@kubb/core 5.0.0-alpha.33 → 5.0.0-alpha.35

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { t as __name } from "./chunk--u3MIqq1.js";
-import { $ as FunctionParamsAST, A as Preset, B as Resolver, C as Plugin, D as PluginLifecycleHooks, E as PluginLifecycle, F as ResolveBannerContext, G as UserConfig, H as ResolverFileParams, I as ResolveNameParams, J as UserPlugin, K as UserGroup, L as ResolveOptionsContext, M as Printer, N as PrinterFactoryOptions, O as PluginParameter, P as PrinterPartial, Q as getBarrelFiles, R as ResolvePathOptions, S as Override, T as PluginFactoryOptions, U as ResolverPathParams, V as ResolverContext, W as SchemaHook, X as UserResolver, Y as UserPluginWithLifeCycle, Z as FileMetaBase, _ as LoggerContext, a as AdapterSource, at as defineParser, b as OperationsHook, c as Config, ct as mergeGenerators, d as GeneratorContext, dt as formatters, et as CLIOptions, f as Group, ft as linters, g as Logger, h as InputPath, i as AdapterFactoryOptions, it as Parser, j as Presets, k as PluginWithLifeCycle, l as DevtoolsOptions, lt as Storage, m as InputData, mt as AsyncEventEmitter, n as getMode, nt as defineConfig, o as BarrelType, ot as Generator, p as Include, pt as logLevel, q as UserLogger, r as Adapter, rt as KubbEvents, s as CompatibilityPreset, st as defineGenerator, t as PluginDriver, tt as ConfigInput, u as Exclude, ut as createStorage, v as LoggerOptions, w as PluginContext, x as Output, y as OperationHook, z as ResolvePathParams } from "./PluginDriver-BBi_41VF.js";
-import { composeTransformers, definePrinter } from "@kubb/ast";
-import { FileNode, InputNode, Node, Visitor } from "@kubb/ast/types";
+import { $ as getBarrelFiles, A as Plugin, B as ResolveOptionsContext, C as Logger, D as OperationsHook, E as OperationHook, F as PluginParameter, G as ResolverFileParams, H as ResolvePathParams, I as PluginWithLifeCycle, J as UserGroup, K as ResolverPathParams, L as PossibleConfig, M as PluginFactoryOptions, N as PluginLifecycle, O as Output, P as PluginLifecycleHooks, Q as FileMetaBase, R as ResolveBannerContext, S as KubbPluginSetupContext, T as LoggerOptions, U as Resolver, V as ResolvePathOptions, W as ResolverContext, X as UserPlugin, Y as UserLogger, Z as UserPluginWithLifeCycle, _ as Include, _t as createRenderer, a as Adapter, at as KubbHooks, b as KubbBuildEndContext, c as BarrelType, ct as Parser, d as Config, dt as createStorage, et as FunctionParamsAST, f as ConfigInput, ft as formatters, g as Group, gt as RendererFactory, h as GeneratorContext, ht as Renderer, i as defineGenerator, it as Kubb, j as PluginContext, k as Override, l as CLIOptions, lt as defineParser, m as Exclude, mt as logLevel, n as getMode, nt as PluginHooks, o as AdapterFactoryOptions, ot as BuildOutput, p as DevtoolsOptions, pt as linters, q as SchemaHook, r as Generator, rt as definePlugin, s as AdapterSource, st as createKubb, t as PluginDriver, tt as HookStylePlugin, u as CompatibilityPreset, ut as Storage, v as InputData, vt as AsyncEventEmitter, w as LoggerContext, x as KubbBuildStartContext, y as InputPath, z as ResolveNameParams } from "./PluginDriver-D8lWvtUg.js";
+import * as ast from "@kubb/ast";
+import { FileNode, InputNode, Node, composeTransformers, definePrinter } from "@kubb/ast";
 
 //#region ../../internals/utils/src/urlPath.d.ts
 type URLObject = {
@@ -139,75 +139,6 @@ declare class URLPath {
   toURLPath(): string;
 }
 //#endregion
-//#region src/build.d.ts
-type BuildOptions = {
-  config: UserConfig;
-  events?: AsyncEventEmitter<KubbEvents>;
-};
-/**
- * Full output produced by a successful or failed build.
- */
-type BuildOutput = {
-  /**
-   * Plugins that threw during installation, paired with the caught error.
-   */
-  failedPlugins: Set<{
-    plugin: Plugin;
-    error: Error;
-  }>;
-  files: Array<FileNode>;
-  driver: PluginDriver;
-  /**
-   * Elapsed time in milliseconds for each plugin, keyed by plugin name.
-   */
-  pluginTimings: Map<string, number>;
-  error?: Error;
-  /**
-   * Raw generated source, keyed by absolute file path.
-   */
-  sources: Map<string, string>;
-};
-/**
- * Intermediate result returned by {@link setup} and accepted by {@link safeBuild}.
- */
-type SetupResult = {
-  events: AsyncEventEmitter<KubbEvents>;
-  driver: PluginDriver;
-  sources: Map<string, string>;
-  config: Config;
-  storage: Storage | null;
-};
-/**
- * Initializes all Kubb infrastructure for a build without executing any plugins.
- *
- * - Validates the input path (when applicable).
- * - Applies config defaults (`root`, `output.*`, `devtools`).
- * - Runs the adapter (if configured) to produce the universal `InputNode`.
- *   When no adapter is supplied and `@kubb/adapter-oas` is installed as an
- *
- * Pass the returned {@link SetupResult} directly to {@link safeBuild} or {@link build}
- * via the `overrides` argument to reuse the same infrastructure across multiple runs.
- */
-declare function setup(options: BuildOptions): Promise<SetupResult>;
-/**
- * Runs a full Kubb build and throws on any error or plugin failure.
- *
- * Internally delegates to {@link safeBuild} and rethrows collected errors.
- * Pass an existing {@link SetupResult} via `overrides` to skip the setup phase.
- */
-declare function build(options: BuildOptions, overrides?: SetupResult): Promise<BuildOutput>;
-/**
- * Runs a full Kubb build and captures errors instead of throwing.
- *
- * - Installs each plugin in order, recording failures in `failedPlugins`.
- * - Generates the root barrel file when `output.barrelType` is set.
- * - Writes all files through the driver's FileManager and FileProcessor.
- *
- * Returns a {@link BuildOutput} even on failure — inspect `error` and
- * `failedPlugins` to determine whether the build succeeded.
- */
-declare function safeBuild(options: BuildOptions, overrides?: SetupResult): Promise<BuildOutput>;
-//#endregion
 //#region src/createAdapter.d.ts
 /**
  * Builder type for an {@link Adapter} — takes options and returns the adapter instance.
@@ -252,6 +183,7 @@ type PluginBuilder<T extends PluginFactoryOptions = PluginFactoryOptions> = (opt
  * // instantiate
  * const plugin = myPlugin({ output: { path: 'src/gen' } })
  * ```
+ * @deprecated use definePlugin instead
  */
 declare function createPlugin<T extends PluginFactoryOptions = PluginFactoryOptions>(build: PluginBuilder<T>): (options?: T['options']) => UserPluginWithLifeCycle<T>;
 //#endregion
@@ -263,27 +195,13 @@ declare function createPlugin<T extends PluginFactoryOptions = PluginFactoryOpti
  * 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))
