@kubb/core 5.11.3 → 5.11.5

package/dist/{createAdapter-D6osJ_0O.d.ts → createAdapter-DtX_MKL-.d.ts}

@@ -320,6 +320,16 @@ type DiagnosticFormatOptions = {
    * @default 0
    */
   width?: number;
+  /**
+   * Where the diagnostic's pointer sits in the input file, when the host resolved it. Replaces the
+   * pointer on the `at` row, and an error's `human` layout draws `frame` under it.
+   */
+  position?: {
+    file: string;
+    line: number;
+    column: number;
+    frame?: Array<string>;
+  };
 };
 /**
  * A {@link Diagnostic} reduced to its JSON-safe fields plus a `docsUrl`, for
@@ -371,7 +381,7 @@ declare function serialize(diagnostic: Diagnostic): SerializedDiagnostic;
  * with `at`, `fix`, the first cause, and `Learn more` for an error, and one row for a warning.
  * `verbose` adds the full stack.
  */
-declare function format(diagnostic: Diagnostic, { audience, verbose, width }?: DiagnosticFormatOptions): Array<string>;
+declare function format(diagnostic: Diagnostic, { audience, verbose, width, position }?: DiagnosticFormatOptions): Array<string>;
 //#endregion
 //#region src/createReporter.d.ts
 /**
@@ -414,9 +424,28 @@ type GenerationResult = {
    */
   diagnostics: Array<Diagnostic>;
   /**
-   * Number of files written for this config.
+   * Number of generated files for this config, including unchanged files.
    */
   filesCreated: number;
+  /**
+   * Number of generated files whose content matches the previous output.
+   */
+  filesUnchanged?: number;
+  /**
+   * Changes compared with the output before this run, when the host collected them.
+   * Line totals include added and deleted files.
+   */
+  fileChanges?: {
+    added: number;
+    modified: number;
+    deleted: number;
+    linesAdded: number;
+    linesRemoved: number;
+  };
+  /**
+   * The result previews generation without writing output.
+   */
+  dryRun?: boolean;
   status: 'success' | 'failed';
   /**
    * `process.hrtime()` snapshot taken when this config started generating.
@@ -453,10 +482,10 @@ type Reporter = {
    */
   report: (result: GenerationResult, context: ReporterContext) => void | Promise<void>;
   /**
-   * Optional finalizer called once after the run's last config. The host wires it to
-   * `kubb:lifecycle:end`. {@link createReporter} closes it over the values that `report` returned.
+   * Runs once after the run's last config, on `kubb:lifecycle:end`. Only a reporter that collects
+   * its configs' reports into one document, such as `json`, has one.
    */
-  drain: (context: ReporterContext) => void | Promise<void>;
+  drain?: (context: ReporterContext) => void | Promise<void>;
   /**
    * Whether the host should collect files from `kubb:plugin:end` hooks.
    */
@@ -675,6 +704,19 @@ type OutputManifest = {
    */
   commit(): Promise<void>;
 };
+/**
+ * Loads the stored manifest, starting empty when it is missing, unreadable, or from an older
+ * version. `storage` holds the generated files, `cache` holds the manifest itself.
+ *
+ * @example
+ * ```ts
+ * const manifest = await createOutputManifest({ storage: config.storage, cache: cacheStorage({ root: config.root }) })
+ * ```
+ */
+declare function createOutputManifest({ storage, cache }: {
+  storage: Storage;
+  cache: Storage;
+}): Promise<OutputManifest>;
 //#endregion
 //#region src/Hookable.d.ts
 /**
@@ -774,7 +816,7 @@ type WriteOptions = ParseOptions & {
    */
   manifest?: OutputManifest;
   /**
-   * Receives `kubb:files:processing:start`, `:update` (one batch, in input order) and `:end` for the write. `config` fills the update rows.
+   * Receives `kubb:files:processing:start`, `:update` (in input order, as files finish) and `:end` for the write. `config` fills the update rows.
    */
   hooks?: Hookable<KubbHooks>;
   config?: Config;
@@ -819,11 +861,12 @@ declare class FileManager {
    * Parses and writes every file through a bounded pool of workers. A small spec runs all its files
    * at once; a spec with thousands of files keeps at most {@link FILE_CONCURRENCY} parsed sources in
    * memory rather than holding every source, while still overlapping each file's write with the
-   * next file's parse. Files finish in whatever order they parse, so the update rows are sorted back
-   * into input order before `kubb:files:processing:update` fires once with the whole batch.
+   * next file's parse. Files finish in whatever order they parse, so each finished file flushes the
+   * run of finished files ahead of it as one `kubb:files:processing:update`, keeping rows in input order.
    *
    * A file the storage already holds is skipped, so a rebuild that generates identical output
-   * writes nothing and leaves every mtime where it was.
+   * writes nothing and leaves every mtime where it was. `kubb:files:processing:end` lists the
+   * skipped paths as `unchanged`.
    */
   write(files: Array<FileNode>, { storage, parsers, manifest, signal, hooks, config }: WriteOptions): Promise<void>;
 }
