@dxtmisha/functional 1.11.1 → 1.11.7

package/dist/functions/executeUse.d.ts

@@ -0,0 +1,216 @@
+/**
+ * Types of initialization for a singleton/ Типы инициализации для синглтона
+ */
+export declare enum ExecuteUseType {
+    /** A single instance for the entire application/ Единственный экземпляр на всё приложение */
+    global = "global",
+    /** Shared via provide/inject in the component tree/ Разделяется через provide/inject в дереве компонентов */
+    provide = "provide",
+    /** A single instance within the closure/ Единственный экземпляр в замыкании */
+    local = "local"
+}
+/**
+ * The object returned by the factory function/ Объект, возвращаемый фабричной функцией
+ */
+export type ExecuteUseReturn<R> = Readonly<R & {
+    /**
+     * Returns the raw instance without management methods/
+     * Возвращает чистый экземпляр без методов управления
+     */
+    init(): Readonly<R>;
+    /**
+     * Resets the cached instance (available for local and global)/
+     * Сбрасывает закешированный экземпляр (доступно для local и global)
+     */
+    destroyExecute?(): void;
+}>;
+/**
+ * Creates a managed singleton that encapsulates initialization logic and access mode.
+ *
+ * It supports three initialization strategies:
+ * - `global`: A single instance for the entire application.
+ * - `provide`: Shared via provide/inject in the component tree (standard for Vue 3).
+ * - `local`: A single instance within the closure of the returned function.
+ *
+ * Создает управляемый синглтон, который инкапсулирует логику инициализации и режим доступа.
+ *
+ * Поддерживает три стратегии инициализации:
+ * - `global`: Единственный экземпляр на всё приложение.
+ * - `provide`: Разделяется через provide/inject в дереве компонентов (стандарт для Vue 3).
+ * - `local`: Единственный экземпляр в замыкании возвращаемой функции.
+ *
+ * @template R return type of the factory function / тип данных, возвращаемых фабрикой
+ * @template O argument types for the factory function / типы аргументов фабричной функции
+ * @template RI instance type with management methods / тип экземпляра с методами управления
+ *
+ * @param callback initialization function / функция инициализации
+ * @param type initialization strategy (defaults to provide) / стратегия инициализации (по умолчанию provide)
+ *
+ * @returns {function} accessor function for the singleton / функция-аксессор для синглтона
+ *
+ * @remarks
+ * Use this function in the following cases:
+ * - **API Services:** Always wrap API clients to ensure a single connection point and unified state.
+ * - **Resource Optimization:** For functions where creating multiple instances is undesirable (e.g., heavy objects, event buses).
+ * - **Shared State:** To share reactive state within a component tree using the `provide` strategy.
+ * - **External SDKs:** Initializing third-party libraries (analytics, maps, charts) that should be singletons.
+ *
+ * Используйте эту функцию в следующих случаях:
+ * - **API-сервисы:** Всегда оборачивайте API-клиенты для обеспечения единой точки подключения и унифицированного состояния.
+ * - **Оптимизация ресурсов:** Для функций, где нежелательно создание множества экземпляров (например, тяжелые объекты, шины событий).
+ * - **Общее состояние:** Для совместного использования реактивного состояния в дереве компонентов с помощью стратегии `provide`.
+ * - **Внешние SDK:** Инициализация сторонних библиотек (аналитика, карты, графики), которые должны быть синглтонами.
+ *
+ * @example
+ * // 1. Global API singleton (useApiGet)/ Глобальный синглтон API (useApiGet)
+ * export const useUserApi = executeUseGlobal(() => {
+ *   return useApiGet('/api/user');
+ * });
+ *
+ * @example
+ * // 2. Shared Reactive State/ Общее реактивное состояние
+ * export const useFeatureState = executeUseProvide(() => {
+ *   // Reactive logic here/ Здесь может быть реактивная логика (reactive, ref)
+ *   const items = [];
+ *   const addItem = (item) => items.push(item);
+ *   return { items, addItem };
+ * });
+ *
+ * @example
+ * // 3. Local Caching/ Локальное кеширование
+ * export const useHeavyResource = executeUseLocal((config) => {
+ *   return new HeavyResource(config);
+ * });
+ *
+ * @example
+ * // 4. Complex API Service (useApiManagementRef)/ Комплексный API-сервис (useApiManagementRef)
+ * export const useUserManagement = executeUseGlobal(() => {
+ *   return useApiManagementRef(
+ *     { path: '/api/users' },                 // GET setup
+ *     { date: (v) => new Date(v).toLocaleString() }, // Formatters
+ *     { columns: ['name', 'email'] },         // Search
+ *     { path: '/api/users' },                 // POST (create)
+ *     { path: (o) => `/api/users/${o.id}` },  // PUT (update)
+ *     { path: (o) => `/api/users/${o.id}` }   // DELETE (remove)
+ *   );
+ * });
+ *
+ * // Usage in component/ Использование в компоненте:
+ * // const { list, loading, sendPost, sendDelete } = useUserManagement();
+ */
+export declare function executeUse<R, O extends any[], RI extends ExecuteUseReturn<R> = ExecuteUseReturn<R>>(callback: (...args: O) => R, type?: ExecuteUseType): ((...args: O) => RI) | (() => RI);
+/**
+ * Creates a global singleton.
+ *
+ * Создает глобальный синглтон.
+ *
+ * @remarks
+ * See {@link executeUse} for more details.
+ *
+ * Подробнее см. {@link executeUse}.
+ *
+ * @param callback Initialization function/ Функция инициализации
+ */
+export declare function executeUseGlobal<R>(callback: () => R): (() => Readonly<R & {
+    /**
+     * Returns the raw instance without management methods/
+     * Возвращает чистый экземпляр без методов управления
+     */
+    init(): Readonly<R>;
+    /**
+     * Resets the cached instance (available for local and global)/
+     * Сбрасывает закешированный экземпляр (доступно для local и global)
+     */
+    destroyExecute?(): void;
+}>) | (() => Readonly<R & {
+    /**
+     * Returns the raw instance without management methods/
+     * Возвращает чистый экземпляр без методов управления
+     */
+    init(): Readonly<R>;
+    /**
+     * Resets the cached instance (available for local and global)/
+     * Сбрасывает закешированный экземпляр (доступно для local и global)
+     */
+    destroyExecute?(): void;
+}>);
+/**
+ * Creates a component-scoped singleton.
+ *
+ * Создает компонентный синглтон.
+ *
+ * @remarks
+ * Best for sharing state within a component sub-tree.
+ * See {@link executeUse} for more details.
+ *
+ * Лучше всего подходит для совместного использования состояния внутри поддерева компонентов.
+ * Подробнее см. {@link executeUse}.
+ *
+ * @param callback Initialization function/ Функция инициализации
+ */
+export declare function executeUseProvide<R, O extends any[]>(callback: (...args: O) => R): ((...args: O) => Readonly<R & {
+    /**
+     * Returns the raw instance without management methods/
+     * Возвращает чистый экземпляр без методов управления
+     */
+    init(): Readonly<R>;
+    /**
+     * Resets the cached instance (available for local and global)/
+     * Сбрасывает закешированный экземпляр (доступно для local и global)
+     */
+    destroyExecute?(): void;
+}>) | (() => Readonly<R & {
+    /**
+     * Returns the raw instance without management methods/
+     * Возвращает чистый экземпляр без методов управления
+     */
+    init(): Readonly<R>;
+    /**
+     * Resets the cached instance (available for local and global)/
+     * Сбрасывает закешированный экземпляр (доступно для local и global)
+     */
+    destroyExecute?(): void;
+}>);
+/**
+ * Creates a local singleton.
+ *
+ * Создает локальный синглтон.
+ *
+ * @remarks
+ * Best for internal state preservation within a closure.
+ * See {@link executeUse} for more details.
+ *
+ * Лучше всего подходит для сохранения внутреннего состояния внутри замыкания.
+ * Подробнее см. {@link executeUse}.
+ *
+ * @param callback Initialization function/ Функция инициализации
+ */
+export declare function executeUseLocal<R, O extends any[]>(callback: (...args: O) => R): ((...args: O) => Readonly<R & {
+    /**
+     * Returns the raw instance without management methods/
+     * Возвращает чистый экземпляр без методов управления
+     */
+    init(): Readonly<R>;
+    /**
+     * Resets the cached instance (available for local and global)/
+     * Сбрасывает закешированный экземпляр (доступно для local и global)
+     */
+    destroyExecute?(): void;
+}>) | (() => Readonly<R & {
+    /**
+     * Returns the raw instance without management methods/
+     * Возвращает чистый экземпляр без методов управления
+     */
+    init(): Readonly<R>;
+    /**
+     * Resets the cached instance (available for local and global)/
+     * Сбрасывает закешированный экземпляр (доступно для local и global)
+     */
+    destroyExecute?(): void;
+}>);
+/**
+ * Initializes all global callbacks.
+ *
+ * Инициализирует все глобальные callback.
+ */
+export declare function executeUseGlobalInit(): void;

