@elliemae/ds-form-helpers-mask-hooks 3.16.4-rc.2 → 3.16.4

package/dist/types/hooks/index.d.ts

@@ -0,0 +1,5 @@
+export * from './usePhoneMask.js';
+export * from './useNumberMask.js';
+export * from './useSSNMask.js';
+export * from './useRegExpMask.js';
+export * from './useZipCodeMask.js';

package/dist/types/hooks/useNumberMask.d.ts

@@ -0,0 +1,4 @@
+import type { DSMaskT } from '../react-desc-prop-types.js';
+export declare const useNumberMask: DSMaskT.NumberHook;
+export declare const getNumberMaskedValue: (value: string, opts: DSMaskT.NumberHookArgs) => string;
+export declare const UseNumberMaskWithSchema: import("@elliemae/ds-props-helpers/dist/types/propTypes/types.js").DocumentedReactComponent<DSMaskT.NumberHookArgs>;

package/dist/types/hooks/usePhoneMask.d.ts

@@ -0,0 +1,4 @@
+import type { DSMaskT } from '../react-desc-prop-types.js';
+export declare const usePhoneMask: DSMaskT.Hook;
+export declare const getPhoneMaskedValue: (value: string, opts?: Partial<DSMaskT.PhoneHookArgs>) => string;
+export declare const UsePhoneMaskWithSchema: import("@elliemae/ds-props-helpers/dist/types/propTypes/types.js").DocumentedReactComponent<DSMaskT.HookArgs>;

package/dist/types/hooks/useRegExpMask.d.ts

@@ -0,0 +1,4 @@
+import type { DSMaskT } from '../react-desc-prop-types.js';
+export declare const useRegExpMask: DSMaskT.Hook;
+export declare const getRegExpMaskedValue: (value: string, regExp: string[]) => string | number;
+export declare const UseRegExpMaskWithSchema: import("@elliemae/ds-props-helpers/dist/types/propTypes/types.js").DocumentedReactComponent<DSMaskT.HookArgs>;

package/dist/types/hooks/useSSNMask.d.ts

@@ -0,0 +1,4 @@
+import type { DSMaskT } from '../react-desc-prop-types.js';
+export declare const useSSNMask: DSMaskT.Hook;
+export declare const getSSNMaskedValue: (value: string) => string;
+export declare const UseSSNMaskWithSchema: import("@elliemae/ds-props-helpers/dist/types/propTypes/types.js").DocumentedReactComponent<DSMaskT.HookArgs>;

package/dist/types/hooks/useZipCodeMask.d.ts

@@ -0,0 +1,4 @@
+import type { DSMaskT } from '../react-desc-prop-types.js';
+export declare const useZipCodeMask: DSMaskT.Hook;
+export declare const getZipCodeMaskedValue: (value: string) => string;
+export declare const UseZipCodeMaskWithSchema: import("@elliemae/ds-props-helpers/dist/types/propTypes/types.js").DocumentedReactComponent<DSMaskT.HookArgs>;

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './hooks/index.js';
+export type { DSMaskT } from './react-desc-prop-types.js';

package/dist/types/react-desc-prop-types.d.ts

@@ -0,0 +1,48 @@
+import type { WeakValidationMap } from 'react';
+import type React from 'react';
+export declare namespace DSMaskT {
+    interface HookArgs {
+        valueSetter: React.Dispatch<React.SetStateAction<string>>;
+        onChange?: (e: React.ChangeEvent<HTMLInputElement>, mask?: string) => void;
+        onKeyDown?: React.KeyboardEventHandler<HTMLInputElement>;
+        onBlur?: React.FocusEventHandler<HTMLInputElement>;
+    }
+    interface HookReturn {
+        onChange: React.ChangeEventHandler<HTMLInputElement>;
+        onKeyDown: React.KeyboardEventHandler<HTMLInputElement>;
+        onBlur?: React.FocusEventHandler<HTMLInputElement>;
+    }
+    interface NumberHookArgs extends HookArgs {
+        suffix?: string;
+        prefix?: string;
+        decimalPlaces?: number;
+        allowNegative?: boolean;
+        includeThousandsSeparator?: boolean;
+        decimalRequired?: boolean;
+    }
+    interface PhoneHookArgs extends HookArgs {
+        isInternational?: boolean;
+    }
+    interface RegExpHookArgs extends HookArgs {
+        filledMask: boolean;
+        regExp: string[];
+    }
+    type Hook = ((args: HookArgs) => HookReturn) & {
+        displayName: string;
+    };
+    type PhoneHook = ((args: PhoneHookArgs) => HookReturn) & {
+        displayName: string;
+    };
+    type NumberHook = ((args: NumberHookArgs) => HookReturn) & {
+        displayName: string;
+    };
+}
+export declare const DSMaskHookDefaultProps: Partial<DSMaskT.HookArgs>;
+export declare const DSMaskPhoneHookDefaultProps: Partial<DSMaskT.PhoneHookArgs>;
+export declare const DSMaskRegExpHookDefaultProps: Partial<DSMaskT.RegExpHookArgs>;
+export declare const DSMaskSSNDefaultProps: Partial<DSMaskT.PhoneHookArgs>;
+export declare const DSMaskNumberHookDefaultProps: Partial<DSMaskT.NumberHookArgs>;
+export declare const DSMaskHookPropsTypes: WeakValidationMap<unknown>;
+export declare const DSMaskRegExpHookPropsTypes: WeakValidationMap<unknown>;
+export declare const DSMaskPhoneHookPropsTypes: WeakValidationMap<unknown>;
+export declare const DSMaskNumberHookPropsTypes: WeakValidationMap<unknown>;

