@kubb/core 5.0.0-beta.17 → 5.0.0-beta.18

package/dist/mocks.cjs

@@ -1,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_PluginDriver = require("./PluginDriver-C5hyNJfM.cjs");
+const require_PluginDriver = require("./PluginDriver-Bc-k8EUQ.cjs");
 let node_path = require("node:path");
 let _kubb_ast = require("@kubb/ast");
 //#region src/mocks.ts

package/dist/mocks.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./chunk--u3MIqq1.js";
-import { H as NormalizedPlugin, K as PluginFactoryOptions, P as PluginDriver, bt as AdapterFactoryOptions, j as Generator, r as Config, yt as Adapter } from "./createKubb-ZgT1MTxG.js";
+import { H as NormalizedPlugin, K as PluginFactoryOptions, P as PluginDriver, bt as AdapterFactoryOptions, j as Generator, r as Config, yt as Adapter } from "./createKubb-DajERI4b.js";
 import { InputNode, OperationNode, SchemaNode, Visitor } from "@kubb/ast";
 
 //#region src/mocks.d.ts

package/dist/mocks.js

@@ -1,5 +1,5 @@
 import "./chunk--u3MIqq1.js";
-import { n as applyHookResult, r as FileManager, t as PluginDriver } from "./PluginDriver-CT33kVoQ.js";
+import { n as applyHookResult, r as FileManager, t as PluginDriver } from "./PluginDriver-T4-THx8t.js";
 import { resolve } from "node:path";
 import { transform } from "@kubb/ast";
 //#region src/mocks.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/core",
