@dxtmisha/functional-basic 0.7.1 → 0.8.4

package/dist/library.d.ts

@@ -86,14 +86,14 @@ export declare class Api {
      * Изменить функцию перед запросом.
      * @param callback function for call/ функция для вызова
      */
-    static setPreparation(callback: () => Promise<void>): Api;
+    static setPreparation(callback: (apiFetch: ApiFetch) => Promise<void>): Api;
     /**
      * Modify the function after the request.
      *
      * Изменить функцию после запроса.
      * @param callback function for call/ функция для вызова
      */
-    static setEnd(callback: (query: Response) => Promise<ApiPreparationEnd>): Api;
+    static setEnd(callback: (query: Response, apiFetch: ApiFetch) => Promise<ApiPreparationEnd>): Api;
     /**
      * To execute a request.
      *
@@ -144,7 +144,7 @@ export declare class Api {
      * @param queryReturn custom function for reading data/ кастомная функция для чтения данных
      * @param end finalization data/ данные финализации
      */
-    protected static readData(query: Response, queryReturn: ApiFetch['queryReturn'], end: ApiPreparationEnd): Promise<any>;
+    protected static readData<T>(query: Response, queryReturn: ApiFetch['queryReturn'], end: ApiPreparationEnd): Promise<ApiData<T>>;
     /**
      * Executing the request.
      *
@@ -159,17 +159,31 @@ export declare class Api {
      * @param data data for transformation/ данные для преобразования
      * @param toData is it necessary to process the data/ нужно ли обрабатывать данные
      */
-    protected static makeData<T>(data: ApiData<T>, toData: boolean): T;
+    protected static makeData<T>(data: ApiData<T>, toData: boolean): ApiData<T>;
+    /**
+     * Appends the status object to the response data if possible.
+     *
+     * Добавляет объект статуса к данным ответа, если это возможно.
+     * @param data response data/ данные ответа
+     * @param status status object/ объект статуса
+     */
+    protected static makeStatus<T>(data: ApiData<T>, status: ApiStatus): ApiData<T>;
 }
 
 /**
  * Shape of API response data wrapper/ Структура обёртки данных ответа API
  */
