@embedpdf/plugin-link 3.0.0-next.14 → 3.0.0-next.16

package/dist/contract/host.cjs

@@ -0,0 +1,10 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_contract = require("../contract-DXB_v4as.cjs");
+//#region src/host-contract.ts
+/** @embedpdf/plugin-link/contract/host: the host lens, the public capability plus what a framework binding supplies. */
+const LinkToken = (0, require("@embedpdf/core").createHostToken)(require_contract.LinkToken);
+//#endregion
+exports.LinkToken = LinkToken;
+exports.resolveLinkTarget = require_contract.resolveLinkTarget;
+
+//# sourceMappingURL=host.cjs.map

package/dist/contract/host.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"host.cjs","names":["PublicLinkToken"],"sources":["../../src/host-contract.ts"],"sourcesContent":["/** @embedpdf/plugin-link/contract/host: the host lens, the public capability plus what a framework binding supplies. */\nimport { createHostToken, type Unsubscribe } from '@embedpdf/core';\n\nimport type { LinkCapability } from './contract';\nimport { LinkToken as PublicLinkToken } from './token';\n\nexport * from './contract';\n\n/**\n * Opens a website for `activate()`, in the user's gesture. Returns whether it\n * opened: false for an address it won't open (a `javascript:` or `file:`\n * URI), which activation then reports.\n */\nexport type UriOpener = (uri: string) => boolean;\n\nexport interface LinkHostCapability extends LinkCapability {\n  /** Does the active tool navigate links (the layer paints anchors only then)? */\n  isNavigationEngaged(): boolean;\n  /**\n   * Register the framework's website opener. The plugin never touches the\n   * DOM: without an opener, a website link activates as `{ outcome: 'uri' }`\n   * for the caller to open. The latest registration wins until it is removed.\n   */\n  registerUriOpener(opener: UriOpener): Unsubscribe;\n}\n\nexport const LinkToken = createHostToken<LinkHostCapability>(PublicLinkToken);\n"],"mappings":";;;;AA0BA,MAAa,aAAA,2BAAA,CAAA,CAAA,gBAAA,CAAgDA,iBAAAA,SAAe"}

package/dist/contract/host.d.cts

@@ -0,0 +1,3 @@
+import { a as LinkCapability, c as PageDestination, i as LinkActivation, l as PdfLinkTarget, n as LinkActivateContext, o as LinkLoadedEvent, r as LinkActivatedEvent, s as LinkResolution, t as Link, u as resolveLinkTarget } from "../contract-B4x0DFCT.cjs";
+import { n as LinkToken, r as UriOpener, t as LinkHostCapability } from "../host-contract-c0QOjhO6.cjs";
+export { Link, LinkActivateContext, LinkActivatedEvent, LinkActivation, LinkCapability, LinkHostCapability, LinkLoadedEvent, LinkResolution, LinkToken, type PageDestination, type PdfLinkTarget, UriOpener, resolveLinkTarget };

package/dist/contract/host.d.ts

@@ -0,0 +1,3 @@
+import { a as LinkCapability, c as PageDestination, i as LinkActivation, l as PdfLinkTarget, n as LinkActivateContext, o as LinkLoadedEvent, r as LinkActivatedEvent, s as LinkResolution, t as Link, u as resolveLinkTarget } from "../contract-DyTXDEwb.js";
+import { n as LinkToken, r as UriOpener, t as LinkHostCapability } from "../host-contract-DNwp7dlr.js";
+export { Link, LinkActivateContext, LinkActivatedEvent, LinkActivation, LinkCapability, LinkHostCapability, LinkLoadedEvent, LinkResolution, LinkToken, type PageDestination, type PdfLinkTarget, UriOpener, resolveLinkTarget };

package/dist/contract/host.js

@@ -0,0 +1,9 @@
+import { n as LinkToken$1, t as resolveLinkTarget } from "../contract-CJ9mhj7i.js";
+import { createHostToken } from "@embedpdf/core";
+//#region src/host-contract.ts
+/** @embedpdf/plugin-link/contract/host: the host lens, the public capability plus what a framework binding supplies. */
+const LinkToken = createHostToken(LinkToken$1);
+//#endregion
+export { LinkToken, resolveLinkTarget };
+
+//# sourceMappingURL=host.js.map

package/dist/contract/host.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"host.js","names":["PublicLinkToken"],"sources":["../../src/host-contract.ts"],"sourcesContent":["/** @embedpdf/plugin-link/contract/host: the host lens, the public capability plus what a framework binding supplies. */\nimport { createHostToken, type Unsubscribe } from '@embedpdf/core';\n\nimport type { LinkCapability } from './contract';\nimport { LinkToken as PublicLinkToken } from './token';\n\nexport * from './contract';\n\n/**\n * Opens a website for `activate()`, in the user's gesture. Returns whether it\n * opened: false for an address it won't open (a `javascript:` or `file:`\n * URI), which activation then reports.\n */\nexport type UriOpener = (uri: string) => boolean;\n\nexport interface LinkHostCapability extends LinkCapability {\n  /** Does the active tool navigate links (the layer paints anchors only then)? */\n  isNavigationEngaged(): boolean;\n  /**\n   * Register the framework's website opener. The plugin never touches the\n   * DOM: without an opener, a website link activates as `{ outcome: 'uri' }`\n   * for the caller to open. The latest registration wins until it is removed.\n   */\n  registerUriOpener(opener: UriOpener): Unsubscribe;\n}\n\nexport const LinkToken = createHostToken<LinkHostCapability>(PublicLinkToken);\n"],"mappings":";;;;AA0BA,MAAa,YAAY,gBAAoCA,WAAe"}

