mindee 5.8.0 → 5.10.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Mindee Node.js API Library Changelog
 
+## v5.10.0 - 2026-09-23
+### Changes
+* :arrow_up: migrate to TypeScript 6.0
+* :arrow_up: bump output to ES2021
+
+
+## v5.9.0 - 2026-09-18
+### Changes
+* :sparkles: add RAG document CRUD
+* :wrench: add package.json exports field for proper ESM resolution
+
+
 ## v5.8.0 - 2026-09-17
 ### Changes
 * :sparkles: better logging of errors

package/package.json

@@ -1,98 +1,106 @@
 {
-    "name": "mindee",
-    "version": "5.8.0",
-    "description": "Mindee Client Library for Node.js",
-    "author": {
-        "name": "Mindee",
-        "email": "opensource@mindee.com",
-        "url": "https://mindee.com/"
+  "name": "mindee",
+  "version": "5.10.0",
+  "description": "Mindee Client Library for Node.js",
+  "author": {
+    "name": "Mindee",
+    "email": "opensource@mindee.com",
+    "url": "https://mindee.com/"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mindee/mindee-api-nodejs.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mindee/mindee-api-nodejs/issues"
+  },
+  "homepage": "https://mindee.com/",
+  "type": "module",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js",
+      "default": "./src/index.js"
     },
-    "license": "MIT",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/mindee/mindee-api-nodejs.git"
-    },
-    "bugs": {
-        "url": "https://github.com/mindee/mindee-api-nodejs/issues"
-    },
-    "homepage": "https://mindee.com/",
-    "type": "module",
-    "main": "src/index.js",
-    "bin": {
-        "mindeeV1": "bin/mindeeV1.js",
-        "mindeeV2": "bin/mindeeV2.js"
-    },
-    "scripts": {
-        "build": "tsc --build && tsc-alias",
-        "build:dist": "tsc --build && tsc-alias && cp LICENSE README.md CHANGELOG.md ./dist",
-        "clean": "rm -rf ./dist ./docs/_build",
-        "test": "node tests/runner.mjs spec",
-        "test:light": "node tests/runner.mjs spec",
-        "test:integration": "node tests/runner.mjs integration",
-        "test:integration:light": "node tests/runner.mjs integration",
-        "test:v2": "tsc --noEmit && node tests/runner.mjs spec v2",
-        "lint": "tsc --noEmit && eslint --report-unused-disable-directives './src/**/*.ts' './tests/**/*.ts'",
-        "lint:fix": "tsc --noEmit && eslint --fix --report-unused-disable-directives './src/**/*.ts' './tests/**/*.ts'",
-        "lint:package": "npm run build:dist && publint ./dist && attw --pack ./dist --profile esm-only",
-        "lint:secrets": "secretlint '**/*'",
-        "license:check": "license-checker-rseidelsohn --onlyAllow \"MIT;Apache-2.0;BSD-2-Clause;BSD-3-Clause;ISC;LGPL-3.0-or-later;Python-2.0;BlueOak-1.0.0;CC-BY-3.0;CC0-1.0;0BSD;LGPL-3.0-only;WTFPL;Artistic-2.0;Unlicense\"",
-        "docs": "typedoc --out docs/_build ./src/index.ts",
-        "docs:dist": "typedoc --out docs/_build ./src/index.ts && cp -r ./docs/code_samples ./docs/_build/",
-        "prepare": "husky"
-    },
-    "files": [
-        "src/*",
-        "bin/*",
-        "LICENSE",
-        "README.md",
-        "CHANGELOG.md"
-    ],
-    "engines": {
-        "node": ">= 20.1"
-    },
-    "dependencies": {
-        "commander": "^14.0.3",
-        "file-type": "^21.3.4",
-        "tmp": "^0.2.7",
-        "undici": ">=6.24.0 <7.0.0 || >=7.24.0 <8.0.0"
-    },
-    "optionalDependencies": {
-        "@cantoo/pdf-lib": "^2.5.3",
-        "node-poppler": "^9.1.1",
-        "pdf.js-extract": "~0.2.1",
-        "sharp": "^0.35.3"
-    },
-    "devDependencies": {
-        "@arethetypeswrong/cli": "^0.18.5",
-        "@eslint/eslintrc": "^3.3.5",
-        "@eslint/js": "^10.0.1",
-        "@secretlint/secretlint-rule-preset-recommend": "^13.0.4",
-        "@types/node": "^20.19.37",
-        "@types/tmp": "^0.2.6",
-        "@typescript-eslint/eslint-plugin": "^8.57.0",
-        "@typescript-eslint/parser": "^8.58.1",
-        "eslint": "^10.6.0",
-        "eslint-plugin-jsdoc": "^62.7.1",
-        "eslint-plugin-security": "^4.0.1",
-        "eslint-plugin-sonarjs": "^4.2.0",
-        "globals": "^17.4.0",
-        "husky": "^9.1.7",
-        "license-checker-rseidelsohn": "^4.4.2",
-        "publint": "^0.3.22",
-        "secretlint": "^13.0.4",
-        "tsc-alias": "^1.8.17",
-        "tslib": "^2.8.1",
-        "tsx": "^4.21.0",
-        "typedoc": "^0.28.18",
-        "typescript": "^5.9.3"
-    },
-    "keywords": [
-        "typescript",
-        "mindee",
-        "api",
-        "client",
-        "client library",
-        "nodejs",
-        "sdk"
-    ]
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "mindeeV1": "bin/mindeeV1.js",
+    "mindeeV2": "bin/mindeeV2.js"
+  },
+  "scripts": {
+    "build": "tsc --build && tsc-alias",
+    "build:dist": "tsc --build && tsc-alias && cp LICENSE README.md CHANGELOG.md package.json ./dist",
+    "clean": "rm -rf ./dist ./docs/_build",
+    "test": "node tests/runner.mjs spec",
+    "test:light": "node tests/runner.mjs spec",
+    "test:integration": "node tests/runner.mjs integration",
+    "test:integration:light": "node tests/runner.mjs integration",
+    "test:v2": "tsc -p tsconfig.test.json && node tests/runner.mjs spec v2",
+    "lint": "tsc -p tsconfig.test.json && eslint --report-unused-disable-directives './src/**/*.ts' './tests/**/*.ts'",
+    "lint:fix": "tsc -p tsconfig.test.json && eslint --fix --report-unused-disable-directives './src/**/*.ts' './tests/**/*.ts'",
+    "lint:package": "npm run build:dist && publint ./dist && attw --pack ./dist --profile esm-only",
+    "lint:secrets": "secretlint '**/*'",
+    "license:check": "license-checker-rseidelsohn --onlyAllow \"MIT;Apache-2.0;BSD-2-Clause;BSD-3-Clause;ISC;LGPL-3.0-or-later;LGPL-3.0-only;Python-2.0;BlueOak-1.0.0;CC-BY-3.0;CC-BY-4.0;CC0-1.0;0BSD;WTFPL;Artistic-2.0;Unlicense\"",
+    "docs": "typedoc --out docs/_build ./src/index.ts",
+    "docs:dist": "typedoc --out docs/_build ./src/index.ts && cp -r ./docs/code_samples ./docs/_build/",
+    "prepare": "husky"
+  },
+  "files": [
+    "src/*",
+    "bin/*",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "engines": {
+    "node": ">= 20.1"
+  },
+  "dependencies": {
+    "commander": "^14.0.3",
+    "file-type": "^21.3.4",
+    "tmp": "^0.2.7",
+    "undici": ">=6.24.0 <7.0.0 || >=7.24.0 <8.0.0"
+  },
+  "optionalDependencies": {
+    "@cantoo/pdf-lib": "^2.5.3",
+    "node-poppler": "^9.1.1",
+    "pdf.js-extract": "~0.2.1",
+    "sharp": "^0.35.3"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@eslint/js": "^10.0.1",
+    "@secretlint/secretlint-rule-preset-recommend": "^13.0.4",
+    "@types/node": "^20.19.37",
+    "@types/tmp": "^0.2.6",
+    "eslint": "^10.8.1",
+    "eslint-plugin-jsdoc": "^62.7.1",
+    "eslint-plugin-security": "^4.0.1",
+    "eslint-plugin-sonarjs": "^4.2.0",
+    "eslint-plugin-unicorn": "^75.0.0",
+    "globals": "^17.4.0",
+    "husky": "^9.1.7",
+    "license-checker-rseidelsohn": "^4.4.2",
+    "publint": "^0.3.22",
+    "secretlint": "^13.0.4",
+    "tsc-alias": "^1.9.5",
+    "tslib": "^2.8.1",
+    "tsx": "^4.21.0",
+    "typedoc": "^0.28.18",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.70.0"
+  },
+  "keywords": [
+    "typescript",
+    "mindee",
+    "api",
+    "client",
+    "client library",
+    "nodejs",
+    "sdk"
+  ]
 }

