mindee 2.0.0 → 2.1.0

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

@@ -0,0 +1,17 @@
+import { Document, DocumentConstructorProps } from "./document";
+import { TaxField, Field, Amount, Locale, DateField } from "../fields";
+export declare class Receipt extends Document {
+    #private;
+    locale: Locale;
+    totalIncl: Amount;
+    date: DateField;
+    /** Receipt category as seen on the receipt. */
+    category: Field;
+    merchantName: Field;
+    time: Field;
+    totalTax: Amount;
+    totalExcl: Amount;
+    taxes: TaxField[];
+    constructor({ prediction, orientation, extras, inputFile, fullText, pageId, }: DocumentConstructorProps);
+    toString(): string;
+}

package/{dist/src → 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/{dist/src → src}/fields/customDocs.d.ts

@@ -8,7 +8,7 @@ export declare class ClassificationField {
     });
     toString(): string;
 }
-export declare class ListFieldItem {
+export declare class ListFieldValue {
     content: any;
     /**
      * The confidence score of the prediction.
@@ -29,7 +29,7 @@ export declare class ListFieldItem {
     toString(): string;
 }
 export declare class ListField {
-    values: ListFieldItem[];
+    readonly values: ListFieldValue[];
     confidence: number;
     /** True if the field was reconstructed or computed using other fields. */
     reconstructed: boolean;

package/{dist/src → src}/fields/customDocs.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListField = exports.ListFieldItem = exports.ClassificationField = void 0;
+exports.ListField = exports.ListFieldValue = exports.ClassificationField = void 0;
 const geometry_1 = require("../geometry");
 class ClassificationField {
     constructor({ prediction }) {
@@ -12,7 +12,7 @@ class ClassificationField {
     }
 }
 exports.ClassificationField = ClassificationField;
-class ListFieldItem {
+class ListFieldValue {
     constructor(prediction) {
         /**
          * Contains exactly 4 relative vertices coordinates (points) of a right
@@ -35,7 +35,7 @@ class ListFieldItem {
         return `${this.content}`;
     }
 }
-exports.ListFieldItem = ListFieldItem;
+exports.ListFieldValue = ListFieldValue;
 class ListField {
     constructor({ prediction, reconstructed = false, pageId }) {
         this.values = [];
@@ -44,7 +44,7 @@ class ListField {
         this.pageId = pageId !== undefined ? pageId : prediction["page_id"];
         if (Object.prototype.hasOwnProperty.call(prediction, "values")) {
             prediction["values"].forEach((field) => {
-                this.values.push(new ListFieldItem(field));
+                this.values.push(new ListFieldValue(field));
             });
         }
     }

package/{dist/src → 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/{dist/src → 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/{dist/src → 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 { ListField, ListFieldItem, ClassificationField } from "./customDocs";
+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/{dist/src → src}/fields/index.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CompanyRegistration = exports.FullText = exports.ClassificationField = exports.ListFieldItem = 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,13 +15,14 @@ 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, "ListFieldItem", { enumerable: true, get: function () { return customDocs_1.ListFieldItem; } });
+Object.defineProperty(exports, "ListFieldValue", { enumerable: true, get: function () { return customDocs_1.ListFieldValue; } });
 Object.defineProperty(exports, "ClassificationField", { enumerable: true, get: function () { return customDocs_1.ClassificationField; } });
 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/{dist/src → 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/{dist/src → 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/{dist/src → src}/fields/tax.js

@@ -13,7 +13,6 @@ class TaxField extends field_1.Field {
      * @param {Integer} pageNumber - Page ID for multi-page document
      */
     constructor({ prediction, valueKey = "value", rateKey = "rate", codeKey = "code", reconstructed = false, pageId = undefined, }) {
-        var _a;
         super({ prediction, valueKey, reconstructed, pageId });
         /** The tax amount. */
         this.value = undefined;
@@ -24,7 +23,7 @@ class TaxField extends field_1.Field {
         this.rate = +parseFloat(prediction[rateKey]);
         if (isNaN(this.rate))
             this.rate = undefined;
-        this.code = (_a = prediction[codeKey]) === null || _a === void 0 ? void 0 : _a.toString();
+        this.code = prediction[codeKey]?.toString();
         if (this.code === "N/A" || this.code === "None") {
             this.code = undefined;
         }

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