@kubb/core 1.1.4 → 1.1.5

package/dist/index.cjs

@@ -627,7 +627,7 @@ var PluginManager = class {
     return this.hookFirstSync({
       hookName: "resolvePath",
       parameters: [params.fileName, params.directory, params.options]
-    });
+    }).result;
   };
   resolveName = (params) => {
     if (params.pluginName) {
@@ -640,7 +640,7 @@ var PluginManager = class {
     return this.hookFirstSync({
       hookName: "resolveName",
       parameters: [params.name]
-    });
+    }).result;
   };
   load = async (id) => {
     return this.hookFirst({
@@ -691,15 +691,20 @@ var PluginManager = class {
     for (const plugin of this.getSortedPlugins(hookName)) {
       if (skipped && skipped.has(plugin))
         continue;
-      promise = promise.then((result) => {
-        if (result != null)
+      promise = promise.then(async (result) => {
+        if (result != null) {
           return result;
-        return this.execute({
+        }
+        const value = await this.execute({
           strategy: "hookFirst",
           hookName,
           parameters,
           plugin
         });
+        return Promise.resolve({
+          plugin,
+          result: value
+        });
       });
     }
     return promise;
@@ -717,12 +722,14 @@ var PluginManager = class {
     for (const plugin of this.getSortedPlugins(hookName)) {
       if (skipped && skipped.has(plugin))
         continue;
-      result = this.executeSync({
-        strategy: "hookFirst",
-        hookName,
-        parameters,
-        plugin
-      });
+      result = {
+        result: this.executeSync({
+          strategy: "hookFirst",
+          hookName,
+          parameters,
+          plugin
+        })
+      };
       if (result != null) {
         break;
       }
@@ -796,7 +803,7 @@ var PluginManager = class {
     return promise.then(noReturn);
   }
   getSortedPlugins(_hookName) {
-    const plugins = [...this.plugins];
+    const plugins = [...this.plugins].filter((plugin) => plugin.name !== "core");
     return plugins;
   }
   getPlugin(hookName, pluginName) {
@@ -1080,11 +1087,14 @@ async function build(options) {
   const queueTask = async (id, file) => {
     const { path } = file;
     let code = getFileSource(file);
-    const loadedResult = await pluginManager.hookFirst({
+    const { result: loadedResult } = await pluginManager.hookFirst({
       hookName: "load",
       parameters: [path]
     });
-    if (loadedResult) {
+    if (loadedResult && isPromise(loadedResult)) {
+      code = await loadedResult;
+    }
+    if (loadedResult && !isPromise(loadedResult)) {
       code = loadedResult;
     }
     if (code) {

package/dist/index.d.ts

@@ -154,22 +154,14 @@ type Executer<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
     plugin: KubbPlugin;
 };
 type OnExecute<H extends PluginLifecycleHooks = PluginLifecycleHooks> = (this: PluginManager, executer: Executer<H> | undefined) => void;
-
-type KubbPluginFactory<T extends PluginFactoryOptions = PluginFactoryOptions> = (options: T['options']) => T['nested'] extends true ? Array<KubbPlugin<T>> : KubbPlugin<T>;
-declare function createPlugin<T extends PluginFactoryOptions = PluginFactoryOptions>(factory: KubbPluginFactory<T>): (options: T['options']) => T["nested"] extends true ? KubbPlugin<T>[] : KubbPlugin<T>;
-type Options$1 = {
-    config: PluginContext['config'];
-    fileManager: FileManager;
-    resolvePath: PluginContext['resolvePath'];
-    resolveName: PluginContext['resolveName'];
-    load: PluginContext['load'];
-    getExecuter: () => Executer<PluginLifecycleHooks> | undefined;
+type ParseResult<H extends PluginLifecycleHooks> = PluginLifecycle[H];
+type SafeParseResult<H extends PluginLifecycleHooks, Result = ReturnType<ParseResult<H>>> = {
+    result: Result;
+    plugin: KubbPlugin;
 };
-type CorePluginOptions = PluginFactoryOptions<Options$1, false, PluginContext>;
-declare const name: "core";
 
 declare const hooks: [keyof PluginLifecycle<PluginFactoryOptions<unknown, false, any, Record<string, any>>>];
-type Options = {
+type Options$1 = {
     task: QueueTask;
     onExecute?: OnExecute<PluginLifecycleHooks>;
 };
@@ -177,15 +169,15 @@ declare class PluginManager {
     plugins: KubbPlugin[];
     readonly fileManager: FileManager;
     private readonly onExecute?;
-    readonly core: KubbPlugin<CorePluginOptions>;
+    private readonly core;
     queue: Queue;
     executer: Executer | undefined;
     executed: Executer[];
-    constructor(config: KubbConfig, options: Options);
+    constructor(config: KubbConfig, options: Options$1);
     getExecuter(): Executer | undefined;
     resolvePath: (params: ResolvePathParams) => OptionalPath;
     resolveName: (params: ResolveNameParams) => string | null;
-    load: (id: string) => Promise<TransformResult>;
+    load: (id: string) => Promise<SafeParseResult<"load">>;
     /**
      *
      * Run only hook for a specific plugin name
@@ -194,12 +186,12 @@ declare class PluginManager {
         pluginName: string;
         hookName: H;
         parameters: Parameters<PluginLifecycle[H]>;
-    }): Promise<ReturnType<PluginLifecycle[H]> | null> | null;
+    }): Promise<ReturnType<ParseResult<H>> | null> | null;
     hookForPluginSync<H extends PluginLifecycleHooks>({ pluginName, hookName, parameters, }: {
         pluginName: string;
         hookName: H;
         parameters: Parameters<PluginLifecycle[H]>;
-    }): ReturnType<PluginLifecycle[H]> | null;
+    }): ReturnType<ParseResult<H>> | null;
     /**
      *
      * Chains, first non-null result stops and returns
@@ -208,7 +200,7 @@ declare class PluginManager {
         hookName: H;
         parameters: Parameters<PluginLifecycle[H]>;
         skipped?: ReadonlySet<KubbPlugin> | null;
-    }): Promise<ReturnType<PluginLifecycle[H]>>;
+    }): Promise<SafeParseResult<H>>;
     /**
      *
      * Chains, first non-null result stops and returns
@@ -217,7 +209,7 @@ declare class PluginManager {
         hookName: H;
         parameters: Parameters<PluginLifecycle[H]>;
         skipped?: ReadonlySet<KubbPlugin> | null;
-    }): ReturnType<PluginLifecycle[H]>;
+    }): SafeParseResult<H>;
     hookParallel<H extends PluginLifecycleHooks, TOuput = void>({ hookName, parameters, }: {
         hookName: H;
         parameters?: Parameters<PluginLifecycle[H]> | undefined;
@@ -225,7 +217,7 @@ declare class PluginManager {
     hookReduceArg0<H extends PluginLifecycleHooks>({ hookName, parameters, reduce, }: {
         hookName: H;
         parameters: Parameters<PluginLifecycle[H]>;
-        reduce: (reduction: Argument0<H>, result: ReturnType<PluginLifecycle[H]>, plugin: KubbPlugin) => MaybePromise<Argument0<H> | null>;
+        reduce: (reduction: Argument0<H>, result: ReturnType<ParseResult<H>>, plugin: KubbPlugin) => MaybePromise<Argument0<H> | null>;
     }): Promise<Argument0<H>>;
     hookSeq<H extends PluginLifecycleHooks>({ hookName, parameters }: {
         hookName: H;
@@ -490,7 +482,7 @@ type PluginContext<TOptions = Record<string, any>> = {
     addFile: (...file: File[]) => Promise<File[]>;
     resolvePath: (params: ResolvePathParams<TOptions>) => OptionalPath;
     resolveName: (params: ResolveNameParams) => string | null | undefined;
-    load: (id: string) => MaybePromise<TransformResult | void>;
+    load: (id: string) => Promise<SafeParseResult<'load'>>;
 };
 type TransformResult = string | null;
 /**
@@ -518,6 +510,19 @@ declare function build(options: BuildOptions): Promise<BuildOutput>;
  */
 declare const defineConfig: (options: MaybePromise<KubbUserConfig> | ((cliOptions: CLIOptions) => MaybePromise<KubbUserConfig>)) => MaybePromise<KubbUserConfig> | ((cliOptions: CLIOptions) => MaybePromise<KubbUserConfig>);
 
+type KubbPluginFactory<T extends PluginFactoryOptions = PluginFactoryOptions> = (options: T['options']) => T['nested'] extends true ? Array<KubbPlugin<T>> : KubbPlugin<T>;
+declare function createPlugin<T extends PluginFactoryOptions = PluginFactoryOptions>(factory: KubbPluginFactory<T>): (options: T['options']) => T["nested"] extends true ? KubbPlugin<T>[] : KubbPlugin<T>;
+type Options = {
+    config: PluginContext['config'];
+    fileManager: FileManager;
+    resolvePath: PluginContext['resolvePath'];
+    resolveName: PluginContext['resolveName'];
+    load: PluginContext['load'];
+    getExecuter: () => Executer<PluginLifecycleHooks> | undefined;
+};
+type CorePluginOptions = PluginFactoryOptions<Options, false, PluginContext>;
+declare const name: "core";
+
 /**
  * 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
@@ -536,4 +541,4 @@ declare abstract class SchemaGenerator<TOptions extends object, TInput, TOutput>
     abstract build(schema: TInput, name: string, description?: string): TOutput;
 }
 
-export { Argument0, BuildOutput, CLIOptions, Cache, CacheStore, CorePluginOptions, Executer, File, FileManager, FileName, Generator, KubbConfig, KubbJSONPlugin, KubbObjectPlugin, KubbPlugin, KubbPluginKind, KubbUserConfig, LogLevel, Logger, MaybePromise, OnExecute, OptionalPath, ParallelPluginError, Path, PathMode, PluginContext, PluginError, PluginFactoryOptions, PluginLifecycle, PluginLifecycleHooks, PluginManager, Queue, QueueTask, Register, ResolveNameParams, ResolvePathParams, SchemaGenerator, Status, Strategy, TransformResult, TreeNode, TreeNodeOptions, UUID, ValidationPluginError, build, clean, combineFiles, createJSDocBlockText, createPlugin, createPluginCache, build as default, defineConfig, getEncodedText, getFileSource, getPathMode, getRelativePath, getStackTrace, getUniqueName, hooks, isPromise, isURL, name, nameSorter, objectToParameters, read, renderTemplate, timeout, transformReservedWord, validatePlugins, write, writeIndexes };
+export { Argument0, BuildOutput, CLIOptions, Cache, CacheStore, CorePluginOptions, Executer, File, FileManager, FileName, Generator, KubbConfig, KubbJSONPlugin, KubbObjectPlugin, KubbPlugin, KubbPluginKind, KubbUserConfig, LogLevel, Logger, MaybePromise, OnExecute, OptionalPath, ParallelPluginError, ParseResult, Path, PathMode, PluginContext, PluginError, PluginFactoryOptions, PluginLifecycle, PluginLifecycleHooks, PluginManager, Queue, QueueTask, Register, ResolveNameParams, ResolvePathParams, SafeParseResult, SchemaGenerator, Status, Strategy, TransformResult, TreeNode, TreeNodeOptions, UUID, ValidationPluginError, build, clean, combineFiles, createJSDocBlockText, createPlugin, createPluginCache, build as default, defineConfig, getEncodedText, getFileSource, getPathMode, getRelativePath, getStackTrace, getUniqueName, hooks, isPromise, isURL, name, nameSorter, objectToParameters, read, renderTemplate, timeout, transformReservedWord, validatePlugins, write, writeIndexes };

package/dist/index.js

@@ -617,7 +617,7 @@ var PluginManager = class {
     return this.hookFirstSync({
       hookName: "resolvePath",
       parameters: [params.fileName, params.directory, params.options]
-    });
+    }).result;
   };
   resolveName = (params) => {
     if (params.pluginName) {
@@ -630,7 +630,7 @@ var PluginManager = class {
     return this.hookFirstSync({
       hookName: "resolveName",
       parameters: [params.name]
-    });
+    }).result;
   };
   load = async (id) => {
     return this.hookFirst({
@@ -681,15 +681,20 @@ var PluginManager = class {
     for (const plugin of this.getSortedPlugins(hookName)) {
       if (skipped && skipped.has(plugin))
         continue;
-      promise = promise.then((result) => {
-        if (result != null)
+      promise = promise.then(async (result) => {
+        if (result != null) {
           return result;
-        return this.execute({
+        }
+        const value = await this.execute({
           strategy: "hookFirst",
           hookName,
           parameters,
           plugin
         });
+        return Promise.resolve({
+          plugin,
+          result: value
+        });
       });
     }
     return promise;
@@ -707,12 +712,14 @@ var PluginManager = class {
     for (const plugin of this.getSortedPlugins(hookName)) {
       if (skipped && skipped.has(plugin))
         continue;
-      result = this.executeSync({
-        strategy: "hookFirst",
-        hookName,
-        parameters,
-        plugin
-      });
+      result = {
+        result: this.executeSync({
+          strategy: "hookFirst",
+          hookName,
+          parameters,
+          plugin
+        })
+      };
       if (result != null) {
         break;
       }
@@ -786,7 +793,7 @@ var PluginManager = class {
     return promise.then(noReturn);
   }
   getSortedPlugins(_hookName) {
-    const plugins = [...this.plugins];
+    const plugins = [...this.plugins].filter((plugin) => plugin.name !== "core");
     return plugins;
   }
   getPlugin(hookName, pluginName) {
@@ -1070,11 +1077,14 @@ async function build(options) {
   const queueTask = async (id, file) => {
     const { path } = file;
     let code = getFileSource(file);
-    const loadedResult = await pluginManager.hookFirst({
+    const { result: loadedResult } = await pluginManager.hookFirst({
       hookName: "load",
       parameters: [path]
     });
-    if (loadedResult) {
+    if (loadedResult && isPromise(loadedResult)) {
+      code = await loadedResult;
+    }
+    if (loadedResult && !isPromise(loadedResult)) {
       code = loadedResult;
     }
     if (code) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/core",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "description": "Generator core",
   "repository": {
     "type": "git",
@@ -43,7 +43,7 @@
     "change-case": "^4.1.2",
     "directory-tree": "^3.5.1",
     "rimraf": "^5.0.1",
-    "@kubb/ts-codegen": "1.1.4"
+    "@kubb/ts-codegen": "1.1.5"
   },
   "devDependencies": {
     "tsup": "^6.7.0",

package/src/build.ts

@@ -2,6 +2,7 @@
 import { PluginManager } from './managers/pluginManager/index.ts'
 import { clean, isURL, read } from './utils/index.ts'
 import { getFileSource } from './managers/fileManager/index.ts'
+import { isPromise } from './utils/isPromise.ts'
 
 import type { OnExecute } from './managers/pluginManager/index.ts'
 import type { File } from './managers/fileManager/index.ts'
@@ -48,13 +49,16 @@ export async function build(options: BuildOptions): Promise<BuildOutput> {
   const queueTask = async (id: string, file: File) => {
     const { path } = file
 
-    let code = getFileSource(file)
+    let code: string | null = getFileSource(file)
 
-    const loadedResult = await pluginManager.hookFirst({
+    const { result: loadedResult } = await pluginManager.hookFirst({
       hookName: 'load',
       parameters: [path],
     })
-    if (loadedResult) {
+    if (loadedResult && isPromise(loadedResult)) {
+      code = await loadedResult
+    }
+    if (loadedResult && !isPromise(loadedResult)) {
       code = loadedResult
     }
 

package/src/managers/pluginManager/PluginManager.ts

@@ -11,7 +11,7 @@ import { Queue } from '../../utils/Queue.ts'
 import { isPromise } from '../../utils/isPromise.ts'
 
 import type { QueueTask } from '../../utils/Queue.ts'
-import type { Argument0, Strategy, Executer, OnExecute } from './types.ts'
+import type { Argument0, Strategy, Executer, OnExecute, ParseResult, SafeParseResult } from './types.ts'
 import type { KubbConfig, KubbPlugin, PluginLifecycleHooks, PluginLifecycle, MaybePromise, ResolvePathParams, ResolveNameParams } from '../../types.ts'
 import type { CorePluginOptions } from '../../plugin.ts'
 
@@ -41,7 +41,7 @@ export class PluginManager {
 
   private readonly onExecute?: OnExecute
 
-  public readonly core: KubbPlugin<CorePluginOptions>
+  private readonly core: KubbPlugin<CorePluginOptions>
 
   public queue: Queue
 
@@ -82,7 +82,7 @@ export class PluginManager {
     return this.hookFirstSync({
       hookName: 'resolvePath',
       parameters: [params.fileName, params.directory, params.options],
-    })
+    }).result
   }
 
   resolveName = (params: ResolveNameParams) => {
@@ -96,7 +96,7 @@ export class PluginManager {
     return this.hookFirstSync({
       hookName: 'resolveName',
       parameters: [params.name],
-    })
+    }).result
   }
 
   load = async (id: string) => {
@@ -118,7 +118,7 @@ export class PluginManager {
     pluginName: string
     hookName: H
     parameters: Parameters<PluginLifecycle[H]>
-  }): Promise<ReturnType<PluginLifecycle[H]> | null> | null {
+  }): Promise<ReturnType<ParseResult<H>> | null> | null {
     const plugin = this.getPlugin(hookName, pluginName)
 
     return this.execute({
@@ -137,7 +137,7 @@ export class PluginManager {
     pluginName: string
     hookName: H
     parameters: Parameters<PluginLifecycle[H]>
-  }): ReturnType<PluginLifecycle[H]> | null {
+  }): ReturnType<ParseResult<H>> | null {
     const plugin = this.getPlugin(hookName, pluginName)
 
     return this.executeSync({
@@ -160,20 +160,29 @@ export class PluginManager {
     hookName: H
     parameters: Parameters<PluginLifecycle[H]>
     skipped?: ReadonlySet<KubbPlugin> | null
-  }): Promise<ReturnType<PluginLifecycle[H]>> {
-    let promise: Promise<ReturnType<PluginLifecycle[H]>> = Promise.resolve(null as ReturnType<PluginLifecycle[H]>)
+  }): Promise<SafeParseResult<H>> {
+    let promise: Promise<SafeParseResult<H>> = Promise.resolve(null as any)
+
     for (const plugin of this.getSortedPlugins(hookName)) {
       if (skipped && skipped.has(plugin)) continue
-      promise = promise.then((result) => {
-        if (result != null) return result
-        return this.execute({
+      promise = promise.then(async (result) => {
+        if (result != null) {
+          return result
+        }
+        const value = await this.execute<H>({
           strategy: 'hookFirst',
           hookName,
           parameters,
           plugin,
-        }) as typeof result
+        })
+
+        return Promise.resolve({
+          plugin,
+          result: value,
+        } as typeof result)
       })
     }
+
     return promise
   }
 
@@ -189,24 +198,26 @@ export class PluginManager {
     hookName: H
     parameters: Parameters<PluginLifecycle[H]>
     skipped?: ReadonlySet<KubbPlugin> | null
-  }): ReturnType<PluginLifecycle[H]> {
-    let result = null
+  }): SafeParseResult<H> {
+    let result: SafeParseResult<H> = null as unknown as SafeParseResult<H>
 
     for (const plugin of this.getSortedPlugins(hookName)) {
       if (skipped && skipped.has(plugin)) continue
 
-      result = this.executeSync<H>({
-        strategy: 'hookFirst',
-        hookName,
-        parameters,
-        plugin,
-      })
+      result = {
+        result: this.executeSync<H>({
+          strategy: 'hookFirst',
+          hookName,
+          parameters,
+          plugin,
+        }),
+      } as SafeParseResult<H>
 
       if (result != null) {
         break
       }
     }
-    return result as ReturnType<PluginLifecycle[H]>
+    return result as SafeParseResult<H>
   }
 
   // parallel
@@ -255,7 +266,7 @@ export class PluginManager {
   }: {
     hookName: H
     parameters: Parameters<PluginLifecycle[H]>
-    reduce: (reduction: Argument0<H>, result: ReturnType<PluginLifecycle[H]>, plugin: KubbPlugin) => MaybePromise<Argument0<H> | null>
+    reduce: (reduction: Argument0<H>, result: ReturnType<ParseResult<H>>, plugin: KubbPlugin) => MaybePromise<Argument0<H> | null>
   }): Promise<Argument0<H>> {
     const [argument0, ...rest] = parameters
 
@@ -271,7 +282,7 @@ export class PluginManager {
           })
           return value
         })
-        .then((result) => reduce.call(this.core.api, argument0, result as ReturnType<PluginLifecycle[H]>, plugin)) as Promise<Argument0<H>>
+        .then((result) => reduce.call(this.core.api, argument0, result as ReturnType<ParseResult<H>>, plugin)) as Promise<Argument0<H>>
     }
     return promise
   }
@@ -294,7 +305,7 @@ export class PluginManager {
   }
 
   private getSortedPlugins(_hookName: keyof PluginLifecycle): KubbPlugin[] {
-    const plugins = [...this.plugins]
+    const plugins = [...this.plugins].filter((plugin) => plugin.name !== 'core')
 
     return plugins
   }
@@ -400,7 +411,7 @@ export class PluginManager {
     hookName: H
     parameters: Parameters<PluginLifecycle[H]>
     plugin: KubbPlugin
-  }): ReturnType<PluginLifecycle[H]> | null {
+  }): ReturnType<ParseResult<H>> | null {
     const hook = plugin[hookName]
 
     if (!hook) {
@@ -438,7 +449,7 @@ export class PluginManager {
     } catch (e) {
       this.catcher<H>(e as Error, plugin, hookName)
 
-      return null as ReturnType<PluginLifecycle[H]>
+      return null as ReturnType<ParseResult<H>>
     }
   }
 

package/src/managers/pluginManager/types.ts

@@ -15,3 +15,10 @@ export type Executer<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
 }
 
 export type OnExecute<H extends PluginLifecycleHooks = PluginLifecycleHooks> = (this: PluginManager, executer: Executer<H> | undefined) => void
+
+export type ParseResult<H extends PluginLifecycleHooks> = PluginLifecycle[H]
+
+export type SafeParseResult<H extends PluginLifecycleHooks, Result = ReturnType<ParseResult<H>>> = {
+  result: Result
+  plugin: KubbPlugin
+}

package/src/types.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-empty-interface */
-import type { PluginManager } from './managers/index.ts'
+import type { PluginManager, SafeParseResult } from './managers/index.ts'
 import type { FileManager, File } from './managers/fileManager/index.ts'
 import type { Cache } from './utils/cache.ts'
 
@@ -237,7 +237,7 @@ export type PluginContext<TOptions = Record<string, any>> = {
   addFile: (...file: File[]) => Promise<File[]>
   resolvePath: (params: ResolvePathParams<TOptions>) => OptionalPath
   resolveName: (params: ResolveNameParams) => string | null | undefined
-  load: (id: string) => MaybePromise<TransformResult | void>
+  load: (id: string) => Promise<SafeParseResult<'load'>>
 }
 
 // null will mean clear the watcher for this key