package/dist/functions/getInject.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Get injected value by name.
+ *
+ * Получение внедренного значения по имени.
+ * @param name Key name / Имя ключа
+ */
+export declare function getInject<T>(name: string): T | undefined;

package/dist/functions/getOptions.d.ts

@@ -0,0 +1,10 @@
+import { ApiFetch } from '@dxtmisha/functional-basic';
+import { ApiOptions } from '../types/apiTypes';
+import { RefOrNormal } from '../types/refTypes';
+/**
+ * Get request options.
+ *
+ * Возвращает опции запроса.
+ * @param options options / параметры
+ */
+export declare const getOptions: (options?: ApiOptions) => RefOrNormal<ApiFetch>;

package/dist/functions/ref/getBindRef.d.ts

@@ -0,0 +1,13 @@
+import { ComputedRef } from 'vue';
+import { ItemList } from '@dxtmisha/functional-basic';
+import { RefOrNormal } from '../../types/refTypes';
+/**
+ * A method for generating properties for a subcomponent.
+ *
+ * Метод для генерации свойств для под компонента.
+ * @param value input value. Can be an object if you need to pass multiple properties/
+ * входное значение. Может быть объектом, если надо передать несколько свойств
+ * @param nameExtra additional parameter or property name/ дополнительный параметр или имя свойства
+ * @param name property name/ имя свойства
+ */
+export declare function getBindRef<T, R extends ItemList>(value: RefOrNormal<T | R> | undefined, nameExtra?: RefOrNormal<ItemList> | string, name?: string): ComputedRef<R>;

