jacquard-api 0.12.0-beta.1

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: blue.2048.key.defs
//
// This file was automatically generated from Lexicon schemas.
// Any manual changes will be overwritten on the next regeneration.

pub mod game;
pub mod player;


#[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::string::Datetime;
use jacquard_common::types::value::Data;
use jacquard_derive::IntoStatic;
use jacquard_lexicon::lexicon::LexiconDoc;
use jacquard_lexicon::schema::LexiconSchema;

#[allow(unused_imports)]
use jacquard_lexicon::validation::{ConstraintError, ValidationPath};
use serde::{Serialize, Deserialize};
/// A record that holds a did:key used to verify records. Use the collection to know the type of verification. Example blue.2048.key.game is for blue.2048.game records

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct Key<S: BosStr = DefaultStr> {
    pub created_at: Datetime,
    ///A did:key used to verify records came from an at://2048 authority
    pub key: S,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/// a signature for an at://2048 record meaning it has been verified by a service. Most likely @2048.blue

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct SignatureRef<S: BosStr = DefaultStr> {
    ///The at://uri for the public did:key to verify this record. This also counts as the authority of the verification (example @2048.blue). As well as the type of verification by the collection name (blue.2048.key.game).
    pub at_uri: S,
    pub created_at: Datetime,
    ///The public verifiable signature of the record. Serialization of the records value minus the signature field
    pub signature: S,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

impl<S: BosStr> LexiconSchema for Key<S> {
    fn nsid() -> &'static str {
        "blue.2048.key.defs"
    }
    fn def_name() -> &'static str {
        "key"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_blue_2048_key_defs()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

impl<S: BosStr> LexiconSchema for SignatureRef<S> {
    fn nsid() -> &'static str {
        "blue.2048.key.defs"
    }
    fn def_name() -> &'static str {
        "signatureRef"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_blue_2048_key_defs()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

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

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

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

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

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

impl<S: BosStr, St> KeyBuilder<S, St>
where
    St: key_state::State,
    St::Key: key_state::IsUnset,
{
    /// Set the `key` field (required)
    pub fn key(mut self, value: impl Into<S>) -> KeyBuilder<S, key_state::SetKey<St>> {
        self._fields.1 = Option::Some(value.into());
        KeyBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> KeyBuilder<S, St>
where
    St: key_state::State,
    St::Key: key_state::IsSet,
    St::CreatedAt: key_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> Key<S> {
        Key {
            created_at: self._fields.0.unwrap(),
            key: self._fields.1.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>>) -> Key<S> {
        Key {
            created_at: self._fields.0.unwrap(),
            key: self._fields.1.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_blue_2048_key_defs() -> 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("blue.2048.key.defs"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("key"),
                LexUserType::Object(LexObject {
                    description: Some(
                        CowStr::new_static(
                            "A record that holds a did:key used to verify records. Use the collection to know the type of verification. Example blue.2048.key.game is for blue.2048.game records",
                        ),
                    ),
                    required: Some(
                        vec![
                            SmolStr::new_static("key"), SmolStr::new_static("createdAt")
                        ],
                    ),
                    properties: {
                        #[allow(unused_mut)]
                        let mut map = BTreeMap::new();
                        map.insert(
                            SmolStr::new_static("createdAt"),
                            LexObjectProperty::String(LexString {
                                format: Some(LexStringFormat::Datetime),
                                ..Default::default()
                            }),
                        );
                        map.insert(
                            SmolStr::new_static("key"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static(
                                        "A did:key used to verify records came from an at://2048 authority",
                                    ),
                                ),
                                ..Default::default()
                            }),
                        );
                        map
                    },
                    ..Default::default()
                }),
            );
            map.insert(
                SmolStr::new_static("signatureRef"),
                LexUserType::Object(LexObject {
                    description: Some(
                        CowStr::new_static(
                            "a signature for an at://2048 record meaning it has been verified by a service. Most likely @2048.blue",
                        ),
                    ),
                    required: Some(
                        vec![
                            SmolStr::new_static("atURI"),
                            SmolStr::new_static("signature"),
                            SmolStr::new_static("createdAt")
                        ],
                    ),
                    properties: {
                        #[allow(unused_mut)]
                        let mut map = BTreeMap::new();
                        map.insert(
                            SmolStr::new_static("atURI"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static(
                                        "The at://uri for the public did:key to verify this record. This also counts as the authority of the verification (example @2048.blue). As well as the type of verification by the collection name (blue.2048.key.game).",
                                    ),
                                ),
                                ..Default::default()
                            }),
                        );
                        map.insert(
                            SmolStr::new_static("createdAt"),
                            LexObjectProperty::String(LexString {
                                format: Some(LexStringFormat::Datetime),
                                ..Default::default()
                            }),
                        );
                        map.insert(
                            SmolStr::new_static("signature"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static(
                                        "The public verifiable signature of the record. Serialization of the records value minus the signature field",
                                    ),
                                ),
                                ..Default::default()
                            }),
                        );
                        map
                    },
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}

pub mod signature_ref_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 AtUri;
        type Signature;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type CreatedAt = Unset;
        type AtUri = Unset;
        type Signature = 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 AtUri = St::AtUri;
        type Signature = St::Signature;
    }
    ///State transition - sets the `at_uri` field to Set
    pub struct SetAtUri<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetAtUri<St> {}
    impl<St: State> State for SetAtUri<St> {
        type CreatedAt = St::CreatedAt;
        type AtUri = Set<members::at_uri>;
        type Signature = St::Signature;
    }
    ///State transition - sets the `signature` field to Set
    pub struct SetSignature<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetSignature<St> {}
    impl<St: State> State for SetSignature<St> {
        type CreatedAt = St::CreatedAt;
        type AtUri = St::AtUri;
        type Signature = Set<members::signature>;
    }
    /// 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 `at_uri` field
        pub struct at_uri(());
        ///Marker type for the `signature` field
        pub struct signature(());
    }
}

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

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

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

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

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

impl<S: BosStr, St> SignatureRefBuilder<S, St>
where
    St: signature_ref_state::State,
    St::Signature: signature_ref_state::IsUnset,
{
    /// Set the `signature` field (required)
    pub fn signature(
        mut self,
        value: impl Into<S>,
    ) -> SignatureRefBuilder<S, signature_ref_state::SetSignature<St>> {
        self._fields.2 = Option::Some(value.into());
        SignatureRefBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> SignatureRefBuilder<S, St>
where
    St: signature_ref_state::State,
    St::CreatedAt: signature_ref_state::IsSet,
    St::AtUri: signature_ref_state::IsSet,
    St::Signature: signature_ref_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> SignatureRef<S> {
        SignatureRef {
            at_uri: self._fields.0.unwrap(),
            created_at: self._fields.1.unwrap(),
            signature: self._fields.2.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>>,
    ) -> SignatureRef<S> {
        SignatureRef {
            at_uri: self._fields.0.unwrap(),
            created_at: self._fields.1.unwrap(),
            signature: self._fields.2.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}