mindee 3.10.2 → 4.0.1

package/src/{documents/fr/bankAccountDetails/bankAccountDetailsV2.d.ts → product/fr/bankAccountDetails/bankAccountDetailsV2Document.d.ts}

@@ -1,18 +1,18 @@
-import { Document, DocumentConstructorProps } from "../../document";
-import { TextField } from "../../../fields";
+import { Prediction, StringDict } from "../../../parsing/common";
 import { BankAccountDetailsV2Bban } from "./bankAccountDetailsV2Bban";
+import { StringField } from "../../../parsing/standard";
 /**
  * Document data for Bank Account Details, API version 2.
  */
-export declare class BankAccountDetailsV2 extends Document {
+export declare class BankAccountDetailsV2Document implements Prediction {
     /** Full extraction of the account holders names. */
-    accountHoldersNames: TextField;
+    accountHoldersNames: StringField;
     /** Full extraction of BBAN, including: branch code, bank code, account and key. */
     bban: BankAccountDetailsV2Bban;
     /** Full extraction of the IBAN number. */
-    iban: TextField;
+    iban: StringField;
     /** Full extraction of the SWIFT code. */
-    swiftCode: TextField;
-    constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);
+    swiftCode: StringField;
+    constructor(rawPrediction: StringDict, pageId?: number);
     toString(): string;
 }

