mindee 3.7.0 → 3.7.2

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## v3.7.2 - 2023-04-04
+### Fixes
+* :bug: export DocumentClient class for easier 3rd party integration
+* :bug: only display the job info when CLI parse-queued is processing
+
+
+## v3.7.1 - 2023-03-31
+### Fixes
+* :bug: make sure all documents are exported properly
+
+
 ## v3.7.0 - 2023-03-31
 ### Changes
 * :sparkles: add support for asynchronous predictions

package/package.json

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

package/src/cli.js

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cli = void 0;
 const commander_1 = require("commander");
-const documents_1 = require("./documents");
+const _1 = require("./");
 const api_1 = require("./api");
 const client_1 = require("./client");
 const inputs_1 = require("./inputs");
@@ -42,7 +42,7 @@ const CLI_COMMAND_CONFIG = new Map([
         COMMAND_CUSTOM,
         {
             displayName: "Custom Document",
-            docClass: documents_1.CustomV1,
+            docClass: _1.CustomV1,
             fullText: false,
             async: false,
             sync: true,
@@ -52,7 +52,7 @@ const CLI_COMMAND_CONFIG = new Map([
         "invoice",
         {
             displayName: "Invoice",
-            docClass: documents_1.InvoiceV4,
+            docClass: _1.InvoiceV4,
             fullText: true,
             async: false,
             sync: true,
@@ -62,7 +62,7 @@ const CLI_COMMAND_CONFIG = new Map([
         "invoice-splitter",
         {
             displayName: "Invoice Splitter",
-            docClass: documents_1.InvoiceSplitterV1,
+            docClass: _1.InvoiceSplitterV1,
             fullText: false,
             async: true,
             sync: false,
@@ -72,7 +72,7 @@ const CLI_COMMAND_CONFIG = new Map([
         "receipt",
         {
             displayName: "Expense Receipt",
-            docClass: documents_1.ReceiptV4,
+            docClass: _1.ReceiptV4,
             fullText: true,
             async: false,
             sync: true,
@@ -82,7 +82,7 @@ const CLI_COMMAND_CONFIG = new Map([
         "passport",
         {
             displayName: "Passport",
-            docClass: documents_1.PassportV1,
+            docClass: _1.PassportV1,
             fullText: false,
             async: false,
             sync: true,
@@ -92,7 +92,7 @@ const CLI_COMMAND_CONFIG = new Map([
         "financial",
         {
             displayName: "Financial Document",
-            docClass: documents_1.FinancialDocumentV1,
+            docClass: _1.FinancialDocumentV1,
             fullText: true,
             async: false,
             sync: true,
@@ -102,7 +102,7 @@ const CLI_COMMAND_CONFIG = new Map([
         "fr-id-card",
         {
             displayName: "FR ID Card",
-            docClass: documents_1.fr.IdCardV1,
+            docClass: _1.fr.IdCardV1,
             fullText: false,
             async: false,
             sync: true,
@@ -112,7 +112,7 @@ const CLI_COMMAND_CONFIG = new Map([
         "fr-bank-account-details",
         {
             displayName: "FR Bank Account Details",
-            docClass: documents_1.fr.BankAccountDetailsV1,
+            docClass: _1.fr.BankAccountDetailsV1,
             fullText: false,
             async: false,
             sync: true,
@@ -122,7 +122,7 @@ const CLI_COMMAND_CONFIG = new Map([
         "fr-carte-vitale",
         {
             displayName: "FR Carte Vitale",
-            docClass: documents_1.fr.CarteVitaleV1,
+            docClass: _1.fr.CarteVitaleV1,
             fullText: false,
             async: false,
             sync: true,
@@ -132,7 +132,7 @@ const CLI_COMMAND_CONFIG = new Map([
         "eu-license-plate",
         {
             displayName: "EU License Plate",
-            docClass: documents_1.eu.LicensePlateV1,
+            docClass: _1.eu.LicensePlateV1,
             fullText: false,
             async: false,
             sync: true,
@@ -142,7 +142,7 @@ const CLI_COMMAND_CONFIG = new Map([
         "us-bank-check",
         {
             displayName: "US Bank Check",
-            docClass: documents_1.us.BankCheckV1,
+            docClass: _1.us.BankCheckV1,
             fullText: false,
             async: false,
             sync: true,
@@ -152,7 +152,7 @@ const CLI_COMMAND_CONFIG = new Map([
         "shipping-container",
         {
             displayName: "Shipping Container",
-            docClass: documents_1.ShippingContainerV1,
+            docClass: _1.ShippingContainerV1,
             fullText: false,
             async: false,
             sync: true,
@@ -162,7 +162,7 @@ const CLI_COMMAND_CONFIG = new Map([
         "mvision",
         {
             displayName: "Mindee Vision",
-            docClass: documents_1.MindeeVisionV1,
+            docClass: _1.MindeeVisionV1,
             fullText: false,
             async: false,
             sync: true,
@@ -225,17 +225,17 @@ async function callEnqueue(command, inputPath, options) {
     const response = await doc.enqueue(conf.docClass, predictParams);
     console.log(response.job);
 }
-async function callParseQueued(command, inputPath, options) {
+async function callParseQueued(command, queueId, options) {
     const conf = getConfig(command);
     const mindeeClient = initClient(command, options);
     const predictParams = getPredictParams(command, options, conf);
     const doc = mindeeClient.docForAsync();
-    const response = await doc.parseQueued(conf.docClass, predictParams, inputPath);
+    const response = await doc.parseQueued(conf.docClass, queueId, predictParams);
     if (response.document !== undefined) {
         printResponse(response.document, options);
     }
     else {
-        console.log(response);
+        console.log(response.job);
     }
 }
 function printResponse(response, options) {

package/src/client.d.ts

@@ -40,7 +40,7 @@ export interface PredictOptions {
      */
     pageOptions?: PageOptions;
 }
-declare class DocumentClient {
+export declare class DocumentClient {
     docConfigs: DocConfigs;
     inputSource?: InputSource;
     constructor(docConfigs: DocConfigs, inputSource?: InputSource);
@@ -56,10 +56,10 @@ declare class DocumentClient {
      * @param params
      */
     enqueue<DocType extends Document>(documentClass: DocumentSig<DocType>, params?: PredictOptions): Promise<AsyncPredictResponse<DocType>>;
-    parseQueued<DocType extends Document>(documentClass: DocumentSig<DocType>, params: {
-        endpointName?: string | undefined;
-        accountName?: string | undefined;
-    } | undefined, queueId: string): Promise<AsyncPredictResponse<DocType>>;
+    parseQueued<DocType extends Document>(documentClass: DocumentSig<DocType>, queueId: string, params?: {
+        endpointName?: string;
+        accountName?: string;
+    }): Promise<AsyncPredictResponse<DocType>>;
     protected getBooleanParam(param?: boolean): boolean;
     protected getDocConfig<DocType extends Document>(documentClass: DocumentSig<DocType>, endpointName?: string, accountName?: string): DocumentConfig<DocType>;
 }

package/src/client.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Client = void 0;
+exports.Client = exports.DocumentClient = void 0;
 const inputs_1 = require("./inputs");
 const api_1 = require("./api");
 const documents_1 = require("./documents");
@@ -58,10 +58,10 @@ class DocumentClient {
             cropper: this.getBooleanParam(params.cropper),
         });
     }
-    async parseQueued(documentClass, params = {
+    async parseQueued(documentClass, queueId, params = {
         endpointName: "",
         accountName: "",
-    }, queueId) {
+    }) {
         const docConfig = this.getDocConfig(documentClass, params.endpointName, params.accountName);
         return await docConfig.getQueuedDocument(queueId);
     }
@@ -96,6 +96,7 @@ class DocumentClient {
         return docConfig;
     }
 }
+exports.DocumentClient = DocumentClient;
 /**
  * Mindee Client
  */

package/src/index.d.ts

@@ -1,4 +1,4 @@
-export { CustomV1, Document, FinancialDocumentV0, FinancialDocumentV1, InvoiceV3, InvoiceV4, PassportV1, ReceiptV3, ReceiptV4, CropperV1, ShippingContainerV1, fr, us, eu, } from "./documents";
-export { Client, ClientOptions, CustomConfigParams, PredictOptions, } from "./client";
+export { CustomV1, Document, FinancialDocumentV0, FinancialDocumentV1, InvoiceV3, InvoiceV4, InvoiceSplitterV1, PassportV1, ReceiptV3, ReceiptV4, CropperV1, ShippingContainerV1, MindeeVisionV1, fr, us, eu, } from "./documents";
+export { Client, ClientOptions, CustomConfigParams, DocumentClient, PredictOptions, } from "./client";
 export { ResponseSig, Response, AsyncPredictResponse } from "./api";
 export { InputSource, PageOptionsOperation } from "./inputs";

package/src/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PageOptionsOperation = exports.InputSource = exports.AsyncPredictResponse = exports.Response = exports.Client = exports.eu = exports.us = exports.fr = exports.ShippingContainerV1 = exports.CropperV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PassportV1 = exports.InvoiceV4 = exports.InvoiceV3 = exports.FinancialDocumentV1 = exports.FinancialDocumentV0 = exports.Document = exports.CustomV1 = void 0;
+exports.PageOptionsOperation = exports.InputSource = exports.AsyncPredictResponse = exports.Response = exports.DocumentClient = exports.Client = exports.eu = exports.us = exports.fr = exports.MindeeVisionV1 = exports.ShippingContainerV1 = exports.CropperV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PassportV1 = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.InvoiceV3 = exports.FinancialDocumentV1 = exports.FinancialDocumentV0 = exports.Document = exports.CustomV1 = void 0;
 var documents_1 = require("./documents");
 Object.defineProperty(exports, "CustomV1", { enumerable: true, get: function () { return documents_1.CustomV1; } });
 Object.defineProperty(exports, "Document", { enumerable: true, get: function () { return documents_1.Document; } });
@@ -8,16 +8,19 @@ Object.defineProperty(exports, "FinancialDocumentV0", { enumerable: true, get: f
 Object.defineProperty(exports, "FinancialDocumentV1", { enumerable: true, get: function () { return documents_1.FinancialDocumentV1; } });
 Object.defineProperty(exports, "InvoiceV3", { enumerable: true, get: function () { return documents_1.InvoiceV3; } });
 Object.defineProperty(exports, "InvoiceV4", { enumerable: true, get: function () { return documents_1.InvoiceV4; } });
+Object.defineProperty(exports, "InvoiceSplitterV1", { enumerable: true, get: function () { return documents_1.InvoiceSplitterV1; } });
 Object.defineProperty(exports, "PassportV1", { enumerable: true, get: function () { return documents_1.PassportV1; } });
 Object.defineProperty(exports, "ReceiptV3", { enumerable: true, get: function () { return documents_1.ReceiptV3; } });
 Object.defineProperty(exports, "ReceiptV4", { enumerable: true, get: function () { return documents_1.ReceiptV4; } });
 Object.defineProperty(exports, "CropperV1", { enumerable: true, get: function () { return documents_1.CropperV1; } });
 Object.defineProperty(exports, "ShippingContainerV1", { enumerable: true, get: function () { return documents_1.ShippingContainerV1; } });
+Object.defineProperty(exports, "MindeeVisionV1", { enumerable: true, get: function () { return documents_1.MindeeVisionV1; } });
 Object.defineProperty(exports, "fr", { enumerable: true, get: function () { return documents_1.fr; } });
 Object.defineProperty(exports, "us", { enumerable: true, get: function () { return documents_1.us; } });
 Object.defineProperty(exports, "eu", { enumerable: true, get: function () { return documents_1.eu; } });
 var client_1 = require("./client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_1.Client; } });
+Object.defineProperty(exports, "DocumentClient", { enumerable: true, get: function () { return client_1.DocumentClient; } });
 var api_1 = require("./api");
 Object.defineProperty(exports, "Response", { enumerable: true, get: function () { return api_1.Response; } });
 Object.defineProperty(exports, "AsyncPredictResponse", { enumerable: true, get: function () { return api_1.AsyncPredictResponse; } });