// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: cat.vt3e.gallery.groupItem
//
// 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};
/// defines an item in a gallery group

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    rename = "cat.vt3e.gallery.groupItem",
    tag = "$type",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct GroupItem<S: BosStr = DefaultStr> {
    pub added_at: Datetime,
    ///uri of the group that the image belongs to
    pub group: AtUri<S>,
    ///uri of the image that this item represents
    pub image: AtUri<S>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub note: Option<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 GroupItemGetRecordOutput<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cid: Option<Cid<S>>,
    pub uri: AtUri<S>,
    pub value: GroupItem<S>,
}

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

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

#[derive(Debug, Serialize, Deserialize)]
pub struct GroupItemRecord;
impl XrpcResp for GroupItemRecord {
    const NSID: &'static str = "cat.vt3e.gallery.groupItem";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = GroupItemGetRecordOutput<S>;
    type Err = RecordError;
}

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

impl<S: BosStr> Collection for GroupItem<S> {
    const NSID: &'static str = "cat.vt3e.gallery.groupItem";
    type Record = GroupItemRecord;
}

impl Collection for GroupItemRecord {
    const NSID: &'static str = "cat.vt3e.gallery.groupItem";
    type Record = GroupItemRecord;
}

impl<S: BosStr> LexiconSchema for GroupItem<S> {
    fn nsid() -> &'static str {
        "cat.vt3e.gallery.groupItem"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_cat_vt3e_gallery_groupItem()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

pub mod group_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 AddedAt;
        type Group;
        type Image;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type AddedAt = Unset;
        type Group = Unset;
        type Image = Unset;
    }
    ///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 AddedAt = Set<members::added_at>;
        type Group = St::Group;
        type Image = St::Image;
    }
    ///State transition - sets the `group` field to Set
    pub struct SetGroup<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetGroup<St> {}
    impl<St: State> State for SetGroup<St> {
        type AddedAt = St::AddedAt;
        type Group = Set<members::group>;
        type Image = St::Image;
    }
    ///State transition - sets the `image` field to Set
    pub struct SetImage<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetImage<St> {}
    impl<St: State> State for SetImage<St> {
        type AddedAt = St::AddedAt;
        type Group = St::Group;
        type Image = Set<members::image>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `added_at` field
        pub struct added_at(());
        ///Marker type for the `group` field
        pub struct group(());
        ///Marker type for the `image` field
        pub struct image(());
    }
}

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

impl GroupItem<DefaultStr> {
    /// Create a new builder for this type, using the default string type (DefaultStr = SmolStr) if needed
    pub fn new() -> GroupItemBuilder<group_item_state::Empty, DefaultStr> {
        GroupItemBuilder::new()
    }
}

impl<S: BosStr> GroupItem<S> {
    /// Create a new builder for this type
    pub fn builder() -> GroupItemBuilder<group_item_state::Empty, S> {
        GroupItemBuilder::builder()
    }
}

impl GroupItemBuilder<group_item_state::Empty, DefaultStr> {
    /// Create a new builder with all fields unset, using the default string type, if needed
    pub fn new() -> Self {
        GroupItemBuilder {
            _state: PhantomData,
            _fields: (None, None, None, None),
            _type: PhantomData,
        }
    }
}

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

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

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

impl<St, S: BosStr> GroupItemBuilder<St, S>
where
    St: group_item_state::State,
    St::Image: group_item_state::IsUnset,
{
    /// Set the `image` field (required)
    pub fn image(
        mut self,
        value: impl Into<AtUri<S>>,
    ) -> GroupItemBuilder<group_item_state::SetImage<St>, S> {
        self._fields.2 = Option::Some(value.into());
        GroupItemBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

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

impl<St, S: BosStr> GroupItemBuilder<St, S>
where
    St: group_item_state::State,
    St::AddedAt: group_item_state::IsSet,
    St::Group: group_item_state::IsSet,
    St::Image: group_item_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> GroupItem<S> {
        GroupItem {
            added_at: self._fields.0.unwrap(),
            group: self._fields.1.unwrap(),
            image: self._fields.2.unwrap(),
            note: 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>>,
    ) -> GroupItem<S> {
        GroupItem {
            added_at: self._fields.0.unwrap(),
            group: self._fields.1.unwrap(),
            image: self._fields.2.unwrap(),
            note: self._fields.3,
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_cat_vt3e_gallery_groupItem() -> 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("cat.vt3e.gallery.groupItem"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    description: Some(
                        CowStr::new_static("defines an item in a gallery group"),
                    ),
                    key: Some(CowStr::new_static("tid")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(
                            vec![
                                SmolStr::new_static("group"), SmolStr::new_static("image"),
                                SmolStr::new_static("addedAt")
                            ],
                        ),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("addedAt"),
                                LexObjectProperty::String(LexString {
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("group"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "uri of the group that the image belongs to",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::AtUri),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("image"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "uri of the image that this item represents",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::AtUri),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("note"),
                                LexObjectProperty::String(LexString {
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}