@dxtmisha/constructor 0.23.0 → 0.39.3

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

@@ -0,0 +1,93 @@
+import { MaskType } from './MaskType';
+import { MaskDate } from './MaskDate';
+import { MaskFormat } from './MaskFormat';
+import { FieldPatternItemOrFunction } from '../../types/fieldTypes';
+import { MaskMatchItem, MaskSpecialItem, MaskSpecialList, MaskSpecialProp } from './basicTypes';
+import { MaskProps } from './props';
+import { ComputedRef } from 'vue';
+/**
+ * Class for working with groups defined by special symbols.
+ *
+ * Класс для работы с группами, определёнными специальными символами.
+ */
+export declare class MaskSpecial {
+    protected readonly props: MaskProps;
+    protected readonly type: MaskType;
+    protected readonly date: MaskDate;
+    protected readonly format: MaskFormat;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param type mask type helper/ объект помощник типа маски
+     * @param date date mask helper/ объект помощник маски даты
+     * @param format numeric/currency mask helper/ объект помощник числовых масок
+     */
+    constructor(props: MaskProps, type: MaskType, date: MaskDate, format: MaskFormat);
+    /**
+     * Returns list of special symbols.
+     *
+     * Возвращает список специальных символов.
+     */
+    readonly item: ComputedRef<string[]>;
+    /**
+     * Returns map of only rubber-enabled groups.
+     *
+     * Возвращает карту только резиновых групп.
+     */
+    readonly rubberList: ComputedRef<MaskSpecialList>;
+    /**
+     * Checks if symbol is special.
+     *
+     * Проверяет, является ли символ специальным.
+     * @param char symbol to check/ символ для проверки
+     */
+    isSpecial(char: string): boolean;
+    /**
+     * Checks if group has default value.
+     *
+     * Проверяет, имеет ли группа значение по умолчанию.
+     * @param groupName group name/ название группы
+     */
+    isDefault(groupName: string): boolean;
+    /**
+     * Returns default value for group.
+     *
+     * Возвращает значение по умолчанию для группы.
+     * @param groupName group name/ название группы
+     */
+    getDefault(groupName: string): MaskMatchItem | undefined;
+    /**
+     * Returns matcher (regexp/string) for group.
+     *
+     * Возвращает выражение для проверки группы.
+     * @param groupName group name/ название группы
+     */
+    getMatch(groupName: string): MaskMatchItem | undefined;
+    /**
+     * Returns pattern definition for group.
+     *
+     * Возвращает pattern для группы.
+     * @param groupName group name/ название группы
+     */
+    getPattern(groupName: string): FieldPatternItemOrFunction | undefined;
+    /**
+     * Returns view (display character) for group.
+     *
+     * Возвращает отображаемый символ для группы.
+     * @param groupName group name/ название группы
+     */
+    getView(groupName: string): string | undefined;
+    /**
+     * Returns special property (original definition).
+     *
+     * Возвращает свойство special (оригинальное определение).
+     */
+    protected readonly special: ComputedRef<MaskSpecialProp>;
+    /**
+     * Returns special group item data by name.
+     *
+     * Возвращает данные группы special по имени.
+     * @param groupName group name/ название группы
+     */
+    protected getSpecialItem(groupName: string): MaskSpecialItem | undefined;
+}

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

@@ -0,0 +1,61 @@
+import { GeoDate } from '@dxtmisha/functional';
+import { MaskTypeItem } from './basicTypes';
+import { MaskProps } from './props';
+import { ComputedRef } from 'vue';
+/**
+ * Class for defining the mask type.
+ *
+ * Класс для определения типа маски.
+ */
+export declare class MaskType {
+    protected readonly props: MaskProps;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     */
+    constructor(props: MaskProps);
+    /** Current mask type (default: text)/ Текущий тип маски (по умолчанию: text) */
+    readonly item: ComputedRef<MaskTypeItem>;
+    /**
+     * Is the mask simple number type.
+     *
+     * Является ли маска простым числовым типом (number).
+     */
+    isNumber(): boolean;
+    /**
+     * Is the mask formatted number type (number-format).
+     *
+     * Является ли маска типом форматированного числа (number-format).
+     */
+    isNumberFormat(): boolean;
+    /**
+     * Is the mask currency type.
+     *
+     * Является ли маска валютным типом (currency).
+     */
+    isCurrency(): boolean;
+    /**
+     * Is the mask one of numeric related types (number | number-format | currency).
+     *
+     * Является ли маска одним из числовых типов (number | number-format | currency).
+     */
+    isCurrencyOrNumber(): boolean;
+    /**
+     * Is the mask one of the time input types.
+     *
+     * Является ли маска одним из типов для ввода времени.
+     */
+    isTime(): boolean;
+    /**
+     * Is the mask one of the date (or time) input types.
+     *
+     * Является ли маска одним из типов для ввода даты (или времени).
+     */
+    isDate(): boolean;
+    /**
+     * Returns GeoDate-compatible mask type (fallback: date).
+     *
+     * Возвращает тип маски совместимый с GeoDate (если нет — date).
+     */
+    getByDate(): GeoDate;
+}

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

