@dxtmisha/functional 1.15.13 → 1.15.14

package/dist/composables/ref/useApiManagementRef.d.ts

@@ -1,161 +0,0 @@
-import { Ref, ComputedRef } from 'vue';
-import { FormattersOptionsList, ApiData, ApiInstance, ArrayToItem, SearchColumns, SearchFormatList, FormattersListColumns, ApiFetch, ApiDataValidation, ApiErrorItem } from '@dxtmisha/functional-basic';
-import { ApiManagementGet, ApiManagementRequest, ApiManagementSearch, ApiManagementValue } from '../../types/apiTypes';
-/**
- * A powerful composable for comprehensive API request orchestration.
- * It centrally manages data loading (GET), list formatting, client-side searching,
- * and mutations (POST, PUT, DELETE) through a single reactive interface.
- *
- * Мощный композабл для комплексной оркестрации API-запросов.
- * Он централизованно управляет загрузкой данных (GET), форматированием списков,
- * клиентским поиском и мутациями (POST, PUT, DELETE) через единый реактивный интерфейс.
- *
- * @template Return type of data returned by the API / тип данных, возвращаемых API
- * @template FormattersOptions optional formatting rules / опциональные правила форматирования
- * @template Post data type for POST creation request / тип данных для POST-запроса создания
- * @template Put data type for PUT update request / тип данных для PUT-запроса обновления
- * @template Delete data type for DELETE removal request / тип данных для DELETE-запроса удаления
- * @template Type original data type (before transformation) / тип исходных данных (до трансформации)
- * @template Item type of a single item in the data list / тип одного элемента из списка данных
- * @template ItemFormatters item type after formatters are applied / тип элемента после применения форматировщиков
- * @template Columns search columns derived from formatting / колонки, по которым производится поиск
- *
- * @param propsGet main GET request settings (path, reactivity, skeleton, etc.) / настройки главного GET-запроса
- * @param formattersOptions optional reactive formatting rules / правила для реактивного форматирования данных
- * @param searchOptions optional client-side search settings / настройки для клиентского поиска по списку
- * @param postRequest optional POST mutation settings / настройки для POST-запроса создания
- * @param putRequest optional PUT mutation settings / настройки для PUT-запроса обновления
- * @param deleteRequest optional DELETE mutation settings / настройки для DELETE-запроса удаления
- * @param action common callback executed after any successful mutation / общий коллбэк после любой успешной мутации
- * @param apiInstance API instance for requests (defaults to Api.getItem()) / экземпляр API для выполнения запроса
- *
- * @returns reactive API management interface / реактивный интерфейс управления API
- *
- * @note This hook is recommended to be used in tandem with `executeUse` for centralized state management.
- * By wrapping `useApiManagementRef` in `executeUseProvide` or `executeUseGlobal`, you can ensure
- * a single source of truth across the component tree or the entire application.
- *
- * Рекомендуется использовать этот хук в тандеме с `executeUse` для централизованного управления состоянием.
- * Обернув `useApiManagementRef` в `executeUseProvide` или `executeUseGlobal`, вы обеспечите
- * единый источник истины в дереве компонентов или во всем приложении.
- *
- * @remarks
- * Data formatting guidelines for `formattersOptions`:
- * - **Recommended for formatting:** Numbers that represent values (prices, counts), dates, currency, units, and statuses.
- * - **Not recommended for formatting:** Technical identifiers such as ID, UUID, account numbers (if used for logic), types, or internal codes.
- *
- * Рекомендации по форматированию данных для `formattersOptions`:
- * - **Рекомендуется для форматирования:** Числа, представляющие значения (цены, количества), даты, валюта, единицы измерения и статусы.
- * - **Не рекомендуется для форматирования:** Технические идентификаторы, такие как ID, UUID, номера счетов (если они используются для логики), типы или внутренние коды.
- *
- * @example
- * // 1. Comprehensive API orchestration/ Комплексная оркестрация API
- * const products = useApiManagementRef(
- *   {
- *     path: '/api/v1/products',
- *     skeleton: () => Array(5).fill({ id: 0, name: 'Loading...', price: 0 })
- *   },
- *   {
- *     // Formatters for display/ Форматтеры для отображения
- *     price: (v) => `${v} USD`,
- *     created_at: (v) => new Date(v).toLocaleDateString()
- *   },
- *   {
- *     // Client-side search setup/ Настройка поиска на стороне клиента
- *     columns: ['name', 'category']
- *   },
- *   { path: '/api/v1/products' }, // POST (create)
- *   { path: (data) => `/api/v1/products/${data.id}` }, // PUT (update)
- *   { path: (data) => `/api/v1/products/${data.id}` }  // DELETE (remove)
- * );
- *
- * // Accessing data/ Доступ к данным:
- * // products.list.value -> processed, formatted, and searched list
- * // products.sendPost({ name: 'New Product', price: 100 }) -> execute mutation
- */
-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): {
-    /** Whether data passed the `typeData` check / `true`, если данные прошли проверку `typeData` */
-    isValid: ComputedRef<boolean>;
-    /** Status of response contract validation / Статус валидации контракта ответа */
-    isResponseContractValid: ComputedRef<boolean>;
-    /** Result of response validation / Результат валидации ответа */
-    responseValidationResult: ComputedRef< ApiDataValidation | undefined>;
-    /** Processed data array (supports Skeleton, formatters, and search) / Обработанный массив данных (поддерживает Skeleton, форматтеры и поиск) */
-    list: ComputedRef<SearchFormatList<ItemFormatters, Columns>>;
-    /** Raw reactive data from `useApiRef` / «Сырые» реактивные данные из `useApiRef` */
-    readonly data: ComputedRef<ApiData<Return> | undefined>;
-    /** Current error from request / Текущая ошибка ответа */
-    errorItem: ComputedRef< ApiErrorItem | undefined>;
-    /** Current number of items in `list` (changes with search) / Текущее количество элементов в `list` (меняется при поиске) */
-    readonly length: ComputedRef<number>;
-    /** Total number of items in raw `data` / Общее количество элементов в исходном `data` */
-    lengthData: ComputedRef<number>;
-    /** Initial loading flag (true when no data yet) / Флаг первичной загрузки (когда данных еще нет) */
-    starting: ComputedRef<boolean>;
-    /** Active read process flag / Флаг активного процесса чтения данных */
-    reading: Ref<boolean, boolean>;
-    /** Loading state for the main GET request / Общее состояние загрузки главного GET-запроса */
-    loading: Ref<boolean, boolean>;
-    /** Loading state during search processing / Состояние загрузки в процессе поиска */
-    loadingSearch: Ref<boolean, boolean> | undefined;
-    /** Loading state for POST mutation / Состояние загрузки для POST мутации */
-    loadingPost: Ref<boolean, boolean> | undefined;
-    /** Loading state for PUT mutation / Состояние загрузки для PUT мутации */
-    loadingPut: Ref<boolean, boolean> | undefined;
-    /** Loading state for DELETE mutation / Состояние загрузки для DELETE мутации */
-    loadingDelete: Ref<boolean, boolean> | undefined;
-    /** Whether search is currently active / Активен ли поиск (есть ли поисковый запрос) */
-    isSearch: ComputedRef<boolean> | undefined;
-    /** Reactive search string (Proxy to `searchOptions.value`) / Реактивная строка поиска (Proxy к переданному `searchOptions.value`) */
-    search: Ref<string>;
-    /**
-     * Manual initialization
-     *
-     * Ручная инициализация
-     */
-    init: () => void;
-    /**
-     * SSR initialization
-     *
-     * Инициализация SSR
-     */
-    initSsr: () => void;
-    /**
-     * Default reset
-     *
-     * Сброс по умолчанию
-     */
-    /**
-     * Force reset the GET request and clear state.
-     *
-     * Принудительный перезапуск GET-запроса и очистка состояния.
-     */
-    reset: () => Promise<void>;
-    /**
-     * Abort the current network request.
-     *
-     * Прекращение текущего сетевого запроса.
-     */
-    abort: () => void;
-    /**
-     * Execute POST mutation request.
-     *
-     * Выполнить POST запрос мутации.
-     * @param request request data / данные запроса
-     */
-    sendPost: (request?: ApiFetch["request"]) => Promise<ApiData<Post> | undefined>;
-    /**
-     * Execute PUT mutation request.
-     *
-     * Выполнить PUT запрос мутации.
-     * @param request request data / данные запроса
-     */
-    sendPut: (request?: ApiFetch["request"]) => Promise<ApiData<Put> | undefined>;
-    /**
-     * Execute DELETE mutation request.
-     *
-     * Выполнить DELETE запрос мутации.
-     * @param request request data / данные запроса
-     */
-    sendDelete: (request?: ApiFetch["request"]) => Promise<ApiData<Delete> | undefined>;
-};

