@dxtmisha/functional-basic 1.8.10 → 1.10.0

package/dist/classes/ApiErrorStorage.d.ts

@@ -1,92 +0,0 @@
-import { ApiErrorStorageList, ApiErrorStorageItem, ApiMethodItem } from '../types/apiTypes';
-/**
- * Manager for handling and identifying API error states.
- *
- * This class provides a centralized storage for API error criteria. It allows the system
- * to identify specific errors by matching the response status, error code from the JSON body,
- * request method, and URL. It is used to transform raw network errors into structured
- * application-level error items for consistent processing.
- *
- * Менеджер для обработки и идентификации состояний ошибок API.
- *
- * Этот класс обеспечивает централизованное хранилище критериев ошибок API. Он позволяет
- * системе идентифицировать конкретные ошибки путем сопоставления статуса ответа,
- * кода ошибки из тела JSON, метода запроса и URL. Используется для преобразования
- * сырых сетевых ошибок в структурированные элементы ошибок прикладного уровня для
- * единообразной обработки.
- */
-export declare class ApiErrorStorage {
-    /** Error storage list / Список хранилища ошибок */
-    protected storage: ApiErrorStorageList;
-    /**
-     * Finds a matching error item in the storage by analyzing the response.
-     *
-     * Ищет подходящий элемент ошибки в хранилище путем анализа ответа.
-     * @param method API method / Метод API
-     * @param response fetch response / Ответ fetch
-     * @returns matched error item or undefined / найденный элемент ошибки или undefined
-     */
-    find(method: ApiMethodItem, response: Response): Promise<ApiErrorStorageItem>;
-    /**
-     * Adds one or more error items or lists to the internal storage.
-     *
-     * Добавляет один или несколько элементов или списков ошибок во внутреннее хранилище.
-     * @param item error item or list of items / элемент ошибки или список элементов
-     * @param url URL pattern or RegExp / шаблон URL или регулярное выражение
-     * @param method HTTP method of the request / HTTP-метод запроса
-     * @returns current instance / текущий экземпляр
-     */
-    add(item: Partial<ApiErrorStorageItem> | Partial<ApiErrorStorageItem>[], url?: string | RegExp, method?: ApiMethodItem): this;
-    /**
-     * Checks if the response matches the criteria of any stored error item.
-     *
-     * Проверяет, соответствует ли ответ критериям любого сохраненного элемента ошибки.
-     * @param method API method / Метод API
-     * @param response fetch response / Ответ fetch
-     * @param code error code from response body / код ошибки из тела ответа
-     * @returns matched error item or undefined if no match found / найденный элемент ошибки или undefined, если совпадений не найдено
-     */
-    protected findItem(method: ApiMethodItem, response: Response, code?: string): ApiErrorStorageItem | undefined;
-    /**
-     * Validates if the given URL matches the specified pattern.
-     *
-     * Проверяет, соответствует ли данный URL указанному шаблону.
-     * @param url URL to check / URL для проверки
-     * @param pattern URL pattern or RegExp / шаблон URL или регулярное выражение
-     * @returns true if the URL matches the pattern / true, если URL соответствует шаблону
-     */
-    protected isUrl(url: string, pattern: string | RegExp): boolean;
-    /**
-     * Attempts to extract an error code from the response body in JSON format.
-     *
-     * Пытается извлечь код ошибки из тела ответа в формате JSON.
-     * @param response fetch response / Ответ fetch
-     * @returns extracted error code or undefined / извлеченный код ошибки или undefined
-     */
-    protected getBody(response: Response): Promise<any>;
-    /**
-     * Retrieves data from the response body by key.
-     *
-     * Получает данные из тела ответа по ключу.
-     * @param body response body / тело ответа
-     * @param key property key / ключ свойства
-     * @returns extracted value or undefined / извлеченное значение или undefined
-     */
-    protected getDataByKey<R = string>(body: any, key: string): R | undefined;
-    /**
-     * Attempts to extract an error code from the response body in JSON format.
-     *
-     * Пытается извлечь код ошибки из тела ответа в формате JSON.
-     * @param body response body / тело ответа
-     * @returns extracted error code or undefined / извлеченный код ошибки или undefined
-     */
-    protected getCode(body: any): string | undefined;
-    /**
-     * Attempts to extract an error message from the response body in JSON format.
-     *
-     * Пытается извлечь сообщение об ошибке из тела ответа в формате JSON.
-     * @param body response body / тело ответа
-     * @returns extracted error message or undefined / извлеченное сообщение об ошибке или undefined
-     */
-    protected getMessage(body: any): string | undefined;
-}

