single-file-core 1.6.1 → 1.6.3

package/test/sfz-harness/relocation-cost.js

@@ -1,94 +0,0 @@
-// §5.2 of doc/singlefile-archive.md quantifies what relocating the extra-data element costs. The
-// figures it carried until 2026-09-12 came from two live captures and one fixture, and two of the
-// three did not reconstruct: the paragraph subtracted the 17 bytes of terminator and end tags from
-// the reservation without subtracting the element, which the appended placement also carries, so
-// it over-counted by the whole element. This pins the corrected arithmetic. The cost is the
-// reservation margin alone, it is positive on every rung whenever an element exists, and the only
-// way to make relocation save bytes is to have no element to relocate.
-import { makePageData, makeOptions, runProcess, freezeDate } from "./common.js";
-
-const DECODER = new TextDecoder("windows-1252");
-const OPEN_TAG = "<sfz-extra-data>";
-const CLOSE_TAG = "</sfz-extra-data>";
-const END_TAGS_LENGTH = "</body></html>".length;
-
-let failed = false;
-
-function check(label, actual, expected) {
-	const ok = actual === expected;
-	console.log(`${ok ? "PASS" : "FAIL"} ${label}: ${actual}${ok ? "" : " (expected " + expected + ")"}`);
-	failed ||= !ok;
-}
-
-function reservationSize(length) {
-	return Math.ceil(length * 1.01) + 32;
-}
-
-function inspect(bytes) {
-	const text = DECODER.decode(bytes);
-	const open = text.indexOf(OPEN_TAG);
-	const firstHeader = text.indexOf("PK\x03\x04");
-	return {
-		total: bytes.length,
-		element: open == -1 ? 0 : text.indexOf(CLOSE_TAG, open) + CLOSE_TAG.length - open,
-		relocated: open != -1 && open < firstHeader
-	};
-}
-
-async function build(seed, targetLength, overrides) {
-	const restoreDate = freezeDate();
-	const appended = inspect((await runProcess(makePageData(seed, targetLength), makeOptions(overrides))).bytes);
-	const relocated = inspect((await runProcess(makePageData(seed, targetLength), makeOptions({ ...overrides, preventAppendedData: true }))).bytes);
-	restoreDate();
-	return { appended, relocated, cost: relocated.total - appended.total };
-}
-
-// the element changes length between the two passes once the reservation is large enough to move
-// the central-directory offsets it encodes, and then the reservation comes from the first pass
-// while the element written into it comes from the second. These fixtures stay below that, which
-// is what lets the identity be asserted exactly rather than within a tolerance.
-for (const [label, seed, targetLength, closeTagLength] of [
-	["comment rung", 1, 64 * 1024, "-->".length],
-	["comment rung, larger", 2, 147 * 1024, "-->".length]
-]) {
-	const { appended, relocated, cost } = await build(seed, targetLength, {});
-	check(`${label}: the element keeps its length`, relocated.element, appended.element);
-	check(`${label}: relocates`, relocated.relocated, true);
-	check(`${label}: cost`, cost,
-		reservationSize(appended.element) - appended.element - closeTagLength - END_TAGS_LENGTH);
-	check(`${label}: cost is positive`, cost > 0, true);
-}
-
-// the rung sets the constant, because it is the closing tag the relocated placement stops emitting
-for (const [label, closeTag] of [
-	["script rung", "</script>"],
-	["svg CDATA rung", "]]></svg>"],
-	["plaintext rung", "</plaintext>"]
-]) {
-	const startTag = { "</script>": "<script type=sfz-data>", "]]></svg>": "<svg><![CDATA[", "</plaintext>": "<plaintext>" }[closeTag];
-	const { appended, cost } = await build(3, 64 * 1024, { extractDataFromPageTags: [startTag, closeTag] });
-	check(`${label}: cost`, cost,
-		reservationSize(appended.element) - appended.element - closeTag.length - END_TAGS_LENGTH);
-	check(`${label}: cost is positive`, cost > 0, true);
-}
-
-// with no element there is nothing to reserve, so the appended run is dropped and nothing replaces
-// it. This is the only case in which suppressing the run makes the file smaller.
-{
-	const { appended, cost } = await build(4, 64 * 1024, { extractDataFromPage: false });
-	check("extraction disabled: no element", appended.element, 0);
-	check("extraction disabled: cost", cost, -("-->".length + END_TAGS_LENGTH));
-}
-
-// the budget triggers relocation once the element no longer fits beside the terminator and the end
-// tags, so the boundary is exactly maxAppendedDataLength - 3 - 14
-{
-	const { appended } = await build(5, 64 * 1024, {});
-	const fits = appended.element + "-->".length + END_TAGS_LENGTH;
-	const atBoundary = await build(5, 64 * 1024, { maxAppendedDataLength: fits });
-	const belowBoundary = await build(5, 64 * 1024, { maxAppendedDataLength: fits - 1 });
-	check("an element that exactly fits the budget stays appended", atBoundary.appended.relocated, false);
-	check("one byte less of budget relocates it", belowBoundary.appended.relocated, true);
-}
-
-Deno.exit(failed ? 1 : 0);

