@embedpdf/plugin-annotation 2.6.1 → 2.7.0

package/dist/index.js

@@ -28,6 +28,7 @@ const SET_SELECTION = "ANNOTATION/SET_SELECTION";
 const SET_ACTIVE_TOOL_ID = "ANNOTATION/SET_ACTIVE_TOOL_ID";
 const CREATE_ANNOTATION = "ANNOTATION/CREATE_ANNOTATION";
 const PATCH_ANNOTATION = "ANNOTATION/PATCH_ANNOTATION";
+const MOVE_ANNOTATION = "ANNOTATION/MOVE_ANNOTATION";
 const DELETE_ANNOTATION = "ANNOTATION/DELETE_ANNOTATION";
 const COMMIT_PENDING_CHANGES = "ANNOTATION/COMMIT";
 const PURGE_ANNOTATION = "ANNOTATION/PURGE_ANNOTATION";
@@ -76,6 +77,10 @@ const patchAnnotation = (documentId, pageIndex, id, patch) => ({
   type: PATCH_ANNOTATION,
   payload: { documentId, pageIndex, id, patch }
 });
+const moveAnnotation = (documentId, pageIndex, id, patch) => ({
+  type: MOVE_ANNOTATION,
+  payload: { documentId, pageIndex, id, patch }
+});
 const deleteAnnotation = (documentId, pageIndex, id) => ({
   type: DELETE_ANNOTATION,
   payload: { documentId, pageIndex, id }
@@ -681,7 +686,8 @@ const defaultTools = [
       // No imageSrc by default, which tells the UI to open a file picker
     },
     behavior: {
-      insertUpright: true
+      insertUpright: true,
+      useAppearanceStream: false
     }
   }
 ];
@@ -715,7 +721,25 @@ const patchAnno = (docState, uid, patch) => {
       ...docState.byUid,
       [uid]: {
         ...prev,
-        commitState: prev.commitState === "synced" ? "dirty" : prev.commitState,
+        commitState: prev.commitState === "synced" || prev.commitState === "moved" ? "dirty" : prev.commitState,
+        object: { ...prev.object, ...patch },
+        dictMode: true
+      }
+    },
+    hasPendingChanges: true
+  };
+};
+const moveAnno = (docState, uid, patch) => {
+  const prev = docState.byUid[uid];
+  if (!prev) return docState;
+  return {
+    ...docState,
+    byUid: {
+      ...docState.byUid,
+      [uid]: {
+        ...prev,
+        // synced -> moved, moved -> moved, dirty stays dirty, new stays new
+        commitState: prev.commitState === "synced" ? "moved" : prev.commitState,
         object: { ...prev.object, ...patch }
       }
     },
@@ -970,6 +994,18 @@ const reducer = (state, action) => {
         }
       };
     }
