resolveMask

The DOM-free editable state the masking engine operates on: a value plus its selection. Structurally compatible with @robonen/platform's InputState.

interface ElementState

Input to a MaskPreprocessor.

interface MaskPreprocessorParams

Output of a MaskPreprocessor.

interface MaskPreprocessorResult

A full mask configuration.

interface MaskOptions

MaskOptions after defaults are applied (internal).

interface ResolvedMaskOptions

A selection range as [from, to]. A collapsed caret has from === to.

export type SelectionRange = readonly [from: number, to: number];

A concrete mask pattern: either a single RegExp validating the whole value, or an array of slots where a string is a fixed (auto-inserted) character and a RegExp validates exactly one character.

export type MaskExpression = ReadonlyArray<RegExp | string> | RegExp;

A mask: a concrete MaskExpression or a function deriving one from the current ElementState (a dynamic mask).

export type Mask = MaskExpression | ((state: ElementState) => MaskExpression);

The user gesture a preprocessor is reacting to.

export type MaskAction = 'deleteBackward' | 'deleteForward' | 'insert' | 'validation';

How newly typed characters interact with the text under a collapsed caret: - shift — insert, pushing existing characters right (default); - replace — overwrite the following characters; - a function resolving the mode per ElementState.

export type OverwriteMode = 'replace' | 'shift' | ((state: ElementState) => 'replace' | 'shift');

Runs before the mask conforms a value — normalizes the upcoming state/data.

export type MaskPreprocessor = (params: MaskPreprocessorParams, action: MaskAction) => MaskPreprocessorResult;

Runs after the mask conforms a value — applies finishing touches (separators, padding, clamping). Receives the conformed state and the pre-change state.

export type MaskPostprocessor = (state: ElementState, initialState: ElementState) => ElementState;

The friendly authoring union accepted at every public boundary: a full MaskOptions, a bare Mask, or a template string (compiled via maskFromTemplate, e.g. '+1 (###) ###-####').

export type MaskOptionInput = Mask | string | MaskOptions;