@qvac/ocr-ggml 0.0.1 → 0.1.1

package/ocr-ggml.js

@@ -0,0 +1,121 @@
+'use strict'
+
+const { QvacErrorAddonOcrGgml, ERR_CODES } = require('./lib/error')
+
+/**
+ * Thin wrapper around the C++ bare addon. Mirrors the surface of
+ * `translation-nmtcpp`'s `marian.js` / `ocr-onnx`'s `ocr-fasttext.js`.
+ */
+class OcrGgmlInterface {
+  /**
+   * @param {Object} configurationParams - configuration for inference setup
+   * @param {Function} outputCb - invoked on inference events (output, error, stats)
+   * @param {Object|null} [transitionCb=null] - optional logger object with
+   *   `info`/`warn`/`error`/`debug` methods. When provided, C++ log lines are
+   *   forwarded via `binding.setLogger`.
+   */
+  constructor (binding, configurationParams, outputCb, transitionCb = null) {
+    this._binding = binding
+    this._handle = this._binding.createInstance(
+      this,
+      configurationParams,
+      outputCb
+    )
+
+    this._loggerInitialized = false
+    if (transitionCb && typeof transitionCb === 'object') {
+      this._binding.setLogger((priority, message) => {
+        const levels = ['error', 'warn', 'info', 'debug']
+        const level = levels[priority] || 'info'
+        if (typeof transitionCb[level] === 'function') {
+          transitionCb[level](message)
+        }
+      })
+      this._loggerInitialized = true
+    }
+  }
+
+  async destroyInstance () {
+    await this.destroy()
+  }
+
+  async unload () {
+    await this.destroy()
+  }
+
+  /**
+   * Moves the addon to LISTENING after construction-time work is finished.
+   */
+  async activate () {
+    try {
+      this._binding.activate(this._handle)
+    } catch (err) {
+      throw new QvacErrorAddonOcrGgml({
+        code: ERR_CODES.FAILED_TO_ACTIVATE,
+        adds: err.message,
+        cause: err
+      })
+    }
+  }
+
+  async cancel () {
+    try {
+      await this._binding.cancel(this._handle)
+    } catch (err) {
+      throw new QvacErrorAddonOcrGgml({
+        code: ERR_CODES.FAILED_TO_CANCEL,
+        adds: err.message,
+        cause: err
+      })
+    }
+  }
+
+  /**
+   * Submit an OCR inference job.
+   * @param {Object} data
+   * @param {'image'} data.type
+   * @param {Object} data.input - either `{ data, isEncoded: true }` for a
+   *   raw JPEG/PNG buffer, or `{ data, width, height }` for raw RGB pixels.
+   * @param {Object} [data.options]
+   * @param {boolean} [data.options.paragraph]
+   * @param {number} [data.options.boxMarginMultiplier]
+   * @param {number[]} [data.options.rotationAngles]
+   */
+  async runJob (data) {
+    try {
+      return this._binding.runJob(this._handle, data)
+    } catch (err) {
+      throw new QvacErrorAddonOcrGgml({
+        code: ERR_CODES.FAILED_TO_RUN_JOB,
+        adds: err.message,
+        cause: err
+      })
+    }
+  }
+
+  async destroy () {
+    if (this._handle === null) {
+      return
+    }
+
+    try {
+      if (this._loggerInitialized) {
+        this._binding.releaseLogger()
+        this._loggerInitialized = false
+      }
+
+      this._binding.destroyInstance(this._handle)
+      this._handle = null
+    } catch (err) {
+      throw new QvacErrorAddonOcrGgml({
+        code: ERR_CODES.FAILED_TO_DESTROY,
+        adds: err.message,
+        cause: err
+      })
+    }
+  }
+}
+
+module.exports = {
+  OcrGgmlInterface
+}

package/package.json

