@modernpoacher/cogs 0.1.256 → 1.0.0

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

@@ -1,28 +1,45 @@
 /**
- * TextCog component
+ *  @typedef {CogsTypes.OnEventType} OnEventType
+ *  @typedef {CogsTypes.Cogs.ValueProps} ValueProps
+ *  @typedef {CogsTypes.Cogs.Text.TextProps} TextProps
+ */
+
+/**
+ *  TextCog 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/text/title'
+import Description from '#cogs/cogs/text/description'
+import ErrorMessage from '#cogs/cogs/text/error-message'
+import Field from '#cogs/cogs/text/field'
+
+/**
+ *  @type {OnEventType}
+ */
+function DEFAULT_HANDLE_EVENT () {
+  //
+}
 
+/**
+ *  @extends {ValueCog<ValueProps & TextProps>}
+ */
 export default class TextCog extends ValueCog {
   getClassName () {
     return classnames(super.getClassName(), 'text')
   }
 
+  /**
+   *  @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 TextCog extends ValueCog {
 
     return (
       <Field
-        id={id}
         name={name}
+        id={id}
         value={value}
         defaultValue={defaultValue}
         required={required}
@@ -107,11 +124,3 @@ export default class TextCog extends ValueCog {
     )
   }
 }
-
-TextCog.propTypes = {
-  ...ValueCog.propTypes
-}
-
-TextCog.defaultProps = {
-  ...ValueCog.defaultProps
-}

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

@@ -11,7 +11,10 @@ const log = debug('@modernpoacher/cogs/cogs/text/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/text/title/index.d.cts

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

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

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

package/src/js/cogs/text/title/index.jsx

@@ -0,0 +1,19 @@
+/**
+ *  @typedef {CogsTypes.Super.Components.Title.TitleProps} TitleProps
+ *  @typedef {CogsTypes.Components.Title.Text.TextProps} TextProps
+ */
+
+/**
+ *  TextTitle component
+ */
+import classnames from 'classnames'
+import Title from '#cogs/components/title'
+
+/**
+ *  @extends {Title<TitleProps & TextProps>}
+ */
+export default class TextTitle extends Title {
+  getClassName () {
+    return classnames(super.getClassName(), 'text')
+  }
+}

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

@@ -11,7 +11,10 @@ const log = debug('@modernpoacher/cogs/cogs/textarea/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/textarea/description/index.d.cts

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

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

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

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

@@ -11,7 +11,10 @@ const log = debug('@modernpoacher/cogs/cogs/textarea/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/textarea/error-message/index.d.cts

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

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

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

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

@@ -11,7 +11,10 @@ const log = debug('@modernpoacher/cogs/cogs/textarea/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/textarea/field/index.d.cts

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

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

@@ -0,0 +1,18 @@
+declare module '#cogs/cogs/textarea/field' {
+  import type { ChangeEvent } from 'react'
+
+  import {
+    ValueField
+  } from '#cogs/components/field'
+
+  export type TextareaProps = CogsTypes.Components.Field.Textarea.TextareaProps
+
+  export default class TextareaField<P extends TextareaProps> extends ValueField<P> {
+    handleChange (event: ChangeEvent<HTMLTextAreaElement>): void
+  }
+}
+
+declare module '@modernpoacher/cogs/cogs/textarea/field' {
+  export { default } from '#cogs/cogs/textarea/field'
+  export * from '#cogs/cogs/textarea/field'
+}

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

@@ -1,11 +1,22 @@
+/**
+ *  @typedef {CogsTypes.Components.Field.ValueProps} ValueProps
+ *  @typedef {CogsTypes.Components.Field.Textarea.TextareaProps} TextareaProps
+ */
+
 /**
  * TextareaField component
  */
 import React from 'react'
 import classnames from 'classnames'
 
-import { ValueField } from '#cogs/components/field'
+import {
+  ValueField,
+  toInputValue
+} from '#cogs/components/field'
 
+/**
+ *  @extends {ValueField<ValueProps & TextareaProps>}
+ */
 export default class TextareaField extends ValueField {
   getClassName () {
     return classnames(super.getClassName(), 'textarea')
@@ -13,9 +24,8 @@ export default class TextareaField extends ValueField {
 
   render () {
     const {
-      id,
       name,
-      value,
+      id,
       defaultValue,
       required = false,
       disabled = false,
@@ -28,12 +38,34 @@ export default class TextareaField extends ValueField {
 
     const className = this.getClassName()
 
+    if (defaultValue === undefined) {
+      const {
+        value
+      } = this.props
+
+      return (
+        <textarea
+          name={name}
+        id={id}
+          value={toInputValue(value)}
+          required={required}
+          disabled={disabled}
+          readOnly={readOnly}
+          tabIndex={tabIndex}
+          accessKey={accessKey}
+          placeholder={placeholder}
+          onChange={this.handleChange}
+          className={className}
+          ref={fieldRef}
+        />
+      )
+    }
+
     return (
       <textarea
-        id={id}
         name={name}
-        value={value}
-        defaultValue={defaultValue}
+        id={id}
+        defaultValue={String(defaultValue)}
         required={required}
         disabled={disabled}
         readOnly={readOnly}
@@ -47,7 +79,3 @@ export default class TextareaField extends ValueField {
     )
   }
 }
-
-TextareaField.propTypes = {
-  ...ValueField.propTypes
-}

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

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

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

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

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

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

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

@@ -1,28 +1,45 @@
+/**
+ *  @typedef {CogsTypes.OnEventType} OnEventType
+ *  @typedef {CogsTypes.Cogs.ValueProps} ValueProps
+ *  @typedef {CogsTypes.Cogs.Textarea.TextareaProps} TextareaProps
+ */
+
 /**
  * TextareaCog 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/textarea/title'
+import Description from '#cogs/cogs/textarea/description'
+import ErrorMessage from '#cogs/cogs/textarea/error-message'
+import Field from '#cogs/cogs/textarea/field'
+
+/**
+ *  @type {OnEventType}
+ */
+function DEFAULT_HANDLE_EVENT () {
+  //
+}
 
+/**
+ *  @extends {ValueCog<ValueProps & TextareaProps>}
+ */
 export default class TextareaCog extends ValueCog {
   getClassName () {
     return classnames(super.getClassName(), 'textarea')
   }
 
+  /**
+   *  @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 TextareaCog extends ValueCog {
 
     return (
       <Field
-        id={id}
         name={name}
+        id={id}
         value={value}
         defaultValue={defaultValue}
         required={required}
@@ -107,7 +124,3 @@ export default class TextareaCog extends ValueCog {
     )
   }
 }
-
-TextareaCog.propTypes = {
-  ...ValueCog.propTypes
-}

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

@@ -11,7 +11,10 @@ const log = debug('@modernpoacher/cogs/cogs/textarea/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/textarea/title/index.d.cts

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

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

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

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

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

package/src/{components → js/components}/common/disabled/index.cjs

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

package/src/js/components/common/disabled/index.d.cts

@@ -0,0 +1 @@
+export { default } from '#cogs/components/common/disabled'

package/src/js/components/common/disabled/index.jsx

@@ -0,0 +1,11 @@
+import React from 'react'
+
+const DISABLED = String.fromCharCode(42)
+
+export default function Disabled () {
+  return (
+    <span className='is-disabled'>
+      {DISABLED}
+    </span>
+  )
+}

package/src/{components → js/components}/common/readonly/index.cjs

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

package/src/js/components/common/readonly/index.d.cts

@@ -0,0 +1 @@
+export { default } from '#cogs/components/common/readonly'

package/src/js/components/common/readonly/index.jsx

@@ -0,0 +1,11 @@
+import React from 'react'
+
+const READONLY = String.fromCharCode(42)
+
+export default function ReadOnly () {
+  return (
+    <span className='is-readonly'>
+      {READONLY}
+    </span>
+  )
+}

package/src/{components → js/components}/common/required/index.cjs

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

package/src/js/components/common/required/index.d.cts

@@ -0,0 +1 @@
+export { default } from '#cogs/components/common/required'

package/src/js/components/common/required/index.jsx

@@ -0,0 +1,11 @@
+import React from 'react'
+
+const REQUIRED = String.fromCharCode(42)
+
+export default function Required () {
+  return (
+    <span className='is-required'>
+      {REQUIRED}
+    </span>
+  )
+}

package/src/{components → js/components}/common/text-content/index.cjs

@@ -1,6 +1,6 @@
 require('@babel/register')({
   ignore: [
-    /node_modules\/(?!@modernpoacher\/cogs|@modernpoacher\/sprockets|@modernpoacher\/gremlins)/
+    /node_modules\/(?!shinkansen|@modernpoacher)/
   ]
 })
 
@@ -11,7 +11,10 @@ const log = debug('@modernpoacher/cogs/components/common/text-content')
 log('`cogs` is awake')
 
 const {
-  default: component
+  default: TextContent
 } = require('./index.jsx')
 
-module.exports = component
+/**
+ *  Exports only default
+ */
+module.exports = TextContent

package/src/js/components/common/text-content/index.d.cts

@@ -0,0 +1,2 @@
+export { default } from '#cogs/components/common/text-content'
+export * from '#cogs/components/common/text-content'

package/src/{components → js/components}/common/text-content/index.d.mts

@@ -1,9 +1,7 @@
 declare module '#cogs/components/common/text-content' {
   import type React from 'react'
 
-  export interface TextContentProps {
-    textContent: string
-  }
+  export type TextContentProps = CogsTypes.Components.Common.TextContent.TextContentProps
 
   export default function TextContent (props: TextContentProps): React.JSX.Element | null
 }

package/src/{components → js/components}/common/text-content/index.jsx

@@ -1,15 +1,16 @@
 /**
- * TextContent component
- *
- * @typedef {import('@modernpoacher/cogs/components/common/text-content').TextContentProps} TextContentProps
+ *  @typedef {CogsTypes.Components.Common.TextContent.TextContentProps} TextContentProps
  */
 
+/**
+ * TextContent component
+ */
 import React from 'react'
 import PropTypes from 'prop-types'
 
 /**
- * @param {TextContentProps}
- * @returns {React.JSX.Element | null}
+ *  @param {TextContentProps} props
+ *  @returns {React.JSX.Element | null}
  */
 export default function TextContent ({ textContent }) {
   if (textContent) {
@@ -24,5 +25,5 @@ export default function TextContent ({ textContent }) {
 }
 
 TextContent.propTypes = {
-  textContent: PropTypes.string.isRequired
+  textContent: PropTypes.string
 }

package/src/{components → js/components}/description/index.cjs

@@ -11,7 +11,10 @@ const log = debug('@modernpoacher/cogs/components/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/components/description/index.d.cts

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

package/src/{components → js/components}/description/index.d.mts

@@ -1,11 +1,6 @@
 declare module '#cogs/components/description' {
-  import React from 'react'
-
-  export interface DescriptionProps {
-    description: string
-  }
-
-  export default class Description extends React.Component<DescriptionProps> {}
+  export { default } from '#cogs/super/components/description'
+  export * from '#cogs/super/components/description'
 }
 
 declare module '@modernpoacher/cogs/components/description' {

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

@@ -0,0 +1,5 @@
+/**
+ * Description component
+ */
+
+export { default } from '#cogs/super/components/description'