@dxtmisha/functional 1.11.6 → 1.11.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/CHANGELOG.md +79 -0
  2. package/ai-description.txt +5 -0
  3. package/ai-types.txt +176 -138
  4. package/dist/classes/design/DesignAbstract.d.ts +61 -0
  5. package/dist/classes/design/DesignAsyncAbstract.d.ts +28 -0
  6. package/dist/classes/design/DesignChanged.d.ts +42 -0
  7. package/dist/classes/design/DesignComp.d.ts +4 -0
  8. package/dist/classes/design/DesignComponents.d.ts +81 -0
  9. package/dist/classes/design/DesignConstructorAbstract.d.ts +150 -0
  10. package/dist/classes/ref/DatetimeRef.d.ts +123 -0
  11. package/dist/classes/ref/EffectScopeGlobal.d.ts +22 -0
  12. package/dist/classes/ref/EventRef.d.ts +22 -0
  13. package/dist/classes/ref/GeoFlagRef.d.ts +51 -0
  14. package/dist/classes/ref/GeoIntlRef.d.ts +213 -0
  15. package/dist/classes/ref/GeoRef.d.ts +58 -0
  16. package/dist/classes/ref/ListDataRef.d.ts +359 -0
  17. package/dist/classes/ref/RouterItemRef.d.ts +61 -0
  18. package/dist/classes/ref/ScrollbarWidthRef.d.ts +22 -0
  19. package/dist/composables/ref/useApiAsyncRef.d.ts +18 -0
  20. package/dist/composables/ref/useApiDelete.d.ts +20 -0
  21. package/dist/composables/ref/useApiGet.d.ts +20 -0
  22. package/dist/composables/ref/useApiManagementAsyncRef.d.ts +49 -0
  23. package/dist/composables/ref/useApiManagementRef.d.ts +155 -0
  24. package/dist/composables/ref/useApiPost.d.ts +20 -0
  25. package/dist/composables/ref/useApiPut.d.ts +20 -0
  26. package/dist/composables/ref/useApiRef.d.ts +106 -0
  27. package/dist/composables/ref/useApiRequest.d.ts +28 -0
  28. package/dist/composables/ref/useBroadcastValueRef.d.ts +11 -0
  29. package/dist/composables/ref/useCookieRef.d.ts +11 -0
  30. package/dist/composables/ref/useFormattersRef.d.ts +21 -0
  31. package/dist/composables/ref/useGeoIntlRef.d.ts +7 -0
  32. package/dist/composables/ref/useHashRef.d.ts +9 -0
  33. package/dist/composables/ref/useLazyItemByMarginRef.d.ts +22 -0
  34. package/dist/composables/ref/useLazyRef.d.ts +42 -0
  35. package/dist/composables/ref/useLoadingRef.d.ts +7 -0
  36. package/dist/composables/ref/useMeta.d.ts +223 -0
  37. package/dist/composables/ref/useRouterList.d.ts +28 -0
  38. package/dist/composables/ref/useSearchRef.d.ts +36 -0
  39. package/dist/composables/ref/useSearchValueRef.d.ts +19 -0
  40. package/dist/composables/ref/useSessionRef.d.ts +9 -0
  41. package/dist/composables/ref/useStorageRef.d.ts +10 -0
  42. package/dist/composables/ref/useTranslateRef.d.ts +40 -0
  43. package/dist/flags.d.ts +1 -0
  44. package/dist/functions/basic.d.ts +1 -0
  45. package/dist/functions/computedAsync.d.ts +13 -0
  46. package/dist/functions/computedByLanguage.d.ts +15 -0
  47. package/dist/functions/computedEternity.d.ts +15 -0
  48. package/dist/functions/dxtFunctionalPlugin.d.ts +61 -0
  49. package/dist/functions/executeUse.d.ts +216 -0
  50. package/dist/functions/getInject.d.ts +7 -0
  51. package/dist/functions/getOptions.d.ts +10 -0
  52. package/dist/functions/ref/getBindRef.d.ts +13 -0
  53. package/dist/functions/ref/getRef.d.ts +8 -0
  54. package/dist/functions/ref/render.d.ts +13 -0
  55. package/dist/functions/ref/setRef.d.ts +9 -0
  56. package/dist/functions/ref/toRefItem.d.ts +9 -0
  57. package/dist/functions/render/getBind.d.ts +14 -0
  58. package/dist/functions/render/getClassName.d.ts +8 -0
  59. package/dist/functions/render/getIndexForRender.d.ts +10 -0
  60. package/dist/functions/toBind.d.ts +10 -0
  61. package/dist/functions/toBinds.d.ts +9 -0
  62. package/dist/library.d.ts +62 -2803
  63. package/dist/library.js +105 -71
  64. package/dist/types/apiTypes.d.ts +66 -0
  65. package/dist/types/constructorTypes.d.ts +126 -0
  66. package/dist/types/listTypes.d.ts +63 -0
  67. package/dist/types/refTypes.d.ts +36 -0
  68. package/dist/types/searchTypes.d.ts +6 -0
  69. package/package.json +7 -5
package/ai-types.txt CHANGED
@@ -17,45 +17,45 @@ The following is the content of "exports" from package.json:
17
17
 
18
18
  // File: library.d.ts
19
19
 
