@dxtmisha/functional 1.3.0 → 1.6.4

package/dist/classes/Api.d.ts

@@ -1,305 +0,0 @@
-import { RefOrNormal } from '../types/refTypes';
-export declare enum ApiMethodItem {
-    get = "GET",
-    post = "POST",
-    put = "PUT",
-    delete = "DELETE"
-}
-export type ApiMethod = string & ApiMethodItem;
-export type ApiFetch = {
-    /** Use base API URL/ Использовать базовый URL API */
-    api?: boolean;
-    /** Endpoint path relative to base URL/ Путь endpoint относительно базового URL */
-    path?: string;
-    /** Complete URL (overrides api + path)/ Полный URL (переопределяет api + path) */
-    pathFull?: string;
-    /** HTTP method/ HTTP метод */
-    method?: ApiMethod;
-    /** Request body data or query parameters/ Данные тела запроса или параметры запроса */
-    request?: FormData | Record<string, any> | string;
-    /** Include authentication headers/ Включить заголовки аутентификации */
-    auth?: boolean;
-    /** Custom headers (null = no headers)/ Пользовательские заголовки (null = без заголовков) */
-    headers?: Record<string, string> | null;
-    /** Content-Type header value/ Значение заголовка Content-Type */
-    type?: string;
-    /** Extract 'data' field from response/ Извлечь поле 'data' из ответа */
-    toData?: boolean;
-    /** Use global response cache/ Использовать глобальный кеш ответов */
-    global?: boolean;
-    /** Enable development logging/ Включить логирование разработки */
-    devMode?: boolean;
-    /** Suppress error logging/ Подавить логирование ошибок */
-    hideError?: boolean;
-    /** Custom response processor/ Пользовательский процессор ответа */
-    queryReturn?: (query: Response) => Promise<any>;
-    /** Run global preparation hooks/ Запускать глобальные хуки подготовки */
-    globalPreparation?: boolean;
-    /** Run global end hooks/ Запускать глобальные хуки завершения */
-    globalEnd?: boolean;
-    /** Additional fetch() options/ Дополнительные опции fetch() */
-    init?: RequestInit;
-};
-export type ApiResponse = {
-    path: string | RegExp;
-    method: ApiMethod;
-    request?: ApiFetch['request'] | '*any';
-    response: any | ((request?: ApiFetch['request']) => any);
-    disable?: RefOrNormal<boolean | undefined>;
-    isForGlobal?: boolean;
-    lag?: RefOrNormal<boolean | undefined>;
-};
-export type ApiData<T> = T & {
-    data?: T;
-    success?: boolean;
-};
-export type ApiPreparationEnd = {
-    reset?: boolean;
-    data?: any;
-};
-/**
- * Class for working with requests.
- *
- * Класс для работы с запросами.
- */
-export declare class Api {
-    protected static url: string;
-    protected static response: ApiResponse[];
-    protected static responseLoading?: any;
-    protected static headers: Record<string, string>;
-    protected static requestDefault: RefOrNormal<Record<string, any>>;
-    protected static preparation: boolean;
-    protected static preparationItem?: () => Promise<void>;
-    protected static preparationEndItem?: (query: Response) => Promise<ApiPreparationEnd>;
-    protected static status?: number;
-    protected static statusText?: string;
-    protected static error?: string;
-    protected static lastResponse?: any;
-    protected static lastMessage?: string;
-    /**
-     * Is the server local.
-     *
-     * Является ли сервер локальный.
-     */
-    static isLocalhost(): boolean;
-    /**
-     * Returns the data of the last request.
-     *
-     * Возвращает данные последнего запроса.
-     */
-    static getLastResponse<T>(): T;
-    /**
-     * Returns messages from the last request.
-     *
-     * Возвращает сообщения от последнего запроса.
-     */
-    static getLastMessage(): string;
-    /**
-     * Getting the header for the request.
-     *
-     * Получение заголовка для запроса.
-     * @param value list of headers/ список заголовков
-     * @param type type of request/ тип запроса
-     */
-    static getHeaders(value?: Record<string, string> | null, type?: string): Record<string, string> | undefined;
-    /**
-     * Getting the full path to the request script.
-     *
-     * Получение полного пути к скрипту запроса.
-     * @param path path to the script/ путь к скрипту
-     * @param api adding a path to the site’s API/ добавление пути к API сайта
-     */
-    static getUrl(path: string, api?: boolean): string;
-    /**
-     * Getting data for the body.
-     *
-     * Получение данных для тела.
-     * @param request this request/ данный запрос
-     * @param method method for request/ метод запрос
-     */
-    static getBody(request?: ApiFetch['request'], method?: ApiMethodItem): string | FormData | undefined;
-    /**
-     * Getting data for the body of the get method.
-     *
-     * Получение данных для тела метода get.
-     * @param request this request/ данный запрос
-     * @param path path to request/ путь к запрос
-     * @param method method for request/ метод запрос
-     */
-    static getBodyForGet(request: ApiFetch['request'], path?: string, method?: ApiMethodItem): string;
-    /**
-     * Returns a list of data about the emulator.
-     *
-     * Возвращает список данных об эмуляторе.
-     */
-    static getResponseList(): (ApiResponse & Record<string, any>)[];
-    /**
-     * Returns the execution status code.
-     *
-     * Возвращает код статуса выполнения.
-     */
-    static getStatus(): number | undefined;
-    /**
-     * Returns the execution status text.
-     *
-     * Возвращает текст статуса выполнения.
-     */
-    static getStatusText(): string | undefined;
-    /**
-     * Returns the script execution error.
-     *
-     * Возвращает ошибку выполнения скрипта.
-     */
-    static getError(): string | undefined;
-    /**
-     * Adds default data to the request.
-     *
-     * Добавляет данные по умолчанию к запросу.
-     */
-    static addRequestDefault(request: ApiFetch['request']): ApiFetch['request'];
-    /**
-     * Modifies the default header data.
-     *
-     * Изменяет данные заголовка по умолчанию.
-     */
-    static setHeaders(headers: Record<string, string>): Api;
-    /**
-     * Modifies the default request data.
-     *
-     * Изменяет данные запроса по умолчанию.
-     */
-    static setRequestDefault(request: RefOrNormal<Record<string, any>>): void;
-    /**
-     * Change the base path to the script.
-     *
-     * Изменить базовый путь к скрипту.
-     * @param url path to the script/ путь к скрипту
-     */
-    static setUrl(url: string): Api;
-    /**
-     * The function is modified for a call before the request.
-     *
-     * Изменить функцию перед запросом.
-     * @param callback function for call/ функция для вызова
-     */
-    static setPreparation(callback: () => Promise<void>): Api;
-    /**
-     * Modify the function after the request.
-     *
-     * Изменить функцию после запроса.
-     * @param callback function for call/ функция для вызова
-     */
-    static setEnd(callback: (query: Response) => Promise<ApiPreparationEnd>): Api;
-    /**
-     * To execute a request.
-     *
-     * Выполнить запрос.
-     * @param pathRequest query string or list of parameters/ строка запроса или список параметров
-     */
-    static request<T>(pathRequest: string | ApiFetch): Promise<T>;
-    /**
-     * Sends a get method request.
-     *
-     * Отправляет запрос метода get.
-     * @param request list of parameters/ список параметров
-     */
-    static get<T>(request: ApiFetch): Promise<T>;
-    /**
-     * Sends a post method request.
-     *
-     * Отправляет запрос метода post.
-     * @param request list of parameters/ список параметров
-     */
-    static post<T>(request: ApiFetch): Promise<T>;
-    /**
-     * Sends a put method request.
-     *
-     * Отправляет запрос метода put.
-     * @param request list of parameters/ список параметров
-     */
-    static put<T>(request: ApiFetch): Promise<T>;
-    /**
-     * Sends a delete method request.
-     *
-     * Отправляет запрос метода delete.
-     * @param request list of parameters/ список параметров
-     */
-    static delete<T>(request: ApiFetch): Promise<T>;
-    /**
-     * Adding cached requests.
-     *
-     * Добавление кешированных запросов.
-     * @param response data for caching/ данные для кеширования
-     */
-    static addResponse(response: ApiResponse | ApiResponse[]): Api;
-    /**
-     * Checks if there is a global cached request, if there is, returns it.
-     *
-     * Проверяет, есть ли глобальный кешированный запрос, если есть, возвращает его.
-     * @param path link to the request/ ссылка на запрос
-     * @param method request method/ метод запроса
-     * @param request data for the request/ данные для запроса
-     * @param devMode is it developer mode/ является ли режим разработчика
-     */
-    protected static getResponse(path: string | undefined, method: ApiMethod, request?: ApiFetch['request'], devMode?: boolean): ApiResponse | undefined;
-    /**
-     * To execute a request.
-     *
-     * Выполнить запрос.
-     * @param apiFetch property of the request/ свойство запроса
-     */
-    protected static fetch<T>(apiFetch: ApiFetch): Promise<T>;
-    /**
-     * Emulates an execution request.
-     *
-     * Эмулирует запрос выполнения.
-     * @param response Data for pre-request/ Данные для пред-запроса
-     * @param request data for the request/ данные для запроса
-     */
-    protected static fetchResponse<T>(response: ApiResponse, request?: ApiFetch['request']): Promise<T>;
-    /**
-     * Выполнение эмулятора, если доступно
-     * @param apiFetch property of the request/ свойство запроса
-     */
-    protected static makeEmulator<T>(apiFetch: ApiFetch): Promise<T | undefined>;
-    /**
-     * Executing the request.
-     *
-     * Выполнение запроса.
-     * @param apiFetch property of the request/ свойство запроса
-     */
-    protected static makeQuery(apiFetch: ApiFetch): Promise<Response>;
-    /**
-     * Preparation before executing the request.
-     *
-     * Подготовка перед выполнением запроса.
-     */
-    protected static makePreparation(): Promise<void>;
-    /**
-     * Analysis of the request after execution.
-     *
-     * Анализ запроса после выполнения.
-     * @param query data received in the request/ данные, полученные в запросе
-     */
-    protected static makePreparationEnd(query: Response): Promise<ApiPreparationEnd>;
-    /**
-     * Transforms data if needed.
-     *
-     * Преобразует данные, если нужно.
-     * @param data data for transformation/ данные для преобразования
-     * @param toData is it necessary to process the data/ нужно ли обрабатывать данные
-     */
-    protected static makeData<T>(data: ApiData<T>, toData: boolean): T;
-    /**
-     * Enable loading for request emulation.
-     *
-     * Включить загрузку для эмуляции запроса.
-     */
-    protected static startResponseLoading(): void;
-    /**
-     * Disable loading for request emulation.
-     *
-     * Отключить загрузку для эмуляции запроса.
-     */
-    protected static stopResponseLoading(): void;
-}

