mindee 3.10.2 → 4.0.1

package/src/documents/proofOfAddress/proofOfAddressV1.js

@@ -1,77 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProofOfAddressV1 = void 0;
-const document_1 = require("../document");
-const fields_1 = require("../../fields");
-class ProofOfAddressV1 extends document_1.Document {
-    constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, pageId = undefined, }) {
-        super({
-            inputSource: inputSource,
-            pageId: pageId,
-            orientation: orientation,
-            extras: extras,
-        });
-        /** All extrated ISO date yyyy-mm-dd. Works both for European and US dates. */
-        this.dates = [];
-        /** Generic: VAT NUMBER, TAX ID, COMPANY REGISTRATION NUMBER or country specific. */
-        this.issuerCompanyRegistration = [];
-        /** Generic: VAT NUMBER, TAX ID, COMPANY REGISTRATION NUMBER or country specific. */
-        this.recipientCompanyRegistration = [];
-        this.locale = new fields_1.Locale({
-            prediction: prediction.locale,
-        });
-        this.date = new fields_1.DateField({
-            prediction: prediction.date,
-            pageId: pageId,
-        });
-        prediction.dates.map((prediction) => this.dates.push(new fields_1.DateField({
-            prediction: prediction,
-            pageId: pageId,
-        })));
-        this.issuerAddress = new fields_1.TextField({
-            prediction: prediction.issuer_address,
-            pageId: pageId,
-        });
-        prediction.issuer_company_registration.map((prediction) => this.issuerCompanyRegistration.push(new fields_1.CompanyRegistration({
-            prediction: prediction,
-            pageId: pageId,
-        })));
-        this.issuerName = new fields_1.TextField({
-            prediction: prediction.issuer_name,
-            pageId: pageId,
-        });
-        prediction.recipient_company_registration.map((prediction) => this.recipientCompanyRegistration.push(new fields_1.CompanyRegistration({
-            prediction: prediction,
-            pageId: pageId,
-        })));
-        this.recipientAddress = new fields_1.TextField({
-            prediction: prediction.recipient_address,
-            pageId: pageId,
-        });
-        this.recipientName = new fields_1.TextField({
-            prediction: prediction.recipient_name,
-            pageId: pageId,
-        });
-    }
-    toString() {
-        const outStr = `----- Proof of Address V1 -----
-Filename: ${this.filename}
-Locale: ${this.locale}
-Issuer Name: ${this.issuerName}
-Issuer Company Registrations: ${this.issuerCompanyRegistration
-            .map((icr) => icr.value)
-            .join(", ")}
-Issuer Address: ${this.issuerAddress}
-Recipient Name: ${this.recipientName}
-Recipient Company Registrations: ${this.recipientCompanyRegistration
-            .map((rcr) => rcr.value)
-            .join(", ")}
-Recipient Address: ${this.recipientAddress}
-Dates: ${this.dates.map((rcr) => rcr.value).join("\n       ")}
-Date of Issue: ${this.date}
-----------------------
-`;
-        return ProofOfAddressV1.cleanOutString(outStr);
-    }
-}
-exports.ProofOfAddressV1 = ProofOfAddressV1;

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

@@ -1,25 +0,0 @@
-import { Document, DocumentConstructorProps } from "../document";
-import { ClassificationField, TaxField, TextField, Amount, Locale, DateField } from "../../fields";
-export declare class ReceiptV3 extends Document {
-    #private;
-    /** Total amount with the tax amount of the purchase. */
-    locale: Locale;
-    /** Where the purchase was made, the language, and the currency. */
-    totalIncl: Amount;
-    /** The purchase date. */
-    date: DateField;
-    /** The type of purchase. */
-    category: ClassificationField;
-    /** Merchant's name as seen on the receipt. */
-    merchantName: TextField;
-    /** Time as seen on the receipt in HH:MM format. */
-    time: TextField;
-    /** Total tax amount of the purchase. */
-    totalTax: Amount;
-    /** Total amount without tax of the purchase. */
-    totalExcl: Amount;
-    /** List of different taxes. */
-    taxes: TaxField[];
-    constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);
-    toString(): string;
-}

package/src/documents/receipt/receiptV3.js

