mindee 5.0.0-alpha1 → 5.0.0-alpha2

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # CHANGELOG
 
+## 5.0.0-alpha2 - 2026-01-16
+### Changes
+* :recycle: use node test methods
+* :recycle: v1 ocr word should be a class
+* :recycle: make v2 products top level
+* :bug: fix for optional node-poppler
+
+
+## 5.0.0-alpha1 - 2026-01-13
+### :boom: :recycle: base for v5
+* :arrow_up: update file-type
+* :recycle: migrate to ES modules (node18)
+* :coffin: remove support for obsolete/unused products:
+  * API builder (no longer maintained, use v2)
+* :coffin: remove support for unused products available in v2:
+  * nutrition facts
+  * business card
+  * US healthcare cards
+  * bill of lading
+* :coffin: remove support for unused products:
+  * delivery note
+  * payslip_fra_v2_async
+  * idcard_fr_v1
+  * ind_passport_v1_async
+  * us_mail_v3_async
+  * energy_bill_fra_v1_async
+  * french_healthcard_v1_async
+  * payslip_fra_v3_async
+* :recycle: use undici for HTTP requests and mocking
+* :sparkles: add ability for a user to specify their own undici `Dispatcher` instance
+* :sparkles: add basic V2 CLI
+* :recycle: :boom: rework of directory structure
+* :recycle: :boom: rework input source errors
+* :sparkles: handle abort signal stream inputs
+* :sparkles: add support for all utility products
+* :boom: :sparkles:  move PDF and image libraries to optional dependencies
+
+
 ## v4.36.3 - 2026-01-20
 ### Fixes
 * :bug: fix streams not loading properly

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "5.0.0-alpha1",
+    "version": "5.0.0-alpha2",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",
@@ -10,16 +10,13 @@
         "build": "tsc --build && tsc-alias",
         "build-for-dist": "tsc --build && tsc-alias && cp LICENSE README.md CHANGELOG.md ./dist",
         "clean": "rm -rf ./dist ./docs/_build",
-        "test": "mocha --grep \"#omitOptionalDeps\" --invert \"tests/**/*.spec.ts\"",
-        "test-light": "mocha --grep \"#includeOptionalDeps\" --invert \"tests/**/*.spec.ts\"",
-        "test-integration": "mocha --grep \"#omitOptionalDeps\" --invert \"tests/**/*.integration.ts\"",
-        "test-integration-light": "mocha --grep \"#includeOptionalDeps\" --invert \"tests/**/*.integration.ts\"",
-        "test-v1": "mocha --grep \"#omitOptionalDeps\" --invert \"tests/v1/**/*.spec.ts\"",
-        "test-v1-light": "mocha --grep \"#includeOptionalDeps\" --invert \"tests/v1/**/*.spec.ts\"",
-        "test-v2": "mocha --grep \"#omitOptionalDeps\" --invert \"tests/v2/**/*.spec.ts\"",
-        "test-v2-light": "mocha --grep \"#includeOptionalDeps\" --invert \"tests/v2/**/*.spec.ts\"",
-        "lint": "tsc --noEmit && eslint './src/**/*.ts' --report-unused-disable-directives && echo 'Your .ts files look good.'",
-        "lint-fix": "eslint './src/**/*.ts' --fix",
+        "test": "mocha --grep '#OptionalDepsRemoved' --invert 'tests/**/*.spec.ts'",
+        "test-light": "mocha --grep '#OptionalDepsRequired' --invert 'tests/**/*.spec.ts'",
+        "test-integration": "mocha --grep '#OptionalDepsRemoved' --invert 'tests/**/*.integration.ts'",
+        "test-integration-light": "mocha --grep '#OptionalDepsRequired' --invert 'tests/**/*.integration.ts'",
+        "test-v2": "tsc --noEmit && node --import tsx --test 'tests/v2/**/*.spec.ts'",
+        "lint": "tsc --noEmit && eslint --report-unused-disable-directives './src/**/*.ts' './tests/**/*.ts'",
+        "lint-fix": "eslint --fix --report-unused-disable-directives './src/**/*.ts' './tests/**/*.ts'",
         "docs": "typedoc --out docs/_build ./src/index.ts",
         "docs-for-dist": "typedoc --out docs/_build ./src/index.ts && cp -r ./docs/code_samples ./docs/_build/"
     },
