mindee 3.8.0 → 3.10.0

package/src/documents/fr/bankAccountDetails/bankAccountDetailsV2.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BankAccountDetailsV2 = void 0;
+const document_1 = require("../../document");
+const fields_1 = require("../../../fields");
+const bankAccountDetailsV2Bban_1 = require("./bankAccountDetailsV2Bban");
+/**
+ * Document data for Bank Account Details, API version 2.
+ */
+class BankAccountDetailsV2 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.accountHoldersNames = new fields_1.TextField({
+            prediction: prediction["account_holders_names"],
+            pageId: pageId,
+        });
+        this.bban = new bankAccountDetailsV2Bban_1.BankAccountDetailsV2Bban({
+            prediction: prediction["bban"],
+            pageId: pageId,
+        });
+        this.iban = new fields_1.TextField({
+            prediction: prediction["iban"],
+            pageId: pageId,
+        });
+        this.swiftCode = new fields_1.TextField({
+            prediction: prediction["swift_code"],
+            pageId: pageId,
+        });
+    }
+    toString() {
+        const outStr = `FR Bank Account Details V2 Prediction
+=====================================
+:Filename: ${this.filename}
+:Account Holder's Names: ${this.accountHoldersNames}
+:Basic Bank Account Number: ${this.bban.toFieldList()}
+:IBAN: ${this.iban}
+:SWIFT Code: ${this.swiftCode}
+`;
+        return BankAccountDetailsV2.cleanOutString(outStr);
+    }
+}
+exports.BankAccountDetailsV2 = BankAccountDetailsV2;

package/src/documents/fr/bankAccountDetails/bankAccountDetailsV2Bban.d.ts

@@ -0,0 +1,34 @@
+import { StringDict } from "../../../fields";
+import { Polygon } from "../../../geometry";
+/**
+ * Full extraction of BBAN, including: branch code, bank code, account and key.
+ */
+export declare class BankAccountDetailsV2Bban {
+    #private;
+    /** The BBAN bank code outputted as a string. */
+    bbanBankCode: string | null;
+    /** The BBAN branch code outputted as a string. */
+    bbanBranchCode: string | null;
+    /** The BBAN key outputted as a string. */
+    bbanKey: string | null;
+    /** The BBAN Account number outputted as a string. */
+    bbanNumber: string | null;
+    /** Confidence score */
+    confidence: number;
+    /** The document page on which the information was found. */
+    pageId: number;
+    /**
+     * Contains the relative vertices coordinates (points) of a polygon containing
+     * the field in the document.
+     */
+    polygon: Polygon;
+    constructor({ prediction }: StringDict);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+    /**
+     * Output in a format suitable for inclusion in a field list.
+     */
+    toFieldList(): string;
+}

package/src/documents/fr/bankAccountDetails/bankAccountDetailsV2Bban.js

