@luii/node-tesseract-ocr 2.0.13 → 2.3.2

package/README.md

@@ -16,24 +16,23 @@ Native C++ addon for Node.js that exposes Tesseract OCR (`libtesseract-dev`) to
   - [Enums](#enums)
   - [Types](#types)
   - [Tesseract API](#tesseract-api)
-- [Example](#example)
 - [License](#license)
-- [Special Thanks](#special-thanks)
 
 ## Features
 
 - Native bindings to Tesseract (prebuilds via `pkg-prebuilds`)
 - Access to Tesseract enums and configuration from TypeScript
 - Progress callback and multiple output formats
+- Lazy download of missing traineddata (configurable)
 
 ## Prerequisites
 
 - nodejs
 - node-addon-api
 - c++ build toolchain (e.g. build-essentials)
-- libtesseract-dev
+- libtesseract-dev (exactly `5.5.2`)
 - libleptonica-dev
-- Tesseract training data (eng, deu, ...)
+- Tesseract training data (eng, deu, ...) or let the library handle that
 
 > See [Install](#install)
 
@@ -44,6 +43,15 @@ sudo apt update
 sudo apt install -y nodejs npm build-essential pkg-config libtesseract-dev libleptonica-dev tesseract-ocr-eng
 ```
 
+Verify the required Tesseract version:
+
+```bash
+pkg-config --modversion tesseract
+# expected: 5.5.2
+```
+
+If your distro ships another version, install/build `tesseract 5.5.2` and ensure `pkg-config` resolves that installation.
+
 ```bash
 git clone git@github.com:luii/node-tesseract-ocr.git
 cd node-tesseract-ocr
@@ -59,7 +67,9 @@ Install additional languages as needed, for example:
 sudo apt install -y tesseract-ocr-deu tesseract-ocr-eng tesseract-ocr-jpn
 ```
 
-If you install traineddata files manually, make sure `NODE_TESSERACT_DATAPATH` points to the directory that contains them (for example `/usr/share/tesseract-ocr/5/tessdata`).
+If you install traineddata files manually, make sure `TESSDATA_PREFIX` points to the directory that contains them (for example `/usr/share/tessdata`).
+
+If traineddata is missing, this package will download it lazily during `init` by default. You can control this behavior via `ensureTraineddata`, `cachePath`, and `dataPath`.
 
 ## Build
 
@@ -73,12 +83,14 @@ npm run build:release
 
 ## Start
 
-Set `NODE_TESSERACT_DATAPATH` to your traineddata directory (usually `/usr/share/tesseract-ocr/5/tessdata`).
+Set `TESSDATA_PREFIX` to your traineddata directory (usually `/usr/share/tesseract-ocr/5/tessdata` or `/usr/share/tessdata`).
 
 ```sh
-env NODE_TESSERACT_DATAPATH=/usr/share/tesseract-ocr/5/tessdata node path/to/your/app.js
+env TESSDATA_PREFIX=/usr/share/tessdata node path/to/your/app.js
 ```
 
+If you prefer automatic downloads, you can skip setting `TESSDATA_PREFIX` and let the default cache directory handle traineddata on first use.
+
 ## Scripts
 
 ```bash
@@ -86,9 +98,6 @@ env NODE_TESSERACT_DATAPATH=/usr/share/tesseract-ocr/5/tessdata node path/to/you
 npm run build:debug
 npm run build:release
 
-# Build precompiled binaries for distribution
-npm run prebuild
-
 # Run the JS example (builds debug first)
 npm run example:recognize
 
@@ -100,8 +109,73 @@ npm run test:js:watch
 
 ## Examples
 
+### Run Included Example
+
 ```sh
-env NODE_TESSERACT_DATAPATH=/usr/share/tesseract-ocr/5/tessdata npm run example:recognize
+env TESSDATA_PREFIX=/usr/share/tessdata npm run example:recognize
+```
+
+### Basic OCR (Local Traineddata)
+
+You can find a similar example in the `examples/` folder of the project.
+
+```ts
+import fs from "node:fs";
+import Tesseract, { OcrEngineModes } from "node-tesseract-ocr";
+
+process.env.TESSDATA_PREFIX = "/usr/share/tessdata/";
+
+async function main() {
+  const tesseract = new Tesseract();
+  await tesseract.init({
+    langs: ["eng"],
+  });
+
+  const buffer = fs.readFileSync("example1.png");
+  await tesseract.setImage(buffer);
+  await tesseract.recognize((info) => {
+    console.log(`Progress: ${info.percent}%`);
+  });
+
+  const text = await tesseract.getUTF8Text();
+  console.log(text);
+
+  await tesseract.end();
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});
+```
+
+### Lazy Traineddata Download (Default)
+
+```ts
+import fs from "node:fs";
+import Tesseract from "node-tesseract-ocr";
+
+async function main() {
+  const tesseract = new Tesseract();
+  await tesseract.init({
+    langs: ["eng"],
+    ensureTraineddata: true
+    dataPath: './tessdata-local'
+  });
+
+  const buffer = fs.readFileSync("example1.png");
+  await tesseract.setImage(buffer);
+  await tesseract.recognize();
+  const text = await tesseract.getUTF8Text();
+  console.log(text);
+
+  await tesseract.end();
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});
 ```
 
 ## Public API
@@ -151,13 +225,17 @@ Full list of page segmentation modes from Tesseract.
 
 #### `TesseractInitOptions`
 
-| Field                   | Type                                                                                                  | Optional | Default     | Description                             |
-| ----------------------- | ----------------------------------------------------------------------------------------------------- | -------- | ----------- | --------------------------------------- |
-| `lang`                  | [`Language[]`](#availablelanguages)                                                                   | Yes      | `undefined` | Languages to load as an array.          |
-| `oem`                   | [`OcrEngineMode`](#ocrenginemode)                                                                     | Yes      | `undefined` | OCR engine mode.                        |
-| `vars`                  | `Partial<Record<keyof ConfigurationVariables, ConfigurationVariables[keyof ConfigurationVariables]>>` | Yes      | `undefined` | Variables to set.                       |
-| `configs`               | `Array<string>`                                                                                       | Yes      | `undefined` | Tesseract config files to apply.        |
-| `setOnlyNonDebugParams` | `boolean`                                                                                             | Yes      | `undefined` | If true, only non-debug params are set. |
+| Field                   | Type                                                                                                  | Optional | Default                                | Description                             |
+| ----------------------- | ----------------------------------------------------------------------------------------------------- | -------- | -------------------------------------- | --------------------------------------- |
+| `langs`                 | [`Language[]`](#availablelanguages)                                                                   | Yes      | `undefined`                            | Languages to load as an array.          |
+| `oem`                   | [`OcrEngineMode`](#ocrenginemode)                                                                     | Yes      | `undefined`                            | OCR engine mode.                        |
+| `vars`                  | `Partial<Record<keyof ConfigurationVariables, ConfigurationVariables[keyof ConfigurationVariables]>>` | Yes      | `undefined`                            | Variables to set.                       |
+| `configs`               | `Array<string>`                                                                                       | Yes      | `undefined`                            | Tesseract config files to apply.        |
+| `setOnlyNonDebugParams` | `boolean`                                                                                             | Yes      | `undefined`                            | If true, only non-debug params are set. |
+| `ensureTraineddata`     | `boolean`                                                                                             | Yes      | `true`                                 | Download missing traineddata lazily.    |
+| `cachePath`             | `string`                                                                                              | Yes      | `~/.cache/node-tesseract-ocr/tessdata` | Cache directory for downloads.          |
+| `dataPath`              | `string`                                                                                              | Yes      | `TESSDATA_PREFIX` or `cachePath`       | Directory used by Tesseract for data.   |
+| `progressCallback`      | `(info: TrainingDataDownloadProgress) => void`                                                        | Yes      | `undefined`                            | Download progress callback.             |
 
 #### `TesseractSetRectangleOptions`
 
@@ -180,6 +258,18 @@ Full list of page segmentation modes from Tesseract.
 | `bottom`   | `number` | No       | n/a     | Bottom coordinate of current element bbox. |
 | `left`     | `number` | No       | n/a     | Left coordinate of current element bbox.   |
 
+#### `TesseractProcessPagesStatus`
+
+| Field             | Type      | Optional | Default | Description                                           |
+| ----------------- | --------- | -------- | ------- | ----------------------------------------------------- |
+| `active`          | `boolean` | No       | n/a     | Whether a multipage session is currently active.      |
+| `healthy`         | `boolean` | No       | n/a     | Whether the renderer is healthy.                      |
+| `processedPages`  | `number`  | No       | n/a     | Number of pages already processed in this session.    |
+| `nextPageIndex`   | `number`  | No       | n/a     | Zero-based index that will be used for the next page. |
+| `outputBase`      | `string`  | No       | n/a     | Effective output base used by the PDF renderer.       |
+| `timeoutMillisec` | `number`  | No       | n/a     | Timeout per page in milliseconds (`0` = unlimited).   |
+| `textonly`        | `boolean` | No       | n/a     | Whether text-only PDF mode is enabled.                |
+
 #### `DetectOrientationScriptResult`
 
 | Field                   | Type     | Optional | Default | Description                                        |
@@ -199,13 +289,92 @@ new Tesseract();
 
 Creates a new Tesseract instance.
 
+#### Initialization Requirements
+
+Call `init(...)` once before using OCR/engine-dependent methods.
+
+Methods that do **not** require `init(...)`:
+
+- `version()`
+- `isInitialized()`
+- `setInputName(...)`
+- `getInputName()`
+- `abortProcessPages()`
+- `getProcessPagesStatus()`
+- `document.abort()`
+- `document.status()`
+- `init(...)`
+- `end()`
+
+Methods that **require** `init(...)`:
+
+- `setInputImage(...)`
+- `getInputImage()`
+- `getSourceYResolution()`
+- `getDataPath()`
+- `setOutputName(...)`
+- `clearPersistentCache()`
+- `clearAdaptiveClassifier()`
+- `setImage(...)`
+- `getThresholdedImage()`
+- `getThresholdedImageScaleFactor()`
+- `setPageMode(...)`
+- `setRectangle(...)`
+- `setSourceResolution(...)`
+- `recognize(...)`
+- `detectOrientationScript()`
+- `meanTextConf()`
+- `allWordConfidences()`
+- `getPAGEText(...)`
+- `getLSTMBoxText(...)`
+- `getBoxText(...)`
+- `getWordStrBoxText(...)`
+- `getOSDText(...)`
+- `getUTF8Text()`
+- `getHOCRText(...)`
+- `getTSVText(...)`
+- `getUNLVText()`
+- `getALTOText(...)`
+- `getInitLanguages()`
+- `getLoadedLanguages()`
+- `getAvailableLanguages()`
+- `setDebugVariable(...)`
+- `setVariable(...)`
+- `getIntVariable(...)`
+- `getBoolVariable(...)`
+- `getDoubleVariable(...)`
+- `getStringVariable(...)`
+- `clear()`
+- `beginProcessPages(...)`
+- `addProcessPage(...)`
+- `finishProcessPages()`
+- `document.begin(...)`
+- `document.addPage(...)`
+- `document.finish()`
+
+#### version
+
+Returns the currently loaded libtesseract version string.
+
+```ts
+version(): Promise<string>
+```
+
+#### isInitialized
+
+Returns whether `init(...)` has already completed successfully and has not been reset via `end()`.
+
+```ts
+isInitialized(): Promise<boolean>
+```
+
 #### init
 
-Initializes Tesseract with language, engine mode, configs, and variables.
+Initializes the OCR engine with language, OEM, configs, and variables.
 
-| Name    | Type                                            | Optional | Default | Description             |
-| ------- | ----------------------------------------------- | -------- | ------- | ----------------------- |
-| options | [`TesseractInitOptions`](#tesseractinitoptions) | No       | n/a     | Initialization options. |
+| Name      | Type                                            | Optional | Default | Description             |
+| --------- | ----------------------------------------------- | -------- | ------- | ----------------------- |
+| `options` | [`TesseractInitOptions`](#tesseractinitoptions) | No       | n/a     | Initialization options. |
 
 ```ts
 init(options: TesseractInitOptions): Promise<void>
@@ -213,56 +382,282 @@ init(options: TesseractInitOptions): Promise<void>
 
 #### initForAnalysePage
 
-Initializes for layout analysis only.
+Initializes the engine in analysis-only mode.
 
 ```ts
 initForAnalysePage(): Promise<void>
 ```
 
-#### analysePage
+#### analyseLayout
 
-Runs the layout analysis.
+Runs page layout analysis on the current image.
 
-| Name              | Type    | Optional | Default | Description                     |
-| ----------------- | ------- | -------- | ------- | ------------------------------- |
-| mergeSimilarWords | boolean | No       | n/a     | Whether to merge similar words. |
+| Name                | Type      | Optional | Default | Description                                 |
+| ------------------- | --------- | -------- | ------- | ------------------------------------------- |
+| `mergeSimilarWords` | `boolean` | No       | n/a     | Merge similar words during layout analysis. |
 
 ```ts
-analysePage(mergeSimilarWords: boolean): Promise<void>
+analyseLayout(mergeSimilarWords: boolean): Promise<void>
+```
+
+#### setInputName
+
+Sets the source/input name used by renderer/training APIs.
+
+| Name        | Type     | Optional | Default | Description                                |
+| ----------- | -------- | -------- | ------- | ------------------------------------------ |
+| `inputName` | `string` | No       | n/a     | Input name used by renderer/training APIs. |
+
+```ts
+setInputName(inputName: string): Promise<void>
+```
+
+#### getInputName
+
+Returns the current input name from engine state.
+
+```ts
+getInputName(): Promise<string>
+```
+
+#### setInputImage
+
+Sets the encoded source image buffer.
+
+| Name     | Type     | Optional | Default | Description                  |
+| -------- | -------- | -------- | ------- | ---------------------------- |
+| `buffer` | `Buffer` | No       | n/a     | Encoded source image buffer. |
+
+```ts
+setInputImage(buffer: Buffer): Promise<void>
+```
+
+#### getInputImage
+
+Returns the current input image bytes.
+
+```ts
+getInputImage(): Promise<Buffer>
+```
+
+#### getSourceYResolution
+
+Returns source image Y resolution (DPI).
+
+```ts
+getSourceYResolution(): Promise<number>
+```
+
+#### getDataPath
+
+Returns the active tessdata path from the engine.
+
+```ts
+getDataPath(): Promise<string>
+```
+
+#### setOutputName
+
+Sets the output base name for renderer-based outputs.
+
+| Name         | Type     | Optional | Default | Description                            |
+| ------------ | -------- | -------- | ------- | -------------------------------------- |
+| `outputName` | `string` | No       | n/a     | Output base name for renderer outputs. |
+
+```ts
+setOutputName(outputName: string): Promise<void>
+```
+
+#### clearPersistentCache
+
+Clears global library-level caches (for example dictionaries).
+
+```ts
+clearPersistentCache(): Promise<void>
+```
+
+#### clearAdaptiveClassifier
+
+Cleans adaptive classifier state between pages/documents.
+
+```ts
+clearAdaptiveClassifier(): Promise<void>
+```
+
+#### setImage
+
+Sets the image used by OCR recognition.
+
+| Name     | Type     | Optional | Default | Description              |
+| -------- | -------- | -------- | ------- | ------------------------ |
+| `buffer` | `Buffer` | No       | n/a     | Image data used for OCR. |
+
+```ts
+setImage(buffer: Buffer): Promise<void>
+```
+
+#### getThresholdedImage
+
+Returns thresholded image bytes from Tesseract internals.
+
+```ts
+getThresholdedImage(): Promise<Buffer>
+```
+
+#### getThresholdedImageScaleFactor
+
+Returns scale factor for thresholded/component images.
+
+```ts
+getThresholdedImageScaleFactor(): Promise<number>
 ```
 
 #### setPageMode
 
-Sets the page segmentation mode.
+Sets the page segmentation mode (PSM).
 
-| Name | Type                                             | Optional | Default | Description             |
-| ---- | ------------------------------------------------ | -------- | ------- | ----------------------- |
-| psm  | [`PageSegmentationMode`](#pagesegmentationmodes) | No       | n/a     | Page segmentation mode. |
+| Name  | Type                                            | Optional | Default | Description             |
+| ----- | ----------------------------------------------- | -------- | ------- | ----------------------- |
+| `psm` | [`PageSegmentationMode`](#pagesegmentationmode) | No       | n/a     | Page segmentation mode. |
 
 ```ts
 setPageMode(psm: PageSegmentationMode): Promise<void>
 ```
 
+#### setRectangle
+
+Restricts recognition to the given rectangle.
+
+| Name      | Type                                                            | Optional | Default | Description        |
+| --------- | --------------------------------------------------------------- | -------- | ------- | ------------------ |
+| `options` | [`TesseractSetRectangleOptions`](#tesseractsetrectangleoptions) | No       | n/a     | Region definition. |
+
+```ts
+setRectangle(options: TesseractSetRectangleOptions): Promise<void>
+```
+
+#### setSourceResolution
+
+Sets the source resolution in PPI.
+
+| Name  | Type     | Optional | Default | Description               |
+| ----- | -------- | -------- | ------- | ------------------------- |
+| `ppi` | `number` | No       | n/a     | Source resolution in PPI. |
+
+```ts
+setSourceResolution(ppi: number): Promise<void>
+```
+
+#### document
+
+Facade for multipage PDF/document processing lifecycle.
+
+```ts
+document: {
+  begin(options: TesseractBeginProcessPagesOptions): Promise<void>;
+  addPage(buffer: Buffer, filename?: string): Promise<void>;
+  finish(): Promise<string>;
+  abort(): Promise<void>;
+  status(): Promise<TesseractProcessPagesStatus>;
+}
+```
+
+#### document.begin
+
+Starts a multipage processing session.
+
+| Name      | Type                                | Optional | Default | Description                 |
+| --------- | ----------------------------------- | -------- | ------- | --------------------------- |
+| `options` | `TesseractBeginProcessPagesOptions` | No       | n/a     | Multipage renderer options. |
+
+```ts
+document.begin(options: TesseractBeginProcessPagesOptions): Promise<void>
+```
+
+#### document.addPage
+
+Adds an encoded page to the active session.
+
+| Name       | Type     | Optional | Default     | Description                                                                                                                                                                                                                                                                                                                                         |
+| ---------- | -------- | -------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `buffer`   | `Buffer` | No       | n/a         | Encoded page image buffer.                                                                                                                                                                                                                                                                                                                          |
+| `filename` | `string` | Yes      | `undefined` | Optional source filename/path passed to Tesseract `ProcessPage` for this page. Tesseract/Leptonica may open this file internally and use it as the source image for parts of PDF rendering. If output pages look wrong (for example inverted or visually corrupted), pass a real image path here to force a stable source image path for that page. |
+
+```ts
+document.addPage(buffer: Buffer, filename?: string): Promise<void>
+```
+
+#### document.finish
+
+Finalizes the active session and returns output PDF path.
+
+```ts
+document.finish(): Promise<string>
+```
+
+#### document.abort
+
+Aborts and resets the active multipage session.
+
+```ts
+document.abort(): Promise<void>
+```
+
+#### document.status
+
+Returns the current multipage session status (active flag, page counters, and effective renderer settings).
+
+```ts
+document.status(): Promise<TesseractProcessPagesStatus>
+```
+
+#### getProcessPagesStatus
+
+Returns the current multipage session status from the instance API.
+
+```ts
+getProcessPagesStatus(): Promise<TesseractProcessPagesStatus>
+```
+
+#### setDebugVariable
+
+Sets a debug configuration variable.
+
+| Name    | Type                                                           | Optional | Default | Description     |
+| ------- | -------------------------------------------------------------- | -------- | ------- | --------------- |
+| `name`  | `keyof SetVariableConfigVariables`                             | No       | n/a     | Variable name.  |
+| `value` | `SetVariableConfigVariables[keyof SetVariableConfigVariables]` | No       | n/a     | Variable value. |
+
+```ts
+setDebugVariable(
+  name: keyof SetVariableConfigVariables,
+  value: SetVariableConfigVariables[keyof SetVariableConfigVariables],
+): Promise<boolean>
+```
+
 #### setVariable
 
-Sets a Tesseract variable. Returns `false` if the lookup failed.
+Sets a regular configuration variable.
 
-| Name  | Type                                                           | Optional | Default | Description     |
-| ----- | -------------------------------------------------------------- | -------- | ------- | --------------- |
-| name  | keyof SetVariableConfigVariables                               | No       | n/a     | Variable name.  |
-| value | SetVariableConfigVariables\[keyof SetVariableConfigVariables\] | No       | n/a     | Variable value. |
+| Name    | Type                                                           | Optional | Default | Description     |
+| ------- | -------------------------------------------------------------- | -------- | ------- | --------------- |
+| `name`  | `keyof SetVariableConfigVariables`                             | No       | n/a     | Variable name.  |
+| `value` | `SetVariableConfigVariables[keyof SetVariableConfigVariables]` | No       | n/a     | Variable value. |
 
 ```ts
-setVariable(name: keyof SetVariableConfigVariables, value: SetVariableConfigVariables[keyof SetVariableConfigVariables]): Promise<boolean>
+setVariable(
+  name: keyof SetVariableConfigVariables,
+  value: SetVariableConfigVariables[keyof SetVariableConfigVariables],
+): Promise<boolean>
 ```
 
 #### getIntVariable
 
-Reads an integer variable from Tesseract.
+Reads a configuration variable as integer.
 
-| Name | Type                             | Optional | Default | Description    |
-| ---- | -------------------------------- | -------- | ------- | -------------- |
-| name | keyof SetVariableConfigVariables | No       | n/a     | Variable name. |
+| Name   | Type                               | Optional | Default | Description    |
+| ------ | ---------------------------------- | -------- | ------- | -------------- |
+| `name` | `keyof SetVariableConfigVariables` | No       | n/a     | Variable name. |
 
 ```ts
 getIntVariable(name: keyof SetVariableConfigVariables): Promise<number>
@@ -270,11 +665,11 @@ getIntVariable(name: keyof SetVariableConfigVariables): Promise<number>
 
 #### getBoolVariable
 
-Reads a boolean variable from Tesseract. Returns `0` or `1`.
+Reads a configuration variable as boolean (`0`/`1`).
 
-| Name | Type                             | Optional | Default | Description    |
-| ---- | -------------------------------- | -------- | ------- | -------------- |
-| name | keyof SetVariableConfigVariables | No       | n/a     | Variable name. |
+| Name   | Type                               | Optional | Default | Description    |
+| ------ | ---------------------------------- | -------- | ------- | -------------- |
+| `name` | `keyof SetVariableConfigVariables` | No       | n/a     | Variable name. |
 
 ```ts
 getBoolVariable(name: keyof SetVariableConfigVariables): Promise<number>
@@ -282,11 +677,11 @@ getBoolVariable(name: keyof SetVariableConfigVariables): Promise<number>
 
 #### getDoubleVariable
 
-Reads a double variable from Tesseract.
+Reads a configuration variable as double.
 
-| Name | Type                             | Optional | Default | Description    |
-| ---- | -------------------------------- | -------- | ------- | -------------- |
-| name | keyof SetVariableConfigVariables | No       | n/a     | Variable name. |
+| Name   | Type                               | Optional | Default | Description    |
+| ------ | ---------------------------------- | -------- | ------- | -------------- |
+| `name` | `keyof SetVariableConfigVariables` | No       | n/a     | Variable name. |
 
 ```ts
 getDoubleVariable(name: keyof SetVariableConfigVariables): Promise<number>
@@ -294,139 +689,175 @@ getDoubleVariable(name: keyof SetVariableConfigVariables): Promise<number>
 
 #### getStringVariable
 
-Reads a string variable from Tesseract.
+Reads a configuration variable as string.
 
-| Name | Type                             | Optional | Default | Description    |
-| ---- | -------------------------------- | -------- | ------- | -------------- |
-| name | keyof SetVariableConfigVariables | No       | n/a     | Variable name. |
+| Name   | Type                               | Optional | Default | Description    |
+| ------ | ---------------------------------- | -------- | ------- | -------------- |
+| `name` | `keyof SetVariableConfigVariables` | No       | n/a     | Variable name. |
 
 ```ts
 getStringVariable(name: keyof SetVariableConfigVariables): Promise<string>
 ```
 
-#### setImage
+#### recognize
 
-Sets the image from a Buffer.
+Runs OCR recognition (optionally with progress callback).
 
-| Name   | Type   | Optional | Default | Description |
-| ------ | ------ | -------- | ------- | ----------- |
-| buffer | Buffer | No       | n/a     | Image data. |
+| Name               | Type                                  | Optional | Default     | Description            |
+| ------------------ | ------------------------------------- | -------- | ----------- | ---------------------- |
+| `progressCallback` | `(info: ProgressChangedInfo) => void` | Yes      | `undefined` | OCR progress callback. |
 
 ```ts
-setImage(buffer: Buffer): Promise<void>
+recognize(progressCallback?: (info: ProgressChangedInfo) => void): Promise<void>
 ```
 
-#### setRectangle
+#### detectOrientationScript
+
+Detects orientation and script with confidence values.
+
+```ts
+detectOrientationScript(): Promise<DetectOrientationScriptResult>
+```
 
-Sets the image region using coordinates and size.
+#### meanTextConf
 
-| Name    | Type                                                            | Optional | Default | Description        |
-| ------- | --------------------------------------------------------------- | -------- | ------- | ------------------ |
-| options | [`TesseractSetRectangleOptions`](#tesseractsetrectangleoptions) | No       | n/a     | Region definition. |
+Returns mean text confidence.
 
 ```ts
-setRectangle(options: TesseractSetRectangleOptions): Promise<void>
+meanTextConf(): Promise<number>
 ```
 
-#### setSourceResolution
+#### allWordConfidences
 
-Sets the source resolution in PPI.
+Returns all word confidences for current recognition result.
+
+```ts
+allWordConfidences(): Promise<number[]>
+```
+
+#### getPAGEText
 
-| Name | Type   | Optional | Default | Description      |
-| ---- | ------ | -------- | ------- | ---------------- |
-| ppi  | number | No       | n/a     | Pixels per inch. |
+Returns PAGE XML output.
+
+| Name               | Type                                  | Optional | Default     | Description                        |
+| ------------------ | ------------------------------------- | -------- | ----------- | ---------------------------------- |
+| `progressCallback` | `(info: ProgressChangedInfo) => void` | Yes      | `undefined` | PAGE generation progress callback. |
+| `pageNumber`       | `number`                              | Yes      | `undefined` | 0-based page number.               |
 
 ```ts
-setSourceResolution(ppi: number): Promise<void>
+getPAGEText(
+  progressCallback?: (info: ProgressChangedInfo) => void,
+  pageNumber?: number,
+): Promise<string>
 ```
 
-#### recognize
+#### getLSTMBoxText
 
-Starts OCR and calls the callback with progress info.
+Returns LSTM box output.
 
-| Name             | Type                                                          | Optional | Default | Description        |
-| ---------------- | ------------------------------------------------------------- | -------- | ------- | ------------------ |
-| progressCallback | (info: [`ProgressChangedInfo`](#progresschangedinfo)) => void | No       | n/a     | Progress callback. |
+| Name         | Type     | Optional | Default     | Description          |
+| ------------ | -------- | -------- | ----------- | -------------------- |
+| `pageNumber` | `number` | Yes      | `undefined` | 0-based page number. |
 
 ```ts
-recognize(progressCallback: (info: ProgressChangedInfo) => void): Promise<void>
+getLSTMBoxText(pageNumber?: number): Promise<string>
 ```
 
-#### getUTF8Text
+#### getBoxText
+
+Returns classic box output.
 
-Returns recognized text as UTF-8.
+| Name         | Type     | Optional | Default     | Description          |
+| ------------ | -------- | -------- | ----------- | -------------------- |
+| `pageNumber` | `number` | Yes      | `undefined` | 0-based page number. |
 
 ```ts
-getUTF8Text(): Promise<string>
+getBoxText(pageNumber?: number): Promise<string>
 ```
 
-#### getHOCRText
+#### getWordStrBoxText
 
-Returns HOCR output. Optional progress callback and page number.
+Returns WordStr box output.
 
-| Name             | Type                                                          | Optional | Default   | Description            |
-| ---------------- | ------------------------------------------------------------- | -------- | --------- | ---------------------- |
-| progressCallback | (info: [`ProgressChangedInfo`](#progresschangedinfo)) => void | Yes      | undefined | Progress callback.     |
-| pageNumber       | number                                                        | Yes      | undefined | Page number (0-based). |
+| Name         | Type     | Optional | Default     | Description          |
+| ------------ | -------- | -------- | ----------- | -------------------- |
+| `pageNumber` | `number` | Yes      | `undefined` | 0-based page number. |
 
 ```ts
-getHOCRText(
-  progressCallback?: (info: ProgressChangedInfo) => void,
-  pageNumber?: number,
-): Promise<string>
+getWordStrBoxText(pageNumber?: number): Promise<string>
 ```
 
-#### getTSVText
+#### getOSDText
 
-Returns TSV output.
+Returns OSD text output.
+
+| Name         | Type     | Optional | Default     | Description          |
+| ------------ | -------- | -------- | ----------- | -------------------- |
+| `pageNumber` | `number` | Yes      | `undefined` | 0-based page number. |
 
 ```ts
-getTSVText(): Promise<string>
+getOSDText(pageNumber?: number): Promise<string>
 ```
 
-#### getUNLVText
+#### getUTF8Text
 
-Returns UNLV output.
+Returns recognized UTF-8 text.
 
 ```ts
-getUNLVText(): Promise<string>
+getUTF8Text(): Promise<string>
 ```
 
-#### getALTOText
+#### getHOCRText
 
-Returns ALTO output. Optional progress callback and page number.
+Returns hOCR output.
 
-| Name             | Type                                                          | Optional | Default   | Description            |
-| ---------------- | ------------------------------------------------------------- | -------- | --------- | ---------------------- |
-| progressCallback | (info: [`ProgressChangedInfo`](#progresschangedinfo)) => void | Yes      | undefined | Progress callback.     |
-| pageNumber       | number                                                        | Yes      | undefined | Page number (0-based). |
+| Name               | Type                                  | Optional | Default     | Description                        |
+| ------------------ | ------------------------------------- | -------- | ----------- | ---------------------------------- |
+| `progressCallback` | `(info: ProgressChangedInfo) => void` | Yes      | `undefined` | hOCR generation progress callback. |
+| `pageNumber`       | `number`                              | Yes      | `undefined` | 0-based page number.               |
 
 ```ts
-getALTOText(
+getHOCRText(
   progressCallback?: (info: ProgressChangedInfo) => void,
   pageNumber?: number,
 ): Promise<string>
 ```
 
-#### detectOrientationScript
+#### getTSVText
+
+Returns TSV output.
 
-Detects orientation and script with confidences. Returns [`DetectOrientationScriptResult`](#detectorientationscriptresult).
+| Name         | Type     | Optional | Default     | Description          |
+| ------------ | -------- | -------- | ----------- | -------------------- |
+| `pageNumber` | `number` | Yes      | `undefined` | 0-based page number. |
 
 ```ts
-detectOrientationScript(): Promise<DetectOrientationScriptResult>
+getTSVText(pageNumber?: number): Promise<string>
 ```
 
-#### meanTextConf
+#### getUNLVText
 
-Mean text confidence (0-100).
+Returns UNLV output.
 
 ```ts
-meanTextConf(): Promise<number>
+getUNLVText(): Promise<string>
+```
+
+#### getALTOText
+
+Returns ALTO XML output.
+
+| Name         | Type     | Optional | Default     | Description          |
+| ------------ | -------- | -------- | ----------- | -------------------- |
+| `pageNumber` | `number` | Yes      | `undefined` | 0-based page number. |
+
+```ts
+getALTOText(pageNumber?: number): Promise<string>
 ```
 
 #### getInitLanguages
 
-Returns [`Language`](#availablelanguages) in raw Tesseract format (e.g. "deu+eng").
+Returns languages used during initialization (for example `deu+eng`).
 
 ```ts
 getInitLanguages(): Promise<string>
@@ -434,7 +865,7 @@ getInitLanguages(): Promise<string>
 
 #### getLoadedLanguages
 
-Returns [`Language[]`](#availablelanguages) in raw Tesseract format.
+Returns languages currently loaded in the engine.
 
 ```ts
 getLoadedLanguages(): Promise<Language[]>
@@ -442,7 +873,7 @@ getLoadedLanguages(): Promise<Language[]>
 
 #### getAvailableLanguages
 
-Returns [`Language[]`](#availablelanguages) in raw Tesseract format.
+Returns languages available from tessdata.
 
 ```ts
 getAvailableLanguages(): Promise<Language[]>
@@ -450,7 +881,7 @@ getAvailableLanguages(): Promise<Language[]>
 
 #### clear
 
-Clears internal state.
+Clears internal recognition state/results.
 
 ```ts
 clear(): Promise<void>
@@ -458,49 +889,12 @@ clear(): Promise<void>
 
 #### end
 
-Ends the instance.
+Releases native resources and ends the instance.
 
 ```ts
 end(): Promise<void>
 ```
 
-## Example
-
-You can find a similar example in the `examples/` folder of the project
-
-```ts
-import fs from "node:fs";
-import Tesseract, { OcrEngineModes } from "node-tesseract-ocr";
-
-async function main() {
-  const tesseract = new Tesseract();
-  await tesseract.init({
-    lang: ["eng"],
-    oem: OcrEngineModes.OEM_LSTM_ONLY,
-  });
-
-  const buffer = fs.readFileSync("example1.png");
-  await tesseract.setImage(buffer);
-  await tesseract.recognize((info) => {
-    console.log(`Progress: ${info.percent}%`);
-  });
-
-  const text = await tesseract.getUTF8Text();
-  console.log(text);
-
-  await tesseract.end();
-}
-
-main().catch((err) => {
-  console.error(err);
-  process.exit(1);
-});
-```
-
 ## License
 
 Apache-2.0. See [`LICENSE.md`](/LICENSE.md) for full terms.
-
-## Special Thanks
-
-- **Stunt3000**