@dxtmisha/functional-basic 1.1.0 → 1.1.6

package/dist/classes/SearchListData.d.ts

@@ -0,0 +1,143 @@
+import { SearchListItem } from './SearchListItem';
+import { SearchListOptions } from './SearchListOptions';
+import { SearchCache, SearchCacheItem, SearchColumns, SearchFormatItem, SearchFormatList, SearchItem, SearchListValue } from '../types/searchTypes';
+/**
+ * Class for managing and formatting the search data list and its cache.
+ *
+ * Класс для управления и форматирования списка данных поиска и его кэша.
+ */
+export declare class SearchListData<T extends SearchItem, K extends SearchColumns<T>> {
+    protected list: SearchListValue<T>;
+    protected columns: K | undefined;
+    protected item: SearchListItem;
+    protected options: SearchListOptions;
+    protected listCache?: SearchCache<T>;
+    /**
+     * Constructor for SearchListData.
+     *
+     * Конструктор для SearchListData.
+     * @param list original list of items/ исходный список элементов
+     * @param columns columns to search in/ столбцы для поиска
+     * @param item current search item state/ текущее состояние элемента поиска
+     * @param options search options/ опции поиска
+     */
+    constructor(list: SearchListValue<T>, columns: K | undefined, item: SearchListItem, options: SearchListOptions);
+    /**
+     * Checks if both list and columns are provided.
+     *
+     * Проверяет, предоставлены ли и список, и столбцы.
+     * @returns boolean indicating if ready for column-based search/ логическое значение, указывающее на готовность к поиску по столбцам
+     */
+    is(): this is this & {
+        list: T[];
+        columns: string[];
+    };
+    /**
+     * Checks if the list is provided.
+     *
+     * Проверяет, предоставлен ли список.
+     * @returns boolean/ логическое значение
+     */
+    isList(): this is this & {
+        list: T[];
+    };
+    /**
+     * Returns the original list.
+     *
+     * Возвращает исходный список.
+     * @returns list value/ значение списка
+     */
+    getList(): SearchListValue<T>;
+    /**
+     * Returns the search columns.
+     *
+     * Возвращает столбцы поиска.
+     * @returns columns or undefined/ столбцы или undefined
+     */
+    getColumns(): K | undefined;
+    /**
+     * Gets the search cache, initializing it if necessary.
+     *
+     * Получает кэш поиска, инициализируя его при необходимости.
+     * @returns search cache/ кэш поиска
+     */
+    protected getCache(): SearchCache<T>;
+    /**
+     * Sets a new list and regenerates the cache.
+     *
+     * Устанавливает новый список и регенерирует кэш.
+     * @param list new list/ новый список
+     * @returns this instance/ данный экземпляр
+     */
+    setList(list: SearchListValue<T>): this;
+    /**
+     * Sets new search columns and regenerates the cache.
+     *
+     * Устанавливает новые столбцы поиска и регенерирует кэш.
+     * @param columns new columns/ новые столбцы
+     * @returns this instance/ данный экземпляр
+     */
+    setColumns(columns?: SearchColumns<T>): this;
+    /**
+     * Finds a cached item corresponding to the given original item.
+     *
+     * Находит кэшированный элемент, соответствующий данному исходному элементу.
+     * @param item original item/ исходный элемент
+     * @returns cache item or undefined/ кэшированный элемент или undefined
+     */
+    findCacheItem(item: T): SearchCacheItem<T> | undefined;
+    /**
+     * Iterates over the cached list and executes a callback for each item.
+     *
+     * Перебирает кэшированный список и выполняет обратный вызов для каждого элемента.
+     * @param callback function to execute for each item/ функция для выполнения для каждого элемента
+     * @returns formatted list/ отформатированный список
+     */
+    forEach(callback: (item: SearchCacheItem<T>['item'], value: SearchCacheItem<T>['value']) => SearchFormatItem<T, K> | undefined): SearchFormatList<T, K>;
+    /**
+     * Converts a single item to a formatted item with highlighted matches if selected.
+     *
+     * Преобразует один элемент в отформатированный элемент с выделенными совпадениями, если он выбран.
+     * @param item original item/ исходный элемент
+     * @param selection whether the item matches the search and should be highlighted/ совпадает ли элемент с поиском и должен ли он быть выделен
+     * @returns formatted item/ отформатированный элемент
+     */
+    toFormatItem(item: T, selection: boolean): SearchFormatItem<T, K>;
+    /**
+     * Formats a column path to a camelCase property name with a 'Search' suffix.
+     *
+     * Форматирует путь к столбцу в имя свойства camelCase с суффиксом 'Search'.
+     * @param column column path/ путь к столбцу
+     * @returns property name/ имя свойства
+     */
+    protected getColumnName(column: string): string;
+    /**
+     * Adds highlight tags to the given value based on the current search value.
+     *
+     * Добавляет теги выделения к данному значению на основе текущего значения поиска.
+     * @param value value to highlight/ значение для выделения
+     * @returns highlighted string/ выделенная строка
+     */
+    protected addTag(value: any): string;
+    /**
+     * Generates a search cache for the current list and columns.
+     *
+     * Генерирует кэш поиска для текущего списка и столбцов.
+     * @returns search cache/ кэш поиска
+     */
+    protected generateCache(): SearchCache<T>;
+    /**
+     * Initializes the search cache.
+     *
+     * Инициализирует кэш поиска.
+     * @returns void
+     */
+    protected initCache(): void;
+    /**
+     * Resets the search cache.
+     *
+     * Сбрасывает кэш поиска.
+     * @returns void
+     */
+    protected resetCache(): void;
+}