@@ -0,0 +1,40 @@
+import { MaskPattern } from './MaskPattern';
+import { MaskValue } from './MaskValue';
+import { FieldValidationItem } from '../../types/fieldTypes';
+import { ComputedRef } from 'vue';
+/**
+ * Class for working with the validity of entered data.
+ *
+ * Класс для работы с валидностью введённых данных.
+ */
+export declare class MaskValidation {
+    protected readonly pattern: MaskPattern;
+    protected readonly value: MaskValue;
+    /**
+     * Constructor
+     * @param pattern object for working with input data validation/ объект для работы с проверкой введённых данных
+     * @param value object for working with entered data/ объект для работы с введёнными данными
+     */
+    constructor(pattern: MaskPattern, value: MaskValue);
+    /** Validation error info or undefined/ Информация об ошибке или undefined */
+    readonly item: ComputedRef<FieldValidationItem>;
+    /**
+     * Checks if the current group has an error.
+     *
+     * Проверяет, есть ли ошибка у текущей группы.
+     * @param groupName group name/ название группы
+     */
+    isError(groupName: string): boolean;
+    /**
+     * Checks the correctness of filling in the values.
+     *
+     * Проверяет корректность заполнения значений.
+     */
+    checkValidity(): boolean;
+    /**
+     * Getting global check data.
+     *
+     * Получение данных глобальной проверки.
+     */
+    protected getValidationCheck(): FieldValidationItem;
+}

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

@@ -0,0 +1,89 @@
+import { MaskType } from './MaskType';
+import { MaskDate } from './MaskDate';
+import { MaskFormat } from './MaskFormat';
+import { MaskItem } from './MaskItem';
+import { MaskSpecial } from './MaskSpecial';
+import { MaskValueBasic } from './MaskValueBasic';
+import { FieldMaskItem, FieldMasks } from '../../types/fieldTypes';
+import { MaskProps } from './props';
+import { ComputedRef } from 'vue';
+/**
+ * Class for transforming the entered data into the final result.
+ *
+ * Класс для преобразования введенных данных в конечный результат.
+ */
+export declare class MaskValue {
+    protected readonly props: MaskProps;
+    protected readonly type: MaskType;
+    protected readonly date: MaskDate;
+    protected readonly format: MaskFormat;
+    protected readonly mask: MaskItem;
+    protected readonly special: MaskSpecial;
+    protected readonly valueBasic: MaskValueBasic;
+    protected infoCache?: FieldMasks;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param type object for working with the mask type/ объект для работы с типом маски
+     * @param date object for working with date types/ объект для работы с типом даты
+     * @param format object for managing numeric mask types/ объект для управления числовыми типами масок
+     * @param mask object for managing masks/ объект управления маской
+     * @param special object for working with special characters/ объект для работы со специальными символами
+     * @param valueBasic object for working with base values/ объект для работы с базовыми значениями
+     */
+    constructor(props: MaskProps, type: MaskType, date: MaskDate, format: MaskFormat, mask: MaskItem, special: MaskSpecial, valueBasic: MaskValueBasic);
+    /**
+     * Receiving a list with information about standard values/
+     * Получение списка с информацией о стандартных значениях
+     */
+    readonly info: ComputedRef<FieldMasks>;
+    /** Final value (shortcut)/ Финальное значение (ярлык) */
+    readonly item: ComputedRef<string>;
+    /** Checks if the mask is fully filled/ Проверяет, полностью ли заполнена маска */
+    readonly isFull: ComputedRef<boolean>;
+    /** Checks if the mask is fully filled by length/ Проверяет, полностью ли заполнена маска по длине */
+    readonly isEnd: ComputedRef<boolean>;
+    /**
+     * Returns old values.
+     *
+     * Возвращает старые значения.
+     */
+    getValueCache(): string;
+    /**
+     * Getting full information for global verification.
+     *
+     * Получение полной информации для глобальной проверки.
+     */
+    getForCheck(): FieldMaskItem;
+    /**
+     * Getting information for a specific group.
+     *
+     * Получение информации для конкретной группы.
+     * @param groupName group name/ название группы
+     */
+    getInfoItem(groupName: string): FieldMaskItem | undefined;
+    /** Returns the final form of the value/ Возвращает финальный вид значения */
+    protected readonly valueFinal: ComputedRef<string>;
+    /**
+     * Checks if there is a value by the key number in the basic values.
+     *
+     * Проверяет, есть ли значение по номеру ключа в базовых значениях.
+     * @param index key number/ номер ключа
+     */
+    protected isStandard(index: number): boolean;
+    /**
+     * Returns values based on the specified data information structure.
+     *
+     * Возвращает значения по указанной структуре информации о данных.
+     * @param info data information/ информация о данных
+     */
+    protected getValue(info: FieldMasks): string;
+    /**
+     * Adding a new character to the list divided by groups if it is not there and returning the property of the given group.
+     *
+     * Добавление нового символа в список, разделенный по группам, если его там нет, и возвращение свойства данной группы.
+     * @param data data for verification/ данные для проверки
+     * @param groupName group name/ название группы
+     */
+    protected add(data: FieldMasks, groupName: string): FieldMaskItem;
+}

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

