mdmodels_core/json/

schema.rs

/*
 * Copyright (c) 2025 Jan Range
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */

use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::{
    collections::{BTreeMap, HashMap},
    fmt::{self, Display},
    str::FromStr,
};
use variantly::Variantly;

use crate::attribute;

// Atomic counter to ensure thread-safe uniqueness
static TITLE_COUNTER: AtomicUsize = AtomicUsize::new(1);

fn generate_unique_title() -> String {
    let unique_id = TITLE_COUNTER.fetch_add(1, Ordering::SeqCst); // Increment the counter atomically
    format!("untitled_{unique_id}")
}

#[derive(Debug, Deserialize, Serialize, Clone)]
#[serde(untagged)]
pub enum SchemaType {
    Object(SchemaObject),
    Enum(EnumObject),
}

#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct SchemaObject {
    #[serde(rename = "$schema", skip_serializing_if = "Option::is_none")]
    pub schema: Option<String>,
    #[serde(rename = "$id", skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(
        default = "generate_unique_title",
        deserialize_with = "deserialize_title_with_whitespace_removal"
    )]
    pub title: String,
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub dtype: Option<DataType>,
    #[serde(skip_serializing_if = "skip_empty_string")]
    pub description: Option<String>,
    pub properties: BTreeMap<String, Property>,
    #[serde(
        rename = "$defs",
        skip_serializing_if = "BTreeMap::is_empty",
        alias = "definitions"
    )]
    #[serde(default)]
    pub definitions: BTreeMap<String, SchemaType>,
    #[serde(default)]
    pub required: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub optional: Vec<String>,
    #[serde(
        rename = "additionalProperties",
        default = "default_false",
        deserialize_with = "deserialize_additional_properties"
    )]
    pub additional_properties: bool,
}

impl SchemaObject {
    pub fn to_value(&self) -> Result<Value, serde_json::Error> {
        serde_json::to_value(self)
    }
}

#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct EnumObject {
    #[serde(default = "generate_unique_title")]
    pub title: String,
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub dtype: Option<DataType>,
    #[serde(skip_serializing_if = "skip_empty_string")]
    pub description: Option<String>,
    #[serde(rename = "enum")]
    pub enum_values: Vec<String>,
}

#[derive(Debug, Deserialize, Serialize, Clone, Default)]
pub struct Property {
    #[serde(alias = "name", skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub dtype: Option<DataType>,
    #[serde(rename = "default", skip_serializing_if = "Option::is_none")]
    pub default: Option<PrimitiveType>,
    #[serde(skip_serializing_if = "skip_empty_string")]
    pub description: Option<String>,
    #[serde(rename = "$term", skip_serializing_if = "skip_empty_string")]
    pub term: Option<String>,
    #[serde(rename = "$ref", skip_serializing_if = "Option::is_none")]
    pub reference: Option<String>,
    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
    pub properties: BTreeMap<String, Property>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub required: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub optional: Vec<String>,
    #[serde(
        rename = "additionalProperties",
        default,
        skip_serializing_if = "Option::is_none",
        deserialize_with = "deserialize_optional_additional_properties"
    )]
    pub additional_properties: Option<bool>,
    #[serde(flatten)]
    pub options: HashMap<String, PrimitiveType>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub items: Option<Item>,
    #[serde(rename = "oneOf", skip_serializing_if = "skip_empty")]
    pub one_of: Option<Vec<Item>>,
    #[serde(rename = "anyOf", skip_serializing_if = "skip_empty")]
    pub any_of: Option<Vec<Item>>,
    #[serde(rename = "allOf", skip_serializing_if = "skip_empty")]
    pub all_of: Option<Vec<Item>>,
    #[serde(skip_serializing_if = "skip_empty", rename = "enum")]
    pub enum_values: Option<Vec<String>>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub examples: Vec<Value>,
}

#[derive(Debug, Deserialize, Variantly, Clone)]
#[serde(untagged)]
pub enum Item {
    ReferenceItem(ReferenceItemType),
    OneOfItem(OneOfItemType),
    AnyOfItem(AnyOfItemType),
    PropertyItem(Box<Property>),
}

