@embedpdf/plugin-annotation 2.7.0 → 2.8.0

package/dist/index.js

@@ -156,8 +156,11 @@ function isLink(a) {
 function isRedact(a) {
   return a.object.type === PdfAnnotationSubtype.REDACT;
 }
+function isCaret(a) {
+  return a.object.type === PdfAnnotationSubtype.CARET;
+}
 function isSidebarAnnotation(a) {
-  return isTextMarkup(a) || isInk(a) || isSquare(a) || isCircle(a) || isPolygon(a) || isLine(a) || isPolyline(a) || isFreeText(a) || isStamp(a) || isRedact(a);
+  return isText(a) && !a.object.inReplyToId || isTextMarkup(a) || isInk(a) || isSquare(a) || isCircle(a) || isPolygon(a) || isLine(a) || isPolyline(a) || isFreeText(a) || isStamp(a) || isRedact(a) || isCaret(a);
 }
 const getAnnotationsByPageIndex = (s, page) => (s.pages[page] ?? []).map((uid) => s.byUid[uid]);
 const getAnnotations = (s) => {
@@ -199,19 +202,33 @@ const getSidebarAnnotationsWithRepliesGroupedByPage = (s) => {
       }
     }
   }
+  const membersByLeader = {};
+  const consumedAsGroupMember = /* @__PURE__ */ new Set();
+  for (const uidList of Object.values(s.pages)) {
+    for (const uid of uidList) {
+      const ta = s.byUid[uid];
+      if (ta && ta.object.inReplyToId && ta.object.replyType === PdfAnnotationReplyType.Group && ta.object.type !== PdfAnnotationSubtype.LINK && isSidebarAnnotation(ta)) {
+        const leaderId = ta.object.inReplyToId;
+        (membersByLeader[leaderId] || (membersByLeader[leaderId] = [])).push(ta);
+        consumedAsGroupMember.add(ta.object.id);
+      }
+    }
+  }
   const out = {};
   for (const [pageStr, uidList] of Object.entries(s.pages)) {
     const page = Number(pageStr);
     const pageAnnotations = [];
     for (const uid of uidList) {
       const ta = s.byUid[uid];
-      if (ta && isSidebarAnnotation(ta)) {
-        pageAnnotations.push({
-          page,
-          annotation: ta,
-          replies: repliesByParent[ta.object.id] ?? []
-        });
-      }
+      if (!ta || !isSidebarAnnotation(ta)) continue;
+      if (consumedAsGroupMember.has(ta.object.id)) continue;
+      const members = membersByLeader[ta.object.id];
+      pageAnnotations.push({
+        page,
+        annotation: ta,
+        replies: repliesByParent[ta.object.id] ?? [],
+        ...members && members.length > 0 ? { groupMembers: members } : {}
+      });
     }
     if (pageAnnotations.length > 0) {
       out[page] = pageAnnotations;
@@ -334,6 +351,7 @@ const defaultTools = [
       textSelection: true,
       isDraggable: false,
       isResizable: false,
+      isRotatable: false,
       // Text markup annotations are anchored to text and should not move/resize in groups
       isGroupDraggable: false,
       isGroupResizable: false
@@ -356,6 +374,7 @@ const defaultTools = [
       textSelection: true,
       isDraggable: false,
       isResizable: false,
+      isRotatable: false,
       isGroupDraggable: false,
       isGroupResizable: false
     },
@@ -376,6 +395,7 @@ const defaultTools = [
       textSelection: true,
       isDraggable: false,
       isResizable: false,
+      isRotatable: false,
       isGroupDraggable: false,
       isGroupResizable: false
     },
@@ -396,6 +416,7 @@ const defaultTools = [
       textSelection: true,
       isDraggable: false,
       isResizable: false,
+      isRotatable: false,
       isGroupDraggable: false,
       isGroupResizable: false
     },
@@ -407,6 +428,59 @@ const defaultTools = [
       opacity: 1
     }
   },
+  // Insert Text (Caret with intent Insert)
+  {
+    id: "insertText",
+    name: "Insert Text",
+    matchScore: (a) => {
+      var _a;
+      if (a.type !== PdfAnnotationSubtype.CARET) return 0;
+      return ((_a = a.intent) == null ? void 0 : _a.includes("Insert")) ? 2 : 1;
+    },
+    interaction: {
+      exclusive: false,
+      textSelection: true,
+      showSelectionRects: true,
+      isDraggable: false,
+      isResizable: false,
+      isRotatable: false,
+      isGroupDraggable: false,
+      isGroupResizable: false
+    },
+    defaults: {
+      type: PdfAnnotationSubtype.CARET,
+      strokeColor: "#E44234",
+      opacity: 1,
+      intent: "Insert"
+    }
+  },
+  // Replace Text (StrikeOut + Caret group)
+  {
+    id: "replaceText",
+    name: "Replace Text",
+    matchScore: (a) => {
+      var _a, _b;
+      if (a.type === PdfAnnotationSubtype.STRIKEOUT && ((_a = a.intent) == null ? void 0 : _a.includes("StrikeOutTextEdit")))
+        return 2;
+      if (a.type === PdfAnnotationSubtype.CARET && ((_b = a.intent) == null ? void 0 : _b.includes("Replace"))) return 2;
+      return 0;
+    },
+    interaction: {
+      exclusive: false,
+      textSelection: true,
+      isDraggable: false,
+      isResizable: false,
+      isRotatable: false,
+      isGroupDraggable: false,
+      isGroupResizable: false
+    },
+    defaults: {
+      type: PdfAnnotationSubtype.STRIKEOUT,
+      strokeColor: "#E44234",
+      opacity: 1,
+      intent: "StrikeOutTextEdit"
+    }
+  },
   // Drawing Tools
   {
     id: "ink",
@@ -631,6 +705,26 @@ const defaultTools = [
     }
   },
   // Text & Stamp
+  {
+    id: "textComment",
+    name: "Comment",
+    matchScore: (a) => a.type === PdfAnnotationSubtype.TEXT && !a.inReplyToId ? 1 : 0,
+    interaction: {
+      exclusive: false,
+      cursor: "crosshair",
+      isDraggable: true,
+      isResizable: false,
+      isRotatable: false
+    },
+    defaults: {
+      type: PdfAnnotationSubtype.TEXT,
+      strokeColor: "#FFCD45",
+      opacity: 1
+    },
+    behavior: {
+      selectAfterCreate: true
+    }
+  },
   {
     id: "freeText",
     name: "Free Text",
@@ -952,7 +1046,7 @@ const reducer = (state, action) => {
             },
             byUid: {
               ...docState.byUid,
-              [uid]: { commitState: "new", object: annotation }
+              [uid]: { commitState: "new", object: annotation, dictMode: true }
             },
             hasPendingChanges: true
           }
@@ -1182,45 +1276,6 @@ const inkHandlerFactory = {
     };
   }
 };
