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

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/dist/vue.d.ts ADDED
@@ -0,0 +1,382 @@
1
+ import * as _tanstack_vue_query from '@tanstack/vue-query';
2
+ import { UseQueryOptions, DefaultError, UseQueryReturnType, QueryKey, UseInfiniteQueryOptions, InfiniteData, UseInfiniteQueryReturnType, UseMutationOptions, UseMutationReturnType } from '@tanstack/vue-query';
3
+ import * as vue from 'vue';
4
+ import { MaybeRefOrGetter, UnwrapRef } from 'vue';
5
+ import { SelectIncludeOmit, ModelResult, FindUniqueArgs, SelectSubset, FindArgs, CreateArgs, CreateManyArgs, BatchResult, CreateManyAndReturnArgs, UpdateArgs, UpdateManyArgs, UpdateManyAndReturnArgs, UpsertArgs, DeleteArgs, DeleteManyArgs, CountArgs, Subset, CountResult, AggregateArgs, AggregateResult, GroupByArgs, GroupByResult } from '@zenstackhq/orm';
6
+ import { SchemaDef, GetModels } from '@zenstackhq/schema';
7
+ import { A as APIContext, E as ExtraQueryOptions, a as ExtraMutationOptions, T as TrimDelegateModelOperations } from './types-BRIDXxNC.js';
8
+ export { F as FetchFn } from './types-BRIDXxNC.js';
9
+
10
+ declare const VueQueryContextKey = "zenstack-vue-query-context";
11
+ /**
12
+ * Provide context for query settings.
13
+ *
14
+ * @deprecated Use {@link provideQuerySettingsContext} instead.
15
+ */
16
+ declare function provideHooksContext(context: APIContext): void;
17
+ /**
18
+ * Provide context for query settings.
19
+ */
20
+ declare function provideQuerySettingsContext(context: APIContext): void;
21
+ type ModelQueryOptions<T> = MaybeRefOrGetter<Omit<UnwrapRef<UseQueryOptions<T, DefaultError>>, 'queryKey'> & ExtraQueryOptions>;
22
+ type ModelQueryResult<T> = UseQueryReturnType<T, DefaultError> & {
23
+ queryKey: QueryKey;
24
+ };
25
+ type ModelInfiniteQueryOptions<T> = MaybeRefOrGetter<Omit<UnwrapRef<UseInfiniteQueryOptions<T, DefaultError, InfiniteData<T>>>, 'queryKey' | 'initialPageParam'>>;
26
+ type ModelInfiniteQueryResult<T> = UseInfiniteQueryReturnType<T, DefaultError> & {
27
+ queryKey: QueryKey;
28
+ };
29
+ type ModelMutationOptions<T, TArgs> = MaybeRefOrGetter<Omit<UnwrapRef<UseMutationOptions<T, DefaultError, TArgs>>, 'mutationFn'> & ExtraMutationOptions>;
30
+ type ModelMutationResult<T, TArgs> = UseMutationReturnType<T, DefaultError, TArgs, unknown>;
31
+ type ModelMutationModelResult<Schema extends SchemaDef, Model extends GetModels<Schema>, TArgs extends SelectIncludeOmit<Schema, Model, boolean>, Array extends boolean = false> = Omit<ModelMutationResult<ModelResult<Schema, Model, TArgs>, TArgs>, 'mutateAsync'> & {
32
+ mutateAsync<T extends TArgs>(args: T, options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>): Promise<Array extends true ? ModelResult<Schema, Model, T>[] : ModelResult<Schema, Model, T>>;
33
+ };
34
+ type ClientHooks<Schema extends SchemaDef> = {
35
+ [Model in GetModels<Schema> as `${Uncapitalize<Model>}`]: ModelQueryHooks<Schema, Model>;
36
+ };
37
+ type ModelQueryHooks<Schema extends SchemaDef, Model extends GetModels<Schema>> = TrimDelegateModelOperations<Schema, Model, {
38
+ useFindUnique<T extends FindUniqueArgs<Schema, Model>>(args: SelectSubset<T, FindUniqueArgs<Schema, Model>>, options?: ModelQueryOptions<ModelResult<Schema, Model, T> | null>): ModelQueryResult<ModelResult<Schema, Model, T> | null>;
39
+ useFindFirst<T extends FindArgs<Schema, Model, false>>(args?: SelectSubset<T, FindArgs<Schema, Model, false>>, options?: ModelQueryOptions<ModelResult<Schema, Model, T> | null>): ModelQueryResult<ModelResult<Schema, Model, T> | null>;
40
+ useFindMany<T extends FindArgs<Schema, Model, true>>(args?: SelectSubset<T, FindArgs<Schema, Model, true>>, options?: ModelQueryOptions<ModelResult<Schema, Model, T>[]>): ModelQueryResult<ModelResult<Schema, Model, T>[]>;
41
+ useInfiniteFindMany<T extends FindArgs<Schema, Model, true>>(args?: SelectSubset<T, FindArgs<Schema, Model, true>>, options?: ModelInfiniteQueryOptions<ModelResult<Schema, Model, T>[]>): ModelInfiniteQueryResult<InfiniteData<ModelResult<Schema, Model, T>[]>>;
42
+ useCreate<T extends CreateArgs<Schema, Model>>(options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>): ModelMutationModelResult<Schema, Model, T>;
43
+ useCreateMany<T extends CreateManyArgs<Schema, Model>>(options?: ModelMutationOptions<BatchResult, T>): ModelMutationResult<BatchResult, T>;
44
+ useCreateManyAndReturn<T extends CreateManyAndReturnArgs<Schema, Model>>(options?: ModelMutationOptions<ModelResult<Schema, Model, T>[], T>): ModelMutationModelResult<Schema, Model, T, true>;
45
+ useUpdate<T extends UpdateArgs<Schema, Model>>(options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>): ModelMutationModelResult<Schema, Model, T>;
46
+ useUpdateMany<T extends UpdateManyArgs<Schema, Model>>(options?: ModelMutationOptions<BatchResult, T>): ModelMutationResult<BatchResult, T>;
47
+ useUpdateManyAndReturn<T extends UpdateManyAndReturnArgs<Schema, Model>>(options?: ModelMutationOptions<ModelResult<Schema, Model, T>[], T>): ModelMutationModelResult<Schema, Model, T, true>;
48
+ useUpsert<T extends UpsertArgs<Schema, Model>>(options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>): ModelMutationModelResult<Schema, Model, T>;
49
+ useDelete<T extends DeleteArgs<Schema, Model>>(options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>): ModelMutationModelResult<Schema, Model, T>;
50
+ useDeleteMany<T extends DeleteManyArgs<Schema, Model>>(options?: ModelMutationOptions<BatchResult, T>): ModelMutationResult<BatchResult, T>;
51
+ useCount<T extends CountArgs<Schema, Model>>(args?: Subset<T, CountArgs<Schema, Model>>, options?: ModelQueryOptions<CountResult<Schema, Model, T>>): ModelQueryResult<CountResult<Schema, Model, T>>;
52
+ useAggregate<T extends AggregateArgs<Schema, Model>>(args: Subset<T, AggregateArgs<Schema, Model>>, options?: ModelQueryOptions<AggregateResult<Schema, Model, T>>): ModelQueryResult<AggregateResult<Schema, Model, T>>;
53
+ useGroupBy<T extends GroupByArgs<Schema, Model>>(args: Subset<T, GroupByArgs<Schema, Model>>, options?: ModelQueryOptions<GroupByResult<Schema, Model, T>>): ModelQueryResult<GroupByResult<Schema, Model, T>>;
54
+ }>;
55
+ /**
56
+ * Gets data query hooks for all models in the schema.
57
+ */
58
+ declare function useClientQueries<Schema extends SchemaDef>(schema: Schema): ClientHooks<Schema>;
59
+ /**
60
+ * Gets data query hooks for a specific model in the schema.
61
+ */
62
+ declare function useModelQueries<Schema extends SchemaDef, Model extends GetModels<Schema>>(schema: Schema, model: Model): ModelQueryHooks<Schema, Model>;
63
+ declare function useInternalQuery<TQueryFnData, TData>(_schema: SchemaDef, model: string, operation: string, args?: MaybeRefOrGetter<unknown>, options?: MaybeRefOrGetter<Omit<UnwrapRef<UseQueryOptions<TQueryFnData, DefaultError, TData>>, 'queryKey'> & ExtraQueryOptions>): {
64
+ data: vue.Ref<TData, TData>;
65
+ error: vue.Ref<Error, Error>;
66
+ isError: vue.Ref<true, true>;
67
+ isPending: vue.Ref<false, false>;
68
+ isLoading: vue.Ref<false, false>;
69
+ isLoadingError: vue.Ref<false, false>;
70
+ isRefetchError: vue.Ref<true, true>;
71
+ isSuccess: vue.Ref<false, false>;
72
+ isPlaceholderData: vue.Ref<false, false>;
73
+ status: vue.Ref<"error", "error">;
74
+ dataUpdatedAt: vue.Ref<number, number>;
75
+ errorUpdatedAt: vue.Ref<number, number>;
76
+ failureCount: vue.Ref<number, number>;
77
+ failureReason: vue.Ref<Error | null, Error | null>;
78
+ errorUpdateCount: vue.Ref<number, number>;
79
+ isFetched: vue.Ref<boolean, boolean>;
80
+ isFetchedAfterMount: vue.Ref<boolean, boolean>;
81
+ isFetching: vue.Ref<boolean, boolean>;
82
+ isInitialLoading: vue.Ref<boolean, boolean>;
83
+ isPaused: vue.Ref<boolean, boolean>;
84
+ isRefetching: vue.Ref<boolean, boolean>;
85
+ isStale: vue.Ref<boolean, boolean>;
86
+ isEnabled: vue.Ref<boolean, boolean>;
87
+ refetch: (options?: _tanstack_vue_query.RefetchOptions) => Promise<_tanstack_vue_query.QueryObserverResult<TData, Error>>;
88
+ fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus, _tanstack_vue_query.FetchStatus>;
89
+ promise: vue.Ref<Promise<TData>, Promise<TData>>;
90
+ suspense: () => Promise<_tanstack_vue_query.DefinedQueryObserverResult<TData, Error>>;
91
+ queryKey: [string, string, string, unknown, {
92
+ infinite: boolean;
93
+ optimisticUpdate: boolean;
94
+ }];
95
+ } | {
96
+ data: vue.Ref<TData, TData>;
97
+ error: vue.Ref<null, null>;
98
+ isError: vue.Ref<false, false>;
99
+ isPending: vue.Ref<false, false>;
100
+ isLoading: vue.Ref<false, false>;
101
+ isLoadingError: vue.Ref<false, false>;
102
+ isRefetchError: vue.Ref<false, false>;
103
+ isSuccess: vue.Ref<true, true>;
104
+ isPlaceholderData: vue.Ref<false, false>;
105
+ status: vue.Ref<"success", "success">;
106
+ dataUpdatedAt: vue.Ref<number, number>;
107
+ errorUpdatedAt: vue.Ref<number, number>;
108
+ failureCount: vue.Ref<number, number>;
109
+ failureReason: vue.Ref<Error | null, Error | null>;
110
+ errorUpdateCount: vue.Ref<number, number>;
111
+ isFetched: vue.Ref<boolean, boolean>;
112
+ isFetchedAfterMount: vue.Ref<boolean, boolean>;
113
+ isFetching: vue.Ref<boolean, boolean>;
114
+ isInitialLoading: vue.Ref<boolean, boolean>;
115
+ isPaused: vue.Ref<boolean, boolean>;
116
+ isRefetching: vue.Ref<boolean, boolean>;
117
+ isStale: vue.Ref<boolean, boolean>;
118
+ isEnabled: vue.Ref<boolean, boolean>;
119
+ refetch: (options?: _tanstack_vue_query.RefetchOptions) => Promise<_tanstack_vue_query.QueryObserverResult<TData, Error>>;
120
+ fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus, _tanstack_vue_query.FetchStatus>;
121
+ promise: vue.Ref<Promise<TData>, Promise<TData>>;
122
+ suspense: () => Promise<_tanstack_vue_query.DefinedQueryObserverResult<TData, Error>>;
123
+ queryKey: [string, string, string, unknown, {
124
+ infinite: boolean;
125
+ optimisticUpdate: boolean;
126
+ }];
127
+ };
128
+ declare function useInternalInfiniteQuery<TQueryFnData, TData>(_schema: SchemaDef, model: string, operation: string, args: MaybeRefOrGetter<unknown>, options: MaybeRefOrGetter<Omit<UnwrapRef<UseInfiniteQueryOptions<TQueryFnData, DefaultError, InfiniteData<TData>>>, 'queryKey' | 'initialPageParam'>> | undefined): {
129
+ data: vue.Ref<InfiniteData<unknown, unknown>, InfiniteData<unknown, unknown>>;
130
+ error: vue.Ref<Error, Error>;
131
+ isError: vue.Ref<true, true>;
132
+ isPending: vue.Ref<false, false>;
133
+ isLoading: vue.Ref<false, false>;
134
+ isLoadingError: vue.Ref<false, false>;
135
+ isRefetchError: vue.Ref<true, true>;
136
+ isSuccess: vue.Ref<false, false>;
137
+ isPlaceholderData: vue.Ref<false, false>;
138
+ status: vue.Ref<"error", "error">;
139
+ fetchNextPage: (options?: _tanstack_vue_query.FetchNextPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
140
+ fetchPreviousPage: (options?: _tanstack_vue_query.FetchPreviousPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
141
+ hasNextPage: vue.Ref<boolean, boolean>;
142
+ hasPreviousPage: vue.Ref<boolean, boolean>;
143
+ isFetchNextPageError: vue.Ref<boolean, boolean>;
144
+ isFetchingNextPage: vue.Ref<boolean, boolean>;
145
+ isFetchPreviousPageError: vue.Ref<boolean, boolean>;
146
+ isFetchingPreviousPage: vue.Ref<boolean, boolean>;
147
+ dataUpdatedAt: vue.Ref<number, number>;
148
+ errorUpdatedAt: vue.Ref<number, number>;
149
+ failureCount: vue.Ref<number, number>;
150
+ failureReason: vue.Ref<Error | null, Error | null>;
151
+ errorUpdateCount: vue.Ref<number, number>;
152
+ isFetched: vue.Ref<boolean, boolean>;
153
+ isFetchedAfterMount: vue.Ref<boolean, boolean>;
154
+ isFetching: vue.Ref<boolean, boolean>;
155
+ isInitialLoading: vue.Ref<boolean, boolean>;
156
+ isPaused: vue.Ref<boolean, boolean>;
157
+ isRefetching: vue.Ref<boolean, boolean>;
158
+ isStale: vue.Ref<boolean, boolean>;
159
+ isEnabled: vue.Ref<boolean, boolean>;
160
+ refetch: (options?: _tanstack_vue_query.RefetchOptions) => Promise<_tanstack_vue_query.QueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
161
+ fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus, _tanstack_vue_query.FetchStatus>;
162
+ promise: vue.Ref<Promise<InfiniteData<unknown, unknown>>, Promise<InfiniteData<unknown, unknown>>>;
163
+ suspense: () => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
164
+ queryKey: [string, string, string, unknown, {
165
+ infinite: boolean;
166
+ optimisticUpdate: boolean;
167
+ }];
168
+ } | {
169
+ data: vue.Ref<InfiniteData<unknown, unknown>, InfiniteData<unknown, unknown>>;
170
+ error: vue.Ref<null, null>;
171
+ isError: vue.Ref<false, false>;
172
+ isPending: vue.Ref<false, false>;
173
+ isLoading: vue.Ref<false, false>;
174
+ isLoadingError: vue.Ref<false, false>;
175
+ isRefetchError: vue.Ref<false, false>;
176
+ isFetchNextPageError: vue.Ref<false, false>;
177
+ isFetchPreviousPageError: vue.Ref<false, false>;
178
+ isSuccess: vue.Ref<true, true>;
179
+ isPlaceholderData: vue.Ref<false, false>;
180
+ status: vue.Ref<"success", "success">;
181
+ fetchNextPage: (options?: _tanstack_vue_query.FetchNextPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
182
+ fetchPreviousPage: (options?: _tanstack_vue_query.FetchPreviousPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
183
+ hasNextPage: vue.Ref<boolean, boolean>;
184
+ hasPreviousPage: vue.Ref<boolean, boolean>;
185
+ isFetchingNextPage: vue.Ref<boolean, boolean>;
186
+ isFetchingPreviousPage: vue.Ref<boolean, boolean>;
187
+ dataUpdatedAt: vue.Ref<number, number>;
188
+ errorUpdatedAt: vue.Ref<number, number>;
189
+ failureCount: vue.Ref<number, number>;
190
+ failureReason: vue.Ref<Error | null, Error | null>;
191
+ errorUpdateCount: vue.Ref<number, number>;
192
+ isFetched: vue.Ref<boolean, boolean>;
193
+ isFetchedAfterMount: vue.Ref<boolean, boolean>;
194
+ isFetching: vue.Ref<boolean, boolean>;
195
+ isInitialLoading: vue.Ref<boolean, boolean>;
196
+ isPaused: vue.Ref<boolean, boolean>;
197
+ isRefetching: vue.Ref<boolean, boolean>;
198
+ isStale: vue.Ref<boolean, boolean>;
199
+ isEnabled: vue.Ref<boolean, boolean>;
200
+ refetch: (options?: _tanstack_vue_query.RefetchOptions) => Promise<_tanstack_vue_query.QueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
201
+ fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus, _tanstack_vue_query.FetchStatus>;
202
+ promise: vue.Ref<Promise<InfiniteData<unknown, unknown>>, Promise<InfiniteData<unknown, unknown>>>;
203
+ suspense: () => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
204
+ queryKey: [string, string, string, unknown, {
205
+ infinite: boolean;
206
+ optimisticUpdate: boolean;
207
+ }];
208
+ } | {
209
+ data: vue.Ref<undefined, undefined>;
210
+ error: vue.Ref<Error, Error>;
211
+ isError: vue.Ref<true, true>;
212
+ isPending: vue.Ref<false, false>;
213
+ isLoading: vue.Ref<false, false>;
214
+ isLoadingError: vue.Ref<true, true>;
215
+ isRefetchError: vue.Ref<false, false>;
216
+ isFetchNextPageError: vue.Ref<false, false>;
217
+ isFetchPreviousPageError: vue.Ref<false, false>;
218
+ isSuccess: vue.Ref<false, false>;
219
+ isPlaceholderData: vue.Ref<false, false>;
220
+ status: vue.Ref<"error", "error">;
221
+ fetchNextPage: (options?: _tanstack_vue_query.FetchNextPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
222
+ fetchPreviousPage: (options?: _tanstack_vue_query.FetchPreviousPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
223
+ hasNextPage: vue.Ref<boolean, boolean>;
224
+ hasPreviousPage: vue.Ref<boolean, boolean>;
225
+ isFetchingNextPage: vue.Ref<boolean, boolean>;
226
+ isFetchingPreviousPage: vue.Ref<boolean, boolean>;
227
+ dataUpdatedAt: vue.Ref<number, number>;
228
+ errorUpdatedAt: vue.Ref<number, number>;
229
+ failureCount: vue.Ref<number, number>;
230
+ failureReason: vue.Ref<Error | null, Error | null>;
231
+ errorUpdateCount: vue.Ref<number, number>;
232
+ isFetched: vue.Ref<boolean, boolean>;
233
+ isFetchedAfterMount: vue.Ref<boolean, boolean>;
234
+ isFetching: vue.Ref<boolean, boolean>;
235
+ isInitialLoading: vue.Ref<boolean, boolean>;
236
+ isPaused: vue.Ref<boolean, boolean>;
237
+ isRefetching: vue.Ref<boolean, boolean>;
238
+ isStale: vue.Ref<boolean, boolean>;
239
+ isEnabled: vue.Ref<boolean, boolean>;
240
+ refetch: (options?: _tanstack_vue_query.RefetchOptions) => Promise<_tanstack_vue_query.QueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
241
+ fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus, _tanstack_vue_query.FetchStatus>;
242
+ promise: vue.Ref<Promise<InfiniteData<unknown, unknown>>, Promise<InfiniteData<unknown, unknown>>>;
243
+ suspense: () => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
244
+ queryKey: [string, string, string, unknown, {
245
+ infinite: boolean;
246
+ optimisticUpdate: boolean;
247
+ }];
248
+ } | {
249
+ data: vue.Ref<undefined, undefined>;
250
+ error: vue.Ref<null, null>;
251
+ isError: vue.Ref<false, false>;
252
+ isPending: vue.Ref<true, true>;
253
+ isLoading: vue.Ref<true, true>;
254
+ isLoadingError: vue.Ref<false, false>;
255
+ isRefetchError: vue.Ref<false, false>;
256
+ isFetchNextPageError: vue.Ref<false, false>;
257
+ isFetchPreviousPageError: vue.Ref<false, false>;
258
+ isSuccess: vue.Ref<false, false>;
259
+ isPlaceholderData: vue.Ref<false, false>;
260
+ status: vue.Ref<"pending", "pending">;
261
+ fetchNextPage: (options?: _tanstack_vue_query.FetchNextPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
262
+ fetchPreviousPage: (options?: _tanstack_vue_query.FetchPreviousPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
263
+ hasNextPage: vue.Ref<boolean, boolean>;
264
+ hasPreviousPage: vue.Ref<boolean, boolean>;
265
+ isFetchingNextPage: vue.Ref<boolean, boolean>;
266
+ isFetchingPreviousPage: vue.Ref<boolean, boolean>;
267
+ dataUpdatedAt: vue.Ref<number, number>;
268
+ errorUpdatedAt: vue.Ref<number, number>;
269
+ failureCount: vue.Ref<number, number>;
270
+ failureReason: vue.Ref<Error | null, Error | null>;
271
+ errorUpdateCount: vue.Ref<number, number>;
272
+ isFetched: vue.Ref<boolean, boolean>;
273
+ isFetchedAfterMount: vue.Ref<boolean, boolean>;
274
+ isFetching: vue.Ref<boolean, boolean>;
275
+ isInitialLoading: vue.Ref<boolean, boolean>;
276
+ isPaused: vue.Ref<boolean, boolean>;
277
+ isRefetching: vue.Ref<boolean, boolean>;
278
+ isStale: vue.Ref<boolean, boolean>;
279
+ isEnabled: vue.Ref<boolean, boolean>;
280
+ refetch: (options?: _tanstack_vue_query.RefetchOptions) => Promise<_tanstack_vue_query.QueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
281
+ fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus, _tanstack_vue_query.FetchStatus>;
282
+ promise: vue.Ref<Promise<InfiniteData<unknown, unknown>>, Promise<InfiniteData<unknown, unknown>>>;
283
+ suspense: () => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
284
+ queryKey: [string, string, string, unknown, {
285
+ infinite: boolean;
286
+ optimisticUpdate: boolean;
287
+ }];
288
+ } | {
289
+ data: vue.Ref<undefined, undefined>;
290
+ error: vue.Ref<null, null>;
291
+ isError: vue.Ref<false, false>;
292
+ isPending: vue.Ref<true, true>;
293
+ isLoadingError: vue.Ref<false, false>;
294
+ isRefetchError: vue.Ref<false, false>;
295
+ isFetchNextPageError: vue.Ref<false, false>;
296
+ isFetchPreviousPageError: vue.Ref<false, false>;
297
+ isSuccess: vue.Ref<false, false>;
298
+ isPlaceholderData: vue.Ref<false, false>;
299
+ status: vue.Ref<"pending", "pending">;
300
+ fetchNextPage: (options?: _tanstack_vue_query.FetchNextPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
301
+ fetchPreviousPage: (options?: _tanstack_vue_query.FetchPreviousPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
302
+ hasNextPage: vue.Ref<boolean, boolean>;
303
+ hasPreviousPage: vue.Ref<boolean, boolean>;
304
+ isFetchingNextPage: vue.Ref<boolean, boolean>;
305
+ isFetchingPreviousPage: vue.Ref<boolean, boolean>;
306
+ dataUpdatedAt: vue.Ref<number, number>;
307
+ errorUpdatedAt: vue.Ref<number, number>;
308
+ failureCount: vue.Ref<number, number>;
309
+ failureReason: vue.Ref<Error | null, Error | null>;
310
+ errorUpdateCount: vue.Ref<number, number>;
311
+ isFetched: vue.Ref<boolean, boolean>;
312
+ isFetchedAfterMount: vue.Ref<boolean, boolean>;
313
+ isFetching: vue.Ref<boolean, boolean>;
314
+ isLoading: vue.Ref<boolean, boolean>;
315
+ isInitialLoading: vue.Ref<boolean, boolean>;
316
+ isPaused: vue.Ref<boolean, boolean>;
317
+ isRefetching: vue.Ref<boolean, boolean>;
318
+ isStale: vue.Ref<boolean, boolean>;
319
+ isEnabled: vue.Ref<boolean, boolean>;
320
+ refetch: (options?: _tanstack_vue_query.RefetchOptions) => Promise<_tanstack_vue_query.QueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
321
+ fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus, _tanstack_vue_query.FetchStatus>;
322
+ promise: vue.Ref<Promise<InfiniteData<unknown, unknown>>, Promise<InfiniteData<unknown, unknown>>>;
323
+ suspense: () => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
324
+ queryKey: [string, string, string, unknown, {
325
+ infinite: boolean;
326
+ optimisticUpdate: boolean;
327
+ }];
328
+ } | {
329
+ data: vue.Ref<InfiniteData<unknown, unknown>, InfiniteData<unknown, unknown>>;
330
+ isError: vue.Ref<false, false>;
331
+ error: vue.Ref<null, null>;
332
+ isPending: vue.Ref<false, false>;
333
+ isLoading: vue.Ref<false, false>;
334
+ isLoadingError: vue.Ref<false, false>;
335
+ isRefetchError: vue.Ref<false, false>;
336
+ isSuccess: vue.Ref<true, true>;
337
+ isPlaceholderData: vue.Ref<true, true>;
338
+ isFetchNextPageError: vue.Ref<false, false>;
339
+ isFetchPreviousPageError: vue.Ref<false, false>;
340
+ status: vue.Ref<"success", "success">;
341
+ fetchNextPage: (options?: _tanstack_vue_query.FetchNextPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
342
+ fetchPreviousPage: (options?: _tanstack_vue_query.FetchPreviousPageOptions) => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
343
+ hasNextPage: vue.Ref<boolean, boolean>;
344
+ hasPreviousPage: vue.Ref<boolean, boolean>;
345
+ isFetchingNextPage: vue.Ref<boolean, boolean>;
346
+ isFetchingPreviousPage: vue.Ref<boolean, boolean>;
347
+ dataUpdatedAt: vue.Ref<number, number>;
348
+ errorUpdatedAt: vue.Ref<number, number>;
349
+ failureCount: vue.Ref<number, number>;
350
+ failureReason: vue.Ref<Error | null, Error | null>;
351
+ errorUpdateCount: vue.Ref<number, number>;
352
+ isFetched: vue.Ref<boolean, boolean>;
353
+ isFetchedAfterMount: vue.Ref<boolean, boolean>;
354
+ isFetching: vue.Ref<boolean, boolean>;
355
+ isInitialLoading: vue.Ref<boolean, boolean>;
356
+ isPaused: vue.Ref<boolean, boolean>;
357
+ isRefetching: vue.Ref<boolean, boolean>;
358
+ isStale: vue.Ref<boolean, boolean>;
359
+ isEnabled: vue.Ref<boolean, boolean>;
360
+ refetch: (options?: _tanstack_vue_query.RefetchOptions) => Promise<_tanstack_vue_query.QueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
361
+ fetchStatus: vue.Ref<_tanstack_vue_query.FetchStatus, _tanstack_vue_query.FetchStatus>;
362
+ promise: vue.Ref<Promise<InfiniteData<unknown, unknown>>, Promise<InfiniteData<unknown, unknown>>>;
363
+ suspense: () => Promise<_tanstack_vue_query.InfiniteQueryObserverResult<InfiniteData<unknown, unknown>, Error>>;
364
+ queryKey: [string, string, string, unknown, {
365
+ infinite: boolean;
366
+ optimisticUpdate: boolean;
367
+ }];
368
+ };
369
+ /**
370
+ * Creates a vue-query mutation
371
+ *
372
+ * @private
373
+ *
374
+ * @param model The name of the model under mutation.
375
+ * @param method The HTTP method.
376
+ * @param operation The mutation operation (e.g. `create`).
377
+ * @param options The vue-query options.
378
+ * @param checkReadBack Whether to check for read back errors and return undefined if found.
379
+ */
380
+ declare function useInternalMutation<TArgs, R = any>(schema: SchemaDef, model: string, method: 'POST' | 'PUT' | 'DELETE', operation: string, options?: MaybeRefOrGetter<Omit<UnwrapRef<UseMutationOptions<R, DefaultError, TArgs>>, 'mutationFn'> & ExtraMutationOptions>): UseMutationReturnType<unknown, Error, void, unknown, Omit<_tanstack_vue_query.MutationObserverIdleResult<unknown, Error, void, unknown>, "mutate" | "reset"> | Omit<_tanstack_vue_query.MutationObserverLoadingResult<unknown, Error, void, unknown>, "mutate" | "reset"> | Omit<_tanstack_vue_query.MutationObserverErrorResult<unknown, Error, void, unknown>, "mutate" | "reset"> | Omit<_tanstack_vue_query.MutationObserverSuccessResult<unknown, Error, void, unknown>, "mutate" | "reset">>;
381
+
382
+ export { type ClientHooks, type ModelInfiniteQueryOptions, type ModelInfiniteQueryResult, type ModelMutationModelResult, type ModelMutationOptions, type ModelMutationResult, type ModelQueryHooks, type ModelQueryOptions, type ModelQueryResult, VueQueryContextKey, provideHooksContext, provideQuerySettingsContext, useClientQueries, useInternalInfiniteQuery, useInternalMutation, useInternalQuery, useModelQueries };