mindee 4.8.0 → 4.8.2

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # CHANGELOG
 
+## v4.8.2 - 2024-02-09
+### Changes
+* :recycle: increased update time for async retries
+
+### Fixes
+* :bug: fixed improper float parsing for Generated list objects
+* :bug: typescript should now allow the use of default values for enqueueAndParse() async options
+
+
+## v4.8.1 - 2024-02-06
+### Fixes
+* :bug: fixed invalid code samples for generated & async generic APIs
+* :memo: fix corresponding docs
+
+
 ## v4.8.0 - 2024-02-05
 ### Changes
 * :sparkles: add support for Generated APIs

package/README.md

@@ -144,6 +144,7 @@ const apiResponse = mindeeClient.parse(
 Complete details on the working of the library are available in the following guides: 
 
 * [Node.js Getting Started](https://developers.mindee.com/docs/nodejs-getting-started)
+* [Node.js Generated API](https://developers.mindee.com/docs/nodejs-generated-api)
 * [Node.js Custom OCR](https://developers.mindee.com/docs/nodejs-api-builder)
 * [Node.js Invoice OCR](https://developers.mindee.com/docs/nodejs-invoice-ocr)
 * [Node.js Receipt OCR](https://developers.mindee.com/docs/nodejs-receipt-ocr)

package/package.json

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

package/src/cli.js

@@ -241,7 +241,7 @@ async function callEnqueueAndParse(productClass, command, inputPath, options) {
             cropper: predictParams.cropper,
             initialDelaySec: 4,
             delaySec: 2,
-            maxRetries: 30,
+            maxRetries: 60,
         });
     }
     else {
@@ -251,7 +251,7 @@ async function callEnqueueAndParse(productClass, command, inputPath, options) {
             cropper: predictParams.cropper,
             initialDelaySec: 4,
             delaySec: 2,
-            maxRetries: 30,
+            maxRetries: 60,
         });
         if (!response.document) {
             throw Error("Document could not be retrieved");

package/src/client.d.ts

@@ -32,6 +32,19 @@ export interface PredictOptions {
 /**
  * Asynchronous polling parameters.
  */
+export interface OptionalAsyncOptions extends PredictOptions {
+    initialDelaySec?: number;
+    delaySec?: number;
+    maxRetries?: number;
+    initialTimerOptions?: {
+        ref?: boolean;
+        signal?: AbortSignal;
+    };
+    recurringTimerOptions?: {
+        ref?: boolean;
+        signal?: AbortSignal;
+    };
+}
 export interface AsyncOptions extends PredictOptions {
     initialDelaySec: number;
     delaySec: number;
@@ -139,7 +152,7 @@ export declare class Client {
      * @category Synchronous
      * @returns a `Promise` containing parsing results.
      */
-    enqueueAndParse<T extends Inference>(productClass: new (httpResponse: StringDict) => T, inputSource: InputSource, asyncParams?: AsyncOptions): Promise<AsyncPredictResponse<T>>;
+    enqueueAndParse<T extends Inference>(productClass: new (httpResponse: StringDict) => T, inputSource: InputSource, asyncParams?: OptionalAsyncOptions): Promise<AsyncPredictResponse<T>>;
     /**
      * Forces boolean coercion on truthy/falsy parameters.
      * @param param input parameter to check.

package/src/client.js

@@ -4,7 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _Client_instances, _Client_validateAsyncParams, _Client_buildProductEndpoint, _Client_buildApiSettings, _Client_initializeOTSEndpoint, _Client_cleanAccountName, _Client_getOtsEndpoint;
+var _Client_instances, _Client_setAsyncParams, _Client_buildProductEndpoint, _Client_buildApiSettings, _Client_initializeOTSEndpoint, _Client_cleanAccountName, _Client_getOtsEndpoint;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Client = void 0;
 const input_1 = require("./input");
@@ -155,34 +155,34 @@ class Client {
         pageOptions: undefined,
         initialDelaySec: 4,
         delaySec: 2,
-        maxRetries: 30,
+        maxRetries: 60,
         initialTimerOptions: undefined,
         recurringTimerOptions: undefined,
     }) {
-        __classPrivateFieldGet(this, _Client_instances, "m", _Client_validateAsyncParams).call(this, asyncParams);
+        const validatedAsyncParams = __classPrivateFieldGet(this, _Client_instances, "m", _Client_setAsyncParams).call(this, asyncParams);
         const enqueueResponse = await this.enqueue(productClass, inputSource, asyncParams);
         if (enqueueResponse.job.id === undefined || enqueueResponse.job.id.length === 0) {
             throw Error("Enqueueing of the document failed.");
         }
         const queueId = enqueueResponse.job.id;
         logger_1.logger.debug(`Successfully enqueued document with job id: ${queueId}.`);
-        await (0, promises_1.setTimeout)(asyncParams.initialDelaySec * 1000, undefined, asyncParams.initialTimerOptions);
+        await (0, promises_1.setTimeout)(validatedAsyncParams.initialDelaySec * 1000, undefined, asyncParams.initialTimerOptions);
         let retryCounter = 1;
         let pollResults;
         pollResults = await this.parseQueued(productClass, queueId, asyncParams);
-        while (retryCounter < asyncParams.maxRetries) {
+        while (retryCounter < validatedAsyncParams.maxRetries) {
             logger_1.logger.debug(`Polling server for parsing result with queueId: ${queueId}.
 Attempt n°${retryCounter}/${asyncParams.maxRetries}.
 Job status: ${pollResults.job.status}.`);
             if (pollResults.job.status === "completed") {
                 break;
             }
-            await (0, promises_1.setTimeout)(asyncParams.delaySec * 1000, undefined, asyncParams.recurringTimerOptions);
+            await (0, promises_1.setTimeout)(validatedAsyncParams.delaySec * 1000, undefined, asyncParams.recurringTimerOptions);
             pollResults = await this.parseQueued(productClass, queueId, asyncParams);
             retryCounter++;
         }
         if (pollResults.job.status !== "completed") {
-            throw Error(`Asynchronous parsing request timed out after ${asyncParams.delaySec * retryCounter} seconds`);
+            throw Error(`Asynchronous parsing request timed out after ${validatedAsyncParams.delaySec * retryCounter} seconds`);
         }
         return pollResults;
     }
@@ -282,22 +282,24 @@ Job status: ${pollResults.job.status}.`);
     }
 }
 exports.Client = Client;
-_Client_instances = new WeakSet(), _Client_validateAsyncParams = function _Client_validateAsyncParams(asyncParams) {
+_Client_instances = new WeakSet(), _Client_setAsyncParams = function _Client_setAsyncParams(asyncParams) {
     const minDelaySec = 1;
     const minInitialDelay = 2;
     const minRetries = 2;
-    asyncParams.delaySec ?? (asyncParams.delaySec = 2);
-    asyncParams.initialDelaySec ?? (asyncParams.initialDelaySec = 4);
-    asyncParams.maxRetries ?? (asyncParams.maxRetries = 30);
-    if (asyncParams.delaySec < minDelaySec) {
+    const newAsyncParams = { ...asyncParams };
+    newAsyncParams.delaySec ?? (newAsyncParams.delaySec = 2);
+    newAsyncParams.initialDelaySec ?? (newAsyncParams.initialDelaySec = 4);
+    newAsyncParams.maxRetries ?? (newAsyncParams.maxRetries = 60);
+    if (newAsyncParams.delaySec < minDelaySec) {
         throw Error(`Cannot set auto-parsing delay to less than ${minDelaySec} seconds.`);
     }
-    if (asyncParams.initialDelaySec < minInitialDelay) {
+    if (newAsyncParams.initialDelaySec < minInitialDelay) {
         throw Error(`Cannot set initial parsing delay to less than ${minInitialDelay} seconds.`);
     }
-    if (asyncParams.maxRetries < minRetries) {
+    if (newAsyncParams.maxRetries < minRetries) {
         throw Error(`Cannot set retry to less than ${minRetries}.`);
     }
+    return newAsyncParams;
 }, _Client_buildProductEndpoint = function _Client_buildProductEndpoint(endpointName, accountName, endpointVersion) {
     return new http_1.Endpoint(endpointName, accountName, endpointVersion, __classPrivateFieldGet(this, _Client_instances, "m", _Client_buildApiSettings).call(this));
 }, _Client_buildApiSettings = function _Client_buildApiSettings() {

package/src/parsing/generated/generatedList.js

@@ -18,10 +18,7 @@ class GeneratedListField {
             }
             else {
                 const valueStr = { ...value };
-                if (valueStr["value"] !== null && valueStr["value"] !== undefined && !isNaN(valueStr["value"])) {
-                    valueStr["value"] = value["value"].toFixed(1);
-                }
-                else if (value["value"] !== undefined && value["value"] !== null) {
+                if (valueStr["value"] !== null && valueStr["value"] !== undefined) {
                     valueStr["value"] = value["value"].toString();
                 }
                 this.values.push(new standard_1.StringField({ prediction: valueStr, pageId: pageId }));