@kubb/plugin-ts 5.0.0-beta.15 → 5.0.0-beta.25

package/dist/index.cjs

@@ -664,13 +664,13 @@ function Enum({ node, enumType, enumTypeSuffix, enumKeyCasing, resolver }) {
 		isExportable: true,
 		isIndexable: true,
 		isTypeOnly: false,
-		children: (0, _kubb_parser_ts.safePrint)(nameNode)
+		children: _kubb_parser_ts.parserTs.print(nameNode)
 	}), /* @__PURE__ */ (0, _kubb_renderer_jsx_jsx_runtime.jsx)(_kubb_renderer_jsx.File.Source, {
 		name: typeName,
 		isIndexable: true,
 		isExportable: ENUM_TYPES_WITH_RUNTIME_VALUE.has(enumType),
 		isTypeOnly: ENUM_TYPES_WITH_TYPE_ONLY.has(enumType),
-		children: (0, _kubb_parser_ts.safePrint)(typeNode)
+		children: _kubb_parser_ts.parserTs.print(typeNode)
 	})] });
 }
 //#endregion
@@ -733,14 +733,14 @@ function buildPropertyJSDocComments(schema) {
 	const meta = _kubb_core.ast.syncSchemaRef(schema);
 	const isArray = meta?.primitive === "array";
 	return [
-		meta && "description" in meta && meta.description ? `@description ${jsStringEscape(meta.description)}` : void 0,
-		meta && "deprecated" in meta && meta.deprecated ? "@deprecated" : void 0,
-		!isArray && meta && "min" in meta && meta.min !== void 0 ? `@minLength ${meta.min}` : void 0,
-		!isArray && meta && "max" in meta && meta.max !== void 0 ? `@maxLength ${meta.max}` : void 0,
-		meta && "pattern" in meta && meta.pattern ? `@pattern ${meta.pattern}` : void 0,
-		meta && "default" in meta && meta.default !== void 0 ? `@default ${"primitive" in meta && meta.primitive === "string" ? stringify(meta.default) : meta.default}` : void 0,
-		meta && "example" in meta && meta.example !== void 0 ? `@example ${meta.example}` : void 0,
-		meta && "primitive" in meta && meta.primitive ? [`@type ${meta.primitive}`, "optional" in schema && schema.optional ? " | undefined" : void 0].filter(Boolean).join("") : void 0
+		meta && "description" in meta && meta.description ? `@description ${jsStringEscape(meta.description)}` : null,
+		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" ? stringify(meta.default) : meta.default}` : null,
+		meta && "example" in meta && meta.example !== void 0 ? `@example ${meta.example}` : null,
+		meta && "primitive" in meta && meta.primitive ? [`@type ${meta.primitive}`, "optional" in schema && schema.optional ? " | undefined" : null].filter(Boolean).join("") : null
 	].filter(Boolean);
 }
 function buildParams(node, { params, resolver }) {
@@ -906,7 +906,7 @@ const printerTs = _kubb_core.ast.definePrinter((options) => {
 			date: dateOrStringNode,
 			time: dateOrStringNode,
 			ref(node) {
-				if (!node.name) return;
+				if (!node.name) return null;
 				const refName = node.ref ? _kubb_core.ast.extractRefName(node.ref) ?? node.name : node.name;
 				return createTypeReferenceNode(node.ref && ENUM_TYPES_WITH_KEY_SUFFIX.has(this.options.enumType) && this.options.enumTypeSuffix && this.options.enumSchemaNames?.has(refName) ? this.options.resolver.resolveEnumKeyName({ name: refName }, this.options.enumTypeSuffix) : node.ref ? this.options.resolver.default(refName, "type") : refName, void 0);
 			},
@@ -943,16 +943,16 @@ const printerTs = _kubb_core.ast.definePrinter((options) => {
 				return createIntersectionDeclaration({
 					withParentheses: true,
 					nodes: buildMemberNodes(node.members, this.transform)
-				}) ?? void 0;
+				}) ?? null;
 			},
 			array(node) {
 				return createArrayDeclaration({
 					nodes: (node.items ?? []).map((item) => this.transform(item)).filter(isNonNullable),
 					arrayType: this.options.arrayType
-				}) ?? void 0;
+				}) ?? null;
 			},
 			tuple(node) {
-				return buildTupleNode(node, this.transform);
+				return buildTupleNode(node, this.transform) ?? null;
 			},
 			object(node) {
 				const { transform, options } = this;
@@ -979,32 +979,34 @@ const printerTs = _kubb_core.ast.definePrinter((options) => {
 		},
 		print(node) {
 			const { name, syntaxType = "type", description, keysToOmit } = this.options;
-			let base = this.transform(node);
-			if (!base) return null;
+			const transformed = this.transform(node);
+			if (!transformed) return null;
 			const meta = _kubb_core.ast.syncSchemaRef(node);
 			if (!name) {
-				if (meta.nullable) base = createUnionDeclaration({ nodes: [base, keywordTypeNodes.null] });
-				if ((meta.nullish || meta.optional) && addsUndefined) base = createUnionDeclaration({ nodes: [base, keywordTypeNodes.undefined] });
-				return (0, _kubb_parser_ts.safePrint)(base);
+				const withNullable = meta.nullable ? createUnionDeclaration({ nodes: [transformed, keywordTypeNodes.null] }) : transformed;
+				const result = (meta.nullish || meta.optional) && addsUndefined ? createUnionDeclaration({ nodes: [withNullable, keywordTypeNodes.undefined] }) : withNullable;
+				return _kubb_parser_ts.parserTs.print(result);
 			}
-			let inner = keysToOmit?.length ? createOmitDeclaration({
-				keys: keysToOmit,
-				type: base,
-				nonNullable: true
-			}) : base;
-			if (meta.nullable) inner = createUnionDeclaration({ nodes: [inner, keywordTypeNodes.null] });
-			if (meta.nullish || meta.optional) inner = createUnionDeclaration({ nodes: [inner, keywordTypeNodes.undefined] });
-			const useTypeGeneration = syntaxType === "type" || inner.kind === syntaxKind.union || !!keysToOmit?.length;
-			return (0, _kubb_parser_ts.safePrint)(createTypeDeclaration({
+			const inner = (() => {
+				const omitted = keysToOmit?.length ? createOmitDeclaration({
+					keys: keysToOmit,
+					type: transformed,
+					nonNullable: true
+				}) : transformed;
+				const withNullable = meta.nullable ? createUnionDeclaration({ nodes: [omitted, keywordTypeNodes.null] }) : omitted;
+				return meta.nullish || meta.optional ? createUnionDeclaration({ nodes: [withNullable, keywordTypeNodes.undefined] }) : withNullable;
+			})();
+			const typeNode = createTypeDeclaration({
 				name,
 				isExportable: true,
 				type: inner,
-				syntax: useTypeGeneration ? "type" : "interface",
+				syntax: syntaxType === "type" || inner.kind === syntaxKind.union || !!keysToOmit?.length ? "type" : "interface",
 				comments: buildPropertyJSDocComments({
 					...meta,
 					description
 				})
-			}));
+			});
+			return _kubb_parser_ts.parserTs.print(typeNode);
 		}
 	};
 });
