@json-layout/vocabulary 1.4.2 → 1.5.1

package/package.json

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

@@ -4,4 +4,5 @@
 export * from './layout-keyword/index.js'
 export * from './normalized-layout/index.js'
 export * from './components/index.js'
-export { normalizeLayoutFragment, getSchemaFragmentType } from './normalize.js'
+export { normalizeLayoutFragment, getSchemaFragmentType, mergeNullableSubSchema } from './normalize.js'
+export * from './utils/clone.js'

package/src/normalize.js

@@ -1,6 +1,7 @@
 import { validateLayoutKeyword, isComponentName, isPartialCompObject, isPartialChildren, isPartialSwitch, isPartialGetItemsExpr, isPartialGetItemsObj, isPartialSlotMarkdown, isPartialGetItemsFetch, isPartialChildComposite, isPartialChildSlot, isPartialSlotText, isPartialSlotName } from './layout-keyword/index.js'
 import { validateNormalizedLayout } from './normalized-layout/index.js'
 import { getComponentValidate } from './validate.js'
+import clone from './utils/clone.js'
 
 /**
  * @typedef {import('./index.js').Child} Child
@@ -291,6 +292,39 @@ function getItemsFromSchema (schemaFragment) {
   return null
 }
 
+/**
+ * @param {SchemaFragment} schemaFragment
+ * @returns {[SchemaFragment, string] | undefined}
+ */
+export const mergeNullableSubSchema = (schemaFragment) => {
+  /** @type {null | 'oneOf' | 'anyOf'} */
+  let subTypesKey = null
+  if (schemaFragment.oneOf) subTypesKey = 'oneOf'
+  else if (schemaFragment.anyOf) subTypesKey = 'anyOf'
+  if (subTypesKey) {
+    const subTypes = schemaFragment[subTypesKey]
+    /* if (subTypes && subTypes.length === 1) {
+      const subType = subTypes[0]
+      for (const key of Object.keys(schemaFragment)) delete subType[key]
+      Object.assign(schemaFragment, subType)
+      delete schemaFragment[subTypesKey]
+    } */
+    if (subTypes && subTypes.length === 2 && subTypes.some(t => t.type === 'null')) {
+      const subTypeIndex = subTypes.findIndex(t => t.type !== 'null')
+      if (subTypeIndex !== -1) {
+        const subType = subTypes[subTypeIndex]
+        const nullableType = clone(schemaFragment)
+        for (const key in subType) {
+          if (!(key in nullableType)) nullableType[key] = subType[key]
+        }
+        delete nullableType[subTypesKey]
+        nullableType.__pointer = nullableType.__pointer + `/${subTypesKey}/${subTypeIndex}`
+        return nullableType
+      }
+    }
+  }
+}
+
 /**
  * @param {SchemaFragment} schemaFragment
  * @returns {{type: string | undefined, nullable: boolean}}
@@ -306,7 +340,6 @@ export const getSchemaFragmentType = (schemaFragment) => {
   }
 
   // case where type is not defined but can be deduced from children oneOf/allOf/anyOf
-  /** @type {any[]} */
   if (!schemaFragment.type) {
     /** @type {string[]} */
     const combinationTypes = []
@@ -323,6 +356,10 @@ export const getSchemaFragmentType = (schemaFragment) => {
     if (combinationTypes.length === 1) return { type: combinationTypes[0], nullable: false }
   }
 
+  if (Array.isArray(schemaFragment.type)) {
+    throw new Error('multiple types are not supported')
+  }
+
   return { type: schemaFragment.type, nullable: false }
 }
 
