@kubb/plugin-swr 5.2.4 → 5.2.6

package/dist/index.cjs

@@ -342,7 +342,7 @@ var compatibility = {
 };
 //#endregion
 //#region package.json
-var version = "5.2.4";
+var version = "5.2.6";
 //#endregion
 //#region ../../internals/client/src/resolveClient.ts
 /**

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./rolldown-runtime-C0LytTxp.js";
-import { Exclude, Group, Include, Output, OutputOptions, Override, PluginFactoryOptions, Resolver, ResolverPatch, ast } from "kubb/kit";
+import { Exclude, Group, Include, Output, OutputOptions, Override, PluginType, Resolver, ResolverPatch, ast } from "kubb/kit";
 import "@kubb/plugin-ts";
 import "kubb/jsx";
 import "@kubb/plugin-zod";
@@ -245,7 +245,7 @@ type ResolvedOptions = {
   mutation: NonNullable<Required<Mutation>> | false;
   resolver: ResolverSwr;
 };
-type PluginSwr = PluginFactoryOptions<'plugin-swr', Options, ResolvedOptions, ResolverSwr>;
+type PluginSwr = PluginType<'plugin-swr', Options, ResolvedOptions, ResolverSwr>;
 declare global {
   namespace Kubb {
     interface PluginRegistry {

package/dist/index.js

@@ -312,7 +312,7 @@ var compatibility = {
 };
 //#endregion
 //#region package.json
-var version = "5.2.4";
+var version = "5.2.6";
 //#endregion
 //#region ../../internals/client/src/resolveClient.ts
 /**

package/docs/overview.md

@@ -1,22 +1,28 @@
 # SWR
 
-Generates typed SWR hooks from your OpenAPI spec: `useSWR` for reads and `useSWRMutation` for writes.
+The SWR plugin generates a `useSWR` hook for each query and a `useSWRMutation` hook for each mutation.
 
 The plugin ships no HTTP client. Each hook 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 SWR v2 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 `swr` 2.2 or a later v2 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.
-- `query` and `mutation` set which HTTP methods become queries (`GET`) and mutations (`POST`, `PUT`, `PATCH`, `DELETE`), and where SWR is imported from (`swr` and `swr/mutation`). Set either to `false` to skip it.
+- `query` and `mutation` set which HTTP methods become queries (`GET`) and mutations (`POST`, `PUT`, `PATCH`, `DELETE`). They also set where SWR is imported from (`swr` and `swr/mutation`). Set either to `false` to skip those hooks.
+
+The plugin does not generate `useSWRInfinite` hooks.
+
+See [Options](https://kubb.dev/extensions/kubb-labs/plugin-swr/options) for every option and its default.
 
 ## Example
 
+The config below generates `useSWR` and `useSWRMutation` hooks that call the Fetch client.
+
 ```typescript [kubb.config.ts]
 import { defineConfig } from 'kubb/config'
 import { pluginTs } from '@kubb/plugin-ts'
@@ -33,7 +39,3 @@ export default defineConfig({
   ],
 })
 ```
-
-## See also
-
-- [SWR](https://swr.vercel.app)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-swr",
-  "version": "5.2.4",
+  "version": "5.2.6",
   "description": "Generate type-safe SWR hooks with Kubb. Covers useSWR and useSWRMutation with full TypeScript support.",
   "keywords": [
     "code-generation",
@@ -74,19 +74,19 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@kubb/plugin-ts": "^5.0.9"
+    "@kubb/plugin-ts": "^5.0.11"
   },
   "devDependencies": {
     "@internals/client": "0.0.0",
     "@internals/shared": "0.0.0",
     "@internals/tanstack-query": "0.0.0",
     "@internals/utils": "0.0.0",
-    "kubb": "^5.8.3",
+    "kubb": "^5.9.2",
     "swr": "^2.5.1"
   },
   "peerDependencies": {
-    "kubb": "^5.8.3",
-    "swr": "^2.0.0"
+    "kubb": "^5.9.2",
+    "swr": "^2.2.0"
   },
   "peerDependenciesMeta": {
     "swr": {