mindee 4.24.1 → 4.26.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## v4.26.0 - 2025-04-16
+### Changes
+* :sparkles: add support for rag param in workflow executions
+
+
+## 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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "4.24.1",
+    "version": "4.26.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/client.d.ts

@@ -52,6 +52,10 @@ export interface WorkflowOptions extends BaseOptions {
      * A unique, encrypted URL for accessing the document validation interface without requiring authentication.
      */
     publicUrl?: string;
+    /**
+     * Whether to enable Retrieval-Augmented Generation.
+     */
+    rag?: boolean;
 }
 /**
  * Asynchronous polling parameters.

package/src/http/httpParams.d.ts

@@ -13,5 +13,6 @@ export interface WorkflowParams extends HTTPParams {
     alias?: string;
     priority?: ExecutionPriority;
     publicUrl?: string;
+    rag?: boolean;
 }
 export {};

package/src/http/workflowEndpoint.d.ts

@@ -25,5 +25,5 @@ export declare class WorkflowEndpoint extends BaseEndpoint {
      * @param fullText
      * @param publicUrl
      */
-    protected sendFileForPrediction(input: InputSource, alias?: string | null, priority?: ExecutionPriority | null, fullText?: boolean, publicUrl?: string | null): Promise<EndpointResponse>;
+    protected sendFileForPrediction(input: InputSource, alias?: string | null, priority?: ExecutionPriority | null, fullText?: boolean, publicUrl?: string | null, rag?: boolean | null): Promise<EndpointResponse>;
 }

package/src/http/workflowEndpoint.js

@@ -11,9 +11,9 @@ var _WorkflowEndpoint_instances, _WorkflowEndpoint_workflowReqPost;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkflowEndpoint = void 0;
 const baseEndpoint_1 = require("./baseEndpoint");
+const input_1 = require("../input");
 const url_1 = require("url");
 const form_data_1 = __importDefault(require("form-data"));
-const input_1 = require("../input");
 const responseValidation_1 = require("./responseValidation");
 const error_1 = require("./error");
 /**
@@ -36,7 +36,7 @@ class WorkflowEndpoint extends baseEndpoint_1.BaseEndpoint {
         if (params.pageOptions !== undefined) {
             await super.cutDocPages(params.inputDoc, params.pageOptions);
         }
-        const response = await __classPrivateFieldGet(this, _WorkflowEndpoint_instances, "m", _WorkflowEndpoint_workflowReqPost).call(this, params.inputDoc, params.alias, params.priority, params.fullText, params.publicUrl);
+        const response = await __classPrivateFieldGet(this, _WorkflowEndpoint_instances, "m", _WorkflowEndpoint_workflowReqPost).call(this, params);
         if (!(0, responseValidation_1.isValidSyncResponse)(response)) {
             (0, error_1.handleError)(this.urlRoot, response, response.messageObj?.statusMessage);
         }
@@ -50,12 +50,15 @@ class WorkflowEndpoint extends baseEndpoint_1.BaseEndpoint {
      * @param fullText
      * @param publicUrl
      */
-    sendFileForPrediction(input, alias = null, priority = null, fullText = false, publicUrl = null) {
+    sendFileForPrediction(input, alias = null, priority = null, fullText = false, publicUrl = null, rag = null) {
         return new Promise((resolve, reject) => {
             const searchParams = new url_1.URLSearchParams();
             if (fullText) {
                 searchParams.append("full_text_ocr", "true");
             }
+            if (rag) {
+                searchParams.append("rag", "true");
+            }
             const form = new form_data_1.default();
             if (input instanceof input_1.LocalInputSource && input.fileObject instanceof Buffer) {
                 form.append("document", input.fileObject, {
@@ -94,6 +97,6 @@ class WorkflowEndpoint extends baseEndpoint_1.BaseEndpoint {
     }
 }
 exports.WorkflowEndpoint = WorkflowEndpoint;
-_WorkflowEndpoint_instances = new WeakSet(), _WorkflowEndpoint_workflowReqPost = function _WorkflowEndpoint_workflowReqPost(input, alias = null, priority = null, fullText = false, publicUrl = null) {
-    return this.sendFileForPrediction(input, alias, priority, fullText, publicUrl);
+_WorkflowEndpoint_instances = new WeakSet(), _WorkflowEndpoint_workflowReqPost = function _WorkflowEndpoint_workflowReqPost(params) {
+    return this.sendFileForPrediction(params.inputDoc, params.alias, params.priority, params.fullText, params.publicUrl, params.rag);
 };

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}