@kubb/plugin-ts 5.0.5 → 5.0.7

package/dist/index.d.ts

@@ -298,7 +298,6 @@ type EnumOptions$1 = {
    * site (`'inlineLiteral'`).
    *
    * @default 'asConst'
-   * @note In Kubb v5, 'inlineLiteral' becomes the default.
    */
   type?: 'literal' | 'inlineLiteral';
   /**
@@ -512,7 +511,7 @@ export declare const pluginTsName = "plugin-ts";
  * })
  * ```
  */
-export declare const pluginTs: (options?: Options | undefined) => import("kubb/kit").Plugin<PluginTs>;
+export declare const pluginTs: import("kubb/kit").PluginFactory<PluginTs>;
 //#endregion
 //#region src/printers/functionParams.d.ts
 /**

package/dist/index.js

@@ -2,7 +2,7 @@ import { n as __name, t as __exportAll } from "./rolldown-runtime-CthDji9g.js";
 import { createRequire } from "node:module";
 import { parserTs } from "@kubb/parser-ts";
 import { File, jsxRenderer } from "kubb/jsx";
-import { Resolver, ast, createResolver, defineGenerator, definePlugin, isStringType, syncSchemaRef } from "kubb/kit";
+import { Resolver, addGenerator, assertPluginOption, ast, createResolver, defineGenerator, definePlugin, isStringType, setMacros, setResolver, syncSchemaRef } from "kubb/kit";
 import { Fragment, jsx, jsxs } from "kubb/jsx/jsx-runtime";
 //#region ../../internals/utils/src/casing.ts
 /**
@@ -1317,7 +1317,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" && typeof meta.default === "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) : 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;
@@ -1831,6 +1831,9 @@ const typeGenerator = defineGenerator({
 	}
 });
 //#endregion
+//#region package.json
+var version = "5.0.7";
+//#endregion
 //#region src/resolvers/resolverTs.ts
 /**
 * Default resolver used by `@kubb/plugin-ts`. Decides the names and file paths
@@ -1875,6 +1878,53 @@ const resolverTs = createResolver({
 * cross-plugin dependency references.
 */
 const pluginTsName = "plugin-ts";
+const allowedEnumTypes = [
+	"asConst",
+	"enum",
+	"constEnum",
+	"literal",
+	"inlineLiteral"
+];
+const allowedSyntaxTypes = ["type", "interface"];
+const allowedArrayTypes = ["array", "generic"];
+const allowedOptionalTypes = [
+	"questionToken",
+	"undefined",
+	"questionTokenAndUndefined"
+];
+/**
+* Throws when an enum-like option holds a value outside its allowed set. Options left out are skipped.
+*/
+function assertEnumLikeOptions({ prefix, options }) {
+	const checks = [
+		{
+			option: "enum.type",
+			value: options.enum?.type,
+			allowed: allowedEnumTypes
+		},
+		{
+			option: "syntaxType",
+			value: options.syntaxType,
+			allowed: allowedSyntaxTypes
+		},
+		{
+			option: "arrayType",
+			value: options.arrayType,
+			allowed: allowedArrayTypes
+		},
+		{
+			option: "optionalType",
+			value: options.optionalType,
+			allowed: allowedOptionalTypes
+		}
+	];
+	for (const { option, value, allowed } of checks) if (value !== void 0) assertPluginOption({
+		plugin: pluginTsName,
+		option: `${prefix}${option}`,
+		value,
+		allowed
+	});
+}
 /**
 * Generates TypeScript `type` aliases and `interface` declarations from an
 * OpenAPI spec. The foundation that every other Kubb plugin builds on:
@@ -1899,39 +1949,52 @@ const pluginTsName = "plugin-ts";
 * })
 * ```
 */
-const pluginTs = definePlugin((options) => {
-	const { output = {
-		path: "types",
-		barrel: { type: "named" }
-	}, group, exclude = [], include, override = [], enum: enumOptions = {}, optionalType = "questionToken", arrayType = "array", syntaxType = "type", printer, resolver: userResolver, macros: userMacros } = options;
-	const groupConfig = createGroupConfig(group);
-	const resolvedEnum = {
-		type: enumOptions.type ?? "asConst",
-		constCasing: enumOptions.constCasing ?? "camelCase",
-		typeSuffix: enumOptions.typeSuffix ?? "Key",
-		keyCasing: enumOptions.keyCasing ?? "none"
-	};
-	return {
+const pluginTs = definePlugin({
+	meta: {
 		name: pluginTsName,
-		options,
-		hooks: { "kubb:plugin:setup"(ctx) {
-			ctx.setOptions({
-				output,
-				exclude,
-				include,
-				override,
-				optionalType,
-				group: groupConfig,
-				arrayType,
+		version,
+		compatibility: { kubb: ">=5.8.0" }
+	},
+	setup(options) {
+		const { output = {
+			path: "types",
+			barrel: { type: "named" }
+		}, group, exclude = [], include, override = [], enum: enumOptions = {}, optionalType = "questionToken", arrayType = "array", syntaxType = "type", printer, resolver: userResolver, macros: userMacros } = options;
+		const resolvedEnum = {
+			type: enumOptions.type ?? "asConst",
+			constCasing: enumOptions.constCasing ?? "camelCase",
+			typeSuffix: enumOptions.typeSuffix ?? "Key",
+			keyCasing: enumOptions.keyCasing ?? "none"
+		};
+		assertEnumLikeOptions({
+			prefix: "",
+			options: {
 				enum: resolvedEnum,
 				syntaxType,
-				printer
-			});
-			ctx.setResolver(userResolver ? Resolver.merge(resolverTs, userResolver) : resolverTs);
-			if (userMacros?.length) ctx.setMacros(userMacros);
-			ctx.addGenerator(typeGenerator);
-		} }
-	};
+				arrayType,
+				optionalType
+			}
+		});
+		for (const [index, entry] of override.entries()) assertEnumLikeOptions({
+			prefix: `override[${index}].options.`,
+			options: entry.options
+		});
+		setResolver(userResolver ? Resolver.merge(resolverTs, userResolver) : resolverTs);
+		if (userMacros?.length) setMacros(userMacros);
+		addGenerator(typeGenerator);
+		return {
+			output,
+			exclude,
+			include,
+			override,
+			optionalType,
+			group: createGroupConfig(group),
+			arrayType,
+			enum: resolvedEnum,
+			syntaxType,
+			printer
+		};
+	}
 });
 //#endregion
 //#region src/printers/functionParams.ts