@openapi-qraft/tanstack-query-react-types 2.1.1 → 2.2.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.
Files changed (77) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/dist/types/service-operation/ServiceOperation.d.ts +2 -2
  3. package/dist/types/service-operation/ServiceOperation.d.ts.map +1 -1
  4. package/dist/types/service-operation/ServiceOperationCancelQueries.d.ts +2 -2
  5. package/dist/types/service-operation/ServiceOperationCancelQueries.d.ts.map +1 -1
  6. package/dist/types/service-operation/ServiceOperationFetchInfiniteQuery.d.ts +4 -4
  7. package/dist/types/service-operation/ServiceOperationFetchInfiniteQuery.d.ts.map +1 -1
  8. package/dist/types/service-operation/ServiceOperationFetchQuery.d.ts +4 -4
  9. package/dist/types/service-operation/ServiceOperationFetchQuery.d.ts.map +1 -1
  10. package/dist/types/service-operation/ServiceOperationGetInfiniteQueryData.d.ts +2 -2
  11. package/dist/types/service-operation/ServiceOperationGetInfiniteQueryData.d.ts.map +1 -1
  12. package/dist/types/service-operation/ServiceOperationGetQueriesData.d.ts +4 -4
  13. package/dist/types/service-operation/ServiceOperationGetQueriesData.d.ts.map +1 -1
  14. package/dist/types/service-operation/ServiceOperationGetQueryData.d.ts +2 -2
  15. package/dist/types/service-operation/ServiceOperationGetQueryData.d.ts.map +1 -1
  16. package/dist/types/service-operation/ServiceOperationGetQueryState.d.ts +3 -3
  17. package/dist/types/service-operation/ServiceOperationGetQueryState.d.ts.map +1 -1
  18. package/dist/types/service-operation/ServiceOperationInvalidateQueries.d.ts +2 -2
  19. package/dist/types/service-operation/ServiceOperationInvalidateQueries.d.ts.map +1 -1
  20. package/dist/types/service-operation/ServiceOperationIsFetchingQueries.d.ts +2 -2
  21. package/dist/types/service-operation/ServiceOperationIsFetchingQueries.d.ts.map +1 -1
  22. package/dist/types/service-operation/ServiceOperationQueryFn.d.ts +2 -2
  23. package/dist/types/service-operation/ServiceOperationQueryFn.d.ts.map +1 -1
  24. package/dist/types/service-operation/ServiceOperationRefetchQueries.d.ts +2 -2
  25. package/dist/types/service-operation/ServiceOperationRefetchQueries.d.ts.map +1 -1
  26. package/dist/types/service-operation/ServiceOperationRemoveQueries.d.ts +2 -2
  27. package/dist/types/service-operation/ServiceOperationRemoveQueries.d.ts.map +1 -1
  28. package/dist/types/service-operation/ServiceOperationResetQueries.d.ts +2 -2
  29. package/dist/types/service-operation/ServiceOperationResetQueries.d.ts.map +1 -1
  30. package/dist/types/service-operation/ServiceOperationSetInfiniteQueryData.d.ts +2 -2
  31. package/dist/types/service-operation/ServiceOperationSetInfiniteQueryData.d.ts.map +1 -1
  32. package/dist/types/service-operation/ServiceOperationSetQueriesData.d.ts +2 -2
  33. package/dist/types/service-operation/ServiceOperationSetQueriesData.d.ts.map +1 -1
  34. package/dist/types/service-operation/ServiceOperationSetQueryData.d.ts +2 -2
  35. package/dist/types/service-operation/ServiceOperationSetQueryData.d.ts.map +1 -1
  36. package/dist/types/service-operation/ServiceOperationUseInfiniteQuery.d.ts +3 -3
  37. package/dist/types/service-operation/ServiceOperationUseInfiniteQuery.d.ts.map +1 -1
  38. package/dist/types/service-operation/ServiceOperationUseIsFetchingQueries.d.ts +2 -2
  39. package/dist/types/service-operation/ServiceOperationUseIsFetchingQueries.d.ts.map +1 -1
  40. package/dist/types/service-operation/ServiceOperationUseQueries.d.ts +3 -3
  41. package/dist/types/service-operation/ServiceOperationUseQueries.d.ts.map +1 -1
  42. package/dist/types/service-operation/ServiceOperationUseQuery.d.ts +3 -3
  43. package/dist/types/service-operation/ServiceOperationUseQuery.d.ts.map +1 -1
  44. package/dist/types/service-operation/ServiceOperationUseSuspenseInfiniteQuery.d.ts +2 -2
  45. package/dist/types/service-operation/ServiceOperationUseSuspenseInfiniteQuery.d.ts.map +1 -1
  46. package/dist/types/service-operation/ServiceOperationUseSuspenseQueries.d.ts +3 -3
  47. package/dist/types/service-operation/ServiceOperationUseSuspenseQueries.d.ts.map +1 -1
  48. package/dist/types/service-operation/ServiceOperationUseSuspenseQuery.d.ts +2 -2
  49. package/dist/types/service-operation/ServiceOperationUseSuspenseQuery.d.ts.map +1 -1
  50. package/dist/types/shared/ServiceOperationFetchInfiniteQueryOptions.d.ts +2 -1
  51. package/dist/types/shared/ServiceOperationFetchInfiniteQueryOptions.d.ts.map +1 -1
  52. package/package.json +1 -1
  53. package/src/service-operation/ServiceOperation.ts +2 -2
  54. package/src/service-operation/ServiceOperationCancelQueries.ts +3 -3
  55. package/src/service-operation/ServiceOperationFetchInfiniteQuery.ts +6 -6
  56. package/src/service-operation/ServiceOperationFetchQuery.ts +9 -9
  57. package/src/service-operation/ServiceOperationGetInfiniteQueryData.ts +2 -2
  58. package/src/service-operation/ServiceOperationGetQueriesData.ts +5 -5
  59. package/src/service-operation/ServiceOperationGetQueryData.ts +2 -2
  60. package/src/service-operation/ServiceOperationGetQueryState.ts +3 -3
  61. package/src/service-operation/ServiceOperationInvalidateQueries.ts +2 -2
  62. package/src/service-operation/ServiceOperationIsFetchingQueries.ts +3 -3
  63. package/src/service-operation/ServiceOperationQueryFn.ts +3 -3
  64. package/src/service-operation/ServiceOperationRefetchQueries.ts +3 -3
  65. package/src/service-operation/ServiceOperationRemoveQueries.ts +3 -3
  66. package/src/service-operation/ServiceOperationResetQueries.ts +3 -3
  67. package/src/service-operation/ServiceOperationSetInfiniteQueryData.ts +5 -4
  68. package/src/service-operation/ServiceOperationSetQueriesData.ts +6 -6
  69. package/src/service-operation/ServiceOperationSetQueryData.ts +4 -4
  70. package/src/service-operation/ServiceOperationUseInfiniteQuery.ts +16 -14
  71. package/src/service-operation/ServiceOperationUseIsFetchingQueries.ts +3 -3
  72. package/src/service-operation/ServiceOperationUseQueries.ts +9 -4
  73. package/src/service-operation/ServiceOperationUseQuery.ts +5 -5
  74. package/src/service-operation/ServiceOperationUseSuspenseInfiniteQuery.ts +8 -5
  75. package/src/service-operation/ServiceOperationUseSuspenseQueries.ts +14 -4
  76. package/src/service-operation/ServiceOperationUseSuspenseQuery.ts +3 -3
  77. package/src/shared/ServiceOperationFetchInfiniteQueryOptions.ts +4 -1