20
- /** Config for main GET request. */
20
+ /** GET request config for API management. */
21
21
  export declare type ApiManagementGet<Return extends ApiManagementValue, Type extends ApiManagementValue = Return> = {
22
22
  /** API endpoint path */
23
23
  path?: RefOrNormal<string | undefined>;
24
- /** Additional request options */
24
+ /** Request options */
25
25
  options?: ApiOptions;
26
26
  /** Enable reactive updates on path/options change */
27
27
  reactivity?: boolean;
28
- /** Request condition */
28
+ /** Condition to trigger request */
29
29
  conditions?: RefType<boolean>;
30
30
  /** Custom data transformation */
31
31
  transformation?: (data: Type, isResponseContractValid?: ApiDataValidation) => ApiData<Return>;
32
- /** Response contract validation */
32
+ /** Validate response contract */
33
33
  validateResponseContract?: (data: Type) => ApiDataValidation;
34
- /** Data validation function or class */
34
+ /** Validation function or class for data */
35
35
  typeData?: ((data: Return) => boolean) | any;
36
36
  /** Clear data on unmount */
37
37
  unmounted?: boolean;
38
- /** Loading skeleton data */
38
+ /** Skeleton data for loading state */
39
39
  skeleton?: () => Return;
40
40
  };
41
41
 
42
- /** Config for mutation requests (POST, PUT, DELETE). */
42
+ /** Mutation request config (POST, PUT, DELETE). */
43
43
  export declare type ApiManagementRequest<T, Return extends ApiData<T> = ApiData<T>> = {
44
44
  /** Target API endpoint path */
45
45
  path?: RefOrNormal<string | undefined>;
46
- /** Success callback */
46
+ /** Callback after success */
47
47
  action?: (data: Return | undefined) => Promise<void> | void;
48
- /** Pre-send transformation */
48
+ /** Transformation before sending */
49
49
  transformation?: (data: T) => Return;
50
50
  /** Wrap payload in 'data' property */
51
51
  toData?: boolean;
52
- /** Additional options */
52
+ /** Mutation request options */
53
53
  options?: ApiOptions;
54
54
  };
55
55
 
