jacquard-api 0.12.0-beta.1

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: sh.tangled.label.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::{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::collection::{Collection, RecordError};
use jacquard_common::types::string::{AtUri, Nsid, 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;

#[allow(unused_imports)]
use jacquard_lexicon::validation::{ConstraintError, ValidationPath};
use serde::{Serialize, Deserialize};
use crate::sh_tangled::label::definition;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    rename = "sh.tangled.label.definition",
    tag = "$type",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct Definition<S: BosStr = DefaultStr> {
    ///The hex value for the background color for the label. Appviews may choose to respect this.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub color: Option<S>,
    pub created_at: Datetime,
    ///Whether this label can be repeated for a given entity, eg.: [reviewer:foo, reviewer:bar]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub multiple: Option<bool>,
    ///The display name of this label.
    pub name: S,
    ///The areas of the repo this label may apply to, eg.: sh.tangled.repo.issue. Appviews may choose to respect this.
    pub scope: Vec<Nsid<S>>,
    ///The type definition of this label. Appviews may allow sorting for certain types.
    pub value_type: definition::ValueType<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>,
}


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic, Default)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct ValueType<S: BosStr = DefaultStr> {
    ///Closed set of values that this label can take.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub r#enum: Option<Vec<S>>,
    ///An optional constraint that can be applied on string concrete types.
    pub format: S,
    ///The concrete type of this label's value.
    pub r#type: S,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<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 = "sh.tangled.label.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 = "sh.tangled.label.definition";
    type Record = DefinitionRecord;
}

impl Collection for DefinitionRecord {
    const NSID: &'static str = "sh.tangled.label.definition";
    type Record = DefinitionRecord;
}

impl<S: BosStr> LexiconSchema for Definition<S> {
    fn nsid() -> &'static str {
        "sh.tangled.label.definition"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_sh_tangled_label_definition()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        {
            let value = &self.name;
            {
                let count = UnicodeSegmentation::graphemes(value.as_ref(), true).count();
                if count > 40usize {
                    return Err(ConstraintError::MaxGraphemes {
                        path: ValidationPath::from_field("name"),
                        max: 40usize,
                        actual: count,
                    });
                }
            }
        }
        {
            let value = &self.name;
            {
                let count = UnicodeSegmentation::graphemes(value.as_ref(), true).count();
                if count < 1usize {
                    return Err(ConstraintError::MinGraphemes {
                        path: ValidationPath::from_field("name"),
                        min: 1usize,
                        actual: count,
                    });
                }
            }
        }
        Ok(())
    }
}

impl<S: BosStr> LexiconSchema for ValueType<S> {
    fn nsid() -> &'static str {
        "sh.tangled.label.definition"
    }
    fn def_name() -> &'static str {
        "valueType"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_sh_tangled_label_definition()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

pub mod definition_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 Name;
        type Scope;
        type CreatedAt;
        type ValueType;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Name = Unset;
        type Scope = Unset;
        type CreatedAt = Unset;
        type ValueType = Unset;
    }
    ///State transition - sets the `name` field to Set
    pub struct SetName<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetName<St> {}
    impl<St: State> State for SetName<St> {
        type Name = Set<members::name>;
        type Scope = St::Scope;
        type CreatedAt = St::CreatedAt;
        type ValueType = St::ValueType;
    }
    ///State transition - sets the `scope` field to Set
    pub struct SetScope<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetScope<St> {}
    impl<St: State> State for SetScope<St> {
        type Name = St::Name;
        type Scope = Set<members::scope>;
        type CreatedAt = St::CreatedAt;
        type ValueType = St::ValueType;
    }
    ///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 Name = St::Name;
        type Scope = St::Scope;
        type CreatedAt = Set<members::created_at>;
        type ValueType = St::ValueType;
    }
    ///State transition - sets the `value_type` field to Set
    pub struct SetValueType<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetValueType<St> {}
    impl<St: State> State for SetValueType<St> {
        type Name = St::Name;
        type Scope = St::Scope;
        type CreatedAt = St::CreatedAt;
        type ValueType = Set<members::value_type>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `name` field
        pub struct name(());
        ///Marker type for the `scope` field
        pub struct scope(());
        ///Marker type for the `created_at` field
        pub struct created_at(());
        ///Marker type for the `value_type` field
        pub struct value_type(());
    }
}

