@json-layout/vocabulary 0.17.0 → 0.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@json-layout/vocabulary",
-  "version": "0.17.0",
+  "version": "0.18.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/normalize.js

@@ -16,25 +16,41 @@ import { getComponentValidate } from './validate.js'
 
 /**
  * @param {import('./types.js').SchemaFragment} schemaFragment
+ * @param {string} type
  * @returns {Children}
  */
-function getDefaultChildren (schemaFragment) {
-  const { type } = getSchemaFragmentType(schemaFragment)
+function getDefaultChildren (schemaFragment, type) {
   /** @type {Children} */
   const children = []
   if (type === 'object') {
-    if (schemaFragment.properties) {
-      for (const key of Object.keys(schemaFragment.properties)) {
-        children.push({ key })
+    for (const key of Object.keys(schemaFragment)) {
+      if (key === 'properties') {
+        for (const key of Object.keys(schemaFragment.properties ?? {})) {
+          children.push({ key })
+          if (schemaFragment.dependencies?.[key] && !Array.isArray(schemaFragment.dependencies[key])) {
+            children.push({ key: `$deps-${key}` })
+          }
+          if (schemaFragment.dependentSchemas && schemaFragment.dependentSchemas[key]) {
+            children.push({ key: `$deps-${key}` })
+          }
+        }
       }
-    }
-    if (schemaFragment.allOf?.length) {
-      for (let i = 0; i < schemaFragment.allOf.length; i++) {
-        children.push({ key: `$allOf-${i}` })
+      if (key === 'allOf') {
+        if (schemaFragment.allOf?.length) {
+          for (let i = 0; i < schemaFragment.allOf.length; i++) {
+            children.push({ key: `$allOf-${i}` })
+          }
+        }
+      }
+      if (key === 'oneOf') {
+        children.push({ key: '$oneOf' })
+      }
+      if (key === 'then' && schemaFragment.if) {
+        children.push({ key: '$then' })
+      }
+      if (key === 'else' && schemaFragment.if) {
+        children.push({ key: '$else' })
       }
-    }
-    if (schemaFragment.oneOf) {
-      children.push({ key: '$oneOf' })
     }
   }
   if (type === 'array' && Array.isArray(schemaFragment.items)) {
@@ -84,11 +100,11 @@ function getChildren (defaultChildren, partialChildren) {
 /**
  * @param {PartialCompObject} partial
  * @param {SchemaFragment} schemaFragment
+ * @param {string | undefined} type
  * @param {'oneOf'} [arrayChild]
  * @returns {import('./index.js').ComponentName}
  */
-function getDefaultComp (partial, schemaFragment, arrayChild) {
-  const { type } = getSchemaFragmentType(schemaFragment)
+function getDefaultComp (partial, schemaFragment, type, arrayChild) {
   const hasSimpleType = type && ['string', 'integer', 'number'].includes(type)
   if (arrayChild === 'oneOf') return 'one-of-select'
   if (hasSimpleType && schemaFragment.enum) return schemaFragment.enum.length > 20 ? 'autocomplete' : 'select'
@@ -232,6 +248,8 @@ export const getSchemaFragmentType = (schemaFragment) => {
 /**
  * @param {LayoutKeyword} layoutKeyword
  * @param {SchemaFragment} schemaFragment
+ * @param {string | undefined} type
+ * @param {boolean} nullable
  * @param {string} schemaPath
  * @param {Record<string, import('./types.js').ComponentInfo>} components
  * @param {(text: string) => string} markdown
@@ -239,11 +257,9 @@ export const getSchemaFragmentType = (schemaFragment) => {
  * @param {'oneOf'} [arrayChild]
  * @returns {BaseCompObject}
  */
-function getCompObject (layoutKeyword, schemaFragment, schemaPath, components, markdown, optionsKeys, arrayChild) {
+function getCompObject (layoutKeyword, schemaFragment, type, nullable, schemaPath, components, markdown, optionsKeys, arrayChild) {
   const key = schemaPath.slice(schemaPath.lastIndexOf('/') + 1)
 
-  const { type, nullable } = getSchemaFragmentType(schemaFragment)
-
   if ('const' in schemaFragment) return { comp: 'none' }
   if (!type) return { comp: 'none' }
 
@@ -255,7 +271,7 @@ function getCompObject (layoutKeyword, schemaFragment, schemaPath, components, m
 
   // chose the default component for a schema fragment
   if (!partial.comp) {
-    partial.comp = getDefaultComp(partial, schemaFragment, arrayChild)
+    partial.comp = getDefaultComp(partial, schemaFragment, type, arrayChild)
   }
   const component = components[partial.comp]
   if (!component) {
@@ -267,7 +283,7 @@ function getCompObject (layoutKeyword, schemaFragment, schemaPath, components, m
 
   if (component.composite) {
     if (!('title' in partial)) partial.title = schemaFragment.title ?? null
-    partial.children = getChildren(getDefaultChildren(schemaFragment), partial.children)
+    partial.children = getChildren(getDefaultChildren(schemaFragment, type), partial.children)
   } else if (partial.comp === 'list') {
     if (!('title' in partial)) partial.title = schemaFragment.title ?? key
     partial.listEditMode = partial.listEditMode ?? (schemaFragment.items.type === 'object' ? 'inline-single' : 'inline')
@@ -414,6 +430,8 @@ function getCompObject (layoutKeyword, schemaFragment, schemaPath, components, m
 /**
  * @param {LayoutKeyword} layoutKeyword
  * @param {SchemaFragment} schemaFragment
+ * @param {string | undefined} type
+ * @param {boolean} nullable
  * @param {string} schemaPath
  * @param {Record<string, import('./types.js').ComponentInfo>} components
  * @param {(text: string) => string} markdown
@@ -421,7 +439,7 @@ function getCompObject (layoutKeyword, schemaFragment, schemaPath, components, m
  * @param {'oneOf'} [arrayChild]
  * @returns {NormalizedLayout}}
  */
-function getNormalizedLayout (layoutKeyword, schemaFragment, schemaPath, components, markdown, optionsKeys, arrayChild) {
+function getNormalizedLayout (layoutKeyword, schemaFragment, type, nullable, schemaPath, components, markdown, optionsKeys, arrayChild) {
   if (isPartialSwitch(layoutKeyword)) {
     /** @type {BaseCompObject[]} */
     const normalizedSwitchCases = []
@@ -431,12 +449,12 @@ function getNormalizedLayout (layoutKeyword, schemaFragment, schemaPath, compone
     }
     for (let i = 0; i < switchCases.length; i++) {
       const switchCase = switchCases[i]
-      const compObjectResult = getCompObject(switchCase, schemaFragment, schemaPath, components, markdown, optionsKeys, arrayChild)
+      const compObjectResult = getCompObject(switchCase, schemaFragment, type, nullable, schemaPath, components, markdown, optionsKeys, arrayChild)
       normalizedSwitchCases.push(compObjectResult)
     }
     return { switch: normalizedSwitchCases }
   } else {
-    return getCompObject(layoutKeyword, schemaFragment, schemaPath, components, markdown, optionsKeys, arrayChild)
+    return getCompObject(layoutKeyword, schemaFragment, type, nullable, schemaPath, components, markdown, optionsKeys, arrayChild)
   }
 }
 
@@ -479,6 +497,8 @@ const defaultOptionsKeys = ['readOnly', 'summary', 'titleDepth', 'density', 'rem
 
 /**
  * @param {SchemaFragment} schemaFragment
+ * @param {string | undefined} type
+ * @param {boolean} nullable
  * @param {string} schemaPath
  * @param {Record<string, import('./types.js').ComponentInfo>} components
  * @param {(text: string) => string} markdown
@@ -486,7 +506,7 @@ const defaultOptionsKeys = ['readOnly', 'summary', 'titleDepth', 'density', 'rem
  * @param {'oneOf'} [arrayChild]
  * @returns {NormalizedLayout}
  */
-function normalizeValidLayoutFragment (schemaFragment, schemaPath, components, markdown, optionsKeys, arrayChild) {
+function normalizeValidLayoutFragment (schemaFragment, type, nullable, schemaPath, components, markdown, optionsKeys, arrayChild) {
   optionsKeys = optionsKeys ? optionsKeys.concat(defaultOptionsKeys) : defaultOptionsKeys
   let layoutKeyword
   if (arrayChild === 'oneOf') {
@@ -499,7 +519,7 @@ function normalizeValidLayoutFragment (schemaFragment, schemaPath, components, m
     error.cause = lighterValidationErrors(validateLayoutKeyword.errors)
     throw error
   }
-  const normalizedLayout = getNormalizedLayout(layoutKeyword, schemaFragment, schemaPath, components, markdown, optionsKeys, arrayChild)
+  const normalizedLayout = getNormalizedLayout(layoutKeyword, schemaFragment, type, nullable, schemaPath, components, markdown, optionsKeys, arrayChild)
 
   if (!validateNormalizedLayout(normalizedLayout)) {
     const error = new Error('normalized layout validation errors at path')
@@ -516,20 +536,23 @@ function normalizeValidLayoutFragment (schemaFragment, schemaPath, components, m
  * @param {(text: string) => string} markdown
  * @param {string[]} [optionsKeys]
  * @param {'oneOf'} [arrayChild]
+ * @param {string | undefined} [knownType]
+ * @param {boolean} [knownNullable]
  * @returns {{layout: NormalizedLayout, errors: string[]}}
  */
-export function normalizeLayoutFragment (schemaFragment, schemaPath, components, markdown = (src) => src, optionsKeys, arrayChild) {
+export function normalizeLayoutFragment (schemaFragment, schemaPath, components, markdown = (src) => src, optionsKeys, arrayChild, knownType, knownNullable) {
+  const { type, nullable } = knownType ? { type: knownType, nullable: knownNullable ?? false } : getSchemaFragmentType(schemaFragment)
   /** @type {string[]} */
   const errors = []
   try {
-    const layout = normalizeValidLayoutFragment(schemaFragment, schemaPath, components, markdown, optionsKeys, arrayChild)
+    const layout = normalizeValidLayoutFragment(schemaFragment, type, nullable, schemaPath, components, markdown, optionsKeys, arrayChild)
     return { layout, errors }
   } catch (/** @type {any} */err) {
     try {
       errors.push(err.message)
       if (err.cause && Array.isArray(err.cause)) errors.push(...err.cause)
       errors.push('failed to normalize layout, use default component')
-      const layout = normalizeValidLayoutFragment({ ...schemaFragment, layout: {} }, schemaPath, components, markdown, optionsKeys, arrayChild)
+      const layout = normalizeValidLayoutFragment({ ...schemaFragment, layout: {} }, type, nullable, schemaPath, components, markdown, optionsKeys, arrayChild)
       return { layout, errors }
     } catch (/** @type {any} */err) {
       errors.push(err.message)

package/src/types.ts

@@ -19,6 +19,11 @@ export interface SchemaFragment {
   formatMinimum?: string
   formatMaximum?: string
   readOnly?: boolean
+  if?: any
+  then?: any
+  else?: any
+  dependencies?: Record<string, any>
+  dependentSchemas?: Record<string, any>
 }
 
 export interface ComponentInfo {

package/types/normalize.d.ts

@@ -5,9 +5,11 @@
  * @param {(text: string) => string} markdown
  * @param {string[]} [optionsKeys]
  * @param {'oneOf'} [arrayChild]
+ * @param {string | undefined} [knownType]
+ * @param {boolean} [knownNullable]
  * @returns {{layout: NormalizedLayout, errors: string[]}}
  */
-export function normalizeLayoutFragment(schemaFragment: SchemaFragment, schemaPath: string, components: Record<string, import('./types.js').ComponentInfo>, markdown?: (text: string) => string, optionsKeys?: string[] | undefined, arrayChild?: "oneOf" | undefined): {
+export function normalizeLayoutFragment(schemaFragment: SchemaFragment, schemaPath: string, components: Record<string, import('./types.js').ComponentInfo>, markdown?: (text: string) => string, optionsKeys?: string[] | undefined, arrayChild?: "oneOf" | undefined, knownType?: string | undefined, knownNullable?: boolean | undefined): {
     layout: NormalizedLayout;
     errors: string[];
 };

package/types/normalize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"normalize.d.ts","sourceRoot":"","sources":["../src/normalize.js"],"names":[],"mappings":"AA+fA;;;;;;;;GAQG;AACH,wDARW,cAAc,cACd,MAAM,cACN,OAAO,MAAM,EAAE,OAAO,YAAY,EAAE,aAAa,CAAC,oBAC3C,MAAM,KAAK,MAAM;YAGb,gBAAgB;YAAU,MAAM,EAAE;EAsBvD;AApVM,sDAHI,cAAc,GACZ;IAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAC,CA+BzD;oBAhOY,OAAO,YAAY,EAAE,KAAK;uBAC1B,OAAO,YAAY,EAAE,QAAQ;6BAC7B,OAAO,YAAY,EAAE,cAAc;yBACnC,OAAO,YAAY,EAAE,UAAU;+BAC/B,OAAO,YAAY,EAAE,gBAAgB;4BACrC,OAAO,YAAY,EAAE,aAAa;8BAClC,OAAO,YAAY,EAAE,eAAe;gCACpC,OAAO,YAAY,EAAE,iBAAiB;6BACtC,OAAO,YAAY,EAAE,cAAc"}
+{"version":3,"file":"normalize.d.ts","sourceRoot":"","sources":["../src/normalize.js"],"names":[],"mappings":"AAmhBA;;;;;;;;;;GAUG;AACH,wDAVW,cAAc,cACd,MAAM,cACN,OAAO,MAAM,EAAE,OAAO,YAAY,EAAE,aAAa,CAAC,oBAC3C,MAAM,KAAK,MAAM,oFAGxB,MAAM,GAAG,SAAS;YAEP,gBAAgB;YAAU,MAAM,EAAE;EAuBvD;AA3VM,sDAHI,cAAc,GACZ;IAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAC,CA+BzD;oBAhPY,OAAO,YAAY,EAAE,KAAK;uBAC1B,OAAO,YAAY,EAAE,QAAQ;6BAC7B,OAAO,YAAY,EAAE,cAAc;yBACnC,OAAO,YAAY,EAAE,UAAU;+BAC/B,OAAO,YAAY,EAAE,gBAAgB;4BACrC,OAAO,YAAY,EAAE,aAAa;8BAClC,OAAO,YAAY,EAAE,eAAe;gCACpC,OAAO,YAAY,EAAE,iBAAiB;6BACtC,OAAO,YAAY,EAAE,cAAc"}

package/types/types.d.ts

@@ -18,6 +18,11 @@ export interface SchemaFragment {
     formatMinimum?: string;
     formatMaximum?: string;
     readOnly?: boolean;
+    if?: any;
+    then?: any;
+    else?: any;
+    dependencies?: Record<string, any>;
+    dependentSchemas?: Record<string, any>;
 }
 export interface ComponentInfo {
     name: string;

package/types/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAE9D,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,aAAa,CAAA;IACtB,WAAW,CAAC,EAAE,aAAa,CAAA;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAChC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAA;IACb,KAAK,CAAC,EAAE,GAAG,EAAE,CAAA;IACb,KAAK,CAAC,EAAE,GAAG,EAAE,CAAA;IACb,KAAK,CAAC,EAAE,GAAG,CAAA;IACX,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;IACZ,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,MAAM,CAAC,EAAE,GAAG,CAAA;IACZ,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAE9D,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,aAAa,CAAA;IACtB,WAAW,CAAC,EAAE,aAAa,CAAA;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAChC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAA;IACb,KAAK,CAAC,EAAE,GAAG,EAAE,CAAA;IACb,KAAK,CAAC,EAAE,GAAG,EAAE,CAAA;IACb,KAAK,CAAC,EAAE,GAAG,CAAA;IACX,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;IACZ,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,EAAE,CAAC,EAAE,GAAG,CAAA;IACR,IAAI,CAAC,EAAE,GAAG,CAAA;IACV,IAAI,CAAC,EAAE,GAAG,CAAA;IACV,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAClC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACvC;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,MAAM,CAAC,EAAE,GAAG,CAAA;IACZ,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB"}