@dxtmisha/functional 1.11.6 → 1.11.7

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

@@ -0,0 +1,42 @@
+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;
+    /**
+     * 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

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

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

@@ -0,0 +1,223 @@
+import { MetaRobots, MetaStatic } from '@dxtmisha/functional-basic';
+import { Ref } from 'vue';
+/**
+ * Vue composable for reactive meta tags management with automatic DOM synchronization.
+ * Uses singleton pattern - all components share the same meta state.
+ *
+ * Vue композабл для реактивного управления мета-тегами с автоматической синхронизацией DOM.
+ * Использует паттерн singleton - все компоненты используют одно состояние мета-тегов.
+ */
+export declare const useMeta: () => Readonly<{
+    meta: typeof MetaStatic;
+    /** 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;
+    /**
+     * Synchronizes all reactive values with the current state of MetaStatic.
+     *
+     * Синхронизирует все реактивные значения с текущим состоянием MetaStatic.
+     */
+    sync: () => void;
+    /**
+     * Updates MetaStatic values with current reactive state.
+     *
+     * Обновляет значения MetaStatic текущим реактивным состоянием.
+     */
+    update: () => void;
+    /**
+     * Updates MetaStatic values if the current environment is SSR (not a DOM runtime).
+     *
+     * Обновляет значения MetaStatic, если текущая среда — SSR (не DOM-среда).
+     */
+    updateSsr: () => void;
+    /**
+     * Sets the page title.
+     *
+     * Устанавливает заголовок страницы.
+     * @param value Title to set / Заголовок для установки
+     */
+    setTitle: (value: string) => void;
+    /**
+     * Sets the keywords meta tag.
+     *
+     * Устанавливает мета-тег keywords.
+     * @param value Keywords to set / Ключевые слова для установки
+     */
+    setKeywords: (value: string) => void;
+    /**
+     * Sets the description meta tag.
+     *
+     * Устанавливает мета-тег description.
+     * @param value Description to set / Описание для установки
+     */
+    setDescription: (value: string) => void;
+    /**
+     * Sets the author meta tag.
+     *
+     * Устанавливает мета-тег author.
+     * @param value Author to set / Автор для установки
+     */
+    setAuthor: (value: string) => void;
+    /**
+     * Sets the Open Graph / Twitter Card image URL.
+     *
+     * Устанавливает URL изображения для Open Graph / Twitter Card.
+     * @param value Image URL to set / URL изображения для установки
+     */
+    setImage: (value: string) => void;
+    /**
+     * Sets the canonical URL.
+     *
+     * Устанавливает канонический URL.
+     * @param value Canonical URL to set / Канонический URL для установки
+     */
+    setCanonical: (value: string) => void;
+    /**
+     * Sets the robots meta tag directive.
+     *
+     * Устанавливает директиву мета-тега robots.
+     * @param value Robots directive to set / Директива robots для установки
+     */
+    setRobots: (value: MetaRobots) => void;
+    /**
+     * Sets the site name for Open Graph and Twitter Card.
+     *
+     * Устанавливает название сайта для Open Graph и Twitter Card.
+     * @param value Site name to set / Название сайта для установки
+     */
+    setSiteName: (value: string) => void;
+    /**
+     * Sets the suffix for the page title.
+     *
+     * Устанавливает суффикс для заголовка страницы.
+     * @param suffix Suffix to set / Суффикс для установки
+     */
+    setSuffix: (suffix: string) => typeof MetaStatic;
+} & {
+    init(): Readonly<{
+        meta: typeof MetaStatic;
+        /** 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;
+        /**
+         * Synchronizes all reactive values with the current state of MetaStatic.
+         *
+         * Синхронизирует все реактивные значения с текущим состоянием MetaStatic.
+         */
+        sync: () => void;
+        /**
+         * Updates MetaStatic values with current reactive state.
+         *
+         * Обновляет значения MetaStatic текущим реактивным состоянием.
+         */
+        update: () => void;
+        /**
+         * Updates MetaStatic values if the current environment is SSR (not a DOM runtime).
+         *
+         * Обновляет значения MetaStatic, если текущая среда — SSR (не DOM-среда).
+         */
+        updateSsr: () => void;
+        /**
+         * Sets the page title.
+         *
+         * Устанавливает заголовок страницы.
+         * @param value Title to set / Заголовок для установки
+         */
+        setTitle: (value: string) => void;
+        /**
+         * Sets the keywords meta tag.
+         *
+         * Устанавливает мета-тег keywords.
+         * @param value Keywords to set / Ключевые слова для установки
+         */
+        setKeywords: (value: string) => void;
+        /**
+         * Sets the description meta tag.
+         *
+         * Устанавливает мета-тег description.
+         * @param value Description to set / Описание для установки
+         */
+        setDescription: (value: string) => void;
+        /**
+         * Sets the author meta tag.
+         *
+         * Устанавливает мета-тег author.
+         * @param value Author to set / Автор для установки
+         */
+        setAuthor: (value: string) => void;
+        /**
+         * Sets the Open Graph / Twitter Card image URL.
+         *
+         * Устанавливает URL изображения для Open Graph / Twitter Card.
+         * @param value Image URL to set / URL изображения для установки
+         */
+        setImage: (value: string) => void;
+        /**
+         * Sets the canonical URL.
+         *
+         * Устанавливает канонический URL.
+         * @param value Canonical URL to set / Канонический URL для установки
+         */
+        setCanonical: (value: string) => void;
+        /**
+         * Sets the robots meta tag directive.
+         *
+         * Устанавливает директиву мета-тега robots.
+         * @param value Robots directive to set / Директива robots для установки
+         */
+        setRobots: (value: MetaRobots) => void;
+        /**
+         * Sets the site name for Open Graph and Twitter Card.
+         *
+         * Устанавливает название сайта для Open Graph и Twitter Card.
+         * @param value Site name to set / Название сайта для установки
+         */
+        setSiteName: (value: string) => void;
+        /**
+         * Sets the suffix for the page title.
+         *
+         * Устанавливает суффикс для заголовка страницы.
+         * @param suffix Suffix to set / Суффикс для установки
+         */
+        setSuffix: (suffix: string) => typeof MetaStatic;
+    }>;
+    destroyExecute?(): void;
+}>;

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

