jacquard-api 0.10.2

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: place.wisp.settings
//
// This file was automatically generated from Lexicon schemas.
// Any manual changes will be overwritten on the next regeneration.

/// Custom HTTP header configuration
#[jacquard_derive::lexicon]
#[derive(
    serde::Serialize,
    serde::Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    jacquard_derive::IntoStatic,
    Default
)]
#[serde(rename_all = "camelCase")]
pub struct CustomHeader<'a> {
    ///HTTP header name (e.g., 'Cache-Control', 'X-Frame-Options')
    #[serde(borrow)]
    pub name: jacquard_common::CowStr<'a>,
    ///Optional glob pattern to apply this header to specific paths (e.g., '*.html', '/assets/*'). If not specified, applies to all paths.
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub path: std::option::Option<jacquard_common::CowStr<'a>>,
    ///HTTP header value
    #[serde(borrow)]
    pub value: jacquard_common::CowStr<'a>,
}

fn lexicon_doc_place_wisp_settings() -> ::jacquard_lexicon::lexicon::LexiconDoc<
    'static,
> {
    ::jacquard_lexicon::lexicon::LexiconDoc {
        lexicon: ::jacquard_lexicon::lexicon::Lexicon::Lexicon1,
        id: ::jacquard_common::CowStr::new_static("place.wisp.settings"),
        revision: None,
        description: None,
        defs: {
            let mut map = ::alloc::collections::BTreeMap::new();
            map.insert(
                ::jacquard_common::deps::smol_str::SmolStr::new_static("customHeader"),
                ::jacquard_lexicon::lexicon::LexUserType::Object(::jacquard_lexicon::lexicon::LexObject {
                    description: Some(
                        ::jacquard_common::CowStr::new_static(
                            "Custom HTTP header configuration",
                        ),
                    ),
                    required: Some(
                        vec![
                            ::jacquard_common::deps::smol_str::SmolStr::new_static("name"),
                            ::jacquard_common::deps::smol_str::SmolStr::new_static("value")
                        ],
                    ),
                    nullable: None,
                    properties: {
                        #[allow(unused_mut)]
                        let mut map = ::alloc::collections::BTreeMap::new();
                        map.insert(
                            ::jacquard_common::deps::smol_str::SmolStr::new_static(
                                "name",
                            ),
                            ::jacquard_lexicon::lexicon::LexObjectProperty::String(::jacquard_lexicon::lexicon::LexString {
                                description: Some(
                                    ::jacquard_common::CowStr::new_static(
                                        "HTTP header name (e.g., 'Cache-Control', 'X-Frame-Options')",
                                    ),
                                ),
                                format: None,
                                default: None,
                                min_length: None,
                                max_length: Some(100usize),
                                min_graphemes: None,
                                max_graphemes: None,
                                r#enum: None,
                                r#const: None,
                                known_values: None,
                            }),
                        );
                        map.insert(
                            ::jacquard_common::deps::smol_str::SmolStr::new_static(
                                "path",
                            ),
                            ::jacquard_lexicon::lexicon::LexObjectProperty::String(::jacquard_lexicon::lexicon::LexString {
                                description: Some(
                                    ::jacquard_common::CowStr::new_static(
                                        "Optional glob pattern to apply this header to specific paths (e.g., '*.html', '/assets/*'). If not specified, applies to all paths.",
                                    ),
                                ),
                                format: None,
                                default: None,
                                min_length: None,
                                max_length: Some(500usize),
                                min_graphemes: None,
                                max_graphemes: None,
                                r#enum: None,
                                r#const: None,
                                known_values: None,
                            }),
                        );
                        map.insert(
                            ::jacquard_common::deps::smol_str::SmolStr::new_static(
                                "value",
                            ),
                            ::jacquard_lexicon::lexicon::LexObjectProperty::String(::jacquard_lexicon::lexicon::LexString {
                                description: Some(
                                    ::jacquard_common::CowStr::new_static("HTTP header value"),
                                ),
                                format: None,
                                default: None,
                                min_length: None,
                                max_length: Some(1000usize),
                                min_graphemes: None,
                                max_graphemes: None,
                                r#enum: None,
                                r#const: None,
                                known_values: None,
                            }),
                        );
                        map
                    },
                }),
            );
            map.insert(
                ::jacquard_common::deps::smol_str::SmolStr::new_static("main"),
                ::jacquard_lexicon::lexicon::LexUserType::Record(::jacquard_lexicon::lexicon::LexRecord {
                    description: Some(
                        ::jacquard_common::CowStr::new_static(
                            "Configuration settings for a static site hosted on wisp.place",
                        ),
                    ),
                    key: Some(::jacquard_common::CowStr::new_static("any")),
                    record: ::jacquard_lexicon::lexicon::LexRecordRecord::Object(::jacquard_lexicon::lexicon::LexObject {
                        description: None,
                        required: None,
                        nullable: None,
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = ::alloc::collections::BTreeMap::new();
                            map.insert(
                                ::jacquard_common::deps::smol_str::SmolStr::new_static(
                                    "cleanUrls",
                                ),
                                ::jacquard_lexicon::lexicon::LexObjectProperty::Boolean(::jacquard_lexicon::lexicon::LexBoolean {
                                    description: None,
                                    default: None,
                                    r#const: None,
                                }),
                            );
                            map.insert(
                                ::jacquard_common::deps::smol_str::SmolStr::new_static(
                                    "custom404",
                                ),
                                ::jacquard_lexicon::lexicon::LexObjectProperty::String(::jacquard_lexicon::lexicon::LexString {
                                    description: Some(
                                        ::jacquard_common::CowStr::new_static(
                                            "Custom 404 error page file path. Incompatible with directoryListing and spaMode.",
                                        ),
                                    ),
                                    format: None,
                                    default: None,
                                    min_length: None,
                                    max_length: Some(500usize),
                                    min_graphemes: None,
                                    max_graphemes: None,
                                    r#enum: None,
                                    r#const: None,
                                    known_values: None,
                                }),
                            );
                            map.insert(
                                ::jacquard_common::deps::smol_str::SmolStr::new_static(
                                    "directoryListing",
                                ),
                                ::jacquard_lexicon::lexicon::LexObjectProperty::Boolean(::jacquard_lexicon::lexicon::LexBoolean {
                                    description: None,
                                    default: None,
                                    r#const: None,
                                }),
                            );
                            map.insert(
                                ::jacquard_common::deps::smol_str::SmolStr::new_static(
                                    "headers",
                                ),
                                ::jacquard_lexicon::lexicon::LexObjectProperty::Array(::jacquard_lexicon::lexicon::LexArray {
                                    description: Some(
                                        ::jacquard_common::CowStr::new_static(
                                            "Custom HTTP headers to set on responses",
                                        ),
                                    ),
                                    items: ::jacquard_lexicon::lexicon::LexArrayItem::Ref(::jacquard_lexicon::lexicon::LexRef {
                                        description: None,
                                        r#ref: ::jacquard_common::CowStr::new_static(
                                            "#customHeader",
                                        ),
                                    }),
                                    min_length: None,
                                    max_length: Some(50usize),
                                }),
                            );
                            map.insert(
                                ::jacquard_common::deps::smol_str::SmolStr::new_static(
                                    "indexFiles",
                                ),
                                ::jacquard_lexicon::lexicon::LexObjectProperty::Array(::jacquard_lexicon::lexicon::LexArray {
                                    description: Some(
                                        ::jacquard_common::CowStr::new_static(
                                            "Ordered list of files to try when serving a directory. Defaults to ['index.html'] if not specified.",
                                        ),
                                    ),
                                    items: ::jacquard_lexicon::lexicon::LexArrayItem::String(::jacquard_lexicon::lexicon::LexString {
                                        description: None,
                                        format: None,
                                        default: None,
                                        min_length: None,
                                        max_length: Some(255usize),
                                        min_graphemes: None,
                                        max_graphemes: None,
                                        r#enum: None,
                                        r#const: None,
                                        known_values: None,
                                    }),
                                    min_length: None,
                                    max_length: Some(10usize),
                                }),
                            );
                            map.insert(
                                ::jacquard_common::deps::smol_str::SmolStr::new_static(
                                    "spaMode",
                                ),
                                ::jacquard_lexicon::lexicon::LexObjectProperty::String(::jacquard_lexicon::lexicon::LexString {
                                    description: Some(
                                        ::jacquard_common::CowStr::new_static(
                                            "File to serve for all routes (e.g., 'index.html'). When set, enables SPA mode where all non-file requests are routed to this file. Incompatible with directoryListing and custom404.",
                                        ),
                                    ),
                                    format: None,
                                    default: None,
                                    min_length: None,
                                    max_length: Some(500usize),
                                    min_graphemes: None,
                                    max_graphemes: None,
                                    r#enum: None,
                                    r#const: None,
                                    known_values: None,
                                }),
                            );
                            map
                        },
                    }),
                }),
            );
            map
        },
    }
}