package/dist/functions/ref/getRef.d.ts

@@ -0,0 +1,8 @@
+import { RefOrNormal } from '../../types/refTypes';
+/**
+ * You return the values of the ref variable or the variable itself if it is not reactive.
+ *
+ * Возвращаешь значения ref переменной или саму переменную, если она не реактивная.
+ * @param item reactive variable or ordinary value/ реактивная переменная или обычное значение
+ */
+export declare function getRef<T>(item: RefOrNormal<T>): T;

package/dist/functions/ref/render.d.ts

@@ -0,0 +1,13 @@
+import { VNode } from 'vue';
+import { ItemList } from '@dxtmisha/functional-basic';
+import { RawChildren, RawSlots } from '../../types/refTypes';
+/**
+ * Getting cached, immutable data.
+ *
+ * Получение кешированных, неизменяемых данных.
+ * @param name name of the component/ названия компонента
+ * @param props property of the component/ свойство компонента
+ * @param children sub-elements of the component/ под элементы компонента
+ * @param index the name of the key/ названия ключа
+ */
+export declare function render<T extends ItemList>(name: string | any, props?: T, children?: RawChildren | RawSlots, index?: string): VNode;

package/dist/functions/ref/setRef.d.ts

@@ -0,0 +1,9 @@
+import { Ref } from 'vue';
+/**
+ * Changing the value for the reactive method.
+ *
+ * Изменение значения для реактивного метода.
+ * @param item reactive element/ реактивный элемент
+ * @param value values for replacement/ значения для замены
+ */
+export declare function setRef<T>(item: Ref<T>, value: T): void;

