@internetarchive/bookreader 5.0.0-66 → 5.0.0-67

package/BookReaderDemo/demo-internetarchive.html

@@ -161,6 +161,44 @@
             </li>
           </ul>
         </li>
+        <li>
+          Chapters
+          <ul>
+            <li>
+              Normal book with chapters
+              <ul>
+                <li><a href="/BookReaderDemo/demo-internetarchive.html?ocaid=adventureofsherl0000unse">
+                  <i>The Adventures of Sherlock Holmes</i> by Arthur Conan Doyle
+                </a></li>
+                <li><a href="/BookReaderDemo/demo-internetarchive.html?ocaid=jalna00dela">
+                  <i>Jalna</i> by Mazo de la Roche
+                </a></li>
+              </ul>
+            </li>
+            <li>
+              Book preview
+              <ul>
+                <li><a href="/BookReaderDemo/demo-internetarchive.html?ocaid=peoplewareproduc00dema_0">
+                  <i>Peopleware</i> by Tom DeMarco and Timothy Lister
+                </a></li>
+                <li><a href="/BookReaderDemo/demo-internetarchive.html?ocaid=passionforbooksb00rabi">
+                  <i>A Passion for Books</i>
+                </a></li>
+              </ul>
+            </li>
+            <li>
+              Book with levelled chapters
+              <ul>
+                <li><a href="/BookReaderDemo/demo-internetarchive.html?ocaid=notredamedepar01hugo">
+                  <i>Notre-Dame de Paris: Tome Premier</i> par Victor Hugo
+                </a></li>
+                <li><a href="/BookReaderDemo/demo-internetarchive.html?ocaid=alanturingenigma0000hodg">
+                  <i>Alan Turing: The Enigma</i> by Andrew Hodges
+                </a></li>
+              </ul>
+            </li>
+          </ul>
+        </li>
       </ul>
     </details>
     <div class="demo">
@@ -220,9 +258,9 @@
 
     // analytics stub
     window.archive_analytics = {
-      send_event_no_sampling: (category, action, label) => console.log('~~~ NO SAMPLE EVENT CALLED: ', { category, action, label }),
-      send_event: (category, action, label) => console.log('~~~ send_event SAMPLE EVENT CALLED: ', { category, action, label }),
-      send_ping: (category, action, label) => console.log('~~~ send_ping SAMPLE EVENT CALLED: ', { category, action, label }),
+      send_event_no_sampling: (category, action, label) => {}, //console.log('~~~ NO SAMPLE EVENT CALLED: ', { category, action, label }),
+      send_event: (category, action, label) => {}, //console.log('~~~ send_event SAMPLE EVENT CALLED: ', { category, action, label }),
+      send_ping: (category, action, label) => {}, //console.log('~~~ send_ping SAMPLE EVENT CALLED: ', { category, action, label }),
     }
   </script>
 

package/BookReaderDemo/toggle_controls.html

@@ -40,7 +40,7 @@
           template: function(br) {
             return '<button class="BRicon ' + this.className + ' desktop-only js-tooltip" data-param="foo">' +
                 '<div class="icon icon-onepg"></div>' +
-                '<span class="tooltip">Overridden control</span>' +
+                '<span class="BRtooltip">Overridden control</span>' +
               '</button>';
           }
         },

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 5.0.0-67
+- Feature: Re-enable chapters plugin + migrate off mmenu @cdrini
+- Fix: Disable tooltips on touchscreens + fix on IA @cdrini
+- Dev: Remove core-js update block; issue resolved in core-js @cdrini
+
 # 5.0.0-66
 - Fix: Pinch zooming on iPad/iPhone, Samsung Internet @cdrini
 

package/index.html

@@ -21,7 +21,7 @@
       <!-- plugin.search.js -->
       <li><a href="BookReaderDemo/demo-internetarchive.html?ocaid=theworksofplato01platiala">From Internet Archive</a></li>
       <!-- plugin.search.js -->
