@kubb/core 4.35.0 → 4.36.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./chunk--u3MIqq1.js";
-import { A as UserPluginWithLifeCycle, C as Printer, D as UserConfig, E as UnknownUserPlugin, F as linters, I as logLevel, L as AsyncEventEmitter, M as PluginManager, N as getMode, O as UserLogger, P as formatters, S as PluginWithLifeCycle, T as ResolvePathParams, _ as PluginFactoryOptions, a as Config, b as PluginLifecycleHooks, c as Group, d as Logger, f as LoggerContext, g as PluginContext, h as Plugin, i as BarrelType, j as KubbEvents, k as UserPlugin, l as InputData, m as Output, n as AdapterFactoryOptions, o as DevtoolsOptions, p as LoggerOptions, r as AdapterSource, s as GetPluginFactoryOptions, t as Adapter, u as InputPath, v as PluginKey, w as ResolveNameParams, x as PluginParameter, y as PluginLifecycle } from "./types-7DgxNmCG.js";
+import { A as UserPlugin, B as AsyncEventEmitter, C as Printer, D as UnknownUserPlugin, E as ResolvePathParams, F as DefineStorage, I as defineStorage, L as formatters, M as KubbEvents, N as PluginManager, O as UserConfig, P as getMode, R as linters, S as PluginWithLifeCycle, T as ResolveNameParams, _ as PluginFactoryOptions, a as Config, b as PluginLifecycleHooks, c as Group, d as Logger, f as LoggerContext, g as PluginContext, h as Plugin, i as BarrelType, j as UserPluginWithLifeCycle, k as UserLogger, l as InputData, m as Output, n as AdapterFactoryOptions, o as DevtoolsOptions, p as LoggerOptions, r as AdapterSource, s as GetPluginFactoryOptions, t as Adapter, u as InputPath, v as PluginKey, w as PrinterFactoryOptions, x as PluginParameter, y as PluginLifecycle, z as logLevel } from "./types-D-MpaA4Z.js";
 import { definePrinter } from "@kubb/ast";
 import { Fabric } from "@kubb/react-fabric";
 import { KubbFile } from "@kubb/fabric-core/types";
@@ -158,6 +158,52 @@ declare class PromiseManager<TState = unknown> {
   }): TOutput;
 }
 //#endregion