+    case MOVE_ANNOTATION: {
+      const { documentId, id, patch } = action.payload;
+      const docState = state.documents[documentId];
+      if (!docState) return state;
+      return {
+        ...state,
+        documents: {
+          ...state.documents,
+          [documentId]: moveAnno(docState, id, patch)
+        }
+      };
+    }
     case COMMIT_PENDING_CHANGES: {
       const { documentId, committedUids } = action.payload;
       const docState = state.documents[documentId];
@@ -981,11 +1017,11 @@ const reducer = (state, action) => {
         if (committedSet.has(uid)) {
           cleaned[uid] = {
             ...ta,
-            commitState: ta.commitState === "dirty" || ta.commitState === "new" ? "synced" : ta.commitState
+            commitState: ta.commitState === "dirty" || ta.commitState === "new" || ta.commitState === "moved" ? "synced" : ta.commitState
           };
         } else {
           cleaned[uid] = ta;
-          if (ta.commitState === "new" || ta.commitState === "dirty" || ta.commitState === "deleted") {
+          if (ta.commitState === "new" || ta.commitState === "dirty" || ta.commitState === "moved" || ta.commitState === "deleted") {
             stillHasPending = true;
           }
         }
@@ -2849,6 +2885,7 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
     this.events$ = createBehaviorEmitter();
     this.toolsChange$ = createBehaviorEmitter();
     this.patchRegistry = new PatchRegistry();
+    this.appearanceCache = /* @__PURE__ */ new Map();
     this.unifiedDragStates = /* @__PURE__ */ new Map();
     this.unifiedDrag$ = createBehaviorEmitter();
     this.unifiedResizeStates = /* @__PURE__ */ new Map();
@@ -2898,6 +2935,7 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
     this.pendingContexts.delete(documentId);
     this.isInitialLoadComplete.delete(documentId);
     this.importQueue.delete(documentId);
+    this.appearanceCache.delete(documentId);
     this.logger.debug(
       "AnnotationPlugin",
       "DocumentClosed",
@@ -3034,10 +3072,13 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
       createAnnotation: (pageIndex, anno, ctx) => this.createAnnotation(pageIndex, anno, ctx),
       updateAnnotation: (pageIndex, id, patch) => this.updateAnnotation(pageIndex, id, patch),
       updateAnnotations: (patches) => this.updateAnnotationsMethod(patches),
+      moveAnnotation: (pageIndex, id, position, mode, documentId) => this.moveAnnotationMethod(pageIndex, id, position, mode, documentId),
       deleteAnnotation: (pageIndex, id) => this.deleteAnnotation(pageIndex, id),
       deleteAnnotations: (annotations, documentId) => this.deleteAnnotationsMethod(annotations, documentId),
       purgeAnnotation: (pageIndex, id, documentId) => this.purgeAnnotationMethod(pageIndex, id, documentId),
       renderAnnotation: (options) => this.renderAnnotation(options),
+      getPageAppearances: (pageIndex, options, documentId) => this.getPageAppearances(pageIndex, options, documentId),
+      invalidatePageAppearances: (pageIndex, documentId) => this.invalidatePageAppearances(pageIndex, documentId),
       commit: () => this.commit(),
       // Attached links (IRT link children)
       getAttachedLinks: (id, documentId) => this.getAttachedLinksMethod(id, documentId),
@@ -3094,10 +3135,13 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
       createAnnotation: (pageIndex, anno, ctx) => this.createAnnotation(pageIndex, anno, ctx, documentId),
       updateAnnotation: (pageIndex, id, patch) => this.updateAnnotation(pageIndex, id, patch, documentId),
       updateAnnotations: (patches) => this.updateAnnotationsMethod(patches, documentId),
+      moveAnnotation: (pageIndex, id, position, mode) => this.moveAnnotationMethod(pageIndex, id, position, mode, documentId),
       deleteAnnotation: (pageIndex, id) => this.deleteAnnotation(pageIndex, id, documentId),
       deleteAnnotations: (annotations) => this.deleteAnnotationsMethod(annotations, documentId),
       purgeAnnotation: (pageIndex, id) => this.purgeAnnotationMethod(pageIndex, id, documentId),
       renderAnnotation: (options) => this.renderAnnotation(options, documentId),
+      getPageAppearances: (pageIndex, options) => this.getPageAppearances(pageIndex, options, documentId),
+      invalidatePageAppearances: (pageIndex) => this.invalidatePageAppearances(pageIndex, documentId),
       commit: () => this.commit(documentId),
       getAttachedLinks: (id) => this.getAttachedLinksMethod(id, documentId),
       hasAttachedLinks: (id) => this.hasAttachedLinksMethod(id, documentId),
@@ -3269,6 +3313,67 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
     }
     return this.engine.renderPageAnnotation(doc, page, annotation, options);
   }
+  /**
+   * Batch-fetch rendered appearance stream images for all annotations on a page.
+   * Results are cached per document + page. Call invalidatePageAppearances to clear.
+   */
+  getPageAppearances(pageIndex, options, documentId) {
+    const id = documentId ?? this.getActiveDocumentId();
+    const docState = this.getCoreDocument(id);
+    const doc = docState == null ? void 0 : docState.document;
+    if (!doc) {
+      return PdfTaskHelper.reject({ code: PdfErrorCode.NotFound, message: "Document not found" });
+    }
+    const page = doc.pages.find((p) => p.index === pageIndex);
+    if (!page) {
+      return PdfTaskHelper.reject({ code: PdfErrorCode.NotFound, message: "Page not found" });
+    }
+    let docCache = this.appearanceCache.get(id);
+    if (!docCache) {
+      docCache = /* @__PURE__ */ new Map();
+      this.appearanceCache.set(id, docCache);
+    }
+    const cached = docCache.get(pageIndex);
+    if (cached && !options) {
+      const task = new Task();
+      task.resolve(cached);
+      return task;
+    }
+    const engineTask = this.engine.renderPageAnnotations(doc, page, options);
+    const resultTask = new Task();
+    engineTask.wait(
+      (result) => {
+        docCache.set(pageIndex, result);
+        resultTask.resolve(result);
+      },
+      (error) => {
+        resultTask.fail(error);
+      }
+    );
+    return resultTask;
+  }
+  /**
+   * Clear cached appearances for a specific page (e.g. on zoom change).
+   */
+  invalidatePageAppearances(pageIndex, documentId) {
+    const id = documentId ?? this.getActiveDocumentId();
+    const docCache = this.appearanceCache.get(id);
+    if (docCache) {
+      docCache.delete(pageIndex);
+    }
+  }
+  /**
+   * Remove a single annotation's entry from the page appearance cache.
+   * Used after committing changes that regenerate the annotation's appearance.
+   */
+  invalidateAnnotationAppearance(annotId, pageIndex, documentId) {
+    const id = documentId ?? this.getActiveDocumentId();
+    const docCache = this.appearanceCache.get(id);
+    if (!docCache) return;
+    const pageMap = docCache.get(pageIndex);
+    if (!pageMap) return;
+    delete pageMap[annotId];
+  }
   importAnnotations(items, documentId) {
     const id = documentId ?? this.getActiveDocumentId();
     if (!this.isInitialLoadComplete.get(id)) {
@@ -3840,7 +3945,7 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
         patches.push({ pageIndex: ta.object.pageIndex, id, patch });
       }
       if (patches.length > 0) {
-        this.updateAnnotationsMethod(patches, documentId);
+        this.moveAnnotationsMethod(patches, documentId);
       }
     }
     const endPatches = this.computeDragPreviewPatches(state, documentId);
@@ -4424,6 +4529,87 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
     const historyScope = this.history.forDocument(docId);
     historyScope.register(command, this.ANNOTATION_HISTORY_TOPIC);
   }
+  moveAnnotationsMethod(patches, documentId) {
+    const docId = documentId ?? this.getActiveDocumentId();
+    if (!this.checkPermission(docId, PdfPermissionFlag.ModifyAnnotations)) {
+      this.logger.debug(
+        "AnnotationPlugin",
+        "MoveAnnotations",
+        `Cannot move annotations: document ${docId} lacks ModifyAnnotations permission`
+      );
+      return;
+    }
+    const docState = this.getDocumentState(docId);
+    const moveData = patches.map(({ pageIndex, id, patch }) => {
+      var _a;
+      const originalObject = (_a = docState.byUid[id]) == null ? void 0 : _a.object;
+      if (!originalObject) return null;
+      return { pageIndex, id, patch, originalObject };
+    }).filter((p) => p !== null);
+    if (moveData.length === 0) return;
+    const execute = () => {
+      for (const { pageIndex, id, patch, originalObject } of moveData) {
+        this.dispatch(moveAnnotation(docId, pageIndex, id, patch));
+        this.events$.emit({
+          type: "update",
+          documentId: docId,
+          annotation: originalObject,
+          pageIndex,
+          patch,
+          committed: false
+        });
+      }
+    };
+    if (!this.history) {
+      execute();
+      if (this.config.autoCommit !== false) {
+        this.commit(docId);
+      }
+      return;
+    }
+    const undoData = moveData.map(({ pageIndex, id, patch, originalObject }) => ({
+      pageIndex,
+      id,
+      originalPatch: Object.fromEntries(
+        Object.keys(patch).map((key) => [key, originalObject[key]])
+      ),
+      originalObject
+    }));
+    const command = {
+      execute,
+      undo: () => {
+        for (const { pageIndex, id, originalPatch, originalObject } of undoData) {
+          this.dispatch(moveAnnotation(docId, pageIndex, id, originalPatch));
+          this.events$.emit({
+            type: "update",
+            documentId: docId,
+            annotation: originalObject,
+            pageIndex,
+            patch: originalPatch,
+            committed: false
+          });
+        }
+      },
+      metadata: { annotationIds: moveData.map((p) => p.id) }
+    };
+    const historyScope = this.history.forDocument(docId);
+    historyScope.register(command, this.ANNOTATION_HISTORY_TOPIC);
+  }
+  moveAnnotationMethod(pageIndex, annotationId, position, mode = "delta", documentId) {
+    const docId = documentId ?? this.getActiveDocumentId();
+    const ta = this.getAnnotationById(annotationId, docId);
+    if (!ta) return;
+    const currentRect = ta.object.rect;
+    const newRect = {
+      ...currentRect,
+      origin: mode === "absolute" ? { x: position.x, y: position.y } : { x: currentRect.origin.x + position.x, y: currentRect.origin.y + position.y }
+    };
+    const patch = this.transformAnnotation(ta.object, {
+      type: "move",
+      changes: { rect: newRect }
+    });
+    this.moveAnnotationsMethod([{ pageIndex, id: annotationId, patch }], docId);
+  }
   getActiveTool(documentId) {
     const docState = this.getDocumentState(documentId);
     if (!docState.activeToolId) return null;
@@ -4493,6 +4679,9 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
             ctx: contexts == null ? void 0 : contexts.get(ta.object.id)
           });
           break;
