@openapi-qraft/react 1.1.5 → 1.3.2
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/CHANGELOG.md +32 -0
- package/README.md +142 -46
- package/dist/QraftContext.d.ts +14 -5
- package/dist/QraftContext.d.ts.map +1 -1
- package/dist/QraftContext.js.map +1 -1
- package/dist/ServiceOperation.d.ts +112 -3
- package/dist/ServiceOperation.d.ts.map +1 -1
- package/dist/callbacks/cancelQueries.d.ts +2 -2
- package/dist/callbacks/cancelQueries.d.ts.map +1 -1
- package/dist/callbacks/cancelQueries.js.map +1 -1
- package/dist/callbacks/fetchInfiniteQuery.d.ts +7 -0
- package/dist/callbacks/fetchInfiniteQuery.d.ts.map +1 -0
- package/dist/callbacks/fetchInfiniteQuery.js +5 -0
- package/dist/callbacks/fetchInfiniteQuery.js.map +1 -0
- package/dist/callbacks/fetchQuery.d.ts +7 -0
- package/dist/callbacks/fetchQuery.d.ts.map +1 -0
- package/dist/callbacks/fetchQuery.js +5 -0
- package/dist/callbacks/fetchQuery.js.map +1 -0
- package/dist/callbacks/getInfiniteQueryData.d.ts +4 -4
- package/dist/callbacks/getInfiniteQueryData.d.ts.map +1 -1
- package/dist/callbacks/getInfiniteQueryData.js +3 -6
- package/dist/callbacks/getInfiniteQueryData.js.map +1 -1
- package/dist/callbacks/getInfiniteQueryKey.d.ts +2 -2
- package/dist/callbacks/getInfiniteQueryKey.d.ts.map +1 -1
- package/dist/callbacks/getInfiniteQueryKey.js.map +1 -1
- package/dist/callbacks/getMutationKey.d.ts +2 -2
- package/dist/callbacks/getMutationKey.d.ts.map +1 -1
- package/dist/callbacks/getMutationKey.js.map +1 -1
- package/dist/callbacks/getQueryData.d.ts +3 -3
- package/dist/callbacks/getQueryData.d.ts.map +1 -1
- package/dist/callbacks/getQueryData.js +3 -4
- package/dist/callbacks/getQueryData.js.map +1 -1
- package/dist/callbacks/getQueryKey.d.ts +2 -2
- package/dist/callbacks/getQueryKey.d.ts.map +1 -1
- package/dist/callbacks/getQueryKey.js.map +1 -1
- package/dist/callbacks/invalidateQueries.d.ts +2 -2
- package/dist/callbacks/invalidateQueries.d.ts.map +1 -1
- package/dist/callbacks/invalidateQueries.js.map +1 -1
- package/dist/callbacks/isFetching.d.ts +2 -2
- package/dist/callbacks/isFetching.d.ts.map +1 -1
- package/dist/callbacks/isFetching.js.map +1 -1
- package/dist/callbacks/mutationFn.d.ts +2 -2
- package/dist/callbacks/mutationFn.d.ts.map +1 -1
- package/dist/callbacks/mutationFn.js.map +1 -1
- package/dist/callbacks/prefetchInfiniteQuery.d.ts +7 -0
- package/dist/callbacks/prefetchInfiniteQuery.d.ts.map +1 -0
- package/dist/callbacks/prefetchInfiniteQuery.js +5 -0
- package/dist/callbacks/prefetchInfiniteQuery.js.map +1 -0
- package/dist/callbacks/prefetchQuery.d.ts +7 -0
- package/dist/callbacks/prefetchQuery.d.ts.map +1 -0
- package/dist/callbacks/prefetchQuery.js +5 -0
- package/dist/callbacks/prefetchQuery.js.map +1 -0
- package/dist/callbacks/queryFn.js.map +1 -1
- package/dist/callbacks/refetchQueries.d.ts +3 -3
- package/dist/callbacks/refetchQueries.d.ts.map +1 -1
- package/dist/callbacks/refetchQueries.js.map +1 -1
- package/dist/callbacks/resetQueries.d.ts +2 -2
- package/dist/callbacks/resetQueries.d.ts.map +1 -1
- package/dist/callbacks/resetQueries.js.map +1 -1
- package/dist/callbacks/setInfiniteQueryData.d.ts +2 -2
- package/dist/callbacks/setInfiniteQueryData.d.ts.map +1 -1
- package/dist/callbacks/setInfiniteQueryData.js +2 -6
- package/dist/callbacks/setInfiniteQueryData.js.map +1 -1
- package/dist/callbacks/setQueryData.d.ts +3 -3
- package/dist/callbacks/setQueryData.d.ts.map +1 -1
- package/dist/callbacks/setQueryData.js +3 -7
- package/dist/callbacks/setQueryData.js.map +1 -1
- package/dist/callbacks/useInfiniteQuery.d.ts +4 -4
- package/dist/callbacks/useInfiniteQuery.d.ts.map +1 -1
- package/dist/callbacks/useInfiniteQuery.js +5 -24
- package/dist/callbacks/useInfiniteQuery.js.map +1 -1
- package/dist/callbacks/useIsFetching.d.ts +2 -2
- package/dist/callbacks/useIsFetching.d.ts.map +1 -1
- package/dist/callbacks/useIsFetching.js +3 -8
- package/dist/callbacks/useIsFetching.js.map +1 -1
- package/dist/callbacks/useMutation.d.ts +2 -2
- package/dist/callbacks/useMutation.d.ts.map +1 -1
- package/dist/callbacks/useMutation.js +11 -8
- package/dist/callbacks/useMutation.js.map +1 -1
- package/dist/callbacks/useMutationState.d.ts +2 -2
- package/dist/callbacks/useMutationState.d.ts.map +1 -1
- package/dist/callbacks/useMutationState.js +3 -7
- package/dist/callbacks/useMutationState.js.map +1 -1
- package/dist/callbacks/useQueries.d.ts +2 -2
- package/dist/callbacks/useQueries.d.ts.map +1 -1
- package/dist/callbacks/useQueries.js +9 -6
- package/dist/callbacks/useQueries.js.map +1 -1
- package/dist/callbacks/useQuery.d.ts +4 -4
- package/dist/callbacks/useQuery.d.ts.map +1 -1
- package/dist/callbacks/useQuery.js +5 -23
- package/dist/callbacks/useQuery.js.map +1 -1
- package/dist/callbacks/useSuspenseInfiniteQuery.d.ts +4 -4
- package/dist/callbacks/useSuspenseInfiniteQuery.d.ts.map +1 -1
- package/dist/callbacks/useSuspenseInfiniteQuery.js +5 -24
- package/dist/callbacks/useSuspenseInfiniteQuery.js.map +1 -1
- package/dist/callbacks/useSuspenseQueries.d.ts +2 -2
- package/dist/callbacks/useSuspenseQueries.d.ts.map +1 -1
- package/dist/callbacks/useSuspenseQueries.js +9 -6
- package/dist/callbacks/useSuspenseQueries.js.map +1 -1
- package/dist/callbacks/useSuspenseQuery.d.ts +4 -4
- package/dist/callbacks/useSuspenseQuery.d.ts.map +1 -1
- package/dist/callbacks/useSuspenseQuery.js +5 -23
- package/dist/callbacks/useSuspenseQuery.js.map +1 -1
- package/dist/index.d.ts +3 -7
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/lib/callQueryClientFetchMethod.d.ts +20 -0
- package/dist/lib/callQueryClientFetchMethod.d.ts.map +1 -0
- package/dist/lib/callQueryClientFetchMethod.js +48 -0
- package/dist/lib/callQueryClientFetchMethod.js.map +1 -0
- package/dist/lib/callQueryClientMethodWithQueryFilters.d.ts +2 -2
- package/dist/lib/callQueryClientMethodWithQueryFilters.d.ts.map +1 -1
- package/dist/lib/callQueryClientMethodWithQueryFilters.js +5 -13
- package/dist/lib/callQueryClientMethodWithQueryFilters.js.map +1 -1
- package/dist/lib/callQueryClientMethodWithQueryKey.d.ts +11 -0
- package/dist/lib/callQueryClientMethodWithQueryKey.d.ts.map +1 -0
- package/dist/lib/callQueryClientMethodWithQueryKey.js +22 -0
- package/dist/lib/callQueryClientMethodWithQueryKey.js.map +1 -0
- package/dist/lib/composeInfiniteQueryKey.d.ts +3 -3
- package/dist/lib/composeInfiniteQueryKey.d.ts.map +1 -1
- package/dist/lib/composeMutationKey.d.ts +4 -4
- package/dist/lib/composeMutationKey.d.ts.map +1 -1
- package/dist/lib/composeMutationKey.js.map +1 -1
- package/dist/lib/composeQueryFilters.d.ts +3 -3
- package/dist/lib/composeQueryFilters.d.ts.map +1 -1
- package/dist/lib/composeQueryFilters.js.map +1 -1
- package/dist/lib/composeQueryKey.d.ts +3 -3
- package/dist/lib/composeQueryKey.d.ts.map +1 -1
- package/dist/lib/requestFn.d.ts +75 -0
- package/dist/lib/requestFn.d.ts.map +1 -0
- package/dist/lib/{request.js → requestFn.js} +40 -34
- package/dist/lib/requestFn.js.map +1 -0
- package/dist/lib/useComposeUseQueryOptions.d.ts +16 -0
- package/dist/lib/useComposeUseQueryOptions.d.ts.map +1 -0
- package/dist/lib/useComposeUseQueryOptions.js +40 -0
- package/dist/lib/useComposeUseQueryOptions.js.map +1 -0
- package/dist/lib/useQueryClient.d.ts +9 -0
- package/dist/lib/useQueryClient.d.ts.map +1 -0
- package/dist/lib/useQueryClient.js +15 -0
- package/dist/lib/useQueryClient.js.map +1 -0
- package/dist/qraftAPIClient.d.ts +7 -7
- package/dist/qraftAPIClient.d.ts.map +1 -1
- package/package.json +2 -2
- package/src/QraftContext.ts +22 -10
- package/src/ServiceOperation.ts +261 -4
- package/src/callbacks/cancelQueries.ts +3 -3
- package/src/callbacks/fetchInfiniteQuery.ts +22 -0
- package/src/callbacks/fetchQuery.ts +20 -0
- package/src/callbacks/getInfiniteQueryData.ts +13 -16
- package/src/callbacks/getInfiniteQueryKey.ts +3 -3
- package/src/callbacks/getMutationKey.ts +3 -3
- package/src/callbacks/getQueryData.ts +12 -10
- package/src/callbacks/getQueryKey.ts +3 -3
- package/src/callbacks/invalidateQueries.ts +3 -3
- package/src/callbacks/isFetching.ts +3 -3
- package/src/callbacks/mutationFn.ts +3 -3
- package/src/callbacks/prefetchInfiniteQuery.ts +22 -0
- package/src/callbacks/prefetchQuery.ts +22 -0
- package/src/callbacks/queryFn.ts +2 -2
- package/src/callbacks/refetchQueries.ts +4 -4
- package/src/callbacks/resetQueries.ts +3 -3
- package/src/callbacks/setInfiniteQueryData.ts +11 -18
- package/src/callbacks/setQueryData.ts +16 -17
- package/src/callbacks/useInfiniteQuery.ts +8 -46
- package/src/callbacks/useIsFetching.ts +6 -20
- package/src/callbacks/useMutation.ts +13 -12
- package/src/callbacks/useMutationState.ts +5 -11
- package/src/callbacks/useQueries.ts +11 -10
- package/src/callbacks/useQuery.ts +8 -39
- package/src/callbacks/useSuspenseInfiniteQuery.ts +8 -42
- package/src/callbacks/useSuspenseQueries.ts +11 -10
- package/src/callbacks/useSuspenseQuery.ts +8 -43
- package/src/index.ts +12 -7
- package/src/lib/callQueryClientFetchMethod.ts +90 -0
- package/src/lib/callQueryClientMethodWithQueryFilters.ts +10 -23
- package/src/lib/callQueryClientMethodWithQueryKey.ts +46 -0
- package/src/lib/composeInfiniteQueryKey.ts +3 -3
- package/src/lib/composeMutationKey.ts +5 -8
- package/src/lib/composeQueryFilters.ts +2 -2
- package/src/lib/composeQueryKey.ts +3 -3
- package/src/lib/{request.ts → requestFn.ts} +143 -79
- package/src/lib/useComposeUseQueryOptions.ts +64 -0
- package/src/lib/useQueryClient.ts +26 -0
- package/src/qraftAPIClient.ts +8 -8
- package/dist/RequestClient.d.ts +0 -19
- package/dist/RequestClient.d.ts.map +0 -1
- package/dist/RequestClient.js +0 -2
- package/dist/RequestClient.js.map +0 -1
- package/dist/lib/request.d.ts +0 -32
- package/dist/lib/request.d.ts.map +0 -1
- package/dist/lib/request.js.map +0 -1
- package/src/RequestClient.ts +0 -32
package/src/ServiceOperation.ts
CHANGED
|
@@ -12,10 +12,14 @@ import {
|
|
|
12
12
|
QueriesPlaceholderDataFunction,
|
|
13
13
|
Query,
|
|
14
14
|
QueryClient,
|
|
15
|
+
FetchQueryOptions,
|
|
15
16
|
RefetchOptions,
|
|
16
17
|
ResetOptions,
|
|
17
18
|
SetDataOptions,
|
|
18
19
|
Updater,
|
|
20
|
+
QueryFunction,
|
|
21
|
+
InitialPageParam,
|
|
22
|
+
GetNextPageParamFunction,
|
|
19
23
|
} from '@tanstack/query-core';
|
|
20
24
|
import type {
|
|
21
25
|
DefinedInitialDataInfiniteOptions,
|
|
@@ -35,6 +39,8 @@ import type {
|
|
|
35
39
|
UseSuspenseQueryResult,
|
|
36
40
|
} from '@tanstack/react-query';
|
|
37
41
|
|
|
42
|
+
import type { RequestFn } from './lib/requestFn.js';
|
|
43
|
+
|
|
38
44
|
export type ServiceOperationQueryKey<
|
|
39
45
|
S extends { url: string; method: string },
|
|
40
46
|
T,
|
|
@@ -63,6 +69,8 @@ export interface ServiceOperationQuery<
|
|
|
63
69
|
ServiceOperationUseSuspenseInfiniteQuery<TSchema, TData, TParams, TError>,
|
|
64
70
|
ServiceOperationUseIsFetchingQueries<TSchema, TData, TParams, TError>,
|
|
65
71
|
ServiceOperationQueryFn<TSchema, TData, TParams>,
|
|
72
|
+
ServiceOperationFetchQuery<TSchema, TData, TParams, TError>,
|
|
73
|
+
ServiceOperationFetchInfiniteQuery<TSchema, TData, TParams, TError>,
|
|
66
74
|
ServiceOperationGetQueryData<TSchema, TData, TParams>,
|
|
67
75
|
ServiceOperationGetInfiniteQueryData<TSchema, TData, TParams>,
|
|
68
76
|
ServiceOperationSetQueryData<TSchema, TData, TParams>,
|
|
@@ -118,6 +126,232 @@ interface ServiceOperationUseQuery<
|
|
|
118
126
|
): DefinedUseQueryResult<TData, TError | Error>;
|
|
119
127
|
}
|
|
120
128
|
|
|
129
|
+
type FetchQueryOptionsBase<
|
|
130
|
+
TSchema extends { url: string; method: string },
|
|
131
|
+
TData,
|
|
132
|
+
TParams = {},
|
|
133
|
+
TError = DefaultError,
|
|
134
|
+
> = Omit<
|
|
135
|
+
FetchQueryOptions<
|
|
136
|
+
TData,
|
|
137
|
+
TError,
|
|
138
|
+
TData,
|
|
139
|
+
ServiceOperationQueryKey<TSchema, TParams>
|
|
140
|
+
>,
|
|
141
|
+
'queryKey' | 'queryFn'
|
|
142
|
+
>;
|
|
143
|
+
|
|
144
|
+
interface FetchQueryOptionsByQueryKey<
|
|
145
|
+
TSchema extends { url: string; method: string },
|
|
146
|
+
TData,
|
|
147
|
+
TParams = {},
|
|
148
|
+
TError = DefaultError,
|
|
149
|
+
> extends FetchQueryOptionsBase<TSchema, TData, TParams, TError> {
|
|
150
|
+
/**
|
|
151
|
+
* Fetch Queries by query key
|
|
152
|
+
*/
|
|
153
|
+
queryKey?: ServiceOperationQueryKey<TSchema, TParams>;
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
interface FetchQueryOptionsByParameters<
|
|
157
|
+
TSchema extends { url: string; method: string },
|
|
158
|
+
TData,
|
|
159
|
+
TParams = {},
|
|
160
|
+
TError = DefaultError,
|
|
161
|
+
> extends FetchQueryOptionsBase<TSchema, TData, TParams, TError> {
|
|
162
|
+
/**
|
|
163
|
+
* Fetch Queries by parameters
|
|
164
|
+
*/
|
|
165
|
+
parameters?: TParams;
|
|
166
|
+
queryKey?: never;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
type FetchQueryOptionsQueryFn<
|
|
170
|
+
TSchema extends { url: string; method: string },
|
|
171
|
+
TData,
|
|
172
|
+
TParams = {},
|
|
173
|
+
> =
|
|
174
|
+
| {
|
|
175
|
+
queryFn?: QueryFunction<
|
|
176
|
+
TData,
|
|
177
|
+
ServiceOperationQueryKey<TSchema, TParams>
|
|
178
|
+
>;
|
|
179
|
+
}
|
|
180
|
+
| {
|
|
181
|
+
requestFn: RequestFn<TData>;
|
|
182
|
+
/**
|
|
183
|
+
* Base URL to use for the request (used in the `queryFn`)
|
|
184
|
+
* @example 'https://api.example.com'
|
|
185
|
+
*/
|
|
186
|
+
baseUrl: string | undefined;
|
|
187
|
+
queryFn?: never; // Workaround to fix union type error
|
|
188
|
+
};
|
|
189
|
+
|
|
190
|
+
interface ServiceOperationFetchQuery<
|
|
191
|
+
TSchema extends { url: string; method: string },
|
|
192
|
+
TData,
|
|
193
|
+
TParams = {},
|
|
194
|
+
TError = DefaultError,
|
|
195
|
+
> {
|
|
196
|
+
fetchQuery(
|
|
197
|
+
options:
|
|
198
|
+
| (FetchQueryOptionsByQueryKey<TSchema, TData, TParams, TError> &
|
|
199
|
+
FetchQueryOptionsQueryFn<TSchema, TData, TParams>)
|
|
200
|
+
| (FetchQueryOptionsByParameters<TSchema, TData, TParams, TError> &
|
|
201
|
+
FetchQueryOptionsQueryFn<TSchema, TData, TParams>),
|
|
202
|
+
queryClient: QueryClient
|
|
203
|
+
): Promise<TData>;
|
|
204
|
+
prefetchQuery(
|
|
205
|
+
options:
|
|
206
|
+
| (FetchQueryOptionsByQueryKey<TSchema, TData, TParams, TError> &
|
|
207
|
+
FetchQueryOptionsQueryFn<TSchema, TData, TParams>)
|
|
208
|
+
| (FetchQueryOptionsByParameters<TSchema, TData, TParams, TError> &
|
|
209
|
+
FetchQueryOptionsQueryFn<TSchema, TData, TParams>),
|
|
210
|
+
queryClient: QueryClient
|
|
211
|
+
): Promise<void>;
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
type FetchInfiniteQueryOptionsBase<
|
|
215
|
+
TSchema extends { url: string; method: string },
|
|
216
|
+
TData,
|
|
217
|
+
TParams = {},
|
|
218
|
+
TPageParam = unknown,
|
|
219
|
+
TError = DefaultError,
|
|
220
|
+
> = Omit<
|
|
221
|
+
FetchQueryOptions<
|
|
222
|
+
TData,
|
|
223
|
+
TError,
|
|
224
|
+
InfiniteData<TData, TPageParam>,
|
|
225
|
+
ServiceOperationQueryKey<TSchema, TParams>,
|
|
226
|
+
TPageParam
|
|
227
|
+
>,
|
|
228
|
+
'queryKey'
|
|
229
|
+
> &
|
|
230
|
+
InitialPageParam<PartialParameters<TPageParam>> &
|
|
231
|
+
FetchInfiniteQueryPages<TData, TPageParam>;
|
|
232
|
+
|
|
233
|
+
type FetchInfiniteQueryPages<TData = unknown, TPageParam = unknown> =
|
|
234
|
+
| {
|
|
235
|
+
pages?: never;
|
|
236
|
+
}
|
|
237
|
+
| {
|
|
238
|
+
pages: number;
|
|
239
|
+
getNextPageParam: GetNextPageParamFunction<
|
|
240
|
+
PartialParameters<TPageParam>,
|
|
241
|
+
TData
|
|
242
|
+
>;
|
|
243
|
+
};
|
|
244
|
+
|
|
245
|
+
type FetchInfiniteQueryOptionsByQueryKey<
|
|
246
|
+
TSchema extends { url: string; method: string },
|
|
247
|
+
TData,
|
|
248
|
+
TParams = {},
|
|
249
|
+
TPageParam = {},
|
|
250
|
+
TError = DefaultError,
|
|
251
|
+
> = FetchInfiniteQueryOptionsBase<
|
|
252
|
+
TSchema,
|
|
253
|
+
TData,
|
|
254
|
+
TParams,
|
|
255
|
+
TPageParam,
|
|
256
|
+
TError
|
|
257
|
+
> & {
|
|
258
|
+
/**
|
|
259
|
+
* Fetch Queries by query key
|
|
260
|
+
*/
|
|
261
|
+
queryKey?: ServiceOperationInfiniteQueryKey<TSchema, TParams>;
|
|
262
|
+
parameters?: never;
|
|
263
|
+
};
|
|
264
|
+
|
|
265
|
+
type FetchInfiniteQueryOptionsByParameters<
|
|
266
|
+
TSchema extends { url: string; method: string },
|
|
267
|
+
TData,
|
|
268
|
+
TParams = {},
|
|
269
|
+
TPageParam = {},
|
|
270
|
+
TError = DefaultError,
|
|
271
|
+
> = FetchInfiniteQueryOptionsBase<
|
|
272
|
+
TSchema,
|
|
273
|
+
TData,
|
|
274
|
+
TParams,
|
|
275
|
+
TPageParam,
|
|
276
|
+
TError
|
|
277
|
+
> & {
|
|
278
|
+
/**
|
|
279
|
+
* Fetch Queries by parameters
|
|
280
|
+
*/
|
|
281
|
+
parameters?: TParams;
|
|
282
|
+
queryKey?: never;
|
|
283
|
+
};
|
|
284
|
+
|
|
285
|
+
type FetchInfiniteQueryOptionsQueryFn<
|
|
286
|
+
TSchema extends { url: string; method: string },
|
|
287
|
+
TData,
|
|
288
|
+
TParams = {},
|
|
289
|
+
> =
|
|
290
|
+
| {
|
|
291
|
+
queryFn?: QueryFunction<
|
|
292
|
+
TData,
|
|
293
|
+
ServiceOperationInfiniteQueryKey<TSchema, TParams>
|
|
294
|
+
>;
|
|
295
|
+
}
|
|
296
|
+
| {
|
|
297
|
+
requestFn: RequestFn<TData>;
|
|
298
|
+
/**
|
|
299
|
+
* Base URL to use for the request (used in the `queryFn`)
|
|
300
|
+
* @example 'https://api.example.com'
|
|
301
|
+
*/
|
|
302
|
+
baseUrl: string | undefined;
|
|
303
|
+
queryFn?: never; // Workaround to fix union type error
|
|
304
|
+
};
|
|
305
|
+
|
|
306
|
+
interface ServiceOperationFetchInfiniteQuery<
|
|
307
|
+
TSchema extends { url: string; method: string },
|
|
308
|
+
TData,
|
|
309
|
+
TParams = {},
|
|
310
|
+
TError = DefaultError,
|
|
311
|
+
> {
|
|
312
|
+
fetchInfiniteQuery<TPageParam extends TParams>(
|
|
313
|
+
options:
|
|
314
|
+
| (FetchInfiniteQueryOptionsByQueryKey<
|
|
315
|
+
TSchema,
|
|
316
|
+
TData,
|
|
317
|
+
TParams,
|
|
318
|
+
TPageParam,
|
|
319
|
+
TError
|
|
320
|
+
> &
|
|
321
|
+
FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>)
|
|
322
|
+
| (FetchInfiniteQueryOptionsByParameters<
|
|
323
|
+
TSchema,
|
|
324
|
+
TData,
|
|
325
|
+
TParams,
|
|
326
|
+
TPageParam,
|
|
327
|
+
TError
|
|
328
|
+
> &
|
|
329
|
+
FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>),
|
|
330
|
+
queryClient: QueryClient
|
|
331
|
+
): Promise<InfiniteData<TData, TPageParam>>;
|
|
332
|
+
|
|
333
|
+
prefetchInfiniteQuery<TPageParam extends TParams>(
|
|
334
|
+
options:
|
|
335
|
+
| (FetchInfiniteQueryOptionsByQueryKey<
|
|
336
|
+
TSchema,
|
|
337
|
+
TData,
|
|
338
|
+
TParams,
|
|
339
|
+
TPageParam,
|
|
340
|
+
TError
|
|
341
|
+
> &
|
|
342
|
+
FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>)
|
|
343
|
+
| (FetchInfiniteQueryOptionsByParameters<
|
|
344
|
+
TSchema,
|
|
345
|
+
TData,
|
|
346
|
+
TParams,
|
|
347
|
+
TPageParam,
|
|
348
|
+
TError
|
|
349
|
+
> &
|
|
350
|
+
FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>),
|
|
351
|
+
queryClient: QueryClient
|
|
352
|
+
): Promise<void>;
|
|
353
|
+
}
|
|
354
|
+
|
|
121
355
|
interface ServiceOperationUseQueries<
|
|
122
356
|
TSchema extends { url: string; method: string },
|
|
123
357
|
TData,
|
|
@@ -138,7 +372,7 @@ interface ServiceOperationUseQueries<
|
|
|
138
372
|
> & {
|
|
139
373
|
placeholderData?: TData | QueriesPlaceholderDataFunction<TData>;
|
|
140
374
|
} & (
|
|
141
|
-
| { parameters: TParams }
|
|
375
|
+
| { parameters: TParams; queryKey?: never }
|
|
142
376
|
| { queryKey: ServiceOperationQueryKey<TSchema, TParams> }
|
|
143
377
|
)
|
|
144
378
|
>;
|
|
@@ -452,7 +686,7 @@ interface ServiceOperationUseSuspenseQueries<
|
|
|
452
686
|
'queryKey'
|
|
453
687
|
> &
|
|
454
688
|
(
|
|
455
|
-
| { parameters: TParams }
|
|
689
|
+
| { parameters: TParams; queryKey?: never }
|
|
456
690
|
| { queryKey: ServiceOperationQueryKey<TSchema, TParams> }
|
|
457
691
|
)
|
|
458
692
|
>;
|
|
@@ -736,6 +970,7 @@ interface QueryFnOptionsByParameters<
|
|
|
736
970
|
TSignal extends AbortSignal = AbortSignal,
|
|
737
971
|
> extends QueryFnOptionsBase<TMeta, TSignal> {
|
|
738
972
|
parameters: TParams;
|
|
973
|
+
queryKey?: never;
|
|
739
974
|
}
|
|
740
975
|
|
|
741
976
|
interface QueryFnOptionsByQueryKey<
|
|
@@ -795,8 +1030,30 @@ interface ServiceOperationSetQueryData<
|
|
|
795
1030
|
setQueryData(
|
|
796
1031
|
parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>,
|
|
797
1032
|
updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>,
|
|
798
|
-
|
|
799
|
-
|
|
1033
|
+
options: SetDataOptions,
|
|
1034
|
+
queryClient: QueryClient
|
|
1035
|
+
): TData | undefined;
|
|
1036
|
+
|
|
1037
|
+
setQueryData(
|
|
1038
|
+
parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>,
|
|
1039
|
+
updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>,
|
|
1040
|
+
queryClient: QueryClient
|
|
1041
|
+
): TData | undefined;
|
|
1042
|
+
}
|
|
1043
|
+
|
|
1044
|
+
/**
|
|
1045
|
+
* @internal
|
|
1046
|
+
*/
|
|
1047
|
+
export interface ServiceOperationSetQueryDataCallback<
|
|
1048
|
+
TSchema extends { url: string; method: string },
|
|
1049
|
+
TData,
|
|
1050
|
+
TParams = {},
|
|
1051
|
+
> extends ServiceOperationSetQueryData<TSchema, TData, TParams> {
|
|
1052
|
+
setQueryData(
|
|
1053
|
+
parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>,
|
|
1054
|
+
updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>,
|
|
1055
|
+
options: SetDataOptions | QueryClient,
|
|
1056
|
+
queryClient?: QueryClient
|
|
800
1057
|
): TData | undefined;
|
|
801
1058
|
}
|
|
802
1059
|
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { callQueryClientMethodWithQueryFilters } from '../lib/callQueryClientMethodWithQueryFilters.js';
|
|
2
|
+
import type { OperationSchema } from '../lib/requestFn.js';
|
|
2
3
|
import type { QraftClientOptions } from '../qraftAPIClient.js';
|
|
3
|
-
import type { RequestClientSchema } from '../RequestClient.js';
|
|
4
4
|
import { ServiceOperationCancelQueriesCallback } from '../ServiceOperation.js';
|
|
5
5
|
|
|
6
6
|
export function cancelQueries<TData>(
|
|
7
7
|
qraftOptions: QraftClientOptions | undefined,
|
|
8
|
-
schema:
|
|
8
|
+
schema: OperationSchema,
|
|
9
9
|
args: Parameters<
|
|
10
10
|
ServiceOperationCancelQueriesCallback<
|
|
11
|
-
|
|
11
|
+
OperationSchema,
|
|
12
12
|
unknown,
|
|
13
13
|
TData
|
|
14
14
|
>['cancelQueries']
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { callQueryClientMethodWithQueryKey } from '../lib/callQueryClientFetchMethod.js';
|
|
2
|
+
import type { QraftClientOptions } from '../qraftAPIClient.js';
|
|
3
|
+
import { ServiceOperationQuery } from '../ServiceOperation.js';
|
|
4
|
+
|
|
5
|
+
export const fetchInfiniteQuery: <
|
|
6
|
+
TSchema extends { url: string; method: 'get' | 'head' | 'options' },
|
|
7
|
+
TData,
|
|
8
|
+
TParams,
|
|
9
|
+
>(
|
|
10
|
+
_: QraftClientOptions | undefined,
|
|
11
|
+
schema: TSchema,
|
|
12
|
+
args: Parameters<
|
|
13
|
+
ServiceOperationQuery<TSchema, TData, TParams>['fetchInfiniteQuery']
|
|
14
|
+
>
|
|
15
|
+
) => Promise<TData> = (_, schema, args) => {
|
|
16
|
+
return callQueryClientMethodWithQueryKey(
|
|
17
|
+
'fetchInfiniteQuery',
|
|
18
|
+
schema,
|
|
19
|
+
true,
|
|
20
|
+
args as never
|
|
21
|
+
) as never;
|
|
22
|
+
};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { callQueryClientMethodWithQueryKey } from '../lib/callQueryClientFetchMethod.js';
|
|
2
|
+
import type { QraftClientOptions } from '../qraftAPIClient.js';
|
|
3
|
+
import { ServiceOperationQuery } from '../ServiceOperation.js';
|
|
4
|
+
|
|
5
|
+
export const fetchQuery: <
|
|
6
|
+
TSchema extends { url: string; method: 'get' | 'head' | 'options' },
|
|
7
|
+
TData,
|
|
8
|
+
TParams,
|
|
9
|
+
>(
|
|
10
|
+
_: QraftClientOptions | undefined,
|
|
11
|
+
schema: TSchema,
|
|
12
|
+
args: Parameters<ServiceOperationQuery<TSchema, TData, TParams>['fetchQuery']>
|
|
13
|
+
) => Promise<TData> = (_, schema, args) => {
|
|
14
|
+
return callQueryClientMethodWithQueryKey(
|
|
15
|
+
'fetchQuery',
|
|
16
|
+
schema,
|
|
17
|
+
false,
|
|
18
|
+
args as never
|
|
19
|
+
) as never;
|
|
20
|
+
};
|
|
@@ -1,28 +1,25 @@
|
|
|
1
|
-
import { InfiniteData } from '@tanstack/query-core';
|
|
1
|
+
import type { InfiniteData } from '@tanstack/query-core';
|
|
2
2
|
|
|
3
|
-
import {
|
|
3
|
+
import { callQueryClientMethodWithQueryKey } from '../lib/callQueryClientMethodWithQueryKey.js';
|
|
4
|
+
import type { OperationSchema } from '../lib/requestFn.js';
|
|
4
5
|
import type { QraftClientOptions } from '../qraftAPIClient.js';
|
|
5
|
-
import type {
|
|
6
|
-
import {
|
|
7
|
-
ServiceOperationInfiniteQueryKey,
|
|
8
|
-
ServiceOperationQuery,
|
|
9
|
-
} from '../ServiceOperation.js';
|
|
6
|
+
import type { ServiceOperationQuery } from '../ServiceOperation.js';
|
|
10
7
|
|
|
11
8
|
export function getInfiniteQueryData<TData>(
|
|
12
|
-
|
|
13
|
-
schema:
|
|
9
|
+
_: QraftClientOptions | undefined,
|
|
10
|
+
schema: OperationSchema,
|
|
14
11
|
args: Parameters<
|
|
15
12
|
ServiceOperationQuery<
|
|
16
|
-
|
|
13
|
+
OperationSchema,
|
|
17
14
|
unknown,
|
|
18
15
|
TData
|
|
19
16
|
>['getInfiniteQueryData']
|
|
20
17
|
>
|
|
21
18
|
): InfiniteData<TData> | undefined {
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
);
|
|
19
|
+
return callQueryClientMethodWithQueryKey(
|
|
20
|
+
'getQueryData',
|
|
21
|
+
schema,
|
|
22
|
+
true,
|
|
23
|
+
args as never
|
|
24
|
+
) as never;
|
|
28
25
|
}
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { composeInfiniteQueryKey } from '../lib/composeInfiniteQueryKey.js';
|
|
2
|
+
import type { OperationSchema } from '../lib/requestFn.js';
|
|
2
3
|
import type { QraftClientOptions } from '../qraftAPIClient.js';
|
|
3
|
-
import type { RequestClientSchema } from '../RequestClient.js';
|
|
4
4
|
import { ServiceOperationQuery } from '../ServiceOperation.js';
|
|
5
5
|
|
|
6
6
|
export const getInfiniteQueryKey = (
|
|
7
7
|
qraftOptions: QraftClientOptions | undefined,
|
|
8
|
-
schema:
|
|
8
|
+
schema: OperationSchema,
|
|
9
9
|
args: Parameters<
|
|
10
10
|
ServiceOperationQuery<
|
|
11
|
-
|
|
11
|
+
OperationSchema,
|
|
12
12
|
unknown,
|
|
13
13
|
unknown
|
|
14
14
|
>['getInfiniteQueryKey']
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { composeMutationKey } from '../lib/composeMutationKey.js';
|
|
2
|
+
import type { OperationSchema } from '../lib/requestFn.js';
|
|
2
3
|
import type { QraftClientOptions } from '../qraftAPIClient.js';
|
|
3
|
-
import type { RequestClientSchema } from '../RequestClient.js';
|
|
4
4
|
import { ServiceOperationMutation } from '../ServiceOperation.js';
|
|
5
5
|
|
|
6
6
|
export const getMutationKey = (
|
|
7
7
|
qraftOptions: QraftClientOptions | undefined,
|
|
8
|
-
schema:
|
|
8
|
+
schema: OperationSchema,
|
|
9
9
|
args: Parameters<
|
|
10
10
|
ServiceOperationMutation<
|
|
11
|
-
|
|
11
|
+
OperationSchema,
|
|
12
12
|
unknown,
|
|
13
13
|
unknown,
|
|
14
14
|
unknown
|
|
@@ -1,17 +1,19 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { callQueryClientMethodWithQueryKey } from '../lib/callQueryClientMethodWithQueryKey.js';
|
|
2
|
+
import type { OperationSchema } from '../lib/requestFn.js';
|
|
2
3
|
import type { QraftClientOptions } from '../qraftAPIClient.js';
|
|
3
|
-
import type {
|
|
4
|
-
import { ServiceOperationQuery } from '../ServiceOperation.js';
|
|
4
|
+
import type { ServiceOperationQuery } from '../ServiceOperation.js';
|
|
5
5
|
|
|
6
6
|
export function getQueryData<TData>(
|
|
7
|
-
|
|
8
|
-
schema:
|
|
7
|
+
_: QraftClientOptions | undefined,
|
|
8
|
+
schema: OperationSchema,
|
|
9
9
|
args: Parameters<
|
|
10
|
-
ServiceOperationQuery<
|
|
10
|
+
ServiceOperationQuery<OperationSchema, unknown, TData>['getQueryData']
|
|
11
11
|
>
|
|
12
12
|
): TData | undefined {
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
13
|
+
return callQueryClientMethodWithQueryKey(
|
|
14
|
+
'getQueryData',
|
|
15
|
+
schema,
|
|
16
|
+
false,
|
|
17
|
+
args as never
|
|
18
|
+
) as never;
|
|
17
19
|
}
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import { composeQueryKey } from '../lib/composeQueryKey.js';
|
|
2
|
+
import type { OperationSchema } from '../lib/requestFn.js';
|
|
2
3
|
import type { QraftClientOptions } from '../qraftAPIClient.js';
|
|
3
|
-
import type { RequestClientSchema } from '../RequestClient.js';
|
|
4
4
|
import { ServiceOperationQuery } from '../ServiceOperation.js';
|
|
5
5
|
|
|
6
6
|
export const getQueryKey = (
|
|
7
7
|
qraftOptions: QraftClientOptions | undefined,
|
|
8
|
-
schema:
|
|
8
|
+
schema: OperationSchema,
|
|
9
9
|
args: Parameters<
|
|
10
|
-
ServiceOperationQuery<
|
|
10
|
+
ServiceOperationQuery<OperationSchema, unknown, unknown>['getQueryKey']
|
|
11
11
|
>
|
|
12
12
|
) => {
|
|
13
13
|
return composeQueryKey(schema, args[0]);
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { callQueryClientMethodWithQueryFilters } from '../lib/callQueryClientMethodWithQueryFilters.js';
|
|
2
|
+
import type { OperationSchema } from '../lib/requestFn.js';
|
|
2
3
|
import type { QraftClientOptions } from '../qraftAPIClient.js';
|
|
3
|
-
import type { RequestClientSchema } from '../RequestClient.js';
|
|
4
4
|
import type { ServiceOperationInvalidateQueriesCallback } from '../ServiceOperation.js';
|
|
5
5
|
|
|
6
6
|
export function invalidateQueries<TData>(
|
|
7
7
|
qraftOptions: QraftClientOptions | undefined,
|
|
8
|
-
schema:
|
|
8
|
+
schema: OperationSchema,
|
|
9
9
|
args: Parameters<
|
|
10
10
|
ServiceOperationInvalidateQueriesCallback<
|
|
11
|
-
|
|
11
|
+
OperationSchema,
|
|
12
12
|
unknown,
|
|
13
13
|
TData
|
|
14
14
|
>['invalidateQueries']
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { callQueryClientMethodWithQueryFilters } from '../lib/callQueryClientMethodWithQueryFilters.js';
|
|
2
|
+
import type { OperationSchema } from '../lib/requestFn.js';
|
|
2
3
|
import type { QraftClientOptions } from '../qraftAPIClient.js';
|
|
3
|
-
import type { RequestClientSchema } from '../RequestClient.js';
|
|
4
4
|
import { ServiceOperationIsFetchingQueriesCallback } from '../ServiceOperation.js';
|
|
5
5
|
|
|
6
6
|
export function isFetching<TData>(
|
|
7
7
|
qraftOptions: QraftClientOptions | undefined,
|
|
8
|
-
schema:
|
|
8
|
+
schema: OperationSchema,
|
|
9
9
|
args: Parameters<
|
|
10
10
|
ServiceOperationIsFetchingQueriesCallback<
|
|
11
|
-
|
|
11
|
+
OperationSchema,
|
|
12
12
|
unknown,
|
|
13
13
|
TData
|
|
14
14
|
>['isFetching']
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
+
import type { OperationSchema } from '../lib/requestFn.js';
|
|
1
2
|
import type { QraftClientOptions } from '../qraftAPIClient.js';
|
|
2
|
-
import type { RequestClientSchema } from '../RequestClient.js';
|
|
3
3
|
import { ServiceOperationMutation } from '../ServiceOperation.js';
|
|
4
4
|
|
|
5
5
|
export const mutationFn = (
|
|
6
6
|
qraftOptions: QraftClientOptions | undefined,
|
|
7
|
-
schema:
|
|
7
|
+
schema: OperationSchema,
|
|
8
8
|
args: unknown
|
|
9
9
|
) => {
|
|
10
10
|
const [client, options] = args as Parameters<
|
|
11
11
|
ServiceOperationMutation<
|
|
12
|
-
|
|
12
|
+
OperationSchema,
|
|
13
13
|
unknown,
|
|
14
14
|
unknown,
|
|
15
15
|
never
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { callQueryClientMethodWithQueryKey } from '../lib/callQueryClientFetchMethod.js';
|
|
2
|
+
import type { QraftClientOptions } from '../qraftAPIClient.js';
|
|
3
|
+
import { ServiceOperationQuery } from '../ServiceOperation.js';
|
|
4
|
+
|
|
5
|
+
export const prefetchInfiniteQuery: <
|
|
6
|
+
TSchema extends { url: string; method: 'get' | 'head' | 'options' },
|
|
7
|
+
TData,
|
|
8
|
+
TParams,
|
|
9
|
+
>(
|
|
10
|
+
_: QraftClientOptions | undefined,
|
|
11
|
+
schema: TSchema,
|
|
12
|
+
args: Parameters<
|
|
13
|
+
ServiceOperationQuery<TSchema, TData, TParams>['prefetchInfiniteQuery']
|
|
14
|
+
>
|
|
15
|
+
) => Promise<TData> = (_, schema, args) => {
|
|
16
|
+
return callQueryClientMethodWithQueryKey(
|
|
17
|
+
'prefetchInfiniteQuery',
|
|
18
|
+
schema,
|
|
19
|
+
true,
|
|
20
|
+
args as never
|
|
21
|
+
) as never;
|
|
22
|
+
};
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { callQueryClientMethodWithQueryKey } from '../lib/callQueryClientFetchMethod.js';
|
|
2
|
+
import type { QraftClientOptions } from '../qraftAPIClient.js';
|
|
3
|
+
import { ServiceOperationQuery } from '../ServiceOperation.js';
|
|
4
|
+
|
|
5
|
+
export const prefetchQuery: <
|
|
6
|
+
TSchema extends { url: string; method: 'get' | 'head' | 'options' },
|
|
7
|
+
TData,
|
|
8
|
+
TParams,
|
|
9
|
+
>(
|
|
10
|
+
_: QraftClientOptions | undefined,
|
|
11
|
+
schema: TSchema,
|
|
12
|
+
args: Parameters<
|
|
13
|
+
ServiceOperationQuery<TSchema, TData, TParams>['prefetchQuery']
|
|
14
|
+
>
|
|
15
|
+
) => Promise<TData> = (_, schema, args) => {
|
|
16
|
+
return callQueryClientMethodWithQueryKey(
|
|
17
|
+
'prefetchQuery',
|
|
18
|
+
schema,
|
|
19
|
+
false,
|
|
20
|
+
args as never
|
|
21
|
+
) as never;
|
|
22
|
+
};
|
package/src/callbacks/queryFn.ts
CHANGED
|
@@ -12,9 +12,9 @@ export const queryFn: <
|
|
|
12
12
|
) => Promise<TData> = (_, schema, args) => {
|
|
13
13
|
const [options, client] = args;
|
|
14
14
|
|
|
15
|
-
return client('queryKey' in options ? options.queryKey[0] : schema, {
|
|
15
|
+
return client('queryKey' in options ? options.queryKey![0] : schema, {
|
|
16
16
|
parameters:
|
|
17
|
-
'queryKey' in options ? options.queryKey[1] : options.parameters,
|
|
17
|
+
'queryKey' in options ? options.queryKey![1] : options.parameters,
|
|
18
18
|
meta: options.meta,
|
|
19
19
|
signal: options.signal,
|
|
20
20
|
}) as Promise<never>;
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { callQueryClientMethodWithQueryFilters } from '../lib/callQueryClientMethodWithQueryFilters.js';
|
|
2
|
+
import type { OperationSchema } from '../lib/requestFn.js';
|
|
2
3
|
import type { QraftClientOptions } from '../qraftAPIClient.js';
|
|
3
|
-
import type {
|
|
4
|
-
import { ServiceOperationResetQueriesCallback } from '../ServiceOperation.js';
|
|
4
|
+
import type { ServiceOperationResetQueriesCallback } from '../ServiceOperation.js';
|
|
5
5
|
|
|
6
6
|
export function refetchQueries<TData>(
|
|
7
7
|
qraftOptions: QraftClientOptions | undefined,
|
|
8
|
-
schema:
|
|
8
|
+
schema: OperationSchema,
|
|
9
9
|
args: Parameters<
|
|
10
10
|
ServiceOperationResetQueriesCallback<
|
|
11
|
-
|
|
11
|
+
OperationSchema,
|
|
12
12
|
unknown,
|
|
13
13
|
TData
|
|
14
14
|
>['refetchQueries']
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { callQueryClientMethodWithQueryFilters } from '../lib/callQueryClientMethodWithQueryFilters.js';
|
|
2
|
+
import type { OperationSchema } from '../lib/requestFn.js';
|
|
2
3
|
import type { QraftClientOptions } from '../qraftAPIClient.js';
|
|
3
|
-
import type { RequestClientSchema } from '../RequestClient.js';
|
|
4
4
|
import type { ServiceOperationResetQueriesCallback } from '../ServiceOperation.js';
|
|
5
5
|
|
|
6
6
|
export function resetQueries<TData>(
|
|
7
7
|
qraftOptions: QraftClientOptions | undefined,
|
|
8
|
-
schema:
|
|
8
|
+
schema: OperationSchema,
|
|
9
9
|
args: Parameters<
|
|
10
10
|
ServiceOperationResetQueriesCallback<
|
|
11
|
-
|
|
11
|
+
OperationSchema,
|
|
12
12
|
unknown,
|
|
13
13
|
TData
|
|
14
14
|
>['resetQueries']
|