package/dist/classes/SearchListItem.d.ts

@@ -0,0 +1,49 @@
+import { SearchListOptions } from './SearchListOptions';
+/**
+ * Class representing a single search item's value and its search-related state.
+ *
+ * Класс, представляющий значение одного элемента поиска и его состояние, связанное с поиском.
+ */
+export declare class SearchListItem {
+    protected value: string | undefined;
+    protected options: SearchListOptions;
+    /**
+     * Constructor for SearchListItem.
+     *
+     * Конструктор для SearchListItem.
+     * @param value current search value/ текущее значение поиска
+     * @param options search options/ опции поиска
+     */
+    constructor(value: string | undefined, options: SearchListOptions);
+    /**
+     * Checks if the value is filled.
+     *
+     * Проверяет, заполнено ли значение.
+     * @returns boolean indicating if value exists/ логическое значение, указывающее на наличие значения
+     */
+    is(): this is this & {
+        value: string;
+    };
+    /**
+     * Checks if the value is filled and the length is greater than or equal to the limit.
+     *
+     * Проверяет, заполнено ли значение и длина больше или равна лимиту.
+     * @returns boolean/ логическое значение
+     */
+    isSearch(): boolean;
+    /**
+     * Returns the current search value as a string.
+     *
+     * Возвращает текущее значение поиска в виде строки.
+     * @returns search value/ значение поиска
+     */
+    get(): string;
+    /**
+     * Sets a new search value.
+     *
+     * Устанавливает новое значение поиска.
+     * @param value new search value/ новое значение поиска
+     * @returns this instance/ данный экземпляр
+     */
+    set(value?: string): this;
+}

package/dist/classes/SearchListMatcher.d.ts

