shinkansen-transmission 2.2.234 → 2.3.0

package/src/transmission/from-hash-to-document/number/index.mjs

@@ -1,3 +1,10 @@
+/**
+ *  @typedef {TransmissionTypes.HashType} HashType
+ *  @typedef {TransmissionTypes.SchemaType} SchemaType
+ *  @typedef {TransmissionTypes.ParamsType} ParamsType
+ *  @typedef {TransmissionTypes.DocumentType} DocumentType
+ */
+
 import debug from 'debug'
 
 import {
@@ -12,18 +19,28 @@ const log = debug('shinkansen-transmission/from-hash-to-document/number')
 
 log('`shinkansen` is awake')
 
-export default function transformNumberSchema (values = {}, schema = {}, params = {}) {
+/**
+ * Hash can be `undefined`
+ *
+ *  @param {HashType} [hash]
+ *  @param {SchemaType} [schema]
+ *  @param {ParamsType} [params]
+ *  @returns {DocumentType | undefined}
+ */
+export default function transformNumberSchema (hash = {}, schema = {}, params = {}) {
   log('transformNumberSchema')
 
-  const { type } = schema
+  const {
+    type
+  } = schema
 
   // https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.4.2.1
   if (type === 'number') {
     const {
-      uri: parentUri
+      uri: parentUri = '#'
     } = params
 
-    return transformNumber(values, schema, parentUri, getUri(parentUri))
+    return transformNumber(hash, schema, parentUri, getUri(parentUri))
   }
 
   throw new Error('Schema does not conform to Instance Data Model, https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.4.2.1')

package/src/transmission/from-hash-to-document/object/index.mjs

@@ -1,3 +1,10 @@
+/**
+ *  @typedef {TransmissionTypes.HashType} HashType
+ *  @typedef {TransmissionTypes.SchemaType} SchemaType
+ *  @typedef {TransmissionTypes.ParamsType} ParamsType
+ *  @typedef {TransmissionTypes.DocumentType} DocumentType
+ */
+
 import debug from 'debug'
 
 import {
@@ -12,19 +19,29 @@ const log = debug('shinkansen-transmission/from-hash-to-document/object')
 
 log('`shinkansen` is awake')
 
-export default function transformObjectSchema (values = {}, schema = {}, params = {}) {
+/**
+ * Hash can be `undefined`
+ *
+ *  @param {HashType} [hash]
+ *  @param {SchemaType} [schema]
+ *  @param {ParamsType} [params]
+ *  @returns {DocumentType | undefined}
+ */
+export default function transformObjectSchema (hash = {}, schema = {}, params = {}) {
   log('transformObjectSchema')
 
-  const { type } = schema
+  const {
+    type
+  } = schema
 
   // https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.4.2.1
   if (type === 'object') {
     const {
-      uri: parentUri,
-      key: fieldKey
+      uri: parentUri = '#',
+      key: fieldKey // string | undefined
     } = params
 
-    return transformObject(values, schema, parentUri, getUri(parentUri, fieldKey))
+    return transformObject(hash, schema, parentUri, getUri(parentUri, fieldKey))
   }
 
   throw new Error('Schema does not conform to Instance Data Model, https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.4.2.1')

package/src/transmission/from-hash-to-document/string/index.mjs

@@ -1,3 +1,15 @@
+/**
+ *  @typedef {TransmissionTypes.ObjectType} ObjectType
+ *  @typedef {TransmissionTypes.ArrayType} ArrayType
+ *
+ *  @typedef {TransmissionTypes.ItemsType} ItemsType
+ *
+ *  @typedef {TransmissionTypes.HashType} HashType
+ *  @typedef {TransmissionTypes.SchemaType} SchemaType
+ *  @typedef {TransmissionTypes.ParamsType} ParamsType
+ *  @typedef {TransmissionTypes.DocumentType} DocumentType
+ */
+
 import debug from 'debug'
 
 import {
@@ -12,18 +24,28 @@ const log = debug('shinkansen-transmission/from-hash-to-document/string')
 
 log('`shinkansen` is awake')
 
-export default function transformStringSchema (values = {}, schema = {}, params = {}) {
+/**
+ * Hash can be `undefined`
+ *
+ *  @param {HashType} [hash]
+ *  @param {SchemaType} [schema]
+ *  @param {ParamsType} [params]
+ *  @returns {DocumentType | undefined}
+ */
+export default function transformStringSchema (hash = {}, schema = {}, params = {}) {
   log('transformStringSchema')
 
-  const { type } = schema
+  const {
+    type
+  } = schema
 
   // https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.4.2.1
   if (type === 'string') {
     const {
-      uri: parentUri
+      uri: parentUri = '#'
     } = params
 
-    return transformString(values, schema, parentUri, getUri(parentUri))
+    return transformString(hash, schema, parentUri, getUri(parentUri))
   }
 
   throw new Error('Schema does not conform to Instance Data Model, https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.4.2.1')

package/src/transmission/index.d.mts

@@ -1,10 +1,4 @@
-declare module '#transmission/transmission' {
-  export * as common from '#transmission/transmission/common'
-  export { default as fromDocumentToHash } from '#transmission/transmission/from-document-to-hash'
-  export { default as fromHashToDocument } from '#transmission/transmission/from-hash-to-document'
-  export { default as toZashiki } from '#transmission/transmission/to-zashiki'
-}
-
-declare module 'shinkansen-transmission/transmission' {
-  export * from '#transmission/transmission'
-}
+export * as common from '#transmission/transmission/common'
+export { default as fromDocumentToHash } from '#transmission/transmission/from-document-to-hash'
+export { default as fromHashToDocument } from '#transmission/transmission/from-hash-to-document'
+export { default as toZashiki } from '#transmission/transmission/to-zashiki'

package/src/transmission/to-zashiki/index.d.mts

@@ -1,15 +1,7 @@
-declare module '#transmission/transmission/to-zashiki' {
-  type SchemaType = ZashikiTypes.SchemaType
+export type SchemaType = TransmissionTypes.SchemaType
+export type ValuesType = TransmissionTypes.ValuesType
+export type ParamsType = TransmissionTypes.ParamsType
 
-  type ObjectLiteralType = ZashikiTypes.ObjectLiteralType
-  type ObjectType = ZashikiTypes.ObjectType
+export type ZashikiType = TransmissionTypes.Zashiki.ZashikiType
 
-  type ZashikiType = ZashikiTypes.ZashikiType
-
-  export default function toZashiki (rootSchema: SchemaType | undefined, values: ObjectType | ObjectLiteralType | undefined, params: ObjectType | ObjectLiteralType | undefined): ZashikiType | undefined
-}
-
-declare module 'shinkansen-transmission/transmission/to-zashiki' {
-  export { default } from '#transmission/transmission/to-zashiki'
-  export * from '#transmission/transmission/to-zashiki'
-}
+export default function toZashiki (rootSchema?: SchemaType, values?: ValuesType, params?: ParamsType): ZashikiType

package/src/transmission/to-zashiki/params/index.mjs

@@ -0,0 +1,430 @@
+/**
+ *  @typedef {TransmissionTypes.ObjectLiteralType} ObjectLiteralType
+ *  @typedef {TransmissionTypes.ObjectType} ObjectType
+ *
+ *  @typedef {TransmissionTypes.EnumType} EnumType
+ *  @typedef {TransmissionTypes.AnyOfType} AnyOfType
+ *  @typedef {TransmissionTypes.OneOfType} OneOfType
+ *  @typedef {TransmissionTypes.FieldType} FieldType
+ *
+ *  @typedef {TransmissionTypes.SchemaType} SchemaType
+ *  @typedef {TransmissionTypes.ValuesType} ValuesType
+ *  @typedef {TransmissionTypes.ParamsType} ParamsType
+ *
+ *  @typedef {TransmissionTypes.Zashiki.ZashikiType} ZashikiType
+ *
+ *  @typedef {TransmissionTypes.Zashiki.StringMetaType} ZashikiStringMetaType
+ *  @typedef {TransmissionTypes.Zashiki.NumberMetaType} ZashikiNumberMetaType
+ *  @typedef {TransmissionTypes.Zashiki.ArrayMetaType} ZashikiArrayMetaType
+ *  @typedef {TransmissionTypes.Zashiki.ObjectMetaType} ZashikiObjectMetaType
+ *  @typedef {TransmissionTypes.Zashiki.BooleanMetaType} ZashikiBooleanMetaType
+ *  @typedef {TransmissionTypes.Zashiki.NullMetaType} ZashikiNullMetaType
+ *
+ *  @typedef {TransmissionTypes.Zashiki.StringElementsType} ZashikiStringElementsType
+ *  @typedef {TransmissionTypes.Zashiki.NumberElementsType} ZashikiNumberElementsType
+ *  @typedef {TransmissionTypes.Zashiki.ArrayElementsType} ZashikiArrayElementsType
+ *  @typedef {TransmissionTypes.Zashiki.ObjectElementsType} ZashikiObjectElementsType
+ *  @typedef {TransmissionTypes.Zashiki.BooleanElementsType} ZashikiBooleanElementsType
+ *  @typedef {TransmissionTypes.Zashiki.NullElementsType} ZashikiNullElementsType
+ */
+
+import debug from 'debug'
+
+import {
+  getSelectedItems,
+  normaliseUri,
+  getUri,
+  getMetaProps,
+  getElementsFieldPropsForEnum,
+  getElementsFieldPropsForAnyOf,
+  getElementsFieldPropsForOneOf,
+  getElementsFieldPropsForAllOf,
+  getElementsProps
+} from '#transmission/transmission/common'
+
+const log = debug('shinkansen-transmission/to-zashiki/params')
+
+log('`shinkansen` is awake')
+
+/**
+ *  @param {SchemaType} schema
+ *  @param {SchemaType} rootSchema
+ *  @param {ValuesType} values
+ *  @param {ParamsType} params
+ *  @returns {ParamsType}
+ */
+export function getParamsByKeyForEnum (schema, rootSchema, values, params) {
+  /**
+   *  log('getParamsByKeyForAnyOf')
+   */
+
+  const {
+    parentUri = '#',
+    key = '',
+    required = []
+  } = params
+
+  const isRequired = key ? required.includes(key) : false
+
+  const uri = getUri(parentUri, key)
+
+  const {
+    selectedItems = getSelectedItems(values, uri) // uri
+  } = getMetaProps(params, uri)
+
+  const meta = Object.assign(getMetaProps(params, uri), {
+    schema,
+    rootSchema,
+    parentUri: normaliseUri(parentUri),
+    uri,
+    selectedItems,
+    isRequired
+  })
+  const elements = {
+    enum: Object.assign(getElementsFieldPropsForEnum(params, uri), {
+      selectedItems,
+      isRequired
+    })
+  }
+
+  return Object.assign(params, {
+    parentUri,
+    uri,
+    key,
+    [uri]: {
+      meta,
+      elements
+    }
+  })
+}
+
+/**
+ *  @param {SchemaType} schema
+ *  @param {SchemaType} rootSchema
+ *  @param {ValuesType} values
+ *  @param {ParamsType} params
+ *  @returns {ParamsType}
+ */
+export function getParamsByKeyForAnyOf (schema, rootSchema, values, params) {
+  /**
+   *  log('getParamsByKeyForAnyOf')
+   */
+
+  const {
+    parentUri = '#',
+    key = '',
+    required = []
+  } = params
+
+  const isRequired = key ? required.includes(key) : false
+
+  const uri = getUri(parentUri, key)
+
+  const {
+    selectedItems = getSelectedItems(values, uri) // uri
+  } = getMetaProps(params, uri)
+
+  const meta = Object.assign(getMetaProps(params, uri), {
+    schema,
+    rootSchema,
+    parentUri: normaliseUri(parentUri),
+    uri,
+    selectedItems,
+    isRequired
+  })
+  const elements = {
+    anyOf: Object.assign(getElementsFieldPropsForAnyOf(params, uri), {
+      selectedItems,
+      isRequired
+    })
+  }
+
+  return Object.assign(params, {
+    parentUri,
+    uri,
+    key,
+    [uri]: {
+      meta,
+      elements
+    }
+  })
+}
+
+/**
+ *  @param {SchemaType} schema
+ *  @param {SchemaType} rootSchema
+ *  @param {ValuesType} values
+ *  @param {ParamsType} params
+ *  @returns {ParamsType}
+ */
+export function getParamsByKeyForOneOf (schema, rootSchema, values, params) {
+  /**
+   *  log('getParamsByKeyForOneOf')
+   */
+
+  const {
+    parentUri = '#',
+    key = '',
+    required = []
+  } = params
+
+  const isRequired = key ? required.includes(key) : false
+
+  const uri = getUri(parentUri, key)
+
+  const {
+    selectedItems = getSelectedItems(values, uri) // uri
+  } = getMetaProps(params, uri)
+
+  const meta = Object.assign(getMetaProps(params, uri), {
+    schema,
+    rootSchema,
+    parentUri: normaliseUri(parentUri),
+    uri,
+    selectedItems,
+    isRequired
+  })
+  const elements = {
+    oneOf: Object.assign(getElementsFieldPropsForOneOf(params, uri), {
+      selectedItems,
+      isRequired
+    })
+  }
+
+  return Object.assign(params, {
+    parentUri,
+    uri,
+    key,
+    [uri]: {
+      meta,
+      elements
+    }
+  })
+}
+
+/**
+ *  @param {SchemaType} schema
+ *  @param {SchemaType} rootSchema
+ *  @param {ValuesType} values
+ *  @param {ParamsType} params
+ *  @returns {ParamsType}
+ */
+export function getParamsByKey (schema, rootSchema, values, params) {
+  /**
+   *  log('getParamsByKey')
+   */
+
+  const {
+    parentUri = '#',
+    key = '',
+    required = []
+  } = params
+
+  const isRequired = key ? required.includes(key) : false
+
+  const uri = getUri(parentUri, key)
+
+  const meta = Object.assign(getMetaProps(params, uri), {
+    schema,
+    rootSchema,
+    parentUri: normaliseUri(parentUri),
+    uri,
+    isRequired
+  })
+  const elements = {
+    field: Object.assign(getElementsFieldPropsForAllOf(params, uri), {
+      isRequired
+    })
+  }
+
+  return Object.assign(params, {
+    parentUri,
+    uri,
+    key,
+    [uri]: {
+      meta,
+      elements
+    }
+  })
+}
+
+/**
+ *  @param {SchemaType} schema
+ *  @param {SchemaType} rootSchema
+ *  @param {ValuesType} values
+ *  @param {ParamsType} params
+ *  @returns {ParamsType}
+ */
+export function getParamsByIndexForEnum (schema, rootSchema, values, params) {
+  /**
+   *  log('getParamsByIndexForEnum')
+   */
+
+  const {
+    parentUri = '#',
+    index = 0
+  } = params
+
+  const uri = getUri(parentUri, index)
+
+  const {
+    selectedItems = getSelectedItems(values, parentUri), // parent uri,
+    ...metaProps
+  } = getMetaProps(params, uri)
+
+  const meta = Object.assign(metaProps, {
+    schema,
+    rootSchema,
+    parentUri: normaliseUri(parentUri),
+    uri,
+    selectedItems
+  })
+  const elements = {
+    enum: Object.assign(getElementsFieldPropsForEnum(params, uri), {
+      selectedItems
+    })
+  }
+
+  return Object.assign(params, {
+    parentUri,
+    uri,
+    index,
+    [uri]: {
+      meta,
+      elements
+    }
+  })
+}
+
+/**
+ *  @param {SchemaType} schema
+ *  @param {SchemaType} rootSchema
+ *  @param {ValuesType} values
+ *  @param {ParamsType} params
+ *  @returns {ParamsType}
+ */
+export function getParamsByIndexForAnyOf (schema, rootSchema, values, params) {
+  /**
+   *  log('getParamsByIndexForAnyOf')
+   */
+
+  const {
+    parentUri = '#',
+    index = 0
+  } = params
+
+  const uri = getUri(parentUri, index)
+
+  const {
+    selectedItems = getSelectedItems(values, parentUri), // parent uri,
+    ...metaProps
+  } = getMetaProps(params, uri)
+
+  const meta = Object.assign(metaProps, {
+    schema,
+    rootSchema,
+    parentUri: normaliseUri(parentUri),
+    uri,
+    selectedItems
+  })
+  const elements = {
+    anyOf: Object.assign(getElementsFieldPropsForAnyOf(params, uri), {
+      selectedItems
+    })
+  }
+
+  return Object.assign(params, {
+    parentUri,
+    uri,
+    index,
+    [uri]: {
+      meta,
+      elements
+    }
+  })
+}
+
+/**
+ *  @param {SchemaType} schema
+ *  @param {SchemaType} rootSchema
+ *  @param {ValuesType} values
+ *  @param {ParamsType} params
+ *  @returns {ParamsType}
+ */
+export function getParamsByIndexForOneOf (schema, rootSchema, values, params) {
+  /**
+   *  log('getParamsByIndexForOneOf')
+   */
+
+  const {
+    parentUri = '#',
+    index = 0
+  } = params
+
+  const uri = getUri(parentUri, index)
+
+  const {
+    selectedItems = getSelectedItems(values, parentUri), // parent uri,
+    ...metaProps
+  } = getMetaProps(params, uri)
+
+  const meta = Object.assign(metaProps, {
+    schema,
+    rootSchema,
+    parentUri: normaliseUri(parentUri),
+    uri,
+    selectedItems
+  })
+  const elements = {
+    oneOf: Object.assign(getElementsFieldPropsForOneOf(params, uri), {
+      selectedItems
+    })
+  }
+
+  return Object.assign(params, {
+    parentUri,
+    uri,
+    index,
+    [uri]: {
+      meta,
+      elements
+    }
+  })
+}
+
+/**
+ *  @param {SchemaType} schema
+ *  @param {SchemaType} rootSchema
+ *  @param {ValuesType} values
+ *  @param {ParamsType} params
+ *  @returns {ParamsType}
+ */
+export function getParamsByIndex (schema, rootSchema, values, params) {
+  /**
+   *  log('getParamsByIndex')
+   */
+
+  const {
+    parentUri = '#',
+    index = 0
+  } = params
+
+  const uri = getUri(parentUri, index)
+
+  const meta = Object.assign(getMetaProps(params, uri), {
+    schema,
+    rootSchema,
+    parentUri: normaliseUri(parentUri),
+    uri
+  })
+
+  return Object.assign(params, {
+    parentUri,
+    uri,
+    index,
+    [uri]: {
+      meta,
+      elements: getElementsProps(params, uri)
+    }
+  })
+}