@dxtmisha/constructor 0.23.0 → 0.39.3

package/dist/constructors/Mask/MaskInclude.d.ts

@@ -0,0 +1,67 @@
+import { VNode, ComputedRef } from 'vue';
+import { ConstrBind, DesignComponents, RefOrNormal } from '@dxtmisha/functional';
+import { FieldValueInclude } from '../../classes/field/FieldValueInclude';
+import { FieldTypeInclude } from '../../classes/field/FieldTypeInclude';
+import { FieldValueProps } from '../../types/fieldTypes';
+import { MaskComponentInclude, MaskPropsInclude } from './basicTypes';
+import { MaskProps } from './props';
+type MaskPropsFullInclude = MaskPropsInclude & FieldValueProps;
+/**
+ * Mask management class.
+ *
+ * Класс управления маской.
+ */
+export declare class MaskInclude<Props extends MaskPropsFullInclude = MaskPropsFullInclude, PropsExtra extends ConstrBind<MaskProps> = ConstrBind<MaskProps>> {
+    protected readonly props: Props;
+    protected readonly className: string;
+    protected readonly value: FieldValueInclude;
+    protected readonly valueDefault?: RefOrNormal<any> | undefined;
+    protected readonly components?: DesignComponents<MaskComponentInclude, Props> | undefined;
+    protected readonly type?: FieldTypeInclude | undefined;
+    protected readonly extra?: RefOrNormal<PropsExtra> | undefined;
+    protected readonly index?: string | undefined;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param className class name/ название класса
+     * @param value object for working with values/ объект для работы со значениями
+     * @param valueDefault default value/ значение по умолчанию
+     * @param components object for working with components/ объект для работы с компонентами
+     * @param type object for working with the input type/ объект для работы с типом ввода
+     * @param extra additional parameter or property name/ дополнительный параметр или имя свойства
+     * @param index index identifier/ идентификатор индекса
+     */
+    constructor(props: Props, className: string, value: FieldValueInclude, valueDefault?: RefOrNormal<any> | undefined, components?: DesignComponents<MaskComponentInclude, Props> | undefined, type?: FieldTypeInclude | undefined, extra?: RefOrNormal<PropsExtra> | undefined, index?: string | undefined);
+    /**
+     * Checks if the mask is active.
+     *
+     * Проверяет, активна ли маска.
+     */
+    readonly is: ComputedRef<boolean>;
+    /**
+     * Returns the basic properties for working with a mask.
+     *
+     * Возвращает базовые свойства для работы с маской.
+     */
+    readonly bindsStatic: ComputedRef<PropsExtra>;
+    /**
+     * Returns all properties for working with the mask.
+     *
+     * Возвращает все свойства для работы с маской.
+     */
+    readonly binds: ComputedRef<ConstrBind<MaskProps>>;
+    /**
+     * Returns the rendered mask component.
+     *
+     * Возвращает отрендеренный компонент маски.
+     * @param attrs additional attributes/ дополнительные атрибуты
+     */
+    readonly render: (attrs?: Record<string, any>) => VNode[];
+    /**
+     * Checks if the mask is active.
+     *
+     * Проверяет, активна ли маска.
+     */
+    isActive(): boolean;
+}
+export {};

package/dist/constructors/Mask/MaskItem.d.ts

