@internetarchive/bookreader 5.0.0-26 → 5.0.0-29

package/tests/karma/BookNavigator/search/search-provider.test.js

@@ -1,23 +1,123 @@
-import { expect } from '@open-wc/testing';
+import { expect, fixtureCleanup, fixtureSync } from '@open-wc/testing';
 import sinon from 'sinon';
 import searchProvider from '../../../../src/BookNavigator/search/search-provider';
 
 afterEach(() => {
   sinon.restore();
+  fixtureCleanup();
 });
 
 describe('Search Provider', () => {
   describe('constructor', () => {
-    const onSearchChangeCB = sinon.fake();
-    const br = sinon.fake();
-    const provider = new searchProvider(onSearchChangeCB, br);
+    const provider = new searchProvider({
+      onProviderChange: sinon.fake(),
+      bookreader: {}
+    });
 
-    expect(provider.bookreader).to.equal(br);
-    expect(provider.onSearchChange).to.equal(onSearchChangeCB);
+    expect(provider.bookreader).to.exist;
+    expect(provider.onProviderChange).to.exist;
     expect(provider.id).to.equal('search');
     expect(provider.icon).to.exist;
+    expect(fixtureSync(provider.icon).tagName).to.equal('IA-ICON-SEARCH');
     expect(provider.label).to.equal('Search inside');
     expect(provider.menuDetails).to.exist;
     expect(provider.component).to.exist;
   });
+  describe('BR calls', () => {
+    it('`advanceToPage', () => {
+      const provider = new searchProvider({
+        onProviderChange: sinon.fake(),
+        bookreader: {
+          leafNumToIndex: sinon.fake(),
+          _searchPluginGoToResult: sinon.fake()
+        }
+      });
+
+      provider.advanceToPage(1);
+      expect(provider?.bookreader.leafNumToIndex.callCount).to.equal(1);
+      expect(provider?.bookreader._searchPluginGoToResult.callCount).to.equal(1);
+    });
+  });
+  describe('Search request life cycles', () => {
+    it('Event: catches `BookReader:SearchStarted`', async() => {
+      const provider = new searchProvider({
+        onProviderChange: sinon.fake(),
+        bookreader: {}
+      });
+      sinon.spy(provider, 'updateMenu');
+      window.dispatchEvent(new CustomEvent('BookReader:SearchStarted', { detail: { props: { term: 'foo' }}}));
+      expect(provider.updateMenu.callCount).to.equal(1);
+    });
+    it('Event: catches `BookReader:SearchCallback`', async() => {
+      const provider = new searchProvider({
+        onProviderChange: sinon.fake(),
+        bookreader: {}
+      });
+      sinon.spy(provider, 'updateMenu');
+      const brStub = {};
+      window.dispatchEvent(new CustomEvent('BookReader:SearchCallback', { detail: { props: { instance: brStub, results: { matches: []} }}}));
+      expect(provider.updateMenu.callCount).to.equal(1);
+      expect(provider.bookreader).to.equal(brStub);
+    });
+    it('Event: catches `BookReader:SearchCallbackEmpty`', async() => {
+      const provider = new searchProvider({
+        onProviderChange: sinon.fake(),
+        bookreader: {}
+      });
+      sinon.spy(provider, 'onSearchRequestError');
+      sinon.spy(provider, 'updateMenu');
+      const brStub = {};
+      window.dispatchEvent(new CustomEvent('BookReader:SearchCallbackEmpty', { detail: { props: { instance: brStub }}}));
+      expect(provider.onSearchRequestError.getCall(0).args[1]).to.equal('noResults');
+      expect(provider.updateMenu.callCount).to.equal(1);
+      expect(provider.bookreader).to.equal(brStub);
+    });
+    it('Event: catches `BookReader:SearchCallbackNotIndexed`', async() => {
+      const provider = new searchProvider({
+        onProviderChange: sinon.fake(),
+        bookreader: {}
+      });
+      const brStub = {};
+      sinon.spy(provider, 'onSearchRequestError');
+      sinon.spy(provider, 'updateMenu');
+      window.dispatchEvent(new CustomEvent('BookReader:SearchCallbackNotIndexed', { detail: { props: { instance: brStub }}}));
+      expect(provider.onSearchRequestError.getCall(0).args[1]).to.equal('notIndexed');
+      expect(provider.updateMenu.callCount).to.equal(1);
+      expect(provider.bookreader).to.equal(brStub);
+    });
+    it('Event: catches `BookReader:SearchCallbackError`', async() => {
+      const provider = new searchProvider({
+        onProviderChange: sinon.fake(),
+        bookreader: {}
+      });
+      sinon.spy(provider, 'onSearchRequestError');
+      sinon.spy(provider, 'updateMenu');
+      const brStub = {};
+      window.dispatchEvent(new CustomEvent('BookReader:SearchCallbackError', { detail: { props: { instance: brStub }}}));
+      expect(provider.onSearchRequestError.getCall(0).args[1]).to.equal(undefined);
+      expect(provider.updateMenu.callCount).to.equal(1);
+      expect(provider.bookreader).to.equal(brStub);
+    });
+    it('Event: catches `component@resultSelected` - user clicks result in side panel - & turns page', async() => {
+      const provider = new searchProvider({
+        onProviderChange: sinon.fake(),
+        bookreader: {
+          leafNumToIndex: sinon.fake(),
+          _searchPluginGoToResult: sinon.fake()
+        }
+      });
+      sinon.spy(provider, 'advanceToPage');
+
+      const searchResultStub = {
+        match: { par: [{ text: 'foo', page: 3 }] },
+      };
+      fixtureSync(provider.component).dispatchEvent(
+        new CustomEvent('resultSelected',
+          { detail: searchResultStub })
+      );
+
+      expect(provider.advanceToPage.callCount).to.equal(1);
+      expect(provider.bookreader._searchPluginGoToResult.callCount).to.equal(1);
+    });
+  });
 });

