@openapi-qraft/react 1.2.0 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @openapi-qraft/react
 
+## 1.4.0
+
+### Minor Changes
+
+- 6343a8d: Added support for `QueryClient.isMutating(...)` method
+- b297c10: Unified `composeMutationKey(...)` to return the same key structure as `composeQueryKey(...)` if no parameters are passed
+- 42a0b11: Added support for `QueryClient.removeQueries(...)` method
+
+### Patch Changes
+
+- 34fd459: Fixed `fetchQuery(...)` documentation
+
+## 1.3.2
+
+### Patch Changes
+
+- cc36283: Republished
+
+## 1.3.1
+
+### Patch Changes
+
+- df98bc2: Fixed issue with `fetch(this, ...)`
+
+## 1.3.0
+
+### Minor Changes
+
+- 7c81509: Add support for `QueryClient.fetchInfiniteQuery(...)` and `QueryClient.prefetchInfiniteQuery(...)` methods
+- 8e47c05: Simplified `QueryClient.setQueryData(...)` API
+- 48e662d: Added support for `QueryClient.fetchQuery(...)` method
+- 315883b: Changed `requestFn(...)` API to simplify the usage
+- d48a40e: Renamed the `request` property to `requestFn` for `QraftContext.value`
+
+### Patch Changes
+
+- 472ae32: Added support for `QueryClient.prefetchQuery(...)` method
+
 ## 1.2.0
 
 ### Minor Changes

package/README.md

@@ -2,7 +2,7 @@
 
 `@openapi-qraft/react` is a modular TypeScript client designed to facilitate type-safe API requests in React
 applications,
-leveraging the power of **Tanstack Query v5**. It utilizes a Proxy-based architecture to dynamically generate
+leveraging the power of **TanStack Query v5**. It utilizes a Proxy-based architecture to dynamically generate
 hooks with typed parameters, ensuring that your API requests are both type-safe and efficient.
 
 ## Features
@@ -11,7 +11,7 @@ hooks with typed parameters, ensuring that your API requests are both type-safe
   developer experience.
 - **Modular Design:** Customize the utility with a set of callbacks to handle API calls according to your project's
   needs.