@@ -0,0 +1,112 @@
+import { MaskType } from './MaskType';
+import { MaskRubberItem } from './MaskRubberItem';
+import { MaskDate } from './MaskDate';
+import { MaskCharacterLength } from './MaskCharacterLength';
+import { MaskSpecial } from './MaskSpecial';
+import { MaskFormat } from './MaskFormat';
+import { MaskList, MaskSpecialInfo } from './basicTypes';
+import { MaskProps } from './props';
+import { ComputedRef } from 'vue';
+/**
+ * Class for working with a mask.
+ *
+ * Класс для работы с маской.
+ */
+export declare class MaskItem {
+    protected readonly props: MaskProps;
+    protected readonly type: MaskType;
+    protected readonly rubberItem: MaskRubberItem;
+    protected readonly characterLength: MaskCharacterLength;
+    protected readonly date: MaskDate;
+    protected readonly format: MaskFormat;
+    protected readonly special: MaskSpecial;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param type object for working with the mask type/ объект для работы с типом маски
+     * @param rubberItem object for working with rubber elements/ объект для работы с резиновыми элементами
+     * @param characterLength object for managing input length/ объект управления длиной ввода
+     * @param date object for working with date types/ объект для работы с типом даты
+     * @param format object for managing numeric mask types/ объект для управления числовыми типами масок
+     * @param special object for working with special characters/ объект для работы со специальными символами
+     */
+    constructor(props: MaskProps, type: MaskType, rubberItem: MaskRubberItem, characterLength: MaskCharacterLength, date: MaskDate, format: MaskFormat, special: MaskSpecial);
+    /**
+     * Returns the current mask.
+     *
+     * Возвращает текущую маску.
+     */
+    readonly item: ComputedRef<string[]>;
+    /**
+     * Returns an array with information about the location of all special characters.
+     *
+     * Возвращает массив с информацией о расположении всех специальных символов.
+     */
+    readonly info: ComputedRef<MaskSpecialInfo[]>;
+    /**
+     * Returns the length of the mask or the maximum length of masks if there are several.
+     *
+     * Возвращает длину маски или максимальную длину масок, если их несколько.
+     */
+    readonly maxLength: ComputedRef<number>;
+    /**
+     * Returns the mask symbol by its index.
+     *
+     * Возвращает символ маски по его индексу.
+     * @param index index of the symbol's location/ индекс расположения символа
+     */
+    get(index: number): string;
+    /**
+     * Returns the location number for replacement by its input symbol.
+     *
+     * Возвращает номер нахождения для замены по его символу ввода.
+     * @param char input symbol/ символ ввода
+     * @param selection minimum index for search/ минимальный индекс для поиска
+     */
+    getByChar(char: string, selection?: number): number;
+    /**
+     * Returns the length of the active mask.
+     *
+     * Возвращает длину активной маски.
+     */
+    getLength(): number;
+    /**
+     * Returns the length of only special characters.
+     *
+     * Возвращает длину только из специальных символов.
+     */
+    getLengthBySpecial(): number;
+    /**
+     * Returns how many special characters were highlighted.
+     *
+     * Возвращает, сколько специальных символов было выделено.
+     * @param start start of selection/ начало выделения
+     * @param end end of selection/ конец выделения
+     */
+    getQuantity(start: number, end: number): number;
+    /**
+     * Returns the active mask.
+     *
+     * Возвращает активную маску.
+     */
+    protected readonly maskActive: ComputedRef<string>;
+    /**
+     * Returns the number of special characters in the current mask.
+     *
+     * Возвращает количество специальных символов в текущей маске.
+     */
+    protected readonly basic: ComputedRef<string[]>;
+    /**
+     * Returns a list of masks.
+     *
+     * Возвращает список масок.
+     */
+    protected getMask(): MaskList;
+    /**
+     * Returns the number of special characters in the current mask.
+     *
+     * Возвращает количество специальных символов в текущей маске.
+     * @param mask selected mask/ выбранная маска
+     */
+    protected getSpecialLength(mask: string): number;
+}

package/dist/constructors/Mask/MaskMatch.d.ts

@@ -0,0 +1,40 @@
+import { MaskSpecial } from './MaskSpecial';
+import { MaskMatchItem } from './basicTypes';
+import { MaskProps } from './props';
+/**
+ * Class for checking an incoming character.
+ *
+ * Класс для проверки входящего символа.
+ */
+export declare class MaskMatch {
+    protected readonly props: MaskProps;
+    protected readonly special: MaskSpecial;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param special special symbols helper/ объект помощник специальных символов
+     */
+    constructor(props: MaskProps, special: MaskSpecial);
+    /**
+     * Checks whether the character matches allowed pattern(s).
+     *
+     * Проверяет, соответствует ли символ разрешённому шаблону.
+     * @param char character to check/ символ для проверки
+     * @param groupName optional group name/ необязательное имя группы
+     */
+    is(char: string, groupName?: string): boolean;
+    /**
+     * Returns match definition (regexp or string) for group or global.
+     *
+     * Возвращает правило проверки (regexp или строка) для группы или глобально.
+     * @param groupName group name/ имя группы
+     */
+    get(groupName?: string): MaskMatchItem;
+    /**
+     * Filters text returning only allowed characters (any group).
+     *
+     * Фильтрует текст, возвращая только допустимые символы (любая группа).
+     * @param text source text/ исходный текст
+     */
+    filter(text: string): string[];
+}

package/dist/constructors/Mask/MaskPattern.d.ts