-      <li><a href="BookReaderDemo/demo-internetarchive.html?ocaid=adventuresofoli00dick">From Internet Archive - a book with CHAPTERS</a></li>
+      <li><a href="BookReaderDemo/demo-internetarchive.html?ocaid=adventureofsherl0000unse">From Internet Archive - a book with CHAPTERS</a></li>
       <li><a href="BookReaderDemo/demo-iiif.html">IIIF</a></li>
       <li><a href="BookReaderDemo/demo-autoplay.html">Autoplay (kiosk mode)</a></li>
       <li><a href="BookReaderDemo/demo-plugin-menu-toggle.html">Plugin: Full screen menu toggle</a></li>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/bookreader",
-  "version": "5.0.0-66",
+  "version": "5.0.0-67",
   "description": "The Internet Archive BookReader.",
   "repository": {
     "type": "git",
@@ -26,7 +26,7 @@
   "private": false,
   "dependencies": {
     "@internetarchive/ia-activity-indicator": "^0.0.4",
-    "@internetarchive/ia-item-navigator": "^1.0.3",
+    "@internetarchive/ia-item-navigator": "^1.0.4",
     "@internetarchive/ia-sharing-options": "^1.0.2",
     "@internetarchive/icon-bookmark": "^1.3.4",
     "@internetarchive/icon-dl": "^1.3.4",
@@ -35,6 +35,7 @@
     "@internetarchive/icon-magnify-plus": "^1.3.4",
     "@internetarchive/icon-search": "^1.3.4",
     "@internetarchive/icon-share": "^1.3.4",
+    "@internetarchive/icon-toc": "^1.3.4",
     "@internetarchive/icon-visual-adjustment": "^1.3.4",
     "@internetarchive/modal-manager": "^0.2.12",
     "@internetarchive/shared-resize-observer": "^0.2.0",
@@ -121,7 +122,7 @@
     "DOCS:update:test-deps": "If CI succeeds, these should be good to update",
     "update:test-deps": "npm i @babel/eslint-parser@latest @open-wc/testing-helpers@latest @types/jest@latest codecov@latest eslint@7 eslint-plugin-testcafe@latest jest@latest sinon@latest testcafe@latest",
     "DOCS:update:build-deps": "These can cause strange changes, so do an npm run build + check file size (git diff --stat), and check the site is as expected",
-    "update:build-deps": "npm i @babel/core@latest @babel/preset-env@latest @babel/plugin-proposal-class-properties@latest @babel/plugin-proposal-decorators@latest babel-loader@latest core-js@3.27.1 regenerator-runtime@latest sass@latest svgo@latest webpack@latest webpack-cli@latest",
+    "update:build-deps": "npm i @babel/core@latest @babel/preset-env@latest @babel/plugin-proposal-class-properties@latest @babel/plugin-proposal-decorators@latest babel-loader@latest core-js@latest regenerator-runtime@latest sass@latest svgo@latest webpack@latest webpack-cli@latest",
     "codecov": "npx codecov"
   }
 }

package/src/BookNavigator/book-navigator.js

@@ -239,7 +239,7 @@ export class BookNavigator extends LitElement {
       });
     }
 
-    this.menuProviders = providers;
+    Object.assign(this.menuProviders, providers);
     this.addMenuShortcut('search');
     this.addMenuShortcut('volumes');
     this.updateMenuContents();