@@ -0,0 +1,28 @@
+import { Ref, ComputedRef } from 'vue';
+import { NumberOrString } from '@dxtmisha/functional-basic';
+import { ConstrBind } from '../../types/constructorTypes';
+import { ListDataBasic } from '../../types/listTypes';
+import { RefType } from '../../types/refTypes';
+/**
+ * Managing a list of links for the router.
+ *
+ * Управление списком ссылок для роутера.
+ * @param list list of items / список элементов
+ * @param selected selected item / выбранный элемент
+ * @param hasTo has to / имеет to
+ */
+export declare const useRouterList: <T extends ListDataBasic>(list: RefType<ConstrBind<T>[] | undefined>, selected?: Ref<string> | string, hasTo?: boolean) => {
+    item: ComputedRef<T | undefined>;
+    /** Selected element / Выбранный элемент */
+    selected: Ref<string, string>;
+    label: ComputedRef<NumberOrString>;
+    /** List of elements / Список элементов */
+    list: ComputedRef<ConstrBind<T>[]>;
+    to: (name?: string) => void;
+    /**
+     * Transition to the main element.
+     *
+     * Переход к главному элементу.
+     */
+    toMain(): void;
+};

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

@@ -0,0 +1,36 @@
+import { Ref, ComputedRef } from 'vue';
+import { SearchColumns, SearchFormatList, SearchItem, SearchOptions } from '@dxtmisha/functional-basic';
+import { SearchListInput } from '../../types/searchTypes';
+/**
+ * Composable for handling search logic with reactive data.
+ *
+ * Композабл для управления логикой поиска с реактивными данными.
+ * @param list list of items to search / список элементов для поиска
+ * @param columns columns to search in / колонки, по которым ведется поиск
+ * @param value reactive search string / реактивная строка поиска
+ * @param options search options / настройки поиска
+ */
+export declare function useSearchRef<T extends SearchItem, K extends SearchColumns<T>>(list: SearchListInput<T>, columns: K, value?: Ref<string>, options?: SearchOptions): {
+    /**
+     * Whether the search is currently active (minimum character limit reached)/
+     * Активен ли поиск в данный момент (достигнут ли лимит символов)
+     */
+    isSearch: ComputedRef<boolean>;
+    /** Search string ref/ Ссылка на строку поиска */
+    search: Ref<string, string>;
+    /**
+     * Search loading status (if delay is used) /
+     * Статус загрузки поиска (если используется задержка)
+     */
+    loading: Ref<boolean, boolean>;
+    /**
+     * Formatted list of search results with highlights /
+     * Форматированный список результатов поиска с подсветкой совпадений
+     */
+    listSearch: ComputedRef<SearchFormatList<T, K>>;
+    /**
+     * Length of the search results /
+     * Длина списка результатов поиска
+     */
+    length: ComputedRef<number>;
+};

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

