jacquard-api 0.12.0-beta.1

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: network.cosmik.collection
//
// 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, BosStr, DefaultStr, FromStaticStr};

#[allow(unused_imports)]
use jacquard_common::deps::codegen::unicode_segmentation::UnicodeSegmentation;
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::collection::RecordError;
use jacquard_common::types::string::{AtUri, Cid, Datetime};
use jacquard_common::types::uri::{RecordUri, UriError};
use jacquard_common::types::value::Data;
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};
/// A record representing a collection of cards.

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    rename = "network.cosmik.collection",
    tag = "$type",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct Collection<S: BosStr = DefaultStr> {
    ///Access control for the collection
    pub access_type: CollectionAccessType<S>,
    ///List of collaborator DIDs who can add cards to closed collections
    #[serde(skip_serializing_if = "Option::is_none")]
    pub collaborators: Option<Vec<S>>,
    ///Timestamp when this collection was created (usually set by PDS).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub created_at: Option<Datetime>,
    ///Description of the collection
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<S>,
    ///Name of the collection
    pub name: S,
    ///Timestamp when this collection was last updated.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub updated_at: Option<Datetime>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/// Access control for the collection

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum CollectionAccessType<S: BosStr = DefaultStr> {
    Open,
    Closed,
    Other(S),
}

impl<S: BosStr> CollectionAccessType<S> {
    pub fn as_str(&self) -> &str {
        match self {
            Self::Open => "OPEN",
            Self::Closed => "CLOSED",
            Self::Other(s) => s.as_ref(),
        }
    }
    /// Construct from a string-like value, matching known values.
    pub fn from_value(s: S) -> Self {
        match s.as_ref() {
            "OPEN" => Self::Open,
            "CLOSED" => Self::Closed,
            _ => Self::Other(s),
        }
    }
}

impl<S: BosStr> core::fmt::Display for CollectionAccessType<S> {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "{}", self.as_str())
    }
}

impl<S: BosStr> AsRef<str> for CollectionAccessType<S> {
    fn as_ref(&self) -> &str {
        self.as_str()
    }
}

impl<S: BosStr> Serialize for CollectionAccessType<S> {
    fn serialize<Ser>(&self, serializer: Ser) -> Result<Ser::Ok, Ser::Error>
    where
        Ser: serde::Serializer,
    {
        serializer.serialize_str(self.as_str())
    }
}

impl<'de, S: Deserialize<'de> + BosStr> Deserialize<'de> for CollectionAccessType<S> {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let s = S::deserialize(deserializer)?;
        Ok(Self::from_value(s))
    }
}

impl<S: BosStr + Default> Default for CollectionAccessType<S> {
    fn default() -> Self {
        Self::Other(Default::default())
    }
}

impl<S: BosStr> jacquard_common::IntoStatic for CollectionAccessType<S>
where
    S: BosStr + jacquard_common::IntoStatic,
    S::Output: BosStr,
{
    type Output = CollectionAccessType<S::Output>;
    fn into_static(self) -> Self::Output {
        match self {
            CollectionAccessType::Open => CollectionAccessType::Open,
            CollectionAccessType::Closed => CollectionAccessType::Closed,
            CollectionAccessType::Other(v) => {
                CollectionAccessType::Other(v.into_static())
            }
        }
    }
}

/// 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 CollectionGetRecordOutput<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cid: Option<Cid<S>>,
    pub uri: AtUri<S>,
    pub value: Collection<S>,
}

impl<S: BosStr> Collection<S> {
    pub fn uri(uri: S) -> Result<RecordUri<S, CollectionRecord>, UriError> {
        RecordUri::try_from_uri(AtUri::new(uri)?)
    }
}

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

#[derive(Debug, Serialize, Deserialize)]
pub struct CollectionRecord;
impl XrpcResp for CollectionRecord {
    const NSID: &'static str = "network.cosmik.collection";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = CollectionGetRecordOutput<S>;
    type Err = RecordError;
}

impl<S: BosStr> From<CollectionGetRecordOutput<S>> for Collection<S> {
    fn from(output: CollectionGetRecordOutput<S>) -> Self {
        output.value
    }
}

impl<S: BosStr> jacquard_common::types::collection::Collection for Collection<S> {
    const NSID: &'static str = "network.cosmik.collection";
    type Record = CollectionRecord;
}

impl jacquard_common::types::collection::Collection for CollectionRecord {
    const NSID: &'static str = "network.cosmik.collection";
    type Record = CollectionRecord;
}

impl<S: BosStr> LexiconSchema for Collection<S> {
    fn nsid() -> &'static str {
        "network.cosmik.collection"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_network_cosmik_collection()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        if let Some(ref value) = self.description {
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 500usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("description"),
                    max: 500usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        {
            let value = &self.name;
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 100usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("name"),
                    max: 100usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        Ok(())
    }
}

pub mod collection_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 Name;
        type AccessType;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Name = Unset;
        type AccessType = Unset;
    }
    ///State transition - sets the `name` field to Set
    pub struct SetName<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetName<St> {}
    impl<St: State> State for SetName<St> {
        type Name = Set<members::name>;
        type AccessType = St::AccessType;
    }
    ///State transition - sets the `access_type` field to Set
    pub struct SetAccessType<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetAccessType<St> {}
    impl<St: State> State for SetAccessType<St> {
        type Name = St::Name;
        type AccessType = Set<members::access_type>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `name` field
        pub struct name(());
        ///Marker type for the `access_type` field
        pub struct access_type(());
    }
}

