@kubb/core 2.0.0-beta.1 → 2.0.0-beta.2

package/dist/index.d.cts

@@ -167,7 +167,7 @@ declare class PluginManager {
     }): Promise<void>;
     getPluginsByKey(hookName: keyof PluginLifecycle, pluginKey: KubbPlugin['key']): KubbPlugin[];
     static getDependedPlugins<T1 extends PluginFactoryOptions, T2 extends PluginFactoryOptions = never, T3 extends PluginFactoryOptions = never, TOutput = T3 extends never ? T2 extends never ? [T1: KubbPlugin<T1>] : [T1: KubbPlugin<T1>, T2: KubbPlugin<T2>] : [T1: KubbPlugin<T1>, T2: KubbPlugin<T2>, T3: KubbPlugin<T3>]>(plugins: Array<KubbPlugin>, dependedPluginNames: string | string[]): TOutput;
-    static get hooks(): readonly ["validate", "buildStart", "resolvePath", "resolveName", "load", "transform", "writeFile", "buildEnd"];
+    static get hooks(): readonly ["buildStart", "resolvePath", "resolveName", "load", "transform", "writeFile", "buildEnd"];
 }
 
 interface Cache<TStore extends object = object> {
@@ -282,7 +282,6 @@ type CLIOptions = {
      */
     logLevel?: LogLevel;
 };
-type KubbPluginKind = 'schema' | 'controller';
 type KubbUnionPlugins = PluginUnion;
 type KubbObjectPlugin = keyof OptionsPlugins;
 type PluginFactoryOptions<
@@ -290,10 +289,6 @@ type PluginFactoryOptions<
  * Name to be used for the plugin, this will also be used for they key.
  */
 TName extends string = string, 
-/**
- * @type "schema" | "controller"
- */
-TKind extends KubbPluginKind = KubbPluginKind, 
 /**
  * Options of the plugin.
  */
@@ -316,55 +311,47 @@ TResolvePathOptions extends object = object,
  */
 TAppMeta = unknown> = {
     name: TName;
-    kind: TKind;
     /**
      * Same behaviour like what has been done with `QueryKey` in `@tanstack/react-query`
      */
-    key: [kind: TKind | undefined, name: TName | string, identifier?: string | number];
+    key: [name: TName | string, identifier?: string | number];
     options: TOptions;
     resolvedOptions: TResolvedOptions;
     api: TAPI;
     resolvePathOptions: TResolvePathOptions;
     appMeta: {
         pluginManager: PluginManager;
-        plugin: KubbPlugin<PluginFactoryOptions<TName, TKind, TOptions, TResolvedOptions, TAPI, TResolvePathOptions, TAppMeta>>;
+        plugin: KubbPlugin<PluginFactoryOptions<TName, TOptions, TResolvedOptions, TAPI, TResolvePathOptions, TAppMeta>>;
     } & TAppMeta;
 };
 type GetPluginFactoryOptions<TPlugin extends KubbUserPlugin> = TPlugin extends KubbUserPlugin<infer X> ? X : never;
 type KubbUserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
     /**
      * Unique name used for the plugin
+     * The name of the plugin follows the format scope:foo-bar or foo-bar, adding scope: can avoid naming conflicts with other plugins.
      * @example @kubb/typescript
      */
     name: TOptions['name'];
-    /**
-     * Internal key used when a developer uses more than one of the same plugin
-     * @private
-     */
-    key?: TOptions['key'];
     /**
      * Options set for a specific plugin(see kubb.config.js), passthrough of options.
      */
     options: TOptions['resolvedOptions'];
+    /**
+     * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin will be executed after these plugins.
+     * Can be used to validate depended plugins.
+     */
+    pre?: Array<string>;
+    /**
+     * 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;
 } : {
     api: (this: TOptions['name'] extends 'core' ? null : Omit<PluginContext<TOptions>, 'addFile'>) => TOptions['api'];
-}) & (TOptions['kind'] extends never ? {
-    kind?: never;
-} : {
-    /**
-     * Kind/type for the plugin
-     *
-     * Type 'schema' can be used for JSON schema's, TypeScript types, ...
-     *
-     * Type 'controller' can be used to create generate API calls, React-Query hooks, Axios controllers, ...
-     * @default undefined
-     */
-    kind: TOptions['kind'];
 });
 type KubbUserPluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = KubbUserPlugin<TOptions> & PluginLifecycle<TOptions>;