+//#region src/storages/fsStorage.d.ts
+/**
+ * Built-in filesystem storage driver.
+ *
+ * This is the default storage when no `storage` option is configured in `output`.
+ * Keys are resolved against `process.cwd()`, so root-relative paths such as
+ * `src/gen/api/getPets.ts` are written to the correct location without extra configuration.
+ *
+ * Internally uses the `write` utility from `@internals/utils`, which:
+ * - trims leading/trailing whitespace before writing
+ * - skips the write when file content is already identical (deduplication)
+ * - creates missing parent directories automatically
+ * - supports Bun's native file API when running under Bun
+ *
+ * @example
+ * ```ts
+ * import { defineConfig, fsStorage } from '@kubb/core'
+ *
+ * export default defineConfig({
+ *   input:  { path: './petStore.yaml' },
+ *   output: { path: './src/gen', storage: fsStorage() },
+ * })
+ * ```
+ */
+declare const fsStorage: (options?: Record<string, never> | undefined) => DefineStorage;
+//#endregion
+//#region src/storages/memoryStorage.d.ts
+/**
+ * In-memory storage driver. Useful for testing and dry-run scenarios where
+ * generated output should be captured without touching the filesystem.
+ *
+ * All data lives in a `Map` scoped to the storage instance and is discarded
+ * when the instance is garbage-collected.
+ *
+ * @example
+ * ```ts
+ * import { defineConfig, memoryStorage } from '@kubb/core'
+ *
+ * export default defineConfig({
+ *   input:  { path: './petStore.yaml' },
+ *   output: { path: './src/gen', storage: memoryStorage() },
+ * })
+ * ```
+ */
+declare const memoryStorage: (options?: Record<string, never> | undefined) => DefineStorage;
+//#endregion
 //#region src/utils/FunctionParams.d.ts
 type FunctionParamsASTWithoutType = {
   name?: string;
@@ -265,5 +311,5 @@ declare function getConfigs(config: ConfigInput | UserConfig, args: CLIOptions):
 type Linter = keyof typeof linters;
 declare function detectLinter(): Promise<Linter | undefined>;
 //#endregion
-export { Adapter, AdapterFactoryOptions, AdapterSource, AsyncEventEmitter, BarrelType, type CLIOptions, Config, type ConfigInput, DevtoolsOptions, type FileMetaBase, FunctionParams, type FunctionParamsAST, GetPluginFactoryOptions, Group, InputData, InputPath, KubbEvents, Logger, LoggerContext, LoggerOptions, Output, PackageManager, Plugin, PluginContext, PluginFactoryOptions, PluginKey, PluginLifecycle, PluginLifecycleHooks, PluginManager, PluginParameter, PluginWithLifeCycle, Printer, PromiseManager, ResolveNameParams, ResolvePathParams, UnknownUserPlugin, UserConfig, UserLogger, UserPlugin, UserPluginWithLifeCycle, build, build as default, defineAdapter, defineConfig, defineLogger, definePlugin, definePrinter, detectFormatter, detectLinter, formatters, getBarrelFiles, getConfigs, getMode, isInputPath, linters, logLevel, safeBuild, setup };
+export { Adapter, AdapterFactoryOptions, AdapterSource, AsyncEventEmitter, BarrelType, type CLIOptions, Config, type ConfigInput, DefineStorage, DevtoolsOptions, type FileMetaBase, FunctionParams, type FunctionParamsAST, GetPluginFactoryOptions, Group, InputData, InputPath, KubbEvents, Logger, LoggerContext, LoggerOptions, Output, PackageManager, Plugin, PluginContext, PluginFactoryOptions, PluginKey, PluginLifecycle, PluginLifecycleHooks, PluginManager, PluginParameter, PluginWithLifeCycle, Printer, PrinterFactoryOptions, PromiseManager, ResolveNameParams, ResolvePathParams, UnknownUserPlugin, UserConfig, UserLogger, UserPlugin, UserPluginWithLifeCycle, build, build as default, defineAdapter, defineConfig, defineLogger, definePlugin, definePrinter, defineStorage, detectFormatter, detectLinter, formatters, fsStorage, getBarrelFiles, getConfigs, getMode, isInputPath, linters, logLevel, memoryStorage, safeBuild, setup };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -3,8 +3,8 @@ import mod from "node:module";
 import { EventEmitter } from "node:events";
 import { parseArgs, styleText } from "node:util";
 import { readFileSync } from "node:fs";
-import { access, mkdir, readFile, rm, writeFile } from "node:fs/promises";
-import path, { dirname, join, posix, resolve } from "node:path";
+import { access, mkdir, readFile, readdir, rm, writeFile } from "node:fs/promises";
+import path, { dirname, join, posix, relative, resolve } from "node:path";
 import { definePrinter } from "@kubb/ast";
 import { createFabric } from "@kubb/react-fabric";
 import { typescriptParser } from "@kubb/react-fabric/parsers";
@@ -401,7 +401,7 @@ function readSync(path) {
 * 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 — useful for catching write failures on unreliable file systems.
+* content does not match.
 */
 async function write(path, data, options = {}) {
 	const trimmed = data.trim();
@@ -1359,8 +1359,109 @@ var PluginManager = class {
 	}
 };
 //#endregion
+//#region src/defineStorage.ts
+/**
+* Wraps a storage builder so the `options` argument is optional, following the
+* same factory pattern as `definePlugin`, `defineLogger`, and `defineAdapter`.
+*
+* The builder receives the resolved options object and must return a
+* `DefineStorage`-compatible object that includes a `name` string.
+*
+* @example
+* ```ts
+* import { defineStorage } from '@kubb/core'
+*
+* export const memoryStorage = defineStorage((_options) => {
+*   const store = new Map<string, string>()
+*   return {
+*     name: 'memory',
+*     async hasItem(key) { return store.has(key) },
+*     async getItem(key) { return store.get(key) ?? null },
+*     async setItem(key, value) { store.set(key, value) },
+*     async removeItem(key) { store.delete(key) },
+*     async getKeys() { return [...store.keys()] },
+*     async clear() { store.clear() },
+*   }
+* })
+* ```
+*/
+function defineStorage(build) {
+	return (options) => build(options ?? {});
+}
+//#endregion
+//#region src/storages/fsStorage.ts
+/**
+* Built-in filesystem storage driver.
+*
+* This is the default storage when no `storage` option is configured in `output`.
+* Keys are resolved against `process.cwd()`, so root-relative paths such as
+* `src/gen/api/getPets.ts` are written to the correct location without extra configuration.
+*
+* Internally uses the `write` utility from `@internals/utils`, which:
+* - trims leading/trailing whitespace before writing
+* - skips the write when file content is already identical (deduplication)
+* - creates missing parent directories automatically
+* - supports Bun's native file API when running under Bun
+*
+* @example
+* ```ts
+* import { defineConfig, fsStorage } from '@kubb/core'
+*
+* export default defineConfig({
+*   input:  { path: './petStore.yaml' },
+*   output: { path: './src/gen', storage: fsStorage() },
+* })
+* ```
+*/
+const fsStorage = defineStorage(() => ({
+	name: "fs",
+	async hasItem(key) {
+		try {
+			await access(resolve(key));
+			return true;
+		} catch {
+			return false;
+		}
+	},
+	async getItem(key) {
+		try {
+			return await readFile(resolve(key), "utf8");
+		} catch {
+			return null;
+		}
+	},
+	async setItem(key, value) {
+		await write(resolve(key), value, { sanity: false });
+	},
+	async removeItem(key) {
+		await rm(resolve(key), { force: true });
+	},
+	async getKeys(base) {
+		const keys = [];
+		async function walk(dir, prefix) {
+			let entries;
+			try {
+				entries = await readdir(dir, { withFileTypes: true });
+			} catch {
+				return;
+			}
+			for (const entry of entries) {
+				const rel = prefix ? `${prefix}/${entry.name}` : entry.name;
+				if (entry.isDirectory()) await walk(join(dir, entry.name), rel);
+				else keys.push(rel);
+			}
+		}
+		await walk(resolve(base ?? process.cwd()), "");
+		return keys;
+	},
+	async clear(base) {
+		if (!base) return;
+		await clean(resolve(base));
+	}
+}));
+//#endregion
 //#region package.json
-var version$1 = "4.35.0";
+var version$1 = "4.36.0";
 //#endregion
 //#region src/utils/diagnostics.ts
 /**
@@ -1391,7 +1492,7 @@ async function setup(options) {
 			`  • Output: ${userConfig.output?.path || "not specified"}`,
 			`  • Plugins: ${userConfig.plugins?.length || 0}`,
 			"Output Settings:",
-			`  • Write: ${userConfig.output?.write !== false ? "enabled" : "disabled"}`,
+			`  • Storage: ${userConfig.output?.storage ? `custom(${userConfig.output.storage.name})` : userConfig.output?.write === false ? "disabled" : "filesystem (default)"}`,
 			`  • Formatter: ${userConfig.output?.format || "none"}`,
 			`  • Linter: ${userConfig.output?.lint || "none"}`,
 			"Environment:",
@@ -1428,12 +1529,13 @@ async function setup(options) {
 		} : void 0,
 		plugins: userConfig.plugins
 	};
+	const storage = definedConfig.output.write === false ? null : definedConfig.output.storage ?? fsStorage();
 	if (definedConfig.output.clean) {
 		await events.emit("debug", {
 			date: /* @__PURE__ */ new Date(),
 			logs: ["Cleaning output directories", `  • Output: ${definedConfig.output.path}`]
 		});