package/src/geometry/bbox.d.ts

@@ -1,14 +1,26 @@
-/** A simple bounding box defined by 4 coordinates: xMin, yMin, xMax, yMax */
+/**
+ * A simple bounding box defined by 4 coordinates: xMin, yMin, xMax, yMax
+ */
 export declare class BBox {
-    /** Minimum X coordinate. */
+    /**
+     * Minimum X coordinate.
+     */
     xMin: number;
-    /** Minimum Y coordinate. */
+    /**
+     * Minimum Y coordinate.
+     */
     yMin: number;
-    /** Maximum X coordinate. */
+    /**
+     * Maximum X coordinate.
+     */
     xMax: number;
-    /** Maximum Y coordinate. */
+    /**
+     * Maximum Y coordinate.
+     */
     yMax: number;
     constructor(xMin: number, yMin: number, xMax: number, yMax: number);
-    /** Returns a bounding box that contains this box and another one. */
+    /**
+     * Returns a bounding box that contains this box and another one.
+     */
     mergeBbox(bbox: BBox): BBox;
 }

package/src/geometry/bbox.js

@@ -1,5 +1,7 @@
-import { mergeBbox } from "../geometry/boundingBoxUtils.js";
-/** A simple bounding box defined by 4 coordinates: xMin, yMin, xMax, yMax */
+import { mergeBbox } from "./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;
@@ -7,7 +9,9 @@ export class BBox {
         this.xMax = xMax;
         this.yMax = yMax;
     }