package/dist/composables/ref/useApiPost.d.ts

@@ -1,23 +0,0 @@
-import { ApiData, ApiFetch } from '@dxtmisha/functional-basic';
-import { UseApiRequestSetup } from './useApiRequest';
-import { Ref } from 'vue';
-/**
- * Setup interface for API POST request.
- *
- * Интерфейс настроек для POST запроса API.
- */
-export interface UseApiPostSetup<T, Request extends ApiFetch['request'] = ApiFetch['request'], Return extends ApiData<T> = ApiData<T>> extends Omit<UseApiRequestSetup<T, Request, Return>, 'method'> {
-}
-/**
- * Use API post request.
- * This is a convenient wrapper over `useApiRequest` that pre-fills the POST method.
- *
- * Использование API post запроса.
- * Это удобная обертка над `useApiRequest`, которая предустанавливает метод POST.
- * @param setup Configured parameters as a single object / Настроенные параметры в виде единого объекта
- * @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>>(setup: UseApiPostSetup<T, Request, Return>): {
-    loading: Ref<boolean, boolean>;
-    send(request?: Request | undefined): Promise<Return | undefined>;
-};

package/dist/composables/ref/useApiPut.d.ts

@@ -1,23 +0,0 @@
-import { ApiData, ApiFetch } from '@dxtmisha/functional-basic';
-import { UseApiRequestSetup } from './useApiRequest';
-import { Ref } from 'vue';
-/**
- * Setup interface for API PUT request.
- *
- * Интерфейс настроек для PUT запроса API.
- */
-export interface UseApiPutSetup<T, Request extends ApiFetch['request'] = ApiFetch['request'], Return extends ApiData<T> = ApiData<T>> extends Omit<UseApiRequestSetup<T, Request, Return>, 'method'> {
-}
-/**
- * Use API put request.
- * This is a convenient wrapper over `useApiRequest` that pre-fills the PUT method.
- *
- * Использование API put запроса.
- * Это удобная обертка над `useApiRequest`, которая предустанавливает метод PUT.
- * @param setup Configured parameters as a single object / Настроенные параметры в виде единого объекта
- * @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>>(setup: UseApiPutSetup<T, Request, Return>): {
-    loading: Ref<boolean, boolean>;
-    send(request?: Request | undefined): Promise<Return | undefined>;
-};

package/dist/composables/ref/useApiRef.d.ts

@@ -1,159 +0,0 @@
-import { ComputedRef, Ref } from 'vue';
-import { ApiInstance, ApiData, ApiDataValidation, ApiErrorStorageList, ApiErrorItem } from '@dxtmisha/functional-basic';
-import { ApiOptions } from '../../types/apiTypes';
-import { RefOrNormal, RefType } from '../../types/refTypes';
-/**
- * Use api ref return type.
- *
- * Тип возвращаемого значения для useApiRef.
- */
-export interface UseApiRef<R> {
-    /** Reactive data (Computed) / Реактивные данные (Computed) */
-    data: ComputedRef<ApiData<R> | undefined>;
-    /** Item (Ref) / Элемент (Ref) */
-    item: Ref<ApiData<R> | undefined>;
-    /** Error item (Computed) / Элемент ошибки (Computed) */
-    errorItem: ComputedRef<ApiErrorItem | undefined>;
-    /**
-     * Status of response contract validation.
-     *
-     * Статус валидации контракта ответа.
-     */
-    isResponseContractValid: ComputedRef<boolean>;
-    /**
-     * Result of response validation.
-     *
-     * Результат валидации ответа.
-     */
-    responseValidationResult: ComputedRef<ApiDataValidation | undefined>;
-    /** Length of the list (Computed) / Длина списка (Computed) */
-    length: ComputedRef<number>;
-    /** Start request flag (true if no data yet) / Флаг начала запроса (true если еще нет данных) */
-    starting: ComputedRef<boolean>;
-    /** Request load flag / Флаг загрузки запроса */
-    loading: Ref<boolean>;
-    /** Active reading flag / Флаг активного чтения */
-    reading: Ref<boolean>;
-    /** Checks if the request is starting (true if no data yet) / Проверяет, начинается ли запрос (true, если данных еще нет) */
-    isStarting(): boolean;
-    /**
-     * Checks if the request is currently loading.
-     *
-     * Проверяет, загружается ли запрос в данный момент.
-     */
-    isLoading(): boolean;
-    /**
-     * Checks if the request is currently reading.
-     *
-     * Проверяет, читается ли запрос в данный момент.
-     */
-    isReading(): boolean;
-    /**
-     * Gets the current item data.
-     *
-     * Получает текущие данные элемента.
-     */
-    getItem(): ApiData<R> | undefined;
-    /**
-     * Manual initialization
-     *
-     * Ручная инициализация
-     */
-    init(): void;
-    /**
-     * SSR initialization
-     *
-     * Инициализация SSR
-     */
-    initSsr(): void;
-    /**
-     * Default reset.
-     *
-     * Сброс по умолчанию.
-     */
-    reset(): Promise<void>;
-    /**
-     * Stop request.
-     *
-     * Остановка запроса.
-     */
-    stop(): void;
-    /**
-     * Abort request.
-     *
-     * Отмена запроса.
-     */
-    abort(): void;
-}
-/**
- * Main reactive composable for working with API requests in Vue.
- * Automatically handles SSR, reactivity, caching, error storage, data validation, and transformation.
- *
- * Главный реактивный composable для работы с API запросами во Vue.
- * Автоматически обрабатывает SSR, реактивность, кэширование, хранение ошибок, валидацию данных и трансформацию.
- *
- * @example
- * ```typescript
- * import { Schema as S } from '@effect/schema'
- * import { useApiRef } from '@dxtmisha/functional'
- *
- * // Define a schema using @effect/schema
- * const userSchema = S.Struct({ id: S.Number, name: S.String })
- *
- * const { data, loading, errorItem, isResponseContractValid } = useApiRef(
- *   '/users/1',
- *   { method: 'GET' },
- *   true, // reactivity
- *   undefined, // conditions
- *   (data) => ({ ...data, isTransformed: true }), // transformation
- *   (data) => { // validateResponseContract
- *     try {
- *       return { status: 'success', data: S.decodeUnknownSync(userSchema)(data) }
- *     } catch (e) {
- *       return { status: 'error', errors: e }
- *     }
- *   },
- *   [ // errorContract (ApiErrorStorageList)
- *     {
- *       status: 404,
- *       message: 'User not found'
- *     }
- *   ]
- * )
- * ```
- *
- * @param path path to request (can be a Ref or Getter) / путь к запросу (может быть Ref или Getter)
- * @param options data for the request (headers, method, etc.) / данные для запроса (заголовки, метод и т.д.)
- * @param reactivity should reactivity be enabled (automatically re-fetch on deps change) /
- * включить ли реактивность (автоматически повторять запрос при изменении зависимостей)
- * @param conditions conditions for executing the request (request will wait until true) /
- * условия выполнения запроса (запрос будет ждать пока не станет true)
- * @param transformation transforms the received response data / преобразовывает полученные данные ответа
- * @param validateResponseContract function to validate response data contract. Used to ensure that the API
- * response matches the expected structure. Highly recommended to use with `@effect/schema`.
- * It should return `ApiDataValidation` containing a `status` ('success' or 'error')
- * and the parsed data or errors. /
- * Функция для проверки контракта данных ответа. Используется для гарантии того, что ответ API соответствует
- * ожидаемой структуре. Настоятельно рекомендуется использовать с `@effect/schema`. Должна возвращать объект
- * `ApiDataValidation`, содержащий `status` ('success' или 'error') и распарсенные данные или ошибки.
- * @param errorContract array of expected error contracts for the request (`ApiErrorStorageList`).
- * Highly recommended to add if there is information about possible request errors. Allows you to predefine
- * possible errors (by code, status, or custom validation). If an error occurs matching one of these contracts,
- * it will be automatically processed and made available via the `errorItem` computed property. /
- * Массив контрактов ожидаемых ошибок для запроса (`ApiErrorStorageList`). Желательно добавлять, если есть
- * информация о возможных ошибках запроса. Позволяет заранее описать возможные ошибки (по коду, статусу или
- * кастомной валидации). Если возникает ошибка, совпадающая с одним из контрактов, она автоматически
- * обрабатывается и становится доступной через вычисляемое свойство `errorItem` для удобного отображения в UI.
- * @param unmounted whether to stop the request and clear data from cache when component is unmounted /
- * нужно ли останавливать запрос и удалять данные из кеша при размонтировании компонента
- * @param apiInstance Api instance (defaults to global Api instance) /
- * Экземпляр Api (по умолчанию используется глобальный экземпляр Api)
- */
-export declare function useApiRef<R, T = R>(path?: RefOrNormal<string | undefined>, options?: ApiOptions, reactivity?: boolean, conditions?: RefType<boolean>, transformation?: (data: T, isResponseContractValid?: ApiDataValidation) => ApiData<R>, validateResponseContract?: (data: T) => ApiDataValidation, errorContract?: ApiErrorStorageList, unmounted?: boolean, apiInstance?: ApiInstance): UseApiRef<R>;
-/**
- * Defines global conditions for the API request.
- *
- * Определяет глобальные условия для API запроса.
- * @param conditions conditions for executing the request/ условия выполнения запроса
- */
-export declare const setApiRefGlobalConditions: (conditions: RefType<any>) => void;