@@ -1023,15 +1025,21 @@ function getPerContentTypeName(dataName, suffix) {
 	if (dataName.endsWith("Data")) return suffix.endsWith("Data") ? dataName.slice(0, -4) + suffix : `${dataName.slice(0, -4)}${suffix}Data`;
 	return dataName + suffix;
 }
+/**
+* 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
+* TypeScript output is produced.
+*/
 const typeGenerator = (0, _kubb_core.defineGenerator)({
 	name: "typescript",
 	renderer: _kubb_renderer_jsx.jsxRendererSync,
 	schema(node, ctx) {
 		const { enumType, enumTypeSuffix, enumKeyCasing, syntaxType, optionalType, arrayType, output, group, printer } = ctx.options;
-		const { adapter, config, resolver, root, inputNode } = ctx;
+		const { adapter, config, resolver, root } = ctx;
 		if (!node.name) return;
 		const mode = ctx.getMode(output);
-		const enumSchemaNames = new Set(inputNode.schemas.filter((s) => _kubb_core.ast.narrowSchema(s, _kubb_core.ast.schemaTypes.enum) && s.name).map((s) => s.name));
+		const enumSchemaNames = new Set(ctx.meta.enumNames);
 		function resolveImportName(schemaName) {
 			if (ENUM_TYPES_WITH_KEY_SUFFIX.has(enumType) && enumTypeSuffix && enumSchemaNames.has(schemaName)) return resolver.resolveEnumKeyName({ name: schemaName }, enumTypeSuffix);
 			return resolver.resolveTypeName(schemaName);
@@ -1044,7 +1052,7 @@ const typeGenerator = (0, _kubb_core.defineGenerator)({
 			}, {
 				root,
 				output,
-				group
+				group: group ?? void 0
 			}).path
 		}));
 		const isEnumSchema = !!_kubb_core.ast.narrowSchema(node, _kubb_core.ast.schemaTypes.enum);
@@ -1056,7 +1064,7 @@ const typeGenerator = (0, _kubb_core.defineGenerator)({
 			}, {
 				root,
 				output,
-				group
+				group: group ?? void 0
 			})
 		};
 		const schemaPrinter = printerTs({
@@ -1075,11 +1083,11 @@ const typeGenerator = (0, _kubb_core.defineGenerator)({
 			baseName: meta.file.baseName,
 			path: meta.file.path,
 			meta: meta.file.meta,
-			banner: resolver.resolveBanner(inputNode, {
+			banner: resolver.resolveBanner(ctx.meta, {
 				output,
 				config
 			}),
-			footer: resolver.resolveFooter(inputNode, {
+			footer: resolver.resolveFooter(ctx.meta, {
 				output,
 				config
 			}),
@@ -1105,7 +1113,7 @@ const typeGenerator = (0, _kubb_core.defineGenerator)({
 	},
 	operation(node, ctx) {
 		const { enumType, enumTypeSuffix, enumKeyCasing, optionalType, arrayType, syntaxType, paramsCasing, group, output, printer } = ctx.options;
-		const { adapter, config, resolver, root, inputNode } = ctx;
+		const { adapter, config, resolver, root } = ctx;
 		const mode = ctx.getMode(output);
 		const params = _kubb_core.ast.caseParams(node.parameters, paramsCasing);
 		const meta = { file: resolver.resolveFile({
@@ -1116,9 +1124,9 @@ const typeGenerator = (0, _kubb_core.defineGenerator)({
 		}, {
 			root,
 			output,
-			group
+			group: group ?? void 0
 		}) };
-		const enumSchemaNames = new Set(inputNode.schemas.filter((s) => _kubb_core.ast.narrowSchema(s, _kubb_core.ast.schemaTypes.enum) && s.name).map((s) => s.name));
+		const enumSchemaNames = new Set(ctx.meta.enumNames);
 		function resolveImportName(schemaName) {
 			if (ENUM_TYPES_WITH_KEY_SUFFIX.has(enumType) && enumTypeSuffix && enumSchemaNames.has(schemaName)) return resolver.resolveEnumKeyName({ name: schemaName }, enumTypeSuffix);
 			return resolver.resolveTypeName(schemaName);
@@ -1133,7 +1141,7 @@ const typeGenerator = (0, _kubb_core.defineGenerator)({
 				}, {
 					root,
 					output,
-					group
+					group: group ?? void 0
 				}).path
 			}));
 			const schemaPrinter = printerTs({
@@ -1257,11 +1265,11 @@ const typeGenerator = (0, _kubb_core.defineGenerator)({
 			baseName: meta.file.baseName,
 			path: meta.file.path,
 			meta: meta.file.meta,
-			banner: resolver.resolveBanner(inputNode, {
+			banner: resolver.resolveBanner(ctx.meta, {
 				output,
 				config
 			}),
-			footer: resolver.resolveFooter(inputNode, {
+			footer: resolver.resolveFooter(ctx.meta, {
 				output,
 				config
 			}),
@@ -1279,20 +1287,21 @@ const typeGenerator = (0, _kubb_core.defineGenerator)({
 //#endregion
 //#region src/resolvers/resolverTs.ts
 /**
-* Resolver for `@kubb/plugin-ts` that provides the default naming and path-resolution
-* helpers used by the plugin. Import this in other plugins to resolve the exact names and
-* paths that `plugin-ts` generates without hardcoding the conventions.
+* Default resolver used by `@kubb/plugin-ts`. Decides the names and file paths
+* for every generated TypeScript type. Import this in other plugins that need
+* to reference the exact names `plugin-ts` produces without duplicating the
+* casing/file-layout rules.
 *
-* The `default` method is automatically injected by `defineResolver` — it uses `camelCase`
-* for identifiers/files and `pascalCase` for type names.
+* The `default` method is supplied by `defineResolver`. It uses PascalCase for
+* type names and PascalCase-with-isFile for files.
 *
-* @example
+* @example Resolve a type and file name
 * ```ts
-* import { resolver } from '@kubb/plugin-ts'
+* import { resolverTs } from '@kubb/plugin-ts'
 *
-* resolver.default('list pets', 'type')              // → 'ListPets'
-* resolver.resolveName('list pets status 200')        // → 'ListPetsStatus200'
-* resolver.resolvePathName('list pets', 'file')       // → 'listPets'
+* resolverTs.default('list pets', 'type')        // 'ListPets'
+* resolverTs.resolvePathName('list pets', 'file') // 'ListPets'
+* resolverTs.resolveResponseStatusName(node, 200) // 'ListPetsStatus200'
 * ```
 */
 const resolverTs = (0, _kubb_core.defineResolver)(() => {
@@ -1343,22 +1352,31 @@ const resolverTs = (0, _kubb_core.defineResolver)(() => {
 //#endregion
 //#region src/plugin.ts
 /**
-* Canonical plugin name for `@kubb/plugin-ts`, used to identify the plugin in driver lookups and warnings.
+* Canonical plugin name for `@kubb/plugin-ts`. Used for driver lookups and
+* cross-plugin dependency references.
 */
 const pluginTsName = "plugin-ts";
 /**
-* The `@kubb/plugin-ts` plugin factory.
-*
-* Generates TypeScript type declarations from an OpenAPI/AST `RootNode`.
-* Walks schemas and operations, delegates rendering to the active generators,
-* and writes barrel files based on `output.barrelType`.
+* Generates TypeScript `type` aliases and `interface` declarations from an
+* OpenAPI spec. The foundation that every other Kubb plugin builds on:
+* clients, query hooks, mocks, and validators all reference the names this
+* plugin produces.
 *
 * @example
 * ```ts
-* import pluginTs from '@kubb/plugin-ts'
+* import { defineConfig } from 'kubb'
+* import { pluginTs } from '@kubb/plugin-ts'
 *
 * export default defineConfig({
-*   plugins: [pluginTs({ output: { path: 'types' }, enumType: 'asConst' })],
+*   input: { path: './petStore.yaml' },
+*   output: { path: './src/gen' },
+*   plugins: [
+*     pluginTs({
+*       output: { path: './types' },
+*       enumType: 'asConst',
+*       optionalType: 'questionTokenAndUndefined',
+*     }),
+*   ],
 * })
 * ```
 */
@@ -1373,7 +1391,7 @@ const pluginTs = (0, _kubb_core.definePlugin)((options) => {
 			if (group.type === "path") return `${ctx.group.split("/")[1]}`;
 			return `${camelCase(ctx.group)}Controller`;
 		}
-	} : void 0;
+	} : null;
 	return {
 		name: pluginTsName,
 		options,