jacquard-api 0.12.0-beta.2

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: app.certified.badge.definition
//
// 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::blob::BlobRef;
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::app_certified::Did;
#[allow(unused_imports)]
use jacquard_lexicon::validation::{ConstraintError, ValidationPath};
use serde::{Deserialize, Serialize};
/// Defines a badge that can be awarded via badge award records to users, projects, or activity claims.

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    rename = "app.certified.badge.definition",
    tag = "$type",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct Definition<S: BosStr = DefaultStr> {
    ///Optional allowlist of DIDs allowed to issue this badge. If omitted, anyone may issue it.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub allowed_issuers: Option<Vec<Did<S>>>,
    ///Category of the badge (e.g. endorsement, participation, affiliation).
    pub badge_type: S,
    ///Client-declared timestamp when this record was originally created
    pub created_at: Datetime,
    ///Optional short statement describing what the badge represents.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<S>,
    ///Icon representing the badge, stored as a blob for compact visual display.
    pub icon: BlobRef<S>,
    ///Human-readable title of the badge.
    pub title: 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 DefinitionGetRecordOutput<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cid: Option<Cid<S>>,
    pub uri: AtUri<S>,
    pub value: Definition<S>,
}

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

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

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

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

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

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

impl<S: BosStr> LexiconSchema for Definition<S> {
    fn nsid() -> &'static str {
        "app.certified.badge.definition"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_app_certified_badge_definition()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        if let Some(ref value) = self.allowed_issuers {
            #[allow(unused_comparisons)]
            if value.len() > 100usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("allowed_issuers"),
                    max: 100usize,
                    actual: value.len(),
                });
            }
        }
        {
            let value = &self.badge_type;
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 100usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("badge_type"),
                    max: 100usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        if let Some(ref value) = self.description {
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 5000usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("description"),
                    max: 5000usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        if let Some(ref value) = self.description {
            {
                let count = UnicodeSegmentation::graphemes(value.as_ref(), true).count();
                if count > 500usize {
                    return Err(ConstraintError::MaxGraphemes {
                        path: ValidationPath::from_field("description"),
                        max: 500usize,
                        actual: count,
                    });
                }
            }
        }
        {
            let value = &self.icon;
            {
                let size = value.blob().size;
                if size > 1048576usize {
                    return Err(ConstraintError::BlobTooLarge {
                        path: ValidationPath::from_field("icon"),
                        max: 1048576usize,
                        actual: size,
                    });
                }
            }
        }
        {
            let value = &self.icon;
            {
                let mime = value.blob().mime_type.as_str();
                let accepted: &[&str] = &["image/png", "image/jpeg", "image/webp", "image/svg+xml"];
                let matched = accepted.iter().any(|pattern| {
                    if *pattern == "*/*" {
                        true
                    } else if pattern.ends_with("/*") {
                        let prefix = &pattern[..pattern.len() - 2];
                        mime.starts_with(prefix) && mime.as_bytes().get(prefix.len()) == Some(&b'/')
                    } else {
                        mime == *pattern
                    }
                });
                if !matched {
                    return Err(ConstraintError::BlobMimeTypeNotAccepted {
                        path: ValidationPath::from_field("icon"),
                        accepted: vec![
                            "image/png".to_string(),
                            "image/jpeg".to_string(),
                            "image/webp".to_string(),
                            "image/svg+xml".to_string(),
                        ],
                        actual: mime.to_string(),
                    });
                }
            }
        }
        {
            let value = &self.title;
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 256usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("title"),
                    max: 256usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        Ok(())
    }
}

pub mod definition_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 Title;
        type Icon;
        type BadgeType;
        type CreatedAt;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Title = Unset;
        type Icon = Unset;
        type BadgeType = Unset;
        type CreatedAt = Unset;
    }
    ///State transition - sets the `title` field to Set
    pub struct SetTitle<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetTitle<St> {}
    impl<St: State> State for SetTitle<St> {
        type Title = Set<members::title>;
        type Icon = St::Icon;
        type BadgeType = St::BadgeType;
        type CreatedAt = St::CreatedAt;
    }
    ///State transition - sets the `icon` field to Set
    pub struct SetIcon<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetIcon<St> {}
    impl<St: State> State for SetIcon<St> {
        type Title = St::Title;
        type Icon = Set<members::icon>;
        type BadgeType = St::BadgeType;
        type CreatedAt = St::CreatedAt;
    }
    ///State transition - sets the `badge_type` field to Set
    pub struct SetBadgeType<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetBadgeType<St> {}
    impl<St: State> State for SetBadgeType<St> {
        type Title = St::Title;
        type Icon = St::Icon;
        type BadgeType = Set<members::badge_type>;
        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 Title = St::Title;
        type Icon = St::Icon;
        type BadgeType = St::BadgeType;
        type CreatedAt = Set<members::created_at>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `title` field
        pub struct title(());
        ///Marker type for the `icon` field
        pub struct icon(());
        ///Marker type for the `badge_type` field
        pub struct badge_type(());
        ///Marker type for the `created_at` field
        pub struct created_at(());
    }
}

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

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

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

