jacquard-api 0.12.0-beta.1

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: blue.rito.service.getSchema
//
// 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::string::UriValue;
use jacquard_common::types::value::Data;
use jacquard_derive::IntoStatic;
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::blue_rito::service::get_schema;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct Langs<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub comment: Option<S>,
    pub lang: S,
    pub moderation: Vec<S>,
    pub title: S,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic, Default)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetSchema<S: BosStr = DefaultStr> {
    pub nsid: S,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/// Returns the Bookmark data for the given NSID.

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetSchemaOutput<S: BosStr = DefaultStr> {
    ///Comments with titles, content, and moderation in multiple languages.
    pub comments: Vec<get_schema::Langs<S>>,
    ///Moderation result for OGP title and description
    pub moderations: Vec<S>,
    ///Namespace ID of the service or application (e.g., 'uk.skyblur.post').
    pub nsid: S,
    ///The Open Graph Protocol (OGP) description for the bookmark.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ogp_description: Option<S>,
    ///The Open Graph Protocol (OGP) image URL for the bookmark.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ogp_image: Option<UriValue<S>>,
    ///The Open Graph Protocol (OGP) title for the bookmark.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ogp_title: Option<S>,
    ///The schema URL pattern associated with this NSID (e.g., 'https://skyblur.uk/post/{did}/{rkey}').
    pub schema: S,
    ///This field contains tags. If registered by the owner, it may include 'Verified'.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tags: Option<Vec<S>>,
    ///If this comment registed by owner, this field should be true.
    pub verified: bool,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

impl<S: BosStr> LexiconSchema for Langs<S> {
    fn nsid() -> &'static str {
        "blue.rito.service.getSchema"
    }
    fn def_name() -> &'static str {
        "langs"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_blue_rito_service_getSchema()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

/// Response type for blue.rito.service.getSchema
pub struct GetSchemaResponse;
impl jacquard_common::xrpc::XrpcResp for GetSchemaResponse {
    const NSID: &'static str = "blue.rito.service.getSchema";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = GetSchemaOutput<S>;
    type Err = jacquard_common::xrpc::GenericError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for GetSchema<S> {
    const NSID: &'static str = "blue.rito.service.getSchema";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = GetSchemaResponse;
}

/// Endpoint type for blue.rito.service.getSchema
pub struct GetSchemaRequest;
impl jacquard_common::xrpc::XrpcEndpoint for GetSchemaRequest {
    const PATH: &'static str = "/xrpc/blue.rito.service.getSchema";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Request<S: BosStr> = GetSchema<S>;
    type Response = GetSchemaResponse;
}

pub mod langs_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 Lang;
        type Title;
        type Moderation;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Lang = Unset;
        type Title = Unset;
        type Moderation = Unset;
    }
    ///State transition - sets the `lang` field to Set
    pub struct SetLang<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetLang<St> {}
    impl<St: State> State for SetLang<St> {
        type Lang = Set<members::lang>;
        type Title = St::Title;
        type Moderation = St::Moderation;
    }
    ///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 Lang = St::Lang;
        type Title = Set<members::title>;
        type Moderation = St::Moderation;
    }
    ///State transition - sets the `moderation` field to Set
    pub struct SetModeration<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetModeration<St> {}
    impl<St: State> State for SetModeration<St> {
        type Lang = St::Lang;
        type Title = St::Title;
        type Moderation = Set<members::moderation>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `lang` field
        pub struct lang(());
        ///Marker type for the `title` field
        pub struct title(());
        ///Marker type for the `moderation` field
        pub struct moderation(());
    }
}

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

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

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

impl<S: BosStr, St: langs_state::State> LangsBuilder<S, St> {
    /// Set the `comment` field (optional)
    pub fn comment(mut self, value: impl Into<Option<S>>) -> Self {
        self._fields.0 = value.into();
        self
    }
    /// Set the `comment` field to an Option value (optional)
    pub fn maybe_comment(mut self, value: Option<S>) -> Self {
        self._fields.0 = value;
        self
    }
}

impl<S: BosStr, St> LangsBuilder<S, St>
where
    St: langs_state::State,
    St::Lang: langs_state::IsUnset,
{
    /// Set the `lang` field (required)
    pub fn lang(
        mut self,
        value: impl Into<S>,
    ) -> LangsBuilder<S, langs_state::SetLang<St>> {
        self._fields.1 = Option::Some(value.into());
        LangsBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> LangsBuilder<S, St>
where
    St: langs_state::State,
    St::Moderation: langs_state::IsUnset,
{
    /// Set the `moderation` field (required)
    pub fn moderation(
        mut self,
        value: impl Into<Vec<S>>,
    ) -> LangsBuilder<S, langs_state::SetModeration<St>> {
        self._fields.2 = Option::Some(value.into());
        LangsBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

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

impl<S: BosStr, St> LangsBuilder<S, St>
where
    St: langs_state::State,
    St::Lang: langs_state::IsSet,
    St::Title: langs_state::IsSet,
    St::Moderation: langs_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> Langs<S> {
        Langs {
            comment: self._fields.0,
            lang: self._fields.1.unwrap(),
            moderation: self._fields.2.unwrap(),
            title: 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<SmolStr, Data<S>>) -> Langs<S> {
        Langs {
            comment: self._fields.0,
            lang: self._fields.1.unwrap(),
            moderation: self._fields.2.unwrap(),
            title: self._fields.3.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_blue_rito_service_getSchema() -> 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.rito.service.getSchema"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("langs"),
                LexUserType::Object(LexObject {
                    required: Some(
                        vec![
                            SmolStr::new_static("lang"), SmolStr::new_static("title"),
                            SmolStr::new_static("moderation")
                        ],
                    ),
                    properties: {
                        #[allow(unused_mut)]
                        let mut map = BTreeMap::new();
                        map.insert(
                            SmolStr::new_static("comment"),
                            LexObjectProperty::String(LexString { ..Default::default() }),
                        );
                        map.insert(
                            SmolStr::new_static("lang"),
                            LexObjectProperty::String(LexString { ..Default::default() }),
                        );
                        map.insert(
                            SmolStr::new_static("moderation"),
                            LexObjectProperty::Array(LexArray {
                                items: LexArrayItem::String(LexString {
                                    ..Default::default()
                                }),
                                ..Default::default()
                            }),
                        );
                        map.insert(
                            SmolStr::new_static("title"),
                            LexObjectProperty::String(LexString { ..Default::default() }),
                        );
                        map
                    },
                    ..Default::default()
                }),
            );
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::XrpcProcedure(LexXrpcProcedure {
                    input: Some(LexXrpcBody {
                        encoding: CowStr::new_static("application/json"),
                        schema: Some(
                            LexXrpcBodySchema::Object(LexObject {
                                required: Some(vec![SmolStr::new_static("nsid")]),
                                properties: {
                                    #[allow(unused_mut)]
                                    let mut map = BTreeMap::new();
                                    map.insert(
                                        SmolStr::new_static("nsid"),
                                        LexObjectProperty::String(LexString {
                                            ..Default::default()
                                        }),
                                    );
                                    map
                                },
                                ..Default::default()
                            }),
                        ),
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}