@kubb/core 2.0.0-alpha.4 → 2.0.0-alpha.5

package/src/types.ts

@@ -1,9 +1,12 @@
+import type { PossiblePromise } from '@kubb/types'
 import type { FileManager, KubbFile } from './FileManager.ts'
 import type { OptionsPlugins, PluginUnion } from './index.ts'
 import type { PluginManager } from './PluginManager.ts'
 import type { Cache } from './utils/cache.ts'
 import type { Logger, LogLevel } from './utils/logger.ts'
 
+// config
+
 /**
  * Config used in `kubb.config.js`
  *
@@ -12,20 +15,22 @@ import type { Logger, LogLevel } from './utils/logger.ts'
  * ...
  * })
  */
-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.
-   * @default process.cwd()
-   */
-  root?: string
-  /**
-   * Plugin type can be KubbJSONPlugin or KubbPlugin
-   * Example: ['@kubb/swagger', { output: false }]
-   * Or: createSwagger({ output: false })
-   */
-  plugins?: Array<Omit<KubbUserPlugin, 'api'> | KubbUnionPlugins | [name: string, options: object]>
-}
+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.
+     * @default process.cwd()
+     */
+    root?: string
+    /**
+     * Plugin type can be KubbJSONPlugin or KubbPlugin
+     * Example: ['@kubb/swagger', { output: false }]
+     * Or: createSwagger({ output: false })
+     */
+    plugins?: Array<Omit<UnknownKubbUserPlugin, 'api'> | KubbUnionPlugins | [name: string, options: object]>
+  }
 
 export type InputPath = {
   /**
@@ -116,15 +121,6 @@ export type CLIOptions = {
   logLevel?: LogLevel
 }
 
-export type BuildOutput = {
-  files: FileManager['files']
-  pluginManager: PluginManager
-  /**
-   * Only for safeBuild
-   */
-  error?: Error
-}
-
 // plugin
 
 export type KubbPluginKind = 'schema' | 'controller'
@@ -133,6 +129,53 @@ export type KubbUnionPlugins = PluginUnion
 
 export type KubbObjectPlugin = keyof OptionsPlugins
 
+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.
+   */
+  TOptions extends object = object,
+  /**
+   * Options of the plugin that can be used later on, see `options` inside your plugin config.
+   */
+  TResolvedOptions extends object = TOptions,
+  /**
+   * API that you want to expose to other plugins.
+   */
+  TAPI = any,
+  /**
+   * When calling `resolvePath` you can specify better types.
+   */
+  TResolvePathOptions extends object = object,
+  /**
+   * When using @kubb/react(based on React) you can specify here which types should be used when calling render.
+   * Always extend from `AppMeta` of the core.
+   */
+  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]
+  options: TOptions
+  resolvedOptions: TResolvedOptions
+  api: TAPI
+  resolvePathOptions: TResolvePathOptions
+  appMeta: {
+    pluginManager: PluginManager
+    plugin: KubbPlugin<PluginFactoryOptions<TName, TKind, TOptions, TResolvedOptions, TAPI, TResolvePathOptions, TAppMeta>>
+  } & TAppMeta
+}
+
 export type GetPluginFactoryOptions<TPlugin extends KubbUserPlugin> = TPlugin extends KubbUserPlugin<infer X> ? X : never
 
 export type KubbUserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
@@ -150,14 +193,13 @@ export type KubbUserPlugin<TOptions extends PluginFactoryOptions = PluginFactory
     /**
      * Options set for a specific plugin(see kubb.config.js), passthrough of options.
      */
-    options: TOptions['options'] extends never ? undefined : TOptions['options']
+    options: TOptions['resolvedOptions']
   }
