@kubb/plugin-ts 5.4.0 → 5.4.2

package/dist/index.js

@@ -879,6 +879,22 @@ function resolveContentTypeVariants(entries, baseName) {
 }
 const operationParameterGroupsByNode = /* @__PURE__ */ new WeakMap();
 /**
+* An OpenAPI 3.2 `querystring` parameter is the whole query string, so a form-encoded object becomes one query parameter
+* per property, typed and serialized like any other.
+* Another content type, such as JSON, stays one parameter named after it, and the runtime sends its value as the whole query string.
+*/
+function spreadQuerystring(param) {
+	const schema = param.schema.type === "ref" ? param.schema.schema : param.schema;
+	const formEncoded = !param.contentType || param.contentType.split(";")[0].trim().toLowerCase() === "application/x-www-form-urlencoded";
+	if (schema?.type !== "object" || !formEncoded) return [param];
+	return schema.properties.map((property) => ast.factory.createParameter({
+		name: property.name,
+		in: "query",
+		schema: property.schema,
+		required: param.required && property.required
+	}));
+}
+/**
 * Groups an operation's parameters by location (`path`/`query`/`header`/`cookie`), deduping each
 * group by name. Every plugin generator visiting the same `OperationNode` shares one AST instance
 * (see `KubbDriver`), so the result is cached per node to avoid re-filtering and re-deduping the
@@ -887,17 +903,18 @@ const operationParameterGroupsByNode = /* @__PURE__ */ new WeakMap();
 function getOperationParameters(node) {
 	const cached = operationParameterGroupsByNode.get(node);
 	if (cached) return cached;
-	const group = (location) => {
+	const dedupe = (params) => {
 		const seen = /* @__PURE__ */ new Set();
-		return node.parameters.filter((param) => {
-			if (param.in !== location || seen.has(param.name)) return false;
+		return params.filter((param) => {
+			if (seen.has(param.name)) return false;
 			seen.add(param.name);
 			return true;
 		});
 	};
+	const group = (location) => dedupe(node.parameters.filter((param) => param.in === location));
 	const groups = {
 		path: group("path"),
-		query: group("query"),
+		query: dedupe([...group("query"), ...group("querystring").flatMap(spreadQuerystring)]),
 		header: group("header"),
 		cookie: group("cookie")
 	};
@@ -946,7 +963,7 @@ function buildOptionsSchema(node, resolver, { pairContentTypes = false } = {}) {
 		properties: [
 			ast.factory.createProperty({
 				name: "body",
-				required: hasBody,
+				required: hasBody && node.requestBody?.required === true,
 				schema: body
 			}),
 			...groups.map(({ name, params, resolve }) => {
@@ -1297,6 +1314,14 @@ function formatExample(value) {
 	if (value === null || typeof value !== "object") return String(value);
 	return (JSON.stringify(value) ?? String(value)).replaceAll("*/", "*\\/");
 }
+/**
+* Whether a schema is binary, or an array of binary items, so its TypeScript type is `Blob` or `Blob[]`.
+*/
+function isBinarySchema(schema) {
+	const meta = syncSchemaRef(schema);
+	const isBlob = (node) => syncSchemaRef(node)?.type === "blob";
+	return !!meta && (isBlob(meta) || meta.type === "array" && "items" in meta && (meta.items ?? []).some(isBlob));
+}
 function buildPropertyJSDocComments(schema, optional) {
 	const meta = syncSchemaRef(schema);
 	const isArray = meta?.primitive === "array";
@@ -1314,7 +1339,7 @@ function buildPropertyJSDocComments(schema, optional) {
 		meta && "default" in meta && meta.default !== void 0 ? `@default ${"primitive" in meta && meta.primitive === "string" && typeof meta.default === "string" ? stringify(meta.default) : formatExample(meta.default)}` : null,
 		...exampleValues.map((example) => `@example ${formatExample(example)}`)
 	].filter(Boolean);
-	const typeTag = comments.length && meta && "primitive" in meta && meta.primitive ? [`@type ${meta.primitive}`, optional ?? isSchemaOptional(schema) ? " | undefined" : null].filter(Boolean).join("") : null;
+	const typeTag = comments.length && !isBinarySchema(schema) && meta && "primitive" in meta && meta.primitive ? [`@type ${meta.primitive}`, optional ?? isSchemaOptional(schema) ? " | undefined" : null].filter(Boolean).join("") : null;
 	return [...comments, typeTag].filter(Boolean);
 }
 /**
@@ -1499,14 +1524,16 @@ const printerTs = ast.createPrinter((options) => {
 					const optional = !property.required || !!property.schema.optional || !!property.schema.nullish;
 					const type = buildPropertyType(property.schema, baseType, options.optionalType, optional);
 					const propMeta = syncSchemaRef(property.schema);
+					const propertyNode = createPropertySignature({
+						questionToken: optional ? addsQuestionToken : false,
+						name,
+						type,
+						readOnly: propMeta?.readOnly
+					});
+					const binaryRemark = isBinarySchema(property.schema) ? "@remarks Pass a `File` to send its filename. A plain `Blob` is sent with the filename `blob`." : void 0;
 					return appendJSDocToNode({
-						node: createPropertySignature({
-							questionToken: optional ? addsQuestionToken : false,
-							name,
-							type,
-							readOnly: propMeta?.readOnly
-						}),
-						comments: buildPropertyJSDocComments(property.schema, optional)
+						node: propertyNode,
+						comments: [...buildPropertyJSDocComments(property.schema, optional), binaryRemark]
 					});
 				});
 				const allElements = [...propertyNodes, ...buildIndexSignatures(node, propertyNodes.length, transform)];
@@ -1902,11 +1929,11 @@ const typeGenerator = defineGenerator({
 });
 // kubb-extension.json
 var compatibility = {
-	"kubb": ">=5.14.6",
+	"kubb": ">=5.16.0",
 	"node": ">=22.22"
 };
 // package.json
-var version = "5.4.0";
+var version = "5.4.2";
 // src/resolvers/resolverTs.ts
 /**
 * Default resolver used by `@kubb/plugin-ts`. Decides the names and file paths