jacquard-api 0.11.0

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

pub mod game;
pub mod stats;


#[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::string::{Did, AtUri, Datetime};
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};
/// Holds the signature for another record showing it has verified it to the best of it's ability and it should be trusted if the signatures match.

#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct VerificationRef<'a> {
    pub created_at: Datetime,
    ///The at://uri for the public did:key to verify the remote 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).
    #[serde(borrow)]
    pub key_ref: AtUri<'a>,
    ///The at://uri for the record that is being verified.
    #[serde(borrow)]
    pub record_ref: AtUri<'a>,
    ///The public verifiable signature of the record. Serialization of the records valued
    #[serde(borrow)]
    pub signature: CowStr<'a>,
    ///DID of the subject the verification applies to.
    #[serde(borrow)]
    pub subject: Did<'a>,
}

impl<'a> LexiconSchema for VerificationRef<'a> {
    fn nsid() -> &'static str {
        "blue.2048.verification.defs"
    }
    fn def_name() -> &'static str {
        "verificationRef"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_blue_2048_verification_defs()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

pub mod verification_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 Subject;
        type KeyRef;
        type RecordRef;
        type Signature;
        type CreatedAt;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Subject = Unset;
        type KeyRef = Unset;
        type RecordRef = Unset;
        type Signature = Unset;
        type CreatedAt = Unset;
    }
    ///State transition - sets the `subject` field to Set
    pub struct SetSubject<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetSubject<S> {}
    impl<S: State> State for SetSubject<S> {
        type Subject = Set<members::subject>;
        type KeyRef = S::KeyRef;
        type RecordRef = S::RecordRef;
        type Signature = S::Signature;
        type CreatedAt = S::CreatedAt;
    }
    ///State transition - sets the `key_ref` field to Set
    pub struct SetKeyRef<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetKeyRef<S> {}
    impl<S: State> State for SetKeyRef<S> {
        type Subject = S::Subject;
        type KeyRef = Set<members::key_ref>;
        type RecordRef = S::RecordRef;
        type Signature = S::Signature;
        type CreatedAt = S::CreatedAt;
    }
    ///State transition - sets the `record_ref` field to Set
    pub struct SetRecordRef<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetRecordRef<S> {}
    impl<S: State> State for SetRecordRef<S> {
        type Subject = S::Subject;
        type KeyRef = S::KeyRef;
        type RecordRef = Set<members::record_ref>;
        type Signature = S::Signature;
        type CreatedAt = S::CreatedAt;
    }
    ///State transition - sets the `signature` field to Set
    pub struct SetSignature<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetSignature<S> {}
    impl<S: State> State for SetSignature<S> {
        type Subject = S::Subject;
        type KeyRef = S::KeyRef;
        type RecordRef = S::RecordRef;
        type Signature = Set<members::signature>;
        type CreatedAt = S::CreatedAt;
    }
    ///State transition - sets the `created_at` field to Set
    pub struct SetCreatedAt<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetCreatedAt<S> {}
    impl<S: State> State for SetCreatedAt<S> {
        type Subject = S::Subject;
        type KeyRef = S::KeyRef;
        type RecordRef = S::RecordRef;
        type Signature = S::Signature;
        type CreatedAt = Set<members::created_at>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `subject` field
        pub struct subject(());
        ///Marker type for the `key_ref` field
        pub struct key_ref(());
        ///Marker type for the `record_ref` field
        pub struct record_ref(());
        ///Marker type for the `signature` field
        pub struct signature(());
        ///Marker type for the `created_at` field
        pub struct created_at(());
    }
}

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

impl<'a> VerificationRef<'a> {
    /// Create a new builder for this type
    pub fn new() -> VerificationRefBuilder<'a, verification_ref_state::Empty> {
        VerificationRefBuilder::new()
    }
}

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

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

