shinkansen-sprockets 1.1.462 → 1.2.0

package/src/sprockets/index.cjs

@@ -10,11 +10,8 @@ const log = debug('shinkansen-sprockets/sprockets')
 
 log('`shinkansen` is awake')
 
-/**
- *  Has only default export
- */
 const {
-  default: component
+  default: component // @ts-ignore
 } = require('./index.jsx')
 
 module.exports = component

package/src/sprockets/index.d.mts

@@ -1,17 +1,23 @@
 declare module '#sprockets/sprockets' {
   import React from 'react'
 
-  export interface SprocketProps {
-    title: string
-    onChange: SprocketsTypes.OnChangeType
-    groupRef: object
-    children: React.JSX.Element | React.JSX.Element[]
-  }
+  type SprocketProps = SprocketsTypes.Sprockets.Sprocket.SprocketProps
+
+  export default class Sprocket<P extends SprocketProps> extends React.Component<P> {
+    static propTypes: object
+
+    getClassName (): string
+
+    shouldComponentUpdate (props: SprocketProps): boolean
 
-  export default class Sprocket extends React.Component<SprocketProps> {}
+    renderTitle (): React.JSX.Element | null
+
+    renderGroup (): React.JSX.Element | null
+  }
 }
 
 declare module 'shinkansen-sprockets/sprockets' {
+  export type SprocketProps = SprocketsTypes.Sprockets.Sprocket.SprocketProps
+
   export { default } from '#sprockets/sprockets'
-  export * from '#sprockets/sprockets'
 }

package/src/sprockets/index.jsx

@@ -1,16 +1,13 @@
 /**
- * Sprocket component
- *
- * @typedef {import('shinkansen-sprockets/sprockets').SprocketProps} SprocketProps
+ *  @typedef {SprocketsTypes.Sprockets.Sprocket.SprocketProps} SprocketProps
  */
 
+/**
+ * Sprocket component
+ */
 import React, { Component } from 'react'
 import PropTypes from 'prop-types'
 
-import {
-  DEFAULT_HANDLE_CHANGE
-} from '#sprockets/common'
-
 import Title from '#sprockets/components/title'
 import Group from '#sprockets/components/group'
 
@@ -20,14 +17,13 @@ export default class Sprocket extends Component {
   }
 
   /**
-   * @param {SprocketProps} props
-   * @returns {boolean}
+   *  @param {SprocketProps} props
+   *  @returns {boolean}
    */
