@kubb/plugin-ts 5.0.0 → 5.0.1

package/dist/index.js

@@ -911,6 +911,115 @@ function Enum({ node, enum: enumOptions, resolver }) {
 	})] });
 }
 //#endregion
+//#region src/utils.ts
+/**
+* Tells whether a `const` (single-value enum) should render as a bare literal type (`'active'`)
+* rather than a named enum reference or a runtime enum declaration.
+*
+* The parser folds `const` into a single-value enum node. The adapter decides which schemas are
+* named enums and lists them in `enumSchemaNames`, and references to those names get suffixed (for
+* example `StatusKey`). A const renders as a literal only when the adapter has not registered it as
+* a named enum, which keeps the declaration and its references in sync across adapter versions.
+*/
+function isInlineConstEnum(node, enumSchemaNames) {
+	return (node.namedEnumValues ?? node.enumValues ?? []).length === 1 && !(node.name && enumSchemaNames?.has(node.name));
+}
+/**
+* Collects JSDoc annotation strings for a schema node.
+*
+* Only uses official JSDoc tags from https://jsdoc.app/: `@description`, `@deprecated`, `@default`, `@example`, `@type`.
+* Constraint metadata (min/max length, pattern, multipleOf, min/maxProperties) is emitted as plain-text lines.
+
+*/
+function isSchemaOptional(schema) {
+	return Boolean("optional" in schema && schema.optional || "nullish" in schema && schema.nullish);
+}
+function formatExample(value) {
+	if (value === null || typeof value !== "object") return String(value);
+	return (JSON.stringify(value) ?? String(value)).replaceAll("*/", "*\\/");
+}
+function buildPropertyJSDocComments(schema, optional) {
+	const meta = syncSchemaRef(schema);
+	const isArray = meta?.primitive === "array";
+	const hasDescription = meta && "description" in meta && meta.description;
+	const formatComment = meta && "format" in meta && meta.format ? hasDescription ? [" ", `Format: \`${meta.format}\``] : ["@description", `Format: \`${meta.format}\``] : [];
+	const exampleValues = meta?.examples ?? [];
+	const comments = [
+		hasDescription ? `@description ${jsStringEscape(meta.description)}` : null,
+		...formatComment,
+		meta && "deprecated" in meta && meta.deprecated ? "@deprecated" : null,
+		!isArray && meta && "min" in meta && meta.min !== void 0 ? `@minLength ${meta.min}` : null,
+		!isArray && meta && "max" in meta && meta.max !== void 0 ? `@maxLength ${meta.max}` : null,
+		meta && "pattern" in meta && meta.pattern ? `@pattern ${meta.pattern}` : null,
+		meta && "default" in meta && meta.default !== void 0 ? `@default ${"primitive" in meta && meta.primitive === "string" && typeof meta.default === "string" ? stringify(meta.default) : 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;
+	return [...comments, typeTag].filter(Boolean);
+}
+/**
+* Builds the object schema for a group of parameters sharing one `in` location (path, query, or
+* header), embedding each param's own schema (and JSDoc) directly rather than referencing a
+* separate per-param type — the group itself is the only type these params get exported as.
+*/
+function buildParams({ params }) {
+	return ast.factory.createSchema({
+		type: "object",
+		properties: params.map((param) => ast.factory.createProperty({
+			name: param.name,
+			required: param.required,
+			schema: ast.factory.createSchema({
+				...param.schema,
+				optional: !param.required
+			})
+		}))
+	});
+}
+function buildResponseUnion(node, { resolver }) {
+	const responsesWithSchema = node.responses.filter((res) => res.content?.some((entry) => entry.schema));
+	if (responsesWithSchema.length === 0) return null;
+	return ast.factory.createSchema({
+		type: "union",
+		members: responsesWithSchema.map((res) => ast.factory.createSchema({
+			type: "ref",
+			name: resolver.response.status(node, res.statusCode)
+		}))
+	});
+}
+//#endregion
+//#region src/components/Type.tsx
+function Type({ name, node, printer, enum: enumOptions, resolver }) {
+	const enumSchemaNodes = ast.collectSync(node, { schema(n) {
+		const enumNode = ast.narrowSchema(n, ast.schemaTypes.enum);
+		if (enumNode?.name && !isInlineConstEnum(enumNode, printer.options.enumSchemaNames)) return enumNode;
+	} });
+	const output = printer.print(node);
+	if (!output) return;
+	const enums = [...new Map(enumSchemaNodes.map((n) => [n.name, n])).values()].map((node) => {
+		return {
+			node,
+			...getEnumNames({
+				node,
+				enum: enumOptions,
+				resolver
+			})
+		};
+	});
+	const shouldExportEnums = enumOptions.type !== "inlineLiteral";
+	const shouldExportType = enumOptions.type === "inlineLiteral" || enums.every((item) => item.typeName !== name);
+	return /* @__PURE__ */ jsxs(Fragment, { children: [shouldExportEnums && enums.map(({ node }) => /* @__PURE__ */ jsx(Enum, {
+		node,
+		enum: enumOptions,
+		resolver
+	}, node.name)), shouldExportType && /* @__PURE__ */ jsx(File.Source, {
+		name,
+		isTypeOnly: true,
+		isExportable: true,
+		isIndexable: true,
+		children: output
+	})] });
+}
+//#endregion
 //#region ../../internals/shared/src/params.ts
 /**
 * Drops parameters that share the same name, keeping the first.
@@ -1054,6 +1163,62 @@ function buildOptionsSchema(node, resolver) {
 		})]
 	});
 }
+/**
+* The schema a status occupies in the `<Name>Responses` record. A status that documents several
+* content types becomes a `{ contentType; data }` union so the runtime can surface the negotiated type
+* on `result.parsed`, while the standalone `<Name>StatusNNN` alias stays the plain body union that the
+* query hooks and `result.data` use.
+*/
+function buildResponseRecordEntry(node, res, resolver) {
+	const statusName = resolver.response.status(node, res.statusCode);
+	const variants = (res.content ?? []).filter((entry) => entry.schema);
+	if (variants.length <= 1) return ast.factory.createSchema({
+		type: "ref",
+		name: statusName
+	});
+	return ast.factory.createSchema({
+		type: "union",
+		members: resolveContentTypeVariants(variants, statusName).map((variant) => ast.factory.createSchema({
+			type: "object",
+			primitive: "object",
+			properties: [ast.factory.createProperty({
+				name: "contentType",
+				required: true,
+				schema: ast.factory.createSchema({
+					type: "enum",
+					enumValues: [variant.contentType]
+				})
+			}), ast.factory.createProperty({
+				name: "data",
+				required: true,
+				schema: ast.factory.createSchema({
+					type: "ref",
+					name: variant.name
+				})
+			})]
+		}))
+	});
+}
+/**
+* Builds the per-status `<Name>Responses` record for an operation, referencing the already-resolved
+* `<Name>StatusNNN` names. Shared by `@kubb/plugin-ts`'s `Responses` type and `@kubb/plugin-zod`'s
+* inferred responses schema, so both emit the same shape from the same inputs.
+*
+* Always emits the keyed record, even when an operation declares no responses. An operation with no
+* responses renders as an empty object, which keeps every consumer's import (for example the axios
+* SDK's `RequestResult<XResponses>`) resolvable instead of pointing at a missing export.
+*/
+function buildResponses(node, resolver) {
+	return ast.factory.createSchema({
+		type: "object",
+		primitive: "object",
+		properties: node.responses.map((res) => ast.factory.createProperty({
+			name: String(res.statusCode),
+			required: true,
+			schema: buildResponseRecordEntry(node, res, resolver)
+		}))
+	});
+}
 //#endregion
 //#region ../../internals/shared/src/resolver.ts
 /**
@@ -1204,160 +1369,6 @@ function mapSchemaItems(node, transform) {
 	}));
 }
 //#endregion
-//#region src/utils.ts
-/**
-* Tells whether a `const` (single-value enum) should render as a bare literal type (`'active'`)
-* rather than a named enum reference or a runtime enum declaration.
-*
-* The parser folds `const` into a single-value enum node. The adapter decides which schemas are
-* named enums and lists them in `enumSchemaNames`, and references to those names get suffixed (for
-* example `StatusKey`). A const renders as a literal only when the adapter has not registered it as
-* a named enum, which keeps the declaration and its references in sync across adapter versions.
-*/
-function isInlineConstEnum(node, enumSchemaNames) {
-	return (node.namedEnumValues ?? node.enumValues ?? []).length === 1 && !(node.name && enumSchemaNames?.has(node.name));
-}
-/**
-* Collects JSDoc annotation strings for a schema node.
-*
-* Only uses official JSDoc tags from https://jsdoc.app/: `@description`, `@deprecated`, `@default`, `@example`, `@type`.
-* Constraint metadata (min/max length, pattern, multipleOf, min/maxProperties) is emitted as plain-text lines.
-
-*/
-function isSchemaOptional(schema) {
-	return Boolean("optional" in schema && schema.optional || "nullish" in schema && schema.nullish);
-}
-function formatExample(value) {
-	if (value === null || typeof value !== "object") return String(value);
-	return (JSON.stringify(value) ?? String(value)).replaceAll("*/", "*\\/");
-}
-function buildPropertyJSDocComments(schema, optional) {
-	const meta = syncSchemaRef(schema);
-	const isArray = meta?.primitive === "array";
-	const hasDescription = meta && "description" in meta && meta.description;
-	const formatComment = meta && "format" in meta && meta.format ? hasDescription ? [" ", `Format: \`${meta.format}\``] : ["@description", `Format: \`${meta.format}\``] : [];
-	const exampleValues = meta?.examples ?? [];
-	const comments = [
-		hasDescription ? `@description ${jsStringEscape(meta.description)}` : null,
-		...formatComment,
-		meta && "deprecated" in meta && meta.deprecated ? "@deprecated" : null,
-		!isArray && meta && "min" in meta && meta.min !== void 0 ? `@minLength ${meta.min}` : null,
-		!isArray && meta && "max" in meta && meta.max !== void 0 ? `@maxLength ${meta.max}` : null,
-		meta && "pattern" in meta && meta.pattern ? `@pattern ${meta.pattern}` : null,
-		meta && "default" in meta && meta.default !== void 0 ? `@default ${"primitive" in meta && meta.primitive === "string" && typeof meta.default === "string" ? stringify(meta.default) : 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;
-	return [...comments, typeTag].filter(Boolean);
-}
-/**
-* Builds the object schema for a group of parameters sharing one `in` location (path, query, or
-* header), embedding each param's own schema (and JSDoc) directly rather than referencing a
-* separate per-param type — the group itself is the only type these params get exported as.
-*/
-function buildParams({ params }) {
-	return ast.factory.createSchema({
-		type: "object",
-		properties: params.map((param) => ast.factory.createProperty({
-			name: param.name,
-			required: param.required,
-			schema: ast.factory.createSchema({
-				...param.schema,
-				optional: !param.required
-			})
-		}))
-	});
-}
-/**
-* The schema a status occupies in the `<Name>Responses` record. A status that documents several
-* content types becomes a `{ contentType; data }` union so the runtime can surface the negotiated type
-* on `result.parsed`, while the standalone `<Name>StatusNNN` alias stays the plain body union that the
-* query hooks and `result.data` use.
-*/
-function buildResponseRecordEntry(node, res, resolver) {
-	const statusName = resolver.response.status(node, res.statusCode);
-	const variants = (res.content ?? []).filter((entry) => entry.schema);
-	if (variants.length <= 1) return ast.factory.createSchema({
-		type: "ref",
-		name: statusName
-	});
-	return ast.factory.createSchema({
-		type: "union",
-		members: resolveContentTypeVariants(variants, statusName).map((variant) => ast.factory.createSchema({
-			type: "object",
-			properties: [ast.factory.createProperty({
-				name: "contentType",
-				required: true,
-				schema: ast.factory.createSchema({
-					type: "enum",
-					enumValues: [variant.contentType]
-				})
-			}), ast.factory.createProperty({
-				name: "data",
-				required: true,
-				schema: ast.factory.createSchema({
-					type: "ref",
-					name: variant.name
-				})
-			})]
-		}))
-	});
-}
-function buildResponses(node, { resolver }) {
-	return ast.factory.createSchema({
-		type: "object",
-		properties: node.responses.map((res) => ast.factory.createProperty({
-			name: String(res.statusCode),
-			required: true,
-			schema: buildResponseRecordEntry(node, res, resolver)
-		}))
-	});
-}
-function buildResponseUnion(node, { resolver }) {
-	const responsesWithSchema = node.responses.filter((res) => res.content?.some((entry) => entry.schema));
-	if (responsesWithSchema.length === 0) return null;
-	return ast.factory.createSchema({
-		type: "union",
-		members: responsesWithSchema.map((res) => ast.factory.createSchema({
-			type: "ref",
-			name: resolver.response.status(node, res.statusCode)
-		}))
-	});
-}
-//#endregion
-//#region src/components/Type.tsx
-function Type({ name, node, printer, enum: enumOptions, resolver }) {
-	const enumSchemaNodes = ast.collectSync(node, { schema(n) {
-		const enumNode = ast.narrowSchema(n, ast.schemaTypes.enum);
-		if (enumNode?.name && !isInlineConstEnum(enumNode, printer.options.enumSchemaNames)) return enumNode;
-	} });
-	const output = printer.print(node);
-	if (!output) return;
-	const enums = [...new Map(enumSchemaNodes.map((n) => [n.name, n])).values()].map((node) => {
-		return {
-			node,
-			...getEnumNames({
-				node,
-				enum: enumOptions,
-				resolver
-			})
-		};
-	});
-	const shouldExportEnums = enumOptions.type !== "inlineLiteral";
-	const shouldExportType = enumOptions.type === "inlineLiteral" || enums.every((item) => item.typeName !== name);
-	return /* @__PURE__ */ jsxs(Fragment, { children: [shouldExportEnums && enums.map(({ node }) => /* @__PURE__ */ jsx(Enum, {
-		node,
-		enum: enumOptions,
-		resolver
-	}, node.name)), shouldExportType && /* @__PURE__ */ jsx(File.Source, {
-		name,
-		isTypeOnly: true,
-		isExportable: true,
-		isIndexable: true,
-		children: output
-	})] });
-}
-//#endregion
 //#region src/printers/printerTs.ts
 const { isNonNullable } = factory_exports;
 /**
@@ -1751,7 +1762,7 @@ const typeGenerator = defineGenerator({
 			name: resolver.response.options(node)
 		});
 		const responsesType = renderSchemaType({
-			schema: buildResponses(node, { resolver }),
+			schema: buildResponses(node, resolver),
 			name: resolver.response.responses(node)
 		});
 		function buildResponseType() {