@embedpdf/plugin-annotation 2.15.0 → 3.0.0-next.0

package/dist/lib/patching/line-endings.d.ts

@@ -1,13 +0,0 @@
-import { PdfAnnotationLineEnding } from '@embedpdf/models';
-export interface SvgEnding {
-    d: string;
-    transform: string;
-    filled: boolean;
-}
-/**
- * Factory that returns SVG path data and transform attributes for a given line ending.
- * It uses a central handler for each ending type to ensure consistency.
- */
-export declare function createEnding(ending: PdfAnnotationLineEnding | undefined, strokeWidth: number, rad: number, // direction angle in radians of the line segment
-px: number, // x-coordinate of the line's endpoint
-py: number): SvgEnding | null;

package/dist/lib/patching/patch-registry.d.ts

@@ -1,40 +0,0 @@
-import { PdfAnnotationObject, PdfAnnotationSubtype } from '@embedpdf/models';
-export interface TransformContext<T extends PdfAnnotationObject = PdfAnnotationObject> {
-    /** The type of transformation being applied */
-    type: 'move' | 'resize' | 'vertex-edit' | 'rotate' | 'property-update';
-    /** The changes being applied - can be any properties of the annotation */
-    changes: Partial<T>;
-    /** Optional metadata about the transformation */
-    metadata?: {
-        maintainAspectRatio?: boolean;
-        /** Rotation angle in degrees (for 'rotate' transform type) */
-        rotationAngle?: number;
-        /** Delta from the initial rotation angle in degrees */
-        rotationDelta?: number;
-        /** Center point for rotation (defaults to rect center) */
-        rotationCenter?: {
-            x: number;
-            y: number;
-        };
-        /** Whether the rotation input is currently snapped */
-        isSnapped?: boolean;
-        /** Snap target angle when isSnapped is true */
-        snappedAngle?: number;
-        [key: string]: any;
-    };
-}
-export type PatchFunction<T extends PdfAnnotationObject> = (original: T, context: TransformContext<T>) => Partial<T>;
-/**
- * Registry for annotation-specific patch functions.
- * Each patch function knows how to transform its annotation type.
- */
-export declare class PatchRegistry {
-    private patches;
-    register<T extends PdfAnnotationObject>(type: PdfAnnotationSubtype, patchFn: PatchFunction<T>): void;
-    /**
-     * Transform an annotation based on the context.
-     * Returns the transformed properties or just the changes if no patch function exists.
-     */
-    transform<T extends PdfAnnotationObject>(annotation: T, context: TransformContext<T>): Partial<T>;
-}
-export declare const patchRegistry: PatchRegistry;

package/dist/lib/patching/patch-utils.d.ts

