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

package/README.md

@@ -81,7 +81,7 @@ export default Example;
 | `name`                    | `AsyncCreatableProps['name']`                                                                         |          |           | Name of the HTML Input (optional - without this, no input will be rendered)&#xA;<br>&#xA;[Props from React select was used](https://react-select.com/props)                                                                                                                                                                                                                               |
 | `noOptionsMessage`        | `AsyncCreatableProps['noOptionsMessage']`                                                             |          |           | Can be used to render a custom value when there are no options (either because of no search results, or all options have been used, or there were none in the first place).&#xA;<br/>&#xA;Gets called with `{ inputValue: String }`. `inputValue` will be an empty string when no search text is present.&#xA;<br>&#xA;[Props from React select was used](https://react-select.com/props) |
 | `onBlur`                  | `Function`<br/>[See signature.](#signature-onBlur)                                                    |          |           | Handle blur events on the control                                                                                                                                                                                                                                                                                                                                                         |
-| `onChange`                | `Function`<br/>[See signature.](#signature-onChange)                                                  |    ✅    |           | Called with a fake event when value changes.&#xA;<br />&#xA;The event's `target.name` will be the name supplied in props. The event's `target.value` will hold the value. The value will be the selected option, or an array of options in case `isMulti` is `true`.&#xA;<br>&#xA;[Props from React select was used](https://react-select.com/props)                                      |
+| `onChange`                | `Function`<br/>[See signature.](#signature-onChange)                                                  |          |           | Called with a fake event when value changes.&#xA;<br />&#xA;The event's `target.name` will be the name supplied in props. The event's `target.value` will hold the value. The value will be the selected option, or an array of options in case `isMulti` is `true`.&#xA;<br>&#xA;[Props from React select was used](https://react-select.com/props)                                      |
 | `onFocus`                 | `AsyncCreatableProps['onFocus']`                                                                      |          |           | Handle focus events on the control&#xA;<br>&#xA;[Props from React select was used](https://react-select.com/props)                                                                                                                                                                                                                                                                        |
 | `onInputChange`           | `AsyncCreatableProps['onInputChange']`                                                                |          |           | Handle change events on the input&#xA;<br>&#xA;[Props from React select was used](https://react-select.com/props)                                                                                                                                                                                                                                                                         |
 | `placeholder`             | `AsyncCreatableProps['placeholder']`                                                                  |          |           | Placeholder text for the select value&#xA;<br>&#xA;[Props from React select was used](https://react-select.com/props)                                                                                                                                                                                                                                                                     |
@@ -117,13 +117,13 @@ export default Example;
 ### Signature `onBlur`
 
 ```ts
-(event: TEvent) => void
+(event: TCustomEvent) => void
 ```
 
 ### Signature `onChange`
 
 ```ts
-(event: TEvent, info: ActionMeta<unknown>) => void
+(event: TCustomEvent, info: ActionMeta<unknown>) => void
 ```
 
 ### Signature `onInfoButtonClick`
@@ -152,3 +152,23 @@ When the `key` is known, and when the value is truthy, and when `renderError` re
 Known error keys are:
 
 - `missing`: tells the user that this field is required
+
+## Static methods
+
+### `AsyncCreatableSelectField.toFieldErrors`
+
+Use this function to convert the Formik `errors` object type to our custom field errors type. This is primarily useful when using TypeScript.
+
+```ts
+type FormValues = {
+  myField: string;
+};
+
+<AsyncCreatableSelectField
+  // ...
+  name="my-field"
+  errors={
+    AsyncCreatableSelectField.toFieldErrors<FormValues>(formik.errors).myField
+  }
+/>;
+```

package/dist/commercetools-uikit-async-creatable-select-field.cjs.dev.js

@@ -99,13 +99,17 @@ var AsyncCreatableSelectField = /*#__PURE__*/function (_Component) {
     value: function render() {
       var hasError = AsyncCreatableSelectInput__default["default"].isTouched(this.props.touched) && hasErrors(this.props.errors);
 
+      if (!this.props.isReadOnly) {
+        process.env.NODE_ENV !== "production" ? utils.warning(typeof this.props.onChange === 'function', 'AsyncCreatableSelectField: `onChange` is required when field is not read only.') : void 0;
+      }
+
       if (this.props.hintIcon) {
         process.env.NODE_ENV !== "production" ? utils.warning(typeof this.props.hint === 'string' || /*#__PURE__*/react.isValidElement(this.props.hint), 'AsyncCreatableSelectField: `hint` is required to be string or ReactNode if hintIcon is present') : void 0;
       }
 
       if (this.props.isMulti) {
         process.env.NODE_ENV !== "production" ? utils.warning(_Array$isArray__default["default"](this.props.value), 'AsyncCreatableSelectField: `value` is expected to be an array of string when isMulti is true') : void 0;
-        process.env.NODE_ENV !== "production" ? utils.warning(_Array$isArray__default["default"](this.props.touched), 'AsyncCreatableSelectField: `touched` is expected to be an array of boolean when isMulti is true') : void 0;
+        process.env.NODE_ENV !== "production" ? utils.warning(typeof this.props.touched === 'undefined' || _Array$isArray__default["default"](this.props.touched), 'AsyncCreatableSelectField: `touched` is expected to be an array of boolean when isMulti is true') : void 0;
       }
 
       return jsxRuntime.jsx(Constraints__default["default"].Horizontal, {
@@ -177,6 +181,17 @@ var AsyncCreatableSelectField = /*#__PURE__*/function (_Component) {
         })
       });
     }
+  }], [{
+    key: "toFieldErrors",
+    value:
+    /**
+     * Use this function to convert the Formik `errors` object type to
+     * our custom field errors type.
+     * This is primarly useful when using TypeScript.
+     */
+    function toFieldErrors(errors) {
+      return errors;
+    }
   }]);
 
   return AsyncCreatableSelectField;
@@ -203,7 +218,7 @@ AsyncCreatableSelectField.propTypes = process.env.NODE_ENV !== "production" ? {
   hasWarning: _pt__default["default"].bool,
   menuPortalZIndex: _pt__default["default"].number,
   onBlur: _pt__default["default"].func,
-  onChange: _pt__default["default"].func.isRequired,
+  onChange: _pt__default["default"].func,
   showOptionGroupDivider: _pt__default["default"].bool,
   title: _pt__default["default"].oneOfType([_pt__default["default"].string, _pt__default["default"].node]).isRequired,
   hint: _pt__default["default"].oneOfType([_pt__default["default"].string, _pt__default["default"].node]),
@@ -215,7 +230,7 @@ AsyncCreatableSelectField.propTypes = process.env.NODE_ENV !== "production" ? {
 } : {};
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "14.0.0";
+var version = "14.0.6";
 
 exports["default"] = AsyncCreatableSelectField;
 exports.version = version;

package/dist/commercetools-uikit-async-creatable-select-field.cjs.prod.js

@@ -97,6 +97,8 @@ var AsyncCreatableSelectField = /*#__PURE__*/function (_Component) {
     value: function render() {
       var hasError = AsyncCreatableSelectInput__default["default"].isTouched(this.props.touched) && hasErrors(this.props.errors);
 
+      if (!this.props.isReadOnly) ;
+
       if (this.props.hintIcon) ;
 
       if (this.props.isMulti) ;
@@ -170,6 +172,17 @@ var AsyncCreatableSelectField = /*#__PURE__*/function (_Component) {
         })
       });
     }
+  }], [{
+    key: "toFieldErrors",
+    value:
+    /**
+     * Use this function to convert the Formik `errors` object type to
+     * our custom field errors type.
+     * This is primarly useful when using TypeScript.
+     */
+    function toFieldErrors(errors) {
+      return errors;
+    }
   }]);
 
   return AsyncCreatableSelectField;
@@ -188,7 +201,7 @@ AsyncCreatableSelectField.getDerivedStateFromProps = function (props, state) {
 AsyncCreatableSelectField.propTypes = {};
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "14.0.0";
+var version = "14.0.6";
 
 exports["default"] = AsyncCreatableSelectField;
 exports.version = version;

package/dist/commercetools-uikit-async-creatable-select-field.esm.js

@@ -73,13 +73,17 @@ var AsyncCreatableSelectField = /*#__PURE__*/function (_Component) {
     value: function render() {
       var hasError = AsyncCreatableSelectInput.isTouched(this.props.touched) && hasErrors(this.props.errors);
 
+      if (!this.props.isReadOnly) {
+        process.env.NODE_ENV !== "production" ? warning(typeof this.props.onChange === 'function', 'AsyncCreatableSelectField: `onChange` is required when field is not read only.') : void 0;
+      }
+
       if (this.props.hintIcon) {
         process.env.NODE_ENV !== "production" ? warning(typeof this.props.hint === 'string' || /*#__PURE__*/isValidElement(this.props.hint), 'AsyncCreatableSelectField: `hint` is required to be string or ReactNode if hintIcon is present') : void 0;
       }
 
       if (this.props.isMulti) {
         process.env.NODE_ENV !== "production" ? warning(_Array$isArray(this.props.value), 'AsyncCreatableSelectField: `value` is expected to be an array of string when isMulti is true') : void 0;
-        process.env.NODE_ENV !== "production" ? warning(_Array$isArray(this.props.touched), 'AsyncCreatableSelectField: `touched` is expected to be an array of boolean when isMulti is true') : void 0;
+        process.env.NODE_ENV !== "production" ? warning(typeof this.props.touched === 'undefined' || _Array$isArray(this.props.touched), 'AsyncCreatableSelectField: `touched` is expected to be an array of boolean when isMulti is true') : void 0;
       }
 
       return jsx(Constraints.Horizontal, {
@@ -151,6 +155,17 @@ var AsyncCreatableSelectField = /*#__PURE__*/function (_Component) {
         })
       });
     }
+  }], [{
+    key: "toFieldErrors",
+    value:
+    /**
+     * Use this function to convert the Formik `errors` object type to
+     * our custom field errors type.
+     * This is primarly useful when using TypeScript.
+     */
+    function toFieldErrors(errors) {
+      return errors;
+    }
   }]);
 
   return AsyncCreatableSelectField;
