@embedpdf/plugin-actions 3.0.0-next.15 → 3.0.0-next.16

package/dist/index.cjs

@@ -254,6 +254,10 @@ function createDispatcher(ctx, services, { run }, { triggerEnabled, lifecycleAnn
 				return fields.find((candidate) => target.kind === "objectNumber" ? candidate.ref.kind === "objectNumber" && candidate.ref.objectNumber === target.objectNumber : candidate.name === target.name)?.actions?.[source.event] ?? null;
 			}
 			case "page": return ctx.getPage(source.page)?.actions?.[source.event ?? "open"] ?? null;
+			case "outline": {
+				const { items } = await ctx.doc.outline.get();
+				return items.find((candidate) => candidate.ref.objectNumber === source.item.objectNumber)?.action ?? null;
+			}
 			case "document": {
 				const snapshot = await readDocumentActions();
 				if (!snapshot) return null;
@@ -755,8 +759,8 @@ function createTriggers(ctx, { settings, form }) {
 * The verb-shaped document events (/WC, /WS, /DS, /WP, /DP) and the print
 * door: one catalog lifecycle tree per event, run inside the current queue
 * operation and never throwing (a broken script must not cancel the user's
-* save or print), and the adapter print wrapped /WP → print → /DP under the
-* print latch.
+* save or print), and a print request sent to the kernel's print, or, without
+* a printer, to the adapter, wrapped /WP → print → /DP under the print latch.
 */
 function createDocumentEvents(services, { ensureOpenSequenceBeforeDocEvent }, { runAndEmit }) {
 	const { reportDiagnostic } = services.events;
@@ -764,6 +768,7 @@ function createDocumentEvents(services, { ensureOpenSequenceBeforeDocEvent }, {
 	const { enqueue, budget } = services.queue;
 	const ports = services.ports.slots;
 	const { allowsPrint } = services.authority;
+	const { documentPrint } = services;
 	const printLatch = services.printLatch;
 	/**
 	* Run one catalog lifecycle tree inside the current queue operation, shared
@@ -803,13 +808,21 @@ function createDocumentEvents(services, { ensureOpenSequenceBeforeDocEvent }, {
 		return foldSteps(step ? [step] : [], diagnostics);
 	};
 	/**
-	* Both adapter print paths (the Named Print verb, and script `doc.print()`
-	* effects from the actions plane) go through here: /WP →
-	* `ports.uiAdapter.print` exactly once → /DP, with the latch reset in
-	* `finally`. While the latch is held (including `runDocumentVerb('print')`'s
-	* body) a nested request is suppressed with `reentrant-print`. An adapter
-	* throw skips /DP (the latch still resets). /DP fires when the adapter call
-	* returns, since a browser cannot observe dialog completion.
+	* Both print paths (the Named Print verb, and script `doc.print()` effects
+	* from the actions plane) go through here. While the latch is held
+	* (including `runDocumentVerb('print')`'s body) a nested request is
+	* suppressed with `reentrant-print`.
+	*
+	* With the kernel's print, a user's request starts `documents.print()` and
+	* returns: the kernel runs /WP and /DP around the dialog through this
+	* plugin's `aroundPrint` wrap, a `runDocumentVerb('print')` that waits for
+	* the current queue operation, so it is never awaited here. A hover or
+	* lifecycle request never opens the dialog.
+	*
+	* Without a printer: /WP → `ports.uiAdapter.print` exactly once → /DP,
+	* with the latch reset in `finally`. An adapter throw skips /DP (the latch
+	* still resets). /DP fires when the adapter call returns, since a browser
+	* cannot observe dialog completion.
 	*/
 	const firePrintThroughAdapter = async (uiContext, diagnose) => {
 		if (printLatch.active) {
@@ -832,6 +845,23 @@ function createDocumentEvents(services, { ensureOpenSequenceBeforeDocEvent }, {
 				detail: "doc.print is not allowed"
 			};
 		}
+		if (documentPrint.available()) {
+			if (uiContext && uiContext.origin !== "user") {
+				diagnose({
+					code: "blocked",
+					message: `print: a ${uiContext.origin} request never prints`
+				});
+				return {
+					status: "blocked",
+					detail: `${uiContext.origin} print request`
+				};
+			}
+			documentPrint.start().catch((error) => diagnose({
+				code: "trigger-failed",
+				message: `print: ${error instanceof Error ? error.message : String(error)}`
+			}));
+			return { status: "executed" };
+		}
 		if (!ports.uiAdapter) {
 			diagnose({
 				code: "no-adapter",
@@ -1206,7 +1236,7 @@ function createScriptWorld(ctx, { form }) {
 	};
 	const scriptEventFor = (actionContext, snapshot) => {
 		const provenance = actionContext.event;
-		const type = provenance.scope === "page" ? "Page" : provenance.scope === "document" ? "Doc" : actionContext.source.kind === "widget" ? "Field" : actionContext.source.kind === "link" ? "Link" : "Annot";
+		const type = provenance.scope === "page" ? "Page" : provenance.scope === "document" ? "Doc" : actionContext.source.kind === "widget" ? "Field" : actionContext.source.kind === "link" ? "Link" : actionContext.source.kind === "outline" ? "Bookmark" : "Annot";
 		const name = provenance.scope === "activate" ? "Mouse Up" : provenance.scope === "annotation" ? ANNOTATION_EVENT_NAMES[provenance.name] ?? "Mouse Up" : provenance.scope === "page" ? PAGE_EVENT_NAMES[provenance.name] ?? "Open" : DOC_EVENT_NAMES[provenance.name] ?? "Open";
 		const targetRef = actionContext.source.kind === "widget" ? actionContext.source.field : void 0;
 		const targetField = targetRef ? snapshot.fields.find((field) => targetRef.kind === "objectNumber" && field.ref.kind === "objectNumber" ? field.ref.objectNumber === targetRef.objectNumber : targetRef.kind === "fqn" && field.name === targetRef.name) : void 0;
@@ -1439,6 +1469,7 @@ function createScriptSurface(services, { performSubmit }) {
 	const { reportDiagnostic, scriptDiagnosticReported, scriptFailed } = services.events;
 	const ports = services.ports.slots;
 	const { allowsPrint } = services.authority;
+	const { documentPrint } = services;
 	const printLatch = services.printLatch;
 	const surfaceScriptResult = (result) => {
 		const uiContext = {
@@ -1479,6 +1510,23 @@ function createScriptSurface(services, { performSubmit }) {
 				});
 				continue;
 			}
+			if (effect.kind === "print" && documentPrint.available()) {
+				if (result.origin !== "user") {
+					scriptDiagnosticReported.emit({
+						code: "ui-effect-suppressed",
+						message: `script print request from a ${result.origin} event suppressed`
+					});
+					continue;
+				}
+				documentPrint.start().catch((error) => reportDiagnostic({
+					code: "trigger-failed",
+					message: `print: ${error instanceof Error ? error.message : String(error)}`
+				}, {
+					action: "javascript",
+					source
+				}));
+				continue;
+			}
 			if (!ports.uiAdapter) {
 				reportDiagnostic({
 					code: "no-adapter",
@@ -1564,6 +1612,24 @@ function createCatalog(ctx) {
 	};
 }
 //#endregion
+//#region src/services/document-print.ts
+/**
+* The kernel's print, where the document's own print requests go (the Named Print verb, a
+* script's `print()`) when the host gave the kernel a printer. The kernel prints the
+* document's pages, and runs the document's /WP and /DP around the dialog through the wrap
+* this plugin registers (`ctx.aroundPrint`). Without a printer, requests fall back to the UI
+* adapter's `print`.
+*/
+function createDocumentPrint(ctx) {
+	const documents = () => ctx.get(_embedpdf_core.DocumentsToken);
+	return {
+		/** Whether the kernel prints this document: `doc.print`, and the host gave a printer. */
+		available: () => documents().canPrint(),
+		/** Print the document through the kernel. */
+		start: () => documents().print()
+	};
+}
+//#endregion
 //#region src/services/events.ts
 function createEvents(ctx) {
 	const executed = ctx.events.source();
@@ -1675,6 +1741,7 @@ function createServices(ctx) {
 		catalog: createCatalog(ctx),
 		form: createForm(ctx, ports.slots),
 		authority: createAuthority(ctx),
+		documentPrint: createDocumentPrint(ctx),
 		printLatch: createPrintLatch()
 	};
 }
@@ -1829,6 +1896,7 @@ function createActionsController(ctx, config = {}) {
 			ctx.listen(ctx.doc.events, (event) => triggers.invalidate(event));
 			openSequence.arm();
 			ctx.aroundDownload((read) => documentEvents.api.runDocumentVerb("save", read));
+			ctx.aroundPrint((print) => documentEvents.api.runDocumentVerb("print", print));
 		}
 	};
 }