@modernpoacher/cogs 0.1.256 → 1.0.0

package/src/{cogs → js/cogs}/checkbox/description/index.cjs

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

package/src/js/cogs/checkbox/description/index.d.cts

@@ -0,0 +1 @@
+export { default } from '#cogs/cogs/checkbox/description'

package/src/{cogs → js/cogs}/checkbox/description/index.jsx

@@ -9,7 +9,3 @@ export default class CheckboxDescription extends Description {
     return classnames(super.getClassName(), 'checkbox')
   }
 }
-
-CheckboxDescription.propTypes = {
-  ...Description.propTypes
-}

package/src/{cogs → js/cogs}/checkbox/error-message/index.cjs

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

package/src/js/cogs/checkbox/error-message/index.d.cts

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

package/src/{cogs → js/cogs}/checkbox/error-message/index.jsx

@@ -9,7 +9,3 @@ export default class CheckboxErrorMessage extends ErrorMessage {
     return classnames(super.getClassName(), 'checkbox')
   }
 }
-
-CheckboxErrorMessage.propTypes = {
-  ...ErrorMessage.propTypes
-}

package/src/{cogs → js/cogs}/checkbox/field/index.cjs

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

package/src/js/cogs/checkbox/field/index.d.cts

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

package/src/js/cogs/checkbox/field/index.d.mts

@@ -0,0 +1,14 @@
+declare module '#cogs/cogs/checkbox/field' {
+  import {
+    CheckField
+  } from '#cogs/components/field'
+
+  export type CheckboxProps = CogsTypes.Components.Field.Checkbox.CheckboxProps
+
+  export default class CheckboxField<P extends CheckboxProps> extends CheckField<P> {}
+}
+
+declare module '@modernpoacher/cogs/cogs/checkbox/field' {
+  export { default } from '#cogs/cogs/checkbox/field'
+  export * from '#cogs/cogs/checkbox/field'
+}

package/src/{cogs → js/cogs}/checkbox/field/index.jsx

@@ -1,12 +1,23 @@
 /**
- * CheckboxField component
+ *  @typedef {CogsTypes.Components.Field.CheckProps} CheckProps
+ *  @typedef {CogsTypes.Components.Field.Checkbox.CheckboxProps} CheckboxProps
+ */
+
+/**
+ *  CheckboxField component
  */
 import React from 'react'
 import PropTypes from 'prop-types'
 import classnames from 'classnames'
 
-import { CheckField } from '#cogs/components/field'
+import {
+  CheckField,
+  toInputValue
+} from '#cogs/components/field'
 