package/dist/contract-B4x0DFCT.d.cts

@@ -0,0 +1,143 @@
+import { EventHook, OperationOptions, PageRef, ResourceStatus } from "@embedpdf/core";
+import { Point } from "@embedpdf/core-geometry";
+import { AnnotationRef, PageDestination, PdfActionTree, PdfLinkTarget } from "@embedpdf/engine-core/runtime";
+import { ActionDispatchResult } from "@embedpdf/plugin-actions/contract";
+import { LinkNavItem } from "@embedpdf/plugin-annotation/contract";
+import { StageCapability } from "@embedpdf/plugin-stage/contract";
+//#region src/token.d.ts
+declare const LinkToken: import("@embedpdf/core").CapabilityToken<LinkCapability>;
+//#endregion
+//#region src/contract.d.ts
+/**
+ * A clickable link area: page-space `bounds`, its target, and its annotation
+ * (when it is one). The target and `/A` tree are as the annotation holds
+ * them, their destinations in page space.
+ */
+type Link = LinkNavItem;
+/**
+ * What activation did: `revealed` (the view went to a page), `uri` (a website
+ * opened), `dispatched` (the actions plugin runs the link's action), or
+ * `reported` (a link it won't follow). `destination`, `named` and a `uri`
+ * with no framework to open it are handed to the caller to perform.
+ */
+type LinkActivation = {
+  outcome: 'revealed';
+} | {
+  outcome: 'destination';
+  destination: PageDestination;
+} | {
+  outcome: 'uri';
+  uri: string;
+} | {
+  outcome: 'named';
+  name: string;
+} | {
+  outcome: 'reported';
+  target: PdfLinkTarget;
+} | {
+  outcome: 'dispatched';
+  dispatch: Promise<ActionDispatchResult>;
+} | {
+  outcome: 'none';
+};
+/**
+ * What activating a target would do, with no side effect. A `goto` to a page
+ * of this document is its destination, ready for `stage.goToDestination`;
+ * one to a page the document doesn't have is reported.
+ */
+type LinkResolution = {
+  kind: 'destination';
+  destination: PageDestination;
+} | {
+  kind: 'uri';
+  uri: string;
+} | {
+  kind: 'named';
+  name: string;
+} | {
+  kind: 'reported';
+  target: PdfLinkTarget;
+};
+/**
+ * What activating a target would do, by the rule every link and outline item
+ * follows: a `goto` to a page `hasPage` knows is its destination, one to a
+ * page the document doesn't have is reported; a website and a named verb are
+ * handed on; anything else is reported.
+ */
+declare function resolveLinkTarget(target: PdfLinkTarget, hasPage: (page: PageRef) => boolean): LinkResolution;
+interface LinkActivateContext {
+  /** The link's `/A` tree when it has one; the actions plugin runs it instead of the target. */
+  activate?: PdfActionTree;
+  ref?: AnnotationRef;
+  page?: PageRef;
+  /**
+   * The view the link was followed in: a page destination moves this Stage.
+   * Defaults to the main view.
+   */
+  stage?: StageCapability;
+}
+/** A link target was activated through this capability. */
+interface LinkActivatedEvent {
+  readonly target: PdfLinkTarget;
+  readonly activation: LinkActivation;
+}
+/** A page's links were read from the engine. */
+interface LinkLoadedEvent {
+  readonly page: PageRef;
+}
+interface LinkCapability {
+  /**
+   * Clickable areas on a page (its ref or its index), page space.
+   * Reference-stable per page while unchanged; empty for a page that isn't in
+   * the document.
+   */
+  listLinks(page: PageRef | number): readonly Link[];
+  /** One link by its stable id, or null. */
+  getLink(page: PageRef | number, linkId: string): Link | null;
+  /** The topmost (smallest) link under a page point, or null. */
+  getLinkAt(page: PageRef | number, point: Point): Link | null;
+  /**
+   * Every link in the document; loads pages as needed. Rejects when a page's
+   * read fails, and `operation-cancelled` when `signal` fires.
+   */
+  listAllLinks(options?: OperationOptions): Promise<readonly Link[]>;
+  /**
+   * Load a page's links. Resolves at once when the annotation plugin owns
+   * them; rejects when the read fails, which `getStatus(page)` then reports,
+   * `not-found` for a page that isn't in the document, and
+   * `operation-cancelled` when `signal` fires.
+   */
+  ensureLoaded(page: PageRef | number, options?: OperationOptions): Promise<void>;
+  /** The page's links were read and are current. Always true with the annotation plugin. */
+  isLoaded(page: PageRef | number): boolean;
+  /** Load state of a page's links: `idle`, `loading`, `ready`, `error` or `forbidden`. */
+  getStatus(page: PageRef | number): ResourceStatus;
+  /** What activation would do, with no side effect. */
+  resolve(target: PdfLinkTarget): LinkResolution;
+  /**
+   * Follow a link, or a link's target, as a click does, and return what
+   * happened at once (the user's gesture is still on the stack, so a website
+   * can open in a new tab). A `goto` moves the Stage, by its `scrollBehavior`
+   * setting; a website opens through the framework (an `http`, `https`,
+   * `mailto` or `tel` address only); a link with an `/A` tree dispatches
+   * through the actions plugin. Fires `onActivated`.
+   */
+  activate(target: PdfLinkTarget | Link, context?: LinkActivateContext): LinkActivation;
+  /**
+   * Hit test, then activate. Null when no link is there; throws `not-found`
+   * for a page that isn't in the document.
+   */
+  activateAt(page: PageRef | number, point: Point, context?: LinkActivateContext): LinkActivation | null;
+  /** A human label for tooltips. */
+  getLabel(link: Link | PdfLinkTarget): string;
+  /** After the built-in handling of any activation. */
+  readonly onActivated: EventHook<LinkActivatedEvent>;
+  /**
+   * A page's links were read, first or again after an annotation change on
+   * it. Never fires for a failed read, nor while the annotation plugin owns the links.
+   */
+  readonly onLoaded: EventHook<LinkLoadedEvent>;
+}
+//#endregion
+export { LinkCapability as a, PageDestination as c, LinkToken as d, LinkActivation as i, PdfLinkTarget as l, LinkActivateContext as n, LinkLoadedEvent as o, LinkActivatedEvent as r, LinkResolution as s, Link as t, resolveLinkTarget as u };
+//# sourceMappingURL=contract-B4x0DFCT.d.cts.map

