mindee 4.29.0-rc2 → 4.29.0-rc4

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # CHANGELOG
 
+## v4.29.0-rc4 - 2025-07-29
+### Changes
+* :sparkles: add support for page count & mime type + fix syntaxes
+* :recycle: update internal field syntaxes to match other SDKs
+* :recycle: upgrade toString() display for most fields
+* :recycle: fix internals & upgrade tests
+
+
+## v4.29.0-rc3 - 2025-07-25
+### Changes
+* :sparkles: add support for URL input source
+### Fixes
+* :arrow_up: bump dependencies to cover vulnerabilities
+
+
 ## v4.29.0-rc2 - 2025-07-25
 ### Changes
 * :recycle: harmonize with other client libraries

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "4.29.0-rc2",
+    "version": "4.29.0-rc4",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",

package/src/clientV2.d.ts

@@ -1,4 +1,4 @@
-import { Base64Input, BufferInput, BytesInput, LocalInputSource, PathInput, StreamInput, UrlInput } from "./input";
+import { Base64Input, BufferInput, BytesInput, InputSource, PathInput, StreamInput, UrlInput } from "./input";
 import { InferenceResponse, JobResponse } from "./parsing/v2";
 import { MindeeApiV2 } from "./http/mindeeApiV2";
 import { Readable } from "stream";
