jacquard-api 0.12.0-beta.1

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: network.cosmik.collectionLink
//
// 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::{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};
use crate::com_atproto::repo::strong_ref::StrongRef;
use crate::network_cosmik::Provenance;
/// A record representing the relationship between a card and a collection.

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    rename = "network.cosmik.collectionLink",
    tag = "$type",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct CollectionLink<S: BosStr = DefaultStr> {
    ///Timestamp when the card was added to the collection.
    pub added_at: Datetime,
    ///DID of the user who added the card to the collection
    pub added_by: S,
    ///Strong reference to the card record in the users library.
    pub card: StrongRef<S>,
    ///Strong reference to the collection record.
    pub collection: StrongRef<S>,
    ///Timestamp when this link record was created (usually set by PDS).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub created_at: Option<Datetime>,
    ///Strong reference to the original card record (may be in another library).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub original_card: Option<StrongRef<S>>,
    ///Optional provenance information for this link.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub provenance: Option<Provenance<S>>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

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

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

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

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

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

impl<S: BosStr> Collection for CollectionLink<S> {
    const NSID: &'static str = "network.cosmik.collectionLink";
    type Record = CollectionLinkRecord;
}

impl Collection for CollectionLinkRecord {
    const NSID: &'static str = "network.cosmik.collectionLink";
    type Record = CollectionLinkRecord;
}

impl<S: BosStr> LexiconSchema for CollectionLink<S> {
    fn nsid() -> &'static str {
        "network.cosmik.collectionLink"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_network_cosmik_collectionLink()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

pub mod collection_link_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 Card;
        type AddedAt;
        type Collection;
        type AddedBy;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Card = Unset;
        type AddedAt = Unset;
        type Collection = Unset;
        type AddedBy = Unset;
    }
    ///State transition - sets the `card` field to Set
    pub struct SetCard<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetCard<St> {}
    impl<St: State> State for SetCard<St> {
        type Card = Set<members::card>;
        type AddedAt = St::AddedAt;
        type Collection = St::Collection;
        type AddedBy = St::AddedBy;
    }
    ///State transition - sets the `added_at` field to Set
    pub struct SetAddedAt<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetAddedAt<St> {}
    impl<St: State> State for SetAddedAt<St> {
        type Card = St::Card;
        type AddedAt = Set<members::added_at>;
        type Collection = St::Collection;
        type AddedBy = St::AddedBy;
    }
    ///State transition - sets the `collection` field to Set
    pub struct SetCollection<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetCollection<St> {}
    impl<St: State> State for SetCollection<St> {
        type Card = St::Card;
        type AddedAt = St::AddedAt;
        type Collection = Set<members::collection>;
        type AddedBy = St::AddedBy;
    }
    ///State transition - sets the `added_by` field to Set
    pub struct SetAddedBy<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetAddedBy<St> {}
    impl<St: State> State for SetAddedBy<St> {
        type Card = St::Card;
        type AddedAt = St::AddedAt;
        type Collection = St::Collection;
        type AddedBy = Set<members::added_by>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `card` field
        pub struct card(());
        ///Marker type for the `added_at` field
        pub struct added_at(());
        ///Marker type for the `collection` field
        pub struct collection(());
        ///Marker type for the `added_by` field
        pub struct added_by(());
    }
}

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

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

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