@@ -1,136 +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 _ReceiptV3_instances, _ReceiptV3_checklist, _ReceiptV3_taxesMatchTotal, _ReceiptV3_reconstruct, _ReceiptV3_reconstructTotalExclFromTCCAndTaxes, _ReceiptV3_reconstructTotalTax;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReceiptV3 = void 0;
-const document_1 = require("../document");
-const fields_1 = require("../../fields");
-class ReceiptV3 extends document_1.Document {
-    constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, fullText = undefined, pageId = undefined, }) {
-        super({
-            inputSource: inputSource,
-            pageId: pageId,
-            orientation: orientation,
-            extras: extras,
-            fullText: fullText,
-        });
-        _ReceiptV3_instances.add(this);
-        this.locale = new fields_1.Locale({
-            prediction: prediction.locale,
-        });
-        this.totalTax = new fields_1.Amount({
-            prediction: { value: undefined, confidence: 0 },
-            pageId: pageId,
-        });
-        this.totalExcl = new fields_1.Amount({
-            prediction: { value: undefined, confidence: 0 },
-            pageId: pageId,
-        });
-        this.totalIncl = new fields_1.Amount({
-            prediction: prediction.total_incl,
-            pageId: pageId,
-        });
-        this.date = new fields_1.DateField({
-            prediction: prediction.date,
-            pageId: pageId,
-        });
-        this.category = new fields_1.ClassificationField({
-            prediction: prediction.category,
-        });
-        this.merchantName = new fields_1.TextField({
-            prediction: prediction.supplier,
-            pageId: pageId,
-        });
-        this.time = new fields_1.TextField({
-            prediction: prediction.time,
-            pageId: pageId,
-        });
-        this.taxes = new fields_1.Taxes().init(prediction["taxes"], pageId);
-        __classPrivateFieldGet(this, _ReceiptV3_instances, "m", _ReceiptV3_checklist).call(this);
-        __classPrivateFieldGet(this, _ReceiptV3_instances, "m", _ReceiptV3_reconstruct).call(this);
-    }
-    toString() {
-        const outStr = `Receipt V3 Prediction
-=====================
-:Filename: ${this.filename}
-:Total amount: ${this.totalIncl}
-:Total net: ${this.totalExcl}
-:Date: ${this.date}
-:Category: ${this.category}
-:Time: ${this.time}
-:Merchant name: ${this.merchantName}
-:Taxes: ${this.taxes}
-:Total tax: ${this.totalTax}
-:Locale: ${this.locale}
-`;
-        return ReceiptV3.cleanOutString(outStr);
-    }
-}
-exports.ReceiptV3 = ReceiptV3;
-_ReceiptV3_instances = new WeakSet(), _ReceiptV3_checklist = function _ReceiptV3_checklist() {
-    this.checklist = { taxesMatchTotalIncl: __classPrivateFieldGet(this, _ReceiptV3_instances, "m", _ReceiptV3_taxesMatchTotal).call(this) };
-}, _ReceiptV3_taxesMatchTotal = function _ReceiptV3_taxesMatchTotal() {
-    // Check taxes and total amount exist
-    if (this.taxes.length === 0 || this.totalIncl.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 += 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;
-}, _ReceiptV3_reconstruct = function _ReceiptV3_reconstruct() {
-    __classPrivateFieldGet(this, _ReceiptV3_instances, "m", _ReceiptV3_reconstructTotalExclFromTCCAndTaxes).call(this);
-    __classPrivateFieldGet(this, _ReceiptV3_instances, "m", _ReceiptV3_reconstructTotalTax).call(this);
-}, _ReceiptV3_reconstructTotalExclFromTCCAndTaxes = function _ReceiptV3_reconstructTotalExclFromTCCAndTaxes() {
-    if (this.taxes.length && this.totalIncl.value !== undefined) {
-        const totalExcl = {
-            value: this.totalIncl.value - fields_1.TextField.arraySum(this.taxes),
-            confidence: fields_1.TextField.arrayConfidence(this.taxes) *
-                this.totalIncl.confidence,
-        };
-        this.totalExcl = new fields_1.Amount({
-            prediction: totalExcl,
-            valueKey: "value",
-            reconstructed: true,
-        });
-    }
-}, _ReceiptV3_reconstructTotalTax = function _ReceiptV3_reconstructTotalTax() {
-    if (this.taxes.length && this.totalTax.value === undefined) {
-        const totalTax = {
-            value: this.taxes
-                .map((tax) => tax.value || 0)
-                .reduce((a, b) => a + b, 0),
-            confidence: fields_1.TextField.arrayConfidence(this.taxes),
-        };
-        if (totalTax.value > 0)
-            this.totalTax = new fields_1.Amount({
-                prediction: totalTax,
-                valueKey: "value",
-                reconstructed: true,
-            });
-    }
-};

package/src/documents/receipt/receiptV4.js

@@ -1,78 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReceiptV4 = void 0;
-const document_1 = require("../document");
-const fields_1 = require("../../fields");
-class ReceiptV4 extends document_1.Document {
-    constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, fullText = undefined, pageId = undefined, }) {
-        super({
-            inputSource: inputSource,
-            pageId: pageId,
-            orientation: orientation,
-            extras: extras,
-            fullText: fullText,
-        });
-        this.locale = new fields_1.Locale({
-            prediction: prediction.locale,
-        });
-        this.totalTax = new fields_1.Amount({
-            prediction: prediction.total_tax,
-            pageId: pageId,
-        });
-        this.totalAmount = new fields_1.Amount({
-            prediction: prediction.total_amount,
-            pageId: pageId,
-        });
-        this.totalNet = new fields_1.Amount({
-            prediction: prediction.total_net,
-            pageId: pageId,
-        });
-        this.tip = new fields_1.Amount({
-            prediction: prediction.tip,
-            pageId: pageId,
-        });
-        this.date = new fields_1.DateField({
-            prediction: prediction.date,
-            pageId: pageId,
-        });
-        this.category = new fields_1.ClassificationField({
-            prediction: prediction.category,
-        });
-        this.subCategory = new fields_1.ClassificationField({
-            prediction: prediction.subcategory,
-        });
-        this.documentType = new fields_1.TextField({
-            prediction: prediction.document_type,
-            pageId: pageId,
-        });
-        this.supplier = new fields_1.TextField({
-            prediction: prediction.supplier,
-            pageId: pageId,
-        });
-        this.time = new fields_1.TextField({
-            prediction: prediction.time,
-            pageId: pageId,
-        });
-        this.taxes = new fields_1.Taxes().init(prediction["taxes"], pageId);
-    }
-    toString() {
-        const outStr = `Receipt V4 Prediction
-=====================
-:Filename: ${this.filename}
-:Total amount: ${this.totalAmount}
-:Total net: ${this.totalNet}
-:Tip: ${this.tip}
-:Date: ${this.date}
-:Category: ${this.category}
-:Subcategory: ${this.subCategory}
-:Document type: ${this.documentType}
-:Time: ${this.time}
-:Supplier name: ${this.supplier}
-:Taxes: ${this.taxes}
-:Total tax: ${this.totalTax}
-:Locale: ${this.locale}
-`;
-        return ReceiptV4.cleanOutString(outStr);
-    }
-}
-exports.ReceiptV4 = ReceiptV4;

