@modernpoacher/sprockets 0.0.288 → 1.0.0

package/src/{sprockets → js/sprockets}/fieldset/description/index.jsx

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

package/src/{sprockets → js/sprockets}/fieldset/error-message/index.cjs

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

package/src/js/sprockets/fieldset/error-message/index.d.cts

@@ -0,0 +1 @@
+export { default } from '#sprockets/sprockets/fieldset/error-message'

package/src/{sprockets → js/sprockets}/fieldset/error-message/index.d.mts

@@ -1,5 +1,5 @@
 declare module '#sprockets/sprockets/fieldset/error-message' {
-  import ErrorMessage from '#sprockets/components/error-message'
+  import ErrorMessage from '#sprockets/super/components/error-message'
 
   export default class FieldsetErrorMessage extends ErrorMessage {}
 }

package/src/{sprockets → js/sprockets}/fieldset/error-message/index.jsx

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

package/src/{sprockets → js/sprockets}/fieldset/group/index.cjs

@@ -11,7 +11,10 @@ const log = debug('@modernpoacher/sprockets/sprockets/fieldset/group')
 log('`sprockets` is awake')
 
 const {
-  default: component
+  default: Group
 } = require('./index.jsx')
 
-module.exports = component
+/**
+ *  Exports only default
+ */
+module.exports = Group

package/src/js/sprockets/fieldset/group/index.d.cts

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

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

@@ -0,0 +1,13 @@
+declare module '#sprockets/sprockets/fieldset/group' {
+  import Group from '#sprockets/super/components/group'
+
+  export type FieldsetProps = SprocketsTypes.Sprockets.Fieldset.Group.FieldsetProps
+  export type FieldsetState = SprocketsTypes.Sprockets.Fieldset.Group.FieldsetState
+
+  export default class FieldsetGroup<P extends FieldsetProps, S extends FieldsetState> extends Group<P, S> {}
+}
+
+declare module '@modernpoacher/sprockets/sprockets/fieldset/group' {
+  export { default } from '#sprockets/sprockets/fieldset/group'
+  export * from '#sprockets/sprockets/fieldset/group'
+}

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

@@ -0,0 +1,21 @@
+/**
+ *  @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
+ */
+import classnames from 'classnames'
+import Group from '#sprockets/super/components/group'
+
+/**
+ *  @extends {Group<GroupProps & FieldsetProps, GroupState & FieldsetState>}
+ */
+export default class FieldsetGroup extends Group {
+  getClassName () {
+    return classnames(super.getClassName(), 'fieldset')
+  }
+}

package/src/{sprockets → js/sprockets}/fieldset/index.cjs

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

package/src/js/sprockets/fieldset/index.d.cts

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

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

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

package/src/{sprockets → js/sprockets}/fieldset/index.jsx

@@ -1,25 +1,25 @@
 /**
- * FieldsetSprocket component
- *
- * @typedef {import('@modernpoacher/sprockets/sprockets').SprocketProps} SprocketProps
+ *  @typedef {SprocketsTypes.Sprockets.SprocketProps} SprocketProps
+ *  @typedef {SprocketsTypes.Sprockets.Fieldset.FieldsetProps} FieldsetProps
  */
 
+/**
+ *  FieldsetSprocket component
+ */
 import React from 'react'
 import PropTypes from 'prop-types'
-
 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'
+import Title from '#sprockets/sprockets/fieldset/title'
+import Description from '#sprockets/sprockets/fieldset/description'
+import ErrorMessage from '#sprockets/sprockets/fieldset/error-message'
+import Group from '#sprockets/sprockets/fieldset/group'
 
