@dxtmisha/functional 1.11.12 → 1.11.13

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.
package/ai-types.txt CHANGED
@@ -15,298 +15,506 @@ The following is the content of "exports" from package.json:
15
15
  }
16
16
 
17
17
  // File: src/classes/design/DesignAbstract.d.ts
18
- /** Base class for working with the constructor. */
18
+ /**
19
+ * Constructor base class.
20
+ */
19
21
  export declare abstract class DesignAbstract<T extends Record<string, any>, C extends Record<string, any>> {
20
22
  /**
23
+ * Constructor.
21
24
  * @param props base data
22
- * @param callback callback function when value changes
23
- * @param changed base data for tracking
25
+ * @param callback callback for value changes
26
+ * @param changed tracking data
24
27
  */
25
28
  constructor(props: T, callback?: ((event: C) => void) | undefined, changed?: string[]);
26
- /** Calls the callback function. @param compelled forces data to update */
29
+ /**
30
+ * Calls callback.
31
+ * @param compelled forces update
32
+ */
27
33
  make(compelled?: boolean): this;
28
- /** Calls the callback function. @param compelled forces data to update */
34
+ /**
35
+ * Calls callback.
36
+ * @param compelled forces update
37
+ */
29
38
  makeCallback(compelled?: boolean): void;
30
39
  }
40
+
41
+
31
42
  // File: src/classes/design/DesignAsyncAbstract.d.ts
32
- /** Base class for working with the constructor. */
43
+ /**
44
+ * Async constructor base class.
45
+ */
33
46
  export declare abstract class DesignAsyncAbstract<T extends Record<string, any>, C extends Record<string, any>> extends DesignAbstract<T, C> {
34
- /** @param compelled forces data to update */
47
+ /**
48
+ * Calls callback.
49
+ * @param compelled forces update
50
+ */
35
51
  make(compelled?: boolean): this;
36
- /** @param compelled forces data to update */
52
+ /**
53
+ * Calls callback.
54
+ * @param compelled forces update
55
+ */
37
56
  makeCallback(compelled?: boolean): Promise<void>;
38
57
  }
58
+
59
+
39
60
  // File: src/classes/design/DesignChanged.d.ts
40
- /** Class checks edited values. */
61
+ /**
62
+ * Tracks edited values.
63
+ */
41
64
  export declare class DesignChanged<T extends Record<string, any>> {
42
65
  /**
66
+ * Constructor.
43
67
  * @param props base data
44
- * @param watch data for tracking
68
+ * @param watch tracking data
45
69
  */
46
70
  constructor(props: T, watch?: string[]);
47
- /** Checks if value was updated. @param name property name */
71
+ /**
72
+ * Check if value updated.
73
+ * @param name property name
74
+ */
48
75
  is(name: string | string[]): boolean;
49
- /** Checks if there are changes in data. */
76
+ /**
77
+ * Check for changes.
78
+ */
50
79
  isChanged(): boolean;
51
- /** Updates all values. */
80
+ /**
81
+ * Update all values.
82
+ */
52
83
  update(): void;
53
84
  }
85
+
86
+
54
87
  // File: src/classes/design/DesignComp.d.ts
55
88
  export declare class DesignComp<COMP extends ConstrComponent, P extends ConstrItem> extends DesignComponents<COMP, P> {
56
89
  }
90
+
91
+
57
92
  // File: src/classes/design/DesignComponents.d.ts
58
- /** Class for working with connected components. */
93
+ /**
94
+ * Manages connected components.
95
+ */
59
96
  export declare class DesignComponents<COMP extends ConstrComponent, P extends ConstrItem> {
60
97
  /**
61
- * @param components list of connected components
62
- * @param modification data for modification
98
+ * Constructor.
99
+ * @param components component list
100
+ * @param modification modification data
63
101
  */
64
102
  constructor(components?: COMP, modification?: ConstrComponentMod<P> | undefined);
65
- /** Check presence of component. @param name component name */
103
+ /**
104
+ * Check component presence.
105
+ * @param name component name
106
+ */
66
107
  is<K extends keyof COMP>(name: K): name is K;
67
- /** Get component object. @param name component name */
108
+ /**
109
+ * Get component object.
110
+ * @param name component name
111
+ */
68
112
  get<K extends keyof COMP>(name: K): COMP[K];
69
- /** Returns modified input data. @param index item name @param props basic data */
113
+ /**
114
+ * Get modified input data.
115
+ * @param index data name
116
+ * @param props basic data
117
+ */
70
118
  getModification<K extends keyof P>(index?: K & string | string, props?: P[K] | Record<string, any>): Record<string, any> | undefined;
71
- /** Render component by name as array. @param name component name @param props component props @param children sub-elements @param index key name */
119
+ /**
120
+ * Render component.
121
+ * @param name component name
122
+ * @param props component props
123
+ * @param children sub-elements
124
+ * @param index key name
125
+ */
72
126
  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[];
73
- /** Render component by name. @param name component name @param props component props @param children sub-elements @param index key name */
127
+ /**
128
+ * Render single component.
129
+ */
74
130
  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;
75
- /** Render component by name and add to array. @param item array to add to @param name component name @param props component props @param children sub-elements @param index key name */
131
+ /**
132
+ * Render and add to array.
133
+ */
76
134
  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;
77
135
  }
136
+
137
+
78
138
  // File: src/classes/design/DesignConstructorAbstract.d.ts
79
- /** Class for collecting functional components. */
139
+ /**
140
+ * Collects functional components.
141
+ */
80
142
  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> {
81
- /** Get class name. */
143
+ /**
144
+ * Get class name.
145
+ */
82
146
  getName(): string;
83
- /** Get design name. */
147
+ /**
148
+ * Get design name.
149
+ */
84
150
  getDesign(): string;
85
- /** Get sub-class name. @param name class level names */
151
+ /**
152
+ * Get sub-level class name.
153
+ */
86
154
  getSubClass(name: string | string[]): string;
87
- /** Get status class name. @param name class level names */
155
+ /**
156
+ * Get status class name.
157
+ */
88
158
  getStatusClass(name: string | string[]): string;
89
- /** Get style property name. @param name class level names */
159
+ /**
160
+ * Get style property name.
161
+ */
90
162
  getStyle(name: string | string[]): string;
91
- /** Get additional parameters. */
163
+ /**
164
+ * Get additional attributes.
165
+ */
92
166
  getAttrs(): ConstrItem;
93
- /** List of external variables. */
167
+ /**
168
+ * External variables list.
169
+ */
94
170
  expose(): ConstrExpose<E, EXPOSE>;
95
- /** Rendering method for setup. */
171
+ /**
172
+ * Rendering for setup.
173
+ */
96
174
  render(): () => VNode | (VNode | any)[] | undefined;
97
175
  }
176
+
177
+
98
178
  // File: src/classes/ref/DatetimeRef.d.ts
