use-mask-input 3.9.0 → 3.10.1

package/src/core/maskEngine.ts

@@ -1,5 +1,5 @@
 /* eslint-disable import-x/no-extraneous-dependencies */
-import inputmask from 'inputmask';
+import inputmask from './inputmask';
 
 import { getMaskOptions } from './maskConfig';
 import { moduleInterop } from '../utils';
@@ -14,7 +14,7 @@ import type { Mask, Options } from '../types';
  * @param options - Optional configuration options
  * @returns A mask instance
  */
-export function createMaskInstance(mask: Mask, options?: Options): Inputmask.Instance {
+export function createMaskInstance(mask: Mask, options?: Options): ReturnType<typeof inputmask> {
   const inputmaskInstance = moduleInterop(inputmask);
   return inputmaskInstance(getMaskOptions(mask, options));
 }

package/src/index.tsx

@@ -11,6 +11,8 @@ export type {
   Input,
   Mask,
   Options,
+  UnmaskedValueApi,
+  UseMaskInputReturn,
   TanStackFormInputProps,
   UseTanStackFormMaskReturn,
   UseFormRegister,

package/src/types/index.ts

@@ -30,9 +30,15 @@ export type Mask = 'datetime'
 export type Options = MaskOptions;
 export type Input = HTMLInputElement | HTMLTextAreaElement | HTMLElement;
 
+export interface UnmaskedValueApi {
+  unmaskedValue: () => string;
+}
+
+export type UseMaskInputReturn = RefCallback<HTMLElement | null> & UnmaskedValueApi;
+
 export interface UseHookFormMaskReturn<
   T extends FieldValues,
-> extends UseFormRegisterReturn<Path<T>> {
+> extends UseFormRegisterReturn<Path<T>>, UnmaskedValueApi {
   ref: RefCallback<HTMLElement | null>;
   prevRef: RefCallback<HTMLElement | null>;
 }
@@ -47,4 +53,4 @@ export type UseTanStackFormMaskReturn<T extends TanStackFormInputProps = TanStac
   Omit<T, 'ref'> & {
   ref: RefCallback<HTMLElement | null>;
   prevRef: RefCallback<HTMLElement | null> | undefined;
-};
+} & UnmaskedValueApi;

package/src/utils/index.ts

@@ -1,4 +1,9 @@
 export { default as flow } from './flow';
 export { default as isServer } from './isServer';
 export { default as moduleInterop } from './moduleInterop';
-export { makeMaskCacheKey, setPrevRef } from './maskHelpers';
+export {
+  getUnmaskedValue,
+  makeMaskCacheKey,
+  setPrevRef,
+  setUnmaskedValue,
+} from './maskHelpers';

package/src/utils/maskHelpers.ts

@@ -1,4 +1,10 @@
-import type { Mask } from '../types';
+import { findInputElement, resolveInputRef } from '../core/elementResolver';
+
+import type { Input, Mask, UnmaskedValueApi } from '../types';
+
+type MaskedElement = (HTMLInputElement | HTMLTextAreaElement) & {
+  inputmask?: { unmaskedvalue?: () => string };
+};
 
 /**
  * Builds a stable string key from a field name and mask, used to cache ref
@@ -20,3 +26,42 @@ export function setPrevRef(result: object, ref: unknown): void {
     configurable: true,
   });
 }
+
+function resolveUnmaskedInput(input: Input | null): HTMLInputElement | HTMLTextAreaElement | null {
+  const resolved = resolveInputRef(input);
+  if (!resolved) return null;
+
+  const inputElement = findInputElement(resolved);
+  if (inputElement) {
+    return inputElement as HTMLInputElement | HTMLTextAreaElement;
+  }
+
+  return resolved as HTMLInputElement | HTMLTextAreaElement;
+}
+
+export function getUnmaskedValue(input: Input | null): string {
+  const element = resolveUnmaskedInput(input);
+  if (!element) return '';
+
+  const { inputmask } = element as MaskedElement;
+
+  if (inputmask && typeof inputmask.unmaskedvalue === 'function') {
+    return inputmask.unmaskedvalue();
+  }
+
+  return 'value' in element ? element.value : '';
+}
+
+export function setUnmaskedValue<T extends object>(
+  result: T,
+  getter: () => string,
+): T & UnmaskedValueApi {
+  Object.defineProperty(result, 'unmaskedValue', {
+    value: getter,
+    enumerable: false,
+    writable: true,
+    configurable: true,
+  });
+
+  return result as T & UnmaskedValueApi;
+}