mindee 5.0.2 → 5.1.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Mindee Node.js API Library Changelog
 
+## v5.1.1 - 2026-03-11
+### Changes
+* :heavy_minus_sign: tslib is never imported, remove from dependencies
+
+
+## v5.1.0 - 2026-03-02
+### Changes
+* :sparkles: add to job information
+### Fixes
+* :bug: fix for printing crop results
+* :bug: proper init of webhook payload
+
 
 ## v5.0.2 - 2026-02-27
 ### Changes

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "5.0.2",
+    "version": "5.1.1",
     "description": "Mindee Client Library for Node.js",
     "author": {
         "name": "Mindee",
@@ -48,9 +48,8 @@
     },
     "dependencies": {
         "commander": "^14.0.3",
-        "file-type": "^21.3.0",
-        "tmp": "^0.2.3",
-        "tslib": "^2.8.1",
+        "file-type": "^21.3.1",
+        "tmp": "^0.2.5",
         "undici": ">=6.23.0 <8.0.0"
     },
     "optionalDependencies": {
@@ -60,15 +59,19 @@
         "sharp": "~0.34.5"
     },
     "devDependencies": {
+        "@eslint/eslintrc": "^3.3.5",
+        "@eslint/js": "^10.0.1",
         "@types/mocha": "^10.0.10",
-        "@types/node": "^20.19.33",
+        "@types/node": "^20.19.37",
         "@types/tmp": "^0.2.6",
-        "@typescript-eslint/eslint-plugin": "^8.56.1",
-        "@typescript-eslint/parser": "^8.56.1",
-        "eslint": "^9.39.3",
+        "@typescript-eslint/eslint-plugin": "^8.57.0",
+        "@typescript-eslint/parser": "^8.57.0",
+        "eslint": "^10.0.3",
         "eslint-plugin-jsdoc": "^62.7.1",
+        "globals": "^17.4.0",
         "mocha": "^11.7.5",
         "tsc-alias": "^1.8.16",
+        "tslib": "^2.8.1",
         "tsx": "^4.21.0",
         "typedoc": "^0.28.17",
         "typescript": "^5.9.3"

package/src/geometry/polygon.js

@@ -37,6 +37,7 @@ export class Polygon extends Array {
         return isPointInY(point, yCoords.min, yCoords.max);
     }
     toString() {
-        return this.map((point) => `(${point})`).join(", ");
+        const points = this.map((point) => `(${point})`).join(", ");
+        return `(${points})`;
     }
 }

package/src/v2/cli.js

@@ -1,7 +1,6 @@
 import { Command } from "commander";
-import { Client } from "./client.js";
-import { PathInput } from "../input/index.js";
 import * as console from "console";
+import { Client, PathInput, UrlInput } from "../index.js";
 import { Classification, Crop, Extraction, Ocr, Split, } from "../v2/product/index.js";
 const program = new Command();
 //
