@kubb/plugin-swr 5.2.1 → 5.2.3

package/OVERVIEW.md

@@ -0,0 +1,16 @@
+# SWR
+
+Generates typed SWR hooks from your OpenAPI spec: `useSWR` for reads and `useSWRMutation` for writes.
+
+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.
+- 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.

package/dist/index.cjs

@@ -335,6 +335,15 @@ function createGroupConfig(group) {
 	};
 }
 //#endregion
+//#region kubb-extension.json
+var compatibility = {
+	"kubb": ">=5.8.0",
+	"node": ">=22"
+};
+//#endregion
+//#region package.json
+var version = "5.2.3";
+//#endregion
 //#region ../../internals/client/src/resolveClient.ts
 /**
 * Resolves which client plugin a consumer (react-query, vue-query, swr, mcp) should call for an
@@ -1297,41 +1306,39 @@ const pluginSwrName = "plugin-swr";
 * })
 * ```
 */
-const pluginSwr = (0, kubb_kit.definePlugin)((options) => {
-	const { output = {
-		path: "hooks",
-		barrel: { type: "named" }
-	}, group, exclude = [], include, override = [], mutation = {}, query = {}, mutationKey = mutationKeyTransformer, queryKey = queryKeyTransformer, client, resolver: userResolver, macros: userMacros } = options;
-	const selectedGenerators = [queryGenerator, mutationGenerator];
-	const groupConfig = createGroupConfig(group) ?? void 0;
-	return {
+const pluginSwr = (0, kubb_kit.definePlugin)({
+	meta: {
 		name: pluginSwrName,
-		options,
-		dependencies: [_kubb_plugin_ts.pluginTsName],
-		hooks: { "kubb:plugin:setup"(ctx) {
-			ctx.requirePlugin(_kubb_plugin_ts.pluginTsName);
-			const resolver = userResolver ? kubb_kit.Resolver.merge(resolverSwr, userResolver) : resolverSwr;
-			ctx.setOptions({
-				output,
-				client: resolveContractClient({
-					client,
-					plugins: ctx.config.plugins
-				}),
-				queryKey,
-				query: resolveQueryConfig(query, { importPath: "swr" }),
-				mutationKey,
-				mutation: resolveMutationConfig(mutation, { importPath: "swr/mutation" }),
-				group: groupConfig,
-				exclude,
-				include,
-				override,
-				resolver
-			});
-			ctx.setResolver(resolver);
-			if (userMacros?.length) ctx.setMacros(userMacros);
-			ctx.addGenerator(...selectedGenerators);
-		} }
-	};
+		version,
+		compatibility
+	},
+	dependencies: { [_kubb_plugin_ts.pluginTsName]: {} },
+	setup(options) {
+		const { output = {
+			path: "hooks",
+			barrel: { type: "named" }
+		}, group, exclude = [], include, override = [], mutation = {}, query = {}, mutationKey = mutationKeyTransformer, queryKey = queryKeyTransformer, client, resolver: userResolver, macros: userMacros } = options;
+		const resolver = userResolver ? kubb_kit.Resolver.merge(resolverSwr, userResolver) : resolverSwr;
+		(0, kubb_kit.setResolver)(resolver);
+		if (userMacros?.length) (0, kubb_kit.setMacros)(userMacros);
+		(0, kubb_kit.addGenerator)(queryGenerator, mutationGenerator);
+		return {
+			output,
+			client: resolveContractClient({
+				client,
+				plugins: (0, kubb_kit.useConfig)().plugins
+			}),
+			queryKey,
+			query: resolveQueryConfig(query, { importPath: "swr" }),
+			mutationKey,
+			mutation: resolveMutationConfig(mutation, { importPath: "swr/mutation" }),
+			group: createGroupConfig(group) ?? void 0,
+			exclude,
+			include,
+			override,
+			resolver
+		};
+	}
 });
 //#endregion
 exports.default = pluginSwr;