@dxtmisha/constructor 0.23.0 → 0.39.3

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;
+}

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

@@ -0,0 +1,159 @@
+import { MaskBuffer } from './MaskBuffer';
+import { MaskFocus } from './MaskFocus';
+import { MaskCharacterLength } from './MaskCharacterLength';
+import { MaskRight } from './MaskRight';
+import { MaskSelection } from './MaskSelection';
+import { MaskValueBasic } from './MaskValueBasic';
+import { MaskEmit } from './MaskEmit';
+import { MaskData } from './MaskData';
+import { MaskEventSelection } from './basicTypes';
+/**
+ * Class for working with events.
+ *
+ * Класс для работы с событиями.
+ */
+export declare class MaskEvent {
+    protected readonly buffer: MaskBuffer;
+    protected readonly focus: MaskFocus;
+    protected readonly characterLength: MaskCharacterLength;
+    protected readonly right: MaskRight;
+    protected readonly selection: MaskSelection;
+    protected readonly valueBasic: MaskValueBasic;
+    protected readonly emit: MaskEmit;
+    protected readonly data: MaskData;
+    /** Change flag/ Флаг изменения */
+    protected change: boolean;
+    /** Unidentified selection data/ Данные неопознанного выделения */
+    protected unidentified?: MaskEventSelection;
+    /**
+     * Constructor
+     * @param buffer object for managing cached input data/ объект управления кешированными вводимыми данными
+     * @param focus object for handling input field focus/ объект для работы с фокусировкой поля ввода
+     * @param characterLength object for managing input length/ объект управления длиной ввода
+     * @param right object for right alignment/ объект для выравнивания направо
+     * @param selection object for managing cursor position/ объект для управления положением курсора
+     * @param valueBasic object for working with base values/ объект для работы с базовыми значениями
+     * @param emit object for handling callback events/ объект для работы с обратными событиями
+     * @param data object for managing input/ объект для управления вводом
+     */
+    constructor(buffer: MaskBuffer, focus: MaskFocus, characterLength: MaskCharacterLength, right: MaskRight, selection: MaskSelection, valueBasic: MaskValueBasic, emit: MaskEmit, data: MaskData);
+    /**
+     * Capture of the event in focus.
+     *
+     * Перехват события при получении фокуса.
+     * @param event event object/ объект события
+     */
+    readonly onFocus: (event: FocusEvent) => void;
+    /**
+     * Capture of the event when focus is lost.
+     *
+     * Перехват события при потере фокуса.
+     * @param event event object/ объект события
+     */
+    readonly onBlur: (event: FocusEvent) => void;
+    /**
+     * Intercepting key press to get a character.
+     *
+     * Перехват нажатия клавиши для получения символа.
+     * @param event invoked event/ вызываемое событие
+     */
+    readonly onKeydown: (event: KeyboardEvent) => void;
+    /**
+     * Intercept key release to check arrow presses.
+     *
+     * Перехват отпускания клавиши для проверки нажатия стрелок.
+     * @param event invoked event/ вызываемое событие
+     */
+    readonly onKeyup: (event: KeyboardEvent) => void;
+    /**
+     * Intercepting the event before data modification.
+     *
+     * Перехват события перед изменением данных.
+     * @param event invoked event/ вызываемое событие
+     */
+    readonly onBeforeinput: (event: InputEvent) => void;
+    /**
+     * Intercepting the event during data modification.
+     *
+     * Перехват события при изменении данных.
+     * @param event invoked event/ вызываемое событие
+     */
+    readonly onInput: (event: InputEvent) => void;
+    /**
+     * Intercept paste event for inserting data from clipboard.
+     *
+     * Перехват события вставки данных из буфера обмена.
+     * @param event invoked event/ вызываемое событие
+     */
+    readonly onPaste: (event: ClipboardEvent) => void;
+    /**
+     * Intercept change event (autocomplete support).
+     *
+     * Перехват события изменения (поддержка автозаполнения).
+     * @param event invoked event/ вызываемое событие
+     */
+    readonly onChange: (event: Event) => void;
+    /**
+     * Intercept click to adjust selection if needed.
+     *
+     * Перехват клика для корректировки выделения при необходимости.
+     * @param event invoked event/ вызываемое событие
+     */
+    readonly onClick: (event: MouseEvent) => void;
+    /**
+     * Was a meta button pressed.
+     *
+     * Была ли нажата мета-кнопка.
+     * @param event invoked event/ вызываемое событие
+     */
+    protected isMetaKey(event: KeyboardEvent): boolean;
+    /**
+     * Was a cut operation performed.
+     *
+     * Была ли выполнена операция вырезания.
+     * @param event invoked event/ вызываемое событие
+     */
+    protected isCut(event: KeyboardEvent): boolean;
+    /**
+     * Checks key value in the event.
+     *
+     * Проверяет значение key в событии.
+     * @param event invoked event/ вызываемое событие
+     */
+    protected isKey(event: KeyboardEvent): boolean;
+    /**
+     * Was there a selection.
+     *
+     * Было ли выделение.
+     * @param info selection data/ данные выделения
+     */
+    protected isSelection(info: MaskEventSelection): boolean;
+    /**
+     * Getting data about selection on the event element.
+     *
+     * Получение данных о выделении у элемента события.
+     * @param event invoked event/ вызываемое событие
+     */
+    protected getSelectionInfo(event: Event): MaskEventSelection;
+    /**
+     * Preparing to send an event.
+     *
+     * Подготовка для отправки события.
+     * @param event invoked event/ вызываемое событие
+     */
+    protected makeChange(event: Event): void;
+    /**
+     * Changes cursor position if alignment is right.
+     *
+     * Изменяет позицию курсора, если выравнивание справа.
+     * @param event invoked event/ вызываемое событие
+     */
+    protected makeToEnd(event: Event): void;
+    /**
+     * Check selection from the start (before special chars).
+     *
+     * Проверка выделения спереди (перед спецсимволами).
+     * @param event invoked event/ вызываемое событие
+     */
+    protected makeToStart(event: Event): void;
+}

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

