shinkansen-pinion 1.1.552 → 1.2.0

package/babel.config.cjs

@@ -40,9 +40,11 @@ const presets = [
 ]
 
 const plugins = [
-  '@babel/syntax-jsx'
+  '@babel/syntax-jsx',
+  '@babel/syntax-import-attributes'
 ]
 
+// @ts-ignore
 module.exports = (api) => {
   if (api) api.cache.using(env)
 

package/eslint.config.mjs

@@ -1,5 +1,7 @@
 import globals from 'globals'
+// @ts-ignore
 import standard from '@sequencemedia/eslint-config-standard/configs/recommended/merge'
+// @ts-ignore
 import typescript from '@sequencemedia/eslint-config-typescript/configs/recommended/merge'
 import babelParser from '@babel/eslint-parser'
 import typescriptParser from '@typescript-eslint/parser'
@@ -58,12 +60,11 @@ export default [
     ]
   },
   /**
-   *  React config for all `jsx` and `tsx` files
+   *  React config for all `jsx` files
    */
   {
     ...reactPlugin.configs.flat.recommended,
     settings: {
-      ...reactPlugin.configs.flat.recommended.settings,
       ...reactSettings
     }
   },
@@ -111,15 +112,15 @@ export default [
     }
   }),
   /**
-   *  Standard config for all `jsx` and `tsx` files
+   *  Standard config for all `jsx` files
    */
   standard({
     files: [
-      'src/**/*.tsx',
+      'src/**/*.jsx',
       'stories/**/*.jsx'
     ],
     ignores: [
-      'src/**/__tests__/**/*.tsx',
+      'src/**/__tests__/**/*.jsx',
       'stories/**/__tests__/**/*.jsx'
     ],
     languageOptions: {
@@ -148,7 +149,7 @@ export default [
   }),
   standard({
     files: [
-      'src/**/__tests__/**/*.tsx',
+      'src/**/__tests__/**/*.jsx',
       'stories/**/__tests__/**/*.jsx'
     ],
     languageOptions: {
@@ -184,83 +185,34 @@ export default [
       '**/*.{mts,cts}'
     ],
     ignores: [
-      'src',
-      'stories',
-      'test'
-    ],
-    languageOptions: {
-      globals: {
-        ...globals.node
-      }
-    }
-  }),
-  typescript({
-    files: [
-      'src/**/*.{mts,cts}',
-      'test/**/*.{mts,cts}'
-    ],
-    languageOptions: {
-      globals: {
-        ...globals.browser,
-        PinionTypes: 'readonly'
-      }
-    }
-  }),
-  /**
-   *  TypeScript config for only `tsx` files
-   */
-  typescript({
-    files: [
-      'src/**/*.tsx'
-    ],
-    ignores: [
-      'src/**/__tests__/**/*.tsx'
+      'src'
     ],
     languageOptions: {
       parser: typescriptParser,
       parserOptions: {
-        ...reactParserOptions,
         projectService: true,
         project: 'tsconfig.json'
       },
       globals: {
-        ...globals.browser
+        ...globals.node,
+        PinionTypes: 'readonly'
       }
-    },
-    plugins: {
-      ...reactPlugins
-    },
-    rules: {
-      ...reactRules
-    },
-    settings: {
-      ...reactSettings
     }
   }),
   typescript({
     files: [
-      'src/**/__tests__/**/*.tsx'
+      'src/**/*.{mts,cts}'
     ],
     languageOptions: {
       parser: typescriptParser,
       parserOptions: {
-        ...reactParserOptions,
         projectService: true,
         project: 'tsconfig.json'
       },
       globals: {
         ...globals.browser,
-        ...globals.jest
+        PinionTypes: 'readonly'
       }
-    },
-    plugins: {
-      ...reactPlugins
-    },
-    rules: {
-      ...reactRules
-    },
-    settings: {
-      ...reactSettings
     }
   })
 ]

package/index.d.mts

@@ -1,3 +1,15 @@
+import type { CheckboxProps } from 'shinkansen-cogs/cogs/checkbox'
+import type { EmailProps } from 'shinkansen-cogs/cogs/email'
+import type { NumberProps } from 'shinkansen-cogs/cogs/number'
+import type { PasswordProps } from 'shinkansen-cogs/cogs/password'
+import type { RadioProps } from 'shinkansen-cogs/cogs/radio'
+import type { SelectProps } from 'shinkansen-cogs/cogs/select'
+import type { TextProps } from 'shinkansen-cogs/cogs/text'
+import type { TextareaProps } from 'shinkansen-cogs/cogs/textarea'
+import type { CheckAnswersProps } from 'shinkansen-sprockets/sprockets/check-answers'
+import type { ErrorSummaryProps } from 'shinkansen-sprockets/sprockets/error-summary'
+import type { FieldsetProps } from 'shinkansen-sprockets/sprockets/fieldset'
+
 declare global {
   namespace PinionTypes {
     export type ObjectLiteralType = Record<PropertyKey, never>
@@ -5,6 +17,30 @@ declare global {
     export type ArrayLiteralType = never[]
     export type ArrayType = unknown[]
 
+    export interface EnumType {
+      id: string
+      name?: string
+      isRequired?: boolean
+      items?: string[] | number[] | boolean[] | null[]
+      selectedItems?: number[]
+    }
+
+    export interface AnyOfType {
+      id: string
+      name?: string
+      isRequired?: boolean
+      items?: string[]
+      selectedItems?: number[]
+    }
+
+    export interface OneOfType {
+      id: string
+      name?: string
+      isRequired?: boolean
+      items?: string[]
+      selectedItems?: number[]
+    }
+
     export interface FieldError {
       type: string
       params: ObjectType
@@ -12,59 +48,65 @@ declare global {
     }
 
     export interface MetaType {
+      type: string,
       uri: string
       isRequired?: boolean
-      items?: string[] | ArrayLiteralType
-      selectedItems?: number[] | ArrayLiteralType
+      schema?: ObjectLiteralType | ObjectType
+      items?: unknown[]
+      selectedItems?: number[]
     }
 
-    export type MetaComponentType = MetaType & { component: ObjectType }
+    export interface MetaEnumType extends Omit<MetaType, 'items'> {
+      items?: string[]
+      selectedItems?: number[]
+    }
 
-    export interface ElementsType {
-      title: string
-      description: string
+    export interface MetaAnyOfType extends Omit<MetaType, 'items'> {
+      items?: PinionType[] // eslint-disable-line no-use-before-define -- Standard type
+      selectedItems?: number[]
     }
 
-    export interface EnumType {
-      id: string
-      name?: string
-      isRequired?: boolean
-      items?: string[] | ArrayLiteralType
-      selectedItems?: number[] | ArrayLiteralType
+    export interface MetaOneOfType extends Omit<MetaType, 'items'> {
+      items?: PinionType[] // eslint-disable-line no-use-before-define -- Standard type
+      selectedItems?: number[]
     }
 
-    export interface AnyOfType {
+    export type MetaFieldType = MetaType
+
+    export interface FieldType {
       id: string
       name?: string
       isRequired?: boolean
-      items?: string[] | ArrayLiteralType
-      selectedItems?: number[] | ArrayLiteralType
+      items?: string[]
+      selectedItems?: number[],
+      value?: string | number | boolean | null | ObjectType | ArrayType
+      defaultValue?: string | number | boolean | null | ObjectType | ArrayType
     }
 
-    export interface OneOfType {
-      id: string
-      name?: string
-      isRequired?: boolean
-      items?: string[] | ArrayLiteralType
-      selectedItems?: number[] | ArrayLiteralType
+    export interface ElementsType {
+      title: string
+      description?: string,
+      field?: FieldType,
+      fields?: PinionType[] // eslint-disable-line no-use-before-define -- Standard type
     }
 
-    export interface FieldType {
-      id: string
-      name?: string
-      isRequired?: boolean
-      items?: string[] | ArrayLiteralType
-      selectedItems?: number[] | ArrayLiteralType
+    export interface ElementsEnumType extends ElementsType {
+      enum: EnumType
+    }
+
+    export interface ElementsAnyOfType extends ElementsType {
+      anyOf: AnyOfType
+    }
+
+    export interface ElementsOneOfType extends ElementsType {
+      oneOf: OneOfType
     }
 
-    export type ElementsEnumType = ElementsType & { enum: EnumType }
-    export type ElementsAnyOfType = ElementsType & { anyOf: AnyOfType }
-    export type ElementsOneOfType = ElementsType & { oneOf: OneOfType }
-    export type ElementsFieldType = ElementsType & { field: FieldType }
+    export type ElementsFieldType = ElementsType
 
     export interface AnswerType {
-      meta: MetaType | MetaComponentType
-      elements: ElementsType | ElementsEnumType | ElementsAnyOfType | ElementsOneOfType | ElementsFieldType
+      meta: MetaType | MetaEnumType | MetaAnyOfType | MetaOneOfType
+      elements: ElementsType | ElementsEnumType | ElementsAnyOfType | ElementsOneOfType
     }
 
     export type ResourceType = Record<PropertyKey, unknown>
@@ -72,7 +114,7 @@ declare global {
     interface AnswerChangeAnswerType {
       href: string
       text: string
-      visuallyHiddenText: string
+      visuallyHiddenText?: string
     }
 
     export interface TypeStringAnswerType {
@@ -142,6 +184,109 @@ declare global {
     }
 
     export type OnChangeType = () => void
+
+    export interface PinionType {
+      meta: MetaType | MetaEnumType | MetaAnyOfType | MetaOneOfType
+      elements: ElementsType | ElementsEnumType | ElementsAnyOfType | ElementsOneOfType
+    }
+
+    export interface ParamsType { components: Record<PropertyKey, unknown>, errors: FieldError[] }
+
+    export interface PinionProps {
+      pinion: PinionType
+      params: ParamsType
+      onChange: OnChangeType
+    }
+
+    export interface FieldProps {
+      meta: MetaEnumType | MetaAnyOfType | MetaOneOfType | MetaFieldType
+      elements: ElementsEnumType | ElementsAnyOfType | ElementsOneOfType | ElementsFieldType
+      params: ParamsType
+      onChange: OnChangeType
+    }
+
+    export interface GroupProps {
+      meta: MetaEnumType | MetaAnyOfType | MetaOneOfType | MetaFieldType
+      elements: ElementsEnumType | ElementsAnyOfType | ElementsOneOfType | ElementsFieldType
+      params: ParamsType
+      onChange: OnChangeType
+    }
+
+    export namespace Components {
+      export namespace Cogs {
+        export namespace Cog {
+          export namespace Checkbox {
+            export type {
+              CheckboxProps
+            }
+          }
+
+          export namespace Email {
+            export type {
+              EmailProps
+            }
+          }
+
+          export namespace Number {
+            export type {
+              NumberProps
+            }
+          }
+
+          export namespace Password {
+            export type {
+              PasswordProps
+            }
+          }
+
+          export namespace Radio {
+            export type {
+              RadioProps
+            }
+          }
+
+          export namespace Select {
+            export type {
+              SelectProps
+            }
+          }
+
+          export namespace Text {
+            export type {
+              TextProps
+            }
+          }
+
+          export namespace Textarea {
+            export type {
+              TextareaProps
+            }
+          }
+        }
+      }
+
+      export namespace Sprockets {
+        export namespace Sprocket {
+          export namespace CheckAnswers {
+            export type {
+              CheckAnswersProps
+            }
+          }
+
+          export namespace ErrorSummary {
+            export type {
+              ErrorSummaryProps
+            }
+          }
+
+          export namespace Fieldset {
+            export type {
+              FieldsetProps
+            }
+          }
+        }
+      }
+    }
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shinkansen-pinion",
-  "version": "1.1.552",
+  "version": "1.2.0",
   "description": "Shinkansen Pinion",
   "keywords": [
     "Shinkansen",
@@ -45,11 +45,13 @@
     "transform": "cross-env DEBUG=shinkansen-pinion* ./transform.sh"
   },
   "dependencies": {
-    "debug": "^4.4.0"
+    "debug": "^4.4.0",
+    "react-router-dom": "^7.2.0"
   },
   "devDependencies": {
     "@babel/core": "^7.26.9",
     "@babel/eslint-parser": "^7.26.8",
+    "@babel/plugin-syntax-import-attributes": "^7.26.0",
     "@babel/preset-env": "^7.26.9",
     "@babel/preset-react": "^7.26.3",
     "@babel/register": "^7.25.9",
@@ -61,7 +63,13 @@
     "@storybook/addon-links": "7.6.20",
     "@storybook/react": "7.6.20",
     "@storybook/react-webpack5": "7.6.20",
+    "@types/babel__register": "^7.17.3",
+    "@types/chai": "^5.0.1",
+    "@types/debug": "^4.1.12",
+    "@types/jest": "^29.5.14",
+    "@types/mocha": "^10.0.10",
     "@types/react": "18.3.13",
+    "@types/react-test-renderer": "^19.0.0",
     "@typescript-eslint/eslint-plugin": "^8.24.1",
     "@typescript-eslint/parser": "^8.24.1",
     "autoprefixer": "^10.4.20",
@@ -95,25 +103,26 @@
     "remove-files-webpack-plugin": "^1.5.0",
     "sass": "^1.85.0",
     "sass-loader": "^16.0.5",
-    "shinkansen-cogs": "1.7.301",
+    "shinkansen-cogs": "1.8.0",
     "shinkansen-rails": "1.0.280",
     "shinkansen-signals": "1.1.210",
-    "shinkansen-sprockets": "1.1.462",
+    "shinkansen-sprockets": "1.2.0",
     "sinon": "^19.0.2",
     "storybook": "7.6.20",
     "webpack": "^5.98.0",
     "webpack-cli": "^6.0.1"
   },
   "peerDependencies": {
-    "shinkansen-cogs": "1.7.x",
+    "shinkansen-cogs": "1.8.x",
     "shinkansen-rails": "1.0.x",
     "shinkansen-signals": "1.1.x",
-    "shinkansen-sprockets": "1.1.x"
+    "shinkansen-sprockets": "1.2.x"
   },
   "imports": {
     "#build/paths": "./build/paths.mjs",
     "#pinion": "./src/index.mjs",
     "#pinion/common": "./src/common/index.mjs",
+    "#pinion/common/*": "./src/common/*.mjs",
     "#pinion/components": "./src/components/index.mjs",
     "#pinion/components/*": "./src/components/*/index.mjs",
     "#pinion/pinion": "./src/pinion/index.jsx",
@@ -136,6 +145,7 @@
       "import": "./src/index.mjs"
     },
     "./common": "./src/common/index.mjs",
+    "./common/*": "./src/common/*.mjs",
     "./components": {
       "require": "./src/components/index.cjs",
       "import": "./src/components/index.mjs"

package/src/common/elements/has-any-of.mjs

@@ -0,0 +1,23 @@
+/**
+ *  @typedef {PinionTypes.ObjectType} ObjectType
+ *
+ *  @typedef {PinionTypes.ElementsType} ElementsType
+ *  @typedef {PinionTypes.ElementsEnumType} ElementsEnumType
+ *  @typedef {PinionTypes.ElementsAnyOfType} ElementsAnyOfType
+ *  @typedef {PinionTypes.ElementsOneOfType} ElementsOneOfType
+ *  @typedef {PinionTypes.ElementsFieldType} ElementsFieldType
+ */
+
+/**
+ *  @overload
+ *  @param {ElementsEnumType | ElementsAnyOfType | ElementsOneOfType | ElementsFieldType} elements
+ *  @returns {elements is ElementsAnyOfType}
+ *
+ *  @param {ElementsType} elements
+ *  @returns {boolean}
+ */
+export default function hasAnyOf (elements) {
+  return (
+    'anyOf' in elements
+  )
+}

package/src/common/elements/has-enum.mjs

@@ -0,0 +1,23 @@
+/**
+ *  @typedef {PinionTypes.ObjectType} ObjectType
+ *
+ *  @typedef {PinionTypes.ElementsType} ElementsType
+ *  @typedef {PinionTypes.ElementsEnumType} ElementsEnumType
+ *  @typedef {PinionTypes.ElementsAnyOfType} ElementsAnyOfType
+ *  @typedef {PinionTypes.ElementsOneOfType} ElementsOneOfType
+ *  @typedef {PinionTypes.ElementsFieldType} ElementsFieldType
+ */
+
+/**
+ *  @overload
+ *  @param {ElementsEnumType | ElementsAnyOfType | ElementsOneOfType | ElementsFieldType} elements
+ *  @returns {elements is ElementsEnumType}
+ *
+ *  @param {ElementsType} elements
+ *  @returns {boolean}
+ */
+export default function hasEnum (elements) {
+  return (
+    'enum' in elements
+  )
+}

package/src/common/elements/has-field.mjs

@@ -0,0 +1,27 @@
+/**
+ *  @typedef {PinionTypes.ElementsType} ElementsType
+ *  @typedef {PinionTypes.ElementsEnumType} ElementsEnumType
+ *  @typedef {PinionTypes.ElementsAnyOfType} ElementsAnyOfType
+ *  @typedef {PinionTypes.ElementsOneOfType} ElementsOneOfType
+ *  @typedef {PinionTypes.ElementsFieldType} ElementsFieldType
+ */
+
+import hasEnum from './has-enum.mjs'
+import hasAnyOf from './has-any-of.mjs'
+import hasOneOf from './has-one-of.mjs'
+
+/**
+ *  @overload
+ *  @param {ElementsEnumType | ElementsAnyOfType | ElementsOneOfType | ElementsFieldType} elements
+ *  @returns {elements is ElementsFieldType}
+ *
+ *  @param {ElementsType} elements
+ *  @returns {boolean}
+ */
+export default function hasField (elements) {
+  return !(
+    hasEnum(elements) ||
+    hasAnyOf(elements) ||
+    hasOneOf(elements)
+  )
+}

package/src/common/elements/has-one-of.mjs

@@ -0,0 +1,23 @@
+/**
+ *  @typedef {PinionTypes.ObjectType} ObjectType
+ *
+ *  @typedef {PinionTypes.ElementsType} ElementsType
+ *  @typedef {PinionTypes.ElementsEnumType} ElementsEnumType
+ *  @typedef {PinionTypes.ElementsAnyOfType} ElementsAnyOfType
+ *  @typedef {PinionTypes.ElementsOneOfType} ElementsOneOfType
+ *  @typedef {PinionTypes.ElementsFieldType} ElementsFieldType
+ */
+
+/**
+ *  @overload
+ *  @param {ElementsEnumType | ElementsAnyOfType | ElementsOneOfType | ElementsFieldType} elements
+ *  @returns {elements is ElementsOneOfType}
+ *
+ *  @param {ElementsType} elements
+ *  @returns {boolean}
+ */
+export default function hasOneOf (elements) {
+  return (
+    'oneOf' in elements
+  )
+}

package/src/common/index.d.mts

@@ -1,7 +1,5 @@
 declare module '#pinion/common' {
   export function DEFAULT_HANDLE_CHANGE (): void
-
-  export function DEFAULT_HANDLE_CLICK (): void
 }
 
 declare module 'shinkansen-pinion/common' {

package/src/common/index.mjs

@@ -1,7 +1,3 @@
 export function DEFAULT_HANDLE_CHANGE () {
   /* */
 }
-
-export function DEFAULT_HANDLE_CLICK () {
-  /* */
-}

package/src/common/meta/get-schema.mjs

@@ -0,0 +1,21 @@
+/**
+ *  @typedef {PinionTypes.ObjectType} ObjectType
+ *
+ *  @typedef {PinionTypes.MetaType} MetaType
+ *  @typedef {PinionTypes.MetaEnumType} MetaEnumType
+ *  @typedef {PinionTypes.MetaAnyOfType} MetaAnyOfType
+ *  @typedef {PinionTypes.MetaOneOfType} MetaOneOfType
+ *  @typedef {PinionTypes.MetaFieldType} MetaFieldType
+ */
+
+/**
+ *  @overload
+ *  @param {MetaEnumType | MetaAnyOfType | MetaOneOfType | MetaFieldType} meta
+ *  @returns {ObjectType}
+ *
+ *  @param {MetaType} meta
+ *  @returns {ObjectType}
+ */
+export default function getSchema ({ schema = {} }) {
+  return schema
+}

package/src/common/meta/has-any-of.mjs

@@ -0,0 +1,23 @@
+/**
+ *  @typedef {PinionTypes.MetaType} MetaType
+ *  @typedef {PinionTypes.MetaEnumType} MetaEnumType
+ *  @typedef {PinionTypes.MetaAnyOfType} MetaAnyOfType
+ *  @typedef {PinionTypes.MetaOneOfType} MetaOneOfType
+ *  @typedef {PinionTypes.MetaFieldType} MetaFieldType
+ */
+
+import getSchema from './get-schema.mjs'
+
+/**
+ *  @overload
+ *  @param {MetaEnumType | MetaAnyOfType | MetaOneOfType | MetaFieldType} meta
+ *  @returns {meta is MetaAnyOfType}
+ *
+ *  @param {MetaType} meta
+ *  @returns {boolean}
+ */
+export default function hasAnyOf (meta) {
+  return (
+    'anyOf' in getSchema(meta)
+  )
+}

package/src/common/meta/has-enum.mjs

@@ -0,0 +1,23 @@
+/**
+ *  @typedef {PinionTypes.MetaType} MetaType
+ *  @typedef {PinionTypes.MetaEnumType} MetaEnumType
+ *  @typedef {PinionTypes.MetaAnyOfType} MetaAnyOfType
+ *  @typedef {PinionTypes.MetaOneOfType} MetaOneOfType
+ *  @typedef {PinionTypes.MetaFieldType} MetaFieldType
+ */
+
+import getSchema from './get-schema.mjs'
+
+/**
+ *  @overload
+ *  @param {MetaEnumType | MetaAnyOfType | MetaOneOfType | MetaFieldType} meta
+ *  @returns {meta is MetaEnumType}
+ *
+ *  @param {MetaType} meta
+ *  @returns {boolean}
+ */
+export default function hasEnum (meta) {
+  return (
+    'enum' in getSchema(meta)
+  )
+}