@@ -1,97 +0,0 @@
-import { Rect, Position, LineEndings, PdfAnnotationLineEnding, PdfRectDifferences, PdfFreeTextAnnoObject, getRectCenter, rotatePointAround, rotateVertices, calculateRotatedRectAABB, calculateRotatedRectAABBAroundPoint } from '@embedpdf/models';
-export { rotatePointAround as rotatePointAroundCenter, rotateVertices, getRectCenter, calculateRotatedRectAABB, calculateRotatedRectAABBAroundPoint, };
-/**
- * Calculate the axis-aligned bounding box for rotated vertices.
- * @param vertices - The rotated vertices
- * @param padding - Optional padding to add around the bounding box
- * @returns The axis-aligned bounding box
- */
-export declare function calculateAABBFromVertices(vertices: Position[], padding?: number): Rect;
-/**
- * Computes the exact bounding box for a line or polyline, including its endings and stroke width.
- * This function uses the central `LINE_ENDING_HANDLERS` to ensure calculations are
- * perfectly in sync with the rendering logic.
- */
-export declare function lineRectWithEndings(vertices: Position[], strokeWidth: number, endings: LineEndings | undefined): Rect;
-/**
- * Build rect patches for vertex editing.
- * For rotated annotations, the tight rect is kept as unrotatedRect and the AABB is
- * computed around the new content center so rotation UI follows the edited geometry.
- */
-export declare function resolveVertexEditRects(original: {
-    rect: Rect;
-    unrotatedRect?: Rect;
-    rotation?: number;
-}, tightRect: Rect): {
-    rect: Rect;
-    unrotatedRect?: Rect;
-};
-/**
- * Resolve an annotation's effective rotation center in page coordinates.
- */
-export declare function resolveAnnotationRotationCenter(original: {
-    rect: Rect;
-    unrotatedRect?: Rect;
-    rotation?: number;
-}): Position;
-/**
- * Build rotate patches while preserving an annotation's effective rotation center.
- * The incoming unrotated rect may already include a translation (group rotation/orbit).
- */
-export declare function resolveRotateRects(original: {
-    rect: Rect;
-    unrotatedRect?: Rect;
-    rotation?: number;
-}, nextUnrotatedRect: Rect, angleDegrees: number): {
-    rect: Rect;
-    unrotatedRect: Rect;
-};
-/**
- * Compensate vertices for rotated vertex editing so the dragged point tracks the cursor
- * while the rotation center follows edited geometry.
- *
- * Without this compensation, changing the tight bounds center during a rotated vertex edit
- * applies an additional translation to all points, which appears as opposite-end drift.
- */
-export declare function compensateRotatedVertexEdit(original: {
-    rect: Rect;
-    unrotatedRect?: Rect;
-    rotation?: number;
-}, vertices: Position[], tightRect: Rect): Position[];
-/**
- * Derive the text box rect from the annotation's overall rect and RD inset.
- */
-export declare function computeTextBoxFromRD(rect: Rect, rd: PdfRectDifferences | undefined): Rect;
-/**
- * Compute the RD inset from the overall rect to the text box.
- */
-export declare function computeRDFromTextBox(overallRect: Rect, textBox: Rect): PdfRectDifferences;
-/**
- * Auto-compute the callout connection point on the text box edge.
- * Uses the knee's position relative to the text box center, scaled by aspect ratio,
- * to choose the nearest edge midpoint (top, right, bottom, left).
- */
-export declare function computeCalloutConnectionPoint(knee: Position, textBox: Rect): Position;
-/**
- * Compute the overall bounding rect for a callout FreeText, encompassing
- * the text box, callout line, and line ending geometry.
- *
- * The text box border grows inward (stroke outer edge = textBox boundary),
- * so no outward padding is added for the text box. The callout line and
- * arrow stroke extend outward and miter joins at the knee can protrude
- * further, so they get strokeWidth padding (half for stroke + half for
- * miter/join clearance).
- */
-export declare function computeCalloutOverallRect(textBox: Rect, calloutLine: Position[], lineEnding: PdfAnnotationLineEnding | undefined, strokeWidth: number): Rect;
-export declare const calloutVertexConfig: {
-    extractVertices: (a: PdfFreeTextAnnoObject) => Position[];
-    transformAnnotation: (a: PdfFreeTextAnnoObject, vertices: Position[]) => {
-        calloutLine?: undefined;
-        rect?: undefined;
-        rectangleDifferences?: undefined;
-    } | {
-        calloutLine: Position[];
-        rect: Rect;
-        rectangleDifferences: PdfRectDifferences;
-    };
-};

package/dist/lib/patching/patches/callout-freetext.patch.d.ts

@@ -1,3 +0,0 @@
-import { PdfFreeTextAnnoObject } from '@embedpdf/models';
-import { PatchFunction } from '../patch-registry';
-export declare const patchCalloutFreeText: PatchFunction<PdfFreeTextAnnoObject>;

package/dist/lib/patching/patches/circle.patch.d.ts

@@ -1,3 +0,0 @@
-import { PdfCircleAnnoObject } from '@embedpdf/models';
-import { PatchFunction } from '../patch-registry';
-export declare const patchCircle: PatchFunction<PdfCircleAnnoObject>;

package/dist/lib/patching/patches/freetext.patch.d.ts

@@ -1,3 +0,0 @@
-import { PdfFreeTextAnnoObject } from '@embedpdf/models';
-import { PatchFunction } from '../patch-registry';
-export declare const patchFreeText: PatchFunction<PdfFreeTextAnnoObject>;

package/dist/lib/patching/patches/index.d.ts

@@ -1,9 +0,0 @@
-export * from './ink.patch';
-export * from './line.patch';
-export * from './polyline.patch';
-export * from './polygon.patch';
-export * from './circle.patch';
-export * from './square.patch';
-export * from './freetext.patch';
-export * from './callout-freetext.patch';
-export * from './stamp.patch';

package/dist/lib/patching/patches/ink.patch.d.ts

@@ -1,3 +0,0 @@
-import { PdfInkAnnoObject } from '@embedpdf/models';
-import { PatchFunction } from '../patch-registry';
-export declare const patchInk: PatchFunction<PdfInkAnnoObject>;

package/dist/lib/patching/patches/line.patch.d.ts

@@ -1,3 +0,0 @@
-import { PdfLineAnnoObject } from '@embedpdf/models';
-import { PatchFunction } from '../patch-registry';
-export declare const patchLine: PatchFunction<PdfLineAnnoObject>;