package/dist/classes/BroadcastMessage.d.ts

@@ -1,36 +0,0 @@
-/**
- * A class to handle BroadcastChannel messaging.
- *
- * Класс для работы с сообщениями BroadcastChannel.
- */
-export declare class BroadcastMessage<Message = any> {
-    protected callback?: ((event: MessageEvent<Message>) => void) | undefined;
-    protected channel?: BroadcastChannel;
-    /**
-     * Constructor
-     * @param name channel name/ название канала
-     * @param callback callback on message received/ колбэк на получение сообщения
-     */
-    constructor(name: string, callback?: ((event: MessageEvent<Message>) => void) | undefined);
-    /**
-     * Send a message to the channel.
-     *
-     * Отправить сообщение в канал.
-     * @param message message to send/ сообщение для отправки
-     */
-    post(message: Message): this;
-    /**
-     * Set the callback function to be called when a message is received.
-     *
-     * Установить функцию колбэка, которая будет вызвана при получении сообщения.
-     * @param callback callback function/ функция колбэка
-     */
-    setCallback(callback: (event: MessageEvent<Message>) => void): this;
-    /**
-     * Update state on message received.
-     *
-     * Обновление состояния при получении сообщения.
-     * @param event message event/ событие сообщения
-     */
-    protected readonly update: (event: MessageEvent<Message>) => this;
-}