@@ -0,0 +1,57 @@
+import { SearchListItem } from './SearchListItem';
+import { SearchListOptions } from './SearchListOptions';
+import { SearchCacheItem } from '../types/searchTypes';
+/**
+ * Class responsible for matching search values against the search list data using regular expressions.
+ *
+ * Класс, отвечающий за сопоставление значений поиска с данными списка поиска с использованием регулярных выражений.
+ */
+export declare class SearchListMatcher {
+    protected item: SearchListItem;
+    protected options: SearchListOptions;
+    protected matcher: RegExp | undefined;
+    /**
+     * Constructor for SearchListMatcher.
+     *
+     * Конструктор для SearchListMatcher.
+     * @param item search item containing the current value/ элемент поиска, содержащий текущее значение
+     * @param options search options/ опции поиска
+     */
+    constructor(item: SearchListItem, options: SearchListOptions);
+    /**
+     * Checks if the matcher is initialized.
+     *
+     * Проверяет, инициализирован ли сопоставитель.
+     * @returns boolean/ логическое значение
+     */
+    is(): boolean;
+    /**
+     * Checks if the given value matches the current search expression.
+     *
+     * Проверяет, соответствует ли данное значение текущему поисковому выражению.
+     * @param value value to check/ проверяемое значение
+     * @returns boolean indicating a match/ логическое значение, указывающее на совпадение
+     */
+    isSelection(value: SearchCacheItem<any>['value']): boolean;
+    /**
+     * Returns the current regular expression matcher.
+     *
+     * Возвращает текущий сопоставитель регулярных выражений.
+     * @returns RegExp or undefined/ RegExp или undefined
+     */
+    get(): RegExp | undefined;
+    /**
+     * Updates the matcher based on the current item value and options.
+     *
+     * Обновляет сопоставитель на основе текущего значения элемента и опций.
+     * @returns void
+     */
+    update(): void;
+    /**
+     * Initializes or resets the regular expression matcher.
+     *
+     * Инициализирует или сбрасывает сопоставитель регулярных выражений.
+     * @returns void
+     */
+    protected initMatcher(): void;
+}

package/dist/classes/SearchListOptions.d.ts

@@ -0,0 +1,66 @@
+import { SearchOptions } from '../types/searchTypes';
+/**
+ * Class for managing search list options.
+ *
+ * Класс для управления опциями списка поиска.
+ */
+export declare class SearchListOptions {
+    protected options?: SearchOptions | undefined;
+    /**
+     * Constructor for SearchListOptions.
+     *
+     * Конструктор для SearchListOptions.
+     * @param options search options/ опции поиска
+     */
+    constructor(options?: SearchOptions | undefined);
+    /**
+     * Returns the current search options.
+     *
+     * Возвращает текущие опции поиска.
+     * @returns search options/ опции поиска
+     */
+    getOptions(): SearchOptions;
+    /**
+     * Returns the minimum number of characters required to trigger a search.
+     *
+     * Возвращает минимальное количество символов, необходимых для запуска поиска.
+     * @returns limit value/ значение лимита
+     */
+    getLimit(): number;
+    /**
+     * Returns whether to return all items even if they don't match the search query.
+     *
+     * Возвращает, следует ли возвращать все элементы, даже если они не соответствуют поисковому запросу.
+     * @returns boolean value/ логическое значение
+     */
+    getReturnEverything(): boolean;
+    /**
+     * Returns the search delay in milliseconds.
+     *
+     * Возвращает задержку поиска в миллисекундах.
+     * @returns delay value/ значение задержки
+     */
+    getDelay(): number;
+    /**
+     * Returns whether to perform an exact match search.
+     *
+     * Возвращает, следует ли выполнять поиск с точным совпадением.
+     * @returns boolean value/ логическое значение
+     */
+    getFindExactMatch(): boolean;
+    /**
+     * Returns the CSS class name used for highlighting matches.
+     *
+     * Возвращает имя класса CSS, используемое для выделения совпадений.
+     * @returns class name/ имя класса
+     */
+    getClassName(): string;
+    /**
+     * Sets new search options.
+     *
+     * Устанавливает новые опции поиска.
+     * @param options search options/ опции поиска
+     * @returns this instance/ данный экземпляр
+     */
+    setOptions(options: SearchOptions): this;
+}

