@internetarchive/bookreader 5.0.0-50 → 5.0.0-52

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 5.0.0-52
+# 5.0.0-51
+- Fix: Bookmark with subfiles was broken @nsharma123
+- Feature: Default 1up mode and options.defaults mode override exiting mode @nsharma123
+
 # 5.0.0-50
 Fix: Search results display @latonv
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/bookreader",
-  "version": "5.0.0-50",
+  "version": "5.0.0-52",
   "description": "The Internet Archive BookReader.",
   "repository": {
     "type": "git",

package/src/BookNavigator/bookmarks/ia-bookmarks.js

@@ -137,7 +137,7 @@ class IABookmarks extends LitElement {
   }
 
   setup() {
-    this.api.identifier = this.bookreader.bookId;
+    this.api.identifier = this.getIdentifier();
     if (this.displayMode === 'login') {
       return;
     }
@@ -145,6 +145,19 @@ class IABookmarks extends LitElement {
     this.setBREventListeners();
   }
 
+  /**
+   * get identifier for current book including sub-files
+   *
+   * @returns Identifer
+   */
+  getIdentifier() {
+    if (this.bookreader.bookId !== this.bookreader.subPrefix) {
+      return `${this.bookreader.bookId}/${this.bookreader.subPrefix}`;
+    }
+
+    return this.bookreader.bookId;
+  }
+
   updateDisplay() {
     if (this.displayMode === 'bookmarks') {
       this.fetchUserBookmarks();

package/src/BookReader.js

@@ -455,16 +455,18 @@ BookReader.prototype.readQueryString = function() {
  * @return {number} the mode
  */
 BookReader.prototype.getInitialMode = function(params) {
-  // Use params or browser width to set view mode
-  const windowWidth = $(window).width();
   let nextMode;
+
+  // if mobile breakpoint, we always show this.constMode1up mode
+  const ifMobileBreakpoint = () => {
+    // Use params or browser width to set view mode
+    const windowWidth = $(window).width();
+    return windowWidth && windowWidth <= this.onePageMinBreakpoint;
+  };
   if ('undefined' != typeof(params.mode)) {
     nextMode = params.mode;
-  } else if (this.ui == 'full'
-          && this.isFullscreenActive
-          && windowWidth <= this.onePageMinBreakpoint
-  ) {
-    // In full mode, we set the default based on width
+  } else if ((this.ui == 'full' && this.isFullscreenActive) || ifMobileBreakpoint()) {
+    // In full mode OR device width, we set the default based on width
     nextMode = this.constMode1up;
   } else {
     nextMode = this.constMode2up;
@@ -473,6 +475,36 @@ BookReader.prototype.getInitialMode = function(params) {
   if (!this.canSwitchToMode(nextMode)) {
     nextMode = this.constMode1up;
   }
+
+  // override defaults mode via `options.defaults` metadata
+  if (this.options.defaults) {
+    nextMode = this.overridesBookMode();
+  }
+
+  return nextMode;
+};
+
+/**
+ * Overrides book mode using options.defaults param
+ * @return {number} the mode
+ */
+BookReader.prototype.overridesBookMode = function() {
+  let nextMode = 2; // set default 2 (mode/2up)
+
+  switch (this.options.defaults) {
+  case 'mode/1up':
+    nextMode = this.constMode1up;
+    break;
+  case 'mode/2up':
+    nextMode = this.constMode2up;
+    break;
+  case 'mode/thumb':
+    nextMode = this.constModeThumb;
+    break;
+  default:
+    break;
+  }
+
   return nextMode;
 };
 

package/src/plugins/tts/WebTTSEngine.js

@@ -71,7 +71,22 @@ export default class WebTTSEngine extends AbstractTTSEngine {
   }
 
   /** @override */
-  getVoices() { return speechSynthesis.getVoices(); }
+  getVoices() {
+    const voices = speechSynthesis.getVoices();
+    if (voices.filter(v => v.default).length != 1) {
+      // iOS bug where the default system voice is sometimes
+      // missing from the list
+      voices.unshift({
+        voiceURI: 'bookreader.SystemDefault',
+        name: 'System Default',
+        // Not necessarily true, but very likely
+        lang: navigator.language,
+        default: true,
+        localService: true,
+      });
+    }
+    return voices;
+  }
 
   /** @override */
   createSound(chunk) {
@@ -122,7 +137,11 @@ export class WebTTSSound {
     this.started = false;
 
     this.utterance = new SpeechSynthesisUtterance(this.text.slice(this._charIndex));
-    this.utterance.voice = this.voice;
+    // iOS bug where the default system voice is sometimes
+    // missing from the list
+    if (this.voice?.voiceURI !== 'bookreader.SystemDefault') {
+      this.utterance.voice = this.voice;
+    }
     // Need to also set lang (for some reason); won't set voice on Chrome@Android otherwise
     if (this.voice) this.utterance.lang = this.voice.lang;
     this.utterance.rate = this.rate;

package/tests/jest/BookReader.test.js

@@ -279,4 +279,35 @@ describe('nextReduce', () => {
       expect(nextReduce(2, 'auto', SAMPLE_FACTORS).reduce).toBe(0.5);
     });
   });
+
+  describe('Override book page mode using options.default param', () => {
+    test('replace current mode with options.default is set mode/1up', () => {
+      br.options.defaults = 'mode/1up';
+
+      const nextModeNumber = br.overridesBookMode();
+      expect(nextModeNumber).toBe(1);
+    });
+
+    test('replace current mode with options.default is set mode/2up', () => {
+      br.options.defaults = 'mode/2up';
+
+      const nextModeNumber = br.overridesBookMode();
+      expect(nextModeNumber).toBe(2);
+    });
+
+    test('replace current mode with options.default is set mode/thumb', () => {
+      br.options.defaults = 'mode/thumb';
+
+      const nextModeNumber = br.overridesBookMode();
+      expect(nextModeNumber).toBe(3);
+    });
+
+    test('test if options.default is NOT set', () => {
+      br.options.defaults = null;
+
+      // use mode/2up as default when no options.default metadata found
+      const nextModeNumber = br.overridesBookMode();
+      expect(nextModeNumber).toBe(2);
+    });
+  });
 });

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

@@ -1,5 +1,5 @@
 import sinon from 'sinon';
-import { WebTTSSound } from '@/src/plugins/tts/WebTTSEngine.js';
+import WebTTSEngine, { WebTTSSound } from '@/src/plugins/tts/WebTTSEngine.js';
 import { afterEventLoop, eventTargetMixin } from '../../utils.js';
 
 beforeEach(() => {
@@ -8,6 +8,7 @@ beforeEach(() => {
     speak: sinon.stub(),
     pause: sinon.stub(),
     resume: sinon.stub(),
+
     ...eventTargetMixin(),
   };
   window.SpeechSynthesisUtterance = function (text) {
@@ -21,6 +22,51 @@ afterEach(() => {
   delete window.SpeechSynthesisUtterance;
 });
 
+describe('WebTTSEngine', () => {
+  test('getVoices should include default voice when no actual default', () => {
+    // iOS devices set all the voices to default -_-
+    speechSynthesis.getVoices = () => [
+      {
+        default: true,
+        lang: "ar-001",
+        localService: true,
+        name: "Majed",
+        voiceURI: "com.apple.voice.compact.ar-001.Maged",
+      },
+      {
+        default: true,
+        lang: "bg-BG",
+        localService: true,
+        name: "Daria",
+        voiceURI: "com.apple.voice.compact.bg-BG.Daria",
+      }
+    ];
+    const voices = WebTTSEngine.prototype.getVoices();
+    expect(voices.length).toBe(3);
+    expect(voices[0].voiceURI).toBe('bookreader.SystemDefault');
+  });
+
+  test('getVoices should not include default voice when there is a default', () => {
+    speechSynthesis.getVoices = () => [
+      {
+        default: true,
+        lang: "ar-001",
+        localService: true,
+        name: "Majed",
+        voiceURI: "com.apple.voice.compact.ar-001.Maged",
+      },
+      {
+        default: false,
+        lang: "bg-BG",
+        localService: true,
+        name: "Daria",
+        voiceURI: "com.apple.voice.compact.bg-BG.Daria",
+      }
+    ];
+    const voices = WebTTSEngine.prototype.getVoices();
+    expect(voices.length).toBe(2);
+  });
+});
 
 describe('WebTTSSound', () => {
   describe('setPlaybackRate', () => {