@embedpdf/core-acrojs 3.0.0-next.13 → 3.0.0-next.15

package/dist/index.js

@@ -1,7 +1,8 @@
 //#region src/actions.ts
 /**
 * Return executable JavaScript in PDF action order (root, then `/Next`
-* depth-first). A poisoned native snapshot is never partially executed.
+* depth-first). A poisoned native snapshot is never partially executed. Any
+* kind of destination will do: only the scripts are read.
 */
 function javaScriptSourcesFromActionTree(tree) {
 	if (tree.incomplete) throw new Error("Refusing to execute an incomplete PDF action tree");
@@ -22,7 +23,7 @@ function javaScriptProgramFromActionTree(tree) {
 /**
 * Host-side Acrobat color-array conversions — the commit sinks and world
 * builders cross the Acrobat-array ↔ renderer-color boundary through these.
-* The PRELUDE inlines its own identical formulas (it must stay
+* The prelude inlines its own identical formulas (it must stay
 * self-contained); `prelude.test.ts` pins the two implementations together.
 *
 * Conversion vectors (the documented Acrobat semantics):
@@ -46,11 +47,11 @@ function scriptColorToRgb(color) {
 			b: color[3]
 		};
 		case "CMYK": {
-			const [, c, m, y, k] = color;
+			const [, cyan, magenta, yellow, black] = color;
 			return {
-				r: 1 - Math.min(1, c + k),
-				g: 1 - Math.min(1, m + k),
-				b: 1 - Math.min(1, y + k)
+				r: 1 - Math.min(1, cyan + black),
+				g: 1 - Math.min(1, magenta + black),
+				b: 1 - Math.min(1, yellow + black)
 			};
 		}
 	}
@@ -91,10 +92,10 @@ function isScriptColorArray(value) {
 //#endregion
 //#region src/types.ts
 /**
-* The writable-property validity matrix, keyed by engine subtype — the ONE
+* The writable-property validity matrix, keyed by engine subtype — the one
 * exported table (the prelude inlines an identical copy; a parity test pins
 * them together, and plugin-annotation drift-guards this against the kind
-* registry's PropSpecs). Flags + contents are writable everywhere
+* registry's FieldSpecs). Flags + contents are writable everywhere
 * script-addressable; appearance keys vary by kind.
 */
 const ANNOT_WRITABLE_KEYS = Object.freeze({
@@ -218,16 +219,16 @@ function seedFrom(documentId, sequence) {
 	}
 	return hash >>> 0;
 }
-/** Engine JWT/session identity composed under embedder overrides — the
-*  standard `ScriptHostOptions.identity` builder. */
+/** The session's identity, as Acrobat JavaScript's `identity` object, under
+*  embedder overrides — the standard `ScriptHostOptions.identity` builder. */
 function resolveScriptIdentity(doc, overrides) {
-	const claims = doc.security.identity;
+	const identity = doc.security.identity;
 	const supplied = typeof overrides === "function" ? overrides() : overrides ?? {};
 	return {
-		name: supplied.name ?? claims?.display_name ?? claims?.user_id ?? "",
-		loginName: supplied.loginName ?? claims?.user_id ?? "",
-		corporation: supplied.corporation ?? claims?.group_id ?? "",
-		email: supplied.email ?? ""
+		name: supplied.name ?? identity?.displayName ?? identity?.userId ?? "",
+		loginName: supplied.loginName ?? identity?.userId ?? "",
+		corporation: supplied.corporation ?? identity?.organization ?? "",
+		email: supplied.email ?? identity?.email ?? ""
 	};
 }
 function createScriptHost(options) {
@@ -261,7 +262,7 @@ function createScriptHost(options) {
 		...world.annotsCoverDocument !== void 0 ? { annotsCoverDocument: world.annotsCoverDocument } : {},
 		event: world.event
 	});
-	/** A resource fault poisons the realm: rebuild + re-boot lazily NEXT time. */
+	/** A resource fault poisons the realm: rebuild + re-boot lazily next time. */
 	const noteFault = (sandbox) => {
 		if (!sandbox.disposed) return;
 		sandboxPromise = null;
@@ -345,25 +346,42 @@ function valueFromEntry(entry) {
 		case "unsupported": return null;
 	}
 }
-function fieldValueFromEntry(family, entry) {
-	if ((family === "checkbox" || family === "radio") && entry.kind === "none") return "Off";
-	return valueFromEntry(entry);
+/**
+* A field value as scripts see it. A checkbox or radio group shows the export
+* value of its checked widget, as Acrobat's `field.value` does, or `'Off'`.
+*/
+function fieldValueFromEntry(field, entry) {
+	if (field.family !== "checkbox" && field.family !== "radio") return valueFromEntry(entry);
+	if (entry.kind !== "scalar") return "Off";
+	return field.widgets.find((widget) => widget.onState === entry.value)?.exportValue ?? entry.value;
+}
+/**
+* How a widget shows, as Acrobat's `field.display` reads its flags: hidden;
+* on screen but not printed; printed but not on screen; or visible.
+*/
+function displayOf(row) {
+	if (!row) return "visible";
+	if (row.hidden) return "hidden";
+	if (row.noView) return "noView";
+	return row.print ? "visible" : "noPrint";
 }
 /** Build the VM's detached field view from the engine's lossless snapshot. */
 function scriptFieldsFromSnapshot(snapshot) {
+	const rows = new Map(snapshot.widgets.map((row) => [row.ref.kind === "objectNumber" ? row.ref.objectNumber : 0, row]));
 	return snapshot.fields.map((field) => ({
 		ref: field.ref,
 		name: field.name,
 		family: field.family,
-		value: fieldValueFromEntry(field.family, field.valueEntry),
-		defaultValue: fieldValueFromEntry(field.family, field.defaultValueEntry),
-		display: "visible",
-		readOnly: field.flags.readOnly,
-		required: field.flags.required,
+		value: fieldValueFromEntry(field, field.valueEntry),
+		defaultValue: fieldValueFromEntry(field, field.defaultValueEntry),
+		display: displayOf(rows.get(field.widgets?.[0]?.objectNumber ?? -1)),
+		readOnly: field.readOnly,
+		required: field.required,
 		..."options" in field ? { options: field.options.map((option) => ({
 			label: option.label,
 			value: option.value
-		})) } : {}
+		})) } : {},
+		...field.family === "checkbox" || field.family === "radio" ? { exportValues: field.widgets.map((widget) => widget.exportValue) } : {}
 	}));
 }
 //#endregion
