@kubb/core 5.0.0-beta.66 → 5.0.0-beta.68

package/README.md

@@ -22,7 +22,7 @@
 
 # @kubb/core
 
-### Core engine for plugin-based code generation
+### Core engine for Kubb
 
 Core engine for Kubb's plugin-based code generation system. Provides the plugin driver, file manager, `defineConfig`, `definePlugin`, `defineMiddleware`, and the build orchestration layer used by every Kubb plugin.
 

package/dist/{diagnostics-M8ckppMO.d.ts → diagnostics-CJtO1uSM.d.ts}

@@ -926,13 +926,6 @@ type Output<_TOptions = unknown> = {
    * Pass a function to compute the footer from the file's `BannerMeta`.
    */
   footer?: string | ((meta: BannerMeta) => string);
-  /**
-   * Allows the plugin to overwrite hand-written files at the same path.
-   * Defaults to `false` to protect manual edits.
-   *
-   * @default false
-   */
-  override?: boolean;
 } & ExtractRegistryKey$1<Kubb.PluginOptionsRegistry, 'output'>;
 /**
  * Groups generated files into subdirectories based on an OpenAPI tag or path
@@ -1127,7 +1120,7 @@ type KubbPluginSetupContext<TFactory extends PluginFactoryOptions = PluginFactor
    * Register a generator dynamically. Generators fire during the AST walk (schema/operation/operations)
    * just like generators declared statically on `createPlugin`.
    */
-  addGenerator<TElement = unknown>(generator: Generator$1<TFactory, TElement>): void;
+  addGenerator<TElement = unknown>(generator: Generator<TFactory, TElement>): void;
   /**
    * Set or override the resolver for this plugin.
    * The resolver controls file naming and path resolution.
@@ -1149,6 +1142,9 @@ type KubbPluginSetupContext<TFactory extends PluginFactoryOptions = PluginFactor
   setOptions(options: TFactory['resolvedOptions']): void;
   /**
    * Inject a raw file into the build output, bypassing the generation pipeline.
+   *
+   * Pass `copy` with an absolute path to emit a real source file (a shipped template) into the
+   * generated folder verbatim, instead of building its content from `sources`.
    */
   injectFile(userFileNode: UserFileNode): void;
   /**
@@ -1215,7 +1211,7 @@ type NormalizedPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptio
   };
   resolver: TOptions['resolver'];
   macros?: Array<Macro>;
-  generators?: Array<Generator$1>;
+  generators?: Array<Generator>;
   apply?: (config: Config) => boolean;
   version?: string;
 };
@@ -1365,7 +1361,7 @@ declare class KubbDriver {
    *
    * Call this method inside `addGenerator()` (in `kubb:plugin:setup`) to wire up a generator.
    */
-  registerGenerator(pluginName: string, generator: Generator$1): void;
+  registerGenerator(pluginName: string, generator: Generator): void;
   /**
    * Returns `true` when at least one generator was registered for the given plugin
    * via `addGenerator()` in `kubb:plugin:setup` (event-based path).
@@ -1561,7 +1557,7 @@ type GeneratorContext<TOptions extends PluginFactoryOptions = PluginFactoryOptio
  * })
  * ```
  */
-type Generator$1<TOptions extends PluginFactoryOptions = PluginFactoryOptions, TElement = unknown> = {
+type Generator<TOptions extends PluginFactoryOptions = PluginFactoryOptions, TElement = unknown> = {
   /**
    * Used in diagnostic messages and debug output.
    */
@@ -1633,7 +1629,7 @@ type Generator$1<TOptions extends PluginFactoryOptions = PluginFactoryOptions, T
  * })
  * ```
  */
-declare function defineGenerator<TOptions extends PluginFactoryOptions = PluginFactoryOptions, TElement = unknown>(generator: Generator$1<TOptions, TElement>): Generator$1<TOptions, TElement>;
+declare function defineGenerator<TOptions extends PluginFactoryOptions = PluginFactoryOptions, TElement = unknown>(generator: Generator<TOptions, TElement>): Generator<TOptions, TElement>;
 //#endregion
 //#region src/defineParser.d.ts
 type PrintOptions = {
@@ -1976,17 +1972,6 @@ type Config<TInput = Input> = {
      * ```
      */
     defaultBanner?: 'simple' | 'full' | false;
