@commercetools-uikit/money-field 14.0.0 → 14.0.1

package/README.md

@@ -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

@@ -149,6 +149,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;
@@ -201,7 +212,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 = "14.0.0";
+var version = "14.0.1";
 
 exports["default"] = MoneyField$1;
 exports.version = version;

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

@@ -144,6 +144,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 +175,7 @@ MoneyField.propTypes = {};
 var MoneyField$1 = MoneyField;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "14.0.0";
+var version = "14.0.1";
 
 exports["default"] = MoneyField$1;
 exports.version = version;

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

@@ -123,6 +123,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;
@@ -175,6 +186,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 = "14.0.0";
+var version = "14.0.1";
 
 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;
@@ -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": "14.0.0",
+  "version": "14.0.1",
   "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/constraints": "14.0.0",
+    "@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/money-input": "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.1",
+    "@commercetools-uikit/money-input": "14.0.1",
+    "@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",