@kubb/studio 5.6.1 → 5.6.2

package/dist/index.d.ts

@@ -220,28 +220,18 @@ type CreateSnapshotOptions = Omit<SnapshotUploadMetadata, 'hashes' | 'peerDepend
    */
   apiKey: string;
   /**
-   * The project's Kubb config. Like `kubb generate`, it writes to `output.path`, then runs the
-   * formatter, the linter, and `output.postGenerate`.
+   * The project's Kubb config, generated like `kubb generate`: formatter, linter, and `output.postGenerate` included.
    */
   config: Config;
   hooks?: Hookable<KubbHooks>;
   signal?: AbortSignal;
 };
 /**
- * Generates the project, packs it as an npm tarball, and publishes it to Studio in one
- * `POST /api/snapshots` request.
+ * Generates the project, packs it as an npm tarball, and publishes it to Studio in one `POST /api/snapshots` request.
  *
  * @example
  * ```ts
- * const snapshot = await createSnapshot({
- *   apiKey: process.env.KUBB_TOKEN!,
- *   config,
- *   id: 'gh:123:pr-4',
- *   name: 'acme/api#4',
- *   packageName: '@acme/api',
- *   version: '1.0.0',
- * })
- * console.log(snapshot.url, snapshot.changes)
+ * const { url } = await createSnapshot({ apiKey: process.env.KUBB_TOKEN!, config, id: 'gh:123:pr-4', name: 'acme/api#4', packageName: '@acme/api', version: '1.0.0' })
  * ```
  */
 export declare function createSnapshot({ studioUrl, apiKey, config, hooks, signal, ...metadata }: CreateSnapshotOptions): Promise<PublishedSnapshot>;

package/dist/index.js

