@molecule/api-ocr-tesseract 1.0.0

package/LICENSE

@@ -0,0 +1,115 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work.
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship.
+
+      "Contribution" shall mean any work of authorship, including the
+      original version of the Work and any modifications or additions
+      to that Work, that is intentionally submitted to the Licensor for
+      inclusion in the Work by the copyright owner or by an individual or
+      Legal Entity authorized to submit on behalf of the copyright owner.
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      patent license to make, have made, use, offer to sell, sell, import,
+      and otherwise transfer the Work.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file.
+
+   5. Submission of Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.
+
+   8. Limitation of Liability. In no event and under no legal theory shall
+      any Contributor be liable to You for damages.
+
+   9. Accepting Warranty or Additional Liability.
+
+   Copyright 2026 Molecule Dev, Inc.
+
+   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.

package/README.md

@@ -0,0 +1,109 @@
+<!--
+AUTO-GENERATED — DO NOT EDIT THIS FILE.
+Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
+Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
+To change this document, edit the module-level JSDoc in src/index.ts.
+Generated: 2026-09-26T03:23:35.151Z
+-->
+
+# @molecule/api-ocr-tesseract
+
+> **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
+> It is written to be read by coding agents as much as by people, and is generated from this
+> package's source — edit `src/index.ts` JSDoc, not this file.
+
+Self-hosted Tesseract OCR provider for molecule.dev — text extraction from images in your own process, no vendor account, no per-call cost
+
+## Type
+
+`provider`
+
+## Installation
+
+```bash
+npm install @molecule/api-ocr-tesseract @molecule/api-ocr tesseract.js
+```
+
+## API
+
+### Interfaces
+
+#### `TesseractOcrConfig`
+
+Options for {@link createProvider}. Tesseract runs entirely in your process
+(a WASM worker thread) — no API key, no egress except the first download of
+a language's traineddata unless you point `langPath` at a local copy.
+
+```typescript
+interface TesseractOcrConfig {
+  /** Default Tesseract language code(s), `+`-joined (e.g. `eng`, `eng+deu`). Default `eng`. */
+  language?: string
+  /**
+   * Where traineddata files are downloaded from. Defaults to the tessdata CDN
+   * the library ships with. Point it at your own mirror or a local directory
+   * (`file://…` or a path the worker can read) for offline installs.
+   */
+  langPath?: string
+  /** Directory to cache downloaded traineddata in. Default: the OS temp dir. */
+  cachePath?: string
+  /**
+   * Whether to fetch `.traineddata.gz` (compressed). Default true; set false
+   * for a `langPath` that only serves uncompressed files.
+   */
+  gzip?: boolean
+}
+```
+
+### Functions
+
+#### `createProvider(config)`
+
+Creates a self-hosted Tesseract OCR provider.
+
+```typescript
+function createProvider(config?: TesseractOcrConfig): OcrProvider
+```
+
+- `config` — Default language and traineddata source.
+
+**Returns:** An `OcrProvider` backed by Tesseract in a worker thread.
+
+### Constants
+
+#### `provider`
+
+The provider implementation.
+
+```typescript
+const provider: OcrProvider
+```
+
+## Core Interface
+
+Implements `@molecule/api-ocr` interface.
+
+## Bond Wiring
+
+Setup function to register this provider with the core interface:
+
+```typescript
+import { setProvider } from '@molecule/api-ocr'
+import { provider } from '@molecule/api-ocr-tesseract'
+
+export function setupOcrTesseract(): void {
+  setProvider(provider)
+}
+```
+
+## Injection Notes
+
+### Requirements
+
+Peer dependencies:
+
+- `@molecule/api-ocr` >=1.0.0
+
+### Runtime Dependencies
+
+- `@molecule/api-ocr`
+- `tesseract.js`

package/dist/browser-guard.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=browser-guard.d.ts.map

package/dist/browser-guard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-guard.d.ts","sourceRoot":"","sources":["../src/browser-guard.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,CAAA"}

package/dist/browser-guard.js

@@ -0,0 +1,18 @@
+/**
+ * Browser guard — `@molecule/api-ocr-tesseract` is SERVER-ONLY.
+ *
+ * Generated by scripts/gen-browser-guards.mjs (workspace root) — edit THAT, not this.
+ * Evaluating a server package in a browser bundle is always an import-graph mistake
+ * (node APIs, secrets); without this guard it surfaces as a cryptic downstream crash
+ * ("Buffer is not defined") far from the culprit. Throwing here names the package and
+ * the fix at the exact moment the client bundle evaluates it. jsdom tests and SSR are
+ * unaffected: the throw requires browser globals AND the absence of a node runtime.
+ */
+const g = globalThis;
+if (g.window !== undefined && g.document !== undefined && !g.process?.versions?.node) {
+    throw new Error('@molecule/api-ocr-tesseract is SERVER-ONLY: it was bundled into browser/client code. Import it only ' +
+        'from server code (a server route/function or your API), or dynamic-import it inside ' +
+        'the server handler — never from components or shared client modules, and never ' +
+        'polyfill Buffer/process to silence this.');
+}
+export {};

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Self-hosted Tesseract OCR provider for molecule.dev.
+ *
+ * Implements the `@molecule/api-ocr` contract with Tesseract running in a
+ * worker thread inside your own process — no vendor account, no per-call cost,
+ * no egress after a language's traineddata is downloaded once. The eject path
+ * when a hosted or model-based OCR bond is more than a high-volume scan job
+ * needs.
+ *
+ * @example
+ * ```typescript
+ * import { setProvider, requireProvider } from '@molecule/api-ocr'
+ * import { createProvider } from '@molecule/api-ocr-tesseract'
+ *
+ * setProvider(createProvider({ language: 'eng' }))
+ *
+ * const result = await requireProvider().recognize({
+ *   data: new Uint8Array(scanBytes),
+ *   mimeType: 'image/png',
+ * })
+ * console.log(result.pages[0].confidence) // Tesseract's own 0–1 mean score
+ * await requireProvider().dispose?.()      // end of the batch: free the workers
+ * ```
+ *
+ * @remarks
+ * - **CPU-heavy work belongs in a worker process, not your request handler.**
+ *   Tesseract runs in its own worker THREAD, so the event loop is not blocked,
+ *   a recognition pass still takes seconds of CPU. For a high-volume API, put
+ *   the work behind a queue (e.g. `@molecule/api-cron` + a job table), not the
+ *   create/update handler.
+ * - **`language` is a TESSERACT code, not a BCP-47 tag** — `eng`, `deu`,
+ *   `eng+deu`. `en` fails traineddata lookup on first use. The first call in a
+ *   new language downloads its traineddata (a few MB, cached in `cachePath`);
+ *   point `langPath` at your own mirror for offline installs.
+ * - **Recognize at real size.** Tesseract wants ~300 DPI grayscale input; a
+ *   200×40 thumbnail of a word returns garbage. Do not downscale before this
+ *   bond the way you would before a vision model.
+ * - `confidence` is Tesseract's own mean over the page (0–1). Gate on it with
+ *   a threshold you calibrated on YOUR scans — clean screenshots score 0.9+,
+ *   photos of crumpled paper can score 0.4 and still be mostly right.
+ * - No layout model: column order, tables and multi-column pages come out in
+ *   reading-order guesses. For table structure, crop cells or use a
+ *   vision-model bond and compare.
+ */
+export * from './browser-guard.js';
+export * from './provider.js';
+export * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,cAAc,oBAAoB,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,YAAY,CAAA"}

package/dist/index.js

@@ -0,0 +1,47 @@
+/**
+ * Self-hosted Tesseract OCR provider for molecule.dev.
+ *
+ * Implements the `@molecule/api-ocr` contract with Tesseract running in a
+ * worker thread inside your own process — no vendor account, no per-call cost,
+ * no egress after a language's traineddata is downloaded once. The eject path
+ * when a hosted or model-based OCR bond is more than a high-volume scan job
+ * needs.
+ *
+ * @example
+ * ```typescript
+ * import { setProvider, requireProvider } from '@molecule/api-ocr'
+ * import { createProvider } from '@molecule/api-ocr-tesseract'
+ *
+ * setProvider(createProvider({ language: 'eng' }))
+ *
+ * const result = await requireProvider().recognize({
+ *   data: new Uint8Array(scanBytes),
+ *   mimeType: 'image/png',
+ * })
+ * console.log(result.pages[0].confidence) // Tesseract's own 0–1 mean score
+ * await requireProvider().dispose?.()      // end of the batch: free the workers
+ * ```
+ *
+ * @remarks
+ * - **CPU-heavy work belongs in a worker process, not your request handler.**
+ *   Tesseract runs in its own worker THREAD, so the event loop is not blocked,
+ *   a recognition pass still takes seconds of CPU. For a high-volume API, put
+ *   the work behind a queue (e.g. `@molecule/api-cron` + a job table), not the
+ *   create/update handler.
+ * - **`language` is a TESSERACT code, not a BCP-47 tag** — `eng`, `deu`,
+ *   `eng+deu`. `en` fails traineddata lookup on first use. The first call in a
+ *   new language downloads its traineddata (a few MB, cached in `cachePath`);
+ *   point `langPath` at your own mirror for offline installs.
+ * - **Recognize at real size.** Tesseract wants ~300 DPI grayscale input; a
+ *   200×40 thumbnail of a word returns garbage. Do not downscale before this
+ *   bond the way you would before a vision model.
+ * - `confidence` is Tesseract's own mean over the page (0–1). Gate on it with
+ *   a threshold you calibrated on YOUR scans — clean screenshots score 0.9+,
+ *   photos of crumpled paper can score 0.4 and still be mostly right.
+ * - No layout model: column order, tables and multi-column pages come out in
+ *   reading-order guesses. For table structure, crop cells or use a
+ *   vision-model bond and compare.
+ */
+export * from './browser-guard.js';
+export * from './provider.js';
+export * from './types.js';

package/dist/provider.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Self-hosted Tesseract implementation of OcrProvider.
+ *
+ * Runs Tesseract (Apache-2.0, code and traineddata weights) in a WASM worker
+ * thread inside your own process — no vendor account, no per-call egress after
+ * the first use of a language downloads its traineddata. Workers are created
+ * lazily per language (LSTM engine) and reused across calls; `dispose()`
+ * terminates them.
+ *
+ * @module
+ */
+import type { OcrProvider } from '@molecule/api-ocr';
+import type { TesseractOcrConfig } from './types.js';
+/**
+ * Creates a self-hosted Tesseract OCR provider.
+ *
+ * @param config - Default language and traineddata source.
+ * @returns An `OcrProvider` backed by Tesseract in a worker thread.
+ */
+export declare function createProvider(config?: TesseractOcrConfig): OcrProvider;
+/**
+ * The provider implementation.
+ */
+export declare const provider: OcrProvider;
+//# sourceMappingURL=provider.d.ts.map

package/dist/provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAIH,OAAO,KAAK,EAAwB,WAAW,EAAa,MAAM,mBAAmB,CAAA;AAErF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAuFpD;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,WAAW,CAEvE;AAID;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,WASrB,CAAA"}

package/dist/provider.js

@@ -0,0 +1,121 @@
+/**
+ * Self-hosted Tesseract implementation of OcrProvider.
+ *
+ * Runs Tesseract (Apache-2.0, code and traineddata weights) in a WASM worker
+ * thread inside your own process — no vendor account, no per-call egress after
+ * the first use of a language downloads its traineddata. Workers are created
+ * lazily per language (LSTM engine) and reused across calls; `dispose()`
+ * terminates them.
+ *
+ * @module
+ */
+import { createWorker } from 'tesseract.js';
+/**
+ * OCR provider backed by self-hosted Tesseract.
+ */
+class TesseractOcrProvider {
+    config;
+    name = 'tesseract';
+    workers = new Map();
+    /**
+     * Creates a new Tesseract OCR provider.
+     *
+     * @param config - Default language and where traineddata comes from.
+     */
+    constructor(config = {}) {
+        this.config = config;
+    }
+    /**
+     * Recognize text in one image.
+     *
+     * @param input - The image bytes and MIME type.
+     * @param options - Language hint as Tesseract traineddata code(s), e.g. `eng`
+     *   or `eng+deu` — a BCP-47 tag like `en` fails traineddata lookup.
+     * @returns One page with Tesseract's text and its own mean confidence.
+     */
+    async recognize(input, options) {
+        const language = options?.language ?? this.config.language ?? 'eng';
+        const worker = await this.worker(language);
+        const { data } = await worker.recognize(Buffer.from(input.data));
+        const text = data.text ?? '';
+        return {
+            text,
+            pages: [
+                {
+                    pageNumber: 1,
+                    text,
+                    ...(typeof data.confidence === 'number' ? { confidence: data.confidence / 100 } : {}),
+                },
+            ],
+        };
+    }
+    /**
+     * Terminates every worker thread this provider started.
+     */
+    async dispose() {
+        const pending = [...this.workers.values()];
+        this.workers.clear();
+        await Promise.allSettled(pending.map(async (p) => {
+            try {
+                await (await p).terminate();
+            }
+            catch (_error) {
+                // Intentional noop: a worker that already died is disposed as far as
+                // the caller cares — dispose() must not fail because one did.
+            }
+        }));
+    }
+    /**
+     * The worker for one language, created once and reused. A failed creation is
+     * dropped so the next call retries instead of caching the rejection.
+     *
+     * @param language - Tesseract language code(s).
+     * @returns The running worker.
+     */
+    worker(language) {
+        const existing = this.workers.get(language);
+        if (existing)
+            return existing;
+        // OEM 1 = LSTM-only: faster and more accurate than the legacy engine on
+        // the tessdata_fast/best packs.
+        const created = createWorker(language, 1, {
+            ...(this.config.langPath ? { langPath: this.config.langPath } : {}),
+            ...(this.config.cachePath ? { cachePath: this.config.cachePath } : {}),
+            ...(this.config.gzip !== undefined ? { gzip: this.config.gzip } : {}),
+        });
+        this.workers.set(language, created);
+        created.catch((_error) => {
+            // Intentional noop: a worker whose creation failed is dropped so the
+            // next call retries from scratch; the rejection already surfaced to the
+            // caller that triggered it.
+            this.workers.delete(language);
+        });
+        return created;
+    }
+}
+/**
+ * Creates a self-hosted Tesseract OCR provider.
+ *
+ * @param config - Default language and traineddata source.
+ * @returns An `OcrProvider` backed by Tesseract in a worker thread.
+ */
+export function createProvider(config) {
+    return new TesseractOcrProvider(config);
+}
+/** Lazily-initialized provider singleton. */
+let _provider = null;
+/**
+ * The provider implementation.
+ */
+export const provider = new Proxy({}, {
+    get(_, prop, receiver) {
+        if (!_provider)
+            _provider = createProvider();
+        return Reflect.get(_provider, prop, receiver);
+    },
+    set(_, prop, value) {
+        if (!_provider)
+            _provider = createProvider();
+        return Reflect.set(_provider, prop, value);
+    },
+});

package/dist/types.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Configuration types for the self-hosted Tesseract OCR provider.
+ *
+ * @module
+ */
+/**
+ * Options for {@link createProvider}. Tesseract runs entirely in your process
+ * (a WASM worker thread) — no API key, no egress except the first download of
+ * a language's traineddata unless you point `langPath` at a local copy.
+ */
+export interface TesseractOcrConfig {
+    /** Default Tesseract language code(s), `+`-joined (e.g. `eng`, `eng+deu`). Default `eng`. */
+    language?: string;
+    /**
+     * Where traineddata files are downloaded from. Defaults to the tessdata CDN
+     * the library ships with. Point it at your own mirror or a local directory
+     * (`file://…` or a path the worker can read) for offline installs.
+     */
+    langPath?: string;
+    /** Directory to cache downloaded traineddata in. Default: the OS temp dir. */
+    cachePath?: string;
+    /**
+     * Whether to fetch `.traineddata.gz` (compressed). Default true; set false
+     * for a `langPath` that only serves uncompressed files.
+     */
+    gzip?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,6FAA6F;IAC7F,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,8EAA8E;IAC9E,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;CACf"}

package/dist/types.js

@@ -0,0 +1,6 @@
+/**
+ * Configuration types for the self-hosted Tesseract OCR provider.
+ *
+ * @module
+ */
+export {};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@molecule/api-ocr-tesseract",
+  "version": "1.0.0",
+  "description": "Self-hosted Tesseract OCR provider for molecule.dev — text extraction from images in your own process, no vendor account, no per-call cost",
+  "homepage": "https://www.molecule.dev/packages/api-ocr-tesseract",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "molecule",
+    "ocr",
+    "tesseract",
+    "self-hosted",
+    "text-recognition"
+  ],
+  "license": "Apache-2.0",
+  "dependencies": {
+    "tesseract.js": "7.0.0"
+  },
+  "peerDependencies": {
+    "@molecule/api-ocr": ">=1.0.0"
+  },
+  "devDependencies": {
+    "@molecule/api-ocr": "1.0.0",
+    "@types/node": "26.1.2",
+    "typescript": "6.0.3",
+    "vitest": "4.1.11"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/molecule-dev/molecule.git",
+    "directory": "packages/api/bonds/ocr/tesseract"
+  },
+  "author": "Molecule Dev, Inc. (https://molecule.dev)"
+}