mindee 4.1.0 → 4.1.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## v4.1.1 - 2023-09-04
+### Changes
+* :recycle: tweaked timer management in async
+
+### Fixes
+* :bug: fix ocr option not being generated as an Ocr object
+
+
 ## v4.1.0 - 2023-08-31
 ### Changes
 * :boom: remove support for node versions <16

package/package.json

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

package/src/client.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import { Readable } from "stream";
 import { InputSource, PageOptions } from "./input";
 import { Endpoint } from "./http";
@@ -35,6 +36,14 @@ export interface AsyncOptions extends PredictOptions {
     initialDelaySec: number;
     delaySec: number;
     maxRetries: number;
+    initialTimerOptions?: {
+        ref?: boolean;
+        signal?: AbortSignal;
+    };
+    recurringTimerOptions?: {
+        ref?: boolean;
+        signal?: AbortSignal;
+    };
 }
 export interface ClientOptions {
     /** Your API key for all endpoints. */

package/src/client.js

@@ -122,6 +122,14 @@ class Client {
         initialDelaySec: 6,
         delaySec: 3,
         maxRetries: 10,
+        initialTimerOptions: {
+            ref: false,
+            signal: undefined,
+        },
+        recurringTimerOptions: {
+            ref: false,
+            signal: undefined,
+        },
     }) {
         __classPrivateFieldGet(this, _Client_instances, "m", _Client_validateAsyncParams).call(this, asyncParams);
         const enqueueResponse = await this.enqueue(productClass, inputSource, asyncParams);
@@ -130,7 +138,7 @@ class Client {
         }
         const queueId = enqueueResponse.job.id;
         logger_1.logger.debug(`Successfully enqueued document with job id: ${queueId}.`);
-        await (0, promises_1.setTimeout)(asyncParams.initialDelaySec * 1000);
+        await (0, promises_1.setTimeout)(asyncParams.initialDelaySec * 1000, undefined, asyncParams.initialTimerOptions);
         let retryCounter = 1;
         let pollResults;
         pollResults = await this.parseQueued(productClass, queueId, asyncParams);
@@ -141,7 +149,7 @@ Job status: ${pollResults.job.status}.`);
             if (pollResults.job.status === "completed") {
                 break;
             }
-            await (0, promises_1.setTimeout)(asyncParams.delaySec * 1000);
+            await (0, promises_1.setTimeout)(asyncParams.delaySec * 1000, undefined, asyncParams.recurringTimerOptions);
             pollResults = await this.parseQueued(productClass, queueId, asyncParams);
             retryCounter++;
         }
@@ -248,6 +256,9 @@ Job status: ${pollResults.job.status}.`);
 }
 exports.Client = Client;
 _Client_instances = new WeakSet(), _Client_validateAsyncParams = function _Client_validateAsyncParams(asyncParams) {
+    asyncParams.delaySec ?? (asyncParams.delaySec = 3);
+    asyncParams.initialDelaySec ?? (asyncParams.initialDelaySec = 6);
+    asyncParams.maxRetries ?? (asyncParams.maxRetries = 10);
     if (asyncParams.delaySec < 2) {
         throw Error("Cannot set auto-parsing delay to less than 2 seconds.");
     }

package/src/parsing/common/document.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Document = void 0;
 const cropperExtra_1 = require("./extras/cropperExtra");
 const extras_1 = require("./extras/extras");
+const ocr_1 = require("./ocr");
 /**
  * Document prediction wrapper class. Holds the results of a parsed document.
  * @typeParam T an extension of an `Inference`. Mandatory in order to properly create an inference.
@@ -16,7 +17,7 @@ class Document {
     constructor(inferenceClass, httpResponse) {
         this.id = httpResponse?.id ?? "";
         this.filename = httpResponse?.name ?? "";
-        this.ocr = httpResponse?.ocr ?? undefined;
+        this.ocr = httpResponse.ocr && Object.keys(httpResponse.ocr).length > 0 ? new ocr_1.Ocr(httpResponse.ocr) : undefined;
         this.inference = new inferenceClass(httpResponse["inference"]);
         // Note: this is a convoluted but functional way of being able to implement/use Extras fields
         // as an extension of a Map object (like having an adapted toString() method, for instance).