@kubb/plugin-client 5.0.0-beta.30 → 5.0.0-beta.31

package/dist/index.d.ts

@@ -170,12 +170,13 @@ type Options = {
   paramsCasing?: 'camelcase';
   /**
    * Validator applied to response bodies before they are returned to the caller.
-   * - `'client'` — no validation. Trusts the API.
+   * - `false` (default) — no validation. The client has no runtime parser; the response is
+   *   returned as-is, cast to the generated TypeScript type.
    * - `'zod'` — pipes responses through schemas from `@kubb/plugin-zod`.
    *
-   * @default 'client'
+   * @default false
    */
-  parser?: 'client' | 'zod';
+  parser?: false | 'zod';
   /**
    * Shape of the generated client.
    * - `'function'` — one standalone async function per operation.

package/dist/index.js

@@ -354,11 +354,30 @@ var URLPath = class {
 };
 //#endregion
 //#region ../../internals/shared/src/operation.ts
+/**
+* Builds the `ResolverFileParams` every operation generator passes to
+* `resolver.resolveFile`: a file named `name`, tagged by the operation's first
+* tag (or `'default'`), at the operation's path. Centralizes the entry object
+* that was repeated at dozens of call sites across the client and query plugins.
+*
+* @example
+* ```ts
+* resolver.resolveFile(operationFileEntry(node, node.operationId), { root, output, group })
+* ```
+*/
+function operationFileEntry(node, name, extname = ".ts") {
+	return {
+		name,
+		extname,
+		tag: node.tags[0] ?? "default",
+		path: node.path
+	};
+}
 function getOperationLink(node, link) {
 	if (!link) return null;
 	if (typeof link === "function") return link(node) ?? null;
 	if (link === "urlPath") return node.path ? `{@link ${new URLPath(node.path).URL}}` : null;
-	return `{@link ${node.path.replaceAll("{", ":").replaceAll("}", "")}}`;
+	return node.path ? `{@link ${node.path.replaceAll("{", ":").replaceAll("}", "")}}` : null;
 }
 function getContentTypeInfo(node) {
 	const contentTypes = node.requestBody?.content?.map((e) => e.contentType) ?? [];
@@ -371,6 +390,22 @@ function getContentTypeInfo(node) {
 		hasFormData: contentTypes.some((ct) => ct === "multipart/form-data")
 	};
 }
+/**
+* Derives the default `responseType` for an operation from its primary success response.
+*
+* Returns a value only when that response declares a single non-JSON content type — a binary type
+* (`application/octet-stream`, `application/pdf`, `image/*`, `audio/*`, `video/*`) maps to `'blob'`
+* and other `text/*` maps to `'text'`. Otherwise `undefined`, leaving the runtime client's
+* `Content-Type` auto-detection in charge.
+*/
+function getResponseType(node) {
+	const contentTypes = getPrimarySuccessResponse(node)?.content?.map((entry) => entry.contentType) ?? [];
+	if (contentTypes.length !== 1) return void 0;
+	const baseType = contentTypes[0].split(";")[0].trim().toLowerCase();
+	if (baseType === "application/json" || baseType.endsWith("+json") || baseType === "text/json") return void 0;
+	if (baseType.startsWith("text/")) return "text";
+	if (baseType === "application/octet-stream" || baseType === "application/pdf" || /^(image|audio|video)\//.test(baseType)) return "blob";
+}
 function buildRequestConfigType(node, resolver) {
 	const requestName = node.requestBody?.content?.[0]?.schema ? resolver.resolveDataName(node) : null;
 	const { isMultipleContentTypes, contentTypeUnion } = getContentTypeInfo(node);
@@ -414,6 +449,15 @@ function isErrorStatusCode(statusCode) {
 	const code = getStatusCodeNumber(statusCode);
 	return code !== null && code >= 400;
 }
+function getSuccessResponses(responses) {
+	return responses.filter((response) => isSuccessStatusCode(response.statusCode));
+}
+function getOperationSuccessResponses(node) {
+	return getSuccessResponses(node.responses);
+}
+function getPrimarySuccessResponse(node) {
+	return getOperationSuccessResponses(node)[0] ?? null;
+}
 function resolveErrorNames(node, resolver) {
 	return node.responses.filter((response) => isErrorStatusCode(response.statusCode)).map((response) => resolver.resolveResponseStatusName(node, response.statusCode));
 }
@@ -456,6 +500,39 @@ function resolveOperationTypeNames(node, resolver, options = {}) {
 	return result;
 }
 //#endregion
+//#region ../../internals/shared/src/group.ts
+/**
+* Builds the `group` config a Kubb plugin passes to `ctx.setOptions`, applying the
+* shared default naming so every plugin groups output consistently:
+*
+* - `path` groups use the second path segment (`/pet/findByStatus` → `pet`).
+* - other groups use `${camelCase(group)}${suffix}` (e.g. `petController`).
+*
+* Returns `null` when grouping is disabled, matching the per-plugin convention.
+*
+* @param group - The user-supplied group option, or `undefined` to disable grouping.
+* @param options.suffix - Appended to non-`path` group names, e.g. `'Controller'` or `'Requests'`.
+* @param options.honorName - When `true`, a user-provided `group.name` overrides the default namer.
+*
+* @example
+* ```ts
+* createGroupConfig(group, { suffix: 'Controller' })                  // plugin-ts, plugin-zod
+* createGroupConfig(group, { suffix: 'Controller', honorName: true }) // plugin-faker, plugin-client, …
+* createGroupConfig(group, { suffix: 'Requests', honorName: true })   // plugin-cypress, plugin-mcp
+* ```
+*/
+function createGroupConfig(group, options) {
+	if (!group) return null;
+	const defaultName = (ctx) => {
+		if (group.type === "path") return `${ctx.group.split("/")[1]}`;
+		return `${camelCase(ctx.group)}${options.suffix}`;
+	};
+	return {
+		...group,
+		name: options.honorName && group.name ? group.name : defaultName
+	};
+}
+//#endregion
 //#region ../../internals/shared/src/params.ts
 function buildParamsMapping(originalParams, mappedParams) {
 	const mapping = {};
@@ -547,6 +624,7 @@ function buildUrlParamsNode({ paramsType, paramsCasing, pathParamsType, node, ts
 	});
 }
 function Url({ name, isExportable = true, isIndexable = true, baseURL, paramsType, paramsCasing, pathParamsType, node, tsResolver }) {
+	if (!ast.isHttpOperationNode(node)) return null;
 	const path = new URLPath(node.path);
 	const paramsNode = buildUrlParamsNode({
 		paramsType,
@@ -600,9 +678,11 @@ function buildClientParamsNode({ paramsType, paramsCasing, pathParamsType, node,
 	});
 }
 function Client({ name, isExportable = true, isIndexable = true, returnType, baseURL, dataReturnType, parser, paramsType, paramsCasing, pathParamsType, node, tsResolver, zodResolver, urlName, children, isConfigurable = true }) {
+	if (!ast.isHttpOperationNode(node)) return null;
 	const path = new URLPath(node.path);
 	const { defaultContentType: contentType, isMultipleContentTypes, hasFormData } = getContentTypeInfo(node);
 	const isFormData = !isMultipleContentTypes && contentType === "multipart/form-data";
+	const responseType = getResponseType(node);
 	const { path: originalPathParams, query: originalQueryParams, header: originalHeaderParams } = getOperationParameters(node);
 	const { path: casedPathParams, query: casedQueryParams, header: casedHeaderParams } = getOperationParameters(node, { paramsCasing });
 	const pathParamsMapping = paramsCasing && !urlName ? buildParamsMapping(originalPathParams, casedPathParams) : null;
@@ -650,6 +730,7 @@ function Client({ name, isExportable = true, isIndexable = true, returnType, bas
 			params: queryParamsName ? queryParamsMapping ? { value: "mappedParams" } : {} : null,
 			data: requestName ? { value: isMultipleContentTypes && hasFormData ? "contentType === 'multipart/form-data' ? formData as FormData : requestData" : isFormData ? "formData as FormData" : "requestData" } : null,
 			contentType: isConfigurable && isMultipleContentTypes ? {} : null,
+			responseType: responseType ? { value: JSON.stringify(responseType) } : null,
 			requestConfig: isConfigurable ? { mode: "inlineSpread" } : null,
 			headers: headers.length ? { value: isConfigurable ? `{ ${headers.join(", ")}, ...requestConfig.headers }` : `{ ${headers.join(", ")} }` } : null
 		}
@@ -657,8 +738,8 @@ function Client({ name, isExportable = true, isIndexable = true, returnType, bas
 	const childrenElement = children ? children : /* @__PURE__ */ jsxs(Fragment, { children: [
 		dataReturnType === "full" && parser === "zod" && zodResponseName && `return {...res, data: ${zodResponseName}.parse(res.data)}`,
 		dataReturnType === "data" && parser === "zod" && zodResponseName && `return ${zodResponseName}.parse(res.data)`,
-		dataReturnType === "full" && parser === "client" && "return res",
-		dataReturnType === "data" && parser === "client" && "return res.data"
+		dataReturnType === "full" && parser !== "zod" && "return res",
+		dataReturnType === "data" && parser !== "zod" && "return res.data"
 	] });
 	return /* @__PURE__ */ jsxs(Fragment, { children: [/* @__PURE__ */ jsx("br", {}), /* @__PURE__ */ jsx(File.Source, {
 		name,
@@ -734,16 +815,18 @@ function buildClassClientParams({ node, path, baseURL, tsResolver, isFormData, i
 	const { query: queryParams } = getOperationParameters(node);
 	const queryParamsName = queryParams.length > 0 ? tsResolver.resolveQueryParamsName(node, queryParams[0]) : null;
 	const requestName = node.requestBody?.content?.[0]?.schema ? tsResolver.resolveDataName(node) : null;
+	const responseType = getResponseType(node);
 	return createFunctionParams({ config: {
 		mode: "object",
 		children: {
 			requestConfig: { mode: "inlineSpread" },
-			method: { value: JSON.stringify(node.method.toUpperCase()) },
+			method: { value: JSON.stringify(ast.isHttpOperationNode(node) ? node.method.toUpperCase() : "") },
 			url: { value: path.template },
 			baseURL: baseURL ? { value: JSON.stringify(baseURL) } : null,
 			params: queryParamsName ? {} : null,
 			data: requestName ? { value: isMultipleContentTypes && hasFormData ? "contentType === 'multipart/form-data' ? formData as FormData : requestData" : isFormData ? "formData as FormData" : "requestData" } : null,
 			contentType: isMultipleContentTypes ? {} : null,
+			responseType: responseType ? { value: JSON.stringify(responseType) } : null,
 			headers: headers.length ? { value: `{ ${headers.join(", ")}, ...requestConfig.headers }` } : null
 		}
 	} });
@@ -773,13 +856,14 @@ function buildReturnStatement({ dataReturnType, parser, node, zodResolver }) {
 	const zodResponseName = zodResolver && parser === "zod" ? zodResolver.resolveResponseName?.(node) : null;
 	if (dataReturnType === "full" && parser === "zod" && zodResponseName) return `return {...res, data: ${zodResponseName}.parse(res.data)}`;
 	if (dataReturnType === "data" && parser === "zod" && zodResponseName) return `return ${zodResponseName}.parse(res.data)`;
-	if (dataReturnType === "full" && parser === "client") return "return res";
+	if (dataReturnType === "full" && parser !== "zod") return "return res";
 	return "return res.data";
 }
 //#endregion
 //#region src/components/ClassClient.tsx
 const declarationPrinter$1 = functionPrinter({ mode: "declaration" });
 function generateMethod$1({ node, name, tsResolver, zodResolver, baseURL, dataReturnType, parser, paramsType, paramsCasing, pathParamsType }) {
+	if (!ast.isHttpOperationNode(node)) return "";
 	const path = new URLPath(node.path, { casing: paramsCasing });
 	const { defaultContentType: contentType, isMultipleContentTypes, hasFormData } = getContentTypeInfo(node);
 	const isFormData = !isMultipleContentTypes && contentType === "multipart/form-data";
@@ -907,22 +991,12 @@ const classClientGenerator = defineGenerator({
 		const pluginZod = parser === "zod" ? driver.getPlugin(pluginZodName) : null;
 		const zodResolver = pluginZod ? driver.getResolver(pluginZodName) : null;
 		function buildOperationData(node) {
-			const typeFile = tsResolver.resolveFile({
-				name: node.operationId,
-				extname: ".ts",
-				tag: node.tags[0] ?? "default",
-				path: node.path
-			}, {
+			const typeFile = tsResolver.resolveFile(operationFileEntry(node, node.operationId), {
 				root,
 				output: tsPluginOptions?.output ?? output,
 				group: tsPluginOptions?.group
 			});
-			const zodFile = zodResolver && pluginZod?.options ? zodResolver.resolveFile({
-				name: node.operationId,
-				extname: ".ts",
-				tag: node.tags[0] ?? "default",
-				path: node.path
-			}, {
+			const zodFile = zodResolver && pluginZod?.options ? zodResolver.resolveFile(operationFileEntry(node, node.operationId), {
 				root,
 				output: pluginZod.options?.output ?? output,
 				group: pluginZod.options?.group ?? void 0
@@ -937,6 +1011,7 @@ const classClientGenerator = defineGenerator({
 			};
 		}
 		const controllers = nodes.reduce((acc, operationNode) => {
+			if (!ast.isHttpOperationNode(operationNode)) return acc;
 			const tag = operationNode.tags[0];
 			const groupName = tag ? group?.name?.({ group: camelCase(tag) }) ?? resolver.resolveGroupName(tag) : resolver.resolveGroupName("Client");
 			if (!tag && !group) {
@@ -1196,6 +1271,7 @@ const clientGenerator = defineGenerator({
 	name: "client",
 	renderer: jsxRendererSync,
 	operation(node, ctx) {
+		if (!ast.isHttpOperationNode(node)) return null;
 		const { config, driver, resolver, root } = ctx;
 		const { output, urlType, dataReturnType, paramsCasing, paramsType, pathParamsType, parser, importPath, group } = ctx.options;
 		const baseURL = ctx.options.baseURL ?? ctx.meta.baseURL;
@@ -1209,32 +1285,17 @@ const clientGenerator = defineGenerator({
 		const meta = {
 			name: resolver.resolveName(node.operationId),
 			urlName: resolver.resolveUrlName(node),
-			file: resolver.resolveFile({
-				name: node.operationId,
-				extname: ".ts",
-				tag: node.tags[0] ?? "default",
-				path: node.path
-			}, {
+			file: resolver.resolveFile(operationFileEntry(node, node.operationId), {
 				root,
 				output,
 				group: group ?? void 0
 			}),
-			fileTs: tsResolver.resolveFile({
-				name: node.operationId,
-				extname: ".ts",
-				tag: node.tags[0] ?? "default",
-				path: node.path
-			}, {
+			fileTs: tsResolver.resolveFile(operationFileEntry(node, node.operationId), {
 				root,
 				output: pluginTs.options?.output ?? output,
 				group: pluginTs.options?.group ?? void 0
 			}),
-			fileZod: zodResolver && pluginZod?.options ? zodResolver.resolveFile({
-				name: node.operationId,
-				extname: ".ts",
-				tag: node.tags[0] ?? "default",
-				path: node.path
-			}, {
+			fileZod: zodResolver && pluginZod?.options ? zodResolver.resolveFile(operationFileEntry(node, node.operationId), {
 				root,
 				output: pluginZod.options.output ?? output,
 				group: pluginZod.options?.group ?? void 0
@@ -1428,6 +1489,7 @@ const groupedClientGenerator = defineGenerator({
 function Operations({ name, nodes }) {
 	const operationsObject = {};
 	nodes.forEach((node) => {
+		if (!ast.isHttpOperationNode(node)) return;
 		operationsObject[node.operationId] = {
 			path: new URLPath(node.path).URL,
 			method: node.method.toLowerCase()
@@ -1489,7 +1551,7 @@ const operationsGenerator = defineGenerator({
 			}),
 			children: /* @__PURE__ */ jsx(Operations, {
 				name,
-				nodes
+				nodes: nodes.filter(ast.isHttpOperationNode)
 			})
 		});
 	}
@@ -1498,6 +1560,7 @@ const operationsGenerator = defineGenerator({
 //#region src/components/StaticClassClient.tsx
 const declarationPrinter = functionPrinter({ mode: "declaration" });
 function generateMethod({ node, name, tsResolver, zodResolver, baseURL, dataReturnType, parser, paramsType, paramsCasing, pathParamsType }) {
+	if (!ast.isHttpOperationNode(node)) return "";
 	const path = new URLPath(node.path, { casing: paramsCasing });
 	const { defaultContentType: contentType, isMultipleContentTypes, hasFormData } = getContentTypeInfo(node);
 	const isFormData = !isMultipleContentTypes && contentType === "multipart/form-data";
@@ -1598,22 +1661,12 @@ const staticClassClientGenerator = defineGenerator({
 		const pluginZod = parser === "zod" ? driver.getPlugin(pluginZodName) : null;
 		const zodResolver = pluginZod ? driver.getResolver(pluginZodName) : null;
 		function buildOperationData(node) {
-			const typeFile = tsResolver.resolveFile({
-				name: node.operationId,
-				extname: ".ts",
-				tag: node.tags[0] ?? "default",
-				path: node.path
-			}, {
+			const typeFile = tsResolver.resolveFile(operationFileEntry(node, node.operationId), {
 				root,
 				output: tsPluginOptions?.output ?? output,
 				group: tsPluginOptions?.group
 			});
-			const zodFile = zodResolver && pluginZod?.options ? zodResolver.resolveFile({
-				name: node.operationId,
-				extname: ".ts",
-				tag: node.tags[0] ?? "default",
-				path: node.path
-			}, {
+			const zodFile = zodResolver && pluginZod?.options ? zodResolver.resolveFile(operationFileEntry(node, node.operationId), {
 				root,
 				output: pluginZod.options?.output ?? output,
 				group: pluginZod.options?.group ?? void 0
@@ -1628,6 +1681,7 @@ const staticClassClientGenerator = defineGenerator({
 			};
 		}
 		const controllers = nodes.reduce((acc, operationNode) => {
+			if (!ast.isHttpOperationNode(operationNode)) return acc;
 			const tag = operationNode.tags[0];
 			const groupName = tag ? group?.name?.({ group: camelCase(tag) }) ?? resolver.resolveGroupName(tag) : resolver.resolveGroupName("Client");
 			if (!tag && !group) {
@@ -1897,20 +1951,17 @@ const pluginClient = definePlugin((options) => {
 	const { output = {
 		path: "clients",
 		barrelType: "named"
-	}, group, exclude = [], include, override = [], urlType = false, dataReturnType = "data", paramsType = "inline", pathParamsType = paramsType === "object" ? "object" : options.pathParamsType || "inline", operations = false, paramsCasing, clientType = options.sdk ? "class" : "function", parser = "client", client = "axios", importPath, bundle = false, sdk, baseURL, resolver: userResolver, transformer: userTransformer } = options;
+	}, group, exclude = [], include, override = [], urlType = false, dataReturnType = "data", paramsType = "inline", pathParamsType = paramsType === "object" ? "object" : options.pathParamsType || "inline", operations = false, paramsCasing, clientType = options.sdk ? "class" : "function", parser = false, client = "axios", importPath, bundle = false, sdk, baseURL, resolver: userResolver, transformer: userTransformer } = options;
 	const resolvedImportPath = importPath ?? (!bundle ? `@kubb/plugin-client/clients/${client}` : void 0);
 	const selectedGenerators = options.generators ?? [
 		clientType === "staticClass" ? staticClassClientGenerator : clientType === "class" ? classClientGenerator : clientGenerator,
 		group && clientType === "function" ? groupedClientGenerator : null,
 		operations ? operationsGenerator : null
 	].filter((x) => Boolean(x));
-	const groupConfig = group ? {
-		...group,
-		name: group.name ? group.name : (ctx) => {
-			if (group.type === "path") return `${ctx.group.split("/")[1]}`;
-			return `${camelCase(ctx.group)}Controller`;
-		}
-	} : null;
+	const groupConfig = createGroupConfig(group, {
+		suffix: "Controller",
+		honorName: true
+	});
 	return {
 		name: pluginClientName,
 		options,