@dxtmisha/functional-basic 1.1.5 → 1.1.6

package/dist/classes/BroadcastMessage.d.ts

@@ -0,0 +1,75 @@
+import { ErrorCenterInstance } from './ErrorCenterInstance';
+/**
+ * Class for working with BroadcastChannel messages.
+ *
+ * Класс для работы с сообщениями BroadcastChannel.
+ */
+export declare class BroadcastMessage<Message = any> {
+    protected callback?: ((event: MessageEvent<Message>) => void) | undefined;
+    protected callbackError?: ((event: MessageEvent<Message>) => void) | undefined;
+    protected channel?: BroadcastChannel;
+    /**
+     * Constructor that initializes the broadcast channel with event handlers.
+     *
+     * Конструктор, инициализирующий канал вещания с обработчиками событий.
+     * @param name unique identifier for the broadcast channel / уникальный идентификатор для канала вещания
+     * @param callback function called when a message is received / функция, вызываемая при получении сообщения
+     * @param callbackError function called when a message error occurs / функция, вызываемая при возникновении ошибки сообщения
+     * @param errorCenter ErrorCenter instance for error reporting / экземпляр ErrorCenter для отчета об ошибках
+     */
+    constructor(name: string, callback?: ((event: MessageEvent<Message>) => void) | undefined, callbackError?: ((event: MessageEvent<Message>) => void) | undefined, errorCenter?: ErrorCenterInstance);
+    /**
+     * Gets the BroadcastChannel instance if available.
+     *
+     * Получает экземпляр BroadcastChannel, если он доступен.
+     * @returns BroadcastChannel instance or undefined if not in DOM runtime / экземпляр BroadcastChannel или undefined, если не в среде DOM
+     */
+    getChannel(): BroadcastChannel | undefined;
+    /**
+     * Sends a message through the broadcast channel.
+     *
+     * Отправляет сообщение через канал вещания.
+     * @param message message data to send / данные сообщения для отправки
+     * @returns this instance for chaining / этот экземпляр для цепочки вызовов
+     */
+    post(message: Message): this;
+    /**
+     * Sets the callback function to be executed when a message is received.
+     *
+     * Устанавливает функцию обратного вызова, выполняемую при получении сообщения.
+     * @param callback function to execute on message received / функция для выполнения при получении сообщения
+     * @returns this instance for chaining / этот экземпляр для цепочки вызовов
+     */
+    setCallback(callback: (event: MessageEvent<Message>) => void): this;
+    /**
+     * Sets the error callback function to be executed when a message error occurs.
+     *
+     * Устанавливает функцию обратного вызова для обработки ошибок сообщений.
+     * @param callbackError function to execute on message error / функция для выполнения при ошибке сообщения
+     * @returns this instance for chaining / этот экземпляр для цепочки вызовов
+     */
+    setCallbackError(callbackError: (event: MessageEvent<Message>) => void): this;
+    /**
+     * Closes the broadcast channel and stops listening for messages.
+     *
+     * Закрывает канал вещания и прекращает прослушивание сообщений.
+     * @returns this instance for chaining / этот экземпляр для цепочки вызовов
+     */
+    destroy(): this;
+    /**
+     * Updates state when a message is received.
+     *
+     * Обновляет состояние при получении сообщения.
+     * @param event message event object / объект события сообщения
+     * @returns this instance for chaining / этот экземпляр для цепочки вызовов
+     */
+    protected readonly update: (event: MessageEvent<Message>) => this;
+    /**
+     * Updates error state when a message error occurs.
+     *
+     * Обновляет состояние ошибки при возникновении ошибки сообщения.
+     * @param event message error event object / объект события ошибки сообщения
+     * @returns this instance for chaining / этот экземпляр для цепочки вызовов
+     */
+    protected readonly updateError: (event: MessageEvent<Message>) => this;
+}

