@dxtmisha/functional 1.11.1 → 1.11.7

package/dist/types/apiTypes.d.ts

@@ -0,0 +1,66 @@
+import { ApiData, ApiDataValidation, ApiDefaultValue, ApiFetch, ApiMethodItem, SearchColumns, SearchItem, SearchOptions } from '@dxtmisha/functional-basic';
+import { RefOrNormal, RefType } from './refTypes';
+import { Ref } from 'vue';
+/** Options for api requests/ Опции для запросов api */
+export type ApiOptions = ApiMethodItem | RefOrNormal<ApiFetch>;
+/**
+ * Base type for API management values, either a single value or an array.
+ *
+ * Базовый тип для значений управления API: одиночное значение или массив.
+ */
+export type ApiManagementValue = ApiDefaultValue | ApiDefaultValue[];
+/**
+ * Configuration for the main GET request in API management.
+ *
+ * Конфигурация для основного GET-запроса в управлении API.
+ */
+export type ApiManagementGet<Return extends ApiManagementValue, Type extends ApiManagementValue = Return> = {
+    /** API endpoint path / Путь к API */
+    path?: RefOrNormal<string | undefined>;
+    /** Additional request options / Дополнительные опции запроса */
+    options?: ApiOptions;
+    /** Enable reactive updates when path or options change / Включить реактивные обновления при изменении пути или опций */
+    reactivity?: boolean;
+    /** Condition to trigger the request / Условие выполнения запроса */
+    conditions?: RefType<boolean>;
+    /** Custom transformation for the fetched data / Пользовательская трансформация полученных данных */
+    transformation?: (data: Type, isResponseContractValid?: ApiDataValidation) => ApiData<Return>;
+    /** Function to validate response data contract / Функция для проверки контракта данных ответа */
+    validateResponseContract?: (data: Type) => ApiDataValidation;
+    /** Validation function or class constructor for data / Функция валидации или конструктор класса для данных */
+    typeData?: ((data: Return) => boolean) | any;
+    /** Whether to clear data when the component is unmounted / Удалять ли данные при размонтировании компонента */
+    unmounted?: boolean;
+    /** Function to provide skeleton data during loading / Функция, предоставляющая данные-заглушки во время загрузки */
+    skeleton?: () => Return;
+};
+/**
+ * Configuration for client-side search across API data.
+ *
+ * Конфигурация для клиентского поиска по данным API.
+ */
+export type ApiManagementSearch<T extends SearchItem, K extends SearchColumns<T>> = {
+    /** List of columns to search through / Список столбцов для поиска */
+    columns: K;
+    /** Reactive search query / Реактивная строка поиска */
+    value?: Ref<string>;
+    /** Additional search algorithm options / Дополнительные опции алгоритма поиска */
+    options?: SearchOptions;
+};
+/**
+ * Configuration for mutation requests (POST, PUT, DELETE).
+ *
+ * Конфигурация для запросов мутации (POST, PUT, DELETE).
+ */
+export type ApiManagementRequest<T, Return extends ApiData<T> = ApiData<T>> = {
+    /** Target API endpoint path / Целевой путь к API */
+    path?: RefOrNormal<string | undefined>;
+    /** Action to perform after a successful request / Действие после успешного выполнения запроса */
+    action?: (data: Return | undefined) => Promise<void> | void;
+    /** Transformation before sending data / Трансформация перед отправкой данных */
+    transformation?: (data: T) => Return;
+    /** Whether to wrap the payload in a 'data' property / Обертывать ли полезную нагрузку в свойство 'data' */
+    toData?: boolean;
+    /** Additional mutation request options / Дополнительные опции запроса мутации */
+    options?: ApiOptions;
+};

package/dist/types/constructorTypes.d.ts

