mindee 2.0.1 → 2.1.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## v2.1.1 - 2022-10-28
+### Fixes
+* :bug: fix for sending base64 documents.
+
+## 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

package/package.json

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

package/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/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,41 +49,30 @@ 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;
             let headers = {
                 "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 = { ...headers, ...form.getHeaders() };
+            const uri = new url_1.URL(`${this.urlRoot}/predict`);
+            if (cropper) {
+                uri.searchParams.append("cropper", "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;
+            logger_1.logger.debug(`Prediction request: ${uri}`);
+            const form = new form_data_1.default();
+            const fileParams = { filename: input.filename };
+            form.append("document", input.fileObject, fileParams);
+            if (includeWords) {
+                form.append("include_mvision", "true");
             }
-            const uri = new url_1.URL(`${this.urlRoot}/predict`);
+            headers = { ...headers, ...form.getHeaders() };
             const options = {
                 method: "POST",
                 headers: headers,
                 hostname: uri.hostname,
                 path: `${uri.pathname}${uri.search}`,
             };
-            logger_1.logger.debug(`Prediction request: ${uri}`);
             const req = https.request(options, function (res) {
                 // when the encoding is set, data chunks will be strings
                 res.setEncoding("utf-8");
@@ -103,16 +92,10 @@ class Endpoint {
                     }
                 });
             });
+            form.pipe(req);
             req.on("error", (err) => {
                 reject(err);
             });
-            if (["path", "stream"].includes(input.inputType)) {
-                form.pipe(req);
-            }
-            if (input.inputType === "base64") {
-                req.write(body);
-                req.end();
-            }
         });
     }
     apiKeyFromEnv() {
@@ -143,6 +126,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

@@ -1,2 +1,2 @@
-export { Response, InvoiceResponse, ReceiptResponse, FinancialDocResponse, PassportResponse, CustomResponse, } from "./response";
-export { Endpoint, InvoiceEndpoint, ReceiptEndpoint, PassportEndpoint, CustomEndpoint, STANDARD_API_OWNER, API_KEY_ENVVAR_NAME, } from "./endpoint";
+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/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/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/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

@@ -35,7 +35,7 @@ async function predictCall(command, inputPath, options) {
         });
     }
     const doc = mindeeClient.docFromPath(inputPath);
