@dxtmisha/constructor 0.30.1 → 0.39.5

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

@@ -0,0 +1,125 @@
+import { Ref, ToRefs, ComputedRef } from 'vue';
+import { ConstrClassObject, ConstrEmit, DesignComp } from '@dxtmisha/functional';
+import { MaskType } from './MaskType';
+import { MaskBuffer } from './MaskBuffer';
+import { MaskFocus } from './MaskFocus';
+import { MaskCharacterLength } from './MaskCharacterLength';
+import { MaskRubberItem } from './MaskRubberItem';
+import { MaskRubberTransition } from './MaskRubberTransition';
+import { MaskDate } from './MaskDate';
+import { MaskFormat } from './MaskFormat';
+import { MaskSpecial } from './MaskSpecial';
+import { MaskMatch } from './MaskMatch';
+import { MaskPattern } from './MaskPattern';
+import { MaskRight } from './MaskRight';
+import { MaskRubber } from './MaskRubber';
+import { MaskItem } from './MaskItem';
+import { MaskSelection } from './MaskSelection';
+import { MaskCharacter } from './MaskCharacter';
+import { MaskValueBasic } from './MaskValueBasic';
+import { MaskValue } from './MaskValue';
+import { MaskValidation } from './MaskValidation';
+import { MaskView } from './MaskView';
+import { MaskEmit } from './MaskEmit';
+import { MaskData } from './MaskData';
+import { MaskEvent } from './MaskEvent';
+import { MaskElementInput } from './basicTypes';
+import { MaskComponents, MaskEmits, MaskSlots } from './types';
+import { MaskProps } from './props';
+/**
+ * Class for working with input masking.
+ *
+ * Класс для работы с маской ввода.
+ */
+export declare class Mask {
+    protected readonly props: MaskProps;
+    protected readonly refs: ToRefs<MaskProps>;
+    protected readonly element: Ref<MaskElementInput>;
+    protected readonly classDesign: string;
+    protected readonly className: string;
+    protected readonly components?: DesignComp<MaskComponents, MaskProps> | undefined;
+    protected readonly slots?: MaskSlots | undefined;
+    protected readonly emits?: ConstrEmit<MaskEmits> | undefined;
+    /** Type helper/ Объект для работы с типом */
+    readonly type: MaskType;
+    /** Buffer helper/ Объект для буферизации ввода */
+    readonly buffer: MaskBuffer;
+    /** Focus helper/ Объект для работы с фокусом */
+    readonly focus: MaskFocus;
+    /** Entered characters length helper/ Объект длины введённых символов */
+    readonly characterLength: MaskCharacterLength;
+    /** Rubber groups length helper/ Объект длины резиновых групп */
+    readonly rubberItem: MaskRubberItem;
+    /** Rubber transition symbol helper/ Объект символа перехода резины */
+    readonly rubberTransition: MaskRubberTransition;
+    /** Date/time mask helper/ Объект для работы с датой/временем */
+    readonly date: MaskDate;
+    /** Number/currency format mask helper/ Объект форматирования числа/валюты */
+    readonly format: MaskFormat;
+    /** Special symbols/groups helper/ Объект для спецсимволов и групп */
+    readonly special: MaskSpecial;
+    /** Match helper/ Объект проверки символов */
+    readonly match: MaskMatch;
+    /** Pattern helper/ Объект паттернов валидации */
+    readonly pattern: MaskPattern;
+    /** Alignment helper/ Объект выравнивания */
+    readonly right: MaskRight;
+    /** Rubber groups helper/ Объект для работы с резиновыми группами */
+    readonly rubber: MaskRubber;
+    /** Mask item helper/ Объект для работы с маской */
+    readonly item: MaskItem;
+    /** Selection helper/ Объект для работы с выделением */
+    readonly selection: MaskSelection;
+    /** Characters helper/ Объект для работы с введёнными символами */
+    readonly character: MaskCharacter;
+    /** Basic value helper/ Объект для работы с базовыми значениями */
+    readonly valueBasic: MaskValueBasic;
+    /** Value helper/ Объект для работы с итоговым значением */
+    readonly value: MaskValue;
+    /** Validation helper/ Объект для работы с валидацией */
+    readonly validation: MaskValidation;
+    /** View helper/ Объект для работы с отображением */
+    readonly view: MaskView;
+    /** Emit helper/ Объект для работы с событиями */
+    readonly emit: MaskEmit;
+    /** Data helper/ Объект для работы с вводом */
+    readonly data: MaskData;
+    /** Event helper/ Объект для работы с DOM-событиями */
+    readonly event: MaskEvent;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param refs input data in the form of reactive elements/ входные данные в виде реактивных элементов
+     * @param element input element/ элемент ввода
+     * @param classDesign design name/ название дизайна
+     * @param className class name/ название класса
+     * @param components object for working with components/ объект для работы с компонентами
+     * @param slots object for working with slots/ объект для работы со слотами
+     * @param emits the function is called when an event is triggered/ функция вызывается, когда срабатывает событие
+     */
+    constructor(props: MaskProps, refs: ToRefs<MaskProps>, element: Ref<MaskElementInput>, classDesign: string, className: string, components?: DesignComp<MaskComponents, MaskProps> | undefined, slots?: MaskSlots | undefined, emits?: ConstrEmit<MaskEmits> | undefined);
+    /** Receiving basic standard values/ Получение базовых стандартных значений */
+    readonly basic: ComputedRef<string>;
+    /** Values for CSS class/ Значения для CSS-класса */
+    readonly classes: ComputedRef<ConstrClassObject>;
+    /**
+     * Sets new value and reinitializes mask.
+     *
+     * Устанавливает новое значение и переинициализирует маску.
+     * @param value new value/ новое значение
+     */
+    readonly set: (value: string) => boolean;
+    /**
+     * Resets all values or updates to the new one.
+     *
+     * Сбрасывает все значения или обновляется до нового.
+     * @param value new values/ новые значения
+     */
+    reset(value?: string | number): boolean;
+    /**
+     * Clears value to default and focuses input.
+     *
+     * Очищает значение до значения по умолчанию и фокусирует поле ввода.
+     */
+    readonly clear: () => void;
+}

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