@@ -0,0 +1,126 @@
+import { Ref, PropType, ComputedRef } from 'vue';
+import { Undefined } from '@dxtmisha/functional-basic';
+import { RefOrNormal, RefType } from './refTypes';
+/** Generic record type for constructor items/ Дженерик тип записи для элементов конструктора */
+export type ConstrItem = Record<string, any>;
+/** Constructor value wrapper with optional value property/ Обертка значения конструктора с опциональным свойством value */
+export type ConstrValue<T = any> = {
+    /** Optional value of type T/ Опциональное значение типа T */
+    value?: T;
+};
+/** Generic record type for constructor components/ Дженерик тип записи для компонентов конструктора */
+export type ConstrComponent = Record<string, any>;
+/**
+ * Constructor component modification type with reactive or normal values/
+ * Тип модификации компонента конструктора с реактивными или обычными значениями
+ */
+export type ConstrComponentMod<P extends ConstrItem> = ConstrItem | {
+    [K in keyof P]?: RefOrNormal<P[K]>;
+};
+export type ConstrExpose<E extends Element, EXPOSE extends ConstrItem> = EXPOSE & {
+    elementHtml?: ComputedRef<E | undefined>;
+};
+/** Utility type to convert union types to intersection types/ Утилитарный тип для преобразования объединенных типов в пересеченные */
+export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+/** Extract emit item type from constructor item/ Извлечение типа элемента emit из элемента конструктора */
+export type ConstrEmitItem<T extends ConstrItem> = T[keyof T];
+/**
+ * Constructor emit type with proper event handler signatures/
+ * Тип emit конструктора с правильными сигнатурами обработчиков событий
+ */
+export type ConstrEmit<T extends ConstrItem = ConstrItem> = UnionToIntersection<ConstrEmitItem<{
+    [K in keyof T]: (evt: K, ...args: T[K]) => void;
+}>>;
+/** Object type for CSS class names with boolean values/ Тип объекта для CSS классов с булевыми значениями */
+export type ConstrClassObject = Record<string, boolean | undefined>;
+/**
+ * Constructor class type supporting strings, arrays, and objects/
+ * Тип класса конструктора, поддерживающий строки, массивы и объекты
+ */
+export type ConstrClass = string | (string | ConstrClass | Undefined)[] | ConstrClassObject;
+/** Record type for mapping class names to class definitions/ Тип записи для сопоставления имен классов с определениями классов */
+export type ConstrClassList = Record<string, ConstrClass>;
+/** Constructor classes with required main class and additional class list/ Классы конструктора с обязательным основным классом и дополнительным списком классов */
+export type ConstrClasses = {
+    main: ConstrClass;
+} & ConstrClassList;
+/** Constructor style item type for individual style properties/ Тип элемента стиля конструктора для отдельных свойств стиля */
+export type ConstrStylesItem = string | null;
+/**
+ * Constructor styles type supporting objects and arrays of style definitions/
+ * Тип стилей конструктора, поддерживающий объекты и массивы определений стилей
+ */
+export type ConstrStyles = Record<string, ConstrStylesItem> | ConstrStyles[];
+/**
+ * Constructor options interface for component configuration/
+ * Интерфейс опций конструктора для конфигурации компонента
+ */
+export type ConstrOptions<COMP extends ConstrComponent, EMITS extends ConstrItem, P extends ConstrItem> = {
+    /** Optional components configuration/ Опциональная конфигурация компонентов */
+    components?: COMP;
+    /** Optional component modifications/ Опциональные модификации компонента */
+    compMod?: ConstrComponentMod<P>;
+    /** Optional emit handlers/ Опциональные обработчики emit */
+    emits?: ConstrEmit<EMITS>;
+    /** Optional reactive classes/ Опциональные реактивные классы */
+    classes?: RefType<ConstrClasses>;
+    /** Optional reactive styles/ Опциональные реактивные стили */
+    styles?: RefType<ConstrStyles>;
+};
+/**
+ * Constructor setup interface for component initialization/
+ * Интерфейс настройки конструктора для инициализации компонента
+ */
+export type ConstrSetup<E extends Element, CLASSES extends ConstrClasses, SETUP extends ConstrItem> = {
+    /** Component name/ Имя компонента */
+    name: string;
+    /** Reactive element reference/ Реактивная ссылка на элемент */
+    element: Ref<E | undefined>;
+    /** Reactive classes/ Реактивные классы */
+    classes: RefType<CLASSES>;
+    /** Reactive styles/ Реактивные стили */
+    styles: RefType<ConstrStyles>;
+} & SETUP;
+/** Constructor registration configuration/ Конфигурация регистрации конструктора */
+export type ConstrRegistration = {
+    /** Optional flag for registration/ Опциональный флаг для регистрации */
+    flag?: boolean;
+    /** Optional translation map/ Опциональная карта переводов */
+    translate?: Record<string, string>;
+};
+/**
+ * Constructor bind type for component binding with class and style support/
+ * Тип привязки конструктора для привязки компонента с поддержкой классов и стилей
+ */
+export type ConstrBind<T> = T & Record<string, any> & {
+    /** Optional key/ Опциональный ключ */
+    key?: string;
+    /** Optional CSS classes/ Опциональные CSS классы */
+    class?: ConstrClass;
+    /** Optional styles/ Опциональные стили */
+    style?: ConstrStyles;
+};
+/** Constructor prop item options for Vue prop definitions/ Опции элемента prop конструктора для определений Vue prop */
+export type ConstrPropItemOptions<T = any> = {
+    /** Vue prop type/ Тип Vue prop */
+    type?: PropType<T>;
+    /** Required flag/ Флаг обязательности */
+    required?: boolean;
+    /** Default value/ Значение по умолчанию */
+    default?: any;
+    /** Custom validator function/ Пользовательская функция валидации */
+    validator?(value: any, props: any): boolean;
+};
+/** Constructor prop item type with options or direct PropType/ Тип элемента prop конструктора с опциями или прямым PropType */
+export type ConstrPropItem<T = any> = ConstrPropItemOptions<T> | PropType<T>;
+/** Constructor props type for component prop definitions/ Тип props конструктора для определений props компонента */
+export type ConstrProps<P = Record<string, any>> = {
+    [K in keyof P]: ConstrPropItem<P[K]>;
+};
+/**
+ * Props for link handling/ Пропсы для обработки ссылок
+ */
+export type ConstrHrefProps = {
+    /** Hyperlink reference/ Гиперссылка */
+    href?: string;
+};