@@ -47,25 +44,22 @@
     },
     "homepage": "https://mindee.com/",
     "devDependencies": {
-        "@types/chai": "^5.2.3",
         "@types/mocha": "^10.0.10",
         "@types/node": "^18.19.130",
         "@types/tmp": "^0.2.6",
-        "@typescript-eslint/eslint-plugin": "^8.52.0",
-        "@typescript-eslint/parser": "^8.52.0",
-        "chai": "^6.2.2",
+        "@typescript-eslint/eslint-plugin": "^8.55.0",
+        "@typescript-eslint/parser": "^8.55.0",
         "eslint": "^9.39.2",
-        "eslint-plugin-jsdoc": "^50.6.17",
+        "eslint-plugin-jsdoc": "^52.0.4",
         "mocha": "^11.7.5",
         "tsc-alias": "^1.8.16",
         "tsx": "^4.21.0",
-        "typedoc": "~0.28.15",
+        "typedoc": "~0.28.16",
         "typescript": "^5.9.3"
     },
     "dependencies": {
         "commander": "~9.4.1",
         "file-type": "^19.6.0",
-        "node-poppler": "^7.2.4",
         "tmp": "^0.2.3",
         "tslib": "^2.8.1",
         "undici": "^6.23.0"
@@ -73,7 +67,8 @@
     "optionalDependencies": {
         "sharp": "~0.34.5",
         "@cantoo/pdf-lib": "^2.3.2",
-        "pdf.js-extract": "^0.2.1"
+        "pdf.js-extract": "^0.2.1",
+        "node-poppler": "^7.2.4"
     },
     "keywords": [
         "typescript",

package/src/geometry/bbox.d.ts

@@ -0,0 +1,9 @@
+/** A simple bounding box defined by 4 coordinates: xMin, yMin, xMax, yMax */
+export declare class BBox {
+    xMin: number;
+    yMin: number;
+    xMax: number;
+    yMax: number;
+    constructor(xMin: number, yMin: number, xMax: number, yMax: number);
+    mergeBbox(bbox: BBox): BBox;
+}

package/src/geometry/bbox.js

@@ -0,0 +1,13 @@
+import { mergeBbox } from "../geometry/boundingBoxUtils.js";
+/** A simple bounding box defined by 4 coordinates: xMin, yMin, xMax, yMax */
+export class BBox {
+    constructor(xMin, yMin, xMax, yMax) {
+        this.xMin = xMin;
+        this.yMin = yMin;
+        this.xMax = xMax;
+        this.yMax = yMax;
+    }
+    mergeBbox(bbox) {
+        return mergeBbox(this, bbox);
+    }
+}

package/src/geometry/boundingBox.d.ts

@@ -1,13 +1,5 @@
 import { Point } from "./point.js";
 import { Polygon } from "./polygon.js";
-/** A simple bounding box defined by 4 coordinates: xMin, yMin, xMax, yMax */
-export declare class BBox {
-    xMin: number;
-    yMin: number;
-    xMax: number;
-    yMax: number;
-    constructor(xMin: number, yMin: number, xMax: number, yMax: number);
-}
 /** A bounding box defined by 4 points. */
 export declare class BoundingBox extends Polygon {
     constructor(topLeft: Point, topRight: Point, bottomRight: Point, bottomLeft: Point);

package/src/geometry/boundingBox.js

@@ -1,13 +1,4 @@
 import { Polygon } from "./polygon.js";
-/** A simple bounding box defined by 4 coordinates: xMin, yMin, xMax, yMax */
-export class BBox {
-    constructor(xMin, yMin, xMax, yMax) {
-        this.xMin = xMin;
-        this.yMin = yMin;
-        this.xMax = xMax;
-        this.yMax = yMax;
-    }
-}
 /** A bounding box defined by 4 points. */
 export class BoundingBox extends Polygon {
     constructor(topLeft, topRight, bottomRight, bottomLeft) {

package/src/geometry/boundingBoxUtils.d.ts

@@ -1,4 +1,5 @@
-import { BoundingBox, BBox } from "./boundingBox.js";
+import { BoundingBox } from "./boundingBox.js";
+import { BBox } from "./bbox.js";
 import { Polygon } from "./polygon.js";
 /**
  * Given a Polygon, calculate a polygon that encompasses all points.

package/src/geometry/boundingBoxUtils.js

@@ -1,4 +1,5 @@
-import { BoundingBox, BBox } from "./boundingBox.js";
+import { BoundingBox } from "./boundingBox.js";
+import { BBox } from "./bbox.js";
 /**
  * Given a Polygon, calculate a polygon that encompasses all points.
  */

package/src/geometry/index.d.ts

@@ -1,6 +1,7 @@
 export { Polygon } from "./polygon.js";
 export { compareOnX, compareOnY, getCentroid, isPointInPolygonX, isPointInPolygonY, relativeX, relativeY, getMinMaxX, getMinMaxY, } from "./polygonUtils.js";
-export { BoundingBox, BBox } from "./boundingBox.js";
+export { BoundingBox } from "./boundingBox.js";
+export { BBox } from "./bbox.js";
 export { getBbox, getBBoxForPolygons, getBoundingBox, getBoundingBoxFromBBox, mergeBbox, } from "./boundingBoxUtils.js";
 export type { MinMax } from "./minMax.js";
 export type { Point } from "./point.js";

package/src/geometry/index.js

@@ -1,4 +1,5 @@
 export { Polygon } from "./polygon.js";
 export { compareOnX, compareOnY, getCentroid, isPointInPolygonX, isPointInPolygonY, relativeX, relativeY, getMinMaxX, getMinMaxY, } from "./polygonUtils.js";
-export { BoundingBox, BBox } from "./boundingBox.js";
+export { BoundingBox } from "./boundingBox.js";
+export { BBox } from "./bbox.js";
 export { getBbox, getBBoxForPolygons, getBoundingBox, getBoundingBoxFromBBox, mergeBbox, } from "./boundingBoxUtils.js";

package/src/image/extractedImage.js

@@ -1,10 +1,10 @@
 import { Buffer } from "node:buffer";
 import { MindeeError } from "../errors/index.js";
 import { writeFileSync } from "node:fs";
+import { writeFile } from "fs/promises";
 import path from "node:path";
-import { logger } from "../logger.js";
 import { BufferInput, MIMETYPES } from "../input/index.js";
-import { writeFile } from "fs/promises";
+import { logger } from "../logger.js";
 import { loadOptionalDependency } from "../dependency/index.js";
 /**
  * Generic class for image extraction

package/src/index.d.ts

@@ -1,7 +1,10 @@
 export { InputSource, Base64Input, BufferInput, BytesInput, PathInput, StreamInput, UrlInput, PageOptionsOperation, } from "./input/index.js";
 export type { PageOptions } from "./input/index.js";
 export * as image from "./image/index.js";
+export * as pdf from "./pdf/index.js";
+export * as geometry from "./geometry/index.js";
 export * as v1 from "./v1/index.js";
 export * as v2 from "./v2/index.js";
-export { Client, InferenceFile, InferenceModel, JobResponse, ErrorResponse, } from "./v2/index.js";
+export * as product from "./v2/product/index.js";
+export { Client, JobResponse, ErrorResponse, } from "./v2/index.js";
 export type { PollingOptions } from "./v2/index.js";

package/src/index.js

@@ -1,7 +1,12 @@
+// Core
 export { InputSource, Base64Input, BufferInput, BytesInput, PathInput, StreamInput, UrlInput, PageOptionsOperation, } from "./input/index.js";
 export * as image from "./image/index.js";
+export * as pdf from "./pdf/index.js";
+export * as geometry from "./geometry/index.js";
 // V1
 export * as v1 from "./v1/index.js";
 // V2
 export * as v2 from "./v2/index.js";
-export { Client, InferenceFile, InferenceModel, JobResponse, ErrorResponse, } from "./v2/index.js";
+// Consider v2 the default
+export * as product from "./v2/product/index.js";
+export { Client, JobResponse, ErrorResponse, } from "./v2/index.js";

package/src/pdf/pdfCompressor.js

@@ -1,9 +1,9 @@
 import { logger } from "../logger.js";
 import tmp from "tmp";
-import { extractTextFromPdf, hasSourceText } from "./pdfUtils.js";
 import * as fs from "node:fs";
 import { compressImage } from "../image/index.js";
 import { loadOptionalDependency } from "../dependency/index.js";
+import { extractTextFromPdf, hasSourceText } from "./pdfUtils.js";
 let pdfLib = null;
 async function getPdfLib() {
     if (!pdfLib) {
@@ -33,8 +33,8 @@ export async function compressPdf(pdfData, imageQuality = 85, forceSourceTextCom
             }
         }
         else {
-            logger.warn("Found text inside of the provided PDF file. Compression operation aborted since disableSourceText "
-                + "is set to 'true'.");
+            logger.warn("Found text inside of the provided PDF file. " +
+                "Compression operation aborted since disableSourceText is set to 'true'.");
             return pdfData;
         }
     }

package/src/v1/parsing/common/ocrPage.js

@@ -4,7 +4,8 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _OcrPage_instances, _OcrPage_areWordsOnSameLine, _OcrPage_toLines;
-import { compareOnX, compareOnY, getCentroid, isPointInPolygonY, } from "../../../geometry/index.js";
+import { compareOnX, compareOnY, isPointInPolygonY, } from "../../../geometry/index.js";
+import { Word } from "../../../v1/parsing/standard/index.js";
 export class OcrPage {
     constructor(rawPrediction) {
         _OcrPage_instances.add(this);
@@ -15,7 +16,7 @@ export class OcrPage {
         const allWords = [];
         if (rawPrediction["all_words"]) {
             rawPrediction["all_words"].forEach((word) => {
-                allWords.push(word);
+                allWords.push(new Word(word));
             });
         }
         this.allWords = allWords.sort((word1, word2) => compareOnY(word1.polygon, word2.polygon));
@@ -40,8 +41,8 @@ export class OcrPage {
     }
 }
 _OcrPage_instances = new WeakSet(), _OcrPage_areWordsOnSameLine = function _OcrPage_areWordsOnSameLine(currentWord, nextWord) {
-    const currentInNext = isPointInPolygonY(getCentroid(currentWord.polygon), nextWord.polygon);
-    const nextInCurrent = isPointInPolygonY(getCentroid(nextWord.polygon), currentWord.polygon);
+    const currentInNext = isPointInPolygonY(currentWord.polygon.getCentroid(), nextWord.polygon);
+    const nextInCurrent = isPointInPolygonY(nextWord.polygon.getCentroid(), currentWord.polygon);
     return nextInCurrent || currentInNext;
 }, _OcrPage_toLines = function _OcrPage_toLines() {
     const lines = [];

package/src/v1/parsing/standard/index.d.ts

@@ -12,4 +12,4 @@ export { Taxes, TaxField } from "./tax.js";
 export { StringField } from "./text.js";
 export { PaymentDetailsField } from "./paymentDetails.js";
 export { PositionField } from "./position.js";
-export type { Word } from "./word.js";
+export { Word } from "./word.js";

package/src/v1/parsing/standard/index.js

@@ -11,3 +11,4 @@ export { Taxes, TaxField } from "./tax.js";
 export { StringField } from "./text.js";
 export { PaymentDetailsField } from "./paymentDetails.js";
 export { PositionField } from "./position.js";
+export { Word } from "./word.js";

package/src/v1/parsing/standard/word.d.ts

@@ -1,10 +1,12 @@
-import * as geometry from "../../../geometry/index.js";
-export type Word = {
+import { Polygon } from "../../../geometry/index.js";
+import { StringDict } from "../../../parsing/index.js";
+export declare class Word {
     /**
      * Contains the relative vertices coordinates (points) of a polygon containing
      * the field in the document.
      */
-    polygon: geometry.Polygon;
+    polygon: Polygon;
     text: string;
     confidence: number;
-};
+    constructor(rawPrediction: StringDict);
+}

package/src/v1/parsing/standard/word.js

@@ -1 +1,9 @@
-export {};
+import { Polygon } from "../../../geometry/index.js";
+export class Word {
+    constructor(rawPrediction) {
+        this.polygon = new Polygon(...rawPrediction["polygon"]);
+        this.text = rawPrediction["text"];
+        this.confidence = rawPrediction["confidence"];
+    }
+}
+;

package/src/v2/index.d.ts

@@ -1,7 +1,6 @@
 export * as http from "./http/index.js";
 export * as parsing from "./parsing/index.js";
 export * as product from "./product/index.js";
-export { LocalResponse } from "./parsing/localResponse.js";
 export { Client } from "./client.js";
-export { InferenceFile, InferenceModel, JobResponse, ErrorResponse, } from "./parsing/index.js";
-export type { PollingOptions } from "./client/index.js";
+export { JobResponse, ErrorResponse, LocalResponse, } from "./parsing/index.js";
+export type { PollingOptions, BaseParameters } from "./client/index.js";

package/src/v2/index.js

@@ -1,6 +1,5 @@
 export * as http from "./http/index.js";
 export * as parsing from "./parsing/index.js";
 export * as product from "./product/index.js";
-export { LocalResponse } from "./parsing/localResponse.js";
 export { Client } from "./client.js";
-export { InferenceFile, InferenceModel, JobResponse, ErrorResponse, } from "./parsing/index.js";
+export { JobResponse, ErrorResponse, LocalResponse, } from "./parsing/index.js";

package/src/v2/parsing/inference/baseInference.d.ts

@@ -1,5 +1,5 @@
 import { InferenceModel } from "./inferenceModel.js";
-import { InferenceFile } from "../../../v2/index.js";
+import { InferenceFile } from "./inferenceFile.js";
 import { StringDict } from "../../../parsing/index.js";
 export declare abstract class BaseInference {
     /**

package/src/v2/parsing/inference/baseInference.js

@@ -1,5 +1,5 @@
 import { InferenceModel } from "./inferenceModel.js";
-import { InferenceFile } from "../../../v2/index.js";
+import { InferenceFile } from "./inferenceFile.js";
 export class BaseInference {
     constructor(serverResponse) {
         this.id = serverResponse["id"];