+/**
+ *  @extends {Sprocket<SprocketProps & FieldsetProps>}
+ */
 export default class FieldsetSprocket extends Sprocket {
   getClassName () {
     const {
@@ -30,14 +30,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 +85,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()}
@@ -98,9 +102,5 @@ export default class FieldsetSprocket extends Sprocket {
 FieldsetSprocket.propTypes = {
   ...Sprocket.propTypes,
   description: PropTypes.string,
-  errorMessage: PropTypes.shape({
-    type: PropTypes.string.isRequired,
-    params: PropTypes.shape().isRequired,
-    uri: PropTypes.string.isRequired
-  })
+  errorMessage: PropTypes.string
 }

package/src/{sprockets → js/sprockets}/fieldset/title/index.cjs

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

package/src/js/sprockets/fieldset/title/index.d.cts

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

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

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

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

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

package/src/{sprockets → js/sprockets}/index.cjs

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

package/src/js/sprockets/index.d.cts

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

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

@@ -0,0 +1,9 @@
+declare module '#sprockets/sprockets' {
+  export { default } from '#sprockets/super/sprockets'
+  export * from '#sprockets/super/sprockets'
+}
+
+declare module '@modernpoacher/sprockets/sprockets' {
+  export { default } from '#sprockets/sprockets'
+  export * from '#sprockets/sprockets'
+}

package/src/js/sprockets/index.jsx

@@ -0,0 +1,5 @@
+/**
+ *  Sprocket component
+ */
+
+export { default } from '#sprockets/super/sprockets'

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

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

package/src/js/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/js/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 '@modernpoacher/sprockets/super/components/description' {
+  export { default } from '#sprockets/super/components/description'
+  export * from '#sprockets/super/components/description'
+}

package/src/{components → js/super/components}/description/index.jsx

@@ -1,25 +1,37 @@
 /**
- * Description component
+ *  @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'
 
+/**
+ *  @extends {Component<DescriptionProps>}
+ */
 export default class Description extends Component {
   getClassName () {
     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/js/super/components/error-message/index.cjs

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

package/src/js/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/js/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 '@modernpoacher/sprockets/super/components/error-message' {
+  export { default } from '#sprockets/super/components/error-message'
+  export * from '#sprockets/super/components/error-message'
+}

package/src/{components → js/super/components}/error-message/index.jsx

@@ -1,5 +1,4 @@
 /**
- *  @typedef {SprocketsTypes.ErrorDefinitionType} ErrorDefinitionType
  *  @typedef {SprocketsTypes.Super.Components.ErrorMessage.ErrorMessageProps} ErrorMessageProps
  *  @typedef {SprocketsTypes.Super.Components.ErrorMessage.ErrorMessageState} ErrorMessageState
  */
@@ -7,7 +6,6 @@
 /**
  *  ErrorMessage component
  */
-
 import React, { Component } from 'react'
 import PropTypes from 'prop-types'
 
@@ -29,20 +27,24 @@ export default class ErrorMessage extends Component {
   /**
    *  Compare current and latest `props` for changes to `errorMessage`
    *
-   *  @param {{errorMessage?: string}} props   Latest props
+   *  @param {ErrorMessageProps} props   Latest props
    *  @returns {boolean}
    */
-  shouldComponentUpdate (props, state) {
+  shouldComponentUpdate (props) {
     return (props.errorMessage !== this.props.errorMessage)
   }
 
   render () {
-    const { errorMessage } = this.props
+    const {
+      errorMessage
+    } = this.props
 
     if (errorMessage) {
       return (
         <span className={this.getClassName()}>
-          <TextContent textContent={errorMessage} />
+          <TextContent
+            textContent={errorMessage}
+          />
         </span>
       )
     }

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

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

package/src/js/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/js/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 '@modernpoacher/sprockets/super/components/group' {
+  export { default } from '#sprockets/super/components/group'
+  export * from '#sprockets/super/components/group'
+}

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

@@ -0,0 +1,59 @@
+/**
+ *  @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 {
+      children
+    } = this.props
+
+    if (children) {
+      const {
+        groupRef
+      } = this.props
+
+      return (
+        <fieldset
+          className={this.getClassName()}
+          ref={groupRef}>
+          {children}
+        </fieldset>
+      )
+    }
+
+    return null
+  }
+}
+
+Group.propTypes = {
+  children: PropTypes.oneOfType([
+    PropTypes.node,
+    PropTypes.arrayOf(
+      PropTypes.node
+    )
+  ]),
+  groupRef: PropTypes.shape({
+    current: PropTypes.shape({})
+  })
+}

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

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