mindee 4.15.0 → 4.17.0

package/src/product/billOfLading/billOfLadingV1Document.d.ts

@@ -0,0 +1,39 @@
+import { Prediction, StringDict } from "../../parsing/common";
+import { BillOfLadingV1Shipper } from "./billOfLadingV1Shipper";
+import { BillOfLadingV1Consignee } from "./billOfLadingV1Consignee";
+import { BillOfLadingV1NotifyParty } from "./billOfLadingV1NotifyParty";
+import { BillOfLadingV1Carrier } from "./billOfLadingV1Carrier";
+import { BillOfLadingV1CarrierItem } from "./billOfLadingV1CarrierItem";
+import { DateField, StringField } from "../../parsing/standard";
+/**
+ * Bill of Lading API version 1.1 document data.
+ */
+export declare class BillOfLadingV1Document implements Prediction {
+    /** A unique identifier assigned to a Bill of Lading document. */
+    billOfLadingNumber: StringField;
+    /** The shipping company responsible for transporting the goods. */
+    carrier: BillOfLadingV1Carrier;
+    /** The goods being shipped. */
+    carrierItems: BillOfLadingV1CarrierItem[];
+    /** The party to whom the goods are being shipped. */
+    consignee: BillOfLadingV1Consignee;
+    /** The date when the bill of lading is issued. */
+    dateOfIssue: DateField;
+    /** The date when the vessel departs from the port of loading. */
+    departureDate: DateField;
+    /** The party to be notified of the arrival of the goods. */
+    notifyParty: BillOfLadingV1NotifyParty;
+    /** The place where the goods are to be delivered. */
+    placeOfDelivery: StringField;
+    /** The port where the goods are unloaded from the vessel. */
+    portOfDischarge: StringField;
+    /** The port where the goods are loaded onto the vessel. */
+    portOfLoading: StringField;
+    /** The party responsible for shipping the goods. */
+    shipper: BillOfLadingV1Shipper;
+    constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

package/src/product/billOfLading/billOfLadingV1Document.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillOfLadingV1Document = void 0;
+const common_1 = require("../../parsing/common");
+const billOfLadingV1Shipper_1 = require("./billOfLadingV1Shipper");
+const billOfLadingV1Consignee_1 = require("./billOfLadingV1Consignee");
+const billOfLadingV1NotifyParty_1 = require("./billOfLadingV1NotifyParty");
+const billOfLadingV1Carrier_1 = require("./billOfLadingV1Carrier");
+const billOfLadingV1CarrierItem_1 = require("./billOfLadingV1CarrierItem");
+const standard_1 = require("../../parsing/standard");
+/**
+ * Bill of Lading API version 1.1 document data.
+ */
+class BillOfLadingV1Document {
+    constructor(rawPrediction, pageId) {
+        /** The goods being shipped. */
+        this.carrierItems = [];
+        this.billOfLadingNumber = new standard_1.StringField({
+            prediction: rawPrediction["bill_of_lading_number"],
+            pageId: pageId,
+        });
+        this.carrier = new billOfLadingV1Carrier_1.BillOfLadingV1Carrier({
+            prediction: rawPrediction["carrier"],
+            pageId: pageId,
+        });
+        rawPrediction["carrier_items"] &&
+            rawPrediction["carrier_items"].map((itemPrediction) => this.carrierItems.push(new billOfLadingV1CarrierItem_1.BillOfLadingV1CarrierItem({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+        this.consignee = new billOfLadingV1Consignee_1.BillOfLadingV1Consignee({
+            prediction: rawPrediction["consignee"],
+            pageId: pageId,
+        });
+        this.dateOfIssue = new standard_1.DateField({
+            prediction: rawPrediction["date_of_issue"],
+            pageId: pageId,
+        });
+        this.departureDate = new standard_1.DateField({
+            prediction: rawPrediction["departure_date"],
+            pageId: pageId,
+        });
+        this.notifyParty = new billOfLadingV1NotifyParty_1.BillOfLadingV1NotifyParty({
+            prediction: rawPrediction["notify_party"],
+            pageId: pageId,
+        });
+        this.placeOfDelivery = new standard_1.StringField({
+            prediction: rawPrediction["place_of_delivery"],
+            pageId: pageId,
+        });
+        this.portOfDischarge = new standard_1.StringField({
+            prediction: rawPrediction["port_of_discharge"],
+            pageId: pageId,
+        });
+        this.portOfLoading = new standard_1.StringField({
+            prediction: rawPrediction["port_of_loading"],
+            pageId: pageId,
+        });
+        this.shipper = new billOfLadingV1Shipper_1.BillOfLadingV1Shipper({
+            prediction: rawPrediction["shipper"],
+            pageId: pageId,
+        });
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        let carrierItemsSummary = "";
+        if (this.carrierItems && this.carrierItems.length > 0) {
+            const carrierItemsColSizes = [38, 14, 13, 18, 10, 13];
+            carrierItemsSummary += "\n" + (0, common_1.lineSeparator)(carrierItemsColSizes, "-") + "\n  ";
+            carrierItemsSummary += "| Description                          ";
+            carrierItemsSummary += "| Gross Weight ";
+            carrierItemsSummary += "| Measurement ";
+            carrierItemsSummary += "| Measurement Unit ";
+            carrierItemsSummary += "| Quantity ";
+            carrierItemsSummary += "| Weight Unit ";
+            carrierItemsSummary += "|\n" + (0, common_1.lineSeparator)(carrierItemsColSizes, "=");
+            carrierItemsSummary += this.carrierItems.map((item) => "\n  " + item.toTableLine() + "\n" + (0, common_1.lineSeparator)(carrierItemsColSizes, "-")).join("");
+        }
+        const outStr = `:Bill of Lading Number: ${this.billOfLadingNumber}
+:Shipper: ${this.shipper.toFieldList()}
+:Consignee: ${this.consignee.toFieldList()}
+:Notify Party: ${this.notifyParty.toFieldList()}
+:Carrier: ${this.carrier.toFieldList()}
+:Items: ${carrierItemsSummary}
+:Port of Loading: ${this.portOfLoading}
+:Port of Discharge: ${this.portOfDischarge}
+:Place of Delivery: ${this.placeOfDelivery}
+:Date of issue: ${this.dateOfIssue}
+:Departure Date: ${this.departureDate}`.trimEnd();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.BillOfLadingV1Document = BillOfLadingV1Document;

package/src/product/billOfLading/billOfLadingV1NotifyParty.d.ts

@@ -0,0 +1,34 @@
+import { StringDict } from "../../parsing/common";
+import { Polygon } from "../../geometry";
+/**
+ * The party to be notified of the arrival of the goods.
+ */
+export declare class BillOfLadingV1NotifyParty {
+    #private;
+    /** The address of the notify party. */
+    address: string | null;
+    /** The  email of the shipper. */
+    email: string | null;
+    /** The name of the notify party. */
+    name: string | null;
+    /** The phone number of the notify party. */
+    phone: 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/product/billOfLading/billOfLadingV1NotifyParty.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 _BillOfLadingV1NotifyParty_instances, _BillOfLadingV1NotifyParty_printableValues;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillOfLadingV1NotifyParty = void 0;
+/**
+ * The party to be notified of the arrival of the goods.
+ */
+class BillOfLadingV1NotifyParty {
+    constructor({ prediction = {} }) {
+        _BillOfLadingV1NotifyParty_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.address = prediction["address"];
+        this.email = prediction["email"];
+        this.name = prediction["name"];
+        this.phone = prediction["phone"];
+        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, _BillOfLadingV1NotifyParty_instances, "m", _BillOfLadingV1NotifyParty_printableValues).call(this);
+        return ("Address: " +
+            printable.address +
+            ", Email: " +
+            printable.email +
+            ", Name: " +
+            printable.name +
+            ", Phone: " +
+            printable.phone);
+    }
+    /**
+     * Output in a format suitable for inclusion in a field list.
+     */
+    toFieldList() {
+        const printable = __classPrivateFieldGet(this, _BillOfLadingV1NotifyParty_instances, "m", _BillOfLadingV1NotifyParty_printableValues).call(this);
+        return `
+  :Address: ${printable.address}
+  :Email: ${printable.email}
+  :Name: ${printable.name}
+  :Phone: ${printable.phone}`.trimEnd();
+    }
+}
+exports.BillOfLadingV1NotifyParty = BillOfLadingV1NotifyParty;
+_BillOfLadingV1NotifyParty_instances = new WeakSet(), _BillOfLadingV1NotifyParty_printableValues = function _BillOfLadingV1NotifyParty_printableValues() {
+    return {
+        address: this.address ?? "",
+        email: this.email ?? "",
+        name: this.name ?? "",
+        phone: this.phone ?? "",
+    };
+};

package/src/product/billOfLading/billOfLadingV1Shipper.d.ts

@@ -0,0 +1,34 @@
+import { StringDict } from "../../parsing/common";
+import { Polygon } from "../../geometry";
+/**
+ * The party responsible for shipping the goods.
+ */
+export declare class BillOfLadingV1Shipper {
+    #private;
+    /** The address of the shipper. */
+    address: string | null;
+    /** The  email of the shipper. */
+    email: string | null;
+    /** The name of the shipper. */
+    name: string | null;
+    /** The phone number of the shipper. */
+    phone: 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/product/billOfLading/billOfLadingV1Shipper.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 _BillOfLadingV1Shipper_instances, _BillOfLadingV1Shipper_printableValues;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillOfLadingV1Shipper = void 0;
+/**
+ * The party responsible for shipping the goods.
+ */
+class BillOfLadingV1Shipper {
+    constructor({ prediction = {} }) {
+        _BillOfLadingV1Shipper_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.address = prediction["address"];
+        this.email = prediction["email"];
+        this.name = prediction["name"];
+        this.phone = prediction["phone"];
+        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, _BillOfLadingV1Shipper_instances, "m", _BillOfLadingV1Shipper_printableValues).call(this);
+        return ("Address: " +
+            printable.address +
+            ", Email: " +
+            printable.email +
+            ", Name: " +
+            printable.name +
+            ", Phone: " +
+            printable.phone);
+    }
+    /**
+     * Output in a format suitable for inclusion in a field list.
+     */
+    toFieldList() {
+        const printable = __classPrivateFieldGet(this, _BillOfLadingV1Shipper_instances, "m", _BillOfLadingV1Shipper_printableValues).call(this);
+        return `
+  :Address: ${printable.address}
+  :Email: ${printable.email}
+  :Name: ${printable.name}
+  :Phone: ${printable.phone}`.trimEnd();
+    }
+}
+exports.BillOfLadingV1Shipper = BillOfLadingV1Shipper;
+_BillOfLadingV1Shipper_instances = new WeakSet(), _BillOfLadingV1Shipper_printableValues = function _BillOfLadingV1Shipper_printableValues() {
+    return {
+        address: this.address ?? "",
+        email: this.email ?? "",
+        name: this.name ?? "",
+        phone: this.phone ?? "",
+    };
+};

package/src/product/billOfLading/index.d.ts

@@ -0,0 +1 @@
+export { BillOfLadingV1 } from "./billOfLadingV1";

package/src/product/billOfLading/index.js

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

package/src/product/billOfLading/internal.d.ts

@@ -0,0 +1,7 @@
+export { BillOfLadingV1 } from "./billOfLadingV1";
+export { BillOfLadingV1Carrier } from "./billOfLadingV1Carrier";
+export { BillOfLadingV1CarrierItem } from "./billOfLadingV1CarrierItem";
+export { BillOfLadingV1Consignee } from "./billOfLadingV1Consignee";
+export { BillOfLadingV1Document } from "./billOfLadingV1Document";
+export { BillOfLadingV1NotifyParty } from "./billOfLadingV1NotifyParty";
+export { BillOfLadingV1Shipper } from "./billOfLadingV1Shipper";

package/src/product/billOfLading/internal.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillOfLadingV1Shipper = exports.BillOfLadingV1NotifyParty = exports.BillOfLadingV1Document = exports.BillOfLadingV1Consignee = exports.BillOfLadingV1CarrierItem = exports.BillOfLadingV1Carrier = exports.BillOfLadingV1 = void 0;
+var billOfLadingV1_1 = require("./billOfLadingV1");
+Object.defineProperty(exports, "BillOfLadingV1", { enumerable: true, get: function () { return billOfLadingV1_1.BillOfLadingV1; } });
+var billOfLadingV1Carrier_1 = require("./billOfLadingV1Carrier");
+Object.defineProperty(exports, "BillOfLadingV1Carrier", { enumerable: true, get: function () { return billOfLadingV1Carrier_1.BillOfLadingV1Carrier; } });
+var billOfLadingV1CarrierItem_1 = require("./billOfLadingV1CarrierItem");
+Object.defineProperty(exports, "BillOfLadingV1CarrierItem", { enumerable: true, get: function () { return billOfLadingV1CarrierItem_1.BillOfLadingV1CarrierItem; } });
+var billOfLadingV1Consignee_1 = require("./billOfLadingV1Consignee");
+Object.defineProperty(exports, "BillOfLadingV1Consignee", { enumerable: true, get: function () { return billOfLadingV1Consignee_1.BillOfLadingV1Consignee; } });
+var billOfLadingV1Document_1 = require("./billOfLadingV1Document");
+Object.defineProperty(exports, "BillOfLadingV1Document", { enumerable: true, get: function () { return billOfLadingV1Document_1.BillOfLadingV1Document; } });
+var billOfLadingV1NotifyParty_1 = require("./billOfLadingV1NotifyParty");
+Object.defineProperty(exports, "BillOfLadingV1NotifyParty", { enumerable: true, get: function () { return billOfLadingV1NotifyParty_1.BillOfLadingV1NotifyParty; } });
+var billOfLadingV1Shipper_1 = require("./billOfLadingV1Shipper");
+Object.defineProperty(exports, "BillOfLadingV1Shipper", { enumerable: true, get: function () { return billOfLadingV1Shipper_1.BillOfLadingV1Shipper; } });

package/src/product/financialDocument/financialDocumentV1Document.d.ts

@@ -2,7 +2,7 @@ import { Prediction, StringDict } from "../../parsing/common";
 import { FinancialDocumentV1LineItem } from "./financialDocumentV1LineItem";
 import { AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, PaymentDetailsField, StringField, Taxes } from "../../parsing/standard";
 /**
- * Financial Document API version 1.9 document data.
+ * Financial Document API version 1.10 document data.
  */
 export declare class FinancialDocumentV1Document implements Prediction {
     /** The customer's address used for billing. */
@@ -31,6 +31,10 @@ export declare class FinancialDocumentV1Document implements Prediction {
     lineItems: FinancialDocumentV1LineItem[];
     /** The locale detected on the document. */
     locale: LocaleField;
+    /** The date on which the payment is due / fullfilled. */
+    paymentDate: DateField;
+    /** The purchase order number. */
+    poNumber: StringField;
     /** The receipt number or identifier only if document is a receipt. */
     receiptNumber: StringField;
     /** List of Reference numbers, including PO number. */

package/src/product/financialDocument/financialDocumentV1Document.js

@@ -5,7 +5,7 @@ const common_1 = require("../../parsing/common");
 const financialDocumentV1LineItem_1 = require("./financialDocumentV1LineItem");
 const standard_1 = require("../../parsing/standard");
 /**
- * Financial Document API version 1.9 document data.
+ * Financial Document API version 1.10 document data.
  */
 class FinancialDocumentV1Document {
     constructor(rawPrediction, pageId) {
@@ -70,6 +70,14 @@ class FinancialDocumentV1Document {
         this.locale = new standard_1.LocaleField({
             prediction: rawPrediction["locale"],
         });
+        this.paymentDate = new standard_1.DateField({
+            prediction: rawPrediction["payment_date"],
+            pageId: pageId,
+        });
+        this.poNumber = new standard_1.StringField({
+            prediction: rawPrediction["po_number"],
+            pageId: pageId,
+        });
         this.receiptNumber = new standard_1.StringField({
             prediction: rawPrediction["receipt_number"],
             pageId: pageId,
@@ -163,11 +171,13 @@ class FinancialDocumentV1Document {
         }
         const outStr = `:Locale: ${this.locale}
 :Invoice Number: ${this.invoiceNumber}
+:Purchase Order Number: ${this.poNumber}
 :Receipt Number: ${this.receiptNumber}
 :Document Number: ${this.documentNumber}
 :Reference Numbers: ${referenceNumbers}
 :Purchase Date: ${this.date}
 :Due Date: ${this.dueDate}
+:Payment Date: ${this.paymentDate}
 :Total Net: ${this.totalNet}
 :Total Amount: ${this.totalAmount}
 :Taxes: ${this.taxes}

package/src/product/financialDocument/financialDocumentV1LineItem.d.ts

@@ -6,21 +6,21 @@ import { Polygon } from "../../geometry";
 export declare class FinancialDocumentV1LineItem {
     #private;
     /** The item description. */
-    description: string | undefined;
+    description: string | null;
     /** The product code referring to the item. */
-    productCode: string | undefined;
+    productCode: string | null;
     /** The item quantity */
-    quantity: number | undefined;
+    quantity: number | null;
     /** The item tax amount. */
-    taxAmount: number | undefined;
+    taxAmount: number | null;
     /** The item tax rate in percentage. */
-    taxRate: number | undefined;
+    taxRate: number | null;
     /** The item total amount. */
-    totalAmount: number | undefined;
+    totalAmount: number | null;
     /** The item unit of measure. */
-    unitMeasure: string | undefined;
+    unitMeasure: string | null;
     /** The item unit price. */
-    unitPrice: number | undefined;
+    unitPrice: number | null;
     /** Confidence score */
     confidence: number;
     /** The document page on which the information was found. */

package/src/product/financialDocument/financialDocumentV1LineItem.js

@@ -7,7 +7,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _FinancialDocumentV1LineItem_instances, _FinancialDocumentV1LineItem_printableValues;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FinancialDocumentV1LineItem = void 0;
-const standard_1 = require("../../parsing/standard");
+const common_1 = require("../../parsing/common");
 /**
  * List of line item details.
  */
@@ -23,21 +23,46 @@ class FinancialDocumentV1LineItem {
         this.polygon = [];
         this.description = prediction["description"];
         this.productCode = prediction["product_code"];
-        if (prediction["quantity"] && !isNaN(prediction["quantity"])) {
-            this.quantity = +parseFloat(prediction["quantity"]).toFixed(3);
+        if (prediction["quantity"] !== undefined &&
+            prediction["quantity"] !== null &&
+            !isNaN(prediction["quantity"])) {
+            this.quantity = +parseFloat(prediction["quantity"]);
         }
-        if (prediction["tax_amount"] && !isNaN(prediction["tax_amount"])) {
-            this.taxAmount = +parseFloat(prediction["tax_amount"]).toFixed(3);
+        else {
+            this.quantity = null;
         }
-        if (prediction["tax_rate"] && !isNaN(prediction["tax_rate"])) {
-            this.taxRate = +parseFloat(prediction["tax_rate"]).toFixed(3);
+        if (prediction["tax_amount"] !== undefined &&
+            prediction["tax_amount"] !== null &&
+            !isNaN(prediction["tax_amount"])) {
+            this.taxAmount = +parseFloat(prediction["tax_amount"]);
         }
-        if (prediction["total_amount"] && !isNaN(prediction["total_amount"])) {
-            this.totalAmount = +parseFloat(prediction["total_amount"]).toFixed(3);
+        else {
+            this.taxAmount = null;
+        }
+        if (prediction["tax_rate"] !== undefined &&
+            prediction["tax_rate"] !== null &&
+            !isNaN(prediction["tax_rate"])) {
+            this.taxRate = +parseFloat(prediction["tax_rate"]);
+        }
+        else {
+            this.taxRate = null;
+        }
+        if (prediction["total_amount"] !== undefined &&
+            prediction["total_amount"] !== null &&
+            !isNaN(prediction["total_amount"])) {
+            this.totalAmount = +parseFloat(prediction["total_amount"]);
+        }
+        else {
+            this.totalAmount = null;
         }
         this.unitMeasure = prediction["unit_measure"];
-        if (prediction["unit_price"] && !isNaN(prediction["unit_price"])) {
-            this.unitPrice = +parseFloat(prediction["unit_price"]).toFixed(3);
+        if (prediction["unit_price"] !== undefined &&
+            prediction["unit_price"] !== null &&
+            !isNaN(prediction["unit_price"])) {
+            this.unitPrice = +parseFloat(prediction["unit_price"]);
+        }
+        else {
+            this.unitPrice = null;
         }
         this.pageId = prediction["page_id"];
         this.confidence = prediction["confidence"] ? prediction.confidence : 0.0;
@@ -96,23 +121,23 @@ _FinancialDocumentV1LineItem_instances = new WeakSet(), _FinancialDocumentV1Line
     return {
         description: this.description ?
             this.description.length <= 36 ?
-                this.description :
-                this.description.slice(0, 33) + "..." :
+                (0, common_1.cleanSpecialChars)(this.description) :
+                (0, common_1.cleanSpecialChars)(this.description).slice(0, 33) + "..." :
             "",
         productCode: this.productCode ?
             this.productCode.length <= 12 ?
-                this.productCode :
-                this.productCode.slice(0, 9) + "..." :
+                (0, common_1.cleanSpecialChars)(this.productCode) :
+                (0, common_1.cleanSpecialChars)(this.productCode).slice(0, 9) + "..." :
             "",
-        quantity: this.quantity !== undefined ? (0, standard_1.floatToString)(this.quantity) : "",
-        taxAmount: this.taxAmount !== undefined ? (0, standard_1.floatToString)(this.taxAmount) : "",
-        taxRate: this.taxRate !== undefined ? (0, standard_1.floatToString)(this.taxRate) : "",
-        totalAmount: this.totalAmount !== undefined ? (0, standard_1.floatToString)(this.totalAmount) : "",
+        quantity: this.quantity !== undefined ? (0, common_1.floatToString)(this.quantity) : "",
+        taxAmount: this.taxAmount !== undefined ? (0, common_1.floatToString)(this.taxAmount) : "",
+        taxRate: this.taxRate !== undefined ? (0, common_1.floatToString)(this.taxRate) : "",
+        totalAmount: this.totalAmount !== undefined ? (0, common_1.floatToString)(this.totalAmount) : "",
         unitMeasure: this.unitMeasure ?
             this.unitMeasure.length <= 15 ?
-                this.unitMeasure :
-                this.unitMeasure.slice(0, 12) + "..." :
+                (0, common_1.cleanSpecialChars)(this.unitMeasure) :
+                (0, common_1.cleanSpecialChars)(this.unitMeasure).slice(0, 12) + "..." :
             "",
-        unitPrice: this.unitPrice !== undefined ? (0, standard_1.floatToString)(this.unitPrice) : "",
+        unitPrice: this.unitPrice !== undefined ? (0, common_1.floatToString)(this.unitPrice) : "",
     };
 };

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

@@ -6,13 +6,13 @@ import { Polygon } from "../../../geometry";
 export declare class BankAccountDetailsV2Bban {
     #private;
     /** The BBAN bank code outputted as a string. */
-    bbanBankCode: string | undefined;
+    bbanBankCode: string | null;
     /** The BBAN branch code outputted as a string. */
-    bbanBranchCode: string | undefined;
+    bbanBranchCode: string | null;
     /** The BBAN key outputted as a string. */
-    bbanKey: string | undefined;
+    bbanKey: string | null;
     /** The BBAN Account number outputted as a string. */
-    bbanNumber: string | undefined;
+    bbanNumber: string | null;
     /** Confidence score */
     confidence: number;
     /** The document page on which the information was found. */

package/src/product/fr/energyBill/energyBillV1.d.ts

@@ -0,0 +1,16 @@
+import { Inference, StringDict, Page } from "../../../parsing/common";
+import { EnergyBillV1Document } from "./energyBillV1Document";
+/**
+ * Energy Bill API version 1 inference prediction.
+ */
+export declare class EnergyBillV1 extends Inference {
+    /** The endpoint's name. */
+    endpointName: string;
+    /** The endpoint's version. */
+    endpointVersion: string;
+    /** The document-level prediction. */
+    prediction: EnergyBillV1Document;
+    /** The document's pages. */
+    pages: Page<EnergyBillV1Document>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/product/fr/energyBill/energyBillV1.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnergyBillV1 = void 0;
+const common_1 = require("../../../parsing/common");
+const energyBillV1Document_1 = require("./energyBillV1Document");
+/**
+ * Energy Bill API version 1 inference prediction.
+ */
+class EnergyBillV1 extends common_1.Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "energy_bill_fra";
+        /** The endpoint's version. */
+        this.endpointVersion = "1";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new energyBillV1Document_1.EnergyBillV1Document(rawPrediction["prediction"]);
+        rawPrediction["pages"].forEach((page) => {
+            if (page.prediction !== undefined && page.prediction !== null &&
+                Object.keys(page.prediction).length > 0) {
+                this.pages.push(new common_1.Page(energyBillV1Document_1.EnergyBillV1Document, page, page["id"], page["orientation"]));
+            }
+        });
+    }
+}
+exports.EnergyBillV1 = EnergyBillV1;