@kubb/core 5.0.0-alpha.2 → 5.0.0-alpha.3

package/dist/{types-B7eZvqwD.d.ts → types-CiPWLv-5.d.ts}

@@ -1,8 +1,8 @@
 import { t as __name } from "./chunk--u3MIqq1.js";
 import { EventEmitter } from "node:events";
 import { Fabric } from "@kubb/react-fabric";
+import { Printer, PrinterFactoryOptions, RootNode, SchemaNode } from "@kubb/ast/types";
 import { KubbFile } from "@kubb/fabric-core/types";
-import { Printer, PrinterFactoryOptions, RootNode } from "@kubb/ast/types";
 
 //#region ../../internals/utils/dist/index.d.ts
 /**
@@ -226,6 +226,7 @@ declare class PluginManager {
    * the build pipeline after the adapter's `parse()` resolves.
    */
   rootNode: RootNode | undefined;
+  adapter: Adapter | undefined;
   constructor(config: Config, options: Options);
   get events(): AsyncEventEmitter<KubbEvents>;
   getContext<TOptions extends PluginFactoryOptions>(plugin: Plugin<TOptions>): PluginContext<TOptions> & Record<string, unknown>;
@@ -617,6 +618,17 @@ type Adapter<TOptions extends AdapterFactoryOptions = AdapterFactoryOptions> = {
   /** Human-readable identifier, e.g. `'oas'`, `'drizzle'`, `'asyncapi'`. */name: TOptions['name']; /** Resolved options (after defaults have been applied). */
   options: TOptions['resolvedOptions']; /** Convert the raw source into a universal `RootNode`. */
   parse: (source: AdapterSource) => PossiblePromise<RootNode>;
+  /**
+   * Extracts `KubbFile.Import` entries needed by a `SchemaNode` tree.
+   * Populated after the first `parse()` call. Returns an empty array before that.
+   *
+   * The `resolve` callback receives the collision-corrected schema name and must
+   * return the `{ name, path }` pair for the import, or `undefined` to skip it.
+   */
+  getImports: (node: SchemaNode, resolve: (schemaName: string) => {
+    name: string;
+    path: string;
+  }) => Array<KubbFile.Import>;
 };
 type BarrelType = 'all' | 'named' | 'propagate';
 type DevtoolsOptions = {
@@ -905,18 +917,26 @@ type PluginContext<TOptions extends PluginFactoryOptions = PluginFactoryOptions>
    * Current plugin
    */
   plugin: Plugin<TOptions>;
-  /**
-   * Returns the universal `@kubb/ast` `RootNode` produced by the configured adapter.
-   * Returns `undefined` when no adapter was set (legacy OAS-only usage).
-   */
-  rootNode: RootNode | undefined;
   /**
    * Opens the Kubb Studio URL for the current `rootNode` in the default browser.
    * Falls back to printing the URL if the browser cannot be launched.
    * No-ops silently when no adapter has set a `rootNode`.
    */
   openInStudio: (options?: DevtoolsOptions) => Promise<void>;
-} & Kubb.PluginContext;
+} & ({
+  /**
+   * Returns the universal `@kubb/ast` `RootNode` produced by the configured adapter.
+   * Returns `undefined` when no adapter was set (legacy OAS-only usage).
+   */
+  rootNode: RootNode;
+  /**
+   * Return the adapter from `@kubb/ast`
+   */
+  adapter: Adapter;
+} | {
+  rootNode?: never;
+  adapter?: never;
+}) & Kubb.PluginContext;
 /**
  * Specify the export location for the files and define the behavior of the output
  */