-    /** Returns a bounding box that contains this box and another one. */
+    /**
+     * Returns a bounding box that contains this box and another one.
+     */
     mergeBbox(bbox) {
         return mergeBbox(this, bbox);
     }

package/src/geometry/boundingBox.d.ts

@@ -1,6 +1,8 @@
 import { Point } from "./point.js";
 import { Polygon } from "./polygon.js";
-/** A bounding box defined by 4 points. */
+/**
+ * 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,5 +1,7 @@
 import { Polygon } from "./polygon.js";
-/** A bounding box defined by 4 points. */
+/**
+ * A bounding box defined by 4 points.
+ */
 export class BoundingBox extends Polygon {
     constructor(topLeft, topRight, bottomRight, bottomLeft) {
         super(topLeft, topRight, bottomRight, bottomLeft);

package/src/geometry/boundingBoxUtils.d.ts

@@ -1,10 +1,6 @@
 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.
- */
-export declare function getBoundingBox(polygon: Polygon): BoundingBox;
 /**
  * Given a BBox, generate the associated bounding box.
  */
@@ -21,3 +17,7 @@ export declare function getBbox(polygon: Polygon): BBox;
  * Given polygons, calculate a BBox that encompasses all points.
  */
 export declare function getBBoxForPolygons(polygons: Polygon[]): BBox;
+/**
+ * Given a Polygon, calculate a polygon that encompasses all points.
+ */
+export declare function getBoundingBox(polygon: Polygon): BoundingBox;

package/src/geometry/boundingBoxUtils.js

@@ -1,12 +1,5 @@
 import { BoundingBox } from "./boundingBox.js";
 import { BBox } from "./bbox.js";
-/**
- * Given a Polygon, calculate a polygon that encompasses all points.
- */
-export function getBoundingBox(polygon) {
-    const bbox = getBbox(polygon);
-    return getBoundingBoxFromBBox(bbox);
-}
 /**
  * Given a BBox, generate the associated bounding box.
  */
@@ -35,3 +28,10 @@ export function getBBoxForPolygons(polygons) {
     const allX = polygons.flatMap((polygon) => polygon.map((point) => point[0]));
     return new BBox(Math.min(...allX), Math.min(...allY), Math.max(...allX), Math.max(...allY));
 }
+/**
+ * Given a Polygon, calculate a polygon that encompasses all points.
+ */
+export function getBoundingBox(polygon) {
+    const bbox = getBbox(polygon);
+    return getBoundingBoxFromBBox(bbox);
+}

package/src/geometry/minMax.d.ts

@@ -1,7 +1,13 @@
-/** Numeric range boundaries. */
+/**
+ * Numeric range boundaries.
+ */
 export type MinMax = {
-    /** Lower bound. */
+    /**
+     * Lower bound.
+     */
     min: number;
-    /** Upper bound. */
+    /**
+     * Upper bound.
+     */
     max: number;
 };

package/src/geometry/point.d.ts

@@ -1,2 +1,4 @@
-/** A point on the document defined by 2 coordinates: X, Y */
+/**
+ * A point on the document defined by 2 coordinates: X, Y
+ */
 export type Point = [number, number];

package/src/geometry/polygon.d.ts

@@ -1,6 +1,8 @@
 import { Point } from "./point.js";
 import { MinMax } from "./minMax.js";
-/** A polygon, composed of several Points. */
+/**
+ * A polygon, composed of several Points.
+ */
 export declare class Polygon extends Array<Point> {
     constructor(...args: Point[]);
     /**

package/src/geometry/polygon.js

@@ -1,5 +1,7 @@
 import { getCentroid, getMinMaxX, getMinMaxY, isPointInX, isPointInY } from "./polygonUtils.js";
-/** A polygon, composed of several Points. */
+/**
+ * A polygon, composed of several Points.
+ */
 export class Polygon extends Array {
     constructor(...args) {
         super(...args);

package/src/http/apiCore.js

@@ -1,5 +1,5 @@
-import { logger } from "../logger.js";
 import { request } from "undici";
+import { logger } from "../logger.js";
 export const TIMEOUT_SECS_DEFAULT = 120;
 /**
  * Reads a response from the API and processes it.

package/src/http/baseSettings.d.ts

@@ -4,16 +4,26 @@ export interface MindeeApiConstructorProps {
     dispatcher?: Dispatcher;
 }
 export declare abstract class BaseSettings {
-    /** API key used for authenticated requests. */
+    /**
+     * API key used for authenticated requests.
+     */
     apiKey: string;
-    /** API hostname used for requests. */
+    /**
+     * API hostname used for requests.
+     */
     hostname: string;
-    /** Request timeout in seconds. */
+    /**
+     * Request timeout in seconds.
+     */
     timeoutSecs: number;
-    /** HTTP dispatcher used by undici. */
+    /**
+     * HTTP dispatcher used by undici.
+     */
     dispatcher: Dispatcher;
     protected constructor(apiKey?: string, dispatcher?: Dispatcher);
-    /** Builds a default user-agent string for outgoing requests. */
+    /**
+     * Builds a default user-agent string for outgoing requests.
+     */
     protected getUserAgent(): string;
     protected abstract apiKeyFromEnv(): string;
     protected abstract hostnameFromEnv(): string;

package/src/http/baseSettings.js

@@ -1,6 +1,6 @@
+import * as os from "node:os";
 // eslint-disable-next-line no-restricted-imports
 import packageJson from "../../package.json" with { type: "json" };
-import * as os from "os";
 import { TIMEOUT_SECS_DEFAULT } from "./apiCore.js";
 import { resolveDefaultDispatcher } from "./dispatcher.js";
 export class BaseSettings {
@@ -17,7 +17,9 @@ export class BaseSettings {
             ? parseInt(process.env.MINDEE_REQUEST_TIMEOUT)
             : TIMEOUT_SECS_DEFAULT;
     }
-    /** Builds a default user-agent string for outgoing requests. */
+    /**
+     * Builds a default user-agent string for outgoing requests.
+     */
     getUserAgent() {
         let platform = os.type().toLowerCase();
         if (platform.includes("darwin")) {

package/src/http/dispatcher.js

@@ -1,6 +1,8 @@
 import { Agent, Dispatcher, getGlobalDispatcher } from "undici";
 import { logger } from "../logger.js";
-/** Library-owned fallback dispatcher, shared across all components. */
+/**
+ * Library-owned fallback dispatcher, shared across all components.
+ */
 let fallbackDispatcher;
 /**
  * Returns the global undici dispatcher, provided it was created by the same
@@ -12,6 +14,6 @@ export function resolveDefaultDispatcher() {
         return globalDispatcher;
     }
     logger.debug("Global dispatcher belongs to a different undici instance, using a library-owned Agent instead.");
-    fallbackDispatcher ?? (fallbackDispatcher = new Agent());
+    fallbackDispatcher ??= new Agent();
     return fallbackDispatcher;
 }

package/src/image/extractedImage.d.ts

@@ -4,13 +4,21 @@ import { BufferInput } from "../input/index.js";
  * Generic class for image extraction.
  */
 export declare class ExtractedImage {
-    /** Raw file bytes for the extracted image artifact. */
+    /**
+     * Raw file bytes for the extracted image artifact.
+     */
     buffer: Buffer;
-    /** Filename used when exporting the extracted image. */
+    /**
+     * Filename used when exporting the extracted image.
+     */
     filename: string;
-    /** 1-based source page identifier. */
+    /**
+     * 1-based source page identifier.
+     */
     readonly pageId: number;
-    /** Identifier of the extracted element on the page. */
+    /**
+     * Identifier of the extracted element on the page.
+     */
     readonly elementId: number;
     constructor(buffer: Uint8Array, fileName: string, pageId: number, elementId: number);
     /**
@@ -20,7 +28,7 @@ export declare class ExtractedImage {
      */
     saveToFileAsync(outputPath: string): Promise<void>;
     /**
-     * Attempts to saves the document to a file synchronously.
+     * Attempts to save the document to a file synchronously.
      * Throws an error if the file extension is not supported or if the file could not be saved to disk for some reason.
      *
      * @param outputPath Path to save the file to.

package/src/image/extractedImage.js

@@ -1,8 +1,8 @@
 import { Buffer } from "node:buffer";
-import { MindeeError } from "../errors/index.js";
 import { writeFileSync } from "node:fs";
-import { writeFile } from "fs/promises";
+import { writeFile } from "node:fs/promises";
 import path from "node:path";
+import { MindeeError } from "../errors/index.js";
 import { BufferInput, MIMETYPES } from "../input/index.js";
 import { logger } from "../logger.js";
 import { loadOptionalDependency } from "../dependency/index.js";
@@ -62,7 +62,7 @@ export class ExtractedImage {
         }
     }
     /**
-     * Attempts to saves the document to a file synchronously.
+     * Attempts to save the document to a file synchronously.
      * Throws an error if the file extension is not supported or if the file could not be saved to disk for some reason.
      *
      * @param outputPath Path to save the file to.

package/src/image/extractedImages.d.ts

@@ -1,5 +1,7 @@
-import { ExtractedImage } from "../image/index.js";
-/** Collection of extracted image artifacts. */
+import { ExtractedImage } from "./index.js";
+/**
+ * Collection of extracted image artifacts.
+ */
 export declare class ExtractedImages extends Array<ExtractedImage> {
     constructor(...items: ExtractedImage[]);
 }

package/src/image/extractedImages.js

@@ -1,4 +1,6 @@
-/** Collection of extracted image artifacts. */
+/**
+ * Collection of extracted image artifacts.
+ */
 export class ExtractedImages extends Array {
     constructor(...items) {
         super(...items);

package/src/image/imageCompressor.d.ts

@@ -1,3 +1,4 @@
+import { Buffer } from "node:buffer";
 /**
  * Compresses an image with the given parameters.
  *

package/src/image/imageCompressor.js

@@ -16,8 +16,8 @@ export async function compressImage(imageBuffer, quality = 85, maxWidth = null,
     if (metadata.width === undefined || metadata.height === undefined) {
         throw new MindeeImageError("Source image has invalid dimensions.");
     }
-    maxWidth ?? (maxWidth = metadata.width);
-    maxHeight ?? (maxHeight = metadata.height);
+    maxWidth ??= metadata.width;
+    maxHeight ??= metadata.height;
     if (maxWidth || maxHeight) {
         sharpImage = sharpImage.resize({
             width: maxWidth,

package/src/image/imageExtractor.d.ts

@@ -1,7 +1,7 @@
+import type * as pdfLibTypes from "@cantoo/pdf-lib";
 import { Polygon } from "../geometry/index.js";
-import { ExtractedImages } from "../image/extractedImages.js";
+import { ExtractedImages } from "./extractedImages.js";
 import { LocalInputSource } from "../input/index.js";
-import type * as pdfLibTypes from "@cantoo/pdf-lib";
 /**
  * Extracts elements from a PDF document based on a list of bounding boxes.
  * @param inputSource The input source to extract from.