package/dist/classes/Cache.d.ts

@@ -1,34 +0,0 @@
-/**
- * Simple class for caching.
- *
- * Простой класс для кэширования.
- */
-export declare class Cache {
-    private cache;
-    /**
-     * Getting data for the cache, and if there is no cache, it performs a function to save the cache.
-     *
-     * Получение данных для кэша, и если нет кэша, выполняет функцию для сохранения кэша.
-     * @param name cache name/ название кэша
-     * @param callback function for the cache/ функция для кэша
-     * @param comparison additional data for comparison/ дополнительные данные для сравнения
-     */
-    get<T>(name: string, callback: () => T, comparison?: any[]): T;
-    /**
-     * Getting data for the cache, and if there is no cache, it performs a function to save the cache (Async).
-     *
-     * Получение данных для кэша, и если нет кэша, выполняет функцию для сохранения кэша (Async).
-     * @param name cache name/ название кэша
-     * @param callback function for the cache/ функция для кэша
-     * @param comparison additional data for comparison/ дополнительные данные для сравнения
-     */
-    getAsync<T>(name: string, callback: () => T, comparison?: any[]): Promise<T>;
-    /**
-     * Returns an instance of the object for working with the cache element.
-     *
-     * Возвращает экземпляр объекта для работы с элементом кэша.
-     * @param name cache name/ название кэша
-     * @param callback function for the cache/ функция для кэша
-     */
-    private getCacheItem;
-}