package/test/sfz-harness/search-triggers.js

@@ -1,35 +0,0 @@
-import { makePageData, makeOptions, runProcess, freezeDate } from "./common.js";
-
-const startSeed = Number(Deno.args[0] ?? 1);
-const seedCount = Number(Deno.args[1] ?? 100);
-const contentLength = Number(Deno.args[2] ?? 2 * 1024 * 1024);
-
-const found = [];
-const restoreDate = freezeDate();
-const startTime = performance.now();
-try {
-	for (let seed = startSeed; seed < startSeed + seedCount; seed++) {
-		const options = makeOptions();
-		const result = await runProcess(makePageData(seed, contentLength), options);
-		if (result.fallbackTag || result.extractionDisabled) {
-			found.push({ seed, fallbackTag: result.fallbackTag, pageSize: result.bytes.length });
-			console.log(`seed ${seed}: TRIGGER, fell back to ${result.fallbackTag}`);
-		}
-	}
-} finally {
-	restoreDate();
-}
-const seconds = (performance.now() - startTime) / 1000;
-console.log(`${found.length} trigger(s) in ${seedCount} attempts (content ${contentLength} bytes, ${seconds.toFixed(1)}s)`);
-if (found.length) {
-	const path = new URL("trigger-seeds.json", import.meta.url).pathname;
-	let existing = { contentLength, seeds: [] };
-	try {
-		existing = JSON.parse(Deno.readTextFileSync(path));
-	} catch {
-		// first run
-	}
-	const seeds = [...existing.seeds, ...found.filter(entry => !existing.seeds.some(known => known.seed == entry.seed))];
-	Deno.writeTextFileSync(path, JSON.stringify({ contentLength, seeds }, null, "\t") + "\n");
-	console.log(`saved to trigger-seeds.json (${seeds.length} total)`);
-}

package/test/sfz-harness/smoke.js

@@ -1,10 +0,0 @@
-import { makePageData, makeOptions, runProcess } from "./common.js";
-
-const options = makeOptions();
-const pageData = makePageData(1, 256 * 1024);
-const result = await runProcess(pageData, options);
-console.log("page size:", result.bytes.length);
-console.log("fallback tag:", result.fallbackTag);
-console.log("extraction disabled:", result.extractionDisabled);
-const head = new TextDecoder().decode(result.bytes.subarray(0, 200));
-console.log("head:", JSON.stringify(head));

package/test/sfz-harness/stored-trigger.js