@@ -15,7 +14,13 @@ function initClient(options) {
 }
 async function enqueueAndGetInference(product, inputPath, options) {
     const mindeeClient = initClient(options);
-    const inputSource = new PathInput({ inputPath: inputPath });
+    let inputSource;
+    if (inputPath.startsWith("https://")) {
+        inputSource = new UrlInput({ url: inputPath });
+    }
+    else {
+        inputSource = new PathInput({ inputPath: inputPath });
+    }
     const response = await mindeeClient.enqueueAndGetResult(product, inputSource, { modelId: options.model }, {
         initialDelaySec: 2,
         delaySec: 1.5,
@@ -36,7 +41,7 @@ function printResponse(document) {
 //
 function addMainOptions(prog) {
     prog.requiredOption("-m, --model <model_id>", "Model ID (required)");
-    prog.argument("<input_path>", "full path to the file");
+    prog.argument("<input_path>", "full path or URL to the file");
 }
 export function cli() {
     program.name("mindee")

package/src/v2/parsing/inference/field/fieldLocation.d.ts

@@ -1,13 +1,13 @@
 import { Polygon } from "../../../../geometry/index.js";
 import { StringDict } from "../../../../parsing/stringDict.js";
 /**
- * Location of a field.
+ * A field's location on the document.
  */
 export declare class FieldLocation {
-    /** Free polygon made up of points (can be null when not provided). */
-    readonly polygon: Polygon | null;
-    /** Page ID. */
-    readonly page: number | undefined;
+    /** Position information as a list of points in clockwise order. */
+    readonly polygon: Polygon;
+    /** 0-based page index of where the polygon is located. */
+    readonly page: any;
     constructor(serverResponse: StringDict);
     toString(): string;
 }

package/src/v2/parsing/inference/field/fieldLocation.js

@@ -1,13 +1,13 @@
 import { Polygon } from "../../../../geometry/index.js";
 /**
- * Location of a field.
+ * A field's location on the document.
  */
 export class FieldLocation {
     constructor(serverResponse) {
-        this.polygon = "polygon" in serverResponse ? new Polygon(...serverResponse["polygon"]) : null;
-        this.page = "page" in serverResponse ? serverResponse["page"] : undefined;
+        this.polygon = new Polygon(...serverResponse["polygon"]);
+        this.page = serverResponse["page"];
     }
     toString() {
-        return this.polygon?.toString() ?? "";
+        return `${this.polygon} on page ${this.page}`;
     }
 }

package/src/v2/parsing/job/job.d.ts

@@ -14,9 +14,13 @@ export declare class Job {
      */
     error?: ErrorResponse;
     /**
-     * Timestamp of the job creation.
+     * Date and time of the Job creation.
      */
     createdAt: Date | null;
+    /**
+     * Date and time of the Job completion. Filled once processing is finished.
+     */
+    completedAt: Date | null | undefined;
     /**
      * ID of the model.
      */

package/src/v2/parsing/job/job.js

@@ -1,5 +1,6 @@
 import { parseDate } from "../../../parsing/index.js";
 import { ErrorResponse } from "../../../v2/index.js";
+import { JobWebhook } from "./jobWebhook.js";
 /**
  * Job information for a V2 polling attempt.
  */
@@ -9,17 +10,21 @@ export class Job {
         if (serverResponse["status"] !== undefined) {
             this.status = serverResponse["status"];
         }
-        if (serverResponse["error"] !== undefined &&
-            serverResponse["error"] !== null &&
-            Object.keys(serverResponse["error"]).length > 0) {
+        if (serverResponse["error"]) {
             this.error = new ErrorResponse(serverResponse["error"]);
         }
         this.createdAt = parseDate(serverResponse["created_at"]);
+        if (!serverResponse["completed_at"]) {
+            this.completedAt = undefined;
+        }
+        else {
+            this.completedAt = parseDate(serverResponse["completed_at"]);
+        }
         this.modelId = serverResponse["model_id"];
         this.pollingUrl = serverResponse["polling_url"];
         this.filename = serverResponse["filename"];
         this.resultUrl = serverResponse["result_url"];
         this.alias = serverResponse["alias"];
-        this.webhooks = serverResponse["webhooks"];
+        this.webhooks = (serverResponse["webhooks"] ?? []).map((webhook) => new JobWebhook(webhook));
     }
 }

package/src/v2/parsing/job/jobWebhook.js

@@ -8,7 +8,7 @@ export class JobWebhook {
         this.id = serverResponse["id"];
         this.createdAt = parseDate(serverResponse["created_at"]);
         this.status = serverResponse["status"];
-        if (serverResponse["error"] !== undefined) {
+        if (serverResponse["error"]) {
             this.error = new ErrorResponse(serverResponse["error"]);
         }
     }

package/src/v2/product/crop/cropItem.js

@@ -5,6 +5,6 @@ export class CropItem {
         this.location = new FieldLocation(serverResponse["location"]);
     }
     toString() {
-        return `${this.objectType}: ${this.location}`;
+        return `* :Location: ${this.location}\n  :Object Type: ${this.objectType}`;
     }
 }

package/src/v2/product/crop/cropResult.js

@@ -8,7 +8,7 @@ export class CropResult {
         this.crops = serverResponse["crops"].map((cropItem) => new CropItem(cropItem));
     }
     toString() {
-        const crops = this.crops.map(item => item.toString()).join("\n * ");
-        return `Crop\n====\n * ${crops}`;
+        const crops = this.crops.map(item => item.toString()).join("\n");
+        return `Crops\n=====\n${crops}`;
     }
 }