mindee 4.23.0 → 4.24.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # CHANGELOG
 
+## v4.24.0 - 2025-03-27
+### Changes
+* :sparkles: update structure for InvoiceSplitterV1
+* :sparkles: update FR EnegryBillV1 to V1.2
+* :sparkles: update US HealthcareCardV1 to V1.1
+* :coffin: remove support for EU Driver License
+* :coffin: remove support for License Plates
+* :coffin: remove support for ReceiptV4
+* :coffin: remove support for Proof of Address
+* :coffin: remove support for US Driver License
+* :coffin: remove support for US W9V1
+### Fixes
+* :bug: fix invalid indexes of some products
+* :recycle: update CLI structure
+
+
+## v4.23.1 - 2025-03-05
+### Changes
+* :recycle: remove superfluous canvas dependency
+* :memo: update doc
+
+
 ## v4.23.0 - 2025-02-21
 ### Changes
 * :sparkles: add support for image & PDF compression

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "4.23.0",
+    "version": "4.24.0",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",
@@ -56,7 +56,6 @@
         "typescript": "^5.6.3"
     },
     "dependencies": {
-        "canvas": "^3.0.1",
         "commander": "~9.4.1",
         "file-type": "~16.5.4",
         "form-data": "~3.0.1",

package/src/cli.js

@@ -25,240 +25,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cli = cli;
 const commander_1 = require("commander");
-const product = __importStar(require("./product"));
 const client_1 = require("./client");
 const input_1 = require("./input");
 const console = __importStar(require("console"));
+const cliProducts_1 = require("./cliProducts");
 const program = new commander_1.Command();
-const COMMAND_CUSTOM = "custom";
-const COMMAND_GENERATED = "generated";
-//
-// PRODUCT CONFIGURATION
-//
-// The Map's key is the command name as it will appear on the console.
-//
-const CLI_COMMAND_CONFIG = new Map([
-    [
-        COMMAND_CUSTOM,
-        {
-            displayName: "Custom Document",
-            docClass: product.CustomV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        COMMAND_GENERATED,
-        {
-            displayName: "Generated Document",
-            docClass: product.GeneratedV1,
-            allWords: true,
-            async: true,
-            sync: true,
-        },
-    ],
-    [
-        "barcode-reader",
-        {
-            displayName: "Barcode Reader",
-            docClass: product.BarcodeReaderV1,
-            allWords: true,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "cropper",
-        {
-            displayName: "Cropper",
-            docClass: product.CropperV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "financial",
-        {
-            displayName: "Financial Document",
-            docClass: product.FinancialDocumentV1,
-            allWords: true,
-            async: true,
-            sync: true,
-        },
-    ],
-    [
-        "fr-bank-account-details",
-        {
-            displayName: "FR Bank Account Details",
-            docClass: product.fr.BankAccountDetailsV2,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "fr-id-card",
-        {
-            displayName: "FR ID Card",
-            docClass: product.fr.IdCardV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "fr-health-card",
-        {
-            displayName: "FR Health Card",
-            docClass: product.fr.HealthCardV1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "fr-carte-grise",
-        {
-            displayName: "FR Carte Grise",
-            docClass: product.fr.CarteGriseV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "eu-license-plate",
-        {
-            displayName: "EU License Plate",
-            docClass: product.eu.LicensePlateV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "driver-license",
-        {
-            displayName: "Driver License",
-            docClass: product.DriverLicenseV1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "international-id",
-        {
-            displayName: "International Id",
-            docClass: product.InternationalIdV2,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "invoice",
-        {
-            displayName: "Invoice",
-            docClass: product.InvoiceV4,
-            allWords: true,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "invoice-splitter",
-        {
-            displayName: "Invoice Splitter",
-            docClass: product.InvoiceSplitterV1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "multi-receipts-detector",
-        {
-            displayName: "Multi Receipts Detector",
-            docClass: product.MultiReceiptsDetectorV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "passport",
-        {
-            displayName: "Passport",
-            docClass: product.PassportV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "receipt",
-        {
-            displayName: "Expense Receipt",
-            docClass: product.ReceiptV5,
-            allWords: true,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "resume",
-        {
-            displayName: "Resume",
-            docClass: product.ResumeV1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "us-bank-check",
-        {
-            displayName: "US Bank Check",
-            docClass: product.us.BankCheckV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "us-healthcare-card",
-        {
-            displayName: "US Healthcare Card",
-            docClass: product.us.HealthcareCardV1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "us-mail",
-        {
-            displayName: "US Mail",
-            docClass: product.us.UsMailV2,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "us-w9",
-        {
-            displayName: "US W9",
-            docClass: product.us.W9V1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-]);
 //
 // EXECUTE THE COMMANDS
 //
@@ -269,7 +40,7 @@ function initClient(options) {
     });
 }
 function getConfig(command) {
-    const conf = CLI_COMMAND_CONFIG.get(command);
+    const conf = cliProducts_1.CLI_COMMAND_CONFIG.get(command);
     if (conf === undefined) {
         throw new Error(`Invalid document type ${command}`);
     }
@@ -298,7 +69,7 @@ async function callParse(productClass, command, inputPath, options) {
     const pageOptions = getPageOptions(options);
     const inputSource = mindeeClient.docFromPath(inputPath);
     let response;
-    if (command === COMMAND_CUSTOM || command === COMMAND_GENERATED) {
+    if (command === cliProducts_1.COMMAND_CUSTOM || command === cliProducts_1.COMMAND_GENERATED) {
         const customEndpoint = mindeeClient.createEndpoint(options.endpoint, options.account, options.version);
         response = await mindeeClient.parse(productClass, inputSource, {
             endpoint: customEndpoint,
@@ -322,7 +93,7 @@ async function callEnqueueAndParse(productClass, command, inputPath, options) {
     const pageOptions = getPageOptions(options);
     const inputSource = mindeeClient.docFromPath(inputPath);
     let response;
-    if (command === COMMAND_CUSTOM || command === COMMAND_GENERATED) {
+    if (command === cliProducts_1.COMMAND_CUSTOM || command === cliProducts_1.COMMAND_GENERATED) {
         const customEndpoint = mindeeClient.createEndpoint(options.endpoint, options.account, options.version);
         response = await mindeeClient.enqueueAndParse(productClass, inputSource, {
             endpoint: customEndpoint,
@@ -409,7 +180,7 @@ function routeSwitchboard(command, inputPath, allOptions) {
     return callParse(docClass, command.name(), inputPath, allOptions);
 }
 function addPredictAction(prog) {
-    if (prog.name() === COMMAND_CUSTOM || prog.name() === COMMAND_GENERATED) {
+    if (prog.name() === cliProducts_1.COMMAND_CUSTOM || prog.name() === cliProducts_1.COMMAND_GENERATED) {
         prog.action(function (inputPath, options, command) {
             const allOptions = {
                 ...prog.parent?.parent?.opts(),
@@ -436,7 +207,7 @@ function cli() {
     program.name("mindee")
         .description("Command line interface for Mindee products.")
         .option("-d, --debug", "high verbosity mode");
-    CLI_COMMAND_CONFIG.forEach((info, name) => {
+    cliProducts_1.CLI_COMMAND_CONFIG.forEach((info, name) => {
         const productCmd = program.command(name)
             .description(info.displayName);
         if (info.async) {
@@ -471,7 +242,7 @@ function cli() {
             }
             predictProductCmd.addOption(asyncOpt);
         }
-        if (name === COMMAND_CUSTOM || name === COMMAND_GENERATED) {
+        if (name === cliProducts_1.COMMAND_CUSTOM || name === cliProducts_1.COMMAND_GENERATED) {
             addCustomPostOptions(predictProductCmd);
         }
         addMainOptions(predictProductCmd);

package/src/cliProducts.d.ts

@@ -0,0 +1,11 @@
+import { Inference, StringDict } from "./parsing/common";
+export declare const COMMAND_CUSTOM = "custom";
+export declare const COMMAND_GENERATED = "generated";
+export interface ProductConfig<T extends Inference = Inference> {
+    displayName: string;
+    docClass: new (rawPrediction: StringDict) => T;
+    allWords: boolean;
+    async: boolean;
+    sync: boolean;
+}
+export declare const CLI_COMMAND_CONFIG: Map<string, ProductConfig<Inference<import("./parsing/common").Prediction, import("./parsing/common").Prediction>>>;

package/src/cliProducts.js

@@ -0,0 +1,306 @@
+"use strict";
+//
+// PRODUCT CONFIGURATION
+//
+// The Map's key is the command name as it will appear on the console.
+//
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CLI_COMMAND_CONFIG = exports.COMMAND_GENERATED = exports.COMMAND_CUSTOM = void 0;
+const product = __importStar(require("./product"));
+exports.COMMAND_CUSTOM = "custom";
+exports.COMMAND_GENERATED = "generated";
+exports.CLI_COMMAND_CONFIG = new Map([
+    [
+        exports.COMMAND_CUSTOM,
+        {
+            displayName: "Custom Document",
+            docClass: product.CustomV1,
+            allWords: false,
+            async: false,
+            sync: true,
+        },
+    ],
+    [
+        exports.COMMAND_GENERATED,
+        {
+            displayName: "Generated Document",
+            docClass: product.GeneratedV1,
+            allWords: true,
+            async: true,
+            sync: true,
+        },
+    ],
+    [
+        "barcode-reader",
+        {
+            displayName: "Barcode Reader",
+            docClass: product.BarcodeReaderV1,
+            allWords: false,
+            async: false,
+            sync: true,
+        },
+    ],
+    [
+        "bill-of-lading",
+        {
+            displayName: "Bill of Lading",
+            docClass: product.BillOfLadingV1,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "business-card",
+        {
+            displayName: "Business Card",
+            docClass: product.BusinessCardV1,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "cropper",
+        {
+            displayName: "Cropper",
+            docClass: product.CropperV1,
+            allWords: false,
+            async: false,
+            sync: true,
+        },
+    ],
+    [
+        "delivery-note",
+        {
+            displayName: "Delivery note",
+            docClass: product.DeliveryNoteV1,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "driver-license",
+        {
+            displayName: "Driver License",
+            docClass: product.DriverLicenseV1,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "financial-document",
+        {
+            displayName: "Financial Document",
+            docClass: product.FinancialDocumentV1,
+            allWords: true,
+            async: true,
+            sync: true,
+        },
+    ],
+    [
+        "fr-bank-account-details",
+        {
+            displayName: "FR Bank Account Details",
+            docClass: product.fr.BankAccountDetailsV2,
+            allWords: false,
+            async: false,
+            sync: true,
+        },
+    ],
+    [
+        "fr-carte-grise",
+        {
+            displayName: "FR Carte Grise",
+            docClass: product.fr.CarteGriseV1,
+            allWords: false,
+            async: false,
+            sync: true,
+        },
+    ],
+    [
+        "fr-energy-bill",
+        {
+            displayName: "FR Energy Bill",
+            docClass: product.fr.EnergyBillV1,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "fr-health-card",
+        {
+            displayName: "FR Health Card",
+            docClass: product.fr.HealthCardV1,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "fr-carte-nationale-d-identite",
+        {
+            displayName: "FR Carte Nationale d'Identité",
+            docClass: product.fr.IdCardV2,
+            allWords: false,
+            async: false,
+            sync: true,
+        },
+    ],
+    [
+        "fr-payslip",
+        {
+            displayName: "FR Payslip",
+            docClass: product.fr.PayslipV3,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "ind-passport-india",
+        {
+            displayName: "IND Passport - India",
+            docClass: product.ind.IndianPassportV1,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "international-id",
+        {
+            displayName: "International ID",
+            docClass: product.InternationalIdV2,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "invoice",
+        {
+            displayName: "Invoice",
+            docClass: product.InvoiceV4,
+            allWords: true,
+            async: true,
+            sync: true,
+        },
+    ],
+    [
+        "invoice-splitter",
+        {
+            displayName: "Invoice Splitter",
+            docClass: product.InvoiceSplitterV1,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "multi-receipts-detector",
+        {
+            displayName: "Multi Receipts Detector",
+            docClass: product.MultiReceiptsDetectorV1,
+            allWords: false,
+            async: false,
+            sync: true,
+        },
+    ],
+    [
+        "nutrition-facts-label",
+        {
+            displayName: "Nutrition Facts Label",
+            docClass: product.NutritionFactsLabelV1,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "passport",
+        {
+            displayName: "Passport",
+            docClass: product.PassportV1,
+            allWords: false,
+            async: false,
+            sync: true,
+        },
+    ],
+    [
+        "receipt",
+        {
+            displayName: "Receipt",
+            docClass: product.ReceiptV5,
+            allWords: true,
+            async: true,
+            sync: true,
+        },
+    ],
+    [
+        "resume",
+        {
+            displayName: "Resume",
+            docClass: product.ResumeV1,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "us-bank-check",
+        {
+            displayName: "US Bank Check",
+            docClass: product.us.BankCheckV1,
+            allWords: false,
+            async: false,
+            sync: true,
+        },
+    ],
+    [
+        "us-healthcare-card",
+        {
+            displayName: "US Healthcare Card",
+            docClass: product.us.HealthcareCardV1,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "us-us-mail",
+        {
+            displayName: "US US Mail",
+            docClass: product.us.UsMailV3,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+]);

package/src/imageOperations/invoiceSplitterExtractor/invoiceSplitterExtractor.js

@@ -53,7 +53,7 @@ async function extractInvoices(inputFile, indexes, strict = false) {
     if (indexes instanceof product_1.InvoiceSplitterV1) {
         indexes.prediction.invoicePageGroups.map((invoicePageGroup) => {
             if (!strict || invoicePageGroup.confidence === 1) {
-                customIndexes.push(invoicePageGroup.pageIndexes);
+                customIndexes.push(invoicePageGroup.pageIndexes ?? []);
             }
         });
     }

package/src/product/deliveryNote/deliveryNoteV1Document.d.ts

@@ -1,7 +1,7 @@
 import { Prediction, StringDict } from "../../parsing/common";
 import { AmountField, DateField, StringField } from "../../parsing/standard";
 /**
- * Delivery note API version 1.1 document data.
+ * Delivery note API version 1.2 document data.
  */
 export declare class DeliveryNoteV1Document implements Prediction {
     /** The address of the customer receiving the goods. */

package/src/product/deliveryNote/deliveryNoteV1Document.js

@@ -4,7 +4,7 @@ exports.DeliveryNoteV1Document = void 0;
 const common_1 = require("../../parsing/common");
 const standard_1 = require("../../parsing/standard");
 /**
- * Delivery note API version 1.1 document data.
+ * Delivery note API version 1.2 document data.
  */
 class DeliveryNoteV1Document {
     constructor(rawPrediction, pageId) {