jacquard-api 0.12.0-beta.2

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: app.beaconbits.bookmark.item
//
// 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::{BosStr, CowStr, 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;

use crate::community_lexicon::location::address::Address;
use crate::community_lexicon::location::geo::Geo;
#[allow(unused_imports)]
use jacquard_lexicon::validation::{ConstraintError, ValidationPath};
use serde::{Deserialize, Serialize};
/// A saved venue bookmark

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    rename = "app.beaconbits.bookmark.item",
    tag = "$type",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct Item<S: BosStr = DefaultStr> {
    ///Structured address using community lexicon
    #[serde(skip_serializing_if = "Option::is_none")]
    pub address_details: Option<Address<S>>,
    ///Timestamp when the bookmark was created
    pub created_at: Datetime,
    ///Reference to a bookmark folder
    #[serde(skip_serializing_if = "Option::is_none")]
    pub folder_uri: Option<AtUri<S>>,
    ///Structured location using community lexicon
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location: Option<Geo<S>>,
    ///User notes about the bookmark
    #[serde(skip_serializing_if = "Option::is_none")]
    pub notes: Option<S>,
    ///Human-readable address
    #[serde(skip_serializing_if = "Option::is_none")]
    pub venue_address: Option<S>,
    ///Category classification
    #[serde(skip_serializing_if = "Option::is_none")]
    pub venue_category: Option<S>,
    ///Display name of the venue
    pub venue_name: S,
    ///URI identifier for the venue (typically OSM URI)
    pub venue_uri: 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 ItemGetRecordOutput<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cid: Option<Cid<S>>,
    pub uri: AtUri<S>,
    pub value: Item<S>,
}

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

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

#[derive(Debug, Serialize, Deserialize)]
pub struct ItemRecord;
impl XrpcResp for ItemRecord {
    const NSID: &'static str = "app.beaconbits.bookmark.item";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = ItemGetRecordOutput<S>;
    type Err = RecordError;
}

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

impl<S: BosStr> Collection for Item<S> {
    const NSID: &'static str = "app.beaconbits.bookmark.item";
    type Record = ItemRecord;
}

impl Collection for ItemRecord {
    const NSID: &'static str = "app.beaconbits.bookmark.item";
    type Record = ItemRecord;
}

impl<S: BosStr> LexiconSchema for Item<S> {
    fn nsid() -> &'static str {
        "app.beaconbits.bookmark.item"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_app_beaconbits_bookmark_item()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        if let Some(ref value) = self.notes {
            {
                let count = UnicodeSegmentation::graphemes(value.as_ref(), true).count();
                if count > 280usize {
                    return Err(ConstraintError::MaxGraphemes {
                        path: ValidationPath::from_field("notes"),
                        max: 280usize,
                        actual: count,
                    });
                }
            }
        }
        if let Some(ref value) = self.venue_address {
            {
                let count = UnicodeSegmentation::graphemes(value.as_ref(), true).count();
                if count > 256usize {
                    return Err(ConstraintError::MaxGraphemes {
                        path: ValidationPath::from_field("venue_address"),
                        max: 256usize,
                        actual: count,
                    });
                }
            }
        }
        if let Some(ref value) = self.venue_category {
            {
                let count = UnicodeSegmentation::graphemes(value.as_ref(), true).count();
                if count > 64usize {
                    return Err(ConstraintError::MaxGraphemes {
                        path: ValidationPath::from_field("venue_category"),
                        max: 64usize,
                        actual: count,
                    });
                }
            }
        }
        {
            let value = &self.venue_name;
            {
                let count = UnicodeSegmentation::graphemes(value.as_ref(), true).count();
                if count > 128usize {
                    return Err(ConstraintError::MaxGraphemes {
                        path: ValidationPath::from_field("venue_name"),
                        max: 128usize,
                        actual: count,
                    });
                }
            }
        }
        {
            let value = &self.venue_uri;
            {
                let count = UnicodeSegmentation::graphemes(value.as_ref(), true).count();
                if count > 512usize {
                    return Err(ConstraintError::MaxGraphemes {
                        path: ValidationPath::from_field("venue_uri"),
                        max: 512usize,
                        actual: count,
                    });
                }
            }
        }
        Ok(())
    }
}

pub mod item_state {

    pub use crate::builder_types::{IsSet, IsUnset, Set, Unset};
    #[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 VenueUri;
        type VenueName;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type CreatedAt = Unset;
        type VenueUri = Unset;
        type VenueName = 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 VenueUri = St::VenueUri;
        type VenueName = St::VenueName;
    }
    ///State transition - sets the `venue_uri` field to Set
    pub struct SetVenueUri<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetVenueUri<St> {}
    impl<St: State> State for SetVenueUri<St> {
        type CreatedAt = St::CreatedAt;
        type VenueUri = Set<members::venue_uri>;
        type VenueName = St::VenueName;
    }
    ///State transition - sets the `venue_name` field to Set
    pub struct SetVenueName<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetVenueName<St> {}
    impl<St: State> State for SetVenueName<St> {
        type CreatedAt = St::CreatedAt;
        type VenueUri = St::VenueUri;
        type VenueName = Set<members::venue_name>;
    }
    /// 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 `venue_uri` field
        pub struct venue_uri(());
        ///Marker type for the `venue_name` field
        pub struct venue_name(());
    }
}

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

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

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

impl<S: BosStr, St: item_state::State> ItemBuilder<S, St> {
    /// Set the `addressDetails` field (optional)
    pub fn address_details(mut self, value: impl Into<Option<Address<S>>>) -> Self {
        self._fields.0 = value.into();
        self
    }
    /// Set the `addressDetails` field to an Option value (optional)
    pub fn maybe_address_details(mut self, value: Option<Address<S>>) -> Self {
        self._fields.0 = value;
        self
    }
}

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