@@ -306,9 +306,9 @@ export class BookNavigator extends LitElement {
    */
   updateMenuContents() {
     const {
-      search, downloads, visualAdjustments, share, bookmarks, volumes
+      search, downloads, visualAdjustments, share, bookmarks, volumes, chapters
     } = this.menuProviders;
-    const availableMenus = [volumes, search, bookmarks, visualAdjustments, share].filter((menu) => !!menu);
+    const availableMenus = [volumes, chapters, search, bookmarks, visualAdjustments, share].filter((menu) => !!menu);
 
     if (this.shouldShowDownloadsMenu()) {
       downloads?.update(this.downloadableTypes);
@@ -410,6 +410,7 @@ export class BookNavigator extends LitElement {
   bindEventListeners() {
     window.addEventListener('BookReader:PostInit', (e) => {
       this.bookreader = e.detail.props;
+      this.bookreader.shell = this;
       this.bookReaderLoaded = true;
       this.bookReaderCannotLoad = false;
       this.emitLoadingStatusUpdate(true);

package/src/BookReader/BookModel.js

@@ -30,6 +30,18 @@ export class BookModel {
     this._medianPageSize = null;
     /** @type {[PageData[], number]} */
     this._getDataFlattenedCached = null;
+
+    // Heal missing first page number assertion
+    const pages = this._getDataFlattened();
+    const firstNumberedPageIndex = pages.findIndex(page => page.pageNum != undefined && !isNaN(parseFloat(page.pageNum)));
+    if (firstNumberedPageIndex != -1 && firstNumberedPageIndex > 0) {
+      const pageNum = parseFloat(pages[firstNumberedPageIndex].pageNum);
+      if (!isNaN(pageNum)) {
+        // Note: Since the pages are always sorted in increasing pageNum/index
+        // order, this will work for both left-to-right and right-to-left books
+        pages[firstNumberedPageIndex - 1].pageNum = pageNum - 1;
+      }
+    }
   }
 
   /** Get median width/height of page in inches. Memoized for performance. */

package/src/BookReader/Navbar/Navbar.js

@@ -41,7 +41,7 @@ export class Navbar {
     return `<li>
       <button class="BRicon ${option.className}" title="${option.label}">
         <div class="icon icon-${option.iconClassName}"></div>
-        <span class="tooltip">${option.label}</span>
+        <span class="BRtooltip">${option.label}</span>
       </button>
     </li>`;
   }
@@ -130,7 +130,7 @@ export class Navbar {
       .removeClass()
       .addClass(`icon icon-${iconClass}`)
       .end()
-      .find('.tooltip')
+      .find('.BRtooltip')
       .text(tooltipText);
   }
 

package/src/css/_BRnav.scss

@@ -104,8 +104,11 @@
     border-radius: 2px;
     background: transparent;
     outline: none;
-    &:hover .tooltip {
-      display: block;
+    @media (hover: hover) {
+      /* styles to apply on devices that support hover */
+      &:hover .BRtooltip {
+        display: block;
+      }
     }
     &.hide {
       display: none;

package/src/css/_BRsearch.scss

@@ -98,6 +98,10 @@
       // background-image: url(images/marker_chap-on.svg);
       background-color: blue;
     }
+    .BRchapterPage {
+      font-size: 0.85em;
+      opacity: .8;
+    }
   }
   .BRsearch {
     width: 9px;
@@ -130,8 +134,8 @@
     }
     footer {
       text-align: center;
-      font-weight: bold;
-      font-size: 0.9em;
+      font-size: 0.85em;
+      opacity: .8;
     }
     mark {
       color: $searchResultText;

package/src/css/_MobileNav.scss

@@ -166,29 +166,3 @@ html.mm-background .BookReader {
 @media (min-width: ($brBreakPointMobile + 1)) {
   .BRtoolbar.responsive { display: block; }
 }
-
-li.BRtable-contents-el {
-  line-height: 150%;
-  padding: 10px 10px 10px 20px;
-  overflow: hidden;
-  color: $controlsText;
-
-  &.chapter-clickable {
-    font-weight: normal;
-  }
-
-  &.current-chapter {
-    background-color: lightblue;
-  }
-  //resetting mmenu styling for span inside .table-contents-el
-  > span {
-    display: inline;
-    padding: 0;
-    white-space: normal;
-  }
-
-  .BRTOCElementPage {
-    font-size: 0.85em;
-    opacity: .8;
-  }
-}

package/src/css/_controls.scss

@@ -1,7 +1,7 @@
 .BRcontrols {
   width: 100%;
 
-  .tooltip {
+  .BRtooltip {
     display: none;
     position: absolute;
     width: auto;
@@ -14,9 +14,10 @@
     color: $controlsText;
     border-radius: 3px;
     background: $tooltipBG;
+    pointer-events: none;
   }
 
-  .full .tooltip {
+  .full .BRtooltip {
     left: auto;
     right: 0;
     transform: translateX(0);