@@ -0,0 +1,34 @@
+import { MaskBuffer } from './MaskBuffer';
+/**
+ * Class for storing element focus state.
+ *
+ * Класс для хранения состояния фокуса элемента.
+ */
+export declare class MaskFocus {
+    protected readonly buffer: MaskBuffer;
+    /** Focus state flag/ Флаг состояния фокуса */
+    protected value: boolean;
+    /**
+     * Constructor
+     * @param buffer buffer helper object/ объект помощник буфера
+     */
+    constructor(buffer: MaskBuffer);
+    /**
+     * Returns current focus state.
+     *
+     * Возвращает текущее состояние фокуса.
+     */
+    is(): boolean;
+    /**
+     * Sets focus state to active and resets buffer.
+     *
+     * Устанавливает состояние фокуса активным и сбрасывает буфер.
+     */
+    in(): void;
+    /**
+     * Removes focus state and resets buffer.
+     *
+     * Снимает состояние фокуса и сбрасывает буфер.
+     */
+    out(): void;
+}

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

@@ -0,0 +1,94 @@
+import { GeoIntl } from '@dxtmisha/functional';
+import { MaskType } from './MaskType';
+import { MaskRubberItem } from './MaskRubberItem';
+import { FieldMasks } from '../../types/fieldTypes';
+import { MaskSpecialList, MaskSpecialProp } from './basicTypes';
+import { MaskProps } from './props';
+import { ComputedRef } from 'vue';
+/**
+ * Class for working with formatted number / currency masks.
+ *
+ * Класс для работы с форматированными масками числа / валюты.
+ */
+export declare class MaskFormat {
+    protected readonly props: MaskProps;
+    protected readonly type: MaskType;
+    protected readonly rubberItem: MaskRubberItem;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param type mask type helper/ объект помощник типа маски
+     * @param rubberItem rubber groups helper/ объект помощник резиновых групп
+     */
+    constructor(props: MaskProps, type: MaskType, rubberItem: MaskRubberItem);
+    /** Special symbols configuration (groups) for numeric input / Конфигурация специальных символов (группы) для числового ввода */
+    readonly special: MaskSpecialProp;
+    /** Rubber mask instructions (dynamic length per group) / Инструкции резиновой маски (динамическая длина по группам) */
+    readonly rubber: ComputedRef<MaskSpecialList>;
+    /** Base view symbol per group / Базовый отображаемый символ для группы */
+    readonly view: ComputedRef<string>;
+    /** Fraction digits count / Количество знаков после запятой */
+    readonly fraction: ComputedRef<number>;
+    /** Returns mask characters for current numeric type / Возвращает символы маски для текущего числового типа */
+    readonly mask: ComputedRef<string[]>;
+    /**
+     * Is fraction part rubber (dynamic)?
+     *
+     * Является ли дробная часть резиновой (динамичной)?
+     */
+    isFractionRubber(): boolean;
+    /**
+     * Returns standardized raw numeric value (integer or integer.fraction).
+     *
+     * Возвращает стандартизированное «сырое» числовое значение (целое или целое.дробь).
+     * @param value masks data object/ объект масок
+     */
+    getValueStandard(value: FieldMasks): string;
+    /** Returns base number mask string.
+     *
+     * Возвращает строку маски числа.
+     */
+    getNumber(): string;
+    /**
+     * Returns formatted number mask string.
+     *
+     * Возвращает форматированную строку числа.
+     */
+    getNumberFormat(): string;
+    /**
+     * Returns currency mask string with appended currency symbol.
+     *
+     * Возвращает строку маски валюты с добавленным символом валюты.
+     */
+    getCurrency(): string;
+    /**
+     * Returns list of delimiter characters for switching to fraction part.
+     *
+     * Возвращает список символов-разделителей для перехода к дробной части.
+     */
+    getDecimal(): string[];
+    /**
+     * Returns list of special group keys.
+     *
+     * Возвращает список ключей групп специальных символов.
+     */
+    getSpecial(): string[];
+    /**
+     * Returns GeoIntl helper instance.
+     *
+     * Возвращает экземпляр помощника GeoIntl.
+     */
+    protected getIntl(): GeoIntl;
+    /**
+     * Builds base numeric pattern string (with optional fraction & currency).
+     *
+     * Формирует базовую строку числового паттерна (с необязательной дробью и валютой).
+     */
+    protected getNumberForString(): string;
+    /**
+     * Converts digit markers (9/3) to group symbols (n/f).
+     *
+     * Преобразует цифровые маркеры (9/3) в групповые символы (n/f).
+     */
+    protected toSpecial(mask: string): string[];
+}