@@ -0,0 +1,56 @@
+import { FieldInputCheckInclude, FieldInputCheckListInclude } from '../../classes/field/FieldInputCheckInclude';
+import { MaskType } from './MaskType';
+import { MaskSpecial } from './MaskSpecial';
+import { MaskDate } from './MaskDate';
+import { FieldPatternItemOrFunction, FieldPatternList } from '../../types/fieldTypes';
+import { MaskProps } from './props';
+import { ComputedRef } from 'vue';
+/**
+ * Class for producing validation pattern data per mask group.
+ *
+ * Класс для получения данных паттернов валидации по группам маски.
+ */
+export declare class MaskPattern {
+    protected readonly props: MaskProps;
+    protected readonly type: MaskType;
+    protected readonly date: MaskDate;
+    protected readonly special: MaskSpecial;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param type mask type helper/ объект помощник типа маски
+     * @param date date mask helper/ объект помощник маски даты
+     * @param special special symbols helper/ объект помощник специальных символов
+     */
+    constructor(props: MaskProps, type: MaskType, date: MaskDate, special: MaskSpecial);
+    /** Validation input objects by group / Объекты проверки по названию группы */
+    readonly item: ComputedRef<FieldInputCheckListInclude>;
+    /** Patterns list by group / Список паттернов по группам */
+    readonly list: ComputedRef<FieldPatternList>;
+    /**
+     * Checks if there is a global check pattern.
+     *
+     * Проверяет, есть ли глобальный паттерн проверки.
+     */
+    isCheck(): boolean;
+    /**
+     * Returns validation input object by group.
+     *
+     * Возвращает объект проверки по названию группы.
+     * @param groupName group name (default: check)/ имя группы (по умолчанию: check)
+     */
+    getInput(groupName?: string): FieldInputCheckInclude | undefined;
+    /**
+     * Builds base patterns object depending on mask type.
+     *
+     * Формирует базовый объект паттернов в зависимости от типа маски.
+     */
+    protected getByType(): FieldPatternList;
+    /**
+     * Returns pattern definition for group or global pattern.
+     *
+     * Возвращает определение паттерна для группы или глобальный паттерн.
+     * @param groupName group name/ имя группы
+     */
+    protected getPattern(groupName?: string): FieldPatternItemOrFunction | undefined;
+}

package/dist/constructors/Mask/MaskRight.d.ts

@@ -0,0 +1,29 @@
+import { MaskType } from './MaskType';
+import { MaskProps } from './props';
+/**
+ * Class for handling alignment of masked value (direction & numeric rules).
+ *
+ * Класс для управления выравниванием маски (направление и числовые правила).
+ */
+export declare class MaskRight {
+    protected readonly props: MaskProps;
+    protected readonly type: MaskType;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param type mask type helper/ объект помощник типа маски
+     */
+    constructor(props: MaskProps, type: MaskType);
+    /**
+     * Returns whether the content should visually end-align (numeric, rtl, currency).
+     *
+     * Возвращает, нужно ли визуально выравнивать по концу (числа, rtl, валюта).
+     */
+    isEnd(): boolean;
+    /**
+     * Checks if alignment is right (explicit right or end alignment).
+     *
+     * Проверяет, что выравнивание справа (явно right или конечное).
+     */
+    isRight(): boolean;
+}

package/dist/constructors/Mask/MaskRubber.d.ts

