mindee 1.0.9 → 1.2.0

package/mindee/documents/receipt.js

@@ -22,6 +22,7 @@ class Receipt extends Document {
    *  @param {Object} orientation - orientation value for creating Receipt object from scratch
    *  @param {Object} totalTax - total taxes value for creating Receipt object from scratch
    *  @param {Object} totalExcl - total taxes excluded value for creating Receipt object from scratch
+   *  @param {String} level - specify whether object is built from "page" level or "document" level prediction
    */
   constructor({
     apiPrediction = undefined,
@@ -36,9 +37,15 @@ class Receipt extends Document {
     orientation = undefined,
     totalTax = undefined,
     totalExcl = undefined,
+    words = undefined,
     pageNumber = 0,
+    level = "page",
   }) {
     super(inputFile);
+    this.level = level;
+    this.constructPrediction = function (item) {
+      return { prediction: { value: item }, valueKey: "value", pageNumber };
+    };
     if (apiPrediction === undefined) {
       this.#initFromScratch({
         locale,
@@ -54,7 +61,7 @@ class Receipt extends Document {
         pageNumber,
       });
     } else {
-      this.#initFromApiPrediction(apiPrediction, pageNumber);
+      this.#initFromApiPrediction(apiPrediction, pageNumber, words);
     }
     this.#checklist();
     this.#reconstruct();
@@ -73,15 +80,12 @@ class Receipt extends Document {
     totalTax,
     pageNumber,
   }) {
-    const constructPrediction = function (item) {
-      return { prediction: { value: item }, valueKey: "value", pageNumber };
-    };
-    this.locale = new Locale(constructPrediction(locale));
-    this.totalIncl = new Amount(constructPrediction(totalIncl));
-    this.date = new Date(constructPrediction(date));
-    this.category = new Field(constructPrediction(category));
-    this.merchantName = new Field(constructPrediction(merchantName));
-    this.time = new Field(constructPrediction(time));
+    this.locale = new Locale(this.constructPrediction(locale));
+    this.totalIncl = new Amount(this.constructPrediction(totalIncl));
+    this.date = new Date(this.constructPrediction(date));
+    this.category = new Field(this.constructPrediction(category));
+    this.merchantName = new Field(this.constructPrediction(merchantName));
+    this.time = new Field(this.constructPrediction(time));
     if (taxes !== undefined) {
       this.taxes = [];
       for (const t of taxes) {
@@ -95,9 +99,9 @@ class Receipt extends Document {
         );
       }
     }
-    this.orientation = new Orientation(constructPrediction(orientation));
-    this.totalTax = new Amount(constructPrediction(totalTax));
-    this.totalExcl = new Amount(constructPrediction(totalExcl));
+    this.orientation = new Orientation(this.constructPrediction(orientation));
+    this.totalTax = new Amount(this.constructPrediction(totalTax));
+    this.totalExcl = new Amount(this.constructPrediction(totalExcl));
   }
 
   /**
@@ -105,8 +109,7 @@ class Receipt extends Document {
     @param apiPrediction: Raw prediction from HTTP response
     @param pageNumber: Page number for multi pages pdf input
    */
-  #initFromApiPrediction(apiPrediction, pageNumber) {
-    this.words = [];
+  #initFromApiPrediction(apiPrediction, pageNumber, words) {
     this.locale = new Locale({ prediction: apiPrediction.locale, pageNumber });
     this.totalIncl = new Amount({
       prediction: apiPrediction.total_incl,
@@ -142,21 +145,33 @@ class Receipt extends Document {
           codeKey: "code",
         })
     );
-    this.orientation = new Orientation({
-      prediction: apiPrediction.orientation,
-      pageNumber,
-    });
     this.totalTax = new Amount({
-      prediction: { value: undefined, probability: 0 },
+      prediction: { value: undefined, confidence: 0 },
       valueKey: "value",
       pageNumber,
     });
     this.totalExcl = new Amount({
-      prediction: { value: undefined, probability: 0 },
+      prediction: { value: undefined, confidence: 0 },
       valueKey: "value",
       pageNumber,
     });
-    if ("mvision" in apiPrediction) this.words = apiPrediction.mvision;
+    if (this.level === "page") {
+      this.orientation = new Orientation({
+        prediction: apiPrediction.orientation,
+        pageNumber,
+      });
+    } else {
+      this.orientation = new Orientation(
+        this.constructPrediction({
+          prediction: {
+            value: undefined,
+            confidence: 0.0,
+            degrees: undefined,
+          },
+        })
+      );
+    }
+    if (words && words.length > 0) this.words = words;
   }
 
   toString() {
@@ -235,7 +250,7 @@ class Receipt extends Document {
     if (this.taxes.length && this.totalIncl.value != null) {
       const totalExcl = {
         value: this.totalIncl.value - Field.arraySum(this.taxes),
-        probability:
+        confidence:
           Field.arrayProbability(this.taxes) * this.totalIncl.probability,
       };
       this.totalExcl = new Amount({
@@ -257,7 +272,7 @@ class Receipt extends Document {
         value: this.taxes
           .map((tax) => tax.value || 0)
           .reduce((a, b) => a + b, 0),
-        probability: Field.arrayProbability(this.taxes),
+        confidence: Field.arrayProbability(this.taxes),
       };
       if (totalTax.value > 0)
         this.totalTax = new Amount({

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "mindee",
-  "version": "1.0.9",
+  "version": "1.2.0",
   "description": "Mindee API SDK for Node.js",
   "main": "mindee/index.js",
-  "license": "GPL-3.0",
+  "license": "Apache-2.0",
   "scripts": {
     "build": "babel mindee -d lib",
     "test": "npm run build && mocha tests/**/*.js",
@@ -38,7 +38,7 @@
     "base64-stream": "^1.0.0",
     "concat-stream": "^2.0.0",
     "file-type": "^16.5.3",
-    "form-data": "^3.0.0",
+    "form-data": "^3.0.1",
     "pdf-lib": "^1.13.0"
   },
   "keywords": [