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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/core",
-  "version": "5.0.0-alpha.3",
+  "version": "5.0.0-alpha.31",
   "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.15.1",
+    "@kubb/react-fabric": "0.15.1",
     "empathic": "^2.0.0",
     "fflate": "^0.8.2",
-    "remeda": "^2.33.6",
+    "remeda": "^2.33.7",
     "semver": "^7.7.4",
     "tinyexec": "^1.0.4",
-    "@kubb/ast": "5.0.0-alpha.3"
+    "@kubb/ast": "5.0.0-alpha.31"
   },
   "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/Kubb.ts

@@ -1,36 +1,32 @@
-import type { KubbFile } from '@kubb/fabric-core/types'
-import type { Strategy } from './PluginManager.ts'
+import type * as KubbFile from './KubbFile.ts'
+import type { Strategy } from './PluginDriver.ts'
 import type { Config, Plugin, PluginLifecycleHooks } from './types'
 
-type DebugEvent = {
+type DebugInfo = {
   date: Date
-  logs: string[]
+  logs: Array<string>
   fileName?: string
 }
 
-type ProgressStartMeta<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
+type HookProgress<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
   hookName: H
   plugins: Array<Plugin>
 }
 
-type ProgressStopMeta<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
-  hookName: H
-}
-
-type ExecutingMeta<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
+type HookExecution<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
   strategy: Strategy
   hookName: H
   plugin: Plugin
-  parameters?: unknown[] | undefined
+  parameters?: Array<unknown>
   output?: unknown
 }
 
-type ExecutedMeta<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
+type HookResult<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
   duration: number
   strategy: Strategy
   hookName: H
   plugin: Plugin
-  parameters?: unknown[] | undefined
+  parameters?: Array<unknown>
   output?: unknown
 }
 
