@kubb/plugin-faker 4.18.4 → 4.18.5

package/dist/components.d.cts

@@ -1,4 +1,4 @@
-import { i as Schema, n as PluginFaker, o as __name } from "./types-BbUEWsa-.cjs";
+import { i as Schema, n as PluginFaker, o as __name } from "./types-DyfT4xCq.cjs";
 import { KubbNode } from "@kubb/react-fabric/types";
 
 //#region src/components/Faker.d.ts

package/dist/components.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./chunk-eQyhnF5A.js";
-import { i as Schema, n as PluginFaker } from "./types-9jHhHEc_.js";
+import { i as Schema, n as PluginFaker } from "./types-Dbb5nozm.js";
 import { KubbNode } from "@kubb/react-fabric/types";
 
 //#region src/components/Faker.d.ts

package/dist/generators.d.cts

@@ -1,4 +1,4 @@
-import { n as PluginFaker, o as __name, r as ReactGenerator } from "./types-BbUEWsa-.cjs";
+import { n as PluginFaker, o as __name, r as ReactGenerator } from "./types-DyfT4xCq.cjs";
 
 //#region src/generators/fakerGenerator.d.ts
 declare const fakerGenerator: ReactGenerator<PluginFaker>;

package/dist/generators.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./chunk-eQyhnF5A.js";
-import { n as PluginFaker, r as ReactGenerator } from "./types-9jHhHEc_.js";
+import { n as PluginFaker, r as ReactGenerator } from "./types-Dbb5nozm.js";
 
 //#region src/generators/fakerGenerator.d.ts
 declare const fakerGenerator: ReactGenerator<PluginFaker>;

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { a as UserPluginWithLifeCycle, n as PluginFaker, o as __name, t as Options } from "./types-BbUEWsa-.cjs";
+import { a as UserPluginWithLifeCycle, n as PluginFaker, o as __name, t as Options } from "./types-DyfT4xCq.cjs";
 
 //#region src/plugin.d.ts
 declare const pluginFakerName = "plugin-faker";

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./chunk-eQyhnF5A.js";
-import { a as UserPluginWithLifeCycle, n as PluginFaker, t as Options } from "./types-9jHhHEc_.js";
+import { a as UserPluginWithLifeCycle, n as PluginFaker, t as Options } from "./types-Dbb5nozm.js";
 
 //#region src/plugin.d.ts
 declare const pluginFakerName = "plugin-faker";

package/dist/{types-9jHhHEc_.d.ts → types-Dbb5nozm.d.ts}

