use-mask-input 1.0.2 → 2.0.0

package/dist/example/App.example.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+declare function App(): JSX.Element;
+export default App;

package/dist/index.js

@@ -4,7 +4,7 @@ var react = require('react');
 var Inputmask = _interopDefault(require('inputmask'));
 
 function _extends() {
-  _extends = Object.assign || function (target) {
+  _extends = Object.assign ? Object.assign.bind() : function (target) {
     for (var i = 1; i < arguments.length; i++) {
       var source = arguments[i];
 
@@ -17,7 +17,6 @@ function _extends() {
 
     return target;
   };
-
   return _extends.apply(this, arguments);
 }
 

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/useMaskInput.ts"],"sourcesContent":["import { useEffect, useRef } from 'react';\nimport Inputmask, { Options } from 'inputmask';\n\ninterface UseInputMaskOptions {\n  mask: Options['mask']\n  register?(element: HTMLElement): void\n  options?: Options\n}\n\nconst useInputMask = (props: UseInputMaskOptions) => {\n  const { mask, register, options } = props;\n\n  const ref = useRef<HTMLInputElement>(null);\n\n  useEffect(() => {\n    if (!ref.current) {\n      return;\n    }\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  }, [mask, register, options]);\n\n  return ref;\n};\n\nexport default useInputMask;\n"],"names":["useInputMask","props","mask","register","options","ref","useRef","useEffect","current","maskInput","Inputmask"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AASA,IAAMA,YAAY,GAAG,SAAfA,YAAe,CAACC,KAAD;MACXC,OAA4BD,MAA5BC;MAAMC,WAAsBF,MAAtBE;MAAUC,UAAYH,MAAZG;AAExB,MAAMC,GAAG,GAAGC,YAAM,CAAmB,IAAnB,CAAlB;AAEAC,EAAAA,eAAS,CAAC;AACR,QAAI,CAACF,GAAG,CAACG,OAAT,EAAkB;AAChB;AACD;;AAED,QAAMC,SAAS,GAAGC,SAAS;AACzBR,MAAAA,IAAI,EAAJA;AADyB,OAEtBE,OAFsB,EAA3B;AAKAK,IAAAA,SAAS,CAACP,IAAV,CAAeG,GAAG,CAACG,OAAnB;;AAEA,QAAIL,QAAQ,IAAIE,GAAG,CAACG,OAApB,EAA6B;AAC3BL,MAAAA,QAAQ,CAACE,GAAG,CAACG,OAAL,CAAR;AACD;AACF,GAfQ,EAeN,CAACN,IAAD,EAAOC,QAAP,EAAiBC,OAAjB,CAfM,CAAT;AAiBA,SAAOC,GAAP;AACD,CAvBD;;;;"}
+{"version":3,"file":"index.js","sources":["../src/useMaskInput.ts"],"sourcesContent":["import { useEffect, useRef } from 'react';\nimport Inputmask from 'inputmask';\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\n  const ref = useRef<HTMLInputElement>(null);\n\n  useEffect(() => {\n    if (!ref.current) {\n      return;\n    }\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  }, [mask, register, options]);\n\n  return ref;\n};\n\nexport default useInputMask;\n"],"names":["useInputMask","props","mask","register","options","ref","useRef","useEffect","current","maskInput","Inputmask"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AASA,IAAMA,YAAY,GAAG,SAAfA,YAAe,CAACC,KAAD;EACnB,IAAQC,IAAR,GAAoCD,KAApC,CAAQC,IAAR;MAAcC,QAAd,GAAoCF,KAApC,CAAcE,QAAd;MAAwBC,OAAxB,GAAoCH,KAApC,CAAwBG,OAAxB;EAEA,IAAMC,GAAG,GAAGC,YAAM,CAAmB,IAAnB,CAAlB;EAEAC,eAAS,CAAC;IACR,IAAI,CAACF,GAAG,CAACG,OAAT,EAAkB;MAChB;;;IAGF,IAAMC,SAAS,GAAGC,SAAS;MACzBR,IAAI,EAAJA;OACGE,OAFsB,EAA3B;IAKAK,SAAS,CAACP,IAAV,CAAeG,GAAG,CAACG,OAAnB;;IAEA,IAAIL,QAAQ,IAAIE,GAAG,CAACG,OAApB,EAA6B;MAC3BL,QAAQ,CAACE,GAAG,CAACG,OAAL,CAAR;;GAbK,EAeN,CAACN,IAAD,EAAOC,QAAP,EAAiBC,OAAjB,CAfM,CAAT;EAiBA,OAAOC,GAAP;AACD,CAvBD;;;;"}

package/dist/index.modern.js

@@ -2,7 +2,7 @@ import { useRef, useEffect } from 'react';
 import Inputmask from 'inputmask';
 
 function _extends() {
-  _extends = Object.assign || function (target) {
+  _extends = Object.assign ? Object.assign.bind() : function (target) {
     for (var i = 1; i < arguments.length; i++) {
       var source = arguments[i];
 
@@ -15,7 +15,6 @@ function _extends() {
 
     return target;
   };
-
   return _extends.apply(this, arguments);
 }
 

package/dist/index.modern.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.modern.js","sources":["../src/useMaskInput.ts"],"sourcesContent":["import { useEffect, useRef } from 'react';\nimport Inputmask, { Options } from 'inputmask';\n\ninterface UseInputMaskOptions {\n  mask: Options['mask']\n  register?(element: HTMLElement): void\n  options?: Options\n}\n\nconst useInputMask = (props: UseInputMaskOptions) => {\n  const { mask, register, options } = props;\n\n  const ref = useRef<HTMLInputElement>(null);\n\n  useEffect(() => {\n    if (!ref.current) {\n      return;\n    }\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  }, [mask, register, options]);\n\n  return ref;\n};\n\nexport default useInputMask;\n"],"names":["useInputMask","props","mask","register","options","ref","useRef","useEffect","current","maskInput","Inputmask"],"mappings":";;;;;;;;;;;;;;;;;;;;;AASA,IAAMA,YAAY,GAAG,SAAfA,YAAe,CAACC,KAAD;MACXC,OAA4BD,MAA5BC;MAAMC,WAAsBF,MAAtBE;MAAUC,UAAYH,MAAZG;AAExB,MAAMC,GAAG,GAAGC,MAAM,CAAmB,IAAnB,CAAlB;AAEAC,EAAAA,SAAS,CAAC;AACR,QAAI,CAACF,GAAG,CAACG,OAAT,EAAkB;AAChB;AACD;;AAED,QAAMC,SAAS,GAAGC,SAAS;AACzBR,MAAAA,IAAI,EAAJA;AADyB,OAEtBE,OAFsB,EAA3B;AAKAK,IAAAA,SAAS,CAACP,IAAV,CAAeG,GAAG,CAACG,OAAnB;;AAEA,QAAIL,QAAQ,IAAIE,GAAG,CAACG,OAApB,EAA6B;AAC3BL,MAAAA,QAAQ,CAACE,GAAG,CAACG,OAAL,CAAR;AACD;AACF,GAfQ,EAeN,CAACN,IAAD,EAAOC,QAAP,EAAiBC,OAAjB,CAfM,CAAT;AAiBA,SAAOC,GAAP;AACD,CAvBD;;;;"}
+{"version":3,"file":"index.modern.js","sources":["../src/useMaskInput.ts"],"sourcesContent":["import { useEffect, useRef } from 'react';\nimport Inputmask from 'inputmask';\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\n  const ref = useRef<HTMLInputElement>(null);\n\n  useEffect(() => {\n    if (!ref.current) {\n      return;\n    }\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  }, [mask, register, options]);\n\n  return ref;\n};\n\nexport default useInputMask;\n"],"names":["useInputMask","props","mask","register","options","ref","useRef","useEffect","current","maskInput","Inputmask"],"mappings":";;;;;;;;;;;;;;;;;;;;AASA,IAAMA,YAAY,GAAG,SAAfA,YAAe,CAACC,KAAD;EACnB,IAAQC,IAAR,GAAoCD,KAApC,CAAQC,IAAR;MAAcC,QAAd,GAAoCF,KAApC,CAAcE,QAAd;MAAwBC,OAAxB,GAAoCH,KAApC,CAAwBG,OAAxB;EAEA,IAAMC,GAAG,GAAGC,MAAM,CAAmB,IAAnB,CAAlB;EAEAC,SAAS,CAAC;IACR,IAAI,CAACF,GAAG,CAACG,OAAT,EAAkB;MAChB;;;IAGF,IAAMC,SAAS,GAAGC,SAAS;MACzBR,IAAI,EAAJA;OACGE,OAFsB,EAA3B;IAKAK,SAAS,CAACP,IAAV,CAAeG,GAAG,CAACG,OAAnB;;IAEA,IAAIL,QAAQ,IAAIE,GAAG,CAACG,OAApB,EAA6B;MAC3BL,QAAQ,CAACE,GAAG,CAACG,OAAL,CAAR;;GAbK,EAeN,CAACN,IAAD,EAAOC,QAAP,EAAiBC,OAAjB,CAfM,CAAT;EAiBA,OAAOC,GAAP;AACD,CAvBD;;;;"}

package/dist/useMaskInput.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="react" />
-import { Options } from 'inputmask';
+import Inputmask from 'inputmask';
 interface UseInputMaskOptions {
-    mask: Options['mask'];
+    mask: Inputmask.Options['mask'];
     register?(element: HTMLElement): void;
-    options?: Options;
+    options?: Inputmask.Options;
 }
 declare const useInputMask: (props: UseInputMaskOptions) => import("react").RefObject<HTMLInputElement>;
 export default useInputMask;

package/node_modules/inputmask/README.md

@@ -1,25 +1,28 @@
 # Inputmask
 
-Copyright (c) 2010 - 2020 Robin Herbots Licensed under the MIT license ([http://opensource.org/licenses/mit-license.php](http://opensource.org/licenses/mit-license.php))
+Copyright (c) 2010 - 2021 Robin Herbots Licensed under the MIT license (<https://opensource.org/licenses/MIT>)
+
+The Inputmask has a very permissive license and this will stay that way.  But when you use the Inputmask in a commercial setting, be so honest to make a small donation.
+This will be appreciated very much.
 
 [![donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZNR3EB6JTMMSS)
   
-[![NPM Version][npm-image]][npm-url] [![Dependency Status][david-image]][david-url] [![devDependency Status][david-dev-image]][david-dev-url]
+![npm](https://img.shields.io/npm/v/inputmask) ![npm (tag)](https://img.shields.io/npm/v/inputmask/next) ![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/inputmask)
 
-Inputmask is a javascript library which creates an input mask.  Inputmask can run against vanilla javascript, jQuery and jqlite.
+Inputmask is a javascript library that creates an input mask.  Inputmask can run against vanilla javascript, jQuery, and jqlite.
 
 An inputmask helps the user with the input by ensuring a predefined format. This can be useful for dates, numerics, phone numbers, ...
 
 Highlights:
 - easy to use
-- optional parts anywere in the mask
-- possibility to define aliases which hide complexity
-- date / datetime masks
+- optional parts anywhere in the mask
+- possibility to define aliases which hide the complexity
+- date / DateTime masks
 - numeric masks
 - lots of callbacks
 - non-greedy masks
 - many features can be enabled/disabled/configured by options
-- supports readonly/disabled/dir="rtl" attributes
+- supports read-only/disabled/dir="rtl" attributes
 - support data-inputmask attribute(s)
 - alternator-mask
 - regex-mask
@@ -29,9 +32,9 @@ Highlights:
 - value formatting / validating without input element
 - AMD/CommonJS support
 - dependencyLibs: vanilla javascript, jQuery, jqlite
-- \<input-mask\> htmlelenent
+- \<input-mask\> htmlelement
 
-Demo page see [http://robinherbots.github.io/Inputmask](http://robinherbots.github.io/Inputmask)
+Demo page see <https://robinherbots.github.io/Inputmask/>
 
 Thanks to [Jetbrains](https://www.jetbrains.com/?from=inputmask) for providing a free license for their excellent Webstorm IDE.  
 <a href="https://www.jetbrains.com/?from=inputmask">
@@ -50,8 +53,6 @@ Inputmask can run against different javascript libraries.
 You can choose between:
 - inputmask.dependencyLib (vanilla)
 - inputmask.dependencyLib.jquery
-- inputmask.dependencyLib.jqlite
-- .... (others are welcome)
 
 ### Classic web with <script\> tag
 Include the js-files which you can find in the `dist` folder.
@@ -94,6 +95,11 @@ var Inputmask = require('inputmask');
 import Inputmask from "inputmask";
 ```
 
+### ES6
+```
+import Inputmask from "inputmask.es6.js";
+```
+
 ## Usage
 ### via Inputmask class
 
@@ -105,7 +111,7 @@ im.mask(selector);
 
 //or
 
-Inputmask({"mask": "(999) 999-9999", .... other options .....}).mask(selector);
+Inputmask({"mask": "(999) 999-9999", ... other_options, ...}).mask(selector);
 Inputmask("9-a{1,3}9{1,3}").mask(selector);
 Inputmask("9", { repeat: 10 }).mask(selector);
 
@@ -154,7 +160,7 @@ $(document).ready(function(){
 ```
 
 ### via \<input-mask\> element
-Use the input-mask element in your html code and set the options as attributes.
+Use the input-mask element in your HTML code and set the options as attributes.
 
 ```html
 <input-mask alias="currency"></input-mask>
@@ -181,13 +187,13 @@ The allowed input types are defined in the supportsInputType option. Also see ([
 There are more definitions defined within the extensions.<br>You can find info within the js-files or by further exploring the options.
 
 ###### Note:
-When your newly mask is acting strange and replaces some static chars with the mask, then there is a definition which uses the char as symbol.
+When your new mask is acting strange and replaces some static chars with the mask, then there is a definition that uses the char as a symbol.
 To solve this you need to [double escape the char](#escape-special-mask-chars).
 
 
 ## Masking types
 ### Static masks
-These are the very basic of masking.  The mask is defined and will not change during the input.
+These are the very basics of masking.  The mask is defined and will not change during the input.
 
 ```javascript
 $(document).ready(function(){
@@ -205,14 +211,14 @@ Example:
 $('#test').inputmask('(99) 9999[9]-9999');
 ```
 
-This mask wil allow input like `(99) 99999-9999` or `(99) 9999-9999`.
+This mask will allow input like `(99) 99999-9999` or `(99) 9999-9999`.
 
 Input => 12123451234      mask => (12) 12345-1234    (trigger complete)<br>
 Input => 121234-1234      mask => (12) 1234-1234     (trigger complete)<br>
 Input => 1212341234       mask => (12) 12341-234_    (trigger incomplete)
 
 #### skipOptionalPartCharacter
-As an extra there is another configurable character which is used to skip an optional part in the mask.
+As an extra, there is another configurable character which is used to skip an optional part in the mask.
 
 ```javascript
 skipOptionalPartCharacter: " "
@@ -220,7 +226,7 @@ skipOptionalPartCharacter: " "
 
 Input => 121234 1234      mask => (12) 1234-1234     (trigger complete)
 
-When `clearMaskOnLostFocus: true` is set in the options (default), the mask will clear out the optional part when it is not filled in and this only in case the optional part is at the end of the mask.
+When `clearMaskOnLostFocus: true` is set in the options (default), the mask will clear out the optional part when it is not filled in, and this only in case the optional part is at the end of the mask.
 
 For example, given:
 
@@ -240,7 +246,7 @@ $(selector).inputmask({ mask: "9[-9999]", greedy: false });
 The initial mask shown will be "**_**" instead of "**_**-____".
 
 ### Dynamic masks
-Dynamic masks can change during the input.  To define a dynamic part use { }.
+Dynamic masks can change during input.  To define a dynamic part use { }.
 
 {n} => n repeats
 {n|j} => n repeats, with j jitmasking
@@ -291,7 +297,8 @@ The alternator syntax is like an **OR** statement.  The mask can be one of the 3
 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
+"(aaa|999|9AA)" => aaa or 999 or 9AA  
+"aaaa|9999" => aaa a or 9 999
 
 **Also make sure to read about the [keepStatic](#keepStatic) option.**
 
@@ -321,14 +328,14 @@ $("selector").inputmask({
 ```
 
 ### Preprocessing masks
-You can define the mask as a function which can allow 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.
+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.
 
 ```javascript
 $(selector).inputmask({ mask: function () { /* do stuff */ return ["[1-]AAA-999", "[1-]999-AAA"]; }});
 ```
 
 ### JIT Masking
-Just in time masking.  With the jitMasking option you can enable jit masking.  The mask will only be visible for the user entered characters.
+Just in time masking.  With the jitMasking option, you can enable jit masking.  The mask will only be visible for the user-entered characters.
 Default: false
 
 Value can be true or a threshold number or false.
@@ -341,9 +348,9 @@ Inputmask("datetime", { jitMasking: true }).mask(selector);
 You can define your own definitions to use in your mask.<br>Start by choosing a masksymbol.
 
 ### validator(chrs, maskset, pos, strict, opts)
-Next define your validator.  The validator can be a regular expression or a function.
+Next, define your validator.  The validator can be a regular expression or a function.
 
-The return value of a validator can be true,  false or a command object.
+The return value of a validator can be true,  false, or a command object.
 
 #### Options of the command object
 - pos : position to insert
@@ -356,7 +363,7 @@ The return value of a validator can be true,  false or a command object.
   - { pos : position to insert, c : character to insert, fromIsValid : true/false, strict : true/false }
   - [{ pos : position to insert, c : character to insert, fromIsValid : true/false, strict : true/false }, { ...}, ... ]
   
-  fromIsValid & strict 
+  fromIsValid & strict defaults to true.
 
 - refreshFromBuffer :
   - true => refresh validPositions from the complete buffer
@@ -365,7 +372,7 @@ The return value of a validator can be true,  false or a command object.
   See [preValidation option](#preValidation)
 
 ### definitionSymbol
-When you insert or delete characters, they are only shifted when the definition type is the same.  This behavior can be overridden by giving a definitionSymbol. (see example x, y, z, which can be used for ip-address masking, the validation is different, but it is allowed to shift the characters between the definitions)
+When you insert or delete characters, they are only shifted when the definition type is the same.  This behavior can be overridden by giving a definitionSymbol. (see example x, y, z, which can be used for IP-address masking, the validation is different, but it is allowed to shift the characters between the definitions)
 
 ```javascript
 Inputmask.extendDefinitions({
@@ -404,8 +411,21 @@ Inputmask.extendDefinitions({
 ### placeholder
 Specify a placeholder for a definition.  This can also be a function.
 
-### set defaults
-Defaults can be set as below.
+### optional
+Mark the definition as optional
+
+### static
+Mark the definition as static
+
+### casing (definition option)
+Specify casing options.  
+The options are the same as the [Casing option](#casing)
+
+### generated
+Mark the definition as generated
+
+## set defaults
+The defaults can be set as below.
 
 ```javascript
 Inputmask.extendDefaults({
@@ -431,7 +451,7 @@ Inputmask.extendAliases({
 ```
 
 But if the property is defined within an alias you need to set it for the alias definition.
-This is also for default plugin options.  If the alias definitions extends on default options, you can only override it at alias level.
+This is also for default plugin options.  If the alias definitions extend on default options, you can only override it at alias level.
 
 ```javascript
 Inputmask.extendAliases({
@@ -443,7 +463,7 @@ Inputmask.extendAliases({
 });
 ```
 
-However, the preferred way to alter properties for an alias is by creating a new alias which inherits from the default alias definition.
+However, the preferred way to alter properties for an alias is by creating a new alias that inherits from the default alias definition.
 
 ```javascript
 Inputmask.extendAliases({
@@ -527,7 +547,8 @@ if (input.inputmask)
 Unmask a given value against the mask.
 
 ```javascript
-var unformattedDate = Inputmask.unmask("23/03/1973", { alias: "dd/mm/yyyy"}); //23031973
+var unformattedMask = Inputmask.unmask("123-45678-90", { mask: "999-99999-99" }); //1234567890
+var unformattedDate = Inputmask.unmask("23/03/1973", { alias: "datetime", inputFormat: "dd/mm/yyyy", outputFormat: "ddmmyyyy"});//23031973
 ```
 
 ### remove
@@ -599,7 +620,7 @@ $(selector).inputmask("getmetadata");
 The setvalue functionality is to set a value to the inputmask like you would do with jQuery.val,
 BUT it will trigger the internal event used by the inputmask always, whatever the case.
 This is particular usefull when cloning an inputmask with jQuery.clone.  Cloning an inputmask is not a fully functional clone.
-On the first event (mouseenter, focus, ...) the inputmask can detect if it where cloned and can reactivate the masking.  However when setting the value with jQuery.val there is none of the events triggered in that case.  The setvalue functionality does this for you.
+On the first event (mouseenter, focus, ...) the inputmask can detect if it were cloned and can reactivate the masking.  However when setting the value with jQuery.val there is none of the events triggered in that case.  The setvalue functionality does this for you.
 
 ```
 $(selector).inputmask("setvalue", value);
@@ -635,7 +656,7 @@ $("#CellPhone").inputmask("option", {
 ```
 
 ### format
-Instead of masking an input element it is also possible to use the inputmask for formatting given values. Think of formatting values to show in jqGrid or on other elements then inputs.
+Instead of masking an input element, it is also possible to use the inputmask for formatting given values. Think of formatting values to show in jqGrid or on other elements then inputs.
 
 ```javascript
 var formattedDate = Inputmask.format("2331973", { alias: "datetime", inputFormat: "dd/mm/yyyy"});
@@ -785,7 +806,7 @@ Automatically unmask the value when retrieved.<br>Default: false.
 Remove the mask before submitting the form.<br>Default: false
 
 ### clearMaskOnLostFocus
-Remove the empty mask on blur or when not empty removes the optional trailing part Default: true
+Remove the empty mask on blur or when not empty remove the optional trailing part Default: true
 
 ```javascript
 $(document).ready(function(){
@@ -811,11 +832,11 @@ $(document).ready(function(){
 ### aliases
 Definitions of aliases.
 
-With an alias you can define a complex mask definition and call it by using an alias name.  So this is mainly to simplify the use of your masks.  Some aliases found in the extensions are: email, currency, decimal, integer, date, datetime, dd/mm/yyyy, etc.
+With an alias, you can define a complex mask definition and call it by using an alias name.  So this is mainly to simplify the use of your masks.  Some aliases found in the extensions are email, currency, decimal, integer, date, DateTime, dd/mm/yyyy, etc.
 
-First you have to create an alias definition.  The alias definition can contain options for the mask, custom definitions, the mask to use etc.
+First, you have to create an alias definition.  The alias definition can contain options for the mask, custom definitions, the mask to use, etc.
 
-When you pass in an alias, the alias is first resolved and then the other options are applied.  So you can call an alias and pass another mask to be applied over the alias. This also means that you can write aliases which "inherit" from another alias.
+When you pass in an alias, the alias is first resolved and then the other options are applied.  So you can call an alias and pass another mask to be applied over the alias. This also means that you can write aliases that "inherit" from another alias.
 
 Some examples can be found in jquery.inputmask.xxx.extensions.js
 
@@ -875,7 +896,7 @@ $(selector).inputmask({
 ```
 
 ### onBeforePaste
-This callback allows for preprocessing the pasted value before actually handling the value for masking.  This can be usefull for stripping away some characters before processing.
+This callback allows for preprocessing the pasted value before actually handling the value for masking.  This can be useful for stripping away some characters before processing.
 
 Function arguments: pastedValue, opts<br>Function return: processedValue
 
@@ -902,9 +923,9 @@ Default: Calls the onBeforeMask
 ### onBeforeWrite
 Executes before writing to the masked element
 
-Use this to do some extra processing of the input. This can be usefull when implementing an alias, ex. decimal alias, autofill the digits when leaving the inputfield.
+Use this to do some extra processing of the input. This can be useful when implementing an alias, ex. decimal alias, autofill the digits when leaving the inputfield.
 
-Function arguments: event, buffer, caretPos, opts<br>Function return: command object (see Define custom definitions)
+Function arguments: event, buffer, caretPos, opts<br>Function return: command object (see [Define custom definitions](#define-custom-definitions))
 
 ### onUnMask
 Executes after unmasking to allow post-processing of the unmaskedvalue.
@@ -941,7 +962,7 @@ $(document).ready(function(){
 ```
 
 ### onKeyValidation
-Callback function is executed on every keyvalidation with the key, result as parameter.
+Callback function is executed on every keyvalidation with the key, result as the parameter.
 
 ```javascript
 $(document).ready(function(){
@@ -967,7 +988,7 @@ $(document).ready(function(){
 ### rightAlign
 Align the input to the right
 
-By setting the rightAlign you can specify to right align an inputmask. This is only applied in combination op the numericInput option or the dir-attribute. Default is true.
+By setting the rightAlign you can specify to right-align an inputmask. This is only applied in combination op the numericInput option or the dir-attribute. The default is true.
 
 ```javascript
 $(document).ready(function(){
@@ -991,7 +1012,11 @@ ex. $(selector).inputmask({ mask: ["+55-99-9999-9999", "+55-99-99999-9999", ], k
 
 typing 1212345123 => should result in +55-12-1234-5123 type extra 4 => switch to +55-12-12345-1234
 
-**When the option is not set, it will default to false, except for multiple masks it will default to true!!**
+**When the option is not set, it will default to false.**  
+**Except:**
+- for multiple masks it will default to true
+- when the first alternation is shorter then the next it will also default to true.
+  - ex: (9|999), (99)|(aaaa)
 
 ### positionCaretOnTab
 When enabled the caret position is set after the latest valid position on TAB Default: true
@@ -1032,16 +1057,16 @@ $(selector).inputmask({
 Hook to postValidate the result from isValid.  Usefull for validating the entry as a whole.  Args => buffer, pos, c, currentResult, opts, maskset, strict, fromCheckval<br>Return => true|false|command object
 
 ### preValidation
-Hook to preValidate the input.  Useful for validating regardless the definition. Args => buffer, pos, char, isSelection, opts, maskset, caretPos, strict => return true/false/command object
-When return true, the normal validation kicks in, otherwise it is skipped.
+Hook to preValidate the input.  Useful for validating regardless of the definition. Args => buffer, pos, char, isSelection, opts, maskset, caretPos, strict => return true/false/command object
+When returning true, the normal validation kicks in, otherwise, it is skipped.
 
-When returning a command object the actions are executed and futher validation is stopped.  
+When returning a command object the actions are executed and further validation is stopped.  
 If you want to continue further validation, you need to add the rewritePosition action.
 
 ### staticDefinitionSymbol
-The staticDefinitionSymbol option is used to indicate that the static entries in the mask can match a certain definition.  Especially usefull with alternators so that static element in the mask can match another alternation.
+The staticDefinitionSymbol option is used to indicate that the static entries in the mask can match a certain definition.  Especially useful with alternators so that the static element in the mask can match another alternation.
 
-In the example below we mark the spaces as a possible match for the "i" definition.  By doing so the mask can alternate to the second mask even when we typed already "12 3".
+In the example below, we mark the spaces as a possible match for the "i" definition.  By doing so the mask can alternate to the second mask even when we typed already "12 3".
 
 ```javascript
 Inputmask("(99 99 999999)|(i{+})", {
@@ -1089,9 +1114,10 @@ casing: function(elem, test, pos, validPositions) {
 Default: null
 
 ### inputmode
-Default: "verbatim"
-Specify the inputmode  - already in place for when browsers start to  support them
-https://html.spec.whatwg.org/#input-modalities:-the-inputmode-attribute
+Default: "text"  
+The inputmode hints at the type of data that might be entered by the user while editing the element or its contents.  
+
+https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode
 
 ### importDataAttributes
 Specify to use the data-inputmask attributes or to ignore them.
@@ -1117,8 +1143,22 @@ Use the default defined definitions from the prototype.
 
 Default: true 
 
+### validationEventTimeOut
+Time to show html5 validation error on form submit.
+
+Default: 3000
+
+### substitutes
+Define character substitutes.
+```
+substitutes: {
+  ",": "."
+}
+```
+Default: {}
+
 ## General
-### set a value and apply mask
+### set a value and apply the mask
 this can be done with the traditional jquery.val function (all browsers) or JavaScript value property for browsers which implement lookupGetter or getOwnPropertyDescriptor
 
 ```javascript
@@ -1154,7 +1194,7 @@ $(document).ready(function(){
 Extra example see https://github.com/RobinHerbots/Inputmask/issues/2251
 
 ### auto-casing inputmask
-You can define within a definition to automatically apply some casing on the entry in an input by giving the casing.<br>Casing can be null, "upper", "lower" or "title".
+You can define within a definition to automatically apply some casing on the entry in input by giving the casing.<br>Casing can be null, "upper", "lower" or "title".
 
 ```javascript
 Inputmask.extendDefinitions({
@@ -1203,7 +1243,7 @@ $(document).ready(function(){
 ```
 
 ### data-inputmask attribute
-You can also apply an inputmask by using the data-inputmask attribute.  In the attribute you specify the options wanted for the inputmask. This gets parsed with $.parseJSON (for the moment), so be sure to use a well-formed json-string without the {}.
+You can also apply an inputmask by using the data-inputmask attribute.  In the attribute, you specify the options wanted for the inputmask. This gets parsed with $.parseJSON (for the moment), so be sure to use a well-formed JSON-string without the {}.
 
 ```html
 <input data-inputmask="'alias': 'datetime'" />
@@ -1236,11 +1276,4 @@ Be sure to pass true in the jQuery.clone fn to clone with data and events and us
 (https://api.jquery.com/clone/)
 
 
-
-[npm-url]: https://npmjs.org/package/inputmask
-[npm-image]: https://img.shields.io/npm/v/inputmask.svg
-[david-url]: https://david-dm.org/RobinHerbots/inputmask#info=dependencies
-[david-image]: https://img.shields.io/david/RobinHerbots/inputmask.svg
-[david-dev-url]: https://david-dm.org/RobinHerbots/inputmask#info=devDependencies
-[david-dev-image]: https://img.shields.io/david/dev/RobinHerbots/inputmask.svg
 [input-type-ref]: https://html.spec.whatwg.org/multipage/forms.html#do-not-apply

package/node_modules/inputmask/dist/inputmask.es6.js

@@ -0,0 +1,5 @@
+import "./inputmask.js";
+
+const inputmask = window.Inputmask;
+window.Inputmask = undefined;
+export default inputmask;