@@ -0,0 +1,19 @@
+import { Ref } from 'vue';
+import { SearchList, SearchColumns, SearchItem } from '@dxtmisha/functional-basic';
+/**
+ * Composable for managing search value state and handling delays.
+ *
+ * Композабл для управления состоянием значения поиска и обработки задержек.
+ * Он изолирует логику debounce, предоставляя `searchDelay` (строка с задержкой)
+ * и `loading` (флаг ожидания), которые затем читаются классом `SearchList` или `useSearchRef`.
+ * @param item search list instance / экземпляр поиска `SearchList`
+ * @param value reactive search string / реактивная строка поиска (опционально)
+ */
+export declare function useSearchValueRef<T extends SearchItem, K extends SearchColumns<T>>(item: SearchList<T, K>, value?: Ref<string>): {
+    /** Current search value / Текущее значение поиска */
+    search: Ref<string, string>;
+    /** Search value with applied delay / Значение поиска с примененной задержкой */
+    searchDelay: Ref<string, string>;
+    /** Loading status during delay / Статус загрузки во время задержки */
+    loading: Ref<boolean, boolean>;
+};

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

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

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

@@ -0,0 +1,10 @@
+import { Ref } from 'vue';
+/**
+ * Creates a reactive variable to manage a local storage.
+ *
+ * Создает реактивный переменный для управления локальным хранилищем.
+ * @param name value name/ название значения
+ * @param defaultValue default value/ значение по умолчанию
+ * @param cache cache time/ время кэширования
+ */
+export declare function useStorageRef<T>(name: string, defaultValue?: T | (() => T), cache?: number): Ref<T | undefined>;

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

@@ -0,0 +1,40 @@
+import { ShallowRef } from 'vue';
+import { TranslateInstance, TranslateList } from '@dxtmisha/functional-basic';
+/**
+ * Getting the translated text by an array of keys or a string with a key.
+ *
+ * It returns a `ShallowRef` that automatically updates when the global language changes.
+ * Use `as const` for arrays to ensure proper TypeScript key inference.
+ *
+ * ---
+ *
+ * Получение переведенного текста по массиву ключей или пункту с ключом.
+ *
+ * Возвращает `ShallowRef`, который автоматически обновляется при смене глобального языка.
+ * Используйте `as const` для массивов, чтобы обеспечить корректный вывод типов ключей в TypeScript.
+ *
+ * ### Examples / Примеры использования:
+ * ```typescript
+ * // 1. Using the main composable / Использование основного хука
+ * const translations = useTranslateRef(['home.title', 'home.description'] as const);
+ *
+ * // 2. Using the shorthand 't' / Использование сокращения 't'
+ * const labels = t(['button.save', 'button.cancel'] as const);
+ * ```
+ *
+ * @param names a string or an array with keys / строка или массив с ключами
+ * @param translateInstance a translate instance / экземпляр перевода
+ */
+export declare function useTranslateRef<T extends (string | string[])[]>(names: T, translateInstance?: TranslateInstance): ShallowRef<TranslateList<T>>;
+/**
+ * Shorthand for useTranslateRef.
+ * Use `as const` for arrays to ensure proper TypeScript key inference.
+ *
+ * ---
+ *
+ * Сокращение для useTranslateRef.
+ * Используйте `as const` для массивов, чтобы обеспечить корректный вывод типов ключей в TypeScript.
+ *
+ * @param names a string or an array with keys / строка или массив с ключами
+ */
+export declare const t: <T extends string[]>(names: T) => ShallowRef<TranslateList<T>>;

