@kubb/core 5.0.0-alpha.9 → 5.0.0-beta.10

package/dist/index.d.ts

@@ -1,177 +1,191 @@
 import { t as __name } from "./chunk--u3MIqq1.js";
-import { A as UserConfig, B as Storage, C as PluginWithLifeCycle, D as ResolveOptionsContext, E as ResolveNameParams, F as CoreGeneratorV2, G as AsyncEventEmitter, H as formatters, I as Generator, L as ReactGeneratorV2, M as UserPlugin, N as UserPluginWithLifeCycle, O as ResolvePathParams, P as UserResolver, R as defineGenerator, S as PluginParameter, T as PrinterFactoryOptions, U as linters, V as createStorage, W as logLevel, _ as Plugin, a as AdapterFactoryOptions, b as PluginLifecycle, c as Config, d as InputData, f as InputPath, g as Output, h as LoggerOptions, i as Adapter, j as UserLogger, k as Resolver, l as DevtoolsOptions, m as LoggerContext, n as PluginDriver, o as AdapterSource, p as Logger, r as getMode, s as BarrelType, u as Group, v as PluginContext, w as Printer, x as PluginLifecycleHooks, y as PluginFactoryOptions, z as KubbEvents } from "./PluginDriver-BkFepPdm.js";
-import { definePrinter } from "@kubb/ast";
-import { Node } from "@kubb/ast/types";
-import { Fabric, KubbFile } from "@kubb/fabric-core/types";
+import { $ as ResolverPathParams, A as isInputPath, B as KubbPluginSetupContext, C as KubbPluginsEndContext, D as PossibleConfig, E as KubbWarnContext, F as FileManager, G as Plugin, H as NormalizedPlugin, I as Exclude, J as ResolveBannerContext, K as PluginFactoryOptions, L as Group, M as GeneratorContext, N as defineGenerator, O as UserConfig, P as PluginDriver, Q as ResolverFileParams, R as Include, S as KubbLifecycleStartContext, T as KubbVersionNewContext, U as Output, V as KubbPluginStartContext, W as Override, X as Resolver, Y as ResolveOptionsContext, Z as ResolverContext, _ as KubbGenerationSummaryContext, _t as AdapterFactoryOptions, a as InputPath, at as Logger, b as KubbHooks, bt as logLevel, c as KubbBuildStartContext, ct as UserLogger, d as KubbErrorContext, dt as Storage, et as defineResolver, f as KubbFileProcessingUpdateContext, ft as createStorage, g as KubbGenerationStartContext, gt as Adapter, h as KubbGenerationEndContext, ht as createRenderer, i as InputData, it as defineMiddleware, j as Generator, k as createKubb, l as KubbConfigEndContext, lt as defineLogger, m as KubbFilesProcessingStartContext, mt as RendererFactory, n as CLIOptions, nt as defineParser, o as Kubb, ot as LoggerContext, p as KubbFilesProcessingEndContext, pt as Renderer, q as definePlugin, r as Config, rt as Middleware, s as KubbBuildEndContext, st as LoggerOptions, t as BuildOutput, tt as Parser, u as KubbDebugContext, ut as DevtoolsOptions, v as KubbHookEndContext, vt as AdapterSource, w as KubbSuccessContext, x as KubbInfoContext, xt as AsyncEventEmitter, y as KubbHookStartContext, yt as createAdapter, z as KubbPluginEndContext } from "./createKubb-ALdb8lmq.js";
+import * as ast from "@kubb/ast";
+import { FileNode } from "@kubb/ast";
 
