@internetarchive/bookreader 5.0.0-8 → 5.0.0-80

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

@@ -0,0 +1,190 @@
+import BookReader from '@/src/BookReader.js';
+import * as utils from '@/src/BookReader/utils.js';
+
+let br;
+beforeAll(() => {
+  document.body.innerHTML = '<div id="BookReader">';
+  br = new BookReader();
+});
+
+afterEach(() => {
+  jest.clearAllMocks();
+});
+
+/**
+ * Only run init() once. Otherwise multiple EventListeners will be added.
+ */
+test('Initialzation enables IntersectionObserver and defaults', () => {
+  const observe = jest.fn();
+  window.IntersectionObserver = jest.fn(() => ({
+    observe
+  }));
+  br.init();
+  expect(br.hasKeyFocus).toBe(true);
+  expect(observe).toHaveBeenCalledTimes(1);
+});
+
+describe('Keyboard shortcuts turned off', () => {
+
+  test('Focus flag disables', () => {
+    br.next = jest.fn();
+    br.hasKeyFocus = false;
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowDown'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.next).toHaveBeenCalledTimes(0);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(0);
+    // Must reset for following tests
+    br.hasKeyFocus = true;
+  });
+
+  test('Input active disables', () => {
+    // eslint-disable-next-line no-import-assign
+    utils.isInputActive = jest.fn(() => true);
+    br.next = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowDown'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.next).toHaveBeenCalledTimes(0);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(0);
+    // Must reset for following tests
+    utils.isInputActive.mockReset();
+  });
+
+});
+
+describe('Keyboard shortcuts', () => {
+
+  test('Home key', () => {
+    br.first = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'Home'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.first).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('End key', () => {
+    br.last = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'End'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.last).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('ArrowDown key', () => {
+    br.mode = br.constMode2up;
+    br.next = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowDown'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.next).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('PageDown key', () => {
+    br.mode = br.constMode2up;
+    br.next = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'PageDown'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.next).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('ArrowUp key', () => {
+    br.mode = br.constMode2up;
+    br.prev = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowUp'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.prev).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('PageUp key', () => {
+    br.mode = br.constMode2up;
+    br.prev = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'PageUp'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.prev).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('ArrowLeft key', () => {
+    br.mode = br.constMode2up;
+    br.left = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowLeft'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.left).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('ArrowRight key', () => {
+    br.mode = br.constMode2up;
+    br.right = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowRight'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.right).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('Subtract key', () => {
+    br.zoom = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'Subtract'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.zoom).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('- key', () => {
+    br.zoom = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': '-'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.zoom).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('Add key', () => {
+    br.zoom = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'Add'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.zoom).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('+ key', () => {
+    br.zoom = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': '+'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.zoom).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('= key', () => {
+    br.zoom = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': '='});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.zoom).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('F key', () => {
+    br.toggleFullscreen = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'F'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.toggleFullscreen).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+});

package/tests/{BookReader.options.test.js → jest/BookReader.options.test.js}

@@ -1,5 +1,5 @@
 
-import BookReader from '../src/BookReader.js';
+import BookReader from '@/src/BookReader.js';
 
 beforeAll(() => {
   document.body.innerHTML = '<div id="BookReader">';
@@ -36,4 +36,12 @@ describe('BookReader options', () => {
       expect(br.options.autoResize).toBe(true);
     });
   });
+
+  describe('`showNavbar`', () => {
+    it('is on by default', () => {
+      const br = new BookReader();
+      br.init();
+      expect(br.options.showNavbar).toBe(true);
+    });
+  });
 });

package/tests/{BookReader.test.js → jest/BookReader.test.js}

@@ -1,7 +1,7 @@
 
-import BookReader from '../src/BookReader.js';
-import '../src/plugins/plugin.resume.js';
-import '../src/plugins/plugin.url.js';
+import BookReader, {_modeStringToNumber} from '@/src/BookReader.js';
+import '@/src/plugins/plugin.resume.js';
+import '@/src/plugins/url/plugin.url.js';
 
 let br;
 beforeAll(() => {
@@ -124,7 +124,7 @@ test('has suppressFragmentChange false when init with fragment', () => {
 test('has suppressFragmentChange false when init with hash fragment', () => {
   br.getResumeValue = jest.fn(() => null);
   br.urlReadFragment = jest.fn(() => '');
-  br.urlReadHashFragment = jest.fn(() => 'mode/1up')
+  br.urlReadHashFragment = jest.fn(() => 'mode/1up');
   br.switchMode = jest.fn();
   br.options.urlMode = 'history',
 
@@ -157,39 +157,20 @@ 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();
+    br.options.ui = '';
+    br.init();
+    expect(br.initNavbar).toHaveBeenCalledTimes(1);
+  });
+  test('Standard navigation is being used by default - when bookreader is embedded', () => {
+    br.initNavbar = jest.fn();
+    br.options.ui = 'embed';
+    br.init();
+    expect(br.initNavbar).toHaveBeenCalledTimes(1);
+    expect(br.options.ui).toEqual('embed');
+  });
 });
 
 describe('quantizeReduce', () => {
@@ -299,3 +280,11 @@ describe('nextReduce', () => {
     });
   });
 });
+
+describe('_modeStringToNumber', () => {
+  test('Returns correct number', () => {
+    expect(_modeStringToNumber('mode/1up')).toBe(1);
+    expect(_modeStringToNumber('mode/2up')).toBe(2);
+    expect(_modeStringToNumber('mode/thumb')).toBe(3);
+  });
+});

package/tests/{plugins → jest/plugins}/plugin.archive_analytics.test.js

@@ -1,6 +1,6 @@
 import sinon from 'sinon';
-import BookReader from '../../src/BookReader.js';
-import '../../src/plugins/plugin.archive_analytics.js';
+import BookReader from '@/src/BookReader.js';
+import '@/src/plugins/plugin.archive_analytics.js';
 
 describe('archiveAnalyticsSendEvent', () => {
   const sendEvent = BookReader.prototype.archiveAnalyticsSendEvent;

package/tests/{plugins → jest/plugins}/plugin.autoplay.test.js

@@ -1,6 +1,6 @@
 
-import BookReader from '../../src/BookReader.js';
-import '../../src/plugins/plugin.autoplay.js';
+import BookReader from '@/src/BookReader.js';
+import '@/src/plugins/plugin.autoplay.js';
 
 
 let br;
@@ -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

@@ -0,0 +1,195 @@
+import sinon from "sinon";
+
+import BookReader from "@/src/BookReader.js";
+import "@/src/plugins/plugin.chapters.js";
+import { BookModel } from "@/src/BookReader/BookModel";
+import { deepCopy } from "../utils";
+/** @typedef {import('@/src/plugins/plugin.chapters').TocEntry} TocEntry  */
+
+/** @type {TocEntry[]} */
+const SAMPLE_TOC = [{
+  "pagenum": "3",
+  "level": 1,
+  "label": "CHAPTER I",
+  "type": { "key": "/type/toc_item" },
+  "title": "THE COUNTRY AND THE MISSION 1",
+  "pageIndex": 3,
+}, {
+  "pagenum": "17",
+  "level": 1,
+  "label": "CHAPTER II",
+  "type": { "key": "/type/toc_item" },
+  "title": "THE COUNTRY AND THE MISSION 2",
+  "pageIndex": 17,
+}, {
+  "pagenum": "undefined",
+  "level": 1,
+  "label": "CHAPTER III",
+  "type": { "key": "/type/toc_item" },
+  "title": "THE COUNTRY AND THE MISSION 3",
+}, {
+  "pagenum": "40",
+  "level": 1,
+  "label": "CHAPTER IV",
+  "type": { "key": "/type/toc_item" },
+  "title": "THE COUNTRY AND THE MISSION 4",
+  "pageIndex": 40,
+}];
+
+/** @type {TocEntry[]} */
+const SAMPLE_TOC_UNDEF = [
+  {
+    "level": 1,
+    "label": "CHAPTER I",
+    "type": { "key": "/type/toc_item" },
+    "title": "THE COUNTRY AND THE MISSION 1",
+  },
+  {
+    "level": 1,
+    "label": "CHAPTER II",
+    "type": { "key": "/type/toc_item" },
+    "title": "THE COUNTRY AND THE MISSION 2",
+  },
+];
+
+/** @type {TocEntry[]} */
+const SAMPLE_TOC_OPTION = [
+  {
+    "level": 1,
+    "title": "THE COUNTRY AND THE MISSION 1",
+  },
+  {
+    "level": 1,
+    "title": "THE COUNTRY AND THE MISSION 2",
+  },
+];
+
+afterEach(() => {
+  sinon.restore();
+});
+
+describe("BRChaptersPlugin", () => {
+  beforeEach(() => {
+    sinon.stub(BookModel.prototype, "getPageIndex").callsFake((str) =>
+      parseFloat(str)
+    );
+  });
+
+  describe("_chaptersInit", () => {
+    test("does not render when no open library record", async () => {
+      const fakeBR = {
+        options: {},
+        getOpenLibraryRecord: async () => null,
+        _chaptersRender: sinon.stub(),
+      };
+      await BookReader.prototype._chapterInit.call(fakeBR);
+      expect(fakeBR._chaptersRender.callCount).toBe(0);
+    });
+
+    test("does not render when open library record with no TOC", async () => {
+      const fakeBR = {
+        options: {},
+        getOpenLibraryRecord: async () => ({ key: "/books/OL1M" }),
+        _chaptersRender: sinon.stub(),
+      };
+      await BookReader.prototype._chapterInit.call(fakeBR);
+      expect(fakeBR._chaptersRender.callCount).toBe(0);
+    });
+
+    test("renders if valid TOC on open library", async () => {
+      const fakeBR = {
+        options: {},
+        bind: sinon.stub(),
+        book: {
+          getPageIndex: (str) => parseFloat(str),
+        },
+        getOpenLibraryRecord: async () => ({
+          "title": "The Adventures of Sherlock Holmes",
+          "table_of_contents": deepCopy(SAMPLE_TOC_OPTION),
+          "ocaid": "adventureofsherl0000unse",
+        }),
+        _chaptersRender: sinon.stub(),
+      };
+      await BookReader.prototype._chapterInit.call(fakeBR);
+      expect(fakeBR._chaptersRender.callCount).toBe(1);
+    });
+
+    test("does not fetch open library record if table of contents in options", async () => {
+      const fakeBR = {
+        options: {
+          table_of_contents: deepCopy(SAMPLE_TOC_UNDEF),
+        },
+        bind: sinon.stub(),
+        getOpenLibraryRecord: sinon.stub(),
+        _chaptersRender: sinon.stub(),
+      };
+      await BookReader.prototype._chapterInit.call(fakeBR);
+      expect(fakeBR.getOpenLibraryRecord.callCount).toBe(0);
+      expect(fakeBR._chaptersRender.callCount).toBe(1);
+    });
+
+    test("converts leafs and pagenums to page index", async () => {
+      const table_of_contents = deepCopy(SAMPLE_TOC_UNDEF);
+      table_of_contents[0].leaf = 0;
+      table_of_contents[1].pagenum = '17';
+      const fakeBR = {
+        options: {
+          table_of_contents,
+        },
+        bind: sinon.stub(),
+        book: {
+          leafNumToIndex: (leaf) => leaf + 1,
+          getPageIndex: (str) => parseFloat(str),
+        },
+        _chaptersRender: sinon.stub(),
+      };
+      await BookReader.prototype._chapterInit.call(fakeBR);
+      expect(fakeBR._chaptersRender.callCount).toBe(1);
+      expect(fakeBR._tocEntries[0].pageIndex).toBe(1);
+      expect(fakeBR._tocEntries[1].pageIndex).toBe(17);
+    });
+  });
+
+  describe('_chaptersRender', () => {
+    test('renders markers and panel', () => {
+      const fakeBR = {
+        _tocEntries: SAMPLE_TOC,
+        _chaptersRenderMarker: sinon.stub(),
+        shell: {
+          menuProviders: {},
+          addMenuShortcut: sinon.stub(),
+          updateMenuContents: sinon.stub(),
+        }
+      };
+      BookReader.prototype._chaptersRender.call(fakeBR);
+      expect(fakeBR.shell.menuProviders['chapters']).toBeTruthy();
+      expect(fakeBR.shell.addMenuShortcut.callCount).toBe(1);
+      expect(fakeBR.shell.updateMenuContents.callCount).toBe(1);
+      expect(fakeBR._chaptersRenderMarker.callCount).toBeGreaterThan(1);
+    });
+  });
+
+  describe('_chaptersUpdateCurrent', () => {
+    test('highlights the current chapter', () => {
+      const fakeBR = {
+        mode: 2,
+        firstIndex: 16,
+        displayedIndices: [16, 17],
+        _tocEntries: SAMPLE_TOC,
+        _chaptersPanel: {
+          currentChapter: null,
+        }
+      };
+      BookReader.prototype._chaptersUpdateCurrent.call(fakeBR);
+      expect(fakeBR._chaptersPanel.currentChapter).toEqual(SAMPLE_TOC[1]);
+
+      fakeBR.mode = 1;
+      BookReader.prototype._chaptersUpdateCurrent.call(fakeBR);
+      expect(fakeBR._chaptersPanel.currentChapter).toEqual(SAMPLE_TOC[0]);
+
+      fakeBR.firstIndex = 0;
+      BookReader.prototype._chaptersUpdateCurrent.call(fakeBR);
+      expect(fakeBR._chaptersPanel.currentChapter).toBeUndefined();
+    });
+  });
+});

package/tests/{plugins → jest/plugins}/plugin.iframe.test.js

@@ -1,7 +1,7 @@
 import sinon from 'sinon';
 
-import BookReader from '../../src/BookReader.js';
-import { _attachEventListeners } from '../../src/plugins/plugin.iframe.js';
+import BookReader from '@/src/BookReader.js';
+import { _attachEventListeners } from '@/src/plugins/plugin.iframe.js';
 
 afterEach(() => {
   sinon.restore();

package/tests/{plugins → jest/plugins}/plugin.resume.test.js

@@ -1,8 +1,8 @@
-import BookReader from '../../src/BookReader.js';
-import '../../src/plugins/plugin.resume.js';
+import BookReader from '@/src/BookReader.js';
+import '@/src/plugins/plugin.resume.js';
 
 import sinon from 'sinon';
-import * as docCookies from '../../src/util/docCookies.js';
+import * as docCookies from '@/src/util/docCookies.js';
 
 let br;
 beforeAll(() => {