@@ -1368,6 +1411,13 @@ type KubbBuildStartContext = FilesContext & {
    * To observe individual schemas and operations use the `kubb:generate:schema` / `kubb:generate:operation` hooks.
    */
   meta: InputMeta | undefined;
+  /**
+   * How many schemas and operations the parsed document holds, the totals for a progress display.
+   */
+  nodeCounts: {
+    schemas: number;
+    operations: number;
+  };
   /**
    * Looks up a registered plugin by name, typed by the plugin registry.
    */
@@ -1519,6 +1569,10 @@ type KubbFilesProcessingEndContext = {
    * All files that were serialized in this batch.
    */
   files: Array<FileNode>;
+  /**
+   * Paths of the files the storage already held with the same content, so they were not written.
+   */
+  unchanged: Array<string>;
 };
 type KubbHookStartContext = {
   /**
@@ -1756,7 +1810,7 @@ type Diagnostic = ProblemDiagnostic | PerformanceDiagnostic | UpdateDiagnostic;
  * Static helpers for working with {@link Diagnostic}s, plus the run-scoped sink
  * that lets deep code report a diagnostic without threading a callback.
  *
- * The sink lives in a single `AsyncLocalStorage` in the `@kubb/core` bundle.
+ * The sink lives in a single `AsyncLocalStorage` on `globalThis`, shared by every copy of `@kubb/core`.
  * `Diagnostics.scope` activates it for a run, so anything inside that run (the
  * adapter parse, a generator) reports through `Diagnostics.report` and lands
  * in the same run.
@@ -3096,9 +3150,11 @@ type Adapter<TOptions extends AdapterFactoryOptions = AdapterFactoryOptions> = {
   name: TOptions['name'];
   meta?: ExtensionMeta<TOptions['name']>;
   /**
-   * Resolved adapter options after defaults have been applied.
+   * The options the adapter was created with, before `setup` applied defaults, as a plugin keeps its
+   * own. Kubb Studio merges its overrides onto these, so a default derived from another option, such
+   * as `emptySchemaType` from `unknownType`, follows a change to it.
    */
-  options: TOptions['resolvedOptions'];
+  options: TOptions['options'];
   /**
    * Parsed source document after the first `parse()` call. `null` before parsing.
    */
@@ -3120,6 +3176,13 @@ type Adapter<TOptions extends AdapterFactoryOptions = AdapterFactoryOptions> = {
   validate: (input: string, options?: {
     throwOnError?: boolean;
   }) => Promise<void>;
+  /**
+   * Zero-based UTF-16 offsets of a diagnostic in `source` for a code frame, `end` exclusive; `undefined` when it cannot be found.
+   */
+  locate?: (source: string, location: DiagnosticLocation) => {
+    start: number;
+    end: number;
+  } | undefined;
 };
 /**
  * The object passed to `defineExtension` with `kind: 'adapter'`.
@@ -3152,5 +3215,5 @@ type AdapterFactory<T extends AdapterFactoryOptions = AdapterFactoryOptions> = E
  */
 declare function createAdapter<T extends AdapterFactoryOptions = AdapterFactoryOptions>(definition: AdapterDefinition<T>): AdapterFactory<T>;
 //#endregion
-export { NodeCache as $, ReporterPluginFiles as $t, PluginFactory as A, KubbInfoContext as At, ResolveImportsOptions as B, RunHookOptions as Bt, NormalizedPlugin as C, KubbGenerationEndContext as Ct, Override as D, KubbHookLineContext as Dt, OutputOptions as E, KubbHookEndContext as Et, definePlugin as F, KubbWarnContext as Ft, ResolverFile as G, RendererFactory as Gt, ResolvePathOptions as H, KubbDriver as Ht, BannerMeta as I, PossibleConfig as It, ResolverPatch as J, createStorage as Jt, ResolverFileParams as K, createRenderer as Kt, ResolveBannerContext as L, PostGenerateCommand as Lt, PluginType as M, KubbMessageContext as Mt, ResolvePluginOptions as N, KubbPluginsEndContext as Nt, Plugin as O, KubbHookStartContext as Ot, assertPluginOption as P, KubbSuccessContext as Pt, defineGenerator as Q, ReporterName as Qt, ResolveBannerFile as R, UserConfig as Rt, KubbPluginStartContext as S, KubbFilesProcessingUpdateContext as St, OutputMode as T, KubbGenerationSummaryContext as Tt, Resolver as U, Hookable as Ut, ResolveOptionsContext as V, runHook as Vt, ResolverDefault as W, Renderer as Wt, Generator as X, Reporter as Xt, ResolverPathParams as Y, GenerationResult as Yt, GeneratorContext as Z, ReporterContext as Zt, Filter as _, KubbDiagnosticContext as _t, AdapterSource as a, Parser as an, Diagnostics as at, KubbPluginEndContext as b, KubbFilesProcessingEndContext as bt, ExtensionDependency as c, defineParser as cn, ProblemDiagnostic as ct, ExtensionKind as d, CLIOptions as dt, UserReporter as en, Diagnostic as et, ExtensionMeta as f, Config as ft, Exclude$1 as g, KubbBuildStartContext as gt, resolveMeta as h, KubbBuildEndContext as ht, AdapterFactoryOptions as i, SerializedDiagnostic as in, DiagnosticSeverity as it, PluginName as j, KubbLifecycleStartContext as jt, PluginDefinition as k, KubbHooks as kt, ExtensionDependencyRecord as l, UpdateDiagnostic as lt, defineExtension as m, Input as mt, AdapterDefinition as n, logLevel as nn, DiagnosticKind as nt, createAdapter as o, ParserDefinition as on, PerformanceDiagnostic as ot, checkCompatibility as p, FilesContext as pt, ResolverFilePathParams as q, Storage as qt, AdapterFactory as r, DiagnosticFormatOptions as rn, DiagnosticLocation as rt, ExtensionDependencies as s, ParserFactory as sn, ProblemCode as st, Adapter as t, createReporter as tn, DiagnosticDoc as tt, ExtensionFactory as u, BuildOutput as ut, Group as v, KubbErrorContext as vt, Output as w, KubbGenerationStartContext as wt, KubbPluginSetupContext as x, KubbFilesProcessingStartContext as xt, Include as y, KubbFileProcessingUpdate as yt, ResolveFileOptions as z, HookResult as zt };
-//# sourceMappingURL=createAdapter-D6osJ_0O.d.ts.map
+export { NodeCache as $, ReporterContext as $t, PluginFactory as A, KubbInfoContext as At, ResolveImportsOptions as B, RunHookOptions as Bt, NormalizedPlugin as C, KubbGenerationEndContext as Ct, Override as D, KubbHookLineContext as Dt, OutputOptions as E, KubbHookEndContext as Et, definePlugin as F, KubbWarnContext as Ft, ResolverFile as G, createOutputManifest as Gt, ResolvePathOptions as H, KubbDriver as Ht, BannerMeta as I, PossibleConfig as It, ResolverPatch as J, createRenderer as Jt, ResolverFileParams as K, Renderer as Kt, ResolveBannerContext as L, PostGenerateCommand as Lt, PluginType as M, KubbMessageContext as Mt, ResolvePluginOptions as N, KubbPluginsEndContext as Nt, Plugin as O, KubbHookStartContext as Ot, assertPluginOption as P, KubbSuccessContext as Pt, defineGenerator as Q, Reporter as Qt, ResolveBannerFile as R, UserConfig as Rt, KubbPluginStartContext as S, KubbFilesProcessingUpdateContext as St, OutputMode as T, KubbGenerationSummaryContext as Tt, Resolver as U, Hookable as Ut, ResolveOptionsContext as V, runHook as Vt, ResolverDefault as W, OutputManifest as Wt, Generator as X, createStorage as Xt, ResolverPathParams as Y, Storage as Yt, GeneratorContext as Z, GenerationResult as Zt, Filter as _, KubbDiagnosticContext as _t, AdapterSource as a, DiagnosticFormatOptions as an, Diagnostics as at, KubbPluginEndContext as b, KubbFilesProcessingEndContext as bt, ExtensionDependency as c, ParserDefinition as cn, ProblemDiagnostic as ct, ExtensionKind as d, CLIOptions as dt, ReporterName as en, Diagnostic as et, ExtensionMeta as f, Config as ft, Exclude$1 as g, KubbBuildStartContext as gt, resolveMeta as h, KubbBuildEndContext as ht, AdapterFactoryOptions as i, logLevel as in, DiagnosticSeverity as it, PluginName as j, KubbLifecycleStartContext as jt, PluginDefinition as k, KubbHooks as kt, ExtensionDependencyRecord as l, ParserFactory as ln, UpdateDiagnostic as lt, defineExtension as m, Input as mt, AdapterDefinition as n, UserReporter as nn, DiagnosticKind as nt, createAdapter as o, SerializedDiagnostic as on, PerformanceDiagnostic as ot, checkCompatibility as p, FilesContext as pt, ResolverFilePathParams as q, RendererFactory as qt, AdapterFactory as r, createReporter as rn, DiagnosticLocation as rt, ExtensionDependencies as s, Parser as sn, ProblemCode as st, Adapter as t, ReporterPluginFiles as tn, DiagnosticDoc as tt, ExtensionFactory as u, defineParser as un, BuildOutput as ut, Group as v, KubbErrorContext as vt, Output as w, KubbGenerationStartContext as wt, KubbPluginSetupContext as x, KubbFilesProcessingStartContext as xt, Include as y, KubbFileProcessingUpdate as yt, ResolveFileOptions as z, HookResult as zt };
+//# sourceMappingURL=createAdapter-DtX_MKL-.d.ts.map