@@ -0,0 +1,67 @@
+"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 _BankAccountDetailsV2Bban_instances, _BankAccountDetailsV2Bban_printableValues;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BankAccountDetailsV2Bban = void 0;
+/**
+ * Full extraction of BBAN, including: branch code, bank code, account and key.
+ */
+class BankAccountDetailsV2Bban {
+    constructor({ prediction }) {
+        _BankAccountDetailsV2Bban_instances.add(this);
+        /** Confidence score */
+        this.confidence = 0.0;
+        /**
+         * Contains the relative vertices coordinates (points) of a polygon containing
+         * the field in the document.
+         */
+        this.polygon = [];
+        this.bbanBankCode = prediction["bban_bank_code"];
+        this.bbanBranchCode = prediction["bban_branch_code"];
+        this.bbanKey = prediction["bban_key"];
+        this.bbanNumber = prediction["bban_number"];
+        this.pageId = prediction["page_id"];
+        this.confidence = prediction["confidence"] ? prediction.confidence : 0.0;
+        if (prediction["polygon"]) {
+            this.polygon = prediction.polygon;
+        }
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        const printable = __classPrivateFieldGet(this, _BankAccountDetailsV2Bban_instances, "m", _BankAccountDetailsV2Bban_printableValues).call(this);
+        return ("Bank Code: " +
+            printable.bbanBankCode +
+            ", Branch Code: " +
+            printable.bbanBranchCode +
+            ", Key: " +
+            printable.bbanKey +
+            ", Account Number: " +
+            printable.bbanNumber);
+    }
+    /**
+     * Output in a format suitable for inclusion in a field list.
+     */
+    toFieldList() {
+        const printable = __classPrivateFieldGet(this, _BankAccountDetailsV2Bban_instances, "m", _BankAccountDetailsV2Bban_printableValues).call(this);
+        return `
+  :Bank Code: ${printable.bbanBankCode}
+  :Branch Code: ${printable.bbanBranchCode}
+  :Key: ${printable.bbanKey}
+  :Account Number: ${printable.bbanNumber}`.trimEnd();
+    }
+}
+exports.BankAccountDetailsV2Bban = BankAccountDetailsV2Bban;
+_BankAccountDetailsV2Bban_instances = new WeakSet(), _BankAccountDetailsV2Bban_printableValues = function _BankAccountDetailsV2Bban_printableValues() {
+    return {
+        bbanBankCode: this.bbanBankCode ?? "",
+        bbanBranchCode: this.bbanBranchCode ?? "",
+        bbanKey: this.bbanKey ?? "",
+        bbanNumber: this.bbanNumber ?? "",
+    };
+};

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

@@ -1,3 +1,4 @@
 export { IdCardV1 } from "./idCard/idCardV1";
 export { BankAccountDetailsV1 } from "./bankAccountDetails/bankAccountDetailsV1";
+export { BankAccountDetailsV2 } from "./bankAccountDetails/bankAccountDetailsV2";
 export { CarteVitaleV1 } from "./carteVitale/carteVitaleV1";

package/src/documents/fr/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CarteVitaleV1 = exports.BankAccountDetailsV1 = exports.IdCardV1 = void 0;
+exports.CarteVitaleV1 = exports.BankAccountDetailsV2 = exports.BankAccountDetailsV1 = exports.IdCardV1 = void 0;
 var idCardV1_1 = require("./idCard/idCardV1");
 Object.defineProperty(exports, "IdCardV1", { enumerable: true, get: function () { return idCardV1_1.IdCardV1; } });
 var bankAccountDetailsV1_1 = require("./bankAccountDetails/bankAccountDetailsV1");
 Object.defineProperty(exports, "BankAccountDetailsV1", { enumerable: true, get: function () { return bankAccountDetailsV1_1.BankAccountDetailsV1; } });
+var bankAccountDetailsV2_1 = require("./bankAccountDetails/bankAccountDetailsV2");
+Object.defineProperty(exports, "BankAccountDetailsV2", { enumerable: true, get: function () { return bankAccountDetailsV2_1.BankAccountDetailsV2; } });
 var carteVitaleV1_1 = require("./carteVitale/carteVitaleV1");
 Object.defineProperty(exports, "CarteVitaleV1", { enumerable: true, get: function () { return carteVitaleV1_1.CarteVitaleV1; } });

package/src/documents/index.d.ts

@@ -12,7 +12,6 @@ export { getLineItems } from "./custom/lineitems";
 export { CropperV1 } from "./cropper/cropperV1";
 export { MindeeVisionV1 } from "./mindeeVision/mindeeVisionV1";
 export { ProofOfAddressV1 } from "./proofOfAddress/proofOfAddressV1";
-export { ShippingContainerV1 } from "./shippingContainer/shippingContainerV1";
 export { Document, DocumentConstructorProps, DocumentSig } from "./document";
 export * as fr from "./fr";
 export * as us from "./us";

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.ReceiptV5 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PageGroup = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.InvoiceV3 = void 0;
+exports.eu = exports.us = exports.fr = exports.Document = 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");
@@ -53,8 +53,6 @@ var mindeeVisionV1_1 = require("./mindeeVision/mindeeVisionV1");
 Object.defineProperty(exports, "MindeeVisionV1", { enumerable: true, get: function () { return mindeeVisionV1_1.MindeeVisionV1; } });
 var proofOfAddressV1_1 = require("./proofOfAddress/proofOfAddressV1");
 Object.defineProperty(exports, "ProofOfAddressV1", { enumerable: true, get: function () { return proofOfAddressV1_1.ProofOfAddressV1; } });
