@kubb/plugin-ts 5.0.0-alpha.23 → 5.0.0-alpha.25

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { t as __name } from "./chunk--u3MIqq1.js";
-import ts from "typescript";
 import { OperationParamsResolver } from "@kubb/ast";
+import ts from "typescript";
 import * as _$_kubb_core0 from "@kubb/core";
 import { CompatibilityPreset, Exclude, Generator, Group, Include, Output, Override, PluginFactoryOptions, PrinterFactoryOptions, ResolvePathOptions, Resolver, UserGroup } from "@kubb/core";
 import { EnumSchemaNode, FunctionNode, OperationNode, ParameterNode, SchemaNode, StatusCode, Visitor } from "@kubb/ast/types";
@@ -27,7 +27,10 @@ type ResolverTs = Resolver & OperationParamsResolver & {
    * @example
    * resolver.resolvePathName('list pets', 'file') // → 'ListPets'
    */
-  resolvePathName(name: string, type?: 'file' | 'function' | 'type' | 'const'): string; /** Resolves the request body type name (required on ResolverTs). */
+  resolvePathName(name: string, type?: 'file' | 'function' | 'type' | 'const'): string;
+  /**
+   * Resolves the request body type name for an operation (required on ResolverTs).
+   */
   resolveDataName(node: OperationNode): string;
   /**
    * Resolves the name for an operation response by status code.
@@ -67,7 +70,9 @@ type ResolverTs = Resolver & OperationParamsResolver & {
    * resolver.resolveEnumKeyName(node, 'Value') // → 'PetStatusValue'
    * resolver.resolveEnumKeyName(node, '')      // → 'PetStatus'
    */
-  resolveEnumKeyName(node: SchemaNode, enumTypeSuffix: string): string;
+  resolveEnumKeyName(node: {
+    name?: string | null;
+  }, enumTypeSuffix: string): string;
   /**
    * Resolves the name for an operation's grouped path parameters type.
    *
@@ -90,6 +95,87 @@ type ResolverTs = Resolver & OperationParamsResolver & {
    */
   resolveHeaderParamsName(node: OperationNode, param: ParameterNode): string;
 };
