mindee 1.3.2 → 2.0.0

package/dist/src/documents/invoice.js

@@ -0,0 +1,303 @@
+"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 _Invoice_instances, _Invoice_initFromApiPrediction, _Invoice_checklist, _Invoice_reconstruct, _Invoice_reconstructTotalTax, _Invoice_reconstructTotalTaxFromTotals, _Invoice_reconstructTotalExcl, _Invoice_reconstructTotalIncl;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Invoice = void 0;
+const document_1 = require("./document");
+const fields_1 = require("../fields");
+class Invoice extends document_1.Document {
+    /**
+     * @param {Object} apiPrediction - Json parsed prediction from HTTP response
+     * @param {Input} inputFile - input file given to parse the document
+     * @param {number} pageId - Page ID for multi-page document
+     * @param {FullText} fullText - full OCR extracted text
+     */
+    constructor({ apiPrediction, inputFile = undefined, fullText = undefined, pageId = undefined, }) {
+        super(inputFile, pageId, fullText);
+        _Invoice_instances.add(this);
+        this.companyRegistration = [];
+        this.taxes = [];
+        this.paymentDetails = [];
+        this.customerCompanyRegistration = [];
+        __classPrivateFieldGet(this, _Invoice_instances, "m", _Invoice_initFromApiPrediction).call(this, apiPrediction, pageId);
+        __classPrivateFieldGet(this, _Invoice_instances, "m", _Invoice_checklist).call(this);
+        __classPrivateFieldGet(this, _Invoice_instances, "m", _Invoice_reconstruct).call(this);
+    }
+    toString() {
+        const taxes = this.taxes.map((item) => item.toString()).join("\n       ");
+        const paymentDetails = this.paymentDetails
+            .map((item) => item.toString())
+            .join("\n                 ");
+        const customerCompanyRegistration = this.customerCompanyRegistration
+            .map((item) => item.toString())
+            .join("; ");
+        const companyRegistration = this.companyRegistration
+            .map((item) => item.toString())
+            .join("; ");
+        const outStr = `-----Invoice data-----
+Filename: ${this.filename}
+Invoice number: ${this.invoiceNumber}
+Total amount including taxes: ${this.totalIncl}
+Total amount excluding taxes: ${this.totalExcl}
+Invoice date: ${this.date}
+Invoice due date: ${this.dueDate}
+Supplier name: ${this.supplier}
+Supplier address: ${this.supplierAddress}
+Customer name: ${this.customerName}
+Customer company registration: ${customerCompanyRegistration}
+Customer address: ${this.customerAddress}
+Payment details: ${paymentDetails}
+Company numbers: ${companyRegistration}
+Taxes: ${taxes}
+Total taxes: ${this.totalTax}
+Locale: ${this.locale}
+----------------------
+`;
+        return Invoice.cleanOutString(outStr);
+    }
+    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.forEach((tax) => {
+                tax.confidence = 1.0;
+            });
+            this.totalTax.confidence = 1.0;
+            this.totalIncl.confidence = 1.0;
+            return true;
+        }
+        return false;
+    }
+    /**
+     *
+     */
+    taxesMatchTotalExcl() {
+        // Check taxes and total amount exist
+        if (this.taxes.length === 0 || this.totalExcl.value === undefined) {
+            return false;
+        }
+        // Reconstruct total_incl from taxes
+        let totalVat = 0;
+        let reconstructedTotal = 0;
+        this.taxes.forEach((tax) => {
+            if (tax.value === undefined || !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.forEach((tax) => {
+                tax.confidence = 1.0;
+            });
+            this.totalTax.confidence = 1.0;
+            this.totalExcl.confidence = 1.0;
+            return true;
+        }
+        return false;
+    }
+    taxesAndTotalExclMatchTotalIncl() {
+        if (this.totalExcl.value === undefined ||
+            this.taxes.length === 0 ||
+            this.totalIncl.value === undefined)
+            return false;
+        let totalVat = 0;
+        this.taxes.forEach((tax) => (totalVat += tax.value || 0));
+        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.forEach((tax) => {
+                tax.confidence = 1.0;
+            });
+            this.totalTax.confidence = 1.0;
+            this.totalIncl.confidence = 1.0;
+            return true;
+        }
+        return false;
+    }
+}
+exports.Invoice = Invoice;
+_Invoice_instances = new WeakSet(), _Invoice_initFromApiPrediction = function _Invoice_initFromApiPrediction(apiPrediction, pageId) {
+    this.locale = new fields_1.Locale({
+        prediction: apiPrediction.locale,
+        valueKey: "language",
+    });
+    this.documentType = new fields_1.BaseField({
+        prediction: apiPrediction.document_type,
+        valueKey: "value",
+    });
+    this.totalIncl = new fields_1.Amount({
+        prediction: apiPrediction.total_incl,
+        valueKey: "value",
+        pageId: pageId,
+    });
+    this.totalTax = new fields_1.Amount({
+        prediction: { value: undefined, confidence: 0.0 },
+        valueKey: "value",
+        pageId: pageId,
+    });
+    this.totalExcl = new fields_1.Amount({
+        prediction: apiPrediction.total_excl,
+        valueKey: "value",
+        pageId: pageId,
+    });
+    this.date = new fields_1.DateField({
+        prediction: apiPrediction.date,
+        pageId,
+    });
+    apiPrediction.taxes.map((prediction) => this.taxes.push(new fields_1.TaxField({
+        prediction: prediction,
+        pageId: pageId,
+        valueKey: "value",
+        rateKey: "rate",
+        codeKey: "code",
+    })));
+    this.companyRegistration = apiPrediction.company_registration.map(function (prediction) {
+        return new fields_1.CompanyRegistration({
+            prediction: prediction,
+            pageId: pageId,
+        });
+    });
+    this.dueDate = new fields_1.DateField({
+        prediction: apiPrediction.due_date,
+        pageId: pageId,
+    });
+    this.invoiceNumber = new fields_1.Field({
+        prediction: apiPrediction.invoice_number,
+        pageId: pageId,
+    });
+    this.supplier = new fields_1.Field({
+        prediction: apiPrediction.supplier,
+        pageId: pageId,
+    });
+    this.supplierAddress = new fields_1.Field({
+        prediction: apiPrediction.supplier_address,
+        pageId: pageId,
+    });
+    this.customerName = new fields_1.Field({
+        prediction: apiPrediction.customer,
+        pageId: pageId,
+    });
+    this.customerAddress = new fields_1.Field({
+        prediction: apiPrediction.customer_address,
+        pageId: pageId,
+    });
+    apiPrediction.customer_company_registration.map((prediction) => this.customerCompanyRegistration.push(new fields_1.CompanyRegistration({
+        prediction: prediction,
+        pageId: pageId,
+    })));
+    apiPrediction.payment_details.map((prediction) => this.paymentDetails.push(new fields_1.PaymentDetails({
+        prediction: prediction,
+        pageId: pageId,
+    })));
+    if (pageId !== undefined) {
+        this.orientation = new fields_1.Orientation({
+            prediction: apiPrediction.orientation,
+            pageId: pageId,
+        });
+    }
+}, _Invoice_checklist = function _Invoice_checklist() {
+    this.checklist = {
+        taxesMatchTotalIncl: this.taxesMatchTotalIncl(),
+        taxesMatchTotalExcl: this.taxesMatchTotalExcl(),
+        taxesAndTotalExclMatchTotalIncl: this.taxesAndTotalExclMatchTotalIncl(),
+    };
+}, _Invoice_reconstruct = function _Invoice_reconstruct() {
+    __classPrivateFieldGet(this, _Invoice_instances, "m", _Invoice_reconstructTotalTax).call(this);
+    __classPrivateFieldGet(this, _Invoice_instances, "m", _Invoice_reconstructTotalExcl).call(this);
+    __classPrivateFieldGet(this, _Invoice_instances, "m", _Invoice_reconstructTotalIncl).call(this);
+    __classPrivateFieldGet(this, _Invoice_instances, "m", _Invoice_reconstructTotalTaxFromTotals).call(this);
+}, _Invoice_reconstructTotalTax = function _Invoice_reconstructTotalTax() {
+    if (this.taxes.length > 0) {
+        const totalTax = {
+            value: this.taxes.reduce((acc, tax) => {
+                return tax.value !== undefined ? acc + tax.value : acc;
+            }, 0),
+            confidence: fields_1.Field.arrayConfidence(this.taxes),
+        };
+        if (totalTax.value > 0)
+            this.totalTax = new fields_1.Amount({
+                prediction: totalTax,
+                valueKey: "value",
+                reconstructed: true,
+            });
+    }
+}, _Invoice_reconstructTotalTaxFromTotals = function _Invoice_reconstructTotalTaxFromTotals() {
+    if (this.totalTax.value !== undefined ||
+        this.totalExcl.value === undefined ||
+        this.totalIncl.value === undefined) {
+        return;
+    }
+    const totalTax = {
+        value: this.totalIncl.value - this.totalExcl.value,
+        confidence: this.totalIncl.confidence * this.totalExcl.confidence,
+    };
+    if (totalTax.value >= 0) {
+        this.totalTax = new fields_1.Amount({
+            prediction: totalTax,
+            valueKey: "value",
+            reconstructed: true,
+        });
+    }
+}, _Invoice_reconstructTotalExcl = function _Invoice_reconstructTotalExcl() {
+    if (this.totalIncl.value === undefined ||
+        this.taxes.length === 0 ||
+        this.totalExcl.value !== undefined) {
+        return;
+    }
+    const totalExcl = {
+        value: this.totalIncl.value - fields_1.Field.arraySum(this.taxes),
+        confidence: fields_1.Field.arrayConfidence(this.taxes) *
+            this.totalIncl.confidence,
+    };
+    this.totalExcl = new fields_1.Amount({
+        prediction: totalExcl,
+        valueKey: "value",
+        reconstructed: true,
+    });
+}, _Invoice_reconstructTotalIncl = function _Invoice_reconstructTotalIncl() {
+    if (!(this.totalExcl.value === undefined ||
+        this.taxes.length === 0 ||
+        this.totalIncl.value !== undefined)) {
+        const totalIncl = {
+            value: this.totalExcl.value +
+                this.taxes.reduce((acc, tax) => {
+                    return tax.value ? acc + tax.value : acc;
+                }, 0.0),
+            confidence: fields_1.Field.arrayConfidence(this.taxes) * this.totalExcl.confidence,
+        };
+        this.totalIncl = new fields_1.Amount({
+            prediction: totalIncl,
+            valueKey: "value",
+            reconstructed: true,
+        });
+    }
+};