@@ -177,7 +192,7 @@ AsyncCreatableSelectField.propTypes = process.env.NODE_ENV !== "production" ? {
   hasWarning: _pt.bool,
   menuPortalZIndex: _pt.number,
   onBlur: _pt.func,
-  onChange: _pt.func.isRequired,
+  onChange: _pt.func,
   showOptionGroupDivider: _pt.bool,
   title: _pt.oneOfType([_pt.string, _pt.node]).isRequired,
   hint: _pt.oneOfType([_pt.string, _pt.node]),
@@ -189,6 +204,6 @@ AsyncCreatableSelectField.propTypes = process.env.NODE_ENV !== "production" ? {
 } : {};
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "14.0.0";
+var version = "14.0.6";
 
 export { AsyncCreatableSelectField as default, version };

package/dist/declarations/src/async-creatable-select-field.d.ts

@@ -2,10 +2,14 @@ import { Component, type ReactElement, type ReactNode } from 'react';
 import type { GroupBase, ActionMeta } from 'react-select';
 import type { AsyncCreatableProps } from 'react-select/async-creatable';
 declare type ReactSelectAsyncCreatableProps = AsyncCreatableProps<unknown, boolean, GroupBase<unknown>>;
-declare type TFieldErrors = Record<string, boolean>;
 declare type TErrorRenderer = (key: string, error?: boolean) => ReactNode;
-declare type TEvent = {
+declare type TFieldErrors = Record<string, boolean>;
+declare type TCustomFormErrors<Values> = {
+    [K in keyof Values]?: TFieldErrors;
+};
+declare type TCustomEvent = {
     target: {
+        id?: string;
         name?: string;
         value?: unknown;
     };
@@ -38,8 +42,8 @@ declare type TAsyncCreatableSelectFieldProps = {
     menuShouldBlockScroll?: ReactSelectAsyncCreatableProps['menuShouldBlockScroll'];
     name?: ReactSelectAsyncCreatableProps['name'];
     noOptionsMessage?: ReactSelectAsyncCreatableProps['noOptionsMessage'];
-    onBlur?: (event: TEvent) => void;
-    onChange: (event: TEvent, info: ActionMeta<unknown>) => void;
+    onBlur?: (event: TCustomEvent) => void;
+    onChange?: (event: TCustomEvent, info: ActionMeta<unknown>) => void;
     onFocus?: ReactSelectAsyncCreatableProps['onFocus'];
     onInputChange?: ReactSelectAsyncCreatableProps['onInputChange'];
     placeholder?: ReactSelectAsyncCreatableProps['placeholder'];
@@ -74,6 +78,7 @@ export default class AsyncCreatableSelectField extends Component<TAsyncCreatable
     static getDerivedStateFromProps: (props: TAsyncCreatableSelectFieldProps, state: TAsyncCreatableSelectFieldState) => {
         id: string;
     };
+    static toFieldErrors<FormValues>(errors: unknown): TCustomFormErrors<FormValues>;
     render(): import("@emotion/react/jsx-runtime").JSX.Element;
 }
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-uikit/async-creatable-select-field",
   "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.",
-  "version": "14.0.0",
+  "version": "14.0.6",
   "bugs": "https://github.com/commercetools/ui-kit/issues",
   "repository": {
     "type": "git",
@@ -21,13 +21,13 @@
   "dependencies": {
     "@babel/runtime": "^7.17.2",
     "@babel/runtime-corejs3": "^7.17.2",
-    "@commercetools-uikit/async-creatable-select-input": "14.0.0",
-    "@commercetools-uikit/constraints": "14.0.0",
+    "@commercetools-uikit/async-creatable-select-input": "14.0.6",
+    "@commercetools-uikit/constraints": "14.0.1",
     "@commercetools-uikit/design-system": "14.0.0",
-    "@commercetools-uikit/field-errors": "14.0.0",
-    "@commercetools-uikit/field-label": "14.0.0",
-    "@commercetools-uikit/spacings": "14.0.0",
-    "@commercetools-uikit/utils": "14.0.0",
+    "@commercetools-uikit/field-errors": "14.0.1",
+    "@commercetools-uikit/field-label": "14.0.6",
+    "@commercetools-uikit/spacings": "14.0.6",
+    "@commercetools-uikit/utils": "14.0.1",
     "@emotion/react": "^11.4.0",
     "@emotion/styled": "^11.3.0",
     "prop-types": "15.8.1",