mindee 1.0.6 → 1.1.0

package/mindee/documents/invoice.js

@@ -0,0 +1,411 @@
+const Document = require("./document");
+const Field = require("./fields").field;
+const Date = require("./fields").date;
+const Amount = require("./fields").amount;
+const Locale = require("./fields").locale;
+const Orientation = require("./fields").orientation;
+const PaymentDetails = require("./fields").paymentDetails;
+const Tax = require("./fields").tax;
+
+class Invoice extends Document {
+  /**
+   *  @param {Object} apiPrediction - Json parsed prediction from HTTP response
+   *  @param {Input} input - Input object
+   *  @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
+   *  @param {Object} invoiceDate - invoice date value for creating Invoice object from scratch
+   *  @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} 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 {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,
+    inputFile = undefined,
+    locale = undefined,
+    totalIncl = undefined,
+    totalExcl = undefined,
+    invoiceDate = undefined,
+    invoiceNumber = undefined,
+    dueDate = undefined,
+    taxes = undefined,
+    supplier = undefined,
+    paymentDetails = undefined,
+    companyNumber = undefined,
+    vatNumber = undefined,
+    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,
+        totalIncl,
+        totalExcl,
+        invoiceDate,
+        invoiceNumber,
+        dueDate,
+        taxes,
+        supplier,
+        paymentDetails,
+        companyNumber,
+        vatNumber,
+        orientation,
+        pageNumber,
+        totalTax,
+      });
+    } else {
+      this.#initFromApiPrediction(apiPrediction, pageNumber);
+    }
+    this.#checklist();
+    this.#reconstruct();
+  }
+
+  #initFromScratch({
+    locale,
+    totalIncl,
+    totalExcl,
+    totalTax,
+    invoiceDate,
+    invoiceNumber,
+    dueDate,
+    taxes,
+    supplier,
+    paymentDetails,
+    companyNumber,
+    vatNumber,
+    orientation,
+    pageNumber,
+  }) {
+    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) {
+        this.taxes.push(
+          new Tax({
+            prediction: { value: t[0], rate: t[1] },
+            pageNumber,
+            valueKey: "value",
+            rateKey: "rate",
+          })
+        );
+      }
+    }
+    if (this.level === "page") {
+      this.orientation = new Orientation(this.constructPrediction(orientation));
+    }
+  }
+
+  #initFromApiPrediction(apiPrediction, pageNumber) {
+    this.words = [];
+    this.locale = new Locale({ prediction: apiPrediction.locale, pageNumber });
+    this.totalIncl = new Amount({
+      prediction: apiPrediction.total_incl,
+      valueKey: "value",
+      pageNumber,
+    });
+    this.totalTax = new Amount({
+      prediction: { value: undefined, probability: 0.0 },
+      valueKey: "value",
+      pageNumber,
+    });
+    this.totalExcl = new Amount({
+      prediction: apiPrediction.total_excl,
+      valueKey: "value",
+      pageNumber,
+    });
+    this.date = new Date({
+      prediction: apiPrediction.date,
+      valueKey: "value",
+      pageNumber,
+    });
+    this.invoiceDate = new Date({
+      prediction: apiPrediction.date,
+      valueKey: "value",
+      pageNumber,
+    });
+    this.taxes = apiPrediction.taxes.map(function (taxPrediction) {
+      return new Tax({
+        prediction: taxPrediction,
+        pageNumber,
+        valueKey: "value",
+        rateKey: "rate",
+        codeKey: "code",
+      });
+    });
+    this.companyNumber = apiPrediction.company_registration.map(function (
+      companyNumber
+    ) {
+      return new Field({
+        prediction: companyNumber,
+        pageNumber,
+        extraFields: ["type"],
+      });
+    });
+    this.dueDate = new Date({
+      prediction: apiPrediction.due_date,
+      valueKey: "value",
+      pageNumber,
+    });
+    this.invoiceNumber = new Field({
+      prediction: apiPrediction.invoice_number,
+      pageNumber,
+    });
+    this.supplier = new Field({
+      prediction: apiPrediction.supplier,
+      pageNumber,
+    });
+    this.paymentDetails = apiPrediction.payment_details.map(function (
+      paymentDetail
+    ) {
+      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;
+  }
+
+  toString() {
+    return `
+    -----Invoice data-----
+    Filename: ${this.filename}
+    Invoice number: ${this.invoiceNumber.value}
+    Total amount including taxes: ${this.totalIncl.value}
+    Total amount excluding taxes: ${this.totalExcl.value}
+    Invoice Date: ${this.invoiceDate.value}
+    Supplier name: ${this.supplier.value}
+    Taxes: ${this.taxes.map((tax) => tax.toString()).join(" - ")}
+    Total taxes: ${this.totalTax.value}
+    `;
+  }
+
+  #checklist() {
+    this.checklist = {
+      taxesMatchTotalIncl: this.#taxesMatchTotalIncl(),
+      taxesMatchTotalExcl: this.#taxesMatchTotalExcl(),
+      taxesPlusTotalExclMatchTotalIncl: this.#taxesPlusTotalExclMatchTotalIncl(),
+    };
+  }
+
+  #reconstruct() {
+    this.#reconstructTotalTax();
+    this.#reconstructTotalExcl();
+    this.#reconstructTotalIncl();
+    this.#reconstructTotalTaxFromTotals();
+  }
+
+  #taxesMatchTotalIncl() {
+    // Check taxes and total include exist
+    if (this.taxes.length === 0 || this.totalIncl.value === undefined)
+      return false;
+
+    // Reconstruct totalIncl from taxes
+    let totalVat = 0;
+    let reconstructedTotal = 0;
+    this.taxes.forEach((tax) => {
+      if (tax.value === undefined || !tax.rate) return false;
+      totalVat += tax.value;
+      reconstructedTotal += tax.value + (100 * tax.value) / tax.rate;
+    });
+
+    // Sanity check
+    if (totalVat <= 0) return false;
+
+    // Crate epsilon
+    const eps = 1 / (100 * totalVat);
+
+    if (
+      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.totalTax.probability = 1.0;
+      this.totalIncl.probability = 1.0;
+      return true;
+    }
+    return false;
+  }
+
+  /**
+   *
+   */
+  #taxesMatchTotalExcl() {
+    // Check taxes and total amount exist
+    if (this.taxes.length === 0 || this.totalExcl.value == null) return false;
+
+    // Reconstruct total_incl from taxes
+    let totalVat = 0;
+    let reconstructedTotal = 0;
+    this.taxes.forEach((tax) => {
+      if (tax.value == null || !tax.rate) return false;
+      totalVat += tax.value;
+      reconstructedTotal += (100 * tax.value) / tax.rate;
+    });
+
+    // Sanity check
+    if (totalVat <= 0) return false;
+
+    // Crate epsilon
+    const eps = 1 / (100 * totalVat);
+
+    if (
+      this.totalExcl.value * (1 - eps) - 0.02 <= reconstructedTotal &&
+      reconstructedTotal <= this.totalExcl.value * (1 + eps) + 0.02
+    ) {
+      this.taxes = this.taxes.map((tax) => ({ ...tax, probability: 1.0 }));
+      this.totalTax.probability = 1.0;
+      this.totalExcl.probability = 1.0;
+      return true;
+    }
+    return false;
+  }
+
+  #taxesPlusTotalExclMatchTotalIncl() {
+    if (
+      this.totalExcl.value === undefined ||
+      this.taxes.length == 0 ||
+      this.totalIncl === undefined
+    )
+      return false;
+    let totalVat = 0;
+    this.taxes.forEach((tax) => (totalVat += tax.value));
+    const reconstructedTotal = totalVat + this.totalExcl.value;
+
+    if (totalVat <= 0) return false;
+
+    if (
+      this.totalIncl.value - 0.01 <= reconstructedTotal &&
+      reconstructedTotal <= this.totalIncl.value + 0.01
+    ) {
+      this.taxes = this.taxes.map((tax) => ({ ...tax, probability: 1.0 }));
+      this.totalTax.probability = 1.0;
+      this.totalIncl.probability = 1.0;
+      return true;
+    }
+    return false;
+  }
+
+  #reconstructTotalTax() {
+    if (this.taxes.length > 0) {
+      const totalTax = {
+        value: this.taxes.reduce((acc, tax) => {
+          return tax.value !== undefined ? acc + tax.value : acc;
+        }, 0),
+        probability: Field.arrayProbability(this.taxes),
+      };
+      if (totalTax.value > 0)
+        this.totalTax = new Amount({
+          prediction: totalTax,
+          valueKey: "value",
+          reconstructed: true,
+        });
+    }
+  }
+
+  #reconstructTotalTaxFromTotals() {
+    if (
+      this.totalTax.value === undefined &&
+      this.totalIncl.value > 0 &&
+      this.totalExcl.value > 0 &&
+      this.totalExcl.value <= this.totalIncl.value
+    ) {
+      const totalTax = {
+        value: this.totalIncl.value - this.totalExcl.value,
+        probability: this.totalIncl.probability * this.totalExcl.probability,
+      };
+      if (totalTax.value > 0)
+        this.totalTax = new Amount({
+          prediction: totalTax,
+          valueKey: "value",
+          reconstructed: true,
+        });
+    }
+  }
+
+  #reconstructTotalExcl() {
+    if (
+      this.taxes.length &&
+      this.totalIncl.value != null &&
+      this.totalExcl.value === undefined
+    ) {
+      const totalExcl = {
+        value:
+          this.totalIncl.value -
+          this.taxes.reduce((acc, tax) => {
+            return tax.value !== undefined ? acc + tax.value : acc;
+          }, 0),
+        probability:
+          Field.arrayProbability(this.taxes) * this.totalIncl.probability,
+      };
+      this.totalExcl = new Amount({
+        prediction: totalExcl,
+        valueKey: "value",
+        reconstructed: true,
+      });
+    }
+  }
+
+  #reconstructTotalIncl() {
+    if (
+      this.taxes.length &&
+      this.totalExcl.value != null &&
+      this.totalIncl.value === undefined
+    ) {
+      const totalIncl = {
+        value:
+          this.totalExcl.value +
+          this.taxes.reduce((acc, tax) => {
+            return tax.value ? acc + tax.value : acc;
+          }, 0.0),
+        probability:
+          Field.arrayProbability(this.taxes) * this.totalExcl.probability,
+      };
+      this.totalIncl = new Amount({
+        prediction: totalIncl,
+        valueKey: "value",
+        reconstructed: true,
+      });
+    }
+  }
+}
+
+module.exports = Invoice;

