@internetarchive/bookreader 5.0.0-28 → 5.0.0-30-a

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,9 +65,13 @@ 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("default");
 
@@ -80,9 +89,13 @@ describe('Volumes Provider', () => {
   });
 
   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);
@@ -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';
+
       const origSortButton = await fixture(provider.sortButton);
       expect(origSortButton.classList.contains('neutral-icon')).to.be.true;
 

package/webpack.config.js

@@ -53,7 +53,7 @@ module.exports = [
       'plugins/plugin.tts.js': { import: './src/plugins/tts/plugin.tts.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' }
+      'ia-bookreader-bundle.js': { import: './src/ia-bookreader/ia-bookreader.js', dependOn: 'BookReader.js' }
     },
 
     externals: {

package/.nvmrc

@@ -1 +0,0 @@
-14