mindee 4.6.1 → 4.7.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # 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

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.1",
+    "version": "4.7.0",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",

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}