@zenstackhq/tanstack-query 2.21.0 → 3.0.0-beta.16

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 (94) hide show
  1. package/.turbo/turbo-build.log +32 -0
  2. package/.turbo/turbo-lint.log +5 -0
  3. package/LICENSE +1 -1
  4. package/dist/react.cjs +1238 -0
  5. package/dist/react.cjs.map +1 -0
  6. package/dist/react.d.cts +696 -0
  7. package/dist/react.d.ts +696 -0
  8. package/dist/react.js +1195 -0
  9. package/dist/react.js.map +1 -0
  10. package/eslint.config.js +4 -0
  11. package/package.json +56 -109
  12. package/scripts/generate.ts +27 -0
  13. package/src/react.ts +531 -0
  14. package/src/utils/common.ts +457 -0
  15. package/src/utils/mutator.ts +441 -0
  16. package/src/utils/nested-read-visitor.ts +61 -0
  17. package/src/utils/nested-write-visitor.ts +359 -0
  18. package/src/utils/query-analysis.ts +116 -0
  19. package/src/utils/serialization.ts +39 -0
  20. package/src/utils/types.ts +19 -0
  21. package/test/react-query.test.tsx +1787 -0
  22. package/test/schemas/basic/input.ts +70 -0
  23. package/test/schemas/basic/models.ts +12 -0
  24. package/test/schemas/basic/schema-lite.ts +124 -0
  25. package/test/schemas/basic/schema.zmodel +25 -0
  26. package/tsconfig.json +7 -0
  27. package/tsconfig.test.json +8 -0
  28. package/tsup.config.ts +13 -0
  29. package/vitest.config.ts +11 -0
  30. package/README.md +0 -5
  31. package/generator.d.ts +0 -6
  32. package/generator.js +0 -578
  33. package/generator.js.map +0 -1
  34. package/index.d.ts +0 -4
  35. package/index.js +0 -22
  36. package/index.js.map +0 -1
  37. package/runtime/common-CXlL7vTW.d.mts +0 -121
  38. package/runtime/common-CXlL7vTW.d.ts +0 -121
  39. package/runtime/index.d.mts +0 -20
  40. package/runtime/index.d.ts +0 -20
  41. package/runtime/index.js +0 -44
  42. package/runtime/index.js.map +0 -1
  43. package/runtime/index.mjs +0 -21
  44. package/runtime/index.mjs.map +0 -1
  45. package/runtime/react.d.mts +0 -322
  46. package/runtime/react.d.ts +0 -322
  47. package/runtime/react.js +0 -408
  48. package/runtime/react.js.map +0 -1
  49. package/runtime/react.mjs +0 -380
  50. package/runtime/react.mjs.map +0 -1
  51. package/runtime/svelte.d.mts +0 -322
  52. package/runtime/svelte.d.ts +0 -322
  53. package/runtime/svelte.js +0 -407
  54. package/runtime/svelte.js.map +0 -1
  55. package/runtime/svelte.mjs +0 -379
  56. package/runtime/svelte.mjs.map +0 -1
  57. package/runtime/vue.d.mts +0 -330
  58. package/runtime/vue.d.ts +0 -330
  59. package/runtime/vue.js +0 -418
  60. package/runtime/vue.js.map +0 -1
  61. package/runtime/vue.mjs +0 -390
  62. package/runtime/vue.mjs.map +0 -1
  63. package/runtime-v5/angular.d.mts +0 -59
  64. package/runtime-v5/angular.d.ts +0 -59
  65. package/runtime-v5/angular.js +0 -425
  66. package/runtime-v5/angular.js.map +0 -1
  67. package/runtime-v5/angular.mjs +0 -397
  68. package/runtime-v5/angular.mjs.map +0 -1
  69. package/runtime-v5/common-CXlL7vTW.d.mts +0 -121
  70. package/runtime-v5/common-CXlL7vTW.d.ts +0 -121
  71. package/runtime-v5/index.d.mts +0 -20
  72. package/runtime-v5/index.d.ts +0 -20
  73. package/runtime-v5/index.js +0 -44
  74. package/runtime-v5/index.js.map +0 -1
  75. package/runtime-v5/index.mjs +0 -21
  76. package/runtime-v5/index.mjs.map +0 -1
  77. package/runtime-v5/react.d.mts +0 -474
  78. package/runtime-v5/react.d.ts +0 -474
  79. package/runtime-v5/react.js +0 -440
  80. package/runtime-v5/react.js.map +0 -1
  81. package/runtime-v5/react.mjs +0 -412
  82. package/runtime-v5/react.mjs.map +0 -1
  83. package/runtime-v5/svelte.d.mts +0 -386
  84. package/runtime-v5/svelte.d.ts +0 -386
  85. package/runtime-v5/svelte.js +0 -436
  86. package/runtime-v5/svelte.js.map +0 -1
  87. package/runtime-v5/svelte.mjs +0 -408
  88. package/runtime-v5/svelte.mjs.map +0 -1
  89. package/runtime-v5/vue.d.mts +0 -330
  90. package/runtime-v5/vue.d.ts +0 -330
  91. package/runtime-v5/vue.js +0 -420
  92. package/runtime-v5/vue.js.map +0 -1
  93. package/runtime-v5/vue.mjs +0 -392
  94. package/runtime-v5/vue.mjs.map +0 -1