@@ -661,6 +698,7 @@ function normalizeValidLayoutFragment (key, schemaFragment, type, nullable, sche
  */
 export function normalizeLayoutFragment (key, schemaFragment, schemaPath, components, markdown = (src) => src, useDescription, optionsKeys, schemaChild, knownType, knownNullable) {
   const { type, nullable } = knownType ? { type: knownType, nullable: knownNullable ?? false } : getSchemaFragmentType(schemaFragment)
+
   /** @type {string[]} */
   const errors = []
   try {

package/src/types.ts

@@ -5,7 +5,7 @@ export interface SchemaFragment {
   layout?: LayoutKeyword
   oneOfLayout?: LayoutKeyword
   patternPropertiesLayout?: LayoutKeyword
-  type: string
+  type?: string | string[]
   format?: string
   title?: string
   description?: string

package/src/utils/clone.js

@@ -0,0 +1,67 @@
+/* eslint-disable jsdoc/require-jsdoc */
+// @ts-nocheck
+
+// a copy of https://github.com/davidmarkclements/rfdc/blob/master/index.js
+// but lighter and with ESM export
+
+function copyBuffer (cur) {
+  if (cur instanceof Buffer) {
+    return Buffer.from(cur)
+  }
+
+  return new cur.constructor(cur.buffer.slice(), cur.byteOffset, cur.length)
+}
+
+function rfdc () {
+  return clone
+
+  function cloneArray (a, fn) {
+    const keys = Object.keys(a)
+    const a2 = new Array(keys.length)
+    for (let i = 0; i < keys.length; i++) {
+      const k = keys[i]
+      const cur = a[k]
+      if (typeof cur !== 'object' || cur === null) {
+        a2[k] = cur
+      } else if (cur instanceof Date) {
+        a2[k] = new Date(cur)
+      } else if (ArrayBuffer.isView(cur)) {
+        a2[k] = copyBuffer(cur)
+      } else {
+        a2[k] = fn(cur)
+      }
+    }
+    return a2
+  }
+
+  function clone (o) {
+    if (typeof o !== 'object' || o === null) return o
+    if (o instanceof Date) return new Date(o)
+    if (Array.isArray(o)) return cloneArray(o, clone)
+    if (o instanceof Map) return new Map(cloneArray(Array.from(o), clone))
+    if (o instanceof Set) return new Set(cloneArray(Array.from(o), clone))
+    const o2 = {}
+    for (const k in o) {
+      if (Object.hasOwnProperty.call(o, k) === false) continue
+      const cur = o[k]
+      if (typeof cur !== 'object' || cur === null) {
+        o2[k] = cur
+      } else if (cur instanceof Date) {
+        o2[k] = new Date(cur)
+      } else if (cur instanceof Map) {
+        o2[k] = new Map(cloneArray(Array.from(cur), clone))
+      } else if (cur instanceof Set) {
+        o2[k] = new Set(cloneArray(Array.from(cur), clone))
+      } else if (ArrayBuffer.isView(cur)) {
+        o2[k] = copyBuffer(cur)
+      } else {
+        o2[k] = clone(cur)
+      }
+    }
+    return o2
+  }
+}
+
+export const clone = rfdc()
+
+export default clone

package/types/index.d.ts

@@ -1,7 +1,8 @@
 export * from "./layout-keyword/index.js";
 export * from "./normalized-layout/index.js";
 export * from "./components/index.js";
+export * from "./utils/clone.js";
 export type SchemaFragment = import("./types.js").SchemaFragment;
 export type ComponentInfo = import("./types.js").ComponentInfo;
-export { normalizeLayoutFragment, getSchemaFragmentType } from "./normalize.js";
+export { normalizeLayoutFragment, getSchemaFragmentType, mergeNullableSubSchema } from "./normalize.js";
 //# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":";;;6BAAc,OAAO,YAAY,EAAE,cAAc;4BACnC,OAAO,YAAY,EAAE,aAAa"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":";;;;6BAAc,OAAO,YAAY,EAAE,cAAc;4BACnC,OAAO,YAAY,EAAE,aAAa"}

package/types/normalize.d.ts

@@ -15,6 +15,7 @@ export function normalizeLayoutFragment(key: string | number, schemaFragment: Sc
     layout: NormalizedLayout;
     errors: string[];
 };
+export function mergeNullableSubSchema(schemaFragment: SchemaFragment): [SchemaFragment, string] | undefined;
 export function getSchemaFragmentType(schemaFragment: SchemaFragment): {
     type: string | undefined;
     nullable: boolean;

package/types/normalize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"normalize.d.ts","sourceRoot":"","sources":["../src/normalize.js"],"names":[],"mappings":"AAwoBA;;;;;;;;;;;;GAYG;AACH,6CAZW,MAAM,GAAG,MAAM,kBACf,cAAc,cACd,MAAM,cACN,MAAM,CAAC,MAAM,EAAE,OAAO,YAAY,EAAE,aAAa,CAAC,aAClD,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,+BACxB,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,gBACnC,MAAM,EAAE,gBACR,OAAO,GAAG,mBAAmB,cAC7B,MAAM,GAAG,SAAS,kBAClB,OAAO,GACL;IAAC,MAAM,EAAE,gBAAgB,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAC,CAuBxD;AAjYM,sDAHI,cAAc,GACZ;IAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAC,CA+BzD;oBAjUY,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":"AA6qBA;;;;;;;;;;;;GAYG;AACH,6CAZW,MAAM,GAAG,MAAM,kBACf,cAAc,cACd,MAAM,cACN,MAAM,CAAC,MAAM,EAAE,OAAO,YAAY,EAAE,aAAa,CAAC,aAClD,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,+BACxB,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,gBACnC,MAAM,EAAE,gBACR,OAAO,GAAG,mBAAmB,cAC7B,MAAM,GAAG,SAAS,kBAClB,OAAO,GACL;IAAC,MAAM,EAAE,gBAAgB,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAC,CAwBxD;AAtaM,uDAHI,cAAc,GACZ,CAAC,cAAc,EAAE,MAAM,CAAC,GAAG,SAAS,CA6BhD;AAMM,sDAHI,cAAc,GACZ;IAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAC,CAkCzD;oBArWY,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

@@ -4,7 +4,7 @@ export interface SchemaFragment {
     layout?: LayoutKeyword;
     oneOfLayout?: LayoutKeyword;
     patternPropertiesLayout?: LayoutKeyword;
-    type: string;
+    type?: string | string[];
     format?: string;
     title?: string;
     description?: 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;AAC9D,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AAEpE,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,aAAa,CAAA;IACtB,WAAW,CAAC,EAAE,aAAa,CAAA;IAC3B,uBAAuB,CAAC,EAAE,aAAa,CAAA;IACvC,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,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACvC,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,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,CAAC,aAAa,EAAE,GAAG,GAAG,aAAa,IAAI,aAAa,CAAA;IACpD,MAAM,EAAE,GAAG,CAAA;CACZ;AAED,MAAM,WAAW,wBAAwB;IACvC,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,gBAAgB,CAAA;IACzC,MAAM,EAAE,GAAG,CAAA;CACZ"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAC9D,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AAEpE,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,aAAa,CAAA;IACtB,WAAW,CAAC,EAAE,aAAa,CAAA;IAC3B,uBAAuB,CAAC,EAAE,aAAa,CAAA;IACvC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,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,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACvC,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,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,CAAC,aAAa,EAAE,GAAG,GAAG,aAAa,IAAI,aAAa,CAAA;IACpD,MAAM,EAAE,GAAG,CAAA;CACZ;AAED,MAAM,WAAW,wBAAwB;IACvC,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,gBAAgB,CAAA;IACzC,MAAM,EAAE,GAAG,CAAA;CACZ"}

package/types/utils/clone.d.ts

@@ -0,0 +1,3 @@
+export function clone(o: any): any;
+export default clone;
+//# sourceMappingURL=clone.d.ts.map

package/types/utils/clone.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clone.d.ts","sourceRoot":"","sources":["../../src/utils/clone.js"],"names":[],"mappings":"AAoCE,mCAyBC"}