archive-codec 1.0.2 → 1.1.1

package/dist/zip/walk.cjs

@@ -0,0 +1,41 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_zip_container = require("./container.cjs");
+const require_zip_detect = require("./detect.cjs");
+//#region src/zip/walk.ts
+const MAX_WALK_DEPTH = 8;
+const MAX_WALK_TOTAL_BYTES = 536870912;
+var ArchiveWalkLimitError = class extends Error {
+	limit;
+	constructor(limit, message) {
+		super(message);
+		this.name = "ArchiveWalkLimitError";
+		this.limit = limit;
+	}
+};
+function walkArchive(bytes, options = {}) {
+	const maxDepth = options.maxDepth ?? 8;
+	const maxTotalBytes = options.maxTotalBytes ?? 536870912;
+	if (!require_zip_detect.isZipArchive(bytes)) throw new Error("walkArchive input is not a ZIP archive (leading magic bytes are not PK\\x03\\x04 or PK\\x05\\x06)");
+	const entries = [];
+	let totalBytes = 0;
+	visit(bytes, []);
+	return entries;
+	function visit(archive, ancestors) {
+		if (ancestors.length + 1 > maxDepth) throw new ArchiveWalkLimitError("depth", `archive nesting exceeds the maximum walk depth of ${maxDepth} at ${ancestors.join(" > ")}`);
+		for (const [path, entryBytes] of Object.entries(require_zip_container.unzipPackage(archive))) {
+			totalBytes += entryBytes.length;
+			if (totalBytes > maxTotalBytes) throw new ArchiveWalkLimitError("total-bytes", `cumulative decompressed size of the walk exceeded the ${maxTotalBytes}-byte budget at ${path}`);
+			entries.push({
+				path,
+				ancestors,
+				bytes: entryBytes
+			});
+			if (require_zip_detect.isZipArchive(entryBytes)) visit(entryBytes, [...ancestors, path]);
+		}
+	}
+}
+//#endregion
+exports.ArchiveWalkLimitError = ArchiveWalkLimitError;
+exports.MAX_WALK_DEPTH = MAX_WALK_DEPTH;
+exports.MAX_WALK_TOTAL_BYTES = MAX_WALK_TOTAL_BYTES;
+exports.walkArchive = walkArchive;

package/dist/zip/walk.d.cts

@@ -0,0 +1,20 @@
+//#region src/zip/walk.d.ts
+declare const MAX_WALK_DEPTH = 8;
+declare const MAX_WALK_TOTAL_BYTES: number;
+interface ArchiveWalkEntry {
+  readonly path: string;
+  readonly ancestors: readonly string[];
+  readonly bytes: Uint8Array<ArrayBuffer>;
+}
+type ArchiveWalkLimit = 'depth' | 'total-bytes';
+declare class ArchiveWalkLimitError extends Error {
+  readonly limit: ArchiveWalkLimit;
+  constructor(limit: ArchiveWalkLimit, message: string);
+}
+interface WalkArchiveOptions {
+  readonly maxDepth?: number;
+  readonly maxTotalBytes?: number;
+}
+declare function walkArchive(bytes: Uint8Array<ArrayBuffer>, options?: WalkArchiveOptions): ArchiveWalkEntry[];
+//#endregion
+export { ArchiveWalkEntry, ArchiveWalkLimit, ArchiveWalkLimitError, MAX_WALK_DEPTH, MAX_WALK_TOTAL_BYTES, WalkArchiveOptions, walkArchive };

package/dist/zip/walk.d.ts

