@internetarchive/bookreader 5.0.0-70-a2 → 5.0.0-71

package/src/BookNavigator/{volumes/volumes-provider.js → viewable-files.js}

@@ -1,7 +1,7 @@
 import { html } from 'lit';
 
-import { viewableFilesIcon  } from '@internetarchive/ia-item-navigator';
-import '@internetarchive/ia-item-navigator';
+import { viewableFilesIcon  } from '@internetarchive/ia-item-navigator/dist/src/menus/viewable-files';
+import '@internetarchive/ia-item-navigator/dist/src/menus/viewable-files';
 
 /**
  * * @typedef { 'title_asc' | 'title_desc' | 'default'} SortTypesT
@@ -11,12 +11,12 @@ const sortTypes = {
   title_desc: 'title_desc',
   default: 'default'
 };
-export default class VolumesProvider {
+export default class ViewableFilesProvider {
   /**
-   * @param {import('../../BookReader').default} bookreader
+   * @param {import('../BookReader').default} bookreader
    */
   constructor({ baseHost, bookreader, onProviderChange }) {
-    /** @type {import('../../BookReader').default} */
+    /** @type {import('../BookReader').default} */
     this.bookreader = bookreader;
     this.onProviderChange = onProviderChange;
     this.baseHost = baseHost;
@@ -30,13 +30,13 @@ export default class VolumesProvider {
     this.icon = html`${viewableFilesIcon}`;
     this.sortOrderBy = sortTypes.default;
 
-    this.component = document.createElement("iaux-viewable-files");
+    this.component = document.createElement("iaux-in-viewable-files-panel");
     this.component.addSortToUrl = true;
     this.component.subPrefix = bookreader.options.subPrefix || "";
     this.component.baseHost = baseHost;
     this.component.fileList = [...this.viewableFiles];
 
-    this.sortFilesComponent = document.createElement("iaux-sort-viewable-files");
+    this.sortFilesComponent = document.createElement("iaux-in-sort-files-button");
     this.sortFilesComponent.fileListRaw = this.viewableFiles;
     this.sortFilesComponent.addEventListener('fileListSorted', (e) => this.handleFileListSorted(e));
     this.actionButton = this.sortFilesComponent;

package/src/BookReader.js

@@ -1788,7 +1788,7 @@ BookReader.prototype.paramsFromFragment = function(fragment) {
   // Index and page
   if ('undefined' != typeof(urlHash['page'])) {
     // page was set -- may not be int
-    params.page = urlHash['page'];
+    params.page = decodeURIComponent(urlHash['page']);
   }
 
   // $$$ process /region
@@ -1820,11 +1820,10 @@ BookReader.prototype.paramsFromFragment = function(fragment) {
  * @return {string}
  */
 BookReader.prototype.fragmentFromParams = function(params, urlMode = 'hash') {
-  const separator = '/';
   const fragments = [];
 
   if ('undefined' != typeof(params.page)) {
-    fragments.push('page', params.page);
+    fragments.push('page', encodeURIComponent(params.page));
   } else {
     if ('undefined' != typeof(params.index)) {
       // Don't have page numbering but we do have the index
@@ -1850,10 +1849,10 @@ BookReader.prototype.fragmentFromParams = function(params, urlMode = 'hash') {
 
   // search
   if (params.search && urlMode === 'hash') {
-    fragments.push('search', params.search);
+    fragments.push('search', utils.encodeURIComponentPlus(params.search));
   }
 
-  return utils.encodeURIComponentPlus(fragments.join(separator)).replace(/%2F/g, '/');
+  return fragments.join('/');
 };
 
 /**

package/src/ia-bookreader/ia-bookreader.js

@@ -30,7 +30,7 @@ export class IaBookReader extends LitElement {
     super();
     this.item = undefined;
     this.bookreader = undefined;
-    this.baseHost = 'https://archive.org';
+    this.baseHost = 'archive.org';
     this.fullscreen = false;
     this.signedIn = false;
     /** @type {ModalManager} */

package/src/plugins/tts/AbstractTTSEngine.js

@@ -142,6 +142,10 @@ export default class AbstractTTSEngine {
     // MS Edge fires voices changed randomly very often
     this.events.off('voiceschanged', this.updateBestVoice);
     this.voice = this.getVoices().find(voice => voice.voiceURI === voiceURI);
+    // if the current book has a language set, store the selected voice with the book language as a suffix
+    if (this.opts.bookLanguage) {
+      localStorage.setItem(`BRtts-voice-${this.opts.bookLanguage}`, this.voice.voiceURI);
+    }
     if (this.activeSound) this.activeSound.setVoice(this.voice);
   }
 
@@ -221,10 +225,12 @@ export default class AbstractTTSEngine {
     // user languages that match the book language
     const matchingUserLangs = userLanguages.filter(lang => lang.startsWith(bookLanguage));
 
-    // Try to find voices that intersect these two sets
-    return AbstractTTSEngine.getMatchingVoice(matchingUserLangs, bookLangVoices) ||
+    // First try to find the last chosen voice from localStorage for the current book language
+    return AbstractTTSEngine.getMatchingStoredVoice(bookLangVoices, bookLanguage)
+        // Try to find voices that intersect these two sets
+        || AbstractTTSEngine.getMatchingVoice(matchingUserLangs, bookLangVoices)
         // no user languages match the books; let's return the best voice for the book language
-        (bookLangVoices.find(v => v.default) || bookLangVoices[0])
+        || (bookLangVoices.find(v => v.default) || bookLangVoices[0])
         // No voices match the book language? let's find a voice in the user's language
         // and ignore book lang
         || AbstractTTSEngine.getMatchingVoice(userLanguages, voices)
@@ -232,6 +238,19 @@ export default class AbstractTTSEngine {
         || (voices.find(v => v.default) || voices[0]);
   }
 
+  /**
+   * @private
+   * Get the voice last selected by the user for the book language from localStorage.
+   * Returns undefined if no voice is stored or found.
+   * @param {SpeechSynthesisVoice[]} voices  browser voices to choose from
+   * @param {ISO6391} bookLanguage  book language to look for
+   * @return {SpeechSynthesisVoice | undefined}
+   */
+  static getMatchingStoredVoice(voices, bookLanguage) {
+    const storedVoice = localStorage.getItem(`BRtts-voice-${bookLanguage}`);
+    return (storedVoice ? voices.find(v => v.voiceURI === storedVoice) : undefined);
+  }
+
   /**
      * @private
      * Get the best voice that matches one of the BCP47 languages (order by preference)

package/src/plugins/url/UrlPlugin.js

@@ -45,7 +45,7 @@ export class UrlPlugin {
 
     const strPathParams = this.urlSchema
       .filter(s => s.position == 'path')
-      .map(schema => pathParams[schema.name] ? `${schema.name}/${pathParams[schema.name]}` : '')
+      .map(schema => pathParams[schema.name] ? `${schema.name}/${encodeURIComponent(pathParams[schema.name])}` : '')
       .join('/');
 
     // replace consecutive slashes with a single slash + remove trailing slashes
@@ -83,15 +83,13 @@ export class UrlPlugin {
         const hasPropertyKey = doesKeyExists(urlStrSplitSlashObj, schema.name);
         const hasDeprecatedKey = doesKeyExists(schema, 'deprecated_for') && hasPropertyKey;
 
-        if (hasDeprecatedKey) {
-          urlState[schema.deprecated_for] = urlStrSplitSlashObj[schema.name];
+        // Not in the URL
+        if (!hasPropertyKey && !hasDeprecatedKey) {
           return;
         }
 
-        if (hasPropertyKey) {
-          urlState[schema.name] = urlStrSplitSlashObj[schema.name];
-          return;
-        }
+        const urlStateParam = hasDeprecatedKey ? schema.deprecated_for : schema.name;
+        urlState[urlStateParam] = decodeURIComponent(urlStrSplitSlashObj[schema.name]);
       });
 
     // Add searchParams to urlState

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

@@ -9,7 +9,7 @@ import DownloadsProvider from '@/src/BookNavigator/downloads/downloads-provider.
 import SearchProvider from '@/src/BookNavigator/search/search-provider.js';
 import SharingProvider from '@/src/BookNavigator/sharing.js';
 import VisualAdjustmentsProvider from '@/src/BookNavigator/visual-adjustments/visual-adjustments-provider.js';
-import VolumesProvider from '@/src/BookNavigator/volumes/volumes-provider.js';
+import ViewableFilesProvider from '@/src/BookNavigator/viewable-files.js';
 import { ModalManager } from '@internetarchive/modal-manager';
 import { SharedResizeObserver } from '@internetarchive/shared-resize-observer';
 import '@/src/BookNavigator/book-navigator.js';
@@ -214,7 +214,7 @@ describe('<book-navigator>', () => {
           await el.elementUpdated;
 
           expect(el.menuProviders.volumes).toBeDefined();
-          expect(el.menuProviders.volumes).toBeInstanceOf(VolumesProvider);
+          expect(el.menuProviders.volumes).toBeInstanceOf(ViewableFilesProvider);
 
           // also adds a menu shortcut
           expect(el.menuShortcuts.find(m => m.id === 'volumes')).toBeDefined();

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

@@ -30,7 +30,7 @@ describe('Sharing Provider', () => {
     expect(provider.id).toEqual('share');
     expect(provider.icon).toBeDefined();
     expect(provider.label).toEqual('Share this book');
-    expect(fixtureSync(provider.component).tagName).toContain('IAUX-SHARING-OPTIONS');
+    expect(fixtureSync(provider.component).tagName).toContain('IAUX-IN-SHARE-PANEL');
   });
 
   describe('Handles being a sub file/volume', () => {

package/tests/jest/BookNavigator/{volumes/volumes-provider.test.js → viewable-files/viewable-files-provider.test.js}

@@ -1,6 +1,6 @@
 import { fixtureCleanup, fixtureSync } from '@open-wc/testing-helpers';
 import sinon from 'sinon';
-import volumesProvider from '@/src/BookNavigator/volumes/volumes-provider';
+import ViewableFilesProvider from '@/src/BookNavigator/viewable-files';
 
 const brOptions = {
   "options": {
@@ -44,7 +44,7 @@ describe('Volumes Provider', () => {
     const onProviderChange = sinon.fake();
 
     const baseHost = "https://archive.org";
-    const provider = new volumesProvider({
+    const provider = new ViewableFilesProvider({
       baseHost,
       bookreader: brOptions,
       onProviderChange

package/tests/jest/plugins/tts/AbstractTTSEngine.test.js

@@ -111,6 +111,26 @@ for (const dummyVoice of [dummyVoiceHyphens, dummyVoiceUnderscores]) {
 
       expect(getBestBookVoice(voices, 'en', ['en-CA', 'en'])).toBe(voices[0]);
     });
+
+    test('choose stored language from localStorage', () => {
+      const voices = [
+        dummyVoice({lang: "en-US", voiceURI: "English US", default: true}),
+        dummyVoice({lang: "en-GB", voiceURI: "English GB"}),
+        dummyVoice({lang: "en-CA", voiceURI: "English CA"}),
+      ];
+      class DummyEngine extends AbstractTTSEngine {
+        getVoices() { return voices; }
+      }
+      const ttsEngine = new DummyEngine({...DUMMY_TTS_ENGINE_OPTS, bookLanguage: 'en'});
+      // simulates setting default voice on tts startup
+      ttsEngine.updateBestVoice();
+      // simulates user choosing a voice that matches the bookLanguage
+      // voice will be stored in localStorage
+      ttsEngine.setVoice(voices[2].voiceURI);
+
+      // expecting the voice to be selected by getMatchingStoredVoice and returned as best voice
+      expect(getBestBookVoice(voices, 'en', [])).toBe(voices[2]);
+    });
   });
 }
 

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

@@ -19,6 +19,10 @@ describe('UrlPlugin tests', () => {
       expect(urlPlugin.urlStateToUrlString(urlStateWithQueries)).toBe(expectedUrlFromStateWithQueries);
     });
 
+    test('encodes page number', () => {
+      expect(urlPlugin.urlStateToUrlString({ page: '12/46' })).toBe(`page/12%2F46`);
+    });
+
     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' };
@@ -47,6 +51,10 @@ describe('UrlPlugin tests', () => {
       expect(urlPlugin.urlStringToUrlState(url1)).toEqual({page: 'n7', mode: '1up'});
     });
 
+    test('decodes page number', () => {
+      expect(urlPlugin.urlStringToUrlState('/page/12%2F46')).toStrictEqual({ page: '12/46' });
+    });
+
     test('urlStringToUrlState with deprecated_for', () => {
       const url = '/page/n7/mode/2up/search/hello';