mindee 1.1.0 → 1.3.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # CHANGELOG
 
+## v1.3.0
+
+### Changes
+
+- :sparkles: allow sending the filename for streams and base64
+- fixes :bug: not able to specify MIME type
+- :page_facing_up: change license to MIT
+- :white_check_mark: add node18 to tests
+- various package updates
+
+## v1.2.0
+
+### Fixes
+
+- fix: 🐛 Get `words` values when `includeWords` parameter is `true`
+
+## v1.1.2
+
+### Fixes
+
+- fix: 🐛 Fix returned probability value
+- fix: 🐛 Fix returned bbox value
+
+### new
+
+- new: ✨ New Mindee Invoice API V3 support
+- new: ✨ Add new supplier and customer fields
+
 ## v1.1.0 (2022-01-03)
 
 ### new

package/LICENSE

@@ -1,202 +1,21 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-
+MIT License
+
+Copyright (c) 2020-Present Mindee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,10 +1,15 @@
-# API SDK for Node.js
+# Mindee Client Library for Node.js
 
 # Installation
 
+## Requirements
+
+The SDK is officially supported on Node.js LTS _active_ and _maintenance_
+[versions](https://nodejs.org/en/about/releases/).
+
 ## From source code
 
-Download and decompress or clone the source code from github and then do in your node project :
+Download and decompress or clone the source code from GitHub and then do in your Node.js project:
 
 ```sh
 npm install mindee
@@ -12,7 +17,7 @@ npm install mindee
 
 # Usage
 
-You can use the SDK easily by creating a Client like this :
+You can use the SDK easily by creating a Client like this:
 
 ```js
 const { Client } = require("mindee");
@@ -30,13 +35,29 @@ mindeeClient.financialDocument.parse({
 });
 ```
 
-Three apis are actually supported : invoice (`ìnvoice`), receipt (`receipt`) and financial document (`financialDocument`)
+Three APIs are actually supported: invoice (`ìnvoice`), receipt (`receipt`) and financial document (`financialDocument`)
+
+You can find more examples on how to use the SDK into the folder `examples`.
+
+## MIME Types
+When using `stream` or `base64` inputs, the MIME type is guessed using magic numbers.
+In some cases, for example with non-standard files, it will not be possible to detect the MIME type in this way.
 
-You can find more examples on how to use the SDK into the folder `examples`
+If you are getting MIME type errors, you will need to specify a file name having the correct extension, for example:
+```js
+mindeeClient.invoice.parse({
+  input: base64String,
+  inputType: "base64",
+  filename: "myfile.pdf",
+});
+```
 
 ## Client
 
-The mindee Client can take multiple parameters to be initialize. Some this parameters can also be set with env variables. If the env variable and the parameter are both set, the parameter will be the one chosen by the client. This is a list of them:
+The Mindee client can take multiple parameters to be initialize.
+Some this parameters can also be set with env variables.
+If the env variable and the parameter are both set, the parameter will be the one chosen by the client.
+This is a list of them:
 
 - invoiceToken (env variable : `MINDEE_INVOICE_TOKEN`) The expense api token
 - receiptToken (env variable : `MINDEE_RECEIPT_TOKEN`) The invoice api token
@@ -118,15 +139,6 @@ mindeeClient.financialDocument
 
 # Tests
 
-First, link your package to the test repository by linking the node package to the tests :
-
-```sh
-cd mindee-api-nodejs/
-npm link
-cd tests/
-npm link mindee
-```
-
 To run the tests, use the command `npm run test`
 
 # Documentation
@@ -135,3 +147,4 @@ A basic documentation of the sdk has been done with the help of JSDoc.
 If you want to generate it, you can use the command `npm run documentation`.
 A folder `docs` will be created with generated documentation.
 Open the `index.html` in your browser to read the documentation.
+

package/lib/api/request.js

@@ -62,7 +62,7 @@ var request = function request(url, method, headers, input) {
             data: JSON.parse(responseBody)
           }));
         } catch (error) {
-          console.log("error");
+          console.log(responseBody, error);
         }
       });
     });

package/lib/api/response.js

@@ -14,8 +14,6 @@ function _objectWithoutProperties(source, excluded) { if (source == null) return
 
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
 
-var Document = require("../documents").document;
-
 var Receipt = require("../documents").receipt;
 
 var Invoice = require("../documents").invoice;

package/lib/documents/financialDocument.js

@@ -66,7 +66,7 @@ class FinancialDocument extends Document {
       invoiceNumber: _invoiceNumber = undefined,
       dueDate: _dueDate = undefined,
       taxes: _taxes = undefined,
-      merchantName = undefined,
+      supplier: _supplier = undefined,
       paymentDetails: _paymentDetails = undefined,
       companyNumber: _companyNumber = undefined,
       vatNumber: _vatNumber = undefined,
@@ -97,7 +97,7 @@ class FinancialDocument extends Document {
         invoiceNumber: _invoiceNumber,
         dueDate: _dueDate,
         taxes: _taxes,
-        supplier,
+        supplier: _supplier,
         paymentDetails: _paymentDetails,
         companyNumber: _companyNumber,
         vatNumber: _vatNumber,

package/lib/inputs.js

@@ -104,6 +104,8 @@ class Input {
 
       var filetype = _this3.filename.split(".").pop();
 
+      console.log(_this3.filename.split("."));
+
       if (!(filetype in _this3.MIMETYPES)) {
         errorHandler.throw(new Error("File type is not allowed. It must be ".concat(Object.keys(_this3.MIMETYPES).toString())));
       }

package/mindee/api/financialDocument.js

@@ -37,10 +37,10 @@ class APIFinancialDocument extends APIObject {
         : this.receiptToken;
     const url =
       inputFile.fileExtension === "application/pdf"
-        ? "/invoices/v2/predict"
-        : "/expense_receipts/v3/predict";
+        ? `/invoices/v${version}/predict`
+        : `/expense_receipts/v${version}/predict`;
     super.parse();
-    return await super._request(url, inputFile, version, includeWords);
+    return super._request(url, inputFile, includeWords);
   }
 }
 

package/mindee/api/invoice.js

@@ -19,7 +19,7 @@ class APIInvoice extends APIObject {
     input,
     inputType = "path",
     filename = undefined,
-    version = "2",
+    version = "3",
     cutPdf = true,
     includeWords = false,
   }) {

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/v1/products/mindee/";
+    this.baseUrl = "https://api.mindee.net/v1/products/mindee";
     this.apiName = apiName;
   }
 

package/mindee/api/request.js

@@ -6,24 +6,27 @@ const os = require("os");
 
 const request = (url, method, headers, input, includeWords = false) => {
   return new Promise(function (resolve, reject) {
-    const form = new FormData();
-    let body;
+    let form = new FormData();
 
     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 };
+
+    const fileParams = { filename: input.filename };
+
+    if (input.inputType === "base64") {
+      form.append(
+        "document",
+        Buffer.from(input.fileObject, "base64"),
+        fileParams
+      );
+    } else {
       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 = { document: input.fileObject };
-      if (includeWords) body_obj["include_mvision"] = "true";
-      body = JSON.stringify(body_obj);
-      headers["Content-Type"] = "application/json";
-      headers["Content-Length"] = body.length;
     }
+    if (includeWords) {
+      form.append("include_mvision", "true");
+    }
+    headers = { ...headers, ...form.getHeaders() };
 
     const uri = new URL(url);
     const options = {
@@ -61,8 +64,7 @@ const request = (url, method, headers, input, includeWords = false) => {
     }
 
     if (input.inputType === "base64") {
-      req.write(body);
-      req.end();
+      form.pipe(req);
     }
   });
 };

package/mindee/api/response.js

@@ -1,4 +1,3 @@
-const Document = require("../documents").document;
 const Receipt = require("../documents").receipt;
 const Invoice = require("../documents").invoice;
 const FinancialDocument = require("../documents").financialDocument;
@@ -33,31 +32,47 @@ class Response {
   }
 
   formatResponse() {
+    let http_data_document = this.httpResponse.data.document;
     const constructors = {
       receipt: (params) => new Receipt(params),
       invoice: (params) => new Invoice(params),
       financialDocument: (params) => new FinancialDocument(params),
     };
-    const predictions = this.httpResponse.data.document.inference.pages.entries();
+
+    const predictions = http_data_document.inference.pages.entries();
     this[`${this.documentType}s`] = [];
+    let document_words_content = [];
 
     // Create a list of Document (Receipt, Invoice...) for each page of the input document
     for (const [pageNumber, prediction] of predictions) {
+      let page_words_content = [];
+      if (
+        "ocr" in http_data_document &&
+        Object.keys(http_data_document.ocr).length > 0
+      ) {
+        page_words_content =
+          http_data_document.ocr["mvision-v1"].pages[pageNumber].all_words;
+        document_words_content.push(
+          ...http_data_document.ocr["mvision-v1"].pages[pageNumber].all_words
+        );
+      }
       this[`${this.documentType}s`].push(
         constructors[this.documentType]({
           apiPrediction: prediction.prediction,
           inputFile: this.input,
           pageNumber: pageNumber,
+          words: page_words_content,
         })
       );
     }
 
     // Merge the list of Document into a unique Document
     this[this.documentType] = constructors[this.documentType]({
-      apiPrediction: this.httpResponse.data.document.inference.prediction,
+      apiPrediction: http_data_document.inference.prediction,
       inputFile: this.input,
-      pageNumber: -1,
+      pageNumber: http_data_document.n_pages,
       level: "document",
+      words: document_words_content,
     });
   }
 }

package/mindee/documents/fields/field.js

@@ -16,13 +16,10 @@ class Field {
     this.pageNumber = pageNumber;
     this.reconstructed = reconstructed;
     this.value = undefined;
-    this.probability = 0.0;
-    this.bbox = [];
+    this.probability = prediction.confidence ? prediction.confidence : 0.0;
+    this.bbox = prediction.polygon ? prediction.polygon : [];
     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 || [];
       if (extraFields) {
         for (const fieldName of extraFields) {
           this[fieldName] = prediction[fieldName];

package/mindee/documents/financialDocument.js

@@ -19,13 +19,17 @@ class FinancialDocument extends Document {
    *  @param {Object} Date - date value for creating FinancialDocument object from scratch
    *  @param {Object} InvoiceNumber - Invoice number value for creating FinancialDocument object from scratch
    *  @param {Object} taxes - taxes value for creating FinancialDocument object from scratch
-   *  @param {Object} merchantName - merchant name value for creating FinancialDocument object from scratch
+   *  @param {Object} supplier - supplier value for creating FinancialDocument object from scratch
+   *  @param {Object} supplierAddress - supplier address value for creating FinancialDocument object from scratch
    *  @param {Object} paymentDetails - payment details value for creating FinancialDocument object from scratch
    *  @param {Object} companyNumber - company number value for creating FinancialDocument object from scratch
    *  @param {Object} vatNumber - vat number value for creating FinancialDocument object from scratch
    *  @param {Object} orientation - orientation value for creating FinancialDocument object from scratch
    *  @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} customerName - customer name value for creating FinancialDocument object from scratch
+   *  @param {Object} customerAddress - customer address value for creating FinancialDocument object from scratch
+   *  @param {Object} customerCompanyRegistration - customer company registration 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
    */
@@ -39,13 +43,18 @@ class FinancialDocument extends Document {
     invoiceNumber = undefined,
     dueDate = undefined,
     taxes = undefined,
-    merchantName = undefined,
+    supplier = undefined,
+    supplierAddress = undefined,
     paymentDetails = undefined,
     companyNumber = undefined,
     vatNumber = undefined,
     orientation = undefined,
     totalTax = undefined,
     time = undefined,
+    customerName = undefined,
+    customerAddress = undefined,
+    customerCompanyRegistration = undefined,
+    words = undefined,
     pageNumber = 0,
     level = "page",
   }) {
@@ -61,6 +70,7 @@ class FinancialDocument extends Document {
         dueDate,
         taxes,
         supplier,
+        supplierAddress,
         paymentDetails,
         companyNumber,
         vatNumber,
@@ -68,9 +78,12 @@ class FinancialDocument extends Document {
         pageNumber,
         totalTax,
         time,
+        customerName,
+        customerAddress,
+        customerCompanyRegistration,
       });
     } else {
-      this.#initFromApiPrediction(apiPrediction, inputFile, pageNumber);
+      this.#initFromApiPrediction(apiPrediction, inputFile, pageNumber, words);
     }
     this.#checklist();
   }
@@ -90,7 +103,11 @@ class FinancialDocument extends Document {
     orientation,
     pageNumber,
     supplier,
+    supplierAddress,
     time,
+    customerName,
+    customerAddress,
+    customerCompanyRegistration,
   }) {
     const constructPrediction = function (item) {
       return { prediction: { value: item }, valueKey: "value", pageNumber };
@@ -102,12 +119,18 @@ class FinancialDocument extends Document {
     this.date = new Date(constructPrediction(date));
     this.dueDate = new Date(constructPrediction(dueDate));
     this.supplier = new Field(constructPrediction(supplier));
+    this.supplierAddress = new Field(this.constructPrediction(supplierAddress));
     this.time = new Field(constructPrediction(time));
     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.customerName = new Field(this.constructPrediction(customerName));
+    this.customerAddress = new Field(this.constructPrediction(customerAddress));
+    this.customerCompanyRegistration = new Field(
+      this.constructPrediction(customerCompanyRegistration)
+    );
     if (taxes !== undefined) {
       this.taxes = [];
       for (const t of taxes) {
@@ -123,13 +146,14 @@ class FinancialDocument extends Document {
     }
   }
 
-  #initFromApiPrediction(apiPrediction, inputFile, pageNumber) {
+  #initFromApiPrediction(apiPrediction, inputFile, pageNumber, words) {
     if (Object.keys(apiPrediction).includes("invoice_number")) {
       const invoice = new Invoice({
         apiPrediction,
         inputFile,
         pageNumber,
         level: this.level,
+        words: words,
       });
       this.locale = invoice.locale;
       this.totalIncl = invoice.totalIncl;
@@ -139,19 +163,25 @@ class FinancialDocument extends Document {
       this.dueDate = invoice.dueDate;
       this.taxes = invoice.taxes;
       this.supplier = invoice.supplier;
+      this.supplierAddress = invoice.supplierAddress;
       this.paymentDetails = invoice.paymentDetails;
       this.companyNumber = invoice.companyNumber;
       this.orientation = invoice.orientation;
       this.totalTax = invoice.totalTax;
+      if (invoice.words) this.words = invoice.words;
       this.time = new Field({
-        prediction: { value: undefined, probability: 0.0 },
+        prediction: { value: undefined, confidence: 0.0 },
       });
+      this.customerName = invoice.customerName;
+      this.customerAddress = invoice.customerAddress;
+      this.customerCompanyRegistration = invoice.customerCompanyRegistration;
     } else {
       const receipt = new Receipt({
         apiPrediction,
         inputFile,
         pageNumber,
         level: this.level,
+        words: words,
       });
       this.orientation = receipt.orientation;
       this.date = receipt.date;
@@ -161,17 +191,28 @@ class FinancialDocument extends Document {
       this.totalIncl = receipt.totalIncl;
       this.totalExcl = receipt.totalExcl;
       this.supplier = receipt.merchantName;
+      this.supplierAddress = new Field({
+        prediction: { value: undefined, confidence: 0.0 },
+      });
       this.time = receipt.time;
       this.totalTax = receipt.totalTax;
       this.invoiceNumber = new Field({
-        prediction: { value: undefined, probability: 0.0 },
+        prediction: { value: undefined, confidence: 0.0 },
       });
       this.paymentDetails = new Field({
-        prediction: { value: undefined, probability: 0.0 },
+        prediction: { value: undefined, confidence: 0.0 },
       });
       this.companyNumber = new Field({
-        prediction: { value: undefined, probability: 0.0 },
+        prediction: { value: undefined, confidence: 0.0 },
+      });
+      this.customerName = new Field({
+        prediction: { value: undefined, confidence: 0.0 },
+      });
+      this.customerAddress = new Field({
+        prediction: { value: undefined, confidence: 0.0 },
       });
+      this.customerCompanyRegistration = [];
+      if (receipt.words) this.words = receipt.words;
     }
   }
 
@@ -216,7 +257,7 @@ class FinancialDocument extends Document {
       this.totalIncl.value * (1 - eps) - 0.02 <= reconstructedTotal &&
       reconstructedTotal <= this.totalIncl.value * (1 + eps) + 0.02
     ) {
-      this.taxes = this.taxes.map((tax) => ({ ...tax, probability: 1.0 }));
+      this.taxes = this.taxes.map((tax) => ({ ...tax, confidence: 1.0 }));
       this.totalTax.probability = 1.0;
       this.totalIncl.probability = 1.0;
       return true;

package/mindee/documents/invoice.js

@@ -18,11 +18,15 @@ class Invoice extends Document {
    *  @param {Object} invoiceNumber - invoice number value for creating Invoice object from scratch
    *  @param {Object} taxes - taxes value for creating Invoice object from scratch
    *  @param {Object} supplier - supplier value for creating Invoice object from scratch
+   *  @param {Object} supplierAddress - supplier address value for creating Invoice object from scratch
    *  @param {Object} paymentDetails - payment details value for creating Invoice object from scratch
    *  @param {Object} companyNumber - company number value for creating Invoice object from scratch
    *  @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} customerName - customer name value for creating Invoice object from scratch
+   *  @param {Object} customerAddress - customer address value for creating Invoice object from scratch
+   *  @param {Object} customerCompanyRegistration - customer company registration value for creating Invoice object from scratch
    *  @param {Number} pageNumber - pageNumber for multi pages pdf input
    *  @param {String} level - specify whether object is built from "page" level or "document" level prediction
    */
@@ -37,11 +41,16 @@ class Invoice extends Document {
     dueDate = undefined,
     taxes = undefined,
     supplier = undefined,
+    supplierAddress = undefined,
     paymentDetails = undefined,
     companyNumber = undefined,
     vatNumber = undefined,
     orientation = undefined,
     totalTax = undefined,
+    customerName = undefined,
+    customerAddress = undefined,
+    customerCompanyRegistration = undefined,
+    words = undefined,
     pageNumber = 0,
     level = "page",
   }) {
@@ -60,15 +69,19 @@ class Invoice extends Document {
         dueDate,
         taxes,
         supplier,
+        supplierAddress,
         paymentDetails,
         companyNumber,
         vatNumber,
         orientation,
         pageNumber,
         totalTax,
+        customerName,
+        customerAddress,
+        customerCompanyRegistration,
       });
     } else {
-      this.#initFromApiPrediction(apiPrediction, pageNumber);
+      this.#initFromApiPrediction(apiPrediction, pageNumber, words);
     }
     this.#checklist();
     this.#reconstruct();
@@ -84,11 +97,15 @@ class Invoice extends Document {
     dueDate,
     taxes,
     supplier,
+    supplierAddress,
     paymentDetails,
     companyNumber,
     vatNumber,
     orientation,
     pageNumber,
+    customerName,
+    customerAddress,
+    customerCompanyRegistration,
   }) {
     this.locale = new Locale(this.constructPrediction(locale));
     this.totalIncl = new Amount(this.constructPrediction(totalIncl));
@@ -98,10 +115,16 @@ class Invoice extends Document {
     this.invoiceDate = new Date(this.constructPrediction(invoiceDate));
     this.dueDate = new Date(this.constructPrediction(dueDate));
     this.supplier = new Field(this.constructPrediction(supplier));
+    this.supplierAddress = new Field(this.constructPrediction(supplierAddress));
     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));
+    this.customerName = new Field(this.constructPrediction(customerName));
+    this.customerAddress = new Field(this.constructPrediction(customerAddress));
+    this.customerCompanyRegistration = new Field(
+      this.constructPrediction(customerCompanyRegistration)
+    );
     if (taxes !== undefined) {
       this.taxes = [];
       for (const t of taxes) {
@@ -120,8 +143,7 @@ class Invoice extends Document {
     }
   }
 
-  #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,
@@ -129,7 +151,7 @@ class Invoice extends Document {
       pageNumber,
     });
     this.totalTax = new Amount({
-      prediction: { value: undefined, probability: 0.0 },
+      prediction: { value: undefined, confidence: 0.0 },
       valueKey: "value",
       pageNumber,
     });
@@ -179,6 +201,27 @@ class Invoice extends Document {
       prediction: apiPrediction.supplier,
       pageNumber,
     });
+    this.supplierAddress = new Field({
+      prediction: apiPrediction.supplier_address,
+      pageNumber,
+    });
+    this.customerName = new Field({
+      prediction: apiPrediction.customer,
+      pageNumber,
+    });
+    this.customerAddress = new Field({
+      prediction: apiPrediction.customer_address,
+      pageNumber,
+    });
+    this.customerCompanyRegistration = apiPrediction.customer_company_registration.map(
+      function (customerCompanyRegistration) {
+        return new Field({
+          prediction: customerCompanyRegistration,
+          pageNumber,
+          extraFields: ["type"],
+        });
+      }
+    );
     this.paymentDetails = apiPrediction.payment_details.map(function (
       paymentDetail
     ) {
@@ -194,14 +237,13 @@ class Invoice extends Document {
         this.constructPrediction({
           prediction: {
             value: undefined,
-            probability: 0.0,
+            confidence: 0.0,
             degrees: undefined,
           },
         })
       );
     }
-    // document.inference.ocr
-    if ("mvision" in apiPrediction) this.words = apiPrediction.mvision;
+    if (words && words.length > 0) this.words = words;
   }
 
   toString() {
@@ -213,6 +255,9 @@ class Invoice extends Document {
     Total amount excluding taxes: ${this.totalExcl.value}
     Invoice Date: ${this.invoiceDate.value}
     Supplier name: ${this.supplier.value}
+    Supplier address: ${this.supplierAddress.value}
+    Customer name: ${this.customerName.value}
+    Customer address: ${this.customerAddress.value}
     Taxes: ${this.taxes.map((tax) => tax.toString()).join(" - ")}
     Total taxes: ${this.totalTax.value}
     `;
@@ -330,7 +375,7 @@ class Invoice extends Document {
         value: this.taxes.reduce((acc, tax) => {
           return tax.value !== undefined ? acc + tax.value : acc;
         }, 0),
-        probability: Field.arrayProbability(this.taxes),
+        confidence: Field.arrayProbability(this.taxes),
       };
       if (totalTax.value > 0)
         this.totalTax = new Amount({
@@ -350,7 +395,7 @@ class Invoice extends Document {
     ) {
       const totalTax = {
         value: this.totalIncl.value - this.totalExcl.value,
-        probability: this.totalIncl.probability * this.totalExcl.probability,
+        confidence: this.totalIncl.probability * this.totalExcl.probability,
       };
       if (totalTax.value > 0)
         this.totalTax = new Amount({
@@ -373,7 +418,7 @@ class Invoice extends Document {
           this.taxes.reduce((acc, tax) => {
             return tax.value !== undefined ? acc + tax.value : acc;
           }, 0),
-        probability:
+        confidence:
           Field.arrayProbability(this.taxes) * this.totalIncl.probability,
       };
       this.totalExcl = new Amount({
@@ -396,7 +441,7 @@ class Invoice extends Document {
           this.taxes.reduce((acc, tax) => {
             return tax.value ? acc + tax.value : acc;
           }, 0.0),
-        probability:
+        confidence:
           Field.arrayProbability(this.taxes) * this.totalExcl.probability,
       };
       this.totalIncl = new Amount({

package/mindee/documents/receipt.js

@@ -37,6 +37,7 @@ class Receipt extends Document {
     orientation = undefined,
     totalTax = undefined,
     totalExcl = undefined,
+    words = undefined,
     pageNumber = 0,
     level = "page",
   }) {
@@ -60,7 +61,7 @@ class Receipt extends Document {
         pageNumber,
       });
     } else {
-      this.#initFromApiPrediction(apiPrediction, pageNumber);
+      this.#initFromApiPrediction(apiPrediction, pageNumber, words);
     }
     this.#checklist();
     this.#reconstruct();
@@ -108,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,
@@ -146,12 +146,12 @@ class Receipt extends Document {
         })
     );
     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,
     });
@@ -165,13 +165,13 @@ class Receipt extends Document {
         this.constructPrediction({
           prediction: {
             value: undefined,
-            probability: 0.0,
+            confidence: 0.0,
             degrees: undefined,
           },
         })
       );
     }
-    if ("mvision" in apiPrediction) this.words = apiPrediction.mvision;
+    if (words && words.length > 0) this.words = words;
   }
 
   toString() {
@@ -250,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({
@@ -272,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/mindee/inputs.js

@@ -52,18 +52,24 @@ class Input {
   async initBase64() {
     this.fileObject = this.file;
     this.filepath = undefined;
-    this.fileExtension = undefined;
 
-    if (this.allowCutPdf == true) {
-      const typeOfFile = await fileType.fromBuffer(
+    if (this.filename === undefined) {
+      const mimeType = await fileType.fromBuffer(
         Buffer.from(this.fileObject, "base64")
       );
-
-      if (typeOfFile === undefined) {
-        console.error(`Cannot detect mime type of: ${this.fileObject}`);
-      } else if (typeOfFile.mime === "application/pdf") {
-        await this.cutPdf();
+      if (mimeType !== undefined) {
+        this.fileExtension = mimeType.mime;
+        this.filename = `from_${this.inputType}.${mimeType.ext}`;
+      } else {
+        throw "Could not determine the MIME type. Please specify the 'filename' option.";
       }
+    } else {
+      const filetype = this.filename.split(".").pop();
+      this.fileExtension = this.MIMETYPES[filetype];
+    }
+
+    if (this.fileExtension === "application/pdf" && this.allowCutPdf == true) {
+      await this.cutPdf();
     }
   }
 
@@ -74,7 +80,6 @@ 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,9 +1,9 @@
 {
   "name": "mindee",
-  "version": "1.1.0",
-  "description": "Mindee API SDK for Node.js",
+  "version": "1.3.0",
+  "description": "Mindee Client Library for Node.js",
   "main": "mindee/index.js",
-  "license": "GPL-3.0",
+  "license": "MIT",
   "scripts": {
     "build": "babel mindee -d lib",
     "test": "npm run build && mocha tests/**/*.js",
@@ -34,12 +34,12 @@
     "prettier": "^2.2.0"
   },
   "dependencies": {
-    "base64-arraybuffer": "^1.0.1",
+    "base64-arraybuffer": "^1.0.2",
     "base64-stream": "^1.0.0",
     "concat-stream": "^2.0.0",
     "file-type": "^16.5.3",
     "form-data": "^3.0.1",
-    "pdf-lib": "^1.13.0"
+    "pdf-lib": "^1.17.1"
   },
   "keywords": [
     "javascript",