jacquard-api 0.12.0-beta.2

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: app.certified.badge.award
//
// 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, UriValue};
use jacquard_common::types::uri::{RecordUri, UriError};
use jacquard_common::types::value::Data;
use jacquard_common::xrpc::XrpcResp;
use jacquard_derive::{IntoStatic, lexicon, open_union};
use jacquard_lexicon::lexicon::LexiconDoc;
use jacquard_lexicon::schema::LexiconSchema;

use crate::app_certified::Did;
use crate::app_certified::badge::definition::Definition;
use crate::com_atproto::repo::strong_ref::StrongRef;
#[allow(unused_imports)]
use jacquard_lexicon::validation::{ConstraintError, ValidationPath};
use serde::{Deserialize, Serialize};
/// Records a badge award to a user, project, or activity claim.

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    rename = "app.certified.badge.award",
    tag = "$type",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct Award<S: BosStr = DefaultStr> {
    ///Reference to the badge definition for this award.
    pub badge: Definition<S>,
    ///Client-declared timestamp when this record was originally created
    pub created_at: Datetime,
    ///Optional statement explaining the reason for this badge award.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub note: Option<S>,
    ///Entity the badge award is for (either an account DID or any specific AT Protocol record), e.g. a user, a project, or a specific activity claim.
    pub subject: AwardSubject<S>,
    ///Optional URL the badge award links to.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<UriValue<S>>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

#[open_union]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(tag = "$type", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub enum AwardSubject<S: BosStr = DefaultStr> {
    #[serde(rename = "app.certified.defs#did")]
    Did(Box<Did<S>>),
    #[serde(rename = "com.atproto.repo.strongRef")]
    StrongRef(Box<StrongRef<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 AwardGetRecordOutput<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cid: Option<Cid<S>>,
    pub uri: AtUri<S>,
    pub value: Award<S>,
}

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

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

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

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

impl<S: BosStr> Collection for Award<S> {
    const NSID: &'static str = "app.certified.badge.award";
    type Record = AwardRecord;
}

impl Collection for AwardRecord {
    const NSID: &'static str = "app.certified.badge.award";
    type Record = AwardRecord;
}

impl<S: BosStr> LexiconSchema for Award<S> {
    fn nsid() -> &'static str {
        "app.certified.badge.award"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_app_certified_badge_award()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        if let Some(ref value) = self.note {
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 500usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("note"),
                    max: 500usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        if let Some(ref value) = self.url {
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 2048usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("url"),
                    max: 2048usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        Ok(())
    }
}

pub mod award_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 Subject;
        type CreatedAt;
        type Badge;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Subject = Unset;
        type CreatedAt = Unset;
        type Badge = Unset;
    }
    ///State transition - sets the `subject` field to Set
    pub struct SetSubject<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetSubject<St> {}
    impl<St: State> State for SetSubject<St> {
        type Subject = Set<members::subject>;
        type CreatedAt = St::CreatedAt;
        type Badge = St::Badge;
    }
    ///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 Subject = St::Subject;
        type CreatedAt = Set<members::created_at>;
        type Badge = St::Badge;
    }
    ///State transition - sets the `badge` field to Set
    pub struct SetBadge<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetBadge<St> {}
    impl<St: State> State for SetBadge<St> {
        type Subject = St::Subject;
        type CreatedAt = St::CreatedAt;
        type Badge = Set<members::badge>;
    }
    /// 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 `created_at` field
        pub struct created_at(());
        ///Marker type for the `badge` field
        pub struct badge(());
    }
}

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

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

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

impl<S: BosStr, St> AwardBuilder<S, St>
where
    St: award_state::State,
    St::Badge: award_state::IsUnset,
{
    /// Set the `badge` field (required)
    pub fn badge(
        mut self,
        value: impl Into<Definition<S>>,
    ) -> AwardBuilder<S, award_state::SetBadge<St>> {
        self._fields.0 = Option::Some(value.into());
        AwardBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

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

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

impl<S: BosStr, St> AwardBuilder<S, St>
where
    St: award_state::State,
    St::Subject: award_state::IsUnset,
{
    /// Set the `subject` field (required)
    pub fn subject(
        mut self,
        value: impl Into<AwardSubject<S>>,
    ) -> AwardBuilder<S, award_state::SetSubject<St>> {
        self._fields.3 = Option::Some(value.into());
        AwardBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

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

impl<S: BosStr, St> AwardBuilder<S, St>
where
    St: award_state::State,
    St::Subject: award_state::IsSet,
    St::CreatedAt: award_state::IsSet,
    St::Badge: award_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> Award<S> {
        Award {
            badge: self._fields.0.unwrap(),
            created_at: self._fields.1.unwrap(),
            note: self._fields.2,
            subject: self._fields.3.unwrap(),
            url: self._fields.4,
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data.
    pub fn build_with_data(self, extra_data: BTreeMap<SmolStr, Data<S>>) -> Award<S> {
        Award {
            badge: self._fields.0.unwrap(),
            created_at: self._fields.1.unwrap(),
            note: self._fields.2,
            subject: self._fields.3.unwrap(),
            url: self._fields.4,
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_app_certified_badge_award() -> 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.certified.badge.award"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    description: Some(
                        CowStr::new_static(
                            "Records a badge award to a user, project, or activity claim.",
                        ),
                    ),
                    key: Some(CowStr::new_static("tid")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(
                            vec![
                                SmolStr::new_static("badge"),
                                SmolStr::new_static("subject"),
                                SmolStr::new_static("createdAt")
                            ],
                        ),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("badge"),
                                LexObjectProperty::Ref(LexRef {
                                    r#ref: CowStr::new_static("app.certified.badge.definition"),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("createdAt"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "Client-declared timestamp when this record was originally created",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("note"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "Optional statement explaining the reason for this badge award.",
                                        ),
                                    ),
                                    max_length: Some(500usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("subject"),
                                LexObjectProperty::Union(LexRefUnion {
                                    description: Some(
                                        CowStr::new_static(
                                            "Entity the badge award is for (either an account DID or any specific AT Protocol record), e.g. a user, a project, or a specific activity claim.",
                                        ),
                                    ),
                                    refs: vec![
                                        CowStr::new_static("app.certified.defs#did"),
                                        CowStr::new_static("com.atproto.repo.strongRef")
                                    ],
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("url"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static("Optional URL the badge award links to."),
                                    ),
                                    format: Some(LexStringFormat::Uri),
                                    max_length: Some(2048usize),
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}