-function useClickDetector({
-  threshold = 5,
-  getTool,
-  onClickDetected
-}) {
-  const [getStartPos, setStartPos] = useState(null);
-  const [getHasMoved, setHasMoved] = useState(false);
-  return {
-    onStart: (pos) => {
-      setStartPos(pos);
-      setHasMoved(false);
-    },
-    onMove: (pos) => {
-      const start = getStartPos();
-      if (!start || getHasMoved()) return;
-      const distance = Math.sqrt(Math.pow(pos.x - start.x, 2) + Math.pow(pos.y - start.y, 2));
-      if (distance > threshold) {
-        setHasMoved(true);
-      }
-    },
-    onEnd: (pos) => {
-      var _a;
-      const start = getStartPos();
-      if (start && !getHasMoved()) {
-        const tool = getTool();
-        if (tool && "clickBehavior" in tool && ((_a = tool.clickBehavior) == null ? void 0 : _a.enabled)) {
-          onClickDetected(pos, tool);
-        }
-      }
-      setStartPos(null);
-      setHasMoved(false);
-    },
-    hasMoved: getHasMoved,
-    reset: () => {
-      setStartPos(null);
-      setHasMoved(false);
-    }
-  };
-}
 function createArrowHandler(isClosed) {
   const calculateGeometry = (sw) => {
     const len = sw * 9;
@@ -1601,6 +1656,75 @@ const index = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.definePropert
   rotatePointAroundCenter: rotatePointAround,
   rotateVertices
 }, Symbol.toStringTag, { value: "Module" }));
