@kubb/plugin-ts 5.0.0-beta.85 → 5.0.0-beta.87

package/dist/index.d.ts

@@ -2,7 +2,6 @@ import { n as __name } from "./rolldown-runtime-CNktS9qV.js";
 import { KubbReactNode } from "kubb/jsx";
 import { Exclude, Group, Include, Output, OutputOptions, Override, PluginFactoryOptions, Resolver, ResolverPatch, ast } from "kubb/kit";
 import ts from "typescript";
-
 //#region src/printers/printerTs.d.ts
 /**
  * Partial map of node-type overrides for the TypeScript printer.
@@ -525,7 +524,7 @@ declare const pluginTsName = "plugin-ts";
  * import { pluginTs } from '@kubb/plugin-ts'
  *
  * export default defineConfig({
- *   input: { path: './petStore.yaml' },
+ *   input: './petStore.yaml',
  *   output: { path: './src/gen' },
  *   plugins: [
  *     pluginTs({

package/dist/index.js

@@ -192,7 +192,7 @@ const reservedWords = /* @__PURE__ */ new Set([
 */
 function isValidVarName(name) {
 	if (!name || reservedWords.has(name)) return false;
-	return /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(name);
+	return isIdentifier(name);
 }
 /**
 * Returns `name` when it's a syntactically valid JavaScript variable name,
@@ -214,6 +214,22 @@ function ensureValidVarName(name) {
 	if (!name || isValidVarName(name)) return name;
 	return `_${name}`;
 }
+/**
+* Returns `true` when `name` is syntactically a valid identifier, ignoring reserved words.
+*
+* Reserved words and globals (`class`, `name`, `Date`, …) are valid as bare object-literal keys
+* even though they are not valid variable names, so use this (not {@link isValidVarName}) when
+* deciding whether an object key needs quoting.
+*
+* @example
+* ```ts
+* isIdentifier('name')   // true
+* isIdentifier('x-total')// false
+* ```
+*/
+function isIdentifier(name) {
+	return /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(name);
+}
 //#endregion
 //#region ../../internals/utils/src/strings.ts
 /**
@@ -526,7 +542,7 @@ function createInterfaceDeclaration({ modifiers, name, typeParameters, members }
 * Intelligently selects the syntax based on the type structure and attaches JSDoc comments.
 */
 function createTypeDeclaration({ syntax, isExportable, comments, name, type }) {
-	if (syntax === "interface" && "members" in type) return appendJSDocToNode({
+	if (syntax === "interface" && ts.isTypeLiteralNode(type)) return appendJSDocToNode({
 		node: createInterfaceDeclaration({
 			members: [...type.members],
 			modifiers: isExportable ? [modifiers.export] : [],
@@ -625,7 +641,7 @@ function createEnumDeclaration({ type = "enum", name, typeName, enums, enumKeyCa
 	}).filter((node) => node !== void 0)))];
 	if (type === "enum" || type === "constEnum") return [void 0, factory.createEnumDeclaration([factory.createToken(ts.SyntaxKind.ExportKeyword), type === "constEnum" ? factory.createToken(ts.SyntaxKind.ConstKeyword) : void 0].filter((modifier) => modifier !== void 0), factory.createIdentifier(typeName), enums.map(([key, value, description]) => {
 		let initializer = factory.createStringLiteral(value?.toString());
-		if (Number.parseInt(value.toString(), 10) === value && isNumber(Number.parseInt(value.toString(), 10))) if (value < 0) initializer = factory.createPrefixUnaryExpression(ts.SyntaxKind.MinusToken, factory.createNumericLiteral(Math.abs(value)));
+		if (Number.parseInt(value.toString(), 10) === value && isNumber(value)) if (value < 0) initializer = factory.createPrefixUnaryExpression(ts.SyntaxKind.MinusToken, factory.createNumericLiteral(Math.abs(value)));
 		else initializer = factory.createNumericLiteral(value);
 		if (typeof value === "boolean") initializer = value ? factory.createTrue() : factory.createFalse();
 		if (isNumber(Number.parseInt(key.toString(), 10))) {
@@ -900,13 +916,13 @@ function Enum({ node, enum: enumOptions, resolver }) {
 		isExportable: true,
 		isIndexable: true,
 		isTypeOnly: false,
-		children: parserTs.print(nameNode)
+		children: parserTs().print(nameNode)
 	}), /* @__PURE__ */ jsx(File.Source, {
 		name: typeName,
 		isIndexable: !namesMerge,
 		isExportable: !namesMerge && ENUM_TYPES_WITH_RUNTIME_VALUE.has(enumOptions.type),
 		isTypeOnly: ENUM_TYPES_WITH_TYPE_ONLY.has(enumOptions.type),
-		children: parserTs.print(typeNode)
+		children: parserTs().print(typeNode)
 	})] });
 }
 //#endregion
@@ -1007,6 +1023,24 @@ function getOperationParameters(node, options = {}) {
 	};
 }
 //#endregion
+//#region ../../internals/shared/src/adapter.ts
+/**
+* Narrows the generic `Adapter` from a generator context to the OpenAPI adapter,
+* so OAS-only options (`dateType`, `nameMapping`) and the parsed `document` are typed.
+*
+* Throws when a non-OAS adapter is configured, turning a silently wrong cast into a
+* clear, actionable error at the point of use.
+*
+* @example
+* ```ts
+* const { dateType } = getOasAdapter(ctx.adapter).options
+* ```
+*/
+function getOasAdapter(adapter) {
+	if (adapter.name !== "oas") throw new Error(`Expected the OpenAPI adapter (adapterOas), but received "${adapter.name}". Configure \`adapter: adapterOas()\` in your Kubb config.`);
+	return adapter;
+}
+//#endregion
 //#region ../../internals/shared/src/group.ts
 /**
 * Builds the `group` config a Kubb plugin passes to `ctx.setOptions`, applying the
@@ -1074,7 +1108,7 @@ function buildPropertyJSDocComments(schema, optional) {
 		!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" ? stringify(meta.default) : meta.default}` : 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 ${example}`),
 		meta && "primitive" in meta && meta.primitive ? [`@type ${meta.primitive}`, optional ?? isSchemaOptional(schema) ? " | undefined" : null].filter(Boolean).join("") : null
 	].filter(Boolean);
@@ -1385,7 +1419,7 @@ const printerTs = ast.createPrinter((options) => {
 			if (!name) {
 				const withNullable = meta.nullable ? createUnionDeclaration({ nodes: [transformed, keywordTypeNodes.null] }) : transformed;
 				const result = (meta.nullish || meta.optional) && addsUndefined ? createUnionDeclaration({ nodes: [withNullable, keywordTypeNodes.undefined] }) : withNullable;
-				return parserTs.print(result);
+				return parserTs().print(result);
 			}
 			const inner = (() => {
 				const omitted = keysToOmit?.length ? createOmitDeclaration({
@@ -1406,13 +1440,22 @@ const printerTs = ast.createPrinter((options) => {
 					description
 				})
 			});
-			return parserTs.print(typeNode);
+			return parserTs().print(typeNode);
 		}
 	};
 });
 //#endregion
 //#region src/generators/typeGenerator.tsx
 /**
+* Resolves the imported type name for a referenced schema. An enum schema emitted
+* as a `const` object imports its suffixed key alias (e.g. `StatusKey`); every other
+* schema imports its plain resolved name.
+*/
+function resolveImportName({ schemaName, enumOptions, enumSchemaNames, resolver }) {
+	if (ENUM_TYPES_WITH_KEY_SUFFIX.has(enumOptions.type) && enumOptions.typeSuffix && enumSchemaNames.has(schemaName)) return resolver.enum.keyName({ name: schemaName }, enumOptions.typeSuffix);
+	return resolver.name(schemaName);
+}
+/**
 * Built-in generator for `@kubb/plugin-ts`. Emits one TypeScript file per
 * schema in the spec plus per-operation request, response, and parameter
 * types. Drop-replace with a custom `Generator<PluginTs>` to change how
@@ -1426,12 +1469,13 @@ const typeGenerator = defineGenerator({
 		const { adapter, config, resolver, root } = ctx;
 		if (!node.name) return;
 		const enumSchemaNames = new Set(ctx.meta.enumNames);
-		function resolveImportName(schemaName) {
-			if (ENUM_TYPES_WITH_KEY_SUFFIX.has(enumOptions.type) && enumOptions.typeSuffix && enumSchemaNames.has(schemaName)) return resolver.enum.keyName({ name: schemaName }, enumOptions.typeSuffix);
-			return resolver.name(schemaName);
-		}
 		const imports = adapter.getImports(node, (schemaName) => ({
-			name: resolveImportName(schemaName),
+			name: resolveImportName({
+				schemaName,
+				enumOptions,
+				enumSchemaNames,
+				resolver
+			}),
 			path: resolver.file({
 				name: schemaName,
 				extname: ".ts",
@@ -1461,7 +1505,7 @@ const typeGenerator = defineGenerator({
 			description: node.description,
 			resolver,
 			enumSchemaNames,
-			nameMapping: adapter.options.nameMapping,
+			nameMapping: getOasAdapter(adapter).options.nameMapping,
 			nodes: printer?.nodes
 		});
 		return /* @__PURE__ */ jsxs(File, {
@@ -1516,14 +1560,15 @@ const typeGenerator = defineGenerator({
 			group: group ?? void 0
 		}) };
 		const enumSchemaNames = new Set(ctx.meta.enumNames);
-		function resolveImportName(schemaName) {
-			if (ENUM_TYPES_WITH_KEY_SUFFIX.has(enumOptions.type) && enumOptions.typeSuffix && enumSchemaNames.has(schemaName)) return resolver.enum.keyName({ name: schemaName }, enumOptions.typeSuffix);
-			return resolver.name(schemaName);
-		}
 		function renderSchemaType({ schema, name, keysToOmit }) {
 			if (!schema) return null;
 			const imports = adapter.getImports(schema, (schemaName) => ({
-				name: resolveImportName(schemaName),
+				name: resolveImportName({
+					schemaName,
+					enumOptions,
+					enumSchemaNames,
+					resolver
+				}),
 				path: resolver.file({
 					name: schemaName,
 					extname: ".ts",
@@ -1542,7 +1587,7 @@ const typeGenerator = defineGenerator({
 				keysToOmit,
 				resolver,
 				enumSchemaNames,
-				nameMapping: adapter.options.nameMapping,
+				nameMapping: getOasAdapter(adapter).options.nameMapping,
 				nodes: printer?.nodes
 			});
 			return /* @__PURE__ */ jsxs(Fragment, { children: [imports.map((imp) => /* @__PURE__ */ jsx(File.Import, {
@@ -1652,7 +1697,12 @@ const typeGenerator = defineGenerator({
 			const responseName = resolver.response.response(node);
 			const responsesWithSchema = node.responses.filter(hasSchema);
 			if (new Set(responsesWithSchema.flatMap((res) => (res.content ?? []).flatMap((entry) => entry.schema ? adapter.getImports(entry.schema, (schemaName) => ({
-				name: resolveImportName(schemaName),
+				name: resolveImportName({
+					schemaName,
+					enumOptions,
+					enumSchemaNames,
+					resolver
+				}),
 				path: ""
 			})).flatMap((imp) => Array.isArray(imp.name) ? imp.name : [imp.name]) : []))).has(responseName)) return null;
 			return renderSchemaType({
@@ -1778,7 +1828,7 @@ const pluginTsName = "plugin-ts";
 * import { pluginTs } from '@kubb/plugin-ts'
 *
 * export default defineConfig({
-*   input: { path: './petStore.yaml' },
+*   input: './petStore.yaml',
 *   output: { path: './src/gen' },
 *   plugins: [
 *     pluginTs({
@@ -2015,14 +2065,14 @@ function renderGroupType(type, sorted, transformType) {
 }
 function printParameter(node, options) {
 	const { mode, transformName, transformType } = options;
-	const isGroup = typeof node.name !== "string";
+	const bindingName = node.name;
 	if (mode === "call") {
-		if (isGroup) return `{ ${sortedGroupMembers(node.name, node.type).map((member) => renderBindingMember(member)).join(", ")} }`;
-		const name = transformName ? transformName(node.name) : node.name;
+		if (typeof bindingName !== "string") return `{ ${sortedGroupMembers(bindingName, node.type).map((member) => renderBindingMember(member)).join(", ")} }`;
+		const name = transformName ? transformName(bindingName) : bindingName;
 		return node.rest ? `...${name}` : name;
 	}
-	if (isGroup) {
-		const sorted = sortedGroupMembers(node.name, node.type);
+	if (typeof bindingName !== "string") {
+		const sorted = sortedGroupMembers(bindingName, node.type);
 		const binding = `{ ${sorted.map((member) => renderBindingMember(member, transformName)).join(", ")} }`;
 		const allOptional = sorted.every((member) => member.optional);
 		const type = renderGroupType(node.type, sorted, transformType);
@@ -2032,7 +2082,7 @@ function printParameter(node, options) {
 		}
 		return node.default ? `${binding} = ${node.default}` : binding;
 	}
-	const name = transformName ? transformName(node.name) : node.name;
+	const name = transformName ? transformName(bindingName) : bindingName;
 	const type = node.type ? renderType(node.type, transformType) : void 0;
 	if (node.rest) return type ? `...${name}: ${type}` : `...${name}`;
 	if (type) {