-type UnknownKubbUserPlugin = KubbUserPlugin<PluginFactoryOptions<any, any, any, any, any, any, any>>;
+type UnknownKubbUserPlugin = KubbUserPlugin<PluginFactoryOptions<any, any, any, any, any, any>>;
 type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
     /**
      * Unique name used for the plugin
@@ -377,16 +364,18 @@ type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
      */
     key: TOptions['key'];
     /**
-     * Options set for a specific plugin(see kubb.config.js), passthrough of options.
+     * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin will be executed after these plugins.
+     * Can be used to validate depended plugins.
      */
-    options: TOptions['resolvedOptions'];
+    pre?: Array<string>;
+    /**
+     * 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>;
     /**
-     * Kind/type for the plugin
-     * Type 'schema' can be used for JSON schema's, TypeScript types, ...
-     * Type 'controller' can be used to create generate API calls, React-Query hooks, Axios controllers, ...
-     * @default undefined
+     * Options set for a specific plugin(see kubb.config.js), passthrough of options.
      */
-    kind?: TOptions['kind'];
+    options: TOptions['resolvedOptions'];
 } & (TOptions['api'] extends never ? {
     api?: never;
 } : {
@@ -394,11 +383,6 @@ type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
 });
 type KubbPluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = KubbPlugin<TOptions> & PluginLifecycle<TOptions>;
 type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
-    /**
-     * Valdiate all plugins to see if their depended plugins are installed and configured.
-     * @type hookParallel
-     */
-    validate?: (this: Omit<PluginContext<TOptions>, 'addFile'>, plugins: NonNullable<KubbConfig['plugins']>) => PossiblePromise<true>;
     /**
      * Start of the lifecycle of a plugin.
      * @type hookParallel
@@ -739,4 +723,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 KubbPluginKind, 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, SchemaGenerator, 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, SchemaGenerator, type TransformResult, ValidationPluginError, Warning, type _Register, build, combineExports, combineImports, createPlugin, build as default, defineConfig, isInputPath, pluginName as name, pluginName, safeBuild };

package/dist/index.d.ts

@@ -167,7 +167,7 @@ declare class PluginManager {
     }): Promise<void>;
     getPluginsByKey(hookName: keyof PluginLifecycle, pluginKey: KubbPlugin['key']): KubbPlugin[];
     static getDependedPlugins<T1 extends PluginFactoryOptions, T2 extends PluginFactoryOptions = never, T3 extends PluginFactoryOptions = never, TOutput = T3 extends never ? T2 extends never ? [T1: KubbPlugin<T1>] : [T1: KubbPlugin<T1>, T2: KubbPlugin<T2>] : [T1: KubbPlugin<T1>, T2: KubbPlugin<T2>, T3: KubbPlugin<T3>]>(plugins: Array<KubbPlugin>, dependedPluginNames: string | string[]): TOutput;
-    static get hooks(): readonly ["validate", "buildStart", "resolvePath", "resolveName", "load", "transform", "writeFile", "buildEnd"];
+    static get hooks(): readonly ["buildStart", "resolvePath", "resolveName", "load", "transform", "writeFile", "buildEnd"];
 }
 
 interface Cache<TStore extends object = object> {
@@ -282,7 +282,6 @@ type CLIOptions = {
      */
     logLevel?: LogLevel;
 };
-type KubbPluginKind = 'schema' | 'controller';
 type KubbUnionPlugins = PluginUnion;
 type KubbObjectPlugin = keyof OptionsPlugins;
 type PluginFactoryOptions<
@@ -290,10 +289,6 @@ type PluginFactoryOptions<
  * Name to be used for the plugin, this will also be used for they key.
  */
 TName extends string = string, 
-/**
- * @type "schema" | "controller"
- */
-TKind extends KubbPluginKind = KubbPluginKind, 
 /**
  * Options of the plugin.
  */