+const COMMENT_SIZE = 24;
+const textHandlerFactory = {
+  annotationType: PdfAnnotationSubtype.TEXT,
+  create(context) {
+    const { onCommit, getTool, pageSize } = context;
+    return {
+      onPointerDown: (pos) => {
+        const tool = getTool();
+        if (!tool) return;
+        const rect = {
+          origin: { x: pos.x - COMMENT_SIZE / 2, y: pos.y - COMMENT_SIZE / 2 },
+          size: { width: COMMENT_SIZE, height: COMMENT_SIZE }
+        };
+        let anno = {
+          ...tool.defaults,
+          rect,
+          type: PdfAnnotationSubtype.TEXT,
+          icon: tool.defaults.icon ?? PdfAnnotationIcon.Comment,
+          contents: tool.defaults.contents ?? "",
+          flags: tool.defaults.flags ?? ["print", "noRotate", "noZoom"],
+          pageIndex: context.pageIndex,
+          id: uuidV4(),
+          created: /* @__PURE__ */ new Date()
+        };
+        anno = clampAnnotationToPage(anno, pageSize);
+        onCommit(anno);
+      }
+    };
+  }
+};
+function useClickDetector({
+  threshold = 5,
+  getTool,
+  onClickDetected
+}) {
+  const [getStartPos, setStartPos] = useState(null);
+  const [getHasMoved, setHasMoved] = useState(false);
+  return {
+    onStart: (pos) => {
+      setStartPos(pos);
+      setHasMoved(false);
+    },
+    onMove: (pos) => {
+      const start = getStartPos();
+      if (!start || getHasMoved()) return;
+      const distance = Math.sqrt(Math.pow(pos.x - start.x, 2) + Math.pow(pos.y - start.y, 2));
+      if (distance > threshold) {
+        setHasMoved(true);
+      }
+    },
+    onEnd: (pos) => {
+      var _a;
+      const start = getStartPos();
+      if (start && !getHasMoved()) {
+        const tool = getTool();
+        if (tool && "clickBehavior" in tool && ((_a = tool.clickBehavior) == null ? void 0 : _a.enabled)) {
+          onClickDetected(pos, tool);
+        }
+      }
+      setStartPos(null);
+      setHasMoved(false);
+    },
+    hasMoved: getHasMoved,
+    reset: () => {
+      setStartPos(null);
+      setHasMoved(false);
+    }
+  };
+}
 const freeTextHandlerFactory = {
   annotationType: PdfAnnotationSubtype.FREETEXT,
   create(context) {
@@ -2453,6 +2577,135 @@ const circleHandlerFactory = {
     };
   }
 };
