feat(rust/catalyst-types): Add JsonSchema type to the catalyst-types crate (#624)

* add json_schema type to the `catalyst-types` crate, bump version of the `catalyst-types`

* wip

* wip

* wip

Author: Mr-Leshiy

rust/catalyst-types/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "catalyst-types"
-version = "0.0.10"
+version = "0.0.11"
 edition.workspace = true
 license.workspace = true
 authors.workspace = true
@@ -29,6 +29,8 @@ uuid = { version = "1.12.0", features = ["v4", "v7", "serde"] }
 chrono = "0.4.39"
 tracing = "0.1.41"
 strum = { version = "0.27.1", features = ["derive"] }
+jsonschema = "0.28.3"
+serde_json = { version = "1.0.134", features = ["raw_value"] }
 
 # Only include fmmap for non-wasm32 targets
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]

rust/catalyst-types/src/json_schema.rs

@@ -0,0 +1,147 @@
+//! A wrapper around a JSON Schema validator.
+
+use std::{ops::Deref, sync::Arc};
+
+use jsonschema::{options, Draft, ValidationError, Validator};
+use serde_json::Value;
+
+/// Wrapper around a JSON Schema validator.
+///
+/// Attempts to detect the draft version from the `$schema` field.
+/// If not specified, it tries Draft2020-12 first, then falls back to Draft7.
+/// Returns an error if schema is invalid for both.
+#[derive(Clone)]
+pub struct JsonSchema(Arc<Validator>);
+
+/// `JsonSchema` building error type.
+#[derive(Debug, thiserror::Error)]
+pub enum SchemaBuildError {
+    /// Invalid JSON Schema error.
+    #[error("{0}")]
+    InvalidSchema(#[from] ValidationError<'static>),
+    /// Undetectable JSON schema version.
+    #[error(
+        "Could not detect draft version and schema is not valid against Draft2020-12 or Draft7"
+    )]
+    UndetectableDraft,
+}
+
+impl Deref for JsonSchema {
+    type Target = Validator;
+
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
+impl TryFrom<&Value> for JsonSchema {
+    type Error = SchemaBuildError;
+
+    fn try_from(schema: &Value) -> std::result::Result<Self, Self::Error> {
+        let draft_version = if let Some(schema) = schema.get("$schema").and_then(|s| s.as_str()) {
+            if schema.contains("draft-07") {
+                Some(Draft::Draft7)
+            } else if schema.contains("2020-12") {
+                Some(Draft::Draft202012)
+            } else {
+                None
+            }
+        } else {
+            None
+        };
+
+        if let Some(draft) = draft_version {
+            let validator = options().with_draft(draft).build(schema)?;
+
+            Ok(JsonSchema(validator.into()))
+        } else {
+            // if draft not specified or not detectable:
+            // try draft2020-12
+            if let Ok(validator) = options().with_draft(Draft::Draft202012).build(schema) {
+                return Ok(JsonSchema(validator.into()));
+            }
+
+            // fallback to draft7
+            if let Ok(validator) = options().with_draft(Draft::Draft7).build(schema) {
+                return Ok(JsonSchema(validator.into()));
+            }
+
+            Err(SchemaBuildError::UndetectableDraft)
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use serde_json::json;
+
+    use super::*;
+
+    #[test]
+    fn valid_draft7_schema() {
+        let schema = json!({
+            "$schema": "http://json-schema.org/draft-07/schema#",
+            "type": "object",
+            "properties": {
+                "name": { "type": "string" }
+            }
+        });
+
+        let result = JsonSchema::try_from(&schema);
+        assert!(result.is_ok(), "Expected Draft7 schema to be valid");
+    }
+
+    #[test]
+    fn valid_draft2020_12_schema() {
+        let schema = json!({
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "properties": {
+                "age": { "type": "integer" }
+            }
+        });
+
+        let result = JsonSchema::try_from(&schema);
+        assert!(result.is_ok(), "Expected Draft2020-12 schema to be valid");
+    }
+
+    #[test]
+    fn schema_without_draft_should_fallback() {
+        // Valid in both Draft2020-12 and Draft7
+        let schema = json!({
+            "type": "object",
+            "properties": {
+                "id": { "type": "number" }
+            }
+        });
+
+        let result = JsonSchema::try_from(&schema);
+        assert!(
+            result.is_ok(),
+            "Expected schema without $schema to fallback and succeed"
+        );
+    }
+
+    #[test]
+    fn invalid_schema_should_error() {
+        // Invalid schema: "type" is not a valid keyword here
+        let schema = json!({
+            "$schema": "http://json-schema.org/draft-07/schema#",
+            "type": "not-a-valid-type"
+        });
+
+        let result = JsonSchema::try_from(&schema);
+        assert!(
+            result.is_err(),
+            "Expected invalid schema to return an error"
+        );
+    }
+
+    #[test]
+    fn empty_object_schema() {
+        let schema = json!({});
+
+        let result = JsonSchema::try_from(&schema);
+        assert!(result.is_ok());
+    }
+}

rust/catalyst-types/src/lib.rs

@@ -3,6 +3,7 @@
 pub mod catalyst_id;
 pub mod cbor_utils;
 pub mod conversion;
+pub mod json_schema;
 #[cfg(not(target_arch = "wasm32"))]
 pub mod mmap_file;
 pub mod problem_report;