@dxtmisha/functional 1.9.1 → 1.10.1

package/dist/library.d.ts

@@ -1,6 +1,8 @@
+import { ApiConfig } from '@dxtmisha/functional-basic';
 import { ApiData } from '@dxtmisha/functional-basic';
 import { ApiDefaultValue } from '@dxtmisha/functional-basic';
 import { ApiFetch } from '@dxtmisha/functional-basic';
+import { ApiInstance } from '@dxtmisha/functional-basic';
 import { ApiMethodItem } from '@dxtmisha/functional-basic';
 import { ArrayToItem } from '@dxtmisha/functional-basic';
 import { ComputedGetter } from 'vue';
@@ -10,6 +12,7 @@ import { Datetime } from '@dxtmisha/functional-basic';
 import { DebuggerOptions } from 'vue';
 import { ElementOrString } from '@dxtmisha/functional-basic';
 import { ElementOrWindow } from '@dxtmisha/functional-basic';
+import { ErrorCenterCauseList } from '@dxtmisha/functional-basic';
 import { EventItem } from '@dxtmisha/functional-basic';
 import { EventListenerDetail } from '@dxtmisha/functional-basic';
 import { EventOptions } from '@dxtmisha/functional-basic';
@@ -24,6 +27,7 @@ import { GeoFlagItem } from '@dxtmisha/functional-basic';
 import { GeoFlagNational } from '@dxtmisha/functional-basic';
 import { GeoHours } from '@dxtmisha/functional-basic';
 import { GeoItemFull } from '@dxtmisha/functional-basic';
+import { IconsConfig } from '@dxtmisha/functional-basic';
 import { ItemList } from '@dxtmisha/functional-basic';
 import { ItemValue } from '@dxtmisha/functional-basic';
 import { Meta } from '@dxtmisha/functional-basic';
@@ -31,6 +35,7 @@ import { MetaRobots } from '@dxtmisha/functional-basic';
 import { NumberOrString } from '@dxtmisha/functional-basic';
 import { NumberOrStringOrBoolean } from '@dxtmisha/functional-basic';
 import { NumberOrStringOrDate } from '@dxtmisha/functional-basic';
+import { Plugin as Plugin_2 } from 'vue';
 import { PropType } from 'vue';
 import { Ref } from 'vue';
 import { RouteLocationRaw } from 'vue-router';
@@ -43,6 +48,8 @@ import { SearchListValue } from '@dxtmisha/functional-basic';
 import { SearchOptions } from '@dxtmisha/functional-basic';
 import { ShallowRef } from 'vue';
 import { ToRefs } from 'vue';
+import { TranslateConfig } from '@dxtmisha/functional-basic';
+import { TranslateInstance } from '@dxtmisha/functional-basic';
 import { TranslateList } from '@dxtmisha/functional-basic';
 import { Undefined } from '@dxtmisha/functional-basic';
 import { VNode } from 'vue';
@@ -746,6 +753,29 @@ export declare abstract class DesignConstructorAbstract<E extends Element, COMP
     private updateStyles;
 }
 
