@qualisero/openapi-endpoint 0.14.0 → 0.16.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/dist/cli.js +4 -3
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/openapi-helpers.d.ts +2 -2
- package/dist/openapi-helpers.d.ts.map +1 -1
- package/dist/openapi-mutation.d.ts.map +1 -1
- package/dist/openapi-mutation.js +1 -5
- package/dist/openapi-query.d.ts +9 -15
- package/dist/openapi-query.d.ts.map +1 -1
- package/dist/types.d.ts +6 -16
- package/dist/types.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/cli.js
CHANGED
|
@@ -1080,10 +1080,11 @@ import {
|
|
|
1080
1080
|
type MutationReturn,
|
|
1081
1081
|
type ReactiveOr,
|
|
1082
1082
|
type NoExcessReturn,
|
|
1083
|
-
type QueryClientLike,
|
|
1084
1083
|
type MaybeRefOrGetter,
|
|
1085
1084
|
} from '@qualisero/openapi-endpoint'
|
|
1086
1085
|
|
|
1086
|
+
import type { QueryClient } from '@tanstack/vue-query'
|
|
1087
|
+
|
|
1087
1088
|
import type {
|
|
1088
1089
|
ApiResponse,
|
|
1089
1090
|
ApiRequest,
|
|
@@ -1111,7 +1112,7 @@ ${registryEntries}
|
|
|
1111
1112
|
|
|
1112
1113
|
type _Config = {
|
|
1113
1114
|
axios: AxiosInstance
|
|
1114
|
-
queryClient:
|
|
1115
|
+
queryClient: QueryClient
|
|
1115
1116
|
operationsRegistry: typeof _registry
|
|
1116
1117
|
}
|
|
1117
1118
|
|
|
@@ -1158,7 +1159,7 @@ ${helpers}
|
|
|
1158
1159
|
* create.mutate({ data: { name: 'Fluffy' } })
|
|
1159
1160
|
* \`\`\`
|
|
1160
1161
|
*/
|
|
1161
|
-
export function createApiClient(axios: AxiosInstance, queryClient:
|
|
1162
|
+
export function createApiClient(axios: AxiosInstance, queryClient: QueryClient = defaultQueryClient) {
|
|
1162
1163
|
const base: _Config = { axios, queryClient, operationsRegistry: _registry }
|
|
1163
1164
|
return {
|
|
1164
1165
|
${factoryCalls}
|
package/dist/index.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ export { useEndpointMutation } from './openapi-mutation';
|
|
|
3
3
|
export { defaultQueryClient } from './openapi-helpers';
|
|
4
4
|
export type { QueryReturn } from './openapi-query';
|
|
5
5
|
export type { MutationReturn } from './openapi-mutation';
|
|
6
|
-
export type { EndpointConfig, QueryOptions, MutationOptions, MutationVars, CacheInvalidationOptions, Refetchable, MutateFn, MutateAsyncFn, MutateAsyncReturn, ReactiveOr, NoExcessReturn, AxiosRequestConfigExtended,
|
|
6
|
+
export type { EndpointConfig, QueryOptions, MutationOptions, MutationVars, CacheInvalidationOptions, Refetchable, MutateFn, MutateAsyncFn, MutateAsyncReturn, ReactiveOr, NoExcessReturn, AxiosRequestConfigExtended, ApiResponse, ApiResponseSafe, ApiRequest, ApiPathParams, ApiPathParamsInput, ApiQueryParams, } from './types';
|
|
7
7
|
export { HttpMethod, QUERY_METHODS, MUTATION_METHODS, isQueryMethod, isMutationMethod } from './types';
|
|
8
8
|
export type { Ref, ComputedRef } from 'vue';
|
|
9
9
|
export type { MaybeRefOrGetter } from '@vue/reactivity';
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAKtD,YAAY,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAClD,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAKxD,YAAY,EAEV,cAAc,EAGd,YAAY,EACZ,eAAe,EACf,YAAY,EAGZ,wBAAwB,EACxB,WAAW,EAGX,QAAQ,EACR,aAAa,EACb,iBAAiB,EAGjB,UAAU,EACV,cAAc,EAGd,0BAA0B,EAG1B,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAKtD,YAAY,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAClD,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAKxD,YAAY,EAEV,cAAc,EAGd,YAAY,EACZ,eAAe,EACf,YAAY,EAGZ,wBAAwB,EACxB,WAAW,EAGX,QAAQ,EACR,aAAa,EACb,iBAAiB,EAGjB,UAAU,EACV,cAAc,EAGd,0BAA0B,EAG1B,WAAW,EACX,eAAe,EACf,UAAU,EACV,aAAa,EACb,kBAAkB,EAClB,cAAc,GACf,MAAM,SAAS,CAAA;AAKhB,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAKtG,YAAY,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,KAAK,CAAA;AAC3C,YAAY,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { QueryClient } from '@tanstack/vue-query';
|
|
2
2
|
/**
|
|
3
3
|
* Default QueryClient with sensible defaults (5-minute stale time).
|
|
4
4
|
* Used when no custom QueryClient is provided to the generated `createApiClient`.
|
|
5
5
|
*/
|
|
6
|
-
export declare const defaultQueryClient:
|
|
6
|
+
export declare const defaultQueryClient: QueryClient;
|
|
7
7
|
//# sourceMappingURL=openapi-helpers.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openapi-helpers.d.ts","sourceRoot":"","sources":["../src/openapi-helpers.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"openapi-helpers.d.ts","sourceRoot":"","sources":["../src/openapi-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAEjD;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,WAI/B,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openapi-mutation.d.ts","sourceRoot":"","sources":["../src/openapi-mutation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,WAAW,EAAE,KAAK,GAAG,EAAE,MAAM,KAAK,CAAA;AAC/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAEvD,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAA;AAE1C,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,eAAe,EAEpB,KAAK,QAAQ,EACb,KAAK,aAAa,EAGnB,MAAM,SAAS,CAAA;AAShB;;;;;;;;;GASG;AACH,MAAM,WAAW,cAAc,CAC7B,SAAS,EACT,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EACnE,QAAQ,GAAG,KAAK,EAChB,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;IAEpE,+DAA+D;IAC/D,IAAI,EAAE,WAAW,CAAC,aAAa,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,CAAA;IACvD,wCAAwC;IACxC,KAAK,EAAE,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,CAAA;IACxB,8CAA8C;IAC9C,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACvB,wCAAwC;IACxC,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACvB,qCAAqC;IACrC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACrB,2CAA2C;IAC3C,MAAM,EAAE,QAAQ,CAAC,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAA;IACrD,mDAAmD;IACnD,WAAW,EAAE,aAAa,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAA;IAC1E,gCAAgC;IAChC,KAAK,EAAE,MAAM,IAAI,CAAA;IACjB,gFAAgF;IAChF,SAAS,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC/B,oCAAoC;IACpC,UAAU,EAAE,WAAW,CAAC,WAAW,CAAC,CAAA;IACpC,oEAAoE;IACpE,eAAe,EAAE,GAAG,CAAC,WAAW,CAAC,CAAA;CAClC;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,EACT,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EACnE,QAAQ,GAAG,KAAK,EAChB,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAEpE,MAAM,EAAE,cAAc,EACtB,UAAU,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,EAC7F,OAAO,CAAC,EAAE,eAAe,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,GACxE,cAAc,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,
|
|
1
|
+
{"version":3,"file":"openapi-mutation.d.ts","sourceRoot":"","sources":["../src/openapi-mutation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,WAAW,EAAE,KAAK,GAAG,EAAE,MAAM,KAAK,CAAA;AAC/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAEvD,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAA;AAE1C,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,eAAe,EAEpB,KAAK,QAAQ,EACb,KAAK,aAAa,EAGnB,MAAM,SAAS,CAAA;AAShB;;;;;;;;;GASG;AACH,MAAM,WAAW,cAAc,CAC7B,SAAS,EACT,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EACnE,QAAQ,GAAG,KAAK,EAChB,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;IAEpE,+DAA+D;IAC/D,IAAI,EAAE,WAAW,CAAC,aAAa,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,CAAA;IACvD,wCAAwC;IACxC,KAAK,EAAE,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,CAAA;IACxB,8CAA8C;IAC9C,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACvB,wCAAwC;IACxC,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACvB,qCAAqC;IACrC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACrB,2CAA2C;IAC3C,MAAM,EAAE,QAAQ,CAAC,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAA;IACrD,mDAAmD;IACnD,WAAW,EAAE,aAAa,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAA;IAC1E,gCAAgC;IAChC,KAAK,EAAE,MAAM,IAAI,CAAA;IACjB,gFAAgF;IAChF,SAAS,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC/B,oCAAoC;IACpC,UAAU,EAAE,WAAW,CAAC,WAAW,CAAC,CAAA;IACpC,oEAAoE;IACpE,eAAe,EAAE,GAAG,CAAC,WAAW,CAAC,CAAA;CAClC;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,EACT,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EACnE,QAAQ,GAAG,KAAK,EAChB,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAEpE,MAAM,EAAE,cAAc,EACtB,UAAU,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,EAC7F,OAAO,CAAC,EAAE,eAAe,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,GACxE,cAAc,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,CAmLhE"}
|
package/dist/openapi-mutation.js
CHANGED
|
@@ -125,11 +125,7 @@ export function useEndpointMutation(config, pathParams, options) {
|
|
|
125
125
|
});
|
|
126
126
|
await Promise.all(promises);
|
|
127
127
|
}
|
|
128
|
-
const allRefetch = [
|
|
129
|
-
...(refetchEndpoints || []),
|
|
130
|
-
...(vars?.refetchEndpoints || []),
|
|
131
|
-
...(refetchEndpointsMutate || []),
|
|
132
|
-
];
|
|
128
|
+
const allRefetch = [...(refetchEndpoints || []), ...(refetchEndpointsMutate || [])];
|
|
133
129
|
if (allRefetch.length > 0) {
|
|
134
130
|
await Promise.all(allRefetch.map((ep) => ep.refetch()));
|
|
135
131
|
}
|
package/dist/openapi-query.d.ts
CHANGED
|
@@ -1,29 +1,23 @@
|
|
|
1
|
-
import { type ComputedRef
|
|
1
|
+
import { type ComputedRef } from 'vue';
|
|
2
2
|
import type { MaybeRefOrGetter } from '@vue/reactivity';
|
|
3
|
+
import { type UseQueryReturnType } from '@tanstack/vue-query';
|
|
3
4
|
import { type EndpointConfig, type QueryOptions } from './types';
|
|
4
5
|
/**
|
|
5
6
|
* Return type of `useEndpointQuery` (the `useQuery` composable on a generated namespace).
|
|
6
7
|
*
|
|
8
|
+
* Extends TanStack's `UseQueryReturnType<TResponse, Error>` so all fields — including
|
|
9
|
+
* `refetch`, `isPending`, `isLoading`, `isSuccess`, `isError`, `error`, etc. — carry
|
|
10
|
+
* their real TanStack types. `data` is overridden with a `ComputedRef` typed to
|
|
11
|
+
* `TResponse | undefined`, and three extra fields are added for our own abstractions.
|
|
12
|
+
*
|
|
7
13
|
* @template TResponse Response data type
|
|
8
14
|
* @template TPathParams Path parameters type (concrete, no undefined)
|
|
9
15
|
*
|
|
10
16
|
* @group Types
|
|
11
17
|
*/
|
|
12
|
-
export
|
|
18
|
+
export type QueryReturn<TResponse, TPathParams extends Record<string, unknown> = Record<string, never>> = Omit<UseQueryReturnType<TResponse, Error>, 'data' | 'isEnabled'> & {
|
|
13
19
|
/** The response data (undefined until loaded). */
|
|
14
20
|
data: ComputedRef<TResponse | undefined>;
|
|
15
|
-
/** The error if the query failed. */
|
|
16
|
-
error: Ref<Error | null>;
|
|
17
|
-
/** True while the query is loading. */
|
|
18
|
-
isPending: Ref<boolean>;
|
|
19
|
-
/** True while loading (alias for isPending). */
|
|
20
|
-
isLoading: Ref<boolean>;
|
|
21
|
-
/** True when the query succeeded. */
|
|
22
|
-
isSuccess: Ref<boolean>;
|
|
23
|
-
/** True when the query failed. */
|
|
24
|
-
isError: Ref<boolean>;
|
|
25
|
-
/** Manually trigger a refetch. */
|
|
26
|
-
refetch: () => Promise<void>;
|
|
27
21
|
/** Whether the query is currently enabled. */
|
|
28
22
|
isEnabled: ComputedRef<boolean>;
|
|
29
23
|
/** The resolved query key. */
|
|
@@ -32,7 +26,7 @@ export interface QueryReturn<TResponse, TPathParams extends Record<string, unkno
|
|
|
32
26
|
pathParams: ComputedRef<TPathParams>;
|
|
33
27
|
/** Register a callback for when data loads successfully for the first time. */
|
|
34
28
|
onLoad: (callback: (data: TResponse) => void) => void;
|
|
35
|
-
}
|
|
29
|
+
};
|
|
36
30
|
/**
|
|
37
31
|
* Execute a type-safe query (GET/HEAD/OPTIONS) with automatic caching.
|
|
38
32
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openapi-query.d.ts","sourceRoot":"","sources":["../src/openapi-query.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,KAAK,WAAW,EAAE,
|
|
1
|
+
{"version":3,"file":"openapi-query.d.ts","sourceRoot":"","sources":["../src/openapi-query.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,KAAK,WAAW,EAAE,MAAM,KAAK,CAAA;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACvD,OAAO,EAAY,KAAK,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAGvE,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,YAAY,EAAiB,MAAM,SAAS,CAAA;AAG/E;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,WAAW,CAAC,SAAS,EAAE,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,IAAI,CAC5G,kBAAkB,CAAC,SAAS,EAAE,KAAK,CAAC,EAIpC,MAAM,GAAG,WAAW,CACrB,GAAG;IACF,kDAAkD;IAClD,IAAI,EAAE,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC,CAAA;IACxC,8CAA8C;IAC9C,SAAS,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC/B,8BAA8B;IAC9B,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,CAAA;IACtD,oCAAoC;IACpC,UAAU,EAAE,WAAW,CAAC,WAAW,CAAC,CAAA;IACpC,+EAA+E;IAC/E,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,KAAK,IAAI,CAAA;CACtD,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EACT,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EACnE,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAEpE,MAAM,EAAE,cAAc,EACtB,UAAU,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,EAC7F,OAAO,CAAC,EAAE,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,GAC9C,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,CAuGrC"}
|
package/dist/types.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { type AxiosInstance, type AxiosError, type AxiosRequestConfig, type AxiosResponse } from 'axios';
|
|
2
2
|
import type { MutationObserverOptions, QueryKey, QueryObserverOptions } from '@tanstack/query-core';
|
|
3
3
|
import type { ComputedRef, Ref } from 'vue';
|
|
4
|
+
import type { QueryClient } from '@tanstack/vue-query';
|
|
4
5
|
/**
|
|
5
6
|
* Extended Axios request configuration that allows custom properties.
|
|
6
7
|
*/
|
|
@@ -46,20 +47,6 @@ export type NoExcessReturn<T extends Record<string, unknown>, F extends () => T>
|
|
|
46
47
|
* @internal Used for internal type inference.
|
|
47
48
|
*/
|
|
48
49
|
export type ReactiveValue<T> = T | Ref<T> | ComputedRef<T>;
|
|
49
|
-
export interface QueryClientLike {
|
|
50
|
-
cancelQueries(filters: {
|
|
51
|
-
queryKey: unknown[];
|
|
52
|
-
exact?: boolean;
|
|
53
|
-
}): Promise<void>;
|
|
54
|
-
setQueryData(queryKey: unknown[], data: unknown): void;
|
|
55
|
-
invalidateQueries(filters: {
|
|
56
|
-
queryKey?: unknown[];
|
|
57
|
-
exact?: boolean;
|
|
58
|
-
predicate?: (query: {
|
|
59
|
-
queryKey: readonly unknown[];
|
|
60
|
-
}) => boolean;
|
|
61
|
-
}): Promise<void>;
|
|
62
|
-
}
|
|
63
50
|
/**
|
|
64
51
|
* Runtime configuration for a single endpoint. Passed directly to
|
|
65
52
|
* `useEndpointQuery` / `useEndpointMutation` by generated code.
|
|
@@ -69,7 +56,7 @@ export interface QueryClientLike {
|
|
|
69
56
|
*/
|
|
70
57
|
export interface EndpointConfig {
|
|
71
58
|
axios: AxiosInstance;
|
|
72
|
-
queryClient:
|
|
59
|
+
queryClient: QueryClient;
|
|
73
60
|
/** The OpenAPI path template, e.g. `/pets/{petId}` */
|
|
74
61
|
path: string;
|
|
75
62
|
method: HttpMethod;
|
|
@@ -91,9 +78,12 @@ export interface EndpointConfig {
|
|
|
91
78
|
/**
|
|
92
79
|
* Minimal interface satisfied by `QueryReturn`. Used for `refetchEndpoints`
|
|
93
80
|
* in cache invalidation options.
|
|
81
|
+
*
|
|
82
|
+
* Uses `Promise<unknown>` so this is compatible with TanStack's real `refetch`
|
|
83
|
+
* return type (`Promise<QueryObserverResult<TData, TError>>`).
|
|
94
84
|
*/
|
|
95
85
|
export interface Refetchable {
|
|
96
|
-
refetch: () => Promise<
|
|
86
|
+
refetch: () => Promise<unknown>;
|
|
97
87
|
}
|
|
98
88
|
/**
|
|
99
89
|
* Options for controlling automatic cache invalidation after mutations.
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,UAAU,EAAE,KAAK,kBAAkB,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAA;AACxG,OAAO,KAAK,EAAE,uBAAuB,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AACnG,OAAO,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,UAAU,EAAE,KAAK,kBAAkB,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAA;AACxG,OAAO,KAAK,EAAE,uBAAuB,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AACnG,OAAO,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAEtD;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAMrF,oBAAY,UAAU;IACpB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAED,eAAO,MAAM,aAAa,gEAAiE,CAAA;AAC3F,eAAO,MAAM,gBAAgB,iFAAkF,CAAA;AAE/G,wBAAgB,aAAa,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAEzD;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAE5D;AAMD;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;AAEnE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAC7E,OAAO,CAAC,MAAM,UAAU,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,SAAS,KAAK,GAAG,CAAC,GAAG,KAAK,CAAA;AAEjE;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;AAM1D;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,aAAa,CAAA;IACpB,WAAW,EAAE,WAAW,CAAA;IACxB,sDAAsD;IACtD,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,UAAU,CAAA;IAClB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC,CAAA;CAChE;AAMD;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAA;CAChC;AAMD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,wDAAwD;IACxD,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,0EAA0E;IAC1E,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAA;IACpF,mEAAmE;IACnE,gBAAgB,CAAC,EAAE,WAAW,EAAE,CAAA;CACjC;AAMD,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;AAClD,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,OAAO,GAC1D,CAAC,GACD,CAAC,SAAS,MAAM,GACd;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GACtC,YAAY,CAAC,CAAC,CAAC,CAAA;AAErB,KAAK,gBAAgB,CAAC,SAAS,EAAE,aAAa,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,YAAY,CAC5F,oBAAoB,CAAC,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,CACvE,GAAG;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAA;AAEzB;;;;;;;;;;GAUG;AACH,MAAM,MAAM,YAAY,CAAC,SAAS,EAAE,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,IAAI,CAC9G,gBAAgB,CAAC,SAAS,EAAE,YAAY,CAAC,EACzC,UAAU,GAAG,SAAS,GAAG,SAAS,CACnC,GAAG;IACF,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,CAAA;IAC7B,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAA;IAClC,YAAY,CAAC,EAAE,0BAA0B,CAAA;IACzC,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAAA;IAClF,WAAW,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAA;CACvC,CAAA;AAMD,KAAK,gBAAgB,CACnB,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3C,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC1C,wBAAwB,GAAG;IAC7B,UAAU,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAA;IACjC,YAAY,CAAC,EAAE,0BAA0B,CAAA;IACzC,WAAW,CAAC,EAAE,YAAY,CAAA;CAC3B,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,CACtB,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3C,QAAQ,EACR,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAClE,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,GAC1B,gBAAgB,CAAC,WAAW,EAAE,YAAY,CAAC,GAC3C,gBAAgB,CAAC,WAAW,EAAE,YAAY,CAAC,GAAG;IAAE,IAAI,CAAC,EAAE,QAAQ,CAAA;CAAE,CAAA;AAErE,KAAK,mBAAmB,CACtB,SAAS,EACT,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3C,QAAQ,EACR,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC1C,YAAY,CACd,uBAAuB,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,OAAO,CAAC,CACrH,GAAG;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAA;AAEzB;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,CACzB,SAAS,EACT,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3C,QAAQ,EACR,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAClE,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC,GACzG,wBAAwB,GAAG;IACzB,YAAY,CAAC,EAAE,0BAA0B,CAAA;IACzC,WAAW,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAA;CACvC,CAAA;AAMH;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,SAAS,IAAI,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAA;AAE5E;;GAEG;AACH,MAAM,MAAM,QAAQ,CAClB,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3C,QAAQ,EACR,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAClE,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,KAAK,IAAI,CAAA;AAEtE;;GAEG;AACH,MAAM,MAAM,aAAa,CACvB,SAAS,EACT,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3C,QAAQ,EACR,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAClE,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,KAAK,iBAAiB,CAAC,SAAS,CAAC,CAAA;AAW9F;;;GAGG;AACH,KAAK,MAAM,GAAG,MAAM,CAAA;AAEpB,KAAK,UAAU,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAA;AAE/C,KAAK,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;AAEnH,KAAK,UAAU,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;IAAE,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;AAEvG,KAAK,eAAe,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACpE,GAAG;KACD,CAAC,IAAI,MAAM,CAAC,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,KAAK,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;CACnE,CAAA;AAED,KAAK,mBAAmB,CAAC,GAAG,SAAS,MAAM,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC,SAAS;IACnF,SAAS,EAAE;QAAE,GAAG,EAAE;YAAE,OAAO,EAAE;gBAAE,kBAAkB,EAAE,MAAM,IAAI,CAAA;aAAE,CAAA;SAAE,CAAA;KAAE,CAAA;CACpE,GACG,IAAI,GACJ,GAAG,CAAC,EAAE,CAAC,SAAS;IAAE,SAAS,EAAE;QAAE,GAAG,EAAE;YAAE,OAAO,EAAE;gBAAE,kBAAkB,EAAE,MAAM,IAAI,CAAA;aAAE,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,GACrF,IAAI,GACJ,GAAG,CAAC,EAAE,CAAC,SAAS;IAAE,SAAS,EAAE;QAAE,GAAG,EAAE;YAAE,OAAO,EAAE;gBAAE,kBAAkB,EAAE,MAAM,IAAI,CAAA;aAAE,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,GACrF,IAAI,GACJ,GAAG,CAAC,EAAE,CAAC,SAAS;IAAE,SAAS,EAAE;QAAE,GAAG,EAAE;YAAE,OAAO,EAAE;gBAAE,kBAAkB,EAAE,MAAM,IAAI,CAAA;aAAE,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,GACrF,IAAI,GACJ,GAAG,CAAC,EAAE,CAAC,SAAS;IAAE,SAAS,EAAE;QAAE,GAAG,EAAE;YAAE,OAAO,EAAE;gBAAE,kBAAkB,EAAE,MAAM,IAAI,CAAA;aAAE,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,GACrF,IAAI,GACJ,GAAG,CAAC,EAAE,CAAC,SAAS;IAAE,SAAS,EAAE;QAAE,GAAG,EAAE;YAAE,OAAO,EAAE;gBAAE,kBAAkB,EAAE,MAAM,IAAI,CAAA;aAAE,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,GACrF,IAAI,GACJ,OAAO,CAAA;AAErB;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,GAAG,SAAS,MAAM,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,UAAU,CAAC,mBAAmB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAA;AAE5G;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,GAAG,SAAS,MAAM,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,eAAe,CAAC,mBAAmB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAA;AAErH,KAAK,QAAQ,CAAC,CAAC,IAAI;IACjB,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;QAAE,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KAAE,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,KAAK,GACpG,CAAC,GACD,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;CACjB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,CAAC,GAAG,SAAS,MAAM,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC,SAAS;IACjF,WAAW,EAAE;QAAE,OAAO,EAAE;YAAE,kBAAkB,EAAE,MAAM,IAAI,CAAA;SAAE,CAAA;KAAE,CAAA;CAC7D,GACG,QAAQ,CAAC,IAAI,CAAC,GACd,GAAG,CAAC,EAAE,CAAC,SAAS;IAAE,WAAW,EAAE;QAAE,OAAO,EAAE;YAAE,qBAAqB,EAAE,MAAM,IAAI,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,GACjF,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,GACzB,KAAK,CAAA;AAEX;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,GAAG,SAAS,MAAM,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC,SAAS;IACpF,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,UAAU,CAAA;KAAE,CAAA;CACvC,GACG,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACxC,UAAU,GACV,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GACvB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;AAEzB;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,GAAG,SAAS,MAAM,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI;KACxE,CAAC,IAAI,MAAM,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS;CAC3E,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,GAAG,SAAS,MAAM,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC,SAAS;IACrF,UAAU,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,WAAW,CAAA;KAAE,CAAA;CAC1C,GACG,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC;KAAG,CAAC,IAAI,MAAM,WAAW,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC;CAAE,GAC7C,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GACvB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA"}
|