impl<S: BosStr, St: item_state::State> ItemBuilder<S, St> {
    /// Set the `folderUri` field (optional)
    pub fn folder_uri(mut self, value: impl Into<Option<AtUri<S>>>) -> Self {
        self._fields.2 = value.into();
        self
    }
    /// Set the `folderUri` field to an Option value (optional)
    pub fn maybe_folder_uri(mut self, value: Option<AtUri<S>>) -> Self {
        self._fields.2 = value;
        self
    }
}

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

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

impl<S: BosStr, St: item_state::State> ItemBuilder<S, St> {
    /// Set the `venueAddress` field (optional)
    pub fn venue_address(mut self, value: impl Into<Option<S>>) -> Self {
        self._fields.5 = value.into();
        self
    }
    /// Set the `venueAddress` field to an Option value (optional)
    pub fn maybe_venue_address(mut self, value: Option<S>) -> Self {
        self._fields.5 = value;
        self
    }
}

impl<S: BosStr, St: item_state::State> ItemBuilder<S, St> {
    /// Set the `venueCategory` field (optional)
    pub fn venue_category(mut self, value: impl Into<Option<S>>) -> Self {
        self._fields.6 = value.into();
        self
    }
    /// Set the `venueCategory` field to an Option value (optional)
    pub fn maybe_venue_category(mut self, value: Option<S>) -> Self {
        self._fields.6 = value;
        self
    }
}

impl<S: BosStr, St> ItemBuilder<S, St>
where
    St: item_state::State,
    St::VenueName: item_state::IsUnset,
{
    /// Set the `venueName` field (required)
    pub fn venue_name(
        mut self,
        value: impl Into<S>,
    ) -> ItemBuilder<S, item_state::SetVenueName<St>> {
        self._fields.7 = Option::Some(value.into());
        ItemBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> ItemBuilder<S, St>
where
    St: item_state::State,
    St::VenueUri: item_state::IsUnset,
{
    /// Set the `venueUri` field (required)
    pub fn venue_uri(mut self, value: impl Into<S>) -> ItemBuilder<S, item_state::SetVenueUri<St>> {
        self._fields.8 = Option::Some(value.into());
        ItemBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> ItemBuilder<S, St>
where
    St: item_state::State,
    St::CreatedAt: item_state::IsSet,
    St::VenueUri: item_state::IsSet,
    St::VenueName: item_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> Item<S> {
        Item {
            address_details: self._fields.0,
            created_at: self._fields.1.unwrap(),
            folder_uri: self._fields.2,
            location: self._fields.3,
            notes: self._fields.4,
            venue_address: self._fields.5,
            venue_category: self._fields.6,
            venue_name: self._fields.7.unwrap(),
            venue_uri: self._fields.8.unwrap(),
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data.
    pub fn build_with_data(self, extra_data: BTreeMap<SmolStr, Data<S>>) -> Item<S> {
        Item {
            address_details: self._fields.0,
            created_at: self._fields.1.unwrap(),
            folder_uri: self._fields.2,
            location: self._fields.3,
            notes: self._fields.4,
            venue_address: self._fields.5,
            venue_category: self._fields.6,
            venue_name: self._fields.7.unwrap(),
            venue_uri: self._fields.8.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_app_beaconbits_bookmark_item() -> LexiconDoc<'static> {
    use alloc::collections::BTreeMap;
    #[allow(unused_imports)]
    use jacquard_common::{CowStr, deps::smol_str::SmolStr, types::blob::MimeType};
    use jacquard_lexicon::lexicon::*;
    LexiconDoc {
        lexicon: Lexicon::Lexicon1,
        id: CowStr::new_static("app.beaconbits.bookmark.item"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    description: Some(CowStr::new_static("A saved venue bookmark")),
                    key: Some(CowStr::new_static("tid")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(vec![
                            SmolStr::new_static("venueUri"),
                            SmolStr::new_static("venueName"),
                            SmolStr::new_static("createdAt"),
                        ]),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("addressDetails"),
                                LexObjectProperty::Ref(LexRef {
                                    r#ref: CowStr::new_static("community.lexicon.location.address"),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("createdAt"),
                                LexObjectProperty::String(LexString {
                                    description: Some(CowStr::new_static(
                                        "Timestamp when the bookmark was created",
                                    )),
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("folderUri"),
                                LexObjectProperty::String(LexString {
                                    description: Some(CowStr::new_static(
                                        "Reference to a bookmark folder",
                                    )),
                                    format: Some(LexStringFormat::AtUri),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("location"),
                                LexObjectProperty::Ref(LexRef {
                                    r#ref: CowStr::new_static("community.lexicon.location.geo"),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("notes"),
                                LexObjectProperty::String(LexString {
                                    description: Some(CowStr::new_static(
                                        "User notes about the bookmark",
                                    )),
                                    max_graphemes: Some(280usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("venueAddress"),
                                LexObjectProperty::String(LexString {
                                    description: Some(CowStr::new_static("Human-readable address")),
                                    max_graphemes: Some(256usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("venueCategory"),
                                LexObjectProperty::String(LexString {
                                    description: Some(CowStr::new_static(
                                        "Category classification",
                                    )),
                                    max_graphemes: Some(64usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("venueName"),
                                LexObjectProperty::String(LexString {
                                    description: Some(CowStr::new_static(
                                        "Display name of the venue",
                                    )),
                                    max_graphemes: Some(128usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("venueUri"),
                                LexObjectProperty::String(LexString {
                                    description: Some(CowStr::new_static(
                                        "URI identifier for the venue (typically OSM URI)",
                                    )),
                                    max_graphemes: Some(512usize),
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}