-var shippingContainerV1_1 = require("./shippingContainer/shippingContainerV1");
-Object.defineProperty(exports, "ShippingContainerV1", { enumerable: true, get: function () { return shippingContainerV1_1.ShippingContainerV1; } });
 var document_1 = require("./document");
 Object.defineProperty(exports, "Document", { enumerable: true, get: function () { return document_1.Document; } });
 exports.fr = __importStar(require("./fr"));

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

@@ -2,42 +2,42 @@ 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.
+ * Document data for Expense 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. */
+    /** The purchase 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). */
+    /** One of: 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'. */
+    documentType: ClassificationField;
+    /** List of line item details. */
+    lineItems: ReceiptV5LineItem[];
+    /** The locale detected on the document. */
+    locale: Locale;
+    /** The purchase subcategory among predefined classes for transport and food. */
+    subcategory: ClassificationField;
+    /** The address of the supplier or merchant. */
+    supplierAddress: TextField;
+    /** List of company registrations associated to the supplier. */
+    supplierCompanyRegistrations: CompanyRegistration[];
+    /** The name of the supplier or merchant. */
+    supplierName: TextField;
+    /** The phone number of the supplier or merchant. */
+    supplierPhoneNumber: TextField;
+    /** List of tax lines information. */
+    taxes: TaxField[];
+    /** The time the purchase was made. */
     time: TextField;
-    /** The total amount paid including taxes, discounts, fees, tips, and gratuity. */
+    /** The total amount of tip and gratuity. */
+    tip: Amount;
+    /** The total amount paid: includes taxes, discounts, fees, tips, and gratuity. */
     totalAmount: Amount;
-    /** The total amount excluding taxes. */
+    /** The net amount paid: does not include taxes, fees, and discounts. */
     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

@@ -11,7 +11,7 @@ const document_1 = require("../document");
 const fields_1 = require("../../fields");
 const receiptV5LineItem_1 = require("./receiptV5LineItem");
 /**
- * Document data for Receipt, API version 5.
+ * 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, }) {
@@ -23,85 +23,85 @@ class ReceiptV5 extends document_1.Document {
             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. */
+        /** List of line item details. */
         this.lineItems = [];
-        this.locale = new fields_1.Locale({
-            prediction: prediction["locale"],
-        });
+        /** List of company registrations associated to the supplier. */
+        this.supplierCompanyRegistrations = [];
         this.category = new fields_1.ClassificationField({
             prediction: prediction["category"],
         });