99
- /** Class for working with dates. */
179
+ /**
180
+ * Date management class.
181
+ */
100
182
  export declare class DatetimeRef {
101
183
  /**
102
- * @param date date for processing
103
- * @param type output format type
104
- * @param code country/language code
184
+ * Constructor.
185
+ * @param date date
186
+ * @param type output format
187
+ * @param code country code
105
188
  */
106
189
  constructor(date: RefOrNormal<NumberOrStringOrDate>, type?: RefOrNormal<GeoDate>, code?: RefOrNormal<string>);
107
- /** Returns basic date data. */
190
+ /**
191
+ * Get basic date data.
192
+ */
108
193
  getItem(): Ref<NumberOrStringOrDate>;
109
- /** Returns Date object. */
194
+ /**
195
+ * Get Date object.
196
+ */
110
197
  getDate(): Ref<Date>;
111
- /** Get base Datetime class object. */
198
+ /**
199
+ * Get Datetime class instance.
200
+ */
112
201
  getDatetime(): Datetime;
113
- /** Returns hours format. */
202
+ /**
203
+ * Get hours format.
204
+ */
114
205
  getHoursType(): ComputedRef<GeoHours>;
115
- /** Returns first day of week code. */
206
+ /**
207
+ * Get first day of week code.
208
+ */
116
209
  getFirstDayCode(): ComputedRef<GeoFirstDay>;
117
- /** Get year local time. */
210
+ /**
211
+ * Get year.
212
+ */
118
213
  getYear(): ComputedRef<number>;
119
- /** Get month local time (zero-based). */
214
+ /**
215
+ * Get zero-based month.
216
+ */
120
217
  getMonth(): ComputedRef<number>;
121
- /** Get day of month local time. */
218
+ /**
219
+ * Get day of month.
220
+ */
122
221
  getDay(): ComputedRef<number>;
123
- /** Get hour local time. */
222
+ /**
223
+ * Get hours.
224
+ */
124
225
  getHour(): ComputedRef<number>;
125
- /** Get minutes local time. */
226
+ /**
227
+ * Get minutes.
228
+ */
126
229
  getMinute(): ComputedRef<number>;
127
- /** Get seconds local time. */
230
+ /**
231
+ * Get seconds.
232
+ */
128
233
  getSecond(): ComputedRef<number>;
129
- /** Get last day of week. */
234
+ /**
235
+ * Get last day of month.
236
+ */
130
237
  getMaxDay(): ComputedRef<number>;
131
- /** Locale formatting. @param type format type @param styleOptions month representation */
238
+ /**
239
+ * Locale-sensitive date formatting.
240
+ */
132
241
  locale(type?: GeoDate, styleOptions?: Intl.DateTimeFormatOptions['month'] | Intl.DateTimeFormatOptions): ComputedRef<string>;
133
- /** Standard data output. @param timeZone add time zone */
242
+ /**
243
+ * Standard data output.
244
+ */
134
245
  standard(timeZone?: boolean): ComputedRef<string>;
135
246
  }
247
+
248
+
136
249
  // File: src/classes/ref/EffectScopeGlobal.d.ts
137
- /** Global effect scope class. */
250
+ /**
251
+ * Global effect scope.
252
+ */
138
253
  export declare class EffectScopeGlobal {
139
- /** Runs function in global scope. @returns return value of function */
254
+ /**
255
+ * Run function in global scope.
256
+ * @returns function return value
257
+ */
140
258
  static run<T>(fn: () => T): T | undefined;
141
259
  }
260
+
261
+
142
262
  // File: src/classes/ref/EventRef.d.ts
143
- /** Class for working with events (Ref). */
263
+ /**
264
+ * Event management class (Ref).
265
+ */
144
266
  export declare class EventRef<E extends ElementOrWindow, O extends Event, D extends Record<string, any> = Record<string, any>> extends EventItem<E, O, D> {
145
267
  /**
146
- * @param elementSelector element
147
- * @param elementSelectorControl control element
148
- * @param type type
149
- * @param listener event listener
150
- * @param options characteristics
151
- * @param detail event-dependent value
268
+ * Constructor.
152
269
  */
153
270
  constructor(elementSelector?: RefOrNormal<ElementOrString<E> | undefined>, elementSelectorControl?: RefOrNormal<ElementOrString<HTMLElement>>, type?: string | string[], listener?: EventListenerDetail<O, D>, options?: EventOptions, detail?: D);
154
271
  }
272
+
273
+
155
274
  // File: src/classes/ref/GeoFlagRef.d.ts
156
- /** Class for working with Flags. */
275
+ /**
276
+ * Flag management class.
277
+ */
157
278
  export declare class GeoFlagRef {
158
- /** @param code country and language code */
279
+ /**
280
+ * Constructor.
281
+ * @param code country code
282
+ */
159
283
  constructor(code?: RefOrNormal<string>);
160
- /** Get reactive object with country code. */
284
+ /**
285
+ * Get reactive country code.
286
+ */
161
287
  getCode(): Ref<string>;
162
- /** Get country and flag info. @param code country code */
288
+ /**
289
+ * Get country and flag info.
290
+ */
163
291
  get(code?: string): ComputedRef<GeoFlagItem | undefined>;
164
- /** Get flag link. @param code country code */
292
+ /**
293
+ * Get flag link.
294
+ */
165
295
  getFlag(code?: string): ComputedRef<string | undefined>;
166
- /** Get countries list by codes. @param codes country codes */
296
+ /**
297
+ * Get list of countries by codes.
298
+ */
167
299
  getList(codes?: string[]): ComputedRef<GeoFlagItem[]>;
168
- /** Get countries list by codes in national language. @param codes country codes */
300
+ /**
301
+ * Get list in national language.
302
+ */
169
303
  getNational(codes?: string[]): ComputedRef<GeoFlagNational[]>;
170
304
  }
305
+
306
+
171
307
  // File: src/classes/ref/GeoIntlRef.d.ts