package/mindee/documents/receipt.js

@@ -0,0 +1,287 @@
+const Document = require("./document");
+const Field = require("./fields").field;
+const Date = require("./fields").date;
+const Amount = require("./fields").amount;
+const Locale = require("./fields").locale;
+const Orientation = require("./fields").orientation;
+const Tax = require("./fields").tax;
+const fs = require("fs").promises;
+
+class Receipt 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 Receipt object from scratch
+   *  @param {Object} totalIncl - total tax Included value for creating Receipt object from scratch
+   *  @param {Object} date - date value for creating Receipt object from scratch
+   *  @param {Object} category - category value for creating Receipt object from scratch
+   *  @param {Object} merchantName - merchant name value for creating Receipt object from scratch
+   *  @param {Object} time - time value for creating Receipt object from scratch
+   *  @param {Object} taxes - taxes value for creating Receipt object from scratch
+   *  @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,
+    inputFile = undefined,
+    locale = undefined,
+    totalIncl = undefined,
+    date = undefined,
+    category = undefined,
+    merchantName = undefined,
+    time = undefined,
+    taxes = undefined,
+    orientation = undefined,
+    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,
+        totalExcl,
+        totalIncl,
+        date,
+        category,
+        merchantName,
+        time,
+        taxes,
+        orientation,
+        totalTax,
+        pageNumber,
+      });
+    } else {
+      this.#initFromApiPrediction(apiPrediction, pageNumber);
+    }
+    this.#checklist();
+    this.#reconstruct();
+  }
+
+  #initFromScratch({
+    locale,
+    totalExcl,
+    totalIncl,
+    date,
+    category,
+    merchantName,
+    time,
+    taxes,
+    orientation,
+    totalTax,
+    pageNumber,
+  }) {
+    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) {
+        this.taxes.push(
+          new Tax({
+            prediction: { value: t[0], rate: t[1] },
+            pageNumber,
+            valueKey: "value",
+            rateKey: "rate",
+          })
+        );
+      }
+    }
+    this.orientation = new Orientation(this.constructPrediction(orientation));
+    this.totalTax = new Amount(this.constructPrediction(totalTax));
+    this.totalExcl = new Amount(this.constructPrediction(totalExcl));
+  }
+
+  /**
+    Set the object attributes with api prediction values
+    @param apiPrediction: Raw prediction from HTTP response
+    @param pageNumber: Page number for multi pages pdf input
+   */
+  #initFromApiPrediction(apiPrediction, pageNumber) {
+    this.words = [];
+    this.locale = new Locale({ prediction: apiPrediction.locale, pageNumber });
+    this.totalIncl = new Amount({
+      prediction: apiPrediction.total_incl,
+      valueKey: "value",
+      pageNumber,
+    });
+    this.date = new Date({
+      prediction: apiPrediction.date,
+      valueKey: "value",
+      pageNumber,
+    });
+    this.category = new Field({
+      prediction: apiPrediction.category,
+      pageNumber,
+    });
+    this.merchantName = new Field({
+      prediction: apiPrediction.supplier,
+      valueKey: "value",
+      pageNumber,
+    });
+    this.time = new Field({
+      prediction: apiPrediction.time,
+      valueKey: "value",
+      pageNumber,
+    });
+    this.taxes = apiPrediction.taxes.map(
+      (taxPrediction) =>
+        new Tax({
+          prediction: taxPrediction,
+          pageNumber,
+          valueKey: "value",
+          rateKey: "rate",
+          codeKey: "code",
+        })
+    );
+    this.totalTax = new Amount({
+      prediction: { value: undefined, probability: 0 },
+      valueKey: "value",
+      pageNumber,
+    });
+    this.totalExcl = new Amount({
+      prediction: { value: undefined, probability: 0 },
+      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;
+  }
+
+  toString() {
+    return `
+    -----Receipt data-----
+    Filename: ${this.filename}
+    Total amount: ${this.totalIncl.value}
+    Date: ${this.date.value}
+    Category: ${this.category.value}
+    Time: ${this.time.value}
+    Merchant name: ${this.merchantName.value}
+    Taxes: ${this.taxes.map((tax) => tax.toString()).join(" - ")}
+    Total taxes: ${this.totalTax.value}
+    `;
+  }
+
+  static async load(path) {
+    const file = fs.readFile(path);
+    const args = JSON.parse(file);
+    return new Receipt({ reconsctruted: true, ...args });
+  }
+
+  /**
+   * Call all check methods
+   */
+  #checklist() {
+    this.checklist = { taxesMatchTotalIncl: this.#taxesMatchTotal() };
+  }
+
+  #taxesMatchTotal() {
+    // Check taxes and total amount exist
+
+    if (this.taxes.length === 0 || this.totalIncl.value == null) return false;
+
+    // Reconstruct total_incl from taxes
+    let totalVat = 0;
+    let reconstructedTotal = 0;
+    this.taxes.forEach((tax) => {
+      if (tax.value == null || !tax.rate) return false;
+      totalVat += tax.value;
+      reconstructedTotal += tax.value + (100 * tax.value) / tax.rate;
+    });
+
+    // Sanity check
+    if (totalVat <= 0) return false;
+
+    // Crate epsilon
+    const eps = 1 / (100 * totalVat);
+
+    if (
+      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.totalTax.probability = 1.0;
+      this.totalIncl.probability = 1.0;
+      return true;
+    }
+    return false;
+  }
+
+  /**
+   * Call all fields that need to be reconstructed
+   */
+  #reconstruct() {
+    this.#reconstructTotalExclFromTCCAndTaxes();
+    this.#reconstructTotalTax();
+  }
+
+  /**
+   * Set this.totalExcl with Amount object
+   * The totalExcl Amount value is the difference between totalIncl and sum of taxes
+   * The totalExcl Amount probability is the product of this.taxes probabilities multiplied by totalIncl probability
+   */
+  #reconstructTotalExclFromTCCAndTaxes() {
+    if (this.taxes.length && this.totalIncl.value != null) {
+      const totalExcl = {
+        value: this.totalIncl.value - Field.arraySum(this.taxes),
+        probability:
+          Field.arrayProbability(this.taxes) * this.totalIncl.probability,
+      };
+      this.totalExcl = new Amount({
+        prediction: totalExcl,
+        valueKey: "value",
+        reconstructed: true,
+      });
+    }
+  }
+
+  /**
+   * Set this.totalTax with Amount object
+   * The totalTax Amount value is the sum of all this.taxes value
+   * The totalTax Amount probability is the product of this.taxes probabilities
+   */
+  #reconstructTotalTax() {
+    if (this.taxes.length && this.totalTax.value == null) {
+      const totalTax = {
+        value: this.taxes
+          .map((tax) => tax.value || 0)
+          .reduce((a, b) => a + b, 0),
+        probability: Field.arrayProbability(this.taxes),
+      };
+      if (totalTax.value > 0)
+        this.totalTax = new Amount({
+          prediction: totalTax,
+          valueKey: "value",
+          reconstructed: true,
+        });
+    }
+  }
+}
+
+module.exports = Receipt;

package/mindee/errors/handler.js

@@ -0,0 +1,16 @@
+const logger = require("../logger");
+
+class ErrorHandler {
+  constructor(throwOnError = true) {
+    this.throwOnError = throwOnError;
+  }
+
+  throw(error, force = true) {
+    if (this.throwOnError || force) throw error;
+    else logger.error(error.message);
+  }
+}
+
+const errorHandler = new ErrorHandler();
+
+module.exports = errorHandler;