@kubb/core 2.0.0-beta.10 → 2.0.0-beta.12

package/dist/index.d.cts

@@ -1,10 +1,9 @@
+import { w as write, r as read } from './write-46ytbnu9.cjs';
 import { PossiblePromise, GreaterThan, TupleToUnion, ObjValueTuple } from '@kubb/types';
 import { DirectoryTreeOptions } from 'directory-tree';
-import { Ora } from 'ora';
-
-declare function read(path: string): Promise<string>;
-
-declare function write(data: string, path: string): Promise<string | undefined>;
+import { E as EventEmitter, Q as Queue, a as QueueJob } from './Queue-2-6pMcCx.cjs';
+import { Logger, LogLevel } from './logger.cjs';
+import 'ora';
 
 type BarrelManagerOptions = {
     treeNode?: DirectoryTreeOptions;
@@ -15,57 +14,6 @@ type BarrelManagerOptions = {
     extName?: KubbFile.Extname;
 };
 
-declare class EventEmitter<TEvents extends Record<string, any>> {
-    #private;
-    constructor();
-    emit<TEventName extends keyof TEvents & string>(eventName: TEventName, ...eventArg: TEvents[TEventName]): void;
-    on<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): void;
-    off<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): void;
-    removeAll(): void;
-}
-
-type QueueJob<T = unknown> = {
-    (...args: unknown[]): Promise<T | void>;
-};
-type RunOptions = {
-    controller?: AbortController;
-    name?: string;
-    description?: string;
-};
-type Events$1 = {
-    jobDone: [result: unknown];
-    jobFailed: [error: Error];
-};
-declare class Queue {
-    #private;
-    readonly eventEmitter: EventEmitter<Events$1>;
-    constructor(maxParallel: number, debug?: boolean);
-    run<T>(job: QueueJob<T>, options?: RunOptions): Promise<T>;
-    runSync<T>(job: QueueJob<T>, options?: RunOptions): void;
-    get hasJobs(): boolean;
-    get count(): number;
-}
-
-declare const LogLevel: {
-    readonly silent: "silent";
-    readonly info: "info";
-    readonly debug: "debug";
-};
-type LogLevel = keyof typeof LogLevel;
-type Logger = {
-    /**
-     * Optional config name to show in CLI output
-     */
-    name?: string;
-    logLevel: LogLevel;
-    log: (message: string | null) => void;
-    error: (message: string | null) => void;
-    info: (message: string | null) => void;
-    warn: (message: string | null) => void;
-    spinner?: Ora;
-    logs: string[];
-};
-
 type RequiredPluginLifecycle = Required<PluginLifecycle>;
 /**
  * Get the type of the first argument in a function.
@@ -105,30 +53,36 @@ declare class PluginManager {
     #private;
     readonly plugins: KubbPluginWithLifeCycle[];
     readonly fileManager: FileManager;
-    readonly eventEmitter: EventEmitter<Events>;
+    readonly events: EventEmitter<Events>;
     readonly queue: Queue;
     readonly config: KubbConfig;
-    readonly executed: Executer[];
+    readonly executed: Array<Executer>;
     readonly logger: Logger;
     constructor(config: KubbConfig, options: Options$2);
     resolvePath: <TOptions = object>(params: ResolvePathParams<TOptions>) => KubbFile.OptionalPath;
     resolveName: (params: ResolveNameParams) => string;
+    /**
+     * Instead of calling `pluginManager.events.on` you can use `pluginManager.on`. This one also has better types.
+     */
     on<TEventName extends keyof Events & string>(eventName: TEventName, handler: (...eventArg: Events[TEventName]) => void): void;
     /**
-     * Run only hook for a specific plugin name
+     * Run a specific hookName for plugin x.
      */
     hookForPlugin<H extends PluginLifecycleHooks>({ pluginKey, hookName, parameters, }: {
         pluginKey: KubbPlugin['key'];
         hookName: H;
         parameters: PluginParameter<H>;
     }): Promise<Array<ReturnType<ParseResult<H>> | null>> | null;