-  shouldComponentUpdate (props, state) {
+  shouldComponentUpdate (props) {
     return (
       (props.children !== this.props.children) ||
-      (props.title !== this.props.title) ||
-      (props.onChange !== this.props.onChange)
+      (props.title !== this.props.title)
     )
   }
 
@@ -45,14 +41,12 @@ export default class Sprocket extends Component {
 
   renderGroup () {
     const {
-      onChange = DEFAULT_HANDLE_CHANGE,
       groupRef,
       children
     } = this.props
 
     return (
       <Group
-        onChange={onChange}
         groupRef={groupRef}>
         {this.renderTitle()}
         {children}
@@ -73,7 +67,6 @@ export default class Sprocket extends Component {
 
 Sprocket.propTypes = {
   title: PropTypes.string,
-  onChange: PropTypes.func,
   children: PropTypes.oneOfType([
     PropTypes.node,
     PropTypes.arrayOf(
@@ -81,6 +74,6 @@ Sprocket.propTypes = {
     )
   ]),
   groupRef: PropTypes.shape({
-    current: PropTypes.shape().isRequired
+    current: PropTypes.shape({}).isRequired
   })
 }

package/src/transformers/check-answers/index.d.mts

@@ -1,3 +1,11 @@
 declare module '#sprockets/transformers/check-answers' {
   export default function transform (answer: SprocketsTypes.AnswerDefinitionType): SprocketsTypes.FieldChangeType
 }
+
+declare module 'shinkansen-sprockets/transformers/check-answers' {
+  export type AnswerDefinitionType = SprocketsTypes.AnswerDefinitionType
+
+  export type FieldChangeType = SprocketsTypes.FieldChangeType
+
+  export { default } from '#sprockets/transformers/check-answers'
+}

package/src/transformers/check-answers/index.mjs

@@ -5,8 +5,8 @@ const log = debug('shinkansen-sprockets/transformers/check-answers')
 log('`shinkansen` is awake')
 
 /**
- * @param {SprocketsTypes.AnswerDefinitionType}
- * @returns {FieldChangeType}
+ *  @param {SprocketsTypes.AnswerDefinitionType}
+ *  @returns {FieldChangeType}
  */
 export default function transform ({ changeAnswer: { text, href } }) {
   log('transform')

package/src/transformers/common/index.mjs

@@ -8,10 +8,10 @@ const log = debug('shinkansen-sprockets/transformers/common')
 log('`shinkansen` is awake')
 
 /**
- * @param {string} href
- * @param {string} text
- * @param {number} index
- * @returns {string}
+ *  @param {string} href
+ *  @param {string} text
+ *  @param {number} index
+ *  @returns {string}
  */
 export function getKey (href, text, index) {
   return (

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

@@ -1,3 +1,11 @@
 declare module '#sprockets/transformers/error-message' {
   export default function transform (error: SprocketsTypes.ErrorDefinitionType): SprocketsTypes.FieldErrorType
 }
+
+declare module 'shinkansen-sprockets/transformers/error-message' {
+  export type ErrorDefinitionType = SprocketsTypes.ErrorDefinitionType
+
+  export type FieldErrorType = SprocketsTypes.FieldErrorType
+
+  export { default } from '#sprockets/transformers/error-message'
+}

package/src/transformers/error-message/index.mjs

@@ -142,6 +142,10 @@ export function getErrorTextForUnknown () {
   return 'Unknown'
 }
 
+/**
+ *  @param {{ expectedType?: string }} params
+ *  @returns {string}
+ */
 export function getErrorTextForTypeInvalid ({ expectedType } = {}) {
   log('getErrorTextForTypeInvalid')
 
@@ -163,6 +167,10 @@ export function getErrorTextForTypeInvalid ({ expectedType } = {}) {
   }
 }
 
+/**
+ *  @param {{ type?: string, params?: Record<PropertyKey, unknown> }} params
+ *  @returns {string}
+ */
 export function getErrorTextByType ({ type, params } = {}) {
   log('getErrorTextByType')
 
@@ -221,8 +229,8 @@ export function getErrorTextByType ({ type, params } = {}) {
 }
 
 /**
- * @param {SprocketsTypes.ErrorDefinitionType}
- * @returns {string}
+ *  @param {{ uri?: string }} [params]
+ *  @returns {string}
  */
 export function getErrorHref ({ uri = '' } = {}) {
   log('getErrorHref')
@@ -231,8 +239,8 @@ export function getErrorHref ({ uri = '' } = {}) {
 }
 
 /**
- * @param {SprocketsTypes.ErrorDefinitionType}
- * @returns {SprocketsTypes.FieldErrorType}
+ *  @param {SprocketsTypes.ErrorDefinitionType} error
+ *  @returns {SprocketsTypes.FieldErrorType}
  */
 export default function transform (error) { // , components) {
   log('transform')

package/src/transformers/error-summary/index.d.mts

@@ -1,3 +1,11 @@
 declare module '#sprockets/transformers/error-summary' {
   export default function transform (error: SprocketsTypes.ErrorDefinitionType): SprocketsTypes.FieldErrorType
 }
+
+declare module 'shinkansen-sprockets/transformers/error-summary' {
+  export type ErrorDefinitionType = SprocketsTypes.ErrorDefinitionType
+
+  export type FieldErrorType = SprocketsTypes.FieldErrorType
+
+  export { default } from '#sprockets/transformers/error-summary'
+}

package/src/transformers/error-summary/index.mjs

@@ -142,6 +142,10 @@ export function getErrorTextForUnknown () {
   return 'Unknown'
 }
 
+/**
+ *  @param {{ expectedType?: string }} params
+ *  @returns {string}
+ */
 export function getErrorTextForTypeInvalid ({ expectedType } = {}) {
   log('getErrorTextForTypeInvalid')
 
@@ -164,8 +168,8 @@ export function getErrorTextForTypeInvalid ({ expectedType } = {}) {
 }
 
 /**
- * @param {SprocketsTypes.ErrorDefinitionType}
- * @returns {string}
+ *  @param {{ type?: string, params?: Record<PropertyKey, unknown> }} params
+ *  @returns {string}
  */
 export function getErrorTextByType ({ type, params } = {}) {
   log('getErrorTextByType')
@@ -225,8 +229,8 @@ export function getErrorTextByType ({ type, params } = {}) {
 }
 
 /**
- * @param {SprocketsTypes.ErrorDefinitionType}
- * @returns {string}
+ *  @param {{ uri?: string }} [params]
+ *  @returns {string}
  */
 export function getErrorHref ({ uri = '' } = {}) {
   log('getErrorHref')
@@ -235,8 +239,8 @@ export function getErrorHref ({ uri = '' } = {}) {
 }
 
 /**
- * @param {SprocketsTypes.ErrorDefinitionType}
- * @returns {SprocketsTypes.FieldErrorType}
+ *  @param {SprocketsTypes.ErrorDefinitionType} error
+ *  @returns {SprocketsTypes.FieldErrorType}
  */
 export default function transform (error) { // , components) {
   log('transform')