impl Item {
    /// Returns a vector of all the types that can be found in the item.
    /// This is useful for getting all the types that can be found in a property.
    pub(crate) fn get_types(&self) -> Vec<String> {
        match self {
            Item::ReferenceItem(ref_item) => vec![ref_item.reference.clone()],
            Item::OneOfItem(one_of_item) => one_of_item
                .one_of
                .iter()
                .flat_map(|item| item.get_types())
                .collect(),
            Item::AnyOfItem(any_of_item) => any_of_item
                .any_of
                .iter()
                .flat_map(|item| item.get_types())
                .collect(),
            Item::PropertyItem(property) => property.get_types(),
        }
    }

    pub(crate) fn as_property(&self) -> Option<&Property> {
        match self {
            Item::PropertyItem(property) => Some(property),
            _ => None,
        }
    }
}

impl Property {
    pub(crate) fn get_types(&self) -> Vec<String> {
        if let Some(reference) = &self.reference {
            return vec![reference.clone()];
        }

        if let Some(dtype) = &self.dtype {
            return vec![dtype.to_string()];
        }

        Vec::new()
    }

    pub(crate) fn has_inline_object(&self) -> bool {
        !self.properties.is_empty()
    }
}

impl Serialize for Item {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        match self {
            Item::ReferenceItem(ref_item) => ref_item.serialize(serializer),
            Item::OneOfItem(one_of_item) => one_of_item.serialize(serializer),
            Item::AnyOfItem(any_of_item) => any_of_item.serialize(serializer),
            Item::PropertyItem(property) => property.serialize(serializer),
        }
    }
}

#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct ReferenceItemType {
    #[serde(rename = "$ref")]
    pub reference: String,
}

#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct OneOfItemType {
    #[serde(rename = "oneOf")]
    pub one_of: Vec<Item>,
}

#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct AnyOfItemType {
    #[serde(rename = "anyOf")]
    pub any_of: Vec<Item>,
}

/// Represents various data types that can be used in a JSON schema.
#[derive(Debug, Deserialize, Serialize, PartialEq, Variantly, Clone, Hash, Eq)]
pub enum DataType {
    #[serde(rename = "string")]
    String,
    #[serde(rename = "integer")]
    Integer,
    #[serde(rename = "number")]
    Number,
    #[serde(rename = "boolean")]
    Boolean,
    #[serde(rename = "object")]
    Object,
    #[serde(rename = "array")]
    Array,
    #[serde(rename = "null")]
    Null,
    #[serde(untagged)]
    Multiple(Box<Vec<DataType>>),
}

impl Default for DataType {
    /// Provides a default value for the DataType, which is `String`.
    fn default() -> Self {
        DataType::String
    }
}

impl FromStr for DataType {
    type Err = String;

    /// Converts a string representation of a data type into a `DataType` enum.
    ///
    /// # Errors
    ///
    /// Returns an error if the string is empty or does not match any known data type.
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "string" => Ok(DataType::String),
            "number" => Ok(DataType::Number),
            "float" => Ok(DataType::Number),
            "integer" => Ok(DataType::Integer),
            "boolean" => Ok(DataType::Boolean),
            "object" => Ok(DataType::Object),
            "array" => Ok(DataType::Array),
            _ => Err(format!("Invalid data type: {s}")),
        }
    }
}

impl Display for DataType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            DataType::String => write!(f, "string"),
            DataType::Number => write!(f, "number"),
            DataType::Integer => write!(f, "integer"),
            DataType::Boolean => write!(f, "boolean"),
            DataType::Object => write!(f, "object"),
            DataType::Array => write!(f, "array"),
            DataType::Null => write!(f, "null"),
            DataType::Multiple(types) => write!(
                f,
                "multiple({})",
                types
                    .iter()
                    .map(|t| t.to_string())
                    .collect::<Vec<String>>()
                    .join(", ")
            ),
        }
    }
}

impl TryFrom<&String> for DataType {
    type Error = String;

    fn try_from(s: &String) -> Result<Self, Self::Error> {
        match s.as_str() {
            "string" => Ok(DataType::String),
            "number" => Ok(DataType::Number),
            "integer" => Ok(DataType::Integer),
            "boolean" => Ok(DataType::Boolean),
            "array" => Ok(DataType::Array),
            "float" => Ok(DataType::Number),
            _ => Ok(DataType::Object),
        }
    }
}

#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
#[serde(untagged)]
pub enum PrimitiveType {
    String(String),
    Number(f64),
    Integer(i64),
    Boolean(bool),
}