package/dist/classes/ServerStorage.d.ts

@@ -0,0 +1,106 @@
+/** Item stored in the server storage/ Элемент, хранящийся в серверном хранилище */
+type ServerStorageItem = {
+    value: any;
+    hydration: boolean;
+};
+type ServerStorageList = Record<string, ServerStorageItem>;
+/**
+ * Class for managing data storage during server-side rendering (SSR).
+ * Handles data isolation between parallel requests by using a request-specific context.
+ *
+ * Класс для управления хранением данных при серверном рендеринге (SSR).
+ * Обеспечивает изоляцию данных между параллельными запросами, используя контекст конкретного запроса.
+ */
+export declare class ServerStorage {
+    protected static storage?: ServerStorageList;
+    protected static listener?: () => Record<string, any> | undefined;
+    protected static hideError?: boolean;
+    /**
+     * Initializes the storage with a context listener.
+     *
+     * Инициализирует хранилище слушателем контекста.
+     * @param listener function that returns the current request context / функция, возвращающая контекст текущего запроса
+     * @returns this instance / текущий класс
+     */
+    static init(listener: () => Record<string, any> | undefined): typeof ServerStorage;
+    /**
+     * Resets the storage.
+     *
+     * Сбрасывает хранилище.
+     */
+    static reset(): void;
+    /**
+     * Checks if a value exists in storage.
+     *
+     * Проверяет наличие значения в хранилище.
+     * @param key unique storage key / уникальный ключ хранилища
+     * @returns boolean / логическое значение
+     */
+    static has(key: string): boolean;
+    /**
+     * Retrieves a value from storage. If it doesn't exist, creates it using the default value factory.
+     *
+     * Извлекает значение из хранилища. Если оно не существует, создает его с помощью фабрики значений по умолчанию.
+     * @param key unique storage key / уникальный ключ хранилища
+     * @param defaultValue function that returns the default value if not found / функция, возвращающая значение по умолчанию, если оно не найдено
+     * @param hydration whether the value should be included in hydration / должно ли значение быть включено в гидратацию
+     * @returns stored value / сохраненное значение
+     */
+    static get<T = any>(key: string, defaultValue?: () => T, hydration?: boolean): T;
+    /**
+     * Saves a value to storage.
+     *
+     * Сохраняет значение в хранилище.
+     * @param key unique storage key / уникальный ключ хранилища
+     * @param value function that returns the value to save / функция, возвращающая значение для сохранения
+     * @param hydration whether the value should be included in hydration / должно ли значение быть включено в гидратацию
+     * @returns saved value / сохраненное значение
+     */
+    static set<T = any>(key: string, value: () => T, hydration?: boolean): T;
+    /**
+     * Sets the visibility of error messages.
+     *
+     * Устанавливает видимость сообщений об ошибках.
+     * @param hide boolean value to hide or show errors / логическое значение для скрытия или отображения ошибок
+     */
+    static setErrorStatus(hide: boolean): void;
+    /**
+     * Removes a value from storage.
+     *
+     * Удаляет значение из хранилища.
+     * @param key unique storage key / уникальный ключ хранилища
+     */
+    static remove(key: string): void;
+    /**
+     * Returns a string representation of the storage for hydration.
+     *
+     * Возвращает строковое представление хранилища для гидратации.
+     * @returns script tag string / строка тега скрипта
+     */
+    static toString(): string;
+    /**
+     * Returns storage.
+     *
+     * Возвращает хранилище.
+     * @param isInit whether to initialize the storage if it does not exist /
+     * инициализировать ли хранилище, если оно не существует
+     * @param status optional status for error reporting / необязательный статус для отчета об ошибках
+     * @returns storage list / список хранилища
+     */
+    protected static getStorage(isInit?: boolean, status?: string): ServerStorageList;
+    /**
+     * Returns storage from DOM.
+     *
+     * Возвращает хранилище из DOM.
+     * @returns storage list from DOM / список хранилища из DOM
+     */
+    protected static getStorageDom(): ServerStorageList;
+    /**
+     * Returns data for hydration.
+     *
+     * Возвращает данные для гидратации.
+     * @returns record of hydration data / запись данных гидратации
+     */
+    protected static getDataForHydration(): Record<string, any>;
+}
+export {};

