@kubb/core 5.0.0-alpha.4 → 5.0.0-alpha.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/core",
-  "version": "5.0.0-alpha.4",
+  "version": "5.0.0-alpha.6",
   "description": "Core functionality for Kubb's plugin-based code generation system, providing the foundation for transforming OpenAPI specifications.",
   "keywords": [
     "typescript",
@@ -64,14 +64,14 @@
     }
   ],
   "dependencies": {
-    "@kubb/fabric-core": "0.13.3",
-    "@kubb/react-fabric": "0.13.3",
+    "@kubb/fabric-core": "0.14.0",
+    "@kubb/react-fabric": "0.14.0",
     "empathic": "^2.0.0",
     "fflate": "^0.8.2",
     "remeda": "^2.33.6",
     "semver": "^7.7.4",
     "tinyexec": "^1.0.4",
-    "@kubb/ast": "5.0.0-alpha.4"
+    "@kubb/ast": "5.0.0-alpha.6"
   },
   "devDependencies": {
     "@types/semver": "^7.7.1",
@@ -79,8 +79,8 @@
     "@internals/utils": "0.0.0"
   },
   "peerDependencies": {
-    "@kubb/fabric-core": "0.13.3",
-    "@kubb/react-fabric": "0.13.3"
+    "@kubb/fabric-core": "0.14.0",
+    "@kubb/react-fabric": "0.14.0"
   },
   "engines": {
     "node": ">=22"

package/src/PluginManager.ts

@@ -3,8 +3,7 @@ import { performance } from 'node:perf_hooks'
 import type { AsyncEventEmitter } from '@internals/utils'
 import { setUniqueName, transformReservedWord } from '@internals/utils'
 import type { RootNode } from '@kubb/ast/types'
-import type { KubbFile } from '@kubb/fabric-core/types'
-import type { Fabric } from '@kubb/react-fabric'
+import type { Fabric as FabricType, KubbFile } from '@kubb/fabric-core/types'
 import { CORE_PLUGIN_NAME, DEFAULT_STUDIO_URL } from './constants.ts'
 import { openInStudio as openInStudioFn } from './devtools.ts'
 import { ValidationPluginError } from './errors.ts'
@@ -40,7 +39,7 @@ type SafeParseResult<H extends PluginLifecycleHooks, Result = ReturnType<ParseRe
 // inspired by: https://github.com/rollup/rollup/blob/master/src/utils/PluginDriver.ts#
 
 type Options = {
-  fabric: Fabric
+  fabric: FabricType
   events: AsyncEventEmitter<KubbEvents>
   /**
    * @default Number.POSITIVE_INFINITY
@@ -48,7 +47,7 @@ type Options = {
   concurrency?: number
 }
 
-type GetFileProps<TOptions = object> = {
+export type GetFileOptions<TOptions = object> = {
   name: string
   mode?: KubbFile.Mode
   extname: KubbFile.Extname
@@ -163,7 +162,7 @@ export class PluginManager {
     return this.#getSortedPlugins()
   }
 
-  getFile<TOptions = object>({ name, mode, extname, pluginName, options }: GetFileProps<TOptions>): KubbFile.File<{ pluginName: string }> {
+  getFile<TOptions = object>({ name, mode, extname, pluginName, options }: GetFileOptions<TOptions>): KubbFile.File<{ pluginName: string }> {
     const resolvedName = mode ? (mode === 'single' ? '' : this.resolveName({ name, pluginName, type: 'file' })) : name
 
     const path = this.resolvePath({

package/src/build.ts

@@ -1,7 +1,6 @@
 import { dirname, relative, resolve } from 'node:path'
 import { AsyncEventEmitter, exists, formatMs, getElapsedMs, getRelativePath, URLPath } from '@internals/utils'
-import type { KubbFile } from '@kubb/fabric-core/types'
-import type { Fabric } from '@kubb/react-fabric'
+import type { Fabric as FabricType, KubbFile } from '@kubb/fabric-core/types'
 import { createFabric } from '@kubb/react-fabric'
 import { typescriptParser } from '@kubb/react-fabric/parsers'
 import { fsPlugin } from '@kubb/react-fabric/plugins'
@@ -21,7 +20,7 @@ type BuildOptions = {
 
 type BuildOutput = {
   failedPlugins: Set<{ plugin: Plugin; error: Error }>
-  fabric: Fabric
+  fabric: FabricType
   files: Array<KubbFile.ResolvedFile>
   pluginManager: PluginManager
   pluginTimings: Map<string, number>
@@ -31,7 +30,7 @@ type BuildOutput = {
 
 type SetupResult = {
   events: AsyncEventEmitter<KubbEvents>
-  fabric: Fabric
+  fabric: FabricType
   pluginManager: PluginManager
   sources: Map<KubbFile.Path, string>
 }

package/src/hooks/index.ts

@@ -1,8 +1,4 @@
 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

@@ -1,22 +1,55 @@
 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'
+import { useFabric } from '@kubb/react-fabric'
+import type { GetFileOptions, PluginManager } from '../PluginManager.ts'
+import type { Config, Plugin, PluginFactoryOptions, ResolveNameParams, ResolvePathParams } from '../types.ts'
 
-export function useKubb<TOptions extends PluginFactoryOptions = PluginFactoryOptions>() {
-  const { meta } = useAppBase<{
+type ResolvePathOptions = {
+  pluginName?: string
+  group?: {
+    tag?: string
+    path?: string
+  }
+  type?: ResolveNameParams['type']
+}
+
+type UseKubbReturn<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
+  plugin: Plugin<TOptions>
+  mode: KubbFile.Mode
+  config: Config
+  /**
+   * Returns the plugin whose `name` matches `pluginName`, defaulting to the current plugin.
+   */
+  getPluginByName: (pluginName?: string) => Plugin | undefined
+  /**
+   * Resolves a file reference, defaulting `pluginName` to the current plugin.
+   */
+  getFile: (params: Omit<GetFileOptions<ResolvePathOptions>, 'pluginName'> & { pluginName?: string }) => KubbFile.File<{ pluginName: string }>
+  /**
+   * Resolves a name, defaulting `pluginName` to the current plugin.
+   */
+  resolveName: (params: Omit<ResolveNameParams, 'pluginName'> & { pluginName?: string }) => string
+  /**
+   * Resolves a path, defaulting `pluginName` to the current plugin.
+   */
+  resolvePath: <TPathOptions = object>(params: Omit<ResolvePathParams<TPathOptions>, 'pluginName'> & { pluginName?: string }) => KubbFile.Path
+}
+
+export function useKubb<TOptions extends PluginFactoryOptions = PluginFactoryOptions>(): UseKubbReturn<TOptions> {
+  const { meta } = useFabric<{
     plugin: Plugin<TOptions>
     mode: KubbFile.Mode
     pluginManager: PluginManager
   }>()
 
+  const defaultPluginName = meta.plugin.name
+
   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),
+    getPluginByName: (pluginName = defaultPluginName) => meta.pluginManager.getPluginByName.call(meta.pluginManager, pluginName),
+    getFile: ({ pluginName = defaultPluginName, ...rest }) => meta.pluginManager.getFile.call(meta.pluginManager, { pluginName, ...rest }),
+    resolveName: ({ pluginName = defaultPluginName, ...rest }) => meta.pluginManager.resolveName.call(meta.pluginManager, { pluginName, ...rest }),
+    resolvePath: ({ pluginName = defaultPluginName, ...rest }) => meta.pluginManager.resolvePath.call(meta.pluginManager, { pluginName, ...rest }),
   }
 }

package/src/hooks/useMode.ts

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

package/src/hooks/usePlugin.ts

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

package/src/hooks/usePluginManager.ts

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

package/src/types.ts

@@ -1,7 +1,6 @@
 import type { AsyncEventEmitter, PossiblePromise } from '@internals/utils'
 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 { Fabric as FabricType, KubbFile } from '@kubb/fabric-core/types'
 import type { DEFAULT_STUDIO_URL, logLevel } from './constants.ts'
 import type { DefineStorage } from './defineStorage.ts'
 import type { KubbEvents } from './Kubb.ts'
@@ -399,7 +398,7 @@ export type ResolveNameParams = {
 }
 
 export type PluginContext<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
-  fabric: Fabric
+  fabric: FabricType
   config: Config
   pluginManager: PluginManager
   /**

package/src/utils/resolveOptions.ts

@@ -7,7 +7,7 @@ type FilterItem = {
 }
 
 type OverrideItem<TOptions> = FilterItem & {
-  options: Partial<TOptions>
+  options: Omit<Partial<TOptions>, 'override'>
 }
 
 type ResolveOptionsContext<TOptions> = {