@liturgical-calendar/components-js/dist/Utils.d.ts

Liturgical calendar components for javascript: an html select populated with liturgical calendars supported by the Liturgical Calendar API; form controls for parameters that are supported by the Liturgical Calendar API; a webcalendar; and liturgy of the d

export default class Utils {
    /**
     * Validates a given element selector and returns the corresponding DOM element.
     *
     * If the element selector is not a string, an error is thrown.
     * If the element selector is a string, it is validated against the DOM and if the element is not found, an error is thrown.
     *
     * @param {string} element - The element selector to be validated.
     * @returns {Element} The DOM element corresponding to the element selector.
     * @throws {Error} If the type of element is not a string.
     * @throws {Error} If the element selector is not found in the DOM.
     */
    static validateElementSelector(element: string): Element;
    /**
     * Checks if the provided class name is valid.
     *
     * The regex pattern used to validate class names:
     *   - `^` asserts the start of a line
     *   - `(?!\d|--|-?\d)` is a negative look ahead that prevents the class name
     *                  from starting with a digit, or a sequence of dashes, or a number with a leading dash
     *   - `[a-zA-Z_-]` matches any character that is a letter, a dash or an underscore
     *   - `[a-zA-Z\d_-]{1,}` matches any alphanumeric character, a dash or an underscore
     *
     * @param {string} className - The class name to be validated.
     * @returns {boolean} `true` if the class name is valid, `false` otherwise.
     */
    static validateClassName(className: string): boolean;
    /**
     * Validates if the given string is a valid CSS selector.
     *
     * A valid CSS selector must:
     * - Not start with a digit, a sequence of dashes, or a number with a leading dash.
     * - Consist of letters, dashes, or underscores.
     * - Contain at least one alphanumeric character, dash, or underscore.
     *
     * @param {string} className - The class name to validate.
     * @returns {boolean} True if the class name is valid, false otherwise.
     */
    static validateId(id: any): boolean;
    /**
     * Sanitizes the given input string to prevent XSS attacks.
     *
     * It uses the DOMParser to parse the string as HTML and then extracts the
     * text content of the parsed HTML document. This effectively strips any HTML
     * tags from the input string.
     *
     * @param {string} input - The input string to sanitize.
     * @returns {string} The sanitized string.
     * @see https://stackoverflow.com/a/47140708/394921
     */
    static sanitizeInput(input: string): string;
    /**
     * Get user's preferred languages from browser settings.
     * Returns an array of language codes in order of preference.
     *
     * @returns {string[]} Array of language codes (e.g., ['en-US', 'en', 'fr'])
     * @example
     * const userLangs = Utils.getUserLanguages();
     * // Returns: ['en-US', 'en'] based on browser settings
     */
    static getUserLanguages(): string[];
    /**
     * Find the best matching locale from available options based on user's language preferences.
     * Tries exact match first, then language prefix match, for each preferred language in order.
     *
     * @param {string[]} userLanguages - User's preferred languages in order of preference
     * @param {string[]} availableLocales - Array of available locale strings to match against
     * @returns {string} The best matching locale value, or the first available option, or 'en' as fallback
     * @example
     * const userLangs = Utils.getUserLanguages(); // ['en-US', 'en']
     * const available = ['it', 'en', 'fr', 'de'];
     * const bestLocale = Utils.findBestLocale(userLangs, available);
     * // Returns: 'en' (matches 'en-US' prefix)
     */
    static findBestLocale(userLanguages: string[], availableLocales: string[]): string;
}
//# sourceMappingURL=Utils.d.ts.map