mindee 4.6.0 → 4.7.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## v4.7.0 - 2024-01-30
+### Changes
+* :arrow_up: update invoices to 4.4
+* :sparkles: add rawValue to string fields.
+
+
+## v4.6.1 - 2023-12-15
+### Changes
+* :recycle: tweak async delays & retry
+* :recycle: tweak default async sample delays & retry
+* :memo: update md doc & fix typos
+
+
 ## v4.6.0 - 2023-12-11
 ### Changes
 * :sparkles: add invoice-splitter auto-splitting feature

package/README.md

@@ -47,7 +47,7 @@ const inputSource = mindeeClient.docFromBase64(myInputString, "my-file-name")
 
 A stream:
 ```js
-const inputSource = mindeeClient.docFromBuffer(myReadableStream, "my-file-name")
+const inputSource = mindeeClient.docFromStream(myReadableStream, "my-file-name")
 ```
 
 A buffer:

package/package.json

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

package/src/cli.js

@@ -228,9 +228,9 @@ async function callEnqueueAndParse(productClass, command, inputPath, options) {
             pageOptions: pageOptions,
             allWords: predictParams.allWords,
             cropper: predictParams.cropper,
-            initialDelaySec: 6,
-            delaySec: 3,
-            maxRetries: 10,
+            initialDelaySec: 4,
+            delaySec: 2,
+            maxRetries: 30,
         });
     }
     else {
@@ -238,9 +238,9 @@ async function callEnqueueAndParse(productClass, command, inputPath, options) {
             pageOptions: pageOptions,
             allWords: predictParams.allWords,
             cropper: predictParams.cropper,
-            initialDelaySec: 6,
-            delaySec: 3,
-            maxRetries: 10,
+            initialDelaySec: 4,
+            delaySec: 2,
+            maxRetries: 30,
         });
         if (!response.document) {
             throw Error("Document could not be retrieved");

package/src/client.js

@@ -153,9 +153,9 @@ class Client {
         allWords: undefined,
         cropper: undefined,
         pageOptions: undefined,
-        initialDelaySec: 6,
-        delaySec: 3,
-        maxRetries: 10,
+        initialDelaySec: 4,
+        delaySec: 2,
+        maxRetries: 30,
         initialTimerOptions: undefined,
         recurringTimerOptions: undefined,
     }) {
@@ -283,17 +283,20 @@ 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.");
+    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) {
+        throw Error(`Cannot set auto-parsing delay to less than ${minDelaySec} seconds.`);
     }
-    if (asyncParams.initialDelaySec < 4) {
-        throw Error("Cannot set initial parsing delay to less than 4 seconds.");
+    if (asyncParams.initialDelaySec < minInitialDelay) {
+        throw Error(`Cannot set initial parsing delay to less than ${minInitialDelay} seconds.`);
     }
-    if (!Number.isInteger(asyncParams.maxRetries)) {
-        throw Error("Retry amount must be an integer.");
+    if (asyncParams.maxRetries < minRetries) {
+        throw Error(`Cannot set retry to less than ${minRetries}.`);
     }
 }, _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));

package/src/parsing/standard/text.d.ts

@@ -12,5 +12,7 @@ export interface FieldConstructor {
 export declare class StringField extends Field {
     /** The value. */
     value?: string;
+    /** Value as it appears on the document. */
+    rawValue?: string;
     constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
 }

package/src/parsing/standard/text.js

@@ -8,6 +8,9 @@ const field_1 = require("./field");
 class StringField extends field_1.Field {
     constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId, }) {
         super({ prediction, valueKey, reconstructed, pageId });
+        if (prediction["raw_value"]) {
+            this.rawValue = prediction["raw_value"];
+        }
     }
 }
 exports.StringField = StringField;

package/src/product/invoice/invoiceV4Document.d.ts

@@ -39,6 +39,8 @@ export declare class InvoiceV4Document implements Prediction {
     totalAmount: AmountField;
     /** The net amount paid: does not include taxes, fees, and discounts. */
     totalNet: AmountField;
+    /** The total tax: includes all the taxes paid for this invoice. */
+    totalTax: AmountField;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**
      * Default string representation.

package/src/product/invoice/invoiceV4Document.js

@@ -87,6 +87,10 @@ class InvoiceV4Document {
             prediction: rawPrediction["total_net"],
             pageId: pageId,
         });
+        this.totalTax = new standard_1.AmountField({
+            prediction: rawPrediction["total_tax"],
+            pageId: pageId,
+        });
     }
     /**
      * Default string representation.
@@ -117,6 +121,7 @@ class InvoiceV4Document {
 :Due Date: ${this.dueDate}
 :Total Net: ${this.totalNet}
 :Total Amount: ${this.totalAmount}
+:Total Tax: ${this.totalTax}
 :Taxes: ${this.taxes}
 :Supplier Payment Details: ${supplierPaymentDetails}
 :Supplier Name: ${this.supplierName}