@kubb/core 3.0.0-alpha.0 → 3.0.0-alpha.2

package/src/build.ts

@@ -3,13 +3,12 @@ import c from 'tinyrainbow'
 import { clean, read } from '@kubb/fs'
 import { FileManager, type ResolvedFile } from './FileManager.ts'
 import { PluginManager } from './PluginManager.ts'
-import { isPromise } from './PromiseManager.ts'
 import { isInputPath } from './config.ts'
 import { LogLevel, createLogger, randomCliColour } from './logger.ts'
 import { URLPath } from './utils/URLPath.ts'
 
 import type { Logger } from './logger.ts'
-import type { Plugin, PluginContext, PluginParameter, TransformResult } from './types.ts'
+import type { PluginContext, PluginParameter } from './types.ts'
 
 type BuildOptions = {
   config: PluginContext['config']
@@ -28,15 +27,6 @@ type BuildOutput = {
   error?: Error
 }
 
-async function transformReducer(
-  this: PluginContext,
-  _previousCode: string,
-  result: TransformResult | Promise<TransformResult>,
-  _plugin: Plugin,
-): Promise<string | null> {
-  return result
-}
-
 async function setup(options: BuildOptions): Promise<PluginManager> {
   const { config, logger = createLogger({ logLevel: LogLevel.silent }) } = options
   let count = 0
@@ -63,40 +53,11 @@ async function setup(options: BuildOptions): Promise<PluginManager> {
   const task = async (file: ResolvedFile): Promise<ResolvedFile> => {
     const { path } = file
 
-    let source: string | null = await FileManager.getSource(file)
-
-    const { result: loadedResult } = await pluginManager.hookFirst({
-      hookName: 'load',
-      parameters: [path],
-    })
-    if (loadedResult && isPromise(loadedResult)) {
-      source = await loadedResult
-    }
-    if (loadedResult && !isPromise(loadedResult)) {
-      source = loadedResult
-    }
+    const source: string | null = await FileManager.getSource(file)
 
     if (source) {
-      source = await pluginManager.hookReduceArg0({
-        hookName: 'transform',
-        parameters: [path, source],
-        reduce: transformReducer,
-      })
-
       if (config.output.write || config.output.write === undefined) {
-        if (file.meta?.pluginKey) {
-          // run only for pluginKey defined in the meta of the file
-          await pluginManager.hookForPlugin({
-            pluginKey: file.meta?.pluginKey,
-            hookName: 'writeFile',
-            parameters: [path, source],
-          })
-        }
-
-        await pluginManager.hookFirst({
-          hookName: 'writeFile',
-          parameters: [path, source],
-        })
+        await pluginManager.fileManager.write(path, source, { sanity: false })
       }
     }
 
@@ -108,16 +69,6 @@ async function setup(options: BuildOptions): Promise<PluginManager> {
 
   const pluginManager = new PluginManager(config, { logger, task })
 
-  pluginManager.on('execute', (executer) => {
-    const { hookName, parameters, plugin } = executer
-
-    if (hookName === 'writeFile') {
-      const [code] = parameters as PluginParameter<'writeFile'>
-
-      logger.emit('debug', [`PluginKey ${c.dim(JSON.stringify(plugin.key))} \nwith source\n\n${code}`])
-    }
-  })
-
   pluginManager.queue.on('add', () => {
     if (logger.logLevel !== LogLevel.info) {
       return

package/src/index.ts

@@ -9,6 +9,3 @@ export { createPlugin } from './plugin.ts'
 export { PluginManager } from './PluginManager.ts'
 export { PromiseManager } from './PromiseManager.ts'
 export type * from './types.ts'
-
-// biome-ignore lint/suspicious/noEmptyInterface: <explanation>
-export interface _Register {}

package/src/plugin.ts

@@ -37,7 +37,7 @@ export const pluginCore = createPlugin<PluginCore>((options) => {
     name: 'core',
     options,
     key: ['core'],
-    api() {
+    context() {
       return {
         get config() {
           return options.config

package/src/types.ts

@@ -2,7 +2,6 @@ import type * as KubbFile from '@kubb/fs/types'
 import type { PossiblePromise } from '@kubb/types'
 import type { FileManager } from './FileManager.ts'
 import type { PluginManager } from './PluginManager.ts'
-import type { OptionsPlugins, PluginUnion } from './kubb.ts'
 import type { Logger } from './logger.ts'
 import type { Cache } from './utils/cache.ts'
 
@@ -24,11 +23,9 @@ export 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'> | UnionPlugins | [name: string, options: object]>
+  plugins?: Array<Omit<UnknownUserPlugin, 'context'>>
 }
 
 export type InputPath = {
@@ -99,10 +96,6 @@ export type Config<TInput = Input> = {
 
 // plugin
 
-export type UnionPlugins = PluginUnion
-
-export type ObjectPlugin = keyof OptionsPlugins
-
 export type PluginFactoryOptions<
   /**
    * Name to be used for the plugin, this will also be used for they key.
@@ -117,9 +110,9 @@ export type PluginFactoryOptions<
    */
   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.
    */
@@ -132,7 +125,7 @@ export type PluginFactoryOptions<
   key: PluginKey<TName | string>
   options: TOptions
   resolvedOptions: TResolvedOptions
-  api: TAPI
+  context: TContext
   resolvePathOptions: TResolvePathOptions
 }
 
@@ -160,12 +153,12 @@ export type UserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOpti
    * 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
+} & (TOptions['context'] extends never
   ? {
-      api?: 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']
     })
 
 export type UserPluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = UserPlugin<TOptions> & PluginLifecycle<TOptions>
@@ -197,14 +190,14 @@ export type Plugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions>
    */
   options: TOptions['resolvedOptions']
   /**
-   * Define an api that can be used by other plugins, see `PluginManager' where we convert from `UserPlugin` to `Plugin`(used when calling `createPlugin`).
+   * Define a context that can be used by other plugins, see `PluginManager' where we convert from `UserPlugin` to `Plugin`(used when calling `createPlugin`).
    */
-} & (TOptions['api'] extends never
+} & (TOptions['context'] extends never
   ? {
-      api?: never
+      context?: never
     }
   : {
-      api: TOptions['api']
+      context: TOptions['context']
     })
 
 export type PluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = Plugin<TOptions> & PluginLifecycle<TOptions>
@@ -229,21 +222,6 @@ export type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactor
    * @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
@@ -296,6 +274,3 @@ export type PluginContext<TOptions extends PluginFactoryOptions = PluginFactoryO
    */
   plugin: Plugin<TOptions>
 }
-
-// null will mean clear the watcher for this key
-export type TransformResult = string | null

package/dist/chunk-LKXUCYWU.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["/home/runner/work/kubb/kubb/packages/core/dist/chunk-LKXUCYWU.cjs","../../../node_modules/.pnpm/tsup@8.2.4_@microsoft+api-extractor@7.47.5_@types+node@20.14.15__jiti@1.21.6_postcss@8.4.40_typescript@5.5.4_yaml@2.4.5/node_modules/tsup/assets/cjs_shims.js"],"names":[],"mappings":"AAAA,6EAAI,SAAS,EAAE,MAAM,CAAC,MAAM;AAC5B,IAAI,UAAU,EAAE,MAAM,CAAC,cAAc;AACrC,IAAI,iBAAiB,EAAE,MAAM,CAAC,wBAAwB;AACtD,IAAI,kBAAkB,EAAE,MAAM,CAAC,mBAAmB;AAClD,IAAI,aAAa,EAAE,MAAM,CAAC,cAAc;AACxC,IAAI,aAAa,EAAE,MAAM,CAAC,SAAS,CAAC,cAAc;AAClD,IAAI,YAAY,EAAE,CAAC,GAAG,EAAE,GAAG;AAC3B,EAAE,MAAM,SAAS,CAAC,GAAG,CAAC;AACtB,CAAC;AACD,IAAI,gBAAgB,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,IAAI,GAAG,IAAI,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,KAAK;AAC/J,IAAI,MAAM,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,SAAS,MAAM,CAAC,EAAE;AAC3C,EAAE,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG;AACrE,CAAC;AACD,IAAI,WAAW,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,SAAS,SAAS,CAAC,EAAE;AACnD,EAAE,OAAO,IAAI,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,OAAO;AACpG,CAAC;AACD,IAAI,YAAY,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG;AAC9C,EAAE,GAAG,CAAC,KAAK,GAAG,OAAO,KAAK,IAAI,SAAS,GAAG,OAAO,KAAK,IAAI,UAAU,EAAE;AACtE,IAAI,IAAI,CAAC,IAAI,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC;AAC3C,MAAM,GAAG,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,IAAI,MAAM;AACvD,QAAQ,SAAS,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;AAC1H,EAAE;AACF,EAAE,OAAO,EAAE;AACX,CAAC;AACD,IAAI,QAAQ,EAAE,CAAC,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,GAAG,KAAK,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,WAAW;AAChH;AACA;AACA;AACA;AACA,EAAE,WAAW,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,KAAK,CAAC,EAAE,EAAE,MAAM;AACjH,EAAE;AACF,CAAC,CAAC;AACF,IAAI,cAAc,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,eAAe,CAAC,GAAG,EAAE,OAAO,IAAI,IAAI,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC;AAC9G,IAAI,cAAc,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC,UAAU,EAAE,GAAG,CAAC;AACzF,IAAI,aAAa,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,yBAAyB,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAChJ,IAAI,aAAa,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,WAAW,CAAC,mDAAmD,EAAE,EAAE,OAAO,WAAW,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC;AACpM,IAAI,aAAa,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,wBAAwB,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC;AAC3K,IAAI,gBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,uBAAuB,CAAC,EAAE,MAAM,CAAC;AAC5G,IAAI,iBAAiB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC;AACzD,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE;AACf,IAAI,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC;AAC5C,EAAE,CAAC;AACH,EAAE,IAAI,CAAC,CAAC,EAAE;AACV,IAAI,OAAO,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC;AAC5C,EAAE;AACF,CAAC,CAAC;AACF;AACA;AC/CA,IAAA,eAAA,EAAA,KAAA,CAAA;AAAA,EAAA,wLAAA,CAAA,EAAA;AAAA,IAAA,YAAA;AAAA,EAAA;AAAA,CAAA,CAAA;ADqDA;AACA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,kVAAC","file":"/home/runner/work/kubb/kubb/packages/core/dist/chunk-LKXUCYWU.cjs","sourcesContent":[null,"// Shim globals in cjs bundle\n// There's a weird bug that esbuild will always inject importMetaUrl\n// if we export it as `const importMetaUrl = ... __filename ...`\n// But using a function will not cause this issue\n\nconst getImportMetaUrl = () =>\n  typeof document === 'undefined'\n    ? new URL(`file:${__filename}`).href\n    : (document.currentScript && document.currentScript.src) ||\n      new URL('main.js', document.baseURI).href\n\nexport const importMetaUrl = /* @__PURE__ */ getImportMetaUrl()\n"]}

package/globals.d.ts

@@ -1,49 +0,0 @@
-/**
-* `tsconfig.json`
-* @example
-"compilerOptions": {
-___ "types": ["@kubb/core/globals"]
-}
-* @example implementation
-type SwaggerPlugin = Kubb.Plugins["@kubb/plugin-oas"]
-const swaggerPlugin: SwaggerPlugin={
-___ validate: true
-}
-*/
-declare namespace Kubb {
-  namespace Helpers {
-    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>
-
-    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
-
-    type TupleToUnion<T> = T extends Array<infer ITEMS> ? ITEMS : never
-  }
-  type Plugins = {
-    ['@kubb/plugin-oas']: import('@kubb/plugin-Oas').PluginOas
-    ['@kubb/plugin-redoc']: import('@kubb/plugin-redoc').PluginRedoc
-    ['@kubb/plugin-client']: import('@kubb/plugin-client').PluginClient
-    ['@kubb/plugin-faker']: import('@kubb/plugin-faker').PluginFaker
-    ['@kubb/plugin-swr']: import('@kubb/plugin-swr').PluginSwr
-    ['@kubb/plugin-tanstack-query']: import('@kubb/plugin-tanstack-query').PluginTanstackQuery
-    ['@kubb/plugin-ts']: import('@kubb/plugin-ts').PluginTs
-    ['@kubb/plugin-zod']: import('@kubb/plugin-zod').PluginZod
-    ['@kubb/plugin-zodios']: import('@kubb/plugin-zodios').PluginZodios
-    ['@kubb/plugin-msw']: import('@kubb/plugin-msw').PluginMsw
-  }
-  type OptionsPlugins = { [K in keyof Plugins]: Plugins[K]['options'] }
-
-  type OptionsOfPlugin<K extends keyof Plugins> = Plugins[K]['options']
-
-  type PluginUnion = Helpers.TupleToUnion<Helpers.ObjValueTuple<OptionsPlugins>>
-
-  type Plugin = keyof Plugins
-}

package/src/kubb.ts

@@ -1,11 +0,0 @@
-import type { ObjValueTuple, TupleToUnion } from '@kubb/types'
-import type { _Register } from './index.ts'
-
-export type Plugins = _Register
-export type OptionsPlugins = { [K in keyof Plugins]: Plugins[K]['options'] }
-
-export type OptionsOfPlugin<K extends keyof Plugins> = Plugins[K]['options']
-
-export type PluginUnion = TupleToUnion<ObjValueTuple<OptionsPlugins>>
-
-export type Plugin = keyof Plugins