jacquard-api 0.11.0

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: io.atcr.hold.captain
//
// This file was automatically generated from Lexicon schemas.
// Any manual changes will be overwritten on the next regeneration.

#[allow(unused_imports)]
use alloc::collections::BTreeMap;

#[allow(unused_imports)]
use core::marker::PhantomData;
use jacquard_common::CowStr;

#[allow(unused_imports)]
use jacquard_common::deps::codegen::unicode_segmentation::UnicodeSegmentation;
use jacquard_common::types::collection::{Collection, RecordError};
use jacquard_common::types::string::{Did, AtUri, Cid, Datetime};
use jacquard_common::types::uri::{RecordUri, UriError};
use jacquard_common::xrpc::XrpcResp;
use jacquard_derive::{IntoStatic, lexicon};
use jacquard_lexicon::lexicon::LexiconDoc;
use jacquard_lexicon::schema::LexiconSchema;

#[allow(unused_imports)]
use jacquard_lexicon::validation::{ConstraintError, ValidationPath};
use serde::{Serialize, Deserialize};
/// Represents the hold's ownership and metadata. Stored as a singleton record at rkey 'self' in the hold's embedded PDS.

#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct Captain<'a> {
    ///Allow any authenticated user to register as crew
    pub allow_all_crew: bool,
    ///RFC3339 timestamp of when the hold was deployed
    pub deployed_at: Datetime,
    ///Enable Bluesky posts when manifests are pushed
    pub enable_bluesky_posts: bool,
    ///DID of the hold owner
    #[serde(borrow)]
    pub owner: Did<'a>,
    ///Whether this hold allows public blob reads (pulls) without authentication
    pub public: bool,
    ///S3 region where blobs are stored
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub region: Option<CowStr<'a>>,
    ///DID of successor hold for migration redirect
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub successor: Option<Did<'a>>,
    ///Tier names that earn a supporter badge on user profiles
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub supporter_badge_tiers: Option<Vec<CowStr<'a>>>,
}

/// Typed wrapper for GetRecord response with this collection's record type.

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct CaptainGetRecordOutput<'a> {
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub cid: Option<Cid<'a>>,
    #[serde(borrow)]
    pub uri: AtUri<'a>,
    #[serde(borrow)]
    pub value: Captain<'a>,
}

impl<'a> Captain<'a> {
    pub fn uri(
        uri: impl Into<CowStr<'a>>,
    ) -> Result<RecordUri<'a, CaptainRecord>, UriError> {
        RecordUri::try_from_uri(AtUri::new_cow(uri.into())?)
    }
}

/// Marker type for deserializing records from this collection.

#[derive(Debug, Serialize, Deserialize)]
pub struct CaptainRecord;
impl XrpcResp for CaptainRecord {
    const NSID: &'static str = "io.atcr.hold.captain";
    const ENCODING: &'static str = "application/json";
    type Output<'de> = CaptainGetRecordOutput<'de>;
    type Err<'de> = RecordError<'de>;
}

impl From<CaptainGetRecordOutput<'_>> for Captain<'_> {
    fn from(output: CaptainGetRecordOutput<'_>) -> Self {
        use jacquard_common::IntoStatic;
        output.value.into_static()
    }
}

impl Collection for Captain<'_> {
    const NSID: &'static str = "io.atcr.hold.captain";
    type Record = CaptainRecord;
}

impl Collection for CaptainRecord {
    const NSID: &'static str = "io.atcr.hold.captain";
    type Record = CaptainRecord;
}

impl<'a> LexiconSchema for Captain<'a> {
    fn nsid() -> &'static str {
        "io.atcr.hold.captain"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_io_atcr_hold_captain()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        if let Some(ref value) = self.region {
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 64usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("region"),
                    max: 64usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        Ok(())
    }
}

pub mod captain_state {

