mindee 3.3.0 → 3.4.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## v3.4.0 - 2023-01-04
+### Changes
+* :sparkles: Support Receipt V4.1
+* :sparkles: Support Invoice V4.1
+
 ## v3.3.0 - 2022-12-01
 ### Changes
 * :sparkles: Add Invoice V4 with line items

package/README.md

@@ -27,7 +27,7 @@ const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
 // Load a file from disk and parse it
 const apiResponse = mindeeClient
     .docFromPath("/path/to/the/file.ext")
-    .parse(mindee.InvoiceV3);
+    .parse(mindee.InvoiceV4);
 ```
 
 #### Region-Specific Documents

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "3.3.0",
+    "version": "3.4.0",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",

package/src/client.d.ts

@@ -5,7 +5,7 @@ import { Response } from "./api";
 import { Document, DocumentSig } from "./documents";
 import { DocumentConfig } from "./documents/documentConfig";
 import { ReadStream } from "fs";
-declare type DocConfigs = Map<string[], DocumentConfig<any>>;
+type DocConfigs = Map<string[], DocumentConfig<any>>;
 export interface PredictOptions {
     /**
      * For custom endpoints, the "API name" field in the "Settings" page of the API Builder.

package/src/documents/document.d.ts

@@ -1,6 +1,6 @@
 import { InputSource } from "../inputs";
 import { PositionField, FullText, OrientationField, stringDict } from "../fields";
-export declare type DocumentSig<DocType extends Document> = {
+export type DocumentSig<DocType extends Document> = {
     new ({ prediction, orientation, extras, inputSource, pageId, fullText, documentType, }: DocumentConstructorProps): DocType;
 };
 export interface DocumentConstructorProps extends BaseDocumentConstructorProps {

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

@@ -20,7 +20,8 @@ class LicensePlateV1 extends document_1.Document {
     }
     toString() {
         const outStr = `----- EU License plate V1 -----
-Licence plates: ${this.licensePlates.map((plate) => plate.value).join(", ")}
+Filename: ${this.filename}
+License plates: ${this.licensePlates.map((plate) => plate.value).join(", ")}
 ----------------------
 `;
         return LicensePlateV1.cleanOutString(outStr);

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

@@ -32,6 +32,7 @@ class CarteVitaleV1 extends document_1.Document {
     }
     toString() {
         const outStr = `----- FR Carte Vitale V1 -----
+Filename: ${this.filename}
 Given names: ${this.givenNames.map((name) => name.value).join(" ")}
 Surname: ${this.surname}
 ID Number: ${this.idNumber}

package/src/documents/invoice/invoiceLineItem.js