@@ -0,0 +1,56 @@
+/**
+ * Class for temporary storage of entered symbols to keep input position during fast typing.
+ *
+ * Класс для временного хранения вводимых символов, чтобы не терять позицию ввода при быстром наборе.
+ */
+export declare class MaskBuffer {
+    /** Stored characters/ Сохранённые символы */
+    protected chars: string[];
+    /** Flag: buffering started/ Флаг: буферизация запущена */
+    protected start: boolean;
+    /**
+     * Checks if buffer has records.
+     *
+     * Проверяет, есть ли записи в буфере.
+     */
+    is(): boolean;
+    /**
+     * Returns list of all buffered chars.
+     *
+     * Возвращает список всех символов в буфере.
+     */
+    get(): string[];
+    /**
+     * Adds new symbol to buffer.
+     *
+     * Добавляет новый символ в буфер.
+     * @param key symbol to add / символ для добавления
+     */
+    add(key: string): this;
+    /**
+     * Handles fast input: if buffering active — adds symbol, else starts buffering.
+     *
+     * Обрабатывает быстрый ввод: если буфер активен — добавляет символ, иначе запускает буферизацию.
+     * @param key symbol to process / символ для обработки
+     * @returns true if processing should continue outside buffer / true если ввод продолжается вне буфера
+     */
+    go(key: string): boolean;
+    /**
+     * Starts buffering.
+     *
+     * Запускает буферизацию.
+     */
+    goStart(): this;
+    /**
+     * Resets all data (chars + start flag).
+     *
+     * Сбрасывает все данные (символы и флаг запуска).
+     */
+    reset(): this;
+    /**
+     * Clears stored characters only.
+     *
+     * Очищает только сохранённые символы.
+     */
+    resetChars(): this;
+}

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