impl<S: BosStr, St: definition_state::State> DefinitionBuilder<S, St> {
    /// Set the `allowedIssuers` field (optional)
    pub fn allowed_issuers(mut self, value: impl Into<Option<Vec<Did<S>>>>) -> Self {
        self._fields.0 = value.into();
        self
    }
    /// Set the `allowedIssuers` field to an Option value (optional)
    pub fn maybe_allowed_issuers(mut self, value: Option<Vec<Did<S>>>) -> Self {
        self._fields.0 = value;
        self
    }
}

impl<S: BosStr, St> DefinitionBuilder<S, St>
where
    St: definition_state::State,
    St::BadgeType: definition_state::IsUnset,
{
    /// Set the `badgeType` field (required)
    pub fn badge_type(
        mut self,
        value: impl Into<S>,
    ) -> DefinitionBuilder<S, definition_state::SetBadgeType<St>> {
        self._fields.1 = Option::Some(value.into());
        DefinitionBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

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

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

impl<S: BosStr, St> DefinitionBuilder<S, St>
where
    St: definition_state::State,
    St::Icon: definition_state::IsUnset,
{
    /// Set the `icon` field (required)
    pub fn icon(
        mut self,
        value: impl Into<BlobRef<S>>,
    ) -> DefinitionBuilder<S, definition_state::SetIcon<St>> {
        self._fields.4 = Option::Some(value.into());
        DefinitionBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> DefinitionBuilder<S, St>
where
    St: definition_state::State,
    St::Title: definition_state::IsUnset,
{
    /// Set the `title` field (required)
    pub fn title(
        mut self,
        value: impl Into<S>,
    ) -> DefinitionBuilder<S, definition_state::SetTitle<St>> {
        self._fields.5 = Option::Some(value.into());
        DefinitionBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> DefinitionBuilder<S, St>
where
    St: definition_state::State,
    St::Title: definition_state::IsSet,
    St::Icon: definition_state::IsSet,
    St::BadgeType: definition_state::IsSet,
    St::CreatedAt: definition_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> Definition<S> {
        Definition {
            allowed_issuers: self._fields.0,
            badge_type: self._fields.1.unwrap(),
            created_at: self._fields.2.unwrap(),
            description: self._fields.3,
            icon: self._fields.4.unwrap(),
            title: self._fields.5.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>>) -> Definition<S> {
        Definition {
            allowed_issuers: self._fields.0,
            badge_type: self._fields.1.unwrap(),
            created_at: self._fields.2.unwrap(),
            description: self._fields.3,
            icon: self._fields.4.unwrap(),
            title: self._fields.5.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_app_certified_badge_definition() -> 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.definition"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    description: Some(
                        CowStr::new_static(
                            "Defines a badge that can be awarded via badge award records to users, projects, or activity claims.",
                        ),
                    ),
                    key: Some(CowStr::new_static("tid")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(
                            vec![
                                SmolStr::new_static("title"),
                                SmolStr::new_static("badgeType"),
                                SmolStr::new_static("icon"),
                                SmolStr::new_static("createdAt")
                            ],
                        ),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("allowedIssuers"),
                                LexObjectProperty::Array(LexArray {
                                    description: Some(
                                        CowStr::new_static(
                                            "Optional allowlist of DIDs allowed to issue this badge. If omitted, anyone may issue it.",
                                        ),
                                    ),
                                    items: LexArrayItem::Ref(LexRef {
                                        r#ref: CowStr::new_static("app.certified.defs#did"),
                                        ..Default::default()
                                    }),
                                    max_length: Some(100usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("badgeType"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "Category of the badge (e.g. endorsement, participation, affiliation).",
                                        ),
                                    ),
                                    max_length: Some(100usize),
                                    ..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("description"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "Optional short statement describing what the badge represents.",
                                        ),
                                    ),
                                    max_length: Some(5000usize),
                                    max_graphemes: Some(500usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("icon"),
                                LexObjectProperty::Blob(LexBlob { ..Default::default() }),
                            );
                            map.insert(
                                SmolStr::new_static("title"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static("Human-readable title of the badge."),
                                    ),
                                    max_length: Some(256usize),
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}