mindee 3.7.4 → 3.8.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v3.8.0 - 2023-05-25
+### Changes
+* :sparkles: add support for receipt v5
+* :sparkles: print taxes in table layout
+
+
 ## v3.7.4 - 2023-04-20
 ### Changes
 * :white_check_mark: minor improvements to tests

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "3.7.4",
+    "version": "3.8.0",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",
@@ -48,11 +48,11 @@
         "eslint": "^8.32.0",
         "eslint-config-prettier": "^8.6.0",
         "eslint-plugin-prettier": "^4.2.1",
-        "typedoc": "~0.23",
         "mocha": "^10.1.0",
         "prettier": "^2.8.1",
         "ts-node": "^10.9.1",
-        "typescript": "^5.0.3"
+        "typedoc": "~0.23",
+        "typescript": "^5.0.4"
     },
     "dependencies": {
         "commander": "~9.4.1",

package/src/cli.js

@@ -72,7 +72,7 @@ const CLI_COMMAND_CONFIG = new Map([
         "receipt",
         {
             displayName: "Expense Receipt",
-            docClass: _1.ReceiptV4,
+            docClass: _1.ReceiptV5,
             fullText: true,
             async: false,
             sync: true,

package/src/client.js

@@ -51,7 +51,7 @@ class DocumentClient {
         if (this.inputSource === undefined) {
             throw new Error("The 'enqueue' function requires an input document.");
         }
-        return await docConfig.asyncPredict({
+        return await docConfig.predictAsync({
             inputDoc: this.inputSource,
             includeWords: this.getBooleanParam(params.fullText),
             pageOptions: params.pageOptions,
@@ -136,6 +136,9 @@ class Client {
         this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.ReceiptV4.name], new documentConfig_1.DocumentConfig(documents_1.ReceiptV4, [
             new api_1.StandardEndpoint("expense_receipts", "4", this.apiKey),
         ]));
+        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.ReceiptV5.name], new documentConfig_1.DocumentConfig(documents_1.ReceiptV5, [
+            new api_1.StandardEndpoint("expense_receipts", "5", this.apiKey),
+        ]));
         this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.PassportV1.name], new documentConfig_1.DocumentConfig(documents_1.PassportV1, [
             new api_1.StandardEndpoint("passport", "1", this.apiKey),
         ]));

package/src/documents/documentConfig.d.ts

@@ -19,7 +19,7 @@ export declare class DocumentConfig<DocType extends Document> {
         pageOptions?: PageOptions;
         cropper: boolean;
     }): Promise<Response<DocType>>;
-    asyncPredict(params: {
+    predictAsync(params: {
         inputDoc: InputSource;
         includeWords: boolean;
         pageOptions?: PageOptions;

package/src/documents/documentConfig.js

@@ -19,7 +19,7 @@ class DocumentConfig {
         const response = await this.predictRequest(params.inputDoc, params.includeWords, params.cropper);
         return this.buildResult(response, params.inputDoc);
     }
-    async asyncPredict(params) {
+    async predictAsync(params) {
         this.checkApiKeys();
         await params.inputDoc.init();
         if (params.pageOptions !== undefined) {

package/src/documents/financialDocument/financialDocumentV1.js

@@ -24,17 +24,14 @@ class FinancialDocumentV1 extends document_1.Document {
         this.supplierCompanyRegistrations = [];
         /** The company registration information for the customer. */
         this.customerCompanyRegistrations = [];
-        /** The list of the taxes. */
-        this.taxes = [];
         /** Line items details. */
         this.lineItems = [];
         this.locale = new fields_1.Locale({
             prediction: prediction.locale,
             valueKey: "language",
         });
-        this.documentType = new fields_1.BaseField({
+        this.documentType = new fields_1.ClassificationField({
             prediction: prediction.document_type,
-            valueKey: "value",
         });
         this.referenceNumbers = prediction.reference_numbers.map(function (prediction) {
             return new fields_1.TextField({
@@ -44,17 +41,14 @@ class FinancialDocumentV1 extends document_1.Document {
         });
         this.totalAmount = new fields_1.Amount({
             prediction: prediction.total_amount,
-            valueKey: "value",
             pageId: pageId,
         });
         this.totalTax = new fields_1.Amount({
             prediction: prediction.total_tax,
-            valueKey: "value",
             pageId: pageId,
         });
         this.totalNet = new fields_1.Amount({
             prediction: prediction.total_net,
-            valueKey: "value",
             pageId: pageId,
         });
         this.date = new fields_1.DateField({
@@ -105,7 +99,6 @@ class FinancialDocumentV1 extends document_1.Document {
         })));
         this.tip = new fields_1.Amount({
             prediction: prediction.tip,
-            valueKey: "value",
             pageId: pageId,
         });
         this.category = new fields_1.TextField({
@@ -120,17 +113,9 @@ class FinancialDocumentV1 extends document_1.Document {
             prediction: prediction.time,
             pageId: pageId,
         });
-        prediction.taxes.map((taxPrediction) => this.taxes.push(new fields_1.TaxField({
-            prediction: taxPrediction,
-            pageId: pageId,
-            valueKey: "value",
-            rateKey: "rate",
-            codeKey: "code",
-            baseKey: "base",
-        })));
+        this.taxes = new fields_1.Taxes().init(prediction["taxes"], pageId);
     }
     toString() {
-        const taxes = this.taxes.map((item) => item.toString()).join("\n       ");
         const referenceNumbers = this.referenceNumbers
             .map((item) => item.toString())
             .join(", ");
@@ -149,31 +134,31 @@ class FinancialDocumentV1 extends document_1.Document {
                 "\n  Code           | QTY    | Price   | Amount   | Tax (Rate)       | Description\n  ";
             lineItems += this.lineItems.map((item) => item.toString()).join("\n  ");
         }
-        const outStr = `----- Financial Document V1 -----
-Filename: ${this.filename}
-Document type: ${this.documentType}
-Category: ${this.category}
-Subcategory: ${this.subCategory}
-Locale: ${this.locale}
-Invoice number: ${this.invoiceNumber}
-Reference numbers: ${referenceNumbers}
-Date: ${this.date}
-Due date: ${this.dueDate}
-Time: ${this.time}
-Supplier name: ${this.supplierName}
-Supplier address: ${this.supplierAddress}
-Supplier company registrations: ${supplierCompanyRegistration}
-Supplier payment details: ${paymentDetails}
-Customer name: ${this.customerName}
-Customer address: ${this.customerAddress}
-Customer company registrations: ${customerCompanyRegistration}
-Tip: ${this.tip}
-Taxes: ${taxes}
-Total tax: ${this.totalTax}
-Total net: ${this.totalNet}
-Total amount: ${this.totalAmount}
-Line Items: ${lineItems}
-----------------------
+        const outStr = `Financial Document V1 Prediction
+================================
+:Filename: ${this.filename}
+:Document type: ${this.documentType}
+:Category: ${this.category}
+:Subcategory: ${this.subCategory}
+:Locale: ${this.locale}
+:Invoice number: ${this.invoiceNumber}
+:Reference numbers: ${referenceNumbers}
+:Date: ${this.date}
+:Due date: ${this.dueDate}
+:Time: ${this.time}
+:Supplier name: ${this.supplierName}
+:Supplier address: ${this.supplierAddress}
+:Supplier company registrations: ${supplierCompanyRegistration}
+:Supplier payment details: ${paymentDetails}
+:Customer name: ${this.customerName}
+:Customer address: ${this.customerAddress}
+:Customer company registrations: ${customerCompanyRegistration}
+:Tip: ${this.tip}
+:Taxes: ${this.taxes}
+:Total tax: ${this.totalTax}
+:Total net: ${this.totalNet}
+:Total amount: ${this.totalAmount}
+:Line Items: ${lineItems}
 `;
         return FinancialDocumentV1.cleanOutString(outStr);
     }

package/src/documents/index.d.ts

@@ -3,6 +3,7 @@ export { InvoiceV4 } from "./invoice/invoiceV4";
 export { InvoiceSplitterV1, PageGroup, } from "./invoiceSplitter/invoiceSplitterV1";
 export { ReceiptV3 } from "./receipt/receiptV3";
 export { ReceiptV4 } from "./receipt/receiptV4";
+export { ReceiptV5 } from "./receipt/receiptV5";
 export { PassportV1 } from "./passport/passportV1";
 export { FinancialDocumentV0 } from "./financialDocument/financialDocumentV0";
 export { FinancialDocumentV1 } from "./financialDocument/financialDocumentV1";

package/src/documents/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.eu = exports.us = exports.fr = exports.Document = exports.ShippingContainerV1 = exports.ProofOfAddressV1 = exports.MindeeVisionV1 = exports.CropperV1 = exports.getLineItems = exports.CustomV1 = exports.FinancialDocumentV1 = exports.FinancialDocumentV0 = exports.PassportV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PageGroup = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.InvoiceV3 = void 0;
+exports.eu = exports.us = exports.fr = exports.Document = exports.ShippingContainerV1 = exports.ProofOfAddressV1 = exports.MindeeVisionV1 = exports.CropperV1 = exports.getLineItems = exports.CustomV1 = exports.FinancialDocumentV1 = exports.FinancialDocumentV0 = exports.PassportV1 = exports.ReceiptV5 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PageGroup = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.InvoiceV3 = void 0;
 var invoiceV3_1 = require("./invoice/invoiceV3");
 Object.defineProperty(exports, "InvoiceV3", { enumerable: true, get: function () { return invoiceV3_1.InvoiceV3; } });
 var invoiceV4_1 = require("./invoice/invoiceV4");
@@ -35,6 +35,8 @@ var receiptV3_1 = require("./receipt/receiptV3");
 Object.defineProperty(exports, "ReceiptV3", { enumerable: true, get: function () { return receiptV3_1.ReceiptV3; } });
 var receiptV4_1 = require("./receipt/receiptV4");
 Object.defineProperty(exports, "ReceiptV4", { enumerable: true, get: function () { return receiptV4_1.ReceiptV4; } });
+var receiptV5_1 = require("./receipt/receiptV5");
+Object.defineProperty(exports, "ReceiptV5", { enumerable: true, get: function () { return receiptV5_1.ReceiptV5; } });
 var passportV1_1 = require("./passport/passportV1");
 Object.defineProperty(exports, "PassportV1", { enumerable: true, get: function () { return passportV1_1.PassportV1; } });
 var financialDocumentV0_1 = require("./financialDocument/financialDocumentV0");

package/src/documents/invoice/invoiceV3.d.ts

@@ -1,5 +1,5 @@
 import { Document, DocumentConstructorProps } from "../document";
-import { BaseField, TaxField, PaymentDetails, Locale, Amount, TextField, DateField, CompanyRegistration } from "../../fields";
+import { BaseField, Taxes, PaymentDetails, Locale, Amount, TextField, DateField, CompanyRegistration } from "../../fields";
 export declare class InvoiceV3 extends Document {
     #private;
     /** Total amount with the tax amount of the purchase. */
@@ -31,7 +31,7 @@ export declare class InvoiceV3 extends Document {
     /** The address of the customer. */
     customerAddress: TextField;
     /** The list of the taxes. */
-    taxes: TaxField[];
+    taxes: Taxes;
     /** The payment information. */
     paymentDetails: PaymentDetails[];
     /** The company registration information for the customer. */

package/src/documents/invoice/invoiceV3.js

@@ -4,7 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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 _InvoiceV3_instances, _InvoiceV3_initFromApiPrediction, _InvoiceV3_checklist, _InvoiceV3_reconstruct;
+var _InvoiceV3_instances, _InvoiceV3_checklist, _InvoiceV3_reconstruct;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvoiceV3 = void 0;
 const document_1 = require("../document");
@@ -39,18 +39,77 @@ class InvoiceV3 extends document_1.Document {
         _InvoiceV3_instances.add(this);
         /** The company regitration information. */
         this.companyRegistration = [];
-        /** The list of the taxes. */
-        this.taxes = [];
         /** The payment information. */
         this.paymentDetails = [];
         /** The company registration information for the customer. */
         this.customerCompanyRegistration = [];
-        __classPrivateFieldGet(this, _InvoiceV3_instances, "m", _InvoiceV3_initFromApiPrediction).call(this, prediction, pageId);
+        this.locale = new fields_1.Locale({
+            prediction: prediction.locale,
+            valueKey: "language",
+        });
+        this.documentType = new fields_1.BaseField({
+            prediction: prediction.document_type,
+        });
+        this.totalIncl = new fields_1.Amount({
+            prediction: prediction.total_incl,
+            pageId: pageId,
+        });
+        this.totalAmount = this.totalIncl;
+        this.totalTax = new fields_1.Amount({
+            prediction: { value: undefined, confidence: 0.0 },
+            pageId: pageId,
+        });
+        this.totalNet = new fields_1.Amount({
+            prediction: prediction.total_excl,
+            pageId: pageId,
+        });
+        this.date = new fields_1.DateField({
+            prediction: prediction.date,
+            pageId,
+        });
+        this.taxes = new fields_1.Taxes().init(prediction["taxes"], pageId);
+        this.companyRegistration = prediction.company_registration.map(function (prediction) {
+            return new fields_1.CompanyRegistration({
+                prediction: prediction,
+                pageId: pageId,
+            });
+        });
+        this.dueDate = new fields_1.DateField({
+            prediction: prediction.due_date,
+            pageId: pageId,
+        });
+        this.invoiceNumber = new fields_1.TextField({
+            prediction: prediction.invoice_number,
+            pageId: pageId,
+        });
+        this.supplier = new fields_1.TextField({
+            prediction: prediction.supplier,
+            pageId: pageId,
+        });
+        this.supplierAddress = new fields_1.TextField({
+            prediction: prediction.supplier_address,
+            pageId: pageId,
+        });
+        this.customerName = new fields_1.TextField({
+            prediction: prediction.customer,
+            pageId: pageId,
+        });
+        this.customerAddress = new fields_1.TextField({
+            prediction: prediction.customer_address,
+            pageId: pageId,
+        });
+        prediction.customer_company_registration.map((prediction) => this.customerCompanyRegistration.push(new fields_1.CompanyRegistration({
+            prediction: prediction,
+            pageId: pageId,
+        })));
+        prediction.payment_details.map((prediction) => this.paymentDetails.push(new fields_1.PaymentDetails({
+            prediction: prediction,
+            pageId: pageId,
+        })));
         __classPrivateFieldGet(this, _InvoiceV3_instances, "m", _InvoiceV3_checklist).call(this);
         __classPrivateFieldGet(this, _InvoiceV3_instances, "m", _InvoiceV3_reconstruct).call(this);
     }
     toString() {
-        const taxes = this.taxes.map((item) => item.toString()).join("\n       ");
         const paymentDetails = this.paymentDetails
             .map((item) => item.toString())
             .join("\n                 ");
@@ -60,104 +119,30 @@ class InvoiceV3 extends document_1.Document {
         const companyRegistration = this.companyRegistration
             .map((item) => item.toString())
             .join("; ");
-        const outStr = `----- Invoice V3 -----
-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}
-----------------------
+        const outStr = `Invoice V3 Prediction
+=====================
+:Filename: ${this.filename}
+:Invoice number: ${this.invoiceNumber}
+:Total amount: ${this.totalIncl}
+:Total net: ${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: ${this.taxes}
+:Total tax: ${this.totalTax}
+:Locale: ${this.locale}
 `;
         return InvoiceV3.cleanOutString(outStr);
     }
 }
 exports.InvoiceV3 = InvoiceV3;
-_InvoiceV3_instances = new WeakSet(), _InvoiceV3_initFromApiPrediction = function _InvoiceV3_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.totalAmount = this.totalIncl;
-    this.totalTax = new fields_1.Amount({
-        prediction: { value: undefined, confidence: 0.0 },
-        valueKey: "value",
-        pageId: pageId,
-    });
-    this.totalNet = 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.TextField({
-        prediction: apiPrediction.invoice_number,
-        pageId: pageId,
-    });
-    this.supplier = new fields_1.TextField({
-        prediction: apiPrediction.supplier,
-        pageId: pageId,
-    });
-    this.supplierAddress = new fields_1.TextField({
-        prediction: apiPrediction.supplier_address,
-        pageId: pageId,
-    });
-    this.customerName = new fields_1.TextField({
-        prediction: apiPrediction.customer,
-        pageId: pageId,
-    });
-    this.customerAddress = new fields_1.TextField({
-        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,
-    })));
-}, _InvoiceV3_checklist = function _InvoiceV3_checklist() {
+_InvoiceV3_instances = new WeakSet(), _InvoiceV3_checklist = function _InvoiceV3_checklist() {
     this.checklist = {
         taxesMatchTotalIncl: (0, checks_1.taxesMatchTotalIncl)(this),
         taxesMatchTotalExcl: (0, checks_1.taxesMatchTotalExcl)(this),

package/src/documents/invoice/invoiceV4.d.ts

@@ -1,5 +1,5 @@
 import { Document, DocumentConstructorProps } from "../document";
-import { ClassificationField, TaxField, PaymentDetails, Locale, Amount, TextField, DateField, CompanyRegistration } from "../../fields";
+import { ClassificationField, Taxes, PaymentDetails, Locale, Amount, TextField, DateField, CompanyRegistration } from "../../fields";
 import { InvoiceLineItem } from "./invoiceLineItem";
 /** Invoice V4 */
 export declare class InvoiceV4 extends Document {
@@ -37,7 +37,7 @@ export declare class InvoiceV4 extends Document {
     /** The company registration information for the customer. */
     customerCompanyRegistrations: CompanyRegistration[];
     /** The list of the taxes. */
-    taxes: TaxField[];
+    taxes: Taxes;
     /** Line items details. */
     lineItems: InvoiceLineItem[];
     constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);

package/src/documents/invoice/invoiceV4.js

@@ -31,8 +31,6 @@ class InvoiceV4 extends document_1.Document {
         this.supplierCompanyRegistrations = [];
         /** The company registration information for the customer. */
         this.customerCompanyRegistrations = [];
-        /** The list of the taxes. */
-        this.taxes = [];
         /** Line items details. */
         this.lineItems = [];
         this.locale = new fields_1.Locale({
@@ -41,7 +39,6 @@ class InvoiceV4 extends document_1.Document {
         });
         this.documentType = new fields_1.ClassificationField({
             prediction: prediction.document_type,
-            valueKey: "value",
         });
         this.referenceNumbers = prediction.reference_numbers.map(function (prediction) {
             return new fields_1.TextField({
@@ -51,30 +48,21 @@ class InvoiceV4 extends document_1.Document {
         });
         this.totalAmount = new fields_1.Amount({
             prediction: prediction.total_amount,
-            valueKey: "value",
             pageId: pageId,
         });
         this.totalTax = new fields_1.Amount({
             prediction: { value: undefined, confidence: 0.0 },
-            valueKey: "value",
             pageId: pageId,
         });
         this.totalNet = new fields_1.Amount({
             prediction: prediction.total_net,
-            valueKey: "value",
             pageId: pageId,
         });
         this.date = new fields_1.DateField({
             prediction: prediction.date,
             pageId,
         });
-        prediction.taxes.map((prediction) => this.taxes.push(new fields_1.TaxField({
-            prediction: prediction,
-            pageId: pageId,
-            valueKey: "value",
-            rateKey: "rate",
-            codeKey: "code",
-        })));
+        this.taxes = new fields_1.Taxes().init(prediction["taxes"], pageId);
         this.supplierCompanyRegistrations =
             prediction.supplier_company_registrations.map(function (prediction) {
                 return new fields_1.CompanyRegistration({
@@ -121,7 +109,6 @@ class InvoiceV4 extends document_1.Document {
         __classPrivateFieldGet(this, _InvoiceV4_instances, "m", _InvoiceV4_reconstruct).call(this);
     }
     toString() {
-        const taxes = this.taxes.map((item) => item.toString()).join("\n       ");
         const referenceNumbers = this.referenceNumbers
             .map((item) => item.toString())
             .join(", ");
@@ -140,26 +127,26 @@ class InvoiceV4 extends document_1.Document {
                 "\n  Code           | QTY    | Price   | Amount   | Tax (Rate)       | Description\n  ";
             lineItems += this.lineItems.map((item) => item.toString()).join("\n  ");
         }
-        const outStr = `----- Invoice V4 -----
-Filename: ${this.filename}
-Locale: ${this.locale}
-Invoice number: ${this.invoiceNumber}
-Reference numbers: ${referenceNumbers}
-Invoice date: ${this.date}
-Invoice due date: ${this.dueDate}
-Supplier name: ${this.supplierName}
-Supplier address: ${this.supplierAddress}
-Supplier company registrations: ${companyRegistration}
-Supplier payment details: ${paymentDetails}
-Customer name: ${this.customerName}
-Customer company registrations: ${customerCompanyRegistration}
-Customer address: ${this.customerAddress}
-Line Items: ${lineItems}
-Taxes: ${taxes}
-Total taxes: ${this.totalTax}
-Total amount excluding taxes: ${this.totalNet}
-Total amount including taxes: ${this.totalAmount}
-----------------------
+        const outStr = `Invoice V4 Prediction
+=====================
+:Filename: ${this.filename}
+:Locale: ${this.locale}
+:Invoice number: ${this.invoiceNumber}
+:Reference numbers: ${referenceNumbers}
+:Invoice date: ${this.date}
+:Invoice due date: ${this.dueDate}
+:Supplier name: ${this.supplierName}
+:Supplier address: ${this.supplierAddress}
+:Supplier company registrations: ${companyRegistration}
+:Supplier payment details: ${paymentDetails}
+:Customer name: ${this.customerName}
+:Customer company registrations: ${customerCompanyRegistration}
+:Customer address: ${this.customerAddress}
+:Line Items: ${lineItems}
+:Taxes: ${this.taxes}
+:Total tax: ${this.totalTax}
+:Total net: ${this.totalNet}
+:Total amount: ${this.totalAmount}
 `;
         return InvoiceV4.cleanOutString(outStr);
     }

package/src/documents/proofOfAddress/proofOfAddressV1.d.ts

@@ -2,7 +2,7 @@ import { Document, DocumentConstructorProps } from "../document";
 import { CompanyRegistration, DateField, Locale, TextField } from "../../fields";
 export declare class ProofOfAddressV1 extends Document {
     /** ISO date yyyy-mm-dd. Works both for European and US dates. */
-    issuanceDate: DateField;
+    date: DateField;
     /** All extrated ISO date yyyy-mm-dd. Works both for European and US dates. */
     dates: DateField[];
     /** Address of the document's issuer. */

package/src/documents/proofOfAddress/proofOfAddressV1.js

@@ -20,7 +20,7 @@ class ProofOfAddressV1 extends document_1.Document {
         this.locale = new fields_1.Locale({
             prediction: prediction.locale,
         });
-        this.issuanceDate = new fields_1.DateField({
+        this.date = new fields_1.DateField({
             prediction: prediction.date,
             pageId: pageId,
         });
@@ -68,7 +68,7 @@ Recipient Company Registrations: ${this.recipientCompanyRegistration
             .join(", ")}
 Recipient Address: ${this.recipientAddress}
 Dates: ${this.dates.map((rcr) => rcr.value).join("\n       ")}
-Date of Issue: ${this.issuanceDate}
+Date of Issue: ${this.date}
 ----------------------
 `;
         return ProofOfAddressV1.cleanOutString(outStr);

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

@@ -18,7 +18,7 @@ export declare class ReceiptV3 extends Document {
     totalTax: Amount;
     /** Total amount without tax of the purchase. */
     totalExcl: Amount;
-    /** List of different taxe. */
+    /** List of different taxes. */
     taxes: TaxField[];
     constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);
     toString(): string;

package/src/documents/receipt/receiptV3.js

@@ -4,7 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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_initFromApiPrediction, _ReceiptV3_checklist, _ReceiptV3_taxesMatchTotal, _ReceiptV3_reconstruct, _ReceiptV3_reconstructTotalExclFromTCCAndTaxes, _ReceiptV3_reconstructTotalTax;
+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");
@@ -19,73 +19,59 @@ class ReceiptV3 extends document_1.Document {
             fullText: fullText,
         });
         _ReceiptV3_instances.add(this);
-        /** List of different taxe. */
-        this.taxes = [];
         this.locale = new fields_1.Locale({
             prediction: prediction.locale,
         });
         this.totalTax = new fields_1.Amount({
             prediction: { value: undefined, confidence: 0 },
-            valueKey: "value",
             pageId: pageId,
         });
         this.totalExcl = new fields_1.Amount({
             prediction: { value: undefined, confidence: 0 },
-            valueKey: "value",
             pageId: pageId,
         });
-        __classPrivateFieldGet(this, _ReceiptV3_instances, "m", _ReceiptV3_initFromApiPrediction).call(this, prediction, 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 taxes = this.taxes.map((item) => item.toString()).join("\n       ");
-        const outStr = `-----Receipt data-----
-Filename: ${this.filename}
-Total amount including taxes: ${this.totalIncl}
-Total amount excluding taxes: ${this.totalExcl}
-Date: ${this.date}
-Category: ${this.category}
-Time: ${this.time}
-Merchant name: ${this.merchantName}
-Taxes: ${taxes}
-Total taxes: ${this.totalTax}
-Locale: ${this.locale}
-----------------------
+        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_initFromApiPrediction = function _ReceiptV3_initFromApiPrediction(apiPrediction, pageId) {
-    this.totalIncl = new fields_1.Amount({
-        prediction: apiPrediction.total_incl,
-        valueKey: "value",
-        pageId: pageId,
-    });
-    this.date = new fields_1.DateField({
-        prediction: apiPrediction.date,
-        pageId: pageId,
-    });
-    this.category = new fields_1.ClassificationField({
-        prediction: apiPrediction.category,
-    });
-    this.merchantName = new fields_1.TextField({
-        prediction: apiPrediction.supplier,
-        pageId: pageId,
-    });
-    this.time = new fields_1.TextField({
-        prediction: apiPrediction.time,
-        pageId: pageId,
-    });
-    apiPrediction.taxes.map((taxPrediction) => this.taxes.push(new fields_1.TaxField({
-        prediction: taxPrediction,
-        pageId: pageId,
-        valueKey: "value",
-        rateKey: "rate",
-        codeKey: "code",
-    })));
-}, _ReceiptV3_checklist = function _ReceiptV3_checklist() {
+_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

package/src/documents/receipt/receiptV4.js

@@ -12,29 +12,23 @@ class ReceiptV4 extends document_1.Document {
             extras: extras,
             fullText: fullText,
         });
-        /** List of taxes detected on the receipt. */
-        this.taxes = [];
         this.locale = new fields_1.Locale({
             prediction: prediction.locale,
         });
         this.totalTax = new fields_1.Amount({
             prediction: prediction.total_tax,
-            valueKey: "value",
             pageId: pageId,
         });
         this.totalAmount = new fields_1.Amount({
             prediction: prediction.total_amount,
-            valueKey: "value",
             pageId: pageId,
         });
         this.totalNet = new fields_1.Amount({
             prediction: prediction.total_net,
-            valueKey: "value",
             pageId: pageId,
         });
         this.tip = new fields_1.Amount({
             prediction: prediction.tip,
-            valueKey: "value",
             pageId: pageId,
         });
         this.date = new fields_1.DateField({
@@ -59,32 +53,24 @@ class ReceiptV4 extends document_1.Document {
             prediction: prediction.time,
             pageId: pageId,
         });
-        prediction.taxes.map((taxPrediction) => this.taxes.push(new fields_1.TaxField({
-            prediction: taxPrediction,
-            pageId: pageId,
-            valueKey: "value",
-            rateKey: "rate",
-            codeKey: "code",
-            baseKey: "base",
-        })));
+        this.taxes = new fields_1.Taxes().init(prediction["taxes"], pageId);
     }
     toString() {
-        const taxes = this.taxes.map((item) => item.toString()).join("\n       ");
-        const outStr = `----- Receipt V4 -----
-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: ${taxes}
-Total taxes: ${this.totalTax}
-Locale: ${this.locale}
-----------------------
+        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);
     }

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

@@ -0,0 +1,43 @@
+import { Document, DocumentConstructorProps } from "../document";
+import { Amount, ClassificationField, CompanyRegistration, DateField, Locale, TaxField, TextField } from "../../fields";
+import { ReceiptV5LineItem } from "./receiptV5LineItem";
+/**
+ * Document data for Receipt, API version 5.
+ */
+export declare class ReceiptV5 extends Document {
+    #private;
+    /** The locale identifier in BCP 47 (RFC 5646) format: ISO language code, '-', ISO country code. */
+    locale: Locale;
+    /** The receipt category among predefined classes. */
+    category: ClassificationField;
+    /** The receipt sub category among predefined classes for transport and food. */
+    subcategory: ClassificationField;
+    /** The receipt document type provides the information whether the document is an expense receipt or a credit card receipt. */
+    documentType: ClassificationField;
+    /** The date the purchase was made. */
+    date: DateField;
+    /** Time of purchase with 24 hours formatting (HH:MM). */
+    time: TextField;
+    /** The total amount paid including taxes, discounts, fees, tips, and gratuity. */
+    totalAmount: Amount;
+    /** The total amount excluding taxes. */
+    totalNet: Amount;
+    /** The total amount of taxes. */
+    totalTax: Amount;
+    /** The total amount of tip and gratuity. */
+    tip: Amount;
+    /** List of tax lines information including: Amount, tax rate, tax base amount and tax code. */
+    taxes: TaxField[];
+    /** The name of the supplier or merchant. */
+    supplierName: TextField;
+    /** List of supplier company registrations or identifiers. */
+    supplierCompanyRegistrations: CompanyRegistration[];
+    /** The address of the supplier or merchant returned as a single string. */
+    supplierAddress: TextField;
+    /** The Phone number of the supplier or merchant returned as a single string. */
+    supplierPhoneNumber: TextField;
+    /** Full extraction of lines, including: description, quantity, unit price and total. */
+    lineItems: ReceiptV5LineItem[];
+    constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);
+    toString(): string;
+}

package/src/documents/receipt/receiptV5.js

@@ -0,0 +1,135 @@
+"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 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 supplier company registrations or identifiers. */
+        this.supplierCompanyRegistrations = [];
+        /** Full extraction of lines, including: description, quantity, unit price and total. */
+        this.lineItems = [];
+        this.locale = new fields_1.Locale({
+            prediction: prediction["locale"],
+        });
+        this.category = new fields_1.ClassificationField({
+            prediction: prediction["category"],
+        });
+        this.subcategory = new fields_1.ClassificationField({
+            prediction: prediction["subcategory"],
+        });
+        this.documentType = new fields_1.ClassificationField({
+            prediction: prediction["document_type"],
+        });
+        this.date = new fields_1.DateField({
+            prediction: prediction["date"],
+            pageId: pageId,
+        });
+        this.time = new fields_1.TextField({
+            prediction: prediction["time"],
+            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,
+        });
+        this.tip = new fields_1.Amount({
+            prediction: prediction["tip"],
+            pageId: pageId,
+        });
+        this.taxes = new fields_1.Taxes().init(prediction["taxes"], pageId);
+        this.supplierName = new fields_1.TextField({
+            prediction: prediction["supplier_name"],
+            pageId: pageId,
+        });
+        prediction["supplier_company_registrations"].map((itemPrediction) => this.supplierCompanyRegistrations.push(new fields_1.CompanyRegistration({
+            prediction: itemPrediction,
+            pageId: pageId,
+        })));
+        this.supplierAddress = new fields_1.TextField({
+            prediction: prediction["supplier_address"],
+            pageId: pageId,
+        });
+        this.supplierPhoneNumber = new fields_1.TextField({
+            prediction: prediction["supplier_phone_number"],
+            pageId: pageId,
+        });
+        prediction["line_items"].map((itemPrediction) => this.lineItems.push(new receiptV5LineItem_1.ReceiptV5LineItem({
+            prediction: itemPrediction,
+            pageId: pageId,
+        })));
+    }
+    toString() {
+        const outStr = `Receipt V5 Prediction
+=====================
+:Filename: ${this.filename}
+:Expense Locale: ${this.locale}
+:Expense Category: ${this.category}
+:Expense Sub Category: ${this.subcategory}
+:Document Type: ${this.documentType}
+:Purchase Date: ${this.date}
+:Purchase Time: ${this.time}
+:Total Amount: ${this.totalAmount}
+:Total Excluding Taxes: ${this.totalNet}
+:Total Tax: ${this.totalTax}
+:Tip and Gratuity: ${this.tip}
+:Taxes: ${this.taxes}
+:Supplier Name: ${this.supplierName}
+:Supplier Company Registrations: ${this.supplierCompanyRegistrations.join(`\n ${" ".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) {
+        return "";
+    }
+    const lines = this.lineItems
+        .map((item) => `${item}`)
+        .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, "-")}`;
+    outStr +=
+        "\n  | Description                          | Quantity | Total Amount | 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/receipt/receiptV5LineItem.d.ts

@@ -0,0 +1,16 @@
+import { StringDict } from "../../fields";
+/**
+ * Full extraction of lines, including: description, quantity, unit price and total.
+ */
+export declare class ReceiptV5LineItem {
+    /** The item description. */
+    description: string | null;
+    /** The item quantity. */
+    quantity: number | null;
+    /** The item total amount. */
+    totalAmount: number | null;
+    /** The item unit price. */
+    unitPrice: number | null;
+    constructor({ prediction }: StringDict);
+    toString(): string;
+}

package/src/documents/receipt/receiptV5LineItem.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReceiptV5LineItem = void 0;
+const amount_1 = require("../../fields/amount");
+/**
+ * Full extraction of lines, including: description, quantity, unit price and total.
+ */
+class ReceiptV5LineItem {
+    constructor({ prediction }) {
+        this.description = prediction["description"];
+        this.quantity = +parseFloat(prediction["quantity"]).toFixed(3);
+        if (isNaN(this.quantity)) {
+            this.quantity = null;
+        }
+        this.totalAmount = +parseFloat(prediction["total_amount"]).toFixed(3);
+        if (isNaN(this.totalAmount)) {
+            this.totalAmount = null;
+        }
+        this.unitPrice = +parseFloat(prediction["unit_price"]).toFixed(3);
+        if (isNaN(this.unitPrice)) {
+            this.unitPrice = null;
+        }
+    }
+    toString() {
+        const description = this.description ?? "";
+        const quantity = this.quantity !== null ? (0, amount_1.floatToString)(this.quantity) : "";
+        const totalAmount = this.totalAmount !== null ? (0, amount_1.floatToString)(this.totalAmount) : "";
+        const unitPrice = this.unitPrice !== null ? (0, amount_1.floatToString)(this.unitPrice) : "";
+        return ("| " +
+            description.padEnd(36) +
+            " | " +
+            quantity.padEnd(8) +
+            " | " +
+            totalAmount.padEnd(12) +
+            " | " +
+            unitPrice.padEnd(10) +
+            " |");
+    }
+}
+exports.ReceiptV5LineItem = ReceiptV5LineItem;

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

@@ -23,7 +23,6 @@ class BankCheckV1 extends document_1.Document {
         });
         this.amount = new fields_1.Amount({
             prediction: prediction.amount,
-            valueKey: "value",
             pageId: pageId,
         });
         this.checkPosition = new fields_1.PositionField({

package/src/fields/amount.js

@@ -17,7 +17,7 @@ class Amount extends field_1.Field {
      * @param {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
      * @param {Integer} pageId - Page ID for multi-page document
      */
-    constructor({ prediction, valueKey = "amount", reconstructed = false, pageId = undefined, }) {
+    constructor({ prediction, valueKey = "value", reconstructed = false, pageId = undefined, }) {
         super({ prediction, valueKey, reconstructed, pageId });
         /** The value. */
         this.value = undefined;

package/src/fields/index.d.ts

@@ -1,5 +1,5 @@
 export { ClassificationField } from "./classification";
-export { TaxField } from "./tax";
+export { Taxes, TaxField } from "./tax";
 export { PaymentDetails } from "./paymentDetails";
 export { OrientationField } from "./orientation";
 export { Locale } from "./locale";

package/src/fields/index.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TextField = exports.PositionField = exports.CompanyRegistration = exports.FullText = exports.BaseField = exports.DateField = exports.Amount = exports.Locale = exports.OrientationField = exports.PaymentDetails = exports.TaxField = exports.ClassificationField = void 0;
+exports.TextField = exports.PositionField = exports.CompanyRegistration = exports.FullText = exports.BaseField = exports.DateField = exports.Amount = exports.Locale = exports.OrientationField = exports.PaymentDetails = exports.TaxField = exports.Taxes = exports.ClassificationField = void 0;
 var classification_1 = require("./classification");
 Object.defineProperty(exports, "ClassificationField", { enumerable: true, get: function () { return classification_1.ClassificationField; } });
 var tax_1 = require("./tax");
+Object.defineProperty(exports, "Taxes", { enumerable: true, get: function () { return tax_1.Taxes; } });
 Object.defineProperty(exports, "TaxField", { enumerable: true, get: function () { return tax_1.TaxField; } });
 var paymentDetails_1 = require("./paymentDetails");
 Object.defineProperty(exports, "PaymentDetails", { enumerable: true, get: function () { return paymentDetails_1.PaymentDetails; } });

package/src/fields/tax.d.ts

@@ -10,6 +10,7 @@ interface TaxConstructor {
     pageId?: number;
 }
 export declare class TaxField extends Field {
+    #private;
     /** The tax amount. */
     value?: number;
     /** The tax rate. */
@@ -30,6 +31,12 @@ export declare class TaxField extends Field {
      * @param {Integer} pageNumber - Page ID for multi-page document
      */
     constructor({ prediction, valueKey, rateKey, codeKey, baseKey, reconstructed, pageId, }: TaxConstructor);
+    toTableLine(): string;
+    toString(): string;
+}
+export declare class Taxes extends Array<TaxField> {
+    #private;
+    init(prediction: StringDict[], pageId: number | undefined): this;
     toString(): string;
 }
 export {};

package/src/fields/tax.js

@@ -1,6 +1,12 @@
 "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 _TaxField_instances, _TaxField_printableValues, _Taxes_instances, _Taxes_lineSeparator;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TaxField = void 0;
+exports.Taxes = exports.TaxField = void 0;
 const field_1 = require("./field");
 const amount_1 = require("./amount");
 class TaxField extends field_1.Field {
@@ -15,6 +21,7 @@ class TaxField extends field_1.Field {
      */
     constructor({ prediction, valueKey = "value", rateKey = "rate", codeKey = "code", baseKey = "base", reconstructed = false, pageId = undefined, }) {
         super({ prediction, valueKey, reconstructed, pageId });
+        _TaxField_instances.add(this);
         /** The tax amount. */
         this.value = undefined;
         /** The tax rate. */
@@ -39,21 +46,70 @@ class TaxField extends field_1.Field {
         if (isNaN(this.base))
             this.base = undefined;
     }
+    toTableLine() {
+        const printable = __classPrivateFieldGet(this, _TaxField_instances, "m", _TaxField_printableValues).call(this);
+        return ("| " +
+            printable.base.padEnd(13) +
+            " | " +
+            printable.code.padEnd(6) +
+            " | " +
+            printable.rate.padEnd(8) +
+            " | " +
+            printable.value.padEnd(13) +
+            " |");
+    }
     toString() {
-        let outStr = "";
-        if (this.value !== undefined) {
-            outStr += `${(0, amount_1.floatToString)(this.value)}`;
-        }
-        if (this.rate !== undefined) {
-            outStr += ` ${(0, amount_1.floatToString)(this.rate)}%`;
-        }
-        if (this.code !== undefined) {
-            outStr += ` ${this.code}`;
+        const printable = __classPrivateFieldGet(this, _TaxField_instances, "m", _TaxField_printableValues).call(this);
+        return ("Base: " +
+            printable.base +
+            ", Code: " +
+            printable.code +
+            ", Rate (%): " +
+            printable.rate +
+            ", Amount: " +
+            printable.value).trim();
+    }
+}
+exports.TaxField = TaxField;
+_TaxField_instances = new WeakSet(), _TaxField_printableValues = function _TaxField_printableValues() {
+    return {
+        code: this.code ?? "",
+        base: this.base !== undefined ? (0, amount_1.floatToString)(this.base) : "",
+        rate: this.rate !== undefined ? (0, amount_1.floatToString)(this.rate) : "",
+        value: this.value !== undefined ? (0, amount_1.floatToString)(this.value) : "",
+    };
+};
+class Taxes extends Array {
+    constructor() {
+        super(...arguments);
+        _Taxes_instances.add(this);
+    }
+    init(prediction, pageId) {
+        for (const entry of prediction) {
+            this.push(new TaxField({
+                prediction: entry,
+                pageId: pageId,
+            }));
         }
-        if (this.base !== undefined) {
-            outStr += ` ${(0, amount_1.floatToString)(this.base)}`;
+        return this;
+    }
+    toString() {
+        let outStr = `
+${__classPrivateFieldGet(this, _Taxes_instances, "m", _Taxes_lineSeparator).call(this, "-")}
+  | Base          | Code   | Rate (%) | Amount        |
+${__classPrivateFieldGet(this, _Taxes_instances, "m", _Taxes_lineSeparator).call(this, "=")}`;
+        for (const entry of this.entries()) {
+            outStr += `\n  ${entry[1].toTableLine()}\n${__classPrivateFieldGet(this, _Taxes_instances, "m", _Taxes_lineSeparator).call(this, "-")}`;
         }
-        return outStr.trim();
+        return outStr;
     }
 }
-exports.TaxField = TaxField;
+exports.Taxes = Taxes;
+_Taxes_instances = new WeakSet(), _Taxes_lineSeparator = function _Taxes_lineSeparator(char) {
+    let outStr = "  ";
+    outStr += `+${char.repeat(15)}`;
+    outStr += `+${char.repeat(8)}`;
+    outStr += `+${char.repeat(10)}`;
+    outStr += `+${char.repeat(15)}`;
+    return outStr + "+";
+};

package/src/index.d.ts

@@ -1,4 +1,4 @@
-export { CustomV1, Document, FinancialDocumentV0, FinancialDocumentV1, InvoiceV3, InvoiceV4, InvoiceSplitterV1, PassportV1, ReceiptV3, ReceiptV4, CropperV1, ShippingContainerV1, MindeeVisionV1, ProofOfAddressV1, fr, us, eu, } from "./documents";
+export { CustomV1, Document, FinancialDocumentV0, FinancialDocumentV1, InvoiceV3, InvoiceV4, InvoiceSplitterV1, PassportV1, ReceiptV3, ReceiptV4, ReceiptV5, CropperV1, ShippingContainerV1, MindeeVisionV1, ProofOfAddressV1, fr, us, eu, } from "./documents";
 export { Client, ClientOptions, CustomConfigParams, DocumentClient, PredictOptions, } from "./client";
 export { ResponseSig, Response, AsyncPredictResponse } from "./api";
 export { InputSource, PageOptionsOperation } from "./inputs";

package/src/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PageOptionsOperation = exports.InputSource = exports.AsyncPredictResponse = exports.Response = exports.DocumentClient = exports.Client = exports.eu = exports.us = exports.fr = exports.ProofOfAddressV1 = exports.MindeeVisionV1 = exports.ShippingContainerV1 = exports.CropperV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PassportV1 = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.InvoiceV3 = exports.FinancialDocumentV1 = exports.FinancialDocumentV0 = exports.Document = exports.CustomV1 = void 0;
+exports.PageOptionsOperation = exports.InputSource = exports.AsyncPredictResponse = exports.Response = exports.DocumentClient = exports.Client = exports.eu = exports.us = exports.fr = exports.ProofOfAddressV1 = exports.MindeeVisionV1 = exports.ShippingContainerV1 = exports.CropperV1 = exports.ReceiptV5 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PassportV1 = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.InvoiceV3 = exports.FinancialDocumentV1 = exports.FinancialDocumentV0 = exports.Document = exports.CustomV1 = void 0;
 var documents_1 = require("./documents");
 Object.defineProperty(exports, "CustomV1", { enumerable: true, get: function () { return documents_1.CustomV1; } });
 Object.defineProperty(exports, "Document", { enumerable: true, get: function () { return documents_1.Document; } });
@@ -12,6 +12,7 @@ Object.defineProperty(exports, "InvoiceSplitterV1", { enumerable: true, get: fun
 Object.defineProperty(exports, "PassportV1", { enumerable: true, get: function () { return documents_1.PassportV1; } });
 Object.defineProperty(exports, "ReceiptV3", { enumerable: true, get: function () { return documents_1.ReceiptV3; } });
 Object.defineProperty(exports, "ReceiptV4", { enumerable: true, get: function () { return documents_1.ReceiptV4; } });
+Object.defineProperty(exports, "ReceiptV5", { enumerable: true, get: function () { return documents_1.ReceiptV5; } });
 Object.defineProperty(exports, "CropperV1", { enumerable: true, get: function () { return documents_1.CropperV1; } });
 Object.defineProperty(exports, "ShippingContainerV1", { enumerable: true, get: function () { return documents_1.ShippingContainerV1; } });
 Object.defineProperty(exports, "MindeeVisionV1", { enumerable: true, get: function () { return documents_1.MindeeVisionV1; } });