@@ -1,95 +0,0 @@
-import { makePageData, makeOptions, runProcess, mulberry32 } from "./common.js";
-
-function storedResource(name, literals) {
-	const rand = mulberry32(0xbeef);
-	const bytes = new Uint8Array(Math.max(4096, 256 + literals.length * 512)).map(() => (rand() * 256) | 0);
-	const encoder = new TextEncoder();
-	let offset = 256;
-	for (const literal of literals) {
-		bytes.set(encoder.encode(literal), offset);
-		offset += 512;
-	}
-	return { name, extension: ".jpg", content: bytes };
-}
-
-let failed = false;
-
-function check(label, actual, expected) {
-	const ok = actual === expected;
-	console.log(`${ok ? "PASS" : "FAIL"} ${label}: ${actual}${ok ? "" : " (expected " + expected + ")"}`);
-	failed ||= !ok;
-}
-
-{
-	const options = makeOptions();
-	const pageData = makePageData(1, 64 * 1024);
-	pageData.resources.images.push(storedResource("photo.jpg", ["-->"]));
-	const result = await runProcess(pageData, options);
-	check("stored '-->' falls back to", result.fallbackTag, "<script type=sfz-data>");
-	check("stored '-->' keeps extraction", result.extractionDisabled, false);
-}
-
-{
-	const options = makeOptions();
-	const pageData = makePageData(2, 64 * 1024);
-	pageData.resources.images.push(storedResource("photo.jpg",
-		["-->", "</script>", "</style>", "</noframes>", "</noembed>", "</iframe>", "</xmp>", "]]>"]));
-	const result = await runProcess(pageData, options);
-	check("all closers exhaust to", result.fallbackTag, "<plaintext>");
-	check("all closers keep extraction", result.extractionDisabled, false);
-}
-
-{
-	const options = makeOptions();
-	const pageData = makePageData(3, 64 * 1024);
-	pageData.resources.images.push(storedResource("photo.jpg", ["</xmp>"]));
-	const result = await runProcess(pageData, options);
-	check("stored '</xmp>' alone stays on comment path", result.fallbackTag, null);
-}
-
-// the rung patterns are matched over the archive BYTES rather than a decoded string, so these
-// four pin the parts of that match a byte scan is easy to get wrong: closers are matched
-// case-insensitively, a closer only counts when a tag-name terminator follows it, and the
-// comment closer is '-->' or '--!>' and nothing else in between
-
-{
-	const options = makeOptions();
-	const pageData = makePageData(4, 64 * 1024);
-	pageData.resources.images.push(storedResource("photo.jpg", ["-->", "</SCRIPT>"]));
-	const result = await runProcess(pageData, options);
-	check("an upper-case closer counts, so '</SCRIPT>' escalates to", result.fallbackTag, "<style type=sfz-data>");
-}
-
-{
-	const options = makeOptions();
-	const pageData = makePageData(5, 64 * 1024);
-	pageData.resources.images.push(storedResource("photo.jpg", ["-->", "</script\tsrc"]));
-	const result = await runProcess(pageData, options);
-	check("a tab terminates a closer, so '</script\\t' escalates to", result.fallbackTag, "<style type=sfz-data>");
-}
-
-{
-	const options = makeOptions();
-	const pageData = makePageData(6, 64 * 1024);
-	pageData.resources.images.push(storedResource("photo.jpg", ["-->", "</scriptx"]));
-	const result = await runProcess(pageData, options);
-	check("'</scriptx' is not a closer, so it stops at", result.fallbackTag, "<script type=sfz-data>");
-}
-
-{
-	const options = makeOptions();
-	const pageData = makePageData(7, 64 * 1024);
-	pageData.resources.images.push(storedResource("photo.jpg", ["--!>"]));
-	const result = await runProcess(pageData, options);
-	check("'--!>' closes a comment, so it falls back to", result.fallbackTag, "<script type=sfz-data>");
-}
-
-{
-	const options = makeOptions();
-	const pageData = makePageData(8, 64 * 1024);
-	pageData.resources.images.push(storedResource("photo.jpg", ["--?>"]));
-	const result = await runProcess(pageData, options);
-	check("'--?>' does not close a comment", result.fallbackTag, null);
-}
-
-Deno.exit(failed ? 1 : 0);

package/test/sfz-harness/trigger-seeds.json

@@ -1,120 +0,0 @@
-{
-	"contentLength": 2097152,
-	"seeds": [
-		{
-			"seed": 68,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 723106
-		},
-		{
-			"seed": 154,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 724555
-		},
-		{
-			"seed": 176,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 724734
-		},
-		{
-			"seed": 184,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 724449
-		},
-		{
-			"seed": 212,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 723683
-		},
-		{
-			"seed": 223,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 724277
-		},
-		{
-			"seed": 224,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 724265
-		},
-		{
-			"seed": 232,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 723856
-		},
-		{
-			"seed": 256,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 722938
-		},
-		{
-			"seed": 282,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 724570
-		},
-		{
-			"seed": 288,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 725625
-		},
-		{
-			"seed": 343,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 724582
-		},
-		{
-			"seed": 351,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 724787
-		},
-		{
-			"seed": 372,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 723867
-		},
-		{
-			"seed": 379,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 725136
-		},
-		{
-			"seed": 383,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 725078
-		},
-		{
-			"seed": 404,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 723429
-		},
-		{
-			"seed": 426,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 724508
-		},
-		{
-			"seed": 441,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 724645
-		},
-		{
-			"seed": 445,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 724563
-		},
-		{
-			"seed": 475,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 723429
-		},
-		{
-			"seed": 495,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 723247
-		},
-		{
-			"seed": 500,
-			"fallbackTag": "<script type=sfz-data>",
-			"pageSize": 724039
-		}
-	]
-}

