@json-layout/vocabulary 0.14.0 → 0.15.0

package/src/layout-keyword/index.js

@@ -1,10 +1,12 @@
-import validate from './validate.js'
 import schema from './schema.js'
+import {ajv} from '../validate.js'
 
 /**
  * @typedef {import('./types.js').LayoutKeyword} LayoutKeyword
  * @typedef {import('./types.js').ComponentName} ComponentName
  * @typedef {import('./types.js').PartialChildren} PartialChildren
+ * @typedef {import('./types.js').PartialChild} PartialChild
+ * @typedef {import('./types.js').PartialChildComposite} PartialChildComposite
  * @typedef {import('./types.js').PartialSwitch} PartialSwitch
  * @typedef {import('./types.js').PartialCompObject} PartialCompObject
  * @typedef {import('./types.js').PartialGetItems} PartialGetItems
@@ -17,7 +19,7 @@ import schema from './schema.js'
  * @typedef {{ errors: any, (layoutKeyword: any): layoutKeyword is LayoutKeyword }} ValidateLayoutKeyword
  */
 
-export const /** @type {ValidateLayoutKeyword} */ validateLayoutKeyword = /** @type {any} */ (validate)
+export const /** @type {ValidateLayoutKeyword} */ validateLayoutKeyword = /** @type {any} */ (ajv.getSchema(schema.$id))
 
 export const layoutKeywordSchema = /** @type {any} */ (schema)
 
@@ -36,6 +38,11 @@ export function isPartialChildren (layoutKeyword) {
   return Array.isArray(layoutKeyword)
 }
 