package/dist/classes/Cache.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Simple in-memory cache class that stores computed values by key.
+ *
+ * Простой класс для in-memory кэширования, который хранит вычисленные значения по ключу.
+ * @deprecated This class is obsolete and should not be used / Этот класс устарел и не рекомендуется к использованию
+ */
+export declare class Cache {
+    private cache;
+    /**
+     * Returns a cached value for the given name. If not cached, executes the callback and stores the result.
+     *
+     * Возвращает кэшированное значение для указанного имени. Если нет кэша, выполняет callback и сохраняет результат.
+     * @param name Unique cache key / Уникальный ключ кэша
+     * @param callback Function to compute the value if not cached / Функция для вычисления значения, если его нет в кэше
+     * @param comparison Optional array for cache invalidation. If provided, the cache is invalidated when any element changes / Опциональный массив для инвалидации кэша. Если предоставлен, кэш сбрасывается при изменении любого элемента
+     * @returns The cached or newly computed value / Кэшированное или новое вычисленное значение
+     */
+    get<T>(name: string, callback: () => T, comparison?: any[]): T;
+    /**
+     * Asynchronously returns a cached value for the given name. If not cached, executes the callback and stores the result.
+     *
+     * Асинхронно возвращает кэшированное значение для указанного имени. Если нет кэша, выполняет callback и сохраняет результат.
+     * @param name Unique cache key / Уникальный ключ кэша
+     * @param callback Async function to compute the value if not cached / Асинхронная или синхронная функция для вычисления значения, если его нет в кэше
+     * @param comparison Optional array for cache invalidation. If provided, the cache is invalidated when any element changes / Опциональный массив для инвалидации кэша. Если предоставлен, кэш сбрасывается при изменении любого элемента
+     * @returns Promise resolving to the cached or newly computed value / Promise, разрешающийся в кэшированное или новое вычисленное значение
+     */
+    getAsync<T>(name: string, callback: () => T, comparison?: any[]): Promise<T>;
+    /**
+     * Gets or creates a CacheItem instance for the given name.
+     *
+     * Получает или создает экземпляр CacheItem для указанного имени.
+     * @param name - Unique cache key / Уникальный ключ кэша
+     * @param callback - Function to compute the value / Функция для вычисления значения
+     * @returns CacheItem instance for the cache key / Экземпляр CacheItem для ключа кэша
+     */
+    private getCacheItem;
+}

package/dist/classes/CacheItem.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Class for managing a single cached value with dependency tracking.
+ *
+ * Класс для управления одним кэшированным значением с отслеживанием зависимостей.
+ * @deprecated This class is obsolete and should not be used / Этот класс устарел и не рекомендуется к использованию
+ */
+export declare class CacheItem<T> {
+    private readonly callback;
+    private cache?;
+    private cacheOld?;
+    private comparisons;
+    /**
+     * Creates a new CacheItem instance.
+     *
+     * Создает новый экземпляр CacheItem.
+     * @param callback - Function to compute the cached value / Функция для вычисления кэшированного значения
+     */
+    constructor(callback: () => T);
+    /**
+     * Returns the cached value. Recomputes if the comparison array has changed.
+     *
+     * Возвращает кэшированное значение. Пересчитывает, если массив comparison изменился.
+     * @param comparison - Array of values to track for cache invalidation / Массив значений для отслеживания инвалидации кэша
+     * @returns The cached or newly computed value / Кэшированное или новое вычисленное значение
+     */
+    getCache(comparison: any[]): T;
+    /**
+     * Returns the previous cached value before the last recalculation.
+     *
+     * Возвращает предыдущее кэшированное значение до последнего пересчета.
+     * @returns The previous cached value, or undefined if no recalculation has occurred / Предыдущее кэшированное значение, или undefined если пересчет не происходил
+     */
+    getCacheOld(): T | undefined;
+    /**
+     * Asynchronously returns the cached value. Recomputes if the comparison array has changed.
+     *
+     * Асинхронно возвращает кэшированное значение. Пересчитывает, если массив comparison изменился.
+     * @param comparison - Array of values to track for cache invalidation / Массив значений для отслеживания инвалидации кэша
+     * @returns Promise resolving to the cached or newly computed value / Promise, разрешающийся в кэшированное или новое вычисленное значение
+     */
+    getCacheAsync(comparison: any[]): Promise<T>;
+    /**
+     * Executes the callback and stores the result in cache.
+     *
+     * Выполняет callback и сохраняет результат в кэш.
+     */
+    private setCache;
+    /**
+     * Asynchronously executes the callback and stores the result in cache.
+     *
+     * Асинхронно выполняет callback и сохраняет результат в кэш.
+     */
+    private setCacheAsync;
+    /**
+     * Determines if the cache should be updated based on comparison array changes.
+     *
+     * Определяет, следует ли обновить кэш на основе изменений в массиве comparison.
+     * @param comparison - New comparison array to compare against / Новый массив comparison для сравнения
+     * @returns True if cache should be updated, false otherwise / True, если кэш нужно обновить, иначе false
+     */
+    private isUpdate;
+}

