@kubb/plugin-react-query 5.4.0-canary.20261013T112432 → 5.4.0-canary.20261013T135854

package/dist/index.cjs

@@ -357,7 +357,7 @@ var compatibility = {
 };
 //#endregion
 //#region package.json
-var version = "5.4.0-canary.20261013T112432";
+var version = "5.4.0-canary.20261013T135854";
 //#endregion
 //#region ../../internals/client/src/resolveClient.ts
 /**

package/dist/index.js

@@ -330,7 +330,7 @@ var compatibility = {
 };
 //#endregion
 //#region package.json
-var version = "5.4.0-canary.20261013T112432";
+var version = "5.4.0-canary.20261013T135854";
 //#endregion
 //#region ../../internals/client/src/resolveClient.ts
 /**

package/docs/overview.md

@@ -1,26 +1,30 @@
 # React Query
 
-Generates TanStack Query helpers for React from your OpenAPI spec. By default you get `queryOptions` and `mutationOptions` factories with their cache keys. Set `hooks: true` to also get `useQuery`, `useSuspenseQuery`, `useInfiniteQuery`, and `useMutation` hooks.
+The React Query plugin generates TanStack Query helpers for React from your OpenAPI spec. By default you get `queryOptions` and `mutationOptions` factories with their query and mutation keys. Set `hooks: true` to also get `useQuery` and `useMutation` hooks.
 
 The plugin ships no HTTP client. Each helper calls a function generated by a client plugin.
 
 ## Setup
 
-- Add `@kubb/plugin-ts` and a client plugin: `@kubb/plugin-fetch` or `@kubb/plugin-axios`.
-- Install `@tanstack/react-query` v5 or higher in the app that uses the generated code.
+- Add `@kubb/plugin-ts` and a client plugin: `@kubb/plugin-fetch` or `@kubb/plugin-axios`. Leave `sdk` unset on the client plugin.
+- Install `@tanstack/react-query` 5.82 or a later v5 release in the app that uses the generated code.
 - Configure validation on the client plugin, not here.
 
 ## Options worth knowing
 
 - `client` picks `fetch` or `axios` when both client plugins are registered. A single client is detected automatically.
 - `hooks` adds the `use*` hooks on top of the option factories.
-- `suspense` adds `useSuspenseQuery` hooks.
-- `infinite` adds infinite queries for pagination. Set `infinite.queryParam` to the query parameter that holds the page cursor.
-- `query` and `mutation` set which HTTP methods become queries (`GET`) and mutations (`POST`, `PUT`, `PATCH`, `DELETE`), and where the TanStack Query runtime is imported from. Set either to `false` to skip it.
-- `customOptions` routes every hook through your own function that returns extra options.
+- `suspense: {}` adds `useSuspenseQuery` hooks. It needs `hooks: true`.
+- `infinite` adds `useInfiniteQuery` hooks for pagination. It needs `hooks: true` and covers the operations that take the query parameter named in `infinite.queryParam`, which defaults to `'id'`.
+- `query` and `mutation` set which HTTP methods become queries (`GET`) and mutations (`POST`, `PUT`, `PATCH`, `DELETE`). They also set where the TanStack Query runtime is imported from. Set either to `false` to skip those helpers.
+- `customOptions: { importPath }` routes every hook through your own function that returns extra options. It needs `hooks: true`. Kubb creates a starter file at `importPath`, resolved from the generated hooks folder, when none exists.
+
+See [Options](https://kubb.dev/extensions/kubb-labs/plugin-react-query/options) for every option and its default.
 
 ## Example
 
+The config below generates `useQuery` and `useMutation` hooks that call the Fetch client.
+
 ```typescript [kubb.config.ts]
 import { defineConfig } from 'kubb/config'
 import { pluginTs } from '@kubb/plugin-ts'
@@ -37,7 +41,3 @@ export default defineConfig({
   ],
 })
 ```
-
-## See also
-
-- [TanStack Query](https://tanstack.com/query)

package/kubb-extension.json

@@ -4,7 +4,7 @@
   "name": "plugin-react-query",
   "export": "pluginReactQuery",
   "displayName": "React Query",
-  "description": "Generates typed TanStack Query hooks for React from your OpenAPI spec, so reads and writes call your API through useQuery, useMutation, and useInfiniteQuery without hand-written boilerplate.",
+  "description": "Generates typed TanStack Query helpers for React from your OpenAPI spec: queryOptions and mutationOptions factories with their cache keys. Set hooks to also get useQuery and useMutation hooks, plus useInfiniteQuery when infinite is set.",
   "category": "framework",
   "icon": {
     "light": "https://kubb.dev/feature/tanstack.svg"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-react-query",
-  "version": "5.4.0-canary.20261013T112432",
+  "version": "5.4.0-canary.20261013T135854",
   "description": "Generate type-safe TanStack Query (React Query) hooks with Kubb. Covers useQuery, useMutation, useInfiniteQuery, and queryOptions with full TypeScript support.",
   "keywords": [
     "code-generation",
@@ -76,13 +76,13 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@kubb/plugin-ts": "^5.1.0-canary.20261013T112432"
+    "@kubb/plugin-ts": "^5.1.0-canary.20261013T135853"
   },
   "devDependencies": {
-    "@internals/client": "0.1.0-canary.20261013T112432",
-    "@internals/shared": "0.1.0-canary.20261013T112431",
-    "@internals/tanstack-query": "0.1.0-canary.20261013T112432",
-    "@internals/utils": "0.1.0-canary.20261013T112431",
+    "@internals/client": "0.1.0-canary.20261013T135853",
+    "@internals/shared": "0.1.0-canary.20261013T135853",
+    "@internals/tanstack-query": "0.1.0-canary.20261013T135853",
+    "@internals/utils": "0.1.0-canary.20261013T135853",
     "@tanstack/react-query": "^5.104.1",
     "kubb": "^5.8.3"
   },