/// Builder for constructing an instance of this type.
pub struct DefinitionBuilder<S: BosStr, St: definition_state::State> {
    _state: PhantomData<fn() -> St>,
    _fields: (
        Option<S>,
        Option<Datetime>,
        Option<bool>,
        Option<S>,
        Option<Vec<Nsid<S>>>,
        Option<definition::ValueType<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 `color` field (optional)
    pub fn color(mut self, value: impl Into<Option<S>>) -> Self {
        self._fields.0 = value.into();
        self
    }
    /// Set the `color` field to an Option value (optional)
    pub fn maybe_color(mut self, value: Option<S>) -> Self {
        self._fields.0 = value;
        self
    }
}

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.1 = Option::Some(value.into());
        DefinitionBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

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

impl<S: BosStr, St> DefinitionBuilder<S, St>
where
    St: definition_state::State,
    St::Name: definition_state::IsUnset,
{
    /// Set the `name` field (required)
    pub fn name(
        mut self,
        value: impl Into<S>,
    ) -> DefinitionBuilder<S, definition_state::SetName<St>> {
        self._fields.3 = 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::Scope: definition_state::IsUnset,
{
    /// Set the `scope` field (required)
    pub fn scope(
        mut self,
        value: impl Into<Vec<Nsid<S>>>,
    ) -> DefinitionBuilder<S, definition_state::SetScope<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::ValueType: definition_state::IsUnset,
{
    /// Set the `valueType` field (required)
    pub fn value_type(
        mut self,
        value: impl Into<definition::ValueType<S>>,
    ) -> DefinitionBuilder<S, definition_state::SetValueType<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::Name: definition_state::IsSet,
    St::Scope: definition_state::IsSet,
    St::CreatedAt: definition_state::IsSet,
    St::ValueType: definition_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> Definition<S> {
        Definition {
            color: self._fields.0,
            created_at: self._fields.1.unwrap(),
            multiple: self._fields.2,
            name: self._fields.3.unwrap(),
            scope: self._fields.4.unwrap(),
            value_type: 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 {
            color: self._fields.0,
            created_at: self._fields.1.unwrap(),
            multiple: self._fields.2,
            name: self._fields.3.unwrap(),
            scope: self._fields.4.unwrap(),
            value_type: self._fields.5.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_sh_tangled_label_definition() -> 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("sh.tangled.label.definition"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    key: Some(CowStr::new_static("any")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(
                            vec![
                                SmolStr::new_static("name"),
                                SmolStr::new_static("valueType"),
                                SmolStr::new_static("scope"),
                                SmolStr::new_static("createdAt")
                            ],
                        ),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("color"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "The hex value for the background color for the label. Appviews may choose to respect this.",
                                        ),
                                    ),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("createdAt"),
                                LexObjectProperty::String(LexString {
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("multiple"),
                                LexObjectProperty::Boolean(LexBoolean {
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("name"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static("The display name of this label."),
                                    ),
                                    min_graphemes: Some(1usize),
                                    max_graphemes: Some(40usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("scope"),
                                LexObjectProperty::Array(LexArray {
                                    description: Some(
                                        CowStr::new_static(
                                            "The areas of the repo this label may apply to, eg.: sh.tangled.repo.issue. Appviews may choose to respect this.",
                                        ),
                                    ),
                                    items: LexArrayItem::String(LexString {
                                        format: Some(LexStringFormat::Nsid),
                                        ..Default::default()
                                    }),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("valueType"),
                                LexObjectProperty::Ref(LexRef {
                                    r#ref: CowStr::new_static("#valueType"),
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map.insert(
                SmolStr::new_static("valueType"),
                LexUserType::Object(LexObject {
                    required: Some(
                        vec![SmolStr::new_static("type"), SmolStr::new_static("format")],
                    ),
                    properties: {
                        #[allow(unused_mut)]
                        let mut map = BTreeMap::new();
                        map.insert(
                            SmolStr::new_static("enum"),
                            LexObjectProperty::Array(LexArray {
                                description: Some(
                                    CowStr::new_static(
                                        "Closed set of values that this label can take.",
                                    ),
                                ),
                                items: LexArrayItem::String(LexString {
                                    ..Default::default()
                                }),
                                ..Default::default()
                            }),
                        );
                        map.insert(
                            SmolStr::new_static("format"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static(
                                        "An optional constraint that can be applied on string concrete types.",
                                    ),
                                ),
                                ..Default::default()
                            }),
                        );
                        map.insert(
                            SmolStr::new_static("type"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static(
                                        "The concrete type of this label's value.",
                                    ),
                                ),
                                ..Default::default()
                            }),
                        );
                        map
                    },
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}