mindee 3.4.1 → 3.5.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 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.5.0",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",

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 (receipt or invoice)",
             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,7 +102,7 @@ const CLI_COMMAND_CONFIG = new Map([
     [
         "shipping-container",
         {
-            description: "Shipping container V1",
+            description: "Shipping Container",
             docClass: documents_1.ShippingContainerV1,
             fullText: false,
         },
@@ -159,7 +167,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

@@ -86,6 +86,9 @@ class Client {
         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),
         ]));

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/fr/bankAccountDetails/bankAccountDetailsV1.d.ts

@@ -1,11 +1,12 @@
 import { Document, DocumentConstructorProps } from "../../document";
 import { TextField } from "../../../fields";
+/** French bank account information (RIB) */
 export declare class BankAccountDetailsV1 extends Document {
-    /** The IBAN number. */
+    /** The account's IBAN. */
     iban: TextField;
-    /** The account holder name. */
+    /** The account holder's name. */
     accountHolderName: TextField;
-    /** The SWIFT value. */
+    /** The bank's SWIFT code. */
     swift: TextField;
     constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
     toString(): string;

package/src/documents/fr/bankAccountDetails/bankAccountDetailsV1.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BankAccountDetailsV1 = void 0;
 const document_1 = require("../../document");
 const fields_1 = require("../../../fields");
+/** French bank account information (RIB) */
 class BankAccountDetailsV1 extends document_1.Document {
     constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, pageId = undefined, }) {
         super({

package/src/documents/fr/carteVitale/carteVitaleV1.d.ts

@@ -1,12 +1,12 @@
 import { Document, DocumentConstructorProps } from "../../document";
 import { TextField, DateField } from "../../../fields";
 export declare class CarteVitaleV1 extends Document {
-    /** The list of the names of the person. */
+    /** List of given (first) names of the cardholder. */
     givenNames: TextField[];
     /** The surname of the person. */
     surname: TextField;
-    /** The ID number of the card. */
-    idNumber: TextField;
+    /** The social security number of the cardholder. */
+    socialSecurity: TextField;
     /** The issuance date of the card. */
     issuanceDate: DateField;
     constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);

package/src/documents/fr/carteVitale/carteVitaleV1.js

@@ -11,9 +11,9 @@ class CarteVitaleV1 extends document_1.Document {
             orientation: orientation,
             extras: extras,
         });
-        /** The list of the names of the person. */
+        /** List of given (first) names of the cardholder. */
         this.givenNames = [];
-        this.idNumber = new fields_1.TextField({
+        this.socialSecurity = new fields_1.TextField({
             prediction: prediction.social_security,
             pageId: pageId,
         });
@@ -35,7 +35,7 @@ class CarteVitaleV1 extends document_1.Document {
 Filename: ${this.filename}
 Given names: ${this.givenNames.map((name) => name.value).join(" ")}
 Surname: ${this.surname}
-ID Number: ${this.idNumber}
+Social Security Number: ${this.socialSecurity}
 Issuance date: ${this.issuanceDate}
 ----------------------
 `;

package/src/documents/fr/idCard/idCardV1.d.ts

@@ -3,7 +3,7 @@ import { TextField, DateField, BaseField } from "../../../fields";
 export declare class IdCardV1 extends Document {
     /** The authority which has issued the card. */
     authority: TextField;
-    /** Indicates if it is the recto, the verso or the both of it. */
+    /** Indicates if it is the recto side, the verso side or both. */
     documentSide: BaseField;
     /** The id number of the card. */
     idNumber: TextField;

package/src/documents/index.d.ts

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

package/src/documents/index.js

@@ -23,11 +23,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.eu = exports.us = exports.fr = exports.Document = exports.ShippingContainerV1 = exports.CropperV1 = exports.CustomV1 = exports.FinancialDocumentV1 = exports.PassportV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.InvoiceV4 = exports.InvoiceV3 = void 0;
+exports.eu = exports.us = exports.fr = exports.Document = exports.ShippingContainerV1 = exports.CropperV1 = exports.CustomV1 = exports.FinancialDocumentV1 = exports.PassportV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PageGroup = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.InvoiceV3 = void 0;
 var invoiceV3_1 = require("./invoice/invoiceV3");
 Object.defineProperty(exports, "InvoiceV3", { enumerable: true, get: function () { return invoiceV3_1.InvoiceV3; } });
 var invoiceV4_1 = require("./invoice/invoiceV4");
 Object.defineProperty(exports, "InvoiceV4", { enumerable: true, get: function () { return invoiceV4_1.InvoiceV4; } });
+var invoiceSplitterV1_1 = require("./invoiceSplitter/invoiceSplitterV1");
+Object.defineProperty(exports, "InvoiceSplitterV1", { enumerable: true, get: function () { return invoiceSplitterV1_1.InvoiceSplitterV1; } });
+Object.defineProperty(exports, "PageGroup", { enumerable: true, get: function () { return invoiceSplitterV1_1.PageGroup; } });
 var receiptV3_1 = require("./receipt/receiptV3");
 Object.defineProperty(exports, "ReceiptV3", { enumerable: true, get: function () { return receiptV3_1.ReceiptV3; } });
 var receiptV4_1 = require("./receipt/receiptV4");

package/src/documents/invoiceSplitter/invoiceSplitterV1.d.ts

@@ -0,0 +1,14 @@
+import { Document, DocumentConstructorProps } from "../document";
+export declare class PageGroup {
+    pageIndexes: number[];
+    constructor(prediction: {
+        [index: string]: number[];
+    });
+    toString(): string;
+}
+export declare class InvoiceSplitterV1 extends Document {
+    /** List of page indexes that belong to the same invoice in the PDF. */
+    invoicePageGroups: PageGroup[];
+    constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);
+    toString(): string;
+}

package/src/documents/invoiceSplitter/invoiceSplitterV1.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvoiceSplitterV1 = exports.PageGroup = void 0;
+const document_1 = require("../document");
+class PageGroup {
+    constructor(prediction) {
+        this.pageIndexes = [];
+        this.pageIndexes = prediction.page_indexes;
+    }
+    toString() {
+        return `page indexes: ${this.pageIndexes.join(", ")}`;
+    }
+}
+exports.PageGroup = PageGroup;
+class InvoiceSplitterV1 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,
+        });
+        /** List of page indexes that belong to the same invoice in the PDF. */
+        this.invoicePageGroups = [];
+        if (prediction.invoice_page_groups !== undefined) {
+            prediction.invoice_page_groups.map((prediction) => this.invoicePageGroups.push(new PageGroup(prediction)));
+        }
+    }
+    toString() {
+        let invoicePageGroups = "\n";
+        if (this.invoicePageGroups.length > 0) {
+            invoicePageGroups = "\n  ";
+            invoicePageGroups += this.invoicePageGroups
+                .map((item) => item.toString())
+                .join("\n  ");
+        }
+        const outStr = `----- Invoice Splitter V1 -----
+Filename: ${this.filename}
+Invoice Page Groups: ${invoicePageGroups}
+----------------------
+`;
+        return InvoiceSplitterV1.cleanOutString(outStr);
+    }
+}
+exports.InvoiceSplitterV1 = InvoiceSplitterV1;

package/src/documents/passport/passportV1.d.ts

@@ -10,23 +10,23 @@ export declare class PassportV1 extends Document {
     birthDate: DateField;
     /** The expiration date of the passport. */
     expiryDate: DateField;
-    /** The issuance date.*/
+    /** The issuance date of the passport. */
     issuanceDate: DateField;
     /** The place of birth of the passport holder. */
     birthPlace: TextField;
     /** The sex or gender of the passport holder. */
     gender: TextField;
-    /** The surname of the person. */
+    /** The surname (last name) of the passport holder. */
     surname: TextField;
-    /** The value of the first mrz line. */
+    /** The value of the first MRZ line. */
     mrz1: TextField;
-    /** The value of the second mrz line. */
+    /** The value of the second MRZ line. */
     mrz2: TextField;
     /** List of first (given) names of the passport holder. */
     givenNames: TextField[];
     /** The full name of the passport holder. */
     fullName: TextField;
-    /** All the mrz values combined. */
+    /** All the MRZ values combined. */
     mrz: TextField;
     constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
     static convertMRZDateToDatetime(dateString: string): Date;

package/src/documents/receipt/receiptV4.d.ts

@@ -6,13 +6,13 @@ export declare class ReceiptV4 extends Document {
     locale: Locale;
     /** The purchase date. */
     date: DateField;
-    /** The type of purchase. */
+    /** The receipt category among predefined classes. */
     category: TextField;
-    /** The receipt sub category among predefined classes. */
+    /** The receipt sub-category among predefined classes. */
     subCategory: TextField;
-    /** The receipt document type provdes the information whether the document is an expense receipt or a credit card receipt. */
+    /** Whether the document is an expense receipt or a credit card receipt. */
     documentType: TextField;
-    /** Merchant's name as seen on the receipt. */
+    /** The name of the supplier or merchant, as seen on the receipt. */
     supplier: TextField;
     /** Time as seen on the receipt in HH:MM format. */
     time: TextField;

package/src/documents/receipt/receiptV4.js

@@ -9,7 +9,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReceiptV4 = void 0;
 const document_1 = require("../document");
 const fields_1 = require("../../fields");
-const tax_1 = require("./tax");
 class ReceiptV4 extends document_1.Document {
     constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, fullText = undefined, pageId = undefined, }) {
         super({
@@ -94,7 +93,7 @@ _ReceiptV4_instances = new WeakSet(), _ReceiptV4_initFromApiPrediction = functio
         prediction: apiPrediction.time,
         pageId: pageId,
     });
-    apiPrediction.taxes.map((taxPrediction) => this.taxes.push(new tax_1.ReceiptTaxField({
+    apiPrediction.taxes.map((taxPrediction) => this.taxes.push(new fields_1.TaxField({
         prediction: taxPrediction,
         pageId: pageId,
         valueKey: "value",

package/src/documents/us/bankCheck/bankCheckV1.d.ts

@@ -3,9 +3,9 @@ import { TextField, DateField, PositionField, Amount } from "../../../fields";
 export declare class BankCheckV1 extends Document {
     /** Payer's bank account number. */
     accountNumber: TextField;
-    /** Total including taxes. */
+    /** Amount to be paid. */
     amount: Amount;
-    /** Payer's bank account number. */
+    /** The check number. */
     checkNumber: TextField;
     /** Check's position in the image. */
     checkPosition: PositionField;
@@ -15,7 +15,7 @@ export declare class BankCheckV1 extends Document {
     payees: TextField[];
     /** Payer's bank account routing number. */
     routingNumber: TextField;
-    /** Signatures' positions in the image. */
+    /** The positions of the signatures on the image. */
     signaturesPositions: PositionField;
     constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
     toString(): string;

package/src/fields/tax.d.ts

@@ -5,6 +5,7 @@ interface TaxConstructor {
     valueKey?: string;
     rateKey?: string;
     codeKey?: string;
+    baseKey?: string;
     reconstructed?: boolean;
     pageId?: number;
 }
@@ -15,6 +16,8 @@ export declare class TaxField extends Field {
     rate?: number;
     /**  The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..). */
     code?: string;
+    /**  The tax base */
+    base?: number;
     /** The document page on which the information was found. */
     pageId: number;
     /**
@@ -22,10 +25,11 @@ export declare class TaxField extends Field {
      * @param {String} valueKey - Key to use in the prediction dict to get the tax value
      * @param {String} rateKey - Key to use to get the tax rate in the prediction dict
      * @param {String} codeKey - Key to use to get the tax code in the prediction dict
+     * @param {String} baseKey - Key to use to get the base tax in the prediction dict
      * @param {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
      * @param {Integer} pageNumber - Page ID for multi-page document
      */
-    constructor({ prediction, valueKey, rateKey, codeKey, reconstructed, pageId, }: TaxConstructor);
+    constructor({ prediction, valueKey, rateKey, codeKey, baseKey, reconstructed, pageId, }: TaxConstructor);
     toString(): string;
 }
 export {};

package/src/fields/tax.js

@@ -9,10 +9,11 @@ class TaxField extends field_1.Field {
      * @param {String} valueKey - Key to use in the prediction dict to get the tax value
      * @param {String} rateKey - Key to use to get the tax rate in the prediction dict
      * @param {String} codeKey - Key to use to get the tax code in the prediction dict
+     * @param {String} baseKey - Key to use to get the base tax in the prediction dict
      * @param {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
      * @param {Integer} pageNumber - Page ID for multi-page document
      */
-    constructor({ prediction, valueKey = "value", rateKey = "rate", codeKey = "code", reconstructed = false, pageId = undefined, }) {
+    constructor({ prediction, valueKey = "value", rateKey = "rate", codeKey = "code", baseKey = "base", reconstructed = false, pageId = undefined, }) {
         super({ prediction, valueKey, reconstructed, pageId });
         /** The tax amount. */
         this.value = undefined;
@@ -20,6 +21,8 @@ class TaxField extends field_1.Field {
         this.rate = undefined;
         /**  The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..). */
         this.code = undefined;
+        /**  The tax base */
+        this.base = undefined;
         this.rate = +parseFloat(prediction[rateKey]);
         if (isNaN(this.rate))
             this.rate = undefined;
@@ -32,6 +35,9 @@ class TaxField extends field_1.Field {
             this.value = undefined;
             this.confidence = 0.0;
         }
+        this.base = parseFloat(prediction[baseKey]);
+        if (isNaN(this.base))
+            this.base = undefined;
     }
     toString() {
         let outStr = "";
@@ -44,6 +50,9 @@ class TaxField extends field_1.Field {
         if (this.code !== undefined) {
             outStr += ` ${this.code}`;
         }
+        if (this.base !== undefined) {
+            outStr += ` ${(0, amount_1.floatToString)(this.base)}`;
+        }
         return outStr.trim();
     }
 }

package/src/documents/receipt/tax.d.ts

@@ -1,25 +0,0 @@
-import { TaxField } from "../../fields";
-interface ReceiptTaxConstructor {
-    prediction: any;
-    valueKey?: string;
-    rateKey?: string;
-    codeKey?: string;
-    baseKey?: string;
-    reconstructed?: boolean;
-    pageId?: number;
-}
-export declare class ReceiptTaxField extends TaxField {
-    /**  The tax base */
-    base?: number;
-    /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict to get the tax value
-     * @param {String} rateKey - Key to use to get the tax rate in the prediction dict
-     * @param {String} codeKey - Key to use to get the tax code in the prediction dict
-     * @param {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
-     * @param {Integer} pageNumber - Page ID for multi-page document
-     */
-    constructor({ prediction, valueKey, rateKey, codeKey, baseKey, reconstructed, pageId, }: ReceiptTaxConstructor);
-    toString(): string;
-}
-export {};

package/src/documents/receipt/tax.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReceiptTaxField = void 0;
-const fields_1 = require("../../fields");
-const amount_1 = require("../../fields/amount");
-class ReceiptTaxField extends fields_1.TaxField {
-    /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict to get the tax value
-     * @param {String} rateKey - Key to use to get the tax rate in the prediction dict
-     * @param {String} codeKey - Key to use to get the tax code in the prediction dict
-     * @param {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
-     * @param {Integer} pageNumber - Page ID for multi-page document
-     */
-    constructor({ prediction, valueKey = "value", rateKey = "rate", codeKey = "code", baseKey = "base", reconstructed = false, pageId = undefined, }) {
-        super({ prediction, valueKey, rateKey, codeKey, reconstructed, pageId });
-        /**  The tax base */
-        this.base = undefined;
-        this.base = parseFloat(prediction[baseKey]);
-        if (isNaN(this.base))
-            this.base = undefined;
-    }
-    toString() {
-        let outStr = "";
-        if (this.value !== undefined) {
-            outStr += `${(0, amount_1.floatToString)(this.value)}`;
-        }
-        if (this.rate !== undefined) {
-            outStr += ` ${(0, amount_1.floatToString)(this.rate)}%`;
-        }
-        if (this.code !== undefined) {
-            outStr += ` ${this.code}`;
-        }
-        if (this.base !== undefined) {
-            outStr += ` ${this.base}`;
-        }
-        return outStr.trim();
-    }
-}
-exports.ReceiptTaxField = ReceiptTaxField;