@embedpdf/plugin-annotation 2.9.1 → 2.10.0

package/dist/lib/actions.d.ts

@@ -1,7 +1,7 @@
 import { Action } from '@embedpdf/core';
 import { PdfAnnotationObject } from '@embedpdf/models';
 import { AnnotationTool } from './tools/types';
-import { AnnotationDocumentState } from './types';
+import { AnnotationDocumentState, LockMode } from './types';
 export declare const INIT_ANNOTATION_STATE = "ANNOTATION/INIT_STATE";
 export declare const CLEANUP_ANNOTATION_STATE = "ANNOTATION/CLEANUP_STATE";
 export declare const SET_ACTIVE_DOCUMENT = "ANNOTATION/SET_ACTIVE_DOCUMENT";
@@ -18,6 +18,8 @@ export declare const MOVE_ANNOTATION = "ANNOTATION/MOVE_ANNOTATION";
 export declare const DELETE_ANNOTATION = "ANNOTATION/DELETE_ANNOTATION";
 export declare const COMMIT_PENDING_CHANGES = "ANNOTATION/COMMIT";
 export declare const PURGE_ANNOTATION = "ANNOTATION/PURGE_ANNOTATION";
+export declare const SET_LOCKED = "ANNOTATION/SET_LOCKED";
+export declare const SYNC_ANNOTATION_OBJECT = "ANNOTATION/SYNC_OBJECT";
 export declare const ADD_COLOR_PRESET = "ANNOTATION/ADD_COLOR_PRESET";
 export declare const SET_TOOL_DEFAULTS = "ANNOTATION/SET_TOOL_DEFAULTS";
 export declare const ADD_TOOL = "ANNOTATION/ADD_TOOL";
@@ -135,6 +137,21 @@ export interface PurgeAnnotationAction extends Action {
         uid: string;
     };
 }
