@kubb/plugin-ts 5.4.1 → 5.4.2

package/dist/index.js

@@ -963,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 }) => {
@@ -1314,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";
@@ -1331,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);
 }
 /**
@@ -1516,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)];
@@ -1923,7 +1933,7 @@ var compatibility = {
 	"node": ">=22.22"
 };
 // package.json
-var version = "5.4.1";
+var version = "5.4.2";
 // src/resolvers/resolverTs.ts
 /**
 * Default resolver used by `@kubb/plugin-ts`. Decides the names and file paths