@dxtmisha/functional 1.11.6 → 1.11.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/CHANGELOG.md +79 -0
  2. package/ai-description.txt +5 -0
  3. package/ai-types.txt +176 -138
  4. package/dist/classes/design/DesignAbstract.d.ts +61 -0
  5. package/dist/classes/design/DesignAsyncAbstract.d.ts +28 -0
  6. package/dist/classes/design/DesignChanged.d.ts +42 -0
  7. package/dist/classes/design/DesignComp.d.ts +4 -0
  8. package/dist/classes/design/DesignComponents.d.ts +81 -0
  9. package/dist/classes/design/DesignConstructorAbstract.d.ts +150 -0
  10. package/dist/classes/ref/DatetimeRef.d.ts +123 -0
  11. package/dist/classes/ref/EffectScopeGlobal.d.ts +22 -0
  12. package/dist/classes/ref/EventRef.d.ts +22 -0
  13. package/dist/classes/ref/GeoFlagRef.d.ts +51 -0
  14. package/dist/classes/ref/GeoIntlRef.d.ts +213 -0
  15. package/dist/classes/ref/GeoRef.d.ts +58 -0
  16. package/dist/classes/ref/ListDataRef.d.ts +359 -0
  17. package/dist/classes/ref/RouterItemRef.d.ts +61 -0
  18. package/dist/classes/ref/ScrollbarWidthRef.d.ts +22 -0
  19. package/dist/composables/ref/useApiAsyncRef.d.ts +18 -0
  20. package/dist/composables/ref/useApiDelete.d.ts +20 -0
  21. package/dist/composables/ref/useApiGet.d.ts +20 -0
  22. package/dist/composables/ref/useApiManagementAsyncRef.d.ts +49 -0
  23. package/dist/composables/ref/useApiManagementRef.d.ts +155 -0
  24. package/dist/composables/ref/useApiPost.d.ts +20 -0
  25. package/dist/composables/ref/useApiPut.d.ts +20 -0
  26. package/dist/composables/ref/useApiRef.d.ts +106 -0
  27. package/dist/composables/ref/useApiRequest.d.ts +28 -0
  28. package/dist/composables/ref/useBroadcastValueRef.d.ts +11 -0
  29. package/dist/composables/ref/useCookieRef.d.ts +11 -0
  30. package/dist/composables/ref/useFormattersRef.d.ts +21 -0
  31. package/dist/composables/ref/useGeoIntlRef.d.ts +7 -0
  32. package/dist/composables/ref/useHashRef.d.ts +9 -0
  33. package/dist/composables/ref/useLazyItemByMarginRef.d.ts +22 -0
  34. package/dist/composables/ref/useLazyRef.d.ts +42 -0
  35. package/dist/composables/ref/useLoadingRef.d.ts +7 -0
  36. package/dist/composables/ref/useMeta.d.ts +223 -0
  37. package/dist/composables/ref/useRouterList.d.ts +28 -0
  38. package/dist/composables/ref/useSearchRef.d.ts +36 -0
  39. package/dist/composables/ref/useSearchValueRef.d.ts +19 -0
  40. package/dist/composables/ref/useSessionRef.d.ts +9 -0
  41. package/dist/composables/ref/useStorageRef.d.ts +10 -0
  42. package/dist/composables/ref/useTranslateRef.d.ts +40 -0
  43. package/dist/flags.d.ts +1 -0
  44. package/dist/functions/basic.d.ts +1 -0
  45. package/dist/functions/computedAsync.d.ts +13 -0
  46. package/dist/functions/computedByLanguage.d.ts +15 -0
  47. package/dist/functions/computedEternity.d.ts +15 -0
  48. package/dist/functions/dxtFunctionalPlugin.d.ts +61 -0
  49. package/dist/functions/executeUse.d.ts +216 -0
  50. package/dist/functions/getInject.d.ts +7 -0
  51. package/dist/functions/getOptions.d.ts +10 -0
  52. package/dist/functions/ref/getBindRef.d.ts +13 -0
  53. package/dist/functions/ref/getRef.d.ts +8 -0
  54. package/dist/functions/ref/render.d.ts +13 -0
  55. package/dist/functions/ref/setRef.d.ts +9 -0
  56. package/dist/functions/ref/toRefItem.d.ts +9 -0
  57. package/dist/functions/render/getBind.d.ts +14 -0
  58. package/dist/functions/render/getClassName.d.ts +8 -0
  59. package/dist/functions/render/getIndexForRender.d.ts +10 -0
  60. package/dist/functions/toBind.d.ts +10 -0
  61. package/dist/functions/toBinds.d.ts +9 -0
  62. package/dist/library.d.ts +62 -2803
  63. package/dist/library.js +105 -71
  64. package/dist/types/apiTypes.d.ts +66 -0
  65. package/dist/types/constructorTypes.d.ts +126 -0
  66. package/dist/types/listTypes.d.ts +63 -0
  67. package/dist/types/refTypes.d.ts +36 -0
  68. package/dist/types/searchTypes.d.ts +6 -0
  69. package/package.json +7 -5
