mindee 3.2.0 → 3.3.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## v3.3.0 - 2022-12-01
+### Changes
+* :sparkles: Add Invoice V4 with line items
+* :sparkles: An env variable can be used to change the Mindee base API url
+
 ## v3.2.0 - 2022-11-14
 ### Changes
 * :sparkles: Add support for shipping container API V1

package/README.md

@@ -66,11 +66,11 @@ const apiResponse = mindeeClient
 
 ### Handling the Return
 ```js
-// Print a brief summary of the parsed data
+// Handle the response Promise
 apiResponse.then((resp) => {
 
-    // The document property can be undefined:
-    // * TypeScript will throw an error without this guard clause
+    // The `document` property can be undefined:
+    // * TypeScript will not compile without this guard clause
     //   (or consider using the '?' notation)
     // * JavaScript will be very happy to produce subtle bugs
     //   without this guard clause

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "3.2.0",
+    "version": "3.3.0",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",

package/src/api/endpoint.d.ts

@@ -3,6 +3,7 @@ import { InputSource } from "../inputs";
 import { IncomingMessage } from "http";
 export declare const STANDARD_API_OWNER = "mindee";
 export declare const API_KEY_ENVVAR_NAME = "MINDEE_API_KEY";
+export declare const API_BASE_URL_ENVVAR_NAME = "MINDEE_BASE_URL";
 export interface predictResponse {
     messageObj: IncomingMessage;
     data: {
@@ -25,6 +26,7 @@ export declare class Endpoint {
      */
     predictReqPost(input: InputSource, includeWords?: boolean, cropper?: boolean): Promise<predictResponse>;
     protected apiKeyFromEnv(): string;
+    protected baseUrlFromEnv(): string;
 }
 export declare class StandardEndpoint extends Endpoint {
     constructor(endpointName: string, version: string, apiKey: string);

package/src/api/endpoint.js

@@ -26,24 +26,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomEndpoint = exports.StandardEndpoint = exports.Endpoint = exports.API_KEY_ENVVAR_NAME = exports.STANDARD_API_OWNER = void 0;
+exports.CustomEndpoint = exports.StandardEndpoint = exports.Endpoint = exports.API_BASE_URL_ENVVAR_NAME = exports.API_KEY_ENVVAR_NAME = exports.STANDARD_API_OWNER = void 0;
 const https = __importStar(require("https"));
 const os = __importStar(require("os"));
 const package_json_1 = require("../../package.json");
 const url_1 = require("url");
 const form_data_1 = __importDefault(require("form-data"));
 const logger_1 = require("../logger");
-const MINDEE_API_URL = "https://api.mindee.net/v1";
+const DEFAULT_MINDEE_API_URL = "https://api.mindee.net/v1";
 const USER_AGENT = `mindee-api-nodejs@v${package_json_1.version} nodejs-${process.version} ${os.type().toLowerCase()}`;
 exports.STANDARD_API_OWNER = "mindee";
 exports.API_KEY_ENVVAR_NAME = "MINDEE_API_KEY";
+exports.API_BASE_URL_ENVVAR_NAME = "MINDEE_BASE_URL";
 class Endpoint {
     constructor(owner, urlName, version, apiKey) {
         this.owner = owner;
         this.urlName = urlName;
         this.version = version;
         this.apiKey = apiKey || this.apiKeyFromEnv();
-        this.urlRoot = `${MINDEE_API_URL}/products/${owner}/${urlName}/v${version}`;
+        this.urlRoot = `${this.baseUrlFromEnv()}/products/${owner}/${urlName}/v${version}`;
         this.baseHeaders = {
             "User-Agent": USER_AGENT,
             Authorization: `Token ${this.apiKey}`,
@@ -112,6 +113,14 @@ class Endpoint {
         }
         return "";
     }
+    baseUrlFromEnv() {
+        const envVarValue = process.env[exports.API_BASE_URL_ENVVAR_NAME];
+        if (envVarValue) {
+            logger_1.logger.debug(`Set the API base URL to ${envVarValue}`);
+            return envVarValue;
+        }
+        return DEFAULT_MINDEE_API_URL;
+    }
 }
 exports.Endpoint = Endpoint;
 class StandardEndpoint extends Endpoint {

package/src/cli.js

@@ -22,8 +22,8 @@ const CLI_COMMAND_CONFIG = new Map([
     [
         "invoice",
         {
-            description: "Invoice V3",
-            docClass: documents_1.InvoiceV3,
+            description: "Invoice V4",
+            docClass: documents_1.InvoiceV4,
             fullText: true,
         },
     ],

package/src/client.d.ts

@@ -14,7 +14,7 @@ export interface PredictOptions {
      */
     endpointName?: string;
     /**
-     * For custom endpoints, your organization's username on the API Builder.
+     * For custom endpoints, your account or organization's username on the API Builder.
      * This is normally not required unless you have a custom endpoint which has the
      * same name as standard (off the shelf) endpoint.
      *

package/src/client.js

@@ -83,6 +83,9 @@ class Client {
         this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.InvoiceV3.name], new documentConfig_1.DocumentConfig(documents_1.InvoiceV3, [
             new api_1.StandardEndpoint("invoices", "3", this.apiKey),
         ]));
+        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.InvoiceV4.name], new documentConfig_1.DocumentConfig(documents_1.InvoiceV4, [
+            new api_1.StandardEndpoint("invoices", "4", this.apiKey),
+        ]));
         this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.ReceiptV3.name], new documentConfig_1.DocumentConfig(documents_1.ReceiptV3, [
             new api_1.StandardEndpoint("expense_receipts", "3", this.apiKey),
         ]));

package/src/documents/index.d.ts

@@ -1,4 +1,5 @@
 export { InvoiceV3 } from "./invoice/invoiceV3";
+export { InvoiceV4 } from "./invoice/invoiceV4";
 export { ReceiptV3 } from "./receipt/receiptV3";
 export { ReceiptV4 } from "./receipt/receiptV4";
 export { PassportV1 } from "./passport/passportV1";

package/src/documents/index.js

@@ -23,9 +23,11 @@ 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.CropperV1 = exports.CustomV1 = exports.FinancialDocumentV1 = exports.PassportV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.InvoiceV3 = void 0;
+exports.eu = exports.us = exports.fr = exports.Document = exports.ShippingContainerV1 = exports.CropperV1 = exports.CustomV1 = exports.FinancialDocumentV1 = exports.PassportV1 = exports.ReceiptV4 = exports.ReceiptV3 = 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");
+Object.defineProperty(exports, "InvoiceV4", { enumerable: true, get: function () { return invoiceV4_1.InvoiceV4; } });
 var receiptV3_1 = require("./receipt/receiptV3");
 Object.defineProperty(exports, "ReceiptV3", { enumerable: true, get: function () { return receiptV3_1.ReceiptV3; } });
 var receiptV4_1 = require("./receipt/receiptV4");

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

@@ -0,0 +1,5 @@
+import { InvoiceV3 } from "./invoiceV3";
+import { InvoiceV4 } from "./invoiceV4";
+export declare function taxesMatchTotalIncl(document: InvoiceV4 | InvoiceV3): boolean;
+export declare function taxesMatchTotalExcl(document: InvoiceV4 | InvoiceV3): boolean;
+export declare function taxesAndTotalExclMatchTotalIncl(document: InvoiceV4 | InvoiceV3): boolean;

package/src/documents/invoice/checks.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taxesAndTotalExclMatchTotalIncl = exports.taxesMatchTotalExcl = exports.taxesMatchTotalIncl = void 0;
+function taxesMatchTotalIncl(document) {
+    // Check taxes and total include exist
+    if (document.taxes.length === 0 || document.totalAmount.value === undefined)
+        return false;
+    // Reconstruct totalIncl from taxes
+    let totalVat = 0;
+    let reconstructedTotal = 0;
+    document.taxes.forEach((tax) => {
+        if (tax.value === undefined || !tax.rate)
+            return false;
+        totalVat += tax.value;
+        reconstructedTotal += tax.value + (100 * tax.value) / tax.rate;
+    });
+    // Sanity check
+    if (totalVat <= 0)
+        return false;
+    // Crate epsilon
+    const eps = 1 / (100 * totalVat);
+    if (document.totalAmount.value * (1 - eps) - 0.02 <= reconstructedTotal &&
+        reconstructedTotal <= document.totalAmount.value * (1 + eps) + 0.02) {
+        document.taxes.forEach((tax) => {
+            tax.confidence = 1.0;
+        });
+        document.totalTax.confidence = 1.0;
+        document.totalAmount.confidence = 1.0;
+        return true;
+    }
+    return false;
+}
+exports.taxesMatchTotalIncl = taxesMatchTotalIncl;
+function taxesMatchTotalExcl(document) {
+    // Check taxes and total amount exist
+    if (document.taxes.length === 0 || document.totalNet.value === undefined) {
+        return false;
+    }
+    // Reconstruct total_incl from taxes
+    let totalVat = 0;
+    let reconstructedTotal = 0;
+    document.taxes.forEach((tax) => {
+        if (tax.value === undefined || !tax.rate) {
+            return false;
+        }
+        totalVat += tax.value;
+        reconstructedTotal += (100 * tax.value) / tax.rate;
+    });
+    // Sanity check
+    if (totalVat <= 0)
+        return false;
+    // Crate epsilon
+    const eps = 1 / (100 * totalVat);
+    if (document.totalNet.value * (1 - eps) - 0.02 <= reconstructedTotal &&
+        reconstructedTotal <= document.totalNet.value * (1 + eps) + 0.02) {
+        document.taxes.forEach((tax) => {
+            tax.confidence = 1.0;
+        });
+        document.totalTax.confidence = 1.0;
+        document.totalNet.confidence = 1.0;
+        return true;
+    }
+    return false;
+}
+exports.taxesMatchTotalExcl = taxesMatchTotalExcl;
+function taxesAndTotalExclMatchTotalIncl(document) {
+    if (document.totalNet.value === undefined ||
+        document.taxes.length === 0 ||
+        document.totalAmount.value === undefined)
+        return false;
+    let totalVat = 0;
+    document.taxes.forEach((tax) => (totalVat += tax.value || 0));
+    const reconstructedTotal = totalVat + document.totalNet.value;
+    if (totalVat <= 0)
+        return false;
+    if (document.totalAmount.value - 0.01 <= reconstructedTotal &&
+        reconstructedTotal <= document.totalAmount.value + 0.01) {
+        document.taxes.forEach((tax) => {
+            tax.confidence = 1.0;
+        });
+        document.totalTax.confidence = 1.0;
+        document.totalAmount.confidence = 1.0;
+        return true;
+    }
+    return false;
+}
+exports.taxesAndTotalExclMatchTotalIncl = taxesAndTotalExclMatchTotalIncl;

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

@@ -0,0 +1,29 @@
+import { stringDict } from "../../fields";
+import { Polygon } from "../../geometry";
+export declare class InvoiceLineItem {
+    /** The product code referring to the item. */
+    productCode: string;
+    /** The item description. */
+    description: string;
+    /** The item quantity  */
+    quantity: number | null;
+    /** The item unit price. */
+    unitPrice: number | null;
+    /** The item total amount. */
+    totalAmount: number | null;
+    /** The item tax rate in percentage. */
+    taxRate: number | null;
+    /** The item tax amount. */
+    taxAmount: 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);
+    toString(): string;
+}

package/src/documents/invoice/invoiceLineItem.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvoiceLineItem = void 0;
+const amount_1 = require("../../fields/amount");
+class InvoiceLineItem {
+    constructor({ prediction }) {
+        /** Confidence score */
+        this.confidence = 0.0;
+        /**
+         * Contains the relative vertices coordinates (points) of a polygon containing
+         * the field in the document.
+         */
+        this.polygon = [];
+        this.productCode = prediction.product_code;
+        this.description = prediction.description;
+        this.quantity = +parseFloat(prediction.quantity).toFixed(3);
+        if (isNaN(this.quantity)) {
+            this.quantity = null;
+        }
+        this.unitPrice = +parseFloat(prediction.unit_price).toFixed(3);
+        if (isNaN(this.unitPrice)) {
+            this.unitPrice = null;
+        }
+        this.totalAmount = +parseFloat(prediction.total_amount).toFixed(3);
+        if (isNaN(this.totalAmount)) {
+            this.totalAmount = null;
+        }
+        this.taxRate = +parseFloat(prediction.tax_rate).toFixed(3);
+        if (isNaN(this.taxRate)) {
+            this.taxRate = null;
+        }
+        this.taxAmount = +parseFloat(prediction.tax_amount).toFixed(3);
+        if (isNaN(this.taxAmount)) {
+            this.taxAmount = null;
+        }
+        this.pageId = prediction.page_id;
+        this.confidence = prediction.confidence ? prediction.confidence : 0.0;
+        if (prediction.polygon) {
+            this.polygon = prediction.polygon;
+        }
+    }
+    toString() {
+        const productCode = this.productCode ?? "";
+        const quantity = this.quantity !== null ? (0, amount_1.floatToString)(this.quantity) : "";
+        const unitPrice = this.unitPrice !== null ? (0, amount_1.floatToString)(this.unitPrice) : "";
+        const totalAmount = this.totalAmount !== null ? (0, amount_1.floatToString)(this.totalAmount) : "";
+        let tax = this.taxAmount !== null ? (0, amount_1.floatToString)(this.taxAmount) : "";
+        tax += this.taxRate !== null ? ` (${this.taxRate} %)` : "";
+        let description = this.description ?? "";
+        if (description.length > 32) {
+            description = this.description.substring(0, 32) + "...";
+        }
+        return (productCode.padEnd(14) +
+            " | " +
+            quantity.padEnd(6) +
+            " | " +
+            unitPrice.padEnd(7) +
+            " | " +
+            totalAmount.padEnd(8) +
+            " | " +
+            tax.padEnd(14) +
+            " | " +
+            description);
+    }
+}
+exports.InvoiceLineItem = InvoiceLineItem;

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

@@ -6,8 +6,8 @@ export declare class InvoiceV3 extends Document {
     locale: Locale;
     /** The nature of the invoice. */
     documentType: BaseField;
-    /** The total amount with tax included. */
-    totalIncl: Amount;
+    /** The total amount with tax included. Same as totalIncl. */
+    totalAmount: Amount;
     /** The creation date of the invoice. */
     date: DateField;
     /** The due date of the invoice. */
@@ -16,8 +16,8 @@ export declare class InvoiceV3 extends Document {
     time: Field;
     /** The total tax. */
     totalTax: Amount;
-    /** The total amount without the tax value. */
-    totalExcl: Amount;
+    /** The total amount without the tax value. Same as totalExcl. */
+    totalNet: Amount;
     /** The supplier name. */
     supplier: Field;
     /** The supplier address. */
@@ -36,12 +36,14 @@ export declare class InvoiceV3 extends Document {
     paymentDetails: PaymentDetails[];
     /** The company registration information for the customer. */
     customerCompanyRegistration: CompanyRegistration[];
+    /** The total amount without the tax value. */
+    get totalExcl(): Amount;
+    /** The total amount without the tax value. */
+    set totalExcl(value: Amount);
+    /** The total amount with tax included. */
+    get totalIncl(): Amount;
+    /** The total amount with tax included. */
+    set totalIncl(value: Amount);
     constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);
     toString(): string;
-    private taxesMatchTotalIncl;
-    /**
-     *
-     */
-    private taxesMatchTotalExcl;
-    private taxesAndTotalExclMatchTotalIncl;
 }

package/src/documents/invoice/invoiceV3.js

@@ -4,11 +4,13 @@ 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, _InvoiceV3_reconstructTotalTax, _InvoiceV3_reconstructTotalTaxFromTotals, _InvoiceV3_reconstructTotalExcl, _InvoiceV3_reconstructTotalIncl;
+var _InvoiceV3_instances, _InvoiceV3_initFromApiPrediction, _InvoiceV3_checklist, _InvoiceV3_reconstruct;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvoiceV3 = void 0;
 const document_1 = require("../document");
 const fields_1 = require("../../fields");
+const checks_1 = require("./checks");
+const reconstruction_1 = require("./reconstruction");
 class InvoiceV3 extends document_1.Document {
     constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, fullText = undefined, pageId = undefined, }) {
         super({
@@ -31,6 +33,22 @@ class InvoiceV3 extends document_1.Document {
         __classPrivateFieldGet(this, _InvoiceV3_instances, "m", _InvoiceV3_checklist).call(this);
         __classPrivateFieldGet(this, _InvoiceV3_instances, "m", _InvoiceV3_reconstruct).call(this);
     }
+    /** The total amount without the tax value. */
+    get totalExcl() {
+        return this.totalNet;
+    }
+    /** The total amount without the tax value. */
+    set totalExcl(value) {
+        this.totalNet = value;
+    }
+    /** The total amount with tax included. */
+    get totalIncl() {
+        return this.totalAmount;
+    }
+    /** The total amount with tax included. */
+    set totalIncl(value) {
+        this.totalAmount = value;
+    }
     toString() {
         const taxes = this.taxes.map((item) => item.toString()).join("\n       ");
         const paymentDetails = this.paymentDetails
@@ -42,7 +60,7 @@ class InvoiceV3 extends document_1.Document {
         const companyRegistration = this.companyRegistration
             .map((item) => item.toString())
             .join("; ");
-        const outStr = `-----Invoice data-----
+        const outStr = `----- Invoice V3 -----
 Filename: ${this.filename}
 Invoice number: ${this.invoiceNumber}
 Total amount including taxes: ${this.totalIncl}
@@ -63,90 +81,6 @@ Locale: ${this.locale}
 `;
         return InvoiceV3.cleanOutString(outStr);
     }