+/**
+ *  @extends {CheckField<CheckProps & CheckboxProps>}
+ */
 export default class CheckboxField extends CheckField {
   getClassName () {
     return classnames(super.getClassName(), 'checkbox')
@@ -14,10 +25,10 @@ export default class CheckboxField extends CheckField {
 
   render () {
     const {
-      checked,
-      id,
       name,
+      id,
       value,
+      checked,
       required = false,
       disabled = false,
       readOnly = false,
@@ -31,10 +42,10 @@ export default class CheckboxField extends CheckField {
     if (typeof checked === 'boolean') {
       return (
         <input
-          checked={checked}
-          id={id}
           name={name}
-          value={value}
+          id={id}
+          value={toInputValue(value)}
+          checked={checked}
           required={required}
           disabled={disabled}
           readOnly={readOnly}
@@ -55,10 +66,10 @@ export default class CheckboxField extends CheckField {
 
     return (
       <input
-        defaultChecked={defaultChecked}
-        id={id}
         name={name}
-        value={value}
+        id={id}
+        value={toInputValue(value)}
+        defaultChecked={defaultChecked}
         required={required}
         disabled={disabled}
         readOnly={readOnly}

package/src/{cogs → js/cogs}/checkbox/index.cjs

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

package/src/js/cogs/checkbox/index.d.cts

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

package/src/js/cogs/checkbox/index.d.mts

@@ -0,0 +1,24 @@
+declare module '#cogs/cogs/checkbox' {
+  import {
+    CheckCog
+  } from '#cogs/cogs'
+
+  export type CheckboxProps = CogsTypes.Cogs.Checkbox.CheckboxProps
+
+  export default class CheckboxCog<P extends CheckboxProps> extends CheckCog<P> {
+    handleChange (
+      value?: string | string[],
+      checked?: boolean
+    ): void
+
+    handleClick (
+      value?: string | string[],
+      checked?: boolean
+    ): void
+  }
+}
+
+declare module '@modernpoacher/cogs/cogs/checkbox' {
+  export { default } from '#cogs/cogs/checkbox'
+  export * from '#cogs/cogs/checkbox'
+}

package/src/{cogs → js/cogs}/checkbox/index.jsx

@@ -1,50 +1,63 @@
 /**
- * CheckboxCog component
+ *  @typedef {CogsTypes.OnEventType} OnEventType
+ *  @typedef {CogsTypes.Cogs.CheckProps} CheckProps
+ *  @typedef {CogsTypes.Cogs.Checkbox.CheckboxProps} CheckboxProps
+ */
+
+/**
+ *  CheckboxCog component
  */
 import React from 'react'
-import PropTypes from 'prop-types'
 import classnames from 'classnames'
 
-import { CheckCog } from '#cogs/cogs'
-
 import {
-  DEFAULT_HANDLE_CHANGE,
-  DEFAULT_HANDLE_CLICK
-} from '#cogs/common'
+  CheckCog
+} from '#cogs/cogs'
 
-import Title from './title/index.jsx'
-import Description from './description/index.jsx'
-import ErrorMessage from './error-message/index.jsx'
-import Field from './field/index.jsx'
+import Title from '#cogs/cogs/checkbox/title'
+import Description from '#cogs/cogs/checkbox/description'
+import ErrorMessage from '#cogs/cogs/checkbox/error-message'
+import Field from '#cogs/cogs/checkbox/field'
 
+/**
+ *  @type {OnEventType}
+ */
+function DEFAULT_HANDLE_EVENT () {
+  //
+}
+
+/**
+ *  @extends {CheckCog<CheckProps & CheckboxProps>}
+ */
 export default class CheckboxCog extends CheckCog {
   getClassName () {
     return classnames(super.getClassName(), 'checkbox')
   }
 
+  /**
+   *  @param {string | string[]} [value]
+   *  @param {boolean} [checked]
+   */
   handleChange = (value, checked) => {
     const {
-      onChange = DEFAULT_HANDLE_CHANGE
+      onChange = DEFAULT_HANDLE_EVENT
     } = this.props
 
     onChange(value, checked)
   }
 
+  /**
+   *  @param {string | string[]} [value]
+   *  @param {boolean} [checked]
+   */
   handleClick = (value, checked) => {
     const {
-      onClick = DEFAULT_HANDLE_CLICK
+      onClick = DEFAULT_HANDLE_EVENT
     } = this.props
 
     onClick(value, checked)
   }
 
-  shouldComponentUpdate (props, state) {
-    return (
-      super.shouldComponentUpdate(props) ||
-      (props.value !== this.props.value)
-    )
-  }
-
   renderTitle () {
     const id = this.getId()
 
@@ -109,8 +122,8 @@ export default class CheckboxCog extends CheckCog {
 
     return (
       <Field
-        id={id}
         name={name}
+        id={id}
         value={value}
         checked={checked}
         defaultChecked={defaultChecked}
@@ -140,8 +153,3 @@ export default class CheckboxCog extends CheckCog {
     )
   }
 }
-
-CheckboxCog.propTypes = {
-  ...CheckCog.propTypes,
-  value: PropTypes.string.isRequired
-}

package/src/{cogs → js/cogs}/checkbox/title/index.cjs

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

package/src/js/cogs/checkbox/title/index.d.cts

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

package/src/{cogs → js/cogs}/checkbox/title/index.d.mts

@@ -1,9 +1,12 @@
 declare module '#cogs/cogs/checkbox/title' {
   import Title from '#cogs/components/title'
 
-  export default class CheckboxTitle extends Title {}
+  export type CheckboxProps = CogsTypes.Components.Title.Checkbox.CheckboxProps
+
+  export default class CheckboxTitle<P extends CheckboxProps> extends Title<P> {}
 }
 
 declare module '@modernpoacher/cogs/cogs/checkbox/title' {
   export { default } from '#cogs/cogs/checkbox/title'
+  export * from '#cogs/cogs/checkbox/title'
 }

package/src/{cogs → js/cogs}/checkbox/title/index.jsx

@@ -1,15 +1,19 @@
+/**
+ *  @typedef {CogsTypes.Super.Components.Title.TitleProps} TitleProps
+ *  @typedef {CogsTypes.Components.Title.Checkbox.CheckboxProps} CheckboxProps
+ */
+
 /**
  * CheckboxTitle component
  */
 import classnames from 'classnames'
 import Title from '#cogs/components/title'
 
+/**
+ *  @extends {Title<TitleProps & CheckboxProps>}
+ */
 export default class CheckboxTitle extends Title {
   getClassName () {
     return classnames(super.getClassName(), 'checkbox')
   }
 }
-
-CheckboxTitle.propTypes = {
-  ...Title.propTypes
-}

package/src/{cogs → js/cogs}/email/description/index.cjs

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

package/src/js/cogs/email/description/index.d.cts

@@ -0,0 +1 @@
+export { default } from '#cogs/cogs/email/description'

package/src/{cogs → js/cogs}/email/description/index.jsx

@@ -9,7 +9,3 @@ export default class EmailDescription extends Description {
     return classnames(super.getClassName(), 'email')
   }
 }
-
-EmailDescription.propTypes = {
-  ...Description.propTypes
-}

package/src/{cogs → js/cogs}/email/error-message/index.cjs

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

package/src/js/cogs/email/error-message/index.d.cts

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

package/src/{cogs → js/cogs}/email/error-message/index.jsx

@@ -9,7 +9,3 @@ export default class EmailErrorMessage extends ErrorMessage {
     return classnames(super.getClassName(), 'email')
   }
 }
-
-EmailErrorMessage.propTypes = {
-  ...ErrorMessage.propTypes
-}

package/src/{cogs → js/cogs}/email/field/index.cjs

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

package/src/js/cogs/email/field/index.d.cts

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

package/src/js/cogs/email/field/index.d.mts

@@ -0,0 +1,14 @@
+declare module '#cogs/cogs/email/field' {
+  import {
+    ValueField
+  } from '#cogs/components/field'
+
+  export type EmailProps = CogsTypes.Components.Field.Email.EmailProps
+
+  export default class EmailField<P extends EmailProps> extends ValueField<P> {}
+}
+
+declare module '@modernpoacher/cogs/cogs/email/field' {
+  export { default } from '#cogs/cogs/email/field'
+  export * from '#cogs/cogs/email/field'
+}

package/src/js/cogs/email/field/index.jsx

@@ -0,0 +1,83 @@
+/**
+ *  @typedef {CogsTypes.Components.Field.ValueProps} ValueProps
+ *  @typedef {CogsTypes.Components.Field.Email.EmailProps} EmailProps
+ */
+
+/**
+ *  EmailField component
+ */
+import React from 'react'
+import classnames from 'classnames'
+
+import {
+  ValueField,
+  toInputValue
+} from '#cogs/components/field'
+
+/**
+ *  @extends {ValueField<ValueProps & EmailProps>}
+ */
+export default class EmailField extends ValueField {
+  getClassName () {
+    return classnames(super.getClassName(), 'email')
+  }
+
+  render () {
+    const {
+      name,
+      id,
+      defaultValue,
+      required = false,
+      disabled = false,
+      readOnly = false,
+      tabIndex,
+      accessKey,
+      placeholder,
+      fieldRef
+    } = this.props
+
+    const className = this.getClassName()
+
+    if (defaultValue === undefined) {
+      const {
+        value
+      } = this.props
+
+      return (
+        <input
+          name={name}
+          id={id}
+          value={toInputValue(value)}
+          required={required}
+          disabled={disabled}
+          readOnly={readOnly}
+          tabIndex={tabIndex}
+          accessKey={accessKey}
+          placeholder={placeholder}
+          onChange={this.handleChange}
+          className={className}
+          type='email'
+          ref={fieldRef}
+        />
+      )
+    }
+
+    return (
+      <input
+        name={name}
+        id={id}
+        defaultValue={String(defaultValue)}
+        required={required}
+        disabled={disabled}
+        readOnly={readOnly}
+        tabIndex={tabIndex}
+        accessKey={accessKey}
+        placeholder={placeholder}
+        onChange={this.handleChange}
+        className={className}
+        type='email'
+        ref={fieldRef}
+      />
+    )
+  }
+}

package/src/{cogs → js/cogs}/email/index.cjs

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

package/src/js/cogs/email/index.d.cts

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

package/src/js/cogs/email/index.d.mts

@@ -0,0 +1,18 @@
+declare module '#cogs/cogs/email' {
+  import {
+    ValueCog
+  } from '#cogs/cogs'
+
+  export type EmailProps = CogsTypes.Cogs.Email.EmailProps
+
+  export default class EmailCog<P extends EmailProps> extends ValueCog<P> {
+    handleChange (
+      value?: string | string[]
+    ): void
+  }
+}
+
+declare module '@modernpoacher/cogs/cogs/email' {
+  export { default } from '#cogs/cogs/email'
+  export * from '#cogs/cogs/email'
+}

package/src/{cogs → js/cogs}/email/index.jsx

@@ -1,28 +1,45 @@
 /**
- * EmailCog component
+ *  @typedef {CogsTypes.OnEventType} OnEventType
+ *  @typedef {CogsTypes.Cogs.ValueProps} ValueProps
+ *  @typedef {CogsTypes.Cogs.Email.EmailProps} EmailProps
+ */
+
+/**
+ *  EmailCog component
  */
 import React from 'react'
 import classnames from 'classnames'
 
-import { ValueCog } from '#cogs/cogs'
-
 import {
-  DEFAULT_HANDLE_CHANGE
-} from '#cogs/common'
+  ValueCog
+} from '#cogs/cogs'
 
-import Title from './title/index.jsx'
-import Description from './description/index.jsx'
-import ErrorMessage from './error-message/index.jsx'
-import Field from './field/index.jsx'
+import Title from '#cogs/cogs/email/title'
+import Description from '#cogs/cogs/email/description'
+import ErrorMessage from '#cogs/cogs/email/error-message'
+import Field from '#cogs/cogs/email/field'
+
+/**
+ *  @type {OnEventType}
+ */
+function DEFAULT_HANDLE_EVENT () {
+  //
+}
 
+/**
+ *  @extends {ValueCog<ValueProps & EmailProps>}
+ */
 export default class EmailCog extends ValueCog {
   getClassName () {
     return classnames(super.getClassName(), 'email')
   }
 
+  /**
+   *  @param {string | string[]} [value]
+   */
   handleChange = (value) => {
     const {
-      onChange = DEFAULT_HANDLE_CHANGE
+      onChange = DEFAULT_HANDLE_EVENT
     } = this.props
 
     onChange(value)
@@ -91,8 +108,8 @@ export default class EmailCog extends ValueCog {
 
     return (
       <Field
-        id={id}
         name={name}
+        id={id}
         value={value}
         defaultValue={defaultValue}
         required={required}
@@ -107,7 +124,3 @@ export default class EmailCog extends ValueCog {
     )
   }
 }
-
-EmailCog.propTypes = {
-  ...ValueCog.propTypes
-}

package/src/{cogs → js/cogs}/email/title/index.cjs

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

package/src/js/cogs/email/title/index.d.cts

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

package/src/{cogs → js/cogs}/email/title/index.d.mts

@@ -1,9 +1,12 @@
 declare module '#cogs/cogs/email/title' {
   import Title from '#cogs/components/title'
 
-  export default class EmailTitle extends Title {}
+  export type EmailProps = CogsTypes.Components.Title.Email.EmailProps
+
+  export default class EmailTitle<P extends EmailProps> extends Title<P> {}
 }
 
 declare module '@modernpoacher/cogs/cogs/email/title' {
   export { default } from '#cogs/cogs/email/title'
+  export * from '#cogs/cogs/email/title'
 }