shinkansen-sprockets 1.2.21 → 1.3.0

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

@@ -1,15 +1,15 @@
 /**
- *  @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
+ *  @typedef {SprocketsTypes.Super.Components.Group.GroupProps} GroupProps
+ *  @typedef {SprocketsTypes.Super.Components.Group.GroupState} GroupState
+ *  @typedef {SprocketsTypes.Sprockets.Fieldset.Group.FieldsetProps} FieldsetProps
+ *  @typedef {SprocketsTypes.Sprockets.Fieldset.Group.FieldsetState} FieldsetState
  */
 
 /**
- * FieldsetGroup component
+ *  FieldsetGroup component
  */
 import classnames from 'classnames'
-import Group from '#sprockets/components/group'
+import Group from '#sprockets/super/components/group'
 
 /**
  *  @extends {Group<GroupProps & FieldsetProps, GroupState & FieldsetState>}

package/src/sprockets/fieldset/index.cjs

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

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

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

package/src/sprockets/fieldset/index.jsx

@@ -1,10 +1,10 @@
 /**
- *  @typedef {SprocketsTypes.Sprockets.Sprocket.SprocketProps} SprocketProps
- *  @typedef {SprocketsTypes.Sprockets.Sprocket.Fieldset.FieldsetProps} FieldsetProps
+ *  @typedef {SprocketsTypes.Sprockets.SprocketProps} SprocketProps
+ *  @typedef {SprocketsTypes.Sprockets.Fieldset.FieldsetProps} FieldsetProps
  */
 
 /**
- * FieldsetSprocket component
+ *  FieldsetSprocket component
  */
 import React from 'react'
 import PropTypes from 'prop-types'

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

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

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

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

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

@@ -1,13 +1,14 @@
 /**
- *  @typedef {SprocketsTypes.Components.Title.TitleProps} TitleProps
- *  @typedef {SprocketsTypes.Components.Title.Fieldset.FieldsetProps} FieldsetProps
+ *  @typedef {SprocketsTypes.Super.Components.Title.TitleProps} TitleProps
+ *  @typedef {SprocketsTypes.Sprockets.Fieldset.Title.FieldsetProps} FieldsetProps
  */
 
 /**
- * FieldsetTitle component
+ *  FieldsetTitle component
  */
 import classnames from 'classnames'
-import Title from '#sprockets/components/title'
+
+import Title from '#sprockets/super/components/title'
 
 /**
  *  @extends {Title<TitleProps & FieldsetProps>}

package/src/sprockets/index.cjs

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

package/src/sprockets/index.d.mts

@@ -1,19 +1,6 @@
 declare module '#sprockets/sprockets' {
-  import React from 'react'
-
-  export 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
-
-    renderTitle (): React.JSX.Element | null
-
-    renderGroup (): React.JSX.Element | null
-  }
+  export { default } from '#sprockets/super/sprockets'
+  export * from '#sprockets/super/sprockets'
 }
 
 declare module 'shinkansen-sprockets/sprockets' {

package/src/sprockets/index.jsx

@@ -1,79 +1,5 @@
 /**
- *  @typedef {SprocketsTypes.Sprockets.Sprocket.SprocketProps} SprocketProps
+ *  Sprocket component
  */
 
-/**
- * Sprocket component
- */
-import React, { Component } from 'react'
-import PropTypes from 'prop-types'
-
-import Title from '#sprockets/components/title'
-import Group from '#sprockets/components/group'
-
-export default class Sprocket extends Component {
-  getClassName () {
-    return 'sprocket'
-  }
-
-  /**
-   *  @param {SprocketProps} props
-   *  @returns {boolean}
-   */
-  shouldComponentUpdate (props) {
-    return (
-      (props.children !== this.props.children) ||
-      (props.title !== this.props.title)
-    )
-  }
-
-  renderTitle () {
-    const {
-      title
-    } = this.props
-
-    return (
-      <Title
-        title={title}
-      />
-    )
-  }
-
-  renderGroup () {
-    const {
-      groupRef,
-      children
-    } = this.props
-
-    return (
-      <Group
-        groupRef={groupRef}>
-        {this.renderTitle()}
-        {children}
-      </Group>
-    )
-  }
-
-  render () {
-    const className = this.getClassName()
-
-    return (
-      <div className={className}>
-        {this.renderGroup()}
-      </div>
-    )
-  }
-}
-
-Sprocket.propTypes = {
-  title: PropTypes.string,
-  children: PropTypes.oneOfType([
-    PropTypes.node,
-    PropTypes.arrayOf(
-      PropTypes.node
-    )
-  ]),
-  groupRef: PropTypes.shape({
-    current: PropTypes.shape({}).isRequired
-  })
-}
+export { default } from '#sprockets/super/sprockets'

package/src/super/components/description/index.cjs

@@ -0,0 +1,20 @@
+require('@babel/register')({
+  ignore: [
+    /node_modules\/(?!shinkansen|@modernpoacher)/
+  ]
+})
+
+const debug = require('debug')
+
+const log = debug('shinkansen-sprockets/components/description')
+
+log('`shinkansen` is awake')
+
+const {
+  default: Description // @ts-expect-error
+} = require('./index.jsx')
+
+/**
+ *  Exports only default
+ */
+module.exports = Description

