mindee 3.7.1 → 3.7.3

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## v3.7.3 - 2023-04-11
+### Changes
+* :arrow_up: upgrade to TypeScript 5.0.3
+* :safety_vest: ban-ts-comment should be an error
+* :white_check_mark: Add docs with code samples and use them for testing
+
+
+## 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

package/README.md

@@ -59,14 +59,14 @@ const mindee = require("mindee");
 // Init a new client and add your document endpoint
 const mindeeClient = new mindee.Client({ apiKey: "my-api-key" })
     .addEndpoint({
-        accountName: "john",
-        endpointName: "wsnine",
+        accountName: "my-account",
+        endpointName: "my-endpoint",
     });
 
 // Load a file from disk and parse it
 const apiResponse = mindeeClient
     .docFromPath("/path/to/the/file.ext")
-    .parse(mindee.CustomV1, { endpointName: "wsnine" });
+    .parse(mindee.CustomV1, { endpointName: "my-endpoint" });
 ```
 
 ### Handling the Return
@@ -96,7 +96,13 @@ customize the experience.
 All the juicy details are described in the
 **[Official Guide](https://developers.mindee.com/docs/nodejs-sdk)**.
 
+You can also take a look at the
+**[Reference Documentation](https://mindee.github.io/mindee-api-nodejs/)**.
+
 ## License
 Copyright © Mindee
 
 Available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)

package/package.json

@@ -1,18 +1,19 @@
 {
     "name": "mindee",
-    "version": "3.7.1",
+    "version": "3.7.3",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",
     "license": "MIT",
     "scripts": {
         "build": "tsc --build",
-        "build-for-publish": "tsc --build && cp LICENSE README.md CHANGELOG.md ./dist",
-        "clean": "rm -rf ./dist",
+        "build-for-dist": "tsc --build && cp LICENSE README.md CHANGELOG.md ./dist",
+        "clean": "rm -rf ./dist ./docs/_build",
         "test": "mocha 'tests/**/*.spec.ts'",
-        "lint-fix": "eslint '**/*.ts' --fix",
-        "lint": "eslint '**/*.ts' --report-unused-disable-directives && echo 'Your .ts files look good.'",
-        "docs": "jsdoc -r dist/src -d docs"
+        "lint-fix": "eslint './src/**/*.ts' --fix",
+        "lint": "eslint  './src/**/*.ts' --report-unused-disable-directives && echo 'Your .ts files look good.'",
+        "docs": "typedoc --out docs/_build ./src/index.ts",
+        "docs-for-dist": "typedoc --out docs/_build ./src/index.ts && cp -r ./docs/code_samples ./docs/_build/"
     },
     "files": [
         "src/*",
@@ -40,18 +41,18 @@
     "devDependencies": {
         "@types/chai": "^4.3.4",
         "@types/mocha": "^9.1.1",
-        "@types/node": "^18.11.18",
-        "@typescript-eslint/eslint-plugin": "^5.48.0",
-        "@typescript-eslint/parser": "^5.48.0",
+        "@types/node": "^18.15.11",
+        "@typescript-eslint/eslint-plugin": "^5.57.1",
+        "@typescript-eslint/parser": "^5.57.1",
         "chai": "^4.3.7",
-        "eslint": "^8.31.0",
+        "eslint": "^8.32.0",
         "eslint-config-prettier": "^8.6.0",
         "eslint-plugin-prettier": "^4.2.1",
-        "jsdoc": "~4.0",
+        "typedoc": "~0.23",
         "mocha": "^10.1.0",
         "prettier": "^2.8.1",
         "ts-node": "^10.9.1",
-        "typescript": "^4.9.4"
+        "typescript": "^5.0.3"
     },
     "dependencies": {
         "commander": "~9.4.1",

package/src/cli.js

@@ -235,7 +235,7 @@ async function callParseQueued(command, queueId, options) {
         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);

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");
@@ -96,6 +96,7 @@ class DocumentClient {
         return docConfig;
     }
 }
+exports.DocumentClient = DocumentClient;
 /**
  * Mindee Client
  */
@@ -127,7 +128,7 @@ class Client {
             new api_1.StandardEndpoint("invoices", "4", this.apiKey),
         ]));
         this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.InvoiceSplitterV1.name], new documentConfig_1.DocumentConfig(documents_1.InvoiceSplitterV1, [
-            new api_1.StandardEndpoint("invoice_splitter_async_beta", "1", this.apiKey),
+            new api_1.StandardEndpoint("invoice_splitter", "1", this.apiKey),
         ]));
         this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.ReceiptV3.name], new documentConfig_1.DocumentConfig(documents_1.ReceiptV3, [
             new api_1.StandardEndpoint("expense_receipts", "3", this.apiKey),

package/src/documents/custom/lineitems.d.ts

@@ -16,7 +16,7 @@ export declare class Line {
     bbox: BBox;
     /**
      * The height tolerance used to build the line.
-     * It helps when the higth of an expected line can vary.
+     * It helps when the height of an expected line can vary.
      */
     heightTolerance: number;
     constructor(rowNumber: number, heightTolerance: number);

package/src/documents/custom/lineitems.js

@@ -105,9 +105,9 @@ function prepare(anchorName, fields, heigthLineTolerance) {
     }
     let currentLineNumber = 1;
     let currentLine = new Line(currentLineNumber, heigthLineTolerance);
-    let currentValue = anchorField.values[0];
-    currentLine.extendWith(currentValue.polygon);
     if (anchorField !== undefined) {
+        let currentValue = anchorField.values[0];
+        currentLine.extendWith(currentValue.polygon);
         for (let index = 1; index < anchorField.values.length; index++) {
             currentValue = anchorField.values[index];
             const currentFieldBbox = (0, geometry_1.getBbox)(currentValue.polygon);

package/src/index.d.ts

@@ -1,4 +1,4 @@
-export { CustomV1, Document, FinancialDocumentV0, FinancialDocumentV1, InvoiceV3, InvoiceV4, InvoiceSplitterV1, PassportV1, ReceiptV3, ReceiptV4, CropperV1, ShippingContainerV1, MindeeVisionV1, 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, ProofOfAddressV1, 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.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;
+exports.PageOptionsOperation = exports.InputSource = exports.AsyncPredictResponse = exports.Response = exports.DocumentClient = exports.Client = exports.eu = exports.us = exports.fr = exports.ProofOfAddressV1 = 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; } });
@@ -15,11 +15,13 @@ Object.defineProperty(exports, "ReceiptV4", { enumerable: true, get: function ()
 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, "ProofOfAddressV1", { enumerable: true, get: function () { return documents_1.ProofOfAddressV1; } });
 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; } });

package/src/logger.d.ts

@@ -9,8 +9,9 @@ interface LoggerInterface {
 }
 export declare const LOG_LEVELS: LoggerLevels;
 declare class Logger implements LoggerInterface {
-    level: string | number;
-    constructor(level?: string | number);
+    levelToSet: string;
+    level: number;
+    constructor(levelToSet?: string);
     debug(...args: any[]): void;
     info(...args: any[]): void;
     warn(...args: any[]): void;

package/src/logger.js

@@ -8,12 +8,12 @@ exports.LOG_LEVELS = {
     error: 3,
 };
 class Logger {
-    constructor(level = "warn") {
-        this.level = level;
-        if (!(level in exports.LOG_LEVELS)) {
-            this.level = "debug";
+    constructor(levelToSet = "warn") {
+        this.levelToSet = levelToSet;
+        if (!(levelToSet in exports.LOG_LEVELS)) {
+            this.level = exports.LOG_LEVELS["debug"];
         }
-        this.level = exports.LOG_LEVELS[level];
+        this.level = exports.LOG_LEVELS[levelToSet];
     }
     debug(...args) {
         if (this.level <= exports.LOG_LEVELS["debug"])