package/tests/karma/BookNavigator/search/search-results.test.js

@@ -11,8 +11,6 @@ const container = (results = [], query = '') => (
   html`<ia-book-search-results .results=${results} .query=${query}></ia-book-search-results>`
 );
 
-console.log("ia-book-search-results-test");
-
 const searchQuery = 'Bristol';
 
 const results = [{

package/tests/karma/BookNavigator/sharing/sharing-provider.test.js

@@ -1,40 +1,49 @@
-import { expect } from '@open-wc/testing';
+import { expect, fixtureSync } from '@open-wc/testing';
 import sinon from 'sinon';
-import sharingProvider from '../../../../src/ItemNavigator/providers/sharing.js';
+import SharingProvider from '../../../../src/BookNavigator/sharing.js';
 
 afterEach(() => {
   sinon.restore();
 });
 
-const mdStub = {
-  identifier: 'stubby-id'
+const item = {
+  metadata: {
+    identifier: 'stubby-id',
+    creator: 'mr. big',
+    title: 'Stubby title',
+  }
 };
 
-const baseHostStub = 'foo.org';
-const itemType = 'texts';
+const baseHost = 'foo.org';
 const subPrefix = 'beep-boop_12 4 5';
 
 describe('Sharing Provider', () => {
   describe('constructor', () => {
-    const provider = new sharingProvider(mdStub, baseHostStub, itemType, subPrefix);
+    const provider = new SharingProvider({
+      item,
+      baseHost,
+      bookreader: {
+        options: { subPrefix }
+      }
+    });
 
     expect(provider.id).to.equal('share');
     expect(provider.icon).to.exist;
-    expect(provider.label).to.equal('Share this item');
-    expect(provider.itemType).to.equal(itemType);
-    expect(provider.idPath).to.exist;
-    expect(provider.component).to.exist;
+    expect(provider.label).to.equal('Share this book');
+    expect(fixtureSync(provider.component).tagName).to.contains('IA-SHARING-OPTIONS');
   });
 
-  describe('handles subprefix', () => {
-    it('encodes the subprefix if it has one', () => {
-      const provider = new sharingProvider(mdStub, baseHostStub, itemType, subPrefix);
-      const encodedSubprefix = encodeURIComponent(subPrefix);
-      expect(provider.idPath).to.equal(`${mdStub.identifier}/${encodedSubprefix}`);
-    });
-    it('does not add subprefix to path if subprefix is item id', () => {
-      const provider = new sharingProvider(mdStub, baseHostStub, itemType, mdStub.identifier);
-      expect(provider.idPath).to.equal(mdStub.identifier);
+  describe('Handles being a sub file/volume', () => {
+    it('encodes the subprefix if it has one', async () => {
+      const provider = new SharingProvider({
+        item,
+        baseHost,
+        bookreader: {
+          options: { subPrefix }
+        }
+      });
+
+      expect(fixtureSync(provider.component).fileSubPrefix).to.equal(subPrefix);
     });
   });
 });

package/tests/karma/BookNavigator/volumes/volumes-provider.test.js

@@ -1,4 +1,4 @@
-import { expect, fixture } from '@open-wc/testing';
+import { expect, fixture, fixtureCleanup, fixtureSync } from '@open-wc/testing';
 import sinon from 'sinon';
 import volumesProvider from '../../../../src/BookNavigator/volumes/volumes-provider';
 
@@ -35,21 +35,26 @@ const brOptions = {
 
 afterEach(() => {
   sinon.restore();
+  fixtureCleanup();
 });
 
 describe('Volumes Provider', () => {
   it('constructor', () => {
-    const onSortClick = sinon.fake();
+    const onProviderChange = sinon.fake();
     const baseHost = "https://archive.org";
-    const provider = new volumesProvider(baseHost, brOptions, onSortClick);
+    const provider = new volumesProvider({
+      baseHost,
+      bookreader: brOptions,
+      onProviderChange
+    });
 
     const files = brOptions.options.multipleBooksList.by_subprefix;
     const volumeCount = Object.keys(files).length;
 
-    expect(provider.optionChange).to.equal(onSortClick);
+    expect(provider.onProviderChange).to.equal(onProviderChange);
     expect(provider.id).to.equal('volumes');
     expect(provider.icon).to.exist;
-
+    expect(fixtureSync(provider.icon).tagName).to.equal('svg');
     expect(provider.label).to.equal(`Viewable files (${volumeCount})`);
     expect(provider.viewableFiles).to.exist;
     expect(provider.viewableFiles.length).to.equal(3);
@@ -60,11 +65,15 @@ describe('Volumes Provider', () => {
   });
 
   it('sorting cycles - render sort actionButton', async () => {
-    const onSortClick = sinon.fake();
+    const onProviderChange = sinon.fake();
     const baseHost = "https://archive.org";
-    const provider = new volumesProvider(baseHost, brOptions, onSortClick);
+    const provider = new volumesProvider({
+      baseHost,
+      bookreader: brOptions,
+      onProviderChange
+    });
 
-    expect(provider.sortOrderBy).to.equal("orig_sort");
+    expect(provider.sortOrderBy).to.equal("default");
 
     provider.sortVolumes("title_asc");
     expect(provider.sortOrderBy).to.equal("title_asc");
@@ -74,23 +83,27 @@ describe('Volumes Provider', () => {
     expect(provider.sortOrderBy).to.equal("title_desc");
     expect(provider.sortButton.getHTML()).includes("sort-by desc-icon");
 
-    provider.sortVolumes("orig_sort");
-    expect(provider.sortOrderBy).to.equal("orig_sort");
+    provider.sortVolumes("default");
+    expect(provider.sortOrderBy).to.equal("default");
     expect(provider.sortButton.getHTML()).includes("sort-by neutral-icon");
   });
 
   it('sort volumes in initial order', async () => {
-    const onSortClick = sinon.fake();
+    const onProviderChange = sinon.fake();
     const baseHost = "https://archive.org";
-    const provider = new volumesProvider(baseHost, brOptions, onSortClick);
+    const provider = new volumesProvider({
+      baseHost,
+      bookreader: brOptions,
+      onProviderChange
+    });
 
     const parsedFiles = brOptions.options.multipleBooksList.by_subprefix;
     const files = Object.keys(parsedFiles).map(item => parsedFiles[item]).sort((a, b) => a.orig_sort - b.orig_sort);
     const origSortTitles = files.map(item => item.title);
 
-    provider.sortVolumes("orig_sort");
+    provider.sortVolumes("default");
 
-    expect(provider.sortOrderBy).to.equal("orig_sort");
+    expect(provider.sortOrderBy).to.equal("default");
     expect(provider.actionButton).to.exist;
 
     const providerFileTitles = provider.viewableFiles.map(item => item.title);
@@ -99,9 +112,13 @@ describe('Volumes Provider', () => {
   });
 
   it('sort volumes in ascending title order', async () => {
-    const onSortClick = sinon.fake();
+    const onProviderChange = sinon.fake();
     const baseHost = "https://archive.org";
-    const provider = new volumesProvider(baseHost, brOptions, onSortClick);
+    const provider = new volumesProvider({
+      baseHost,
+      bookreader: brOptions,
+      onProviderChange
+    });
 
     const parsedFiles = brOptions.options.multipleBooksList.by_subprefix;
     const files = Object.keys(parsedFiles).map(item => parsedFiles[item]);
@@ -118,10 +135,13 @@ describe('Volumes Provider', () => {
   });
 
   it('sort volumes in descending title order', async () => {
-    const onSortClick = sinon.fake();
+    const onProviderChange = sinon.fake();
     const baseHost = "https://archive.org";
-    const provider = new volumesProvider(baseHost, brOptions, onSortClick);
-
+    const provider = new volumesProvider({
+      baseHost,
+      bookreader: brOptions,
+      onProviderChange
+    });
     provider.isSortAscending = false;
 
     const parsedFiles = brOptions.options.multipleBooksList.by_subprefix;
@@ -140,11 +160,15 @@ describe('Volumes Provider', () => {
 
   describe('Sorting icons', () => {
     it('has 3 icons', async () => {
-      const onSortClick = sinon.fake();
+      const onProviderChange = sinon.fake();
       const baseHost = "https://archive.org";
-      const provider = new volumesProvider(baseHost, brOptions, onSortClick);
+      const provider = new volumesProvider({
+        baseHost,
+        bookreader: brOptions,
+        onProviderChange
+      });
+      provider.sortOrderBy = 'default';
 
-      provider.sortOrderBy = 'orig_sort';
       const origSortButton = await fixture(provider.sortButton);
       expect(origSortButton.classList.contains('neutral-icon')).to.be.true;
 

package/webpack.config.js

@@ -51,7 +51,7 @@ module.exports = [
       'plugins/plugin.search.js': { import: './src/plugins/search/plugin.search.js', dependOn: 'BookReader.js' },
       'plugins/plugin.text_selection.js': { import: './src/plugins/plugin.text_selection.js', dependOn: 'BookReader.js' },
       'plugins/plugin.tts.js': { import: './src/plugins/tts/plugin.tts.js', dependOn: 'BookReader.js' },
-      'plugins/plugin.url.js': { import: './src/plugins/plugin.url.js', dependOn: 'BookReader.js' },
+      'plugins/plugin.url.js': { import: './src/plugins/url/plugin.url.js', dependOn: 'BookReader.js' },
       'plugins/plugin.vendor-fullscreen.js': { import: './src/plugins/plugin.vendor-fullscreen.js', dependOn: 'BookReader.js' },
       'bookreader-component-bundle.js': { import: './src/BookReaderComponent/BookReaderComponent.js', dependOn: 'BookReader.js' }
     },

package/src/BookNavigator/assets/book-loader.js

@@ -1,27 +0,0 @@
-import { html } from 'lit-element';
-
-export default html`
-  <svg
-    height="100"
-    viewBox="0 0 100 100"
-    width="100"
-    xmlns="http://www.w3.org/2000/svg"
-    aria-labelledby="bookreader-loading"
-  >
-    <title id="bookreader-loading">Currently loading viewer.</title>
-    <desc>Please wait while we load book reader.</desc>
-    <g fill="#333" fill-rule="evenodd" class="book-icon">
-      <g transform="matrix(1 0 0 -1 28 67.362264)">
-        <path d="m44.71698 31.6981124v-29.99320678s-18.0956599.30735848-18.6322637-.7171698c-.0633962-.12226414-1.890566-.59207545-2.9745282-.59207545-1.3228302 0-3.5122641 0-4.1286791.74547168-.9707547 1.17452827-18.82811278.71660375-18.82811278.71660375v30.040754l1.83849052.7867924.29094339-28.48188608s15.94981097.15339622 17.09094297-1.10716978c.8145283-.90056602 4.997547-.91641507 5.3450942-.3526415.9611321 1.55716977 14.7101883 1.31716978 17.6077354 1.45981128l.3266038 28.22830118z"/>
-        <path d="m40.1129424 33.5957539h-12.8337733c-1.8690565 0-3.1098112-.7545283-3.9299999-1.6279245v-26.70452764l1.2362264-.00792453c.4584906.72962262 3.0922641 1.39415091 3.0922641 1.39415091h10.1298111s1.0381131.01754717 1.5141509.47377357c.5643396.54056602.7913207 1.36981129.7913207 1.36981129z"/>
-        <path d="m17.3354713 33.5957539h-12.8337733v-25.37660316s0-.75283017.49358489-1.14113205c.52867924-.41433961 1.3415094-.42849055 1.3415094-.42849055h10.59905631s2.2075471-.52698112 3.0928301-1.39415091l1.2.00792453v26.74245214c-.8201886.8581132-2.0530188 1.59-3.8932074 1.59"/>
-      </g>
-      <path
-        class="ring"
-        d="m17.8618849 11.6970233c18.5864635-15.59603144 45.6875867-15.59603102 64.2740497.000001 1.9271446 1.6170806 2.1785128 4.4902567.5614466 6.4174186-1.6170661 1.9271618-4.4902166 2.1785323-6.4173612.5614517-15.1996922-12.75416882-37.3625282-12.75416916-52.5622206-.000001-15.19969387 12.7541707-19.04823077 34.5805019-9.1273354 51.7641499 9.9208955 17.183646 30.7471499 24.7638499 49.3923323 17.9774983 18.6451823-6.7863521 29.7266014-25.9801026 26.2811129-45.5206248-.436848-2.4775114 1.2174186-4.8400696 3.6949079-5.2769215 2.4774893-.4368518 4.8400264 1.2174296 5.2768744 3.694941 4.2132065 23.8945096-9.3373563 47.3649806-32.137028 55.6634567-22.799672 8.2984758-48.2663986-.9707372-60.39785211-21.9832155-12.1314534-21.012481-7.42539173-47.7021198 11.16107351-63.2981544z"
-        fill-rule="nonzero"
-      />
-    </g>
-  </svg>
-`;
-