-//#region src/build.d.ts
-type BuildOptions = {
-  config: UserConfig;
-  events?: AsyncEventEmitter<KubbEvents>;
-};
-type BuildOutput = {
-  failedPlugins: Set<{
-    plugin: Plugin;
-    error: Error;
-  }>;
-  fabric: Fabric;
-  files: Array<KubbFile.ResolvedFile>;
-  driver: PluginDriver;
-  pluginTimings: Map<string, number>;
-  error?: Error;
-  sources: Map<KubbFile.Path, string>;
+//#region ../../internals/utils/src/urlPath.d.ts
+type URLObject = {
+  /**
+   * The resolved URL string (Express-style or template literal, depending on context).
+   */
+  url: string;
+  /**
+   * Extracted path parameters as a key-value map, or `undefined` when the path has none.
+   */
+  params?: Record<string, string>;
 };
-type SetupResult = {
-  events: AsyncEventEmitter<KubbEvents>;
-  fabric: Fabric;
-  driver: PluginDriver;
-  sources: Map<KubbFile.Path, string>;
+type ObjectOptions = {
+  /**
+   * Controls whether the `url` is rendered as an Express path or a template literal.
+   * @default 'path'
+   */
+  type?: 'path' | 'template';
+  /**
+   * Optional transform applied to each extracted parameter name.
+   */
+  replacer?: (pathParam: string) => string;
+  /**
+   * When `true`, the result is serialized to a string expression instead of a plain object.
+   */
+  stringify?: boolean;
 };
-declare function setup(options: BuildOptions): Promise<SetupResult>;
-declare function build(options: BuildOptions, overrides?: SetupResult): Promise<BuildOutput>;
-declare function safeBuild(options: BuildOptions, overrides?: SetupResult): Promise<BuildOutput>;
-//#endregion
-//#region src/config.d.ts
 /**
- * CLI options derived from command-line flags.
+ * Supported identifier casing strategies for path parameters.
  */
-type CLIOptions = {
-  /** Path to `kubb.config.js` */config?: string; /** Enable watch mode for input files */
-  watch?: boolean;
+type PathCasing = 'camelcase';
+type Options = {
   /**
-   * Logging verbosity for CLI usage.
-   *
-   * - `silent`: hide non-essential logs
-   * - `info`: show general logs (non-plugin-related)
-   * - `debug`: include detailed plugin lifecycle logs
-   * @default 'silent'
+   * Casing strategy applied to path parameter names.
+   * @default undefined (original identifier preserved)
    */
-  logLevel?: 'silent' | 'info' | 'debug'; /** Run Kubb with Bun */
-  bun?: boolean;
+  casing?: PathCasing;
 };
-/** All accepted forms of a Kubb configuration. */
-type ConfigInput = PossiblePromise<UserConfig | UserConfig[]> | ((cli: CLIOptions) => PossiblePromise<UserConfig | UserConfig[]>);
-/**
- * Helper for defining a Kubb configuration.
- *
- * Accepts either:
- * - A config object or array of configs
- * - A function returning the config(s), optionally async,
- *   receiving the CLI options as argument
- *
- * @example
- * export default defineConfig(({ logLevel }) => ({
- *   root: 'src',
- *   plugins: [myPlugin()],
- * }))
- */
-declare function defineConfig(config: (cli: CLIOptions) => PossiblePromise<UserConfig | UserConfig[]>): typeof config;
-declare function defineConfig(config: PossiblePromise<UserConfig | UserConfig[]>): typeof config;
-/**
- * Type guard to check if a given config has an `input.path`.
- */
-declare function isInputPath(config: UserConfig | undefined): config is UserConfig<InputPath>;
-//#endregion
-//#region src/createAdapter.d.ts
-/**
- * Builder type for an {@link Adapter} — takes options and returns the adapter instance.
- */
-type AdapterBuilder<T extends AdapterFactoryOptions> = (options: T['options']) => Adapter<T>;
-/**
- * Creates an adapter factory. Call the returned function with optional options to get the adapter instance.
- *
- * @example
- * export const myAdapter = createAdapter<MyAdapter>((options) => {
- *   return {
- *     name: 'my-adapter',
- *     options,
- *     async parse(source) { ... },
- *   }
- * })
- *
- * // instantiate
- * const adapter = myAdapter({ validate: true })
- */
-declare function createAdapter<T extends AdapterFactoryOptions = AdapterFactoryOptions>(build: AdapterBuilder<T>): (options?: T['options']) => Adapter<T>;
-//#endregion
-//#region src/createPlugin.d.ts
-/**
- * Builder type for a {@link UserPluginWithLifeCycle} — takes options and returns the plugin instance.
- */
-type PluginBuilder<T extends PluginFactoryOptions = PluginFactoryOptions> = (options: T['options']) => UserPluginWithLifeCycle<T>;
-/**
- * Creates a plugin factory. Call the returned function with optional options to get the plugin instance.
- *
- * @example
- * export const myPlugin = createPlugin<MyPlugin>((options) => {
- *   return {
- *     name: 'my-plugin',
- *     options,
- *     resolvePath(baseName) { ... },
- *     resolveName(name, type) { ... },
- *   }
- * })
- *
- * // instantiate
- * const plugin = myPlugin({ output: { path: 'src/gen' } })
- */
-declare function createPlugin<T extends PluginFactoryOptions = PluginFactoryOptions>(build: PluginBuilder<T>): (options?: T['options']) => UserPluginWithLifeCycle<T>;
-//#endregion
-//#region src/defineLogger.d.ts
 /**
- * Wraps a logger definition into a typed {@link Logger}.
+ * Parses and transforms an OpenAPI/Swagger path string into various URL formats.
  *
  * @example
- * export const myLogger = defineLogger({
- *   name: 'my-logger',
- *   install(context, options) {
- *     context.on('info', (message) => console.log('ℹ', message))
- *     context.on('error', (error) => console.error('✗', error.message))
- *   },
- * })
+ * const p = new URLPath('/pet/{petId}')
+ * p.URL      // '/pet/:petId'
+ * p.template // '`/pet/${petId}`'
  */
-declare function defineLogger<Options extends LoggerOptions = LoggerOptions>(logger: UserLogger<Options>): Logger<Options>;
+declare class URLPath {
+  #private;
+  /**
+   * The raw OpenAPI/Swagger path string, e.g. `/pet/{petId}`.
+   */
+  path: string;
+  constructor(path: string, options?: Options);
+  /** Converts the OpenAPI path to Express-style colon syntax, e.g. `/pet/{petId}` → `/pet/:petId`.
+   *
+   * @example
+   * ```ts
+   * new URLPath('/pet/{petId}').URL // '/pet/:petId'
+   * ```
+   */
+  get URL(): string;
+  /** Returns `true` when `path` is a fully-qualified URL (e.g. starts with `https://`).
+   *
+   * @example
+   * ```ts
+   * new URLPath('https://petstore.swagger.io/v2/pet').isURL // true
+   * new URLPath('/pet/{petId}').isURL                       // false
+   * ```
+   */
+  get isURL(): boolean;
+  /**
+   * Converts the OpenAPI path to a TypeScript template literal string.
+   *
+   * @example
+   * new URLPath('/pet/{petId}').template              // '`/pet/${petId}`'
+   * new URLPath('/account/monetary-accountID').template // '`/account/${monetaryAccountId}`'
+   */
+  get template(): string;
+  /** Returns the path and its extracted params as a structured `URLObject`, or as a stringified expression when `stringify` is set.
+   *
+   * @example
+   * ```ts
+   * new URLPath('/pet/{petId}').object
+   * // { url: '/pet/:petId', params: { petId: 'petId' } }
+   * ```
+   */
+  get object(): URLObject | string;
+  /** Returns a map of path parameter names, or `undefined` when the path has no parameters.
+   *
+   * @example
+   * ```ts
+   * new URLPath('/pet/{petId}').params // { petId: 'petId' }
+   * new URLPath('/pet').params         // undefined
+   * ```
+   */
+  get params(): Record<string, string> | undefined;
+  toObject({
+    type,
+    replacer,
+    stringify
+  }?: ObjectOptions): URLObject | string;
+  /**
+   * Converts the OpenAPI path to a TypeScript template literal string.
+   * An optional `replacer` can transform each extracted parameter name before interpolation.
+   *
+   * @example
+   * new URLPath('/pet/{petId}').toTemplateString() // '`/pet/${petId}`'
+   */
+  toTemplateString({
+    prefix,
+    replacer
+  }?: {
+    prefix?: string;
+    replacer?: (pathParam: string) => string;
+  }): string;
+  /**
+   * Extracts all `{param}` segments from the path and returns them as a key-value map.
+   * An optional `replacer` transforms each parameter name in both key and value positions.
+   * Returns `undefined` when no path parameters are found.
+   *
+   * @example
+   * ```ts
+   * new URLPath('/pet/{petId}/tag/{tagId}').getParams()
+   * // { petId: 'petId', tagId: 'tagId' }
+   * ```
+   */
+  getParams(replacer?: (pathParam: string) => string): Record<string, string> | undefined;
+  /** Converts the OpenAPI path to Express-style colon syntax.
+   *
+   * @example
+   * ```ts
+   * new URLPath('/pet/{petId}').toURLPath() // '/pet/:petId'
+   * ```
+   */
+  toURLPath(): string;
+}
 //#endregion
-//#region src/defineResolver.d.ts
-/**
- * Builder type for the plugin-specific resolver fields.
- * `default` and `resolveOptions` are optional — built-in fallbacks are used when omitted.
- */
-type ResolverBuilder<T extends PluginFactoryOptions> = () => Omit<T['resolver'], 'default' | 'resolveOptions'> & Partial<Pick<T['resolver'], 'default' | 'resolveOptions'>> & ThisType<T['resolver']>;
-/**
- * Default option resolver — applies include/exclude filters and merges any matching override options.
- * Returns `null` when the node is filtered out.
- */
-declare function defaultResolveOptions<TOptions>(node: Node, {
-  options,
-  exclude,
-  include,
-  override
-}: ResolveOptionsContext<TOptions>): TOptions | null;
+//#region src/FileProcessor.d.ts
+type ParseOptions = {
+  parsers?: Map<FileNode['extname'], Parser>;
+  extension?: Record<FileNode['extname'], FileNode['extname'] | ''>;
+};
+type RunOptions = ParseOptions & {
+  /**
+   * @default 'sequential'
+   */
+  mode?: 'sequential' | 'parallel';
+  onStart?: (files: Array<FileNode>) => Promise<void> | void;
+  onEnd?: (files: Array<FileNode>) => Promise<void> | void;
+  onUpdate?: (params: {
+    file: FileNode;
+    source?: string;
+    processed: number;
+    total: number;
+    percentage: number;
+  }) => Promise<void> | void;
+};
 /**
- * Defines a resolver for a plugin, with built-in defaults for name casing and include/exclude/override filtering.
- * Override `default` or `resolveOptions` in the builder to customize the behavior.
+ * Converts a single file to a string using the registered parsers.
+ * Falls back to joining source values when no matching parser is found.
  *
- * @example
- * export const resolver = defineResolver<PluginTs>(() => ({
- *   resolveName(name) {
- *     return this.default(name, 'function')
- *   },
- *   resolveTypedName(name) {
- *     return this.default(name, 'type')
- *   },
- *   resolveParamName(node, param) {
- *     return this.resolveName(`${node.operationId} ${param.in} ${param.name}`)
- *   },
- * }))
+ * @internal
  */
-declare function defineResolver<T extends PluginFactoryOptions>(build: ResolverBuilder<T>): T['resolver'];
+declare class FileProcessor {
+  #private;
+  parse(file: FileNode, {
+    parsers,
+    extension
+  }?: ParseOptions): Promise<string>;
+  run(files: Array<FileNode>, {
+    parsers,
+    mode,
+    extension,
+    onStart,
+    onEnd,
+    onUpdate
+  }?: RunOptions): Promise<Array<FileNode>>;
+}
 //#endregion
 //#region src/storages/fsStorage.d.ts
 /**
  * Built-in filesystem storage driver.
  *
- * This is the default storage when no `storage` option is configured in `output`.
+ * This is the default storage when no `storage` option is configured in the root config.
  * Keys are resolved against `process.cwd()`, so root-relative paths such as
  * `src/gen/api/getPets.ts` are written to the correct location without extra configuration.
  *
@@ -183,11 +197,13 @@ declare function defineResolver<T extends PluginFactoryOptions>(build: ResolverB
  *
  * @example
  * ```ts
- * import { defineConfig, fsStorage } from '@kubb/core'
+ * import { fsStorage } from '@kubb/core'
+ * import { defineConfig } from 'kubb'
  *
  * export default defineConfig({
  *   input:  { path: './petStore.yaml' },
- *   output: { path: './src/gen', storage: fsStorage() },
+ *   output: { path: './src/gen' },
+ *   storage: fsStorage(),
  * })
  * ```
  */
@@ -203,127 +219,17 @@ declare const fsStorage: (options?: Record<string, never> | undefined) => Storag
  *
  * @example
  * ```ts
- * import { defineConfig, memoryStorage } from '@kubb/core'
+ * import { memoryStorage } from '@kubb/core'
+ * import { defineConfig } from 'kubb'
  *
  * export default defineConfig({
  *   input:  { path: './petStore.yaml' },
- *   output: { path: './src/gen', storage: memoryStorage() },
+ *   output: { path: './src/gen' },
+ *   storage: memoryStorage(),
  * })
  * ```
  */
 declare const memoryStorage: (options?: Record<string, never> | undefined) => Storage;
 //#endregion
-//#region src/utils/FunctionParams.d.ts
-type FunctionParamsASTWithoutType = {
-  name?: string;
-  type?: string;
-  /**
-   * @default true
-   */
-  required?: boolean;
-  /**
-   * @default true
-   */
-  enabled?: boolean;
-  default?: string;
-};
-type FunctionParamsASTWithType = {
-  name?: never;
-  type: string;
-  /**
-   * @default true
-   */
-  required?: boolean;
-  /**
-   * @default true
-   */
-  enabled?: boolean;
-  default?: string;
-};
-/**
- * @deprecated
- */
-type FunctionParamsAST = FunctionParamsASTWithoutType | FunctionParamsASTWithType;
-/**
- * @deprecated
- */
-declare class FunctionParams {
-  #private;
-  get items(): FunctionParamsAST[];
-  add(item: FunctionParamsAST | Array<FunctionParamsAST | FunctionParamsAST[] | undefined> | undefined): FunctionParams;
-  static toObject(items: FunctionParamsAST[]): FunctionParamsAST;
-  toObject(): FunctionParamsAST;
-  static toString(items: (FunctionParamsAST | FunctionParamsAST[])[]): string;
-  toString(): string;
-}
-//#endregion
-//#region src/utils/formatters.d.ts
-type Formatter = keyof typeof formatters;
-/**
- * Detect which formatter is available in the system.
- *
- * @returns Promise that resolves to the first available formatter or undefined if none are found
- *
- * @remarks
- * Checks in order of preference: biome, oxfmt, prettier.
- * Uses the `--version` flag to detect if each formatter command is available.
- * This is a reliable method as all supported formatters implement this flag.
- *
- * @example
- * ```typescript
- * const formatter = await detectFormatter()
- * if (formatter) {
- *   console.log(`Using ${formatter} for formatting`)
- * } else {
- *   console.log('No formatter found')
- * }
- * ```
- */
-declare function detectFormatter(): Promise<Formatter | undefined>;
-//#endregion
-//#region src/utils/getBarrelFiles.d.ts
-type FileMetaBase = {
-  pluginName?: string;
-};
-type AddIndexesProps = {
-  type: BarrelType | false | undefined;
-  /**
-   * Root based on root and output.path specified in the config
-   */
-  root: string;
-  /**
-   * Output for plugin
-   */
-  output: {
-    path: string;
-  };
-  group?: {
-    output: string;
-    exportAs: string;
-  };
-  meta?: FileMetaBase;
-};
-declare function getBarrelFiles(files: Array<KubbFile.ResolvedFile>, {
-  type,
-  meta,
-  root,
-  output
-}: AddIndexesProps): Promise<Array<KubbFile.File>>;
-//#endregion
-//#region src/utils/getConfigs.d.ts
-/**
- * Converting UserConfig to Config Array without a change in the object beside the JSON convert.
- */
-declare function getConfigs(config: ConfigInput | UserConfig, args: CLIOptions): Promise<Array<Config>>;
-//#endregion
-//#region src/utils/linters.d.ts
-type Linter = keyof typeof linters;
-declare function detectLinter(): Promise<Linter | undefined>;
-//#endregion
-//#region src/utils/packageJSON.d.ts
-type DependencyName = string;
-type DependencyVersion = string;
-declare function satisfiesDependency(dependency: DependencyName | RegExp, version: DependencyVersion, cwd?: string): boolean;
-//#endregion
-export { Adapter, AdapterFactoryOptions, AdapterSource, BarrelType, type CLIOptions, Config, type ConfigInput, CoreGeneratorV2, DevtoolsOptions, type FileMetaBase, FunctionParams, type FunctionParamsAST, Generator, Group, InputData, InputPath, KubbEvents, Logger, LoggerContext, LoggerOptions, Output, Plugin, PluginContext, PluginDriver, PluginFactoryOptions, PluginLifecycle, PluginLifecycleHooks, PluginParameter, PluginWithLifeCycle, Printer, PrinterFactoryOptions, ReactGeneratorV2, ResolveNameParams, ResolveOptionsContext, ResolvePathParams, Resolver, Storage, UserConfig, UserLogger, UserPlugin, UserPluginWithLifeCycle, UserResolver, build, build as default, createAdapter, createPlugin, createStorage, defaultResolveOptions, defineConfig, defineGenerator, defineLogger, definePrinter, defineResolver, detectFormatter, detectLinter, formatters, fsStorage, getBarrelFiles, getConfigs, getMode, isInputPath, linters, logLevel, memoryStorage, safeBuild, satisfiesDependency, setup };
+export { Adapter, AdapterFactoryOptions, AdapterSource, AsyncEventEmitter, BuildOutput, CLIOptions, Config, DevtoolsOptions, Exclude, FileManager, FileProcessor, Generator, GeneratorContext, Group, Include, InputData, InputPath, Kubb, KubbBuildEndContext, KubbBuildStartContext, KubbConfigEndContext, KubbDebugContext, KubbErrorContext, KubbFileProcessingUpdateContext, KubbFilesProcessingEndContext, KubbFilesProcessingStartContext, KubbGenerationEndContext, KubbGenerationStartContext, KubbGenerationSummaryContext, KubbHookEndContext, KubbHookStartContext, KubbHooks, KubbInfoContext, KubbLifecycleStartContext, KubbPluginEndContext, KubbPluginSetupContext, KubbPluginStartContext, KubbPluginsEndContext, KubbSuccessContext, KubbVersionNewContext, KubbWarnContext, Logger, LoggerContext, LoggerOptions, Middleware, NormalizedPlugin, Output, Override, Parser, Plugin, PluginDriver, PluginFactoryOptions, PossibleConfig, Renderer, RendererFactory, ResolveBannerContext, ResolveOptionsContext, Resolver, ResolverContext, ResolverFileParams, ResolverPathParams, Storage, URLPath, UserConfig, UserLogger, ast, createAdapter, createKubb, createRenderer, createStorage, defineGenerator, defineLogger, defineMiddleware, defineParser, definePlugin, defineResolver, fsStorage, isInputPath, logLevel, memoryStorage };
 //# sourceMappingURL=index.d.ts.map