@internetarchive/bookreader 5.0.0-96 → 5.0.0-98

package/src/plugins/plugin.text_selection.js

@@ -3,31 +3,13 @@ import { createDIVPageLayer } from '../BookReader/PageContainer.js';
 import { SelectionObserver } from '../BookReader/utils/SelectionObserver.js';
 import { BookReaderPlugin } from '../BookReaderPlugin.js';
 import { applyVariables } from '../util/strings.js';
+import { Cache } from '../util/cache.js';
+import { toISO6391 } from './tts/utils.js';
 /** @typedef {import('../util/strings.js').StringWithVars} StringWithVars */
 /** @typedef {import('../BookReader/PageContainer.js').PageContainer} PageContainer */
 
 const BookReader = /** @type {typeof import('../BookReader').default} */(window.BookReader);
 
-/**
- * @template T
- */
-export class Cache {
-  constructor(maxSize = 10) {
-    this.maxSize = maxSize;
-    /** @type {T[]} */
-    this.entries = [];
-  }
-
-  /**
-   * @param {T} entry
-   */
-  add(entry) {
-    if (this.entries.length >= this.maxSize) {
-      this.entries.shift();
-    }
-    this.entries.push(entry);
-  }
-}
 
 export class TextSelectionPlugin extends BookReaderPlugin {
   options = {
@@ -327,9 +309,16 @@ export class TextSelectionPlugin extends BookReaderPlugin {
     }
 
     const textLayer = createDIVPageLayer(pageContainer.page, 'BRtextLayer');
+    // Have to wait to make sure the page container is actually rendered,
+    // otherwise width/height are unset after a mode change.
+    await Promise.resolve();
     const ratioW = parseFloat(pageContainer.$container[0].style.width) / pageContainer.page.width;
     const ratioH = parseFloat(pageContainer.$container[0].style.height) / pageContainer.page.height;
     textLayer.style.transform = `scale(${ratioW}, ${ratioH})`;
+    const bookLangCode = toISO6391(this.br.options.bookLanguage);
+    if (bookLangCode) {
+      textLayer.setAttribute("lang", bookLangCode);
+    }
     textLayer.setAttribute("dir", this.rtl ? "rtl" : "ltr");
 
     const ocrParagraphs = $(XMLpage).find("PARAGRAPH[coords]").toArray();
@@ -356,6 +345,10 @@ export class TextSelectionPlugin extends BookReaderPlugin {
     }
     $container.append(textLayer);
     this.stopPageFlip($container);
+    this.br.trigger('textLayerRendered', {
+      pageIndex,
+      pageContainer,
+    });
   }
 
   /**
@@ -365,6 +358,10 @@ export class TextSelectionPlugin extends BookReaderPlugin {
   renderParagraph(ocrParagraph) {
     const paragEl = document.createElement('p');
     paragEl.classList.add('BRparagraphElement');
+    if (ocrParagraph.getAttribute("x-role")) {
+      paragEl.classList.add('ocr-role-header-footer');
+      paragEl.ariaHidden = "true";
+    }
     const [paragLeft, paragBottom, paragRight, paragTop] = $(ocrParagraph).attr("coords").split(",").map(parseFloat);
     const wordHeightArr = [];
     const lines = $(ocrParagraph).find("LINE[coords]").toArray();

package/src/plugins/translate/TranslationManager.js

@@ -0,0 +1,170 @@
+// @ts-check
+import { Cache } from '../../util/cache.js';
+import { BatchTranslator } from '@internetarchive/bergamot-translator/translator.js';
+import { toISO6391 } from '../tts/utils.js';
+
+export const langs = /** @type {{[lang: string]: string}} */ {
+  "bg": "Bulgarian",
+  "ca": "Catalan",
+  "cs": "Czech",
+  "nl": "Dutch",
+  "en": "English",
+  "et": "Estonian",
+  "de": "German",
+  "fr": "French",
+  "is": "Icelandic",
+  "it": "Italian",
+  "nb": "Norwegian Bokmål",
+  "nn": "Norwegian Nynorsk",
+  "fa": "Persian",
+  "pl": "Polish",
+  "pt": "Portuguese",
+  "ru": "Russian",
+  "es": "Spanish",
+  "uk": "Ukrainian",
+};
+
+export class TranslationManager {
+  /** @type {Cache<{index: string, response: string}>} */
+  alreadyTranslated = new Cache(100);
+
+  /**
+  * @typedef {Object} genericModelInfo
+  * @property {string} name
+  * @property {number} size
+  * @property {number} estimatedCompressedSize
+  * @property {any} [qualityModel]
+  * @property {string} [expectedSha256Hash]
+  * @property {string} [modelType]
+  */
+  /**
+  * @type { {[langPair: string] : {model: genericModelInfo, lex: genericModelInfo, vocab: genericModelInfo, quality?: genericModelInfo}} }
+  */
+  modelRegistry = {};
+
+  /** @type {Record<key, {promise: Promise<string>, resolve: function, reject: function}>} */
+  currentlyTranslating = {}
+
+  /** @type {Record<string, string>[]} */
+  fromLanguages = [];
+  /** @type {Record<string, string>[]} */
+  toLanguages = [];
+
+  /** @type {boolean} */
+  active = false;
+
+  publicPath = '';
+
+  constructor() {
+    //TODO Should default to the book language as the first element
+    const enModel = {code: "en", name: "English", type: "prod"};
+    this.fromLanguages.push(enModel);
+    this.toLanguages.push(enModel);
+  }
+
+
+  async initWorker() {
+    if (this.initPromise) return this.initPromise;
+    this.initPromise = new Promise((resolve, reject) => {
+      this._initResolve = resolve;
+      this._initReject = reject;
+    });
+    const registryUrl = "https://cors.archive.org/cors/mozilla-translate-models/firefox_models/";
+    const registryJson = await fetch(registryUrl + "registry.json").then(r => r.json());
+    for (const language of Object.values(registryJson)) {
+      for (const file of Object.values(language)) {
+        file.name = registryUrl + file.name;
+      }
+    }
+
+    /** @type {BatchTranslator} */
+    // Arbitrary setting for number of workers, 1 is already quite fast
+    // batchSize from 8 -> 4 for improved performance
+    this.translator = new BatchTranslator({
+      registryUrl: `data:application/json,${encodeURIComponent(JSON.stringify(registryJson))}`,
+      workers: 2,
+      batchSize: 4,
+      workerUrl: this.publicPath + '/translator-worker.js',
+    });
+
+    const modelType = await this.translator.backing.registry;
+    const arr = {}; // unsure if we need to keep track of the files
+    for (const obj of Object.values(modelType)) {
+      const firstLang = obj['from'];
+      const secondLang = obj['to'];
+      const fromModelType = obj['files'];
+      arr[`${firstLang}${secondLang}`] = fromModelType;
+      // Assuming that all of the languages loaded from the registryUrl inside @internetarchive/bergamot-translator/translator.js are prod
+      // List of dev models found here https://github.com/mozilla/firefox-translations-models/tree/main/models/base
+      // There are also differences between the model types in the repo above here: https://github.com/mozilla/firefox-translations-models?tab=readme-ov-file#firefox-translations-models
+      if (firstLang !== "en") {
+        this.fromLanguages.push({code: firstLang, name: toISO6391(firstLang, true), type: "prod"});
+      }
+      if (secondLang !== "en") {
+        this.toLanguages.push({code: secondLang, name: toISO6391(secondLang, true), type: "prod"});
+      }
+    }
+    this._initResolve([this.modelRegistry]);
+    return this.initPromise;
+  }
+
+  /**
+   * Targets the page and paragraph of a text layer to create a translation from the "fromLang" to the "toLang". Tries to force order in translation by using the pageIndex (+1000 if the current page is not visible) and paragraphIndex
+   * @param {string} fromLang
+   * @param {string} toLang
+   * @param {string} pageIndex
+   * @param {number} paragraphIndex
+   * @param {string} text
+   * @param {number} priority
+   * @return {Promise<string>} translated text
+   */
+
+  getTranslation = async (fromLang, toLang, pageIndex, paragraphIndex, text, priority) => {
+    this.active = true;
+    if (fromLang == toLang || !fromLang || !toLang) {
+      return;
+    }
+    const key = `${fromLang}${toLang}-${pageIndex}:${paragraphIndex}`;
+    const cachedEntry = this.alreadyTranslated.entries.find(x => x.index == key);
+
+    if (cachedEntry) {
+      return cachedEntry.response;
+    }
+
+    if (key in this.currentlyTranslating) {
+      return this.currentlyTranslating[key].promise;
+    }
+
+    let _resolve = null;
+    let _reject = null;
+    const promise = new Promise((res, rej) => {
+      _resolve = res;
+      _reject = rej;
+    });
+
+    this.currentlyTranslating[key] = {
+      promise,
+      resolve: _resolve,
+      reject: _reject,
+    };
+
+    if (!text) {
+      this.currentlyTranslating[key].reject("No text was provided");
+      return promise;
+    }
+    this.translator.translate({
+      to: toLang,
+      from: fromLang,
+      text: text,
+      html: false,
+      priority: priority,
+    }).then((resp) => {
+      const response = resp;
+      this.currentlyTranslating[key].resolve(response.target.text);
+      this.alreadyTranslated.add({index: key, response: response.target.text});
+      delete this.currentlyTranslating[key];
+    });
+
+    return promise;
+  }
+}