172
- /** Reactive class for formatting numbers and dates. */
308
+ /**
309
+ * Reactive numbers and dates formatting.
310
+ */
173
311
  export declare class GeoIntlRef {
174
- /** @param code country code/language */
312
+ /**
313
+ * Constructor.
314
+ * @param code country code
315
+ */
175
316
  constructor(code?: RefOrNormal<string>);
176
- /** Translation of display names. */
317
+ /**
318
+ * Translate display names.
319
+ */
177
320
  display(value?: RefOrNormal<string>, typeOptions?: Intl.DisplayNamesOptions['type'] | Intl.DisplayNamesOptions): ComputedRef<string>;
178
- /** Get language display name. */
321
+ /**
322
+ * Get language names.
323
+ */
179
324
  languageName(value?: RefOrNormal<string>, style?: Intl.RelativeTimeFormatStyle): ComputedRef<string>;
180
- /** Get region display name. */
325
+ /**
326
+ * Get region names.
327
+ */
181
328
  countryName(value?: RefOrNormal<string>, style?: Intl.RelativeTimeFormatStyle): ComputedRef<string>;
182
- /** Number formatting. */
329
+ /**
330
+ * Number formatting.
331
+ */
183
332
  number(value: RefOrNormal<NumberOrString>, options?: Intl.NumberFormatOptions): ComputedRef<string>;
184
- /** Decimal point symbol. */
333
+ /**
334
+ * Decimal point symbol.
335
+ */
185
336
  decimal(): ComputedRef<string>;
186
- /** Currency formatting. */
337
+ /**
338
+ * Currency formatting.
339
+ */
187
340
  currency(value: RefOrNormal<NumberOrString>, currencyOptions?: RefOrNormal<string | Intl.NumberFormatOptions>, numberOnly?: boolean): ComputedRef<string>;
188
- /** Get currency symbol or code. */
341
+ /**
342
+ * Get currency symbol or code.
343
+ */
189
344
  currencySymbol(currency: RefOrNormal<string>, currencyDisplay?: keyof Intl.NumberFormatOptionsCurrencyDisplayRegistry): ComputedRef<string>;
190
- /** Unit formatting. */
345
+ /**
346
+ * Unit formatting.
347
+ */
191
348
  unit(value: RefOrNormal<NumberOrString>, unitOptions?: string | Intl.NumberFormatOptions): ComputedRef<string>;
192
- /** Formatted file size. */
349
+ /**
350
+ * File size formatting.
351
+ */
193
352
  sizeFile(value: RefOrNormal<NumberOrString>, unitOptions?: 'byte' | 'kilobyte' | 'megabyte' | 'gigabyte' | 'terabyte' | 'petabyte' | Intl.NumberFormatOptions): ComputedRef<string>;
194
- /** Number as percentage. */
353
+ /**
354
+ * Percentage formatting.
355
+ */
195
356
  percent(value: RefOrNormal<NumberOrString>, options?: Intl.NumberFormatOptions): ComputedRef<string>;
196
- /** Number as percentage (unit). */
357
+ /**
358
+ * Percentage formatting (unit).
359
+ */
197
360
  percentBy100(value: RefOrNormal<NumberOrString>, options?: Intl.NumberFormatOptions): ComputedRef<string>;
198
- /** Plural formatting. */
361
+ /**
362
+ * Plural rules formatting.
363
+ */
199
364
  plural(value: RefOrNormal<NumberOrString>, words: string, options?: Intl.PluralRulesOptions, optionsNumber?: Intl.NumberFormatOptions): ComputedRef<string>;
200
- /** Date and time formatting. */
365
+ /**
366
+ * Date/time formatting.
367
+ */
201
368
  date(value: RefOrNormal<NumberOrStringOrDate>, type?: GeoDate, styleOptions?: Intl.DateTimeFormatOptions['month'] | Intl.DateTimeFormatOptions, hour24?: boolean): ComputedRef<string>;
202
- /** Relative time formatting. */
369
+ /**
370
+ * Relative time formatting.
371
+ */
203
372
  relative(value: RefOrNormal<NumberOrStringOrDate>, styleOptions?: Intl.RelativeTimeFormatStyle | Intl.RelativeTimeFormatOptions, todayValue?: Date): ComputedRef<string>;
204
- /** Relative time formatting with limit. */
373
+ /**
374
+ * Relative time with standard limit.
375
+ */
205
376
  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>;
206
- /** Formatted relative value. */
377
+ /**
378
+ * Elapsed time formatting.
379
+ */
207
380
  relativeByValue(value: RefOrNormal<NumberOrString>, unit: Intl.RelativeTimeFormatUnit, styleOptions?: Intl.RelativeTimeFormatStyle | Intl.RelativeTimeFormatOptions): ComputedRef<string>;
208
- /** Month names. */
381
+ /**
382
+ * Month names.
383
+ */
209
384
  month(value?: RefOrNormal<NumberOrStringOrDate>, style?: Intl.DateTimeFormatOptions['month']): ComputedRef<string>;
210
- /** List of months. */
385
+ /**
386
+ * List of months.
387
+ */
211
388
  months(style?: Intl.DateTimeFormatOptions['month']): ComputedRef<ItemValue<number | undefined>[]>;
212
- /** Weekday names. */
389
+ /**
390
+ * Weekday names.
391
+ */
213
392
  weekday(value?: RefOrNormal<NumberOrStringOrDate>, style?: Intl.DateTimeFormatOptions['weekday']): ComputedRef<string>;
214
- /** List of weekdays. */
393
+ /**
394
+ * List of weekdays.
395
+ */
215
396
  weekdays(style?: Intl.DateTimeFormatOptions['weekday']): ComputedRef<ItemValue<number | undefined>[]>;
216
- /** Time formatting. */
397
+ /**
398
+ * Time formatting.
399
+ */
217
400
  time(value: RefOrNormal<NumberOrStringOrDate>): ComputedRef<string>;
218
- /** Sort strings. */
401
+ /**
402
+ * Country-aware string sorting.
403
+ */
219
404
  sort<T>(data: RefOrNormal<T[]>, compareFn?: (a: T, b: T) => [string, string]): ComputedRef<T[]>;
220
405
  }
406
+
407
+
221
408
  // File: src/classes/ref/GeoRef.d.ts
222
- /** Reactive class for geographic data. */
409
+ /**
410
+ * Reactive geographic data.
411
+ */
223
412
  export declare class GeoRef {
224
- /** Full geographic info. */
413
+ /**
414
+ * Current country info.
415
+ */
225
416
  static get(): Ref<GeoItemFull>;
226
- /** Current country code. */
417
+ /**
418
+ * Current country code.
419
+ */
227
420
  static getCountry(): ComputedRef<string>;
228
- /** Current language code. */
421
+ /**
422
+ * Current language code.
423
+ */
229
424
  static getLanguage(): ComputedRef<string>;
230
- /** Full standard locale format. */
425
+ /**
426
+ * Full standard locale.
427
+ */
231
428
  static getStandard(): ComputedRef<string>;
232
- /** First day of the week. */
429
+ /**
430
+ * Get first day of week.
431
+ */
233
432
  static getFirstDay(): ComputedRef<string>;
234
- /** Set data by full code. @param code country/language code */
433
+ /**
434
+ * Set data by code.
435
+ */
235
436
  static set(code: string): void;
236
437
  }
438
+
439
+
237
440
  // File: src/classes/ref/ListDataRef.d.ts
238
- /** Class for managing data list. */
441
+ /**
442
+ * List data management.
443
+ */
239
444
  export declare class ListDataRef {
445
+ /**
446
+ * Constructor.
447
+ */
240
448
  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);
241
- /** List for forming a list. */
449
+ /** List for rendering. */
242
450
  readonly data: ComputedRef<ListList>;
243
- /** Simplified list for quick loading. */
451
+ /** Simplified list. */
244
452
  readonly liteData: ComputedRef<ListList>;
245
- /** List with all additional state data. */
453
+ /** Full list with state. */
246
454
  readonly fullData: ComputedRef<ListDataFull>;
247
455
  /** Flat map of all entries. */
248
456
  readonly map: ComputedRef<ListList>;
249
- /** List consisting only of items. */
457
+ /** Only items map. */
250
458
  readonly mapItems: ComputedRef<ListList>;
251
- /** List of values for selection. */
459
+ /** Selection items. */
252
460
  readonly items: ComputedRef<ListList>;
253
- /** First found search index. */
461
+ /** First search result index. */
254
462
  readonly highlightFirstItem: ComputedRef<number>;
255
- /** Is any item selected. */
463
+ /** Has selection. */
256
464
  readonly isSelected: ComputedRef<boolean>;
257
- /** Is minimum selection reached. */
465
+ /** Min selection reached. */
258
466
  readonly isSelectedMin: ComputedRef<boolean>;
259
- /** Is maximum selection reached. */
467
+ /** Max selection reached. */
260
468
  readonly isSelectedMax: ComputedRef<boolean>;