@@ -45,7 +45,7 @@ class InvoiceLineItem {
         const unitPrice = this.unitPrice !== null ? (0, amount_1.floatToString)(this.unitPrice) : "";
         const totalAmount = this.totalAmount !== null ? (0, amount_1.floatToString)(this.totalAmount) : "";
         let tax = this.taxAmount !== null ? (0, amount_1.floatToString)(this.taxAmount) : "";
-        tax += this.taxRate !== null ? ` (${this.taxRate} %)` : "";
+        tax += this.taxRate !== null ? ` (${(0, amount_1.floatToString)(this.taxRate)}%)` : "";
         let description = this.description ?? "";
         if (description.length > 32) {
             description = this.description.substring(0, 32) + "...";
@@ -58,7 +58,7 @@ class InvoiceLineItem {
             " | " +
             totalAmount.padEnd(8) +
             " | " +
-            tax.padEnd(14) +
+            tax.padEnd(16) +
             " | " +
             description);
     }

package/src/documents/invoice/invoiceV3.js

@@ -12,6 +12,22 @@ const fields_1 = require("../../fields");
 const checks_1 = require("./checks");
 const reconstruction_1 = require("./reconstruction");
 class InvoiceV3 extends document_1.Document {
+    /** The total amount without the tax value. */
+    get totalExcl() {
+        return this.totalNet;
+    }
+    /** The total amount without the tax value. */
+    set totalExcl(value) {
+        this.totalNet = value;
+    }
+    /** The total amount with tax included. */
+    get totalIncl() {
+        return this.totalAmount;
+    }
+    /** The total amount with tax included. */
+    set totalIncl(value) {
+        this.totalAmount = value;
+    }
     constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, fullText = undefined, pageId = undefined, }) {
         super({
             inputSource: inputSource,
@@ -33,22 +49,6 @@ class InvoiceV3 extends document_1.Document {
         __classPrivateFieldGet(this, _InvoiceV3_instances, "m", _InvoiceV3_checklist).call(this);
         __classPrivateFieldGet(this, _InvoiceV3_instances, "m", _InvoiceV3_reconstruct).call(this);
     }
-    /** The total amount without the tax value. */
-    get totalExcl() {
-        return this.totalNet;
-    }
-    /** The total amount without the tax value. */
-    set totalExcl(value) {
-        this.totalNet = value;
-    }
-    /** The total amount with tax included. */
-    get totalIncl() {
-        return this.totalAmount;
-    }
-    /** The total amount with tax included. */
-    set totalIncl(value) {
-        this.totalAmount = value;
-    }
     toString() {
         const taxes = this.taxes.map((item) => item.toString()).join("\n       ");
         const paymentDetails = this.paymentDetails

package/src/documents/invoice/invoiceV4.d.ts

@@ -7,6 +7,8 @@ export declare class InvoiceV4 extends Document {
     locale: Locale;
     /** The nature of the invoice. */
     documentType: BaseField;
+    /** List of Reference numbers including PO number. */
+    referenceNumbers: Field[];
     /** The total amount with tax included. */
     totalAmount: Amount;
     /** The creation date of the invoice. */

package/src/documents/invoice/invoiceV4.js

@@ -22,6 +22,8 @@ class InvoiceV4 extends document_1.Document {
             extras: extras,
         });
         _InvoiceV4_instances.add(this);
+        /** List of Reference numbers including PO number. */
+        this.referenceNumbers = [];
         /** The payment information. */
         this.supplierPaymentDetails = [];
         /** The supplier company regitration information. */
@@ -38,6 +40,9 @@ class InvoiceV4 extends document_1.Document {
     }
     toString() {
         const taxes = this.taxes.map((item) => item.toString()).join("\n       ");
+        const referenceNumbers = this.referenceNumbers
+            .map((item) => item.toString())
+            .join(", ");
         const paymentDetails = this.supplierPaymentDetails
             .map((item) => item.toString())
             .join("\n                 ");
@@ -50,13 +55,14 @@ class InvoiceV4 extends document_1.Document {
         let lineItems = "\n";
         if (this.lineItems.length > 0) {
             lineItems =
-                "\n  Code           | QTY    | Price   | Amount   | Tax (Rate)     | Description\n  ";
+                "\n  Code           | QTY    | Price   | Amount   | Tax (Rate)       | Description\n  ";
             lineItems += this.lineItems.map((item) => item.toString()).join("\n  ");
         }
         const outStr = `----- Invoice V4 -----
 Filename: ${this.filename}
 Locale: ${this.locale}
 Invoice number: ${this.invoiceNumber}
+Reference numbers: ${referenceNumbers}
 Invoice date: ${this.date}
 Invoice due date: ${this.dueDate}
 Supplier name: ${this.supplierName}
@@ -86,6 +92,12 @@ _InvoiceV4_instances = new WeakSet(), _InvoiceV4_initFromApiPrediction = functio
         prediction: apiPrediction.document_type,
         valueKey: "value",
     });
+    this.referenceNumbers = apiPrediction.reference_numbers.map(function (prediction) {
+        return new fields_1.Field({
+            prediction: prediction,
+            pageId: pageId,
+        });
+    });
     this.totalAmount = new fields_1.Amount({
         prediction: apiPrediction.total_amount,
         valueKey: "value",

package/src/documents/passport/passportV1.js

@@ -101,7 +101,7 @@ class PassportV1 extends document_1.Document {
         return new Date(year, month - 1, day, 0, 0, 0, 0);
     }
     toString() {
-        const outStr = `-----Passport data-----
+        const outStr = `----- Passport V1 -----
 Filename: ${this.filename}
 Full name: ${this.fullName}
 Given names: ${this.givenNames.map((name) => name.value).join(" ")}

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

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

package/src/documents/receipt/receiptV4.js

@@ -33,6 +33,8 @@ Total net: ${this.totalNet}
 Tip: ${this.tip}
 Date: ${this.date}
 Category: ${this.category}
+Subcategory: ${this.subCategory}
+Document type: ${this.documentType}
 Time: ${this.time}
 Supplier name: ${this.supplier}
 Taxes: ${taxes}
@@ -77,6 +79,14 @@ _ReceiptV4_instances = new WeakSet(), _ReceiptV4_initFromApiPrediction = functio
         prediction: apiPrediction.category,
         pageId: pageId,
     });
+    this.subCategory = new fields_1.Field({
+        prediction: apiPrediction.subcategory,
+        pageId: pageId,
+    });
+    this.documentType = new fields_1.Field({
+        prediction: apiPrediction.document_type,
+        pageId: pageId,
+    });
     this.supplier = new fields_1.Field({
         prediction: apiPrediction.supplier,
         pageId: pageId,
@@ -91,6 +101,6 @@ _ReceiptV4_instances = new WeakSet(), _ReceiptV4_initFromApiPrediction = functio
         valueKey: "value",
         rateKey: "rate",
         codeKey: "code",
-        basisKey: "basis",
+        baseKey: "base",
     })));
 };

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

@@ -4,13 +4,13 @@ interface ReceiptTaxConstructor {
     valueKey?: string;
     rateKey?: string;
     codeKey?: string;
-    basisKey?: string;
+    baseKey?: string;
     reconstructed?: boolean;
     pageId?: number;
 }
 export declare class ReceiptTaxField extends TaxField {
     /**  The tax base */
-    basis?: number;
+    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
@@ -19,7 +19,7 @@ export declare class ReceiptTaxField extends TaxField {
      * @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, basisKey, reconstructed, pageId, }: ReceiptTaxConstructor);
+    constructor({ prediction, valueKey, rateKey, codeKey, baseKey, reconstructed, pageId, }: ReceiptTaxConstructor);
     toString(): string;
 }
 export {};

package/src/documents/receipt/tax.js

@@ -12,13 +12,13 @@ class ReceiptTaxField extends fields_1.TaxField {
      * @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", basisKey = "basis", reconstructed = false, pageId = undefined, }) {
+    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.basis = undefined;
-        this.basis = parseFloat(prediction[basisKey]);
-        if (isNaN(this.basis))
-            this.basis = undefined;
+        this.base = undefined;
+        this.base = parseFloat(prediction[baseKey]);
+        if (isNaN(this.base))
+            this.base = undefined;
     }
     toString() {
         let outStr = "";
@@ -31,8 +31,8 @@ class ReceiptTaxField extends fields_1.TaxField {
         if (this.code !== undefined) {
             outStr += ` ${this.code}`;
         }
-        if (this.basis !== undefined) {
-            outStr += ` ${this.basis}`;
+        if (this.base !== undefined) {
+            outStr += ` ${this.base}`;
         }
         return outStr.trim();
     }

package/src/documents/shipping_container/shippingContainerV1.js

@@ -26,6 +26,7 @@ class ShippingContainerV1 extends document_1.Document {
     }
     toString() {
         const outStr = `----- Shipping Container V1 -----
+Filename: ${this.filename}
 Owner: ${this.owner}
 Serial number: ${this.serialNumber}
 Size and type: ${this.sizeType}

package/src/fields/amount.js

@@ -3,10 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Amount = exports.floatToString = void 0;
 const field_1 = require("./field");
 function floatToString(value) {
-    if (Number.isInteger(value)) {
-        return `${value}.0`;
-    }
-    return value.toString();
+    return value.toLocaleString(undefined, {
+        minimumFractionDigits: 2,
+        maximumFractionDigits: 3,
+        useGrouping: false,
+    });
 }
 exports.floatToString = floatToString;
 class Amount extends field_1.Field {

package/src/fields/field.d.ts

@@ -1,5 +1,5 @@
 import { Polygon } from "../geometry";
-export declare type stringDict = {
+export type stringDict = {
     [index: string]: any;
 };
 export interface FieldConstructor {

package/src/fields/fullText.d.ts

@@ -1,5 +1,5 @@
 import * as geometry from "../geometry";
-export declare type Word = {
+export type Word = {
     /**
      * Contains the relative vertices coordinates (points) of a polygon containing
      * the field in the document.
@@ -8,7 +8,7 @@ export declare type Word = {
     text: string;
     confidence: number;
 };
-declare type Line = Word[];
+type Line = Word[];
 export declare class FullText {
     words: Word[];
     /**

package/src/fields/tax.d.ts

@@ -10,9 +10,9 @@ interface TaxConstructor {
 export declare class TaxField extends Field {
     /** The tax amount. */
     value?: number;
-    /**  The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..). */
-    rate?: number;
     /** The tax rate. */
+    rate?: number;
+    /**  The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..). */
     code?: string;
     /** The document page on which the information was found. */
     pageId: number;

package/src/fields/tax.js

@@ -16,9 +16,9 @@ class TaxField extends field_1.Field {
         super({ prediction, valueKey, reconstructed, pageId });
         /** The tax amount. */
         this.value = undefined;
-        /**  The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..). */
-        this.rate = undefined;
         /** The tax rate. */
+        this.rate = undefined;
+        /**  The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..). */
         this.code = undefined;
         this.rate = +parseFloat(prediction[rateKey]);
         if (isNaN(this.rate))

package/src/geometry.d.ts

@@ -1,13 +1,13 @@
-declare type MinMax = {
+type MinMax = {
     min: number;
     max: number;
 };
 /** A point on the document defined by 2 coordinates: X, Y */
-export declare type Point = [number, number];
+export type Point = [number, number];
 /** A bounding box defined by 4 coordinates: xMin, yMin, xMax, yMax */
-export declare type BoundingBox = [number, number, number, number];
+export type BoundingBox = [number, number, number, number];
 /** A polygon, composed of several Points. */
-export declare type Polygon = Array<Point>;
+export type Polygon = Array<Point>;
 /**
  * Given a Polygon, calculate a polygon that encompasses all points.
  */

package/src/index.d.ts

@@ -1,3 +1,3 @@
 export { CustomV1, FinancialDocumentV1, InvoiceV3, InvoiceV4, PassportV1, ReceiptV3, ReceiptV4, CropperV1, ShippingContainerV1, fr, us, eu, } from "./documents";
-export { Client } from "./client";
+export { Client, ClientOptions } from "./client";
 export { PageOptionsOperation } from "./inputs";