package/dist/types/tests/useNumberMask.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/tests/usePhoneMask.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/tests/useRegExpMask.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/tests/useSSNMask.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/tests/useZipCode.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/utils/addSpecialCharacters.d.ts

@@ -0,0 +1,9 @@
+/**
+ *
+ * @param {string[]} maskWithoutSpecialChars An array of characters with the unfinished mask
+ * @param {[string, number][]} specialCharsDescr An array of tuples. Each tuple contains a string and a position (What string to add in a particular position)
+ * @param {number} maskedPos Current masked position
+ * @param {string} lastKeyCode Last key code of the user
+ * @returns {[string, number]} A tuple containing the final mask and the final masked position
+ */
+export declare const addSpecialCharacters: (maskWithoutSpecialChars: string[], specialCharsDescr: [string, number][], maskedPos: number, lastKeyCode: string) => [string, number];

package/dist/types/utils/flatStringArray.d.ts

@@ -0,0 +1 @@
+export declare const flatStringArray: (stringArray: string[]) => string[];

package/dist/types/utils/getPartialMaskedPos.d.ts

@@ -0,0 +1 @@
+export declare const getPartialMaskedPos: (rawValue: string, maskWithoutSpecialChars: string[], cursorPos: number) => number;

package/dist/types/utils/index.d.ts

@@ -0,0 +1,5 @@
+export * from './addSpecialCharacters.js';
+export * from './getPartialMaskedPos.js';
+export * from './setCursorPosition.js';
+export * from './sharedFilters.js';
+export * from './flatStringArray.js';

package/dist/types/utils/setCursorPosition.d.ts

@@ -0,0 +1 @@
+export declare const setCursorPosition: (input: HTMLInputElement, position: number) => void;

package/dist/types/utils/sharedFilters.d.ts

@@ -0,0 +1,6 @@
+/**
+ *
+ * @param {string[]} charactersToFilter An array of characters to filter from
+ * @returns [string] the filtered array including only 0~9 characters
+ */
+export declare const filterNumbersOnly: (charactersToFilter: string[]) => string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-form-helpers-mask-hooks",
-  "version": "3.16.4-rc.2",
+  "version": "3.16.4",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Controlled Form Helpers - Text Masks Hooks",
   "files": [
@@ -35,9 +35,9 @@
     "indent": 4
   },
   "dependencies": {
-    "@elliemae/ds-props-helpers": "3.16.4-rc.2",
-    "@elliemae/ds-system": "3.16.4-rc.2",
-    "@elliemae/ds-utilities": "3.16.4-rc.2"
+    "@elliemae/ds-props-helpers": "3.16.4",
+    "@elliemae/ds-utilities": "3.16.4",
+    "@elliemae/ds-system": "3.16.4"
   },
   "devDependencies": {
     "@elliemae/pui-theme": "~2.7.0",
@@ -46,7 +46,7 @@
     "@testing-library/user-event": "~13.5.0",
     "styled-components": "~5.3.9",
     "styled-system": "~5.1.5",
-    "@elliemae/ds-form-input-text": "3.16.4-rc.2"
+    "@elliemae/ds-form-input-text": "3.16.4"
   },
   "peerDependencies": {
     "@elliemae/pui-theme": "~2.7.0",