package/dist/contract-CJ9mhj7i.js

@@ -0,0 +1,46 @@
+import { createCapabilityToken } from "@embedpdf/core";
+//#region src/token.ts
+/** The package token, created once here: `contract.ts` re-exports it and
+*  `host-contract.ts` widens it to the host capability. */
+const LinkToken = createCapabilityToken("link", {
+	hint: `add linkPlugin() from '@embedpdf/plugin-link' to your plugins list`,
+	promises: {
+		listAllLinks: true,
+		ensureLoaded: true
+	}
+});
+//#endregion
+//#region src/contract.ts
+/**
+* What activating a target would do, by the rule every link and outline item
+* follows: a `goto` to a page `hasPage` knows is its destination, one to a
+* page the document doesn't have is reported; a website and a named verb are
+* handed on; anything else is reported.
+*/
+function resolveLinkTarget(target, hasPage) {
+	switch (target.kind) {
+		case "goto": return hasPage(target.destination.page) ? {
+			kind: "destination",
+			destination: target.destination
+		} : {
+			kind: "reported",
+			target
+		};
+		case "uri": return {
+			kind: "uri",
+			uri: target.uri
+		};
+		case "named": return {
+			kind: "named",
+			name: target.name
+		};
+		default: return {
+			kind: "reported",
+			target
+		};
+	}
+}
+//#endregion
+export { LinkToken as n, resolveLinkTarget as t };
+
+//# sourceMappingURL=contract-CJ9mhj7i.js.map