/// Builder for constructing an instance of this type.
pub struct CollectionBuilder<S: BosStr, St: collection_state::State> {
    _state: PhantomData<fn() -> St>,
    _fields: (
        Option<CollectionAccessType<S>>,
        Option<Vec<S>>,
        Option<Datetime>,
        Option<S>,
        Option<S>,
        Option<Datetime>,
    ),
    _type: PhantomData<fn() -> S>,
}

impl<S: BosStr> Collection<S> {
    /// Create a new builder for this type.
    pub fn new() -> CollectionBuilder<S, collection_state::Empty> {
        CollectionBuilder::new()
    }
}

impl<S: BosStr> CollectionBuilder<S, collection_state::Empty> {
    /// Create a new builder with all fields unset.
    pub fn new() -> Self {
        CollectionBuilder {
            _state: PhantomData,
            _fields: (None, None, None, None, None, None),
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> CollectionBuilder<S, St>
where
    St: collection_state::State,
    St::AccessType: collection_state::IsUnset,
{
    /// Set the `accessType` field (required)
    pub fn access_type(
        mut self,
        value: impl Into<CollectionAccessType<S>>,
    ) -> CollectionBuilder<S, collection_state::SetAccessType<St>> {
        self._fields.0 = Option::Some(value.into());
        CollectionBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St: collection_state::State> CollectionBuilder<S, St> {
    /// Set the `collaborators` field (optional)
    pub fn collaborators(mut self, value: impl Into<Option<Vec<S>>>) -> Self {
        self._fields.1 = value.into();
        self
    }
    /// Set the `collaborators` field to an Option value (optional)
    pub fn maybe_collaborators(mut self, value: Option<Vec<S>>) -> Self {
        self._fields.1 = value;
        self
    }
}

impl<S: BosStr, St: collection_state::State> CollectionBuilder<S, St> {
    /// Set the `createdAt` field (optional)
    pub fn created_at(mut self, value: impl Into<Option<Datetime>>) -> Self {
        self._fields.2 = value.into();
        self
    }
    /// Set the `createdAt` field to an Option value (optional)
    pub fn maybe_created_at(mut self, value: Option<Datetime>) -> Self {
        self._fields.2 = value;
        self
    }
}

impl<S: BosStr, St: collection_state::State> CollectionBuilder<S, St> {
    /// Set the `description` field (optional)
    pub fn description(mut self, value: impl Into<Option<S>>) -> Self {
        self._fields.3 = value.into();
        self
    }
    /// Set the `description` field to an Option value (optional)
    pub fn maybe_description(mut self, value: Option<S>) -> Self {
        self._fields.3 = value;
        self
    }
}

impl<S: BosStr, St> CollectionBuilder<S, St>
where
    St: collection_state::State,
    St::Name: collection_state::IsUnset,
{
    /// Set the `name` field (required)
    pub fn name(
        mut self,
        value: impl Into<S>,
    ) -> CollectionBuilder<S, collection_state::SetName<St>> {
        self._fields.4 = Option::Some(value.into());
        CollectionBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St: collection_state::State> CollectionBuilder<S, St> {
    /// Set the `updatedAt` field (optional)
    pub fn updated_at(mut self, value: impl Into<Option<Datetime>>) -> Self {
        self._fields.5 = value.into();
        self
    }
    /// Set the `updatedAt` field to an Option value (optional)
    pub fn maybe_updated_at(mut self, value: Option<Datetime>) -> Self {
        self._fields.5 = value;
        self
    }
}

impl<S: BosStr, St> CollectionBuilder<S, St>
where
    St: collection_state::State,
    St::Name: collection_state::IsSet,
    St::AccessType: collection_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> Collection<S> {
        Collection {
            access_type: self._fields.0.unwrap(),
            collaborators: self._fields.1,
            created_at: self._fields.2,
            description: self._fields.3,
            name: self._fields.4.unwrap(),
            updated_at: self._fields.5,
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data.
    pub fn build_with_data(
        self,
        extra_data: BTreeMap<SmolStr, Data<S>>,
    ) -> Collection<S> {
        Collection {
            access_type: self._fields.0.unwrap(),
            collaborators: self._fields.1,
            created_at: self._fields.2,
            description: self._fields.3,
            name: self._fields.4.unwrap(),
            updated_at: self._fields.5,
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_network_cosmik_collection() -> 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("network.cosmik.collection"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    description: Some(
                        CowStr::new_static(
                            "A record representing a collection of cards.",
                        ),
                    ),
                    key: Some(CowStr::new_static("tid")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(
                            vec![
                                SmolStr::new_static("name"),
                                SmolStr::new_static("accessType")
                            ],
                        ),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("accessType"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static("Access control for the collection"),
                                    ),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("collaborators"),
                                LexObjectProperty::Array(LexArray {
                                    description: Some(
                                        CowStr::new_static(
                                            "List of collaborator DIDs who can add cards to closed collections",
                                        ),
                                    ),
                                    items: LexArrayItem::String(LexString {
                                        description: Some(
                                            CowStr::new_static("DID of a collaborator"),
                                        ),
                                        ..Default::default()
                                    }),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("createdAt"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "Timestamp when this collection was created (usually set by PDS).",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("description"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static("Description of the collection"),
                                    ),
                                    max_length: Some(500usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("name"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static("Name of the collection"),
                                    ),
                                    max_length: Some(100usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("updatedAt"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "Timestamp when this collection was last updated.",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}