261
- /** Selected items on map. */
469
+ /** Map of selected items. */
262
470
  readonly selectedList: ComputedRef<ListList>;
263
- /** Selected items in current group. */
471
+ /** Selected items in group. */
264
472
  readonly selectedListInGroup: ComputedRef<ListList>;
265
- /** Selected labels on map. */
473
+ /** Selected labels. */
266
474
  readonly selectedNames: ComputedRef<ListNames>;
267
- /** Selected values on map. */
475
+ /** Selected values. */
268
476
  readonly selectedValues: ComputedRef<any[]>;
269
477
  /** Is lite mode active. */
270
478
  isLite(): boolean;
271
- /** Is element in focus. */
479
+ /** Is focus active. */
272
480
  isFocus(): boolean;
273
- /** Is there a search result highlight. */
481
+ /** Is highlight active. */
274
482
  isHighlight(): boolean;
275
- /** Is highlighting active. */
483
+ /** Is minimum highlight length reached. */
276
484
  isHighlightActive(): boolean;
277
- /** Count of records in current list. */
485
+ /** Current list length. */
278
486
  getLength(): number;
279
- /** Total available records in map. */
487
+ /** Map length. */
280
488
  getLengthByMap(): number;
281
- /** Total available records (items). */
489
+ /** Items length. */
282
490
  getLengthByItems(): number;
283
491
  /** Get focus identifier. */
284
492
  getFocus(): ListSelectedItem | undefined;
285
- /** Get item in focus. */
493
+ /** Get focus item. */
286
494
  getFocusItem(): ListDataItem | undefined;
287
495
  /** Get highlight text. */
288
496
  getHighlight(): string | undefined;
289
- /** Get minimum highlight length. */
497
+ /** Get min highlight length. */
290
498
  getHighlightLengthStart(): number;
291
- /** Get selected identifiers. */
499
+ /** Get selected IDs. */
292
500
  getSelected(): ListSelectedList | undefined;
293
- /** Get item by relative step from selected. */
501
+ /** Get item by relative step. */
294
502
  getSelectedByStep(step: number): ListSelectedItem | undefined;
295
- /** Get next item from selected. */
503
+ /** Get next item. */
296
504
  getSelectedNext(): ListSelectedItem | undefined;
297
- /** Get previous item from selected. */
505
+ /** Get previous item. */
298
506
  getSelectedPrev(): ListSelectedItem | undefined;
299
- /** Get item by step from item. */
507
+ /** Move step from item. */
300
508
  getItemByStep(item: ListDataItem, step: number): ListDataItem | undefined;
301
- /** Get next item. */
509
+ /** Get next item from item. */
302
510
  getItemNext(item: ListDataItem): ListDataItem | undefined;
303
- /** Get previous item. */
511
+ /** Get previous item from item. */
304
512
  getItemPrev(item: ListDataItem): ListDataItem | undefined;
305
- /** Get item by step from index. */
513
+ /** Move step from index. */
306
514
  getIndexByStep(index: string, step: number): ListDataItem | undefined;
307
- /** Get next item from index. */
515
+ /** Next from index. */
308
516
  getIndexNext(index: string): ListDataItem | undefined;
309
- /** Get previous item from index. */
517
+ /** Previous from index. */
310
518
  getIndexPrev(index: string): ListDataItem | undefined;
311
519
  /** Get item by index. */
312
520
  getItemByIndex(index?: string): {
@@ -315,63 +523,93 @@ export declare class ListDataRef {
315
523
  } | undefined;
316
524
  /** Get item by key. */
317
525
  getItemByKey(key: number): ListDataItem | undefined;
318
- /** Get first item by parent ID. */
526
+ /** First item in parent. */
319
527
  getFirstItemByParent(parent: string | undefined): ListDataItem | undefined;
320
- /** Get last item by parent ID. */
528
+ /** Last item in parent. */
321
529
  getLastItemByParent(parent: string | undefined): ListDataItem | undefined;
322
- /** Get sublist object. */
530
+ /** Get sublist for group. */
323
531
  getSubList(item: ListDataItem): ListDataRef;
324
532
  }
533
+
534
+
325
535
  // File: src/classes/ref/RouterItemRef.d.ts
326
- /** Router management class. */
536
+ /**
537
+ * Router management.
538
+ */
327
539
  export declare class RouterItemRef {
328
540
  /** Get router instance. */
329
541
  static get(): Router;
330
- /** Get link string by name. */
542
+ /** Get link by name. */
331
543
  static getLink(name: string, params?: any, query?: any): string | undefined;
332
- /** Get href props by name. */
544
+ /** Get href props. */
333
545
  static getHref(name?: string, params?: any, query?: any): ConstrHrefProps;
334
- /** Change site path. */
546
+ /** Change path. */
335
547
  static push(to: string | RouteLocationRaw): void;
336
548
  /** Set router instance. */
337
549
  static set(router: Router): void;
338
- /** Set router instance once. */
550
+ /** Set router once. */
339
551
  static setOneTime(router: Router): void;
340
- /** Convert raw location to href. */
552
+ /** Raw to href props. */
341
553
  static rawToHref(to?: string | RouteLocationRaw): ConstrHrefProps;
342
554
  }
555
+
556
+
343
557
  // File: src/classes/ref/ScrollbarWidthRef.d.ts
344
- /** Class for getting scroll width reactively. */
558
+ /**
559
+ * Reactive scroll width.
560
+ */
345
561
  export declare class ScrollbarWidthRef {
346
562
  readonly item: Ref<boolean | undefined, boolean | undefined>;
347
563
  readonly width: Ref<number, number>;
348
564
  constructor();
349
- /** Is scroll width defined. */
565
+ /** Width defined. */
350
566
  readonly is: ComputedRef<boolean>;
351
567
  }
568
+
569
+
352
570
  // File: src/composables/ref/useApiAsyncRef.d.ts
353
- /** Executes request and initializes asynchronously. */
354
- 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>;
571
+ /**
572
+ * Async reactive API request with SSR support.
573
+ * @remarks Use for server-side pre-fetching.
574
+ * @example
575
+ * ```typescript
576
+ * const { data, loading } = useApiAsyncRef('/users/1')
577
+ * ```
578
+ */
579
+ 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, errorContract?: ApiErrorStorageList, unmounted?: boolean, apiInstance?: ApiInstance): UseApiRef<R>;
580
+
581
+
355
582
  // File: src/composables/ref/useApiDelete.d.ts
356
- /** Use API delete request. */
357
- 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): {
583
+ /**
584
+ * API DELETE request wrapper.
585
+ */
586
+ 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, errorContract?: ApiErrorStorageList, toData?: boolean, options?: ApiOptions, apiInstance?: ApiInstance): {
358
587
  loading: Ref<boolean, boolean>;
359
588
  send(request?: Request | undefined): Promise<Return | undefined>;
360
589
  };
590
+
591
+
361
592
  // File: src/composables/ref/useApiGet.d.ts
362
- /** Use API get request. */
363
- 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): {
593
+ /**
594
+ * API GET request wrapper.
595
+ */
596
+ 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, errorContract?: ApiErrorStorageList, toData?: boolean, options?: ApiOptions, apiInstance?: ApiInstance): {
364
597
  loading: Ref<boolean, boolean>;
365
598
  send(request?: Request | undefined): Promise<Return | undefined>;
366
599
  };
