shinkansen-transmission 2.4.9 → 2.5.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shinkansen-transmission",
-  "version": "2.4.9",
+  "version": "2.5.1",
   "description": "Shinkansen Transmission",
   "keywords": [
     "Shinkansen",
@@ -41,11 +41,10 @@
   },
   "devDependencies": {
     "@babel/core": "^7.26.9",
-    "@babel/eslint-parser": "^7.26.8",
     "@babel/preset-env": "^7.26.9",
     "@babel/register": "^7.25.9",
-    "@sequencemedia/eslint-config-standard": "^0.2.41",
-    "@sequencemedia/eslint-config-typescript": "^0.1.57",
+    "@sequencemedia/eslint-config-standard": "^0.2.42",
+    "@sequencemedia/eslint-config-typescript": "^0.1.58",
     "@types/babel__register": "^7.17.3",
     "@types/chai": "^5.2.0",
     "@types/debug": "^4.1.12",
@@ -54,13 +53,16 @@
     "chai": "^5.2.0",
     "core-js": "^3.41.0",
     "cross-env": "^7.0.3",
-    "eslint": "^9.21.0",
+    "eslint": "^9.22.0",
     "globals": "^16.0.0",
     "husky": "^9.1.7",
     "mocha": "^11.1.0"
   },
   "imports": {
-    "#transmission": "./src/index.mjs",
+    "#transmission": {
+      "require": "./src/index.cjs",
+      "import": "./src/index.mjs"
+    },
     "#transmission/transmission": "./src/transmission/index.mjs",
     "#transmission/transmission/*": "./src/transmission/*/index.mjs",
     "#transmission/transmission/to-zashiki/transform-root-schema": "./src/transmission/to-zashiki/transform-root-schema.mjs",

package/src/index.cjs

@@ -1,5 +1,3 @@
-// @ts-nocheck
-
 require('@babel/register')({
   ignore: [
     /node_modules\/(?!shinkansen|@modernpoacher)/
@@ -12,9 +10,10 @@ const log = debug('shinkansen-transmission')
 
 log('`shinkansen` is awake')
 
-const common = require('./transmission/common/index.mjs')
-const { default: fromDocumentToHash } = require('./transmission/from-document-to-hash/index.mjs')
-const { default: fromHashToDocument } = require('./transmission/from-hash-to-document/index.mjs')
+// @ts-expect-error MJS
+const common = require('./transmission/common/index.mjs') // @ts-expect-error MJS
+const { default: fromDocumentToHash } = require('./transmission/from-document-to-hash/index.mjs') // @ts-expect-error MJS
+const { default: fromHashToDocument } = require('./transmission/from-hash-to-document/index.mjs') // @ts-expect-error MJS
 const { default: toZashiki } = require('./transmission/to-zashiki/index.mjs')
 
 module.exports.common = common

package/src/index.d.cts

@@ -0,0 +1,11 @@
+export type SchemaType = TransmissionTypes.SchemaType
+export type DocumentType = TransmissionTypes.DocumentType
+export type HashType = TransmissionTypes.HashType
+
+export type ZashikiType = TransmissionTypes.Zashiki.ZashikiType
+
+// @ts-expect-error MJS
+export * as common from '#transmission/transmission/common' // @ts-expect-error MJS
+export { default as fromDocumentToHash } from '#transmission/transmission/from-document-to-hash' // @ts-expect-error MJS
+export { default as fromHashToDocument } from '#transmission/transmission/from-hash-to-document'// @ts-expect-error MJS
+export { default as toZashiki } from '#transmission/transmission/to-zashiki'

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

@@ -74,27 +74,6 @@ export function toString (value?: MemberType): string
 export function getSchemaFromItems (schema?: { items?: SchemaType | SchemaType[] }, parentUri?: string, uri?: string): SchemaType | undefined
 export function getSchemaFromProperties (schema?: { properties?: Record<string, SchemaType> }, parentUri?: string, uri?: string): SchemaType | undefined
 
-declare function getSchema (
-  schema: (
-    StringSchemaType |
-    NumberSchemaType |
-    ArraySchemaType |
-    ObjectSchemaType |
-    BooleanSchemaType |
-    NullSchemaType
-  ),
-  parentUri?: string,
-  uri?: string
-): SchemaType | undefined
-
-declare function getSchema (
-  schema?: ObjectLiteralType | ObjectType,
-  parentUri?: string,
-  uri?: string
-): SchemaType | undefined
-
-export { getSchema }
-
 export function transformIndexToValueByFindValue (array: MemberArrayType, value?: MemberType): string
 export function transformIndexToValueByFindEqual (array: MemberArrayType, value?: MemberType): string
 

package/src/transmission/common/index.mjs

@@ -455,46 +455,6 @@ export function getSchemaFromProperties ({ properties /* object */ }, parentUri,
   return undefined
 }
 
-/**
- *  @deprecated
- *
- *  @overload
- *  @param {(
- *    StringSchemaType |
- *    NumberSchemaType |
- *    ArraySchemaType |
- *    ObjectSchemaType |
- *    BooleanSchemaType |
- *    NullSchemaType
- *  )} schema
- *  @param {string} [parentUri]
- *  @param {string} [uri]
- *  @returns {SchemaType | undefined}
- *
- *
- *  @param {*} schema
- *  @param {string} parentUri
- *  @param {string} uri
- *  @returns {* | undefined}
- */
-export function getSchema (schema, parentUri, uri) {
-  /*
-   *  log('getSchema')
-   */
-
-  const {
-    type
-  } = schema
-
-  switch (type) {
-    case 'array':
-      return getSchemaFromItems(schema, parentUri, uri)
-
-    case 'object':
-      return getSchemaFromProperties(schema, parentUri, uri)
-  }
-}
-
 /**
  *  @param {MemberArrayType} array
  *  @param {MemberType} [value]
@@ -551,7 +511,7 @@ export function transformIndexToValueByFindEqual (array, value) {
 /**
  *  @param {MemberArrayType} array
  *  @param {MemberType} [value]
- *  @returns {string}
+ *  @returns {MemberType}
  */
 export function findIndexByEqual (array, value) {
   /*

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

@@ -10,9 +10,9 @@ export function transformObjectFor (document: Record<string, DocumentType>, sche
 export function transformObject (document: Record<string, DocumentType>, schema: SchemaType, hash: HashType, parentUri: string, uri: string): HashType
 export function transformObjectSchema (document?: DocumentType, schema?: SchemaType, hash?: HashType, parentUri?: string, uri?: string): HashType
 
-export { default as transformStringSchema } from './string/index.mjs'
-export { default as transformNumberSchema } from './number/index.mjs'
-export { default as transformBooleanSchema } from './boolean/index.mjs'
-export { default as transformNullSchema } from './null/index.mjs'
+export { default as transformStringSchema } from '#transmission/transmission/from-document-to-hash/string'
+export { default as transformNumberSchema } from '#transmission/transmission/from-document-to-hash/number'
+export { default as transformBooleanSchema } from '#transmission/transmission/from-document-to-hash/boolean'
+export { default as transformNullSchema } from '#transmission/transmission/from-document-to-hash/null'
 
 export default function fromDocumentToHash (document?: DocumentType, schema?: SchemaType, hash?: HashType, parentUri?: string, uri?: string): HashType

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

@@ -30,12 +30,12 @@ const log = debug('shinkansen-transmission/from-hash-to-document/boolean')
 log('`shinkansen` is awake')
 
 /**
- * @overload
- * @param {unknown} error
- * @returns {void}
+ *  @overload
+ *  @param {unknown} error
+ *  @returns {void}
  *
- * @param {{ message?: string }} error
- * @returns {void}
+ *  @param {{ message?: string }} error
+ *  @returns {void}
  */
 function handleError ({ message = 'No error message defined' }) { log(message) }
 

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

@@ -19,21 +19,21 @@ export function transformObjectSchema (hash?: HashType, schema?: SchemaType, par
 export {
   transformString,
   default as transformStringSchema
-} from './string/index.mjs'
+} from '#transmission/transmission/from-hash-to-document/string'
 
 export {
   transformNumber,
   default as transformNumberSchema
-} from './number/index.mjs'
+} from '#transmission/transmission/from-hash-to-document/number'
 
 export {
   transformBoolean,
   default as transformBooleanSchema
-} from './boolean/index.mjs'
+} from '#transmission/transmission/from-hash-to-document/boolean'
 
 export {
   transformNull,
   default as transformNullSchema
-} from './null/index.mjs'
+} from '#transmission/transmission/from-hash-to-document/null'
 
 export default function fromHashToDocument (hash?: HashType, rootSchema?: SchemaType, parentUri?: string, uri?: string): DocumentType | undefined

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

@@ -8,6 +8,7 @@
  *
  *  @typedef {TransmissionTypes.DocumentType} DocumentType
  *  @typedef {TransmissionTypes.SchemaType} SchemaType
+ *  @typedef {TransmissionTypes.ParamsType} ParamsType
  *  @typedef {TransmissionTypes.HashType} HashType
  */
 
@@ -246,7 +247,7 @@ export function transformArray (hash, schema, parentUri, uri) {
  *  @param {HashType} [hash]
  *  @param {SchemaType} [schema]
  *  @param {ParamsType} [params]
- *  @returns {DocumentType}
+ *  @returns {DocumentType | undefined}
  */
 export function transformArraySchema (hash = {}, schema = {}, params = {}) {
   log('transformArraySchema')
@@ -361,7 +362,7 @@ export function transformObject (hash, schema, parentUri, uri) {
  *  @param {HashType} [hash]
  *  @param {SchemaType} [schema]
  *  @param {ParamsType} [params]
- *  @returns {DocumentType}
+ *  @returns {DocumentType | undefined}
  */
 export function transformObjectSchema (hash = {}, schema = {}, params = {}) {
   log('transformObjectSchema')

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

@@ -30,12 +30,12 @@ const log = debug('shinkansen-transmission/from-hash-to-document/null')
 log('`shinkansen` is awake')
 
 /**
- * @overload
- * @param {unknown} error
- * @returns {void}
+ *  @overload
+ *  @param {unknown} error
+ *  @returns {void}
  *
- * @param {{ message?: string }} error
- * @returns {void}
+ *  @param {{ message?: string }} error
+ *  @returns {void}
  */
 function handleError ({ message = 'No error message defined' }) { log(message) }
 

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

@@ -30,12 +30,12 @@ const log = debug('shinkansen-transmission/from-hash-to-document/number')
 log('`shinkansen` is awake')
 
 /**
- * @overload
- * @param {unknown} error
- * @returns {void}
+ *  @overload
+ *  @param {unknown} error
+ *  @returns {void}
  *
- * @param {{ message?: string }} error
- * @returns {void}
+ *  @param {{ message?: string }} error
+ *  @returns {void}
  */
 function handleError ({ message = 'No error message defined' }) { log(message) }
 

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

@@ -35,12 +35,12 @@ const log = debug('shinkansen-transmission/from-hash-to-document/string')
 log('`shinkansen` is awake')
 
 /**
- * @overload
- * @param {unknown} error
- * @returns {void}
+ *  @overload
+ *  @param {unknown} error
+ *  @returns {void}
  *
- * @param {{ message?: string }} error
- * @returns {void}
+ *  @param {{ message?: string }} error
+ *  @returns {void}
  */
 function handleError ({ message = 'No error message defined' }) { log(message) }