Fix/disable use query generation (#1374)

* fix: allow disabling `useQuery`

* fix: InfiniteData for react-query v5(disabled for v4)

* chore: update examples

* chore: upgrade packages

* chore: update test cases

.changeset/serious-bottles-drum.md

@@ -0,0 +1,6 @@
+---
+"@kubb/plugin-react-query": patch
+"@kubb/plugin-vue-query": patch
+---
+
+InfiniteData for react-query v5(disabled for v4)

.changeset/stupid-trees-sip.md

@@ -0,0 +1,5 @@
+---
+"@kubb/plugin-react-query": patch
+---
+
+allow disabling `useQuery`

docs/.vitepress/config.ts

@@ -45,7 +45,7 @@ const knowledgeBaseSidebar = [
   {
     text: 'Kubb Plugins',
     link: '/knowledge-base/plugins/',
-  }
+  },
   // {
   //   text: 'Plugins',
   //   collapsed: false,

docs/blog/v3.md

@@ -31,7 +31,7 @@ We’re excited to announce the release of Kubb v3, a major update that brings s
 In this post, we’ll dive into the key features of Kubb v3 and explore what’s new.
 
 ## What is Kubb?
-For those unfamiliar with Kubb, it’s a flexible framework built to automate code generation based on Swagger/OpenApi spec file. Kubb simplifies your workflow by creating API clients, generating type-safe code, Zod schema's, React-Query code, ...
+For those unfamiliar with Kubb, it’s a flexible framework built to automate code generation based on Swagger/OpenAPI spec file. Kubb simplifies your workflow by creating API clients, generating type-safe code, Zod schema's, React-Query code, ...
 
 By integrating with tools like OpenAPI, Kubb ensures that your code remains aligned with your API specifications, reducing the risk of errors and improving maintainability.
 

docs/changelog.md

@@ -4,6 +4,11 @@ title: Changelog
 
 # Changelog
 
+## 3.0.1
+- [`plugin-react-query`](/plugins/plugin-react-query/): allow disabling `useQuery`
+- [`plugin-react-query`](/plugins/plugin-react-query/): use of `InfiniteData` TypeScript helper for infiniteQueries
+- [`plugin-vue-query`](/plugins/plugin-vue-query/): use of `InfiniteData` TypeScript helper for infiniteQueries
+
 ## 3.0.0-beta.12
 - [`plugin-react-query`](/plugins/plugin-react-query/): allow to disable the generation of useQuery or createQuery hooks.
 - [`plugin-svelte-query`](/plugins/plugin-svelte-query/): allow to disable the generation of useQuery or createQuery hooks.

e2e/package.json

@@ -32,10 +32,10 @@
     "@kubb/plugin-ts": "workspace:*",
     "@kubb/plugin-zod": "workspace:*",
     "@kubb/react": "workspace:*",
-    "@tanstack/react-query": "^5.59.19",
-    "@tanstack/solid-query": "^5.59.17",
-    "@tanstack/svelte-query": "^5.59.17",
-    "@tanstack/vue-query": "^5.59.17",
+    "@tanstack/react-query": "^5.59.20",
+    "@tanstack/solid-query": "^5.59.20",
+    "@tanstack/svelte-query": "^5.59.20",
+    "@tanstack/vue-query": "^5.59.20",
     "axios": "^1.7.7",
     "msw": "^2.6.0",
     "react": "^18.3.1",

examples/advanced/package.json

@@ -38,11 +38,11 @@
     "@kubb/plugin-ts": "workspace:*",
     "@kubb/plugin-zod": "workspace:*",
     "@kubb/react": "workspace:*",
-    "@tanstack/query-core": "^5.59.17",
-    "@tanstack/react-query": "^5.59.19",
-    "@tanstack/solid-query": "^5.59.17",
-    "@tanstack/svelte-query": "^5.59.17",
-    "@tanstack/vue-query": "^5.59.17",
+    "@tanstack/query-core": "^5.59.20",
+    "@tanstack/react-query": "^5.59.20",
+    "@tanstack/solid-query": "^5.59.20",
+    "@tanstack/svelte-query": "^5.59.20",
+    "@tanstack/vue-query": "^5.59.20",
     "axios": "^1.7.7",
     "msw": "^2.6.0",
     "react": "^18.3.1",

examples/advanced/src/gen/clients/hooks/petController/useFindPetsByTagsInfinite.ts

@@ -1,6 +1,6 @@
 import client from '../../../../tanstack-query-client.ts'
 import type { RequestConfig, ResponseConfig } from '../../../../tanstack-query-client.ts'
-import type { QueryKey, InfiniteQueryObserverOptions, UseInfiniteQueryResult } from '../../../../tanstack-query-hook.ts'
+import type { InfiniteData, QueryKey, InfiniteQueryObserverOptions, UseInfiniteQueryResult } from '../../../../tanstack-query-hook.ts'
 import type {
   FindPetsByTagsQueryResponse,
   FindPetsByTagsQueryParams,
@@ -71,7 +71,7 @@ export function findPetsByTagsInfiniteQueryOptions(
  * @link /pet/findByTags
  */
 export function useFindPetsByTagsInfinite<
-  TData = ResponseConfig<FindPetsByTagsQueryResponse>,
+  TData = InfiniteData<ResponseConfig<FindPetsByTagsQueryResponse>>,
   TQueryData = ResponseConfig<FindPetsByTagsQueryResponse>,
   TQueryKey extends QueryKey = FindPetsByTagsInfiniteQueryKey,
 >(

examples/react-query/kubb.config.ts

@@ -74,6 +74,10 @@ export const config = {
               importPath: '@tanstack/react-query',
               methods: ['post'],
             },
+            mutation: {
+              importPath: '@tanstack/react-query',
+              methods: ['put', 'delete'],
+            },
             pathParamsType: 'inline',
           },
         },

examples/react-query/package.json

@@ -29,8 +29,8 @@
     "@kubb/plugin-react-query": "workspace:*",
     "@kubb/plugin-ts": "workspace:*",
     "@kubb/react": "workspace:*",
-    "@tanstack/react-query": "^5.59.19",
-    "@tanstack/react-query-devtools": "^5.59.19",
+    "@tanstack/react-query": "^5.59.20",
+    "@tanstack/react-query-devtools": "^5.59.20",
     "axios": "^1.7.7",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",

examples/react-query/src/gen/hooks/index.ts

@@ -10,6 +10,7 @@ export type { FindPetsByTagsQueryKey } from './useFindPetsByTagsHook.ts'
 export type { FindPetsByTagsInfiniteQueryKey } from './useFindPetsByTagsInfiniteHook.ts'
 export type { FindPetsByTagsSuspenseQueryKey } from './useFindPetsByTagsSuspenseHook.ts'
 export type { GetInventoryQueryKey } from './useGetInventoryHook.ts'
+export type { GetInventorySuspenseQueryKey } from './useGetInventorySuspenseHook.ts'
 export type { GetOrderByIdQueryKey } from './useGetOrderByIdHook.ts'
 export type { GetOrderByIdSuspenseQueryKey } from './useGetOrderByIdSuspenseHook.ts'
 export type { GetPetByIdQueryKey } from './useGetPetByIdHook.ts'
@@ -43,6 +44,7 @@ export { findPetsByTagsQueryKey, findPetsByTagsQueryOptionsHook, useFindPetsByTa
 export { findPetsByTagsInfiniteQueryKey, findPetsByTagsInfiniteQueryOptionsHook, useFindPetsByTagsInfiniteHook } from './useFindPetsByTagsInfiniteHook.ts'
 export { findPetsByTagsSuspenseQueryKey, findPetsByTagsSuspenseQueryOptionsHook, useFindPetsByTagsSuspenseHook } from './useFindPetsByTagsSuspenseHook.ts'
 export { getInventoryQueryKey, getInventoryQueryOptionsHook } from './useGetInventoryHook.ts'
+export { getInventorySuspenseQueryKey, getInventorySuspenseQueryOptionsHook, useGetInventorySuspenseHook } from './useGetInventorySuspenseHook.ts'
 export { getOrderByIdQueryKey, getOrderByIdQueryOptionsHook, useGetOrderByIdHook } from './useGetOrderByIdHook.ts'
 export { getOrderByIdSuspenseQueryKey, getOrderByIdSuspenseQueryOptionsHook, useGetOrderByIdSuspenseHook } from './useGetOrderByIdSuspenseHook.ts'
 export { getPetByIdQueryKey, getPetByIdQueryOptionsHook, useGetPetByIdHook } from './useGetPetByIdHook.ts'

examples/react-query/src/gen/hooks/useFindPetsByTagsInfiniteHook.ts

@@ -1,7 +1,7 @@
 import client from '@kubb/plugin-client/client'
 import type { FindPetsByTagsQueryResponse, FindPetsByTagsQueryParams, FindPetsByTags400 } from '../models/FindPetsByTags.ts'
 import type { RequestConfig, ResponseConfig } from '@kubb/plugin-client/client'
-import type { QueryKey, InfiniteQueryObserverOptions, UseInfiniteQueryResult } from '@tanstack/react-query'
+import type { InfiniteData, QueryKey, InfiniteQueryObserverOptions, UseInfiniteQueryResult } from '@tanstack/react-query'
 import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/react-query'
 
 export const findPetsByTagsInfiniteQueryKey = (params?: FindPetsByTagsQueryParams) => ['v5', { url: '/pet/findByTags' }, ...(params ? [params] : [])] as const
@@ -41,7 +41,7 @@ export function findPetsByTagsInfiniteQueryOptionsHook(params?: FindPetsByTagsQu
  * @link /pet/findByTags
  */
 export function useFindPetsByTagsInfiniteHook<
-  TData = ResponseConfig<FindPetsByTagsQueryResponse>,
+  TData = InfiniteData<ResponseConfig<FindPetsByTagsQueryResponse>>,
   TQueryData = ResponseConfig<FindPetsByTagsQueryResponse>,
   TQueryKey extends QueryKey = FindPetsByTagsInfiniteQueryKey,
 >(

examples/react-query/src/gen/hooks/useGetInventorySuspenseHook.ts

@@ -0,0 +1,58 @@
+import client from '@kubb/plugin-client/client'
+import type { GetInventoryQueryResponse } from '../models/GetInventory.ts'
+import type { RequestConfig } from '@kubb/plugin-client/client'
+import type { QueryKey, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query'
+import { queryOptions, useSuspenseQuery } from '@tanstack/react-query'
+
+export const getInventorySuspenseQueryKey = () => ['v5', { url: '/store/inventory' }] as const
+
+export type GetInventorySuspenseQueryKey = ReturnType<typeof getInventorySuspenseQueryKey>
+
+/**
+ * @description Returns a map of status codes to quantities
+ * @summary Returns pet inventories by status
+ * @link /store/inventory
+ */
+async function getInventory(config: Partial<RequestConfig> = {}) {
+  const res = await client<GetInventoryQueryResponse, Error, unknown>({ method: 'GET', url: '/store/inventory', ...config })
+  return res.data
+}
+
+export function getInventorySuspenseQueryOptionsHook(config: Partial<RequestConfig> = {}) {
+  const queryKey = getInventorySuspenseQueryKey()
+  return queryOptions({
+    queryKey,
+    queryFn: async ({ signal }) => {
+      config.signal = signal
+      return getInventory(config)
+    },
+  })
+}
+
+/**
+ * @description Returns a map of status codes to quantities
+ * @summary Returns pet inventories by status
+ * @link /store/inventory
+ */
+export function useGetInventorySuspenseHook<
+  TData = GetInventoryQueryResponse,
+  TQueryData = GetInventoryQueryResponse,
+  TQueryKey extends QueryKey = GetInventorySuspenseQueryKey,
+>(
+  options: {
+    query?: Partial<UseSuspenseQueryOptions<GetInventoryQueryResponse, Error, TData, TQueryKey>>
+    client?: Partial<RequestConfig>
+  } = {},
+) {
+  const { query: queryOptions, client: config = {} } = options ?? {}
+  const queryKey = queryOptions?.queryKey ?? getInventorySuspenseQueryKey()
+  const query = useSuspenseQuery({
+    ...(getInventorySuspenseQueryOptionsHook(config) as unknown as UseSuspenseQueryOptions),
+    queryKey,
+    ...(queryOptions as unknown as Omit<UseSuspenseQueryOptions, 'queryKey'>),
+  }) as UseSuspenseQueryResult<TData, Error> & {
+    queryKey: TQueryKey
+  }
+  query.queryKey = queryKey as TQueryKey
+  return query
+}

examples/react-query/src/gen/index.ts

@@ -10,6 +10,7 @@ export type { FindPetsByTagsQueryKey } from './hooks/useFindPetsByTagsHook.ts'
 export type { FindPetsByTagsInfiniteQueryKey } from './hooks/useFindPetsByTagsInfiniteHook.ts'
 export type { FindPetsByTagsSuspenseQueryKey } from './hooks/useFindPetsByTagsSuspenseHook.ts'
 export type { GetInventoryQueryKey } from './hooks/useGetInventoryHook.ts'
+export type { GetInventorySuspenseQueryKey } from './hooks/useGetInventorySuspenseHook.ts'
 export type { GetOrderByIdQueryKey } from './hooks/useGetOrderByIdHook.ts'
 export type { GetOrderByIdSuspenseQueryKey } from './hooks/useGetOrderByIdSuspenseHook.ts'
 export type { GetPetByIdQueryKey } from './hooks/useGetPetByIdHook.ts'
@@ -134,6 +135,7 @@ export { findPetsByTagsQueryKey, findPetsByTagsQueryOptionsHook, useFindPetsByTa
 export { findPetsByTagsInfiniteQueryKey, findPetsByTagsInfiniteQueryOptionsHook, useFindPetsByTagsInfiniteHook } from './hooks/useFindPetsByTagsInfiniteHook.ts'
 export { findPetsByTagsSuspenseQueryKey, findPetsByTagsSuspenseQueryOptionsHook, useFindPetsByTagsSuspenseHook } from './hooks/useFindPetsByTagsSuspenseHook.ts'
 export { getInventoryQueryKey, getInventoryQueryOptionsHook } from './hooks/useGetInventoryHook.ts'
+export { getInventorySuspenseQueryKey, getInventorySuspenseQueryOptionsHook, useGetInventorySuspenseHook } from './hooks/useGetInventorySuspenseHook.ts'
 export { getOrderByIdQueryKey, getOrderByIdQueryOptionsHook, useGetOrderByIdHook } from './hooks/useGetOrderByIdHook.ts'
 export { getOrderByIdSuspenseQueryKey, getOrderByIdSuspenseQueryOptionsHook, useGetOrderByIdSuspenseHook } from './hooks/useGetOrderByIdSuspenseHook.ts'
 export { getPetByIdQueryKey, getPetByIdQueryOptionsHook, useGetPetByIdHook } from './hooks/useGetPetByIdHook.ts'

examples/simple-single/package.json

@@ -31,7 +31,7 @@
     "@kubb/plugin-redoc": "workspace:*",
     "@kubb/plugin-ts": "workspace:*",
     "@kubb/plugin-zod": "workspace:*",
-    "@tanstack/react-query": "^5.59.19",
+    "@tanstack/react-query": "^5.59.20",
     "axios": "^1.7.7",
     "react": "^18.3.1",
     "tsup": "^8.3.5",

examples/simple-single/src/gen2/index.ts

@@ -540,6 +540,7 @@ export const machinesListQueryParamsSchema = z
   .object({
     include_deleted: z.boolean().describe('Include deleted machines').optional(),
     region: z.string().describe('Region filter').optional(),
+    state: z.string().describe('comma separated list of states to filter (created, started, stopped, suspended)').optional(),
     summary: z.boolean().describe('Only return summary info about machines (omit config, checks, events, host_status, nonce, etc.)').optional(),
   })
   .optional()

examples/solid-query/kubb.config.js

@@ -26,6 +26,7 @@ export default defineConfig({
       output: {
         path: './hooks',
       },
+      query: false,
       override: [
         {
           type: 'operationId',

examples/solid-query/package.json

@@ -27,7 +27,7 @@
     "@kubb/plugin-solid-query": "workspace:*",
     "@kubb/plugin-ts": "workspace:*",
     "@kubb/plugin-zod": "workspace:*",
-    "@tanstack/solid-query": "^5.59.17",
+    "@tanstack/solid-query": "^5.59.20",
     "axios": "^1.7.7",
     "solid-js": "^1.9.3",
     "tsup": "^8.3.5"

examples/solid-query/src/gen/hooks/createFindPetsByStatus.ts

@@ -1,8 +1,7 @@
 import client from '@kubb/plugin-client/client'
 import type { FindPetsByStatusQueryResponse, FindPetsByStatusQueryParams, FindPetsByStatus400 } from '../models/FindPetsByStatus.ts'
 import type { RequestConfig } from '@kubb/plugin-client/client'
-import type { QueryKey, CreateBaseQueryOptions, CreateQueryResult } from '@tanstack/solid-query'
-import { queryOptions, createQuery } from '@tanstack/solid-query'
+import { queryOptions } from '@tanstack/solid-query'
 
 export const findPetsByStatusQueryKey = (params?: FindPetsByStatusQueryParams) => [{ url: '/pet/findByStatus' }, ...(params ? [params] : [])] as const
 
@@ -28,33 +27,3 @@ export function findPetsByStatusQueryOptions(params?: FindPetsByStatusQueryParam
     },
   })
 }
-
-/**
- * @description Multiple status values can be provided with comma separated strings
- * @summary Finds Pets by status
- * @link /pet/findByStatus
- */
-export function createFindPetsByStatus<
-  TData = FindPetsByStatusQueryResponse,
-  TQueryData = FindPetsByStatusQueryResponse,
-  TQueryKey extends QueryKey = FindPetsByStatusQueryKey,
->(
-  params?: FindPetsByStatusQueryParams,
-  options: {
-    query?: Partial<CreateBaseQueryOptions<FindPetsByStatusQueryResponse, FindPetsByStatus400, TData, TQueryData, TQueryKey>>
-    client?: Partial<RequestConfig>
-  } = {},
-) {
-  const { query: queryOptions, client: config = {} } = options ?? {}
-  const queryKey = queryOptions?.queryKey ?? findPetsByStatusQueryKey(params)
-  const query = createQuery(() => ({
-    ...(findPetsByStatusQueryOptions(params, config) as unknown as CreateBaseQueryOptions),
-    queryKey,
-    initialData: null,
-    ...(queryOptions as unknown as Omit<CreateBaseQueryOptions, 'queryKey'>),
-  })) as CreateQueryResult<TData, FindPetsByStatus400> & {
-    queryKey: TQueryKey
-  }
-  query.queryKey = queryKey as TQueryKey
-  return query
-}

examples/solid-query/src/gen/hooks/createFindPetsByTags.ts

@@ -1,8 +1,7 @@
 import client from '@kubb/plugin-client/client'
 import type { FindPetsByTagsQueryResponse, FindPetsByTagsQueryParams, FindPetsByTags400 } from '../models/FindPetsByTags.ts'
-import type { RequestConfig, ResponseConfig } from '@kubb/plugin-client/client'
-import type { QueryKey, CreateBaseQueryOptions, CreateQueryResult } from '@tanstack/solid-query'
-import { queryOptions, createQuery } from '@tanstack/solid-query'
+import type { RequestConfig } from '@kubb/plugin-client/client'
+import { queryOptions } from '@tanstack/solid-query'
 
 export const findPetsByTagsQueryKey = (params?: FindPetsByTagsQueryParams) => [{ url: '/pet/findByTags' }, ...(params ? [params] : [])] as const
 
@@ -28,33 +27,3 @@ export function findPetsByTagsQueryOptions(params?: FindPetsByTagsQueryParams, c
     },
   })
 }
-
-/**
- * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
- * @summary Finds Pets by tags
- * @link /pet/findByTags
- */
-export function createFindPetsByTags<
-  TData = ResponseConfig<FindPetsByTagsQueryResponse>,
-  TQueryData = ResponseConfig<FindPetsByTagsQueryResponse>,
-  TQueryKey extends QueryKey = FindPetsByTagsQueryKey,
->(
-  params?: FindPetsByTagsQueryParams,
-  options: {
-    query?: Partial<CreateBaseQueryOptions<ResponseConfig<FindPetsByTagsQueryResponse>, FindPetsByTags400, TData, TQueryData, TQueryKey>>
-    client?: Partial<RequestConfig>
-  } = {},
-) {
-  const { query: queryOptions, client: config = {} } = options ?? {}
-  const queryKey = queryOptions?.queryKey ?? findPetsByTagsQueryKey(params)
-  const query = createQuery(() => ({
-    ...(findPetsByTagsQueryOptions(params, config) as unknown as CreateBaseQueryOptions),
-    queryKey,
-    initialData: null,
-    ...(queryOptions as unknown as Omit<CreateBaseQueryOptions, 'queryKey'>),
-  })) as CreateQueryResult<TData, FindPetsByTags400> & {
-    queryKey: TQueryKey
-  }
-  query.queryKey = queryKey as TQueryKey
-  return query
-}

examples/solid-query/src/gen/hooks/createGetInventory.ts

@@ -1,8 +1,7 @@
 import client from '@kubb/plugin-client/client'
 import type { GetInventoryQueryResponse } from '../models/GetInventory.ts'
 import type { RequestConfig } from '@kubb/plugin-client/client'
-import type { QueryKey, CreateBaseQueryOptions, CreateQueryResult } from '@tanstack/solid-query'
-import { queryOptions, createQuery } from '@tanstack/solid-query'
+import { queryOptions } from '@tanstack/solid-query'
 
 export const getInventoryQueryKey = () => [{ url: '/store/inventory' }] as const
 
@@ -28,32 +27,3 @@ export function getInventoryQueryOptions(config: Partial<RequestConfig> = {}) {
     },
   })
 }
-
-/**
- * @description Returns a map of status codes to quantities
- * @summary Returns pet inventories by status
- * @link /store/inventory
- */
-export function createGetInventory<
-  TData = GetInventoryQueryResponse,
-  TQueryData = GetInventoryQueryResponse,
-  TQueryKey extends QueryKey = GetInventoryQueryKey,
->(
-  options: {
-    query?: Partial<CreateBaseQueryOptions<GetInventoryQueryResponse, Error, TData, TQueryData, TQueryKey>>
-    client?: Partial<RequestConfig>
-  } = {},
-) {
-  const { query: queryOptions, client: config = {} } = options ?? {}
-  const queryKey = queryOptions?.queryKey ?? getInventoryQueryKey()
-  const query = createQuery(() => ({
-    ...(getInventoryQueryOptions(config) as unknown as CreateBaseQueryOptions),
-    queryKey,
-    initialData: null,
-    ...(queryOptions as unknown as Omit<CreateBaseQueryOptions, 'queryKey'>),
-  })) as CreateQueryResult<TData, Error> & {
-    queryKey: TQueryKey
-  }
-  query.queryKey = queryKey as TQueryKey
-  return query
-}