+/** @type {(partialChild: PartialChild) => partialChild is PartialChildComposite} */
+export function isPartialChildComposite (partialChild) {
+  return typeof partialChild !== 'string' && "children" in partialChild
+}
+
 /** @type {(layoutKeyword: LayoutKeyword) => layoutKeyword is PartialCompObject} */
 export function isPartialCompObject (layoutKeyword) {
   return typeof layoutKeyword === 'object' && !Array.isArray(layoutKeyword)

package/src/layout-keyword/schema.js

@@ -2,25 +2,27 @@
 // raw schema
 export default {
   "$id": "https://json-layout.github.io/layout-keyword",
-  "title": "layout keyword",
-  "errorMessage": {
-    "anyOf": "layout keyword must be a string with a valid component name, or a more complete object definition, or an array of children, or a switch structure"
-  },
-  "anyOf": [
-    {
-      "$ref": "#/$defs/comp-name"
-    },
-    {
-      "$ref": "#/$defs/partial-children"
-    },
-    {
-      "$ref": "#/$defs/partial-comp-object"
-    },
-    {
-      "$ref": "#/$defs/partial-switch"
-    }
-  ],
   "$defs": {
+    "layout-keyword": {
+      "title": "layout keyword",
+      "errorMessage": {
+        "anyOf": "layout keyword must be a string with a valid component name, or a more complete object definition, or an array of children, or a switch structure"
+      },
+      "anyOf": [
+        {
+          "$ref": "#/$defs/comp-name"
+        },
+        {
+          "$ref": "#/$defs/partial-children"
+        },
+        {
+          "$ref": "#/$defs/partial-comp-object"
+        },
+        {
+          "$ref": "#/$defs/partial-switch"
+        }
+      ]
+    },
     "partial-switch": {
       "type": "object",
       "required": [
@@ -148,40 +150,14 @@ export default {
     },
     "comp-name": {
       "title": "component name",
-      "type": "string",
-      "errorMessage": {
-        "enum": "component name is unknown"
-      },
-      "enum": [
-        "none",
-        "text-field",
-        "number-field",
-        "textarea",
-        "markdown",
-        "checkbox",
-        "switch",
-        "slider",
-        "date-picker",
-        "date-time-picker",
-        "time-picker",
-        "color-picker",
-        "combobox",
-        "number-combobox",
-        "section",
-        "list",
-        "select",
-        "autocomplete",
-        "tabs",
-        "vertical-tabs",
-        "expansion-panels",
-        "stepper",
-        "one-of-select",
-        "file-input"
-      ]
+      "type": "string"
     },
-    "partial-child": {
+    "partial-child-ref": {
       "type": "object",
-      "unevaluatedProperties": false,
+      "required": [
+        "key"
+      ],
+      "additionalProperties": false,
       "properties": {
         "key": {
           "type": [
@@ -192,25 +168,54 @@ export default {
         "cols": {
           "$ref": "#/$defs/partial-cols"
         }
-      },
-      "allOf": [
+      }
+    },
+    "partial-child-composite": {
+      "type": "object",
+      "required": [
+        "children"
+      ],
+      "properties": {
+        "comp": {
+          "type": "string"
+        },
+        "title": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "subtitle": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "children": {
+          "$ref": "#/$defs/partial-children"
+        },
+        "cols": {
+          "$ref": "#/$defs/partial-cols"
+        }
+      }
+    },
+    "partial-child": {
+      "anyOf": [
         {
-          "$ref": "#/$defs/partial-comp-object"
+          "type": "string"
+        },
+        {
+          "$ref": "#/$defs/partial-child-ref"
         },
-        {}
+        {
+          "$ref": "#/$defs/partial-child-composite"
+        }
       ]
     },
     "partial-children": {
       "type": "array",
       "items": {
-        "oneOf": [
-          {
-            "type": "string"
-          },
-          {
-            "$ref": "#/$defs/partial-child"
-          }
-        ]
+        "$ref": "#/$defs/partial-child"
       }
     },
     "partial-expression": {

package/src/layout-keyword/schema.json

@@ -1,16 +1,18 @@
 {
   "$id": "https://json-layout.github.io/layout-keyword",
-  "title": "layout keyword",
-  "errorMessage": {
-    "anyOf": "layout keyword must be a string with a valid component name, or a more complete object definition, or an array of children, or a switch structure"
-  },
-  "anyOf": [
-    {"$ref": "#/$defs/comp-name"},
-    {"$ref": "#/$defs/partial-children"},
-    {"$ref": "#/$defs/partial-comp-object"},
-    {"$ref": "#/$defs/partial-switch"}
-  ],
   "$defs": {
+    "layout-keyword": {
+      "title": "layout keyword",
+      "errorMessage": {
+        "anyOf": "layout keyword must be a string with a valid component name, or a more complete object definition, or an array of children, or a switch structure"
+      },
+      "anyOf": [
+        {"$ref": "#/$defs/comp-name"},
+        {"$ref": "#/$defs/partial-children"},
+        {"$ref": "#/$defs/partial-comp-object"},
+        {"$ref": "#/$defs/partial-switch"}
+      ]
+    },
     "partial-switch": {
       "type": "object",
       "required": ["switch"],
@@ -61,56 +63,39 @@
     },
     "comp-name": {
       "title": "component name",
-      "type": "string",
-      "errorMessage": {
-        "enum": "component name is unknown"
-      },
-      "enum": [
-        "none",
-        "text-field",
-        "number-field",
-        "textarea",
-        "markdown",
-        "checkbox",
-        "switch",
-        "slider",
-        "date-picker",
-        "date-time-picker",
-        "time-picker",
-        "color-picker",
-        "combobox",
-        "number-combobox",
-        "section",
-        "list",
-        "select",
-        "autocomplete",
-        "tabs",
-        "vertical-tabs",
-        "expansion-panels",
-        "stepper",
-        "one-of-select",
-        "file-input"
-      ]
+      "type": "string"
     },
-    "partial-child": {
+    "partial-child-ref": {
       "type": "object",
-      "unevaluatedProperties": false,
+      "required": ["key"],
+      "additionalProperties": false,
       "properties": {
         "key": {"type": ["string", "integer"]},
         "cols": {"$ref": "#/$defs/partial-cols"}
-      },
-      "allOf": [
-        {"$ref": "#/$defs/partial-comp-object"},
-        {}
+      }
+    },
+    "partial-child-composite": {
+      "type": "object",
+      "required": ["children"],
+      "properties": {
+        "comp": {"type": "string"},
+        "title": {"type": ["string", "null"]},
+        "subtitle": {"type": ["string", "null"]},
+        "children": {"$ref": "#/$defs/partial-children"},
+        "cols": {"$ref": "#/$defs/partial-cols"}
+      }
+    },
+    "partial-child": {
+      "anyOf": [
+        {"type": "string"},
+        {"$ref": "#/$defs/partial-child-ref"},
+        {"$ref": "#/$defs/partial-child-composite"}
       ]
     },
     "partial-children": {
       "type": "array",
       "items": {
-        "oneOf": [
-          {"type": "string"},
-          {"$ref": "#/$defs/partial-child"}
-        ]
+        "$ref": "#/$defs/partial-child"
       }
     },
     "partial-expression": {

package/src/layout-keyword/types.ts

@@ -1,36 +1,42 @@
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "layout-keyword".
+ */
 export type LayoutKeyword = ComponentName | PartialChildren | PartialCompObject | PartialSwitch;
-export type ComponentName =
-  | "none"
-  | "text-field"
-  | "number-field"
-  | "textarea"
-  | "markdown"
-  | "checkbox"
-  | "switch"
-  | "slider"
-  | "date-picker"
-  | "date-time-picker"
-  | "time-picker"
-  | "color-picker"
-  | "combobox"
-  | "number-combobox"
-  | "section"
-  | "list"
-  | "select"
-  | "autocomplete"
-  | "tabs"
-  | "vertical-tabs"
-  | "expansion-panels"
-  | "stepper"
-  | "one-of-select"
-  | "file-input";
-export type PartialChild = PartialChild1 & {
-  key?: string | number;
-  cols?: PartialCols;
-  [k: string]: unknown;
-};
-export type PartialChild1 = PartialCompObject & unknown;
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "comp-name".
+ */
+export type ComponentName = string;
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-child".
+ */
+export type PartialChild = string | PartialChildRef | PartialChildComposite;
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-cols".
+ */
+export type PartialCols = PartialColsNumber | PartialColsObj;
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-cols-number".
+ */
+export type PartialColsNumber = number;
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-children".
+ */
+export type PartialChildren = PartialChild[];
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-expression".
+ */
 export type PartialExpression = string | PartialExpressionObj;
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-select-item".
+ */
 export type PartialSelectItem =
   | string
   | {
@@ -39,7 +45,15 @@ export type PartialSelectItem =
       value?: unknown;
       [k: string]: unknown;
     };
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-get-items".
+ */
 export type PartialGetItems = string | PartialGetItemsObj;
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-get-items-obj".
+ */
 export type PartialGetItemsObj = {
   itemTitle?: PartialExpression;
   itemKey?: PartialExpression;
@@ -54,15 +68,54 @@ export type PartialGetItemsObj = {
   | PartialExpressionObj
   | PartialGetItemsFetch
 );
-export type PartialCols = PartialColsNumber | PartialColsObj;
-export type PartialColsNumber = number;
 /**
  * This interface was referenced by `undefined`'s JSON-Schema definition
  * via the `patternProperty` ".*".
+ *
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-slot".
  */
 export type PartialSlot = string | PartialSlotText | PartialSlotMarkdown | PartialSlotName;
-export type PartialChildren = (string | PartialChild)[];
 
+export interface HttpsJsonLayoutGithubIoLayoutKeyword {
+  [k: string]: unknown;
+}
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-child-ref".
+ */
+export interface PartialChildRef {
+  key: string | number;
+  cols?: PartialCols;
+}
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-cols-obj".
+ */
+export interface PartialColsObj {
+  xs?: PartialColsNumber;
+  sm?: PartialColsNumber;
+  md?: PartialColsNumber;
+  lg?: PartialColsNumber;
+  xl?: PartialColsNumber;
+  xxl?: PartialColsNumber;
+}
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-child-composite".
+ */
+export interface PartialChildComposite {
+  comp?: string;
+  title?: string | null;
+  subtitle?: string | null;
+  children: PartialChildren;
+  cols?: PartialCols;
+  [k: string]: unknown;
+}
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-comp-object".
+ */
 export interface PartialCompObject {
   comp?: ComponentName;
   help?: string;
@@ -100,32 +153,48 @@ export interface PartialCompObject {
   separator?: string;
   [k: string]: unknown;
 }
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-expression-obj".
+ */
 export interface PartialExpressionObj {
   type?: "js-fn" | "js-eval" | "js-tpl";
   expr: string;
   [k: string]: unknown;
 }
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-get-items-fetch".
+ */
 export interface PartialGetItemsFetch {
   url: PartialExpression;
   [k: string]: unknown;
 }
-export interface PartialColsObj {
-  xs?: PartialColsNumber;
-  sm?: PartialColsNumber;
-  md?: PartialColsNumber;
-  lg?: PartialColsNumber;
-  xl?: PartialColsNumber;
-  xxl?: PartialColsNumber;
-}
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-slot-text".
+ */
 export interface PartialSlotText {
   text: string;
 }
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-slot-markdown".
+ */
 export interface PartialSlotMarkdown {
   markdown: string;
 }
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-slot-name".
+ */
 export interface PartialSlotName {
   name: string;
 }
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-switch".
+ */
 export interface PartialSwitch {
   switch: PartialCompObject[];
 }