jacquard-api 0.12.0-beta.1

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: sh.weaver.notebook.entry
//
// 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::sh_weaver::actor::Author;
use crate::sh_weaver::notebook::ContentRating;
use crate::sh_weaver::notebook::ContentWarnings;
use crate::sh_weaver::notebook::Path;
use crate::sh_weaver::notebook::Tags;
use crate::sh_weaver::notebook::Title;
/// A notebook entry

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    rename = "sh.weaver.notebook.entry",
    tag = "$type",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct Entry<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub authors: Option<Vec<Author<S>>>,
    ///The content of the notebook entry. This should be some flavor of Markdown.
    pub content: S,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub content_warnings: Option<ContentWarnings<S>>,
    ///Client-declared timestamp when this was originally created.
    pub created_at: Datetime,
    ///The set of images and records, if any, embedded in the notebook entry.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub embeds: Option<EntryEmbeds<S>>,
    pub path: Path<S>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub rating: Option<ContentRating<S>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tags: Option<Tags<S>>,
    pub title: Title<S>,
    ///Client-declared timestamp of last modification. Used for canonicality tiebreaking in multi-author scenarios.
    #[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>>>,
}

/// The set of images and records, if any, embedded in the notebook entry.

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic, Default)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct EntryEmbeds<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub externals: Option<crate::sh_weaver::embed::external::External<S>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub images: Option<crate::sh_weaver::embed::images::Images<S>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub records: Option<crate::sh_weaver::embed::records::Records<S>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub records_with_media: Option<
        Vec<crate::sh_weaver::embed::record_with_media::RecordWithMedia<S>>,
    >,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub videos: Option<crate::sh_weaver::embed::video::VideoRecord<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 EntryGetRecordOutput<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cid: Option<Cid<S>>,
    pub uri: AtUri<S>,
    pub value: Entry<S>,
}

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

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

#[derive(Debug, Serialize, Deserialize)]
pub struct EntryRecord;
impl XrpcResp for EntryRecord {
    const NSID: &'static str = "sh.weaver.notebook.entry";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = EntryGetRecordOutput<S>;
    type Err = RecordError;
}

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

impl<S: BosStr> Collection for Entry<S> {
    const NSID: &'static str = "sh.weaver.notebook.entry";
    type Record = EntryRecord;
}

impl Collection for EntryRecord {
    const NSID: &'static str = "sh.weaver.notebook.entry";
    type Record = EntryRecord;
}

