@embedpdf/plugin-link 3.0.0-next.0

package/LICENSE

@@ -0,0 +1,192 @@
+Copyright 2026 CloudPDF LTD
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use files in this distribution except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-----------------------------------------------------------------------
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/dist/index.cjs

@@ -0,0 +1,196 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let _embedpdf_core = require("@embedpdf/core");
+let _embedpdf_plugin_interaction = require("@embedpdf/plugin-interaction");
+let _embedpdf_plugin_stage = require("@embedpdf/plugin-stage");
+let _embedpdf_plugin_annotation = require("@embedpdf/plugin-annotation");
+let _embedpdf_plugin_annotation_internal = require("@embedpdf/plugin-annotation/internal");
+let _embedpdf_core_annotation = require("@embedpdf/core-annotation");
+//#region src/source.ts
+function loadLinksPage(io, pon) {
+	const doc = io.doc;
+	const crop = io.document()?.pages.find((p) => p.pageObjectNumber === pon)?.boxes.crop;
+	if (!doc || !crop) return;
+	doc.page(pon).annotations.list().then((snap) => {
+		const items = [];
+		for (const dto of snap.annotations) {
+			if (dto.subtype !== "link" || dto.target == null) continue;
+			if (dto.flags.hidden || dto.flags.noView) continue;
+			items.push({
+				id: dto.ref.kind === "objectNumber" ? `obj:${dto.ref.annotObjectNumber}` : `idx:${pon}:${dto.index}`,
+				rect: (0, _embedpdf_core_annotation.pdfToContentRect)(dto.rect, crop),
+				target: dto.target
+			});
+		}
+		io.dispatch({
+			type: "SET_PAGE",
+			pon,
+			items
+		});
+	}, () => {});
+}
+//#endregion
+//#region src/capability.ts
+const EMPTY = [];
+/**
+* The navigation plane's surface. Data source is decided PER CALL (lazily,
+* so plugin registration order can't matter): the annotation plugin's
+* folded model when present — its `linkItemsOn` lens is memoized by model
+* identity and already excludes hidden links — else this plugin's own
+* engine-backed page cache (see source.ts).
+*/
+function createLinkCapability(ctx, config = {}) {
+	const anno = () => ctx.tryGet(_embedpdf_plugin_annotation_internal.AnnotationToken);
+	const activate = (target) => {
+		const activation = (() => {
+			switch (target.kind) {
+				case "goto": {
+					const stage = ctx.tryGet(_embedpdf_plugin_stage.StageToken);
+					const layout = ctx.document()?.pages.find((p) => p.pageObjectNumber === target.destination.pageObjectNumber);
+					if (!stage || !layout) return {
+						outcome: "destination",
+						destination: target.destination
+					};
+					const { pageIndex, options } = (0, _embedpdf_plugin_stage.destinationToReveal)(target.destination, layout);
+					stage.reveal(pageIndex, {
+						...options,
+						behavior: "smooth"
+					});
+					return { outcome: "revealed" };
+				}
+				case "uri": return {
+					outcome: "uri",
+					uri: target.uri
+				};
+				case "named": return {
+					outcome: "named",
+					name: target.name
+				};
+				default: return {
+					outcome: "reported",
+					target
+				};
+			}
+		})();
+		config.onActivate?.({
+			target,
+			activation
+		});
+		return activation;
+	};
+	return {
+		linksOn: (pon) => {
+			const host = anno();
+			if (host) return host.linkItemsOn(pon);
+			return ctx.getState().pages[pon] ?? EMPTY;
+		},
+		ensurePage: (pon) => {
+			const host = anno();
+			if (host) {
+				host.ensurePage(pon);
+				return;
+			}
+			if (!(pon in ctx.getState().pages)) loadLinksPage(ctx, pon);
+		},
+		engaged: () => ctx.tryGet(_embedpdf_plugin_interaction.InteractionToken)?.activeTool()?.enables.has("link-nav") ?? false,
+		activate
+	};
+}
+//#endregion
+//#region src/effects.ts
+/**
+* Keeps the ENGINE-BACKED page cache honest in viewer-only deployments:
+* any annotation mutation on a cached page (own or remote — the cache has
+* no other refresh path, unlike the annotation plugin's optimistic model)
+* refetches that page's links. With the annotation plugin present the
+* folded model is the source and this effect never fires a fetch.
+*/
+function registerLinkEffects(ctx) {
+	const doc = ctx.doc;
+	if (!doc) return;
+	const refetch = (pon) => {
+		if (ctx.tryGet(_embedpdf_plugin_annotation_internal.AnnotationToken)) return;
+		if (pon in ctx.getState().pages) loadLinksPage(ctx, pon);
+	};
+	const unsubscribe = doc.events.subscribe((event) => {
+		switch (event.type) {
+			case "annotation.created":
+				refetch(event.created.pageObjectNumber);
+				break;
+			case "annotation.updated":
+				refetch(event.updated.pageObjectNumber);
+				break;
+			case "annotation.moved":
+				if (event.moved.length) refetch(event.moved[0].pageObjectNumber);
+				break;
+			case "annotation.deleted":
+				refetch(event.pageObjectNumber);
+				break;
+			default: break;
+		}
+	});
+	ctx.cleanup(unsubscribe);
+}
+//#endregion
+//#region src/reducer.ts
+const initialLinkState = () => ({ pages: {} });
+/** Pure. Engine-backed page cache only — the annotation-backed mode reads the
+*  annotation plugin's model and never touches this state. */
+function linkReducer(state, a) {
+	switch (a.type) {
+		case "SET_PAGE": return {
+			...state,
+			pages: {
+				...state.pages,
+				[a.pon]: a.items
+			}
+		};
+		case "DROP_PAGE": {
+			if (!(a.pon in state.pages)) return state;
+			const pages = { ...state.pages };
+			delete pages[a.pon];
+			return {
+				...state,
+				pages
+			};
+		}
+	}
+}
+//#endregion
+//#region src/types.ts
+const LinkToken = (0, _embedpdf_core.createCapabilityToken)("link");
+//#endregion
+//#region src/link.plugin.ts
+/**
+* The link plugin: the NAVIGATION plane. Document-scoped; requires only the
+* interaction hub. Navigation works with no annotation plugin at all —
+* links are read from the engine's link DTOs. When the annotation plugin IS
+* present, its folded model becomes the data source (no double fetch) and a
+* Behavior keeps links navigation-owned while a `link-nav` tool is active
+* (pointer/pan/form-fill by default) — the single-active-tool hub IS the
+* mode switch: grab the link tool and every link becomes an editable rect.
+*/
+const linkPlugin = (config) => (0, _embedpdf_core.definePlugin)({
+	id: "link",
+	token: LinkToken,
+	scope: "document",
+	requires: [_embedpdf_plugin_interaction.InteractionToken],
+	optional: [_embedpdf_plugin_stage.StageToken, _embedpdf_plugin_annotation.AnnotationToken],
+	initialState: initialLinkState,
+	reduce: linkReducer,
+	capability: (ctx) => createLinkCapability(ctx, config),
+	effects: registerLinkEffects,
+	init: (ctx) => {
+		const interaction = ctx.get(_embedpdf_plugin_interaction.InteractionToken);
+		const annotation = ctx.tryGet(_embedpdf_plugin_annotation_internal.AnnotationToken);
+		if (annotation) annotation.registerBehavior({
+			id: "link-nav",
+			matches: (a) => a.subtype === "link",
+			engaged: () => interaction.activeTool()?.enables.has("link-nav") ?? false
+		});
+	}
+});
+//#endregion
+exports.LinkToken = LinkToken;
+exports.linkPlugin = linkPlugin;
+
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["AnnotationHostToken","StageToken","InteractionToken","AnnotationHostToken","InteractionToken","StageToken","AnnotationToken","AnnotationHostToken"],"sources":["../src/source.ts","../src/capability.ts","../src/effects.ts","../src/reducer.ts","../src/types.ts","../src/link.plugin.ts"],"sourcesContent":["import type { DocumentHandle, PageLayout } from '@embedpdf/core';\nimport { pdfToContentRect } from '@embedpdf/core-annotation';\nimport type { LinkAction, LinkNavItem } from './types';\n\n/**\n * The ENGINE-BACKED link source, for viewer-only deployments (no annotation\n * plugin): read a page's annotation list and keep just the navigable links —\n * standalone AND attached children alike (both are raw link DTOs here).\n * Shared by the capability's lazy `ensurePage` and the effects module's\n * event-driven refetch; both PluginContext and EffectContext satisfy the\n * structural `io` slice.\n */\nexport interface LinkSourceIO {\n  doc: DocumentHandle | null;\n  document(): { pages: readonly PageLayout[] } | null;\n  dispatch(action: LinkAction): void;\n}\n\nexport function loadLinksPage(io: LinkSourceIO, pon: number): void {\n  const doc = io.doc;\n  const crop = io.document()?.pages.find((p) => p.pageObjectNumber === pon)?.boxes.crop;\n  if (!doc || !crop) return;\n  doc\n    .page(pon)\n    .annotations.list()\n    .then(\n      (snap) => {\n        const items: LinkNavItem[] = [];\n        for (const dto of snap.annotations) {\n          if (dto.subtype !== 'link' || dto.target == null) continue;\n          if (dto.flags.hidden || dto.flags.noView) continue;\n          items.push({\n            id:\n              dto.ref.kind === 'objectNumber'\n                ? `obj:${dto.ref.annotObjectNumber}`\n                : `idx:${pon}:${dto.index}`,\n            rect: pdfToContentRect(dto.rect, crop),\n            target: dto.target,\n          });\n        }\n        io.dispatch({ type: 'SET_PAGE', pon, items });\n      },\n      () => {},\n    );\n}\n","import type { PluginContext } from '@embedpdf/core';\nimport type { PdfLinkTarget } from '@embedpdf/engine-core/runtime';\nimport { InteractionToken } from '@embedpdf/plugin-interaction';\nimport { destinationToReveal, StageToken } from '@embedpdf/plugin-stage';\n// The host lens (linkItemsOn) — same runtime token as the public one.\nimport { AnnotationToken as AnnotationHostToken } from '@embedpdf/plugin-annotation/internal';\nimport { loadLinksPage } from './source';\nimport type {\n  LinkAction,\n  LinkActivation,\n  LinkCapability,\n  LinkNavItem,\n  LinkPluginConfig,\n  LinkState,\n} from './types';\n\nconst EMPTY: LinkNavItem[] = [];\n\n/**\n * The navigation plane's surface. Data source is decided PER CALL (lazily,\n * so plugin registration order can't matter): the annotation plugin's\n * folded model when present — its `linkItemsOn` lens is memoized by model\n * identity and already excludes hidden links — else this plugin's own\n * engine-backed page cache (see source.ts).\n */\nexport function createLinkCapability(\n  ctx: PluginContext<LinkState, LinkAction>,\n  config: LinkPluginConfig = {},\n): LinkCapability {\n  const anno = () => ctx.tryGet(AnnotationHostToken);\n\n  const activate = (target: PdfLinkTarget): LinkActivation => {\n    const activation = ((): LinkActivation => {\n      switch (target.kind) {\n        case 'goto': {\n          const stage = ctx.tryGet(StageToken);\n          const layout = ctx\n            .document()\n            ?.pages.find((p) => p.pageObjectNumber === target.destination.pageObjectNumber);\n          if (!stage || !layout) {\n            // No camera to drive — hand the embedder the explicit destination.\n            return { outcome: 'destination', destination: target.destination };\n          }\n          const { pageIndex, options } = destinationToReveal(target.destination, layout);\n          stage.reveal(pageIndex, { ...options, behavior: 'smooth' });\n          return { outcome: 'revealed' };\n        }\n        case 'uri':\n          // Opening is the FRAMEWORK layer's job (a real <a href> after\n          // sanitizing) — this plugin never touches the DOM.\n          return { outcome: 'uri', uri: target.uri };\n        case 'named':\n          return { outcome: 'named', name: target.name };\n        default:\n          // javascript / goto-remote / launch / unsupported: reported, never\n          // executed here. JavaScript activation belongs to the scripting\n          // orchestrator once it lands — the chain already rides the\n          // annotation's base `actions`.\n          return { outcome: 'reported', target };\n      }\n    })();\n    config.onActivate?.({ target, activation });\n    return activation;\n  };\n\n  return {\n    linksOn: (pon) => {\n      const host = anno();\n      if (host) return host.linkItemsOn(pon);\n      return ctx.getState().pages[pon] ?? EMPTY;\n    },\n    ensurePage: (pon) => {\n      const host = anno();\n      if (host) {\n        host.ensurePage(pon); // the folded model is the source; it lazy-loads\n        return;\n      }\n      if (!(pon in ctx.getState().pages)) loadLinksPage(ctx, pon);\n    },\n    engaged: () => ctx.tryGet(InteractionToken)?.activeTool()?.enables.has('link-nav') ?? false,\n    activate,\n  };\n}\n","import type { DocumentEvent, EffectContext } from '@embedpdf/core';\nimport { AnnotationToken as AnnotationHostToken } from '@embedpdf/plugin-annotation/internal';\nimport { loadLinksPage } from './source';\nimport type { LinkAction, LinkState } from './types';\n\n/**\n * Keeps the ENGINE-BACKED page cache honest in viewer-only deployments:\n * any annotation mutation on a cached page (own or remote — the cache has\n * no other refresh path, unlike the annotation plugin's optimistic model)\n * refetches that page's links. With the annotation plugin present the\n * folded model is the source and this effect never fires a fetch.\n */\nexport function registerLinkEffects(ctx: EffectContext<LinkState, LinkAction>): void {\n  const doc = ctx.doc;\n  if (!doc) return;\n\n  const refetch = (pon: number): void => {\n    if (ctx.tryGet(AnnotationHostToken)) return; // annotation model owns the data\n    if (pon in ctx.getState().pages) loadLinksPage(ctx, pon);\n  };\n\n  const unsubscribe = doc.events.subscribe((event: DocumentEvent) => {\n    switch (event.type) {\n      case 'annotation.created':\n        refetch(event.created.pageObjectNumber);\n        break;\n      case 'annotation.updated':\n        refetch(event.updated.pageObjectNumber);\n        break;\n      case 'annotation.moved':\n        if (event.moved.length) refetch(event.moved[0].pageObjectNumber);\n        break;\n      case 'annotation.deleted':\n        refetch(event.pageObjectNumber);\n        break;\n      default:\n        break;\n    }\n  });\n  ctx.cleanup(unsubscribe);\n}\n","import type { LinkAction, LinkState } from './types';\n\nexport const initialLinkState = (): LinkState => ({ pages: {} });\n\n/** Pure. Engine-backed page cache only — the annotation-backed mode reads the\n *  annotation plugin's model and never touches this state. */\nexport function linkReducer(state: LinkState, a: LinkAction): LinkState {\n  switch (a.type) {\n    case 'SET_PAGE':\n      return { ...state, pages: { ...state.pages, [a.pon]: a.items } };\n    case 'DROP_PAGE': {\n      if (!(a.pon in state.pages)) return state;\n      const pages = { ...state.pages };\n      delete pages[a.pon];\n      return { ...state, pages };\n    }\n  }\n}\n","import { createCapabilityToken, type PageObjectNumber } from '@embedpdf/core';\nimport type { PdfDestination, PdfLinkTarget } from '@embedpdf/engine-core/runtime';\nimport type { LinkNavItem } from '@embedpdf/plugin-annotation';\n\nexport type { LinkNavItem };\n// The wire target vocabulary, re-exported so app code building link editors\n// needs only this package (the annotation-props precedent).\nexport type { PdfDestination, PdfLinkTarget };\n\n/**\n * What one activation did. `revealed` = the stage moved the camera;\n * `destination` = no stage plugin — the embedder gets the explicit\n * destination to handle; `uri` = opening is the FRAMEWORK layer's job (the\n * plugin is DOM-free); `named` = a viewer verb (NextPage…) reported until\n * stage verbs land; `reported` = read-only/executable-shaped targets\n * (javascript / goto-remote / launch / unsupported) — surfaced, NEVER\n * executed here (javascript belongs to the scripting orchestrator).\n */\nexport type LinkActivation =\n  | { outcome: 'revealed' }\n  | { outcome: 'destination'; destination: PdfDestination }\n  | { outcome: 'uri'; uri: string }\n  | { outcome: 'named'; name: string }\n  | { outcome: 'reported'; target: PdfLinkTarget }\n  | { outcome: 'none' };\n\nexport interface LinkActivateEvent {\n  target: PdfLinkTarget;\n  activation: LinkActivation;\n}\n\nexport interface LinkPluginConfig {\n  /** Every activation (navigations AND reported targets) — analytics /\n   *  custom handling. Called after the built-in handling ran. */\n  onActivate?: (event: LinkActivateEvent) => void;\n}\n\n/**\n * The navigation plane of link annotations. Data comes from ONE of two\n * sources, picked at init: the annotation plugin's folded model when that\n * plugin is present (zero extra engine reads — it already lists every\n * page), or the plugin's own engine reads in viewer-only deployments.\n */\nexport interface LinkCapability {\n  /** The clickable link areas of a page (content space, y-down). */\n  linksOn(pon: PageObjectNumber): LinkNavItem[];\n  /** Lazy-load a page's links (no-op when the annotation plugin owns the data). */\n  ensurePage(pon: PageObjectNumber): void;\n  /** Whether the navigation plane currently owns links: the active tool\n   *  enables `link-nav` (pointer/pan/form-fill by default). While false —\n   *  the link tool or any authoring tool is active — the annotation plane\n   *  owns them and the LinkLayer stands down. */\n  engaged(): boolean;\n  /** THE one activation entry point (framework layers call it on click). */\n  activate(target: PdfLinkTarget): LinkActivation;\n}\n\n/** Engine-backed page cache (viewer-only deployments). */\nexport interface LinkState {\n  pages: Record<number, LinkNavItem[]>;\n}\n\nexport type LinkAction =\n  | { type: 'SET_PAGE'; pon: number; items: LinkNavItem[] }\n  | { type: 'DROP_PAGE'; pon: number };\n\nexport const LinkToken = createCapabilityToken<LinkCapability>('link');\n","import { definePlugin } from '@embedpdf/core';\nimport { InteractionToken } from '@embedpdf/plugin-interaction';\nimport { StageToken } from '@embedpdf/plugin-stage';\nimport { AnnotationToken } from '@embedpdf/plugin-annotation';\n// Behavior registration lives on the HOST capability (framework/plugin\n// surface) — same runtime token, wider type. The form plugin's precedent.\nimport { AnnotationToken as AnnotationHostToken } from '@embedpdf/plugin-annotation/internal';\n\nimport { createLinkCapability } from './capability';\nimport { registerLinkEffects } from './effects';\nimport { initialLinkState, linkReducer } from './reducer';\nimport { LinkToken } from './types';\nimport type { LinkAction, LinkCapability, LinkPluginConfig, LinkState } from './types';\n\n/**\n * The link plugin: the NAVIGATION plane. Document-scoped; requires only the\n * interaction hub. Navigation works with no annotation plugin at all —\n * links are read from the engine's link DTOs. When the annotation plugin IS\n * present, its folded model becomes the data source (no double fetch) and a\n * Behavior keeps links navigation-owned while a `link-nav` tool is active\n * (pointer/pan/form-fill by default) — the single-active-tool hub IS the\n * mode switch: grab the link tool and every link becomes an editable rect.\n */\nexport const linkPlugin = (config?: LinkPluginConfig) =>\n  definePlugin<LinkState, LinkAction, LinkCapability>({\n    id: 'link',\n    token: LinkToken,\n    scope: 'document',\n    requires: [InteractionToken],\n    optional: [StageToken, AnnotationToken],\n    initialState: initialLinkState,\n    reduce: linkReducer,\n    capability: (ctx) => createLinkCapability(ctx, config),\n    effects: registerLinkEffects,\n    init: (ctx) => {\n      const interaction = ctx.get(InteractionToken);\n      const annotation = ctx.tryGet(AnnotationHostToken);\n      if (annotation) {\n        annotation.registerBehavior({\n          id: 'link-nav',\n          matches: (a) => a.subtype === 'link',\n          engaged: () => interaction.activeTool()?.enables.has('link-nav') ?? false,\n        });\n      }\n    },\n  });\n"],"mappings":";;;;;;;;AAkBA,SAAgB,cAAc,IAAkB,KAAmB;CACjE,MAAM,MAAM,GAAG;CACf,MAAM,OAAO,GAAG,SAAS,CAAC,EAAE,MAAM,MAAM,MAAM,EAAE,qBAAqB,GAAG,CAAC,EAAE,MAAM;CACjF,IAAI,CAAC,OAAO,CAAC,MAAM;CACnB,IACG,KAAK,GAAG,CAAC,CACT,YAAY,KAAK,CAAC,CAClB,MACE,SAAS;EACR,MAAM,QAAuB,CAAC;EAC9B,KAAK,MAAM,OAAO,KAAK,aAAa;GAClC,IAAI,IAAI,YAAY,UAAU,IAAI,UAAU,MAAM;GAClD,IAAI,IAAI,MAAM,UAAU,IAAI,MAAM,QAAQ;GAC1C,MAAM,KAAK;IACT,IACE,IAAI,IAAI,SAAS,iBACb,OAAO,IAAI,IAAI,sBACf,OAAO,IAAI,GAAG,IAAI;IACxB,OAAA,GAAA,0BAAA,iBAAA,CAAuB,IAAI,MAAM,IAAI;IACrC,QAAQ,IAAI;GACd,CAAC;EACH;EACA,GAAG,SAAS;GAAE,MAAM;GAAY;GAAK;EAAM,CAAC;CAC9C,SACM,CAAC,CACT;AACJ;;;AC5BA,MAAM,QAAuB,CAAC;;;;;;;;AAS9B,SAAgB,qBACd,KACA,SAA2B,CAAC,GACZ;CAChB,MAAM,aAAa,IAAI,OAAOA,qCAAAA,eAAmB;CAEjD,MAAM,YAAY,WAA0C;EAC1D,MAAM,oBAAoC;GACxC,QAAQ,OAAO,MAAf;IACE,KAAK,QAAQ;KACX,MAAM,QAAQ,IAAI,OAAOC,uBAAAA,UAAU;KACnC,MAAM,SAAS,IACZ,SAAS,CAAC,EACT,MAAM,MAAM,MAAM,EAAE,qBAAqB,OAAO,YAAY,gBAAgB;KAChF,IAAI,CAAC,SAAS,CAAC,QAEb,OAAO;MAAE,SAAS;MAAe,aAAa,OAAO;KAAY;KAEnE,MAAM,EAAE,WAAW,aAAA,GAAA,uBAAA,oBAAA,CAAgC,OAAO,aAAa,MAAM;KAC7E,MAAM,OAAO,WAAW;MAAE,GAAG;MAAS,UAAU;KAAS,CAAC;KAC1D,OAAO,EAAE,SAAS,WAAW;IAC/B;IACA,KAAK,OAGH,OAAO;KAAE,SAAS;KAAO,KAAK,OAAO;IAAI;IAC3C,KAAK,SACH,OAAO;KAAE,SAAS;KAAS,MAAM,OAAO;IAAK;IAC/C,SAKE,OAAO;KAAE,SAAS;KAAY;IAAO;GACzC;EACF,EAAA,CAAG;EACH,OAAO,aAAa;GAAE;GAAQ;EAAW,CAAC;EAC1C,OAAO;CACT;CAEA,OAAO;EACL,UAAU,QAAQ;GAChB,MAAM,OAAO,KAAK;GAClB,IAAI,MAAM,OAAO,KAAK,YAAY,GAAG;GACrC,OAAO,IAAI,SAAS,CAAC,CAAC,MAAM,QAAQ;EACtC;EACA,aAAa,QAAQ;GACnB,MAAM,OAAO,KAAK;GAClB,IAAI,MAAM;IACR,KAAK,WAAW,GAAG;IACnB;GACF;GACA,IAAI,EAAE,OAAO,IAAI,SAAS,CAAC,CAAC,QAAQ,cAAc,KAAK,GAAG;EAC5D;EACA,eAAe,IAAI,OAAOC,6BAAAA,gBAAgB,CAAC,EAAE,WAAW,CAAC,EAAE,QAAQ,IAAI,UAAU,KAAK;EACtF;CACF;AACF;;;;;;;;;;ACtEA,SAAgB,oBAAoB,KAAiD;CACnF,MAAM,MAAM,IAAI;CAChB,IAAI,CAAC,KAAK;CAEV,MAAM,WAAW,QAAsB;EACrC,IAAI,IAAI,OAAOC,qCAAAA,eAAmB,GAAG;EACrC,IAAI,OAAO,IAAI,SAAS,CAAC,CAAC,OAAO,cAAc,KAAK,GAAG;CACzD;CAEA,MAAM,cAAc,IAAI,OAAO,WAAW,UAAyB;EACjE,QAAQ,MAAM,MAAd;GACE,KAAK;IACH,QAAQ,MAAM,QAAQ,gBAAgB;IACtC;GACF,KAAK;IACH,QAAQ,MAAM,QAAQ,gBAAgB;IACtC;GACF,KAAK;IACH,IAAI,MAAM,MAAM,QAAQ,QAAQ,MAAM,MAAM,EAAE,CAAC,gBAAgB;IAC/D;GACF,KAAK;IACH,QAAQ,MAAM,gBAAgB;IAC9B;GACF,SACE;EACJ;CACF,CAAC;CACD,IAAI,QAAQ,WAAW;AACzB;;;ACtCA,MAAa,0BAAqC,EAAE,OAAO,CAAC,EAAE;;;AAI9D,SAAgB,YAAY,OAAkB,GAA0B;CACtE,QAAQ,EAAE,MAAV;EACE,KAAK,YACH,OAAO;GAAE,GAAG;GAAO,OAAO;IAAE,GAAG,MAAM;KAAQ,EAAE,MAAM,EAAE;GAAM;EAAE;EACjE,KAAK,aAAa;GAChB,IAAI,EAAE,EAAE,OAAO,MAAM,QAAQ,OAAO;GACpC,MAAM,QAAQ,EAAE,GAAG,MAAM,MAAM;GAC/B,OAAO,MAAM,EAAE;GACf,OAAO;IAAE,GAAG;IAAO;GAAM;EAC3B;CACF;AACF;;;ACiDA,MAAa,aAAA,GAAA,eAAA,sBAAA,CAAkD,MAAM;;;;;;;;;;;;AC3CrE,MAAa,cAAc,YAAA,GAAA,eAAA,aAAA,CAC2B;CAClD,IAAI;CACJ,OAAO;CACP,OAAO;CACP,UAAU,CAACC,6BAAAA,gBAAgB;CAC3B,UAAU,CAACC,uBAAAA,YAAYC,4BAAAA,eAAe;CACtC,cAAc;CACd,QAAQ;CACR,aAAa,QAAQ,qBAAqB,KAAK,MAAM;CACrD,SAAS;CACT,OAAO,QAAQ;EACb,MAAM,cAAc,IAAI,IAAIF,6BAAAA,gBAAgB;EAC5C,MAAM,aAAa,IAAI,OAAOG,qCAAAA,eAAmB;EACjD,IAAI,YACF,WAAW,iBAAiB;GAC1B,IAAI;GACJ,UAAU,MAAM,EAAE,YAAY;GAC9B,eAAe,YAAY,WAAW,CAAC,EAAE,QAAQ,IAAI,UAAU,KAAK;EACtE,CAAC;CAEL;AACF,CAAC"}

