mindee 2.0.0 → 2.1.0

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,46 @@ class DocumentClient {
         this.inputDoc = inputDoc;
         this.docConfigs = docConfigs;
     }
-    parse(responseClass, params = {
+    async parse(responseClass, params = {
         docType: "",
         username: "",
         cutPages: true,
         fullText: false,
+        cropper: 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 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)
+            : 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,
+            cropper: cropper,
         });
     }
     getDocType(responseClass) {
@@ -75,13 +67,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");
@@ -93,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/{dist/src → 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/{dist/src → 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/{dist/src → 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

@@ -0,0 +1,42 @@
+import { Input } from "../inputs";
+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;
+    filename: string;
+    filepath?: string;
+    fullText?: FullText;
+    pageId?: number | undefined;
+    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;
+    /**
+     * Takes a list of Documents and return one Document where
+     * each field is set with the maximum probability field
+     * @param {Array<Document>} documents - A list of Documents
+     */
+    static mergePages(documents: any): any;
+    static cleanOutString(outStr: string): string;
+}
+export {};

package/{dist/src → 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;
@@ -34,19 +45,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.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/{dist/src → src}/documents/documentConfig.js

@@ -1,15 +1,6 @@
 "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;
+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");
@@ -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, cropping) {
+        return await this.endpoints[0].predictRequest(inputDoc, includeWords, cropping);
     }
     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, params.cropper);
+        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, cropping) {
+        let endpoint;
+        if (inputDoc.isPdf()) {
+            endpoint = this.endpoints[0];
+        }
+        else {
+            endpoint = this.endpoints[1];
+        }
+        return await endpoint.predictRequest(inputDoc, includeWords, cropping);
     }
 }
 exports.FinancialDocConfig = FinancialDocConfig;
@@ -110,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/{dist/src → 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/{dist/src → 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;
@@ -121,7 +119,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;

package/{dist/src → 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/{dist/src → 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/{dist/src → 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;
     /**