@@ -11,7 +11,7 @@ import type {
11
11
 
12
12
  export interface ServiceOperationUseQuery<
13
13
  TSchema extends { url: string; method: string },
14
- TQueryFnData,
14
+ TOperationQueryFnData,
15
15
  TParams,
16
16
  TError,
17
17
  > {
@@ -19,13 +19,13 @@ export interface ServiceOperationUseQuery<
19
19
  parameters: AreAllOptional<TParams> extends true ? TParams | void : TParams
20
20
  ): ServiceOperationQueryKey<TSchema, TParams>;
21
21
 
22
- useQuery<TData = TQueryFnData>(
22
+ useQuery<TData = TOperationQueryFnData>(
23
23
  parameters:
24
24
  | ServiceOperationQueryKey<TSchema, TParams>
25
25
  | (AreAllOptional<TParams> extends true ? TParams | void : TParams),
26
26
  options?: Omit<
27
27
  UndefinedInitialDataOptions<
28
- TQueryFnData,
28
+ TOperationQueryFnData,
29
29
  TError,
30
30
  TData,
31
31
  ServiceOperationQueryKey<TSchema, TParams>
@@ -34,13 +34,13 @@ export interface ServiceOperationUseQuery<
34
34
  >
35
35
  ): UseQueryResult<TData, TError | Error>;
36
36
 
37
- useQuery<TData = TQueryFnData>(
37
+ useQuery<TData = TOperationQueryFnData>(
38
38
  parameters:
39
39
  | ServiceOperationQueryKey<TSchema, TParams>
40
40
  | (AreAllOptional<TParams> extends true ? TParams | void : TParams),
41
41
  options: Omit<
42
42
  DefinedInitialDataOptions<
43
- TQueryFnData,
43
+ TOperationQueryFnData,
44
44
  TError,
45
45
  TData,
46
46
  ServiceOperationQueryKey<TSchema, TParams>
@@ -12,20 +12,23 @@ import type {
12
12
 
13
13
  export interface ServiceOperationUseSuspenseInfiniteQuery<
14
14
  TSchema extends { url: string; method: string },
15
- TQueryFnData,
15
+ TOperationQueryFnData,
16
16
  TParams,
17
17
  TError,
18
18
  > {
19
- useSuspenseInfiniteQuery<TPageParam extends TParams, TData = TQueryFnData>(
19
+ useSuspenseInfiniteQuery<
20
+ TPageParam extends TParams,
21
+ TData = TOperationQueryFnData,
22
+ >(
20
23
  parameters:
21
24
  | ServiceOperationInfiniteQueryKey<TSchema, TParams>
22
25
  | (AreAllOptional<TParams> extends true ? TParams | void : TParams),
23
26
  options: Omit<
24
27
  UseSuspenseInfiniteQueryOptions<
25
- TQueryFnData,
28
+ TOperationQueryFnData,
26
29
  TError,
27
30
  OperationInfiniteData<TData, TParams>,
28
- TQueryFnData,
31
+ TOperationQueryFnData,
29
32
  ServiceOperationInfiniteQueryKey<TSchema, TParams>,
30
33
  PartialParameters<TPageParam>
31
34
  >,
@@ -35,7 +38,7 @@ export interface ServiceOperationUseSuspenseInfiniteQuery<
35
38
  | 'initialPageParam'
36
39
  > &
37
40
  InfiniteQueryPageParamsOptions<
38
- TQueryFnData,
41
+ TOperationQueryFnData,
39
42
  PartialParameters<TPageParam>
40
43
  >
41
44
  ): UseSuspenseInfiniteQueryResult<
@@ -6,20 +6,30 @@ import type { UseSuspenseQueryResult } from '@tanstack/react-query';
6
6
 
7
7
  export interface ServiceOperationUseSuspenseQueries<
8
8
  TSchema extends { url: string; method: string },
9
- TQueryFnData,
9
+ TOperationQueryFnData,
10
10
  TParams,
11
11
  TError,
12
12
  > {
13
13
  useSuspenseQueries<
14
14
  T extends Array<
15
- UseQueryOptionsForUseSuspenseQuery<TSchema, TParams, TQueryFnData, TError>
15
+ UseQueryOptionsForUseSuspenseQuery<
16
+ TSchema,
17
+ TParams,
18
+ TOperationQueryFnData,
19
+ TError
20
+ >
21
+ >,
22
+ TCombinedResult = Array<
23
+ UseSuspenseQueryResult<TOperationQueryFnData, TError>
16
24
  >,
17
- TCombinedResult = Array<UseSuspenseQueryResult<TQueryFnData, TError>>,
18
25
  >(options: {
19
26
  queries: T;
20
27
  combine?: (
21
28
  results: Array<
22
- WithOptional<UseSuspenseQueryResult<TQueryFnData, TError>, 'data'>
29
+ WithOptional<
30
+ UseSuspenseQueryResult<TOperationQueryFnData, TError>,
31
+ 'data'
32
+ >
23
33
  >
24
34
  ) => TCombinedResult;
25
35
  }): TCombinedResult;
@@ -9,17 +9,17 @@ import type {
9
9
 
10
10
  export interface ServiceOperationUseSuspenseQuery<
11
11
  TSchema extends { url: string; method: string },
12
- TQueryFnData,
12
+ TOperationQueryFnData,
13
13
  TParams,
14
14
  TError,
15
15
  > {
16
- useSuspenseQuery<TData = TQueryFnData>(
16
+ useSuspenseQuery<TData = TOperationQueryFnData>(
17
17
  parameters:
18
18
  | ServiceOperationQueryKey<TSchema, TParams>
19
19
  | (AreAllOptional<TParams> extends true ? TParams | void : TParams),
20
20
  options?: Omit<
21
21
  UseSuspenseQueryOptions<
22
- TQueryFnData,
22
+ TOperationQueryFnData,
23
23
  TError,
24
24
  TData,
25
25
  ServiceOperationQueryKey<TSchema, TParams>
@@ -8,6 +8,7 @@ import type {
8
8
  import type { OperationInfiniteData } from './OperationInfiniteData.js';
9
9
  import type { PartialParameters } from './PartialParameters.js';
10
10
  import type { ServiceOperationInfiniteQueryKey } from './ServiceOperationKey.js';
11
+ import { AreAllOptional } from './AreAllOptional.js';
11
12
  import { RequestFn } from './RequestFn.js';
12
13
 
13
14
  export type ServiceOperationFetchInfiniteQueryOptions<
@@ -96,7 +97,9 @@ type FetchInfiniteQueryOptionsBase<
96
97
  >,
97
98
  'queryKey' | 'initialPageParam'
98
99
  > &
99
- InitialPageParam<PartialParameters<TPageParam>> &
100
+ (AreAllOptional<TParams> extends true
101
+ ? Partial<InitialPageParam<PartialParameters<TPageParam>>>
102
+ : InitialPageParam<PartialParameters<TPageParam>>) &
100
103
  FetchInfiniteQueryPages<TQueryFnData, TPageParam>;
101
104
 
102
105
  type FetchInfiniteQueryOptionsByQueryKey<