@@ -316,55 +311,47 @@ TResolvePathOptions extends object = object,
  */
 TAppMeta = unknown> = {
     name: TName;
-    kind: TKind;
     /**
      * Same behaviour like what has been done with `QueryKey` in `@tanstack/react-query`
      */
-    key: [kind: TKind | undefined, name: TName | string, identifier?: string | number];
+    key: [name: TName | string, identifier?: string | number];
     options: TOptions;
     resolvedOptions: TResolvedOptions;
     api: TAPI;
     resolvePathOptions: TResolvePathOptions;
     appMeta: {
         pluginManager: PluginManager;
-        plugin: KubbPlugin<PluginFactoryOptions<TName, TKind, TOptions, TResolvedOptions, TAPI, TResolvePathOptions, TAppMeta>>;
+        plugin: KubbPlugin<PluginFactoryOptions<TName, TOptions, TResolvedOptions, TAPI, TResolvePathOptions, TAppMeta>>;
     } & TAppMeta;
 };
 type GetPluginFactoryOptions<TPlugin extends KubbUserPlugin> = TPlugin extends KubbUserPlugin<infer X> ? X : never;
 type KubbUserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
     /**
      * Unique name used for the plugin
+     * The name of the plugin follows the format scope:foo-bar or foo-bar, adding scope: can avoid naming conflicts with other plugins.
      * @example @kubb/typescript
      */
     name: TOptions['name'];
-    /**
-     * Internal key used when a developer uses more than one of the same plugin
-     * @private
-     */
-    key?: TOptions['key'];
     /**
      * Options set for a specific plugin(see kubb.config.js), passthrough of options.
      */
     options: TOptions['resolvedOptions'];
+    /**
+     * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin will be executed after these plugins.
+     * Can be used to validate depended plugins.
+     */
+    pre?: Array<string>;
+    /**
+     * 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;
 } : {
     api: (this: TOptions['name'] extends 'core' ? null : Omit<PluginContext<TOptions>, 'addFile'>) => TOptions['api'];
-}) & (TOptions['kind'] extends never ? {
-    kind?: never;
-} : {
-    /**
-     * Kind/type for the plugin
-     *
-     * Type 'schema' can be used for JSON schema's, TypeScript types, ...
-     *
-     * Type 'controller' can be used to create generate API calls, React-Query hooks, Axios controllers, ...
-     * @default undefined
-     */
-    kind: TOptions['kind'];
 });
 type KubbUserPluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = KubbUserPlugin<TOptions> & PluginLifecycle<TOptions>;
-type UnknownKubbUserPlugin = KubbUserPlugin<PluginFactoryOptions<any, any, any, any, any, any, any>>;
+type UnknownKubbUserPlugin = KubbUserPlugin<PluginFactoryOptions<any, any, any, any, any, any>>;
 type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
     /**
      * Unique name used for the plugin
@@ -377,16 +364,18 @@ type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
      */
     key: TOptions['key'];
     /**
-     * Options set for a specific plugin(see kubb.config.js), passthrough of options.
+     * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin will be executed after these plugins.
+     * Can be used to validate depended plugins.
      */
-    options: TOptions['resolvedOptions'];
+    pre?: Array<string>;
+    /**
+     * 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>;
     /**
-     * Kind/type for the plugin
-     * Type 'schema' can be used for JSON schema's, TypeScript types, ...
-     * Type 'controller' can be used to create generate API calls, React-Query hooks, Axios controllers, ...
-     * @default undefined
+     * Options set for a specific plugin(see kubb.config.js), passthrough of options.
      */
-    kind?: TOptions['kind'];
+    options: TOptions['resolvedOptions'];
 } & (TOptions['api'] extends never ? {
     api?: never;
 } : {
@@ -394,11 +383,6 @@ type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
 });
 type KubbPluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = KubbPlugin<TOptions> & PluginLifecycle<TOptions>;
 type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