package/src/documents/receipt/receiptV5.js

@@ -1,137 +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 _ReceiptV5_instances, _ReceiptV5_lineItemsSeparator, _ReceiptV5_lineItemsToString;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReceiptV5 = void 0;
-const document_1 = require("../document");
-const fields_1 = require("../../fields");
-const receiptV5LineItem_1 = require("./receiptV5LineItem");
-/**
- * Document data for Expense Receipt, API version 5.
- */
-class ReceiptV5 extends document_1.Document {
-    constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, fullText = undefined, pageId = undefined, }) {
-        super({
-            inputSource: inputSource,
-            pageId: pageId,
-            orientation: orientation,
-            extras: extras,
-            fullText: fullText,
-        });
-        _ReceiptV5_instances.add(this);
-        /** List of line item details. */
-        this.lineItems = [];
-        /** List of company registrations associated to the supplier. */
-        this.supplierCompanyRegistrations = [];
-        this.category = new fields_1.ClassificationField({
-            prediction: prediction["category"],
-        });
-        this.date = new fields_1.DateField({
-            prediction: prediction["date"],
-            pageId: pageId,
-        });
-        this.documentType = new fields_1.ClassificationField({
-            prediction: prediction["document_type"],
-        });
-        prediction["line_items"].map((itemPrediction) => this.lineItems.push(new receiptV5LineItem_1.ReceiptV5LineItem({
-            prediction: itemPrediction,
-            pageId: pageId,
-        })));
-        this.locale = new fields_1.Locale({
-            prediction: prediction["locale"],
-        });
-        this.subcategory = new fields_1.ClassificationField({
-            prediction: prediction["subcategory"],
-        });
-        this.supplierAddress = new fields_1.TextField({
-            prediction: prediction["supplier_address"],
-            pageId: pageId,
-        });
-        prediction["supplier_company_registrations"].map((itemPrediction) => this.supplierCompanyRegistrations.push(new fields_1.CompanyRegistration({
-            prediction: itemPrediction,
-            pageId: pageId,
-        })));
-        this.supplierName = new fields_1.TextField({
-            prediction: prediction["supplier_name"],
-            pageId: pageId,
-        });
-        this.supplierPhoneNumber = new fields_1.TextField({
-            prediction: prediction["supplier_phone_number"],
-            pageId: pageId,
-        });
-        this.taxes = new fields_1.Taxes().init(prediction["taxes"], pageId);
-        this.time = new fields_1.TextField({
-            prediction: prediction["time"],
-            pageId: pageId,
-        });
-        this.tip = new fields_1.Amount({
-            prediction: prediction["tip"],
-            pageId: pageId,
-        });
-        this.totalAmount = new fields_1.Amount({
-            prediction: prediction["total_amount"],
-            pageId: pageId,
-        });
-        this.totalNet = new fields_1.Amount({
-            prediction: prediction["total_net"],
-            pageId: pageId,
-        });
-        this.totalTax = new fields_1.Amount({
-            prediction: prediction["total_tax"],
-            pageId: pageId,
-        });
-    }
-    toString() {
-        const outStr = `Receipt V5 Prediction
-=====================
-:Filename: ${this.filename}
-:Expense Locale: ${this.locale}
-:Purchase Category: ${this.category}
-:Purchase Subcategory: ${this.subcategory}
-:Document Type: ${this.documentType}
-:Purchase Date: ${this.date}
-:Purchase Time: ${this.time}
-:Total Amount: ${this.totalAmount}
-:Total Net: ${this.totalNet}
-:Total Tax: ${this.totalTax}
-:Tip and Gratuity: ${this.tip}
-:Taxes: ${this.taxes}
-:Supplier Name: ${this.supplierName}
-:Supplier Company Registrations: ${this.supplierCompanyRegistrations.join(`${" ".repeat(32)}`)}
-:Supplier Address: ${this.supplierAddress}
-:Supplier Phone Number: ${this.supplierPhoneNumber}
-:Line Items: ${__classPrivateFieldGet(this, _ReceiptV5_instances, "m", _ReceiptV5_lineItemsToString).call(this)}
-`;
-        return ReceiptV5.cleanOutString(outStr);
-    }
-}
-exports.ReceiptV5 = ReceiptV5;
-_ReceiptV5_instances = new WeakSet(), _ReceiptV5_lineItemsSeparator = function _ReceiptV5_lineItemsSeparator(char) {
-    let outStr = "  ";
-    outStr += `+${char.repeat(38)}`;
-    outStr += `+${char.repeat(10)}`;
-    outStr += `+${char.repeat(14)}`;
-    outStr += `+${char.repeat(12)}`;
-    return outStr + "+";
-}, _ReceiptV5_lineItemsToString = function _ReceiptV5_lineItemsToString() {
-    if (!this.lineItems || this.lineItems.length === 0) {
-        return "";
-    }
-    const lines = this.lineItems
-        .map((item) => item.toTableLine())
-        .join(`\n${__classPrivateFieldGet(this, _ReceiptV5_instances, "m", _ReceiptV5_lineItemsSeparator).call(this, "-")}\n  `);
-    let outStr = "";
-    outStr += `\n${__classPrivateFieldGet(this, _ReceiptV5_instances, "m", _ReceiptV5_lineItemsSeparator).call(this, "-")}\n `;
-    outStr += " | Description                         ";
-    outStr += " | Quantity";
-    outStr += " | Total Amount";
-    outStr += " | Unit Price";
-    outStr += ` |\n${__classPrivateFieldGet(this, _ReceiptV5_instances, "m", _ReceiptV5_lineItemsSeparator).call(this, "=")}`;
-    outStr += `\n  ${lines}`;
-    outStr += `\n${__classPrivateFieldGet(this, _ReceiptV5_instances, "m", _ReceiptV5_lineItemsSeparator).call(this, "-")}`;
-    return outStr;
-};