@@ -0,0 +1,20 @@
+//#region src/zip/walk.d.ts
+declare const MAX_WALK_DEPTH = 8;
+declare const MAX_WALK_TOTAL_BYTES: number;
+interface ArchiveWalkEntry {
+  readonly path: string;
+  readonly ancestors: readonly string[];
+  readonly bytes: Uint8Array<ArrayBuffer>;
+}
+type ArchiveWalkLimit = 'depth' | 'total-bytes';
+declare class ArchiveWalkLimitError extends Error {
+  readonly limit: ArchiveWalkLimit;
+  constructor(limit: ArchiveWalkLimit, message: string);
+}
+interface WalkArchiveOptions {
+  readonly maxDepth?: number;
+  readonly maxTotalBytes?: number;
+}
+declare function walkArchive(bytes: Uint8Array<ArrayBuffer>, options?: WalkArchiveOptions): ArchiveWalkEntry[];
+//#endregion
+export { ArchiveWalkEntry, ArchiveWalkLimit, ArchiveWalkLimitError, MAX_WALK_DEPTH, MAX_WALK_TOTAL_BYTES, WalkArchiveOptions, walkArchive };

package/dist/zip/walk.js

@@ -0,0 +1,37 @@
+import { unzipPackage } from "./container.js";
+import { isZipArchive } from "./detect.js";
+//#region src/zip/walk.ts
+const MAX_WALK_DEPTH = 8;
+const MAX_WALK_TOTAL_BYTES = 536870912;
+var ArchiveWalkLimitError = class extends Error {
+	limit;
+	constructor(limit, message) {
+		super(message);
+		this.name = "ArchiveWalkLimitError";
+		this.limit = limit;
+	}
+};
+function walkArchive(bytes, options = {}) {
+	const maxDepth = options.maxDepth ?? 8;
+	const maxTotalBytes = options.maxTotalBytes ?? 536870912;
+	if (!isZipArchive(bytes)) throw new Error("walkArchive input is not a ZIP archive (leading magic bytes are not PK\\x03\\x04 or PK\\x05\\x06)");
+	const entries = [];
+	let totalBytes = 0;
+	visit(bytes, []);
+	return entries;
+	function visit(archive, ancestors) {
+		if (ancestors.length + 1 > maxDepth) throw new ArchiveWalkLimitError("depth", `archive nesting exceeds the maximum walk depth of ${maxDepth} at ${ancestors.join(" > ")}`);
+		for (const [path, entryBytes] of Object.entries(unzipPackage(archive))) {
+			totalBytes += entryBytes.length;
+			if (totalBytes > maxTotalBytes) throw new ArchiveWalkLimitError("total-bytes", `cumulative decompressed size of the walk exceeded the ${maxTotalBytes}-byte budget at ${path}`);
+			entries.push({
+				path,
+				ancestors,
+				bytes: entryBytes
+			});
+			if (isZipArchive(entryBytes)) visit(entryBytes, [...ancestors, path]);
+		}
+	}
+}
+//#endregion
+export { ArchiveWalkLimitError, MAX_WALK_DEPTH, MAX_WALK_TOTAL_BYTES, walkArchive };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "archive-codec",
-  "version": "1.0.2",
-  "description": "Recursive archive (ZIP-in-ZIP) detection and walking with depth and cumulative decompressed-size guards - zero document-format knowledge, the archive utility package for the documents.js family.",
+  "version": "1.1.1",
+  "description": "ZIP-in-ZIP recursive walking with depth and cumulative decompressed-size guards, plus bounded classic OLE compound-file ([MS-CFB]) reading - zero document-format knowledge, the archive and container utility package for the documents.js family.",
   "type": "module",
   "repository": {
     "type": "git",
@@ -57,10 +57,12 @@
     "_typecheck": "tsc -p tsconfig.json && tsc -p tsconfig.node.json",
     "_typecheck:attw": "attw --pack",
     "test": "turbo run _test",
-    "_test": "vitest run",
-    "test:watch": "vitest",
+    "_test": "vitest run --project unit",
+    "test:watch": "vitest --project unit",
     "test:workers": "turbo run _test:workers",
     "_test:workers": "vitest run --config vitest.workers.config.ts",
+    "test:smoke": "turbo run _test:smoke",
+    "_test:smoke": "vitest run --project smoke",
     "prepare": "husky"
   },
   "packageManager": "pnpm@11.6.0",