@@ -978,4 +998,4 @@ type Logger<TOptions extends LoggerOptions = LoggerOptions> = {
 type UserLogger<TOptions extends LoggerOptions = LoggerOptions> = Omit<Logger<TOptions>, 'logLevel'>;
 //#endregion
 export { UserPluginWithLifeCycle as A, URLPath as B, PrinterFactoryOptions as C, UserConfig as D, UnknownUserPlugin as E, defineStorage as F, formatters as I, linters as L, PluginManager as M, getMode as N, UserLogger as O, DefineStorage as P, logLevel as R, Printer as S, ResolvePathParams as T, PluginFactoryOptions as _, Config as a, PluginParameter as b, Group as c, Logger as d, LoggerContext as f, PluginContext as g, Plugin as h, BarrelType as i, KubbEvents as j, UserPlugin as k, InputData as l, Output as m, AdapterFactoryOptions as n, DevtoolsOptions as o, LoggerOptions as p, AdapterSource as r, GetPluginFactoryOptions as s, Adapter as t, InputPath as u, PluginLifecycle as v, ResolveNameParams as w, PluginWithLifeCycle as x, PluginLifecycleHooks as y, AsyncEventEmitter as z };
-//# sourceMappingURL=types-B7eZvqwD.d.ts.map
+//# sourceMappingURL=types-CiPWLv-5.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/core",
-  "version": "5.0.0-alpha.2",
+  "version": "5.0.0-alpha.3",
   "description": "Core functionality for Kubb's plugin-based code generation system, providing the foundation for transforming OpenAPI specifications.",
   "keywords": [
     "typescript",
@@ -71,7 +71,7 @@
     "remeda": "^2.33.6",
     "semver": "^7.7.4",
     "tinyexec": "^1.0.4",
-    "@kubb/ast": "5.0.0-alpha.2"
+    "@kubb/ast": "5.0.0-alpha.3"
   },
   "devDependencies": {
     "@types/semver": "^7.7.1",

package/src/PluginManager.ts

@@ -1,4 +1,4 @@
-import path from 'node:path'
+import { basename, extname, resolve } from 'node:path'
 import { performance } from 'node:perf_hooks'
 import type { AsyncEventEmitter } from '@internals/utils'
 import { setUniqueName, transformReservedWord } from '@internals/utils'
@@ -10,6 +10,7 @@ import { openInStudio as openInStudioFn } from './devtools.ts'
 import { ValidationPluginError } from './errors.ts'
 import { isPromiseRejectedResult, PromiseManager } from './PromiseManager.ts'
 import type {
+  Adapter,
   Config,
   DevtoolsOptions,
   KubbEvents,
@@ -59,7 +60,7 @@ export function getMode(fileOrFolder: string | undefined | null): KubbFile.Mode
   if (!fileOrFolder) {
     return 'split'
   }
-  return path.extname(fileOrFolder) ? 'single' : 'split'
+  return extname(fileOrFolder) ? 'single' : 'split'
 }
 
 export class PluginManager {
@@ -71,6 +72,7 @@ export class PluginManager {
    * the build pipeline after the adapter's `parse()` resolves.
    */
   rootNode: RootNode | undefined = undefined
+  adapter: Adapter | undefined = undefined
   #studioIsOpen = false
 
   readonly #plugins = new Set<Plugin>()
@@ -104,7 +106,7 @@ export class PluginManager {
       plugin,
       events: this.options.events,
       pluginManager: this,
-      mode: getMode(path.resolve(this.config.root, this.config.output.path)),
+      mode: getMode(resolve(this.config.root, this.config.output.path)),
       addFile: async (...files: Array<KubbFile.File>) => {
         await this.options.fabric.addFile(...files)
       },
@@ -114,17 +116,20 @@ export class PluginManager {
       get rootNode(): RootNode | undefined {
         return pluginManager.rootNode
       },
+      get adapter(): Adapter | undefined {
+        return pluginManager.adapter
+      },
       openInStudio(options?: DevtoolsOptions) {
+        if (!pluginManager.config.devtools || pluginManager.#studioIsOpen) {
+          return
+        }
+
         if (typeof pluginManager.config.devtools !== 'object') {
           throw new Error('Devtools must be an object')
         }
 
-        if (!pluginManager.rootNode) {
-          throw new Error('RootNode is not defined, make sure you have set the parser in kubb.config.ts')
-        }
-
-        if (pluginManager.#studioIsOpen) {
-          return
+        if (!pluginManager.rootNode || !pluginManager.adapter) {
+          throw new Error('adapter is not defined, make sure you have set the parser in kubb.config.ts')
         }
 
         pluginManager.#studioIsOpen = true
@@ -159,16 +164,22 @@ export class PluginManager {
   }
 
   getFile<TOptions = object>({ name, mode, extname, pluginName, options }: GetFileProps<TOptions>): KubbFile.File<{ pluginName: string }> {
-    const baseName = `${name}${extname}` as const
-    const path = this.resolvePath({ baseName, mode, pluginName, options })
+    const resolvedName = mode ? (mode === 'single' ? '' : this.resolveName({ name, pluginName, type: 'file' })) : name
+
+    const path = this.resolvePath({
+      baseName: `${resolvedName}${extname}` as const,
+      mode,
+      pluginName,
+      options,
+    })
 
     if (!path) {
-      throw new Error(`Filepath should be defined for resolvedName "${name}" and pluginName "${pluginName}"`)
+      throw new Error(`Filepath should be defined for resolvedName "${resolvedName}" and pluginName "${pluginName}"`)
     }
 
     return {
       path,
-      baseName,
+      baseName: basename(path) as KubbFile.File['baseName'],
       meta: {
         pluginName,
       },
@@ -179,8 +190,8 @@ export class PluginManager {
   }
 
   resolvePath = <TOptions = object>(params: ResolvePathParams<TOptions>): KubbFile.Path => {
-    const root = path.resolve(this.config.root, this.config.output.path)
-    const defaultPath = path.resolve(root, params.baseName)
+    const root = resolve(this.config.root, this.config.output.path)
+    const defaultPath = resolve(root, params.baseName)
 
     if (params.pluginName) {
       const paths = this.hookForPluginSync({
@@ -456,7 +467,12 @@ export class PluginManager {
     return plugins
       .map((plugin) => {
         if (plugin.pre) {
-          const missingPlugins = plugin.pre.filter((pluginName) => !plugins.find((pluginToFind) => pluginToFind.name === pluginName))
+          let missingPlugins = plugin.pre.filter((pluginName) => !plugins.find((pluginToFind) => pluginToFind.name === pluginName))
+
+          // when adapter is set, we can ignore the depends on plugin-oas, in v5 this will not be needed anymore
+          if (missingPlugins.includes('plugin-oas') && this.adapter) {
+            missingPlugins = missingPlugins.filter((pluginName) => pluginName !== 'plugin-oas')
+          }
 
           if (missingPlugins.length > 0) {
             throw new ValidationPluginError(`The plugin '${plugin.name}' has a pre set that references missing plugins for '${missingPlugins.join(', ')}'`)

package/src/build.ts

@@ -180,6 +180,7 @@ export async function setup(options: BuildOptions): Promise<SetupResult> {
       logs: [`Running adapter: ${definedConfig.adapter.name}`],
     })
 
+    pluginManager.adapter = definedConfig.adapter
     pluginManager.rootNode = await definedConfig.adapter.parse(source)
 
     await events.emit('debug', {

package/src/hooks/index.ts

@@ -1,3 +1,8 @@
+export { useKubb } from './useKubb.ts'
+
+/** @deprecated Use `useKubb` from `@kubb/core/hooks` instead */
 export { useMode } from './useMode.ts'
+/** @deprecated Use `useKubb` from `@kubb/core/hooks` instead */
 export { usePlugin } from './usePlugin.ts'
+/** @deprecated Use `useKubb` from `@kubb/core/hooks` instead */
 export { usePluginManager } from './usePluginManager.ts'

package/src/hooks/useKubb.ts

@@ -0,0 +1,22 @@
+import type { KubbFile } from '@kubb/fabric-core/types'
+import { useApp as useAppBase } from '@kubb/react-fabric'
+import type { PluginManager } from '../PluginManager.ts'
+import type { Plugin, PluginFactoryOptions } from '../types.ts'
+
+export function useKubb<TOptions extends PluginFactoryOptions = PluginFactoryOptions>() {
+  const { meta } = useAppBase<{
+    plugin: Plugin<TOptions>
+    mode: KubbFile.Mode
+    pluginManager: PluginManager
+  }>()
+
+  return {
+    plugin: meta.plugin as Plugin<TOptions>,
+    mode: meta.mode,
+    config: meta.pluginManager.config,
+    getPluginByName: meta.pluginManager.getPluginByName.bind(meta.pluginManager),
+    getFile: meta.pluginManager.getFile.bind(meta.pluginManager),
+    resolveName: meta.pluginManager.resolveName.bind(meta.pluginManager),
+    resolvePath: meta.pluginManager.resolvePath.bind(meta.pluginManager),
+  }
+}

package/src/hooks/useMode.ts

@@ -1,6 +1,9 @@
 import type { KubbFile } from '@kubb/fabric-core/types'
 import { useApp } from '@kubb/react-fabric'
 
+/**
+ * @deprecated use `useKubb` instead
+ */
 export function useMode(): KubbFile.Mode {
   const { meta } = useApp<{ mode: KubbFile.Mode }>()
 

package/src/hooks/usePlugin.ts

@@ -1,6 +1,9 @@
 import { useApp } from '@kubb/react-fabric'
 import type { Plugin, PluginFactoryOptions } from '../types.ts'
 
+/**
+ * @deprecated use useApp instead
+ */
 export function usePlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions>(): Plugin<TOptions> {
   const { meta } = useApp<{ plugin: Plugin<TOptions> }>()
 

package/src/hooks/usePluginManager.ts

@@ -1,6 +1,9 @@
 import { useApp } from '@kubb/react-fabric'
 import type { PluginManager } from '../PluginManager.ts'
 
+/**
+ * @deprecated use `useKubb` instead
+ */
 export function usePluginManager(): PluginManager {
   const { meta } = useApp<{ pluginManager: PluginManager }>()
 

package/src/types.ts

@@ -1,5 +1,5 @@
 import type { AsyncEventEmitter, PossiblePromise } from '@internals/utils'
-import type { RootNode } from '@kubb/ast/types'
+import type { RootNode, SchemaNode } from '@kubb/ast/types'
 import type { KubbFile } from '@kubb/fabric-core/types'
 import type { Fabric } from '@kubb/react-fabric'
 import type { DEFAULT_STUDIO_URL, logLevel } from './constants.ts'
@@ -98,6 +98,14 @@ export type Adapter<TOptions extends AdapterFactoryOptions = AdapterFactoryOptio
   options: TOptions['resolvedOptions']
   /** Convert the raw source into a universal `RootNode`. */
   parse: (source: AdapterSource) => PossiblePromise<RootNode>
+  /**
+   * Extracts `KubbFile.Import` entries needed by a `SchemaNode` tree.
+   * Populated after the first `parse()` call. Returns an empty array before that.
+   *
+   * The `resolve` callback receives the collision-corrected schema name and must
+   * return the `{ name, path }` pair for the import, or `undefined` to skip it.
+   */
+  getImports: (node: SchemaNode, resolve: (schemaName: string) => { name: string; path: string }) => Array<KubbFile.Import>
 }
 
 export type BarrelType = 'all' | 'named' | 'propagate'
@@ -408,18 +416,31 @@ export type PluginContext<TOptions extends PluginFactoryOptions = PluginFactoryO
    * Current plugin
    */
   plugin: Plugin<TOptions>
-  /**
-   * Returns the universal `@kubb/ast` `RootNode` produced by the configured adapter.
-   * Returns `undefined` when no adapter was set (legacy OAS-only usage).
-   */
-  rootNode: RootNode | undefined
+
   /**
    * Opens the Kubb Studio URL for the current `rootNode` in the default browser.
    * Falls back to printing the URL if the browser cannot be launched.
    * No-ops silently when no adapter has set a `rootNode`.
    */
   openInStudio: (options?: DevtoolsOptions) => Promise<void>
-} & Kubb.PluginContext
+} & (
+  | {
+      /**
+       * Returns the universal `@kubb/ast` `RootNode` produced by the configured adapter.
+       * Returns `undefined` when no adapter was set (legacy OAS-only usage).
+       */
+      rootNode: RootNode
+      /**
+       * Return the adapter from `@kubb/ast`
+       */
+      adapter: Adapter
+    }
+  | {
+      rootNode?: never
+      adapter?: never
+    }
+) &
+  Kubb.PluginContext
 /**
  * Specify the export location for the files and define the behavior of the output
  */