@internetarchive/bookreader 5.0.0-5 → 5.0.0-50-a1

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 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', () => {

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/{plugins → jest/plugins}/plugin.chapters.test.js

@@ -1,8 +1,8 @@
 import sinon from 'sinon';
 
-import BookReader from '../../src/BookReader.js';
-import '../../src/plugins/plugin.mobile_nav.js';
-import '../../src/plugins/plugin.chapters.js';
+import BookReader from '@/src/BookReader.js';
+import '@/src/plugins/plugin.mobile_nav.js';
+import '@/src/plugins/plugin.chapters.js';
 
 const SAMPLE_TOC = [{
   "pagenum": "3",
@@ -53,8 +53,9 @@ const SAMPLE_TOC_UNDEF = [
     "title": "THE COUNTRY AND THE MISSION 2",
     "pageIndex": undefined,
   }
-]
+];
 
+/** @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();
   });
 
@@ -111,20 +110,20 @@ describe('updateTOCState', () => {
   test('Only one element has .current-chapter', () => {
     br.updateTOCState(9, SAMPLE_TOC);
     expect($('li.BRtable-contents-el.current-chapter').length).toBe(1);
-  })
+  });
 
   test('No chapter has .current-chapter if current index is < than any chapter index', () => {
     br.updateTOCState(1, SAMPLE_TOC);
     expect($('li.BRtable-contents-el.current-chapter').length).toBe(0);
-  })
+  });
 
   test('if current index == chapter index ', () => {
     br.updateTOCState(17, SAMPLE_TOC);
     expect($('li.BRtable-contents-el')[1].classList.contains('current-chapter'));
-  })
+  });
 
   test('No chapter has .current-chapter if all chapter have undefined pageIndex ', () => {
     br.updateTOCState(10, SAMPLE_TOC_UNDEF);
     expect($('li.BRtable-contents-el.current-chapter').length).toBe(0);
-  })
+  });
 });

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.mobile_nav.test.js

@@ -1,6 +1,6 @@
 
-import BookReader from '../../src/BookReader.js';
-import '../../src/plugins/plugin.mobile_nav.js';
+import BookReader from '@/src/BookReader.js';
+import '@/src/plugins/plugin.mobile_nav.js';
 
 /** @type {BookReader} */
 let br;
@@ -37,7 +37,7 @@ describe('Plugin: Mobile Nav', () => {
       return function() {
         callCount++;
         _super.apply(this, arguments);
-      }
+      };
     }(BookReader.prototype.initToolbar);
     const br = new BookReader();
     br.init();