@@ -1,12 +1,101 @@
 {
   "name": "@qvac/ocr-ggml",
-  "version": "0.0.1",
-  "description": "qvac",
-  "license": "ISC",
-  "author": "",
-  "type": "commonjs",
-  "main": "index.js",
+  "version": "0.1.1",
+  "description": "GGML-backed OCR addon for qvac (EasyOCR pipeline on GGUF weights)",
+  "addon": true,
+  "engines": {
+    "bare": ">=1.19.0"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "bare-make generate && bare-make build && bare-make install",
+    "build:pack": "mkdir -p dist && npm pack --pack-destination dist",
+    "mobile:copy-prebuilds": "node ./scripts/copy-mobile-test-assets.js",
+    "mobile:generate-urls": "bash ./scripts/generate-ocr-ggml-presigned-urls.sh",
+    "lint": "standard",
+    "lint:fix": "standard --fix",
+    "lint-cpp": "clang-tidy -p build $(find addon/src -name '*.cpp')",
+    "test:unit:generate": "brittle -r test/unit/all.js test/unit/*.test.js",
+    "test:unit": "npm run test:unit:generate && bare test/unit/all.js --exit",
+    "test:integration:generate": "brittle -r test/integration/all.js test/integration/*.test.js && npm run test:mobile:generate",
+    "test:integration": "npm run test:integration:generate && bash test/integration/run-tests.sh",
+    "test:mobile:generate": "bare ./scripts/generate-mobile-integration-tests.js",
+    "test:mobile:validate": "node scripts/validate-mobile-tests.js",
+    "test": "npm run lint && npm run test:unit && npm run test:integration",
+    "test:dts": "tsc -p tsconfig.dts.json",
+    "test:cpp:build": "bare-make generate -D BUILD_TESTING=ON && bare-make build --target addon-test",
+    "test:cpp:run": "cd build/addon/tests/ && ./addon-test --gtest_output=xml:cpp-test-results.xml",
+    "test:cpp": "npm run test:cpp:build && npm run test:cpp:run",
+    "setup:venv": "bash scripts/setup-venv.sh",
+    "convert-model": "bash scripts/convert-model.sh",
+    "setup-models": "bash scripts/setup-venv.sh"
+  },
+  "files": [
+    "addonLogging.js",
+    "addonLogging.d.ts",
+    "binding.js",
+    "index.js",
+    "ocr-ggml.js",
+    "prebuilds",
+    "lib",
+    "index.d.ts",
+    "test/integration",
+    "test/mobile",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tetherto/qvac.git",
+    "directory": "packages/ocr-ggml"
+  },
+  "author": "Tether",
+  "keywords": [
+    "tether",
+    "addon",
+    "qvac",
+    "ocr",
+    "ggml",
+    "gguf",
+    "easyocr"
+  ],
+  "license": "Apache-2.0",
+  "bugs": "https://github.com/tetherto/qvac/issues",
+  "homepage": "https://github.com/tetherto/qvac/tree/main/packages/ocr-ggml#readme",
+  "devDependencies": {
+    "@qvac/registry-client": "^0.4.0",
+    "@types/node": "^24.2.1",
+    "bare-fetch": "^2.5.1",
+    "bare-fs": "^4.5.1",
+    "bare-path": "^3.0.0",
+    "bare-process": "^4.2.2",
+    "bare-stream": "^2.7.0",
+    "bare-subprocess": "^5.2.1",
+    "brittle": "^3.4.0",
+    "cmake-bare": "^1.7.5",
+    "cmake-vcpkg": "^1.1.0",
+    "standard": "^17.0.0",
+    "typescript": "^5.9.2"
+  },
+  "dependencies": {
+    "@qvac/error": "^0.1.0",
+    "@qvac/infer-base": "^0.4.0",
+    "@qvac/logging": "^0.1.0"
+  },
+  "exports": {
+    "./package": "./package.json",
+    ".": "./index.js",
+    "./addonLogging": {
+      "types": "./addonLogging.d.ts",
+      "default": "./addonLogging.js"
+    },
+    "./addonLogging.js": "./addonLogging.js"
+  },
+  "types": "index.d.ts",
+  "standard": {
+    "ignore": [
+      "build/**",
+      "prebuilds/**",
+      "examples/**"
+    ]
   }
 }