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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/core",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0-beta.3",
   "description": "Generator core",
   "keywords": [
     "typescript",
@@ -57,8 +57,8 @@
     "picocolors": "^1.0.0",
     "seedrandom": "^3.0.5",
     "semver": "^7.5.4",
-    "@kubb/parser": "2.0.0-beta.1",
-    "@kubb/types": "2.0.0-beta.1"
+    "@kubb/parser": "2.0.0-beta.2",
+    "@kubb/types": "2.0.0-beta.2"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4",
@@ -71,8 +71,8 @@
     "tsup": "^8.0.1",
     "typescript": "^5.3.2",
     "@kubb/eslint-config": "1.1.8",
-    "@kubb/tsup-config": "1.1.8",
-    "@kubb/ts-config": "0.1.0"
+    "@kubb/ts-config": "0.1.0",
+    "@kubb/tsup-config": "1.1.8"
   },
   "packageManager": "pnpm@8.3.0",
   "engines": {

package/src/PluginManager.ts

@@ -388,28 +388,46 @@ export class PluginManager {
 
       return plugins.filter((item) => item[hookName])
     }
+    // TODO add test case for sorting with pre/post
 
-    return plugins
+    return plugins.map(plugin => {
+      if (plugin.pre) {
+        const isValid = plugin.pre.every(pluginName => plugins.find(pluginToFind => pluginToFind.name === pluginName))
+
+        if (!isValid) {
+          throw new ValidationPluginError(`This plugin has a pre set that is not valid(${JSON.stringify(plugin.pre, undefined, 2)})`)
+        }
+      }
+
+      return plugin
+    }).sort((a, b) => {
+      if (b.pre?.includes(a.name)) {
+        return 1
+      }
+      if (b.post?.includes(a.name)) {
+        return -1
+      }
+      return 0
+    })
   }
 
   getPluginsByKey(hookName: keyof PluginLifecycle, pluginKey: KubbPlugin['key']): KubbPlugin[] {
     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) {
@@ -569,7 +587,7 @@ export class PluginManager {
 
     setUniqueName(plugin.name, usedPluginNames)
 
-    const key = plugin.key || ([plugin.kind, plugin.name, usedPluginNames[plugin.name]].filter(Boolean) as [typeof plugin.kind, typeof plugin.name, string])
+    const key = [plugin.name, usedPluginNames[plugin.name]].filter(Boolean) as [typeof plugin.name, string]
 
     if (plugin.name !== 'core' && usedPluginNames[plugin.name]! >= 2) {
       pluginManager.logger.warn('Using multiple of the same plugin is an experimental feature')
@@ -624,6 +642,6 @@ export class PluginManager {
 
   // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
   static get hooks() {
-    return ['validate', 'buildStart', 'resolvePath', 'resolveName', 'load', 'transform', 'writeFile', 'buildEnd'] as const
+    return ['buildStart', 'resolvePath', 'resolveName', 'load', 'transform', 'writeFile', 'buildEnd'] as const
   }
 }

package/src/build.ts

@@ -157,11 +157,6 @@ export async function build(options: BuildOptions): Promise<BuildOutput> {
 
   const { fileManager, logger } = pluginManager
 
-  await pluginManager.hookParallel<'validate', true>({
-    hookName: 'validate',
-    parameters: [pluginManager.plugins],
-  })
-
   await pluginManager.hookParallel({
     hookName: 'buildStart',
     parameters: [options.config],
@@ -183,11 +178,6 @@ export async function safeBuild(options: BuildOptions): Promise<BuildOutput> {
   const { fileManager, logger } = pluginManager
 
   try {
-    await pluginManager.hookParallel<'validate', true>({
-      hookName: 'validate',
-      parameters: [pluginManager.plugins],
-    })
-
     await pluginManager.hookParallel({
       hookName: 'buildStart',
       parameters: [options.config],

package/src/plugin.ts

@@ -26,10 +26,10 @@ type Options = {
 }
 
 // not publicly exported
-export type CorePluginOptions = PluginFactoryOptions<'core', 'controller', Options, Options, PluginContext, never>
+export type CorePluginOptions = PluginFactoryOptions<'core', Options, Options, PluginContext, never>
 
 export const pluginName = 'core' satisfies CorePluginOptions['name']
-export const pluginKey: CorePluginOptions['key'] = ['controller', pluginName] satisfies CorePluginOptions['key']
+export const pluginKey: CorePluginOptions['key'] = [pluginName] satisfies CorePluginOptions['key']
 
 export const definePlugin = createPlugin<CorePluginOptions>((options) => {
   const { fileManager, pluginManager, resolvePath, resolveName, logger } = options
@@ -37,8 +37,8 @@ export const definePlugin = createPlugin<CorePluginOptions>((options) => {
   return {
     name: pluginName,
     options,
-    key: ['controller', 'core'],
-    kind: 'controller',
+    key: ['core'],
+
     api() {
       return {
         get config() {

package/src/types.ts

@@ -123,8 +123,6 @@ export type CLIOptions = {
 
 // plugin
 
-export type KubbPluginKind = 'schema' | 'controller'
-
 export type KubbUnionPlugins = PluginUnion
 
 export type KubbObjectPlugin = keyof OptionsPlugins
@@ -134,10 +132,6 @@ export 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.
    */
@@ -161,18 +155,17 @@ export type PluginFactoryOptions<
   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
 }
 
@@ -182,18 +175,23 @@ export type KubbUserPlugin<TOptions extends PluginFactoryOptions = PluginFactory
   & {
     /**
      * 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
@@ -201,24 +199,10 @@ export type KubbUserPlugin<TOptions extends PluginFactoryOptions = PluginFactory
     : {
       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']
-    })
 
 export 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>>
 
 export type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
   & {
@@ -233,16 +217,18 @@ export type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOpti
      */
     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>
     /**
-     * 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
+     * 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.
      */
-    kind?: TOptions['kind']
+    post?: Array<string>
+    /**
+     * Options set for a specific plugin(see kubb.config.js), passthrough of options.
+     */
+    options: TOptions['resolvedOptions']
     /**
      * Define an api that can be used by other plugins, see `PluginManager' where we convert from `KubbUserPlugin` to `KubbPlugin`(used when calling `createPlugin`).
      */
@@ -257,11 +243,6 @@ export type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOpti
 export type KubbPluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = KubbPlugin<TOptions> & PluginLifecycle<TOptions>
 
 export 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