@kubb/core 1.0.0-beta.1 → 1.0.0-beta.10

package/src/managers/pluginManager/PluginManager.ts

@@ -7,7 +7,7 @@ import { Queue } from '../../utils/queue'
 
 import type { QueueTask } from '../../utils/queue'
 import type { Argument0, Strategy } from './types'
-import type { KubbConfig, KubbPlugin, PluginLifecycleHooks, PluginLifecycle, MaybePromise, ResolveIdParams } from '../../types'
+import type { KubbConfig, KubbPlugin, PluginLifecycleHooks, PluginLifecycle, MaybePromise, ResolvePathParams, ResolveNameParams } from '../../types'
 import type { Logger } from '../../build'
 import type { CorePluginOptions } from '../../plugin'
 
@@ -19,7 +19,8 @@ const hookNames: {
 } = {
   validate: 1,
   buildStart: 1,
-  resolveId: 1,
+  resolvePath: 1,
+  resolveName: 1,
   load: 1,
   transform: 1,
   writeFile: 1,
@@ -50,70 +51,174 @@ export class PluginManager {
       config,
       fileManager: this.fileManager,
       load: this.load,
-      resolveId: this.resolveId,
+      resolvePath: this.resolvePath,
+      resolveName: this.resolveName,
     }) as KubbPlugin<CorePluginOptions> & {
       api: CorePluginOptions['api']
     }
     this.plugins = [this.core, ...(config.plugins || [])]
   }
 
