@openapi-qraft/tanstack-query-react-types 2.0.0-next.8 → 2.0.0-next.9
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 +2 -0
- package/dist/types/service-operation/ServiceOperationGetInfiniteQueryData.d.ts +1 -1
- package/dist/types/service-operation/ServiceOperationGetInfiniteQueryData.d.ts.map +1 -1
- package/dist/types/service-operation/ServiceOperationGetQueryData.d.ts +1 -1
- package/dist/types/service-operation/ServiceOperationGetQueryData.d.ts.map +1 -1
- package/dist/types/service-operation/ServiceOperationGetQueryState.d.ts +1 -1
- package/dist/types/service-operation/ServiceOperationGetQueryState.d.ts.map +1 -1
- package/dist/types/service-operation/ServiceOperationQueryFn.d.ts +1 -1
- package/dist/types/service-operation/ServiceOperationQueryFn.d.ts.map +1 -1
- package/dist/types/service-operation/ServiceOperationUseMutation.d.ts +2 -2
- package/dist/types/service-operation/ServiceOperationUseMutation.d.ts.map +1 -1
- package/dist/types/shared/FetchInfiniteQueryOptions.d.ts +1 -1
- package/dist/types/shared/FetchInfiniteQueryOptions.d.ts.map +1 -1
- package/dist/types/shared/MutationFilters.d.ts +1 -1
- package/dist/types/shared/MutationFilters.d.ts.map +1 -1
- package/dist/types/shared/RequestFn.d.ts +18 -6
- package/dist/types/shared/RequestFn.d.ts.map +1 -1
- package/package.json +4 -4
- package/src/service-operation/ServiceOperationGetInfiniteQueryData.ts +3 -3
- package/src/service-operation/ServiceOperationGetQueryData.ts +3 -3
- package/src/service-operation/ServiceOperationGetQueryState.ts +3 -3
- package/src/service-operation/ServiceOperationQueryFn.ts +5 -8
- package/src/service-operation/ServiceOperationUseMutation.ts +14 -14
- package/src/shared/FetchInfiniteQueryOptions.ts +1 -1
- package/src/shared/MutationFilters.ts +1 -1
- package/src/shared/RequestFn.ts +18 -10
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,6 @@ export interface ServiceOperationGetInfiniteQueryData<TSchema extends {
|
|
|
3
3
|
url: string;
|
|
4
4
|
method: string;
|
|
5
5
|
}, TQueryFnData, TParams> {
|
|
6
|
-
getInfiniteQueryData(parameters: AreAllOptional<TParams> extends true ? TParams |
|
|
6
|
+
getInfiniteQueryData(parameters: ServiceOperationInfiniteQueryKey<TSchema, TParams> | (AreAllOptional<TParams> extends true ? TParams | void : TParams)): OperationInfiniteData<TQueryFnData, TParams> | undefined;
|
|
7
7
|
}
|
|
8
8
|
//# sourceMappingURL=ServiceOperationGetInfiniteQueryData.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ServiceOperationGetInfiniteQueryData.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationGetInfiniteQueryData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,qBAAqB,EACrB,gCAAgC,EACjC,MAAM,2CAA2C,CAAC;AAEnD,MAAM,WAAW,oCAAoC,CACnD,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO;IAEP,oBAAoB,CAClB,UAAU,
|
|
1
|
+
{"version":3,"file":"ServiceOperationGetInfiniteQueryData.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationGetInfiniteQueryData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,qBAAqB,EACrB,gCAAgC,EACjC,MAAM,2CAA2C,CAAC;AAEnD,MAAM,WAAW,oCAAoC,CACnD,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO;IAEP,oBAAoB,CAClB,UAAU,EACN,gCAAgC,CAAC,OAAO,EAAE,OAAO,CAAC,GAClD,CAAC,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,GAAG,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC,GACpE,qBAAqB,CAAC,YAAY,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CAC7D"}
|
|
@@ -3,6 +3,6 @@ export interface ServiceOperationGetQueryData<TSchema extends {
|
|
|
3
3
|
url: string;
|
|
4
4
|
method: string;
|
|
5
5
|
}, TQueryFnData, TParams> {
|
|
6
|
-
getQueryData(parameters: AreAllOptional<TParams> extends true ? TParams |
|
|
6
|
+
getQueryData(parameters: ServiceOperationQueryKey<TSchema, TParams> | (AreAllOptional<TParams> extends true ? TParams | void : TParams)): TQueryFnData | undefined;
|
|
7
7
|
}
|
|
8
8
|
//# sourceMappingURL=ServiceOperationGetQueryData.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ServiceOperationGetQueryData.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationGetQueryData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,wBAAwB,EACzB,MAAM,2CAA2C,CAAC;AAEnD,MAAM,WAAW,4BAA4B,CAC3C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO;IAEP,YAAY,CACV,UAAU,
|
|
1
|
+
{"version":3,"file":"ServiceOperationGetQueryData.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationGetQueryData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,wBAAwB,EACzB,MAAM,2CAA2C,CAAC;AAEnD,MAAM,WAAW,4BAA4B,CAC3C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO;IAEP,YAAY,CACV,UAAU,EACN,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,GAC1C,CAAC,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,GAAG,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC,GACpE,YAAY,GAAG,SAAS,CAAC;CAC7B"}
|
|
@@ -4,7 +4,7 @@ export interface ServiceOperationGetQueryState<TSchema extends {
|
|
|
4
4
|
url: string;
|
|
5
5
|
method: string;
|
|
6
6
|
}, TQueryFnData, TParams, TError> {
|
|
7
|
-
getQueryState(parameters: AreAllOptional<TParams> extends true ? TParams |
|
|
7
|
+
getQueryState(parameters: ServiceOperationQueryKey<TSchema, TParams> | (AreAllOptional<TParams> extends true ? TParams | void : TParams)): QueryState<TQueryFnData, TError> | undefined;
|
|
8
8
|
getInfiniteQueryState(parameters: AreAllOptional<TParams> extends true ? TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams> | void : TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>): QueryState<OperationInfiniteData<TQueryFnData, TParams>, TError> | undefined;
|
|
9
9
|
}
|
|
10
10
|
//# sourceMappingURL=ServiceOperationGetQueryState.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ServiceOperationGetQueryState.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationGetQueryState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,qBAAqB,EACrB,gCAAgC,EAChC,wBAAwB,EACzB,MAAM,2CAA2C,CAAC;AACnD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAEvD,MAAM,WAAW,6BAA6B,CAC5C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,MAAM;IAEN,aAAa,CACX,UAAU,
|
|
1
|
+
{"version":3,"file":"ServiceOperationGetQueryState.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationGetQueryState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,qBAAqB,EACrB,gCAAgC,EAChC,wBAAwB,EACzB,MAAM,2CAA2C,CAAC;AACnD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAEvD,MAAM,WAAW,6BAA6B,CAC5C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,MAAM;IAEN,aAAa,CACX,UAAU,EACN,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,GAC1C,CAAC,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,GAAG,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC,GACpE,UAAU,CAAC,YAAY,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IAEhD,qBAAqB,CACnB,UAAU,EAAE,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,GAC5C,OAAO,GAAG,gCAAgC,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,IAAI,GACnE,OAAO,GAAG,gCAAgC,CAAC,OAAO,EAAE,OAAO,CAAC,GAE9D,UAAU,CAAC,qBAAqB,CAAC,YAAY,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,GAChE,SAAS,CAAC;CACf"}
|
|
@@ -3,7 +3,7 @@ export interface ServiceOperationQueryFn<TSchema extends {
|
|
|
3
3
|
url: string;
|
|
4
4
|
method: string;
|
|
5
5
|
}, TQueryFnData, TParams, TError> {
|
|
6
|
-
<TMeta extends Record<string, any>, TSignal extends AbortSignal = AbortSignal>(options:
|
|
6
|
+
<TMeta extends Record<string, any>, TSignal extends AbortSignal = AbortSignal>(options: QueryFnOptionsByQueryKey<TSchema, TParams, TMeta, TSignal> | (AreAllOptional<TParams> extends true ? QueryFnOptionsByParameters<TParams, TMeta, TSignal> | void : QueryFnOptionsByParameters<TParams, TMeta, TSignal>), client?: (schema: TSchema, options: {
|
|
7
7
|
parameters: TParams;
|
|
8
8
|
signal?: TSignal;
|
|
9
9
|
meta?: TMeta;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ServiceOperationQueryFn.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationQueryFn.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,0BAA0B,EAC1B,wBAAwB,EACxB,iBAAiB,EAClB,MAAM,2CAA2C,CAAC;AAEnD,MAAM,WAAW,uBAAuB,CACtC,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,MAAM;IAEN,CACE,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACjC,OAAO,SAAS,WAAW,GAAG,WAAW,EAEzC,OAAO,
|
|
1
|
+
{"version":3,"file":"ServiceOperationQueryFn.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationQueryFn.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,0BAA0B,EAC1B,wBAAwB,EACxB,iBAAiB,EAClB,MAAM,2CAA2C,CAAC;AAEnD,MAAM,WAAW,uBAAuB,CACtC,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,MAAM;IAEN,CACE,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACjC,OAAO,SAAS,WAAW,GAAG,WAAW,EAEzC,OAAO,EACH,wBAAwB,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,GAC1D,CAAC,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,GACjC,0BAA0B,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,IAAI,GAC1D,0BAA0B,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,EAC5D,MAAM,CAAC,EAAE,CACP,MAAM,EAAE,OAAO,EACf,OAAO,EAAE;QACP,UAAU,EAAE,OAAO,CAAC;QACpB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,IAAI,CAAC,EAAE,KAAK,CAAC;KACd,KACE,OAAO,CAAC,iBAAiB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,GACpD,OAAO,CAAC,iBAAiB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;CACrD"}
|
|
@@ -5,7 +5,7 @@ export interface ServiceOperationUseMutation<TSchema extends {
|
|
|
5
5
|
method: string;
|
|
6
6
|
}, TBody, TMutationData, TParams, TError> {
|
|
7
7
|
getMutationKey(parameters: TParams | void): ServiceOperationMutationKey<TSchema, TParams>;
|
|
8
|
-
useMutation<TVariables extends
|
|
9
|
-
useMutation<TVariables extends TBody, TContext = unknown>(parameters:
|
|
8
|
+
useMutation<TVariables extends TBody, TContext = unknown>(parameters: TParams, options?: ServiceOperationUseMutationOptions<TSchema, TMutationData, TParams, TVariables, TError, TContext>): UseMutationResult<TMutationData, TError | Error, AreAllOptional<TVariables> extends true ? TVariables | void : TVariables, TContext>;
|
|
9
|
+
useMutation<TVariables extends MutationVariables<TBody, TParams>, TContext = unknown>(parameters: void, options?: ServiceOperationUseMutationOptions<TSchema, TMutationData, TParams, TVariables, TError, TContext>): UseMutationResult<TMutationData, TError | Error, TVariables, TContext>;
|
|
10
10
|
}
|
|
11
11
|
//# sourceMappingURL=ServiceOperationUseMutation.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ServiceOperationUseMutation.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationUseMutation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,iBAAiB,EACjB,2BAA2B,EAC3B,kCAAkC,EACnC,MAAM,2CAA2C,CAAC;AACnD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE/D,MAAM,WAAW,2BAA2B,CAC1C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM;IAEN,cAAc,CACZ,UAAU,EAAE,OAAO,GAAG,IAAI,GACzB,2BAA2B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAEjD,WAAW,
|
|
1
|
+
{"version":3,"file":"ServiceOperationUseMutation.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationUseMutation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,iBAAiB,EACjB,2BAA2B,EAC3B,kCAAkC,EACnC,MAAM,2CAA2C,CAAC;AACnD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE/D,MAAM,WAAW,2BAA2B,CAC1C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM;IAEN,cAAc,CACZ,UAAU,EAAE,OAAO,GAAG,IAAI,GACzB,2BAA2B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAEjD,WAAW,CAAC,UAAU,SAAS,KAAK,EAAE,QAAQ,GAAG,OAAO,EACtD,UAAU,EAAE,OAAO,EACnB,OAAO,CAAC,EAAE,kCAAkC,CAC1C,OAAO,EACP,aAAa,EACb,OAAO,EACP,UAAU,EACV,MAAM,EACN,QAAQ,CACT,GACA,iBAAiB,CAClB,aAAa,EACb,MAAM,GAAG,KAAK,EACd,cAAc,CAAC,UAAU,CAAC,SAAS,IAAI,GAAG,UAAU,GAAG,IAAI,GAAG,UAAU,EACxE,QAAQ,CACT,CAAC;IAEF,WAAW,CACT,UAAU,SAAS,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,EACpD,QAAQ,GAAG,OAAO,EAElB,UAAU,EAAE,IAAI,EAChB,OAAO,CAAC,EAAE,kCAAkC,CAC1C,OAAO,EACP,aAAa,EACb,OAAO,EACP,UAAU,EACV,MAAM,EACN,QAAQ,CACT,GACA,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;CAC3E"}
|
|
@@ -12,7 +12,7 @@ type FetchInfiniteQueryPages<TQueryFnData = unknown, TPageParam = unknown> = {
|
|
|
12
12
|
type FetchInfiniteQueryOptionsBase<TSchema extends {
|
|
13
13
|
url: string;
|
|
14
14
|
method: string;
|
|
15
|
-
}, TQueryFnData, TParams = {}, TPageParam = unknown, TError = DefaultError> = Omit<FetchQueryOptions<TQueryFnData, TError, OperationInfiniteData<TQueryFnData, TParams>, ServiceOperationQueryKey<TSchema, TParams>, TPageParam>, 'queryKey'> & InitialPageParam<PartialParameters<TPageParam>> & FetchInfiniteQueryPages<TQueryFnData, TPageParam>;
|
|
15
|
+
}, TQueryFnData, TParams = {}, TPageParam = unknown, TError = DefaultError> = Omit<FetchQueryOptions<TQueryFnData, TError, OperationInfiniteData<TQueryFnData, TParams>, ServiceOperationQueryKey<TSchema, TParams>, TPageParam>, 'queryKey' | 'initialPageParam'> & InitialPageParam<PartialParameters<TPageParam>> & FetchInfiniteQueryPages<TQueryFnData, TPageParam>;
|
|
16
16
|
export type FetchInfiniteQueryOptionsByQueryKey<TSchema extends {
|
|
17
17
|
url: string;
|
|
18
18
|
method: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FetchInfiniteQueryOptions.d.ts","sourceRoot":"","sources":["../../../src/shared/FetchInfiniteQueryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,iBAAiB,EACjB,wBAAwB,EACxB,gBAAgB,EAChB,aAAa,EACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EACV,gCAAgC,EAChC,wBAAwB,EACzB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,KAAK,uBAAuB,CAAC,YAAY,GAAG,OAAO,EAAE,UAAU,GAAG,OAAO,IACrE;IACE,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,GACD;IACE,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,EAAE,wBAAwB,CACxC,iBAAiB,CAAC,UAAU,CAAC,EAC7B,YAAY,CACb,CAAC;CACH,CAAC;AAEN,KAAK,6BAA6B,CAChC,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,GAAG,EAAE,EACZ,UAAU,GAAG,OAAO,EACpB,MAAM,GAAG,YAAY,IACnB,IAAI,CACN,iBAAiB,CACf,YAAY,EACZ,MAAM,EACN,qBAAqB,CAAC,YAAY,EAAE,OAAO,CAAC,EAC5C,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,EAC1C,UAAU,CACX,EACD,UAAU,
|
|
1
|
+
{"version":3,"file":"FetchInfiniteQueryOptions.d.ts","sourceRoot":"","sources":["../../../src/shared/FetchInfiniteQueryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,iBAAiB,EACjB,wBAAwB,EACxB,gBAAgB,EAChB,aAAa,EACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EACV,gCAAgC,EAChC,wBAAwB,EACzB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,KAAK,uBAAuB,CAAC,YAAY,GAAG,OAAO,EAAE,UAAU,GAAG,OAAO,IACrE;IACE,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,GACD;IACE,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,EAAE,wBAAwB,CACxC,iBAAiB,CAAC,UAAU,CAAC,EAC7B,YAAY,CACb,CAAC;CACH,CAAC;AAEN,KAAK,6BAA6B,CAChC,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,GAAG,EAAE,EACZ,UAAU,GAAG,OAAO,EACpB,MAAM,GAAG,YAAY,IACnB,IAAI,CACN,iBAAiB,CACf,YAAY,EACZ,MAAM,EACN,qBAAqB,CAAC,YAAY,EAAE,OAAO,CAAC,EAC5C,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,EAC1C,UAAU,CACX,EACD,UAAU,GAAG,kBAAkB,CAChC,GACC,gBAAgB,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,GAC/C,uBAAuB,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;AAEpD,MAAM,MAAM,mCAAmC,CAC7C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,GAAG,EAAE,EACZ,UAAU,GAAG,EAAE,EACf,MAAM,GAAG,YAAY,IACnB,6BAA6B,CAC/B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GAAG;IACF;;OAEG;IACH,QAAQ,CAAC,EAAE,gCAAgC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9D,UAAU,CAAC,EAAE,KAAK,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,qCAAqC,CAC/C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,GAAG,EAAE,EACZ,UAAU,GAAG,EAAE,EACf,MAAM,GAAG,YAAY,IACnB,6BAA6B,CAC/B,OAAO,EACP,YAAY,EACZ,OAAO,EACP,UAAU,EACV,MAAM,CACP,GAAG;IACF;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,gCAAgC,CAC1C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,YAAY,EACZ,OAAO,EACP,MAAM,IAEJ;IACE,OAAO,EAAE,aAAa,CACpB,YAAY,EACZ,gCAAgC,CAAC,OAAO,EAAE,OAAO,CAAC,CACnD,CAAC;CACH,GACD;IACE;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAC5C;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB,CAAC"}
|
|
@@ -38,7 +38,7 @@ export type MutationVariables<TBody, TParams> = AreAllOptional<TBody> extends tr
|
|
|
38
38
|
body?: TBody;
|
|
39
39
|
} & NonNullableObject<TParams>) | void : {
|
|
40
40
|
body?: TBody;
|
|
41
|
-
} & TParams : {
|
|
41
|
+
} & NonNullableObject<TParams> : {
|
|
42
42
|
body: TBody;
|
|
43
43
|
} & NonNullableObject<TParams>;
|
|
44
44
|
type NonNullableObject<T> = NonNullable<T> extends never ? {} : T;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"MutationFilters.d.ts","sourceRoot":"","sources":["../../../src/shared/MutationFilters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,QAAQ,EACR,cAAc,EACf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AAE5E,UAAU,2BAA2B,CACnC,KAAK,EACL,KAAK,EACL,OAAO,EACP,MAAM,GAAG,YAAY,EACrB,QAAQ,GAAG,OAAO;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,CACV,QAAQ,EAAE,QAAQ,CAChB,KAAK,EACL,MAAM,EACN,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,EACjC,QAAQ,CACT,KACE,OAAO,CAAC;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,2BAA2B,CAC1C,KAAK,EACL,KAAK,EACL,OAAO,EACP,MAAM,GAAG,YAAY,EACrB,QAAQ,GAAG,OAAO,CAClB,SAAQ,2BAA2B,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC;IAC5E;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACxC,WAAW,CAAC,EAAE,KAAK,CAAC;CACrB;AAED,MAAM,WAAW,4BAA4B,CAC3C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,KAAK,EACL,KAAK,EACL,OAAO,EACP,MAAM,GAAG,YAAY,EACrB,QAAQ,GAAG,OAAO,CAClB,SAAQ,2BAA2B,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC;IAC5E;;OAEG;IACH,WAAW,CAAC,EAAE,2BAA2B,CACvC,OAAO,EACP,iBAAiB,CAAC,OAAO,CAAC,CAC3B,CAAC;IACF,UAAU,CAAC,EAAE,KAAK,CAAC;CACpB;AAED,MAAM,MAAM,iBAAiB,CAAC,KAAK,EAAE,OAAO,IAC1C,cAAc,CAAC,KAAK,CAAC,SAAS,IAAI,GAC9B,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,GAClC,CAAC;IAAE,IAAI,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC,GAAG,IAAI,GACtD;IAAE,IAAI,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG,OAAO,
|
|
1
|
+
{"version":3,"file":"MutationFilters.d.ts","sourceRoot":"","sources":["../../../src/shared/MutationFilters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,QAAQ,EACR,cAAc,EACf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AAE5E,UAAU,2BAA2B,CACnC,KAAK,EACL,KAAK,EACL,OAAO,EACP,MAAM,GAAG,YAAY,EACrB,QAAQ,GAAG,OAAO;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,CACV,QAAQ,EAAE,QAAQ,CAChB,KAAK,EACL,MAAM,EACN,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,EACjC,QAAQ,CACT,KACE,OAAO,CAAC;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,2BAA2B,CAC1C,KAAK,EACL,KAAK,EACL,OAAO,EACP,MAAM,GAAG,YAAY,EACrB,QAAQ,GAAG,OAAO,CAClB,SAAQ,2BAA2B,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC;IAC5E;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACxC,WAAW,CAAC,EAAE,KAAK,CAAC;CACrB;AAED,MAAM,WAAW,4BAA4B,CAC3C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,KAAK,EACL,KAAK,EACL,OAAO,EACP,MAAM,GAAG,YAAY,EACrB,QAAQ,GAAG,OAAO,CAClB,SAAQ,2BAA2B,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC;IAC5E;;OAEG;IACH,WAAW,CAAC,EAAE,2BAA2B,CACvC,OAAO,EACP,iBAAiB,CAAC,OAAO,CAAC,CAC3B,CAAC;IACF,UAAU,CAAC,EAAE,KAAK,CAAC;CACpB;AAED,MAAM,MAAM,iBAAiB,CAAC,KAAK,EAAE,OAAO,IAC1C,cAAc,CAAC,KAAK,CAAC,SAAS,IAAI,GAC9B,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,GAClC,CAAC;IAAE,IAAI,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC,GAAG,IAAI,GACtD;IAAE,IAAI,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,GAC/C;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;AAEnD,KAAK,iBAAiB,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,EAAE,GAAG,CAAC,CAAC;AAElE,MAAM,MAAM,kCAAkC,CAC5C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,KAAK,EACL,OAAO,EACP,UAAU,EACV,MAAM,EACN,QAAQ,GAAG,OAAO,IAChB,IAAI,CACN,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,EACvD,aAAa,CACd,GAAG;IACF,WAAW,CAAC,EAAE,2BAA2B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;CAC7D,CAAC"}
|
|
@@ -1,3 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The `RequestFn` is the wrapper on top of the `fetch` function that simplifies
|
|
3
|
+
* the process of making requests to the API using Qraft.
|
|
4
|
+
* using OpenAPI Operation schemas generated by Qraft CLI.
|
|
5
|
+
*
|
|
6
|
+
* @param schema - The schema of the operation to be performed. It includes the OpenAPI path, HTTP method and other details.
|
|
7
|
+
* @param requestInfo - The information required to make the request. It includes parameters, headers, body, etc.
|
|
8
|
+
* @param options - The options for the request. It includes custom `urlSerializer`, `bodySerializer`, and fetch function.
|
|
9
|
+
*
|
|
10
|
+
* @returns Returns a promise that resolves with the response of the request.
|
|
11
|
+
*/
|
|
1
12
|
export interface RequestFn<TData, TError> {
|
|
2
13
|
(schema: OperationSchema, requestInfo: RequestFnInfo, options?: RequestFnOptions): Promise<RequestFnResponse<TData, TError>>;
|
|
3
14
|
}
|
|
@@ -18,14 +29,12 @@ export interface OperationSchema {
|
|
|
18
29
|
readonly mediaType?: string;
|
|
19
30
|
readonly security?: string[];
|
|
20
31
|
}
|
|
21
|
-
export interface RequestFnInfo extends
|
|
32
|
+
export interface RequestFnInfo extends Omit<RequestInit, 'headers' | 'method' | 'body' | 'signal'> {
|
|
22
33
|
/**
|
|
23
34
|
* Request headers
|
|
24
35
|
* @example { 'X-Auth': '123' }
|
|
25
36
|
*/
|
|
26
37
|
readonly headers?: HeadersOptions;
|
|
27
|
-
}
|
|
28
|
-
export interface RequestFnPayload {
|
|
29
38
|
/**
|
|
30
39
|
* Base URL to use for the request
|
|
31
40
|
* @example 'https://api.example.com'
|
|
@@ -49,12 +58,15 @@ export interface RequestFnPayload {
|
|
|
49
58
|
*/
|
|
50
59
|
readonly body?: BodyInit | Record<string, unknown> | null;
|
|
51
60
|
/**
|
|
52
|
-
*
|
|
61
|
+
* TanStack Query Meta
|
|
53
62
|
*/
|
|
54
63
|
meta?: Record<string, unknown>;
|
|
55
64
|
/** An AbortSignal to set request's signal. */
|
|
56
65
|
signal?: AbortSignal | null;
|
|
57
66
|
}
|
|
67
|
+
/**
|
|
68
|
+
* The `RequestFnResponse` is the response of the `RequestFn` function.
|
|
69
|
+
*/
|
|
58
70
|
export type RequestFnResponse<TData, TError> = {
|
|
59
71
|
data: TData;
|
|
60
72
|
response: Response;
|
|
@@ -73,8 +85,8 @@ export interface RequestFnOptions {
|
|
|
73
85
|
bodySerializer?: BodySerializer;
|
|
74
86
|
fetch?: typeof fetch;
|
|
75
87
|
}
|
|
76
|
-
type BodySerializer = (schema: OperationSchema, info:
|
|
77
|
-
type UrlSerializer = (schema: OperationSchema, info:
|
|
88
|
+
type BodySerializer = (schema: OperationSchema, info: RequestFnInfo) => string | FormData | Blob | undefined;
|
|
89
|
+
type UrlSerializer = (schema: OperationSchema, info: RequestFnInfo) => string;
|
|
78
90
|
export type HeadersOptions = HeadersInit | Record<string, string | number | boolean | null | undefined>;
|
|
79
91
|
export {};
|
|
80
92
|
//# sourceMappingURL=RequestFn.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RequestFn.d.ts","sourceRoot":"","sources":["../../../src/shared/RequestFn.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAS,CAAC,KAAK,EAAE,MAAM;IACtC,CACE,MAAM,EAAE,eAAe,EACvB,WAAW,EAAE,aAAa,EAC1B,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,iBAAiB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,MAAM,EACX,KAAK,GACL,KAAK,GACL,MAAM,GACN,OAAO,GACP,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,CAAC;IAEZ;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE5B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,aACf,SAAQ,
|
|
1
|
+
{"version":3,"file":"RequestFn.d.ts","sourceRoot":"","sources":["../../../src/shared/RequestFn.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,MAAM,WAAW,SAAS,CAAC,KAAK,EAAE,MAAM;IACtC,CACE,MAAM,EAAE,eAAe,EACvB,WAAW,EAAE,aAAa,EAC1B,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,iBAAiB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,MAAM,EACX,KAAK,GACL,KAAK,GACL,MAAM,GACN,OAAO,GACP,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,CAAC;IAEZ;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE5B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,aACf,SAAQ,IAAI,CAAC,WAAW,EAAE,SAAS,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;IACnE;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC;IAElC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE;QACpB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACpC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACtC,CAAC;IAEF;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAE1D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B,8CAA8C;IAC9C,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,KAAK,EAAE,MAAM,IACvC;IACE,IAAI,EAAE,KAAK,CAAC;IACZ,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB,GACD;IAEE,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC;CACvB,GACD;IAEE,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAEN,MAAM,WAAW,gBAAgB;IAC/B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CACtB;AAED,KAAK,cAAc,GAAG,CACpB,MAAM,EAAE,eAAe,EACvB,IAAI,EAAE,aAAa,KAChB,MAAM,GAAG,QAAQ,GAAG,IAAI,GAAG,SAAS,CAAC;AAE1C,KAAK,aAAa,GAAG,CAAC,MAAM,EAAE,eAAe,EAAE,IAAI,EAAE,aAAa,KAAK,MAAM,CAAC;AAG9E,MAAM,MAAM,cAAc,GACtB,WAAW,GACX,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openapi-qraft/tanstack-query-react-types",
|
|
3
|
-
"version": "2.0.0-next.
|
|
3
|
+
"version": "2.0.0-next.9",
|
|
4
4
|
"scripts": {
|
|
5
5
|
"build": "yarn clean && NODE_ENV=production rollup --config rollup.config.mjs && tsc --project tsconfig.build.json --emitDeclarationOnly",
|
|
6
6
|
"dev": "yarn clean && tsc --project tsconfig.build.json --watch --outDir ./dist/esm --noEmitOnError false",
|
|
@@ -27,10 +27,10 @@
|
|
|
27
27
|
"devDependencies": {
|
|
28
28
|
"@openapi-qraft/eslint-config": "1.0.0",
|
|
29
29
|
"@openapi-qraft/rollup-config": "1.1.0-next.0",
|
|
30
|
-
"eslint": "^9.
|
|
30
|
+
"eslint": "^9.10.0",
|
|
31
31
|
"rimraf": "^5.0.10",
|
|
32
|
-
"rollup": "~4.
|
|
33
|
-
"typescript": "^5.
|
|
32
|
+
"rollup": "~4.21.3",
|
|
33
|
+
"typescript": "^5.6.2"
|
|
34
34
|
},
|
|
35
35
|
"packageManager": "yarn@4.2.1",
|
|
36
36
|
"files": [
|
|
@@ -10,8 +10,8 @@ export interface ServiceOperationGetInfiniteQueryData<
|
|
|
10
10
|
TParams,
|
|
11
11
|
> {
|
|
12
12
|
getInfiniteQueryData(
|
|
13
|
-
parameters:
|
|
14
|
-
|
|
15
|
-
|
|
13
|
+
parameters:
|
|
14
|
+
| ServiceOperationInfiniteQueryKey<TSchema, TParams>
|
|
15
|
+
| (AreAllOptional<TParams> extends true ? TParams | void : TParams)
|
|
16
16
|
): OperationInfiniteData<TQueryFnData, TParams> | undefined;
|
|
17
17
|
}
|
|
@@ -9,8 +9,8 @@ export interface ServiceOperationGetQueryData<
|
|
|
9
9
|
TParams,
|
|
10
10
|
> {
|
|
11
11
|
getQueryData(
|
|
12
|
-
parameters:
|
|
13
|
-
|
|
14
|
-
|
|
12
|
+
parameters:
|
|
13
|
+
| ServiceOperationQueryKey<TSchema, TParams>
|
|
14
|
+
| (AreAllOptional<TParams> extends true ? TParams | void : TParams)
|
|
15
15
|
): TQueryFnData | undefined;
|
|
16
16
|
}
|
|
@@ -13,9 +13,9 @@ export interface ServiceOperationGetQueryState<
|
|
|
13
13
|
TError,
|
|
14
14
|
> {
|
|
15
15
|
getQueryState(
|
|
16
|
-
parameters:
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
parameters:
|
|
17
|
+
| ServiceOperationQueryKey<TSchema, TParams>
|
|
18
|
+
| (AreAllOptional<TParams> extends true ? TParams | void : TParams)
|
|
19
19
|
): QueryState<TQueryFnData, TError> | undefined;
|
|
20
20
|
|
|
21
21
|
getInfiniteQueryState(
|
|
@@ -15,14 +15,11 @@ export interface ServiceOperationQueryFn<
|
|
|
15
15
|
TMeta extends Record<string, any>,
|
|
16
16
|
TSignal extends AbortSignal = AbortSignal,
|
|
17
17
|
>(
|
|
18
|
-
options:
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
:
|
|
24
|
-
| QueryFnOptionsByParameters<TParams, TMeta, TSignal>
|
|
25
|
-
| QueryFnOptionsByQueryKey<TSchema, TParams, TMeta, TSignal>,
|
|
18
|
+
options:
|
|
19
|
+
| QueryFnOptionsByQueryKey<TSchema, TParams, TMeta, TSignal>
|
|
20
|
+
| (AreAllOptional<TParams> extends true
|
|
21
|
+
? QueryFnOptionsByParameters<TParams, TMeta, TSignal> | void
|
|
22
|
+
: QueryFnOptionsByParameters<TParams, TMeta, TSignal>),
|
|
26
23
|
client?: (
|
|
27
24
|
schema: TSchema,
|
|
28
25
|
options: {
|
|
@@ -17,11 +17,8 @@ export interface ServiceOperationUseMutation<
|
|
|
17
17
|
parameters: TParams | void
|
|
18
18
|
): ServiceOperationMutationKey<TSchema, TParams>;
|
|
19
19
|
|
|
20
|
-
useMutation<
|
|
21
|
-
|
|
22
|
-
TContext = unknown,
|
|
23
|
-
>(
|
|
24
|
-
parameters?: undefined,
|
|
20
|
+
useMutation<TVariables extends TBody, TContext = unknown>(
|
|
21
|
+
parameters: TParams,
|
|
25
22
|
options?: ServiceOperationUseMutationOptions<
|
|
26
23
|
TSchema,
|
|
27
24
|
TMutationData,
|
|
@@ -30,10 +27,18 @@ export interface ServiceOperationUseMutation<
|
|
|
30
27
|
TError,
|
|
31
28
|
TContext
|
|
32
29
|
>
|
|
33
|
-
): UseMutationResult<
|
|
30
|
+
): UseMutationResult<
|
|
31
|
+
TMutationData,
|
|
32
|
+
TError | Error,
|
|
33
|
+
AreAllOptional<TVariables> extends true ? TVariables | void : TVariables,
|
|
34
|
+
TContext
|
|
35
|
+
>;
|
|
34
36
|
|
|
35
|
-
useMutation<
|
|
36
|
-
|
|
37
|
+
useMutation<
|
|
38
|
+
TVariables extends MutationVariables<TBody, TParams>,
|
|
39
|
+
TContext = unknown,
|
|
40
|
+
>(
|
|
41
|
+
parameters: void,
|
|
37
42
|
options?: ServiceOperationUseMutationOptions<
|
|
38
43
|
TSchema,
|
|
39
44
|
TMutationData,
|
|
@@ -42,10 +47,5 @@ export interface ServiceOperationUseMutation<
|
|
|
42
47
|
TError,
|
|
43
48
|
TContext
|
|
44
49
|
>
|
|
45
|
-
): UseMutationResult<
|
|
46
|
-
TMutationData,
|
|
47
|
-
TError | Error,
|
|
48
|
-
AreAllOptional<TVariables> extends true ? TVariables | void : TVariables,
|
|
49
|
-
TContext
|
|
50
|
-
>;
|
|
50
|
+
): UseMutationResult<TMutationData, TError | Error, TVariables, TContext>;
|
|
51
51
|
}
|
|
@@ -39,7 +39,7 @@ type FetchInfiniteQueryOptionsBase<
|
|
|
39
39
|
ServiceOperationQueryKey<TSchema, TParams>,
|
|
40
40
|
TPageParam
|
|
41
41
|
>,
|
|
42
|
-
'queryKey'
|
|
42
|
+
'queryKey' | 'initialPageParam'
|
|
43
43
|
> &
|
|
44
44
|
InitialPageParam<PartialParameters<TPageParam>> &
|
|
45
45
|
FetchInfiniteQueryPages<TQueryFnData, TPageParam>;
|
|
@@ -73,7 +73,7 @@ export type MutationVariables<TBody, TParams> =
|
|
|
73
73
|
AreAllOptional<TBody> extends true
|
|
74
74
|
? AreAllOptional<TParams> extends true
|
|
75
75
|
? ({ body?: TBody } & NonNullableObject<TParams>) | void
|
|
76
|
-
: { body?: TBody } & TParams
|
|
76
|
+
: { body?: TBody } & NonNullableObject<TParams>
|
|
77
77
|
: { body: TBody } & NonNullableObject<TParams>;
|
|
78
78
|
|
|
79
79
|
type NonNullableObject<T> = NonNullable<T> extends never ? {} : T;
|
package/src/shared/RequestFn.ts
CHANGED
|
@@ -1,3 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The `RequestFn` is the wrapper on top of the `fetch` function that simplifies
|
|
3
|
+
* the process of making requests to the API using Qraft.
|
|
4
|
+
* using OpenAPI Operation schemas generated by Qraft CLI.
|
|
5
|
+
*
|
|
6
|
+
* @param schema - The schema of the operation to be performed. It includes the OpenAPI path, HTTP method and other details.
|
|
7
|
+
* @param requestInfo - The information required to make the request. It includes parameters, headers, body, etc.
|
|
8
|
+
* @param options - The options for the request. It includes custom `urlSerializer`, `bodySerializer`, and fetch function.
|
|
9
|
+
*
|
|
10
|
+
* @returns Returns a promise that resolves with the response of the request.
|
|
11
|
+
*/
|
|
1
12
|
export interface RequestFn<TData, TError> {
|
|
2
13
|
(
|
|
3
14
|
schema: OperationSchema,
|
|
@@ -36,16 +47,13 @@ export interface OperationSchema {
|
|
|
36
47
|
}
|
|
37
48
|
|
|
38
49
|
export interface RequestFnInfo
|
|
39
|
-
extends
|
|
40
|
-
Omit<RequestInit, 'headers' | 'method' | 'body' | 'signal'> {
|
|
50
|
+
extends Omit<RequestInit, 'headers' | 'method' | 'body' | 'signal'> {
|
|
41
51
|
/**
|
|
42
52
|
* Request headers
|
|
43
53
|
* @example { 'X-Auth': '123' }
|
|
44
54
|
*/
|
|
45
55
|
readonly headers?: HeadersOptions;
|
|
46
|
-
}
|
|
47
56
|
|
|
48
|
-
export interface RequestFnPayload {
|
|
49
57
|
/**
|
|
50
58
|
* Base URL to use for the request
|
|
51
59
|
* @example 'https://api.example.com'
|
|
@@ -72,7 +80,7 @@ export interface RequestFnPayload {
|
|
|
72
80
|
readonly body?: BodyInit | Record<string, unknown> | null;
|
|
73
81
|
|
|
74
82
|
/**
|
|
75
|
-
*
|
|
83
|
+
* TanStack Query Meta
|
|
76
84
|
*/
|
|
77
85
|
meta?: Record<string, unknown>;
|
|
78
86
|
|
|
@@ -80,6 +88,9 @@ export interface RequestFnPayload {
|
|
|
80
88
|
signal?: AbortSignal | null;
|
|
81
89
|
}
|
|
82
90
|
|
|
91
|
+
/**
|
|
92
|
+
* The `RequestFnResponse` is the response of the `RequestFn` function.
|
|
93
|
+
*/
|
|
83
94
|
export type RequestFnResponse<TData, TError> =
|
|
84
95
|
| {
|
|
85
96
|
data: TData;
|
|
@@ -107,13 +118,10 @@ export interface RequestFnOptions {
|
|
|
107
118
|
|
|
108
119
|
type BodySerializer = (
|
|
109
120
|
schema: OperationSchema,
|
|
110
|
-
info:
|
|
121
|
+
info: RequestFnInfo
|
|
111
122
|
) => string | FormData | Blob | undefined;
|
|
112
123
|
|
|
113
|
-
type UrlSerializer = (
|
|
114
|
-
schema: OperationSchema,
|
|
115
|
-
info: RequestFnPayload
|
|
116
|
-
) => string;
|
|
124
|
+
type UrlSerializer = (schema: OperationSchema, info: RequestFnInfo) => string;
|
|
117
125
|
|
|
118
126
|
// To have definitely typed headers without a conversion to stings
|
|
119
127
|
export type HeadersOptions =
|