-		await clean(definedConfig.output.path);
+		await storage?.clear(resolve(definedConfig.root, definedConfig.output.path));
 	}
 	const fabric = createFabric();
 	fabric.use(fsPlugin);
@@ -1453,7 +1555,8 @@ async function setup(options) {
 			source
 		});
 		if (source) {
-			if (definedConfig.output.write) await write(file.path, source, { sanity: false });
+			const key = relative(resolve(definedConfig.root), file.path);
+			await storage?.setItem(key, source);
 			sources.set(file.path, source);
 		}
 	});
@@ -1468,7 +1571,7 @@ async function setup(options) {
 		date: /* @__PURE__ */ new Date(),
 		logs: [
 			"✓ Fabric initialized",
-			`  • File writing: ${definedConfig.output.write ? "enabled" : "disabled (dry-run)"}`,
+			`  • Storage: ${storage ? storage.name : "disabled (dry-run)"}`,
 			`  • Barrel type: ${definedConfig.output.barrelType || "none"}`
 		]
 	});
@@ -1786,6 +1889,54 @@ var PackageManager = class PackageManager {
 	}
 };
 //#endregion
+//#region src/storages/memoryStorage.ts
+/**
+* In-memory storage driver. Useful for testing and dry-run scenarios where
+* generated output should be captured without touching the filesystem.
+*
+* All data lives in a `Map` scoped to the storage instance and is discarded
+* when the instance is garbage-collected.
+*
+* @example
+* ```ts
+* import { defineConfig, memoryStorage } from '@kubb/core'
+*
+* export default defineConfig({
+*   input:  { path: './petStore.yaml' },
+*   output: { path: './src/gen', storage: memoryStorage() },
+* })
+* ```
+*/
+const memoryStorage = defineStorage(() => {
+	const store = /* @__PURE__ */ new Map();
+	return {
+		name: "memory",
+		async hasItem(key) {
+			return store.has(key);
+		},
+		async getItem(key) {
+			return store.get(key) ?? null;
+		},
+		async setItem(key, value) {
+			store.set(key, value);
+		},
+		async removeItem(key) {
+			store.delete(key);
+		},
+		async getKeys(base) {
+			const keys = [...store.keys()];
+			return base ? keys.filter((k) => k.startsWith(base)) : keys;
+		},
+		async clear(base) {
+			if (!base) {
+				store.clear();
+				return;
+			}
+			for (const key of store.keys()) if (key.startsWith(base)) store.delete(key);
+		}
+	};
+});
+//#endregion
 //#region src/utils/FunctionParams.ts
 /**
 * @deprecated
@@ -2155,6 +2306,6 @@ async function detectLinter() {
 	]) if (await isLinterAvailable(linter)) return linter;
 }
 //#endregion
-export { AsyncEventEmitter, FunctionParams, PackageManager, PluginManager, PromiseManager, build, build as default, defineAdapter, defineConfig, defineLogger, definePlugin, definePrinter, detectFormatter, detectLinter, formatters, getBarrelFiles, getConfigs, getMode, isInputPath, linters, logLevel, safeBuild, setup };
+export { AsyncEventEmitter, FunctionParams, PackageManager, PluginManager, PromiseManager, build, build as default, defineAdapter, defineConfig, defineLogger, definePlugin, definePrinter, defineStorage, detectFormatter, detectLinter, formatters, fsStorage, getBarrelFiles, getConfigs, getMode, isInputPath, linters, logLevel, memoryStorage, safeBuild, setup };
 
 //# sourceMappingURL=index.js.map