jacquard-api 0.11.1

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: coop.hypha.spores.site.layout
//
// 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::{AtUri, Cid};
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};
/// Site layout for spores.garden, defining the order of sections.

#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    rename = "coop.hypha.spores.site.layout",
    tag = "$type"
)]
pub struct Layout<'a> {
    ///Ordered list of section AT-URIs to display
    #[serde(borrow)]
    pub sections: Vec<AtUri<'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 LayoutGetRecordOutput<'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: Layout<'a>,
}

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

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

#[derive(Debug, Serialize, Deserialize)]
pub struct LayoutRecord;
impl XrpcResp for LayoutRecord {
    const NSID: &'static str = "coop.hypha.spores.site.layout";
    const ENCODING: &'static str = "application/json";
    type Output<'de> = LayoutGetRecordOutput<'de>;
    type Err<'de> = RecordError<'de>;
}

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

impl Collection for Layout<'_> {
    const NSID: &'static str = "coop.hypha.spores.site.layout";
    type Record = LayoutRecord;
}

impl Collection for LayoutRecord {
    const NSID: &'static str = "coop.hypha.spores.site.layout";
    type Record = LayoutRecord;
}

impl<'a> LexiconSchema for Layout<'a> {
    fn nsid() -> &'static str {
        "coop.hypha.spores.site.layout"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_coop_hypha_spores_site_layout()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

pub mod layout_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 Sections;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Sections = Unset;
    }
    ///State transition - sets the `sections` field to Set
    pub struct SetSections<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetSections<S> {}
    impl<S: State> State for SetSections<S> {
        type Sections = Set<members::sections>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `sections` field
        pub struct sections(());
    }
}

/// Builder for constructing an instance of this type
pub struct LayoutBuilder<'a, S: layout_state::State> {
    _state: PhantomData<fn() -> S>,
    _fields: (Option<Vec<AtUri<'a>>>,),
    _lifetime: PhantomData<&'a ()>,
}

impl<'a> Layout<'a> {
    /// Create a new builder for this type
    pub fn new() -> LayoutBuilder<'a, layout_state::Empty> {
        LayoutBuilder::new()
    }
}

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

impl<'a, S> LayoutBuilder<'a, S>
where
    S: layout_state::State,
    S::Sections: layout_state::IsUnset,
{
    /// Set the `sections` field (required)
    pub fn sections(
        mut self,
        value: impl Into<Vec<AtUri<'a>>>,
    ) -> LayoutBuilder<'a, layout_state::SetSections<S>> {
        self._fields.0 = Option::Some(value.into());
        LayoutBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> LayoutBuilder<'a, S>
where
    S: layout_state::State,
    S::Sections: layout_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> Layout<'a> {
        Layout {
            sections: self._fields.0.unwrap(),
            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>,
        >,
    ) -> Layout<'a> {
        Layout {
            sections: self._fields.0.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_coop_hypha_spores_site_layout() -> 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("coop.hypha.spores.site.layout"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    description: Some(
                        CowStr::new_static(
                            "Site layout for spores.garden, defining the order of sections.",
                        ),
                    ),
                    key: Some(CowStr::new_static("literal:self")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(vec![SmolStr::new_static("sections")]),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("sections"),
                                LexObjectProperty::Array(LexArray {
                                    description: Some(
                                        CowStr::new_static(
                                            "Ordered list of section AT-URIs to display",
                                        ),
                                    ),
                                    items: LexArrayItem::String(LexString {
                                        description: Some(
                                            CowStr::new_static(
                                                "AT-URI of a coop.hypha.spores.site.section record",
                                            ),
                                        ),
                                        format: Some(LexStringFormat::AtUri),
                                        ..Default::default()
                                    }),
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}