@luii/node-tesseract-ocr 1.0.19 → 2.0.13

package/dist/esm/index.mjs

@@ -1,18 +1,259 @@
 /*
-* Copyright 2025 Philipp Czarnetzki
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
-* or implied. See the License for the specific language governing
-* permissions and limitations under the License.
-*/
-const { Tesseract } = require('node-gyp-build')(__dirname);
-export { Tesseract };
+ * Copyright 2025 Philipp Czarnetzki
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+/**
+ * All available languages for tesseract
+ * @readonly
+ * @enum {string}
+ */
+export const Language = {
+    afr: "afr",
+    amh: "amh",
+    ara: "ara",
+    asm: "asm",
+    aze: "aze",
+    aze_cyrl: "aze_cyrl",
+    bel: "bel",
+    ben: "ben",
+    bod: "bod",
+    bos: "bos",
+    bre: "bre",
+    bul: "bul",
+    cat: "cat",
+    ceb: "ceb",
+    ces: "ces",
+    chi_sim: "chi_sim",
+    chi_tra: "chi_tra",
+    chr: "chr",
+    cos: "cos",
+    cym: "cym",
+    dan: "dan",
+    deu: "deu",
+    deu_latf: "deu_latf",
+    div: "div",
+    dzo: "dzo",
+    ell: "ell",
+    eng: "eng",
+    enm: "enm",
+    epo: "epo",
+    equ: "equ",
+    est: "est",
+    eus: "eus",
+    fao: "fao",
+    fas: "fas",
+    fil: "fil",
+    fin: "fin",
+    fra: "fra",
+    frm: "frm",
+    fry: "fry",
+    gla: "gla",
+    gle: "gle",
+    glg: "glg",
+    grc: "grc",
+    guj: "guj",
+    hat: "hat",
+    heb: "heb",
+    hin: "hin",
+    hrv: "hrv",
+    hun: "hun",
+    hye: "hye",
+    iku: "iku",
+    ind: "ind",
+    isl: "isl",
+    ita: "ita",
+    ita_old: "ita_old",
+    jav: "jav",
+    jpn: "jpn",
+    kan: "kan",
+    kat: "kat",
+    kat_old: "kat_old",
+    kaz: "kaz",
+    khm: "khm",
+    kir: "kir",
+    kmr: "kmr",
+    kor: "kor",
+    kor_vert: "kor_vert",
+    kur: "kur",
+    lao: "lao",
+    lat: "lat",
+    lav: "lav",
+    lit: "lit",
+    ltz: "ltz",
+    mal: "mal",
+    mar: "mar",
+    mkd: "mkd",
+    mlt: "mlt",
+    mon: "mon",
+    mri: "mri",
+    msa: "msa",
+    mya: "mya",
+    nep: "nep",
+    nld: "nld",
+    nor: "nor",
+    oci: "oci",
+    ori: "ori",
+    osd: "osd",
+    pan: "pan",
+    pol: "pol",
+    por: "por",
+    pus: "pus",
+    que: "que",
+    ron: "ron",
+    rus: "rus",
+    san: "san",
+    sin: "sin",
+    slk: "slk",
+    slv: "slv",
+    snd: "snd",
+    spa: "spa",
+    spa_old: "spa_old",
+    sqi: "sqi",
+    srp: "srp",
+    srp_latn: "srp_latn",
+    sun: "sun",
+    swa: "swa",
+    swe: "swe",
+    syr: "syr",
+    tam: "tam",
+    tat: "tat",
+    tel: "tel",
+    tgk: "tgk",
+    tha: "tha",
+    tir: "tir",
+    ton: "ton",
+    tur: "tur",
+    uig: "uig",
+    ukr: "ukr",
+    urd: "urd",
+    uzb: "uzb",
+    uzb_cyrl: "uzb_cyrl",
+    vie: "vie",
+    yid: "yid",
+    yor: "yor",
+};
+/**
+ * When Tesseract/Cube is initialized we can choose to instantiate/load/run
+ * only the Tesseract part, only the Cube part or both along with the combiner.
+ * The preference of which engine to use is stored in tessedit_ocr_engine_mode.
+ * @readonly
+ * @enum {number}
+ */
+export const OcrEngineModes = {
+    /**
+     * Run Tesseract only - fastest
+     * @deprecated
+     * @type {number}
+     */
+    OEM_TESSERACT_ONLY: 0,
+    /**
+     * Run just the LSTM line recognizer.
+     * @type {nmumber}
+     */
+    OEM_LSTM_ONLY: 1,
+    /**
+     * Run the LSTM recognizer, but allow fallback
+     * to Tesseract when things get difficult.
+     * @deprecated
+     * @type {number}
+     */
+    OEM_TESSERACT_LSTM_COMBINED: 2,
+    /**
+     * Specify this mode when calling init(),
+     * to indicate that any of the above modes
+     * should be automatically inferred from the
+     * variables in the language-specific config,
+     * command-line configs, or if not specified
+     * in any of the above should be set to the
+     * default OEM_TESSERACT_ONLY.
+     * @type {number}
+     * @default
+     */
+    OEM_DEFAULT: 3,
+};
+/**
+ * Possible modes for page layout analysis.
+ * @readonly
+ * @enum {number}
+ */
+export const PageSegmentationModes = {
+    // Orientation and script detection only.
+    PSM_OSD_ONLY: 0,
+    // Automatic page segmentation with orientation and script detection. (OSD)
+    PSM_AUTO_OSD: 1,
+    // Automatic page segmentation, but no OSD, or OCR.
+    PSM_AUTO_ONLY: 2,
+    // Fully automatic page segmentation, but no OSD.
+    PSM_AUTO: 3,
+    // Assume a single column of text of variable sizes.
+    PSM_SINGLE_COLUMN: 4,
+    // Assume a single uniform block of vertically aligned text.
+    PSM_SINGLE_BLOCK_VERT_TEXT: 5,
+    // Assume a single uniform block of text. (Default.)
+    PSM_SINGLE_BLOCK: 6,
+    // Treat the image as a single text line.
+    PSM_SINGLE_LINE: 7,
+    // Treat the image as a single word.
+    PSM_SINGLE_WORD: 8,
+    // Treat the image as a single word in a circle.
+    PSM_CIRCLE_WORD: 9,
+    // Treat the image as a single character.
+    PSM_SINGLE_CHAR: 10,
+    // Find as much text as possible in no particular order.
+    PSM_SPARSE_TEXT: 11,
+    // Sparse text with orientation and script det.
+    PSM_SPARSE_TEXT_OSD: 12,
+    // Treat the image as a single text line, bypassing hacks that are Tesseract-specific.
+    PSM_RAW_LINE: 13,
+};
+export const LogLevels = {
+    ALL: "-2147483648",
+    TRACE: "5000",
+    DEBUG: "10000",
+    INFO: "20000",
+    WARN: "30000",
+    ERROR: "40000",
+    FATAL: "50000",
+    OFF: "2147483647",
+};
+const fs = require("node:fs");
+const path = require("node:path");
+const rootFromSource = path.resolve(__dirname, "../../");
+const bindingOptionsFromSource = path.resolve(rootFromSource, "binding-options.js");
+const bindingOptionsPath = fs.existsSync(bindingOptionsFromSource)
+    ? bindingOptionsFromSource
+    : path.resolve(process.cwd(), "binding-options.js");
+const prebuildRoot = fs.existsSync(bindingOptionsFromSource)
+    ? rootFromSource
+    : process.cwd();
+const { Tesseract: NativeTesseract } = require("pkg-prebuilds")(prebuildRoot, require(bindingOptionsPath));
+class Tesseract extends NativeTesseract {
+    constructor() {
+        super();
+    }
+    async init(options) {
+        // scan train data for any files
+        // check whether the requested langs are available/cached
+        // if not
+        //   fetch traineddata from cdn
+        //     - add .lock file to downloaded file (while downloading, so other instances
+        //       can wait on it and dont have to download again)
+        //     - place into tesseract standard folder
+        //  if available
+        //    just go on with the init function of the native addon
+        return super.init(options);
+    }
+}
+export { Tesseract, NativeTesseract };
 export default Tesseract;

