shinkansen-cogs 1.8.21 → 1.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (143) hide show
  1. package/eslint.config.mjs +16 -3
  2. package/index.d.mts +116 -104
  3. package/package.json +36 -5
  4. package/src/cogs/checkbox/description/index.cjs +5 -2
  5. package/src/cogs/checkbox/description/index.jsx +1 -1
  6. package/src/cogs/checkbox/error-message/index.cjs +5 -2
  7. package/src/cogs/checkbox/error-message/index.jsx +1 -1
  8. package/src/cogs/checkbox/field/index.cjs +5 -2
  9. package/src/cogs/checkbox/field/index.jsx +1 -1
  10. package/src/cogs/checkbox/index.cjs +5 -2
  11. package/src/cogs/checkbox/index.d.mts +1 -1
  12. package/src/cogs/checkbox/index.jsx +13 -10
  13. package/src/cogs/checkbox/title/index.cjs +5 -2
  14. package/src/cogs/checkbox/title/index.jsx +2 -2
  15. package/src/cogs/email/description/index.cjs +5 -2
  16. package/src/cogs/email/description/index.jsx +1 -1
  17. package/src/cogs/email/error-message/index.cjs +5 -2
  18. package/src/cogs/email/error-message/index.jsx +1 -1
  19. package/src/cogs/email/field/index.cjs +5 -2
  20. package/src/cogs/email/field/index.jsx +1 -1
  21. package/src/cogs/email/index.cjs +5 -2
  22. package/src/cogs/email/index.d.mts +1 -1
  23. package/src/cogs/email/index.jsx +12 -8
  24. package/src/cogs/email/title/index.cjs +5 -2
  25. package/src/cogs/email/title/index.jsx +2 -2
  26. package/src/cogs/index.cjs +7 -5
  27. package/src/cogs/index.d.cts +0 -1
  28. package/src/cogs/index.d.mts +4 -23
  29. package/src/cogs/index.jsx +22 -169
  30. package/src/cogs/number/description/index.cjs +5 -2
  31. package/src/cogs/number/description/index.jsx +1 -1
  32. package/src/cogs/number/error-message/index.cjs +5 -2
  33. package/src/cogs/number/error-message/index.jsx +1 -1
  34. package/src/cogs/number/field/index.cjs +5 -2
  35. package/src/cogs/number/field/index.jsx +1 -1
  36. package/src/cogs/number/index.cjs +5 -2
  37. package/src/cogs/number/index.d.mts +1 -1
  38. package/src/cogs/number/index.jsx +12 -8
  39. package/src/cogs/number/title/index.cjs +5 -2
  40. package/src/cogs/number/title/index.jsx +2 -2
  41. package/src/cogs/password/description/index.cjs +5 -2
  42. package/src/cogs/password/description/index.jsx +1 -1
  43. package/src/cogs/password/error-message/index.cjs +5 -2
  44. package/src/cogs/password/error-message/index.jsx +1 -1
  45. package/src/cogs/password/field/index.cjs +5 -2
  46. package/src/cogs/password/field/index.jsx +1 -1
  47. package/src/cogs/password/index.cjs +5 -2
  48. package/src/cogs/password/index.d.mts +1 -1
  49. package/src/cogs/password/index.jsx +12 -8
  50. package/src/cogs/password/title/index.cjs +5 -2
  51. package/src/cogs/password/title/index.jsx +2 -2
  52. package/src/cogs/radio/description/index.cjs +5 -2
  53. package/src/cogs/radio/description/index.jsx +1 -1
  54. package/src/cogs/radio/error-message/index.cjs +5 -2
  55. package/src/cogs/radio/error-message/index.jsx +1 -1
  56. package/src/cogs/radio/field/index.cjs +5 -2
  57. package/src/cogs/radio/field/index.jsx +1 -1
  58. package/src/cogs/radio/index.cjs +5 -2
  59. package/src/cogs/radio/index.d.mts +1 -1
  60. package/src/cogs/radio/index.jsx +13 -10
  61. package/src/cogs/radio/title/index.cjs +5 -2
  62. package/src/cogs/radio/title/index.jsx +2 -2
  63. package/src/cogs/select/description/index.cjs +5 -2
  64. package/src/cogs/select/description/index.jsx +1 -1
  65. package/src/cogs/select/error-message/index.cjs +5 -2
  66. package/src/cogs/select/error-message/index.jsx +1 -1
  67. package/src/cogs/select/field/index.cjs +5 -2
  68. package/src/cogs/select/field/index.jsx +9 -5
  69. package/src/cogs/select/index.cjs +5 -2
  70. package/src/cogs/select/index.d.mts +1 -1
  71. package/src/cogs/select/index.jsx +12 -8
  72. package/src/cogs/select/title/index.cjs +5 -2
  73. package/src/cogs/select/title/index.jsx +2 -2
  74. package/src/cogs/text/description/index.cjs +5 -2
  75. package/src/cogs/text/description/index.jsx +1 -1
  76. package/src/cogs/text/error-message/index.cjs +5 -2
  77. package/src/cogs/text/error-message/index.jsx +1 -1
  78. package/src/cogs/text/field/index.cjs +5 -2
  79. package/src/cogs/text/field/index.jsx +1 -1
  80. package/src/cogs/text/index.cjs +5 -2
  81. package/src/cogs/text/index.d.mts +1 -1
  82. package/src/cogs/text/index.jsx +12 -8
  83. package/src/cogs/text/title/index.cjs +5 -2
  84. package/src/cogs/text/title/index.jsx +2 -2
  85. package/src/cogs/textarea/description/index.cjs +5 -2
  86. package/src/cogs/textarea/description/index.jsx +1 -1
  87. package/src/cogs/textarea/error-message/index.cjs +5 -2
  88. package/src/cogs/textarea/error-message/index.jsx +1 -1
  89. package/src/cogs/textarea/field/index.cjs +5 -2
  90. package/src/cogs/textarea/field/index.jsx +1 -1
  91. package/src/cogs/textarea/index.cjs +5 -2
  92. package/src/cogs/textarea/index.d.mts +1 -1
  93. package/src/cogs/textarea/index.jsx +12 -8
  94. package/src/cogs/textarea/title/index.cjs +5 -2
  95. package/src/cogs/textarea/title/index.jsx +2 -2
  96. package/src/common/index.d.mts +1 -7
  97. package/src/common/index.mjs +1 -5
  98. package/src/components/common/disabled/index.cjs +5 -2
  99. package/src/components/common/readonly/index.cjs +5 -2
  100. package/src/components/common/required/index.cjs +5 -2
  101. package/src/components/common/text-content/index.cjs +5 -2
  102. package/src/components/common/text-content/index.jsx +1 -1
  103. package/src/components/description/index.cjs +5 -2
  104. package/src/components/description/index.d.mts +1 -1
  105. package/src/components/description/index.jsx +2 -44
  106. package/src/components/error-message/index.cjs +5 -2
  107. package/src/components/error-message/index.d.mts +2 -21
  108. package/src/components/error-message/index.jsx +2 -118
  109. package/src/components/field/index.cjs +9 -3
  110. package/src/components/field/index.d.cts +0 -1
  111. package/src/components/field/index.d.mts +3 -11
  112. package/src/components/field/index.jsx +18 -75
  113. package/src/components/index.cjs +25 -5
  114. package/src/components/index.d.cts +4 -4
  115. package/src/components/index.d.mts +4 -4
  116. package/src/components/index.mjs +4 -4
  117. package/src/components/title/index.cjs +2 -2
  118. package/src/components/title/index.d.mts +2 -23
  119. package/src/components/title/index.jsx +2 -118
  120. package/src/super/cogs/index.cjs +20 -0
  121. package/src/super/cogs/index.d.cts +2 -0
  122. package/src/super/cogs/index.d.mts +28 -0
  123. package/src/super/cogs/index.jsx +179 -0
  124. package/src/super/components/description/index.cjs +20 -0
  125. package/src/super/components/description/index.d.cts +2 -0
  126. package/src/super/components/description/index.d.mts +18 -0
  127. package/src/super/components/description/index.jsx +47 -0
  128. package/src/super/components/error-message/index.cjs +20 -0
  129. package/src/super/components/error-message/index.d.cts +2 -0
  130. package/src/super/components/error-message/index.d.mts +28 -0
  131. package/src/super/components/error-message/index.jsx +121 -0
  132. package/src/super/components/field/index.cjs +20 -0
  133. package/src/super/components/field/index.d.cts +2 -0
  134. package/src/super/components/field/index.d.mts +18 -0
  135. package/src/super/components/field/index.jsx +74 -0
  136. package/src/super/components/index.cjs +32 -0
  137. package/src/super/components/index.d.cts +4 -0
  138. package/src/super/components/index.d.mts +4 -0
  139. package/src/super/components/index.mjs +10 -0
  140. package/src/super/components/title/index.cjs +20 -0
  141. package/src/super/components/title/index.d.cts +2 -0
  142. package/src/super/components/title/index.d.mts +30 -0
  143. package/src/super/components/title/index.jsx +121 -0