package/dist/composables/ref/useApiRequest.d.ts

@@ -1,105 +0,0 @@
-import { ApiInstance, ApiMethodItem, ApiData, ApiFetch, ApiErrorStorageList, ApiDataValidation } from '@dxtmisha/functional-basic';
-import { ApiOptions } from '../../types/apiTypes';
-import { RefOrNormal } from '../../types/refTypes';
-import { Ref } from 'vue';
-/**
- * Setup interface for API request.
- *
- * Интерфейс настроек для запроса API.
- */
-export interface UseApiRequestSetup<T, Request extends ApiFetch['request'] = ApiFetch['request'], Return extends ApiData<T> = ApiData<T>> {
-    /**
-     * Path to the API endpoint. Can be a reactive Ref or a normal string.
-     *
-     * Путь к endpoint API. Может быть реактивным Ref или обычной строкой.
-     */
-    path?: RefOrNormal<string | undefined>;
-    /**
-     * HTTP method used for the request (e.g., GET, POST, PUT, DELETE). Defaults to POST.
-     *
-     * HTTP метод, используемый для запроса (например, GET, POST, PUT, DELETE). По умолчанию POST.
-     */
-    method?: ApiMethodItem;
-    /**
-     * Action/callback to perform after the request has successfully completed.
-     * Can return a Promise for asynchronous operations.
-     *
-     * Действие/колбэк, выполняемое после успешного завершения запроса.
-     * Может возвращать Promise для асинхронных операций.
-     */
-    action?: (data: Return | undefined) => Promise<void> | void;
-    /**
-     * Transformation function that modifies the raw response data before returning it.
-     *
-     * Функция трансформации, которая преобразует исходные данные ответа перед их возвратом.
-     */
-    transformation?: (data: T) => Return;
-    /**
-     * Function to validate the request payload contract. Used to ensure that the API
-     * request payload matches the expected structure.
-     *
-     * Функция для проверки контракта данных запроса. Используется для гарантии того,
-     * что отправляемая полезная нагрузка запроса API соответствует ожидаемой структуре.
-     */
-    validateRequestContract?: (data: Request) => ApiDataValidation & Return;
-    /**
-     * Function to validate response data contract. Used to ensure that the API
-     * response matches the expected structure. Highly recommended to use with `@effect/schema`.
-     * It should return `ApiDataValidation` containing a `status` ('success' or 'error')
-     * and the parsed data or errors.
-     *
-     * Функция для проверки контракта данных ответа. Используется для гарантии того, что ответ API соответствует
-     * ожидаемой структуре. Настоятельно рекомендуется использовать с `@effect/schema`. Должна возвращать объект
-     * `ApiDataValidation`, содержащий `status` ('success' или 'error') и распарсенные данные или ошибки.
-     */
-    validateResponseContract?: (data: T) => ApiDataValidation & Return;
-    /**
-     * Array of expected error contracts for the request (`ApiErrorStorageList`).
-     * Highly recommended to add if there is information about possible request errors. Allows you to predefine
-     * possible errors (by code, status, or custom validation) which will be centrally processed by the application.
-     *
-     * Массив контрактов ожидаемых ошибок для запроса (`ApiErrorStorageList`). Желательно добавлять, если есть
-     * информация о возможных ошибках запроса. Позволяет заранее описать возможные ошибки (по коду, статусу или
-     * кастомной валидации) для централизованной обработки в приложении.
-     */
-    errorContract?: ApiErrorStorageList;
-    /**
-     * If true, extracts the nested 'data' field from the response object instead of returning the raw envelope.
-     * Defaults to true.
-     *
-     * Если true, извлекает вложенное поле 'data' из объекта ответа вместо возврата исходного конверта.
-     * По умолчанию true.
-     */
-    toData?: boolean;
-    /**
-     * Additional request options (headers, query params, etc.).
-     *
-     * Дополнительные опции запроса (заголовки, параметры запроса и т.д.).
-     */
-    options?: ApiOptions;
-    /**
-     * Custom Api instance to execute the request on. Defaults to global Api singleton instance.
-     *
-     * Кастомный экземпляр класса Api для выполнения запроса. По умолчанию используется глобальный синглтон Api.
-     */
-    apiInstance?: ApiInstance;
-}
-/**
- * Use api request.
- *
- * Использование запроса api.
- * @param setup Configured parameters as a single object / Настроенные параметры в виде единого объекта
- * @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, method, action, transformation, validateRequestContract, validateResponseContract, errorContract, toData, options, apiInstance }: UseApiRequestSetup<T, Request, Return>): {
-    /** Loading state / Состояние загрузки */
-    loading: Ref<boolean, boolean>;
-    /**
-     * Send request.
-     *
-     * Отправка запроса.
-     * @param request Request data / Данные запроса
-     * @returns Response data / Данные ответа
-     */
-    send(request?: Request): Promise<Return | undefined>;
-};