impl From<&String> for PrimitiveType {
    /// Converts a string reference into a `PrimitiveType` enum.
    ///
    /// # Arguments
    ///
    /// * `s` - A reference to the string to be converted.
    ///
    /// # Returns
    ///
    /// A `PrimitiveType` enum variant corresponding to the parsed value.
    fn from(s: &String) -> Self {
        if let Ok(number) = s.parse::<f64>() {
            return PrimitiveType::Number(number);
        }

        if let Ok(boolean) = s.to_lowercase().parse::<bool>() {
            return PrimitiveType::Boolean(boolean);
        }

        if let Ok(integer) = s.parse::<i64>() {
            return PrimitiveType::Integer(integer);
        }

        PrimitiveType::String(s.clone())
    }
}

impl Display for PrimitiveType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            PrimitiveType::String(s) => write!(f, "{s}"),
            PrimitiveType::Number(n) => write!(f, "{n}"),
            PrimitiveType::Integer(i) => write!(f, "{i}"),
            PrimitiveType::Boolean(b) => write!(f, "{b}"),
        }
    }
}

impl From<attribute::DataType> for PrimitiveType {
    fn from(dtype: attribute::DataType) -> Self {
        match dtype {
            attribute::DataType::String(s) => {
                PrimitiveType::String(s.trim_matches('"').to_string())
            }
            attribute::DataType::Integer(i) => PrimitiveType::Integer(i),
            attribute::DataType::Float(f) => PrimitiveType::Number(f),
            attribute::DataType::Boolean(b) => PrimitiveType::Boolean(b),
        }
    }
}

fn skip_empty<T>(option: &Option<Vec<T>>) -> bool {
    match option {
        Some(vec) => vec.is_empty(),
        None => true,
    }
}

fn skip_empty_string(option: &Option<String>) -> bool {
    match option {
        Some(string) => string.is_empty(),
        None => true,
    }
}

fn default_false() -> bool {
    false
}

fn deserialize_title_with_whitespace_removal<'de, D>(deserializer: D) -> Result<String, D::Error>
where
    D: serde::Deserializer<'de>,
{
    use serde::de::{self, Visitor};
    use std::fmt;

    struct TitleVisitor;

    impl<'de> Visitor<'de> for TitleVisitor {
        type Value = String;

        fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
            formatter.write_str("a string")
        }

        fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
        where
            E: de::Error,
        {
            Ok(value.chars().filter(|c| !c.is_whitespace()).collect())
        }

        fn visit_string<E>(self, value: String) -> Result<Self::Value, E>
        where
            E: de::Error,
        {
            Ok(value.chars().filter(|c| !c.is_whitespace()).collect())
        }
    }

    deserializer.deserialize_str(TitleVisitor)
}

fn deserialize_optional_additional_properties<'de, D>(
    deserializer: D,
) -> Result<Option<bool>, D::Error>
where
    D: serde::Deserializer<'de>,
{
    use serde::de::{self, Visitor};
    use serde_json::Value;
    use std::fmt;

    struct OptionalAdditionalPropertiesVisitor;

    impl<'de> Visitor<'de> for OptionalAdditionalPropertiesVisitor {
        type Value = Option<bool>;

        fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
            formatter.write_str("a boolean or an object")
        }

        fn visit_none<E>(self) -> Result<Self::Value, E>
        where
            E: de::Error,
        {
            Ok(None)
        }

        fn visit_unit<E>(self) -> Result<Self::Value, E>
        where
            E: de::Error,
        {
            Ok(None)
        }

        fn visit_bool<E>(self, value: bool) -> Result<Self::Value, E>
        where
            E: de::Error,
        {
            Ok(Some(value))
        }

        fn visit_map<M>(self, mut map: M) -> Result<Self::Value, M::Error>
        where
            M: de::MapAccess<'de>,
        {
            while map.next_entry::<String, Value>()?.is_some() {}
            Ok(Some(true))
        }
    }

    deserializer.deserialize_any(OptionalAdditionalPropertiesVisitor)
}