-        this.subcategory = new fields_1.ClassificationField({
-            prediction: prediction["subcategory"],
+        this.date = new fields_1.DateField({
+            prediction: prediction["date"],
+            pageId: pageId,
         });
         this.documentType = new fields_1.ClassificationField({
             prediction: prediction["document_type"],
         });
-        this.date = new fields_1.DateField({
-            prediction: prediction["date"],
+        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.time = new fields_1.TextField({
-            prediction: prediction["time"],
+        this.subcategory = new fields_1.ClassificationField({
+            prediction: prediction["subcategory"],
+        });
+        this.supplierAddress = new fields_1.TextField({
+            prediction: prediction["supplier_address"],
             pageId: pageId,
         });
-        this.totalAmount = new fields_1.Amount({
-            prediction: prediction["total_amount"],
+        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.totalNet = new fields_1.Amount({
-            prediction: prediction["total_net"],
+        this.supplierPhoneNumber = new fields_1.TextField({
+            prediction: prediction["supplier_phone_number"],
             pageId: pageId,
         });
-        this.totalTax = new fields_1.Amount({
-            prediction: prediction["total_tax"],
+        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.taxes = new fields_1.Taxes().init(prediction["taxes"], pageId);
-        this.supplierName = new fields_1.TextField({
-            prediction: prediction["supplier_name"],
+        this.totalAmount = new fields_1.Amount({
+            prediction: prediction["total_amount"],
             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"],
+        this.totalNet = new fields_1.Amount({
+            prediction: prediction["total_net"],
             pageId: pageId,
         });
-        this.supplierPhoneNumber = new fields_1.TextField({
-            prediction: prediction["supplier_phone_number"],
+        this.totalTax = new fields_1.Amount({
+            prediction: prediction["total_tax"],
             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}
+: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 Excluding Taxes: ${this.totalNet}
+: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(`\n ${" ".repeat(32)}`)}
+: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)}
@@ -118,17 +118,19 @@ _ReceiptV5_instances = new WeakSet(), _ReceiptV5_lineItemsSeparator = function _
     outStr += `+${char.repeat(12)}`;
     return outStr + "+";
 }, _ReceiptV5_lineItemsToString = function _ReceiptV5_lineItemsToString() {
-    if (!this.lineItems) {
+    if (!this.lineItems || this.lineItems.length === 0) {
         return "";
     }
     const lines = this.lineItems
-        .map((item) => `${item}`)
+        .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, "-")}`;
-    outStr +=
-        "\n  | Description                          | Quantity | Total Amount | Unit Price |";
-    outStr += `\n${__classPrivateFieldGet(this, _ReceiptV5_instances, "m", _ReceiptV5_lineItemsSeparator).call(this, "=")}`;
+    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/receipt/receiptV5LineItem.d.ts

@@ -1,8 +1,10 @@
 import { StringDict } from "../../fields";
+import { Polygon } from "../../geometry";
 /**
- * Full extraction of lines, including: description, quantity, unit price and total.
+ * List of line item details.
  */
 export declare class ReceiptV5LineItem {
+    #private;
     /** The item description. */
     description: string | null;
     /** The item quantity. */
@@ -11,6 +13,22 @@ export declare class ReceiptV5LineItem {
     totalAmount: number | null;
     /** The item unit price. */
     unitPrice: number | null;
+    /** Confidence score */
+    confidence: number;
+    /** The document page on which the information was found. */
+    pageId: number;
+    /**
+     * Contains the relative vertices coordinates (points) of a polygon containing
+     * the field in the document.
+     */
+    polygon: Polygon;
     constructor({ prediction }: StringDict);
+    /**
+     * Default string representation.
+     */
     toString(): string;
+    /**
+     * Output in a format suitable for inclusion in an rST table.
+     */
+    toTableLine(): string;
 }

package/src/documents/receipt/receiptV5LineItem.js

@@ -1,12 +1,26 @@
 "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 _ReceiptV5LineItem_instances, _ReceiptV5LineItem_printableValues;
 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.
+ * List of line item details.
  */
 class ReceiptV5LineItem {
     constructor({ prediction }) {
+        _ReceiptV5LineItem_instances.add(this);
+        /** Confidence score */
+        this.confidence = 0.0;
+        /**
+         * Contains the relative vertices coordinates (points) of a polygon containing
+         * the field in the document.
+         */
+        this.polygon = [];
         this.description = prediction["description"];
         this.quantity = +parseFloat(prediction["quantity"]).toFixed(3);
         if (isNaN(this.quantity)) {
@@ -20,21 +34,48 @@ class ReceiptV5LineItem {
         if (isNaN(this.unitPrice)) {
             this.unitPrice = null;
         }
+        this.pageId = prediction["page_id"];
+        this.confidence = prediction["confidence"] ? prediction.confidence : 0.0;
+        if (prediction["polygon"]) {
+            this.polygon = prediction.polygon;
+        }
     }
+    /**
+     * Default string representation.
+     */
     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) : "";
+        const printable = __classPrivateFieldGet(this, _ReceiptV5LineItem_instances, "m", _ReceiptV5LineItem_printableValues).call(this);
+        return ("Description: " +
+            printable.description +
+            "Quantity: " +
+            printable.quantity +
+            "Total Amount: " +
+            printable.totalAmount +
+            "Unit Price: " +
+            printable.unitPrice).trim();
+    }
+    /**
+     * Output in a format suitable for inclusion in an rST table.
+     */
+    toTableLine() {
+        const printable = __classPrivateFieldGet(this, _ReceiptV5LineItem_instances, "m", _ReceiptV5LineItem_printableValues).call(this);
         return ("| " +
-            description.padEnd(36) +
+            printable.description.padEnd(36) +
             " | " +
-            quantity.padEnd(8) +
+            printable.quantity.padEnd(8) +
             " | " +
-            totalAmount.padEnd(12) +
+            printable.totalAmount.padEnd(12) +
             " | " +
-            unitPrice.padEnd(10) +
+            printable.unitPrice.padEnd(10) +
             " |");
     }
 }
 exports.ReceiptV5LineItem = ReceiptV5LineItem;
+_ReceiptV5LineItem_instances = new WeakSet(), _ReceiptV5LineItem_printableValues = function _ReceiptV5LineItem_printableValues() {
+    return {
+        description: this.description ?? "",
+        quantity: this.quantity !== null ? (0, amount_1.floatToString)(this.quantity) : "",
+        totalAmount: this.totalAmount !== null ? (0, amount_1.floatToString)(this.totalAmount) : "",
+        unitPrice: this.unitPrice !== null ? (0, amount_1.floatToString)(this.unitPrice) : "",
+    };
+};

package/src/fields/amount.d.ts

@@ -1,5 +1,8 @@
 import { Field, FieldConstructor } from "./field";
 export declare function floatToString(value: number): string;
+/**
+ * A field containing an amount value.
+ */
 export declare class Amount extends Field {
     /** The value. */
     value?: number;

package/src/fields/amount.js

@@ -10,6 +10,9 @@ function floatToString(value) {
     });
 }
 exports.floatToString = floatToString;
+/**
+ * A field containing an amount value.
+ */
 class Amount extends field_1.Field {
     /**
      * @param {Object} prediction - Prediction object from HTTP response

package/src/fields/base.d.ts

@@ -6,6 +6,9 @@ export interface BaseFieldConstructor {
     valueKey?: string;
     reconstructed?: boolean;
 }
+/**
+ * Base class for most fields.
+ */
 export declare class BaseField {
     /** The value. */
     value?: string | number;

package/src/fields/base.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseField = void 0;
+/**
+ * Base class for most fields.
+ */
 class BaseField {
     /**
      * @param {Object} prediction - Prediction object from HTTP response

package/src/fields/classification.d.ts

@@ -1,4 +1,7 @@
 import { BaseField, BaseFieldConstructor } from "./base";
+/**
+ * Represents a classifier value.
+ */
 export declare class ClassificationField extends BaseField {
     /** The confidence score of the prediction. */
     confidence: number;

package/src/fields/classification.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClassificationField = void 0;
 const base_1 = require("./base");
+/**
+ * Represents a classifier value.
+ */
 class ClassificationField extends base_1.BaseField {
     constructor({ prediction, valueKey = "value", reconstructed = false, }) {
         super({ prediction, valueKey, reconstructed });

package/src/fields/companyRegistration.d.ts

@@ -1,4 +1,7 @@
 import { Field, FieldConstructor } from "./field";
+/**
+ * A company registration item.
+ */
 export declare class CompanyRegistration extends Field {
     /** Registration identifier. */
     value?: string;

package/src/fields/companyRegistration.js

@@ -2,6 +2,9 @@
 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 });

package/src/fields/date.d.ts

@@ -1,4 +1,7 @@
 import { Field, FieldConstructor } from "./field";
+/**
+ * A field containing a date value.
+ */
 export declare class DateField extends Field {
     /** Date string in ISO format. */
     value?: string;

package/src/fields/date.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DateField = void 0;
 const field_1 = require("./field");
+/**
+ * A field containing a date value.
+ */
 class DateField extends field_1.Field {
     /**
      * @param {Object} prediction - Prediction object from HTTP response