@internetarchive/bookreader 5.0.0-48 → 5.0.0-49

package/src/plugins/plugin.autoplay.js

@@ -81,7 +81,7 @@ BookReader.prototype.autoToggle = function(overrides) {
   }
 
   // Change to autofit if book is too large
-  if (this.reduce < this.twoPageGetAutofitReduce()) {
+  if (this.reduce < this._modes.mode2Up.getAutofitReduce()) {
     this.zoom('auto');
   }
 
@@ -94,7 +94,7 @@ BookReader.prototype.autoToggle = function(overrides) {
       // don't flip immediately -- wait until timer fires
     } else {
       // flip immediately
-      this.flipFwdToIndex();
+      this.next({ triggerStop: false });
     }
 
     this.$('.play').hide();
@@ -103,9 +103,9 @@ BookReader.prototype.autoToggle = function(overrides) {
       if (this.animating) return;
 
       if (Math.max(this.twoPage.currentIndexL, this.twoPage.currentIndexR) >= this.lastDisplayableIndex()) {
-        this.flipBackToIndex(1); // $$$ really what we want?
+        this.prev({ triggerStop: false }); // $$$ really what we want?
       } else {
-        this.flipFwdToIndex();
+        this.next({ triggerStop: false });
       }
     }, this.flipDelay);
   } else {

package/src/plugins/plugin.chapters.js

@@ -53,7 +53,7 @@ BookReader.prototype.init = (function(super_) {
  */
 BookReader.prototype.addChapter = function(chapterTitle, pageNumber, pageIndex) {
   const uiStringPage = 'Page'; // i18n
-  const percentThrough = BookReader.util.cssPercentage(pageIndex, this.getNumLeafs() - 1);
+  const percentThrough = BookReader.util.cssPercentage(pageIndex, this.book.getNumLeafs() - 1);
   const jumpToChapter = (event) => {
     this.jumpToIndex($(event.delegateTarget).data('pageIndex'));
     $('.current-chapter').removeClass('current-chapter');
@@ -151,7 +151,7 @@ BookReader.prototype.updateTOC = function(tocEntries) {
  * @param {TocEntry} tocEntryObject
  */
 BookReader.prototype.addChapterFromEntry = function(tocEntryObject) {
-  tocEntryObject.pageIndex = this.getPageIndex(tocEntryObject['pagenum']);
+  tocEntryObject.pageIndex = this.book.getPageIndex(tocEntryObject['pagenum']);
   //creates a string with non-void tocEntryObject.label and tocEntryObject.title
   const chapterStr = [tocEntryObject.label, tocEntryObject.title]
     .filter(x => x)

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

@@ -297,7 +297,7 @@ export function marshallSearchResults(results, displayPageNumberFn) {
  * @param {boolean} options.goToFirstResult
  */
 BookReader.prototype.BRSearchCallback = function(results, options) {
-  marshallSearchResults(results, pageNum => this.getPageNum(this.leafNumToIndex(pageNum)));
+  marshallSearchResults(results, pageNum => this.book.getPageNum(this.book.leafNumToIndex(pageNum)));
   this.searchResults = results || [];
 
   this.updateSearchHilites();
@@ -357,7 +357,7 @@ BookReader.prototype.updateSearchHilites = function() {
   // Group by pageIndex
   for (const match of matches) {
     for (const box of match.par[0].boxes) {
-      const pageIndex = this.leafNumToIndex(box.page);
+      const pageIndex = this.book.leafNumToIndex(box.page);
       const pageBoxes = boxesByIndex[pageIndex] || (boxesByIndex[pageIndex] = []);
       pageBoxes.push(box);
     }
@@ -366,7 +366,7 @@ BookReader.prototype.updateSearchHilites = function() {
   // update any already created pages
   for (const [pageIndexString, boxes] of Object.entries(boxesByIndex)) {
     const pageIndex = parseFloat(pageIndexString);
-    const page = this._models.book.getPage(pageIndex);
+    const page = this.book.getPage(pageIndex);
     const pageContainers = this.getActivePageContainerElementsForIndex(pageIndex);
     for (const container of pageContainers) {
       renderBoxesInPageContainerLayer('searchHiliteLayer', boxes, page, container, boxes.map(b => `match-index-${b.matchIndex}`));
@@ -392,8 +392,8 @@ BookReader.prototype.removeSearchHilites = function() {
  */
 BookReader.prototype._searchPluginGoToResult = async function (matchIndex) {
   const match = this.searchResults?.matches[matchIndex];
-  const pageIndex = this.leafNumToIndex(match.par[0].page);
-  const { book } = this._models;
+  const book = this.book;
+  const pageIndex = book.leafNumToIndex(match.par[0].page);
   const page = book.getPage(pageIndex);
   const onNearbyPage = Math.abs(this.currentIndex() - pageIndex) < 3;
   let makeUnviewableAtEnd = false;
@@ -478,7 +478,7 @@ BookReader.prototype.searchHighlightVisible = function() {
 
   results.matches.some(match => {
     return match.par[0].boxes.some(box => {
-      const pageIndex = this.leafNumToIndex(box.page);
+      const pageIndex = this.book.leafNumToIndex(box.page);
       if (jQuery.inArray(pageIndex, visiblePages) >= 0) {
         return true;
       }

package/src/plugins/search/view.js

@@ -231,10 +231,10 @@ class SearchView {
   renderPins(matches) {
     matches.forEach((match) => {
       const queryString = match.text;
-      const pageIndex = this.br.leafNumToIndex(match.par[0].page);
+      const pageIndex = this.br.book.leafNumToIndex(match.par[0].page);
       const uiStringSearch = "Search result"; // i18n
 
-      const percentThrough = this.br.constructor.util.cssPercentage(pageIndex, this.br.getNumLeafs() - 1);
+      const percentThrough = this.br.constructor.util.cssPercentage(pageIndex, this.br.book.getNumLeafs() - 1);
 
       const escapedQueryString = escapeHTML(queryString);
       const queryStringWithB = escapedQueryString.replace(this.matcher, '<b>$1</b>');

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

@@ -224,7 +224,7 @@ BookReader.prototype.ttsStart = function (startTTSEngine = true) {
   this.$('.BRicon.read').addClass('unread active');
   this.ttsSendAnalyticsEvent('Start');
   if (startTTSEngine)
-    this.ttsEngine.start(this.currentIndex(), this.getNumLeafs());
+    this.ttsEngine.start(this.currentIndex(), this.book.getNumLeafs());
 };
 
 BookReader.prototype.ttsJumpForward = function () {
@@ -326,7 +326,7 @@ BookReader.prototype.ttsHighlightChunk = function(chunk) {
   // update any already created pages
   for (const [pageIndexString, boxes] of Object.entries(this._ttsBoxesByIndex)) {
     const pageIndex = parseFloat(pageIndexString);
-    const page = this._models.book.getPage(pageIndex);
+    const page = this.book.getPage(pageIndex);
     const pageContainers = this.getActivePageContainerElementsForIndex(pageIndex);
     pageContainers.forEach(container => renderBoxesInPageContainerLayer('ttsHiliteLayer', boxes, page, container));
   }

package/tests/e2e/models/Navigation.js

@@ -17,7 +17,7 @@ export default class Navigation {
  * @class
  * @classdesc defines DesktopNav base elements
  */
-class DesktopNav {
+export class DesktopNav {
   /**
    * @param {Selector} bottomToolbar
    * @param {Selector} itemNav

package/tests/jest/BookReader/BookModel.test.js

@@ -1,6 +1,7 @@
 import sinon from 'sinon';
 import { deepCopy } from '../utils.js';
 import { BookModel } from '@/src/BookReader/BookModel.js';
+import { NAMED_REDUCE_SETS } from '@/src/BookReader/ReduceSet.js';
 /** @typedef {import('@/src/BookReader/options.js').BookReaderOptions} BookReaderOptions */
 
 afterEach(() => {
@@ -21,10 +22,10 @@ const SAMPLE_DATA = [
   ],
 ];
 
-describe('getMedianPageSize', () => {
+describe('getMedianPageSizeInches', () => {
   test('handles single page data', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA.slice(0, 1) });
-    expect(bm.getMedianPageSize()).toEqual({ width: 123, height: 123 });
+    const bm = new BookModel({ data: SAMPLE_DATA.slice(0, 1), options: {ppi: 1} });
+    expect(bm.getMedianPageSizeInches()).toEqual({ width: 123, height: 123 });
   });
 
   test('handles odd pages data', () => {
@@ -38,8 +39,8 @@ describe('getMedianPageSize', () => {
     Object.assign(data[0][0], sizes[0]);
     Object.assign(data[1][0], sizes[1]);
     Object.assign(data[1][1], sizes[2]);
-    const bm = new BookModel({ data });
-    expect(bm.getMedianPageSize()).toEqual({ width: 200, height: 2200 });
+    const bm = new BookModel({ data, options: {ppi: 1} });
+    expect(bm.getMedianPageSizeInches()).toEqual({ width: 200, height: 2200 });
   });
 
 
@@ -55,16 +56,16 @@ describe('getMedianPageSize', () => {
     Object.assign(data[1][0], sizes[1]);
     Object.assign(data[1][1], sizes[2]);
     Object.assign(data[2][0], sizes[3]);
-    const bm = new BookModel({ data });
-    expect(bm.getMedianPageSize()).toEqual({ width: 300, height: 2300 });
+    const bm = new BookModel({ data, options: {ppi: 1} });
+    expect(bm.getMedianPageSizeInches()).toEqual({ width: 300, height: 2300 });
   });
 
   test('caches result', () => {
     const bm = new BookModel({ data: SAMPLE_DATA });
-    const firstResult = bm.getMedianPageSize();
-    expect(bm.getMedianPageSize()).toBe(firstResult);
-    expect(bm.getMedianPageSize()).toBe(firstResult);
-    expect(bm.getMedianPageSize()).toBe(firstResult);
+    const firstResult = bm.getMedianPageSizeInches();
+    expect(bm.getMedianPageSizeInches()).toBe(firstResult);
+    expect(bm.getMedianPageSizeInches()).toBe(firstResult);
+    expect(bm.getMedianPageSizeInches()).toBe(firstResult);
   });
 });
 
@@ -309,4 +310,23 @@ describe('PageModel', () => {
       expect(bm.getPage(0).findPrev({ combineConsecutiveUnviewables: true })).toBeUndefined();
     });
   });
+
+  describe('getURISrcSet', () => {
+    const data = deepCopy(SAMPLE_DATA);
+    const bm = new BookModel({ data, reduceSet: NAMED_REDUCE_SETS.pow2 });
+    bm.getPageURI = (index, scale, rotate) => `correctURL.png?scale=${scale}`;
+    const page = bm.getPage(0);
+
+    test('with 0 elements in srcset', () => {
+      expect(page.getURISrcSet(1)).toBe("");
+    });
+
+    test('with 2 elements in srcset', () => {
+      expect(page.getURISrcSet(5)).toBe("correctURL.png?scale=2 2x, correctURL.png?scale=1 4x");
+    });
+
+    test('with the most elements in srcset', () => {
+      expect(page.getURISrcSet(35)).toBe("correctURL.png?scale=16 2x, correctURL.png?scale=8 4x, correctURL.png?scale=4 8x, correctURL.png?scale=2 16x, correctURL.png?scale=1 32x");
+    });
+  });
 });

package/tests/jest/BookReader/BookReaderPublicFunctions.test.js

@@ -140,14 +140,14 @@ describe('`BookReader.prototype.prev`', () => {
   const br = new BookReader();
   global.br = br;
   br.trigger = sinon.fake();
-  br.flipBackToIndex = sinon.fake();
+  br._modes.mode2Up.flipBackToIndex = sinon.fake();
   br.jumpToIndex = sinon.fake();
 
   test('does not take action if user is on front page', () => {
     br.firstIndex = 0;
     br.prev();
     expect(br.trigger.callCount).toBe(0);
-    expect(br.flipBackToIndex.callCount).toBe(0);
+    expect(br._modes.mode2Up.flipBackToIndex.callCount).toBe(0);
     expect(br.jumpToIndex.callCount).toBe(0);
   });
 
@@ -158,7 +158,7 @@ describe('`BookReader.prototype.prev`', () => {
       br.prev();
       expect(br.jumpToIndex.callCount).toBe(0); // <--  does not get called
       expect(br.trigger.callCount).toBe(1);
-      expect(br.flipBackToIndex.callCount).toBe(1);
+      expect(br._modes.mode2Up.flipBackToIndex.callCount).toBe(1);
     });
   });
 
@@ -169,7 +169,7 @@ describe('`BookReader.prototype.prev`', () => {
       br.prev();
       expect(br.jumpToIndex.callCount).toBe(1);  // <--  gets called
       expect(br.trigger.callCount).toBe(1); // <-- gets called by `jumpToIndex` internally
-      expect(br.flipBackToIndex.callCount).toBe(1); // <-- gets called by `jumpToIndex` internally
+      expect(br._modes.mode2Up.flipBackToIndex.callCount).toBe(1); // <-- gets called by `jumpToIndex` internally
     });
   });
 });

package/tests/jest/BookReader/Mode1UpLit.test.js

@@ -22,7 +22,11 @@ const SAMPLE_DATA = [
 function make_dummy_br(overrides = {}) {
   return Object.assign({
     updateFirstIndex() {},
-    updateNavIndexThrottled() {},
+    _components: {
+      navbar: {
+        updateNavIndexThrottled() {},
+      }
+    },
     data: []
   }, overrides);
 }

package/tests/jest/BookReader/Mode2Up.test.js

@@ -145,13 +145,13 @@ describe('2up Container sizing', () => {
   test('baseLeafCss', () => {
     const br = new BookReader({ data: SAMPLE_DATA });
     br.init();
-    br.calculateSpreadSize();
+    br._modes.mode2Up.calculateSpreadSize();
     expect(Object.keys(br._modes.mode2Up.baseLeafCss)).toEqual(['position', 'right', 'top', 'zIndex']);
   });
   test('heightCss', () => {
     const br = new BookReader({ data: SAMPLE_DATA });
     br.init();
-    br.calculateSpreadSize();
+    br._modes.mode2Up.calculateSpreadSize();
     const heightStub = 1000;
     br.twoPage.height = heightStub;
     expect(Object.keys(br._modes.mode2Up.heightCss)).toEqual(['height']);
@@ -160,7 +160,7 @@ describe('2up Container sizing', () => {
   describe('left side', () => {
     const br = new BookReader({ data: SAMPLE_DATA });
     br.init();
-    br.calculateSpreadSize();
+    br._modes.mode2Up.calculateSpreadSize();
 
     test('leftLeafCss', () => {
       expect(Object.keys(br._modes.mode2Up.leftLeafCss)).toEqual([
@@ -186,7 +186,7 @@ describe('2up Container sizing', () => {
   describe('right side', () => {
     const br = new BookReader({ data: SAMPLE_DATA });
     br.init();
-    br.calculateSpreadSize();
+    br._modes.mode2Up.calculateSpreadSize();
 
     test('rightLeafCss', () => {
       expect(Object.keys(br._modes.mode2Up.rightLeafCss)).toEqual([
@@ -213,20 +213,20 @@ describe('2up Container sizing', () => {
     test('mainContainerCss', () => {
       const br = new BookReader({ data: SAMPLE_DATA });
       br.init();
-      br.calculateSpreadSize();
+      br._modes.mode2Up.calculateSpreadSize();
 
       expect(Object.keys(br._modes.mode2Up.mainContainerCss)).toEqual(['height', 'width', 'position']);
     });
     test('spreadCoverCss', () => {
       const br = new BookReader({ data: SAMPLE_DATA });
       br.init();
-      br.calculateSpreadSize();
+      br._modes.mode2Up.calculateSpreadSize();
       expect(Object.keys(br._modes.mode2Up.spreadCoverCss)).toEqual(['width', 'height', 'visibility']);
     });
     test('spineCss', () => {
       const br = new BookReader({ data: SAMPLE_DATA });
       br.init();
-      br.calculateSpreadSize();
+      br._modes.mode2Up.calculateSpreadSize();
       expect(Object.keys(br._modes.mode2Up.spineCss)).toEqual(['width', 'height', 'left', 'top']);
     });
   });
@@ -247,7 +247,7 @@ describe('prepareTwoPageView', () => {
       const preparePopUp = sinon.spy(mode2Up, 'preparePopUp');
       const updateBrClasses = sinon.spy(br, 'updateBrClasses');
 
-      br.prepareTwoPageView(undefined, undefined, true);
+      mode2Up.prepare(undefined, undefined, true);
       expect(prefetch.callCount).toBe(1);
 
       expect(resizeSpread.callCount).toBe(0);

package/tests/jest/BookReader.test.js

@@ -157,41 +157,6 @@ test('does not add q= term to urlMode=hash query string', () => {
   )).toBe('?name=value');
 });
 
-test('_getPageURISrcset with 0 page book', () => {
-  br._models.book.getNumLeafs = jest.fn(() => 0);
-  br._models.book.getPageURI = jest.fn((index, scale, rotate) => "correctURL.png&scale=" + scale);
-  br.init();
-  expect(br._getPageURISrcset(5, undefined, undefined)).toBe("");
-});
-
-test('_getPageURISrcset with negative index', () => {
-  br._models.book.getNumLeafs = jest.fn(() => 0);
-  br._models.book.getPageURI = jest.fn((index, scale, rotate) => "correctURL.png&scale=" + scale);
-  br.init();
-  expect(br._getPageURISrcset(-7, undefined, undefined)).toBe("");
-});
-
-test('_getPageURISrcset with 0 elements in srcset', () => {
-  br._models.book.getNumLeafs = jest.fn(() => 30);
-  br._models.book.getPageURI = jest.fn((index, scale, rotate) => "correctURL.png&scale=" + scale);
-  br.init();
-  expect(br._getPageURISrcset(5, 1, undefined)).toBe("");
-});
-
-test('_getPageURISrcset with 2 elements in srcset', () => {
-  br._models.book.getNumLeafs = jest.fn(() => 30);
-  br._models.book.getPageURI = jest.fn((index, scale, rotate) => "correctURL.png&scale=" + scale);
-  br.init();
-  expect(br._getPageURISrcset(5, 5, undefined)).toBe("correctURL.png&scale=2 2x, correctURL.png&scale=1 4x");
-});
-
-test('_getPageURISrcset with the most elements in srcset', () => {
-  br._models.book.getNumLeafs = jest.fn(() => 30);
-  br._models.book.getPageURI = jest.fn((index, scale, rotate) => "correctURL.png&scale=" + scale);
-  br.init();
-  expect(br._getPageURISrcset(5, 35, undefined)).toBe("correctURL.png&scale=16 2x, correctURL.png&scale=8 4x, correctURL.png&scale=4 8x, correctURL.png&scale=2 16x, correctURL.png&scale=1 32x");
-});
-
 describe('Navigation Bars', () => {
   test('Standard navigation is being used by default', () => {
     br.initNavbar = jest.fn();

package/tests/jest/plugins/plugin.autoplay.test.js

@@ -38,12 +38,12 @@ describe('Plugin: Menu Toggle', () => {
   });
   test('autoplay will run without `flipSpeed` parameters', () => {
     const initialAutoTimer = br.autoTimer;
-    br.flipFwdToIndex = jest.fn();
+    br.next = jest.fn();
     br.autoStop = jest.fn();
     br.init();
     br.autoToggle();
     // internally referenced functions that fire
-    expect(br.flipFwdToIndex).toHaveBeenCalledTimes(1);
+    expect(br.next).toHaveBeenCalledTimes(1);
 
     expect(initialAutoTimer).toBeFalsy();
     // br.autoTimer changes when autoToggle turns on

package/tests/jest/plugins/plugin.chapters.test.js

@@ -55,6 +55,7 @@ const SAMPLE_TOC_UNDEF = [
   }
 ];
 
+/** @type {BookReader} */
 let br;
 beforeEach(() => {
   $.ajax = jest.fn().mockImplementation((args) => {
@@ -97,9 +98,7 @@ describe('updateTOCState', () => {
 
   beforeEach(() => {
     window.HTMLElement.prototype.scrollIntoView = sinon.stub();
-    //Sinon is not used because this function is imported from BookModel with exposeOverrideableMethod()
-    //which has a getter and setter
-    br.getPageIndex = (str) => parseFloat(str);
+    br.book.getPageIndex = (str) => parseFloat(str);
     br.init();
   });
 

package/tests/e2e/ia-production/ia-prod-base.js

@@ -1,17 +0,0 @@
-import { runBaseTests } from '../helpers/base';
-import BookReader from '../models/BookReader';
-
-const localURL = 'https://archive.org/details/';
-const books = [
-  'birdbookillustra00reedrich', // publicDomain
-  // 'pianoservicingtu00rebl_0', // borrowable,
-  // 'adventuresoftoms00twaiiala', // has chapter markers
-  // 'gendaitankashu00meijuoft', // Right to Left book
-  // 'gov.uspto.patents.application.10074026', // multiple files
-];
-
-books.forEach(function(page) {
-  const url = `${localURL}${page}`;
-  fixture `Archive.org BR Base Tests for: ${page}`.page `${url}`;
-  runBaseTests(new BookReader());
-});