package/src/documents/us/bankCheck/bankCheckV1.d.ts

@@ -1,22 +0,0 @@
-import { Document, DocumentConstructorProps } from "../../document";
-import { TextField, DateField, PositionField, Amount } from "../../../fields";
-export declare class BankCheckV1 extends Document {
-    /** Payer's bank account number. */
-    accountNumber: TextField;
-    /** Amount to be paid. */
-    amount: Amount;
-    /** The check number. */
-    checkNumber: TextField;
-    /** Check's position in the image. */
-    checkPosition: PositionField;
-    /** Date the check was issued. */
-    issuanceDate: DateField;
-    /** List of payees (full name or company name). */
-    payees: TextField[];
-    /** Payer's bank account routing number. */
-    routingNumber: TextField;
-    /** The positions of the signatures on the image. */
-    signaturesPositions: PositionField;
-    constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
-    toString(): string;
-}

package/src/documents/us/bankCheck/bankCheckV1.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BankCheckV1 = void 0;
-const document_1 = require("../../document");
-const fields_1 = require("../../../fields");
-class BankCheckV1 extends document_1.Document {
-    constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, pageId = undefined, }) {
-        super({
-            inputSource: inputSource,
-            pageId: pageId,
-            orientation: orientation,
-            extras: extras,
-        });
-        /** List of payees (full name or company name). */
-        this.payees = [];
-        this.accountNumber = new fields_1.TextField({
-            prediction: prediction.account_number,
-            pageId: pageId,
-        });
-        this.checkNumber = new fields_1.TextField({
-            prediction: prediction.check_number,
-            pageId: pageId,
-        });
-        this.amount = new fields_1.Amount({
-            prediction: prediction.amount,
-            pageId: pageId,
-        });
-        this.checkPosition = new fields_1.PositionField({
-            prediction: prediction.check_position,
-            pageId: pageId,
-        });
-        this.issuanceDate = new fields_1.DateField({
-            prediction: prediction.date,
-            pageId: pageId,
-        });
-        prediction.payees.map((prediction) => this.payees.push(new fields_1.TextField({
-            prediction: prediction,
-            pageId: pageId,
-        })));
-        this.routingNumber = new fields_1.TextField({
-            prediction: prediction.routing_number,
-            pageId: pageId,
-        });
-        this.signaturesPositions = new fields_1.PositionField({
-            prediction: prediction.signatures_positions,
-            pageId: pageId,
-        });
-    }
-    toString() {
-        const outStr = `----- US Bank Check V1 -----
-Filename: ${this.filename}
-Routing number: ${this.routingNumber}
-Account number: ${this.accountNumber}
-Check number: ${this.checkNumber}
-Date: ${this.issuanceDate}
-Amount: ${this.amount}
-Payees: ${this.payees.map((name) => name.value).join(", ")}
-----------------------
-`;
-        return BankCheckV1.cleanOutString(outStr);
-    }
-}
-exports.BankCheckV1 = BankCheckV1;