package/dist/classes/CacheStatic.d.ts

@@ -0,0 +1,36 @@
+import { Cache } from './Cache';
+/**
+ * Static cache class that uses ServerStorage for persistent caching across the application.
+ *
+ * Статический класс кэша, использующий ServerStorage для постоянного кэширования в приложении.
+ * @deprecated This class is obsolete and should not be used / Этот класс устарел и не рекомендуется к использованию
+ */
+export declare class CacheStatic {
+    /**
+     * Retrieves the Cache instance from ServerStorage.
+     *
+     * Получает экземпляр Cache из ServerStorage.
+     * @returns Cache instance for static caching / Экземпляр Cache для статического кэширования
+     */
+    protected static getItem(): Cache;
+    /**
+     * Returns a cached value for the given name. If not cached, executes the callback and stores the result.
+     *
+     * Возвращает кэшированное значение для указанного имени. Если нет кэша, выполняет callback и сохраняет результат.
+     * @param name - Unique cache key / Уникальный ключ кэша
+     * @param callback - Function to compute the value if not cached / Функция для вычисления значения, если его нет в кэше
+     * @param comparison - Optional array for cache invalidation / Опциональный массив для инвалидации кэша
+     * @returns The cached or newly computed value / Кэшированное или новое вычисленное значение
+     */
+    static get<T>(name: string, callback: () => T, comparison?: any[]): T;
+    /**
+     * Asynchronously returns a cached value for the given name. If not cached, executes the callback and stores the result.
+     *
+     * Асинхронно возвращает кэшированное значение для указанного имени. Если нет кэша, выполняет callback и сохраняет результат.
+     * @param name - Unique cache key / Уникальный ключ кэша
+     * @param callback - Async function to compute the value if not cached / Асинхронная функция для вычисления значения
+     * @param comparison - Optional array for cache invalidation / Опциональный массив для инвалидации кэша
+     * @returns Promise resolving to the cached or newly computed value / Promise, разрешающийся в кэшированное или новое вычисленное значение
+     */
+    static getAsync<T>(name: string, callback: () => T, comparison?: any[]): Promise<T>;
+}

package/dist/classes/Cookie.d.ts

@@ -0,0 +1,54 @@
+import { CookieOptions } from './CookieStorage';
+/**
+ * Class for working with cookies.
+ *
+ * Класс для управления Cookie.
+ */
+export declare class Cookie<T> {
+    private name;
+    /**
+     * Returns an instance of the class according to the specified cookie name.
+     *
+     * Возвращает экземпляр класса по указанному имени cookie.
+     * @param name cookie name/ название cookie
+     */
+    static getInstance<T>(name: string): Cookie<unknown>;
+    /** Cookie value / Значение cookie */
+    private value?;
+    /** Cookie options / Параметры cookie */
+    private options;
+    /**
+     * Constructor
+     * @param name cookie name/ название cookie
+     */
+    constructor(name: string);
+    /**
+     * Get data or update if none.
+     *
+     * Получает данные или обновляет, если их нет.
+     * @param defaultValue value or function to change data / значение или функция для изменения данных
+     * @param options additional parameters / дополнительные параметры
+     * @returns cookie value / значение cookie
+     */
+    get(defaultValue?: T | string | (() => (T | string)), options?: CookieOptions): string | T | undefined;
+    /**
+     * Updates cookie data.
+     *
+     * Обновляет данные cookie.
+     * @param value value or function to change data / значение или функция для изменения данных
+     * @param options additional parameters / дополнительные параметры
+     */
+    set(value?: T | string | (() => (T | string)), options?: CookieOptions): void;
+    /**
+     * Delete cookie data.
+     *
+     * Удаление данных из cookie.
+     */
+    remove(): void;
+    /**
+     * Update cookie data.
+     *
+     * Обновление данных cookie.
+     */
+    private update;
+}