package/dist/composables/ref/useBroadcastValueRef.d.ts

@@ -1,11 +0,0 @@
-import { Ref } from 'vue';
-type BroadcastValueItem<T> = T | string | undefined;
-/**
- * Creates a reactive variable to manage data between browser tabs.
- *
- * Создает реактивную переменную для управления данными между вкладками браузера.
- * @param name value name/ название значения
- * @param defaultValue default value/ значение по умолчанию
- */
-export declare function useBroadcastValueRef<T>(name: string, defaultValue?: T | string | (() => (T | string))): Ref<BroadcastValueItem<T>>;
-export {};

package/dist/composables/ref/useCookieRef.d.ts

@@ -1,11 +0,0 @@
-import { Ref } from 'vue';
-import { CookieOptions } from '@dxtmisha/functional-basic';
-/**
- * Creates a reactive variable to manage cookies.
- *
- * Создает реактивную переменную для управления cookie.
- * @param name cookie name / название cookie
- * @param defaultValue value or function to change data / значение или функция для изменения данных
- * @param options additional parameters / дополнительные параметры
- */
-export declare function useCookieRef<T>(name: string, defaultValue?: T | string | (() => (T | string)), options?: CookieOptions): Ref<T | string | undefined>;

package/dist/composables/ref/useFormattersRef.d.ts