package/test/sfz-harness/zip64.js

@@ -1,77 +0,0 @@
-// §5.7 states that the page.pdf central-record injection applies its accounting to the zip64
-// end of central directory record when one is present, and claimed the combination "has been
-// verified on a forced-zip64 build". No such build existed here: the writer has no zip64 lever
-// and §8.3 described the specimen only in prose, so nothing checked the branch. It runs only past
-// 4 GiB or 65535 entries, which a saved page never reaches, so a defect in it would be invisible.
-//
-// zipWriter.options is a live reference to the object the ZipWriter was constructed with, so the
-// writeEntries callback can force zip64 on without any production change.
-import "./dom-stub.js";
-import { createArchive } from "../../processors/compression/compression.js";
-import { TextReader, ZipReader, BlobReader } from "../../vendor/zip/zip.js";
-import { FIXED_DATE, blobBytes } from "./common.js";
-
-const ZIP64_EOCD_SIGNATURE = 0x06064b50;
-const ZIP64_LOCATOR_SIGNATURE = 0x07064b50;
-const EOCD_SIGNATURE = 0x06054b50;
-
-let failed = false;
-
-function check(label, actual, expected) {
-	const ok = actual === expected;
-	console.log(`${ok ? "PASS" : "FAIL"} ${label}: ${actual}${ok ? "" : " (expected " + expected + ")"}`);
-	failed ||= !ok;
-}
-
-const PDF = new TextEncoder().encode("%PDF-1.4\n1 0 obj\n<< /X (zip64) >>\nendobj\ntrailer\n<<>>\n%%EOF\n");
-const pageData = { doctype: "<!DOCTYPE html>", content: "<html><body>zip64</body></html>", title: "zip64" };
-const archiveOptions = { url: "https://example.com/", selfExtractingArchive: true, embeddedPdf: PDF };
-
-const blob = await createArchive(pageData, archiveOptions, "/* zip script stub */", async zipWriter => {
-	zipWriter.options.zip64 = true;
-	await zipWriter.add("index.html", new TextReader("<html><body>zip64</body></html>"));
-	await zipWriter.add("manifest.json", new TextReader("{}"));
-}, FIXED_DATE);
-const bytes = await blobBytes(blob);
-const view = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);
-
-// locate the three records from the end, the way a reader does
-let eocd = -1;
-for (let index = bytes.length - 22; index >= 0 && eocd == -1; index--) {
-	if (view.getUint32(index, true) == EOCD_SIGNATURE) {
-		eocd = index;
-	}
-}
-check("the archive ends with an EOCD record", eocd != -1, true);
-const locator = eocd - 20;
-check("a zip64 locator precedes the EOCD", view.getUint32(locator, true), ZIP64_LOCATOR_SIGNATURE);
-const zip64 = Number(view.getBigUint64(locator + 8, true));
-check("the locator points at the zip64 record", view.getUint32(zip64, true), ZIP64_EOCD_SIGNATURE);
-
-// §5.7: the EOCD's saturated fields stay at their sentinels, and the writer saturates all of
-// them once zip64 is emitted rather than only the one that overflowed
-check("the EOCD entry count is a sentinel", view.getUint16(eocd + 8, true), 0xFFFF);
-check("the EOCD total count is a sentinel", view.getUint16(eocd + 10, true), 0xFFFF);
-check("the EOCD directory size is a sentinel", view.getUint32(eocd + 12, true), 0xFFFFFFFF);
-check("the EOCD directory offset is a sentinel", view.getUint32(eocd + 16, true), 0xFFFFFFFF);
-
-// the injection's accounting lands in the zip64 record: three entries, not the writer's two
-check("the zip64 record counts the injected record on this disk", Number(view.getBigUint64(zip64 + 24, true)), 3);
-check("the zip64 record counts it in the total", Number(view.getBigUint64(zip64 + 32, true)), 3);
-
-// the directory begins at the injected record, which sits ahead of the writer's own directory
-const directoryOffset = Number(view.getBigUint64(zip64 + 48, true));
-const directorySize = Number(view.getBigUint64(zip64 + 40, true));
-check("the zip64 directory offset points at the injected record",
-	view.getUint32(directoryOffset, true), 0x02014b50);
-check("the first record in the directory is page.pdf",
-	new TextDecoder().decode(bytes.subarray(directoryOffset + 46, directoryOffset + 54)), "page.pdf");
-check("the directory size covers every record", directoryOffset + directorySize, zip64);
-
-// and the result is still an archive every reader can read
-const reader = new ZipReader(new BlobReader(new Blob([bytes])));
-const entries = await reader.getEntries();
-await reader.close();
-check("a reader lists all three entries", entries.map(entry => entry.filename).join(","), "page.pdf,index.html,manifest.json");
-
-Deno.exit(failed ? 1 : 0);