@@ -1,4 +1,4 @@
1
- export * as Description from '#cogs/components/description'
2
- export * as ErrorMessage from '#cogs/components/error-message'
3
- export * as Field from '#cogs/components/field'
4
- export * as Title from '#cogs/components/title'
1
+ export { default as Description } from '#cogs/components/description'
2
+ export { default as ErrorMessage } from '#cogs/components/error-message'
3
+ export { default as Field } from '#cogs/components/field'
4
+ export { default as Title } from '#cogs/components/title'
@@ -1,4 +1,4 @@
1
- export * as Description from '#cogs/components/description'
2
- export * as ErrorMessage from '#cogs/components/error-message'
3
- export * as Field from '#cogs/components/field'
4
- export * as Title from '#cogs/components/title'
1
+ export { default as Description } from '#cogs/components/description'
2
+ export { default as ErrorMessage } from '#cogs/components/error-message'
3
+ export { default as Field } from '#cogs/components/field'
4
+ export { default as Title } from '#cogs/components/title'
@@ -4,7 +4,7 @@ const log = debug('shinkansen-cogs/components')
4
4
 
5
5
  log('`shinkansen` is awake')
6
6
 
7
- export * as Description from './description/index.cjs'
8
- export * as ErrorMessage from './error-message/index.cjs'
9
- export * as Field from './field/index.cjs'
10
- export * as Title from './title/index.cjs'
7
+ export { default as Description } from './description/index.cjs'
8
+ export { default as ErrorMessage } from './error-message/index.cjs'
9
+ export { default as Field } from './field/index.cjs'
10
+ export { default as Title } from './title/index.cjs'
@@ -11,10 +11,10 @@ const log = debug('shinkansen-cogs/components/title')
11
11
  log('`shinkansen` is awake')