-  & Partial<PluginLifecycle<TOptions>>
   & (TOptions['api'] extends never ? {
       api?: never
     }
     : {
-      api: (this: TOptions['name'] extends 'core' ? null : Omit<PluginContext, 'addFile'>) => TOptions['api']
+      api: (this: TOptions['name'] extends 'core' ? null : Omit<PluginContext<TOptions>, 'addFile'>) => TOptions['api']
     })
   & (TOptions['kind'] extends never ? {
       kind?: never
@@ -172,6 +214,10 @@ export type KubbUserPlugin<TOptions extends PluginFactoryOptions = PluginFactory
       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>>
+
 export type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
   & {
     /**
@@ -187,19 +233,18 @@ export type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOpti
     /**
      * Options set for a specific plugin(see kubb.config.js), passthrough of options.
      */
-    options: TOptions['options'] extends never ? undefined : TOptions['options']
+    options: TOptions['resolvedOptions']
     /**
      * 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?: KubbPluginKind
+    kind?: TOptions['kind']
     /**
      * Define an api that can be used by other plugins, see `PluginManager' where we convert from `KubbUserPlugin` to `KubbPlugin`(used when calling `createPlugin`).
      */
   }
-  & PluginLifecycle<TOptions>
   & (TOptions['api'] extends never ? {
       api?: never
     }
@@ -207,73 +252,53 @@ export type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOpti
       api: TOptions['api']
     })
 
-// use of type objects
-
-export type PluginFactoryOptions<
-  Name = string,
-  Kind extends KubbPluginKind = KubbPluginKind | never,
-  Options = unknown | never,
-  Nested extends boolean = false,
-  API = unknown | never,
-  resolvePathOptions = Record<string, unknown>,
-> = {
-  name: Name
-  kind: Kind
-  /**
-   * Same like `QueryKey` in `@tanstack/react-query`
-   */
-  key: [kind: Kind | undefined, name: Name, identifier?: string | number]
-  options: Options
-  nested: Nested
-  api: API
-  resolvePathOptions: resolvePathOptions
-}
+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, 'addFile'>, plugins: NonNullable<KubbConfig['plugins']>) => PossiblePromise<true>
+  validate?: (this: Omit<PluginContext<TOptions>, 'addFile'>, plugins: NonNullable<KubbConfig['plugins']>) => PossiblePromise<true>
   /**
    * Start of the lifecycle of a plugin.
    * @type hookParallel
    */
-  buildStart?: (this: PluginContext, kubbConfig: KubbConfig) => PossiblePromise<void>
+  buildStart?: (this: PluginContext<TOptions>, kubbConfig: KubbConfig) => PossiblePromise<void>
   /**
    * Resolve to a Path based on a baseName(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: PluginContext, baseName: string, directory?: string, options?: TOptions['resolvePathOptions']) => KubbFile.OptionalPath
+  resolvePath?: (this: PluginContext<TOptions>, baseName: string, directory?: string, options?: TOptions['resolvePathOptions']) => KubbFile.OptionalPath
   /**
    * Resolve to a name based on a string.
    * Useful when converting to PascalCase or camelCase.
    * @type hookFirst
    * @example ('pet') => 'Pet'
    */
-  resolveName?: (this: PluginContext, name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string
+  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, 'addFile'>, path: KubbFile.Path) => PossiblePromise<TransformResult | null>
+  load?: (this: Omit<PluginContext<TOptions>, 'addFile'>, path: KubbFile.Path) => PossiblePromise<TransformResult | null>
   /**
    * Transform the source-code.
    * @type hookReduceArg0
    */
-  transform?: (this: Omit<PluginContext, 'addFile'>, source: string, path: KubbFile.Path) => PossiblePromise<TransformResult>
+  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, 'addFile'>, source: string | undefined, path: KubbFile.Path) => PossiblePromise<string | void>
+  writeFile?: (this: Omit<PluginContext<TOptions>, 'addFile'>, source: string | undefined, path: KubbFile.Path) => PossiblePromise<string | void>
   /**
    * End of the plugin lifecycle.
    * @type hookParallel
    */
-  buildEnd?: (this: PluginContext) => PossiblePromise<void>
+  buildEnd?: (this: PluginContext<TOptions>) => PossiblePromise<void>
 }
 
 export type PluginLifecycleHooks = keyof PluginLifecycle
@@ -282,7 +307,7 @@ export type PluginParameter<H extends PluginLifecycleHooks> = Parameters<Require
 
 export type PluginCache = Record<string, [number, unknown]>
 
