@kubb/plugin-ts 4.18.4 → 4.18.5

package/dist/{types-BmA-vXVc.d.cts → types-BMfQRWAb.d.cts}

@@ -39,7 +39,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
@@ -341,7 +341,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;
@@ -356,41 +356,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;
@@ -403,17 +401,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>;
@@ -442,7 +440,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;
@@ -463,12 +461,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'];
@@ -486,12 +484,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>;
   /**
@@ -541,10 +539,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';
 };
@@ -599,11 +599,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;
 };
@@ -675,7 +678,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,
@@ -687,7 +690,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,
@@ -699,15 +702,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
    */
@@ -976,8 +979,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;
     };
@@ -1109,7 +1112,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
      */
@@ -1188,7 +1191,7 @@ type Options = {
   output?: Output<Oas>;
   /**
    * Define which contentType should be used.
-   * By default, the first JSON valid mediaType will be used
+   * By default, uses the first valid JSON media type.
    */
   contentType?: contentType;
   /**
@@ -1208,29 +1211,31 @@ type Options = {
    */
   override?: Array<Override<ResolvedOptions>>;
   /**
-   * Choose to use `enum`, `asConst`, `asPascalConst`, `constEnum`, `literal`, or `inlineLiteral` for enums.
-   * - `enum`: TypeScript enum
-   * - `asConst`: const with camelCase name (e.g., `petType`)
-   * - `asPascalConst`: const with PascalCase name (e.g., `PetType`)
-   * - `constEnum`: const enum
-   * - `literal`: literal union type
-   * - `inlineLiteral`: inline enum values directly into the type (default in v5)
+   * Choose to use enum, asConst, asPascalConst, constEnum, literal, or inlineLiteral for enums.
+   * - 'enum' generates TypeScript enum declarations.
+   * - 'asConst' generates const objects with camelCase names and as const assertion.
+   * - 'asPascalConst' generates const objects with PascalCase names and as const assertion.
+   * - 'constEnum' generates TypeScript const enum declarations.
+   * - 'literal' generates literal union types.
+   * - 'inlineLiteral' inlines enum values directly into the type (default in v5).
    * @default 'asConst'
-   * @note In Kubb v5, `inlineLiteral` will become the default.
+   * @note In Kubb v5, 'inlineLiteral' becomes the default.
    */
   enumType?: 'enum' | 'asConst' | 'asPascalConst' | 'constEnum' | 'literal' | 'inlineLiteral';
   /**
    * Choose the casing for enum key names.
-   * - `'screamingSnakeCase'`: ENUM_VALUE
-   * - `'snakeCase'`: enum_value
-   * - `'pascalCase'`: EnumValue
-   * - `'camelCase'`: enumValue
-   * - `'none'`: Uses the enum value as-is
+   * - 'screamingSnakeCase' generates keys in SCREAMING_SNAKE_CASE format.
+   * - 'snakeCase' generates keys in snake_case format.
+   * - 'pascalCase' generates keys in PascalCase format.
+   * - 'camelCase' generates keys in camelCase format.
+   * - 'none' uses the enum value as-is without transformation.
    * @default 'none'
    */
   enumKeyCasing?: 'screamingSnakeCase' | 'snakeCase' | 'pascalCase' | 'camelCase' | 'none';
   /**
-   * Switch between type or interface for creating TypeScript types
+   * Switch between type or interface for creating TypeScript types.
+   * - 'type' generates type alias declarations.
+   * - 'interface' generates interface declarations.
    * @default 'type'
    */
   syntaxType?: 'type' | 'interface';
@@ -1240,32 +1245,40 @@ type Options = {
    */
   enumSuffix?: string;
   /**
-   * 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 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 what to use as mode for an optional value.
-   * @examples 'questionToken': type?: string
-   * @examples 'undefined': type: string | undefined
-   * @examples 'questionTokenAndUndefined': type?: string | undefined
+   * - 'questionToken' marks the property as optional with ? (e.g., type?: string).
+   * - 'undefined' adds undefined to the type union (e.g., type: string | undefined).
+   * - 'questionTokenAndUndefined' combines both approaches (e.g., type?: string | undefined).
    * @default 'questionToken'
    */
   optionalType?: 'questionToken' | 'undefined' | 'questionTokenAndUndefined';
   /**
-   * Choose between `Array<string>` or `string[]` for array types.
-   * - `generic`: Array<Type>
-   * - `array`: Type[]
+   * Choose between Array<string> or string[] for array types.
+   * - 'generic' generates Array<Type> syntax.
+   * - 'array' generates Type[] syntax.
    * @default 'array'
    */
   arrayType?: 'generic' | 'array';
@@ -1314,4 +1327,4 @@ type ResolvedOptions = {
 type PluginTs = PluginFactoryOptions<'plugin-ts', Options, ResolvedOptions, never, ResolvePathOptions>;
 //#endregion
 export { UserPluginWithLifeCycle as a, Schema as i, PluginTs as n, SchemaObject$1 as o, ReactGenerator as r, __name as s, Options as t };
-//# sourceMappingURL=types-BmA-vXVc.d.cts.map
+//# sourceMappingURL=types-BMfQRWAb.d.cts.map