mindee 1.0.9 → 1.1.0

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;
 };
 

package/mindee/api/financialDocument.js

@@ -30,12 +30,14 @@ class APIFinancialDocument extends APIObject {
       filename: filename,
       allowCutPdf: cutPdf,
     });
-    this.apiToken =
-      inputFile.fileExtension === "pdf" ? this.invoiceToken : this.receiptToken;
     await inputFile.init();
+    this.apiToken =
+      inputFile.fileExtension === "application/pdf"
+        ? this.invoiceToken
+        : this.receiptToken;
     const url =
-      inputFile.fileExtension === "pdf"
-        ? "/invoices/v1/predict"
+      inputFile.fileExtension === "application/pdf"
+        ? "/invoices/v2/predict"
         : "/expense_receipts/v3/predict";
     super.parse();
     return await super._request(url, inputFile, version, includeWords);

package/mindee/api/object.js

@@ -10,7 +10,7 @@ const request = require("./request");
 class APIObject {
   constructor(apiToken = undefined, apiName = "") {
     this.apiToken = apiToken;
-    this.baseUrl = "https://api.mindee.net/products";
+    this.baseUrl = "https://api.mindee.net/v1/products/mindee/";
     this.apiName = apiName;
   }
 
@@ -54,7 +54,7 @@ class APIObject {
     @returns {Response}
   */
   wrapResponse(inputFile, response, documentType) {
-    if (response.statusCode != 200) {
+    if (response.statusCode > 201) {
       const errorMessage = JSON.stringify(response.data, null, 4);
       errorHandler.throw(
         new Error(

package/mindee/api/request.js

@@ -2,20 +2,23 @@ const https = require("https");
 const { version: sdkVersion } = require("../../package.json");
 const { URL } = require("url");
 const FormData = require("form-data");
+const os = require("os");
 
 const request = (url, method, headers, input, includeWords = false) => {
   return new Promise(function (resolve, reject) {
     const form = new FormData();
     let body;
-    headers["User-Agent"] = `mindee-node/${sdkVersion} node/${process.version}`;
 
+    headers["User-Agent"] = `mindee-api-nodejs@v${sdkVersion} nodejs-${
+      process.version
+    } ${os.type().toLowerCase()}`;
     if (["path", "stream"].includes(input.inputType)) {
       const fileParams = { filename: input.filename };
-      form.append("file", input.fileObject, fileParams);
+      form.append("document", input.fileObject, fileParams);
       if (includeWords) form.append("include_mvision", "true");
       headers = { ...headers, ...form.getHeaders() };
     } else if (input.inputType === "base64") {
-      let body_obj = { file: input.fileObject };
+      let body_obj = { document: input.fileObject };
       if (includeWords) body_obj["include_mvision"] = "true";
       body = JSON.stringify(body_obj);
       headers["Content-Type"] = "application/json";
@@ -44,7 +47,7 @@ const request = (url, method, headers, input, includeWords = false) => {
             data: JSON.parse(responseBody),
           });
         } catch (error) {
-          console.log(responseBody);
+          console.log(responseBody, error);
         }
       });
     });

package/mindee/api/response.js

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

package/mindee/documents/fields/field.js

@@ -18,7 +18,7 @@ class Field {
     this.value = undefined;
     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)

package/mindee/documents/financialDocument.js

@@ -27,6 +27,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({
     apiPrediction = undefined,
@@ -46,8 +47,10 @@ class FinancialDocument extends Document {
     totalTax = undefined,
     time = undefined,
     pageNumber = 0,
+    level = "page",
   }) {
     super(inputFile);
+    this.level = level;
     if (apiPrediction === undefined) {
       this.#initFromScratch({
         locale,
@@ -57,7 +60,7 @@ class FinancialDocument extends Document {
         invoiceNumber,
         dueDate,
         taxes,
-        merchantName,
+        supplier,
         paymentDetails,
         companyNumber,
         vatNumber,
@@ -86,7 +89,7 @@ class FinancialDocument extends Document {
     vatNumber,
     orientation,
     pageNumber,
-    merchantName,
+    supplier,
     time,
   }) {
     const constructPrediction = function (item) {
@@ -98,7 +101,7 @@ class FinancialDocument extends Document {
     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));
@@ -122,26 +125,47 @@ class FinancialDocument extends Document {
 
   #initFromApiPrediction(apiPrediction, inputFile, pageNumber) {
     if (Object.keys(apiPrediction).includes("invoice_number")) {
-      const invoice = new Invoice({ apiPrediction, inputFile, pageNumber });
-      Object.assign(this, invoice);
-      this.time = new Field({
-        prediction: { value: undefined, probability: 0.0 },
+      const invoice = new Invoice({
+        apiPrediction,
+        inputFile,
+        pageNumber,
+        level: this.level,
       });
-      this.merchantName = new Field({
+      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 },
       });
     } else {
-      const receipt = new Receipt({ apiPrediction, inputFile, pageNumber });
-      Object.assign(this, receipt);
-      this.invoiceDate = new Field({
-        prediction: { value: undefined, probability: 0.0 },
+      const receipt = new Receipt({
+        apiPrediction,
+        inputFile,
+        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, probability: 0.0 },
       });
@@ -157,7 +181,7 @@ class FinancialDocument extends Document {
     Filename: ${this.filename}
     Total amount: ${this.totalIncl.value}
     Date: ${this.date.value}
-    Merchant name: ${this.merchantName.value}
+    Supplier: ${this.supplier.value}
     Total taxes: ${this.totalTax.value}
     `;
   }

package/mindee/documents/invoice.js

@@ -11,7 +11,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
@@ -24,7 +23,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({
     apiPrediction = undefined,
@@ -43,8 +43,13 @@ class Invoice extends Document {
     orientation = undefined,
     totalTax = 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,
@@ -85,22 +90,18 @@ class Invoice extends Document {
     orientation,
     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.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 = [];
       for (const t of taxes) {
@@ -114,6 +115,9 @@ class Invoice extends Document {
         );
       }
     }
+    if (this.level === "page") {
+      this.orientation = new Orientation(this.constructPrediction(orientation));
+    }
   }
 
   #initFromApiPrediction(apiPrediction, pageNumber) {
@@ -153,10 +157,6 @@ class Invoice extends Document {
         codeKey: "code",
       });
     });
-    this.orientation = new Orientation({
-      prediction: apiPrediction.orientation,
-      pageNumber,
-    });
     this.companyNumber = apiPrediction.company_registration.map(function (
       companyNumber
     ) {
@@ -184,7 +184,23 @@ class Invoice extends Document {
     ) {
       return new PaymentDetails({ prediction: paymentDetail, 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/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,
@@ -37,8 +38,13 @@ class Receipt extends Document {
     totalTax = undefined,
     totalExcl = 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,
@@ -73,15 +79,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 +98,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));
   }
 
   /**
@@ -142,10 +145,6 @@ class Receipt extends Document {
           codeKey: "code",
         })
     );
-    this.orientation = new Orientation({
-      prediction: apiPrediction.orientation,
-      pageNumber,
-    });
     this.totalTax = new Amount({
       prediction: { value: undefined, probability: 0 },
       valueKey: "value",
@@ -156,6 +155,22 @@ class Receipt extends Document {
       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;
   }
 

package/mindee/inputs.js

@@ -74,6 +74,7 @@ class Input {
 
     // Check if file type is valid
     const filetype = this.filename.split(".").pop();
+    console.log(this.filename.split("."));
     if (!(filetype in this.MIMETYPES)) {
       errorHandler.throw(
         new Error(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mindee",
-  "version": "1.0.9",
+  "version": "1.1.0",
   "description": "Mindee API SDK for Node.js",
   "main": "mindee/index.js",
   "license": "GPL-3.0",
@@ -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": [