@@ -1,21 +0,0 @@
-import { FormattersListProp, FormattersOptionsList, FormattersReturn } from '@dxtmisha/functional-basic';
-import { RefType } from '../../types/refTypes';
-import { ComputedRef } from 'vue';
-/**
- * Composable for reactive formatting of data lists based on specified rules for each property. /
- * Композабл для реактивного форматирования списков данных на основе заданных правил для каждого свойства.
- * @param list source data list (Ref or ComputedRef) / исходный список данных (Ref или ComputedRef)
- * @param options formatting settings for each property / настройки форматирования для каждого свойства
- */
-export declare function useFormattersRef<Options extends FormattersOptionsList = FormattersOptionsList, List extends FormattersListProp = FormattersListProp>(list: RefType<List | undefined>, options: Options): {
-    /**
-     * Formatted data list (ComputedRef) /
-     * Отформатированный список данных (ComputedRef)
-     */
-    listFormat: ComputedRef<FormattersReturn<List, Options>>;
-    /**
-     * Returns the count of records in the list (ComputedRef) /
-     * Возвращает количество записей в списке (ComputedRef)
-     */
-    length: ComputedRef<number>;
-};

package/dist/composables/ref/useGeoIntlRef.d.ts

@@ -1,14 +0,0 @@
-import { GeoIntlRef } from '../../classes/ref/GeoIntlRef';
-/**
- * Returns a class object for working with data formatting.
- *
- * Возвращает объект класса для работы с форматированием данных.
- *
- * @remarks
- * Avoid using this reactive composable if reactive updates are not required.
- * For non-reactive formatting, use the standard `GeoIntl` class from `@dxtmisha/functional-basic`.
- *
- * Старайтесь избегать этого хука, если не требуется реактивная переменная.
- * Для нереактивного форматирования используйте обычный `GeoIntl` из `@dxtmisha/functional-basic`.
- */
-export declare function useGeoIntlRef(): GeoIntlRef;