package/dist/classes/CookieBlock.d.ts

@@ -0,0 +1,30 @@
+import { CookieBlockInstance } from './CookieBlockInstance';
+/**
+ * Class for changing cookie access status.
+ *
+ * Класс для изменения статуса доступа к куки.
+ */
+export declare class CookieBlock {
+    /**
+     * Returns a request-isolated instance of CookieBlockInstance.
+     *
+     * Возвращает изолированный в рамках запроса экземпляр CookieBlockInstance.
+     * @returns CookieBlockInstance instance / экземпляр CookieBlockInstance
+     */
+    static getItem(): CookieBlockInstance;
+    /**
+     * Obtaining status.
+     *
+     * Получение статуса.
+     * @returns boolean current block status/ текущий статус блокировки
+     */
+    static get(): boolean;
+    /**
+     * Changing status.
+     *
+     * Изменение статуса.
+     * @param value value to be changed/ значение, на которое будет изменен
+     * @returns void
+     */
+    static set(value: boolean): void;
+}

package/dist/classes/CookieBlockInstance.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Class for changing cookie access status.
+ *
+ * Класс для изменения статуса доступа к куки.
+ */
+export declare class CookieBlockInstance {
+    private storage;
+    /**
+     * Obtaining status.
+     *
+     * Получение статуса.
+     * @returns boolean current block status/ текущий статус блокировки
+     */
+    get(): boolean;
+    /**
+     * Changing status.
+     *
+     * Изменение статуса.
+     * @param value value to be changed/ значение, на которое будет изменен
+     * @returns void
+     */
+    set(value: boolean): void;
+}

package/dist/classes/CookieStorage.d.ts