-    /**
-     * Overwrite existing files when `true`, skip files that already exist when `false`. Individual
-     * plugins can override it. Keep `false` to avoid clobbering local edits in the output folder.
-     *
-     * @example
-     * ```ts
-     * override: true   // regenerate everything, even existing files
-     * override: false  // skip files that already exist
-     * ```
-     */
-    override?: boolean;
   } & ExtractRegistryKey<Kubb.ConfigOptionsRegistry, 'output'>;
   /**
    * Where generated files are persisted. Defaults to `fsStorage()` (disk). Pass `memoryStorage()`
@@ -2903,5 +2888,5 @@ declare class Diagnostics {
   static formatLines(diagnostic: Diagnostic): Array<string>;
 }
 //#endregion
-export { KubbPluginSetupContext as $, KubbHookStartContext as A, Adapter as At, ParsedFile as B, KubbFilesProcessingEndContext as C, GenerationResult as Ct, KubbGenerationStartContext as D, UserReporter as Dt, KubbGenerationEndContext as E, ReporterName as Et, KubbSuccessContext as F, Generator$1 as G, createKubb as H, KubbWarnContext as I, KubbDriver as J, GeneratorContext as K, PossibleConfig as L, KubbInfoContext as M, AdapterSource as Mt, KubbLifecycleStartContext as N, createAdapter as Nt, KubbHookEndContext as O, createReporter as Ot, KubbPluginsEndContext as P, AsyncEventEmitter as Pt, KubbPluginEndContext as Q, UserConfig as R, KubbFileProcessingUpdate as S, createStorage as St, KubbFilesProcessingUpdateContext as T, ReporterContext as Tt, Parser as U, Kubb$1 as V, defineParser as W, Group as X, Exclude$1 as Y, Include as Z, InputPath as _, defineResolver as _t, DiagnosticLocation as a, Override as at, KubbDiagnosticContext as b, createRenderer as bt, PerformanceDiagnostic as c, definePlugin as ct, SerializedDiagnostic as d, ResolveBannerFile as dt, KubbPluginStartContext as et, UpdateDiagnostic as f, ResolveOptionsContext as ft, InputData as g, ResolverPathParams as gt, Config as h, ResolverFileParams as ht, DiagnosticKind as i, OutputOptions as it, KubbHooks as j, AdapterFactoryOptions as jt, KubbHookLineContext as k, logLevel as kt, ProblemCode as l, BannerMeta as lt, CLIOptions as m, ResolverContext as mt, DiagnosticByCode as n, Output as nt, DiagnosticSeverity as o, Plugin as ot, BuildOutput as p, Resolver as pt, defineGenerator as q, DiagnosticDoc as r, OutputMode as rt, Diagnostics as s, PluginFactoryOptions as st, Diagnostic as t, NormalizedPlugin as tt, ProblemDiagnostic as u, ResolveBannerContext as ut, KubbBuildEndContext as v, Renderer as vt, KubbFilesProcessingStartContext as w, Reporter as wt, KubbErrorContext as x, Storage as xt, KubbBuildStartContext as y, RendererFactory as yt, FileProcessorHooks as z };
-//# sourceMappingURL=diagnostics-M8ckppMO.d.ts.map
+export { KubbPluginSetupContext as $, KubbHookStartContext as A, Adapter as At, ParsedFile as B, KubbFilesProcessingEndContext as C, GenerationResult as Ct, KubbGenerationStartContext as D, UserReporter as Dt, KubbGenerationEndContext as E, ReporterName as Et, KubbSuccessContext as F, Generator as G, createKubb as H, KubbWarnContext as I, KubbDriver as J, GeneratorContext as K, PossibleConfig as L, KubbInfoContext as M, AdapterSource as Mt, KubbLifecycleStartContext as N, createAdapter as Nt, KubbHookEndContext as O, createReporter as Ot, KubbPluginsEndContext as P, AsyncEventEmitter as Pt, KubbPluginEndContext as Q, UserConfig as R, KubbFileProcessingUpdate as S, createStorage as St, KubbFilesProcessingUpdateContext as T, ReporterContext as Tt, Parser as U, Kubb$1 as V, defineParser as W, Group as X, Exclude$1 as Y, Include as Z, InputPath as _, defineResolver as _t, DiagnosticLocation as a, Override as at, KubbDiagnosticContext as b, createRenderer as bt, PerformanceDiagnostic as c, definePlugin as ct, SerializedDiagnostic as d, ResolveBannerFile as dt, KubbPluginStartContext as et, UpdateDiagnostic as f, ResolveOptionsContext as ft, InputData as g, ResolverPathParams as gt, Config as h, ResolverFileParams as ht, DiagnosticKind as i, OutputOptions as it, KubbHooks as j, AdapterFactoryOptions as jt, KubbHookLineContext as k, logLevel as kt, ProblemCode as l, BannerMeta as lt, CLIOptions as m, ResolverContext as mt, DiagnosticByCode as n, Output as nt, DiagnosticSeverity as o, Plugin as ot, BuildOutput as p, Resolver as pt, defineGenerator as q, DiagnosticDoc as r, OutputMode as rt, Diagnostics as s, PluginFactoryOptions as st, Diagnostic as t, NormalizedPlugin as tt, ProblemDiagnostic as u, ResolveBannerContext as ut, KubbBuildEndContext as v, Renderer as vt, KubbFilesProcessingStartContext as w, Reporter as wt, KubbErrorContext as x, Storage as xt, KubbBuildStartContext as y, RendererFactory as yt, FileProcessorHooks as z };
+//# sourceMappingURL=diagnostics-CJtO1uSM.d.ts.map

package/dist/index.cjs

@@ -1,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_memoryStorage = require("./memoryStorage-67VG6jZn.cjs");
+const require_memoryStorage = require("./memoryStorage-CfycFGzX.cjs");
 let node_crypto = require("node:crypto");
 let node_util = require("node:util");
 let node_fs_promises = require("node:fs/promises");
@@ -96,167 +96,6 @@ function randomCliColor(text) {
 	return (0, node_util.styleText)(randomColors[(0, node_crypto.hash)("sha256", text, "buffer").readUInt32BE(0) % randomColors.length] ?? "white", text);
 }
 //#endregion
-//#region ../../internals/utils/src/runtime.ts
-/**
-* Detects the JavaScript runtime executing the current process and exposes its name and version.
-*
-* Prefer the shared {@link runtime} instance over constructing your own.
-*/
-var Runtime = class {
-	/**
-	* `true` when the current process is running under Bun.
-	*
-	* Detection keys off the global `Bun` object rather than `process.versions`,
-	* because Bun polyfills `process.versions.node` for Node compatibility and would
-	* otherwise look like Node.
-	*
-	* @example
-	* ```ts
-	* if (runtime.isBun) {
-	*   await Bun.write(path, data)
-	* }
-	* ```
-	*/
-	get isBun() {
-		return typeof Bun !== "undefined";
-	}
-	/**
-	* `true` when the current process is running under Deno.
-	*/
-	get isDeno() {
-		return typeof globalThis.Deno !== "undefined";
-	}
-	/**
-	* `true` when the current process is running under Node.
-	*
-	* Bun and Deno are excluded first so a polyfilled `process` does not register as Node.
-	*/
-	get isNode() {
-		return !this.isBun && !this.isDeno && typeof process !== "undefined" && process.versions?.node != null;
-	}
-	/**
-	* Name of the runtime executing the current process.
-	*
-	* @example
-	* ```ts
-	* runtime.name // 'bun' when run with `bun kubb`, 'node' otherwise
-	* ```
-	*/
-	get name() {
-		if (this.isBun) return "bun";
-		if (this.isDeno) return "deno";
-		return "node";
-	}
-	/**
-	* Version of the active runtime, or an empty string when it cannot be read.
-	*
-	* @example
-	* ```ts
-	* runtime.version // '1.3.11' under Bun, '22.22.2' under Node
-	* ```
-	*/
-	get version() {
-		if (this.isBun) return process.versions.bun ?? "";
-		if (this.isDeno) return globalThis.Deno?.version?.deno ?? "";
-		return process.versions?.node ?? "";
-	}
-};
-/**
-* Shared {@link Runtime} instance describing the JavaScript runtime executing the current process.
-*/
-const runtime = new Runtime();
-//#endregion
-//#region ../../internals/utils/src/fs.ts
-/**
-* Writes `data` to `path`, trimming leading/trailing whitespace before saving.
-* Skips the write when the trimmed content is empty or identical to what is already on disk.
-* Creates any missing parent directories automatically.
-* When `sanity` is `true`, re-reads the file after writing and throws if the content does not match.
-*
-* @example
-* ```ts
-* await write('./src/Pet.ts', source)         // writes and returns trimmed content
-* await write('./src/Pet.ts', source)         // null — file unchanged
-* await write('./src/Pet.ts', '  ')           // null — empty content skipped
-* ```
-*/
-async function write(path, data, options = {}) {
-	const trimmed = data.trim();
-	if (trimmed === "") return null;
-	const resolved = (0, node_path.resolve)(path);
-	if (runtime.isBun) {
-		const file = Bun.file(resolved);
-		if ((await file.exists() ? await file.text() : null) === trimmed) return null;
-		await Bun.write(resolved, trimmed);
-		return trimmed;
-	}
-	try {
-		if (await (0, node_fs_promises.readFile)(resolved, { encoding: "utf-8" }) === trimmed) return null;
-	} catch {}
-	await (0, node_fs_promises.mkdir)((0, node_path.dirname)(resolved), { recursive: true });
-	await (0, node_fs_promises.writeFile)(resolved, trimmed, { encoding: "utf-8" });
-	if (options.sanity) {
-		const savedData = await (0, node_fs_promises.readFile)(resolved, { encoding: "utf-8" });
-		if (savedData !== trimmed) throw new Error(`Sanity check failed for ${path}\n\nData[${data.length}]:\n${data}\n\nSaved[${savedData.length}]:\n${savedData}\n`);
-		return savedData;
-	}
-	return trimmed;
-}
-/**
-* Recursively removes `path`. Silently succeeds when `path` does not exist.
-*
-* @example
-* ```ts
-* await clean('./dist')
-* ```
-*/
-async function clean(path) {
-	return (0, node_fs_promises.rm)(path, {
-		recursive: true,
-		force: true
-	});
-}
-/**
-* Converts a filesystem path to use POSIX (`/`) separators.
-*
-* Most of the codebase compares and composes paths as strings (prefix matching, joining for
-* import specifiers, splitting on `/`). On POSIX `path.resolve` already returns `/`-separated
-* paths, but on Windows it returns `\`-separated paths, which breaks every such comparison.
-*
-* Routing every path that crosses a module boundary through `toPosixPath` keeps the rest of the
-* code platform-agnostic. The conversion runs unconditionally so Windows-specific behavior is
-* exercisable from POSIX CI.
-*
-* @example
-* toPosixPath('C:\\repo\\src\\pet.ts') // 'C:/repo/src/pet.ts'
-*/
-function toPosixPath(filePath) {
-	return filePath.replaceAll("\\", "/");
-}
-/**
-* Builds a nested file path from a dotted name. Splits on dots that precede a letter
-* (so version numbers embedded in operationIds like `v2025.0` stay intact), camelCases
-* every earlier segment, applies `caseLast` to the final segment, and joins with `/`.
-*
-* Empty segments are dropped before joining. They arise when the name starts with a dot
-* followed by a letter (e.g. `..Schema` splits into `['..', 'Schema']` and `'..'` cases to
-* an empty string). Without this a leading `/` would form, which `path.resolve` reads as an
-* absolute path, letting generated files escape the configured output directory.
-*
-* @example Nested path from a dotted name
-* `toFilePath('pet.petId') // 'pet/petId'`
-*
-* @example PascalCase the final segment
-* `toFilePath('pet.Pet', pascalCase) // 'pet/Pet'`
-*
-* @example Suffix applied to the final segment only
-* `toFilePath('tag.tag', (part) => camelCase(part, { suffix: 'schema' })) // 'tag/tagSchema'`
-*/
-function toFilePath(name, caseLast = require_memoryStorage.camelCase) {
-	const parts = name.split(/\.(?=[a-zA-Z])/);
-	return parts.map((part, i) => i === parts.length - 1 ? caseLast(part) : require_memoryStorage.camelCase(part)).filter(Boolean).join("/");
-}
-//#endregion
 //#region ../../internals/utils/src/promise.ts
 function* chunks(arr, size) {
 	for (let i = 0; i < arr.length; i += size) yield arr.slice(i, i + size);
@@ -608,7 +447,7 @@ function createAdapter(build) {
 /**
 * Docs major version, derived from the package version so the link tracks the published major.
 */
-const docsMajor = "5.0.0-beta.66".split(".")[0] ?? "5";
+const docsMajor = "5.0.0-beta.68".split(".")[0] ?? "5";
 /**
 * Narrows a {@link Diagnostic} to the variant for `code`, or `null` when it does not match.
 *
@@ -1130,7 +969,7 @@ function matchesSchemaPattern(node, type, pattern) {
 * - `camelCase` for `function` and everything else.
 */
 function defaultResolver(name, type) {
-	if (type === "file") return toFilePath(name);
+	if (type === "file") return require_memoryStorage.toFilePath(name);
 	if (type === "type") return require_memoryStorage.pascalCase(name);
 	return require_memoryStorage.camelCase(name);
 }
@@ -2351,14 +2190,14 @@ const fsStorage = require_memoryStorage.createStorage(() => ({
 		}
 	},
 	async setItem(key, value) {
-		await write((0, node_path.resolve)(key), value, { sanity: false });
+		await require_memoryStorage.write((0, node_path.resolve)(key), value, { sanity: false });
 	},
 	async removeItem(key) {
 		await (0, node_fs_promises.rm)((0, node_path.resolve)(key), { force: true });
 	},
 	async getKeys(base) {
 		const resolvedBase = (0, node_path.resolve)(base ?? process.cwd());
-		if (runtime.isBun) {
+		if (require_memoryStorage.runtime.isBun) {
 			const bunGlob = new Bun.Glob("**/*");
 			return Array.fromAsync(bunGlob.scan({
 				cwd: resolvedBase,
@@ -2371,13 +2210,13 @@ const fsStorage = require_memoryStorage.createStorage(() => ({
 			for await (const entry of (0, node_fs_promises.glob)("**/*", {
 				cwd: resolvedBase,
 				withFileTypes: true
-			})) if (entry.isFile()) keys.push(toPosixPath((0, node_path.relative)(resolvedBase, (0, node_path.join)(entry.parentPath, entry.name))));
+			})) if (entry.isFile()) keys.push(require_memoryStorage.toPosixPath((0, node_path.relative)(resolvedBase, (0, node_path.join)(entry.parentPath, entry.name))));
 		} catch (_error) {}
 		return keys;
 	},
 	async clear(base) {
 		if (!base) return;
-		await clean((0, node_path.resolve)(base));
+		await require_memoryStorage.clean((0, node_path.resolve)(base));
 	}
 }));
 //#endregion
@@ -2773,7 +2612,7 @@ const fileReporter = createReporter({
 			Date.now()
 		].filter(Boolean).join("-")}.log`;
 		const pathName = (0, node_path.resolve)(node_process.default.cwd(), ".kubb", baseName);
-		await write(pathName, `${content}\n`);
+		await require_memoryStorage.write(pathName, `${content}\n`);
 		console.error(`Debug log written to ${(0, node_path.relative)(node_process.default.cwd(), pathName)}`);
 	}
 });