package/zip-build/README.md

@@ -1,56 +0,0 @@
-# Rebuilding `vendor/zip`
-
-The three files in [`../vendor/zip`](../vendor/zip) are custom builds of
-[@zip.js/zip.js](https://www.npmjs.com/package/@zip.js/zip.js) with
-[fflate](https://www.npmjs.com/package/fflate) as `DecompressionStream`
-fallback:
-
-- `zip.min.js` — extraction bundle used by self-extracting pages
-  (`ZipReader`, `HttpRangeReader`, blob/text/data-URI readers and writers,
-  no web workers, fflate fallback for browsers without
-  `DecompressionStream`)
-- `zip.js` — creation bundle used when saving pages (full zip-core plus
-  `deflateRaw`/`inflateRaw`)
-- `z-worker.js` — web worker script for the creation bundle
-
-This directory rebuilds them byte-for-byte from their sources. All
-dependencies are pinned to exact versions by `package.json` and
-`package-lock.json`, and the build embeds no timestamps, so the output is
-reproducible on any platform with a recent Node.js version:
-
-```sh
-cd zip-build
-npm ci
-npm run build
-git diff --exit-code ../vendor/zip
-```
-
-An empty diff means the checked-in files match the sources exactly. The
-GitHub Actions workflow `.github/workflows/vendor.yml` runs the same steps
-on every push.
-
-## Files
-
-- `lib/zip.js`, `lib/zip-vendor.js`, `lib/zip-vendor-worker.js` — bundle
-  entry points; they import the zip.js sources from the pinned npm package
-- `lib/fflate.js` — vendored [fflate](https://github.com/101arrowz/fflate)
-  0.8.3 (MIT)
-- `lib/fflate-streams.js` — `CompressionStream`/`DecompressionStream`
-  adapter over fflate
-- `reserved-property-names.json` — property names protected from terser
-  property mangling; generated by `reserved-property-names.js` in the
-  [zip.js repository](https://github.com/gildas-lormeau/zip.js) at the
-  pinned version (the script is not part of the npm package)
-
-## Updating zip.js
-
-1. Bump `@zip.js/zip.js` in `package.json` and run `npm install`.
-2. Regenerate `reserved-property-names.json` from a checkout of the zip.js
-   repository at the matching tag, with its dev dependencies installed:
-
-   ```sh
-   node --input-type=module -e "import { getReservedPropertyNames } from './reserved-property-names.js'; console.log(JSON.stringify([...getReservedPropertyNames()], null, '\t'))" > path/to/single-file-core/zip-build/reserved-property-names.json
-   ```
-
-3. Run `npm run build` and commit the regenerated files in `../vendor/zip`
-   together with the changes in this directory.

package/zip-build/lib/fflate-streams.js

@@ -1,47 +0,0 @@
-/* global TransformStream */
-
-import { Deflate, Inflate } from "./fflate.js";
-
-const FORMAT_DEFLATE_RAW = "deflate-raw";
-
-class FflateStream extends TransformStream {
-	constructor(codec) {
-		super({
-			start(controller) {
-				codec.ondata = chunk => {
-					if (chunk.length) {
-						controller.enqueue(chunk);
-					}
-				};
-			},
-			transform(chunk) {
-				codec.push(chunk);
-			},
-			flush() {
-				codec.push(new Uint8Array(0), true);
-			}
-		});
-	}
-}
-
-class CompressionStreamFallback extends FflateStream {
-	constructor(format, { level } = {}) {
-		checkFormat(format);
-		super(new Deflate(level === undefined ? {} : { level }));
-	}
-}
-
-class DecompressionStreamFallback extends FflateStream {
-	constructor(format) {
-		checkFormat(format);
-		super(new Inflate());
-	}
-}
-
-function checkFormat(format) {
-	if (format != FORMAT_DEFLATE_RAW) {
-		throw new TypeError("Unsupported compression format: " + format);
-	}
-}
-
-export { CompressionStreamFallback, DecompressionStreamFallback };