@dxtmisha/functional-basic 0.6.0 → 0.6.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dxtmisha/functional-basic",
   "private": false,
-  "version": "0.6.0",
+  "version": "0.6.1",
   "type": "module",
   "description": "Core functional utility library for modern web development without framework dependencies",
   "keywords": [

package/dist/classes/Api.d.ts

@@ -1,161 +0,0 @@
-import { ApiHeaders } from './ApiHeaders';
-import { ApiDefault } from './ApiDefault';
-import { ApiStatus } from './ApiStatus';
-import { ApiResponse } from './ApiResponse';
-import { ApiPreparation } from './ApiPreparation';
-import { ApiData, ApiFetch, ApiMethodItem, ApiPreparationEnd } from '../types/apiTypes';
-/**
- * Class for working with requests.
- *
- * Класс для работы с запросами.
- */
-export declare class Api {
-    protected static url: string;
-    protected static headers: ApiHeaders;
-    protected static requestDefault: ApiDefault;
-    protected static status: ApiStatus;
-    protected static response: ApiResponse;
-    protected static preparation: ApiPreparation;
-    /**
-     * Is the server local.
-     *
-     * Является ли сервер локальный.
-     */
-    static isLocalhost(): boolean;
-    /**
-     * Returns the status of the last request.
-     *
-     * Возвращает статус последнего запроса.
-     */
-    static getStatus(): ApiStatus;
-    /**
-     * Getting the response handler.
-     *
-     * Получение обработчика ответа.
-     */
-    static getResponse(): ApiResponse;
-    /**
-     * 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;
-    /**
-     * Modifies the default header data.
-     *
-     * Изменяет данные заголовка по умолчанию.
-     */
-    static setHeaders(headers: Record<string, string>): Api;
-    /**
-     * Modifies the default request data.
-     *
-     * Изменяет данные запроса по умолчанию.
-     */
-    static setRequestDefault(request: Record<string, any>): Api;
-    /**
-     * 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>;
-    /**
-     * To execute a request.
-     *
-     * Выполнить запрос.
-     * @param apiFetch property of the request/ свойство запроса
-     */
-    protected static fetch<T>(apiFetch: ApiFetch): Promise<T>;
-    /**
-     * Reading data from the response.
-     *
-     * Чтение данных из ответа.
-     * @param query response from the server/ ответ от сервера
-     * @param queryReturn custom function for reading data/ кастомная функция для чтения данных
-     * @param end finalization data/ данные финализации
-     */
-    protected static readData(query: Response, queryReturn: ApiFetch['queryReturn'], end: ApiPreparationEnd): Promise<any>;
-    /**
-     * Executing the request.
-     *
-     * Выполнение запроса.
-     * @param apiFetch property of the request/ свойство запроса
-     */
-    protected static makeQuery(apiFetch: ApiFetch): Promise<Response>;
-    /**
-     * 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;
-}

package/dist/classes/ApiDefault.d.ts

@@ -1,43 +0,0 @@
-import { ApiDefaultValue, ApiFetch } from '../types/apiTypes';
-/**
- * Class for working with default API request data.
- *
- * Класс для работы с данными запроса API по умолчанию.
- */
-export declare class ApiDefault {
-    /** Default request data/ Данные запроса по умолчанию */
-    protected value?: ApiDefaultValue;
-    /**
-     * Checks if default request data exists.
-     *
-     * Проверяет, существуют ли данные запроса по умолчанию.
-     */
-    is(): boolean;
-    /**
-     * Gets the default request data.
-     *
-     * Получает данные запроса по умолчанию.
-     */
-    get(): ApiDefaultValue;
-    /**
-     * Adds default data to the request.
-     *
-     * Добавляет данные по умолчанию к запросу.
-     * @param request request data/ данные запроса
-     */
-    request(request: ApiFetch['request']): ApiFetch['request'];
-    /**
-     * Modifies the default request data.
-     *
-     * Изменяет данные запроса по умолчанию.
-     */
-    set(request: ApiDefaultValue): void;
-    /**
-     * Adds default data to FormData request.
-     *
-     * Добавляет данные по умолчанию к запросу FormData.
-     * @param request FormData request/ запрос FormData
-     * @param value default values/ значения по умолчанию
-     */
-    protected addByFormData(request: FormData, value: ApiDefaultValue): void;
-}

package/dist/classes/ApiHeaders.d.ts

@@ -1,23 +0,0 @@
-/**
- * Class for managing HTTP request headers.
- *
- * Класс для управления заголовками HTTP-запросов.
- */
-export declare class ApiHeaders {
-    /** Default headers/ Заголовки по умолчанию */
-    protected headers: Record<string, string>;
-    /**
-     * Getting the header for the request.
-     *
-     * Получение заголовка для запроса.
-     * @param value list of headers/ список заголовков
-     * @param type type of request/ тип запроса
-     */
-    get(value?: Record<string, string> | null, type?: string): Record<string, string> | undefined;
-    /**
-     * Modifies the default header data.
-     *
-     * Изменяет данные заголовка по умолчанию.
-     */
-    set(headers: Record<string, string>): this;
-}

package/dist/classes/ApiPreparation.d.ts

@@ -1,56 +0,0 @@
-import { ApiPreparationEnd } from '../types/apiTypes';
-/**
- * Class for preparing requests.
- *
- * Класс для подготовки запросов.
- */
-export declare class ApiPreparation {
-    /** Function for call before the request/ Функция для вызова перед запросом */
-    protected callback?: () => Promise<void>;
-    /** Function for call after the request/ Функция для вызова после запроса */
-    protected callbackEnd?: (query: Response) => Promise<ApiPreparationEnd>;
-    /** Is the preparation in progress/ Идет ли подготовка */
-    protected loading: boolean;
-    /**
-     * Preparation before executing the request.
-     *
-     * Подготовка перед выполнением запроса.
-     * @param active is preparation active/ активна ли подготовка
-     */
-    make(active: boolean): Promise<void>;
-    /**
-     * Analysis of the request after execution.
-     *
-     * Анализ запроса после выполнения.
-     * @param active is preparation active/ активна ли подготовка
-     * @param query data received in the request/ данные, полученные в запросе
-     */
-    makeEnd(active: boolean, query: Response): Promise<ApiPreparationEnd>;
-    /**
-     * The function is modified for a call before the request.
-     *
-     * Изменить функцию перед запросом.
-     * @param callback function for call/ функция для вызова
-     */
-    set(callback: () => Promise<void>): this;
-    /**
-     * Modify the function after the request.
-     *
-     * Изменить функцию после запроса.
-     * @param callback function for call/ функция для вызова
-     */
-    setEnd(callback: (query: Response) => Promise<ApiPreparationEnd>): this;
-    /**
-     * To execute preparation.
-     *
-     * Выполнить подготовку.
-     */
-    protected go(): Promise<void>;
-    /**
-     * Analysis of the request after execution.
-     *
-     * Анализ запроса после выполнения.
-     * @param query data received in the request/ данные, полученные в запросе
-     */
-    protected end(query: Response): Promise<ApiPreparationEnd>;
-}

package/dist/classes/ApiResponse.d.ts

@@ -1,111 +0,0 @@
-import { ApiDefault } from './ApiDefault';
-import { ApiFetch, ApiMethod, ApiResponseItem } from '../types/apiTypes';
-export declare class ApiResponse {
-    protected readonly requestDefault: ApiDefault;
-    /** List of first-time API requests/ Список первичных API запросов */
-    protected readonly first: ApiResponseItem[];
-    /** Cached responses/ Кешированные ответы */
-    protected readonly response: ApiResponseItem[];
-    /** Loading instance/ Экземпляр загрузки */
-    protected loading?: any;
-    /** Developer mode flag/ Флаг режима разработчика */
-    protected devMode: boolean;
-    /**
-     * Constructor
-     * @param requestDefault default request processor/ процессор запросов по умолчанию
-     */
-    constructor(requestDefault: ApiDefault);
-    /**
-     * 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/ является ли режим разработчика
-     */
-    get(path: string | undefined, method: ApiMethod, request?: ApiFetch['request'], devMode?: boolean): ApiResponseItem | undefined;
-    /**
-     * Returns a list of data about the emulator.
-     *
-     * Возвращает список данных об эмуляторе.
-     */
-    getList(): (ApiResponseItem & Record<string, any>)[];
-    /**
-     * Adding cached requests.
-     *
-     * Добавление кешированных запросов.
-     * @param response data for caching/ данные для кеширования
-     */
-    add(response: ApiResponseItem | ApiResponseItem[]): this;
-    /**
-     * Sets developer mode.
-     *
-     * Устанавливает режим разработчика.
-     * @param devMode is it developer mode/ является ли режим разработчика
-     */
-    setDevMode(devMode: boolean): this;
-    /**
-     * Выполнение эмулятора, если доступно
-     * @param apiFetch property of the request/ свойство запроса
-     */
-    emulator<T>(apiFetch: ApiFetch): Promise<T | undefined>;
-    /**
-     * Checks if the cached item is disabled.
-     *
-     * Проверяет, отключен ли кешированный элемент.
-     * @param item cached item/ кешированный элемент
-     */
-    protected isDisable(item: ApiResponseItem): boolean;
-    /**
-     * Checks if the path matches the cached one.
-     *
-     * Проверяет, совпадает ли путь с кешированным.
-     * @param item cached item/ кешированный элемент
-     * @param path request path/ путь запроса
-     */
-    protected isPath(item: ApiResponseItem, path: string): boolean;
-    /**
-     * Checks if it is developer mode.
-     *
-     * Проверяет, является ли режимом разработчика.
-     * @param devMode is it developer mode/ является ли режим разработчика
-     */
-    protected isDevMode(devMode?: boolean): boolean;
-    /**
-     * Checks if this is the first request.
-     *
-     * Проверяет, является ли это первым запросом.
-     * @param item cached item/ кешированный элемент
-     * @param devMode is it developer mode/ является ли режим разработчика
-     */
-    protected isFirst(item: ApiResponseItem, devMode?: boolean): boolean;
-    /**
-     * Checks if the request matches the cached one.
-     *
-     * Проверяет, совпадает ли запрос с кешированным.
-     * @param item cached item/ кешированный элемент
-     * @param request request data/ данные запроса
-     */
-    protected isResponse(item: ApiResponseItem, request?: ApiFetch['request']): boolean;
-    /**
-     * Emulates an execution request.
-     *
-     * Эмулирует запрос выполнения.
-     * @param response Data for pre-request/ Данные для пред-запроса
-     * @param request data for the request/ данные для запроса
-     */
-    protected fetch<T>(response: ApiResponseItem, request?: ApiFetch['request']): Promise<T>;
-    /**
-     * Enable loading for request emulation.
-     *
-     * Включить загрузку для эмуляции запроса.
-     */
-    protected startResponseLoading(): void;
-    /**
-     * Disable loading for request emulation.
-     *
-     * Отключить загрузку для эмуляции запроса.
-     */
-    protected stopResponseLoading(): void;
-}

package/dist/classes/ApiStatus.d.ts

@@ -1,89 +0,0 @@
-import { ApiStatusItem } from '../types/apiTypes';
-/**
- * API status class
- *
- * Класс статуса API
- */
-export declare class ApiStatus {
-    protected value?: ApiStatusItem;
-    /**
-     * Last response data
-     *
-     * Данные последнего ответа
-     */
-    get(): ApiStatusItem;
-    /**
-     * Returns the execution status code.
-     *
-     * Возвращает код статуса выполнения.
-     */
-    getStatus(): number | undefined;
-    /**
-     * Returns the execution status text.
-     *
-     * Возвращает текст статуса выполнения.
-     */
-    getStatusText(): string | undefined;
-    /**
-     * Returns the script execution error.
-     *
-     * Возвращает ошибку выполнения скрипта.
-     */
-    getError(): string | undefined;
-    /**
-     * Returns the data of the last request.
-     *
-     * Возвращает данные последнего запроса.
-     */
-    getResponse<T>(): T | undefined;
-    /**
-     * Returns messages from the last request.
-     *
-     * Возвращает сообщения от последнего запроса.
-     */
-    getMessage(): string;
-    /**
-     * Sets the status item data.
-     *
-     * Устанавливает данные элемента статуса.
-     * @param data status item data/ данные элемента статуса
-     */
-    set(data: ApiStatusItem): this;
-    /**
-     * Sets the status code and optional status text.
-     *
-     * Устанавливает код статуса и необязательный текст статуса.
-     * @param status status code/ код статуса
-     * @param statusText optional status text/ необязательный текст статуса
-     */
-    setStatus(status?: number, statusText?: string): this;
-    /**
-     * Sets the error message.
-     *
-     * Устанавливает сообщение об ошибке.
-     * @param error error message/ сообщение об ошибке
-     */
-    setError(error?: string): this;
-    /**
-     * Sets the data of the last response.
-     *
-     * Устанавливает данные последнего ответа.
-     * @param response response data/ данные ответа
-     */
-    setLastResponse(response?: any): this;
-    /**
-     * Sets messages from the last request.
-     *
-     * Устанавливает сообщения от последнего запроса.
-     * @param message message text/ текст сообщения
-     */
-    setLastMessage(message?: string): this;
-    /**
-     * Sets a specific field in the status item.
-     *
-     * Устанавливает конкретное поле в элементе статуса.
-     * @param name field name/ название поля
-     * @param value field value/ значение поля
-     */
-    protected setValue<K extends keyof ApiStatusItem>(name: K, value?: ApiStatusItem[K]): 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;
-}