@openapi-qraft/tanstack-query-react-types 2.4.1 → 2.5.0-beta.0

package/src/service-operation/ServiceOperationSetQueryData.ts

@@ -8,14 +8,14 @@ import type { NoInfer, SetDataOptions, Updater } from '@tanstack/query-core';
 export interface ServiceOperationSetQueryData<
   TSchema extends { url: string; method: string },
   TOperationQueryFnData,
-  TParams,
+  TQueryParams,
 > {
   setQueryData(
     parameters:
-      | (AreAllOptional<TParams> extends true
-          ? DeepReadonly<TParams> | undefined
-          : DeepReadonly<TParams>)
-      | ServiceOperationQueryKey<TSchema, TParams>,
+      | (AreAllOptional<TQueryParams> extends true
+          ? DeepReadonly<TQueryParams> | undefined
+          : DeepReadonly<TQueryParams>)
+      | ServiceOperationQueryKey<TSchema, TQueryParams>,
     updater: Updater<
       NoInfer<TOperationQueryFnData> | undefined,
       NoInfer<DeepReadonly<TOperationQueryFnData>> | undefined

package/src/service-operation/ServiceOperationUseInfiniteQuery.ts

@@ -16,31 +16,31 @@ import type {
 export interface ServiceOperationUseInfiniteQuery<
   TSchema extends { url: string; method: string },
   TOperationQueryFnData,
-  TParams,
+  TQueryParams,
   TError,
 > {
   getInfiniteQueryKey(
-    parameters: AreAllOptional<TParams> extends true
-      ? DeepReadonly<TParams> | void
-      : DeepReadonly<TParams>
-  ): ServiceOperationInfiniteQueryKey<TSchema, TParams>;
+    parameters: AreAllOptional<TQueryParams> extends true
+      ? DeepReadonly<TQueryParams> | void
+      : DeepReadonly<TQueryParams>
+  ): ServiceOperationInfiniteQueryKey<TSchema, TQueryParams>;
 
   useInfiniteQuery<
-    TPageParam extends TParams,
+    TPageParam extends TQueryParams,
     TQueryFnData = TOperationQueryFnData,
-    TData = OperationInfiniteData<TQueryFnData, TParams>,
+    TData = OperationInfiniteData<TQueryFnData, TQueryParams>,
   >(
     parameters:
-      | ServiceOperationInfiniteQueryKey<TSchema, TParams>
-      | (AreAllOptional<TParams> extends true
-          ? DeepReadonly<TParams> | void
-          : DeepReadonly<TParams>),
+      | ServiceOperationInfiniteQueryKey<TSchema, TQueryParams>
+      | (AreAllOptional<TQueryParams> extends true
+          ? DeepReadonly<TQueryParams> | void
+          : DeepReadonly<TQueryParams>),
     options: Omit<
       UndefinedInitialDataInfiniteOptions<
         TQueryFnData,
         TError,
         TData,
-        ServiceOperationInfiniteQueryKey<TSchema, TParams>,
+        ServiceOperationInfiniteQueryKey<TSchema, TQueryParams>,
         PartialParameters<DeepReadonly<TPageParam>>
       >,
       | 'queryKey'
@@ -55,21 +55,21 @@ export interface ServiceOperationUseInfiniteQuery<
   ): UseInfiniteQueryResult<TData, TError | Error>;
 
   useInfiniteQuery<
-    TPageParam extends TParams,
+    TPageParam extends TQueryParams,
     TQueryFnData = TOperationQueryFnData,
-    TData = OperationInfiniteData<TQueryFnData, TParams>,
+    TData = OperationInfiniteData<TQueryFnData, TQueryParams>,
   >(
     parameters:
-      | ServiceOperationInfiniteQueryKey<TSchema, TParams>
-      | (AreAllOptional<TParams> extends true
-          ? DeepReadonly<TParams> | void
-          : DeepReadonly<TParams>),
+      | ServiceOperationInfiniteQueryKey<TSchema, TQueryParams>
+      | (AreAllOptional<TQueryParams> extends true
+          ? DeepReadonly<TQueryParams> | void
+          : DeepReadonly<TQueryParams>),
     options: Omit<
       DefinedInitialDataInfiniteOptions<
         TQueryFnData,
         TError,
         TData,
-        ServiceOperationInfiniteQueryKey<TSchema, TParams>,
+        ServiceOperationInfiniteQueryKey<TSchema, TQueryParams>,
         PartialParameters<DeepReadonly<TPageParam>>
       >,
       | 'queryKey'

package/src/service-operation/ServiceOperationUseIsFetchingQueries.ts

@@ -6,7 +6,7 @@ import type {
 export interface ServiceOperationUseIsFetchingQueries<
   TSchema extends { url: string; method: string },
   TOperationQueryFnData,
-  TParams,
+  TQueryParams,
   TError,
 > {
   useIsFetching<TInfinite extends boolean = false>(
@@ -15,14 +15,14 @@ export interface ServiceOperationUseIsFetchingQueries<
           TSchema,
           TOperationQueryFnData,
           TInfinite,
-          TParams,
+          TQueryParams,
           TError
         >
       | QueryFiltersByQueryKey<
           TSchema,
           TOperationQueryFnData,
           TInfinite,
-          TParams,
+          TQueryParams,
           TError
         >
   ): number;

package/src/service-operation/ServiceOperationUseIsMutating.ts

@@ -7,7 +7,7 @@ export interface ServiceOperationUseIsMutating<
   TSchema extends { url: string; method: string },
   TBody,
   TMutationData,
-  TParams,
+  TMutationParams,
   TError,
 > {
   useIsMutating<TContext = unknown>(
@@ -15,7 +15,7 @@ export interface ServiceOperationUseIsMutating<
       | MutationFiltersByParameters<
           TBody,
           TMutationData,
-          TParams,
+          TMutationParams,
           TError | Error,
           TContext
         >
@@ -23,7 +23,7 @@ export interface ServiceOperationUseIsMutating<
           TSchema,
           TBody,
           TMutationData,
-          TParams,
+          TMutationParams,
           TError | Error,
           TContext
         >

package/src/service-operation/ServiceOperationUseMutation.ts

@@ -11,19 +11,19 @@ export interface ServiceOperationUseMutation<
   TSchema extends { url: string; method: string },
   TBody,
   TMutationData,
-  TParams,
+  TMutationParams,
   TError,
 > {
   getMutationKey(
-    parameters: DeepReadonly<TParams> | void
-  ): ServiceOperationMutationKey<TSchema, TParams>;
+    parameters: DeepReadonly<TMutationParams> | void
+  ): ServiceOperationMutationKey<TSchema, TMutationParams>;
 
   useMutation<TVariables extends TBody, TContext = unknown>(
-    parameters: DeepReadonly<TParams>,
+    parameters: DeepReadonly<TMutationParams>,
     options?: ServiceOperationUseMutationOptions<
       TSchema,
       TMutationData,
-      TParams,
+      TMutationParams,
       TVariables,
       TError | Error,
       TContext
@@ -36,14 +36,14 @@ export interface ServiceOperationUseMutation<
   >;
 
   useMutation<
-    TVariables extends MutationVariables<TBody, TParams>,
+    TVariables extends MutationVariables<TBody, TMutationParams>,
     TContext = unknown,
   >(
     parameters: void,
     options?: ServiceOperationUseMutationOptions<
       TSchema,
       TMutationData,
-      TParams,
+      TMutationParams,
       TVariables,
       TError | Error,
       TContext

package/src/service-operation/ServiceOperationUseMutationState.ts

@@ -9,7 +9,7 @@ export interface ServiceOperationUseMutationState<
   TSchema extends { url: string; method: string },
   TBody,
   TMutationData,
-  TParams,
+  TMutationParams,
   TError,
 > {
   useMutationState<
@@ -17,7 +17,7 @@ export interface ServiceOperationUseMutationState<
     TResult = MutationState<
       TMutationData,
       TError | Error,
-      MutationVariables<TBody, TParams>,
+      MutationVariables<TBody, TMutationParams>,
       TContext
     >,
   >(options?: {
@@ -25,7 +25,7 @@ export interface ServiceOperationUseMutationState<
       | MutationFiltersByParameters<
           TBody,
           TMutationData,
-          TParams,
+          TMutationParams,
           TError | Error,
           TContext
         >
@@ -33,7 +33,7 @@ export interface ServiceOperationUseMutationState<
           TSchema,
           TBody,
           TMutationData,
-          TParams,
+          TMutationParams,
           TError | Error,
           TContext
         >;
@@ -41,7 +41,7 @@ export interface ServiceOperationUseMutationState<
       mutation: Mutation<
         TMutationData,
         TError | Error,
-        MutationVariables<TBody, TParams>,
+        MutationVariables<TBody, TMutationParams>,
         TContext
       >
     ) => TResult;

package/src/service-operation/ServiceOperationUseQueries.ts

@@ -4,14 +4,14 @@ import type { UseQueryResult } from '@tanstack/react-query';
 export interface ServiceOperationUseQueries<
   TSchema extends { url: string; method: string },
   TOperationQueryFnData,
-  TParams,
+  TQueryParams,
   TError,
 > {
   useQueries<
     T extends Array<
       UseQueryOptionsForUseQueries<
         TSchema,
-        TParams,
+        TQueryParams,
         TOperationQueryFnData,
         TError
       >

package/src/service-operation/ServiceOperationUseQuery.ts

@@ -13,27 +13,27 @@ import type {
 export interface ServiceOperationUseQuery<
   TSchema extends { url: string; method: string },
   TOperationQueryFnData,
-  TParams,
+  TQueryParams,
   TError,
 > {
   getQueryKey(
-    parameters: AreAllOptional<TParams> extends true
-      ? DeepReadonly<TParams> | void
-      : DeepReadonly<TParams>
-  ): ServiceOperationQueryKey<TSchema, TParams>;
+    parameters: AreAllOptional<TQueryParams> extends true
+      ? DeepReadonly<TQueryParams> | void
+      : DeepReadonly<TQueryParams>
+  ): ServiceOperationQueryKey<TSchema, TQueryParams>;
 
   useQuery<TData = TOperationQueryFnData>(
     parameters:
-      | ServiceOperationQueryKey<TSchema, TParams>
-      | (AreAllOptional<TParams> extends true
-          ? DeepReadonly<TParams> | void
-          : DeepReadonly<TParams>),
+      | ServiceOperationQueryKey<TSchema, TQueryParams>
+      | (AreAllOptional<TQueryParams> extends true
+          ? DeepReadonly<TQueryParams> | void
+          : DeepReadonly<TQueryParams>),
     options?: Omit<
       UndefinedInitialDataOptions<
         TOperationQueryFnData,
         TError,
         TData,
-        ServiceOperationQueryKey<TSchema, TParams>
+        ServiceOperationQueryKey<TSchema, TQueryParams>
       >,
       'queryKey'
     >
@@ -41,16 +41,16 @@ export interface ServiceOperationUseQuery<
 
   useQuery<TData = TOperationQueryFnData>(
     parameters:
-      | ServiceOperationQueryKey<TSchema, TParams>
-      | (AreAllOptional<TParams> extends true
-          ? DeepReadonly<TParams> | void
-          : DeepReadonly<TParams>),
+      | ServiceOperationQueryKey<TSchema, TQueryParams>
+      | (AreAllOptional<TQueryParams> extends true
+          ? DeepReadonly<TQueryParams> | void
+          : DeepReadonly<TQueryParams>),
     options: Omit<
       DefinedInitialDataOptions<
         TOperationQueryFnData,
         TError,
         TData,
-        ServiceOperationQueryKey<TSchema, TParams>
+        ServiceOperationQueryKey<TSchema, TQueryParams>
       >,
       'queryKey'
     >

package/src/service-operation/ServiceOperationUseSuspenseInfiniteQuery.ts

@@ -14,25 +14,25 @@ import type {
 export interface ServiceOperationUseSuspenseInfiniteQuery<
   TSchema extends { url: string; method: string },
   TOperationQueryFnData,
-  TParams,
+  TQueryParams,
   TError,
 > {
   useSuspenseInfiniteQuery<
-    TPageParam extends TParams,
+    TPageParam extends TQueryParams,
     TData = TOperationQueryFnData,
   >(
     parameters:
-      | ServiceOperationInfiniteQueryKey<TSchema, TParams>
-      | (AreAllOptional<TParams> extends true
-          ? DeepReadonly<TParams> | void
-          : DeepReadonly<TParams>),
+      | ServiceOperationInfiniteQueryKey<TSchema, TQueryParams>
+      | (AreAllOptional<TQueryParams> extends true
+          ? DeepReadonly<TQueryParams> | void
+          : DeepReadonly<TQueryParams>),
     options: Omit<
       UseSuspenseInfiniteQueryOptions<
         TOperationQueryFnData,
         TError,
-        OperationInfiniteData<TData, TParams>,
+        OperationInfiniteData<TData, TQueryParams>,
         TOperationQueryFnData,
-        ServiceOperationInfiniteQueryKey<TSchema, TParams>,
+        ServiceOperationInfiniteQueryKey<TSchema, TQueryParams>,
         PartialParameters<DeepReadonly<TPageParam>>
       >,
       | 'queryKey'
@@ -45,7 +45,7 @@ export interface ServiceOperationUseSuspenseInfiniteQuery<
         PartialParameters<DeepReadonly<TPageParam>>
       >
   ): UseSuspenseInfiniteQueryResult<
-    OperationInfiniteData<TData, TParams>,
+    OperationInfiniteData<TData, TQueryParams>,
     TError | Error
   >;
 }

package/src/service-operation/ServiceOperationUseSuspenseQueries.ts

@@ -7,14 +7,14 @@ import type { UseSuspenseQueryResult } from '@tanstack/react-query';
 export interface ServiceOperationUseSuspenseQueries<
   TSchema extends { url: string; method: string },
   TOperationQueryFnData,
-  TParams,
+  TQueryParams,
   TError,
 > {
   useSuspenseQueries<
     T extends Array<
       UseQueryOptionsForUseSuspenseQuery<
         TSchema,
-        TParams,
+        TQueryParams,
         TOperationQueryFnData,
         TError
       >

package/src/service-operation/ServiceOperationUseSuspenseQuery.ts

@@ -11,21 +11,21 @@ import type {
 export interface ServiceOperationUseSuspenseQuery<
   TSchema extends { url: string; method: string },
   TOperationQueryFnData,
-  TParams,
+  TQueryParams,
   TError,
 > {
   useSuspenseQuery<TData = TOperationQueryFnData>(
     parameters:
-      | ServiceOperationQueryKey<TSchema, TParams>
-      | (AreAllOptional<TParams> extends true
-          ? DeepReadonly<TParams> | void
-          : DeepReadonly<TParams>),
+      | ServiceOperationQueryKey<TSchema, TQueryParams>
+      | (AreAllOptional<TQueryParams> extends true
+          ? DeepReadonly<TQueryParams> | void
+          : DeepReadonly<TQueryParams>),
     options?: Omit<
       UseSuspenseQueryOptions<
         TOperationQueryFnData,
         TError,
         TData,
-        ServiceOperationQueryKey<TSchema, TParams>
+        ServiceOperationQueryKey<TSchema, TQueryParams>
       >,
       'queryKey'
     >