@internetarchive/bookreader 5.0.0-82 → 5.0.0-84

package/src/BookReader.js

@@ -275,7 +275,7 @@ BookReader.prototype.getActivePageContainerElementsForIndex = function(pageIndex
   return [
     this._modes.mode2Up.mode2UpLit.pageContainerCache[pageIndex]?.$container?.[0],
     this._modes.mode1Up.mode1UpLit.pageContainerCache[pageIndex]?.$container?.[0],
-    ...(this.mode == this.constModeThumb ? this.$(`.pagediv${pageIndex}`).toArray() : [])
+    ...(this.mode == this.constModeThumb ? this.$(`.pagediv${pageIndex}`).toArray() : []),
   ].filter(x => x);
 };
 
@@ -816,7 +816,7 @@ BookReader.prototype.bindGestures = function(jElement) {
  */
 BookReader.prototype.drawLeafsThrottled = utils.throttle(
   BookReader.prototype.drawLeafs,
-  250 // 250 ms gives quick feedback, but doesn't eat cpu
+  250, // 250 ms gives quick feedback, but doesn't eat cpu
 );
 
 /**
@@ -845,12 +845,12 @@ BookReader.prototype.resizeBRcontainer = function(animate) {
   if (animate) {
     this.refs.$brContainer.animate({
       top: this.getToolBarHeight(),
-      bottom: this.getFooterHeight()
+      bottom: this.getFooterHeight(),
     }, this.constResizeAnimationDuration, 'linear');
   } else {
     this.refs.$brContainer.css({
       top: this.getToolBarHeight(),
-      bottom: this.getFooterHeight()
+      bottom: this.getFooterHeight(),
     });
   }
 };
@@ -1012,8 +1012,8 @@ BookReader.prototype.switchMode = function(
   {
     suppressFragmentChange = false,
     init = false,
-    pageFound = false
-  } = {}
+    pageFound = false,
+  } = {},
 ) {
   // Skip checks before init() complete
   if (this.init.initComplete) {
@@ -1209,7 +1209,7 @@ BookReader.prototype.currentIndex = function() {
  */
 BookReader.prototype.updateFirstIndex = function(
   index,
-  { suppressFragmentChange = false } = {}
+  { suppressFragmentChange = false } = {},
 ) {
   // If there's no change, do nothing
   if (this.firstIndex === index) return;
@@ -1424,7 +1424,7 @@ BookReader.prototype.bindNavigationHandlers = function() {
       if ($brNavCntlBtmEl.hasClass('BRdn')) {
         if (self.refs.$BRtoolbar)
           promises.push(self.refs.$BRtoolbar.animate(
-            {top: self.getToolBarHeight() * -1}
+            {top: self.getToolBarHeight() * -1},
           ).promise());
         promises.push(self.$('.BRfooter').animate({bottom: self.getFooterHeight() * -1}).promise());
         $brNavCntlBtmEl.addClass('BRup').removeClass('BRdn');
@@ -1454,7 +1454,7 @@ BookReader.prototype.bindNavigationHandlers = function() {
           self.resizeBRcontainer();
         }
       });
-    }
+    },
   );
   $brNavCntlBtmEl
     .on("mouseover", function() {
@@ -1506,7 +1506,7 @@ BookReader.prototype.updateFromParams = function(params) {
   if (mode) {
     this.switchMode(
       mode,
-      { init: init, suppressFragmentChange: !fragmentChange }
+      { init: init, suppressFragmentChange: !fragmentChange },
     );
   }
 
@@ -1608,7 +1608,7 @@ BookReader.prototype.showProgressPopup = function(msg, onCloseCallback) {
 
   const bar = document.createElement("div");
   $(bar).css({
-    height:   '20px'
+    height:   '20px',
   }).prop('className', 'BRprogressbar');
   $(this.popup).append(bar);
 
@@ -1869,7 +1869,7 @@ BookReader.prototype.fragmentFromParams = function(params, urlMode = 'hash') {
 BookReader.prototype.queryStringFromParams = function(
   params,
   currQueryString,
-  urlMode = 'hash'
+  urlMode = 'hash',
 ) {
   const newParams = new URLSearchParams(currQueryString);
 

package/src/css/_BRicon.scss

@@ -38,8 +38,14 @@ i.BRicon { display: inline-block; }
 .BRicon.info { @include sprite-offet(1); }
 .BRicon.share { @include sprite-offet(3); }
 // We can only transition these because they are adjacent
-.BRicon.read { @include sprite-offet(5); transition-property: background-color, border, background-position; }
-.BRicon.unread { @include sprite-offet(7); transition-property: background-color, border, background-position; }
+.BRicon.read {
+  transition-property: background-color, border, background-position;
+  @include sprite-offet(5); 
+}
+.BRicon.unread {
+  transition-property: background-color, border, background-position;
+  @include sprite-offet(7); 
+}
 .BRicon.fit { @include sprite-offet(9); }
 .BRicon.download { @include sprite-offet(38); }
 .BRicon.return { @include sprite-offet(26); }

package/src/ia-bookreader/ia-bookreader.js

@@ -62,7 +62,7 @@ export class IaBookReader extends LitElement {
     let modalManager = document.querySelector('modal-manager');
     if (!modalManager) {
       modalManager = document.createElement(
-        'modal-manager'
+        'modal-manager',
       );
       document.body.appendChild(modalManager);
     }

package/src/plugins/plugin.archive_analytics.js

@@ -33,7 +33,7 @@ BookReader.prototype.archiveAnalyticsSendFragmentChange = function() {
     const values = {
       bookreader: "user_changed_view",
       itemid: this.bookId,
-      cache_bust: Math.random()
+      cache_bust: Math.random(),
     };
     // EEK!  offsite embedding and /details/ page books look the same in analytics, otherwise!
     values.offsite = 1;

package/src/plugins/plugin.autoplay.js

@@ -4,7 +4,7 @@
  * Plugin which adds an autoplay feature. Useful for kiosk situations.
  */
 jQuery.extend(BookReader.defaultOptions, {
-  enableAutoPlayPlugin: true
+  enableAutoPlayPlugin: true,
 });
 
 /**
@@ -66,7 +66,7 @@ BookReader.prototype.autoToggle = function(overrides) {
 
   const options = $.extend({
     flipSpeed: this.flipSpeed,
-    flipDelay: this.flipDelay
+    flipDelay: this.flipDelay,
   }, overrides);
 
   this.flipSpeed = typeof options.flipSpeed === "number" ? options.flipSpeed : this.flipSpeed;

package/src/plugins/plugin.chapters.js

@@ -118,8 +118,8 @@ BookReader.prototype._chaptersRenderMarker = function(tocEntry, entryIndex) {
         .text(chapterStr)
         .append(
           $('<div class="BRchapterPage" />')
-            .text(this.book.getPageName(tocEntry.pageIndex))
-        )
+            .text(this.book.getPageName(tocEntry.pageIndex)),
+        ),
     )
     .addClass('BRchapter')
     .css({ left: percentThrough })
@@ -179,7 +179,7 @@ BookReader.prototype.getOpenLibraryRecord = async function (olHost, ocaid) {
  * @param {PageIndex} curIndex
  */
 BookReader.prototype._chaptersUpdateCurrent = function(
-  curIndex = (this.mode == 2 ? Math.max(...this.displayedIndices) : this.firstIndex)
+  curIndex = (this.mode == 2 ? Math.max(...this.displayedIndices) : this.firstIndex),
 ) {
   const tocEntriesIndexed = this._tocEntries.filter((el) => el.pageIndex != undefined).reverse();
   const currChapter = tocEntriesIndexed[

package/src/plugins/plugin.iframe.js

@@ -33,7 +33,7 @@ export function _attachEventListeners(br, parent = window.parent) {
 
     parent.postMessage(
       { type: MESSAGE_TYPE_FRAGMENT_CHANGE, fragment },
-      '*'
+      '*',
     );
   });
 

package/src/plugins/plugin.iiif.js

@@ -35,7 +35,7 @@ class IIIFPlugin {
       bookTitle: resolveInternationalString(manifest.label),
       pageProgression: manifest.viewingDirection == "right-to-left" ? "rl" : "lr",
       // numLeafs: manifest.items.length,
-      metadata: manifest.metadata.map((metadata) => {
+      metadata: (manifest.metadata || []).map((metadata) => {
         return {
           label: resolveInternationalString(metadata.label),
           value: resolveInternationalString(metadata.value),
@@ -51,7 +51,7 @@ class IIIFPlugin {
         const body = bodyArr instanceof Array ? bodyArr[0] : bodyArr;
         const uri = body.service[0].id;
         return `${uri}/full/pct:${percent}/0/default.jpg`;
-      }
+      },
     };
 
     if (manifest.viewingDirection == "top-to-bottom" || manifest.viewingDirection == "bottom-to-top") {
@@ -76,7 +76,9 @@ class IIIFPlugin {
         spread = [];
       }
     });
-
+    if (spread.length > 0) {
+      book.data.push(spread);
+    }
     return book;
   }
 
@@ -98,7 +100,7 @@ class IIIFPlugin {
         const percent = Math.floor(100 * 1 / reduce);
         const uri = manifest.sequences[0].canvases[pageIndex].images[0].resource.service['@id'];
         return `${uri}/full/pct:${percent}/0/default.jpg`;
-      }
+      },
     };
 
     let spread = [];
@@ -116,7 +118,9 @@ class IIIFPlugin {
         spread = [];
       }
     });
-
+    if (spread.length > 0) {
+      book.data.push(spread);
+    }
     return book;
   }
 }

package/src/plugins/plugin.text_selection.js

@@ -89,7 +89,7 @@ export class TextSelectionPlugin {
       url: applyVariables(this.options.fullDjvuXmlUrl, this.optionVariables),
       dataType: this.options.jsonp ? "jsonp" : "html",
       cache: true,
-      error: (e) => undefined
+      error: (e) => undefined,
     }).then((res) => {
       try {
         const xmlMap = $.parseXML(res);
@@ -475,7 +475,7 @@ function determineRealRects(parentEl, selector) {
           origRect.width,
           origRect.height,
         )];
-      })
+      }),
   );
   document.body.removeChild(parentEl);
   Object.assign(parentEl.style, initals);

package/src/plugins/plugin.vendor-fullscreen.js

@@ -8,7 +8,7 @@ if (!isMobile()) {
 
   jQuery.extend(BookReader.defaultOptions, {
     /** @type {boolean} */
-    enableVendorFullscreenPlugin: true
+    enableVendorFullscreenPlugin: true,
   });
 
   /** @override */
@@ -225,13 +225,13 @@ export function fullscreenAllowed() {
  * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/fullscreenchange_event
  */
 export function bindFullscreenChangeListener(
-  data, fullscreenchangeListener
+  data, fullscreenchangeListener,
 ) {
   const event = 'fullscreenchange ';
   const vendor_prefixes = [
     'webkit',
     'moz',
-    'ms'
+    'ms',
   ];
   const all_events = (event + vendor_prefixes.join(event) + event).trim();
   $(document).on(all_events, data, fullscreenchangeListener);

package/src/plugins/search/plugin.search.js

@@ -66,7 +66,17 @@ BookReader.prototype.setup = (function (super_) {
     /** @type { {[pageIndex: number]: SearchInsideMatchBox[]} } */
     this._searchBoxesByIndex = {};
 
-    this.searchView = undefined;
+    if (this.enableSearch) {
+      this.searchView = new SearchView({
+        br: this,
+        searchCancelledCallback: () => {
+          this._cancelSearch();
+          this.trigger('SearchCanceled', { term: this.searchTerm, instance: this });
+        },
+      });
+    } else {
+      this.searchView = null;
+    }
   };
 })(BookReader.prototype.setup);
 
@@ -74,15 +84,10 @@ BookReader.prototype.setup = (function (super_) {
 BookReader.prototype.init = (function (super_) {
   return function () {
     super_.call(this);
-    // give SearchView the most complete bookreader state
-    this.searchView = new SearchView({
-      br: this,
-      searchCancelledCallback: () => {
-        this._cancelSearch();
-        this.trigger('SearchCanceled', { term: this.searchTerm, instance: this });
-      }
-    });
-    if (this.options.enableSearch && this.options.initialSearchTerm) {
+    if (!this.enableSearch) return;
+
+    this.searchView.init();
+    if (this.options.initialSearchTerm) {
       /**
        * this.search() take two parameter
        * 1. this.options.initialSearchTerm - search term
@@ -93,7 +98,7 @@ BookReader.prototype.init = (function (super_) {
        */
       this.search(
         this.options.initialSearchTerm,
-        { goToFirstResult: this.options.goToFirstResult, suppressFragmentChange: false }
+        { goToFirstResult: this.options.goToFirstResult, suppressFragmentChange: false },
       );
     }
   };

package/src/plugins/search/view.js

@@ -11,10 +11,13 @@ class SearchView {
     this.br = br;
     this.matches = [];
     this.cacheDOMElements();
-    this.bindEvents();
     this.cancelSearch = searchCancelledCallback;
   }
 
+  init() {
+    this.bindEvents();
+  }
+
   cacheDOMElements() {
     this.dom = {};
     // Search input within the top toolbar. Will be removed once the mobile menu is replaced.

package/src/plugins/tts/AbstractTTSEngine.js

@@ -134,7 +134,7 @@ export default class AbstractTTSEngine {
     await Promise.all([
       this.activeSound.stop(),
       this._chunkIterator.decrement()
-        .then(() => this._chunkIterator.decrement())
+        .then(() => this._chunkIterator.decrement()),
     ]);
     this.step();
   }

package/src/plugins/tts/FestivalTTSEngine.js

@@ -29,7 +29,7 @@ export default class FestivalTTSEngine extends AbstractTTSEngine {
   /** @override */
   getVoices() {
     return [
-      { default: true, lang: "en-US", localService: false, name: "Festival - English (US)", voiceURI: null }
+      { default: true, lang: "en-US", localService: false, name: "Festival - English (US)", voiceURI: null },
     ];
   }
 
@@ -45,7 +45,7 @@ export default class FestivalTTSEngine extends AbstractTTSEngine {
       url: '/bookreader/BookReader/soundmanager/swf',
       useHTML5Audio: true,
       //flash 8 version of swf is buggy when calling play() on a sound that is still loading
-      flashVersion: 9
+      flashVersion: 9,
     });
   }
 
@@ -125,7 +125,7 @@ class FestivalTTSSound {
       onresume: async () => {
         await sleep(25);
         if (this.rate != 1) this.sound.setPlaybackRate(this.rate);
-      }
+      },
     });
     return this.sound.load();
   }

package/src/plugins/tts/PageChunk.js

@@ -29,8 +29,8 @@ export default class PageChunk {
       cache: true,
       data: {
         path: `${bookPath}_djvu.xml`,
-        page: leafIndex
-      }
+        page: leafIndex,
+      },
     });
     return PageChunk._fromTextWrapperResponse(leafIndex, chunks);
   }

package/src/plugins/tts/WebTTSEngine.js

@@ -45,7 +45,7 @@ export default class WebTTSEngine extends AbstractTTSEngine {
           // album: 'The Ultimate Collection (Remastered)',
           artwork: [
             { src: br.options.thumbnail, type: 'image/jpg' },
-          ]
+          ],
         });
 
         navigator.mediaSession.setActionHandler('play', () => {

package/src/plugins/tts/plugin.tts.js

@@ -306,7 +306,7 @@ BookReader.prototype.ttsHighlightChunk = function(chunk) {
 
   // group by index; currently only possible to have chunks on one page :/
   this._ttsBoxesByIndex = {
-    [pageIndex]: chunk.lineRects.map(([l, b, r, t]) => ({l, r, b, t}))
+    [pageIndex]: chunk.lineRects.map(([l, b, r, t]) => ({l, r, b, t})),
   };
 
   // update any already created pages

package/src/plugins/tts/utils.js

@@ -30,7 +30,7 @@ const COLUMN_TO_LANG_INDEX = {
   'Endonym': 1,
   'ISO 639-1': 2,
   'ISO 639-2/T': 3,
-  'ISO 639-2/B': 4
+  'ISO 639-2/B': 4,
 };
 
 /**

package/src/plugins/url/plugin.url.js

@@ -61,7 +61,7 @@ BookReader.prototype.init = (function(super_) {
       });
 
       this.bind(BookReader.eventNames.fragmentChange,
-        this.urlUpdateFragment.bind(this)
+        this.urlUpdateFragment.bind(this),
       );
     }
     super_.call(this);

package/tests/e2e/helpers/mockSearch.js

@@ -30,7 +30,7 @@ const MOCKED_RESPONSE_NOT_FOUND = {
   "page_count": 1,
   "body_length": 666,
   "leaf0_missing": true,
-  "matches": []
+  "matches": [],
 };
 
 const MOCKED_RESPONSE_FOUND = {
@@ -51,8 +51,8 @@ const MOCKED_RESPONSE_FOUND = {
               "b": 811,
               "t": 753,
               "page": PAGE_FIRST_RESULT_ADJUSTED,
-              "l": 894
-            }
+              "l": 894,
+            },
           ],
           "b": 1935,
           "t": 686,
@@ -60,9 +60,9 @@ const MOCKED_RESPONSE_FOUND = {
           "r": 1704,
           "l": 148,
           "page_height": 2940,
-          "page": PAGE_FIRST_RESULT_ADJUSTED
-        }
-      ]
+          "page": PAGE_FIRST_RESULT_ADJUSTED,
+        },
+      ],
     },
     {
       "text": "That when the Dodger, and his accomplished friend Master Bates, joined in the hue-and-cry which was raised at Oliver's heels, in consequence of their executing an illegal conveyance of Mr. Brownlow's personal property, as has been already described, they were actuated by a very laudable and becoming regard for themselves ; and forasmuch as the freedom of the subject and the liberty of the individual are among the first and proudest boasts of a true-hearted Englishman, so, I need hardly beg the reader to observe, that this action should tend to exalt them in the opinion of all jniblic and patriotic men, in almost as great a degree as this strong proof of their anxiety for their own preservation and safety goes to corroborate and confirm the little code of laws which certain profound and sound-judging philosophers have laid down as the mainsprings of all Nature's deeds and actions : the said philosophers very wisely reducing the good lady's proceedings to matters of maxim and {{{" + TEST_TEXT_FOUND + "}}} : and, by a very neat and pretty compliment   to   her   exalted   wisdom   and   understanding,   putting entirely out of sight any considerations of heart, or generous impulse and feeling. For, these are matters totally beneath a female who is acknowledged by universal admission to be far above the numerous little foibles and weaknesses of her sex.",
@@ -74,8 +74,8 @@ const MOCKED_RESPONSE_FOUND = {
               "b": 2567,
               "t": 2507,
               "page": 162,
-              "l": 441
-            }
+              "l": 441,
+            },
           ],
           "b": 2631,
           "t": 1439,
@@ -83,11 +83,11 @@ const MOCKED_RESPONSE_FOUND = {
           "r": 1620,
           "l": 56,
           "page_height": 2940,
-          "page": 162
-        }
-      ]
-    }
-  ]
+          "page": 162,
+        },
+      ],
+    },
+  ],
 };
 
 export const SEARCH_MATCHES_LENGTH = MOCKED_RESPONSE_FOUND.matches.length;

package/tests/jest/BookNavigator/book-navigator.test.js

@@ -22,7 +22,7 @@ const container = (sharedObserver = null) => {
       identifier: 'foo',
       creator: 'bar',
       title: 'baz',
-    }
+    },
   };
   const modalMgr = new ModalManager();
   return html`
@@ -49,7 +49,7 @@ window.ResizeObserver = class ResizeObserver {
 beforeEach(() => {
   window.archive_analytics = {
     send_event_no_sampling: sinon.fake(),
-    send_event: sinon.fake()
+    send_event: sinon.fake(),
   };
 });
 
@@ -78,7 +78,7 @@ describe('<book-navigator>', () => {
           jumpToIndex: sinon.fake(),
           options: { enableMultipleBooks: false }, // for multipleBooks
           el: '#BookReader',
-          refs: {}
+          refs: {},
         };
 
         const sharedObserver = new SharedResizeObserver();
@@ -93,7 +93,7 @@ describe('<book-navigator>', () => {
         expect(brStub.resize.callCount).toEqual(0);
 
         window.dispatchEvent(new CustomEvent('BookReader:PostInit', {
-          detail: { props: brStub }
+          detail: { props: brStub },
         }));
         await elementUpdated(el);
 
@@ -142,8 +142,8 @@ describe('<book-navigator>', () => {
           jumpToIndex: sinon.fake(),
           options: {},
           refs: {
-            $brContainer
-          }
+            $brContainer,
+          },
         };
         el.bookreader = brStub;
         await el.elementUpdated;
@@ -173,8 +173,8 @@ describe('<book-navigator>', () => {
             jumpToIndex: sinon.fake(),
             options: { enableSearch: true },
             refs: {
-              $brContainer
-            }
+              $brContainer,
+            },
           };
           el.bookreader = brStub;
           await el.elementUpdated;
@@ -199,13 +199,13 @@ describe('<book-navigator>', () => {
               enableMultipleBooks: true,
               multipleBooksList: {
                 by_subprefix: {
-                  fooSubprefix: 'beep'
-                }
-              }
+                  fooSubprefix: 'beep',
+                },
+              },
             },
             refs: {
-              $brContainer
-            }
+              $brContainer,
+            },
           };
           el.bookreader = brStub;
           await el.elementUpdated;
@@ -242,8 +242,8 @@ describe('<book-navigator>', () => {
           jumpToIndex: sinon.fake(),
           options: {},
           refs: {
-            $brContainer
-          }
+            $brContainer,
+          },
         };
         el.bookreader = brStub;
         await el.elementUpdated;
@@ -325,7 +325,7 @@ describe('<book-navigator>', () => {
             'volumes',
             'chapters',
             'search',
-            'bookmarks'
+            'bookmarks',
           ]);
         });
       });
@@ -368,8 +368,8 @@ describe('<book-navigator>', () => {
         resize: sinon.fake(),
         options: {},
         refs: {
-          $brContainer: document.createElement('div')
-        }
+          $brContainer: document.createElement('div'),
+        },
       };
       el.bookreader = brStub;
       await elementUpdated(el);
@@ -379,9 +379,9 @@ describe('<book-navigator>', () => {
       const mockResizeEvent = {
         contentRect: {
           height: 500,
-          width: 900
+          width: 900,
         },
-        target: el.mainBRContainer
+        target: el.mainBRContainer,
       };
       el.handleResize(mockResizeEvent);
 
@@ -398,8 +398,8 @@ describe('<book-navigator>', () => {
         resize: sinon.fake(),
         options: {},
         refs: {
-          $brContainer: document.createElement('div')
-        }
+          $brContainer: document.createElement('div'),
+        },
       };
 
       el.bookreader = brStub;
@@ -410,9 +410,9 @@ describe('<book-navigator>', () => {
       const mockResizeEvent = {
         contentRect: {
           height: 500,
-          width: 900
+          width: 900,
         },
-        target: el.mainBRContainer
+        target: el.mainBRContainer,
       };
       el.handleResize(mockResizeEvent);
 
@@ -540,7 +540,7 @@ describe('<book-navigator>', () => {
       await elementUpdated(el);
 
       window.dispatchEvent(new CustomEvent('BookReader:fullscreenToggled', {
-        detail: { props: brStub }
+        detail: { props: brStub },
       }));
       await elementUpdated(el);
 
@@ -581,7 +581,7 @@ describe('<book-navigator>', () => {
 
         // analytics fires
         expect(window.archive_analytics.send_event_no_sampling.called).toEqual(
-          false
+          false,
         );
         expect(window.archive_analytics.send_event.called).toEqual(true);
         // we prevent default
@@ -633,7 +633,7 @@ describe('<book-navigator>', () => {
       await el.elementUpdated;
 
       expect(window.archive_analytics.send_event_no_sampling.called).toEqual(
-        false
+        false,
       );
       expect(window.archive_analytics.send_event.called).toEqual(false);