@kubb/plugin-ts 5.0.6 → 5.0.8

package/OVERVIEW.md

@@ -0,0 +1,17 @@
+# TypeScript
+
+Generates TypeScript types and interfaces from your OpenAPI spec. You get a type for every schema, plus the request, response, and parameter types of each operation.
+
+Most other Kubb plugins build on these types. The client, query, mock, and test plugins import them, so add this plugin first.
+
+## Setup
+
+No other plugins or packages are needed.
+
+## Options worth knowing
+
+- `enum.type` sets how enums are written: `asConst` (default), `enum`, `constEnum`, `literal`, or `inlineLiteral`. `enum.constCasing`, `enum.typeSuffix`, and `enum.keyCasing` tune the names.
+- `syntaxType` writes object schemas as `type` aliases (default) or `interface` declarations.
+- `optionalType` sets how optional properties are written: `questionToken` (default), `undefined`, or `questionTokenAndUndefined`.
+- `arrayType` writes arrays as `T[]` (default) or `Array<T>`.
+- `group` splits the output into folders by tag or path. It does not work with `output.mode: 'file'`.

package/dist/index.cjs

@@ -1850,6 +1850,15 @@ const typeGenerator = (0, kubb_kit.defineGenerator)({
 	}
 });
 //#endregion
+//#region kubb-extension.json
+var compatibility = {
+	"kubb": ">=5.8.0",
+	"node": ">=22"
+};
+//#endregion
+//#region package.json
+var version = "5.0.8";
+//#endregion
 //#region src/resolvers/resolverTs.ts
 /**
 * Default resolver used by `@kubb/plugin-ts`. Decides the names and file paths
@@ -1965,52 +1974,52 @@ function assertEnumLikeOptions({ prefix, options }) {
 * })
 * ```
 */
-const pluginTs = (0, kubb_kit.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 = (0, kubb_kit.definePlugin)({
+	meta: {
 		name: pluginTsName,
-		options,
-		hooks: { "kubb:plugin:setup"(ctx) {
-			assertEnumLikeOptions({
-				prefix: "",
-				options: {
-					enum: resolvedEnum,
-					syntaxType,
-					arrayType,
-					optionalType
-				}
-			});
-			for (const [index, entry] of override.entries()) assertEnumLikeOptions({
-				prefix: `override[${index}].options.`,
-				options: entry.options
-			});
-			ctx.setOptions({
-				output,
-				exclude,
-				include,
-				override,
-				optionalType,
-				group: groupConfig,
-				arrayType,
+		version,
+		compatibility
+	},
+	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 ? kubb_kit.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
+		});
+		(0, kubb_kit.setResolver)(userResolver ? kubb_kit.Resolver.merge(resolverTs, userResolver) : resolverTs);
+		if (userMacros?.length) (0, kubb_kit.setMacros)(userMacros);
+		(0, kubb_kit.addGenerator)(typeGenerator);
+		return {
+			output,
+			exclude,
+			include,
+			override,
+			optionalType,
+			group: createGroupConfig(group),
+			arrayType,
+			enum: resolvedEnum,
+			syntaxType,
+			printer
+		};
+	}
 });
 //#endregion
 //#region src/printers/functionParams.ts