mindee 5.2.0 → 5.3.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Mindee Node.js API Library Changelog
 
+## v5.3.1 - 2026-06-11
+### Fixes
+* :arrow_up: bump 'tmp' and 'file-type'
+* :bug: :sparkles: get results by URL directly
+
+
+## v5.3.0 - 2026-05-07
+### Changes
+* :sparkles: Add support for extraction in crop, split, and classify products
+
+
 ## v5.2.0 - 2026-04-14
 ### Changes
 * :sparkles: add support for crop operation for V2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "5.2.0",
+    "version": "5.3.1",
     "description": "Mindee Client Library for Node.js",
     "author": {
         "name": "Mindee",
@@ -48,8 +48,8 @@
     },
     "dependencies": {
         "commander": "^14.0.3",
-        "file-type": "^21.3.3",
-        "tmp": "^0.2.5",
+        "file-type": "^21.3.4",
+        "tmp": "^0.2.7",
         "undici": ">=6.24.0 <7.0.0 || >=7.24.0 <8.0.0"
     },
     "optionalDependencies": {

package/src/v2/client.d.ts

@@ -41,6 +41,16 @@ export declare class Client {
      * @returns a `Promise` containing the inference.
      */
     getResult<P extends typeof BaseProduct>(product: P, inferenceId: string): Promise<InstanceType<P["responseClass"]>>;
+    /**
+     * Retrieves the result of a previously enqueued request.
+     * This method is used when manually polling the server for the result URL.
+     *
+     * @param product the product to retrieve.
+     * @param url URL as given in the `getJob()` response.
+     * @typeParam T an extension of an `Inference`. Can be omitted as it will be inferred from the `productClass`.
+     * @returns a `Promise` containing the inference.
+     */
+    getResultByUrl<P extends typeof BaseProduct>(product: P, url: string): Promise<InstanceType<P["responseClass"]>>;
     /**
      * Get the processing status of a previously enqueued request.
      * Can be used for polling.

package/src/v2/client.js

@@ -53,6 +53,19 @@ export class Client {
         logger.debug(`Attempting to get inference with ID: ${inferenceId} using response type: ${product.name}`);
         return await this.mindeeApi.getProductResultById(product, inferenceId);
     }
+    /**
+     * Retrieves the result of a previously enqueued request.
+     * This method is used when manually polling the server for the result URL.
+     *
+     * @param product the product to retrieve.
+     * @param url URL as given in the `getJob()` response.
+     * @typeParam T an extension of an `Inference`. Can be omitted as it will be inferred from the `productClass`.
+     * @returns a `Promise` containing the inference.
+     */
+    async getResultByUrl(product, url) {
+        logger.debug(`Attempting to get inference from: ${url} using response type: ${product.name}`);
+        return await this.mindeeApi.getProductResultByUrl(product, url);
+    }
     /**
      * Get the processing status of a previously enqueued request.
      * Can be used for polling.
@@ -109,7 +122,7 @@ export class Client {
                 if (!pollResults.job.resultUrl) {
                     throw new MindeeError("The result URL is undefined. This is a server error, try again later or contact support.");
                 }
-                return this.mindeeApi.getProductResultByUrl(product, pollResults.job.resultUrl);
+                return this.getResultByUrl(product, pollResults.job.resultUrl);
             }
             await setTimeout(pollingOptions.delaySec * 1000, undefined, pollingOptions.recurringTimerOptions);
             retryCounter++;

package/src/v2/fileOperations/crop.js

@@ -21,6 +21,7 @@ export async function extractCrops(inputSource, crops, quality) {
     if (crops.length === 0) {
         throw new MindeeError("No crop indexes provided.");
     }
+    await inputSource.init();
     logger.debug("Extracting crops: " + crops.join(", "));
     const polygonsByPage = new Map();
     for (const crop of crops) {

package/src/v2/fileOperations/split.js

@@ -23,6 +23,7 @@ export async function extractSplits(inputSource, splits) {
     if (pageGroups.length === 0) {
         throw new MindeeError("No valid split indexes provided.");
     }
+    await inputSource.init();
     logger.debug("Extracting splits: " + splits.join(", "));
     const pdfExtractor = new PdfExtractor(inputSource);
     await pdfExtractor.init();

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

@@ -1,6 +1,14 @@
 import { StringDict } from "../../../../parsing/stringDict.js";
 import { BaseField } from "./baseField.js";
 export declare class SimpleField extends BaseField {
+    /**
+     * The untyped value of the field.
+     *
+     * This is usually not what you want, look at the typed accessors instead:
+     * - stringValue
+     * - numberValue
+     * - booleanValue
+     */
     readonly value: string | number | boolean | null;
     constructor(serverResponse: StringDict, indentLevel?: number);
     /**

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

@@ -7,13 +7,25 @@ import { BaseResponse } from "./baseResponse.js";
  */
 export declare class LocalResponse extends LocalResponseBase {
     /**
-     * Deserialize the loaded local response into the requested CommonResponse-derived class.
+     * Deserialize the loaded local response into a product response class.
      *
-     * Typically used when dealing with V2 webhook callbacks.
+     * Typically used when dealing with V2 webhook callbacks to parse the raw
+     * JSON payload pushed to your endpoint into a typed response object.
      *
-     * @typeParam ResponseT - A class that extends `CommonResponse`.
-     * @param responseClass - The constructor of the class into which the payload should be deserialized.
-     * @returns An instance of `responseClass` populated with the file content.
+     * Pass the response class that matches the product you used when enqueuing
+     * the document. All product response classes are exported from the `mindee`
+     * package and can be used here:
+     *
+     * - `mindee.product.ExtractionResponse`
+     * - `mindee.product.ClassificationResponse`
+     * - `mindee.product.OcrResponse`
+     * - `mindee.product.CropResponse`
+     * - `mindee.product.SplitResponse`
+     *
+     * @typeParam ResponseT - A class that extends `BaseResponse`.
+     * @param responseClass - The constructor of the product response class into
+     *   which the payload should be deserialized.
+     * @returns An instance of `responseClass` populated with the webhook payload.
      * @throws MindeeError If the provided class cannot be instantiated.
      */
     deserializeResponse<ResponseT extends BaseResponse>(responseClass: new (serverResponse: StringDict) => ResponseT): Promise<ResponseT>;

package/src/v2/parsing/localResponse.js

@@ -6,13 +6,25 @@ import { LocalResponseBase } from "../../parsing/localResponseBase.js";
  */
 export class LocalResponse extends LocalResponseBase {
     /**
-     * Deserialize the loaded local response into the requested CommonResponse-derived class.
+     * Deserialize the loaded local response into a product response class.
      *
-     * Typically used when dealing with V2 webhook callbacks.
+     * Typically used when dealing with V2 webhook callbacks to parse the raw
+     * JSON payload pushed to your endpoint into a typed response object.
      *
-     * @typeParam ResponseT - A class that extends `CommonResponse`.
-     * @param responseClass - The constructor of the class into which the payload should be deserialized.
-     * @returns An instance of `responseClass` populated with the file content.
+     * Pass the response class that matches the product you used when enqueuing
+     * the document. All product response classes are exported from the `mindee`
+     * package and can be used here:
+     *
+     * - `mindee.product.ExtractionResponse`
+     * - `mindee.product.ClassificationResponse`
+     * - `mindee.product.OcrResponse`
+     * - `mindee.product.CropResponse`
+     * - `mindee.product.SplitResponse`
+     *
+     * @typeParam ResponseT - A class that extends `BaseResponse`.
+     * @param responseClass - The constructor of the product response class into
+     *   which the payload should be deserialized.
+     * @returns An instance of `responseClass` populated with the webhook payload.
      * @throws MindeeError If the provided class cannot be instantiated.
      */
     async deserializeResponse(responseClass) {

package/src/v2/product/classification/classificationClassifier.d.ts

@@ -1,9 +1,17 @@
 import { StringDict } from "../../../parsing/index.js";
+import { ExtractionResponse } from "../../../v2/product/index.js";
 /**
  * Document level classification.
  */
 export declare class ClassificationClassifier {
+    /**
+     * The document type, as identified on given classification values.
+     */
     documentType: string;
+    /**
+     * The extraction response associated with the classification.
+     */
+    extractionResponse?: ExtractionResponse;
     constructor(serverResponse: StringDict);
     toString(): string;
 }

package/src/v2/product/classification/classificationClassifier.js

@@ -1,9 +1,13 @@
+import { ExtractionResponse } from "../../../v2/product/index.js";
 /**
  * Document level classification.
  */
 export class ClassificationClassifier {
     constructor(serverResponse) {
         this.documentType = serverResponse["document_type"];
+        this.extractionResponse = serverResponse["extraction_response"]
+            ? new ExtractionResponse(serverResponse["extraction_response"])
+            : undefined;
     }
     toString() {
         return `Document Type: ${this.documentType}`;

package/src/v2/product/crop/cropItem.d.ts

@@ -2,9 +2,20 @@ import { FieldLocation } from "../../../v2/parsing/inference/field/index.js";
 import { StringDict } from "../../../parsing/index.js";
 import { LocalInputSource } from "../../../input/index.js";
 import { ExtractedImage } from "../../../image/index.js";
+import { ExtractionResponse } from "../../../v2/product/index.js";
 export declare class CropItem {
+    /**
+     * Type or classification of the detected object.
+     */
     objectType: string;
+    /**
+     * Location that includes cropping coordinates for the detected object, within the source document.
+     */
     location: FieldLocation;
+    /**
+     * The extraction response associated with the crop.
+     */
+    extractionResponse?: ExtractionResponse;
     constructor(serverResponse: StringDict);
     toString(): string;
     /**

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

@@ -1,9 +1,13 @@
 import { FieldLocation } from "../../../v2/parsing/inference/field/index.js";
 import { extractCrops } from "../../../v2/fileOperations/crop.js";
+import { ExtractionResponse } from "../../../v2/product/index.js";
 export class CropItem {
     constructor(serverResponse) {
         this.objectType = serverResponse["object_type"];
         this.location = new FieldLocation(serverResponse["location"]);
+        this.extractionResponse = serverResponse["extraction_response"]
+            ? new ExtractionResponse(serverResponse["extraction_response"])
+            : undefined;
     }
     toString() {
         return `* :Location: ${this.location}\n  :Object Type: ${this.objectType}`;

package/src/v2/product/split/splitRange.d.ts

@@ -1,5 +1,6 @@
 import { StringDict } from "../../../parsing/index.js";
 import { LocalInputSource } from "../../../input/index.js";
+import { ExtractionResponse } from "../../../v2/product/index.js";
 /**
  * Split inference result.
  */
@@ -13,6 +14,10 @@ export declare class SplitRange {
      * The document type, as identified on given classification values.
      */
     documentType: string;
+    /**
+     * The extraction response associated with the split.
+     */
+    extractionResponse?: ExtractionResponse;
     constructor(serverResponse: StringDict);
     toString(): string;
     /**

package/src/v2/product/split/splitRange.js

@@ -1,4 +1,5 @@
 import { expandRange, extractSplits } from "../../../v2/fileOperations/split.js";
+import { ExtractionResponse } from "../../../v2/product/index.js";
 /**
  * Split inference result.
  */
@@ -6,6 +7,9 @@ export class SplitRange {
     constructor(serverResponse) {
         this.pageRange = serverResponse["page_range"];
         this.documentType = serverResponse["document_type"];
+        this.extractionResponse = serverResponse["extraction_response"]
+            ? new ExtractionResponse(serverResponse["extraction_response"])
+            : undefined;
     }
     toString() {
         const pageRange = this.pageRange.join(",");