@embedpdf/engine-core 3.0.0-next.10 → 3.0.0-next.11

package/dist/conformance.cjs

@@ -2,7 +2,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_fold = require("./fold-C7I5GpBz.cjs");
 const require_PageInsertBlankInput = require("./PageInsertBlankInput-CzShuSJI.cjs");
 const require_AbortError = require("./AbortError-CRSooKsk.cjs");
-const require_schemas = require("./schemas-D1pxEv3t.cjs");
+const require_schemas = require("./schemas-CS5iPpX5.cjs");
 //#region src/conformance/runMetadataConformance.ts
 /**
 * The conformance harness is transport-agnostic. It takes the test runner as
@@ -370,6 +370,13 @@ function emptyFlags() {
 }
 //#endregion
 //#region src/conformance/runActionsConformance.ts
+/** The script payload rides only the javascript/rendition arms. */
+function scriptOf(node) {
+	if (!node) return "";
+	if (node.type === "javascript") return node.script;
+	if (node.type === "rendition") return node.script ?? "";
+	return "";
+}
 /** Action extraction parity. These tests assert data only; no script executes. */
 function runActionsConformance(runner, opts) {
 	const { describe, test, beforeAll, afterAll, expect } = runner;
@@ -389,10 +396,10 @@ function runActionsConformance(runner, opts) {
 				expect(require_schemas.DocumentActionsSnapshotSchema.safeParse(snapshot).success).toBe(true);
 				expect(snapshot.openAction).toBeNull();
 				expect(snapshot.willSave?.root?.type).toBe("javascript");
-				expect(snapshot.willSave?.root?.script ?? "").toMatch(/Will Save/);
-				expect(snapshot.didSave?.root?.script ?? "").toMatch(/Did Save/);
-				expect(snapshot.willPrint?.root?.script ?? "").toMatch(/Will Print/);
-				expect(snapshot.didPrint?.root?.script ?? "").toMatch(/Did Print/);
+				expect(scriptOf(snapshot.willSave?.root)).toMatch(/Will Save/);
+				expect(scriptOf(snapshot.didSave?.root)).toMatch(/Did Save/);
+				expect(scriptOf(snapshot.willPrint?.root)).toMatch(/Will Print/);
+				expect(scriptOf(snapshot.didPrint?.root)).toMatch(/Did Print/);
 				const form = await doc.forms.list();
 				expect(form.calculationOrder).toEqual([{
 					kind: "objectNumber",
@@ -439,7 +446,7 @@ function runActionsConformance(runner, opts) {
 				expect(link?.subtype).toBe("link");
 				if (link?.subtype === "link") expect(link.target).toEqual({ kind: "javascript" });
 				expect(link?.actions?.activate?.root?.type).toBe("javascript");
-				expect(link?.actions?.activate?.root?.script ?? "").toMatch(/app\.alert/);
+				expect(scriptOf(link?.actions?.activate?.root)).toMatch(/app\.alert/);
 			} finally {
 				await doc.close();
 			}
@@ -450,7 +457,7 @@ function runActionsConformance(runner, opts) {
 				const form = await doc.forms.list();
 				expect(form.fields).toHaveLength(1);
 				expect(form.fields[0].actions?.format?.root?.type).toBe("javascript");
-				expect(form.fields[0].actions?.format?.root?.script ?? "").toMatch(/AFDate_FormatEx/);
+				expect(scriptOf(form.fields[0].actions?.format?.root)).toMatch(/AFDate_FormatEx/);
 				const page = (await doc.pages.list()).pages[0];
 				const widget = (await doc.page(page.pageObjectNumber).annotations.list()).annotations[0];
 				expect(widget.actions).toBe(void 0);
@@ -458,6 +465,210 @@ function runActionsConformance(runner, opts) {
 				await doc.close();
 			}
 		});
+		test("carries interpreter payloads on every executable node", async () => {
+			const doc = await open(engine, opts, opts.fixtures.payloads);
+			try {
+				const page = (await doc.pages.list()).pages[0];
+				const snapshot = await doc.page(page.pageObjectNumber).annotations.list();
+				const pon = page.pageObjectNumber;
+				const rootOf = (nm) => {
+					const annotation = snapshot.annotations.find((candidate) => candidate.nm === nm);
+					expect(Boolean(annotation)).toBe(true);
+					return annotation?.actions?.activate?.root ?? null;
+				};
+				const targetOf = (nm) => {
+					const annotation = snapshot.annotations.find((candidate) => candidate.nm === nm);
+					return annotation?.subtype === "link" ? annotation.target : null;
+				};
+				expect(rootOf("goto-fitr")).toMatchObject({
+					type: "goto",
+					destination: {
+						kind: "fitR",
+						pageObjectNumber: pon,
+						left: 10,
+						bottom: 20,
+						right: 300,
+						top: 400
+					}
+				});
+				expect(targetOf("goto-fitr")).toMatchObject({
+					kind: "goto",
+					destination: { kind: "fitR" }
+				});
+				expect(rootOf("uri-map")).toMatchObject({
+					type: "uri",
+					uri: "https://example.test/map",
+					isMap: true
+				});
+				expect(rootOf("named-next")).toMatchObject({
+					type: "named",
+					name: "NextPage"
+				});
+				const mixed = rootOf("hide-mixed");
+				expect(mixed).toMatchObject({
+					type: "hide",
+					hide: false
+				});
+				const mixedTargets = mixed?.type === "hide" ? mixed.targets : [];
+				expect(mixedTargets).toHaveLength(2);
+				expect(mixedTargets[0]).toEqual({
+					kind: "name",
+					name: "note1"
+				});
+				expect(mixedTargets[1]?.kind === "objectNumber" && mixedTargets[1].objectNumber > 0).toBe(true);
+				expect(rootOf("hide-scalar")).toMatchObject({
+					type: "hide",
+					targets: [{
+						kind: "name",
+						name: "fieldB"
+					}],
+					hide: true
+				});
+				expect(rootOf("reset-include")).toMatchObject({
+					type: "reset-form",
+					fields: [{
+						kind: "name",
+						name: "calc1"
+					}],
+					exclude: true
+				});
+				expect(rootOf("reset-absent")).toMatchObject({
+					type: "reset-form",
+					fields: null,
+					exclude: true
+				});
+				expect(rootOf("reset-empty")).toMatchObject({
+					type: "reset-form",
+					fields: [],
+					exclude: false
+				});
+				expect(rootOf("submit-urlspec")).toMatchObject({
+					type: "submit-form",
+					payload: {
+						url: "https://uf.example.test/submit",
+						fields: [{
+							kind: "name",
+							name: "parent"
+						}],
+						flags: {
+							raw: 0,
+							exclude: false,
+							format: "fdf",
+							method: "post"
+						}
+					}
+				});
+				expect(rootOf("submit-compat-xfdf")).toMatchObject({
+					type: "submit-form",
+					payload: {
+						url: "https://example.test/xfdf",
+						fields: [{
+							kind: "name",
+							name: "noexport"
+						}, {
+							kind: "name",
+							name: "plain"
+						}],
+						flags: {
+							raw: 35,
+							exclude: true,
+							includeNoValueFields: true,
+							format: "xfdf",
+							method: "post"
+						},
+						charSet: "utf-8"
+					}
+				});
+				expect(rootOf("submit-pdf-get")).toMatchObject({
+					type: "submit-form",
+					payload: {
+						url: "https://example.test/pdf",
+						fields: null,
+						flags: {
+							raw: 264,
+							format: "pdf",
+							method: "get"
+						}
+					}
+				});
+				expect(rootOf("launch-app")).toMatchObject({
+					type: "launch",
+					filePath: "app.exe"
+				});
+				expect(rootOf("gotor-file")).toMatchObject({
+					type: "goto-remote",
+					filePath: "other.pdf"
+				});
+				const chain = rootOf("chain-js-goto-hide");
+				expect(chain).toMatchObject({
+					type: "javascript",
+					script: "app.alert('chain');"
+				});
+				expect(chain?.next[0]).toMatchObject({
+					type: "goto",
+					destination: {
+						kind: "xyz",
+						pageObjectNumber: pon,
+						left: 5,
+						top: 10,
+						zoom: 1.25
+					}
+				});
+				expect(chain?.next[0]?.next[0]).toMatchObject({
+					type: "hide",
+					targets: [{
+						kind: "name",
+						name: "note1"
+					}],
+					hide: true
+				});
+			} finally {
+				await doc.close();
+			}
+		});
+		test("degrades unreadable payloads to unknown with payload-dropped", async () => {
+			const doc = await open(engine, opts, opts.fixtures.payloads);
+			try {
+				const page = (await doc.pages.list()).pages[0];
+				const snapshot = await doc.page(page.pageObjectNumber).annotations.list();
+				for (const [nm, subtype] of [
+					["goto-malformed", "GoTo"],
+					["hide-partial", "Hide"],
+					["submit-not-url", "SubmitForm"],
+					["submit-no-f", "SubmitForm"]
+				]) {
+					const annotation = snapshot.annotations.find((candidate) => candidate.nm === nm);
+					const tree = annotation?.actions?.activate;
+					expect(tree?.root).toMatchObject({
+						type: "unknown",
+						subtype
+					});
+					expect(tree?.warnings ?? []).toContain("payload-dropped");
+					if (annotation?.subtype === "link") expect(annotation.target).toEqual({ kind: "unsupported" });
+				}
+			} finally {
+				await doc.close();
+			}
+		});
+		test("reads a destination-form /OpenAction as openDestination", async () => {
+			const doc = await open(engine, opts, opts.fixtures.openDestination);
+			try {
+				expect(Boolean(doc.actions)).toBe(true);
+				const snapshot = await doc.actions.read();
+				expect(require_schemas.DocumentActionsSnapshotSchema.safeParse(snapshot).success).toBe(true);
+				expect(snapshot.openAction).toBeNull();
+				const pon = (await doc.pages.list()).pages[0].pageObjectNumber;
+				expect(snapshot.openDestination).toEqual({
+					kind: "xyz",
+					pageObjectNumber: pon,
+					left: 10,
+					top: 700,
+					zoom: 1.5
+				});
+			} finally {
+				await doc.close();
+			}
+		});
 	});
 }
 async function open(engine, opts, fixture) {