package/dist/classes/CacheItem.d.ts

@@ -1,55 +0,0 @@
-/**
- * Class for managing a single caching value.
- *
- * Класс для управления одним значением кэширования.
- */
-export declare class CacheItem<T> {
-    private readonly callback;
-    private cache?;
-    private cacheOld?;
-    private comparisons;
-    /**
-     * Constructor
-     * @param callback function for the cache/ функция для кэша
-     */
-    constructor(callback: () => T);
-    /**
-     * Getting data for the cache, and if there is no cache, it performs a function to save the cache.
-     *
-     * Получение данных для кэша, и если нет кэша, выполняет функцию для сохранения кэша.
-     * @param comparison additional data for comparison/ дополнительные данные для сравнения
-     */
-    getCache(comparison: any[]): T;
-    /**
-     * Getting the previous value of the cache.
-     *
-     * Получение предыдущего значения кэша.
-     */
-    getCacheOld(): T | undefined;
-    /**
-     * Getting data for the cache, and if there is no cache, it performs a function to save the cache (Async).
-     *
-     * Получение данных для кэша, и если нет кэша, выполняет функцию для сохранения кэша (Async).
-     * @param comparison additional data for comparison/ дополнительные данные для сравнения
-     */
-    getCacheAsync(comparison: any[]): Promise<T>;
-    /**
-     * Overwrites or adds new values for the cache.
-     *
-     * Перезаписывает или добавляет новые значения для кэша.
-     */
-    private setCache;
-    /**
-     * Overwrites or adds new values for the cache (Async).
-     *
-     * Перезаписывает или добавляет новые значения для кэша (Async).
-     */
-    private setCacheAsync;
-    /**
-     * Checking additional data.
-     *
-     * Проверка дополнительных данных.
-     * @param comparison additional data for comparison/ дополнительные данные для сравнения
-     */
-    private isUpdate;
-}

package/dist/classes/CacheStatic.d.ts

@@ -1,17 +0,0 @@
-/**
- * Class for working with fast cache during code execution.
- *
- * Класс для работы с быстрым кэшем во время выполнения кода.
- */
-export declare class CacheStatic {
-    private static cache;
-    /**
-     * Getting data for the cache, and if there is no cache, it performs a function to save the cache.
-     *
-     * Получение данных для кэша, и если нет кэша, выполняет функцию для сохранения кэша.
-     * @param name cache name/ название кэша
-     * @param callback function for the cache/ функция для кэша
-     * @param comparison additional data for comparison/ дополнительные данные для сравнения
-     */
-    static get<T>(name: string, callback: () => T, comparison?: any[]): T;
-}

