jacquard-api 0.11.0

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: place.stream.moderation.permission
//
// 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;

#[allow(unused_imports)]
use jacquard_common::deps::codegen::unicode_segmentation::UnicodeSegmentation;
use jacquard_common::types::collection::{Collection, RecordError};
use jacquard_common::types::string::{Did, AtUri, Cid, Datetime};
use jacquard_common::types::uri::{RecordUri, UriError};
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};
/// Record granting moderation permissions to a user for this streamer's content.

#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct Permission<'a> {
    ///Client-declared timestamp when this moderator was added.
    pub created_at: Datetime,
    ///Optional expiration time for this delegation. If set, the delegation is invalid after this time.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub expiration_time: Option<Datetime>,
    ///The DID of the user granted moderator permissions.
    #[serde(borrow)]
    pub moderator: Did<'a>,
    ///Array of permissions granted to this moderator. 'ban' covers blocks/bans (with optional expiration), 'hide' covers message gates, 'livestream.manage' allows updating livestream metadata.
    #[serde(borrow)]
    pub permissions: Vec<CowStr<'a>>,
}

/// 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 PermissionGetRecordOutput<'a> {
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub cid: Option<Cid<'a>>,
    #[serde(borrow)]
    pub uri: AtUri<'a>,
    #[serde(borrow)]
    pub value: Permission<'a>,
}

impl<'a> Permission<'a> {
    pub fn uri(
        uri: impl Into<CowStr<'a>>,
    ) -> Result<RecordUri<'a, PermissionRecord>, UriError> {
        RecordUri::try_from_uri(AtUri::new_cow(uri.into())?)
    }
}

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

#[derive(Debug, Serialize, Deserialize)]
pub struct PermissionRecord;
impl XrpcResp for PermissionRecord {
    const NSID: &'static str = "place.stream.moderation.permission";
    const ENCODING: &'static str = "application/json";
    type Output<'de> = PermissionGetRecordOutput<'de>;
    type Err<'de> = RecordError<'de>;
}

impl From<PermissionGetRecordOutput<'_>> for Permission<'_> {
    fn from(output: PermissionGetRecordOutput<'_>) -> Self {
        use jacquard_common::IntoStatic;
        output.value.into_static()
    }
}

impl Collection for Permission<'_> {
    const NSID: &'static str = "place.stream.moderation.permission";
    type Record = PermissionRecord;
}

impl Collection for PermissionRecord {
    const NSID: &'static str = "place.stream.moderation.permission";
    type Record = PermissionRecord;
}

impl<'a> LexiconSchema for Permission<'a> {
    fn nsid() -> &'static str {
        "place.stream.moderation.permission"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_place_stream_moderation_permission()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

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

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

impl<'a> Permission<'a> {
    /// Create a new builder for this type
    pub fn new() -> PermissionBuilder<'a, permission_state::Empty> {
        PermissionBuilder::new()
    }
}

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

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

impl<'a, S: permission_state::State> PermissionBuilder<'a, S> {
    /// Set the `expirationTime` field (optional)
    pub fn expiration_time(mut self, value: impl Into<Option<Datetime>>) -> Self {
        self._fields.1 = value.into();
        self
    }
    /// Set the `expirationTime` field to an Option value (optional)
    pub fn maybe_expiration_time(mut self, value: Option<Datetime>) -> Self {
        self._fields.1 = value;
        self
    }
}

impl<'a, S> PermissionBuilder<'a, S>
where
    S: permission_state::State,
    S::Moderator: permission_state::IsUnset,
{
    /// Set the `moderator` field (required)
    pub fn moderator(
        mut self,
        value: impl Into<Did<'a>>,
    ) -> PermissionBuilder<'a, permission_state::SetModerator<S>> {
        self._fields.2 = Option::Some(value.into());
        PermissionBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> PermissionBuilder<'a, S>
where
    S: permission_state::State,
    S::Permissions: permission_state::IsUnset,
{
    /// Set the `permissions` field (required)
    pub fn permissions(
        mut self,
        value: impl Into<Vec<CowStr<'a>>>,
    ) -> PermissionBuilder<'a, permission_state::SetPermissions<S>> {
        self._fields.3 = Option::Some(value.into());
        PermissionBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> PermissionBuilder<'a, S>
where
    S: permission_state::State,
    S::Permissions: permission_state::IsSet,
    S::CreatedAt: permission_state::IsSet,
    S::Moderator: permission_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> Permission<'a> {
        Permission {
            created_at: self._fields.0.unwrap(),
            expiration_time: self._fields.1,
            moderator: self._fields.2.unwrap(),
            permissions: self._fields.3.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>,
        >,
    ) -> Permission<'a> {
        Permission {
            created_at: self._fields.0.unwrap(),
            expiration_time: self._fields.1,
            moderator: self._fields.2.unwrap(),
            permissions: self._fields.3.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_place_stream_moderation_permission() -> 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("place.stream.moderation.permission"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    description: Some(
                        CowStr::new_static(
                            "Record granting moderation permissions to a user for this streamer's content.",
                        ),
                    ),
                    key: Some(CowStr::new_static("tid")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(
                            vec![
                                SmolStr::new_static("moderator"),
                                SmolStr::new_static("permissions"),
                                SmolStr::new_static("createdAt")
                            ],
                        ),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("createdAt"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "Client-declared timestamp when this moderator was added.",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("expirationTime"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "Optional expiration time for this delegation. If set, the delegation is invalid after this time.",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("moderator"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "The DID of the user granted moderator permissions.",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::Did),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("permissions"),
                                LexObjectProperty::Array(LexArray {
                                    description: Some(
                                        CowStr::new_static(
                                            "Array of permissions granted to this moderator. 'ban' covers blocks/bans (with optional expiration), 'hide' covers message gates, 'livestream.manage' allows updating livestream metadata.",
                                        ),
                                    ),
                                    items: LexArrayItem::String(LexString {
                                        ..Default::default()
                                    }),
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}