@kubb/core 4.33.5 → 4.35.0

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { t as __name } from "./chunk--u3MIqq1.js";
-import { A as linters, C as UserLogger, D as PluginManager, E as KubbEvents, M as AsyncEventEmitter, O as getMode, S as UserConfig, T as UserPluginWithLifeCycle, _ as PluginParameter, a as InputData, b as ResolvePathParams, c as LoggerContext, d as Plugin, f as PluginContext, g as PluginLifecycleHooks, h as PluginLifecycle, i as Group, j as logLevel, k as formatters, l as LoggerOptions, m as PluginKey, n as Config, o as InputPath, p as PluginFactoryOptions, r as GetPluginFactoryOptions, s as Logger, t as BarrelType, u as Output, v as PluginWithLifeCycle, w as UserPlugin, x as UnknownUserPlugin, y as ResolveNameParams } from "./types-DfjjJb2r.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 { definePrinter } from "@kubb/ast";
 import { Fabric } from "@kubb/react-fabric";
 import { KubbFile } from "@kubb/fabric-core/types";
 
@@ -71,6 +72,25 @@ declare function defineConfig(config: PossiblePromise<UserConfig | UserConfig[]>
  */
 declare function isInputPath(config: UserConfig | undefined): config is UserConfig<InputPath>;
 //#endregion
+//#region src/defineAdapter.d.ts
+type AdapterBuilder<T extends AdapterFactoryOptions> = (options: T['options']) => Adapter<T>;
+/**
+ * Wraps an adapter builder to make the options parameter optional.
+ *
+ * @example
+ * ```ts
+ * export const adapterOas = defineAdapter<OasAdapter>((options) => {
+ *   const { validate = true, dateType = 'string' } = options
+ *   return {
+ *     name: adapterOasName,
+ *     options: { validate, dateType, ... },
+ *     parse(source) { ... },
+ *   }
+ * })
+ * ```
+ */
+declare function defineAdapter<T extends AdapterFactoryOptions = AdapterFactoryOptions>(build: AdapterBuilder<T>): (options?: T['options']) => Adapter<T>;
+//#endregion
 //#region src/defineLogger.d.ts
 declare function defineLogger<Options extends LoggerOptions = LoggerOptions>(logger: UserLogger<Options>): Logger<Options>;
 //#endregion
@@ -245,5 +265,5 @@ declare function getConfigs(config: ConfigInput | UserConfig, args: CLIOptions):
 type Linter = keyof typeof linters;
 declare function detectLinter(): Promise<Linter | undefined>;
 //#endregion
-export { BarrelType, type CLIOptions, Config, type ConfigInput, type FileMetaBase, FunctionParams, type FunctionParamsAST, GetPluginFactoryOptions, Group, InputData, InputPath, KubbEvents, Logger, LoggerContext, LoggerOptions, Output, PackageManager, Plugin, PluginContext, PluginFactoryOptions, PluginKey, PluginLifecycle, PluginLifecycleHooks, PluginManager, PluginParameter, PluginWithLifeCycle, PromiseManager, ResolveNameParams, ResolvePathParams, UnknownUserPlugin, UserConfig, UserLogger, UserPlugin, UserPluginWithLifeCycle, build, build as default, defineConfig, defineLogger, definePlugin, detectFormatter, detectLinter, formatters, getBarrelFiles, getConfigs, getMode, isInputPath, linters, logLevel, safeBuild, setup };
+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 };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,21 +1,23 @@
 import "./chunk--u3MIqq1.js";
 import mod from "node:module";
-import path, { dirname, join, posix, resolve } from "node:path";
 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 { definePrinter } from "@kubb/ast";
 import { createFabric } from "@kubb/react-fabric";
 import { typescriptParser } from "@kubb/react-fabric/parsers";
 import { fsPlugin } from "@kubb/react-fabric/plugins";
 import { performance } from "node:perf_hooks";
+import { deflateSync } from "fflate";
+import { x } from "tinyexec";
 import { version } from "node:process";
 import os from "node:os";
 import { pathToFileURL } from "node:url";
 import * as pkg from "empathic/package";
 import { coerce, satisfies } from "semver";
 import { sortBy } from "remeda";
