mindee 5.3.0 → 5.3.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # 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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "5.3.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/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) {