Replaced opentype.js build with submodule

Balearica · Balearica · commit 421d59e902cd · 2026-03-22T19:24:21.000-07:00
diff --git a/.gitmodules b/.gitmodules
@@ -4,3 +4,6 @@
 [submodule "tests/test-assets"]
 	path = tests/test-assets
 	url = https://github.com/scribe-js/test-assets.git
+[submodule "js/font-parser"]
+	path = js/font-parser
+	url = https://github.com/scribe-js/font-parser.git
diff --git a/.npmignore b/.npmignore
@@ -24,4 +24,6 @@ karma.conf.cjs
 jsconfig.json
 .eslintrc.json
 .gitmodules
-build-deno-compile.sh
+build-deno-compile.sh
+js/font-parser/fonts
+js/font-parser/test
diff --git a/js/containers/fontContainer.js b/js/containers/fontContainer.js
@@ -4,7 +4,7 @@
 // all fonts should have an identical OpenType.js and FontFace version.
 
 // Node.js case
-import opentype from '../../lib/opentype.module.js';
+import opentype from '../font-parser/src/index.js';
 import { determineSansSerif, getStyleLookup, clearObjectProperties } from '../utils/miscUtils.js';
 import { ca } from '../canvasAdapter.js';
 
@@ -43,9 +43,13 @@ export function checkMultiFontMode(charMetricsObj) {
  * @param {string|ArrayBuffer} src
  * @param {?Object.<string, number>} [kerningPairs=null]
  */
+/** Tables not used by scribe.js — skipping them avoids decompression and parsing overhead. */
+const defaultSkipTables = ['GSUB', 'GPOS', 'OS/2', 'cvt ', 'fpgm', 'prep', 'COLR', 'CPAL', 'meta'];
+
 export async function loadOpentype(src, kerningPairs = null) {
-  const font = typeof (src) === 'string' ? await opentype.load(src) : await opentype.parse(src, { lowMemory: false });
-  font.tables.gsub = null;
+  const font = typeof (src) === 'string'
+    ? opentype.parse(await fetch(src).then((r) => r.arrayBuffer()), { skipTables: defaultSkipTables })
+    : opentype.parse(src, { skipTables: defaultSkipTables });
   // Re-apply kerningPairs object so when toArrayBuffer is called on this font later (when making a pdf) kerning data will be included
   if (kerningPairs) font.kerningPairs = kerningPairs;
   return font;
diff --git a/js/export/pdf/writePdf.js b/js/export/pdf/writePdf.js
@@ -484,7 +484,7 @@ function consolidateAnnotations(pageAnnotations, pageObj) {
  * @param {boolean} [params.rotateBackground=false]
  * @param {number} [params.confThreshHigh=85]
  * @param {number} [params.confThreshMed=75]
- * @param {?import('opentype.js').Font} [params.fontChiSim=null]
+ * @param {?import('../../font-parser/src/font.js').Font} [params.fontChiSim=null]
  * @param {Array<number>} [params.imageObjIndices=[]] - Array of image object indices
  * @param {?string} [params.imageName=null]
  * @param {Array<AnnotationHighlight>} [params.pageAnnotations=[]] - Highlight annotations for this page
diff --git a/js/export/pdf/writePdfFonts.js b/js/export/pdf/writePdfFonts.js
@@ -33,7 +33,7 @@ export function hex(arrayBuffer) {
  * Creates a ToUnicode CMap string for a font.
  * The CMap maps character codes to Unicode values to enable text extraction.
  *
- * @param {import('opentype.js').Font} font - Opentype.js font object
+ * @param {import('../../font-parser/src/font.js').Font} font - Opentype.js font object
  * @returns {string} The ToUnicode CMap content string
  */
 export function createToUnicode(font) {
@@ -107,7 +107,7 @@ const generateFontFlags = (serif, italic, smallcap, symbolic) => { /* eslint-dis
 
 /**
  *
- * @param {opentype.Font} font - Opentype.js font object
+ * @param {opentypeFont} font - Opentype.js font object
  * @param {number} objIndex - Index for font descriptor PDF object
  * @param {boolean} italic
  * @param {?number} embeddedObjIndex - Index for embedded font file PDF object.
@@ -174,7 +174,7 @@ function createFontDescriptor(font, objIndex, italic, embeddedObjIndex = null) {
  * Converts a Opentype.js font object into an array of strings containing PDF objects.
  * The font is represented as a simple "Type 1" font.
  *
- * @param {opentype.Font} font - Opentype.js font object
+ * @param {opentypeFont} font - Opentype.js font object
  * @param {number} firstObjIndex - Index for the first PDF object
  * @param {boolean} [italic=false] - Whether the font is italic.
  * @param {boolean} [isStandardFont=false] - Whether the font is a standard font.
@@ -250,7 +250,7 @@ export function createEmbeddedFontType1(font, firstObjIndex, italic = false, isS
  * The font is represented as a composite "Type 0" font.
  *
  * @param {Object} options - Configuration object
- * @param {opentype.Font} options.font - Opentype.js font object
+ * @param {opentypeFont} options.font - Opentype.js font object
  * @param {number} options.firstObjIndex - Index for the first PDF object
  * @param {boolean} [options.italic=false] - Whether the font is italic.
  *
diff --git a/js/font-parser b/js/font-parser
@@ -0,0 +1 @@
+Subproject commit 1c58d249ad07ad40dd9a76ec791236f7fce26ea3
diff --git a/js/fontEval.js b/js/fontEval.js
@@ -11,7 +11,7 @@ import { gs } from './generalWorkerMain.js';
 /**
  * Compute the RMSD between OCR character widths and a font's glyph advance widths.
  *
- * @param {opentype.Font} fontOpentype
+ * @param {opentypeFont} fontOpentype
  * @param {CharMetricsFont} charMetrics
  * @returns {number}
  */
diff --git a/js/global.d.ts b/js/global.d.ts
@@ -90,8 +90,8 @@ declare global {
         boldItalic: ArrayBuffer | null;
     };
 
-    type opentypeFont = import("../lib/opentype.module.js").Font;
-    type opentypeGlyph = import("../lib/opentype.module.js").Glyph;
+    type opentypeFont = import("./font-parser/src/index.js").Font;
+    type opentypeGlyph = import("./font-parser/src/index.js").Glyph;
     type GeneralScheduler = import("./generalWorkerMain.js").GeneralScheduler;
 
     // Image objects
diff --git a/js/import/convertDocDocx.js b/js/import/convertDocDocx.js
@@ -57,14 +57,14 @@ function isSentenceEnding(word) {
   return true;
 }
 
-/** @type {?opentype.Font} */
+/** @type {?opentypeFont} */
 let fontOpentype = null;
 
 /**
  * Calculates the advance of a string in pixels.
  * @param {string} text
  * @param {number} size
- * @param {opentype.Font} font
+ * @param {opentypeFont} font
  */
 function getTextWidth(text, size, font) {
   const charMetrics = calcWordCharMetrics(text, font);
diff --git a/js/import/convertPageText.js b/js/import/convertPageText.js
@@ -11,14 +11,14 @@ const LINE_HEIGHT = 14.4;
 const MARGIN_VERTICAL = 30;
 const MARGIN_HORIZONTAL = 20;
 
-/** @type {?opentype.Font} */
+/** @type {?opentypeFont} */
 let fontOpentype = null;
 
 /**
  * Calculates the advance of a string in pixels.
  * @param {string} text
  * @param {number} size
- * @param {opentype.Font} font
+ * @param {opentypeFont} font
  */
 function getTextWidth(text, size, font) {
   const { advanceArr, kerningArr } = calcWordCharMetrics(text, font);
diff --git a/js/utils/fontUtils.js b/js/utils/fontUtils.js
@@ -5,7 +5,7 @@ import { FontCont } from '../containers/fontContainer.js';
 import { getPrevLine } from '../objects/ocrObjects.js';
 import { FontProps, quantile } from './miscUtils.js';
 
-import opentype from '../../lib/opentype.module.js';
+import opentype from '../font-parser/src/index.js';
 import { opt } from '../containers/app.js';
 
 /**
@@ -41,7 +41,7 @@ export const getDistinctCharsFont = (ocrPageArr, family, style) => {
 
 /**
  *
- * @param {import('opentype.js').Font} font
+ * @param {opentype.Font} font
  * @param {Array<string>} charArr
  * @returns
  */
@@ -80,7 +80,7 @@ export async function subsetFont(font, charArr = []) {
 /**
  * Calculates font size by comparing provided character height to font metrics.
  *
- * @param {import('opentype.js').Font} fontOpentype
+ * @param {opentype.Font} fontOpentype
  * @param {number} heightActual - Actual, measured height of text in pixels.
  * @param {string} text - Text to compare `heightActual` against.
  *
@@ -107,7 +107,7 @@ function getFontSize(fontOpentype, heightActual, text) {
 /**
  * Calculates font size for an array of words using the most granular bounding box available (character or word-level) rather than using line-level metrics.
  * @param {Array<OcrWord>} wordArr
- * @param {import('opentype.js').Font} fontOpentype
+ * @param {opentype.Font} fontOpentype
  * @param {Boolean} [nonLatin=false]
  *
  */
diff --git a/js/worker/optimizeFontModule.js b/js/worker/optimizeFontModule.js
@@ -1,6 +1,6 @@
 import { quantile } from '../utils/miscUtils.js';
 
-import opentype from '../../lib/opentype.module.js';
+import opentype from '../font-parser/src/index.js';
 
 // Defining "window" is needed due to bad browser/node detection in Opentype.js
 // Can hopefully remove in future version
@@ -162,15 +162,11 @@ const calculateKerningPairs = (font, charMetricsObj, xHeight, styleLookup) => {
 export async function optimizeFont({
   fontData, charMetricsObj, style, adjustAllLeftBearings = false, standardizeSize = false, targetEmSize = null, transGlyphs = true,
 }) {
+  const skipTables = ['GSUB', 'GPOS', 'OS/2', 'cvt ', 'fpgm', 'prep', 'COLR', 'CPAL', 'meta'];
   /** @type {opentype.Font} */
-  const workingFont = typeof (fontData) === 'string' ? await opentype.load(fontData) : opentype.parse(fontData, { lowMemory: false });
-
-  // let workingFont;
-  // if (typeof (fontData) == "string") {
-  //   workingFont = await opentype.load(fontData);
-  // } else {
-  //   workingFont = opentype.parse(fontData, { lowMemory: false });
-  // }
+  const workingFont = typeof (fontData) === 'string'
+    ? await opentype.parse(await fetch(fontData).then((r) => r.arrayBuffer()), { skipTables })
+    : await opentype.parse(fontData, { skipTables });
 
   // Remove GSUB table (in most Latin fonts this table is responsible for ligatures, if it is used at all).
   // The presence of ligatures (such as ﬁ and ﬂ) is not properly accounted for when setting character metrics.
@@ -185,17 +181,17 @@ export async function optimizeFont({
   const scaleGlyph = (x) => x * xHeightScale;
   if (Math.abs(1 - xHeightScale) > 0.01) {
     if (standardizeSize) {
-      for (const [key, value] of Object.entries(workingFont.glyphs.glyphs)) {
-        transformGlyph(value, scaleGlyph, true, true);
+      for (let i = 0; i < workingFont.glyphs.length; i++) {
+        transformGlyph(workingFont.glyphs.get(i), scaleGlyph, true, true);
       }
     } else {
       console.log("Font is not standard size ('o' 0.47x em size).  Either standardize the font ahead of time or enable `standardizeSize = true` to standardize on the fly.");
     }
   }
 
   if (targetEmSize && targetEmSize !== workingFont.unitsPerEm) {
-    for (const [key, value] of Object.entries(workingFont.glyphs.glyphs)) {
-      transformGlyph(value, (x) => x * (targetEmSize / workingFont.unitsPerEm), true, true);
+    for (let i = 0; i < workingFont.glyphs.length; i++) {
+      transformGlyph(workingFont.glyphs.get(i), (x) => x * (targetEmSize / workingFont.unitsPerEm), true, true);
     }
     workingFont.unitsPerEm = targetEmSize;
   }
@@ -321,7 +317,8 @@ export async function optimizeFont({
       // Limit to +/-30% of original advance width, matching the general scaling limits.
       const uniformAdvance = Math.round(Math.max(Math.min(targetAdvance, originalMonoAdvance * 1.3), originalMonoAdvance * 0.7));
 
-      for (const [key, glyph] of Object.entries(workingFont.glyphs.glyphs)) {
+      for (let i = 0; i < workingFont.glyphs.length; i++) {
+        const glyph = workingFont.glyphs.get(i);
         if (glyph.advanceWidth > 0) {
           glyph.advanceWidth = uniformAdvance;
         }
diff --git a/lib/opentype.module.js b/lib/opentype.module.js
diff --git a/lib/opentype.module.js.map b/lib/opentype.module.js.map
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -10,7 +10,6 @@
   "devDependencies": {
     "@types/mocha": "^10.0.7",
     "@types/node": "^18.0.6",
-    "@types/opentype.js": "^1.3.8",
     "chai": "^5.1.1",
     "documentation": "^14.0.3",
     "eslint": "^8.56.0",
@@ -55,4 +54,4 @@
     "canvaskit-wasm": "^0.39.1",
     "commander": "^11.1.0"
   }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import { gs } from './generalWorkerMain.js';`
`11`	`11`	`/**`
`12`	`12`	`* Compute the RMSD between OCR character widths and a font's glyph advance widths.`
`13`	`13`	`*`
`14`		`- * @param {opentype.Font} fontOpentype`
	`14`	`+ * @param {opentypeFont} fontOpentype`
`15`	`15`	`* @param {CharMetricsFont} charMetrics`
`16`	`16`	`* @returns {number}`
`17`	`17`	`*/`