impl<'a> ::jacquard_lexicon::schema::LexiconSchema for CustomHeader<'a> {
    fn nsid() -> &'static str {
        "place.wisp.settings"
    }
    fn def_name() -> &'static str {
        "customHeader"
    }
    fn lexicon_doc() -> ::jacquard_lexicon::lexicon::LexiconDoc<'static> {
        lexicon_doc_place_wisp_settings()
    }
    fn validate(
        &self,
    ) -> ::core::result::Result<(), ::jacquard_lexicon::validation::ConstraintError> {
        {
            let value = &self.name;
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 100usize {
                return Err(::jacquard_lexicon::validation::ConstraintError::MaxLength {
                    path: ::jacquard_lexicon::validation::ValidationPath::from_field(
                        "name",
                    ),
                    max: 100usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        if let Some(ref value) = self.path {
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 500usize {
                return Err(::jacquard_lexicon::validation::ConstraintError::MaxLength {
                    path: ::jacquard_lexicon::validation::ValidationPath::from_field(
                        "path",
                    ),
                    max: 500usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        {
            let value = &self.value;
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 1000usize {
                return Err(::jacquard_lexicon::validation::ConstraintError::MaxLength {
                    path: ::jacquard_lexicon::validation::ValidationPath::from_field(
                        "value",
                    ),
                    max: 1000usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        Ok(())
    }
}

/// Configuration settings for a static site hosted on wisp.place
#[jacquard_derive::lexicon]
#[derive(
    serde::Serialize,
    serde::Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    jacquard_derive::IntoStatic
)]
#[serde(rename_all = "camelCase")]
pub struct Settings<'a> {
    ///Enable clean URL routing. When enabled, '/about' will attempt to serve '/about.html' or '/about/index.html' automatically. Defaults to `false`.
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(default = "_default_settings_clean_urls")]
    pub clean_urls: std::option::Option<bool>,
    ///Custom 404 error page file path. Incompatible with directoryListing and spaMode.
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub custom404: std::option::Option<jacquard_common::CowStr<'a>>,
    ///Enable directory listing mode for paths that resolve to directories without an index file. Incompatible with spaMode. Defaults to `false`.
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(default = "_default_settings_directory_listing")]
    pub directory_listing: std::option::Option<bool>,
    ///Custom HTTP headers to set on responses
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub headers: std::option::Option<Vec<crate::place_wisp::settings::CustomHeader<'a>>>,
    ///Ordered list of files to try when serving a directory. Defaults to ['index.html'] if not specified.
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub index_files: std::option::Option<Vec<jacquard_common::CowStr<'a>>>,
    ///File to serve for all routes (e.g., 'index.html'). When set, enables SPA mode where all non-file requests are routed to this file. Incompatible with directoryListing and custom404.
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub spa_mode: std::option::Option<jacquard_common::CowStr<'a>>,
}

fn _default_settings_clean_urls() -> std::option::Option<bool> {
    Some(false)
}

fn _default_settings_directory_listing() -> std::option::Option<bool> {
    Some(false)
}

impl Default for Settings<'_> {
    fn default() -> Self {
        Self {
            clean_urls: Some(false),
            custom404: None,
            directory_listing: Some(false),
            headers: None,
            index_files: None,
            spa_mode: None,
            extra_data: Default::default(),
        }
    }
}

pub mod settings_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 {}
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {}
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {}
}

/// Builder for constructing an instance of this type
pub struct SettingsBuilder<'a, S: settings_state::State> {
    _phantom_state: ::core::marker::PhantomData<fn() -> S>,
    __unsafe_private_named: (
        ::core::option::Option<bool>,
        ::core::option::Option<jacquard_common::CowStr<'a>>,
        ::core::option::Option<bool>,
        ::core::option::Option<Vec<crate::place_wisp::settings::CustomHeader<'a>>>,
        ::core::option::Option<Vec<jacquard_common::CowStr<'a>>>,
        ::core::option::Option<jacquard_common::CowStr<'a>>,
    ),
    _phantom: ::core::marker::PhantomData<&'a ()>,
}

impl<'a> Settings<'a> {
    /// Create a new builder for this type
    pub fn new() -> SettingsBuilder<'a, settings_state::Empty> {
        SettingsBuilder::new()
    }
}

impl<'a> SettingsBuilder<'a, settings_state::Empty> {
    /// Create a new builder with all fields unset
    pub fn new() -> Self {
        SettingsBuilder {
            _phantom_state: ::core::marker::PhantomData,
            __unsafe_private_named: (None, None, None, None, None, None),
            _phantom: ::core::marker::PhantomData,
        }
    }
}

impl<'a, S: settings_state::State> SettingsBuilder<'a, S> {
    /// Set the `cleanUrls` field (optional)
    pub fn clean_urls(mut self, value: impl Into<Option<bool>>) -> Self {
        self.__unsafe_private_named.0 = value.into();
        self
    }
    /// Set the `cleanUrls` field to an Option value (optional)
    pub fn maybe_clean_urls(mut self, value: Option<bool>) -> Self {
        self.__unsafe_private_named.0 = value;
        self
    }
}

impl<'a, S: settings_state::State> SettingsBuilder<'a, S> {
    /// Set the `custom404` field (optional)
    pub fn custom404(
        mut self,
        value: impl Into<Option<jacquard_common::CowStr<'a>>>,
    ) -> Self {
        self.__unsafe_private_named.1 = value.into();
        self
    }
    /// Set the `custom404` field to an Option value (optional)
    pub fn maybe_custom404(
        mut self,
        value: Option<jacquard_common::CowStr<'a>>,
    ) -> Self {
        self.__unsafe_private_named.1 = value;
        self
    }
}

impl<'a, S: settings_state::State> SettingsBuilder<'a, S> {
    /// Set the `directoryListing` field (optional)
    pub fn directory_listing(mut self, value: impl Into<Option<bool>>) -> Self {
        self.__unsafe_private_named.2 = value.into();
        self
    }
    /// Set the `directoryListing` field to an Option value (optional)
    pub fn maybe_directory_listing(mut self, value: Option<bool>) -> Self {
        self.__unsafe_private_named.2 = value;
        self
    }
}

impl<'a, S: settings_state::State> SettingsBuilder<'a, S> {
    /// Set the `headers` field (optional)
    pub fn headers(
        mut self,
        value: impl Into<Option<Vec<crate::place_wisp::settings::CustomHeader<'a>>>>,
    ) -> Self {
        self.__unsafe_private_named.3 = value.into();
        self
    }
    /// Set the `headers` field to an Option value (optional)
    pub fn maybe_headers(
        mut self,
        value: Option<Vec<crate::place_wisp::settings::CustomHeader<'a>>>,
    ) -> Self {
        self.__unsafe_private_named.3 = value;
        self
    }
}

impl<'a, S: settings_state::State> SettingsBuilder<'a, S> {
    /// Set the `indexFiles` field (optional)
    pub fn index_files(
        mut self,
        value: impl Into<Option<Vec<jacquard_common::CowStr<'a>>>>,
    ) -> Self {
        self.__unsafe_private_named.4 = value.into();
        self
    }
    /// Set the `indexFiles` field to an Option value (optional)
    pub fn maybe_index_files(
        mut self,
        value: Option<Vec<jacquard_common::CowStr<'a>>>,
    ) -> Self {
        self.__unsafe_private_named.4 = value;
        self
    }
}

impl<'a, S: settings_state::State> SettingsBuilder<'a, S> {
    /// Set the `spaMode` field (optional)
    pub fn spa_mode(
        mut self,
        value: impl Into<Option<jacquard_common::CowStr<'a>>>,
    ) -> Self {
        self.__unsafe_private_named.5 = value.into();
        self
    }
    /// Set the `spaMode` field to an Option value (optional)
    pub fn maybe_spa_mode(mut self, value: Option<jacquard_common::CowStr<'a>>) -> Self {
        self.__unsafe_private_named.5 = value;
        self
    }
}

impl<'a, S> SettingsBuilder<'a, S>
where
    S: settings_state::State,
{
    /// Build the final struct
    pub fn build(self) -> Settings<'a> {
        Settings {
            clean_urls: self.__unsafe_private_named.0.or_else(|| Some(false)),
            custom404: self.__unsafe_private_named.1,
            directory_listing: self.__unsafe_private_named.2.or_else(|| Some(false)),
            headers: self.__unsafe_private_named.3,
            index_files: self.__unsafe_private_named.4,
            spa_mode: self.__unsafe_private_named.5,
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data
    pub fn build_with_data(
        self,
        extra_data: std::collections::BTreeMap<
            jacquard_common::deps::smol_str::SmolStr,
            jacquard_common::types::value::Data<'a>,
        >,
    ) -> Settings<'a> {
        Settings {
            clean_urls: self.__unsafe_private_named.0.or_else(|| Some(false)),
            custom404: self.__unsafe_private_named.1,
            directory_listing: self.__unsafe_private_named.2.or_else(|| Some(false)),
            headers: self.__unsafe_private_named.3,
            index_files: self.__unsafe_private_named.4,
            spa_mode: self.__unsafe_private_named.5,
            extra_data: Some(extra_data),
        }
    }
}

impl<'a> Settings<'a> {
    pub fn uri(
        uri: impl Into<jacquard_common::CowStr<'a>>,
    ) -> Result<
        jacquard_common::types::uri::RecordUri<'a, SettingsRecord>,
        jacquard_common::types::uri::UriError,
    > {
        jacquard_common::types::uri::RecordUri::try_from_uri(
            jacquard_common::types::string::AtUri::new_cow(uri.into())?,
        )
    }
}

/// Typed wrapper for GetRecord response with this collection's record type.
#[derive(
    serde::Serialize,
    serde::Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    jacquard_derive::IntoStatic
)]
#[serde(rename_all = "camelCase")]
pub struct SettingsGetRecordOutput<'a> {
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub cid: std::option::Option<jacquard_common::types::string::Cid<'a>>,
    #[serde(borrow)]
    pub uri: jacquard_common::types::string::AtUri<'a>,
    #[serde(borrow)]
    pub value: Settings<'a>,
}

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