-    taxesMatchTotalIncl() {
-        // Check taxes and total include exist
-        if (this.taxes.length === 0 || this.totalIncl.value === undefined)
-            return false;
-        // Reconstruct totalIncl from taxes
-        let totalVat = 0;
-        let reconstructedTotal = 0;
-        this.taxes.forEach((tax) => {
-            if (tax.value === undefined || !tax.rate)
-                return false;
-            totalVat += tax.value;
-            reconstructedTotal += tax.value + (100 * tax.value) / tax.rate;
-        });
-        // Sanity check
-        if (totalVat <= 0)
-            return false;
-        // Crate epsilon
-        const eps = 1 / (100 * totalVat);
-        if (this.totalIncl.value * (1 - eps) - 0.02 <= reconstructedTotal &&
-            reconstructedTotal <= this.totalIncl.value * (1 + eps) + 0.02) {
-            this.taxes.forEach((tax) => {
-                tax.confidence = 1.0;
-            });
-            this.totalTax.confidence = 1.0;
-            this.totalIncl.confidence = 1.0;
-            return true;
-        }
-        return false;
-    }
-    /**
-     *
-     */
-    taxesMatchTotalExcl() {
-        // Check taxes and total amount exist
-        if (this.taxes.length === 0 || this.totalExcl.value === undefined) {
-            return false;
-        }
-        // Reconstruct total_incl from taxes
-        let totalVat = 0;
-        let reconstructedTotal = 0;
-        this.taxes.forEach((tax) => {
-            if (tax.value === undefined || !tax.rate) {
-                return false;
-            }
-            totalVat += tax.value;
-            reconstructedTotal += (100 * tax.value) / tax.rate;
-        });
-        // Sanity check
-        if (totalVat <= 0)
-            return false;
-        // Crate epsilon
-        const eps = 1 / (100 * totalVat);
-        if (this.totalExcl.value * (1 - eps) - 0.02 <= reconstructedTotal &&
-            reconstructedTotal <= this.totalExcl.value * (1 + eps) + 0.02) {
-            this.taxes.forEach((tax) => {
-                tax.confidence = 1.0;
-            });
-            this.totalTax.confidence = 1.0;
-            this.totalExcl.confidence = 1.0;
-            return true;
-        }
-        return false;
-    }
-    taxesAndTotalExclMatchTotalIncl() {
-        if (this.totalExcl.value === undefined ||
-            this.taxes.length === 0 ||
-            this.totalIncl.value === undefined)
-            return false;
-        let totalVat = 0;
-        this.taxes.forEach((tax) => (totalVat += tax.value || 0));
-        const reconstructedTotal = totalVat + this.totalExcl.value;
-        if (totalVat <= 0)
-            return false;
-        if (this.totalIncl.value - 0.01 <= reconstructedTotal &&
-            reconstructedTotal <= this.totalIncl.value + 0.01) {
-            this.taxes.forEach((tax) => {
-                tax.confidence = 1.0;
-            });
-            this.totalTax.confidence = 1.0;
-            this.totalIncl.confidence = 1.0;
-            return true;
-        }
-        return false;
-    }
 }
 exports.InvoiceV3 = InvoiceV3;
 _InvoiceV3_instances = new WeakSet(), _InvoiceV3_initFromApiPrediction = function _InvoiceV3_initFromApiPrediction(apiPrediction, pageId) {
@@ -163,12 +97,13 @@ _InvoiceV3_instances = new WeakSet(), _InvoiceV3_initFromApiPrediction = functio
         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.totalExcl = new fields_1.Amount({
+    this.totalNet = new fields_1.Amount({
         prediction: apiPrediction.total_excl,
         valueKey: "value",
         pageId: pageId,
@@ -224,78 +159,13 @@ _InvoiceV3_instances = new WeakSet(), _InvoiceV3_initFromApiPrediction = functio
     })));
 }, _InvoiceV3_checklist = function _InvoiceV3_checklist() {
     this.checklist = {
-        taxesMatchTotalIncl: this.taxesMatchTotalIncl(),
-        taxesMatchTotalExcl: this.taxesMatchTotalExcl(),
-        taxesAndTotalExclMatchTotalIncl: this.taxesAndTotalExclMatchTotalIncl(),
+        taxesMatchTotalIncl: (0, checks_1.taxesMatchTotalIncl)(this),
+        taxesMatchTotalExcl: (0, checks_1.taxesMatchTotalExcl)(this),
+        taxesAndTotalExclMatchTotalIncl: (0, checks_1.taxesAndTotalExclMatchTotalIncl)(this),
     };
 }, _InvoiceV3_reconstruct = function _InvoiceV3_reconstruct() {
-    __classPrivateFieldGet(this, _InvoiceV3_instances, "m", _InvoiceV3_reconstructTotalTax).call(this);
-    __classPrivateFieldGet(this, _InvoiceV3_instances, "m", _InvoiceV3_reconstructTotalExcl).call(this);
-    __classPrivateFieldGet(this, _InvoiceV3_instances, "m", _InvoiceV3_reconstructTotalIncl).call(this);
-    __classPrivateFieldGet(this, _InvoiceV3_instances, "m", _InvoiceV3_reconstructTotalTaxFromTotals).call(this);
-}, _InvoiceV3_reconstructTotalTax = function _InvoiceV3_reconstructTotalTax() {
-    if (this.taxes.length > 0) {
-        const totalTax = {
-            value: this.taxes.reduce((acc, tax) => {
-                return tax.value !== undefined ? acc + tax.value : acc;
-            }, 0),
-            confidence: fields_1.Field.arrayConfidence(this.taxes),
-        };
-        if (totalTax.value > 0)
-            this.totalTax = new fields_1.Amount({
-                prediction: totalTax,
-                valueKey: "value",
-                reconstructed: true,
-            });
-    }
-}, _InvoiceV3_reconstructTotalTaxFromTotals = function _InvoiceV3_reconstructTotalTaxFromTotals() {
-    if (this.totalTax.value !== undefined ||
-        this.totalExcl.value === undefined ||
-        this.totalIncl.value === undefined) {
-        return;
-    }
-    const totalTax = {
-        value: this.totalIncl.value - this.totalExcl.value,
-        confidence: this.totalIncl.confidence * this.totalExcl.confidence,
-    };
-    if (totalTax.value >= 0) {
-        this.totalTax = new fields_1.Amount({
-            prediction: totalTax,
-            valueKey: "value",
-            reconstructed: true,
-        });
-    }
-}, _InvoiceV3_reconstructTotalExcl = function _InvoiceV3_reconstructTotalExcl() {
-    if (this.totalIncl.value === undefined ||
-        this.taxes.length === 0 ||
-        this.totalExcl.value !== undefined) {
-        return;
-    }
-    const totalExcl = {
-        value: this.totalIncl.value - fields_1.Field.arraySum(this.taxes),
-        confidence: fields_1.Field.arrayConfidence(this.taxes) *
-            this.totalIncl.confidence,
-    };
-    this.totalExcl = new fields_1.Amount({
-        prediction: totalExcl,
-        valueKey: "value",
-        reconstructed: true,
-    });
-}, _InvoiceV3_reconstructTotalIncl = function _InvoiceV3_reconstructTotalIncl() {
-    if (!(this.totalExcl.value === undefined ||
-        this.taxes.length === 0 ||
-        this.totalIncl.value !== undefined)) {
-        const totalIncl = {
-            value: this.totalExcl.value +
-                this.taxes.reduce((acc, tax) => {
-                    return tax.value ? acc + tax.value : acc;
-                }, 0.0),
-            confidence: fields_1.Field.arrayConfidence(this.taxes) * this.totalExcl.confidence,
-        };
-        this.totalIncl = new fields_1.Amount({
-            prediction: totalIncl,
-            valueKey: "value",
-            reconstructed: true,
-        });
-    }
+    (0, reconstruction_1.reconstructTotalTax)(this);
+    (0, reconstruction_1.reconstructTotalExcl)(this);
+    (0, reconstruction_1.reconstructTotalIncl)(this);
+    (0, reconstruction_1.reconstructTotalTaxFromTotals)(this);
 };

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