@@ -4,7 +4,7 @@ import { createRequire } from "node:module";
 import { createHash, hash, randomUUID } from "node:crypto";
 import { mkdir, mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
 import { tmpdir } from "node:os";
-import path, { isAbsolute, join, relative, resolve, sep } from "node:path";
+import path, { dirname, isAbsolute, join, relative, resolve, sep } from "node:path";
 import process$1 from "node:process";
 import { setTimeout as setTimeout$1 } from "node:timers/promises";
 import { pathToFileURL } from "node:url";
@@ -192,7 +192,7 @@ function getElapsedMs(hrStart) {
 }
 //#endregion
 //#region package.json
-var version = "5.6.1";
+var version = "5.6.2";
 //#endregion
 //#region src/resolveConfig.ts
 /**
@@ -1034,19 +1034,21 @@ async function generate({ config, hooks, signal, allowExec }) {
 		lint: false,
 		postGenerate: []
 	};
-	const result = await createKubb({
+	const kubb = createKubb({
 		...config,
 		output
 	}, {
 		hooks,
 		signal
-	}).generate();
+	});
+	const result = await kubb.generate();
 	if (!result.success) throw generationFailure(result.diagnostics);
+	const { storage, root } = kubb.config;
 	return {
-		storage: config.storage,
-		root: config.root,
+		storage,
+		root,
 		paths: new Set(result.files.map((file) => relativeStoragePath({
-			root: config.root,
+			root,
 			filePath: file.path
 		})))
 	};
@@ -1991,29 +1993,24 @@ const gzipAsync = promisify(gzip);
 const UPLOAD_TIMEOUT_MS = 12e4;
 const BUNDLED_DEPENDENCIES = ["@kubb/plugin-barrel"];
 /**
-* Maps a generated file's path to its place inside the tarball, stripping everything before a
-* `src`/`dist` segment and any `..`/empty path segment so a crafted file name cannot escape the
-* `package/` root.
+* Maps a generated file to its path in the package, from its `src`/`dist` segment on, without `..` parts that could escape it.
 */
 function packagePath(filePath) {
 	const normalized = filePath.replaceAll("\\", "/");
-	return `package/${(normalized.match(/\/(?:src|dist)\/.*$/)?.[0].slice(1) ?? normalized.replace(/^\/+/, "")).split("/").filter((part) => part && part !== "." && part !== "..").join("/")}`;
+	return (normalized.match(/\/(?:src|dist)\/.*$/)?.[0] ?? normalized).split("/").filter((part) => part && part !== "." && part !== "..").join("/");
 }
 /**
-* Splits a tarball entry path into the legacy 100-byte `name` field and, when the path does not
-* fit, the 155-byte USTAR `prefix` field that extends it. Throws rather than silently truncating
-* a path the format cannot address (max 256 bytes: 100 name + 1 separator + 155 prefix).
+* Splits a tar path into the 100-byte USTAR `name` and the 155-byte `prefix`, and throws for a path that fits neither.
 */
 function splitEntryPath(path) {
-	if (Buffer.byteLength(path, "utf8") <= 100) return {
+	if (Buffer.byteLength(path) <= 100) return {
 		name: path,
 		prefix: ""
 	};
-	for (let i = path.length - 1; i >= 0; i--) {
-		if (path[i] !== "/") continue;
+	for (let i = path.lastIndexOf("/"); i > 0; i = path.lastIndexOf("/", i - 1)) {
 		const prefix = path.slice(0, i);
 		const name = path.slice(i + 1);
-		if (Buffer.byteLength(prefix, "utf8") <= 155 && Buffer.byteLength(name, "utf8") <= 100) return {
+		if (Buffer.byteLength(prefix) <= 155 && Buffer.byteLength(name) <= 100) return {
 			name,
 			prefix
 		};
@@ -2023,21 +2020,23 @@ function splitEntryPath(path) {
 function header(path, size) {
 	const { name, prefix } = splitEntryPath(path);
 	const value = Buffer.alloc(512);
-	value.write(name, 0, "utf8");
-	value.write("0000644\0", 100, "ascii");
-	value.write("0000000\0", 108, "ascii");
-	value.write("0000000\0", 116, "ascii");
-	value.write(`${size.toString(8).padStart(11, "0")}\0`, 124, "ascii");
-	value.write("03560116604\0", 136, "ascii");
+	value.write(name);
+	value.write("0000644\0", 100);
+	for (const offset of [
+		108,
+		116,
+		265,
+		297
+	]) value.write("0000000\0", offset);
+	value.write(`${size.toString(8).padStart(11, "0")}\0`, 124);
+	value.write("03560116604\0", 136);
 	value.fill(32, 148, 156);
-	value.write("0", 156, "ascii");
-	value.write("ustar\0", 257, "ascii");
-	value.write("00", 263, "ascii");
-	value.write("0000000\0", 265, "ascii");
-	value.write("0000000\0", 297, "ascii");
-	value.write(prefix, 345, "utf8");
-	const checksum = [...value].reduce((sum, byte) => sum + byte, 0);
-	value.write(`${checksum.toString(8).padStart(6, "0")}\0 `, 148, "ascii");
+	value.write("0", 156);
+	value.write("ustar\0", 257);
+	value.write("00", 263);
+	value.write(prefix, 345);
+	const checksum = value.reduce((sum, byte) => sum + byte, 0);
+	value.write(`${checksum.toString(8).padStart(6, "0")}\0 `, 148);
 	return value;
 }
 /**
@@ -2045,31 +2044,29 @@ function header(path, size) {
 * generated sources, a `tsdown`-built `dist/` (esm + cjs), and a `package.json` manifest.
 */
 async function createSnapshotPackage({ files, packageInfo }) {
+	const sources = /* @__PURE__ */ new Map();
+	for (const [name, content] of Object.entries(files)) {
+		const path = packagePath(name);
+		const owner = sources.get(path)?.name;
+		if (owner) throw new Error(`Snapshot has two generated files that sanitize to the same path "package/${path}": "${owner}" and "${name}"`);
+		sources.set(path, {
+			name,
+			content
+		});
+	}
 	const root = await mkdtemp(join(tmpdir(), "kubb-snapshot-"));
 	const dist = join(root, "dist");
-	const resolvedPaths = Object.entries(files).map(([name, content]) => ({
-		name,
-		content,
-		target: packagePath(name)
-	}));
-	const targetOwners = /* @__PURE__ */ new Map();
-	for (const { name, target } of resolvedPaths) {
-		const owner = targetOwners.get(target);
-		if (owner) throw new Error(`Snapshot has two generated files that sanitize to the same path "${target}": "${owner}" and "${name}"`);
-		targetOwners.set(target, name);
-	}
 	try {
 		await mkdir(dist);
-		await Promise.all(resolvedPaths.map(async ({ content, target }) => {
-			const path = join(root, target.slice(8));
-			await mkdir(join(path, ".."), { recursive: true });
-			await writeFile(path, content);
+		await Promise.all([...sources].map(async ([path, { content }]) => {
+			await mkdir(dirname(join(root, path)), { recursive: true });
+			await writeFile(join(root, path), content);
 		}));
-		const sourceEntries = resolvedPaths.filter(({ name }) => /\.(?:[cm]?[jt]sx?)$/.test(name)).map(({ target }) => join(root, target.slice(8)));
-		if (sourceEntries.length) {
+		const entry = [...sources.keys()].filter((path) => /\.(?:[cm]?[jt]sx?)$/.test(path)).map((path) => join(root, path));
+		if (entry.length) {
 			const { build } = await import("tsdown");
 			await build({
-				entry: sourceEntries,
+				entry,
 				outDir: dist,
 				format: ["esm", "cjs"],
 				dts: false,
@@ -2080,38 +2077,38 @@ async function createSnapshotPackage({ files, packageInfo }) {
 				fixedExtension: true
 			});
 		}
-		const builtEntries = await Promise.all((await fsStorage().readKeys(dist)).map(async (key) => [`package/dist/${key}`, await readFile(join(dist, key), "utf8")]));
-		const builtPaths = new Set(builtEntries.map(([path]) => path));
-		const hasBarrel = builtPaths.has("package/dist/index.mjs") && builtPaths.has("package/dist/index.cjs");
-		const barrelFields = hasBarrel ? {
-			main: "./dist/index.cjs",
-			module: "./dist/index.mjs"
-		} : {};
-		const barrelExport = hasBarrel ? { ".": {
-			import: "./dist/index.mjs",
-			require: "./dist/index.cjs"
-		} } : {};
-		const entries = {
-			"package/package.json": JSON.stringify({
-				...packageInfo,
-				type: "module",
-				...barrelFields,
-				exports: {
-					...barrelExport,
-					"./*": {
-						import: "./dist/*.mjs",
-						require: "./dist/*.cjs"
-					}
+		const built = await fsStorage().readKeys(dist);
+		const hasBarrel = built.includes("index.mjs") && built.includes("index.cjs");
+		const manifest = {
+			...packageInfo,
+			type: "module",
+			...hasBarrel ? {
+				main: "./dist/index.cjs",
+				module: "./dist/index.mjs"
+			} : {},
+			exports: {
+				...hasBarrel ? { ".": {
+					import: "./dist/index.mjs",
+					require: "./dist/index.cjs"
+				} } : {},
+				"./*": {
+					import: "./dist/*.mjs",
+					require: "./dist/*.cjs"
 				}
-			}, null, 2),
-			...Object.fromEntries(resolvedPaths.map(({ content, target }) => [target, content])),
-			...Object.fromEntries(builtEntries)
+			}
 		};
-		const chunks = [];
-		for (const [name, content] of Object.entries(entries)) {
+		const chunks = [...new Map([
+			["package.json", JSON.stringify(manifest, null, 2)],
+			...[...sources].map(([path, { content }]) => [path, content]),
+			...await Promise.all(built.map(async (key) => [`dist/${key}`, await readFile(join(dist, key), "utf8")]))
+		])].flatMap(([path, content]) => {
 			const bytes = Buffer.from(content);
-			chunks.push(header(name, bytes.length), bytes, Buffer.alloc((512 - bytes.length % 512) % 512));
-		}
+			return [
+				header(`package/${path}`, bytes.length),
+				bytes,
+				Buffer.alloc((512 - bytes.length % 512) % 512)
+			];
+		});
 		return await gzipAsync(Buffer.concat([...chunks, Buffer.alloc(1024)]));
 	} finally {
 		await rm(root, {
@@ -2120,25 +2117,12 @@ async function createSnapshotPackage({ files, packageInfo }) {
 		});
 	}
 }
-function failureMessage({ status, _data }) {
-	const upgrade = _data?.data?.upgradeUrl ? ` Upgrade at ${_data.data.upgradeUrl}.` : "";
-	return `Kubb Studio refused the snapshot (status ${status})${_data?.message ? `: ${_data.message}` : ""}.${upgrade}`;
-}
 /**
-* Generates the project, packs it as an npm tarball, and publishes it to Studio in one
-* `POST /api/snapshots` request.
+* Generates the project, packs it as an npm tarball, and publishes it to Studio in one `POST /api/snapshots` request.
 *
 * @example
 * ```ts
-* const snapshot = await createSnapshot({
-*   apiKey: process.env.KUBB_TOKEN!,
-*   config,
-*   id: 'gh:123:pr-4',
-*   name: 'acme/api#4',
-*   packageName: '@acme/api',
-*   version: '1.0.0',
-* })
-* console.log(snapshot.url, snapshot.changes)
+* const { url } = await createSnapshot({ apiKey: process.env.KUBB_TOKEN!, config, id: 'gh:123:pr-4', name: 'acme/api#4', packageName: '@acme/api', version: '1.0.0' })
 * ```
 */
 async function createSnapshot({ studioUrl = defaultStudioUrl, apiKey, config, hooks, signal, ...metadata }) {
@@ -2178,7 +2162,7 @@ async function createSnapshot({ studioUrl = defaultStudioUrl, apiKey, config, ho
 	}));
 	body.set("tarball", new Blob([new Uint8Array(bytes)], { type: "application/gzip" }), "snapshot.tgz");
 	const timeout = AbortSignal.timeout(UPLOAD_TIMEOUT_MS);
-	const response = await ofetch.raw(url.href, {
+	const { ok, status, _data } = await ofetch.raw(url.href, {
 		method: "POST",
 		headers: { "x-api-key": apiKey },
 		body,
@@ -2186,10 +2170,12 @@ async function createSnapshot({ studioUrl = defaultStudioUrl, apiKey, config, ho
 		signal: signal ? AbortSignal.any([signal, timeout]) : timeout,
 		ignoreResponseError: true
 	});
-	if (!response.ok) throw new Error(failureMessage(response));
-	const snapshot = response._data?.snapshot;
-	if (!snapshot) throw new Error(`Kubb Studio returned no snapshot (status ${response.status})`);
-	return snapshot;
+	if (!ok) {
+		const upgrade = _data?.data?.upgradeUrl ? ` Upgrade at ${_data.data.upgradeUrl}.` : "";
+		throw new Error(`Kubb Studio refused the snapshot (status ${status})${_data?.message ? `: ${_data.message}` : ""}.${upgrade}`);
+	}
+	if (!_data?.snapshot) throw new Error(`Kubb Studio returned no snapshot (status ${status})`);
+	return _data.snapshot;
 }
 //#endregion
 export { IncompatibleAgentError, InvalidAgentTokenError, PairingCanceledError, PairingDeniedError, PairingExpiredError, connectAgent, createSnapshot, defaultStudioUrl, pairAgent };