12
12
 
13
13
  const {
14
- default: component // @ts-ignore
14
+ default: Title // @ts-expect-error
15
15
  } = require('./index.jsx')
16
16
 
17
17
  /**
18
18
  * Exports only default
19
19
  */
20
- module.exports = component
20
+ module.exports = Title
@@ -1,27 +1,6 @@
1
1
  declare module '#cogs/components/title' {
2
- import React from 'react'
3
-
4
- export type TitleProps = CogsTypes.Components.Title.TitleProps
5
-
6
- export default class Title<P extends TitleProps> extends React.Component<P> {
7
- static propTypes: object
8
-
9
- isRequired (): boolean
10
-
11
- isDisabled (): boolean
12
-
13
- isReadOnly (): boolean
14
-
15
- getClassName (): string
16
-
17
- shouldComponentUpdate (props: TitleProps): boolean
18
-
19
- renderIsRequired (): React.JSX.Element | null
20
-
21
- renderIsDisabled (): React.JSX.Element | null
22
-
23
- renderIsReadOnly (): React.JSX.Element | null
24
- }
2
+ export { default } from '#cogs/super/components/title'
3
+ export * from '#cogs/super/components/title'
25
4
  }
26
5
 
27
6
  declare module 'shinkansen-cogs/components/title' {
@@ -1,121 +1,5 @@
1
1
  /**
2
- * @typedef {CogsTypes.Components.Title.TitleProps} TitleProps
2
+ * Title component
3
3
  */
4
4
 
5
- /**
6
- * Title component
7
- */
8
- import React, { Component } from 'react'
9
- import PropTypes from 'prop-types'
10
-
11
- import TextContent from '#cogs/components/common/text-content'
12
- import Required from '#cogs/components/common/required'
13
- import Disabled from '#cogs/components/common/disabled'
14
- import ReadOnly from '#cogs/components/common/readonly'
15
-
16
- export default class Title extends Component {
17
- isRequired () {
18
- const {
19
- required = false
20
- } = this.props
21
-
22
- return required
23
- }
24
-
25
- isDisabled () {
26
- const {
27
- disabled = false
28
- } = this.props
29
-
30
- return disabled
31
- }
32
-
33
- isReadOnly () {
34
- const {
35
- readOnly = false
36
- } = this.props
37
-
38
- return readOnly
39
- }
40
-
41
- getClassName () {
42
- return 'title'
43
- }
44
-
45
- /**
46
- * @param {TitleProps} props
47
- * @returns {boolean}
48
- */
49
- shouldComponentUpdate (props) {
50
- return (
51
- (props.id !== this.props.id) ||
52
- (props.title !== this.props.title) ||
53
- (props.required !== this.props.required) ||
54
- (props.disabled !== this.props.disabled) ||
55
- (props.readOnly !== this.props.readOnly) ||
56
- (props.children !== this.props.children)
57
- )
58
- }
59
-
60
- renderIsRequired () {
61
- if (this.isRequired()) {
62
- return (
63
- <Required />
64
- )
65
- }
66
-
67
- return null
68
- }
69
-
70
- renderIsDisabled () {
71
- if (this.isDisabled()) {
72
- return (
73
- <Disabled />
74
- )
75
- }
76
-
77
- return null
78
- }
79
-
80
- renderIsReadOnly () {
81
- if (this.isReadOnly()) {
82
- return (
83
- <ReadOnly />
84
- )
85
- }
86
-
87
- return null
88
- }
89
-
90
- render () {
91
- const {
92
- title
93
- } = this.props
94
-
95
- if (title) {
96
- const { id } = this.props
97
-
98
- return (
99
- <label htmlFor={id} className={this.getClassName()}>
100
- <TextContent textContent={title} />
101
- </label>
102
- )
103
- }
104
-
105
- return null
106
- }
107
- }
108
-
109
- Title.propTypes = {
110
- id: PropTypes.string.isRequired,
111
- title: PropTypes.string,
112
- required: PropTypes.bool,
113
- disabled: PropTypes.bool,
114
- readOnly: PropTypes.bool,
115
- children: PropTypes.oneOfType([
116
- PropTypes.node,
117
- PropTypes.arrayOf(
118
- PropTypes.node
119
- )
120
- ])
121
- }
5
+ export { default } from '#cogs/super/components/title'
@@ -0,0 +1,20 @@
1
+ require('@babel/register')({
2
+ ignore: [
3
+ /node_modules\/(?!shinkansen|@modernpoacher)/
4
+ ]
5
+ })
6
+
7
+ const debug = require('debug')
8
+
9
+ const log = debug('shinkansen-cogs/super/cogs')
10
+
11
+ log('`shinkansen` is awake')
12
+
13
+ const {
14
+ default: Cog // @ts-expect-error
15
+ } = require('./index.jsx')
16
+
17
+ /**
18
+ * Exports only default
19
+ */
20
+ module.exports = Cog // = require('./index.jsx')
@@ -0,0 +1,2 @@
1
+ export { default } from '#cogs/super/cogs'
2
+ export * from '#cogs/super/cogs'
@@ -0,0 +1,28 @@
1
+ declare module '#cogs/super/cogs' {
2
+ import React from 'react'
3
+
4
+ export type CogProps = CogsTypes.Super.Cogs.CogProps
5
+
6
+ export default class Cog<P extends CogProps> extends React.Component<P> {
7
+ static propTypes: Record<PropertyKey, unknown>
8
+
9
+ getClassName (): string
10
+
11
+ getId (): string
12
+
13
+ shouldComponentUpdate (props: CogProps): boolean
14
+
15
+ renderTitle (): React.JSX.Element | null
16
+
17
+ renderDescription (): React.JSX.Element | null
18
+
19
+ renderErrorMessage (): React.JSX.Element | null
20
+
21
+ renderField (): React.JSX.Element | null
22
+ }
23
+ }
24
+
25
+ declare module 'shinkansen-cogs/super/cogs' {
26
+ export { default } from '#cogs/super/cogs'
27
+ export * from '#cogs/super/cogs'
28
+ }
@@ -0,0 +1,179 @@
1
+ /**
2
+ * @typedef {CogsTypes.OnEventType} OnEventType
3
+ * @typedef {CogsTypes.Super.Cogs.CogProps} CogProps
4
+ */
5
+
6
+ /**
7
+ * Cog component
8
+ */
9
+ import React, { Component } from 'react'
10
+ import PropTypes from 'prop-types'
11
+ import classnames from 'classnames'
12
+
13
+ import Title from '#cogs/super/components/title'
14
+ import Description from '#cogs/super/components/description'
15
+ import ErrorMessage from '#cogs/super/components/error-message'
16
+ import Field from '#cogs/super/components/field'
17
+
18
+ /**
19
+ * @type {OnEventType}
20
+ */
21
+ function DEFAULT_HANDLE_EVENT () {
22
+ //
23
+ }
24
+
25
+ export default class Cog extends Component {
26
+ getClassName () {
27
+ const {
28
+ required = false,
29
+ disabled = false,
30
+ readOnly = false,
31
+ errorMessage
32
+ } = this.props
33
+
34
+ return classnames('cog', { required, disabled, readOnly, error: !!errorMessage })
35
+ }
36
+
37
+ getId () {
38
+ const {
39
+ id,
40
+ name
41
+ } = this.props
42
+
43
+ return id || name
44
+ }
45
+
46
+ /**
47
+ * @param {CogProps} props
48
+ * @returns {boolean}
49
+ */
50
+ shouldComponentUpdate (props) {
51
+ return (
52
+ (props.name !== this.props.name) ||
53
+ (props.id !== this.props.id) ||
54
+ (props.title !== this.props.title) ||
55
+ (props.description !== this.props.description) ||
56
+ (props.errorMessage !== this.props.errorMessage) ||
57
+ (props.required !== this.props.required) ||
58
+ (props.disabled !== this.props.disabled) ||
59
+ (props.readOnly !== this.props.readOnly) ||
60
+ (props.tabIndex !== this.props.tabIndex) ||
61
+ (props.accessKey !== this.props.accessKey) ||
62
+ (props.placeholder !== this.props.placeholder) ||
63
+ (props.onChange !== this.props.onChange)
64
+ )
65
+ }
66
+
67
+ renderTitle () {
68
+ const id = this.getId()
69
+
70
+ const {
71
+ title,
72
+ required = false,
73
+ disabled = false,
74
+ readOnly = false
75
+ } = this.props
76
+
77
+ return (
78
+ <Title
79
+ id={id}
80
+ title={title}
81
+ required={required}
82
+ disabled={disabled}
83
+ readOnly={readOnly}
84
+ />
85
+ )
86
+ }
87
+
88
+ renderDescription () {
89
+ const {
90
+ description
91
+ } = this.props
92
+
93
+ return (
94
+ <Description
95
+ description={description}
96
+ />
97
+ )
98
+ }
99
+
100
+ renderErrorMessage () {
101
+ const {
102
+ errorMessage
103
+ } = this.props
104
+
105
+ return (
106
+ <ErrorMessage
107
+ errorMessage={errorMessage}
108
+ />
109
+ )
110
+ }
111
+
112
+ renderField () {
113
+ const id = this.getId()
114
+
115
+ const {
116
+ name,
117
+ required = false,
118
+ disabled = false,
119
+ readOnly = false,
120
+ tabIndex,
121
+ accessKey,
122
+ placeholder,
123
+ onChange = DEFAULT_HANDLE_EVENT,
124
+ fieldRef
125
+ } = this.props
126
+
127
+ return (
128
+ <Field
129
+ id={id}
130
+ name={name}
131
+ required={required}
132
+ disabled={disabled}
133
+ readOnly={readOnly}
134
+ tabIndex={tabIndex}
135
+ accessKey={accessKey}
136
+ placeholder={placeholder}
137
+ onChange={onChange}
138
+ fieldRef={fieldRef}
139
+ />
140
+ )
141
+ }
142
+
143
+ render () {
144
+ const className = this.getClassName()
145
+
146
+ return (
147
+ <div className={className}>
148
+ {this.renderTitle()}
149
+ {this.renderDescription()}
150
+ {this.renderErrorMessage()}
151
+ {this.renderField()}
152
+ </div>
153
+ )
154
+ }
155
+ }
156
+
157
+ Cog.propTypes = {
158
+ id: PropTypes.string,
159
+ name: PropTypes.string.isRequired,
160
+ title: PropTypes.string,
161
+ description: PropTypes.string,
162
+ errorMessage: PropTypes.shape({
163
+ type: PropTypes.string.isRequired,
164
+ params: PropTypes.shape({}).isRequired,
165
+ uri: PropTypes.string.isRequired
166
+ }),
167
+ required: PropTypes.bool,
168
+ disabled: PropTypes.bool,
169
+ readOnly: PropTypes.bool,
170
+ tabIndex: PropTypes.number,
171
+ accessKey: PropTypes.string,
172
+ placeholder: PropTypes.string,
173
+ onChange: PropTypes.func,
174
+ fieldRef: PropTypes.shape({
175
+ current: PropTypes.shape({}).isRequired
176
+ })
177
+ }
178
+
179
+ export class CheckCog { }
@@ -0,0 +1,20 @@
1
+ require('@babel/register')({
2
+ ignore: [
3
+ /node_modules\/(?!shinkansen|@modernpoacher)/
4
+ ]
5
+ })
6
+
7
+ const debug = require('debug')
8
+
9
+ const log = debug('shinkansen-cogs/super/components/description')
10
+
11
+ log('`shinkansen` is awake')
12
+
13
+ const {
14
+ default: Description // @ts-expect-error
15
+ } = require('./index.jsx')
16
+
17
+ /**
18
+ * Exports only default
19
+ */
20
+ module.exports = Description
@@ -0,0 +1,2 @@
1
+ export { default } from '#cogs/super/components/description'
2
+ export * from '#cogs/super/components/description'
@@ -0,0 +1,18 @@
1
+ declare module '#cogs/super/components/description' {
2
+ import React from 'react'
3
+
4
+ export type DescriptionProps = CogsTypes.Super.Components.Description.DescriptionProps
5
+
6
+ export default class Description extends React.Component<DescriptionProps> {
7
+ static propTypes: object
8
+
9
+ getClassName (): string
10
+
11
+ shouldComponentUpdate (props: DescriptionProps): boolean
12
+ }
13
+ }
14
+
15
+ declare module 'shinkansen-cogs/super/components/description' {
16
+ export { default } from '#cogs/super/components/description'
17
+ export * from '#cogs/super/components/description'
18
+ }
@@ -0,0 +1,47 @@
1
+ /**
2
+ * @typedef {CogsTypes.Super.Components.Description.DescriptionProps} DescriptionProps
3
+ */
4
+
5
+ /**
6
+ * Description component
7
+ */
8
+ import React, { Component } from 'react'
9
+ import PropTypes from 'prop-types'
10
+
11
+ import TextContent from '#cogs/components/common/text-content'
12
+
13
+ export default class Description extends Component {
14
+ getClassName () {
15
+ return 'description'
16
+ }
17
+
18
+ /**
19
+ * @param {DescriptionProps} props
20
+ * @returns {boolean}
21
+ */
22
+ shouldComponentUpdate (props) {
23
+ return (
24
+ (props.description !== this.props.description)
25
+ )
26
+ }
27
+
28
+ render () {
29
+ const {
30
+ description
31
+ } = this.props
32
+
33
+ if (description) {
34
+ return (
35
+ <span className={this.getClassName()}>
36
+ <TextContent textContent={description} />
37
+ </span>
38
+ )
39
+ }
40
+
41
+ return null
42
+ }
43
+ }
44
+
45
+ Description.propTypes = {
46
+ description: PropTypes.string
47
+ }
@@ -0,0 +1,20 @@
1
+ require('@babel/register')({
2
+ ignore: [
3
+ /node_modules\/(?!shinkansen|@modernpoacher)/
4
+ ]
5
+ })
6
+
7
+ const debug = require('debug')
8
+
9
+ const log = debug('shinkansen-cogs/super/components/error-message')
10
+
11
+ log('`shinkansen` is awake')
12
+
13
+ const {
14
+ default: ErrorMessage // @ts-expect-error
15
+ } = require('./index.jsx')
16
+
17
+ /**
18
+ * Exports only default
19
+ */
20
+ module.exports = ErrorMessage
@@ -0,0 +1,2 @@
1
+ export { default } from '#cogs/super/components/error-message'
2
+ export * from '#cogs/super/components/error-message'
@@ -0,0 +1,28 @@
1
+ declare module '#cogs/super/components/error-message' {
2
+ import React from 'react'
3
+
4
+ export type ErrorDefinitionType = CogsTypes.ErrorDefinitionType
5
+ export type ErrorMessageProps = CogsTypes.Super.Components.ErrorMessage.ErrorMessageProps
6
+ export type ErrorMessageState = CogsTypes.Super.Components.ErrorMessage.ErrorMessageState
7
+
8
+ export default class ErrorMessage extends React.Component<ErrorMessageProps, ErrorMessageState> {
9
+ static propTypes: object
10
+
11
+ hasTextContent (): boolean
12
+
13
+ getTextContent (): string
14
+
15
+ getClassName (): string
16
+
17
+ static getDerivedStateFromProps (props: ErrorMessageProps, state: ErrorMessageState): ErrorMessageState
18
+
19
+ shouldComponentUpdate (props: ErrorMessageProps, state: ErrorMessageState): boolean
20
+
21
+ renderTextContent (): React.JSX.Element | null
22
+ }
23
+ }
24
+
25
+ declare module 'shinkansen-cogs/super/components/error-message' {
26
+ export { default } from '#cogs/super/components/error-message'
27
+ export * from '#cogs/super/components/error-message'
28
+ }
@@ -0,0 +1,121 @@
1
+ /**
2
+ * @typedef {CogsTypes.ErrorDefinitionType} ErrorDefinitionType
3
+ * @typedef {CogsTypes.Super.Components.ErrorMessage.ErrorMessageProps} ErrorMessageProps
4
+ * @typedef {CogsTypes.Super.Components.ErrorMessage.ErrorMessageState} ErrorMessageState
5
+ */
6
+
7
+ /**
8
+ * ErrorMessage component
9
+ */
10
+ import React, { Component } from 'react'
11
+ import PropTypes from 'prop-types'
12
+ import equal from 'fast-deep-equal'
13
+
14
+ import transform from '#cogs/transformers/error-message'
15
+
16
+ import TextContent from '#cogs/components/common/text-content'
17
+
18
+ export default class ErrorMessage extends Component {
19
+ /**
20
+ * @type {ErrorMessageState}
21
+ */
22
+ state = {}
23
+
24
+ hasTextContent () {
25
+ const {
26
+ errorMessage
27
+ } = this.props
28
+
29
+ const {
30
+ text
31
+ } = transform(errorMessage)
32
+
33
+ return !!text
34
+ }
35
+
36
+ getTextContent () {
37
+ const {
38
+ errorMessage
39
+ } = this.props
40
+
41
+ const {
42
+ text
43
+ } = transform(errorMessage)
44
+
45
+ return text
46
+ }
47
+
48
+ getClassName () {
49
+ return 'error-message'
50
+ }
51
+
52
+ /**
53
+ * Merge latest `props` to `state`
54
+ *
55
+ * @param {ErrorMessageProps} props Latest props
56
+ * @param {ErrorMessageState} state Current state
57
+ * @returns {ErrorMessageState}
58
+ */
59
+ static getDerivedStateFromProps ({ errorMessage }, { errorMessage: E }) {
60
+ return {
61
+ errorMessage: equal(errorMessage, E) ? E : errorMessage
62
+ }
63
+ }
64
+
65
+ /**
66
+ * Compare current and latest `state` for changes to `errorMessage`
67
+ *
68
+ * @param {ErrorMessageProps} props Latest props
69
+ * @param {ErrorMessageState} state Latest state
70
+ * @returns {boolean}
71
+ */
72
+ shouldComponentUpdate (props, state) {
73
+ const {
74
+ errorMessage: e
75
+ } = state
76
+
77
+ const {
78
+ errorMessage: E
79
+ } = this.state
80
+
81
+ return !equal(E, e)
82
+ }
83
+
84
+ renderTextContent () {
85
+ if (this.hasTextContent()) {
86
+ const textContent = this.getTextContent()
87
+
88
+ return (
89
+ <TextContent
90
+ textContent={textContent}
91
+ />
92
+ )
93
+ }
94
+
95
+ return null
96
+ }
97
+
98
+ render () {
99
+ const {
100
+ errorMessage
101
+ } = this.props
102
+
103
+ if (errorMessage) {
104
+ return (
105
+ <span className={this.getClassName()}>
106
+ {this.renderTextContent()}
107
+ </span>
108
+ )
109
+ }
110
+
111
+ return null
112
+ }
113
+ }
114
+
115
+ ErrorMessage.propTypes = {
116
+ errorMessage: PropTypes.shape({
117
+ type: PropTypes.string.isRequired,
118
+ params: PropTypes.shape({}).isRequired,
119
+ uri: PropTypes.string.isRequired
120
+ })
121
+ }