use-mask-input 3.1.2 → 3.3.0

package/CHANGELOG.md

@@ -0,0 +1,130 @@
+# [3.3.0](https://github.com/eduardoborges/use-mask-input/compare/3.2.0...3.3.0) (2023-06-30)
+
+
+### Features
+
+* new useHookFormMask API ([#35](https://github.com/eduardoborges/use-mask-input/issues/35)) ([52609eb](https://github.com/eduardoborges/use-mask-input/commit/52609eb57d77f4cd95a8ccbe868f9e4cbcdc2e47))
+
+# [3.2.0](https://github.com/eduardoborges/use-mask-input/compare/3.1.2...3.2.0) (2023-06-14)
+
+
+### Features
+
+* now works with Next! ([7730de2](https://github.com/eduardoborges/use-mask-input/commit/7730de24237f8df0eede8cf464620b6d1c87c558))
+
+## [3.1.2](https://github.com/eduardoborges/use-mask-input/compare/3.1.1...3.1.2) (2023-05-10)
+
+
+### Bug Fixes
+
+* add inputmask extension support ([eecc00a](https://github.com/eduardoborges/use-mask-input/commit/eecc00a0601ff5bc340c50886a6ab35174006096))
+
+## [3.1.1](https://github.com/eduardoborges/use-mask-input/compare/3.1.0...3.1.1) (2023-05-10)
+
+
+### Bug Fixes
+
+* change dependency type ([#13](https://github.com/eduardoborges/use-mask-input/issues/13)) ([1c87dc7](https://github.com/eduardoborges/use-mask-input/commit/1c87dc723540cd51e1dc40f1a162611aa53e9c11))
+* downgrade required node to 16 ([#11](https://github.com/eduardoborges/use-mask-input/issues/11)) ([d829d2f](https://github.com/eduardoborges/use-mask-input/commit/d829d2f5c34aa0b30ab6f68d42fbc5a068b53b70))
+* regression issue with react hook form and ci ([#31](https://github.com/eduardoborges/use-mask-input/issues/31)) ([bf104b2](https://github.com/eduardoborges/use-mask-input/commit/bf104b2a1ca7ccb0b7a1d573ba07bdfe95dd8949)), closes [#11](https://github.com/eduardoborges/use-mask-input/issues/11) [#13](https://github.com/eduardoborges/use-mask-input/issues/13)
+
+# [3.1.0](https://github.com/eduardoborges/use-mask-input/compare/3.0.6...3.1.0) (2023-05-04)
+
+
+### Bug Fixes
+
+* refactor code and add compose function to `utils.ts` ([49a7459](https://github.com/eduardoborges/use-mask-input/commit/49a7459c0976443f04426c2cc14d29172fe413ad))
+* refactor withHookFormMask to use compose instead of flow. ([85b8bc5](https://github.com/eduardoborges/use-mask-input/commit/85b8bc59b112341ad76b09d7acc167c98d8bd352))
+* small refactors, remove lodash dep and add exports suggar ([95286a8](https://github.com/eduardoborges/use-mask-input/commit/95286a87c4ea3c2bf0f25a418413078da9d17c7b))
+
+
+### Features
+
+* Add React Hook Form to dependencies and install git hooks ([f7496c2](https://github.com/eduardoborges/use-mask-input/commit/f7496c23a429363bc47e03f18c9ce8eb3be41ab0))
+
+## [3.0.6](https://github.com/eduardoborges/use-mask-input/compare/3.0.5...3.0.6) (2023-02-10)
+
+
+### Bug Fixes
+
+* fix regression for cra exports ([b149d78](https://github.com/eduardoborges/use-mask-input/commit/b149d7822dac99db3f308671a13b8fbbe148010c))
+
+## [3.0.5](https://github.com/eduardoborges/use-mask-input/compare/3.0.4...3.0.5) (2023-02-09)
+
+
+### Bug Fixes
+
+* fix module resolution ([ab8a464](https://github.com/eduardoborges/use-mask-input/commit/ab8a464a4cb6fe529d1ff3decc56de925efa68fc))
+
+## [3.0.4](https://github.com/eduardoborges/use-mask-input/compare/3.0.3...3.0.4) (2023-02-09)
+
+
+### Bug Fixes
+
+* fix invalid resolve entry for package fix [#8](https://github.com/eduardoborges/use-mask-input/issues/8) ([91e3fc2](https://github.com/eduardoborges/use-mask-input/commit/91e3fc28b7180bbc6c608dd33eefd92d1c21da78))
+
+## [3.0.3](https://github.com/eduardoborges/use-mask-input/compare/3.0.2...3.0.3) (2023-02-09)
+
+
+### Bug Fixes
+
+* can access nodeName on component unmount fix [#7](https://github.com/eduardoborges/use-mask-input/issues/7) ([a881272](https://github.com/eduardoborges/use-mask-input/commit/a881272be60b77287d68208472280c52331d82e7))
+
+## [3.0.2](https://github.com/eduardoborges/use-mask-input/compare/3.0.1...3.0.2) (2023-02-06)
+
+
+### Bug Fixes
+
+* remove unused deps and fix vulnerabilities ([a49c5d5](https://github.com/eduardoborges/use-mask-input/commit/a49c5d55b485553fe9a79c38af900fc4def24774))
+
+## [3.0.1](https://github.com/eduardoborges/use-mask-input/compare/3.0.0...3.0.1) (2023-01-23)
+
+
+### Bug Fixes
+
+* security fixes ([aad0816](https://github.com/eduardoborges/use-mask-input/commit/aad08168b9349a6199a3bfa0d1340a5f20cae732))
+
+# [3.0.0](https://github.com/eduardoborges/use-mask-input/compare/2.1.0...3.0.0) (2022-10-11)
+
+
+### Features
+
+* simplify API & add react-final-form support. ([981588d](https://github.com/eduardoborges/use-mask-input/commit/981588d54121e66d550eb5df9fe64b5de01d70c6))
+
+
+### BREAKING CHANGES
+
+* update api
+
+# [2.1.0](https://github.com/eduardoborges/use-mask-input/compare/2.0.1...2.1.0) (2022-09-27)
+
+
+### Features
+
+* add react-hook-form 7 integration ([0fd5bfc](https://github.com/eduardoborges/use-mask-input/commit/0fd5bfca4f8a686b9d89eba1f319c055073f51ed))
+
+## [2.0.1](https://github.com/eduardoborges/use-mask-input/compare/2.0.0...2.0.1) (2022-09-27)
+
+
+### Bug Fixes
+
+* enhance actions time ([6ea226c](https://github.com/eduardoborges/use-mask-input/commit/6ea226cf1e49f46ff476ad7c1619c136a54a1954))
+
+# [2.0.0](https://github.com/eduardoborges/use-mask-input/compare/1.1.0...2.0.0) (2022-09-27)
+
+
+### Bug Fixes
+
+* Bump version ([4485125](https://github.com/eduardoborges/use-mask-input/commit/44851258e0b9f767be53d77e279b3604578b8aaa))
+
+
+### BREAKING CHANGES
+
+* update libs to suport new react-hook-form
+
+# [1.1.0](https://github.com/eduardoborges/use-mask-input/compare/1.0.2...1.1.0) (2022-09-27)
+
+
+### Features
+
+* force release ([61d23d3](https://github.com/eduardoborges/use-mask-input/commit/61d23d3f588abe095ec0a81de8249801c39a31bd))

package/README.md

@@ -6,15 +6,23 @@ A React Hook for build elegant and simple input masks.
 
 ---
 
+## Table of Contents
+
+- [Installation](#install)
+- [Usage](#quickstart)
+- [Masking Types](#masking-types)
+  - [Static Masking Type](#static-masking-type)
+  - [Optional Masking Type](#optional-masking-type)
+  - [Dynamic Masking Type](#dynamic-masking-type)
+  - [Alias Masking Type](#alias-masking-type)
+  - [Alternator Masking Type](#alias-masking-type)
+  - [Preprocessing Masking Type](#preprocessing-masking-type)
+
 ## Features
 - 🎯  Simple API
+- 💎  Works like a charm with *Next.js*
 - ✨  Compatible with [React Hook Form](https://github.com/react-hook-form/react-hook-form)
 - 🏁  Compatible with [React Final Form](https://github.com/final-form/react-final-form)
-
-## Know Issues
-
-- Not compatible with Next.js, but we are working on it
-
 ## Install
 
 ```sh
@@ -34,7 +42,7 @@ const App = () => {
 }
 ```
 
-## Usage with React Hook Forms
+### Usage with React Hook Forms
 
 ```jsx
 import React from 'react';
@@ -43,14 +51,17 @@ import { withHookFormMask } from 'use-mask-input';
 
 function App() {
   const { register, handleSubmit } = useForm();
+  const registerWithMask = useHookFormMask(register);
 
   ...
 
   return (
     <form onSubmit={onSubmit}>
       <input
+        {...registerWithMask("phone", ['99 9999-9999', '99999-9999'], {
+          required: true
+        })}
         type="text"
-        {...withHookFormMask(register('phone'), ['(99) 9999 9999', '(99) 9 9999 9999'])}
       />
       <button type="submit">Submit</button>
     </form>
@@ -58,7 +69,7 @@ function App() {
 }
 ```
 
-## Usage with React Final Form
+### Usage with React Final Form
 
 Just use `withMask` normaly.
 
@@ -87,3 +98,133 @@ function App() {
   );
 }
 ```
+
+## Masking types
+
+The `mask` params cabe be
+
+### Static Masking Type
+
+These are the very basics of masking. The mask is defined and will not change during the input.
+
+```tsx
+<input
+  {...registerWithMask("phone", '99 9999-9999')}
+  type="text"
+/>
+```
+
+### Optional Masking Type
+
+It is possible to define some parts in the mask as optional. This is done by using `[ ]`. By example:
+
+```tsx
+<input
+  {...registerWithMask("phone", '99 [9]9999-9999')}
+  type="text"
+/>
+```
+This mask will allow input like (99) 99999-9999 or (99) 9999-9999.
+
+### Dynamic Masking Type
+
+Dynamic masks can change during input. To define a dynamic part use { }.
+
+{n} => n repeats {n|j} => n repeats, with j jitmasking {n,m} => from n to m repeats {n,m|j} => from n to m repeats, with j jitmasking
+
+Also {+} and {} is allowed. + start from 1 and start from 0.
+
+By example:
+
+```tsx
+//static mask with dynamic syntax
+<input
+  {...registerWithMask("phone", "aa-9{4}")}
+  type="text"
+/>
+
+// dynamic mask ~ the 9 def can be occur 1 to 4 times
+<input
+  {...registerWithMask("phone", "aa-9{4}")}
+  type="text"
+/>
+
+// dynamic mask ~ email
+<input
+  {...registerWithMask("phone", "*{1,20}[.*{1,20}][.*{1,20}][.*{1,20}]@*{1,20}[.*{2,6}][.*{1,2}]")}
+  type="text"
+/>
+
+```
+### Alias Masking Type
+
+A Lot of common default "alises" presets, you can use like that:
+```tsx
+<input                         // the alias
+  {...registerWithMask("date", "datetime", {
+    inputFormat: "yyyy-mm-dd",
+  })}
+  type="text"
+/>
+```
+
+You can use together with options like  `inputFormat`, `prefix`, `sufix`, etc. Checkout [API docs](#api)
+
+The avaliable ones is:
+
+ - `datetime`
+ - `email`
+ - `ip`
+ - `datetime`
+ - `cpf`
+ - `email`
+ - `numeric`
+ - `currency`
+ - `decimal`
+ - `integer`
+ - `percentage`
+ - `url`
+ - `ip`
+ - `mac`
+ - `ssn`
+
+### Alternator Masking Type
+
+The alternator syntax is like an OR statement. The mask can be one of the 3 choices specified in the alternator.
+
+To define an alternator use the |. ex: "a|9" => a or 9 "(aaa)|(999)" => aaa or 999 "(aaa|999|9AA)" => aaa or 999 or 9AA
+"aaaa|9999" => aaa a or 9 999
+
+```tsx
+<input
+  {...registerWithMask("phone", "9999-9999|99999-9999")}
+  type="text"
+/>
+
+// or just passing an array
+<input
+  {...registerWithMask("phone", ["9999-9999", "99999-9999"])}
+  type="text"
+/>
+
+```
+
+
+### Preprocessing Masking Type
+
+You can define the mask as a function that can allow you to preprocess the resulting mask. Example sorting for multiple masks or retrieving mask definitions dynamically through ajax. The preprocessing fn should return a valid mask definition.
+
+```tsx
+<input
+  {...registerWithMask("phone", function () {
+    /* do stuff */ return ["[1-]AAA-999", "[1-]999-AAA"];
+  })}
+  type="text"
+/>
+
+```
+
+
+## API
+
+(TODO)

package/dist/index.cjs

@@ -5,7 +5,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var react = require('react');
 var Inputmask = require('inputmask');
 
-const isServer = !(typeof window !== 'undefined' && window.document && window.document.createElement);
 function flow(...funcs) {
     const { length  } = funcs;
     let index = length;
@@ -24,6 +23,8 @@ function flow(...funcs) {
     };
 }
 
+const isServer = !(typeof window !== 'undefined' && window.document && window.document.createElement);
+
 function _define_property$2(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
@@ -52,6 +53,99 @@ function _object_spread$2(target) {
     }
     return target;
 }
+function ownKeys$2(object, enumerableOnly) {
+    var keys = Object.keys(object);
+    if (Object.getOwnPropertySymbols) {
+        var symbols = Object.getOwnPropertySymbols(object);
+        if (enumerableOnly) {
+            symbols = symbols.filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+            });
+        }
+        keys.push.apply(keys, symbols);
+    }
+    return keys;
+}
+function _object_spread_props$2(target, source) {
+    source = source != null ? source : {};
+    if (Object.getOwnPropertyDescriptors) {
+        Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
+    } else {
+        ownKeys$2(Object(source)).forEach(function(key) {
+            Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+        });
+    }
+    return target;
+}
+const getMaskOptions = (mask, _options)=>{
+    const options = _object_spread_props$2(_object_spread$2({}, _options), {
+        jitMasking: false
+    });
+    if (!mask) return options;
+    const masks = {
+        datetime: _object_spread$2({
+            alias: 'datetime',
+            inputFormat: 'dd/mm/yyyy',
+            placeholder: 'dd/mm/yyyy'
+        }, options),
+        cpf: _object_spread$2({
+            mask: '999.999.999-99',
+            placeholder: '___.___.___-__'
+        }, options),
+        cnpj: _object_spread$2({
+            mask: '99.999.999/9999-99',
+            placeholder: '__.___.___/____-__'
+        }, options),
+        email: _object_spread$2({
+            alias: 'email',
+            placeholder: ''
+        }, options),
+        numeric: _object_spread$2({
+            alias: 'numeric',
+            placeholder: ''
+        }, options),
+        currency: _object_spread$2({
+            alias: 'currency',
+            prefix: '$ ',
+            placeholder: ''
+        }, options),
+        decimal: _object_spread$2({
+            alias: 'decimal',
+            placeholder: ''
+        }, options),
+        integer: _object_spread$2({
+            alias: 'integer',
+            placeholder: ''
+        }, options),
+        percentage: _object_spread$2({
+            alias: 'percentage',
+            placeholder: ' %',
+            suffix: ' %'
+        }, options),
+        url: _object_spread$2({
+            alias: 'url',
+            placeholder: 'https://'
+        }, options),
+        ip: _object_spread$2({
+            alias: 'ip'
+        }, options),
+        mac: _object_spread$2({
+            alias: 'mac'
+        }, options),
+        ssn: _object_spread$2({
+            alias: 'ssn'
+        }, options)
+    };
+    if (typeof mask === 'string') {
+        if (masks[mask]) return masks[mask];
+    } else if (typeof mask === 'object') {
+        return _object_spread$2({}, mask, options);
+    }
+    return _object_spread$2({
+        mask
+    }, options);
+};
+
 const useInputMask = (props)=>{
     const { mask , register , options  } = props;
     const ref = react.useRef(null);
@@ -59,9 +153,7 @@ const useInputMask = (props)=>{
     react.useEffect(()=>{
         if (!isServer) {
             if (!ref.current) return;
-            const maskInput = Inputmask(_object_spread$2({
-                mask
-            }, options));
+            const maskInput = Inputmask(getMaskOptions(mask, options));
             maskInput.mask(ref.current);
             if (register && ref.current) {
                 register(ref.current);
@@ -103,7 +195,7 @@ function _object_spread$1(target) {
     }
     return target;
 }
-function ownKeys(object, enumerableOnly) {
+function ownKeys$1(object, enumerableOnly) {
     var keys = Object.keys(object);
     if (Object.getOwnPropertySymbols) {
         var symbols = Object.getOwnPropertySymbols(object);
@@ -116,12 +208,12 @@ function ownKeys(object, enumerableOnly) {
     }
     return keys;
 }
-function _object_spread_props(target, source) {
+function _object_spread_props$1(target, source) {
     source = source != null ? source : {};
     if (Object.getOwnPropertyDescriptors) {
         Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
     } else {
-        ownKeys(Object(source)).forEach(function(key) {
+        ownKeys$1(Object(source)).forEach(function(key) {
             Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
         });
     }
@@ -132,19 +224,28 @@ const withHookFormMask = (register, mask, options)=>{
     let newRef;
     if (register) {
         const { ref  } = register;
-        const maskInput = Inputmask(_object_spread$1({
-            mask: mask || undefined
-        }, options));
+        const maskInput = Inputmask(getMaskOptions(mask, options));
         newRef = flow((_ref)=>{
             if (_ref) maskInput.mask(_ref);
             return _ref;
         }, ref);
     }
-    return _object_spread_props(_object_spread$1({}, register), {
+    return _object_spread_props$1(_object_spread$1({}, register), {
         ref: newRef
     });
 };
 
+const withMask = (mask, options)=>(input)=>{
+        //
+        if (isServer) return input;
+        if (mask === null) return input;
+        const maskInput = Inputmask(getMaskOptions(mask, options));
+        if (input) {
+            maskInput.mask(input);
+        }
+        return input;
+    };
+
 function _define_property(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
@@ -173,19 +274,76 @@ function _object_spread(target) {
     }
     return target;
 }
-const withMask = (mask, options)=>(input)=>{
-        //
-        if (isServer) return input;
-        const maskInput = Inputmask(_object_spread({
-            mask: mask || undefined
-        }, options));
-        if (input) {
-            maskInput.mask(input);
+function ownKeys(object, enumerableOnly) {
+    var keys = Object.keys(object);
+    if (Object.getOwnPropertySymbols) {
+        var symbols = Object.getOwnPropertySymbols(object);
+        if (enumerableOnly) {
+            symbols = symbols.filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+            });
         }
-        return input;
+        keys.push.apply(keys, symbols);
+    }
+    return keys;
+}
+function _object_spread_props(target, source) {
+    source = source != null ? source : {};
+    if (Object.getOwnPropertyDescriptors) {
+        Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
+    } else {
+        ownKeys(Object(source)).forEach(function(key) {
+            Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+        });
+    }
+    return target;
+}
+function _object_without_properties(source, excluded) {
+    if (source == null) return {};
+    var target = _object_without_properties_loose(source, excluded);
+    var key, i;
+    if (Object.getOwnPropertySymbols) {
+        var sourceSymbolKeys = Object.getOwnPropertySymbols(source);
+        for(i = 0; i < sourceSymbolKeys.length; i++){
+            key = sourceSymbolKeys[i];
+            if (excluded.indexOf(key) >= 0) continue;
+            if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue;
+            target[key] = source[key];
+        }
+    }
+    return target;
+}
+function _object_without_properties_loose(source, excluded) {
+    if (source == null) return {};
+    var target = {};
+    var sourceKeys = Object.keys(source);
+    var key, i;
+    for(i = 0; i < sourceKeys.length; i++){
+        key = sourceKeys[i];
+        if (excluded.indexOf(key) >= 0) continue;
+        target[key] = source[key];
+    }
+    return target;
+}
+function useHookFormMask(registerFn) {
+    return (fieldName, mask, options)=>{
+        if (!registerFn) throw new Error('registerFn is required');
+        const _registerFn = registerFn(fieldName), { ref  } = _registerFn, restRegister = _object_without_properties(_registerFn, [
+            "ref"
+        ]);
+        const maskInput = Inputmask(getMaskOptions(mask, options));
+        const newRef = flow((_ref)=>{
+            if (_ref) maskInput.mask(_ref);
+            return _ref;
+        }, ref);
+        return _object_spread_props(_object_spread({}, restRegister), {
+            ref: newRef
+        });
     };
+}
 
 exports.default = useInputMask;
+exports.useHookFormMask = useHookFormMask;
 exports.withHookFormMask = withHookFormMask;
 exports.withMask = withMask;
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":["../src/utils.ts","../src/useMaskInput.ts","../src/withHookFormMask.ts","../src/withMask.ts"],"sourcesContent":["export const isServer = !(\n  typeof window !== 'undefined'\n  && window.document\n  && window.document.createElement\n);\n\nexport function flow(...funcs: Array<Function>) : Function {\n  const { length } = funcs;\n  let index = length;\n  while (index--) {\n    if (typeof funcs[index] !== 'function') {\n      throw new TypeError('Expected a function');\n    }\n  }\n  return (...args: Array<Function>) => {\n    let i = 0;\n    let result = length ? funcs[i].apply(this, args) : args[0];\n    while (++i < length) {\n      result = funcs[i].call(this, result);\n    }\n    return result;\n  };\n}\n","import { useEffect, useRef } from 'react';\nimport Inputmask from 'inputmask';\nimport { isServer } from './utils';\n\ninterface UseInputMaskOptions {\n  mask: Inputmask.Options['mask']\n  register?(element: HTMLElement): void\n  options?: Inputmask.Options\n}\n\nconst useInputMask = (props: UseInputMaskOptions) => {\n  const { mask, register, options } = props;\n  const ref = useRef<HTMLInputElement>(null);\n  if (isServer) return ref;\n\n  useEffect(() => {\n    if (!isServer) {\n      if (!ref.current) return;\n\n      const maskInput = Inputmask({\n        mask,\n        ...options,\n      });\n\n      maskInput.mask(ref.current);\n\n      if (register && ref.current) {\n        register(ref.current);\n      }\n    }\n  }, [mask, register, options]);\n\n  return ref;\n};\n\nexport default useInputMask;\n","import Inputmask from 'inputmask';\nimport { RefCallback } from 'react';\nimport { flow } from './utils';\nimport { Mask, Options, Register } from './types';\n\nexport const withHookFormMask = (register: Register, mask: Mask, options?: Options): Register => {\n  //\n  let newRef;\n\n  if (register) {\n    const { ref } = register;\n\n    const maskInput = Inputmask({\n      mask: mask || undefined,\n      ...options,\n    });\n\n    newRef = flow((_ref: HTMLElement) => {\n      if (_ref) maskInput.mask(_ref);\n      return _ref;\n    }, ref) as RefCallback<HTMLElement>;\n  }\n\n  return {\n    ...register,\n    ref: newRef as RefCallback<HTMLElement>,\n  };\n};\n","import Inputmask from 'inputmask';\nimport { isServer } from './utils';\nimport { Input, Mask, Options } from './types';\n\nexport const withMask = (mask?: Mask, options?: Options) => (input: Input) => {\n  //\n  if (isServer) return input;\n\n  const maskInput = Inputmask({\n    mask: mask || undefined,\n    ...options,\n  });\n\n  if (input) {\n    maskInput.mask(input);\n  }\n\n  return input;\n};\n"],"names":["isServer","window","document","createElement","flow","funcs","length","index","TypeError","args","i","result","apply","call","useInputMask","props","mask","register","options","ref","useRef","useEffect","current","maskInput","Inputmask","_object_spread","withHookFormMask","newRef","undefined","_ref","withMask","input"],"mappings":";;;;;;;AAAO,MAAMA,QAAAA,GAAW,EACtB,OAAOC,MAAW,KAAA,WAAA,IACfA,MAAOC,CAAAA,QAAQ,IACfD,MAAOC,CAAAA,QAAQ,CAACC,aAAa,CAChC,CAAA;AAEK,SAASC,IAAAA,CAAK,GAAGC,KAAsB,EAAa;IACzD,MAAM,EAAEC,MAAM,GAAE,GAAGD,KAAAA,CAAAA;AACnB,IAAA,IAAIE,KAAQD,GAAAA,MAAAA,CAAAA;AACZ,IAAA,MAAOC,KAAS,EAAA,CAAA;AACd,QAAA,IAAI,OAAOF,KAAK,CAACE,KAAAA,CAAM,KAAK,UAAY,EAAA;YACtC,MAAM,IAAIC,UAAU,qBAAuB,CAAA,CAAA;SAC5C;AACH,KAAA;IACA,OAAO,CAAC,GAAGC,IAA0B,GAAA;AACnC,QAAA,IAAIC,CAAI,GAAA,CAAA,CAAA;AACR,QAAA,IAAIC,MAASL,GAAAA,MAAAA,GAASD,KAAK,CAACK,CAAE,CAAA,CAACE,KAAK,CAAC,IAAI,EAAEH,IAAQA,CAAAA,GAAAA,IAAI,CAAC,CAAE,CAAA,CAAA;QAC1D,MAAO,EAAEC,IAAIJ,MAAQ,CAAA;AACnBK,YAAAA,MAAAA,GAASN,KAAK,CAACK,CAAAA,CAAE,CAACG,IAAI,CAAC,IAAI,EAAEF,MAAAA,CAAAA,CAAAA;AAC/B,SAAA;QACA,OAAOA,MAAAA,CAAAA;AACT,KAAA,CAAA;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACZMG,MAAAA,YAAAA,GAAe,CAACC,KAA+B,GAAA;AACnD,IAAA,MAAM,EAAEC,IAAI,GAAEC,WAAUC,OAAAA,GAAS,GAAGH,KAAAA,CAAAA;IACpC,MAAMI,GAAAA,GAAMC,aAAyB,IAAI,CAAA,CAAA;AACzC,IAAA,IAAIpB,UAAU,OAAOmB,GAAAA,CAAAA;AAErBE,IAAAA,eAAAA,CAAU,IAAM;AACd,QAAA,IAAI,CAACrB,QAAU,EAAA;YACb,IAAI,CAACmB,GAAIG,CAAAA,OAAO,EAAE,OAAA;AAElB,YAAA,MAAMC,YAAYC,SAAU,CAAAC,gBAAA,CAAA;AAC1BT,gBAAAA,IAAAA;AACGE,aAAAA,EAAAA,OAAAA,CAAAA,CAAAA,CAAAA;YAGLK,SAAUP,CAAAA,IAAI,CAACG,GAAAA,CAAIG,OAAO,CAAA,CAAA;YAE1B,IAAIL,QAAAA,IAAYE,GAAIG,CAAAA,OAAO,EAAE;AAC3BL,gBAAAA,QAAAA,CAASE,IAAIG,OAAO,CAAA,CAAA;aACrB;SACF;KACA,EAAA;AAACN,QAAAA,IAAAA;AAAMC,QAAAA,QAAAA;AAAUC,QAAAA,OAAAA;AAAQ,KAAA,CAAA,CAAA;IAE5B,OAAOC,GAAAA,CAAAA;AACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AC5BaO,MAAAA,gBAAAA,GAAmB,CAACT,QAAAA,EAAoBD,MAAYE,OAAgC,GAAA;;IAE/F,IAAIS,MAAAA,CAAAA;AAEJ,IAAA,IAAIV,QAAU,EAAA;QACZ,MAAM,EAAEE,GAAG,GAAE,GAAGF,QAAAA,CAAAA;AAEhB,QAAA,MAAMM,YAAYC,SAAU,CAAAC,gBAAA,CAAA;AAC1BT,YAAAA,IAAAA,EAAMA,IAAQY,IAAAA,SAAAA;AACXV,SAAAA,EAAAA,OAAAA,CAAAA,CAAAA,CAAAA;QAGLS,MAASvB,GAAAA,IAAAA,CAAK,CAACyB,IAAsB,GAAA;YACnC,IAAIA,IAAAA,EAAMN,SAAUP,CAAAA,IAAI,CAACa,IAAAA,CAAAA,CAAAA;YACzB,OAAOA,IAAAA,CAAAA;SACNV,EAAAA,GAAAA,CAAAA,CAAAA;KACJ;AAED,IAAA,OAAO,oBACFF,CAAAA,gBAAAA,CAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EAAAA;QACHE,GAAKQ,EAAAA,MAAAA;;AAET;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MCvBaG,QAAW,GAAA,CAACd,IAAaE,EAAAA,OAAAA,GAAsB,CAACa,KAAiB,GAAA;;AAE5E,QAAA,IAAI/B,UAAU,OAAO+B,KAAAA,CAAAA;AAErB,QAAA,MAAMR,YAAYC,SAAU,CAAA,cAAA,CAAA;AAC1BR,YAAAA,IAAAA,EAAMA,IAAQY,IAAAA,SAAAA;AACXV,SAAAA,EAAAA,OAAAA,CAAAA,CAAAA,CAAAA;AAGL,QAAA,IAAIa,KAAO,EAAA;AACTR,YAAAA,SAAAA,CAAUP,IAAI,CAACe,KAAAA,CAAAA,CAAAA;SAChB;QAED,OAAOA,KAAAA,CAAAA;;;;;;;"}
+{"version":3,"file":"index.cjs","sources":["../src/utils/flow.ts","../src/utils/isServer.ts","../src/utils/getMaskOptions.ts","../src/useMaskInput.ts","../src/withHookFormMask.ts","../src/withMask.ts","../src/useHookFormMask.ts"],"sourcesContent":["export function flow(...funcs: Array<Function>) : Function {\n  const { length } = funcs;\n  let index = length;\n  while (index--) {\n    if (typeof funcs[index] !== 'function') {\n      throw new TypeError('Expected a function');\n    }\n  }\n  return (...args: Array<Function>) => {\n    let i = 0;\n    let result = length ? funcs[i].apply(this, args) : args[0];\n    while (++i < length) {\n      result = funcs[i].call(this, result);\n    }\n    return result;\n  };\n}\n","export const isServer = !(\n  typeof window !== 'undefined'\n  && window.document\n  && window.document.createElement\n);\n","import { Mask, Options } from '../types';\n\nexport const getMaskOptions = (mask?: Mask, _options?: Options): Options => {\n  const options: Options = {\n    ..._options,\n    jitMasking: false,\n  };\n  if (!mask) return options;\n\n  const masks: Record<string, Inputmask.Options> = {\n    datetime: {\n      alias: 'datetime',\n      inputFormat: 'dd/mm/yyyy',\n      placeholder: 'dd/mm/yyyy',\n      ...options,\n    },\n    cpf: {\n      mask: '999.999.999-99',\n      placeholder: '___.___.___-__',\n      ...options,\n    },\n    cnpj: {\n      mask: '99.999.999/9999-99',\n      placeholder: '__.___.___/____-__',\n      ...options,\n    },\n    email: {\n      alias: 'email',\n      placeholder: '',\n      ...options,\n    },\n    numeric: {\n      alias: 'numeric',\n      placeholder: '',\n      ...options,\n    },\n    currency: {\n      alias: 'currency',\n      prefix: '$ ',\n      placeholder: '',\n      ...options,\n    },\n    decimal: {\n      alias: 'decimal',\n      placeholder: '',\n      ...options,\n    },\n    integer: {\n      alias: 'integer',\n      placeholder: '',\n      ...options,\n    },\n    percentage: {\n      alias: 'percentage',\n      placeholder: ' %',\n      suffix: ' %',\n      ...options,\n    },\n    url: {\n      alias: 'url',\n      placeholder: 'https://',\n      ...options,\n    },\n    ip: {\n      alias: 'ip',\n      ...options,\n    },\n    mac: {\n      alias: 'mac',\n      ...options,\n    },\n    ssn: {\n      alias: 'ssn',\n      ...options,\n    },\n\n  };\n\n  if (typeof mask === 'string') {\n    if (masks[mask]) return masks[mask];\n  } else if (typeof mask === 'object') {\n    return {\n      ...mask,\n      ...options,\n    };\n  }\n\n  return {\n    mask,\n    ...options,\n  };\n};\n","import { useEffect, useRef } from 'react';\nimport Inputmask from 'inputmask';\nimport { getMaskOptions, isServer } from './utils';\nimport { Mask, Options } from './types';\n\ninterface UseInputMaskOptions {\n  mask: Mask,\n  register?(element: HTMLElement): void\n  options?: Options\n}\n\nconst useInputMask = (props: UseInputMaskOptions) => {\n  const { mask, register, options } = props;\n  const ref = useRef<HTMLInputElement>(null);\n  if (isServer) return ref;\n\n  useEffect(() => {\n    if (!isServer) {\n      if (!ref.current) return;\n\n      const maskInput = Inputmask(getMaskOptions(mask, options));\n\n      maskInput.mask(ref.current);\n\n      if (register && ref.current) {\n        register(ref.current);\n      }\n    }\n  }, [mask, register, options]);\n\n  return ref;\n};\n\nexport default useInputMask;\n","import Inputmask from 'inputmask';\nimport { RefCallback } from 'react';\nimport { flow, getMaskOptions } from './utils';\nimport { Mask, Options, UseFormRegisterReturn } from './types';\n\nexport const withHookFormMask = (\n  register: UseFormRegisterReturn,\n  mask: Mask,\n  options?: Options,\n): UseFormRegisterReturn => {\n  //\n  let newRef;\n\n  if (register) {\n    const { ref } = register;\n\n    const maskInput = Inputmask(getMaskOptions(mask, options));\n\n    newRef = flow((_ref: HTMLElement) => {\n      if (_ref) maskInput.mask(_ref);\n      return _ref;\n    }, ref) as RefCallback<HTMLElement>;\n  }\n\n  return {\n    ...register,\n    ref: newRef as RefCallback<HTMLElement>,\n  };\n};\n","import Inputmask from 'inputmask';\nimport { getMaskOptions, isServer } from './utils';\nimport { Input, Mask, Options } from './types';\n\nexport const withMask = (mask: Mask, options?: Options) => (input: Input) => {\n  //\n  if (isServer) return input;\n  if (mask === null) return input;\n\n  const maskInput = Inputmask(getMaskOptions(mask, options));\n\n  if (input) {\n    maskInput.mask(input);\n  }\n\n  return input;\n};\n","import Inputmask from 'inputmask';\nimport { RefCallback } from 'react';\nimport {\n  FieldValues, Path, UseFormRegister, RegisterOptions,\n} from 'react-hook-form';\nimport { flow, getMaskOptions } from './utils';\nimport { Mask, Options } from './types';\n\nexport function useHookFormMask<\n  T extends FieldValues, D extends RegisterOptions,\n>(registerFn: UseFormRegister<T>) {\n  return (fieldName: Path<T>, mask: Mask, options?: Options & D) => {\n    if (!registerFn) throw new Error('registerFn is required');\n\n    const { ref, ...restRegister } = registerFn(fieldName);\n\n    const maskInput = Inputmask(getMaskOptions(mask, options));\n\n    const newRef = flow((_ref: HTMLElement) => {\n      if (_ref) maskInput.mask(_ref);\n      return _ref;\n    }, ref) as RefCallback<HTMLElement>;\n\n    return {\n      ...restRegister,\n      ref: newRef as RefCallback<HTMLElement>,\n    };\n  };\n}\n"],"names":["flow","funcs","length","index","TypeError","args","i","result","apply","call","isServer","window","document","createElement","getMaskOptions","mask","_options","options","_object_spread_props","jitMasking","masks","datetime","_object_spread","alias","inputFormat","placeholder","cpf","cnpj","email","numeric","currency","prefix","decimal","integer","percentage","suffix","url","ip","mac","ssn","useInputMask","props","register","ref","useRef","useEffect","current","maskInput","Inputmask","withHookFormMask","newRef","_ref","withMask","input","useHookFormMask","registerFn","fieldName","Error","restRegister"],"mappings":";;;;;;;AAAO,SAASA,IAAAA,CAAK,GAAGC,KAAsB,EAAa;IACzD,MAAM,EAAEC,MAAM,GAAE,GAAGD,KAAAA,CAAAA;AACnB,IAAA,IAAIE,KAAQD,GAAAA,MAAAA,CAAAA;AACZ,IAAA,MAAOC,KAAS,EAAA,CAAA;AACd,QAAA,IAAI,OAAOF,KAAK,CAACE,KAAAA,CAAM,KAAK,UAAY,EAAA;YACtC,MAAM,IAAIC,UAAU,qBAAuB,CAAA,CAAA;SAC5C;AACH,KAAA;IACA,OAAO,CAAC,GAAGC,IAA0B,GAAA;AACnC,QAAA,IAAIC,CAAI,GAAA,CAAA,CAAA;AACR,QAAA,IAAIC,MAASL,GAAAA,MAAAA,GAASD,KAAK,CAACK,CAAE,CAAA,CAACE,KAAK,CAAC,IAAI,EAAEH,IAAQA,CAAAA,GAAAA,IAAI,CAAC,CAAE,CAAA,CAAA;QAC1D,MAAO,EAAEC,IAAIJ,MAAQ,CAAA;AACnBK,YAAAA,MAAAA,GAASN,KAAK,CAACK,CAAAA,CAAE,CAACG,IAAI,CAAC,IAAI,EAAEF,MAAAA,CAAAA,CAAAA;AAC/B,SAAA;QACA,OAAOA,MAAAA,CAAAA;AACT,KAAA,CAAA;AACF;;AChBO,MAAMG,QAAAA,GAAW,EACtB,OAAOC,MAAW,KAAA,WAAA,IACfA,MAAOC,CAAAA,QAAQ,IACfD,MAAOC,CAAAA,QAAQ,CAACC,aAAa,CAChC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACFK,MAAMC,cAAAA,GAAiB,CAACC,IAAAA,EAAaC,QAAgC,GAAA;AAC1E,IAAA,MAAMC,UAAmBC,sBACpBF,CAAAA,gBAAAA,CAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EAAAA;AACHG,QAAAA,UAAAA,EAAY,KAAK;;IAEnB,IAAI,CAACJ,MAAM,OAAOE,OAAAA,CAAAA;AAElB,IAAA,MAAMG,KAA2C,GAAA;QAC/CC,QAAU,EAAAC,gBAAA,CAAA;YACRC,KAAO,EAAA,UAAA;YACPC,WAAa,EAAA,YAAA;YACbC,WAAa,EAAA,YAAA;AACVR,SAAAA,EAAAA,OAAAA,CAAAA;QAELS,GAAK,EAAAJ,gBAAA,CAAA;YACHP,IAAM,EAAA,gBAAA;YACNU,WAAa,EAAA,gBAAA;AACVR,SAAAA,EAAAA,OAAAA,CAAAA;QAELU,IAAM,EAAAL,gBAAA,CAAA;YACJP,IAAM,EAAA,oBAAA;YACNU,WAAa,EAAA,oBAAA;AACVR,SAAAA,EAAAA,OAAAA,CAAAA;QAELW,KAAO,EAAAN,gBAAA,CAAA;YACLC,KAAO,EAAA,OAAA;YACPE,WAAa,EAAA,EAAA;AACVR,SAAAA,EAAAA,OAAAA,CAAAA;QAELY,OAAS,EAAAP,gBAAA,CAAA;YACPC,KAAO,EAAA,SAAA;YACPE,WAAa,EAAA,EAAA;AACVR,SAAAA,EAAAA,OAAAA,CAAAA;QAELa,QAAU,EAAAR,gBAAA,CAAA;YACRC,KAAO,EAAA,UAAA;YACPQ,MAAQ,EAAA,IAAA;YACRN,WAAa,EAAA,EAAA;AACVR,SAAAA,EAAAA,OAAAA,CAAAA;QAELe,OAAS,EAAAV,gBAAA,CAAA;YACPC,KAAO,EAAA,SAAA;YACPE,WAAa,EAAA,EAAA;AACVR,SAAAA,EAAAA,OAAAA,CAAAA;QAELgB,OAAS,EAAAX,gBAAA,CAAA;YACPC,KAAO,EAAA,SAAA;YACPE,WAAa,EAAA,EAAA;AACVR,SAAAA,EAAAA,OAAAA,CAAAA;QAELiB,UAAY,EAAAZ,gBAAA,CAAA;YACVC,KAAO,EAAA,YAAA;YACPE,WAAa,EAAA,IAAA;YACbU,MAAQ,EAAA,IAAA;AACLlB,SAAAA,EAAAA,OAAAA,CAAAA;QAELmB,GAAK,EAAAd,gBAAA,CAAA;YACHC,KAAO,EAAA,KAAA;YACPE,WAAa,EAAA,UAAA;AACVR,SAAAA,EAAAA,OAAAA,CAAAA;QAELoB,EAAI,EAAAf,gBAAA,CAAA;YACFC,KAAO,EAAA,IAAA;AACJN,SAAAA,EAAAA,OAAAA,CAAAA;QAELqB,GAAK,EAAAhB,gBAAA,CAAA;YACHC,KAAO,EAAA,KAAA;AACJN,SAAAA,EAAAA,OAAAA,CAAAA;QAELsB,GAAK,EAAAjB,gBAAA,CAAA;YACHC,KAAO,EAAA,KAAA;AACJN,SAAAA,EAAAA,OAAAA,CAAAA;AAGP,KAAA,CAAA;IAEA,IAAI,OAAOF,SAAS,QAAU,EAAA;AAC5B,QAAA,IAAIK,KAAK,CAACL,IAAAA,CAAK,EAAE,OAAOK,KAAK,CAACL,IAAK,CAAA,CAAA;KAC9B,MAAA,IAAI,OAAOA,IAAAA,KAAS,QAAU,EAAA;AACnC,QAAA,OAAOO,qBACFP,IACAE,EAAAA,OAAAA,CAAAA,CAAAA;KAEN;IAED,OAAOK,gBAAA,CAAA;AACLP,QAAAA,IAAAA;AACGE,KAAAA,EAAAA,OAAAA,CAAAA,CAAAA;AAEP,CAAE;;AChFIuB,MAAAA,YAAAA,GAAe,CAACC,KAA+B,GAAA;AACnD,IAAA,MAAM,EAAE1B,IAAI,GAAE2B,WAAUzB,OAAAA,GAAS,GAAGwB,KAAAA,CAAAA;IACpC,MAAME,GAAAA,GAAMC,aAAyB,IAAI,CAAA,CAAA;AACzC,IAAA,IAAIlC,UAAU,OAAOiC,GAAAA,CAAAA;AAErBE,IAAAA,eAAAA,CAAU,IAAM;AACd,QAAA,IAAI,CAACnC,QAAU,EAAA;YACb,IAAI,CAACiC,GAAIG,CAAAA,OAAO,EAAE,OAAA;YAElB,MAAMC,SAAAA,GAAYC,SAAUlC,CAAAA,cAAAA,CAAeC,IAAME,EAAAA,OAAAA,CAAAA,CAAAA,CAAAA;YAEjD8B,SAAUhC,CAAAA,IAAI,CAAC4B,GAAAA,CAAIG,OAAO,CAAA,CAAA;YAE1B,IAAIJ,QAAAA,IAAYC,GAAIG,CAAAA,OAAO,EAAE;AAC3BJ,gBAAAA,QAAAA,CAASC,IAAIG,OAAO,CAAA,CAAA;aACrB;SACF;KACA,EAAA;AAAC/B,QAAAA,IAAAA;AAAM2B,QAAAA,QAAAA;AAAUzB,QAAAA,OAAAA;AAAQ,KAAA,CAAA,CAAA;IAE5B,OAAO0B,GAAAA,CAAAA;AACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AC1BaM,MAAAA,gBAAAA,GAAmB,CAC9BP,QAAAA,EACA3B,MACAE,OAC0B,GAAA;;IAE1B,IAAIiC,MAAAA,CAAAA;AAEJ,IAAA,IAAIR,QAAU,EAAA;QACZ,MAAM,EAAEC,GAAG,GAAE,GAAGD,QAAAA,CAAAA;QAEhB,MAAMK,SAAAA,GAAYC,SAAUlC,CAAAA,cAAAA,CAAeC,IAAME,EAAAA,OAAAA,CAAAA,CAAAA,CAAAA;QAEjDiC,MAASlD,GAAAA,IAAAA,CAAK,CAACmD,IAAsB,GAAA;YACnC,IAAIA,IAAAA,EAAMJ,SAAUhC,CAAAA,IAAI,CAACoC,IAAAA,CAAAA,CAAAA;YACzB,OAAOA,IAAAA,CAAAA;SACNR,EAAAA,GAAAA,CAAAA,CAAAA;KACJ;AAED,IAAA,OAAOzB,sBACFwB,CAAAA,gBAAAA,CAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EAAAA;QACHC,GAAKO,EAAAA,MAAAA;;AAET;;MCxBaE,QAAW,GAAA,CAACrC,IAAYE,EAAAA,OAAAA,GAAsB,CAACoC,KAAiB,GAAA;;AAE3E,QAAA,IAAI3C,UAAU,OAAO2C,KAAAA,CAAAA;QACrB,IAAItC,IAAAA,KAAS,IAAI,EAAE,OAAOsC,KAAAA,CAAAA;QAE1B,MAAMN,SAAAA,GAAYC,SAAUlC,CAAAA,cAAAA,CAAeC,IAAME,EAAAA,OAAAA,CAAAA,CAAAA,CAAAA;AAEjD,QAAA,IAAIoC,KAAO,EAAA;AACTN,YAAAA,SAAAA,CAAUhC,IAAI,CAACsC,KAAAA,CAAAA,CAAAA;SAChB;QAED,OAAOA,KAAAA,CAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACPF,SAASC,eAEdC,CAAAA,UAA8B,EAAE;IAChC,OAAO,CAACC,SAAoBzC,EAAAA,IAAAA,EAAYE,OAA0B,GAAA;AAChE,QAAA,IAAI,CAACsC,UAAAA,EAAY,MAAM,IAAIE,MAAM,wBAA0B,CAAA,CAAA;QAE3D,MAAiCF,WAAAA,GAAAA,WAAWC,SAAtC,CAAA,EAAA,EAAEb,MAAsB,GAAGY,aAAjBG,YAAiBH,GAAAA,0BAAAA,CAAAA,WAAAA,EAAAA;AAAzBZ,YAAAA,KAAAA;;QAER,MAAMI,SAAAA,GAAYC,SAAUlC,CAAAA,cAAAA,CAAeC,IAAME,EAAAA,OAAAA,CAAAA,CAAAA,CAAAA;QAEjD,MAAMiC,MAAAA,GAASlD,IAAK,CAAA,CAACmD,IAAsB,GAAA;YACzC,IAAIA,IAAAA,EAAMJ,SAAUhC,CAAAA,IAAI,CAACoC,IAAAA,CAAAA,CAAAA;YACzB,OAAOA,IAAAA,CAAAA;SACNR,EAAAA,GAAAA,CAAAA,CAAAA;AAEH,QAAA,OAAO,oBACFe,CAAAA,cAAAA,CAAAA,EAAAA,EAAAA,YAAAA,CAAAA,EAAAA;YACHf,GAAKO,EAAAA,MAAAA;;AAET,KAAA,CAAA;AACF;;;;;;;"}

package/dist/index.d.ts

@@ -1,21 +1,34 @@
 import * as react from 'react';
-import Inputmask$1 from 'inputmask';
-import { UseFormRegisterReturn } from 'react-hook-form';
+import * as react_hook_form from 'react-hook-form';
+import { UseFormRegisterReturn, FieldValues, RegisterOptions, UseFormRegister, Path } from 'react-hook-form';
+
+type Mask = 'email' | 'cpf' | 'datetime' | 'numeric' | 'currency' | 'decimal' | 'integer' | (string & {}) | (string[] & {}) | null;
+type Options = Inputmask.Options;
+type Input = HTMLInputElement | HTMLTextAreaElement | HTMLElement | HTMLInputElement | null;
 
 interface UseInputMaskOptions {
-    mask: Inputmask$1.Options['mask'];
+    mask: Mask;
     register?(element: HTMLElement): void;
-    options?: Inputmask$1.Options;
+    options?: Options;
 }
 declare const useInputMask: (props: UseInputMaskOptions) => react.RefObject<HTMLInputElement>;
 
-type Register = UseFormRegisterReturn;
-type Mask = Inputmask.Options['mask'];
-type Options = Inputmask.Options;
-type Input = HTMLInputElement | HTMLTextAreaElement | HTMLElement | HTMLInputElement | null;
+declare const withHookFormMask: (register: UseFormRegisterReturn, mask: Mask, options?: Options) => UseFormRegisterReturn;
 
-declare const withHookFormMask: (register: Register, mask: Mask, options?: Options) => Register;
+declare const withMask: (mask: Mask, options?: Options) => (input: Input) => Input;
 
-declare const withMask: (mask?: Mask, options?: Options) => (input: Input) => Input;
+declare function useHookFormMask<T extends FieldValues, D extends RegisterOptions>(registerFn: UseFormRegister<T>): (fieldName: Path<T>, mask: Mask, options?: Options & D) => {
+    ref: (instance: HTMLElement | null) => void;
+    onChange: react_hook_form.ChangeHandler;
+    onBlur: react_hook_form.ChangeHandler;
+    name: Path<T>;
+    min?: string | number | undefined;
+    max?: string | number | undefined;
+    maxLength?: number | undefined;
+    minLength?: number | undefined;
+    pattern?: string | undefined;
+    required?: boolean | undefined;
+    disabled?: boolean | undefined;
+};
 
-export { useInputMask as default, withHookFormMask, withMask };
+export { useInputMask as default, useHookFormMask, withHookFormMask, withMask };