@internetarchive/bookreader 5.0.0-4 → 5.0.0-40-a1

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:';
@@ -63,14 +63,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();

package/tests/{plugins → jest/plugins}/tts/AbstractTTSEngine.test.js

@@ -1,12 +1,12 @@
 import sinon from 'sinon';
 import { afterEventLoop } from '../../utils.js';
-import AbstractTTSEngine from '../../../src/plugins/tts/AbstractTTSEngine.js';
-import PageChunkIterator from '../../../src/plugins/tts/PageChunkIterator.js';
-/** @typedef {import('../../../src/plugins/tts/AbstractTTSEngine.js').TTSEngineOptions} TTSEngineOptions */
+import AbstractTTSEngine from '@/src/plugins/tts/AbstractTTSEngine.js';
+import PageChunkIterator from '@/src/plugins/tts/PageChunkIterator.js';
+/** @typedef {import('@/src/plugins/tts/AbstractTTSEngine.js').TTSEngineOptions} TTSEngineOptions */
 
 // Skipping because it's flaky. Fix in #672
 describe.skip('AbstractTTSEngine', () => {
-  test('stops playing once done', () => {
+  test('stops playing once done', async () => {
     class DummyEngine extends AbstractTTSEngine {
       getVoices() { return []; }
     }
@@ -15,8 +15,8 @@ describe.skip('AbstractTTSEngine', () => {
     const stopStub = sinon.stub(d, 'stop');
     expect(stopStub.callCount).toBe(0);
     d.step();
-    return afterEventLoop()
-      .then(() => expect(stopStub.callCount).toBe(1));
+    await afterEventLoop();
+    expect(stopStub.callCount).toBe(1);
   });
 });
 

package/tests/{plugins → jest/plugins}/tts/FestivalTTSEngine.test.js

@@ -1,10 +1,10 @@
-import FestivalTTSEngine from '../../../src/plugins/tts/FestivalTTSEngine.js';
+import FestivalTTSEngine from '@/src/plugins/tts/FestivalTTSEngine.js';
 import sinon from 'sinon';
 import { afterEventLoop } from '../../utils.js';
 import { DUMMY_TTS_ENGINE_OPTS } from './AbstractTTSEngine.test.js';
-import PageChunk from '../../../src/plugins/tts/PageChunk.js';
-import PageChunkIterator from '../../../src/plugins/tts/PageChunkIterator.js';
-/** @typedef {import('../../../src/plugins/tts/AbstractTTSEngine.js').TTSEngineOptions} TTSEngineOptions */
+import PageChunk from '@/src/plugins/tts/PageChunk.js';
+import PageChunkIterator from '@/src/plugins/tts/PageChunkIterator.js';
+/** @typedef {import('@/src/plugins/tts/AbstractTTSEngine.js').TTSEngineOptions} TTSEngineOptions */
 
 describe('iOSCaptureUserIntentHack', () => {
   test('synchronously calls createSound/play to capture user intent', () => {

package/tests/{plugins → jest/plugins}/tts/PageChunk.test.js

@@ -1,4 +1,4 @@
-import PageChunk from '../../../src/plugins/tts/PageChunk.js';
+import PageChunk from '@/src/plugins/tts/PageChunk.js';
 
 describe('_fixChunkRects', () => {
   const { _fixChunkRects } = PageChunk;

package/tests/{plugins → jest/plugins}/tts/PageChunkIterator.test.js

@@ -1,6 +1,6 @@
 import sinon from 'sinon';
-import PageChunkIterator from "../../../src/plugins/tts/PageChunkIterator";
-import PageChunk from '../../../src/plugins/tts/PageChunk';
+import PageChunkIterator from "@/src/plugins/tts/PageChunkIterator";
+import PageChunk from '@/src/plugins/tts/PageChunk';
 
 describe('Buffers pages', () => {
   test('Does not error if no room for reverse buffer', async () => {
@@ -109,7 +109,7 @@ describe('Iterates pages', () => {
     expect(iterator._cursor.chunk).toBe(0);
 
     for (let i = 2; i >= 0; i--) {
-      await iterator.decrement()
+      await iterator.decrement();
       expect(iterator._cursor.page).toBe(49);
       expect(iterator._cursor.chunk).toBe(i);
     }

package/tests/{plugins → jest/plugins}/tts/WebTTSEngine.test.js

@@ -1,5 +1,5 @@
 import sinon from 'sinon';
-import { WebTTSSound } from '../../../src/plugins/tts/WebTTSEngine.js';
+import { WebTTSSound } from '@/src/plugins/tts/WebTTSEngine.js';
 import { afterEventLoop, eventTargetMixin } from '../../utils.js';
 
 beforeEach(() => {

package/tests/{plugins → jest/plugins}/tts/utils.test.js

@@ -1,6 +1,6 @@
 import sinon from 'sinon';
 import { afterEventLoop, eventTargetMixin } from '../../utils.js';
-import * as utils from '../../../src/plugins/tts/utils.js';
+import * as utils from '@/src/plugins/tts/utils.js';
 
 describe('promisifyEvent', () => {
   const { promisifyEvent } = utils;
@@ -10,7 +10,7 @@ describe('promisifyEvent', () => {
     const resolveSpy = sinon.spy();
     promisifyEvent(fakeTarget, 'pause').then(resolveSpy);
 
-    await afterEventLoop()
+    await afterEventLoop();
     expect(resolveSpy.callCount).toBe(0);
     fakeTarget.dispatchEvent('pause', {});
     await afterEventLoop();
@@ -22,7 +22,7 @@ describe('promisifyEvent', () => {
     const resolveSpy = sinon.spy();
     promisifyEvent(fakeTarget, 'pause').then(resolveSpy);
 
-    await afterEventLoop()
+    await afterEventLoop();
     expect(resolveSpy.callCount).toBe(0);
     fakeTarget.dispatchEvent('pause', {});
     fakeTarget.dispatchEvent('pause', {});

package/tests/jest/plugins/url/UrlPlugin.test.js

@@ -0,0 +1,190 @@
+import { UrlPlugin } from '@/src/plugins/url/UrlPlugin';
+
+afterEach(() => {
+  jest.clearAllMocks();
+});
+
+describe('UrlPlugin tests', () => {
+  const urlPlugin = new UrlPlugin();
+
+  describe('urlStateToUrlString tests', () => {
+    test('urlStateToUrlString with known states in schema', () => {
+      const urlState = { page: 'n7', mode: '1up', search: 'foo' };
+      const urlStateWithQueries = { page: 'n7', mode: '1up', q: 'hello', view: 'theater', sort: 'title_asc' };
+
+      const expectedUrlFromState = 'page/n7/mode/1up?q=foo';
+      const expectedUrlFromStateWithQueries = 'page/n7/mode/1up?q=hello&view=theater&sort=title_asc';
+
+      expect(urlPlugin.urlStateToUrlString(urlState)).toBe(expectedUrlFromState);
+      expect(urlPlugin.urlStateToUrlString(urlStateWithQueries)).toBe(expectedUrlFromStateWithQueries);
+    });
+
+    test('urlStateToUrlString with unknown states in schema', () => {
+      const urlState = { page: 'n7', mode: '1up' };
+      const urlStateWithQueries = { page: 'n7', mode: '1up', q: 'hello', viewer: 'theater', sortBy: 'title_asc' };
+
+      const expectedUrlFromState = 'page/n7/mode/1up';
+      const expectedUrlFromStateWithQueries = 'page/n7/mode/1up?q=hello&viewer=theater&sortBy=title_asc';
+
+      expect(urlPlugin.urlStateToUrlString(urlState)).toBe(expectedUrlFromState);
+      expect(urlPlugin.urlStateToUrlString(urlStateWithQueries)).toBe(expectedUrlFromStateWithQueries);
+    });
+
+    test('urlStateToUrlString with boolean value', () => {
+      const urlState = { page: 'n7', mode: '1up', search: 'foo', view: 'theater', wrapper: 'false' };
+      const expectedUrlFromState = 'page/n7/mode/1up?q=foo&view=theater&wrapper=false';
+
+      expect(urlPlugin.urlStateToUrlString(urlState)).toBe(expectedUrlFromState);
+    });
+  });
+
+  describe('urlStringToUrlState tests', () => {
+    test('urlStringToUrlState without query string', () => {
+      const url = '/page/n7/mode/2up';
+      const url1 = '/page/n7/mode/1up';
+
+      expect(urlPlugin.urlStringToUrlState(url)).toEqual({page: 'n7', mode: '2up'});
+      expect(urlPlugin.urlStringToUrlState(url1)).toEqual({page: 'n7', mode: '1up'});
+    });
+
+    test('urlStringToUrlState with deprecated_for', () => {
+      const url = '/page/n7/mode/2up/search/hello';
+
+      expect(urlPlugin.urlStringToUrlState(url)).toEqual({page: 'n7', mode: '2up', q: 'hello'});
+    });
+
+    test('urlStringToUrlState with query string', () => {
+      const url = '/page/n7/mode/2up/search/hello?view=theather&foo=bar&sort=title_asc';
+      const url1 = '/mode/2up?ref=ol&ui=embed&wrapper=false&view=theater';
+
+      expect(urlPlugin.urlStringToUrlState(url)).toEqual(
+        {page: 'n7', mode: '2up', q: 'hello', view: 'theather', foo: 'bar', sort: 'title_asc'}
+      );
+      expect(urlPlugin.urlStringToUrlState(url1)).toEqual(
+        {mode: '2up', ref: 'ol', ui: 'embed', wrapper: 'false', view: 'theater'}
+      );
+    });
+
+    test('urlStringToUrlState compare search and ?q', () => {
+      const url = '/page/n7/mode/2up/search/hello';
+      urlPlugin.urlState = { q: 'hello' };
+
+      expect(urlPlugin.urlStringToUrlState(url)).toEqual({page: 'n7', mode: '2up', q: 'hello'});
+    });
+  });
+
+  describe('url plugin helper functions', () => {
+    test('setUrlParam', () => {
+      urlPlugin.urlState = {};
+      urlPlugin.setUrlParam('page', '20');
+      urlPlugin.setUrlParam('mode', '2up');
+
+      expect(urlPlugin.urlState).toEqual({page: '20', mode: '2up'});
+    });
+
+    test('removeUrlParam', () => {
+      urlPlugin.setUrlParam('page', '20');
+      urlPlugin.setUrlParam('mode', '2up');
+      urlPlugin.removeUrlParam('mode');
+
+      expect(urlPlugin.urlState).toEqual({page: '20'});
+    });
+
+    test('getUrlParam', () => {
+      urlPlugin.setUrlParam('page', '20');
+      urlPlugin.setUrlParam('mode', '2up');
+      expect(urlPlugin.getUrlParam('page')).toEqual('20');
+      expect(urlPlugin.getUrlParam('mode')).toEqual('2up');
+    });
+  });
+
+  describe('pullFromAddressBar and pushToAddressBar - hash mode', () => {
+    test('url first load - empty state', () => {
+      urlPlugin.urlState = {};
+      urlPlugin.urlMode = 'hash';
+
+      urlPlugin.pullFromAddressBar({ pathname: '', search: '', hash: '#' });
+      expect(urlPlugin.urlState).toEqual({});
+
+      urlPlugin.pushToAddressBar();
+      expect(window.location.hash).toEqual('');
+    });
+
+    test('url without mode state value - use default', () => {
+      urlPlugin.urlState = {};
+      urlPlugin.urlMode = 'hash';
+
+      urlPlugin.pullFromAddressBar({ pathname: '', search: '', hash: '#page/12' });
+      expect(urlPlugin.urlState).toEqual({page: '12'});
+
+      urlPlugin.pushToAddressBar();
+      expect(window.location.hash).toEqual('#page/12');
+    });
+
+    test('url with query param', () => {
+      urlPlugin.urlState = {};
+      urlPlugin.urlMode = 'hash';
+
+      urlPlugin.pullFromAddressBar({ pathname: '', search: '', hash: '#page/12?q=hello&view=theater' });
+      expect(urlPlugin.urlState).toEqual({page: '12', q: 'hello', view: 'theater'});
+
+      urlPlugin.pushToAddressBar();
+      expect(window.location.hash).toEqual('#page/12?q=hello&view=theater');
+    });
+  });
+
+  describe('pullFromAddressBar and pushToAddressBar - history mode', () => {
+    test('url first load - empty state', () => {
+      urlPlugin.urlState = {};
+      urlPlugin.urlHistoryBasePath = '/details/foo';
+      urlPlugin.urlMode = 'history';
+
+      urlPlugin.pullFromAddressBar({ pathname: '', search: '', hash: '' });
+      expect(urlPlugin.urlState).toEqual({});
+
+      urlPlugin.pushToAddressBar();
+      expect(window.location.pathname).toEqual('/details/foo');
+    });
+
+    test('url without mode state value', () => {
+      urlPlugin.urlState = {};
+      urlPlugin.urlHistoryBasePath = '/details/foo/';
+      urlPlugin.urlMode = 'history';
+
+      urlPlugin.pullFromAddressBar({ pathname: '/details/foo/page/12', search: '', hash: '' });
+      expect(urlPlugin.urlState).toEqual({page: '12'});
+
+      urlPlugin.pushToAddressBar();
+      expect(window.location.pathname).toEqual('/details/foo/page/12');
+    });
+
+    test('url with query param', () => {
+      urlPlugin.urlState = {};
+      urlPlugin.urlHistoryBasePath = '/details/foo/';
+      urlPlugin.urlMode = 'history';
+
+      urlPlugin.pullFromAddressBar({ pathname: '/details/foo/page/12', search: '?q=hello&view=theater', hash: '' });
+      expect(urlPlugin.urlState).toEqual({page: '12', q: 'hello', view: 'theater'});
+
+      urlPlugin.pushToAddressBar();
+      const locationUrl = `${window.location.pathname}${window.location.search}`;
+      expect(locationUrl).toEqual('/details/foo/page/12?q=hello&view=theater');
+    });
+
+    test('strips leading slash of incoming path name for no double slash', () => {
+      const urlPlugin = new UrlPlugin();
+      urlPlugin.urlMode = 'history';
+
+      urlPlugin.urlHistoryBasePath = '/details/SubBookTest/book1/GPORFP/';
+      urlPlugin.urlState = {
+        "mode": "1up",
+      };
+
+      urlPlugin.setUrlParam('sort', 'title_asc');
+      urlPlugin.setUrlParam('mode', 'thumb');
+
+      expect(window.location.href).toEqual('http://localhost/details/SubBookTest/book1/GPORFP/mode/thumb?sort=title_asc');
+    });
+  });
+
+});

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

@@ -1,6 +1,6 @@
-
-import BookReader from '../../src/BookReader.js';
-import '../../src/plugins/plugin.url.js';
+import BookReader from '@/src/BookReader.js';
+import '@/src/plugins/url/plugin.url.js';
+import sinon from 'sinon';
 
 let br;
 beforeAll(() => {
@@ -10,6 +10,7 @@ beforeAll(() => {
 
 afterEach(() => {
   jest.clearAllMocks();
+  sinon.restore();
 });
 
 describe('Plugin: URL controller', () => {
@@ -26,10 +27,10 @@ describe('Plugin: URL controller', () => {
     expect(defaultOptions).toHaveProperty('updateWindowTitle');
     expect(defaultOptions).toHaveProperty('defaults');
     expect(defaultOptions).toHaveProperty('bookId');
-  })
+  });
 
   test('has a whitelist of params that it tracks', () => {
-    ['page', 'search', 'mode', 'region', 'highlight']
+    ['page', 'search', 'mode', 'region', 'highlight'];
     const { defaultOptions: { urlTrackedParams } } = BookReader;
     expect(Array.isArray(urlTrackedParams)).toEqual(true);
     expect(urlTrackedParams.find(param => param === 'page')).toBeTruthy();
@@ -37,7 +38,8 @@ describe('Plugin: URL controller', () => {
     expect(urlTrackedParams.find(param => param === 'mode')).toBeTruthy();
     expect(urlTrackedParams.find(param => param === 'region')).toBeTruthy();
     expect(urlTrackedParams.find(param => param === 'highlight')).toBeTruthy();
-  })
+    expect(urlTrackedParams.find(param => param === 'view')).toBeTruthy();
+  });
 
   test('initializes polling for url changes if using hash', () => {
     BookReader.prototype.urlStartLocationPolling = jest.fn();
@@ -60,7 +62,7 @@ describe('Plugin: URL controller', () => {
     br.urlUpdateFragment();
 
     expect(window.history.replaceState).toHaveBeenCalled();
-  })
+  });
 
   test('updates URL when mode changes', () => {
     window.history.replaceState = jest.fn();
@@ -76,7 +78,7 @@ describe('Plugin: URL controller', () => {
     br.urlUpdateFragment();
 
     expect(window.history.replaceState).toHaveBeenCalled();
-  })
+  });
 
   test('updates URL when search changes', () => {
     window.history.replaceState = jest.fn();
@@ -93,7 +95,24 @@ describe('Plugin: URL controller', () => {
     br.urlUpdateFragment();
 
     expect(window.history.replaceState).toHaveBeenCalled();
-  })
+  });
+
+  test('updates URL when view changes', () => {
+    window.history.replaceState = jest.fn();
+    BookReader.prototype.currentIndex = jest.fn(() => 1);
+    BookReader.prototype.urlReadFragment = jest.fn(() => '');
+    BookReader.prototype.paramsFromCurrent = jest.fn(() => ({
+      index: 1,
+      mode: 2,
+      view: 'theater'
+    }));
+    BookReader.prototype.search = jest.fn();
+    br.options.urlMode = 'history';
+    br.init();
+    br.urlUpdateFragment();
+
+    expect(window.history.replaceState).toHaveBeenCalled();
+  });
 
   test('does not update URL when search in query string', () => {
     window.history.replaceState = jest.fn();
@@ -112,18 +131,18 @@ describe('Plugin: URL controller', () => {
     br.urlUpdateFragment();
 
     expect(window.history.replaceState).toHaveBeenCalledTimes(0);
-  })
+  });
 
   test('only q= param is selected from url query params', () => {
-    const INTIAL_URL = "http://127.0.0.1:8080/BookReaderDemo/demo-internetarchive.html?ocaid=adventuresofoli00dick&q=foo"
+    const INTIAL_URL = "http://127.0.0.1:8080/BookReaderDemo/demo-internetarchive.html?ocaid=adventuresofoli00dick&q=foo";
     const result = br.urlParamsFiltersOnlySearch(INTIAL_URL);
     expect(result).toBe("?q=foo");
-  })
+  });
 
   test('only q= param is selected from url query params with special character', () => {
-    const INTIAL_URL = "http://127.0.0.1:8080/BookReaderDemo/demo-internetarchive.html?ocaid=adventuresofoli00dick&q=foo%24%24"
+    const INTIAL_URL = "http://127.0.0.1:8080/BookReaderDemo/demo-internetarchive.html?ocaid=adventuresofoli00dick&q=foo%24%24";
     const result = br.urlParamsFiltersOnlySearch(INTIAL_URL);
     expect(result).toBe("?q=foo%24%24");
-  })
+  });
 });
 

package/tests/{util → jest/util}/browserSniffing.test.js

@@ -1,6 +1,6 @@
 import {
   isChrome, isFirefox, isSafari,
-} from '../../src/util/browserSniffing.js';
+} from '@/src/util/browserSniffing.js';
 
 const TESTS = [
   {

package/tests/{util → jest/util}/docCookies.test.js

@@ -1,4 +1,4 @@
-import * as docCookies from '../../src/util/docCookies.js';
+import * as docCookies from '@/src/util/docCookies.js';
 
 afterEach(() => {
   jest.clearAllMocks();

package/tests/{util → jest/util}/strings.test.js

@@ -1,4 +1,4 @@
-import { APPLY_FILTERS, applyVariables } from '../../src/util/strings.js';
+import { APPLY_FILTERS, applyVariables } from '@/src/util/strings.js';
 
 describe('applyVariables', () => {
   test('null cases', () => {

package/tests/{utils.js → jest/utils.js}

@@ -31,6 +31,44 @@ export function eventTargetMixin() {
   };
 }
 
+/** @implements {EventTarget} */
+export class EventTargetSpy {
+  /** @type {Record<string, Function[]} */
+  _listeners = {}
+  get _totalListenerCount() {
+    return Object.values(this._listeners)
+      .map(a => a.length)
+      .reduce((a, b) => a + b, 0);
+  }
+
+  addEventListener(evName, listener) {
+    const listeners = this._listeners[evName] || [];
+    listeners.push(listener);
+    this._listeners[evName] = listeners;
+  }
+
+  dispatchEvent(evName, ev) {
+    const listeners = this._listeners[evName] || [];
+    listeners.forEach(fn => fn(ev));
+  }
+
+  removeEventListener(evName, listener) {
+    const listeners = this._listeners[evName] || [];
+    this._listeners[evName] = listeners.filter(fn => fn != listener);
+  }
+
+  /**
+   * @param {EventTarget} realEventTarget
+   */
+  static wrap(realEventTarget) {
+    const spy = new EventTargetSpy();
+    realEventTarget.addEventListener = spy.addEventListener.bind(spy);
+    realEventTarget.removeEventListener = spy.removeEventListener.bind(spy);
+    realEventTarget.dispatchEvent = spy.dispatchEvent.bind(spy);
+    return spy;
+  }
+}
+
 /**
  * Lazy deep copy function; only supports objects (no classes)
  * @template T