shinkansen-transmission 2.3.0 → 2.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shinkansen-transmission",
-  "version": "2.3.0",
+  "version": "2.3.2",
   "description": "Shinkansen Transmission",
   "keywords": [
     "Shinkansen",
@@ -44,8 +44,8 @@
     "@babel/eslint-parser": "^7.26.8",
     "@babel/preset-env": "^7.26.9",
     "@babel/register": "^7.25.9",
-    "@sequencemedia/eslint-config-standard": "^0.2.29",
-    "@sequencemedia/eslint-config-typescript": "^0.1.43",
+    "@sequencemedia/eslint-config-standard": "^0.2.31",
+    "@sequencemedia/eslint-config-typescript": "^0.1.46",
     "@types/babel__register": "^7.17.3",
     "@types/chai": "^5.0.1",
     "@types/debug": "^4.1.12",

package/src/index.d.mts

@@ -1,5 +1,4 @@
 export type SchemaType = TransmissionTypes.SchemaType
-
 export type DocumentType = TransmissionTypes.DocumentType
 export type HashType = TransmissionTypes.HashType
 

package/src/transmission/common/index.d.mts

@@ -1,38 +1,38 @@
-type ObjectLiteralType = TransmissionTypes.ObjectLiteralType
-type ObjectType = TransmissionTypes.ObjectType
-
-type ItemsType = TransmissionTypes.ItemsType
-
-type TransmissionStringMetaType = TransmissionTypes.Transmission.StringMetaType
-type TransmissionNumberMetaType = TransmissionTypes.Transmission.NumberMetaType
-type TransmissionArrayMetaType = TransmissionTypes.Transmission.ArrayMetaType
-type TransmissionObjectMetaType = TransmissionTypes.Transmission.ObjectMetaType
-type TransmissionBooleanMetaType = TransmissionTypes.Transmission.BooleanMetaType
-type TransmissionNullMetaType = TransmissionTypes.Transmission.NullMetaType
-
-type TransmissionStringElementsType = TransmissionTypes.Transmission.StringElementsType
-type TransmissionNumberElementsType = TransmissionTypes.Transmission.NumberElementsType
-type TransmissionArrayElementsType = TransmissionTypes.Transmission.ArrayElementsType
-type TransmissionObjectElementsType = TransmissionTypes.Transmission.ObjectElementsType
-type TransmissionBooleanElementsType = TransmissionTypes.Transmission.BooleanElementsType
-type TransmissionNullElementsType = TransmissionTypes.Transmission.NullElementsType
-
-type EnumType = TransmissionTypes.EnumType
-type OneOfType = TransmissionTypes.OneOfType
-type AnyOfType = TransmissionTypes.AnyOfType
-type FieldType = TransmissionTypes.FieldType
-
-type SchemaType = TransmissionTypes.SchemaType
-
-type StringSchemaType = TransmissionTypes.StringSchemaType
-type NumberSchemaType = TransmissionTypes.NumberSchemaType
-type ArraySchemaType = TransmissionTypes.ArraySchemaType
-type ObjectSchemaType = TransmissionTypes.ObjectSchemaType
-type BooleanSchemaType = TransmissionTypes.BooleanSchemaType
-type NullSchemaType = TransmissionTypes.NullSchemaType
-
-type ValuesType = TransmissionTypes.ValuesType
-type ParamsType = TransmissionTypes.ParamsType
+export type ObjectLiteralType = TransmissionTypes.ObjectLiteralType
+export type ObjectType = TransmissionTypes.ObjectType
+
+export type ItemsType = TransmissionTypes.ItemsType
+
+export type StringMetaType = TransmissionTypes.Transmission.StringMetaType
+export type NumberMetaType = TransmissionTypes.Transmission.NumberMetaType
+export type ArrayMetaType = TransmissionTypes.Transmission.ArrayMetaType
+export type ObjectMetaType = TransmissionTypes.Transmission.ObjectMetaType
+export type BooleanMetaType = TransmissionTypes.Transmission.BooleanMetaType
+export type NullMetaType = TransmissionTypes.Transmission.NullMetaType
+
+export type StringElementsType = TransmissionTypes.Transmission.StringElementsType
+export type NumberElementsType = TransmissionTypes.Transmission.NumberElementsType
+export type ArrayElementsType = TransmissionTypes.Transmission.ArrayElementsType
+export type ObjectElementsType = TransmissionTypes.Transmission.ObjectElementsType
+export type BooleanElementsType = TransmissionTypes.Transmission.BooleanElementsType
+export type NullElementsType = TransmissionTypes.Transmission.NullElementsType
+
+export type EnumType = TransmissionTypes.EnumType
+export type OneOfType = TransmissionTypes.OneOfType
+export type AnyOfType = TransmissionTypes.AnyOfType
+export type FieldType = TransmissionTypes.FieldType
+
+export type SchemaType = TransmissionTypes.SchemaType
+
+export type StringSchemaType = TransmissionTypes.StringSchemaType
+export type NumberSchemaType = TransmissionTypes.NumberSchemaType
+export type ArraySchemaType = TransmissionTypes.ArraySchemaType
+export type ObjectSchemaType = TransmissionTypes.ObjectSchemaType
+export type BooleanSchemaType = TransmissionTypes.BooleanSchemaType
+export type NullSchemaType = TransmissionTypes.NullSchemaType
+
+export type ValuesType = TransmissionTypes.ValuesType
+export type ParamsType = TransmissionTypes.ParamsType
 
 export function isObject (v?: unknown): v is (Record<PropertyKey, string | number | object | boolean | null | string[] | number[] | object[] | boolean[] | null[]> | Record<PropertyKey, never>)
 export function isArray (v?: unknown): v is (string[] | number[] | object[] | boolean[] | null[])
@@ -55,7 +55,7 @@ export function getSelectedItems (values?: ValuesType, uri?: string): Array<stri
 
 export function isParentUri (parentUri?: string, uri?: string): boolean
 
-export function getMetaProps (params?: ParamsType, uri?: string): TransmissionStringMetaType | TransmissionNumberMetaType | TransmissionArrayMetaType | TransmissionObjectMetaType | TransmissionBooleanMetaType | TransmissionNullMetaType | Record<string, never>
+export function getMetaProps (params?: ParamsType, uri?: string): StringMetaType | NumberMetaType | ArrayMetaType | ObjectMetaType | BooleanMetaType | NullMetaType | Record<string, never>
 export function hasMetaDefaultValue (schema?: SchemaType): boolean
 export function getMetaDefaultValue (schema?: SchemaType): { defaultValue: string } | ObjectLiteralType
 export function hasMetaValue (values?: ValuesType, uri?: string, schema?: SchemaType): boolean
@@ -63,7 +63,8 @@ export function getMetaValue (values?: ValuesType, uri?: string, schema?: Schema
 
 export function transformToValue (schema?: string | number | object | boolean | null): string | number | object | boolean | null | undefined
 
-export function findByUri (parentUri: string, uri: string): (key: string | number) => boolean
+export function findByKey (parentUri: string, uri: string): (key: string | number) => boolean
+export function findByIndex (parentUri: string, uri: string): (item: SchemaType, index: number) => boolean
 export function findByValue (value?: string | number | object | boolean | null): (item?: string | number | object | boolean | null | string[] | number[] | object[] | boolean[] | null[]) => boolean
 export function findByEqual (value?: string | number | object | boolean | null): (item?: string | number | object | boolean | null | string[] | number[] | object[] | boolean[] | null[]) => boolean
 
@@ -108,7 +109,7 @@ export function getIndexForAnyOf (values?: ValuesType, parentUri?: string, uri?:
 export function getValueForOneOf (v: string | number, schema?: { oneOf?: ItemsType }): string
 export function getIndexForOneOf (values: ValuesType, parentUri?: string, uri?: string, schema?: SchemaType): number
 
-export function getElementsProps (params?: ParamsType, uri?: string): TransmissionStringElementsType | TransmissionNumberElementsType | TransmissionArrayElementsType | TransmissionObjectElementsType | TransmissionBooleanElementsType | TransmissionNullElementsType | Record<string, never>
+export function getElementsProps (params?: ParamsType, uri?: string): StringElementsType | NumberElementsType | ArrayElementsType | ObjectElementsType | BooleanElementsType | NullElementsType | Record<string, never>
 
 export function getElementsFieldPropsForEnum (params?: ParamsType, uri?: string): EnumType | ObjectLiteralType
 export function getElementsFieldPropsForOneOf (params?: ParamsType, uri?: string): OneOfType | ObjectLiteralType

package/src/transmission/common/index.mjs

@@ -328,9 +328,9 @@ export function transformToValue (item) {
  *  @param {string} uri
  *  @returns {(key: string | number) => boolean}
  */
-export function findByUri (parentUri, uri) {
+export function findByKey (parentUri, uri) {
   /*
-   *  log('findByUri')
+   *  log('findByKey')
    */
   return function find (key) {
     /*
@@ -343,6 +343,60 @@ export function findByUri (parentUri, uri) {
   }
 }
 
+/**
+ *  @param {string} parentUri
+ *  @param {string} uri
+ *  @returns {(item: SchemaType, index: number) => boolean}
+ */
+export function findByIndex (parentUri, uri) {
+  /*
+   *  log('findByIndex')
+   */
+  return function find (item, index) {
+    /*
+     *  log('find')
+     */
+
+    /**
+     *  It's a schema not a value
+     */
+
+    if (hasEnum(item)) {
+      /**
+       *  Do the `parentUri` and `uri` match?
+       */
+
+      return (
+        getUri(parentUri, index) === uri
+      )
+    } else {
+      if (hasAnyOf(item)) {
+        const array = getAnyOf(item)
+
+        return (
+          array.filter(isObject).some(findByIndex(parentUri, uri))
+        )
+      } else {
+        if (hasOneOf(item)) {
+          const array = getOneOf(item)
+
+          return (
+            array.filter(isObject).some(findByIndex(parentUri, uri))
+          )
+        }
+      }
+    }
+
+    /**
+     *  It's any other kind of schema/sub-schema
+     */
+
+    return (
+      getUri(parentUri, index) === uri
+    )
+  }
+}
+
 /**
  *  @param {string | number | object | boolean | null} [value]
  *  @returns {(item?: string | number | object | boolean | null | string[] | number[] | object[] | boolean[] | null[]) => boolean}
@@ -395,14 +449,17 @@ export function toString (value) {
  *  @param {string} uri
  *  @returns {SchemaType | undefined}
  */
-function getArray ({ items /* array or object */ } = {}, parentUri = '', uri = '') {
+export function getArray ({ items /* array or object */ } = {}, parentUri = '', uri = '') {
+  /*
+   *  log('getArray')
+   */
+
   if (isArray(items)) {
-    const keys = Object.keys(items).map(Number)
-    const find = findByUri(parentUri, uri)
+    const find = findByIndex(parentUri, uri)
 
-    const key = keys.find(find)
-    if (typeof key === 'number') return items[key]
-    return undefined
+    return (
+      items.find(find)
+    )
   }
 
   if (isObject(items)) return items
@@ -422,11 +479,14 @@ export function getObject ({ properties /* object */ } = {}, parentUri = '', uri
    */
 
   if (isObject(properties)) {
-    const keys = Object.keys(properties).map(String)
-    const find = findByUri(parentUri, uri)
+    const find = findByKey(parentUri, uri)
+    const key = Object.keys(properties).find(find)
 
-    const key = keys.find(find)
-    if (typeof key === 'string') return properties[key]
+    if (key) {
+      return (
+        properties[key]
+      )
+    }
   }
 
   return undefined
@@ -456,6 +516,7 @@ export function getSchema (schema = {}, parentUri = '', uri = '') {
   /*
    *  log('getSchema')
    */
+
   const {
     type
   } = schema

package/src/transmission/from-document-to-hash/index.d.mts

@@ -1,6 +1,6 @@
-type DocumentType = TransmissionTypes.DocumentType
-type SchemaType = TransmissionTypes.SchemaType
-type HashType = TransmissionTypes.HashType
+export type DocumentType = TransmissionTypes.DocumentType
+export type SchemaType = TransmissionTypes.SchemaType
+export type HashType = TransmissionTypes.HashType
 
 export function transformArrayFor (document: DocumentType[], schema: { type: string }, hash: HashType, parentUri: string): HashType
 export function transformObjectFor (document: Record<string, DocumentType>, schema: { type: string }, hash: HashType, parentUri: string): HashType

package/src/transmission/from-hash-to-document/index.d.mts

@@ -1,27 +1,26 @@
-  type ObjectLiteralType = TransmissionTypes.ObjectLiteralType
-  type ObjectType = TransmissionTypes.ObjectType
-  type ArrayLiteralType = TransmissionTypes.ArrayLiteralType
-  type ArrayType = TransmissionTypes.ArrayType
+export type ObjectLiteralType = TransmissionTypes.ObjectLiteralType
+export type ObjectType = TransmissionTypes.ObjectType
+export type ArrayLiteralType = TransmissionTypes.ArrayLiteralType
+export type ArrayType = TransmissionTypes.ArrayType
 
-  type SchemaType = TransmissionTypes.SchemaType
-
-  type DocumentType = TransmissionTypes.DocumentType
-  type HashType = TransmissionTypes.HashType
+export type SchemaType = TransmissionTypes.SchemaType
+export type DocumentType = TransmissionTypes.DocumentType
+export type HashType = TransmissionTypes.HashType
 
 export function toNull (v: unknown): null
 export function toBoolean (v: unknown): boolean
 export function toString (v: unknown): string
 export function toNumber (v: unknown): number
 
-export function transformValueFor (document: DocumentType, array: ArrayLiteralType | ArrayType | undefined): DocumentType
+export function transformValueFor (document: DocumentType, array?: ArrayLiteralType | ArrayType): DocumentType
 
-export function getArrayFor (hash: HashType, array: ArrayLiteralType | ArrayType | undefined, uri?: string): ArrayLiteralType | ArrayType
+export function getArrayFor (hash: HashType, array?: ArrayLiteralType | ArrayType, uri?: string): ArrayLiteralType | ArrayType
 
 export function transformArrayFor (hash: HashType, schema: SchemaType, parentUri?: string, uri?: string): ArrayLiteralType | ArrayType
 export function transformObjectFor (hash: HashType, schema: SchemaType, parentUri?: string, uri?: string): ObjectLiteralType | ObjectType
 
-export function transformItemsArrayFor (hash: HashType, items: ArrayLiteralType | ArrayType | undefined, parentUri?: string, uri?: string): ArrayLiteralType | ArrayType | undefined
-export function transformItemsObjectFor (hash: HashType, items: ObjectLiteralType | ObjectType | undefined, parentUri?: string, uri?: string): ArrayLiteralType | ArrayType | undefined
+export function transformItemsArrayFor (hash: HashType, items?: ArrayLiteralType | ArrayType, parentUri?: string, uri?: string): ArrayLiteralType | ArrayType | undefined
+export function transformItemsObjectFor (hash: HashType, items?: ObjectLiteralType | ObjectType, parentUri?: string, uri?: string): ArrayLiteralType | ArrayType | undefined
 
 export function transformNull (hash: HashType, schema: SchemaType, parentUri: string, uri: string): null | undefined
 export function transformBoolean (hash: HashType, schema: SchemaType, parentUri: string, uri: string): boolean | undefined

package/src/transmission/index.d.mts

@@ -1,3 +1,9 @@
+export type SchemaType = TransmissionTypes.SchemaType
+export type DocumentType = TransmissionTypes.DocumentType
+export type HashType = TransmissionTypes.HashType
+
+export type ZashikiType = TransmissionTypes.Zashiki.ZashikiType
+
 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'