@@ -106,7 +106,7 @@ export interface ClientOptions {
  */
 export declare class ClientV2 {
     #private;
-    /** Key of the API. */
+    /** Mindee API handler. */
     protected mindeeApi: MindeeApiV2;
     /**
      * @param {ClientOptions} options options for the initialization of a client.
@@ -114,12 +114,12 @@ export declare class ClientV2 {
     constructor({ apiKey, throwOnError, debug }?: ClientOptions);
     /**
      * Send the document to an asynchronous endpoint and return its ID in the queue.
-     * @param inputSource file to parse.
+     * @param inputSource file or URL to parse.
      * @param params parameters relating to prediction options.
      * @category Asynchronous
      * @returns a `Promise` containing the job (queue) corresponding to a document.
      */
-    enqueueInference(inputSource: LocalInputSource, params: InferenceParameters): Promise<JobResponse>;
+    enqueueInference(inputSource: InputSource, params: InferenceParameters): Promise<JobResponse>;
     /**
      * Retrieves an inference.
      *
@@ -152,7 +152,7 @@ export declare class ClientV2 {
      * @category Synchronous
      * @returns a `Promise` containing parsing results.
      */
-    enqueueAndGetInference(inputDoc: LocalInputSource, params: InferenceParameters): Promise<InferenceResponse>;
+    enqueueAndGetInference(inputDoc: InputSource, params: InferenceParameters): Promise<InferenceResponse>;
     /**
      * Load an input source from a local path.
      * @param inputPath

package/src/clientV2.js

@@ -38,7 +38,7 @@ class ClientV2 {
     }
     /**
      * Send the document to an asynchronous endpoint and return its ID in the queue.
-     * @param inputSource file to parse.
+     * @param inputSource file or URL to parse.
      * @param params parameters relating to prediction options.
      * @category Asynchronous
      * @returns a `Promise` containing the job (queue) corresponding to a document.

package/src/http/mindeeApiV2.d.ts

@@ -1,20 +1,20 @@
 import { ApiSettingsV2 } from "./apiSettingsV2";
 import { InferenceParameters } from "../clientV2";
 import { InferenceResponse, JobResponse } from "../parsing/v2";
-import { LocalInputSource } from "../input";
+import { InputSource } from "../input";
 export declare class MindeeApiV2 {
     #private;
     settings: ApiSettingsV2;
     constructor(apiKey?: string);
     /**
      * Sends a file to the inference queue.
-     * @param inputDoc Local file loaded as an input.
+     * @param inputSource Local file loaded as an input.
      * @param params {InferenceParameters} parameters relating to the enqueueing options.
      * @category V2
      * @throws Error if the server's response contains one.
      * @returns a `Promise` containing a job response.
      */
-    reqPostInferenceEnqueue(inputDoc: LocalInputSource, params: InferenceParameters): Promise<JobResponse>;
+    reqPostInferenceEnqueue(inputSource: InputSource, params: InferenceParameters): Promise<JobResponse>;
     /**
      * Requests the job of a queued document from the API.
      * Throws an error if the server's response contains one.

package/src/http/mindeeApiV2.js

@@ -14,6 +14,7 @@ const apiSettingsV2_1 = require("./apiSettingsV2");
 const v2_1 = require("../parsing/v2");
 const form_data_1 = __importDefault(require("form-data"));
 const baseEndpoint_1 = require("./baseEndpoint");
+const input_1 = require("../input");
 const mindeeError_1 = require("../errors/mindeeError");
 const logger_1 = require("../logger");
 class MindeeApiV2 {
@@ -23,18 +24,18 @@ class MindeeApiV2 {
     }
     /**
      * Sends a file to the inference queue.
-     * @param inputDoc Local file loaded as an input.
+     * @param inputSource Local file loaded as an input.
      * @param params {InferenceParameters} parameters relating to the enqueueing options.
      * @category V2
      * @throws Error if the server's response contains one.
      * @returns a `Promise` containing a job response.
      */
-    async reqPostInferenceEnqueue(inputDoc, params) {
-        await inputDoc.init();
+    async reqPostInferenceEnqueue(inputSource, params) {
+        await inputSource.init();
         if (params.modelId === undefined || params.modelId === null || params.modelId === "") {
             throw new Error("Model ID must be provided");
         }
-        const result = await __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_documentEnqueuePost).call(this, inputDoc, params);
+        const result = await __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_documentEnqueuePost).call(this, inputSource, params);
         if (result.data.error?.code !== undefined) {
             throw new mindeeError_1.MindeeHttpErrorV2(result.data.error.code, result.data.error.message ?? "Unknown error.");
         }
@@ -78,7 +79,7 @@ _MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_processResponse = function
         logger_1.logger.error(`Raised '${e}' Couldn't deserialize response object:\n${JSON.stringify(result.data)}`);
         throw new mindeeError_1.MindeeApiV2Error("Couldn't deserialize response object.");
     }
-}, _MindeeApiV2_documentEnqueuePost = function _MindeeApiV2_documentEnqueuePost(inputDoc, params) {
+}, _MindeeApiV2_documentEnqueuePost = function _MindeeApiV2_documentEnqueuePost(inputSource, params) {
     const form = new form_data_1.default();
     form.append("model_id", params.modelId);
     if (params.rag) {
@@ -87,9 +88,14 @@ _MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_processResponse = function
     if (params.webhookIds && params.webhookIds.length > 0) {
         form.append("webhook_ids", params.webhookIds.join(","));
     }
-    form.append("file", inputDoc.fileObject, {
-        filename: inputDoc.filename,
-    });
+    if (inputSource instanceof input_1.LocalInputSource) {
+        form.append("file", inputSource.fileObject, {
+            filename: inputSource.filename,
+        });
+    }
+    else {
+        form.append("url", inputSource.url);
+    }
     const path = "/v2/inferences/enqueue";
     const headers = { ...this.settings.baseHeaders, ...form.getHeaders() };
     const options = {

package/src/input/sources/urlInput.d.ts

@@ -1,7 +1,7 @@
 import { InputSource } from "./inputSource";
 import { BytesInput } from "./bytesInput";
 export declare class UrlInput extends InputSource {
-    private readonly url;
+    readonly url: string;
     constructor({ url }: {
         url: string;
     });

package/src/parsing/v2/field/baseField.d.ts

@@ -1,9 +1,7 @@
 import { FieldConfidence } from "./fieldConfidence";
-import { FieldLocation } from "./fieldLocation";
 import { StringDict } from "../../common";
 export declare abstract class BaseField {
     protected _indentLevel: number;
-    locations: Array<FieldLocation> | undefined;
     confidence: FieldConfidence | undefined;
     protected constructor(rawResponse: StringDict, indentLevel?: number);
 }

package/src/parsing/v2/field/baseField.js

@@ -1,15 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseField = void 0;
-const fieldLocation_1 = require("./fieldLocation");
 class BaseField {
     constructor(rawResponse, indentLevel = 0) {
         this._indentLevel = indentLevel;
-        if (rawResponse["locations"]) {
-            this.locations = rawResponse["locations"].map((location) => {
-                return location ? new fieldLocation_1.FieldLocation(location) : "";
-            });
-        }
         if (rawResponse["confidence"] !== undefined) {
             this.confidence = rawResponse["confidence"];
         }

package/src/parsing/v2/field/dynamicField.d.ts

@@ -0,0 +1,7 @@
+import { BaseField } from "./baseField";
+import { FieldLocation } from "./fieldLocation";
+import { StringDict } from "../../common";
+export declare class DynamicField extends BaseField {
+    locations: Array<FieldLocation> | undefined;
+    constructor(rawResponse: StringDict, indentLevel?: number);
+}

package/src/parsing/v2/field/dynamicField.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamicField = void 0;
+const baseField_1 = require("./baseField");
+const fieldLocation_1 = require("./fieldLocation");
+class DynamicField extends baseField_1.BaseField {
+    constructor(rawResponse, indentLevel = 0) {
+        super(rawResponse, indentLevel);
+        if (rawResponse["locations"]) {
+            this.locations = rawResponse["locations"].map((location) => {
+                return location ? new fieldLocation_1.FieldLocation(location) : "";
+            });
+        }
+    }
+}
+exports.DynamicField = DynamicField;

package/src/parsing/v2/field/inferenceFields.js

@@ -27,8 +27,8 @@ class InferenceFields extends Map {
                 line += fieldValue.toString();
             }
             else if (fieldValue.constructor.name === "SimpleField") {
-                const val = fieldValue.value;
-                line += val !== null && val !== undefined ? " " + val.toString() : "";
+                const val = fieldValue.toString();
+                line += val.length > 0 ? " " + val.toString() : "";
             }
             lines.push(line);
         }

package/src/parsing/v2/field/objectField.d.ts

@@ -1,7 +1,7 @@
-import { BaseField } from "./baseField";
 import { InferenceFields } from "./inferenceFields";
 import { StringDict } from "../../common";
-export declare class ObjectField extends BaseField {
+import { DynamicField } from "./dynamicField";
+export declare class ObjectField extends DynamicField {
     readonly fields: InferenceFields;
     constructor(serverResponse: StringDict, indentLevel?: number);
     toString(): string;

package/src/parsing/v2/field/objectField.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ObjectField = void 0;
-const baseField_1 = require("./baseField");
 const inferenceFields_1 = require("./inferenceFields");
-class ObjectField extends baseField_1.BaseField {
+const dynamicField_1 = require("./dynamicField");
+class ObjectField extends dynamicField_1.DynamicField {
     constructor(serverResponse, indentLevel = 0) {
         super(serverResponse, indentLevel);
         this.fields = new inferenceFields_1.InferenceFields(serverResponse["fields"], this._indentLevel + 1);

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

@@ -1,6 +1,6 @@
-import { BaseField } from "./baseField";
 import { StringDict } from "../../common";
-export declare class SimpleField extends BaseField {
+import { DynamicField } from "./dynamicField";
+export declare class SimpleField extends DynamicField {
     readonly value: string | number | boolean | null;
     constructor(serverResponse: StringDict, indentLevel?: number);
     toString(): string;

package/src/parsing/v2/field/simpleField.js

@@ -1,17 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SimpleField = void 0;
-const baseField_1 = require("./baseField");
-class SimpleField extends baseField_1.BaseField {
+const dynamicField_1 = require("./dynamicField");
+class SimpleField extends dynamicField_1.DynamicField {
     constructor(serverResponse, indentLevel = 0) {
         super(serverResponse, indentLevel);
         this.value =
             serverResponse["value"] !== undefined ? serverResponse["value"] : null;
     }
     toString() {
-        return this.value !== null && this.value !== undefined
-            ? this.value.toString()
-            : "";
+        if (this.value === null) {
+            return "";
+        }
+        if (typeof this.value === "number" && Number.isInteger(this.value)) {
+            return this.value.toString() + ".0";
+        }
+        if (typeof this.value === "boolean") {
+            return this.value ? "True" : "False";
+        }
+        return this.value.toString();
     }
 }
 exports.SimpleField = SimpleField;

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

@@ -1,12 +1,12 @@
 export { CommonResponse } from "./commonResponse";
 export { ErrorResponse } from "./errorResponse";
 export { Inference } from "./inference";
-export { InferenceResultFile } from "./inferenceResultFile";
-export { InferenceResultModel } from "./inferenceResultModel";
+export { InferenceFile } from "./inferenceFile";
+export { InferenceModel } from "./inferenceModel";
 export { InferenceResultOptions } from "./inferenceResultOptions";
 export { InferenceResponse } from "./inferenceResponse";
 export { InferenceResult } from "./inferenceResult";
 export { Job } from "./job";
 export { JobResponse } from "./jobResponse";
 export { RawText } from "./rawText";
-export { JobResponseWebhook } from "./jobResponseWebhook";
+export { JobWebhook } from "./jobWebhook";

package/src/parsing/v2/index.js

@@ -1,16 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.JobResponseWebhook = exports.RawText = exports.JobResponse = exports.Job = exports.InferenceResult = exports.InferenceResponse = exports.InferenceResultOptions = exports.InferenceResultModel = exports.InferenceResultFile = exports.Inference = exports.ErrorResponse = exports.CommonResponse = void 0;
+exports.JobWebhook = exports.RawText = exports.JobResponse = exports.Job = exports.InferenceResult = exports.InferenceResponse = exports.InferenceResultOptions = exports.InferenceModel = exports.InferenceFile = exports.Inference = exports.ErrorResponse = exports.CommonResponse = void 0;
 var commonResponse_1 = require("./commonResponse");
 Object.defineProperty(exports, "CommonResponse", { enumerable: true, get: function () { return commonResponse_1.CommonResponse; } });
 var errorResponse_1 = require("./errorResponse");
 Object.defineProperty(exports, "ErrorResponse", { enumerable: true, get: function () { return errorResponse_1.ErrorResponse; } });
 var inference_1 = require("./inference");
 Object.defineProperty(exports, "Inference", { enumerable: true, get: function () { return inference_1.Inference; } });
-var inferenceResultFile_1 = require("./inferenceResultFile");
-Object.defineProperty(exports, "InferenceResultFile", { enumerable: true, get: function () { return inferenceResultFile_1.InferenceResultFile; } });
-var inferenceResultModel_1 = require("./inferenceResultModel");
-Object.defineProperty(exports, "InferenceResultModel", { enumerable: true, get: function () { return inferenceResultModel_1.InferenceResultModel; } });
+var inferenceFile_1 = require("./inferenceFile");
+Object.defineProperty(exports, "InferenceFile", { enumerable: true, get: function () { return inferenceFile_1.InferenceFile; } });
+var inferenceModel_1 = require("./inferenceModel");
+Object.defineProperty(exports, "InferenceModel", { enumerable: true, get: function () { return inferenceModel_1.InferenceModel; } });
 var inferenceResultOptions_1 = require("./inferenceResultOptions");
 Object.defineProperty(exports, "InferenceResultOptions", { enumerable: true, get: function () { return inferenceResultOptions_1.InferenceResultOptions; } });
 var inferenceResponse_1 = require("./inferenceResponse");
@@ -23,5 +23,5 @@ var jobResponse_1 = require("./jobResponse");
 Object.defineProperty(exports, "JobResponse", { enumerable: true, get: function () { return jobResponse_1.JobResponse; } });
 var rawText_1 = require("./rawText");
 Object.defineProperty(exports, "RawText", { enumerable: true, get: function () { return rawText_1.RawText; } });
-var jobResponseWebhook_1 = require("./jobResponseWebhook");
-Object.defineProperty(exports, "JobResponseWebhook", { enumerable: true, get: function () { return jobResponseWebhook_1.JobResponseWebhook; } });
+var jobWebhook_1 = require("./jobWebhook");
+Object.defineProperty(exports, "JobWebhook", { enumerable: true, get: function () { return jobWebhook_1.JobWebhook; } });

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

@@ -1,16 +1,16 @@
 import { StringDict } from "../common";
-import { InferenceResultModel } from "./inferenceResultModel";
+import { InferenceModel } from "./inferenceModel";
 import { InferenceResult } from "./inferenceResult";
-import { InferenceResultFile } from "./inferenceResultFile";
+import { InferenceFile } from "./inferenceFile";
 export declare class Inference {
     /**
      * Model info for the inference.
      */
-    model: InferenceResultModel;
+    model: InferenceModel;
     /**
      * File info for the inference.
      */
-    file: InferenceResultFile;
+    file: InferenceFile;
     /**
      * Result of the inference.
      */

package/src/parsing/v2/inference.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Inference = void 0;
-const inferenceResultModel_1 = require("./inferenceResultModel");
+const inferenceModel_1 = require("./inferenceModel");
 const inferenceResult_1 = require("./inferenceResult");
-const inferenceResultFile_1 = require("./inferenceResultFile");
+const inferenceFile_1 = require("./inferenceFile");
 class Inference {
     constructor(serverResponse) {
-        this.model = new inferenceResultModel_1.InferenceResultModel(serverResponse["model"]);
-        this.file = new inferenceResultFile_1.InferenceResultFile(serverResponse["file"]);
+        this.model = new inferenceModel_1.InferenceModel(serverResponse["model"]);
+        this.file = new inferenceFile_1.InferenceFile(serverResponse["file"]);
         this.result = new inferenceResult_1.InferenceResult(serverResponse["result"]);
         if ("id" in serverResponse) {
             this.id = serverResponse["id"];

package/src/parsing/v2/{inferenceResultFile.d.ts → inferenceFile.d.ts}

@@ -1,5 +1,5 @@
 import { StringDict } from "../common";
-export declare class InferenceResultFile {
+export declare class InferenceFile {
     /**
      * Name of the file.
      */
@@ -8,6 +8,14 @@ export declare class InferenceResultFile {
      * Optional alias for the file.
      */
     alias: string;
+    /**
+     * Page count.
+     */
+    pageCount: number;
+    /**
+     * MIME type.
+     */
+    mimeType: string;
     constructor(serverResponse: StringDict);
     toString(): string;
 }

package/src/parsing/v2/inferenceFile.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InferenceFile = void 0;
+class InferenceFile {
+    constructor(serverResponse) {
+        this.name = serverResponse["name"];
+        this.alias = serverResponse["alias"];
+        this.pageCount = serverResponse["page_count"];
+        this.mimeType = serverResponse["mime_type"];
+    }
+    toString() {
+        return ("File\n" +
+            "====\n" +
+            `:Name: ${this.name}\n` +
+            `:Alias:${this.alias ? " " + this.alias : ""}\n`) +
+            `:Page Count: ${this.pageCount}\n` +
+            `:MIME Type: ${this.mimeType}\n`;
+    }
+}
+exports.InferenceFile = InferenceFile;

package/src/parsing/v2/{inferenceResultModel.d.ts → inferenceModel.d.ts}

@@ -1,5 +1,5 @@
 import { StringDict } from "../common";
-export declare class InferenceResultModel {
+export declare class InferenceModel {
     /**
      * ID of the model.
      */

package/src/parsing/v2/{inferenceResultModel.js → inferenceModel.js}

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InferenceResultModel = void 0;
-class InferenceResultModel {
+exports.InferenceModel = void 0;
+class InferenceModel {
     constructor(serverResponse) {
         this.id = serverResponse["id"];
     }
 }
-exports.InferenceResultModel = InferenceResultModel;
+exports.InferenceModel = InferenceModel;

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

@@ -1,6 +1,6 @@
 import { StringDict } from "../common";
 import { ErrorResponse } from "./errorResponse";
-import { JobResponseWebhook } from "./jobResponseWebhook";
+import { JobWebhook } from "./jobWebhook";
 /**
  * Job information for a V2 polling attempt.
  */
@@ -44,6 +44,6 @@ export declare class Job {
     /**
      * ID of webhooks associated with the job.
      */
-    webhooks: Array<JobResponseWebhook>;
+    webhooks: Array<JobWebhook>;
     constructor(serverResponse: StringDict);
 }

package/src/parsing/v2/job.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Job = void 0;
 const errorResponse_1 = require("./errorResponse");
-const dateParser_1 = require("../common/dateParser");
+const common_1 = require("../common");
 /**
  * Job information for a V2 polling attempt.
  */
@@ -17,7 +17,7 @@ class Job {
             Object.keys(serverResponse["error"]).length > 0) {
             this.error = new errorResponse_1.ErrorResponse(serverResponse["error"]);
         }
-        this.createdAt = (0, dateParser_1.parseDate)(serverResponse["created_at"]);
+        this.createdAt = (0, common_1.parseDate)(serverResponse["created_at"]);
         this.modelId = serverResponse["model_id"];
         this.pollingUrl = serverResponse["polling_url"];
         this.filename = serverResponse["filename"];

package/src/parsing/v2/{jobResponseWebhook.d.ts → jobWebhook.d.ts}

@@ -1,11 +1,11 @@
 import { ErrorResponse } from "./errorResponse";
 import { StringDict } from "../common";
 /**
- * JobResponseWebhook information.
+ * JobWebhook information.
  */
-export declare class JobResponseWebhook {
+export declare class JobWebhook {
     /**
-     * JobResponseWebhook ID.
+     * JobWebhook ID.
      */
     id: string;
     /**

package/src/parsing/v2/{jobResponseWebhook.js → jobWebhook.js}

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.JobResponseWebhook = void 0;
+exports.JobWebhook = void 0;
 const errorResponse_1 = require("./errorResponse");
 const common_1 = require("../common");
 /**
- * JobResponseWebhook information.
+ * JobWebhook information.
  */
-class JobResponseWebhook {
+class JobWebhook {
     constructor(serverResponse) {
         this.id = serverResponse["id"];
         this.createdAt = (0, common_1.parseDate)(serverResponse["created_at"]);
@@ -16,4 +16,4 @@ class JobResponseWebhook {
         }
     }
 }
-exports.JobResponseWebhook = JobResponseWebhook;
+exports.JobWebhook = JobWebhook;

package/src/parsing/v2/inferenceResultFile.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InferenceResultFile = void 0;
-class InferenceResultFile {
-    constructor(serverResponse) {
-        this.name = serverResponse["name"];
-        this.alias = serverResponse["alias"];
-    }
-    toString() {
-        return ("File\n" +
-            "====\n" +
-            `:Name: ${this.name}\n` +
-            `:Alias:${this.alias ? " " + this.alias : ""}\n`);
-    }
-}
-exports.InferenceResultFile = InferenceResultFile;