@@ -0,0 +1,174 @@
+/**
+ * Cookie sameSite attribute / Атрибут sameSite cookie
+ */
+export type CookieSameSite = 'strict' | 'lax';
+/**
+ * Cookie options / Параметры cookie
+ */
+export type CookieOptions = {
+    /** Cache age / Время кэширования */
+    age?: number;
+    /** SameSite attribute / Атрибут SameSite */
+    sameSite?: CookieSameSite;
+    /** Path / Путь */
+    path?: string;
+    /** Domain / Домен */
+    domain?: string;
+    /** Secure attribute / Атрибут Secure */
+    secure?: boolean;
+    /** HttpOnly attribute / Атрибут HttpOnly */
+    httpOnly?: boolean;
+    /** Partitioned attribute / Атрибут Partitioned */
+    partitioned?: boolean;
+    /** Additional arguments / Дополнительные аргументы */
+    arguments?: string[] | Record<string, string | number | boolean>;
+};
+/**
+ * Class for managing cookie storage with support for custom listeners.
+ * Useful for consistent cookie handling across different environments (DOM, SSR).
+ *
+ * Класс для управления хранением cookie с поддержкой пользовательских слушателей.
+ * Полезен для консистентной работы с cookie в различных окружениях (DOM, SSR).
+ */
+export declare class CookieStorage {
+    /** Storage mechanism for getting data / механизм хранения для получения данных */
+    protected static getListener?: (key: string) => any | undefined;
+    /** Storage mechanism for getting raw data / механизм хранения для получения сырых данных */
+    protected static getListenerRaw?: () => string;
+    /** Storage mechanism for setting data / механизм хранения для сохранения данных */
+    protected static setListener?: (key: string, value: any, cookie: string, options?: CookieOptions) => void;
+    /**
+     * Initializes the storage with listeners.
+     *
+     * Инициализирует хранилище слушателями.
+     * @param getListener Storage mechanism for getting data / механизм хранения для получения данных
+     * @param setListener Storage mechanism for setting data / механизм хранения для сохранения данных
+     */
+    static init(getListener?: (key: string) => any | undefined, getListenerRaw?: () => string, setListener?: (key: string, value: any, cookie: string, options?: CookieOptions) => void): void;
+    /**
+     * Resets the storage by clearing all in-memory items and resetting listeners.
+     *
+     * Сбрасывает хранилище, очищая все элементы в памяти и сбрасывая слушатели.
+     */
+    static reset(): void;
+    /**
+     * Getting data from storage.
+     *
+     * Получение данных из хранилища.
+     * @param name cookie name / имя cookie
+     * @param defaultValue default value / значение по умолчанию
+     * @returns T | undefined cookie value or default/ значение cookie или значение по умолчанию
+     */
+    static get<T>(name: string, defaultValue?: T | (() => T)): T | undefined;
+    /**
+     * Saving data to storage.
+     *
+     * Сохранение данных в хранилище.
+     * @param name cookie name / имя cookie
+     * @param value data to be stored / данные для хранения
+     * @param options additional parameters / дополнительные параметры
+     * @returns stored value / сохраненное значение
+     */
+    static set<T>(name: string, value: T | (() => T), options?: CookieOptions): T;
+    /**
+     * Removing data from storage.
+     *
+     * Удаление данных из хранилища.
+     * @param name cookie name / имя cookie
+     * @returns void
+     */
+    static remove(name: string): void;
+    /**
+     * Update data from cookies.
+     *
+     * Обновляет данные из cookies.
+     */
+    static update(): void;
+    /**
+     * Formats the cookie string for storage.
+     *
+     * Форматирует строку cookie для хранения.
+     * @param name cookie name / имя cookie
+     * @param value cookie value / значение cookie
+     * @param options additional parameters / дополнительные параметры
+     */
+    protected static format(name: string, value: string, options?: CookieOptions): string;
+    /**
+     * Check if the current environment is a DOM environment.
+     *
+     * Проверяет, является ли текущее окружение DOM-окружением.
+     * @returns True if the current environment is a DOM environment, false otherwise / Возвращает true, если текущее окружение является DOM-окружением, иначе false
+     */
+    protected static hasDom(): boolean;
+    /**
+     * Parses the cookie string into a key-value pair object.
+     *
+     * Разбирает строку cookie в объект пар ключ-значение.
+     * @param cookie cookie string / строка cookie
+     * @returns Record<string, any> parsed items / разобранные элементы
+     */
+    protected static parse(cookie: string): Record<string, any>;
+    /**
+     * Initialize storage if not initialized.
+     *
+     * Инициализирует хранилище, если оно не инициализировано.
+     */
+    protected static initItems(): Record<string, any>;
+    /**
+     * Converts the value to a string for the max-age attribute.
+     *
+     * Преобразует значение в строку для атрибута max-age.
+     * @param stringValue cookie value / значение cookie
+     * @param age cache age (default: 7 days) / возраст кэша (по умолчанию: 7 дней)
+     */
+    protected static toMaxAge(stringValue: string, age?: CookieOptions['age']): string;
+    /**
+     * Converts the value to a string for the SameSite attribute.
+     *
+     * Преобразует значение в строку для атрибута SameSite.
+     * @param sameSite SameSite attribute / атрибут SameSite
+     */
+    protected static toSameSite(sameSite?: CookieOptions['sameSite']): string;
+    /**
+     * Converts the value to a string for the path attribute.
+     *
+     * Преобразует значение в строку для атрибута path.
+     * @param path Path / путь
+     */
+    protected static toPath(path?: CookieOptions['path']): string;
+    /**
+     * Converts the value to a string for the domain attribute.
+     *
+     * Преобразует значение в строку для атрибута domain.
+     * @param domain Domain / домен
+     */
+    protected static toDomain(domain?: CookieOptions['domain']): string | undefined;
+    /**
+     * Converts the value to a string for the secure attribute.
+     *
+     * Преобразует значение в строку для атрибута secure.
+     * @param secure Secure attribute / атрибут secure
+     */
+    protected static toSecure(secure?: CookieOptions['secure']): string | undefined;
+    /**
+     * Converts the value to a string for the HttpOnly attribute.
+     *
+     * Преобразует значение в строку для атрибута HttpOnly.
+     * @param httpOnly HttpOnly attribute / атрибут HttpOnly
+     */
+    protected static toHttpOnly(httpOnly?: CookieOptions['httpOnly']): string | undefined;
+    /**
+     * Converts the value to a string for the partitioned attribute.
+     *
+     * Преобразует значение в строку для атрибута partitioned.
+     * @param partitioned Partitioned attribute / атрибут partitioned
+     */
+    protected static toPartitioned(partitioned?: CookieOptions['partitioned']): string | undefined;
+    /**
+     * Converts additional arguments to an array of strings.
+     *
+     * Преобразует дополнительные аргументы в массив строк.
+     * @param args additional arguments / дополнительные аргументы
+     */
+    protected static toArguments(args?: CookieOptions['arguments']): string[];
+}

