@kubb/plugin-react-query 5.5.3 → 5.5.5

package/docs/options.md

@@ -12,9 +12,9 @@ Pass these options to `pluginReactQuery()`. Shared options link to [Shared plugi
 | [`infinite`](#infinite)                                                   | Generate `useInfiniteQuery` hooks for pagination.                      | `false`                                                                                |
 | [`suspense`](#suspense)                                                   | Generate `useSuspenseQuery` hooks.                                     | `false`                                                                                |
 | [`query`](#query)                                                         | Configure the query hooks.                                             | `{ methods: ['GET', 'QUERY'], importPath: '@tanstack/react-query' }`                   |
-| [`queryKey`](#querykey)                                                   | Build the `queryKey` for each query hook.                              | Built-in `queryKeyTransformer`                                                         |
+| [`queryKey`](#querykey)                                                   | Build the `queryKey` for each query hook.                              | Exported `queryKeyTransformer`                                                         |
 | [`mutation`](#mutation)                                                   | Configure the mutation hooks.                                          | `{ methods: ['POST', 'PUT', 'PATCH', 'DELETE'], importPath: '@tanstack/react-query' }` |
-| [`mutationKey`](#mutationkey)                                             | Build the `mutationKey` for each mutation hook.                        | Built-in `mutationKeyTransformer`                                                      |
+| [`mutationKey`](#mutationkey)                                             | Build the `mutationKey` for each mutation hook.                        | Exported `mutationKeyTransformer`                                                      |
 | [`customOptions`](#customoptions)                                         | Route every hook through your own options function.                    | None                                                                                   |
 | [`hooks`](#hooks)                                                         | Emit `use*` hook functions on top of the factories.                    | `false`                                                                                |
 | [`include`](https://kubb.dev/docs/5.x/reference/plugin-options#include)   | Keep only operations that match.                                       | None                                                                                   |
@@ -190,7 +190,7 @@ Builds the `queryKey` for each hook from the operation `node`, `casing` and `var
 | -------- | ------------------------------------------------------ |
 | Type     | `(props: { node, casing, variant }) => Array<unknown>` |
 | Required | `false`                                                |
-| Default  | Built-in `queryKeyTransformer`                         |
+| Default  | Exported `queryKeyTransformer`                         |
 
 `variant` is `'query'`, `'suspenseQuery'`, `'infiniteQuery'` or `'suspenseInfiniteQuery'`. The default key adds `infinite: true` to infinite variants so they never share a cache entry with the plain query.
 
@@ -198,6 +198,14 @@ Builds the `queryKey` for each hook from the operation `node`, `casing` and `var
 queryKey: ({ node, variant }) => [JSON.stringify({ variant, operationId: node.operationId })]
 ```
 
+To extend the default key instead of replacing it, import `queryKeyTransformer` and spread its result. The default segments can change between releases, so spread them instead of reading single entries.
+
+```typescript
+import { queryKeyTransformer } from '@kubb/plugin-react-query'
+
+queryKey: (props) => [JSON.stringify(props.node.operationId), ...queryKeyTransformer(props)]
+```
+
 ### mutation
 
 Which operations become mutations, emitting a `mutationOptions` factory by default. Set `false` to skip, or set [`hooks`](#hooks) to also emit `useMutation`.
@@ -236,7 +244,15 @@ Builds the `mutationKey` for each mutation hook, for batched invalidations or `u
 | -------- | ------------------------------------------------------ |
 | Type     | `(props: { node, casing, variant }) => Array<unknown>` |
 | Required | `false`                                                |
-| Default  | Built-in `mutationKeyTransformer`                      |
+| Default  | Exported `mutationKeyTransformer`                      |
+
+Extend the default the same way with `mutationKeyTransformer`:
+
+```typescript
+import { mutationKeyTransformer } from '@kubb/plugin-react-query'
+
+mutationKey: (props) => [JSON.stringify(props.node.operationId), ...mutationKeyTransformer(props)]
+```
 
 ### customOptions
 

package/kubb-extension.json

@@ -220,6 +220,34 @@
       "description": "Module specifier the generated mutation hook imports from",
       "type": "text",
       "default": "@tanstack/react-query"
+    },
+    {
+      "key": "customOptionsImportPath",
+      "path": ["customOptions", "importPath"],
+      "label": "Custom Options Import Path",
+      "description": "Module of your hook that adds options to every generated query and mutation",
+      "type": "text"
+    },
+    {
+      "key": "customOptionsName",
+      "path": ["customOptions", "name"],
+      "label": "Custom Options Name",
+      "description": "Exported name of that hook, useCustomHookOptions when empty. Needs the import path",
+      "type": "text"
+    },
+    {
+      "key": "banner",
+      "path": ["output", "banner"],
+      "label": "Banner",
+      "description": "Text added at the top of every generated file",
+      "type": "text"
+    },
+    {
+      "key": "footer",
+      "path": ["output", "footer"],
+      "label": "Footer",
+      "description": "Text added at the end of every generated file",
+      "type": "text"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-react-query",
-  "version": "5.5.3",
+  "version": "5.5.5",
   "description": "Generate type-safe TanStack Query (React Query) hooks with Kubb. Covers useQuery, useMutation, useInfiniteQuery, and queryOptions with full TypeScript support.",
   "keywords": [
     "code-generation",
@@ -81,19 +81,19 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@kubb/plugin-ts": "^5.0.14"
+    "@kubb/plugin-ts": "^5.0.15"
   },
   "devDependencies": {
     "@internals/client": "0.0.0",
     "@internals/shared": "0.0.0",
     "@internals/tanstack-query": "0.0.0",
     "@internals/utils": "0.0.0",
-    "@tanstack/react-query": "^5.104.2",
-    "kubb": "^5.10.3"
+    "@tanstack/react-query": "^5.104.4",
+    "kubb": "^5.12.5"
   },
   "peerDependencies": {
     "@tanstack/react-query": "^5.82.0",
-    "kubb": "^5.10.3"
+    "kubb": "^5.12.5"
   },
   "peerDependenciesMeta": {
     "@tanstack/react-query": {