jacquard-api 0.12.0-beta.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.

#[allow(unused_imports)]
use alloc::collections::BTreeMap;

#[allow(unused_imports)]
use core::marker::PhantomData;
use jacquard_common::{BosStr, CowStr, DefaultStr, FromStaticStr};

#[allow(unused_imports)]
use jacquard_common::deps::codegen::unicode_segmentation::UnicodeSegmentation;
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::collection::{Collection, RecordError};
use jacquard_common::types::string::{AtUri, Cid};
use jacquard_common::types::uri::{RecordUri, UriError};
use jacquard_common::types::value::Data;
use jacquard_common::xrpc::XrpcResp;
use jacquard_derive::{IntoStatic, lexicon};
use jacquard_lexicon::lexicon::LexiconDoc;
use jacquard_lexicon::schema::LexiconSchema;

use crate::place_wisp::settings;
#[allow(unused_imports)]
use jacquard_lexicon::validation::{ConstraintError, ValidationPath};
use serde::{Deserialize, Serialize};
/// Custom HTTP header configuration

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic, Default)]
#[serde(
    rename_all = "camelCase",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct CustomHeader<S: BosStr = DefaultStr> {
    ///HTTP header name (e.g., 'Cache-Control', 'X-Frame-Options')
    pub name: S,
    ///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 = "Option::is_none")]
    pub path: Option<S>,
    ///HTTP header value
    pub value: S,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/// Configuration settings for a static site hosted on wisp.place

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    rename = "place.wisp.settings",
    tag = "$type",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct Settings<S: BosStr = DefaultStr> {
    ///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 = "Option::is_none")]
    #[serde(default = "_default_settings_clean_urls")]
    pub clean_urls: Option<bool>,
    ///Custom 404 error page file path. Incompatible with directoryListing and spaMode.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub custom404: Option<S>,
    ///Enable directory listing mode for paths that resolve to directories without an index file. Incompatible with spaMode.  Defaults to `false`.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default = "_default_settings_directory_listing")]
    pub directory_listing: Option<bool>,
    ///Custom HTTP headers to set on responses
    #[serde(skip_serializing_if = "Option::is_none")]
    pub headers: Option<Vec<settings::CustomHeader<S>>>,
    ///Ordered list of files to try when serving a directory. Defaults to ['index.html'] if not specified.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub index_files: Option<Vec<S>>,
    ///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 = "Option::is_none")]
    pub spa_mode: Option<S>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/// 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 SettingsGetRecordOutput<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cid: Option<Cid<S>>,
    pub uri: AtUri<S>,
    pub value: Settings<S>,
}

impl<S: BosStr> Settings<S> {
    pub fn uri(uri: S) -> Result<RecordUri<S, SettingsRecord>, UriError> {
        RecordUri::try_from_uri(AtUri::new(uri)?)
    }
}

impl<S: BosStr> LexiconSchema for CustomHeader<S> {
    fn nsid() -> &'static str {
        "place.wisp.settings"
    }
    fn def_name() -> &'static str {
        "customHeader"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_place_wisp_settings()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        {
            let value = &self.name;
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 100usize {
                return Err(ConstraintError::MaxLength {
                    path: 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(ConstraintError::MaxLength {
                    path: 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(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("value"),
                    max: 1000usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        Ok(())
    }
}

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

#[derive(Debug, Serialize, Deserialize)]
pub struct SettingsRecord;
impl XrpcResp for SettingsRecord {
    const NSID: &'static str = "place.wisp.settings";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = SettingsGetRecordOutput<S>;
    type Err = RecordError;
}

impl<S: BosStr> From<SettingsGetRecordOutput<S>> for Settings<S> {
    fn from(output: SettingsGetRecordOutput<S>) -> Self {
        output.value
    }
}

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

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

impl<S: BosStr> LexiconSchema for Settings<S> {
    fn nsid() -> &'static str {
        "place.wisp.settings"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_place_wisp_settings()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        if let Some(ref value) = self.custom404 {
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 500usize {
                return Err(ConstraintError::MaxLength {
                    path: 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(ConstraintError::MaxLength {
                    path: 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(ConstraintError::MaxLength {
                    path: 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(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("spa_mode"),
                    max: 500usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        Ok(())
    }
}

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

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

fn _default_settings_directory_listing() -> 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::{IsSet, IsUnset, Set, Unset};
    #[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<S: BosStr, St: settings_state::State> {
    _state: PhantomData<fn() -> St>,
    _fields: (
        Option<bool>,
        Option<S>,
        Option<bool>,
        Option<Vec<settings::CustomHeader<S>>>,
        Option<Vec<S>>,
        Option<S>,
    ),
    _type: PhantomData<fn() -> S>,
}

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

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

impl<S: BosStr, St: settings_state::State> SettingsBuilder<S, St> {
    /// Set the `cleanUrls` field (optional)
    pub fn clean_urls(mut self, value: impl Into<Option<bool>>) -> Self {
        self._fields.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._fields.0 = value;
        self
    }
}

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

impl<S: BosStr, St: settings_state::State> SettingsBuilder<S, St> {
    /// Set the `directoryListing` field (optional)
    pub fn directory_listing(mut self, value: impl Into<Option<bool>>) -> Self {
        self._fields.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._fields.2 = value;
        self
    }
}

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

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

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

impl<S: BosStr, St> SettingsBuilder<S, St>
where
    St: settings_state::State,
{
    /// Build the final struct.
    pub fn build(self) -> Settings<S> {
        Settings {
            clean_urls: self._fields.0.or_else(|| Some(false)),
            custom404: self._fields.1,
            directory_listing: self._fields.2.or_else(|| Some(false)),
            headers: self._fields.3,
            index_files: self._fields.4,
            spa_mode: self._fields.5,
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data.
    pub fn build_with_data(self, extra_data: BTreeMap<SmolStr, Data<S>>) -> Settings<S> {
        Settings {
            clean_urls: self._fields.0.or_else(|| Some(false)),
            custom404: self._fields.1,
            directory_listing: self._fields.2.or_else(|| Some(false)),
            headers: self._fields.3,
            index_files: self._fields.4,
            spa_mode: self._fields.5,
            extra_data: Some(extra_data),
        }
    }
}