impl<S: BosStr> LexiconSchema for Entry<S> {
    fn nsid() -> &'static str {
        "sh.weaver.notebook.entry"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_sh_weaver_notebook_entry()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

impl<S: BosStr> LexiconSchema for EntryEmbeds<S> {
    fn nsid() -> &'static str {
        "sh.weaver.notebook.entry"
    }
    fn def_name() -> &'static str {
        "EntryEmbeds"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_sh_weaver_notebook_entry()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

fn lexicon_doc_sh_weaver_notebook_entry() -> 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("sh.weaver.notebook.entry"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    description: Some(CowStr::new_static("A notebook entry")),
                    key: Some(CowStr::new_static("tid")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(
                            vec![
                                SmolStr::new_static("content"),
                                SmolStr::new_static("title"), SmolStr::new_static("path"),
                                SmolStr::new_static("createdAt")
                            ],
                        ),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("authors"),
                                LexObjectProperty::Array(LexArray {
                                    items: LexArrayItem::Ref(LexRef {
                                        r#ref: CowStr::new_static("sh.weaver.actor.defs#author"),
                                        ..Default::default()
                                    }),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("content"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "The content of the notebook entry. This should be some flavor of Markdown.",
                                        ),
                                    ),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("contentWarnings"),
                                LexObjectProperty::Ref(LexRef {
                                    r#ref: CowStr::new_static(
                                        "sh.weaver.notebook.defs#contentWarnings",
                                    ),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("createdAt"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "Client-declared timestamp when this was originally created.",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("embeds"),
                                LexObjectProperty::Object(LexObject {
                                    description: Some(
                                        CowStr::new_static(
                                            "The set of images and records, if any, embedded in the notebook entry.",
                                        ),
                                    ),
                                    properties: {
                                        #[allow(unused_mut)]
                                        let mut map = BTreeMap::new();
                                        map.insert(
                                            SmolStr::new_static("externals"),
                                            LexObjectProperty::Ref(LexRef {
                                                r#ref: CowStr::new_static("sh.weaver.embed.external"),
                                                ..Default::default()
                                            }),
                                        );
                                        map.insert(
                                            SmolStr::new_static("images"),
                                            LexObjectProperty::Ref(LexRef {
                                                r#ref: CowStr::new_static("sh.weaver.embed.images"),
                                                ..Default::default()
                                            }),
                                        );
                                        map.insert(
                                            SmolStr::new_static("records"),
                                            LexObjectProperty::Ref(LexRef {
                                                r#ref: CowStr::new_static("sh.weaver.embed.records"),
                                                ..Default::default()
                                            }),
                                        );
                                        map.insert(
                                            SmolStr::new_static("recordsWithMedia"),
                                            LexObjectProperty::Array(LexArray {
                                                items: LexArrayItem::Ref(LexRef {
                                                    r#ref: CowStr::new_static(
                                                        "sh.weaver.embed.recordWithMedia",
                                                    ),
                                                    ..Default::default()
                                                }),
                                                ..Default::default()
                                            }),
                                        );
                                        map.insert(
                                            SmolStr::new_static("videos"),
                                            LexObjectProperty::Ref(LexRef {
                                                r#ref: CowStr::new_static("sh.weaver.embed.video"),
                                                ..Default::default()
                                            }),
                                        );
                                        map
                                    },
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("path"),
                                LexObjectProperty::Ref(LexRef {
                                    r#ref: CowStr::new_static("sh.weaver.notebook.defs#path"),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("rating"),
                                LexObjectProperty::Ref(LexRef {
                                    r#ref: CowStr::new_static(
                                        "sh.weaver.notebook.defs#contentRating",
                                    ),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("tags"),
                                LexObjectProperty::Ref(LexRef {
                                    r#ref: CowStr::new_static("sh.weaver.notebook.defs#tags"),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("title"),
                                LexObjectProperty::Ref(LexRef {
                                    r#ref: CowStr::new_static("sh.weaver.notebook.defs#title"),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("updatedAt"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "Client-declared timestamp of last modification. Used for canonicality tiebreaking in multi-author scenarios.",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}

pub mod entry_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 Content;
        type Title;
        type Path;
        type CreatedAt;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Content = Unset;
        type Title = Unset;
        type Path = Unset;
        type CreatedAt = Unset;
    }
    ///State transition - sets the `content` field to Set
    pub struct SetContent<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetContent<St> {}
    impl<St: State> State for SetContent<St> {
        type Content = Set<members::content>;
        type Title = St::Title;
        type Path = St::Path;
        type CreatedAt = St::CreatedAt;
    }
    ///State transition - sets the `title` field to Set
    pub struct SetTitle<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetTitle<St> {}
    impl<St: State> State for SetTitle<St> {
        type Content = St::Content;
        type Title = Set<members::title>;
        type Path = St::Path;
        type CreatedAt = St::CreatedAt;
    }
    ///State transition - sets the `path` field to Set
    pub struct SetPath<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetPath<St> {}
    impl<St: State> State for SetPath<St> {
        type Content = St::Content;
        type Title = St::Title;
        type Path = Set<members::path>;
        type CreatedAt = St::CreatedAt;
    }
    ///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 Content = St::Content;
        type Title = St::Title;
        type Path = St::Path;
        type CreatedAt = Set<members::created_at>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `content` field
        pub struct content(());
        ///Marker type for the `title` field
        pub struct title(());
        ///Marker type for the `path` field
        pub struct path(());
        ///Marker type for the `created_at` field
        pub struct created_at(());
    }
}

/// Builder for constructing an instance of this type.
pub struct EntryBuilder<S: BosStr, St: entry_state::State> {
    _state: PhantomData<fn() -> St>,
    _fields: (
        Option<Vec<Author<S>>>,
        Option<S>,
        Option<ContentWarnings<S>>,
        Option<Datetime>,
        Option<EntryEmbeds<S>>,
        Option<Path<S>>,
        Option<ContentRating<S>>,
        Option<Tags<S>>,
        Option<Title<S>>,
        Option<Datetime>,
    ),
    _type: PhantomData<fn() -> S>,
}

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

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

impl<S: BosStr, St: entry_state::State> EntryBuilder<S, St> {
    /// Set the `authors` field (optional)
    pub fn authors(mut self, value: impl Into<Option<Vec<Author<S>>>>) -> Self {
        self._fields.0 = value.into();
        self
    }
    /// Set the `authors` field to an Option value (optional)
    pub fn maybe_authors(mut self, value: Option<Vec<Author<S>>>) -> Self {
        self._fields.0 = value;
        self
    }
}

impl<S: BosStr, St> EntryBuilder<S, St>
where
    St: entry_state::State,
    St::Content: entry_state::IsUnset,
{
    /// Set the `content` field (required)
    pub fn content(
        mut self,
        value: impl Into<S>,
    ) -> EntryBuilder<S, entry_state::SetContent<St>> {
        self._fields.1 = Option::Some(value.into());
        EntryBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St: entry_state::State> EntryBuilder<S, St> {
    /// Set the `contentWarnings` field (optional)
    pub fn content_warnings(
        mut self,
        value: impl Into<Option<ContentWarnings<S>>>,
    ) -> Self {
        self._fields.2 = value.into();
        self
    }
    /// Set the `contentWarnings` field to an Option value (optional)
    pub fn maybe_content_warnings(mut self, value: Option<ContentWarnings<S>>) -> Self {
        self._fields.2 = value;
        self
    }
}

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

impl<S: BosStr, St: entry_state::State> EntryBuilder<S, St> {
    /// Set the `embeds` field (optional)
    pub fn embeds(mut self, value: impl Into<Option<EntryEmbeds<S>>>) -> Self {
        self._fields.4 = value.into();
        self
    }
    /// Set the `embeds` field to an Option value (optional)
    pub fn maybe_embeds(mut self, value: Option<EntryEmbeds<S>>) -> Self {
        self._fields.4 = value;
        self
    }
}

impl<S: BosStr, St> EntryBuilder<S, St>
where
    St: entry_state::State,
    St::Path: entry_state::IsUnset,
{
    /// Set the `path` field (required)
    pub fn path(
        mut self,
        value: impl Into<Path<S>>,
    ) -> EntryBuilder<S, entry_state::SetPath<St>> {
        self._fields.5 = Option::Some(value.into());
        EntryBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St: entry_state::State> EntryBuilder<S, St> {
    /// Set the `rating` field (optional)
    pub fn rating(mut self, value: impl Into<Option<ContentRating<S>>>) -> Self {
        self._fields.6 = value.into();
        self
    }
    /// Set the `rating` field to an Option value (optional)
    pub fn maybe_rating(mut self, value: Option<ContentRating<S>>) -> Self {
        self._fields.6 = value;
        self
    }
}

impl<S: BosStr, St: entry_state::State> EntryBuilder<S, St> {
    /// Set the `tags` field (optional)
    pub fn tags(mut self, value: impl Into<Option<Tags<S>>>) -> Self {
        self._fields.7 = value.into();
        self
    }
    /// Set the `tags` field to an Option value (optional)
    pub fn maybe_tags(mut self, value: Option<Tags<S>>) -> Self {
        self._fields.7 = value;
        self
    }
}

impl<S: BosStr, St> EntryBuilder<S, St>
where
    St: entry_state::State,
    St::Title: entry_state::IsUnset,
{
    /// Set the `title` field (required)
    pub fn title(
        mut self,
        value: impl Into<Title<S>>,
    ) -> EntryBuilder<S, entry_state::SetTitle<St>> {
        self._fields.8 = Option::Some(value.into());
        EntryBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St: entry_state::State> EntryBuilder<S, St> {
    /// Set the `updatedAt` field (optional)
    pub fn updated_at(mut self, value: impl Into<Option<Datetime>>) -> Self {
        self._fields.9 = 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.9 = value;
        self
    }
}

impl<S: BosStr, St> EntryBuilder<S, St>
where
    St: entry_state::State,
    St::Content: entry_state::IsSet,
    St::Title: entry_state::IsSet,
    St::Path: entry_state::IsSet,
    St::CreatedAt: entry_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> Entry<S> {
        Entry {
            authors: self._fields.0,
            content: self._fields.1.unwrap(),
            content_warnings: self._fields.2,
            created_at: self._fields.3.unwrap(),
            embeds: self._fields.4,
            path: self._fields.5.unwrap(),
            rating: self._fields.6,
            tags: self._fields.7,
            title: self._fields.8.unwrap(),
            updated_at: self._fields.9,
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data.
    pub fn build_with_data(self, extra_data: BTreeMap<SmolStr, Data<S>>) -> Entry<S> {
        Entry {
            authors: self._fields.0,
            content: self._fields.1.unwrap(),
            content_warnings: self._fields.2,
            created_at: self._fields.3.unwrap(),
            embeds: self._fields.4,
            path: self._fields.5.unwrap(),
            rating: self._fields.6,
            tags: self._fields.7,
            title: self._fields.8.unwrap(),
            updated_at: self._fields.9,
            extra_data: Some(extra_data),
        }
    }
}