@@ -0,0 +1,49 @@
+import { MaskRubberTransition } from './MaskRubberTransition';
+import { MaskItem } from './MaskItem';
+import { MaskSpecial } from './MaskSpecial';
+import { MaskCharacter } from './MaskCharacter';
+import { ComputedRef } from 'vue';
+/**
+ * Class for getting basic input values.
+ *
+ * Класс для получения базовых вводимых значений.
+ */
+export declare class MaskValueBasic {
+    protected readonly rubberTransition: MaskRubberTransition;
+    protected readonly mask: MaskItem;
+    protected readonly special: MaskSpecial;
+    protected readonly character: MaskCharacter;
+    /**
+     * Constructor
+     * @param rubberTransition object for managing the transition character/ объект для управления символом перехода
+     * @param mask object for managing masks/ объект управления маской
+     * @param special object for working with special characters/ объект для работы со специальными символами
+     * @param character object for managing entered character/ объект для управления введённым символом
+     */
+    constructor(rubberTransition: MaskRubberTransition, mask: MaskItem, special: MaskSpecial, character: MaskCharacter);
+    /**
+     * Receiving basic standard values.
+     *
+     * Получение базовых стандартных значений.
+     */
+    readonly item: ComputedRef<string>;
+    /**
+     * Checks if the values are filled in.
+     *
+     * Проверяет, заполнены ли значения.
+     */
+    is(): boolean;
+    /**
+     * Getting the character from the basic standard values by its key number.
+     *
+     * Получение символа из базовых стандартных значений по его номеру ключа.
+     * @param index key number/ номер ключа
+     */
+    getChar(index: number): string | undefined;
+    /**
+     * Getting the length of basic standard values.
+     *
+     * Получение длины базовых стандартных значений.
+     */
+    getLength(): number;
+}

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

