modern-tar 0.5.0 → 0.5.2

package/dist/fs/index.d.ts

@@ -50,43 +50,48 @@ interface UnpackOptionsFS extends UnpackOptions {
    */
   concurrency?: number;
 }
+/** Base interface containing common metadata properties for all source types. */
+interface BaseSource {
+  /** Destination path for the entry inside the tar archive. */
+  target: string;
+  /** Optional modification time. Overrides filesystem values or defaults to current time. */
+  mtime?: Date;
+  /** Optional user ID. Overrides filesystem values or defaults to 0. */
+  uid?: number;
+  /** Optional group ID. Overrides filesystem values or defaults to 0. */
+  gid?: number;
+  /** Optional user name. */
+  uname?: string;
+  /** Optional group name. */
+  gname?: string;
+  /** Optional Unix file permissions for the entry (e.g., 0o644, 0o755). */
+  mode?: number;
+}
 /** Describes a file on the local filesystem to be added to the archive. */
-interface FileSource {
+interface FileSource extends BaseSource {
   type: "file";
   /** Path to the source file on the local filesystem. */
   source: string;
-  /** Destination path for the file inside the tar archive. */
-  target: string;
 }
 /** Describes a directory on the local filesystem to be added to the archive. */
-interface DirectorySource {
+interface DirectorySource extends BaseSource {
   type: "directory";
   /** Path to the source directory on the local filesystem. */
   source: string;
-  /** Destination path for the directory inside the tar archive. */
-  target: string;
 }
 /** Describes raw, buffered content to be added to the archive. */
-interface ContentSource {
+interface ContentSource extends BaseSource {
   type: "content";
   /** Raw content to add. Supports string, Uint8Array, ArrayBuffer, Blob, or null. */
   content: TarEntryData;
-  /** Destination path for the content inside the tar archive. */
-  target: string;
-  /** Optional Unix file permissions for the entry (e.g., 0o644). */
-  mode?: number;
 }
 /** Describes a stream of content to be added to the archive. */
-interface StreamSource {
+interface StreamSource extends BaseSource {
   type: "stream";
   /** A Readable or ReadableStream. */
   content: Readable | ReadableStream;
-  /** Destination path for the content inside the tar archive. */
-  target: string;
   /** The total size of the stream's content in bytes. This is required for streams. */
   size: number;
-  /** Optional Unix file permissions for the entry (e.g., 0o644). */
-  mode?: number;
 }
 /** A union of all possible source types for creating a tar archive. */
 type TarSource = FileSource | DirectorySource | ContentSource | StreamSource;

package/dist/fs/index.js

@@ -28,7 +28,8 @@ function packTar(sources, options = {}) {
 		let activeWorkers = 0;
 		let allJobsQueued = false;
 		const writer = async () => {
-			const readBuffer = Buffer.alloc(64 * 1024);
+			const readBufferSmall = Buffer.alloc(64 * 1024);
+			let readBufferLarge = null;
 			while (true) {
 				if (stream.destroyed) return;
 				if (allJobsQueued && writeIndex >= jobs.length) break;
@@ -57,6 +58,7 @@ function packTar(sources, options = {}) {
 				}
 				else {
 					const { handle, size } = result.body;
+					const readBuffer = size > 1048576 ? readBufferLarge ??= Buffer.alloc(512 * 1024) : readBufferSmall;
 					try {
 						let bytesLeft = size;
 						while (bytesLeft > 0 && !stream.destroyed) {
@@ -99,8 +101,9 @@ function packTar(sources, options = {}) {
 				if (job.type === "content" || job.type === "stream") {
 					let body$1;
 					let size;
+					const isDir$1 = target.endsWith("/");
 					if (job.type === "stream") {
-						if (typeof job.size !== "number" || job.size <= 0) throw new Error("StreamSource requires a positive size property.");
+						if (typeof job.size !== "number" || !isDir$1 && job.size <= 0 || isDir$1 && job.size !== 0) throw new Error(isDir$1 ? "Streams for directories must have size 0." : "Streams require a positive size.");
 						size = job.size;
 						body$1 = job.content;
 					} else {
@@ -109,29 +112,31 @@ function packTar(sources, options = {}) {
 						body$1 = content;
 					}
 					const stat$1 = {
-						size,
-						isFile: () => true,
-						isDirectory: () => false,
+						size: isDir$1 ? 0 : size,
+						isFile: () => !isDir$1,
+						isDirectory: () => isDir$1,
 						isSymbolicLink: () => false,
-						mode: job.mode ?? 420,
-						mtime: /* @__PURE__ */ new Date(),
-						uid: process.getuid?.() ?? 0,
-						gid: process.getgid?.() ?? 0
+						mode: job.mode,
+						mtime: job.mtime ?? /* @__PURE__ */ new Date(),
+						uid: job.uid ?? 0,
+						gid: job.gid ?? 0
 					};
 					if (filter && !filter(target, stat$1)) return;
 					let header$1 = {
 						name: target,
-						type: "file",
-						size,
+						type: isDir$1 ? "directory" : "file",
+						size: isDir$1 ? 0 : size,
 						mode: stat$1.mode,
 						mtime: stat$1.mtime,
 						uid: stat$1.uid,
-						gid: stat$1.gid
+						gid: stat$1.gid,
+						uname: job.uname,
+						gname: job.gname
 					};
 					if (map) header$1 = map(header$1);
 					jobResult = {
 						header: header$1,
-						body: body$1
+						body: isDir$1 ? void 0 : body$1
 					};
 					return;
 				}
@@ -147,10 +152,12 @@ function packTar(sources, options = {}) {
 				let header = {
 					name: target,
 					size: 0,
-					mode: Number(stat.mode),
-					mtime: stat.mtime,
-					uid: Number(stat.uid),
-					gid: Number(stat.gid),
+					mode: job.mode ?? Number(stat.mode),
+					mtime: job.mtime ?? stat.mtime,
+					uid: job.uid ?? Number(stat.uid),
+					gid: job.gid ?? Number(stat.gid),
+					uname: job.uname,
+					gname: job.gname,
 					type: "file"
 				};
 				let body;
@@ -199,22 +206,46 @@ function packTar(sources, options = {}) {
 	return stream;
 }
 
+//#endregion
+//#region src/fs/win-path.ts
+const REPLACEMENTS = {
+	":": "",
+	"<": "",
+	">": "",
+	"|": "",
+	"?": "",
+	"*": "",
+	"\"": ""
+};
+function normalizeWindowsPath(p) {
+	if (!(process.platform === "win32")) return p;
+	const normalized = p.replace(/\\/g, "/");
+	if (/^[A-Za-z]:\.\./i.test(normalized)) throw new Error(`Entry ${p} points outside extraction directory.`);
+	return normalized.replace(/^[A-Za-z]:/, "").replace(/[<>:"|?*]/g, (char) => REPLACEMENTS[char]);
+}
+
 //#endregion
 //#region src/fs/path.ts
 const unicodeCache = /* @__PURE__ */ new Map();
-const MAX_CACHE_SIZE = 1e4;
 const normalizeUnicode = (s) => {
 	let result = unicodeCache.get(s);
 	if (result !== void 0) unicodeCache.delete(s);
 	result = result ?? s.normalize("NFD");
 	unicodeCache.set(s, result);
-	const overflow = unicodeCache.size - MAX_CACHE_SIZE;
-	if (overflow > MAX_CACHE_SIZE / 10) {
-		const keys = unicodeCache.keys();
-		for (let i = 0; i < overflow; i++) unicodeCache.delete(keys.next().value);
-	}
+	if (unicodeCache.size > 1e4) unicodeCache.delete(unicodeCache.keys().next().value);
 	return result;
 };
+function stripTrailingSlashes(p) {
+	let i = p.length - 1;
+	if (i === -1 || p[i] !== "/") return p;
+	let slashesStart = i;
+	while (i > -1 && p[i] === "/") {
+		slashesStart = i;
+		i--;
+	}
+	return p.slice(0, slashesStart);
+}
+const normalizeHeaderName = (s) => normalizeUnicode(normalizeWindowsPath(stripTrailingSlashes(s)));
 function validateBounds(targetPath, destDir, errorMessage) {
 	const target = normalizeUnicode(path.resolve(targetPath));
 	const dest = path.resolve(destDir);
@@ -309,9 +340,11 @@ function createFSHandler(directoryPath, options) {
 		let promise = pathPromises.get(dirPath);
 		if (promise) return promise;
 		promise = (async () => {
+			if (signal.aborted) throw signal.reason;
 			const destDir = await destDirPromise;
 			if (dirPath === destDir.symbolic) return "directory";
 			await ensureDirectoryExists(path.dirname(dirPath));
+			if (signal.aborted) throw signal.reason;
 			try {
 				await fs.mkdir(dirPath, { mode: dmode });
 				return "directory";
@@ -330,63 +363,6 @@ function createFSHandler(directoryPath, options) {
 		pathPromises.set(dirPath, promise);
 		return promise;
 	};
-	const processHeader = async (header, entryStream) => {
-		try {
-			const destDir = await destDirPromise;
-			const normalizedName = normalizeUnicode(header.name);
-			if (maxDepth !== Infinity && normalizedName.split("/").length > maxDepth) throw new Error("Tar exceeds max specified depth.");
-			if (path.isAbsolute(normalizedName)) throw new Error(`Absolute path found in "${header.name}".`);
-			const outPath = path.join(destDir.symbolic, normalizedName);
-			validateBounds(outPath, destDir.symbolic, `Entry "${header.name}" points outside the extraction directory.`);
-			const parentDir = path.dirname(outPath);
-			await ensureDirectoryExists(parentDir);
-			switch (header.type) {
-				case "directory":
-					await fs.mkdir(outPath, {
-						recursive: true,
-						mode: dmode ?? header.mode
-					});
-					break;
-				case "file": {
-					const fileStream = createWriteStream(outPath, {
-						mode: fmode ?? header.mode,
-						highWaterMark: header.size > 1048576 ? 524288 : void 0
-					});
-					await pipeline(entryStream, fileStream);
-					break;
-				}
-				case "symlink": {
-					const { linkname } = header;
-					if (!linkname) return header.type;
-					const target = path.resolve(parentDir, linkname);
-					validateBounds(target, destDir.symbolic, `Symlink "${linkname}" points outside the extraction directory.`);
-					await fs.symlink(linkname, outPath);
-					break;
-				}
-				case "link": {
-					const { linkname } = header;
-					if (!linkname) return header.type;
-					const normalizedLink = normalizeUnicode(linkname);
-					if (path.isAbsolute(normalizedLink)) throw new Error(`Hardlink "${linkname}" points outside the extraction directory.`);
-					const linkTarget = path.join(destDir.symbolic, normalizedLink);
-					validateBounds(linkTarget, destDir.symbolic, `Hardlink "${linkname}" points outside the extraction directory.`);
-					await ensureDirectoryExists(path.dirname(linkTarget));
-					const realTargetParent = await fs.realpath(path.dirname(linkTarget));
-					const realLinkTarget = path.join(realTargetParent, path.basename(linkTarget));
-					validateBounds(realLinkTarget, destDir.real, `Hardlink "${linkname}" points outside the extraction directory.`);
-					const targetPromise = pathPromises.get(linkTarget);
-					if (targetPromise) await targetPromise;
-					await fs.link(linkTarget, outPath);
-					break;
-				}
-				default: return header.type;
-			}
-			if (header.mtime) await (header.type === "symlink" ? fs.lutimes : fs.utimes)(outPath, header.mtime, header.mtime).catch(() => {});
-			return header.type;
-		} finally {
-			if (!entryStream.readableEnded) entryStream.resume();
-		}
-	};
 	return {
 		handler: {
 			onHeader(header) {
@@ -403,21 +379,73 @@ function createFSHandler(directoryPath, options) {
 							processQueue();
 							return;
 						}
-						const destDir = path.resolve(directoryPath);
-						const keyPath = path.join(destDir, normalizeUnicode(transformed.name));
-						const normalizedTarget = keyPath.endsWith("/") || keyPath.endsWith("\\") ? keyPath.slice(0, -1) : keyPath;
-						opPromise = (pathPromises.get(normalizedTarget) || Promise.resolve(void 0)).then(async (priorOp) => {
+						const name = normalizeHeaderName(transformed.name);
+						const target = path.join(path.resolve(directoryPath), name);
+						opPromise = (pathPromises.get(target) || Promise.resolve(void 0)).then(async (priorOp) => {
 							if (signal.aborted) throw signal.reason;
 							if (priorOp) {
-								if (priorOp === "directory" && transformed.type !== "directory" || priorOp !== "directory" && transformed.type === "directory") throw new Error(`Path conflict: cannot create ${transformed.type} over existing ${priorOp} at "${transformed.name}"`);
+								if (priorOp === "directory" && transformed.type !== "directory" || priorOp !== "directory" && transformed.type === "directory") throw new Error(`Path conflict ${transformed.type} over existing ${priorOp} at "${transformed.name}"`);
+							}
+							try {
+								const destDir = await destDirPromise;
+								if (maxDepth !== Infinity && name.split("/").length > maxDepth) throw new Error("Tar exceeds max specified depth.");
+								if (path.isAbsolute(name)) throw new Error(`Absolute path found in "${transformed.name}".`);
+								const outPath = path.join(destDir.symbolic, name);
+								validateBounds(outPath, destDir.symbolic, `Entry "${transformed.name}" points outside the extraction directory.`);
+								const parentDir = path.dirname(outPath);
+								await ensureDirectoryExists(parentDir);
+								switch (transformed.type) {
+									case "directory":
+										await fs.mkdir(outPath, {
+											recursive: true,
+											mode: dmode ?? transformed.mode
+										});
+										break;
+									case "file": {
+										const fileStream = createWriteStream(outPath, {
+											mode: fmode ?? transformed.mode,
+											highWaterMark: transformed.size > 1048576 ? 524288 : void 0
+										});
+										await pipeline(entryStream, fileStream);
+										break;
+									}
+									case "symlink": {
+										const { linkname } = transformed;
+										if (!linkname) return transformed.type;
+										const target$1 = path.resolve(parentDir, linkname);
+										validateBounds(target$1, destDir.symbolic, `Symlink "${linkname}" points outside the extraction directory.`);
+										await fs.symlink(linkname, outPath);
+										break;
+									}
+									case "link": {
+										const { linkname } = transformed;
+										if (!linkname) return transformed.type;
+										const normalizedLink = normalizeUnicode(linkname);
+										if (path.isAbsolute(normalizedLink)) throw new Error(`Hardlink "${linkname}" points outside the extraction directory.`);
+										const linkTarget = path.join(destDir.symbolic, normalizedLink);
+										validateBounds(linkTarget, destDir.symbolic, `Hardlink "${linkname}" points outside the extraction directory.`);
+										await ensureDirectoryExists(path.dirname(linkTarget));
+										const realTargetParent = await fs.realpath(path.dirname(linkTarget));
+										const realLinkTarget = path.join(realTargetParent, path.basename(linkTarget));
+										validateBounds(realLinkTarget, destDir.real, `Hardlink "${linkname}" points outside the extraction directory.`);
+										if (linkTarget === outPath) return transformed.type;
+										const targetPromise = pathPromises.get(linkTarget);
+										if (targetPromise) await targetPromise;
+										await fs.link(linkTarget, outPath);
+										break;
+									}
+									default: return transformed.type;
+								}
+								if (transformed.mtime) await (transformed.type === "symlink" ? fs.lutimes : fs.utimes)(outPath, transformed.mtime, transformed.mtime).catch(() => {});
+								return transformed.type;
+							} finally {
+								if (!entryStream.readableEnded) entryStream.resume();
 							}
-							return await processHeader(transformed, entryStream);
 						});
-						pathPromises.set(normalizedTarget, opPromise);
+						pathPromises.set(target, opPromise);
 					} catch (err) {
 						opPromise = Promise.reject(err);
 						abortController.abort(err);
-						entryStream?.destroy(err);
 					}
 					opPromise.catch((err) => abortController.abort(err)).finally(() => {
 						activeOps--;
@@ -436,7 +464,6 @@ function createFSHandler(directoryPath, options) {
 			},
 			onError(error) {
 				abortController.abort(error);
-				activeEntryStream?.destroy(error);
 			},
 			async process() {
 				processingEnded = true;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "modern-tar",
-	"version": "0.5.0",
+	"version": "0.5.2",
 	"description": "Zero dependency streaming tar parser and writer for JavaScript.",
 	"author": "Ayuhito <hello@ayuhito.com>",
 	"license": "MIT",