mindee 4.24.0 → 4.25.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## v4.25.0 - 2025-04-08
+### Changes
+* :sparkles: add support for Financial Document V1.12
+* :sparkles: add support for Invoices V4.10
+* :sparkles: add support for US Healthcare Cards V1.2
+### Fixes
+* :arrow_up: upgrade mocha dependency
+
+
+## v4.24.1 - 2025-03-27
+### Fixes
+* :bug: fix null objects being return in extras
+
+
 ## v4.24.0 - 2025-03-27
 ### Changes
 * :sparkles: update structure for InvoiceSplitterV1

package/README.md

@@ -166,15 +166,10 @@ Complete details on the working of the library are available in the following gu
 * [Node.js Resume OCR](https://developers.mindee.com/docs/nodejs-resume-ocr)
 * [Node.js Financial Document OCR](https://developers.mindee.com/docs/nodejs-financial-document-ocr)
 * [Node.js Passport OCR](https://developers.mindee.com/docs/nodejs-passport-ocr)
-* [Node.js Proof of Address OCR](https://developers.mindee.com/docs/nodejs-proof-of-address-ocr)
-* [Node.js EU License Plate OCR](https://developers.mindee.com/docs/nodejs-eu-license-plate-ocr)
-* [Node.js EU Driver License OCR](https://developers.mindee.com/docs/nodejs-eu-driver-license-ocr)
 * [Node.js FR Bank Account Detail OCR](https://developers.mindee.com/docs/nodejs-fr-bank-account-details-ocr)
 * [Node.js FR Health Card OCR](https://developers.mindee.com/docs/nodejs-fr-health-card-ocr)
 * [Node.js FR ID Card OCR](https://developers.mindee.com/docs/nodejs-fr-carte-nationale-didentite-ocr)
 * [Node.js US Bank Check OCR](https://developers.mindee.com/docs/nodejs-us-bank-check-ocr)
-* [Node.js US W9 OCR](https://developers.mindee.com/docs/nodejs-us-w9-ocr)
-* [Node.js US Driver License OCR](https://developers.mindee.com/docs/nodejs-us-driver-license-ocr)
 * [Node.js Barcode Reader API](https://developers.mindee.com/docs/nodejs-barcode-reader-ocr)
 * [Node.js Cropper API](https://developers.mindee.com/docs/nodejs-cropper-ocr)
 * [Node.js Invoice Splitter API](https://developers.mindee.com/docs/nodejs-invoice-splitter-ocr)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "4.24.0",
+    "version": "4.25.0",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",
@@ -41,7 +41,7 @@
     "homepage": "https://mindee.com/",
     "devDependencies": {
         "@types/chai": "^4.3.4",
-        "@types/mocha": "^10.0.9",
+        "@types/mocha": "^10.0.10",
         "@types/node": "^18.15.11",
         "@types/tmp": "^0.2.6",
         "@typescript-eslint/eslint-plugin": "^8.15.0",
@@ -49,7 +49,7 @@
         "chai": "^4.3.10",
         "eslint": "^9.15.0",
         "eslint-plugin-jsdoc": "^50.5.0",
-        "mocha": "^10.8.2",
+        "mocha": "^11.1.0",
         "nock": "^13.5.6",
         "ts-node": "^10.9.2",
         "typedoc": "~0.26.11",

package/src/parsing/common/document.js

@@ -52,7 +52,10 @@ ${this.inference?.toString()}`;
     injectFullTextOcr(rawPrediction) {
         if (rawPrediction["inference"]["pages"].length < 1 ||
             rawPrediction["inference"]["pages"][0]["extras"].length < 1 ||
-            !("full_text_ocr" in rawPrediction["inference"]["pages"][0]["extras"])) {
+            !("full_text_ocr" in rawPrediction["inference"]["pages"][0]["extras"]) ||
+            !rawPrediction["inference"]["pages"][0]["extras"]["full_text_ocr"] ||
+            !("content" in rawPrediction["inference"]["pages"][0]["extras"]["full_text_ocr"]) ||
+            !rawPrediction["inference"]["pages"][0]["extras"]["full_text_ocr"]["content"]) {
             return;
         }
         const fullTextOcr = rawPrediction["inference"]["pages"].filter((e) => "extras" in e).map((e) => e["extras"]["full_text_ocr"]["content"]).join("\n");

package/src/parsing/common/page.js

@@ -29,13 +29,15 @@ class Page {
             Object.keys(rawPrediction["extras"].length > 0)) {
             const extras = {};
             Object.entries(rawPrediction["extras"]).forEach(([extraKey, extraValue]) => {
-                switch (extraKey) {
-                    case "cropper":
-                        extras["cropper"] = new extras_1.CropperExtra(extraValue);
-                        break;
-                    case "full_text_ocr":
-                        extras["fullTextOcr"] = new extras_1.FullTextOcrExtra(extraValue);
-                        break;
+                if (extraValue) {
+                    switch (extraKey) {
+                        case "cropper":
+                            extras["cropper"] = new extras_1.CropperExtra(extraValue);
+                            break;
+                        case "full_text_ocr":
+                            extras["fullTextOcr"] = new extras_1.FullTextOcrExtra(extraValue);
+                            break;
+                    }
                 }
             });
             this.extras = new extras_2.Extras(extras);
@@ -58,6 +60,14 @@ ${this.prediction.toString()}
         if (!("extras" in rawPrediction) || !("full_text_ocr" in rawPrediction["extras"])) {
             return;
         }
+        if (!rawPrediction["extras"]
+            || rawPrediction["extras"] === null ||
+            !rawPrediction["extras"]["full_text_ocr"] ||
+            rawPrediction["extras"]["full_text_ocr"] === null ||
+            !rawPrediction["extras"]["full_text_ocr"]["content"] ||
+            rawPrediction["extras"]["full_text_ocr"]["content"] === null) {
+            return;
+        }
         const fullTextOcr = rawPrediction["extras"]["full_text_ocr"]["content"];
         const artificialTextObj = {
             // eslint-disable-next-line @typescript-eslint/naming-convention

package/src/product/financialDocument/financialDocumentV1Document.d.ts

@@ -2,7 +2,7 @@ import { Prediction, StringDict } from "../../parsing/common";
 import { FinancialDocumentV1LineItem } from "./financialDocumentV1LineItem";
 import { AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, PaymentDetailsField, StringField, Taxes } from "../../parsing/standard";
 /**
- * Financial Document API version 1.11 document data.
+ * Financial Document API version 1.12 document data.
  */
 export declare class FinancialDocumentV1Document implements Prediction {
     /** The customer's address used for billing. */
@@ -26,6 +26,8 @@ export declare class FinancialDocumentV1Document implements Prediction {
      * is a receipt.
      */
     documentType: ClassificationField;
+    /** Document type extended. */
+    documentTypeExtended: ClassificationField;
     /** The date on which the payment is due. */
     dueDate: DateField;
     /** The invoice number or identifier only if document is an invoice. */

package/src/product/financialDocument/financialDocumentV1Document.js

@@ -5,7 +5,7 @@ const common_1 = require("../../parsing/common");
 const financialDocumentV1LineItem_1 = require("./financialDocumentV1LineItem");
 const standard_1 = require("../../parsing/standard");
 /**
- * Financial Document API version 1.11 document data.
+ * Financial Document API version 1.12 document data.
  */
 class FinancialDocumentV1Document {
     constructor(rawPrediction, pageId) {
@@ -54,6 +54,9 @@ class FinancialDocumentV1Document {
         this.documentType = new standard_1.ClassificationField({
             prediction: rawPrediction["document_type"],
         });
+        this.documentTypeExtended = new standard_1.ClassificationField({
+            prediction: rawPrediction["document_type_extended"],
+        });
         this.dueDate = new standard_1.DateField({
             prediction: rawPrediction["due_date"],
             pageId: pageId,
@@ -195,6 +198,7 @@ class FinancialDocumentV1Document {
 :Shipping Address: ${this.shippingAddress}
 :Billing Address: ${this.billingAddress}
 :Document Type: ${this.documentType}
+:Document Type Extended: ${this.documentTypeExtended}
 :Purchase Subcategory: ${this.subcategory}
 :Purchase Category: ${this.category}
 :Total Tax: ${this.totalTax}

package/src/product/invoice/invoiceV4Document.d.ts

@@ -2,7 +2,7 @@ import { Prediction, StringDict } from "../../parsing/common";
 import { InvoiceV4LineItem } from "./invoiceV4LineItem";
 import { AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, PaymentDetailsField, StringField, Taxes } from "../../parsing/standard";
 /**
- * Invoice API version 4.9 document data.
+ * Invoice API version 4.10 document data.
  */
 export declare class InvoiceV4Document implements Prediction {
     /** The customer billing address. */
@@ -19,6 +19,8 @@ export declare class InvoiceV4Document implements Prediction {
     date: DateField;
     /** Document type: INVOICE or CREDIT NOTE. */
     documentType: ClassificationField;
+    /** Document type extended. */
+    documentTypeExtended: ClassificationField;
     /** The date on which the payment is due. */
     dueDate: DateField;
     /** The invoice number or identifier. */

package/src/product/invoice/invoiceV4Document.js

@@ -5,7 +5,7 @@ const common_1 = require("../../parsing/common");
 const invoiceV4LineItem_1 = require("./invoiceV4LineItem");
 const standard_1 = require("../../parsing/standard");
 /**
- * Invoice API version 4.9 document data.
+ * Invoice API version 4.10 document data.
  */
 class InvoiceV4Document {
     constructor(rawPrediction, pageId) {
@@ -47,6 +47,9 @@ class InvoiceV4Document {
         this.documentType = new standard_1.ClassificationField({
             prediction: rawPrediction["document_type"],
         });
+        this.documentTypeExtended = new standard_1.ClassificationField({
+            prediction: rawPrediction["document_type_extended"],
+        });
         this.dueDate = new standard_1.DateField({
             prediction: rawPrediction["due_date"],
             pageId: pageId,
@@ -172,6 +175,7 @@ class InvoiceV4Document {
 :Shipping Address: ${this.shippingAddress}
 :Billing Address: ${this.billingAddress}
 :Document Type: ${this.documentType}
+:Document Type Extended: ${this.documentTypeExtended}
 :Line Items: ${lineItemsSummary}`.trimEnd();
         return (0, common_1.cleanOutString)(outStr);
     }

package/src/product/us/healthcareCard/healthcareCardV1Copay.js

@@ -54,7 +54,7 @@ class HealthcareCardV1Copay {
         return ("| " +
             printable.serviceFees.padEnd(12) +
             " | " +
-            printable.serviceName.padEnd(12) +
+            printable.serviceName.padEnd(20) +
             " |");
     }
 }
@@ -63,9 +63,9 @@ _HealthcareCardV1Copay_instances = new WeakSet(), _HealthcareCardV1Copay_printab
     return {
         serviceFees: this.serviceFees !== undefined ? (0, common_1.floatToString)(this.serviceFees) : "",
         serviceName: this.serviceName ?
-            this.serviceName.length <= 12 ?
+            this.serviceName.length <= 20 ?
                 (0, common_1.cleanSpecialChars)(this.serviceName) :
-                (0, common_1.cleanSpecialChars)(this.serviceName).slice(0, 9) + "..." :
+                (0, common_1.cleanSpecialChars)(this.serviceName).slice(0, 17) + "..." :
             "",
     };
 };

package/src/product/us/healthcareCard/healthcareCardV1Document.d.ts

@@ -2,7 +2,7 @@ import { Prediction, StringDict } from "../../../parsing/common";
 import { HealthcareCardV1Copay } from "./healthcareCardV1Copay";
 import { DateField, StringField } from "../../../parsing/standard";
 /**
- * Healthcare Card API version 1.1 document data.
+ * Healthcare Card API version 1.2 document data.
  */
 export declare class HealthcareCardV1Document implements Prediction {
     /** The name of the company that provides the healthcare plan. */
@@ -27,6 +27,8 @@ export declare class HealthcareCardV1Document implements Prediction {
     rxBin: StringField;
     /** The group number for prescription drug coverage. */
     rxGrp: StringField;
+    /** The ID number for prescription drug coverage. */
+    rxId: StringField;
     /** The PCN number for prescription drug coverage. */
     rxPcn: StringField;
     constructor(rawPrediction: StringDict, pageId?: number);

package/src/product/us/healthcareCard/healthcareCardV1Document.js

@@ -5,7 +5,7 @@ const common_1 = require("../../../parsing/common");
 const healthcareCardV1Copay_1 = require("./healthcareCardV1Copay");
 const standard_1 = require("../../../parsing/standard");
 /**
- * Healthcare Card API version 1.1 document data.
+ * Healthcare Card API version 1.2 document data.
  */
 class HealthcareCardV1Document {
     constructor(rawPrediction, pageId) {
@@ -59,6 +59,10 @@ class HealthcareCardV1Document {
             prediction: rawPrediction["rx_grp"],
             pageId: pageId,
         });
+        this.rxId = new standard_1.StringField({
+            prediction: rawPrediction["rx_id"],
+            pageId: pageId,
+        });
         this.rxPcn = new standard_1.StringField({
             prediction: rawPrediction["rx_pcn"],
             pageId: pageId,
@@ -71,10 +75,10 @@ class HealthcareCardV1Document {
         const dependents = this.dependents.join("\n             ");
         let copaysSummary = "";
         if (this.copays && this.copays.length > 0) {
-            const copaysColSizes = [14, 14];
+            const copaysColSizes = [14, 22];
             copaysSummary += "\n" + (0, common_1.lineSeparator)(copaysColSizes, "-") + "\n  ";
             copaysSummary += "| Service Fees ";
-            copaysSummary += "| Service Name ";
+            copaysSummary += "| Service Name         ";
             copaysSummary += "|\n" + (0, common_1.lineSeparator)(copaysColSizes, "=");
             copaysSummary += this.copays.map((item) => "\n  " + item.toTableLine() + "\n" + (0, common_1.lineSeparator)(copaysColSizes, "-")).join("");
         }
@@ -86,6 +90,7 @@ class HealthcareCardV1Document {
 :Group Number: ${this.groupNumber}
 :Payer ID: ${this.payerId}
 :RX BIN: ${this.rxBin}
+:RX ID: ${this.rxId}
 :RX GRP: ${this.rxGrp}
 :RX PCN: ${this.rxPcn}
 :copays: ${copaysSummary}