jacquard-api 0.11.0

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: app.gainforest.evaluator.subscription
//
// 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};
/// User subscription to an evaluator service. Published by the user (not the evaluator) to declare they want evaluations.

#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct Subscription<'a> {
    ///Which of the user's record collections should be evaluated (NSIDs). Must be a subset of the evaluator's subjectCollections. If omitted, all supported collections are evaluated.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub collections: Option<Vec<CowStr<'a>>>,
    ///Timestamp of when this subscription was created.
    pub created_at: Datetime,
    ///Which evaluation types the user wants. If omitted, all types the evaluator supports are applied.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub evaluation_types: Option<Vec<CowStr<'a>>>,
    ///DID of the evaluator service to subscribe to.
    #[serde(borrow)]
    pub evaluator: Did<'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 SubscriptionGetRecordOutput<'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: Subscription<'a>,
}

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

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

#[derive(Debug, Serialize, Deserialize)]
pub struct SubscriptionRecord;
impl XrpcResp for SubscriptionRecord {
    const NSID: &'static str = "app.gainforest.evaluator.subscription";
    const ENCODING: &'static str = "application/json";
    type Output<'de> = SubscriptionGetRecordOutput<'de>;
    type Err<'de> = RecordError<'de>;
}

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

impl Collection for Subscription<'_> {
    const NSID: &'static str = "app.gainforest.evaluator.subscription";
    type Record = SubscriptionRecord;
}

impl Collection for SubscriptionRecord {
    const NSID: &'static str = "app.gainforest.evaluator.subscription";
    type Record = SubscriptionRecord;
}

impl<'a> LexiconSchema for Subscription<'a> {
    fn nsid() -> &'static str {
        "app.gainforest.evaluator.subscription"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_app_gainforest_evaluator_subscription()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        if let Some(ref value) = self.collections {
            #[allow(unused_comparisons)]
            if value.len() > 20usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("collections"),
                    max: 20usize,
                    actual: value.len(),
                });
            }
        }
        if let Some(ref value) = self.evaluation_types {
            #[allow(unused_comparisons)]
            if value.len() > 20usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("evaluation_types"),
                    max: 20usize,
                    actual: value.len(),
                });
            }
        }
        Ok(())
    }
}

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

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

impl<'a> Subscription<'a> {
    /// Create a new builder for this type
    pub fn new() -> SubscriptionBuilder<'a, subscription_state::Empty> {
        SubscriptionBuilder::new()
    }
}

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

impl<'a, S: subscription_state::State> SubscriptionBuilder<'a, S> {
    /// Set the `collections` field (optional)
    pub fn collections(mut self, value: impl Into<Option<Vec<CowStr<'a>>>>) -> Self {
        self._fields.0 = value.into();
        self
    }
    /// Set the `collections` field to an Option value (optional)
    pub fn maybe_collections(mut self, value: Option<Vec<CowStr<'a>>>) -> Self {
        self._fields.0 = value;
        self
    }
}

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

impl<'a, S: subscription_state::State> SubscriptionBuilder<'a, S> {
    /// Set the `evaluationTypes` field (optional)
    pub fn evaluation_types(
        mut self,
        value: impl Into<Option<Vec<CowStr<'a>>>>,
    ) -> Self {
        self._fields.2 = value.into();
        self
    }
    /// Set the `evaluationTypes` field to an Option value (optional)
    pub fn maybe_evaluation_types(mut self, value: Option<Vec<CowStr<'a>>>) -> Self {
        self._fields.2 = value;
        self
    }
}

impl<'a, S> SubscriptionBuilder<'a, S>
where
    S: subscription_state::State,
    S::Evaluator: subscription_state::IsUnset,
{
    /// Set the `evaluator` field (required)
    pub fn evaluator(
        mut self,
        value: impl Into<Did<'a>>,
    ) -> SubscriptionBuilder<'a, subscription_state::SetEvaluator<S>> {
        self._fields.3 = Option::Some(value.into());
        SubscriptionBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> SubscriptionBuilder<'a, S>
where
    S: subscription_state::State,
    S::Evaluator: subscription_state::IsSet,
    S::CreatedAt: subscription_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> Subscription<'a> {
        Subscription {
            collections: self._fields.0,
            created_at: self._fields.1.unwrap(),
            evaluation_types: self._fields.2,
            evaluator: 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>,
        >,
    ) -> Subscription<'a> {
        Subscription {
            collections: self._fields.0,
            created_at: self._fields.1.unwrap(),
            evaluation_types: self._fields.2,
            evaluator: self._fields.3.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_app_gainforest_evaluator_subscription() -> 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("app.gainforest.evaluator.subscription"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    description: Some(
                        CowStr::new_static(
                            "User subscription to an evaluator service. Published by the user (not the evaluator) to declare they want evaluations.",
                        ),
                    ),
                    key: Some(CowStr::new_static("tid")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(
                            vec![
                                SmolStr::new_static("evaluator"),
                                SmolStr::new_static("createdAt")
                            ],
                        ),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("collections"),
                                LexObjectProperty::Array(LexArray {
                                    description: Some(
                                        CowStr::new_static(
                                            "Which of the user's record collections should be evaluated (NSIDs). Must be a subset of the evaluator's subjectCollections. If omitted, all supported collections are evaluated.",
                                        ),
                                    ),
                                    items: LexArrayItem::String(LexString {
                                        max_graphemes: Some(128usize),
                                        ..Default::default()
                                    }),
                                    max_length: Some(20usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("createdAt"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "Timestamp of when this subscription was created.",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("evaluationTypes"),
                                LexObjectProperty::Array(LexArray {
                                    description: Some(
                                        CowStr::new_static(
                                            "Which evaluation types the user wants. If omitted, all types the evaluator supports are applied.",
                                        ),
                                    ),
                                    items: LexArrayItem::String(LexString {
                                        max_graphemes: Some(64usize),
                                        ..Default::default()
                                    }),
                                    max_length: Some(20usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("evaluator"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "DID of the evaluator service to subscribe to.",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::Did),
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}