mindee 3.4.1 → 3.6.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # CHANGELOG
 
+## v3.6.0 - 2023-02-01
+### Changes
+* :sparkles: Add support for the mindee_vision API (for internal testing)
+* :sparkles: support Proof of Address V1
+* :sparkles: Add support for: financial document v1
+* :arrow_up: update jsdoc
+
+### ¡Warning!
+The `FinancialDocumentV1` class now uses an actual API call to the new route `financial_document`.
+Previously, determining whether a document is an invoice or a receipt was done internally by this library.
+
+The API call way is **much** better, however some fields have been renamed compared to the internal handling.
+This was done so field names now match exactly `Invoice` and `Receipt` classes.
+
+As such, we encourage users to migrate to the new field structure.
+
+If this is problematic, it's possible to use the deprecated way.
+Simply pass `FinancialDocumentV0` to the `parse` method.
+Usage is otherwise identical.
+
+## v3.5.0 - 2023-01-17
+### Changes
+* :memo: updates to class documentation
+* :sparkles: Add invoice splitter support (beta)
+
+### Fixes
+* :bug: fix for CLI command option description
+
 ## v3.4.1 - 2023-01-05
 ### Changes
 * :label: Added typing information, get rid of `any` type in various places

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "3.4.1",
+    "version": "3.6.0",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",
@@ -12,7 +12,7 @@
         "test": "mocha 'tests/**/*.spec.ts'",
         "lint-fix": "eslint '**/*.ts' --fix",
         "lint": "eslint '**/*.ts' --report-unused-disable-directives && echo 'Your .ts files look good.'",