package/dist/classes/ApiHeaders.d.ts

@@ -1,37 +0,0 @@
-import { ApiFetch, ApiHeadersValue } from '../types/apiTypes';
-/**
- * Class for managing HTTP request headers.
- *
- * Класс для управления заголовками HTTP-запросов.
- */
-export declare class ApiHeaders {
-    /** Default headers / Заголовки по умолчанию */
-    protected headers: ApiHeadersValue;
-    /**
-     * Gets the headers for the request.
-     *
-     * Получает заголовки для запроса.
-     * @param value list of headers / список заголовков
-     * @param type Content-Type header value / значение заголовка Content-Type
-     * @returns merged headers or undefined / объединенные заголовки или undefined
-     */
-    get(value?: Record<string, string> | null, type?: string | undefined | null): Record<string, string> | undefined;
-    /**
-     * Gets the headers for the request based on request type.
-     *
-     * Получает заголовки для запроса на основе типа запроса.
-     * @param request request data / данные запроса
-     * @param value list of headers / список заголовков
-     * @param type Content-Type header value / значение заголовка Content-Type
-     * @returns merged headers or undefined / объединенные заголовки или undefined
-     */
-    getByRequest(request: ApiFetch['request'], value?: Record<string, string> | null, type?: string): Record<string, string> | undefined;
-    /**
-     * Sets the default headers.
-     *
-     * Устанавливает заголовки по умолчанию.
-     * @param headers list of default headers/ список заголовков по умолчанию
-     * @returns this instance for chaining / текущий экземпляр для цепочки вызовов
-     */
-    set(headers: ApiHeadersValue): this;
-}

package/dist/classes/ApiHydration.d.ts

@@ -1,40 +0,0 @@
-import { ApiResponse } from './ApiResponse';
-import { ApiFetch, ApiHydrationList } from '../types/apiTypes';
-/**
- * Class for collecting API data for hydration on the client side during SSR.
- *
- * Класс для сбора данных API для последующей гидратации на стороне клиента при SSR.
- */
-export declare class ApiHydration {
-    /** Hydration data list / Список данных гидратации */
-    protected list: ApiHydrationList;
-    /**
-     * Initializes the response with hydration data.
-     *
-     * Инициализирует ответ данными гидратации.
-     * @param response API response / ответ API
-     * @returns void / ничего не возвращает
-     */
-    initResponse(response: ApiResponse): void;
-    /**
-     * Saves API response for client-side hydration.
-     *
-     * Сохраняет ответ API для гидратации на стороне клиента.
-     * @param apiFetch API request configuration / конфигурация запроса API
-     * @param response API response data / данные ответа API
-     * @returns void / ничего не возвращает
-     */
-    toClient<T>(apiFetch: ApiFetch, response: T): void;
-    /**
-     * Returns a string representation of the hydration data for the client.
-     *
-     * Возвращает строковое представление данных гидратации для клиента.
-     */
-    toString(): string;
-    /**
-     * Returns the list of API responses for the client.
-     *
-     * Возвращает список ответов API для клиента.
-     */
-    protected getListByClient(): ApiHydrationList;
-}

package/dist/classes/ApiInstance.d.ts

