DHFPROD-1891 Create JSON/XML schema to validate against entity instances (#1910)

Author: ryanjdew

marklogic-data-hub/src/main/resources/ml-modules/root/data-hub/4/impl/hub-entities.xqy

@@ -300,3 +300,60 @@ declare function hent:fix-tde($nodes as node()*, $entity-model-contexts as xs:st
         )
       default return $n
 };
+
+declare variable $number-types as xs:string+ := ("byte","decimal","double","float","int","integer","long","negativeInteger","nonNegativeInteger","nonPositiveInteger","positiveInteger","short","unsignedLong","unsignedInt","unsignedShort","unsignedByte");
+declare variable $string-types as xs:string+ := "dateTime";
+
+declare function hent:json-schema-generate($entity-title as xs:string, $uber-model as map:map)
+{
+  let $uber-model := map:new((
+  (: Ensure we're not change a map for anyone else :)
+  map:map(document{$uber-model}/*),
+  map:entry("language", "zxx"),
+  map:entry("$schema", "http://json-schema.org/draft-07/schema#")
+  ))
+  let $definitions := $uber-model => map:get("definitions")
+  (: JSON Schema needs an extra level of wrapping to account for Entity Model label wrapping it. :)
+  let $_nest-refs :=
+    for $definition-type in map:keys($definitions)
+    let $definition-properties := $definitions => map:get($definition-type) => map:get("properties")
+    for $property-name in map:keys($definition-properties)
+    let $property := $definition-properties => map:get($property-name)
+    let $property-items := $property => map:get("items")
+    let $datatype := $property => map:get("datatype")
+    let $_set-types := (
+      $property => map:put("type", if ($datatype = $number-types) then "number" else if ($datatype = $string-types) then "string" else $datatype),
+      $property => map:delete("datatype"),
+      if ($property-items instance of map:map) then (
+        let $items-datatype := $property => map:get("datatype")
+        return (
+          $property-items => map:put("type", if ($items-datatype = $number-types) then "number" else if ($items-datatype = $string-types) then "string" else $datatype),
+          $property-items => map:delete("datatype"))
+      ) else ()
+    )
+    return
+    (: references can be in the property or in items for arrays :)
+      if ($property => map:contains("$ref")) then
+        map:put($definition-properties, $property-name,
+          map:new((
+            map:entry("type", "object"),
+            map:entry("properties",
+              map:entry(fn:tokenize(map:get($property,"$ref"),"/")[fn:last()], $property)
+            )
+          ))
+        )
+      else if ($property-items instance of map:map and $property-items => map:contains("$ref")) then
+        map:put($property, "items",
+          map:new((
+            map:entry("type", "object"),
+            map:entry("properties",
+              map:entry(fn:tokenize(map:get($property-items,"$ref"),"/")[fn:last()], $property-items)
+            )
+          ))
+        )
+      else ()
+  let $_set-info := (
+    $uber-model => map:put("properties", map:entry($entity-title, map:entry("$ref", "#/definitions/"||$entity-title)))
+  )
+  return xdmp:to-json($uber-model)
+};

marklogic-data-hub/src/main/resources/ml-modules/root/data-hub/4/triggers/entity-model-delete-trigger.xqy

@@ -15,6 +15,8 @@ let $entity-def := fn:doc($trgr:uri)
 let $entity-title := $entity-def/info/title
 let $entity-version := $entity-def/info/version
 let $tde-uri := "/tde/" || $entity-title || "-" || $entity-version || ".tdex"
+let $schema-xml-uri := fn:replace($trgr:uri, "\.json$", ".xsd")
+let $schema-json-uri := fn:replace($trgr:uri, "\.json$", ".schema.json")
 return (
   xdmp:invoke-function(
     function() {
@@ -23,6 +25,12 @@ return (
       else (),
       if (fn:doc-available($tde-uri)) then
         xdmp:document-delete($tde-uri)
+      else (),
+      if (fn:doc-available($schema-xml-uri)) then
+        xdmp:document-delete($schema-xml-uri)
+      else (),
+      if (fn:doc-available($schema-json-uri)) then
+        xdmp:document-delete($schema-json-uri)
       else ()
     }, map:entry("database", xdmp:schema-database())
   )

marklogic-data-hub/src/main/resources/ml-modules/root/data-hub/4/triggers/entity-model-trigger.xqy

@@ -92,6 +92,18 @@ return (
     (: Insert entity model into SCHEMA db :)
   xdmp:invoke-function(
     function() {
+      xdmp:document-insert(
+        fn:replace($trgr:uri, "\.json$", ".xsd"),
+        es:schema-generate($uber-model),
+        $default-permissions,
+        "ml-data-hub-xml-schema"
+      ),
+      xdmp:document-insert(
+        fn:replace($trgr:uri, "\.json$", ".schema.json"),
+        hent:json-schema-generate($entity-title, $uber-model),
+        $default-permissions,
+        "ml-data-hub-json-schema"
+      ),
       xdmp:document-insert(
         $trgr:uri,
         $valid-entity-model,