mindee 4.29.0-rc2 → 4.29.0-rc3

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 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-rc3",
     "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/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,8 +1,8 @@
 "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 =