impl<'a, S> VerificationRefBuilder<'a, S>
where
    S: verification_ref_state::State,
    S::KeyRef: verification_ref_state::IsUnset,
{
    /// Set the `keyRef` field (required)
    pub fn key_ref(
        mut self,
        value: impl Into<AtUri<'a>>,
    ) -> VerificationRefBuilder<'a, verification_ref_state::SetKeyRef<S>> {
        self._fields.1 = Option::Some(value.into());
        VerificationRefBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> VerificationRefBuilder<'a, S>
where
    S: verification_ref_state::State,
    S::RecordRef: verification_ref_state::IsUnset,
{
    /// Set the `recordRef` field (required)
    pub fn record_ref(
        mut self,
        value: impl Into<AtUri<'a>>,
    ) -> VerificationRefBuilder<'a, verification_ref_state::SetRecordRef<S>> {
        self._fields.2 = Option::Some(value.into());
        VerificationRefBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> VerificationRefBuilder<'a, S>
where
    S: verification_ref_state::State,
    S::Signature: verification_ref_state::IsUnset,
{
    /// Set the `signature` field (required)
    pub fn signature(
        mut self,
        value: impl Into<CowStr<'a>>,
    ) -> VerificationRefBuilder<'a, verification_ref_state::SetSignature<S>> {
        self._fields.3 = Option::Some(value.into());
        VerificationRefBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> VerificationRefBuilder<'a, S>
where
    S: verification_ref_state::State,
    S::Subject: verification_ref_state::IsUnset,
{
    /// Set the `subject` field (required)
    pub fn subject(
        mut self,
        value: impl Into<Did<'a>>,
    ) -> VerificationRefBuilder<'a, verification_ref_state::SetSubject<S>> {
        self._fields.4 = Option::Some(value.into());
        VerificationRefBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> VerificationRefBuilder<'a, S>
where
    S: verification_ref_state::State,
    S::Subject: verification_ref_state::IsSet,
    S::KeyRef: verification_ref_state::IsSet,
    S::RecordRef: verification_ref_state::IsSet,
    S::Signature: verification_ref_state::IsSet,
    S::CreatedAt: verification_ref_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> VerificationRef<'a> {
        VerificationRef {
            created_at: self._fields.0.unwrap(),
            key_ref: self._fields.1.unwrap(),
            record_ref: self._fields.2.unwrap(),
            signature: self._fields.3.unwrap(),
            subject: self._fields.4.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>,
        >,
    ) -> VerificationRef<'a> {
        VerificationRef {
            created_at: self._fields.0.unwrap(),
            key_ref: self._fields.1.unwrap(),
            record_ref: self._fields.2.unwrap(),
            signature: self._fields.3.unwrap(),
            subject: self._fields.4.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_blue_2048_verification_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.verification.defs"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("verificationRef"),
                LexUserType::Object(LexObject {
                    description: Some(
                        CowStr::new_static(
                            "Holds the signature for another record showing it has verified it to the best of it's ability and it should be trusted if the signatures match.",
                        ),
                    ),
                    required: Some(
                        vec![
                            SmolStr::new_static("keyRef"),
                            SmolStr::new_static("recordRef"),
                            SmolStr::new_static("subject"),
                            SmolStr::new_static("signature"),
                            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("keyRef"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static(
                                        "The at://uri for the public did:key to verify the remote 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).",
                                    ),
                                ),
                                format: Some(LexStringFormat::AtUri),
                                ..Default::default()
                            }),
                        );
                        map.insert(
                            SmolStr::new_static("recordRef"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static(
                                        "The at://uri for the record that is being verified.",
                                    ),
                                ),
                                format: Some(LexStringFormat::AtUri),
                                ..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 valued",
                                    ),
                                ),
                                ..Default::default()
                            }),
                        );
                        map.insert(
                            SmolStr::new_static("subject"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static(
                                        "DID of the subject the verification applies to.",
                                    ),
                                ),
                                format: Some(LexStringFormat::Did),
                                ..Default::default()
                            }),
                        );
                        map
                    },
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}