-export type ResolvePathParams<TOptions = Record<string, unknown>> = {
+export type ResolvePathParams<TOptions = object> = {
   pluginKey?: KubbPlugin['key']
   baseName: string
   directory?: string | undefined
@@ -295,16 +320,16 @@ export type ResolvePathParams<TOptions = Record<string, unknown>> = {
 export type ResolveNameParams = {
   name: string
   pluginKey?: KubbPlugin['key']
-  type?: 'file' | 'function'
+  type?: 'file' | 'function' | 'type'
 }
 
-export type PluginContext<TOptions = Record<string, unknown>> = {
+export type PluginContext<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
   config: KubbConfig
   cache: Cache<PluginCache>
   fileManager: FileManager
   pluginManager: PluginManager
   addFile: (...file: Array<KubbFile.File>) => Promise<Array<KubbFile.File>>
-  resolvePath: (params: ResolvePathParams<TOptions>) => KubbFile.OptionalPath
+  resolvePath: (params: ResolvePathParams<TOptions['resolvePathOptions']>) => KubbFile.OptionalPath
   resolveName: (params: ResolveNameParams) => string
   logger: Logger
   /**
@@ -314,57 +339,8 @@ export type PluginContext<TOptions = Record<string, unknown>> = {
   /**
    * Current plugin
    */
-  plugin: KubbPlugin
+  plugin: KubbPlugin<TOptions>
 }
 
 // null will mean clear the watcher for this key
 export type TransformResult = string | null
-
-export type AppMeta = { pluginManager: PluginManager }
-
-// generic types
-
-export type Prettify<T> =
-  & {
-    [K in keyof T]: T[K]
-  }
-  // eslint-disable-next-line @typescript-eslint/ban-types
-  & {}
-
-/**
- * TODO move to @kubb/types
- * @deprecated
- */
-export type PossiblePromise<T> = Promise<T> | T
-
-type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never
-type LastOf<T> = UnionToIntersection<T extends any ? () => T : never> extends () => infer R ? R : never
-
-// TS4.0+
-type Push<T extends any[], V> = [...T, V]
-
-// TS4.1+
-type TuplifyUnion<T, L = LastOf<T>, N = [T] extends [never] ? true : false> = true extends N ? [] : Push<TuplifyUnion<Exclude<T, L>>, L>
-/**
- * TODO move to @kubb/types
- * @deprecated
- */
-export type ObjValueTuple<T, KS extends any[] = TuplifyUnion<keyof T>, R extends any[] = []> = KS extends [infer K, ...infer KT]
-  ? ObjValueTuple<T, KT, [...R, [name: K & keyof T, options: T[K & keyof T]]]>
-  : R
-/**
- * TODO move to @kubb/types
- * @deprecated
- */
-export type TupleToUnion<T> = T extends Array<infer ITEMS> ? ITEMS : never
-
-/**
- * TODO move to @kubb/types
- * @deprecated
- */
-type ArrayWithLength<T extends number, U extends any[] = []> = U['length'] extends T ? U : ArrayWithLength<T, [true, ...U]>
-/**
- * TODO move to @kubb/types
- * @deprecated
- */
-export type GreaterThan<T extends number, U extends number> = ArrayWithLength<U> extends [...ArrayWithLength<T>, ...infer _] ? false : true

package/src/utils/logger.ts

@@ -53,7 +53,7 @@ export function createLogger({ logLevel, name, spinner }: Props): Logger {
   }
 
   const info: Logger['warn'] = (message) => {
-    if (message && spinner) {
+    if (message && spinner && logLevel !== LogLevel.silent) {
       spinner.info(message)
       logs.push(message)
     }

package/src/utils/promise.ts

@@ -1,4 +1,4 @@
-type PossiblePromise<T> = Promise<T> | T
+import type { PossiblePromise } from '@kubb/types'
 
 export function isPromise<T>(result: PossiblePromise<T>): result is Promise<T> {
   return !!result && typeof (result as Promise<unknown>)?.then === 'function'

package/src/utils/transformers/index.ts

@@ -5,6 +5,7 @@ import { createIndent } from './indent.ts'
 import { nameSorter } from './nameSorter.ts'
 import { searchAndReplace } from './searchAndReplace.ts'
 import { transformReservedWord } from './transformReservedWord.ts'
+import { trim } from './trim.ts'
 
 export const transformers = {
   combineCodes,
@@ -14,6 +15,7 @@ export const transformers = {
   transformReservedWord,
   nameSorter,
   searchAndReplace,
+  trim,
   JSDoc: {
     createJSDocBlockText,
   },

package/src/utils/transformers/trim.ts

@@ -0,0 +1,3 @@
+export function trim(text: string): string {
+  return text.replaceAll(/\n/g, '').trim()
+}