Add library to convert data type to JSON schema. #27 (#85)

Add library to convert data type to JSON schema.

Author: badmonster0

Cargo.toml

@@ -40,3 +40,4 @@ derivative = "2.2.0"
 async-lock = "3.4.0"
 hex = "0.4.3"
 pythonize = "0.23.0"
+schemars = "0.8.22"

src/base/json_schema.rs

@@ -0,0 +1,113 @@
+use super::schema;
+use schemars::schema::{
+    ArrayValidation, InstanceType, ObjectValidation, SchemaObject, SingleOrVec,
+};
+
+pub trait ToJsonSchema {
+    fn to_json_schema(&self) -> SchemaObject;
+}
+
+impl ToJsonSchema for schema::BasicValueType {
+    fn to_json_schema(&self) -> SchemaObject {
+        let mut schema = SchemaObject::default();
+        match self {
+            schema::BasicValueType::Str => {
+                schema.instance_type = Some(SingleOrVec::Single(Box::new(InstanceType::String)));
+            }
+            schema::BasicValueType::Bytes => {
+                schema.instance_type = Some(SingleOrVec::Single(Box::new(InstanceType::String)));
+            }
+            schema::BasicValueType::Bool => {
+                schema.instance_type = Some(SingleOrVec::Single(Box::new(InstanceType::Boolean)));
+            }
+            schema::BasicValueType::Int64 => {
+                schema.instance_type = Some(SingleOrVec::Single(Box::new(InstanceType::Integer)));
+            }
+            schema::BasicValueType::Float32 | schema::BasicValueType::Float64 => {
+                schema.instance_type = Some(SingleOrVec::Single(Box::new(InstanceType::Number)));
+            }
+            schema::BasicValueType::Json => {
+                // Can be any value. No type constraint.
+            }
+            schema::BasicValueType::Range => {
+                schema.instance_type = Some(SingleOrVec::Single(Box::new(InstanceType::Array)));
+                schema.array = Some(Box::new(ArrayValidation {
+                    items: Some(SingleOrVec::Single(Box::new(
+                        SchemaObject {
+                            instance_type: Some(SingleOrVec::Single(Box::new(
+                                InstanceType::Integer,
+                            ))),
+                            ..Default::default()
+                        }
+                        .into(),
+                    ))),
+                    min_items: Some(2),
+                    max_items: Some(2),
+                    ..Default::default()
+                }));
+                schema
+                    .metadata
+                    .get_or_insert_with(|| Default::default())
+                    .description =
+                    Some("A range, start pos (inclusive), end pos (exclusive).".to_string());
+            }
+            schema::BasicValueType::Vector(s) => {
+                schema.instance_type = Some(SingleOrVec::Single(Box::new(InstanceType::Array)));
+                schema.array = Some(Box::new(ArrayValidation {
+                    items: Some(SingleOrVec::Single(Box::new(
+                        s.element_type.to_json_schema().into(),
+                    ))),
+                    min_items: s.dimension.and_then(|d| u32::try_from(d).ok()),
+                    max_items: s.dimension.and_then(|d| u32::try_from(d).ok()),
+                    ..Default::default()
+                }));
+            }
+        }
+        schema
+    }
+}
+
+impl ToJsonSchema for schema::StructSchema {
+    fn to_json_schema(&self) -> SchemaObject {
+        SchemaObject {
+            instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::Object))),
+            object: Some(Box::new(ObjectValidation {
+                properties: self
+                    .fields
+                    .iter()
+                    .map(|f| (f.name.to_string(), f.value_type.to_json_schema().into()))
+                    .collect(),
+                required: self
+                    .fields
+                    .iter()
+                    .filter_map(|f| (!f.value_type.nullable).then(|| f.name.to_string()))
+                    .collect(),
+                ..Default::default()
+            })),
+            ..Default::default()
+        }
+    }
+}
+
+impl ToJsonSchema for schema::ValueType {
+    fn to_json_schema(&self) -> SchemaObject {
+        match self {
+            schema::ValueType::Basic(b) => b.to_json_schema(),
+            schema::ValueType::Struct(s) => s.to_json_schema(),
+            schema::ValueType::Collection(c) => SchemaObject {
+                instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::Array))),
+                array: Some(Box::new(ArrayValidation {
+                    items: Some(SingleOrVec::Single(Box::new(c.row.to_json_schema().into()))),
+                    ..Default::default()
+                })),
+                ..Default::default()
+            },
+        }
+    }
+}
+
+impl ToJsonSchema for schema::EnrichedValueType {
+    fn to_json_schema(&self) -> SchemaObject {
+        self.typ.to_json_schema()
+    }
+}

src/base/mod.rs

@@ -1,4 +1,5 @@
 pub mod field_attrs;
+pub mod json_schema;
 pub mod schema;
 pub mod spec;
 pub mod value;