package/src/super/components/description/index.d.cts

@@ -0,0 +1,2 @@
+export { default } from '#sprockets/super/components/description'
+export * from '#sprockets/super/components/description'

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

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

package/src/super/components/description/index.jsx

@@ -0,0 +1,47 @@
+/**
+ *  @typedef {SprocketsTypes.Super.Components.Description.DescriptionProps} DescriptionProps
+ */
+
+/**
+ *  Description component
+ */
+import React, { Component } from 'react'
+import PropTypes from 'prop-types'
+
+import TextContent from '#sprockets/components/common/text-content'
+
+export default class Description extends Component {
+  getClassName () {
+    return 'description'
+  }
+
+  /**
+   *  @param {DescriptionProps} props
+   *  @returns {boolean}
+   */
+  shouldComponentUpdate (props) {
+    return (
+      (props.description !== this.props.description)
+    )
+  }
+
+  render () {
+    const {
+      description
+    } = this.props
+
+    if (description) {
+      return (
+        <span className={this.getClassName()}>
+          <TextContent textContent={description} />
+        </span>
+      )
+    }
+
+    return null
+  }
+}
+
+Description.propTypes = {
+  description: PropTypes.string
+}

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

@@ -0,0 +1,20 @@
+require('@babel/register')({
+  ignore: [
+    /node_modules\/(?!shinkansen|@modernpoacher)/
+  ]
+})
+
+const debug = require('debug')
+
+const log = debug('shinkansen-sprockets/super/components/error-message')
+
+log('`shinkansen` is awake')
+
+const {
+  default: ErrorMessage // @ts-expect-error
+} = require('./index.jsx')
+
+/**
+ *  Exports only default
+ */
+module.exports = ErrorMessage

package/src/super/components/error-message/index.d.cts

@@ -0,0 +1,2 @@
+export { default } from '#sprockets/super/components/error-message'
+export * from '#sprockets/super/components/error-message'

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

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

package/src/super/components/error-message/index.jsx

@@ -0,0 +1,121 @@
+/**
+ *  @typedef {SprocketsTypes.ErrorDefinitionType} ErrorDefinitionType
+ *  @typedef {SprocketsTypes.Super.Components.ErrorMessage.ErrorMessageProps} ErrorMessageProps
+ *  @typedef {SprocketsTypes.Super.Components.ErrorMessage.ErrorMessageState} ErrorMessageState
+ */
+
+/**
+ *  ErrorMessage component
+ */
+import React, { Component } from 'react'
+import PropTypes from 'prop-types'
+import equal from 'fast-deep-equal'
+
+import transform from '#sprockets/transformers/error-message'
+
+import TextContent from '#sprockets/components/common/text-content'
+
+export default class ErrorMessage extends Component {
+  /**
+   *  @type {ErrorMessageState}
+   */
+  state = {}
+
+  hasTextContent () {
+    const {
+      errorMessage
+    } = this.props
+
+    const {
+      text
+    } = transform(errorMessage)
+
+    return !!text
+  }
+
+  getTextContent () {
+    const {
+      errorMessage
+    } = this.props
+
+    const {
+      text
+    } = transform(errorMessage)
+
+    return text
+  }
+
+  getClassName () {
+    return 'error-message'
+  }
+
+  /**
+   *  Merge latest `props` to `state`
+   *
+   *  @param {ErrorMessageProps} props   Latest props
+   *  @param {ErrorMessageState} state   Current state
+   *  @returns {ErrorMessageState}
+   */
+  static getDerivedStateFromProps ({ errorMessage }, { errorMessage: E }) {
+    return {
+      errorMessage: equal(errorMessage, E) ? E : errorMessage
+    }
+  }
+
+  /**
+   *  Compare current and latest `state` for changes to `errorMessage`
+   *
+   *  @param {ErrorMessageProps} props   Latest props
+   *  @param {ErrorMessageState} state   Latest state
+   *  @returns {boolean}
+   */
+  shouldComponentUpdate (props, state) {
+    const {
+      errorMessage: e
+    } = state
+
+    const {
+      errorMessage: E
+    } = this.state
+
+    return !equal(E, e)
+  }
+
+  renderTextContent () {
+    if (this.hasTextContent()) {
+      const textContent = this.getTextContent()
+
+      return (
+        <TextContent
+          textContent={textContent}
+        />
+      )
+    }
+
+    return null
+  }
+
+  render () {
+    const {
+      errorMessage
+    } = this.props
+
+    if (errorMessage) {
+      return (
+        <span className={this.getClassName()}>
+          {this.renderTextContent()}
+        </span>
+      )
+    }
+
+    return null
+  }
+}
+
+ErrorMessage.propTypes = {
+  errorMessage: PropTypes.shape({
+    type: PropTypes.string.isRequired,
+    params: PropTypes.shape({}).isRequired,
+    uri: PropTypes.string.isRequired
+  })
+}