-  "version": "5.0.0-beta.17",
+  "version": "5.0.0-beta.18",
   "description": "Core engine for Kubb's plugin-based code generation system. Provides the plugin driver, file manager, defineConfig, and build orchestration used by every Kubb plugin.",
   "keywords": [
     "code-generator",
@@ -58,14 +58,14 @@
   "dependencies": {
     "fflate": "^0.8.2",
     "tinyexec": "^1.1.2",
-    "@kubb/ast": "5.0.0-beta.17"
+    "@kubb/ast": "5.0.0-beta.18"
   },
   "devDependencies": {
     "@internals/utils": "0.0.0",
-    "@kubb/renderer-jsx": "5.0.0-beta.17"
+    "@kubb/renderer-jsx": "5.0.0-beta.18"
   },
   "peerDependencies": {
-    "@kubb/renderer-jsx": "5.0.0-beta.17"
+    "@kubb/renderer-jsx": "5.0.0-beta.18"
   },
   "size-limit": [
     {

package/src/FileManager.ts

@@ -99,6 +99,10 @@ export class FileManager {
     this.clear()
   }
 
+  [Symbol.dispose](): void {
+    this.dispose()
+  }
+
   /**
    * All stored files, sorted by path length (shorter paths first).
    */

package/src/PluginDriver.ts

@@ -302,6 +302,10 @@ export class PluginDriver {
     this.inputStreamNode = undefined
   }
 
+  [Symbol.dispose](): void {
+    this.dispose()
+  }
+
   #trackHookListener(event: keyof KubbHooks, handler: (...args: never[]) => void | Promise<void>): void {
     let handlers = this.#hookListeners.get(event)
     if (!handlers) {
@@ -467,7 +471,13 @@ export async function applyHookResult<TElement = unknown>(
   }
 
   const renderer = rendererFactory()
-  await renderer.render(result)
-  driver.fileManager.upsert(...renderer.files)
+  if (renderer.stream) {
+    for await (const file of renderer.stream(result)) {
+      driver.fileManager.upsert(file)
+    }
+  } else {
+    await renderer.render(result)
+    driver.fileManager.upsert(...renderer.files)
+  }
   renderer.unmount()
 }

package/src/createKubb.ts

@@ -778,6 +778,7 @@ type SetupResult = {
   storage: Storage
   config: Config
   dispose: () => void
+  [Symbol.dispose](): void
 }
 
 /**
@@ -975,12 +976,15 @@ async function setup(userConfig: UserConfig, options: SetupOptions = {}): Promis
     hooks,
     driver,
     storage,
-    dispose: () => {
-      driver.dispose()
-      for (const [event, handler] of middlewareListeners) {
-        hooks.off(event, handler as never)
-      }
-    },
+    dispose,
+    [Symbol.dispose]: dispose,
+  }
+
+  function dispose() {
+    driver.dispose()
+    for (const [event, handler] of middlewareListeners) {
+      hooks.off(event, handler as never)
+    }
   }
 }
 
@@ -1202,7 +1206,10 @@ async function runPluginAstHooks(plugin: NormalizedPlugin, context: GeneratorCon
       await Promise.all(
         generators
           .filter((gen) => gen.schema)
-          .map((gen) => Promise.resolve(gen.schema!(transformedNode, ctx)).then((result) => applyHookResult(result, driver, resolveRenderer(gen)))),
+          .map(async (gen) => {
+            const result = await gen.schema!(transformedNode, ctx)
+            return applyHookResult(result, driver, resolveRenderer(gen))
+          }),
       )
 
       await driver.hooks.emit('kubb:generate:schema', transformedNode, ctx)
@@ -1223,7 +1230,10 @@ async function runPluginAstHooks(plugin: NormalizedPlugin, context: GeneratorCon
         await Promise.all(
           generators
             .filter((gen) => gen.operation)
-            .map((gen) => Promise.resolve(gen.operation!(transformedNode, ctx)).then((result) => applyHookResult(result, driver, resolveRenderer(gen)))),
+            .map(async (gen) => {
+              const result = await gen.operation!(transformedNode, ctx)
+              return applyHookResult(result, driver, resolveRenderer(gen))
+            }),
         )
 
         await driver.hooks.emit('kubb:generate:operation', transformedNode, ctx)
@@ -1245,6 +1255,7 @@ async function runPluginAstHooks(plugin: NormalizedPlugin, context: GeneratorCon
 }
 
 async function safeBuild(setupResult: SetupResult): Promise<BuildOutput> {
+  using _cleanup = setupResult
   const { driver, hooks, storage } = setupResult
 
   const failedPlugins = new Set<{ plugin: Plugin; error: Error }>()
@@ -1455,8 +1466,6 @@ async function safeBuild(setupResult: SetupResult): Promise<BuildOutput> {
       error: error as Error,
       storage,
     }
-  } finally {
-    setupResult.dispose()
   }
 }
 

package/src/createRenderer.ts

@@ -3,37 +3,47 @@ import type { FileNode } from '@kubb/ast'
 /**
  * Minimal interface any Kubb renderer must satisfy.
  *
- * The generic `TElement` is the type of the element the renderer accepts —
- * e.g. `KubbReactElement` for `@kubb/renderer-jsx`, or a custom type for
- * your own renderer.  Defaults to `unknown` so that generators which do not
- * care about the element type continue to work without specifying it.
- *
- * This allows core to drive rendering without a hard dependency on
- * `@kubb/renderer-jsx` or any specific renderer implementation.
+ * `TElement` is the type the renderer accepts, for example `KubbReactElement`
+ * for `@kubb/renderer-jsx` or a custom type for your own renderer. Defaults to
+ * `unknown` so generators that don't care about the element type work without
+ * specifying it.
  */
 export type Renderer<TElement = unknown> = {
+  /**
+   * Renders `element` and populates {@link files} with the resulting {@link FileNode} objects.
+   * Called once per render cycle; must resolve before {@link files} is read.
+   */
   render(element: TElement): Promise<void>
+  /**
+   * Tears down the renderer and releases any held resources.
+   * Pass an `Error` to signal a failure, a number for an exit code, or omit for a clean shutdown.
+   */
   unmount(error?: Error | number | null): void
+  /**
+   * Accumulated {@link FileNode} results produced by the last {@link render} call.
+   * Not populated when {@link stream} is implemented.
+   */
   readonly files: Array<FileNode>
+  /**
+   * When present, core calls this instead of {@link render} and {@link files},
+   * forwarding each file to `FileManager` as soon as it is ready.
+   * Implementing this method enables per-file streaming without buffering the full result set.
+   */
+  stream?(element: TElement): AsyncIterable<FileNode>
 }
 
 /**
- * A factory function that produces a fresh {@link Renderer} per render.
+ * A factory function that produces a fresh {@link Renderer} per render cycle.
  *
  * Generators use this to declare which renderer handles their output.
  */
 export type RendererFactory<TElement = unknown> = () => Renderer<TElement>
 
 /**
- * Creates a renderer factory for use in generator definitions.
- *
- * Wrap your renderer factory function with this helper to register it as the
- * renderer for a generator. Core will call this factory once per render cycle
- * to obtain a fresh renderer instance.
+ * Wraps a renderer factory for use in generator definitions.
  *
  * @example
  * ```ts
- * // packages/renderer-jsx/src/index.ts
  * export const jsxRenderer = createRenderer(() => {
  *   const runtime = new Runtime()
  *   return {
@@ -42,14 +52,6 @@ export type RendererFactory<TElement = unknown> = () => Renderer<TElement>
  *     unmount(error) { runtime.unmount(error) },
  *   }
  * })
- *
- * // packages/plugin-zod/src/generators/zodGenerator.tsx
- * import { jsxRenderer } from '@kubb/renderer-jsx'
- * export const zodGenerator = defineGenerator<PluginZod>({
- *   name: 'zod',
- *   renderer: jsxRenderer,
- *   schema(node, options) { return <File ...>...</File> },
- * })
  * ```
  */
 export function createRenderer<TElement = unknown>(factory: RendererFactory<TElement>): RendererFactory<TElement> {