600
+
601
+
367
602
  // File: src/composables/ref/useApiManagementAsyncRef.d.ts
368
- /** Executes API management request and initializes asynchronously. */
603
+ /**
604
+ * Async API management with SSR support.
605
+ */
369
606
  export declare function useApiManagementAsyncRef<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): {
370
607
  isValid: ComputedRef<boolean>;
371
608
  isResponseContractValid: ComputedRef<boolean>;
372
609
  responseValidationResult: ComputedRef< ApiDataValidation | undefined>;
373
610
  list: ComputedRef<SearchFormatList<ItemFormatters, Columns>>;
374
611
  readonly data: ComputedRef< ApiData<Return> | undefined>;
612
+ errorItem: ComputedRef< ApiErrorItem | undefined>;
375
613
  readonly length: ComputedRef<number>;
376
614
  lengthData: ComputedRef<number>;
377
615
  starting: ComputedRef<boolean>;
@@ -382,7 +620,7 @@ export declare function useApiManagementAsyncRef<Return extends ApiManagementVal
382
620
  loadingPut: Ref<boolean, boolean> | undefined;
383
621
  loadingDelete: Ref<boolean, boolean> | undefined;
384
622
  isSearch: ComputedRef<boolean> | undefined;
385
- search: Ref<string, string> | undefined;
623
+ search: Ref<string>;
386
624
  init: () => void;
387
625
  initSsr: () => void;
388
626
  reset: () => Promise<void>;
@@ -391,13 +629,18 @@ export declare function useApiManagementAsyncRef<Return extends ApiManagementVal
391
629
  sendPut: (request?: ApiFetch["request"]) => Promise< ApiData<Put> | undefined>;
392
630
  sendDelete: (request?: ApiFetch["request"]) => Promise< ApiData<Delete> | undefined>;
393
631
  };
632
+
633
+
394
634
  // File: src/composables/ref/useApiManagementRef.d.ts
395
635
  /**
396
- * Composable for API request orchestration. Manages GET, formatting, search, and mutations.
397
- * @note Use with `executeUse` for centralized state.
398
- * @remarks Recommended for values, dates, statuses. Not for technical IDs.
636
+ * Orchestrates API loading, formatting, searching, and mutations.
637
+ * @note Use with `executeUse` for global state.
638
+ * @remarks
639
+ * Formatters guidelines:
640
+ * - Recommended: Values, dates, currency.
641
+ * - Not recommended: Tech IDs, UUIDs.
399
642
  * @example
400
- * const products = useApiManagementRef({ path: '/api/v1/products' }, { price: (v) => `${v} USD` });
643
+ * const products = useApiManagementRef({ path: '/api/v1/products' });
401
644
  */
402
645
  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): {
403
646
  isValid: ComputedRef<boolean>;
@@ -405,6 +648,7 @@ export declare function useApiManagementRef<Return extends ApiManagementValue, F
405
648
  responseValidationResult: ComputedRef< ApiDataValidation | undefined>;
406
649
  list: ComputedRef<SearchFormatList<ItemFormatters, Columns>>;
407
650
  readonly data: ComputedRef<ApiData<Return> | undefined>;
651
+ errorItem: ComputedRef< ApiErrorItem | undefined>;
408
652
  readonly length: ComputedRef<number>;
409
653
  lengthData: ComputedRef<number>;
410
654
  starting: ComputedRef<boolean>;
@@ -415,7 +659,7 @@ export declare function useApiManagementRef<Return extends ApiManagementValue, F
415
659
  loadingPut: Ref<boolean, boolean> | undefined;
416
660
  loadingDelete: Ref<boolean, boolean> | undefined;
417
661
  isSearch: ComputedRef<boolean> | undefined;
418
- search: Ref<string, string> | undefined;
662
+ search: Ref<string>;
419
663
  init: () => void;
420
664
  initSsr: () => void;
421
665
  reset: () => Promise<void>;
@@ -424,22 +668,36 @@ export declare function useApiManagementRef<Return extends ApiManagementValue, F
424
668
  sendPut: (request?: ApiFetch["request"]) => Promise<ApiData<Put> | undefined>;
425
669
  sendDelete: (request?: ApiFetch["request"]) => Promise<ApiData<Delete> | undefined>;
426
670
  };
671
+
672
+
427
673
  // File: src/composables/ref/useApiPost.d.ts
428
- /** Use API post request. */
429
- 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): {
674
+ /**
675
+ * API POST request wrapper.
676
+ */
677
+ 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, errorContract?: ApiErrorStorageList, toData?: boolean, options?: ApiOptions, apiInstance?: ApiInstance): {
430
678
  loading: Ref<boolean, boolean>;
431
679
  send(request?: Request | undefined): Promise<Return | undefined>;
432
680
  };
681
+
682
+
433
683
  // File: src/composables/ref/useApiPut.d.ts
434
- /** Use API put request. */
435
- 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): {
684
+ /**
685
+ * API PUT request wrapper.
686
+ */
687
+ 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, errorContract?: ApiErrorStorageList, toData?: boolean, options?: ApiOptions, apiInstance?: ApiInstance): {
436
688
  loading: Ref<boolean, boolean>;
437
689
  send(request?: Request | undefined): Promise<Return | undefined>;
438
690
  };
691
+
692
+
439
693
  // File: src/composables/ref/useApiRef.d.ts
694
+ /**
695
+ * useApiRef return interface.
696
+ */
440
697
  export interface UseApiRef<R> {
441
698
  data: ComputedRef<ApiData<R> | undefined>;
442
699
  item: Ref<ApiData<R> | undefined>;
700
+ errorItem: ComputedRef<ApiErrorItem | undefined>;
443
701
  isResponseContractValid: ComputedRef<boolean>;
444
702
  responseValidationResult: ComputedRef<ApiDataValidation | undefined>;
445
703
  length: ComputedRef<number>;
@@ -456,45 +714,82 @@ export interface UseApiRef<R> {
456
714
  stop(): void;
457
715
  abort(): void;
458
716
  }
459
- /** Returns data for working with requests. */
460
- 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>;
461
- /** Global conditions for API request. */
717
+ /**
718
+ * Reactive API request handler.
719
+ * @example
720
+ * ```typescript
721
+ * const { data, loading } = useApiRef('/users/1')
722
+ * ```
723
+ */
724
+ export declare function useApiRef<R, T = R>(path?: RefOrNormal<string | undefined>, options?: ApiOptions, reactivity?: boolean, conditions?: RefType<boolean>, transformation?: (data: T, isResponseContractValid?: ApiDataValidation) => ApiData<R>, validateResponseContract?: (data: T) => ApiDataValidation, errorContract?: ApiErrorStorageList, unmounted?: boolean, apiInstance?: ApiInstance): UseApiRef<R>;
725
+ /**
726
+ * Global API conditions.
727
+ */
462
728
  export declare const setApiRefGlobalConditions: (conditions: RefType<any>) => void;
729
+
730
+
463
731
  // File: src/composables/ref/useApiRequest.d.ts
464
- /** Use api request. */
465
- 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): {
732
+ /**
733
+ * Generic API request.
734
+ */
735
+ 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, errorContract?: ApiErrorStorageList, toData?: boolean, options?: ApiOptions, apiInstance?: ApiInstance): {
466
736
  loading: Ref<boolean, boolean>;
467
737
  send(request?: Request): Promise<Return | undefined>;
468
738
  };