+type EnumKeyCasing = 'screamingSnakeCase' | 'snakeCase' | 'pascalCase' | 'camelCase' | 'none';
+/**
+ * Discriminated union that ties `enumTypeSuffix` and `enumKeyCasing` to the enum types that actually use them.
+ *
+ * - `'asConst'` / `'asPascalConst'` — emit a `const` object; both `enumTypeSuffix` (type-alias suffix) and
+ *    `enumKeyCasing` (key formatting) are meaningful.
+ * - `'enum'` / `'constEnum'` — emit a TypeScript enum; `enumKeyCasing` applies to member names,
+ *    but there is no separate type alias so `enumTypeSuffix` is not used.
+ * - `'literal'` / `'inlineLiteral'` — emit only union literals; keys are discarded entirely,
+ *    so neither `enumTypeSuffix` nor `enumKeyCasing` have any effect.
+ */
+type EnumTypeOptions = {
+  /**
+   * Choose to use enum, asConst, asPascalConst, constEnum, literal, or inlineLiteral for enums.
+   * - 'asConst' generates const objects with camelCase names and as const assertion.
+   * - 'asPascalConst' generates const objects with PascalCase names and as const assertion.
+   * @default 'asConst'
+   */
+  enumType?: 'asConst' | 'asPascalConst';
+  /**
+   * Suffix appended to the generated type alias name.
+   *
+   * Only affects the type alias — the const object name is unchanged.
+   *
+   * @default 'Key'
+   * @example enumTypeSuffix: 'Value' → `export type PetStatusValue = …`
+   */
+  enumTypeSuffix?: string;
+  /**
+   * Choose the casing for enum key names.
+   * - '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?: EnumKeyCasing;
+} | {
+  /**
+   * Choose to use enum, asConst, asPascalConst, constEnum, literal, or inlineLiteral for enums.
+   * - 'enum' generates TypeScript enum declarations.
+   * - 'constEnum' generates TypeScript const enum declarations.
+   * @default 'asConst'
+   */
+  enumType?: 'enum' | 'constEnum';
+  /**
+   * `enumTypeSuffix` has no effect for this `enumType`.
+   * It is only used when `enumType` is `'asConst'` or `'asPascalConst'`.
+   */
+  enumTypeSuffix?: never;
+  /**
+   * Choose the casing for enum key names.
+   * - '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?: EnumKeyCasing;
+} | {
+  /**
+   * Choose to use enum, asConst, asPascalConst, constEnum, literal, or inlineLiteral for enums.
+   * - 'literal' generates literal union types.
+   * - 'inlineLiteral' will inline enum values directly into the type (default in v5).
+   * @default 'asConst'
+   * @note In Kubb v5, 'inlineLiteral' becomes the default.
+   */
+  enumType?: 'literal' | 'inlineLiteral';
+  /**
+   * `enumTypeSuffix` has no effect for this `enumType`.
+   * It is only used when `enumType` is `'asConst'` or `'asPascalConst'`.
+   */
+  enumTypeSuffix?: never;
+  /**
+   * `enumKeyCasing` has no effect for this `enumType`.
+   * Literal and inlineLiteral modes emit only values — keys are discarded entirely.
+   */
+  enumKeyCasing?: never;
+};
 type Options = {
   /**
    * Specify the export location for the files and define the behavior of the output
@@ -117,37 +203,6 @@ type Options = {
    * Array containing override parameters to override `options` based on tags/operations/methods/paths.
    */
   override?: Array<Override<ResolvedOptions>>;
-  /**
-   * 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' inline enum values directly into the type (default in v5).
-   * @default 'asConst'
-   * @note In Kubb v5, 'inlineLiteral' becomes the default.
-   */
-  enumType?: 'enum' | 'asConst' | 'asPascalConst' | 'constEnum' | 'literal' | 'inlineLiteral';
-  /**
-   * Suffix appended to the generated type alias name when `enumType` is `asConst` or `asPascalConst`.
-   *
-   * Only affects the type alias — the const object name is unchanged.
-   *
-   * @default 'Key'
-   * @example enumTypeSuffix: 'Value' → `export type PetStatusValue = …`
-   */
-  enumTypeSuffix?: string;
-  /**
-   * Choose the casing for enum key names.
-   * - '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.
    * - 'type' generates type alias declarations.
@@ -218,13 +273,13 @@ type Options = {
    * ```
    */
   transformers?: Array<Visitor>;
-};
+} & EnumTypeOptions;
 type ResolvedOptions = {
   output: Output;
   group: Group | undefined;
   enumType: NonNullable<Options['enumType']>;
   enumTypeSuffix: NonNullable<Options['enumTypeSuffix']>;
-  enumKeyCasing: NonNullable<Options['enumKeyCasing']>;
+  enumKeyCasing: EnumKeyCasing;
   optionalType: NonNullable<Options['optionalType']>;
   arrayType: NonNullable<Options['arrayType']>;
   syntaxType: NonNullable<Options['syntaxType']>;
@@ -280,6 +335,12 @@ type Props = {
   resolver: PluginTs['resolver'];
   description?: string;
   keysToOmit?: string[];
+  /**
+   * Names of top-level schemas that are enums.
+   * Used so the printer's `ref` handler can use the suffixed type name (e.g. `StatusKey`)
+   * instead of the plain PascalCase name (e.g. `Status`) when resolving `$ref` enum targets.
+   */
+  enumSchemaNames?: Set<string>;
 };
 declare function Type({
   name,
@@ -292,7 +353,8 @@ declare function Type({
   enumTypeSuffix,
   enumKeyCasing,
   description,
-  resolver
+  resolver,
+  enumSchemaNames
 }: Props): FabricReactNode;
 //#endregion
 //#region src/generators/typeGenerator.d.ts
@@ -411,6 +473,12 @@ type TsOptions = {
    * Resolver used to transform raw schema names into valid TypeScript identifiers.
    */
   resolver: ResolverTs;
+  /**
+   * Names of top-level schemas that are enums.
+   * When set, the `ref` handler uses the suffixed type name (e.g. `StatusKey`) for enum refs
+   * instead of the plain PascalCase name, so imports align with what the enum file actually exports.
+   */
+  enumSchemaNames?: Set<string>;
 };
 /**
  * TypeScript printer factory options: maps `SchemaNode` → `ts.TypeNode` (raw) or `ts.Node` (full declaration).