package/dist/lib/patching/patches/polygon.patch.d.ts

@@ -1,3 +0,0 @@
-import { PdfPolygonAnnoObject } from '@embedpdf/models';
-import { PatchFunction } from '../patch-registry';
-export declare const patchPolygon: PatchFunction<PdfPolygonAnnoObject>;

package/dist/lib/patching/patches/polyline.patch.d.ts

@@ -1,3 +0,0 @@
-import { PdfPolylineAnnoObject } from '@embedpdf/models';
-import { PatchFunction } from '../patch-registry';
-export declare const patchPolyline: PatchFunction<PdfPolylineAnnoObject>;

package/dist/lib/patching/patches/square.patch.d.ts

@@ -1,3 +0,0 @@
-import { PdfSquareAnnoObject } from '@embedpdf/models';
-import { PatchFunction } from '../patch-registry';
-export declare const patchSquare: PatchFunction<PdfSquareAnnoObject>;

package/dist/lib/patching/patches/stamp.patch.d.ts

@@ -1,3 +0,0 @@
-import { PdfStampAnnoObject } from '@embedpdf/models';
-import { PatchFunction } from '../patch-registry';
-export declare const patchStamp: PatchFunction<PdfStampAnnoObject>;

package/dist/lib/reducer.d.ts

@@ -1,6 +0,0 @@
-import { Reducer } from '@embedpdf/core';
-import { AnnotationAction } from './actions';
-import { AnnotationPluginConfig, AnnotationState, AnnotationDocumentState } from './types';
-export declare const initialDocumentState: (cfg?: AnnotationPluginConfig) => AnnotationDocumentState;
-export declare const initialState: (cfg: AnnotationPluginConfig) => AnnotationState;
-export declare const reducer: Reducer<AnnotationState, AnnotationAction>;

package/dist/lib/selectors.d.ts