+const textMarkupSelectionHandler = {
+  toolId: "__textMarkup__",
+  handle(context, selections, getText) {
+    const tool = context.getTool();
+    if (!tool) return;
+    for (const selection of selections) {
+      const id = uuidV4();
+      getText().then((text) => {
+        var _a;
+        context.createAnnotation(selection.pageIndex, {
+          ...tool.defaults,
+          rect: selection.rect,
+          segmentRects: selection.segmentRects,
+          pageIndex: selection.pageIndex,
+          created: /* @__PURE__ */ new Date(),
+          id,
+          ...text != null && { custom: { text } }
+        });
+        if ((_a = tool.behavior) == null ? void 0 : _a.selectAfterCreate) {
+          context.selectAnnotation(selection.pageIndex, id);
+        }
+      });
+    }
+  }
+};
+function computeCaretRect(lastSegRect) {
+  const lineHeight = lastSegRect.size.height;
+  const height = lineHeight / 2;
+  const width = height;
+  const lineEndX = lastSegRect.origin.x + lastSegRect.size.width;
+  return {
+    origin: {
+      x: lineEndX - width / 2,
+      y: lastSegRect.origin.y + lineHeight / 2
+    },
+    size: { width, height }
+  };
+}
+const insertTextSelectionHandler = {
+  toolId: "insertText",
+  handle(context, selections, getText) {
+    const tool = context.getTool();
+    if (!tool) return;
+    const getDefaults = () => ({
+      strokeColor: tool.defaults.strokeColor ?? "#E44234",
+      opacity: tool.defaults.opacity ?? 1,
+      flags: tool.defaults.flags ?? ["print"]
+    });
+    for (const selection of selections) {
+      const lastSegRect = selection.segmentRects[selection.segmentRects.length - 1];
+      if (!lastSegRect) continue;
+      const caretRect = computeCaretRect(lastSegRect);
+      const caretId = uuidV4();
+      const defaults = getDefaults();
+      getText().then((text) => {
+        var _a;
+        context.createAnnotation(selection.pageIndex, {
+          type: PdfAnnotationSubtype.CARET,
+          id: caretId,
+          pageIndex: selection.pageIndex,
+          rect: caretRect,
+          strokeColor: defaults.strokeColor,
+          opacity: defaults.opacity,
+          intent: "Insert",
+          rectangleDifferences: { left: 0.5, top: 0.5, right: 0.5, bottom: 0.5 },
+          created: /* @__PURE__ */ new Date(),
+          flags: defaults.flags,
+          ...text != null && { custom: { text } }
+        });
+        if ((_a = tool.behavior) == null ? void 0 : _a.selectAfterCreate) {
+          context.selectAnnotation(selection.pageIndex, caretId);
+        }
+      });
+    }
+  }
+};
+const replaceTextSelectionHandler = {
+  toolId: "replaceText",
+  handle(context, selections, getText) {
+    const tool = context.getTool();
+    if (!tool) return;
+    const getDefaults = () => ({
+      strokeColor: tool.defaults.strokeColor ?? "#E44234",
+      opacity: tool.defaults.opacity ?? 1,
+      flags: tool.defaults.flags ?? ["print"]
+    });
+    for (const selection of selections) {
+      const lastSegRect = selection.segmentRects[selection.segmentRects.length - 1];
+      if (!lastSegRect) continue;
+      const caretRect = computeCaretRect(lastSegRect);
+      const caretId = uuidV4();
+      const strikeoutId = uuidV4();
+      const defaults = getDefaults();
+      getText().then((text) => {
+        var _a;
+        context.createAnnotation(selection.pageIndex, {
+          type: PdfAnnotationSubtype.CARET,
+          id: caretId,
+          pageIndex: selection.pageIndex,
+          rect: caretRect,
+          strokeColor: defaults.strokeColor,
+          opacity: defaults.opacity,
+          intent: "Replace",
+          rectangleDifferences: { left: 0.5, top: 0.5, right: 0.5, bottom: 0.5 },
+          created: /* @__PURE__ */ new Date(),
+          flags: defaults.flags
+        });
+        context.createAnnotation(selection.pageIndex, {
+          type: PdfAnnotationSubtype.STRIKEOUT,
+          id: strikeoutId,
+          pageIndex: selection.pageIndex,
+          rect: selection.rect,
+          segmentRects: selection.segmentRects,
+          strokeColor: defaults.strokeColor,
+          opacity: defaults.opacity,
+          intent: "StrikeOutTextEdit",
+          inReplyToId: caretId,
+          replyType: PdfAnnotationReplyType.Group,
+          created: /* @__PURE__ */ new Date(),
+          flags: defaults.flags,
+          ...text != null && { custom: { text } }
+        });
+        if ((_a = tool.behavior) == null ? void 0 : _a.selectAfterCreate) {
+          context.selectAnnotation(selection.pageIndex, caretId);
+        }
+      });
+    }
+  }
+};
 const patchInk = (original, ctx) => {
   switch (ctx.type) {
     case "vertex-edit":
@@ -2881,6 +3134,7 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
     this.importQueue = /* @__PURE__ */ new Map();
     this.commitInProgress = /* @__PURE__ */ new Map();
     this.handlerFactories = /* @__PURE__ */ new Map();
+    this.selectionHandlerFactories = /* @__PURE__ */ new Map();
     this.activeTool$ = createBehaviorEmitter();
     this.events$ = createBehaviorEmitter();
     this.toolsChange$ = createBehaviorEmitter();
@@ -2897,6 +3151,7 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
     this.history = ((_b = registry.getPlugin("history")) == null ? void 0 : _b.provides()) ?? null;
     this.interactionManager = ((_c = registry.getPlugin("interaction-manager")) == null ? void 0 : _c.provides()) ?? null;
     this.registerHandlerFactories();
+    this.registerSelectionHandlerFactories();
     this.registerBuiltInPatches();
   }
   // ─────────────────────────────────────────────────────────
@@ -2922,7 +3177,7 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
       for (const tool of this.state.tools) {
         if (tool.interaction.textSelection) {
           this.selection.enableForMode(tool.interaction.mode ?? tool.id, {
-            showSelectionRects: false,
+            showSelectionRects: tool.interaction.showSelectionRects ?? false,
             enableSelection: true,
             enableMarquee: false
           });
@@ -2951,6 +3206,11 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
     this.handlerFactories.set(PdfAnnotationSubtype.LINE, lineHandlerFactory);
     this.handlerFactories.set(PdfAnnotationSubtype.INK, inkHandlerFactory);
     this.handlerFactories.set(PdfAnnotationSubtype.FREETEXT, freeTextHandlerFactory);
+    this.handlerFactories.set(PdfAnnotationSubtype.TEXT, textHandlerFactory);
+  }
+  registerSelectionHandlerFactories() {
+    this.selectionHandlerFactories.set("insertText", insertTextSelectionHandler);
+    this.selectionHandlerFactories.set("replaceText", replaceTextSelectionHandler);
   }
   registerBuiltInPatches() {
     this.patchRegistry.register(PdfAnnotationSubtype.INK, patchInk);
@@ -2984,7 +3244,7 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
       if (modeId !== "pointerMode") return;
       const docState = this.state.documents[documentId];
       if (!docState) return;
-      const pageAnnotations = (docState.pages[pageIndex] ?? []).map((uid) => docState.byUid[uid]).filter((ta) => ta !== void 0).filter((ta) => !isLink(ta));
+      const pageAnnotations = (docState.pages[pageIndex] ?? []).map((uid) => docState.byUid[uid]).filter((ta) => ta !== void 0).filter((ta) => isSidebarAnnotation(ta));
       const selectedIds = pageAnnotations.filter((ta) => rectsIntersect(rect, ta.object.rect)).map((ta) => ta.object.id);
       if (selectedIds.length > 0) {
         const expandedIds = /* @__PURE__ */ new Set();
@@ -3002,44 +3262,32 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
       }
     });
     (_c = this.selection) == null ? void 0 : _c.onEndSelection(({ documentId }) => {
-      var _a2, _b2, _c2;
-      if (!this.checkPermission(documentId, PdfPermissionFlag.ModifyAnnotations)) {
-        return;
-      }
+      var _a2, _b2, _c2, _d;
+      if (!this.checkPermission(documentId, PdfPermissionFlag.ModifyAnnotations)) return;
       const activeTool = this.getActiveTool(documentId);
       if (!activeTool || !activeTool.interaction.textSelection) return;
       const formattedSelection = (_a2 = this.selection) == null ? void 0 : _a2.getFormattedSelection();
       const selectionText = (_b2 = this.selection) == null ? void 0 : _b2.getSelectedText();
       if (!formattedSelection || !selectionText) return;
-      for (const selection of formattedSelection) {
-        selectionText.wait((text) => {
-          var _a3, _b3;
-          const annotationId = uuidV4();
-          this.createAnnotation(
-            selection.pageIndex,
-            {
-              ...activeTool.defaults,
-              rect: selection.rect,
-              segmentRects: selection.segmentRects,
-              pageIndex: selection.pageIndex,
-              created: /* @__PURE__ */ new Date(),
-              id: annotationId,
-              custom: {
-                text: text.join("\n")
-              }
-            },
-            void 0,
-            documentId
-          );
-          if ((_a3 = activeTool.behavior) == null ? void 0 : _a3.deactivateToolAfterCreate) {
-            this.setActiveTool(null, documentId);
-          }
-          if ((_b3 = activeTool.behavior) == null ? void 0 : _b3.selectAfterCreate) {
-            this.selectAnnotation(selection.pageIndex, annotationId, documentId);
-          }
-        }, ignore);
+      const getText = () => new Promise((resolve) => {
+        selectionText.wait(
+          (text) => resolve(text.join("\n")),
+          () => resolve(void 0)
+        );
+      });
+      const context = {
+        toolId: activeTool.id,
+        documentId,
+        getTool: () => this.getActiveTool(documentId) ?? null,
+        createAnnotation: (pageIndex, annotation) => this.createAnnotation(pageIndex, annotation, void 0, documentId),
+        selectAnnotation: (pageIndex, id) => this.selectAnnotation(pageIndex, id, documentId)
+      };
+      const handler = this.selectionHandlerFactories.get(activeTool.id) ?? textMarkupSelectionHandler;
+      handler.handle(context, formattedSelection, getText);
+      if ((_c2 = activeTool.behavior) == null ? void 0 : _c2.deactivateToolAfterCreate) {
+        this.setActiveTool(null, documentId);
       }
-      (_c2 = this.selection) == null ? void 0 : _c2.clear();
+      (_d = this.selection) == null ? void 0 : _d.clear();
     });
   }
   registerInteractionForTool(tool) {
@@ -4867,6 +5115,8 @@ const isPolylineTool = createToolPredicate("polyline");
 const isPolygonTool = createToolPredicate("polygon");
 const isFreeTextTool = createToolPredicate("freeText");
 const isStampTool = createToolPredicate("stamp");
+const isInsertTextTool = createToolPredicate("insertText");
+const isReplaceTextTool = createToolPredicate("replaceText");
 const AnnotationPluginPackage = {
   manifest,
   create: (registry, config) => new AnnotationPlugin(ANNOTATION_PLUGIN_ID, registry, config),
@@ -4906,6 +5156,7 @@ export {
   initialDocumentState,
   initialState,
   isAnnotationSelected,
+  isCaret,
   isCircle,
   isCircleTool,
   isFreeText,
@@ -4916,6 +5167,7 @@ export {
   isInk,
   isInkHighlighterTool,
   isInkTool,
+  isInsertTextTool,
   isLine,
   isLineTool,
   isLink,
@@ -4924,6 +5176,7 @@ export {
   isPolyline,
   isPolylineTool,
   isRedact,
+  isReplaceTextTool,
   isSidebarAnnotation,
   isSquare,
   isSquareTool,