@@ -1,299 +0,0 @@
-import { GeoInstance } from './GeoInstance';
-import { LoadingInstance } from './LoadingInstance';
-import { ErrorCenterInstance } from './ErrorCenterInstance';
-import { ApiDefault } from './ApiDefault';
-import { ApiErrorItem } from './ApiErrorItem';
-import { ApiHeaders } from './ApiHeaders';
-import { ApiHydration } from './ApiHydration';
-import { ApiPreparation } from './ApiPreparation';
-import { ApiResponse } from './ApiResponse';
-import { ApiStatus } from './ApiStatus';
-import { ApiDefaultValue, ApiFetch, ApiHeadersValue, ApiMethod, ApiPreparationEnd } from '../types/apiTypes';
-/** Options for the API instance / Опции для экземпляра API */
-export type ApiInstanceOptions = {
-    /** Class for working with headers / Класс для работы с заголовками */
-    headersClass?: typeof ApiHeaders;
-    /** Class for working with default request parameters / Класс для работы с параметрами запроса по умолчанию */
-    requestDefaultClass?: typeof ApiDefault;
-    /** Class for working with status / Класс для работы со статусом */
-    statusClass?: typeof ApiStatus;
-    /** Class for working with response / Класс для работы с ответом */
-    responseClass?: typeof ApiResponse;
-    /** Class for working with preparation / Класс для работы с модификацией запроса */
-    preparationClass?: typeof ApiPreparation;
-    /** Instance of loading handler / Экземпляр обработчика загрузки */
-    loadingClass?: LoadingInstance;
-    /** Instance of error handler / Экземпляр обработчика ошибок */
-    errorCenterClass?: ErrorCenterInstance;
-    /** Class for working with hydration / Класс для работы с гидратацией */
-    hydrationClass?: typeof ApiHydration;
-    /** Wrapper function for requests / Функция-обертка для запросов */
-    wrapper?: <R>(callback: () => Promise<R>, apiFetch: ApiFetch) => Promise<R>;
-};
-/**
- * Core class for managing HTTP requests using the Fetch API.
- *
- * Основной класс для управления HTTP-запросами через Fetch API.
- */
-export declare class ApiInstance {
-    protected url: string;
-    /** Geo class instance / Экземпляр класса Geo */
-    protected geo: GeoInstance;
-    /** Headers / Заголовки */
-    protected headers: ApiHeaders;
-    /** Default request parameters / Параметры запроса по умолчанию */
-    protected requestDefault: ApiDefault;
-    /** Status of the last request / Статус последнего запроса */
-    protected status: ApiStatus;
-    /** Response handler / Обработчик ответа */
-    protected response: ApiResponse;
-    /** Request modification handler / Обработчик модификации запроса */
-    protected preparation: ApiPreparation;
-    /** Loading handler / Обработчик загрузки */
-    protected loading: LoadingInstance;
-    /** Error handler / Обработчик ошибок */
-    protected errorCenter: ErrorCenterInstance;
-    /** Hydration handler / Обработчик гидратации */
-    protected hydration: ApiHydration;
-    /** Timeout for the request in milliseconds / Таймаут запроса в миллисекундах */
-    protected timeout: number;
-    /** Base URL origin / Базовый origin URL */
-    protected origin?: string;
-    /** Wrapper function for requests / Функция-обертка для запросов */
-    protected wrapper?: <R>(callback: () => Promise<R>, apiFetch: ApiFetch) => Promise<R>;
-    /**
-     * Constructor
-     * @param url base path to the script / базовый путь к скрипту
-     * @param options options for the API instance / опции для экземпляра API
-     */
-    constructor(url?: string, options?: ApiInstanceOptions);
-    /**
-     * Checks if the server is running on localhost.
-     *
-     * Проверяет, работает ли сервер на localhost.
-     * @returns true if server is localhost / true, если сервер является локальным
-     */
-    isLocalhost(): boolean;
-    /**
-     * Returns the status of the last request.
-     *
-     * Возвращает статус последнего запроса.
-     * @returns ApiStatus instance / экземпляр ApiStatus
-     */
-    getStatus(): ApiStatus;
-    /**
-     * Gets the response handler.
-     *
-     * Получает обработчик ответа.
-     * @returns ApiResponse instance / экземпляр ApiResponse
-     */
-    getResponse(): ApiResponse;
-    /**
-     * Gets the hydration handler.
-     *
-     * Получает обработчик гидратации.
-     * @returns ApiHydration instance / экземпляр ApiHydration
-     */
-    getHydration(): ApiHydration;
-    /**
-     * Gets the base origin URL combined with the API path.
-     *
-     * Получает базовый URL источника, объединенный с путем API.
-     * @returns final base URL string / итоговая строка базового URL
-     */
-    getOrigin(): string;
-    /**
-     * Gets the full path to the request script.
-     *
-     * Получает полный путь к скрипту запроса.
-     * @param path path to the script / путь к скрипту
-     * @param api whether to prepend base API URL / нужно ли добавить базовый URL API
-     * @returns full URL / полный URL
-     */
-    getUrl(path: string, api?: boolean): string;
-    /**
-     * Gets data for the request body.
-     *
-     * Получает данные для тела запроса.
-     * @param request request data / данные запроса
-     * @param method HTTP method / HTTP метод
-     * @returns body data for non-GET requests or FormData / данные тела для не-GET запросов или FormData
-     */
-    getBody(request?: ApiFetch['request'], method?: ApiMethod): string | FormData | undefined;
-    /**
-     * Gets query string for GET method requests.
-     *
-     * Получает строку запроса для GET-методов.
-     * @param request request data / данные запроса
-     * @param path path to request / путь к запросу
-     * @param method HTTP method / HTTP метод
-     * @returns query string with prefix (? or &) / строка запроса с префиксом (? или &)
-     */
-    getBodyForGet(request: ApiFetch['request'], path?: string, method?: ApiMethod): string;
-    /**
-     * Returns a string representation of the hydration data for the client.
-     *
-     * Возвращает строковое представление данных гидратации для клиента.
-     * @returns HTML script element string / строка HTML элемента script
-     */
-    getHydrationScript(): string;
-    /**
-     * Modifies the default header data.
-     *
-     * Изменяет данные заголовка по умолчанию.
-     * @param headers default headers / заголовки по умолчанию
-     */
-    setHeaders(headers: ApiHeadersValue): this;
-    /**
-     * Modifies the default request data.
-     *
-     * Изменяет данные запроса по умолчанию.
-     * @param request default request data / данные запроса по умолчанию
-     */
-    setRequestDefault(request: ApiDefaultValue): this;
-    /**
-     * Changes the base path to the script.
-     *
-     * Изменяет базовый путь к скрипту.
-     * @param url path to the script / путь к скрипту
-     */
-    setUrl(url: string): this;
-    /**
-     * Modifies the function to be called before the request.
-     *
-     * Изменяет функцию для вызова перед запросом.
-     * @param callback function to call before request / функция для вызова перед запросом
-     */
-    setPreparation(callback: (apiFetch: ApiFetch) => Promise<void>): this;
-    /**
-     * Modifies the function to be called after the request.
-     *
-     * Изменяет функцию для вызова после запроса.
-     * @param callback function to call after request / функция для вызова после запроса
-     */
-    setEnd(callback: (query: Response, apiFetch: ApiFetch) => Promise<ApiPreparationEnd>): this;
-    /**
-     * Changes the timeout for the request in milliseconds.
-     *
-     * Изменяет таймаут запроса в миллисекундах.
-     * @param timeout timeout in milliseconds / таймаут в миллисекундах
-     */
-    setTimeout(timeout: number): this;
-    /**
-     * Changes the origin (protocol and domain) for the base URL.
-     *
-     * Изменяет источник (протокол и домен) для базового URL.
-     * @param origin protocol and domain / протокол и домен
-     */
-    setOrigin(origin: string): this;
-    /**
-     * Sets the wrapper function for requests.
-     *
-     * Устанавливает функцию-обертку для запросов.
-     * @param wrapper wrapper function / функция-обертка
-     */
-    setWrapper(wrapper: <R>(callback: () => Promise<R>, apiFetch: ApiFetch) => Promise<R>): this;
-    /**
-     * Executes a request with the given path or configuration.
-     *
-     * Выполняет запрос с указанным путем или конфигурацией.
-     * @param pathRequest path or configuration / путь или конфигурация запроса
-     * @returns Promise with response data / Promise с данными ответа
-     */
-    request<T>(pathRequest: string | ApiFetch): Promise<T>;
-    /**
-     * Sends a GET method request.
-     *
-     * Отправляет запрос метода GET.
-     * @param request fetch configuration / конфигурация запроса
-     * @returns Promise with response data / Promise с данными ответа
-     */
-    get<T>(request: ApiFetch): Promise<T>;
-    /**
-     * Sends a POST method request.
-     *
-     * Отправляет запрос метода POST.
-     * @param request fetch configuration / конфигурация запроса
-     * @returns Promise with response data / Promise с данными ответа
-     */
-    post<T>(request: ApiFetch): Promise<T>;
-    /**
-     * Sends a PUT method request.
-     *
-     * Отправляет запрос метода PUT.
-     * @param request fetch configuration / конфигурация запроса
-     * @returns Promise with response data / Promise с данными ответа
-     */
-    put<T>(request: ApiFetch): Promise<T>;
-    /**
-     * Sends a PATCH method request.
-     *
-     * Отправляет запрос метода PATCH.
-     * @param request fetch configuration / конфигурация запроса
-     * @returns Promise with response data / Promise с данными ответа
-     */
-    patch<T>(request: ApiFetch): Promise<T>;
-    /**
-     * Sends a DELETE method request.
-     *
-     * Отправляет запрос метода DELETE.
-     * @param request fetch configuration / конфигурация запроса
-     * @returns Promise with response data / Promise с данными ответа
-     */
-    delete<T>(request: ApiFetch): Promise<T>;
-    /**
-     * Gets retry delay with jitter.
-     *
-     * Получает задержку повтора с джиттером.
-     * @param retryCount count of retries / количество повторов
-     * @param retryDelay base delay between retries / базовая задержка между повторами
-     * @returns delay in milliseconds / задержка в миллисекундах
-     */
-    protected getRetryDelay(retryCount: number, retryDelay: number): number;
-    /**
-     * Execute API request with retry support.
-     *
-     * Выполнить запрос API с поддержкой повторов.
-     * @param apiFetch fetch configuration / конфигурация запроса
-     * @param retryCount current retry count / текущий счетчик повторов
-     */
-    protected fetch<T>(apiFetch: ApiFetch, retryCount?: number): Promise<T>;
-    /**
-     * Executing the HTTP request.
-     *
-     * Выполнение HTTP-запроса.
-     * @param apiFetch fetch configuration / конфигурация запроса
-     * @param pathToApi base path to API / базовый путь к API
-     * @returns object containing response and optional timeout ID / объект, содержащий ответ и опциональный ID таймера
-     */
-    protected makeQuery(apiFetch: ApiFetch, pathToApi: string): Promise<{
-        query: Response;
-        timeoutId: any;
-    }>;
-    /**
-     * Processing an error.
-     *
-     * Обработка ошибки.
-     * @param error error object / объект ошибки
-     * @param group error group for error center (default: 'api') / группа ошибки для центра ошибок (по умолчанию: 'api')
-     */
-    protected makeError(error: Record<string, any> & {
-        name: string;
-    }, group?: string): void;
-    /**
-     * Processes an error response.
-     *
-     * Обрабатывает ошибку ответа.
-     * @param error error details / данные ошибки
-     */
-    protected makeErrorQuery(error: ApiErrorItem | Response): void;
-    /**
-     * Initialize controller for request with timeout support.
-     *
-     * Инициализация контроллера для запроса с поддержкой таймаута.
-     * @param apiFetch request options / опции запроса
-     * @param fetchInit request initialization object / объект инициализации запроса
-     * @returns timeout ID (from setTimeout) or undefined / ID таймера (от setTimeout) или undefined
-     */
-    protected initController(apiFetch: ApiFetch, fetchInit: RequestInit): any;
-}

