@embedpdf/plugin-annotation 3.0.0-next.13 → 3.0.0-next.15

package/dist/contract-b2e_LZvu.js

@@ -0,0 +1,651 @@
+import { createCapabilityToken, defineState } from "@embedpdf/core";
+import { AnnotationTransfer } from "@embedpdf/engine-core/public";
+import { ANNOTATION_FIELD_NAMES } from "@embedpdf/engine-core/runtime";
+//#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 AnnotationToken = createCapabilityToken("annotation", {
+	hint: `add annotationPlugin() from '@embedpdf/plugin-annotation' to your plugins list`,
+	promises: {
+		refresh: true,
+		create: true,
+		createFromSelection: true,
+		update: true,
+		delete: true,
+		reorder: true,
+		export: true,
+		import: true,
+		downloadResource: true,
+		"links.set": true,
+		"links.clear": true,
+		"selection.update": true,
+		"selection.updateLink": true,
+		"selection.delete": true,
+		"selection.rotateBy": true,
+		"selection.resetRotation": true,
+		"selection.group": true,
+		"selection.ungroup": true,
+		"draft.finish": true,
+		"text.end": true,
+		"text.toggleFormat": true,
+		"stamps.arm": true,
+		"stamps.place": true,
+		"comments.reply": true,
+		"comments.setText": true,
+		"comments.setStatus": true,
+		"comments.setMarked": true,
+		"comments.delete": true,
+		"comments.deleteThread": true
+	}
+});
+//#endregion
+//#region src/state.ts
+/**
+* The selecting page's State table as code: what `useAnnotationState()`
+* returns, and the same fields in every other framework. The annotations
+* themselves are not here: `useAnnotationList()` reads them, so a component
+* that shows the selection doesn't re-render for every change on the page.
+*/
+const annotationState = defineState(AnnotationToken, {
+	read: (annotation) => ({
+		status: annotation.getStatus(),
+		selected: annotation.selection.list(),
+		hovered: annotation.getHovered(),
+		editing: annotation.text.getEditing()
+	}),
+	empty: {
+		status: "loading",
+		selected: [],
+		hovered: null,
+		editing: null
+	}
+});
+//#endregion
+//#region src/tools/definitions.ts
+/**
+* The tool `stamps.arm` activates — and the only tool an armed payload survives
+* onto (plus the legacy `annotation-stamp` tag, honoured for embedder configs
+* written before the tags were unified). Placement consults the armed payload
+* before the active tool's own `source` spec, so a payload must not outlive
+* its tool onto a sibling stamp preset: an `image` preset's click has to open
+* its own picker, not silently place whatever the stamp panel last armed.
+*/
+const ARMED_STAMP_TOOL_ID = "stamp";
+/** How opaque a ghost paints unless its tool says. */
+const GHOST_OPACITY = .5;
+/** A tool's ghost setting, resolved: `true` is half see-through. */
+const resolveGhost = (ghost) => ghost === true ? { opacity: GHOST_OPACITY } : ghost;
+/**
+* The fields no tool's defaults may set: where the annotation goes (that comes
+* from the drawing), its identity and relationships, and what the engine
+* stamps or keeps by itself.
+*/
+const NOT_DEFAULTS = [
+	"ref",
+	"page",
+	"index",
+	"hasAppearance",
+	"appearanceState",
+	"nm",
+	"rect",
+	"box",
+	"linePoints",
+	"vertices",
+	"inkList",
+	"quadPoints",
+	"calloutLine",
+	"captionCenter",
+	"measure",
+	"reply",
+	"popup",
+	"parent",
+	"groupId",
+	"author",
+	"createdAt",
+	"modifiedAt",
+	"userId",
+	"createdBy",
+	"modifiedBy",
+	"importedBy",
+	"actions"
+];
+const WIDGET_BOX_FIELDS = [
+	"color",
+	"interiorColor",
+	"strokeWidth",
+	"borderStyle"
+];
+const WIDGET_TEXT_FIELDS = [
+	...WIDGET_BOX_FIELDS,
+	"fontFamily",
+	"fontSize",
+	"fontColor",
+	"textAlign"
+];
+/** Every field of an engine kind a tool's defaults may set: any field but the ones above. */
+const draftDefaults = (subtype) => ANNOTATION_FIELD_NAMES[subtype].filter((name) => !NOT_DEFAULTS.includes(name));
+/**
+* The fields each known authoring kind's defaults may set: any field a create
+* from the tool takes besides where it goes, flags and `contents` included.
+* A key outside it stops the app at startup, naming the tool and the field.
+*/
+const TOOL_DEFAULT_FIELDS = {
+	square: draftDefaults("square"),
+	circle: draftDefaults("circle"),
+	line: draftDefaults("line"),
+	polygon: draftDefaults("polygon"),
+	polyline: draftDefaults("polyline"),
+	ink: draftDefaults("ink"),
+	"free-text": draftDefaults("free-text"),
+	"free-text-callout": draftDefaults("free-text"),
+	highlight: draftDefaults("highlight"),
+	underline: draftDefaults("underline"),
+	strikeout: draftDefaults("strikeout"),
+	squiggly: draftDefaults("squiggly"),
+	caret: draftDefaults("caret"),
+	redact: draftDefaults("redact"),
+	stamp: draftDefaults("stamp"),
+	link: draftDefaults("link"),
+	text: draftDefaults("text"),
+	"file-attachment": draftDefaults("file-attachment"),
+	"widget-text": WIDGET_TEXT_FIELDS,
+	"widget-choice": WIDGET_TEXT_FIELDS,
+	"widget-button": WIDGET_TEXT_FIELDS,
+	"widget-toggle": WIDGET_BOX_FIELDS,
+	"widget-radio": WIDGET_BOX_FIELDS,
+	"widget-box": WIDGET_BOX_FIELDS
+};
+/**
+* The tools whose line gesture is captured instead of created: the measurement
+* plugin turns the calibrate tool's two points into a scale. A tool that
+* extends one captures too.
+*/
+const CAPTURE_TOOLS = /* @__PURE__ */ new Set(["calibrate"]);
+const DRAW_TAGS = ["annotation-draw", "annotation-edit"];
+/** This viewer's drawing red: shapes, lines and text boxes start in it. */
+const HOUSE_RED = "#e5484d";
+const MARKUP_TAGS = ["text-select", "annotation-edit"];
+/**
+* What one finger does while this annotation tool is active (`Tool.touch`):
+* drag-create tools (shape/ink draw and text-markup select) take it as `'draw'`
+* (a finger draws or marks, two fingers navigate: the drawing-app convention).
+* Click-to-place tools (stamp, note) are `'tap'`: a tap places, and drags keep
+* scrolling. Derived from the gesture tags, so custom registered tools inherit
+* the right behavior. Only annotation-owned tools run through this: the
+* built-in `pointer` tool also enables `text-select`, but the hub registers it.
+*/
+const toolTouchOf = (enables) => enables.has("annotation-draw") || enables.has("text-select") ? "draw" : "tap";
+/**
+* The built-in tools, as data (shapes + lines + ink
+* + free text in the draw channel, text markup + caret behind text selection, and
+* the click-to-place stamp). Order is display-neutral; the toolbar owns layout.
+*/
+const DEFAULT_TOOLS = [
+	{
+		id: "square",
+		subtype: "square",
+		cursor: "crosshair",
+		enables: DRAW_TAGS,
+		defaults: {
+			color: HOUSE_RED,
+			strokeWidth: 6
+		},
+		clickCreate: {
+			width: 80,
+			height: 60
+		},
+		upright: true
+	},
+	{
+		id: "circle",
+		subtype: "circle",
+		cursor: "crosshair",
+		enables: DRAW_TAGS,
+		defaults: {
+			color: HOUSE_RED,
+			strokeWidth: 6
+		},
+		clickCreate: {
+			width: 80,
+			height: 60
+		},
+		upright: true
+	},
+	{
+		id: "line",
+		subtype: "line",
+		cursor: "crosshair",
+		enables: DRAW_TAGS,
+		defaults: {
+			color: HOUSE_RED,
+			strokeWidth: 6
+		},
+		clickCreate: { length: 80 },
+		upright: true
+	},
+	{
+		id: "distance",
+		extends: "line",
+		clickCreate: false,
+		defaults: {
+			intent: "line-dimension",
+			strokeWidth: 1,
+			lineEndings: {
+				start: "closed-arrow",
+				end: "closed-arrow"
+			},
+			captionEnabled: true,
+			captionPosition: "inline",
+			leader: {
+				length: 12,
+				extension: 5,
+				offset: 0
+			}
+		}
+	},
+	{
+		id: "calibrate",
+		extends: "line",
+		enables: ["annotation-draw"],
+		defaults: { strokeWidth: 1 },
+		clickCreate: false
+	},
+	{
+		id: "polygon",
+		subtype: "polygon",
+		cursor: "crosshair",
+		enables: DRAW_TAGS,
+		defaults: {
+			color: HOUSE_RED,
+			strokeWidth: 6
+		}
+	},
+	{
+		id: "polyline",
+		subtype: "polyline",
+		cursor: "crosshair",
+		enables: DRAW_TAGS,
+		defaults: {
+			color: HOUSE_RED,
+			strokeWidth: 6
+		}
+	},
+	{
+		id: "perimeter",
+		extends: "polyline",
+		defaults: {
+			intent: "polyline-dimension",
+			strokeWidth: 1,
+			lineEndings: {
+				start: "none",
+				end: "none"
+			},
+			captionEnabled: true
+		}
+	},
+	{
+		id: "area",
+		extends: "polygon",
+		defaults: {
+			intent: "polygon-dimension",
+			strokeWidth: 1,
+			captionEnabled: true
+		}
+	},
+	{
+		id: "ink",
+		subtype: "ink",
+		cursor: "crosshair",
+		enables: DRAW_TAGS,
+		defaults: {
+			color: "#ef4444",
+			strokeWidth: 6,
+			blendMode: "normal"
+		},
+		ink: { groupStrokesMs: 800 }
+	},
+	{
+		id: "ink-highlight",
+		extends: "ink",
+		defaults: {
+			intent: "ink-highlight",
+			color: "#ffcd45",
+			strokeWidth: 14,
+			blendMode: "multiply"
+		},
+		ink: { straighten: {
+			deviationThreshold: .15,
+			axisSnapDegrees: 15
+		} }
+	},
+	{
+		id: "free-text",
+		subtype: "free-text",
+		cursor: "crosshair",
+		enables: DRAW_TAGS,
+		defaults: {
+			color: HOUSE_RED,
+			strokeWidth: 2,
+			fontColor: "#ef4444"
+		},
+		upright: true,
+		clickCreate: {
+			width: 180,
+			height: 40,
+			anchor: "top-left"
+		}
+	},
+	{
+		id: "free-text-callout",
+		subtype: "free-text-callout",
+		cursor: "crosshair",
+		enables: DRAW_TAGS,
+		defaults: {
+			color: HOUSE_RED,
+			strokeWidth: 6,
+			lineEnding: "open-arrow"
+		},
+		upright: true
+	},
+	{
+		id: "highlight",
+		subtype: "highlight",
+		cursor: "default",
+		enables: MARKUP_TAGS,
+		defaults: {
+			color: "#ffe16a",
+			blendMode: "multiply"
+		},
+		selection: { kind: "markup" }
+	},
+	{
+		id: "redact",
+		subtype: "redact",
+		cursor: "crosshair",
+		enables: [
+			"text-select",
+			"annotation-draw",
+			"annotation-edit"
+		],
+		defaults: {
+			color: "#e44234",
+			interiorColor: "#000000",
+			fontSize: 14,
+			fontColor: "#ffffff",
+			opacity: 1
+		},
+		selection: { kind: "markup" }
+	},
+	{
+		id: "underline",
+		subtype: "underline",
+		cursor: "default",
+		enables: MARKUP_TAGS,
+		defaults: { color: "#ef4444" },
+		selection: { kind: "markup" }
+	},
+	{
+		id: "strikeout",
+		subtype: "strikeout",
+		cursor: "default",
+		enables: MARKUP_TAGS,
+		defaults: { color: "#ef4444" },
+		selection: { kind: "markup" }
+	},
+	{
+		id: "squiggly",
+		subtype: "squiggly",
+		cursor: "default",
+		enables: MARKUP_TAGS,
+		defaults: { color: "#ef4444" },
+		selection: { kind: "markup" }
+	},
+	{
+		id: "insert-text",
+		subtype: "caret",
+		fieldsKind: "caret",
+		preset: "caret",
+		cursor: "default",
+		enables: MARKUP_TAGS,
+		defaults: { color: "#ef4444" },
+		selection: {
+			kind: "text-edit",
+			operation: "insert"
+		}
+	},
+	{
+		id: "replace-text",
+		subtype: "strikeout",
+		fieldsKind: "strikeout",
+		cursor: "default",
+		enables: MARKUP_TAGS,
+		defaults: { color: "#ef4444" },
+		selection: {
+			kind: "text-edit",
+			operation: "replace"
+		}
+	},
+	{
+		id: ARMED_STAMP_TOOL_ID,
+		subtype: "stamp",
+		cursor: "copy",
+		enables: ["annotation-place", "annotation-edit"],
+		source: {
+			kind: "prompt",
+			accept: "image/png,image/jpeg,application/pdf"
+		},
+		upright: true,
+		ghost: true
+	},
+	{
+		id: "link",
+		subtype: "link",
+		cursor: "crosshair",
+		enables: DRAW_TAGS
+	},
+	{
+		id: "note",
+		subtype: "text",
+		cursor: "crosshair",
+		enables: ["annotation-place", "annotation-edit"],
+		defaults: {
+			icon: "comment",
+			color: "#facc15"
+		},
+		flags: {
+			noZoom: true,
+			noRotate: true
+		},
+		upright: true,
+		ghost: true
+	},
+	{
+		id: "attachment",
+		subtype: "file-attachment",
+		cursor: "crosshair",
+		enables: ["annotation-place", "annotation-edit"],
+		source: { kind: "prompt" },
+		defaults: {
+			icon: "paperclip",
+			color: "#facc15"
+		},
+		flags: {
+			noZoom: true,
+			noRotate: true
+		},
+		upright: true,
+		ghost: true
+	}
+];
+/** Merge two tools' defaults, `right` over `left`, each value whole. */
+function mergeDefaults(left, right) {
+	return left && right ? {
+		...left,
+		...right
+	} : right ?? left;
+}
+/** Overlay a same-id override onto a base definition (configure a built-in). */
+function mergeDef(base, over) {
+	return {
+		...base,
+		...over,
+		enables: over.enables ?? base.enables,
+		meta: base.meta || over.meta ? {
+			...base.meta,
+			...over.meta
+		} : void 0,
+		defaults: mergeDefaults(base.defaults, over.defaults),
+		flags: base.flags || over.flags ? {
+			...base.flags,
+			...over.flags
+		} : void 0,
+		ink: base.ink || over.ink ? {
+			...base.ink,
+			...over.ink
+		} : void 0,
+		afterCreate: base.afterCreate || over.afterCreate ? {
+			...base.afterCreate,
+			...over.afterCreate
+		} : void 0
+	};
+}
+function validateDefaults(tool) {
+	if (!tool.defaults) return;
+	const allowed = TOOL_DEFAULT_FIELDS[tool.subtype];
+	if (!allowed) return;
+	const keys = new Set(allowed);
+	for (const key of Object.keys(tool.defaults)) if (!keys.has(key)) throw new Error(`[annotation] tool '${tool.id}' does not support default '${key}' for '${tool.subtype}'`);
+}
+/**
+* Resolve {@link DEFAULT_TOOLS} + embedder overrides into the ready-to-use table.
+* A same-id override merges over the built-in; a new id adds a tool; `extends`
+* inherits from an already-defined tool. Keyed by id, so lookups are O(1).
+*/
+function buildToolRegistry(overrides = []) {
+	const defs = /* @__PURE__ */ new Map();
+	for (const definition of DEFAULT_TOOLS) defs.set(definition.id, definition);
+	for (const override of overrides) {
+		const previous = defs.get(override.id);
+		defs.set(override.id, previous ? mergeDef(previous, override) : override);
+	}
+	const out = /* @__PURE__ */ new Map();
+	const resolving = /* @__PURE__ */ new Set();
+	const resolve = (id) => {
+		const cached = out.get(id);
+		if (cached) return cached;
+		const definition = defs.get(id);
+		if (!definition) throw new Error(`[annotation] tool '${id}' extends an unknown tool`);
+		let base;
+		if (definition.extends && definition.extends !== id && !resolving.has(definition.extends)) {
+			resolving.add(id);
+			base = resolve(definition.extends);
+			resolving.delete(id);
+		}
+		const subtype = definition.subtype ?? base?.subtype ?? definition.id;
+		const resolved = {
+			id: definition.id,
+			subtype,
+			preset: definition.preset ?? definition.id,
+			fieldsKind: definition.fieldsKind ?? base?.fieldsKind ?? subtype,
+			cursor: definition.cursor ?? base?.cursor ?? "crosshair",
+			enables: new Set(definition.enables ?? (base ? [...base.enables] : [])),
+			defaults: mergeDefaults(base?.defaults, definition.defaults),
+			flags: base?.flags || definition.flags ? {
+				...base?.flags,
+				...definition.flags
+			} : void 0,
+			source: definition.source ?? base?.source,
+			selection: definition.selection ?? base?.selection,
+			ink: base?.ink || definition.ink ? {
+				...base?.ink,
+				...definition.ink
+			} : void 0,
+			upright: definition.upright ?? base?.upright ?? false,
+			clickCreate: definition.clickCreate ?? base?.clickCreate ?? false,
+			ghost: resolveGhost(definition.ghost ?? base?.ghost ?? false),
+			afterCreate: base?.afterCreate || definition.afterCreate ? {
+				...base?.afterCreate,
+				...definition.afterCreate
+			} : void 0,
+			capture: CAPTURE_TOOLS.has(definition.id) || (base?.capture ?? false),
+			meta: base?.meta || definition.meta ? {
+				...base?.meta,
+				...definition.meta
+			} : void 0
+		};
+		validateDefaults(resolved);
+		out.set(id, resolved);
+		return resolved;
+	};
+	for (const id of defs.keys()) resolve(id);
+	return out;
+}
+//#endregion
+//#region src/contract.ts
+/** What the annotation settings are when the app registers none. */
+const ANNOTATION_DEFAULTS = {
+	tools: [],
+	afterCreate: {
+		select: true,
+		tool: "stay",
+		editText: true
+	},
+	chrome: {
+		accent: null,
+		outline: {
+			color: null,
+			style: "solid",
+			width: 1
+		},
+		handles: {
+			shape: "square",
+			size: 8,
+			hitSize: 24,
+			fill: "#ffffff",
+			stroke: null
+		},
+		rotationHandle: {
+			enabled: true,
+			size: 10,
+			hitSize: 24,
+			offset: 32,
+			stalk: true,
+			fill: null,
+			stroke: null
+		},
+		guides: {
+			enabled: true,
+			color: "#e91e63",
+			rotationColor: null,
+			style: "solid",
+			width: 1.5
+		},
+		marquee: {
+			fill: null,
+			stroke: null
+		},
+		textOutline: null,
+		readout: {
+			enabled: true,
+			background: "rgb(0 0 0 / 0.8)",
+			color: "#ffffff"
+		}
+	},
+	snap: {
+		alignment: true,
+		alignmentThreshold: 6,
+		rotation: true,
+		rotationAngles: [
+			0,
+			90,
+			180,
+			270
+		],
+		rotationThreshold: 4
+	},
+	editable: true
+};
+//#endregion
+export { buildToolRegistry as a, AnnotationToken as c, DEFAULT_TOOLS as i, AnnotationTransfer as n, toolTouchOf as o, ARMED_STAMP_TOOL_ID as r, annotationState as s, ANNOTATION_DEFAULTS as t };
+
+//# sourceMappingURL=contract-b2e_LZvu.js.map