@dxtmisha/functional 1.11.13 → 1.12.0

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