-  resolveId = (params: ResolveIdParams) => {
+  resolvePath = (params: ResolvePathParams) => {
     if (params.pluginName) {
-      return this.hookForPlugin(params.pluginName, 'resolveId', [params.fileName, params.directory, params.options])
+      return this.hookForPluginSync({
+        pluginName: params.pluginName,
+        hookName: 'resolvePath',
+        parameters: [params.fileName, params.directory, params.options],
+      })
+    }
+    return this.hookFirstSync({
+      hookName: 'resolvePath',
+      parameters: [params.fileName, params.directory, params.options],
+    })
+  }
+
+  resolveName = (params: ResolveNameParams) => {
+    if (params.pluginName) {
+      return this.hookForPluginSync({
+        pluginName: params.pluginName,
+        hookName: 'resolveName',
+        parameters: [params.name],
+      })
     }
-    return this.hookFirst('resolveId', [params.fileName, params.directory, params.options])
+    return this.hookFirstSync({
+      hookName: 'resolveName',
+      parameters: [params.name],
+    })
   }
 
   load = async (id: string) => {
-    return this.hookFirst('load', [id])
+    return this.hookFirst({
+      hookName: 'load',
+      parameters: [id],
+    })
+  }
+
+  /**
+   *
+   * Run only hook for a specific plugin name
+   */
+  hookForPlugin<H extends PluginLifecycleHooks>({
+    pluginName,
+    hookName,
+    parameters,
+  }: {
+    pluginName: string
+    hookName: H
+    parameters: Parameters<PluginLifecycle[H]>
+  }): Promise<ReturnType<PluginLifecycle[H]> | null> {
+    const plugin = this.getPlugin(hookName, pluginName)
+
+    return this.run({
+      strategy: 'hookFirst',
+      hookName,
+      parameters,
+      plugin,
+    })
   }
 
-  // run only hook for a specific plugin name
-  hookForPlugin<H extends PluginLifecycleHooks>(
-    pluginName: string,
-    hookName: H,
-    parameters: Parameters<PluginLifecycle[H]>,
+  hookForPluginSync<H extends PluginLifecycleHooks>({
+    pluginName,
+    hookName,
+    parameters,
+  }: {
+    pluginName: string
+    hookName: H
+    parameters: Parameters<PluginLifecycle[H]>
+  }): ReturnType<PluginLifecycle[H]> | null {
+    const plugin = this.getPlugin(hookName, pluginName)
+
+    return this.runSync({
+      strategy: 'hookFirst',
+      hookName,
+      parameters,
+      plugin,
+    })
+  }
+
+  /**
+   *
+   * Chains, first non-null result stops and returns
+   */
+  hookFirst<H extends PluginLifecycleHooks>({
+    hookName,
+    parameters,
+    skipped,
+  }: {
+    hookName: H
+    parameters: Parameters<PluginLifecycle[H]>
     skipped?: ReadonlySet<KubbPlugin> | null
-  ): Promise<ReturnType<PluginLifecycle[H]> | null> {
+  }): Promise<ReturnType<PluginLifecycle[H]> | null> {
     let promise: Promise<ReturnType<PluginLifecycle[H]> | null> = Promise.resolve(null)
-    for (const plugin of this.getSortedPlugins(hookName, pluginName)) {
+    for (const plugin of this.getSortedPlugins(hookName)) {
       if (skipped && skipped.has(plugin)) continue
       promise = promise.then((result) => {
         if (result != null) return result
-        return this.run('hookFirst', hookName, parameters, plugin) as typeof result
+        return this.run({
+          strategy: 'hookFirst',
+          hookName,
+          parameters,
+          plugin,
+        }) as typeof result
       })
     }
     return promise
   }
 
-  // chains, first non-null result stops and returns
-  hookFirst<H extends PluginLifecycleHooks>(
-    hookName: H,
-    parameters: Parameters<PluginLifecycle[H]>,
+  /**
+   *
+   * Chains, first non-null result stops and returns
+   */
+  hookFirstSync<H extends PluginLifecycleHooks>({
+    hookName,
+    parameters,
+    skipped,
+  }: {
+    hookName: H
+    parameters: Parameters<PluginLifecycle[H]>
     skipped?: ReadonlySet<KubbPlugin> | null
-  ): Promise<ReturnType<PluginLifecycle[H]> | null> {
-    let promise: Promise<ReturnType<PluginLifecycle[H]> | null> = Promise.resolve(null)
+  }): ReturnType<PluginLifecycle[H]> | null {
+    let result = null
+
     for (const plugin of this.getSortedPlugins(hookName)) {
       if (skipped && skipped.has(plugin)) continue
-      promise = promise.then((result) => {
-        if (result != null) return result
-        return this.run('hookFirst', hookName, parameters, plugin) as typeof result
+
+      result = this.runSync({
+        strategy: 'hookFirst',
+        hookName,
+        parameters,
+        plugin,
       })
+
+      if (result != null) {
+        break
+      }
     }
-    return promise
+    return result
   }
 
   // parallel
-  async hookParallel<H extends PluginLifecycleHooks, TOuput = void>(hookName: H, parameters?: Parameters<PluginLifecycle[H]> | undefined) {
+  async hookParallel<H extends PluginLifecycleHooks, TOuput = void>({
+    hookName,
+    parameters,
+  }: {
+    hookName: H
+    parameters?: Parameters<PluginLifecycle[H]> | undefined
+  }) {
     const parallelPromises: Promise<TOuput>[] = []
 
     for (const plugin of this.getSortedPlugins(hookName)) {
       if ((plugin[hookName] as { sequential?: boolean })?.sequential) {
         await Promise.all(parallelPromises)
         parallelPromises.length = 0
-        await this.run('hookParallel', hookName, parameters, plugin)
+        await this.run({
+          strategy: 'hookParallel',
+          hookName,
+          parameters,
+          plugin,
+        })
       } else {
-        const promise: Promise<TOuput> = this.run('hookParallel', hookName, parameters, plugin)
+        const promise: Promise<TOuput> = this.run({ strategy: 'hookParallel', hookName, parameters, plugin })
 
         parallelPromises.push(promise)
       }
@@ -122,17 +227,26 @@ export class PluginManager {
   }
 
   // chains, reduces returned value, handling the reduced value as the first hook argument
-  hookReduceArg0<H extends PluginLifecycleHooks>(
-    hookName: H,
-    [argument0, ...rest]: Parameters<PluginLifecycle[H]>,
+  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>
-  ): Promise<Argument0<H>> {
+  }): Promise<Argument0<H>> {
+    const [argument0, ...rest] = parameters
+
     let promise: Promise<Argument0<H>> = Promise.resolve(argument0)
     for (const plugin of this.getSortedPlugins(hookName)) {
       promise = promise.then((argument0) =>
-        this.run('hookReduceArg0', hookName, [argument0, ...rest] as Parameters<PluginLifecycle[H]>, plugin).then((result) =>
-          reduce.call(this.core.api, argument0, result as ReturnType<PluginLifecycle[H]>, plugin)
-        )
+        this.run({
+          strategy: 'hookReduceArg0',
+          hookName,
+          parameters: [argument0, ...rest] as Parameters<PluginLifecycle[H]>,
+          plugin,
+        }).then((result) => reduce.call(this.core.api, argument0, result as ReturnType<PluginLifecycle[H]>, plugin))
       ) as Promise<Argument0<H>>
     }
     return promise
@@ -140,30 +254,39 @@ export class PluginManager {
 
   // chains
 
-  hookSeq<H extends PluginLifecycleHooks>(hookName: H, parameters?: Parameters<PluginLifecycle[H]>) {
+  hookSeq<H extends PluginLifecycleHooks>({ hookName, parameters }: { hookName: H; parameters?: Parameters<PluginLifecycle[H]> }) {
     let promise: Promise<void> = Promise.resolve()
     for (const plugin of this.getSortedPlugins(hookName)) {
-      promise = promise.then(() => this.run('hookSeq', hookName, parameters, plugin))
+      promise = promise.then(() =>
+        this.run({
+          strategy: 'hookSeq',
+          hookName,
+          parameters,
+          plugin,
+        })
+      )
     }
     return promise.then(noReturn)
   }
 
-  private getSortedPlugins(hookName: keyof PluginLifecycle, pluginName?: string): KubbPlugin[] {
+  private getSortedPlugins(_hookName: keyof PluginLifecycle): KubbPlugin[] {
     const plugins = [...this.plugins]
 
-    if (pluginName) {
-      const pluginsByPluginName = plugins.filter((item) => item.name === pluginName && item[hookName])
-      if (pluginsByPluginName.length === 0) {
-        // fallback on the core plugin when there is no match
-        if (this.config.logLevel === 'warn' && this.logger?.spinner) {
-          this.logger.spinner.info(`Plugin hook with ${hookName} not found for plugin ${pluginName}`)
-        }
-        return [this.core]
+    return plugins
+  }
+
+  private getPlugin(hookName: keyof PluginLifecycle, pluginName: string): KubbPlugin {
+    const plugins = [...this.plugins]
+
+    const pluginByPluginName = plugins.find((item) => item.name === pluginName && item[hookName])
+    if (!pluginByPluginName) {
+      // fallback on the core plugin when there is no match
+      if (this.config.logLevel === 'warn' && this.logger?.spinner) {
+        this.logger.spinner.info(`Plugin hook with ${hookName} not found for plugin ${pluginName}`)
       }
-      return pluginsByPluginName
+      return this.core
     }
-
-    return plugins
+    return pluginByPluginName
   }
 
   /**
@@ -173,12 +296,17 @@ export class PluginManager {
    * @param plugin The actual pluginObject to run.
    */
   // Implementation signature
-  private run<H extends PluginLifecycleHooks, TResult = void>(
-    strategy: Strategy,
-    hookName: H,
-    parameters: unknown[] | undefined,
+  private run<H extends PluginLifecycleHooks, TResult = void>({
+    strategy,
+    hookName,
+    parameters,
+    plugin,
+  }: {
+    strategy: Strategy
+    hookName: H
+    parameters: unknown[] | undefined
     plugin: KubbPlugin
-  ): Promise<TResult> {
+  }): Promise<TResult> {
     const hook = plugin[hookName]!
 
     return Promise.resolve()
@@ -221,20 +349,31 @@ export class PluginManager {
    * @param plugin The acutal plugin
    * @param replaceContext When passed, the plugin context can be overridden.
    */
-  private runSync<H extends PluginLifecycleHooks>(
-    hookName: H,
-    parameters: Parameters<PluginLifecycle[H]>,
+  private runSync<H extends PluginLifecycleHooks>({
+    strategy,
+    hookName,
+    parameters,
+    plugin,
+  }: {
+    strategy: Strategy
+    hookName: H
+    parameters: Parameters<PluginLifecycle[H]>
     plugin: KubbPlugin
-  ): ReturnType<PluginLifecycle[H]> | Error {
+  }): ReturnType<PluginLifecycle[H]> {
     const hook = plugin[hookName]!
 
     // const context = this.pluginContexts.get(plugin)!;
 
     try {
       // eslint-disable-next-line @typescript-eslint/ban-types
+      if (typeof hook !== 'function') {
+        return hook
+      }
+
       return (hook as Function).apply(this.core.api, parameters)
-    } catch (error) {
-      return error as Error
+    } catch (e) {
+      this.catcher<H>(e as Error, plugin, hookName)
+      return null as ReturnType<PluginLifecycle[H]>
     }
   }
 

package/src/plugin.ts

@@ -30,7 +30,8 @@ export function createPlugin<T extends PluginFactoryOptions = PluginFactoryOptio
 type Options = {
   config: PluginContext['config']
   fileManager: FileManager
-  resolveId: PluginContext['resolveId']
+  resolvePath: PluginContext['resolvePath']
+  resolveName: PluginContext['resolveName']
   load: PluginContext['load']
 }
 
@@ -40,7 +41,7 @@ export type CorePluginOptions = PluginFactoryOptions<Options, false, PluginConte
 export const name = 'core' as const
 
 export const definePlugin = createPlugin<CorePluginOptions>((options) => {
-  const { fileManager, resolveId, load } = options
+  const { fileManager, resolvePath, resolveName, load } = options
 
   const api: PluginContext = {
     get config() {
@@ -50,7 +51,8 @@ export const definePlugin = createPlugin<CorePluginOptions>((options) => {
     async addFile(file) {
       return fileManager.addOrAppend(file)
     },
-    resolveId,
+    resolvePath,
+    resolveName,
     load,
     cache: createPluginCache(Object.create(null)),
   }
@@ -59,11 +61,14 @@ export const definePlugin = createPlugin<CorePluginOptions>((options) => {
     name,
     options,
     api,
-    resolveId(fileName, directory) {
+    resolvePath(fileName, directory) {
       if (!directory) {
         return null
       }
       return pathParser.resolve(directory, fileName)
     },
+    resolveName(name) {
+      return name
+    },
   }
 })

package/src/types.ts

@@ -1,9 +1,12 @@
+/* eslint-disable @typescript-eslint/no-empty-interface */
 import type { FileManager, File } from './managers/fileManager'
 import type { Cache } from './utils/cache'
 
+export interface Register {}
+
 export type MaybePromise<T> = Promise<T> | T
 
-export type KubbUserConfig = Omit<KubbConfig, 'root'> & {
+export type KubbUserConfig = Omit<KubbConfig, 'root' | 'plugins'> & {
   /**
    * Project root directory. Can be an absolute path, or a path relative from
    * the location of the config file itself.
@@ -15,7 +18,7 @@ export type KubbUserConfig = Omit<KubbConfig, 'root'> & {
    * Example: ['@kubb/swagger', { output: false }]
    * Or: createSwagger({ output: false })
    */
-  plugins?: Array<unknown>
+  plugins?: KubbPlugin[] | KubbJSONPlugin[] | KubbObjectPlugin
 }
 
 /**
@@ -82,7 +85,11 @@ export type CLIOptions = {
 
 export type KubbPluginKind = 'schema' | 'controller'
 
-export type KubbJSONPlugin = [string, Record<string, any>]
+export type KubbJSONPlugin = [plugin: keyof Register | string, options: Register[keyof Register] | object]
+
+export type KubbObjectPlugin = {
+  [K in keyof Register]: Register[K] | object
+}
 
 export type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
   /**
@@ -108,11 +115,11 @@ export type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOpti
 } & Partial<PluginLifecycle<TOptions>>
 
 // use of type objects
-export type PluginFactoryOptions<Options = unknown, Nested extends boolean = false, Api = any, ResolveIdOptions = Record<string, any>> = {
+export type PluginFactoryOptions<Options = unknown, Nested extends boolean = false, Api = any, resolvePathOptions = Record<string, any>> = {
   options: Options
-  resolveIdOptions: ResolveIdOptions
   nested: Nested
   api: Api
+  resolvePathOptions: resolvePathOptions
 }
 
 export type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
@@ -127,13 +134,21 @@ export type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactor
    */
   buildStart: (this: PluginContext, kubbConfig: KubbConfig) => MaybePromise<void>
   /**
-   * Resolve to an id based on importee(example: `./Pet.ts`) and directory(example: `./models`).
+   * Resolve to a Path based on a fileName(example: `./Pet.ts`) and directory(example: `./models`).
+   * Options can als be included.
+   * @type hookFirst
+   * @example ('./Pet.ts', './src/gen/') => '/src/gen/Pet.ts'
+   */
+  resolvePath: (this: Omit<PluginContext, 'addFile'>, fileName: string, directory?: string, options?: TOptions['resolvePathOptions']) => OptionalPath
+  /**
+   * Resolve to a name based on a string.
+   * Useful when converting to PascalCase or camelCase.
    * @type hookFirst
-   * @example ('./Pet.ts', './src/gen/')
+   * @example ('pet') => 'Pet'
    */
-  resolveId: (this: Omit<PluginContext, 'addFile'>, fileName: string, directory?: string, options?: TOptions['resolveIdOptions']) => OptionalPath
+  resolveName: (this: Omit<PluginContext, 'addFile'>, name: string) => string | null
   /**
-   * Makes it possible to run async logic to override the path defined previously by `resolveId`.
+   * Makes it possible to run async logic to override the path defined previously by `resolvePath`.
    * @type hookFirst
    */
   load: (this: Omit<PluginContext, 'addFile'>, path: Path) => MaybePromise<TransformResult | null>
@@ -143,7 +158,7 @@ export type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactor
    */
   transform: (this: Omit<PluginContext, 'addFile'>, source: string, path: Path) => MaybePromise<TransformResult>
   /**
-   * Write the result to the file-system based on the id(defined by `resolveId` or changed by `load`).
+   * Write the result to the file-system based on the id(defined by `resolvePath` or changed by `load`).
    * @type hookParallel
    */
   writeFile: (this: Omit<PluginContext, 'addFile'>, source: string | undefined, path: Path) => MaybePromise<void>
@@ -156,26 +171,36 @@ export type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactor
 
 export type PluginLifecycleHooks = keyof PluginLifecycle
 
-export type ResolveIdParams<TOptions = Record<string, any>> = {
-  fileName: string
-  directory?: string | undefined
+export type ResolvePathParams<TOptions = Record<string, any>> = {
   /**
-   * When set, resolveId will only call resolveId of the name of the plugin set here.
-   * If not defined it will fall back on the resolveId of the core plugin.
+   * When set, resolvePath will only call resolvePath of the name of the plugin set here.
+   * If not defined it will fall back on the resolvePath of the core plugin.
    */
   pluginName?: string
+  fileName: string
+  directory?: string | undefined
   /**
-   * Options to be passed to 'resolveId' 3th parameter
+   * Options to be passed to 'resolvePath' 3th parameter
    */
   options?: TOptions
 }
 
+export type ResolveNameParams = {
+  /**
+   * When set, resolvePath will only call resolvePath of the name of the plugin set here.
+   * If not defined it will fall back on the resolvePath of the core plugin.
+   */
+  pluginName?: string
+  name: string
+}
+
 export type PluginContext<TOptions = Record<string, any>> = {
   config: KubbConfig
   cache: Cache
   fileManager: FileManager
   addFile: (file: File) => Promise<File>
-  resolveId: (params: ResolveIdParams<TOptions>) => MaybePromise<OptionalPath>
+  resolvePath: (params: ResolvePathParams<TOptions>) => OptionalPath
+  resolveName: (params: ResolveNameParams) => string | null
   load: (id: string) => MaybePromise<TransformResult | void>
 }
 

package/src/utils/getEncodedText.ts

@@ -0,0 +1,3 @@
+export function getEncodedText(text?: string): string {
+  return text ? text.replaceAll('`', '\\`') : ''
+}

package/src/utils/index.ts

@@ -9,3 +9,5 @@ export * from './jsdoc'
 export * from './getUniqueName'
 export * from './timeout'
 export * from './queue'
+export * from './getEncodedText'
+export * from './renderTemplate'

package/src/utils/jsdoc.ts

@@ -1,8 +1,8 @@
-export function createJSDocBlockText({ comments }: { comments: Array<string | undefined> }) {
+export function createJSDocBlockText({ comments }: { comments: Array<string> }): string {
   const filteredComments = comments.filter(Boolean)
 
   if (!filteredComments.length) {
-    return undefined
+    return ''
   }
 
   const text = filteredComments.reduce((acc, comment) => {

package/src/utils/renderTemplate.ts

@@ -0,0 +1,11 @@
+export function renderTemplate<TData extends Record<string, string> = Record<string, string>>(template: string, data: TData | undefined = undefined) {
+  if (!data) {
+    return template.replace(/{{(.*?)}}/g, '')
+  }
+
+  return template.replace(/{{(.*?)}}/g, (match) => {
+    const value = data[match.split(/{{|}}/).filter(Boolean)[0].trim()]
+
+    return value || ''
+  })
+}