@fkui/logic 5.36.0

package/lib/types/index.d.ts

@@ -0,0 +1,1337 @@
+import { FDate } from '@fkui/date';
+
+/**
+ * Add a listener to each item in the list of elements
+ *
+ * @public
+ */
+export declare function addFocusListener(elements: HTMLElement[], listener: ((event: Event) => unknown) | (() => unknown)): void;
+
+/**
+ * Trigger screen reader to read the passed text.
+ *
+ * @public
+ * @param text - text to be read by screen reader.
+ * @param options - options for wrapper element attributes.
+ */
+export declare function alertScreenReader(text: string, options?: Partial<AlertScreenReaderOptions>): void;
+
+/**
+ * Options for {@link alertScreenReader}.
+ *
+ * @public
+ */
+export declare interface AlertScreenReaderOptions {
+    /**
+     * If true, set aria-live to assertive instead of polite.
+     */
+    assertive: boolean;
+}
+
+/**
+ * This function does nothing and should not be used.
+ *
+ * @public
+ * @deprecated This function does nothing.
+ */
+export declare function applyValidationMessages(): void;
+
+/**
+ * A string with 3-16 digits, for example "0123456789"
+ *
+ * @public
+ */
+export declare type BankAccountNumberString = string;
+
+/**
+ * A string with 7-8 digits separated by hyphen, for example "999-9996"
+ *
+ * @public
+ */
+export declare type BankgiroString = string;
+
+/**
+ * @public
+ */
+export declare interface BlacklistValidatorConfig extends ValidatorOptions {
+    values: string | string[] | number | number[];
+}
+
+/**
+ * A string of 4-5 digits where last digit may be separated by hyphen, for
+ * example "5678-1"
+ *
+ * @public
+ */
+export declare type ClearingnumberString = string;
+
+/**
+ * @public
+ */
+export declare const configLogic: FKUIConfigLogic;
+
+/**
+ * @public
+ */
+export declare type CookieLifetimeOption = {
+    /**
+     * @deprecated Use timeLimitSeconds instead. Will be rounded to nearest second.
+     */
+    timeLimitMillis?: number;
+    timeLimitSeconds?: never;
+} | {
+    timeLimitMillis?: never;
+    timeLimitSeconds?: number;
+};
+
+/**
+ * @public
+ */
+export declare type CookieOptions = {
+    name: string;
+    value: string;
+    keepAnyExistingCookie?: boolean;
+} & CookieLifetimeOption;
+
+/**
+ * @public
+ * @deprecated Use `FDate` instead.
+ */
+export declare const DATE_REGEXP_WITH_DASH: RegExp;
+
+/* Excluded from this release type: DateFormat */
+
+/**
+ * A string in format YYYY-MM-DD, for example 2021-02-03
+ *
+ * @public
+ */
+export declare type DateString = string;
+
+/**
+ * Executes a function when it stops being invoked for n seconds. Usually used together with resize,
+ * scroll and keyup/keydown-events to improve application's performance.
+ *
+ * Example:
+ *
+ * ```
+ *    window.addEventListener(
+ *        'resize',
+ *        debounce(computationalHeavyFunction, 1000),
+ *    );
+ * ```
+ *
+ * This will call the `computationalHeavyFunction` once if the resize-event hasn't been sent for 1000 ms.
+ *
+ * Example with immediate-flag:
+ *
+ * ```
+ *    window.addEventListener(
+ *        'resize',
+ *        debounce(computationalHeavyFunction, 1000, true),
+ *    );
+ * ```
+ *
+ * This will call the `computationalHeavyFunction` once BEFORE the resize-event has finished,
+ * and thereafter will not be able to be called again until the timeout has finished
+ *
+ * @public
+ * @param func - Function to be debounced.
+ * @param delay - Function execution threshold in milliseconds.
+ * @param immediate - Whether the function should be called at the beginning of the delay (Before the timeout) instead of the end.
+ * Default is false.
+ */
+export declare function debounce<TThis, TArgs extends unknown[], TReturn>(this: TThis, func: (this: TThis, ...args: TArgs) => TReturn, delay: number, immediate?: boolean): (...args: TArgs) => void;
+
+/**
+ * @public
+ */
+export declare interface DecimalValidatorConfig extends ValidatorOptions {
+    minDecimals: number;
+    maxDecimals: number;
+}
+
+/**
+ * Decorates an original error with more information while
+ * keeping the original intact.
+ *
+ * @public
+ */
+export declare class DecoratedError extends Error {
+    cause: Error;
+    constructor(message: string, cause: Error);
+    /**
+     * Get the direct cause of this error, the one that triggered
+     * this error.
+     */
+    getCause(): Error;
+    /**
+     * Get the root cause of this error, the first error that occured.
+     */
+    getRootCause(): Error;
+}
+
+/**
+ * Perform a deep clone of the given value.
+ *
+ * This function supports cloning:
+ *
+ * - Primitive types such as booleans, numbers and strings
+ * - Arrays and objects
+ * - Classes
+ * - `Date`,
+ * - `Map`,
+ * - `RegExp`
+ * - `Set`
+ * - `Symbol`
+ *
+ * The following values are NOT cloned:
+ *
+ * - `Error` (and subclasses) - Cloned value will reference the same Error instance.
+ * - DOM `Node` (and subclasses) - Cloned value will return the same DOM reference.
+ * - `Function` (and arrow functions) - Cloned value will be an empty object `{}`
+ *
+ * @public
+ * @param value - The value to recursively clone.
+ * @returns Returns the deep cloned value.
+ */
+export declare function deepClone<T>(value: T): T;
+
+/**
+ * @public
+ */
+export declare function deleteCookie(name: string): void;
+
+/**
+ * Compares the position of the given node against another node in any document.
+ *
+ * Unset elements (e.g. `null`) are undefined behaviour but the current
+ * non-contractural behaviour is to put them at the end of the sorted
+ * array. The caller should ensure those elements are removed before sorting.
+ *
+ * @example
+ * ```ts
+ * const sorted = listOfElements.sort(documentOrderComparator);
+ * ```
+ *
+ * @public
+ */
+export declare function documentOrderComparator<T extends Node>(a?: T | null, b?: T | null): number;
+
+declare namespace DomUtils {
+    export {
+        addFocusListener,
+        documentOrderComparator,
+        focus_2 as focus,
+        isFocusable,
+        isTabbable,
+        findTabbableElements,
+        focusFirst,
+        focusLast,
+        restoreFocus,
+        saveFocus,
+        FocusOptions_2 as FocusOptions,
+        popFocus,
+        pushFocus,
+        StackHandle,
+        handleTab,
+        isRadiobuttonOrCheckbox,
+        isValidatableFormElement,
+        isVisible,
+        isVisibleInViewport,
+        removeFocusListener,
+        scrollTo_2 as scrollTo,
+        ScrollToOptions_2 as ScrollToOptions
+    }
+}
+export { DomUtils }
+
+/**
+ * @public
+ */
+export declare const ElementIdService: ElementIdServiceInterface;
+
+/**
+ * @public
+ */
+export declare interface ElementIdServiceInterface {
+    /**
+     * Returns an element id in the following format: `fkui-vue-element-<elementId>`.
+     */
+    generateElementId(prefix?: string): string;
+    /**
+     * Resets the internal state.
+     */
+    reset(): void;
+}
+
+/**
+ * @public
+ */
+export declare interface ElementValidatorsReference {
+    validators: Validator[];
+    validatorConfigs: ValidatorConfigs;
+    baseValidatorConfigs?: ValidatorConfigs;
+    element: ValidatableHTMLElement;
+    instant: boolean;
+}
+
+/**
+ * @public
+ */
+export declare interface EmailValidatorConfig extends ValidatorOptions {
+    maxLength: number;
+}
+
+/**
+ * Assert that a value is set and throw a {@link MissingValueError} if it is not,
+ * i.e., both null and undefined values will throw an error. This can be nice to
+ * use when transforming data between view model and rest api model.
+ *
+ * @public
+ * @param value - the value asserted to be set.
+ * @param message - an optional exception message to use if the check fails.
+ * @returns the value unambiguously defined.
+ * @throws {@link MissingValueError} if value is not set.
+     */
+ export declare function ensureSet<T>(value: T | undefined | null, message?: string): T | never;
+
+ /**
+  * @public
+  */
+ export declare function findCookie(name: string): string | undefined;
+
+ /**
+  * Find all visible and tabbable elements.
+  *
+  * @public
+  * @param root - Element or document to find tabbable elements in.
+  * @returns List of matching elements
+  */
+ export declare function findTabbableElements(root: HTMLElement | Document): HTMLElement[];
+
+ /**
+  * Configuration parameters specific to FKUI Logic
+  *
+  * @public
+  */
+ export declare interface FKUIConfigLogic {
+     production: boolean;
+ }
+
+ /**
+  * Takes an optionally nested textobject structure and convert to a flat
+  * structure. Nested keys are joined with a dot ".". Deep nesting is supported.
+  *
+  * Given the following:
+  * ```
+  * {
+  *   "foo": {
+  *     "bar": "text"
+  *   }
+  * }
+  * ```
+  *
+  * It would produce the following output:
+  * ```
+  * {
+  *   "foo.bar": "text"
+  * }
+  * ```
+  *
+  * If the src object is already flat the output will be the same.
+  *
+  * @public
+  * @param src - Source data
+  * @param destination - Destination to write temporary result to.
+  * @param prefix - If set this is prefixed to all keys.
+  */
+ export declare function flatten(src: NestedStringRecord, destination?: Record<string, string>, prefix?: string): Record<string, string>;
+
+ /**
+  * Give focus to a given element.
+  *
+  * For convenience it will ignore `null` and `undefined` as element parameter.
+  *
+  * If in a Vue context, please refer to the `focus` method included in `@fkui/vue`.
+  *
+  * @public
+  * @param element - Element to focus.
+  * @param options - Focus options. If you pass boolean `true` or `false` it sets the `force` option.
+  */
+ declare function focus_2(element: Element | null | undefined, options?: boolean | FocusOptions_2): void;
+ export { focus_2 as focus }
+
+ /**
+  * Focus first focusable element among given root element's hierarchy.
+  *
+  * @public
+  * @param rootElement - Root element.
+  */
+ export declare function focusFirst(rootElement: HTMLElement): void;
+
+ /**
+  * Focus last focusable element among given root element's hierarchy.
+  *
+  * @public
+  * @param rootElement - Root element.
+  */
+ export declare function focusLast(rootElement: HTMLElement): void;
+
+ /**
+  * Options for {@link focus}.
+  *
+  * @public
+  */
+ declare interface FocusOptions_2 {
+     /**
+      * If set to `true` `tabindex="-1"` will be added as needed so any element
+      * can be focused.
+      */
+     force?: boolean;
+     /**
+      * By default the element is scrolled into view. Set this to `true` to prevent this behavior.
+      *
+      * See full description of [`preventScroll` at
+      * MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus#parameters)
+      */
+     preventScroll?: boolean;
+     /**
+      * By default the element is scrolled into view centered vertically. Set this to `true` to
+      * scroll such that the elements top is at the top of the viewport.
+      *
+      * It will utilize the `scrollIntoView` function, see full description of [`scrollIntoView` at
+      * MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView)
+      */
+     scrollToTop?: boolean;
+ }
+ export { FocusOptions_2 as FocusOptions }
+
+ /**
+  * @public
+  * @deprecated Use {@link formatNumber} instead.
+  */
+ export declare const FORMAT_3_DIGITS_GROUPS: RegExp;
+
+ /**
+  * @public
+  */
+ export declare function formatClearingNumberForBackend(value: ClearingnumberString): string | undefined;
+
+ /**
+  * Format number with thousand separator and use comma as decimal separator.
+  *
+  * @public
+  */
+ export declare function formatNumber(value: number | string | undefined | null, decimals?: number): string | undefined;
+
+ /**
+  * @public
+  */
+ export declare function formatPercent(modelValue: number | string | undefined | null, decimals?: number): string | undefined;
+
+ /**
+  * Formats personnummer to a 10-digit string.
+  *
+  * @public
+  */
+ export declare function formatPersonnummer(value: PersonnummerString | null | undefined): string | undefined;
+
+ /**
+  * @public
+  */
+ export declare function formatPostalCode(value: string | undefined | null): string | undefined;
+
+ /**
+  * @public
+  */
+ export declare function getErrorMessages(): Record<string, string>;
+
+ /**
+  * Handle tab focus between given containers focusable elements
+  *
+  * @public
+  * @param event - tab KeyboardEvent
+  * @param container - containing focusable elements
+  */
+ export declare function handleTab(event: KeyboardEvent, container: HTMLElement): void;
+
+ /**
+  * @public
+  */
+ export declare interface InvalidDatesValidatorConfig extends ValidatorOptions {
+     dates: string[];
+ }
+
+ /**
+  * @public
+  */
+ export declare interface InvalidWeekdaysValidatorConfig extends ValidatorOptions {
+     days: number[];
+ }
+
+ /**
+  * Determine if a value is empty.
+  *
+  * A value is considered empty if it is:
+  *
+  * - `undefined`
+  * - `null`
+  * - empty string `""`.
+  *
+  * @public
+  * @param value - value to check if it is empty
+  */
+ export declare function isEmpty(value: string | undefined | null): value is "" | undefined | null;
+
+ /* Excluded from this release type: isFieldset */
+
+ /**
+  * Check if an element is focusable (visible and either interactive or with
+  * tabindex). This includes programatically focusable elements.
+  *
+  * @public
+  * @param element - An `Element` for which to test focusability.
+  * @returns `true` if the element is focusable, otherwise `false`.
+  */
+ export declare function isFocusable(element: Element): boolean;
+
+ /**
+  * @public
+  */
+ export declare function isInvalidDatesConfig(value: Partial<InvalidDatesValidatorConfig>): value is InvalidDatesValidatorConfig;
+
+ /**
+  * @public
+  */
+ export declare function isInvalidWeekdaysConfig(value: Partial<InvalidWeekdaysValidatorConfig>): value is InvalidWeekdaysValidatorConfig;
+
+ /**
+  * Check if element is of type radiobutton or checkbox
+  *
+  * @public
+  */
+ export declare function isRadiobuttonOrCheckbox(element: Element): element is HTMLInputElement;
+
+ /**
+  * Determine if a value is set. If it is undefined or null, this function
+  * returns false.
+  *
+  * @public
+  * @param value - the value for which to determine if it is set
+  */
+ export declare function isSet<T>(value: T | undefined | null): value is T;
+
+ /**
+  * @public
+  */
+ export declare function isString(value: string | unknown): boolean;
+
+ /**
+  * Check if an element is tabbable (visible and either interactive or
+  * non-negative tabindex). This does not include programatically focusable
+  * elements.
+  *
+  * @public
+  * @param element - An `Element` for which to test focusability.
+  * @returns `true` if the element is focusable, otherwise `false`.
+  */
+ export declare function isTabbable(element: Element): boolean;
+
+ /**
+  * Check if element is a form element
+  *
+  * Also see {@link isValidatableHTMLElement} for a similar function but
+  * including HTMLFieldSetElement.
+  *
+  * @public
+  * @param element - Element to test
+  */
+ export declare function isValidatableFormElement(element: Element): element is HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement;
+
+ /**
+  * Returns true if given element is a validatable element.
+  *
+  * Also see {@link isValidatableFormElement} for a similar function but
+  * excluding HTMLFieldSetElement.
+  *
+  * @public
+  * @param element - Element to test
+  */
+ export declare function isValidatableHTMLElement(element: Element): element is ValidatableHTMLElement;
+
+ /* Excluded from this release type: isValidDate */
+
+ /**
+  * Check if an element is visible in the dom
+  *
+  * @public
+  */
+ export declare function isVisible(element: HTMLElement): boolean;
+
+ /**
+  * Check if an element is fully visible in the viewport
+  *
+  * @public
+  */
+ export declare function isVisibleInViewport(element: Element): boolean;
+
+ /**
+  * @public
+  */
+ export declare interface MatchesValidatorConfig extends ValidatorOptions {
+     /** Identifier of another input field */
+     id?: string;
+ }
+
+ /**
+  * @public
+  */
+ export declare interface MaxDateValidatorConfig extends ValidatorOptions {
+     limit: string;
+ }
+
+ /**
+  * @public
+  */
+ export declare interface MaxLengthValidatorConfig extends ValidatorOptions {
+     length: number;
+ }
+
+ /**
+  * @public
+  */
+ export declare interface MinDateValidatorConfig extends ValidatorOptions {
+     limit: string;
+ }
+
+ /**
+  * @public
+  */
+ export declare interface MinLengthValidatorConfig extends ValidatorOptions {
+     length: number;
+ }
+
+ /**
+  * An error indicating that a mandatory value is not set.
+  *
+  * @public
+  */
+ export declare class MissingValueError extends Error {
+     constructor(message?: string);
+ }
+
+ /**
+  * @public
+  */
+ export declare interface NestedStringRecord {
+     [key: string]: string | NestedStringRecord;
+ }
+
+ /* Excluded from this release type: normalizeDateFormat */
+
+ /**
+  * A string with 6 digits followed by additional 4 digits separated by a hyphen,
+  * for example "999999-9999".
+  *
+  * @public
+  */
+ export declare type OrganisationsnummerString = string;
+
+ /**
+  * @public
+  */
+ export declare function parseBankAccountNumber(value: string): BankAccountNumberString | undefined;
+
+ /**
+  * @public
+  */
+ export declare function parseBankgiro(value: string): BankgiroString | undefined;
+
+ /**
+  * @public
+  */
+ export declare function parseClearingNumber(value: string): ClearingnumberString | undefined;
+
+ /**
+  * @public
+  */
+ export declare function parseDate(value: string): DateString | undefined;
+
+ /**
+  * @public
+  */
+ export declare function parseNumber(value: string): number | undefined;
+
+ /**
+  * @public
+  */
+ export declare function parseOrganisationsnummer(value: string): OrganisationsnummerString | undefined;
+
+ /**
+  * @public
+  */
+ export declare function parsePercent(viewValue: string): number;
+
+ /**
+  * Parses 10- and 12-digit personnummers.
+  *
+  * @public
+  */
+ export declare function parsePersonnummer(value: string | null | undefined, now?: FDate): PersonnummerString | undefined;
+
+ /**
+  * Parses 10- and 12-digit personnummers with Luhn validation.
+  *
+  * @public
+  */
+ export declare function parsePersonnummerLuhn(value: string | null | undefined): PersonnummerString | undefined;
+
+ /**
+  * @public
+  */
+ export declare function parsePlusgiro(value: string): PlusgiroString | undefined;
+
+ /**
+  * @public
+  */
+ export declare function parsePostalCode(value: string): PostalCodeString | undefined;
+
+ /**
+  * @public
+  */
+ export declare type PartialRecord<K extends keyof any, T> = {
+     [P in K]?: T;
+ };
+
+ /**
+  * Describes the event that is dispatched during input if no instant validation.
+  *
+  * @public
+  */
+ export declare interface PendingValidityEvent {
+ }
+
+ /**
+  * This feature can be used by creating a new file with something like:
+  *
+  * ```
+  * export const MyCustomPersistenceService = new PersistenceService<MyCustomApplicationModel>();
+  * ```
+  *
+  * There is also a simplified version in {@link SimplePersistenceService}.
+  *
+  * @public
+  */
+ export declare class PersistenceService<T> implements PersistenceServiceInterface<T> {
+     private cache;
+     constructor();
+     set(key: string, value: T): void;
+     get(key: string): T;
+     find(key: string): T | undefined;
+     remove(key: string): void;
+     /* Excluded from this release type: isSessionPresent */
+ }
+
+ /**
+  * @public
+  */
+ export declare interface PersistenceServiceInterface<T> {
+     set(key: string, value: T): void;
+     get(key: string): T;
+     find(key: string): T | undefined;
+     remove(key: string): void;
+ }
+
+ /**
+  * A 12-digit string including hyphen separator, for example "99999999-9999"
+  *
+  * @public
+  */
+ export declare type PersonnummerString = string;
+
+ /**
+  * A string containing of digits separated by spaces and hyphen, see spec-file for
+  * examples
+  *
+  * @public
+  */
+ export declare type PlusgiroString = string;
+
+ /**
+  * Restore the focus on the last element from the stack
+  *
+  * @public
+  * @throws Error when pop is called on an empty focus stack
+  * @throws Error when pop is called without a valid StackHandle
+  */
+ export declare function popFocus(handle: StackHandle): void;
+
+ /* Excluded from this release type: POSTAL_CODE_REGEXP */
+
+ /**
+  * A 5-digit string with space separator, for example "932 22"
+  *
+  * @public
+  */
+ export declare type PostalCodeString = string;
+
+ /**
+  * Save current active element focus on the stack and set focus on element
+  *
+  * @public
+  * @param element - The element to set focus on
+  */
+ export declare function pushFocus(element?: Element | null): StackHandle;
+
+ /**
+  * @public
+  */
+ export declare class Reference<T extends Record<string, any>> {
+     readonly ref: T;
+     constructor(ref: T);
+ }
+
+ /**
+  * Remove listener for each item in the list of elements
+  *
+  * @public
+  */
+ export declare function removeFocusListener(elements: HTMLElement[], listener: ((event: Event) => unknown) | (() => unknown)): void;
+
+ /**
+  * Restore focus to a previous element. Use this in combination with {@link saveFocus}
+  *
+  * @public
+  */
+ export declare function restoreFocus(): void;
+
+ /**
+  * Save a DOM reference to the active element for later use.
+  *
+  * @public
+  * @param document - Document element
+  */
+ export declare function saveFocus(document: Document): void;
+
+ /**
+  * Default delay in milliseconds for {@link waitForScreenReader}
+  *
+  * @public
+  */
+ export declare const SCREEN_READER_DELAY = 100;
+
+ /**
+  * Scroll to element with scroll options.
+  *
+  * @public
+  * @param element - Element to scroll into view
+  * @param options - scroll options (duration, offset)
+  */
+ declare function scrollTo_2(element: Element, options: ScrollToOptions_2): Promise<void>;
+
+ /**
+  * Scroll to element
+  *
+  * @public
+  * @param element - Element to scroll into view
+  * @param offset - Set vertical offset, default 0px
+  */
+ declare function scrollTo_2(element: Element, offset?: number): Promise<void>;
+ export { scrollTo_2 as scrollTo }
+
+ /**
+  * Optional arguments for scrollTo.
+  *
+  * @public
+  * @param duration - Duration in milliseconds
+  * @param offset - Set vertical offset, default 0px
+  */
+ declare interface ScrollToOptions_2 {
+     duration?: number;
+     offset?: number;
+ }
+ export { ScrollToOptions_2 as ScrollToOptions }
+
+ /**
+  * @public
+  */
+ export declare function setCookie(options: CookieOptions): void;
+
+ /**
+  * This feature can be used by creating a new file with something like:
+  *
+  * ```ts
+  * export const MyAwesomePersistenceService = new SimplePersistenceService<MyAwesomeModel>("my-awesome-key");
+  * ```
+  *
+  * There is also a more advanced version in {@link PersistenceService}.
+  *
+  * @public
+  */
+ export declare class SimplePersistenceService<T> implements SimplePersistenceServiceInterface<T> {
+     private persistenceService;
+     private key;
+     constructor(key: string);
+     set(value: T): void;
+     get(): T;
+     find(): T | undefined;
+     remove(): void;
+ }
+
+ /**
+  * @public
+  */
+ export declare interface SimplePersistenceServiceInterface<T> {
+     set(value: T): void;
+     get(): T;
+     find(): T | undefined;
+     remove(): void;
+ }
+
+ /**
+  * @public
+  */
+ export declare interface StackHandle {
+     [sym]: number;
+ }
+
+ /** @public */
+ export declare function stripNull<T>(obj: T): T;
+
+ /** @public */
+ export declare function stripNull(obj: null): undefined;
+
+ /** @public */
+ export declare function stripNull(obj: number): number;
+
+ /** @public */
+ export declare function stripNull(obj: string): string;
+
+ /**
+  * Strips all whitespace from the text (not only leading and trailing)
+  *
+  * @public
+  * @param text - Text to strip whitespace from.
+  * @returns Text with whitespace stripped.
+  */
+ export declare function stripWhitespace(text: string): string;
+
+ declare const sym: unique symbol;
+
+ /**
+  * Takes a string containing only numbers and checks that the checksum is correct
+  * according to the Luhn Algorithm.
+  *
+  * @public
+  * @param inputString - A string containing only numbers
+  */
+ export declare function testLuhnChecksum(inputString: string): boolean;
+
+ /**
+  * @public
+  */
+ export declare type TranslateFunction = (key: string, defaultValueOrArgs?: string | Record<string, unknown>, args?: Record<string, unknown>) => string;
+
+ /**
+  * @public
+  */
+ export declare interface TranslationProviderInterface {
+     readonly currentLanguage: string;
+     changeLanguage(language: string): Promise<void> | Promise<TranslateFunction>;
+     translate(key: string, defaultValueOrArgs?: string | Record<string, unknown>, args?: Record<string, unknown>): string;
+ }
+
+ /**
+  * @public
+  */
+ export declare const TranslationService: TranslationServiceInterface;
+
+ /**
+  * @public
+  */
+ export declare interface TranslationServiceInterface {
+     provider: TranslationProviderInterface;
+     changeProvider(provider: TranslationProviderInterface): void;
+ }
+
+ /**
+  * @public
+  */
+ export declare type ValidatableHTMLElement = HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement | HTMLFieldSetElement;
+
+ /**
+  * Event used to trigger validation.
+  *
+  * @public
+  */
+ export declare interface ValidateEvent {
+ }
+
+ /**
+  *  Emitted when the validation configuration is updated and includes the current configuration.
+  *
+  * @public
+  */
+ export declare interface ValidationConfigUpdateDetail {
+     /** Current configuration */
+     config: ValidatorConfigs;
+ }
+
+ /**
+  * Builder to create validation error message map.
+  *
+  * @public
+  */
+ export declare class ValidationErrorMessageBuilder {
+     /**
+      * Create a new builder.
+      */
+     static create(): ValidationErrorMessageBuilder;
+     private validatorMessageMap;
+     private constructor();
+     /**
+      * Map the validator name message towards an error message.
+      *
+      * @param validatorName - the name of the validator
+      * @param message - the error message
+      * @param elementType - limit to a specific element type
+      */
+     map(validatorName: ValidatorName, message: string, elementType?: "text" | "radio" | "checkbox" | "select" | "textarea"): this;
+     /**
+      * Validators that coexists on same element can have a combined message,
+      * i.e. if a element have the `required` and the `personnummer` validator
+      * the required error message could be combined with
+      * `mapCombined('required','personnummer', 'You must enter a social security number!');`.
+      *
+      * @param validatorName - the name of the validator
+      * @param dependentValidatorName - the name of the combined validator
+      * @param message - the error message
+      * @param elementType - limit to a specific element type
+      */
+     mapCombined(validatorName: ValidatorName, dependentValidatorName: ValidatorName, message: string, elementType?: "text" | "radio" | "checkbox" | "select" | "textarea"): this;
+     /**
+      * Build the translation map.
+      *
+      * @returns the created map.
+      */
+     build(): Record<string, string>;
+ }
+
+ /**
+  * Result of {@link ValidationServiceInterface.validateElement}.
+  *
+  * @public
+  */
+ export declare interface ValidationResult {
+     /**
+      * `true` if the element is valid and have no validation errors.
+      */
+     isValid: boolean;
+     /**
+      * `true` if the field has been touched, i.e. the user has interacted with
+      * it.
+      */
+     isTouched: boolean;
+     /**
+      * `true` if the field has been submitted (or attempted to be submitted)
+      */
+     isSubmitted: boolean;
+     /**
+      * Validation error message.
+      *
+      * `null` if no validation error is present.
+      */
+     error: string | null;
+ }
+
+ /**
+  * @public
+  */
+ export declare const ValidationService: ValidationServiceInterface;
+
+ /**
+  * @public
+  */
+ export declare interface ValidationServiceInterface {
+     /* Excluded from this release type: getElementsAndValidators */
+     /**
+      * Whether any of the fields are touched
+      */
+     readonly isAnyTouched: boolean;
+     /* Excluded from this release type: validationErrorMessages */
+     /* Excluded from this release type: resolveValidityModeWhenError */
+     /**
+      * Check if given element(s) are valid.
+      *
+      * When passing multiple elements all of them must be valid. For non-input
+      * elements (fieldsets, divs, etc) it checks whenever all descendants are
+      * valid. Returns `true` if array is empty.
+      *
+      * Note: this function does not update the validity state (i.e. run
+      * validators) but only checks the current state! Use
+      * {@link ValidationServiceInterface.validateElement} to update state.
+      *
+      * @public
+      * @deprecated Use {@link ValidationServiceInterface.validateElement} instead.
+      * @param src - Element instance or id.
+      * @param root - Element (or document) to query when looking up elements by id.
+      * @returns Resolves to `true` if all given elements (or descendants) are valid. Empty array resolves to `true`.
+      */
+     isValid(src: string | string[] | Element | Element[] | null, root?: Document | Element): Promise<boolean>;
+     /**
+      * Add translations for validators.
+      * New translations will be merged with existing
+      * translations and overwritten if they already exists.
+      * @see {@link ValidationErrorMessageBuilder}
+      *
+      * @public
+      * @param validationErrorMessageMap - the map with translation for validators
+      */
+     addValidationErrorMessages(validationErrorMessageMap: Record<ValidatorName | string, string>): void;
+     /**
+      * Register a validator.
+      * To be used when a customer validator is needed.
+      *
+      * @param validator - the validator to register
+      */
+     registerValidator<TConfig = ValidatorConfig>(validator: Validator<TConfig>): void;
+     /**
+      * Remove element from ValidationService.
+      *
+      * @param element - Element to remove validators from.
+      */
+     removeValidatorsFromElement(element: ValidatableHTMLElement): void;
+     /**
+      * Add validators to an element.
+      *
+      * @param element - the element to add validator to
+      * @param validatorConfigs - the defintion of validators to be addede.
+      * @param isBaseConfigs - is a boolean which indicates if this configuration
+      * should always lay as a base configuration even if overlaying code is
+      * changing its validators.
+      *
+      * As an example there is FEmailTextField which sets its own EmailValidator
+      * in the constructor. Then the app-code can add its own validatorsConfig on
+      * top of that (example: `required: { enabled: $someValue } }`). Setting
+      * isBaseConfigs to true preserves the validatorConfig set by
+      * FEmailTextField as the app code changes the required validatorConfig
+      * (which triggers `addValidatorsToElement()` again)
+      *
+      * @see {@link ValidityEvent} dispatched during blur and change
+      * @see {@link PendingValidityEvent} dispatched during input
+      */
+     addValidatorsToElement(element: ValidatableHTMLElement, validatorConfigs: ValidatorConfigs, isBaseConfigs?: boolean): void;
+     /**
+      * Set or update validation state on element(s).
+      *
+      * Can be used to restore state after page reload, or to set all elements in
+      * a subform to submitted.
+      *
+      * If passed element is a not a validatable element, the state of all
+      * validatable children is updated instead.
+      *
+      * @see {@link ValidityEvent} validityMode
+      *
+      * @public
+      * @deprecated Use {@link ValidationServiceInterface.setSubmitted},
+      * {@link ValidationServiceInterface.setTouched},
+      * {@link ValidationServiceInterface.setError},
+      * {@link ValidationServiceInterface.resetState} or request a specific
+      * function is added if you have another use-case.
+      * @param element - Element instance or id
+      * @param validationState - The state to be set
+      */
+     setState(element: string | Element | null, validationState: ValidationState): void;
+     /**
+      * Set `submitted` flag on the given Element.
+      *
+      * If passed element is not a validatable element the state of all
+      * validatable children is updated instead.
+      *
+      * @public
+      * @param element - Element instance or id.
+      */
+     setSubmitted(element: string | Element | null): void;
+     /**
+      * Set `touched` flag on the given Element.
+      *
+      * If passed element is not a validatable element the state of all
+      * validatable children is updated instead.
+      *
+      * @public
+      * @param element - Element instance or id.
+      */
+     setTouched(element: string | Element | null): void;
+     /**
+      * Set element as invalid with the given strnig as error message.
+      *
+      * @public
+      * @param element - Element instance or id.
+      * @param message - Error message to present.
+      */
+     setError(element: string | Element | null, message: string): void;
+     /**
+      * Reset validation status for given element
+      * If passed element is a not a validatable element, the state of all validatable
+      * children is updated instead.
+      *
+      * @param element - Element instance or id
+      */
+     resetState(element: string | Element | null): void;
+     /**
+      * Update validation status of given element.
+      *
+      * @public
+      * @param element - Element instance or id. Element must be attached to `document`.
+      */
+     validateElement(element: string | Element | null): Promise<ValidationResult>;
+     /**
+      * Validate all validatable descendants of given element.
+      *
+      * @public
+      * @param root - The top element to validate.
+      */
+     validateAllElements(root: string | Element): Promise<void>;
+     /**
+      * Clears all validation states.
+      */
+     clearAllStates(): void;
+     /**
+      * Gets a registered validator by its name, i.e., {@link Validator.name}.
+      *
+      * @public
+      * @param name - The name of the validator to retrieve.
+      * @returns The registered validator with the given name.
+      * @throws Error if no validator has been registered by the provided name.
+      */
+     getValidatorByName<TConfig = ValidatorConfig>(name: ValidatorName): Validator<TConfig>;
+ }
+
+ /**
+  * Describes the initial state of the validator.
+  * @see {@link ValidationServiceInterface} setState
+  *
+  * @public
+  */
+ export declare interface ValidationState {
+     touched?: boolean;
+     submitted?: boolean;
+     serverError?: string;
+ }
+
+ /**
+  * Describes an input validator.
+  *
+  * @public
+  */
+ export declare interface Validator<TConfig = ValidatorConfig> {
+     /**
+      * The name of the validator.
+      */
+     name: ValidatorName;
+     /**
+      * Validation method
+      */
+     validation(value: string, element: ValidatableHTMLElement, config: Partial<TConfig>): boolean;
+     /**
+      * Optional instant validation
+      */
+     instant?: boolean;
+ }
+
+ /**
+  * Describes the configuration of a validator.
+  *
+  * @public
+  */
+ export declare type ValidatorConfig = Record<string, string | number | boolean | string[] | unknown[]> & ValidatorOptions;
+
+ /**
+  * Describes the configuration of several validators,
+  * e.g `{ 'maxLength': { 'length: 13 }, 'minLength' { 'length: 12 }}`
+  *
+  * @public
+  */
+ export declare type ValidatorConfigs = PartialRecord<ValidatorName | string, ValidatorConfig>;
+
+ /**
+  * Type for validator name, i.e. keys in inputValidators.
+  *
+  * @public
+  */
+ export declare type ValidatorName = string;
+
+ /**
+  * @public
+  */
+ export declare interface ValidatorOptions {
+     /**
+      * Custom error message.
+      */
+     errorMessage?: string;
+     /**
+      * If the validator should validate on each change.
+      */
+     instant?: boolean;
+     /**
+      * If the validator should validate/run.
+      */
+     enabled?: boolean;
+ }
+
+ /**
+  * @public
+  */
+ export declare function validChecksum(value: string): boolean;
+
+ /**
+  * Describes the event that is dispatched by the validator.
+  *
+  * @public
+  */
+ export declare interface ValidityEvent {
+     target: ValidatableHTMLElement;
+     elementId: string;
+     isValid: boolean;
+     validationMessage: string;
+     validityMode: ValidityMode;
+     nativeEvent: ValidityNativeEvent;
+ }
+
+ /**
+  * @public
+  */
+ export declare type ValidityMode = "INITIAL" | "ERROR" | "VALID";
+
+ /**
+  * @public
+  */
+ export declare type ValidityNativeEvent = "input" | "change" | "blur" | "validate";
+
+ /**
+  * @public
+  */
+ export declare function validLimit(limit: unknown): string;
+
+ /**
+  * Defer execution of passed function to allow screen reader to update.
+  * Used if screen reader has not been updated with changed or added
+  * aria attributes before interaction.
+  *
+  * See issue:
+  * https://github.com/nvaccess/nvda/issues/12738
+  *
+  * @public
+  */
+ export declare function waitForScreenReader<TReturn = void>(callback: () => TReturn, delay?: number): Promise<TReturn>;
+
+ /**
+  * Matches a single whitespace globally.
+  *
+  * @public
+  * @deprecated Use {@link stripWhitespace} instead
+  */
+ export declare const WHITESPACE_PATTERN: RegExp;
+
+ export { }