@internetarchive/bookreader 5.0.0-91 → 5.0.0-92

package/src/plugins/search/view.js

@@ -1,13 +1,17 @@
+// @ts-check
+/** @typedef {import('@/src/BookReader.js').default} BookReader */
+
 class SearchView {
   /**
    * @param {object} params
-   * @param {object} params.br The BookReader instance
-   * @param {function} params.cancelSearch callback when a user wants to cancel search
+   * @param {BookReader} params.br The BookReader instance
+   * @param {function} params.searchCancelledCallback callback when a user wants to cancel search
    *
    * @event BookReader:SearchResultsCleared - when the search results nav gets cleared
    * @event BookReader:ToggleSearchMenu - when search results menu should toggle
    */
   constructor({ br, searchCancelledCallback = () => {} }) {
+    /** @type {BookReader} */
     this.br = br;
     this.matches = [];
     this.cacheDOMElements();
@@ -40,7 +44,7 @@ class SearchView {
   }
 
   clearSearchFieldAndResults(dispatchEventWhenComplete = true) {
-    this.br.removeSearchResults();
+    this.br._plugins.search.removeSearchResults();
     this.removeResultPins();
     this.emptyMatches();
     this.setQuery('');
@@ -269,15 +273,15 @@ class SearchView {
           $(event.target).addClass('front');
         })
         .on("mouseleave", (event) => $(event.target).removeClass('front'))
-        .on("click", () => { this.br._searchPluginGoToResult(match.matchIndex); });
+        .on("click", () => { this.br._plugins.search.jumpToMatch(match.matchIndex); });
     });
   }
 
   /**
-   * @param {boolean} bool
+   * @param {boolean} show
    */