@@ -47,7 +47,7 @@ describe('Plugin: Mobile Nav', () => {
     expect($(document.body).hasClass('BRbodyMobileNavEnabled')).toEqual(true);
   });
   test('loads the navbar on init', () => {
-    expect($('#BRmobileMenu')).toHaveLength(1)
+    expect($('#BRmobileMenu')).toHaveLength(1);
   });
   test('There is a Settings Section', () => {
     expect($('.BRmobileMenu__settings')).toHaveLength(1);
@@ -60,7 +60,7 @@ describe('Plugin: Mobile Nav', () => {
   });
   test('clicking on hamburger opens menu', () => {
     expect($('html').hasClass('mm-opened')).toEqual(false);
-    $('.BRmobileHamburger').click();
+    $('.BRmobileHamburger').trigger("click");
     expect($('html').hasClass('mm-opened')).toEqual(true);
   });
 });

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(() => {

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

@@ -1,7 +1,7 @@
 import sinon from 'sinon';
 
-import '../../src/BookReader.js';
-import { BookreaderWithTextSelection, TextSelectionPlugin, Cache } from '../../src/plugins/plugin.text_selection.js';
+import '@/src/BookReader.js';
+import { BookreaderWithTextSelection, TextSelectionPlugin, Cache } from '@/src/plugins/plugin.text_selection.js';
 
 
 /** @type {BookReader} */
@@ -19,30 +19,32 @@ const FAKE_XML_5COORDS = `<OBJECT data="file://localhost//tmp/derive/goodytwosho
 const FAKE_XML_EMPTY = '';
 
 describe("Generic tests", () => {
-  let br;
-  beforeEach(() => {
-    document.body.innerHTML = '<div id="BookReader">';
-    br = new BookreaderWithTextSelection({
-      data: [
-        [
-          { width: 800, height: 1200,
-            uri: '//archive.org/download/BookReader/img/page001.jpg' },
-        ],
-        [
-          { width: 800, height: 1200,
-            uri: '//archive.org/download/BookReader/img/page002.jpg' },
-          { width: 800, height: 1200,
-            uri: '//archive.org/download/BookReader/img/page003.jpg' },
-        ],
-        [
-          { width: 800, height: 1200,
-            uri: '//archive.org/download/BookReader/img/page004.jpg' },
-          { width: 800, height: 1200,
-            uri: '//archive.org/download/BookReader/img/page005.jpg' },
-        ]
+  document.body.innerHTML = '<div id="BookReader">';
+  const br = new BookreaderWithTextSelection({
+    data: [
+      [
+        { width: 800, height: 1200,
+          uri: '//archive.org/download/BookReader/img/page001.jpg' },
       ],
-    });
-    br.init();
+      [
+        { width: 800, height: 1200,
+          uri: '//archive.org/download/BookReader/img/page002.jpg' },
+        { width: 800, height: 1200,
+          uri: '//archive.org/download/BookReader/img/page003.jpg' },
+      ],
+      [
+        { width: 800, height: 1200,
+          uri: '//archive.org/download/BookReader/img/page004.jpg' },
+        { width: 800, height: 1200,
+          uri: '//archive.org/download/BookReader/img/page005.jpg' },
+      ]
+    ],
+  });
+  br.init();
+
+  afterEach(() => {
+    sinon.restore();
+    $('.textSelectionSVG').remove();
   });
 
   test("_createPageContainer overridden function still creates a BRpagecontainer element", () => {
@@ -72,8 +74,8 @@ describe("Generic tests", () => {
     const $container = br.refs.$brContainer;
     sinon.stub(br.textSelectionPlugin, "getPageText")
       .returns($(new DOMParser().parseFromString(FAKE_XML_1WORD, "text/xml")));
-    const pageIndex = br.data.length - 1
-    await br.textSelectionPlugin.createTextLayer(pageIndex, $container);
+    const pageIndex = br.data.length - 1;
+    await br.textSelectionPlugin.createTextLayer({ $container, page: { index: pageIndex, width: 100, height: 100 }});
     expect($container.find(".textSelectionSVG").length).toBe(1);
     expect($container.find(".BRparagElement").length).toBe(1);
   });
@@ -83,17 +85,7 @@ describe("Generic tests", () => {
     const xml = FAKE_XML_1WORD.replace(/<WORD.*<\/WORD>/, FAKE_XML_1WORD.match(/<WORD.*<\/WORD>/)[0].repeat(3000));
     sinon.stub(br.textSelectionPlugin, "getPageText")
       .returns($(new DOMParser().parseFromString(xml, "text/xml")));
-    await br.textSelectionPlugin.createTextLayer(0, $container);
-    expect($container.find(".textSelectionSVG").length).toBe(0);
-    expect($container.find(".BRparagElement").length).toBe(0);
-    expect($container.find(".BRwordElement").length).toBe(0);
-  });
-
-  // GRRRR!!! This is a useful test :( But can't get it working for some reason,
-  // and the error output is super cryptic.
-  test.skip("createTextLayer will not create text layer if index is more than total number of book pages", async () => {
-    const $container = br.refs.$brContainer;
-    await br.textSelectionPlugin.createTextLayer(150, $container);
+    await br.textSelectionPlugin.createTextLayer({ $container, page: { index: 0, width: 100, height: 100 }});
     expect($container.find(".textSelectionSVG").length).toBe(0);
     expect($container.find(".BRparagElement").length).toBe(0);
     expect($container.find(".BRwordElement").length).toBe(0);
@@ -103,7 +95,7 @@ describe("Generic tests", () => {
     const $container = br.refs.$brContainer;
     sinon.stub(br.textSelectionPlugin, "getPageText")
       .returns($(new DOMParser().parseFromString(FAKE_XML_1WORD, "text/xml")));
-    await br.textSelectionPlugin.createTextLayer(1, $container);
+    await br.textSelectionPlugin.createTextLayer({ $container, page: { index: 1, width: 100, height: 100 }});
     expect($container.find(".textSelectionSVG").length).toBe(1);
     expect($container.find(".BRparagElement").length).toBe(1);
     expect($container.find(".BRwordElement").length).toBe(1);
@@ -114,7 +106,7 @@ describe("Generic tests", () => {
     const $container = br.refs.$brContainer;
     sinon.stub(br.textSelectionPlugin, "getPageText")
       .returns($(new DOMParser().parseFromString(FAKE_XML_MULT_WORDS, "text/xml")));
-    await br.textSelectionPlugin.createTextLayer(2, $container);
+    await br.textSelectionPlugin.createTextLayer({ $container, page: { index: 2, width: 100, height: 100 }});
     expect($container.find(".textSelectionSVG").length).toBe(1);
     expect($container.find(".BRparagElement").length).toBe(1);
     expect($container.find(".BRwordElement").length).toBe(5);
@@ -125,7 +117,7 @@ describe("Generic tests", () => {
     const $container = br.refs.$brContainer;
     sinon.stub(br.textSelectionPlugin, "getPageText")
       .returns($(new DOMParser().parseFromString(FAKE_XML_5COORDS, "text/xml")));
-    await br.textSelectionPlugin.createTextLayer(3, $container);
+    await br.textSelectionPlugin.createTextLayer({ $container, page: { index: 3, width: 100, height: 100 }});
     expect($container.find(".textSelectionSVG").length).toBe(1);
     expect($container.find(".BRparagElement").length).toBe(1);
     expect($container.find(".BRwordElement").length).toBe(1);
@@ -135,7 +127,7 @@ describe("Generic tests", () => {
     const $container = br.refs.$brContainer;
     sinon.stub(br.textSelectionPlugin, "getPageText")
       .returns($(new DOMParser().parseFromString(FAKE_XML_EMPTY, "text/xml")));
-    await br.textSelectionPlugin.createTextLayer(4, $container);
+    await br.textSelectionPlugin.createTextLayer({ $container, page: { index: 4, width: 100, height: 100 }});
     expect($container.find(".textSelectionSVG").length).toBe(1);
     expect($container.find(".BRparagElement").length).toBe(0);
     expect($container.find(".BRwordElement").length).toBe(0);
@@ -146,28 +138,28 @@ describe("Generic tests", () => {
     const $container = br.refs.$brContainer;
     br.textSelectionPlugin.stopPageFlip($container);
     const currIndex = br.currentIndex();
-    $container.find("BRwordElement").mousedown();
+    $container.find("BRwordElement").trigger("mousedown");
     // Waits for long press
     setTimeout(() => {
-      $container.find("BRwordElement").mousedown();
+      $container.find("BRwordElement").trigger("mousedown");
       // Waits for flipping animation
       setTimeout(() => {
         expect(br.currentIndex()).toBe(currIndex);
       }, 2000);
     }, LONG_PRESS_DURATION);
   });
-})
+});
 
 describe("textSelectionPlugin constructor", () => {
   test("textSelectionPlugin constructor with firefox browser", () => {
-    const tsp = new TextSelectionPlugin({}, {}, true)
+    const tsp = new TextSelectionPlugin({}, {}, true);
     expect(tsp.djvuPagesPromise).toBe(null);
     expect(tsp.svgParagraphElement).toBe("g");
     expect(tsp.svgWordElement).toBe("text");
   });
 
   test("textSelectionPlugin constructor not on firefox browser", () => {
-    const tsp = new TextSelectionPlugin({}, {}, false)
+    const tsp = new TextSelectionPlugin({}, {}, false);
     expect(tsp.djvuPagesPromise).toBe(null);
     expect(tsp.svgParagraphElement).toBe("text");
     expect(tsp.svgWordElement).toBe("tspan");

package/tests/{plugins → jest/plugins}/plugin.vendor-fullscreen.test.js

@@ -1,6 +1,6 @@
 
-import BookReader from '../../src/BookReader.js';
-import * as util from '../../src/plugins/plugin.vendor-fullscreen.js';
+import BookReader from '@/src/BookReader.js';
+import * as util from '@/src/plugins/plugin.vendor-fullscreen.js';
 
 let br;
 beforeEach(() => {

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

@@ -1,9 +1,9 @@
+import BookReader from '@/src/BookReader.js';
+import '@/src/plugins/plugin.mobile_nav.js';
+import { marshallSearchResults } from '@/src/plugins/search/plugin.search.js';
+import { deepCopy } from '../../utils.js';
 
-import BookReader from '../../../src/BookReader.js';
-import '../../../src/plugins/plugin.mobile_nav.js';
-import '../../../src/plugins/search/plugin.search.js';
-
-jest.mock('../../../src/plugins/search/view.js');
+jest.mock('@/src/plugins/search/view.js');
 
 let br;
 const namespace = 'BookReader:';
@@ -14,31 +14,33 @@ const triggeredEvents = () => {
   });
 };
 
+const DUMMY_RESULTS = {
+  ia: "adventuresofoli00dick",
+  q: "child",
+  indexed: true,
+  page_count: 644,
+  body_length: 666,
+  leaf0_missing: false,
+  matches: [{
+    text: 'For a long; time after it was ushered into this world of sorrow and trouble, by the parish surgeon, it remained a matter of considerable doubt wliether the {{{child}}} Avould survi^ e to bear any name at all; in which case it is somewhat more than probable that these memoirs would never have appeared; or, if they had, that being comprised within a couple of pages, they would have possessed the inestimable meiit of being the most concise and faithful specimen of biography, extant in the literature of any age or country.',
+    par: [{
+      boxes: [{r: 1221, b: 2121, t: 2075, page: 37, l: 1107}],
+      b: 2535,
+      t: 1942,
+      page_width: 1790,
+      r: 1598,
+      l: 50,
+      page_height: 2940,
+      page: 37
+    }]
+  }]
+};
+
 beforeEach(() => {
   $.ajax = jest.fn().mockImplementation(() => {
     // return from:
     // `https://ia800304.us.archive.org/fulltext/inside.php?item_id=adventuresofoli00dick&doc=adventuresofoli00dick&path=/30/items/adventuresofoli00dick&q=child&callback=<serialized jQ CB>`
-    return Promise.resolve({
-      ia: "adventuresofoli00dick",
-      q: "child",
-      indexed: true,
-      page_count: 644,
-      body_length: 666,
-      leaf0_missing: false,
-      matches: [{
-        text: 'For a long; time after it was ushered into this world of sorrow and trouble, by the parish surgeon, it remained a matter of considerable doubt wliether the {{{child}}} Avould survi^ e to bear any name at all; in which case it is somewhat more than probable that these memoirs would never have appeared; or, if they had, that being comprised within a couple of pages, they would have possessed the inestimable meiit of being the most concise and faithful specimen of biography, extant in the literature of any age or country.',
-        par: [{
-          boxes: [{r: 1221, b: 2121, t: 2075, page: 37, l: 1107}],
-          b: 2535,
-          t: 1942,
-          page_width: 1790,
-          r: 1598,
-          l: 50,
-          page_height: 2940,
-          page: 37
-        }]
-      }]
-    });
+    return Promise.resolve(deepCopy(DUMMY_RESULTS));
   });
 
   $.fn.trigger = jest.fn();
