@kubb/core 5.0.0-beta.38 → 5.0.0-beta.39

package/dist/index.d.ts

@@ -1,141 +1,186 @@
 import { t as __name } from "./chunk-C0LytTxp.js";
-import { $ as Exclude, A as KubbFileProcessingUpdate, At as Parser, B as KubbLifecycleStartContext, Bt as RendererFactory, C as InputPath, Ct as LoggerContext, D as KubbConfigEndContext, Dt as FileProcessor, E as KubbBuildStartContext, Et as defineLogger, F as KubbGenerationStartContext, Ft as ReporterName, G as UserConfig, Gt as AdapterFactoryOptions, H as KubbSuccessContext, Ht as Storage, I as KubbHookEndContext, It as UserReporter, J as Generator, Jt as diagnosticCode, K as createKubb, Kt as AdapterSource, L as KubbHookStartContext, Lt as createReporter, M as KubbFilesProcessingStartContext, Mt as GenerationResult, N as KubbFilesProcessingUpdateContext, Nt as Reporter, O as KubbDiagnosticContext, Ot as FileProcessorHooks, P as KubbGenerationEndContext, Pt as ReporterContext, Q as FileManager, R as KubbHooks, Rt as DevtoolsOptions, S as InputData, St as Logger, T as KubbBuildEndContext, Tt as UserLogger, U as KubbWarnContext, Ut as createStorage, V as KubbPluginsEndContext, Vt as createRenderer, W as PossibleConfig, Wt as Adapter, X as defineGenerator, Xt as AsyncEventEmitter, Y as GeneratorContext, Yt as logLevel, Z as KubbDriver, _ as isUpdateDiagnostic, _t as ResolverFileParams, a as DiagnosticKind, at as NormalizedPlugin, b as CLIOptions, bt as Middleware, c as Diagnostics, ct as Plugin, d as ProblemDiagnostic, dt as BannerMeta, et as Group, f as SerializedDiagnostic, ft as ResolveBannerContext, g as isProblemDiagnostic, gt as ResolverContext, h as isPerformanceDiagnostic, ht as Resolver, i as DiagnosticError, it as KubbPluginStartContext, j as KubbFilesProcessingEndContext, jt as defineParser, k as KubbErrorContext, kt as ParsedFile, l as PerformanceDiagnostic, lt as PluginFactoryOptions, m as diagnosticCatalog, mt as ResolveOptionsContext, n as DiagnosticByCode, nt as KubbPluginEndContext, o as DiagnosticLocation, ot as Output, p as UpdateDiagnostic, pt as ResolveBannerFile, q as isInputPath, qt as createAdapter, r as DiagnosticDoc, rt as KubbPluginSetupContext, s as DiagnosticSeverity, st as Override, t as Diagnostic, tt as Include, u as ProblemCode, ut as definePlugin, v as narrowDiagnostic, vt as ResolverPathParams, w as Kubb, wt as LoggerOptions, x as Config, xt as defineMiddleware, y as BuildOutput, yt as defineResolver, z as KubbInfoContext, zt as Renderer } from "./diagnostics-CYfKPtbU.js";
+import { $ as Override, A as KubbHookEndContext, At as logLevel, B as createKubb, Bt as AsyncEventEmitter, C as KubbErrorContext, Ct as createReporter, D as KubbFilesProcessingUpdateContext, Dt as LoggerOptions, E as KubbFilesProcessingStartContext, Et as LoggerContext, F as KubbPluginsEndContext, Ft as createStorage, G as Exclude, H as GeneratorContext, I as KubbSuccessContext, It as Adapter, J as KubbPluginEndContext, K as Group, L as KubbWarnContext, Lt as AdapterFactoryOptions, M as KubbHooks, Mt as RendererFactory, N as KubbInfoContext, Nt as createRenderer, O as KubbGenerationEndContext, Ot as UserLogger, P as KubbLifecycleStartContext, Pt as Storage, Q as Output, R as PossibleConfig, Rt as AdapterSource, S as KubbDiagnosticContext, St as UserReporter, T as KubbFilesProcessingEndContext, Tt as Logger, U as defineGenerator, V as Generator, W as KubbDriver, X as KubbPluginStartContext, Y as KubbPluginSetupContext, Z as NormalizedPlugin, _ as InputPath, _t as defineParser, a as DiagnosticLocation, at as ResolveBannerFile, b as KubbBuildStartContext, bt as ReporterContext, c as PerformanceDiagnostic, ct as ResolverContext, d as SerializedDiagnostic, dt as defineResolver, et as Plugin, f as UpdateDiagnostic, ft as Middleware, g as InputData, gt as Parser, h as Config, ht as ParsedFile, i as DiagnosticKind, it as ResolveBannerContext, j as KubbHookStartContext, jt as Renderer, k as KubbGenerationStartContext, kt as defineLogger, l as ProblemCode, lt as ResolverFileParams, m as CLIOptions, mt as FileProcessorHooks, n as DiagnosticByCode, nt as definePlugin, o as DiagnosticSeverity, ot as ResolveOptionsContext, p as BuildOutput, pt as defineMiddleware, q as Include, r as DiagnosticDoc, rt as BannerMeta, s as Diagnostics, st as Resolver, t as Diagnostic, tt as PluginFactoryOptions, u as ProblemDiagnostic, ut as ResolverPathParams, v as Kubb, vt as GenerationResult, w as KubbFileProcessingUpdate, wt as selectReporters, x as KubbConfigEndContext, xt as ReporterName, y as KubbBuildEndContext, yt as Reporter, z as UserConfig, zt as createAdapter } from "./diagnostics-DhfW8YpT.js";
 import * as ast from "@kubb/ast";
 
