@json-layout/vocabulary 0.13.0 → 0.15.0

package/src/normalized-layout/types.ts

@@ -1,51 +1,12 @@
-export type NormalizedLayout = SwitchStruct | CompObject;
-export type CompObject = {
-  if?: Expression;
-  options?: StateNodeOptionsBase;
-  getOptions?: Expression;
-  defaultData?: unknown;
-  getDefaultData?: Expression;
-  constData?: unknown;
-  getConstData?: Expression;
-  transformData?: Expression;
-  nullable?: boolean;
-  help?: string;
-  cols?: ColsObj;
-  props?: StateNodePropsLib;
-  getProps?: Expression;
-  slots?: StateNodeSlotsLib & {
-    before?: Slot;
-    after?: Slot;
-    component?: Slot;
-    [k: string]: unknown;
-  };
-  [k: string]: unknown;
-} & (
-  | None
-  | List
-  | TextField
-  | NumberField
-  | Textarea
-  | Markdown
-  | Checkbox
-  | Switch
-  | Slider
-  | DatePicker
-  | DateTimePicker
-  | TimePicker
-  | ColorPicker
-  | Combobox
-  | NumberCombobox
-  | Select
-  | Autocomplete
-  | OneOfSelect
-  | Section
-  | Tabs
-  | VerticalTabs
-  | ExpansionPanels
-  | Stepper
-  | FileInput
-);
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "normalized-layout".
+ */
+export type NormalizedLayout = SwitchStruct | BaseCompObject;
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "state-node-options-base".
+ */
 export type StateNodeOptionsBase = StateNodeOptionsBaseLib & {
   readOnly?: boolean;
   summary?: boolean;
@@ -56,17 +17,25 @@ export type StateNodeOptionsBase = StateNodeOptionsBaseLib & {
    */
   removeAdditional?: boolean | ("unknown" | "error" | "none");
   validateOn?: "input" | "blur" | "submit";
+  updateOn?: "input" | "blur";
+  debounceInputMs?: number;
   initialValidation?: "never" | "always" | "withData";
   defaultOn?: "missing" | "empty" | "never";
   autofocus?: boolean;
   readOnlyPropertiesMode?: "remove" | "hide" | "show";
-  debounceInputMs?: number;
   [k: string]: unknown;
 };
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "cols".
+ */
 export type Cols = number;
 /**
  * This interface was referenced by `StateNodeSlotsLib`'s JSON-Schema definition
  * via the `patternProperty` ".*".
+ *
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "slot".
  */
 export type Slot =
   | {
@@ -78,7 +47,67 @@ export type Slot =
   | {
       name: string;
     };
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "composite-comp-object".
+ */
+export type CompositeCompObject = BaseCompObject & {
+  comp: string;
+  title?: string | null;
+  subtitle?: string | null;
+  children: Children;
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "child".
+ */
+export type Child = ChildRef | ChildComposite;
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "children".
+ */
+export type Children = Child[];
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "simple-comp-object".
+ */
+export type SimpleCompObject = BaseCompObject & {
+  comp: string;
+  label?: string;
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "focusable-comp-object".
+ */
+export type FocusableCompObject = BaseCompObject & {
+  comp: string;
+  label?: string;
+  autofocus?: boolean;
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "items-based-comp-object".
+ */
+export type ItemsBasedCompObject = BaseCompObject & {
+  comp: string;
+  items?: SelectItems;
+  getItems?: GetItems;
+  multiple?: boolean;
+  separator?: string;
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "select-items".
+ */
 export type SelectItems = SelectItem[];
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "get-items".
+ */
 export type GetItems = {
   returnObjects?: boolean;
   itemsResults?: Expression;
@@ -88,21 +117,59 @@ export type GetItems = {
   itemIcon?: Expression;
   [k: string]: unknown;
 } & (Expression | GetItemsFetch);
-export type Child = Child1 & {
-  key: string | number;
-  cols?: ColsObj;
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "multiple-compat-comp-object".
+ */
+export type MultipleCompatCompObject = BaseCompObject & {
+  comp: string;
+  multiple?: boolean;
   [k: string]: unknown;
 };
-export type Child1 = unknown | CompositeCompObject;
-export type CompositeCompObject = Section | Tabs | VerticalTabs | ExpansionPanels;
-export type Children = Child[];
 
+export interface HttpsJsonLayoutGithubIoNormalizedLayoutKeyword {
+  [k: string]: unknown;
+}
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "switch-struct".
+ */
 export interface SwitchStruct {
-  switch: CompObject[];
+  switch: BaseCompObject[];
+}
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "base-comp-object".
+ */
+export interface BaseCompObject {
+  comp: string;
+  if?: Expression;
+  options?: StateNodeOptionsBase;
+  getOptions?: Expression;
+  defaultData?: unknown;
+  getDefaultData?: Expression;
+  constData?: unknown;
+  getConstData?: Expression;
+  transformData?: Expression;
+  nullable?: boolean;
+  help?: string;
+  cols?: ColsObj;
+  props?: StateNodePropsLib;
+  getProps?: Expression;
+  slots?: StateNodeSlotsLib & {
+    before?: Slot;
+    after?: Slot;
+    component?: Slot;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
 }
 /**
  * This interface was referenced by `undefined`'s JSON-Schema definition
  * via the `patternProperty` ".*".
+ *
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "expression".
  */
 export interface Expression {
   type: "js-fn" | "js-eval" | "js-tpl";
@@ -111,6 +178,10 @@ export interface Expression {
   ref?: number;
   [k: string]: unknown;
 }
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "state-node-options-base-lib".
+ */
 export interface StateNodeOptionsBaseLib {
   /**
    * This interface was referenced by `StateNodeOptionsBaseLib`'s JSON-Schema definition
@@ -118,6 +189,10 @@ export interface StateNodeOptionsBaseLib {
    */
   [k: string]: unknown;
 }
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "cols-obj".
+ */
 export interface ColsObj {
   xs: number;
   sm?: Cols;
@@ -126,6 +201,10 @@ export interface ColsObj {
   xl?: Cols;
   xxl?: Cols;
 }
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "state-node-props-lib".
+ */
 export interface StateNodePropsLib {
   /**
    * This interface was referenced by `StateNodePropsLib`'s JSON-Schema definition
@@ -133,111 +212,38 @@ export interface StateNodePropsLib {
    */
   [k: string]: unknown;
 }
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "state-node-slots-lib".
+ */
 export interface StateNodeSlotsLib {
   [k: string]: Slot;
 }
-export interface None {
-  comp: "none";
-  [k: string]: unknown;
-}
-export interface List {
-  comp: "list";
-  title?: string;
-  listEditMode: "inline" | "inline-single" | "menu" | "dialog";
-  listActions: ("add" | "edit" | "delete" | "sort" | "duplicate")[];
-  itemTitle?: Expression;
-  itemSubtitle?: Expression;
-  messages?: {
-    addItem?: string;
-    delete?: string;
-    edit?: string;
-    duplicate?: string;
-    sort?: string;
-  };
-  [k: string]: unknown;
-}
-export interface TextField {
-  comp: "text-field";
-  label: string;
-  autofocus?: boolean;
-  [k: string]: unknown;
-}
-export interface NumberField {
-  comp: "number-field";
-  label: string;
-  autofocus?: boolean;
-  step?: number;
-  min?: number;
-  max?: number;
-  [k: string]: unknown;
-}
-export interface Textarea {
-  comp: "textarea";
-  label: string;
-  autofocus?: boolean;
-  [k: string]: unknown;
-}
-export interface Markdown {
-  comp: "markdown";
-  label: string;
-  autofocus?: boolean;
-  [k: string]: unknown;
-}
-export interface Checkbox {
-  comp: "checkbox";
-  label: string;
-  [k: string]: unknown;
-}
-export interface Switch {
-  comp: "switch";
-  label: string;
-  [k: string]: unknown;
-}
-export interface Slider {
-  comp: "slider";
-  label: string;
-  step?: number;
-  min: number;
-  max: number;
-  [k: string]: unknown;
-}
-export interface DatePicker {
-  comp: "date-picker";
-  label: string;
-  min?: string;
-  max?: string;
-  format?: "date" | "date-time";
-  [k: string]: unknown;
-}
-export interface DateTimePicker {
-  comp: "date-time-picker";
-  label: string;
-  min?: string;
-  max?: string;
-  [k: string]: unknown;
-}
-export interface TimePicker {
-  comp: "time-picker";
-  label: string;
-  min?: string;
-  max?: string;
-  [k: string]: unknown;
-}
-export interface ColorPicker {
-  comp: "color-picker";
-  label: string;
-  [k: string]: unknown;
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "child-ref".
+ */
+export interface ChildRef {
+  key: string | number;
+  cols?: ColsObj;
 }
-export interface Combobox {
-  comp: "combobox";
-  label: string;
-  autofocus?: boolean;
-  items?: SelectItems;
-  getItems?: GetItems;
-  multiple?: boolean;
-  separator?: string;
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "child-composite".
+ */
+export interface ChildComposite {
+  key: string | number;
+  cols?: ColsObj;
+  comp?: string;
+  title?: string | null;
+  subtitle?: string | null;
+  children: Children;
   [k: string]: unknown;
 }
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "select-item".
+ */
 export interface SelectItem {
   title: string;
   key: string;
@@ -245,6 +251,10 @@ export interface SelectItem {
   icon?: string;
   [k: string]: unknown;
 }
+/**
+ * This interface was referenced by `HttpsJsonLayoutGithubIoNormalizedLayoutKeyword`'s JSON-Schema
+ * via the `definition` "get-items-fetch".
+ */
 export interface GetItemsFetch {
   url: Expression;
   qSearchParam?: string;
@@ -253,82 +263,3 @@ export interface GetItemsFetch {
   };
   [k: string]: unknown;
 }
-export interface NumberCombobox {
-  comp: "number-combobox";
-  label: string;
-  autofocus?: boolean;
-  items?: SelectItems;
-  getItems?: GetItems;
-  multiple?: boolean;
-  step?: number;
-  min?: number;
-  max?: number;
-  [k: string]: unknown;
-}
-export interface Select {
-  comp: "select";
-  label: string;
-  autofocus?: boolean;
-  items?: SelectItems;
-  getItems?: GetItems;
-  multiple?: boolean;
-  separator?: string;
-  [k: string]: unknown;
-}
-export interface Autocomplete {
-  comp: "autocomplete";
-  label: string;
-  autofocus?: boolean;
-  items?: SelectItems;
-  getItems?: GetItems;
-  multiple?: boolean;
-  separator?: string;
-  [k: string]: unknown;
-}
-export interface OneOfSelect {
-  comp: "one-of-select";
-  label: string;
-  [k: string]: unknown;
-}
-export interface Section {
-  comp: "section";
-  title?: string | null;
-  subtitle?: string | null;
-  children: Children;
-  [k: string]: unknown;
-}
-export interface Tabs {
-  comp: "tabs";
-  title?: string | null;
-  subtitle?: string | null;
-  children: Children;
-  [k: string]: unknown;
-}
-export interface VerticalTabs {
-  comp: "vertical-tabs";
-  title?: string | null;
-  subtitle?: string | null;
-  children: Children;
-  [k: string]: unknown;
-}
-export interface ExpansionPanels {
-  comp: "expansion-panels";
-  title?: string | null;
-  subtitle?: string | null;
-  children: Children;
-  [k: string]: unknown;
-}
-export interface Stepper {
-  comp: "stepper";
-  title?: string | null;
-  subtitle?: string | null;
-  children: Children;
-  [k: string]: unknown;
-}
-export interface FileInput {
-  comp: "file-input";
-  label: string;
-  accept?: string;
-  multiple?: boolean;
-  [k: string]: unknown;
-}

package/src/types.ts

@@ -20,3 +20,14 @@ export interface SchemaFragment {
   formatMaximum?: string
   readOnly?: boolean
 }
+
+export interface ComponentInfo {
+  name: string
+  composite?: boolean
+  shouldDebounce?: boolean
+  emitsBlur?: boolean
+  focusable?: boolean
+  itemsBased?: boolean
+  multipleCompat?: boolean
+  schema?: any
+}

package/src/validate.js

@@ -0,0 +1,42 @@
+import ajvModule from 'ajv/dist/2019.js'
+import addFormats from 'ajv-formats'
+import ajvErrors from 'ajv-errors'
+import layoutKeyword from './layout-keyword/schema.js'
+import normalizedLayout from './normalized-layout/schema.js'
+import { getComponentSchema } from './components/index.js'
+
+// fix some broken typing of ajv
+// @ts-ignore
+const Ajv = /** @type {typeof ajvModule.default} */ (ajvModule)
+
+export const ajv = new Ajv({
+  code: {
+    source: true,
+    esm: true
+    // optimize: true
+  },
+  discriminator: true,
+  allowMatchingProperties: true,
+  allowUnionTypes: true,
+  allErrors: true
+})
+
+addFormats.default(ajv)
+ajvErrors.default(ajv)
+
+ajv.addSchema(layoutKeyword)
+ajv.addSchema(normalizedLayout)
+
+/** @type {Record<string, import('ajv').ValidateFunction>} */
+const componentsValidateCache = {}
+
+/**
+ * @param {import('./types.js').ComponentInfo} component
+ * @returns {import('ajv').ValidateFunction}
+ */
+export function getComponentValidate (component) {
+  if (componentsValidateCache[component.name]) return componentsValidateCache[component.name]
+  const schema = getComponentSchema(component)
+  componentsValidateCache[component.name] = ajv.compile(schema)
+  return componentsValidateCache[component.name]
+}

package/types/components/compile-types.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @param {string} from
+ * @returns {string}
+ */
+export function getComponentTypesCodeImport(from: string): string;
+/**
+ * @param {any} schema
+ * @param {string} key
+ * @param {boolean} standalone
+ * @returns {Promise<string>}
+ */
+export function getComponentTypesCode(schema: any, key: string, standalone?: boolean): Promise<string>;
+//# sourceMappingURL=compile-types.d.ts.map

package/types/components/compile-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compile-types.d.ts","sourceRoot":"","sources":["../../src/components/compile-types.js"],"names":[],"mappings":"AA6BA;;;GAGG;AACH,kDAHW,MAAM,GACJ,MAAM,CAclB;AAED;;;;;GAKG;AACH,8CALW,GAAG,OACH,MAAM,eACN,OAAO,GACL,QAAQ,MAAM,CAAC,CAS3B"}

package/types/components/index.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @param {import('../types.js').ComponentInfo} component
+ * @returns {any}
+ */
+export function getComponentSchema(component: import('../types.js').ComponentInfo): any;
+/**
+ * @typedef {import('./types.js').Section} Section
+ * @typedef {import('./types.js').Select} Select
+ * @typedef {import('./types.js').Autocomplete} Autocomplete
+ * @typedef {import('./types.js').TextField} TextField
+ * @typedef {import('./types.js').Textarea} Textarea
+ * @typedef {import('./types.js').NumberField} NumberField
+ * @typedef {import('./types.js').Slider} Slider
+ * @typedef {import('./types.js').Checkbox} Checkbox
+ * @typedef {import('./types.js').Switch} Switch
+ * @typedef {import('./types.js').DatePicker} DatePicker
+ * @typedef {import('./types.js').TimePicker} TimePicker
+ * @typedef {import('./types.js').DateTimePicker} DateTimePicker
+ * @typedef {import('./types.js').ColorPicker} ColorPicker
+ * @typedef {import('./types.js').OneOfSelect} OneOfSelect
+ * @typedef {import('./types.js').Tabs} Tabs
+ * @typedef {import('./types.js').VerticalTabs} VerticalTabs
+ * @typedef {import('./types.js').ExpansionPanels} ExpansionPanels
+ * @typedef {import('./types.js').Stepper} Stepper
+ * @typedef {import('./types.js').List} List
+ * @typedef {import('./types.js').Combobox} Combobox
+ * @typedef {import('./types.js').FileInput} FileInput
+ */
+/** @type {import('../types.js').ComponentInfo[]} */
+export const standardComponents: import('../types.js').ComponentInfo[];
+export type Section = import('./types.js').Section;
+export type Select = import('./types.js').Select;
+export type Autocomplete = import('./types.js').Autocomplete;
+export type TextField = import('./types.js').TextField;
+export type Textarea = import('./types.js').Textarea;
+export type NumberField = import('./types.js').NumberField;
+export type Slider = import('./types.js').Slider;
+export type Checkbox = import('./types.js').Checkbox;
+export type Switch = import('./types.js').Switch;
+export type DatePicker = import('./types.js').DatePicker;
+export type TimePicker = import('./types.js').TimePicker;
+export type DateTimePicker = import('./types.js').DateTimePicker;
+export type ColorPicker = import('./types.js').ColorPicker;
+export type OneOfSelect = import('./types.js').OneOfSelect;
+export type Tabs = import('./types.js').Tabs;
+export type VerticalTabs = import('./types.js').VerticalTabs;
+export type ExpansionPanels = import('./types.js').ExpansionPanels;
+export type Stepper = import('./types.js').Stepper;
+export type List = import('./types.js').List;
+export type Combobox = import('./types.js').Combobox;
+export type FileInput = import('./types.js').FileInput;
+//# sourceMappingURL=index.d.ts.map

package/types/components/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.js"],"names":[],"mappings":"AA+LA;;;GAGG;AACH,8CAHW,OAAO,aAAa,EAAE,aAAa,GACjC,GAAG,CAgCf;AAjOD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,oDAAoD;AACpD,iCADW,OAAO,aAAa,EAAE,aAAa,EAAE,CAqK/C;sBA5LY,OAAO,YAAY,EAAE,OAAO;qBAC5B,OAAO,YAAY,EAAE,MAAM;2BAC3B,OAAO,YAAY,EAAE,YAAY;wBACjC,OAAO,YAAY,EAAE,SAAS;uBAC9B,OAAO,YAAY,EAAE,QAAQ;0BAC7B,OAAO,YAAY,EAAE,WAAW;qBAChC,OAAO,YAAY,EAAE,MAAM;uBAC3B,OAAO,YAAY,EAAE,QAAQ;qBAC7B,OAAO,YAAY,EAAE,MAAM;yBAC3B,OAAO,YAAY,EAAE,UAAU;yBAC/B,OAAO,YAAY,EAAE,UAAU;6BAC/B,OAAO,YAAY,EAAE,cAAc;0BACnC,OAAO,YAAY,EAAE,WAAW;0BAChC,OAAO,YAAY,EAAE,WAAW;mBAChC,OAAO,YAAY,EAAE,IAAI;2BACzB,OAAO,YAAY,EAAE,YAAY;8BACjC,OAAO,YAAY,EAAE,eAAe;sBACpC,OAAO,YAAY,EAAE,OAAO;mBAC5B,OAAO,YAAY,EAAE,IAAI;uBACzB,OAAO,YAAY,EAAE,QAAQ;wBAC7B,OAAO,YAAY,EAAE,SAAS"}