@@ -305,7 +305,7 @@ type Config<TInput = Input> = {
   input: TInput;
   output: {
     /**
-     * The path where all generated files will be exported.
+     * The path where all generated files receives exported.
      * This can be an absolute path or a path relative to the specified root option.
      */
     path: string;
@@ -320,41 +320,39 @@ type Config<TInput = Input> = {
     write?: boolean;
     /**
      * Specifies the formatting tool to be used.
-     * @default prettier
-     *
-     * Possible values:
-     * - 'auto': Automatically detects and uses biome or prettier (in that order of preference).
-     * - 'prettier': Uses Prettier for code formatting.
-     * - 'biome': Uses Biome for code formatting.
-     *
+     * - 'auto' automatically detects and uses biome or prettier (in that order of preference).
+     * - 'prettier' uses Prettier for code formatting.
+     * - 'biome' uses Biome for code formatting.
+     * - 'oxfmt' uses Oxfmt for code formatting.
+     * - false disables code formatting.
+     * @default 'prettier'
      */
     format?: 'auto' | 'prettier' | 'biome' | 'oxfmt' | false;
     /**
      * Specifies the linter that should be used to analyze the code.
-     * The accepted values indicate different linting tools.
-     *
-     * Possible values:
-     * - 'auto': Automatically detects and uses biome, oxlint, or eslint (in that order of preference).
-     * - 'eslint': Represents the use of ESLint, a widely used JavaScript linter.
-     * - 'biome': Represents the Biome linter, a modern tool for code scanning.
-     * - 'oxlint': Represents the Oxlint tool for linting purposes.
-     *
+     * - 'auto' automatically detects and uses biome, oxlint, or eslint (in that order of preference).
+     * - 'eslint' uses ESLint for linting.
+     * - 'biome' uses Biome for linting.
+     * - 'oxlint' uses Oxlint for linting.
+     * - false disables linting.
+     * @default 'auto'
      */
     lint?: 'auto' | 'eslint' | 'biome' | 'oxlint' | false;
     /**
-     * Override the extension to the generated imports and exports, by default each plugin will add an extension
+     * Overrides the extension for generated imports and exports. By default, each plugin adds an extension.
      * @default { '.ts': '.ts'}
      */
     extension?: Record<KubbFile.Extname, KubbFile.Extname | ''>;
     /**
-     * Specify how `index.ts` files should be created. You can also disable the generation of barrel files here. While each plugin has its own `barrelType` option, this setting controls the creation of the root barrel file, such as` src/gen/index.ts`.
+     * Configures how `index.ts` files are created, including disabling barrel file generation. Each plugin has its own `barrelType` option; this setting controls the root barrel file (e.g., `src/gen/index.ts`).
      * @default 'named'
      */
     barrelType?: Exclude<BarrelType, 'propagate'> | false;
     /**
-     * Add a default banner to the beginning of every generated file. This makes it clear that the file was generated by Kubb.
-     * - 'simple': will only add banner with link to Kubb
-     * - 'full': will add source, title, description and the OpenAPI version used
+     * Adds a default banner to the start of every generated file indicating it was generated by Kubb.
+     * - 'simple' adds banner with link to Kubb.
+     * - 'full' adds source, title, description, and OpenAPI version.
+     * - false disables banner generation.
      * @default 'simple'
      */
     defaultBanner?: 'simple' | 'full' | false;
@@ -367,17 +365,17 @@ type Config<TInput = Input> = {
     override?: boolean;
   };
   /**
-   * An array of Kubb plugins that will be used in the generation.
+   * An array of Kubb plugins that used in the generation.
    * Each plugin may include additional configurable options(defined in the plugin itself).
-   * If a plugin depends on another plugin, an error will be returned if the required dependency is missing. See pre for more details.
+   * If a plugin depends on another plugin, an error is returned if the required dependency is missing. See pre for more details.
    */
   plugins?: Array<Plugin>;
   /**
-   * Hooks that will be called when a specific action is triggered in Kubb.
+   * Hooks triggered when a specific action occurs in Kubb.
    */
   hooks?: {
     /**
-     * Hook that will be triggered at the end of all executions.
+     * Hook that triggers at the end of all executions.
      * Useful for running Prettier or ESLint to format/lint your code.
      */
     done?: string | Array<string>;
@@ -406,7 +404,7 @@ TContext = any,
 TResolvePathOptions extends object = object> = {
   name: TName;
   /**
-   * Same behaviour like what has been done with `QueryKey` in `@tanstack/react-query`
+   * Same behavior like what has been done with `QueryKey` in `@tanstack/react-query`
    */
   key: PluginKey<TName | string>;
   options: TOptions;
@@ -427,12 +425,12 @@ type UserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
    */
   options: TOptions['resolvedOptions'];
   /**
-   * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin will be executed after these plugins.
+   * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin is executed after these plugins.
    * Can be used to validate dependent plugins.
    */
   pre?: Array<string>;
   /**
-   * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin will be executed before these plugins.
+   * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin is executed before these plugins.
    */
   post?: Array<string>;
   inject?: (this: PluginContext<TOptions>, context: PluginContext<TOptions>) => TOptions['context'];
@@ -450,12 +448,12 @@ type Plugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
    */
   key: TOptions['key'];
   /**
-   * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin will be executed after these plugins.
+   * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin is executed after these plugins.
    * Can be used to validate dependent plugins.
    */
   pre?: Array<string>;
   /**
-   * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin will be executed before these plugins.
+   * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin is executed before these plugins.
    */
   post?: Array<string>;
   /**
@@ -505,10 +503,12 @@ type ResolveNameParams = {
   name: string;
   pluginKey?: Plugin['key'];
   /**
-   * `file` will be used to customize the name of the created file(use of camelCase)
-   * `function` can be used to customize the exported functions(use of camelCase)
-   * `type` is a special type for TypeScript(use of PascalCase)
-   * `const` can be used for variables(use of camelCase)
+   * Specifies the type of entity being named.
+   * - 'file' customizes the name of the created file (uses camelCase).
+   * - 'function' customizes the exported function names (uses camelCase).
+   * - 'type' customizes TypeScript types (uses PascalCase).
+   * - 'const' customizes variable names (uses camelCase).
+   * @default undefined
    */
   type?: 'file' | 'function' | 'type' | 'const';
 };
@@ -563,11 +563,14 @@ type GroupContext = {
 };
 type Group = {
   /**
-   * Define a type where to group the files on
+   * Defines the type where to group the files.
+   * - 'tag' groups files by OpenAPI tags.
+   * - 'path' groups files by OpenAPI paths.
+   * @default undefined
    */
   type: 'tag' | 'path';
   /**
-   * Return the name of a group based on the group name, this will be used for the file and name generation
+   * Return the name of a group based on the group name, this used for the file and name generation
    */
   name?: (context: GroupContext) => string;
 };
@@ -639,7 +642,7 @@ declare class PluginManager {
     parameters: PluginParameter<H>;
   }): Array<ReturnType<ParseResult<H>>> | null;
   /**
-   * First non-null result stops and will return it's value.
+   * Returns the first non-null result.
    */
   hookFirst<H extends PluginLifecycleHooks>({
     hookName,
@@ -651,7 +654,7 @@ declare class PluginManager {
     skipped?: ReadonlySet<Plugin> | null;
   }): Promise<SafeParseResult<H>>;
   /**
-   * First non-null result stops and will return it's value.
+   * Returns the first non-null result.
    */
   hookFirstSync<H extends PluginLifecycleHooks>({
     hookName,
@@ -663,15 +666,15 @@ declare class PluginManager {
     skipped?: ReadonlySet<Plugin> | null;
   }): SafeParseResult<H>;
   /**
-   * Run all plugins in parallel(order will be based on `this.plugin` and if `pre` or `post` is set).
+   * Runs all plugins in parallel based on `this.plugin` order and `pre`/`post` settings.
    */
-  hookParallel<H extends PluginLifecycleHooks, TOuput = void>({
+  hookParallel<H extends PluginLifecycleHooks, TOutput = void>({
     hookName,
     parameters
   }: {
     hookName: H;
     parameters?: Parameters<RequiredPluginLifecycle[H]> | undefined;
-  }): Promise<Awaited<TOuput>[]>;
+  }): Promise<Awaited<TOutput>[]>;
   /**
    * Chains plugins
    */
@@ -721,7 +724,7 @@ declare class Oas extends BaseOas {
   getResponseSchema(operation: Operation$1, statusCode: string | number): SchemaObject$1;
   getRequestSchema(operation: Operation$1): SchemaObject$1 | undefined;
   getParametersSchema(operation: Operation$1, inKey: 'path' | 'query' | 'header'): SchemaObject$1 | null;
-  valdiate(): Promise<oas_normalize_lib_types0.ValidationResult>;
+  validate(): Promise<oas_normalize_lib_types0.ValidationResult>;
   flattenSchema(schema: SchemaObject$1 | null): SchemaObject$1 | null;
 }
 //#endregion
@@ -974,8 +977,8 @@ type SchemaKeywordMapper = {
        */
       path: KubbFile.Path;
       /**
-       * When true `File.Import` will be used.
-       * When false a reference will be used inside the current file.
+       * When true `File.Import` is used.
+       * When false a reference is used inside the current file.
        */
       isImportable: boolean;
     };
@@ -1107,7 +1110,7 @@ type SchemaGeneratorOptions = {
      */
     name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
     /**
-     * Receive schema and name(propertName) and return FakerMeta array
+     * Receive schema and name(propertyName) and return FakerMeta array
      * TODO TODO add docs
      * @beta
      */
@@ -1186,7 +1189,7 @@ type Options = {
   output?: Output<Oas>;
   /**
    * Define which contentType should be used.
-   * By default, the first JSON valid mediaType will be used
+   * By default, the first JSON valid mediaType is used
    */
   contentType?: contentType;
   /**
@@ -1206,36 +1209,40 @@ type Options = {
    */
   override?: Array<Override<ResolvedOptions>>;
   /**
-   * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
+   * Choose to use date or datetime as JavaScript Date instead of string.
+   * - 'string' represents dates as string values.
+   * - 'date' represents dates as JavaScript Date objects.
    * @default 'string'
    */
   dateType?: 'string' | 'date';
   /**
-   * Which parser should be used when dateType is set to 'string'.
-   * - Schema with format 'date' will use ISO date format (YYYY-MM-DD)
-   *   - `'dayjs'` will use `dayjs(faker.date.anytime()).format("YYYY-MM-DD")`.
-   *   - `undefined` will use `faker.date.anytime().toString()`
-   * - Schema with format 'time' will use ISO time format (HH:mm:ss[.SSSSSS])
-   *   - `'dayjs'` will use `dayjs(faker.date.anytime()).format("HH:mm:ss")`.
-   *   - `undefined` will use `faker.date.anytime().toString()`
-   * * @default 'faker'
+   * Which parser should be used when dateType is set to string.
+   * - 'faker' uses faker's built-in date formatting methods.
+   * - 'dayjs' uses dayjs for date formatting with custom patterns.
+   * - 'moment' uses moment for date formatting with custom patterns.
+   * @default 'faker'
    */
   dateParser?: 'faker' | 'dayjs' | 'moment' | (string & {});
   /**
-   * Which type to use when the Swagger/OpenAPI file is not providing more information
+   * Which type to use when the Swagger/OpenAPI file is not providing more information.
+   * - 'any' allows any value.
+   * - 'unknown' requires type narrowing before use.
+   * - 'void' represents no value.
    * @default 'any'
    */
   unknownType?: 'any' | 'unknown' | 'void';
   /**
-   * Which type to use for empty schema values
+   * Which type to use for empty schema values.
+   * - 'any' allows any value.
+   * - 'unknown' requires type narrowing before use.
+   * - 'void' represents no value.
    * @default `unknownType`
    */
   emptySchemaType?: 'any' | 'unknown' | 'void';
   /**
    * Choose which generator to use when using Regexp.
-   *
-   * `'faker'` will use `faker.helpers.fromRegExp(new RegExp(/test/))`
-   * `'randexp'` will use `new RandExp(/test/).gen()`
+   * - 'faker' uses faker.helpers.fromRegExp for generating values from regex patterns.
+   * - 'randexp' uses RandExp library for generating values from regex patterns.
    * @default 'faker'
    */
   regexGenerator?: 'faker' | 'randexp';
@@ -1250,7 +1257,7 @@ type Options = {
      */
     name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
     /**
-     * Receive schema and baseName(propertName) and return FakerMeta array
+     * Receive schema and baseName(propertyName) and return FakerMeta array
      * TODO TODO add docs
      * @beta
      */
@@ -1281,4 +1288,4 @@ type ResolvedOptions = {
 type PluginFaker = PluginFactoryOptions<'plugin-faker', Options, ResolvedOptions, never, ResolvePathOptions>;
 //#endregion
 export { UserPluginWithLifeCycle as a, Schema as i, PluginFaker as n, ReactGenerator as r, Options as t };
-//# sourceMappingURL=types-9jHhHEc_.d.ts.map
+//# sourceMappingURL=types-Dbb5nozm.d.ts.map

package/dist/{types-BbUEWsa-.d.cts → types-DyfT4xCq.d.cts}

@@ -306,7 +306,7 @@ type Config<TInput = Input> = {
   input: TInput;
   output: {
     /**
-     * The path where all generated files will be exported.
+     * The path where all generated files receives exported.
      * This can be an absolute path or a path relative to the specified root option.
      */
     path: string;
@@ -321,41 +321,39 @@ type Config<TInput = Input> = {
     write?: boolean;
     /**
      * Specifies the formatting tool to be used.
-     * @default prettier
-     *
-     * Possible values:
-     * - 'auto': Automatically detects and uses biome or prettier (in that order of preference).
-     * - 'prettier': Uses Prettier for code formatting.
-     * - 'biome': Uses Biome for code formatting.
-     *
+     * - 'auto' automatically detects and uses biome or prettier (in that order of preference).
+     * - 'prettier' uses Prettier for code formatting.
+     * - 'biome' uses Biome for code formatting.
+     * - 'oxfmt' uses Oxfmt for code formatting.
+     * - false disables code formatting.
+     * @default 'prettier'
      */
     format?: 'auto' | 'prettier' | 'biome' | 'oxfmt' | false;
     /**
      * Specifies the linter that should be used to analyze the code.
-     * The accepted values indicate different linting tools.
-     *
-     * Possible values:
-     * - 'auto': Automatically detects and uses biome, oxlint, or eslint (in that order of preference).
-     * - 'eslint': Represents the use of ESLint, a widely used JavaScript linter.
-     * - 'biome': Represents the Biome linter, a modern tool for code scanning.
-     * - 'oxlint': Represents the Oxlint tool for linting purposes.
-     *
+     * - 'auto' automatically detects and uses biome, oxlint, or eslint (in that order of preference).
+     * - 'eslint' uses ESLint for linting.
+     * - 'biome' uses Biome for linting.
+     * - 'oxlint' uses Oxlint for linting.
+     * - false disables linting.
+     * @default 'auto'
      */
     lint?: 'auto' | 'eslint' | 'biome' | 'oxlint' | false;
     /**
-     * Override the extension to the generated imports and exports, by default each plugin will add an extension
+     * Overrides the extension for generated imports and exports. By default, each plugin adds an extension.
      * @default { '.ts': '.ts'}
      */
     extension?: Record<KubbFile.Extname, KubbFile.Extname | ''>;
     /**
-     * Specify how `index.ts` files should be created. You can also disable the generation of barrel files here. While each plugin has its own `barrelType` option, this setting controls the creation of the root barrel file, such as` src/gen/index.ts`.
+     * Configures how `index.ts` files are created, including disabling barrel file generation. Each plugin has its own `barrelType` option; this setting controls the root barrel file (e.g., `src/gen/index.ts`).
      * @default 'named'
      */
     barrelType?: Exclude<BarrelType, 'propagate'> | false;
     /**
-     * Add a default banner to the beginning of every generated file. This makes it clear that the file was generated by Kubb.
-     * - 'simple': will only add banner with link to Kubb
-     * - 'full': will add source, title, description and the OpenAPI version used
+     * Adds a default banner to the start of every generated file indicating it was generated by Kubb.
+     * - 'simple' adds banner with link to Kubb.
+     * - 'full' adds source, title, description, and OpenAPI version.
+     * - false disables banner generation.
      * @default 'simple'
      */
     defaultBanner?: 'simple' | 'full' | false;
@@ -368,17 +366,17 @@ type Config<TInput = Input> = {
     override?: boolean;
   };
   /**
-   * An array of Kubb plugins that will be used in the generation.
+   * An array of Kubb plugins that used in the generation.
    * Each plugin may include additional configurable options(defined in the plugin itself).
-   * If a plugin depends on another plugin, an error will be returned if the required dependency is missing. See pre for more details.
+   * If a plugin depends on another plugin, an error is returned if the required dependency is missing. See pre for more details.
    */
   plugins?: Array<Plugin>;
   /**
-   * Hooks that will be called when a specific action is triggered in Kubb.
+   * Hooks triggered when a specific action occurs in Kubb.
    */
   hooks?: {
     /**
-     * Hook that will be triggered at the end of all executions.
+     * Hook that triggers at the end of all executions.
      * Useful for running Prettier or ESLint to format/lint your code.
      */
     done?: string | Array<string>;
@@ -407,7 +405,7 @@ TContext = any,
 TResolvePathOptions extends object = object> = {
   name: TName;
   /**
-   * Same behaviour like what has been done with `QueryKey` in `@tanstack/react-query`
+   * Same behavior like what has been done with `QueryKey` in `@tanstack/react-query`
    */
   key: PluginKey<TName | string>;
   options: TOptions;
@@ -428,12 +426,12 @@ type UserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
    */
   options: TOptions['resolvedOptions'];
   /**
-   * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin will be executed after these plugins.
+   * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin is executed after these plugins.
    * Can be used to validate dependent plugins.
    */
   pre?: Array<string>;
   /**
-   * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin will be executed before these plugins.
+   * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin is executed before these plugins.
    */
   post?: Array<string>;
   inject?: (this: PluginContext<TOptions>, context: PluginContext<TOptions>) => TOptions['context'];
@@ -451,12 +449,12 @@ type Plugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
    */
   key: TOptions['key'];
   /**
-   * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin will be executed after these plugins.
+   * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin is executed after these plugins.
    * Can be used to validate dependent plugins.
    */
   pre?: Array<string>;
   /**
-   * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin will be executed before these plugins.
+   * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin is executed before these plugins.
    */
   post?: Array<string>;
   /**
@@ -506,10 +504,12 @@ type ResolveNameParams = {
   name: string;
   pluginKey?: Plugin['key'];
   /**
-   * `file` will be used to customize the name of the created file(use of camelCase)
-   * `function` can be used to customize the exported functions(use of camelCase)
-   * `type` is a special type for TypeScript(use of PascalCase)
-   * `const` can be used for variables(use of camelCase)
+   * Specifies the type of entity being named.
+   * - 'file' customizes the name of the created file (uses camelCase).
+   * - 'function' customizes the exported function names (uses camelCase).
+   * - 'type' customizes TypeScript types (uses PascalCase).
+   * - 'const' customizes variable names (uses camelCase).
+   * @default undefined
    */
   type?: 'file' | 'function' | 'type' | 'const';
 };
@@ -564,11 +564,14 @@ type GroupContext = {
 };
 type Group = {
   /**
-   * Define a type where to group the files on
+   * Defines the type where to group the files.
+   * - 'tag' groups files by OpenAPI tags.
+   * - 'path' groups files by OpenAPI paths.
+   * @default undefined
    */
   type: 'tag' | 'path';
   /**
-   * Return the name of a group based on the group name, this will be used for the file and name generation
+   * Return the name of a group based on the group name, this used for the file and name generation
    */
   name?: (context: GroupContext) => string;
 };
@@ -640,7 +643,7 @@ declare class PluginManager {
     parameters: PluginParameter<H>;
   }): Array<ReturnType<ParseResult<H>>> | null;
   /**
-   * First non-null result stops and will return it's value.
+   * Returns the first non-null result.
    */
   hookFirst<H extends PluginLifecycleHooks>({
     hookName,
@@ -652,7 +655,7 @@ declare class PluginManager {
     skipped?: ReadonlySet<Plugin> | null;
   }): Promise<SafeParseResult<H>>;
   /**
-   * First non-null result stops and will return it's value.
+   * Returns the first non-null result.
    */
   hookFirstSync<H extends PluginLifecycleHooks>({
     hookName,
@@ -664,15 +667,15 @@ declare class PluginManager {
     skipped?: ReadonlySet<Plugin> | null;
   }): SafeParseResult<H>;
   /**
-   * Run all plugins in parallel(order will be based on `this.plugin` and if `pre` or `post` is set).
+   * Runs all plugins in parallel based on `this.plugin` order and `pre`/`post` settings.
    */
-  hookParallel<H extends PluginLifecycleHooks, TOuput = void>({
+  hookParallel<H extends PluginLifecycleHooks, TOutput = void>({
     hookName,
     parameters
   }: {
     hookName: H;
     parameters?: Parameters<RequiredPluginLifecycle[H]> | undefined;
-  }): Promise<Awaited<TOuput>[]>;
+  }): Promise<Awaited<TOutput>[]>;
   /**
    * Chains plugins
    */
@@ -722,7 +725,7 @@ declare class Oas extends BaseOas {
   getResponseSchema(operation: Operation$1, statusCode: string | number): SchemaObject$1;
   getRequestSchema(operation: Operation$1): SchemaObject$1 | undefined;
   getParametersSchema(operation: Operation$1, inKey: 'path' | 'query' | 'header'): SchemaObject$1 | null;
-  valdiate(): Promise<oas_normalize_lib_types0.ValidationResult>;
+  validate(): Promise<oas_normalize_lib_types0.ValidationResult>;
   flattenSchema(schema: SchemaObject$1 | null): SchemaObject$1 | null;
 }
 //#endregion
@@ -975,8 +978,8 @@ type SchemaKeywordMapper = {
        */
       path: KubbFile.Path;
       /**
-       * When true `File.Import` will be used.
-       * When false a reference will be used inside the current file.
+       * When true `File.Import` is used.
+       * When false a reference is used inside the current file.
        */
       isImportable: boolean;
     };
@@ -1108,7 +1111,7 @@ type SchemaGeneratorOptions = {
      */
     name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
     /**
-     * Receive schema and name(propertName) and return FakerMeta array
+     * Receive schema and name(propertyName) and return FakerMeta array
      * TODO TODO add docs
      * @beta
      */
@@ -1187,7 +1190,7 @@ type Options = {
   output?: Output<Oas>;
   /**
    * Define which contentType should be used.
-   * By default, the first JSON valid mediaType will be used
+   * By default, the first JSON valid mediaType is used
    */
   contentType?: contentType;
   /**
@@ -1207,36 +1210,40 @@ type Options = {
    */
   override?: Array<Override<ResolvedOptions>>;
   /**
-   * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
+   * Choose to use date or datetime as JavaScript Date instead of string.
+   * - 'string' represents dates as string values.
+   * - 'date' represents dates as JavaScript Date objects.
    * @default 'string'
    */
   dateType?: 'string' | 'date';
   /**
-   * Which parser should be used when dateType is set to 'string'.
-   * - Schema with format 'date' will use ISO date format (YYYY-MM-DD)
-   *   - `'dayjs'` will use `dayjs(faker.date.anytime()).format("YYYY-MM-DD")`.
-   *   - `undefined` will use `faker.date.anytime().toString()`
-   * - Schema with format 'time' will use ISO time format (HH:mm:ss[.SSSSSS])
-   *   - `'dayjs'` will use `dayjs(faker.date.anytime()).format("HH:mm:ss")`.
-   *   - `undefined` will use `faker.date.anytime().toString()`
-   * * @default 'faker'
+   * Which parser should be used when dateType is set to string.
+   * - 'faker' uses faker's built-in date formatting methods.
+   * - 'dayjs' uses dayjs for date formatting with custom patterns.
+   * - 'moment' uses moment for date formatting with custom patterns.
+   * @default 'faker'
    */
   dateParser?: 'faker' | 'dayjs' | 'moment' | (string & {});
   /**
-   * Which type to use when the Swagger/OpenAPI file is not providing more information
+   * Which type to use when the Swagger/OpenAPI file is not providing more information.
+   * - 'any' allows any value.
+   * - 'unknown' requires type narrowing before use.
+   * - 'void' represents no value.
    * @default 'any'
    */
   unknownType?: 'any' | 'unknown' | 'void';
   /**
-   * Which type to use for empty schema values
+   * Which type to use for empty schema values.
+   * - 'any' allows any value.
+   * - 'unknown' requires type narrowing before use.
+   * - 'void' represents no value.
    * @default `unknownType`
    */
   emptySchemaType?: 'any' | 'unknown' | 'void';
   /**
    * Choose which generator to use when using Regexp.
-   *
-   * `'faker'` will use `faker.helpers.fromRegExp(new RegExp(/test/))`
-   * `'randexp'` will use `new RandExp(/test/).gen()`
+   * - 'faker' uses faker.helpers.fromRegExp for generating values from regex patterns.
+   * - 'randexp' uses RandExp library for generating values from regex patterns.
    * @default 'faker'
    */
   regexGenerator?: 'faker' | 'randexp';
@@ -1251,7 +1258,7 @@ type Options = {
      */
     name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
     /**
-     * Receive schema and baseName(propertName) and return FakerMeta array
+     * Receive schema and baseName(propertyName) and return FakerMeta array
      * TODO TODO add docs
      * @beta
      */
@@ -1282,4 +1289,4 @@ type ResolvedOptions = {
 type PluginFaker = PluginFactoryOptions<'plugin-faker', Options, ResolvedOptions, never, ResolvePathOptions>;
 //#endregion
 export { UserPluginWithLifeCycle as a, Schema as i, PluginFaker as n, __name as o, ReactGenerator as r, Options as t };
-//# sourceMappingURL=types-BbUEWsa-.d.cts.map
+//# sourceMappingURL=types-DyfT4xCq.d.cts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-faker",
-  "version": "4.18.4",
+  "version": "4.18.5",
   "description": "Faker.js data generator plugin for Kubb, creating realistic mock data from OpenAPI specifications for development and testing.",
   "keywords": [
     "faker",
@@ -69,10 +69,10 @@
   ],
   "dependencies": {
     "@kubb/react-fabric": "0.12.4",
-    "@kubb/core": "4.18.4",
-    "@kubb/oas": "4.18.4",
-    "@kubb/plugin-oas": "4.18.4",
-    "@kubb/plugin-ts": "4.18.4"
+    "@kubb/core": "4.18.5",
+    "@kubb/oas": "4.18.5",
+    "@kubb/plugin-oas": "4.18.5",
+    "@kubb/plugin-ts": "4.18.5"
   },
   "engines": {
     "node": ">=20"

package/src/types.ts

@@ -12,7 +12,7 @@ export type Options = {
   output?: Output<Oas>
   /**
    * Define which contentType should be used.
-   * By default, the first JSON valid mediaType will be used
+   * By default, the first JSON valid mediaType is used
    */
   contentType?: contentType
   /**
@@ -32,36 +32,40 @@ export type Options = {
    */
   override?: Array<Override<ResolvedOptions>>
   /**
-   * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
+   * Choose to use date or datetime as JavaScript Date instead of string.
+   * - 'string' represents dates as string values.
+   * - 'date' represents dates as JavaScript Date objects.
    * @default 'string'
    */
   dateType?: 'string' | 'date'
   /**
-   * Which parser should be used when dateType is set to 'string'.
-   * - Schema with format 'date' will use ISO date format (YYYY-MM-DD)
-   *   - `'dayjs'` will use `dayjs(faker.date.anytime()).format("YYYY-MM-DD")`.
-   *   - `undefined` will use `faker.date.anytime().toString()`
-   * - Schema with format 'time' will use ISO time format (HH:mm:ss[.SSSSSS])
-   *   - `'dayjs'` will use `dayjs(faker.date.anytime()).format("HH:mm:ss")`.
-   *   - `undefined` will use `faker.date.anytime().toString()`
-   * * @default 'faker'
+   * Which parser should be used when dateType is set to string.
+   * - 'faker' uses faker's built-in date formatting methods.
+   * - 'dayjs' uses dayjs for date formatting with custom patterns.
+   * - 'moment' uses moment for date formatting with custom patterns.
+   * @default 'faker'
    */
   dateParser?: 'faker' | 'dayjs' | 'moment' | (string & {})
   /**
-   * Which type to use when the Swagger/OpenAPI file is not providing more information
+   * Which type to use when the Swagger/OpenAPI file is not providing more information.
+   * - 'any' allows any value.
+   * - 'unknown' requires type narrowing before use.
+   * - 'void' represents no value.
    * @default 'any'
    */
   unknownType?: 'any' | 'unknown' | 'void'
   /**
-   * Which type to use for empty schema values
+   * Which type to use for empty schema values.
+   * - 'any' allows any value.
+   * - 'unknown' requires type narrowing before use.
+   * - 'void' represents no value.
    * @default `unknownType`
    */
   emptySchemaType?: 'any' | 'unknown' | 'void'
   /**
    * Choose which generator to use when using Regexp.
-   *
-   * `'faker'` will use `faker.helpers.fromRegExp(new RegExp(/test/))`
-   * `'randexp'` will use `new RandExp(/test/).gen()`
+   * - 'faker' uses faker.helpers.fromRegExp for generating values from regex patterns.
+   * - 'randexp' uses RandExp library for generating values from regex patterns.
    * @default 'faker'
    */
   regexGenerator?: 'faker' | 'randexp'
@@ -77,7 +81,7 @@ export type Options = {
      */
     name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string
     /**
-     * Receive schema and baseName(propertName) and return FakerMeta array
+     * Receive schema and baseName(propertyName) and return FakerMeta array
      * TODO TODO add docs
      * @beta
      */