-        "docs": "jsdoc -r src -d docs"
+        "docs": "jsdoc -r dist/src -d docs"
     },
     "files": [
         "src/*",
@@ -47,7 +47,7 @@
         "eslint": "^8.31.0",
         "eslint-config-prettier": "^8.6.0",
         "eslint-plugin-prettier": "^4.2.1",
-        "jsdoc": "^3.6.11",
+        "jsdoc": "~4.0",
         "mocha": "^10.1.0",
         "prettier": "^2.8.1",
         "ts-node": "^10.9.1",

package/src/cli.js

@@ -22,15 +22,23 @@ const CLI_COMMAND_CONFIG = new Map([
     [
         "invoice",
         {
-            description: "Invoice V4",
+            description: "Invoice",
             docClass: documents_1.InvoiceV4,
             fullText: true,
         },
     ],
+    [
+        "invoice-splitter",
+        {
+            description: "Invoice Splitter",
+            docClass: documents_1.InvoiceSplitterV1,
+            fullText: false,
+        },
+    ],
     [
         "receipt",
         {
-            description: "Expense Receipt V4",
+            description: "Expense Receipt",
             docClass: documents_1.ReceiptV4,
             fullText: true,
         },
@@ -38,7 +46,7 @@ const CLI_COMMAND_CONFIG = new Map([
     [
         "passport",
         {
-            description: "Passport V1",
+            description: "Passport",
             docClass: documents_1.PassportV1,
             fullText: false,
         },
@@ -46,7 +54,7 @@ const CLI_COMMAND_CONFIG = new Map([
     [
         "financial",
         {
-            description: "Financial Document V1 (receipt or invoice)",
+            description: "Financial Document",
             docClass: documents_1.FinancialDocumentV1,
             fullText: true,
         },
@@ -54,7 +62,7 @@ const CLI_COMMAND_CONFIG = new Map([
     [
         "fr-id-card",
         {
-            description: "FR ID Card V1",
+            description: "FR ID Card",
             docClass: documents_1.fr.IdCardV1,
             fullText: false,
         },
@@ -62,7 +70,7 @@ const CLI_COMMAND_CONFIG = new Map([
     [
         "fr-bank-account-details",
         {
-            description: "FR Bank Account Details V1",
+            description: "FR Bank Account Details",
             docClass: documents_1.fr.BankAccountDetailsV1,
             fullText: false,
         },
@@ -70,7 +78,7 @@ const CLI_COMMAND_CONFIG = new Map([
     [
         "fr-carte-vitale",
         {
-            description: "FR Carte Vitale V1",
+            description: "FR Carte Vitale",
             docClass: documents_1.fr.CarteVitaleV1,
             fullText: false,
         },
@@ -78,7 +86,7 @@ const CLI_COMMAND_CONFIG = new Map([
     [
         "eu-license-plate",
         {
-            description: "EU License Plate V1",
+            description: "EU License Plate",
             docClass: documents_1.eu.LicensePlateV1,
             fullText: false,
         },
@@ -86,7 +94,7 @@ const CLI_COMMAND_CONFIG = new Map([
     [
         "us-bank-check",
         {
-            description: "US Bank Check V1",
+            description: "US Bank Check",
             docClass: documents_1.us.BankCheckV1,
             fullText: false,
         },
@@ -94,11 +102,19 @@ const CLI_COMMAND_CONFIG = new Map([
     [
         "shipping-container",
         {
-            description: "Shipping container V1",
+            description: "Shipping Container",
             docClass: documents_1.ShippingContainerV1,
             fullText: false,
         },
     ],
+    [
+        "mvision",
+        {
+            description: "Mindee Vision",
+            docClass: documents_1.MindeeVisionV1,
+            fullText: false,
+        },
+    ],
 ]);
 async function predictCall(command, inputPath, options) {
     const conf = CLI_COMMAND_CONFIG.get(command);
@@ -159,7 +175,7 @@ function cli() {
         }
         if (name === COMMAND_CUSTOM) {
             prog.requiredOption("-u, --user <username>", "API account name for the endpoint");
-            prog.option("-v, --version <version>", "API account name for the endpoint");
+            prog.option("-v, --version <version>", "Version for the endpoint, use the latest version if not specified.");
             prog.argument("<endpoint_name>", "API endpoint name");
         }
         prog.argument("<input_path>", "Full path to the file");

package/src/client.js

@@ -79,13 +79,19 @@ class Client {
     }
     // TODO: init only those endpoints we actually need.
     addStandardEndpoints() {
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.FinancialDocumentV1.name], new documentConfig_1.FinancialDocV1Config(this.apiKey));
+        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.FinancialDocumentV0.name], new documentConfig_1.FinancialDocV0Config(this.apiKey));
+        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.FinancialDocumentV1.name], new documentConfig_1.DocumentConfig(documents_1.FinancialDocumentV1, [
+            new api_1.StandardEndpoint("financial_document", "1", this.apiKey),
+        ]));
         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.InvoiceSplitterV1.name], new documentConfig_1.DocumentConfig(documents_1.InvoiceSplitterV1, [
+            new api_1.StandardEndpoint("invoice_splitter_beta", "1", 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),
         ]));
@@ -116,6 +122,12 @@ class Client {
         this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.ShippingContainerV1.name], new documentConfig_1.DocumentConfig(documents_1.ShippingContainerV1, [
             new api_1.StandardEndpoint("shipping_containers", "1", this.apiKey),
         ]));
+        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.MindeeVisionV1.name], new documentConfig_1.DocumentConfig(documents_1.MindeeVisionV1, [
+            new api_1.StandardEndpoint("mindee_vision", "1", this.apiKey),
+        ]));
+        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.ProofOfAddressV1.name], new documentConfig_1.DocumentConfig(documents_1.ProofOfAddressV1, [
+            new api_1.StandardEndpoint("proof_of_address", "1", this.apiKey),
+        ]));
     }
     /**
      * Add a custom endpoint to the client.

package/src/documents/documentConfig.d.ts

@@ -1,6 +1,6 @@
 import { InputSource } from "../inputs";
 import { Response, Endpoint, predictResponse } from "../api";
-import { Document, FinancialDocumentV1, CustomV1, DocumentSig } from "./index";
+import { Document, FinancialDocumentV0, CustomV1, DocumentSig } from "./index";
 import { PageOptions } from "../inputs";
 interface CustomDocConstructor {
     endpointName: string;
@@ -27,7 +27,7 @@ export declare class DocumentConfig<DocType extends Document> {
 export declare class CustomDocConfig extends DocumentConfig<CustomV1> {
     constructor({ endpointName, accountName, version, apiKey, }: CustomDocConstructor);
 }
-export declare class FinancialDocV1Config extends DocumentConfig<FinancialDocumentV1> {
+export declare class FinancialDocV0Config extends DocumentConfig<FinancialDocumentV0> {
     constructor(apiKey: string);
     protected predictRequest(inputDoc: InputSource, includeWords: boolean, cropping: boolean): Promise<predictResponse>;
 }

package/src/documents/documentConfig.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FinancialDocV1Config = exports.CustomDocConfig = exports.DocumentConfig = void 0;
+exports.FinancialDocV0Config = exports.CustomDocConfig = exports.DocumentConfig = void 0;
 const api_1 = require("../api");
 const index_1 = require("./index");
 const handler_1 = require("../errors/handler");
@@ -65,13 +65,13 @@ class CustomDocConfig extends DocumentConfig {
     }
 }
 exports.CustomDocConfig = CustomDocConfig;
-class FinancialDocV1Config extends DocumentConfig {
+class FinancialDocV0Config extends DocumentConfig {
     constructor(apiKey) {
         const endpoints = [
             new api_1.StandardEndpoint("invoices", "3", apiKey),
             new api_1.StandardEndpoint("expense_receipts", "3", apiKey),
         ];
-        super(index_1.FinancialDocumentV1, endpoints);
+        super(index_1.FinancialDocumentV0, endpoints);
     }
     async predictRequest(inputDoc, includeWords, cropping) {
         let endpoint;
@@ -84,4 +84,4 @@ class FinancialDocV1Config extends DocumentConfig {
         return await endpoint.predictReqPost(inputDoc, includeWords, cropping);
     }
 }
-exports.FinancialDocV1Config = FinancialDocV1Config;
+exports.FinancialDocV0Config = FinancialDocV0Config;

package/src/documents/eu/licensePlate/licensePlateV1.d.ts

@@ -1,7 +1,7 @@
 import { Document, DocumentConstructorProps } from "../../document";
 import { TextField } from "../../../fields";
 export declare class LicensePlateV1 extends Document {
-    /** A list of license plates values. */
+    /** A list of license plates. */
     licensePlates: TextField[];
     constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
     toString(): string;

package/src/documents/eu/licensePlate/licensePlateV1.js

@@ -11,7 +11,7 @@ class LicensePlateV1 extends document_1.Document {
             orientation: orientation,
             extras: extras,
         });
-        /** A list of license plates values. */
+        /** A list of license plates. */
         this.licensePlates = [];
         prediction.license_plates.map((prediction) => this.licensePlates.push(new fields_1.TextField({
             prediction: prediction,

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

@@ -0,0 +1,28 @@
+import { Document, DocumentConstructorProps } from "../document";
+import { TaxField, TextField, Amount, Locale, DateField as Date, CompanyRegistration } from "../../fields";
+/**
+ * @deprecated You should use FinancialDocumentV1 instead.
+ */
+export declare class FinancialDocumentV0 extends Document {
+    #private;
+    pageId: number | undefined;
+    locale: Locale;
+    totalIncl: Amount;
+    date: Date;
+    dueDate: Date;
+    category: TextField;
+    time: TextField;
+    taxes: TaxField[];
+    totalTax: Amount;
+    totalExcl: Amount;
+    supplier: TextField;
+    supplierAddress: TextField;
+    invoiceNumber: TextField;
+    companyRegistration: CompanyRegistration[];
+    customerName: TextField;
+    customerAddress: TextField;
+    paymentDetails: TextField[];
+    customerCompanyRegistration: CompanyRegistration[];
+    constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);
+    toString(): string;
+}

package/src/documents/financialDocument/financialDocumentV0.js

@@ -0,0 +1,140 @@
+"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 _FinancialDocumentV0_instances, _FinancialDocumentV0_initFromApiPrediction, _FinancialDocumentV0_checklist, _FinancialDocumentV0_taxesMatchTotalIncl;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FinancialDocumentV0 = void 0;
+const document_1 = require("../document");
+const invoiceV3_1 = require("../invoice/invoiceV3");
+const receiptV3_1 = require("../receipt/receiptV3");
+const fields_1 = require("../../fields");
+/**
+ * @deprecated You should use FinancialDocumentV1 instead.
+ */
+class FinancialDocumentV0 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,
+        });
+        _FinancialDocumentV0_instances.add(this);
+        this.taxes = [];
+        this.companyRegistration = [];
+        this.paymentDetails = [];
+        this.customerCompanyRegistration = [];
+        __classPrivateFieldGet(this, _FinancialDocumentV0_instances, "m", _FinancialDocumentV0_initFromApiPrediction).call(this, prediction, inputSource, pageId, orientation, extras);
+        __classPrivateFieldGet(this, _FinancialDocumentV0_instances, "m", _FinancialDocumentV0_checklist).call(this);
+    }
+    toString() {
+        const outStr = `-----Financial document-----
+Filename: ${this.filename}
+Total amount: ${this.totalIncl.value}
+Date: ${this.date.value}
+Supplier: ${this.supplier.value}
+Total taxes: ${this.totalTax.value}
+----------------------
+`;
+        return FinancialDocumentV0.cleanOutString(outStr);
+    }
+}
+exports.FinancialDocumentV0 = FinancialDocumentV0;
+_FinancialDocumentV0_instances = new WeakSet(), _FinancialDocumentV0_initFromApiPrediction = function _FinancialDocumentV0_initFromApiPrediction(prediction, inputFile, pageNumber, orientation, extras) {
+    if (Object.keys(prediction).includes("invoice_number")) {
+        const invoice = new invoiceV3_1.InvoiceV3({
+            prediction: prediction,
+            inputSource: inputFile,
+            pageId: pageNumber,
+            orientation: orientation,
+            extras: extras,
+        });
+        this.locale = invoice.locale;
+        this.totalIncl = invoice.totalIncl;
+        this.totalExcl = invoice.totalExcl;
+        this.date = invoice.date;
+        this.invoiceNumber = invoice.invoiceNumber;
+        this.dueDate = invoice.dueDate;
+        this.taxes = invoice.taxes;
+        this.supplier = invoice.supplier;
+        this.supplierAddress = invoice.supplierAddress;
+        this.paymentDetails = invoice.paymentDetails;
+        this.companyRegistration = invoice.customerCompanyRegistration;
+        this.orientation = invoice.orientation;
+        this.totalTax = invoice.totalTax;
+        this.time = new fields_1.TextField({
+            prediction: { value: undefined, confidence: 0.0 },
+        });
+        this.customerName = invoice.customerName;
+        this.customerAddress = invoice.customerAddress;
+        this.customerCompanyRegistration = invoice.customerCompanyRegistration;
+    }
+    else {
+        const receipt = new receiptV3_1.ReceiptV3({
+            prediction: prediction,
+            inputSource: inputFile,
+            pageId: pageNumber,
+            orientation: orientation,
+            extras: extras,
+        });
+        this.orientation = receipt.orientation;
+        this.date = receipt.date;
+        this.dueDate = receipt.date;
+        this.taxes = receipt.taxes;
+        this.locale = receipt.locale;
+        this.totalIncl = receipt.totalIncl;
+        this.totalExcl = receipt.totalExcl;
+        this.supplier = receipt.merchantName;
+        this.supplierAddress = new fields_1.TextField({
+            prediction: { value: undefined, confidence: 0.0 },
+        });
+        this.time = receipt.time;
+        this.totalTax = receipt.totalTax;
+        this.invoiceNumber = new fields_1.TextField({
+            prediction: { value: undefined, confidence: 0.0 },
+        });
+        this.customerName = new fields_1.TextField({
+            prediction: { value: undefined, confidence: 0.0 },
+        });
+        this.customerAddress = new fields_1.TextField({
+            prediction: { value: undefined, confidence: 0.0 },
+        });
+    }
+}, _FinancialDocumentV0_checklist = function _FinancialDocumentV0_checklist() {
+    this.checklist = {
+        taxesMatchTotalIncl: __classPrivateFieldGet(this, _FinancialDocumentV0_instances, "m", _FinancialDocumentV0_taxesMatchTotalIncl).call(this),
+    };
+}, _FinancialDocumentV0_taxesMatchTotalIncl = function _FinancialDocumentV0_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 = this.taxes.map((tax) => ({
+            ...tax,
+            confidence: 1.0,
+        }));
+        this.totalTax.confidence = 1.0;
+        this.totalIncl.confidence = 1.0;
+        return true;
+    }
+    return false;
+};

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

@@ -1,25 +1,54 @@
 import { Document, DocumentConstructorProps } from "../document";
-import { TaxField, TextField, Amount, Locale, DateField as Date, CompanyRegistration } from "../../fields";
+import { TaxField, PaymentDetails, Locale, Amount, TextField, DateField, CompanyRegistration, BaseField } from "../../fields";
+import { InvoiceLineItem } from "../invoice/invoiceLineItem";
+/**
+ * Financial Document.
+ */
 export declare class FinancialDocumentV1 extends Document {
-    #private;
-    pageId: number | undefined;
+    /** Locale information. */
     locale: Locale;
-    totalIncl: Amount;
-    date: Date;
-    dueDate: Date;
-    category: TextField;
-    time: TextField;
-    taxes: TaxField[];
-    totalTax: Amount;
-    totalExcl: Amount;
-    supplier: TextField;
+    /** The nature of the document. */
+    documentType: BaseField;
+    /** List of Reference numbers including PO number. */
+    referenceNumbers: TextField[];
+    /** The creation date of the invoice or the purchase date. */
+    date: DateField;
+    /** The due date of the invoice. */
+    dueDate: DateField;
+    /** The supplier name. */
+    supplierName: TextField;
+    /** The supplier address. */
     supplierAddress: TextField;
+    /** The payment information. */
+    supplierPaymentDetails: PaymentDetails[];
+    /** The supplier company registration information. */
+    supplierCompanyRegistrations: CompanyRegistration[];
+    /** The invoice number. */
     invoiceNumber: TextField;
-    companyRegistration: CompanyRegistration[];
+    /** The name of the customer. */
     customerName: TextField;
+    /** The address of the customer. */
     customerAddress: TextField;
-    paymentDetails: TextField[];
-    customerCompanyRegistration: CompanyRegistration[];
+    /** 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. */
+    totalTax: Amount;
     constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);
     toString(): string;
 }