56
- /** Config for client-side search. */
56
+ /** Client-side search config for API data. */
57
57
  export declare type ApiManagementSearch<T extends SearchItem, K extends SearchColumns<T>> = {
58
- /** Columns to search through */
58
+ /** Columns to search */
59
59
  columns: K;
60
60
  /** Reactive search query */
61
61
  value?: Ref<string>;
@@ -66,84 +66,86 @@ export declare type ApiManagementSearch<T extends SearchItem, K extends SearchCo
66
66
  /** Base type for API values. */
67
67
  export declare type ApiManagementValue = ApiDefaultValue | ApiDefaultValue[];
68
68
 
69
- /** API request options. */
69
+ /** Options for api requests */
70
70
  export declare type ApiOptions = ApiMethodItem | RefOrNormal<ApiFetch>;
71
71
 
72
72
  declare type BroadcastValueItem<T> = T | string | undefined;
73
73
 
74
74
  /**
75
- * Creates computed property for async getters.
76
- * @param getter Sync/async function or value
77
- * @param ignore Values to exclude
78
- * @param debugOptions Vue debug options
75
+ * Computed property for asynchronous getters.
76
+ * @param getter Async/sync function or value
77
+ * @param initialState initial result
78
+ * @param ignore values to ignore
79
+ * @param debugOptions Vue debugger options
79
80
  */
80
- export declare function computedAsync<R>(getter: (() => Promise<R>) | (() => R) | R, ignore?: R, debugOptions?: DebuggerOptions): ComputedRef<R | undefined>;
81
+ export declare function computedAsync<R>(getter: (() => Promise<R>) | (() => R) | R, initialState?: (() => R) | R, ignore?: R, debugOptions?: DebuggerOptions): ComputedRef<R | undefined>;
81
82
 
82
83
  /**
83
- * Computed property dependent on current language.
84
- * @param getter Main language-dependent value
85
- * @param getterNone Fallback value
86
- * @param conditions Trigger conditions
87
- * @param debugOptions Vue debug options
84
+ * Computed property dependent on language and conditions.
85
+ * @param getter Main value getter
86
+ * @param getterNone Alternative value if conditions fail or getter is undefined
87
+ * @param conditions Trigger condition
88
+ * @param debugOptions Vue debugger options
88
89
  */
89
90
  export declare function computedByLanguage<T, R extends (T | undefined) = T | undefined>(getter: ComputedGetter<R>, getterNone?: R | (() => R), conditions?: () => boolean, debugOptions?: DebuggerOptions): ComputedRef<R>;
90
91
 
91
92
  /**
92
- * Cached on-demand computed property. Persists for app lifetime.
93
- * @param getter Function returning value or promise
93
+ * Computed property computed on demand and cached.
94
+ * @param getter Value getter
95
+ * @param initialState initial result
94
96
  */
95
- export declare function computedEternity<T>(getter: () => Promise<T> | T): Ref<T, T>;
97
+ export declare function computedEternity<T>(getter: () => Promise<T> | T, initialState?: (() => T) | T): Ref<T, T>;
96
98
 
97
- /** Constructor bind type with class/style support. */
99
+ /** Component binding with class/style support */
98
100
  export declare type ConstrBind<T> = T & Record<string, any> & {
99
101
  key?: string;
100
102
  class?: ConstrClass;
101
103
  style?: ConstrStyles;
102
104
  };
103
105
 
104
- /** Constructor class type. */
106
+ /** Constructor class type (string, array, or object) */
105
107
  export declare type ConstrClass = string | (string | ConstrClass | Undefined)[] | ConstrClassObject;
106
108
 
107
- /** Constructor classes with main and additional list. */
109
+ /** Required main class and additional class list */
108
110
  export declare type ConstrClasses = {
109
111
  main: ConstrClass;
110
112
  } & ConstrClassList;
111
113
 
112
- /** Class name mapping. */
114
+ /** Map class names to definitions */
113
115
  export declare type ConstrClassList = Record<string, ConstrClass>;
114
116
 
115
- /** CSS class object. */
117
+ /** Object for CSS classes with boolean values */
116
118
  export declare type ConstrClassObject = Record<string, boolean | undefined>;
117
119
 
118
- /** Constructor component record. */
120
+ /** Generic record for constructor components */
119
121
  export declare type ConstrComponent = Record<string, any>;
120
122
 
121
- /** Component modification type. */
123
+ /** Component modification with reactive or normal values */
122
124
  export declare type ConstrComponentMod<P extends ConstrItem> = ConstrItem | {
123
125
  [K in keyof P]?: RefOrNormal<P[K]>;
124
126
  };
125
127
 
126
- /** Constructor emit type. */
128
+ /** Constructor emit with event handler signatures */
127
129
  export declare type ConstrEmit<T extends ConstrItem = ConstrItem> = UnionToIntersection<ConstrEmitItem<{
128
130
  [K in keyof T]: (evt: K, ...args: T[K]) => void;
129
131
  }>>;
130
132
 
131
- /** Extract emit item. */
133
+ /** Extract emit type from constructor item */
132
134
  export declare type ConstrEmitItem<T extends ConstrItem> = T[keyof T];
133
135
 
134
136
  export declare type ConstrExpose<E extends Element, EXPOSE extends ConstrItem> = EXPOSE & {
135
137
  elementHtml?: ComputedRef<E | undefined>;
136
138
  };
137
139
 
138
- /** Link props. */
140
+ /** Props for link handling */
139
141
  export declare type ConstrHrefProps = {
140
142
  href?: string;
141
143
  };
142
144
 
143
- /** Generic constructor item. */
145
+ /** Generic record for constructor items */
144
146
  export declare type ConstrItem = Record<string, any>;
145
147
 
146
- /** Component configuration options. */
148
+ /** Constructor options for component config */
147
149
  export declare type ConstrOptions<COMP extends ConstrComponent, EMITS extends ConstrItem, P extends ConstrItem> = {
148
150
  components?: COMP;
149
151
  compMod?: ConstrComponentMod<P>;
@@ -152,10 +154,10 @@ export declare type ConstrOptions<COMP extends ConstrComponent, EMITS extends Co
152
154
  styles?: RefType<ConstrStyles>;
153
155
  };
154
156
 
155
- /** Prop item definition. */
157
+ /** Constructor prop item */
156
158
  export declare type ConstrPropItem<T = any> = ConstrPropItemOptions<T> | PropType<T>;
157
159
 
158
- /** Vue prop options. */
160
+ /** Vue prop definition options */
159
161
  export declare type ConstrPropItemOptions<T = any> = {
160
162
  type?: PropType<T>;
161
163
  required?: boolean;
@@ -163,18 +165,18 @@ export declare type ConstrPropItemOptions<T = any> = {
163
165
  validator?(value: any, props: any): boolean;
164
166
  };
165
167
 
166
- /** Component prop definitions. */
168
+ /** Component prop definitions */
167
169
  export declare type ConstrProps<P = Record<string, any>> = {
168
170
  [K in keyof P]: ConstrPropItem<P[K]>;
169
171
  };
170
172
 
171
- /** Registration config. */
173
+ /** Constructor registration config */
172
174
  export declare type ConstrRegistration = {
173
175
  flag?: boolean;
174
176
  translate?: Record<string, string>;
175
177
  };
176
178
 
177
- /** Setup interface for component init. */
179
+ /** Setup interface for component initialization */
178
180
  export declare type ConstrSetup<E extends Element, CLASSES extends ConstrClasses, SETUP extends ConstrItem> = {
179
181
  name: string;
180
182
  element: Ref<E | undefined>;
@@ -182,13 +184,13 @@ export declare type ConstrSetup<E extends Element, CLASSES extends ConstrClasses
182
184
  styles: RefType<ConstrStyles>;
183
185
  } & SETUP;
184
186
 
185
- /** Style definitions. */
187
+ /** Style definitions (object or array) */
186
188
  export declare type ConstrStyles = Record<string, ConstrStylesItem> | ConstrStyles[];
187
189
 
188
- /** Individual style property. */
190
+ /** Individual style property */
189
191
  export declare type ConstrStylesItem = string | null;
190
192
 
191
- /** Value wrapper. */
193
+ /** Value wrapper */
192
194
  export declare type ConstrValue<T = any> = {
193
195
  value?: T;
194
196
  };
@@ -196,9 +198,9 @@ export declare type ConstrValue<T = any> = {
196
198
  /** Class for date processing. */
197
199
  export declare class DatetimeRef {
198
200
  /**
199
- * @param date Date to process
200
- * @param type Format type
201
- * @param code Locale code
201
+ * @param date input date
202
+ * @param type output format
203
+ * @param code locale code
202
204
  */
203
205
  constructor(date: RefOrNormal<NumberOrStringOrDate>, type?: RefOrNormal<GeoDate>, code?: RefOrNormal<string>);
204
206
  getItem(): Ref<NumberOrStringOrDate>;
@@ -214,28 +216,35 @@ export declare class DatetimeRef {
214
216
  getSecond(): ComputedRef<number>;
215
217
  getMaxDay(): ComputedRef<number>;
216
218
  /**
217
- * Language-sensitive formatting.
218
- * @param type Output format
219
- * @param styleOptions Month representation/options
219
+ * @param type format type
220
+ * @param styleOptions representation style
220
221
  */
221
222
  locale(type?: GeoDate, styleOptions?: Intl.DateTimeFormatOptions['month'] | Intl.DateTimeFormatOptions): ComputedRef<string>;
222
223
  /**
223
- * Standard data output.
224
- * @param timeZone Include timezone
224
+ * @param timeZone include time zone
225
225
  */
226
226
  standard(timeZone?: boolean): ComputedRef<string>;
227
227
  }
228
228
 
229
- /** Base design class. */
229
+ /** Base class for constructor design logic. */
230
230
  export declare abstract class DesignAbstract<T extends Record<string, any>, C extends Record<string, any>> {
231
+ /**
232
+ * @param props base data
233
+ * @param callback value change callback
234
+ * @param changed tracking data
235
+ */
231
236
  constructor(props: T, callback?: ((event: C) => void) | undefined, changed?: string[]);
232
- /** Triggers update. */
237
+ /**
238
+ * @param compelled force update
239
+ */
233
240
  make(compelled?: boolean): this;
234
- /** Triggers callback. */
241
+ /**
242
+ * @param compelled force update
243
+ */
235
244
  makeCallback(compelled?: boolean): void;
236
245
  }
237
246
 
238
- /** Async base design class. */
247
+ /** Async version of DesignAbstract. */
239
248
  export declare abstract class DesignAsyncAbstract<T extends Record<string, any>, C extends Record<string, any>> extends DesignAbstract<T, C> {
240
249
  make(compelled?: boolean): this;
241
250
  makeCallback(compelled?: boolean): Promise<void>;
@@ -243,12 +252,13 @@ export declare abstract class DesignAsyncAbstract<T extends Record<string, any>,
243
252
 
244
253
  /** Tracks edited values. */
245
254
  export declare class DesignChanged<T extends Record<string, any>> {
255
+ /**
256
+ * @param props base data
257
+ * @param watch tracking keys
258
+ */
246
259
  constructor(props: T, watch?: string[]);
247
- /** Check if specific property updated. */
248
260
  is(name: string | string[]): boolean;
249
- /** Check for any changes. */
250
261
  isChanged(): boolean;
251
- /** Update tracked values. */
252
262
  update(): void;
253
263
  }
254
264
 
@@ -257,22 +267,20 @@ export declare class DesignComp<COMP extends ConstrComponent, P extends ConstrIt
257
267
 
258
268
  /** Manages connected components. */
259
269
  export declare class DesignComponents<COMP extends ConstrComponent, P extends ConstrItem> {
270
+ /**
271
+ * @param components list of components
272
+ * @param modification modification data
273
+ */
260
274
  constructor(components?: COMP, modification?: ConstrComponentMod<P> | undefined);
261
- /** Check component presence. */
262
275
  is<K extends keyof COMP>(name: K): name is K;
263
- /** Get component object. */
264
276
  get<K extends keyof COMP>(name: K): COMP[K];
265
- /** Get modified props for child component. */
266
277
  getModification<K extends keyof P>(index?: K & string | string, props?: P[K] | Record<string, any>): Record<string, any> | undefined;
267
- /** Render component in array. */
268
278
  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[];
269
- /** Render single component. */
270
279
  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;
271
- /** Add rendered component to array. */
272
280
  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;
273
281
  }
274
282
 
275
- /** Main constructor for functional components. */
283
+ /** Base class for functional component constructors. */
276
284
  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> {
277
285
  protected constructor(name: string, props: Readonly<P>, options?: ConstrOptions<COMP, EMITS, P> | undefined);
278
286
  getName(): string;
@@ -285,46 +293,51 @@ export declare abstract class DesignConstructorAbstract<E extends Element, COMP
285
293
  render(): () => VNode | (VNode | any)[] | undefined;
286
294
  }
287
295
 
288
- /**
289
- * Vue plugin for global services.
290
- * @example
291
- * ```typescript
292
- * app.use(dxtFunctionalPlugin, { api: { url: '...' }, router })
293
- * ```
294
- */
296
+ /** Vue plugin for functional services. */
295
297
  export declare const dxtFunctionalPlugin: Plugin_2;
296
298
 
297
- /** Global effect scope utility. */
299
+ /** Global effect scope. */
298
300
  export declare class EffectScopeGlobal {
299
301
  static run<T>(fn: () => T): T | undefined;
300
302
  }
301
303
 
302
- /** Event handler with reactive element. */
304
+ /** Event management with Ref. */
303
305
  export declare class EventRef<E extends ElementOrWindow, O extends Event, D extends Record<string, any> = Record<string, any>> extends EventItem<E, O, D> {
304
306
  constructor(elementSelector?: RefOrNormal<ElementOrString<E> | undefined>, elementSelectorControl?: RefOrNormal<ElementOrString<HTMLElement>>, type?: string | string[], listener?: EventListenerDetail<O, D>, options?: EventOptions, detail?: D);
305
307
  }
306
308
 
307
309
  /**
308
- * Managed singleton for state/API.
309
- * @remarks Use for API clients, shared state, or SDKs.
310
+ * Creates managed singleton with application, provide, or local strategy.
311
+ * @param callback init function
312
+ * @param type strategy (global, provide, local)
313
+ * @remarks Use for API services, state, or external SDKs.
310
314
  * @example
311
315
  * export const useUserApi = executeUseGlobal(() => useApiGet('/api/user'));
312
316
  */
313
317
  export declare function executeUse<R, O extends any[], RI extends ExecuteUseReturn<R> = ExecuteUseReturn<R>>(callback: (...args: O) => R, type?: ExecuteUseType): ((...args: O) => RI) | (() => RI);
314
318
 
315
- /** Creates global singleton. */
316
- export declare function executeUseGlobal<R>(callback: () => R): (() => ExecuteUseReturn<R>);
319
+ /** Global singleton helper. */
320
+ export declare function executeUseGlobal<R>(callback: () => R): (() => Readonly<R & {
321
+ init(): Readonly<R>;
322
+ destroyExecute?(): void;
323
+ }>);
317
324
 
318
- /** Inits global callbacks. */
325
+ /** Init global callbacks. */
319
326
  export declare function executeUseGlobalInit(): void;
320
327
 
321
- /** Creates local singleton in closure. */
322
- export declare function executeUseLocal<R, O extends any[]>(callback: (...args: O) => R): ((...args: O) => ExecuteUseReturn<R>);
328
+ /** Local singleton helper. */
329
+ export declare function executeUseLocal<R, O extends any[]>(callback: (...args: O) => R): ((...args: O) => Readonly<R & {
330
+ init(): Readonly<R>;
331
+ destroyExecute?(): void;
332
+ }>);
323
333
 
324
- /** Creates provide/inject singleton. */
325
- export declare function executeUseProvide<R, O extends any[]>(callback: (...args: O) => R): ((...args: O) => ExecuteUseReturn<R>);
334
+ /** Component-scoped singleton helper. */
335
+ export declare function executeUseProvide<R, O extends any[]>(callback: (...args: O) => R): ((...args: O) => Readonly<R & {
336
+ init(): Readonly<R>;
337
+ destroyExecute?(): void;
338
+ }>);
326
339
 
327
- /** Factory return object. */
340
+ /** Singleton return type. */
328
341
  export declare type ExecuteUseReturn<R> = Readonly<R & {
329
342
  init(): Readonly<R>;
330
343
  destroyExecute?(): void;
@@ -337,7 +350,7 @@ export declare enum ExecuteUseType {
337
350
  local = "local"
338
351
  }
339
352
 
340
- /** Plugin options interface. */
353
+ /** Functional plugin configuration. */
341
354
  export declare interface FunctionalPluginOptions {
342
355
  api?: ApiConfig;
343
356
  translate?: TranslateConfig;
@@ -347,7 +360,7 @@ export declare interface FunctionalPluginOptions {
347
360
  errorCauses?: ErrorCenterCauseList;
348
361
  }
349
362
 
350
- /** Country/flag utility. */
363
+ /** Management class for Flags. */
351
364
  export declare class GeoFlagRef {
352
365
  constructor(code?: RefOrNormal<string>);
353
366
  getCode(): Ref<string>;
@@ -357,7 +370,7 @@ export declare class GeoFlagRef {
357
370
  getNational(codes?: string[]): ComputedRef<GeoFlagNational[]>;
358
371
  }
359
372
 
360
- /** Reactive numbers/dates formatting. */
373
+ /** Reactive formatting for numbers and dates. */
361
374
  export declare class GeoIntlRef {
362
375
  constructor(code?: RefOrNormal<string>);
363
376
  display(value?: RefOrNormal<string>, typeOptions?: Intl.DisplayNamesOptions['type'] | Intl.DisplayNamesOptions): ComputedRef<string>;
@@ -384,7 +397,7 @@ export declare class GeoIntlRef {
384
397
  sort<T>(data: RefOrNormal<T[]>, compareFn?: (a: T, b: T) => [string, string]): ComputedRef<T[]>;
385
398
  }
386
399
 
387
- /** Global geographic data management. */
400
+ /** Reactive geographic data access. */
388
401
  export declare class GeoRef {
389
402
  static get(): Ref<GeoItemFull>;
390
403
  static getCountry(): ComputedRef<string>;
@@ -394,22 +407,25 @@ export declare class GeoRef {
394
407
  static set(code: string): void;
395
408
  }
396
409
 
397
- /** Generate subcomponent properties. */
410
+ /** Generates properties for subcomponents. */
398
411
  export declare function getBind<T, R extends ItemList>(value: T | R | undefined | null, nameExtra?: ItemList | string, name?: string, except?: boolean): ConstrBind<R>;
399
412
 
400
- /** Reactive subcomponent properties. */
413
+ /** Generates reactive properties for subcomponents. */
401
414
  export declare function getBindRef<T, R extends ItemList>(value: RefOrNormal<T | R> | undefined, nameExtra?: RefOrNormal<ItemList> | string, name?: string): ComputedRef<R>;
402
415
 
403
416
  /** Get class name from props. */
404
417
  export declare function getClassName<T extends ItemList>(props?: T): string | undefined;
405
418
 
406
- /** Get/gen render index. */
419
+ /** Generate render key. */
407
420
  export declare function getIndexForRender<T extends ItemList>(name: string | any, props?: T, index?: string): string | undefined;
408
421
 
409
- /** Get API options. */
422
+ /** Get injected value. */
423
+ export declare function getInject<T>(name: string): T | undefined;
424
+
425
+ /** Get request options. */
410
426
  export declare const getOptions: (options?: ApiOptions) => RefOrNormal<ApiFetch>;
411
427
 
412
- /** Unwrap ref value. */
428
+ /** Unwrap Ref or return value. */
413
429
  export declare function getRef<T>(item: RefOrNormal<T>): T;
414
430
 
415
431
  export declare type LazyItem = {
@@ -426,7 +442,7 @@ export declare type LazyItemByMargin = {
426
442
 
427
443
  export declare type LazyList = Record<string, LazyItem>;
428
444
 
429
- /** Basic list item structure. */
445
+ /** List item structure. */
430
446
  export declare type ListDataBasic = {
431
447
  label?: NumberOrString;
432
448
  value?: any;
@@ -444,14 +460,14 @@ export declare type ListDataFullItem<Item extends ListDataBasic = ListDataBasic>
444
460
  disabled?: boolean;
445
461
  };
446
462
 
447
- /** Identified list item. */
463
+ /** List item with type and index. */
448
464
  export declare type ListDataItem<Item extends ListDataBasic = ListDataBasic> = ConstrBind<Item & {
449
465
  parent?: string;
450
466
  type: ListType;
451
467
  index: string;
452
468
  }>;
453
469
 
454
- /** List data management class. */
470
+ /** Manages data list state and selection. */
455
471
  export declare class ListDataRef {
456
472
  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);
457
473
  readonly data: ComputedRef<ListList>;
@@ -488,7 +504,10 @@ export declare class ListDataRef {
488
504
  getIndexByStep(index: string, step: number): ListDataItem | undefined;
489
505
  getIndexNext(index: string): ListDataItem | undefined;
490
506
  getIndexPrev(index: string): ListDataItem | undefined;
491
- getItemByIndex(index?: string): { key: number; item: ListDataItem; } | undefined;
507
+ getItemByIndex(index?: string): {
508
+ key: number;
509
+ item: ListDataItem;
510
+ } | undefined;
492
511
  getItemByKey(key: number): ListDataItem | undefined;
493
512
  getFirstItemByParent(parent: string | undefined): ListDataItem | undefined;
494
513
  getLastItemByParent(parent: string | undefined): ListDataItem | undefined;
@@ -496,26 +515,40 @@ export declare class ListDataRef {
496
515
  }
497
516
 
498
517
  export declare type ListList<Item extends ListDataBasic = ListDataBasic> = ListDataItem<Item>[];
518
+
499
519
  export declare type ListListInput<Item extends ListDataBasic = ListDataBasic> = ListListInputItem<Item>[] | string[] | Record<string, ListListInputItem<Item>> | Record<string, string>;
520
+
500
521
  export declare type ListListInputItem<Item extends ListDataBasic = ListDataBasic> = ConstrBind<Item>;
522
+
501
523
  export declare type ListName = string | number | undefined;
524
+
502
525
  export declare type ListNames = ListName[];
526
+
503
527
  export declare type ListRecord<Item extends ListDataBasic = ListDataBasic> = ListList<Item> | Record<string, any>;
528
+
504
529
  export declare type ListSelectedItem = NumberOrStringOrBoolean;
530
+
505
531
  export declare type ListSelectedList = ListSelectedItem | ListSelectedItem[];
532
+
506
533
  export declare type ListType = 'item' | 'space' | 'line' | 'subtitle' | 'html' | 'menu' | 'menu-group' | 'group';
507
534
 
508
535
  export declare type RawChildren = string | number | boolean | VNode | VNodeArrayChildren | (() => any);
509
- export declare type RawSlots = { [name: string]: unknown; $stable?: boolean; };
536
+
537
+ export declare type RawSlots = {
538
+ [name: string]: unknown;
539
+ $stable?: boolean;
540
+ };
510
541
 
511
542
  export declare type RefOrNormal<T> = RefType<T> | T;
543
+
512
544
  export declare type RefType<T> = ComputedRef<T> | Ref<T>;
545
+
513
546
  export declare type RefUndefined<T> = RefType<T | undefined>;
514
547
 
515
- /** Render cached/immutable data. */
548
+ /** Rendering helper. */
516
549
  export declare function render<T extends ItemList>(name: string | any, props?: T, children?: RawChildren | RawSlots, index?: string): VNode;
517
550
 
518
- /** Router utilities. */
551
+ /** Router navigation management. */
519
552
  export declare class RouterItemRef {
520
553
  static get(): Router;
521
554
  static getLink(name: string, params?: any, query?: any): string | undefined;
@@ -526,7 +559,7 @@ export declare class RouterItemRef {
526
559
  static rawToHref(to?: string | RouteLocationRaw): ConstrHrefProps;
527
560
  }
528
561
 
529
- /** Scrollbar width detector. */
562
+ /** Reactive scrollbar width. */
530
563
  export declare class ScrollbarWidthRef {
531
564
  readonly item: Ref<boolean | undefined, boolean | undefined>;
532
565
  readonly width: Ref<number, number>;
@@ -535,43 +568,49 @@ export declare class ScrollbarWidthRef {
535
568
  }
536
569
 
537
570
  export declare type SearchListInput<T extends SearchItem> = SearchListValueRef<T> | (() => SearchListValueRef<T>);
571
+
538
572
  export declare type SearchListValueRef<T extends SearchItem> = RefOrNormal<SearchListValue<T>>;
539
573
 
540
- /** Global API conditions. */
574
+ /** Global API conditions setter. */
541
575
  export declare const setApiRefGlobalConditions: (conditions: RefType<any>) => void;
542
576
 
543
- /** Update reactive ref. */
577
+ /** Update Ref value. */
544
578
  export declare function setRef<T>(item: Ref<T>, value: T): void;
545
579
 
546
- /** Shorthand for translation. */
580
+ /** Shorthand for useTranslateRef. */
547
581
  export declare const t: <T extends string[]>(names: T) => ShallowRef<TranslateList<T>>;
548
582
 
549
- /** Merge objects with class/style awareness. */
583
+ /** Merge objects with class/style merging. */
550
584
  export declare function toBind<R extends ItemList = ItemList>(extra: ItemList, value: ItemList): ConstrBind<R>;
585
+
586
+ /** Merge multiple objects with class/style merging. */
551
587
  export declare function toBinds<R extends ItemList = ItemList>(...values: (ItemList | undefined)[]): ConstrBind<R>;
552
588
 
553
- /** Ensure value is Ref. */
589
+ /** Wrap value in Ref. */
554
590
  export declare function toRefItem<T>(item: RefOrNormal<T>): Ref<T>;
555
591
 
556
592
  export declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
557
593
 
558
- /** API DELETE request. */
594
+ /** Execute async API request immediately. */
595
+ 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>;
596
+
597
+ /** API delete request. */
559
598
  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): {
560
599
  loading: Ref<boolean, boolean>;
561
600
  send(request?: Request | undefined): Promise<Return | undefined>;
562
601
  };
563
602
 
564
- /** API GET request. */
603
+ /** API get request. */
565
604
  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): {
566
605
  loading: Ref<boolean, boolean>;
567
606
  send(request?: Request | undefined): Promise<Return | undefined>;
568
607
  };
569
608
 
570
609
  /**
571
- * Advanced API orchestration (GET, List, Search, Mutations).
572
- * @note Best used with `executeUse`.
610
+ * Orchestrates API loading, search, formatting, and mutations.
611
+ * @remarks Recommended with `executeUse` for centralized state.
573
612
  * @example
574
- * const products = useApiManagementRef({ path: '/api/v1/products' }, { price: (v) => `${v}$` });
613
+ * const products = useApiManagementRef({ path: '/api/v1/products' }, { price: (v) => `${v} USD` });
575
614
  */
576
615
  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): {
577
616
  isValid: ComputedRef<boolean>;
@@ -595,19 +634,19 @@ export declare function useApiManagementRef<Return extends ApiManagementValue, F
595
634
  sendDelete: (request?: ApiFetch["request"]) => Promise<ApiData<Delete> | undefined>;
596
635
  };
597
636
 
598
- /** API POST request. */
637
+ /** API post request. */
599
638
  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): {
600
639
  loading: Ref<boolean, boolean>;
601
640
  send(request?: Request | undefined): Promise<Return | undefined>;
602
641
  };
603
642
 
604
- /** API PUT request. */
643
+ /** API put request. */
605
644
  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): {
606
645
  loading: Ref<boolean, boolean>;
607
646
  send(request?: Request | undefined): Promise<Return | undefined>;
608
647
  };
609
648
 
610
- /** useApiRef return interface. */
649
+ /** API Ref return interface. */
611
650
  export declare interface UseApiRef<R> {
612
651
  data: ComputedRef<ApiData<R> | undefined>;
613
652
  item: Ref<ApiData<R> | undefined>;
@@ -622,32 +661,34 @@ export declare interface UseApiRef<R> {
622
661
  isReading(): boolean;
623
662
  getItem(): ApiData<R> | undefined;
624
663
  init(): void;
664
+ initSsr(): void;
625
665
  reset(): Promise<void>;
626
666
  stop(): void;
627
667
  abort(): void;
628
668
  }
629
669
 
630
- /** Reactive request handling. */
670
+ /** Reactive API request management. */
631
671
  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>;
632
672
 
633
- /** Basic API request composable. */
673
+ /** General API request. */
634
674
  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): {
635
675
  loading: Ref<boolean, boolean>;
636
676
  send(request?: Request): Promise<Return | undefined>;
637
677
  };
638
678
 
639
- /** Sync data between tabs. */
679
+ /** Multi-tab reactive variable. */
640
680
  export declare function useBroadcastValueRef<T>(name: string, defaultValue?: T | string | (() => (T | string))): Ref<BroadcastValueItem<T>>;
641
681
 
642
- /** Manage cookies reactively. */
682
+ /** Reactive cookie management. */
643
683
  export declare function useCookieRef<T>(name: string, defaultValue?: T | string | (() => (T | string)), options?: CookieOptions): Ref<T | string | undefined>;
644
684
 
645
- /** Reactive list formatting. */
685
+ /** Reactive formatting for lists. */
646
686
  export declare function useFormattersRef<Options extends FormattersOptionsList = FormattersOptionsList, List extends FormattersListProp = FormattersListProp>(list: RefType<List | undefined>, options: Options): {
647
687
  listFormat: ComputedRef<FormattersReturn<List, Options>>;
648
688
  length: ComputedRef<number>;
649
689
  };
650
690
 
691
+ /** Access formatting logic. */
651
692
  export declare function useGeoIntlRef(): GeoIntlRef;
652
693
 
653
694
  /** Reactive hash management. */
@@ -659,7 +700,7 @@ export declare const useLazyItemByMarginRef: (element: RefType<HTMLElement | und
659
700
  readonly lazyItem: any;
660
701
  };
661
702
 
662
- /** Element visibility tracking. */
703
+ /** Track elements appearance via IntersectionObserver. */
663
704
  export declare const useLazyRef: (options?: IntersectionObserverInit) => {
664
705
  intersectionObserver: IntersectionObserver | undefined;
665
706
  getItem(element: HTMLElement): LazyItem;
@@ -668,11 +709,12 @@ export declare const useLazyRef: (options?: IntersectionObserverInit) => {
668
709
  disconnectLazy: () => void | undefined;
669
710
  };
670
711
 
712
+ /** Get loading status. */
671
713
  export declare function useLoadingRef(): ShallowRef<boolean, boolean>;
672
714
 
673
- /** Global meta tag management. */
715
+ /** Reactive meta tags management. */
674
716
  export declare const useMeta: () => Readonly<{
675
- meta: Meta;
717
+ meta: typeof MetaStatic;
676
718
  title: Ref<string, string>;
677
719
  keyword: Ref<string, string>;
678
720
  description: Ref<string, string>;
@@ -682,10 +724,10 @@ export declare const useMeta: () => Readonly<{
682
724
  robots: Ref<MetaRobots, MetaRobots>;
683
725
  siteName: Ref<string, string>;
684
726
  getHtmlMeta: () => string;
685
- setSuffix: (suffix: string) => void;
727
+ setSuffix: (suffix: string) => typeof MetaStatic;
686
728
  } & {
687
729
  init(): Readonly<{
688
- meta: Meta;
730
+ meta: typeof MetaStatic;
689
731
  title: Ref<string, string>;
690
732
  keyword: Ref<string, string>;
691
733
  description: Ref<string, string>;
@@ -695,12 +737,12 @@ export declare const useMeta: () => Readonly<{
695
737
  robots: Ref<MetaRobots, MetaRobots>;
696
738
  siteName: Ref<string, string>;
697
739
  getHtmlMeta: () => string;
698
- setSuffix: (suffix: string) => void;
740
+ setSuffix: (suffix: string) => typeof MetaStatic;
699
741
  }>;
700
742
  destroyExecute?(): void;
701
743
  }>;
702
744
 
703
- /** Router-linked list. */
745
+ /** Router link list management. */
704
746
  export declare const useRouterList: <T extends ListDataBasic>(list: RefType<ConstrBind<T>[] | undefined>, selected?: Ref<string> | string, hasTo?: boolean) => {
705
747
  item: ComputedRef<T | undefined>;
706
748
  selected: Ref<string, string>;
@@ -710,7 +752,7 @@ export declare const useRouterList: <T extends ListDataBasic>(list: RefType<Cons
710
752
  toMain(): void;
711
753
  };
712
754
 
713
- /** Reactive search logic. */
755
+ /** Search logic for reactive data. */
714
756
  export declare function useSearchRef<T extends SearchItem, K extends SearchColumns<T>>(list: SearchListInput<T>, columns: K, value?: Ref<string>, options?: SearchOptions): {
715
757
  isSearch: ComputedRef<boolean>;
716
758
  search: Ref<string, string>;
@@ -719,7 +761,7 @@ export declare function useSearchRef<T extends SearchItem, K extends SearchColum
719
761
  length: ComputedRef<number>;
720
762
  };
721
763
 
722
- /** Search state with debounce. */
764
+ /** Search state with debounce/delay. */
723
765
  export declare function useSearchValueRef<T extends SearchItem, K extends SearchColumns<T>>(item: SearchList<T, K>, value?: Ref<string>): {
724
766
  search: Ref<string, string>;
725
767
  searchDelay: Ref<string, string>;
@@ -733,14 +775,10 @@ export declare function useSessionRef<T>(name: string, defaultValue?: T | (() =>
733
775
  export declare function useStorageRef<T>(name: string, defaultValue?: T | (() => T), cache?: number): Ref<T | undefined>;
734
776
 
735
777
  /**
736
- * Reactive translation retrieval.
737
- * @example
738
- * const tr = useTranslateRef(['home.title'] as const);
778
+ * Returns reactive translation list.
779
+ * @example const translations = useTranslateRef(['home.title'] as const);
739
780
  */
740
781
  export declare function useTranslateRef<T extends (string | string[])[]>(names: T, translateInstance?: TranslateInstance): ShallowRef<TranslateList<T>>;
741
782
 
742
783
  export * from "@dxtmisha/functional-basic";
743
-
744
- export { }
745
-
746
- go!
784
+ export { }