mindee 4.3.1 → 4.3.3

package/src/product/invoice/invoiceV4Document.js

@@ -1,67 +1,44 @@
 "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 common_1 = require("../../parsing/common");
 const invoiceV4LineItem_1 = require("./invoiceV4LineItem");
+const standard_1 = require("../../parsing/standard");
 /**
  * Document data for Invoice, API version 4.
  */
 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. */
+        /** List of company registrations associated to the customer. */
         this.customerCompanyRegistrations = [];
-        /** Line items details. */
+        /** List of line item 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 },
+        /** List of Reference numbers, including PO number. */
+        this.referenceNumbers = [];
+        /** List of company registrations associated to the supplier. */
+        this.supplierCompanyRegistrations = [];
+        /** List of payment details associated to the supplier. */
+        this.supplierPaymentDetails = [];
+        this.customerAddress = new standard_1.StringField({
+            prediction: rawPrediction["customer_address"],
             pageId: pageId,
         });
-        this.totalNet = new standard_1.AmountField({
-            prediction: rawPrediction["total_net"],
+        rawPrediction["customer_company_registrations"] &&
+            rawPrediction["customer_company_registrations"].map((itemPrediction) => this.customerCompanyRegistrations.push(new standard_1.CompanyRegistrationField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+        this.customerName = new standard_1.StringField({
+            prediction: rawPrediction["customer_name"],
             pageId: pageId,
         });
         this.date = new standard_1.DateField({
             prediction: rawPrediction["date"],
-            pageId,
+            pageId: pageId,
+        });
+        this.documentType = new standard_1.ClassificationField({
+            prediction: rawPrediction["document_type"],
         });
-        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,
@@ -70,79 +47,87 @@ class InvoiceV4Document {
             prediction: rawPrediction["invoice_number"],
             pageId: pageId,
         });
-        this.supplierName = new standard_1.StringField({
-            prediction: rawPrediction["supplier_name"],
-            pageId: pageId,
+        rawPrediction["line_items"] &&
+            rawPrediction["line_items"].map((itemPrediction) => this.lineItems.push(new invoiceV4LineItem_1.InvoiceV4LineItem({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+        this.locale = new standard_1.LocaleField({
+            prediction: rawPrediction["locale"],
         });
+        rawPrediction["reference_numbers"] &&
+            rawPrediction["reference_numbers"].map((itemPrediction) => this.referenceNumbers.push(new standard_1.StringField({
+                prediction: itemPrediction,
+                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,
+        rawPrediction["supplier_company_registrations"] &&
+            rawPrediction["supplier_company_registrations"].map((itemPrediction) => this.supplierCompanyRegistrations.push(new standard_1.CompanyRegistrationField({
+                prediction: itemPrediction,
                 pageId: pageId,
             })));
+        this.supplierName = new standard_1.StringField({
+            prediction: rawPrediction["supplier_name"],
+            pageId: pageId,
+        });
         rawPrediction["supplier_payment_details"] &&
-            rawPrediction["supplier_payment_details"].forEach((prediction) => this.supplierPaymentDetails.push(new standard_1.PaymentDetailsField({
-                prediction: prediction,
+            rawPrediction["supplier_payment_details"].map((itemPrediction) => this.supplierPaymentDetails.push(new standard_1.PaymentDetailsField({
+                prediction: itemPrediction,
                 pageId: pageId,
             })));
-        rawPrediction["line_items"] &&
-            rawPrediction["line_items"].forEach((prediction) => this.lineItems.push(new invoiceV4LineItem_1.InvoiceV4LineItem(prediction)));
+        this.taxes = new standard_1.Taxes().init(rawPrediction["taxes"], pageId);
+        this.totalAmount = new standard_1.AmountField({
+            prediction: rawPrediction["total_amount"],
+            pageId: pageId,
+        });
+        this.totalNet = new standard_1.AmountField({
+            prediction: rawPrediction["total_net"],
+            pageId: pageId,
+        });
     }
+    /**
+     * Default string representation.
+     */
     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 referenceNumbers = this.referenceNumbers.join("\n                    ");
+        const supplierPaymentDetails = this.supplierPaymentDetails.join("\n                           ");
+        const supplierCompanyRegistrations = this.supplierCompanyRegistrations.join("\n                                 ");
+        const customerCompanyRegistrations = this.customerCompanyRegistrations.join("\n                                 ");
+        let lineItemsSummary = "";
+        if (this.lineItems && this.lineItems.length > 0) {
+            const lineItemsColSizes = [38, 14, 10, 12, 14, 14, 12];
+            lineItemsSummary += "\n" + (0, common_1.lineSeparator)(lineItemsColSizes, "-") + "\n  ";
+            lineItemsSummary += "| Description                          ";
+            lineItemsSummary += "| Product code ";
+            lineItemsSummary += "| Quantity ";
+            lineItemsSummary += "| Tax Amount ";
+            lineItemsSummary += "| Tax Rate (%) ";
+            lineItemsSummary += "| Total Amount ";
+            lineItemsSummary += "| Unit Price ";
+            lineItemsSummary += "|\n" + (0, common_1.lineSeparator)(lineItemsColSizes, "=");
+            lineItemsSummary += this.lineItems.map((item) => "\n  " + item.toTableLine() + "\n" + (0, common_1.lineSeparator)(lineItemsColSizes, "-")).join("");
         }
         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}
+:Invoice Number: ${this.invoiceNumber}
+:Reference Numbers: ${referenceNumbers}
+:Purchase Date: ${this.date}
+:Due Date: ${this.dueDate}
+:Total Net: ${this.totalNet}
+:Total Amount: ${this.totalAmount}
 :Taxes: ${this.taxes}
-:Total net: ${this.totalNet}
-:Total tax: ${this.totalTax}
-:Total amount: ${this.totalAmount}
-:Line Items: ${lineItems}`;
-        return (0, summaryHelper_1.cleanOutString)(outStr);
+:Supplier Payment Details: ${supplierPaymentDetails}
+:Supplier Name: ${this.supplierName}
+:Supplier Company Registrations: ${supplierCompanyRegistrations}
+:Supplier Address: ${this.supplierAddress}
+:Customer Name: ${this.customerName}
+:Customer Company Registrations: ${customerCompanyRegistrations}
+:Customer Address: ${this.customerAddress}
+:Document Type: ${this.documentType}
+:Line Items: ${lineItemsSummary}`.trimEnd();
+        return (0, common_1.cleanOutString)(outStr);
     }
 }
 exports.InvoiceV4Document = InvoiceV4Document;

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

@@ -1,24 +1,24 @@
-import { Polygon } from "../../geometry";
 import { StringDict } from "../../parsing/common";
+import { Polygon } from "../../geometry";
 /**
  * List of line item details.
  */
 export declare class InvoiceV4LineItem {
     #private;
-    /** The product code referring to the item. */
-    productCode: string;
     /** The item description. */
-    description: string;
-    /** The item quantity  */
+    description: string | undefined;
+    /** The product code referring to the item. */
+    productCode: string | undefined;
+    /** The item quantity */
     quantity: number | undefined;
-    /** The item unit price. */
-    unitPrice: number | undefined;
-    /** The item total amount. */
-    totalAmount: number | undefined;
-    /** The item tax rate in percentage. */
-    taxRate: number | undefined;
     /** The item tax amount. */
     taxAmount: number | undefined;
+    /** The item tax rate in percentage. */
+    taxRate: number | undefined;
+    /** The item total amount. */
+    totalAmount: number | undefined;
+    /** The item unit price. */
+    unitPrice: number | undefined;
     /** Confidence score */
     confidence: number;
     /** The document page on which the information was found. */
@@ -28,13 +28,13 @@ export declare class InvoiceV4LineItem {
      * the field in the document.
      */
     polygon: Polygon;
-    constructor(rawPrediction: StringDict);
-    /**
-     * Output in a format suitable for inclusion in an rST table.
-     */
-    toTableLine(): string;
+    constructor({ prediction }: StringDict);
     /**
      * Default string representation.
      */
     toString(): string;
+    /**
+     * Output in a format suitable for inclusion in an rST table.
+     */
+    toTableLine(): string;
 }

package/src/product/invoice/invoiceV4LineItem.js

@@ -12,7 +12,7 @@ const standard_1 = require("../../parsing/standard");
  * List of line item details.
  */
 class InvoiceV4LineItem {
-    constructor(rawPrediction) {
+    constructor({ prediction = {} }) {
         _InvoiceV4LineItem_instances.add(this);
         /** Confidence score */
         this.confidence = 0.0;
@@ -21,90 +21,88 @@ class InvoiceV4LineItem {
          * the field in the document.
          */
         this.polygon = [];
-        this.productCode = rawPrediction["product_code"];
-        this.description =
-            rawPrediction["description"] !== undefined
-                ? rawPrediction["description"]
-                : "";
-        this.quantity = +parseFloat(rawPrediction["quantity"]).toFixed(3);
-        if (isNaN(this.quantity)) {
-            this.quantity = undefined;
+        this.description = prediction["description"];
+        this.productCode = prediction["product_code"];
+        if (prediction["quantity"] && !isNaN(prediction["quantity"])) {
+            this.quantity = +parseFloat(prediction["quantity"]).toFixed(3);
         }
-        this.unitPrice = +parseFloat(rawPrediction["unit_price"]).toFixed(3);
-        if (isNaN(this.unitPrice)) {
-            this.unitPrice = undefined;
+        if (prediction["tax_amount"] && !isNaN(prediction["tax_amount"])) {
+            this.taxAmount = +parseFloat(prediction["tax_amount"]).toFixed(3);
         }
-        this.totalAmount = +parseFloat(rawPrediction["total_amount"]).toFixed(3);
-        if (isNaN(this.totalAmount)) {
-            this.totalAmount = undefined;
+        if (prediction["tax_rate"] && !isNaN(prediction["tax_rate"])) {
+            this.taxRate = +parseFloat(prediction["tax_rate"]).toFixed(3);
         }
-        this.taxRate = +parseFloat(rawPrediction["tax_rate"]).toFixed(3);
-        if (isNaN(this.taxRate)) {
-            this.taxRate = undefined;
+        if (prediction["total_amount"] && !isNaN(prediction["total_amount"])) {
+            this.totalAmount = +parseFloat(prediction["total_amount"]).toFixed(3);
         }
-        this.taxAmount = +parseFloat(rawPrediction["tax_amount"]).toFixed(3);
-        if (isNaN(this.taxAmount)) {
-            this.taxAmount = undefined;
+        if (prediction["unit_price"] && !isNaN(prediction["unit_price"])) {
+            this.unitPrice = +parseFloat(prediction["unit_price"]).toFixed(3);
         }
-        this.pageId = rawPrediction["page_id"];
-        this.confidence = rawPrediction["confidence"]
-            ? rawPrediction["confidence"]
-            : 0.0;
-        if (rawPrediction["polygon"]) {
-            this.polygon = rawPrediction["polygon"];
+        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, _InvoiceV4LineItem_instances, "m", _InvoiceV4LineItem_printableValues).call(this);
+        return ("Description: " +
+            printable.description +
+            ", Product code: " +
+            printable.productCode +
+            ", Quantity: " +
+            printable.quantity +
+            ", Tax Amount: " +
+            printable.taxAmount +
+            ", Tax Rate (%): " +
+            printable.taxRate +
+            ", Total Amount: " +
+            printable.totalAmount +
+            ", Unit Price: " +
+            printable.unitPrice);
+    }
     /**
      * Output in a format suitable for inclusion in an rST table.
      */
     toTableLine() {
         const printable = __classPrivateFieldGet(this, _InvoiceV4LineItem_instances, "m", _InvoiceV4LineItem_printableValues).call(this);
         return ("| " +
-            printable.productCode.padEnd(20) +
+            printable.description.padEnd(36) +
             " | " +
-            printable.quantity.padEnd(7) +
+            printable.productCode.padEnd(12) +
             " | " +
-            printable.unitPrice.padEnd(7) +
+            printable.quantity.padEnd(8) +
             " | " +
-            printable.totalAmount.padEnd(8) +
+            printable.taxAmount.padEnd(10) +
             " | " +
-            printable.tax.padEnd(16) +
+            printable.taxRate.padEnd(12) +
             " | " +
-            printable.description.padEnd(36) +
+            printable.totalAmount.padEnd(12) +
+            " | " +
+            printable.unitPrice.padEnd(10) +
             " |");
     }
-    /**
-     * Default string representation.
-     */
-    toString() {
-        const printable = __classPrivateFieldGet(this, _InvoiceV4LineItem_instances, "m", _InvoiceV4LineItem_printableValues).call(this);
-        return ("Code: " +
-            printable.productCode +
-            ", Quantity: " +
-            printable.quantity +
-            ", Price: " +
-            printable.unitPrice +
-            ", Amount: " +
-            printable.totalAmount +
-            ", Tax (Rate): " +
-            printable.tax +
-            " Description: " +
-            printable.description).trim();
-    }
 }
 exports.InvoiceV4LineItem = InvoiceV4LineItem;
 _InvoiceV4LineItem_instances = new WeakSet(), _InvoiceV4LineItem_printableValues = function _InvoiceV4LineItem_printableValues() {
     return {
-        productCode: this.productCode ?? "",
+        description: this.description ?
+            this.description.length <= 36 ?
+                this.description :
+                this.description.slice(0, 33) + "..." :
+            "",
+        productCode: this.productCode ?
+            this.productCode.length <= 12 ?
+                this.productCode :
+                this.productCode.slice(0, 9) + "..." :
+            "",
         quantity: this.quantity !== undefined ? (0, standard_1.floatToString)(this.quantity) : "",
-        unitPrice: this.unitPrice !== undefined ? (0, standard_1.floatToString)(this.unitPrice) : "",
+        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) : "",
-        tax: (this.taxAmount !== undefined ? (0, standard_1.floatToString)(this.taxAmount) : "") +
-            (this.taxRate !== undefined
-                ? " (" + (0, standard_1.floatToString)(this.taxRate) + "%)"
-                : ""),
-        description: this.description.length > 33
-            ? this.description.substring(0, 33) + "..."
-            : this.description,
+        unitPrice: this.unitPrice !== undefined ? (0, standard_1.floatToString)(this.unitPrice) : "",
     };
 };

package/src/product/invoiceSplitter/invoiceSplitterV1Document.d.ts

@@ -1,9 +1,9 @@
-import { Inference, StringDict } from "../../parsing/common";
+import { Prediction, StringDict } from "../../parsing/common";
 import { InvoiceSplitterV1PageGroup } from "./invoiceSplitterV1PageGroup";
 /**
  * Document data for Invoice Splitter, API version 1.
  */
-export declare class InvoiceSplitterV1Document extends Inference {
+export declare class InvoiceSplitterV1Document implements Prediction {
     /** List of page indexes that belong to the same invoice in the PDF. */
     invoicePageGroups: InvoiceSplitterV1PageGroup[];
     constructor(rawPrediction: StringDict);

package/src/product/invoiceSplitter/invoiceSplitterV1Document.js

@@ -6,9 +6,8 @@ const invoiceSplitterV1PageGroup_1 = require("./invoiceSplitterV1PageGroup");
 /**
  * Document data for Invoice Splitter, API version 1.
  */
-class InvoiceSplitterV1Document extends common_1.Inference {
+class InvoiceSplitterV1Document {
     constructor(rawPrediction) {
-        super(rawPrediction);
         /** List of page indexes that belong to the same invoice in the PDF. */
         this.invoicePageGroups = [];
         rawPrediction["invoice_page_groups"] &&

package/src/product/invoiceSplitter/invoiceSplitterV1PageGroup.d.ts

@@ -1,6 +1,6 @@
 import { StringDict } from "../../parsing/common";
 /**
- * Pages indexes in a group.
+ * Pages indexes in a group for Invoice Splitter V1.
  */
 export declare class InvoiceSplitterV1PageGroup {
     /** List of page indexes. */

package/src/product/invoiceSplitter/invoiceSplitterV1PageGroup.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvoiceSplitterV1PageGroup = void 0;
 /**
- * Pages indexes in a group.
+ * Pages indexes in a group for Invoice Splitter V1.
  */
 class InvoiceSplitterV1PageGroup {
     constructor(prediction) {

package/src/product/us/w9/w9V1.d.ts

@@ -2,7 +2,7 @@ import { Inference, StringDict, Page } from "../../../parsing/common";
 import { W9V1Document } from "./w9V1Document";
 import { W9V1Page } from "./w9V1Page";
 /**
- * Inference prediction for US W9, API version 1.
+ * Inference prediction for W9, API version 1.
  */
 export declare class W9V1 extends Inference {
     /** The endpoint's name. */

package/src/product/us/w9/w9V1.js

@@ -5,7 +5,7 @@ const common_1 = require("../../../parsing/common");
 const w9V1Document_1 = require("./w9V1Document");
 const w9V1Page_1 = require("./w9V1Page");
 /**
- * Inference prediction for US W9, API version 1.
+ * Inference prediction for W9, API version 1.
  */
 class W9V1 extends common_1.Inference {
     constructor(rawPrediction) {

package/src/product/us/w9/w9V1Document.d.ts

@@ -1,6 +1,6 @@
 import { Prediction } from "../../../parsing/common";
 /**
- * Document data for US W9, API version 1.
+ * Document data for W9, API version 1.
  */
 export declare class W9V1Document implements Prediction {
     /**

package/src/product/us/w9/w9V1Document.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.W9V1Document = void 0;
 /**
- * Document data for US W9, API version 1.
+ * Document data for W9, API version 1.
  */
 class W9V1Document {
     /**

package/src/product/us/w9/w9V1Page.d.ts

@@ -2,7 +2,7 @@ import { StringDict } from "../../../parsing/common";
 import { PositionField, StringField } from "../../../parsing/standard";
 import { W9V1Document } from "./w9V1Document";
 /**
- * Page data for US W9, API version 1.
+ * Page data for W9, API version 1.
  */
 export declare class W9V1Page extends W9V1Document {
     /** The street address (number, street, and apt. or suite no.) of the applicant. */

package/src/product/us/w9/w9V1Page.js

@@ -5,7 +5,7 @@ const common_1 = require("../../../parsing/common");
 const standard_1 = require("../../../parsing/standard");
 const w9V1Document_1 = require("./w9V1Document");
 /**
- * Page data for US W9, API version 1.
+ * Page data for W9, API version 1.
  */
 class W9V1Page extends w9V1Document_1.W9V1Document {
     constructor(rawPrediction, pageId) {

package/src/http/mindeeApi.d.ts

@@ -1,20 +0,0 @@
-export declare const API_KEY_ENVVAR_NAME = "MINDEE_API_KEY";
-export declare const API_HOST_ENVVAR_NAME = "MINDEE_API_HOST";
-export declare const STANDARD_API_OWNER = "mindee";
-interface MindeeApiConstructorProps {
-    apiKey: string;
-    urlName: string;
-    version: string;
-    owner: string;
-}
-export declare class MindeeApi {
-    apiKey: string;
-    baseHeaders: Record<string, string>;
-    hostname: string;
-    private readonly urlName;
-    private readonly version;
-    constructor({ apiKey, urlName, version, owner, }: MindeeApiConstructorProps);
-    protected apiKeyFromEnv(): string;
-    protected hostnameFromEnv(): string;
-}
-export {};