mindee 1.3.1 → 1.4.0

package/dist/documents/fields/locale.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Locale = void 0;
-const field_1 = require("@fields/field");
-class Locale extends field_1.Field {
-    /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict
-     * @param {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
-     * @param {Integer} pageNumber - Page number for multi pages pdf
-     */
-    constructor({ prediction, valueKey = "value", reconstructed = false, pageNumber = 0, }) {
-        super({ prediction, valueKey, reconstructed, pageNumber });
-        this.language = undefined;
-        this.country = undefined;
-        this.currency = undefined;
-        if ("language" in prediction && prediction.language !== "N/A")
-            this.language = prediction.language;
-        if ("country" in prediction && prediction.country !== "N/A")
-            this.country = prediction.country;
-        if ("currency" in prediction && prediction.currency !== "N/A")
-            this.currency = prediction.currency;
-    }
-}
-exports.Locale = Locale;

package/dist/documents/fields/orientation.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Orientation = void 0;
-const field_1 = require("@fields/field");
-class Orientation extends field_1.Field {
-    /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict
-     * @param {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
-     * @param {Integer} pageNumber - Page number for multi pages pdf
-     */
-    constructor({ prediction, valueKey = "degrees", reconstructed = false, pageNumber = 0, }) {
-        const orientations = [0, 90, 180, 270];
-        super({ prediction, valueKey, reconstructed, pageNumber });
-        this.value = parseInt(prediction[valueKey]);
-        if (isNaN(this.value))
-            this.probability = 0.0;
-        if (!orientations.includes(this.value))
-            this.value = 0;
-    }
-}
-exports.Orientation = Orientation;

package/dist/documents/fields/paymentDetails.js

@@ -1,50 +0,0 @@
-"use strict";
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _PaymentDetails_instances, _PaymentDetails_setKey;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PaymentDetails = void 0;
-const field_1 = require("@fields/field");
-class PaymentDetails extends field_1.Field {
-    /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict to get the iban
-     * @param {String} accountNumberKey - Key to use to get the account number in the prediction dict
-     * @param {String} ibanKey - Key to use to get the IBAN in the prediction dict
-     * @param {String} routingNumberKey - Key to use to get the routing number in the prediction dict
-     * @param {String} swiftKey - Key to use to get the SWIFT in the prediction dict
-     * @param {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
-     * @param {Integer} pageNumber - Page number for multi pages pdf
-     */
-    constructor({ prediction, valueKey = "iban", accountNumberKey = "account_number", ibanKey = "iban", routingNumberKey = "routing_number", swiftKey = "swift", reconstructed = false, pageNumber = 0, }) {
-        super({ prediction, valueKey, reconstructed, pageNumber });
-        _PaymentDetails_instances.add(this);
-        this.accountNumber = undefined;
-        this.iban = undefined;
-        this.routingNumber = undefined;
-        this.swift = undefined;
-        __classPrivateFieldGet(this, _PaymentDetails_instances, "m", _PaymentDetails_setKey).call(this, prediction[accountNumberKey], "accountNumber");
-        __classPrivateFieldGet(this, _PaymentDetails_instances, "m", _PaymentDetails_setKey).call(this, prediction[ibanKey], "iban");
-        __classPrivateFieldGet(this, _PaymentDetails_instances, "m", _PaymentDetails_setKey).call(this, prediction[routingNumberKey], "routingNumber");
-        __classPrivateFieldGet(this, _PaymentDetails_instances, "m", _PaymentDetails_setKey).call(this, prediction[swiftKey], "swift");
-    }
-    toString() {
-        let str = "";
-        const keys = ["accountNumber", "iban", "routingNumber", "swift"];
-        for (const key of keys) {
-            if (this[key])
-                str += `${this[key]}; `;
-        }
-        return str;
-    }
-}
-exports.PaymentDetails = PaymentDetails;
-_PaymentDetails_instances = new WeakSet(), _PaymentDetails_setKey = function _PaymentDetails_setKey(value, key) {
-    if (typeof value === "string" && value !== "N/A")
-        this[key] = value;
-    else
-        this[key] = undefined;
-};

package/dist/documents/fields/tax.js

@@ -1,42 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Tax = void 0;
-const field_1 = require("@fields/field");
-class Tax extends field_1.Field {
-    /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict to get the tax value
-     * @param {String} rateKey - Key to use to get the tax rate in the prediction dict
-     * @param {String} codeKey - Key to use to get the tax code in the prediction dict
-     * @param {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
-     * @param {Integer} pageNumber - Page number for multi pages pdf
-     */
-    constructor({ prediction, valueKey = "value", rateKey = "rate", codeKey = "code", reconstructed = false, pageNumber = 0, }) {
-        var _a;
-        super({ prediction, valueKey, reconstructed, pageNumber });
-        this.rate = parseFloat(prediction[rateKey]);
-        if (isNaN(this.rate))
-            this.rate = undefined;
-        this.code = (_a = prediction[codeKey]) === null || _a === void 0 ? void 0 : _a.toString();
-        if (this.code === "N/A")
-            this.code = undefined;
-        this.value = parseFloat(prediction[valueKey]);
-        if (isNaN(this.value)) {
-            this.value = undefined;
-            this.probability = 0.0;
-        }
-    }
-    toString() {
-        let str = "";
-        const keys = ["value", "rate", "code"];
-        for (const [i, key] of keys.entries()) {
-            const value = this[key] === undefined ? "_" : this[key].toString();
-            if (i < keys.length - 1)
-                str += `${value}${key === "rate" ? "%" : ""}; `;
-            else
-                str += value;
-        }
-        return str;
-    }
-}
-exports.Tax = Tax;

package/dist/documents/financialDocument.js

@@ -1,216 +0,0 @@
-"use strict";
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _FinancialDocument_instances, _FinancialDocument_initFromScratch, _FinancialDocument_initFromApiPrediction, _FinancialDocument_checklist, _FinancialDocument_taxesMatchTotalIncl;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FinancialDocument = void 0;
-const document_1 = require("@documents/document");
-const invoice_1 = require("@documents/invoice");
-const receipt_1 = require("@documents/receipt");
-const fields_1 = require("@documents/fields");
-class FinancialDocument extends document_1.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 FinancialDocument object from scratch
-     *  @param {Object} totalIncl - total tax included value for creating FinancialDocument object from scratch
-     *  @param {Object} totalExcl - total tax excluded value for creating FinancialDocument object from scratch
-     *  @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} 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
-     */
-    constructor({ apiPrediction = undefined, inputFile = undefined, locale = undefined, totalIncl = undefined, totalExcl = undefined, date = undefined, invoiceNumber = undefined, dueDate = undefined, taxes = 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", }) {
-        super(inputFile);
-        _FinancialDocument_instances.add(this);
-        this.level = level;
-        if (apiPrediction === undefined) {
-            __classPrivateFieldGet(this, _FinancialDocument_instances, "m", _FinancialDocument_initFromScratch).call(this, {
-                locale,
-                totalIncl,
-                totalExcl,
-                date,
-                invoiceNumber,
-                dueDate,
-                taxes,
-                supplier,
-                supplierAddress,
-                paymentDetails,
-                companyNumber,
-                vatNumber,
-                orientation,
-                pageNumber,
-                totalTax,
-                time,
-                customerName,
-                customerAddress,
-                customerCompanyRegistration,
-            });
-        }
-        else {
-            __classPrivateFieldGet(this, _FinancialDocument_instances, "m", _FinancialDocument_initFromApiPrediction).call(this, apiPrediction, inputFile, pageNumber, words);
-        }
-        __classPrivateFieldGet(this, _FinancialDocument_instances, "m", _FinancialDocument_checklist).call(this);
-    }
-    toString() {
-        return `
-    -----Financial document-----
-    Filename: ${this.filename}
-    Total amount: ${this.totalIncl.value}
-    Date: ${this.date.value}
-    Supplier: ${this.supplier.value}
-    Total taxes: ${this.totalTax.value}
-    `;
-    }
-}
-exports.FinancialDocument = FinancialDocument;
-_FinancialDocument_instances = new WeakSet(), _FinancialDocument_initFromScratch = function _FinancialDocument_initFromScratch({ locale, totalIncl, totalExcl, totalTax, date, invoiceNumber, dueDate, taxes, paymentDetails, companyNumber, vatNumber, orientation, pageNumber, supplier, supplierAddress, time, customerName, customerAddress, customerCompanyRegistration, }) {
-    const constructPrediction = function (item) {
-        return { prediction: { value: item }, valueKey: "value", pageNumber };
-    };
-    this.locale = new fields_1.Locale(constructPrediction(locale));
-    this.totalIncl = new fields_1.Amount(constructPrediction(totalIncl));
-    this.totalExcl = new fields_1.Amount(constructPrediction(totalExcl));
-    this.totalTax = new fields_1.Amount(constructPrediction(totalTax));
-    this.date = new fields_1.DateField(constructPrediction(date));
-    this.dueDate = new fields_1.DateField(constructPrediction(dueDate));
-    this.supplier = new fields_1.Field(constructPrediction(supplier));
-    this.supplierAddress = new fields_1.Field(this.constructPrediction(supplierAddress));
-    this.time = new fields_1.Field(constructPrediction(time));
-    this.orientation = new fields_1.Orientation(constructPrediction(orientation));
-    this.invoiceNumber = new fields_1.Field(constructPrediction(invoiceNumber));
-    this.paymentDetails = new fields_1.Field(constructPrediction(paymentDetails));
-    this.companyNumber = new fields_1.Field(constructPrediction(companyNumber));
-    this.vatNumber = new fields_1.Field(constructPrediction(vatNumber));
-    this.customerName = new fields_1.Field(this.constructPrediction(customerName));
-    this.customerAddress = new fields_1.Field(this.constructPrediction(customerAddress));
-    this.customerCompanyRegistration = new fields_1.Field(this.constructPrediction(customerCompanyRegistration));
-    if (taxes !== undefined) {
-        this.taxes = [];
-        for (const t of taxes) {
-            this.taxes.push(new fields_1.Tax({
-                prediction: { value: t[0], rate: t[1] },
-                pageNumber,
-                valueKey: "value",
-                rateKey: "rate",
-            }));
-        }
-    }
-}, _FinancialDocument_initFromApiPrediction = function _FinancialDocument_initFromApiPrediction(apiPrediction, inputFile, pageNumber, words) {
-    if (Object.keys(apiPrediction).includes("invoice_number")) {
-        const invoice = new invoice_1.Invoice({
-            apiPrediction,
-            inputFile,
-            pageNumber,
-            level: this.level,
-            words: words,
-        });
-        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.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 fields_1.Field({
-            prediction: { value: undefined, confidence: 0.0 },
-        });
-        this.customerName = invoice.customerName;
-        this.customerAddress = invoice.customerAddress;
-        this.customerCompanyRegistration = invoice.customerCompanyRegistration;
-    }
-    else {
-        const receipt = new receipt_1.Receipt({
-            apiPrediction,
-            inputFile,
-            pageNumber,
-            level: this.level,
-            words: words,
-        });
-        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.supplierAddress = new fields_1.Field({
-            prediction: { value: undefined, confidence: 0.0 },
-        });
-        this.time = receipt.time;
-        this.totalTax = receipt.totalTax;
-        this.invoiceNumber = new fields_1.Field({
-            prediction: { value: undefined, confidence: 0.0 },
-        });
-        this.paymentDetails = new fields_1.Field({
-            prediction: { value: undefined, confidence: 0.0 },
-        });
-        this.companyNumber = new fields_1.Field({
-            prediction: { value: undefined, confidence: 0.0 },
-        });
-        this.customerName = new fields_1.Field({
-            prediction: { value: undefined, confidence: 0.0 },
-        });
-        this.customerAddress = new fields_1.Field({
-            prediction: { value: undefined, confidence: 0.0 },
-        });
-        this.customerCompanyRegistration = [];
-        if (receipt.words)
-            this.words = receipt.words;
-    }
-}, _FinancialDocument_checklist = function _FinancialDocument_checklist() {
-    this.checklist = {
-        taxesMatchTotalIncl: __classPrivateFieldGet(this, _FinancialDocument_instances, "m", _FinancialDocument_taxesMatchTotalIncl).call(this),
-    };
-}, _FinancialDocument_taxesMatchTotalIncl = function _FinancialDocument_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) => (Object.assign(Object.assign({}, tax), { confidence: 1.0 })));
-        this.totalTax.probability = 1.0;
-        this.totalIncl.probability = 1.0;
-        return true;
-    }
-    return false;
-};

package/dist/documents/index.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FinancialDocument = exports.Invoice = exports.Receipt = exports.Document = exports.Field = void 0;
-var fields_1 = require("@documents/fields");
-Object.defineProperty(exports, "Field", { enumerable: true, get: function () { return fields_1.Field; } });
-var document_1 = require("@documents/document");
-Object.defineProperty(exports, "Document", { enumerable: true, get: function () { return document_1.Document; } });
-var receipt_1 = require("@documents/receipt");
-Object.defineProperty(exports, "Receipt", { enumerable: true, get: function () { return receipt_1.Receipt; } });
-var invoice_1 = require("@documents/invoice");
-Object.defineProperty(exports, "Invoice", { enumerable: true, get: function () { return invoice_1.Invoice; } });
-var financialDocument_1 = require("@documents/financialDocument");
-Object.defineProperty(exports, "FinancialDocument", { enumerable: true, get: function () { return financialDocument_1.FinancialDocument; } });