package/runtime/vue.d.mts DELETED
@@ -1,330 +0,0 @@
1
- import * as _tanstack_vue_query from '@tanstack/vue-query';
2
- import { UseQueryOptions, UseInfiniteQueryOptions, InfiniteData, UseMutationOptions } from '@tanstack/vue-query';
3
- import * as _vue_shared from '@vue/shared';
4
- import * as vue from 'vue';
5
- import { MaybeRefOrGetter, ComputedRef } from 'vue';
6
- import { ModelMeta } from '@zenstackhq/runtime/cross';
7
- import { A as APIContext, F as FetchFn, a as ExtraQueryOptions, E as ExtraMutationOptions } from './common-CXlL7vTW.mjs';
8
-
9
- declare const VueQueryContextKey = "zenstack-vue-query-context";
10
- /**
11
- * Provide context for the generated TanStack Query hooks.
12
- */
13
- declare function provideHooksContext(context: APIContext): void;
14
- /**
15
- * Hooks context.
16
- */
17
- declare function getHooksContext(): {
18
- fetch?: FetchFn;
19
- logging?: boolean;
20
- endpoint: string;
21
- };
22
- /**
23
- * Creates a vue-query query.
24
- *
25
- * @param model The name of the model under query.
26
- * @param url The request URL.
27
- * @param args The request args object, URL-encoded and appended as "?q=" parameter
28
- * @param options The vue-query options object
29
- * @param fetch The fetch function to use for sending the HTTP request
30
- * @returns useQuery hook
31
- */
32
- declare function useModelQuery<TQueryFnData, TData, TError>(model: string, url: string, args?: MaybeRefOrGetter<unknown> | ComputedRef<unknown>, options?: MaybeRefOrGetter<Omit<UseQueryOptions<TQueryFnData, TError, TData>, 'queryKey'> & ExtraQueryOptions> | ComputedRef<Omit<UseQueryOptions<TQueryFnData, TError, TData>, 'queryKey'> & ExtraQueryOptions>, fetch?: FetchFn): {
33
- data: _vue_shared.IfAny<TData, vue.Ref<TData>, [TData] extends [vue.Ref<any>] ? TData : vue.Ref<TData>>;
34
- error: _vue_shared.IfAny<TError, vue.Ref<TError>, [TError] extends [vue.Ref<any>] ? TError : vue.Ref<TError>>;
35
- isError: vue.Ref<true>;
36
- isLoading: vue.Ref<false>;
37
- isLoadingError: vue.Ref<false>;
38
- isRefetchError: vue.Ref<true>;
39
- isSuccess: vue.Ref<false>;
40
- status: vue.Ref<"error">;
41
- dataUpdatedAt: vue.Ref<number>;
42
- errorUpdatedAt: vue.Ref<number>;
43
- failureCount: vue.Ref<number>;
44
- failureReason: _vue_shared.IfAny<TError | null, vue.Ref<TError | null>, [TError | null] extends [vue.Ref<any>] ? vue.Ref<any> & TError : vue.Ref<TError | null>>;
45
- errorUpdateCount: vue.Ref<number>;
46
- isFetched: vue.Ref<boolean>;
47
- isFetchedAfterMount: vue.Ref<boolean>;
48
- isFetching: vue.Ref<boolean>;
49
- isInitialLoading: vue.Ref<boolean>;
50
- isPaused: vue.Ref<boolean>;
51
- isPlaceholderData: vue.Ref<boolean>;
52
- isPreviousData: vue.Ref<boolean>;
53
- isRefetching: vue.Ref<boolean>;
54
- isStale: vue.Ref<boolean>;
55
- refetch: <TPageData>(options?: (_tanstack_vue_query.RefetchOptions & _tanstack_vue_query.RefetchQueryFilters<TPageData>) | undefined) => Promise<_tanstack_vue_query.QueryObserverResult<TData, TError>>;
56
- remove: () => void;
57
- fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus>;
58
- suspense: () => Promise<_tanstack_vue_query.QueryObserverResult<TData, TError>>;
59
- queryKey: [string, string, string, unknown, {
60
- infinite: boolean;
61
- optimisticUpdate: boolean;
62
- }];
63
- } | {
64
- data: _vue_shared.IfAny<TData, vue.Ref<TData>, [TData] extends [vue.Ref<any>] ? TData : vue.Ref<TData>>;
65
- error: vue.Ref<null>;
66
- isError: vue.Ref<false>;
67
- isLoading: vue.Ref<false>;
68
- isLoadingError: vue.Ref<false>;
69
- isRefetchError: vue.Ref<false>;
70
- isSuccess: vue.Ref<true>;
71
- status: vue.Ref<"success">;
72
- dataUpdatedAt: vue.Ref<number>;
73
- errorUpdatedAt: vue.Ref<number>;
74
- failureCount: vue.Ref<number>;
75
- failureReason: _vue_shared.IfAny<TError | null, vue.Ref<TError | null>, [TError | null] extends [vue.Ref<any>] ? vue.Ref<any> & TError : vue.Ref<TError | null>>;
76
- errorUpdateCount: vue.Ref<number>;
77
- isFetched: vue.Ref<boolean>;
78
- isFetchedAfterMount: vue.Ref<boolean>;
79
- isFetching: vue.Ref<boolean>;
80
- isInitialLoading: vue.Ref<boolean>;
81
- isPaused: vue.Ref<boolean>;
82
- isPlaceholderData: vue.Ref<boolean>;
83
- isPreviousData: vue.Ref<boolean>;
84
- isRefetching: vue.Ref<boolean>;
85
- isStale: vue.Ref<boolean>;
86
- refetch: <TPageData>(options?: (_tanstack_vue_query.RefetchOptions & _tanstack_vue_query.RefetchQueryFilters<TPageData>) | undefined) => Promise<_tanstack_vue_query.QueryObserverResult<TData, TError>>;
87
- remove: () => void;
88
- fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus>;
89
- suspense: () => Promise<_tanstack_vue_query.QueryObserverResult<TData, TError>>;
90
- queryKey: [string, string, string, unknown, {
91
- infinite: boolean;
92
- optimisticUpdate: boolean;
93
- }];
94
- } | {
95
- data: vue.Ref<undefined>;
96
- error: _vue_shared.IfAny<TError, vue.Ref<TError>, [TError] extends [vue.Ref<any>] ? TError : vue.Ref<TError>>;
97
- isError: vue.Ref<true>;
98
- isLoading: vue.Ref<false>;
99
- isLoadingError: vue.Ref<true>;
100
- isRefetchError: vue.Ref<false>;
101
- isSuccess: vue.Ref<false>;
102
- status: vue.Ref<"error">;
103
- dataUpdatedAt: vue.Ref<number>;
104
- errorUpdatedAt: vue.Ref<number>;
105
- failureCount: vue.Ref<number>;
106
- failureReason: _vue_shared.IfAny<TError | null, vue.Ref<TError | null>, [TError | null] extends [vue.Ref<any>] ? vue.Ref<any> & TError : vue.Ref<TError | null>>;
107
- errorUpdateCount: vue.Ref<number>;
108
- isFetched: vue.Ref<boolean>;
109
- isFetchedAfterMount: vue.Ref<boolean>;
110
- isFetching: vue.Ref<boolean>;
111
- isInitialLoading: vue.Ref<boolean>;
112
- isPaused: vue.Ref<boolean>;
113
- isPlaceholderData: vue.Ref<boolean>;
114
- isPreviousData: vue.Ref<boolean>;
115
- isRefetching: vue.Ref<boolean>;
116
- isStale: vue.Ref<boolean>;
117
- refetch: <TPageData>(options?: (_tanstack_vue_query.RefetchOptions & _tanstack_vue_query.RefetchQueryFilters<TPageData>) | undefined) => Promise<_tanstack_vue_query.QueryObserverResult<TData, TError>>;
118
- remove: () => void;
119
- fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus>;
120
- suspense: () => Promise<_tanstack_vue_query.QueryObserverResult<TData, TError>>;
121
- queryKey: [string, string, string, unknown, {
122
- infinite: boolean;
123
- optimisticUpdate: boolean;
124
- }];
125
- } | {
126
- data: vue.Ref<undefined>;
127
- error: vue.Ref<null>;
128
- isError: vue.Ref<false>;
129
- isLoading: vue.Ref<true>;
130
- isLoadingError: vue.Ref<false>;
131
- isRefetchError: vue.Ref<false>;
132
- isSuccess: vue.Ref<false>;
133
- status: vue.Ref<"loading">;
134
- dataUpdatedAt: vue.Ref<number>;
135
- errorUpdatedAt: vue.Ref<number>;
136
- failureCount: vue.Ref<number>;
137
- failureReason: _vue_shared.IfAny<TError | null, vue.Ref<TError | null>, [TError | null] extends [vue.Ref<any>] ? vue.Ref<any> & TError : vue.Ref<TError | null>>;
138
- errorUpdateCount: vue.Ref<number>;
139
- isFetched: vue.Ref<boolean>;
140
- isFetchedAfterMount: vue.Ref<boolean>;
141
- isFetching: vue.Ref<boolean>;
142
- isInitialLoading: vue.Ref<boolean>;
143
- isPaused: vue.Ref<boolean>;
144
- isPlaceholderData: vue.Ref<boolean>;
145
- isPreviousData: vue.Ref<boolean>;
146
- isRefetching: vue.Ref<boolean>;
147
- isStale: vue.Ref<boolean>;
148
- refetch: <TPageData>(options?: (_tanstack_vue_query.RefetchOptions & _tanstack_vue_query.RefetchQueryFilters<TPageData>) | undefined) => Promise<_tanstack_vue_query.QueryObserverResult<TData, TError>>;
149
- remove: () => void;
150
- fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus>;
151
- suspense: () => Promise<_tanstack_vue_query.QueryObserverResult<TData, TError>>;
152
- queryKey: [string, string, string, unknown, {
153
- infinite: boolean;
154
- optimisticUpdate: boolean;
155
- }];
156
- };
157
- /**
158
- * Creates a vue-query infinite query.
159
- *
160
- * @param model The name of the model under query.
161
- * @param url The request URL.
162
- * @param args The initial request args object, URL-encoded and appended as "?q=" parameter
163
- * @param options The vue-query infinite query options object
164
- * @param fetch The fetch function to use for sending the HTTP request
165
- * @returns useInfiniteQuery hook
166
- */
167
- declare function useInfiniteModelQuery<TQueryFnData, TData, TError>(model: string, url: string, args?: MaybeRefOrGetter<unknown> | ComputedRef<unknown>, options?: MaybeRefOrGetter<Omit<UseInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>, 'queryKey' | 'initialPageParam'>> | ComputedRef<Omit<UseInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>, 'queryKey' | 'initialPageParam'>>, fetch?: FetchFn): {
168
- data: vue.Ref<undefined>;
169
- error: _vue_shared.IfAny<TError, vue.Ref<TError>, [TError] extends [vue.Ref<any>] ? TError : vue.Ref<TError>>;
170
- isError: vue.Ref<true>;
171
- isLoading: vue.Ref<false>;
172
- isLoadingError: vue.Ref<true>;
173
- isRefetchError: vue.Ref<false>;
174
- isSuccess: vue.Ref<false>;
175
- status: vue.Ref<"error">;
176
- fetchNextPage: (options?: _tanstack_vue_query.FetchNextPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
177
- fetchPreviousPage: (options?: _tanstack_vue_query.FetchPreviousPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
178
- hasNextPage?: vue.Ref<boolean | undefined> | undefined;
179
- hasPreviousPage?: vue.Ref<boolean | undefined> | undefined;
180
- isFetchingNextPage: vue.Ref<boolean>;
181
- isFetchingPreviousPage: vue.Ref<boolean>;
182
- dataUpdatedAt: vue.Ref<number>;
183
- errorUpdatedAt: vue.Ref<number>;
184
- failureCount: vue.Ref<number>;
185
- failureReason: _vue_shared.IfAny<TError | null, vue.Ref<TError | null>, [TError | null] extends [vue.Ref<any>] ? vue.Ref<any> & TError : vue.Ref<TError | null>>;
186
- errorUpdateCount: vue.Ref<number>;
187
- isFetched: vue.Ref<boolean>;
188
- isFetchedAfterMount: vue.Ref<boolean>;
189
- isFetching: vue.Ref<boolean>;
190
- isInitialLoading: vue.Ref<boolean>;
191
- isPaused: vue.Ref<boolean>;
192
- isPlaceholderData: vue.Ref<boolean>;
193
- isPreviousData: vue.Ref<boolean>;
194
- isRefetching: vue.Ref<boolean>;
195
- isStale: vue.Ref<boolean>;
196
- refetch: <TPageData>(options?: (_tanstack_vue_query.RefetchOptions & _tanstack_vue_query.RefetchQueryFilters<TPageData>) | undefined) => Promise<_tanstack_vue_query.QueryObserverResult<InfiniteData<TData>, TError>>;
197
- remove: () => void;
198
- fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus>;
199
- suspense: () => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
200
- queryKey: [string, string, string, unknown, {
201
- infinite: boolean;
202
- optimisticUpdate: boolean;
203
- }];
204
- } | {
205
- data: vue.Ref<undefined>;
206
- error: vue.Ref<null>;
207
- isError: vue.Ref<false>;
208
- isLoading: vue.Ref<true>;
209
- isLoadingError: vue.Ref<false>;
210
- isRefetchError: vue.Ref<false>;
211
- isSuccess: vue.Ref<false>;
212
- status: vue.Ref<"loading">;
213
- fetchNextPage: (options?: _tanstack_vue_query.FetchNextPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
214
- fetchPreviousPage: (options?: _tanstack_vue_query.FetchPreviousPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
215
- hasNextPage?: vue.Ref<boolean | undefined> | undefined;
216
- hasPreviousPage?: vue.Ref<boolean | undefined> | undefined;
217
- isFetchingNextPage: vue.Ref<boolean>;
218
- isFetchingPreviousPage: vue.Ref<boolean>;
219
- dataUpdatedAt: vue.Ref<number>;
220
- errorUpdatedAt: vue.Ref<number>;
221
- failureCount: vue.Ref<number>;
222
- failureReason: _vue_shared.IfAny<TError | null, vue.Ref<TError | null>, [TError | null] extends [vue.Ref<any>] ? vue.Ref<any> & TError : vue.Ref<TError | null>>;
223
- errorUpdateCount: vue.Ref<number>;
224
- isFetched: vue.Ref<boolean>;
225
- isFetchedAfterMount: vue.Ref<boolean>;
226
- isFetching: vue.Ref<boolean>;
227
- isInitialLoading: vue.Ref<boolean>;
228
- isPaused: vue.Ref<boolean>;
229
- isPlaceholderData: vue.Ref<boolean>;
230
- isPreviousData: vue.Ref<boolean>;
231
- isRefetching: vue.Ref<boolean>;
232
- isStale: vue.Ref<boolean>;
233
- refetch: <TPageData>(options?: (_tanstack_vue_query.RefetchOptions & _tanstack_vue_query.RefetchQueryFilters<TPageData>) | undefined) => Promise<_tanstack_vue_query.QueryObserverResult<InfiniteData<TData>, TError>>;
234
- remove: () => void;
235
- fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus>;
236
- suspense: () => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
237
- queryKey: [string, string, string, unknown, {
238
- infinite: boolean;
239
- optimisticUpdate: boolean;
240
- }];
241
- } | {
242
- data: vue.Ref<InfiniteData<TData>>;
243
- error: _vue_shared.IfAny<TError, vue.Ref<TError>, [TError] extends [vue.Ref<any>] ? TError : vue.Ref<TError>>;
244
- isError: vue.Ref<true>;
245
- isLoading: vue.Ref<false>;
246
- isLoadingError: vue.Ref<false>;
247
- isRefetchError: vue.Ref<true>;
248
- isSuccess: vue.Ref<false>;
249
- status: vue.Ref<"error">;
250
- fetchNextPage: (options?: _tanstack_vue_query.FetchNextPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
251
- fetchPreviousPage: (options?: _tanstack_vue_query.FetchPreviousPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
252
- hasNextPage?: vue.Ref<boolean | undefined> | undefined;
253
- hasPreviousPage?: vue.Ref<boolean | undefined> | undefined;
254
- isFetchingNextPage: vue.Ref<boolean>;
255
- isFetchingPreviousPage: vue.Ref<boolean>;
256
- dataUpdatedAt: vue.Ref<number>;
257
- errorUpdatedAt: vue.Ref<number>;
258
- failureCount: vue.Ref<number>;
259
- failureReason: _vue_shared.IfAny<TError | null, vue.Ref<TError | null>, [TError | null] extends [vue.Ref<any>] ? vue.Ref<any> & TError : vue.Ref<TError | null>>;
260
- errorUpdateCount: vue.Ref<number>;
261
- isFetched: vue.Ref<boolean>;
262
- isFetchedAfterMount: vue.Ref<boolean>;
263
- isFetching: vue.Ref<boolean>;
264
- isInitialLoading: vue.Ref<boolean>;
265
- isPaused: vue.Ref<boolean>;
266
- isPlaceholderData: vue.Ref<boolean>;
267
- isPreviousData: vue.Ref<boolean>;
268
- isRefetching: vue.Ref<boolean>;
269
- isStale: vue.Ref<boolean>;
270
- refetch: <TPageData>(options?: (_tanstack_vue_query.RefetchOptions & _tanstack_vue_query.RefetchQueryFilters<TPageData>) | undefined) => Promise<_tanstack_vue_query.QueryObserverResult<InfiniteData<TData>, TError>>;
271
- remove: () => void;
272
- fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus>;
273
- suspense: () => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
274
- queryKey: [string, string, string, unknown, {
275
- infinite: boolean;
276
- optimisticUpdate: boolean;
277
- }];
278
- } | {
279
- data: vue.Ref<InfiniteData<TData>>;
280
- error: vue.Ref<null>;
281
- isError: vue.Ref<false>;
282
- isLoading: vue.Ref<false>;
283
- isLoadingError: vue.Ref<false>;
284
- isRefetchError: vue.Ref<false>;
285
- isSuccess: vue.Ref<true>;
286
- status: vue.Ref<"success">;
287
- fetchNextPage: (options?: _tanstack_vue_query.FetchNextPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
288
- fetchPreviousPage: (options?: _tanstack_vue_query.FetchPreviousPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
289
- hasNextPage?: vue.Ref<boolean | undefined> | undefined;
290
- hasPreviousPage?: vue.Ref<boolean | undefined> | undefined;
291
- isFetchingNextPage: vue.Ref<boolean>;
292
- isFetchingPreviousPage: vue.Ref<boolean>;
293
- dataUpdatedAt: vue.Ref<number>;
294
- errorUpdatedAt: vue.Ref<number>;
295
- failureCount: vue.Ref<number>;
296
- failureReason: _vue_shared.IfAny<TError | null, vue.Ref<TError | null>, [TError | null] extends [vue.Ref<any>] ? vue.Ref<any> & TError : vue.Ref<TError | null>>;
297
- errorUpdateCount: vue.Ref<number>;
298
- isFetched: vue.Ref<boolean>;
299
- isFetchedAfterMount: vue.Ref<boolean>;
300
- isFetching: vue.Ref<boolean>;
301
- isInitialLoading: vue.Ref<boolean>;
302
- isPaused: vue.Ref<boolean>;
303
- isPlaceholderData: vue.Ref<boolean>;
304
- isPreviousData: vue.Ref<boolean>;
305
- isRefetching: vue.Ref<boolean>;
306
- isStale: vue.Ref<boolean>;
307
- refetch: <TPageData>(options?: (_tanstack_vue_query.RefetchOptions & _tanstack_vue_query.RefetchQueryFilters<TPageData>) | undefined) => Promise<_tanstack_vue_query.QueryObserverResult<InfiniteData<TData>, TError>>;
308
- remove: () => void;
309
- fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus>;
310
- suspense: () => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
311
- queryKey: [string, string, string, unknown, {
312
- infinite: boolean;
313
- optimisticUpdate: boolean;
314
- }];
315
- };
316
- /**
317
- * Creates a mutation with vue-query.
318
- *
319
- * @param model The name of the model under mutation.
320
- * @param method The HTTP method.
321
- * @param modelMeta The model metadata.
322
- * @param url The request URL.
323
- * @param options The vue-query options.
324
- * @param fetch The fetch function to use for sending the HTTP request
325
- * @param checkReadBack Whether to check for read back errors and return undefined if found.
326
- * @returns useMutation hooks
327
- */
328
- declare function useModelMutation<TArgs, TError, R = any, C extends boolean = boolean, Result = C extends true ? R | undefined : R>(model: string, method: 'POST' | 'PUT' | 'DELETE', url: string, modelMeta: ModelMeta, options?: MaybeRefOrGetter<Omit<UseMutationOptions<Result, TError, TArgs, unknown>, 'mutationFn'> & ExtraMutationOptions> | ComputedRef<Omit<UseMutationOptions<Result, TError, TArgs, unknown>, 'mutationFn'> & ExtraMutationOptions>, fetch?: FetchFn, checkReadBack?: C): _tanstack_vue_query.UseMutationReturnType<Result, TError, TArgs, unknown, Omit<_tanstack_vue_query.MutationObserverIdleResult<Result, TError, TArgs, unknown>, "mutate" | "reset"> | Omit<_tanstack_vue_query.MutationObserverLoadingResult<Result, TError, TArgs, unknown>, "mutate" | "reset"> | Omit<_tanstack_vue_query.MutationObserverErrorResult<Result, TError, TArgs, unknown>, "mutate" | "reset"> | Omit<_tanstack_vue_query.MutationObserverSuccessResult<Result, TError, TArgs, unknown>, "mutate" | "reset">>;
329
-
330
- export { APIContext as RequestHandlerContext, VueQueryContextKey, getHooksContext, provideHooksContext, useInfiniteModelQuery, useModelMutation, useModelQuery };
package/runtime/vue.d.ts DELETED
@@ -1,330 +0,0 @@
1
- import * as _tanstack_vue_query from '@tanstack/vue-query';
2
- import { UseQueryOptions, UseInfiniteQueryOptions, InfiniteData, UseMutationOptions } from '@tanstack/vue-query';
3
- import * as _vue_shared from '@vue/shared';
4
- import * as vue from 'vue';
5
- import { MaybeRefOrGetter, ComputedRef } from 'vue';
6
- import { ModelMeta } from '@zenstackhq/runtime/cross';
7
- import { A as APIContext, F as FetchFn, a as ExtraQueryOptions, E as ExtraMutationOptions } from './common-CXlL7vTW.js';
8
-
9
- declare const VueQueryContextKey = "zenstack-vue-query-context";
10
- /**
11
- * Provide context for the generated TanStack Query hooks.
12
- */
13
- declare function provideHooksContext(context: APIContext): void;
14
- /**
15
- * Hooks context.
16
- */
17
- declare function getHooksContext(): {
18
- fetch?: FetchFn;
19
- logging?: boolean;
20
- endpoint: string;
21
- };
22
- /**
23
- * Creates a vue-query query.
24
- *
25
- * @param model The name of the model under query.
26
- * @param url The request URL.
27
- * @param args The request args object, URL-encoded and appended as "?q=" parameter
28
- * @param options The vue-query options object
29
- * @param fetch The fetch function to use for sending the HTTP request
30
- * @returns useQuery hook
31
- */
32
- declare function useModelQuery<TQueryFnData, TData, TError>(model: string, url: string, args?: MaybeRefOrGetter<unknown> | ComputedRef<unknown>, options?: MaybeRefOrGetter<Omit<UseQueryOptions<TQueryFnData, TError, TData>, 'queryKey'> & ExtraQueryOptions> | ComputedRef<Omit<UseQueryOptions<TQueryFnData, TError, TData>, 'queryKey'> & ExtraQueryOptions>, fetch?: FetchFn): {
33
- data: _vue_shared.IfAny<TData, vue.Ref<TData>, [TData] extends [vue.Ref<any>] ? TData : vue.Ref<TData>>;
34
- error: _vue_shared.IfAny<TError, vue.Ref<TError>, [TError] extends [vue.Ref<any>] ? TError : vue.Ref<TError>>;
35
- isError: vue.Ref<true>;
36
- isLoading: vue.Ref<false>;
37
- isLoadingError: vue.Ref<false>;
38
- isRefetchError: vue.Ref<true>;
39
- isSuccess: vue.Ref<false>;
40
- status: vue.Ref<"error">;
41
- dataUpdatedAt: vue.Ref<number>;
42
- errorUpdatedAt: vue.Ref<number>;
43
- failureCount: vue.Ref<number>;
44
- failureReason: _vue_shared.IfAny<TError | null, vue.Ref<TError | null>, [TError | null] extends [vue.Ref<any>] ? vue.Ref<any> & TError : vue.Ref<TError | null>>;
45
- errorUpdateCount: vue.Ref<number>;
46
- isFetched: vue.Ref<boolean>;
47
- isFetchedAfterMount: vue.Ref<boolean>;
48
- isFetching: vue.Ref<boolean>;
49
- isInitialLoading: vue.Ref<boolean>;
50
- isPaused: vue.Ref<boolean>;
51
- isPlaceholderData: vue.Ref<boolean>;
52
- isPreviousData: vue.Ref<boolean>;
53
- isRefetching: vue.Ref<boolean>;
54
- isStale: vue.Ref<boolean>;
55
- refetch: <TPageData>(options?: (_tanstack_vue_query.RefetchOptions & _tanstack_vue_query.RefetchQueryFilters<TPageData>) | undefined) => Promise<_tanstack_vue_query.QueryObserverResult<TData, TError>>;
56
- remove: () => void;
57
- fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus>;
58
- suspense: () => Promise<_tanstack_vue_query.QueryObserverResult<TData, TError>>;
59
- queryKey: [string, string, string, unknown, {
60
- infinite: boolean;
61
- optimisticUpdate: boolean;
62
- }];
63
- } | {
64
- data: _vue_shared.IfAny<TData, vue.Ref<TData>, [TData] extends [vue.Ref<any>] ? TData : vue.Ref<TData>>;
65
- error: vue.Ref<null>;
66
- isError: vue.Ref<false>;
67
- isLoading: vue.Ref<false>;
68
- isLoadingError: vue.Ref<false>;
69
- isRefetchError: vue.Ref<false>;
70
- isSuccess: vue.Ref<true>;
71
- status: vue.Ref<"success">;
72
- dataUpdatedAt: vue.Ref<number>;
73
- errorUpdatedAt: vue.Ref<number>;
74
- failureCount: vue.Ref<number>;
75
- failureReason: _vue_shared.IfAny<TError | null, vue.Ref<TError | null>, [TError | null] extends [vue.Ref<any>] ? vue.Ref<any> & TError : vue.Ref<TError | null>>;
76
- errorUpdateCount: vue.Ref<number>;
77
- isFetched: vue.Ref<boolean>;
78
- isFetchedAfterMount: vue.Ref<boolean>;
79
- isFetching: vue.Ref<boolean>;
80
- isInitialLoading: vue.Ref<boolean>;
81
- isPaused: vue.Ref<boolean>;
82
- isPlaceholderData: vue.Ref<boolean>;
83
- isPreviousData: vue.Ref<boolean>;
84
- isRefetching: vue.Ref<boolean>;
85
- isStale: vue.Ref<boolean>;
86
- refetch: <TPageData>(options?: (_tanstack_vue_query.RefetchOptions & _tanstack_vue_query.RefetchQueryFilters<TPageData>) | undefined) => Promise<_tanstack_vue_query.QueryObserverResult<TData, TError>>;
87
- remove: () => void;
88
- fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus>;
89
- suspense: () => Promise<_tanstack_vue_query.QueryObserverResult<TData, TError>>;
90
- queryKey: [string, string, string, unknown, {
91
- infinite: boolean;
92
- optimisticUpdate: boolean;
93
- }];
94
- } | {
95
- data: vue.Ref<undefined>;
96
- error: _vue_shared.IfAny<TError, vue.Ref<TError>, [TError] extends [vue.Ref<any>] ? TError : vue.Ref<TError>>;
97
- isError: vue.Ref<true>;
98
- isLoading: vue.Ref<false>;
99
- isLoadingError: vue.Ref<true>;
100
- isRefetchError: vue.Ref<false>;
101
- isSuccess: vue.Ref<false>;
102
- status: vue.Ref<"error">;
103
- dataUpdatedAt: vue.Ref<number>;
104
- errorUpdatedAt: vue.Ref<number>;
105
- failureCount: vue.Ref<number>;
106
- failureReason: _vue_shared.IfAny<TError | null, vue.Ref<TError | null>, [TError | null] extends [vue.Ref<any>] ? vue.Ref<any> & TError : vue.Ref<TError | null>>;
107
- errorUpdateCount: vue.Ref<number>;
108
- isFetched: vue.Ref<boolean>;
109
- isFetchedAfterMount: vue.Ref<boolean>;
110
- isFetching: vue.Ref<boolean>;
111
- isInitialLoading: vue.Ref<boolean>;
112
- isPaused: vue.Ref<boolean>;
113
- isPlaceholderData: vue.Ref<boolean>;
114
- isPreviousData: vue.Ref<boolean>;
115
- isRefetching: vue.Ref<boolean>;
116
- isStale: vue.Ref<boolean>;
117
- refetch: <TPageData>(options?: (_tanstack_vue_query.RefetchOptions & _tanstack_vue_query.RefetchQueryFilters<TPageData>) | undefined) => Promise<_tanstack_vue_query.QueryObserverResult<TData, TError>>;
118
- remove: () => void;
119
- fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus>;
120
- suspense: () => Promise<_tanstack_vue_query.QueryObserverResult<TData, TError>>;
121
- queryKey: [string, string, string, unknown, {
122
- infinite: boolean;
123
- optimisticUpdate: boolean;
124
- }];
125
- } | {
126
- data: vue.Ref<undefined>;
127
- error: vue.Ref<null>;
128
- isError: vue.Ref<false>;
129
- isLoading: vue.Ref<true>;
130
- isLoadingError: vue.Ref<false>;
131
- isRefetchError: vue.Ref<false>;
132
- isSuccess: vue.Ref<false>;
133
- status: vue.Ref<"loading">;
134
- dataUpdatedAt: vue.Ref<number>;
135
- errorUpdatedAt: vue.Ref<number>;
136
- failureCount: vue.Ref<number>;
137
- failureReason: _vue_shared.IfAny<TError | null, vue.Ref<TError | null>, [TError | null] extends [vue.Ref<any>] ? vue.Ref<any> & TError : vue.Ref<TError | null>>;
138
- errorUpdateCount: vue.Ref<number>;
139
- isFetched: vue.Ref<boolean>;
140
- isFetchedAfterMount: vue.Ref<boolean>;
141
- isFetching: vue.Ref<boolean>;
142
- isInitialLoading: vue.Ref<boolean>;
143
- isPaused: vue.Ref<boolean>;
144
- isPlaceholderData: vue.Ref<boolean>;
145
- isPreviousData: vue.Ref<boolean>;
146
- isRefetching: vue.Ref<boolean>;
147
- isStale: vue.Ref<boolean>;
148
- refetch: <TPageData>(options?: (_tanstack_vue_query.RefetchOptions & _tanstack_vue_query.RefetchQueryFilters<TPageData>) | undefined) => Promise<_tanstack_vue_query.QueryObserverResult<TData, TError>>;
149
- remove: () => void;
150
- fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus>;
151
- suspense: () => Promise<_tanstack_vue_query.QueryObserverResult<TData, TError>>;
152
- queryKey: [string, string, string, unknown, {
153
- infinite: boolean;
154
- optimisticUpdate: boolean;
155
- }];
156
- };
157
- /**
158
- * Creates a vue-query infinite query.
159
- *
160
- * @param model The name of the model under query.
161
- * @param url The request URL.
162
- * @param args The initial request args object, URL-encoded and appended as "?q=" parameter
163
- * @param options The vue-query infinite query options object
164
- * @param fetch The fetch function to use for sending the HTTP request
165
- * @returns useInfiniteQuery hook
166
- */
167
- declare function useInfiniteModelQuery<TQueryFnData, TData, TError>(model: string, url: string, args?: MaybeRefOrGetter<unknown> | ComputedRef<unknown>, options?: MaybeRefOrGetter<Omit<UseInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>, 'queryKey' | 'initialPageParam'>> | ComputedRef<Omit<UseInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>, 'queryKey' | 'initialPageParam'>>, fetch?: FetchFn): {
168
- data: vue.Ref<undefined>;
169
- error: _vue_shared.IfAny<TError, vue.Ref<TError>, [TError] extends [vue.Ref<any>] ? TError : vue.Ref<TError>>;
170
- isError: vue.Ref<true>;
171
- isLoading: vue.Ref<false>;
172
- isLoadingError: vue.Ref<true>;
173
- isRefetchError: vue.Ref<false>;
174
- isSuccess: vue.Ref<false>;
175
- status: vue.Ref<"error">;
176
- fetchNextPage: (options?: _tanstack_vue_query.FetchNextPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
177
- fetchPreviousPage: (options?: _tanstack_vue_query.FetchPreviousPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
178
- hasNextPage?: vue.Ref<boolean | undefined> | undefined;
179
- hasPreviousPage?: vue.Ref<boolean | undefined> | undefined;
180
- isFetchingNextPage: vue.Ref<boolean>;
181
- isFetchingPreviousPage: vue.Ref<boolean>;
182
- dataUpdatedAt: vue.Ref<number>;
183
- errorUpdatedAt: vue.Ref<number>;
184
- failureCount: vue.Ref<number>;
185
- failureReason: _vue_shared.IfAny<TError | null, vue.Ref<TError | null>, [TError | null] extends [vue.Ref<any>] ? vue.Ref<any> & TError : vue.Ref<TError | null>>;
186
- errorUpdateCount: vue.Ref<number>;
187
- isFetched: vue.Ref<boolean>;
188
- isFetchedAfterMount: vue.Ref<boolean>;
189
- isFetching: vue.Ref<boolean>;
190
- isInitialLoading: vue.Ref<boolean>;
191
- isPaused: vue.Ref<boolean>;
192
- isPlaceholderData: vue.Ref<boolean>;
193
- isPreviousData: vue.Ref<boolean>;
194
- isRefetching: vue.Ref<boolean>;
195
- isStale: vue.Ref<boolean>;
196
- refetch: <TPageData>(options?: (_tanstack_vue_query.RefetchOptions & _tanstack_vue_query.RefetchQueryFilters<TPageData>) | undefined) => Promise<_tanstack_vue_query.QueryObserverResult<InfiniteData<TData>, TError>>;
197
- remove: () => void;
198
- fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus>;
199
- suspense: () => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
200
- queryKey: [string, string, string, unknown, {
201
- infinite: boolean;
202
- optimisticUpdate: boolean;
203
- }];
204
- } | {
205
- data: vue.Ref<undefined>;
206
- error: vue.Ref<null>;
207
- isError: vue.Ref<false>;
208
- isLoading: vue.Ref<true>;
209
- isLoadingError: vue.Ref<false>;
210
- isRefetchError: vue.Ref<false>;
211
- isSuccess: vue.Ref<false>;
212
- status: vue.Ref<"loading">;
213
- fetchNextPage: (options?: _tanstack_vue_query.FetchNextPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
214
- fetchPreviousPage: (options?: _tanstack_vue_query.FetchPreviousPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
215
- hasNextPage?: vue.Ref<boolean | undefined> | undefined;
216
- hasPreviousPage?: vue.Ref<boolean | undefined> | undefined;
217
- isFetchingNextPage: vue.Ref<boolean>;
218
- isFetchingPreviousPage: vue.Ref<boolean>;
219
- dataUpdatedAt: vue.Ref<number>;
220
- errorUpdatedAt: vue.Ref<number>;
221
- failureCount: vue.Ref<number>;
222
- failureReason: _vue_shared.IfAny<TError | null, vue.Ref<TError | null>, [TError | null] extends [vue.Ref<any>] ? vue.Ref<any> & TError : vue.Ref<TError | null>>;
223
- errorUpdateCount: vue.Ref<number>;
224
- isFetched: vue.Ref<boolean>;
225
- isFetchedAfterMount: vue.Ref<boolean>;
226
- isFetching: vue.Ref<boolean>;
227
- isInitialLoading: vue.Ref<boolean>;
228
- isPaused: vue.Ref<boolean>;
229
- isPlaceholderData: vue.Ref<boolean>;
230
- isPreviousData: vue.Ref<boolean>;
231
- isRefetching: vue.Ref<boolean>;
232
- isStale: vue.Ref<boolean>;
233
- refetch: <TPageData>(options?: (_tanstack_vue_query.RefetchOptions & _tanstack_vue_query.RefetchQueryFilters<TPageData>) | undefined) => Promise<_tanstack_vue_query.QueryObserverResult<InfiniteData<TData>, TError>>;
234
- remove: () => void;
235
- fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus>;
236
- suspense: () => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
237
- queryKey: [string, string, string, unknown, {
238
- infinite: boolean;
239
- optimisticUpdate: boolean;
240
- }];
241
- } | {
242
- data: vue.Ref<InfiniteData<TData>>;
243
- error: _vue_shared.IfAny<TError, vue.Ref<TError>, [TError] extends [vue.Ref<any>] ? TError : vue.Ref<TError>>;
244
- isError: vue.Ref<true>;
245
- isLoading: vue.Ref<false>;
246
- isLoadingError: vue.Ref<false>;
247
- isRefetchError: vue.Ref<true>;
248
- isSuccess: vue.Ref<false>;
249
- status: vue.Ref<"error">;
250
- fetchNextPage: (options?: _tanstack_vue_query.FetchNextPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
251
- fetchPreviousPage: (options?: _tanstack_vue_query.FetchPreviousPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
252
- hasNextPage?: vue.Ref<boolean | undefined> | undefined;
253
- hasPreviousPage?: vue.Ref<boolean | undefined> | undefined;
254
- isFetchingNextPage: vue.Ref<boolean>;
255
- isFetchingPreviousPage: vue.Ref<boolean>;
256
- dataUpdatedAt: vue.Ref<number>;
257
- errorUpdatedAt: vue.Ref<number>;
258
- failureCount: vue.Ref<number>;
259
- failureReason: _vue_shared.IfAny<TError | null, vue.Ref<TError | null>, [TError | null] extends [vue.Ref<any>] ? vue.Ref<any> & TError : vue.Ref<TError | null>>;
260
- errorUpdateCount: vue.Ref<number>;
261
- isFetched: vue.Ref<boolean>;
262
- isFetchedAfterMount: vue.Ref<boolean>;
263
- isFetching: vue.Ref<boolean>;
264
- isInitialLoading: vue.Ref<boolean>;
265
- isPaused: vue.Ref<boolean>;
266
- isPlaceholderData: vue.Ref<boolean>;
267
- isPreviousData: vue.Ref<boolean>;
268
- isRefetching: vue.Ref<boolean>;
269
- isStale: vue.Ref<boolean>;
270
- refetch: <TPageData>(options?: (_tanstack_vue_query.RefetchOptions & _tanstack_vue_query.RefetchQueryFilters<TPageData>) | undefined) => Promise<_tanstack_vue_query.QueryObserverResult<InfiniteData<TData>, TError>>;
271
- remove: () => void;
272
- fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus>;
273
- suspense: () => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
274
- queryKey: [string, string, string, unknown, {
275
- infinite: boolean;
276
- optimisticUpdate: boolean;
277
- }];
278
- } | {
279
- data: vue.Ref<InfiniteData<TData>>;
280
- error: vue.Ref<null>;
281
- isError: vue.Ref<false>;
282
- isLoading: vue.Ref<false>;
283
- isLoadingError: vue.Ref<false>;
284
- isRefetchError: vue.Ref<false>;
285
- isSuccess: vue.Ref<true>;
286
- status: vue.Ref<"success">;
287
- fetchNextPage: (options?: _tanstack_vue_query.FetchNextPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
288
- fetchPreviousPage: (options?: _tanstack_vue_query.FetchPreviousPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
289
- hasNextPage?: vue.Ref<boolean | undefined> | undefined;
290
- hasPreviousPage?: vue.Ref<boolean | undefined> | undefined;
291
- isFetchingNextPage: vue.Ref<boolean>;
292
- isFetchingPreviousPage: vue.Ref<boolean>;
293
- dataUpdatedAt: vue.Ref<number>;
294
- errorUpdatedAt: vue.Ref<number>;
295
- failureCount: vue.Ref<number>;
296
- failureReason: _vue_shared.IfAny<TError | null, vue.Ref<TError | null>, [TError | null] extends [vue.Ref<any>] ? vue.Ref<any> & TError : vue.Ref<TError | null>>;
297
- errorUpdateCount: vue.Ref<number>;
298
- isFetched: vue.Ref<boolean>;
299
- isFetchedAfterMount: vue.Ref<boolean>;
300
- isFetching: vue.Ref<boolean>;
301
- isInitialLoading: vue.Ref<boolean>;
302
- isPaused: vue.Ref<boolean>;
303
- isPlaceholderData: vue.Ref<boolean>;
304
- isPreviousData: vue.Ref<boolean>;
305
- isRefetching: vue.Ref<boolean>;
306
- isStale: vue.Ref<boolean>;
307
- refetch: <TPageData>(options?: (_tanstack_vue_query.RefetchOptions & _tanstack_vue_query.RefetchQueryFilters<TPageData>) | undefined) => Promise<_tanstack_vue_query.QueryObserverResult<InfiniteData<TData>, TError>>;
308
- remove: () => void;
309
- fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus>;
310
- suspense: () => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<TData, TError>>;
311
- queryKey: [string, string, string, unknown, {
312
- infinite: boolean;
313
- optimisticUpdate: boolean;
314
- }];
315
- };
316
- /**
317
- * Creates a mutation with vue-query.
318
- *
319
- * @param model The name of the model under mutation.
320
- * @param method The HTTP method.
321
- * @param modelMeta The model metadata.
322
- * @param url The request URL.
323
- * @param options The vue-query options.
324
- * @param fetch The fetch function to use for sending the HTTP request
325
- * @param checkReadBack Whether to check for read back errors and return undefined if found.
326
- * @returns useMutation hooks
327
- */
328
- declare function useModelMutation<TArgs, TError, R = any, C extends boolean = boolean, Result = C extends true ? R | undefined : R>(model: string, method: 'POST' | 'PUT' | 'DELETE', url: string, modelMeta: ModelMeta, options?: MaybeRefOrGetter<Omit<UseMutationOptions<Result, TError, TArgs, unknown>, 'mutationFn'> & ExtraMutationOptions> | ComputedRef<Omit<UseMutationOptions<Result, TError, TArgs, unknown>, 'mutationFn'> & ExtraMutationOptions>, fetch?: FetchFn, checkReadBack?: C): _tanstack_vue_query.UseMutationReturnType<Result, TError, TArgs, unknown, Omit<_tanstack_vue_query.MutationObserverIdleResult<Result, TError, TArgs, unknown>, "mutate" | "reset"> | Omit<_tanstack_vue_query.MutationObserverLoadingResult<Result, TError, TArgs, unknown>, "mutate" | "reset"> | Omit<_tanstack_vue_query.MutationObserverErrorResult<Result, TError, TArgs, unknown>, "mutate" | "reset"> | Omit<_tanstack_vue_query.MutationObserverSuccessResult<Result, TError, TArgs, unknown>, "mutate" | "reset">>;
329
-
330
- export { APIContext as RequestHandlerContext, VueQueryContextKey, getHooksContext, provideHooksContext, useInfiniteModelQuery, useModelMutation, useModelQuery };