mindee 4.1.1 → 4.2.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## v4.2.0 - 2023-09-15
+### Changes
+* :sparkles: add support for W9 V1
+* :sparkles: add support for Barcode Reader V11
+* :sparkles: add support for Multi Receipt Detector V1
+* :sparkles: add support for FR Id Card V2
+* :sparkles: add support for OTS Cropper V1
+* :memo: update documentation
+
+### Fixes
+* :bug: fix missing position field display issues
+* :bug: fix issues with asynchronous timeouts crashing in some instances
+
+
 ## v4.1.1 - 2023-09-04
 ### Changes
 * :recycle: tweaked timer management in async

package/README.md

@@ -155,9 +155,12 @@ Complete details on the working of the library are available in the following gu
 * [Node.js FR Carte Vitale OCR](https://developers.mindee.com/docs/nodejs-fr-carte-vitale-ocr)
 * [Node.js FR ID Card OCR](https://developers.mindee.com/docs/nodejs-fr-id-card-ocr)
 * [Node.js US Bank Check OCR](https://developers.mindee.com/docs/nodejs-us-bank-checks-ocr)
-* [Node.js US Driver License OCR](https://developers.mindee.com/docs/nodejs-us-driver-license-ocr)
+* [Node.js US W9 OCR](https://developers.mindee.com/docs/nodejs-us-driver-license-ocr)
+* [Node.js US Driver License OCR](https://developers.mindee.com/docs/nodejs-us-w9-ocr)
+* [Node.js Barcode Reader API](https://developers.mindee.com/docs/nodejs-barcode-reader-api)
 * [Node.js Cropper API](https://developers.mindee.com/docs/nodejs-cropper-api)
 * [Node.js Invoice Splitter API](https://developers.mindee.com/docs/nodejs-invoice-splitter-api)
+* [Node.js Multi Receipts Detector API](https://developers.mindee.com/docs/nodejs-multi-receipts-detector-api)
 
 You can also take a look at the **[Reference Documentation](https://mindee.github.io/mindee-api-nodejs/)**.
 

package/package.json

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

package/src/client.js

@@ -122,14 +122,8 @@ class Client {
         initialDelaySec: 6,
         delaySec: 3,
         maxRetries: 10,
-        initialTimerOptions: {
-            ref: false,
-            signal: undefined,
-        },
-        recurringTimerOptions: {
-            ref: false,
-            signal: undefined,
-        },
+        initialTimerOptions: undefined,
+        recurringTimerOptions: undefined,
     }) {
         __classPrivateFieldGet(this, _Client_instances, "m", _Client_validateAsyncParams).call(this, asyncParams);
         const enqueueResponse = await this.enqueue(productClass, inputSource, asyncParams);

package/src/http/error.d.ts

@@ -46,7 +46,7 @@ export declare class MindeeHttp413Error extends MindeeHttpError {
     constructor(httpError: StringDict, url: string, code?: number);
 }
 /**
- * Usually contains TooManyRequests errors.
+ * Usually corresponds to TooManyRequests errors.
  * Arises whenever too many calls to the API are made in quick succession.
  */
 export declare class MindeeHttp429Error extends MindeeHttpError {

package/src/http/error.js

@@ -168,7 +168,7 @@ class MindeeHttp413Error extends MindeeHttpError {
 }
 exports.MindeeHttp413Error = MindeeHttp413Error;
 /**
- * Usually contains TooManyRequests errors.
+ * Usually corresponds to TooManyRequests errors.
  * Arises whenever too many calls to the API are made in quick succession.
  */
 class MindeeHttp429Error extends MindeeHttpError {
@@ -195,7 +195,7 @@ exports.MindeeHttp500Error = MindeeHttp500Error;
 class MindeeHttp504Error extends MindeeHttpError {
     constructor(httpError, url, code) {
         super(httpError, url, code);
-        this.name = "MindeeHttp500Error";
+        this.name = "MindeeHttp504Error";
     }
 }
 exports.MindeeHttp504Error = MindeeHttp504Error;

package/src/parsing/common/inference.js

@@ -28,8 +28,7 @@ class Inference {
 
 Prediction
 ==========
-${this.prediction.toString() || ""}
-
+${this.prediction.toString().length === 0 ? "" : this.prediction.toString() + "\n"}
 Page Predictions
 ================
 

package/src/parsing/standard/base.d.ts

@@ -16,8 +16,8 @@ export declare class BaseField {
     pageId?: number;
     /**
      * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict
-     * @param {Boolean} reconstructed - Is the object reconstructed (not extracted by the API)
+     * @param valueKey - Key to use in the prediction dict
+     * @param reconstructed - Is the object reconstructed (not extracted by the API)
      */
     constructor({ prediction, valueKey, reconstructed, pageId, }: BaseFieldConstructor);
     compare(other: BaseField): boolean;

package/src/parsing/standard/base.js

@@ -7,8 +7,8 @@ exports.BaseField = void 0;
 class BaseField {
     /**
      * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict
-     * @param {Boolean} reconstructed - Is the object reconstructed (not extracted by the API)
+     * @param valueKey - Key to use in the prediction dict
+     * @param reconstructed - Is the object reconstructed (not extracted by the API)
      */
     constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId = undefined, }) {
         /** The value. */

package/src/parsing/standard/field.d.ts

@@ -24,23 +24,23 @@ export declare class Field extends BaseField {
     /** The confidence score of the prediction. */
     confidence: 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
-     * @param {Array<String>} extraFields - Extra fields to get from the prediction and to set as attribute of the Field
+     * @param prediction - Prediction object from HTTP response
+     * @param valueKey - Key to use in the prediction dict
+     * @param reconstructed - Does the object is reconstructed (not extracted by the API)
+     * @param pageId - Page ID for multi-page document
+     * @param extraFields - Extra fields to get from the prediction and to set as attribute of the Field
      */
     constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
     /**
-    @param {Field[]} array1 - first Array of Fields
-    @param {Field[]} array2 - second Array of Fields
-    @param {String} attr - Attribute to compare
-    @returns {Boolean} - true if all elements in array1 exist in array2 and vice-versa, false otherwise
+    @param array1 first Array of Fields
+    @param array2 second Array of Fields
+    @param attr Attribute to compare
+    @returns true if all elements in array1 exist in array2 and vice-versa, false otherwise
      */
     static compareArrays(array1: Field[], array2: Field[], attr?: string): boolean;
     /**
      * @param {Field[]} array - Array of Fields
-     * @returns {Number} product of all the fields probaility
+     * @returns {Number} product of all the fields probability
      */
     static arrayConfidence(array: Field[]): number;
 }

package/src/parsing/standard/field.js

@@ -8,11 +8,11 @@ const geometry_1 = require("../../geometry");
  */
 class Field extends base_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
-     * @param {Array<String>} extraFields - Extra fields to get from the prediction and to set as attribute of the Field
+     * @param prediction - Prediction object from HTTP response
+     * @param valueKey - Key to use in the prediction dict
+     * @param reconstructed - Does the object is reconstructed (not extracted by the API)
+     * @param pageId - Page ID for multi-page document
+     * @param 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, reconstructed, pageId });
@@ -28,10 +28,10 @@ class Field extends base_1.BaseField {
         this.boundingBox = (0, geometry_1.getBoundingBox)(this.polygon);
     }
     /**
-    @param {Field[]} array1 - first Array of Fields
-    @param {Field[]} array2 - second Array of Fields
-    @param {String} attr - Attribute to compare
-    @returns {Boolean} - true if all elements in array1 exist in array2 and vice-versa, false otherwise
+    @param array1 first Array of Fields
+    @param array2 second Array of Fields
+    @param attr Attribute to compare
+    @returns true if all elements in array1 exist in array2 and vice-versa, false otherwise
      */
     static compareArrays(array1, array2, attr = "value") {
         const list1 = array1.map((item) => item[attr]);
@@ -46,7 +46,7 @@ class Field extends base_1.BaseField {
     }
     /**
      * @param {Field[]} array - Array of Fields
-     * @returns {Number} product of all the fields probaility
+     * @returns {Number} product of all the fields probability
      */
     static arrayConfidence(array) {
         let total = 1.0;

package/src/parsing/standard/position.js

@@ -16,7 +16,18 @@ class PositionField {
      * Default string representation.
      */
     toString() {
-        return `Polygon with ${this.polygon.length} points.`;
+        if (this.polygon && this.polygon.length > 0)
+            return `Polygon with ${this.polygon.length} points.`;
+        if (this.boundingBox && this.boundingBox.length > 0) {
+            return `Polygon with ${this.boundingBox.length} points.`;
+        }
+        if (this.rectangle && this.rectangle.length > 0) {
+            return `Polygon with ${this.rectangle.length} points.`;
+        }
+        if (this.quadrangle && this.quadrangle.length > 0) {
+            return `Polygon with ${this.quadrangle.length} points.`;
+        }
+        return "";
     }
 }
 exports.PositionField = PositionField;

package/src/product/barcodeReader/barcodeReaderV1.d.ts

@@ -0,0 +1,16 @@
+import { Inference, StringDict, Page } from "../../parsing/common";
+import { BarcodeReaderV1Document } from "./barcodeReaderV1Document";
+/**
+ * Inference prediction for Barcode Reader, API version 1.
+ */
+export declare class BarcodeReaderV1 extends Inference {
+    /** The endpoint's name. */
+    endpointName: string;
+    /** The endpoint's version. */
+    endpointVersion: string;
+    /** The document-level prediction. */
+    prediction: BarcodeReaderV1Document;
+    /** The document's pages. */
+    pages: Page<BarcodeReaderV1Document>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/product/barcodeReader/barcodeReaderV1.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BarcodeReaderV1 = void 0;
+const common_1 = require("../../parsing/common");
+const barcodeReaderV1Document_1 = require("./barcodeReaderV1Document");
+/**
+ * Inference prediction for Barcode Reader, API version 1.
+ */
+class BarcodeReaderV1 extends common_1.Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "barcode_reader";
+        /** The endpoint's version. */
+        this.endpointVersion = "1";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new barcodeReaderV1Document_1.BarcodeReaderV1Document(rawPrediction["prediction"]);
+        this.pages = rawPrediction["pages"].map((page) => new common_1.Page(barcodeReaderV1Document_1.BarcodeReaderV1Document, page, page["id"], page["orientation"]));
+    }
+}
+exports.BarcodeReaderV1 = BarcodeReaderV1;

package/src/product/barcodeReader/barcodeReaderV1Document.d.ts

@@ -0,0 +1,16 @@
+import { Prediction, StringDict } from "../../parsing/common";
+import { StringField } from "../../parsing/standard";
+/**
+ * Document data for Barcode Reader, API version 1.
+ */
+export declare class BarcodeReaderV1Document implements Prediction {
+    /** List of decoded 1D barcodes. */
+    codes1D: StringField[];
+    /** List of decoded 2D barcodes. */
+    codes2D: StringField[];
+    constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

package/src/product/barcodeReader/barcodeReaderV1Document.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BarcodeReaderV1Document = void 0;
+const common_1 = require("../../parsing/common");
+const standard_1 = require("../../parsing/standard");
+/**
+ * Document data for Barcode Reader, API version 1.
+ */
+class BarcodeReaderV1Document {
+    constructor(rawPrediction, pageId) {
+        /** List of decoded 1D barcodes. */
+        this.codes1D = [];
+        /** List of decoded 2D barcodes. */
+        this.codes2D = [];
+        rawPrediction["codes_1d"] &&
+            rawPrediction["codes_1d"].map((itemPrediction) => this.codes1D.push(new standard_1.StringField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+        rawPrediction["codes_2d"] &&
+            rawPrediction["codes_2d"].map((itemPrediction) => this.codes2D.push(new standard_1.StringField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        const codes1D = this.codes1D.join("\n              ");
+        const codes2D = this.codes2D.join("\n              ");
+        const outStr = `:Barcodes 1D: ${codes1D}
+:Barcodes 2D: ${codes2D}`.trimEnd();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.BarcodeReaderV1Document = BarcodeReaderV1Document;

package/src/product/barcodeReader/internal.d.ts

@@ -0,0 +1,2 @@
+export { BarcodeReaderV1 } from "./barcodeReaderV1";
+export { BarcodeReaderV1Document } from "./barcodeReaderV1Document";

package/src/product/barcodeReader/internal.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BarcodeReaderV1Document = exports.BarcodeReaderV1 = void 0;
+var barcodeReaderV1_1 = require("./barcodeReaderV1");
+Object.defineProperty(exports, "BarcodeReaderV1", { enumerable: true, get: function () { return barcodeReaderV1_1.BarcodeReaderV1; } });
+var barcodeReaderV1Document_1 = require("./barcodeReaderV1Document");
+Object.defineProperty(exports, "BarcodeReaderV1Document", { enumerable: true, get: function () { return barcodeReaderV1Document_1.BarcodeReaderV1Document; } });

package/src/product/cropper/cropperV1.d.ts

@@ -1,7 +1,8 @@
-import { Inference, Page, StringDict } from "../../parsing/common";
+import { Inference, StringDict, Page } from "../../parsing/common";
 import { CropperV1Document } from "./cropperV1Document";
+import { CropperV1Page } from "./cropperV1Page";
 /**
- * Inference prediction for Cropper API, version 1.
+ * Inference prediction for Cropper, API version 1.
  */
 export declare class CropperV1 extends Inference {
     /** The endpoint's name. */
@@ -11,6 +12,6 @@ export declare class CropperV1 extends Inference {
     /** The document-level prediction. */
     prediction: CropperV1Document;
     /** The document's pages. */
-    pages: Page<CropperV1Document>[];
+    pages: Page<CropperV1Page>[];
     constructor(rawPrediction: StringDict);
 }

package/src/product/cropper/cropperV1.js

@@ -3,8 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CropperV1 = void 0;
 const common_1 = require("../../parsing/common");
 const cropperV1Document_1 = require("./cropperV1Document");
+const cropperV1Page_1 = require("./cropperV1Page");
 /**
- * Inference prediction for Cropper API, version 1.
+ * Inference prediction for Cropper, API version 1.
  */
 class CropperV1 extends common_1.Inference {
     constructor(rawPrediction) {
@@ -15,8 +16,8 @@ class CropperV1 extends common_1.Inference {
         this.endpointVersion = "1";
         /** The document's pages. */
         this.pages = [];
-        this.prediction = new cropperV1Document_1.CropperV1Document(rawPrediction["prediction"]);
-        this.pages = rawPrediction["pages"].map((page) => new common_1.Page(cropperV1Document_1.CropperV1Document, page, page["id"], page["orientation"]));
+        this.prediction = new cropperV1Document_1.CropperV1Document();
+        this.pages = rawPrediction["pages"].map((page) => new common_1.Page(cropperV1Page_1.CropperV1Page, page, page["id"], page["orientation"]));
     }
 }
 exports.CropperV1 = CropperV1;

package/src/product/cropper/cropperV1Document.d.ts

@@ -1,12 +1,8 @@
-import { Prediction, StringDict } from "../../parsing/common";
-import { PositionField } from "../../parsing/standard";
+import { Prediction } from "../../parsing/common";
 /**
- * Document data for Cropper API, version 1.
+ * Document data for Cropper, API version 1.
  */
 export declare class CropperV1Document implements Prediction {
-    /** A list of cropped positions. */
-    cropping: PositionField[];
-    constructor(rawPrediction: StringDict, pageId?: number);
     /**
      * Default string representation.
      */

package/src/product/cropper/cropperV1Document.js

@@ -1,32 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CropperV1Document = void 0;
-const summaryHelper_1 = require("../../parsing/common/summaryHelper");
-const standard_1 = require("../../parsing/standard");
 /**
- * Document data for Cropper API, version 1.
+ * Document data for Cropper, API version 1.
  */
 class CropperV1Document {
-    constructor(rawPrediction, pageId) {
-        /** A list of cropped positions. */
-        this.cropping = [];
-        rawPrediction["cropping"] &&
-            rawPrediction["cropping"].forEach((crop) => {
-                this.cropping.push(new standard_1.PositionField({
-                    prediction: crop,
-                    pageId: pageId,
-                }));
-            });
-    }
     /**
      * Default string representation.
      */
     toString() {
-        const cropping = this.cropping
-            .map((crop) => crop.toString())
-            .join("\n           ");
-        const outStr = `:Cropping: ${cropping}`.trim();
-        return (0, summaryHelper_1.cleanOutString)(outStr);
+        return "";
     }
 }
 exports.CropperV1Document = CropperV1Document;

package/src/product/cropper/cropperV1Page.d.ts

@@ -0,0 +1,12 @@
+import { StringDict } from "../../parsing/common";
+import { PositionField } from "../../parsing/standard";
+import { CropperV1Document } from "./cropperV1Document";
+/**
+ * Page data for Cropper, API version 1.
+ */
+export declare class CropperV1Page extends CropperV1Document {
+    /** List of documents found in the image. */
+    cropping: PositionField[];
+    constructor(rawPrediction: StringDict, pageId?: number);
+    toString(): string;
+}

package/src/product/cropper/cropperV1Page.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CropperV1Page = void 0;
+const common_1 = require("../../parsing/common");
+const standard_1 = require("../../parsing/standard");
+const cropperV1Document_1 = require("./cropperV1Document");
+/**
+ * Page data for Cropper, API version 1.
+ */
+class CropperV1Page extends cropperV1Document_1.CropperV1Document {
+    constructor(rawPrediction, pageId) {
+        super();
+        /** List of documents found in the image. */
+        this.cropping = [];
+        rawPrediction["cropping"].map((itemPrediction) => this.cropping.push(new standard_1.PositionField({
+            prediction: itemPrediction,
+            pageId: pageId,
+        })));
+    }
+    toString() {
+        const cropping = this.cropping.join("\n                   ");
+        const outStr = `:Document Cropper: ${cropping}`.trimEnd();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.CropperV1Page = CropperV1Page;

package/src/product/cropper/internal.d.ts

@@ -1,2 +1,3 @@
 export { CropperV1 } from "./cropperV1";
 export { CropperV1Document } from "./cropperV1Document";
+export { CropperV1Page } from "./cropperV1Page";

package/src/product/cropper/internal.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CropperV1Document = exports.CropperV1 = void 0;
+exports.CropperV1Page = exports.CropperV1Document = exports.CropperV1 = void 0;
 var cropperV1_1 = require("./cropperV1");
 Object.defineProperty(exports, "CropperV1", { enumerable: true, get: function () { return cropperV1_1.CropperV1; } });
 var cropperV1Document_1 = require("./cropperV1Document");
 Object.defineProperty(exports, "CropperV1Document", { enumerable: true, get: function () { return cropperV1Document_1.CropperV1Document; } });
+var cropperV1Page_1 = require("./cropperV1Page");
+Object.defineProperty(exports, "CropperV1Page", { enumerable: true, get: function () { return cropperV1Page_1.CropperV1Page; } });

package/src/product/fr/carteVitale/carteVitaleV1Document.js

@@ -32,7 +32,7 @@ class CarteVitaleV1Document {
      * Default string representation.
      */
     toString() {
-        const givenNames = this.givenNames.join("\n              ");
+        const givenNames = this.givenNames.join("\n                ");
         const outStr = `:Given Name(s): ${givenNames}
 :Surname: ${this.surname}
 :Social Security Number: ${this.socialSecurity}

package/src/product/fr/idCard/idCardV1Document.js

@@ -56,7 +56,7 @@ class IdCardV1Document {
      * Default string representation.
      */
     toString() {
-        const givenNames = this.givenNames.join("\n              ");
+        const givenNames = this.givenNames.join("\n                ");
         const outStr = `:Identity Number: ${this.idNumber}
 :Given Name(s): ${givenNames}
 :Surname: ${this.surname}

package/src/product/fr/idCard/idCardV2.d.ts

@@ -0,0 +1,17 @@
+import { Inference, StringDict, Page } from "../../../parsing/common";
+import { IdCardV2Document } from "./idCardV2Document";
+import { IdCardV2Page } from "./idCardV2Page";
+/**
+ * Inference prediction for Carte Nationale d'Identité, API version 2.
+ */
+export declare class IdCardV2 extends Inference {
+    /** The endpoint's name. */
+    endpointName: string;
+    /** The endpoint's version. */
+    endpointVersion: string;
+    /** The document-level prediction. */
+    prediction: IdCardV2Document;
+    /** The document's pages. */
+    pages: Page<IdCardV2Page>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/product/fr/idCard/idCardV2.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdCardV2 = void 0;
+const common_1 = require("../../../parsing/common");
+const idCardV2Document_1 = require("./idCardV2Document");
+const idCardV2Page_1 = require("./idCardV2Page");
+/**
+ * Inference prediction for Carte Nationale d'Identité, API version 2.
+ */
+class IdCardV2 extends common_1.Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "idcard_fr";
+        /** The endpoint's version. */
+        this.endpointVersion = "2";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new idCardV2Document_1.IdCardV2Document(rawPrediction["prediction"]);
+        this.pages = rawPrediction["pages"].map((page) => new common_1.Page(idCardV2Page_1.IdCardV2Page, page, page["id"], page["orientation"]));
+    }
+}
+exports.IdCardV2 = IdCardV2;

package/src/product/fr/idCard/idCardV2Document.d.ts

@@ -0,0 +1,42 @@
+import { Prediction, StringDict } from "../../../parsing/common";
+import { DateField, StringField } from "../../../parsing/standard";
+/**
+ * Document data for Carte Nationale d'Identité, API version 2.
+ */
+export declare class IdCardV2Document implements Prediction {
+    /** The alternate name of the card holder. */
+    alternateName: StringField;
+    /** The name of the issuing authority. */
+    authority: StringField;
+    /** The date of birth of the card holder. */
+    birthDate: DateField;
+    /** The place of birth of the card holder. */
+    birthPlace: StringField;
+    /** The card access number (CAN). */
+    cardAccessNumber: StringField;
+    /** The document number. */
+    documentNumber: StringField;
+    /** The expiry date of the identification card. */
+    expiryDate: DateField;
+    /** The gender of the card holder. */
+    gender: StringField;
+    /** The given name(s) of the card holder. */
+    givenNames: StringField[];
+    /** The date of issue of the identification card. */
+    issueDate: DateField;
+    /** The Machine Readable Zone, first line. */
+    mrz1: StringField;
+    /** The Machine Readable Zone, second line. */
+    mrz2: StringField;
+    /** The Machine Readable Zone, third line. */
+    mrz3: StringField;
+    /** The nationality of the card holder. */
+    nationality: StringField;
+    /** The surname of the card holder. */
+    surname: StringField;
+    constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}