package/src/product/fr/bankAccountDetails/bankAccountDetailsV2Document.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BankAccountDetailsV2Document = void 0;
+const common_1 = require("../../../parsing/common");
+const bankAccountDetailsV2Bban_1 = require("./bankAccountDetailsV2Bban");
+const standard_1 = require("../../../parsing/standard");
+/**
+ * Document data for Bank Account Details, API version 2.
+ */
+class BankAccountDetailsV2Document {
+    constructor(rawPrediction, pageId) {
+        this.accountHoldersNames = new standard_1.StringField({
+            prediction: rawPrediction["account_holders_names"],
+            pageId: pageId,
+        });
+        this.bban = new bankAccountDetailsV2Bban_1.BankAccountDetailsV2Bban({
+            prediction: rawPrediction["bban"],
+            pageId: pageId,
+        });
+        this.iban = new standard_1.StringField({
+            prediction: rawPrediction["iban"],
+            pageId: pageId,
+        });
+        this.swiftCode = new standard_1.StringField({
+            prediction: rawPrediction["swift_code"],
+            pageId: pageId,
+        });
+    }
+    toString() {
+        const outStr = `:Account Holder's Names: ${this.accountHoldersNames}
+:Basic Bank Account Number: ${this.bban.toFieldList()}
+:IBAN: ${this.iban}
+:SWIFT Code: ${this.swiftCode}`.trimEnd();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.BankAccountDetailsV2Document = BankAccountDetailsV2Document;

package/src/product/fr/carteVitale/carteVitaleV1.d.ts

@@ -0,0 +1,9 @@
+import { Inference, StringDict, Page } from "../../../parsing/common";
+import { CarteVitaleV1Document } from "./carteVitaleV1Document";
+export declare class CarteVitaleV1 extends Inference {
+    endpointName: string;
+    endpointVersion: string;
+    prediction: CarteVitaleV1Document;
+    pages: Page<CarteVitaleV1Document>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/product/fr/carteVitale/carteVitaleV1.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CarteVitaleV1 = void 0;
+const common_1 = require("../../../parsing/common");
+const carteVitaleV1Document_1 = require("./carteVitaleV1Document");
+class CarteVitaleV1 extends common_1.Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        this.endpointName = "carte_vitale";
+        this.endpointVersion = "1";
+        this.pages = [];
+        this.prediction = new carteVitaleV1Document_1.CarteVitaleV1Document(rawPrediction["prediction"]);
+        this.pages = rawPrediction["pages"].map((page) => new common_1.Page(carteVitaleV1Document_1.CarteVitaleV1Document, page, page["id"], page["orientation"]));
+    }
+}
+exports.CarteVitaleV1 = CarteVitaleV1;

package/src/product/fr/carteVitale/carteVitaleV1Document.d.ts

@@ -0,0 +1,17 @@
+import { Prediction, StringDict } from "../../../parsing/common";
+import { DateField, StringField } from "../../../parsing/standard";
+/**
+ * Document data for Carte Vitale, API version 1.
+ */
+export declare class CarteVitaleV1Document implements Prediction {
+    /** The given name(s) of the card holder. */
+    givenNames: StringField[];
+    /** The date the card was issued. */
+    issuanceDate: DateField;
+    /** The Social Security Number (Numéro de Sécurité Sociale) of the card holder */
+    socialSecurity: StringField;
+    /** The surname of the card holder. */
+    surname: StringField;
+    constructor(rawPrediction: StringDict, pageId?: number);
+    toString(): string;
+}

package/src/product/fr/carteVitale/carteVitaleV1Document.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CarteVitaleV1Document = void 0;
+const common_1 = require("../../../parsing/common");
+const standard_1 = require("../../../parsing/standard");
+/**
+ * Document data for Carte Vitale, API version 1.
+ */
+class CarteVitaleV1Document {
+    constructor(rawPrediction, pageId) {
+        /** The given name(s) of the card holder. */
+        this.givenNames = [];
+        rawPrediction["given_names"] &&
+            rawPrediction["given_names"].map((itemPrediction) => this.givenNames.push(new standard_1.StringField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+        this.issuanceDate = new standard_1.DateField({
+            prediction: rawPrediction["issuance_date"],
+            pageId: pageId,
+        });
+        this.socialSecurity = new standard_1.StringField({
+            prediction: rawPrediction["social_security"],
+            pageId: pageId,
+        });
+        this.surname = new standard_1.StringField({
+            prediction: rawPrediction["surname"],
+            pageId: pageId,
+        });
+    }
+    toString() {
+        const givenNames = this.givenNames.join("\n              ");
+        const outStr = `:Given Name(s): ${givenNames}
+:Surname: ${this.surname}
+:Social Security Number: ${this.socialSecurity}
+:Issuance Date: ${this.issuanceDate}`.trimEnd();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.CarteVitaleV1Document = CarteVitaleV1Document;

package/src/product/fr/idCard/idCardV1.d.ts

@@ -0,0 +1,10 @@
+import { Inference, StringDict, Page } from "../../../parsing/common";
+import { IdCardV1Document } from "./idCardV1Document";
+import { IdCardV1Page } from "./idCardV1Page";
+export declare class IdCardV1 extends Inference {
+    endpointName: string;
+    endpointVersion: string;
+    prediction: IdCardV1Document;
+    pages: Page<IdCardV1Page>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/product/fr/idCard/idCardV1.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdCardV1 = void 0;
+const common_1 = require("../../../parsing/common");
+const idCardV1Document_1 = require("./idCardV1Document");
+const idCardV1Page_1 = require("./idCardV1Page");
+class IdCardV1 extends common_1.Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        this.endpointName = "idcard_fr";
+        this.endpointVersion = "1";
+        this.pages = [];
+        this.prediction = new idCardV1Document_1.IdCardV1Document(rawPrediction["prediction"]);
+        this.pages = rawPrediction["pages"].map((page) => new common_1.Page(idCardV1Page_1.IdCardV1Page, page, page["id"], page["orientation"]));
+    }
+}
+exports.IdCardV1 = IdCardV1;

package/src/product/fr/idCard/idCardV1Document.d.ts

@@ -0,0 +1,29 @@
+import { Prediction, StringDict } from "../../../parsing/common";
+import { DateField, StringField } from "../../../parsing/standard";
+/**
+ * Document data for Carte Nationale d'Identité, API version 1.
+ */
+export declare class IdCardV1Document implements Prediction {
+    /** The name of the issuing authority. */
+    authority: StringField;
+    /** The date of birth of the card holder. */
+    birthDate: DateField;
+    /** The place of birth of the card holder. */
+    birthPlace: StringField;
+    /** The expiry date of the identification card. */
+    expiryDate: DateField;
+    /** The gender of the card holder. */
+    gender: StringField;
+    /** The given name(s) of the card holder. */
+    givenNames: StringField[];
+    /** The identification card number. */
+    idNumber: StringField;
+    /** Machine Readable Zone, first line */
+    mrz1: StringField;
+    /** Machine Readable Zone, second line */
+    mrz2: StringField;
+    /** The surname of the card holder. */
+    surname: StringField;
+    constructor(rawPrediction: StringDict, pageId?: number);
+    toString(): string;
+}

package/src/product/fr/idCard/idCardV1Document.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdCardV1Document = void 0;
+const common_1 = require("../../../parsing/common");
+const standard_1 = require("../../../parsing/standard");
+/**
+ * Document data for Carte Nationale d'Identité, API version 1.
+ */
+class IdCardV1Document {
+    constructor(rawPrediction, pageId) {
+        /** The given name(s) of the card holder. */
+        this.givenNames = [];
+        this.authority = new standard_1.StringField({
+            prediction: rawPrediction["authority"],
+            pageId: pageId,
+        });
+        this.birthDate = new standard_1.DateField({
+            prediction: rawPrediction["birth_date"],
+            pageId: pageId,
+        });
+        this.birthPlace = new standard_1.StringField({
+            prediction: rawPrediction["birth_place"],
+            pageId: pageId,
+        });
+        this.expiryDate = new standard_1.DateField({
+            prediction: rawPrediction["expiry_date"],
+            pageId: pageId,
+        });
+        this.gender = new standard_1.StringField({
+            prediction: rawPrediction["gender"],
+            pageId: pageId,
+        });
+        rawPrediction["given_names"] &&
+            rawPrediction["given_names"].map((itemPrediction) => this.givenNames.push(new standard_1.StringField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+        this.idNumber = new standard_1.StringField({
+            prediction: rawPrediction["id_number"],
+            pageId: pageId,
+        });
+        this.mrz1 = new standard_1.StringField({
+            prediction: rawPrediction["mrz1"],
+            pageId: pageId,
+        });
+        this.mrz2 = new standard_1.StringField({
+            prediction: rawPrediction["mrz2"],
+            pageId: pageId,
+        });
+        this.surname = new standard_1.StringField({
+            prediction: rawPrediction["surname"],
+            pageId: pageId,
+        });
+    }
+    toString() {
+        const givenNames = this.givenNames.join("\n              ");
+        const outStr = `:Identity Number: ${this.idNumber}
+:Given Name(s): ${givenNames}
+:Surname: ${this.surname}
+:Date of Birth: ${this.birthDate}
+:Place of Birth: ${this.birthPlace}
+:Expiry Date: ${this.expiryDate}
+:Issuing Authority: ${this.authority}
+:Gender: ${this.gender}
+:MRZ Line 1: ${this.mrz1}
+:MRZ Line 2: ${this.mrz2}`.trimEnd();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.IdCardV1Document = IdCardV1Document;

package/src/product/fr/idCard/idCardV1Page.d.ts

@@ -0,0 +1,12 @@
+import { StringDict } from "../../../parsing/common";
+import { ClassificationField } from "../../../parsing/standard";
+import { IdCardV1Document } from "./idCardV1Document";
+/**
+ * Page data for Carte Nationale d'Identité, API version 1.
+ */
+export declare class IdCardV1Page extends IdCardV1Document {
+    /** The side of the document which is visible. */
+    documentSide: ClassificationField;
+    constructor(rawPrediction: StringDict, pageId?: number);
+    toString(): string;
+}

package/src/product/fr/idCard/idCardV1Page.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdCardV1Page = void 0;
+const common_1 = require("../../../parsing/common");
+const standard_1 = require("../../../parsing/standard");
+const idCardV1Document_1 = require("./idCardV1Document");
+/**
+ * Page data for Carte Nationale d'Identité, API version 1.
+ */
+class IdCardV1Page extends idCardV1Document_1.IdCardV1Document {
+    constructor(rawPrediction, pageId) {
+        super(rawPrediction, pageId);
+        this.documentSide = new standard_1.ClassificationField({
+            prediction: rawPrediction["document_side"],
+        });
+    }
+    toString() {
+        let outStr = `:Document Side: ${this.documentSide}`.trimEnd();
+        outStr += "\n" + super.toString();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.IdCardV1Page = IdCardV1Page;

package/src/{documents → product}/index.d.ts

@@ -1,18 +1,13 @@
-export { InvoiceV3 } from "./invoice/invoiceV3";
 export { InvoiceV4 } from "./invoice/invoiceV4";
-export { InvoiceSplitterV1, PageGroup, } from "./invoiceSplitter/invoiceSplitterV1";
-export { ReceiptV3 } from "./receipt/receiptV3";
+export { InvoiceSplitterV1 } from "./invoiceSplitter/invoiceSplitterV1";
+export { PageGroup } from "./invoiceSplitter/invoiceSplitterV1PageGroup";
 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";
 export { CustomV1 } from "./custom/customV1";
-export { getLineItems } from "./custom/lineitems";
 export { CropperV1 } from "./cropper/cropperV1";
-export { MindeeVisionV1 } from "./mindeeVision/mindeeVisionV1";
 export { ProofOfAddressV1 } from "./proofOfAddress/proofOfAddressV1";
-export { Document, DocumentConstructorProps, DocumentSig } from "./document";
 export * as fr from "./fr";
 export * as us from "./us";
 export * as eu from "./eu";

package/src/{documents → product}/index.js

@@ -23,38 +23,27 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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; } });
+exports.eu = exports.us = exports.fr = exports.ProofOfAddressV1 = exports.CropperV1 = exports.CustomV1 = exports.FinancialDocumentV1 = exports.PassportV1 = exports.ReceiptV5 = exports.ReceiptV4 = exports.PageGroup = exports.InvoiceSplitterV1 = exports.InvoiceV4 = void 0;
 var invoiceV4_1 = require("./invoice/invoiceV4");
 Object.defineProperty(exports, "InvoiceV4", { enumerable: true, get: function () { return invoiceV4_1.InvoiceV4; } });
 var invoiceSplitterV1_1 = require("./invoiceSplitter/invoiceSplitterV1");
 Object.defineProperty(exports, "InvoiceSplitterV1", { enumerable: true, get: function () { return invoiceSplitterV1_1.InvoiceSplitterV1; } });
-Object.defineProperty(exports, "PageGroup", { enumerable: true, get: function () { return invoiceSplitterV1_1.PageGroup; } });
-var receiptV3_1 = require("./receipt/receiptV3");
-Object.defineProperty(exports, "ReceiptV3", { enumerable: true, get: function () { return receiptV3_1.ReceiptV3; } });
+var invoiceSplitterV1PageGroup_1 = require("./invoiceSplitter/invoiceSplitterV1PageGroup");
+Object.defineProperty(exports, "PageGroup", { enumerable: true, get: function () { return invoiceSplitterV1PageGroup_1.PageGroup; } });
 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");
-Object.defineProperty(exports, "FinancialDocumentV0", { enumerable: true, get: function () { return financialDocumentV0_1.FinancialDocumentV0; } });
 var financialDocumentV1_1 = require("./financialDocument/financialDocumentV1");
 Object.defineProperty(exports, "FinancialDocumentV1", { enumerable: true, get: function () { return financialDocumentV1_1.FinancialDocumentV1; } });
 var customV1_1 = require("./custom/customV1");
 Object.defineProperty(exports, "CustomV1", { enumerable: true, get: function () { return customV1_1.CustomV1; } });
-var lineitems_1 = require("./custom/lineitems");
-Object.defineProperty(exports, "getLineItems", { enumerable: true, get: function () { return lineitems_1.getLineItems; } });
 var cropperV1_1 = require("./cropper/cropperV1");
 Object.defineProperty(exports, "CropperV1", { enumerable: true, get: function () { return cropperV1_1.CropperV1; } });
-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 document_1 = require("./document");
-Object.defineProperty(exports, "Document", { enumerable: true, get: function () { return document_1.Document; } });
 exports.fr = __importStar(require("./fr"));
 exports.us = __importStar(require("./us"));
 exports.eu = __importStar(require("./eu"));

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

@@ -0,0 +1,9 @@
+import { Inference, StringDict, Page } from "../../parsing/common";
+import { InvoiceV4Document } from "./invoiceV4Document";
+export declare class InvoiceV4 extends Inference {
+    endpointName: string;
+    endpointVersion: string;
+    prediction: InvoiceV4Document;
+    pages: Page<InvoiceV4Document>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/product/invoice/invoiceV4.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvoiceV4 = void 0;
+const common_1 = require("../../parsing/common");
+const invoiceV4Document_1 = require("./invoiceV4Document");
+class InvoiceV4 extends common_1.Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        this.endpointName = "invoices";
+        this.endpointVersion = "4";
+        this.pages = [];
+        this.prediction = new invoiceV4Document_1.InvoiceV4Document(rawPrediction["prediction"]);
+        this.pages = rawPrediction["pages"].map((page) => new common_1.Page(invoiceV4Document_1.InvoiceV4Document, page, page["id"], page["orientation"]));
+    }
+}
+exports.InvoiceV4 = InvoiceV4;

package/src/product/invoice/invoiceV4Document.d.ts

@@ -0,0 +1,44 @@
+import { Prediction, StringDict } from "../../parsing/common";
+import { ClassificationField, Taxes, PaymentDetailsField, LocaleField, AmountField, StringField, DateField, CompanyRegistrationField } from "../../parsing/standard";
+import { InvoiceV4LineItem } from "./invoiceV4LineItem";
+/** Invoice V4 */
+export declare class InvoiceV4Document implements Prediction {
+    /** LocaleField information. */
+    locale: LocaleField;
+    /** The nature of the invoice. */
+    documentType: ClassificationField;
+    /** List of Reference numbers including PO number. */
+    referenceNumbers: StringField[];
+    /** The total amount with tax included. */
+    totalAmount: AmountField;
+    /** The creation date of the invoice. */
+    date: DateField;
+    /** The due date of the invoice. */
+    dueDate: DateField;
+    /** The total tax. */
+    totalTax: AmountField;
+    /** The total amount without the tax value. */
+    totalNet: AmountField;
+    /** The supplier name. */
+    supplierName: StringField;
+    /** The supplier address. */
+    supplierAddress: StringField;
+    /** The payment information. */
+    supplierPaymentDetails: PaymentDetailsField[];
+    /** The supplier company registration information. */
+    supplierCompanyRegistrations: CompanyRegistrationField[];
+    /** The invoice number. */
+    invoiceNumber: StringField;
+    /** The name of the customer. */
+    customerName: StringField;
+    /** The address of the customer. */
+    customerAddress: StringField;
+    /** The company registration information for the customer. */
+    customerCompanyRegistrations: CompanyRegistrationField[];
+    /** The list of the taxes. */
+    taxes: Taxes;
+    /** Line items details. */
+    lineItems: InvoiceV4LineItem[];
+    constructor(rawPrediction: StringDict, pageId?: number);
+    toString(): string;
+}

package/src/product/invoice/invoiceV4Document.js

@@ -0,0 +1,146 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvoiceV4Document = void 0;
+const summaryHelper_1 = require("../../parsing/common/summaryHelper");
+const standard_1 = require("../../parsing/standard");
+const invoiceV4LineItem_1 = require("./invoiceV4LineItem");
+/** Invoice V4 */
+class InvoiceV4Document {
+    constructor(rawPrediction, pageId) {
+        /** List of Reference numbers including PO number. */
+        this.referenceNumbers = [];
+        /** The payment information. */
+        this.supplierPaymentDetails = [];
+        /** The supplier company registration information. */
+        this.supplierCompanyRegistrations = [];
+        /** The company registration information for the customer. */
+        this.customerCompanyRegistrations = [];
+        /** Line items details. */
+        this.lineItems = [];
+        this.locale = new standard_1.LocaleField({
+            prediction: rawPrediction["locale"],
+            valueKey: "language",
+        });
+        this.documentType = new standard_1.ClassificationField({
+            prediction: rawPrediction["document_type"],
+        });
+        this.referenceNumbers =
+            rawPrediction["reference_numbers"] &&
+                rawPrediction["reference_numbers"].map((prediction) => new standard_1.StringField({
+                    prediction: prediction,
+                    pageId: pageId,
+                }));
+        this.totalAmount = new standard_1.AmountField({
+            prediction: rawPrediction["total_amount"],
+            pageId: pageId,
+        });
+        this.totalTax = new standard_1.AmountField({
+            prediction: rawPrediction["taxes"] && rawPrediction["taxes"].length > 0
+                ? {
+                    value: rawPrediction["taxes"].reduce((acc, tax) => {
+                        return tax.value !== undefined ? acc + tax.value : acc;
+                    }, 0),
+                    confidence: 1,
+                }
+                : { value: undefined, confidence: 0.0 },
+            pageId: pageId,
+        });
+        this.totalNet = new standard_1.AmountField({
+            prediction: rawPrediction["total_net"],
+            pageId: pageId,
+        });
+        this.date = new standard_1.DateField({
+            prediction: rawPrediction["date"],
+            pageId,
+        });
+        this.taxes = new standard_1.Taxes().init(rawPrediction["taxes"], pageId);
+        this.supplierCompanyRegistrations =
+            rawPrediction["supplier_company_registrations"] &&
+                rawPrediction["supplier_company_registrations"].map((prediction) => new standard_1.CompanyRegistrationField({
+                    prediction: prediction,
+                    pageId: pageId,
+                }));
+        this.dueDate = new standard_1.DateField({
+            prediction: rawPrediction["due_date"],
+            pageId: pageId,
+        });
+        this.invoiceNumber = new standard_1.StringField({
+            prediction: rawPrediction["invoice_number"],
+            pageId: pageId,
+        });
+        this.supplierName = new standard_1.StringField({
+            prediction: rawPrediction["supplier_name"],
+            pageId: pageId,
+        });
+        this.supplierAddress = new standard_1.StringField({
+            prediction: rawPrediction["supplier_address"],
+            pageId: pageId,
+        });
+        this.customerName = new standard_1.StringField({
+            prediction: rawPrediction["customer_name"],
+            pageId: pageId,
+        });
+        this.customerAddress = new standard_1.StringField({
+            prediction: rawPrediction["customer_address"],
+            pageId: pageId,
+        });
+        rawPrediction["customer_company_registrations"] &&
+            rawPrediction["customer_company_registrations"].forEach((prediction) => this.customerCompanyRegistrations.push(new standard_1.CompanyRegistrationField({
+                prediction: prediction,
+                pageId: pageId,
+            })));
+        rawPrediction["supplier_payment_details"] &&
+            rawPrediction["supplier_payment_details"].forEach((prediction) => this.supplierPaymentDetails.push(new standard_1.PaymentDetailsField({
+                prediction: prediction,
+                pageId: pageId,
+            })));
+        rawPrediction["line_items"] &&
+            rawPrediction["line_items"].forEach((prediction) => this.lineItems.push(new invoiceV4LineItem_1.InvoiceV4LineItem(prediction)));
+    }
+    toString() {
+        const referenceNumbers = this.referenceNumbers
+            .map((item) => item.toString())
+            .join(", ");
+        const paymentDetails = this.supplierPaymentDetails
+            .map((item) => item.toString())
+            .join("\n                 ");
+        const customerCompanyRegistration = this.customerCompanyRegistrations
+            .map((item) => item.toString())
+            .join("; ");
+        const companyRegistration = this.supplierCompanyRegistrations
+            .map((item) => item.toString())
+            .join("; ");
+        let lineItems = "\n";
+        if (this.lineItems.length > 0) {
+            lineItems += (0, summaryHelper_1.lineSeparator)([22, 9, 9, 10, 18, 38], "-");
+            lineItems +=
+                "\n  | Code                 | QTY     | Price   | Amount   | Tax (Rate)       | Description                          |\n";
+            lineItems += (0, summaryHelper_1.lineSeparator)([22, 9, 9, 10, 18, 38], "=") + "\n  ";
+            lineItems += this.lineItems
+                .map((item) => item.toTableLine() +
+                "\n" +
+                (0, summaryHelper_1.lineSeparator)([22, 9, 9, 10, 18, 38], "-"))
+                .join("\n  ");
+        }
+        const outStr = `:Locale: ${this.locale}
+:Document type: ${this.documentType}
+: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 address: ${this.customerAddress}
+:Customer company registrations: ${customerCompanyRegistration}
+:Taxes: ${this.taxes}
+:Total net: ${this.totalNet}
+:Total tax: ${this.totalTax}
+:Total amount: ${this.totalAmount}
+:Line Items: ${lineItems}`;
+        return (0, summaryHelper_1.cleanOutString)(outStr);
+    }
+}
+exports.InvoiceV4Document = InvoiceV4Document;

package/src/{documents/invoice/invoiceLineItem.d.ts → product/invoice/invoiceV4LineItem.d.ts}

@@ -1,20 +1,21 @@
-import { StringDict } from "../../fields";
 import { Polygon } from "../../geometry";
-export declare class InvoiceLineItem {
+import { StringDict } from "../../parsing/common";
+export declare class InvoiceV4LineItem {
+    #private;
     /** The product code referring to the item. */
     productCode: string;
     /** The item description. */
     description: string;
     /** The item quantity  */
-    quantity: number | null;
+    quantity: number | undefined;
     /** The item unit price. */
-    unitPrice: number | null;
+    unitPrice: number | undefined;
     /** The item total amount. */
-    totalAmount: number | null;
+    totalAmount: number | undefined;
     /** The item tax rate in percentage. */
-    taxRate: number | null;
+    taxRate: number | undefined;
     /** The item tax amount. */
-    taxAmount: number | null;
+    taxAmount: number | undefined;
     /** Confidence score */
     confidence: number;
     /** The document page on which the information was found. */
@@ -24,6 +25,7 @@ export declare class InvoiceLineItem {
      * the field in the document.
      */
     polygon: Polygon;
-    constructor({ prediction }: StringDict);
+    constructor(rawPrediction: StringDict);
+    toTableLine(): string;
     toString(): string;
 }