-import { x } from "tinyexec";
 //#region ../../internals/utils/dist/index.js
 /** Thrown when a plugin's configuration or input fails validation. */
 var ValidationPluginError = class extends Error {};
@@ -662,6 +664,9 @@ function defineConfig(config) {
 function isInputPath(config) {
 	return typeof config?.input === "object" && config.input !== null && "path" in config.input;
 }
+//#endregion
+//#region src/constants.ts
+const DEFAULT_STUDIO_URL = "https://studio.kubb.dev";
 const BARREL_FILENAME = "index.ts";
 const DEFAULT_BANNER = "simple";
 const DEFAULT_EXTENSION = { ".ts": ".ts" };
@@ -721,6 +726,50 @@ const formatters = {
 	}
 };
 //#endregion
+//#region src/devtools.ts
+/**
+* Encodes a `RootNode` as a compressed, URL-safe string.
+*
+* The JSON representation is deflate-compressed with {@link deflateSync} before
+* base64url encoding, which typically reduces payload size by 70–80 % and
+* keeps URLs well within browser and server path-length limits.
+*
+* Use {@link decodeAst} to reverse.
+*/
+function encodeAst(root) {
+	const compressed = deflateSync(new TextEncoder().encode(JSON.stringify(root)));
+	return Buffer.from(compressed).toString("base64url");
+}
+/**
+* Constructs the Kubb Studio URL for the given `RootNode`.
+* When `options.ast` is `true`, navigates to the AST inspector (`/ast`).
+* The `root` is encoded and attached as the `?root=` query parameter so Studio
+* can decode and render it without a round-trip to any server.
+*/
+function getStudioUrl(root, studioUrl, options = {}) {
+	return `${studioUrl.replace(/\/$/, "")}${options.ast ? "/ast" : ""}?root=${encodeAst(root)}`;
+}
+/**
+* Opens the Kubb Studio URL for the given `RootNode` in the default browser —
+*
+* Falls back to printing the URL if the browser cannot be launched.
+*/
+async function openInStudio(root, studioUrl, options = {}) {
+	const url = getStudioUrl(root, studioUrl, options);
+	const cmd = process.platform === "win32" ? "cmd" : process.platform === "darwin" ? "open" : "xdg-open";
+	const args = process.platform === "win32" ? [
+		"/c",
+		"start",
+		"",
+		url
+	] : [url];
+	try {
+		await x(cmd, args);
+	} catch {
+		console.log(`\n  ${url}\n`);
+	}
+}
+//#endregion
 //#region ../../node_modules/.pnpm/yocto-queue@1.2.2/node_modules/yocto-queue/index.js
 var Node = class {
 	value;
@@ -907,6 +956,12 @@ function getMode(fileOrFolder) {
 var PluginManager = class {
 	config;
 	options;
+	/**
+	* The universal `@kubb/ast` `RootNode` produced by the adapter, set by
+	* the build pipeline after the adapter's `parse()` resolves.
+	*/
+	rootNode = void 0;
+	#studioIsOpen = false;
 	#plugins = /* @__PURE__ */ new Set();
 	#usedPluginNames = {};
 	#promiseManager;
@@ -924,6 +979,7 @@ var PluginManager = class {
 	}
 	getContext(plugin) {
 		const plugins = [...this.#plugins];
+		const pluginManager = this;
 		const baseContext = {
 			fabric: this.options.fabric,
 			config: this.config,
@@ -936,6 +992,17 @@ var PluginManager = class {
 			},
 			upsertFile: async (...files) => {
 				await this.options.fabric.upsertFile(...files);
+			},
+			get rootNode() {
+				return pluginManager.rootNode;
+			},
+			openInStudio(options) {
+				if (typeof pluginManager.config.devtools !== "object") throw new Error("Devtools must be an object");
+				if (!pluginManager.rootNode) throw new Error("RootNode is not defined, make sure you have set the parser in kubb.config.ts");
+				if (pluginManager.#studioIsOpen) return;
+				pluginManager.#studioIsOpen = true;
+				const studioUrl = pluginManager.config.devtools?.studioUrl ?? "https://studio.kubb.dev";
+				return openInStudio(pluginManager.rootNode, studioUrl, options);
 			}
 		};
 		const mergedExtras = {};
@@ -1293,7 +1360,7 @@ var PluginManager = class {
 };
 //#endregion
 //#region package.json
-var version$1 = "4.33.5";
+var version$1 = "4.35.0";
 //#endregion
 //#region src/utils/diagnostics.ts
 /**
@@ -1355,6 +1422,10 @@ async function setup(options) {
 			defaultBanner: DEFAULT_BANNER,
 			...userConfig.output
 		},
+		devtools: userConfig.devtools ? {
+			studioUrl: DEFAULT_STUDIO_URL,
+			...typeof userConfig.devtools === "boolean" ? {} : userConfig.devtools
+		} : void 0,
 		plugins: userConfig.plugins
 	};
 	if (definedConfig.output.clean) {
@@ -1401,14 +1472,31 @@ async function setup(options) {
 			`  • Barrel type: ${definedConfig.output.barrelType || "none"}`
 		]
 	});
+	const pluginManager = new PluginManager(definedConfig, {
+		fabric,
+		events,
+		concurrency: 15
+	});
+	if (definedConfig.adapter) {
+		const source = inputToAdapterSource(definedConfig);
+		await events.emit("debug", {
+			date: /* @__PURE__ */ new Date(),
+			logs: [`Running adapter: ${definedConfig.adapter.name}`]
+		});
+		pluginManager.rootNode = await definedConfig.adapter.parse(source);
+		await events.emit("debug", {
+			date: /* @__PURE__ */ new Date(),
+			logs: [
+				`✓ Adapter '${definedConfig.adapter.name}' resolved RootNode`,
+				`  • Schemas: ${pluginManager.rootNode.schemas.length}`,
+				`  • Operations: ${pluginManager.rootNode.operations.length}`
+			]
+		});
+	}
 	return {
 		events,
 		fabric,
-		pluginManager: new PluginManager(definedConfig, {
-			fabric,
-			events,
-			concurrency: 15
-		}),
+		pluginManager,
 		sources
 	};
 }
@@ -1563,6 +1651,44 @@ function buildBarrelExports({ barrelFiles, rootDir, existingExports, config, plu
 		});
 	});
 }