package/dist/library.d.ts CHANGED
@@ -1,2803 +1,62 @@
1
- import { ApiConfig } from '@dxtmisha/functional-basic';
2
- import { ApiData } from '@dxtmisha/functional-basic';
3
- import { ApiDataValidation } from '@dxtmisha/functional-basic';
4
- import { ApiDefaultValue } from '@dxtmisha/functional-basic';
5
- import { ApiFetch } from '@dxtmisha/functional-basic';
6
- import { ApiInstance } from '@dxtmisha/functional-basic';
7
- import { ApiMethodItem } from '@dxtmisha/functional-basic';
8
- import { ArrayToItem } from '@dxtmisha/functional-basic';
9
- import { ComputedGetter } from 'vue';
10
- import { ComputedRef } from 'vue';
11
- import { CookieOptions } from '@dxtmisha/functional-basic';
12
- import { Datetime } from '@dxtmisha/functional-basic';
13
- import { DebuggerOptions } from 'vue';
14
- import { ElementOrString } from '@dxtmisha/functional-basic';
15
- import { ElementOrWindow } from '@dxtmisha/functional-basic';
16
- import { ErrorCenterCauseList } from '@dxtmisha/functional-basic';
17
- import { EventItem } from '@dxtmisha/functional-basic';
18
- import { EventListenerDetail } from '@dxtmisha/functional-basic';
19
- import { EventOptions } from '@dxtmisha/functional-basic';
20
- import { FormattersListColumns } from '@dxtmisha/functional-basic';
21
- import { FormattersListProp } from '@dxtmisha/functional-basic';
22
- import { FormattersOptionsList } from '@dxtmisha/functional-basic';
23
- import { FormattersReturn } from '@dxtmisha/functional-basic';
24
- import { GeoDate } from '@dxtmisha/functional-basic';
25
- import { GeoFirstDay } from '@dxtmisha/functional-basic';
26
- import { GeoFlag } from '@dxtmisha/functional-basic';
27
- import { GeoFlagItem } from '@dxtmisha/functional-basic';
28
- import { GeoFlagNational } from '@dxtmisha/functional-basic';
29
- import { GeoHours } from '@dxtmisha/functional-basic';
30
- import { GeoItemFull } from '@dxtmisha/functional-basic';
31
- import { IconsConfig } from '@dxtmisha/functional-basic';
32
- import { ItemList } from '@dxtmisha/functional-basic';
33
- import { ItemValue } from '@dxtmisha/functional-basic';
34
- import { MetaRobots } from '@dxtmisha/functional-basic';
35
- import { MetaStatic } from '@dxtmisha/functional-basic';
36
- import { NumberOrString } from '@dxtmisha/functional-basic';
37
- import { NumberOrStringOrBoolean } from '@dxtmisha/functional-basic';
38
- import { NumberOrStringOrDate } from '@dxtmisha/functional-basic';
39
- import { Plugin as Plugin_2 } from 'vue';
40
- import { PropType } from 'vue';
41
- import { Ref } from 'vue';
42
- import { RouteLocationRaw } from 'vue-router';
43
- import { Router } from 'vue-router';
44
- import { SearchColumns } from '@dxtmisha/functional-basic';
45
- import { SearchFormatList } from '@dxtmisha/functional-basic';
46
- import { SearchItem } from '@dxtmisha/functional-basic';
47
- import { SearchList } from '@dxtmisha/functional-basic';
48
- import { SearchListValue } from '@dxtmisha/functional-basic';
49
- import { SearchOptions } from '@dxtmisha/functional-basic';
50
- import { ShallowRef } from 'vue';
51
- import { ToRefs } from 'vue';
52
- import { TranslateConfig } from '@dxtmisha/functional-basic';
53
- import { TranslateInstance } from '@dxtmisha/functional-basic';
54
- import { TranslateList } from '@dxtmisha/functional-basic';
55
- import { Undefined } from '@dxtmisha/functional-basic';
56
- import { VNode } from 'vue';
57
- import { VNodeArrayChildren } from 'vue';
58
-
59
- /**
60
- * Configuration for the main GET request in API management.
61
- *
62
- * Конфигурация для основного GET-запроса в управлении API.
63
- */
64
- export declare type ApiManagementGet<Return extends ApiManagementValue, Type extends ApiManagementValue = Return> = {
65
- /** API endpoint path / Путь к API */
66
- path?: RefOrNormal<string | undefined>;
67
- /** Additional request options / Дополнительные опции запроса */
68
- options?: ApiOptions;
69
- /** Enable reactive updates when path or options change / Включить реактивные обновления при изменении пути или опций */
70
- reactivity?: boolean;
71
- /** Condition to trigger the request / Условие выполнения запроса */
72
- conditions?: RefType<boolean>;
73
- /** Custom transformation for the fetched data / Пользовательская трансформация полученных данных */
74
- transformation?: (data: Type, isResponseContractValid?: ApiDataValidation) => ApiData<Return>;
75
- /** Function to validate response data contract / Функция для проверки контракта данных ответа */
76
- validateResponseContract?: (data: Type) => ApiDataValidation;
77
- /** Validation function or class constructor for data / Функция валидации или конструктор класса для данных */
78
- typeData?: ((data: Return) => boolean) | any;
79
- /** Whether to clear data when the component is unmounted / Удалять ли данные при размонтировании компонента */
80
- unmounted?: boolean;
81
- /** Function to provide skeleton data during loading / Функция, предоставляющая данные-заглушки во время загрузки */
82
- skeleton?: () => Return;
83
- };
84
-
85
- /**
86
- * Configuration for mutation requests (POST, PUT, DELETE).
87
- *
88
- * Конфигурация для запросов мутации (POST, PUT, DELETE).
89
- */
90
- export declare type ApiManagementRequest<T, Return extends ApiData<T> = ApiData<T>> = {
91
- /** Target API endpoint path / Целевой путь к API */
92
- path?: RefOrNormal<string | undefined>;
93
- /** Action to perform after a successful request / Действие после успешного выполнения запроса */
94
- action?: (data: Return | undefined) => Promise<void> | void;
95
- /** Transformation before sending data / Трансформация перед отправкой данных */
96
- transformation?: (data: T) => Return;
97
- /** Whether to wrap the payload in a 'data' property / Обертывать ли полезную нагрузку в свойство 'data' */
98
- toData?: boolean;
99
- /** Additional mutation request options / Дополнительные опции запроса мутации */
100
- options?: ApiOptions;
101
- };
102
-
103
- /**
104
- * Configuration for client-side search across API data.
105
- *
106
- * Конфигурация для клиентского поиска по данным API.
107
- */
108
- export declare type ApiManagementSearch<T extends SearchItem, K extends SearchColumns<T>> = {
109
- /** List of columns to search through / Список столбцов для поиска */
110
- columns: K;
111
- /** Reactive search query / Реактивная строка поиска */
112
- value?: Ref<string>;
113
- /** Additional search algorithm options / Дополнительные опции алгоритма поиска */
114
- options?: SearchOptions;
115
- };
116
-
117
- /**
118
- * Base type for API management values, either a single value or an array.
119
- *
120
- * Базовый тип для значений управления API: одиночное значение или массив.
121
- */
122
- export declare type ApiManagementValue = ApiDefaultValue | ApiDefaultValue[];
123
-
124
- /** Options for api requests/ Опции для запросов api */
125
- export declare type ApiOptions = ApiMethodItem | RefOrNormal<ApiFetch>;
126
-
127
- declare type BroadcastValueItem<T> = T | string | undefined;
128
-
129
- /**
130
- * Creates a computed property that can handle asynchronous getters.
131
- *
132
- * Создаёт вычисляемое свойство, которое может обрабатывать асинхронные геттеры.
133
- * @param getter Asynchronous function, synchronous function, or direct value to compute the result/
134
- * Асинхронная функция, синхронная функция или прямое значение для вычисления результата
135
- * @param initialState initial value of result/ начальное значение результата
136
- * @param ignore values to be ignored/ значения для исключения из обработки
137
- * @param debugOptions Used for debugging reactive computations. Supported by Vue.js library/
138
- * Используется для отладки реактивных вычислений. Поддерживается библиотекой Vue.js
139
- */
140
- export declare function computedAsync<R>(getter: (() => Promise<R>) | (() => R) | R, initialState?: (() => R) | R, ignore?: R, debugOptions?: DebuggerOptions): ComputedRef<R | undefined>;
141
-
142
- /**
143
- * Метод `computedByLanguage` предоставляет возможность создания реактивного свойства `computed`,
144
- * значение которого изменяется в зависимости от текущего языка и определённых условий.
145
- * @param getter Функция, которая предоставляет основное значение, зависящее от текущего языка
146
- * или других факторов. Этот `getter` будет вызываться для получения актуального значения
147
- * @param getterNone Альтернативное значение, которое будет возвращено в случаях, если:
148
- * Условия не выполнены,
149
- * Значение, возвращённое `getter`, равно `undefined`
150
- * @param conditions Условие, определяющее, когда должен быть вызван основной `getter`.
151
- * Если функция отсутствует, условие считается выполненным всегда
152
- * @param debugOptions Используется для отладки реактивных вычислений.
153
- * Поддерживается библиотекой Vue.js
154
- */
155
- export declare function computedByLanguage<T, R extends (T | undefined) = T | undefined>(getter: ComputedGetter<R>, getterNone?: R | (() => R), conditions?: () => boolean, debugOptions?: DebuggerOptions): ComputedRef<R>;
156
-
157
- /**
158
- * Creates a computed property that is computed on demand and cached.
159
- * The value is updated automatically when dependencies change, but only if it has been accessed at least once.
160
- * The watcher remains active throughout the life of the application.
161
- *
162
- * Создаёт вычисляемое свойство, которое вычисляется по требованию и кешируется.
163
- * Значение обновляется автоматически при изменении зависимостей, но только если к нему был осуществлён доступ хотя бы один раз.
164
- * Вотчер остаётся активным на протяжении работы всего приложения.
165
- *
166
- * @param getter A function that returns the value to be computed/
167
- * Функция, которая возвращает вычисляемое значение
168
- * @param initialState initial value of result/ начальное значение результата
169
- */
170
- export declare function computedEternity<T>(getter: () => Promise<T> | T, initialState?: (() => T) | T): Ref<T, T>;
171
-
172
- /**
173
- * Constructor bind type for component binding with class and style support/
174
- * Тип привязки конструктора для привязки компонента с поддержкой классов и стилей
175
- */
176
- export declare type ConstrBind<T> = T & Record<string, any> & {
177
- /** Optional key/ Опциональный ключ */
178
- key?: string;
179
- /** Optional CSS classes/ Опциональные CSS классы */
180
- class?: ConstrClass;
181
- /** Optional styles/ Опциональные стили */
182
- style?: ConstrStyles;
183
- };
184
-
185
- /**
186
- * Constructor class type supporting strings, arrays, and objects/
187
- * Тип класса конструктора, поддерживающий строки, массивы и объекты
188
- */
189
- export declare type ConstrClass = string | (string | ConstrClass | Undefined)[] | ConstrClassObject;
190
-
191
- /** Constructor classes with required main class and additional class list/ Классы конструктора с обязательным основным классом и дополнительным списком классов */
192
- export declare type ConstrClasses = {
193
- main: ConstrClass;
194
- } & ConstrClassList;
195
-
196
- /** Record type for mapping class names to class definitions/ Тип записи для сопоставления имен классов с определениями классов */
197
- export declare type ConstrClassList = Record<string, ConstrClass>;
198
-
199
- /** Object type for CSS class names with boolean values/ Тип объекта для CSS классов с булевыми значениями */
200
- export declare type ConstrClassObject = Record<string, boolean | undefined>;
201
-
202
- /** Generic record type for constructor components/ Дженерик тип записи для компонентов конструктора */
203
- export declare type ConstrComponent = Record<string, any>;
204
-
205
- /**
206
- * Constructor component modification type with reactive or normal values/
207
- * Тип модификации компонента конструктора с реактивными или обычными значениями
208
- */
209
- export declare type ConstrComponentMod<P extends ConstrItem> = ConstrItem | {
210
- [K in keyof P]?: RefOrNormal<P[K]>;
211
- };
212
-
213
- /**
214
- * Constructor emit type with proper event handler signatures/
215
- * Тип emit конструктора с правильными сигнатурами обработчиков событий
216
- */
217
- export declare type ConstrEmit<T extends ConstrItem = ConstrItem> = UnionToIntersection<ConstrEmitItem<{
218
- [K in keyof T]: (evt: K, ...args: T[K]) => void;
219
- }>>;
220
-
221
- /** Extract emit item type from constructor item/ Извлечение типа элемента emit из элемента конструктора */
222
- export declare type ConstrEmitItem<T extends ConstrItem> = T[keyof T];
223
-
224
- export declare type ConstrExpose<E extends Element, EXPOSE extends ConstrItem> = EXPOSE & {
225
- elementHtml?: ComputedRef<E | undefined>;
226
- };
227
-
228
- /**
229
- * Props for link handling/ Пропсы для обработки ссылок
230
- */
231
- export declare type ConstrHrefProps = {
232
- /** Hyperlink reference/ Гиперссылка */
233
- href?: string;
234
- };
235
-
236
- /** Generic record type for constructor items/ Дженерик тип записи для элементов конструктора */
237
- export declare type ConstrItem = Record<string, any>;
238
-
239
- /**
240
- * Constructor options interface for component configuration/
241
- * Интерфейс опций конструктора для конфигурации компонента
242
- */
243
- export declare type ConstrOptions<COMP extends ConstrComponent, EMITS extends ConstrItem, P extends ConstrItem> = {
244
- /** Optional components configuration/ Опциональная конфигурация компонентов */
245
- components?: COMP;
246
- /** Optional component modifications/ Опциональные модификации компонента */
247
- compMod?: ConstrComponentMod<P>;
248
- /** Optional emit handlers/ Опциональные обработчики emit */
249
- emits?: ConstrEmit<EMITS>;
250
- /** Optional reactive classes/ Опциональные реактивные классы */
251
- classes?: RefType<ConstrClasses>;
252
- /** Optional reactive styles/ Опциональные реактивные стили */
253
- styles?: RefType<ConstrStyles>;
254
- };
255
-
256
- /** Constructor prop item type with options or direct PropType/ Тип элемента prop конструктора с опциями или прямым PropType */
257
- export declare type ConstrPropItem<T = any> = ConstrPropItemOptions<T> | PropType<T>;
258
-
259
- /** Constructor prop item options for Vue prop definitions/ Опции элемента prop конструктора для определений Vue prop */
260
- export declare type ConstrPropItemOptions<T = any> = {
261
- /** Vue prop type/ Тип Vue prop */
262
- type?: PropType<T>;
263
- /** Required flag/ Флаг обязательности */
264
- required?: boolean;
265
- /** Default value/ Значение по умолчанию */
266
- default?: any;
267
- /** Custom validator function/ Пользовательская функция валидации */
268
- validator?(value: any, props: any): boolean;
269
- };
270
-
271
- /** Constructor props type for component prop definitions/ Тип props конструктора для определений props компонента */
272
- export declare type ConstrProps<P = Record<string, any>> = {
273
- [K in keyof P]: ConstrPropItem<P[K]>;
274
- };
275
-
276
- /** Constructor registration configuration/ Конфигурация регистрации конструктора */
277
- export declare type ConstrRegistration = {
278
- /** Optional flag for registration/ Опциональный флаг для регистрации */
279
- flag?: boolean;
280
- /** Optional translation map/ Опциональная карта переводов */
281
- translate?: Record<string, string>;
282
- };
283
-
284
- /**
285
- * Constructor setup interface for component initialization/
286
- * Интерфейс настройки конструктора для инициализации компонента
287
- */
288
- export declare type ConstrSetup<E extends Element, CLASSES extends ConstrClasses, SETUP extends ConstrItem> = {
289
- /** Component name/ Имя компонента */
290
- name: string;
291
- /** Reactive element reference/ Реактивная ссылка на элемент */
292
- element: Ref<E | undefined>;
293
- /** Reactive classes/ Реактивные классы */
294
- classes: RefType<CLASSES>;
295
- /** Reactive styles/ Реактивные стили */
296
- styles: RefType<ConstrStyles>;
297
- } & SETUP;
298
-
299
- /**
300
- * Constructor styles type supporting objects and arrays of style definitions/
301
- * Тип стилей конструктора, поддерживающий объекты и массивы определений стилей
302
- */
303
- export declare type ConstrStyles = Record<string, ConstrStylesItem> | ConstrStyles[];
304
-
305
- /** Constructor style item type for individual style properties/ Тип элемента стиля конструктора для отдельных свойств стиля */
306
- export declare type ConstrStylesItem = string | null;
307
-
308
- /** Constructor value wrapper with optional value property/ Обертка значения конструктора с опциональным свойством value */
309
- export declare type ConstrValue<T = any> = {
310
- /** Optional value of type T/ Опциональное значение типа T */
311
- value?: T;
312
- };
313
-
314
- /**
315
- * A class for working with dates.
316
- *
317
- * Класс для работы с датами.
318
- */
319
- export declare class DatetimeRef {
320
- protected item: Ref<NumberOrStringOrDate>;
321
- protected type: Ref<GeoDate>;
322
- protected code: Ref<string>;
323
- protected date: Ref<Date>;
324
- protected datetime: Datetime;
325
- protected year: Ref<number, number>;
326
- protected month: Ref<number, number>;
327
- protected day: Ref<number, number>;
328
- protected hour: Ref<number, number>;
329
- protected minute: Ref<number, number>;
330
- protected second: Ref<number, number>;
331
- /**
332
- * Constructor
333
- * @param date date for processing. дата для обработки
334
- * @param type type of date format for output. тип формата даты вывода
335
- * @param code country and language code. код страны и языка
336
- */
337
- constructor(date: RefOrNormal<NumberOrStringOrDate>, type?: RefOrNormal<GeoDate>, code?: RefOrNormal<string>);
338
- /**
339
- * Returns the basic data for the date.
340
- *
341
- * Возвращает основные данные для даты.
342
- */
343
- getItem(): Ref<NumberOrStringOrDate>;
344
- /**
345
- * Returns a Date object.
346
- *
347
- * Возвращает объект Date.
348
- */
349
- getDate(): Ref<Date>;
350
- /**
351
- * Obtaining an object of the basic Datetime class.
352
- *
353
- * Получение объекта основного класса Datetime.
354
- */
355
- getDatetime(): Datetime;
356
- /**
357
- * Returns the format of hours.
358
- *
359
- * Возвращает формат часов.
360
- */
361
- getHoursType(): ComputedRef<GeoHours>;
362
- /**
363
- * Returns the code of the first day of the week.
364
- *
365
- * Возвращает код первого дня недели.
366
- */
367
- getFirstDayCode(): ComputedRef<GeoFirstDay>;
368
- /**
369
- * The method returns the year of the specified date according to local time.
370
- *
371
- * Метод возвращает год указанной даты по местному времени.
372
- */
373
- getYear(): ComputedRef<number>;
374
- /**
375
- * The method returns the month in the specified date according to local time,
376
- * as a zero-based value.
377
- *
378
- * Метод возвращает месяц указанной даты по местному времени, нумерация
379
- * месяцев начинается с нуля для первого месяца в году.
380
- */
381
- getMonth(): ComputedRef<number>;
382
- /**
383
- * The method returns the day of the month for the specified date according to local time.
384
- *
385
- * Метод возвращает день месяца указанной даты по местному времени.
386
- */
387
- getDay(): ComputedRef<number>;
388
- /**
389
- * The method returns the hour for the specified date, according to local time.
390
- *
391
- * Метод возвращает часы указанной даты по местному времени.
392
- */
393
- getHour(): ComputedRef<number>;
394
- /**
395
- * The method returns the minutes in the specified date according to local time.
396
- *
397
- * Метод возвращает минуты указанной даты по местному времени.
398
- */
399
- getMinute(): ComputedRef<number>;
400
- /**
401
- * The method returns the seconds in the specified date according to local time.
402
- *
403
- * Метод возвращает секунды указанной даты по местному времени.
404
- */
405
- getSecond(): ComputedRef<number>;
406
- /**
407
- * Returns the last day of the week.
408
- *
409
- * Возвращает последний день недели.
410
- */
411
- getMaxDay(): ComputedRef<number>;
412
- /**
413
- * Enables language-sensitive date and time formatting.
414
- *
415
- * Конструктором объектов, включающих языка-зависимое форматирование даты и времени.
416
- * @param type type of date format for output. тип формата даты вывода
417
- * @param styleOptions the representation of the month. представление месяца
418
- */
419
- locale(type?: GeoDate, styleOptions?: Intl.DateTimeFormatOptions['month'] | Intl.DateTimeFormatOptions): ComputedRef<string>;
420
- /**
421
- * Output of standard data.
422
- *
423
- * Вывод стандартных данных.
424
- * @param timeZone add time zone. добавить временную зону
425
- */
426
- standard(timeZone?: boolean): ComputedRef<string>;
427
- /**
428
- * Updates all reactive date values.
429
- *
430
- * Обновляет все реактивные значения даты.
431
- */
432
- protected updateDate(): this;
433
- }
434
-
435
- /**
436
- * Base class for working with the constructor.
437
- *
438
- * Базовый класс для работы с конструктором.
439
- */
440
- export declare abstract class DesignAbstract<T extends Record<string, any>, C extends Record<string, any>> {
441
- protected readonly props: T;
442
- protected readonly callback?: ((event: C) => void) | undefined;
443
- protected readonly event: C;
444
- protected readonly changed: DesignChanged<T>;
445
- /**
446
- * Constructor
447
- * @param props base data/ базовые данные
448
- * @param callback callback function when the value changes/
449
- * функция обратного вызова при изменении значения
450
- * @param changed base data/ данный для слежения
451
- */
452
- constructor(props: T, callback?: ((event: C) => void) | undefined, changed?: string[]);
453
- /**
454
- * Calls the callback function.
455
- *
456
- * Вызывает функцию обратного вызова.
457
- * @param compelled forces data to update/ вынуждает обновлять данные
458
- */
459
- make(compelled?: boolean): this;
460
- /**
461
- * Checks if there are values in the property.
462
- *
463
- * Проверяет, есть ли значения в свойстве.
464
- * @param name property names/ названия свойств
465
- */
466
- protected is<K extends keyof T>(name: K): boolean;
467
- /**
468
- * Checks if the value has been changed by the property name.
469
- *
470
- * Проверяет, было ли изменено значение по названию свойства.
471
- * @param name property names/ названия свойств
472
- * @param nameProp names of properties of the input variable/ названия свойств входной переменной
473
- */
474
- protected isChanged<K extends keyof C & string, KT extends keyof T & string>(name: K, nameProp?: KT | KT[]): boolean;
475
- /**
476
- * Calls the callback function.
477
- *
478
- * Вызывает функцию обратного вызова.
479
- * @param compelled forces data to update/ вынуждает обновлять данные
480
- */
481
- makeCallback(compelled?: boolean): void;
482
- /**
483
- * The function calls an image call.
484
- *
485
- * Функция вызывает образный вызов.
486
- */
487
- protected makeCallbackItem(): void;
488
- /**
489
- * A function that is called each time the input values are changed.
490
- *
491
- * Функция, которая вызывается каждый раз, когда изменяются входные значения.
492
- */
493
- protected abstract initEvent(): void;
494
- }
495
-
496
- /**
497
- * Base class for working with the constructor.
498
- *
499
- * Базовый класс для работы с конструктором.
500
- */
501
- export declare abstract class DesignAsyncAbstract<T extends Record<string, any>, C extends Record<string, any>> extends DesignAbstract<T, C> {
502
- /**
503
- * Calls the callback function.
504
- *
505
- * Вызывает функцию обратного вызова.
506
- * @param compelled forces data to update/ вынуждает обновлять данные
507
- */
508
- make(compelled?: boolean): this;
509
- /**
510
- * Calls the callback function.
511
- *
512
- * Вызывает функцию обратного вызова.
513
- * @param compelled forces data to update/ вынуждает обновлять данные
514
- */
515
- makeCallback(compelled?: boolean): Promise<void>;
516
- /**
517
- * A function that is called each time the input values are changed.
518
- *
519
- * Функция, которая вызывается каждый раз, когда изменяются входные значения.
520
- */
521
- protected abstract initEvent(): Promise<void>;
522
- }
523
-
524
- /**
525
- * The class checks the values that have been edited.
526
- *
527
- * Класс проверяет значения, которые были отредактированы.
528
- */
529
- export declare class DesignChanged<T extends Record<string, any>> {
530
- protected readonly props: T;
531
- protected readonly watch: string[];
532
- private readonly cache;
533
- /**
534
- * Constructor
535
- * @param props base data/ базовые данные
536
- * @param watch data for tracking/ данные для слежения
537
- */
538
- constructor(props: T, watch?: string[]);
539
- /**
540
- * Checks if the value has been updated.
541
- *
542
- * Проверяет, обновлено ли значение.
543
- * @param name property name/ название свойства
544
- */
545
- is(name: string | string[]): boolean;
546
- /**
547
- * Checks if there are changes in the data.
548
- *
549
- * Проверяет, есть ли изменения в данных.
550
- */
551
- isChanged(): boolean;
552
- /**
553
- * Updates all values.
554
- *
555
- * Обновляет все значения.
556
- */
557
- update(): void;
558
- /**
559
- * Checking additional data.
560
- *
561
- * Проверка дополнительных данных.
562
- * @param name property name/ название свойства
563
- */
564
- protected isDifferent(name: string): boolean;
565
- }
566
-
567
- export declare class DesignComp<COMP extends ConstrComponent, P extends ConstrItem> extends DesignComponents<COMP, P> {
568
- }
569
-
570
- /**
571
- * Class for working with connected components.
572
- *
573
- * Класс для работы с подключенными компонентами.
574
- */
575
- export declare class DesignComponents<COMP extends ConstrComponent, P extends ConstrItem> {
576
- protected readonly components: COMP;
577
- protected readonly modification?: ConstrComponentMod<P> | undefined;
578
- /** Cache for computed properties/ Кэш для вычисляемых свойств */
579
- protected caching: Record<string, ComputedRef<any>>;
580
- /**
581
- * Constructor
582
- * @param components list of connected components/ список подключенных компонентов
583
- * @param modification data for modification/ данные для модификации
584
- */
585
- constructor(components?: COMP, modification?: ConstrComponentMod<P> | undefined);
586
- /**
587
- * Check the presence of the component.
588
- *
589
- * Проверить наличие компонента.
590
- * @param name name of the component/ названия компонента
591
- */
592
- is<K extends keyof COMP>(name: K): name is K;
593
- /**
594
- * Getting the object of the component.
595
- *
596
- * Получение объекта компонента.
597
- * @param name name of the component/ названия компонента
598
- */
599
- get<K extends keyof COMP>(name: K): COMP[K];
600
- /**
601
- * Returns the modified input data of the connected components.
602
- *
603
- * Возвращает модифицированные входные данные у подключенных компонентов.
604
- * @param index the name of this/ название данного
605
- * @param props basic data/ базовые данные
606
- */
607
- getModification<K extends keyof P>(index?: K & string | string, props?: P[K] | Record<string, any>): Record<string, any> | undefined;
608
- /**
609
- * Rendering a component by its name and returning an array with one component.
610
- *
611
- * Рендеринг компонента по его имени и возвращение массива с одним компонентом.
612
- * @param name name of the component/ названия компонента
613
- * @param props property of the component/ свойство компонента
614
- * @param children sub-elements of the component/ под элементы компонента
615
- * @param index the name of the key/ названия ключа
616
- */
617
- render<K extends keyof COMP, PK extends keyof P>(name: K & string, props?: P[PK] & ConstrItem | ConstrItem, children?: RawChildren | RawSlots, index?: PK & string | string): VNode[];
618
- /**
619
- * Rendering a component by its name.
620
- *
621
- * Рендеринг компонента по его имени.
622
- * @param name name of the component/ названия компонента
623
- * @param props property of the component/ свойство компонента
624
- * @param children sub-elements of the component/ под элементы компонента
625
- * @param index the name of the key/ названия ключа
626
- */
627
- renderOne<K extends keyof COMP, PK extends keyof P>(name: K & string, props?: P[PK] & ConstrItem | ConstrItem, children?: RawChildren | RawSlots, index?: PK & string | string): VNode | undefined;
628
- /**
629
- * Rendering the component by its name.
630
- *
631
- * Рендеринг компонента по его имени.
632
- * @param item an array to which the rendered object will be added/
633
- * массив, по которому будет добавлять объект
634
- * @param name name of the component/ названия компонента
635
- * @param props property of the component/ свойство компонента
636
- * @param children sub-elements of the component/ под элементы компонента
637
- * @param index the name of the key/ названия ключа
638
- */
639
- renderAdd<K extends keyof COMP, PK extends keyof P>(item: any[], name: K & string, props?: P[PK] & ConstrItem | ConstrItem, children?: RawChildren | RawSlots, index?: PK & string | string): this;
640
- /**
641
- * Calculates modified input data for connected components.
642
- *
643
- * Вычисляет модифицированные входные данные для подключенных компонентов.
644
- * @param index the name of this/ название данного
645
- */
646
- protected computeModification<K extends keyof P>(index: K & string | string): Record<string, any>;
647
- }
648
-
649
- /**
650
- * Class for collecting all functional components.
651
- *
652
- * Класс для сбора всех функциональных компонентов.
653
- */
654
- export declare abstract class DesignConstructorAbstract<E extends Element, COMP extends ConstrComponent, EMITS extends ConstrItem, EXPOSE extends ConstrItem, SLOTS extends ConstrItem, CLASSES extends ConstrClasses, P extends ConstrItem> {
655
- protected readonly props: Readonly<P>;
656
- protected readonly options?: ConstrOptions<COMP, EMITS, P> | undefined;
657
- protected readonly name: string[];
658
- protected readonly element: Ref<E | undefined, E | undefined>;
659
- protected readonly refs: ToRefs<P>;
660
- protected readonly components: DesignComponents<COMP, P>;
661
- protected readonly emits?: ConstrEmit<EMITS>;
662
- protected readonly classes?: ComputedRef<CLASSES>;
663
- protected classesSub?: ComputedRef<Partial<CLASSES>>;
664
- protected readonly styles?: ComputedRef<ConstrStyles>;
665
- protected stylesSub?: ComputedRef<ConstrStyles>;
666
- protected attrs?: ConstrItem;
667
- protected slots?: SLOTS;
668
- protected dataExpose?: EXPOSE;
669
- /**
670
- * Constructor
671
- * @param name class name/ название класса
672
- * @param props properties/ свойства
673
- * @param options list of additional parameters/ список дополнительных параметров
674
- */
675
- protected constructor(name: string, props: Readonly<P>, options?: ConstrOptions<COMP, EMITS, P> | undefined);
676
- protected init(): this;
677
- /**
678
- * Getting the class name.
679
- *
680
- * Получение названия класса.
681
- */
682
- getName(): string;
683
- /**
684
- * Getting the class name.
685
- *
686
- * Получение названия дизайна.
687
- */
688
- getDesign(): string;
689
- /**
690
- * Getting the class name.
691
- *
692
- * Получение названия класса.
693
- * @param name list of class names by levels/ список названий классов по уровням
694
- */
695
- getSubClass(name: string | string[]): string;
696
- /**
697
- * Getting the class name for the status.
698
- *
699
- * Получение названия класса для статуса.
700
- * @param name list of class names by levels/ список названий классов по уровням
701
- */
702
- getStatusClass(name: string | string[]): string;
703
- /**
704
- * Getting the property name for the style.
705
- *
706
- * Получение названия свойства для стиля.
707
- * @param name list of class names by levels/ список названий классов по уровням
708
- */
709
- getStyle(name: string | string[]): string;
710
- /**
711
- * Getting additional parameters.
712
- *
713
- * Получение дополнительных параметров.
714
- */
715
- getAttrs(): ConstrItem;
716
- /**
717
- * List of available external variables.
718
- *
719
- * Список доступных переменных извне.
720
- */
721
- expose(): ConstrExpose<E, EXPOSE>;
722
- /**
723
- * The rendering method for the setup method.
724
- *
725
- * Метод рендеринга для метода настройки.
726
- */
727
- render(): () => VNode | (VNode | any)[] | undefined;
728
- /**
729
- * Initialization of all the necessary properties for work
730
- *
731
- * Инициализация всех необходимых свойств для работы.
732
- */
733
- protected abstract initExpose(): EXPOSE;
734
- /**
735
- * Improvement of the obtained list of classes.
736
- *
737
- * Доработка полученного списка классов.
738
- */
739
- protected abstract initClasses(): Partial<CLASSES>;
740
- /**
741
- * Refinement of the received list of styles.
742
- *
743
- * Доработка полученного списка стилей.
744
- */
745
- protected abstract initStyles(): ConstrStyles;
746
- /**
747
- * A method for rendering.
748
- *
749
- * Метод для рендеринга.
750
- */
751
- protected abstract initRender(): VNode | (VNode | any)[] | undefined;
752
- /**
753
- * Initializes the slot.
754
- *
755
- * Инициализирует слот.
756
- * @param name slot name/ название слота
757
- * @param children if you pass this element, the slot will be added to it/
758
- * если передать этот элемент, то слот добавится в него
759
- * @param props property for the slot/ свойство для слота
760
- */
761
- protected initSlot<K extends keyof SLOTS>(name: K, children?: any[], props?: ConstrItem): VNode | undefined;
762
- /**
763
- * Transformation of the class value into an object.
764
- *
765
- * Преобразование значения класса в объект.
766
- * @param classes list of classes for transformation/ список классов для преобразования
767
- */
768
- protected toClass(classes?: ConstrClass): ConstrClassObject;
769
- /**
770
- * Converts the class name to standard for the current component.
771
- *
772
- * Преобразовывает название класса в стандартное для текущего компонента.
773
- * @param classes list of classes/ список классов
774
- */
775
- protected toClassName<T extends ConstrItem>(classes?: ConstrItem): T;
776
- /**
777
- * Getting component names as an array.
778
- *
779
- * Получение названий компонентов в виде массива.
780
- * @param name component name for transformation/ название компонента для преобразования
781
- */
782
- private initName;
783
- /**
784
- * Updating data about the class.
785
- *
786
- * Обновление данных об классе.
787
- */
788
- private updateClasses;
789
- /**
790
- * Refinement of the received list of styles.
791
- *
792
- * Доработка полученного списка стилей.
793
- */
794
- private updateStyles;
795
- }
796
-
797
- /**
798
- * Vue plugin for initializing and configuring global functional services
799
- * (Api, Translate, Icons, Meta).
800
- *
801
- * Vue плагин для инициализации и настройки глобальных функциональных сервисов
802
- * (Api, Translate, Icons, Meta).
803
- *
804
- * @example
805
- * ```typescript
806
- * import { createApp } from 'vue'
807
- * import { dxtFunctionalPlugin } from '@dxtmisha/functional'
808
- * import router from './router'
809
- *
810
- * const app = createApp(App)
811
- * app.use(dxtFunctionalPlugin, {
812
- * api: { url: 'https://api.example.com' },
813
- * metaSuffix: ' | My App',
814
- * router
815
- * })
816
- * ```
817
- */
818
- export declare const dxtFunctionalPlugin: Plugin_2;
819
-
820
- /**
821
- * Global effect scope class.
822
- *
823
- * Глобальный класс для области действия эффекта.
824
- */
825
- export declare class EffectScopeGlobal {
826
- /**
827
- * Runs a function within the global scope.
828
- *
829
- * Запускает функцию в глобальной области.
830
- * @param fn function/ функция
831
- * @returns the return value of the function/ возвращаемое значение функции
832
- */
833
- static run<T>(fn: () => T): T | undefined;
834
- /**
835
- * Gets the global effect scope instance.
836
- *
837
- * Получает экземпляр глобальной области действия эффекта.
838
- * @returns the global effect scope instance/ экземпляр глобальной области действия эффекта
839
- */
840
- private static getScope;
841
- }
842
-
843
- /**
844
- * Class for working with events (Ref).
845
- *
846
- * Класс для работа с события (Ref).
847
- */
848
- export declare class EventRef<E extends ElementOrWindow, O extends Event, D extends Record<string, any> = Record<string, any>> extends EventItem<E, O, D> {
849
- /**
850
- * Classes Constructor
851
- * @param elementSelector element/ элемент
852
- * @param elementSelectorControl control element/ элемент управления
853
- * @param type type/ тип
854
- * @param listener the object that receives a notification (an object that implements the
855
- * Event interface) when an event of the specified type occurs/ объект, который принимает
856
- * уведомление, когда событие указанного типа произошло
857
- * @param options object that specifies characteristics/ объект options
858
- * @param detail an event-dependent value associated with the event/ зависимое от события
859
- * значение, связанное с событием
860
- */
861
- constructor(elementSelector?: RefOrNormal<ElementOrString<E> | undefined>, elementSelectorControl?: RefOrNormal<ElementOrString<HTMLElement>>, type?: string | string[], listener?: EventListenerDetail<O, D>, options?: EventOptions, detail?: D);
862
- }
863
-
864
- /**
865
- * Creates a managed singleton that encapsulates initialization logic and access mode.
866
- *
867
- * It supports three initialization strategies:
868
- * - `global`: A single instance for the entire application.
869
- * - `provide`: Shared via provide/inject in the component tree (standard for Vue 3).
870
- * - `local`: A single instance within the closure of the returned function.
871
- *
872
- * Создает управляемый синглтон, который инкапсулирует логику инициализации и режим доступа.
873
- *
874
- * Поддерживает три стратегии инициализации:
875
- * - `global`: Единственный экземпляр на всё приложение.
876
- * - `provide`: Разделяется через provide/inject в дереве компонентов (стандарт для Vue 3).
877
- * - `local`: Единственный экземпляр в замыкании возвращаемой функции.
878
- *
879
- * @template R return type of the factory function / тип данных, возвращаемых фабрикой
880
- * @template O argument types for the factory function / типы аргументов фабричной функции
881
- * @template RI instance type with management methods / тип экземпляра с методами управления
882
- *
883
- * @param callback initialization function / функция инициализации
884
- * @param type initialization strategy (defaults to provide) / стратегия инициализации (по умолчанию provide)
885
- *
886
- * @returns {function} accessor function for the singleton / функция-аксессор для синглтона
887
- *
888
- * @remarks
889
- * Use this function in the following cases:
890
- * - **API Services:** Always wrap API clients to ensure a single connection point and unified state.
891
- * - **Resource Optimization:** For functions where creating multiple instances is undesirable (e.g., heavy objects, event buses).
892
- * - **Shared State:** To share reactive state within a component tree using the `provide` strategy.
893
- * - **External SDKs:** Initializing third-party libraries (analytics, maps, charts) that should be singletons.
894
- *
895
- * Используйте эту функцию в следующих случаях:
896
- * - **API-сервисы:** Всегда оборачивайте API-клиенты для обеспечения единой точки подключения и унифицированного состояния.
897
- * - **Оптимизация ресурсов:** Для функций, где нежелательно создание множества экземпляров (например, тяжелые объекты, шины событий).
898
- * - **Общее состояние:** Для совместного использования реактивного состояния в дереве компонентов с помощью стратегии `provide`.
899
- * - **Внешние SDK:** Инициализация сторонних библиотек (аналитика, карты, графики), которые должны быть синглтонами.
900
- *
901
- * @example
902
- * // 1. Global API singleton (useApiGet)/ Глобальный синглтон API (useApiGet)
903
- * export const useUserApi = executeUseGlobal(() => {
904
- * return useApiGet('/api/user');
905
- * });
906
- *
907
- * @example
908
- * // 2. Shared Reactive State/ Общее реактивное состояние
909
- * export const useFeatureState = executeUseProvide(() => {
910
- * // Reactive logic here/ Здесь может быть реактивная логика (reactive, ref)
911
- * const items = [];
912
- * const addItem = (item) => items.push(item);
913
- * return { items, addItem };
914
- * });
915
- *
916
- * @example
917
- * // 3. Local Caching/ Локальное кеширование
918
- * export const useHeavyResource = executeUseLocal((config) => {
919
- * return new HeavyResource(config);
920
- * });
921
- *
922
- * @example
923
- * // 4. Complex API Service (useApiManagementRef)/ Комплексный API-сервис (useApiManagementRef)
924
- * export const useUserManagement = executeUseGlobal(() => {
925
- * return useApiManagementRef(
926
- * { path: '/api/users' }, // GET setup
927
- * { date: (v) => new Date(v).toLocaleString() }, // Formatters
928
- * { columns: ['name', 'email'] }, // Search
929
- * { path: '/api/users' }, // POST (create)
930
- * { path: (o) => `/api/users/${o.id}` }, // PUT (update)
931
- * { path: (o) => `/api/users/${o.id}` } // DELETE (remove)
932
- * );
933
- * });
934
- *
935
- * // Usage in component/ Использование в компоненте:
936
- * // const { list, loading, sendPost, sendDelete } = useUserManagement();
937
- */
938
- export declare function executeUse<R, O extends any[], RI extends ExecuteUseReturn<R> = ExecuteUseReturn<R>>(callback: (...args: O) => R, type?: ExecuteUseType): ((...args: O) => RI) | (() => RI);
939
-
940
- /**
941
- * Creates a global singleton.
942
- *
943
- * Создает глобальный синглтон.
944
- *
945
- * @remarks
946
- * See {@link executeUse} for more details.
947
- *
948
- * Подробнее см. {@link executeUse}.
949
- *
950
- * @param callback Initialization function/ Функция инициализации
951
- */
952
- export declare function executeUseGlobal<R>(callback: () => R): (() => Readonly<R & {
953
- /**
954
- * Returns the raw instance without management methods/
955
- * Возвращает чистый экземпляр без методов управления
956
- */
957
- init(): Readonly<R>;
958
- /**
959
- * Resets the cached instance (available for local and global)/
960
- * Сбрасывает закешированный экземпляр (доступно для local и global)
961
- */
962
- destroyExecute?(): void;
963
- }>) | (() => Readonly<R & {
964
- /**
965
- * Returns the raw instance without management methods/
966
- * Возвращает чистый экземпляр без методов управления
967
- */
968
- init(): Readonly<R>;
969
- /**
970
- * Resets the cached instance (available for local and global)/
971
- * Сбрасывает закешированный экземпляр (доступно для local и global)
972
- */
973
- destroyExecute?(): void;
974
- }>);
975
-
976
- /**
977
- * Initializes all global callbacks.
978
- *
979
- * Инициализирует все глобальные callback.
980
- */
981
- export declare function executeUseGlobalInit(): void;
982
-
983
- /**
984
- * Creates a local singleton.
985
- *
986
- * Создает локальный синглтон.
987
- *
988
- * @remarks
989
- * Best for internal state preservation within a closure.
990
- * See {@link executeUse} for more details.
991
- *
992
- * Лучше всего подходит для сохранения внутреннего состояния внутри замыкания.
993
- * Подробнее см. {@link executeUse}.
994
- *
995
- * @param callback Initialization function/ Функция инициализации
996
- */
997
- export declare function executeUseLocal<R, O extends any[]>(callback: (...args: O) => R): ((...args: O) => Readonly<R & {
998
- /**
999
- * Returns the raw instance without management methods/
1000
- * Возвращает чистый экземпляр без методов управления
1001
- */
1002
- init(): Readonly<R>;
1003
- /**
1004
- * Resets the cached instance (available for local and global)/
1005
- * Сбрасывает закешированный экземпляр (доступно для local и global)
1006
- */
1007
- destroyExecute?(): void;
1008
- }>) | (() => Readonly<R & {
1009
- /**
1010
- * Returns the raw instance without management methods/
1011
- * Возвращает чистый экземпляр без методов управления
1012
- */
1013
- init(): Readonly<R>;
1014
- /**
1015
- * Resets the cached instance (available for local and global)/
1016
- * Сбрасывает закешированный экземпляр (доступно для local и global)
1017
- */
1018
- destroyExecute?(): void;
1019
- }>);
1020
-
1021
- /**
1022
- * Creates a component-scoped singleton.
1023
- *
1024
- * Создает компонентный синглтон.
1025
- *
1026
- * @remarks
1027
- * Best for sharing state within a component sub-tree.
1028
- * See {@link executeUse} for more details.
1029
- *
1030
- * Лучше всего подходит для совместного использования состояния внутри поддерева компонентов.
1031
- * Подробнее см. {@link executeUse}.
1032
- *
1033
- * @param callback Initialization function/ Функция инициализации
1034
- */
1035
- export declare function executeUseProvide<R, O extends any[]>(callback: (...args: O) => R): ((...args: O) => Readonly<R & {
1036
- /**
1037
- * Returns the raw instance without management methods/
1038
- * Возвращает чистый экземпляр без методов управления
1039
- */
1040
- init(): Readonly<R>;
1041
- /**
1042
- * Resets the cached instance (available for local and global)/
1043
- * Сбрасывает закешированный экземпляр (доступно для local и global)
1044
- */
1045
- destroyExecute?(): void;
1046
- }>) | (() => Readonly<R & {
1047
- /**
1048
- * Returns the raw instance without management methods/
1049
- * Возвращает чистый экземпляр без методов управления
1050
- */
1051
- init(): Readonly<R>;
1052
- /**
1053
- * Resets the cached instance (available for local and global)/
1054
- * Сбрасывает закешированный экземпляр (доступно для local и global)
1055
- */
1056
- destroyExecute?(): void;
1057
- }>);
1058
-
1059
- /**
1060
- * The object returned by the factory function/ Объект, возвращаемый фабричной функцией
1061
- */
1062
- export declare type ExecuteUseReturn<R> = Readonly<R & {
1063
- /**
1064
- * Returns the raw instance without management methods/
1065
- * Возвращает чистый экземпляр без методов управления
1066
- */
1067
- init(): Readonly<R>;
1068
- /**
1069
- * Resets the cached instance (available for local and global)/
1070
- * Сбрасывает закешированный экземпляр (доступно для local и global)
1071
- */
1072
- destroyExecute?(): void;
1073
- }>;
1074
-
1075
- /**
1076
- * Types of initialization for a singleton/ Типы инициализации для синглтона
1077
- */
1078
- export declare enum ExecuteUseType {
1079
- /** A single instance for the entire application/ Единственный экземпляр на всё приложение */
1080
- global = "global",
1081
- /** Shared via provide/inject in the component tree/ Разделяется через provide/inject в дереве компонентов */
1082
- provide = "provide",
1083
- /** A single instance within the closure/ Единственный экземпляр в замыкании */
1084
- local = "local"
1085
- }
1086
-
1087
- /**
1088
- * Interface for the functional plugin options /
1089
- * Интерфейс для опций функционального плагина
1090
- */
1091
- export declare interface FunctionalPluginOptions {
1092
- /**
1093
- * Configuration for the API client /
1094
- * Конфигурация для API-клиента
1095
- */
1096
- api?: ApiConfig;
1097
- /**
1098
- * Configuration for the translation service /
1099
- * Конфигурация для сервиса переводов
1100
- */
1101
- translate?: TranslateConfig;
1102
- /**
1103
- * Suffix to be appended to all page titles /
1104
- * Суффикс, который будет добавляться ко всем заголовкам страниц
1105
- */
1106
- metaSuffix?: string;
1107
- /**
1108
- * Configuration for the icon management service /
1109
- * Конфигурация для сервиса управления иконками
1110
- */
1111
- icons?: IconsConfig;
1112
- /**
1113
- * Vue Router instance for global navigation state management /
1114
- * Экземпляр Vue Router для глобального управления состоянием навигации
1115
- */
1116
- router?: Router;
1117
- /**
1118
- * Error causes list for error center /
1119
- * Список причин ошибок для центра ошибок
1120
- */
1121
- errorCauses?: ErrorCenterCauseList;
1122
- }
1123
-
1124
- /**
1125
- * Class for working with Flags.
1126
- *
1127
- * Класс для работы с Флагами.
1128
- */
1129
- export declare class GeoFlagRef {
1130
- protected code: Ref<string>;
1131
- protected flag: GeoFlag;
1132
- /**
1133
- * Constructor
1134
- * @param code country and language code/ код страны и языка
1135
- */
1136
- constructor(code?: RefOrNormal<string>);
1137
- /**
1138
- * Obtaining a reactive object with the country code.
1139
- *
1140
- * Получение реактивного объекта с кодом страны.
1141
- */
1142
- getCode(): Ref<string>;
1143
- /**
1144
- * Returns information about the country and its flag.
1145
- *
1146
- * Возвращает информацию о стране и её флаге.
1147
- * @param code country code/ код страны
1148
- */
1149
- get(code?: string): ComputedRef<GeoFlagItem | undefined>;
1150
- /**
1151
- * Getting a link to the flag.
1152
- *
1153
- * Получение ссылки на флаг.
1154
- * @param code country code/ код страны
1155
- */
1156
- getFlag(code?: string): ComputedRef<string | undefined>;
1157
- /**
1158
- * Getting a list of countries by an array of codes.
1159
- *
1160
- * Получение списка стран по массиву с кодами.
1161
- * @param codes country code/ код страны
1162
- */
1163
- getList(codes?: string[]): ComputedRef<GeoFlagItem[]>;
1164
- /**
1165
- * Getting a list of countries by an array of codes in national language.
1166
- *
1167
- * Получение списка стран по массиву с кодами на национальный язык.
1168
- * @param codes country code/ код страны.
1169
- */
1170
- getNational(codes?: string[]): ComputedRef<GeoFlagNational[]>;
1171
- }
1172
-
1173
- /**
1174
- * Reactive class for managing the formatting of numbers and dates.
1175
- *
1176
- * Реактивный класс для управления форматированием чисел и дат.
1177
- */
1178
- export declare class GeoIntlRef {
1179
- private location;
1180
- private intl;
1181
- /**
1182
- * Constructor
1183
- * @param code country code, full form language-country or one of them/
1184
- * код страны, полный вид язык-страна или один из них
1185
- */
1186
- constructor(code?: RefOrNormal<string>);
1187
- /**
1188
- * The consistent translation of language, region and script display names.
1189
- *
1190
- * Последовательный перевод отображаемых названий языка, региона и скрипта.
1191
- * @param value the code to provide depends on the type/ предоставляемый код зависит от типа
1192
- * @param typeOptions an object with some or all of the following properties/
1193
- * объект с некоторыми или всеми из следующих свойств
1194
- */
1195
- display(value?: RefOrNormal<string>, typeOptions?: Intl.DisplayNamesOptions['type'] | Intl.DisplayNamesOptions): ComputedRef<string>;
1196
- /**
1197
- * Get display names of language.
1198
- *
1199
- * Получить отображаемые имена языка.
1200
- * @param value the code to provide depends on the type/ предоставляемый код зависит от типа
1201
- * @param style the formatting style to use/ используемый стиль форматирования
1202
- */
1203
- languageName(value?: RefOrNormal<string>, style?: Intl.RelativeTimeFormatStyle): ComputedRef<string>;
1204
- /**
1205
- * Get display names of region.
1206
- *
1207
- * Получить отображаемые имена региона.
1208
- * @param value the code to provide depends on the type/ предоставляемый код зависит от типа
1209
- * @param style the formatting style to use/ используемый стиль форматирования
1210
- */
1211
- countryName(value?: RefOrNormal<string>, style?: Intl.RelativeTimeFormatStyle): ComputedRef<string>;
1212
- /**
1213
- * In basic use without specifying a locale, a formatted string.
1214
- *
1215
- * При обычном использовании без указания локали форматированная строка
1216
- *
1217
- * @param value a number, bigint, or string, to format/ число для форматирования
1218
- * @param options an object with some or all properties/ объект с некоторыми
1219
- * или всеми свойствами
1220
- */
1221
- number(value: RefOrNormal<NumberOrString>, options?: Intl.NumberFormatOptions): ComputedRef<string>;
1222
- /**
1223
- * Decimal point symbol.
1224
- *
1225
- * Символ десятичной точки.
1226
- */
1227
- decimal(): ComputedRef<string>;
1228
- /**
1229
- * Currency formatting.
1230
- *
1231
- * Форматирование валюты.
1232
- * @param value a number, bigint, or string, to format/ число для форматирования
1233
- * @param currencyOptions the currency to use in currency formatting/
1234
- * валюта для использования в форматировании валюты
1235
- * @param numberOnly do not display the currency symbol/ не выводить значок валюты
1236
- */
1237
- currency(value: RefOrNormal<NumberOrString>, currencyOptions?: RefOrNormal<string | Intl.NumberFormatOptions>, numberOnly?: boolean): ComputedRef<string>;
1238
- /**
1239
- * Returns the currency symbol if it exists, otherwise the currency code.
1240
- *
1241
- * Возвращает символ для валюты, если он есть, или сам код валюты.
1242
- * @param currency the currency to use in currency formatting/
1243
- * валюта для использования в форматировании валюты
1244
- * @param currencyDisplay how to display the currency in currency formatting/
1245
- * как отобразить валюту в формате валюты
1246
- */
1247
- currencySymbol(currency: RefOrNormal<string>, currencyDisplay?: keyof Intl.NumberFormatOptionsCurrencyDisplayRegistry): ComputedRef<string>;
1248
- /**
1249
- * Unit formatting.
1250
- * If the style is 'unit', a unit property must be provided.
1251
- *
1252
- * Форматирование юнитов.
1253
- * @param value a number, bigint, or string, to format/ число для форматирования
1254
- * @param unitOptions the unit to use in unit formatting/ блок для использования
1255
- * в форматировании блока
1256
- */
1257
- unit(value: RefOrNormal<NumberOrString>, unitOptions?: string | Intl.NumberFormatOptions): ComputedRef<string>;
1258
- /**
1259
- * Возвращает отформатированный размер файла
1260
- * @param value a number, bigint, or string, to format /<br>число для форматирования
1261
- * @param unitOptions the unit to use in unit formatting /<br>блок для использования
1262
- * в форматировании блока
1263
- */
1264
- sizeFile(value: RefOrNormal<NumberOrString>, unitOptions?: 'byte' | 'kilobyte' | 'megabyte' | 'gigabyte' | 'terabyte' | 'petabyte' | Intl.NumberFormatOptions): ComputedRef<string>;
1265
- /**
1266
- * Number as a percentage.
1267
- *
1268
- * Число в виде процента.
1269
- * @param value a number, bigint, or string, to format/ число для форматирования
1270
- * @param options an object with some or all properties/ объект с некоторыми или всеми свойствами
1271
- */
1272
- percent(value: RefOrNormal<NumberOrString>, options?: Intl.NumberFormatOptions): ComputedRef<string>;
1273
- /**
1274
- * Number as a percentage (unit).
1275
- *
1276
- * Число в виде процента (единица).
1277
- * @param value a number, bigint, or string, to format/ число для форматирования
1278
- * @param options an object with some or all properties/
1279
- * объект с некоторыми или всеми свойствами
1280
- */
1281
- percentBy100(value: RefOrNormal<NumberOrString>, options?: Intl.NumberFormatOptions): ComputedRef<string>;
1282
- /**
1283
- * Применять форматирование, учитывающее множественное число, и языковые правила, связанные с множественным числом
1284
- * @param value a number, bigint, or string, to format/ число для форматирования
1285
- * @param words list of words for formatting (in the format one|two|few|many|other|zero)/
1286
- * список слов для форматирования (в формате `one|two|few|many|other|zero`)
1287
- * @param options Property for PluralRules/ свойство для PluralRules
1288
- * @param optionsNumber an object with some or all properties/ объект с некоторыми или всеми свойствами
1289
- */
1290
- plural(value: RefOrNormal<NumberOrString>, words: string, options?: Intl.PluralRulesOptions, optionsNumber?: Intl.NumberFormatOptions): ComputedRef<string>;
1291
- /**
1292
- * Enables language-sensitive date and time formatting.
1293
- *
1294
- * Конструктором объектов, включающих языка-зависимое форматирование даты и времени.
1295
- * @param value the date to format/ дата для форматирования
1296
- * @param type type of data format/ тип формата data
1297
- * @param styleOptions the representation of the month/ представление месяца
1298
- * @param hour24 whether to use 12-hour time/ использовать ли 12-часовое время
1299
- */
1300
- date(value: RefOrNormal<NumberOrStringOrDate>, type?: GeoDate, styleOptions?: Intl.DateTimeFormatOptions['month'] | Intl.DateTimeFormatOptions, hour24?: boolean): ComputedRef<string>;
1301
- /**
1302
- * Enables language-sensitive relative time formatting.
1303
- *
1304
- * Включает форматирование относительного времени с учетом языка.
1305
- * @param value a number, bigint, or string, to format/ число для форматирования
1306
- * @param styleOptions the length of the internationalized message/
1307
- * длина интернационализированного сообщения
1308
- * @param todayValue current day/ текущий день
1309
- */
1310
- relative(value: RefOrNormal<NumberOrStringOrDate>, styleOptions?: Intl.RelativeTimeFormatStyle | Intl.RelativeTimeFormatOptions, todayValue?: Date): ComputedRef<string>;
1311
- /**
1312
- * Enables language-sensitive relative time formatting
1313
- * Including the ability to add a limit to output the standard time format if the value
1314
- * exceeds the allowable limit.
1315
- *
1316
- * Включает форматирование относительного времени с учетом языка.
1317
- * Включая возможность добавления лимита, чтобы выводить уже стандартный формат времени,
1318
- * если значение вышло за пределы допустимого.
1319
- * @param value a number, bigint, or string, to format/ число для форматирования
1320
- * @param limit values that determine the output limit (values per day)/
1321
- * значения, по которым определяем предел вывода (значения в день)
1322
- * @param todayValue current day/ текущий день
1323
- * @param relativeOptions the length of the internationalized message/
1324
- * длина интернационализированного сообщения
1325
- * @param dateOptions the representation of the month/ представление месяца
1326
- * @param type type of data format/ тип формата data
1327
- * @param hour24 whether to use 12-hour time/ использовать ли 12-часовое время
1328
- */
1329
- relativeLimit(value: RefOrNormal<NumberOrStringOrDate>, limit: number, todayValue?: Date, relativeOptions?: Intl.RelativeTimeFormatStyle | Intl.RelativeTimeFormatOptions, dateOptions?: Intl.DateTimeFormatOptions['month'] | Intl.DateTimeFormatOptions, type?: GeoDate, hour24?: boolean): ComputedRef<string>;
1330
- /**
1331
- * Возвращает отформатированное значение времени, прошедшего с момента события
1332
- * @param value a number, bigint, or string, to format/ число для форматирования
1333
- * @param unit time unit/ единица времени
1334
- * @param styleOptions additional option or formatting style/ дополнительная опция или стиль форматирования
1335
- */
1336
- relativeByValue(value: RefOrNormal<NumberOrString>, unit: Intl.RelativeTimeFormatUnit, styleOptions?: Intl.RelativeTimeFormatStyle | Intl.RelativeTimeFormatOptions): ComputedRef<string>;
1337
- /**
1338
- * Names of months.
1339
- *
1340
- * Названия месяцев.
1341
- * @param value the date to format/ дата для форматирования
1342
- * @param style the representation of the month/ представление месяца
1343
- */
1344
- month(value?: RefOrNormal<NumberOrStringOrDate>, style?: Intl.DateTimeFormatOptions['month']): ComputedRef<string>;
1345
- /**
1346
- * Array to list of months.
1347
- *
1348
- * Массив в список месяцев.
1349
- * @param style the representation of the month/ представление месяца
1350
- */
1351
- months(style?: Intl.DateTimeFormatOptions['month']): ComputedRef<ItemValue<number | undefined>[]>;
1352
- /**
1353
- * Returns names of days of the week.
1354
- *
1355
- * Возвращает названия дней недели.
1356
- * @param value the date to format/ дата для форматирования
1357
- * @param style the representation of the weekday/ представление о дне недели
1358
- */
1359
- weekday(value?: RefOrNormal<NumberOrStringOrDate>, style?: Intl.DateTimeFormatOptions['weekday']): ComputedRef<string>;
1360
- /**
1361
- * An array of the list of names of the days of the week.
1362
- *
1363
- * Массив из списка названий дней недели.
1364
- * @param style the representation of the weekday/ представление о дне недели
1365
- */
1366
- weekdays(style?: Intl.DateTimeFormatOptions['weekday']): ComputedRef<ItemValue<number | undefined>[]>;
1367
- /**
1368
- * Time.
1369
- *
1370
- * Время.
1371
- * @param value the date to format/ дата для форматирования
1372
- */
1373
- time(value: RefOrNormal<NumberOrStringOrDate>): ComputedRef<string>;
1374
- /**
1375
- * Sorts strings taking into account the characteristics of countries.
1376
- *
1377
- * Сортирует строки с учетом особенностей стран.
1378
- * @param data an array with data/ массив с данными
1379
- * @param compareFn a function for sorting/ функция для сортировки
1380
- */
1381
- sort<T>(data: RefOrNormal<T[]>, compareFn?: (a: T, b: T) => [string, string]): ComputedRef<T[]>;
1382
- }
1383
-
1384
- /**
1385
- * Reactive class for working with geographic data.
1386
- *
1387
- * Реактивный класс для работы с географическими данными.
1388
- */
1389
- export declare class GeoRef {
1390
- private static readonly country;
1391
- private static readonly language;
1392
- private static readonly standard;
1393
- private static readonly firstDay;
1394
- /**
1395
- * Information about the current country.
1396
- *
1397
- * Информация об текущей стране.
1398
- * @returns reactive object with full geographic information/ реактивный объект с полной географической информацией
1399
- */
1400
- static get(): Ref<GeoItemFull>;
1401
- /**
1402
- * Current country.
1403
- *
1404
- * Текущая страна.
1405
- * @returns reactive string with the current country code/ реактивная строка с кодом текущей страны
1406
- */
1407
- static getCountry(): ComputedRef<string>;
1408
- /**
1409
- * Current language.
1410
- *
1411
- * Текущий язык.
1412
- * @returns reactive string with the current language code/ реактивная строка с кодом текущего языка
1413
- */
1414
- static getLanguage(): ComputedRef<string>;
1415
- /**
1416
- * Full format according to the standard.
1417
- *
1418
- * Полный формат согласно стандарту.
1419
- * @returns reactive string with the full standard locale format/
1420
- * реактивная строка с полным форматом стандарта локали
1421
- */
1422
- static getStandard(): ComputedRef<string>;
1423
- /**
1424
- * Returns the first day of the week.
1425
- *
1426
- * Возвращает первый день недели.
1427
- * @returns reactive string representing the first day of the week/
1428
- * реактивная строка, представляющая первый день недели
1429
- */
1430
- static getFirstDay(): ComputedRef<string>;
1431
- /**
1432
- * Changes the data by the full code.
1433
- *
1434
- * Изменяет данные по полному коду.
1435
- * @param code country code, full form language-country or one of them/
1436
- * код страны, полный вид язык-страна или один из них
1437
- */
1438
- static set(code: string): void;
1439
- }
1440
-
1441
- /**
1442
- * A method for generating properties for a subcomponent.
1443
- *
1444
- * Метод для генерации свойств для под компонента.
1445
- * @param value input value. Can be an object if you need to pass multiple properties/
1446
- * входное значение. Может быть объектом, если надо передать несколько свойств
1447
- * @param nameExtra additional parameter or property name/ дополнительный параметр или имя свойства
1448
- * @param name property name/ имя свойства
1449
- * @param except exclude the rule requiring the presence of a primary key/
1450
- * исключить правило обязательности наличия главного ключа
1451
- */
1452
- export declare function getBind<T, R extends ItemList>(value: T | R | undefined | null, nameExtra?: ItemList | string, name?: string, except?: boolean): ConstrBind<R>;
1453
-
1454
- /**
1455
- * A method for generating properties for a subcomponent.
1456
- *
1457
- * Метод для генерации свойств для под компонента.
1458
- * @param value input value. Can be an object if you need to pass multiple properties/
1459
- * входное значение. Может быть объектом, если надо передать несколько свойств
1460
- * @param nameExtra additional parameter or property name/ дополнительный параметр или имя свойства
1461
- * @param name property name/ имя свойства
1462
- */
1463
- export declare function getBindRef<T, R extends ItemList>(value: RefOrNormal<T | R> | undefined, nameExtra?: RefOrNormal<ItemList> | string, name?: string): ComputedRef<R>;
1464
-
1465
- /**
1466
- * Returns the name of the class from the property.
1467
- *
1468
- * Возвращает название класса из свойства.
1469
- * @param props property of the component/ свойство компонента
1470
- */
1471
- export declare function getClassName<T extends ItemList>(props?: T): string | undefined;
1472
-
1473
- /**
1474
- * Returns or generates a new element.
1475
- *
1476
- * Возвращает или генерирует новый элемент.
1477
- * @param name name of the component/ названия компонента
1478
- * @param props property of the component/ свойство компонента
1479
- * @param index the name of the key/ названия ключа
1480
- */
1481
- export declare function getIndexForRender<T extends ItemList>(name: string | any, props?: T, index?: string): string | undefined;
1482
-
1483
- /**
1484
- * Get injected value by name.
1485
- *
1486
- * Получение внедренного значения по имени.
1487
- * @param name Key name / Имя ключа
1488
- */
1489
- export declare function getInject<T>(name: string): T | undefined;
1490
-
1491
- /**
1492
- * Get request options.
1493
- *
1494
- * Возвращает опции запроса.
1495
- * @param options options / параметры
1496
- */
1497
- export declare const getOptions: (options?: ApiOptions) => RefOrNormal<ApiFetch>;
1498
-
1499
- /**
1500
- * You return the values of the ref variable or the variable itself if it is not reactive.
1501
- *
1502
- * Возвращаешь значения ref переменной или саму переменную, если она не реактивная.
1503
- * @param item reactive variable or ordinary value/ реактивная переменная или обычное значение
1504
- */
1505
- export declare function getRef<T>(item: RefOrNormal<T>): T;
1506
-
1507
- export declare type LazyItem = {
1508
- status: ShallowRef<boolean>;
1509
- ratio: ShallowRef<number>;
1510
- entry: ShallowRef<IntersectionObserverEntry | undefined>;
1511
- stopWatch: () => void;
1512
- };
1513
-
1514
- export declare type LazyItemByMargin = {
1515
- rootMargin: string;
1516
- item: any;
1517
- };
1518
-
1519
- export declare type LazyList = Record<string, LazyItem>;
1520
-
1521
- /** Basic data structure for list item/ Базовая структура данных для элемента списка */
1522
- export declare type ListDataBasic = {
1523
- /** Optional display label/ Опциональная отображаемая метка */
1524
- label?: NumberOrString;
1525
- /** Any value associated with the item/ Любое значение, связанное с элементом */
1526
- value?: any;
1527
- /** Search text for filtering/ Текст поиска для фильтрации */
1528
- search?: string;
1529
- };
1530
-
1531
- /**
1532
- * Array of extended list items with state/
1533
- * Массив расширенных элементов списка с состоянием
1534
- */
1535
- export declare type ListDataFull<Item extends ListDataBasic = ListDataBasic> = ListDataFullItem<Item>[];
1536
-
1537
- /**
1538
- * Extended list item with additional state properties/
1539
- * Расширенный элемент списка с дополнительными свойствами состояния
1540
- */
1541
- export declare type ListDataFullItem<Item extends ListDataBasic = ListDataBasic> = ListDataItem<Item> & {
1542
- /** Whether the item has focus/ Имеет ли элемент фокус */
1543
- focus: boolean;
1544
- /** Highlighted text portion/ Выделенная часть текста */
1545
- highlight?: string;
1546
- /** Whether the item is selected/ Выбран ли элемент */
1547
- selected: boolean;
1548
- /** Whether the item is disabled/ Отключен ли элемент */
1549
- disabled?: boolean;
1550
- };
1551
-
1552
- /** Extended list item with type and index/ Расширенный элемент списка с типом и индексом */
1553
- export declare type ListDataItem<Item extends ListDataBasic = ListDataBasic> = ConstrBind<Item & {
1554
- /** Parent item identifier/ Идентификатор родительского элемента */
1555
- parent?: string;
1556
- /** Type of list item/ Тип элемента списка */
1557
- type: ListType;
1558
- /** Unique item identifier/ Уникальный идентификатор элемента */
1559
- index: string;
1560
- }>;
1561
-
1562
- /**
1563
- * Class for managing the data list.
1564
- *
1565
- * Класс для управления списком данных.
1566
- */
1567
- export declare class ListDataRef {
1568
- protected readonly list: RefOrNormal<ListListInput | undefined>;
1569
- protected readonly focus?: RefType<ListSelectedItem | undefined> | undefined;
1570
- protected readonly highlight?: RefType<string | undefined> | undefined;
1571
- protected readonly highlightLengthStart?: RefType<number | undefined> | undefined;
1572
- protected readonly filterMode?: RefType<boolean | undefined> | undefined;
1573
- protected readonly selected?: RefType<ListSelectedList | undefined> | undefined;
1574
- protected readonly keyValue?: RefType<string | undefined> | undefined;
1575
- protected readonly keyLabel?: RefType<string | undefined> | undefined;
1576
- protected readonly lite?: RefType<number | undefined> | undefined;
1577
- protected readonly min: RefOrNormal<number | string | undefined>;
1578
- protected readonly max: RefOrNormal<number | string | undefined>;
1579
- protected readonly parent?: string | undefined;
1580
- protected subList: Record<any, ListDataRef>;
1581
- /**
1582
- * Creates an instance of ListData for managing list data.
1583
- *
1584
- * Создает экземпляр ListData для управления данными списка.
1585
- * @param list List data / данные списка
1586
- * @param focus Focused item / элемент в фокусе
1587
- * @param highlight Search text for highlighting / текст поиска для выделения
1588
- * @param highlightLengthStart Minimum length to start highlighting / минимальная длина для начала выделения
1589
- * @param filterMode Filter mode / режим фильтрации
1590
- * @param selected Selected items / выбранные элементы
1591
- * @param keyValue Key for getting item value / ключ для получения значения элемента
1592
- * @param keyLabel Key for getting item label / ключ для получения метки элемента
1593
- * @param lite Threshold for lite mode / порог для облегченного режима
1594
- * @param min Minimum number of selections / минимальное количество выделений
1595
- * @param max Maximum number of selections / максимальное количество выделений
1596
- * @param parent Parent identifier / идентификатор родителя
1597
- */
1598
- constructor(list: RefOrNormal<ListListInput | undefined>, focus?: RefType<ListSelectedItem | undefined> | undefined, highlight?: RefType<string | undefined> | undefined, highlightLengthStart?: RefType<number | undefined> | undefined, filterMode?: RefType<boolean | undefined> | undefined, selected?: RefType<ListSelectedList | undefined> | undefined, keyValue?: RefType<string | undefined> | undefined, keyLabel?: RefType<string | undefined> | undefined, lite?: RefType<number | undefined> | undefined, min?: RefOrNormal<number | string | undefined>, max?: RefOrNormal<number | string | undefined>, parent?: string | undefined);
1599
- /**
1600
- * Returns a list for forming a list.
1601
- *
1602
- * Возвращает список для формирования списка.
1603
- * @returns reactive list of items/ реактивный список элементов
1604
- */
1605
- readonly data: ComputedRef<ListList>;
1606
- /**
1607
- * Returns a simplified list for quick loading.
1608
- *
1609
- * Возвращает упрощенный список для быстрой загрузки.
1610
- * @returns simplified reactive list/ упрощенный реактивный список
1611
- */
1612
- readonly liteData: ComputedRef<ListList>;
1613
- /**
1614
- * Returns a list of records with all additional data (focus, selection, disabled status).
1615
- *
1616
- * Возвращает список записей со всеми дополнительными данными (фокус, выделение, статус активности).
1617
- * @returns full reactive list/ полный реактивный список
1618
- */
1619
- readonly fullData: ComputedRef<ListDataFull>;
1620
- /**
1621
- * Returns a flat map of all entries including sublists.
1622
- *
1623
- * Возвращает плоскую карту всех записей, включая подсписки.
1624
- * @returns reactive flat list/ реактивный плоский список
1625
- */
1626
- readonly map: ComputedRef<ListList>;
1627
- /** Returns a list consisting only of items/ Возвращает список, состоящий только из элементов. */
1628
- readonly mapItems: ComputedRef<ListList>;
1629
- /**
1630
- * Returns a list consisting only of values for selection (item, group, menu).
1631
- *
1632
- * Возвращает список, состоящий только из значений для выбора (item, group, menu).
1633
- * @returns reactive list/ реактивный список
1634
- */
1635
- readonly items: ComputedRef<ListList>;
1636
- /**
1637
- * Finds the first element that meets the search conditions.
1638
- *
1639
- * Находит первый элемент, соответствующий условиям поиска.
1640
- * @returns first found index/ первый найденный индекс
1641
- */
1642
- readonly highlightFirstItem: ComputedRef<number>;
1643
- /**
1644
- * Is there a selected item.
1645
- *
1646
- * Есть ли выбранный элемент.
1647
- * @returns true if selection exists/ true, если есть выбор
1648
- */
1649
- readonly isSelected: ComputedRef<boolean>;
1650
- /**
1651
- * Is the minimum selection reached.
1652
- *
1653
- * Достигнуто ли минимальное выделение.
1654
- * @returns true if minimum reached/ true, если минимум достигнут
1655
- */
1656
- readonly isSelectedMin: ComputedRef<boolean>;
1657
- /**
1658
- * Is the maximum selection reached.
1659
- *
1660
- * Достигнуто ли максимальное выделение.
1661
- * @returns true if maximum reached/ true, если максимум достигнут
1662
- */
1663
- readonly isSelectedMax: ComputedRef<boolean>;
1664
- /**
1665
- * Returns a list of selected items on the map.
1666
- *
1667
- * Возвращает список выделенных элементов на карте.
1668
- * @returns reactive list of selected items/ реактивный список выделенных элементов
1669
- */
1670
- readonly selectedList: ComputedRef<ListList>;
1671
- /**
1672
- * Returns a list of selected items in the current group.
1673
- *
1674
- * Возвращает список выделенных элементов в текущей группе.
1675
- * @returns reactive list of selected items in group/ реактивный список выделенных элементов в группе
1676
- */
1677
- readonly selectedListInGroup: ComputedRef<ListList>;
1678
- /**
1679
- * Returns a list of selected labels on the map.
1680
- *
1681
- * Возвращает список названий выделенных элементов на карте.
1682
- * @returns reactive list of labels/ реактивный список названий
1683
- */
1684
- readonly selectedNames: ComputedRef<ListNames>;
1685
- /**
1686
- * Returns a list of selected values on the map.
1687
- *
1688
- * Возвращает список значений выделенных элементов на карте.
1689
- * @returns reactive list of values/ реактивный список значений
1690
- */
1691
- readonly selectedValues: ComputedRef<any[]>;
1692
- /**
1693
- * Checks whether it is necessary to first display a simplified version.
1694
- *
1695
- * Проверяет, надо ли сначала вывести упрощенную версию.
1696
- * @returns true if lite mode is active/ true, если активен облегченный режим
1697
- */
1698
- isLite(): boolean;
1699
- /**
1700
- * Checks if an element is in focus.
1701
- *
1702
- * Проверяет, есть ли элемент в фокусе.
1703
- * @returns true if focus exists/ true, если есть фокус
1704
- */
1705
- isFocus(): boolean;
1706
- /**
1707
- * Checks if there is a highlighted item (search results).
1708
- *
1709
- * Проверяет, есть ли найденный элемент (результаты поиска).
1710
- * @returns true if highlight exists/ true, если есть совпадения
1711
- */
1712
- isHighlight(): boolean;
1713
- /**
1714
- * Checks if highlighting is active (minimum length reached).
1715
- *
1716
- * Проверяет, активно ли выделение (достигнута минимальная длина).
1717
- * @returns true if active/ true, если активно
1718
- */
1719
- isHighlightActive(): boolean;
1720
- /**
1721
- * Returns the number of records in the current list.
1722
- *
1723
- * Возвращает количество записей в текущем списке.
1724
- * @returns length/ количество
1725
- */
1726
- getLength(): number;
1727
- /**
1728
- * Returns the number of all available records in the map.
1729
- *
1730
- * Возвращает количество всех доступных записей в карте.
1731
- * @returns length/ количество
1732
- */
1733
- getLengthByMap(): number;
1734
- /**
1735
- * Returns the number of all available records (items).
1736
- *
1737
- * Возвращает количество всех доступных записей (элементы).
1738
- * @returns length/ количество
1739
- */
1740
- getLengthByItems(): number;
1741
- /**
1742
- * Returns the identifier in focus.
1743
- *
1744
- * Возвращает идентификатор в фокусе.
1745
- * @returns focus identifier/ идентификатор в фокусе
1746
- */
1747
- getFocus(): ListSelectedItem | undefined;
1748
- /**
1749
- * Returns the highlight text.
1750
- *
1751
- * Возвращает текст для выделения.
1752
- * @returns text/ текст
1753
- */
1754
- getHighlight(): string | undefined;
1755
- /**
1756
- * Returns the minimum length for highlight to start.
1757
- *
1758
- * Возвращает минимальную длину для начала выделения.
1759
- * @returns length/ длина
1760
- */
1761
- getHighlightLengthStart(): number;
1762
- /**
1763
- * Returns the selected identifiers list.
1764
- *
1765
- * Возвращает список выбранных идентификаторов.
1766
- * @returns list/ список
1767
- */
1768
- getSelected(): ListSelectedList | undefined;
1769
- /**
1770
- * Returns an item by moving a certain number of steps from the selected item.
1771
- *
1772
- * Возвращает элемент, перемещаясь на определенное количество шагов от выбранного элемента.
1773
- * @param step number of steps/ количество шагов
1774
- * @returns target item index/ индекс целевого элемента
1775
- */
1776
- getSelectedByStep(step: number): ListSelectedItem | undefined;
1777
- /**
1778
- * Returns the next item from the selected one.
1779
- *
1780
- * Возвращает следующий элемент от выбранного.
1781
- * @returns next item index/ индекс следующего элемента
1782
- */
1783
- getSelectedNext(): ListSelectedItem | undefined;
1784
- /**
1785
- * Returns the previous item from the selected one.
1786
- *
1787
- * Возвращает предыдущий элемент от выбранного.
1788
- * @returns previous item index/ индекс предыдущего элемента
1789
- */
1790
- getSelectedPrev(): ListSelectedItem | undefined;
1791
- /**
1792
- * Returns an item by moving a certain number of steps from the specified item.
1793
- *
1794
- * Возвращает элемент, перемещаясь на определенное количество шагов от указанного элемента.
1795
- * @param item item/ элемент
1796
- * @param step number of steps/ количество шагов
1797
- * @returns target item/ целевой элемент
1798
- */
1799
- getItemByStep(item: ListDataItem, step: number): ListDataItem | undefined;
1800
- /**
1801
- * Returns the next item from the specified one.
1802
- *
1803
- * Возвращает следующий элемент от указанного.
1804
- * @param item item/ элемент
1805
- * @returns next item/ следующий элемент
1806
- */
1807
- getItemNext(item: ListDataItem): ListDataItem | undefined;
1808
- /**
1809
- * Returns the previous item from the specified one.
1810
- *
1811
- * Возвращает предыдущий элемент от указанного.
1812
- * @param item item/ элемент
1813
- * @returns previous item/ предыдущий элемент
1814
- */
1815
- getItemPrev(item: ListDataItem): ListDataItem | undefined;
1816
- /**
1817
- * Returns an item by moving a certain number of steps from the specified index.
1818
- *
1819
- * Возвращает элемент, перемещаясь на определенное количество шагов от указанного индекса.
1820
- * @param index item index/ индекс элемента
1821
- * @param step number of steps/ количество шагов
1822
- * @returns target item/ целевой элемент
1823
- */
1824
- getIndexByStep(index: string, step: number): ListDataItem | undefined;
1825
- /**
1826
- * Returns the next item from the specified index.
1827
- *
1828
- * Возвращает следующий элемент от указанного индекса.
1829
- * @param index item index/ индекс элемента
1830
- * @returns next item/ следующий элемент
1831
- */
1832
- getIndexNext(index: string): ListDataItem | undefined;
1833
- /**
1834
- * Returns the previous item from the specified index.
1835
- *
1836
- * Возвращает предыдущий элемент от указанного индекса.
1837
- * @param index item index/ индекс элемента
1838
- * @returns previous item/ предыдущий элемент
1839
- */
1840
- getIndexPrev(index: string): ListDataItem | undefined;
1841
- /**
1842
- * Returns an item by its index.
1843
- *
1844
- * Возвращает элемент по его индексу.
1845
- * @param index item index/ индекс элемента
1846
- * @returns found item details/ информация о найденном элементе
1847
- */
1848
- getItemByIndex(index?: string): {
1849
- key: number;
1850
- item: ListDataItem;
1851
- } | undefined;
1852
- /**
1853
- * Returns an item by its key.
1854
- *
1855
- * Возвращает элемент по его ключу.
1856
- * @param key item key/ ключ элемента
1857
- * @returns found item/ найденный элемент
1858
- */
1859
- getItemByKey(key: number): ListDataItem | undefined;
1860
- /**
1861
- * Returns the first item with the specified parent.
1862
- *
1863
- * Возвращает первый элемент с указанным родителем.
1864
- * @param parent parent identifier to search for / идентификатор родителя для поиска
1865
- * @returns first item/ первый элемент
1866
- */
1867
- getFirstItemByParent(parent: string | undefined): ListDataItem | undefined;
1868
- /**
1869
- * Returns the last item with the specified parent.
1870
- *
1871
- * Возвращает последний элемент с указанным родителем.
1872
- * @param parent parent identifier to search for / идентификатор родителя для поиска
1873
- * @returns last item/ последний элемент
1874
- */
1875
- getLastItemByParent(parent: string | undefined): ListDataItem | undefined;
1876
- /**
1877
- * Returns a sublist object for a group item.
1878
- *
1879
- * Возвращает объект подсписка для группового элемента.
1880
- * @param item List item data/ данные элемента списка
1881
- * @returns sublist instance/ экземпляр подсписка
1882
- */
1883
- getSubList(item: ListDataItem): ListDataRef;
1884
- /**
1885
- * Checks if the item is an item, group, or menu.
1886
- *
1887
- * Проверяет, является ли элемент элементом, группой или меню.
1888
- * @param item List item data/ данные элемента списка
1889
- */
1890
- protected isItem(item: ListDataItem): boolean;
1891
- /**
1892
- * Checks if the item is in the specified parent.
1893
- *
1894
- * Проверяет, находится ли элемент в указанном родителе.
1895
- * @param parent parent identifier to search for / идентификатор родителя для поиска
1896
- * @param item List item data/ данные элемента списка
1897
- */
1898
- protected isInParent(parent: string | undefined, item: ListDataItem): boolean;
1899
- /**
1900
- * Returns the index for the list item.
1901
- *
1902
- * Возвращает индекс для элемента списка.
1903
- * @param index current index / текущий индекс
1904
- * @param value item value / значение элемента
1905
- * @param key item key / ключ элемента
1906
- * @param label item label / метка элемента
1907
- */
1908
- protected getIndex(index: string | number | undefined, value: any, key: string | number | undefined, label: string | number | undefined): string | number | undefined;
1909
- /**
1910
- * Creates an object of the record element.
1911
- *
1912
- * Создает объект элемента записи.
1913
- * @param key the value of the key in the element/ значения ключа у элемента
1914
- * @param item selected element/ выбранный элемент
1915
- */
1916
- protected initItem(key: string | number, item: any): ListDataItem;
1917
- }
1918
-
1919
- /** Array of list data items/ Массив элементов данных списка */
1920
- export declare type ListList<Item extends ListDataBasic = ListDataBasic> = ListDataItem<Item>[];
1921
-
1922
- /**
1923
- * Various input formats for list creation/
1924
- * Различные форматы входных данных для создания списка
1925
- */
1926
- export declare type ListListInput<Item extends ListDataBasic = ListDataBasic> = ListListInputItem<Item>[] | string[] | Record<string, ListListInputItem<Item>> | Record<string, string>;
1927
-
1928
- /** Input item for list creation/ Входной элемент для создания списка */
1929
- export declare type ListListInputItem<Item extends ListDataBasic = ListDataBasic> = ConstrBind<Item>;
1930
-
1931
- /** Name of selected list item/ Название выбранного элемента списка */
1932
- export declare type ListName = string | number | undefined;
1933
-
1934
- /** Array of list item names/ Массив названий выбранных элементов списка */
1935
- export declare type ListNames = ListName[];
1936
-
1937
- /**
1938
- * List or record structure for list data/
1939
- * Структура списка или записи для данных списка
1940
- */
1941
- export declare type ListRecord<Item extends ListDataBasic = ListDataBasic> = ListList<Item> | Record<string, any>;
1942
-
1943
- /** Single selected item identifier/ Идентификатор одного выбранного элемента */
1944
- export declare type ListSelectedItem = NumberOrStringOrBoolean;
1945
-
1946
- /** Single or multiple selected items/ Один или несколько выбранных элементов */
1947
- export declare type ListSelectedList = ListSelectedItem | ListSelectedItem[];
1948
-
1949
- /** Type of list item/ Тип элемента списка */
1950
- export declare type ListType = 'item' | 'space' | 'line' | 'subtitle' | 'html' | 'menu' | 'menu-group' | 'group';
1951
-
1952
- /**
1953
- * Union type for Vue raw children content
1954
- * (strings, numbers, booleans, VNodes, arrays, functions)/
1955
- * Объединенный тип для Vue сырого содержимого дочерних элементов
1956
- * (строки, числа, булевы, VNode, массивы, функции)
1957
- */
1958
- export declare type RawChildren = string | number | boolean | VNode | VNodeArrayChildren | (() => any);
1959
-
1960
- /**
1961
- * Type for Vue raw slots with optional stability flag/
1962
- * Тип для Vue сырых слотов с опциональным флагом стабильности
1963
- */
1964
- export declare type RawSlots = {
1965
- /** Slot name mapping to unknown content/ Маппинг имени слота к неизвестному содержимому */
1966
- [name: string]: unknown;
1967
- /**
1968
- * Optional stability flag for performance optimization/
1969
- * Опциональный флаг стабильности для оптимизации производительности
1970
- */
1971
- $stable?: boolean;
1972
- };
1973
-
1974
- /**
1975
- * Union type that can be either a Vue reactive reference or a normal value/
1976
- * Объединенный тип, который может быть либо Vue реактивной ссылкой, либо обычным значением
1977
- */
1978
- export declare type RefOrNormal<T> = RefType<T> | T;
1979
-
1980
- /**
1981
- * Union type for Vue reactive references (computed or ref)/
1982
- * Объединенный тип для Vue реактивных ссылок (computed или ref)
1983
- */
1984
- export declare type RefType<T> = ComputedRef<T> | Ref<T>;
1985
-
1986
- /**
1987
- * Union type for Vue reactive references that can be undefined/
1988
- * Объединенный тип для Vue реактивных ссылок, которые могут быть undefined
1989
- */
1990
- export declare type RefUndefined<T> = RefType<T | undefined>;
1991
-
1992
- /**
1993
- * Getting cached, immutable data.
1994
- *
1995
- * Получение кешированных, неизменяемых данных.
1996
- * @param name name of the component/ названия компонента
1997
- * @param props property of the component/ свойство компонента
1998
- * @param children sub-elements of the component/ под элементы компонента
1999
- * @param index the name of the key/ названия ключа
2000
- */
2001
- export declare function render<T extends ItemList>(name: string | any, props?: T, children?: RawChildren | RawSlots, index?: string): VNode;
2002
-
2003
- /**
2004
- * Router management class.
2005
- *
2006
- * Класс управления роутером.
2007
- */
2008
- export declare class RouterItemRef {
2009
- /**
2010
- * Get router instance.
2011
- *
2012
- * Получить экземпляр роутера.
2013
- */
2014
- static get(): Router;
2015
- /**
2016
- * Returns the link by name.
2017
- *
2018
- * Возвращает ссылку по имени.
2019
- * @param name route name/ имя маршрута
2020
- * @param params route parameters/ параметры маршрута
2021
- * @param query route query/ запрос маршрута
2022
- */
2023
- static getLink(name: string, params?: any, query?: any): string | undefined;
2024
- /**
2025
- * Returns the link property by name.
2026
- *
2027
- * Возвращает свойство ссылки по имени.
2028
- * @param name route name/ имя маршрута
2029
- * @param params route parameters/ параметры маршрута
2030
- * @param query route query/ запрос маршрута
2031
- */
2032
- static getHref(name?: string, params?: any, query?: any): ConstrHrefProps;
2033
- /**
2034
- * Site path change.
2035
- *
2036
- * Изменение пути сайта.
2037
- * @param to new path/ новый путь
2038
- */
2039
- static push(to: string | RouteLocationRaw): void;
2040
- /**
2041
- * Set router instance.
2042
- *
2043
- * Установить экземпляр роутера.
2044
- * @param router router instance/ экземпляр роутера
2045
- */
2046
- static set(router: Router): void;
2047
- /**
2048
- * Set router instance only once.
2049
- *
2050
- * Установить экземпляр роутера только один раз.
2051
- * @param router router instance/ экземпляр роутера
2052
- */
2053
- static setOneTime(router: Router): void;
2054
- /**
2055
- * Converts the raw route location to href properties.
2056
- *
2057
- * Преобразует необработанное местоположение маршрута в свойства href.
2058
- * @param to raw route location/ необработанное местоположение маршрута
2059
- */
2060
- static rawToHref(to?: string | RouteLocationRaw): ConstrHrefProps;
2061
- }
2062
-
2063
- /**
2064
- * Class for getting the scroll width as a reactive item.
2065
- *
2066
- * Класс для получения ширины скролла в виде реактивного элемента.
2067
- */
2068
- export declare class ScrollbarWidthRef {
2069
- /** Reactive item/ Реактивный элемент */
2070
- readonly item: Ref<boolean | undefined, boolean | undefined>;
2071
- /** Reactive width/ Реактивная ширина */
2072
- readonly width: Ref<number, number>;
2073
- /**
2074
- * Constructor
2075
- */
2076
- constructor();
2077
- /**
2078
- * Checks whether the scroll width is defined.
2079
- *
2080
- * Проверяет, определена ли ширина скролла.
2081
- */
2082
- readonly is: ComputedRef<boolean>;
2083
- }
2084
-
2085
- /** Search list input / Входные данные списка поиска */
2086
- export declare type SearchListInput<T extends SearchItem> = SearchListValueRef<T> | (() => SearchListValueRef<T>);
2087
-
2088
- /** Search list data / Данные списка поиска */
2089
- export declare type SearchListValueRef<T extends SearchItem> = RefOrNormal<SearchListValue<T>>;
2090
-
2091
- /**
2092
- * Defines global conditions for the API request.
2093
- *
2094
- * Определяет глобальные условия для API запроса.
2095
- * @param conditions conditions for executing the request/ условия выполнения запроса
2096
- */
2097
- export declare const setApiRefGlobalConditions: (conditions: RefType<any>) => void;
2098
-
2099
- /**
2100
- * Changing the value for the reactive method.
2101
- *
2102
- * Изменение значения для реактивного метода.
2103
- * @param item reactive element/ реактивный элемент
2104
- * @param value values for replacement/ значения для замены
2105
- */
2106
- export declare function setRef<T>(item: Ref<T>, value: T): void;
2107
-
2108
- /**
2109
- * Shorthand for useTranslateRef.
2110
- * Use `as const` for arrays to ensure proper TypeScript key inference.
2111
- *
2112
- * ---
2113
- *
2114
- * Сокращение для useTranslateRef.
2115
- * Используйте `as const` для массивов, чтобы обеспечить корректный вывод типов ключей в TypeScript.
2116
- *
2117
- * @param names a string or an array with keys / строка или массив с ключами
2118
- */
2119
- export declare const t: <T extends string[]>(names: T) => ShallowRef<TranslateList<T>>;
2120
-
2121
- /**
2122
- * Merges two objects with properties, taking into account their classes and styles
2123
- *
2124
- * Объединяет два объекта со свойствами с учётом классов и стилей в них
2125
- * @param extra additional property/ дополнительное свойство
2126
- * @param value input value/ входное значение
2127
- */
2128
- export declare function toBind<R extends ItemList = ItemList>(extra: ItemList, value: ItemList): ConstrBind<R>;
2129
-
2130
- /**
2131
- * Merges multiple objects with properties, taking into account their classes and styles
2132
- *
2133
- * Объединяет несколько объектов со свойствами с учётом классов и стилей в них
2134
- * @param values list of input values/ список входных значений
2135
- */
2136
- export declare function toBinds<R extends ItemList = ItemList>(...values: (ItemList | undefined)[]): ConstrBind<R>;
2137
-
2138
- /**
2139
- * Returns a regular variable or wraps it in a regular variable if it is an ordinary variable.
2140
- *
2141
- * Возвращает регулярный переменный или оборачивает его в регулярный переменный, если является обычным переменным.
2142
- * @param item
2143
- */
2144
- export declare function toRefItem<T>(item: RefOrNormal<T>): Ref<T>;
2145
-
2146
- /** Utility type to convert union types to intersection types/ Утилитарный тип для преобразования объединенных типов в пересеченные */
2147
- export declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
2148
-
2149
- /**
2150
- * Executes a request and immediately initializes it asynchronously.
2151
- *
2152
- * Выполняет запрос и сразу инициализирует его асинхронно.
2153
- * @param path path to request / путь к запросу
2154
- * @param options data for the request / данные для запроса
2155
- * @param reactivity should reactivity be enabled / включить ли reactivity
2156
- * @param conditions conditions for executing the request / условия выполнения запроса
2157
- * @param transformation transforms the received request / преобразовывает полученный запрос
2158
- * @param validateResponseContract function to validate response data contract / функция для проверки контракта данных ответа
2159
- * @param unmounted delete data from the cache / удалить ли данные из кеша
2160
- * @param apiInstance Api instance / Экземпляр Api
2161
- */
2162
- export declare function useApiAsyncRef<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, unmounted?: boolean, apiInstance?: ApiInstance): UseApiRef<R>;
2163
-
2164
- /**
2165
- * Use API delete request.
2166
- *
2167
- * Использование API delete запроса.
2168
- * @param path Path to the API endpoint / Путь к endpoint API
2169
- * @param action Action to perform after the request / Действие, выполняемое после запроса
2170
- * @param transformation Transformation function / Функция трансформации
2171
- * @param toData Extract 'data' field from response / Извлечь поле 'data' из ответа
2172
- * @param options Additional request options / Дополнительные опции запроса
2173
- * @param apiInstance Api instance / Экземпляр Api
2174
- * @returns Object with loading state and send method / Объект с состоянием загрузки и методом отправки
2175
- */
2176
- 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): {
2177
- loading: Ref<boolean, boolean>;
2178
- send(request?: Request | undefined): Promise<Return | undefined>;
2179
- };
2180
-
2181
- /**
2182
- * Use API get request.
2183
- *
2184
- * Использование API get запроса.
2185
- * @param path Path to the API endpoint / Путь к endpoint API
2186
- * @param action Action to perform after the request / Действие, выполняемое после запроса
2187
- * @param transformation Transformation function / Функция трансформации
2188
- * @param toData Extract 'data' field from response / Извлечь поле 'data' из ответа
2189
- * @param options Additional request options / Дополнительные опции запроса
2190
- * @param apiInstance Api instance / Экземпляр Api
2191
- * @returns Object with loading state and send method / Объект с состоянием загрузки и методом отправки
2192
- */
2193
- 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): {
2194
- loading: Ref<boolean, boolean>;
2195
- send(request?: Request | undefined): Promise<Return | undefined>;
2196
- };
2197
-
2198
- /**
2199
- * A powerful composable for comprehensive API request orchestration.
2200
- * It centrally manages data loading (GET), list formatting, client-side searching,
2201
- * and mutations (POST, PUT, DELETE) through a single reactive interface.
2202
- *
2203
- * Мощный композабл для комплексной оркестрации API-запросов.
2204
- * Он централизованно управляет загрузкой данных (GET), форматированием списков,
2205
- * клиентским поиском и мутациями (POST, PUT, DELETE) через единый реактивный интерфейс.
2206
- *
2207
- * @template Return type of data returned by the API / тип данных, возвращаемых API
2208
- * @template FormattersOptions optional formatting rules / опциональные правила форматирования
2209
- * @template Post data type for POST creation request / тип данных для POST-запроса создания
2210
- * @template Put data type for PUT update request / тип данных для PUT-запроса обновления
2211
- * @template Delete data type for DELETE removal request / тип данных для DELETE-запроса удаления
2212
- * @template Type original data type (before transformation) / тип исходных данных (до трансформации)
2213
- * @template Item type of a single item in the data list / тип одного элемента из списка данных
2214
- * @template ItemFormatters item type after formatters are applied / тип элемента после применения форматировщиков
2215
- * @template Columns search columns derived from formatting / колонки, по которым производится поиск
2216
- *
2217
- * @param propsGet main GET request settings (path, reactivity, skeleton, etc.) / настройки главного GET-запроса
2218
- * @param formattersOptions optional reactive formatting rules / правила для реактивного форматирования данных
2219
- * @param searchOptions optional client-side search settings / настройки для клиентского поиска по списку
2220
- * @param postRequest optional POST mutation settings / настройки для POST-запроса создания
2221
- * @param putRequest optional PUT mutation settings / настройки для PUT-запроса обновления
2222
- * @param deleteRequest optional DELETE mutation settings / настройки для DELETE-запроса удаления
2223
- * @param action common callback executed after any successful mutation / общий коллбэк после любой успешной мутации
2224
- * @param apiInstance API instance for requests (defaults to Api.getItem()) / экземпляр API для выполнения запроса
2225
- *
2226
- * @returns reactive API management interface / реактивный интерфейс управления API
2227
- *
2228
- * @note This hook is recommended to be used in tandem with `executeUse` for centralized state management.
2229
- * By wrapping `useApiManagementRef` in `executeUseProvide` or `executeUseGlobal`, you can ensure
2230
- * a single source of truth across the component tree or the entire application.
2231
- *
2232
- * Рекомендуется использовать этот хук в тандеме с `executeUse` для централизованного управления состоянием.
2233
- * Обернув `useApiManagementRef` в `executeUseProvide` или `executeUseGlobal`, вы обеспечите
2234
- * единый источник истины в дереве компонентов или во всем приложении.
2235
- *
2236
- * @remarks
2237
- * Data formatting guidelines for `formattersOptions`:
2238
- * - **Recommended for formatting:** Numbers that represent values (prices, counts), dates, currency, units, and statuses.
2239
- * - **Not recommended for formatting:** Technical identifiers such as ID, UUID, account numbers (if used for logic), types, or internal codes.
2240
- *
2241
- * Рекомендации по форматированию данных для `formattersOptions`:
2242
- * - **Рекомендуется для форматирования:** Числа, представляющие значения (цены, количества), даты, валюта, единицы измерения и статусы.
2243
- * - **Не рекомендуется для форматирования:** Технические идентификаторы, такие как ID, UUID, номера счетов (если они используются для логики), типы или внутренние коды.
2244
- *
2245
- * @example
2246
- * // 1. Comprehensive API orchestration/ Комплексная оркестрация API
2247
- * const products = useApiManagementRef(
2248
- * {
2249
- * path: '/api/v1/products',
2250
- * skeleton: () => Array(5).fill({ id: 0, name: 'Loading...', price: 0 })
2251
- * },
2252
- * {
2253
- * // Formatters for display/ Форматтеры для отображения
2254
- * price: (v) => `${v} USD`,
2255
- * created_at: (v) => new Date(v).toLocaleDateString()
2256
- * },
2257
- * {
2258
- * // Client-side search setup/ Настройка поиска на стороне клиента
2259
- * columns: ['name', 'category']
2260
- * },
2261
- * { path: '/api/v1/products' }, // POST (create)
2262
- * { path: (data) => `/api/v1/products/${data.id}` }, // PUT (update)
2263
- * { path: (data) => `/api/v1/products/${data.id}` } // DELETE (remove)
2264
- * );
2265
- *
2266
- * // Accessing data/ Доступ к данным:
2267
- * // products.list.value -> processed, formatted, and searched list
2268
- * // products.sendPost({ name: 'New Product', price: 100 }) -> execute mutation
2269
- */
2270
- 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): {
2271
- /** Whether data passed the `typeData` check / `true`, если данные прошли проверку `typeData` */
2272
- isValid: ComputedRef<boolean>;
2273
- /** Processed data array (supports Skeleton, formatters, and search) / Обработанный массив данных (поддерживает Skeleton, форматтеры и поиск) */
2274
- list: ComputedRef<SearchFormatList<ItemFormatters, Columns>>;
2275
- /** Raw reactive data from `useApiRef` / «Сырые» реактивные данные из `useApiRef` */
2276
- readonly data: ComputedRef<ApiData<Return> | undefined>;
2277
- /** Current number of items in `list` (changes with search) / Текущее количество элементов в `list` (меняется при поиске) */
2278
- readonly length: ComputedRef<number>;
2279
- /** Total number of items in raw `data` / Общее количество элементов в исходном `data` */
2280
- lengthData: ComputedRef<number>;
2281
- /** Initial loading flag (true when no data yet) / Флаг первичной загрузки (когда данных еще нет) */
2282
- starting: ComputedRef<boolean>;
2283
- /** Active read process flag / Флаг активного процесса чтения данных */
2284
- reading: Ref<boolean, boolean>;
2285
- /** Loading state for the main GET request / Общее состояние загрузки главного GET-запроса */
2286
- loading: Ref<boolean, boolean>;
2287
- /** Loading state during search processing / Состояние загрузки в процессе поиска */
2288
- loadingSearch: Ref<boolean, boolean> | undefined;
2289
- /** Loading state for POST mutation / Состояние загрузки для POST мутации */
2290
- loadingPost: Ref<boolean, boolean> | undefined;
2291
- /** Loading state for PUT mutation / Состояние загрузки для PUT мутации */
2292
- loadingPut: Ref<boolean, boolean> | undefined;
2293
- /** Loading state for DELETE mutation / Состояние загрузки для DELETE мутации */
2294
- loadingDelete: Ref<boolean, boolean> | undefined;
2295
- /** Whether search is currently active / Активен ли поиск (есть ли поисковый запрос) */
2296
- isSearch: ComputedRef<boolean> | undefined;
2297
- /** Reactive search string (Proxy to `searchOptions.value`) / Реактивная строка поиска (Proxy к переданному `searchOptions.value`) */
2298
- search: Ref<string, string> | undefined;
2299
- /**
2300
- * Force reset the GET request and clear state.
2301
- *
2302
- * Принудительный перезапуск GET-запроса и очистка состояния.
2303
- */
2304
- reset: () => Promise<void>;
2305
- /**
2306
- * Abort the current network request.
2307
- *
2308
- * Прекращение текущего сетевого запроса.
2309
- */
2310
- abort: () => void;
2311
- /**
2312
- * Execute POST mutation request.
2313
- *
2314
- * Выполнить POST запрос мутации.
2315
- * @param request request data / данные запроса
2316
- */
2317
- sendPost: (request?: ApiFetch["request"]) => Promise<ApiData<Post> | undefined>;
2318
- /**
2319
- * Execute PUT mutation request.
2320
- *
2321
- * Выполнить PUT запрос мутации.
2322
- * @param request request data / данные запроса
2323
- */
2324
- sendPut: (request?: ApiFetch["request"]) => Promise<ApiData<Put> | undefined>;
2325
- /**
2326
- * Execute DELETE mutation request.
2327
- *
2328
- * Выполнить DELETE запрос мутации.
2329
- * @param request request data / данные запроса
2330
- */
2331
- sendDelete: (request?: ApiFetch["request"]) => Promise<ApiData<Delete> | undefined>;
2332
- };
2333
-
2334
- /**
2335
- * Use API post request.
2336
- *
2337
- * Использование API post запроса.
2338
- * @param path Path to the API endpoint / Путь к endpoint API
2339
- * @param action Action to perform after the request / Действие, выполняемое после запроса
2340
- * @param transformation Transformation function / Функция трансформации
2341
- * @param toData Extract 'data' field from response / Извлечь поле 'data' из ответа
2342
- * @param options Additional request options / Дополнительные опции запроса
2343
- * @param apiInstance Api instance / Экземпляр Api
2344
- * @returns Object with loading state and send method / Объект с состоянием загрузки и методом отправки
2345
- */
2346
- 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): {
2347
- loading: Ref<boolean, boolean>;
2348
- send(request?: Request | undefined): Promise<Return | undefined>;
2349
- };
2350
-
2351
- /**
2352
- * Use API put request.
2353
- *
2354
- * Использование API put запроса.
2355
- * @param path Path to the API endpoint / Путь к endpoint API
2356
- * @param action Action to perform after the request / Действие, выполняемое после запроса
2357
- * @param transformation Transformation function / Функция трансформации
2358
- * @param toData Extract 'data' field from response / Извлечь поле 'data' из ответа
2359
- * @param options Additional request options / Дополнительные опции запроса
2360
- * @param apiInstance Api instance / Экземпляр Api
2361
- * @returns Object with loading state and send method / Объект с состоянием загрузки и методом отправки
2362
- */
2363
- 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): {
2364
- loading: Ref<boolean, boolean>;
2365
- send(request?: Request | undefined): Promise<Return | undefined>;
2366
- };
2367
-
2368
- /**
2369
- * Use api ref return type.
2370
- *
2371
- * Тип возвращаемого значения для useApiRef.
2372
- */
2373
- export declare interface UseApiRef<R> {
2374
- /** Reactive data (Computed) / Реактивные данные (Computed) */
2375
- data: ComputedRef<ApiData<R> | undefined>;
2376
- /** Item (Ref) / Элемент (Ref) */
2377
- item: Ref<ApiData<R> | undefined>;
2378
- /**
2379
- * Status of response contract validation.
2380
- *
2381
- * Статус валидации контракта ответа.
2382
- */
2383
- isResponseContractValid: ComputedRef<boolean>;
2384
- /**
2385
- * Result of response validation.
2386
- *
2387
- * Результат валидации ответа.
2388
- */
2389
- responseValidationResult: ComputedRef<ApiDataValidation | undefined>;
2390
- /** Length of the list (Computed) / Длина списка (Computed) */
2391
- length: ComputedRef<number>;
2392
- /** Start request flag (true if no data yet) / Флаг начала запроса (true если еще нет данных) */
2393
- starting: ComputedRef<boolean>;
2394
- /** Request load flag / Флаг загрузки запроса */
2395
- loading: Ref<boolean>;
2396
- /** Active reading flag / Флаг активного чтения */
2397
- reading: Ref<boolean>;
2398
- /** Checks if the request is starting (true if no data yet) / Проверяет, начинается ли запрос (true, если данных еще нет) */
2399
- isStarting(): boolean;
2400
- /**
2401
- * Checks if the request is currently loading.
2402
- *
2403
- * Проверяет, загружается ли запрос в данный момент.
2404
- */
2405
- isLoading(): boolean;
2406
- /**
2407
- * Checks if the request is currently reading.
2408
- *
2409
- * Проверяет, читается ли запрос в данный момент.
2410
- */
2411
- isReading(): boolean;
2412
- /**
2413
- * Gets the current item data.
2414
- *
2415
- * Получает текущие данные элемента.
2416
- */
2417
- getItem(): ApiData<R> | undefined;
2418
- /**
2419
- * Manual initialization
2420
- *
2421
- * Ручная инициализация
2422
- */
2423
- init(): void;
2424
- /**
2425
- * SSR initialization
2426
- *
2427
- * Инициализация SSR
2428
- */
2429
- initSsr(): void;
2430
- /**
2431
- * Default reset.
2432
- *
2433
- * Сброс по умолчанию.
2434
- */
2435
- reset(): Promise<void>;
2436
- /**
2437
- * Stop request.
2438
- *
2439
- * Остановка запроса.
2440
- */
2441
- stop(): void;
2442
- /**
2443
- * Abort request.
2444
- *
2445
- * Отмена запроса.
2446
- */
2447
- abort(): void;
2448
- }
2449
-
2450
- /**
2451
- * Returns data for working with requests.
2452
- *
2453
- * Возвращает данные для работы с запросами.
2454
- * @param path path to request / путь к запросу
2455
- * @param options data for the request / данные для запроса
2456
- * @param reactivity should reactivity be enabled / включить ли реактивность
2457
- * @param conditions conditions for executing the request / условия выполнения запроса
2458
- * @param transformation transforms the received request / преобразовывает полученный запрос
2459
- * @param validateResponseContract function to validate response data contract / функция для проверки контракта данных ответа
2460
- * @param unmounted delete data from the cache / удалить ли данные из кеша
2461
- * @param apiInstance Api instance / Экземпляр Api
2462
- */
2463
- 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, unmounted?: boolean, apiInstance?: ApiInstance): UseApiRef<R>;
2464
-
2465
- /**
2466
- * Use api request.
2467
- *
2468
- * Использование запроса api.
2469
- * @param path Path to the API endpoint / Путь к endpoint API
2470
- * @param method HTTP method / HTTP метод
2471
- * @param action Action to perform after the request / Действие, выполняемое после запроса
2472
- * @param transformation Transformation function / Функция трансформации
2473
- * @param toData Extract 'data' field from response / Извлечь поле 'data' из ответа
2474
- * @param options Additional request options / Дополнительные опции запроса
2475
- * @param apiInstance Api instance / Экземпляр Api
2476
- * @returns Object with loading state and send method / Объект с состоянием загрузки и методом отправки
2477
- */
2478
- 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): {
2479
- loading: Ref<boolean, boolean>;
2480
- /**
2481
- * Send request.
2482
- *
2483
- * Отправка запроса.
2484
- * @param request Request data / Данные запроса
2485
- * @returns Response data / Данные ответа
2486
- */
2487
- send(request?: Request): Promise<Return | undefined>;
2488
- };
2489
-
2490
- /**
2491
- * Creates a reactive variable to manage data between browser tabs.
2492
- *
2493
- * Создает реактивную переменную для управления данными между вкладками браузера.
2494
- * @param name value name/ название значения
2495
- * @param defaultValue default value/ значение по умолчанию
2496
- */
2497
- export declare function useBroadcastValueRef<T>(name: string, defaultValue?: T | string | (() => (T | string))): Ref<BroadcastValueItem<T>>;
2498
-
2499
- /**
2500
- * Creates a reactive variable to manage cookies.
2501
- *
2502
- * Создает реактивную переменную для управления cookie.
2503
- * @param name cookie name / название cookie
2504
- * @param defaultValue value or function to change data / значение или функция для изменения данных
2505
- * @param options additional parameters / дополнительные параметры
2506
- */
2507
- export declare function useCookieRef<T>(name: string, defaultValue?: T | string | (() => (T | string)), options?: CookieOptions): Ref<T | string | undefined>;
2508
-
2509
- /**
2510
- * Composable for reactive formatting of data lists based on specified rules for each property. /
2511
- * Композабл для реактивного форматирования списков данных на основе заданных правил для каждого свойства.
2512
- * @param list source data list (Ref or ComputedRef) / исходный список данных (Ref или ComputedRef)
2513
- * @param options formatting settings for each property / настройки форматирования для каждого свойства
2514
- */
2515
- export declare function useFormattersRef<Options extends FormattersOptionsList = FormattersOptionsList, List extends FormattersListProp = FormattersListProp>(list: RefType<List | undefined>, options: Options): {
2516
- /**
2517
- * Formatted data list (ComputedRef) /
2518
- * Отформатированный список данных (ComputedRef)
2519
- */
2520
- listFormat: ComputedRef<FormattersReturn<List, Options>>;
2521
- /**
2522
- * Returns the count of records in the list (ComputedRef) /
2523
- * Возвращает количество записей в списке (ComputedRef)
2524
- */
2525
- length: ComputedRef<number>;
2526
- };
2527
-
2528
- /**
2529
- * Returns a class object for working with data formatting.
2530
- *
2531
- * Возвращает объект класса для работы с форматированием данных.
2532
- */
2533
- export declare function useGeoIntlRef(): GeoIntlRef;
2534
-
2535
- /**
2536
- * Creates a reactive variable to manage the hash.
2537
- *
2538
- * Создает реактивную переменную для управления хэшем.
2539
- * @param name value name / название значения
2540
- * @param defaultValue default value / значение по умолчанию
2541
- */
2542
- export declare function useHashRef<T>(name: string, defaultValue?: T | (() => T)): ShallowRef<T>;
2543
-
2544
- /**
2545
- * Hook for initializing the tracking of an element's appearance on the screen by margin.
2546
- *
2547
- * Хук для инициализации отслеживания появления элемента на экране по отступу.
2548
- * @param element element for tracking/ элемента для отслеживания
2549
- * @param rootMargin root margin for IntersectionObserver/ отступ для IntersectionObserver
2550
- */
2551
- export declare const useLazyItemByMarginRef: (element: RefType<HTMLElement | undefined>, rootMargin: string) => {
2552
- /** Lazy item status/ Статус ленивого элемента */
2553
- lazyItemStatus: any;
2554
- /**
2555
- * Getting a tracked lazy item.
2556
- *
2557
- * Получение отслеживаемого ленивого элемента.
2558
- */
2559
- readonly lazyItem: any;
2560
- };
2561
-
2562
- /**
2563
- * Hook for initializing the tracking of an element's appearance on the screen.
2564
- *
2565
- * Хук для инициализации отслеживания появления элемента на экране.
2566
- */
2567
- export declare const useLazyRef: (options?: IntersectionObserverInit) => {
2568
- intersectionObserver: IntersectionObserver | undefined;
2569
- /**
2570
- * Getting a tracked element.
2571
- *
2572
- * Получение отслеживаемого элемента.
2573
- * @param element tracked element/ отслеживаемый элемент
2574
- */
2575
- getItem(element: HTMLElement): LazyItem;
2576
- /**
2577
- * Adding an element for tracking.
2578
- *
2579
- * Добавление элемента для отслеживания.
2580
- * @param element element for tracking/ элемента для отслеживания
2581
- */
2582
- addLazyItem(element: Ref<HTMLElement | undefined>): ShallowRef<boolean, boolean>;
2583
- /**
2584
- * Removing an element from tracking.
2585
- *
2586
- * Удаление элемента из отслеживания.
2587
- */
2588
- removeLazyItem: (element?: HTMLElement) => void;
2589
- /**
2590
- * Removing all elements from tracking.
2591
- *
2592
- * Удаление всех элементов из отслеживания.
2593
- */
2594
- disconnectLazy: () => void | undefined;
2595
- };
2596
-
2597
- /**
2598
- * Returns the loading status.
2599
- *
2600
- * Возвращает статус загрузки.
2601
- */
2602
- export declare function useLoadingRef(): ShallowRef<boolean, boolean>;
2603
-
2604
- /**
2605
- * Vue composable for reactive meta tags management with automatic DOM synchronization.
2606
- * Uses singleton pattern - all components share the same meta state.
2607
- *
2608
- * Vue композабл для реактивного управления мета-тегами с автоматической синхронизацией DOM.
2609
- * Использует паттерн singleton - все компоненты используют одно состояние мета-тегов.
2610
- */
2611
- export declare const useMeta: () => Readonly<{
2612
- meta: typeof MetaStatic;
2613
- /** Reactive page title (without suffix) / Реактивный заголовок страницы (без суффикса) */
2614
- title: Ref<string, string>;
2615
- /** Reactive keywords meta tag / Реактивный мета-тег keywords */
2616
- keyword: Ref<string, string>;
2617
- /** Reactive description meta tag / Реактивный мета-тег description */
2618
- description: Ref<string, string>;
2619
- /** Reactive author meta tag / Реактивный мета-тег author */
2620
- author: Ref<string, string>;
2621
- /** Reactive Open Graph / Twitter Card image URL / Реактивный URL изображения для Open Graph / Twitter Card */
2622
- image: Ref<string, string>;
2623
- /** Reactive canonical URL / Реактивный канонический URL */
2624
- canonical: Ref<string, string>;
2625
- /** Reactive robots meta tag directive / Реактивная директива мета-тега robots */
2626
- robots: Ref<MetaRobots, MetaRobots>;
2627
- /** Reactive site name for Open Graph and Twitter Card / Реактивное название сайта для Open Graph и Twitter Card */
2628
- siteName: Ref<string, string>;
2629
- /**
2630
- * Generates HTML string for all meta tags (for SSR).
2631
- *
2632
- * Генерирует HTML-строку для всех мета-тегов (для SSR).
2633
- */
2634
- getHtmlMeta: () => string;
2635
- /**
2636
- * Sets the suffix for the page title.
2637
- *
2638
- * Устанавливает суффикс для заголовка страницы.
2639
- * @param suffix Suffix to set / Суффикс для установки
2640
- */
2641
- setSuffix: (suffix: string) => typeof MetaStatic;
2642
- } & {
2643
- init(): Readonly<{
2644
- meta: typeof MetaStatic;
2645
- /** Reactive page title (without suffix) / Реактивный заголовок страницы (без суффикса) */
2646
- title: Ref<string, string>;
2647
- /** Reactive keywords meta tag / Реактивный мета-тег keywords */
2648
- keyword: Ref<string, string>;
2649
- /** Reactive description meta tag / Реактивный мета-тег description */
2650
- description: Ref<string, string>;
2651
- /** Reactive author meta tag / Реактивный мета-тег author */
2652
- author: Ref<string, string>;
2653
- /** Reactive Open Graph / Twitter Card image URL / Реактивный URL изображения для Open Graph / Twitter Card */
2654
- image: Ref<string, string>;
2655
- /** Reactive canonical URL / Реактивный канонический URL */
2656
- canonical: Ref<string, string>;
2657
- /** Reactive robots meta tag directive / Реактивная директива мета-тега robots */
2658
- robots: Ref<MetaRobots, MetaRobots>;
2659
- /** Reactive site name for Open Graph and Twitter Card / Реактивное название сайта для Open Graph и Twitter Card */
2660
- siteName: Ref<string, string>;
2661
- /**
2662
- * Generates HTML string for all meta tags (for SSR).
2663
- *
2664
- * Генерирует HTML-строку для всех мета-тегов (для SSR).
2665
- */
2666
- getHtmlMeta: () => string;
2667
- /**
2668
- * Sets the suffix for the page title.
2669
- *
2670
- * Устанавливает суффикс для заголовка страницы.
2671
- * @param suffix Suffix to set / Суффикс для установки
2672
- */
2673
- setSuffix: (suffix: string) => typeof MetaStatic;
2674
- }>;
2675
- destroyExecute?(): void;
2676
- }>;
2677
-
2678
- /**
2679
- * Managing a list of links for the router.
2680
- *
2681
- * Управление списком ссылок для роутера.
2682
- * @param list list of items / список элементов
2683
- * @param selected selected item / выбранный элемент
2684
- * @param hasTo has to / имеет to
2685
- */
2686
- export declare const useRouterList: <T extends ListDataBasic>(list: RefType<ConstrBind<T>[] | undefined>, selected?: Ref<string> | string, hasTo?: boolean) => {
2687
- item: ComputedRef<T | undefined>;
2688
- /** Selected element / Выбранный элемент */
2689
- selected: Ref<string, string>;
2690
- label: ComputedRef<NumberOrString>;
2691
- /** List of elements / Список элементов */
2692
- list: ComputedRef<ConstrBind<T>[]>;
2693
- to: (name?: string) => void;
2694
- /**
2695
- * Transition to the main element.
2696
- *
2697
- * Переход к главному элементу.
2698
- */
2699
- toMain(): void;
2700
- };
2701
-
2702
- /**
2703
- * Composable for handling search logic with reactive data.
2704
- *
2705
- * Композабл для управления логикой поиска с реактивными данными.
2706
- * @param list list of items to search / список элементов для поиска
2707
- * @param columns columns to search in / колонки, по которым ведется поиск
2708
- * @param value reactive search string / реактивная строка поиска
2709
- * @param options search options / настройки поиска
2710
- */
2711
- export declare function useSearchRef<T extends SearchItem, K extends SearchColumns<T>>(list: SearchListInput<T>, columns: K, value?: Ref<string>, options?: SearchOptions): {
2712
- /**
2713
- * Whether the search is currently active (minimum character limit reached)/
2714
- * Активен ли поиск в данный момент (достигнут ли лимит символов)
2715
- */
2716
- isSearch: ComputedRef<boolean>;
2717
- /** Search string ref/ Ссылка на строку поиска */
2718
- search: Ref<string, string>;
2719
- /**
2720
- * Search loading status (if delay is used) /
2721
- * Статус загрузки поиска (если используется задержка)
2722
- */
2723
- loading: Ref<boolean, boolean>;
2724
- /**
2725
- * Formatted list of search results with highlights /
2726
- * Форматированный список результатов поиска с подсветкой совпадений
2727
- */
2728
- listSearch: ComputedRef<SearchFormatList<T, K>>;
2729
- /**
2730
- * Length of the search results /
2731
- * Длина списка результатов поиска
2732
- */
2733
- length: ComputedRef<number>;
2734
- };
2735
-
2736
- /**
2737
- * Composable for managing search value state and handling delays.
2738
- *
2739
- * Композабл для управления состоянием значения поиска и обработки задержек.
2740
- * Он изолирует логику debounce, предоставляя `searchDelay` (строка с задержкой)
2741
- * и `loading` (флаг ожидания), которые затем читаются классом `SearchList` или `useSearchRef`.
2742
- * @param item search list instance / экземпляр поиска `SearchList`
2743
- * @param value reactive search string / реактивная строка поиска (опционально)
2744
- */
2745
- export declare function useSearchValueRef<T extends SearchItem, K extends SearchColumns<T>>(item: SearchList<T, K>, value?: Ref<string>): {
2746
- /** Current search value / Текущее значение поиска */
2747
- search: Ref<string, string>;
2748
- /** Search value with applied delay / Значение поиска с примененной задержкой */
2749
- searchDelay: Ref<string, string>;
2750
- /** Loading status during delay / Статус загрузки во время задержки */
2751
- loading: Ref<boolean, boolean>;
2752
- };
2753
-
2754
- /**
2755
- * Creates a reactive variable to manage session storage.
2756
- *
2757
- * Создает реактивную переменную для управления сессией хранения.
2758
- * @param name value name/ название значения
2759
- * @param defaultValue default value/ значение по умолчанию
2760
- */
2761
- export declare function useSessionRef<T>(name: string, defaultValue?: T | (() => T)): Ref<T | undefined>;
2762
-
2763
- /**
2764
- * Creates a reactive variable to manage a local storage.
2765
- *
2766
- * Создает реактивный переменный для управления локальным хранилищем.
2767
- * @param name value name/ название значения
2768
- * @param defaultValue default value/ значение по умолчанию
2769
- * @param cache cache time/ время кэширования
2770
- */
2771
- export declare function useStorageRef<T>(name: string, defaultValue?: T | (() => T), cache?: number): Ref<T | undefined>;
2772
-
2773
- /**
2774
- * Getting the translated text by an array of keys or a string with a key.
2775
- *
2776
- * It returns a `ShallowRef` that automatically updates when the global language changes.
2777
- * Use `as const` for arrays to ensure proper TypeScript key inference.
2778
- *
2779
- * ---
2780
- *
2781
- * Получение переведенного текста по массиву ключей или пункту с ключом.
2782
- *
2783
- * Возвращает `ShallowRef`, который автоматически обновляется при смене глобального языка.
2784
- * Используйте `as const` для массивов, чтобы обеспечить корректный вывод типов ключей в TypeScript.
2785
- *
2786
- * ### Examples / Примеры использования:
2787
- * ```typescript
2788
- * // 1. Using the main composable / Использование основного хука
2789
- * const translations = useTranslateRef(['home.title', 'home.description'] as const);
2790
- *
2791
- * // 2. Using the shorthand 't' / Использование сокращения 't'
2792
- * const labels = t(['button.save', 'button.cancel'] as const);
2793
- * ```
2794
- *
2795
- * @param names a string or an array with keys / строка или массив с ключами
2796
- * @param translateInstance a translate instance / экземпляр перевода
2797
- */
2798
- export declare function useTranslateRef<T extends (string | string[])[]>(names: T, translateInstance?: TranslateInstance): ShallowRef<TranslateList<T>>;
2799
-
2800
-
2801
- export * from "@dxtmisha/functional-basic";
2802
-
2803
- export { }
1
+ export * from './classes/design/DesignAbstract';
2
+ export * from './classes/design/DesignAsyncAbstract';
3
+ export * from './classes/design/DesignChanged';
4
+ export * from './classes/design/DesignComp';
5
+ export * from './classes/design/DesignComponents';
6
+ export * from './classes/design/DesignConstructorAbstract';
7
+ export * from './classes/ref/DatetimeRef';
8
+ export * from './classes/ref/EffectScopeGlobal';
9
+ export * from './classes/ref/EventRef';
10
+ export * from './classes/ref/GeoFlagRef';
11
+ export * from './classes/ref/GeoIntlRef';
12
+ export * from './classes/ref/GeoRef';
13
+ export * from './classes/ref/ListDataRef';
14
+ export * from './classes/ref/RouterItemRef';
15
+ export * from './classes/ref/ScrollbarWidthRef';
16
+ export * from './composables/ref/useApiAsyncRef';
17
+ export * from './composables/ref/useApiDelete';
18
+ export * from './composables/ref/useApiGet';
19
+ export * from './composables/ref/useApiManagementAsyncRef';
20
+ export * from './composables/ref/useApiManagementRef';
21
+ export * from './composables/ref/useApiPost';
22
+ export * from './composables/ref/useApiPut';
23
+ export * from './composables/ref/useApiRef';
24
+ export * from './composables/ref/useApiRequest';
25
+ export * from './composables/ref/useBroadcastValueRef';
26
+ export * from './composables/ref/useCookieRef';
27
+ export * from './composables/ref/useFormattersRef';
28
+ export * from './composables/ref/useGeoIntlRef';
29
+ export * from './composables/ref/useHashRef';
30
+ export * from './composables/ref/useLazyItemByMarginRef';
31
+ export * from './composables/ref/useLazyRef';
32
+ export * from './composables/ref/useLoadingRef';
33
+ export * from './composables/ref/useMeta';
34
+ export * from './composables/ref/useRouterList';
35
+ export * from './composables/ref/useSearchRef';
36
+ export * from './composables/ref/useSearchValueRef';
37
+ export * from './composables/ref/useSessionRef';
38
+ export * from './composables/ref/useStorageRef';
39
+ export * from './composables/ref/useTranslateRef';
40
+ export * from './functions/basic';
41
+ export * from './functions/computedAsync';
42
+ export * from './functions/computedByLanguage';
43
+ export * from './functions/computedEternity';
44
+ export * from './functions/dxtFunctionalPlugin';
45
+ export * from './functions/executeUse';
46
+ export * from './functions/getInject';
47
+ export * from './functions/getOptions';
48
+ export * from './functions/ref/getBindRef';
49
+ export * from './functions/ref/getRef';
50
+ export * from './functions/ref/render';
51
+ export * from './functions/ref/setRef';
52
+ export * from './functions/ref/toRefItem';
53
+ export * from './functions/render/getBind';
54
+ export * from './functions/render/getClassName';
55
+ export * from './functions/render/getIndexForRender';
56
+ export * from './functions/toBind';
57
+ export * from './functions/toBinds';
58
+ export * from './types/apiTypes';
59
+ export * from './types/constructorTypes';
60
+ export * from './types/listTypes';
61
+ export * from './types/refTypes';
62
+ export * from './types/searchTypes';