max-mask/src/commonUtils.ts

Simple masking solution for any frontend as well as nodejs. Provides composable for Vue3

// src/commonUtils.ts

/**
 * Checks if a given character is a forever mode symbol ('*').
 * @param char - the character to check
 * @returns boolean - whether or not the character is a forever mode symbol
 */
export const isForeverModeSymbol = (char: string): boolean => {
    return char === "*";
};

/**
 * Checks if a given character is a valid format symbol.
 * @param char - the character to check
 * @returns boolean - whether or not the character is a valid format symbol
 */
export const isValidFormatSymbol = (char: string): boolean => {
    return ["U", "#", "a", "A", "S", "X"].includes(char);
};

/**
 * Applies masking to a given input character based on a given format character.
 * @param inputChar - the input character to apply masking to
 * @param formatChar - the format character that defines how to mask
 * @returns string | null - the masked character or null if it doesn't fit the mask
 */
export const applyMasking = (
    inputChar: string,
    formatChar: string
): string | null => {
    switch (formatChar) {
        case "#":
            return /\d/.test(inputChar) ? inputChar : null;
        case "U":
            return /[a-zA-Z0-9]/.test(inputChar)
                ? inputChar.toUpperCase()
                : null;
        case "a":
            return /[a-zA-Z]/.test(inputChar) ? inputChar.toLowerCase() : null;
        case "A":
            return /[a-zA-Z]/.test(inputChar) ? inputChar.toUpperCase() : null;
        case "S":
        case "X":
            return /[a-zA-Z0-9]/.test(inputChar) ? inputChar : null;
        default:
            return null;
    }
};