mindee 4.29.0-rc1 → 4.29.0-rc2

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v4.29.0-rc2 - 2025-07-25
+### Changes
+* :recycle: harmonize with other client libraries
+
 ## v4.29.0-rc1 - 2025-07-21
 ### Changes
 * :sparkles: add support for V2 client

package/README.md

@@ -3,163 +3,39 @@
 # Mindee API Helper Library for Node.js
 Quickly and easily connect to Mindee's API services using Node.js.
 
-## Quick Start
-Here's the TL;DR of getting started.
+## Mindee API Versions
+This client library has support for both Mindee platform versions.
 
-First, get an [API Key](https://developers.mindee.com/docs/create-api-key)
+### Latest - V2
+This is the new platform located here:
 
-Then, install this library:
-```shell
-npm install mindee
-```
+https://app.mindee.com
 
-Finally, Node.js away!
+It uses **API version 2**.
 
-### Loading a File and Parsing It
+Consult the
+**[Latest Documentation](https://docs.mindee.com/integrations/client-libraries-sdk)**
 
-#### Global Documents
-```js
-const mindee = require("mindee");
-// for TS or modules:
-// import * as mindee from "mindee";
 
-// Init a new client
-const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
+### Legacy - V1
+This is the legacy platform located here:
 
-// Load a file from disk
-const inputSource = mindeeClient.docFromPath("/path/to/the/file.ext");
+https://platform.mindee.com/
 
-// Parse it on the API of your choice
-const apiResponse = mindeeClient.parse(mindee.product.InvoiceV4, inputSource);
-```
+It uses **API version 1**.
 
-**Note:** Files can also be loaded from:
-
-A base64 encoded string:
-```js
-const inputSource = mindeeClient.docFromBase64(myInputString, "my-file-name.ext")
-```
+Consult the
+**[Legacy Documentation](https://developers.mindee.com/docs/nodejs-getting-started)**
 
-A byte sequence:
-```js
-const inputSource = mindeeClient.docFromBytes(myInputBytes, "my-file-name.ext")
-```
+## Additional Information
 
-A stream:
-```js
-const inputSource = mindeeClient.docFromStream(myReadableStream, "my-file-name.ext")
-```
-
-A buffer:
-```js
-const inputSource = mindeeClient.docFromBuffer(myBuffer, "my-file-name.ext")
-```
-
-A URL (`https` only):
-```js
-const inputSource = mindeeClient.docFromUrl("https://my-url");
-```
-
-You can also load the document locally before sending it:
-```js
-const inputSource = mindeeClient.docFromUrl("https://my-url");
-await inputSource.init();
-const localInputSource = inputSource.asLocalInputSource();
-```
-
-**Note:** Files hidden behind redirections are rejected by the server; this solution helps to circumvent that issue.
-
-#### Region-Specific Documents
-
-Region-Specific Documents use the following syntax:
-
-```js
-const mindee = require("mindee");
-// for TS or modules:
-// import * as mindee from "mindee";
-
-const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
-
-const inputSource = mindeeClient.docFromPath("/path/to/the/file.ext");
-
-// The IdCardV1 product belongs to mindee.product.fr, not mindee.product itself
-const apiResponse = mindeeClient.parse(mindee.product.fr.IdCardV1, inputSource);
-```
-
-#### Custom Documents (docTI & Custom APIs)
-
-Custom documents will require you to provide their endpoint manually.
-
-```js
-const mindee = require("mindee");
-// for TS or modules:
-// import * as mindee from "mindee";
-
-// Init a new client
-const mindeeClient = new mindee.Client({
-  apiKey: "my-api-key"
-});
-
-// Load a file from disk
-const inputSource = mindeeClient.docFromPath("/path/to/the/file.ext");
-
-// Create a custom endpoint for your product
-const customEndpoint = mindeeClient.createEndpoint(
-  "my-endpoint",
-  "my-account",
-  "my-version" // will default to 1 if not provided
-);
-
-// Parse it
-const apiResponse = await mindeeClient
-  .enqueueAndParse(
-    mindee.product.GeneratedV1,
-    inputSource,
-    {
-      endpoint: customEndpoint
-    }
-  );
-```
-
-### Handling the Return
-```js
-// Handle the response Promise
-apiResponse.then((resp) => {
-    // print a string summary
-    console.log(resp.document.toString());
-
-    // individual pages (array)
-    console.log(res.document.inference.pages);
-});
-```
-
-### Additional Options
-Options to pass when sending a file to be parsed.
-
-#### Page Options
-Allows only sending certain pages in a PDF.
-
-In this example we only send the first, penultimate, and last pages:
-
-```js
-const apiResponse = mindeeClient.parse(
-  mindee.product.InvoiceV4,
-  inputSource,
-  {
-    pageOptions: {
-      pageIndexes: [0, -2, -1],
-      operation: mindee.PageOptionsOperation.KeepOnly,
-      onMinPages: 2
-    }
-  });
-```
-
-You can also take a look at the **[Reference Documentation](https://mindee.github.io/mindee-api-nodejs/)**.
-
-## License
+**[Source Code](https://github.com/mindee/mindee-api-nodejs)**
+
+**[Reference Documentation](https://mindee.github.io/mindee-api-nodejs/)**
+
+**[Feedback](https://feedback.mindee.com/)**
+
+### License
 Copyright © Mindee
 
 Available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

package/package.json

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

package/src/client.d.ts

@@ -3,7 +3,8 @@ import { Endpoint } from "./http";
 import { AsyncPredictResponse, ExecutionPriority, FeedbackResponse, Inference, PredictResponse, StringDict } from "./parsing/common";
 import { GeneratedV1 } from "./product";
 import { WorkflowResponse } from "./parsing/common/workflowResponse";
-import { BaseClient } from "./baseClient";
+import { Base64Input, BufferInput, BytesInput, PathInput, StreamInput, UrlInput } from "./input";
+import { Readable } from "stream";
 /**
  * Common options for workflows & predictions.
  */
@@ -103,7 +104,7 @@ export interface ClientOptions {
  *
  * @category Client
  */
-export declare class Client extends BaseClient {
+export declare class Client {
     #private;
     /** Key of the API. */
     protected apiKey: string;
@@ -211,5 +212,39 @@ export declare class Client extends BaseClient {
      * @returns Endpoint a new product endpoint
      */
     createEndpoint(endpointName: string, accountName: string, endpointVersion?: string): Endpoint;
+    /**
+     * Load an input document from a local path.
+     * @param inputPath
+     */
+    docFromPath(inputPath: string): PathInput;
+    /**
+     * Load an input document from a base64 encoded string.
+     * @param inputString input content, as a string.
+     * @param filename file name.
+     */
+    docFromBase64(inputString: string, filename: string): Base64Input;
+    /**
+     * Load an input document from a `stream.Readable` object.
+     * @param inputStream input content, as a readable stream.
+     * @param filename file name.
+     */
+    docFromStream(inputStream: Readable, filename: string): StreamInput;
+    /**
+     * Load an input document from bytes.
+     * @param inputBytes input content, as a Uint8Array or Buffer.
+     * @param filename file name.
+     */
+    docFromBytes(inputBytes: Uint8Array, filename: string): BytesInput;
+    /**
+     * Load an input document from a URL.
+     * @param url input url. Must be HTTPS.
+     */
+    docFromUrl(url: string): UrlInput;
+    /**
+     * Load an input document from a Buffer.
+     * @param buffer input content, as a buffer.
+     * @param filename file name.
+     */
+    docFromBuffer(buffer: Buffer, filename: string): BufferInput;
 }
 export {};

package/src/client.js

@@ -17,13 +17,13 @@ const promises_1 = require("node:timers/promises");
 const errors_1 = require("./errors");
 const workflowResponse_1 = require("./parsing/common/workflowResponse");
 const workflowEndpoint_1 = require("./http/workflowEndpoint");
-const baseClient_1 = require("./baseClient");
+const input_1 = require("./input");
 /**
  * Mindee Client class that centralizes most basic operations.
  *
  * @category Client
  */
-class Client extends baseClient_1.BaseClient {
+class Client {
     /**
      * @param {ClientOptions} options options for the initialization of a client.
      */
@@ -32,7 +32,6 @@ class Client extends baseClient_1.BaseClient {
         throwOnError: true,
         debug: false,
     }) {
-        super();
         _Client_instances.add(this);
         this.apiKey = apiKey ? apiKey : "";
         handler_1.errorHandler.throwOnError = throwOnError ?? true;
@@ -271,6 +270,68 @@ Job status: ${pollResults.job.status}.`);
         }
         return __classPrivateFieldGet(this, _Client_instances, "m", _Client_buildProductEndpoint).call(this, endpointName, cleanAccountName, cleanEndpointVersion);
     }
+    /**
+     * Load an input document from a local path.
+     * @param inputPath
+     */
+    docFromPath(inputPath) {
+        return new input_1.PathInput({
+            inputPath: inputPath,
+        });
+    }
+    /**
+     * Load an input document from a base64 encoded string.
+     * @param inputString input content, as a string.
+     * @param filename file name.
+     */
+    docFromBase64(inputString, filename) {
+        return new input_1.Base64Input({
+            inputString: inputString,
+            filename: filename,
+        });
+    }
+    /**
+     * Load an input document from a `stream.Readable` object.
+     * @param inputStream input content, as a readable stream.
+     * @param filename file name.
+     */
+    docFromStream(inputStream, filename) {
+        return new input_1.StreamInput({
+            inputStream: inputStream,
+            filename: filename,
+        });
+    }
+    /**
+     * Load an input document from bytes.
+     * @param inputBytes input content, as a Uint8Array or Buffer.
+     * @param filename file name.
+     */
+    docFromBytes(inputBytes, filename) {
+        return new input_1.BytesInput({
+            inputBytes: inputBytes,
+            filename: filename,
+        });
+    }
+    /**
+     * Load an input document from a URL.
+     * @param url input url. Must be HTTPS.
+     */
+    docFromUrl(url) {
+        return new input_1.UrlInput({
+            url: url,
+        });
+    }
+    /**
+     * Load an input document from a Buffer.
+     * @param buffer input content, as a buffer.
+     * @param filename file name.
+     */
+    docFromBuffer(buffer, filename) {
+        return new input_1.BufferInput({
+            buffer: buffer,
+            filename: filename,
+        });
+    }
 }
 exports.Client = Client;
 _Client_instances = new WeakSet(), _Client_setAsyncParams = function _Client_setAsyncParams(asyncParams) {

package/src/clientV2.d.ts

@@ -1,7 +1,7 @@
-import { LocalInputSource } from "./input";
+import { Base64Input, BufferInput, BytesInput, LocalInputSource, PathInput, StreamInput, UrlInput } from "./input";
 import { InferenceResponse, JobResponse } from "./parsing/v2";
 import { MindeeApiV2 } from "./http/mindeeApiV2";
-import { BaseClient } from "./baseClient";
+import { Readable } from "stream";
 /**
  * Parameters for the internal polling loop in {@link ClientV2.enqueueAndGetInference | enqueueAndGetInference()} .
  *
@@ -104,7 +104,7 @@ export interface ClientOptions {
  *
  * @category ClientV2
  */
-export declare class ClientV2 extends BaseClient {
+export declare class ClientV2 {
     #private;
     /** Key of the API. */
     protected mindeeApi: MindeeApiV2;
@@ -153,4 +153,38 @@ export declare class ClientV2 extends BaseClient {
      * @returns a `Promise` containing parsing results.
      */
     enqueueAndGetInference(inputDoc: LocalInputSource, params: InferenceParameters): Promise<InferenceResponse>;
+    /**
+     * Load an input source from a local path.
+     * @param inputPath
+     */
+    sourceFromPath(inputPath: string): PathInput;
+    /**
+     * Load an input source from a base64 encoded string.
+     * @param inputString input content, as a string.
+     * @param filename file name.
+     */
+    sourceFromBase64(inputString: string, filename: string): Base64Input;
+    /**
+     * Load an input source from a `stream.Readable` object.
+     * @param inputStream input content, as a readable stream.
+     * @param filename file name.
+     */
+    sourceFromStream(inputStream: Readable, filename: string): StreamInput;
+    /**
+     * Load an input source from bytes.
+     * @param inputBytes input content, as a Uint8Array or Buffer.
+     * @param filename file name.
+     */
+    sourceFromBytes(inputBytes: Uint8Array, filename: string): BytesInput;
+    /**
+     * Load an input source from a Buffer.
+     * @param buffer input content, as a buffer.
+     * @param filename file name.
+     */
+    sourceFromBuffer(buffer: Buffer, filename: string): BufferInput;
+    /**
+     * Load an input source from a URL.
+     * @param url input url. Must be HTTPS.
+     */
+    sourceFromUrl(url: string): UrlInput;
 }

package/src/clientV2.js

@@ -7,18 +7,18 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _ClientV2_instances, _ClientV2_setAsyncParams;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientV2 = void 0;
+const input_1 = require("./input");
 const handler_1 = require("./errors/handler");
 const logger_1 = require("./logger");
 const promises_1 = require("node:timers/promises");
 const mindeeApiV2_1 = require("./http/mindeeApiV2");
-const baseClient_1 = require("./baseClient");
 const mindeeError_1 = require("./errors/mindeeError");
 /**
  * Mindee Client V2 class that centralizes most basic operations.
  *
  * @category ClientV2
  */
-class ClientV2 extends baseClient_1.BaseClient {
+class ClientV2 {
     /**
      * @param {ClientOptions} options options for the initialization of a client.
      */
@@ -27,7 +27,6 @@ class ClientV2 extends baseClient_1.BaseClient {
         throwOnError: true,
         debug: false,
     }) {
-        super();
         _ClientV2_instances.add(this);
         this.mindeeApi = new mindeeApiV2_1.MindeeApiV2(apiKey);
         handler_1.errorHandler.throwOnError = throwOnError ?? true;
@@ -120,6 +119,68 @@ Job status: ${pollResults.job.status}.`);
             validatedAsyncParams.delaySec * retryCounter +
             " seconds");
     }
+    /**
+     * Load an input source from a local path.
+     * @param inputPath
+     */
+    sourceFromPath(inputPath) {
+        return new input_1.PathInput({
+            inputPath: inputPath,
+        });
+    }
+    /**
+     * Load an input source from a base64 encoded string.
+     * @param inputString input content, as a string.
+     * @param filename file name.
+     */
+    sourceFromBase64(inputString, filename) {
+        return new input_1.Base64Input({
+            inputString: inputString,
+            filename: filename,
+        });
+    }
+    /**
+     * Load an input source from a `stream.Readable` object.
+     * @param inputStream input content, as a readable stream.
+     * @param filename file name.
+     */
+    sourceFromStream(inputStream, filename) {
+        return new input_1.StreamInput({
+            inputStream: inputStream,
+            filename: filename,
+        });
+    }
+    /**
+     * Load an input source from bytes.
+     * @param inputBytes input content, as a Uint8Array or Buffer.
+     * @param filename file name.
+     */
+    sourceFromBytes(inputBytes, filename) {
+        return new input_1.BytesInput({
+            inputBytes: inputBytes,
+            filename: filename,
+        });
+    }
+    /**
+     * Load an input source from a Buffer.
+     * @param buffer input content, as a buffer.
+     * @param filename file name.
+     */
+    sourceFromBuffer(buffer, filename) {
+        return new input_1.BufferInput({
+            buffer: buffer,
+            filename: filename,
+        });
+    }
+    /**
+     * Load an input source from a URL.
+     * @param url input url. Must be HTTPS.
+     */
+    sourceFromUrl(url) {
+        return new input_1.UrlInput({
+            url: url,
+        });
+    }
 }
 exports.ClientV2 = ClientV2;
 _ClientV2_instances = new WeakSet(), _ClientV2_setAsyncParams = function _ClientV2_setAsyncParams(asyncParams = undefined) {

package/src/index.d.ts

@@ -2,6 +2,6 @@ export * as product from "./product";
 export { Client, PredictOptions } from "./client";
 export { ClientV2, InferenceParameters, PollingOptions } from "./clientV2";
 export { AsyncPredictResponse, PredictResponse, Inference, Prediction, Document, Page, } from "./parsing/common";
-export { InputSource, PageOptionsOperation, LocalResponse } from "./input";
+export { InputSource, PageOptions, PageOptionsOperation, LocalResponse } from "./input";
 export * as internal from "./internal";
 export * as imageOperations from "./imageOperations";

package/src/baseClient.d.ts

@@ -1,38 +0,0 @@
-import { Base64Input, BufferInput, BytesInput, PathInput, StreamInput, UrlInput } from "./input";
-import { Readable } from "stream";
-export declare abstract class BaseClient {
-    /**
-     * Load an input document from a local path.
-     * @param inputPath
-     */
-    docFromPath(inputPath: string): PathInput;
-    /**
-     * Load an input document from a base64 encoded string.
-     * @param inputString input content, as a string.
-     * @param filename file name.
-     */
-    docFromBase64(inputString: string, filename: string): Base64Input;
-    /**
-     * Load an input document from a `stream.Readable` object.
-     * @param inputStream input content, as a readable stream.
-     * @param filename file name.
-     */
-    docFromStream(inputStream: Readable, filename: string): StreamInput;
-    /**
-     * Load an input document from bytes.
-     * @param inputBytes input content, as a Uint8Array or Buffer.
-     * @param filename file name.
-     */
-    docFromBytes(inputBytes: Uint8Array, filename: string): BytesInput;
-    /**
-     * Load an input document from a URL.
-     * @param url input url. Must be HTTPS.
-     */
-    docFromUrl(url: string): UrlInput;
-    /**
-     * Load an input document from a Buffer.
-     * @param buffer input content, as a buffer.
-     * @param filename file name.
-     */
-    docFromBuffer(buffer: Buffer, filename: string): BufferInput;
-}

package/src/baseClient.js

@@ -1,69 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseClient = void 0;
-const input_1 = require("./input");
-class BaseClient {
-    /**
-     * Load an input document from a local path.
-     * @param inputPath
-     */
-    docFromPath(inputPath) {
-        return new input_1.PathInput({
-            inputPath: inputPath,
-        });
-    }
-    /**
-     * Load an input document from a base64 encoded string.
-     * @param inputString input content, as a string.
-     * @param filename file name.
-     */
-    docFromBase64(inputString, filename) {
-        return new input_1.Base64Input({
-            inputString: inputString,
-            filename: filename,
-        });
-    }
-    /**
-     * Load an input document from a `stream.Readable` object.
-     * @param inputStream input content, as a readable stream.
-     * @param filename file name.
-     */
-    docFromStream(inputStream, filename) {
-        return new input_1.StreamInput({
-            inputStream: inputStream,
-            filename: filename,
-        });
-    }
-    /**
-     * Load an input document from bytes.
-     * @param inputBytes input content, as a Uint8Array or Buffer.
-     * @param filename file name.
-     */
-    docFromBytes(inputBytes, filename) {
-        return new input_1.BytesInput({
-            inputBytes: inputBytes,
-            filename: filename,
-        });
-    }
-    /**
-     * Load an input document from a URL.
-     * @param url input url. Must be HTTPS.
-     */
-    docFromUrl(url) {
-        return new input_1.UrlInput({
-            url: url,
-        });
-    }
-    /**
-     * Load an input document from a Buffer.
-     * @param buffer input content, as a buffer.
-     * @param filename file name.
-     */
-    docFromBuffer(buffer, filename) {
-        return new input_1.BufferInput({
-            buffer: buffer,
-            filename: filename,
-        });
-    }
-}
-exports.BaseClient = BaseClient;