package/dist/src/documents/passport.d.ts

@@ -0,0 +1,36 @@
+import { Document, DocumentConstructorProps } from "./document";
+import { Field, DateField } from "../fields";
+export declare class Passport extends Document {
+    #private;
+    country: Field;
+    idNumber: Field;
+    birthDate: DateField;
+    expiryDate: DateField;
+    issuanceDate: DateField;
+    birthPlace: Field;
+    gender: Field;
+    surname: Field;
+    mrz1: Field;
+    mrz2: Field;
+    givenNames: Field[];
+    fullName: Field;
+    mrz: Field;
+    /**
+     * @param {Object} apiPrediction - Json parsed prediction from HTTP response
+     * @param {Input} inputFile - input file given to parse the document
+     * @param {number} pageId - Page ID for multi-page document
+     * @param {FullText} fullText - full OCR extracted text
+     */
+    constructor({ apiPrediction, inputFile, pageId, }: DocumentConstructorProps);
+    static convertMRZDateToDatetime(dateString: string): Date;
+    toString(): string;
+    isExpired(): boolean;
+    private isMRZValid;
+    private isBirthDateValid;
+    private isExpiryDateValid;
+    private isIdNumberValid;
+    private isSurnameValid;
+    private isCountryValid;
+    private constructFullName;
+    private constructMRZ;
+}