-export declare type ApiData<T> = T & {
+export declare type ApiData<T = any> = T & {
     /** Primary payload (optional)/ Основная полезная нагрузка (опционально) */
     data?: T;
     /** Success flag/ Флаг успешности */
     success?: boolean;
+    /** Status/ Статус */
+    status?: ApiStatusType;
+    /** Message/ Сообщение */
+    message?: string;
+    /** Status object/ Объект статуса */
+    statusObject?: ApiStatusItem;
 };
 
 /**
@@ -256,6 +270,8 @@ export declare type ApiFetch = {
     globalEnd?: boolean;
     /** Additional fetch() options/ Дополнительные опции fetch() */
     init?: RequestInit;
+    /** AbortController for canceling the request/ AbortController для отмены запроса */
+    controller?: AbortController;
 };
 
 /**
@@ -322,9 +338,9 @@ export declare enum ApiMethodItem {
  */
 export declare class ApiPreparation {
     /** Function for call before the request/ Функция для вызова перед запросом */
-    protected callback?: () => Promise<void>;
+    protected callback?: (apiFetch: ApiFetch) => Promise<void>;
     /** Function for call after the request/ Функция для вызова после запроса */
-    protected callbackEnd?: (query: Response) => Promise<ApiPreparationEnd>;
+    protected callbackEnd?: (query: Response, apiFetch: ApiFetch) => Promise<ApiPreparationEnd>;
     /** Is the preparation in progress/ Идет ли подготовка */
     protected loading: boolean;
     /**
@@ -332,43 +348,47 @@ export declare class ApiPreparation {
      *
      * Подготовка перед выполнением запроса.
      * @param active is preparation active/ активна ли подготовка
+     * @param apiFetch request options/ опции запроса
      */
-    make(active: boolean): Promise<void>;
+    make(active: boolean, apiFetch: ApiFetch): Promise<void>;
     /**
      * Analysis of the request after execution.
      *
      * Анализ запроса после выполнения.
      * @param active is preparation active/ активна ли подготовка
      * @param query data received in the request/ данные, полученные в запросе
+     * @param apiFetch request options/ опции запроса
      */
-    makeEnd(active: boolean, query: Response): Promise<ApiPreparationEnd>;
+    makeEnd(active: boolean, query: Response, apiFetch: ApiFetch): Promise<ApiPreparationEnd>;
     /**
      * The function is modified for a call before the request.
      *
      * Изменить функцию перед запросом.
      * @param callback function for call/ функция для вызова
      */
-    set(callback: () => Promise<void>): this;
+    set(callback: (apiFetch: ApiFetch) => Promise<void>): this;
     /**
      * Modify the function after the request.
      *
      * Изменить функцию после запроса.
      * @param callback function for call/ функция для вызова
      */
-    setEnd(callback: (query: Response) => Promise<ApiPreparationEnd>): this;
+    setEnd(callback: (query: Response, apiFetch: ApiFetch) => Promise<ApiPreparationEnd>): this;
     /**
      * To execute preparation.
      *
      * Выполнить подготовку.
+     * @param apiFetch request options/ опции запроса
      */
-    protected go(): Promise<void>;
+    protected go(apiFetch: ApiFetch): Promise<void>;
     /**
      * Analysis of the request after execution.
      *
      * Анализ запроса после выполнения.
      * @param query data received in the request/ данные, полученные в запросе
+     * @param apiFetch request options/ опции запроса
      */
-    protected end(query: Response): Promise<ApiPreparationEnd>;
+    protected end(query: Response, apiFetch: ApiFetch): Promise<ApiPreparationEnd>;
 }
 
 /**
@@ -381,6 +401,11 @@ export declare type ApiPreparationEnd = {
     data?: any;
 };
 
+/**
+ * Class for working with API responses.
+ *
+ * Класс для работы с ответами API.
+ */
 export declare class ApiResponse {
     protected readonly requestDefault: ApiDefault;
     /** List of first-time API requests/ Список первичных API запросов */
@@ -536,6 +561,12 @@ export declare class ApiStatus {
      * Возвращает текст статуса выполнения.
      */
     getStatusText(): string | undefined;
+    /**
+     * Returns the last status type.
+     *
+     * Возвращает последний тип статуса.
+     */
+    getStatusType(): ApiStatusType | undefined;
     /**
      * Returns the script execution error.
      *
@@ -583,6 +614,13 @@ export declare class ApiStatus {
      * @param response response data/ данные ответа
      */
     setLastResponse(response?: any): this;
+    /**
+     * Sets the last status.
+     *
+     * Устанавливает последний статус.
+     * @param status status/ статус
+     */
+    setLastStatus(status?: ApiStatusType): this;
     /**
      * Sets messages from the last request.
      *
@@ -601,19 +639,29 @@ export declare class ApiStatus {
 }
 
 export declare type ApiStatusItem = {
+    /** HTTP status code/ Код статуса HTTP */
     status?: number;
+    /** HTTP status text/ Текст статуса HTTP */
     statusText?: string;
+    /** Error message/ Сообщение об ошибке */
     error?: string;
+    /** Last response/ Последний ответ */
     lastResponse?: any;
+    /** Last status/ Последний статус */
+    lastStatus?: ApiStatusType;
+    /** Last message/ Последнее сообщение */
     lastMessage?: string;
 };
 
+/** API status type/ Тип статуса API */
+export declare type ApiStatusType = 'success' | 'error' | 'warning' | 'info';
+
 /**
  * Applies a template to the text, replacing keys with values from the replacement object
  *
  * Применяет шаблон к тексту, заменяя ключи на значения из объекта замены
- * @param text text with a template containing keys in square brackets, for example "[key]"/
- * текст с шаблоном, содержащим ключи в квадратных скобках, например "[key]"
+ * @param text text with a template containing keys in square or curly brackets, for example "[key]" or "{key}"/
+ * текст с шаблоном, содержащим ключи в квадратных или фигурных скобках, например "[key]" или "{key}"
  * @param replacement an object containing key-value pairs for replacement/
  * объект, содержащий пары ключ-значение для замены
  */
@@ -1769,8 +1817,10 @@ export declare function executePromise<T>(callback: (() => Promise<T>) | (() =>
  * @param data object for iteration/ объект для перебора
  * @param callback a function to execute for each element in the array/
  * функция, которая будет вызвана для каждого элемента
+ * @param saveUndefined if true, the function will return an array with undefined values/
+ * если true, функция вернет массив с undefined значениями
  */
-export declare function forEach<T, R, D extends T[] | Record<string, T> | Map<string, T> = T[] | Record<string, T> | Map<string, T>, K = D extends T[] ? number : string>(data: D & (T[] | Record<string, T> | Map<string, T>), callback: (item: T, key: K, dataMain: typeof data) => R): R[];
+export declare function forEach<T, R, D extends T[] | Record<string, T> | Map<string, T> = T[] | Record<string, T> | Map<string, T>, K = D extends T[] ? number : string>(data: D & (T[] | Record<string, T> | Map<string, T>), callback: (item: T, key: K, dataMain: typeof data) => R, saveUndefined?: boolean): R[];
 
 /**
  * Cyclically calls requestAnimationFrame until next returns true
@@ -2625,7 +2675,7 @@ export declare function getExp(value: string, flags?: string, pattern?: string):
  * @param item object for work/ объект для работы
  * @param path data path/ путь к данным
  */
-export declare function getItemByPath<T extends Record<string, any>>(item: T, path: string): string;
+export declare function getItemByPath<T extends Record<string, any>, R = string>(item: T, path: string): R | undefined;
 
 /**
  * Returns the pressed key.
@@ -2792,6 +2842,16 @@ export declare function goScroll(selector: string, elementTo: HTMLElement | unde
  */
 export declare function goScrollSmooth<E extends HTMLElement>(element: E, options?: ScrollIntoViewOptions, shift?: number): void;
 
+/**
+ * Scrolls the container to make the target element visible.
+ *
+ * Прокручивает контейнер, чтобы целевой элемент стал видимым.
+ * @param element container element/ элемент контейнера
+ * @param elementTo target element/ целевой элемент
+ * @param behavior scroll behavior/ режим прокрутки
+ */
+export declare function goScrollTo(element?: HTMLElement, elementTo?: HTMLElement, behavior?: ScrollBehavior): void;
+
 /**
  * Working with data stored in hash.
  *
@@ -3017,8 +3077,9 @@ export declare function isDomRuntime(): boolean;
  *
  * Проверяет, является ли нажатая клавиша Enter или Space.
  * @param event event object/ объект события
+ * @param isInputElement whether the element is an input element/ является ли элемент полем ввода
  */
-export declare const isEnter: (event: KeyboardEvent) => boolean;
+export declare const isEnter: (event: KeyboardEvent, isInputElement?: boolean) => boolean;
 
 /**
  * Checks if the field is filled.
@@ -3053,6 +3114,14 @@ export declare function isFunction<T>(callback: T): callback is Extract<T, Funct
  */
 export declare function isInDom<E extends ElementOrWindow>(element?: ElementOrString<E>): boolean;
 
+/**
+ * Checks if the element is an input field or editable.
+ *
+ * Проверяет, является ли элемент полем ввода или редактируемым.
+ * @param element element to check/ проверяемый элемент
+ */
+export declare const isInput: (element: HTMLElement | EventTarget | null) => boolean;
+
 /**
  * Checks if the value is between integers.
  *
@@ -4471,6 +4540,18 @@ export declare function splice<I>(array: ObjectItem<I>, replacement?: ObjectItem
  */
 export declare function strFill(value: string, count: number): string;
 
+/**
+ * Splits a string by a separator, limited to a certain number of elements.
+ * If a limit is specified, the last element will contain the remainder of the string.
+ *
+ * Разделяет строку по разделителю, ограничивая количество элементов.
+ * Если указан лимит, последний элемент будет содержать остаток строки.
+ * @param value input value/ входное значение
+ * @param separator separator/ разделитель
+ * @param limit limit/ лимит
+ */
+export declare function strSplit(value: number | string, separator: string, limit?: number): string[];
+
 /**
  * Преобразует значение в массив.
  * Если переданное значение уже является массивом, возвращается оно само.
@@ -4655,6 +4736,13 @@ export declare class Translate {
      * @param data list of texts in the form of key-value/ список текстов в виде ключ-значение
      */
     static addNormalOrSync(data: Record<string, string>): Promise<void>;
+    /**
+     * Adds texts synchronously by location.
+     *
+     * Добавляет тексты синхронно по местоположению.
+     * @param data list of texts by location/ список текстов по местоположению
+     */
+    static addSyncByLocation(data: Record<string, Record<string, string>>): void;
     /**
      * Change the path to the script for obtaining the translation.
      *
@@ -4663,6 +4751,20 @@ export declare class Translate {
      */
     static setUrl(url: string): Translate;
     static setPropsName(name: string): Translate;
+    /**
+     * Checks for translation by code, taking into account fallback options.
+     *
+     * Проверяет наличие перевода по коду с учетом запасных вариантов.
+     * @param name code name/ название кода
+     */
+    protected static hasName(name: string): boolean;
+    /**
+     * Retrieves translation text by code, returning the first matching fallback.
+     *
+     * Получает текст перевода по коду, возвращая первое совпадение из запасных вариантов.
+     * @param name code name/ название кода
+     */
+    protected static getText(name: string): string | undefined;
     /**
      * Getting the full title for translation.
      *
@@ -4670,6 +4772,20 @@ export declare class Translate {
      * @param name code name/ название кода
      */
     protected static getName(name: string): string;
+    /**
+     * Getting the title for translation by language.
+     *
+     * Получение названия для перевода по языку.
+     * @param name code name/ название кода
+     */
+    protected static getNameByLanguage(name: string): string;
+    /**
+     * Getting the title for translation globally.
+     *
+     * Получение названия для перевода глобально.
+     * @param name code name/ название кода
+     */
+    protected static getNameByGlobal(name: string): string;
     /**
      * Returns a list of names that are not yet in the list.
      *
@@ -4699,6 +4815,8 @@ export declare class Translate {
     protected static make(): Promise<void>;
 }
 
+export declare const TRANSLATE_GLOBAL_PREFIX = "global";
+
 export declare type TranslateCode = string | string[];
 
 export declare type TranslateItemOrList<T extends TranslateCode> = T extends string[] ? TranslateList<T> : string;