+ *     context.on('kubb:info', (message) => console.log('ℹ', message))
+ *     context.on('kubb:error', (error) => console.error('✗', error.message))
  *   },
  * })
  */
 declare function defineLogger<Options extends LoggerOptions = LoggerOptions>(logger: UserLogger<Options>): Logger<Options>;
 //#endregion
-//#region src/definePresets.d.ts
-/**
- * Creates a typed presets registry object — a named collection of {@link Preset} entries.
- *
- * @example
- * import { definePreset, definePresets } from '@kubb/core'
- * import { resolverTsLegacy } from '@kubb/plugin-ts'
- *
- * export const myPresets = definePresets({
- *   kubbV4: definePreset('kubbV4', { resolvers: [resolverTsLegacy] }),
- * })
- */
-declare function definePresets<TResolver extends Resolver = Resolver>(presets: Presets<TResolver>): Presets<TResolver>;
-//#endregion
 //#region src/defineResolver.d.ts
 /**
  * Builder type for the plugin-specific resolver fields.
@@ -601,35 +519,32 @@ type Formatter = keyof typeof formatters;
  */
 declare function detectFormatter(): Promise<Formatter | null>;
 //#endregion
-//#region src/utils/getConfigs.d.ts
-/**
- * Resolves a {@link ConfigInput} into a normalized array of {@link Config} objects.
- *
- * - Awaits the config when it is a `Promise`.
- * - Calls the factory function with `args` when the config is a function.
- * - Wraps a single config object in an array for uniform downstream handling.
- */
-declare function getConfigs(config: ConfigInput | UserConfig, args: CLIOptions): Promise<Array<Config>>;
-//#endregion
 //#region src/utils/getFunctionParams.d.ts
 type Param = {
   /**
-   * `object` will return the pathParams as an object.
+   * Controls how path parameters are emitted in the function signature.
+   * - `'object'` groups them as a single destructured parameter.
+   * - `'inline'` spreads them as individual comma-separated parameters.
+   * - `'inlineSpread'` emits a single rest parameter.
    *
-   * `inline` will return the pathParams as comma separated params.
-   * @default `'inline'`
-   * @private
+   * @default 'inline'
+   * @internal
    */
   mode?: 'object' | 'inline' | 'inlineSpread';
   type?: 'string' | 'number' | (string & {});
   optional?: boolean;
   /**
-   * @example test = "default"
+   * Default value expression for the parameter.
+   *
+   * @example Assignment syntax
+   * `test = "default"`
    */
   default?: string;
   /**
-   * Used for no TypeScript(with mode object)
-   * @example test: "default"
+   * Used for no TypeScript (with mode object).
+   *
+   * @example Value syntax
+   * `test: "default"`
    */
   value?: string;
   children?: Params;
@@ -663,45 +578,11 @@ declare class FunctionParams {
   toConstructor(): string;
 }
 //#endregion
-//#region src/utils/getPreset.d.ts
-type GetPresetParams<TResolver extends Resolver> = {
-  preset: CompatibilityPreset;
-  presets: Presets<TResolver>;
-  /**
-   * Optional single resolver whose methods override the preset resolver.
-   * When a method returns `null` or `undefined` the preset resolver's method is used instead.
-   */
-  resolver?: Partial<TResolver> & ThisType<TResolver>;
-  /**
-   * User-supplied generators to append after the preset's generators.
-   */
-  generators?: Array<Generator<any>>;
-  /**
-   * Optional single transformer visitor whose methods override the preset transformer.
-   * When a method returns `null` or `undefined` the preset transformer's method is used instead.
-   */
-  transformer?: Visitor;
-};
-type GetPresetResult<TResolver extends Resolver> = {
-  resolver: TResolver;
-  transformer: Visitor | undefined;
-  generators: Array<Generator<any>>;
-  preset: Preset<TResolver> | undefined;
-};
-/**
- * Resolves a named preset into a resolver, transformer, and generators.
- *
- * - Selects the preset resolver; wraps it with user overrides using null/undefined fallback.
- * - Composes the preset's transformers into a single visitor; wraps it with the user transformer using null/undefined fallback.
- * - Combines preset generators with user-supplied generators; falls back to the `default` preset's generators when neither provides any.
- */
-declare function getPreset<TResolver extends Resolver = Resolver>(params: GetPresetParams<TResolver>): GetPresetResult<TResolver>;
-//#endregion
 //#region src/utils/isInputPath.d.ts
 /**
  * Type guard to check if a given config has an `input.path`.
  */
-declare function isInputPath(config: UserConfig | undefined): config is UserConfig<InputPath>;
+declare function isInputPath(config: Config | undefined): config is Config<InputPath>;
 //#endregion
 //#region src/utils/linters.d.ts
 type Linter = keyof typeof linters;
@@ -741,5 +622,5 @@ type DependencyVersion = string;
  */
 declare function satisfiesDependency(dependency: DependencyName | RegExp, version: DependencyVersion, cwd?: string): boolean;
 //#endregion
-export { Adapter, AdapterFactoryOptions, AdapterSource, AsyncEventEmitter, BarrelType, CLIOptions, CompatibilityPreset, Config, ConfigInput, DevtoolsOptions, Exclude, FileMetaBase, FunctionParams, type FunctionParamsAST, Generator, GeneratorContext, Group, Include, InputData, InputPath, KubbEvents, Logger, LoggerContext, LoggerOptions, OperationHook, OperationsHook, Output, Override, type Param, type Params, Parser, Plugin, PluginContext, PluginDriver, PluginFactoryOptions, PluginLifecycle, PluginLifecycleHooks, PluginParameter, PluginWithLifeCycle, Preset, Presets, Printer, PrinterFactoryOptions, PrinterPartial, ResolveBannerContext, ResolveNameParams, ResolveOptionsContext, ResolvePathOptions, ResolvePathParams, Resolver, ResolverContext, ResolverFileParams, ResolverPathParams, SchemaHook, Storage, URLPath, UserConfig, UserGroup, UserLogger, UserPlugin, UserPluginWithLifeCycle, UserResolver, build, build as default, buildDefaultBanner, composeTransformers, createAdapter, createFunctionParams, createPlugin, createStorage, defaultResolveBanner, defaultResolveFile, defaultResolveFooter, defaultResolveOptions, defaultResolvePath, defineConfig, defineGenerator, defineLogger, defineParser, definePresets, definePrinter, defineResolver, detectFormatter, detectLinter, formatters, fsStorage, getBarrelFiles, getConfigs, getFunctionParams, getMode, getPreset, isInputPath, linters, logLevel, memoryStorage, mergeGenerators, safeBuild, satisfiesDependency, setup };
+export { Adapter, AdapterFactoryOptions, AdapterSource, AsyncEventEmitter, BarrelType, BuildOutput, CLIOptions, CompatibilityPreset, Config, ConfigInput, DevtoolsOptions, Exclude, FileMetaBase, FunctionParams, type FunctionParamsAST, Generator, GeneratorContext, Group, HookStylePlugin, Include, InputData, InputPath, Kubb, KubbBuildEndContext, KubbBuildStartContext, KubbHooks, KubbPluginSetupContext, Logger, LoggerContext, LoggerOptions, OperationHook, OperationsHook, Output, Override, type Param, type Params, Parser, Plugin, PluginContext, PluginDriver, PluginFactoryOptions, PluginHooks, PluginLifecycle, PluginLifecycleHooks, PluginParameter, PluginWithLifeCycle, PossibleConfig, Renderer, RendererFactory, ResolveBannerContext, ResolveNameParams, ResolveOptionsContext, ResolvePathOptions, ResolvePathParams, Resolver, ResolverContext, ResolverFileParams, ResolverPathParams, SchemaHook, Storage, URLPath, UserGroup, UserLogger, UserPlugin, UserPluginWithLifeCycle, ast, buildDefaultBanner, composeTransformers, createAdapter, createFunctionParams, createKubb, createPlugin, createRenderer, createStorage, defaultResolveBanner, defaultResolveFile, defaultResolveFooter, defaultResolveOptions, defaultResolvePath, defineGenerator, defineLogger, defineParser, definePlugin, definePrinter, defineResolver, detectFormatter, detectLinter, formatters, fsStorage, getBarrelFiles, getFunctionParams, getMode, isInputPath, linters, logLevel, memoryStorage, satisfiesDependency };
 //# sourceMappingURL=index.d.ts.map