739
+
740
+
469
741
  // File: src/composables/ref/useBroadcastValueRef.d.ts
470
- type BroadcastValueItem<T> = T | string | undefined;
471
- /** Manage data between browser tabs. */
742
+ /**
743
+ * Reactive data sync between tabs.
744
+ */
472
745
  export declare function useBroadcastValueRef<T>(name: string, defaultValue?: T | string | (() => (T | string))): Ref<BroadcastValueItem<T>>;
746
+
747
+
473
748
  // File: src/composables/ref/useCookieRef.d.ts
474
- /** Reactive variable for cookies. */
749
+ /**
750
+ * Reactive cookie management.
751
+ */
475
752
  export declare function useCookieRef<T>(name: string, defaultValue?: T | string | (() => (T | string)), options?: CookieOptions): Ref<T | string | undefined>;
753
+
754
+
476
755
  // File: src/composables/ref/useFormattersRef.d.ts
477
- /** Reactive formatting of data lists. */
756
+ /**
757
+ * Reactive list formatting.
758
+ */
478
759
  export declare function useFormattersRef<Options extends FormattersOptionsList = FormattersOptionsList, List extends FormattersListProp = FormattersListProp>(list: RefType<List | undefined>, options: Options): {
479
760
  listFormat: ComputedRef<FormattersReturn<List, Options>>;
480
761
  length: ComputedRef<number>;
481
762
  };
763
+
764
+
482
765
  // File: src/composables/ref/useGeoIntlRef.d.ts
483
- /** Working with data formatting. */
766
+ /**
767
+ * Get GeoIntlRef instance.
768
+ */
484
769
  export declare function useGeoIntlRef(): GeoIntlRef;
770
+
771
+
485
772
  // File: src/composables/ref/useHashRef.d.ts
486
- /** Manage URL hash. */
773
+ /**
774
+ * Reactive hash management.
775
+ */
487
776
  export declare function useHashRef<T>(name: string, defaultValue?: T | (() => T)): ShallowRef<T>;
777
+
778
+
488
779
  // File: src/composables/ref/useLazyItemByMarginRef.d.ts
489
780
  export type LazyItemByMargin = {
490
781
  rootMargin: string;
491
782
  item: any;
492
783
  };
493
- /** Track element appearance by margin. */
784
+ /**
785
+ * Track element screen appearance by margin.
786
+ */
494
787
  export declare const useLazyItemByMarginRef: (element: RefType<HTMLElement | undefined>, rootMargin: string) => {
495
788
  lazyItemStatus: any;
496
789
  readonly lazyItem: any;
497
790
  };
791
+
792
+
498
793
  // File: src/composables/ref/useLazyRef.d.ts