package/package.json

@@ -1,10 +1,17 @@
 {
   "name": "@luii/node-tesseract-ocr",
-  "version": "1.0.19",
+  "version": "2.0.13",
   "private": false,
-  "gypfile": true,
+  "binary": {
+    "napi_versions": [
+      10
+    ]
+  },
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",
+  "engines": {
+    "node": ">=22.14.0"
+  },
   "types": "dist/index.d.ts",
   "homepage": "https://github.com/luii/node-tesseract-ocr",
   "repository": {
@@ -29,52 +36,51 @@
     "ocr",
     "tesseract",
     "leptonica",
-    "node-gyp",
+    "cmake-js",
     "node-addon-api"
   ],
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "install": "node-gyp-build",
-    "prebuild": "prebuildify --napi --strip",
-    "build": "npm run build:release",
-    "build:addon:debug": "node-gyp rebuild --debug",
-    "build:addon:release": "node-gyp rebuild --release",
-    "build:types": "mkdir -p dist && cp lib/index.d.ts dist/index.d.ts",
-    "build:ts": "npm run build:cjs && npm run build:esm && npm run build:types",
-    "build:cjs": "tsc -p tsconfig.cjs.json && mv dist/cjs/index.js dist/cjs/index.cjs",
-    "build:esm": "tsc -p tsconfig.esm.json && mv dist/esm/index.js dist/esm/index.mjs",
-    "build:debug": "rm -rf dist && mkdir dist && npm run build:addon:debug && npm run build:cjs && npm run build:esm",
-    "build:release": "rm -rf dist && mkdir dist && npm run build:addon:release && npm run build:cjs && npm run build:esm",
-    "build:examples": "npm run build && npx tsc -p tsconfig.examples.json",
-    "example:recognize": "npm run build:examples && node dist/examples/recognize.js"
+    "install": "cmake-js compile",
+    "build:ts": "tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json && mkdir -p dist && mv dist/cjs/index.js dist/cjs/index.cjs && mv dist/esm/index.js dist/esm/index.mjs",
+    "build:debug": "cmake-js compile --debug && npm run build:ts",
+    "build:release": "cmake-js compile --release && npm run build:ts",
+    "example:recognize": "npm run build:debug && tsc -p tsconfig.examples.json && node -r dotenv/config dist/examples/recognize.js dotenv_config_path=.env.local",
+    "test:cpp": "cmake-js compile --release && ./build/release/node-tesseract-ocr-tests",
+    "test:js": "vitest run",
+    "test:js:watch": "vitest"
   },
   "files": [
     "dist/**",
     "prebuilds/**",
     "src/**",
-    "build/Release/*.node",
+    "build/release/*.node",
     "package.json",
-    "binding.gyp",
+    "CMakeLists.txt",
     "README.md",
     "LICENSE.md"
   ],
   "devDependencies": {
+    "vitest": "^2.1.9",
     "@types/node": "^22.0.0",
-    "node-addon-api": "^8.5.0",
-    "prebuildify": "^5.0.0",
-    "node-gyp": "^10.0.0",
     "typescript": "^5.6.0"
   },
   "dependencies": {
-    "node-gyp-build": "^4.0.0"
+    "cmake-js": "^7.4.0",
+    "node-addon-api": "^8.5.0",
+    "dotenv": "^16.4.5",
+    "pkg-prebuilds": "^1.0.0"
   },
   "exports": {
-    ".": {
-      "import": "./dist/esm/index.mjs",
-      "require": "./dist/cjs/index.cjs",
-      "types": "./dist/index.d.ts"
+    "require": {
+      "types": "./dist/cjs/index.d.ts",
+      "default": "./dist/cjs/index.cjs"
+    },
+    "import": {
+      "types": "./dist/esm/index.d.ts",
+      "default": "./dist/esm/index.mjs"
     }
   }
 }

package/src/addon.cpp

@@ -1,24 +1,9 @@
-/*
- * Copyright 2025 Philipp Czarnetzki
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
- * or implied. See the License for the specific language governing
- * permissions and limitations under the License.
- */
-
-#include "handle.h"
-#include <napi.h>
-
-Napi::Object InitAll(Napi::Env env, Napi::Object exports) {
-  return Handle::GetClass(env, exports);
-}
-
-NODE_API_MODULE(hello, InitAll)
+
+#include "tesseract_wrapper.hpp"
+#include <napi.h>
+
+Napi::Object Init(Napi::Env env, Napi::Object exports) {
+  return TesseractWrapper::InitAddon(env, exports);
+}
+
+NODE_API_MODULE(NODE_GYP_MODULE_NAME, Init)