+export interface SetLockedAction extends Action {
+    type: typeof SET_LOCKED;
+    payload: {
+        documentId: string;
+        mode: LockMode;
+    };
+}
+export interface SyncAnnotationObjectAction extends Action {
+    type: typeof SYNC_ANNOTATION_OBJECT;
+    payload: {
+        documentId: string;
+        id: string;
+        patch: Partial<PdfAnnotationObject>;
+    };
+}
 export interface AddColorPresetAction extends Action {
     type: typeof ADD_COLOR_PRESET;
     payload: string;
@@ -143,14 +160,14 @@ export interface SetToolDefaultsAction extends Action {
     type: typeof SET_TOOL_DEFAULTS;
     payload: {
         toolId: string;
-        patch: Partial<any>;
+        patch: Partial<PdfAnnotationObject> & Record<string, unknown>;
     };
 }
 export interface AddToolAction extends Action {
     type: typeof ADD_TOOL;
-    payload: AnnotationTool;
+    payload: AnnotationTool<any>;
 }
-export type AnnotationAction = InitAnnotationStateAction | CleanupAnnotationStateAction | SetActiveDocumentAction | SetAnnotationsAction | SelectAnnotationAction | DeselectAnnotationAction | AddToSelectionAction | RemoveFromSelectionAction | SetSelectionAction | SetActiveToolIdAction | CreateAnnotationAction | PatchAnnotationAction | MoveAnnotationAction | DeleteAnnotationAction | CommitAction | PurgeAnnotationAction | AddColorPresetAction | SetToolDefaultsAction | AddToolAction;
+export type AnnotationAction = InitAnnotationStateAction | CleanupAnnotationStateAction | SetActiveDocumentAction | SetAnnotationsAction | SelectAnnotationAction | DeselectAnnotationAction | AddToSelectionAction | RemoveFromSelectionAction | SetSelectionAction | SetActiveToolIdAction | CreateAnnotationAction | PatchAnnotationAction | MoveAnnotationAction | DeleteAnnotationAction | CommitAction | PurgeAnnotationAction | SetLockedAction | SyncAnnotationObjectAction | AddColorPresetAction | SetToolDefaultsAction | AddToolAction;
 export declare function initAnnotationState(documentId: string, state: AnnotationDocumentState): InitAnnotationStateAction;
 export declare function cleanupAnnotationState(documentId: string): CleanupAnnotationStateAction;
 export declare function setActiveDocument(documentId: string | null): SetActiveDocumentAction;
@@ -167,6 +184,8 @@ export declare const moveAnnotation: (documentId: string, pageIndex: number, id:
 export declare const deleteAnnotation: (documentId: string, pageIndex: number, id: string) => DeleteAnnotationAction;
 export declare const commitPendingChanges: (documentId: string, committedUids: string[]) => CommitAction;
 export declare const purgeAnnotation: (documentId: string, pageIndex: number, uid: string) => PurgeAnnotationAction;
+export declare const setLockedAction: (documentId: string, mode: LockMode) => SetLockedAction;
+export declare const syncAnnotationObject: (documentId: string, id: string, patch: Partial<PdfAnnotationObject>) => SyncAnnotationObjectAction;
 export declare const addColorPreset: (c: string) => AddColorPresetAction;
-export declare const setToolDefaults: (toolId: string, patch: Partial<any>) => SetToolDefaultsAction;
-export declare const addTool: (tool: AnnotationTool) => AddToolAction;
+export declare const setToolDefaults: (toolId: string, patch: Partial<PdfAnnotationObject> & Record<string, unknown>) => SetToolDefaultsAction;
+export declare const addTool: (tool: AnnotationTool<any>) => AddToolAction;

package/dist/lib/annotation-plugin.d.ts

@@ -1,9 +1,9 @@
 import { BasePlugin, PluginRegistry } from '@embedpdf/core';
 import { PdfAnnotationObject, Position, Rect } from '@embedpdf/models';
-import { AnnotationCapability, AnnotationPluginConfig, AnnotationState, UnifiedDragOptions, UnifiedDragState, UnifiedDragEvent, UnifiedResizeOptions, UnifiedResizeState, UnifiedResizeEvent, UnifiedRotateOptions, UnifiedRotateState, UnifiedRotateEvent } from './types';
+import { AnnotationCapability, AnnotationPluginConfig, AnnotationState, UnifiedDragOptions, UnifiedDragState, UnifiedDragEvent, UnifiedResizeOptions, UnifiedResizeState, UnifiedResizeEvent, UnifiedRotateOptions, UnifiedRotateState, UnifiedRotateEvent, LockMode } from './types';
 import { AnnotationAction } from './actions';
-import { AnnotationTool } from './tools/types';
-import { AnyPreviewState, HandlerServices } from './handlers/types';
+import { AnnotationTool, AnnotationToolMap, ToolById, ToolId } from './tools/types';
+import { PreviewState, HandlerServices } from './handlers/types';
 export declare class AnnotationPlugin extends BasePlugin<AnnotationPluginConfig, AnnotationCapability, AnnotationState, AnnotationAction> {
     static readonly id: "annotation";
     private readonly ANNOTATION_HISTORY_TOPIC;
@@ -12,16 +12,14 @@ export declare class AnnotationPlugin extends BasePlugin<AnnotationPluginConfig,
     private readonly interactionManager;
     private readonly selection;
     private readonly history;
+    private readonly scroll;
     private pendingContexts;
     private isInitialLoadComplete;
     private importQueue;
     private commitInProgress;
-    private handlerFactories;
-    private selectionHandlerFactories;
     private readonly activeTool$;
     private readonly events$;
     private readonly toolsChange$;
-    private readonly patchRegistry;
     private readonly appearanceCache;
     private readonly unifiedDragStates;
     private readonly unifiedDrag$;
@@ -29,23 +27,20 @@ export declare class AnnotationPlugin extends BasePlugin<AnnotationPluginConfig,
     private readonly unifiedResize$;
     private readonly unifiedRotateStates;
     private readonly unifiedRotate$;
+    private readonly navigate$;
     constructor(id: string, registry: PluginRegistry, config: AnnotationPluginConfig);
     protected onDocumentLoadingStarted(documentId: string): void;
     protected onDocumentLoaded(documentId: string): void;
     protected onDocumentClosed(documentId: string): void;
-    private registerHandlerFactories;
-    private registerSelectionHandlerFactories;
-    private registerBuiltInPatches;
     initialize(): Promise<void>;
     private registerInteractionForTool;
     protected buildCapability(): AnnotationCapability;
     private createAnnotationScope;
     onStoreUpdated(prev: AnnotationState, next: AnnotationState): void;
-    private registerPatchFunction;
     private transformAnnotation;
     registerPageHandlers(documentId: string, pageIndex: number, scale: number, callbacks: {
         services: HandlerServices;
-        onPreview: (toolId: string, state: AnyPreviewState | null) => void;
+        onPreview: (toolId: string, state: PreviewState | null) => void;
     }): () => void;
     private getDocumentState;
     private getAllAnnotations;
@@ -248,8 +243,16 @@ export declare class AnnotationPlugin extends BasePlugin<AnnotationPluginConfig,
     private moveAnnotationMethod;
     getActiveTool(documentId?: string): AnnotationTool | null;
     setActiveTool(toolId: string | null, documentId?: string): void;
-    getTool<T extends AnnotationTool>(toolId: string): T | undefined;
+    getTool<TId extends ToolId<AnnotationToolMap>>(toolId: TId): (ToolById<AnnotationToolMap, TId> & AnnotationTool) | undefined;
+    getTool(toolId: string): AnnotationTool | undefined;
     findToolForAnnotation(annotation: PdfAnnotationObject): AnnotationTool | null;
+    setLocked(mode: LockMode, documentId?: string): void;
+    getLocked(documentId?: string): LockMode;
+    isAnnotationLocked(annotation: PdfAnnotationObject, documentId?: string): boolean;
+    isCategoryLockedMethod(category: string, documentId?: string): boolean;
+    isToolLockedMethod(toolId: string, documentId?: string): boolean;
+    syncAnnotationObject(id: string, patch: Partial<PdfAnnotationObject>, documentId?: string): void;
+    private navigateTargetMethod;
     /**
      * Collects all pending annotation changes for a document into a batch.
      * This separates the "what to commit" from "how to commit" for cleaner code.

package/dist/lib/handlers/index.d.ts

@@ -7,6 +7,7 @@ export * from './polygon.handler';
 export * from './square.handler';
 export * from './stamp.handler';
 export * from './circle.handler';
+export * from './link.handler';
 export * from './text-markup.handler';
 export * from './insert-text.handler';
 export * from './replace-text.handler';

package/dist/lib/handlers/link.handler.d.ts

@@ -0,0 +1,3 @@
+import { PdfLinkAnnoObject } from '@embedpdf/models';
+import { HandlerFactory } from './types';
+export declare const linkHandlerFactory: HandlerFactory<PdfLinkAnnoObject>;

package/dist/lib/handlers/types.d.ts

@@ -67,6 +67,13 @@ export interface FreeTextPreviewData {
     verticalAlign?: PdfVerticalAlignment;
     contents?: string;
 }
+export interface LinkPreviewData {
+    rect: Rect;
+    strokeColor: string;
+    strokeWidth: number;
+    strokeStyle: PdfAnnotationBorderStyle;
+    strokeDashArray: number[];
+}
 /**
  * Map types to their preview data
  */
@@ -78,6 +85,7 @@ export interface PreviewDataMap {
     [PdfAnnotationSubtype.LINE]: LinePreviewData;
     [PdfAnnotationSubtype.INK]: InkPreviewData;
     [PdfAnnotationSubtype.FREETEXT]: FreeTextPreviewData;
+    [PdfAnnotationSubtype.LINK]: LinkPreviewData;
 }
 /**
  * Typed preview state - constrain T to keys that exist in PreviewDataMap
@@ -137,7 +145,7 @@ export interface HandlerContext<A extends PdfAnnotationObject> {
     pageRotation: Rotation;
     scale: number;
     services: HandlerServices;
-    onPreview: (state: AnyPreviewState | null) => void;
+    onPreview: (state: PreviewState<A['type']> | null) => void;
     onCommit: (annotation: A, context?: AnnotationCreateContext<A>) => void;
 }
 export interface SelectionHandlerContext<A extends PdfAnnotationObject = PdfAnnotationObject> {

package/dist/lib/helpers.d.ts

@@ -1,12 +1,11 @@
-import { PdfAnnotationSubtype, PdfAnnotationObject, Rect } from '@embedpdf/models';
-import { TrackedAnnotation } from './types';
+import { PdfAnnotationSubtype, PdfAnnotationObject, PdfAnnotationOf, Rect } from '@embedpdf/models';
+import { LockMode, TrackedAnnotation } from './types';
+import { AnnotationTool } from './tools/types';
 /**
  * Check if two rectangles intersect
  */
 export declare function rectsIntersect(a: Rect, b: Rect): boolean;
-export type AnnoOf<S extends PdfAnnotationSubtype> = Extract<PdfAnnotationObject, {
-    type: S;
-}>;
+export type AnnoOf<S extends PdfAnnotationSubtype> = PdfAnnotationOf<S>;
 export type TextMarkupSubtype = PdfAnnotationSubtype.HIGHLIGHT | PdfAnnotationSubtype.UNDERLINE | PdfAnnotationSubtype.STRIKEOUT | PdfAnnotationSubtype.SQUIGGLY;
 export type SidebarSubtype = TextMarkupSubtype | PdfAnnotationSubtype.TEXT | PdfAnnotationSubtype.INK | PdfAnnotationSubtype.SQUARE | PdfAnnotationSubtype.CIRCLE | PdfAnnotationSubtype.POLYGON | PdfAnnotationSubtype.LINE | PdfAnnotationSubtype.POLYLINE | PdfAnnotationSubtype.FREETEXT | PdfAnnotationSubtype.STAMP | PdfAnnotationSubtype.REDACT | PdfAnnotationSubtype.CARET;
 /** True when `a.object.type === INK` – and narrows the generic. */
@@ -28,4 +27,12 @@ export declare function isText(a: TrackedAnnotation): a is TrackedAnnotation<Ann
 export declare function isLink(a: TrackedAnnotation): a is TrackedAnnotation<AnnoOf<PdfAnnotationSubtype.LINK>>;
 export declare function isRedact(a: TrackedAnnotation): a is TrackedAnnotation<AnnoOf<PdfAnnotationSubtype.REDACT>>;
 export declare function isCaret(a: TrackedAnnotation): a is TrackedAnnotation<AnnoOf<PdfAnnotationSubtype.CARET>>;
+export declare function isWidget(a: TrackedAnnotation): a is TrackedAnnotation<AnnoOf<PdfAnnotationSubtype.WIDGET>>;
 export declare function isSidebarAnnotation(a: TrackedAnnotation): a is TrackedAnnotation<AnnoOf<SidebarSubtype>>;
+export declare function isSelectableAnnotation(a: TrackedAnnotation): boolean;
+/** Extract the category tags from a tool (returns `[]` for uncategorized). */
+export declare function getAnnotationCategories(tool: AnnotationTool | null): string[];
+/** Check if the category-based LockMode locks annotations with these categories. */
+export declare function isCategoryLocked(categories: string[], mode: LockMode): boolean;
+/** Check if the annotation itself has the PDF 'locked' flag (bit 7). */
+export declare function hasLockedFlag(annotation: PdfAnnotationObject): boolean;

package/dist/lib/index.d.ts

@@ -10,7 +10,11 @@ export * from './selectors';
 export * from './helpers';
 export * from './handlers/types';
 export * from './tools/types';
+export type { DefaultAnnotationTool, DefaultAnnotationToolMap } from './tools/default-tools';
 export * from './tools/tools-utils';
 export * from './geometry';
 export * as patching from './patching';
+export type { PatchFunction, TransformContext } from './patching/patch-registry';
 export { initialState, initialDocumentState } from './reducer';
+export { useState } from './utils/use-state';
+export { useClickDetector } from './handlers/click-detector';

package/dist/lib/reducer.d.ts

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