+/**
+* Maps the resolved `Config['input']` shape into an `AdapterSource` that
+* the adapter's `parse()` can consume.
+*/
+function inputToAdapterSource(config) {
+	if (Array.isArray(config.input)) return {
+		type: "paths",
+		paths: config.input.map((i) => resolve(config.root, i.path))
+	};
+	if ("data" in config.input) return {
+		type: "data",
+		data: config.input.data
+	};
+	return {
+		type: "path",
+		path: resolve(config.root, config.input.path)
+	};
+}
+//#endregion
+//#region src/defineAdapter.ts
+/**
+* Wraps an adapter builder to make the options parameter optional.
+*
+* @example
+* ```ts
+* export const adapterOas = defineAdapter<OasAdapter>((options) => {
+*   const { validate = true, dateType = 'string' } = options
+*   return {
+*     name: adapterOasName,
+*     options: { validate, dateType, ... },
+*     parse(source) { ... },
+*   }
+* })
+* ```
+*/
+function defineAdapter(build) {
+	return (options) => build(options ?? {});
+}
 //#endregion
 //#region src/defineLogger.ts
 function defineLogger(logger) {
@@ -2029,6 +2155,6 @@ async function detectLinter() {
 	]) if (await isLinterAvailable(linter)) return linter;
 }
 //#endregion
-export { FunctionParams, PackageManager, PluginManager, PromiseManager, build, build as default, defineConfig, defineLogger, definePlugin, 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, detectFormatter, detectLinter, formatters, getBarrelFiles, getConfigs, getMode, isInputPath, linters, logLevel, safeBuild, setup };
 
 //# sourceMappingURL=index.js.map