package/dist/types/listTypes.d.ts

@@ -0,0 +1,63 @@
+import { NumberOrString, NumberOrStringOrBoolean } from '@dxtmisha/functional-basic';
+import { ConstrBind } from './constructorTypes';
+/** Type of list item/ Тип элемента списка */
+export type ListType = 'item' | 'space' | 'line' | 'subtitle' | 'html' | 'menu' | 'menu-group' | 'group';
+/** Basic data structure for list item/ Базовая структура данных для элемента списка */
+export type ListDataBasic = {
+    /** Optional display label/ Опциональная отображаемая метка */
+    label?: NumberOrString;
+    /** Any value associated with the item/ Любое значение, связанное с элементом */
+    value?: any;
+    /** Search text for filtering/ Текст поиска для фильтрации */
+    search?: string;
+};
+/** Extended list item with type and index/ Расширенный элемент списка с типом и индексом */
+export type ListDataItem<Item extends ListDataBasic = ListDataBasic> = ConstrBind<Item & {
+    /** Parent item identifier/ Идентификатор родительского элемента */
+    parent?: string;
+    /** Type of list item/ Тип элемента списка */
+    type: ListType;
+    /** Unique item identifier/ Уникальный идентификатор элемента */
+    index: string;
+}>;
+/** Array of list data items/ Массив элементов данных списка */
+export type ListList<Item extends ListDataBasic = ListDataBasic> = ListDataItem<Item>[];
+/**
+ * List or record structure for list data/
+ * Структура списка или записи для данных списка
+ */
+export type ListRecord<Item extends ListDataBasic = ListDataBasic> = ListList<Item> | Record<string, any>;
+/**
+ * Extended list item with additional state properties/
+ * Расширенный элемент списка с дополнительными свойствами состояния
+ */
+export type ListDataFullItem<Item extends ListDataBasic = ListDataBasic> = ListDataItem<Item> & {
+    /** Whether the item has focus/ Имеет ли элемент фокус */
+    focus: boolean;
+    /** Highlighted text portion/ Выделенная часть текста */
+    highlight?: string;
+    /** Whether the item is selected/ Выбран ли элемент */
+    selected: boolean;
+    /** Whether the item is disabled/ Отключен ли элемент */
+    disabled?: boolean;
+};
+/**
+ * Array of extended list items with state/
+ * Массив расширенных элементов списка с состоянием
+ */
+export type ListDataFull<Item extends ListDataBasic = ListDataBasic> = ListDataFullItem<Item>[];
+/** Input item for list creation/ Входной элемент для создания списка */
+export type ListListInputItem<Item extends ListDataBasic = ListDataBasic> = ConstrBind<Item>;
+/**
+ * Various input formats for list creation/
+ * Различные форматы входных данных для создания списка
+ */
+export type ListListInput<Item extends ListDataBasic = ListDataBasic> = ListListInputItem<Item>[] | string[] | Record<string, ListListInputItem<Item>> | Record<string, string>;
+/** Single selected item identifier/ Идентификатор одного выбранного элемента */
+export type ListSelectedItem = NumberOrStringOrBoolean;
+/** Single or multiple selected items/ Один или несколько выбранных элементов */
+export type ListSelectedList = ListSelectedItem | ListSelectedItem[];
+/** Name of selected list item/ Название выбранного элемента списка */
+export type ListName = string | number | undefined;
+/** Array of list item names/ Массив названий выбранных элементов списка */
+export type ListNames = ListName[];

