@kubb/core 3.0.0-alpha.1 → 3.0.0-alpha.3

package/dist/{FileManager-EVJig-LT.d.ts → FileManager-BW--rO8q.d.ts}

@@ -128,7 +128,7 @@ declare class PluginManager {
     }): Promise<void>;
     getPluginsByKey(hookName: keyof PluginLifecycle, pluginKey: Plugin['key']): Plugin[];
     static getDependedPlugins<T1 extends PluginFactoryOptions, T2 extends PluginFactoryOptions = never, T3 extends PluginFactoryOptions = never, TOutput = T3 extends never ? (T2 extends never ? [T1: Plugin<T1>] : [T1: Plugin<T1>, T2: Plugin<T2>]) : [T1: Plugin<T1>, T2: Plugin<T2>, T3: Plugin<T3>]>(plugins: Array<Plugin>, dependedPluginNames: string | string[]): TOutput;
-    static get hooks(): readonly ["buildStart", "resolvePath", "resolveName", "load", "transform", "writeFile", "buildEnd"];
+    static get hooks(): readonly ["buildStart", "resolvePath", "resolveName", "buildEnd"];
 }
 
 interface Cache<TStore extends object = object> {
@@ -154,11 +154,9 @@ type UserConfig = Omit<Config, 'root' | 'plugins'> & {
      */
     root?: string;
     /**
-     * Plugin type can be KubbJSONPlugin or Plugin
-     * Example: ['@kubb/plugin-oas', { output: false }]
-     * Or: pluginOas({ output: false })
+     * Plugin type should be a Kubb plugin
      */
-    plugins?: Array<Omit<UnknownUserPlugin, 'api'>>;
+    plugins?: Array<Omit<UnknownUserPlugin, 'context'>>;
 };
 type InputPath = {
     /**
@@ -236,9 +234,9 @@ TOptions extends object = object,
  */
 TResolvedOptions extends object = TOptions, 
 /**
- * API that you want to expose to other plugins.
+ * Context that you want to expose to other plugins.
  */
-TAPI = any, 
+TContext = any, 
 /**
  * When calling `resolvePath` you can specify better types.
  */
@@ -250,7 +248,7 @@ TResolvePathOptions extends object = object> = {
     key: PluginKey<TName | string>;
     options: TOptions;
     resolvedOptions: TResolvedOptions;
-    api: TAPI;
+    context: TContext;
     resolvePathOptions: TResolvePathOptions;
 };
 type PluginKey<TName> = [name: TName, identifier?: string | number];
@@ -275,10 +273,10 @@ type UserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
      * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin will be executed before these plugins.
      */
     post?: Array<string>;
-} & (TOptions['api'] extends never ? {
-    api?: never;
+} & (TOptions['context'] extends never ? {
+    context?: never;
 } : {
-    api: (this: TOptions['name'] extends 'core' ? null : Omit<PluginContext<TOptions>, 'addFile'>) => TOptions['api'];
+    context: (this: TOptions['name'] extends 'core' ? null : Omit<PluginContext<TOptions>, 'addFile'>) => TOptions['context'];
 });
 type UserPluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = UserPlugin<TOptions> & PluginLifecycle<TOptions>;
 type UnknownUserPlugin = UserPlugin<PluginFactoryOptions<any, any, any, any, any>>;
@@ -306,10 +304,10 @@ type Plugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
      * Options set for a specific plugin(see kubb.config.js), passthrough of options.
      */
     options: TOptions['resolvedOptions'];
-} & (TOptions['api'] extends never ? {
-    api?: never;
+} & (TOptions['context'] extends never ? {
+    context?: never;
 } : {
-    api: TOptions['api'];
+    context: TOptions['context'];
 });
 type PluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = Plugin<TOptions> & PluginLifecycle<TOptions>;
 type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
@@ -332,21 +330,6 @@ type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactoryOption
      * @example ('pet') => 'Pet'
      */
     resolveName?: (this: PluginContext<TOptions>, name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
-    /**
-     * Makes it possible to run async logic to override the path defined previously by `resolvePath`.
-     * @type hookFirst
-     */
-    load?: (this: Omit<PluginContext<TOptions>, 'addFile'>, path: KubbFile.Path) => PossiblePromise<TransformResult | null>;
-    /**
-     * Transform the source-code.
-     * @type hookReduceArg0
-     */
-    transform?: (this: Omit<PluginContext<TOptions>, 'addFile'>, source: string, path: KubbFile.Path) => PossiblePromise<TransformResult>;
-    /**
-     * Write the result to the file-system based on the id(defined by `resolvePath` or changed by `load`).
-     * @type hookParallel
-     */
-    writeFile?: (this: Omit<PluginContext<TOptions>, 'addFile'>, path: KubbFile.Path, source: string | undefined) => PossiblePromise<string | void>;
     /**
      * End of the plugin lifecycle.
      * @type hookParallel
@@ -393,7 +376,6 @@ type PluginContext<TOptions extends PluginFactoryOptions = PluginFactoryOptions>
      */
     plugin: Plugin<TOptions>;
 };
-type TransformResult = string | null;
 
 type ResolvedFile<TMeta extends FileMetaBase = FileMetaBase, TBaseName extends BaseName = BaseName> = File<TMeta, TBaseName> & {
     /**
@@ -452,4 +434,4 @@ declare class FileManager {
     static isJavascript(baseName: string): boolean;
 }
 
-export { type Config as C, FileManager as F, type GetPluginFactoryOptions as G, type InputPath as I, type PluginContext as P, type ResolvePathParams as R, type TransformResult as T, type UserConfig as U, PluginManager as a, type PluginFactoryOptions as b, type UserPluginWithLifeCycle as c, type FileMetaBase as d, type InputData as e, type PluginKey as f, type UserPlugin as g, type Plugin as h, type PluginWithLifeCycle as i, type PluginLifecycle as j, type PluginLifecycleHooks as k, type PluginParameter as l, type PluginCache as m, type ResolveNameParams as n };
+export { type Config as C, FileManager as F, type GetPluginFactoryOptions as G, type InputPath as I, type PluginContext as P, type ResolvePathParams as R, type UserConfig as U, PluginManager as a, type PluginFactoryOptions as b, type UserPluginWithLifeCycle as c, type FileMetaBase as d, type InputData as e, type PluginKey as f, type UserPlugin as g, type Plugin as h, type PluginWithLifeCycle as i, type PluginLifecycle as j, type PluginLifecycleHooks as k, type PluginParameter as l, type PluginCache as m, type ResolveNameParams as n };

package/dist/{FileManager-DSLZ6ps7.d.cts → FileManager-Bw-FNS3q.d.cts}

@@ -128,7 +128,7 @@ declare class PluginManager {
     }): Promise<void>;
     getPluginsByKey(hookName: keyof PluginLifecycle, pluginKey: Plugin['key']): Plugin[];
     static getDependedPlugins<T1 extends PluginFactoryOptions, T2 extends PluginFactoryOptions = never, T3 extends PluginFactoryOptions = never, TOutput = T3 extends never ? (T2 extends never ? [T1: Plugin<T1>] : [T1: Plugin<T1>, T2: Plugin<T2>]) : [T1: Plugin<T1>, T2: Plugin<T2>, T3: Plugin<T3>]>(plugins: Array<Plugin>, dependedPluginNames: string | string[]): TOutput;
-    static get hooks(): readonly ["buildStart", "resolvePath", "resolveName", "load", "transform", "writeFile", "buildEnd"];
+    static get hooks(): readonly ["buildStart", "resolvePath", "resolveName", "buildEnd"];
 }
 
 interface Cache<TStore extends object = object> {
@@ -154,11 +154,9 @@ type UserConfig = Omit<Config, 'root' | 'plugins'> & {
      */
     root?: string;
     /**
-     * Plugin type can be KubbJSONPlugin or Plugin
-     * Example: ['@kubb/plugin-oas', { output: false }]
-     * Or: pluginOas({ output: false })
+     * Plugin type should be a Kubb plugin
      */
-    plugins?: Array<Omit<UnknownUserPlugin, 'api'>>;
+    plugins?: Array<Omit<UnknownUserPlugin, 'context'>>;
 };
 type InputPath = {
     /**
@@ -236,9 +234,9 @@ TOptions extends object = object,
  */
 TResolvedOptions extends object = TOptions, 
 /**
- * API that you want to expose to other plugins.
+ * Context that you want to expose to other plugins.
  */
-TAPI = any, 
+TContext = any, 
 /**
  * When calling `resolvePath` you can specify better types.
  */
@@ -250,7 +248,7 @@ TResolvePathOptions extends object = object> = {
     key: PluginKey<TName | string>;
     options: TOptions;
     resolvedOptions: TResolvedOptions;
-    api: TAPI;
+    context: TContext;
     resolvePathOptions: TResolvePathOptions;
 };
 type PluginKey<TName> = [name: TName, identifier?: string | number];
@@ -275,10 +273,10 @@ type UserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
      * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin will be executed before these plugins.
      */
     post?: Array<string>;
-} & (TOptions['api'] extends never ? {
-    api?: never;
+} & (TOptions['context'] extends never ? {
+    context?: never;
 } : {
-    api: (this: TOptions['name'] extends 'core' ? null : Omit<PluginContext<TOptions>, 'addFile'>) => TOptions['api'];
+    context: (this: TOptions['name'] extends 'core' ? null : Omit<PluginContext<TOptions>, 'addFile'>) => TOptions['context'];
 });
 type UserPluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = UserPlugin<TOptions> & PluginLifecycle<TOptions>;
 type UnknownUserPlugin = UserPlugin<PluginFactoryOptions<any, any, any, any, any>>;
@@ -306,10 +304,10 @@ type Plugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
      * Options set for a specific plugin(see kubb.config.js), passthrough of options.
      */
     options: TOptions['resolvedOptions'];
-} & (TOptions['api'] extends never ? {
-    api?: never;
+} & (TOptions['context'] extends never ? {
+    context?: never;
 } : {
-    api: TOptions['api'];
+    context: TOptions['context'];
 });
 type PluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = Plugin<TOptions> & PluginLifecycle<TOptions>;
 type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
@@ -332,21 +330,6 @@ type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactoryOption
      * @example ('pet') => 'Pet'
      */
     resolveName?: (this: PluginContext<TOptions>, name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
-    /**
-     * Makes it possible to run async logic to override the path defined previously by `resolvePath`.
-     * @type hookFirst
-     */
-    load?: (this: Omit<PluginContext<TOptions>, 'addFile'>, path: KubbFile.Path) => PossiblePromise<TransformResult | null>;
-    /**
-     * Transform the source-code.
-     * @type hookReduceArg0
-     */
-    transform?: (this: Omit<PluginContext<TOptions>, 'addFile'>, source: string, path: KubbFile.Path) => PossiblePromise<TransformResult>;
-    /**
-     * Write the result to the file-system based on the id(defined by `resolvePath` or changed by `load`).
-     * @type hookParallel
-     */
-    writeFile?: (this: Omit<PluginContext<TOptions>, 'addFile'>, path: KubbFile.Path, source: string | undefined) => PossiblePromise<string | void>;
     /**
      * End of the plugin lifecycle.
      * @type hookParallel
@@ -393,7 +376,6 @@ type PluginContext<TOptions extends PluginFactoryOptions = PluginFactoryOptions>
      */
     plugin: Plugin<TOptions>;
 };
-type TransformResult = string | null;
 
 type ResolvedFile<TMeta extends FileMetaBase = FileMetaBase, TBaseName extends BaseName = BaseName> = File<TMeta, TBaseName> & {
     /**
@@ -452,4 +434,4 @@ declare class FileManager {
     static isJavascript(baseName: string): boolean;
 }
 
-export { type Config as C, FileManager as F, type GetPluginFactoryOptions as G, type InputPath as I, type PluginContext as P, type ResolvePathParams as R, type TransformResult as T, type UserConfig as U, PluginManager as a, type PluginFactoryOptions as b, type UserPluginWithLifeCycle as c, type FileMetaBase as d, type InputData as e, type PluginKey as f, type UserPlugin as g, type Plugin as h, type PluginWithLifeCycle as i, type PluginLifecycle as j, type PluginLifecycleHooks as k, type PluginParameter as l, type PluginCache as m, type ResolveNameParams as n };
+export { type Config as C, FileManager as F, type GetPluginFactoryOptions as G, type InputPath as I, type PluginContext as P, type ResolvePathParams as R, type UserConfig as U, PluginManager as a, type PluginFactoryOptions as b, type UserPluginWithLifeCycle as c, type FileMetaBase as d, type InputData as e, type PluginKey as f, type UserPlugin as g, type Plugin as h, type PluginWithLifeCycle as i, type PluginLifecycle as j, type PluginLifecycleHooks as k, type PluginParameter as l, type PluginCache as m, type ResolveNameParams as n };