@kubb/core 1.13.0 → 1.14.0-canary.20231020T164632

package/dist/index.d.cts

@@ -105,16 +105,12 @@ type RunOptions = {
     description?: string;
 };
 declare class Queue {
-    private queue;
-    private workerCount;
-    private maxParallel;
-    private debug;
+    #private;
     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;
-    private work;
 }
 
 declare function escape(text?: string): string;
@@ -285,9 +281,7 @@ declare class FunctionParams {
 }
 
 declare class FileManager {
-    private cache;
-    private task?;
-    private queue?;
+    #private;
     constructor(options?: {
         queue?: Queue;
         task?: QueueJob<KubbFile.ResolvedFile>;
@@ -297,7 +291,6 @@ declare class FileManager {
     get isExecuting(): boolean;
     add(file: KubbFile.File): Promise<KubbFile.ResolvedFile>;
     addOrAppend(file: KubbFile.File): Promise<KubbFile.ResolvedFile>;
-    private append;
     getCacheByUUID(UUID: KubbFile.UUID): KubbFile.File | undefined;
     get(path: KubbFile.Path): Array<KubbFile.File> | undefined;
     remove(path: KubbFile.Path): void;
@@ -317,8 +310,8 @@ declare function combineImports(imports: Array<KubbFile.Import>, exports: Array<
 declare function createFileSource(file: KubbFile.File): string;
 
 declare class EventEmitter<TEvents extends Record<string, any>> {
+    #private;
     constructor();
-    private emitter;
     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;
@@ -365,13 +358,13 @@ type Events = {
     error: [pluginError: PluginError];
 };
 declare class PluginManager {
+    #private;
     plugins: KubbPlugin[];
     readonly fileManager: FileManager;
     readonly eventEmitter: EventEmitter<Events>;
     readonly queue: Queue;
     readonly executed: Executer[];
     readonly logger: Logger;
-    private readonly core;
     constructor(config: KubbConfig, options: Options$1);
     resolvePath: (params: ResolvePathParams) => KubbFile.OptionalPath;
     resolveName: (params: ResolveNameParams) => string;
@@ -432,25 +425,7 @@ declare class PluginManager {
         hookName: H;
         parameters?: Parameters<PluginLifecycle[H]>;
     }): Promise<void>;
-    private getSortedPlugins;
     getPlugin(hookName: keyof PluginLifecycle, pluginName: string): KubbPlugin;
-    private addExecutedToCallStack;
-    /**
-     * Run an async plugin hook and return the result.
-     * @param hookName Name of the plugin hook. Must be either in `PluginHooks` or `OutputPluginValueHooks`.
-     * @param args Arguments passed to the plugin hook.
-     * @param plugin The actual pluginObject to run.
-     */
-    private execute;
-    /**
-     * Run a sync plugin hook and return the result.
-     * @param hookName Name of the plugin hook. Must be in `PluginHooks`.
-     * @param args Arguments passed to the plugin hook.
-     * @param plugin The acutal plugin
-     * @param replaceContext When passed, the plugin context can be overridden.
-     */
-    private executeSync;
-    private catcher;
 }
 
 declare class ValidationPluginError extends Error {
@@ -473,7 +448,7 @@ type PackageJSON = {
     devDependencies?: Record<string, string>;
 };
 declare class PackageManager {
-    private cwd;
+    #private;
     constructor(workspace?: string);
     getPackageJSON(): Promise<PackageJSON | undefined>;
     getPackageJSONSync(): PackageJSON | undefined;
@@ -506,7 +481,7 @@ type KubbUserConfig = Omit<KubbConfig, 'root' | 'plugins'> & {
     plugins?: Array<KubbPlugin> | Array<KubbJSONPlugins> | KubbObjectPlugins;
 };
 /**
- * Global/internal config used through out the full generation.
+ * @private
  */
 type KubbConfig = {
     /**
@@ -517,27 +492,28 @@ type KubbConfig = {
     root: string;
     input: {
         /**
-         * Path to be used as the input. Can be an absolute path, or a path relative from
-         * the defined root option.
+         * Path to be used as the input. This can be an absolute path or a path relative to the `root`.
          */
         path: string;
     } | {
         /**
-         * String or object containing the data that you would normally import.
+         * `string` or `object` containing the data.
          */
         data: string | unknown;
     };
     output: {
         /**
-         * Path to be used to export all generated files. Can be an absolute path, or a path relative based of the defined root option.
+         * Path to be used to export all generated files.
+         * This can be an absolute path, or a path relative based of the defined `root` option.
          */
         path: string;
         /**
-         * Remove previous generated files and folders.
+         * Clean output directory before each build.
          */
         clean?: boolean;
         /**
-         * Enabled or disable the writing to the filesystem. This is being used for the playground.
+         * Write files to the fileSystem
+         * This is being used for the playground.
          * @default true
          */
         write?: boolean;
@@ -553,8 +529,8 @@ type KubbConfig = {
      */
     hooks?: {
         /**
-         * Hook that will be triggerend at the end of all executions.
-         * Useful for running Prettier or ESLint to use your own linting structure.
+         * Hook that will be triggered at the end of all executions.
+         * Useful for running Prettier or ESLint to format/lint your code.
          */
         done?: string | Array<string>;
     };
@@ -774,10 +750,12 @@ declare const pluginName: CorePluginOptions['name'];
  * Abstract class that contains the building blocks for plugins to create their own Generator
  * @link idea based on https://github.com/colinhacks/zod/blob/master/src/types.ts#L137
  */
-declare abstract class Generator<TOptions extends object = object> {
-    private _options;
-    constructor(options?: TOptions);
+declare abstract class Generator<TOptions = unknown, TContext = unknown> {
+    #private;
+    constructor(options?: TOptions, context?: TContext);
     get options(): TOptions;
+    get context(): TContext;
+    set options(options: TOptions);
     abstract build(...params: unknown[]): unknown;
 }
 

package/dist/index.d.ts

@@ -105,16 +105,12 @@ type RunOptions = {
     description?: string;
 };
 declare class Queue {
-    private queue;
-    private workerCount;
-    private maxParallel;
-    private debug;
+    #private;
     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;
-    private work;
 }
 
 declare function escape(text?: string): string;
@@ -285,9 +281,7 @@ declare class FunctionParams {
 }
 
 declare class FileManager {
-    private cache;
-    private task?;
-    private queue?;
+    #private;
     constructor(options?: {
         queue?: Queue;
         task?: QueueJob<KubbFile.ResolvedFile>;
@@ -297,7 +291,6 @@ declare class FileManager {
     get isExecuting(): boolean;
     add(file: KubbFile.File): Promise<KubbFile.ResolvedFile>;
     addOrAppend(file: KubbFile.File): Promise<KubbFile.ResolvedFile>;
-    private append;
     getCacheByUUID(UUID: KubbFile.UUID): KubbFile.File | undefined;
     get(path: KubbFile.Path): Array<KubbFile.File> | undefined;
     remove(path: KubbFile.Path): void;
@@ -317,8 +310,8 @@ declare function combineImports(imports: Array<KubbFile.Import>, exports: Array<
 declare function createFileSource(file: KubbFile.File): string;
 
 declare class EventEmitter<TEvents extends Record<string, any>> {
+    #private;
     constructor();
-    private emitter;
     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;
@@ -365,13 +358,13 @@ type Events = {
     error: [pluginError: PluginError];
 };
 declare class PluginManager {
+    #private;
     plugins: KubbPlugin[];
     readonly fileManager: FileManager;
     readonly eventEmitter: EventEmitter<Events>;
     readonly queue: Queue;
     readonly executed: Executer[];
     readonly logger: Logger;
-    private readonly core;
     constructor(config: KubbConfig, options: Options$1);
     resolvePath: (params: ResolvePathParams) => KubbFile.OptionalPath;
     resolveName: (params: ResolveNameParams) => string;
@@ -432,25 +425,7 @@ declare class PluginManager {
         hookName: H;
         parameters?: Parameters<PluginLifecycle[H]>;
     }): Promise<void>;
-    private getSortedPlugins;
     getPlugin(hookName: keyof PluginLifecycle, pluginName: string): KubbPlugin;
-    private addExecutedToCallStack;
-    /**
-     * Run an async plugin hook and return the result.
-     * @param hookName Name of the plugin hook. Must be either in `PluginHooks` or `OutputPluginValueHooks`.
-     * @param args Arguments passed to the plugin hook.
-     * @param plugin The actual pluginObject to run.
-     */
-    private execute;
-    /**
-     * Run a sync plugin hook and return the result.
-     * @param hookName Name of the plugin hook. Must be in `PluginHooks`.
-     * @param args Arguments passed to the plugin hook.
-     * @param plugin The acutal plugin
-     * @param replaceContext When passed, the plugin context can be overridden.
-     */
-    private executeSync;
-    private catcher;
 }
 
 declare class ValidationPluginError extends Error {
@@ -473,7 +448,7 @@ type PackageJSON = {
     devDependencies?: Record<string, string>;
 };
 declare class PackageManager {
-    private cwd;
+    #private;
     constructor(workspace?: string);
     getPackageJSON(): Promise<PackageJSON | undefined>;
     getPackageJSONSync(): PackageJSON | undefined;
@@ -506,7 +481,7 @@ type KubbUserConfig = Omit<KubbConfig, 'root' | 'plugins'> & {
     plugins?: Array<KubbPlugin> | Array<KubbJSONPlugins> | KubbObjectPlugins;
 };
 /**
- * Global/internal config used through out the full generation.
+ * @private
  */
 type KubbConfig = {
     /**
@@ -517,27 +492,28 @@ type KubbConfig = {
     root: string;
     input: {
         /**
-         * Path to be used as the input. Can be an absolute path, or a path relative from
-         * the defined root option.
+         * Path to be used as the input. This can be an absolute path or a path relative to the `root`.
          */
         path: string;
     } | {
         /**
-         * String or object containing the data that you would normally import.
+         * `string` or `object` containing the data.
          */
         data: string | unknown;
     };
     output: {
         /**
-         * Path to be used to export all generated files. Can be an absolute path, or a path relative based of the defined root option.
+         * Path to be used to export all generated files.
+         * This can be an absolute path, or a path relative based of the defined `root` option.
          */
         path: string;
         /**
-         * Remove previous generated files and folders.
+         * Clean output directory before each build.
          */
         clean?: boolean;
         /**
-         * Enabled or disable the writing to the filesystem. This is being used for the playground.
+         * Write files to the fileSystem
+         * This is being used for the playground.
          * @default true
          */
         write?: boolean;
@@ -553,8 +529,8 @@ type KubbConfig = {
      */
     hooks?: {
         /**
-         * Hook that will be triggerend at the end of all executions.
-         * Useful for running Prettier or ESLint to use your own linting structure.
+         * Hook that will be triggered at the end of all executions.
+         * Useful for running Prettier or ESLint to format/lint your code.
          */
         done?: string | Array<string>;
     };
@@ -774,10 +750,12 @@ declare const pluginName: CorePluginOptions['name'];
  * Abstract class that contains the building blocks for plugins to create their own Generator
  * @link idea based on https://github.com/colinhacks/zod/blob/master/src/types.ts#L137
  */
-declare abstract class Generator<TOptions extends object = object> {
-    private _options;
-    constructor(options?: TOptions);
+declare abstract class Generator<TOptions = unknown, TContext = unknown> {
+    #private;
+    constructor(options?: TOptions, context?: TContext);
     get options(): TOptions;
+    get context(): TContext;
+    set options(options: TOptions);
     abstract build(...params: unknown[]): unknown;
 }