@commercetools-uikit/async-creatable-select-field 14.0.0 → 14.0.1

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.
package/README.md CHANGED
@@ -152,3 +152,23 @@ When the `key` is known, and when the value is truthy, and when `renderError` re
152
152
  Known error keys are:
153
153
 
154
154
  - `missing`: tells the user that this field is required
155
+
156
+ ## Static methods
157
+
158
+ ### `AsyncCreatableSelectField.toFieldErrors`
159
+
160
+ Use this function to convert the Formik `errors` object type to our custom field errors type. This is primarily useful when using TypeScript.
161
+
162
+ ```ts
163
+ type FormValues = {
164
+ myField: string;
165
+ };
166
+
167
+ <AsyncCreatableSelectField
168
+ // ...
169
+ name="my-field"
170
+ errors={
171
+ AsyncCreatableSelectField.toFieldErrors<FormValues>(formik.errors).myField
172
+ }
173
+ />;
174
+ ```
@@ -177,6 +177,17 @@ var AsyncCreatableSelectField = /*#__PURE__*/function (_Component) {
177
177
  })
178
178
  });
179
179
  }
180
+ }], [{
181
+ key: "toFieldErrors",
182
+ value:
183
+ /**
184
+ * Use this function to convert the Formik `errors` object type to
185
+ * our custom field errors type.
186
+ * This is primarly useful when using TypeScript.
187
+ */
188
+ function toFieldErrors(errors) {
189
+ return errors;
190
+ }
180
191
  }]);
181
192
 
182
193
  return AsyncCreatableSelectField;
@@ -215,7 +226,7 @@ AsyncCreatableSelectField.propTypes = process.env.NODE_ENV !== "production" ? {
215
226
  } : {};
216
227
 
217
228
  // NOTE: This string will be replaced on build time with the package version.
218
- var version = "14.0.0";
229
+ var version = "14.0.1";
219
230
 
220
231
  exports["default"] = AsyncCreatableSelectField;
221
232
  exports.version = version;
@@ -170,6 +170,17 @@ var AsyncCreatableSelectField = /*#__PURE__*/function (_Component) {
170
170
  })
171
171
  });
172
172
  }
173
+ }], [{
174
+ key: "toFieldErrors",
175
+ value:
176
+ /**
177
+ * Use this function to convert the Formik `errors` object type to
178
+ * our custom field errors type.
179
+ * This is primarly useful when using TypeScript.
180
+ */
181
+ function toFieldErrors(errors) {
182
+ return errors;
183
+ }
173
184
  }]);
174
185
 
175
186
  return AsyncCreatableSelectField;
@@ -188,7 +199,7 @@ AsyncCreatableSelectField.getDerivedStateFromProps = function (props, state) {
188
199
  AsyncCreatableSelectField.propTypes = {};
189
200
 
190
201
  // NOTE: This string will be replaced on build time with the package version.
191
- var version = "14.0.0";
202
+ var version = "14.0.1";
192
203
 
193
204
  exports["default"] = AsyncCreatableSelectField;
194
205
  exports.version = version;
@@ -151,6 +151,17 @@ var AsyncCreatableSelectField = /*#__PURE__*/function (_Component) {
151
151
  })
152
152
  });
153
153
  }
154
+ }], [{
155
+ key: "toFieldErrors",
156
+ value:
157
+ /**
158
+ * Use this function to convert the Formik `errors` object type to
159
+ * our custom field errors type.
160
+ * This is primarly useful when using TypeScript.
161
+ */
162
+ function toFieldErrors(errors) {
163
+ return errors;
164
+ }
154
165
  }]);
155
166
 
156
167
  return AsyncCreatableSelectField;
@@ -189,6 +200,6 @@ AsyncCreatableSelectField.propTypes = process.env.NODE_ENV !== "production" ? {
189
200
  } : {};
190
201
 
191
202
  // NOTE: This string will be replaced on build time with the package version.
192
- var version = "14.0.0";
203
+ var version = "14.0.1";
193
204
 
194
205
  export { AsyncCreatableSelectField as default, version };
@@ -2,8 +2,11 @@ import { Component, type ReactElement, type ReactNode } from 'react';
2
2
  import type { GroupBase, ActionMeta } from 'react-select';
3
3
  import type { AsyncCreatableProps } from 'react-select/async-creatable';
4
4
  declare type ReactSelectAsyncCreatableProps = AsyncCreatableProps<unknown, boolean, GroupBase<unknown>>;
5
- declare type TFieldErrors = Record<string, boolean>;
6
5
  declare type TErrorRenderer = (key: string, error?: boolean) => ReactNode;
6
+ declare type TFieldErrors = Record<string, boolean>;
7
+ declare type TCustomFormErrors<Values> = {
8
+ [K in keyof Values]?: TFieldErrors;
9
+ };
7
10
  declare type TEvent = {
8
11
  target: {
9
12
  name?: string;
@@ -74,6 +77,7 @@ export default class AsyncCreatableSelectField extends Component<TAsyncCreatable
74
77
  static getDerivedStateFromProps: (props: TAsyncCreatableSelectFieldProps, state: TAsyncCreatableSelectFieldState) => {
75
78
  id: string;
76
79
  };
80
+ static toFieldErrors<FormValues>(errors: unknown): TCustomFormErrors<FormValues>;
77
81
  render(): import("@emotion/react/jsx-runtime").JSX.Element;
78
82
  }
79
83
  export {};
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@commercetools-uikit/async-creatable-select-field",
3
3
  "description": "An input component with validation states and a label getting a selection from an asynchronously loaded list from the user, and where options can be created by the user.",
4
- "version": "14.0.0",
4
+ "version": "14.0.1",
5
5
  "bugs": "https://github.com/commercetools/ui-kit/issues",
6
6
  "repository": {
7
7
  "type": "git",
@@ -21,13 +21,13 @@
21
21
  "dependencies": {
22
22
  "@babel/runtime": "^7.17.2",
23
23
  "@babel/runtime-corejs3": "^7.17.2",
24
- "@commercetools-uikit/async-creatable-select-input": "14.0.0",
25
- "@commercetools-uikit/constraints": "14.0.0",
24
+ "@commercetools-uikit/async-creatable-select-input": "14.0.1",
25
+ "@commercetools-uikit/constraints": "14.0.1",
26
26
  "@commercetools-uikit/design-system": "14.0.0",
27
- "@commercetools-uikit/field-errors": "14.0.0",
28
- "@commercetools-uikit/field-label": "14.0.0",
29
- "@commercetools-uikit/spacings": "14.0.0",
30
- "@commercetools-uikit/utils": "14.0.0",
27
+ "@commercetools-uikit/field-errors": "14.0.1",
28
+ "@commercetools-uikit/field-label": "14.0.1",
29
+ "@commercetools-uikit/spacings": "14.0.1",
30
+ "@commercetools-uikit/utils": "14.0.1",
31
31
  "@emotion/react": "^11.4.0",
32
32
  "@emotion/styled": "^11.3.0",
33
33
  "prop-types": "15.8.1",