@kubb/plugin-faker 5.0.0-beta.3 → 5.0.0-beta.30

package/dist/index.cjs

@@ -2,8 +2,8 @@ Object.defineProperties(exports, {
 	__esModule: { value: true },
 	[Symbol.toStringTag]: { value: "Module" }
 });
-const require_Faker = require("./Faker-BgleOzVN.cjs");
-const require_fakerGenerator = require("./fakerGenerator-VJEVzLjc.cjs");
+const require_Faker = require("./Faker-CkJccVKI.cjs");
+const require_fakerGenerator = require("./fakerGenerator-DhNV9xBw.cjs");
 let node_path = require("node:path");
 node_path = require_Faker.__toESM(node_path, 1);
 let _kubb_core = require("@kubb/core");
@@ -52,42 +52,163 @@ function camelCase(text, { isFile, prefix = "", suffix = "" } = {}) {
 	return toCamelOrPascal(`${prefix} ${text} ${suffix}`, false);
 }
 //#endregion
-//#region src/resolvers/resolverFaker.ts
-function isValidStrictIdentifier(name) {
-	try {
-		new Function(`"use strict"; const ${name} = 1;`);
-	} catch {
-		return false;
-	}
-	return true;
+//#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);
 }
 /**
-* Naming convention resolver for Faker plugin.
+* Returns `name` when it's a syntactically valid JavaScript variable name,
+* otherwise prefixes it with `_` so the result is a valid identifier.
 *
-* Provides default naming helpers using camelCase. Prefixes invalid identifiers with `_`.
+* 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
-* `resolverFaker.default('list pets', 'function')  // → 'listPets'`
+* ```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/resolvers/resolverFaker.ts
+/**
+* Default resolver used by `@kubb/plugin-faker`. Decides the names and file
+* paths for every generated mock factory. Functions and files are prefixed
+* with `create` so `Pet` becomes `createPet`.
+*
+* @example Resolve a factory name
+* ```ts
+* import { resolverFaker } from '@kubb/plugin-faker'
+*
+* resolverFaker.default('list pets', 'function') // 'createListPets'
+* ```
 */