fn deserialize_additional_properties<'de, D>(deserializer: D) -> Result<bool, D::Error>
where
    D: serde::Deserializer<'de>,
{
    use serde::de::{self, Visitor};
    use serde_json::Value;
    use std::fmt;

    struct AdditionalPropertiesVisitor;

    impl<'de> Visitor<'de> for AdditionalPropertiesVisitor {
        type Value = bool;

        fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
            formatter.write_str("a boolean or an object")
        }

        fn visit_bool<E>(self, value: bool) -> Result<Self::Value, E>
        where
            E: de::Error,
        {
            Ok(value)
        }

        fn visit_map<M>(self, mut map: M) -> Result<Self::Value, M::Error>
        where
            M: de::MapAccess<'de>,
        {
            // Consume all entries in the map to avoid "trailing characters" error
            while map.next_entry::<String, Value>()?.is_some() {
                // Just consume and discard
            }
            // Any object/map means additionalProperties = true
            Ok(true)
        }
    }

    deserializer.deserialize_any(AdditionalPropertiesVisitor)
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    #[test]
    /// Tests the conversion from string to DataType enum variants.
    /// It checks for correct parsing of basic types and custom references.
    fn test_from_str() {
        assert_eq!(DataType::from_str("string").unwrap(), DataType::String);
        assert_eq!(DataType::from_str("number").unwrap(), DataType::Number);
        assert_eq!(DataType::from_str("integer").unwrap(), DataType::Integer);
        assert_eq!(DataType::from_str("boolean").unwrap(), DataType::Boolean);
        assert_eq!(DataType::from_str("object").unwrap(), DataType::Object);
        assert_eq!(DataType::from_str("array").unwrap(), DataType::Array);
    }

    #[test]
    /// Tests that title deserialization removes all whitespaces from the title string.
    fn test_title_whitespace_removal() {
        use serde_json;

        // Test with spaces, tabs, and newlines
        let json_with_whitespace = r#"
        {
            "title": "My Test Title",
            "type": "object",
            "properties": {}
        }
        "#;

        let schema: SchemaObject = serde_json::from_str(json_with_whitespace).unwrap();
        assert_eq!(schema.title, "MyTestTitle");

        // Test with various whitespace characters
        let json_with_various_whitespace = r#"
        {
            "title": "  My\t\nTest\r Title  ",
            "type": "object",
            "properties": {}
        }
        "#;

        let schema2: SchemaObject = serde_json::from_str(json_with_various_whitespace).unwrap();
        assert_eq!(schema2.title, "MyTestTitle");

        // Test with no whitespace (should remain unchanged)
        let json_no_whitespace = r#"
        {
            "title": "MyTitle",
            "type": "object",
            "properties": {}
        }
        "#;

        let schema3: SchemaObject = serde_json::from_str(json_no_whitespace).unwrap();
        assert_eq!(schema3.title, "MyTitle");
    }

    #[test]
    fn test_nested_property_deserialization() {
        let property_json = json!({
            "optional": ["name"],
            "properties": {
                "display_standard_values": {
                    "default": false,
                    "type": "boolean"
                },
                "filter": {
                    "optional": ["type"],
                    "properties": {
                        "limit": {
                            "default": 1e-16,
                            "exclusiveMinimum": 0,
                            "type": "number"
                        },
                        "type": {
                            "enum": ["QR1", "QR2"],
                            "type": "string"
                        }
                    },
                    "required": ["limit"],
                    "type": "object"
                }
            },
            "required": [],
            "type": "object"
        });

        let property: Property = serde_json::from_value(property_json).unwrap();
        assert_eq!(property.properties.len(), 2);
        assert_eq!(property.optional, vec!["name"]);
        assert!(property.properties.contains_key("filter"));

        let filter = property.properties.get("filter").unwrap();
        assert_eq!(filter.properties.len(), 2);
        assert_eq!(filter.required, vec!["limit"]);
    }

    #[test]
    fn test_array_items_with_inline_object() {
        let property_json = json!({
            "type": "array",
            "items": {
                "properties": {
                    "name": { "type": "string" },
                    "solver": { "type": "string" }
                },
                "required": ["name", "solver"],
                "type": "object"
            },
            "minItems": 1,
            "uniqueItems": true
        });

        let property: Property = serde_json::from_value(property_json).unwrap();
        let items = property.items.as_ref().unwrap();
        let item_property = items.as_property().expect("expected inline object items");
        assert_eq!(item_property.properties.len(), 2);
        assert_eq!(
            property.options.get("minItems"),
            Some(&PrimitiveType::Number(1.0))
        );
        assert_eq!(
            property.options.get("uniqueItems"),
            Some(&PrimitiveType::Boolean(true))
        );
    }
}