package/dist/classes/ApiPreparation.d.ts

@@ -1,58 +0,0 @@
-import { ApiFetch, ApiPreparationEnd } from '../types/apiTypes';
-/**
- * Class for preparing requests.
- *
- * Класс для подготовки запросов.
- */
-export declare class ApiPreparation {
-    /** Function for call before the request / Функция для вызова перед запросом */
-    protected callback?: (apiFetch: ApiFetch) => Promise<void>;
-    /** Function for call after the request / Функция для вызова после запроса */
-    protected callbackEnd?: (query: Response, apiFetch: ApiFetch) => Promise<ApiPreparationEnd>;
-    /** Is the preparation in progress / Идет ли подготовка */
-    protected loading: boolean;
-    /**
-     * Executes preparation before the request.
-     *
-     * Выполняет подготовку перед выполнением запроса.
-     * @param active is preparation active / активна ли подготовка
-     * @param apiFetch request options / опции запроса
-     * @returns Promise<void> / Promise без возвращаемого значения
-     */
-    make(active: boolean, apiFetch: ApiFetch): Promise<void>;
-    /**
-     * Analyzes the request after execution.
-     *
-     * Анализирует запрос после выполнения.
-     * @param active is preparation active / активна ли подготовка
-     * @param query data received in the request / данные, полученные в запросе
-     * @param apiFetch request options / опции запроса
-     * @returns preparation end data / данные завершения подготовки
-     */
-    makeEnd(active: boolean, query: Response, apiFetch: ApiFetch): Promise<ApiPreparationEnd>;
-    /**
-     * Modifies the function to be called before the request.
-     *
-     * Изменяет функцию для вызова перед запросом.
-     * @param callback function to call before request / функция для вызова перед запросом
-     * @returns this instance for chaining / текущий экземпляр для цепочки вызовов
-     */
-    set(callback: (apiFetch: ApiFetch) => Promise<void>): this;
-    /**
-     * Modifies the function to be called after the request.
-     *
-     * Изменяет функцию для вызова после запроса.
-     * @param callback function to call after request / функция для вызова после запроса
-     * @returns this instance for chaining / текущий экземпляр для цепочки вызовов
-     */
-    setEnd(callback: (query: Response, apiFetch: ApiFetch) => Promise<ApiPreparationEnd>): this;
-    /**
-     * To execute preparation.
-     *
-     * Выполнить подготовку.
-     * @param apiFetch request options / опции запроса
-     * @param limit limit of retry attempts / лимит попыток повтора
-     * @returns Promise<void> / Promise без возвращаемого значения
-     */
-    protected go(apiFetch: ApiFetch, limit?: number): Promise<void>;
-}