package/dist/classes/Cookie.d.ts

@@ -1,58 +0,0 @@
-type CookieSameSite = 'strict' | 'lax';
-export type CookieOptions = {
-    age?: number;
-    sameSite?: CookieSameSite;
-    arguments?: string[];
-};
-/**
- * Class for working with cookies.
- *
- * Класс для управления Cookie.
- */
-export declare class Cookie<T> {
-    private name;
-    value?: T | string;
-    private options;
-    constructor(name: string);
-    /**
-     * Get data or update if none.
-     *
-     * Получает данные или обновляет, если их нет.
-     * @param defaultValue value or function to change data/ значение или функция для изменения данных
-     * @param options additional parameters/ дополнительные параметры
-     */
-    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;
-    /**
-     * Returns cache time.
-     *
-     * Возвращает время кэширования.
-     */
-    private getAge;
-    /**
-     * Update cookie data.
-     *
-     * Обновление данных cookie.
-     */
-    private update;
-    /**
-     * Update data from cookies.
-     *
-     * Обновляет данные из cookies.
-     */
-    static updateData(): void;
-}
-export {};

package/dist/classes/CookieBlock.d.ts

@@ -1,22 +0,0 @@
-import { DataStorage } from './DataStorage';
-/**
- * Class for changing cookie access status.
- *
- * Класс для изменения статуса доступа к куки.
- */
-export declare class CookieBlock {
-    static storage: DataStorage<boolean>;
-    /**
-     * Obtaining status.
-     *
-     * Получение статуса.
-     */
-    static get(): boolean;
-    /**
-     * Changing status.
-     *
-     * Изменение статуса.
-     * @param value value to be changed/ значение, на которое будет изменен
-     */
-    static set(value: boolean): void;
-}

package/dist/classes/DataStorage.d.ts

@@ -1,82 +0,0 @@
-/**
- * Class for working with localStorage.
- *
- * Класс для работы с localStorage.
- */
-export declare class DataStorage<T> {
-    private name;
-    private isSession;
-    /**
-     * Changing the prefix in key names. Should be called at the beginning of the code.
-     *
-     * Изменение префикса в названиях ключей. Вызывать нужно в начале кода.
-     * @param newPrefix new prefix/ новый префикс
-     */
-    static setPrefix(newPrefix: string): void;
-    private value?;
-    private age?;
-    /**
-     * Constructor
-     * @param name value name/ название значения
-     * @param isSession should we use a session/ использовать ли сессию
-     */
-    constructor(name: string, isSession?: boolean);
-    /**
-     * Getting data from local storage.
-     *
-     * Получение данных из локального хранилища.
-     * @param defaultValue default value/ значение по умолчанию
-     * @param cache cache time/ время кэширования
-     */
-    get(defaultValue?: T | (() => T), cache?: number): T | undefined;
-    /**
-     * Changing data in storage.
-     *
-     * Изменение данных в хранилище.
-     * @param value new values/ новые значения
-     */
-    set(value?: T | (() => T)): T | undefined;
-    /**
-     * Removing data from storage.
-     *
-     * Удаление данных из хранилища.
-     */
-    remove(): this;
-    /**
-     * Clearing all data from storage.
-     *
-     * Очистка всех данных из хранилища.
-     */
-    update(): this;
-    /**
-     * Checks for storage time limit.
-     *
-     * Проверяет на лимит времени хранения.
-     * @param cache cache time/ время кэширования
-     */
-    private isCache;
-    /**
-     * Returns an object for working with storage.
-     *
-     * Возвращает объект для работы с хранилищем.
-     */
-    private getMethod;
-    /**
-     * Getting the storage key name.
-     *
-     * Получение имени ключа в хранилище.
-     */
-    private getIndex;
-    /**
-     * Getting data from storage.
-     *
-     * Получение данных из хранилища.
-     */
-    private getValue;
-    /**
-     * Filling in the data from storage.
-     *
-     * Заполнение данными из хранилища.
-     */
-    private make;
-}