@@ -0,0 +1,44 @@
+import { Document, DocumentConstructorProps } from "../document";
+import { TaxField, PaymentDetails, Locale, Amount, Field, DateField, CompanyRegistration, BaseField } from "../../fields";
+import { InvoiceLineItem } from "./invoiceLineItem";
+export declare class InvoiceV4 extends Document {
+    #private;
+    /** Locale information. */
+    locale: Locale;
+    /** The nature of the invoice. */
+    documentType: BaseField;
+    /** The total amount with tax included. */
+    totalAmount: Amount;
+    /** The creation date of the invoice. */
+    date: DateField;
+    /** The due date of the invoice. */
+    dueDate: DateField;
+    /** The created time of the invoice */
+    time: Field;
+    /** The total tax. */
+    totalTax: Amount;
+    /** The total amount without the tax value. */
+    totalNet: Amount;
+    /** The supplier name. */
+    supplierName: Field;
+    /** The supplier address. */
+    supplierAddress: Field;
+    /** The payment information. */
+    supplierPaymentDetails: PaymentDetails[];
+    /** The supplier company regitration information. */
+    supplierCompanyRegistrations: CompanyRegistration[];
+    /** The invoice number. */
+    invoiceNumber: Field;
+    /** The name of the customer. */
+    customerName: Field;
+    /** The address of the customer. */
+    customerAddress: Field;
+    /** The company registration information for the customer. */
+    customerCompanyRegistrations: CompanyRegistration[];
+    /** The list of the taxes. */
+    taxes: TaxField[];
+    /** Line items details. */
+    lineItems: InvoiceLineItem[];
+    constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);
+    toString(): string;
+}