package/dist/contract-CJ9mhj7i.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract-CJ9mhj7i.js","names":[],"sources":["../src/token.ts","../src/contract.ts"],"sourcesContent":["/** The package token, created once here: `contract.ts` re-exports it and\n *  `host-contract.ts` widens it to the host capability. */\nimport { createCapabilityToken } from '@embedpdf/core';\n\nimport type { LinkCapability } from './contract';\n\nexport const LinkToken = createCapabilityToken<LinkCapability>('link', {\n  hint: `add linkPlugin() from '@embedpdf/plugin-link' to your plugins list`,\n  // Without a document, an adapter's stand-in rejects these with `not-ready`, as the\n  // capability would; the type asks for every member that returns a promise.\n  promises: {\n    listAllLinks: true,\n    ensureLoaded: true,\n  },\n});\n","/** @embedpdf/plugin-link/contract: the public link vocabulary. */\nimport type { EventHook, OperationOptions, PageRef, ResourceStatus } from '@embedpdf/core';\nimport type { Point } from '@embedpdf/core-geometry';\nimport type {\n  AnnotationRef,\n  PageDestination,\n  PdfActionTree,\n  PdfLinkTarget,\n} from '@embedpdf/engine-core/runtime';\nimport type { ActionDispatchResult } from '@embedpdf/plugin-actions/contract';\nimport type { LinkNavItem } from '@embedpdf/plugin-annotation/contract';\nimport type { StageCapability } from '@embedpdf/plugin-stage/contract';\n\nexport { LinkToken } from './token';\n\n/**\n * A clickable link area: page-space `bounds`, its target, and its annotation\n * (when it is one). The target and `/A` tree are as the annotation holds\n * them, their destinations in page space.\n */\nexport type Link = LinkNavItem;\nexport type { PageDestination, PdfLinkTarget };\n\n/**\n * What activation did: `revealed` (the view went to a page), `uri` (a website\n * opened), `dispatched` (the actions plugin runs the link's action), or\n * `reported` (a link it won't follow). `destination`, `named` and a `uri`\n * with no framework to open it are handed to the caller to perform.\n */\nexport type LinkActivation =\n  | { outcome: 'revealed' }\n  | { outcome: 'destination'; destination: PageDestination }\n  | { outcome: 'uri'; uri: string }\n  | { outcome: 'named'; name: string }\n  | { outcome: 'reported'; target: PdfLinkTarget }\n  | { outcome: 'dispatched'; dispatch: Promise<ActionDispatchResult> }\n  | { outcome: 'none' };\n\n/**\n * What activating a target would do, with no side effect. A `goto` to a page\n * of this document is its destination, ready for `stage.goToDestination`;\n * one to a page the document doesn't have is reported.\n */\nexport type LinkResolution =\n  | { kind: 'destination'; destination: PageDestination }\n  | { kind: 'uri'; uri: string }\n  | { kind: 'named'; name: string }\n  | { kind: 'reported'; target: PdfLinkTarget };\n\n/**\n * What activating a target would do, by the rule every link and outline item\n * follows: a `goto` to a page `hasPage` knows is its destination, one to a\n * page the document doesn't have is reported; a website and a named verb are\n * handed on; anything else is reported.\n */\nexport function resolveLinkTarget(\n  target: PdfLinkTarget,\n  hasPage: (page: PageRef) => boolean,\n): LinkResolution {\n  switch (target.kind) {\n    case 'goto':\n      return hasPage(target.destination.page)\n        ? { kind: 'destination', destination: target.destination }\n        : { kind: 'reported', target };\n    case 'uri':\n      return { kind: 'uri', uri: target.uri };\n    case 'named':\n      return { kind: 'named', name: target.name };\n    default:\n      return { kind: 'reported', target };\n  }\n}\n\nexport interface LinkActivateContext {\n  /** The link's `/A` tree when it has one; the actions plugin runs it instead of the target. */\n  activate?: PdfActionTree;\n  ref?: AnnotationRef;\n  page?: PageRef;\n  /**\n   * The view the link was followed in: a page destination moves this Stage.\n   * Defaults to the main view.\n   */\n  stage?: StageCapability;\n}\n\n/** A link target was activated through this capability. */\nexport interface LinkActivatedEvent {\n  readonly target: PdfLinkTarget;\n  readonly activation: LinkActivation;\n}\n/** A page's links were read from the engine. */\nexport interface LinkLoadedEvent {\n  readonly page: PageRef;\n}\n\nexport interface LinkCapability {\n  /**\n   * Clickable areas on a page (its ref or its index), page space.\n   * Reference-stable per page while unchanged; empty for a page that isn't in\n   * the document.\n   */\n  listLinks(page: PageRef | number): readonly Link[];\n  /** One link by its stable id, or null. */\n  getLink(page: PageRef | number, linkId: string): Link | null;\n  /** The topmost (smallest) link under a page point, or null. */\n  getLinkAt(page: PageRef | number, point: Point): Link | null;\n  /**\n   * Every link in the document; loads pages as needed. Rejects when a page's\n   * read fails, and `operation-cancelled` when `signal` fires.\n   */\n  listAllLinks(options?: OperationOptions): Promise<readonly Link[]>;\n  /**\n   * Load a page's links. Resolves at once when the annotation plugin owns\n   * them; rejects when the read fails, which `getStatus(page)` then reports,\n   * `not-found` for a page that isn't in the document, and\n   * `operation-cancelled` when `signal` fires.\n   */\n  ensureLoaded(page: PageRef | number, options?: OperationOptions): Promise<void>;\n  /** The page's links were read and are current. Always true with the annotation plugin. */\n  isLoaded(page: PageRef | number): boolean;\n  /** Load state of a page's links: `idle`, `loading`, `ready`, `error` or `forbidden`. */\n  getStatus(page: PageRef | number): ResourceStatus;\n  /** What activation would do, with no side effect. */\n  resolve(target: PdfLinkTarget): LinkResolution;\n  /**\n   * Follow a link, or a link's target, as a click does, and return what\n   * happened at once (the user's gesture is still on the stack, so a website\n   * can open in a new tab). A `goto` moves the Stage, by its `scrollBehavior`\n   * setting; a website opens through the framework (an `http`, `https`,\n   * `mailto` or `tel` address only); a link with an `/A` tree dispatches\n   * through the actions plugin. Fires `onActivated`.\n   */\n  activate(target: PdfLinkTarget | Link, context?: LinkActivateContext): LinkActivation;\n  /**\n   * Hit test, then activate. Null when no link is there; throws `not-found`\n   * for a page that isn't in the document.\n   */\n  activateAt(\n    page: PageRef | number,\n    point: Point,\n    context?: LinkActivateContext,\n  ): LinkActivation | null;\n  /** A human label for tooltips. */\n  getLabel(link: Link | PdfLinkTarget): string;\n  /** After the built-in handling of any activation. */\n  readonly onActivated: EventHook<LinkActivatedEvent>;\n  /**\n   * A page's links were read, first or again after an annotation change on\n   * it. Never fires for a failed read, nor while the annotation plugin owns the links.\n   */\n  readonly onLoaded: EventHook<LinkLoadedEvent>;\n}\n"],"mappings":";;;;AAMA,MAAa,YAAY,sBAAsC,QAAQ;CACrE,MAAM;CAGN,UAAU;EACR,cAAc;EACd,cAAc;CAChB;AACF,CAAC;;;;;;;;;ACyCD,SAAgB,kBACd,QACA,SACgB;CAChB,QAAQ,OAAO,MAAf;EACE,KAAK,QACH,OAAO,QAAQ,OAAO,YAAY,IAAI,IAClC;GAAE,MAAM;GAAe,aAAa,OAAO;EAAY,IACvD;GAAE,MAAM;GAAY;EAAO;EACjC,KAAK,OACH,OAAO;GAAE,MAAM;GAAO,KAAK,OAAO;EAAI;EACxC,KAAK,SACH,OAAO;GAAE,MAAM;GAAS,MAAM,OAAO;EAAK;EAC5C,SACE,OAAO;GAAE,MAAM;GAAY;EAAO;CACtC;AACF"}

package/dist/contract-DXB_v4as.cjs

@@ -0,0 +1,56 @@
+//#region src/token.ts
+/** The package token, created once here: `contract.ts` re-exports it and
+*  `host-contract.ts` widens it to the host capability. */
+const LinkToken = (0, require("@embedpdf/core").createCapabilityToken)("link", {
+	hint: `add linkPlugin() from '@embedpdf/plugin-link' to your plugins list`,
+	promises: {
+		listAllLinks: true,
+		ensureLoaded: true
+	}
+});
+//#endregion
+//#region src/contract.ts
+/**
+* What activating a target would do, by the rule every link and outline item
+* follows: a `goto` to a page `hasPage` knows is its destination, one to a
+* page the document doesn't have is reported; a website and a named verb are
+* handed on; anything else is reported.
+*/
+function resolveLinkTarget(target, hasPage) {
+	switch (target.kind) {
+		case "goto": return hasPage(target.destination.page) ? {
+			kind: "destination",
+			destination: target.destination
+		} : {
+			kind: "reported",
+			target
+		};
+		case "uri": return {
+			kind: "uri",
+			uri: target.uri
+		};
+		case "named": return {
+			kind: "named",
+			name: target.name
+		};
+		default: return {
+			kind: "reported",
+			target
+		};
+	}
+}
+//#endregion
+Object.defineProperty(exports, "LinkToken", {
+	enumerable: true,
+	get: function() {
+		return LinkToken;
+	}
+});
+Object.defineProperty(exports, "resolveLinkTarget", {
+	enumerable: true,
+	get: function() {
+		return resolveLinkTarget;
+	}
+});
+
+//# sourceMappingURL=contract-DXB_v4as.cjs.map

package/dist/contract-DXB_v4as.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract-DXB_v4as.cjs","names":[],"sources":["../src/token.ts","../src/contract.ts"],"sourcesContent":["/** The package token, created once here: `contract.ts` re-exports it and\n *  `host-contract.ts` widens it to the host capability. */\nimport { createCapabilityToken } from '@embedpdf/core';\n\nimport type { LinkCapability } from './contract';\n\nexport const LinkToken = createCapabilityToken<LinkCapability>('link', {\n  hint: `add linkPlugin() from '@embedpdf/plugin-link' to your plugins list`,\n  // Without a document, an adapter's stand-in rejects these with `not-ready`, as the\n  // capability would; the type asks for every member that returns a promise.\n  promises: {\n    listAllLinks: true,\n    ensureLoaded: true,\n  },\n});\n","/** @embedpdf/plugin-link/contract: the public link vocabulary. */\nimport type { EventHook, OperationOptions, PageRef, ResourceStatus } from '@embedpdf/core';\nimport type { Point } from '@embedpdf/core-geometry';\nimport type {\n  AnnotationRef,\n  PageDestination,\n  PdfActionTree,\n  PdfLinkTarget,\n} from '@embedpdf/engine-core/runtime';\nimport type { ActionDispatchResult } from '@embedpdf/plugin-actions/contract';\nimport type { LinkNavItem } from '@embedpdf/plugin-annotation/contract';\nimport type { StageCapability } from '@embedpdf/plugin-stage/contract';\n\nexport { LinkToken } from './token';\n\n/**\n * A clickable link area: page-space `bounds`, its target, and its annotation\n * (when it is one). The target and `/A` tree are as the annotation holds\n * them, their destinations in page space.\n */\nexport type Link = LinkNavItem;\nexport type { PageDestination, PdfLinkTarget };\n\n/**\n * What activation did: `revealed` (the view went to a page), `uri` (a website\n * opened), `dispatched` (the actions plugin runs the link's action), or\n * `reported` (a link it won't follow). `destination`, `named` and a `uri`\n * with no framework to open it are handed to the caller to perform.\n */\nexport type LinkActivation =\n  | { outcome: 'revealed' }\n  | { outcome: 'destination'; destination: PageDestination }\n  | { outcome: 'uri'; uri: string }\n  | { outcome: 'named'; name: string }\n  | { outcome: 'reported'; target: PdfLinkTarget }\n  | { outcome: 'dispatched'; dispatch: Promise<ActionDispatchResult> }\n  | { outcome: 'none' };\n\n/**\n * What activating a target would do, with no side effect. A `goto` to a page\n * of this document is its destination, ready for `stage.goToDestination`;\n * one to a page the document doesn't have is reported.\n */\nexport type LinkResolution =\n  | { kind: 'destination'; destination: PageDestination }\n  | { kind: 'uri'; uri: string }\n  | { kind: 'named'; name: string }\n  | { kind: 'reported'; target: PdfLinkTarget };\n\n/**\n * What activating a target would do, by the rule every link and outline item\n * follows: a `goto` to a page `hasPage` knows is its destination, one to a\n * page the document doesn't have is reported; a website and a named verb are\n * handed on; anything else is reported.\n */\nexport function resolveLinkTarget(\n  target: PdfLinkTarget,\n  hasPage: (page: PageRef) => boolean,\n): LinkResolution {\n  switch (target.kind) {\n    case 'goto':\n      return hasPage(target.destination.page)\n        ? { kind: 'destination', destination: target.destination }\n        : { kind: 'reported', target };\n    case 'uri':\n      return { kind: 'uri', uri: target.uri };\n    case 'named':\n      return { kind: 'named', name: target.name };\n    default:\n      return { kind: 'reported', target };\n  }\n}\n\nexport interface LinkActivateContext {\n  /** The link's `/A` tree when it has one; the actions plugin runs it instead of the target. */\n  activate?: PdfActionTree;\n  ref?: AnnotationRef;\n  page?: PageRef;\n  /**\n   * The view the link was followed in: a page destination moves this Stage.\n   * Defaults to the main view.\n   */\n  stage?: StageCapability;\n}\n\n/** A link target was activated through this capability. */\nexport interface LinkActivatedEvent {\n  readonly target: PdfLinkTarget;\n  readonly activation: LinkActivation;\n}\n/** A page's links were read from the engine. */\nexport interface LinkLoadedEvent {\n  readonly page: PageRef;\n}\n\nexport interface LinkCapability {\n  /**\n   * Clickable areas on a page (its ref or its index), page space.\n   * Reference-stable per page while unchanged; empty for a page that isn't in\n   * the document.\n   */\n  listLinks(page: PageRef | number): readonly Link[];\n  /** One link by its stable id, or null. */\n  getLink(page: PageRef | number, linkId: string): Link | null;\n  /** The topmost (smallest) link under a page point, or null. */\n  getLinkAt(page: PageRef | number, point: Point): Link | null;\n  /**\n   * Every link in the document; loads pages as needed. Rejects when a page's\n   * read fails, and `operation-cancelled` when `signal` fires.\n   */\n  listAllLinks(options?: OperationOptions): Promise<readonly Link[]>;\n  /**\n   * Load a page's links. Resolves at once when the annotation plugin owns\n   * them; rejects when the read fails, which `getStatus(page)` then reports,\n   * `not-found` for a page that isn't in the document, and\n   * `operation-cancelled` when `signal` fires.\n   */\n  ensureLoaded(page: PageRef | number, options?: OperationOptions): Promise<void>;\n  /** The page's links were read and are current. Always true with the annotation plugin. */\n  isLoaded(page: PageRef | number): boolean;\n  /** Load state of a page's links: `idle`, `loading`, `ready`, `error` or `forbidden`. */\n  getStatus(page: PageRef | number): ResourceStatus;\n  /** What activation would do, with no side effect. */\n  resolve(target: PdfLinkTarget): LinkResolution;\n  /**\n   * Follow a link, or a link's target, as a click does, and return what\n   * happened at once (the user's gesture is still on the stack, so a website\n   * can open in a new tab). A `goto` moves the Stage, by its `scrollBehavior`\n   * setting; a website opens through the framework (an `http`, `https`,\n   * `mailto` or `tel` address only); a link with an `/A` tree dispatches\n   * through the actions plugin. Fires `onActivated`.\n   */\n  activate(target: PdfLinkTarget | Link, context?: LinkActivateContext): LinkActivation;\n  /**\n   * Hit test, then activate. Null when no link is there; throws `not-found`\n   * for a page that isn't in the document.\n   */\n  activateAt(\n    page: PageRef | number,\n    point: Point,\n    context?: LinkActivateContext,\n  ): LinkActivation | null;\n  /** A human label for tooltips. */\n  getLabel(link: Link | PdfLinkTarget): string;\n  /** After the built-in handling of any activation. */\n  readonly onActivated: EventHook<LinkActivatedEvent>;\n  /**\n   * A page's links were read, first or again after an annotation change on\n   * it. Never fires for a failed read, nor while the annotation plugin owns the links.\n   */\n  readonly onLoaded: EventHook<LinkLoadedEvent>;\n}\n"],"mappings":";;;AAMA,MAAa,aAAA,2BAAA,CAAA,CAAA,sBAAA,CAAkD,QAAQ;CACrE,MAAM;CAGN,UAAU;EACR,cAAc;EACd,cAAc;CAChB;AACF,CAAC;;;;;;;;;ACyCD,SAAgB,kBACd,QACA,SACgB;CAChB,QAAQ,OAAO,MAAf;EACE,KAAK,QACH,OAAO,QAAQ,OAAO,YAAY,IAAI,IAClC;GAAE,MAAM;GAAe,aAAa,OAAO;EAAY,IACvD;GAAE,MAAM;GAAY;EAAO;EACjC,KAAK,OACH,OAAO;GAAE,MAAM;GAAO,KAAK,OAAO;EAAI;EACxC,KAAK,SACH,OAAO;GAAE,MAAM;GAAS,MAAM,OAAO;EAAK;EAC5C,SACE,OAAO;GAAE,MAAM;GAAY;EAAO;CACtC;AACF"}

package/dist/contract-DyTXDEwb.d.ts

@@ -0,0 +1,143 @@
+import { EventHook, OperationOptions, PageRef, ResourceStatus } from "@embedpdf/core";
+import { ActionDispatchResult } from "@embedpdf/plugin-actions/contract";
+import { LinkNavItem } from "@embedpdf/plugin-annotation/contract";
+import { StageCapability } from "@embedpdf/plugin-stage/contract";
+import { AnnotationRef, PageDestination, PdfActionTree, PdfLinkTarget } from "@embedpdf/engine-core/runtime";
+import { Point } from "@embedpdf/core-geometry";
+//#region src/token.d.ts
+declare const LinkToken: import("@embedpdf/core").CapabilityToken<LinkCapability>;
+//#endregion
+//#region src/contract.d.ts
+/**
+ * A clickable link area: page-space `bounds`, its target, and its annotation
+ * (when it is one). The target and `/A` tree are as the annotation holds
+ * them, their destinations in page space.
+ */
+type Link = LinkNavItem;
+/**
+ * What activation did: `revealed` (the view went to a page), `uri` (a website
+ * opened), `dispatched` (the actions plugin runs the link's action), or
+ * `reported` (a link it won't follow). `destination`, `named` and a `uri`
+ * with no framework to open it are handed to the caller to perform.
+ */
+type LinkActivation = {
+  outcome: 'revealed';
+} | {
+  outcome: 'destination';
+  destination: PageDestination;
+} | {
+  outcome: 'uri';
+  uri: string;
+} | {
+  outcome: 'named';
+  name: string;
+} | {
+  outcome: 'reported';
+  target: PdfLinkTarget;
+} | {
+  outcome: 'dispatched';
+  dispatch: Promise<ActionDispatchResult>;
+} | {
+  outcome: 'none';
+};
+/**
+ * What activating a target would do, with no side effect. A `goto` to a page
+ * of this document is its destination, ready for `stage.goToDestination`;
+ * one to a page the document doesn't have is reported.
+ */
+type LinkResolution = {
+  kind: 'destination';
+  destination: PageDestination;
+} | {
+  kind: 'uri';
+  uri: string;
+} | {
+  kind: 'named';
+  name: string;
+} | {
+  kind: 'reported';
+  target: PdfLinkTarget;
+};
+/**
+ * What activating a target would do, by the rule every link and outline item
+ * follows: a `goto` to a page `hasPage` knows is its destination, one to a
+ * page the document doesn't have is reported; a website and a named verb are
+ * handed on; anything else is reported.
+ */
+declare function resolveLinkTarget(target: PdfLinkTarget, hasPage: (page: PageRef) => boolean): LinkResolution;
+interface LinkActivateContext {
+  /** The link's `/A` tree when it has one; the actions plugin runs it instead of the target. */
+  activate?: PdfActionTree;
+  ref?: AnnotationRef;
+  page?: PageRef;
+  /**
+   * The view the link was followed in: a page destination moves this Stage.
+   * Defaults to the main view.
+   */
+  stage?: StageCapability;
+}
+/** A link target was activated through this capability. */
+interface LinkActivatedEvent {
+  readonly target: PdfLinkTarget;
+  readonly activation: LinkActivation;
+}
+/** A page's links were read from the engine. */
+interface LinkLoadedEvent {
+  readonly page: PageRef;
+}
+interface LinkCapability {
+  /**
+   * Clickable areas on a page (its ref or its index), page space.
+   * Reference-stable per page while unchanged; empty for a page that isn't in
+   * the document.
+   */
+  listLinks(page: PageRef | number): readonly Link[];
+  /** One link by its stable id, or null. */
+  getLink(page: PageRef | number, linkId: string): Link | null;
+  /** The topmost (smallest) link under a page point, or null. */
+  getLinkAt(page: PageRef | number, point: Point): Link | null;
+  /**
+   * Every link in the document; loads pages as needed. Rejects when a page's
+   * read fails, and `operation-cancelled` when `signal` fires.
+   */
+  listAllLinks(options?: OperationOptions): Promise<readonly Link[]>;
+  /**
+   * Load a page's links. Resolves at once when the annotation plugin owns
+   * them; rejects when the read fails, which `getStatus(page)` then reports,
+   * `not-found` for a page that isn't in the document, and
+   * `operation-cancelled` when `signal` fires.
+   */
+  ensureLoaded(page: PageRef | number, options?: OperationOptions): Promise<void>;
+  /** The page's links were read and are current. Always true with the annotation plugin. */
+  isLoaded(page: PageRef | number): boolean;
+  /** Load state of a page's links: `idle`, `loading`, `ready`, `error` or `forbidden`. */
+  getStatus(page: PageRef | number): ResourceStatus;
+  /** What activation would do, with no side effect. */
+  resolve(target: PdfLinkTarget): LinkResolution;
+  /**
+   * Follow a link, or a link's target, as a click does, and return what
+   * happened at once (the user's gesture is still on the stack, so a website
+   * can open in a new tab). A `goto` moves the Stage, by its `scrollBehavior`
+   * setting; a website opens through the framework (an `http`, `https`,
+   * `mailto` or `tel` address only); a link with an `/A` tree dispatches
+   * through the actions plugin. Fires `onActivated`.
+   */
+  activate(target: PdfLinkTarget | Link, context?: LinkActivateContext): LinkActivation;
+  /**
+   * Hit test, then activate. Null when no link is there; throws `not-found`
+   * for a page that isn't in the document.
+   */
+  activateAt(page: PageRef | number, point: Point, context?: LinkActivateContext): LinkActivation | null;
+  /** A human label for tooltips. */
+  getLabel(link: Link | PdfLinkTarget): string;
+  /** After the built-in handling of any activation. */
+  readonly onActivated: EventHook<LinkActivatedEvent>;
+  /**
+   * A page's links were read, first or again after an annotation change on
+   * it. Never fires for a failed read, nor while the annotation plugin owns the links.
+   */
+  readonly onLoaded: EventHook<LinkLoadedEvent>;
+}
+//#endregion
+export { LinkCapability as a, PageDestination as c, LinkToken as d, LinkActivation as i, PdfLinkTarget as l, LinkActivateContext as n, LinkLoadedEvent as o, LinkActivatedEvent as r, LinkResolution as s, Link as t, resolveLinkTarget as u };
+//# sourceMappingURL=contract-DyTXDEwb.d.ts.map

package/dist/contract.cjs

@@ -1,3 +1,4 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_contract = require("./contract-DGKEPl11.cjs");
+const require_contract = require("./contract-DXB_v4as.cjs");
 exports.LinkToken = require_contract.LinkToken;
+exports.resolveLinkTarget = require_contract.resolveLinkTarget;

package/dist/contract.d.cts

@@ -1,2 +1,2 @@
-import { a as LinkCapability, c as LinkState, d as PdfLinkTarget, i as LinkActivation, l as LinkToken, n as LinkActivateContext, o as LinkNavItem, r as LinkActivateEvent, s as LinkPluginConfig, u as PdfDestination } from "./contract-DO3vDsAV.cjs";
-export { type LinkActivateContext, type LinkActivateEvent, type LinkActivation, type LinkCapability, type LinkNavItem, type LinkPluginConfig, type LinkState, LinkToken, type PdfDestination, type PdfLinkTarget };
+import { a as LinkCapability, c as PageDestination, d as LinkToken, i as LinkActivation, l as PdfLinkTarget, n as LinkActivateContext, o as LinkLoadedEvent, r as LinkActivatedEvent, s as LinkResolution, t as Link, u as resolveLinkTarget } from "./contract-B4x0DFCT.cjs";
+export { Link, LinkActivateContext, LinkActivatedEvent, LinkActivation, LinkCapability, LinkLoadedEvent, LinkResolution, LinkToken, type PageDestination, type PdfLinkTarget, resolveLinkTarget };

package/dist/contract.d.ts

@@ -1,2 +1,2 @@
-import { a as LinkCapability, c as LinkState, d as PdfLinkTarget, i as LinkActivation, l as LinkToken, n as LinkActivateContext, o as LinkNavItem, r as LinkActivateEvent, s as LinkPluginConfig, u as PdfDestination } from "./contract-B8bEMeH8.js";
-export { type LinkActivateContext, type LinkActivateEvent, type LinkActivation, type LinkCapability, type LinkNavItem, type LinkPluginConfig, type LinkState, LinkToken, type PdfDestination, type PdfLinkTarget };
+import { a as LinkCapability, c as PageDestination, d as LinkToken, i as LinkActivation, l as PdfLinkTarget, n as LinkActivateContext, o as LinkLoadedEvent, r as LinkActivatedEvent, s as LinkResolution, t as Link, u as resolveLinkTarget } from "./contract-DyTXDEwb.js";
+export { Link, LinkActivateContext, LinkActivatedEvent, LinkActivation, LinkCapability, LinkLoadedEvent, LinkResolution, LinkToken, type PageDestination, type PdfLinkTarget, resolveLinkTarget };

package/dist/contract.js

@@ -1,2 +1,2 @@
-import { t as LinkToken } from "./contract-HRggERzU.js";
-export { LinkToken };
+import { n as LinkToken, t as resolveLinkTarget } from "./contract-CJ9mhj7i.js";
+export { LinkToken, resolveLinkTarget };

package/dist/host-contract-DNwp7dlr.d.ts

@@ -0,0 +1,23 @@
+import { a as LinkCapability } from "./contract-DyTXDEwb.js";
+import { Unsubscribe } from "@embedpdf/core";
+//#region src/host-contract.d.ts
+/**
+ * Opens a website for `activate()`, in the user's gesture. Returns whether it
+ * opened: false for an address it won't open (a `javascript:` or `file:`
+ * URI), which activation then reports.
+ */
+type UriOpener = (uri: string) => boolean;
+interface LinkHostCapability extends LinkCapability {
+  /** Does the active tool navigate links (the layer paints anchors only then)? */
+  isNavigationEngaged(): boolean;
+  /**
+   * Register the framework's website opener. The plugin never touches the
+   * DOM: without an opener, a website link activates as `{ outcome: 'uri' }`
+   * for the caller to open. The latest registration wins until it is removed.
+   */
+  registerUriOpener(opener: UriOpener): Unsubscribe;
+}
+declare const LinkToken: import("@embedpdf/core").CapabilityToken<LinkHostCapability>;
+//#endregion
+export { LinkToken as n, UriOpener as r, LinkHostCapability as t };
+//# sourceMappingURL=host-contract-DNwp7dlr.d.ts.map

package/dist/host-contract-c0QOjhO6.d.cts

@@ -0,0 +1,23 @@
+import { a as LinkCapability } from "./contract-B4x0DFCT.cjs";
+import { Unsubscribe } from "@embedpdf/core";
+//#region src/host-contract.d.ts
+/**
+ * Opens a website for `activate()`, in the user's gesture. Returns whether it
+ * opened: false for an address it won't open (a `javascript:` or `file:`
+ * URI), which activation then reports.
+ */
+type UriOpener = (uri: string) => boolean;
+interface LinkHostCapability extends LinkCapability {
+  /** Does the active tool navigate links (the layer paints anchors only then)? */
+  isNavigationEngaged(): boolean;
+  /**
+   * Register the framework's website opener. The plugin never touches the
+   * DOM: without an opener, a website link activates as `{ outcome: 'uri' }`
+   * for the caller to open. The latest registration wins until it is removed.
+   */
+  registerUriOpener(opener: UriOpener): Unsubscribe;
+}
+declare const LinkToken: import("@embedpdf/core").CapabilityToken<LinkHostCapability>;
+//#endregion
+export { LinkToken as n, UriOpener as r, LinkHostCapability as t };
+//# sourceMappingURL=host-contract-c0QOjhO6.d.cts.map