Merge pull request #1376 from cdrini/refactor/tts-br-plugin

 Migrate TtsPlugin to BookReaderPlugin

Author: cdrini

codecov.yml

@@ -5,7 +5,7 @@ codecov:
     project:
       default:
         # Allow small drops in coverage
-        threshold: 0.005  # .5 %
+        threshold: 0.5  # 0.5%
         if_not_found: failure
 
 coverage:

src/BookReader.js

@@ -74,6 +74,8 @@ BookReader.PLUGINS = {
   resume: null,
   /** @type {typeof import('./plugins/plugin.text_selection.js').TextSelectionPlugin | null}*/
   textSelection: null,
+  /** @type {typeof import('./plugins/tts/plugin.tts.js').TtsPlugin | null}*/
+  tts: null,
 };
 
 /**
@@ -264,6 +266,7 @@ BookReader.prototype.setup = function(options) {
     autoplay: BookReader.PLUGINS.autoplay ? new BookReader.PLUGINS.autoplay(this) : null,
     resume: BookReader.PLUGINS.resume ? new BookReader.PLUGINS.resume(this) : null,
     textSelection: BookReader.PLUGINS.textSelection ? new BookReader.PLUGINS.textSelection(this) : null,
+    tts: BookReader.PLUGINS.tts ? new BookReader.PLUGINS.tts(this) : null,
   };
 
   // Delete anything that's null
@@ -590,7 +593,12 @@ BookReader.prototype.init = function() {
     this.initToolbar(this.mode, this.ui); // Build inside of toolbar div
   }
   if (this.options.showNavbar) { // default navigation
-    this.initNavbar();
+    const $navBar = this.initNavbar();
+
+    // extend navbar with plugins
+    for (const plugin of Object.values(this._plugins)) {
+      plugin.extendNavBar($navBar);
+    }
   }
 
   // Switch navbar controls on mobile/desktop

src/BookReader/options.js

@@ -149,6 +149,8 @@ export const DEFAULT_OPTIONS = {
     resume: null,
     /** @type {import('../plugins/plugin.text_selection.js').TextSelectionPlugin['options']} */
     textSelection: null,
+    /** @type {import('../plugins/tts/plugin.tts.js').TtsPlugin['options']} */
+    tts: null,
   },
 
   /**

src/BookReaderPlugin.js

@@ -36,4 +36,9 @@ export class BookReaderPlugin {
 
   /** @abstract @protected */
   _bindNavigationHandlers() {}
+
+  /**
+   * @param {JQuery<HTMLElement>} $navBar
+   */
+  extendNavBar($navBar) {}
 }

src/plugins/tts/AbstractTTSEngine.js

@@ -6,8 +6,7 @@ import { hasLocalStorage } from './utils.js';
 /**
  * @export
  * @typedef {Object} TTSEngineOptions
- * @property {String} server
- * @property {String} bookPath
+ * @property {import('@/src/util/strings.js').StringWithVars} pageChunkUrl
  * @property {ISO6391} bookLanguage
  * @property {Function} onLoadingStart
  * @property {Function} onLoadingComplete
@@ -85,8 +84,7 @@ export default class AbstractTTSEngine {
     this.opts.onLoadingStart();
 
     this._chunkIterator = new PageChunkIterator(numLeafs, leafIndex, {
-      server: this.opts.server,
-      bookPath: this.opts.bookPath,
+      pageChunkUrl: this.opts.pageChunkUrl,
       pageBufferSize: 5,
     });
 

src/plugins/tts/PageChunk.js

@@ -1,3 +1,5 @@
+import { applyVariables } from "../../util/strings.js";
+
 /**
  * Class to manage a 'chunk' (approximately a paragraph) of text on a page.
  */
@@ -16,24 +18,18 @@ export default class PageChunk {
   }
 
   /**
-   * @param {string} server
-   * @param {string} bookPath
+   * @param {import('@/src/util/strings.js').StringWithVars} pageChunkUrl
    * @param {number} leafIndex
    * @return {Promise<PageChunk[]>}
    */
-  static async fetch(server, bookPath, leafIndex) {
+  static async fetch(pageChunkUrl, leafIndex) {
     const chunks = await $.ajax({
       type: 'GET',
-      url: `https://${server}/BookReader/BookReaderGetTextWrapper.php`,
+      url: applyVariables(pageChunkUrl, { pageIndex: leafIndex }),
       cache: true,
       xhrFields: {
         withCredentials: window.br.protected,
       },
-      data: {
-        path: `${bookPath}_djvu.xml`,
-        page: leafIndex,
-        callback: 'false',
-      },
     });
     return PageChunk._fromTextWrapperResponse(leafIndex, chunks);
   }

src/plugins/tts/PageChunkIterator.js

@@ -138,22 +138,20 @@ export default class PageChunkIterator {
    * @param {number} index
    */
   _fetchPageChunksDirect(index) {
-    return PageChunk.fetch(this.opts.server, this.opts.bookPath, index);
+    return PageChunk.fetch(this.opts.pageChunkUrl, index);
   }
 }
 
 PageChunkIterator.AT_END = "__PageChunkIterator.AT_END__";
 
 /** @type {PageChunkIteratorOptions} */
 const DEFAULT_OPTS = {
-  server: null,
-  bookPath: null,
+  pageChunkUrl: null,
   pageBufferSize: 2,
 };
 
 /**
  * @typedef {Object} PageChunkIteratorOptions
- * @property {string} server
- * @property {string} bookPath
+ * @property {import('@/src/util/strings.js').StringWithVars} pageChunkUrl
  * @property {number} [pageBufferSize] number of pages to buffer before/after the current page
  */