@kubb/plugin-swr 5.4.3 → 5.4.5

package/docs/options.md

@@ -10,9 +10,9 @@ Pass these options to `pluginSwr()`, all of them optional. Shared options link t
 | [`group`](https://kubb.dev/docs/5.x/reference/plugin-options#group)       | Split output by tag or path: `type`, `name`.                           | None                                                                          |
 | [`client`](#client)                                                       | Which registered client plugin the hooks call.                         | Auto-detected                                                                 |
 | [`query`](#query)                                                         | Configure the `useSWR` hooks, or turn them off.                        | `{ methods: ['GET', 'QUERY'], importPath: 'swr' }`                            |
-| [`queryKey`](#querykey)                                                   | Build the SWR key for each query hook.                                 | Built-in `queryKeyTransformer`                                                |
+| [`queryKey`](#querykey)                                                   | Build the SWR key for each query hook.                                 | Exported `queryKeyTransformer`                                                |
 | [`mutation`](#mutation)                                                   | Configure the `useSWRMutation` hooks, or turn them off.                | `{ methods: ['POST', 'PUT', 'PATCH', 'DELETE'], importPath: 'swr/mutation' }` |
-| [`mutationKey`](#mutationkey)                                             | Build the SWR key for each mutation hook.                              | Built-in `mutationKeyTransformer`                                             |
+| [`mutationKey`](#mutationkey)                                             | Build the SWR key for each mutation hook.                              | Exported `mutationKeyTransformer`                                             |
 | [`include`](https://kubb.dev/docs/5.x/reference/plugin-options#include)   | Keep only operations that match.                                       | None                                                                          |
 | [`exclude`](https://kubb.dev/docs/5.x/reference/plugin-options#exclude)   | Skip operations that match.                                            | `[]`                                                                          |
 | [`override`](https://kubb.dev/docs/5.x/reference/plugin-options#override) | Apply different options per pattern.                                   | `[]`                                                                          |
@@ -86,12 +86,20 @@ Builds the SWR key for each query hook. The callback receives the operation `nod
 | -------- | ------------------------------------------------------ |
 | Type     | `(props: { node, casing, variant }) => Array<unknown>` |
 | Required | `false`                                                |
-| Default  | Built-in `queryKeyTransformer`                         |
+| Default  | Exported `queryKeyTransformer`                         |
 
 ```typescript
 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-swr'
+
+queryKey: (props) => [JSON.stringify(props.node.operationId), ...queryKeyTransformer(props)]
+```
+
 ### mutation
 
 Configures the generated `useSWRMutation` hooks. Pass an object to change the HTTP methods or import path, or `false` to skip mutation hook generation.
@@ -130,7 +138,15 @@ Builds the SWR key for each mutation hook. Like `queryKey`, the callback receive
 | -------- | ------------------------------------------------------ |
 | 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-swr'
+
+mutationKey: (props) => [JSON.stringify(props.node.operationId), ...mutationKeyTransformer(props)]
+```
 
 ### resolver
 

package/kubb-extension.json

@@ -195,6 +195,20 @@
       "description": "Module specifier the generated mutation hook imports from",
       "type": "text",
       "default": "swr/mutation"
+    },
+    {
+      "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-swr",
-  "version": "5.4.3",
+  "version": "5.4.5",
   "description": "Generate type-safe SWR hooks with Kubb. Covers useSWR and useSWRMutation with full TypeScript support.",
   "keywords": [
     "code-generation",
@@ -79,18 +79,18 @@
     "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",
-    "kubb": "^5.10.3",
+    "kubb": "^5.12.5",
     "swr": "^2.5.1"
   },
   "peerDependencies": {
-    "kubb": "^5.10.3",
+    "kubb": "^5.12.5",
     "swr": "^2.2.0"
   },
   "peerDependenciesMeta": {