shinkansen-sprockets 1.1.462 → 1.2.0

package/src/sprockets/check-answers/index.jsx

@@ -1,9 +1,12 @@
 /**
- * CheckAnswersSprocket component
- *
- * @typedef {import('shinkansen-sprockets/sprockets').SprocketProps} SprocketProps
+ *  @typedef {SprocketsTypes.AnswerDefinitionType} AnswerDefinitionType
+ *  @typedef {SprocketsTypes.Sprockets.Sprocket.SprocketProps} SprocketProps
+ *  @typedef {SprocketsTypes.Sprockets.Sprocket.CheckAnswers.CheckAnswersProps} CheckAnswersProps
  */
 
+/**
+ * CheckAnswersSprocket component
+ */
 import React from 'react'
 import PropTypes from 'prop-types'
 
@@ -13,21 +16,34 @@ import Sprocket from '#sprockets/sprockets'
 import Title from './title/index.jsx'
 import Group from './group/index.jsx'
 
+/**
+ *  @type {AnswerDefinitionType[]}
+ */
 const DEFAULT_CHECK_ANSWERS = []
 
+/**
+ *  @extends {Sprocket<SprocketProps & CheckAnswersProps>}
+ */
 export default class CheckAnswersSprocket extends Sprocket {
   getClassName () {
     return classnames(super.getClassName(), 'check-answers')
   }
 
   /**
-   * @param {SprocketProps} props
-   * @returns {boolean}
+   *  @param {CheckAnswersProps} props
+   *  @returns {boolean}
    */
-  shouldComponentUpdate (props, state) {
+  shouldComponentUpdate (props) {
+    const {
+      checkAnswers,
+      ...superProps
+    } = props
+
+    console.log('checkAnswers', checkAnswers)
+
     return (
-      super.shouldComponentUpdate(props, state) ||
-      (props.checkAnswers !== this.props.checkAnswers)
+      super.shouldComponentUpdate(superProps) ||
+      (checkAnswers !== this.props.checkAnswers)
     )
   }
 
@@ -75,5 +91,5 @@ export default class CheckAnswersSprocket extends Sprocket {
 
 CheckAnswersSprocket.propTypes = {
   ...Sprocket.propTypes,
-  checkAnswers: PropTypes.arrayOf(PropTypes.shape())
+  checkAnswers: PropTypes.arrayOf(PropTypes.shape({}))
 }

package/src/sprockets/check-answers/title/index.cjs

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

package/src/sprockets/check-answers/title/index.d.mts

@@ -1,9 +1,13 @@
 declare module '#sprockets/sprockets/check-answers/title' {
   import Title from '#sprockets/components/title'
 
-  export default class CheckAnswersTitle extends Title {}
+  type CheckAnswersProps = SprocketsTypes.Components.Title.CheckAnswers.CheckAnswersProps
+
+  export default class CheckAnswersTitle<P extends CheckAnswersProps> extends Title<P> {}
 }
 
 declare module 'shinkansen-sprockets/sprockets/check-answers/title' {
+  export type CheckAnswersProps = SprocketsTypes.Components.Title.CheckAnswers.CheckAnswersProps
+
   export { default } from '#sprockets/sprockets/check-answers/title'
 }

package/src/sprockets/check-answers/title/index.jsx

@@ -1,11 +1,18 @@
 /**
- * CheckAnswersTitle component
+ *  @typedef {SprocketsTypes.Components.Title.TitleProps} TitleProps
+ *  @typedef {SprocketsTypes.Components.Title.CheckAnswers.CheckAnswersProps} CheckAnswersProps
  */
 
+/**
+ * CheckAnswersTitle component
+ */
 import React from 'react'
 import classnames from 'classnames'
 import Title from '#sprockets/components/title'
 
+/**
+ *  @extends {Title<TitleProps & CheckAnswersProps>}
+ */
 export default class CheckAnswersTitle extends Title {
   getClassName () {
     return classnames(super.getClassName(), 'check-answers')
@@ -23,7 +30,3 @@ export default class CheckAnswersTitle extends Title {
     return null
   }
 }
-
-CheckAnswersTitle.propTypes = {
-  ...Title.propTypes
-}

package/src/sprockets/error-summary/group/index.cjs

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

package/src/sprockets/error-summary/group/index.d.mts

@@ -1,9 +1,15 @@
 declare module '#sprockets/sprockets/error-summary/group' {
   import Group from '#sprockets/components/group'
 
-  export default class ErrorSummaryGroup extends Group {}
+  type ErrorSummaryProps = SprocketsTypes.Components.Group.ErrorSummary.ErrorSummaryProps
+  type ErrorSummaryState = SprocketsTypes.Components.Group.ErrorSummary.ErrorSummaryState
+
+  export default class ErrorSummaryGroup<P extends ErrorSummaryProps, S extends ErrorSummaryState> extends Group<P, S> {}
 }
 
 declare module 'shinkansen-sprockets/sprockets/error-summary/group' {
+  export type ErrorSummaryProps = SprocketsTypes.Components.Group.ErrorSummary.ErrorSummaryProps
+  export type ErrorSummaryState = SprocketsTypes.Components.Group.ErrorSummary.ErrorSummaryState
+
   export { default } from '#sprockets/sprockets/error-summary/group'
 }

package/src/sprockets/error-summary/group/index.jsx

@@ -1,22 +1,22 @@
 /**
- * ErrorSummaryGroup component
- *
- * @typedef {import('shinkansen-sprockets/components/group').GroupProps} GroupProps
- *
- * Group state
- *
- * @typedef {Object} GroupState
- * @property {{}} [errorSummary]
+ *  @typedef {SprocketsTypes.ErrorDefinitionType} ErrorDefinitionType
+ *  @typedef {SprocketsTypes.Components.Group.GroupProps} GroupProps
+ *  @typedef {SprocketsTypes.Components.Group.GroupState} GroupState
+ *  @typedef {SprocketsTypes.Components.Group.ErrorSummary.ErrorSummaryProps} ErrorSummaryProps
+ *  @typedef {SprocketsTypes.Components.Group.ErrorSummary.ErrorSummaryState} ErrorSummaryState
  */
 
+/**
+ * ErrorSummaryGroup component
+ */
 import React from 'react'
 import PropTypes from 'prop-types'
 
-import debug from 'debug'
-
 import equal from 'fast-deep-equal'
 import classnames from 'classnames'
 
+import debug from 'debug'
+
 import Group from '#sprockets/components/group'
 
 import transform from '#sprockets/transformers/error-summary'
@@ -26,11 +26,18 @@ import {
 
 import TextContent from '#sprockets/components/common/text-content'
 
+/**
+ *  @type {ErrorDefinitionType[]}
+ */
 const DEFAULT_ERROR_SUMMARY = []
 
 const log = debug('shinkansen-sprockets/sprockets/error-summary/group')
 
-/* eslint-disable-next-line react/prop-types */
+/**
+ * @param {ErrorDefinitionType} error
+ * @param {number} index
+ * @returns {React.JSX.Element}
+ */
 function render (error, index) {
   log('render')
 
@@ -48,13 +55,14 @@ function render (error, index) {
   )
 }
 
+/**
+ *  @extends {Group<GroupProps & ErrorSummaryProps, GroupState & ErrorSummaryState>}
+ */
 export default class ErrorSummaryGroup extends Group {
   /**
-   * @type {GroupState}
+   *  @type {ErrorSummaryState}
    */
-  state = {
-    errorSummary: DEFAULT_ERROR_SUMMARY
-  }
+  state = {}
 
   getClassName () {
     return classnames(super.getClassName(), 'error-summary')
@@ -63,9 +71,9 @@ export default class ErrorSummaryGroup extends Group {
   /**
    * Compare latest 'props' with 'state' for changes to 'errorSummary'
    *
-   * @param {GroupProps} props   Latest props
-   * @param {GroupState} state   Current state
-   * @returns {GroupState}
+   *  @param {ErrorSummaryProps} props   Latest props
+   *  @param {ErrorSummaryState} state   Current state
+   *  @returns {ErrorSummaryState}
    */
   static getDerivedStateFromProps ({ errorSummary }, { errorSummary: E }) {
     return {
@@ -76,9 +84,9 @@ export default class ErrorSummaryGroup extends Group {
   /**
    * Compare latest 'props' with 'state' for changes to 'errorSummary'
    *
-   * @param {GroupProps} props   Latest props
-   * @param {GroupState} state   Current state
-   * @returns {boolean}
+   *  @param {ErrorSummaryProps} props   Latest props
+   *  @param {ErrorSummaryState} state   Current state
+   *  @returns {boolean}
    */
   shouldComponentUpdate (props, state) {
     const {
@@ -89,7 +97,7 @@ export default class ErrorSummaryGroup extends Group {
       errorSummary: E = DEFAULT_ERROR_SUMMARY
     } = this.state
 
-    return (e !== E)
+    return !equal(e, E)
   }
 
   render () {
@@ -117,5 +125,5 @@ export default class ErrorSummaryGroup extends Group {
 
 ErrorSummaryGroup.propTypes = {
   ...Group.propTypes,
-  errorSummary: PropTypes.arrayOf(PropTypes.shape())
+  errorSummary: PropTypes.arrayOf(PropTypes.shape({}))
 }

package/src/sprockets/error-summary/index.cjs

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

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

@@ -1,9 +1,13 @@
 declare module '#sprockets/sprockets/error-summary' {
   import Sprocket from '#sprockets/sprockets'
 
-  export default class ErrorSummarySprocket extends Sprocket {}
+  type ErrorSummaryProps = SprocketsTypes.Sprockets.Sprocket.ErrorSummary.ErrorSummaryProps
+
+  export default class ErrorSummarySprocket<P extends ErrorSummaryProps> extends Sprocket<P> {}
 }
 
 declare module 'shinkansen-sprockets/sprockets/error-summary' {
+  export type ErrorSummaryProps = SprocketsTypes.Sprockets.Sprocket.ErrorSummary.ErrorSummaryProps
+
   export { default } from '#sprockets/sprockets/error-summary'
 }

package/src/sprockets/error-summary/index.jsx

@@ -1,9 +1,11 @@
 /**
- * ErrorSummarySprocket component
- *
- * @typedef {import('shinkansen-sprockets/sprockets').SprocketProps} SprocketProps
+ *  @typedef {SprocketsTypes.Sprockets.Sprocket.SprocketProps} SprocketProps
+ *  @typedef {SprocketsTypes.Sprockets.Sprocket.ErrorSummary.ErrorSummaryProps} ErrorSummaryProps
  */
 
+/**
+ * ErrorSummarySprocket component
+ */
 import React from 'react'
 import PropTypes from 'prop-types'
 
@@ -15,19 +17,27 @@ import Group from './group/index.jsx'
 
 const DEFAULT_ERROR_SUMMARY = []
 
+/**
+ *  @extends {Sprocket<SprocketProps & ErrorSummaryProps>}
+ */
 export default class ErrorSummarySprocket extends Sprocket {
   getClassName () {
     return classnames(super.getClassName(), 'error-summary')
   }
 
   /**
-   * @param {SprocketProps} props
-   * @returns {boolean}
+   *  @param {ErrorSummaryProps} props
+   *  @returns {boolean}
    */
-  shouldComponentUpdate (props, state) {
+  shouldComponentUpdate (props) {
+    const {
+      errorSummary,
+      ...superProps
+    } = props
+
     return (
-      super.shouldComponentUpdate(props, state) ||
-      (props.errorSummary !== this.props.errorSummary)
+      super.shouldComponentUpdate(superProps) ||
+      (errorSummary !== this.props.errorSummary)
     )
   }
 
@@ -77,5 +87,5 @@ export default class ErrorSummarySprocket extends Sprocket {
 
 ErrorSummarySprocket.propTypes = {
   ...Sprocket.propTypes,
-  errorSummary: PropTypes.arrayOf(PropTypes.shape())
+  errorSummary: PropTypes.arrayOf(PropTypes.shape({}))
 }

package/src/sprockets/error-summary/title/index.cjs

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

package/src/sprockets/error-summary/title/index.d.mts

@@ -1,9 +1,13 @@
 declare module '#sprockets/sprockets/error-summary/title' {
   import Title from '#sprockets/components/title'
 
-  export default class ErrorSummaryTitle extends Title {}
+  type ErrorSummaryProps = SprocketsTypes.Components.Title.ErrorSummary.ErrorSummaryProps
+
+  export default class ErrorSummaryTitle<P extends ErrorSummaryProps> extends Title<P> {}
 }
 
 declare module 'shinkansen-sprockets/sprockets/error-summary/title' {
+  export type ErrorSummaryProps = SprocketsTypes.Components.Title.ErrorSummary.ErrorSummaryProps
+
   export { default } from '#sprockets/sprockets/error-summary/title'
 }

package/src/sprockets/error-summary/title/index.jsx

@@ -1,11 +1,18 @@
 /**
- * ErrorSummaryTitle component
+ *  @typedef {SprocketsTypes.Components.Title.TitleProps} TitleProps
+ *  @typedef {SprocketsTypes.Components.Title.ErrorSummary.ErrorSummaryProps} ErrorSummaryProps
  */
 
+/**
+ * ErrorSummaryTitle component
+ */
 import React from 'react'
 import classnames from 'classnames'
 import Title from '#sprockets/components/title'
 
+/**
+ *  @extends {Title<TitleProps & ErrorSummaryProps>}
+ */
 export default class ErrorSummaryTitle extends Title {
   getClassName () {
     return classnames(super.getClassName(), 'error-summary')
@@ -23,7 +30,3 @@ export default class ErrorSummaryTitle extends Title {
     return null
   }
 }
-
-ErrorSummaryTitle.propTypes = {
-  ...Title.propTypes
-}

package/src/sprockets/fieldset/description/index.cjs

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

package/src/sprockets/fieldset/description/index.jsx

@@ -1,7 +1,6 @@
 /**
  * FieldsetDescription component
  */
-
 import classnames from 'classnames'
 import Description from '#sprockets/components/description'
 
@@ -10,7 +9,3 @@ export default class FieldsetDescription extends Description {
     return classnames(super.getClassName(), 'fieldset')
   }
 }
-
-FieldsetDescription.propTypes = {
-  ...Description.propTypes
-}

package/src/sprockets/fieldset/error-message/index.cjs

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

package/src/sprockets/fieldset/error-message/index.jsx

@@ -1,7 +1,6 @@
 /**
  * FieldsetErrorMessage component
  */
-
 import classnames from 'classnames'
 import ErrorMessage from '#sprockets/components/error-message'
 
@@ -10,7 +9,3 @@ export default class FieldsetErrorMessage extends ErrorMessage {
     return classnames(super.getClassName(), 'fieldset')
   }
 }
-
-FieldsetErrorMessage.propTypes = {
-  ...ErrorMessage.propTypes
-}

package/src/sprockets/fieldset/group/index.cjs

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

package/src/sprockets/fieldset/group/index.d.mts

@@ -1,9 +1,15 @@
 declare module '#sprockets/sprockets/fieldset/group' {
   import Group from '#sprockets/components/group'
 
-  export default class FieldsetGroup extends Group {}
+  type FieldsetProps = SprocketsTypes.Components.Group.Fieldset.FieldsetProps
+  type FieldsetState = SprocketsTypes.Components.Group.Fieldset.FieldsetState
+
+  export default class FieldsetGroup<P extends FieldsetProps, S extends FieldsetState> extends Group<P, S> {}
 }
 
 declare module 'shinkansen-sprockets/sprockets/fieldset/group' {
+  export type FieldsetProps = SprocketsTypes.Components.Group.Fieldset.FieldsetProps
+  export type FieldsetState = SprocketsTypes.Components.Group.Fieldset.FieldsetState
+
   export { default } from '#sprockets/sprockets/fieldset/group'
 }

package/src/sprockets/fieldset/group/index.jsx

@@ -1,16 +1,21 @@
 /**
- * FieldsetGroup component
+ *  @typedef {SprocketsTypes.Components.Group.GroupProps} GroupProps
+ *  @typedef {SprocketsTypes.Components.Group.GroupState} GroupState
+ *  @typedef {SprocketsTypes.Components.Group.Fieldset.FieldsetProps} FieldsetProps
+ *  @typedef {SprocketsTypes.Components.Group.Fieldset.FieldsetState} FieldsetState
  */
 
+/**
+ * FieldsetGroup component
+ */
 import classnames from 'classnames'
 import Group from '#sprockets/components/group'
 
+/**
+ *  @extends {Group<GroupProps & FieldsetProps, GroupState & FieldsetState>}
+ */
 export default class FieldsetGroup extends Group {
   getClassName () {
     return classnames(super.getClassName(), 'fieldset')
   }
 }
-
-FieldsetGroup.propTypes = {
-  ...Group.propTypes
-}

package/src/sprockets/fieldset/index.cjs

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

package/src/sprockets/fieldset/index.d.mts

@@ -1,9 +1,19 @@
 declare module '#sprockets/sprockets/fieldset' {
+  import type React from 'react'
+
   import Sprocket from '#sprockets/sprockets'
 
-  export default class FieldsetSprocket extends Sprocket {}
+  type FieldsetProps = SprocketsTypes.Sprockets.Sprocket.Fieldset.FieldsetProps
+
+  export default class FieldsetSprocket<P extends FieldsetProps> extends Sprocket<P> {
+    renderDescription (): React.JSX.Element | null
+
+    renderErrorMessage (): React.JSX.Element | null
+  }
 }
 
 declare module 'shinkansen-sprockets/sprockets/fieldset' {
+  export type FieldsetProps = SprocketsTypes.Sprockets.Sprocket.Fieldset.FieldsetProps
+
   export { default } from '#sprockets/sprockets/fieldset'
 }

package/src/sprockets/fieldset/index.jsx

@@ -1,9 +1,11 @@
 /**
- * FieldsetSprocket component
- *
- * @typedef {import('shinkansen-sprockets/sprockets').SprocketProps} SprocketProps
+ *  @typedef {SprocketsTypes.Sprockets.Sprocket.SprocketProps} SprocketProps
+ *  @typedef {SprocketsTypes.Sprockets.Sprocket.Fieldset.FieldsetProps} FieldsetProps
  */
 
+/**
+ * FieldsetSprocket component
+ */
 import React from 'react'
 import PropTypes from 'prop-types'
 
@@ -11,15 +13,14 @@ import classnames from 'classnames'
 
 import Sprocket from '#sprockets/sprockets'
 
-import {
-  DEFAULT_HANDLE_CHANGE
-} from '#sprockets/common'
-
 import Title from './title/index.jsx'
 import Description from './description/index.jsx'
 import ErrorMessage from './error-message/index.jsx'
 import Group from './group/index.jsx'
 
+/**
+ *  @extends {Sprocket<SprocketProps & FieldsetProps>}
+ */
 export default class FieldsetSprocket extends Sprocket {
   getClassName () {
     const {
@@ -30,14 +31,20 @@ export default class FieldsetSprocket extends Sprocket {
   }
 
   /**
-   * @param {SprocketProps} props
-   * @returns {boolean}
+   *  @param {FieldsetProps} props
+   *  @returns {boolean}
    */
-  shouldComponentUpdate (props, state) {
+  shouldComponentUpdate (props) {
+    const {
+      description,
+      errorMessage,
+      ...superProps
+    } = props
+
     return (
-      super.shouldComponentUpdate(props, state) ||
-      (props.description !== this.props.description) ||
-      (props.errorMessage !== this.props.errorMessage)
+      super.shouldComponentUpdate(superProps) ||
+      (description !== this.props.description) ||
+      (errorMessage !== this.props.errorMessage)
     )
   }
 
@@ -79,13 +86,11 @@ export default class FieldsetSprocket extends Sprocket {
 
   renderGroup () {
     const {
-      onChange = DEFAULT_HANDLE_CHANGE,
       children
     } = this.props
 
     return (
-      <Group
-        onChange={onChange}>
+      <Group>
         {this.renderTitle()}
         {this.renderDescription()}
         {this.renderErrorMessage()}
@@ -100,7 +105,7 @@ FieldsetSprocket.propTypes = {
   description: PropTypes.string,
   errorMessage: PropTypes.shape({
     type: PropTypes.string.isRequired,
-    params: PropTypes.shape().isRequired,
+    params: PropTypes.shape({}).isRequired,
     uri: PropTypes.string.isRequired
   })
 }

package/src/sprockets/fieldset/title/index.cjs

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

package/src/sprockets/fieldset/title/index.d.mts

@@ -1,9 +1,13 @@
 declare module '#sprockets/sprockets/fieldset/title' {
   import Title from '#sprockets/components/title'
 
-  export default class FieldsetTitle extends Title {}
+  type FieldsetProps = SprocketsTypes.Components.Title.Fieldset.FieldsetProps
+
+  export default class FieldsetTitle<P extends FieldsetProps> extends Title<P> {}
 }
 
 declare module 'shinkansen-sprockets/sprockets/fieldset/title' {
+  export type FieldsetProps = SprocketsTypes.Components.Title.Fieldset.FieldsetProps
+
   export { default } from '#sprockets/sprockets/fieldset/title'
 }

package/src/sprockets/fieldset/title/index.jsx

@@ -1,15 +1,19 @@
+/**
+ *  @typedef {SprocketsTypes.Components.Title.TitleProps} TitleProps
+ *  @typedef {SprocketsTypes.Components.Title.Fieldset.FieldsetProps} FieldsetProps
+ */
+
 /**
  * FieldsetTitle component
  */
 import classnames from 'classnames'
 import Title from '#sprockets/components/title'
 
+/**
+ *  @extends {Title<TitleProps & FieldsetProps>}
+ */
 export default class FieldsetTitle extends Title {
   getClassName () {
     return classnames(super.getClassName(), 'fieldset')
   }
 }
-
-FieldsetTitle.propTypes = {
-  ...Title.propTypes
-}