+    /**
+     * Run a specific hookName for plugin x.
+     */
     hookForPluginSync<H extends PluginLifecycleHooks>({ pluginKey, hookName, parameters, }: {
         pluginKey: KubbPlugin['key'];
         hookName: H;
         parameters: PluginParameter<H>;
     }): Array<ReturnType<ParseResult<H>>> | null;
     /**
-     * Chains, first non-null result stops and returns
+     * First non-null result stops and will return it's value.
      */
     hookFirst<H extends PluginLifecycleHooks>({ hookName, parameters, skipped, }: {
         hookName: H;
@@ -136,7 +90,7 @@ declare class PluginManager {
         skipped?: ReadonlySet<KubbPlugin> | null;
     }): Promise<SafeParseResult<H>>;
     /**
-     * Chains, first non-null result stops and returns
+     * First non-null result stops and will return it's value.
      */
     hookFirstSync<H extends PluginLifecycleHooks>({ hookName, parameters, skipped, }: {
         hookName: H;
@@ -144,14 +98,14 @@ declare class PluginManager {
         skipped?: ReadonlySet<KubbPlugin> | null;
     }): SafeParseResult<H>;
     /**
-     * Parallel, runs all plugins
+     * 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, }: {
         hookName: H;
         parameters?: Parameters<RequiredPluginLifecycle[H]> | undefined;
     }): Promise<Awaited<TOuput>[]>;
     /**
-     * Chains, reduces returned value, handling the reduced value as the first hook argument
+     * Chain all plugins, `reduce` can be passed through to handle every returned value. The return value of the first plugin will be used as the first parameter for the plugin after that.
      */
     hookReduceArg0<H extends PluginLifecycleHooks>({ hookName, parameters, reduce, }: {
         hookName: H;
@@ -624,13 +578,10 @@ declare class FileManager {
     write(...params: Parameters<typeof write>): Promise<string | undefined>;
     read(...params: Parameters<typeof read>): Promise<string>;
     static getSource<TMeta extends KubbFile.FileMetaBase = KubbFile.FileMetaBase>(file: KubbFile.File<TMeta>): string;
-    static combineFiles<TMeta extends KubbFile.FileMetaBase = KubbFile.FileMetaBase>(files: Array<KubbFile.File<TMeta> | null>): Array<KubbFile.File<TMeta>>;
     static getMode(path: string | undefined | null): KubbFile.Mode;
     static get extensions(): Array<KubbFile.Extname>;
     static isExtensionAllowed(baseName: string): boolean;
 }
-declare function combineExports(exports: Array<KubbFile.Export>): Array<KubbFile.Export>;
-declare function combineImports(imports: Array<KubbFile.Import>, exports: Array<KubbFile.Export>, source?: string): Array<KubbFile.Import>;
 
 type BuildOptions = {
     config: PluginContext['config'];
@@ -668,8 +619,6 @@ declare class Warning extends Error {
         cause: Error;
     });
 }
-declare class ValidationPluginError extends Error {
-}
 
 /**
  * Abstract class that contains the building blocks for plugins to create their own Generator
@@ -739,4 +688,4 @@ type OptionsOfPlugin<K extends keyof Plugins> = Plugins[K]['options'];
 type PluginUnion = TupleToUnion<ObjValueTuple<OptionsPlugins>>;
 type Plugin = keyof Plugins;
 
-export { type CLIOptions, FileManager, Generator, type GetPluginFactoryOptions, type InputData, type InputPath, type KubbConfig, KubbFile, type KubbObjectPlugin, type KubbPlugin, type KubbPluginWithLifeCycle, type KubbUnionPlugins, type KubbUserConfig, type KubbUserPlugin, type KubbUserPluginWithLifeCycle, type OptionsOfPlugin, type OptionsPlugins, PackageManager, type Plugin, type PluginCache, type PluginContext, type PluginFactoryOptions, type PluginLifecycle, type PluginLifecycleHooks, PluginManager, type PluginParameter, type PluginUnion, type Plugins, PromiseManager, type ResolveNameParams, type ResolvePathParams, type TransformResult, ValidationPluginError, Warning, type _Register, build, combineExports, combineImports, createPlugin, build as default, defineConfig, isInputPath, pluginName as name, pluginName, safeBuild };
+export { type CLIOptions, FileManager, Generator, type GetPluginFactoryOptions, type InputData, type InputPath, type KubbConfig, KubbFile, type KubbObjectPlugin, type KubbPlugin, type KubbPluginWithLifeCycle, type KubbUnionPlugins, type KubbUserConfig, type KubbUserPlugin, type KubbUserPluginWithLifeCycle, type OptionsOfPlugin, type OptionsPlugins, PackageManager, type Plugin, type PluginCache, type PluginContext, type PluginFactoryOptions, type PluginLifecycle, type PluginLifecycleHooks, PluginManager, type PluginParameter, type PluginUnion, type Plugins, PromiseManager, type ResolveNameParams, type ResolvePathParams, type TransformResult, Warning, type _Register, build, createPlugin, build as default, defineConfig, isInputPath, pluginName as name, pluginName, safeBuild };

package/dist/index.d.ts

@@ -1,10 +1,9 @@
+import { w as write, r as read } from './write-46ytbnu9.js';
 import { PossiblePromise, GreaterThan, TupleToUnion, ObjValueTuple } from '@kubb/types';
 import { DirectoryTreeOptions } from 'directory-tree';
-import { Ora } from 'ora';
-
-declare function read(path: string): Promise<string>;
-
-declare function write(data: string, path: string): Promise<string | undefined>;
+import { E as EventEmitter, Q as Queue, a as QueueJob } from './Queue-2-6pMcCx.js';
+import { Logger, LogLevel } from './logger.js';
+import 'ora';
 
 type BarrelManagerOptions = {
     treeNode?: DirectoryTreeOptions;
@@ -15,57 +14,6 @@ type BarrelManagerOptions = {
     extName?: KubbFile.Extname;
 };
 
-declare class EventEmitter<TEvents extends Record<string, any>> {
-    #private;
-    constructor();
-    emit<TEventName extends keyof TEvents & string>(eventName: TEventName, ...eventArg: TEvents[TEventName]): void;
-    on<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): void;
-    off<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): void;
-    removeAll(): void;
-}
-
-type QueueJob<T = unknown> = {
-    (...args: unknown[]): Promise<T | void>;
-};
-type RunOptions = {
-    controller?: AbortController;
-    name?: string;
-    description?: string;
-};
-type Events$1 = {
-    jobDone: [result: unknown];
-    jobFailed: [error: Error];
-};
-declare class Queue {
-    #private;
-    readonly eventEmitter: EventEmitter<Events$1>;
-    constructor(maxParallel: number, debug?: boolean);
-    run<T>(job: QueueJob<T>, options?: RunOptions): Promise<T>;
-    runSync<T>(job: QueueJob<T>, options?: RunOptions): void;
-    get hasJobs(): boolean;
-    get count(): number;
-}
-
-declare const LogLevel: {
-    readonly silent: "silent";
-    readonly info: "info";
-    readonly debug: "debug";
-};
-type LogLevel = keyof typeof LogLevel;
-type Logger = {
-    /**
-     * Optional config name to show in CLI output
-     */
-    name?: string;
-    logLevel: LogLevel;
-    log: (message: string | null) => void;
-    error: (message: string | null) => void;
-    info: (message: string | null) => void;
-    warn: (message: string | null) => void;
-    spinner?: Ora;
-    logs: string[];
-};
-
 type RequiredPluginLifecycle = Required<PluginLifecycle>;
 /**
  * Get the type of the first argument in a function.
@@ -105,30 +53,36 @@ declare class PluginManager {
     #private;
     readonly plugins: KubbPluginWithLifeCycle[];
     readonly fileManager: FileManager;
-    readonly eventEmitter: EventEmitter<Events>;
+    readonly events: EventEmitter<Events>;
     readonly queue: Queue;
     readonly config: KubbConfig;
-    readonly executed: Executer[];
+    readonly executed: Array<Executer>;
     readonly logger: Logger;
     constructor(config: KubbConfig, options: Options$2);
     resolvePath: <TOptions = object>(params: ResolvePathParams<TOptions>) => KubbFile.OptionalPath;
     resolveName: (params: ResolveNameParams) => string;
+    /**
+     * Instead of calling `pluginManager.events.on` you can use `pluginManager.on`. This one also has better types.
+     */
     on<TEventName extends keyof Events & string>(eventName: TEventName, handler: (...eventArg: Events[TEventName]) => void): void;
     /**
-     * Run only hook for a specific plugin name
+     * Run a specific hookName for plugin x.
      */
     hookForPlugin<H extends PluginLifecycleHooks>({ pluginKey, hookName, parameters, }: {
         pluginKey: KubbPlugin['key'];
         hookName: H;
         parameters: PluginParameter<H>;
     }): Promise<Array<ReturnType<ParseResult<H>> | null>> | null;
+    /**
+     * Run a specific hookName for plugin x.
+     */
     hookForPluginSync<H extends PluginLifecycleHooks>({ pluginKey, hookName, parameters, }: {
         pluginKey: KubbPlugin['key'];
         hookName: H;
         parameters: PluginParameter<H>;
     }): Array<ReturnType<ParseResult<H>>> | null;
     /**
-     * Chains, first non-null result stops and returns
+     * First non-null result stops and will return it's value.
      */
     hookFirst<H extends PluginLifecycleHooks>({ hookName, parameters, skipped, }: {
         hookName: H;
@@ -136,7 +90,7 @@ declare class PluginManager {
         skipped?: ReadonlySet<KubbPlugin> | null;
     }): Promise<SafeParseResult<H>>;
     /**
-     * Chains, first non-null result stops and returns
+     * First non-null result stops and will return it's value.
      */
     hookFirstSync<H extends PluginLifecycleHooks>({ hookName, parameters, skipped, }: {
         hookName: H;
@@ -144,14 +98,14 @@ declare class PluginManager {
         skipped?: ReadonlySet<KubbPlugin> | null;
     }): SafeParseResult<H>;
     /**
-     * Parallel, runs all plugins
+     * 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, }: {
         hookName: H;
         parameters?: Parameters<RequiredPluginLifecycle[H]> | undefined;
     }): Promise<Awaited<TOuput>[]>;
     /**
-     * Chains, reduces returned value, handling the reduced value as the first hook argument
+     * Chain all plugins, `reduce` can be passed through to handle every returned value. The return value of the first plugin will be used as the first parameter for the plugin after that.
      */
     hookReduceArg0<H extends PluginLifecycleHooks>({ hookName, parameters, reduce, }: {
         hookName: H;
@@ -624,13 +578,10 @@ declare class FileManager {
     write(...params: Parameters<typeof write>): Promise<string | undefined>;
     read(...params: Parameters<typeof read>): Promise<string>;
     static getSource<TMeta extends KubbFile.FileMetaBase = KubbFile.FileMetaBase>(file: KubbFile.File<TMeta>): string;
-    static combineFiles<TMeta extends KubbFile.FileMetaBase = KubbFile.FileMetaBase>(files: Array<KubbFile.File<TMeta> | null>): Array<KubbFile.File<TMeta>>;
     static getMode(path: string | undefined | null): KubbFile.Mode;
     static get extensions(): Array<KubbFile.Extname>;
     static isExtensionAllowed(baseName: string): boolean;
 }
-declare function combineExports(exports: Array<KubbFile.Export>): Array<KubbFile.Export>;
-declare function combineImports(imports: Array<KubbFile.Import>, exports: Array<KubbFile.Export>, source?: string): Array<KubbFile.Import>;
 
 type BuildOptions = {
     config: PluginContext['config'];
@@ -668,8 +619,6 @@ declare class Warning extends Error {
         cause: Error;
     });
 }
-declare class ValidationPluginError extends Error {
-}
 
 /**
  * Abstract class that contains the building blocks for plugins to create their own Generator
@@ -739,4 +688,4 @@ type OptionsOfPlugin<K extends keyof Plugins> = Plugins[K]['options'];
 type PluginUnion = TupleToUnion<ObjValueTuple<OptionsPlugins>>;
 type Plugin = keyof Plugins;
 
-export { type CLIOptions, FileManager, Generator, type GetPluginFactoryOptions, type InputData, type InputPath, type KubbConfig, KubbFile, type KubbObjectPlugin, type KubbPlugin, type KubbPluginWithLifeCycle, type KubbUnionPlugins, type KubbUserConfig, type KubbUserPlugin, type KubbUserPluginWithLifeCycle, type OptionsOfPlugin, type OptionsPlugins, PackageManager, type Plugin, type PluginCache, type PluginContext, type PluginFactoryOptions, type PluginLifecycle, type PluginLifecycleHooks, PluginManager, type PluginParameter, type PluginUnion, type Plugins, PromiseManager, type ResolveNameParams, type ResolvePathParams, type TransformResult, ValidationPluginError, Warning, type _Register, build, combineExports, combineImports, createPlugin, build as default, defineConfig, isInputPath, pluginName as name, pluginName, safeBuild };
+export { type CLIOptions, FileManager, Generator, type GetPluginFactoryOptions, type InputData, type InputPath, type KubbConfig, KubbFile, type KubbObjectPlugin, type KubbPlugin, type KubbPluginWithLifeCycle, type KubbUnionPlugins, type KubbUserConfig, type KubbUserPlugin, type KubbUserPluginWithLifeCycle, type OptionsOfPlugin, type OptionsPlugins, PackageManager, type Plugin, type PluginCache, type PluginContext, type PluginFactoryOptions, type PluginLifecycle, type PluginLifecycleHooks, PluginManager, type PluginParameter, type PluginUnion, type Plugins, PromiseManager, type ResolveNameParams, type ResolvePathParams, type TransformResult, Warning, type _Register, build, createPlugin, build as default, defineConfig, isInputPath, pluginName as name, pluginName, safeBuild };