    pub use crate::builder_types::{Set, Unset, IsSet, IsUnset};
    #[allow(unused)]
    use ::core::marker::PhantomData;
    mod sealed {
        pub trait Sealed {}
    }
    /// State trait tracking which required fields have been set
    pub trait State: sealed::Sealed {
        type Public;
        type EnableBlueskyPosts;
        type AllowAllCrew;
        type DeployedAt;
        type Owner;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Public = Unset;
        type EnableBlueskyPosts = Unset;
        type AllowAllCrew = Unset;
        type DeployedAt = Unset;
        type Owner = Unset;
    }
    ///State transition - sets the `public` field to Set
    pub struct SetPublic<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetPublic<S> {}
    impl<S: State> State for SetPublic<S> {
        type Public = Set<members::public>;
        type EnableBlueskyPosts = S::EnableBlueskyPosts;
        type AllowAllCrew = S::AllowAllCrew;
        type DeployedAt = S::DeployedAt;
        type Owner = S::Owner;
    }
    ///State transition - sets the `enable_bluesky_posts` field to Set
    pub struct SetEnableBlueskyPosts<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetEnableBlueskyPosts<S> {}
    impl<S: State> State for SetEnableBlueskyPosts<S> {
        type Public = S::Public;
        type EnableBlueskyPosts = Set<members::enable_bluesky_posts>;
        type AllowAllCrew = S::AllowAllCrew;
        type DeployedAt = S::DeployedAt;
        type Owner = S::Owner;
    }
    ///State transition - sets the `allow_all_crew` field to Set
    pub struct SetAllowAllCrew<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetAllowAllCrew<S> {}
    impl<S: State> State for SetAllowAllCrew<S> {
        type Public = S::Public;
        type EnableBlueskyPosts = S::EnableBlueskyPosts;
        type AllowAllCrew = Set<members::allow_all_crew>;
        type DeployedAt = S::DeployedAt;
        type Owner = S::Owner;
    }
    ///State transition - sets the `deployed_at` field to Set
    pub struct SetDeployedAt<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetDeployedAt<S> {}
    impl<S: State> State for SetDeployedAt<S> {
        type Public = S::Public;
        type EnableBlueskyPosts = S::EnableBlueskyPosts;
        type AllowAllCrew = S::AllowAllCrew;
        type DeployedAt = Set<members::deployed_at>;
        type Owner = S::Owner;
    }
    ///State transition - sets the `owner` field to Set
    pub struct SetOwner<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetOwner<S> {}
    impl<S: State> State for SetOwner<S> {
        type Public = S::Public;
        type EnableBlueskyPosts = S::EnableBlueskyPosts;
        type AllowAllCrew = S::AllowAllCrew;
        type DeployedAt = S::DeployedAt;
        type Owner = Set<members::owner>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `public` field
        pub struct public(());
        ///Marker type for the `enable_bluesky_posts` field
        pub struct enable_bluesky_posts(());
        ///Marker type for the `allow_all_crew` field
        pub struct allow_all_crew(());
        ///Marker type for the `deployed_at` field
        pub struct deployed_at(());
        ///Marker type for the `owner` field
        pub struct owner(());
    }
}

/// Builder for constructing an instance of this type
pub struct CaptainBuilder<'a, S: captain_state::State> {
    _state: PhantomData<fn() -> S>,
    _fields: (
        Option<bool>,
        Option<Datetime>,
        Option<bool>,
        Option<Did<'a>>,
        Option<bool>,
        Option<CowStr<'a>>,
        Option<Did<'a>>,
        Option<Vec<CowStr<'a>>>,
    ),
    _lifetime: PhantomData<&'a ()>,
}

impl<'a> Captain<'a> {
    /// Create a new builder for this type
    pub fn new() -> CaptainBuilder<'a, captain_state::Empty> {
        CaptainBuilder::new()
    }
}