499
794
  export type LazyItem = {
500
795
  status: ShallowRef<boolean>;
@@ -503,7 +798,9 @@ export type LazyItem = {
503
798
  stopWatch: () => void;
504
799
  };
505
800
  export type LazyList = Record<string, LazyItem>;
506
- /** Track element appearance on screen. */
801
+ /**
802
+ * Track element screen appearance.
803
+ */
507
804
  export declare const useLazyRef: (options?: IntersectionObserverInit) => {
508
805
  intersectionObserver: IntersectionObserver | undefined;
509
806
  getItem(element: HTMLElement): LazyItem;
@@ -511,11 +808,19 @@ export declare const useLazyRef: (options?: IntersectionObserverInit) => {
511
808
  removeLazyItem: (element?: HTMLElement) => void;
512
809
  disconnectLazy: () => void | undefined;
513
810
  };
811
+
812
+
514
813
  // File: src/composables/ref/useLoadingRef.d.ts
515
- /** Returns loading status. */
814
+ /**
815
+ * Get loading status.
816
+ */
516
817
  export declare function useLoadingRef(): ShallowRef<boolean, boolean>;
818
+
819
+
517
820
  // File: src/composables/ref/useMeta.d.ts
518
- /** Reactive meta tags management with automatic DOM sync. */
821
+ /**
822
+ * Reactive meta tags singleton.
823
+ */
519
824
  export declare const useMeta: () => Readonly<{
520
825
  meta: typeof MetaStatic;
521
826
  title: Ref<string, string>;
@@ -566,8 +871,12 @@ export declare const useMeta: () => Readonly<{
566
871
  }>;
567
872
  destroyExecute?(): void;
568
873
  }>;
874
+
875
+
569
876
  // File: src/composables/ref/useRouterList.d.ts
570
- /** Managing link list for router. */
877
+ /**
878
+ * Link list management for router.
879
+ */
571
880
  export declare const useRouterList: <T extends ListDataBasic>(list: RefType<ConstrBind<T>[] | undefined>, selected?: Ref<string> | string, hasTo?: boolean) => {
572
881
  item: ComputedRef<T | undefined>;
573
882
  selected: Ref<string, string>;
@@ -576,8 +885,12 @@ export declare const useRouterList: <T extends ListDataBasic>(list: RefType<Cons
576
885
  to: (name?: string) => void;
577
886
  toMain(): void;
578
887
  };
888
+
889
+
579
890
  // File: src/composables/ref/useSearchRef.d.ts
580
- /** Handling search logic with reactive data. */
891
+ /**
892
+ * Reactive search logic.
893
+ */
581
894
  export declare function useSearchRef<T extends SearchItem, K extends SearchColumns<T>>(list: SearchListInput<T>, columns: K, value?: Ref<string>, options?: SearchOptions): {
582
895
  isSearch: ComputedRef<boolean>;
583
896
  search: Ref<string, string>;
@@ -585,42 +898,80 @@ export declare function useSearchRef<T extends SearchItem, K extends SearchColum
585
898
  listSearch: ComputedRef<SearchFormatList<T, K>>;
586
899
  length: ComputedRef<number>;
587
900
  };
901
+
902
+
588
903
  // File: src/composables/ref/useSearchValueRef.d.ts
589
- /** Managing search value state and delays. */
904
+ /**
905
+ * Debounced search state.
906
+ */
590
907
  export declare function useSearchValueRef<T extends SearchItem, K extends SearchColumns<T>>(item: SearchList<T, K>, value?: Ref<string>): {
591
908
  search: Ref<string, string>;
592
909
  searchDelay: Ref<string, string>;
593
910
  loading: Ref<boolean, boolean>;
594
911
  };
912
+
913
+
595
914
  // File: src/composables/ref/useSessionRef.d.ts
596
- /** Manage session storage. */
915
+ /**
916
+ * Reactive session storage.
917
+ */
597
918
  export declare function useSessionRef<T>(name: string, defaultValue?: T | (() => T)): Ref<T | undefined>;
919
+
920
+
598
921
  // File: src/composables/ref/useStorageRef.d.ts
599
- /** Manage local storage. */
922
+ /**
923
+ * Reactive local storage.
924
+ */
600
925
  export declare function useStorageRef<T>(name: string, defaultValue?: T | (() => T), cache?: number): Ref<T | undefined>;
926
+
927
+
601
928
  // File: src/composables/ref/useTranslateRef.d.ts
602
929
  /**
603
- * Translation of text by keys. ShallowRef updates on global language change.
930
+ * Get reactive translations.
931
+ * @remarks Use `as const` for arrays.
604
932
  * @example
605
- * const translations = useTranslateRef(['home.title'] as const);
933
+ * ```typescript
934
+ * const labels = t(['button.save', 'button.cancel'] as const);
935
+ * ```
606
936
  */
607
937
  export declare function useTranslateRef<T extends (string | string[])[]>(names: T, translateInstance?: TranslateInstance): ShallowRef<TranslateList<T>>;
608
- /** Shorthand for useTranslateRef. */
938
+ /**
939
+ * Shorthand for translations.
940
+ */
609
941
  export declare const t: <T extends string[]>(names: T) => ShallowRef<TranslateList<T>>;
942
+
943
+
610
944
  // File: src/flags.d.ts
611
945
  export declare const uiMakeFlags: () => void;
946
+
947
+
612
948
  // File: src/functions/basic.d.ts
613
949
  export * from '@dxtmisha/functional-basic';
950
+
951
+
614
952
  // File: src/functions/computedAsync.d.ts
615
- /** Computed property for async getters. */
953
+ /**
954
+ * Async computed property.
955
+ */
616
956
  export declare function computedAsync<R>(getter: (() => Promise<R>) | (() => R) | R, initialState?: (() => R) | R, ignore?: R, debugOptions?: DebuggerOptions): ComputedRef<R | undefined>;
957
+
958
+
617
959
  // File: src/functions/computedByLanguage.d.ts
618
- /** Computed property reacting to current language. */
960
+ /**
961
+ * Language-aware computed property.
962
+ */
619
963
  export declare function computedByLanguage<T, R extends (T | undefined) = T | undefined>(getter: ComputedGetter<R>, getterNone?: R | (() => R), conditions?: () => boolean, debugOptions?: DebuggerOptions): ComputedRef<R>;
964
+
965
+
620
966
  // File: src/functions/computedEternity.d.ts
621
- /** Computed property cached on demand; remains active application-wide. */
967
+ /**
968
+ * Cached on-demand computed property.
969
+ */
622
970
  export declare function computedEternity<T>(getter: () => Promise<T> | T, initialState?: (() => T) | T): Ref<T, T>;
971
+
972
+
623
973
  // File: src/functions/dxtFunctionalPlugin.d.ts
974
+ /** Functional plugin options. */
624
975
  export interface FunctionalPluginOptions {
625
976
  api?: ApiConfig;
626
977
  translate?: TranslateConfig;
@@ -628,27 +979,30 @@ export interface FunctionalPluginOptions {
628
979
  icons?: IconsConfig;
629
980
  router?: Router;
630
981
  errorCauses?: ErrorCenterCauseList;
982
+ errorHandlers?: ErrorCenterHandlerList;
631
983
  }
632
- /** Vue plugin initializing functional services. */
984
+ /** Functional services plugin. */
633
985
  export declare const dxtFunctionalPlugin: Plugin;
986
+
987
+
634
988
  // File: src/functions/executeUse.d.ts
635
989
  export declare enum ExecuteUseType {
636
990
  global = "global",
637
991
  provide = "provide",
638
992
  local = "local"
639
993
  }
994
+ /** Return with management methods. */
640
995
  export type ExecuteUseReturn<R> = Readonly<R & {
641
996
  init(): Readonly<R>;
642
997
  destroyExecute?(): void;
643
998
  }>;
644
999
  /**
645
- * Managed singleton accessor.
646
- * @remarks Use for API Services, Shared State, External SDKs.
647
- * @example
648
- * export const useUserApi = executeUseGlobal(() => useApiGet('/api/user'));
1000
+ * Managed singleton factory.
1001
+ * @remarks
1002
+ * Use for API services, resource optimization, shared state, SDKs.
649
1003
  */
650
1004
  export declare function executeUse<R, O extends any[], RI extends ExecuteUseReturn<R> = ExecuteUseReturn<R>>(callback: (...args: O) => R, type?: ExecuteUseType): ((...args: O) => RI) | (() => RI);
651
- /** Global singleton creator. */
1005
+ /** Global singleton. */
652
1006
  export declare function executeUseGlobal<R>(callback: () => R): (() => Readonly<R & {
653
1007
  init(): Readonly<R>;
654
1008
  destroyExecute?(): void;
@@ -656,7 +1010,7 @@ export declare function executeUseGlobal<R>(callback: () => R): (() => Readonly<
656
1010
  init(): Readonly<R>;
657
1011
  destroyExecute?(): void;
658
1012
  }>);
659
- /** Component-scoped singleton creator. */
1013
+ /** Provide/inject singleton. */
660
1014
  export declare function executeUseProvide<R, O extends any[]>(callback: (...args: O) => R): ((...args: O) => Readonly<R & {
661
1015
  init(): Readonly<R>;
662
1016
  destroyExecute?(): void;
@@ -664,7 +1018,7 @@ export declare function executeUseProvide<R, O extends any[]>(callback: (...args
664
1018
  init(): Readonly<R>;
665
1019
  destroyExecute?(): void;
666
1020
  }>);
667
- /** Local singleton creator. */
1021
+ /** Closure-local singleton. */
668
1022
  export declare function executeUseLocal<R, O extends any[]>(callback: (...args: O) => R): ((...args: O) => Readonly<R & {
669
1023
  init(): Readonly<R>;
670
1024
  destroyExecute?(): void;
@@ -672,44 +1026,75 @@ export declare function executeUseLocal<R, O extends any[]>(callback: (...args:
672
1026
  init(): Readonly<R>;
673
1027
  destroyExecute?(): void;
674
1028
  }>);
675
- /** Initializes all global callbacks. */
1029
+ /** Init global callbacks. */
676
1030
  export declare function executeUseGlobalInit(): void;
1031
+
1032
+
677
1033
  // File: src/functions/getInject.d.ts
678
1034
  /** Get injected value. */
679
1035
  export declare function getInject<T>(name: string): T | undefined;
1036
+
1037
+
680
1038
  // File: src/functions/getOptions.d.ts
681
- /** Returns request options. */
1039
+ /** Get request options. */
682
1040
  export declare const getOptions: (options?: ApiOptions) => RefOrNormal<ApiFetch>;
1041
+
1042
+
1043
+ // File: src/functions/ref/getApiErrorRef.d.ts
1044
+ /** Get API error item. */
1045
+ export declare function getApiErrorRef<R>(data: RefType<ApiData<R> | undefined>): ComputedRef<ApiErrorItem | undefined>;
1046
+
1047
+
683
1048
  // File: src/functions/ref/getBindRef.d.ts
684
- /** Generate properties for subcomponent. */
1049
+ /** Generate props for subcomponent. */
685
1050
  export declare function getBindRef<T, R extends ItemList>(value: RefOrNormal<T | R> | undefined, nameExtra?: RefOrNormal<ItemList> | string, name?: string): ComputedRef<R>;
1051
+
1052
+
686
1053
  // File: src/functions/ref/getRef.d.ts
687
- /** Return value of ref or item itself. */
1054
+ /** Get ref value or literal. */
688
1055
  export declare function getRef<T>(item: RefOrNormal<T>): T;
1056
+
1057
+
689
1058
  // File: src/functions/ref/render.d.ts
690
- /** Rendering cached, immutable data. */
1059
+ /** Get cached VNode. */
691
1060
  export declare function render<T extends ItemList>(name: string | any, props?: T, children?: RawChildren | RawSlots, index?: string): VNode;
1061
+
1062
+
692
1063
  // File: src/functions/ref/setRef.d.ts
693
- /** Change value for reactive method. */
1064
+ /** Update reactive value. */
694
1065
  export declare function setRef<T>(item: Ref<T>, value: T): void;
1066
+
1067
+
695
1068
  // File: src/functions/ref/toRefItem.d.ts
696
- /** Wraps variable in ref if not reactive. */
1069
+ /** Ensure Ref wrapper. */
697
1070
  export declare function toRefItem<T>(item: RefOrNormal<T>): Ref<T>;
1071
+
1072
+
698
1073
  // File: src/functions/render/getBind.d.ts
699
- /** Generate properties for subcomponent. */
1074
+ /** Generate props for subcomponent. */
700
1075
  export declare function getBind<T, R extends ItemList>(value: T | R | undefined | null, nameExtra?: ItemList | string, name?: string, except?: boolean): ConstrBind<R>;
1076
+
1077
+
701
1078
  // File: src/functions/render/getClassName.d.ts
702
- /** Returns class name from property. */
1079
+ /** Get class from property. */
703
1080
  export declare function getClassName<T extends ItemList>(props?: T): string | undefined;
1081
+
1082
+
704
1083
  // File: src/functions/render/getIndexForRender.d.ts
705
- /** Generates new element. */
1084
+ /** Get or generate render index. */
706
1085
  export declare function getIndexForRender<T extends ItemList>(name: string | any, props?: T, index?: string): string | undefined;
1086
+
1087
+
707
1088
  // File: src/functions/toBind.d.ts
708
- /** Merges two objects considering classes and styles. */
1089
+ /** Merge objects with class/style handling. */
709
1090
  export declare function toBind<R extends ItemList = ItemList>(extra: ItemList, value: ItemList): ConstrBind<R>;
1091
+
1092
+
710
1093
  // File: src/functions/toBinds.d.ts
711
- /** Merges multiple objects considering classes and styles. */
1094
+ /** Merge multiple objects with class/style handling. */
712
1095
  export declare function toBinds<R extends ItemList = ItemList>(...values: (ItemList | undefined)[]): ConstrBind<R>;
1096
+
1097
+
713
1098
  // File: src/library.d.ts
714
1099
  export * from './classes/design/DesignAbstract';
715
1100
  export * from './classes/design/DesignAsyncAbstract';
@@ -758,6 +1143,7 @@ export * from './functions/dxtFunctionalPlugin';
758
1143
  export * from './functions/executeUse';
759
1144
  export * from './functions/getInject';
760
1145
  export * from './functions/getOptions';
1146
+ export * from './functions/ref/getApiErrorRef';
761
1147
  export * from './functions/ref/getBindRef';
762
1148
  export * from './functions/ref/getRef';
763
1149
  export * from './functions/ref/render';
@@ -773,12 +1159,11 @@ export * from './types/constructorTypes';
773
1159
  export * from './types/listTypes';
774
1160
  export * from './types/refTypes';
775
1161
  export * from './types/searchTypes';
1162
+
1163
+
776
1164
  // File: src/types/apiTypes.d.ts
777
- /** Options for api requests */
778
1165
  export type ApiOptions = ApiMethodItem | RefOrNormal<ApiFetch>;
779
- /** Base type for API management values. */
780
1166
  export type ApiManagementValue = ApiDefaultValue | ApiDefaultValue[];
781
- /** Configuration for GET request in API management. */
782
1167
  export type ApiManagementGet<Return extends ApiManagementValue, Type extends ApiManagementValue = Return> = {
783
1168
  path?: RefOrNormal<string | undefined>;
784
1169
  options?: ApiOptions;
@@ -786,24 +1171,26 @@ export type ApiManagementGet<Return extends ApiManagementValue, Type extends Api
786
1171
  conditions?: RefType<boolean>;
787
1172
  transformation?: (data: Type, isResponseContractValid?: ApiDataValidation) => ApiData<Return>;
788
1173
  validateResponseContract?: (data: Type) => ApiDataValidation;
1174
+ errorContract?: ApiErrorStorageList;
789
1175
  typeData?: ((data: Return) => boolean) | any;
790
1176
  unmounted?: boolean;
791
1177
  skeleton?: () => Return;
792
1178
  };
793
- /** Configuration for client-side search across API data. */
794
1179
  export type ApiManagementSearch<T extends SearchItem, K extends SearchColumns<T>> = {
795
1180
  columns: K;
796
1181
  value?: Ref<string>;
797
1182
  options?: SearchOptions;
798
1183
  };
799
- /** Configuration for mutation requests. */
800
1184
  export type ApiManagementRequest<T, Return extends ApiData<T> = ApiData<T>> = {
801
1185
  path?: RefOrNormal<string | undefined>;
802
1186
  action?: (data: Return | undefined) => Promise<void> | void;
803
1187
  transformation?: (data: T) => Return;
1188
+ errorContract?: ApiErrorStorageList;
804
1189
  toData?: boolean;
805
1190
  options?: ApiOptions;
806
1191
  };
1192
+
1193
+
807
1194
  // File: src/types/constructorTypes.d.ts
808
1195
  export type ConstrItem = Record<string, any>;
809
1196
  export type ConstrValue<T = any> = {
@@ -864,6 +1251,8 @@ export type ConstrProps<P = Record<string, any>> = {
864
1251
  export type ConstrHrefProps = {
865
1252
  href?: string;
866
1253
  };
1254
+
1255
+
867
1256
  // File: src/types/listTypes.d.ts
868
1257
  export type ListType = 'item' | 'space' | 'line' | 'subtitle' | 'html' | 'menu' | 'menu-group' | 'group';
869
1258
  export type ListDataBasic = {
@@ -892,6 +1281,8 @@ export type ListSelectedItem = NumberOrStringOrBoolean;
892
1281
  export type ListSelectedList = ListSelectedItem | ListSelectedItem[];
893
1282
  export type ListName = string | number | undefined;
894
1283
  export type ListNames = ListName[];
1284
+
1285
+
895
1286
  // File: src/types/refTypes.d.ts
896
1287
  export type RefType<T> = ComputedRef<T> | Ref<T>;
897
1288
  export type RefUndefined<T> = RefType<T | undefined>;
@@ -901,6 +1292,8 @@ export type RawSlots = {
901
1292
  [name: string]: unknown;
902
1293
  $stable?: boolean;
903
1294
  };
1295
+
1296
+
904
1297
  // File: src/types/searchTypes.d.ts
905
1298
  export type SearchListValueRef<T extends SearchItem> = RefOrNormal<SearchListValue<T>>;
906
1299
  export type SearchListInput<T extends SearchItem> = SearchListValueRef<T> | (() => SearchListValueRef<T>);