jacquard-api 0.12.0-beta.1

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: com.atproto.repo.putRecord
//
// 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};
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::ident::AtIdentifier;
use jacquard_common::types::string::{AtUri, Nsid, Cid, RecordKey, Rkey};
use jacquard_common::types::value::Data;
use jacquard_derive::{IntoStatic, open_union};
use serde::{Serialize, Deserialize};
use crate::com_atproto::repo::CommitMeta;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct PutRecord<S: BosStr = DefaultStr> {
    ///The NSID of the record collection.
    pub collection: Nsid<S>,
    ///The record to write.
    pub record: Data<S>,
    ///The handle or DID of the repo (aka, current account).
    pub repo: AtIdentifier<S>,
    ///The Record Key.
    pub rkey: RecordKey<Rkey<S>>,
    ///Compare and swap with the previous commit by CID.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub swap_commit: Option<Cid<S>>,
    ///Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation
    #[serde(skip_serializing_if = "Option::is_none")]
    pub swap_record: Option<Cid<S>>,
    ///Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub validate: Option<bool>,
    #[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)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct PutRecordOutput<S: BosStr = DefaultStr> {
    pub cid: Cid<S>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub commit: Option<CommitMeta<S>>,
    pub uri: AtUri<S>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub validation_status: Option<PutRecordOutputValidationStatus<S>>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}


#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum PutRecordOutputValidationStatus<S: BosStr = DefaultStr> {
    Valid,
    Unknown,
    Other(S),
}

impl<S: BosStr> PutRecordOutputValidationStatus<S> {
    pub fn as_str(&self) -> &str {
        match self {
            Self::Valid => "valid",
            Self::Unknown => "unknown",
            Self::Other(s) => s.as_ref(),
        }
    }
    /// Construct from a string-like value, matching known values.
    pub fn from_value(s: S) -> Self {
        match s.as_ref() {
            "valid" => Self::Valid,
            "unknown" => Self::Unknown,
            _ => Self::Other(s),
        }
    }
}

impl<S: BosStr> core::fmt::Display for PutRecordOutputValidationStatus<S> {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "{}", self.as_str())
    }
}

impl<S: BosStr> AsRef<str> for PutRecordOutputValidationStatus<S> {
    fn as_ref(&self) -> &str {
        self.as_str()
    }
}

impl<S: BosStr> Serialize for PutRecordOutputValidationStatus<S> {
    fn serialize<Ser>(&self, serializer: Ser) -> Result<Ser::Ok, Ser::Error>
    where
        Ser: serde::Serializer,
    {
        serializer.serialize_str(self.as_str())
    }
}

impl<'de, S: Deserialize<'de> + BosStr> Deserialize<'de>
for PutRecordOutputValidationStatus<S> {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let s = S::deserialize(deserializer)?;
        Ok(Self::from_value(s))
    }
}

impl<S: BosStr + Default> Default for PutRecordOutputValidationStatus<S> {
    fn default() -> Self {
        Self::Other(Default::default())
    }
}

impl<S: BosStr> jacquard_common::IntoStatic for PutRecordOutputValidationStatus<S>
where
    S: BosStr + jacquard_common::IntoStatic,
    S::Output: BosStr,
{
    type Output = PutRecordOutputValidationStatus<S::Output>;
    fn into_static(self) -> Self::Output {
        match self {
            PutRecordOutputValidationStatus::Valid => {
                PutRecordOutputValidationStatus::Valid
            }
            PutRecordOutputValidationStatus::Unknown => {
                PutRecordOutputValidationStatus::Unknown
            }
            PutRecordOutputValidationStatus::Other(v) => {
                PutRecordOutputValidationStatus::Other(v.into_static())
            }
        }
    }
}


#[derive(
    Serialize,
    Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    thiserror::Error,
    miette::Diagnostic
)]

#[serde(tag = "error", content = "message")]
pub enum PutRecordError {
    #[serde(rename = "InvalidSwap")]
    InvalidSwap(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other { error: SmolStr, message: Option<SmolStr> },
}

impl core::fmt::Display for PutRecordError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::InvalidSwap(msg) => {
                write!(f, "InvalidSwap")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::Other { error, message } => {
                write!(f, "{}", error)?;
                if let Some(msg) = message {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
        }
    }
}

/// Response type for com.atproto.repo.putRecord
pub struct PutRecordResponse;
impl jacquard_common::xrpc::XrpcResp for PutRecordResponse {
    const NSID: &'static str = "com.atproto.repo.putRecord";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = PutRecordOutput<S>;
    type Err = PutRecordError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for PutRecord<S> {
    const NSID: &'static str = "com.atproto.repo.putRecord";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = PutRecordResponse;
}

/// Endpoint type for com.atproto.repo.putRecord
pub struct PutRecordRequest;
impl jacquard_common::xrpc::XrpcEndpoint for PutRecordRequest {
    const PATH: &'static str = "/xrpc/com.atproto.repo.putRecord";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Request<S: BosStr> = PutRecord<S>;
    type Response = PutRecordResponse;
}

pub mod put_record_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 Collection;
        type Record;
        type Repo;
        type Rkey;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Collection = Unset;
        type Record = Unset;
        type Repo = Unset;
        type Rkey = Unset;
    }
    ///State transition - sets the `collection` field to Set
    pub struct SetCollection<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetCollection<St> {}
    impl<St: State> State for SetCollection<St> {
        type Collection = Set<members::collection>;
        type Record = St::Record;
        type Repo = St::Repo;
        type Rkey = St::Rkey;
    }
    ///State transition - sets the `record` field to Set
    pub struct SetRecord<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetRecord<St> {}
    impl<St: State> State for SetRecord<St> {
        type Collection = St::Collection;
        type Record = Set<members::record>;
        type Repo = St::Repo;
        type Rkey = St::Rkey;
    }
    ///State transition - sets the `repo` field to Set
    pub struct SetRepo<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetRepo<St> {}
    impl<St: State> State for SetRepo<St> {
        type Collection = St::Collection;
        type Record = St::Record;
        type Repo = Set<members::repo>;
        type Rkey = St::Rkey;
    }
    ///State transition - sets the `rkey` field to Set
    pub struct SetRkey<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetRkey<St> {}
    impl<St: State> State for SetRkey<St> {
        type Collection = St::Collection;
        type Record = St::Record;
        type Repo = St::Repo;
        type Rkey = Set<members::rkey>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `collection` field
        pub struct collection(());
        ///Marker type for the `record` field
        pub struct record(());
        ///Marker type for the `repo` field
        pub struct repo(());
        ///Marker type for the `rkey` field
        pub struct rkey(());
    }
}

