@json-layout/vocabulary 1.2.0 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@json-layout/vocabulary",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Main JSON Layout vocabulary as JSON schemas and Typescript types. Also contains some small utility functions to validate and normalize annotations.",
   "type": "module",
   "exports": {

package/src/components/index.js

@@ -28,6 +28,9 @@ export const standardComponents = [
   {
     name: 'none'
   },
+  {
+    name: 'slot'
+  },
   {
     name: 'section',
     composite: true

package/src/components/types.ts

@@ -16,7 +16,17 @@ export type None = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
+    [k: string]: unknown;
+  });
+export type Slot = {
+  comp?: "slot";
+  [k: string]: unknown;
+} & BaseCompObject &
+  (BaseCompObject & {
+    comp: string;
+    label?: string;
+    hint?: string | null;
     [k: string]: unknown;
   });
 export type Section = {
@@ -92,7 +102,7 @@ export type List = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) & {
     title?: string;
@@ -117,7 +127,7 @@ export type TextField = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) &
   (BaseCompObject & {
@@ -135,7 +145,7 @@ export type Textarea = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) &
   (BaseCompObject & {
@@ -153,7 +163,7 @@ export type NumberField = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) &
   (BaseCompObject & {
@@ -174,7 +184,7 @@ export type Checkbox = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   });
 export type Switch = {
@@ -184,7 +194,7 @@ export type Switch = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   });
 export type Slider = {
@@ -194,7 +204,7 @@ export type Slider = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) & {
     step?: number;
@@ -209,7 +219,7 @@ export type DatePicker = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) & {
     min?: string;
@@ -224,7 +234,7 @@ export type DateTimePicker = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) & {
     min?: string;
@@ -238,7 +248,7 @@ export type TimePicker = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) & {
     min?: string;
@@ -252,7 +262,7 @@ export type ColorPicker = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   });
 export type Select = {
@@ -262,7 +272,7 @@ export type Select = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) &
   (BaseCompObject & {
@@ -289,7 +299,7 @@ export type Autocomplete = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) &
   (BaseCompObject & {
@@ -316,7 +326,7 @@ export type Combobox = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) &
   (BaseCompObject & {
@@ -343,7 +353,7 @@ export type NumberCombobox = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) &
   (BaseCompObject & {
@@ -375,7 +385,7 @@ export type CheckboxGroup = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) &
   (BaseCompObject & {
@@ -397,7 +407,7 @@ export type SwitchGroup = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) &
   (BaseCompObject & {
@@ -419,7 +429,7 @@ export type RadioGroup = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) &
   (BaseCompObject & {
@@ -435,7 +445,7 @@ export type FileInput = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) &
   (BaseCompObject & {
@@ -460,7 +470,7 @@ export type OneOfSelect = {
   (BaseCompObject & {
     comp: string;
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
   }) & {
     emptyData?: boolean;

package/src/layout-keyword/index.js

@@ -7,6 +7,7 @@ import {ajv} from '../validate.js'
  * @typedef {import('./types.js').PartialChildren} PartialChildren
  * @typedef {import('./types.js').PartialChild} PartialChild
  * @typedef {import('./types.js').PartialChildComposite} PartialChildComposite
+ * @typedef {import('./types.js').PartialChildSlot} PartialChildSlot
  * @typedef {import('./types.js').PartialSwitch} PartialSwitch
  * @typedef {import('./types.js').PartialCompObject} PartialCompObject
  * @typedef {import('./types.js').PartialGetItems} PartialGetItems
@@ -14,6 +15,8 @@ import {ajv} from '../validate.js'
  * @typedef {import('./types.js').PartialExpression} PartialExpression
  * @typedef {import('./types.js').PartialGetItemsObj} PartialGetItemsObj
  * @typedef {import('./types.js').PartialSlotMarkdown} PartialSlotMarkdown
+ * @typedef {import('./types.js').PartialSlotText} PartialSlotText
+ * @typedef {import('./types.js').PartialSlotName} PartialSlotName
  * @typedef {import('./types.js').PartialSlot} PartialSlot
  * @typedef {import('./types.js').PartialSelectItem} PartialSelectItem
  * @typedef {{ errors: any, (layoutKeyword: any): layoutKeyword is LayoutKeyword }} ValidateLayoutKeyword
@@ -40,7 +43,12 @@ export function isPartialChildren (layoutKeyword) {
 
 /** @type {(partialChild: PartialChild) => partialChild is PartialChildComposite} */
 export function isPartialChildComposite (partialChild) {
-  return typeof partialChild !== 'string' && "children" in partialChild
+  return typeof partialChild !== 'string' && 'children' in partialChild
+}
+
+/** @type {(partialChild: PartialChild) => partialChild is PartialChildSlot} */
+export function isPartialChildSlot (partialChild) {
+  return typeof partialChild !== 'string' && ('text' in partialChild || 'markdown' in partialChild || 'name' in partialChild)
 }
 
 /** @type {(layoutKeyword: LayoutKeyword) => layoutKeyword is PartialCompObject} */
@@ -66,4 +74,14 @@ export function isPartialGetItemsFetch (getItems) {
 /** @type {(partialSlot: PartialSlot) => partialSlot is PartialSlotMarkdown} */
 export function isPartialSlotMarkdown (partialSlot) {
   return typeof partialSlot == 'object' && !!/** @type {PartialSlotMarkdown} */(partialSlot).markdown
+}
+
+/** @type {(partialSlot: PartialSlot) => partialSlot is PartialSlotText} */
+export function isPartialSlotText (partialSlot) {
+  return typeof partialSlot == 'object' && !!/** @type {PartialSlotText} */(partialSlot).text
+}
+
+/** @type {(partialSlot: PartialSlot) => partialSlot is PartialSlotName} */
+export function isPartialSlotName (partialSlot) {
+  return typeof partialSlot == 'object' && !!/** @type {PartialSlotName} */(partialSlot).name
 }

package/src/layout-keyword/schema.js

@@ -54,6 +54,12 @@ export default {
         "label": {
           "type": "string"
         },
+        "hint": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
         "title": {
           "type": [
             "string",
@@ -170,6 +176,14 @@ export default {
         },
         "if": {
           "$ref": "#/$defs/partial-expression"
+        },
+        "slots": {
+          "type": "object",
+          "patternProperties": {
+            ".*": {
+              "$ref": "#/$defs/partial-slot"
+            }
+          }
         }
       }
     },
@@ -202,19 +216,58 @@ export default {
         },
         "if": {
           "$ref": "#/$defs/partial-expression"
+        },
+        "slots": {
+          "type": "object",
+          "patternProperties": {
+            ".*": {
+              "$ref": "#/$defs/partial-slot"
+            }
+          }
         }
       }
     },
+    "partial-child-slot": {
+      "type": "object",
+      "properties": {
+        "cols": {
+          "$ref": "#/$defs/partial-cols"
+        },
+        "if": {
+          "$ref": "#/$defs/partial-expression"
+        }
+      },
+      "oneOf": [
+        {
+          "$ref": "#/$defs/partial-slot-text"
+        },
+        {
+          "$ref": "#/$defs/partial-slot-markdown"
+        },
+        {
+          "$ref": "#/$defs/partial-slot-name"
+        }
+      ]
+    },
     "partial-child": {
       "anyOf": [
         {
           "type": "string"
         },
+        {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/partial-child"
+          }
+        },
         {
           "$ref": "#/$defs/partial-child-ref"
         },
         {
           "$ref": "#/$defs/partial-child-composite"
+        },
+        {
+          "$ref": "#/$defs/partial-child-slot"
         }
       ]
     },

package/src/layout-keyword/schema.json

@@ -32,6 +32,7 @@
         "help": {"type": "string"},
         "children": {"$ref": "#/$defs/partial-children"},
         "label": {"type": "string"},
+        "hint": {"type": ["string", "null"]},
         "title": {"type": ["string", "null"]},
         "subtitle": {"type": ["string", "null"]},
         "step": {"type": "number"},
@@ -72,7 +73,13 @@
       "properties": {
         "key": {"type": ["string", "integer"]},
         "cols": {"$ref": "#/$defs/partial-cols"},
-        "if": {"$ref": "#/$defs/partial-expression"}
+        "if": {"$ref": "#/$defs/partial-expression"},
+        "slots": {
+          "type": "object",
+          "patternProperties": {
+            ".*": {"$ref": "#/$defs/partial-slot"}
+          }
+        }
       }
     },
     "partial-child-composite": {
@@ -84,14 +91,34 @@
         "subtitle": {"type": ["string", "null"]},
         "children": {"$ref": "#/$defs/partial-children"},
         "cols": {"$ref": "#/$defs/partial-cols"},
-        "if": {"$ref": "#/$defs/partial-expression"}
+        "if": {"$ref": "#/$defs/partial-expression"},
+        "slots": {
+          "type": "object",
+          "patternProperties": {
+            ".*": {"$ref": "#/$defs/partial-slot"}
+          }
+        }
       }
     },
+    "partial-child-slot": {
+      "type": "object",
+      "properties": {
+        "cols": {"$ref": "#/$defs/partial-cols"},
+        "if": {"$ref": "#/$defs/partial-expression"}
+      },
+      "oneOf": [
+        {"$ref": "#/$defs/partial-slot-text"},
+        {"$ref": "#/$defs/partial-slot-markdown"},
+        {"$ref": "#/$defs/partial-slot-name"}
+      ]
+    },
     "partial-child": {
       "anyOf": [
         {"type": "string"},
+        {"type": "array", "items": {"$ref": "#/$defs/partial-child"}},
         {"$ref": "#/$defs/partial-child-ref"},
-        {"$ref": "#/$defs/partial-child-composite"}
+        {"$ref": "#/$defs/partial-child-composite"},
+        {"$ref": "#/$defs/partial-child-slot"}
       ]
     },
     "partial-children": {

package/src/layout-keyword/types.ts

@@ -12,7 +12,7 @@ export type ComponentName = string;
  * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
  * via the `definition` "partial-child".
  */
-export type PartialChild = string | PartialChildRef | PartialChildComposite;
+export type PartialChild = string | PartialChild[] | PartialChildRef | PartialChildComposite | PartialChildSlot;
 /**
  * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
  * via the `definition` "partial-cols".
@@ -28,6 +28,30 @@ export type PartialColsNumber = number;
  * via the `definition` "partial-expression".
  */
 export type PartialExpression = string | PartialExpressionObj;
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema definition
+ * via the `patternProperty` ".*".
+ *
+ * This interface was referenced by `undefined`'s JSON-Schema definition
+ * via the `patternProperty` ".*".
+ *
+ * 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 PartialChildSlot = {
+  cols?: PartialCols;
+  if?: PartialExpression;
+  [k: string]: unknown;
+} & PartialChildSlot1;
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
+ * via the `definition` "partial-child-slot".
+ */
+export type PartialChildSlot1 = PartialSlotText | PartialSlotMarkdown | PartialSlotName;
 /**
  * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
  * via the `definition` "partial-children".
@@ -68,14 +92,6 @@ export type PartialGetItemsObj = {
   | PartialExpressionObj
   | PartialGetItemsFetch
 );
-/**
- * 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 interface HttpsJsonLayoutGithubIoLayoutKeyword {
   [k: string]: unknown;
@@ -88,6 +104,9 @@ export interface PartialChildRef {
   key: string | number;
   cols?: PartialCols;
   if?: PartialExpression;
+  slots?: {
+    [k: string]: PartialSlot;
+  };
 }
 /**
  * This interface was referenced by `HttpsJsonLayoutGithubIoLayoutKeyword`'s JSON-Schema
@@ -110,6 +129,27 @@ export interface PartialExpressionObj {
   expr: string;
   [k: string]: unknown;
 }
+/**
+ * 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-child-composite".
@@ -121,6 +161,9 @@ export interface PartialChildComposite {
   children: PartialChildren;
   cols?: PartialCols;
   if?: PartialExpression;
+  slots?: {
+    [k: string]: PartialSlot;
+  };
   [k: string]: unknown;
 }
 /**
@@ -132,6 +175,7 @@ export interface PartialCompObject {
   help?: string;
   children?: PartialChildren;
   label?: string;
+  hint?: string | null;
   title?: string | null;
   subtitle?: string | null;
   step?: number;
@@ -172,27 +216,6 @@ export interface PartialGetItemsFetch {
   url: PartialExpression;
   [k: string]: unknown;
 }
-/**
- * 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".