package/dist/classes/StorageCallback.d.ts

@@ -0,0 +1,84 @@
+/**
+ * A class for working with callback lists for storage.
+ *
+ * Класс для работы со списками обратных вызовов для хранилища.
+ */
+export declare class StorageCallback<T = any, Callback = (value: T) => void | Promise<void>> {
+    protected name: string;
+    protected group: string;
+    /**
+     * Returns an instance of the class by name.
+     *
+     * Возвращает экземпляр класса по названию.
+     * @param name storage name/ название хранилища
+     * @param group storage group/ группа хранилища
+     * @returns StorageCallback instance / экземпляр StorageCallback
+     */
+    static getInstance<T>(name: string, group?: string): StorageCallback<T, (value: T) => void | Promise<void>>;
+    protected callbacks: {
+        callback: Callback;
+        isOnce?: boolean;
+    }[];
+    protected loading: boolean;
+    /**
+     * Constructor for initialization.
+     *
+     * Конструктор для инициализации.
+     * @param name storage name/ название хранилища
+     * @param group storage group/ группа хранилища
+     */
+    constructor(name: string, group?: string);
+    /**
+     * Returns the loading state.
+     *
+     * Возвращает состояние загрузки.
+     * @returns loading state / состояние загрузки
+     */
+    isLoading(): boolean;
+    /**
+     * Returns the storage name.
+     *
+     * Возвращает название хранилища.
+     * @returns storage name / название хранилища
+     */
+    getName(): string;
+    /**
+     * Returns the loading state.
+     *
+     * Возвращает состояние загрузки.
+     * @returns loading state / состояние загрузки
+     */
+    getLoading(): boolean;
+    /**
+     * Adds a callback to the list.
+     *
+     * Добавляет обратный вызов в список.
+     * @param callback function for callbacks/ функция для обратных вызовов
+     * @param isOnce whether the callback should only be called once/ является ли колбэк одноразовым
+     * @returns this instance / текущий экземпляр
+     */
+    addCallback(callback: Callback, isOnce?: boolean): this;
+    /**
+     * Removes a callback from the list.
+     *
+     * Удаляет обратный вызов из списка.
+     * @param callback function for callbacks/ функция для обратных вызовов
+     * @returns this instance / текущий экземпляр
+     */
+    removeCallback(callback: Callback): this;
+    /**
+     * Preparation of data before launch.
+     *
+     * Подготовка данных перед запуском.
+     * @returns this instance / текущий экземпляр
+     */
+    preparation(): this;
+    /**
+     * Execution of all callbacks.
+     *
+     * Выполнение всех обратных вызовов.
+     * @param value storage data/ данные хранилища
+     * @returns this instance / текущий экземпляр
+     */
+    run(value: T): Promise<this>;
+}

package/dist/classes/Translate.d.ts

