@commercetools-uikit/number-field 14.0.0 → 14.0.1

package/README.md

@@ -108,3 +108,21 @@ 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
+
+### `NumberField.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;
+};
+
+<NumberField
+  // ...
+  name="my-field"
+  errors={NumberField.toFieldErrors<FormValues>(formik.errors).myField}
+/>;
+```

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

@@ -147,6 +147,17 @@ var NumberField = /*#__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 NumberField;
@@ -193,7 +204,7 @@ NumberField.propTypes = process.env.NODE_ENV !== "production" ? {
 var NumberField$1 = NumberField;
 
 // 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"] = NumberField$1;
 exports.version = version;

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

@@ -142,6 +142,17 @@ var NumberField = /*#__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 NumberField;
@@ -162,7 +173,7 @@ NumberField.propTypes = {};
 var NumberField$1 = NumberField;
 
 // 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"] = NumberField$1;
 exports.version = version;

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

@@ -122,6 +122,17 @@ var NumberField = /*#__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 NumberField;
@@ -168,6 +179,6 @@ NumberField.propTypes = process.env.NODE_ENV !== "production" ? {
 var NumberField$1 = NumberField;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "14.0.0";
+var version = "14.0.1";
 
 export { NumberField$1 as default, version };

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

@@ -1,6 +1,9 @@
 import { Component, type ChangeEventHandler, type FocusEventHandler, type ReactElement, type ReactNode, type MouseEvent, type KeyboardEvent } from 'react';
-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 TNumberFieldProps = {
     id?: string;
     horizontalConstraint?: 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 'scale' | 'auto';
@@ -38,6 +41,7 @@ declare class NumberField extends Component<TNumberFieldProps, TNumberFieldState
     static getDerivedStateFromProps: (props: TNumberFieldProps, state: TNumberFieldState) => {
         id: string;
     };
+    static toFieldErrors<FormValues>(errors: unknown): TCustomFormErrors<FormValues>;
     render(): import("@emotion/react/jsx-runtime").JSX.Element;
 }
 export default NumberField;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-uikit/number-field",
   "description": "A controlled input component for numbers 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/number-input": "14.0.0",
-    "@commercetools-uikit/spacings-stack": "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/number-input": "14.0.1",
+    "@commercetools-uikit/spacings-stack": "14.0.1",
+    "@commercetools-uikit/utils": "14.0.1",
     "@emotion/react": "^11.4.0",
     "@emotion/styled": "^11.3.0",
     "prop-types": "15.8.1",