package/dist/functions/ref/toRefItem.d.ts

@@ -0,0 +1,9 @@
+import { Ref } from 'vue';
+import { RefOrNormal } from '../../types/refTypes';
+/**
+ * Returns a regular variable or wraps it in a regular variable if it is an ordinary variable.
+ *
+ * Возвращает регулярный переменный или оборачивает его в регулярный переменный, если является обычным переменным.
+ * @param item
+ */
+export declare function toRefItem<T>(item: RefOrNormal<T>): Ref<T>;

package/dist/functions/render/getBind.d.ts

@@ -0,0 +1,14 @@
+import { ItemList } from '@dxtmisha/functional-basic';
+import { ConstrBind } from '../../types/constructorTypes';
+/**
+ * A method for generating properties for a subcomponent.
+ *
+ * Метод для генерации свойств для под компонента.
+ * @param value input value. Can be an object if you need to pass multiple properties/
+ * входное значение. Может быть объектом, если надо передать несколько свойств
+ * @param nameExtra additional parameter or property name/ дополнительный параметр или имя свойства
+ * @param name property name/ имя свойства
+ * @param except exclude the rule requiring the presence of a primary key/
+ * исключить правило обязательности наличия главного ключа
+ */
+export declare function getBind<T, R extends ItemList>(value: T | R | undefined | null, nameExtra?: ItemList | string, name?: string, except?: boolean): ConstrBind<R>;

package/dist/functions/render/getClassName.d.ts

@@ -0,0 +1,8 @@
+import { ItemList } from '@dxtmisha/functional-basic';
+/**
+ * Returns the name of the class from the property.
+ *
+ * Возвращает название класса из свойства.
+ * @param props property of the component/ свойство компонента
+ */
+export declare function getClassName<T extends ItemList>(props?: T): string | undefined;

package/dist/functions/render/getIndexForRender.d.ts

@@ -0,0 +1,10 @@
+import { ItemList } from '@dxtmisha/functional-basic';
+/**
+ * Returns or generates a new element.
+ *
+ * Возвращает или генерирует новый элемент.
+ * @param name name of the component/ названия компонента
+ * @param props property of the component/ свойство компонента
+ * @param index the name of the key/ названия ключа
+ */
+export declare function getIndexForRender<T extends ItemList>(name: string | any, props?: T, index?: string): string | undefined;

package/dist/functions/toBind.d.ts

@@ -0,0 +1,10 @@
+import { ItemList } from '@dxtmisha/functional-basic';
+import { ConstrBind } from '../types/constructorTypes';
+/**
+ * Merges two objects with properties, taking into account their classes and styles
+ *
+ * Объединяет два объекта со свойствами с учётом классов и стилей в них
+ * @param extra additional property/ дополнительное свойство
+ * @param value input value/ входное значение
+ */
+export declare function toBind<R extends ItemList = ItemList>(extra: ItemList, value: ItemList): ConstrBind<R>;

package/dist/functions/toBinds.d.ts

@@ -0,0 +1,9 @@
+import { ItemList } from '@dxtmisha/functional-basic';
+import { ConstrBind } from '../types/constructorTypes';
+/**
+ * Merges multiple objects with properties, taking into account their classes and styles
+ *
+ * Объединяет несколько объектов со свойствами с учётом классов и стилей в них
+ * @param values list of input values/ список входных значений
+ */
+export declare function toBinds<R extends ItemList = ItemList>(...values: (ItemList | undefined)[]): ConstrBind<R>;