scribe.js-ocr 0.7.0 → 0.7.1

package/.eslintrc.json

@@ -11,6 +11,9 @@
         "ecmaVersion": "latest",
         "sourceType": "module"
     },
+    "plugins": [
+        "jsdoc"
+    ],
     // "globals": {
     //     "fabric": "writable"
     // },
@@ -20,6 +23,9 @@
             200,
             { "ignoreRegExpLiterals": true, "ignoreTemplateLiterals": true }
         ],
+
+        "jsdoc/check-alignment": 1,
+
         // This rule results in code being deleted. 
         "no-unreachable": "off",
         // This edit allows for .js files (but not packages) to have an extension.

package/js/containers/fontContainer.js

@@ -365,14 +365,14 @@ export class FontCont {
   };
 
   /**
-     * Gets a font object.  Unlike accessing the font containers directly,
-     * this method allows for special values 'Default', 'SansDefault', and 'SerifDefault' to be used.
-     *
-     * @param {('Default'|'SansDefault'|'SerifDefault'|string)} family - Font family name.
-     * @param {('normal'|'italic'|'bold'|string)} [style='normal']
-     * @param {string} [lang='eng']
-     * @returns {FontContainerFont}
-     */
+   * Gets a font object.  Unlike accessing the font containers directly,
+   * this method allows for special values 'Default', 'SansDefault', and 'SerifDefault' to be used.
+   *
+   * @param {('Default'|'SansDefault'|'SerifDefault'|string)} family - Font family name.
+   * @param {('normal'|'italic'|'bold'|string)} [style='normal']
+   * @param {string} [lang='eng']
+   * @returns {FontContainerFont}
+   */
   static getFont = (family, style = 'normal', lang = 'eng') => {
     if (FontCont.doc?.[family]?.[style] && !FontCont.doc?.[family]?.[style]?.disable) {
       return FontCont.doc[family][style];

package/js/fontContainerMain.js

@@ -47,70 +47,70 @@ export async function loadBuiltInFontsRaw(glyphSet = 'latin') {
       carlitoNormal = fetch(new URL('../fonts/latin/Carlito-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
       carlitoItalic = fetch(new URL('../fonts/latin/Carlito-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
       carlitoBold = fetch(new URL('../fonts/latin/Carlito-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      centuryNormal = fetch(new URL('../fonts/latin/C059-Roman.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      centuryItalic = fetch(new URL('../fonts/latin/C059-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      centuryBold = fetch(new URL('../fonts/latin/C059-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      garamondNormal = fetch(new URL('../fonts/latin/EBGaramond-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      garamondItalic = fetch(new URL('../fonts/latin/EBGaramond-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      garamondBold = fetch(new URL('../fonts/latin/EBGaramond-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      palatinoNormal = fetch(new URL('../fonts/latin/P052-Roman.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      palatinoItalic = fetch(new URL('../fonts/latin/P052-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      palatinoBold = fetch(new URL('../fonts/latin/P052-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      centuryNormal = fetch(new URL('../fonts/latin/Century-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      centuryItalic = fetch(new URL('../fonts/latin/Century-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      centuryBold = fetch(new URL('../fonts/latin/Century-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      garamondNormal = fetch(new URL('../fonts/latin/Garamond-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      garamondItalic = fetch(new URL('../fonts/latin/Garamond-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      garamondBold = fetch(new URL('../fonts/latin/Garamond-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      palatinoNormal = fetch(new URL('../fonts/latin/Palatino-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      palatinoItalic = fetch(new URL('../fonts/latin/Palatino-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      palatinoBold = fetch(new URL('../fonts/latin/Palatino-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
       nimbusRomNo9LNormal = fetch(new URL('../fonts/latin/NimbusRoman-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
       nimbusRomNo9LItalic = fetch(new URL('../fonts/latin/NimbusRoman-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
       nimbusRomNo9LBold = fetch(new URL('../fonts/latin/NimbusRoman-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
       nimbusSansNormal = fetch(new URL('../fonts/latin/NimbusSans-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
       nimbusSansItalic = fetch(new URL('../fonts/latin/NimbusSans-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
       nimbusSansBold = fetch(new URL('../fonts/latin/NimbusSans-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      nimbusMonoNormal = fetch(new URL('../fonts/latin/NimbusMonoPS-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      nimbusMonoItalic = fetch(new URL('../fonts/latin/NimbusMonoPS-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      nimbusMonoBold = fetch(new URL('../fonts/latin/NimbusMonoPS-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      nimbusMonoNormal = fetch(new URL('../fonts/latin/NimbusMono-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      nimbusMonoItalic = fetch(new URL('../fonts/latin/NimbusMono-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      nimbusMonoBold = fetch(new URL('../fonts/latin/NimbusMono-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
     } else {
       carlitoNormal = fetch(new URL('../fonts/all/Carlito-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
       carlitoItalic = fetch(new URL('../fonts/all/Carlito-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
       carlitoBold = fetch(new URL('../fonts/all/Carlito-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      centuryNormal = fetch(new URL('../fonts/all/C059-Roman.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      centuryItalic = fetch(new URL('../fonts/all/C059-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      centuryBold = fetch(new URL('../fonts/all/C059-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      garamondNormal = fetch(new URL('../fonts/all/EBGaramond-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      garamondItalic = fetch(new URL('../fonts/all/EBGaramond-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      garamondBold = fetch(new URL('../fonts/all/EBGaramond-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      palatinoNormal = fetch(new URL('../fonts/all/P052-Roman.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      palatinoItalic = fetch(new URL('../fonts/all/P052-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      palatinoBold = fetch(new URL('../fonts/all/P052-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      centuryNormal = fetch(new URL('../fonts/all/Century-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      centuryItalic = fetch(new URL('../fonts/all/Century-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      centuryBold = fetch(new URL('../fonts/all/Century-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      garamondNormal = fetch(new URL('../fonts/all/Garamond-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      garamondItalic = fetch(new URL('../fonts/all/Garamond-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      garamondBold = fetch(new URL('../fonts/all/Garamond-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      palatinoNormal = fetch(new URL('../fonts/all/Palatino-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      palatinoItalic = fetch(new URL('../fonts/all/Palatino-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      palatinoBold = fetch(new URL('../fonts/all/Palatino-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
       nimbusRomNo9LNormal = fetch(new URL('../fonts/all/NimbusRoman-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
       nimbusRomNo9LItalic = fetch(new URL('../fonts/all/NimbusRoman-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
       nimbusRomNo9LBold = fetch(new URL('../fonts/all/NimbusRoman-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
       nimbusSansNormal = fetch(new URL('../fonts/all/NimbusSans-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
       nimbusSansItalic = fetch(new URL('../fonts/all/NimbusSans-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
       nimbusSansBold = fetch(new URL('../fonts/all/NimbusSans-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      nimbusMonoNormal = fetch(new URL('../fonts/all/NimbusMonoPS-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      nimbusMonoItalic = fetch(new URL('../fonts/all/NimbusMonoPS-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
-      nimbusMonoBold = fetch(new URL('../fonts/all/NimbusMonoPS-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      nimbusMonoNormal = fetch(new URL('../fonts/all/NimbusMono-Regular.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      nimbusMonoItalic = fetch(new URL('../fonts/all/NimbusMono-Italic.woff', import.meta.url)).then((res) => res.arrayBuffer());
+      nimbusMonoBold = fetch(new URL('../fonts/all/NimbusMono-Bold.woff', import.meta.url)).then((res) => res.arrayBuffer());
     }
   } else {
     const { readFile } = await import('fs/promises');
-    carlitoNormal = readFile(new URL('../fonts/all_ttf/Carlito-Regular.ttf', import.meta.url)).then((res) => res.buffer);
-    carlitoItalic = readFile(new URL('../fonts/all_ttf/Carlito-Italic.ttf', import.meta.url)).then((res) => res.buffer);
-    carlitoBold = readFile(new URL('../fonts/all_ttf/Carlito-Bold.ttf', import.meta.url)).then((res) => res.buffer);
-    centuryNormal = readFile(new URL('../fonts/all_ttf/C059-Roman.ttf', import.meta.url)).then((res) => res.buffer);
-    centuryItalic = readFile(new URL('../fonts/all_ttf/C059-Italic.ttf', import.meta.url)).then((res) => res.buffer);
-    centuryBold = readFile(new URL('../fonts/all_ttf/C059-Bold.ttf', import.meta.url)).then((res) => res.buffer);
-    garamondNormal = readFile(new URL('../fonts/all_ttf/EBGaramond-Regular.ttf', import.meta.url)).then((res) => res.buffer);
-    garamondItalic = readFile(new URL('../fonts/all_ttf/EBGaramond-Italic.ttf', import.meta.url)).then((res) => res.buffer);
-    garamondBold = readFile(new URL('../fonts/all_ttf/EBGaramond-Bold.ttf', import.meta.url)).then((res) => res.buffer);
-    palatinoNormal = readFile(new URL('../fonts/all_ttf/P052-Roman.ttf', import.meta.url)).then((res) => res.buffer);
-    palatinoItalic = readFile(new URL('../fonts/all_ttf/P052-Italic.ttf', import.meta.url)).then((res) => res.buffer);
-    palatinoBold = readFile(new URL('../fonts/all_ttf/P052-Bold.ttf', import.meta.url)).then((res) => res.buffer);
-    nimbusRomNo9LNormal = readFile(new URL('../fonts/all_ttf/NimbusRoman-Regular.ttf', import.meta.url)).then((res) => res.buffer);
-    nimbusRomNo9LItalic = readFile(new URL('../fonts/all_ttf/NimbusRoman-Italic.ttf', import.meta.url)).then((res) => res.buffer);
-    nimbusRomNo9LBold = readFile(new URL('../fonts/all_ttf/NimbusRoman-Bold.ttf', import.meta.url)).then((res) => res.buffer);
-    nimbusSansNormal = readFile(new URL('../fonts/all_ttf/NimbusSans-Regular.ttf', import.meta.url)).then((res) => res.buffer);
-    nimbusSansItalic = readFile(new URL('../fonts/all_ttf/NimbusSans-Italic.ttf', import.meta.url)).then((res) => res.buffer);
-    nimbusSansBold = readFile(new URL('../fonts/all_ttf/NimbusSans-Bold.ttf', import.meta.url)).then((res) => res.buffer);
-    nimbusMonoNormal = readFile(new URL('../fonts/all_ttf/NimbusMonoPS-Regular.ttf', import.meta.url)).then((res) => res.buffer);
-    nimbusMonoItalic = readFile(new URL('../fonts/all_ttf/NimbusMonoPS-Italic.ttf', import.meta.url)).then((res) => res.buffer);
-    nimbusMonoBold = readFile(new URL('../fonts/all_ttf/NimbusMonoPS-Bold.ttf', import.meta.url)).then((res) => res.buffer);
+    carlitoNormal = readFile(new URL('../fonts/all/Carlito-Regular.woff', import.meta.url)).then((res) => res.buffer);
+    carlitoItalic = readFile(new URL('../fonts/all/Carlito-Italic.woff', import.meta.url)).then((res) => res.buffer);
+    carlitoBold = readFile(new URL('../fonts/all/Carlito-Bold.woff', import.meta.url)).then((res) => res.buffer);
+    centuryNormal = readFile(new URL('../fonts/all/Century-Regular.woff', import.meta.url)).then((res) => res.buffer);
+    centuryItalic = readFile(new URL('../fonts/all/Century-Italic.woff', import.meta.url)).then((res) => res.buffer);
+    centuryBold = readFile(new URL('../fonts/all/Century-Bold.woff', import.meta.url)).then((res) => res.buffer);
+    garamondNormal = readFile(new URL('../fonts/all/Garamond-Regular.woff', import.meta.url)).then((res) => res.buffer);
+    garamondItalic = readFile(new URL('../fonts/all/Garamond-Italic.woff', import.meta.url)).then((res) => res.buffer);
+    garamondBold = readFile(new URL('../fonts/all/Garamond-Bold.woff', import.meta.url)).then((res) => res.buffer);
+    palatinoNormal = readFile(new URL('../fonts/all/Palatino-Regular.woff', import.meta.url)).then((res) => res.buffer);
+    palatinoItalic = readFile(new URL('../fonts/all/Palatino-Italic.woff', import.meta.url)).then((res) => res.buffer);
+    palatinoBold = readFile(new URL('../fonts/all/Palatino-Bold.woff', import.meta.url)).then((res) => res.buffer);
+    nimbusRomNo9LNormal = readFile(new URL('../fonts/all/NimbusRoman-Regular.woff', import.meta.url)).then((res) => res.buffer);
+    nimbusRomNo9LItalic = readFile(new URL('../fonts/all/NimbusRoman-Italic.woff', import.meta.url)).then((res) => res.buffer);
+    nimbusRomNo9LBold = readFile(new URL('../fonts/all/NimbusRoman-Bold.woff', import.meta.url)).then((res) => res.buffer);
+    nimbusSansNormal = readFile(new URL('../fonts/all/NimbusSans-Regular.woff', import.meta.url)).then((res) => res.buffer);
+    nimbusSansItalic = readFile(new URL('../fonts/all/NimbusSans-Italic.woff', import.meta.url)).then((res) => res.buffer);
+    nimbusSansBold = readFile(new URL('../fonts/all/NimbusSans-Bold.woff', import.meta.url)).then((res) => res.buffer);
+    nimbusMonoNormal = readFile(new URL('../fonts/all/NimbusMono-Regular.woff', import.meta.url)).then((res) => res.buffer);
+    nimbusMonoItalic = readFile(new URL('../fonts/all/NimbusMono-Italic.woff', import.meta.url)).then((res) => res.buffer);
+    nimbusMonoBold = readFile(new URL('../fonts/all/NimbusMono-Bold.woff', import.meta.url)).then((res) => res.buffer);
   }
 
   const srcObj = {

package/js/fontEval.js

@@ -40,9 +40,9 @@ export async function evalPagesFont(font, pageArr, opt, n = 500) {
 }
 
 /**
-* @param {Array<OcrPage>} pageArr
-* @param {boolean} opt - Whether to use optimized fonts.
-*/
+ * @param {Array<OcrPage>} pageArr
+ * @param {boolean} opt - Whether to use optimized fonts.
+ */
 export async function evaluateFonts(pageArr, opt) {
   const evalCarlito = !!(opt ? FontCont.opt?.Carlito : FontCont.raw?.Carlito);
   const evalNimbusSans = !!(opt ? FontCont.opt?.NimbusSans : FontCont.raw?.NimbusSans);

package/js/fontSupp.js

@@ -62,13 +62,13 @@ const calcSuppFontInfoForWords = async (words) => {
 };
 
 /**
-   *
-   * @param {Array<OcrPage>} ocrArr
-   * @returns
-   * This function runs recognition on certain fonts when we need more information about them.
-   * Fonts are included when either (1) we need to know if they are sans or serif or (2) if the text is extracted from a PDF,
-   * and we need to determine how large to render the text.
-   */
+ *
+ * @param {Array<OcrPage>} ocrArr
+ * @returns
+ * This function runs recognition on certain fonts when we need more information about them.
+ * Fonts are included when either (1) we need to know if they are sans or serif or (2) if the text is extracted from a PDF,
+ * and we need to determine how large to render the text.
+ */
 export const calcSuppFontInfo = async (ocrArr) => {
   if (!ocrArr) return;
   await gs.initTesseract({ anyOk: true, langs: ['eng'] });

package/js/generalWorkerMain.js

@@ -57,10 +57,10 @@ export async function initGeneralWorker() {
     }
 
     /**
-       * Wraps a function to be called via worker messages.
-       * @param {string} func The function name to call.
-       * @returns {Function} A function that returns a promise resolving to the worker's response.
-       */
+     * Wraps a function to be called via worker messages.
+     * @param {string} func The function name to call.
+     * @returns {Function} A function that returns a promise resolving to the worker's response.
+     */
     function wrap(func) {
       return function (...args) {
         return new Promise((innerResolve, innerReject) => {
@@ -72,10 +72,10 @@ export async function initGeneralWorker() {
     }
 
     /**
-       * Similar to wrap, but handles two promises.
-       * @param {string} func The function name to call.
-       * @returns {Array} Returns two promises in an array.
-       */
+     * Similar to wrap, but handles two promises.
+     * @param {string} func The function name to call.
+     * @returns {Array} Returns two promises in an array.
+     */
     function wrap2(func) {
       return function (...args) {
         const id = promiseId++;
@@ -187,14 +187,14 @@ export class gs {
   static optimizeFont = async (args) => (await gs.schedulerInner.addJob('optimizeFont', args));
 
   /**
-  * @template {Partial<Tesseract.OutputFormats>} TO
-  * @param {Object} args
-  * @param {Parameters<Tesseract.Worker['recognize']>[0]} args.image
-  * @param {Parameters<Tesseract.Worker['recognize']>[1]} args.options
-  * @param {TO} args.output
-  * @returns {Promise<Tesseract.Page<TO>>}
-  * Exported for type inference purposes, should not be imported anywhere.
-  */
+   * @template {Partial<Tesseract.OutputFormats>} TO
+   * @param {Object} args
+   * @param {Parameters<Tesseract.Worker['recognize']>[0]} args.image
+   * @param {Parameters<Tesseract.Worker['recognize']>[1]} args.options
+   * @param {TO} args.output
+   * @returns {Promise<Tesseract.Page<TO>>}
+   * Exported for type inference purposes, should not be imported anywhere.
+   */
   static recognize = async (args) => (await gs.schedulerInner.addJob('recognize', args));
 
   /**

package/js/import/convertPageHocr.js

@@ -87,8 +87,8 @@ export async function convertPageHocr({
   }
 
   /**
-     * @param {string} match
-     */
+   * @param {string} match
+   */
   function convertLine(match) {
     const titleStrLine = match.match(/title=['"]([^'"]+)/)?.[1];
     if (!titleStrLine) return '';
@@ -258,8 +258,8 @@ export async function convertPageHocr({
     }
 
     /**
-       * @param {string} match
-       */
+     * @param {string} match
+     */
     function convertWord(match) {
       const wordID = match.match(/id=['"]([^'"]*)['"]/i)?.[1] || `word_${n + 1}_${pageObj.lines.length + 1}_${lineObj.words.length + 1}`;
 
@@ -357,8 +357,8 @@ export async function convertPageHocr({
   }
 
   /**
-     * @param {string} match
-     */
+   * @param {string} match
+   */
   const convertPar = (match) => {
     const parLang = match.match(/^.+?lang=['"]([^'"]*)['"]/i)?.[1];
     if (parLang) currentLang = parLang;

package/js/import/nodeAdapter.js

@@ -9,11 +9,11 @@ import path from 'path';
  */
 export class FileNode {
   /**
-     * Creates an instance of the File class.
-     * @param {string} filePath - The path to the file.
-     * @param {string} name - The name of the file.
-     * @param {Buffer} fileData - The file's data.
-     */
+   * Creates an instance of the File class.
+   * @param {string} filePath - The path to the file.
+   * @param {string} name - The name of the file.
+   * @param {Buffer} fileData - The file's data.
+   */
   constructor(filePath, name, fileData) {
     this.filePath = filePath;
     this.name = name;
@@ -21,9 +21,9 @@ export class FileNode {
   }
 
   /**
-     * Returns an ArrayBuffer with the file's contents.
-     * @returns {Promise<ArrayBuffer>} A promise that resolves with the file's contents as an ArrayBuffer.
-     */
+   * Returns an ArrayBuffer with the file's contents.
+   * @returns {Promise<ArrayBuffer>} A promise that resolves with the file's contents as an ArrayBuffer.
+   */
   async arrayBuffer() {
     return this.fileData.buffer.slice(this.fileData.byteOffset, this.fileData.byteOffset + this.fileData.byteLength);
   }

package/js/objects/imageObjects.js

@@ -2,15 +2,15 @@ import { getJpegDimensions, getPngDimensions } from '../utils/imageUtils.js';
 
 export class ImageWrapper {
   /**
-     * @param {number} n - Page number
-     * @param {string} imageStr - Base-64 encoded image string. Should start with "data:image/png" or "data:image/jpeg".
-     * @param {string} colorMode - Color mode ("color", "gray", or "binary").
-     * @param {boolean} rotated - Whether image has been rotated.
-     * @param {boolean} upscaled - Whether image has been upscaled.
-     *
-     * All properties of this object must be serializable, as ImageWrapper objects are sent between threads.
-     * This means that no promises can be used.
-     */
+   * @param {number} n - Page number
+   * @param {string} imageStr - Base-64 encoded image string. Should start with "data:image/png" or "data:image/jpeg".
+   * @param {string} colorMode - Color mode ("color", "gray", or "binary").
+   * @param {boolean} rotated - Whether image has been rotated.
+   * @param {boolean} upscaled - Whether image has been upscaled.
+   *
+   * All properties of this object must be serializable, as ImageWrapper objects are sent between threads.
+   * This means that no promises can be used.
+   */
   constructor(n, imageStr, colorMode, rotated = false, upscaled = false) {
     this.n = n;
     this.src = imageStr;

package/js/objects/ocrObjects.js

@@ -134,7 +134,7 @@ export function OcrWord(line, text, bbox, id) {
   /**
    * @type {boolean} - If `true`, left/right coordinates represent the left/rightmost pixel.
    * If `false`, left/right coordinates represent the start/end of the font bounding box.
-  */
+   */
   this.visualCoords = true;
 }
 
@@ -331,7 +331,7 @@ export const getLineText = (line) => {
 
 /**
  * @param {OcrPar} par
-*/
+ */
 export const getParText = (par) => {
   let text = '';
   for (let i = 0; i < par.lines.length; i++) {
@@ -584,7 +584,7 @@ function rotateLine(line, angle, dims = null, useCharLevel = false) {
 /**
  * Clones page object.
  * @param {OcrPage} page
-  */
+ */
 function clonePage(page) {
   const pageNew = new OcrPage(page.n, { ...page.dims });
   for (const line of page.lines) {

package/js/utils/fontUtils.js

@@ -99,7 +99,7 @@ function calcWordFontSizePrecise(wordArr, fontOpentype, nonLatin = false) {
  * Adds ligatures to text of `OcrWord` object. Returns an array of letters.
  * @param {OcrWord} word
  * @returns {Array<string>}
-*/
+ */
 export function addLigatures(word) {
   if (word.smallCaps || !opt.ligatures) return word.text.split('');
   const fontI = FontCont.getWordFont(word);
@@ -181,9 +181,9 @@ function calcWordCharMetrics(wordText, fontOpentype) {
       if (opt.kerning) {
         const glyphJ = fontOpentype.charToGlyph(charJ);
         const kerning = fontOpentype.getKerningValue(glyphI, glyphJ);
-        kerningArr.push(kerning);  
+        kerningArr.push(kerning);
       } else {
-        kerningArr.push(0);  
+        kerningArr.push(0);
       }
     }
   }
@@ -322,11 +322,11 @@ export const calcWordFontSize = (word) => {
 // Therefore, the appropriate font size must be calculated using (1) the character stats from the input image and
 // (2) stats regarding the font being used.
 /**
-* Get or calculate font size for line.
-* This value will either be (1) a manually set value or (2) a value calculated using line metrics.
-* @param {OcrLine} line
-* @returns {number}
-*/
+ * Get or calculate font size for line.
+ * This value will either be (1) a manually set value or (2) a value calculated using line metrics.
+ * @param {OcrLine} line
+ * @returns {number}
+ */
 export const calcLineFontSize = (line) => {
   if (line._size) return line._size;
 

package/js/utils/imageUtils.js

@@ -1,6 +1,5 @@
 /* eslint-disable no-bitwise */
 
-
 /**
  * Loads an image from a given URL and sets it to a specified HTML element.
  *
@@ -53,15 +52,15 @@ export function base64ToBytes(base64) {
 }
 
 /**
-  * Extracts the width and height from the IHDR chunk of a PNG image encoded in base64.
-  *
-  * This function decodes the base64 to bytes and parses the IHDR chunk to extract the image dimensions.
-  * It assumes the base64 string is a valid PNG image and directly starts parsing the binary data.
-  * Note: This is a basic implementation without extensive error handling or validation.
-  *
-  * @param {string} base64 - The base64 encoded string of the PNG image.
-  * @returns {dims} An object containing the width and height of the image.
-  */
+ * Extracts the width and height from the IHDR chunk of a PNG image encoded in base64.
+ *
+ * This function decodes the base64 to bytes and parses the IHDR chunk to extract the image dimensions.
+ * It assumes the base64 string is a valid PNG image and directly starts parsing the binary data.
+ * Note: This is a basic implementation without extensive error handling or validation.
+ *
+ * @param {string} base64 - The base64 encoded string of the PNG image.
+ * @returns {dims} An object containing the width and height of the image.
+ */
 export function getPngDimensions(base64) {
   // The number 96 is chosen to line up leanly with byte boundaries (97 would result in an error)
   // but is otherwise arbitrary, while being large enough to contain the IHDR chunk.

package/js/utils/reflowPars.js

@@ -51,11 +51,11 @@ export function assignParagraphs(page, angle) {
   }
 
   /**
-     * Calculates expected line start and end positions based on surrounding lines.
-     * If this line varies from those values, it may be the first or last line of a paragraph.
-     * @param {number} lineIndex - Index of the line to calculate the expected values for.
-     * @returns
-     */
+   * Calculates expected line start and end positions based on surrounding lines.
+   * If this line varies from those values, it may be the first or last line of a paragraph.
+   * @param {number} lineIndex - Index of the line to calculate the expected values for.
+   * @returns
+   */
   const calcExpected = (lineIndex) => {
     // Ideally, we compare the current line to the next 5 lines.
     // When there are fewer than 5 lines after the current line, we add previous lines to the window.

package/js/worker/compareOCRModule.js

@@ -74,24 +74,24 @@ export async function drawWordActual(words, imageBinaryBit, angle) {
 }
 
 /**
-   * Function that draws a word on a canvas.
-   * This code was factored out to allow for drawing multiple times while only calculating metrics once.
-   * Therefore, only the drawing code should be in this function; the metrics should be calculated elsewhere
-   * and passed to this function, rather than calcualting from an `OcrWord` object.
-   *
-   * @param {Object} params
-   * @param {CanvasRenderingContext2D|OffscreenCanvasRenderingContext2D} params.ctx
-   * @param {Array<string>} params.charArr
-   * @param {number} params.left
-   * @param {number} params.bottom
-   * @param {Array<number>} params.advanceArr - Array of pixels to advance for each character.
-   *    Unlike the "advance" property of a glyph, this is the actual distance to advance on the canvas,
-   *    and should include kerning and character spacing.
-   * @param {FontContainerFont} params.font
-   * @param {number} params.size
-   * @param {boolean} params.smallCaps
-   * @param {string} [params.fillStyle='black']
-   */
+ * Function that draws a word on a canvas.
+ * This code was factored out to allow for drawing multiple times while only calculating metrics once.
+ * Therefore, only the drawing code should be in this function; the metrics should be calculated elsewhere
+ * and passed to this function, rather than calcualting from an `OcrWord` object.
+ *
+ * @param {Object} params
+ * @param {CanvasRenderingContext2D|OffscreenCanvasRenderingContext2D} params.ctx
+ * @param {Array<string>} params.charArr
+ * @param {number} params.left
+ * @param {number} params.bottom
+ * @param {Array<number>} params.advanceArr - Array of pixels to advance for each character.
+ *    Unlike the "advance" property of a glyph, this is the actual distance to advance on the canvas,
+ *    and should include kerning and character spacing.
+ * @param {FontContainerFont} params.font
+ * @param {number} params.size
+ * @param {boolean} params.smallCaps
+ * @param {string} [params.fillStyle='black']
+ */
 const printWordOnCanvas = async ({
   ctx, charArr, left, bottom, advanceArr, font, size, smallCaps, fillStyle = 'black',
 }) => {
@@ -118,15 +118,15 @@ const printWordOnCanvas = async ({
 };
 
 /**
-   * Print word on canvas.
-   *
-   * @param {CanvasRenderingContext2D|OffscreenCanvasRenderingContext2D} ctx
-   * @param {OcrWord} word
-   * @param {number} offsetX
-   * @param {number} cropY
-   * @param {?CanvasRenderingContext2D|OffscreenCanvasRenderingContext2D} ctxView
-   * @param {boolean} [imageRotated=false] -
-   */
+ * Print word on canvas.
+ *
+ * @param {CanvasRenderingContext2D|OffscreenCanvasRenderingContext2D} ctx
+ * @param {OcrWord} word
+ * @param {number} offsetX
+ * @param {number} cropY
+ * @param {?CanvasRenderingContext2D|OffscreenCanvasRenderingContext2D} ctxView
+ * @param {boolean} [imageRotated=false] -
+ */
 export const drawWordRender = async (ctx, word, offsetX = 0, cropY = 0, ctxView = null, imageRotated = false) => {
   if (!FontCont.raw) throw new Error('Fonts must be defined before running this function.');
   if (!ctx) throw new Error('Canvases must be defined before running this function.');
@@ -1304,8 +1304,8 @@ export async function evalPageFont({
   }
 
   /**
- * @param {OcrLine} ocrLineJ
- */
+   * @param {OcrLine} ocrLineJ
+   */
   const transformLineFont = (ocrLineJ) => {
     if (!FontCont.raw) throw new Error('Fonts must be defined before running this function.');
 

package/js/worker/generalWorker.js

@@ -329,14 +329,14 @@ export const recognizeAndConvert2 = async ({
 };
 
 /**
-* @template {Partial<Tesseract.OutputFormats>} TO
-* @param {Object} args
-* @param {Parameters<Tesseract.Worker['recognize']>[0]} args.image
-* @param {Parameters<Tesseract.Worker['recognize']>[1]} args.options
-* @param {TO} args.output
-* @returns {Promise<Tesseract.Page<TO>>}
-* Exported for type inference purposes, should not be imported anywhere.
-*/
+ * @template {Partial<Tesseract.OutputFormats>} TO
+ * @param {Object} args
+ * @param {Parameters<Tesseract.Worker['recognize']>[0]} args.image
+ * @param {Parameters<Tesseract.Worker['recognize']>[1]} args.options
+ * @param {TO} args.output
+ * @returns {Promise<Tesseract.Page<TO>>}
+ * Exported for type inference purposes, should not be imported anywhere.
+ */
 export const recognize = async ({ image, options, output }) => {
   if (!worker) throw new Error('Worker not initialized');
   const res1 = await worker.recognize(image, options, output);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scribe.js-ocr",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "High-quality OCR and text extraction for images and PDFs.",
   "main": "scribe.js",
   "directories": {
@@ -16,6 +16,7 @@
     "eslint": "^8.56.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsdoc": "^50.6.2",
     "express": "^4.18.2",
     "karma": "^6.4.4",
     "karma-chrome-launcher": "^3.2.0",
@@ -48,8 +49,8 @@
   },
   "homepage": "https://github.com/scribeocr/scribe.js#readme",
   "dependencies": {
+    "@scribe.js/tesseract.js": "^6.0.2",
     "canvaskit-wasm": "^0.39.1",
-    "commander": "^11.1.0",
-    "@scribe.js/tesseract.js": "^6.0.2"
+    "commander": "^11.1.0"
   }
 }