@openapi-qraft/react 1.3.2 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +25 -1
- package/README.md +17 -17
- package/dist/ServiceOperation.d.ts +146 -40
- package/dist/ServiceOperation.d.ts.map +1 -1
- package/dist/callbacks/getInfiniteQueryState.d.ts +5 -0
- package/dist/callbacks/getInfiniteQueryState.d.ts.map +1 -0
- package/dist/callbacks/getInfiniteQueryState.js +5 -0
- package/dist/callbacks/getInfiniteQueryState.js.map +1 -0
- package/dist/callbacks/getQueriesData.d.ts +5 -0
- package/dist/callbacks/getQueriesData.d.ts.map +1 -0
- package/dist/callbacks/getQueriesData.js +5 -0
- package/dist/callbacks/getQueriesData.js.map +1 -0
- package/dist/callbacks/getQueryState.d.ts +5 -0
- package/dist/callbacks/getQueryState.d.ts.map +1 -0
- package/dist/callbacks/getQueryState.js +5 -0
- package/dist/callbacks/getQueryState.js.map +1 -0
- package/dist/callbacks/isMutating.d.ts +5 -0
- package/dist/callbacks/isMutating.d.ts.map +1 -0
- package/dist/callbacks/isMutating.js +5 -0
- package/dist/callbacks/isMutating.js.map +1 -0
- package/dist/callbacks/removeQueries.d.ts +5 -0
- package/dist/callbacks/removeQueries.d.ts.map +1 -0
- package/dist/callbacks/removeQueries.js +5 -0
- package/dist/callbacks/removeQueries.js.map +1 -0
- package/dist/callbacks/setQueriesData.d.ts +5 -0
- package/dist/callbacks/setQueriesData.d.ts.map +1 -0
- package/dist/callbacks/setQueriesData.js +5 -0
- package/dist/callbacks/setQueriesData.js.map +1 -0
- package/dist/callbacks/useIsFetching.js.map +1 -1
- package/dist/callbacks/useIsMutating.d.ts +7 -0
- package/dist/callbacks/useIsMutating.d.ts.map +1 -0
- package/dist/callbacks/useIsMutating.js +9 -0
- package/dist/callbacks/useIsMutating.js.map +1 -0
- package/dist/callbacks/useMutationState.d.ts.map +1 -1
- package/dist/callbacks/useMutationState.js +2 -15
- package/dist/callbacks/useMutationState.js.map +1 -1
- package/dist/lib/callQueryClientMethodWithMutationFilters.d.ts +11 -0
- package/dist/lib/callQueryClientMethodWithMutationFilters.d.ts.map +1 -0
- package/dist/lib/callQueryClientMethodWithMutationFilters.js +18 -0
- package/dist/lib/callQueryClientMethodWithMutationFilters.js.map +1 -0
- package/dist/lib/callQueryClientMethodWithQueryFilters.js +1 -1
- package/dist/lib/callQueryClientMethodWithQueryFilters.js.map +1 -1
- package/dist/lib/callQueryClientMethodWithQueryKey.js +1 -1
- package/dist/lib/callQueryClientMethodWithQueryKey.js.map +1 -1
- package/dist/lib/composeBaseQueryKey.d.ts +6 -0
- package/dist/lib/composeBaseQueryKey.d.ts.map +1 -0
- package/dist/lib/composeBaseQueryKey.js +7 -0
- package/dist/lib/composeBaseQueryKey.js.map +1 -0
- package/dist/lib/composeInfiniteQueryKey.d.ts.map +1 -1
- package/dist/lib/composeInfiniteQueryKey.js +2 -1
- package/dist/lib/composeInfiniteQueryKey.js.map +1 -1
- package/dist/lib/composeMutationFilters.d.ts +11 -0
- package/dist/lib/composeMutationFilters.d.ts.map +1 -0
- package/dist/lib/composeMutationFilters.js +32 -0
- package/dist/lib/composeMutationFilters.js.map +1 -0
- package/dist/lib/composeMutationKey.js +1 -1
- package/dist/lib/composeMutationKey.js.map +1 -1
- package/dist/lib/composeQueryFilters.d.ts +5 -2
- package/dist/lib/composeQueryFilters.d.ts.map +1 -1
- package/dist/lib/composeQueryFilters.js +17 -11
- package/dist/lib/composeQueryFilters.js.map +1 -1
- package/dist/lib/composeQueryKey.d.ts.map +1 -1
- package/dist/lib/composeQueryKey.js +2 -1
- package/dist/lib/composeQueryKey.js.map +1 -1
- package/package.json +4 -3
- package/src/ServiceOperation.ts +344 -84
- package/src/callbacks/getInfiniteQueryState.ts +23 -0
- package/src/callbacks/getQueriesData.ts +18 -0
- package/src/callbacks/getQueryState.ts +19 -0
- package/src/callbacks/isMutating.ts +22 -0
- package/src/callbacks/removeQueries.ts +22 -0
- package/src/callbacks/setQueriesData.ts +22 -0
- package/src/callbacks/useIsFetching.ts +1 -1
- package/src/callbacks/useIsMutating.ts +42 -0
- package/src/callbacks/useMutationState.ts +2 -27
- package/src/lib/callQueryClientMethodWithMutationFilters.ts +37 -0
- package/src/lib/callQueryClientMethodWithQueryFilters.ts +1 -1
- package/src/lib/callQueryClientMethodWithQueryKey.ts +1 -1
- package/src/lib/composeBaseQueryKey.ts +34 -0
- package/src/lib/composeInfiniteQueryKey.ts +2 -1
- package/src/lib/composeMutationFilters.ts +44 -0
- package/src/lib/composeMutationKey.ts +1 -1
- package/src/lib/composeQueryFilters.ts +24 -16
- package/src/lib/composeQueryKey.ts +2 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,29 @@
|
|
|
1
1
|
# @openapi-qraft/react
|
|
2
2
|
|
|
3
|
+
## 1.5.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 5c965ab: Unified QueryKey for Infinite and regular Queries: `[TSchema & { infinite: boolean}, TParams]`
|
|
8
|
+
- 8db4067: Added support for `QueryClient.getQueriesData(...)` method
|
|
9
|
+
|
|
10
|
+
### Patch Changes
|
|
11
|
+
|
|
12
|
+
- c761191: Added support for `QueryClient.setQueriesData(...)` method
|
|
13
|
+
- bf43192: feature: add support for `QueryClient.getQueryState(...)` method
|
|
14
|
+
|
|
15
|
+
## 1.4.0
|
|
16
|
+
|
|
17
|
+
### Minor Changes
|
|
18
|
+
|
|
19
|
+
- 6343a8d: Added support for `QueryClient.isMutating(...)` method
|
|
20
|
+
- b297c10: Unified `composeMutationKey(...)` to return the same key structure as `composeQueryKey(...)` if no parameters are passed
|
|
21
|
+
- 42a0b11: Added support for `QueryClient.removeQueries(...)` method
|
|
22
|
+
|
|
23
|
+
### Patch Changes
|
|
24
|
+
|
|
25
|
+
- 34fd459: Fixed `fetchQuery(...)` documentation
|
|
26
|
+
|
|
3
27
|
## 1.3.2
|
|
4
28
|
|
|
5
29
|
### Patch Changes
|
|
@@ -16,7 +40,7 @@
|
|
|
16
40
|
|
|
17
41
|
### Minor Changes
|
|
18
42
|
|
|
19
|
-
- 7c81509: Add support for `
|
|
43
|
+
- 7c81509: Add support for `QueryClient.fetchInfiniteQuery(...)` and `QueryClient.prefetchInfiniteQuery(...)` methods
|
|
20
44
|
- 8e47c05: Simplified `QueryClient.setQueryData(...)` API
|
|
21
45
|
- 48e662d: Added support for `QueryClient.fetchQuery(...)` method
|
|
22
46
|
- 315883b: Changed `requestFn(...)` API to simplify the usage
|
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
`@openapi-qraft/react` is a modular TypeScript client designed to facilitate type-safe API requests in React
|
|
4
4
|
applications,
|
|
5
|
-
leveraging the power of **
|
|
5
|
+
leveraging the power of **TanStack Query v5**. It utilizes a Proxy-based architecture to dynamically generate
|
|
6
6
|
hooks with typed parameters, ensuring that your API requests are both type-safe and efficient.
|
|
7
7
|
|
|
8
8
|
## Features
|
|
@@ -11,7 +11,7 @@ hooks with typed parameters, ensuring that your API requests are both type-safe
|
|
|
11
11
|
developer experience.
|
|
12
12
|
- **Modular Design:** Customize the utility with a set of callbacks to handle API calls according to your project's
|
|
13
13
|
needs.
|
|
14
|
-
- **Integration with [
|
|
14
|
+
- **Integration with [TanStack Query v5](https://tanstack.com/query/v5):** Seamlessly integrate with _TanStack Query_
|
|
15
15
|
for handling server state, caching, and data synchronization.
|
|
16
16
|
- **Dynamic Proxy-Based Hooks:** Automatically generate React Query hooks for your API endpoints without manual
|
|
17
17
|
boilerplate.
|
|
@@ -56,7 +56,7 @@ npx openapi-typescript https://api.dev.monite.com/openapi.json?version=2023-09-0
|
|
|
56
56
|
|
|
57
57
|
#### Generating Qraft Services
|
|
58
58
|
|
|
59
|
-
Next, use `@openapi-qraft/cli` to generate the services and typed
|
|
59
|
+
Next, use `@openapi-qraft/cli` to generate the services and typed TanStack Query React Hooks. Ensure to specify the path
|
|
60
60
|
to the TypeScript definitions generated in the previous step.
|
|
61
61
|
|
|
62
62
|
```bash
|
|
@@ -274,7 +274,7 @@ useEffect(() => {
|
|
|
274
274
|
const infiniteQuery = qraft.posts.getPosts.useInfiniteQuery(
|
|
275
275
|
{ query: { limit: 10 } },
|
|
276
276
|
{
|
|
277
|
-
// * required by
|
|
277
|
+
// * required by TanStack Query
|
|
278
278
|
getNextPageParam: (lastPage, allPages, lastPageParams) => {
|
|
279
279
|
if (lastPage.length < 10) return; // if less than 10 items, there are no more pages
|
|
280
280
|
return {
|
|
@@ -283,7 +283,7 @@ const infiniteQuery = qraft.posts.getPosts.useInfiniteQuery(
|
|
|
283
283
|
},
|
|
284
284
|
};
|
|
285
285
|
},
|
|
286
|
-
// * required by
|
|
286
|
+
// * required by TanStack Query
|
|
287
287
|
initialPageParam: {
|
|
288
288
|
query: {
|
|
289
289
|
page: 1, // will be used in initial request
|
|
@@ -316,11 +316,11 @@ const infiniteQuery = qraft.dataExports.getDataExports.useInfiniteQuery(
|
|
|
316
316
|
},
|
|
317
317
|
},
|
|
318
318
|
{
|
|
319
|
-
// * required by
|
|
319
|
+
// * required by TanStack Query
|
|
320
320
|
initialPageParam: {
|
|
321
321
|
query: { pagination_token: undefined }, // will be used in initial request
|
|
322
322
|
},
|
|
323
|
-
// * required by
|
|
323
|
+
// * required by TanStack Query
|
|
324
324
|
getNextPageParam: (lastPage, allPages, lastPageParam) => ({
|
|
325
325
|
query: { pagination_token: lastPage.next_pagination_token },
|
|
326
326
|
}),
|
|
@@ -331,10 +331,10 @@ const infiniteQuery = qraft.dataExports.getDataExports.useInfiniteQuery(
|
|
|
331
331
|
}
|
|
332
332
|
);
|
|
333
333
|
|
|
334
|
-
// ⬇︎ will execute GET /data_exports?pagination_token
|
|
334
|
+
// ⬇︎ will execute GET /data_exports?pagination_token=<NEXT_PAGINATION_TOKEN>
|
|
335
335
|
infiniteQuery.fetchNextPage();
|
|
336
336
|
|
|
337
|
-
// ⬇︎ will execute GET /data_exports?pagination_token
|
|
337
|
+
// ⬇︎ will execute GET /data_exports?pagination_token=<PREV_PAGINATION_TOKEN>
|
|
338
338
|
infiniteQuery.fetchPreviousPage();
|
|
339
339
|
```
|
|
340
340
|
|
|
@@ -382,10 +382,10 @@ qraft.entities.getEntities.useQueries({
|
|
|
382
382
|
```tsx
|
|
383
383
|
function FetchStatus() {
|
|
384
384
|
// Checks all queries `GET /entities`
|
|
385
|
-
const
|
|
385
|
+
const fetchingTotal = qraft.entities.getEntities.useIsFetching();
|
|
386
386
|
|
|
387
|
-
//
|
|
388
|
-
const
|
|
387
|
+
// Checks all queries `GET /entities/3e3e-3e3e-3e3e` and `x-monite-version: 2023-09-01` header
|
|
388
|
+
const specificQueryKeyTotal = qraft.entities.getEntities.useIsFetching({
|
|
389
389
|
parameters: {
|
|
390
390
|
header: {
|
|
391
391
|
'x-monite-version': '2023-09-01',
|
|
@@ -398,8 +398,8 @@ function FetchStatus() {
|
|
|
398
398
|
|
|
399
399
|
return (
|
|
400
400
|
<>
|
|
401
|
-
{!!
|
|
402
|
-
{!!
|
|
401
|
+
{!!fetchingTotal && <div>Number of queries: {fetchingTotal}...</div>}
|
|
402
|
+
{!!specificQueryKeyTotal && <div>Loading specific query...</div>}
|
|
403
403
|
</>
|
|
404
404
|
);
|
|
405
405
|
}
|
|
@@ -542,7 +542,7 @@ import { QueryClient } from '@tanstack/react-query';
|
|
|
542
542
|
|
|
543
543
|
const queryClient = new QueryClient();
|
|
544
544
|
|
|
545
|
-
const posts = qraft.posts.getPosts.
|
|
545
|
+
const posts = qraft.posts.getPosts.fetchQuery(
|
|
546
546
|
{
|
|
547
547
|
parameters: { query: { limit: 10 } },
|
|
548
548
|
/**
|
|
@@ -622,8 +622,8 @@ Supported Suspense Queries are:
|
|
|
622
622
|
- `getQueryData(parameters)`
|
|
623
623
|
- `setQueryData(parameters, updater)`
|
|
624
624
|
- `getInfiniteQueryKey(parameters)`
|
|
625
|
-
- `
|
|
626
|
-
- `
|
|
625
|
+
- `getInfiniteQueryData(parameters)`
|
|
626
|
+
- `setInfiniteQueryData(parameters, updater)`
|
|
627
627
|
- `schema` - object with schema: `{method, url, mediaType}`
|
|
628
628
|
- `types` - object with types: `{parameters, data, error, body}`
|
|
629
629
|
|
|
@@ -1,21 +1,25 @@
|
|
|
1
|
-
import { CancelOptions, DefaultError, FetchStatus, InfiniteData, InfiniteQueryPageParamsOptions, InvalidateOptions, Mutation, MutationState, MutationStatus, NoInfer, QueriesPlaceholderDataFunction, Query, QueryClient, FetchQueryOptions, RefetchOptions, ResetOptions, SetDataOptions, Updater, QueryFunction, InitialPageParam, GetNextPageParamFunction } from '@tanstack/query-core';
|
|
1
|
+
import { CancelOptions, DefaultError, FetchStatus, InfiniteData, InfiniteQueryPageParamsOptions, InvalidateOptions, Mutation, MutationState, MutationStatus, NoInfer, QueriesPlaceholderDataFunction, Query, QueryClient, FetchQueryOptions, RefetchOptions, ResetOptions, SetDataOptions, Updater, QueryFunction, InitialPageParam, GetNextPageParamFunction, QueryState } from '@tanstack/query-core';
|
|
2
2
|
import type { DefinedInitialDataInfiniteOptions, DefinedInitialDataOptions, DefinedUseInfiniteQueryResult, DefinedUseQueryResult, UndefinedInitialDataInfiniteOptions, UndefinedInitialDataOptions, UseInfiniteQueryResult, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult, UseSuspenseInfiniteQueryOptions, UseSuspenseInfiniteQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
|
|
3
3
|
import type { RequestFn } from './lib/requestFn.js';
|
|
4
|
+
type ServiceOperationBaseQueryKey<S extends {
|
|
5
|
+
url: string;
|
|
6
|
+
method: string;
|
|
7
|
+
}, Infinite extends boolean, T> = [S & {
|
|
8
|
+
infinite: Infinite;
|
|
9
|
+
}, T];
|
|
4
10
|
export type ServiceOperationQueryKey<S extends {
|
|
5
11
|
url: string;
|
|
6
12
|
method: string;
|
|
7
|
-
}, T> =
|
|
13
|
+
}, T> = ServiceOperationBaseQueryKey<S, false, T>;
|
|
8
14
|
export type ServiceOperationInfiniteQueryKey<S extends {
|
|
9
15
|
url: string;
|
|
10
16
|
method: string;
|
|
11
|
-
}, T> =
|
|
12
|
-
infinite: true;
|
|
13
|
-
}, T];
|
|
17
|
+
}, T> = ServiceOperationBaseQueryKey<S, true, T>;
|
|
14
18
|
export type ServiceOperationMutationKey<S extends Record<'url' | 'method', string>, T extends unknown> = NonNullable<T> extends never ? [S] : [S, T];
|
|
15
19
|
export interface ServiceOperationQuery<TSchema extends {
|
|
16
20
|
url: string;
|
|
17
21
|
method: string;
|
|
18
|
-
}, TData, TParams, TError = DefaultError> extends ServiceOperationUseQuery<TSchema, TData, TParams, TError>, ServiceOperationUseQueries<TSchema, TData, TParams, TError>, ServiceOperationUseSuspenseQueries<TSchema, TData, TParams, TError>, ServiceOperationUseInfiniteQuery<TSchema, TData, TParams, TError>, ServiceOperationUseSuspenseQueryQuery<TSchema, TData, TParams, TError>, ServiceOperationUseSuspenseInfiniteQuery<TSchema, TData, TParams, TError>, ServiceOperationUseIsFetchingQueries<TSchema, TData, TParams, TError>, ServiceOperationQueryFn<TSchema, TData, TParams>, ServiceOperationFetchQuery<TSchema, TData, TParams, TError>, ServiceOperationFetchInfiniteQuery<TSchema, TData, TParams, TError>, ServiceOperationGetQueryData<TSchema, TData, TParams>, ServiceOperationGetInfiniteQueryData<TSchema, TData, TParams>, ServiceOperationSetQueryData<TSchema, TData, TParams>, ServiceOperationSetInfiniteQueryData<TSchema, TData, TParams>, ServiceOperationInvalidateQueries<TSchema, TData, TParams, TError>, ServiceOperationCancelQueries<TSchema, TData, TParams, TError>, ServiceOperationResetQueries<TSchema, TData, TParams, TError>, ServiceOperationRefetchQueries<TSchema, TData, TParams, TError>, ServiceOperationIsFetchingQueries<TSchema, TData, TParams, TError> {
|
|
22
|
+
}, TData, TParams, TError = DefaultError> extends ServiceOperationUseQuery<TSchema, TData, TParams, TError>, ServiceOperationUseQueries<TSchema, TData, TParams, TError>, ServiceOperationUseSuspenseQueries<TSchema, TData, TParams, TError>, ServiceOperationUseInfiniteQuery<TSchema, TData, TParams, TError>, ServiceOperationUseSuspenseQueryQuery<TSchema, TData, TParams, TError>, ServiceOperationUseSuspenseInfiniteQuery<TSchema, TData, TParams, TError>, ServiceOperationUseIsFetchingQueries<TSchema, TData, TParams, TError>, ServiceOperationQueryFn<TSchema, TData, TParams>, ServiceOperationFetchQuery<TSchema, TData, TParams, TError>, ServiceOperationFetchInfiniteQuery<TSchema, TData, TParams, TError>, ServiceOperationGetQueryData<TSchema, TData, TParams>, ServiceOperationGetQueryState<TSchema, TData, TParams, TError>, ServiceOperationGetQueriesData<TSchema, TData, TParams, TError>, ServiceOperationGetInfiniteQueryData<TSchema, TData, TParams>, ServiceOperationSetQueryData<TSchema, TData, TParams>, ServiceOperationSetQueriesData<TSchema, TData, TParams, TError>, ServiceOperationSetInfiniteQueryData<TSchema, TData, TParams>, ServiceOperationInvalidateQueries<TSchema, TData, TParams, TError>, ServiceOperationCancelQueries<TSchema, TData, TParams, TError>, ServiceOperationRemoveQueries<TSchema, TData, TParams, TError>, ServiceOperationResetQueries<TSchema, TData, TParams, TError>, ServiceOperationRefetchQueries<TSchema, TData, TParams, TError>, ServiceOperationIsFetchingQueries<TSchema, TData, TParams, TError> {
|
|
19
23
|
schema: TSchema;
|
|
20
24
|
types: {
|
|
21
25
|
parameters: TParams;
|
|
@@ -146,7 +150,11 @@ type QueryTypeFilter = 'all' | 'active' | 'inactive';
|
|
|
146
150
|
interface QueryFiltersBase<TSchema extends {
|
|
147
151
|
url: string;
|
|
148
152
|
method: string;
|
|
149
|
-
}, TData, TParams = {}, TError = DefaultError> {
|
|
153
|
+
}, TData, TInfinite extends boolean, TParams = {}, TError = DefaultError> {
|
|
154
|
+
/**
|
|
155
|
+
* Include queries matching this predicate function
|
|
156
|
+
*/
|
|
157
|
+
predicate?: TInfinite extends true ? QueryFilterInfinitePredicate<TSchema, TData, TParams, TError> : TInfinite extends false ? QueryFilterRegularPredicate<TSchema, TData, TParams, TError> : (query: string) => boolean;
|
|
150
158
|
/**
|
|
151
159
|
* Filter to active queries, inactive queries or all queries
|
|
152
160
|
*/
|
|
@@ -155,10 +163,6 @@ interface QueryFiltersBase<TSchema extends {
|
|
|
155
163
|
* Match query key exactly
|
|
156
164
|
*/
|
|
157
165
|
exact?: boolean;
|
|
158
|
-
/**
|
|
159
|
-
* Include queries matching this predicate function
|
|
160
|
-
*/
|
|
161
|
-
predicate?: (query: Query<TData, TError, TData, ServiceOperationQueryKey<TSchema, TParams> | ServiceOperationInfiniteQueryKey<TSchema, TParams>>) => boolean;
|
|
162
166
|
/**
|
|
163
167
|
* Include or exclude stale queries
|
|
164
168
|
*/
|
|
@@ -171,33 +175,58 @@ interface QueryFiltersBase<TSchema extends {
|
|
|
171
175
|
interface QueryFiltersByQueryKey<TSchema extends {
|
|
172
176
|
url: string;
|
|
173
177
|
method: string;
|
|
174
|
-
}, TData, TParams = {}, TError = DefaultError> extends QueryFiltersBase<TSchema, TData, TParams, TError> {
|
|
178
|
+
}, TData, TInfinite extends boolean, TParams = {}, TError = DefaultError> extends QueryFiltersBase<TSchema, TData, TInfinite, TParams, TError> {
|
|
175
179
|
/**
|
|
176
180
|
* Include queries matching this query key
|
|
177
181
|
*/
|
|
178
|
-
queryKey?:
|
|
182
|
+
queryKey?: ServiceOperationBaseQueryKey<TSchema, TInfinite, TParams>;
|
|
183
|
+
infinite?: never;
|
|
184
|
+
parameters?: never;
|
|
179
185
|
}
|
|
180
186
|
interface QueryFiltersByParameters<TSchema extends {
|
|
181
187
|
url: string;
|
|
182
188
|
method: string;
|
|
183
|
-
}, TData, TParams = {}, TError = DefaultError> extends QueryFiltersBase<TSchema, TData, TParams, TError> {
|
|
189
|
+
}, TData, TInfinite extends boolean, TParams = {}, TError = DefaultError> extends QueryFiltersBase<TSchema, TData, TInfinite, TParams, TError> {
|
|
190
|
+
/**
|
|
191
|
+
* Is the query infinite
|
|
192
|
+
*/
|
|
193
|
+
infinite?: TInfinite;
|
|
184
194
|
/**
|
|
185
195
|
* Include queries matching parameters
|
|
186
196
|
*/
|
|
187
197
|
parameters?: TParams;
|
|
198
|
+
queryKey?: never;
|
|
199
|
+
}
|
|
200
|
+
interface QueryFilterInfinitePredicate<TSchema extends {
|
|
201
|
+
url: string;
|
|
202
|
+
method: string;
|
|
203
|
+
}, TData, TParams = {}, TError = DefaultError> {
|
|
204
|
+
/**
|
|
205
|
+
* Include queries matching this predicate function
|
|
206
|
+
*/
|
|
207
|
+
(query: Query<InfiniteData<TData, TParams>, TError, InfiniteData<TData, TParams>, ServiceOperationInfiniteQueryKey<TSchema, TParams>>): boolean;
|
|
208
|
+
}
|
|
209
|
+
interface QueryFilterRegularPredicate<TSchema extends {
|
|
210
|
+
url: string;
|
|
211
|
+
method: string;
|
|
212
|
+
}, TData, TParams = {}, TError = DefaultError> {
|
|
213
|
+
/**
|
|
214
|
+
* Include queries matching this predicate function
|
|
215
|
+
*/
|
|
216
|
+
(query: Query<TData, TError, TData, ServiceOperationQueryKey<TSchema, TParams>>): boolean;
|
|
188
217
|
}
|
|
189
218
|
type InvalidateQueryFilters<TSchema extends {
|
|
190
219
|
url: string;
|
|
191
220
|
method: string;
|
|
192
|
-
}, TData, TParams = {}, TError = DefaultError> = (QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>) & {
|
|
221
|
+
}, TData, TInfinite extends boolean, TParams = {}, TError = DefaultError> = (QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>) & {
|
|
193
222
|
refetchType?: QueryTypeFilter | 'none';
|
|
194
223
|
};
|
|
195
224
|
interface ServiceOperationInvalidateQueries<TSchema extends {
|
|
196
225
|
url: string;
|
|
197
226
|
method: string;
|
|
198
227
|
}, TData, TParams = {}, TError = DefaultError> {
|
|
199
|
-
invalidateQueries(filters: InvalidateQueryFilters<TSchema, TData, TParams, TError>, options: InvalidateOptions, queryClient: QueryClient): Promise<void>;
|
|
200
|
-
invalidateQueries(filters: InvalidateQueryFilters<TSchema, TData, TParams, TError>, queryClient: QueryClient): Promise<void>;
|
|
228
|
+
invalidateQueries<TInfinite extends boolean>(filters: InvalidateQueryFilters<TSchema, TData, TInfinite, TParams, TError>, options: InvalidateOptions, queryClient: QueryClient): Promise<void>;
|
|
229
|
+
invalidateQueries<TInfinite extends boolean>(filters: InvalidateQueryFilters<TSchema, TData, TInfinite, TParams, TError>, queryClient: QueryClient): Promise<void>;
|
|
201
230
|
invalidateQueries(queryClient: QueryClient): Promise<void>;
|
|
202
231
|
}
|
|
203
232
|
/**
|
|
@@ -207,14 +236,14 @@ export interface ServiceOperationInvalidateQueriesCallback<TSchema extends {
|
|
|
207
236
|
url: string;
|
|
208
237
|
method: string;
|
|
209
238
|
}, TData, TParams = {}, TError = DefaultError> extends ServiceOperationInvalidateQueries<TSchema, TData, TParams, TError> {
|
|
210
|
-
invalidateQueries(filters:
|
|
239
|
+
invalidateQueries<TInfinite extends boolean>(filters: InvalidateQueryFilters<TSchema, TData, TInfinite, TParams, TError> | QueryClient, options?: InvalidateOptions | QueryClient, queryClient?: QueryClient): Promise<void>;
|
|
211
240
|
}
|
|
212
241
|
interface ServiceOperationCancelQueries<TSchema extends {
|
|
213
242
|
url: string;
|
|
214
243
|
method: string;
|
|
215
244
|
}, TData, TParams = {}, TError = DefaultError> {
|
|
216
|
-
cancelQueries(filters: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>, options: CancelOptions, queryClient: QueryClient): Promise<void>;
|
|
217
|
-
cancelQueries(filters: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>, queryClient: QueryClient): Promise<void>;
|
|
245
|
+
cancelQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, options: CancelOptions, queryClient: QueryClient): Promise<void>;
|
|
246
|
+
cancelQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, queryClient: QueryClient): Promise<void>;
|
|
218
247
|
cancelQueries(queryClient: QueryClient): Promise<void>;
|
|
219
248
|
}
|
|
220
249
|
/**
|
|
@@ -224,14 +253,30 @@ export interface ServiceOperationCancelQueriesCallback<TSchema extends {
|
|
|
224
253
|
url: string;
|
|
225
254
|
method: string;
|
|
226
255
|
}, TData, TParams = {}, TError = DefaultError> extends ServiceOperationCancelQueries<TSchema, TData, TParams, TError> {
|
|
227
|
-
cancelQueries(filters: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError> | QueryClient, options?: CancelOptions | QueryClient, queryClient?: QueryClient): Promise<void>;
|
|
256
|
+
cancelQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError> | QueryClient, options?: CancelOptions | QueryClient, queryClient?: QueryClient): Promise<void>;
|
|
257
|
+
}
|
|
258
|
+
interface ServiceOperationRemoveQueries<TSchema extends {
|
|
259
|
+
url: string;
|
|
260
|
+
method: string;
|
|
261
|
+
}, TData, TParams = {}, TError = DefaultError> {
|
|
262
|
+
removeQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, queryClient: QueryClient): void;
|
|
263
|
+
removeQueries(queryClient: QueryClient): void;
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* @internal
|
|
267
|
+
*/
|
|
268
|
+
export interface ServiceOperationRemoveQueriesCallback<TSchema extends {
|
|
269
|
+
url: string;
|
|
270
|
+
method: string;
|
|
271
|
+
}, TData, TParams = {}, TError = DefaultError> extends ServiceOperationRemoveQueries<TSchema, TData, TParams, TError> {
|
|
272
|
+
removeQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError> | QueryClient, queryClient?: QueryClient): void;
|
|
228
273
|
}
|
|
229
274
|
interface ServiceOperationResetQueries<TSchema extends {
|
|
230
275
|
url: string;
|
|
231
276
|
method: string;
|
|
232
277
|
}, TData, TParams = {}, TError = DefaultError> {
|
|
233
|
-
resetQueries(filters: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>, options: ResetOptions, queryClient: QueryClient): Promise<void>;
|
|
234
|
-
resetQueries(filters: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>, queryClient: QueryClient): Promise<void>;
|
|
278
|
+
resetQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, options: ResetOptions, queryClient: QueryClient): Promise<void>;
|
|
279
|
+
resetQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, queryClient: QueryClient): Promise<void>;
|
|
235
280
|
resetQueries(queryClient: QueryClient): Promise<void>;
|
|
236
281
|
}
|
|
237
282
|
/**
|
|
@@ -241,14 +286,14 @@ export interface ServiceOperationResetQueriesCallback<TSchema extends {
|
|
|
241
286
|
url: string;
|
|
242
287
|
method: string;
|
|
243
288
|
}, TData, TParams = {}, TError = DefaultError> extends ServiceOperationResetQueries<TSchema, TData, TParams, TError> {
|
|
244
|
-
resetQueries(filters: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError> | QueryClient, options?: ResetOptions | QueryClient, queryClient?: QueryClient): Promise<void>;
|
|
289
|
+
resetQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError> | QueryClient, options?: ResetOptions | QueryClient, queryClient?: QueryClient): Promise<void>;
|
|
245
290
|
}
|
|
246
291
|
interface ServiceOperationRefetchQueries<TSchema extends {
|
|
247
292
|
url: string;
|
|
248
293
|
method: string;
|
|
249
294
|
}, TData, TParams = {}, TError = DefaultError> {
|
|
250
|
-
refetchQueries(filters: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>, options: RefetchOptions, queryClient: QueryClient): Promise<void>;
|
|
251
|
-
refetchQueries(filters: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>, queryClient: QueryClient): Promise<void>;
|
|
295
|
+
refetchQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, options: RefetchOptions, queryClient: QueryClient): Promise<void>;
|
|
296
|
+
refetchQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, queryClient: QueryClient): Promise<void>;
|
|
252
297
|
refetchQueries(queryClient: QueryClient): Promise<void>;
|
|
253
298
|
}
|
|
254
299
|
/**
|
|
@@ -258,13 +303,13 @@ export interface ServiceOperationResetQueriesCallback<TSchema extends {
|
|
|
258
303
|
url: string;
|
|
259
304
|
method: string;
|
|
260
305
|
}, TData, TParams = {}, TError = DefaultError> extends ServiceOperationRefetchQueries<TSchema, TData, TParams, TError> {
|
|
261
|
-
refetchQueries(filters: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError> | QueryClient, options?: RefetchOptions | QueryClient, queryClient?: QueryClient): Promise<void>;
|
|
306
|
+
refetchQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError> | QueryClient, options?: RefetchOptions | QueryClient, queryClient?: QueryClient): Promise<void>;
|
|
262
307
|
}
|
|
263
308
|
interface ServiceOperationIsFetchingQueries<TSchema extends {
|
|
264
309
|
url: string;
|
|
265
310
|
method: string;
|
|
266
311
|
}, TData, TParams = {}, TError = DefaultError> {
|
|
267
|
-
isFetching(filters: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>, queryClient: QueryClient): number;
|
|
312
|
+
isFetching<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, queryClient: QueryClient): number;
|
|
268
313
|
isFetching(queryClient: QueryClient): number;
|
|
269
314
|
}
|
|
270
315
|
/**
|
|
@@ -274,13 +319,13 @@ export interface ServiceOperationIsFetchingQueriesCallback<TSchema extends {
|
|
|
274
319
|
url: string;
|
|
275
320
|
method: string;
|
|
276
321
|
}, TData, TParams = {}, TError = DefaultError> extends ServiceOperationIsFetchingQueries<TSchema, TData, TParams, TError> {
|
|
277
|
-
refetchQueries(filters: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError> | QueryClient, queryClient?: QueryClient): number;
|
|
322
|
+
refetchQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError> | QueryClient, queryClient?: QueryClient): number;
|
|
278
323
|
}
|
|
279
324
|
interface ServiceOperationUseIsFetchingQueries<TSchema extends {
|
|
280
325
|
url: string;
|
|
281
326
|
method: string;
|
|
282
327
|
}, TData, TParams = {}, TError = DefaultError> {
|
|
283
|
-
useIsFetching(filters?: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>, queryClient?: QueryClient): number;
|
|
328
|
+
useIsFetching<TInfinite extends boolean>(filters?: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, queryClient?: QueryClient): number;
|
|
284
329
|
}
|
|
285
330
|
interface ServiceOperationUseSuspenseQueries<TSchema extends {
|
|
286
331
|
url: string;
|
|
@@ -301,14 +346,14 @@ interface ServiceOperationUseInfiniteQuery<TSchema extends {
|
|
|
301
346
|
method: string;
|
|
302
347
|
}, TData, TParams = {}, TError = DefaultError> {
|
|
303
348
|
getInfiniteQueryKey<TQueryKeyParams extends TParams>(parameters: TQueryKeyParams): ServiceOperationInfiniteQueryKey<TSchema, TQueryKeyParams>;
|
|
304
|
-
useInfiniteQuery<TPageParam extends TParams>(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, options: Omit<UndefinedInitialDataInfiniteOptions<TData, TError, InfiniteData<TData>, ServiceOperationInfiniteQueryKey<TSchema, TParams>, PartialParameters<TPageParam>>, 'queryKey' | 'getPreviousPageParam' | 'getNextPageParam' | 'initialPageParam'> & InfiniteQueryPageParamsOptions<TData, PartialParameters<TPageParam>>, queryClient?: QueryClient): UseInfiniteQueryResult<InfiniteData<TData>, TError | Error>;
|
|
305
|
-
useInfiniteQuery<TPageParam extends TParams>(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, options: Omit<DefinedInitialDataInfiniteOptions<TData, TError, InfiniteData<TData>, ServiceOperationInfiniteQueryKey<TSchema, TParams>, PartialParameters<TPageParam>>, 'queryKey' | 'getPreviousPageParam' | 'getNextPageParam' | 'initialPageParam'> & InfiniteQueryPageParamsOptions<TData, PartialParameters<TPageParam>>, queryClient?: QueryClient): DefinedUseInfiniteQueryResult<InfiniteData<TData>, TError | Error>;
|
|
349
|
+
useInfiniteQuery<TPageParam extends TParams>(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, options: Omit<UndefinedInitialDataInfiniteOptions<TData, TError, InfiniteData<TData, TParams>, ServiceOperationInfiniteQueryKey<TSchema, TParams>, PartialParameters<TPageParam>>, 'queryKey' | 'getPreviousPageParam' | 'getNextPageParam' | 'initialPageParam'> & InfiniteQueryPageParamsOptions<TData, PartialParameters<TPageParam>>, queryClient?: QueryClient): UseInfiniteQueryResult<InfiniteData<TData, TParams>, TError | Error>;
|
|
350
|
+
useInfiniteQuery<TPageParam extends TParams>(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, options: Omit<DefinedInitialDataInfiniteOptions<TData, TError, InfiniteData<TData, TParams>, ServiceOperationInfiniteQueryKey<TSchema, TParams>, PartialParameters<TPageParam>>, 'queryKey' | 'getPreviousPageParam' | 'getNextPageParam' | 'initialPageParam'> & InfiniteQueryPageParamsOptions<TData, PartialParameters<TPageParam>>, queryClient?: QueryClient): DefinedUseInfiniteQueryResult<InfiniteData<TData, TParams>, TError | Error>;
|
|
306
351
|
}
|
|
307
352
|
interface ServiceOperationUseSuspenseInfiniteQuery<TSchema extends {
|
|
308
353
|
url: string;
|
|
309
354
|
method: string;
|
|
310
355
|
}, TData, TParams = {}, TError = DefaultError> {
|
|
311
|
-
useSuspenseInfiniteQuery<TPageParam extends TParams>(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, options: Omit<UseSuspenseInfiniteQueryOptions<TData, TError, InfiniteData<TData>, TData, ServiceOperationInfiniteQueryKey<TSchema, TParams>, PartialParameters<TPageParam>>, 'queryKey' | 'getPreviousPageParam' | 'getNextPageParam' | 'initialPageParam'> & InfiniteQueryPageParamsOptions<TData, PartialParameters<TPageParam>>, queryClient?: QueryClient): UseSuspenseInfiniteQueryResult<InfiniteData<TData>, TError | Error>;
|
|
356
|
+
useSuspenseInfiniteQuery<TPageParam extends TParams>(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, options: Omit<UseSuspenseInfiniteQueryOptions<TData, TError, InfiniteData<TData, TParams>, TData, ServiceOperationInfiniteQueryKey<TSchema, TParams>, PartialParameters<TPageParam>>, 'queryKey' | 'getPreviousPageParam' | 'getNextPageParam' | 'initialPageParam'> & InfiniteQueryPageParamsOptions<TData, PartialParameters<TPageParam>>, queryClient?: QueryClient): UseSuspenseInfiniteQueryResult<InfiniteData<TData, TParams>, TError | Error>;
|
|
312
357
|
}
|
|
313
358
|
interface ServiceOperationUseSuspenseQueryQuery<TSchema extends {
|
|
314
359
|
url: string;
|
|
@@ -319,7 +364,7 @@ interface ServiceOperationUseSuspenseQueryQuery<TSchema extends {
|
|
|
319
364
|
export interface ServiceOperationMutation<TSchema extends {
|
|
320
365
|
url: string;
|
|
321
366
|
method: string;
|
|
322
|
-
}, TBody, TData, TParams, TError = DefaultError> extends ServiceOperationUseMutation<TSchema, TBody, TData, TParams, TError>, ServiceOperationUseMutationState<TSchema, TBody, TData, TParams, TError>, ServiceOperationMutationFn<TSchema, TBody, TData, TParams> {
|
|
367
|
+
}, TBody, TData, TParams, TError = DefaultError> extends ServiceOperationUseMutation<TSchema, TBody, TData, TParams, TError>, ServiceOperationUseIsMutating<TSchema, TBody, TData, TParams, TError>, ServiceOperationUseMutationState<TSchema, TBody, TData, TParams, TError>, ServiceOperationIsMutatingQueries<TSchema, TBody, TData, TParams, TError>, ServiceOperationMutationFn<TSchema, TBody, TData, TParams> {
|
|
323
368
|
schema: TSchema;
|
|
324
369
|
types: {
|
|
325
370
|
parameters: TParams;
|
|
@@ -332,7 +377,7 @@ interface ServiceOperationUseMutation<TSchema extends {
|
|
|
332
377
|
url: string;
|
|
333
378
|
method: string;
|
|
334
379
|
}, TBody, TData, TParams, TError = DefaultError> {
|
|
335
|
-
getMutationKey<TMutationKeyParams extends TParams>(parameters
|
|
380
|
+
getMutationKey<TMutationKeyParams extends TParams | undefined = undefined>(parameters?: TMutationKeyParams): ServiceOperationMutationKey<TSchema, TMutationKeyParams>;
|
|
336
381
|
useMutation<TVariables extends MutationVariables<TBody, TParams>, TContext = unknown>(parameters?: undefined, options?: Omit<UseMutationOptions<TData, TError, TVariables, TContext>, 'mutationKey'> & {
|
|
337
382
|
mutationKey?: ServiceOperationMutationKey<TSchema, TParams>;
|
|
338
383
|
}, queryClient?: QueryClient): UseMutationResult<TData, TError | Error, TVariables, TContext>;
|
|
@@ -352,13 +397,14 @@ interface UseMutationStateFiltersBase<TBody, TData, TParams, TError = DefaultErr
|
|
|
352
397
|
*/
|
|
353
398
|
status?: MutationStatus;
|
|
354
399
|
}
|
|
355
|
-
interface
|
|
400
|
+
interface MutationFiltersByParameters<TBody, TData, TParams, TError = DefaultError, TContext = unknown> extends UseMutationStateFiltersBase<TBody, TData, TParams, TError, TContext> {
|
|
356
401
|
/**
|
|
357
402
|
* Include mutations matching these parameters
|
|
358
403
|
*/
|
|
359
404
|
parameters?: PartialParameters<TParams>;
|
|
405
|
+
mutationKey?: never;
|
|
360
406
|
}
|
|
361
|
-
interface
|
|
407
|
+
interface MutationFiltersByMutationKey<TSchema extends {
|
|
362
408
|
url: string;
|
|
363
409
|
method: string;
|
|
364
410
|
}, TBody, TData, TParams, TError = DefaultError, TContext = unknown> extends UseMutationStateFiltersBase<TBody, TData, TParams, TError, TContext> {
|
|
@@ -366,6 +412,7 @@ interface UseMutationStateFiltersByMutationKey<TSchema extends {
|
|
|
366
412
|
* Include mutations matching this mutation key
|
|
367
413
|
*/
|
|
368
414
|
mutationKey?: ServiceOperationMutationKey<TSchema, PartialParameters<TParams>>;
|
|
415
|
+
parameters?: never;
|
|
369
416
|
}
|
|
370
417
|
type MutationVariables<TBody, TParams> = {
|
|
371
418
|
body: TBody;
|
|
@@ -375,10 +422,16 @@ interface ServiceOperationUseMutationState<TSchema extends {
|
|
|
375
422
|
method: string;
|
|
376
423
|
}, TBody, TData, TParams, TError = DefaultError> {
|
|
377
424
|
useMutationState<TContext = unknown, TResult = MutationState<TData, TError, MutationVariables<TBody, TParams>, TContext>>(options?: {
|
|
378
|
-
filters?:
|
|
425
|
+
filters?: MutationFiltersByParameters<TBody, TData, TParams, TError, TContext> | MutationFiltersByMutationKey<TSchema, TBody, TData, TParams, TError, TContext>;
|
|
379
426
|
select?: (mutation: Mutation<TData, TError, MutationVariables<TBody, TParams>, TContext>) => TResult;
|
|
380
427
|
}, queryClient?: QueryClient): Array<TResult>;
|
|
381
428
|
}
|
|
429
|
+
interface ServiceOperationUseIsMutating<TSchema extends {
|
|
430
|
+
url: string;
|
|
431
|
+
method: string;
|
|
432
|
+
}, TBody, TData, TParams, TError = DefaultError> {
|
|
433
|
+
useIsMutating<TContext = unknown>(filters?: MutationFiltersByParameters<TBody, TData, TParams, TError, TContext> | MutationFiltersByMutationKey<TSchema, TBody, TData, TParams, TError, TContext>, queryClient?: QueryClient): number;
|
|
434
|
+
}
|
|
382
435
|
interface QueryFnOptionsBase<TMeta extends Record<string, any>, TSignal extends AbortSignal = AbortSignal> {
|
|
383
436
|
signal?: TSignal;
|
|
384
437
|
meta?: TMeta;
|
|
@@ -424,11 +477,41 @@ export interface ServiceOperationSetQueryDataCallback<TSchema extends {
|
|
|
424
477
|
}, TData, TParams = {}> extends ServiceOperationSetQueryData<TSchema, TData, TParams> {
|
|
425
478
|
setQueryData(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>, updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>, options: SetDataOptions | QueryClient, queryClient?: QueryClient): TData | undefined;
|
|
426
479
|
}
|
|
480
|
+
interface ServiceOperationSetQueriesData<TSchema extends {
|
|
481
|
+
url: string;
|
|
482
|
+
method: string;
|
|
483
|
+
}, TData, TParams = {}, // todo::try to replace `TParams = {}` with `TParams = undefined`
|
|
484
|
+
TError = DefaultError> {
|
|
485
|
+
setQueriesData<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>, options: SetDataOptions, queryClient: QueryClient): Array<TData | undefined>;
|
|
486
|
+
setQueriesData<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>, queryClient: QueryClient): Array<TData | undefined>;
|
|
487
|
+
}
|
|
488
|
+
/**
|
|
489
|
+
* @internal
|
|
490
|
+
*/
|
|
491
|
+
export interface ServiceOperationSetQueriesDataCallback<TSchema extends {
|
|
492
|
+
url: string;
|
|
493
|
+
method: string;
|
|
494
|
+
}, TData, TParams = {}, TError = DefaultError> extends ServiceOperationSetQueriesData<TSchema, TData, TParams, TError> {
|
|
495
|
+
setQueriesData<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>, options: SetDataOptions | QueryClient, queryClient?: QueryClient): Array<TData | undefined>;
|
|
496
|
+
}
|
|
497
|
+
interface ServiceOperationGetQueriesData<TSchema extends {
|
|
498
|
+
url: string;
|
|
499
|
+
method: string;
|
|
500
|
+
}, TData, TParams = {}, // todo::try to replace `TParams = {}` with `TParams = undefined`
|
|
501
|
+
TError = DefaultError> {
|
|
502
|
+
getQueriesData<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, queryClient: QueryClient): TInfinite extends true ? Array<[
|
|
503
|
+
queryKey: ServiceOperationInfiniteQueryKey<TSchema, TParams>,
|
|
504
|
+
data: NoInfer<InfiniteData<TData, TParams>> | undefined
|
|
505
|
+
]> : Array<[
|
|
506
|
+
queryKey: ServiceOperationQueryKey<TSchema, TParams>,
|
|
507
|
+
data: TData | undefined
|
|
508
|
+
]>;
|
|
509
|
+
}
|
|
427
510
|
interface ServiceOperationSetInfiniteQueryData<TSchema extends {
|
|
428
511
|
url: string;
|
|
429
512
|
method: string;
|
|
430
513
|
}, TData, TParams = {}> {
|
|
431
|
-
setInfiniteQueryData(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, updater: Updater<NoInfer<InfiniteData<TData>> | undefined, NoInfer<InfiniteData<TData>> | undefined>, queryClient: QueryClient, options?: SetDataOptions): InfiniteData<TData> | undefined;
|
|
514
|
+
setInfiniteQueryData(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, updater: Updater<NoInfer<InfiniteData<TData, TParams>> | undefined, NoInfer<InfiniteData<TData, TParams>> | undefined>, queryClient: QueryClient, options?: SetDataOptions): InfiniteData<TData, TParams> | undefined;
|
|
432
515
|
}
|
|
433
516
|
interface ServiceOperationGetQueryData<TSchema extends {
|
|
434
517
|
url: string;
|
|
@@ -440,7 +523,14 @@ interface ServiceOperationGetInfiniteQueryData<TSchema extends {
|
|
|
440
523
|
url: string;
|
|
441
524
|
method: string;
|
|
442
525
|
}, TData, TParams = {}> {
|
|
443
|
-
getInfiniteQueryData(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, queryClient: QueryClient): InfiniteData<TData> | undefined;
|
|
526
|
+
getInfiniteQueryData(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, queryClient: QueryClient): InfiniteData<TData, TParams> | undefined;
|
|
527
|
+
}
|
|
528
|
+
interface ServiceOperationGetQueryState<TSchema extends {
|
|
529
|
+
url: string;
|
|
530
|
+
method: string;
|
|
531
|
+
}, TData, TParams = {}, TError = DefaultError> {
|
|
532
|
+
getQueryState(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>, queryClient: QueryClient): QueryState<TData, TError> | undefined;
|
|
533
|
+
getInfiniteQueryState(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, queryClient: QueryClient): QueryState<InfiniteData<TData, PartialParameters<TParams>>, TError> | undefined;
|
|
444
534
|
}
|
|
445
535
|
export interface ServiceOperationMutationFn<TSchema extends {
|
|
446
536
|
url: string;
|
|
@@ -461,6 +551,22 @@ export interface ServiceOperationMutationFn<TSchema extends {
|
|
|
461
551
|
body: TBody;
|
|
462
552
|
}): Promise<TData>;
|
|
463
553
|
}
|
|
554
|
+
interface ServiceOperationIsMutatingQueries<TSchema extends {
|
|
555
|
+
url: string;
|
|
556
|
+
method: string;
|
|
557
|
+
}, TBody, TData, TParams = {}, TError = DefaultError> {
|
|
558
|
+
isMutating<TContext>(filters: MutationFiltersByParameters<TBody, TData, TParams, TError, TContext> | MutationFiltersByMutationKey<TSchema, TBody, TData, TParams, TError, TContext>, queryClient: QueryClient): number;
|
|
559
|
+
isMutating(queryClient: QueryClient): number;
|
|
560
|
+
}
|
|
561
|
+
/**
|
|
562
|
+
* @internal
|
|
563
|
+
*/
|
|
564
|
+
export interface ServiceOperationIsMutatingQueriesCallback<TSchema extends {
|
|
565
|
+
url: string;
|
|
566
|
+
method: string;
|
|
567
|
+
}, TBody, TData, TParams = {}, TError = DefaultError> extends ServiceOperationIsMutatingQueries<TSchema, TBody, TData, TParams, TError> {
|
|
568
|
+
isMutating<TContext>(filters: MutationFiltersByParameters<TBody, TData, TParams, TError, TContext> | MutationFiltersByMutationKey<TSchema, TBody, TData, TParams, TError, TContext> | QueryClient, queryClient?: QueryClient): number;
|
|
569
|
+
}
|
|
464
570
|
/**
|
|
465
571
|
* Shallow partial 'parameters'.
|
|
466
572
|
* @example
|