/// Builder for constructing an instance of this type.
pub struct PutRecordBuilder<S: BosStr, St: put_record_state::State> {
    _state: PhantomData<fn() -> St>,
    _fields: (
        Option<Nsid<S>>,
        Option<Data<S>>,
        Option<AtIdentifier<S>>,
        Option<RecordKey<Rkey<S>>>,
        Option<Cid<S>>,
        Option<Cid<S>>,
        Option<bool>,
    ),
    _type: PhantomData<fn() -> S>,
}

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

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

impl<S: BosStr, St> PutRecordBuilder<S, St>
where
    St: put_record_state::State,
    St::Collection: put_record_state::IsUnset,
{
    /// Set the `collection` field (required)
    pub fn collection(
        mut self,
        value: impl Into<Nsid<S>>,
    ) -> PutRecordBuilder<S, put_record_state::SetCollection<St>> {
        self._fields.0 = Option::Some(value.into());
        PutRecordBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> PutRecordBuilder<S, St>
where
    St: put_record_state::State,
    St::Record: put_record_state::IsUnset,
{
    /// Set the `record` field (required)
    pub fn record(
        mut self,
        value: impl Into<Data<S>>,
    ) -> PutRecordBuilder<S, put_record_state::SetRecord<St>> {
        self._fields.1 = Option::Some(value.into());
        PutRecordBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> PutRecordBuilder<S, St>
where
    St: put_record_state::State,
    St::Repo: put_record_state::IsUnset,
{
    /// Set the `repo` field (required)
    pub fn repo(
        mut self,
        value: impl Into<AtIdentifier<S>>,
    ) -> PutRecordBuilder<S, put_record_state::SetRepo<St>> {
        self._fields.2 = Option::Some(value.into());
        PutRecordBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> PutRecordBuilder<S, St>
where
    St: put_record_state::State,
    St::Rkey: put_record_state::IsUnset,
{
    /// Set the `rkey` field (required)
    pub fn rkey(
        mut self,
        value: impl Into<RecordKey<Rkey<S>>>,
    ) -> PutRecordBuilder<S, put_record_state::SetRkey<St>> {
        self._fields.3 = Option::Some(value.into());
        PutRecordBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St: put_record_state::State> PutRecordBuilder<S, St> {
    /// Set the `swapCommit` field (optional)
    pub fn swap_commit(mut self, value: impl Into<Option<Cid<S>>>) -> Self {
        self._fields.4 = value.into();
        self
    }
    /// Set the `swapCommit` field to an Option value (optional)
    pub fn maybe_swap_commit(mut self, value: Option<Cid<S>>) -> Self {
        self._fields.4 = value;
        self
    }
}

impl<S: BosStr, St: put_record_state::State> PutRecordBuilder<S, St> {
    /// Set the `swapRecord` field (optional)
    pub fn swap_record(mut self, value: impl Into<Option<Cid<S>>>) -> Self {
        self._fields.5 = value.into();
        self
    }
    /// Set the `swapRecord` field to an Option value (optional)
    pub fn maybe_swap_record(mut self, value: Option<Cid<S>>) -> Self {
        self._fields.5 = value;
        self
    }
}

impl<S: BosStr, St: put_record_state::State> PutRecordBuilder<S, St> {
    /// Set the `validate` field (optional)
    pub fn validate(mut self, value: impl Into<Option<bool>>) -> Self {
        self._fields.6 = value.into();
        self
    }
    /// Set the `validate` field to an Option value (optional)
    pub fn maybe_validate(mut self, value: Option<bool>) -> Self {
        self._fields.6 = value;
        self
    }
}

impl<S: BosStr, St> PutRecordBuilder<S, St>
where
    St: put_record_state::State,
    St::Collection: put_record_state::IsSet,
    St::Record: put_record_state::IsSet,
    St::Repo: put_record_state::IsSet,
    St::Rkey: put_record_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> PutRecord<S> {
        PutRecord {
            collection: self._fields.0.unwrap(),
            record: self._fields.1.unwrap(),
            repo: self._fields.2.unwrap(),
            rkey: self._fields.3.unwrap(),
            swap_commit: self._fields.4,
            swap_record: self._fields.5,
            validate: self._fields.6,
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data.
    pub fn build_with_data(
        self,
        extra_data: BTreeMap<SmolStr, Data<S>>,
    ) -> PutRecord<S> {
        PutRecord {
            collection: self._fields.0.unwrap(),
            record: self._fields.1.unwrap(),
            repo: self._fields.2.unwrap(),
            rkey: self._fields.3.unwrap(),
            swap_commit: self._fields.4,
            swap_record: self._fields.5,
            validate: self._fields.6,
            extra_data: Some(extra_data),
        }
    }
}