package/src/documents/us/index.d.ts

@@ -1 +0,0 @@
-export { BankCheckV1 } from "./bankCheck/bankCheckV1";

package/src/documents/us/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BankCheckV1 = void 0;
-var bankCheckV1_1 = require("./bankCheck/bankCheckV1");
-Object.defineProperty(exports, "BankCheckV1", { enumerable: true, get: function () { return bankCheckV1_1.BankCheckV1; } });

package/src/fields/companyRegistration.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CompanyRegistration = void 0;
-const field_1 = require("./field");
-/**
- * A company registration item.
- */
-class CompanyRegistration extends field_1.Field {
-    constructor({ prediction, valueKey = "value", reconstructed = false, pageId, }) {
-        super({ prediction, valueKey, reconstructed, pageId });
-        this.type = prediction.type;
-    }
-}
-exports.CompanyRegistration = CompanyRegistration;

package/src/fields/fullText.d.ts

@@ -1,27 +0,0 @@
-import * as geometry from "../geometry";
-export type Word = {
-    /**
-     * Contains the relative vertices coordinates (points) of a polygon containing
-     * the field in the document.
-     */
-    polygon: geometry.Polygon;
-    text: string;
-    confidence: number;
-};
-type Line = Word[];
-/**
- * OCR extraction from the entire document.
- */
-export declare class FullText {
-    words: Word[];
-    /**
-     * Order all text on a page into lines.
-     * WARNING: This feature is experimental.
-     */
-    toLines(): Line[];
-    /**
-     * WARNING: This feature is experimental.
-     */
-    toString(): string;
-}
-export {};