package/dist/flags.d.ts

@@ -0,0 +1 @@
+export declare const uiMakeFlags: () => void;

package/dist/functions/basic.d.ts

@@ -0,0 +1 @@
+export * from '@dxtmisha/functional-basic';

package/dist/functions/computedAsync.d.ts

@@ -0,0 +1,13 @@
+import { ComputedRef, DebuggerOptions } from 'vue';
+/**
+ * Creates a computed property that can handle asynchronous getters.
+ *
+ * Создаёт вычисляемое свойство, которое может обрабатывать асинхронные геттеры.
+ * @param getter Asynchronous function, synchronous function, or direct value to compute the result/
+ * Асинхронная функция, синхронная функция или прямое значение для вычисления результата
+ * @param initialState initial value of result/ начальное значение результата
+ * @param ignore values to be ignored/ значения для исключения из обработки
+ * @param debugOptions Used for debugging reactive computations. Supported by Vue.js library/
+ * Используется для отладки реактивных вычислений. Поддерживается библиотекой Vue.js
+ */
+export declare function computedAsync<R>(getter: (() => Promise<R>) | (() => R) | R, initialState?: (() => R) | R, ignore?: R, debugOptions?: DebuggerOptions): ComputedRef<R | undefined>;

package/dist/functions/computedByLanguage.d.ts

@@ -0,0 +1,15 @@
+import { ComputedGetter, ComputedRef, DebuggerOptions } from 'vue';
+/**
+ * Метод `computedByLanguage` предоставляет возможность создания реактивного свойства `computed`,
+ * значение которого изменяется в зависимости от текущего языка и определённых условий.
+ * @param getter Функция, которая предоставляет основное значение, зависящее от текущего языка
+ * или других факторов. Этот `getter` будет вызываться для получения актуального значения
+ * @param getterNone Альтернативное значение, которое будет возвращено в случаях, если:
+ *   Условия не выполнены,
+ *   Значение, возвращённое `getter`, равно `undefined`
+ * @param conditions Условие, определяющее, когда должен быть вызван основной `getter`.
+ * Если функция отсутствует, условие считается выполненным всегда
+ * @param debugOptions Используется для отладки реактивных вычислений.
+ * Поддерживается библиотекой Vue.js
+ */
+export declare function computedByLanguage<T, R extends (T | undefined) = T | undefined>(getter: ComputedGetter<R>, getterNone?: R | (() => R), conditions?: () => boolean, debugOptions?: DebuggerOptions): ComputedRef<R>;

package/dist/functions/computedEternity.d.ts

@@ -0,0 +1,15 @@
+import { Ref } from 'vue';
+/**
+ * Creates a computed property that is computed on demand and cached.
+ * The value is updated automatically when dependencies change, but only if it has been accessed at least once.
+ * The watcher remains active throughout the life of the application.
+ *
+ * Создаёт вычисляемое свойство, которое вычисляется по требованию и кешируется.
+ * Значение обновляется автоматически при изменении зависимостей, но только если к нему был осуществлён доступ хотя бы один раз.
+ * Вотчер остаётся активным на протяжении работы всего приложения.
+ *
+ * @param getter A function that returns the value to be computed/
+ * Функция, которая возвращает вычисляемое значение
+ * @param initialState initial value of result/ начальное значение результата
+ */
+export declare function computedEternity<T>(getter: () => Promise<T> | T, initialState?: (() => T) | T): Ref<T, T>;

package/dist/functions/dxtFunctionalPlugin.d.ts

@@ -0,0 +1,61 @@
+import { Plugin } from 'vue';
+import { ApiConfig, ErrorCenterCauseList, IconsConfig, TranslateConfig } from '@dxtmisha/functional-basic';
+import { Router } from 'vue-router';
+/**
+ * Interface for the functional plugin options /
+ * Интерфейс для опций функционального плагина
+ */
+export 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;
+}
+/**
+ * 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;