-  toggleSearchPending(bool) {
-    if (bool) {
+  toggleSearchPending(show = false) {
+    if (show) {
       this.br.showProgressPopup("Search results will appear below...", () => this.progressPopupClosed());
     }
     else {
@@ -375,11 +379,11 @@ class SearchView {
 
   handleSearchStarted() {
     this.emptyMatches();
-    this.br.removeSearchHilites();
+    this.br._plugins.search.removeSearchHilites();
     this.removeResultPins();
     this.toggleSearchPending(true);
     this.teardownSearchNavigation();
-    this.setQuery(this.br.searchTerm);
+    this.setQuery(this.br._plugins.search.searchTerm);
   }
 
   /**

package/tests/e2e/helpers/mockSearch.js

@@ -2,7 +2,7 @@ export const TEST_TEXT_FOUND = 'theory';
 export const TEST_TEXT_NOT_FOUND = 'HopefullyNotFoundLongWord';
 export const PAGE_FIRST_RESULT = 30;
 
-export const SEARCH_INSIDE_URL_RE  = /https:\/\/ia[0-9]+\.us\.archive\.org\/fulltext\/inside\.php\?item_id=.*/;
+export const SEARCH_INSIDE_URL_RE  = /\/fulltext\/inside\.php/;
 
 /** Mock response for a matching search term. */
 export function mockResponseFound(req, res) {

package/tests/jest/BookNavigator/book-navigator.test.js

@@ -164,14 +164,20 @@ describe('<book-navigator>', () => {
         expect(el.menuProviders.visualAdjustments).toBeInstanceOf(VisualAdjustmentsProvider);
       });
       describe('Loading Sub Menus By Plugin Flags', () => {
-        test('Search: uses `enableSearch` flag', async() => {
+        test('Search: uses `enabled` flag', async() => {
           const el = fixtureSync(container());
           const $brContainer = document.createElement('div');
           const brStub = {
             resize: sinon.fake(),
             currentIndex: sinon.fake(),
             jumpToIndex: sinon.fake(),
-            options: { enableSearch: true },
+            options: {
+              plugins: {
+                search: {
+                  enabled: true,
+                },
+              },
+            },
             refs: {
               $brContainer,
             },
@@ -346,7 +352,6 @@ describe('<book-navigator>', () => {
 
             let sidePanelConfig = {};
             el.addEventListener('updateSideMenu', (e) => {
-              console.log();
               sidePanelConfig = e.detail;
             });
             const toggleSearchMenuEvent = new Event('BookReader:ToggleSearchMenu');

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

@@ -88,7 +88,11 @@ describe('Search Provider', () => {
         onProviderChange: sinon.fake(),
         bookreader: {
           leafNumToIndex: sinon.fake(),
-          _searchPluginGoToResult: sinon.fake(),
+          _plugins: {
+            search: {
+              jumpToMatch: sinon.fake(),
+            },
+          },
         },
       });
 
@@ -100,7 +104,7 @@ describe('Search Provider', () => {
           { detail: searchResultStub }),
       );
 
-      expect(provider.bookreader._searchPluginGoToResult.callCount).toEqual(1);
+      expect(provider.bookreader._plugins.search.jumpToMatch.callCount).toEqual(1);
     });
     test('update url when search is cancelled or input cleared', async() => {
       const urlPluginMock = {
@@ -111,7 +115,11 @@ describe('Search Provider', () => {
         onProviderChange: sinon.fake(),
         bookreader: {
           leafNumToIndex: sinon.fake(),
-          _searchPluginGoToResult: sinon.fake(),
+          _plugins: {
+            search: {
+              jumpToMatch: sinon.fake(),
+            },
+          },
           urlPlugin: urlPluginMock,
         },
       });
@@ -145,7 +153,11 @@ describe('Search Provider', () => {
         onProviderChange: sinon.fake(),
         bookreader: {
           leafNumToIndex: sinon.fake(),
-          _searchPluginGoToResult: sinon.fake(),
+          _plugins: {
+            search: {
+              jumpToMatch: sinon.fake(),
+            },
+          },
           urlPlugin: urlPluginMock,
           search: sinon.fake(),
         },

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

@@ -39,7 +39,7 @@ describe('Sharing Provider', () => {
         item,
         baseHost,
         bookreader: {
-          options: { subPrefix },
+          subPrefix,
         },
       });
 

package/tests/jest/BookReader.test.js

@@ -7,7 +7,12 @@ import '@/src/plugins/url/plugin.url.js';
 let br;
 beforeAll(() => {
   document.body.innerHTML = '<div id="BookReader">';
-  br = new BookReader();
+  br = new BookReader({
+    server: '',
+    bookId: '',
+    subPrefix: '',
+    bookPath: '',
+  });
 });
 
 afterEach(() => {
@@ -91,6 +96,26 @@ test('calls switchMode with init option when init called', () => {
     .toHaveProperty('init', true);
 });
 
+test('has added BR property: server', () => {
+  expect(br).toHaveProperty('server');
+  expect(br.server).toBeDefined();
+});
+
+test('has added BR property: bookId', () => {
+  expect(br).toHaveProperty('bookId');
+  expect(br.bookId).toBeDefined();
+});
+
+test('has added BR property: subPrefix', () => {
+  expect(br).toHaveProperty('subPrefix');
+  expect(br.subPrefix).toBeDefined();
+});
+
+test('has added BR property: bookPath', () => {
+  expect(br).toHaveProperty('bookPath');
+  expect(br.bookPath).toBeDefined();
+});
+
 test('has suppressFragmentChange true when init with no input', () => {
   br._plugins.resume.getResumeValue = jest.fn(() => null);
   br.urlReadFragment = jest.fn(() => '');

package/tests/jest/plugins/search/plugin.search.test.js

@@ -5,6 +5,7 @@ import { DUMMY_RESULTS } from './utils.js';
 
 jest.mock('@/src/plugins/search/view.js');
 
+/** @type {BookReader} */
 let br;
 const namespace = 'BookReader:';
 const triggeredEvents = () => {
@@ -23,10 +24,14 @@ beforeEach(() => {
 
   $.fn.trigger = jest.fn();
   document.body.innerHTML = '<div id="BookReader">';
-  br = new BookReader();
+  br = new BookReader({
+    server: 'foo.bar.com',
+    bookPath: '/13/items/foo/foobar',
+    subPrefix: '/foobar',
+  });
   br.initToolbar = jest.fn();
   br.showProgressPopup = jest.fn();
-  br.searchXHR = jest.fn();
+  br._plugins.search.searchXHR = jest.fn();
 });
 
 afterEach(() => {
@@ -34,54 +39,24 @@ afterEach(() => {
 });
 
 describe('Plugin: Search', () => {
-  test('has option flag', () => {
-    expect(BookReader.defaultOptions.enableSearch).toEqual(true);
-  });
-
-  test('has added BR property: server', () => {
-    expect(br).toHaveProperty('server');
-    expect(br.server).toBeTruthy();
-  });
-
-  test('has added BR property: bookId', () => {
-    expect(br).toHaveProperty('bookId');
-    expect(br.bookId).toBeFalsy();
-  });
-
-  test('has added BR property: subPrefix', () => {
-    expect(br).toHaveProperty('subPrefix');
-    expect(br.subPrefix).toBeFalsy();
-  });
-
-  test('has added BR property: bookPath', () => {
-    expect(br).toHaveProperty('bookPath');
-    expect(br.bookPath).toBeFalsy();
-  });
-
-  test('has added BR property: searchInsideUrl', () => {
-    expect(br).toHaveProperty('searchInsideUrl');
-    expect(br.searchInsideUrl).toBeTruthy();
-  });
-
-  test('has added BR property: initialSearchTerm', () => {
-    expect(br.options).toHaveProperty('initialSearchTerm');
-    expect(br.options.initialSearchTerm).toBeFalsy();
-  });
-
   test('On init, it loads the toolbar', () => {
     br.init();
     expect(br.initToolbar).toHaveBeenCalled();
   });
 
+  test('Constructs SearchView', () => {
+    expect(br._plugins.search.searchView).toBeDefined();
+  });
+
   test('On init, it will run a search if given `options.initialSearchTerm`', () => {
-    br.search = jest.fn();
-    br.options.initialSearchTerm = 'foo';
+    br._plugins.search.search = jest.fn();
+    br.options.plugins.search.initialSearchTerm = 'foo';
     br.init();
 
-    expect(br.search).toHaveBeenCalled();
-    expect(br.search.mock.calls[0][1])
+    expect(br._plugins.search.search).toHaveBeenCalled();
+    expect(br._plugins.search.search.mock.calls[0][1])
       .toHaveProperty('goToFirstResult', true);
-    expect(br.search.mock.calls[0][1])
+    expect(br._plugins.search.search.mock.calls[0][1])
       .toHaveProperty('suppressFragmentChange', false);
   });
 
@@ -100,7 +75,7 @@ describe('Plugin: Search', () => {
   test('SearchStarted event fires and should go to first result', () => {
     br.init();
     br.search('foo', { goToFirstResult: true});
-    expect(br.options.goToFirstResult).toBeTruthy();
+    expect(br._plugins.search.options.goToFirstResult).toBeTruthy();
   });
 
   test('SearchCallback event fires when AJAX search returns results', async () => {

package/tests/jest/plugins/search/plugin.search.view.test.js

@@ -1,9 +1,10 @@
-
+// @ts-check
 import BookReader from '@/src/BookReader.js';
 import '@/src/plugins/search/plugin.search.js';
 import { marshallSearchResults } from '@/src/plugins/search/utils.js';
 import '@/src/plugins/search/view.js';
 
+/** @type {BookReader} */
 let br;
 const namespace = 'BookReader:';
 const results = {
@@ -71,31 +72,22 @@ afterEach(() => {
 });
 
 describe('View: Plugin: Search', () => {
-  test('When search runs, the view gets created.', () => {
-    br.search = jest.fn();
-    br.options.initialSearchTerm = 'foo';
-    br.init();
-
-    expect(br.searchView).toBeDefined();
-    expect(br.searchView.handleSearchCallback).toBeDefined();
-  });
-
   describe("Search results navigation bar", () => {
     test('Search Results callback creates the results nav', () => {
       br.init();
       const event = new CustomEvent(`${namespace}SearchCallback`);
       const options = { goToFirstResult: false };
 
-      expect(br.searchView.dom.searchNavigation).toBeUndefined();
+      expect(br._plugins.search.searchView.dom.searchNavigation).toBeUndefined();
 
-      br.searchView.handleSearchCallback(event, { results, options});
-      expect(br.searchView.dom.searchNavigation).toBeDefined();
+      br._plugins.search.searchView.handleSearchCallback(event, { results, options});
+      expect(br._plugins.search.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._plugins.search.searchView.handleSearchCallback(event, { results, options});
 
       const searchResultsNav = document.querySelector('.BRsearch-navigation');
       expect(searchResultsNav).toBeDefined();
@@ -110,9 +102,9 @@ describe('View: Plugin: Search', () => {
       br.init();
       const event = new CustomEvent(`${namespace}SearchCallback`);
       const options = { goToFirstResult: false };
-      br.searchView.handleSearchCallback(event, { results: resultWithScript, options });
+      br._plugins.search.searchView.handleSearchCallback(event, { results: resultWithScript, options });
 
-      expect(br.searchView.dom.searchNavigation.parent().html()).not.toContain('<script>alert(1);</script>');
+      expect(br._plugins.search.searchView.dom.searchNavigation.parent().html()).not.toContain('<script>alert(1);</script>');
     });
 
     describe('Click events handlers', () => {
@@ -122,7 +114,7 @@ describe('View: Plugin: Search', () => {
         br.trigger = (eventName) => eventNameTriggered = eventName;
 
         expect(eventNameTriggered).toBeFalsy();
-        br.searchView.toggleSidebar();
+        br._plugins.search.searchView.toggleSidebar();
         expect(eventNameTriggered).toEqual('ToggleSearchMenu');
       });
       it('triggers custom event when closing navbar', () => {
@@ -131,7 +123,7 @@ describe('View: Plugin: Search', () => {
         br.trigger = (eventName) => eventNameTriggered = eventName;
 
         expect(eventNameTriggered).toBeFalsy();
-        br.searchView.clearSearchFieldAndResults();
+        br._plugins.search.searchView.clearSearchFieldAndResults();
         expect(eventNameTriggered).toEqual('SearchResultsCleared');
       });
     });

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

@@ -145,7 +145,7 @@ describe('Plugin: URL controller', () => {
       search: 'foo',
     }));
     BookReader.prototype.search = jest.fn();
-    br.options.initialSearchTerm = 'foo';
+    br.options.plugins.search = { initialSearchTerm: 'foo' };
     br.options.urlMode = 'history';
     br.init();
     br.urlUpdateFragment();