@@ -0,0 +1,100 @@
+import { MaskRubberItem } from './MaskRubberItem';
+import { MaskCharacterLength } from './MaskCharacterLength';
+import { MaskSpecial } from './MaskSpecial';
+import { MaskItem } from './MaskItem';
+import { MaskSelection } from './MaskSelection';
+import { MaskProps } from './props';
+import { Ref } from 'vue';
+/**
+ * Class for working with and storing input characters.
+ *
+ * Класс для работы и хранения вводимых символов.
+ */
+export declare class MaskCharacter {
+    protected readonly props: MaskProps;
+    protected readonly rubberItem: MaskRubberItem;
+    protected readonly characterLength: MaskCharacterLength;
+    protected readonly special: MaskSpecial;
+    protected readonly mask: MaskItem;
+    protected readonly selection: MaskSelection;
+    /** Entered characters list/ Список введённых символов */
+    readonly item: Ref<string[], string[]>;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param rubberItem object for working with rubber elements/ объект для работы с резиновыми элементами
+     * @param characterLength object for managing input length/ объект управления длиной ввода
+     * @param special object for working with special characters/ объект для работы со специальными символами
+     * @param mask object for managing masks/ объект управления маской
+     * @param selection object for managing cursor position/ объект для управления положением курсора
+     */
+    constructor(props: MaskProps, rubberItem: MaskRubberItem, characterLength: MaskCharacterLength, special: MaskSpecial, mask: MaskItem, selection: MaskSelection);
+    /**
+     * Checks if the value is filled.
+     *
+     * Проверяет, заполнено ли значение.
+     */
+    is(): boolean;
+    /**
+     * Checks if the selected character was previously deleted.
+     *
+     * Проверяет, является ли выделенный символ ранее удалённым.
+     */
+    isCharDelete(): boolean;
+    /**
+     * Getting the selected mask character.
+     *
+     * Получение выбранного символа маски.
+     */
+    getFocus(): string;
+    /**
+     * Getting the mask character by the key number of the nearest special character.
+     *
+     * Получение символа маски по номеру ключа ближайшего специального символа.
+     */
+    getImmediate(): string;
+    /**
+     * Getting the next mask character.
+     *
+     * Получение следующего символа маски.
+     */
+    getNext(): string;
+    /**
+     * Adding 1 entered character at its selection location.
+     *
+     * Добавление 1 введённого символа по месту его выделения.
+     * @param char entered character/ введённый символ
+     */
+    add(char: string): this;
+    /**
+     * Deleting 1 entered character at its selection location.
+     *
+     * Удаление 1 введённого символа по месту его выделения.
+     */
+    pop(): this;
+    /**
+     * Resets the values to the initial values.
+     *
+     * Сбрасывает значения до начальных.
+     */
+    reset(): this;
+    /**
+     * Shifts by 1 value depending on the direction of selection change.
+     *
+     * Сдвигает на 1 значение в зависимости от направления изменения выделения.
+     * @param status shift status/ статус сдвига
+     */
+    shift(status?: number): this;
+    /**
+     * Checks if there is another group of special characters ahead.
+     *
+     * Проверяет, есть ли впереди другая группа специальных символов.
+     */
+    protected isSpecialNextAnother(): boolean;
+    /**
+     * Updates the length of entered characters.
+     *
+     * Обновляет длину введённых символов.
+     */
+    protected updateLength(): this;
+}

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

@@ -0,0 +1,29 @@
+import { Ref } from 'vue';
+/**
+ * Class for storing the length of entered characters.
+ *
+ * Класс для хранения длины введённых символов.
+ */
+export declare class MaskCharacterLength {
+    /** Current length value/ Текущее значение длины */
+    protected length: Ref<number, number>;
+    /**
+     * Checks if there is at least one entered character.
+     *
+     * Проверяет, есть ли хотя бы один введённый символ.
+     */
+    is(): boolean;
+    /**
+     * Returns current length.
+     *
+     * Возвращает текущую длину.
+     */
+    get(): number;
+    /**
+     * Sets new length value.
+     *
+     * Устанавливает новое значение длины.
+     * @param length new length value / новое значение длины
+     */
+    set(length: number): this;
+}

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