@@ -0,0 +1,75 @@
+import { MaskType } from './MaskType';
+import { MaskRubberItem } from './MaskRubberItem';
+import { MaskRubberTransition } from './MaskRubberTransition';
+import { MaskSpecial } from './MaskSpecial';
+import { MaskMatch } from './MaskMatch';
+import { MaskFormat } from './MaskFormat';
+import { FieldMasks } from '../../types/fieldTypes';
+import { MaskSpecialItem, MaskSpecialList } from './basicTypes';
+import { MaskProps } from './props';
+import { ComputedRef } from 'vue';
+/**
+ * Class for working with the rubber type.
+ *
+ * Класс для работы с резиновым типом.
+ */
+export declare class MaskRubber {
+    protected readonly props: MaskProps;
+    protected readonly type: MaskType;
+    protected readonly rubberItem: MaskRubberItem;
+    protected readonly rubberTransition: MaskRubberTransition;
+    protected readonly special: MaskSpecial;
+    protected readonly match: MaskMatch;
+    protected readonly format: MaskFormat;
+    /**
+     * Constructor
+     * @param props base data/ базовые данные
+     * @param type object for working with the mask type/ объект для работы с типом маски
+     * @param rubberItem object for working with rubber elements/ объект для работы с резиновыми элементами
+     * @param rubberTransition object for managing the transition character/ объект для управления символом перехода
+     * @param special object for working with special characters/ объект для работы со специальными символами
+     * @param match object for managing the input character/ объект для управления символом ввода
+     * @param format object for managing numeric mask types/ объект для управления числовыми типами масок
+     */
+    constructor(props: MaskProps, type: MaskType, rubberItem: MaskRubberItem, rubberTransition: MaskRubberTransition, special: MaskSpecial, match: MaskMatch, format: MaskFormat);
+    /**
+     * Checks if the symbol is a transition.
+     *
+     * Проверяет, является ли символ перехода.
+     * @param char checkable symbol/ проверяемый символ
+     */
+    isTransition(char: string): boolean;
+    /**
+     * Getting properties for the rubber group.
+     *
+     * Получение свойства для резиновой группы.
+     * @param groupName group name/ название группы
+     */
+    get(groupName: string): MaskSpecialItem | undefined;
+    /**
+     * Updates the group of rubber symbols if all conditions are met and returns true.
+     *
+     * Обновляет группу резиновых символов, если все условия подходят, и возвращает true.
+     * @param data values for verification/ значения для проверки
+     * @param groupName group name/ название группы
+     * @param char symbol for checking/ символ для проверки
+     */
+    update(data: FieldMasks, groupName: string, char: string): boolean;
+    /**
+     * Reduces the length of the entered symbol by its group.
+     *
+     * Уменьшает длину вводимого символа по его группе.
+     * @param groupName group name/ название группы
+     */
+    pop(groupName: string): boolean;
+    /**
+     * Resets all states of all groups to the initial one.
+     *
+     * Сбрасывает все состояния всех групп до начального.
+     */
+    reset(): this;
+    /** List of rubber groups/ Список резиновых групп */
+    protected readonly list: ComputedRef<MaskSpecialList>;
+    /** List of transition symbols/ Список символов перехода */
+    protected readonly transition: ComputedRef<string[]>;
+}

package/dist/constructors/Mask/MaskRubberItem.d.ts

@@ -0,0 +1,52 @@
+import { Ref } from 'vue';
+/**
+ * Class for storing counts of entered characters for elastic ("rubber") groups.
+ *
+ * Класс для хранения количества введённых символов для «резиновых» групп.
+ */
+export declare class MaskRubberItem {
+    /** Map: group name -> entered length/ Карта: имя группы -> введённая длина */
+    protected readonly item: Ref<Record<string, number>, Record<string, number>>;
+    /**
+     * Checks whether group has a non‑zero stored length.
+     *
+     * Проверяет, есть ли у группы ненулевая длина.
+     * @param groupName group name / название группы
+     */
+    is(groupName: string): boolean;
+    /**
+     * Returns stored length for group (0 if none).
+     *
+     * Возвращает сохранённую длину группы (0 если нет).
+     * @param groupName group name / название группы
+     */
+    getByIndex(groupName: string): number;
+    /**
+     * Increments stored length for group by 1.
+     *
+     * Увеличивает сохранённую длину группы на 1.
+     * @param groupName group name / название группы
+     */
+    add(groupName: string): this;
+    /**
+     * Decreases stored length for group by 1 (if > 0).
+     *
+     * Уменьшает сохранённую длину группы на 1 (если > 0).
+     * @param groupName group name / название группы
+     * @returns true if decreased / true если уменьшено
+     */
+    pop(groupName: string): boolean;
+    /**
+     * Resets all stored lengths.
+     *
+     * Сбрасывает все сохранённые длины.
+     */
+    reset(): this;
+    /**
+     * Expands mask by duplicating matched group placeholders according to stored lengths.
+     *
+     * Расширяет маску, дублируя плейсхолдеры групп по сохранённым длинам.
+     * @param mask original mask / исходная маска
+     */
+    expandMask(mask: string): string;
+}

package/dist/constructors/Mask/MaskRubberTransition.d.ts

