@kubb/plugin-zod 5.0.0-beta.22 → 5.0.0-beta.27

package/dist/index.cjs

@@ -136,6 +136,129 @@ function toRegExpString(text, func = "RegExp") {
 	return `new ${func}(${JSON.stringify(source)}${flags ? `, ${JSON.stringify(flags)}` : ""})`;
 }
 //#endregion
+//#region ../../internals/utils/src/reserved.ts
+/**
+* JavaScript and Java reserved words.
+* @link https://github.com/jonschlinkert/reserved/blob/master/index.js
+*/
+const reservedWords = new Set([
+	"abstract",
+	"arguments",
+	"boolean",
+	"break",
+	"byte",
+	"case",
+	"catch",
+	"char",
+	"class",
+	"const",
+	"continue",
+	"debugger",
+	"default",
+	"delete",
+	"do",
+	"double",
+	"else",
+	"enum",
+	"eval",
+	"export",
+	"extends",
+	"false",
+	"final",
+	"finally",
+	"float",
+	"for",
+	"function",
+	"goto",
+	"if",
+	"implements",
+	"import",
+	"in",
+	"instanceof",
+	"int",
+	"interface",
+	"let",
+	"long",
+	"native",
+	"new",
+	"null",
+	"package",
+	"private",
+	"protected",
+	"public",
+	"return",
+	"short",
+	"static",
+	"super",
+	"switch",
+	"synchronized",
+	"this",
+	"throw",
+	"throws",
+	"transient",
+	"true",
+	"try",
+	"typeof",
+	"var",
+	"void",
+	"volatile",
+	"while",
+	"with",
+	"yield",
+	"Array",
+	"Date",
+	"hasOwnProperty",
+	"Infinity",
+	"isFinite",
+	"isNaN",
+	"isPrototypeOf",
+	"length",
+	"Math",
+	"name",
+	"NaN",
+	"Number",
+	"Object",
+	"prototype",
+	"String",
+	"toString",
+	"undefined",
+	"valueOf"
+]);
+/**
+* Returns `true` when `name` is a syntactically valid JavaScript variable name.
+*
+* @example
+* ```ts
+* isValidVarName('status')  // true
+* isValidVarName('class')   // false (reserved word)
+* isValidVarName('42foo')   // false (starts with digit)
+* ```
+*/
+function isValidVarName(name) {
+	if (!name || reservedWords.has(name)) return false;
+	return /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(name);
+}
+/**
+* Returns `name` when it's a syntactically valid JavaScript variable name,
+* otherwise prefixes it with `_` so the result is a valid identifier.
+*
+* Useful for sanitizing OpenAPI schema names or operation IDs that start with
+* a digit (e.g. `409`, `504AccountCancel`) before using them as exported
+* variable, type, or function names.
+*
+* @example
+* ```ts
+* ensureValidVarName('409')             // '_409'
+* ensureValidVarName('504AccountCancel') // '_504AccountCancel'
+* ensureValidVarName('Pet')              // 'Pet'
+* ensureValidVarName('class')            // '_class'
+* ```
+*/
+function ensureValidVarName(name) {
+	if (!name || isValidVarName(name)) return name;
+	return `_${name}`;
+}
+//#endregion
 //#region src/components/Operations.tsx
 function Operations({ name, operations }) {
 	const operationsJSON = operations.reduce((prev, acc) => {
@@ -271,11 +394,11 @@ function buildSchemaNames(node, { params, resolver }) {
 	}
 	responses["default"] = resolver.resolveResponseName(node);
 	return {
-		request: node.requestBody?.content?.[0]?.schema ? resolver.resolveDataName(node) : void 0,
+		request: node.requestBody?.content?.[0]?.schema ? resolver.resolveDataName(node) : null,
 		parameters: {
-			path: pathParam ? resolver.resolvePathParamsName(node, pathParam) : void 0,
-			query: queryParam ? resolver.resolveQueryParamsName(node, queryParam) : void 0,
-			header: headerParam ? resolver.resolveHeaderParamsName(node, headerParam) : void 0
+			path: pathParam ? resolver.resolvePathParamsName(node, pathParam) : null,
+			query: queryParam ? resolver.resolveQueryParamsName(node, queryParam) : null,
+			header: headerParam ? resolver.resolveHeaderParamsName(node, headerParam) : null
 		},
 		responses,
 		errors
@@ -727,6 +850,12 @@ const printerZodMini = _kubb_core.ast.definePrinter((options) => {
 //#region src/generators/zodGenerator.tsx
 const zodPrinterCache = /* @__PURE__ */ new WeakMap();
 const zodMiniPrinterCache = /* @__PURE__ */ new WeakMap();
+/**
+* Built-in generator for `@kubb/plugin-zod`. Emits one Zod schema per
+* schema in the spec plus per-operation request/response/parameter schemas.
+* When `mini: true`, schemas use the Zod Mini functional API instead of
+* chainable methods.
+*/
 const zodGenerator = (0, _kubb_core.defineGenerator)({
 	name: "zod",
 	renderer: _kubb_renderer_jsx.jsxRendererSync,
@@ -745,7 +874,7 @@ const zodGenerator = (0, _kubb_core.defineGenerator)({
 			}, {
 				root,
 				output,
-				group
+				group: group ?? void 0
 			}).path
 		}));
 		const meta = {
@@ -756,10 +885,10 @@ const zodGenerator = (0, _kubb_core.defineGenerator)({
 			}, {
 				root,
 				output,
-				group
+				group: group ?? void 0
 			})
 		};
-		const inferTypeName = inferred ? resolver.resolveSchemaTypeName(node.name) : void 0;
+		const inferTypeName = inferred ? resolver.resolveSchemaTypeName(node.name) : null;
 		const cyclicSchemas = new Set(ctx.meta.circularNames);
 		const schemaPrinter = mini ? getCachedMiniPrinter() : getCachedStdPrinter();
 		function getCachedStdPrinter() {
@@ -845,12 +974,12 @@ const zodGenerator = (0, _kubb_core.defineGenerator)({
 		}, {
 			root,
 			output,
-			group
+			group: group ?? void 0
 		}) };
 		const cyclicSchemas = new Set(ctx.meta.circularNames);
 		function renderSchemaEntry({ schema, name, keysToOmit }) {
 			if (!schema) return null;
-			const inferTypeName = inferred ? resolver.resolveTypeName(name) : void 0;
+			const inferTypeName = inferred ? resolver.resolveTypeName(name) : null;
 			const imports = adapter.getImports(schema, (schemaName) => ({
 				name: resolver.resolveSchemaName(schemaName),
 				path: resolver.resolveFile({
@@ -859,7 +988,7 @@ const zodGenerator = (0, _kubb_core.defineGenerator)({
 				}, {
 					root,
 					output,
-					group
+					group: group ?? void 0
 				}).path
 			}));
 			const cachedStd = zodPrinterCache.get(resolver);
@@ -982,7 +1111,7 @@ const zodGenerator = (0, _kubb_core.defineGenerator)({
 		}, {
 			root,
 			output,
-			group
+			group: group ?? void 0
 		}) };
 		const transformedOperations = nodes.map((node) => {
 			return {
@@ -1007,7 +1136,7 @@ const zodGenerator = (0, _kubb_core.defineGenerator)({
 			}, {
 				root,
 				output,
-				group
+				group: group ?? void 0
 			});
 			return names.map((name) => /* @__PURE__ */ (0, _kubb_renderer_jsx_jsx_runtime.jsx)(_kubb_renderer_jsx.File.Import, {
 				name: [name],
@@ -1046,31 +1175,37 @@ const zodGenerator = (0, _kubb_core.defineGenerator)({
 //#endregion
 //#region src/resolvers/resolverZod.ts
 /**
-* Naming convention resolver for Zod plugin.
+* Default resolver used by `@kubb/plugin-zod`. Decides the names and file
+* paths for every generated Zod schema. Schemas use camelCase with a
+* `Schema` suffix (`listPetsSchema`); their inferred types use PascalCase.
 *
-* Provides default naming helpers using camelCase with a `Schema` suffix for schemas.
+* @example Resolve schema and type names
+* ```ts
+* import { resolverZod } from '@kubb/plugin-zod'
 *
-* @example
-* `resolverZod.default('list pets', 'function')  // → 'listPetsSchema'`
+* resolverZod.default('list pets', 'function') // 'listPetsSchema'
+* resolverZod.resolveSchemaTypeName('pet')     // 'PetSchema'
+* ```
 */
 const resolverZod = (0, _kubb_core.defineResolver)(() => {
 	return {
 		name: "default",
 		pluginName: "plugin-zod",
 		default(name, type) {
-			return camelCase(name, {
+			const resolved = camelCase(name, {
 				isFile: type === "file",
 				suffix: type ? "schema" : void 0
 			});
+			return type === "file" ? resolved : ensureValidVarName(resolved);
 		},
 		resolveSchemaName(name) {
-			return camelCase(name, { suffix: "schema" });
+			return ensureValidVarName(camelCase(name, { suffix: "schema" }));
 		},
 		resolveSchemaTypeName(name) {
-			return pascalCase(name, { suffix: "schema" });
+			return ensureValidVarName(pascalCase(name, { suffix: "schema" }));
 		},
 		resolveTypeName(name) {
-			return pascalCase(name);
+			return ensureValidVarName(pascalCase(name));
 		},
 		resolvePathName(name, type) {
 			return this.default(name, type);
@@ -1104,19 +1239,32 @@ const resolverZod = (0, _kubb_core.defineResolver)(() => {
 //#endregion
 //#region src/plugin.ts
 /**
-* Canonical plugin name for `@kubb/plugin-zod`, used in driver lookups and warnings.
+* Canonical plugin name for `@kubb/plugin-zod`. Used for driver lookups and
+* cross-plugin dependency references.
 */
 const pluginZodName = "plugin-zod";
 /**
-* Generates Zod validation schemas from an OpenAPI specification.
-* Walks schemas and operations, delegates to generators, and writes barrel files
-* based on the configured `barrelType`.
+* Generates Zod v4 schemas from an OpenAPI spec. Use them to validate API
+* responses at runtime, build form schemas, or feed back into router libraries
+* that consume Zod (tRPC, Hono, Elysia). Pair with `@kubb/plugin-client` and
+* set the client's `parser: 'zod'` to validate every response automatically.
 *
-* @example Zod schema generator
+* @example
 * ```ts
-* import pluginZod from '@kubb/plugin-zod'
+* import { defineConfig } from 'kubb'
+* import { pluginTs } from '@kubb/plugin-ts'
+* import { pluginZod } from '@kubb/plugin-zod'
+*
 * export default defineConfig({
-*   plugins: [pluginZod({ output: { path: 'zod' } })]
+*   input: { path: './petStore.yaml' },
+*   output: { path: './src/gen' },
+*   plugins: [
+*     pluginTs(),
+*     pluginZod({
+*       output: { path: './zod' },
+*       typed: true,
+*     }),
+*   ],
 * })
 * ```
 */
@@ -1131,7 +1279,7 @@ const pluginZod = (0, _kubb_core.definePlugin)((options) => {
 			if (group.type === "path") return `${ctx.group.split("/")[1]}`;
 			return `${camelCase(ctx.group)}Controller`;
 		}
-	} : void 0;
+	} : null;
 	return {
 		name: pluginZodName,
 		options,