jacquard-api 0.12.0-beta.1

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: at.margin.collectionItem
//
// 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};
/// Associates an annotation with a collection

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    rename = "at.margin.collectionItem",
    tag = "$type",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct CollectionItem<S: BosStr = DefaultStr> {
    ///AT URI of the annotation, highlight, or bookmark
    pub annotation: AtUri<S>,
    ///AT URI of the collection
    pub collection: AtUri<S>,
    pub created_at: Datetime,
    ///Sort order within the collection
    #[serde(skip_serializing_if = "Option::is_none")]
    pub position: Option<i64>,
    #[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 CollectionItemGetRecordOutput<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cid: Option<Cid<S>>,
    pub uri: AtUri<S>,
    pub value: CollectionItem<S>,
}

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

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

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

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

impl<S: BosStr> Collection for CollectionItem<S> {
    const NSID: &'static str = "at.margin.collectionItem";
    type Record = CollectionItemRecord;
}

impl Collection for CollectionItemRecord {
    const NSID: &'static str = "at.margin.collectionItem";
    type Record = CollectionItemRecord;
}

impl<S: BosStr> LexiconSchema for CollectionItem<S> {
    fn nsid() -> &'static str {
        "at.margin.collectionItem"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_at_margin_collectionItem()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        if let Some(ref value) = self.position {
            if *value < 0i64 {
                return Err(ConstraintError::Minimum {
                    path: ValidationPath::from_field("position"),
                    min: 0i64,
                    actual: *value,
                });
            }
        }
        Ok(())
    }
}

pub mod collection_item_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 CreatedAt;
        type Annotation;
        type Collection;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type CreatedAt = Unset;
        type Annotation = Unset;
        type Collection = Unset;
    }
    ///State transition - sets the `created_at` field to Set
    pub struct SetCreatedAt<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetCreatedAt<St> {}
    impl<St: State> State for SetCreatedAt<St> {
        type CreatedAt = Set<members::created_at>;
        type Annotation = St::Annotation;
        type Collection = St::Collection;
    }
    ///State transition - sets the `annotation` field to Set
    pub struct SetAnnotation<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetAnnotation<St> {}
    impl<St: State> State for SetAnnotation<St> {
        type CreatedAt = St::CreatedAt;
        type Annotation = Set<members::annotation>;
        type Collection = St::Collection;
    }
    ///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 CreatedAt = St::CreatedAt;
        type Annotation = St::Annotation;
        type Collection = Set<members::collection>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `created_at` field
        pub struct created_at(());
        ///Marker type for the `annotation` field
        pub struct annotation(());
        ///Marker type for the `collection` field
        pub struct collection(());
    }
}

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

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

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

impl<S: BosStr, St> CollectionItemBuilder<S, St>
where
    St: collection_item_state::State,
    St::Annotation: collection_item_state::IsUnset,
{
    /// Set the `annotation` field (required)
    pub fn annotation(
        mut self,
        value: impl Into<AtUri<S>>,
    ) -> CollectionItemBuilder<S, collection_item_state::SetAnnotation<St>> {
        self._fields.0 = Option::Some(value.into());
        CollectionItemBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

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

impl<S: BosStr, St> CollectionItemBuilder<S, St>
where
    St: collection_item_state::State,
    St::CreatedAt: collection_item_state::IsUnset,
{
    /// Set the `createdAt` field (required)
    pub fn created_at(
        mut self,
        value: impl Into<Datetime>,
    ) -> CollectionItemBuilder<S, collection_item_state::SetCreatedAt<St>> {
        self._fields.2 = Option::Some(value.into());
        CollectionItemBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

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

impl<S: BosStr, St> CollectionItemBuilder<S, St>
where
    St: collection_item_state::State,
    St::CreatedAt: collection_item_state::IsSet,
    St::Annotation: collection_item_state::IsSet,
    St::Collection: collection_item_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> CollectionItem<S> {
        CollectionItem {
            annotation: self._fields.0.unwrap(),
            collection: self._fields.1.unwrap(),
            created_at: self._fields.2.unwrap(),
            position: self._fields.3,
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data.
    pub fn build_with_data(
        self,
        extra_data: BTreeMap<SmolStr, Data<S>>,
    ) -> CollectionItem<S> {
        CollectionItem {
            annotation: self._fields.0.unwrap(),
            collection: self._fields.1.unwrap(),
            created_at: self._fields.2.unwrap(),
            position: self._fields.3,
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_at_margin_collectionItem() -> 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("at.margin.collectionItem"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    description: Some(
                        CowStr::new_static("Associates an annotation with a collection"),
                    ),
                    key: Some(CowStr::new_static("tid")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(
                            vec![
                                SmolStr::new_static("collection"),
                                SmolStr::new_static("annotation"),
                                SmolStr::new_static("createdAt")
                            ],
                        ),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("annotation"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "AT URI of the annotation, highlight, or bookmark",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::AtUri),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("collection"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static("AT URI of the collection"),
                                    ),
                                    format: Some(LexStringFormat::AtUri),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("createdAt"),
                                LexObjectProperty::String(LexString {
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("position"),
                                LexObjectProperty::Integer(LexInteger {
                                    minimum: Some(0i64),
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}