@@ -0,0 +1,36 @@
+import { Ref } from 'vue';
+/**
+ * Class for storing and working with the transition symbol for the active group.
+ *
+ * Класс для хранения и работы с символом перехода для активной группы.
+ */
+export declare class MaskRubberTransition {
+    /** Transition symbol value/ Значение символа перехода */
+    readonly item: Ref<string, string>;
+    /**
+     * Checks if a transition symbol is set.
+     *
+     * Проверяет, установлен ли символ перехода.
+     */
+    is(): boolean;
+    /**
+     * Checks if provided char equals current transition symbol.
+     *
+     * Проверяет, совпадает ли символ с текущим символом перехода.
+     * @param char candidate char / проверяемый символ
+     */
+    isChar(char: string): boolean;
+    /**
+     * Sets new transition symbol.
+     *
+     * Устанавливает новый символ перехода.
+     * @param char transition symbol / символ перехода
+     */
+    set(char: string): this;
+    /**
+     * Resets transition symbol to empty.
+     *
+     * Сбрасывает символ перехода в пустой.
+     */
+    reset(): this;
+}

package/dist/constructors/Mask/MaskSelection.d.ts

@@ -0,0 +1,119 @@
+import { MaskSpecial } from './MaskSpecial';
+import { MaskItem } from './MaskItem';
+/**
+ * Class for working with the character input location.
+ *
+ * Класс для работы с местом ввода символа.
+ */
+export declare class MaskSelection {
+    protected readonly special: MaskSpecial;
+    protected readonly mask: MaskItem;
+    /** Selection value/ Значение выделения */
+    protected value: number;
+    /** Immediate selection value/ Значение непосредственного выделения */
+    protected immediate: number;
+    /** Shift flag/ Флаг сдвига */
+    protected shift: boolean;
+    /**
+     * Constructor
+     * @param special object for working with special characters/ объект для работы со специальными символами
+     * @param mask object for managing masks/ объект управления маской
+     */
+    constructor(special: MaskSpecial, mask: MaskItem);
+    /**
+     * Getting the selection key number.
+     *
+     * Получение номера ключа выделения.
+     */
+    get(): number;
+    /**
+     * Returns the selection number for the first element that is a special symbol.
+     *
+     * Возвращает номер выделения для первого элемента, являющегося специальным символом.
+     */
+    getFirst(): number;
+    /**
+     * Getting the current key of the selected character.
+     *
+     * Получение текущего ключа выделенного символа.
+     */
+    getFocus(): number;
+    /**
+     * Getting the next key of the selected character.
+     *
+     * Получение следующего ключа выделенного символа.
+     */
+    getNext(): number;
+    /**
+     * Getting the previous key of the selected symbol.
+     *
+     * Получение предыдущего ключа выделенного символа.
+     */
+    getPrevious(): number;
+    /**
+     * Getting the key number of the nearest special character.
+     *
+     * Получение номера ключа ближайшего специального символа.
+     */
+    getImmediate(): number;
+    /**
+     * Getting the number of the key shifted to the left direction.
+     *
+     * Получение номера ключа, сдвинутого в левом направлении.
+     */
+    getShift(): number;
+    /**
+     * Changing the selection key number.
+     *
+     * Изменение номера ключа выделения.
+     * @param selection selection number/ номер выделения
+     */
+    set(selection: number): this;
+    /**
+     * Changes the selection key number according to the mask structure.
+     *
+     * Изменяет номер ключа выделения по структуре маски.
+     * @param selection selection number/ номер выделения
+     * @param focus is the element in focus/ элемент в фокусе ли
+     */
+    setByMask(selection: number, focus?: boolean): this;
+    /**
+     * Changing the selection key for the nearest special character.
+     *
+     * Изменение ключа выделения для ближайшего специального символа.
+     * @param immediate selection key number/ номер ключа выделения
+     */
+    setImmediate(immediate: number): this;
+    /**
+     * Turning shift on or off.
+     *
+     * Включение или отключение сдвига.
+     * @param shift value for shift/ значение для сдвига
+     */
+    setShift(shift: boolean): this;
+    /**
+     * Resets the selection key for the nearest special character to the selection location.
+     *
+     * Сбрасывает ключ выделения для ближайшего специального символа до места выделения.
+     */
+    resetImmediate(): this;
+    /**
+     * Move the selection location back by 1 step.
+     *
+     * Передвигаем место выделения назад на 1 шаг.
+     */
+    goBack(): this;
+    /**
+     * Move the selection location forward by 1 step.
+     *
+     * Передвигаем место выделения вперед на 1 шаг.
+     */
+    goNext(): this;
+    /**
+     * Getting the key number at the selection location.
+     *
+     * Получение номера ключа по месту выделения.
+     * @param selection selection location/ место выделения
+     */
+    protected getCharacter(selection: number): number;
+}