package/dist/classes/DataStorage.d.ts

@@ -0,0 +1,107 @@
+import { ErrorCenterInstance } from './ErrorCenterInstance';
+/**
+ * Class for working with localStorage and sessionStorage.
+ * Includes support for prefixes, expiration time, and request isolation in SSR.
+ *
+ * Класс для работы с localStorage и sessionStorage.
+ * Включает поддержку префиксов, времени жизни данных и изоляцию запросов в SSR.
+ */
+export declare class DataStorage<T> {
+    private name;
+    private isSession;
+    private errorCenter;
+    /**
+     * Changing the prefix in key names. Should be called at the beginning of the code.
+     *
+     * Изменение префикса в названиях ключей. Вызывать нужно в начале кода.
+     * @param newPrefix new prefix/ новый префикс
+     * @returns void
+     */
+    static setPrefix(newPrefix: string): void;
+    /**
+     * The current value stored in memory/
+     * Текущее значение, хранящееся в памяти
+     */
+    private value?;
+    /**
+     * The timestamp of when the value was last saved/
+     * Временная метка последнего сохранения значения
+     */
+    private age?;
+    /**
+     * Constructor.
+     *
+     * Конструктор.
+     * @param name value name / название значения
+     * @param isSession should we use a session/ использовать ли сессию
+     * @param errorCenter error center instance/ экземпляр центра ошибок
+     */
+    constructor(name: string, isSession?: boolean, errorCenter?: ErrorCenterInstance);
+    /**
+     * Getting data from storage.
+     *
+     * Получение данных из хранилища.
+     * @param defaultValue default value / значение по умолчанию
+     * @param cache cache time in seconds / время кэширования в секундах
+     * @returns stored value or default value / сохраненное значение или значение по умолчанию
+     */
+    get(defaultValue?: T | (() => T), cache?: number): T | undefined;
+    /**
+     * Changing data in storage.
+     *
+     * Изменение данных в хранилище.
+     * @param value new values / новые значения
+     * @returns the set value / установленное значение
+     */
+    set(value?: T | (() => T)): T | undefined;
+    /**
+     * Removing data from storage.
+     *
+     * Удаление данных из хранилища.
+     * @returns this instance for chaining / текущий экземпляр для цепочки вызовов
+     */
+    remove(): this;
+    /**
+     * Syncing data from storage.
+     *
+     * Синхронизация данных из хранилища.
+     * @returns this instance / текущий экземпляр
+     */
+    update(): this;
+    /**
+     * Checks for storage time limit.
+     *
+     * Проверяет данные на истечение срока хранения (кэша).
+     * @param cache cache time in seconds / время кэширования в секундах
+     * @returns true if data is valid / true, если данные актуальны
+     */
+    private isCache;
+    /**
+     * Returns an object for working with storage (localStorage or sessionStorage).
+     *
+     * Возвращает объект для работы с хранилищем (localStorage или sessionStorage).
+     * @returns Storage object or undefined / объект Storage или undefined
+     */
+    private getMethod;
+    /**
+     * Getting the storage key name with prefix.
+     *
+     * Получение имени ключа в хранилище с учетом префикса.
+     * @returns key name / имя ключа
+     */
+    private getIndex;
+    /**
+     * Getting raw data from storage.
+     *
+     * Получение "сырых" данных из хранилища.
+     * @returns parsed data or undefined / распарсенные данные или undefined
+     */
+    private getValue;
+    /**
+     * Filling in the data from storage into memory.
+     *
+     * Заполнение данных из хранилища в память.
+     * @returns this instance / текущий экземпляр
+     */
+    private make;
+}