mindee 3.7.4 → 3.9.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # CHANGELOG
 
+## v3.9.0 - 2023-06-06
+### Changes
+* :sparkles: support for financial document v1.1
+* :recycle: change http status code handling for async requests
+
+### Fixes
+* :bug: fix typing in PaymentDetails
+* :bug: locale value should always be set
+* :bug: add missing class properties on new line items
+
+
+## v3.8.0 - 2023-05-25
+### Changes
+* :sparkles: add support for receipt v5
+* :sparkles: print taxes in table layout
+
+
 ## v3.7.4 - 2023-04-20
 ### Changes
 * :white_check_mark: minor improvements to tests

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "3.7.4",
+    "version": "3.9.0",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",
@@ -48,11 +48,11 @@
         "eslint": "^8.32.0",
         "eslint-config-prettier": "^8.6.0",
         "eslint-plugin-prettier": "^4.2.1",
-        "typedoc": "~0.23",
         "mocha": "^10.1.0",
         "prettier": "^2.8.1",
         "ts-node": "^10.9.1",
-        "typescript": "^5.0.3"
+        "typedoc": "~0.23",
+        "typescript": "^5.0.4"
     },
     "dependencies": {
         "commander": "~9.4.1",

package/src/cli.js

@@ -72,7 +72,7 @@ const CLI_COMMAND_CONFIG = new Map([
         "receipt",
         {
             displayName: "Expense Receipt",
-            docClass: _1.ReceiptV4,
+            docClass: _1.ReceiptV5,
             fullText: true,
             async: false,
             sync: true,

package/src/client.js

@@ -51,7 +51,7 @@ class DocumentClient {
         if (this.inputSource === undefined) {
             throw new Error("The 'enqueue' function requires an input document.");
         }
-        return await docConfig.asyncPredict({
+        return await docConfig.predictAsync({
             inputDoc: this.inputSource,
             includeWords: this.getBooleanParam(params.fullText),
             pageOptions: params.pageOptions,
@@ -136,6 +136,9 @@ class Client {
         this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.ReceiptV4.name], new documentConfig_1.DocumentConfig(documents_1.ReceiptV4, [
             new api_1.StandardEndpoint("expense_receipts", "4", this.apiKey),
         ]));
+        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.ReceiptV5.name], new documentConfig_1.DocumentConfig(documents_1.ReceiptV5, [
+            new api_1.StandardEndpoint("expense_receipts", "5", this.apiKey),
+        ]));
         this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.PassportV1.name], new documentConfig_1.DocumentConfig(documents_1.PassportV1, [
             new api_1.StandardEndpoint("passport", "1", this.apiKey),
         ]));

package/src/documents/documentConfig.d.ts

@@ -19,7 +19,7 @@ export declare class DocumentConfig<DocType extends Document> {
         pageOptions?: PageOptions;
         cropper: boolean;
     }): Promise<Response<DocType>>;
-    asyncPredict(params: {
+    predictAsync(params: {
         inputDoc: InputSource;
         includeWords: boolean;
         pageOptions?: PageOptions;

package/src/documents/documentConfig.js

@@ -19,7 +19,7 @@ class DocumentConfig {
         const response = await this.predictRequest(params.inputDoc, params.includeWords, params.cropper);
         return this.buildResult(response, params.inputDoc);
     }
-    async asyncPredict(params) {
+    async predictAsync(params) {
         this.checkApiKeys();
         await params.inputDoc.init();
         if (params.pageOptions !== undefined) {
@@ -27,7 +27,7 @@ class DocumentConfig {
         }
         const response = await this.endpoints[0].predictAsyncReqPost(params.inputDoc, params.includeWords, params.cropper);
         const statusCode = response.messageObj.statusCode;
-        if (statusCode === undefined || statusCode >= 202) {
+        if (statusCode === undefined || statusCode >= 300) {
             this.handleError(response, statusCode);
         }
         return new api_1.AsyncPredictResponse(response.data);
@@ -38,7 +38,7 @@ class DocumentConfig {
         const queueStatusCode = queueResponse.messageObj.statusCode;
         if (queueStatusCode === undefined ||
             queueStatusCode < 200 ||
-            queueStatusCode > 302) {
+            queueStatusCode >= 400) {
             this.handleError(queueResponse, queueStatusCode);
         }
         if (queueStatusCode === 302 &&

package/src/documents/financialDocument/financialDocumentV1.d.ts

@@ -1,54 +1,57 @@
 import { Document, DocumentConstructorProps } from "../document";
-import { TaxField, PaymentDetails, Locale, Amount, TextField, DateField, CompanyRegistration, BaseField } from "../../fields";
-import { InvoiceLineItem } from "../invoice/invoiceLineItem";
+import { Amount, ClassificationField, CompanyRegistration, DateField, Locale, PaymentDetails, TaxField, TextField } from "../../fields";
+import { FinancialDocumentV1LineItem } from "./financialDocumentV1LineItem";
 /**
- * Financial Document.
+ * Document data for Financial Document, API version 1.
  */
 export declare class FinancialDocumentV1 extends Document {
-    /** Locale information. */
+    #private;
+    /** The locale detected on the document. */
     locale: Locale;
-    /** The nature of the document. */
-    documentType: BaseField;
-    /** List of Reference numbers including PO number. */
+    /** The invoice number or identifier. */
+    invoiceNumber: TextField;
+    /** List of Reference numbers, including PO number. */
     referenceNumbers: TextField[];
-    /** The creation date of the invoice or the purchase date. */
+    /** The date the purchase was made. */
     date: DateField;
-    /** The due date of the invoice. */
+    /** The date on which the payment is due. */
     dueDate: DateField;
-    /** The supplier name. */
-    supplierName: TextField;
-    /** The supplier address. */
-    supplierAddress: TextField;
-    /** The payment information. */
+    /** The net amount paid: does not include taxes, fees, and discounts. */
+    totalNet: Amount;
+    /** The total amount paid: includes taxes, tips, fees, and other charges. */
+    totalAmount: Amount;
+    /** List of tax lines information. */
+    taxes: TaxField[];
+    /** List of payment details associated to the supplier. */
     supplierPaymentDetails: PaymentDetails[];
-    /** The supplier company registration information. */
+    /** The name of the supplier or merchant. */
+    supplierName: TextField;
+    /** List of company registrations associated to the supplier. */
     supplierCompanyRegistrations: CompanyRegistration[];
-    /** The invoice number. */
-    invoiceNumber: TextField;
+    /** The address of the supplier or merchant. */
+    supplierAddress: TextField;
+    /** The phone number of the supplier or merchant. */
+    supplierPhoneNumber: TextField;
     /** The name of the customer. */
     customerName: TextField;
+    /** List of company registrations associated to the customer. */
+    customerCompanyRegistrations: CompanyRegistration[];
     /** The address of the customer. */
     customerAddress: TextField;
-    /** The company registration information for the customer. */
-    customerCompanyRegistrations: CompanyRegistration[];
-    /** The list of the taxes. */
-    taxes: TaxField[];
-    /** Line items details. */
-    lineItems: InvoiceLineItem[];
-    /** The receipt category among predefined classes. */
-    category: TextField;
-    /** The receipt sub-category among predefined classes. */
-    subCategory: TextField;
-    /** Time as seen on the receipt in HH:MM format. */
-    time: TextField;
-    /** Total amount of tip and gratuity. */
-    tip: Amount;
-    /** total spent including taxes, discounts, fees, tips, and gratuity. */
-    totalAmount: Amount;
-    /** Total amount of the purchase excluding taxes. */
-    totalNet: Amount;
-    /** Total tax amount of the purchase. */
+    /** One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'. */
+    documentType: ClassificationField;
+    /** The purchase subcategory among predefined classes for transport and food. */
+    subcategory: ClassificationField;
+    /** The purchase category among predefined classes. */
+    category: ClassificationField;
+    /** The total amount of taxes. */
     totalTax: Amount;
+    /** The total amount of tip and gratuity */
+    tip: Amount;
+    /** The time the purchase was made. */
+    time: TextField;
+    /** List of line item details. */
+    lineItems: FinancialDocumentV1LineItem[];
     constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);
     toString(): string;
 }

package/src/documents/financialDocument/financialDocumentV1.js

@@ -1,11 +1,17 @@
 "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 _FinancialDocumentV1_instances, _FinancialDocumentV1_lineItemsSeparator, _FinancialDocumentV1_lineItemsToString;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FinancialDocumentV1 = void 0;
 const document_1 = require("../document");
 const fields_1 = require("../../fields");
-const invoiceLineItem_1 = require("../invoice/invoiceLineItem");
+const financialDocumentV1LineItem_1 = require("./financialDocumentV1LineItem");
 /**
- * Financial Document.
+ * Document data for Financial Document, API version 1.
  */
 class FinancialDocumentV1 extends document_1.Document {
     constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, fullText = undefined, pageId = undefined, }) {
@@ -13,169 +19,179 @@ class FinancialDocumentV1 extends document_1.Document {
             inputSource: inputSource,
             pageId: pageId,
             orientation: orientation,
-            fullText: fullText,
             extras: extras,
+            fullText: fullText,
         });
-        /** List of Reference numbers including PO number. */
+        _FinancialDocumentV1_instances.add(this);
+        /** List of Reference numbers, including PO number. */
         this.referenceNumbers = [];
-        /** The payment information. */
+        /** List of payment details associated to the supplier. */
         this.supplierPaymentDetails = [];
-        /** The supplier company registration information. */
+        /** List of company registrations associated to the supplier. */
         this.supplierCompanyRegistrations = [];
-        /** The company registration information for the customer. */
+        /** List of company registrations associated to the customer. */
         this.customerCompanyRegistrations = [];
-        /** The list of the taxes. */
-        this.taxes = [];
-        /** Line items details. */
+        /** List of line item details. */
         this.lineItems = [];
         this.locale = new fields_1.Locale({
-            prediction: prediction.locale,
+            prediction: prediction["locale"],
             valueKey: "language",
         });
-        this.documentType = new fields_1.BaseField({
-            prediction: prediction.document_type,
-            valueKey: "value",
-        });
-        this.referenceNumbers = prediction.reference_numbers.map(function (prediction) {
-            return new fields_1.TextField({
-                prediction: prediction,
-                pageId: pageId,
-            });
+        this.invoiceNumber = new fields_1.TextField({
+            prediction: prediction["invoice_number"],
+            pageId: pageId,
         });
-        this.totalAmount = new fields_1.Amount({
-            prediction: prediction.total_amount,
-            valueKey: "value",
+        prediction["reference_numbers"].map((itemPrediction) => this.referenceNumbers.push(new fields_1.TextField({
+            prediction: itemPrediction,
+            pageId: pageId,
+        })));
+        this.date = new fields_1.DateField({
+            prediction: prediction["date"],
             pageId: pageId,
         });
-        this.totalTax = new fields_1.Amount({
-            prediction: prediction.total_tax,
-            valueKey: "value",
+        this.dueDate = new fields_1.DateField({
+            prediction: prediction["due_date"],
             pageId: pageId,
         });
         this.totalNet = new fields_1.Amount({
-            prediction: prediction.total_net,
-            valueKey: "value",
+            prediction: prediction["total_net"],
             pageId: pageId,
         });
-        this.date = new fields_1.DateField({
-            prediction: prediction.date,
-            pageId,
-        });
-        this.dueDate = new fields_1.DateField({
-            prediction: prediction.due_date,
+        this.totalAmount = new fields_1.Amount({
+            prediction: prediction["total_amount"],
             pageId: pageId,
         });
-        this.invoiceNumber = new fields_1.TextField({
-            prediction: prediction.invoice_number,
+        this.taxes = new fields_1.Taxes().init(prediction["taxes"], pageId);
+        prediction["supplier_payment_details"].map((itemPrediction) => this.supplierPaymentDetails.push(new fields_1.PaymentDetails({
+            prediction: itemPrediction,
             pageId: pageId,
-        });
+        })));
         this.supplierName = new fields_1.TextField({
-            prediction: prediction.supplier_name,
+            prediction: prediction["supplier_name"],
             pageId: pageId,
         });
+        prediction["supplier_company_registrations"].map((itemPrediction) => this.supplierCompanyRegistrations.push(new fields_1.CompanyRegistration({
+            prediction: itemPrediction,
+            pageId: pageId,
+        })));
         this.supplierAddress = new fields_1.TextField({
-            prediction: prediction.supplier_address,
+            prediction: prediction["supplier_address"],
             pageId: pageId,
         });
-        this.supplierCompanyRegistrations =
-            prediction.supplier_company_registrations.map(function (prediction) {
-                return new fields_1.CompanyRegistration({
-                    prediction: prediction,
-                    pageId: pageId,
-                });
-            });
-        this.customerName = new fields_1.TextField({
-            prediction: prediction.customer_name,
+        this.supplierPhoneNumber = new fields_1.TextField({
+            prediction: prediction["supplier_phone_number"],
             pageId: pageId,
         });
-        this.customerAddress = new fields_1.TextField({
-            prediction: prediction.customer_address,
+        this.customerName = new fields_1.TextField({
+            prediction: prediction["customer_name"],
             pageId: pageId,
         });
-        prediction.customer_company_registrations.map((prediction) => this.customerCompanyRegistrations.push(new fields_1.CompanyRegistration({
-            prediction: prediction,
-            pageId: pageId,
-        })));
-        prediction.supplier_payment_details.map((prediction) => this.supplierPaymentDetails.push(new fields_1.PaymentDetails({
-            prediction: prediction,
+        prediction["customer_company_registrations"].map((itemPrediction) => this.customerCompanyRegistrations.push(new fields_1.CompanyRegistration({
+            prediction: itemPrediction,
             pageId: pageId,
         })));
-        prediction.line_items.map((prediction) => this.lineItems.push(new invoiceLineItem_1.InvoiceLineItem({
-            prediction: prediction,
-        })));
-        this.tip = new fields_1.Amount({
-            prediction: prediction.tip,
-            valueKey: "value",
+        this.customerAddress = new fields_1.TextField({
+            prediction: prediction["customer_address"],
             pageId: pageId,
         });
-        this.category = new fields_1.TextField({
-            prediction: prediction.category,
+        this.documentType = new fields_1.ClassificationField({
+            prediction: prediction["document_type"],
+        });
+        this.subcategory = new fields_1.ClassificationField({
+            prediction: prediction["subcategory"],
+        });
+        this.category = new fields_1.ClassificationField({
+            prediction: prediction["category"],
+        });
+        this.totalTax = new fields_1.Amount({
+            prediction: prediction["total_tax"],
             pageId: pageId,
         });
-        this.subCategory = new fields_1.TextField({
-            prediction: prediction.subcategory,
+        this.tip = new fields_1.Amount({
+            prediction: prediction["tip"],
             pageId: pageId,
         });
         this.time = new fields_1.TextField({
-            prediction: prediction.time,
+            prediction: prediction["time"],
             pageId: pageId,
         });
-        prediction.taxes.map((taxPrediction) => this.taxes.push(new fields_1.TaxField({
-            prediction: taxPrediction,
+        prediction["line_items"].map((itemPrediction) => this.lineItems.push(new financialDocumentV1LineItem_1.FinancialDocumentV1LineItem({
+            prediction: itemPrediction,
             pageId: pageId,
-            valueKey: "value",
-            rateKey: "rate",
-            codeKey: "code",
-            baseKey: "base",
         })));
     }
     toString() {
-        const taxes = this.taxes.map((item) => item.toString()).join("\n       ");
         const referenceNumbers = this.referenceNumbers
             .map((item) => item.toString())
             .join(", ");
-        const paymentDetails = this.supplierPaymentDetails
+        const supplierPaymentDetails = this.supplierPaymentDetails
             .map((item) => item.toString())
             .join("\n                 ");
-        const customerCompanyRegistration = this.customerCompanyRegistrations
+        const customerCompanyRegistrations = this.customerCompanyRegistrations
             .map((item) => item.toString())
             .join("; ");
-        const supplierCompanyRegistration = this.supplierCompanyRegistrations
+        const supplierCompanyRegistrations = this.supplierCompanyRegistrations
             .map((item) => item.toString())
             .join("; ");
-        let lineItems = "";
-        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 = `----- Financial Document V1 -----
-Filename: ${this.filename}
-Document type: ${this.documentType}
-Category: ${this.category}
-Subcategory: ${this.subCategory}
-Locale: ${this.locale}
-Invoice number: ${this.invoiceNumber}
-Reference numbers: ${referenceNumbers}
-Date: ${this.date}
-Due date: ${this.dueDate}
-Time: ${this.time}
-Supplier name: ${this.supplierName}
-Supplier address: ${this.supplierAddress}
-Supplier company registrations: ${supplierCompanyRegistration}
-Supplier payment details: ${paymentDetails}
-Customer name: ${this.customerName}
-Customer address: ${this.customerAddress}
-Customer company registrations: ${customerCompanyRegistration}
-Tip: ${this.tip}
-Taxes: ${taxes}
-Total tax: ${this.totalTax}
-Total net: ${this.totalNet}
-Total amount: ${this.totalAmount}
-Line Items: ${lineItems}
-----------------------
+        const outStr = `Financial Document V1 Prediction
+================================
+:Filename: ${this.filename}
+:Locale: ${this.locale}
+: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}
+:Supplier Payment Details: ${supplierPaymentDetails}
+:Supplier name: ${this.supplierName}
+:Supplier Company Registrations: ${customerCompanyRegistrations}
+:Supplier Address: ${this.supplierAddress}
+:Supplier Phone Number: ${this.supplierPhoneNumber}
+:Customer name: ${this.customerName}
+:Customer Company Registrations: ${supplierCompanyRegistrations}
+:Customer Address: ${this.customerAddress}
+:Document Type: ${this.documentType}
+:Purchase Subcategory: ${this.subcategory}
+:Purchase Category: ${this.category}
+:Total Tax: ${this.totalTax}
+:Tip and Gratuity: ${this.tip}
+:Purchase Time: ${this.time}
+:Line Items: ${__classPrivateFieldGet(this, _FinancialDocumentV1_instances, "m", _FinancialDocumentV1_lineItemsToString).call(this)}
 `;
         return FinancialDocumentV1.cleanOutString(outStr);
     }
 }
 exports.FinancialDocumentV1 = FinancialDocumentV1;
+_FinancialDocumentV1_instances = new WeakSet(), _FinancialDocumentV1_lineItemsSeparator = function _FinancialDocumentV1_lineItemsSeparator(char) {
+    let outStr = "  ";
+    outStr += `+${char.repeat(38)}`;
+    outStr += `+${char.repeat(14)}`;
+    outStr += `+${char.repeat(10)}`;
+    outStr += `+${char.repeat(12)}`;
+    outStr += `+${char.repeat(14)}`;
+    outStr += `+${char.repeat(14)}`;
+    outStr += `+${char.repeat(12)}`;
+    return outStr + "+";
+}, _FinancialDocumentV1_lineItemsToString = function _FinancialDocumentV1_lineItemsToString() {
+    if (this.lineItems.length === 0) {
+        return "";
+    }
+    const lines = this.lineItems
+        .map((item) => item.toTableLine())
+        .join(`\n${__classPrivateFieldGet(this, _FinancialDocumentV1_instances, "m", _FinancialDocumentV1_lineItemsSeparator).call(this, "-")}\n  `);
+    let outStr = "";
+    outStr += `\n${__classPrivateFieldGet(this, _FinancialDocumentV1_instances, "m", _FinancialDocumentV1_lineItemsSeparator).call(this, "-")}\n `;
+    outStr += " | Description                         ";
+    outStr += " | Product code";
+    outStr += " | Quantity";
+    outStr += " | Tax Amount";
+    outStr += " | Tax Rate (%)";
+    outStr += " | Total Amount";
+    outStr += " | Unit Price";
+    outStr += ` |\n${__classPrivateFieldGet(this, _FinancialDocumentV1_instances, "m", _FinancialDocumentV1_lineItemsSeparator).call(this, "=")}`;
+    outStr += `\n  ${lines}`;
+    outStr += `\n${__classPrivateFieldGet(this, _FinancialDocumentV1_instances, "m", _FinancialDocumentV1_lineItemsSeparator).call(this, "-")}`;
+    return outStr;
+};

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

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