@commercetools-uikit/money-field 13.0.4 → 14.0.2

package/README.md

@@ -77,7 +77,7 @@ export default Example;
 | `isDisabled`            | `boolean`                                                                                             |          |           | Indicates that the input cannot be modified (e.g not authorized, or changes currently saving).                                                                                                                                                                        |
 | `isReadOnly`            | `boolean`                                                                                             |          |           | Indicates that the field is displaying read-only content                                                                                                                                                                                                              |
 | `isAutofocussed`        | `boolean`                                                                                             |          |           | Focus the input on initial render                                                                                                                                                                                                                                     |
-| `onChange`              | `Function`<br/>[See signature.](#signature-onChange)                                                  |    ✅    |           | Called with the event of the input or dropdown when either the currency or the amount have changed.                                                                                                                                                                   |
+| `onChange`              | `Function`<br/>[See signature.](#signature-onChange)                                                  |          |           | Called with the event of the input or dropdown when either the currency or the amount have changed.                                                                                                                                                                   |
 | `menuPortalTarget`      | `ReactSelectProps['menuPortalTarget']`                                                                |          |           | Dom element to portal the currency select menu to&#xA;<br>&#xA;[Props from React select was used](https://react-select.com/props)                                                                                                                                     |
 | `menuPortalZIndex`      | `number`                                                                                              |          |           | z-index value for the currency select menu portal                                                                                                                                                                                                                     |
 | `menuShouldBlockScroll` | `ReactSelectProps['menuShouldBlockScroll']`                                                           |          |           | whether the menu should block scroll while open&#xA;<br>&#xA;[Props from React select was used](https://react-select.com/props)                                                                                                                                       |
@@ -117,19 +117,19 @@ export default Example;
 ### Signature `onBlur`
 
 ```ts
-(event: TEvent) => void
+(event: TCustomEvent) => void
 ```
 
 ### Signature `onFocus`
 
 ```ts
-(event: TEvent) => void
+(event: TCustomEvent) => void
 ```
 
 ### Signature `onChange`
 
 ```ts
-(event: TEvent) => void
+(event: TCustomEvent) => void
 ```
 
 ### Signature `onInfoButtonClick`
@@ -157,3 +157,21 @@ Known error keys are:
 ## Main Functions and use cases are:
 
 - Getting monetary value input with a currency from users (with cent precision or high precision)
+
+## Static methods
+
+### `MoneyField.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;
+};
+
+<MoneyField
+  // ...
+  name="my-field"
+  errors={MoneyField.toFieldErrors<FormValues>(formik.errors).myField}
+/>;
+```

package/dist/commercetools-uikit-money-field.cjs.dev.js

@@ -101,6 +101,11 @@ var MoneyField = /*#__PURE__*/function (_Component) {
       // This avoids showing an error when the user just selected a language but
       // didn't add an amount yet.
       var hasError = MoneyInput__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', 'MoneyField: `onChange` is required when field is not read only.') : void 0;
+      }
+
       process.env.NODE_ENV !== "production" ? utils.warning(!has__default["default"](this.props, 'isTouched'), 'MoneyField:  Invalid prop isTouched supplied to MoneyField. Use touched instead.') : void 0;
 
       if (this.props.hintIcon) {
@@ -149,6 +154,17 @@ var MoneyField = /*#__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 MoneyField;
@@ -189,7 +205,7 @@ MoneyField.propTypes = process.env.NODE_ENV !== "production" ? {
   isDisabled: _pt__default["default"].bool,
   isReadOnly: _pt__default["default"].bool,
   isAutofocussed: _pt__default["default"].bool,
-  onChange: _pt__default["default"].func.isRequired,
+  onChange: _pt__default["default"].func,
   menuPortalZIndex: _pt__default["default"].number,
   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]),
@@ -201,7 +217,7 @@ MoneyField.propTypes = process.env.NODE_ENV !== "production" ? {
 var MoneyField$1 = MoneyField;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "13.0.4";
+var version = "14.0.2";
 
 exports["default"] = MoneyField$1;
 exports.version = version;

package/dist/commercetools-uikit-money-field.cjs.prod.js

@@ -100,6 +100,8 @@ var MoneyField = /*#__PURE__*/function (_Component) {
       // didn't add an amount yet.
       var hasError = MoneyInput__default["default"].isTouched(this.props.touched) && hasErrors(this.props.errors);
 
+      if (!this.props.isReadOnly) ;
+
       if (this.props.hintIcon) ;
 
       return jsxRuntime.jsx(Constraints__default["default"].Horizontal, {
@@ -144,6 +146,17 @@ var MoneyField = /*#__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 MoneyField;
@@ -164,7 +177,7 @@ MoneyField.propTypes = {};
 var MoneyField$1 = MoneyField;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "13.0.4";
+var version = "14.0.2";
 
 exports["default"] = MoneyField$1;
 exports.version = version;

package/dist/commercetools-uikit-money-field.esm.js

@@ -75,6 +75,11 @@ var MoneyField = /*#__PURE__*/function (_Component) {
       // This avoids showing an error when the user just selected a language but
       // didn't add an amount yet.
       var hasError = MoneyInput.isTouched(this.props.touched) && hasErrors(this.props.errors);
+
+      if (!this.props.isReadOnly) {
+        process.env.NODE_ENV !== "production" ? warning(typeof this.props.onChange === 'function', 'MoneyField: `onChange` is required when field is not read only.') : void 0;
+      }
+
       process.env.NODE_ENV !== "production" ? warning(!has(this.props, 'isTouched'), 'MoneyField:  Invalid prop isTouched supplied to MoneyField. Use touched instead.') : void 0;
 
       if (this.props.hintIcon) {
@@ -123,6 +128,17 @@ var MoneyField = /*#__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 MoneyField;
@@ -163,7 +179,7 @@ MoneyField.propTypes = process.env.NODE_ENV !== "production" ? {
   isDisabled: _pt.bool,
   isReadOnly: _pt.bool,
   isAutofocussed: _pt.bool,
-  onChange: _pt.func.isRequired,
+  onChange: _pt.func,
   menuPortalZIndex: _pt.number,
   title: _pt.oneOfType([_pt.string, _pt.node]).isRequired,
   hint: _pt.oneOfType([_pt.string, _pt.node]),
@@ -175,6 +191,6 @@ MoneyField.propTypes = process.env.NODE_ENV !== "production" ? {
 var MoneyField$1 = MoneyField;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "13.0.4";
+var version = "14.0.2";
 
 export { MoneyField$1 as default, version };

package/dist/declarations/src/money-field.d.ts

@@ -1,8 +1,11 @@
 import { Component, type ReactElement, type ReactNode } from 'react';
 import { type Props as ReactSelectProps } from 'react-select';
 import { type TCurrencyCode } from '@commercetools-uikit/money-input';
-declare type TFieldErrors = Record<string, boolean>;
 declare type TErrorRenderer = (key: string, error?: boolean) => ReactNode;
+declare type TFieldErrors = Record<string, boolean>;
+declare type TCustomFormErrors<Values> = {
+    [K in keyof Values]?: TFieldErrors;
+};
 declare type TTouched = {
     amount?: boolean;
     currencyCode?: boolean;
@@ -11,7 +14,7 @@ declare type TValue = {
     amount: string;
     currencyCode: TCurrencyCode;
 };
-declare type TEvent = {
+declare type TCustomEvent = {
     target: {
         id?: string;
         name?: string;
@@ -32,12 +35,12 @@ declare type TMoneyFieldProps = {
     value: TValue;
     currencies?: string[];
     placeholder?: string;
-    onBlur?: (event: TEvent) => void;
-    onFocus?: (event: TEvent) => void;
+    onBlur?: (event: TCustomEvent) => void;
+    onFocus?: (event: TCustomEvent) => void;
     isDisabled?: boolean;
     isReadOnly?: boolean;
     isAutofocussed?: boolean;
-    onChange: (event: TEvent) => void;
+    onChange?: (event: TCustomEvent) => void;
     menuPortalTarget?: ReactSelectProps['menuPortalTarget'];
     menuPortalZIndex?: number;
     menuShouldBlockScroll?: ReactSelectProps['menuShouldBlockScroll'];
@@ -60,6 +63,7 @@ declare class MoneyField extends Component<TMoneyFieldProps, TMoneyFieldState> {
     static getDerivedStateFromProps: (props: TMoneyFieldProps, state: TMoneyFieldState) => {
         id: string;
     };
+    static toFieldErrors<FormValues>(errors: unknown): TCustomFormErrors<FormValues>;
     render(): import("@emotion/react/jsx-runtime").JSX.Element;
 }
 export default MoneyField;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-uikit/money-field",
   "description": "A controlled input component for money values with validation states and a label.",
-  "version": "13.0.4",
+  "version": "14.0.2",
   "bugs": "https://github.com/commercetools/ui-kit/issues",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
     "directory": "packages/components/fields/money-field"
   },
   "homepage": "https://uikit.commercetools.com",
-  "keywords": ["javascript", "design system", "react", "uikit"],
+  "keywords": ["javascript", "typescript", "design-system", "react", "uikit"],
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -19,15 +19,15 @@
   "module": "dist/commercetools-uikit-money-field.esm.js",
   "files": ["dist"],
   "dependencies": {
-    "@babel/runtime": "7.17.2",
-    "@babel/runtime-corejs3": "7.17.2",
-    "@commercetools-uikit/constraints": "13.0.2",
-    "@commercetools-uikit/design-system": "13.0.0",
-    "@commercetools-uikit/field-errors": "13.0.4",
-    "@commercetools-uikit/field-label": "13.0.4",
-    "@commercetools-uikit/money-input": "13.0.4",
-    "@commercetools-uikit/spacings": "13.0.2",
-    "@commercetools-uikit/utils": "13.0.2",
+    "@babel/runtime": "^7.17.2",
+    "@babel/runtime-corejs3": "^7.17.2",
+    "@commercetools-uikit/constraints": "14.0.1",
+    "@commercetools-uikit/design-system": "14.0.0",
+    "@commercetools-uikit/field-errors": "14.0.1",
+    "@commercetools-uikit/field-label": "14.0.2",
+    "@commercetools-uikit/money-input": "14.0.2",
+    "@commercetools-uikit/spacings": "14.0.1",
+    "@commercetools-uikit/utils": "14.0.1",
     "@emotion/react": "^11.4.0",
     "@emotion/styled": "^11.3.0",
     "lodash": "4.17.21",