@kubb/plugin-fetch 5.5.7 → 5.5.9

package/OVERVIEW.md

@@ -0,0 +1,19 @@
+# Fetch
+
+Generates a type-safe HTTP client based on the native Fetch API from your OpenAPI spec. Each operation becomes one async function with grouped `path`, `query`, `headers`, and `body` parameters and a result keyed by status code.
+
+This plugin provides the client runtime. Query plugins such as `@kubb/plugin-react-query`, `@kubb/plugin-vue-query`, `@kubb/plugin-swr`, and `@kubb/plugin-mcp` call the functions it generates.
+
+## Setup
+
+- Add `@kubb/plugin-ts` for the operation types. Without it, `@kubb/plugin-zod` with `inferred: true` supplies them.
+- Add `@kubb/plugin-zod` when you set `validator`.
+- No HTTP client package is needed.
+
+## Options worth knowing
+
+- `baseURL` is prepended to every request.
+- `validator: 'zod'` validates request and response bodies with the schemas from `@kubb/plugin-zod`.
+- `sdk` generates a class-based SDK, grouped by tag or flat, instead of standalone functions. Query plugins need the standalone functions, so leave `sdk` unset when you use them.
+- `returnType: 'data'` makes a call resolve to the success body instead of the full result with status, data, and error.
+- `throwOnErrorDefault: false` returns documented error responses as values instead of throwing. A single call can still pass `throwOnError`.

package/dist/index.cjs

@@ -1480,6 +1480,15 @@ const resolverClient = (0, kubb_kit.createResolver)({
 */
 const clientGenerator = createClientGenerator("fetch");
 //#endregion
+//#region kubb-extension.json
+var compatibility = {
+	"kubb": ">=5.8.0",
+	"node": ">=22"
+};
+//#endregion
+//#region package.json
+var version = "5.5.9";
+//#endregion
 //#region src/templates.ts
 /** Absolute path to the fetch client template, copied into `.kubb/client.ts`. */
 const fetchClientTemplatePath = (0, node_url.fileURLToPath)(new URL("../templates/fetch.ts", require("url").pathToFileURL(__filename).href));
@@ -1519,57 +1528,61 @@ const pluginFetchName = "plugin-fetch";
 * })
 * ```
 */
-const pluginFetch = (0, kubb_kit.definePlugin)((options) => {
-	const { output = {
-		path: "clients",
-		barrel: { type: "named" }
-	}, exclude = [], include, override = [], baseURL, throwOnErrorDefault = true, validator = false, returnType = "full", group, sdk, resolver: userResolver } = options;
-	const resolved = {
-		output,
-		exclude,
-		include,
-		override,
-		group: createGroupConfig(group),
-		baseURL,
-		throwOnErrorDefault,
-		validator,
-		returnType,
-		sdk: sdk ? {
-			mode: sdk.mode ?? "tag",
-			name: sdk.name
-		} : void 0,
-		resolver: userResolver ? kubb_kit.Resolver.merge(resolverClient, userResolver) : resolverClient
-	};
-	const selectedGenerators = resolved.sdk ? [createSdkGenerator()] : [clientGenerator];
-	return {
+const pluginFetch = (0, kubb_kit.definePlugin)({
+	meta: {
 		name: pluginFetchName,
-		options,
-		dependencies: [_kubb_plugin_ts.pluginTsName, _kubb_plugin_zod.pluginZodName],
-		hooks: { "kubb:plugin:setup"(ctx) {
-			ctx.setOptions(resolved);
-			ctx.setResolver(resolved.resolver);
-			ctx.setMacros([...defaultMacros, ...options.macros ?? []]);
-			ctx.addGenerator(...selectedGenerators);
-			const root = node_path.default.resolve(ctx.config.root, ctx.config.output.path);
-			const baseURLExpression = baseURL ? baseURL.includes("${") ? `\`${baseURL.replaceAll("`", "\\`")}\`` : JSON.stringify(baseURL) : void 0;
-			ctx.injectFile({
-				baseName: "serializers.ts",
-				path: node_path.default.resolve(root, ".kubb/serializers.ts"),
-				copy: fetchSerializersTemplatePath
-			});
-			ctx.injectFile({
-				baseName: "client.ts",
-				path: node_path.default.resolve(root, ".kubb/client.ts"),
-				copy: fetchClientTemplatePath,
-				footer: baseURLExpression ? `client.setConfig({ baseURL: ${baseURLExpression} })` : void 0
-			});
-			ctx.injectFile({
-				baseName: "standardSchema.ts",
-				path: node_path.default.resolve(root, ".kubb/standardSchema.ts"),
-				copy: standardSchemaTemplatePath
-			});
-		} }
-	};
+		version,
+		compatibility
+	},
+	dependencies: {
+		[_kubb_plugin_ts.pluginTsName]: { optional: true },
+		[_kubb_plugin_zod.pluginZodName]: { optional: true }
+	},
+	setup(options) {
+		const config = (0, kubb_kit.useConfig)();
+		const { output = {
+			path: "clients",
+			barrel: { type: "named" }
+		}, exclude = [], include, override = [], baseURL, throwOnErrorDefault = true, validator = false, returnType = "full", group, sdk, resolver: userResolver } = options;
+		const resolved = {
+			output,
+			exclude,
+			include,
+			override,
+			group: createGroupConfig(group),
+			baseURL,
+			throwOnErrorDefault,
+			validator,
+			returnType,
+			sdk: sdk ? {
+				mode: sdk.mode ?? "tag",
+				name: sdk.name
+			} : void 0,
+			resolver: userResolver ? kubb_kit.Resolver.merge(resolverClient, userResolver) : resolverClient
+		};
+		(0, kubb_kit.setResolver)(resolved.resolver);
+		(0, kubb_kit.setMacros)([...defaultMacros, ...options.macros ?? []]);
+		(0, kubb_kit.addGenerator)(resolved.sdk ? createSdkGenerator() : clientGenerator);
+		const root = node_path.default.resolve(config.root, config.output.path);
+		const baseURLExpression = baseURL ? baseURL.includes("${") ? `\`${baseURL.replaceAll("`", "\\`")}\`` : JSON.stringify(baseURL) : void 0;
+		(0, kubb_kit.injectFile)({
+			baseName: "serializers.ts",
+			path: node_path.default.resolve(root, ".kubb/serializers.ts"),
+			copy: fetchSerializersTemplatePath
+		});
+		(0, kubb_kit.injectFile)({
+			baseName: "client.ts",
+			path: node_path.default.resolve(root, ".kubb/client.ts"),
+			copy: fetchClientTemplatePath,
+			footer: baseURLExpression ? `client.setConfig({ baseURL: ${baseURLExpression} })` : void 0
+		});
+		(0, kubb_kit.injectFile)({
+			baseName: "standardSchema.ts",
+			path: node_path.default.resolve(root, ".kubb/standardSchema.ts"),
+			copy: standardSchemaTemplatePath
+		});
+		return resolved;
+	}
 });
 //#endregion
 exports.clientGenerator = clientGenerator;