package/dist/src/documents/passport.js

@@ -0,0 +1,218 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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 _Passport_instances, _Passport_checklist;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Passport = void 0;
+const document_1 = require("./document");
+const fields_1 = require("../fields");
+// @ts-ignore
+const MRZ = __importStar(require("mrz"));
+class Passport extends document_1.Document {
+    /**
+     * @param {Object} apiPrediction - Json parsed prediction from HTTP response
+     * @param {Input} inputFile - input file given to parse the document
+     * @param {number} pageId - Page ID for multi-page document
+     * @param {FullText} fullText - full OCR extracted text
+     */
+    constructor({ apiPrediction, inputFile = undefined, pageId = undefined, }) {
+        super(inputFile, pageId);
+        _Passport_instances.add(this);
+        this.givenNames = [];
+        this.country = new fields_1.Field({
+            prediction: apiPrediction.country,
+            pageId: pageId,
+        });
+        this.idNumber = new fields_1.Field({
+            prediction: apiPrediction.id_number,
+            pageId: pageId,
+        });
+        this.birthDate = new fields_1.DateField({
+            prediction: apiPrediction.birth_date,
+            pageId: pageId,
+        });
+        this.expiryDate = new fields_1.DateField({
+            prediction: apiPrediction.expiry_date,
+            pageId: pageId,
+        });
+        this.issuanceDate = new fields_1.DateField({
+            prediction: apiPrediction.issuance_date,
+            pageId: pageId,
+        });
+        this.birthPlace = new fields_1.Field({
+            prediction: apiPrediction.birth_place,
+            pageId: pageId,
+        });
+        this.gender = new fields_1.Field({
+            prediction: apiPrediction.gender,
+            pageId: pageId,
+        });
+        this.surname = new fields_1.Field({
+            prediction: apiPrediction.surname,
+            pageId: pageId,
+        });
+        this.mrz1 = new fields_1.Field({
+            prediction: apiPrediction.mrz1,
+            pageId: pageId,
+        });
+        this.mrz2 = new fields_1.Field({
+            prediction: apiPrediction.mrz2,
+            pageId: pageId,
+        });
+        apiPrediction.given_names.map((prediction) => this.givenNames.push(new fields_1.Field({
+            prediction: prediction,
+            pageId: pageId,
+        })));
+        this.fullName = this.constructFullName(pageId);
+        this.mrz = this.constructMRZ(pageId);
+        __classPrivateFieldGet(this, _Passport_instances, "m", _Passport_checklist).call(this);
+    }
+    static convertMRZDateToDatetime(dateString) {
+        const year = parseInt(dateString.substring(0, 2));
+        const month = parseInt(dateString.substring(2, 4));
+        const day = parseInt(dateString.substring(4, 6));
+        // month is 0 indexed, day is 1 indexed... because JavaScript ...
+        return new Date(year, month - 1, day, 0, 0, 0, 0);
+    }
+    toString() {
+        const outStr = `-----Passport data-----
+Filename: ${this.filename}
+Full name: ${this.fullName}
+Given names: ${this.givenNames.map((name) => name.value).join(" ")}
+Surname: ${this.surname}
+Country: ${this.country}
+ID Number: ${this.idNumber}
+Issuance date: ${this.issuanceDate}
+Birth date: ${this.birthDate}
+Expiry date: ${this.expiryDate}
+MRZ 1: ${this.mrz1}
+MRZ 2: ${this.mrz2}
+MRZ: ${this.mrz}
+----------------------
+`;
+        return Passport.cleanOutString(outStr);
+    }
+    isExpired() {
+        const dateTime = new Date();
+        if (this.expiryDate.dateObject) {
+            return this.expiryDate.dateObject < dateTime;
+        }
+        return true;
+    }
+    isMRZValid(mrz) {
+        const check = mrz.valid;
+        if (check)
+            this.mrz.confidence = 1.0;
+        return check;
+    }
+    isBirthDateValid(mrz) {
+        if (this.birthDate.dateObject === undefined || !mrz.fields.birthDate) {
+            return false;
+        }
+        const mrzDate = Passport.convertMRZDateToDatetime(mrz.fields.birthDate);
+        const check = fields_1.DateField.compareDates(this.birthDate.dateObject, mrzDate);
+        if (check) {
+            this.birthDate.confidence = 1.0;
+        }
+        return check;
+    }
+    isExpiryDateValid(mrz) {
+        if (this.expiryDate.dateObject === undefined ||
+            !mrz.fields.expirationDate) {
+            return false;
+        }
+        const mrzDate = Passport.convertMRZDateToDatetime(mrz.fields.expirationDate);
+        const check = fields_1.DateField.compareDates(this.expiryDate.dateObject, mrzDate);
+        if (check) {
+            this.expiryDate.confidence = 1.0;
+        }
+        return check;
+    }
+    isIdNumberValid(mrz) {
+        const check = mrz.fields.documentNumber &&
+            mrz.fields.documentNumber === this.idNumber.value;
+        if (check)
+            this.idNumber.confidence = 1.0;
+        return check;
+    }
+    isSurnameValid(mrz) {
+        const check = mrz.fields.lastName === this.surname.value;
+        if (check)
+            this.surname.confidence = 1.0;
+        return check;
+    }
+    isCountryValid(mrz) {
+        const check = mrz.fields.nationality === this.country.value;
+        if (check)
+            this.country.confidence = 1.0;
+        return check;
+    }
+    constructFullName(pageNumber) {
+        if (this.surname &&
+            this.givenNames.length > 0 &&
+            this.givenNames[0].value) {
+            const fullName = {
+                value: `${this.givenNames[0].value} ${this.surname.value}`,
+                confidence: fields_1.Field.arrayConfidence([this.surname, this.givenNames[0]]),
+            };
+            return new fields_1.Field({
+                prediction: fullName,
+                pageId: pageNumber,
+                reconstructed: true,
+            });
+        }
+    }
+    constructMRZ(pageNumber) {
+        if (this.mrz1.value && this.mrz2.value) {
+            const mrz = {
+                value: `${this.mrz1.value}${this.mrz2.value}`,
+                confidence: fields_1.Field.arrayConfidence([this.mrz1, this.mrz2]),
+            };
+            return new fields_1.Field({
+                prediction: mrz,
+                pageId: pageNumber,
+                reconstructed: true,
+            });
+        }
+    }
+}
+exports.Passport = Passport;
+_Passport_instances = new WeakSet(), _Passport_checklist = function _Passport_checklist() {
+    if (this.mrz1.value && this.mrz2.value) {
+        const mrz = MRZ.parse([this.mrz1.value, this.mrz2.value]);
+        this.checklist = {
+            mrzValid: this.isMRZValid(mrz),
+            mrzValidBirthDate: this.isBirthDateValid(mrz),
+            mrzValidExpiryDate: this.isExpiryDateValid(mrz),
+            mrzValidIdNumber: this.isIdNumberValid(mrz),
+            mrzValidSurname: this.isSurnameValid(mrz),
+            mrzValidCountry: this.isCountryValid(mrz),
+        };
+    }
+};

package/dist/src/documents/receipt.d.ts

@@ -0,0 +1,24 @@
+import { Document, DocumentConstructorProps } from "./document";
+import { TaxField, Field, Amount, Locale, Orientation, DateField } from "../fields";
+export declare class Receipt extends Document {
+    #private;
+    locale: Locale;
+    totalIncl: Amount;
+    date: DateField;
+    /** Receipt category as seen on the receipt. */
+    category: Field;
+    merchantName: Field;
+    time: Field;
+    orientation: Orientation | undefined;
+    totalTax: Amount;
+    totalExcl: Amount;
+    taxes: TaxField[];
+    /**
+     * @param {Object} apiPrediction - Json parsed prediction from HTTP response
+     * @param {Input} inputFile - input file given to parse the document
+     * @param {number} pageId - Page ID for multi-page document
+     * @param {FullText} fullText - full OCR extracted text
+     */
+    constructor({ apiPrediction, inputFile, fullText, pageId, }: DocumentConstructorProps);
+    toString(): string;
+}