-const resolverFaker = (0, _kubb_core.defineResolver)((ctx) => {
+const resolverFaker = (0, _kubb_core.defineResolver)(() => {
 	return {
 		name: "default",
 		pluginName: "plugin-faker",
 		default(name, type) {
-			const resolvedName = camelCase(name, { isFile: type === "file" });
-			if (type === "file" || isValidStrictIdentifier(resolvedName)) return resolvedName;
-			return `_${resolvedName}`;
+			const resolvedName = camelCase(name, {
+				isFile: type === "file",
+				prefix: "create"
+			});
+			return type === "file" ? resolvedName : ensureValidVarName(resolvedName);
 		},
 		resolveName(name, type) {
-			return ctx.default(name, type);
+			return this.default(name, type);
 		},
 		resolvePathName(name, type) {
-			return ctx.default(name, type);
+			return this.default(name, type);
 		},
 		resolveFile({ name, extname, tag, path: groupPath }, context) {
-			const pathMode = _kubb_core.PluginDriver.getMode(node_path.default.resolve(context.root, context.output.path));
-			const baseName = `${pathMode === "single" ? "" : ctx.resolveName(name, "file")}${extname}`;
-			const filePath = ctx.resolvePath({
+			const pathMode = _kubb_core.KubbDriver.getMode(node_path.default.resolve(context.root, context.output.path));
+			const baseName = `${pathMode === "single" ? "" : this.resolveName(name, "file")}${extname}`;
+			const filePath = this.resolvePath({
 				baseName,
 				pathMode,
 				tag,
@@ -100,48 +221,68 @@ const resolverFaker = (0, _kubb_core.defineResolver)((ctx) => {
 				path: filePath,
 				baseName,
 				extname,
-				meta: { pluginName: ctx.pluginName },
+				meta: { pluginName: this.pluginName },
 				sources: [],
 				imports: [],
 				exports: []
 			};
 		},
 		resolveParamName(node, param) {
-			return ctx.resolveName(`${node.operationId} ${param.in} ${param.name}`);
+			return this.resolveName(`${node.operationId} ${param.in} ${param.name}`);
 		},
 		resolveDataName(node) {
-			return ctx.resolveName(`${node.operationId} Data`);
+			return this.resolveName(`${node.operationId} Data`);
 		},
 		resolveResponseStatusName(node, statusCode) {
-			return ctx.resolveName(`${node.operationId} Status ${statusCode}`);
+			return this.resolveName(`${node.operationId} Status ${statusCode}`);
 		},
 		resolveResponseName(node) {
-			return ctx.resolveName(`${node.operationId} Response`);
+			return this.resolveName(`${node.operationId} Response`);
+		},
+		resolveResponsesName(node) {
+			return this.resolveName(`${node.operationId} Responses`);
 		},
 		resolvePathParamsName(node, param) {
-			return ctx.resolveParamName(node, param);
+			return this.resolveParamName(node, param);
 		},
 		resolveQueryParamsName(node, param) {
-			return ctx.resolveParamName(node, param);
+			return this.resolveParamName(node, param);
 		},
 		resolveHeaderParamsName(node, param) {
-			return ctx.resolveParamName(node, param);
+			return this.resolveParamName(node, param);
 		}
 	};
 });
 //#endregion
 //#region src/plugin.ts
 /**
-* Canonical plugin name for `@kubb/plugin-faker`, used in driver lookups and warnings.
+* Canonical plugin name for `@kubb/plugin-faker`. Used for driver lookups and
+* cross-plugin dependency references.
 */
 const pluginFakerName = "plugin-faker";
 /**
-* Generates Faker mock data factories from OpenAPI/AST specification.
-*
-* Creates randomized test data and mock helpers from schema definitions.
+* Generates one mock-data factory per OpenAPI schema using Faker.js. Call
+* `createPet()` to get a realistic `Pet` object. Useful for tests, Storybook,
+* and local development without a running backend.
 *
 * @example
-* `import pluginFaker from '@kubb/plugin-faker'; export default defineConfig({ plugins: [pluginFaker({ output: { path: 'mocks' } })], })`
+* ```ts
+* import { defineConfig } from 'kubb'
+* import { pluginTs } from '@kubb/plugin-ts'
+* import { pluginFaker } from '@kubb/plugin-faker'
+*
+* export default defineConfig({
+*   input: { path: './petStore.yaml' },
+*   output: { path: './src/gen' },
+*   plugins: [
+*     pluginTs(),
+*     pluginFaker({
+*       output: { path: './mocks' },
+*       seed: [100],
+*     }),
+*   ],
+* })
+* ```
 */
 const pluginFaker = (0, _kubb_core.definePlugin)((options) => {
 	const { output = {
@@ -154,7 +295,7 @@ const pluginFaker = (0, _kubb_core.definePlugin)((options) => {
 			if (group.type === "path") return `${ctx.group.split("/")[1]}`;
 			return `${camelCase(ctx.group)}Controller`;
 		}
-	} : void 0;
+	} : null;
 	return {
 		name: pluginFakerName,
 		options,

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["PluginDriver","path","pluginTsName","fakerGenerator"],"sources":["../../../internals/utils/src/casing.ts","../src/resolvers/resolverFaker.ts","../src/plugin.ts"],"sourcesContent":["type Options = {\n  /**\n   * When `true`, dot-separated segments are split on `.` and joined with `/` after casing.\n   */\n  isFile?: boolean\n  /**\n   * Text prepended before casing is applied.\n   */\n  prefix?: string\n  /**\n   * Text appended before casing is applied.\n   */\n  suffix?: string\n}\n\n/**\n * Shared implementation for camelCase and PascalCase conversion.\n * Splits on common word boundaries (spaces, hyphens, underscores, dots, slashes, colons)\n * and capitalizes each word according to `pascal`.\n *\n * When `pascal` is `true` the first word is also capitalized (PascalCase), otherwise only subsequent words are.\n */\nfunction toCamelOrPascal(text: string, pascal: boolean): string {\n  const normalized = text\n    .trim()\n    .replace(/([a-z\\d])([A-Z])/g, '$1 $2')\n    .replace(/([A-Z]+)([A-Z][a-z])/g, '$1 $2')\n    .replace(/(\\d)([a-z])/g, '$1 $2')\n\n  const words = normalized.split(/[\\s\\-_./\\\\:]+/).filter(Boolean)\n\n  return words\n    .map((word, i) => {\n      const allUpper = word.length > 1 && word === word.toUpperCase()\n      if (allUpper) return word\n      if (i === 0 && !pascal) return word.charAt(0).toLowerCase() + word.slice(1)\n      return word.charAt(0).toUpperCase() + word.slice(1)\n    })\n    .join('')\n    .replace(/[^a-zA-Z0-9]/g, '')\n}\n\n/**\n * Splits `text` on `.` and applies `transformPart` to each segment.\n * The last segment receives `isLast = true`, all earlier segments receive `false`.\n * Segments are joined with `/` to form a file path.\n *\n * Only splits on dots followed by a letter so that version numbers\n * embedded in operationIds (e.g. `v2025.0`) are kept intact.\n */\nfunction applyToFileParts(text: string, transformPart: (part: string, isLast: boolean) => string): string {\n  const parts = text.split(/\\.(?=[a-zA-Z])/)\n  return parts.map((part, i) => transformPart(part, i === parts.length - 1)).join('/')\n}\n\n/**\n * Converts `text` to camelCase.\n * When `isFile` is `true`, dot-separated segments are each cased independently and joined with `/`.\n *\n * @example\n * camelCase('hello-world')                   // 'helloWorld'\n * camelCase('pet.petId', { isFile: true })   // 'pet/petId'\n */\nexport function camelCase(text: string, { isFile, prefix = '', suffix = '' }: Options = {}): string {\n  if (isFile) {\n    return applyToFileParts(text, (part, isLast) => camelCase(part, isLast ? { prefix, suffix } : {}))\n  }\n\n  return toCamelOrPascal(`${prefix} ${text} ${suffix}`, false)\n}\n\n/**\n * Converts `text` to PascalCase.\n * When `isFile` is `true`, the last dot-separated segment is PascalCased and earlier segments are camelCased.\n *\n * @example\n * pascalCase('hello-world')                  // 'HelloWorld'\n * pascalCase('pet.petId', { isFile: true })  // 'pet/PetId'\n */\nexport function pascalCase(text: string, { isFile, prefix = '', suffix = '' }: Options = {}): string {\n  if (isFile) {\n    return applyToFileParts(text, (part, isLast) => (isLast ? pascalCase(part, { prefix, suffix }) : camelCase(part)))\n  }\n\n  return toCamelOrPascal(`${prefix} ${text} ${suffix}`, true)\n}\n\n/**\n * Converts `text` to snake_case.\n *\n * @example\n * snakeCase('helloWorld')  // 'hello_world'\n * snakeCase('Hello-World') // 'hello_world'\n */\nexport function snakeCase(text: string, { prefix = '', suffix = '' }: Omit<Options, 'isFile'> = {}): string {\n  const processed = `${prefix} ${text} ${suffix}`.trim()\n  return processed\n    .replace(/([a-z])([A-Z])/g, '$1_$2')\n    .replace(/[\\s\\-.]+/g, '_')\n    .replace(/[^a-zA-Z0-9_]/g, '')\n    .toLowerCase()\n    .split('_')\n    .filter(Boolean)\n    .join('_')\n}\n\n/**\n * Converts `text` to SCREAMING_SNAKE_CASE.\n *\n * @example\n * screamingSnakeCase('helloWorld') // 'HELLO_WORLD'\n */\nexport function screamingSnakeCase(text: string, { prefix = '', suffix = '' }: Omit<Options, 'isFile'> = {}): string {\n  return snakeCase(text, { prefix, suffix }).toUpperCase()\n}\n","import { createHash } from 'node:crypto'\nimport path from 'node:path'\nimport { camelCase } from '@internals/utils'\nimport { defineResolver, PluginDriver } from '@kubb/core'\nimport type { PluginFaker } from '../types.ts'\n\nfunction isValidStrictIdentifier(name: string): boolean {\n  try {\n    new Function(`\"use strict\"; const ${name} = 1;`)\n  } catch {\n    return false\n  }\n\n  return true\n}\n\n/**\n * Naming convention resolver for Faker plugin.\n *\n * Provides default naming helpers using camelCase. Prefixes invalid identifiers with `_`.\n *\n * @example\n * `resolverFaker.default('list pets', 'function')  // → 'listPets'`\n */\nexport const resolverFaker = defineResolver<PluginFaker>((ctx) => {\n  return {\n    name: 'default',\n    pluginName: 'plugin-faker',\n    default(name, type) {\n      const resolvedName = camelCase(name, { isFile: type === 'file' })\n\n      if (type === 'file' || isValidStrictIdentifier(resolvedName)) {\n        return resolvedName\n      }\n\n      return `_${resolvedName}`\n    },\n    resolveName(name, type) {\n      return ctx.default(name, type)\n    },\n    resolvePathName(name, type) {\n      return ctx.default(name, type)\n    },\n    resolveFile({ name, extname, tag, path: groupPath }, context) {\n      const pathMode = PluginDriver.getMode(path.resolve(context.root, context.output.path))\n      const baseName = `${pathMode === 'single' ? '' : ctx.resolveName(name, 'file')}${extname}` as `${string}.${string}`\n      const filePath = ctx.resolvePath(\n        {\n          baseName,\n          pathMode,\n          tag,\n          path: groupPath,\n        },\n        context,\n      )\n\n      return {\n        kind: 'File',\n        id: createHash('sha256').update(filePath).digest('hex'),\n        name: path.basename(filePath, extname),\n        path: filePath,\n        baseName,\n        extname,\n        meta: { pluginName: ctx.pluginName },\n        sources: [],\n        imports: [],\n        exports: [],\n      }\n    },\n    resolveParamName(node, param) {\n      return ctx.resolveName(`${node.operationId} ${param.in} ${param.name}`)\n    },\n    resolveDataName(node) {\n      return ctx.resolveName(`${node.operationId} Data`)\n    },\n    resolveResponseStatusName(node, statusCode) {\n      return ctx.resolveName(`${node.operationId} Status ${statusCode}`)\n    },\n    resolveResponseName(node) {\n      return ctx.resolveName(`${node.operationId} Response`)\n    },\n    resolvePathParamsName(node, param) {\n      return ctx.resolveParamName(node, param)\n    },\n    resolveQueryParamsName(node, param) {\n      return ctx.resolveParamName(node, param)\n    },\n    resolveHeaderParamsName(node, param) {\n      return ctx.resolveParamName(node, param)\n    },\n  }\n})\n","import { camelCase } from '@internals/utils'\nimport { definePlugin, type Group } from '@kubb/core'\nimport { pluginTsName } from '@kubb/plugin-ts'\nimport { fakerGenerator } from './generators/fakerGenerator.tsx'\nimport { resolverFaker } from './resolvers/resolverFaker.ts'\nimport type { PluginFaker } from './types.ts'\n\n/**\n * Canonical plugin name for `@kubb/plugin-faker`, used in driver lookups and warnings.\n */\nexport const pluginFakerName = 'plugin-faker' satisfies PluginFaker['name']\n\n/**\n * Generates Faker mock data factories from OpenAPI/AST specification.\n *\n * Creates randomized test data and mock helpers from schema definitions.\n *\n * @example\n * `import pluginFaker from '@kubb/plugin-faker'; export default defineConfig({ plugins: [pluginFaker({ output: { path: 'mocks' } })], })`\n */\nexport const pluginFaker = definePlugin<PluginFaker>((options) => {\n  const {\n    output = { path: 'mocks', barrelType: 'named' },\n    seed,\n    locale,\n    group,\n    exclude = [],\n    include,\n    override = [],\n    mapper = {},\n    dateParser = 'faker',\n    generators: userGenerators = [],\n    regexGenerator = 'faker',\n    paramsCasing,\n    printer,\n    resolver: userResolver,\n    transformer: userTransformer,\n  } = options\n\n  const groupConfig = group\n    ? ({\n        ...group,\n        name: group.name\n          ? group.name\n          : (ctx: { group: string }) => {\n              if (group.type === 'path') {\n                return `${ctx.group.split('/')[1]}`\n              }\n\n              return `${camelCase(ctx.group)}Controller`\n            },\n      } satisfies Group)\n    : undefined\n\n  return {\n    name: pluginFakerName,\n    options,\n    dependencies: [pluginTsName],\n    hooks: {\n      'kubb:plugin:setup'(ctx) {\n        ctx.setOptions({\n          output,\n          seed,\n          locale,\n          exclude,\n          include,\n          override,\n          group: groupConfig,\n          mapper,\n          dateParser,\n          regexGenerator,\n          paramsCasing,\n          printer,\n        })\n        ctx.setResolver(userResolver ? { ...resolverFaker, ...userResolver } : resolverFaker)\n        if (userTransformer) {\n          ctx.setTransformer(userTransformer)\n        }\n        ctx.addGenerator(fakerGenerator)\n        for (const generator of userGenerators) {\n          ctx.addGenerator(generator)\n        }\n      },\n    },\n  }\n})\n\nexport default pluginFaker\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAsBA,SAAS,gBAAgB,MAAc,QAAyB;AAS9D,QARmB,KAChB,MAAM,CACN,QAAQ,qBAAqB,QAAQ,CACrC,QAAQ,yBAAyB,QAAQ,CACzC,QAAQ,gBAAgB,QAEH,CAAC,MAAM,gBAAgB,CAAC,OAAO,QAE3C,CACT,KAAK,MAAM,MAAM;AAEhB,MADiB,KAAK,SAAS,KAAK,SAAS,KAAK,aAAa,CACjD,QAAO;AACrB,MAAI,MAAM,KAAK,CAAC,OAAQ,QAAO,KAAK,OAAO,EAAE,CAAC,aAAa,GAAG,KAAK,MAAM,EAAE;AAC3E,SAAO,KAAK,OAAO,EAAE,CAAC,aAAa,GAAG,KAAK,MAAM,EAAE;GACnD,CACD,KAAK,GAAG,CACR,QAAQ,iBAAiB,GAAG;;;;;;;;;;AAWjC,SAAS,iBAAiB,MAAc,eAAkE;CACxG,MAAM,QAAQ,KAAK,MAAM,iBAAiB;AAC1C,QAAO,MAAM,KAAK,MAAM,MAAM,cAAc,MAAM,MAAM,MAAM,SAAS,EAAE,CAAC,CAAC,KAAK,IAAI;;;;;;;;;;AAWtF,SAAgB,UAAU,MAAc,EAAE,QAAQ,SAAS,IAAI,SAAS,OAAgB,EAAE,EAAU;AAClG,KAAI,OACF,QAAO,iBAAiB,OAAO,MAAM,WAAW,UAAU,MAAM,SAAS;EAAE;EAAQ;EAAQ,GAAG,EAAE,CAAC,CAAC;AAGpG,QAAO,gBAAgB,GAAG,OAAO,GAAG,KAAK,GAAG,UAAU,MAAM;;;;AC9D9D,SAAS,wBAAwB,MAAuB;AACtD,KAAI;AACF,MAAI,SAAS,uBAAuB,KAAK,OAAO;SAC1C;AACN,SAAO;;AAGT,QAAO;;;;;;;;;;AAWT,MAAa,iBAAA,GAAA,WAAA,iBAA6C,QAAQ;AAChE,QAAO;EACL,MAAM;EACN,YAAY;EACZ,QAAQ,MAAM,MAAM;GAClB,MAAM,eAAe,UAAU,MAAM,EAAE,QAAQ,SAAS,QAAQ,CAAC;AAEjE,OAAI,SAAS,UAAU,wBAAwB,aAAa,CAC1D,QAAO;AAGT,UAAO,IAAI;;EAEb,YAAY,MAAM,MAAM;AACtB,UAAO,IAAI,QAAQ,MAAM,KAAK;;EAEhC,gBAAgB,MAAM,MAAM;AAC1B,UAAO,IAAI,QAAQ,MAAM,KAAK;;EAEhC,YAAY,EAAE,MAAM,SAAS,KAAK,MAAM,aAAa,SAAS;GAC5D,MAAM,WAAWA,WAAAA,aAAa,QAAQC,UAAAA,QAAK,QAAQ,QAAQ,MAAM,QAAQ,OAAO,KAAK,CAAC;GACtF,MAAM,WAAW,GAAG,aAAa,WAAW,KAAK,IAAI,YAAY,MAAM,OAAO,GAAG;GACjF,MAAM,WAAW,IAAI,YACnB;IACE;IACA;IACA;IACA,MAAM;IACP,EACD,QACD;AAED,UAAO;IACL,MAAM;IACN,KAAA,GAAA,YAAA,YAAe,SAAS,CAAC,OAAO,SAAS,CAAC,OAAO,MAAM;IACvD,MAAMA,UAAAA,QAAK,SAAS,UAAU,QAAQ;IACtC,MAAM;IACN;IACA;IACA,MAAM,EAAE,YAAY,IAAI,YAAY;IACpC,SAAS,EAAE;IACX,SAAS,EAAE;IACX,SAAS,EAAE;IACZ;;EAEH,iBAAiB,MAAM,OAAO;AAC5B,UAAO,IAAI,YAAY,GAAG,KAAK,YAAY,GAAG,MAAM,GAAG,GAAG,MAAM,OAAO;;EAEzE,gBAAgB,MAAM;AACpB,UAAO,IAAI,YAAY,GAAG,KAAK,YAAY,OAAO;;EAEpD,0BAA0B,MAAM,YAAY;AAC1C,UAAO,IAAI,YAAY,GAAG,KAAK,YAAY,UAAU,aAAa;;EAEpE,oBAAoB,MAAM;AACxB,UAAO,IAAI,YAAY,GAAG,KAAK,YAAY,WAAW;;EAExD,sBAAsB,MAAM,OAAO;AACjC,UAAO,IAAI,iBAAiB,MAAM,MAAM;;EAE1C,uBAAuB,MAAM,OAAO;AAClC,UAAO,IAAI,iBAAiB,MAAM,MAAM;;EAE1C,wBAAwB,MAAM,OAAO;AACnC,UAAO,IAAI,iBAAiB,MAAM,MAAM;;EAE3C;EACD;;;;;;ACjFF,MAAa,kBAAkB;;;;;;;;;AAU/B,MAAa,eAAA,GAAA,WAAA,eAAyC,YAAY;CAChE,MAAM,EACJ,SAAS;EAAE,MAAM;EAAS,YAAY;EAAS,EAC/C,MACA,QACA,OACA,UAAU,EAAE,EACZ,SACA,WAAW,EAAE,EACb,SAAS,EAAE,EACX,aAAa,SACb,YAAY,iBAAiB,EAAE,EAC/B,iBAAiB,SACjB,cACA,SACA,UAAU,cACV,aAAa,oBACX;CAEJ,MAAM,cAAc,QACf;EACC,GAAG;EACH,MAAM,MAAM,OACR,MAAM,QACL,QAA2B;AAC1B,OAAI,MAAM,SAAS,OACjB,QAAO,GAAG,IAAI,MAAM,MAAM,IAAI,CAAC;AAGjC,UAAO,GAAG,UAAU,IAAI,MAAM,CAAC;;EAEtC,GACD,KAAA;AAEJ,QAAO;EACL,MAAM;EACN;EACA,cAAc,CAACC,gBAAAA,aAAa;EAC5B,OAAO,EACL,oBAAoB,KAAK;AACvB,OAAI,WAAW;IACb;IACA;IACA;IACA;IACA;IACA;IACA,OAAO;IACP;IACA;IACA;IACA;IACA;IACD,CAAC;AACF,OAAI,YAAY,eAAe;IAAE,GAAG;IAAe,GAAG;IAAc,GAAG,cAAc;AACrF,OAAI,gBACF,KAAI,eAAe,gBAAgB;AAErC,OAAI,aAAaC,uBAAAA,eAAe;AAChC,QAAK,MAAM,aAAa,eACtB,KAAI,aAAa,UAAU;KAGhC;EACF;EACD"}
+{"version":3,"file":"index.cjs","names":["KubbDriver","path","pluginTsName","fakerGenerator"],"sources":["../../../internals/utils/src/casing.ts","../../../internals/utils/src/reserved.ts","../src/resolvers/resolverFaker.ts","../src/plugin.ts"],"sourcesContent":["type Options = {\n  /**\n   * When `true`, dot-separated segments are split on `.` and joined with `/` after casing.\n   */\n  isFile?: boolean\n  /**\n   * Text prepended before casing is applied.\n   */\n  prefix?: string\n  /**\n   * Text appended before casing is applied.\n   */\n  suffix?: string\n}\n\n/**\n * Shared implementation for camelCase and PascalCase conversion.\n * Splits on common word boundaries (spaces, hyphens, underscores, dots, slashes, colons)\n * and capitalizes each word according to `pascal`.\n *\n * When `pascal` is `true` the first word is also capitalized (PascalCase), otherwise only subsequent words are.\n */\nfunction toCamelOrPascal(text: string, pascal: boolean): string {\n  const normalized = text\n    .trim()\n    .replace(/([a-z\\d])([A-Z])/g, '$1 $2')\n    .replace(/([A-Z]+)([A-Z][a-z])/g, '$1 $2')\n    .replace(/(\\d)([a-z])/g, '$1 $2')\n\n  const words = normalized.split(/[\\s\\-_./\\\\:]+/).filter(Boolean)\n\n  return words\n    .map((word, i) => {\n      const allUpper = word.length > 1 && word === word.toUpperCase()\n      if (allUpper) return word\n      if (i === 0 && !pascal) return word.charAt(0).toLowerCase() + word.slice(1)\n      return word.charAt(0).toUpperCase() + word.slice(1)\n    })\n    .join('')\n    .replace(/[^a-zA-Z0-9]/g, '')\n}\n\n/**\n * Splits `text` on `.` and applies `transformPart` to each segment.\n * The last segment receives `isLast = true`, all earlier segments receive `false`.\n * Segments are joined with `/` to form a file path.\n *\n * Only splits on dots followed by a letter so that version numbers\n * embedded in operationIds (e.g. `v2025.0`) are kept intact.\n */\nfunction applyToFileParts(text: string, transformPart: (part: string, isLast: boolean) => string): string {\n  const parts = text.split(/\\.(?=[a-zA-Z])/)\n  return parts.map((part, i) => transformPart(part, i === parts.length - 1)).join('/')\n}\n\n/**\n * Converts `text` to camelCase.\n * When `isFile` is `true`, dot-separated segments are each cased independently and joined with `/`.\n *\n * @example\n * camelCase('hello-world')                   // 'helloWorld'\n * camelCase('pet.petId', { isFile: true })   // 'pet/petId'\n */\nexport function camelCase(text: string, { isFile, prefix = '', suffix = '' }: Options = {}): string {\n  if (isFile) {\n    return applyToFileParts(text, (part, isLast) => camelCase(part, isLast ? { prefix, suffix } : {}))\n  }\n\n  return toCamelOrPascal(`${prefix} ${text} ${suffix}`, false)\n}\n\n/**\n * Converts `text` to PascalCase.\n * When `isFile` is `true`, the last dot-separated segment is PascalCased and earlier segments are camelCased.\n *\n * @example\n * pascalCase('hello-world')                  // 'HelloWorld'\n * pascalCase('pet.petId', { isFile: true })  // 'pet/PetId'\n */\nexport function pascalCase(text: string, { isFile, prefix = '', suffix = '' }: Options = {}): string {\n  if (isFile) {\n    return applyToFileParts(text, (part, isLast) => (isLast ? pascalCase(part, { prefix, suffix }) : camelCase(part)))\n  }\n\n  return toCamelOrPascal(`${prefix} ${text} ${suffix}`, true)\n}\n\n/**\n * Converts `text` to snake_case.\n *\n * @example\n * snakeCase('helloWorld')  // 'hello_world'\n * snakeCase('Hello-World') // 'hello_world'\n */\nexport function snakeCase(text: string, { prefix = '', suffix = '' }: Omit<Options, 'isFile'> = {}): string {\n  const processed = `${prefix} ${text} ${suffix}`.trim()\n  return processed\n    .replace(/([a-z])([A-Z])/g, '$1_$2')\n    .replace(/[\\s\\-.]+/g, '_')\n    .replace(/[^a-zA-Z0-9_]/g, '')\n    .toLowerCase()\n    .split('_')\n    .filter(Boolean)\n    .join('_')\n}\n\n/**\n * Converts `text` to SCREAMING_SNAKE_CASE.\n *\n * @example\n * screamingSnakeCase('helloWorld') // 'HELLO_WORLD'\n */\nexport function screamingSnakeCase(text: string, { prefix = '', suffix = '' }: Omit<Options, 'isFile'> = {}): string {\n  return snakeCase(text, { prefix, suffix }).toUpperCase()\n}\n","/**\n * JavaScript and Java reserved words.\n * @link https://github.com/jonschlinkert/reserved/blob/master/index.js\n */\nconst reservedWords = new Set([\n  'abstract',\n  'arguments',\n  'boolean',\n  'break',\n  'byte',\n  'case',\n  'catch',\n  'char',\n  'class',\n  'const',\n  'continue',\n  'debugger',\n  'default',\n  'delete',\n  'do',\n  'double',\n  'else',\n  'enum',\n  'eval',\n  'export',\n  'extends',\n  'false',\n  'final',\n  'finally',\n  'float',\n  'for',\n  'function',\n  'goto',\n  'if',\n  'implements',\n  'import',\n  'in',\n  'instanceof',\n  'int',\n  'interface',\n  'let',\n  'long',\n  'native',\n  'new',\n  'null',\n  'package',\n  'private',\n  'protected',\n  'public',\n  'return',\n  'short',\n  'static',\n  'super',\n  'switch',\n  'synchronized',\n  'this',\n  'throw',\n  'throws',\n  'transient',\n  'true',\n  'try',\n  'typeof',\n  'var',\n  'void',\n  'volatile',\n  'while',\n  'with',\n  'yield',\n  'Array',\n  'Date',\n  'hasOwnProperty',\n  'Infinity',\n  'isFinite',\n  'isNaN',\n  'isPrototypeOf',\n  'length',\n  'Math',\n  'name',\n  'NaN',\n  'Number',\n  'Object',\n  'prototype',\n  'String',\n  'toString',\n  'undefined',\n  'valueOf',\n] as const)\n\n/**\n * Returns `true` when `name` is a syntactically valid JavaScript variable name.\n *\n * @example\n * ```ts\n * isValidVarName('status')  // true\n * isValidVarName('class')   // false (reserved word)\n * isValidVarName('42foo')   // false (starts with digit)\n * ```\n */\nexport function isValidVarName(name: string): boolean {\n  if (!name || reservedWords.has(name as 'valueOf')) {\n    return false\n  }\n  return /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(name)\n}\n\n/**\n * Returns `name` when it's a syntactically valid JavaScript variable name,\n * otherwise prefixes it with `_` so the result is a valid identifier.\n *\n * Useful for sanitizing OpenAPI schema names or operation IDs that start with\n * a digit (e.g. `409`, `504AccountCancel`) before using them as exported\n * variable, type, or function names.\n *\n * @example\n * ```ts\n * ensureValidVarName('409')             // '_409'\n * ensureValidVarName('504AccountCancel') // '_504AccountCancel'\n * ensureValidVarName('Pet')              // 'Pet'\n * ensureValidVarName('class')            // '_class'\n * ```\n */\nexport function ensureValidVarName(name: string): string {\n  if (!name || isValidVarName(name)) {\n    return name\n  }\n  return `_${name}`\n}\n","import { createHash } from 'node:crypto'\nimport path from 'node:path'\nimport { camelCase, ensureValidVarName } from '@internals/utils'\nimport { defineResolver, KubbDriver } from '@kubb/core'\nimport type { PluginFaker } from '../types.ts'\n\n/**\n * Default resolver used by `@kubb/plugin-faker`. Decides the names and file\n * paths for every generated mock factory. Functions and files are prefixed\n * with `create` so `Pet` becomes `createPet`.\n *\n * @example Resolve a factory name\n * ```ts\n * import { resolverFaker } from '@kubb/plugin-faker'\n *\n * resolverFaker.default('list pets', 'function') // 'createListPets'\n * ```\n */\nexport const resolverFaker = defineResolver<PluginFaker>(() => {\n  return {\n    name: 'default',\n    pluginName: 'plugin-faker',\n    default(name, type) {\n      const resolvedName = camelCase(name, { isFile: type === 'file', prefix: 'create' })\n      return type === 'file' ? resolvedName : ensureValidVarName(resolvedName)\n    },\n    resolveName(name, type) {\n      return this.default(name, type)\n    },\n    resolvePathName(name, type) {\n      return this.default(name, type)\n    },\n    resolveFile({ name, extname, tag, path: groupPath }, context) {\n      const pathMode = KubbDriver.getMode(path.resolve(context.root, context.output.path))\n      const baseName = `${pathMode === 'single' ? '' : this.resolveName(name, 'file')}${extname}` as `${string}.${string}`\n      const filePath = this.resolvePath(\n        {\n          baseName,\n          pathMode,\n          tag,\n          path: groupPath,\n        },\n        context,\n      )\n\n      return {\n        kind: 'File',\n        id: createHash('sha256').update(filePath).digest('hex'),\n        name: path.basename(filePath, extname),\n        path: filePath,\n        baseName,\n        extname,\n        meta: { pluginName: this.pluginName },\n        sources: [],\n        imports: [],\n        exports: [],\n      }\n    },\n    resolveParamName(node, param) {\n      return this.resolveName(`${node.operationId} ${param.in} ${param.name}`)\n    },\n    resolveDataName(node) {\n      return this.resolveName(`${node.operationId} Data`)\n    },\n    resolveResponseStatusName(node, statusCode) {\n      return this.resolveName(`${node.operationId} Status ${statusCode}`)\n    },\n    resolveResponseName(node) {\n      return this.resolveName(`${node.operationId} Response`)\n    },\n    resolveResponsesName(node) {\n      return this.resolveName(`${node.operationId} Responses`)\n    },\n    resolvePathParamsName(node, param) {\n      return this.resolveParamName(node, param)\n    },\n    resolveQueryParamsName(node, param) {\n      return this.resolveParamName(node, param)\n    },\n    resolveHeaderParamsName(node, param) {\n      return this.resolveParamName(node, param)\n    },\n  }\n})\n","import { camelCase } from '@internals/utils'\nimport { definePlugin, type Group } from '@kubb/core'\nimport { pluginTsName } from '@kubb/plugin-ts'\nimport { fakerGenerator } from './generators/fakerGenerator.tsx'\nimport { resolverFaker } from './resolvers/resolverFaker.ts'\nimport type { PluginFaker } from './types.ts'\n\n/**\n * Canonical plugin name for `@kubb/plugin-faker`. Used for driver lookups and\n * cross-plugin dependency references.\n */\nexport const pluginFakerName = 'plugin-faker' satisfies PluginFaker['name']\n\n/**\n * Generates one mock-data factory per OpenAPI schema using Faker.js. Call\n * `createPet()` to get a realistic `Pet` object. Useful for tests, Storybook,\n * and local development without a running backend.\n *\n * @example\n * ```ts\n * import { defineConfig } from 'kubb'\n * import { pluginTs } from '@kubb/plugin-ts'\n * import { pluginFaker } from '@kubb/plugin-faker'\n *\n * export default defineConfig({\n *   input: { path: './petStore.yaml' },\n *   output: { path: './src/gen' },\n *   plugins: [\n *     pluginTs(),\n *     pluginFaker({\n *       output: { path: './mocks' },\n *       seed: [100],\n *     }),\n *   ],\n * })\n * ```\n */\nexport const pluginFaker = definePlugin<PluginFaker>((options) => {\n  const {\n    output = { path: 'mocks', barrelType: 'named' },\n    seed,\n    locale,\n    group,\n    exclude = [],\n    include,\n    override = [],\n    mapper = {},\n    dateParser = 'faker',\n    generators: userGenerators = [],\n    regexGenerator = 'faker',\n    paramsCasing,\n    printer,\n    resolver: userResolver,\n    transformer: userTransformer,\n  } = options\n\n  const groupConfig = group\n    ? ({\n        ...group,\n        name: group.name\n          ? group.name\n          : (ctx: { group: string }) => {\n              if (group.type === 'path') {\n                return `${ctx.group.split('/')[1]}`\n              }\n\n              return `${camelCase(ctx.group)}Controller`\n            },\n      } satisfies Group)\n    : null\n\n  return {\n    name: pluginFakerName,\n    options,\n    dependencies: [pluginTsName],\n    hooks: {\n      'kubb:plugin:setup'(ctx) {\n        ctx.setOptions({\n          output,\n          seed,\n          locale,\n          exclude,\n          include,\n          override,\n          group: groupConfig,\n          mapper,\n          dateParser,\n          regexGenerator,\n          paramsCasing,\n          printer,\n        })\n        ctx.setResolver(userResolver ? { ...resolverFaker, ...userResolver } : resolverFaker)\n        if (userTransformer) {\n          ctx.setTransformer(userTransformer)\n        }\n        ctx.addGenerator(fakerGenerator)\n        for (const generator of userGenerators) {\n          ctx.addGenerator(generator)\n        }\n      },\n    },\n  }\n})\n\nexport default pluginFaker\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAsBA,SAAS,gBAAgB,MAAc,QAAyB;CAS9D,OARmB,KAChB,MAAM,CACN,QAAQ,qBAAqB,QAAQ,CACrC,QAAQ,yBAAyB,QAAQ,CACzC,QAAQ,gBAAgB,QAEH,CAAC,MAAM,gBAAgB,CAAC,OAAO,QAE3C,CACT,KAAK,MAAM,MAAM;EAEhB,IADiB,KAAK,SAAS,KAAK,SAAS,KAAK,aAAa,EACjD,OAAO;EACrB,IAAI,MAAM,KAAK,CAAC,QAAQ,OAAO,KAAK,OAAO,EAAE,CAAC,aAAa,GAAG,KAAK,MAAM,EAAE;EAC3E,OAAO,KAAK,OAAO,EAAE,CAAC,aAAa,GAAG,KAAK,MAAM,EAAE;GACnD,CACD,KAAK,GAAG,CACR,QAAQ,iBAAiB,GAAG;;;;;;;;;;AAWjC,SAAS,iBAAiB,MAAc,eAAkE;CACxG,MAAM,QAAQ,KAAK,MAAM,iBAAiB;CAC1C,OAAO,MAAM,KAAK,MAAM,MAAM,cAAc,MAAM,MAAM,MAAM,SAAS,EAAE,CAAC,CAAC,KAAK,IAAI;;;;;;;;;;AAWtF,SAAgB,UAAU,MAAc,EAAE,QAAQ,SAAS,IAAI,SAAS,OAAgB,EAAE,EAAU;CAClG,IAAI,QACF,OAAO,iBAAiB,OAAO,MAAM,WAAW,UAAU,MAAM,SAAS;EAAE;EAAQ;EAAQ,GAAG,EAAE,CAAC,CAAC;CAGpG,OAAO,gBAAgB,GAAG,OAAO,GAAG,KAAK,GAAG,UAAU,MAAM;;;;;;;;AChE9D,MAAM,gBAAgB,IAAI,IAAI;CAC5B;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD,CAAU;;;;;;;;;;;AAYX,SAAgB,eAAe,MAAuB;CACpD,IAAI,CAAC,QAAQ,cAAc,IAAI,KAAkB,EAC/C,OAAO;CAET,OAAO,6BAA6B,KAAK,KAAK;;;;;;;;;;;;;;;;;;AAmBhD,SAAgB,mBAAmB,MAAsB;CACvD,IAAI,CAAC,QAAQ,eAAe,KAAK,EAC/B,OAAO;CAET,OAAO,IAAI;;;;;;;;;;;;;;;;AC3Gb,MAAa,iBAAA,GAAA,WAAA,sBAAkD;CAC7D,OAAO;EACL,MAAM;EACN,YAAY;EACZ,QAAQ,MAAM,MAAM;GAClB,MAAM,eAAe,UAAU,MAAM;IAAE,QAAQ,SAAS;IAAQ,QAAQ;IAAU,CAAC;GACnF,OAAO,SAAS,SAAS,eAAe,mBAAmB,aAAa;;EAE1E,YAAY,MAAM,MAAM;GACtB,OAAO,KAAK,QAAQ,MAAM,KAAK;;EAEjC,gBAAgB,MAAM,MAAM;GAC1B,OAAO,KAAK,QAAQ,MAAM,KAAK;;EAEjC,YAAY,EAAE,MAAM,SAAS,KAAK,MAAM,aAAa,SAAS;GAC5D,MAAM,WAAWA,WAAAA,WAAW,QAAQC,UAAAA,QAAK,QAAQ,QAAQ,MAAM,QAAQ,OAAO,KAAK,CAAC;GACpF,MAAM,WAAW,GAAG,aAAa,WAAW,KAAK,KAAK,YAAY,MAAM,OAAO,GAAG;GAClF,MAAM,WAAW,KAAK,YACpB;IACE;IACA;IACA;IACA,MAAM;IACP,EACD,QACD;GAED,OAAO;IACL,MAAM;IACN,KAAA,GAAA,YAAA,YAAe,SAAS,CAAC,OAAO,SAAS,CAAC,OAAO,MAAM;IACvD,MAAMA,UAAAA,QAAK,SAAS,UAAU,QAAQ;IACtC,MAAM;IACN;IACA;IACA,MAAM,EAAE,YAAY,KAAK,YAAY;IACrC,SAAS,EAAE;IACX,SAAS,EAAE;IACX,SAAS,EAAE;IACZ;;EAEH,iBAAiB,MAAM,OAAO;GAC5B,OAAO,KAAK,YAAY,GAAG,KAAK,YAAY,GAAG,MAAM,GAAG,GAAG,MAAM,OAAO;;EAE1E,gBAAgB,MAAM;GACpB,OAAO,KAAK,YAAY,GAAG,KAAK,YAAY,OAAO;;EAErD,0BAA0B,MAAM,YAAY;GAC1C,OAAO,KAAK,YAAY,GAAG,KAAK,YAAY,UAAU,aAAa;;EAErE,oBAAoB,MAAM;GACxB,OAAO,KAAK,YAAY,GAAG,KAAK,YAAY,WAAW;;EAEzD,qBAAqB,MAAM;GACzB,OAAO,KAAK,YAAY,GAAG,KAAK,YAAY,YAAY;;EAE1D,sBAAsB,MAAM,OAAO;GACjC,OAAO,KAAK,iBAAiB,MAAM,MAAM;;EAE3C,uBAAuB,MAAM,OAAO;GAClC,OAAO,KAAK,iBAAiB,MAAM,MAAM;;EAE3C,wBAAwB,MAAM,OAAO;GACnC,OAAO,KAAK,iBAAiB,MAAM,MAAM;;EAE5C;EACD;;;;;;;ACxEF,MAAa,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;AA0B/B,MAAa,eAAA,GAAA,WAAA,eAAyC,YAAY;CAChE,MAAM,EACJ,SAAS;EAAE,MAAM;EAAS,YAAY;EAAS,EAC/C,MACA,QACA,OACA,UAAU,EAAE,EACZ,SACA,WAAW,EAAE,EACb,SAAS,EAAE,EACX,aAAa,SACb,YAAY,iBAAiB,EAAE,EAC/B,iBAAiB,SACjB,cACA,SACA,UAAU,cACV,aAAa,oBACX;CAEJ,MAAM,cAAc,QACf;EACC,GAAG;EACH,MAAM,MAAM,OACR,MAAM,QACL,QAA2B;GAC1B,IAAI,MAAM,SAAS,QACjB,OAAO,GAAG,IAAI,MAAM,MAAM,IAAI,CAAC;GAGjC,OAAO,GAAG,UAAU,IAAI,MAAM,CAAC;;EAEtC,GACD;CAEJ,OAAO;EACL,MAAM;EACN;EACA,cAAc,CAACC,gBAAAA,aAAa;EAC5B,OAAO,EACL,oBAAoB,KAAK;GACvB,IAAI,WAAW;IACb;IACA;IACA;IACA;IACA;IACA;IACA,OAAO;IACP;IACA;IACA;IACA;IACA;IACD,CAAC;GACF,IAAI,YAAY,eAAe;IAAE,GAAG;IAAe,GAAG;IAAc,GAAG,cAAc;GACrF,IAAI,iBACF,IAAI,eAAe,gBAAgB;GAErC,IAAI,aAAaC,uBAAAA,eAAe;GAChC,KAAK,MAAM,aAAa,gBACtB,IAAI,aAAa,UAAU;KAGhC;EACF;EACD"}

package/dist/index.d.ts

@@ -1,32 +1,53 @@
 import { t as __name } from "./chunk--u3MIqq1.js";
-import { a as Options, i as printerFaker, n as PrinterFakerNodes, o as PluginFaker, r as PrinterFakerOptions, s as ResolverFaker, t as PrinterFakerFactory } from "./printerFaker-CJiwzoto.js";
-import { t as Faker } from "./Faker-CdyPfOPg.js";
-import { t as fakerGenerator } from "./fakerGenerator-C3Ho3BaI.js";
+import { a as Options, i as printerFaker, n as PrinterFakerNodes, o as PluginFaker, r as PrinterFakerOptions, s as ResolverFaker, t as PrinterFakerFactory } from "./printerFaker-Bhwq62d1.js";
+import { t as Faker } from "./Faker-BaLJxPyl.js";
+import { t as fakerGenerator } from "./fakerGenerator-DSvAJTq3.js";
 import * as _$_kubb_core0 from "@kubb/core";
 
 //#region src/plugin.d.ts
 /**
- * Canonical plugin name for `@kubb/plugin-faker`, used in driver lookups and warnings.
+ * Canonical plugin name for `@kubb/plugin-faker`. Used for driver lookups and
+ * cross-plugin dependency references.
  */
 declare const pluginFakerName = "plugin-faker";
 /**
- * Generates Faker mock data factories from OpenAPI/AST specification.
- *
- * Creates randomized test data and mock helpers from schema definitions.
+ * Generates one mock-data factory per OpenAPI schema using Faker.js. Call
+ * `createPet()` to get a realistic `Pet` object. Useful for tests, Storybook,
+ * and local development without a running backend.
  *
  * @example
- * `import pluginFaker from '@kubb/plugin-faker'; export default defineConfig({ plugins: [pluginFaker({ output: { path: 'mocks' } })], })`
+ * ```ts
+ * import { defineConfig } from 'kubb'
+ * import { pluginTs } from '@kubb/plugin-ts'
+ * import { pluginFaker } from '@kubb/plugin-faker'
+ *
+ * export default defineConfig({
+ *   input: { path: './petStore.yaml' },
+ *   output: { path: './src/gen' },
+ *   plugins: [
+ *     pluginTs(),
+ *     pluginFaker({
+ *       output: { path: './mocks' },
+ *       seed: [100],
+ *     }),
+ *   ],
+ * })
+ * ```
  */
 declare const pluginFaker: (options?: Options | undefined) => _$_kubb_core0.Plugin<PluginFaker>;
 //#endregion
 //#region src/resolvers/resolverFaker.d.ts
 /**
- * Naming convention resolver for Faker plugin.
+ * Default resolver used by `@kubb/plugin-faker`. Decides the names and file
+ * paths for every generated mock factory. Functions and files are prefixed
+ * with `create` so `Pet` becomes `createPet`.
  *
- * Provides default naming helpers using camelCase. Prefixes invalid identifiers with `_`.
+ * @example Resolve a factory name
+ * ```ts
+ * import { resolverFaker } from '@kubb/plugin-faker'
  *
- * @example
- * `resolverFaker.default('list pets', 'function')  // → 'listPets'`
+ * resolverFaker.default('list pets', 'function') // 'createListPets'
+ * ```
  */
 declare const resolverFaker: ResolverFaker;
 //#endregion