@embedpdf/plugin-annotation 2.14.0 → 2.14.2

package/dist/index.js

@@ -207,6 +207,22 @@ function hasLockedFlag(annotation) {
   var _a;
   return ((_a = annotation.flags) == null ? void 0 : _a.includes("locked")) ?? false;
 }
+function hasNoViewFlag(annotation) {
+  var _a;
+  return ((_a = annotation.flags) == null ? void 0 : _a.includes("noView")) ?? false;
+}
+function hasHiddenFlag(annotation) {
+  var _a;
+  return ((_a = annotation.flags) == null ? void 0 : _a.includes("hidden")) ?? false;
+}
+function hasReadOnlyFlag(annotation) {
+  var _a;
+  return ((_a = annotation.flags) == null ? void 0 : _a.includes("readOnly")) ?? false;
+}
+function hasLockedContentsFlag(annotation) {
+  var _a;
+  return ((_a = annotation.flags) == null ? void 0 : _a.includes("lockedContents")) ?? false;
+}
 const getAnnotationsByPageIndex = (s, page) => (s.pages[page] ?? []).map((uid) => s.byUid[uid]);
 const getAnnotations = (s) => {
   const out = {};
@@ -4749,7 +4765,7 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
       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) => isSelectableAnnotation(ta));
-      const selectedIds = pageAnnotations.filter((ta) => rectsIntersect(rect, ta.object.rect)).filter((ta) => !this.isAnnotationLocked(ta.object, documentId)).map((ta) => ta.object.id);
+      const selectedIds = pageAnnotations.filter((ta) => rectsIntersect(rect, ta.object.rect)).filter((ta) => this.isAnnotationSelectable(ta.object, documentId)).map((ta) => ta.object.id);
       if (selectedIds.length > 0) {
         const expandedIds = /* @__PURE__ */ new Set();
         for (const id of selectedIds) {
@@ -4848,6 +4864,9 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
       setLocked: (mode, documentId) => this.setLocked(mode, documentId),
       getLocked: (documentId) => this.getLocked(documentId),
       isAnnotationLocked: (annotation, documentId) => this.isAnnotationLocked(annotation, documentId),
+      isAnnotationInteractive: (annotation, documentId) => this.isAnnotationInteractive(annotation, documentId),
+      isAnnotationStructurallyLocked: (annotation, documentId) => this.isAnnotationStructurallyLocked(annotation, documentId),
+      isAnnotationContentLocked: (annotation, documentId) => this.isAnnotationContentLocked(annotation, documentId),
       isCategoryLocked: (category, documentId) => this.isCategoryLockedMethod(category, documentId),
       isToolLocked: (toolId, documentId) => this.isToolLockedMethod(toolId, documentId),
       // Sync (lightweight state update without commit)
@@ -4922,6 +4941,9 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
       setLocked: (mode) => this.setLocked(mode, documentId),
       getLocked: () => this.getLocked(documentId),
       isAnnotationLocked: (annotation) => this.isAnnotationLocked(annotation, documentId),
+      isAnnotationInteractive: (annotation) => this.isAnnotationInteractive(annotation, documentId),
+      isAnnotationStructurallyLocked: (annotation) => this.isAnnotationStructurallyLocked(annotation, documentId),
+      isAnnotationContentLocked: (annotation) => this.isAnnotationContentLocked(annotation, documentId),
       isCategoryLocked: (category) => this.isCategoryLockedMethod(category, documentId),
       isToolLocked: (toolId) => this.isToolLockedMethod(toolId, documentId),
       syncAnnotationObject: (id, patch) => this.syncAnnotationObject(id, patch, documentId),
@@ -5464,7 +5486,7 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
   selectAnnotation(pageIndex, id, documentId) {
     const docId = documentId ?? this.getActiveDocumentId();
     const ta = this.getAnnotationById(id, docId);
-    if (ta && this.isAnnotationLocked(ta.object, docId)) return;
+    if (ta && !this.isAnnotationSelectable(ta.object, docId)) return;
     if (this.isInGroupMethod(id, docId)) {
       const members = this.getGroupMembersMethod(id, docId);
       const memberIds = members.map((m) => m.object.id);
@@ -5510,7 +5532,7 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
   toggleSelectionMethod(pageIndex, id, documentId) {
     const docId = documentId ?? this.getActiveDocumentId();
     const ta = this.getAnnotationById(id, docId);
-    if (ta && this.isAnnotationLocked(ta.object, docId)) return;
+    if (ta && !this.isAnnotationSelectable(ta.object, docId)) return;
     const docState = this.getDocumentState(docId);
     if (docState.selectedUids.includes(id)) {
       this.dispatch(removeFromSelection(docId, id));
@@ -5530,7 +5552,7 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
   addToSelectionMethod(pageIndex, id, documentId) {
     const docId = documentId ?? this.getActiveDocumentId();
     const ta = this.getAnnotationById(id, docId);
-    if (ta && this.isAnnotationLocked(ta.object, docId)) return;
+    if (ta && !this.isAnnotationInteractive(ta.object, docId)) return;
     this.dispatch(addToSelection(docId, pageIndex, id));
   }
   removeFromSelectionMethod(id, documentId) {
@@ -5542,7 +5564,7 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
     const docState = this.getDocumentState(docId);
     const filtered = ids.filter((id) => {
       const ta = docState.byUid[id];
-      return !ta || !this.isAnnotationLocked(ta.object, docId);
+      return !ta || this.isAnnotationInteractive(ta.object, docId);
     });
     this.dispatch(setSelection(docId, filtered));
   }
@@ -6530,7 +6552,7 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
     const lockedSelected = updatedDocState.selectedUids.filter((uid) => {
       const ta = updatedDocState.byUid[uid];
       if (!ta) return false;
-      return this.isAnnotationLocked(ta.object, docId);
+      return !this.isAnnotationInteractive(ta.object, docId);
     });
     if (lockedSelected.length > 0) {
       const remaining = updatedDocState.selectedUids.filter((uid) => !lockedSelected.includes(uid));
@@ -6546,6 +6568,47 @@ const _AnnotationPlugin = class _AnnotationPlugin extends BasePlugin {
     const categories = getAnnotationCategories(tool);
     return isCategoryLocked(categories, this.getLocked(documentId));
   }
+  /**
+   * Whether the annotation can be interacted with at all (selected, edited, menu shown).
+   * Returns false for `noView`, `hidden`, `readOnly`, or category-locked annotations.
+   * This is the spec-compliant "can the user do anything with this?" predicate.
+   */
+  isAnnotationInteractive(annotation, documentId) {
+    if (hasNoViewFlag(annotation)) return false;
+    if (hasHiddenFlag(annotation)) return false;
+    if (hasReadOnlyFlag(annotation)) return false;
+    const tool = this.findToolForAnnotation(annotation);
+    const categories = getAnnotationCategories(tool);
+    if (isCategoryLocked(categories, this.getLocked(documentId))) return false;
+    return true;
+  }
+  /**
+   * Whether the annotation's structure (position, size, rotation, vertices) is locked.
+   * Non-interactive annotations are treated as structurally locked. PDF `locked` flag
+   * makes an otherwise-interactive annotation structurally locked while still selectable.
+   */
+  isAnnotationStructurallyLocked(annotation, documentId) {
+    if (!this.isAnnotationInteractive(annotation, documentId)) return true;
+    return hasLockedFlag(annotation);
+  }
+  /**
+   * Whether the annotation's content (e.g. FreeText text) is locked.
+   * Non-interactive annotations are treated as content-locked. PDF `lockedContents`
+   * flag blocks content edits while still allowing move/resize.
+   */
+  isAnnotationContentLocked(annotation, documentId) {
+    if (!this.isAnnotationInteractive(annotation, documentId)) return true;
+    return hasLockedContentsFlag(annotation);
+  }
+  /**
+   * Whether a specific annotation is eligible to be added to the selection store.
+   * Differs from the subtype-based `isSelectableAnnotation` helper: that answers
+   * "is this subtype ever selectable?", while this answers "is this specific
+   * annotation selectable right now given its flags and document lock state?".
+   */
+  isAnnotationSelectable(annotation, documentId) {
+    return this.isAnnotationInteractive(annotation, documentId);
+  }
   isCategoryLockedMethod(category, documentId) {
     return isCategoryLocked([category], this.getLocked(documentId));
   }
@@ -6878,9 +6941,13 @@ export {
   getSidebarAnnotationsWithRepliesGroupedByPage,
   getToolDefaultsById,
   hasAttachedLinks,
+  hasHiddenFlag,
   hasIRTChildren,
+  hasLockedContentsFlag,
   hasLockedFlag,
   hasMultipleSelected,
+  hasNoViewFlag,
+  hasReadOnlyFlag,
   inferRotationCenterFromRects2 as inferRotationCenterFromRects,
   initialDocumentState,
   initialState,