@@ -0,0 +1,104 @@
+import { Ref } from 'vue';
+import { MaskType } from './MaskType';
+import { MaskBuffer } from './MaskBuffer';
+import { MaskFocus } from './MaskFocus';
+import { MaskRubberTransition } from './MaskRubberTransition';
+import { MaskDate } from './MaskDate';
+import { MaskSpecial } from './MaskSpecial';
+import { MaskMatch } from './MaskMatch';
+import { MaskRubber } from './MaskRubber';
+import { MaskItem } from './MaskItem';
+import { MaskSelection } from './MaskSelection';
+import { MaskCharacter } from './MaskCharacter';
+import { MaskValueBasic } from './MaskValueBasic';
+import { MaskValue } from './MaskValue';
+import { MaskEmit } from './MaskEmit';
+import { MaskElementInput } from './basicTypes';
+/**
+ * Class for working with input behavior (data entering flow)
+ *
+ * Класс для работы с поведением при вводе данных
+ */
+export declare class MaskData {
+    protected readonly type: MaskType;
+    protected readonly buffer: MaskBuffer;
+    protected readonly focus: MaskFocus;
+    protected readonly rubberTransition: MaskRubberTransition;
+    protected readonly date: MaskDate;
+    protected readonly special: MaskSpecial;
+    protected readonly match: MaskMatch;
+    protected readonly rubber: MaskRubber;
+    protected readonly mask: MaskItem;
+    protected readonly selection: MaskSelection;
+    protected readonly character: MaskCharacter;
+    protected readonly valueBasic: MaskValueBasic;
+    protected readonly value: MaskValue;
+    protected readonly emit: MaskEmit;
+    protected readonly element: Ref<MaskElementInput>;
+    /**
+     * Constructor
+     * @param type object for working with the mask type/ объект для работы с типом маски
+     * @param buffer object for managing cached input data/ объект управления кешированными вводимыми данными
+     * @param focus object for handling input field focus/ объект для работы с фокусом поля ввода
+     * @param rubberTransition object for managing the transition character/ объект для управления символом перехода
+     * @param date object for working with date types/ объект для работы с типом даты
+     * @param special object for working with special characters/ объект для работы со специальными символами
+     * @param match object for managing the input character match logic/ объект для управления совпадением символов ввода
+     * @param rubber object for working with rubber types/ объект для работы с резиновыми типами
+     * @param mask object for managing masks/ объект управления маской
+     * @param selection object for managing caret position/ объект для управления положением курсора
+     * @param character object for managing entered characters/ объект для управления введёнными символами
+     * @param valueBasic object for working with base values/ объект для работы с базовыми значениями
+     * @param value object for working with transformed value/ объект для работы с преобразованным значением
+     * @param emit object for handling callback events/ объект для работы с событиями
+     * @param element input element ref/ ссылка на элемент ввода
+     */
+    constructor(type: MaskType, buffer: MaskBuffer, focus: MaskFocus, rubberTransition: MaskRubberTransition, date: MaskDate, special: MaskSpecial, match: MaskMatch, rubber: MaskRubber, mask: MaskItem, selection: MaskSelection, character: MaskCharacter, valueBasic: MaskValueBasic, value: MaskValue, emit: MaskEmit, element: Ref<MaskElementInput>);
+    /**
+     * Adds new characters entered by user
+     *
+     * Добавляет новые символы, вводимые пользователем
+     * @param selection selected key index/ индекс выделенного ключа
+     * @param chars list of characters (string or array)/ список вводимых символов
+     * @param focus is element focused/ элемент в фокусе ли
+     * @returns was value updated/ было ли обновлено значение
+     */
+    add(selection: number, chars: string | string[], focus?: boolean): boolean;
+    /**
+     * Removes (deletes) selected input characters
+     *
+     * Удаляет выделенные символы ввода
+     * @param start start selection index/ индекс начала выделения
+     * @param end end selection index/ индекс конца выделения
+     * @param focus is element focused/ элемент в фокусе ли
+     */
+    pop(start: number, end?: number, focus?: boolean): this;
+    /**
+     * Resets all values or applies provided value
+     *
+     * Сбрасывает все значения или применяет переданное
+     * @param value new raw value to apply/ новое значение для применения
+     */
+    reset(value?: string): this;
+    /**
+     * Removes redundant characters for paste operation
+     *
+     * Удаляет лишние символы при вставке
+     * @param chars characters to insert/ вставляемые символы
+     */
+    extra(chars: string[]): string[];
+    /**
+     * Restores caret (selection) position
+     *
+     * Восстанавливает позицию курсора (выделения)
+     * @param updateBuffer update from buffer first/ сначала обновить из буфера
+     */
+    goSelection(updateBuffer?: boolean): this;
+    /**
+     * Processes buffered data if present and emits events
+     *
+     * Обрабатывает данные из буфера (если есть) и вызывает события
+     * @returns was buffer consumed/ был ли использован буфер
+     */
+    protected goBuffer(): boolean;
+}

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