@@ -0,0 +1,84 @@
+import { MaskType } from './MaskType';
+import { MaskDate } from './MaskDate';
+import { MaskFormat } from './MaskFormat';
+import { MaskSpecial } from './MaskSpecial';
+import { MaskRubber } from './MaskRubber';
+import { MaskItem } from './MaskItem';
+import { MaskValueBasic } from './MaskValueBasic';
+import { MaskValidation } from './MaskValidation';
+import { MaskViewList } from './basicTypes';
+import { MaskProps } from './props';
+import { ComputedRef } from 'vue';
+/**
+ * Class for working with data to output to the screen.
+ *
+ * Класс для работы с данными для вывода на экран.
+ */
+export declare class MaskView {
+    protected readonly props: MaskProps;
+    protected readonly type: MaskType;
+    protected readonly date: MaskDate;
+    protected readonly format: MaskFormat;
+    protected readonly special: MaskSpecial;
+    protected readonly rubber: MaskRubber;
+    protected readonly mask: MaskItem;
+    protected readonly valueBasic: MaskValueBasic;
+    protected readonly validation: MaskValidation;
+    /** Class name prefix for item/ Класс для элемента */
+    protected classNameItem: string;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param type object for working with the mask type/ объект для работы с типом маски
+     * @param date object for working with date types/ объект для работы с типом даты
+     * @param format object for managing numeric mask types/ объект для управления числовыми типами масок
+     * @param special object for working with special characters/ объект для работы со специальными символами
+     * @param rubber object for working with rubber types/ объект для работы с резиновыми типами
+     * @param mask object for managing masks/ объект управления маской
+     * @param valueBasic object for working with base values/ объект для работы с базовыми значениями
+     * @param validation object for working with validation/ объект для работы с валидацией
+     * @param className define class names for each symbol/ определить название класса для каждого символа
+     */
+    constructor(props: MaskProps, type: MaskType, date: MaskDate, format: MaskFormat, special: MaskSpecial, rubber: MaskRubber, mask: MaskItem, valueBasic: MaskValueBasic, validation: MaskValidation, className: string);
+    /** View items list/ Список данных для отображения */
+    readonly item: ComputedRef<MaskViewList>;
+    /** Input value with special view characters/ Значение ввода со спецсимволами отображения */
+    readonly input: ComputedRef<string>;
+    /**
+     * Checks if the value is filled in.
+     *
+     * Проверяет, заполнено ли значение.
+     * @param value checked value/ проверяемое значение
+     */
+    protected isValue(value?: string): value is string;
+    /**
+     * Returns the status by mask symbol and its position.
+     *
+     * Возвращает статус по символу маски и месту его расположения.
+     * @param char mask symbol/ символ маски
+     * @param value entered value for this position/ введённое значение для позиции
+     */
+    protected getStatus(char: string, value?: string): string;
+    /**
+     * Returns symbol for rendering: real value or placeholder.
+     *
+     * Возвращает символ для отображения: реальное значение или плейсхолдер.
+     * @param char mask symbol/ символ маски
+     * @param value entered value for position/ введённое значение позиции
+     */
+    protected getValue(char: string, value?: string): string;
+    /**
+     * Returns display version of special mask symbol (placeholder).
+     *
+     * Возвращает отображаемую версию специального символа маски (плейсхолдер).
+     * @param char mask symbol/ символ маски
+     */
+    protected getSpecialToView(char: string): string;
+    /**
+     * Returns special character for view by its group name.
+     *
+     * Возвращает специальный символ для отображения по имени группы.
+     * @param groupName group name/ имя группы
+     */
+    protected getViewChar(groupName: string): string | undefined;
+}

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

@@ -0,0 +1,52 @@
+import { ConstrBind, GeoDate } from '@dxtmisha/functional';
+import { FieldPatternItemOrFunction, FieldValidationItem } from '../../types/fieldTypes';
+import { MaskPropsBasic } from './props';
+export type MaskTypeItem = GeoDate | 'text' | 'number' | 'number-format' | 'currency';
+export type MaskElementInput = HTMLInputElement | undefined;
+export type MaskMatchItem = RegExp | string;
+export type MaskFractionItem = string | boolean | number;
+export type MaskSpecialItem = {
+    defaultValue?: string;
+    rubber?: boolean;
+    transitionChar?: string | string[];
+    minLength?: number;
+    maxLength?: number;
+    match?: MaskMatchItem;
+    pattern?: FieldPatternItemOrFunction;
+    view?: string;
+};
+export type MaskSpecialInfo = {
+    index: number;
+    key: number;
+    char: string;
+};
+export type MaskSpecialList = Record<string, MaskSpecialItem>;
+export type MaskSpecialProp = string | string[] | MaskSpecialList;
+export type MaskViewItem = {
+    className: string;
+    value: string;
+};
+export type MaskViewList = MaskViewItem[];
+export type MaskList = string | string[];
+export type MaskEventData = FieldValidationItem;
+export type MaskEventSelection = {
+    target: HTMLInputElement;
+    start: number;
+    end: number;
+    length: number;
+};
+export type MaskComponentInclude = {
+    mask?: object;
+};
+export type MaskPropsInclude<Mask extends MaskPropsBasic = MaskPropsBasic> = {
+    name?: string;
+    mask?: string | ConstrBind<Mask>;
+    maskVisible?: boolean;
+    maskNone?: boolean;
+    currency?: string;
+    currencyHide?: boolean;
+    fraction?: MaskFractionItem;
+    maskAttrs?: ConstrBind<Mask>;
+};
+export declare const MASK_CHAR_DELETE = "~";
+export declare const MASK_VIEW_DEFAULT = "_";

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