-    /**
-     * Valdiate all plugins to see if their depended plugins are installed and configured.
-     * @type hookParallel
-     */
-    validate?: (this: Omit<PluginContext<TOptions>, 'addFile'>, plugins: NonNullable<KubbConfig['plugins']>) => PossiblePromise<true>;
     /**
      * Start of the lifecycle of a plugin.
      * @type hookParallel
@@ -739,4 +723,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 KubbPluginKind, 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, SchemaGenerator, 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, SchemaGenerator, type TransformResult, ValidationPluginError, Warning, type _Register, build, combineExports, combineImports, createPlugin, build as default, defineConfig, isInputPath, pluginName as name, pluginName, safeBuild };

package/dist/index.js

@@ -1127,8 +1127,7 @@ var definePlugin = createPlugin((options) => {
   return {
     name: pluginName,
     options,
-    key: ["controller", "core"],
-    kind: "controller",
+    key: ["core"],
     api() {
       return {
         get config() {
@@ -1472,16 +1471,15 @@ Names: ${JSON.stringify(names, void 0, 2)}`
   }
   getPluginsByKey(hookName, pluginKey) {
     const plugins = [...this.plugins];
-    const [searchKind, searchPluginName, searchIdentifier] = pluginKey;
+    const [searchPluginName, searchIdentifier] = pluginKey;
     const pluginByPluginName = plugins.filter((plugin) => plugin[hookName]).filter((item) => {
-      const [kind, name, identifier] = item.key;
+      const [name, identifier] = item.key;
       const identifierCheck = identifier?.toString() === searchIdentifier?.toString();
-      const kindCheck = kind === searchKind;
       const nameCheck = name === searchPluginName;
       if (searchIdentifier) {
-        return identifierCheck && kindCheck && nameCheck;
+        return identifierCheck && nameCheck;
       }
-      return kindCheck && nameCheck;
+      return nameCheck;
     });
     if (!pluginByPluginName?.length) {
       const corePlugin = plugins.find((plugin) => plugin.name === "core" && plugin[hookName]);
@@ -1513,7 +1511,7 @@ Names: ${JSON.stringify(names, void 0, 2)}`
   }
   // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
   static get hooks() {
-    return ["validate", "buildStart", "resolvePath", "resolveName", "load", "transform", "writeFile", "buildEnd"];
+    return ["buildStart", "resolvePath", "resolveName", "load", "transform", "writeFile", "buildEnd"];
   }
 };
 _core = new WeakMap();
@@ -1531,7 +1529,23 @@ getSortedPlugins_fn = function(hookName) {
     }
     return plugins.filter((item) => item[hookName]);
   }
-  return plugins;
+  return plugins.map((plugin) => {
+    if (plugin.pre) {
+      const isValid = plugin.pre.every((pluginName2) => plugins.find((pluginToFind) => pluginToFind.name === pluginName2));
+      if (!isValid) {
+        throw new ValidationPluginError(`This plugin has a pre set that is not valid(${JSON.stringify(plugin.pre, void 0, 2)})`);
+      }
+    }
+    return plugin;
+  }).sort((a, b) => {
+    if (b.pre?.includes(a.name)) {
+      return 1;
+    }
+    if (b.post?.includes(a.name)) {
+      return -1;
+    }
+    return 0;
+  });
 };
 _addExecutedToCallStack = new WeakSet();
 addExecutedToCallStack_fn = function(executer) {
@@ -1622,7 +1636,7 @@ _parse = new WeakSet();
 parse_fn = function(plugin, pluginManager, context) {
   const usedPluginNames = __privateGet(pluginManager, _usedPluginNames);
   setUniqueName(plugin.name, usedPluginNames);
-  const key = plugin.key || [plugin.kind, plugin.name, usedPluginNames[plugin.name]].filter(Boolean);
+  const key = [plugin.name, usedPluginNames[plugin.name]].filter(Boolean);
   if (plugin.name !== "core" && usedPluginNames[plugin.name] >= 2) {
     pluginManager.logger.warn("Using multiple of the same plugin is an experimental feature");
   }
@@ -1745,10 +1759,6 @@ ${code}`);
 async function build(options) {
   const pluginManager = await setup(options);
   const { fileManager, logger } = pluginManager;
-  await pluginManager.hookParallel({
-    hookName: "validate",
-    parameters: [pluginManager.plugins]
-  });
   await pluginManager.hookParallel({
     hookName: "buildStart",
     parameters: [options.config]
@@ -1764,10 +1774,6 @@ async function safeBuild(options) {
   const pluginManager = await setup(options);
   const { fileManager, logger } = pluginManager;
   try {
-    await pluginManager.hookParallel({
-      hookName: "validate",
-      parameters: [pluginManager.plugins]
-    });
     await pluginManager.hookParallel({
       hookName: "buildStart",
       parameters: [options.config]