vld 0.3.0

Type-safe runtime validation library for Rust, inspired by Zod
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

use serde_json::Value;

use crate::error::{IssueCode, VldError};
use crate::schema::VldSchema;

#[derive(Clone)]
pub struct ZJsonValue {
    require_object: bool,
    require_array: bool,
    required_keys: Vec<String>,
    max_depth: Option<usize>,
}

impl ZJsonValue {
    pub fn new() -> Self {
        Self {
            require_object: false,
            require_array: false,
            required_keys: Vec::new(),
            max_depth: None,
        }
    }

    pub fn object(mut self) -> Self {
        self.require_object = true;
        self.require_array = false;
        self
    }

    pub fn array(mut self) -> Self {
        self.require_array = true;
        self.require_object = false;
        self
    }

    pub fn require_key(mut self, key: impl Into<String>) -> Self {
        self.required_keys.push(key.into());
        self
    }

    pub fn max_depth(mut self, depth: usize) -> Self {
        self.max_depth = Some(depth);
        self
    }

    #[cfg(feature = "openapi")]
    pub fn to_json_schema(&self) -> serde_json::Value {
        let mut schema = serde_json::json!({});
        if self.require_object {
            schema["type"] = serde_json::json!("object");
            if !self.required_keys.is_empty() {
                schema["required"] = serde_json::json!(self.required_keys);
            }
        } else if self.require_array {
            schema["type"] = serde_json::json!("array");
        }
        if let Some(depth) = self.max_depth {
            schema["x-maxDepth"] = serde_json::json!(depth);
        }
        schema
    }
}

impl Default for ZJsonValue {
    fn default() -> Self {
        Self::new()
    }
}

fn depth(value: &Value) -> usize {
    match value {
        Value::Array(arr) => 1 + arr.iter().map(depth).max().unwrap_or(0),
        Value::Object(map) => 1 + map.values().map(depth).max().unwrap_or(0),
        _ => 1,
    }
}

impl VldSchema for ZJsonValue {
    type Output = Value;

    fn parse_value(&self, value: &Value) -> Result<Self::Output, VldError> {
        if self.require_object && !value.is_object() {
            return Err(VldError::single_with_value(
                IssueCode::InvalidType {
                    expected: "object".to_string(),
                    received: crate::error::value_type_name(value),
                },
                "Expected object JSON value",
                value,
            ));
        }
        if self.require_array && !value.is_array() {
            return Err(VldError::single_with_value(
                IssueCode::InvalidType {
                    expected: "array".to_string(),
                    received: crate::error::value_type_name(value),
                },
                "Expected array JSON value",
                value,
            ));
        }
        if !self.required_keys.is_empty() {
            let obj = value.as_object().ok_or_else(|| {
                VldError::single_with_value(
                    IssueCode::InvalidType {
                        expected: "object".to_string(),
                        received: crate::error::value_type_name(value),
                    },
                    "Required keys can be checked only for object values",
                    value,
                )
            })?;
            for k in &self.required_keys {
                if !obj.contains_key(k) {
                    return Err(VldError::single_with_value(
                        IssueCode::MissingField,
                        format!("Missing required key `{}`", k),
                        value,
                    ));
                }
            }
        }
        if let Some(max_depth) = self.max_depth {
            let d = depth(value);
            if d > max_depth {
                return Err(VldError::single_with_value(
                    IssueCode::Custom {
                        code: "json_depth_exceeded".to_string(),
                    },
                    format!("JSON depth {} exceeds max {}", d, max_depth),
                    value,
                ));
            }
        }
        Ok(value.clone())
    }
}