+/**
+ * Vue plugin for initializing and configuring global functional services
+ * (Api, Translate, Icons, Meta).
+ *
+ * Vue плагин для инициализации и настройки глобальных функциональных сервисов
+ * (Api, Translate, Icons, Meta).
+ *
+ * @example
+ * ```typescript
+ * import { createApp } from 'vue'
+ * import { dxtFunctionalPlugin } from '@dxtmisha/functional'
+ * import router from './router'
+ *
+ * const app = createApp(App)
+ * app.use(dxtFunctionalPlugin, {
+ *   api: { url: 'https://api.example.com' },
+ *   metaSuffix: ' | My App',
+ *   router
+ * })
+ * ```
+ */
+export declare const dxtFunctionalPlugin: Plugin_2;
+
 /**
  * Global effect scope class.
  *
@@ -930,6 +960,43 @@ export declare enum ExecuteUseType {
     local = "local"
 }
 
+/**
+ * Interface for the functional plugin options /
+ * Интерфейс для опций функционального плагина
+ */
+export declare interface FunctionalPluginOptions {
+    /**
+     * Configuration for the API client /
+     * Конфигурация для API-клиента
+     */
+    api?: ApiConfig;
+    /**
+     * Configuration for the translation service /
+     * Конфигурация для сервиса переводов
+     */
+    translate?: TranslateConfig;
+    /**
+     * Suffix to be appended to all page titles /
+     * Суффикс, который будет добавляться ко всем заголовкам страниц
+     */
+    metaSuffix?: string;
+    /**
+     * Configuration for the icon management service /
+     * Конфигурация для сервиса управления иконками
+     */
+    icons?: IconsConfig;
+    /**
+     * Vue Router instance for global navigation state management /
+     * Экземпляр Vue Router для глобального управления состоянием навигации
+     */
+    router?: Router;
+    /**
+     * Error causes list for error center /
+     * Список причин ошибок для центра ошибок
+     */
+    errorCauses?: ErrorCenterCauseList;
+}
+
 /**
  * Class for working with Flags.
  *
@@ -1869,12 +1936,10 @@ export declare class RouterItemRef {
  * Класс для получения ширины скролла в виде реактивного элемента.
  */
 export declare class ScrollbarWidthRef {
-    /**
-     * Reactive item.
-     *
-     * Реактивный элемент.
-     */
+    /** Reactive item/ Реактивный элемент */
     readonly item: Ref<boolean | undefined, boolean | undefined>;
+    /** Reactive width/ Реактивная ширина */
+    readonly width: Ref<number, number>;
     /**
      * Constructor
      */
@@ -1946,12 +2011,36 @@ export declare function toRefItem<T>(item: RefOrNormal<T>): Ref<T>;
 /** Utility type to convert union types to intersection types/ Утилитарный тип для преобразования объединенных типов в пересеченные */
 export declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
 
-export declare function useApiDelete<T, Request extends ApiFetch['request'] = ApiFetch['request'], Return extends ApiData<T> = ApiData<T>>(path?: RefOrNormal<string | undefined>, action?: (data: Return | undefined) => Promise<void> | void, transformation?: (data: T) => Return, toData?: boolean, options?: ApiOptions): {
+/**
+ * Use API delete request.
+ *
+ * Использование API delete запроса.
+ * @param path Path to the API endpoint / Путь к endpoint API
+ * @param action Action to perform after the request / Действие, выполняемое после запроса
+ * @param transformation Transformation function / Функция трансформации
+ * @param toData Extract 'data' field from response / Извлечь поле 'data' из ответа
+ * @param options Additional request options / Дополнительные опции запроса
+ * @param apiInstance Api instance / Экземпляр Api
+ * @returns Object with loading state and send method / Объект с состоянием загрузки и методом отправки
+ */
+export declare function useApiDelete<T, Request extends ApiFetch['request'] = ApiFetch['request'], Return extends ApiData<T> = ApiData<T>>(path?: RefOrNormal<string | undefined>, action?: (data: Return | undefined) => Promise<void> | void, transformation?: (data: T) => Return, toData?: boolean, options?: ApiOptions, apiInstance?: ApiInstance): {
     loading: Ref<boolean, boolean>;
     send(request?: Request | undefined): Promise<Return | undefined>;
 };
 
-export declare function useApiGet<T, Request extends ApiFetch['request'] = ApiFetch['request'], Return extends ApiData<T> = ApiData<T>>(path?: RefOrNormal<string | undefined>, action?: (data: Return | undefined) => Promise<void> | void, transformation?: (data: T) => Return, toData?: boolean, options?: ApiOptions): {
+/**
+ * Use API get request.
+ *
+ * Использование API get запроса.
+ * @param path Path to the API endpoint / Путь к endpoint API
+ * @param action Action to perform after the request / Действие, выполняемое после запроса
+ * @param transformation Transformation function / Функция трансформации
+ * @param toData Extract 'data' field from response / Извлечь поле 'data' из ответа
+ * @param options Additional request options / Дополнительные опции запроса
+ * @param apiInstance Api instance / Экземпляр Api
+ * @returns Object with loading state and send method / Объект с состоянием загрузки и методом отправки
+ */
+export declare function useApiGet<T, Request extends ApiFetch['request'] = ApiFetch['request'], Return extends ApiData<T> = ApiData<T>>(path?: RefOrNormal<string | undefined>, action?: (data: Return | undefined) => Promise<void> | void, transformation?: (data: T) => Return, toData?: boolean, options?: ApiOptions, apiInstance?: ApiInstance): {
     loading: Ref<boolean, boolean>;
     send(request?: Request | undefined): Promise<Return | undefined>;
 };
@@ -1968,7 +2057,7 @@ export declare function useApiGet<T, Request extends ApiFetch['request'] = ApiFe
  * @param deleteRequest properties for DELETE request / параметры для DELETE запроса
  * @param action additional action to perform on mutations / дополнительное действие при мутациях
  */
-export declare function useApiManagementRef<Return extends ApiManagementValue, FormattersOptions extends FormattersOptionsList, Post extends Record<string, any>, Put extends Record<string, any>, Delete extends Record<string, any>, Type extends ApiManagementValue = Return, Item extends ArrayToItem<Return> = ArrayToItem<Return>, ItemFormatters extends FormattersListColumns<Item, FormattersOptions>[number] = FormattersListColumns<Item, FormattersOptions>[number], Columns extends SearchColumns<ItemFormatters> = []>(propsGet: ApiManagementGet<Return, Type>, formattersOptions?: FormattersOptions, searchOptions?: ApiManagementSearch<Item, Columns>, postRequest?: ApiManagementRequest<Post>, putRequest?: ApiManagementRequest<Put>, deleteRequest?: ApiManagementRequest<Delete>, action?: () => Promise<void> | void): {
+export declare function useApiManagementRef<Return extends ApiManagementValue, FormattersOptions extends FormattersOptionsList, Post extends Record<string, any>, Put extends Record<string, any>, Delete extends Record<string, any>, Type extends ApiManagementValue = Return, Item extends ArrayToItem<Return> = ArrayToItem<Return>, ItemFormatters extends FormattersListColumns<Item, FormattersOptions>[number] = FormattersListColumns<Item, FormattersOptions>[number], Columns extends SearchColumns<ItemFormatters> = []>(propsGet: ApiManagementGet<Return, Type>, formattersOptions?: FormattersOptions, searchOptions?: ApiManagementSearch<Item, Columns>, postRequest?: ApiManagementRequest<Post>, putRequest?: ApiManagementRequest<Put>, deleteRequest?: ApiManagementRequest<Delete>, action?: () => Promise<void> | void, apiInstance?: ApiInstance): {
     /** Is valid data (Computed) / Валидность данных (Computed) */
     isValid: ComputedRef<boolean>;
     /** List data (Computed) / Данные списка (Computed) */
@@ -2032,12 +2121,36 @@ export declare function useApiManagementRef<Return extends ApiManagementValue, F
     sendDelete: (request?: ApiFetch["request"]) => Promise<ApiData<Delete> | undefined>;
 };
 
-export declare function useApiPost<T, Request extends ApiFetch['request'] = ApiFetch['request'], Return extends ApiData<T> = ApiData<T>>(path?: RefOrNormal<string | undefined>, action?: (data: Return | undefined) => Promise<void> | void, transformation?: (data: T) => Return, toData?: boolean, options?: ApiOptions): {
+/**
+ * Use API post request.
+ *
+ * Использование API post запроса.
+ * @param path Path to the API endpoint / Путь к endpoint API
+ * @param action Action to perform after the request / Действие, выполняемое после запроса
+ * @param transformation Transformation function / Функция трансформации
+ * @param toData Extract 'data' field from response / Извлечь поле 'data' из ответа
+ * @param options Additional request options / Дополнительные опции запроса
+ * @param apiInstance Api instance / Экземпляр Api
+ * @returns Object with loading state and send method / Объект с состоянием загрузки и методом отправки
+ */
+export declare function useApiPost<T, Request extends ApiFetch['request'] = ApiFetch['request'], Return extends ApiData<T> = ApiData<T>>(path?: RefOrNormal<string | undefined>, action?: (data: Return | undefined) => Promise<void> | void, transformation?: (data: T) => Return, toData?: boolean, options?: ApiOptions, apiInstance?: ApiInstance): {
     loading: Ref<boolean, boolean>;
     send(request?: Request | undefined): Promise<Return | undefined>;
 };
 
-export declare function useApiPut<T, Request extends ApiFetch['request'] = ApiFetch['request'], Return extends ApiData<T> = ApiData<T>>(path?: RefOrNormal<string | undefined>, action?: (data: Return | undefined) => Promise<void> | void, transformation?: (data: T) => Return, toData?: boolean, options?: ApiOptions): {
+/**
+ * Use API put request.
+ *
+ * Использование API put запроса.
+ * @param path Path to the API endpoint / Путь к endpoint API
+ * @param action Action to perform after the request / Действие, выполняемое после запроса
+ * @param transformation Transformation function / Функция трансформации
+ * @param toData Extract 'data' field from response / Извлечь поле 'data' из ответа
+ * @param options Additional request options / Дополнительные опции запроса
+ * @param apiInstance Api instance / Экземпляр Api
+ * @returns Object with loading state and send method / Объект с состоянием загрузки и методом отправки
+ */
+export declare function useApiPut<T, Request extends ApiFetch['request'] = ApiFetch['request'], Return extends ApiData<T> = ApiData<T>>(path?: RefOrNormal<string | undefined>, action?: (data: Return | undefined) => Promise<void> | void, transformation?: (data: T) => Return, toData?: boolean, options?: ApiOptions, apiInstance?: ApiInstance): {
     loading: Ref<boolean, boolean>;
     send(request?: Request | undefined): Promise<Return | undefined>;
 };
@@ -2116,8 +2229,9 @@ export declare interface UseApiRef<R> {
  * @param conditions conditions for executing the request/ условия выполнения запроса
  * @param transformation transforms the received request/ преобразовывает полученный запрос
  * @param unmounted delete data from the cache/ удалить ли данные из кеша
+ * @param apiInstance Api instance / Экземпляр Api
  */
-export declare function useApiRef<R, T = R>(path?: RefOrNormal<string | undefined>, options?: ApiOptions, reactivity?: boolean, conditions?: RefType<boolean>, transformation?: (data: T) => ApiData<R>, unmounted?: boolean): UseApiRef<R>;
+export declare function useApiRef<R, T = R>(path?: RefOrNormal<string | undefined>, options?: ApiOptions, reactivity?: boolean, conditions?: RefType<boolean>, transformation?: (data: T) => ApiData<R>, unmounted?: boolean, apiInstance?: ApiInstance): UseApiRef<R>;
 
 /**
  * Use api request.
@@ -2129,9 +2243,10 @@ export declare function useApiRef<R, T = R>(path?: RefOrNormal<string | undefine
  * @param transformation Transformation function / Функция трансформации
  * @param toData Extract 'data' field from response / Извлечь поле 'data' из ответа
  * @param options Additional request options / Дополнительные опции запроса
+ * @param apiInstance Api instance / Экземпляр Api
  * @returns Object with loading state and send method / Объект с состоянием загрузки и методом отправки
  */
-export declare function useApiRequest<T, Request extends ApiFetch['request'] = ApiFetch['request'], Return extends ApiData<T> = ApiData<T>>(path?: RefOrNormal<string | undefined>, method?: ApiMethodItem, action?: (data: Return | undefined) => Promise<void> | void, transformation?: (data: T) => Return, toData?: boolean, options?: ApiOptions): {
+export declare function useApiRequest<T, Request extends ApiFetch['request'] = ApiFetch['request'], Return extends ApiData<T> = ApiData<T>>(path?: RefOrNormal<string | undefined>, method?: ApiMethodItem, action?: (data: Return | undefined) => Promise<void> | void, transformation?: (data: T) => Return, toData?: boolean, options?: ApiOptions, apiInstance?: ApiInstance): {
     loading: Ref<boolean, boolean>;
     /**
      * Send request.
@@ -2228,7 +2343,7 @@ export declare const useLazyRef: (options?: IntersectionObserverInit) => {
      * Получение отслеживаемого элемента.
      * @param element tracked element/ отслеживаемый элемент
      */
-    getItem(element: HTMLElement): LazyItem | undefined;
+    getItem(element: HTMLElement): LazyItem;
     /**
      * Adding an element for tracking.
      *
@@ -2266,27 +2381,67 @@ export declare function useLoadingRef(): ShallowRef<boolean, boolean>;
  */
 export declare const useMeta: () => Readonly<{
     meta: Meta;
+    /** Reactive page title (without suffix) / Реактивный заголовок страницы (без суффикса) */
     title: Ref<string, string>;
+    /** Reactive keywords meta tag / Реактивный мета-тег keywords */
     keyword: Ref<string, string>;
+    /** Reactive description meta tag / Реактивный мета-тег description */
     description: Ref<string, string>;
+    /** Reactive author meta tag / Реактивный мета-тег author */
     author: Ref<string, string>;
+    /** Reactive Open Graph / Twitter Card image URL / Реактивный URL изображения для Open Graph / Twitter Card */
     image: Ref<string, string>;
+    /** Reactive canonical URL / Реактивный канонический URL */
     canonical: Ref<string, string>;
+    /** Reactive robots meta tag directive / Реактивная директива мета-тега robots */
     robots: Ref<MetaRobots, MetaRobots>;
+    /** Reactive site name for Open Graph and Twitter Card / Реактивное название сайта для Open Graph и Twitter Card */
     siteName: Ref<string, string>;
+    /**
+     * Generates HTML string for all meta tags (for SSR).
+     *
+     * Генерирует HTML-строку для всех мета-тегов (для SSR).
+     */
     getHtmlMeta: () => string;
+    /**
+     * Sets the suffix for the page title.
+     *
+     * Устанавливает суффикс для заголовка страницы.
+     * @param suffix Suffix to set / Суффикс для установки
+     */
+    setSuffix: (suffix: string) => void;
 } & {
     init(): Readonly<{
         meta: Meta;
+        /** Reactive page title (without suffix) / Реактивный заголовок страницы (без суффикса) */
         title: Ref<string, string>;
+        /** Reactive keywords meta tag / Реактивный мета-тег keywords */
         keyword: Ref<string, string>;
+        /** Reactive description meta tag / Реактивный мета-тег description */
         description: Ref<string, string>;
+        /** Reactive author meta tag / Реактивный мета-тег author */
         author: Ref<string, string>;
+        /** Reactive Open Graph / Twitter Card image URL / Реактивный URL изображения для Open Graph / Twitter Card */
         image: Ref<string, string>;
+        /** Reactive canonical URL / Реактивный канонический URL */
         canonical: Ref<string, string>;
+        /** Reactive robots meta tag directive / Реактивная директива мета-тега robots */
         robots: Ref<MetaRobots, MetaRobots>;
+        /** Reactive site name for Open Graph and Twitter Card / Реактивное название сайта для Open Graph и Twitter Card */
         siteName: Ref<string, string>;
+        /**
+         * Generates HTML string for all meta tags (for SSR).
+         *
+         * Генерирует HTML-строку для всех мета-тегов (для SSR).
+         */
         getHtmlMeta: () => string;
+        /**
+         * Sets the suffix for the page title.
+         *
+         * Устанавливает суффикс для заголовка страницы.
+         * @param suffix Suffix to set / Суффикс для установки
+         */
+        setSuffix: (suffix: string) => void;
     }>;
     destroyExecute?(): void;
 }>;
@@ -2391,8 +2546,9 @@ export declare function useStorageRef<T>(name: string, defaultValue?: T | (() =>
  *
  * Получение переведенного текста по массиву ключей или строке с ключом.
  * @param names a string or an array with keys/ строка или массив с ключами
+ * @param translateInstance a translate instance/ экземпляр перевода
  */
-export declare function useTranslateRef<T extends (string | string[])[]>(names: T): ShallowRef<TranslateList<T>>;
+export declare function useTranslateRef<T extends (string | string[])[]>(names: T, translateInstance?: TranslateInstance): ShallowRef<TranslateList<T>>;
 
 
 export * from "@dxtmisha/functional-basic";