impl<'a> CaptainBuilder<'a, captain_state::Empty> {
    /// Create a new builder with all fields unset
    pub fn new() -> Self {
        CaptainBuilder {
            _state: PhantomData,
            _fields: (None, None, None, None, None, None, None, None),
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> CaptainBuilder<'a, S>
where
    S: captain_state::State,
    S::AllowAllCrew: captain_state::IsUnset,
{
    /// Set the `allowAllCrew` field (required)
    pub fn allow_all_crew(
        mut self,
        value: impl Into<bool>,
    ) -> CaptainBuilder<'a, captain_state::SetAllowAllCrew<S>> {
        self._fields.0 = Option::Some(value.into());
        CaptainBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> CaptainBuilder<'a, S>
where
    S: captain_state::State,
    S::DeployedAt: captain_state::IsUnset,
{
    /// Set the `deployedAt` field (required)
    pub fn deployed_at(
        mut self,
        value: impl Into<Datetime>,
    ) -> CaptainBuilder<'a, captain_state::SetDeployedAt<S>> {
        self._fields.1 = Option::Some(value.into());
        CaptainBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> CaptainBuilder<'a, S>
where
    S: captain_state::State,
    S::EnableBlueskyPosts: captain_state::IsUnset,
{
    /// Set the `enableBlueskyPosts` field (required)
    pub fn enable_bluesky_posts(
        mut self,
        value: impl Into<bool>,
    ) -> CaptainBuilder<'a, captain_state::SetEnableBlueskyPosts<S>> {
        self._fields.2 = Option::Some(value.into());
        CaptainBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> CaptainBuilder<'a, S>
where
    S: captain_state::State,
    S::Owner: captain_state::IsUnset,
{
    /// Set the `owner` field (required)
    pub fn owner(
        mut self,
        value: impl Into<Did<'a>>,
    ) -> CaptainBuilder<'a, captain_state::SetOwner<S>> {
        self._fields.3 = Option::Some(value.into());
        CaptainBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> CaptainBuilder<'a, S>
where
    S: captain_state::State,
    S::Public: captain_state::IsUnset,
{
    /// Set the `public` field (required)
    pub fn public(
        mut self,
        value: impl Into<bool>,
    ) -> CaptainBuilder<'a, captain_state::SetPublic<S>> {
        self._fields.4 = Option::Some(value.into());
        CaptainBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S: captain_state::State> CaptainBuilder<'a, S> {
    /// Set the `region` field (optional)
    pub fn region(mut self, value: impl Into<Option<CowStr<'a>>>) -> Self {
        self._fields.5 = value.into();
        self
    }
    /// Set the `region` field to an Option value (optional)
    pub fn maybe_region(mut self, value: Option<CowStr<'a>>) -> Self {
        self._fields.5 = value;
        self
    }
}

impl<'a, S: captain_state::State> CaptainBuilder<'a, S> {
    /// Set the `successor` field (optional)
    pub fn successor(mut self, value: impl Into<Option<Did<'a>>>) -> Self {
        self._fields.6 = value.into();
        self
    }
    /// Set the `successor` field to an Option value (optional)
    pub fn maybe_successor(mut self, value: Option<Did<'a>>) -> Self {
        self._fields.6 = value;
        self
    }
}

impl<'a, S: captain_state::State> CaptainBuilder<'a, S> {
    /// Set the `supporterBadgeTiers` field (optional)
    pub fn supporter_badge_tiers(
        mut self,
        value: impl Into<Option<Vec<CowStr<'a>>>>,
    ) -> Self {
        self._fields.7 = value.into();
        self
    }
    /// Set the `supporterBadgeTiers` field to an Option value (optional)
    pub fn maybe_supporter_badge_tiers(
        mut self,
        value: Option<Vec<CowStr<'a>>>,
    ) -> Self {
        self._fields.7 = value;
        self
    }
}

impl<'a, S> CaptainBuilder<'a, S>
where
    S: captain_state::State,
    S::Public: captain_state::IsSet,
    S::EnableBlueskyPosts: captain_state::IsSet,
    S::AllowAllCrew: captain_state::IsSet,
    S::DeployedAt: captain_state::IsSet,
    S::Owner: captain_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> Captain<'a> {
        Captain {
            allow_all_crew: self._fields.0.unwrap(),
            deployed_at: self._fields.1.unwrap(),
            enable_bluesky_posts: self._fields.2.unwrap(),
            owner: self._fields.3.unwrap(),
            public: self._fields.4.unwrap(),
            region: self._fields.5,
            successor: self._fields.6,
            supporter_badge_tiers: self._fields.7,
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data
    pub fn build_with_data(
        self,
        extra_data: BTreeMap<
            jacquard_common::deps::smol_str::SmolStr,
            jacquard_common::types::value::Data<'a>,
        >,
    ) -> Captain<'a> {
        Captain {
            allow_all_crew: self._fields.0.unwrap(),
            deployed_at: self._fields.1.unwrap(),
            enable_bluesky_posts: self._fields.2.unwrap(),
            owner: self._fields.3.unwrap(),
            public: self._fields.4.unwrap(),
            region: self._fields.5,
            successor: self._fields.6,
            supporter_badge_tiers: self._fields.7,
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_io_atcr_hold_captain() -> LexiconDoc<'static> {
    #[allow(unused_imports)]
    use jacquard_common::{CowStr, deps::smol_str::SmolStr, types::blob::MimeType};
    use jacquard_lexicon::lexicon::*;
    use alloc::collections::BTreeMap;
    LexiconDoc {
        lexicon: Lexicon::Lexicon1,
        id: CowStr::new_static("io.atcr.hold.captain"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    description: Some(
                        CowStr::new_static(
                            "Represents the hold's ownership and metadata. Stored as a singleton record at rkey 'self' in the hold's embedded PDS.",
                        ),
                    ),
                    key: Some(CowStr::new_static("literal:self")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(
                            vec![
                                SmolStr::new_static("owner"), SmolStr::new_static("public"),
                                SmolStr::new_static("allowAllCrew"),
                                SmolStr::new_static("enableBlueskyPosts"),
                                SmolStr::new_static("deployedAt")
                            ],
                        ),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("allowAllCrew"),
                                LexObjectProperty::Boolean(LexBoolean {
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("deployedAt"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "RFC3339 timestamp of when the hold was deployed",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("enableBlueskyPosts"),
                                LexObjectProperty::Boolean(LexBoolean {
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("owner"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static("DID of the hold owner"),
                                    ),
                                    format: Some(LexStringFormat::Did),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("public"),
                                LexObjectProperty::Boolean(LexBoolean {
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("region"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static("S3 region where blobs are stored"),
                                    ),
                                    max_length: Some(64usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("successor"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "DID of successor hold for migration redirect",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::Did),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("supporterBadgeTiers"),
                                LexObjectProperty::Array(LexArray {
                                    description: Some(
                                        CowStr::new_static(
                                            "Tier names that earn a supporter badge on user profiles",
                                        ),
                                    ),
                                    items: LexArrayItem::String(LexString {
                                        max_length: Some(64usize),
                                        ..Default::default()
                                    }),
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}