@@ -0,0 +1,67 @@
+import { Datetime } from '@dxtmisha/functional';
+import { MaskType } from './MaskType';
+import { FieldMasks, FieldPatternList } from '../../types/fieldTypes';
+import { MaskProps } from './props';
+import { ComputedRef } from 'vue';
+/**
+ * Class for working with date/time masks (date, datetime, time etc.).
+ *
+ * Класс для работы с масками даты/времени (date, datetime, time и т.п.).
+ */
+export declare class MaskDate {
+    protected readonly props: MaskProps;
+    protected readonly type: MaskType;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param type mask type helper/ объект помощник типа маски
+     */
+    constructor(props: MaskProps, type: MaskType);
+    /** Mask template for current date type / Шаблон маски для текущего типа даты */
+    readonly mask: ComputedRef<string[]>;
+    /**
+     * Returns base Datetime helper for given value (or default stub).
+     *
+     * Возвращает базовый помощник Datetime для значения (или дефолтный шаблон).
+     * @param date filled date string/ заполненная строка даты
+     */
+    getDatetime(date?: string): Datetime;
+    /**
+     * Returns localized formatted date/time value.
+     *
+     * Возвращает локализованное форматированное значение даты/времени.
+     * @param date filled date string/ заполненная строка даты
+     */
+    getValue(date?: string): string;
+    /**
+     * Returns standardized (ISO-like) date/time value or empty if invalid.
+     *
+     * Возвращает стандартизированное (похоже на ISO) значение или пустую строку при невалидности.
+     * @param date masks data grouped by parts/ данные масок, сгруппированные по частям
+     */
+    getValueStandard(date: FieldMasks): string;
+    /**
+     * Returns full raw date/time string assembled from groups (or empty if invalid).
+     *
+     * Возвращает полную «сырую» строку даты/времени, собранную из групп (или пусто если невалидно).
+     * @param date masks data grouped by parts/ данные масок, сгруппированные по частям
+     */
+    getValueStandardFull(date: FieldMasks): string;
+    /**
+     * Returns validation patterns object for date/time parts.
+     *
+     * Возвращает объект паттернов валидации для частей даты/времени.
+     */
+    getPattern(): FieldPatternList;
+    /** Returns list of date-only group symbols/ Возвращает список символов для даты */
+    getSpecialDate(): string[];
+    /** Returns list of full date-time group symbols/ Возвращает список символов для даты и времени */
+    getSpecialFull(): string[];
+    /**
+     * Returns display symbol for group.
+     *
+     * Возвращает отображаемый символ для группы.
+     * @param groupName group name/ название группы
+     */
+    getView(groupName: string): string | undefined;
+}

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

