@qualisero/openapi-endpoint 0.9.0 → 0.10.1
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/README.md +1 -1
- package/dist/index.d.ts +6 -9
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -12
- package/dist/openapi-helpers.d.ts +10 -2
- package/dist/openapi-helpers.d.ts.map +1 -1
- package/dist/openapi-helpers.js +13 -1
- package/dist/openapi-mutation.d.ts +4 -0
- package/dist/openapi-mutation.d.ts.map +1 -1
- package/dist/openapi-mutation.js +9 -2
- package/dist/openapi-query.d.ts +6 -0
- package/dist/openapi-query.d.ts.map +1 -1
- package/dist/openapi-query.js +9 -1
- package/dist/openapi-utils.js +1 -1
- package/dist/types.d.ts +56 -5
- package/dist/types.d.ts.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Vue OpenAPI Query
|
|
2
2
|
|
|
3
|
-
[](https://badge.fury.io/js/@qualisero%2Fopenapi-endpoint)
|
|
4
4
|
[](https://github.com/qualisero/openapi-endpoint/actions/workflows/ci.yml)
|
|
5
5
|
[](https://opensource.org/licenses/MIT)
|
|
6
6
|
[](https://bundlephobia.com/package/@qualisero/openapi-endpoint)
|
package/dist/index.d.ts
CHANGED
|
@@ -1,20 +1,13 @@
|
|
|
1
1
|
import type { MaybeRefOrGetter } from 'vue';
|
|
2
|
-
import { QueryClient } from '@tanstack/vue-query';
|
|
3
2
|
import { EndpointQueryReturn } from './openapi-query';
|
|
4
3
|
import { EndpointMutationReturn } from './openapi-mutation';
|
|
5
4
|
import { Operations, GetPathParameters, OpenApiConfig, QQueryOptions, QMutationOptions, IsQueryOperation } from './types';
|
|
6
|
-
export type { OpenApiConfig, OpenApiInstance, GetResponseData } from './types';
|
|
5
|
+
export type { OpenApiConfig, OpenApiInstance, GetResponseData, QueryClientLike } from './types';
|
|
6
|
+
export { queryClient } from './openapi-helpers';
|
|
7
7
|
/** @internal */
|
|
8
8
|
export { type EndpointQueryReturn, useEndpointQuery } from './openapi-query';
|
|
9
9
|
/** @internal */
|
|
10
10
|
export { type EndpointMutationReturn, useEndpointMutation } from './openapi-mutation';
|
|
11
|
-
/**
|
|
12
|
-
* Default QueryClient instance with pre-configured options.
|
|
13
|
-
*
|
|
14
|
-
* This client is used by default when no custom QueryClient is provided to useOpenApi.
|
|
15
|
-
* It includes sensible defaults like 5-minute stale time for queries.
|
|
16
|
-
*/
|
|
17
|
-
export declare const queryClient: QueryClient;
|
|
18
11
|
/**
|
|
19
12
|
* Creates a type-safe OpenAPI client for Vue applications.
|
|
20
13
|
*
|
|
@@ -112,6 +105,7 @@ export declare function useOpenApi<Ops extends Operations<Ops>>(config: OpenApiC
|
|
|
112
105
|
data: import("vue").ComputedRef<import("axios").AxiosResponse<import("./types").GetResponseData<Ops, Op>, any, {}> | undefined>;
|
|
113
106
|
isEnabled: import("vue").ComputedRef<boolean>;
|
|
114
107
|
extraPathParams: import("vue").Ref<GetPathParameters<Ops, Op>, GetPathParameters<Ops, Op>>;
|
|
108
|
+
pathParams: import("vue").ComputedRef<GetPathParameters<Ops, Op>>;
|
|
115
109
|
context: import("vue").Ref<unknown, unknown>;
|
|
116
110
|
error: import("vue").Ref<null, null>;
|
|
117
111
|
isError: import("vue").Ref<false, false>;
|
|
@@ -131,6 +125,7 @@ export declare function useOpenApi<Ops extends Operations<Ops>>(config: OpenApiC
|
|
|
131
125
|
data: import("vue").ComputedRef<import("axios").AxiosResponse<import("./types").GetResponseData<Ops, Op>, any, {}> | undefined>;
|
|
132
126
|
isEnabled: import("vue").ComputedRef<boolean>;
|
|
133
127
|
extraPathParams: import("vue").Ref<GetPathParameters<Ops, Op>, GetPathParameters<Ops, Op>>;
|
|
128
|
+
pathParams: import("vue").ComputedRef<GetPathParameters<Ops, Op>>;
|
|
134
129
|
context: import("vue").Ref<unknown, unknown>;
|
|
135
130
|
error: import("vue").Ref<null, null>;
|
|
136
131
|
isError: import("vue").Ref<false, false>;
|
|
@@ -150,6 +145,7 @@ export declare function useOpenApi<Ops extends Operations<Ops>>(config: OpenApiC
|
|
|
150
145
|
data: import("vue").ComputedRef<import("axios").AxiosResponse<import("./types").GetResponseData<Ops, Op>, any, {}> | undefined>;
|
|
151
146
|
isEnabled: import("vue").ComputedRef<boolean>;
|
|
152
147
|
extraPathParams: import("vue").Ref<GetPathParameters<Ops, Op>, GetPathParameters<Ops, Op>>;
|
|
148
|
+
pathParams: import("vue").ComputedRef<GetPathParameters<Ops, Op>>;
|
|
153
149
|
context: import("vue").Ref<unknown, unknown>;
|
|
154
150
|
error: import("vue").Ref<Error, Error>;
|
|
155
151
|
isError: import("vue").Ref<true, true>;
|
|
@@ -169,6 +165,7 @@ export declare function useOpenApi<Ops extends Operations<Ops>>(config: OpenApiC
|
|
|
169
165
|
data: import("vue").ComputedRef<import("axios").AxiosResponse<import("./types").GetResponseData<Ops, Op>, any, {}> | undefined>;
|
|
170
166
|
isEnabled: import("vue").ComputedRef<boolean>;
|
|
171
167
|
extraPathParams: import("vue").Ref<GetPathParameters<Ops, Op>, GetPathParameters<Ops, Op>>;
|
|
168
|
+
pathParams: import("vue").ComputedRef<GetPathParameters<Ops, Op>>;
|
|
172
169
|
context: import("vue").Ref<unknown, unknown>;
|
|
173
170
|
error: import("vue").Ref<null, null>;
|
|
174
171
|
isError: import("vue").Ref<false, false>;
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,KAAK,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,KAAK,CAAA;AAG3C,OAAO,EAAE,mBAAmB,EAAoB,MAAM,iBAAiB,CAAA;AACvE,OAAO,EAAE,sBAAsB,EAAuB,MAAM,oBAAoB,CAAA;AAChF,OAAO,EACL,UAAU,EACV,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAEhB,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAC/F,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,gBAAgB;AAChB,OAAO,EAAE,KAAK,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAC5E,gBAAgB;AAChB,OAAO,EAAE,KAAK,sBAAsB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAErF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,UAAU,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC;IAE9E;;;;;OAKG;6BAC+B,EAAE,SAAS,MAAM,GAAG,eAAe,EAAE,KAIxD,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC;IAGxC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;eACiB,EAAE,SAAS,MAAM,GAAG,eACzB,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,IAAI,GAAG,EAAE,GAAG,KAAK,wBAC1C,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAC1E,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,GACtB,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,kBAC5E,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,KACrC,mBAAmB,CAAC,GAAG,EAAE,EAAE,CAAC;IAM/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;kBACoB,EAAE,SAAS,MAAM,GAAG,eAC5B,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,KAAK,GAAG,EAAE,GAAG,KAAK,wBAC3C,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAC1E,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,GACzB,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,kBAC/E,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAO3C;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;kBACoB,EAAE,SAAS,MAAM,GAAG,eAC5B,EAAE,wBACO,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAC1E,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,IAAI,GACpC,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,GACtB,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,GAEvB,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,GAC/D,CAAC,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,IAAI,GAAG,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,kBACrF,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,IAAI,GAAG,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,KAC1G,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,IAAI,GAAG,mBAAmB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,sBAAsB,CAAC,GAAG,EAAE,EAAE,CAAC;EAM7G"}
|
package/dist/index.js
CHANGED
|
@@ -1,23 +1,12 @@
|
|
|
1
|
-
import { QueryClient } from '@tanstack/vue-query';
|
|
2
1
|
import { useEndpoint } from './openapi-endpoint';
|
|
3
2
|
import { useEndpointQuery } from './openapi-query';
|
|
4
3
|
import { useEndpointMutation } from './openapi-mutation';
|
|
5
4
|
import { getHelpers } from './openapi-helpers';
|
|
5
|
+
export { queryClient } from './openapi-helpers';
|
|
6
6
|
/** @internal */
|
|
7
7
|
export { useEndpointQuery } from './openapi-query';
|
|
8
8
|
/** @internal */
|
|
9
9
|
export { useEndpointMutation } from './openapi-mutation';
|
|
10
|
-
/**
|
|
11
|
-
* Default QueryClient instance with pre-configured options.
|
|
12
|
-
*
|
|
13
|
-
* This client is used by default when no custom QueryClient is provided to useOpenApi.
|
|
14
|
-
* It includes sensible defaults like 5-minute stale time for queries.
|
|
15
|
-
*/
|
|
16
|
-
export const queryClient = new QueryClient({
|
|
17
|
-
defaultOptions: {
|
|
18
|
-
queries: { staleTime: 1000 * 60 * 5 },
|
|
19
|
-
},
|
|
20
|
-
});
|
|
21
10
|
/**
|
|
22
11
|
* Creates a type-safe OpenAPI client for Vue applications.
|
|
23
12
|
*
|
|
@@ -1,4 +1,11 @@
|
|
|
1
|
-
import { type OperationInfo, OpenApiConfig, Operations } from './types';
|
|
1
|
+
import { type OperationInfo, OpenApiConfig, Operations, QueryClientLike } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Default QueryClient instance with pre-configured options.
|
|
4
|
+
*
|
|
5
|
+
* This client is used by default when no custom QueryClient is provided to useOpenApi.
|
|
6
|
+
* It includes sensible defaults like 5-minute stale time for queries.
|
|
7
|
+
*/
|
|
8
|
+
declare const defaultQueryClient: QueryClientLike;
|
|
2
9
|
export declare function getHelpers<Ops extends Operations<Ops>, Op extends keyof Ops>(config: OpenApiConfig<Ops>): {
|
|
3
10
|
getOperationInfo: (operationId: Op) => OperationInfo;
|
|
4
11
|
getListOperationPath: (operationId: Op) => string | null;
|
|
@@ -6,7 +13,8 @@ export declare function getHelpers<Ops extends Operations<Ops>, Op extends keyof
|
|
|
6
13
|
isQueryOperation: (operationId: Op) => boolean;
|
|
7
14
|
isMutationOperation: (operationId: Op) => boolean;
|
|
8
15
|
axios: import("axios").AxiosInstance;
|
|
9
|
-
queryClient:
|
|
16
|
+
queryClient: QueryClientLike;
|
|
10
17
|
};
|
|
11
18
|
export type OpenApiHelpers<Ops extends Operations<Ops>, Op extends keyof Ops> = ReturnType<typeof getHelpers<Ops, Op>>;
|
|
19
|
+
export { defaultQueryClient as queryClient };
|
|
12
20
|
//# sourceMappingURL=openapi-helpers.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openapi-helpers.d.ts","sourceRoot":"","sources":["../src/openapi-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,KAAK,aAAa,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;
|
|
1
|
+
{"version":3,"file":"openapi-helpers.d.ts","sourceRoot":"","sources":["../src/openapi-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,KAAK,aAAa,EAAE,aAAa,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAGpG;;;;;GAKG;AACH,QAAA,MAAM,kBAAkB,EAAE,eAIxB,CAAA;AAiBF,wBAAgB,UAAU,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC;oCAE/D,EAAE,KAAG,aAAa;wCAMd,EAAE,KAAG,MAAM,GAAG,IAAI;yCAiCjB,EAAE,KAAG,MAAM,GAAG,IAAI;oCAevB,EAAE,KAAG,OAAO;uCAMT,EAAE,KAAG,OAAO;;;EAcvD;AAED,MAAM,MAAM,cAAc,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,UAAU,CAAC,OAAO,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAA;AAEtH,OAAO,EAAE,kBAAkB,IAAI,WAAW,EAAE,CAAA"}
|
package/dist/openapi-helpers.js
CHANGED
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
import { HttpMethod } from './types';
|
|
2
|
-
import {
|
|
2
|
+
import { QueryClient } from '@tanstack/vue-query';
|
|
3
|
+
/**
|
|
4
|
+
* Default QueryClient instance with pre-configured options.
|
|
5
|
+
*
|
|
6
|
+
* This client is used by default when no custom QueryClient is provided to useOpenApi.
|
|
7
|
+
* It includes sensible defaults like 5-minute stale time for queries.
|
|
8
|
+
*/
|
|
9
|
+
const defaultQueryClient = new QueryClient({
|
|
10
|
+
defaultOptions: {
|
|
11
|
+
queries: { staleTime: 1000 * 60 * 5 },
|
|
12
|
+
},
|
|
13
|
+
});
|
|
3
14
|
// Helper returning the operationId prefix given an http method
|
|
4
15
|
function getMethodPrefix(method) {
|
|
5
16
|
const METHOD_PREFIXES = {
|
|
@@ -86,3 +97,4 @@ export function getHelpers(config) {
|
|
|
86
97
|
queryClient: config.queryClient || defaultQueryClient,
|
|
87
98
|
};
|
|
88
99
|
}
|
|
100
|
+
export { defaultQueryClient as queryClient };
|
|
@@ -38,6 +38,7 @@ pathParamsOrOptions?: MaybeRefOrGetter<GetPathParameters<Ops, Op> | null | undef
|
|
|
38
38
|
data: ComputedRef<AxiosResponse<GetResponseData<Ops, Op>> | undefined>;
|
|
39
39
|
isEnabled: ComputedRef<boolean>;
|
|
40
40
|
extraPathParams: Ref<GetPathParameters<Ops, Op>, GetPathParameters<Ops, Op>>;
|
|
41
|
+
pathParams: ComputedRef<GetPathParameters<Ops, Op>>;
|
|
41
42
|
context: Ref<unknown, unknown>;
|
|
42
43
|
error: Ref<null, null>;
|
|
43
44
|
isError: Ref<false, false>;
|
|
@@ -57,6 +58,7 @@ pathParamsOrOptions?: MaybeRefOrGetter<GetPathParameters<Ops, Op> | null | undef
|
|
|
57
58
|
data: ComputedRef<AxiosResponse<GetResponseData<Ops, Op>> | undefined>;
|
|
58
59
|
isEnabled: ComputedRef<boolean>;
|
|
59
60
|
extraPathParams: Ref<GetPathParameters<Ops, Op>, GetPathParameters<Ops, Op>>;
|
|
61
|
+
pathParams: ComputedRef<GetPathParameters<Ops, Op>>;
|
|
60
62
|
context: Ref<unknown, unknown>;
|
|
61
63
|
error: Ref<null, null>;
|
|
62
64
|
isError: Ref<false, false>;
|
|
@@ -76,6 +78,7 @@ pathParamsOrOptions?: MaybeRefOrGetter<GetPathParameters<Ops, Op> | null | undef
|
|
|
76
78
|
data: ComputedRef<AxiosResponse<GetResponseData<Ops, Op>> | undefined>;
|
|
77
79
|
isEnabled: ComputedRef<boolean>;
|
|
78
80
|
extraPathParams: Ref<GetPathParameters<Ops, Op>, GetPathParameters<Ops, Op>>;
|
|
81
|
+
pathParams: ComputedRef<GetPathParameters<Ops, Op>>;
|
|
79
82
|
context: Ref<unknown, unknown>;
|
|
80
83
|
error: Ref<Error, Error>;
|
|
81
84
|
isError: Ref<true, true>;
|
|
@@ -95,6 +98,7 @@ pathParamsOrOptions?: MaybeRefOrGetter<GetPathParameters<Ops, Op> | null | undef
|
|
|
95
98
|
data: ComputedRef<AxiosResponse<GetResponseData<Ops, Op>> | undefined>;
|
|
96
99
|
isEnabled: ComputedRef<boolean>;
|
|
97
100
|
extraPathParams: Ref<GetPathParameters<Ops, Op>, GetPathParameters<Ops, Op>>;
|
|
101
|
+
pathParams: ComputedRef<GetPathParameters<Ops, Op>>;
|
|
98
102
|
context: Ref<unknown, unknown>;
|
|
99
103
|
error: Ref<null, null>;
|
|
100
104
|
isError: Ref<false, false>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openapi-mutation.d.ts","sourceRoot":"","sources":["../src/openapi-mutation.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,KAAK,WAAW,EAAE,KAAK,GAAG,EAAE,KAAK,gBAAgB,EAAE,MAAM,KAAK,CAAA;AAG/F,OAAO,EACL,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EAErB,UAAU,EACV,cAAc,EACf,MAAM,SAAS,CAAA;AAEhB,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAA;AAE1C,MAAM,MAAM,sBAAsB,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,UAAU,CAChG,OAAO,mBAAmB,CAAC,GAAG,EAAE,EAAE,CAAC,CACpC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,EACnF,WAAW,EAAE,EAAE,EACf,CAAC,EAAE,cAAc,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,UAAU;AACtC,mBAAmB,CAAC,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,EACjH,aAAa,CAAC,EAAE,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"openapi-mutation.d.ts","sourceRoot":"","sources":["../src/openapi-mutation.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,KAAK,WAAW,EAAE,KAAK,GAAG,EAAE,KAAK,gBAAgB,EAAE,MAAM,KAAK,CAAA;AAG/F,OAAO,EACL,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EAErB,UAAU,EACV,cAAc,EACf,MAAM,SAAS,CAAA;AAEhB,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAA;AAE1C,MAAM,MAAM,sBAAsB,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,UAAU,CAChG,OAAO,mBAAmB,CAAC,GAAG,EAAE,EAAE,CAAC,CACpC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,EACnF,WAAW,EAAE,EAAE,EACf,CAAC,EAAE,cAAc,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,UAAU;AACtC,mBAAmB,CAAC,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,EACjH,aAAa,CAAC,EAAE,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC;UAoJhB,WAAW,CAAC,aAAa,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;UAAhE,WAAW,CAAC,aAAa,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;UAAhE,WAAW,CAAC,aAAa,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;UAAhE,WAAW,CAAC,aAAa,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;;;;;;;;;;;;;;;;;;;EAK1F"}
|
package/dist/openapi-mutation.js
CHANGED
|
@@ -42,9 +42,15 @@ pathParamsOrOptions, optionsOrNull) {
|
|
|
42
42
|
const { pathParams, options } = getParamsOptionsFrom(path, pathParamsOrOptions, optionsOrNull);
|
|
43
43
|
const { axiosOptions, dontInvalidate, dontUpdateCache, invalidateOperations, refetchEndpoints, ...useMutationOptions } = options;
|
|
44
44
|
const extraPathParams = ref({});
|
|
45
|
-
// Compute the resolved path
|
|
45
|
+
// Compute the resolved path - same pattern as query
|
|
46
|
+
// This ensures that when pathParams is a function, it gets called within the computed
|
|
47
|
+
// so Vue can track dependencies of variables referenced inside the function
|
|
48
|
+
const basePathParams = computed(() => {
|
|
49
|
+
const result = toValue(pathParams);
|
|
50
|
+
return result;
|
|
51
|
+
});
|
|
46
52
|
const allPathParams = computed(() => ({
|
|
47
|
-
...
|
|
53
|
+
...basePathParams.value,
|
|
48
54
|
...extraPathParams.value,
|
|
49
55
|
}));
|
|
50
56
|
const resolvedPath = computed(() => resolvePath(path, allPathParams.value));
|
|
@@ -132,5 +138,6 @@ pathParamsOrOptions, optionsOrNull) {
|
|
|
132
138
|
data: mutation.data,
|
|
133
139
|
isEnabled: computed(() => isPathResolved(resolvedPath.value)),
|
|
134
140
|
extraPathParams,
|
|
141
|
+
pathParams: allPathParams,
|
|
135
142
|
};
|
|
136
143
|
}
|
package/dist/openapi-query.d.ts
CHANGED
|
@@ -29,6 +29,7 @@ export declare function useEndpointQuery<Ops extends Operations<Ops>, Op extends
|
|
|
29
29
|
isEnabled: ComputedRef<boolean>;
|
|
30
30
|
queryKey: ComputedRef<string[]>;
|
|
31
31
|
onLoad: (callback: (data: GetResponseData<Ops, Op>) => void) => void;
|
|
32
|
+
pathParams: ComputedRef<GetPathParameters<Ops, Op> | null | undefined>;
|
|
32
33
|
error: import("vue").Ref<Error, Error>;
|
|
33
34
|
isError: import("vue").Ref<true, true>;
|
|
34
35
|
isPending: import("vue").Ref<false, false>;
|
|
@@ -59,6 +60,7 @@ export declare function useEndpointQuery<Ops extends Operations<Ops>, Op extends
|
|
|
59
60
|
isEnabled: ComputedRef<boolean>;
|
|
60
61
|
queryKey: ComputedRef<string[]>;
|
|
61
62
|
onLoad: (callback: (data: GetResponseData<Ops, Op>) => void) => void;
|
|
63
|
+
pathParams: ComputedRef<GetPathParameters<Ops, Op> | null | undefined>;
|
|
62
64
|
error: import("vue").Ref<null, null>;
|
|
63
65
|
isError: import("vue").Ref<false, false>;
|
|
64
66
|
isPending: import("vue").Ref<false, false>;
|
|
@@ -89,6 +91,7 @@ export declare function useEndpointQuery<Ops extends Operations<Ops>, Op extends
|
|
|
89
91
|
isEnabled: ComputedRef<boolean>;
|
|
90
92
|
queryKey: ComputedRef<string[]>;
|
|
91
93
|
onLoad: (callback: (data: GetResponseData<Ops, Op>) => void) => void;
|
|
94
|
+
pathParams: ComputedRef<GetPathParameters<Ops, Op> | null | undefined>;
|
|
92
95
|
error: import("vue").Ref<Error, Error>;
|
|
93
96
|
isError: import("vue").Ref<true, true>;
|
|
94
97
|
isPending: import("vue").Ref<false, false>;
|
|
@@ -119,6 +122,7 @@ export declare function useEndpointQuery<Ops extends Operations<Ops>, Op extends
|
|
|
119
122
|
isEnabled: ComputedRef<boolean>;
|
|
120
123
|
queryKey: ComputedRef<string[]>;
|
|
121
124
|
onLoad: (callback: (data: GetResponseData<Ops, Op>) => void) => void;
|
|
125
|
+
pathParams: ComputedRef<GetPathParameters<Ops, Op> | null | undefined>;
|
|
122
126
|
error: import("vue").Ref<null, null>;
|
|
123
127
|
isError: import("vue").Ref<false, false>;
|
|
124
128
|
isPending: import("vue").Ref<true, true>;
|
|
@@ -149,6 +153,7 @@ export declare function useEndpointQuery<Ops extends Operations<Ops>, Op extends
|
|
|
149
153
|
isEnabled: ComputedRef<boolean>;
|
|
150
154
|
queryKey: ComputedRef<string[]>;
|
|
151
155
|
onLoad: (callback: (data: GetResponseData<Ops, Op>) => void) => void;
|
|
156
|
+
pathParams: ComputedRef<GetPathParameters<Ops, Op> | null | undefined>;
|
|
152
157
|
error: import("vue").Ref<null, null>;
|
|
153
158
|
isError: import("vue").Ref<false, false>;
|
|
154
159
|
isPending: import("vue").Ref<true, true>;
|
|
@@ -179,6 +184,7 @@ export declare function useEndpointQuery<Ops extends Operations<Ops>, Op extends
|
|
|
179
184
|
isEnabled: ComputedRef<boolean>;
|
|
180
185
|
queryKey: ComputedRef<string[]>;
|
|
181
186
|
onLoad: (callback: (data: GetResponseData<Ops, Op>) => void) => void;
|
|
187
|
+
pathParams: ComputedRef<GetPathParameters<Ops, Op> | null | undefined>;
|
|
182
188
|
isError: import("vue").Ref<false, false>;
|
|
183
189
|
error: import("vue").Ref<null, null>;
|
|
184
190
|
isPending: import("vue").Ref<false, false>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openapi-query.d.ts","sourceRoot":"","sources":["../src/openapi-query.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,KAAK,WAAW,EAAE,KAAK,gBAAgB,EAAE,MAAM,KAAK,CAAA;AAEvF,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE,KAAK,aAAa,EAAE,MAAM,SAAS,CAAA;AAGtG,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAEvD,MAAM,MAAM,mBAAmB,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,UAAU,CAC7F,OAAO,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,CACjC,GAAG;IACF,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,IAAI,KAAK,IAAI,CAAA;CACrE,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,EAChF,WAAW,EAAE,EAAE,EACf,CAAC,EAAE,cAAc,CAAC,GAAG,EAAE,EAAE,CAAC,EAC1B,mBAAmB,CAAC,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,EAC9G,aAAa,CAAC,EAAE,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"openapi-query.d.ts","sourceRoot":"","sources":["../src/openapi-query.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,KAAK,WAAW,EAAE,KAAK,gBAAgB,EAAE,MAAM,KAAK,CAAA;AAEvF,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE,KAAK,aAAa,EAAE,MAAM,SAAS,CAAA;AAGtG,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAEvD,MAAM,MAAM,mBAAmB,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,UAAU,CAC7F,OAAO,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,CACjC,GAAG;IACF,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,IAAI,KAAK,IAAI,CAAA;CACrE,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,EAChF,WAAW,EAAE,EAAE,EACf,CAAC,EAAE,cAAc,CAAC,GAAG,EAAE,EAAE,CAAC,EAC1B,mBAAmB,CAAC,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,EAC9G,aAAa,CAAC,EAAE,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC;UAsGhB,WAAW,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC;;;uBAN7C,CAAC,IAAI,EAAE,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAM5C,WAAW,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC;;;uBAN7C,CAAC,IAAI,EAAE,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAM5C,WAAW,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC;;;uBAN7C,CAAC,IAAI,EAAE,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAM5C,WAAW,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC;;;uBAN7C,CAAC,IAAI,EAAE,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAM5C,WAAW,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC;;;uBAN7C,CAAC,IAAI,EAAE,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAM5C,WAAW,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC;;;uBAN7C,CAAC,IAAI,EAAE,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;EAYnE"}
|
package/dist/openapi-query.js
CHANGED
|
@@ -30,7 +30,14 @@ export function useEndpointQuery(operationId, h, pathParamsOrOptions, optionsOrN
|
|
|
30
30
|
const { path, method } = h.getOperationInfo(operationId);
|
|
31
31
|
const { pathParams, options } = getParamsOptionsFrom(path, pathParamsOrOptions, optionsOrNull);
|
|
32
32
|
const { enabled: enabledInit, onLoad: onLoadInit, axiosOptions, errorHandler, ...useQueryOptions } = options;
|
|
33
|
-
|
|
33
|
+
// Make path parameters reactive by ensuring toValue is called inside computed
|
|
34
|
+
// This ensures that when pathParams is a function, it gets called within the computed
|
|
35
|
+
// so Vue can track dependencies of variables referenced inside the function
|
|
36
|
+
const allPathParams = computed(() => {
|
|
37
|
+
const result = toValue(pathParams);
|
|
38
|
+
return result;
|
|
39
|
+
});
|
|
40
|
+
const resolvedPath = computed(() => resolvePath(path, allPathParams.value));
|
|
34
41
|
const queryKey = computed(() => generateQueryKey(resolvedPath.value));
|
|
35
42
|
// Check if path is fully resolved for enabling the query
|
|
36
43
|
const isEnabled = computed(() => {
|
|
@@ -109,5 +116,6 @@ export function useEndpointQuery(operationId, h, pathParamsOrOptions, optionsOrN
|
|
|
109
116
|
isEnabled,
|
|
110
117
|
queryKey,
|
|
111
118
|
onLoad,
|
|
119
|
+
pathParams: allPathParams,
|
|
112
120
|
};
|
|
113
121
|
}
|
package/dist/openapi-utils.js
CHANGED
|
@@ -60,7 +60,7 @@ export function getParamsOptionsFrom(path, pathParamsOrOptions, optionsOrNull) {
|
|
|
60
60
|
let options = undefined;
|
|
61
61
|
if (optionsOrNull === undefined) {
|
|
62
62
|
const pathParamsOrOptionsValue = toValue(pathParamsOrOptions);
|
|
63
|
-
if (typeof pathParamsOrOptions === 'object' &&
|
|
63
|
+
if ((typeof pathParamsOrOptions === 'object' || typeof pathParamsOrOptions === 'function') &&
|
|
64
64
|
pathParamsOrOptions !== null &&
|
|
65
65
|
pathParamsOrOptionsValue &&
|
|
66
66
|
typeof pathParamsOrOptionsValue === 'object' &&
|
package/dist/types.d.ts
CHANGED
|
@@ -1,11 +1,50 @@
|
|
|
1
1
|
import { type AxiosInstance, type AxiosError, type AxiosRequestConfig, type AxiosResponse } from 'axios';
|
|
2
|
-
import { UseMutationOptions, type UseQueryOptions
|
|
2
|
+
import { UseMutationOptions, type UseQueryOptions } from '@tanstack/vue-query';
|
|
3
3
|
import type { MaybeRef, MaybeRefOrGetter } from 'vue';
|
|
4
4
|
import type { EndpointQueryReturn } from './openapi-query';
|
|
5
5
|
import type { EndpointMutationReturn } from './openapi-mutation';
|
|
6
|
+
/**
|
|
7
|
+
* Extended Axios request configuration that allows custom properties.
|
|
8
|
+
*
|
|
9
|
+
* This type extends the standard AxiosRequestConfig to support custom properties
|
|
10
|
+
* that users might add through module augmentation. It ensures compatibility with
|
|
11
|
+
* both standard axios options and user-defined custom properties.
|
|
12
|
+
*/
|
|
13
|
+
export type AxiosRequestConfigExtended = AxiosRequestConfig & Record<string, unknown>;
|
|
6
14
|
/** @internal */
|
|
7
15
|
export type { EndpointQueryReturn, EndpointMutationReturn };
|
|
8
16
|
export type OperationId = string;
|
|
17
|
+
/**
|
|
18
|
+
* Interface defining the minimal QueryClient methods required by this library.
|
|
19
|
+
*
|
|
20
|
+
* This interface ensures compatibility with different versions of @tanstack/vue-query
|
|
21
|
+
* by only requiring the specific methods that are actually used internally.
|
|
22
|
+
* This prevents version compatibility issues where internal implementation details
|
|
23
|
+
* (like private properties) might differ between versions.
|
|
24
|
+
*/
|
|
25
|
+
export interface QueryClientLike {
|
|
26
|
+
/**
|
|
27
|
+
* Cancel running queries that match the provided filters.
|
|
28
|
+
* Used to prevent race conditions when mutations affect data.
|
|
29
|
+
*/
|
|
30
|
+
cancelQueries(filters: {
|
|
31
|
+
queryKey: unknown[];
|
|
32
|
+
exact?: boolean;
|
|
33
|
+
}): Promise<void>;
|
|
34
|
+
/**
|
|
35
|
+
* Set query data for a specific query key.
|
|
36
|
+
* Used for optimistic updates after successful mutations.
|
|
37
|
+
*/
|
|
38
|
+
setQueryData(queryKey: unknown[], data: unknown): void;
|
|
39
|
+
/**
|
|
40
|
+
* Invalidate queries that match the provided filters.
|
|
41
|
+
* Used to trigger refetches of related data after mutations.
|
|
42
|
+
*/
|
|
43
|
+
invalidateQueries(filters: {
|
|
44
|
+
queryKey: unknown[];
|
|
45
|
+
exact?: boolean;
|
|
46
|
+
}): Promise<void>;
|
|
47
|
+
}
|
|
9
48
|
export type Operations<Ops> = object & {
|
|
10
49
|
[K in keyof Ops]: {
|
|
11
50
|
method: HttpMethod;
|
|
@@ -19,6 +58,7 @@ export type Operations<Ops> = object & {
|
|
|
19
58
|
* from your OpenAPI specification) and an Axios instance for making HTTP requests.
|
|
20
59
|
*
|
|
21
60
|
* @template Ops - The operations type, typically generated from your OpenAPI specification
|
|
61
|
+
* @template AxiosConfig - The axios request configuration type (defaults to AxiosRequestConfig)
|
|
22
62
|
*
|
|
23
63
|
* @example
|
|
24
64
|
* ```typescript
|
|
@@ -26,6 +66,7 @@ export type Operations<Ops> = object & {
|
|
|
26
66
|
* import { openApiOperations, type OpenApiOperations } from './generated/api-operations'
|
|
27
67
|
* import axios from 'axios'
|
|
28
68
|
*
|
|
69
|
+
* // Basic usage with default axios config
|
|
29
70
|
* const config: OpenApiConfig<OpenApiOperations> = {
|
|
30
71
|
* operations: openApiOperations,
|
|
31
72
|
* axios: axios.create({
|
|
@@ -34,6 +75,12 @@ export type Operations<Ops> = object & {
|
|
|
34
75
|
* }),
|
|
35
76
|
* queryClient: customQueryClient // optional
|
|
36
77
|
* }
|
|
78
|
+
*
|
|
79
|
+
* // With custom axios config type (for module augmentation)
|
|
80
|
+
* const configWithCustomAxios: OpenApiConfig<OpenApiOperations, MyCustomAxiosRequestConfig> = {
|
|
81
|
+
* operations: openApiOperations,
|
|
82
|
+
* axios: customAxiosInstance
|
|
83
|
+
* }
|
|
37
84
|
* ```
|
|
38
85
|
*/
|
|
39
86
|
export interface OpenApiConfig<Ops extends Operations<Ops>> {
|
|
@@ -50,8 +97,11 @@ export interface OpenApiConfig<Ops extends Operations<Ops>> {
|
|
|
50
97
|
/**
|
|
51
98
|
* Optional TanStack Query client instance.
|
|
52
99
|
* If not provided, a default QueryClient with sensible defaults will be used.
|
|
100
|
+
*
|
|
101
|
+
* Note: This accepts any QueryClient-like object that implements the required methods,
|
|
102
|
+
* ensuring compatibility across different versions of @tanstack/vue-query.
|
|
53
103
|
*/
|
|
54
|
-
queryClient?:
|
|
104
|
+
queryClient?: QueryClientLike;
|
|
55
105
|
}
|
|
56
106
|
export declare enum HttpMethod {
|
|
57
107
|
GET = "GET",
|
|
@@ -83,7 +133,7 @@ type OmitMaybeRef<T, K extends PropertyKey> = T extends MaybeRef<infer U> ? Mayb
|
|
|
83
133
|
export type QQueryOptions<Ops extends Operations<Ops>, Op extends keyof Ops> = OmitMaybeRef<UseQueryOptions<GetResponseData<Ops, Op>, Error, GetResponseData<Ops, Op>, GetResponseData<Ops, Op>>, 'queryKey' | 'queryFn' | 'enabled'> & {
|
|
84
134
|
enabled?: MaybeRefOrGetter<boolean>;
|
|
85
135
|
onLoad?: (data: GetResponseData<Ops, Op>) => void;
|
|
86
|
-
axiosOptions?:
|
|
136
|
+
axiosOptions?: AxiosRequestConfigExtended;
|
|
87
137
|
errorHandler?: (error: AxiosError) => GetResponseData<Ops, Op> | void | Promise<GetResponseData<Ops, Op> | void>;
|
|
88
138
|
};
|
|
89
139
|
type MutationOnSuccessOptions<Ops extends Operations<Ops>> = {
|
|
@@ -98,11 +148,11 @@ type MutationOnSuccessOptions<Ops extends Operations<Ops>> = {
|
|
|
98
148
|
export type QMutationVars<Ops extends Operations<Ops>, Op extends keyof Ops> = MutationOnSuccessOptions<Ops> & {
|
|
99
149
|
data?: GetRequestBody<Ops, Op>;
|
|
100
150
|
pathParams?: GetPathParameters<Ops, Op>;
|
|
101
|
-
axiosOptions?:
|
|
151
|
+
axiosOptions?: AxiosRequestConfigExtended;
|
|
102
152
|
};
|
|
103
153
|
/** @internal */
|
|
104
154
|
export type QMutationOptions<Ops extends Operations<Ops>, Op extends keyof Ops> = OmitMaybeRef<UseMutationOptions<AxiosResponse<GetResponseData<Ops, Op>>, Error, GetRequestBody<Ops, Op> extends never ? QMutationVars<Ops, Op> | void : QMutationVars<Ops, Op>>, 'mutationFn' | 'mutationKey'> & MutationOnSuccessOptions<Ops> & {
|
|
105
|
-
axiosOptions?:
|
|
155
|
+
axiosOptions?: AxiosRequestConfigExtended;
|
|
106
156
|
};
|
|
107
157
|
export type GetPathParameters<Ops extends Operations<Ops>, Op extends keyof Ops> = Ops[Op] extends {
|
|
108
158
|
parameters: {
|
|
@@ -147,6 +197,7 @@ export type IsQueryOperation<Ops extends Operations<Ops>, Op extends keyof Ops>
|
|
|
147
197
|
* on your OpenAPI specification.
|
|
148
198
|
*
|
|
149
199
|
* @template Ops - The operations type from your OpenAPI specification
|
|
200
|
+
* @template AxiosConfig - The axios request configuration type (defaults to AxiosRequestConfig)
|
|
150
201
|
*
|
|
151
202
|
* @example
|
|
152
203
|
* ```typescript
|
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,EAAE,kBAAkB,EAAE,KAAK,eAAe,EAAE,
|
|
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,EAAE,kBAAkB,EAAE,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAC9E,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,KAAK,CAAA;AACrD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAC1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AAEhE;;;;;;GAMG;AACH,MAAM,MAAM,0BAA0B,GAAG,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAErF,gBAAgB;AAChB,YAAY,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,CAAA;AAE3D,MAAM,MAAM,WAAW,GAAG,MAAM,CAAA;AAEhC;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE;QAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE/E;;;OAGG;IACH,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAA;IAEtD;;;OAGG;IACH,iBAAiB,CAAC,OAAO,EAAE;QAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACpF;AAED,MAAM,MAAM,UAAU,CAAC,GAAG,IAAI,MAAM,GAAG;KAAG,CAAC,IAAI,MAAM,GAAG,GAAG;QAAE,MAAM,EAAE,UAAU,CAAA;KAAE;CAAE,CAAA;AAEnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,WAAW,aAAa,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC;IACxD;;;OAGG;IACH,UAAU,EAAE,GAAG,CAAA;IAEf;;;OAGG;IACH,KAAK,EAAE,aAAa,CAAA;IAEpB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,eAAe,CAAA;CAC9B;AAED,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,gBAAgB;AAChB,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,UAAU,CAAA;CACnB;AAED,MAAM,MAAM,YAAY,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC,CAAA;AAErF,MAAM,MAAM,eAAe,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,IAC3E,YAAY,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS;IAC5B,SAAS,EAAE;QAAE,GAAG,EAAE;YAAE,OAAO,EAAE;gBAAE,kBAAkB,EAAE,MAAM,IAAI,CAAA;aAAE,CAAA;SAAE,CAAA;KAAE,CAAA;CACpE,GACG,eAAe,CAAC,IAAI,CAAC,GACrB,OAAO,CAAA;AAEb,KAAK,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,IACxC,CAAC,SAAS,QAAQ,CAAC,MAAM,CAAC,CAAC,GACvB,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,GACpD,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;AAIhD,gBAAgB;AAChB,MAAM,MAAM,aAAa,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,YAAY,CACzF,eAAe,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EACpG,UAAU,GAAG,SAAS,GAAG,SAAS,CACnC,GAAG;IACF,OAAO,CAAC,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAA;IACnC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,IAAI,CAAA;IACjD,YAAY,CAAC,EAAE,0BAA0B,CAAA;IACzC,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;CACjH,CAAA;AAED,KAAK,wBAAwB,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,IAAI;IAC3D,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,oBAAoB,CAAC,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,GAAG,OAAO,CAAC;SAAG,CAAC,IAAI,MAAM,GAAG,GAAG,iBAAiB,CAAC,GAAG,EAAE,CAAC,CAAC;KAAE,CAAC,CAAA;IAC/F,gBAAgB,CAAC,EAAE,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,EAAE,CAAA;CACzD,CAAA;AAED,gBAAgB;AAChB,MAAM,MAAM,aAAa,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,wBAAwB,CAAC,GAAG,CAAC,GAAG;IAC7G,IAAI,CAAC,EAAE,cAAc,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;IAC9B,UAAU,CAAC,EAAE,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;IACvC,YAAY,CAAC,EAAE,0BAA0B,CAAA;CAC1C,CAAA;AACD,gBAAgB;AAChB,MAAM,MAAM,gBAAgB,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,YAAY,CAC5F,kBAAkB,CAChB,aAAa,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EACvC,KAAK,EACL,cAAc,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,KAAK,GAAG,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,CAC/F,EACD,YAAY,GAAG,aAAa,CAC7B,GACC,wBAAwB,CAAC,GAAG,CAAC,GAAG;IAC9B,YAAY,CAAC,EAAE,0BAA0B,CAAA;CAC1C,CAAA;AAEH,MAAM,MAAM,iBAAiB,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC,SAAS;IACjG,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,UAAU,CAAA;KAAE,CAAA;CACvC,GACG;KAAG,CAAC,IAAI,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS;CAAE,GACtD,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;AAEzB,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;AACnH,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;AACvG,KAAK,QAAQ,CAAC,CAAC,IAAI;IACjB,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,KAAK,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;CAC7E,CAAA;AAED,MAAM,MAAM,cAAc,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,IAC1E,YAAY,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS;IAC5B,WAAW,EAAE;QAAE,OAAO,EAAE;YAAE,kBAAkB,EAAE,MAAM,IAAI,CAAA;SAAE,CAAA;KAAE,CAAA;CAC7D,GACG,QAAQ,CAAC,IAAI,CAAC,GACd,YAAY,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS;IAC1B,WAAW,EAAE;QAAE,OAAO,EAAE;YAAE,qBAAqB,EAAE,MAAM,IAAI,CAAA;SAAE,CAAA;KAAE,CAAA;CAChE,GACD,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,GACzB,KAAK,CAAA;AAGb,KAAK,eAAe,CAAC,CAAC,IAAI;KAEvB,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;KAED,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,MAAM,MAAM,gBAAgB,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,MAAM,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC,SAAS;IAChG,MAAM,EAAE,UAAU,CAAC,GAAG,GAAG,UAAU,CAAC,IAAI,GAAG,UAAU,CAAC,OAAO,CAAA;CAC9D,GACG,IAAI,GACJ,KAAK,CAAA;AAET;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,eAAe,CAAC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,IAAI;IACzD;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,EAAE,CAAC,EAAE,SAAS,MAAM,GAAG,EAAE,WAAW,EAAE,EAAE,KAAK,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;IAE5F;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,EAAE,CAAC,EAAE,SAAS,MAAM,GAAG,EAC7B,WAAW,EAAE,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,IAAI,GAAG,EAAE,GAAG,KAAK,EAChE,mBAAmB,CAAC,EAAE,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAC1E,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,GACtB,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,EAC5F,aAAa,CAAC,EAAE,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,KACnC,mBAAmB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,WAAW,EAAE,CAAC,EAAE,SAAS,MAAM,GAAG,EAChC,WAAW,EAAE,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,KAAK,GAAG,EAAE,GAAG,KAAK,EACjE,mBAAmB,CAAC,EAAE,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAC1E,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,GACzB,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,EAC/F,aAAa,CAAC,EAAE,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,KACtC,sBAAsB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,WAAW,EAAE,CAAC,EAAE,SAAS,MAAM,GAAG,EAChC,WAAW,EAAE,EAAE,EACf,mBAAmB,CAAC,EAAE,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAC1E,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,IAAI,GACpC,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,GACtB,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,GAEvB,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,GAC/D,CAAC,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,IAAI,GAAG,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EACrG,aAAa,CAAC,EAAE,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,IAAI,GAAG,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,KACxG,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,IAAI,GAAG,mBAAmB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,sBAAsB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;CAC7G,CAAA"}
|