impl jacquard_common::types::collection::Collection for Settings<'_> {
    const NSID: &'static str = "place.wisp.settings";
    type Record = SettingsRecord;
}

/// Marker type for deserializing records from this collection.
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct SettingsRecord;
impl jacquard_common::xrpc::XrpcResp for SettingsRecord {
    const NSID: &'static str = "place.wisp.settings";
    const ENCODING: &'static str = "application/json";
    type Output<'de> = SettingsGetRecordOutput<'de>;
    type Err<'de> = jacquard_common::types::collection::RecordError<'de>;
}

impl jacquard_common::types::collection::Collection for SettingsRecord {
    const NSID: &'static str = "place.wisp.settings";
    type Record = SettingsRecord;
}

impl<'a> ::jacquard_lexicon::schema::LexiconSchema for Settings<'a> {
    fn nsid() -> &'static str {
        "place.wisp.settings"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> ::jacquard_lexicon::lexicon::LexiconDoc<'static> {
        lexicon_doc_place_wisp_settings()
    }
    fn validate(
        &self,
    ) -> ::core::result::Result<(), ::jacquard_lexicon::validation::ConstraintError> {
        if let Some(ref value) = self.custom404 {
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 500usize {
                return Err(::jacquard_lexicon::validation::ConstraintError::MaxLength {
                    path: ::jacquard_lexicon::validation::ValidationPath::from_field(
                        "custom404",
                    ),
                    max: 500usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        if let Some(ref value) = self.headers {
            #[allow(unused_comparisons)]
            if value.len() > 50usize {
                return Err(::jacquard_lexicon::validation::ConstraintError::MaxLength {
                    path: ::jacquard_lexicon::validation::ValidationPath::from_field(
                        "headers",
                    ),
                    max: 50usize,
                    actual: value.len(),
                });
            }
        }
        if let Some(ref value) = self.index_files {
            #[allow(unused_comparisons)]
            if value.len() > 10usize {
                return Err(::jacquard_lexicon::validation::ConstraintError::MaxLength {
                    path: ::jacquard_lexicon::validation::ValidationPath::from_field(
                        "index_files",
                    ),
                    max: 10usize,
                    actual: value.len(),
                });
            }
        }
        if let Some(ref value) = self.spa_mode {
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 500usize {
                return Err(::jacquard_lexicon::validation::ConstraintError::MaxLength {
                    path: ::jacquard_lexicon::validation::ValidationPath::from_field(
                        "spa_mode",
                    ),
                    max: 500usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        Ok(())
    }
}