package/dist/types/refTypes.d.ts

@@ -0,0 +1,36 @@
+import { ComputedRef, Ref, VNode, VNodeArrayChildren } from 'vue';
+/**
+ * Union type for Vue reactive references (computed or ref)/
+ * Объединенный тип для Vue реактивных ссылок (computed или ref)
+ */
+export type RefType<T> = ComputedRef<T> | Ref<T>;
+/**
+ * Union type for Vue reactive references that can be undefined/
+ * Объединенный тип для Vue реактивных ссылок, которые могут быть undefined
+ */
+export type RefUndefined<T> = RefType<T | undefined>;
+/**
+ * Union type that can be either a Vue reactive reference or a normal value/
+ * Объединенный тип, который может быть либо Vue реактивной ссылкой, либо обычным значением
+ */
+export type RefOrNormal<T> = RefType<T> | T;
+/**
+ * Union type for Vue raw children content
+ * (strings, numbers, booleans, VNodes, arrays, functions)/
+ * Объединенный тип для Vue сырого содержимого дочерних элементов
+ * (строки, числа, булевы, VNode, массивы, функции)
+ */
+export type RawChildren = string | number | boolean | VNode | VNodeArrayChildren | (() => any);
+/**
+ * Type for Vue raw slots with optional stability flag/
+ * Тип для Vue сырых слотов с опциональным флагом стабильности
+ */
+export type RawSlots = {
+    /** Slot name mapping to unknown content/ Маппинг имени слота к неизвестному содержимому */
+    [name: string]: unknown;
+    /**
+     * Optional stability flag for performance optimization/
+     * Опциональный флаг стабильности для оптимизации производительности
+     */
+    $stable?: boolean;
+};

package/dist/types/searchTypes.d.ts

@@ -0,0 +1,6 @@
+import { RefOrNormal } from './refTypes';
+import { SearchItem, SearchListValue } from '@dxtmisha/functional-basic';
+/** Search list data / Данные списка поиска */
+export type SearchListValueRef<T extends SearchItem> = RefOrNormal<SearchListValue<T>>;
+/** Search list input / Входные данные списка поиска */
+export type SearchListInput<T extends SearchItem> = SearchListValueRef<T> | (() => SearchListValueRef<T>);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dxtmisha/functional",
   "private": false,
-  "version": "1.11.1",
+  "version": "1.11.7",
   "type": "module",
   "description": "A comprehensive library of utilities, base classes, and Vue 3 composables for reactive web development. Extends @dxtmisha/functional-basic with Composition API.",
   "keywords": [
@@ -40,16 +40,18 @@
     "preview": "vite preview",
     "test": "vitest",
     "library": "dxt-library",
-    "dxt-types": "dxt-types",
+    "types": "dxt-types",
     "prepublishOnly": "npm run library && npm run build",
-    "public": "npm publish --access public"
+    "publish-to-npm": "npm publish --access public"
   },
   "files": [
     "dist",
+    "ai-description.txt",
     "ai-types.txt",
-    "README.md",
+    "CHANGELOG.md",
+    "LICENSE",
     "package.json",
-    "LICENSE"
+    "README.md"
   ],
   "main": "dist/library.js",
   "module": "dist/library.js",