-//#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>;
+//#region src/reporters/cliReporter.d.ts
+/**
+ * The default `cli` reporter. Renders the {@link Report} for each config as it finishes, independent
+ * of the live logger view. Suppressed at `silent`; the `verbose` level adds the per-plugin timings.
+ */
+declare const cliReporter: Reporter;
+//#endregion
+//#region src/reporters/fileReporter.d.ts
+/**
+ * The `file` reporter. Writes a config's {@link Report} to `.kubb/kubb-<name>-<timestamp>.log` as a
+ * plain-text document: a `# <name> — <timestamp>` header, a `## Summary` with the same counts the
+ * cli and json reporters expose, a `## Problems` section in the miette block format, and a
+ * `## Timings` section. Selected with `--reporter file` (or `reporters: ['file']`), replacing the
+ * old `--debug` flag.
+ *
+ * @note Unlike the streaming logger it replaced, it captures the collected diagnostics once a
+ * config finishes, not the live `kubb:info`/`kubb:plugin` event stream. Color is stripped so the
+ * file stays plain text even when the run is attached to a TTY.
+ */
+declare const fileReporter: Reporter;
+//#endregion
+//#region src/reporters/jsonReporter.d.ts
+/**
+ * The `json` reporter. `report` returns one config's {@link Report}, which {@link createReporter}
+ * buffers, and `drain` writes them as a single pretty-printed JSON array on `kubb:lifecycle:end`.
+ * Buffering keeps a multi-config run one valid JSON document on stdout instead of concatenated
+ * objects that would break `jq .`. The terminal reporter is suppressed while `json` is active so
+ * stdout stays valid JSON.
+ */
+declare const jsonReporter: Reporter;
+//#endregion
+//#region src/Telemetry.d.ts
+type OtlpStringValue = {
+  stringValue: 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;
+type OtlpBoolValue = {
+  boolValue: boolean;
+};
+type OtlpIntValue = {
+  intValue: number;
+};
+type OtlpDoubleValue = {
+  doubleValue: number;
+};
+type OtlpBytesValue = {
+  bytesValue: string;
+};
+type OtlpArrayValue = {
+  arrayValue: {
+    values: Array<OtlpAnyValue>;
+  };
+};
+type OtlpKvListValue = {
+  kvlistValue: {
+    values: Array<OtlpKeyValue>;
+  };
+};
+type OtlpAnyValue = OtlpStringValue | OtlpBoolValue | OtlpIntValue | OtlpDoubleValue | OtlpBytesValue | OtlpArrayValue | OtlpKvListValue;
+type OtlpKeyValue = {
+  key: string;
+  value: OtlpAnyValue;
+};
+type OtlpResource = {
+  attributes: Array<OtlpKeyValue>;
+  droppedAttributesCount?: number;
+};
+type OtlpInstrumentationScope = {
+  name: string;
+  version?: string;
+  attributes?: Array<OtlpKeyValue>;
+  droppedAttributesCount?: number;
+};
+/** https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/trace/v1/trace.proto#L103 */
+type OtlpSpanKind = 0 | 1 | 2 | 3 | 4 | 5;
+/** 0 = STATUS_CODE_UNSET, 1 = STATUS_CODE_OK, 2 = STATUS_CODE_ERROR */
+type OtlpStatusCode = 0 | 1 | 2;
+type OtlpStatus = {
+  code: OtlpStatusCode;
+  message?: string;
+};
+type OtlpSpan = {
+  traceId: string;
+  spanId: string;
+  traceState?: string;
+  parentSpanId?: string;
+  name: string;
+  kind: OtlpSpanKind;
+  startTimeUnixNano: string;
+  endTimeUnixNano: string;
+  attributes?: Array<OtlpKeyValue>;
+  droppedAttributesCount?: number;
+  events?: Array<OtlpSpanEvent>;
+  droppedEventsCount?: number;
+  links?: Array<OtlpSpanLink>;
+  droppedLinksCount?: number;
+  status?: OtlpStatus;
+};
+type OtlpSpanEvent = {
+  timeUnixNano: string;
+  name: string;
+  attributes?: Array<OtlpKeyValue>;
+  droppedAttributesCount?: number;
+};
+type OtlpSpanLink = {
+  traceId: string;
+  spanId: string;
+  traceState?: string;
+  attributes?: Array<OtlpKeyValue>;
+  droppedAttributesCount?: number;
+};
+type OtlpScopeSpans = {
+  scope: OtlpInstrumentationScope;
+  spans: Array<OtlpSpan>;
+  schemaUrl?: string;
+};
+type OtlpResourceSpans = {
+  resource: OtlpResource;
+  scopeSpans: Array<OtlpScopeSpans>;
+  schemaUrl?: string;
+};
+/** Root payload sent to POST /v1/traces */
+type OtlpExportTraceServiceRequest = {
+  resourceSpans: Array<OtlpResourceSpans>;
 };
 /**
- * Supported identifier casing strategies for path parameters.
+ * Anonymous plugin name and options snapshot sent with each telemetry event.
  */
-type PathCasing = 'camelcase';
-type Options = {
+type TelemetryPlugin = {
+  /**
+   * Plugin name as registered in the Kubb config, e.g. `'@kubb/plugin-ts'`.
+   */
+  name: string;
   /**
-   * Casing strategy applied to path parameter names.
-   * @default undefined (original identifier preserved)
+   * anonymized plugin options snapshot, values are included but cannot be traced back to the user.
    */
-  casing?: PathCasing;
+  options: Record<string, unknown>;
+};
+type TelemetryEvent = {
+  command: string;
+  kubbVersion: string;
+  nodeVersion: string;
+  platform: string;
+  ci: boolean;
+  plugins: Array<TelemetryPlugin>;
+  duration: number;
+  filesCreated: number;
+  status: 'success' | 'failed';
 };
 /**
- * Parses and transforms an OpenAPI/Swagger path string into various URL formats.
- *
- * @example
- * const p = new URLPath('/pet/{petId}')
- * p.URL      // '/pet/:petId'
- * p.template // '`/pet/${petId}`'
+ * Anonymous OTLP usage telemetry for the Kubb run. All methods are static, so call them as
+ * `Telemetry.build(...)`, `Telemetry.send(...)`, and `Telemetry.isDisabled()`. No file paths,
+ * OpenAPI specs, or secrets are ever included, and sending fails silently to never break a run.
  */
-declare class URLPath {
-  #private;
+declare class Telemetry {
   /**
-   * The raw OpenAPI/Swagger path string, e.g. `/pet/{petId}`.
+   * Returns `true` when telemetry is disabled via `DO_NOT_TRACK` or `KUBB_DISABLE_TELEMETRY`.
    */
-  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;
+  static isDisabled(): 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' } }
-   * ```
+   * Build an anonymous telemetry payload from a completed generation run.
    */
-  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;
+  static build(options: {
+    command: 'generate' | 'mcp' | 'validate' | 'agent';
+    kubbVersion: string;
+    plugins?: Array<TelemetryPlugin>;
+    hrStart: [number, number];
+    filesCreated?: number;
+    status: 'success' | 'failed';
+  }): TelemetryEvent;
   /**
-   * 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}`'
+   * Convert a {@link TelemetryEvent} into an OTLP-compatible JSON trace payload.
+   * See https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/
    */
-  toTemplateString({
-    prefix,
-    replacer
-  }?: {
-    prefix?: string | null;
-    replacer?: (pathParam: string) => string;
-  }): string;
+  static buildOtlpPayload(event: TelemetryEvent): OtlpExportTraceServiceRequest;
   /**
-   * 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'
-   * ```
+   * Send an anonymous telemetry event to the Kubb OTLP endpoint. Respects `DO_NOT_TRACK` and
+   * `KUBB_DISABLE_TELEMETRY`, and fails silently so telemetry never interrupts a run.
    */
-  toURLPath(): string;
+  static send(event: TelemetryEvent): Promise<void>;
 }
 //#endregion
 //#region src/storages/fsStorage.d.ts
@@ -188,5 +233,5 @@ declare const fsStorage: (options?: Record<string, never> | undefined) => Storag
  */
 declare const memoryStorage: (options?: Record<string, never> | undefined) => Storage;
 //#endregion
-export { type Adapter, type AdapterFactoryOptions, type AdapterSource, AsyncEventEmitter, type BannerMeta, type BuildOutput, type CLIOptions, type Config, type DevtoolsOptions, type Diagnostic, type DiagnosticByCode, type DiagnosticDoc, DiagnosticError, type DiagnosticKind, type DiagnosticLocation, type DiagnosticSeverity, Diagnostics, type Exclude, FileManager, FileProcessor, type FileProcessorHooks, type GenerationResult, type Generator, type GeneratorContext, type Group, type Include, type InputData, type InputPath, type Kubb, type KubbBuildEndContext, type KubbBuildStartContext, type KubbConfigEndContext, type KubbDiagnosticContext, KubbDriver, type KubbErrorContext, type KubbFileProcessingUpdate, type KubbFilesProcessingEndContext, type KubbFilesProcessingStartContext, type KubbFilesProcessingUpdateContext, type KubbGenerationEndContext, type KubbGenerationStartContext, type KubbHookEndContext, type KubbHookStartContext, type KubbHooks, type KubbInfoContext, type KubbLifecycleStartContext, type KubbPluginEndContext, type KubbPluginSetupContext, type KubbPluginStartContext, type KubbPluginsEndContext, type KubbSuccessContext, type KubbWarnContext, type Logger, type LoggerContext, type LoggerOptions, type Middleware, type NormalizedPlugin, type Output, type Override, type ParsedFile, type Parser, type PerformanceDiagnostic, type Plugin, type PluginFactoryOptions, type PossibleConfig, type ProblemCode, type ProblemDiagnostic, type Renderer, type RendererFactory, type Reporter, type ReporterContext, type ReporterName, type ResolveBannerContext, type ResolveBannerFile, type ResolveOptionsContext, type Resolver, type ResolverContext, type ResolverFileParams, type ResolverPathParams, type SerializedDiagnostic, type Storage, URLPath, type UpdateDiagnostic, type UserConfig, type UserLogger, type UserReporter, ast, createAdapter, createKubb, createRenderer, createReporter, createStorage, defineGenerator, defineLogger, defineMiddleware, defineParser, definePlugin, defineResolver, diagnosticCatalog, diagnosticCode, fsStorage, isInputPath, isPerformanceDiagnostic, isProblemDiagnostic, isUpdateDiagnostic, logLevel, memoryStorage, narrowDiagnostic };
+export { type Adapter, type AdapterFactoryOptions, type AdapterSource, AsyncEventEmitter, type BannerMeta, type BuildOutput, type CLIOptions, type Config, type Diagnostic, type DiagnosticByCode, type DiagnosticDoc, type DiagnosticKind, type DiagnosticLocation, type DiagnosticSeverity, Diagnostics, type Exclude, type FileProcessorHooks, type GenerationResult, type Generator, type GeneratorContext, type Group, type Include, type InputData, type InputPath, type Kubb, type KubbBuildEndContext, type KubbBuildStartContext, type KubbConfigEndContext, type KubbDiagnosticContext, KubbDriver, type KubbErrorContext, type KubbFileProcessingUpdate, type KubbFilesProcessingEndContext, type KubbFilesProcessingStartContext, type KubbFilesProcessingUpdateContext, type KubbGenerationEndContext, type KubbGenerationStartContext, type KubbHookEndContext, type KubbHookStartContext, type KubbHooks, type KubbInfoContext, type KubbLifecycleStartContext, type KubbPluginEndContext, type KubbPluginSetupContext, type KubbPluginStartContext, type KubbPluginsEndContext, type KubbSuccessContext, type KubbWarnContext, type Logger, type LoggerContext, type LoggerOptions, type Middleware, type NormalizedPlugin, type Output, type Override, type ParsedFile, type Parser, type PerformanceDiagnostic, type Plugin, type PluginFactoryOptions, type PossibleConfig, type ProblemCode, type ProblemDiagnostic, type Renderer, type RendererFactory, type Reporter, type ReporterContext, type ReporterName, type ResolveBannerContext, type ResolveBannerFile, type ResolveOptionsContext, type Resolver, type ResolverContext, type ResolverFileParams, type ResolverPathParams, type SerializedDiagnostic, type Storage, Telemetry, type UpdateDiagnostic, type UserConfig, type UserLogger, type UserReporter, ast, cliReporter, createAdapter, createKubb, createRenderer, createReporter, createStorage, defineGenerator, defineLogger, defineMiddleware, defineParser, definePlugin, defineResolver, fileReporter, fsStorage, jsonReporter, logLevel, memoryStorage, selectReporters };
 //# sourceMappingURL=index.d.ts.map