package/dist/composables/ref/useGeoUnitRef.d.ts

@@ -1,7 +0,0 @@
-import { GeoUnitRef } from '../../classes/ref/GeoUnitRef';
-/**
- * Returns a class object for working with unit formatting and automatic conversions.
- *
- * Возвращает объект класса для работы с форматированием единиц измерения и автоматической конвертацией.
- */
-export declare function useGeoUnitRef(): GeoUnitRef;

package/dist/composables/ref/useHashRef.d.ts

@@ -1,9 +0,0 @@
-import { ShallowRef } from 'vue';
-/**
- * Creates a reactive variable to manage the hash.
- *
- * Создает реактивную переменную для управления хэшем.
- * @param name value name / название значения
- * @param defaultValue default value / значение по умолчанию
- */
-export declare function useHashRef<T>(name: string, defaultValue?: T | (() => T)): ShallowRef<T>;

package/dist/composables/ref/useLazyItemByMarginRef.d.ts

@@ -1,24 +0,0 @@
-import { useLazyRef, LazyItem } from './useLazyRef';
-import { RefType } from '../../types/refTypes';
-import { ShallowRef } from 'vue';
-export type LazyItemByMargin = {
-    rootMargin: string;
-    item: ReturnType<typeof useLazyRef>;
-};
-/**
- * Hook for initializing the tracking of an element's appearance on the screen by margin.
- *
- * Хук для инициализации отслеживания появления элемента на экране по отступу.
- * @param element element for tracking/ элемента для отслеживания
- * @param rootMargin root margin for IntersectionObserver/ отступ для IntersectionObserver
- */
-export declare const useLazyItemByMarginRef: (element: RefType<HTMLElement | undefined>, rootMargin?: string) => {
-    /** Lazy item status/ Статус ленивого элемента */
-    lazyItemStatus: ShallowRef<boolean, boolean>;
-    /**
-     * Getting a tracked lazy item.
-     *
-     * Получение отслеживаемого ленивого элемента.
-     */
-    readonly lazyItem: LazyItem | undefined;
-};

