stimulus-pdf-viewer-rails 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 863e0c885d62300048eda7098bb47e91082b609197aa5712557f9e76c1a33cd2
-  data.tar.gz: c99cdaa21cd6318fdec59037bd07ec86d1aed8260f45bd17852c90305e903f77
+  metadata.gz: 2304be55407cf2f6bda31771ad7dff2bd54499278bb24b24e0429f161c835569
+  data.tar.gz: 28149508a79eaabd4b5f65120cb6758082b263e5b66540b693671e3a328d1424
 SHA512:
-  metadata.gz: 0a203691d3cc984e25cae915193472832086a52671137d9ccedf12dd8712033a99d3505c4cb664c5f5eb76943591bbb6f868703fbdf7b75ae3de5acd5957244d
-  data.tar.gz: 0bf609b800a496af6828e6382608214a75d6c7d2c583c3a34773797236fe73a7d66073369f28891908477fd6b02c40a19a7765b22d72f47f0d5baf1106087527
+  metadata.gz: 86c15ca518c858a764d8050175314e96244dd6941dd1b9556d58758e33f8e1767968516ca617e8a3dd9d13752caafbd6c2d1fb429658ba8981f7f730a8ec24d8
+  data.tar.gz: 757a7972ddabe9b0f12c737dda5336cd1be4f0a319faa73df52887e08bde64de84871cb1d22fce37f8fc571b3a648b1fa229bec9d1c29c3ae6f7f3a0d0a1973d

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.4.1] - 2026-08-10
+
+### Fixed
+- Updated stimulus-pdf-viewer to 0.4.1
+
+This fixes `initialAnnotation` deep-links, which never scrolled to or selected
+the annotation (a string/number id mismatch in the annotation map lookup), and
+gives deep-linked annotations the same flash/highlight treatment as sidebar
+clicks. See the upstream
+[0.4.1 changelog](https://github.com/jhubert/stimulus-pdf-viewer/blob/main/CHANGELOG.md)
+for full details.
+
 ## [0.4.0] - 2026-06-24
 
 ### Added

data/app/assets/javascripts/stimulus-pdf-viewer.esm.js

@@ -1729,7 +1729,7 @@ class AnnotationManager {
     this.annotationsByPage.clear();
 
     for (const annotation of annotationsData) {
-      this.annotations.set(annotation.id, annotation);
+      this.annotations.set(this._key(annotation.id), annotation);
 
       if (!this.annotationsByPage.has(annotation.page)) {
         this.annotationsByPage.set(annotation.page, []);
@@ -1738,8 +1738,14 @@ class AnnotationManager {
     }
   }
 
+  // Ids arrive as numbers from JSON payloads but as strings from DOM
+  // datasets and Stimulus values, so the map is keyed by string
+  _key(id) {
+    return String(id)
+  }
+
   getAnnotation(id) {
-    return this.annotations.get(id)
+    return this.annotations.get(this._key(id))
   }
 
   getAnnotationsForPage(pageNumber) {
@@ -1785,7 +1791,7 @@ class AnnotationManager {
   }
 
   async deleteAnnotation(id) {
-    const existingAnnotation = this.annotations.get(id);
+    const existingAnnotation = this.getAnnotation(id);
     if (!existingAnnotation) return
 
     try {
@@ -1824,7 +1830,7 @@ class AnnotationManager {
   }
 
   _addAnnotation(annotation) {
-    this.annotations.set(annotation.id, annotation);
+    this.annotations.set(this._key(annotation.id), annotation);
 
     if (!this.annotationsByPage.has(annotation.page)) {
       this.annotationsByPage.set(annotation.page, []);
@@ -1833,7 +1839,7 @@ class AnnotationManager {
   }
 
   _updateAnnotation(annotation) {
-    const oldAnnotation = this.annotations.get(annotation.id);
+    const oldAnnotation = this.getAnnotation(annotation.id);
     if (!oldAnnotation) {
       this._addAnnotation(annotation);
       return
@@ -1850,27 +1856,27 @@ class AnnotationManager {
     } else {
       // Update in place
       const pageAnnotations = this.annotationsByPage.get(annotation.page);
-      const index = pageAnnotations.findIndex(a => a.id === annotation.id);
+      const index = pageAnnotations.findIndex(a => this._key(a.id) === this._key(annotation.id));
       if (index !== -1) {
         pageAnnotations[index] = annotation;
       }
     }
 
-    this.annotations.set(annotation.id, annotation);
+    this.annotations.set(this._key(annotation.id), annotation);
   }
 
   _removeAnnotation(id) {
-    const annotation = this.annotations.get(id);
+    const annotation = this.getAnnotation(id);
     if (!annotation) return
 
     this._removeAnnotationFromPage(id, annotation.page);
-    this.annotations.delete(id);
+    this.annotations.delete(this._key(id));
   }
 
   _removeAnnotationFromPage(id, pageNumber) {
     const pageAnnotations = this.annotationsByPage.get(pageNumber);
     if (pageAnnotations) {
-      const index = pageAnnotations.findIndex(a => a.id === id);
+      const index = pageAnnotations.findIndex(a => this._key(a.id) === this._key(id));
       if (index !== -1) {
         pageAnnotations.splice(index, 1);
       }
@@ -4363,7 +4369,7 @@ class AnnotationSidebar {
     }
 
     // Selection state
-    if (this.selectedAnnotationId === annotation.id) {
+    if (this.selectedAnnotationId === String(annotation.id)) {
       item.classList.add("selected");
     }
 
@@ -4471,6 +4477,9 @@ class AnnotationSidebar {
   }
 
   _selectItem(annotationId) {
+    // Ids arrive as numbers from JSON payloads but as strings from DOM
+    // datasets and deep-links, so selection state is tracked as string
+    annotationId = String(annotationId);
     const previousId = this.selectedAnnotationId;
 
     // Skip if already selected
@@ -4527,7 +4536,7 @@ class AnnotationSidebar {
   onAnnotationDeleted(annotation) {
     if (this.isOpen) {
       // Clear selection if deleted annotation was selected
-      if (this.selectedAnnotationId === annotation.id) {
+      if (this.selectedAnnotationId === String(annotation.id)) {
         const previousId = this.selectedAnnotationId;
         this.selectedAnnotationId = null;
         this.element.dispatchEvent(new CustomEvent("pdf-sidebar:annotation-deselected", {
@@ -7527,9 +7536,10 @@ class PdfViewer {
         this.viewer.goToPage(this.initialPage);
       }
 
-      // Navigate to initial annotation if specified
+      // Navigate to initial annotation if specified, flashing it so
+      // deep-link visitors can spot it immediately
       if (this.initialAnnotation) {
-        this._scrollToAnnotation(this.initialAnnotation);
+        this._scrollToAnnotationWithFlash(this.initialAnnotation);
       }
 
       // Start with select tool
@@ -8428,20 +8438,9 @@ class PdfViewer {
     }
   }
 
-  _scrollToAnnotation(annotationId) {
-    const annotation = this.annotationManager.getAnnotation(annotationId);
-    if (!annotation) return
-
-    // Mark this annotation for selection when it's rendered
-    this.pendingAnnotationSelection = annotationId;
-
-    // Go to the page - the annotation will be selected in _renderAnnotationsForPage
-    this.viewer.goToPage(annotation.page);
-  }
-
   /**
    * Scroll to annotation and flash/highlight it.
-   * Called from the annotation sidebar when clicking an annotation.
+   * Called from the annotation sidebar and for initial deep-links.
    */
   _scrollToAnnotationWithFlash(annotationId) {
     const annotation = this.annotationManager.getAnnotation(annotationId);

data/app/assets/javascripts/stimulus-pdf-viewer.js

@@ -1749,7 +1749,7 @@
       this.annotationsByPage.clear();
 
       for (const annotation of annotationsData) {
-        this.annotations.set(annotation.id, annotation);
+        this.annotations.set(this._key(annotation.id), annotation);
 
         if (!this.annotationsByPage.has(annotation.page)) {
           this.annotationsByPage.set(annotation.page, []);
@@ -1758,8 +1758,14 @@
       }
     }
 
+    // Ids arrive as numbers from JSON payloads but as strings from DOM
+    // datasets and Stimulus values, so the map is keyed by string
+    _key(id) {
+      return String(id)
+    }
+
     getAnnotation(id) {
-      return this.annotations.get(id)
+      return this.annotations.get(this._key(id))
     }
 
     getAnnotationsForPage(pageNumber) {
@@ -1805,7 +1811,7 @@
     }
 
     async deleteAnnotation(id) {
-      const existingAnnotation = this.annotations.get(id);
+      const existingAnnotation = this.getAnnotation(id);
       if (!existingAnnotation) return
 
       try {
@@ -1844,7 +1850,7 @@
     }
 
     _addAnnotation(annotation) {
-      this.annotations.set(annotation.id, annotation);
+      this.annotations.set(this._key(annotation.id), annotation);
 
       if (!this.annotationsByPage.has(annotation.page)) {
         this.annotationsByPage.set(annotation.page, []);
@@ -1853,7 +1859,7 @@
     }
 
     _updateAnnotation(annotation) {
-      const oldAnnotation = this.annotations.get(annotation.id);
+      const oldAnnotation = this.getAnnotation(annotation.id);
       if (!oldAnnotation) {
         this._addAnnotation(annotation);
         return
@@ -1870,27 +1876,27 @@
       } else {
         // Update in place
         const pageAnnotations = this.annotationsByPage.get(annotation.page);
-        const index = pageAnnotations.findIndex(a => a.id === annotation.id);
+        const index = pageAnnotations.findIndex(a => this._key(a.id) === this._key(annotation.id));
         if (index !== -1) {
           pageAnnotations[index] = annotation;
         }
       }
 
-      this.annotations.set(annotation.id, annotation);
+      this.annotations.set(this._key(annotation.id), annotation);
     }
 
     _removeAnnotation(id) {
-      const annotation = this.annotations.get(id);
+      const annotation = this.getAnnotation(id);
       if (!annotation) return
 
       this._removeAnnotationFromPage(id, annotation.page);
-      this.annotations.delete(id);
+      this.annotations.delete(this._key(id));
     }
 
     _removeAnnotationFromPage(id, pageNumber) {
       const pageAnnotations = this.annotationsByPage.get(pageNumber);
       if (pageAnnotations) {
-        const index = pageAnnotations.findIndex(a => a.id === id);
+        const index = pageAnnotations.findIndex(a => this._key(a.id) === this._key(id));
         if (index !== -1) {
           pageAnnotations.splice(index, 1);
         }
@@ -4383,7 +4389,7 @@
       }
 
       // Selection state
-      if (this.selectedAnnotationId === annotation.id) {
+      if (this.selectedAnnotationId === String(annotation.id)) {
         item.classList.add("selected");
       }
 
@@ -4491,6 +4497,9 @@
     }
 
     _selectItem(annotationId) {
+      // Ids arrive as numbers from JSON payloads but as strings from DOM
+      // datasets and deep-links, so selection state is tracked as string
+      annotationId = String(annotationId);
       const previousId = this.selectedAnnotationId;
 
       // Skip if already selected
@@ -4547,7 +4556,7 @@
     onAnnotationDeleted(annotation) {
       if (this.isOpen) {
         // Clear selection if deleted annotation was selected
-        if (this.selectedAnnotationId === annotation.id) {
+        if (this.selectedAnnotationId === String(annotation.id)) {
           const previousId = this.selectedAnnotationId;
           this.selectedAnnotationId = null;
           this.element.dispatchEvent(new CustomEvent("pdf-sidebar:annotation-deselected", {
@@ -7547,9 +7556,10 @@
           this.viewer.goToPage(this.initialPage);
         }
 
-        // Navigate to initial annotation if specified
+        // Navigate to initial annotation if specified, flashing it so
+        // deep-link visitors can spot it immediately
         if (this.initialAnnotation) {
-          this._scrollToAnnotation(this.initialAnnotation);
+          this._scrollToAnnotationWithFlash(this.initialAnnotation);
         }
 
         // Start with select tool
@@ -8448,20 +8458,9 @@
       }
     }
 
-    _scrollToAnnotation(annotationId) {
-      const annotation = this.annotationManager.getAnnotation(annotationId);
-      if (!annotation) return
-
-      // Mark this annotation for selection when it's rendered
-      this.pendingAnnotationSelection = annotationId;
-
-      // Go to the page - the annotation will be selected in _renderAnnotationsForPage
-      this.viewer.goToPage(annotation.page);
-    }
-
     /**
      * Scroll to annotation and flash/highlight it.
-     * Called from the annotation sidebar when clicking an annotation.
+     * Called from the annotation sidebar and for initial deep-links.
      */
     _scrollToAnnotationWithFlash(annotationId) {
       const annotation = this.annotationManager.getAnnotation(annotationId);

data/lib/stimulus_pdf_viewer/rails/version.rb

@@ -1,7 +1,7 @@
 module StimulusPdfViewer
   module Rails
-    VERSION = "0.4.0"
+    VERSION = '0.4.1'
     # This should match the npm package version
-    STIMULUS_PDF_VIEWER_VERSION = "0.4.0"
+    STIMULUS_PDF_VIEWER_VERSION = '0.4.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stimulus-pdf-viewer-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Jeremy Baker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-24 00:00:00.000000000 Z
+date: 2026-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties