mindee 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -1,6 +1,16 @@
 # CHANGELOG
 
-## v2.0.0 (2022-08-26)
+## v2.1.0 - 2022-10-19
+### Changes
+* :sparkles: add cropper support to predict requests
+* :sparkles: add stand-alone cropper support
+
+
+## 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.1.0",
+    "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.d.ts

@@ -12,7 +12,7 @@ export declare class Endpoint {
     /**
      * Make a prediction request.
      */
-    predictRequest(input: Input, includeWords?: boolean): Promise<unknown>;
+    predictRequest(input: Input, includeWords?: boolean, cropper?: boolean): Promise<unknown>;
     protected apiKeyFromEnv(): string;
 }
 export declare class InvoiceEndpoint extends Endpoint {
@@ -24,6 +24,9 @@ export declare class ReceiptEndpoint extends Endpoint {
 export declare class PassportEndpoint extends Endpoint {
     constructor(apiKey: string);
 }
+export declare class CropperEndpoint extends Endpoint {
+    constructor(apiKey: string);
+}
 export declare class CustomEndpoint extends Endpoint {
     constructor(documentType: string, accountName: string, version: string, apiKey: string);
 }

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

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomEndpoint = exports.PassportEndpoint = exports.ReceiptEndpoint = exports.InvoiceEndpoint = exports.Endpoint = exports.API_KEY_ENVVAR_NAME = exports.STANDARD_API_OWNER = void 0;
+exports.CustomEndpoint = exports.CropperEndpoint = exports.PassportEndpoint = exports.ReceiptEndpoint = exports.InvoiceEndpoint = exports.Endpoint = exports.API_KEY_ENVVAR_NAME = exports.STANDARD_API_OWNER = void 0;
 const https = __importStar(require("https"));
 const os = __importStar(require("os"));
 const package_json_1 = require("../../package.json");
@@ -49,7 +49,7 @@ class Endpoint {
     /**
      * Make a prediction request.
      */
-    predictRequest(input, includeWords = false) {
+    predictRequest(input, includeWords = false, cropper = false) {
         return new Promise((resolve, reject) => {
             const form = new form_data_1.default();
             let body;
@@ -57,26 +57,16 @@ class Endpoint {
                 "User-Agent": USER_AGENT,
                 Authorization: `Token ${this.apiKey}`,
             };
-            // TODO: redo this section given there should only
-            //       be a single way of reading the input doc
-            if (["path", "stream"].includes(input.inputType)) {
-                const fileParams = { filename: input.filename };
-                form.append("document", input.fileObject, fileParams);
-                if (includeWords) {
-                    form.append("include_mvision", "true");
-                }
-                headers = Object.assign(Object.assign({}, headers), form.getHeaders());
+            const uri = new url_1.URL(`${this.urlRoot}/predict`);
+            const fileParams = { filename: input.filename };
+            form.append("document", input.fileObject, fileParams);
+            if (includeWords) {
+                form.append("include_mvision", "true");
             }
-            else if (input.inputType === "base64") {
-                const bodyObj = { document: input.fileObject };
-                if (includeWords) {
-                    bodyObj["include_mvision"] = "true";
-                }
-                body = JSON.stringify(bodyObj);
-                headers["Content-Type"] = "application/json";
-                headers["Content-Length"] = body.length;
+            if (cropper) {
+                uri.searchParams.append("cropper", "true");
             }
-            const uri = new url_1.URL(`${this.urlRoot}/predict`);
+            headers = { ...headers, ...form.getHeaders() };
             const options = {
                 method: "POST",
                 headers: headers,
@@ -93,7 +83,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);
@@ -140,6 +133,12 @@ class PassportEndpoint extends Endpoint {
     }
 }
 exports.PassportEndpoint = PassportEndpoint;
+class CropperEndpoint extends Endpoint {
+    constructor(apiKey) {
+        super(exports.STANDARD_API_OWNER, "cropper", "1", apiKey);
+    }
+}
+exports.CropperEndpoint = CropperEndpoint;
 class CustomEndpoint extends Endpoint {
     constructor(documentType, accountName, version, apiKey) {
         super(accountName, documentType, version, apiKey);

package/src/api/index.d.ts

@@ -0,0 +1,2 @@
+export { Response, InvoiceResponse, ReceiptResponse, FinancialDocResponse, PassportResponse, CustomResponse, CropperResponse, } from "./response";
+export { Endpoint, InvoiceEndpoint, ReceiptEndpoint, PassportEndpoint, CustomEndpoint, CropperEndpoint, STANDARD_API_OWNER, API_KEY_ENVVAR_NAME, } from "./endpoint";

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.API_KEY_ENVVAR_NAME = exports.STANDARD_API_OWNER = exports.CustomEndpoint = exports.PassportEndpoint = exports.ReceiptEndpoint = exports.InvoiceEndpoint = exports.Endpoint = exports.CustomResponse = exports.PassportResponse = exports.FinancialDocResponse = exports.ReceiptResponse = exports.InvoiceResponse = exports.Response = void 0;
+exports.API_KEY_ENVVAR_NAME = exports.STANDARD_API_OWNER = exports.CropperEndpoint = exports.CustomEndpoint = exports.PassportEndpoint = exports.ReceiptEndpoint = exports.InvoiceEndpoint = exports.Endpoint = exports.CropperResponse = exports.CustomResponse = exports.PassportResponse = exports.FinancialDocResponse = exports.ReceiptResponse = exports.InvoiceResponse = exports.Response = void 0;
 var response_1 = require("./response");
 Object.defineProperty(exports, "Response", { enumerable: true, get: function () { return response_1.Response; } });
 Object.defineProperty(exports, "InvoiceResponse", { enumerable: true, get: function () { return response_1.InvoiceResponse; } });
@@ -8,11 +8,13 @@ Object.defineProperty(exports, "ReceiptResponse", { enumerable: true, get: funct
 Object.defineProperty(exports, "FinancialDocResponse", { enumerable: true, get: function () { return response_1.FinancialDocResponse; } });
 Object.defineProperty(exports, "PassportResponse", { enumerable: true, get: function () { return response_1.PassportResponse; } });
 Object.defineProperty(exports, "CustomResponse", { enumerable: true, get: function () { return response_1.CustomResponse; } });
+Object.defineProperty(exports, "CropperResponse", { enumerable: true, get: function () { return response_1.CropperResponse; } });
 var endpoint_1 = require("./endpoint");
 Object.defineProperty(exports, "Endpoint", { enumerable: true, get: function () { return endpoint_1.Endpoint; } });
 Object.defineProperty(exports, "InvoiceEndpoint", { enumerable: true, get: function () { return endpoint_1.InvoiceEndpoint; } });
 Object.defineProperty(exports, "ReceiptEndpoint", { enumerable: true, get: function () { return endpoint_1.ReceiptEndpoint; } });
 Object.defineProperty(exports, "PassportEndpoint", { enumerable: true, get: function () { return endpoint_1.PassportEndpoint; } });
 Object.defineProperty(exports, "CustomEndpoint", { enumerable: true, get: function () { return endpoint_1.CustomEndpoint; } });
+Object.defineProperty(exports, "CropperEndpoint", { enumerable: true, get: function () { return endpoint_1.CropperEndpoint; } });
 Object.defineProperty(exports, "STANDARD_API_OWNER", { enumerable: true, get: function () { return endpoint_1.STANDARD_API_OWNER; } });
 Object.defineProperty(exports, "API_KEY_ENVVAR_NAME", { enumerable: true, get: function () { return endpoint_1.API_KEY_ENVVAR_NAME; } });

package/{dist/src → src}/api/response.d.ts

@@ -1,4 +1,4 @@
-import { Document, Passport, Receipt, Invoice, FinancialDocument, CustomDocument, DocumentConstructorProps } from "../documents";
+import { Document, Passport, Receipt, Invoice, FinancialDocument, CustomDocument, DocumentConstructorProps, Cropper } from "../documents";
 import { FullText } from "../fields";
 import { Input } from "../inputs";
 export interface ResponseProps {
@@ -27,7 +27,7 @@ export declare class CustomResponse extends Response<CustomDocument> {
     protected formatResponse(): void;
 }
 declare type StandardDocumentSig<DocType extends Document> = {
-    new ({ apiPrediction, inputFile, pageId, fullText, }: DocumentConstructorProps): DocType;
+    new ({ prediction, inputFile, pageId, fullText, }: DocumentConstructorProps): DocType;
 };
 /**
  * Generic class for all standard (Off-the-Shelf) endpoint responses.
@@ -49,4 +49,7 @@ export declare class FinancialDocResponse extends StandardProductResponse<Financ
 export declare class PassportResponse extends StandardProductResponse<Passport> {
     constructor(params: ResponseProps);
 }
+export declare class CropperResponse extends StandardProductResponse<Cropper> {
+    constructor(params: ResponseProps);
+}
 export {};

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PassportResponse = exports.FinancialDocResponse = exports.ReceiptResponse = exports.InvoiceResponse = exports.StandardProductResponse = exports.CustomResponse = exports.Response = void 0;
+exports.CropperResponse = exports.PassportResponse = exports.FinancialDocResponse = exports.ReceiptResponse = exports.InvoiceResponse = exports.StandardProductResponse = exports.CustomResponse = exports.Response = void 0;
 const documents_1 = require("../documents");
 const fields_1 = require("../fields");
 /**
@@ -38,16 +38,20 @@ class CustomResponse extends Response {
         const httpDataDocument = this.httpResponse.data.document;
         httpDataDocument.inference.pages.forEach((apiPage) => {
             this.pages.push(new documents_1.CustomDocument({
-                apiPrediction: apiPage.prediction,
+                prediction: apiPage.prediction,
+                orientation: apiPage.orientation,
+                extras: apiPage.extras,
                 inputFile: this.inputFile,
                 pageId: apiPage.id,
                 documentType: this.documentType,
             }));
         });
         this.document = new documents_1.CustomDocument({
-            apiPrediction: httpDataDocument.inference.prediction,
+            prediction: httpDataDocument.inference.prediction,
             inputFile: this.inputFile,
             documentType: this.documentType,
+            orientation: {},
+            extras: {},
         });
     }
 }
@@ -68,15 +72,19 @@ class StandardProductResponse extends Response {
         httpDataDocument.inference.pages.forEach((apiPage) => {
             const pageText = this.getPageText(httpDataDocument, apiPage.id);
             this.pages.push(new this.documentClass({
-                apiPrediction: apiPage.prediction,
+                prediction: apiPage.prediction,
                 inputFile: this.inputFile,
                 pageId: apiPage.id,
+                orientation: apiPage.orientation,
+                extras: apiPage.extras,
                 fullText: pageText,
             }));
         });
         this.document = new this.documentClass({
-            apiPrediction: httpDataDocument.inference.prediction,
+            prediction: httpDataDocument.inference.prediction,
             inputFile: this.inputFile,
+            orientation: {},
+            extras: {},
         });
     }
 }
@@ -105,3 +113,9 @@ class PassportResponse extends StandardProductResponse {
     }
 }
 exports.PassportResponse = PassportResponse;
+class CropperResponse extends StandardProductResponse {
+    constructor(params) {
+        super(documents_1.Cropper, params);
+    }
+}
+exports.CropperResponse = CropperResponse;

package/src/cli.js

@@ -0,0 +1,125 @@
+"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 predictParams = {
+        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, predictParams);
+            break;
+        case COMMAND_RECEIPT:
+            response = await doc.parse(api_1.ReceiptResponse, predictParams);
+            break;
+        case COMMAND_FINANCIAL:
+            response = await doc.parse(api_1.FinancialDocResponse, predictParams);
+            break;
+        case COMMAND_PASSPORT:
+            response = await doc.parse(api_1.PassportResponse, predictParams);
+            break;
+        case COMMAND_CUSTOM:
+            response = await doc.parse(api_1.CustomResponse, predictParams);
+            break;
+        default:
+            throw `Unhandled command: ${command}`;
+    }
+    if (options.fullText) {
+        response.pages.forEach((page) => {
+            console.log(page.fullText?.toString());
+        });
+    }
+    if (options.pages) {
+        response.pages.forEach((page) => {
+            console.log(`\n${page}`);
+        });
+    }
+    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");
+        prog.option("-p, --pages", "Show pages content");
+        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.d.ts

@@ -10,6 +10,7 @@ interface PredictOptions {
     username?: string;
     cutPages?: boolean;
     fullText?: boolean;
+    cropper?: boolean;
 }
 declare class DocumentClient {
     inputDoc: Input;