@@ -40,7 +36,7 @@ type ExecutedMeta<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
  *
  * @example
  * ```typescript
- * import type { AsyncEventEmitter } from '@kubb/core'
+ * import type { AsyncEventEmitter } from '@internals/utils'
  * import type { KubbEvents } from '@kubb/core'
  *
  * const events: AsyncEventEmitter<KubbEvents> = new AsyncEventEmitter()
@@ -59,7 +55,6 @@ export interface KubbEvents {
    * Emitted at the beginning of the Kubb lifecycle, before any code generation starts.
    */
   'lifecycle:start': [version: string]
-
   /**
    * Emitted at the end of the Kubb lifecycle, after all code generation is complete.
    */
@@ -69,7 +64,6 @@ export interface KubbEvents {
    * Emitted when configuration loading starts.
    */
   'config:start': []
-
   /**
    * Emitted when configuration loading is complete.
    */
@@ -79,24 +73,22 @@ export interface KubbEvents {
    * Emitted when code generation phase starts.
    */
   'generation:start': [config: Config]
-
   /**
    * Emitted when code generation phase completes.
    */
-  'generation:end': [Config: Config, files: Array<KubbFile.ResolvedFile>, sources: Map<KubbFile.Path, string>]
-
+  'generation:end': [config: Config, files: Array<KubbFile.ResolvedFile>, sources: Map<KubbFile.Path, string>]
   /**
    * Emitted with a summary of the generation results.
    * Contains summary lines, title, and success status.
    */
   'generation:summary': [
-    Config: Config,
+    config: Config,
     {
       failedPlugins: Set<{ plugin: Plugin; error: Error }>
       status: 'success' | 'failed'
       hrStart: [number, number]
       filesCreated: number
-      pluginTimings?: Map<string, number>
+      pluginTimings?: Map<Plugin['name'], number>
     },
   ]
 
@@ -104,7 +96,6 @@ export interface KubbEvents {
    * Emitted when code formatting starts (e.g., running Biome or Prettier).
    */
   'format:start': []
-
   /**
    * Emitted when code formatting completes.
    */
@@ -114,7 +105,6 @@ export interface KubbEvents {
    * Emitted when linting starts.
    */
   'lint:start': []
-
   /**
    * Emitted when linting completes.
    */
@@ -124,29 +114,20 @@ export interface KubbEvents {
    * Emitted when plugin hooks execution starts.
    */
   'hooks:start': []
-
   /**
    * Emitted when plugin hooks execution completes.
    */
   'hooks:end': []
 
   /**
-   * Emitted when a single hook execution starts. (e.g., format or lint).
+   * Emitted when a single hook execution starts (e.g., format or lint).
    * The callback should be invoked when the command completes.
    */
   'hook:start': [{ id?: string; command: string; args?: readonly string[] }]
   /**
    * Emitted when a single hook execution completes.
    */
-  'hook:end': [
-    {
-      id?: string
-      command: string
-      args?: readonly string[]
-      success: boolean
-      error: Error | null
-    },
-  ]
+  'hook:end': [{ id?: string; command: string; args?: readonly string[]; success: boolean; error: Error | null }]
 
   /**
    * Emitted when a new version of Kubb is available.
@@ -157,49 +138,54 @@ export interface KubbEvents {
    * Informational message event.
    */
   info: [message: string, info?: string]
-
   /**
    * Error event. Emitted when an error occurs during code generation.
    */
   error: [error: Error, meta?: Record<string, unknown>]
-
   /**
    * Success message event.
    */
   success: [message: string, info?: string]
-
   /**
    * Warning message event.
    */
   warn: [message: string, info?: string]
-
   /**
    * Debug event for detailed logging.
    * Contains timestamp, log messages, and optional filename.
    */
-  debug: [meta: DebugEvent]
+  debug: [info: DebugInfo]
 
   /**
    * Emitted when file processing starts.
    * Contains the list of files to be processed.
    */
   'files:processing:start': [files: Array<KubbFile.ResolvedFile>]
-
   /**
    * Emitted for each file being processed, providing progress updates.
    * Contains processed count, total count, percentage, and file details.
    */
   'file:processing:update': [
     {
-      /** Number of files processed so far */
+      /**
+       * Number of files processed so far.
+       */
       processed: number
-      /** Total number of files to process */
+      /**
+       * Total number of files to process.
+       */
       total: number
-      /** Processing percentage (0-100) */
+      /**
+       * Processing percentage (0–100).
+       */
       percentage: number
-      /** Optional source identifier */
+      /**
+       * Optional source identifier.
+       */
       source?: string
-      /** The file being processed */
+      /**
+       * The file being processed.
+       */
       file: KubbFile.ResolvedFile
       /**
        * Kubb configuration (not present in Fabric).
@@ -208,45 +194,41 @@ export interface KubbEvents {
       config: Config
     },
   ]
-
   /**
    * Emitted when file processing completes.
    * Contains the list of processed files.
    */
-  'files:processing:end': [files: KubbFile.ResolvedFile[]]
+  'files:processing:end': [files: Array<KubbFile.ResolvedFile>]
 
   /**
    * Emitted when a plugin starts executing.
    */
   'plugin:start': [plugin: Plugin]
-
   /**
    * Emitted when a plugin completes execution.
-   * Duration in ms
+   * Duration in ms.
    */
-  'plugin:end': [plugin: Plugin, meta: { duration: number; success: boolean; error?: Error }]
+  'plugin:end': [plugin: Plugin, result: { duration: number; success: boolean; error?: Error }]
 
   /**
    * Emitted when plugin hook progress tracking starts.
    * Contains the hook name and list of plugins to execute.
    */
-  'plugins:hook:progress:start': [meta: ProgressStartMeta]
-
+  'plugins:hook:progress:start': [progress: HookProgress]
   /**
    * Emitted when plugin hook progress tracking ends.
    * Contains the hook name that completed.
    */
-  'plugins:hook:progress:end': [meta: ProgressStopMeta]
+  'plugins:hook:progress:end': [{ hookName: PluginLifecycleHooks }]
 
   /**
    * Emitted when a plugin hook starts processing.
    * Contains strategy, hook name, plugin, parameters, and output.
    */
-  'plugins:hook:processing:start': [meta: ExecutingMeta]
-
+  'plugins:hook:processing:start': [execution: HookExecution]
   /**
    * Emitted when a plugin hook completes processing.
    * Contains duration, strategy, hook name, plugin, parameters, and output.
    */
-  'plugins:hook:processing:end': [meta: ExecutedMeta]
+  'plugins:hook:processing:end': [result: HookResult]
 }

package/src/KubbFile.ts

@@ -0,0 +1,143 @@
+type ImportName =
+  | string
+  | Array<
+      | string
+      | {
+          propertyName: string
+          name?: string
+        }
+    >
+
+export type Import = {
+  /**
+   * Import name to be used.
+   * @example ["useState"]
+   * @example "React"
+   */
+  name: ImportName
+  /**
+   * Path for the import.
+   * @example '@kubb/core'
+   */
+  path: string
+  /**
+   * Add type-only import prefix.
+   * - `true` generates `import type { Type } from './path'`
+   * - `false` generates `import { Type } from './path'`
+   * @default false
+   */
+  isTypeOnly?: boolean
+  /**
+   * Import entire module as namespace.
+   * - `true` generates `import * as Name from './path'`
+   * - `false` generates standard import
+   * @default false
+   */
+  isNameSpace?: boolean
+  /**
+   * When root is set it will compute a relative path with `getRelativePath(root, path)`.
+   */
+  root?: string
+}
+
+export type Source = {
+  name?: string
+  value?: string
+  /**
+   * Make this source a type-only export.
+   * @default false
+   */
+  isTypeOnly?: boolean
+  /**
+   * Include export keyword in source.
+   * @default false
+   */
+  isExportable?: boolean
+  /**
+   * Include in barrel file generation.
+   * @default false
+   */
+  isIndexable?: boolean
+}
+
+export type Export = {
+  /**
+   * Export name to be used.
+   * @example ["useState"]
+   * @example "React"
+   */
+  name?: string | Array<string>
+  /**
+   * Path for the export.
+   * @example '@kubb/core'
+   */
+  path: string
+  /**
+   * Add type-only export prefix.
+   * - `true` generates `export type { Type } from './path'`
+   * - `false` generates `export { Type } from './path'`
+   * @default false
+   */
+  isTypeOnly?: boolean
+  /**
+   * Export as aliased namespace.
+   * - `true` generates `export * as aliasName from './path'`
+   * - `false` generates standard export
+   * @default false
+   */
+  asAlias?: boolean
+}
+
+export type Extname = '.ts' | '.js' | '.tsx' | '.json' | `.${string}`
+
+export type Mode = 'single' | 'split'
+
+/**
+ * Name to be used to dynamically create the baseName (based on input.path).
+ * Based on UNIX basename.
+ * @link https://nodejs.org/api/path.html#pathbasenamepath-suffix
+ */
+export type BaseName = `${string}.${string}`
+
+/**
+ * Fully qualified path to a specified file.
+ */
+export type Path = string
+
+export type File<TMeta extends object = object> = {
+  /**
+   * Name used to create the path.
+   * Based on UNIX basename, `${name}${extname}`.
+   * @link https://nodejs.org/api/path.html#pathbasenamepath-suffix
+   */
+  baseName: BaseName
+  /**
+   * Fully qualified path to the file.
+   */
+  path: Path
+  sources: Array<Source>
+  imports: Array<Import>
+  exports: Array<Export>
+  /**
+   * Extra metadata used for barrel/index file generation.
+   */
+  meta?: TMeta
+  banner?: string
+  footer?: string
+}
+
+export type ResolvedFile<TMeta extends object = object> = File<TMeta> & {
+  /**
+   * Unique identifier, generated from a hash.
+   * @default hash
+   */
+  id: string
+  /**
+   * First part of the `baseName`, derived from the file name.
+   * @link https://nodejs.org/api/path.html#pathformatpathobject
+   */
+  name: string
+  extname: Extname
+  imports: Array<Import>
+  exports: Array<Export>
+}