-- **Integration with [Tanstack Query v5](https://tanstack.com/query/v5):** Seamlessly integrate with _Tanstack Query_
+- **Integration with [TanStack Query v5](https://tanstack.com/query/v5):** Seamlessly integrate with _TanStack Query_
   for handling server state, caching, and data synchronization.
 - **Dynamic Proxy-Based Hooks:** Automatically generate React Query hooks for your API endpoints without manual
   boilerplate.
@@ -56,7 +56,7 @@ npx openapi-typescript https://api.dev.monite.com/openapi.json?version=2023-09-0
 
 #### Generating Qraft Services
 
-Next, use `@openapi-qraft/cli` to generate the services and typed Tanstack Query React Hooks. Ensure to specify the path
+Next, use `@openapi-qraft/cli` to generate the services and typed TanStack Query React Hooks. Ensure to specify the path
 to the TypeScript definitions generated in the previous step.
 
 ```bash
@@ -92,7 +92,7 @@ Every request will be handled by `request` function, which can be customized to
 ```tsx
 import { useMemo } from 'react';
 
-import { request, QraftContext } from '@openapi-qraft/react';
+import { QraftContext, requestFn } from '@openapi-qraft/react';
 import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
 
 // where `./api` is the '--output-dir' path to the services you generated with `@openapi-qraft/cli`
@@ -109,7 +109,7 @@ function Providers({ children }: { children: React.ReactNode }) {
       <QraftContext.Provider
         value={{
           baseUrl: 'https://api.sandbox.monite.com/v1', // base URL for all requests
-          request, // `request(...)` will be invoked for every request
+          requestFn, // `requestFn(...)` will be invoked for every request
         }}
       >
         {children}
@@ -274,7 +274,7 @@ useEffect(() => {
 const infiniteQuery = qraft.posts.getPosts.useInfiniteQuery(
   { query: { limit: 10 } },
   {
-    // * required by Tanstack Query
+    // * required by TanStack Query
     getNextPageParam: (lastPage, allPages, lastPageParams) => {
       if (lastPage.length < 10) return; // if less than 10 items, there are no more pages
       return {
@@ -283,7 +283,7 @@ const infiniteQuery = qraft.posts.getPosts.useInfiniteQuery(
         },
       };
     },
-    // * required by Tanstack Query
+    // * required by TanStack Query
     initialPageParam: {
       query: {
         page: 1, // will be used in initial request
@@ -316,11 +316,11 @@ const infiniteQuery = qraft.dataExports.getDataExports.useInfiniteQuery(
     },
   },
   {
-    // * required by Tanstack Query
+    // * required by TanStack Query
     initialPageParam: {
       query: { pagination_token: undefined }, // will be used in initial request
     },
-    // * required by Tanstack Query
+    // * required by TanStack Query
     getNextPageParam: (lastPage, allPages, lastPageParam) => ({
       query: { pagination_token: lastPage.next_pagination_token },
     }),
@@ -331,10 +331,10 @@ const infiniteQuery = qraft.dataExports.getDataExports.useInfiniteQuery(
   }
 );
 
-// ⬇︎ will execute GET /data_exports?pagination_token=...NEXT_PAGE_TOKEN....
+// ⬇︎ will execute GET /data_exports?pagination_token=<NEXT_PAGINATION_TOKEN>
 infiniteQuery.fetchNextPage();
 
-// ⬇︎ will execute GET /data_exports?pagination_token=...PREV_PAGE_TOKEN....
+// ⬇︎ will execute GET /data_exports?pagination_token=<PREV_PAGINATION_TOKEN>
 infiniteQuery.fetchPreviousPage();
 ```
 
@@ -377,6 +377,34 @@ qraft.entities.getEntities.useQueries({
 });
 ```
 
+### [useIsFetching(...) 🔗](https://tanstack.com/query/latest/docs/framework/react/reference/useIsFetching)
+
+```tsx
+function FetchStatus() {
+  // Checks all queries `GET /entities`
+  const fetchingTotal = qraft.entities.getEntities.useIsFetching();
+
+  // Checks all queries `GET /entities/3e3e-3e3e-3e3e` and `x-monite-version: 2023-09-01` header
+  const specificQueryKeyTotal = qraft.entities.getEntities.useIsFetching({
+    parameters: {
+      header: {
+        'x-monite-version': '2023-09-01',
+      },
+      path: {
+        entity_id: '3e3e-3e3e-3e3e',
+      },
+    },
+  });
+
+  return (
+    <>
+      {!!fetchingTotal && <div>Number of queries: {fetchingTotal}...</div>}
+      {!!specificQueryKeyTotal && <div>Loading specific query...</div>}
+    </>
+  );
+}
+```
+
 ### [`QueryClient`](https://tanstack.com/query/latest/docs/reference/QueryClient) Methods
 
 #### [invalidateQueries(...) 🔗](https://tanstack.com/query/latest/docs/reference/QueryClient#queryclientinvalidatequeries)
@@ -501,33 +529,85 @@ The interface is the same as `invalidateQueries(...)`, but it will refetch the q
 The interface is the same as `invalidateQueries(...), but it will check if the queries are fetching, and there are no
 options.
 
-#### [useIsFetching(...) 🔗](https://tanstack.com/query/latest/docs/framework/react/reference/useIsFetching)
+#### [fetchQuery(...) 🔗](https://tanstack.com/query/latest/docs/reference/QueryClient#queryclientfetchquery)
 
-The interface is the same as `QueryClient.isFetching(...)`, but without the need to pass the `QueryClient` instance:
+```ts
+/**
+ * Will execute the request:
+ * ###
+ * GET /posts?limit=10
+ **/
+import { requestFn } from '@openapi-qraft/react';
+import { QueryClient } from '@tanstack/react-query';
 
-```tsx
-function FetchStatus() {
-  const isFetchingTotal = qraft.entities.getEntities.useIsFetching();
-  const isSpecificQueryFetching = qraft.entities.getEntities.useIsFetching({
-    parameters: {
-      header: {
-        'x-monite-version': '2023-09-01',
-      },
-      path: {
-        entity_id: '3e3e-3e3e-3e3e',
-      },
+const queryClient = new QueryClient();
+
+const posts = qraft.posts.getPosts.fetchQuery(
+  {
+    parameters: { query: { limit: 10 } },
+    /**
+     * Request function should be provided, otherwise it will throw an error
+     * if default `queryFn` is not set previously using
+     * `QueryClient.setDefaultOptions(...)` method
+     */
+    requestFn: requestFn,
+    baseUrl: 'https://api.sandbox.monite.com/v1', // must be provided if `requestFn` is set
+  },
+  queryClient
+);
+```
+
+#### [prefetchQuery(...) 🔗](https://tanstack.com/query/latest/docs/reference/QueryClient#queryclientprefetchquery)
+
+The interface is the same as `fetchQuery(...)`, but returns empty Promise.
+
+#### [fetchInfiniteQuery(...) 🔗](https://tanstack.com/query/latest/docs/reference/QueryClient#queryclientfetchinfinitequery)
+
+```ts
+/**
+ * Will execute the initial request:
+ * ###
+ * GET /posts?limit=10&page=1
+ * ###
+ * And then will execute the next page request:
+ * GET /posts?limit=10&page=2
+ **/
+import { requestFn } from '@openapi-qraft/react';
+import { QueryClient } from '@tanstack/react-query';
+
+const queryClient = new QueryClient();
+
+const posts = qraft.posts.getPosts.fetchInfiniteQuery(
+  {
+    parameters: { query: { limit: 10 } },
+    pages: 2, // How many pages to fetch
+    initialPageParam: {
+      query: { pagination_token: undefined }, // will be used in initial request
     },
-  });
+    getNextPageParam: (lastPage, allPages, lastPageParam) => ({
+      query: { pagination_token: lastPage.next_pagination_token },
+    }),
+    /**
+     * Request function should be provided, otherwise it will throw an error
+     * if default `queryFn` is not set previously using
+     * `QueryClient.setDefaultOptions(...)` method
+     */
+    requestFn: requestFn,
+    baseUrl: 'https://api.sandbox.monite.com/v1', // must be provided if `requestFn` is set
+  },
+  queryClient
+);
 
-  return (
-    <>
-      {!!isFetchingTotal && <div>Number of queries: {isFetchingTotal}...</div>}
-      {!!isSpecificQueryFetching && <div>Loading specific query...</div>}
-    </>
-  );
-}
+console.log(
+  posts.pages, // all fetched pages
+  posts.pageParams // all page parameters
+);
 ```
 
+#### [prefetchInfiniteQuery(...) 🔗](https://tanstack.com/query/latest/docs/reference/QueryClient#queryclientprefetchinfinitequery)
+
+The interface is the same as `fetchInfiniteQuery(...)`, but returns empty Promise.
+
 ### Suspense Queries
 
 Supported Suspense Queries are:
@@ -542,8 +622,8 @@ Supported Suspense Queries are:
 - `getQueryData(parameters)`
 - `setQueryData(parameters, updater)`
 - `getInfiniteQueryKey(parameters)`
-- `getInfinityQueryData(parameters)`
-- `setInfinityQueryData(parameters, updater)`
+- `getInfiniteQueryData(parameters)`
+- `setInfiniteQueryData(parameters, updater)`
 - `schema` - object with schema: `{method, url, mediaType}`
 - `types` - object with types: `{parameters, data, error, body}`
 
@@ -555,7 +635,7 @@ In the example below, we provide a custom `request` function to the `QraftContex
 using a custom `fetchToken` async function.
 
 ```tsx
-import { request, QraftContext } from '@openapi-qraft/react';
+import { QraftContext, requestFn } from '@openapi-qraft/react';
 
 import { fetchToken } from './auth';
 
@@ -564,11 +644,11 @@ function QraftProvider({ children }: { children: React.ReactNode }) {
     <QraftContext.Provider
       value={{
         baseUrl: 'https://api.sandbox.monite.com/v1',
-        async request({ baseUrl }, schema, info) {
+        async requestFn(schema, requestInfo) {
           const token = await fetchToken();
 
-          return request({ baseUrl }, schema, {
-            ...info,
+          return requestFn(schema, {
+            ...requestInfo,
             /** Specify your predefined Headers **/
             headers: {
               Authorization: `Bearer ${token}`,

package/dist/QraftContext.d.ts

@@ -1,20 +1,18 @@
 /// <reference types="react" />
 import type { QueryClient } from '@tanstack/react-query';
-import type { OperationRequestInfo, OperationRequestSchema } from './lib/request.js';
+import type { OperationSchema, RequestFnPayload } from './lib/requestFn.js';
 interface QraftContextValueBase {
-    /** The QueryClient to use in Hooks */
-    queryClient?: QueryClient;
-    /**
-     * The request client to use for making requests. Will be invoked with every request.
-     */
-    request<T>(options: {
-        baseUrl: string;
-    }, schema: OperationRequestSchema, requestInfo: OperationRequestInfo): Promise<T>;
     /**
      * The base URL to use for all requests.
      * @example 'https://api.example.com'
      */
-    baseUrl: string;
+    baseUrl?: string;
+    /**
+     * The `requestFn` will be invoked with every request.
+     */
+    requestFn<T>(requestSchema: OperationSchema, requestInfo: RequestFnPayload): Promise<T>;
+    /** The QueryClient to use in Hooks */
+    queryClient?: QueryClient;
 }
 export type QraftContextValue = QraftContextValueBase | undefined;
 export declare const QraftContext: import("react").Context<QraftContextValue>;

package/dist/QraftContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"QraftContext.d.ts","sourceRoot":"","sources":["../src/QraftContext.ts"],"names":[],"mappings":";AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,KAAK,EACV,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,kBAAkB,CAAC;AAE1B,UAAU,qBAAqB;IAC7B,sCAAsC;IACtC,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,CAAC,EACP,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,EAC5B,MAAM,EAAE,sBAAsB,EAC9B,WAAW,EAAE,oBAAoB,GAChC,OAAO,CAAC,CAAC,CAAC,CAAC;IACd;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,iBAAiB,GAAG,qBAAqB,GAAG,SAAS,CAAC;AAElE,eAAO,MAAM,YAAY,4CAA8C,CAAC"}
+{"version":3,"file":"QraftContext.d.ts","sourceRoot":"","sources":["../src/QraftContext.ts"],"names":[],"mappings":";AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE5E,UAAU,qBAAqB;IAC7B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,CAAC,EACT,aAAa,EAAE,eAAe,EAC9B,WAAW,EAAE,gBAAgB,GAC5B,OAAO,CAAC,CAAC,CAAC,CAAC;IAEd,sCAAsC;IACtC,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,MAAM,MAAM,iBAAiB,GAAG,qBAAqB,GAAG,SAAS,CAAC;AAElE,eAAO,MAAM,YAAY,4CAA8C,CAAC"}

package/dist/QraftContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"QraftContext.js","sourceRoot":"","sources":["../src/QraftContext.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AA8BtC,MAAM,CAAC,MAAM,YAAY,GAAG,aAAa,CAAoB,SAAS,CAAC,CAAC"}
+{"version":3,"file":"QraftContext.js","sourceRoot":"","sources":["../src/QraftContext.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AA2BtC,MAAM,CAAC,MAAM,YAAY,GAAG,aAAa,CAAoB,SAAS,CAAC,CAAC"}

package/dist/ServiceOperation.d.ts

@@ -1,5 +1,6 @@
-import { CancelOptions, DefaultError, FetchStatus, InfiniteData, InfiniteQueryPageParamsOptions, InvalidateOptions, Mutation, MutationState, MutationStatus, NoInfer, QueriesPlaceholderDataFunction, Query, QueryClient, RefetchOptions, ResetOptions, SetDataOptions, Updater } from '@tanstack/query-core';
+import { CancelOptions, DefaultError, FetchStatus, InfiniteData, InfiniteQueryPageParamsOptions, InvalidateOptions, Mutation, MutationState, MutationStatus, NoInfer, QueriesPlaceholderDataFunction, Query, QueryClient, FetchQueryOptions, RefetchOptions, ResetOptions, SetDataOptions, Updater, QueryFunction, InitialPageParam, GetNextPageParamFunction } from '@tanstack/query-core';
 import type { DefinedInitialDataInfiniteOptions, DefinedInitialDataOptions, DefinedUseInfiniteQueryResult, DefinedUseQueryResult, UndefinedInitialDataInfiniteOptions, UndefinedInitialDataOptions, UseInfiniteQueryResult, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult, UseSuspenseInfiniteQueryOptions, UseSuspenseInfiniteQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
+import type { RequestFn } from './lib/requestFn.js';
 export type ServiceOperationQueryKey<S extends {
     url: string;
     method: string;
@@ -14,7 +15,7 @@ export type ServiceOperationMutationKey<S extends Record<'url' | 'method', strin
 export interface ServiceOperationQuery<TSchema extends {
     url: string;
     method: string;
-}, TData, TParams, TError = DefaultError> extends ServiceOperationUseQuery<TSchema, TData, TParams, TError>, ServiceOperationUseQueries<TSchema, TData, TParams, TError>, ServiceOperationUseSuspenseQueries<TSchema, TData, TParams, TError>, ServiceOperationUseInfiniteQuery<TSchema, TData, TParams, TError>, ServiceOperationUseSuspenseQueryQuery<TSchema, TData, TParams, TError>, ServiceOperationUseSuspenseInfiniteQuery<TSchema, TData, TParams, TError>, ServiceOperationUseIsFetchingQueries<TSchema, TData, TParams, TError>, ServiceOperationQueryFn<TSchema, TData, TParams>, ServiceOperationGetQueryData<TSchema, TData, TParams>, ServiceOperationGetInfiniteQueryData<TSchema, TData, TParams>, ServiceOperationSetQueryData<TSchema, TData, TParams>, ServiceOperationSetInfiniteQueryData<TSchema, TData, TParams>, ServiceOperationInvalidateQueries<TSchema, TData, TParams, TError>, ServiceOperationCancelQueries<TSchema, TData, TParams, TError>, ServiceOperationResetQueries<TSchema, TData, TParams, TError>, ServiceOperationRefetchQueries<TSchema, TData, TParams, TError>, ServiceOperationIsFetchingQueries<TSchema, TData, TParams, TError> {
+}, TData, TParams, TError = DefaultError> extends ServiceOperationUseQuery<TSchema, TData, TParams, TError>, ServiceOperationUseQueries<TSchema, TData, TParams, TError>, ServiceOperationUseSuspenseQueries<TSchema, TData, TParams, TError>, ServiceOperationUseInfiniteQuery<TSchema, TData, TParams, TError>, ServiceOperationUseSuspenseQueryQuery<TSchema, TData, TParams, TError>, ServiceOperationUseSuspenseInfiniteQuery<TSchema, TData, TParams, TError>, ServiceOperationUseIsFetchingQueries<TSchema, TData, TParams, TError>, ServiceOperationQueryFn<TSchema, TData, TParams>, ServiceOperationFetchQuery<TSchema, TData, TParams, TError>, ServiceOperationFetchInfiniteQuery<TSchema, TData, TParams, TError>, ServiceOperationGetQueryData<TSchema, TData, TParams>, ServiceOperationGetInfiniteQueryData<TSchema, TData, TParams>, ServiceOperationSetQueryData<TSchema, TData, TParams>, ServiceOperationSetInfiniteQueryData<TSchema, TData, TParams>, ServiceOperationInvalidateQueries<TSchema, TData, TParams, TError>, ServiceOperationCancelQueries<TSchema, TData, TParams, TError>, ServiceOperationRemoveQueries<TSchema, TData, TParams, TError>, ServiceOperationResetQueries<TSchema, TData, TParams, TError>, ServiceOperationRefetchQueries<TSchema, TData, TParams, TError>, ServiceOperationIsFetchingQueries<TSchema, TData, TParams, TError> {
     schema: TSchema;
     types: {
         parameters: TParams;
@@ -30,6 +31,101 @@ interface ServiceOperationUseQuery<TSchema extends {
     useQuery(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>, options?: Omit<UndefinedInitialDataOptions<TData, TError, TData, ServiceOperationQueryKey<TSchema, TParams>>, 'queryKey'>, queryClient?: QueryClient): UseQueryResult<TData, TError | Error>;
     useQuery(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>, options: Omit<DefinedInitialDataOptions<TData, TError, TData, ServiceOperationQueryKey<TSchema, TParams>>, 'queryKey'>, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError | Error>;
 }
+type FetchQueryOptionsBase<TSchema extends {
+    url: string;
+    method: string;
+}, TData, TParams = {}, TError = DefaultError> = Omit<FetchQueryOptions<TData, TError, TData, ServiceOperationQueryKey<TSchema, TParams>>, 'queryKey' | 'queryFn'>;
+interface FetchQueryOptionsByQueryKey<TSchema extends {
+    url: string;
+    method: string;
+}, TData, TParams = {}, TError = DefaultError> extends FetchQueryOptionsBase<TSchema, TData, TParams, TError> {
+    /**
+     * Fetch Queries by query key
+     */
+    queryKey?: ServiceOperationQueryKey<TSchema, TParams>;
+}
+interface FetchQueryOptionsByParameters<TSchema extends {
+    url: string;
+    method: string;
+}, TData, TParams = {}, TError = DefaultError> extends FetchQueryOptionsBase<TSchema, TData, TParams, TError> {
+    /**
+     * Fetch Queries by parameters
+     */
+    parameters?: TParams;
+    queryKey?: never;
+}
+type FetchQueryOptionsQueryFn<TSchema extends {
+    url: string;
+    method: string;
+}, TData, TParams = {}> = {
+    queryFn?: QueryFunction<TData, ServiceOperationQueryKey<TSchema, TParams>>;
+} | {
+    requestFn: RequestFn<TData>;
+    /**
+     * Base URL to use for the request (used in the `queryFn`)
+     * @example 'https://api.example.com'
+     */
+    baseUrl: string | undefined;
+    queryFn?: never;
+};
+interface ServiceOperationFetchQuery<TSchema extends {
+    url: string;
+    method: string;
+}, TData, TParams = {}, TError = DefaultError> {
+    fetchQuery(options: (FetchQueryOptionsByQueryKey<TSchema, TData, TParams, TError> & FetchQueryOptionsQueryFn<TSchema, TData, TParams>) | (FetchQueryOptionsByParameters<TSchema, TData, TParams, TError> & FetchQueryOptionsQueryFn<TSchema, TData, TParams>), queryClient: QueryClient): Promise<TData>;
+    prefetchQuery(options: (FetchQueryOptionsByQueryKey<TSchema, TData, TParams, TError> & FetchQueryOptionsQueryFn<TSchema, TData, TParams>) | (FetchQueryOptionsByParameters<TSchema, TData, TParams, TError> & FetchQueryOptionsQueryFn<TSchema, TData, TParams>), queryClient: QueryClient): Promise<void>;
+}
+type FetchInfiniteQueryOptionsBase<TSchema extends {
+    url: string;
+    method: string;
+}, TData, TParams = {}, TPageParam = unknown, TError = DefaultError> = Omit<FetchQueryOptions<TData, TError, InfiniteData<TData, TPageParam>, ServiceOperationQueryKey<TSchema, TParams>, TPageParam>, 'queryKey'> & InitialPageParam<PartialParameters<TPageParam>> & FetchInfiniteQueryPages<TData, TPageParam>;
+type FetchInfiniteQueryPages<TData = unknown, TPageParam = unknown> = {
+    pages?: never;
+} | {
+    pages: number;
+    getNextPageParam: GetNextPageParamFunction<PartialParameters<TPageParam>, TData>;
+};
+type FetchInfiniteQueryOptionsByQueryKey<TSchema extends {
+    url: string;
+    method: string;
+}, TData, TParams = {}, TPageParam = {}, TError = DefaultError> = FetchInfiniteQueryOptionsBase<TSchema, TData, TParams, TPageParam, TError> & {
+    /**
+     * Fetch Queries by query key
+     */
+    queryKey?: ServiceOperationInfiniteQueryKey<TSchema, TParams>;
+    parameters?: never;
+};
+type FetchInfiniteQueryOptionsByParameters<TSchema extends {
+    url: string;
+    method: string;
+}, TData, TParams = {}, TPageParam = {}, TError = DefaultError> = FetchInfiniteQueryOptionsBase<TSchema, TData, TParams, TPageParam, TError> & {
+    /**
+     * Fetch Queries by parameters
+     */
+    parameters?: TParams;
+    queryKey?: never;
+};
+type FetchInfiniteQueryOptionsQueryFn<TSchema extends {
+    url: string;
+    method: string;
+}, TData, TParams = {}> = {
+    queryFn?: QueryFunction<TData, ServiceOperationInfiniteQueryKey<TSchema, TParams>>;
+} | {
+    requestFn: RequestFn<TData>;
+    /**
+     * Base URL to use for the request (used in the `queryFn`)
+     * @example 'https://api.example.com'
+     */
+    baseUrl: string | undefined;
+    queryFn?: never;
+};
+interface ServiceOperationFetchInfiniteQuery<TSchema extends {
+    url: string;
+    method: string;
+}, TData, TParams = {}, TError = DefaultError> {
+    fetchInfiniteQuery<TPageParam extends TParams>(options: (FetchInfiniteQueryOptionsByQueryKey<TSchema, TData, TParams, TPageParam, TError> & FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>) | (FetchInfiniteQueryOptionsByParameters<TSchema, TData, TParams, TPageParam, TError> & FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>), queryClient: QueryClient): Promise<InfiniteData<TData, TPageParam>>;
+    prefetchInfiniteQuery<TPageParam extends TParams>(options: (FetchInfiniteQueryOptionsByQueryKey<TSchema, TData, TParams, TPageParam, TError> & FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>) | (FetchInfiniteQueryOptionsByParameters<TSchema, TData, TParams, TPageParam, TError> & FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>), queryClient: QueryClient): Promise<void>;
+}
 interface ServiceOperationUseQueries<TSchema extends {
     url: string;
     method: string;
@@ -39,6 +135,7 @@ interface ServiceOperationUseQueries<TSchema extends {
             placeholderData?: TData | QueriesPlaceholderDataFunction<TData>;
         } & ({
             parameters: TParams;
+            queryKey?: never;
         } | {
             queryKey: ServiceOperationQueryKey<TSchema, TParams>;
         })>;
@@ -129,6 +226,22 @@ export interface ServiceOperationCancelQueriesCallback<TSchema extends {
 }, TData, TParams = {}, TError = DefaultError> extends ServiceOperationCancelQueries<TSchema, TData, TParams, TError> {
     cancelQueries(filters: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError> | QueryClient, options?: CancelOptions | QueryClient, queryClient?: QueryClient): Promise<void>;
 }
+interface ServiceOperationRemoveQueries<TSchema extends {
+    url: string;
+    method: string;
+}, TData, TParams = {}, TError = DefaultError> {
+    removeQueries(filters: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>, queryClient: QueryClient): void;
+    removeQueries(queryClient: QueryClient): void;
+}
+/**
+ * @internal
+ */
+export interface ServiceOperationRemoveQueriesCallback<TSchema extends {
+    url: string;
+    method: string;
+}, TData, TParams = {}, TError = DefaultError> extends ServiceOperationRemoveQueries<TSchema, TData, TParams, TError> {
+    removeQueries(filters: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError> | QueryClient, queryClient?: QueryClient): void;
+}
 interface ServiceOperationResetQueries<TSchema extends {
     url: string;
     method: string;
@@ -192,6 +305,7 @@ interface ServiceOperationUseSuspenseQueries<TSchema extends {
     useSuspenseQueries<TCombinedResult = Array<UseSuspenseQueryResult<TData, TError>>>(options: {
         queries: ReadonlyArray<Omit<UseSuspenseQueryOptions<TData, TError, TData, ServiceOperationQueryKey<TSchema, TParams>>, 'queryKey'> & ({
             parameters: TParams;
+            queryKey?: never;
         } | {
             queryKey: ServiceOperationQueryKey<TSchema, TParams>;
         })>;
@@ -221,7 +335,7 @@ interface ServiceOperationUseSuspenseQueryQuery<TSchema extends {
 export interface ServiceOperationMutation<TSchema extends {
     url: string;
     method: string;
-}, TBody, TData, TParams, TError = DefaultError> extends ServiceOperationUseMutation<TSchema, TBody, TData, TParams, TError>, ServiceOperationUseMutationState<TSchema, TBody, TData, TParams, TError>, ServiceOperationMutationFn<TSchema, TBody, TData, TParams> {
+}, TBody, TData, TParams, TError = DefaultError> extends ServiceOperationUseMutation<TSchema, TBody, TData, TParams, TError>, ServiceOperationUseIsMutating<TSchema, TBody, TData, TParams, TError>, ServiceOperationUseMutationState<TSchema, TBody, TData, TParams, TError>, ServiceOperationIsMutatingQueries<TSchema, TData, TParams, TError>, ServiceOperationMutationFn<TSchema, TBody, TData, TParams> {
     schema: TSchema;
     types: {
         parameters: TParams;
@@ -234,7 +348,7 @@ interface ServiceOperationUseMutation<TSchema extends {
     url: string;
     method: string;
 }, TBody, TData, TParams, TError = DefaultError> {
-    getMutationKey<TMutationKeyParams extends TParams>(parameters: TMutationKeyParams | undefined): ServiceOperationMutationKey<TSchema, TMutationKeyParams>;
+    getMutationKey<TMutationKeyParams extends TParams | undefined = undefined>(parameters?: TMutationKeyParams): ServiceOperationMutationKey<TSchema, TMutationKeyParams>;
     useMutation<TVariables extends MutationVariables<TBody, TParams>, TContext = unknown>(parameters?: undefined, options?: Omit<UseMutationOptions<TData, TError, TVariables, TContext>, 'mutationKey'> & {
         mutationKey?: ServiceOperationMutationKey<TSchema, TParams>;
     }, queryClient?: QueryClient): UseMutationResult<TData, TError | Error, TVariables, TContext>;
@@ -281,12 +395,19 @@ interface ServiceOperationUseMutationState<TSchema extends {
         select?: (mutation: Mutation<TData, TError, MutationVariables<TBody, TParams>, TContext>) => TResult;
     }, queryClient?: QueryClient): Array<TResult>;
 }
+interface ServiceOperationUseIsMutating<TSchema extends {
+    url: string;
+    method: string;
+}, TBody, TData, TParams, TError = DefaultError> {
+    useIsMutating<TContext = unknown>(filters?: UseMutationStateFiltersByParameters<TBody, TData, TParams, TError, TContext> | UseMutationStateFiltersByMutationKey<TSchema, TBody, TData, TParams, TError, TContext>, queryClient?: QueryClient): number;
+}
 interface QueryFnOptionsBase<TMeta extends Record<string, any>, TSignal extends AbortSignal = AbortSignal> {
     signal?: TSignal;
     meta?: TMeta;
 }
 interface QueryFnOptionsByParameters<TParams, TMeta extends Record<string, any>, TSignal extends AbortSignal = AbortSignal> extends QueryFnOptionsBase<TMeta, TSignal> {
     parameters: TParams;
+    queryKey?: never;
 }
 interface QueryFnOptionsByQueryKey<TSchema extends {
     url: string;
@@ -313,7 +434,17 @@ interface ServiceOperationSetQueryData<TSchema extends {
     url: string;
     method: string;
 }, TData, TParams = {}> {
-    setQueryData(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>, updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>, queryClient: QueryClient, options?: SetDataOptions): TData | undefined;
+    setQueryData(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>, updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>, options: SetDataOptions, queryClient: QueryClient): TData | undefined;
+    setQueryData(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>, updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>, queryClient: QueryClient): TData | undefined;
+}
+/**
+ * @internal
+ */
+export interface ServiceOperationSetQueryDataCallback<TSchema extends {
+    url: string;
+    method: string;
+}, TData, TParams = {}> extends ServiceOperationSetQueryData<TSchema, TData, TParams> {
+    setQueryData(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>, updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>, options: SetDataOptions | QueryClient, queryClient?: QueryClient): TData | undefined;
 }
 interface ServiceOperationSetInfiniteQueryData<TSchema extends {
     url: string;
@@ -352,6 +483,22 @@ export interface ServiceOperationMutationFn<TSchema extends {
         body: TBody;
     }): Promise<TData>;
 }
+interface ServiceOperationIsMutatingQueries<TSchema extends {
+    url: string;
+    method: string;
+}, TData, TParams = {}, TError = DefaultError> {
+    isMutating(filters: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>, queryClient: QueryClient): number;
+    isMutating(queryClient: QueryClient): number;
+}
+/**
+ * @internal
+ */
+export interface ServiceOperationIsMutatingQueriesCallback<TSchema extends {
+    url: string;
+    method: string;
+}, TData, TParams = {}, TError = DefaultError> extends ServiceOperationIsMutatingQueries<TSchema, TData, TParams, TError> {
+    isMutating(filters: QueryFiltersByParameters<TSchema, TData, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TParams, TError> | QueryClient, queryClient?: QueryClient): number;
+}
 /**
  * Shallow partial 'parameters'.
  * @example