@@ -0,0 +1,5 @@
+export * from './Mask';
+export * from './MaskDesign';
+export * from './props';
+export * from './types';
+export * from './basicTypes';

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

@@ -0,0 +1,48 @@
+import { FieldPatternItemOrFunction } from '../../types/fieldTypes';
+import { MaskFractionItem, MaskList, MaskMatchItem, MaskSpecialProp, MaskTypeItem } from './basicTypes';
+interface MaskPropsToken {
+    visible?: boolean;
+    visiblePartly?: boolean;
+    align?: 'center' | 'left' | 'right';
+    dir?: 'ltr' | 'rtl';
+}
+export interface MaskPropsBasic {
+    name?: string;
+    value?: string | number;
+    valueDefault?: string | number;
+    currency?: string;
+    currencyHide?: boolean;
+    fullOnly?: boolean;
+    mask?: MaskList;
+    special?: MaskSpecialProp;
+    match?: MaskMatchItem;
+    groupSave?: boolean;
+    pattern?: FieldPatternItemOrFunction;
+    check?: FieldPatternItemOrFunction;
+    fraction?: MaskFractionItem;
+    type?: MaskTypeItem;
+    view?: string;
+    inputAttrs?: Partial<HTMLInputElement>;
+    language?: string;
+}
+/**
+ * Type describing incoming properties.
+ *
+ * Тип, описывающий входящие свойства.
+ */
+export interface MaskProps extends MaskPropsBasic, MaskPropsToken {
+}
+/**
+ * Default value for property.
+ *
+ * Значение по умолчанию для свойства.
+ */
+export declare const defaultsMask: {
+    visible: boolean;
+    special: string;
+    match: RegExp;
+    type: string;
+    groupSave: boolean;
+    view: string;
+};
+export {};

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

@@ -0,0 +1,62 @@
+import { ComputedRef } from 'vue';
+import { ConstrClass } from '@dxtmisha/functional';
+import { FieldValidationItem } from '../../types/fieldTypes';
+/**
+ * Interface for describing which components need to be connected for work.
+ *
+ * Интерфейс для описания, какие компоненты надо подключить для работы.
+ */
+export type MaskComponents = {};
+/**
+ * Type describing available events.
+ *
+ * Тип, описывающий доступные события.
+ */
+export type MaskEmits = {
+    focus: [event: FocusEvent];
+    blur: [event: FocusEvent];
+    keydown: [event: KeyboardEvent];
+    keyup: [event: KeyboardEvent];
+    beforeinput: [event: InputEvent];
+    input: [
+        event: InputEvent,
+        value: FieldValidationItem
+    ];
+    inputLite: [value: FieldValidationItem];
+    change: [
+        event: InputEvent,
+        value: FieldValidationItem
+    ];
+    changeLite: [value: FieldValidationItem];
+    paste: [event: ClipboardEvent];
+    reset: [event: Event];
+};
+/**
+ * Type describing available properties.
+ *
+ * Тип, описывающий доступные свойства.
+ */
+export interface MaskExpose {
+    valueBasic: ComputedRef<string>;
+    value: ComputedRef<string>;
+    setValue(value: string): boolean;
+    clear(): boolean;
+}
+/**
+ * Type describing available slots.
+ *
+ * Тип, описывающий доступные слоты.
+ */
+export interface MaskSlots {
+}
+/**
+ * Type describing subclasses.
+ *
+ * Тип, описывающий подклассы.
+ */
+export type MaskClasses = {
+    main: ConstrClass;
+    input: string;
+    character: string;
+    characterItem: string;
+};