@@ -0,0 +1,60 @@
+import { VNode } from 'vue';
+import { ConstrOptions, ConstrStyles, DesignConstructorAbstract } from '@dxtmisha/functional';
+import { Mask } from './Mask';
+import { MaskPropsBasic } from './props';
+import { MaskClasses, MaskComponents, MaskEmits, MaskExpose, MaskSlots } from './types';
+/**
+ * MaskDesign
+ */
+export declare class MaskDesign<COMP extends MaskComponents, EXPOSE extends MaskExpose, CLASSES extends MaskClasses, P extends MaskPropsBasic> extends DesignConstructorAbstract<HTMLInputElement, COMP, MaskEmits, EXPOSE, MaskSlots, CLASSES, P> {
+    protected readonly item: Mask;
+    /**
+     * Constructor
+     * @param name class name/ название класса
+     * @param props properties/ свойства
+     * @param options list of additional parameters/ список дополнительных параметров
+     */
+    constructor(name: string, props: Readonly<P>, options?: ConstrOptions<COMP, MaskEmits, P>);
+    /**
+     * Initialization of all the necessary properties for work
+     *
+     * Инициализация всех необходимых свойств для работы.
+     */
+    protected initExpose(): EXPOSE;
+    /**
+     * Improvement of the obtained list of classes.
+     *
+     * Доработка полученного списка классов.
+     */
+    protected initClasses(): Partial<CLASSES>;
+    /**
+     * Refinement of the received list of styles.
+     *
+     * Доработка полученного списка стилей.
+     */
+    protected initStyles(): ConstrStyles;
+    /**
+     * A method for rendering.
+     *
+     * Метод для рендеринга.
+     */
+    protected initRender(): VNode;
+    /**
+     * Element for storing the final data.
+     *
+     * Элемент для хранения конечных данных.
+     */
+    protected renderData: () => VNode[];
+    /**
+     * Rendering method for input.
+     *
+     * Метод рендеринга для ввода.
+     */
+    protected renderInput: () => VNode[];
+    /**
+     * Rendering method for displaying the mask and the input data.
+     *
+     * Метод рендеринга для вывода маски и вводимых данных.
+     */
+    protected renderView: () => VNode[];
+}

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

@@ -0,0 +1,74 @@
+import { MaskValidation } from './MaskValidation';
+import { ConstrEmit } from '@dxtmisha/functional';
+import { MaskEmits } from './types';
+/**
+ * Class for event invocation
+ *
+ * Класс для вызова событий
+ */
+export declare class MaskEmit {
+    protected readonly validation: MaskValidation;
+    protected readonly emits?: ConstrEmit<MaskEmits> | undefined;
+    /** Current event type key/ Текущий ключ типа события */
+    protected type?: string & keyof MaskEmits;
+    /** Native event object/ Объект нативного события */
+    protected event?: Event;
+    /**
+     * Constructor
+     * @param validation object for working with validation/ объект для работы с валидацией
+     * @param emits emit function (Design system bridge)/ функция вызова события
+     */
+    constructor(validation: MaskValidation, emits?: ConstrEmit<MaskEmits> | undefined);
+    /**
+     * Checks whether extra data (validation) should be generated for current event
+     *
+     * Проверяет, нужно ли генерировать дополнительные данные (валидацию) для текущего события
+     */
+    isValue(): boolean;
+    /**
+     * Initializes event handling and emits event with optional validation payload
+     *
+     * Инициализирует обработку и вызывает событие с опциональной валидацией
+     */
+    go(): this;
+    /**
+     * Sets both event type and native event object
+     *
+     * Устанавливает одновременно тип события и объект события
+     * @param type event name/ название события
+     * @param event event object/ объект события
+     */
+    set<E extends Event>(type: string & keyof MaskEmits, event: E): this;
+    /**
+     * Sets event type
+     *
+     * Устанавливает тип события
+     * @param type event name/ название события
+     */
+    setType(type: string & keyof MaskEmits): this;
+    /**
+     * Sets native event object
+     *
+     * Устанавливает объект события
+     * @param event event object/ объект события
+     */
+    setEvent<E extends Event>(event: E): this;
+    /**
+     * Resets all internal state (type + event)
+     *
+     * Сбрасывает всё внутреннее состояние (тип и событие)
+     */
+    reset(): this;
+    /**
+     * Resets stored event type
+     *
+     * Сбрасывает сохранённый тип события
+     */
+    resetType(): this;
+    /**
+     * Resets stored native event
+     *
+     * Сбрасывает сохранённый объект события
+     */
+    resetEvent(): this;
+}