@internetarchive/bookreader 5.0.0-51 → 5.0.0-52

package/CHANGELOG.md

@@ -1,6 +1,7 @@
+# 5.0.0-52
 # 5.0.0-51
-- Fix: Bookmark with subfiles was broken
-- Feature: Default 1up mode and options.defaults mode override exiting mode
+- 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-51",
+  "version": "5.0.0-52",
   "description": "The Internet Archive BookReader.",
   "repository": {
     "type": "git",

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/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', () => {