shinkansen-sprockets 1.1.463 → 1.2.1

package/babel.config.cjs

@@ -43,6 +43,7 @@ const plugins = [
   '@babel/syntax-jsx'
 ]
 
+// @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` and `jsx` files
    */
   {
     ...reactPlugin.configs.flat.recommended,
     settings: {
-      ...reactPlugin.configs.flat.recommended.settings,
       ...reactSettings
     }
   },
@@ -100,15 +101,15 @@ export default [
     }
   }),
   /**
-   *  Standard config for all `jsx` and `tsx` files
+   *  Standard config for all `jsx`
    */
   standard({
     files: [
-      'src/**/*.tsx',
+      'src/**/*.jsx',
       'stories/**/*.jsx'
     ],
     ignores: [
-      'src/**/__tests__/**/*.tsx',
+      'src/**/__tests__/**/*.jsx',
       'stories/**/__tests__/**/*.jsx'
     ],
     languageOptions: {
@@ -137,7 +138,7 @@ export default [
   }),
   standard({
     files: [
-      'src/**/__tests__/**/*.tsx',
+      'src/**/__tests__/**/*.jsx',
       'stories/**/__tests__/**/*.jsx'
     ],
     languageOptions: {
@@ -175,78 +176,32 @@ export default [
     ignores: [
       'src'
     ],
-    languageOptions: {
-      globals: {
-        ...globals.node,
-        SprocketsTypes: 'readonly'
-      }
-    }
-  }),
-  typescript({
-    files: [
-      'src/**/*.{mts,cts}'
-    ],
-    languageOptions: {
-      globals: {
-        ...globals.browser
-      }
-    }
-  }),
-  /**
-   *  TypeScript config for only `tsx` files
-   */
-  typescript({
-    files: [
-      'src/**/*.tsx'
-    ],
-    ignores: [
-      'src/**/__tests__/**/*.tsx'
-    ],
     languageOptions: {
       parser: typescriptParser,
       parserOptions: {
-        ...reactParserOptions,
         projectService: true,
         project: 'tsconfig.json'
       },
       globals: {
-        ...globals.browser
+        ...globals.node,
+        SprocketsTypes: '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
+        SprocketsTypes: 'readonly'
       }
-    },
-    plugins: {
-      ...reactPlugins
-    },
-    rules: {
-      ...reactRules
-    },
-    settings: {
-      ...reactSettings
     }
   })
 ]

package/index.d.mts

@@ -1,25 +1,26 @@
+import type React from 'react'
+
 declare global {
   namespace SprocketsTypes {
-    export type OnChangeType = () => void
-
     export interface AnswerDefinitionType {
-      answer: {
-        title: string
-        value: string | string[]
-      }
-      changeAnswer: {
-        text: string
-        href: string
-        visuallyHiddenText?: string
+      type: string,
+      params: {
+        answer: {
+          title: string
+          value: string | string[]
+        }
+        changeAnswer: {
+          text: string
+          href: string
+          visuallyHiddenText?: string
+        }
       }
     }
 
     export interface ErrorDefinitionType {
       type: string
       uri: string
-      params: {
-        expectedType: string
-      }
+      params: Record<PropertyKey, unknown> | Record<PropertyKey, never>
     }
 
     export interface FieldChangeType {
@@ -31,6 +32,114 @@ declare global {
       text: string
       href: string
     }
+
+    export namespace Components {
+      export namespace Common {
+        export namespace TextContent {
+          export interface TextContentProps {
+            textContent?: string
+          }
+        }
+
+        export namespace VisuallyHiddenText {
+          export interface VisuallyHiddenTextProps {
+            visuallyHiddenText?: string
+          }
+        }
+      }
+
+      export namespace Description {
+        export interface DescriptionProps {
+          description?: string
+        }
+      }
+
+      export namespace ErrorMessage {
+        export interface ErrorMessageProps {
+          errorMessage?: ErrorDefinitionType[]
+        }
+
+        export interface ErrorMessageState {
+          errorMessage?: ErrorDefinitionType[]
+        }
+      }
+
+      export namespace Group {
+        export interface GroupProps extends React.PropsWithChildren {
+          groupRef?: React.RefObject<any> // eslint-disable-line @typescript-eslint/no-explicit-any -- Simplicity
+        }
+
+        export type GroupState = Record<PropertyKey, unknown>
+
+        export namespace CheckAnswers {
+          export interface CheckAnswersProps extends GroupProps {
+            checkAnswers?: AnswerDefinitionType[]
+          }
+
+          export interface CheckAnswersState extends GroupState {
+            checkAnswers?: AnswerDefinitionType[]
+          }
+        }
+
+        export namespace ErrorSummary {
+          export interface ErrorSummaryProps extends GroupProps {
+            errorSummary?: ErrorDefinitionType[]
+          }
+
+          export interface ErrorSummaryState extends GroupState {
+            errorSummary?: ErrorDefinitionType[]
+          }
+        }
+
+        export namespace Fieldset {
+          export type FieldsetProps = GroupProps
+          export type FieldsetState = GroupState
+        }
+      }
+
+      export namespace Title {
+        export interface TitleProps {
+          title?: string
+        }
+
+        export namespace CheckAnswers {
+          export type CheckAnswersProps = TitleProps
+        }
+
+        export namespace ErrorSummary {
+          export type ErrorSummaryProps = TitleProps
+        }
+
+        export namespace Fieldset {
+          export type FieldsetProps = TitleProps
+        }
+      }
+    }
+
+    export namespace Sprockets {
+      export namespace Sprocket {
+        export interface SprocketProps extends React.PropsWithChildren {
+          title?: string
+          groupRe?: React.RefObject<any> // eslint-disable-line @typescript-eslint/no-explicit-any -- Simplicity
+        }
+
+        export namespace CheckAnswers {
+          export interface CheckAnswersProps extends SprocketProps {
+            checkAnswers?: AnswerDefinitionType[]
+          }
+        }
+
+        export namespace ErrorSummary {
+          export interface ErrorSummaryProps extends SprocketProps {
+            errorSummary?: ErrorDefinitionType[]
+          }
+        }
+
+        export namespace Fieldset {
+          export type FieldsetProps = SprocketProps
+        }
+      }
+    }
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shinkansen-sprockets",
-  "version": "1.1.463",
+  "version": "1.2.1",
   "description": "Shinkansen Sprockets",
   "keywords": [
     "Shinkansen",
@@ -54,14 +54,18 @@
     "@babel/preset-react": "^7.26.3",
     "@babel/register": "^7.25.9",
     "@modernpoacher/design-system": "1.1.27",
-    "@sequencemedia/eslint-config-standard": "^0.2.25",
-    "@sequencemedia/eslint-config-typescript": "^0.1.36",
+    "@sequencemedia/eslint-config-standard": "^0.2.26",
+    "@sequencemedia/eslint-config-typescript": "^0.1.37",
     "@storybook/addon-actions": "7.6.20",
     "@storybook/addon-essentials": "7.6.20",
     "@storybook/addon-links": "7.6.20",
     "@storybook/react": "7.6.20",
     "@storybook/react-webpack5": "7.6.20",
+    "@types/babel__register": "^7.17.3",
+    "@types/debug": "^4.1.12",
+    "@types/jest": "^29.5.14",
     "@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",
@@ -77,7 +81,7 @@
     "jest": "^29.7.0",
     "mini-css-extract-plugin": "^2.9.2",
     "perfectionist": "^2.4.0",
-    "postcss": "^8.5.2",
+    "postcss": "^8.5.3",
     "postcss-discard-comments": "^7.0.3",
     "postcss-discard-empty": "^7.0.0",
     "postcss-import": "^16.1.0",
@@ -87,6 +91,7 @@
     "react": "18.3.1",
     "react-dom": "18.3.1",
     "react-router": "^7.2.0",
+    "react-router-dom": "^7.2.0",
     "react-test-renderer": "18.3.1",
     "remove-files-webpack-plugin": "^1.5.0",
     "sass": "^1.85.0",

package/src/common/index.d.mts

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

package/src/common/index.mjs

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

package/src/components/common/text-content/index.cjs

@@ -11,7 +11,7 @@ const log = debug('shinkansen-sprockets/components/common/text-content')
 log('`shinkansen` is awake')
 
 const {
-  default: component
+  default: component // @ts-ignore
 } = require('./index.jsx')
 
 module.exports = component

package/src/components/common/text-content/index.d.mts

@@ -1,14 +1,13 @@
 declare module '#sprockets/components/common/text-content' {
   import type React from 'react'
 
-  export interface TextContentProps {
-    textContent: string
-  }
+  type TextContentProps = SprocketsTypes.Components.Common.TextContent.TextContentProps
 
   export default function TextContent (props: TextContentProps): React.JSX.Element | null
 }
 
 declare module 'shinkansen-sprockets/components/common/text-content' {
+  export type TextContentProps = SprocketsTypes.Components.Common.TextContent.TextContentProps
+
   export { default } from '#sprockets/components/common/text-content'
-  export * from '#sprockets/components/common/text-content'
 }

package/src/components/common/text-content/index.jsx

@@ -1,15 +1,16 @@
 /**
- * TextContent component
- *
- * @typedef {import('shinkansen-sprockets/components/common/text-content').TextContentProps} TextContentProps
+ *  @typedef {SprocketsTypes.Components.Common.TextContent.TextContentProps} TextContentProps
  */
 
+/**
+ * TextContent component
+ */
 import React from 'react'
 import PropTypes from 'prop-types'
 
 /**
- * @param {TextContentProps}
- * @returns {React.JSX.Element | null}
+ *  @param {TextContentProps} props
+ *  @returns {React.JSX.Element | null}
  */
 export default function TextContent ({ textContent }) {
   if (textContent) {
@@ -24,5 +25,5 @@ export default function TextContent ({ textContent }) {
 }
 
 TextContent.propTypes = {
-  textContent: PropTypes.string.isRequired
+  textContent: PropTypes.string
 }

package/src/components/common/visually-hidden-text/index.cjs

@@ -11,7 +11,7 @@ const log = debug('shinkansen-sprockets/components/common/visually-hidden-text')
 log('`shinkansen` is awake')
 
 const {
-  default: component
+  default: component // @ts-ignore
 } = require('./index.jsx')
 
 module.exports = component

package/src/components/common/visually-hidden-text/index.d.mts

@@ -1,14 +1,13 @@
 declare module '#sprockets/components/common/visually-hidden-text' {
   import type React from 'react'
 
-  export interface VisuallyHiddenTextProps {
-    visuallyHiddenText: string
-  }
+  type VisuallyHiddenTextProps = SprocketsTypes.Components.Common.VisuallyHiddenText.VisuallyHiddenTextProps
 
   export default function VisuallyHiddenText (props: VisuallyHiddenTextProps): React.JSX.Element | null
 }
 
 declare module 'shinkansen-sprockets/components/common/visually-hidden-text' {
+  export type VisuallyHiddenTextProps = SprocketsTypes.Components.Common.VisuallyHiddenText.VisuallyHiddenTextProps
+
   export { default } from '#sprockets/components/common/visually-hidden-text'
-  export * from '#sprockets/components/common/visually-hidden-text'
 }

package/src/components/common/visually-hidden-text/index.jsx

@@ -1,15 +1,16 @@
 /**
- * VisuallyHiddenText component
- *
- * @typedef {import('shinkansen-sprockets/components/common/visually-hidden-text').VisuallyHiddenTextProps} VisuallyHiddenTextProps
+ *  @typedef {SprocketsTypes.Components.Common.VisuallyHiddenText.VisuallyHiddenTextProps} VisuallyHiddenTextProps
  */
 
+/**
+ * VisuallyHiddenText component
+ */
 import React from 'react'
 import PropTypes from 'prop-types'
 
 /**
- * @param {VisuallyHiddenTextProps}
- * @returns {React.JSX.Element | null}
+ *  @param {VisuallyHiddenTextProps} props
+ *  @returns {React.JSX.Element | null}
  */
 export default function VisuallyHiddenText ({ visuallyHiddenText }) {
   if (visuallyHiddenText) {
@@ -24,5 +25,5 @@ export default function VisuallyHiddenText ({ visuallyHiddenText }) {
 }
 
 VisuallyHiddenText.propTypes = {
-  visuallyHiddenText: PropTypes.string.isRequired
+  visuallyHiddenText: PropTypes.string
 }

package/src/components/description/index.cjs

@@ -11,7 +11,7 @@ const log = debug('shinkansen-sprockets/components/description')
 log('`shinkansen` is awake')
 
 const {
-  default: component
+  default: component // @ts-ignore
 } = require('./index.jsx')
 
 module.exports = component

package/src/components/description/index.d.mts

@@ -1,14 +1,19 @@
 declare module '#sprockets/components/description' {
   import React from 'react'
 
-  export interface DescriptionProps {
-    description: string
-  }
+  type DescriptionProps = SprocketsTypes.Components.Description.DescriptionProps
+
+  export default class Description extends React.Component<DescriptionProps> {
+    static propTypes: object
+
+    getClassName (): string
 
-  export default class Description extends React.Component<DescriptionProps> {}
+    shouldComponentUpdate (props: DescriptionProps): boolean
+  }
 }
 
 declare module 'shinkansen-sprockets/components/description' {
+  export type DescriptionProps = SprocketsTypes.Components.Description.DescriptionProps
+
   export { default } from '#sprockets/components/description'
-  export * from '#sprockets/components/description'
 }

package/src/components/description/index.jsx

@@ -1,7 +1,10 @@
 /**
- * Description component
+ *  @typedef {SprocketsTypes.Components.Description.DescriptionProps} DescriptionProps
  */
 
+/**
+ * Description component
+ */
 import React, { Component } from 'react'
 import PropTypes from 'prop-types'
 
@@ -12,14 +15,20 @@ export default class Description extends Component {
     return 'description'
   }
 
-  shouldComponentUpdate (props, state) {
+  /**
+   *  @param {DescriptionProps} props
+   *  @returns {boolean}
+   */
+  shouldComponentUpdate (props) {
     return (
       (props.description !== this.props.description)
     )
   }
 
   render () {
-    const { description } = this.props
+    const {
+      description
+    } = this.props
 
     if (description) {
       return (

package/src/components/error-message/index.cjs

@@ -11,7 +11,7 @@ const log = debug('shinkansen-sprockets/components/error-message')
 log('`shinkansen` is awake')
 
 const {
-  default: component
+  default: component // @ts-ignore
 } = require('./index.jsx')
 
 module.exports = component

package/src/components/error-message/index.d.mts

@@ -1,14 +1,29 @@
 declare module '#sprockets/components/error-message' {
   import React from 'react'
 
-  export interface ErrorMessageProps {
-    errorMessage: string
-  }
+  type ErrorMessageProps = SprocketsTypes.Components.ErrorMessage.ErrorMessageProps
+  type ErrorMessageState = SprocketsTypes.Components.ErrorMessage.ErrorMessageState
+
+  export default class ErrorMessage extends React.Component<ErrorMessageProps, ErrorMessageState> {
+    static propTypes: object
+
+    hasTextContent (): boolean
+
+    getTextContent (): string
+
+    getClassName (): string
 
-  export default class ErrorMessage extends React.Component<ErrorMessageProps> {}
+    static getDerivedStateFromProps (props: ErrorMessageProps, state: ErrorMessageState): ErrorMessageState
+
+    shouldComponentUpdate (props: ErrorMessageProps, state: ErrorMessageState): boolean
+
+    renderTextContent (): React.JSX.Element | null
+  }
 }
 
 declare module 'shinkansen-sprockets/components/error-message' {
+  export type ErrorMessageProps = SprocketsTypes.Components.ErrorMessage.ErrorMessageProps
+  export type ErrorMessageState = SprocketsTypes.Components.ErrorMessage.ErrorMessageState
+
   export { default } from '#sprockets/components/error-message'
-  export * from '#sprockets/components/error-message'
 }