mindee 2.0.0 → 2.0.1

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 # CHANGELOG
 
-## v2.0.0 (2022-08-26)
+## v2.0.1 - 2022-10-13
+### Fixes
+* :bug: Fix for packaging and documentation related to commonJS imports
+
+## v2.0.0 - 2022-08-26
 ### Note
 This is a complete rewrite in TypeScript!
 

package/README.md

@@ -13,31 +13,35 @@ npm install mindee
 
 Finally, Node.js away!
 
-### Off-the-Shelf Document
+### Off-the-Shelf Documents
 
-```ts
-import { Client, InvoiceResponse } from "mindee";
+```js
+const mindee = require("mindee");
+// for TS or modules:
+// import * as mindee from "mindee";
 
 // Init a new client
-const mindeeClient = new Client({apiKey: "my-api-key"});
+const mindeeClient = new mindee.Client({apiKey: "my-api-key"});
 
 // Load a file from disk and parse it
 const invoiceResponse = mindeeClient.docFromPath("/path/to/the/invoice.pdf")
-  .parse(InvoiceResponse);
+    .parse(mindee.InvoiceResponse);
 
 // Print a brief summary of the parsed data
 invoiceResponse.then((resp) => {
-  console.log(resp.document);
+    console.log(resp.document);
 });
 ```
 
-### Custom Document (API Builder)
+### Custom Documents (API Builder)
 
-```ts
-import { Client, CustomResponse } from "mindee";
+```js
+const mindee = require("mindee");
+// for TS or modules:
+// import * as mindee from "mindee";
 
 // Init a new client and add your document endpoint
-const mindeeClient = new Client({apiKey: "my-api-key"})
+const mindeeClient = new mindee.Client({apiKey: "my-api-key"})
   .addEndpoint({
     accountName: "john",
     documentType: "wsnine",
@@ -45,7 +49,7 @@ const mindeeClient = new Client({apiKey: "my-api-key"})
 
 // Load a file from disk and parse it
 const customResponse = mindeeClient.docFromPath("/path/to/the/wsnine.jpg")
-  .parse(CustomResponse, {docType: "wsnine"});
+  .parse(mindee.CustomResponse, {docType: "wsnine"});
 
 // Print a brief summary of the parsed data
 customResponse.then((resp) => {

package/bin/mindee.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/bin/mindee.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_1 = require("../src/cli");
+(0, cli_1.cli)();

package/package.json

@@ -1,70 +1,70 @@
 {
-  "name": "mindee",
-  "version": "2.0.0",
-  "description": "Mindee Client Library for Node.js",
-  "main": "src/index.js",
-  "license": "MIT",
-  "scripts": {
-    "build": "tsc --build",
-    "clean": "rm -rf ./dist",
-    "test": "mocha 'tests/**/*.spec.ts'",
-    "lint-fix": "eslint 'src/**/*.ts' --fix",
-    "lint": "eslint 'src/**/*.ts' --report-unused-disable-directives && echo 'Your .ts files look good.'",
-    "docs": "jsdoc -r src -d docs"
-  },
-  "files": [
-    "dist/",
-    "bin/",
-    "LICENSE",
-    "README.md",
-    "CHANGELOG.md"
-  ],
-  "engines": {
-    "node": ">= 14.0.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/mindee/mindee-api-nodejs.git"
-  },
-  "author": {
-    "name": "Mindee",
-    "email": "devrel@mindee.com",
-    "url": "https://mindee.com/"
-  },
-  "bugs": {
-    "url": "https://github.com/mindee/mindee-api-nodejs/issues"
-  },
-  "homepage": "https://mindee.com/",
-  "devDependencies": {
-    "@tsconfig/node16": "^1.0.3",
-    "@types/chai": "^4.3.1",
-    "@types/mocha": "^9.1.1",
-    "@types/node": "^17.0.38",
-    "@typescript-eslint/eslint-plugin": "^5.30.0",
-    "@typescript-eslint/parser": "^5.30.0",
-    "chai": "^4.3.6",
-    "eslint": "^8.18.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^4.1.0",
-    "jsdoc": "^3.6.10",
-    "mocha": "^10.0.0",
-    "prettier": "^2.7.1",
-    "ts-node": "^10.8.1",
-    "typescript": "^4.7.4"
-  },
-  "dependencies": {
-    "commander": "^9.4.0",
-    "file-type": "^16.5.4",
-    "form-data": "^3.0.1",
-    "mrz": "^3.1.4",
-    "pdf-lib": "^1.17.1"
-  },
-  "keywords": [
-    "typescript",
-    "mindee",
-    "api",
-    "client",
-    "client library",
-    "nodejs"
-  ]
+    "name": "mindee",
+    "version": "2.0.1",
+    "description": "Mindee Client Library for Node.js",
+    "main": "src/index.js",
+    "bin": "bin/mindee.js",
+    "license": "MIT",
+    "scripts": {
+        "build": "tsc --build && cp LICENSE README.md CHANGELOG.md ./dist",
+        "clean": "rm -rf ./dist",
+        "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 src -d docs"
+    },
+    "files": [
+        "src/*",
+        "bin/*",
+        "LICENSE",
+        "README.md",
+        "CHANGELOG.md"
+    ],
+    "engines": {
+        "node": ">= 14"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/mindee/mindee-api-nodejs.git"
+    },
+    "author": {
+        "name": "Mindee",
+        "email": "devrel@mindee.com",
+        "url": "https://mindee.com/"
+    },
+    "bugs": {
+        "url": "https://github.com/mindee/mindee-api-nodejs/issues"
+    },
+    "homepage": "https://mindee.com/",
+    "devDependencies": {
+        "@types/chai": "^4.3.1",
+        "@types/mocha": "^9.1.1",
+        "@types/node": "^17.0.38",
+        "@typescript-eslint/eslint-plugin": "^5.30.0",
+        "@typescript-eslint/parser": "^5.30.0",
+        "chai": "^4.3.6",
+        "eslint": "^8.18.0",
+        "eslint-config-prettier": "^8.5.0",
+        "eslint-plugin-prettier": "^4.1.0",
+        "jsdoc": "^3.6.10",
+        "mocha": "^10.0.0",
+        "prettier": "^2.7.1",
+        "ts-node": "^10.8.1",
+        "typescript": "^4.7.4"
+    },
+    "dependencies": {
+        "commander": "^9.4.0",
+        "file-type": "^16.5.4",
+        "form-data": "^3.0.1",
+        "mrz": "^3.1.4",
+        "pdf-lib": "^1.17.1"
+    },
+    "keywords": [
+        "typescript",
+        "mindee",
+        "api",
+        "client",
+        "client library",
+        "nodejs"
+    ]
 }

package/{dist/src → src}/api/endpoint.js

@@ -65,7 +65,7 @@ class Endpoint {
                 if (includeWords) {
                     form.append("include_mvision", "true");
                 }
-                headers = Object.assign(Object.assign({}, headers), form.getHeaders());
+                headers = { ...headers, ...form.getHeaders() };
             }
             else if (input.inputType === "base64") {
                 const bodyObj = { document: input.fileObject };
@@ -93,7 +93,10 @@ class Endpoint {
                 });
                 res.on("end", function () {
                     try {
-                        resolve(Object.assign(Object.assign({}, res), { data: JSON.parse(responseBody) }));
+                        resolve({
+                            ...res,
+                            data: JSON.parse(responseBody),
+                        });
                     }
                     catch (error) {
                         reject(error);

package/src/cli.js

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cli = void 0;
+const commander_1 = require("commander");
+const documents_1 = require("./documents");
+const api_1 = require("./api");
+const client_1 = require("./client");
+const constants_1 = require("./constants");
+const program = new commander_1.Command();
+const COMMAND_INVOICE = "invoice";
+const COMMAND_RECEIPT = "receipt";
+const COMMAND_PASSPORT = "passport";
+const COMMAND_FINANCIAL = "financial";
+const COMMAND_CUSTOM = "custom";
+const CLI_COMMAND_CONFIG = new Map([
+    [COMMAND_INVOICE, constants_1.ProductConfigs.getByDocType(documents_1.DOC_TYPE_INVOICE)],
+    [COMMAND_RECEIPT, constants_1.ProductConfigs.getByDocType(documents_1.DOC_TYPE_RECEIPT)],
+    [COMMAND_PASSPORT, constants_1.ProductConfigs.getByDocType(documents_1.DOC_TYPE_PASSPORT)],
+    [COMMAND_FINANCIAL, constants_1.ProductConfigs.getByDocType(documents_1.DOC_TYPE_FINANCIAL)],
+    [COMMAND_CUSTOM, constants_1.ProductConfigs.getByDocType(documents_1.DOC_TYPE_CUSTOM)],
+]);
+async function predictCall(command, inputPath, options) {
+    const conf = CLI_COMMAND_CONFIG.get(command);
+    if (conf === undefined) {
+        throw new Error(`Invalid document type ${command}`);
+    }
+    const mindeeClient = new client_1.Client({
+        apiKey: options.apiKey,
+        debug: options.debug,
+    });
+    if (command === COMMAND_CUSTOM) {
+        mindeeClient.addEndpoint({
+            accountName: options.user,
+            documentType: options.documentType,
+        });
+    }
+    const doc = mindeeClient.docFromPath(inputPath);
+    const params = {
+        docType: command === COMMAND_CUSTOM ? options.documentType : conf.docType,
+        username: command === COMMAND_CUSTOM ? options.user : api_1.STANDARD_API_OWNER,
+        cutPages: options.cutPages,
+        fullText: options.fullText,
+    };
+    // Tried setting the response by using the responseClass property in constants.PRODUCTS_CONFIG
+    // This compiled, but threw an exception:
+    //   TypeError: responseType is not a constructor
+    //
+    // So using a switch to explicitly set the response class parameter. Ugly, but works.
+    // Improvements welcome!
+    let response;
+    switch (command) {
+        case COMMAND_INVOICE:
+            response = await doc.parse(api_1.InvoiceResponse, params);
+            break;
+        case COMMAND_RECEIPT:
+            response = await doc.parse(api_1.ReceiptResponse, params);
+            break;
+        case COMMAND_FINANCIAL:
+            response = await doc.parse(api_1.FinancialDocResponse, params);
+            break;
+        case COMMAND_PASSPORT:
+            response = await doc.parse(api_1.PassportResponse, params);
+            break;
+        case COMMAND_CUSTOM:
+            response = await doc.parse(api_1.CustomResponse, params);
+            break;
+        default:
+            throw `Unhandled command: ${command}`;
+    }
+    if (response.document) {
+        console.log(`\n${response.document}`);
+    }
+}
+function cli() {
+    program.name("mindee");
+    program.option("-d, --debug", "high verbosity mode");
+    CLI_COMMAND_CONFIG.forEach((info, name) => {
+        const prog = program.command(name);
+        prog.description(info.description);
+        prog.option("-k, --api-key <api_key>", "API key for document endpoint");
+        prog.option("-C, --no-cut-pages", "Don't cut document pages");
+        if (info.fullText) {
+            prog.option("-t, --full-text", "Include full document text in response");
+        }
+        if (name === COMMAND_CUSTOM) {
+            prog.requiredOption("-u, --user <username>", "API account name for the endpoint");
+            prog.option("-v, --version <version>", "API account name for the endpoint");
+            prog.argument("<endpoint_name>", "API endpoint name");
+        }
+        prog.argument("<input_path>", "Full path to the file");
+        if (name === COMMAND_CUSTOM) {
+            prog.action((endpointName, inputPath, options, command) => {
+                const allOptions = {
+                    ...program.opts(),
+                    ...options,
+                    documentType: endpointName,
+                };
+                predictCall(command.name(), inputPath, allOptions);
+            });
+        }
+        else {
+            prog.action((inputPath, options, command) => {
+                const allOptions = {
+                    ...program.opts(),
+                    ...options,
+                    endpointName: undefined,
+                };
+                predictCall(command.name(), inputPath, allOptions);
+            });
+        }
+    });
+    program.parse(process.argv);
+}
+exports.cli = cli;

package/{dist/src → src}/client.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Client = void 0;
 const inputs_1 = require("./inputs");
@@ -22,45 +13,43 @@ class DocumentClient {
         this.inputDoc = inputDoc;
         this.docConfigs = docConfigs;
     }
-    parse(responseClass, params = {
+    async parse(responseClass, params = {
         docType: "",
         username: "",
         cutPages: true,
         fullText: false,
     }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // seems like there should be a better way of doing this
-            const fullText = (params === null || params === void 0 ? void 0 : params.fullText) !== undefined ? params.fullText : false;
-            const cutPages = (params === null || params === void 0 ? void 0 : params.cutPages) !== undefined ? params.cutPages : true;
-            const docType = params.docType === undefined || params.docType === ""
-                ? this.getDocType(responseClass.name)
-                : params.docType;
-            const found = [];
-            this.docConfigs.forEach((config, configKey) => {
-                if (configKey[1] === docType) {
-                    found.push(configKey);
-                }
-            });
-            if (found.length === 0) {
-                throw `Document type not configured: '${docType}'`;
+        // seems like there should be a better way of doing this
+        const fullText = params?.fullText !== undefined ? params.fullText : false;
+        const cutPages = params?.cutPages !== undefined ? params.cutPages : true;
+        const docType = params.docType === undefined || params.docType === ""
+            ? this.getDocType(responseClass.name)
+            : params.docType;
+        const found = [];
+        this.docConfigs.forEach((config, configKey) => {
+            if (configKey[1] === docType) {
+                found.push(configKey);
             }
-            let configKey = [];
-            if (found.length === 1) {
-                configKey = found[0];
-            }
-            else if (params.username) {
-                configKey = [params.username, docType];
-            }
-            const docConfig = this.docConfigs.get(configKey);
-            if (docConfig === undefined) {
-                // TODO: raise error printing all usernames
-                throw `Couldn't find the config '${configKey}'`;
-            }
-            return yield docConfig.predict(responseClass, {
-                inputDoc: this.inputDoc,
-                includeWords: fullText,
-                cutPages: cutPages,
-            });
+        });
+        if (found.length === 0) {
+            throw `Document type not configured: '${docType}'`;
+        }
+        let configKey = [];
+        if (found.length === 1) {
+            configKey = found[0];
+        }
+        else if (params.username) {
+            configKey = [params.username, docType];
+        }
+        const docConfig = this.docConfigs.get(configKey);
+        if (docConfig === undefined) {
+            // TODO: raise error printing all usernames
+            throw `Couldn't find the config '${configKey}'`;
+        }
+        return await docConfig.predict(responseClass, {
+            inputDoc: this.inputDoc,
+            includeWords: fullText,
+            cutPages: cutPages,
         });
     }
     getDocType(responseClass) {
@@ -75,13 +64,13 @@ class Client {
      * @param options
      */
     constructor(options) {
-        const throwOnError = (options === null || options === void 0 ? void 0 : options.throwOnError) === undefined ? true : options.throwOnError;
-        const debug = (options === null || options === void 0 ? void 0 : options.debug) === undefined ? false : options.debug;
-        this.apiKey = (options === null || options === void 0 ? void 0 : options.apiKey) === undefined ? "" : options.apiKey;
+        const throwOnError = options?.throwOnError === undefined ? true : options.throwOnError;
+        const debug = options?.debug === undefined ? false : options.debug;
+        this.apiKey = options?.apiKey === undefined ? "" : options.apiKey;
         this.docConfigs = new Map();
         handler_1.errorHandler.throwOnError = throwOnError;
         logger_1.logger.level =
-            (debug !== null && debug !== void 0 ? debug : process.env.MINDEE_DEBUG)
+            debug ?? process.env.MINDEE_DEBUG
                 ? logger_1.LOG_LEVELS["debug"]
                 : logger_1.LOG_LEVELS["warn"];
         logger_1.logger.debug("Client initialized");

package/{dist/src → src}/documents/document.js

@@ -34,19 +34,18 @@ class Document {
      * @param {Array<Document>} documents - A list of Documents
      */
     static mergePages(documents) {
-        var _a, _b;
         const finalDocument = documents[0].clone();
         const attributes = Object.getOwnPropertyNames(finalDocument);
         for (const document of documents) {
             for (const attribute of attributes) {
-                if (Array.isArray(document === null || document === void 0 ? void 0 : document[attribute])) {
-                    finalDocument[attribute] = ((_a = finalDocument[attribute]) === null || _a === void 0 ? void 0 : _a.length)
+                if (Array.isArray(document?.[attribute])) {
+                    finalDocument[attribute] = finalDocument[attribute]?.length
                         ? finalDocument[attribute]
-                        : document === null || document === void 0 ? void 0 : document[attribute];
+                        : document?.[attribute];
                 }
-                else if (((_b = document === null || document === void 0 ? void 0 : document[attribute]) === null || _b === void 0 ? void 0 : _b.confidence) >
+                else if (document?.[attribute]?.confidence >
                     finalDocument[attribute].confidence) {
-                    finalDocument[attribute] = document === null || document === void 0 ? void 0 : document[attribute];
+                    finalDocument[attribute] = document?.[attribute];
                 }
             }
         }

package/{dist/src → src}/documents/documentConfig.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomDocConfig = exports.PassportConfig = exports.FinancialDocConfig = exports.ReceiptConfig = exports.InvoiceConfig = exports.DocumentConfig = void 0;
 const api_1 = require("../api");
@@ -18,10 +9,8 @@ class DocumentConfig {
         this.documentType = documentType;
         this.endpoints = endpoints;
     }
-    predictRequest(inputDoc, includeWords = false) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.endpoints[0].predictRequest(inputDoc, includeWords);
-        });
+    async predictRequest(inputDoc, includeWords = false) {
+        return await this.endpoints[0].predictRequest(inputDoc, includeWords);
     }
     buildResult(responseType, inputFile, response) {
         if (response.statusCode > 201) {
@@ -41,21 +30,17 @@ class DocumentConfig {
             error: false,
         });
     }
-    predict(responseType, params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.checkApiKeys();
-            yield params.inputDoc.init();
-            yield this.cutDocPages(params.inputDoc, params.cutPages);
-            const response = yield this.predictRequest(params.inputDoc, params.includeWords);
-            return this.buildResult(responseType, params.inputDoc, response);
-        });
+    async predict(responseType, params) {
+        this.checkApiKeys();
+        await params.inputDoc.init();
+        await this.cutDocPages(params.inputDoc, params.cutPages);
+        const response = await this.predictRequest(params.inputDoc, params.includeWords);
+        return this.buildResult(responseType, params.inputDoc, response);
     }
-    cutDocPages(inputDoc, cutPages) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (cutPages && inputDoc.isPdf()) {
-                yield inputDoc.cutPdf();
-            }
-        });
+    async cutDocPages(inputDoc, cutPages) {
+        if (cutPages && inputDoc.isPdf()) {
+            await inputDoc.cutPdf();
+        }
     }
     checkApiKeys() {
         this.endpoints.forEach((endpoint) => {
@@ -89,17 +74,15 @@ class FinancialDocConfig extends DocumentConfig {
         ];
         super(index_1.DOC_TYPE_FINANCIAL, endpoints);
     }
-    predictRequest(inputDoc, includeWords = false) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let endpoint;
-            if (inputDoc.isPdf()) {
-                endpoint = this.endpoints[0];
-            }
-            else {
-                endpoint = this.endpoints[1];
-            }
-            return yield endpoint.predictRequest(inputDoc, includeWords);
-        });
+    async predictRequest(inputDoc, includeWords = false) {
+        let endpoint;
+        if (inputDoc.isPdf()) {
+            endpoint = this.endpoints[0];
+        }
+        else {
+            endpoint = this.endpoints[1];
+        }
+        return await endpoint.predictRequest(inputDoc, includeWords);
     }
 }
 exports.FinancialDocConfig = FinancialDocConfig;

package/{dist/src → src}/documents/financialDocument.js

@@ -121,7 +121,10 @@ _FinancialDocument_instances = new WeakSet(), _FinancialDocument_initFromApiPred
     const eps = 1 / (100 * totalVat);
     if (this.totalIncl.value * (1 - eps) - 0.02 <= reconstructedTotal &&
         reconstructedTotal <= this.totalIncl.value * (1 + eps) + 0.02) {
-        this.taxes = this.taxes.map((tax) => (Object.assign(Object.assign({}, tax), { confidence: 1.0 })));
+        this.taxes = this.taxes.map((tax) => ({
+            ...tax,
+            confidence: 1.0,
+        }));
         this.totalTax.confidence = 1.0;
         this.totalIncl.confidence = 1.0;
         return true;