mindee 5.0.0-rc1 → 5.0.0-rc2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 5.0.0-rc2 - 2026-01-18
+### Changes
+* :sparkles: add Job to inference responses
+### Fixes
+* :bug: fix for bin scripts
+
+
 ## 5.0.0-rc1 - 2026-01-17
 ### Changes
 * :boom: drop support for node.js 18

package/package.json

@@ -1,14 +1,27 @@
 {
     "name": "mindee",
-    "version": "5.0.0-rc1",
+    "version": "5.0.0-rc2",
     "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",
     "bin": {
         "mindeeV1": "bin/mindeeV1.js",
         "mindeeV2": "bin/mindeeV2.js"
     },
-    "license": "MIT",
-    "type": "module",
     "scripts": {
         "build": "tsc --build && tsc-alias",
         "build-for-dist": "tsc --build && tsc-alias && cp LICENSE README.md CHANGELOG.md ./dist",
@@ -33,33 +46,6 @@
     "engines": {
         "node": ">= 20.1"
     },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/mindee/mindee-api-nodejs.git"
-    },
-    "author": {
-        "name": "Mindee",
-        "email": "opensource@mindee.com",
-        "url": "https://mindee.com/"
-    },
-    "bugs": {
-        "url": "https://github.com/mindee/mindee-api-nodejs/issues"
-    },
-    "homepage": "https://mindee.com/",
-    "devDependencies": {
-        "@types/mocha": "^10.0.10",
-        "@types/node": "^18.19.130",
-        "@types/tmp": "^0.2.6",
-        "@typescript-eslint/eslint-plugin": "^8.55.0",
-        "@typescript-eslint/parser": "^8.55.0",
-        "eslint": "^9.39.2",
-        "eslint-plugin-jsdoc": "^52.0.4",
-        "mocha": "^11.3.0",
-        "tsc-alias": "^1.8.16",
-        "tsx": "^4.21.0",
-        "typedoc": "~0.28.16",
-        "typescript": "^5.9.3"
-    },
     "dependencies": {
         "commander": "~9.4.1",
         "file-type": "^19.6.0",
@@ -73,6 +59,20 @@
         "pdf.js-extract": "^0.2.1",
         "sharp": "~0.34.5"
     },
+    "devDependencies": {
+        "@types/mocha": "^10.0.10",
+        "@types/node": "^20.19.33",
+        "@types/tmp": "^0.2.6",
+        "@typescript-eslint/eslint-plugin": "^8.56.0",
+        "@typescript-eslint/parser": "^8.56.0",
+        "eslint": "^9.39.2",
+        "eslint-plugin-jsdoc": "^62.6.0",
+        "mocha": "^11.7.5",
+        "tsc-alias": "^1.8.16",
+        "tsx": "^4.21.0",
+        "typedoc": "^0.28.17",
+        "typescript": "^5.9.3"
+    },
     "keywords": [
         "typescript",
         "mindee",

package/src/v2/client/baseParameters.d.ts

@@ -8,7 +8,7 @@ export interface BaseParametersConstructor {
     closeFile?: boolean;
 }
 /**
- * Parameters accepted by the asynchronous **inference** v2 endpoint.
+ * Parameters accepted by all v2 products.
  *
  * All fields are optional except `modelId`.
  *
@@ -19,10 +19,6 @@ export interface BaseParametersConstructor {
  *   rag: true,
  *   alias: "YOUR_ALIAS",
  *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
- *   pollingOptions: {
- *     initialDelaySec: 2,
- *     delaySec: 1.5,
- *   }
  * };
  */
 export declare abstract class BaseParameters {

package/src/v2/client/baseParameters.js

@@ -1,6 +1,6 @@
 import { MindeeConfigurationError } from "../../errors/index.js";
 /**
- * Parameters accepted by the asynchronous **inference** v2 endpoint.
+ * Parameters accepted by all v2 products.
  *
  * All fields are optional except `modelId`.
  *
@@ -11,10 +11,6 @@ import { MindeeConfigurationError } from "../../errors/index.js";
  *   rag: true,
  *   alias: "YOUR_ALIAS",
  *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
- *   pollingOptions: {
- *     initialDelaySec: 2,
- *     delaySec: 1.5,
- *   }
  * };
  */
 export class BaseParameters {

package/src/v2/client/index.d.ts

@@ -1,3 +1,3 @@
 export { PollingOptions } from "./pollingOptions.js";
-export type { PollingOptionsConstructor } from "./pollingOptions.js";
+export type { PollingOptionsConstructor, TimerOptions, } from "./pollingOptions.js";
 export { BaseParameters } from "./baseParameters.js";

package/src/v2/client/pollingOptions.d.ts

@@ -13,8 +13,8 @@ export interface PollingOptionsConstructor {
  * Parameters for the internal polling loop in `enqueueAndGetInference()`.
  *
  * Default behavior:
- * - `initialDelaySec` = 2s
- * - `delaySec` = 1.5s
+ * - `initialDelaySec` = 2
+ * - `delaySec` = 1.5
  * - `maxRetries` = 80
  *
  * Validation rules:
@@ -23,17 +23,21 @@ export interface PollingOptionsConstructor {
  * - `maxRetries` >= 2
  *
  * The `initialTimerOptions` and `recurringTimerOptions` objects let you pass an
- * `AbortSignal` or make the timer `unref`-ed to the `setTimeout()`.
+ * `AbortSignal` or make the timer `ref`-ed to the `setTimeout()`.
  *
  * @category ClientV2
  * @example
- * const params = {
+ * ```
+ * const pollingOptions = {
  *   initialDelaySec: 4,
  *   delaySec: 2,
  *   maxRetries: 50
  * };
  *
- * const inference = await client.enqueueAndGetInference(inputDoc, params);
+ * const inference = await client.enqueueAndGetInference(
+ *   inputDoc, params, pollingOptions
+ * );
+ * ```
  */
 export declare class PollingOptions {
     /** Number of seconds to wait *before the first poll*. */
@@ -43,15 +47,9 @@ export declare class PollingOptions {
     /** Maximum number of polling attempts (including the first one). */
     maxRetries: number;
     /** Options passed to the initial `setTimeout()`. */
-    initialTimerOptions?: {
-        ref?: boolean;
-        signal?: AbortSignal;
-    };
+    initialTimerOptions?: TimerOptions;
     /** Options passed to every recurring `setTimeout()`. */
-    recurringTimerOptions?: {
-        ref?: boolean;
-        signal?: AbortSignal;
-    };
+    recurringTimerOptions?: TimerOptions;
     constructor(params?: PollingOptionsConstructor);
     validateOptions(): void;
     toString(): string;

package/src/v2/client/pollingOptions.js

@@ -7,8 +7,8 @@ const minRetries = 2;
  * Parameters for the internal polling loop in `enqueueAndGetInference()`.
  *
  * Default behavior:
- * - `initialDelaySec` = 2s
- * - `delaySec` = 1.5s
+ * - `initialDelaySec` = 2
+ * - `delaySec` = 1.5
  * - `maxRetries` = 80
  *
  * Validation rules:
@@ -17,17 +17,21 @@ const minRetries = 2;
  * - `maxRetries` >= 2
  *
  * The `initialTimerOptions` and `recurringTimerOptions` objects let you pass an
- * `AbortSignal` or make the timer `unref`-ed to the `setTimeout()`.
+ * `AbortSignal` or make the timer `ref`-ed to the `setTimeout()`.
  *
  * @category ClientV2
  * @example
- * const params = {
+ * ```
+ * const pollingOptions = {
  *   initialDelaySec: 4,
  *   delaySec: 2,
  *   maxRetries: 50
  * };
  *
- * const inference = await client.enqueueAndGetInference(inputDoc, params);
+ * const inference = await client.enqueueAndGetInference(
+ *   inputDoc, params, pollingOptions
+ * );
+ * ```
  */
 export class PollingOptions {
     constructor(params) {

package/src/v2/http/{apiSettingsV2.d.ts → apiSettings.d.ts}

@@ -1,5 +1,5 @@
 import { BaseSettings, MindeeApiConstructorProps } from "../../http/baseSettings.js";
-export declare class ApiSettingsV2 extends BaseSettings {
+export declare class ApiSettings extends BaseSettings {
     baseHeaders: Record<string, string>;
     constructor({ apiKey, dispatcher, }: MindeeApiConstructorProps);
     protected apiKeyFromEnv(): string;

package/src/v2/http/{apiSettingsV2.js → apiSettings.js}

@@ -4,7 +4,7 @@ import { MindeeConfigurationError } from "../../errors/index.js";
 const API_V2_KEY_ENVVAR_NAME = "MINDEE_V2_API_KEY";
 const API_V2_HOST_ENVVAR_NAME = "MINDEE_V2_API_HOST";
 const DEFAULT_MINDEE_API_HOST = "api-v2.mindee.net";
-export class ApiSettingsV2 extends BaseSettings {
+export class ApiSettings extends BaseSettings {
     constructor({ apiKey, dispatcher, }) {
         super(apiKey, dispatcher);
         if (!this.apiKey || this.apiKey.length === 0) {
@@ -16,6 +16,7 @@ export class ApiSettingsV2 extends BaseSettings {
             "User-Agent": this.getUserAgent(),
             Authorization: `${this.apiKey}`,
         };
+        /* eslint-enable @typescript-eslint/naming-convention */
     }
     apiKeyFromEnv() {
         const envVarValue = process.env[API_V2_KEY_ENVVAR_NAME];

package/src/v2/http/errors.d.ts

@@ -1,5 +1,8 @@
 import { ErrorDetails, ErrorItem, ErrorResponse } from "../../v2/parsing/index.js";
 import { MindeeError } from "../../errors/index.js";
+/**
+ * HTTP error returned by the API.
+ */
 export declare class MindeeHttpErrorV2 extends MindeeError implements ErrorDetails {
     status: number;
     detail: string;

package/src/v2/http/errors.js

@@ -1,4 +1,7 @@
 import { MindeeError } from "../../errors/index.js";
+/**
+ * HTTP error returned by the API.
+ */
 export class MindeeHttpErrorV2 extends MindeeError {
     constructor(error) {
         super(`HTTP ${error.status} - ${error.title} :: ${error.code} - ${error.detail}`);

package/src/v2/http/mindeeApiV2.d.ts

@@ -1,4 +1,4 @@
-import { ApiSettingsV2 } from "./apiSettingsV2.js";
+import { ApiSettings } from "./apiSettings.js";
 import { Dispatcher } from "undici";
 import { BaseParameters } from "../../v2/client/index.js";
 import { JobResponse } from "../../v2/parsing/index.js";
@@ -6,7 +6,7 @@ import { InputSource } from "../../input/index.js";
 import { BaseProduct } from "../../v2/product/baseProduct.js";
 export declare class MindeeApiV2 {
     #private;
-    settings: ApiSettingsV2;
+    settings: ApiSettings;
     constructor(dispatcher?: Dispatcher, apiKey?: string);
     /**
      * Sends a file to the extraction inference queue.

package/src/v2/http/mindeeApiV2.js

@@ -4,7 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _MindeeApiV2_instances, _MindeeApiV2_processResponse, _MindeeApiV2_reqPostProductEnqueue, _MindeeApiV2_reqGetJob, _MindeeApiV2_reqGetProductResult;
-import { ApiSettingsV2 } from "./apiSettingsV2.js";
+import { ApiSettings } from "./apiSettings.js";
 import { ErrorResponse, JobResponse, } from "../../v2/parsing/index.js";
 import { sendRequestAndReadResponse } from "../../http/apiCore.js";
 import { LocalInputSource } from "../../input/index.js";
@@ -14,7 +14,7 @@ import { logger } from "../../logger.js";
 export class MindeeApiV2 {
     constructor(dispatcher, apiKey) {
         _MindeeApiV2_instances.add(this);
-        this.settings = new ApiSettingsV2({ dispatcher: dispatcher, apiKey: apiKey });
+        this.settings = new ApiSettings({ dispatcher: dispatcher, apiKey: apiKey });
     }
     /**
      * Sends a file to the extraction inference queue.
@@ -58,7 +58,8 @@ export class MindeeApiV2 {
     }
 }
 _MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_processResponse = function _MindeeApiV2_processResponse(result, responseClass) {
-    if (result.messageObj?.statusCode && (result.messageObj?.statusCode > 399 || result.messageObj?.statusCode < 200)) {
+    if (result.messageObj?.statusCode
+        && (result.messageObj?.statusCode > 399 || result.messageObj?.statusCode < 200)) {
         if (result.data?.status !== null) {
             throw new MindeeHttpErrorV2(new ErrorResponse(result.data));
         }

package/src/v2/index.d.ts

@@ -3,4 +3,5 @@ export * as parsing from "./parsing/index.js";
 export * as product from "./product/index.js";
 export { Client } from "./client.js";
 export { JobResponse, ErrorResponse, LocalResponse, } from "./parsing/index.js";
-export type { PollingOptions, BaseParameters } from "./client/index.js";
+export type { BaseParameters, TimerOptions } from "./client/index.js";
+export { PollingOptions } from "./client/index.js";

package/src/v2/index.js

@@ -3,3 +3,4 @@ export * as parsing from "./parsing/index.js";
 export * as product from "./product/index.js";
 export { Client } from "./client.js";
 export { JobResponse, ErrorResponse, LocalResponse, } from "./parsing/index.js";
+export { PollingOptions } from "./client/index.js";

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

@@ -1,11 +1,16 @@
+import { StringDict } from "../../../parsing/index.js";
 import { InferenceModel } from "./inferenceModel.js";
 import { InferenceFile } from "./inferenceFile.js";
-import { StringDict } from "../../../parsing/index.js";
+import { InferenceJob } from "./inferenceJob.js";
 export declare abstract class BaseInference {
     /**
      * Model info for the inference.
      */
     model: InferenceModel;
+    /**
+     * Job the inference belongs to.
+     */
+    job: InferenceJob;
     /**
      * File info for the inference.
      */

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

@@ -1,8 +1,10 @@
 import { InferenceModel } from "./inferenceModel.js";
 import { InferenceFile } from "./inferenceFile.js";
+import { InferenceJob } from "./inferenceJob.js";
 export class BaseInference {
     constructor(serverResponse) {
         this.id = serverResponse["id"];
+        this.job = new InferenceJob(serverResponse["job"]);
         this.model = new InferenceModel(serverResponse["model"]);
         this.file = new InferenceFile(serverResponse["file"]);
     }

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

@@ -0,0 +1,9 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+export declare class InferenceJob {
+    /**
+     * UUID of the Job.
+     */
+    id: string;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

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

@@ -0,0 +1,10 @@
+export class InferenceJob {
+    constructor(serverResponse) {
+        this.id = serverResponse["id"];
+    }
+    toString() {
+        return ("Job\n" +
+            "===\n" +
+            `:ID: ${this.id}\n`);
+    }
+}

package/src/v2/product/baseProduct.d.ts

@@ -1,5 +1,10 @@
 import { BaseParameters } from "../../v2/client/index.js";
 import { ResponseConstructor } from "../../v2/parsing/index.js";
+/**
+ * Base class for all V2 product definitions.
+ *
+ * Child classes are passed to the Client when making requests.
+ */
 export declare abstract class BaseProduct {
     static get parametersClass(): new (...args: any[]) => BaseParameters;
     static get responseClass(): ResponseConstructor<any>;

package/src/v2/product/baseProduct.js

@@ -1,3 +1,8 @@
+/**
+ * Base class for all V2 product definitions.
+ *
+ * Child classes are passed to the Client when making requests.
+ */
 export class BaseProduct {
     static get parametersClass() {
         throw new Error("Must define static parameters property");

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

@@ -1,6 +1,9 @@
 import { ClassificationResponse } from "./classificationResponse.js";
 import { ClassificationParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Automatically sort any image or scanned document into categories.
+ */
 export declare class Classification extends BaseProduct {
     static get parametersClass(): typeof ClassificationParameters;
     static get responseClass(): typeof ClassificationResponse;

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

@@ -1,6 +1,9 @@
 import { ClassificationResponse } from "./classificationResponse.js";
 import { ClassificationParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Automatically sort any image or scanned document into categories.
+ */
 export class Classification extends BaseProduct {
     static get parametersClass() {
         return ClassificationParameters;

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

@@ -1,6 +1,9 @@
 import { CropResponse } from "./cropResponse.js";
 import { CropParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Identify the borders of documents on each page, matching each one to a category.
+ */
 export declare class Crop extends BaseProduct {
     static get parametersClass(): typeof CropParameters;
     static get responseClass(): typeof CropResponse;

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

@@ -1,6 +1,9 @@
 import { CropResponse } from "./cropResponse.js";
 import { CropParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Identify the borders of documents on each page, matching each one to a category.
+ */
 export class Crop extends BaseProduct {
     static get parametersClass() {
         return CropParameters;

package/src/v2/product/extraction/extraction.d.ts

@@ -1,6 +1,9 @@
 import { ExtractionResponse } from "./extractionResponse.js";
 import { ExtractionParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Automatically extract structured data from any image or scanned document.
+ */
 export declare class Extraction extends BaseProduct {
     static get parametersClass(): typeof ExtractionParameters;
     static get responseClass(): typeof ExtractionResponse;

package/src/v2/product/extraction/extraction.js

@@ -1,6 +1,9 @@
 import { ExtractionResponse } from "./extractionResponse.js";
 import { ExtractionParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Automatically extract structured data from any image or scanned document.
+ */
 export class Extraction extends BaseProduct {
     static get parametersClass() {
         return ExtractionParameters;

package/src/v2/product/ocr/ocr.d.ts

@@ -1,6 +1,9 @@
 import { OcrResponse } from "./ocrResponse.js";
 import { OcrParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Extract raw text (OCR) from any image or scanned document.
+ */
 export declare class Ocr extends BaseProduct {
     static get parametersClass(): typeof OcrParameters;
     static get responseClass(): typeof OcrResponse;

package/src/v2/product/ocr/ocr.js

@@ -1,6 +1,9 @@
 import { OcrResponse } from "./ocrResponse.js";
 import { OcrParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Extract raw text (OCR) from any image or scanned document.
+ */
 export class Ocr extends BaseProduct {
     static get parametersClass() {
         return OcrParameters;

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

@@ -1,6 +1,9 @@
 import { SplitResponse } from "./splitResponse.js";
 import { SplitParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Break a multipage source file into separate documents, associating a class for each one.
+ */
 export declare class Split extends BaseProduct {
     static get parametersClass(): typeof SplitParameters;
     static get responseClass(): typeof SplitResponse;

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

@@ -1,6 +1,9 @@
 import { SplitResponse } from "./splitResponse.js";
 import { SplitParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Break a multipage source file into separate documents, associating a class for each one.
+ */
 export class Split extends BaseProduct {
     static get parametersClass() {
         return SplitParameters;