+        case "moved":
+          batch.updates.push({ uid, ta, moved: true });
+          break;
         case "dirty":
           batch.updates.push({ uid, ta });
           break;
@@ -4517,11 +4706,11 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
       const createTask = this.engine.createPageAnnotation(doc, page, ta.object, ctx);
       pendingOps.push({ type: "create", task: createTask, ta, uid, ctx });
     }
-    for (const { uid, ta } of batch.updates) {
+    for (const { uid, ta, moved } of batch.updates) {
       const page = doc.pages.find((p) => p.index === ta.object.pageIndex);
       if (!page) continue;
-      const updateTask = this.engine.updatePageAnnotation(doc, page, ta.object);
-      pendingOps.push({ type: "update", task: updateTask, ta, uid });
+      const updateTask = moved ? this.engine.updatePageAnnotation(doc, page, ta.object, { regenerateAppearance: false }) : this.engine.updatePageAnnotation(doc, page, ta.object);
+      pendingOps.push({ type: "update", task: updateTask, ta, uid, moved });
     }
     for (const { uid, ta } of batch.deletions) {
       const page = doc.pages.find((p) => p.index === ta.object.pageIndex);
@@ -4539,6 +4728,12 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
     Task.allSettled(allTasks).wait(
       () => {
         this.emitCommitEvents(docId, pendingOps, contexts);
+        for (const op of pendingOps) {
+          if (op.type === "update" && op.moved) continue;
+          if (op.type === "create" || op.type === "update" || op.type === "delete") {
+            this.invalidateAnnotationAppearance(op.ta.object.id, op.ta.object.pageIndex, docId);
+          }
+        }
         this.dispatch(commitPendingChanges(docId, batch.committedUids));
         task.resolve(true);
       },