mindee 1.0.6 → 1.1.0

package/lib/api/financialDocument.js

@@ -40,13 +40,13 @@ class APIFinancialDocument extends APIObject {
       } = _ref;
       var inputFile = new Input({
         file: input,
-        inputType,
-        filename,
-        cutPdf
+        inputType: inputType,
+        filename: filename,
+        allowCutPdf: cutPdf
       });
-      _this.apiToken = inputFile.fileExtension === "pdf" ? _this.invoiceToken : _this.receiptToken;
       yield inputFile.init();
-      var url = inputFile.fileExtension === "pdf" ? "/invoices/v1/predict" : "/expense_receipts/v3/predict";
+      _this.apiToken = inputFile.fileExtension === "application/pdf" ? _this.invoiceToken : _this.receiptToken;
+      var url = inputFile.fileExtension === "application/pdf" ? "/invoices/v2/predict" : "/expense_receipts/v3/predict";
 
       _superprop_getParse().call(_this);
 

package/lib/api/invoice.js

@@ -43,9 +43,9 @@ class APIInvoice extends APIObject {
 
       var inputFile = new Input({
         file: input,
-        inputType,
-        filename,
-        cutPdf
+        inputType: inputType,
+        filename: filename,
+        allowCutPdf: cutPdf
       });
       yield inputFile.init();
       var url = "v".concat(version, "/predict");

package/lib/api/object.js

@@ -21,7 +21,7 @@ class APIObject {
     var apiToken = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : undefined;
     var apiName = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "";
     this.apiToken = apiToken;
-    this.baseUrl = "https://api.mindee.net/products";
+    this.baseUrl = "https://api.mindee.net/v1/products/mindee/";
     this.apiName = apiName;
   }
   /**
@@ -65,7 +65,7 @@ class APIObject {
 
 
   wrapResponse(inputFile, response, documentType) {
-    if (response.statusCode != 200) {
+    if (response.statusCode > 201) {
       var errorMessage = JSON.stringify(response.data, null, 4);
       errorHandler.throw(new Error("".concat(this.apiName, " API ").concat(response.statusCode, " HTTP error: ").concat(errorMessage)), false);
       return new Response({

package/lib/api/receipt.js

@@ -43,9 +43,9 @@ class APIReceipt extends APIObject {
 
       var inputFile = new Input({
         file: input,
-        inputType,
-        filename,
-        cutPdf
+        inputType: inputType,
+        filename: filename,
+        allowCutPdf: cutPdf
       });
       yield inputFile.init();
       var url = "v".concat(version, "/predict");

package/lib/api/request.js

@@ -18,23 +18,25 @@ var {
 
 var FormData = require("form-data");
 
+var os = require("os");
+
 var request = function request(url, method, headers, input) {
   var includeWords = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : false;
   return new Promise(function (resolve, reject) {
     var form = new FormData();
     var body;
-    headers["User-Agent"] = "mindee-node/".concat(sdkVersion, " node/").concat(process.version);
+    headers["User-Agent"] = "mindee-api-nodejs@v".concat(sdkVersion, " nodejs-").concat(process.version, " ").concat(os.type().toLowerCase());
 
     if (["path", "stream"].includes(input.inputType)) {
       var fileParams = {
         filename: input.filename
       };
-      form.append("file", input.fileObject, fileParams);
+      form.append("document", input.fileObject, fileParams);
       if (includeWords) form.append("include_mvision", "true");
       headers = _objectSpread(_objectSpread({}, headers), form.getHeaders());
     } else if (input.inputType === "base64") {
       var body_obj = {
-        file: input.fileObject
+        document: input.fileObject
       };
       if (includeWords) body_obj["include_mvision"] = "true";
       body = JSON.stringify(body_obj);
@@ -55,9 +57,13 @@ var request = function request(url, method, headers, input) {
         responseBody += chunk;
       });
       res.on("end", function () {
-        resolve(_objectSpread(_objectSpread({}, res), {}, {
-          data: JSON.parse(responseBody)
-        }));
+        try {
+          resolve(_objectSpread(_objectSpread({}, res), {}, {
+            data: JSON.parse(responseBody)
+          }));
+        } catch (error) {
+          console.log("error");
+        }
       });
     });
     req.on("error", err => {

package/lib/api/response.js

@@ -69,19 +69,24 @@ class Response {
       invoice: params => new Invoice(params),
       financialDocument: params => new FinancialDocument(params)
     };
-    var predictions = this.httpResponse.data.predictions.entries();
+    var predictions = this.httpResponse.data.document.inference.pages.entries();
     this["".concat(this.documentType, "s")] = []; // Create a list of Document (Receipt, Invoice...) for each page of the input document
 
     for (var [pageNumber, prediction] of predictions) {
       this["".concat(this.documentType, "s")].push(constructors[this.documentType]({
-        apiPrediction: prediction,
+        apiPrediction: prediction.prediction,
         inputFile: this.input,
         pageNumber: pageNumber
       }));
     } // Merge the list of Document into a unique Document
 
 
-    this[this.documentType] = Document.mergePages(this["".concat(this.documentType, "s")]);
+    this[this.documentType] = constructors[this.documentType]({
+      apiPrediction: this.httpResponse.data.document.inference.prediction,
+      inputFile: this.input,
+      pageNumber: -1,
+      level: "document"
+    });
   }
 
 }

package/lib/documents/document.js

@@ -79,7 +79,11 @@ class Document {
       for (var attribute of attributes) {
         var _document$attribute;
 
-        if ((document === null || document === void 0 ? void 0 : (_document$attribute = document[attribute]) === null || _document$attribute === void 0 ? void 0 : _document$attribute.probability) > finalDocument[attribute].probability) {
+        if (Array.isArray(document === null || document === void 0 ? void 0 : document[attribute])) {
+          var _finalDocument$attrib;
+
+          finalDocument[attribute] = (_finalDocument$attrib = finalDocument[attribute]) !== null && _finalDocument$attrib !== void 0 && _finalDocument$attrib.length ? finalDocument[attribute] : document === null || document === void 0 ? void 0 : document[attribute];
+        } else if ((document === null || document === void 0 ? void 0 : (_document$attribute = document[attribute]) === null || _document$attribute === void 0 ? void 0 : _document$attribute.probability) > finalDocument[attribute].probability) {
           finalDocument[attribute] = document === null || document === void 0 ? void 0 : document[attribute];
         }
       }

package/lib/documents/fields/field.js

@@ -22,7 +22,7 @@ class Field {
     this.probability = 0.0;
     this.bbox = [];
 
-    if (valueKey in prediction && prediction[valueKey] !== "N/A") {
+    if (valueKey in prediction && prediction[valueKey] !== null) {
       this.value = prediction[valueKey];
       if (prediction.probability) this.probability = prediction.probability;
       if (prediction.segmentation) this.bbox = prediction.segmentation.bounding_box || [];

package/lib/documents/financialDocument.js

@@ -53,6 +53,7 @@ class FinancialDocument extends Document {
    *  @param {Object} totalTax - total tax value for creating FinancialDocument object from scratch
    *  @param {Object} time - time value for creating FinancialDocument object from scratch
    *  @param {Object} pageNumber - pageNumber for multi pages pdf input
+   *  @param {String} level - specify whether object is built from "page" level or "document" level prediction
    */
   constructor(_ref) {
     var {
@@ -65,14 +66,15 @@ class FinancialDocument extends Document {
       invoiceNumber: _invoiceNumber = undefined,
       dueDate: _dueDate = undefined,
       taxes: _taxes = undefined,
-      merchantName: _merchantName = undefined,
+      merchantName = undefined,
       paymentDetails: _paymentDetails = undefined,
       companyNumber: _companyNumber = undefined,
       vatNumber: _vatNumber = undefined,
       orientation: _orientation = undefined,
       totalTax: _totalTax = undefined,
       time: _time = undefined,
-      pageNumber: _pageNumber = 0
+      pageNumber: _pageNumber = 0,
+      level = "page"
     } = _ref;
     super(_inputFile);
 
@@ -84,6 +86,8 @@ class FinancialDocument extends Document {
 
     _initFromScratch.add(this);
 
+    this.level = level;
+
     if (_apiPrediction === undefined) {
       _classPrivateMethodGet(this, _initFromScratch, _initFromScratch2).call(this, {
         locale: _locale,
@@ -93,7 +97,7 @@ class FinancialDocument extends Document {
         invoiceNumber: _invoiceNumber,
         dueDate: _dueDate,
         taxes: _taxes,
-        merchantName: _merchantName,
+        supplier,
         paymentDetails: _paymentDetails,
         companyNumber: _companyNumber,
         vatNumber: _vatNumber,
@@ -110,7 +114,7 @@ class FinancialDocument extends Document {
   }
 
   toString() {
-    return "\n    -----Financial document-----\n    Filename: ".concat(this.filename, "\n    Total amount: ").concat(this.totalIncl.value, "\n    Date: ").concat(this.date.value, "\n    Merchant name: ").concat(this.merchantName.value, "\n    Total taxes: ").concat(this.totalTax.value, "\n    ");
+    return "\n    -----Financial document-----\n    Filename: ".concat(this.filename, "\n    Total amount: ").concat(this.totalIncl.value, "\n    Date: ").concat(this.date.value, "\n    Supplier: ").concat(this.supplier.value, "\n    Total taxes: ").concat(this.totalTax.value, "\n    ");
   }
 
 }
@@ -130,7 +134,7 @@ var _initFromScratch2 = function _initFromScratch2(_ref2) {
     vatNumber,
     orientation,
     pageNumber,
-    merchantName,
+    supplier,
     time
   } = _ref2;
 
@@ -150,7 +154,7 @@ var _initFromScratch2 = function _initFromScratch2(_ref2) {
   this.totalTax = new Amount(constructPrediction(totalTax));
   this.date = new Date(constructPrediction(date));
   this.dueDate = new Date(constructPrediction(dueDate));
-  this.merchantName = new Field(constructPrediction(merchantName));
+  this.supplier = new Field(constructPrediction(supplier));
   this.time = new Field(constructPrediction(time));
   this.orientation = new Orientation(constructPrediction(orientation));
   this.invoiceNumber = new Field(constructPrediction(invoiceNumber));
@@ -180,46 +184,50 @@ var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, in
     var invoice = new Invoice({
       apiPrediction,
       inputFile,
-      pageNumber
+      pageNumber,
+      level: this.level
     });
-    Object.assign(this, invoice);
+    this.locale = invoice.locale;
+    this.totalIncl = invoice.totalIncl;
+    this.totalExcl = invoice.totalExcl;
+    this.date = invoice.invoiceDate;
+    this.invoiceNumber = invoice.invoiceNumber;
+    this.dueDate = invoice.dueDate;
+    this.taxes = invoice.taxes;
+    this.supplier = invoice.supplier;
+    this.paymentDetails = invoice.paymentDetails;
+    this.companyNumber = invoice.companyNumber;
+    this.orientation = invoice.orientation;
+    this.totalTax = invoice.totalTax;
     this.time = new Field({
       prediction: {
         value: undefined,
         probability: 0.0
       }
     });
-    this.merchantName = new Field({
-      prediction: {
-        value: undefined,
-        probability: 0.0
-      }
-    });
   } else {
     var receipt = new Receipt({
       apiPrediction,
       inputFile,
-      pageNumber
-    });
-    Object.assign(this, receipt);
-    this.invoiceDate = new Field({
-      prediction: {
-        value: undefined,
-        probability: 0.0
-      }
+      pageNumber,
+      level: this.level
     });
+    this.orientation = receipt.orientation;
+    this.date = receipt.date;
+    this.dueDate = receipt.date;
+    this.taxes = receipt.taxes;
+    this.locale = receipt.locale;
+    this.totalIncl = receipt.totalIncl;
+    this.totalExcl = receipt.totalExcl;
+    this.supplier = receipt.merchantName;
+    this.time = receipt.time;
+    this.totalTax = receipt.totalTax;
     this.invoiceNumber = new Field({
       prediction: {
         value: undefined,
         probability: 0.0
       }
     });
-    this.dueDate = new Field({
-      prediction: {
-        value: undefined,
-        probability: 0.0
-      }
-    });
     this.paymentDetails = new Field({
       prediction: {
         value: undefined,

package/lib/documents/invoice.js

@@ -50,7 +50,6 @@ class Invoice extends Document {
   /**
    *  @param {Object} apiPrediction - Json parsed prediction from HTTP response
    *  @param {Input} input - Input object
-   *  @param {Integer} pageNumber - Page number for multi pages pdf input
    *  @param {Object} locale - locale value for creating Invoice object from scratch
    *  @param {Object} totalIncl - total tax included value for creating Invoice object from scratch
    *  @param {Object} totalExcl - total tax excluded value for creating Invoice object from scratch
@@ -63,7 +62,8 @@ class Invoice extends Document {
    *  @param {Object} vatNumber - vat number value for creating Invoice object from scratch
    *  @param {Object} orientation - orientation value for creating Invoice object from scratch
    *  @param {Object} totalTax - total tax value for creating Invoice object from scratch
-   *  @param {Object} pageNumber - pageNumber for multi pages pdf input
+   *  @param {Number} pageNumber - pageNumber for multi pages pdf input
+   *  @param {String} level - specify whether object is built from "page" level or "document" level prediction
    */
   constructor(_ref) {
     var {
@@ -82,7 +82,8 @@ class Invoice extends Document {
       vatNumber: _vatNumber = undefined,
       orientation: _orientation = undefined,
       totalTax: _totalTax = undefined,
-      pageNumber: _pageNumber = 0
+      pageNumber: _pageNumber = 0,
+      level = "page"
     } = _ref;
     super(inputFile);
 
@@ -108,6 +109,18 @@ class Invoice extends Document {
 
     _initFromScratch.add(this);
 
+    this.level = level;
+
+    this.constructPrediction = function (item) {
+      return {
+        prediction: {
+          value: item
+        },
+        valueKey: "value",
+        pageNumber: _pageNumber
+      };
+    };
+
     if (_apiPrediction === undefined) {
       _classPrivateMethodGet(this, _initFromScratch, _initFromScratch2).call(this, {
         locale: _locale,
@@ -157,30 +170,18 @@ var _initFromScratch2 = function _initFromScratch2(_ref2) {
     orientation,
     pageNumber
   } = _ref2;
-
-  var constructPrediction = function constructPrediction(item) {
-    return {
-      prediction: {
-        value: item
-      },
-      valueKey: "value",
-      pageNumber
-    };
-  };
-
-  this.locale = new Locale(constructPrediction(locale));
-  this.totalIncl = new Amount(constructPrediction(totalIncl));
-  this.totalExcl = new Amount(constructPrediction(totalExcl));
-  this.totalTax = new Amount(constructPrediction(totalTax));
-  this.date = new Date(constructPrediction(invoiceDate));
-  this.invoiceDate = new Date(constructPrediction(invoiceDate));
-  this.dueDate = new Date(constructPrediction(dueDate));
-  this.supplier = new Field(constructPrediction(supplier));
-  this.orientation = new Orientation(constructPrediction(orientation));
-  this.invoiceNumber = new Field(constructPrediction(invoiceNumber));
-  this.paymentDetails = new Field(constructPrediction(paymentDetails));
-  this.companyNumber = new Field(constructPrediction(companyNumber));
-  this.vatNumber = new Field(constructPrediction(vatNumber));
+  this.locale = new Locale(this.constructPrediction(locale));
+  this.totalIncl = new Amount(this.constructPrediction(totalIncl));
+  this.totalExcl = new Amount(this.constructPrediction(totalExcl));
+  this.totalTax = new Amount(this.constructPrediction(totalTax));
+  this.date = new Date(this.constructPrediction(invoiceDate));
+  this.invoiceDate = new Date(this.constructPrediction(invoiceDate));
+  this.dueDate = new Date(this.constructPrediction(dueDate));
+  this.supplier = new Field(this.constructPrediction(supplier));
+  this.invoiceNumber = new Field(this.constructPrediction(invoiceNumber));
+  this.paymentDetails = new Field(this.constructPrediction(paymentDetails));
+  this.companyNumber = new Field(this.constructPrediction(companyNumber));
+  this.vatNumber = new Field(this.constructPrediction(vatNumber));
 
   if (taxes !== undefined) {
     this.taxes = [];
@@ -197,6 +198,10 @@ var _initFromScratch2 = function _initFromScratch2(_ref2) {
       }));
     }
   }
+
+  if (this.level === "page") {
+    this.orientation = new Orientation(this.constructPrediction(orientation));
+  }
 };
 
 var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, pageNumber) {
@@ -242,10 +247,6 @@ var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, pa
       codeKey: "code"
     });
   });
-  this.orientation = new Orientation({
-    prediction: apiPrediction.orientation,
-    pageNumber
-  });
   this.companyNumber = apiPrediction.company_registration.map(function (companyNumber) {
     return new Field({
       prediction: companyNumber,
@@ -272,6 +273,23 @@ var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, pa
       pageNumber
     });
   });
+
+  if (this.level === "page") {
+    this.orientation = new Orientation({
+      prediction: apiPrediction.orientation,
+      pageNumber
+    });
+  } else {
+    this.orientation = new Orientation(this.constructPrediction({
+      prediction: {
+        value: undefined,
+        probability: 0.0,
+        degrees: undefined
+      }
+    }));
+  } // document.inference.ocr
+
+
   if ("mvision" in apiPrediction) this.words = apiPrediction.mvision;
 };
 

package/lib/documents/receipt.js

@@ -57,6 +57,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(_ref) {
     var {
@@ -72,7 +73,8 @@ class Receipt extends Document {
       orientation: _orientation = undefined,
       totalTax: _totalTax = undefined,
       totalExcl: _totalExcl = undefined,
-      pageNumber: _pageNumber = 0
+      pageNumber: _pageNumber = 0,
+      level = "page"
     } = _ref;
     super(inputFile);
 
@@ -90,6 +92,18 @@ class Receipt extends Document {
 
     _initFromScratch.add(this);
 
+    this.level = level;
+
+    this.constructPrediction = function (item) {
+      return {
+        prediction: {
+          value: item
+        },
+        valueKey: "value",
+        pageNumber: _pageNumber
+      };
+    };
+
     if (_apiPrediction === undefined) {
       _classPrivateMethodGet(this, _initFromScratch, _initFromScratch2).call(this, {
         locale: _locale,
@@ -147,23 +161,12 @@ var _initFromScratch2 = function _initFromScratch2(_ref2) {
     totalTax,
     pageNumber
   } = _ref2;
-
-  var constructPrediction = function constructPrediction(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 = [];
@@ -181,9 +184,9 @@ var _initFromScratch2 = function _initFromScratch2(_ref2) {
     }
   }
 
-  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));
 };
 
 var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, pageNumber) {
@@ -223,10 +226,6 @@ var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, pa
     rateKey: "rate",
     codeKey: "code"
   }));
-  this.orientation = new Orientation({
-    prediction: apiPrediction.orientation,
-    pageNumber
-  });
   this.totalTax = new Amount({
     prediction: {
       value: undefined,
@@ -243,6 +242,22 @@ var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, pa
     valueKey: "value",
     pageNumber
   });
+
+  if (this.level === "page") {
+    this.orientation = new Orientation({
+      prediction: apiPrediction.orientation,
+      pageNumber
+    });
+  } else {
+    this.orientation = new Orientation(this.constructPrediction({
+      prediction: {
+        value: undefined,
+        probability: 0.0,
+        degrees: undefined
+      }
+    }));
+  }
+
   if ("mvision" in apiPrediction) this.words = apiPrediction.mvision;
 };