package/src/documents/invoice/invoiceV4.js

@@ -0,0 +1,168 @@
+"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 _InvoiceV4_instances, _InvoiceV4_initFromApiPrediction, _InvoiceV4_checklist, _InvoiceV4_reconstruct;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvoiceV4 = void 0;
+const document_1 = require("../document");
+const fields_1 = require("../../fields");
+const invoiceLineItem_1 = require("./invoiceLineItem");
+const checks_1 = require("./checks");
+const reconstruction_1 = require("./reconstruction");
+class InvoiceV4 extends document_1.Document {
+    constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, fullText = undefined, pageId = undefined, }) {
+        super({
+            inputSource: inputSource,
+            pageId: pageId,
+            orientation: orientation,
+            fullText: fullText,
+            extras: extras,
+        });
+        _InvoiceV4_instances.add(this);
+        /** The payment information. */
+        this.supplierPaymentDetails = [];
+        /** The supplier company regitration information. */
+        this.supplierCompanyRegistrations = [];
+        /** The company registration information for the customer. */
+        this.customerCompanyRegistrations = [];
+        /** The list of the taxes. */
+        this.taxes = [];
+        /** Line items details. */
+        this.lineItems = [];
+        __classPrivateFieldGet(this, _InvoiceV4_instances, "m", _InvoiceV4_initFromApiPrediction).call(this, prediction, pageId);
+        __classPrivateFieldGet(this, _InvoiceV4_instances, "m", _InvoiceV4_checklist).call(this);
+        __classPrivateFieldGet(this, _InvoiceV4_instances, "m", _InvoiceV4_reconstruct).call(this);
+    }
+    toString() {
+        const taxes = this.taxes.map((item) => item.toString()).join("\n       ");
+        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 =
+                "\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}
+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}
+----------------------
+`;
+        return InvoiceV4.cleanOutString(outStr);
+    }
+}
+exports.InvoiceV4 = InvoiceV4;
+_InvoiceV4_instances = new WeakSet(), _InvoiceV4_initFromApiPrediction = function _InvoiceV4_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.totalAmount = new fields_1.Amount({
+        prediction: apiPrediction.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: apiPrediction.total_net,
+        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.supplierCompanyRegistrations =
+        apiPrediction.supplier_company_registrations.map(function (prediction) {
+            return new fields_1.CompanyRegistration({
+                prediction: prediction,
+                pageId: pageId,
+            });
+        });
+    this.dueDate = new fields_1.DateField({
+        prediction: apiPrediction.due_date,
+        pageId: pageId,
+    });
+    this.invoiceNumber = new fields_1.Field({
+        prediction: apiPrediction.invoice_number,
+        pageId: pageId,
+    });
+    this.supplierName = new fields_1.Field({
+        prediction: apiPrediction.supplier_name,
+        pageId: pageId,
+    });
+    this.supplierAddress = new fields_1.Field({
+        prediction: apiPrediction.supplier_address,
+        pageId: pageId,
+    });
+    this.customerName = new fields_1.Field({
+        prediction: apiPrediction.customer_name,
+        pageId: pageId,
+    });
+    this.customerAddress = new fields_1.Field({
+        prediction: apiPrediction.customer_address,
+        pageId: pageId,
+    });
+    apiPrediction.customer_company_registrations.map((prediction) => this.customerCompanyRegistrations.push(new fields_1.CompanyRegistration({
+        prediction: prediction,
+        pageId: pageId,
+    })));
+    apiPrediction.supplier_payment_details.map((prediction) => this.supplierPaymentDetails.push(new fields_1.PaymentDetails({
+        prediction: prediction,
+        pageId: pageId,
+    })));
+    apiPrediction.line_items.map((prediction) => this.lineItems.push(new invoiceLineItem_1.InvoiceLineItem({
+        prediction: prediction,
+    })));
+}, _InvoiceV4_checklist = function _InvoiceV4_checklist() {
+    this.checklist = {
+        taxesMatchTotalIncl: (0, checks_1.taxesMatchTotalIncl)(this),
+        taxesMatchTotalExcl: (0, checks_1.taxesMatchTotalExcl)(this),
+        taxesAndTotalExclMatchTotalIncl: (0, checks_1.taxesAndTotalExclMatchTotalIncl)(this),
+    };
+}, _InvoiceV4_reconstruct = function _InvoiceV4_reconstruct() {
+    (0, reconstruction_1.reconstructTotalTax)(this);
+    (0, reconstruction_1.reconstructTotalExcl)(this);
+    (0, reconstruction_1.reconstructTotalIncl)(this);
+    (0, reconstruction_1.reconstructTotalTaxFromTotals)(this);
+};

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

@@ -0,0 +1,6 @@
+import { InvoiceV3 } from "./invoiceV3";
+import { InvoiceV4 } from "./invoiceV4";
+export declare function reconstructTotalTax(document: InvoiceV3 | InvoiceV4): void;
+export declare function reconstructTotalTaxFromTotals(document: InvoiceV3 | InvoiceV4): void;
+export declare function reconstructTotalExcl(document: InvoiceV3 | InvoiceV4): void;
+export declare function reconstructTotalIncl(document: InvoiceV3 | InvoiceV4): void;

package/src/documents/invoice/reconstruction.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reconstructTotalIncl = exports.reconstructTotalExcl = exports.reconstructTotalTaxFromTotals = exports.reconstructTotalTax = void 0;
+const fields_1 = require("../../fields");
+function reconstructTotalTax(document) {
+    if (document.taxes.length > 0) {
+        const totalTax = {
+            value: document.taxes.reduce((acc, tax) => {
+                return tax.value !== undefined ? acc + tax.value : acc;
+            }, 0),
+            confidence: fields_1.Field.arrayConfidence(document.taxes),
+        };
+        if (totalTax.value > 0)
+            document.totalTax = new fields_1.Amount({
+                prediction: totalTax,
+                valueKey: "value",
+                reconstructed: true,
+            });
+    }
+}
+exports.reconstructTotalTax = reconstructTotalTax;
+function reconstructTotalTaxFromTotals(document) {
+    if (document.totalTax.value !== undefined ||
+        document.totalNet.value === undefined ||
+        document.totalAmount.value === undefined) {
+        return;
+    }
+    const totalTax = {
+        value: document.totalAmount.value - document.totalNet.value,
+        confidence: document.totalAmount.confidence * document.totalNet.confidence,
+    };
+    if (totalTax.value >= 0) {
+        document.totalTax = new fields_1.Amount({
+            prediction: totalTax,
+            valueKey: "value",
+            reconstructed: true,
+        });
+    }
+}
+exports.reconstructTotalTaxFromTotals = reconstructTotalTaxFromTotals;
+function reconstructTotalExcl(document) {
+    if (document.totalAmount.value === undefined ||
+        document.taxes.length === 0 ||
+        document.totalNet.value !== undefined) {
+        return;
+    }
+    const totalExcl = {
+        value: document.totalAmount.value - fields_1.Field.arraySum(document.taxes),
+        confidence: fields_1.Field.arrayConfidence(document.taxes) *
+            document.totalAmount.confidence,
+    };
+    document.totalNet = new fields_1.Amount({
+        prediction: totalExcl,
+        valueKey: "value",
+        reconstructed: true,
+    });
+}
+exports.reconstructTotalExcl = reconstructTotalExcl;
+function reconstructTotalIncl(document) {
+    if (!(document.totalNet.value === undefined ||
+        document.taxes.length === 0 ||
+        document.totalAmount.value !== undefined)) {
+        const totalIncl = {
+            value: document.totalNet.value +
+                document.taxes.reduce((acc, tax) => {
+                    return tax.value ? acc + tax.value : acc;
+                }, 0.0),
+            confidence: fields_1.Field.arrayConfidence(document.taxes) * document.totalNet.confidence,
+        };
+        document.totalAmount = new fields_1.Amount({
+            prediction: totalIncl,
+            valueKey: "value",
+            reconstructed: true,
+        });
+    }
+}
+exports.reconstructTotalIncl = reconstructTotalIncl;

package/src/index.d.ts

@@ -1,3 +1,3 @@
-export { CustomV1, FinancialDocumentV1, InvoiceV3, PassportV1, ReceiptV3, ReceiptV4, CropperV1, ShippingContainerV1, fr, us, eu, } from "./documents";
+export { CustomV1, FinancialDocumentV1, InvoiceV3, InvoiceV4, PassportV1, ReceiptV3, ReceiptV4, CropperV1, ShippingContainerV1, fr, us, eu, } from "./documents";
 export { Client } from "./client";
 export { PageOptionsOperation } from "./inputs";

package/src/index.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PageOptionsOperation = exports.Client = exports.eu = exports.us = exports.fr = exports.ShippingContainerV1 = exports.CropperV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PassportV1 = exports.InvoiceV3 = exports.FinancialDocumentV1 = exports.CustomV1 = void 0;
+exports.PageOptionsOperation = exports.Client = exports.eu = exports.us = exports.fr = exports.ShippingContainerV1 = exports.CropperV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PassportV1 = exports.InvoiceV4 = exports.InvoiceV3 = exports.FinancialDocumentV1 = exports.CustomV1 = void 0;
 var documents_1 = require("./documents");
 Object.defineProperty(exports, "CustomV1", { enumerable: true, get: function () { return documents_1.CustomV1; } });
 Object.defineProperty(exports, "FinancialDocumentV1", { enumerable: true, get: function () { return documents_1.FinancialDocumentV1; } });
 Object.defineProperty(exports, "InvoiceV3", { enumerable: true, get: function () { return documents_1.InvoiceV3; } });
+Object.defineProperty(exports, "InvoiceV4", { enumerable: true, get: function () { return documents_1.InvoiceV4; } });
 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; } });