package/dist/index.d.cts

@@ -0,0 +1,86 @@
+import { PageObjectNumber } from "@embedpdf/core";
+import { PdfDestination, PdfLinkTarget } from "@embedpdf/engine-core/runtime";
+import { LinkNavItem } from "@embedpdf/plugin-annotation";
+//#region src/types.d.ts
+/**
+ * What one activation did. `revealed` = the stage moved the camera;
+ * `destination` = no stage plugin — the embedder gets the explicit
+ * destination to handle; `uri` = opening is the FRAMEWORK layer's job (the
+ * plugin is DOM-free); `named` = a viewer verb (NextPage…) reported until
+ * stage verbs land; `reported` = read-only/executable-shaped targets
+ * (javascript / goto-remote / launch / unsupported) — surfaced, NEVER
+ * executed here (javascript belongs to the scripting orchestrator).
+ */
+type LinkActivation = {
+  outcome: 'revealed';
+} | {
+  outcome: 'destination';
+  destination: PdfDestination;
+} | {
+  outcome: 'uri';
+  uri: string;
+} | {
+  outcome: 'named';
+  name: string;
+} | {
+  outcome: 'reported';
+  target: PdfLinkTarget;
+} | {
+  outcome: 'none';
+};
+interface LinkActivateEvent {
+  target: PdfLinkTarget;
+  activation: LinkActivation;
+}
+interface LinkPluginConfig {
+  /** Every activation (navigations AND reported targets) — analytics /
+   *  custom handling. Called after the built-in handling ran. */
+  onActivate?: (event: LinkActivateEvent) => void;
+}
+/**
+ * The navigation plane of link annotations. Data comes from ONE of two
+ * sources, picked at init: the annotation plugin's folded model when that
+ * plugin is present (zero extra engine reads — it already lists every
+ * page), or the plugin's own engine reads in viewer-only deployments.
+ */
+interface LinkCapability {
+  /** The clickable link areas of a page (content space, y-down). */
+  linksOn(pon: PageObjectNumber): LinkNavItem[];
+  /** Lazy-load a page's links (no-op when the annotation plugin owns the data). */
+  ensurePage(pon: PageObjectNumber): void;
+  /** Whether the navigation plane currently owns links: the active tool
+   *  enables `link-nav` (pointer/pan/form-fill by default). While false —
+   *  the link tool or any authoring tool is active — the annotation plane
+   *  owns them and the LinkLayer stands down. */
+  engaged(): boolean;
+  /** THE one activation entry point (framework layers call it on click). */
+  activate(target: PdfLinkTarget): LinkActivation;
+}
+/** Engine-backed page cache (viewer-only deployments). */
+interface LinkState {
+  pages: Record<number, LinkNavItem[]>;
+}
+type LinkAction = {
+  type: 'SET_PAGE';
+  pon: number;
+  items: LinkNavItem[];
+} | {
+  type: 'DROP_PAGE';
+  pon: number;
+};
+declare const LinkToken: import("@embedpdf/core").CapabilityToken<LinkCapability>;
+//#endregion
+//#region src/link.plugin.d.ts
+/**
+ * The link plugin: the NAVIGATION plane. Document-scoped; requires only the
+ * interaction hub. Navigation works with no annotation plugin at all —
+ * links are read from the engine's link DTOs. When the annotation plugin IS
+ * present, its folded model becomes the data source (no double fetch) and a
+ * Behavior keeps links navigation-owned while a `link-nav` tool is active
+ * (pointer/pan/form-fill by default) — the single-active-tool hub IS the
+ * mode switch: grab the link tool and every link becomes an editable rect.
+ */
+declare const linkPlugin: (config?: LinkPluginConfig) => import("@embedpdf/core").PluginDef<LinkState, LinkAction, LinkCapability>;
+//#endregion
+export { type LinkActivateEvent, type LinkActivation, type LinkCapability, type LinkNavItem, type LinkPluginConfig, type LinkState, LinkToken, type PdfDestination, type PdfLinkTarget, linkPlugin };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -0,0 +1,86 @@
+import { PageObjectNumber } from "@embedpdf/core";
+import { LinkNavItem } from "@embedpdf/plugin-annotation";
+import { PdfDestination, PdfLinkTarget } from "@embedpdf/engine-core/runtime";
+//#region src/types.d.ts
+/**
+ * What one activation did. `revealed` = the stage moved the camera;
+ * `destination` = no stage plugin — the embedder gets the explicit
+ * destination to handle; `uri` = opening is the FRAMEWORK layer's job (the
+ * plugin is DOM-free); `named` = a viewer verb (NextPage…) reported until
+ * stage verbs land; `reported` = read-only/executable-shaped targets
+ * (javascript / goto-remote / launch / unsupported) — surfaced, NEVER
+ * executed here (javascript belongs to the scripting orchestrator).
+ */
+type LinkActivation = {
+  outcome: 'revealed';
+} | {
+  outcome: 'destination';
+  destination: PdfDestination;
+} | {
+  outcome: 'uri';
+  uri: string;
+} | {
+  outcome: 'named';
+  name: string;
+} | {
+  outcome: 'reported';
+  target: PdfLinkTarget;
+} | {
+  outcome: 'none';
+};
+interface LinkActivateEvent {
+  target: PdfLinkTarget;
+  activation: LinkActivation;
+}
+interface LinkPluginConfig {
+  /** Every activation (navigations AND reported targets) — analytics /
+   *  custom handling. Called after the built-in handling ran. */
+  onActivate?: (event: LinkActivateEvent) => void;
+}
+/**
+ * The navigation plane of link annotations. Data comes from ONE of two
+ * sources, picked at init: the annotation plugin's folded model when that
+ * plugin is present (zero extra engine reads — it already lists every
+ * page), or the plugin's own engine reads in viewer-only deployments.
+ */
+interface LinkCapability {
+  /** The clickable link areas of a page (content space, y-down). */
+  linksOn(pon: PageObjectNumber): LinkNavItem[];
+  /** Lazy-load a page's links (no-op when the annotation plugin owns the data). */
+  ensurePage(pon: PageObjectNumber): void;
+  /** Whether the navigation plane currently owns links: the active tool
+   *  enables `link-nav` (pointer/pan/form-fill by default). While false —
+   *  the link tool or any authoring tool is active — the annotation plane
+   *  owns them and the LinkLayer stands down. */
+  engaged(): boolean;
+  /** THE one activation entry point (framework layers call it on click). */
+  activate(target: PdfLinkTarget): LinkActivation;
+}
+/** Engine-backed page cache (viewer-only deployments). */
+interface LinkState {
+  pages: Record<number, LinkNavItem[]>;
+}
+type LinkAction = {
+  type: 'SET_PAGE';
+  pon: number;
+  items: LinkNavItem[];
+} | {
+  type: 'DROP_PAGE';
+  pon: number;
+};
+declare const LinkToken: import("@embedpdf/core").CapabilityToken<LinkCapability>;
+//#endregion
+//#region src/link.plugin.d.ts
+/**
+ * The link plugin: the NAVIGATION plane. Document-scoped; requires only the
+ * interaction hub. Navigation works with no annotation plugin at all —
+ * links are read from the engine's link DTOs. When the annotation plugin IS
+ * present, its folded model becomes the data source (no double fetch) and a
+ * Behavior keeps links navigation-owned while a `link-nav` tool is active
+ * (pointer/pan/form-fill by default) — the single-active-tool hub IS the
+ * mode switch: grab the link tool and every link becomes an editable rect.
+ */
+declare const linkPlugin: (config?: LinkPluginConfig) => import("@embedpdf/core").PluginDef<LinkState, LinkAction, LinkCapability>;
+//#endregion
+export { type LinkActivateEvent, type LinkActivation, type LinkCapability, type LinkNavItem, type LinkPluginConfig, type LinkState, LinkToken, type PdfDestination, type PdfLinkTarget, linkPlugin };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,194 @@
+import { createCapabilityToken, definePlugin } from "@embedpdf/core";
+import { InteractionToken } from "@embedpdf/plugin-interaction";
+import { StageToken, destinationToReveal } from "@embedpdf/plugin-stage";
+import { AnnotationToken } from "@embedpdf/plugin-annotation";
+import { AnnotationToken as AnnotationToken$1 } from "@embedpdf/plugin-annotation/internal";
+import { pdfToContentRect } from "@embedpdf/core-annotation";
+//#region src/source.ts
+function loadLinksPage(io, pon) {
+	const doc = io.doc;
+	const crop = io.document()?.pages.find((p) => p.pageObjectNumber === pon)?.boxes.crop;
+	if (!doc || !crop) return;
+	doc.page(pon).annotations.list().then((snap) => {
+		const items = [];
+		for (const dto of snap.annotations) {
+			if (dto.subtype !== "link" || dto.target == null) continue;
+			if (dto.flags.hidden || dto.flags.noView) continue;
+			items.push({
+				id: dto.ref.kind === "objectNumber" ? `obj:${dto.ref.annotObjectNumber}` : `idx:${pon}:${dto.index}`,
+				rect: pdfToContentRect(dto.rect, crop),
+				target: dto.target
+			});
+		}
+		io.dispatch({
+			type: "SET_PAGE",
+			pon,
+			items
+		});
+	}, () => {});
+}
+//#endregion
+//#region src/capability.ts
+const EMPTY = [];
+/**
+* The navigation plane's surface. Data source is decided PER CALL (lazily,
+* so plugin registration order can't matter): the annotation plugin's
+* folded model when present — its `linkItemsOn` lens is memoized by model
+* identity and already excludes hidden links — else this plugin's own
+* engine-backed page cache (see source.ts).
+*/
+function createLinkCapability(ctx, config = {}) {
+	const anno = () => ctx.tryGet(AnnotationToken$1);
+	const activate = (target) => {
+		const activation = (() => {
+			switch (target.kind) {
+				case "goto": {
+					const stage = ctx.tryGet(StageToken);
+					const layout = ctx.document()?.pages.find((p) => p.pageObjectNumber === target.destination.pageObjectNumber);
+					if (!stage || !layout) return {
+						outcome: "destination",
+						destination: target.destination
+					};
+					const { pageIndex, options } = destinationToReveal(target.destination, layout);
+					stage.reveal(pageIndex, {
+						...options,
+						behavior: "smooth"
+					});
+					return { outcome: "revealed" };
+				}
+				case "uri": return {
+					outcome: "uri",
+					uri: target.uri
+				};
+				case "named": return {
+					outcome: "named",
+					name: target.name
+				};
+				default: return {
+					outcome: "reported",
+					target
+				};
+			}
+		})();
+		config.onActivate?.({
+			target,
+			activation
+		});
+		return activation;
+	};
+	return {
+		linksOn: (pon) => {
+			const host = anno();
+			if (host) return host.linkItemsOn(pon);
+			return ctx.getState().pages[pon] ?? EMPTY;
+		},
+		ensurePage: (pon) => {
+			const host = anno();
+			if (host) {
+				host.ensurePage(pon);
+				return;
+			}
+			if (!(pon in ctx.getState().pages)) loadLinksPage(ctx, pon);
+		},
+		engaged: () => ctx.tryGet(InteractionToken)?.activeTool()?.enables.has("link-nav") ?? false,
+		activate
+	};
+}
+//#endregion
+//#region src/effects.ts
+/**
+* Keeps the ENGINE-BACKED page cache honest in viewer-only deployments:
+* any annotation mutation on a cached page (own or remote — the cache has
+* no other refresh path, unlike the annotation plugin's optimistic model)
+* refetches that page's links. With the annotation plugin present the
+* folded model is the source and this effect never fires a fetch.
+*/
+function registerLinkEffects(ctx) {
+	const doc = ctx.doc;
+	if (!doc) return;
+	const refetch = (pon) => {
+		if (ctx.tryGet(AnnotationToken$1)) return;
+		if (pon in ctx.getState().pages) loadLinksPage(ctx, pon);
+	};
+	const unsubscribe = doc.events.subscribe((event) => {
+		switch (event.type) {
+			case "annotation.created":
+				refetch(event.created.pageObjectNumber);
+				break;
+			case "annotation.updated":
+				refetch(event.updated.pageObjectNumber);
+				break;
+			case "annotation.moved":
+				if (event.moved.length) refetch(event.moved[0].pageObjectNumber);
+				break;
+			case "annotation.deleted":
+				refetch(event.pageObjectNumber);
+				break;
+			default: break;
+		}
+	});
+	ctx.cleanup(unsubscribe);
+}
+//#endregion
+//#region src/reducer.ts
+const initialLinkState = () => ({ pages: {} });
+/** Pure. Engine-backed page cache only — the annotation-backed mode reads the
+*  annotation plugin's model and never touches this state. */
+function linkReducer(state, a) {
+	switch (a.type) {
+		case "SET_PAGE": return {
+			...state,
+			pages: {
+				...state.pages,
+				[a.pon]: a.items
+			}
+		};
+		case "DROP_PAGE": {
+			if (!(a.pon in state.pages)) return state;
+			const pages = { ...state.pages };
+			delete pages[a.pon];
+			return {
+				...state,
+				pages
+			};
+		}
+	}
+}
+//#endregion
+//#region src/types.ts
+const LinkToken = createCapabilityToken("link");
+//#endregion
+//#region src/link.plugin.ts
+/**
+* The link plugin: the NAVIGATION plane. Document-scoped; requires only the
+* interaction hub. Navigation works with no annotation plugin at all —
+* links are read from the engine's link DTOs. When the annotation plugin IS
+* present, its folded model becomes the data source (no double fetch) and a
+* Behavior keeps links navigation-owned while a `link-nav` tool is active
+* (pointer/pan/form-fill by default) — the single-active-tool hub IS the
+* mode switch: grab the link tool and every link becomes an editable rect.
+*/
+const linkPlugin = (config) => definePlugin({
+	id: "link",
+	token: LinkToken,
+	scope: "document",
+	requires: [InteractionToken],
+	optional: [StageToken, AnnotationToken],
+	initialState: initialLinkState,
+	reduce: linkReducer,
+	capability: (ctx) => createLinkCapability(ctx, config),
+	effects: registerLinkEffects,
+	init: (ctx) => {
+		const interaction = ctx.get(InteractionToken);
+		const annotation = ctx.tryGet(AnnotationToken$1);
+		if (annotation) annotation.registerBehavior({
+			id: "link-nav",
+			matches: (a) => a.subtype === "link",
+			engaged: () => interaction.activeTool()?.enables.has("link-nav") ?? false
+		});
+	}
+});
+//#endregion
+export { LinkToken, linkPlugin };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["AnnotationHostToken","AnnotationHostToken","AnnotationHostToken"],"sources":["../src/source.ts","../src/capability.ts","../src/effects.ts","../src/reducer.ts","../src/types.ts","../src/link.plugin.ts"],"sourcesContent":["import type { DocumentHandle, PageLayout } from '@embedpdf/core';\nimport { pdfToContentRect } from '@embedpdf/core-annotation';\nimport type { LinkAction, LinkNavItem } from './types';\n\n/**\n * The ENGINE-BACKED link source, for viewer-only deployments (no annotation\n * plugin): read a page's annotation list and keep just the navigable links —\n * standalone AND attached children alike (both are raw link DTOs here).\n * Shared by the capability's lazy `ensurePage` and the effects module's\n * event-driven refetch; both PluginContext and EffectContext satisfy the\n * structural `io` slice.\n */\nexport interface LinkSourceIO {\n  doc: DocumentHandle | null;\n  document(): { pages: readonly PageLayout[] } | null;\n  dispatch(action: LinkAction): void;\n}\n\nexport function loadLinksPage(io: LinkSourceIO, pon: number): void {\n  const doc = io.doc;\n  const crop = io.document()?.pages.find((p) => p.pageObjectNumber === pon)?.boxes.crop;\n  if (!doc || !crop) return;\n  doc\n    .page(pon)\n    .annotations.list()\n    .then(\n      (snap) => {\n        const items: LinkNavItem[] = [];\n        for (const dto of snap.annotations) {\n          if (dto.subtype !== 'link' || dto.target == null) continue;\n          if (dto.flags.hidden || dto.flags.noView) continue;\n          items.push({\n            id:\n              dto.ref.kind === 'objectNumber'\n                ? `obj:${dto.ref.annotObjectNumber}`\n                : `idx:${pon}:${dto.index}`,\n            rect: pdfToContentRect(dto.rect, crop),\n            target: dto.target,\n          });\n        }\n        io.dispatch({ type: 'SET_PAGE', pon, items });\n      },\n      () => {},\n    );\n}\n","import type { PluginContext } from '@embedpdf/core';\nimport type { PdfLinkTarget } from '@embedpdf/engine-core/runtime';\nimport { InteractionToken } from '@embedpdf/plugin-interaction';\nimport { destinationToReveal, StageToken } from '@embedpdf/plugin-stage';\n// The host lens (linkItemsOn) — same runtime token as the public one.\nimport { AnnotationToken as AnnotationHostToken } from '@embedpdf/plugin-annotation/internal';\nimport { loadLinksPage } from './source';\nimport type {\n  LinkAction,\n  LinkActivation,\n  LinkCapability,\n  LinkNavItem,\n  LinkPluginConfig,\n  LinkState,\n} from './types';\n\nconst EMPTY: LinkNavItem[] = [];\n\n/**\n * The navigation plane's surface. Data source is decided PER CALL (lazily,\n * so plugin registration order can't matter): the annotation plugin's\n * folded model when present — its `linkItemsOn` lens is memoized by model\n * identity and already excludes hidden links — else this plugin's own\n * engine-backed page cache (see source.ts).\n */\nexport function createLinkCapability(\n  ctx: PluginContext<LinkState, LinkAction>,\n  config: LinkPluginConfig = {},\n): LinkCapability {\n  const anno = () => ctx.tryGet(AnnotationHostToken);\n\n  const activate = (target: PdfLinkTarget): LinkActivation => {\n    const activation = ((): LinkActivation => {\n      switch (target.kind) {\n        case 'goto': {\n          const stage = ctx.tryGet(StageToken);\n          const layout = ctx\n            .document()\n            ?.pages.find((p) => p.pageObjectNumber === target.destination.pageObjectNumber);\n          if (!stage || !layout) {\n            // No camera to drive — hand the embedder the explicit destination.\n            return { outcome: 'destination', destination: target.destination };\n          }\n          const { pageIndex, options } = destinationToReveal(target.destination, layout);\n          stage.reveal(pageIndex, { ...options, behavior: 'smooth' });\n          return { outcome: 'revealed' };\n        }\n        case 'uri':\n          // Opening is the FRAMEWORK layer's job (a real <a href> after\n          // sanitizing) — this plugin never touches the DOM.\n          return { outcome: 'uri', uri: target.uri };\n        case 'named':\n          return { outcome: 'named', name: target.name };\n        default:\n          // javascript / goto-remote / launch / unsupported: reported, never\n          // executed here. JavaScript activation belongs to the scripting\n          // orchestrator once it lands — the chain already rides the\n          // annotation's base `actions`.\n          return { outcome: 'reported', target };\n      }\n    })();\n    config.onActivate?.({ target, activation });\n    return activation;\n  };\n\n  return {\n    linksOn: (pon) => {\n      const host = anno();\n      if (host) return host.linkItemsOn(pon);\n      return ctx.getState().pages[pon] ?? EMPTY;\n    },\n    ensurePage: (pon) => {\n      const host = anno();\n      if (host) {\n        host.ensurePage(pon); // the folded model is the source; it lazy-loads\n        return;\n      }\n      if (!(pon in ctx.getState().pages)) loadLinksPage(ctx, pon);\n    },\n    engaged: () => ctx.tryGet(InteractionToken)?.activeTool()?.enables.has('link-nav') ?? false,\n    activate,\n  };\n}\n","import type { DocumentEvent, EffectContext } from '@embedpdf/core';\nimport { AnnotationToken as AnnotationHostToken } from '@embedpdf/plugin-annotation/internal';\nimport { loadLinksPage } from './source';\nimport type { LinkAction, LinkState } from './types';\n\n/**\n * Keeps the ENGINE-BACKED page cache honest in viewer-only deployments:\n * any annotation mutation on a cached page (own or remote — the cache has\n * no other refresh path, unlike the annotation plugin's optimistic model)\n * refetches that page's links. With the annotation plugin present the\n * folded model is the source and this effect never fires a fetch.\n */\nexport function registerLinkEffects(ctx: EffectContext<LinkState, LinkAction>): void {\n  const doc = ctx.doc;\n  if (!doc) return;\n\n  const refetch = (pon: number): void => {\n    if (ctx.tryGet(AnnotationHostToken)) return; // annotation model owns the data\n    if (pon in ctx.getState().pages) loadLinksPage(ctx, pon);\n  };\n\n  const unsubscribe = doc.events.subscribe((event: DocumentEvent) => {\n    switch (event.type) {\n      case 'annotation.created':\n        refetch(event.created.pageObjectNumber);\n        break;\n      case 'annotation.updated':\n        refetch(event.updated.pageObjectNumber);\n        break;\n      case 'annotation.moved':\n        if (event.moved.length) refetch(event.moved[0].pageObjectNumber);\n        break;\n      case 'annotation.deleted':\n        refetch(event.pageObjectNumber);\n        break;\n      default:\n        break;\n    }\n  });\n  ctx.cleanup(unsubscribe);\n}\n","import type { LinkAction, LinkState } from './types';\n\nexport const initialLinkState = (): LinkState => ({ pages: {} });\n\n/** Pure. Engine-backed page cache only — the annotation-backed mode reads the\n *  annotation plugin's model and never touches this state. */\nexport function linkReducer(state: LinkState, a: LinkAction): LinkState {\n  switch (a.type) {\n    case 'SET_PAGE':\n      return { ...state, pages: { ...state.pages, [a.pon]: a.items } };\n    case 'DROP_PAGE': {\n      if (!(a.pon in state.pages)) return state;\n      const pages = { ...state.pages };\n      delete pages[a.pon];\n      return { ...state, pages };\n    }\n  }\n}\n","import { createCapabilityToken, type PageObjectNumber } from '@embedpdf/core';\nimport type { PdfDestination, PdfLinkTarget } from '@embedpdf/engine-core/runtime';\nimport type { LinkNavItem } from '@embedpdf/plugin-annotation';\n\nexport type { LinkNavItem };\n// The wire target vocabulary, re-exported so app code building link editors\n// needs only this package (the annotation-props precedent).\nexport type { PdfDestination, PdfLinkTarget };\n\n/**\n * What one activation did. `revealed` = the stage moved the camera;\n * `destination` = no stage plugin — the embedder gets the explicit\n * destination to handle; `uri` = opening is the FRAMEWORK layer's job (the\n * plugin is DOM-free); `named` = a viewer verb (NextPage…) reported until\n * stage verbs land; `reported` = read-only/executable-shaped targets\n * (javascript / goto-remote / launch / unsupported) — surfaced, NEVER\n * executed here (javascript belongs to the scripting orchestrator).\n */\nexport type LinkActivation =\n  | { outcome: 'revealed' }\n  | { outcome: 'destination'; destination: PdfDestination }\n  | { outcome: 'uri'; uri: string }\n  | { outcome: 'named'; name: string }\n  | { outcome: 'reported'; target: PdfLinkTarget }\n  | { outcome: 'none' };\n\nexport interface LinkActivateEvent {\n  target: PdfLinkTarget;\n  activation: LinkActivation;\n}\n\nexport interface LinkPluginConfig {\n  /** Every activation (navigations AND reported targets) — analytics /\n   *  custom handling. Called after the built-in handling ran. */\n  onActivate?: (event: LinkActivateEvent) => void;\n}\n\n/**\n * The navigation plane of link annotations. Data comes from ONE of two\n * sources, picked at init: the annotation plugin's folded model when that\n * plugin is present (zero extra engine reads — it already lists every\n * page), or the plugin's own engine reads in viewer-only deployments.\n */\nexport interface LinkCapability {\n  /** The clickable link areas of a page (content space, y-down). */\n  linksOn(pon: PageObjectNumber): LinkNavItem[];\n  /** Lazy-load a page's links (no-op when the annotation plugin owns the data). */\n  ensurePage(pon: PageObjectNumber): void;\n  /** Whether the navigation plane currently owns links: the active tool\n   *  enables `link-nav` (pointer/pan/form-fill by default). While false —\n   *  the link tool or any authoring tool is active — the annotation plane\n   *  owns them and the LinkLayer stands down. */\n  engaged(): boolean;\n  /** THE one activation entry point (framework layers call it on click). */\n  activate(target: PdfLinkTarget): LinkActivation;\n}\n\n/** Engine-backed page cache (viewer-only deployments). */\nexport interface LinkState {\n  pages: Record<number, LinkNavItem[]>;\n}\n\nexport type LinkAction =\n  | { type: 'SET_PAGE'; pon: number; items: LinkNavItem[] }\n  | { type: 'DROP_PAGE'; pon: number };\n\nexport const LinkToken = createCapabilityToken<LinkCapability>('link');\n","import { definePlugin } from '@embedpdf/core';\nimport { InteractionToken } from '@embedpdf/plugin-interaction';\nimport { StageToken } from '@embedpdf/plugin-stage';\nimport { AnnotationToken } from '@embedpdf/plugin-annotation';\n// Behavior registration lives on the HOST capability (framework/plugin\n// surface) — same runtime token, wider type. The form plugin's precedent.\nimport { AnnotationToken as AnnotationHostToken } from '@embedpdf/plugin-annotation/internal';\n\nimport { createLinkCapability } from './capability';\nimport { registerLinkEffects } from './effects';\nimport { initialLinkState, linkReducer } from './reducer';\nimport { LinkToken } from './types';\nimport type { LinkAction, LinkCapability, LinkPluginConfig, LinkState } from './types';\n\n/**\n * The link plugin: the NAVIGATION plane. Document-scoped; requires only the\n * interaction hub. Navigation works with no annotation plugin at all —\n * links are read from the engine's link DTOs. When the annotation plugin IS\n * present, its folded model becomes the data source (no double fetch) and a\n * Behavior keeps links navigation-owned while a `link-nav` tool is active\n * (pointer/pan/form-fill by default) — the single-active-tool hub IS the\n * mode switch: grab the link tool and every link becomes an editable rect.\n */\nexport const linkPlugin = (config?: LinkPluginConfig) =>\n  definePlugin<LinkState, LinkAction, LinkCapability>({\n    id: 'link',\n    token: LinkToken,\n    scope: 'document',\n    requires: [InteractionToken],\n    optional: [StageToken, AnnotationToken],\n    initialState: initialLinkState,\n    reduce: linkReducer,\n    capability: (ctx) => createLinkCapability(ctx, config),\n    effects: registerLinkEffects,\n    init: (ctx) => {\n      const interaction = ctx.get(InteractionToken);\n      const annotation = ctx.tryGet(AnnotationHostToken);\n      if (annotation) {\n        annotation.registerBehavior({\n          id: 'link-nav',\n          matches: (a) => a.subtype === 'link',\n          engaged: () => interaction.activeTool()?.enables.has('link-nav') ?? false,\n        });\n      }\n    },\n  });\n"],"mappings":";;;;;;;AAkBA,SAAgB,cAAc,IAAkB,KAAmB;CACjE,MAAM,MAAM,GAAG;CACf,MAAM,OAAO,GAAG,SAAS,CAAC,EAAE,MAAM,MAAM,MAAM,EAAE,qBAAqB,GAAG,CAAC,EAAE,MAAM;CACjF,IAAI,CAAC,OAAO,CAAC,MAAM;CACnB,IACG,KAAK,GAAG,CAAC,CACT,YAAY,KAAK,CAAC,CAClB,MACE,SAAS;EACR,MAAM,QAAuB,CAAC;EAC9B,KAAK,MAAM,OAAO,KAAK,aAAa;GAClC,IAAI,IAAI,YAAY,UAAU,IAAI,UAAU,MAAM;GAClD,IAAI,IAAI,MAAM,UAAU,IAAI,MAAM,QAAQ;GAC1C,MAAM,KAAK;IACT,IACE,IAAI,IAAI,SAAS,iBACb,OAAO,IAAI,IAAI,sBACf,OAAO,IAAI,GAAG,IAAI;IACxB,MAAM,iBAAiB,IAAI,MAAM,IAAI;IACrC,QAAQ,IAAI;GACd,CAAC;EACH;EACA,GAAG,SAAS;GAAE,MAAM;GAAY;GAAK;EAAM,CAAC;CAC9C,SACM,CAAC,CACT;AACJ;;;AC5BA,MAAM,QAAuB,CAAC;;;;;;;;AAS9B,SAAgB,qBACd,KACA,SAA2B,CAAC,GACZ;CAChB,MAAM,aAAa,IAAI,OAAOA,iBAAmB;CAEjD,MAAM,YAAY,WAA0C;EAC1D,MAAM,oBAAoC;GACxC,QAAQ,OAAO,MAAf;IACE,KAAK,QAAQ;KACX,MAAM,QAAQ,IAAI,OAAO,UAAU;KACnC,MAAM,SAAS,IACZ,SAAS,CAAC,EACT,MAAM,MAAM,MAAM,EAAE,qBAAqB,OAAO,YAAY,gBAAgB;KAChF,IAAI,CAAC,SAAS,CAAC,QAEb,OAAO;MAAE,SAAS;MAAe,aAAa,OAAO;KAAY;KAEnE,MAAM,EAAE,WAAW,YAAY,oBAAoB,OAAO,aAAa,MAAM;KAC7E,MAAM,OAAO,WAAW;MAAE,GAAG;MAAS,UAAU;KAAS,CAAC;KAC1D,OAAO,EAAE,SAAS,WAAW;IAC/B;IACA,KAAK,OAGH,OAAO;KAAE,SAAS;KAAO,KAAK,OAAO;IAAI;IAC3C,KAAK,SACH,OAAO;KAAE,SAAS;KAAS,MAAM,OAAO;IAAK;IAC/C,SAKE,OAAO;KAAE,SAAS;KAAY;IAAO;GACzC;EACF,EAAA,CAAG;EACH,OAAO,aAAa;GAAE;GAAQ;EAAW,CAAC;EAC1C,OAAO;CACT;CAEA,OAAO;EACL,UAAU,QAAQ;GAChB,MAAM,OAAO,KAAK;GAClB,IAAI,MAAM,OAAO,KAAK,YAAY,GAAG;GACrC,OAAO,IAAI,SAAS,CAAC,CAAC,MAAM,QAAQ;EACtC;EACA,aAAa,QAAQ;GACnB,MAAM,OAAO,KAAK;GAClB,IAAI,MAAM;IACR,KAAK,WAAW,GAAG;IACnB;GACF;GACA,IAAI,EAAE,OAAO,IAAI,SAAS,CAAC,CAAC,QAAQ,cAAc,KAAK,GAAG;EAC5D;EACA,eAAe,IAAI,OAAO,gBAAgB,CAAC,EAAE,WAAW,CAAC,EAAE,QAAQ,IAAI,UAAU,KAAK;EACtF;CACF;AACF;;;;;;;;;;ACtEA,SAAgB,oBAAoB,KAAiD;CACnF,MAAM,MAAM,IAAI;CAChB,IAAI,CAAC,KAAK;CAEV,MAAM,WAAW,QAAsB;EACrC,IAAI,IAAI,OAAOC,iBAAmB,GAAG;EACrC,IAAI,OAAO,IAAI,SAAS,CAAC,CAAC,OAAO,cAAc,KAAK,GAAG;CACzD;CAEA,MAAM,cAAc,IAAI,OAAO,WAAW,UAAyB;EACjE,QAAQ,MAAM,MAAd;GACE,KAAK;IACH,QAAQ,MAAM,QAAQ,gBAAgB;IACtC;GACF,KAAK;IACH,QAAQ,MAAM,QAAQ,gBAAgB;IACtC;GACF,KAAK;IACH,IAAI,MAAM,MAAM,QAAQ,QAAQ,MAAM,MAAM,EAAE,CAAC,gBAAgB;IAC/D;GACF,KAAK;IACH,QAAQ,MAAM,gBAAgB;IAC9B;GACF,SACE;EACJ;CACF,CAAC;CACD,IAAI,QAAQ,WAAW;AACzB;;;ACtCA,MAAa,0BAAqC,EAAE,OAAO,CAAC,EAAE;;;AAI9D,SAAgB,YAAY,OAAkB,GAA0B;CACtE,QAAQ,EAAE,MAAV;EACE,KAAK,YACH,OAAO;GAAE,GAAG;GAAO,OAAO;IAAE,GAAG,MAAM;KAAQ,EAAE,MAAM,EAAE;GAAM;EAAE;EACjE,KAAK,aAAa;GAChB,IAAI,EAAE,EAAE,OAAO,MAAM,QAAQ,OAAO;GACpC,MAAM,QAAQ,EAAE,GAAG,MAAM,MAAM;GAC/B,OAAO,MAAM,EAAE;GACf,OAAO;IAAE,GAAG;IAAO;GAAM;EAC3B;CACF;AACF;;;ACiDA,MAAa,YAAY,sBAAsC,MAAM;;;;;;;;;;;;AC3CrE,MAAa,cAAc,WACzB,aAAoD;CAClD,IAAI;CACJ,OAAO;CACP,OAAO;CACP,UAAU,CAAC,gBAAgB;CAC3B,UAAU,CAAC,YAAY,eAAe;CACtC,cAAc;CACd,QAAQ;CACR,aAAa,QAAQ,qBAAqB,KAAK,MAAM;CACrD,SAAS;CACT,OAAO,QAAQ;EACb,MAAM,cAAc,IAAI,IAAI,gBAAgB;EAC5C,MAAM,aAAa,IAAI,OAAOC,iBAAmB;EACjD,IAAI,YACF,WAAW,iBAAiB;GAC1B,IAAI;GACJ,UAAU,MAAM,EAAE,YAAY;GAC9B,eAAe,YAAY,WAAW,CAAC,EAAE,QAAQ,IAAI,UAAU,KAAK;EACtE,CAAC;CAEL;AACF,CAAC"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@embedpdf/plugin-link",
+  "version": "3.0.0-next.0",
+  "private": false,
+  "description": "The navigation plane for PDF link annotations: per-page clickable link areas + one activate() entry point (GoTo → stage reveal, URI → framework opener). Works standalone in viewer deployments; with the annotation plugin present it reads the folded model (no double fetch) and a Behavior hands links to the editing plane when the link tool is active.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@embedpdf/core-annotation": "3.0.0-next.0",
+    "@embedpdf/core-geometry": "3.0.0-next.0",
+    "@embedpdf/core": "3.0.0-next.0",
+    "@embedpdf/plugin-annotation": "3.0.0-next.0",
+    "@embedpdf/plugin-interaction": "3.0.0-next.0",
+    "@embedpdf/engine-core": "3.0.0-next.0",
+    "@embedpdf/plugin-stage": "3.0.0-next.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0",
+    "vitest": "^2.1.9",
+    "@embedpdf/tooling-build": "0.0.0"
+  },
+  "license": "Apache-2.0",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/embedpdf/embed-pdf-viewer.git",
+    "directory": "packages/plugin/link"
+  },
+  "scripts": {
+    "build": "epdf-build",
+    "clean": "rimraf dist",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run --passWithNoTests"
+  }
+}