package/src/super/components/group/index.cjs

@@ -0,0 +1,20 @@
+require('@babel/register')({
+  ignore: [
+    /node_modules\/(?!shinkansen|@modernpoacher)/
+  ]
+})
+
+const debug = require('debug')
+
+const log = debug('shinkansen-sprockets/super/components/group')
+
+log('`shinkansen` is awake')
+
+const {
+  default: Group // @ts-expect-error
+} = require('./index.jsx')
+
+/**
+ *  Exports only default
+ */
+module.exports = Group

package/src/super/components/group/index.d.cts

@@ -0,0 +1,2 @@
+export { default } from '#sprockets/super/components/group'
+export * from '#sprockets/super/components/group'

package/src/super/components/group/index.d.mts

@@ -0,0 +1,19 @@
+declare module '#sprockets/super/components/group' {
+  import React from 'react'
+
+  export type GroupProps = SprocketsTypes.Super.Components.Group.GroupProps
+  export type GroupState = SprocketsTypes.Super.Components.Group.GroupState
+
+  export default class Group<P extends GroupProps, S extends GroupState> extends React.Component<P, S> {
+    static propTypes: object
+
+    getClassName (): string
+
+    shouldComponentUpdate (props: GroupProps, state: GroupState): boolean
+  }
+}
+
+declare module 'shinkansen-sprockets/super/components/group' {
+  export { default } from '#sprockets/super/components/group'
+  export * from '#sprockets/super/components/group'
+}

package/src/super/components/group/index.jsx

@@ -0,0 +1,52 @@
+/**
+ *  @typedef {SprocketsTypes.Super.Components.Group.GroupProps} GroupProps
+ */
+
+/**
+ *  Group component
+ */
+import React, { Component } from 'react'
+import PropTypes from 'prop-types'
+
+export default class Group extends Component {
+  getClassName () {
+    return 'group'
+  }
+
+  /**
+   *  @param {GroupProps} props
+   *  @returns {boolean}
+   */
+  shouldComponentUpdate (props) {
+    return (
+      (props.children !== this.props.children)
+    )
+  }
+
+  render () {
+    const {
+      groupRef,
+      children
+    } = this.props
+
+    return (
+      <fieldset
+        className={this.getClassName()}
+        ref={groupRef}>
+        {children}
+      </fieldset>
+    )
+  }
+}
+
+Group.propTypes = {
+  children: PropTypes.oneOfType([
+    PropTypes.node,
+    PropTypes.arrayOf(
+      PropTypes.node
+    )
+  ]),
+  groupRef: PropTypes.shape({
+    current: PropTypes.shape({}).isRequired
+  })
+}

package/src/super/components/index.cjs

@@ -0,0 +1,16 @@
+require('@babel/register')({
+  ignore: [
+    /node_modules\/(?!shinkansen|@modernpoacher)/
+  ]
+})
+
+const debug = require('debug')
+
+const log = debug('shinkansen-sprockets/super/components')
+
+log('`shinkansen` is awake')
+
+module.exports.Description = require('./description/index.cjs')
+module.exports.ErrorMessage = require('./error-message/index.cjs')
+module.exports.Group = require('./group/index.cjs')
+module.exports.Title = require('./title/index.cjs')

package/src/super/components/index.d.cts

@@ -0,0 +1,4 @@
+export { default as Description } from '#sprockets/super/components/description'
+export { default as ErrorMessage } from '#sprockets/super/components/error-message'
+export { default as Group } from '#sprockets/super/components/group'
+export { default as Title } from '#sprockets/super/components/title'

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

@@ -0,0 +1,4 @@
+export { default as Description } from '#sprockets/super/components/description'
+export { default as ErrorMessage } from '#sprockets/super/components/error-message'
+export { default as Group } from '#sprockets/super/components/group'
+export { default as Title } from '#sprockets/super/components/title'

package/src/super/components/index.mjs

@@ -0,0 +1,10 @@
+import debug from 'debug'
+
+const log = debug('shinkansen-sprockets/super/components')
+
+log('`shinkansen` is awake')
+
+export { default as Description } from './description/index.cjs'
+export { default as ErrorMessage } from './error-message/index.cjs'
+export { default as Group } from './group/index.cjs'
+export { default as Title } from './title/index.cjs'

package/src/super/components/title/index.cjs

@@ -0,0 +1,20 @@
+require('@babel/register')({
+  ignore: [
+    /node_modules\/(?!shinkansen|@modernpoacher)/
+  ]
+})
+
+const debug = require('debug')
+
+const log = debug('shinkansen-sprockets/super/components/title')
+
+log('`shinkansen` is awake')
+
+const {
+  default: Title // @ts-expect-error
+} = require('./index.jsx')
+
+/**
+ *  Exports only default
+ */
+module.exports = Title

package/src/super/components/title/index.d.cts

@@ -0,0 +1,2 @@
+export { default } from '#sprockets/super/components/title'
+export * from '#sprockets/super/components/title'