impl<S: BosStr, St> CollectionLinkBuilder<S, St>
where
    St: collection_link_state::State,
    St::AddedAt: collection_link_state::IsUnset,
{
    /// Set the `addedAt` field (required)
    pub fn added_at(
        mut self,
        value: impl Into<Datetime>,
    ) -> CollectionLinkBuilder<S, collection_link_state::SetAddedAt<St>> {
        self._fields.0 = Option::Some(value.into());
        CollectionLinkBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> CollectionLinkBuilder<S, St>
where
    St: collection_link_state::State,
    St::AddedBy: collection_link_state::IsUnset,
{
    /// Set the `addedBy` field (required)
    pub fn added_by(
        mut self,
        value: impl Into<S>,
    ) -> CollectionLinkBuilder<S, collection_link_state::SetAddedBy<St>> {
        self._fields.1 = Option::Some(value.into());
        CollectionLinkBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> CollectionLinkBuilder<S, St>
where
    St: collection_link_state::State,
    St::Card: collection_link_state::IsUnset,
{
    /// Set the `card` field (required)
    pub fn card(
        mut self,
        value: impl Into<StrongRef<S>>,
    ) -> CollectionLinkBuilder<S, collection_link_state::SetCard<St>> {
        self._fields.2 = Option::Some(value.into());
        CollectionLinkBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> CollectionLinkBuilder<S, St>
where
    St: collection_link_state::State,
    St::Collection: collection_link_state::IsUnset,
{
    /// Set the `collection` field (required)
    pub fn collection(
        mut self,
        value: impl Into<StrongRef<S>>,
    ) -> CollectionLinkBuilder<S, collection_link_state::SetCollection<St>> {
        self._fields.3 = Option::Some(value.into());
        CollectionLinkBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St: collection_link_state::State> CollectionLinkBuilder<S, St> {
    /// Set the `createdAt` field (optional)
    pub fn created_at(mut self, value: impl Into<Option<Datetime>>) -> Self {
        self._fields.4 = 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.4 = value;
        self
    }
}

impl<S: BosStr, St: collection_link_state::State> CollectionLinkBuilder<S, St> {
    /// Set the `originalCard` field (optional)
    pub fn original_card(mut self, value: impl Into<Option<StrongRef<S>>>) -> Self {
        self._fields.5 = value.into();
        self
    }
    /// Set the `originalCard` field to an Option value (optional)
    pub fn maybe_original_card(mut self, value: Option<StrongRef<S>>) -> Self {
        self._fields.5 = value;
        self
    }
}

impl<S: BosStr, St: collection_link_state::State> CollectionLinkBuilder<S, St> {
    /// Set the `provenance` field (optional)
    pub fn provenance(mut self, value: impl Into<Option<Provenance<S>>>) -> Self {
        self._fields.6 = value.into();
        self
    }
    /// Set the `provenance` field to an Option value (optional)
    pub fn maybe_provenance(mut self, value: Option<Provenance<S>>) -> Self {
        self._fields.6 = value;
        self
    }
}

impl<S: BosStr, St> CollectionLinkBuilder<S, St>
where
    St: collection_link_state::State,
    St::Card: collection_link_state::IsSet,
    St::AddedAt: collection_link_state::IsSet,
    St::Collection: collection_link_state::IsSet,
    St::AddedBy: collection_link_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> CollectionLink<S> {
        CollectionLink {
            added_at: self._fields.0.unwrap(),
            added_by: self._fields.1.unwrap(),
            card: self._fields.2.unwrap(),
            collection: self._fields.3.unwrap(),
            created_at: self._fields.4,
            original_card: self._fields.5,
            provenance: self._fields.6,
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data.
    pub fn build_with_data(
        self,
        extra_data: BTreeMap<SmolStr, Data<S>>,
    ) -> CollectionLink<S> {
        CollectionLink {
            added_at: self._fields.0.unwrap(),
            added_by: self._fields.1.unwrap(),
            card: self._fields.2.unwrap(),
            collection: self._fields.3.unwrap(),
            created_at: self._fields.4,
            original_card: self._fields.5,
            provenance: self._fields.6,
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_network_cosmik_collectionLink() -> 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.collectionLink"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    description: Some(
                        CowStr::new_static(
                            "A record representing the relationship between a card and a collection.",
                        ),
                    ),
                    key: Some(CowStr::new_static("tid")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(
                            vec![
                                SmolStr::new_static("collection"),
                                SmolStr::new_static("card"), SmolStr::new_static("addedBy"),
                                SmolStr::new_static("addedAt")
                            ],
                        ),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("addedAt"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "Timestamp when the card was added to the collection.",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("addedBy"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "DID of the user who added the card to the collection",
                                        ),
                                    ),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("card"),
                                LexObjectProperty::Ref(LexRef {
                                    r#ref: CowStr::new_static("com.atproto.repo.strongRef"),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("collection"),
                                LexObjectProperty::Ref(LexRef {
                                    r#ref: CowStr::new_static("com.atproto.repo.strongRef"),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("createdAt"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "Timestamp when this link record was created (usually set by PDS).",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("originalCard"),
                                LexObjectProperty::Ref(LexRef {
                                    r#ref: CowStr::new_static("com.atproto.repo.strongRef"),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("provenance"),
                                LexObjectProperty::Ref(LexRef {
                                    r#ref: CowStr::new_static("network.cosmik.defs#provenance"),
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}