@kubb/oas 4.11.1 → 4.11.3

package/dist/index.d.cts

@@ -52,13 +52,35 @@ type DebugEvent = {
   date: Date;
   logs: string[];
   fileName?: string;
+  /**
+   * Category of the debug log, used for GitHub Actions grouping
+   * - 'setup': Initial configuration and environment setup
+   * - 'plugin': Plugin installation and execution
+   * - 'hook': Plugin hook execution details
+   * - 'schema': Schema parsing and generation
+   * - 'file': File operations (read/write/generate)
+   * - 'error': Error details and stack traces
+   * - undefined: Generic logs (always inline)
+   */
+  category?: 'setup' | 'plugin' | 'hook' | 'schema' | 'file' | 'error';
+  /**
+   * Plugin name for grouping plugin-specific logs together
+   */
+  pluginName?: string;
+  /**
+   * Indicates if this is the start or end of a plugin's execution
+   * - 'start': Start of plugin execution group
+   * - 'end': End of plugin execution group
+   */
+  pluginGroupMarker?: 'start' | 'end';
 };
 type Events$1 = {
   start: [message: string];
   success: [message: string];
-  error: [message: string, cause: Error];
+  error: [message: string, error: Error];
   warning: [message: string];
   debug: [DebugEvent];
+  verbose: [DebugEvent];
   info: [message: string];
   progress_start: [{
     id: string;
@@ -82,7 +104,7 @@ type Logger = {
   consola?: ConsolaInstance;
   on: EventEmitter<Events$1>['on'];
   emit: EventEmitter<Events$1>['emit'];
-  writeLogs: () => Promise<string[]>;
+  writeLogs: () => Promise<void>;
 };
 //#endregion
 //#region ../core/src/utils/types.d.ts
@@ -335,14 +357,35 @@ type PluginContext<TOptions extends PluginFactoryOptions = PluginFactoryOptions>
 //#region ../core/src/PluginManager.d.ts
 type RequiredPluginLifecycle = Required<PluginLifecycle>;
 type Strategy = 'hookFirst' | 'hookForPlugin' | 'hookParallel' | 'hookSeq';
-type Executer<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
-  message: string;
+type ExecutingMeta<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
   strategy: Strategy;
   hookName: H;
   plugin: Plugin;
   parameters?: unknown[] | undefined;
   output?: unknown;
 };
+type ExecutedMeta<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
+  duration: number;
+  strategy: Strategy;
+  hookName: H;
+  plugin: Plugin;
+  parameters?: unknown[] | undefined;
+  output?: unknown;
+};
+type ErrorMeta<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
+  hookName: H;
+  duration: number;
+  strategy: Strategy;
+  parameters?: unknown[] | undefined;
+  plugin: Plugin;
+};
+type ProgressStartMeta<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
+  hookName: H;
+  plugins: Array<Plugin>;
+};
+type ProgressStopMeta<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
+  hookName: H;
+};
 type ParseResult<H extends PluginLifecycleHooks> = RequiredPluginLifecycle[H];
 type SafeParseResult<H extends PluginLifecycleHooks, Result = ReturnType<ParseResult<H>>> = {
   result: Result;
@@ -357,9 +400,11 @@ type Options = {
   concurrency?: number;
 };
 type Events = {
-  executing: [executer: Executer];
-  executed: [executer: Executer];
-  error: [error: Error];
+  progress_start: [meta: ProgressStartMeta];
+  progress_stop: [meta: ProgressStopMeta];
+  executing: [meta: ExecutingMeta];
+  executed: [meta: ExecutedMeta];
+  error: [error: Error, meta: ErrorMeta];
 };
 type GetFileProps<TOptions = object> = {
   name: string;
@@ -372,8 +417,6 @@ declare class PluginManager {
   #private;
   readonly events: EventEmitter<Events>;
   readonly config: Config;
-  readonly executed: Array<Executer>;
-  readonly logger: Logger;
   readonly options: Options;
   constructor(config: Config, options: Options);
   getContext<TOptions extends PluginFactoryOptions>(plugin: Plugin<TOptions>): PluginContext<TOptions> & Record<string, any>;
@@ -399,13 +442,11 @@ declare class PluginManager {
   hookForPlugin<H extends PluginLifecycleHooks>({
     pluginKey,
     hookName,
-    parameters,
-    message
+    parameters
   }: {
     pluginKey: Plugin['key'];
     hookName: H;
     parameters: PluginParameter<H>;
-    message: string;
   }): Promise<Array<ReturnType<ParseResult<H>> | null>>;
   /**
    * Run a specific hookName for plugin x.
@@ -413,13 +454,11 @@ declare class PluginManager {
   hookForPluginSync<H extends PluginLifecycleHooks>({
     pluginKey,
     hookName,
-    parameters,
-    message
+    parameters
   }: {
     pluginKey: Plugin['key'];
     hookName: H;
     parameters: PluginParameter<H>;
-    message: string;
   }): Array<ReturnType<ParseResult<H>>> | null;
   /**
    * First non-null result stops and will return it's value.
@@ -427,13 +466,11 @@ declare class PluginManager {
   hookFirst<H extends PluginLifecycleHooks>({
     hookName,
     parameters,
-    skipped,
-    message
+    skipped
   }: {
     hookName: H;
     parameters: PluginParameter<H>;
     skipped?: ReadonlySet<Plugin> | null;
-    message: string;
   }): Promise<SafeParseResult<H>>;
   /**
    * First non-null result stops and will return it's value.
@@ -441,37 +478,31 @@ declare class PluginManager {
   hookFirstSync<H extends PluginLifecycleHooks>({
     hookName,
     parameters,
-    skipped,
-    message
+    skipped
   }: {
     hookName: H;
     parameters: PluginParameter<H>;
     skipped?: ReadonlySet<Plugin> | null;
-    message: string;
   }): SafeParseResult<H>;
   /**
    * Run all plugins in parallel(order will be based on `this.plugin` and if `pre` or `post` is set).
    */
   hookParallel<H extends PluginLifecycleHooks, TOuput = void>({
     hookName,
-    parameters,
-    message
+    parameters
   }: {
     hookName: H;
     parameters?: Parameters<RequiredPluginLifecycle[H]> | undefined;
-    message: string;
   }): Promise<Awaited<TOuput>[]>;
   /**
    * Chains plugins
    */
   hookSeq<H extends PluginLifecycleHooks>({
     hookName,
-    parameters,
-    message
+    parameters
   }: {
     hookName: H;
     parameters?: PluginParameter<H>;
-    message: string;
   }): Promise<void>;
   getPluginByKey(pluginKey: Plugin['key']): Plugin | undefined;
   getPluginsByKey(hookName: keyof PluginWithLifeCycle, pluginKey: Plugin['key']): Plugin[];

package/dist/index.d.ts

@@ -52,13 +52,35 @@ type DebugEvent = {
   date: Date;
   logs: string[];
   fileName?: string;
+  /**
+   * Category of the debug log, used for GitHub Actions grouping
+   * - 'setup': Initial configuration and environment setup
+   * - 'plugin': Plugin installation and execution
+   * - 'hook': Plugin hook execution details
+   * - 'schema': Schema parsing and generation
+   * - 'file': File operations (read/write/generate)
+   * - 'error': Error details and stack traces
+   * - undefined: Generic logs (always inline)
+   */
+  category?: 'setup' | 'plugin' | 'hook' | 'schema' | 'file' | 'error';
+  /**
+   * Plugin name for grouping plugin-specific logs together
+   */
+  pluginName?: string;
+  /**
+   * Indicates if this is the start or end of a plugin's execution
+   * - 'start': Start of plugin execution group
+   * - 'end': End of plugin execution group
+   */
+  pluginGroupMarker?: 'start' | 'end';
 };
 type Events$1 = {
   start: [message: string];
   success: [message: string];
-  error: [message: string, cause: Error];
+  error: [message: string, error: Error];
   warning: [message: string];
   debug: [DebugEvent];
+  verbose: [DebugEvent];
   info: [message: string];
   progress_start: [{
     id: string;
@@ -82,7 +104,7 @@ type Logger = {
   consola?: ConsolaInstance;
   on: EventEmitter<Events$1>['on'];
   emit: EventEmitter<Events$1>['emit'];
-  writeLogs: () => Promise<string[]>;
+  writeLogs: () => Promise<void>;
 };
 //#endregion
 //#region ../core/src/utils/types.d.ts
@@ -335,14 +357,35 @@ type PluginContext<TOptions extends PluginFactoryOptions = PluginFactoryOptions>
 //#region ../core/src/PluginManager.d.ts
 type RequiredPluginLifecycle = Required<PluginLifecycle>;
 type Strategy = 'hookFirst' | 'hookForPlugin' | 'hookParallel' | 'hookSeq';
-type Executer<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
-  message: string;
+type ExecutingMeta<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
   strategy: Strategy;
   hookName: H;
   plugin: Plugin;
   parameters?: unknown[] | undefined;
   output?: unknown;
 };
+type ExecutedMeta<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
+  duration: number;
+  strategy: Strategy;
+  hookName: H;
+  plugin: Plugin;
+  parameters?: unknown[] | undefined;
+  output?: unknown;
+};
+type ErrorMeta<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
+  hookName: H;
+  duration: number;
+  strategy: Strategy;
+  parameters?: unknown[] | undefined;
+  plugin: Plugin;
+};
+type ProgressStartMeta<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
+  hookName: H;
+  plugins: Array<Plugin>;
+};
+type ProgressStopMeta<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
+  hookName: H;
+};
 type ParseResult<H extends PluginLifecycleHooks> = RequiredPluginLifecycle[H];
 type SafeParseResult<H extends PluginLifecycleHooks, Result = ReturnType<ParseResult<H>>> = {
   result: Result;
@@ -357,9 +400,11 @@ type Options = {
   concurrency?: number;
 };
 type Events = {
-  executing: [executer: Executer];
-  executed: [executer: Executer];
-  error: [error: Error];
+  progress_start: [meta: ProgressStartMeta];
+  progress_stop: [meta: ProgressStopMeta];
+  executing: [meta: ExecutingMeta];
+  executed: [meta: ExecutedMeta];
+  error: [error: Error, meta: ErrorMeta];
 };
 type GetFileProps<TOptions = object> = {
   name: string;
@@ -372,8 +417,6 @@ declare class PluginManager {
   #private;
   readonly events: EventEmitter<Events>;
   readonly config: Config;
-  readonly executed: Array<Executer>;
-  readonly logger: Logger;
   readonly options: Options;
   constructor(config: Config, options: Options);
   getContext<TOptions extends PluginFactoryOptions>(plugin: Plugin<TOptions>): PluginContext<TOptions> & Record<string, any>;
@@ -399,13 +442,11 @@ declare class PluginManager {
   hookForPlugin<H extends PluginLifecycleHooks>({
     pluginKey,
     hookName,
-    parameters,
-    message
+    parameters
   }: {
     pluginKey: Plugin['key'];
     hookName: H;
     parameters: PluginParameter<H>;
-    message: string;
   }): Promise<Array<ReturnType<ParseResult<H>> | null>>;
   /**
    * Run a specific hookName for plugin x.
@@ -413,13 +454,11 @@ declare class PluginManager {
   hookForPluginSync<H extends PluginLifecycleHooks>({
     pluginKey,
     hookName,
-    parameters,
-    message
+    parameters
   }: {
     pluginKey: Plugin['key'];
     hookName: H;
     parameters: PluginParameter<H>;
-    message: string;
   }): Array<ReturnType<ParseResult<H>>> | null;
   /**
    * First non-null result stops and will return it's value.
@@ -427,13 +466,11 @@ declare class PluginManager {
   hookFirst<H extends PluginLifecycleHooks>({
     hookName,
     parameters,
-    skipped,
-    message
+    skipped
   }: {
     hookName: H;
     parameters: PluginParameter<H>;
     skipped?: ReadonlySet<Plugin> | null;
-    message: string;
   }): Promise<SafeParseResult<H>>;
   /**
    * First non-null result stops and will return it's value.
@@ -441,37 +478,31 @@ declare class PluginManager {
   hookFirstSync<H extends PluginLifecycleHooks>({
     hookName,
     parameters,
-    skipped,
-    message
+    skipped
   }: {
     hookName: H;
     parameters: PluginParameter<H>;
     skipped?: ReadonlySet<Plugin> | null;
-    message: string;
   }): SafeParseResult<H>;
   /**
    * Run all plugins in parallel(order will be based on `this.plugin` and if `pre` or `post` is set).
    */
   hookParallel<H extends PluginLifecycleHooks, TOuput = void>({
     hookName,
-    parameters,
-    message
+    parameters
   }: {
     hookName: H;
     parameters?: Parameters<RequiredPluginLifecycle[H]> | undefined;
-    message: string;
   }): Promise<Awaited<TOuput>[]>;
   /**
    * Chains plugins
    */
   hookSeq<H extends PluginLifecycleHooks>({
     hookName,
-    parameters,
-    message
+    parameters
   }: {
     hookName: H;
     parameters?: PluginParameter<H>;
-    message: string;
   }): Promise<void>;
   getPluginByKey(pluginKey: Plugin['key']): Plugin | undefined;
   getPluginsByKey(hookName: keyof PluginWithLifeCycle, pluginKey: Plugin['key']): Plugin[];

package/dist/index.js

@@ -4356,7 +4356,11 @@ async function parse(pathOrApi, { oasClass = Oas, canBundle = true, enablePaths
 		ref: pathOrApi,
 		config: await loadConfig(),
 		base: pathOrApi
-	})).bundle.parsed);
+	})).bundle.parsed, {
+		oasClass,
+		canBundle,
+		enablePaths
+	});
 	const document = await new OASNormalize(pathOrApi, {
 		enablePaths,
 		colorizeErrors: true