@@ -46,6 +48,7 @@ beforeEach(() => {
   br = new BookReader();
   br.initToolbar = jest.fn();
   br.showProgressPopup = jest.fn();
+  br.searchXHR = jest.fn();
 });
 
 afterEach(() => {
@@ -101,7 +104,7 @@ describe('Plugin: Search', () => {
     expect(br.search.mock.calls[0][1])
       .toHaveProperty('goToFirstResult', true);
     expect(br.search.mock.calls[0][1])
-      .toHaveProperty('suppressFragmentChange', true);
+      .toHaveProperty('suppressFragmentChange', false);
   });
 
   test('calling `search` fires ajax call`', () => {
@@ -116,28 +119,30 @@ describe('Plugin: Search', () => {
     expect(triggeredEvents()).toContain(`${namespace}SearchStarted`);
   });
 
-  test('SearchCallback event fires when AJAX search returns results', () => {
+  test('SearchStarted event fires and should go to first result', () => {
     br.init();
-    const dfd = br.search('foo');
-    return dfd.then(() => {
-      expect(triggeredEvents()).toContain(`${namespace}SearchCallback`);
-    });
+    br.search('foo', { goToFirstResult: true});
+    expect(br.options.goToFirstResult).toBeTruthy();
+  });
+
+  test('SearchCallback event fires when AJAX search returns results', async () => {
+    br.init();
+    await br.search('foo');
+    expect(triggeredEvents()).toContain(`${namespace}SearchCallback`);
   });
 
-  test('SearchCallbackError event fires when AJAX search returns error', () => {
+  test('SearchCallbackError event fires when AJAX search returns error', async () => {
     $.ajax = jest.fn().mockImplementation(() => {
       return Promise.resolve({
         error: true,
       });
     });
     br.init();
-    const dfd = br.search('foo');
-    return dfd.then(() => {
-      expect(triggeredEvents()).toContain(`${namespace}SearchCallbackError`);
-    });
+    await br.search('foo');
+    expect(triggeredEvents()).toContain(`${namespace}SearchCallbackError`);
   });
 
-  test('SearchCallbackNotIndexed event fires when AJAX search returns false indexed value', () => {
+  test('SearchCallbackNotIndexed event fires when AJAX search returns false indexed value', async () => {
     $.ajax = jest.fn().mockImplementation(() => {
       return Promise.resolve({
         matches: [],
@@ -145,22 +150,33 @@ describe('Plugin: Search', () => {
       });
     });
     br.init();
-    const dfd = br.search('foo');
-    return dfd.then(() => {
-      expect(triggeredEvents()).toContain(`${namespace}SearchCallbackBookNotIndexed`);
-    });
+    await br.search('foo');
+    expect(triggeredEvents()).toContain(`${namespace}SearchCallbackBookNotIndexed`);
   });
 
-  test('SearchCallbackEmpty event fires when AJAX search returns no matches', () => {
+  test('SearchCallbackEmpty event fires when AJAX search returns no matches', async () => {
     $.ajax = jest.fn().mockImplementation(() => {
       return Promise.resolve({
         matches: [],
       });
     });
     br.init();
-    const dfd = br.search('foo');
-    return dfd.then(() => {
-      expect(triggeredEvents()).toContain(`${namespace}SearchCallbackEmpty`);
-    });
+    await br.search('foo');
+    expect(triggeredEvents()).toContain(`${namespace}SearchCallbackEmpty`);
+  });
+});
+
+describe('marshallSearchResults', () => {
+  test('Adds match index', () => {
+    const results = deepCopy(DUMMY_RESULTS);
+    marshallSearchResults(results, x => x.toString());
+    expect(results.matches[0]).toHaveProperty('matchIndex', 0);
+    expect(results.matches[0].par[0].boxes[0]).toHaveProperty('matchIndex', 0);
+  });
+
+  test('Adds display page number', () => {
+    const results = deepCopy(DUMMY_RESULTS);
+    marshallSearchResults(results, x => `n${x}`);
+    expect(results.matches[0]).toHaveProperty('displayPageNumber', 'n37');
   });
 });

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

@@ -1,8 +1,8 @@
 
-import BookReader from '../../../src/BookReader.js';
-import '../../../src/plugins/plugin.mobile_nav.js';
-import '../../../src/plugins/search/plugin.search.js';
-import '../../../src/plugins/search/view.js';
+import BookReader from '@/src/BookReader.js';
+import '@/src/plugins/plugin.mobile_nav.js';
+import '@/src/plugins/search/plugin.search.js';
+import '@/src/plugins/search/view.js';
 
 let br;
 const namespace = 'BookReader:';
@@ -27,6 +27,27 @@ const results = {
     }]
   }]
 };
+const resultWithScript = {
+  ia: "adventuresofoli00dick",
+  q: "child",
+  indexed: true,
+  page_count: 644,
+  body_length: 666,
+  leaf0_missing: false,
+  matches: [{
+    text: 'foo bar <script>alert(1);</script> {{{keyword}}} baz',
+    par: [{
+      boxes: [{r: 1221, b: 2121, t: 2075, page: 37, l: 1107}],
+      b: 2535,
+      t: 1942,
+      page_width: 1790,
+      r: 1598,
+      l: 50,
+      page_height: 2940,
+      page: 37
+    }]
+  }]
+};
 beforeEach(() => {
   $.ajax = jest.fn().mockImplementation(() => {
     // return from:
@@ -63,14 +84,14 @@ describe('View: Plugin: Search', () => {
 
       expect(br.searchView.dom.searchNavigation).toBeUndefined();
 
-      br.searchView.handleSearchCallback(event, { results, options})
+      br.searchView.handleSearchCallback(event, { results, options});
       expect(br.searchView.dom.searchNavigation).toBeDefined();
     });
     test('has controls', () => {
       br.init();
       const event = new CustomEvent(`${namespace}SearchCallback`);
       const options = { goToFirstResult: false };
-      br.searchView.handleSearchCallback(event, { results, options})
+      br.searchView.handleSearchCallback(event, { results, options});
 
       const searchResultsNav = document.querySelector('.BRsearch-navigation');
       expect(searchResultsNav).toBeDefined();
@@ -81,6 +102,14 @@ describe('View: Plugin: Search', () => {
       expect(searchResultsNav.querySelector('.prev')).toBeDefined();
       expect(searchResultsNav.querySelector('.next')).toBeDefined();
     });
+    test('disallows xss from search results', () => {
+      br.init();
+      const event = new CustomEvent(`${namespace}SearchCallback`);
+      const options = { goToFirstResult: false };
+      br.searchView.handleSearchCallback(event, { results: resultWithScript, options });
+
+      expect(br.searchView.dom.searchNavigation.parent().html()).not.toContain('<script>alert(1);</script>');
+    });
 
     describe('Click events handlers', () => {
       it('triggers custom event when toggling side menu', () => {