@llamaindex/liteparse 1.0.0

package/dist/src/core/types.d.ts

@@ -0,0 +1,287 @@
+/**
+ * Supported output formats for parsed documents.
+ *
+ * - `"json"` — Structured JSON with per-page text items, bounding boxes, and metadata.
+ * - `"text"` — Plain text with spatial layout preserved.
+ */
+export type OutputFormat = "json" | "text";
+/**
+ * Configuration options for the {@link LiteParse} parser.
+ *
+ * All fields have sensible defaults. Pass a `Partial<LiteParseConfig>` to the
+ * constructor to override only the options you need.
+ *
+ * @example
+ * ```typescript
+ * const parser = new LiteParse({
+ *   ocrEnabled: true,
+ *   ocrLanguage: "fra",
+ *   dpi: 300,
+ *   outputFormat: "json",
+ * });
+ * ```
+ */
+export interface LiteParseConfig {
+    /**
+     * OCR language code(s). Uses ISO 639-3 codes for Tesseract (e.g., `"eng"`, `"fra"`)
+     * or ISO 639-1 for HTTP OCR servers (e.g., `"en"`, `"fr"`).
+     *
+     * @defaultValue `"en"`
+     */
+    ocrLanguage: string | string[];
+    /**
+     * Whether to run OCR on pages with little or no native text.
+     * When enabled, LiteParse selectively OCRs only images and text-sparse regions.
+     *
+     * @defaultValue `true`
+     */
+    ocrEnabled: boolean;
+    /**
+     * URL of an HTTP OCR server implementing the LiteParse OCR API.
+     * If not provided, the built-in Tesseract.js engine is used.
+     *
+     * @see {@link https://github.com/run-llama/liteparse/blob/main/OCR_API_SPEC.md | OCR API Specification}
+     */
+    ocrServerUrl?: string;
+    /**
+     * Number of pages to OCR in parallel. Higher values use more memory but
+     * process faster on multi-core machines.
+     *
+     * @defaultValue CPU cores - 1 (minimum 1)
+     */
+    numWorkers: number;
+    /**
+     * Maximum number of pages to parse from the document.
+     *
+     * @defaultValue `1000`
+     */
+    maxPages: number;
+    /**
+     * Specific pages to parse, as a comma-separated string of page numbers and ranges.
+     *
+     * @example `"1-5,10,15-20"`
+     */
+    targetPages?: string;
+    /**
+     * DPI (dots per inch) for rendering pages to images. Higher values improve
+     * OCR accuracy but increase processing time and memory usage.
+     *
+     * @defaultValue `150`
+     */
+    dpi: number;
+    /**
+     * Output format for parsed results.
+     *
+     * @defaultValue `"json"`
+     */
+    outputFormat: OutputFormat;
+    /**
+     * Calculate precise bounding boxes for each text line. Disable for faster
+     * parsing when bounding boxes aren't needed.
+     *
+     * @defaultValue `true`
+     */
+    preciseBoundingBox: boolean;
+    /**
+     * Preserve very small text that would normally be filtered out.
+     *
+     * @defaultValue `false`
+     */
+    preserveVerySmallText: boolean;
+    /**
+     * Maintain consistent text alignment across page boundaries.
+     *
+     * @defaultValue `false`
+     */
+    preserveLayoutAlignmentAcrossPages: boolean;
+}
+/**
+ * An individual text element extracted from a page, with position, size, and font metadata.
+ *
+ * Coordinates use the PDF coordinate system where the origin is at the top-left
+ * of the page, x increases to the right, and y increases downward.
+ */
+export interface TextItem {
+    /** The text content of this item. */
+    str: string;
+    /** X coordinate of the top-left corner, in PDF points. */
+    x: number;
+    /** Y coordinate of the top-left corner, in PDF points. */
+    y: number;
+    /** Width of the text item in PDF points. */
+    width: number;
+    /** Height of the text item in PDF points. */
+    height: number;
+    /** Alias for {@link TextItem.width | width}. */
+    w: number;
+    /** Alias for {@link TextItem.height | height}. */
+    h: number;
+    /** Font name (e.g., `"Helvetica"`, `"Times-Roman"`, `"OCR"` for OCR-detected text). */
+    fontName?: string;
+    /** Font size in PDF points. */
+    fontSize?: number;
+    /** Rotation angle in degrees. One of `0`, `90`, `180`, or `270`. */
+    r?: number;
+    /** X coordinate after rotation transformation. */
+    rx?: number;
+    /** Y coordinate after rotation transformation. */
+    ry?: number;
+    /** Markup annotations (highlights, underlines, etc.) applied to this text. */
+    markup?: MarkupData;
+    /** @internal Whether this item represents a vertical gap. */
+    vgap?: boolean;
+    /** @internal Whether this is a placeholder item used during layout. */
+    isPlaceholder?: boolean;
+}
+/**
+ * Markup annotation data associated with a text item.
+ */
+export interface MarkupData {
+    /** Highlight color (e.g., `"yellow"`, `"#FFFF00"`), or `undefined` if not highlighted. */
+    highlight?: string;
+    /** Whether the text is underlined. */
+    underline?: boolean;
+    /** Whether the text has a squiggly underline. */
+    squiggly?: boolean;
+    /** Whether the text is struck out. */
+    strikeout?: boolean;
+}
+export interface ProjectionTextBox {
+    str: string;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    rx?: number;
+    ry?: number;
+    r?: number;
+    strLength: number;
+    markup?: MarkupData;
+    pageBbox?: Coordinates;
+    vgap?: boolean;
+    isPlaceholder?: boolean;
+    fromOCR?: boolean;
+    snap?: "left" | "right" | "center";
+    leftAnchor?: string;
+    rightAnchor?: string;
+    centerAnchor?: string;
+    isDup?: boolean;
+    rendered?: boolean;
+    isMarginLineNumber?: boolean;
+    shouldSpace?: number;
+    forceUnsnapped?: boolean;
+    rotated?: boolean;
+    d?: number;
+}
+/**
+ * A rectangle defined by position and dimensions.
+ * @internal
+ */
+export interface Coordinates {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}
+/**
+ * Raw OCR detection result before conversion to {@link TextItem}.
+ * @internal
+ */
+export interface OcrData {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    /** Confidence score from 0.0 to 1.0. */
+    confidence: number;
+    /** Recognized text. */
+    text: string;
+}
+/**
+ * An axis-aligned bounding box defined by its top-left and bottom-right corners.
+ *
+ * All coordinates are in PDF points.
+ */
+export interface BoundingBox {
+    /** X coordinate of the top-left corner. */
+    x1: number;
+    /** Y coordinate of the top-left corner. */
+    y1: number;
+    /** X coordinate of the bottom-right corner. */
+    x2: number;
+    /** Y coordinate of the bottom-right corner. */
+    y2: number;
+}
+/**
+ * Parsed data for a single page of a document.
+ */
+export interface ParsedPage {
+    /** 1-indexed page number. */
+    pageNum: number;
+    /** Page width in PDF points. */
+    width: number;
+    /** Page height in PDF points. */
+    height: number;
+    /** Full text content of the page with spatial layout preserved. */
+    text: string;
+    /** Individual text elements extracted from the page. */
+    textItems: TextItem[];
+    /** Bounding boxes for text lines. Present when {@link LiteParseConfig.preciseBoundingBox} is enabled. */
+    boundingBoxes?: BoundingBox[];
+}
+/**
+ * Structured JSON representation of parsed document data.
+ * Returned when {@link LiteParseConfig.outputFormat} is `"json"`.
+ */
+export interface ParseResultJson {
+    /** Array of page data. */
+    pages: Array<{
+        /** 1-indexed page number. */
+        page: number;
+        /** Page width in PDF points. */
+        width: number;
+        /** Page height in PDF points. */
+        height: number;
+        /** Full text content of the page. */
+        text: string;
+        /** Individual text elements with position and font metadata. */
+        textItems: Array<{
+            text: string;
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+            fontName?: string;
+            fontSize?: number;
+        }>;
+        /** Bounding boxes for text lines. */
+        boundingBoxes: BoundingBox[];
+    }>;
+}
+/**
+ * The result of parsing a document with {@link LiteParse.parse}.
+ */
+export interface ParseResult {
+    /** Per-page parsed data. */
+    pages: ParsedPage[];
+    /** Full document text, concatenated from all pages. */
+    text: string;
+    /** Structured JSON data. Present when {@link LiteParseConfig.outputFormat} is `"json"`. */
+    json?: ParseResultJson;
+}
+/**
+ * The result of generating a screenshot with {@link LiteParse.screenshot}.
+ */
+export interface ScreenshotResult {
+    /** 1-indexed page number. */
+    pageNum: number;
+    /** Image width in pixels. */
+    width: number;
+    /** Image height in pixels. */
+    height: number;
+    /** Raw image data as a Node.js Buffer (PNG or JPG). */
+    imageBuffer: Buffer;
+    /** File path if the screenshot was saved to disk. */
+    imagePath?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/src/core/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/core/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC;AAE3C;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE/B;;;;;OAKG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;;;OAKG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;;;OAIG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;;;OAIG;IACH,kCAAkC,EAAE,OAAO,CAAC;CAC7C;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,qCAAqC;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,0DAA0D;IAC1D,CAAC,EAAE,MAAM,CAAC;IACV,0DAA0D;IAC1D,CAAC,EAAE,MAAM,CAAC;IACV,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAC;IACf,gDAAgD;IAChD,CAAC,EAAE,MAAM,CAAC;IACV,kDAAkD;IAClD,CAAC,EAAE,MAAM,CAAC;IACV,uFAAuF;IACvF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,+BAA+B;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,kDAAkD;IAClD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,kDAAkD;IAClD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,8EAA8E;IAC9E,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,6DAA6D;IAC7D,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,uEAAuE;IACvE,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,0FAA0F;IAC1F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iDAAiD;IACjD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sCAAsC;IACtC,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;IAGlB,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,2CAA2C;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,2CAA2C;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,yGAAyG;IACzG,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,0BAA0B;IAC1B,KAAK,EAAE,KAAK,CAAC;QACX,6BAA6B;QAC7B,IAAI,EAAE,MAAM,CAAC;QACb,gCAAgC;QAChC,KAAK,EAAE,MAAM,CAAC;QACd,iCAAiC;QACjC,MAAM,EAAE,MAAM,CAAC;QACf,qCAAqC;QACrC,IAAI,EAAE,MAAM,CAAC;QACb,gEAAgE;QAChE,SAAS,EAAE,KAAK,CAAC;YACf,IAAI,EAAE,MAAM,CAAC;YACb,CAAC,EAAE,MAAM,CAAC;YACV,CAAC,EAAE,MAAM,CAAC;YACV,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;YACf,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB,CAAC,CAAC;QACH,qCAAqC;QACrC,aAAa,EAAE,WAAW,EAAE,CAAC;KAC9B,CAAC,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,4BAA4B;IAC5B,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,uDAAuD;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,2FAA2F;IAC3F,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,8BAA8B;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,uDAAuD;IACvD,WAAW,EAAE,MAAM,CAAC;IACpB,qDAAqD;IACrD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/src/core/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/src/core/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/core/types.ts"],"names":[],"mappings":""}

package/dist/src/engines/ocr/http-simple.d.ts

@@ -0,0 +1,19 @@
+import { OcrEngine, OcrOptions, OcrResult } from "./interface.js";
+/**
+ * HTTP-based OCR engine that conforms to LiteParse OCR API specification.
+ *
+ * The server must implement the API defined in OCR_API_SPEC.md:
+ * - POST /ocr endpoint
+ * - Accepts multipart/form-data with 'file' and 'language' fields
+ * - Returns JSON: { results: [{ text, bbox: [x1,y1,x2,y2], confidence }] }
+ *
+ * See ocr/easyocr/ and ocr/paddleocr/ for example server implementations.
+ */
+export declare class HttpOcrEngine implements OcrEngine {
+    name: string;
+    private serverUrl;
+    constructor(serverUrl: string);
+    recognize(imagePath: string, options: OcrOptions): Promise<OcrResult[]>;
+    recognizeBatch(imagePaths: string[], options: OcrOptions): Promise<OcrResult[][]>;
+}
+//# sourceMappingURL=http-simple.d.ts.map

package/dist/src/engines/ocr/http-simple.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-simple.d.ts","sourceRoot":"","sources":["../../../../src/engines/ocr/http-simple.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAQlE;;;;;;;;;GASG;AACH,qBAAa,aAAc,YAAW,SAAS;IAC7C,IAAI,SAAc;IAClB,OAAO,CAAC,SAAS,CAAS;gBAEd,SAAS,EAAE,MAAM;IAIvB,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IA0CvE,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;CAQxF"}

package/dist/src/engines/ocr/http-simple.js

@@ -0,0 +1,63 @@
+import axios from "axios";
+import FormData from "form-data";
+import fs from "fs";
+/**
+ * HTTP-based OCR engine that conforms to LiteParse OCR API specification.
+ *
+ * The server must implement the API defined in OCR_API_SPEC.md:
+ * - POST /ocr endpoint
+ * - Accepts multipart/form-data with 'file' and 'language' fields
+ * - Returns JSON: { results: [{ text, bbox: [x1,y1,x2,y2], confidence }] }
+ *
+ * See ocr/easyocr/ and ocr/paddleocr/ for example server implementations.
+ */
+export class HttpOcrEngine {
+    name = "http-ocr";
+    serverUrl;
+    constructor(serverUrl) {
+        this.serverUrl = serverUrl;
+    }
+    async recognize(imagePath, options) {
+        try {
+            // Prepare request
+            const formData = new FormData();
+            formData.append("file", fs.createReadStream(imagePath));
+            const language = Array.isArray(options.language) ? options.language[0] : options.language;
+            formData.append("language", language);
+            // Make HTTP request
+            const response = await axios.post(this.serverUrl, formData, {
+                headers: formData.getHeaders(),
+                timeout: 60000,
+            });
+            // Parse response (conforming to OCR_API_SPEC.md)
+            const { results } = response.data;
+            if (!Array.isArray(results)) {
+                console.warn("OCR server response missing results array:", response.data);
+                return [];
+            }
+            return results.map((item) => ({
+                text: item.text,
+                bbox: item.bbox,
+                confidence: item.confidence,
+            }));
+        }
+        catch (error) {
+            if (axios.isAxiosError(error)) {
+                console.error(`OCR HTTP error for ${imagePath}:`, error.response?.status, error.response?.data?.error || error.message);
+            }
+            else {
+                console.error(`OCR error for ${imagePath}:`, error);
+            }
+            return [];
+        }
+    }
+    async recognizeBatch(imagePaths, options) {
+        const results = [];
+        for (const imagePath of imagePaths) {
+            const result = await this.recognize(imagePath, options);
+            results.push(result);
+        }
+        return results;
+    }
+}
+//# sourceMappingURL=http-simple.js.map

package/dist/src/engines/ocr/http-simple.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-simple.js","sourceRoot":"","sources":["../../../../src/engines/ocr/http-simple.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,QAAQ,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,MAAM,IAAI,CAAC;AASpB;;;;;;;;;GASG;AACH,MAAM,OAAO,aAAa;IACxB,IAAI,GAAG,UAAU,CAAC;IACV,SAAS,CAAS;IAE1B,YAAY,SAAiB;QAC3B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,SAAiB,EAAE,OAAmB;QACpD,IAAI,CAAC;YACH,kBAAkB;YAClB,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;YAChC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;YAExD,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC1F,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAEtC,oBAAoB;YACpB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE;gBAC1D,OAAO,EAAE,QAAQ,CAAC,UAAU,EAAE;gBAC9B,OAAO,EAAE,KAAK;aACf,CAAC,CAAC;YAEH,iDAAiD;YACjD,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC;YAElC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC5B,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAC1E,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,IAAyB,EAAE,EAAE,CAAC,CAAC;gBACjD,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,UAAU,EAAE,IAAI,CAAC,UAAU;aAC5B,CAAC,CAAC,CAAC;QACN,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9B,OAAO,CAAC,KAAK,CACX,sBAAsB,SAAS,GAAG,EAClC,KAAK,CAAC,QAAQ,EAAE,MAAM,EACtB,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,IAAI,KAAK,CAAC,OAAO,CAC7C,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,iBAAiB,SAAS,GAAG,EAAE,KAAK,CAAC,CAAC;YACtD,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,UAAoB,EAAE,OAAmB;QAC5D,MAAM,OAAO,GAAkB,EAAE,CAAC;QAClC,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YACxD,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;CACF"}

package/dist/src/engines/ocr/http-simple.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=http-simple.test.d.ts.map

package/dist/src/engines/ocr/http-simple.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-simple.test.d.ts","sourceRoot":"","sources":["../../../../src/engines/ocr/http-simple.test.ts"],"names":[],"mappings":""}

package/dist/src/engines/ocr/http-simple.test.js

@@ -0,0 +1,108 @@
+import { vi, describe, it, expect } from "vitest";
+import { PassThrough } from "stream";
+const mockStream = new PassThrough();
+const mockOcrItems = [
+    {
+        text: "Hello World",
+        bbox: [0, 0, 100, 20],
+        confidence: 0.99,
+    },
+    {
+        text: "Some text",
+        bbox: [0, 25, 100, 45],
+        confidence: 0.95,
+    },
+];
+vi.mock("fs", async () => {
+    const actual = await vi.importActual("fs");
+    return {
+        ...actual,
+        default: {
+            createReadStream: vi.fn(() => {
+                return mockStream;
+            }),
+        },
+    };
+});
+vi.mock("axios", async () => {
+    const actual = await vi.importActual("axios");
+    return {
+        default: {
+            ...actual,
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            post: vi.fn(async (url, _formData, _config) => {
+                if (url == "http://localhost:9999") {
+                    throw new actual.AxiosError("Endpoint not found", "404 Not Found");
+                }
+                else if (url == "http://localhost:10000") {
+                    throw new Error("Unrecheable server");
+                }
+                else if (url == "http://localhost:9998") {
+                    // not an array
+                    return {
+                        data: { results: mockOcrItems[0] },
+                    };
+                }
+                return {
+                    data: { results: mockOcrItems },
+                };
+            }),
+        },
+    };
+});
+import { HttpOcrEngine } from "./http-simple";
+describe("test OCR simple HTTP server (single image)", () => {
+    it("test server success", async () => {
+        const server = new HttpOcrEngine("http://localhost:8000");
+        expect(server.name).toBe("http-ocr");
+        const result = await server.recognize("cat.png", { language: "en" });
+        expect(result).toStrictEqual(mockOcrItems);
+    });
+    it("test server axios error", async () => {
+        const server = new HttpOcrEngine("http://localhost:9999");
+        const result = await server.recognize("cat.png", { language: "en" });
+        expect(result.length).toBe(0);
+    });
+    it("test server generic error", async () => {
+        const server = new HttpOcrEngine("http://localhost:10000");
+        const result = await server.recognize("cat.png", { language: "en" });
+        expect(result.length).toBe(0);
+    });
+    it("test server malformed response", async () => {
+        const server = new HttpOcrEngine("http://localhost:9998");
+        const result = await server.recognize("cat.png", { language: "en" });
+        expect(result.length).toBe(0);
+    });
+});
+describe("test OCR simple HTTP server (batch)", () => {
+    it("test server success", async () => {
+        const server = new HttpOcrEngine("http://localhost:8000");
+        const result = await server.recognizeBatch(["cat.png", "dog.png"], { language: "en" });
+        expect(result).toStrictEqual([mockOcrItems, mockOcrItems]);
+    });
+    it("test server axios error", async () => {
+        const server = new HttpOcrEngine("http://localhost:9999");
+        const result = await server.recognizeBatch(["cat.png", "dog.png"], { language: "en" });
+        expect(result.length).toBe(2);
+        for (const r of result) {
+            expect(r.length).toBe(0);
+        }
+    });
+    it("test server generic error", async () => {
+        const server = new HttpOcrEngine("http://localhost:10000");
+        const result = await server.recognizeBatch(["cat.png", "dog.png"], { language: "en" });
+        expect(result.length).toBe(2);
+        for (const r of result) {
+            expect(r.length).toBe(0);
+        }
+    });
+    it("test server malformed response", async () => {
+        const server = new HttpOcrEngine("http://localhost:9998");
+        const result = await server.recognizeBatch(["cat.png", "dog.png"], { language: "en" });
+        expect(result.length).toBe(2);
+        for (const r of result) {
+            expect(r.length).toBe(0);
+        }
+    });
+});
+//# sourceMappingURL=http-simple.test.js.map

package/dist/src/engines/ocr/http-simple.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-simple.test.js","sourceRoot":"","sources":["../../../../src/engines/ocr/http-simple.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAErC,MAAM,UAAU,GAAG,IAAI,WAAW,EAAE,CAAC;AACrC,MAAM,YAAY,GAAG;IACnB;QACE,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC;QACrB,UAAU,EAAE,IAAI;KACjB;IACD;QACE,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC;QACtB,UAAU,EAAE,IAAI;KACjB;CACF,CAAC;AAEF,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE;IACvB,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,YAAY,CAAsB,IAAI,CAAC,CAAC;IAChE,OAAO;QACL,GAAG,MAAM;QACT,OAAO,EAAE;YACP,gBAAgB,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE;gBAC3B,OAAO,UAAU,CAAC;YACpB,CAAC,CAAC;SACH;KACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;IAC1B,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,YAAY,CAAyB,OAAO,CAAC,CAAC;IACtE,OAAO;QACL,OAAO,EAAE;YACP,GAAG,MAAM;YACT,8DAA8D;YAC9D,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,GAAW,EAAE,SAA2B,EAAE,OAAyB,EAAE,EAAE;gBACxF,IAAI,GAAG,IAAI,uBAAuB,EAAE,CAAC;oBACnC,MAAM,IAAI,MAAM,CAAC,UAAU,CAAC,oBAAoB,EAAE,eAAe,CAAC,CAAC;gBACrE,CAAC;qBAAM,IAAI,GAAG,IAAI,wBAAwB,EAAE,CAAC;oBAC3C,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;gBACxC,CAAC;qBAAM,IAAI,GAAG,IAAI,uBAAuB,EAAE,CAAC;oBAC1C,eAAe;oBACf,OAAO;wBACL,IAAI,EAAE,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE;qBACnC,CAAC;gBACJ,CAAC;gBACD,OAAO;oBACL,IAAI,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE;iBAChC,CAAC;YACJ,CAAC,CAAC;SACH;KACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE9C,QAAQ,CAAC,4CAA4C,EAAE,GAAG,EAAE;IAC1D,EAAE,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;QACnC,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAC1D,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QACrE,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yBAAyB,EAAE,KAAK,IAAI,EAAE;QACvC,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QACrE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,wBAAwB,CAAC,CAAC;QAC3D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QACrE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC9C,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QACrE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,qCAAqC,EAAE,GAAG,EAAE;IACnD,EAAE,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;QACnC,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QACvF,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yBAAyB,EAAE,KAAK,IAAI,EAAE;QACvC,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QACvF,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC9B,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;YACvB,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,wBAAwB,CAAC,CAAC;QAC3D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QACvF,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC9B,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;YACvB,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC9C,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QACvF,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC9B,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;YACvB,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/engines/ocr/interface.d.ts

@@ -0,0 +1,15 @@
+export interface OcrEngine {
+    name: string;
+    recognize(imagePath: string, options: OcrOptions): Promise<OcrResult[]>;
+    recognizeBatch(imagePaths: string[], options: OcrOptions): Promise<OcrResult[][]>;
+}
+export interface OcrOptions {
+    language: string | string[];
+    correctRotation?: boolean;
+}
+export interface OcrResult {
+    text: string;
+    bbox: [number, number, number, number];
+    confidence: number;
+}
+//# sourceMappingURL=interface.d.ts.map

package/dist/src/engines/ocr/interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.d.ts","sourceRoot":"","sources":["../../../../src/engines/ocr/interface.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IACxE,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;CACnF;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC5B,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,UAAU,EAAE,MAAM,CAAC;CACpB"}

package/dist/src/engines/ocr/interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=interface.js.map

package/dist/src/engines/ocr/interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.js","sourceRoot":"","sources":["../../../../src/engines/ocr/interface.ts"],"names":[],"mappings":""}

package/dist/src/engines/ocr/tesseract.d.ts

@@ -0,0 +1,19 @@
+import { OcrEngine, OcrOptions, OcrResult } from "./interface.js";
+export declare class TesseractEngine implements OcrEngine {
+    name: string;
+    private scheduler?;
+    private workers;
+    private currentLanguage?;
+    private concurrency;
+    constructor(concurrency?: number);
+    initialize(language?: string): Promise<void>;
+    recognize(imagePath: string, options: OcrOptions): Promise<OcrResult[]>;
+    recognizeBatch(imagePaths: string[], options: OcrOptions): Promise<OcrResult[][]>;
+    terminate(): Promise<void>;
+    /**
+     * Normalize language codes to Tesseract format
+     * Common mappings: en->eng, fr->fra, de->deu, es->spa, zh->chi_sim, ja->jpn
+     */
+    private normalizeLanguage;
+}
+//# sourceMappingURL=tesseract.d.ts.map

package/dist/src/engines/ocr/tesseract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tesseract.d.ts","sourceRoot":"","sources":["../../../../src/engines/ocr/tesseract.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAElE,qBAAa,eAAgB,YAAW,SAAS;IAC/C,IAAI,SAAe;IACnB,OAAO,CAAC,SAAS,CAAC,CAAY;IAC9B,OAAO,CAAC,OAAO,CAAgB;IAC/B,OAAO,CAAC,eAAe,CAAC,CAAS;IACjC,OAAO,CAAC,WAAW,CAAS;gBAEhB,WAAW,GAAE,MAAU;IAI7B,UAAU,CAAC,QAAQ,GAAE,MAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBnD,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAiDvE,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;IAmBjF,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAShC;;;OAGG;IACH,OAAO,CAAC,iBAAiB;CAuB1B"}