package/dist/composables/ref/useLazyRef.d.ts

@@ -1,42 +0,0 @@
-import { Ref, ShallowRef } from 'vue';
-export type LazyItem = {
-    status: ShallowRef<boolean>;
-    ratio: ShallowRef<number>;
-    entry: ShallowRef<IntersectionObserverEntry | undefined>;
-    stopWatch: () => void;
-};
-export type LazyList = Record<string, LazyItem>;
-/**
- * Hook for initializing the tracking of an element's appearance on the screen.
- *
- * Хук для инициализации отслеживания появления элемента на экране.
- */
-export declare const useLazyRef: (options?: IntersectionObserverInit) => {
-    intersectionObserver: IntersectionObserver | undefined;
-    /**
-     * Getting a tracked element.
-     *
-     * Получение отслеживаемого элемента.
-     * @param element tracked element/ отслеживаемый элемент
-     */
-    getItem(element?: HTMLElement): LazyItem | undefined;
-    /**
-     * Adding an element for tracking.
-     *
-     * Добавление элемента для отслеживания.
-     * @param element element for tracking/ элемента для отслеживания
-     */
-    addLazyItem(element: Ref<HTMLElement | undefined>): ShallowRef<boolean, boolean>;
-    /**
-     * Removing an element from tracking.
-     *
-     * Удаление элемента из отслеживания.
-     */
-    removeLazyItem: (element?: HTMLElement) => void;
-    /**
-     * Removing all elements from tracking.
-     *
-     * Удаление всех элементов из отслеживания.
-     */
-    disconnectLazy: () => void | undefined;
-};

package/dist/composables/ref/useLoadingRef.d.ts

@@ -1,7 +0,0 @@
-import { ShallowRef } from 'vue';
-/**
- * Returns the loading status.
- *
- * Возвращает статус загрузки.
- */
-export declare function useLoadingRef(): ShallowRef<boolean, boolean>;