-    const params = {
+    const predictParams = {
         docType: command === COMMAND_CUSTOM ? options.documentType : conf.docType,
         username: command === COMMAND_CUSTOM ? options.user : api_1.STANDARD_API_OWNER,
         cutPages: options.cutPages,
@@ -50,23 +50,33 @@ async function predictCall(command, inputPath, options) {
     let response;
     switch (command) {
         case COMMAND_INVOICE:
-            response = await doc.parse(api_1.InvoiceResponse, params);
+            response = await doc.parse(api_1.InvoiceResponse, predictParams);
             break;
         case COMMAND_RECEIPT:
-            response = await doc.parse(api_1.ReceiptResponse, params);
+            response = await doc.parse(api_1.ReceiptResponse, predictParams);
             break;
         case COMMAND_FINANCIAL:
-            response = await doc.parse(api_1.FinancialDocResponse, params);
+            response = await doc.parse(api_1.FinancialDocResponse, predictParams);
             break;
         case COMMAND_PASSPORT:
-            response = await doc.parse(api_1.PassportResponse, params);
+            response = await doc.parse(api_1.PassportResponse, predictParams);
             break;
         case COMMAND_CUSTOM:
-            response = await doc.parse(api_1.CustomResponse, params);
+            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}`);
     }
@@ -79,6 +89,7 @@ function cli() {
         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");
         }

package/src/client.d.ts

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

package/src/client.js

@@ -18,9 +18,11 @@ class DocumentClient {
         username: "",
         cutPages: true,
         fullText: false,
+        cropper: false,
     }) {
         // seems like there should be a better way of doing this
         const fullText = params?.fullText !== undefined ? params.fullText : false;
+        const cropper = params?.cropper !== undefined ? params.cropper : false;
         const cutPages = params?.cutPages !== undefined ? params.cutPages : true;
         const docType = params.docType === undefined || params.docType === ""
             ? this.getDocType(responseClass.name)
@@ -50,6 +52,7 @@ class DocumentClient {
             inputDoc: this.inputDoc,
             includeWords: fullText,
             cutPages: cutPages,
+            cropper: cropper,
         });
     }
     getDocType(responseClass) {
@@ -82,6 +85,7 @@ class Client {
         this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.DOC_TYPE_RECEIPT], new documentConfig_1.ReceiptConfig(this.apiKey));
         this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.DOC_TYPE_FINANCIAL], new documentConfig_1.FinancialDocConfig(this.apiKey));
         this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.DOC_TYPE_PASSPORT], new documentConfig_1.PassportConfig(this.apiKey));
+        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.DOC_TYPE_CROPPER], new documentConfig_1.CropperConfig(this.apiKey));
     }
     addEndpoint({ accountName, documentType, version = "1", }) {
         this.docConfigs.set([accountName, documentType], new documentConfig_1.CustomDocConfig({

package/src/constants.js

@@ -51,4 +51,10 @@ ProductConfigs.configs = [
         responseClass: api_1.CustomResponse,
         fullText: false,
     },
+    {
+        description: "Cropper",
+        docType: documents_1.DOC_TYPE_CROPPER,
+        responseClass: api_1.CropperResponse,
+        fullText: false,
+    },
 ];

package/src/documents/cropper.d.ts

@@ -0,0 +1,7 @@
+import { Document, DocumentConstructorProps } from "./document";
+import { CropperField } from "../fields";
+export declare class Cropper extends Document {
+    cropping: CropperField[];
+    constructor({ prediction, orientation, inputFile, pageId, }: DocumentConstructorProps);
+    toString(): string;
+}

package/src/documents/cropper.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Cropper = void 0;
+const document_1 = require("./document");
+const fields_1 = require("../fields");
+class Cropper extends document_1.Document {
+    constructor({ prediction, orientation = undefined, inputFile = undefined, pageId = undefined, }) {
+        super({ inputFile, pageId, orientation });
+        this.cropping = [];
+        if (pageId !== undefined) {
+            prediction.cropping.forEach((crop) => {
+                this.cropping.push(new fields_1.CropperField({
+                    prediction: crop,
+                    pageId: pageId,
+                }));
+            });
+        }
+    }
+    toString() {
+        const cropping = this.cropping
+            .map((crop) => crop.toString())
+            .join("\n          ");
+        const outStr = `----- Cropper Data -----
+Filename: ${this.filename}
+Cropping: ${cropping}
+------------------------
+`;
+        return Cropper.cleanOutString(outStr);
+    }
+}
+exports.Cropper = Cropper;

package/src/documents/custom.d.ts

@@ -1,6 +1,6 @@
 import { Document, DocumentConstructorProps } from "./document";
 import { ClassificationField, ListField } from "../fields";
-import { stringDict } from "../fields/field";
+import { stringDict } from "../fields";
 export interface CustomDocConstructorProps extends DocumentConstructorProps {
     documentType: string;
 }
@@ -8,7 +8,7 @@ export declare class CustomDocument extends Document {
     fields: Map<string, ListField>;
     classifications: Map<string, ClassificationField>;
     readonly documentType: string;
-    constructor({ inputFile, apiPrediction, pageId, documentType, }: CustomDocConstructorProps);
+    constructor({ inputFile, prediction, extras, orientation, pageId, documentType, }: CustomDocConstructorProps);
     protected setField(fieldName: string, apiPrediction: stringDict, pageId: number | undefined): void;
     toString(): string;
 }

package/src/documents/custom.js

@@ -4,13 +4,13 @@ exports.CustomDocument = void 0;
 const document_1 = require("./document");
 const fields_1 = require("../fields");
 class CustomDocument extends document_1.Document {
-    constructor({ inputFile, apiPrediction, pageId, documentType, }) {
-        super(inputFile, pageId);
+    constructor({ inputFile, prediction, extras = undefined, orientation = undefined, pageId, documentType, }) {
+        super({ inputFile, pageId, orientation, extras });
         this.fields = new Map();
         this.classifications = new Map();
         this.documentType = documentType;
-        Object.keys(apiPrediction).forEach((fieldName) => {
-            this.setField(fieldName, apiPrediction, pageId);
+        Object.keys(prediction).forEach((fieldName) => {
+            this.setField(fieldName, prediction, pageId);
         });
     }
     setField(fieldName, apiPrediction, pageId) {

package/src/documents/document.d.ts

@@ -1,30 +1,33 @@
 import { Input } from "../inputs";
-import { FullText } from "../fields";
-export interface DocumentConstructorProps {
-    apiPrediction: {
-        [index: string]: any;
-    };
+import { CropperField, FullText, OrientationField, stringDict } from "../fields";
+export interface DocumentConstructorProps extends BaseDocumentConstructorProps {
+    /** JSON parsed prediction from HTTP response */
+    prediction: stringDict;
+}
+interface BaseDocumentConstructorProps {
+    /** Orientation JSON for page-level document */
+    orientation?: stringDict;
+    /** Extras JSON */
+    extras?: stringDict;
+    /** input file given to parse the document */
     inputFile?: Input;
+    /** Page ID for page-level document */
     pageId?: number;
+    /** full OCR extracted text */
     fullText?: FullText;
 }
 export declare class Document {
     checklist: {
         [index: string]: boolean;
     };
-    mimeType: string | undefined;
+    mimeType?: string;
     filename: string;
-    filepath: string | undefined;
+    filepath?: string;
     fullText?: FullText;
     pageId?: number | undefined;
-    /**
-     * Takes a list of Documents and return one Document where
-     * each field is set with the maximum probability field
-     * @param {Input} inputFile - input file given to parse the document
-     * @param {number} pageId - Page ID for multi-page document
-     * @param {FullText} fullText - full OCR extracted text
-     */
-    constructor(inputFile?: Input, pageId?: number, fullText?: FullText);
+    orientation?: OrientationField;
+    cropper: CropperField[];
+    constructor({ orientation, extras, inputFile, fullText, pageId, }: BaseDocumentConstructorProps);
     clone(): any;
     /** return true if all checklist of the document if true */
     checkAll(): boolean;
@@ -36,3 +39,4 @@ export declare class Document {
     static mergePages(documents: any): any;
     static cleanOutString(outStr: string): string;
 }
+export {};

package/src/documents/document.js

@@ -1,18 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Document = void 0;
+const fields_1 = require("../fields");
 class Document {
-    /**
-     * Takes a list of Documents and return one Document where
-     * each field is set with the maximum probability field
-     * @param {Input} inputFile - input file given to parse the document
-     * @param {number} pageId - Page ID for multi-page document
-     * @param {FullText} fullText - full OCR extracted text
-     */
-    constructor(inputFile, pageId, fullText) {
+    constructor({ orientation = undefined, extras = undefined, inputFile = undefined, fullText = undefined, pageId = undefined, }) {
         this.filename = "";
+        this.cropper = [];
         this.filepath = undefined;
         this.pageId = pageId;
+        if (pageId !== undefined && orientation !== undefined) {
+            this.orientation = new fields_1.OrientationField({
+                prediction: orientation,
+                pageId: pageId,
+            });
+        }
+        if (extras !== undefined) {
+            if (extras.cropper !== undefined) {
+                extras.cropper.cropping.forEach((crop) => {
+                    this.cropper.push(new fields_1.CropperField({
+                        prediction: crop,
+                        pageId: pageId,
+                    }));
+                });
+            }
+        }
         if (inputFile !== undefined) {
             this.filepath = inputFile.filepath;
             this.filename = inputFile.filename;

package/src/documents/documentConfig.d.ts

@@ -15,12 +15,13 @@ export declare class DocumentConfig {
     readonly documentType: string;
     readonly endpoints: Array<Endpoint>;
     constructor(documentType: string, endpoints: Array<Endpoint>);
-    predictRequest(inputDoc: Input, includeWords?: boolean): Promise<unknown>;
+    predictRequest(inputDoc: Input, includeWords: boolean, cropping: boolean): Promise<unknown>;
     buildResult<RespType extends Response<Document>>(responseType: responseSig<RespType>, inputFile: Input, response: any): RespType;
     predict<RespType extends Response<Document>>(responseType: responseSig<RespType>, params: {
         inputDoc: Input;
         includeWords: boolean;
         cutPages: boolean;
+        cropper: boolean;
     }): Promise<RespType>;
     cutDocPages(inputDoc: Input, cutPages: boolean): Promise<void>;
     protected checkApiKeys(): void;
@@ -33,11 +34,14 @@ export declare class ReceiptConfig extends DocumentConfig {
 }
 export declare class FinancialDocConfig extends DocumentConfig {
     constructor(apiKey: string);
-    predictRequest(inputDoc: Input, includeWords?: boolean): Promise<unknown>;
+    predictRequest(inputDoc: Input, includeWords: boolean, cropping: boolean): Promise<unknown>;
 }
 export declare class PassportConfig extends DocumentConfig {
     constructor(apiKey: string);
 }
+export declare class CropperConfig extends DocumentConfig {
+    constructor(apiKey: string);
+}
 export declare class CustomDocConfig extends DocumentConfig {
     constructor({ documentType, accountName, version, apiKey, }: CustomDocConstructor);
 }

package/src/documents/documentConfig.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomDocConfig = exports.PassportConfig = exports.FinancialDocConfig = exports.ReceiptConfig = exports.InvoiceConfig = exports.DocumentConfig = void 0;
+exports.CustomDocConfig = exports.CropperConfig = exports.PassportConfig = exports.FinancialDocConfig = exports.ReceiptConfig = exports.InvoiceConfig = exports.DocumentConfig = void 0;
 const api_1 = require("../api");
 const index_1 = require("./index");
 const handler_1 = require("../errors/handler");
@@ -9,8 +9,8 @@ class DocumentConfig {
         this.documentType = documentType;
         this.endpoints = endpoints;
     }
-    async predictRequest(inputDoc, includeWords = false) {
-        return await this.endpoints[0].predictRequest(inputDoc, includeWords);
+    async predictRequest(inputDoc, includeWords, cropping) {
+        return await this.endpoints[0].predictRequest(inputDoc, includeWords, cropping);
     }
     buildResult(responseType, inputFile, response) {
         if (response.statusCode > 201) {
@@ -34,7 +34,7 @@ class DocumentConfig {
         this.checkApiKeys();
         await params.inputDoc.init();
         await this.cutDocPages(params.inputDoc, params.cutPages);
-        const response = await this.predictRequest(params.inputDoc, params.includeWords);
+        const response = await this.predictRequest(params.inputDoc, params.includeWords, params.cropper);
         return this.buildResult(responseType, params.inputDoc, response);
     }
     async cutDocPages(inputDoc, cutPages) {
@@ -74,7 +74,7 @@ class FinancialDocConfig extends DocumentConfig {
         ];
         super(index_1.DOC_TYPE_FINANCIAL, endpoints);
     }
-    async predictRequest(inputDoc, includeWords = false) {
+    async predictRequest(inputDoc, includeWords, cropping) {
         let endpoint;
         if (inputDoc.isPdf()) {
             endpoint = this.endpoints[0];
@@ -82,7 +82,7 @@ class FinancialDocConfig extends DocumentConfig {
         else {
             endpoint = this.endpoints[1];
         }
-        return await endpoint.predictRequest(inputDoc, includeWords);
+        return await endpoint.predictRequest(inputDoc, includeWords, cropping);
     }
 }
 exports.FinancialDocConfig = FinancialDocConfig;
@@ -93,6 +93,13 @@ class PassportConfig extends DocumentConfig {
     }
 }
 exports.PassportConfig = PassportConfig;
+class CropperConfig extends DocumentConfig {
+    constructor(apiKey) {
+        const endpoints = [new api_1.CropperEndpoint(apiKey)];
+        super(index_1.DOC_TYPE_CROPPER, endpoints);
+    }
+}
+exports.CropperConfig = CropperConfig;
 class CustomDocConfig extends DocumentConfig {
     constructor({ documentType, accountName, version, apiKey, }) {
         const endpoints = [

package/src/documents/financialDocument.d.ts

@@ -1,5 +1,5 @@
 import { Document, DocumentConstructorProps } from "./document";
-import { TaxField, Field, Amount, Locale, Orientation, DateField as Date, CompanyRegistration } from "../fields";
+import { TaxField, Field, Amount, Locale, DateField as Date, CompanyRegistration } from "../fields";
 export declare class FinancialDocument extends Document {
     #private;
     pageId: number | undefined;
@@ -9,7 +9,6 @@ export declare class FinancialDocument extends Document {
     dueDate: Date;
     category: Field;
     time: Field;
-    orientation: Orientation | undefined;
     taxes: TaxField[];
     totalTax: Amount;
     totalExcl: Amount;
@@ -21,12 +20,6 @@ export declare class FinancialDocument extends Document {
     customerAddress: Field;
     paymentDetails: Field[];
     customerCompanyRegistration: CompanyRegistration[];
-    /**
-     * @param {Object} apiPrediction - Json parsed prediction from HTTP response
-     * @param {Input} inputFile - input file given to parse the document
-     * @param {number} pageId - Page ID for multi-page document
-     * @param {FullText} fullText - full OCR extracted text
-     */
-    constructor({ apiPrediction, inputFile, fullText, pageId, }: DocumentConstructorProps);
+    constructor({ prediction, orientation, extras, inputFile, fullText, pageId, }: DocumentConstructorProps);
     toString(): string;
 }

package/src/documents/financialDocument.js

@@ -12,20 +12,14 @@ const invoice_1 = require("./invoice");
 const receipt_1 = require("./receipt");
 const fields_1 = require("../fields");
 class FinancialDocument extends document_1.Document {
-    /**
-     * @param {Object} apiPrediction - Json parsed prediction from HTTP response
-     * @param {Input} inputFile - input file given to parse the document
-     * @param {number} pageId - Page ID for multi-page document
-     * @param {FullText} fullText - full OCR extracted text
-     */
-    constructor({ apiPrediction, inputFile = undefined, fullText = undefined, pageId = undefined, }) {
-        super(inputFile, pageId, fullText);
+    constructor({ prediction, orientation = undefined, extras = undefined, inputFile = undefined, fullText = undefined, pageId = undefined, }) {
+        super({ inputFile, pageId, fullText, orientation, extras });
         _FinancialDocument_instances.add(this);
         this.taxes = [];
         this.companyRegistration = [];
         this.paymentDetails = [];
         this.customerCompanyRegistration = [];
-        __classPrivateFieldGet(this, _FinancialDocument_instances, "m", _FinancialDocument_initFromApiPrediction).call(this, apiPrediction, inputFile, pageId);
+        __classPrivateFieldGet(this, _FinancialDocument_instances, "m", _FinancialDocument_initFromApiPrediction).call(this, prediction, inputFile, pageId, orientation, extras);
         __classPrivateFieldGet(this, _FinancialDocument_instances, "m", _FinancialDocument_checklist).call(this);
     }
     toString() {
@@ -41,12 +35,14 @@ Total taxes: ${this.totalTax.value}
     }
 }
 exports.FinancialDocument = FinancialDocument;
-_FinancialDocument_instances = new WeakSet(), _FinancialDocument_initFromApiPrediction = function _FinancialDocument_initFromApiPrediction(prediction, inputFile, pageNumber) {
+_FinancialDocument_instances = new WeakSet(), _FinancialDocument_initFromApiPrediction = function _FinancialDocument_initFromApiPrediction(prediction, inputFile, pageNumber, orientation, extras) {
     if (Object.keys(prediction).includes("invoice_number")) {
         const invoice = new invoice_1.Invoice({
-            apiPrediction: prediction,
+            prediction: prediction,
             inputFile,
             pageId: pageNumber,
+            orientation: orientation,
+            extras: extras,
         });
         this.locale = invoice.locale;
         this.totalIncl = invoice.totalIncl;
@@ -70,9 +66,11 @@ _FinancialDocument_instances = new WeakSet(), _FinancialDocument_initFromApiPred
     }
     else {
         const receipt = new receipt_1.Receipt({
-            apiPrediction: prediction,
+            prediction: prediction,
             inputFile,
             pageId: pageNumber,
+            orientation: orientation,
+            extras: extras,
         });
         this.orientation = receipt.orientation;
         this.date = receipt.date;

package/src/documents/index.d.ts

@@ -3,10 +3,12 @@ import { Receipt } from "./receipt";
 import { Passport } from "./passport";
 import { FinancialDocument } from "./financialDocument";
 import { CustomDocument } from "./custom";
+import { Cropper } from "./cropper";
 export { Document, DocumentConstructorProps } from "./document";
-export { Receipt, Invoice, FinancialDocument, Passport, CustomDocument };
+export { Receipt, Invoice, FinancialDocument, Passport, CustomDocument, Cropper, };
 export declare const DOC_TYPE_INVOICE: string;
 export declare const DOC_TYPE_RECEIPT: string;
 export declare const DOC_TYPE_PASSPORT: string;
 export declare const DOC_TYPE_FINANCIAL: string;
 export declare const DOC_TYPE_CUSTOM: string;
+export declare const DOC_TYPE_CROPPER: string;

package/src/documents/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DOC_TYPE_CUSTOM = exports.DOC_TYPE_FINANCIAL = exports.DOC_TYPE_PASSPORT = exports.DOC_TYPE_RECEIPT = exports.DOC_TYPE_INVOICE = exports.CustomDocument = exports.Passport = exports.FinancialDocument = exports.Invoice = exports.Receipt = exports.Document = void 0;
+exports.DOC_TYPE_CROPPER = exports.DOC_TYPE_CUSTOM = exports.DOC_TYPE_FINANCIAL = exports.DOC_TYPE_PASSPORT = exports.DOC_TYPE_RECEIPT = exports.DOC_TYPE_INVOICE = exports.Cropper = exports.CustomDocument = exports.Passport = exports.FinancialDocument = exports.Invoice = exports.Receipt = exports.Document = void 0;
 const invoice_1 = require("./invoice");
 Object.defineProperty(exports, "Invoice", { enumerable: true, get: function () { return invoice_1.Invoice; } });
 const receipt_1 = require("./receipt");
@@ -11,6 +11,8 @@ const financialDocument_1 = require("./financialDocument");
 Object.defineProperty(exports, "FinancialDocument", { enumerable: true, get: function () { return financialDocument_1.FinancialDocument; } });
 const custom_1 = require("./custom");
 Object.defineProperty(exports, "CustomDocument", { enumerable: true, get: function () { return custom_1.CustomDocument; } });
+const cropper_1 = require("./cropper");
+Object.defineProperty(exports, "Cropper", { enumerable: true, get: function () { return cropper_1.Cropper; } });
 var document_1 = require("./document");
 Object.defineProperty(exports, "Document", { enumerable: true, get: function () { return document_1.Document; } });
 exports.DOC_TYPE_INVOICE = invoice_1.Invoice.name;
@@ -18,3 +20,4 @@ exports.DOC_TYPE_RECEIPT = receipt_1.Receipt.name;
 exports.DOC_TYPE_PASSPORT = passport_1.Passport.name;
 exports.DOC_TYPE_FINANCIAL = financialDocument_1.FinancialDocument.name;
 exports.DOC_TYPE_CUSTOM = custom_1.CustomDocument.name;
+exports.DOC_TYPE_CROPPER = cropper_1.Cropper.name;

package/src/documents/invoice.d.ts

@@ -1,5 +1,5 @@
 import { Document, DocumentConstructorProps } from "./document";
-import { BaseField, TaxField, PaymentDetails, Orientation, Locale, Amount, Field, DateField, CompanyRegistration } from "../fields";
+import { BaseField, TaxField, PaymentDetails, Locale, Amount, Field, DateField, CompanyRegistration } from "../fields";
 export declare class Invoice extends Document {
     #private;
     locale: Locale;
@@ -8,7 +8,6 @@ export declare class Invoice extends Document {
     date: DateField;
     dueDate: DateField;
     time: Field;
-    orientation: Orientation;
     totalTax: Amount;
     totalExcl: Amount;
     supplier: Field;
@@ -20,13 +19,7 @@ export declare class Invoice extends Document {
     taxes: TaxField[];
     paymentDetails: PaymentDetails[];
     customerCompanyRegistration: CompanyRegistration[];
-    /**
-     * @param {Object} apiPrediction - Json parsed prediction from HTTP response
-     * @param {Input} inputFile - input file given to parse the document
-     * @param {number} pageId - Page ID for multi-page document
-     * @param {FullText} fullText - full OCR extracted text
-     */
-    constructor({ apiPrediction, inputFile, fullText, pageId, }: DocumentConstructorProps);
+    constructor({ prediction, orientation, extras, inputFile, fullText, pageId, }: DocumentConstructorProps);
     toString(): string;
     private taxesMatchTotalIncl;
     /**

package/src/documents/invoice.js

@@ -10,20 +10,14 @@ exports.Invoice = void 0;
 const document_1 = require("./document");
 const fields_1 = require("../fields");
 class Invoice extends document_1.Document {
-    /**
-     * @param {Object} apiPrediction - Json parsed prediction from HTTP response
-     * @param {Input} inputFile - input file given to parse the document
-     * @param {number} pageId - Page ID for multi-page document
-     * @param {FullText} fullText - full OCR extracted text
-     */
-    constructor({ apiPrediction, inputFile = undefined, fullText = undefined, pageId = undefined, }) {
-        super(inputFile, pageId, fullText);
+    constructor({ prediction, orientation = undefined, extras = undefined, inputFile = undefined, fullText = undefined, pageId = undefined, }) {
+        super({ inputFile, pageId, fullText, orientation, extras });
         _Invoice_instances.add(this);
         this.companyRegistration = [];
         this.taxes = [];
         this.paymentDetails = [];
         this.customerCompanyRegistration = [];
-        __classPrivateFieldGet(this, _Invoice_instances, "m", _Invoice_initFromApiPrediction).call(this, apiPrediction, pageId);
+        __classPrivateFieldGet(this, _Invoice_instances, "m", _Invoice_initFromApiPrediction).call(this, prediction, pageId);
         __classPrivateFieldGet(this, _Invoice_instances, "m", _Invoice_checklist).call(this);
         __classPrivateFieldGet(this, _Invoice_instances, "m", _Invoice_reconstruct).call(this);
     }
@@ -218,12 +212,6 @@ _Invoice_instances = new WeakSet(), _Invoice_initFromApiPrediction = function _I
         prediction: prediction,
         pageId: pageId,
     })));
-    if (pageId !== undefined) {
-        this.orientation = new fields_1.Orientation({
-            prediction: apiPrediction.orientation,
-            pageId: pageId,
-        });
-    }
 }, _Invoice_checklist = function _Invoice_checklist() {
     this.checklist = {
         taxesMatchTotalIncl: this.taxesMatchTotalIncl(),

package/src/documents/passport.d.ts

@@ -15,13 +15,7 @@ export declare class Passport extends Document {
     givenNames: Field[];
     fullName: Field;
     mrz: Field;
-    /**
-     * @param {Object} apiPrediction - Json parsed prediction from HTTP response
-     * @param {Input} inputFile - input file given to parse the document
-     * @param {number} pageId - Page ID for multi-page document
-     * @param {FullText} fullText - full OCR extracted text
-     */
-    constructor({ apiPrediction, inputFile, pageId, }: DocumentConstructorProps);
+    constructor({ prediction, orientation, extras, inputFile, pageId, }: DocumentConstructorProps);
     static convertMRZDateToDatetime(dateString: string): Date;
     toString(): string;
     isExpired(): boolean;

package/src/documents/passport.js

@@ -35,57 +35,51 @@ const fields_1 = require("../fields");
 // @ts-ignore
 const MRZ = __importStar(require("mrz"));
 class Passport extends document_1.Document {
-    /**
-     * @param {Object} apiPrediction - Json parsed prediction from HTTP response
-     * @param {Input} inputFile - input file given to parse the document
-     * @param {number} pageId - Page ID for multi-page document
-     * @param {FullText} fullText - full OCR extracted text
-     */
-    constructor({ apiPrediction, inputFile = undefined, pageId = undefined, }) {
-        super(inputFile, pageId);
+    constructor({ prediction, orientation = undefined, extras = undefined, inputFile = undefined, pageId = undefined, }) {
+        super({ inputFile, pageId, orientation, extras });
         _Passport_instances.add(this);
         this.givenNames = [];
         this.country = new fields_1.Field({
-            prediction: apiPrediction.country,
+            prediction: prediction.country,
             pageId: pageId,
         });
         this.idNumber = new fields_1.Field({
-            prediction: apiPrediction.id_number,
+            prediction: prediction.id_number,
             pageId: pageId,
         });
         this.birthDate = new fields_1.DateField({
-            prediction: apiPrediction.birth_date,
+            prediction: prediction.birth_date,
             pageId: pageId,
         });
         this.expiryDate = new fields_1.DateField({
-            prediction: apiPrediction.expiry_date,
+            prediction: prediction.expiry_date,
             pageId: pageId,
         });
         this.issuanceDate = new fields_1.DateField({
-            prediction: apiPrediction.issuance_date,
+            prediction: prediction.issuance_date,
             pageId: pageId,
         });
         this.birthPlace = new fields_1.Field({
-            prediction: apiPrediction.birth_place,
+            prediction: prediction.birth_place,
             pageId: pageId,
         });
         this.gender = new fields_1.Field({
-            prediction: apiPrediction.gender,
+            prediction: prediction.gender,
             pageId: pageId,
         });
         this.surname = new fields_1.Field({
-            prediction: apiPrediction.surname,
+            prediction: prediction.surname,
             pageId: pageId,
         });
         this.mrz1 = new fields_1.Field({
-            prediction: apiPrediction.mrz1,
+            prediction: prediction.mrz1,
             pageId: pageId,
         });
         this.mrz2 = new fields_1.Field({
-            prediction: apiPrediction.mrz2,
+            prediction: prediction.mrz2,
             pageId: pageId,
         });
-        apiPrediction.given_names.map((prediction) => this.givenNames.push(new fields_1.Field({
+        prediction.given_names.map((prediction) => this.givenNames.push(new fields_1.Field({
             prediction: prediction,
             pageId: pageId,
         })));

package/src/documents/receipt.d.ts

@@ -1,5 +1,5 @@
 import { Document, DocumentConstructorProps } from "./document";
-import { TaxField, Field, Amount, Locale, Orientation, DateField } from "../fields";
+import { TaxField, Field, Amount, Locale, DateField } from "../fields";
 export declare class Receipt extends Document {
     #private;
     locale: Locale;
@@ -9,16 +9,9 @@ export declare class Receipt extends Document {
     category: Field;
     merchantName: Field;
     time: Field;
-    orientation: Orientation | undefined;
     totalTax: Amount;
     totalExcl: Amount;
     taxes: TaxField[];
-    /**
-     * @param {Object} apiPrediction - Json parsed prediction from HTTP response
-     * @param {Input} inputFile - input file given to parse the document
-     * @param {number} pageId - Page ID for multi-page document
-     * @param {FullText} fullText - full OCR extracted text
-     */
-    constructor({ apiPrediction, inputFile, fullText, pageId, }: DocumentConstructorProps);
+    constructor({ prediction, orientation, extras, inputFile, fullText, pageId, }: DocumentConstructorProps);
     toString(): string;
 }

package/src/documents/receipt.js

@@ -10,18 +10,12 @@ exports.Receipt = void 0;
 const document_1 = require("./document");
 const fields_1 = require("../fields");
 class Receipt extends document_1.Document {
-    /**
-     * @param {Object} apiPrediction - Json parsed prediction from HTTP response
-     * @param {Input} inputFile - input file given to parse the document
-     * @param {number} pageId - Page ID for multi-page document
-     * @param {FullText} fullText - full OCR extracted text
-     */
-    constructor({ apiPrediction, inputFile = undefined, fullText = undefined, pageId = undefined, }) {
-        super(inputFile, pageId, fullText);
+    constructor({ prediction, orientation = undefined, extras = undefined, inputFile = undefined, fullText = undefined, pageId = undefined, }) {
+        super({ inputFile, pageId, fullText, orientation, extras });
         _Receipt_instances.add(this);
         this.taxes = [];
         this.locale = new fields_1.Locale({
-            prediction: apiPrediction.locale,
+            prediction: prediction.locale,
             pageId: pageId,
         });
         this.totalTax = new fields_1.Amount({
@@ -34,7 +28,7 @@ class Receipt extends document_1.Document {
             valueKey: "value",
             pageId: pageId,
         });
-        __classPrivateFieldGet(this, _Receipt_instances, "m", _Receipt_initFromApiPrediction).call(this, apiPrediction, pageId);
+        __classPrivateFieldGet(this, _Receipt_instances, "m", _Receipt_initFromApiPrediction).call(this, prediction, pageId);
         __classPrivateFieldGet(this, _Receipt_instances, "m", _Receipt_checklist).call(this);
         __classPrivateFieldGet(this, _Receipt_instances, "m", _Receipt_reconstruct).call(this);
     }
@@ -86,12 +80,6 @@ _Receipt_instances = new WeakSet(), _Receipt_initFromApiPrediction = function _R
         rateKey: "rate",
         codeKey: "code",
     })));
-    if (pageId !== undefined) {
-        this.orientation = new fields_1.Orientation({
-            prediction: apiPrediction.orientation,
-            pageId,
-        });
-    }
 }, _Receipt_checklist = function _Receipt_checklist() {
     this.checklist = { taxesMatchTotalIncl: __classPrivateFieldGet(this, _Receipt_instances, "m", _Receipt_taxesMatchTotal).call(this) };
 }, _Receipt_taxesMatchTotal = function _Receipt_taxesMatchTotal() {

package/src/fields/cropper.d.ts

@@ -0,0 +1,16 @@
+import { BaseField, FieldConstructor } from "./field";
+import { Polygon } from "../geometry";
+export declare class CropperField extends BaseField {
+    /** Straight rectangle. */
+    boundingBox: Polygon;
+    /** Free polygon with up to 30 vertices. */
+    polygon: Polygon;
+    /** Free polygon with 4 vertices. */
+    quadrangle: Polygon;
+    /** Rectangle that may be oriented (can go beyond the canvas). */
+    rectangle: Polygon;
+    /** The document page on which the information was found. */
+    pageId: number | undefined;
+    constructor({ prediction, valueKey, pageId }: FieldConstructor);
+    toString(): string;
+}

package/src/fields/cropper.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CropperField = void 0;
+const field_1 = require("./field");
+class CropperField extends field_1.BaseField {
+    constructor({ prediction, valueKey = "polygon", pageId }) {
+        super({ prediction, valueKey });
+        this.pageId = pageId;
+        this.boundingBox = prediction.bounding_box;
+        this.polygon = prediction.polygon;
+        this.quadrangle = prediction.quadrangle;
+        this.rectangle = prediction.rectangle;
+    }
+    toString() {
+        return `Polygon with ${this.polygon.length} points.`;
+    }
+}
+exports.CropperField = CropperField;

package/src/fields/field.d.ts

@@ -3,24 +3,28 @@ export declare type stringDict = {
     [index: string]: any;
 };
 export interface FieldConstructor {
-    prediction: {
-        [index: string]: any;
-    };
+    prediction: stringDict;
     valueKey?: string;
     reconstructed?: boolean;
     pageId?: number | undefined;
 }
-interface BaseFieldConstructor {
+export interface BaseFieldConstructor {
     prediction: stringDict;
-    valueKey: string;
+    valueKey?: string;
+    reconstructed?: boolean;
 }
 export declare class BaseField {
     value?: any;
+    /**
+     * True if the field was reconstructed or computed using other fields.
+     */
+    reconstructed: boolean;
     /**
      * @param {Object} prediction - Prediction object from HTTP response
      * @param {String} valueKey - Key to use in the prediction dict
+     * @param {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
      */
-    constructor({ prediction, valueKey }: BaseFieldConstructor);
+    constructor({ prediction, valueKey, reconstructed, }: BaseFieldConstructor);
 }
 export declare class Field extends BaseField {
     /**
@@ -39,10 +43,6 @@ export declare class Field extends BaseField {
      * The confidence score of the prediction.
      */
     confidence: number;
-    /**
-     * True if the field was reconstructed or computed using other fields.
-     */
-    reconstructed: boolean;
     /**
      * @param {Object} prediction - Prediction object from HTTP response
      * @param {String} valueKey - Key to use in the prediction dict
@@ -71,4 +71,3 @@ export declare class Field extends BaseField {
     static arraySum(array: any): number;
     toString(): string;
 }
-export {};

package/src/fields/field.js

@@ -6,9 +6,11 @@ class BaseField {
     /**
      * @param {Object} prediction - Prediction object from HTTP response
      * @param {String} valueKey - Key to use in the prediction dict
+     * @param {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
      */
-    constructor({ prediction, valueKey }) {
+    constructor({ prediction, valueKey = "value", reconstructed = false, }) {
         this.value = undefined;
+        this.reconstructed = reconstructed;
         if (valueKey in prediction && prediction[valueKey] !== null) {
             this.value = prediction[valueKey];
         }
@@ -24,7 +26,7 @@ class Field extends BaseField {
      * @param {Array<String>} extraFields - Extra fields to get from the prediction and to set as attribute of the Field
      */
     constructor({ prediction, valueKey = "value", reconstructed = false, pageId, }) {
-        super({ prediction, valueKey });
+        super({ prediction, valueKey, reconstructed });
         /**
          * Contains exactly 4 relative vertices coordinates (points) of a right
          * rectangle containing the field in the document.
@@ -36,7 +38,6 @@ class Field extends BaseField {
          */
         this.polygon = [];
         this.pageId = pageId !== undefined ? pageId : prediction["page_id"];
-        this.reconstructed = reconstructed;
         this.confidence = prediction.confidence ? prediction.confidence : 0.0;
         if (prediction.polygon) {
             this.polygon = prediction.polygon;

package/src/fields/index.d.ts

@@ -1,11 +1,11 @@
 export { TaxField } from "./tax";
 export { PaymentDetails } from "./paymentDetails";
-export { Orientation } from "./orientation";
+export { OrientationField } from "./orientation";
 export { Locale } from "./locale";
 export { Amount } from "./amount";
 export { DateField } from "./date";
-export { BaseField } from "./field";
-export { Field } from "./field";
+export { BaseField, stringDict, Field } from "./field";
 export { ListField, ListFieldValue, ClassificationField } from "./customDocs";
 export { FullText } from "./fullText";
 export { CompanyRegistration } from "./companyRegistration";
+export { CropperField } from "./cropper";

package/src/fields/index.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CompanyRegistration = exports.FullText = exports.ClassificationField = exports.ListFieldValue = exports.ListField = exports.Field = exports.BaseField = exports.DateField = exports.Amount = exports.Locale = exports.Orientation = exports.PaymentDetails = exports.TaxField = void 0;
+exports.CropperField = exports.CompanyRegistration = exports.FullText = exports.ClassificationField = exports.ListFieldValue = exports.ListField = exports.Field = exports.BaseField = exports.DateField = exports.Amount = exports.Locale = exports.OrientationField = exports.PaymentDetails = exports.TaxField = void 0;
 var tax_1 = require("./tax");
 Object.defineProperty(exports, "TaxField", { enumerable: true, get: function () { return tax_1.TaxField; } });
 var paymentDetails_1 = require("./paymentDetails");
 Object.defineProperty(exports, "PaymentDetails", { enumerable: true, get: function () { return paymentDetails_1.PaymentDetails; } });
 var orientation_1 = require("./orientation");
-Object.defineProperty(exports, "Orientation", { enumerable: true, get: function () { return orientation_1.Orientation; } });
+Object.defineProperty(exports, "OrientationField", { enumerable: true, get: function () { return orientation_1.OrientationField; } });
 var locale_1 = require("./locale");
 Object.defineProperty(exports, "Locale", { enumerable: true, get: function () { return locale_1.Locale; } });
 var amount_1 = require("./amount");
@@ -15,8 +15,7 @@ var date_1 = require("./date");
 Object.defineProperty(exports, "DateField", { enumerable: true, get: function () { return date_1.DateField; } });
 var field_1 = require("./field");
 Object.defineProperty(exports, "BaseField", { enumerable: true, get: function () { return field_1.BaseField; } });
-var field_2 = require("./field");
-Object.defineProperty(exports, "Field", { enumerable: true, get: function () { return field_2.Field; } });
+Object.defineProperty(exports, "Field", { enumerable: true, get: function () { return field_1.Field; } });
 var customDocs_1 = require("./customDocs");
 Object.defineProperty(exports, "ListField", { enumerable: true, get: function () { return customDocs_1.ListField; } });
 Object.defineProperty(exports, "ListFieldValue", { enumerable: true, get: function () { return customDocs_1.ListFieldValue; } });
@@ -25,3 +24,5 @@ var fullText_1 = require("./fullText");
 Object.defineProperty(exports, "FullText", { enumerable: true, get: function () { return fullText_1.FullText; } });
 var companyRegistration_1 = require("./companyRegistration");
 Object.defineProperty(exports, "CompanyRegistration", { enumerable: true, get: function () { return companyRegistration_1.CompanyRegistration; } });
+var cropper_1 = require("./cropper");
+Object.defineProperty(exports, "CropperField", { enumerable: true, get: function () { return cropper_1.CropperField; } });

package/src/fields/orientation.d.ts

@@ -1,10 +1,17 @@
-import { Field } from "./field";
-export declare class Orientation extends Field {
+import { BaseField, BaseFieldConstructor } from "./field";
+interface OrientationFieldConstructor extends BaseFieldConstructor {
+    pageId: number;
+}
+export declare class OrientationField extends BaseField {
+    value: number;
+    pageId: number;
     /**
      * @param {Object} prediction - Prediction object from HTTP response
      * @param {String} valueKey - Key to use in the prediction dict
      * @param {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
      * @param {Integer} pageId - Page ID for multi-page document
      */
-    constructor({ prediction, valueKey, reconstructed, pageId, }: any);
+    constructor({ prediction, valueKey, reconstructed, pageId, }: OrientationFieldConstructor);
+    toString(): string;
 }
+export {};

package/src/fields/orientation.js

@@ -1,22 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Orientation = void 0;
+exports.OrientationField = void 0;
 const field_1 = require("./field");
-class Orientation extends field_1.Field {
+class OrientationField extends field_1.BaseField {
     /**
      * @param {Object} prediction - Prediction object from HTTP response
      * @param {String} valueKey - Key to use in the prediction dict
      * @param {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
      * @param {Integer} pageId - Page ID for multi-page document
      */
-    constructor({ prediction, valueKey = "degrees", reconstructed = false, pageId, }) {
+    constructor({ prediction, valueKey = "value", reconstructed = false, pageId, }) {
+        super({ prediction, valueKey, reconstructed });
         const orientations = [0, 90, 180, 270];
-        super({ prediction, valueKey, reconstructed, pageId });
+        this.pageId = pageId;
         this.value = parseInt(prediction[valueKey]);
-        if (isNaN(this.value))
-            this.confidence = 0.0;
         if (!orientations.includes(this.value))
             this.value = 0;
     }
+    toString() {
+        return `${this.value} degrees`;
+    }
 }
-exports.Orientation = Orientation;
+exports.OrientationField = OrientationField;

package/src/index.d.ts

@@ -1,2 +1,2 @@
-export { Response, FinancialDocResponse, InvoiceResponse, PassportResponse, ReceiptResponse, CustomResponse, } from "./api";
+export { Response, FinancialDocResponse, InvoiceResponse, PassportResponse, ReceiptResponse, CustomResponse, CropperResponse, } from "./api";
 export { Client } from "./client";

package/src/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Client = exports.CustomResponse = exports.ReceiptResponse = exports.PassportResponse = exports.InvoiceResponse = exports.FinancialDocResponse = exports.Response = void 0;
+exports.Client = exports.CropperResponse = exports.CustomResponse = exports.ReceiptResponse = exports.PassportResponse = exports.InvoiceResponse = exports.FinancialDocResponse = exports.Response = void 0;
 var api_1 = require("./api");
 Object.defineProperty(exports, "Response", { enumerable: true, get: function () { return api_1.Response; } });
 Object.defineProperty(exports, "FinancialDocResponse", { enumerable: true, get: function () { return api_1.FinancialDocResponse; } });
@@ -8,5 +8,6 @@ Object.defineProperty(exports, "InvoiceResponse", { enumerable: true, get: funct
 Object.defineProperty(exports, "PassportResponse", { enumerable: true, get: function () { return api_1.PassportResponse; } });
 Object.defineProperty(exports, "ReceiptResponse", { enumerable: true, get: function () { return api_1.ReceiptResponse; } });
 Object.defineProperty(exports, "CustomResponse", { enumerable: true, get: function () { return api_1.CustomResponse; } });
+Object.defineProperty(exports, "CropperResponse", { enumerable: true, get: function () { return api_1.CropperResponse; } });
 var client_1 = require("./client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_1.Client; } });