@@ -375,18 +393,18 @@ function scriptFieldsFromSnapshot(snapshot) {
 * values. The sandbox ships `installAcroJs.toString()` into QuickJS, while
 * tests execute the same source in a Node VM. Types disappear at build time.
 */
-function installAcroJs(g) {
-	const host = g;
+function installAcroJs(globalObject) {
+	const host = globalObject;
 	const NativeDate = Date;
 	let state = null;
 	const cloneValue = (value) => Array.isArray(value) ? value.map((item) => String(item)) : value;
-	const sameValue = (a, b) => {
-		if (Array.isArray(a) && Array.isArray(b)) return a.length === b.length && a.every((item, index) => item === b[index]);
-		return a === b;
+	const sameValue = (left, right) => {
+		if (Array.isArray(left) && Array.isArray(right)) return left.length === right.length && left.every((item, index) => item === right[index]);
+		return left === right;
 	};
 	const refKey = (ref) => {
 		const value = ref;
-		return value?.kind === "objectNumber" ? `obj:${String(value.fieldObjectNumber)}` : `fqn:${String(value?.name ?? "")}`;
+		return value?.kind === "objectNumber" ? `obj:${String(value.objectNumber)}` : `fqn:${String(value?.name ?? "")}`;
 	};
 	const diagnostic = (code, message) => {
 		state?.diagnostics.push({
@@ -583,19 +601,19 @@ function installAcroJs(g) {
 			Number(color[2]),
 			Number(color[3])
 		];
-		const c = Number(color[1]);
-		const m = Number(color[2]);
-		const y = Number(color[3]);
-		const k = Number(color[4]);
+		const cyan = Number(color[1]);
+		const magenta = Number(color[2]);
+		const yellow = Number(color[3]);
+		const black = Number(color[4]);
 		return [
-			1 - Math.min(1, c + k),
-			1 - Math.min(1, m + k),
-			1 - Math.min(1, y + k)
+			1 - Math.min(1, cyan + black),
+			1 - Math.min(1, magenta + black),
+			1 - Math.min(1, yellow + black)
 		];
 	};
-	const sameAnnotValue = (a, b) => {
-		if (Array.isArray(a) && Array.isArray(b)) return a.length === b.length && a.every((item, index) => item === b[index]);
-		return a === b;
+	const sameAnnotValue = (left, right) => {
+		if (Array.isArray(left) && Array.isArray(right)) return left.length === right.length && left.every((item, index) => item === right[index]);
+		return left === right;
 	};
 	const cloneAnnotValue = (value) => Array.isArray(value) ? [...value] : value;
 	const makeAnnot = (record) => {
@@ -623,8 +641,8 @@ function installAcroJs(g) {
 			get: () => cloneAnnotValue(record.current[key]),
 			set: (value) => stage(key, value, validate)
 		});
-		const isNum = (v) => typeof v === "number" && isFinite(v);
-		const isBool = (v) => typeof v === "boolean";
+		const isNum = (value) => typeof value === "number" && isFinite(value);
+		const isBool = (value) => typeof value === "boolean";
 		Object.defineProperties(wrapper, {
 			name: {
 				enumerable: true,
@@ -648,12 +666,12 @@ function installAcroJs(g) {
 			},
 			strokeColor: prop("strokeColor", isColorArray),
 			fillColor: prop("fillColor", isColorArray),
-			opacity: prop("opacity", (v) => isNum(v) && Number(v) >= 0 && Number(v) <= 1),
-			width: prop("width", (v) => isNum(v) && Number(v) >= 0),
-			style: prop("borderStyle", (v) => v === "S" || v === "D"),
-			dash: prop("dash", (v) => Array.isArray(v) && v.every(isNum)),
-			rect: prop("rect", (v) => Array.isArray(v) && v.length === 4 && v.every(isNum)),
-			contents: prop("contents", (v) => typeof v === "string"),
+			opacity: prop("opacity", (value) => isNum(value) && Number(value) >= 0 && Number(value) <= 1),
+			width: prop("width", (value) => isNum(value) && Number(value) >= 0),
+			style: prop("borderStyle", (value) => value === "S" || value === "D"),
+			dash: prop("dash", (value) => Array.isArray(value) && value.every(isNum)),
+			rect: prop("rect", (value) => Array.isArray(value) && value.length === 4 && value.every(isNum)),
+			contents: prop("contents", (value) => typeof value === "string"),
 			hidden: prop("hidden", isBool),
 			print: prop("print", isBool),
 			readOnly: prop("readOnly", isBool),
@@ -871,30 +889,30 @@ function installAcroJs(g) {
 		});
 		const fieldsByName = new Map(fields.map((field) => [String(field.input.name), field]));
 		const fieldsByRef = new Map(fields.map((field) => [refKey(field.input.ref), field]));
-		const annots = (input.annots ?? []).map((annot) => {
+		const annots = (input.annots ?? []).map((annotation) => {
 			const writableSnapshot = () => ({
-				strokeColor: cloneAnnotValue(annot.strokeColor ?? ["T"]),
-				fillColor: cloneAnnotValue(annot.fillColor ?? ["T"]),
-				opacity: Number(annot.opacity ?? 1),
-				width: Number(annot.width ?? 1),
-				borderStyle: String(annot.borderStyle ?? "S"),
-				dash: cloneAnnotValue(annot.dash ?? []),
-				rect: cloneAnnotValue(annot.rect ?? [
+				strokeColor: cloneAnnotValue(annotation.strokeColor ?? ["T"]),
+				fillColor: cloneAnnotValue(annotation.fillColor ?? ["T"]),
+				opacity: Number(annotation.opacity ?? 1),
+				width: Number(annotation.width ?? 1),
+				borderStyle: String(annotation.borderStyle ?? "S"),
+				dash: cloneAnnotValue(annotation.dash ?? []),
+				rect: cloneAnnotValue(annotation.rect ?? [
 					0,
 					0,
 					0,
 					0
 				]),
-				contents: String(annot.contents ?? ""),
-				hidden: Boolean(annot.hidden),
-				print: Boolean(annot.print),
-				readOnly: Boolean(annot.readOnly),
-				locked: Boolean(annot.locked),
-				noView: Boolean(annot.noView),
-				toggleNoView: Boolean(annot.toggleNoView)
+				contents: String(annotation.contents ?? ""),
+				hidden: Boolean(annotation.hidden),
+				print: Boolean(annotation.print),
+				readOnly: Boolean(annotation.readOnly),
+				locked: Boolean(annotation.locked),
+				noView: Boolean(annotation.noView),
+				toggleNoView: Boolean(annotation.toggleNoView)
 			});
 			const record = {
-				input: annot,
+				input: annotation,
 				original: writableSnapshot(),
 				current: writableSnapshot(),
 				wrapper: {}
@@ -951,22 +969,17 @@ function installAcroJs(g) {
 	};
 	const formValue = (field, value) => {
 		const family = String(field.input.family);
-		if (family === "text") return {
-			type: "text",
-			value: String(value ?? "")
-		};
-		if (family === "checkbox" || family === "radio") return {
-			type: "toggle",
-			state: value === null || value === void 0 || String(value) === "Off" ? null : String(value)
-		};
-		if (family === "combobox") return {
-			type: "choice",
-			values: Array.isArray(value) ? value.slice(0, 1).map(String) : [String(value ?? "")]
-		};
-		if (family === "listbox") return {
-			type: "choice",
-			values: Array.isArray(value) ? value.map(String) : [String(value ?? "")]
-		};
+		if (family === "text") return { value: String(value ?? "") };
+		if (family === "checkbox" || family === "radio") return { value: value === null || value === void 0 || String(value) === "Off" ? null : String(value) };
+		if (family === "combobox") {
+			const selected = Array.isArray(value) ? value[0] : value;
+			const text = selected === null || selected === void 0 ? "" : String(selected);
+			return { value: text === "" ? null : text };
+		}
+		if (family === "listbox") {
+			if (Array.isArray(value)) return { selectedValues: value.map(String) };
+			return { selectedValues: value === null || value === void 0 || value === "" ? [] : [String(value)] };
+		}
 		diagnostic("invalid-field-value", `field '${String(field.input.name)}' cannot accept a scripted value`);
 		return null;
 	};
@@ -1157,23 +1170,23 @@ function installAcroJs(g) {
 				rgb[2]
 			];
 			if (target === "CMYK") {
-				const k = 1 - Math.max(rgb[0], rgb[1], rgb[2]);
+				const black = 1 - Math.max(rgb[0], rgb[1], rgb[2]);
 				return [
 					"CMYK",
-					1 - rgb[0] - k,
-					1 - rgb[1] - k,
-					1 - rgb[2] - k,
-					k
+					1 - rgb[0] - black,
+					1 - rgb[1] - black,
+					1 - rgb[2] - black,
+					black
 				];
 			}
 			return ["T"];
 		},
-		equal: (a, b) => {
-			if (!isColorArray(a) || !isColorArray(b)) return false;
-			const left = colorToRgbTriple(a);
-			const right = colorToRgbTriple(b);
-			if (left === null || right === null) return left === right;
-			return left.every((component, index) => Math.abs(component - right[index]) < 1e-6);
+		equal: (left, right) => {
+			if (!isColorArray(left) || !isColorArray(right)) return false;
+			const leftRgb = colorToRgbTriple(left);
+			const rightRgb = colorToRgbTriple(right);
+			if (leftRgb === null || rightRgb === null) return leftRgb === rightRgb;
+			return leftRgb.every((component, index) => Math.abs(component - rightRgb[index]) < 1e-6);
 		}
 	});
 	host.getField = getField;
@@ -1221,7 +1234,7 @@ function installAcroJs(g) {
 	host.AFSimple_Calculate = (operation, names) => {
 		const values = (Array.isArray(names) ? names : String(names).split(",")).map((name) => numberValue(getField(String(name).trim())?.value));
 		const op = String(operation).toUpperCase();
-		const value = values.length === 0 ? 0 : op === "PRD" ? values.reduce((a, b) => a * b, 1) : op === "AVG" ? values.reduce((a, b) => a + b, 0) / values.length : op === "MIN" ? Math.min(...values) : op === "MAX" ? Math.max(...values) : values.reduce((a, b) => a + b, 0);
+		const value = values.length === 0 ? 0 : op === "PRD" ? values.reduce((left, right) => left * right, 1) : op === "AVG" ? values.reduce((left, right) => left + right, 0) / values.length : op === "MIN" ? Math.min(...values) : op === "MAX" ? Math.max(...values) : values.reduce((left, right) => left + right, 0);
 		if (state) state.event.value = value;
 	};
 	host.AFNumber_Format = (decimals, separatorStyle, _negativeStyle, _currencyStyle, currency, prepend) => {
@@ -1274,12 +1287,12 @@ function installAcroJs(g) {
 	const formatMismatch = () => rejectWithAlert(`The value entered does not match the format of the field [ ${String(state?.event.targetName ?? "")} ]`);
 	const dateMismatch = (format) => rejectWithAlert(`Invalid date/time: please ensure that the date/time exists. Field [ ${String(state?.event.targetName ?? "")} ] should match format ${String(format ?? "")}`);
 	const mergeChange = (eventObject) => {
-		const e = eventObject ?? state?.event ?? {};
-		const value = String(e.value ?? "");
-		if (e.willCommit) return value;
-		const start = Math.max(0, Math.trunc(Number(e.selStart ?? 0)));
-		const end = Math.max(start, Math.trunc(Number(e.selEnd ?? 0)));
-		return value.slice(0, start) + String(e.change ?? "") + value.slice(end);
+		const event = eventObject ?? state?.event ?? {};
+		const value = String(event.value ?? "");
+		if (event.willCommit) return value;
+		const start = Math.max(0, Math.trunc(Number(event.selStart ?? 0)));
+		const end = Math.max(start, Math.trunc(Number(event.selEnd ?? 0)));
+		return value.slice(0, start) + String(event.change ?? "") + value.slice(end);
 	};
 	host.AFMergeChange = mergeChange;
 	const makeNumber = (value) => {
@@ -1374,17 +1387,17 @@ function installAcroJs(g) {
 			break;
 		}
 		const timeMatch = /(\d{1,2}):(\d{2})(?::(\d{2}))?\s*(am|pm)?/i.exec(text);
-		let H = 0;
-		let M = 0;
-		let S = 0;
+		let hours = 0;
+		let minutes = 0;
+		let seconds = 0;
 		if (timeMatch) {
-			H = Number(timeMatch[1]);
-			M = Number(timeMatch[2]);
-			S = Number(timeMatch[3] ?? 0);
+			hours = Number(timeMatch[1]);
+			minutes = Number(timeMatch[2]);
+			seconds = Number(timeMatch[3] ?? 0);
 			const marker = String(timeMatch[4] ?? "").toLowerCase();
-			if (marker === "pm" && H < 12) H += 12;
-			if (marker === "am" && H === 12) H = 0;
-			if (H > 23 || M > 59 || S > 59) return null;
+			if (marker === "pm" && hours < 12) hours += 12;
+			if (marker === "am" && hours === 12) hours = 0;
+			if (hours > 23 || minutes > 59 || seconds > 59) return null;
 		}
 		const numbers = ((timeMatch ? text.slice(0, timeMatch.index) + text.slice(timeMatch.index + timeMatch[0].length) : text).match(/\d+/g) ?? []).map((token) => Number(token));
 		const order = [];
@@ -1392,35 +1405,35 @@ function installAcroJs(g) {
 			const kind = token[0] === "y" ? "y" : token[0] === "m" ? "m" : "d";
 			if (order.indexOf(kind) < 0) order.push(kind);
 		}
-		let y = null;
-		let m = namedMonth;
-		let d = null;
+		let year = null;
+		let month = namedMonth;
+		let day = null;
 		let cursor = 0;
 		for (const kind of order) {
 			if (kind === "m" && namedMonth !== null) continue;
 			if (cursor >= numbers.length) break;
 			const value = numbers[cursor];
 			cursor += 1;
-			if (kind === "y") y = value;
-			else if (kind === "m") m = value;
-			else d = value;
+			if (kind === "y") year = value;
+			else if (kind === "m") month = value;
+			else day = value;
 		}
-		if (y === null && m === null && d === null && !timeMatch) return null;
+		if (year === null && month === null && day === null && !timeMatch) return null;
 		const today = nowWall();
-		if (y === null) y = today.y;
-		else if (y < 100) y = y < 50 ? 2e3 + y : 1900 + y;
-		if (m === null) m = today.m;
-		if (d === null) d = 1;
-		if (m < 1 || m > 12 || d < 1 || d > 31) return null;
-		const probe = new NativeDate(NativeDate.UTC(y, m - 1, d));
-		if (probe.getUTCFullYear() !== y || probe.getUTCMonth() !== m - 1 || probe.getUTCDate() !== d) return null;
+		if (year === null) year = today.y;
+		else if (year < 100) year = year < 50 ? 2e3 + year : 1900 + year;
+		if (month === null) month = today.m;
+		if (day === null) day = 1;
+		if (month < 1 || month > 12 || day < 1 || day > 31) return null;
+		const probe = new NativeDate(NativeDate.UTC(year, month - 1, day));
+		if (probe.getUTCFullYear() !== year || probe.getUTCMonth() !== month - 1 || probe.getUTCDate() !== day) return null;
 		return {
-			y,
-			m,
-			d,
-			H,
-			M,
-			S
+			y: year,
+			m: month,
+			d: day,
+			H: hours,
+			M: minutes,
+			S: seconds
 		};
 	};
 	const afDateFormatEx = (format) => {