@@ -0,0 +1,119 @@
+import { TranslateInstance } from './TranslateInstance';
+import { TranslateCode, TranslateConfig, TranslateDataFile, TranslateList } from '../types/translateTypes';
+/**
+ * Class for getting the translated text.
+ *
+ * Класс для получения переведенного текста.
+ */
+export declare class Translate {
+    protected static item?: TranslateInstance;
+    /**
+     * Getting the translation text by its code.
+     *
+     * Получение текста перевода по его коду.
+     * @param name code name/ название кода
+     * @param replacement If set, replaces the text with the specified values/ если установлено, заменяет текст на указанные значения
+     * @returns translation text / текст перевода
+     */
+    static get(name: string, replacement?: string[] | Record<string, string | number>): Promise<string>;
+    /**
+     * Returns a request-isolated instance of TranslateInstance.
+     *
+     * Возвращает изолированный в рамках запроса экземпляр TranslateInstance.
+     * @returns TranslateInstance instance / экземпляр TranslateInstance
+     */
+    static getItem(): TranslateInstance;
+    /**
+     * Getting the translation text by its code (Sync).
+     *
+     * Получение текста перевода по его коду (Sync).
+     * @param name code name/ название кода
+     * @param first If set to false, returns an empty string if there is no text/
+     * если установлено false, возвращает пустую строку, если нет текста
+     * @param replacement If set, replaces the text with the specified values/
+     * если установлено, заменяет текст на указанные значения
+     * @returns translation text / текст перевода
+     */
+    static getSync(name: string, first?: boolean, replacement?: string[] | Record<string, string | number>): string;
+    /**
+     * Getting a list of translations by an array of text codes.
+     *
+     * Получение списка переводов по массиву кодов текста.
+     * @param names list of codes to get translations/ список кодов для получения переводов
+     * @returns object with translations / объект с переводами
+     */
+    static getList<T extends TranslateCode[]>(names: T): Promise<TranslateList<T>>;
+    /**
+     * Getting a list of translations by an array of text codes.
+     *
+     * Получение списка переводов по массиву кодов текста.
+     * @param names list of codes to get translations/ список кодов для получения переводов
+     * @param first If set to false, returns an empty string if there is no text/
+     * если установлено false, возвращает пустую строку, если нет текста
+     * @returns object with translations / объект с переводами
+     */
+    static getListSync<T extends TranslateCode[]>(names: T, first?: boolean): TranslateList<T>;
+    /**
+     * Added a list of translated texts.
+     *
+     * Добавлен список переведенных текстов.
+     * @param names list of codes to get translations/ список кодов для получения переводов
+     */
+    static add(names: string | string[]): Promise<void>;
+    /**
+     * Adds texts in sync mode.
+     *
+     * Добавляет тексты в режиме синхронизации.
+     * @param data list of texts in the form of key-value/ список текстов в виде ключ-значение
+     */
+    static addSync(data: Record<string, string>): void;
+    /**
+     * Adding data in the form of a query or directly, depending on the execution environment.
+     *
+     * Добавление данных в виде запроса или напрямую, в зависимости от среды выполнения.
+     * @param data list of texts in the form of key-value/ список текстов в виде ключ-значение
+     */
+    static addNormalOrSync(data: Record<string, string>): Promise<void>;
+    /**
+     * Adds texts synchronously by location.
+     *
+     * Добавляет тексты синхронно по местоположению.
+     * @param data list of texts by location/ список текстов по местоположению
+     */
+    static addSyncByLocation(data: Record<string, Record<string, string>>): void;
+    /**
+     * Adds texts synchronously from the file.
+     *
+     * Добавляет тексты синхронно из файла.
+     * @param data file with translations/ файл с переводами
+     */
+    static addSyncByFile(data: TranslateDataFile): void;
+    /**
+     * Change the path to the script for obtaining the translation.
+     *
+     * Изменить путь к скрипту для получения перевода.
+     * @param url path to the script/ путь к скрипту
+     */
+    static setUrl(url: string): void;
+    /**
+     * Change the name of the property to get the translation.
+     *
+     * Изменить имя свойства для получения перевода.
+     * @param name property name/ имя свойства
+     */
+    static setPropsName(name: string): void;
+    /**
+     * Change the read mode from the API.
+     *
+     * Изменить режим чтения из API.
+     * @param value read mode/ режим чтения
+     */
+    static setReadApi(value: boolean): void;
+    /**
+     * Set the configuration for the translation.
+     *
+     * Установить конфигурацию для перевода.
+     * @param config configuration/ конфигурация
+     */
+    static setConfig(config: TranslateConfig): void;
+}