@@ -1,139 +0,0 @@
-import { AnnotationState, AnnotationDocumentState, SidebarAnnotationEntry, TrackedAnnotation, GroupingAction } from './types';
-import { PdfAnnotationSubtype, PdfAnnotationObject } from '@embedpdf/models';
-import { ToolMap } from './tools/tools-utils';
-/** All annotations _objects_ on a single page (order preserved). */
-export declare const getAnnotationsByPageIndex: (s: AnnotationDocumentState, page: number) => TrackedAnnotation<PdfAnnotationObject>[];
-/** Shortcut: every page → list of annotation objects. */
-export declare const getAnnotations: (s: AnnotationDocumentState) => Record<number, TrackedAnnotation<PdfAnnotationObject>[]>;
-/**
- * The full `TrackedAnnotation` for the current selection.
- * @deprecated Use getSelectedAnnotations() for multi-select support. Returns first selected or null.
- */
-export declare const getSelectedAnnotation: (s: AnnotationDocumentState) => TrackedAnnotation | null;
-/** Get all selected TrackedAnnotations */
-export declare const getSelectedAnnotations: (s: AnnotationDocumentState) => TrackedAnnotation[];
-/** Get the IDs of all selected annotations */
-export declare const getSelectedAnnotationIds: (s: AnnotationDocumentState) => string[];
-/** Get a tracked annotation by its ID */
-export declare const getAnnotationByUid: (s: AnnotationDocumentState, uid: string) => TrackedAnnotation<PdfAnnotationObject>;
-/**
- * Get selected annotation on a specific page (single, for backward compatibility)
- * @deprecated Use getSelectedAnnotationsByPageIndex() for multi-select support.
- */
-export declare const getSelectedAnnotationByPageIndex: (s: AnnotationDocumentState, pageIndex: number) => TrackedAnnotation | null;
-/** Get all selected annotations on a specific page */
-export declare const getSelectedAnnotationsByPageIndex: (s: AnnotationDocumentState, pageIndex: number) => TrackedAnnotation[];
-/** Check if a given annotation is in the current selection. */
-export declare const isAnnotationSelected: (s: AnnotationDocumentState, id: string) => boolean;
-/** Check if multiple annotations are selected */
-export declare const hasMultipleSelected: (s: AnnotationDocumentState) => boolean;
-/**
- * Returns the current defaults for a specific tool by its ID.
- * This is fully type-safe and infers the correct return type.
- *
- * @param state The annotation plugin's state.
- * @param toolId The ID of the tool (e.g., 'highlight', 'pen').
- * @returns The tool's current `defaults` object, or `undefined` if not found.
- */
-export declare function getToolDefaultsById<K extends keyof ToolMap>(state: AnnotationState, toolId: K): ToolMap[K]['defaults'] | undefined;
-/**
- * Collect every sidebar-eligible annotation and attach its TEXT replies,
- * grouped by page for efficient rendering.
- *
- * Annotations linked via IRT / RT=Group are collapsed: the group leader
- * becomes the sidebar entry and its non-LINK group members are attached
- * as `groupMembers`. This keeps the sidebar compact for tools like
- * Replace Text (Caret + StrikeOut pair).
- *
- * Result shape:
- * {
- *   0: [{ page: 0, annotation: <TrackedAnnotation>, replies: [ … ], groupMembers: [ … ] }, ...],
- *   1: [{ page: 1, annotation: <TrackedAnnotation>, replies: [ … ] }, ...],
- *   …
- * }
- */
-export declare const getSidebarAnnotationsWithRepliesGroupedByPage: (s: AnnotationDocumentState) => Record<number, SidebarAnnotationEntry[]>;
-/**
- * Collect every sidebar-eligible annotation and attach its TEXT replies.
- *
- * Result shape:
- * [
- *   { page: 0, annotation: <TrackedAnnotation>, replies: [ … ] },
- *   { page: 1, annotation: <TrackedAnnotation>, replies: [ … ] },
- *   …
- * ]
- */
-export declare const getSidebarAnnotationsWithReplies: (s: AnnotationDocumentState) => SidebarAnnotationEntry[];
-/**
- * Get all IRT child annotation info for cascade delete.
- * Returns array of { id, pageIndex } for each annotation that references parentId.
- */
-export declare const getIRTChildIds: (s: AnnotationDocumentState, parentId: string) => {
-    id: string;
-    pageIndex: number;
-}[];
-/**
- * Check if an annotation has any IRT children (links, replies, etc.)
- */
-export declare const hasIRTChildren: (s: AnnotationDocumentState, parentId: string) => boolean;
-/**
- * Get IRT children filtered by annotation type (e.g., only LINK).
- * @param s - The annotation document state
- * @param parentId - The parent annotation ID
- * @param types - Array of annotation subtypes to include
- */
-export declare const getIRTChildrenByType: (s: AnnotationDocumentState, parentId: string, types: PdfAnnotationSubtype[]) => TrackedAnnotation[];
-/**
- * Get link annotations attached to a parent annotation via IRT relationship.
- * @param s - The annotation document state
- * @param parentId - The parent annotation ID
- */
-export declare const getAttachedLinks: (s: AnnotationDocumentState, parentId: string) => TrackedAnnotation[];
-/**
- * Check if an annotation has attached link children.
- * @param s - The annotation document state
- * @param parentId - The parent annotation ID
- */
-export declare const hasAttachedLinks: (s: AnnotationDocumentState, parentId: string) => boolean;
-/**
- * Get the leader ID of a group.
- * If the annotation has inReplyToId with replyType = Group, return the inReplyToId.
- * Otherwise, the annotation itself is the leader.
- *
- * @param s - The annotation document state
- * @param annotationId - The annotation ID to find the group leader for
- * @returns The leader annotation ID, or undefined if annotation not found
- */
-export declare const getGroupLeaderId: (s: AnnotationDocumentState, annotationId: string) => string | undefined;
-/**
- * Get all annotations in the same group as the given annotation.
- * Returns the leader plus all annotations with inReplyToId pointing to leader and replyType = Group.
- * Note: LINK annotations are excluded - they use IRT/Group for attachment but are not "group members"
- * in the user-facing sense.
- *
- * @param s - The annotation document state
- * @param annotationId - Any annotation ID in the group
- * @returns Array of TrackedAnnotations in the group (including the annotation itself)
- */
-export declare const getGroupMembers: (s: AnnotationDocumentState, annotationId: string) => TrackedAnnotation<PdfAnnotationObject>[];
-/**
- * Check if an annotation is part of a group.
- * An annotation is in a group if:
- * - It has inReplyToId with replyType = Group (it's a group member), OR
- * - It has at least one other annotation pointing to it with replyType = Group (it's a group leader)
- *
- * Note: LINK annotations are excluded - they use IRT/Group for attachment but are not "group members"
- * in the user-facing sense. An annotation with only attached links is NOT considered "in a group".
- *
- * @param s - The annotation document state
- * @param annotationId - The annotation ID to check
- * @returns true if the annotation is part of a group
- */
-export declare const isInGroup: (s: AnnotationDocumentState, annotationId: string) => boolean;
-/**
- * Determine what grouping action is available for the current selection.
- *
- * @param s - The annotation document state
- * @returns The available grouping action
- */
-export declare const getSelectionGroupingAction: (s: AnnotationDocumentState) => GroupingAction;