mindee 3.1.1 → 3.2.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## v3.2.0 - 2022-11-14
+### Changes
+* :sparkles: Add support for shipping container API V1
+* :sparkles: Add support for EU license plate V1
+* :bug: Fix page removal in CLI
+* :sparkles: Add support for Carte Vitale V1
+* :sparkles: Add support for FR Bank Account Details V1
+* :memo: Export and add comments for method parameters.
+* :sparkles: Add support for US Bank Check V1
+
 ## v3.1.1 - 2022-11-08
 ### Changes
 * :bug: fix proper import and documentation of region-specific documents

package/README.md

@@ -67,7 +67,7 @@ const apiResponse = mindeeClient
 ### Handling the Return
 ```js
 // Print a brief summary of the parsed data
-invoiceResponse.then((resp) => {
+apiResponse.then((resp) => {
 
     // The document property can be undefined:
     // * TypeScript will throw an error without this guard clause

package/package.json

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

package/src/cli.js

@@ -3,62 +3,99 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.cli = void 0;
 const commander_1 = require("commander");
 const documents_1 = require("./documents");
-const fr_1 = require("./documents/fr");
 const api_1 = require("./api");
 const client_1 = require("./client");
+const inputs_1 = require("./inputs");
 const program = new commander_1.Command();
-const COMMAND_INVOICE = "invoice";
-const COMMAND_RECEIPT = "receipt";
-const COMMAND_PASSPORT = "passport";
-const COMMAND_FINANCIAL = "financial";
-const COMMAND_FR_ID_CARD = "fr-id-card";
 const COMMAND_CUSTOM = "custom";
+// The Map's key is the command name as it will appear on the console.
+//
 const CLI_COMMAND_CONFIG = new Map([
     [
-        COMMAND_INVOICE,
+        COMMAND_CUSTOM,
+        {
+            description: "A custom document",
+            docClass: documents_1.CustomV1,
+            fullText: false,
+        },
+    ],
+    [
+        "invoice",
         {
             description: "Invoice V3",
-            docType: documents_1.InvoiceV3.name,
+            docClass: documents_1.InvoiceV3,
             fullText: true,
         },
     ],
     [
-        COMMAND_RECEIPT,
+        "receipt",
         {
             description: "Expense Receipt V4",
-            docType: documents_1.ReceiptV4.name,
+            docClass: documents_1.ReceiptV4,
             fullText: true,
         },
     ],
     [
-        COMMAND_PASSPORT,
+        "passport",
         {
             description: "Passport V1",
-            docType: documents_1.PassportV1.name,
+            docClass: documents_1.PassportV1,
             fullText: false,
         },
     ],
     [
-        COMMAND_FINANCIAL,
+        "financial",
         {
             description: "Financial Document V1 (receipt or invoice)",
-            docType: documents_1.FinancialDocumentV1.name,
+            docClass: documents_1.FinancialDocumentV1,
             fullText: true,
         },
     ],
     [
-        COMMAND_FR_ID_CARD,
+        "fr-id-card",
         {
             description: "FR ID Card V1",
-            docType: fr_1.IdCardV1.name,
+            docClass: documents_1.fr.IdCardV1,
             fullText: false,
         },
     ],
     [
-        COMMAND_CUSTOM,
+        "fr-bank-account-details",
         {
-            description: "A custom document",
-            docType: documents_1.CustomV1.name,
+            description: "FR Bank Account Details V1",
+            docClass: documents_1.fr.BankAccountDetailsV1,
+            fullText: false,
+        },
+    ],
+    [
+        "fr-carte-vitale",
+        {
+            description: "FR Carte Vitale V1",
+            docClass: documents_1.fr.CarteVitaleV1,
+            fullText: false,
+        },
+    ],
+    [
+        "eu-license-plate",
+        {
+            description: "EU License Plate V1",
+            docClass: documents_1.eu.LicensePlateV1,
+            fullText: false,
+        },
+    ],
+    [
+        "us-bank-check",
+        {
+            description: "US Bank Check V1",
+            docClass: documents_1.us.BankCheckV1,
+            fullText: false,
+        },
+    ],
+    [
+        "shipping-container",
+        {
+            description: "Shipping container V1",
+            docClass: documents_1.ShippingContainerV1,
             fullText: false,
         },
     ],
@@ -79,41 +116,21 @@ async function predictCall(command, inputPath, options) {
         });
     }
     const doc = mindeeClient.docFromPath(inputPath);
+    let pageOptions = undefined;
+    if (options.cutPages) {
+        pageOptions = {
+            operation: inputs_1.PageOptionsOperation.KeepOnly,
+            pageIndexes: [0, 1, 2, 3, 4],
+            onMinPages: 5,
+        };
+    }
     const predictParams = {
-        docType: command === COMMAND_CUSTOM ? options.documentType : conf.docType,
-        username: command === COMMAND_CUSTOM ? options.user : api_1.STANDARD_API_OWNER,
-        cutPages: options.cutPages,
+        endpointName: command === COMMAND_CUSTOM ? options.documentType : conf.docClass.name,
+        accountName: command === COMMAND_CUSTOM ? options.user : api_1.STANDARD_API_OWNER,
         fullText: options.fullText,
+        pageOptions: pageOptions,
     };
-    // Tried setting the response by using the responseClass property in constants.PRODUCTS_CONFIG
-    // This compiled, but threw an exception:
-    //   TypeError: responseType is not a constructor
-    //
-    // So using a switch to explicitly set the response class parameter. Ugly, but works.
-    // Improvements welcome!
-    let response;
-    switch (command) {
-        case COMMAND_INVOICE:
-            response = await doc.parse(documents_1.InvoiceV3, predictParams);
-            break;
-        case COMMAND_RECEIPT:
-            response = await doc.parse(documents_1.ReceiptV4, predictParams);
-            break;
-        case COMMAND_FINANCIAL:
-            response = await doc.parse(documents_1.FinancialDocumentV1, predictParams);
-            break;
-        case COMMAND_PASSPORT:
-            response = await doc.parse(documents_1.PassportV1, predictParams);
-            break;
-        case COMMAND_FR_ID_CARD:
-            response = await doc.parse(fr_1.IdCardV1, predictParams);
-            break;
-        case COMMAND_CUSTOM:
-            response = await doc.parse(documents_1.CustomV1, predictParams);
-            break;
-        default:
-            throw `Unhandled command: ${command}`;
-    }
+    const response = await doc.parse(conf.docClass, predictParams);
     if (options.fullText) {
         response.pages.forEach((page) => {
             console.log(page.fullText?.toString());
@@ -135,7 +152,7 @@ function cli() {
         const prog = program.command(name);
         prog.description(info.description);
         prog.option("-k, --api-key <api_key>", "API key for document endpoint");
-        prog.option("-C, --no-cut-pages", "Don't cut document pages");
+        prog.option("-c, --cut-pages", "Keep only the first 5 pages of the document.");
         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

@@ -6,11 +6,38 @@ import { Document, DocumentSig } from "./documents";
 import { DocumentConfig } from "./documents/documentConfig";
 import { ReadStream } from "fs";
 declare type DocConfigs = Map<string[], DocumentConfig<any>>;
-interface PredictOptions {
+export interface PredictOptions {
+    /**
+     * For custom endpoints, the "API name" field in the "Settings" page of the API Builder.
+     *
+     * Do not set for standard (off the shelf) endpoints.
+     */
     endpointName?: string;
+    /**
+     * For custom endpoints, your organization's username on the API Builder.
+     * This is normally not required unless you have a custom endpoint which has the
+     * same name as standard (off the shelf) endpoint.
+     *
+     * Do not set for standard (off the shelf) endpoints.
+     */
     accountName?: string;
+    /**
+     * Whether to include the full text for each page.
+     *
+     * This performs a full OCR operation on the server and will increase response time.
+     */
     fullText?: boolean;
+    /**
+     * Whether to include cropper results for each page.
+     *
+     * This performs a cropping operation on the server and will increase response time.
+     */
     cropper?: boolean;
+    /**
+     * If set, remove pages from the document as specified.
+     *
+     * This is done before sending the file to the server and is useful to avoid page limitations.
+     */
     pageOptions?: PageOptions;
 }
 declare class DocumentClient {
@@ -24,14 +51,23 @@ declare class DocumentClient {
      */
     parse<DocType extends Document>(documentClass: DocumentSig<DocType>, params?: PredictOptions): Promise<Response<DocType>>;
 }
-interface customConfigParams {
+export interface CustomConfigParams {
+    /** Your organization's username on the API Builder. */
     accountName: string;
+    /** The "API name" field in the "Settings" page of the API Builder. */
     endpointName: string;
+    /**
+     * If set, locks the version of the model to use.
+     * If not set, use the latest version of the model.
+     */
     version?: string;
 }
-interface ClientOptions {
+export interface ClientOptions {
+    /** Your API key for all endpoints. */
     apiKey?: string;
+    /** Raise an `Error` on errors. */
     throwOnError?: boolean;
+    /** Log debug messages. */
     debug?: boolean;
 }
 /**
@@ -43,7 +79,7 @@ export declare class Client {
     /**
      * @param options
      */
-    constructor(options?: ClientOptions);
+    constructor({ apiKey, throwOnError, debug, }: ClientOptions);
     protected addStandardEndpoints(): void;
     /**
      * Add a custom endpoint to the client.
@@ -51,7 +87,7 @@ export declare class Client {
      * @param endpointName
      * @param version
      */
-    addEndpoint({ accountName, endpointName, version, }: customConfigParams): this;
+    addEndpoint({ accountName, endpointName, version, }: CustomConfigParams): this;
     /**
      * Load an input document from a local path.
      * @param inputPath

package/src/client.js

@@ -66,11 +66,9 @@ class Client {
     /**
      * @param options
      */
-    constructor(options) {
-        const throwOnError = options?.throwOnError === undefined ? true : options.throwOnError;
-        const debug = options?.debug === undefined ? false : options.debug;
-        this.apiKey = options?.apiKey === undefined ? "" : options.apiKey;
+    constructor({ apiKey = "", throwOnError = true, debug = false, }) {
         this.docConfigs = new Map();
+        this.apiKey = apiKey;
         handler_1.errorHandler.throwOnError = throwOnError;
         logger_1.logger.level =
             debug ?? process.env.MINDEE_DEBUG
@@ -100,6 +98,21 @@ class Client {
         this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.fr.IdCardV1.name], new documentConfig_1.DocumentConfig(documents_1.fr.IdCardV1, [
             new api_1.StandardEndpoint("idcard_fr", "1", this.apiKey),
         ]));
+        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.us.BankCheckV1.name], new documentConfig_1.DocumentConfig(documents_1.us.BankCheckV1, [
+            new api_1.StandardEndpoint("bank_check", "1", this.apiKey),
+        ]));
+        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.fr.BankAccountDetailsV1.name], new documentConfig_1.DocumentConfig(documents_1.fr.BankAccountDetailsV1, [
+            new api_1.StandardEndpoint("bank_account_details", "1", this.apiKey),
+        ]));
+        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.fr.CarteVitaleV1.name], new documentConfig_1.DocumentConfig(documents_1.fr.CarteVitaleV1, [
+            new api_1.StandardEndpoint("carte_vitale", "1", this.apiKey),
+        ]));
+        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.eu.LicensePlateV1.name], new documentConfig_1.DocumentConfig(documents_1.eu.LicensePlateV1, [
+            new api_1.StandardEndpoint("license_plates", "1", this.apiKey),
+        ]));
+        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.ShippingContainerV1.name], new documentConfig_1.DocumentConfig(documents_1.ShippingContainerV1, [
+            new api_1.StandardEndpoint("shipping_containers", "1", this.apiKey),
+        ]));
     }
     /**
      * Add a custom endpoint to the client.

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

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

package/src/documents/cropper/cropperV1.js

@@ -13,7 +13,7 @@ class CropperV1 extends document_1.Document {
         this.cropping = [];
         if (pageId !== undefined) {
             prediction.cropping.forEach((crop) => {
-                this.cropping.push(new fields_1.CropperField({
+                this.cropping.push(new fields_1.PositionField({
                     prediction: crop,
                     pageId: pageId,
                 }));

package/src/documents/document.d.ts

@@ -1,5 +1,5 @@
 import { InputSource } from "../inputs";
-import { CropperField, FullText, OrientationField, stringDict } from "../fields";
+import { PositionField, FullText, OrientationField, stringDict } from "../fields";
 export declare type DocumentSig<DocType extends Document> = {
     new ({ prediction, orientation, extras, inputSource, pageId, fullText, documentType, }: DocumentConstructorProps): DocType;
 };
@@ -30,7 +30,7 @@ export declare class Document {
     fullText?: FullText;
     pageId?: number | undefined;
     orientation?: OrientationField;
-    cropper: CropperField[];
+    cropper: PositionField[];
     readonly docType: string;
     constructor({ orientation, extras, inputSource, fullText, pageId, documentType, }: BaseDocumentConstructorProps);
     clone(): any;

package/src/documents/document.js

@@ -23,7 +23,7 @@ class Document {
         if (extras !== undefined) {
             if (extras.cropper !== undefined) {
                 extras.cropper.cropping.forEach((crop) => {
-                    this.cropper.push(new fields_1.CropperField({
+                    this.cropper.push(new fields_1.PositionField({
                         prediction: crop,
                         pageId: pageId,
                     }));

package/src/documents/eu/index.d.ts

@@ -0,0 +1 @@
+export { LicensePlateV1 } from "./licensePlate/licensePlateV1";

package/src/documents/eu/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LicensePlateV1 = void 0;
+var licensePlateV1_1 = require("./licensePlate/licensePlateV1");
+Object.defineProperty(exports, "LicensePlateV1", { enumerable: true, get: function () { return licensePlateV1_1.LicensePlateV1; } });

package/src/documents/eu/licensePlate/licensePlateV1.d.ts

@@ -0,0 +1,8 @@
+import { Document, DocumentConstructorProps } from "../../document";
+import { Field } from "../../../fields";
+export declare class LicensePlateV1 extends Document {
+    /** A list of license plates values. */
+    licensePlates: Field[];
+    constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
+    toString(): string;
+}

package/src/documents/eu/licensePlate/licensePlateV1.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LicensePlateV1 = void 0;
+const document_1 = require("../../document");
+const fields_1 = require("../../../fields");
+class LicensePlateV1 extends document_1.Document {
+    constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, pageId = undefined, }) {
+        super({
+            inputSource: inputSource,
+            pageId: pageId,
+            orientation: orientation,
+            extras: extras,
+        });
+        /** A list of license plates values. */
+        this.licensePlates = [];
+        prediction.license_plates.map((prediction) => this.licensePlates.push(new fields_1.Field({
+            prediction: prediction,
+            pageId: pageId,
+        })));
+    }
+    toString() {
+        const outStr = `----- EU License plate V1 -----
+Licence plates: ${this.licensePlates.map((plate) => plate.value).join(", ")}
+----------------------
+`;
+        return LicensePlateV1.cleanOutString(outStr);
+    }
+}
+exports.LicensePlateV1 = LicensePlateV1;

package/src/documents/fr/bankAccountDetails/bankAccountDetailsV1.d.ts

@@ -0,0 +1,12 @@
+import { Document, DocumentConstructorProps } from "../../document";
+import { Field } from "../../../fields";
+export declare class BankAccountDetailsV1 extends Document {
+    /** The IBAN number. */
+    iban: Field;
+    /** The account holder name. */
+    accountHolderName: Field;
+    /** The SWIFT value. */
+    swift: Field;
+    constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
+    toString(): string;
+}

package/src/documents/fr/bankAccountDetails/bankAccountDetailsV1.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BankAccountDetailsV1 = void 0;
+const document_1 = require("../../document");
+const fields_1 = require("../../../fields");
+class BankAccountDetailsV1 extends document_1.Document {
+    constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, pageId = undefined, }) {
+        super({
+            inputSource: inputSource,
+            pageId: pageId,
+            orientation: orientation,
+            extras: extras,
+        });
+        this.iban = new fields_1.Field({
+            prediction: prediction.iban,
+            pageId: pageId,
+        });
+        this.accountHolderName = new fields_1.Field({
+            prediction: prediction.account_holder_name,
+            pageId: pageId,
+        });
+        this.swift = new fields_1.Field({
+            prediction: prediction.swift,
+            pageId: pageId,
+        });
+    }
+    toString() {
+        const outStr = `----- FR Bank Account Details V1 -----
+IBAN: ${this.iban}
+Account holder name: ${this.accountHolderName}
+SWIFT: ${this.swift}
+----------------------
+`;
+        return BankAccountDetailsV1.cleanOutString(outStr);
+    }
+}
+exports.BankAccountDetailsV1 = BankAccountDetailsV1;

package/src/documents/fr/carteVitale/carteVitaleV1.d.ts

@@ -0,0 +1,14 @@
+import { Document, DocumentConstructorProps } from "../../document";
+import { Field, DateField } from "../../../fields";
+export declare class CarteVitaleV1 extends Document {
+    /** The list of the names of the person. */
+    givenNames: Field[];
+    /** The surname of the person. */
+    surname: Field;
+    /** The ID number of the card. */
+    idNumber: Field;
+    /** The issuance date of the card. */
+    issuanceDate: DateField;
+    constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
+    toString(): string;
+}

package/src/documents/fr/carteVitale/carteVitaleV1.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CarteVitaleV1 = void 0;
+const document_1 = require("../../document");
+const fields_1 = require("../../../fields");
+class CarteVitaleV1 extends document_1.Document {
+    constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, pageId = undefined, }) {
+        super({
+            inputSource: inputSource,
+            pageId: pageId,
+            orientation: orientation,
+            extras: extras,
+        });
+        /** The list of the names of the person. */
+        this.givenNames = [];
+        this.idNumber = new fields_1.Field({
+            prediction: prediction.social_security,
+            pageId: pageId,
+        });
+        this.issuanceDate = new fields_1.DateField({
+            prediction: prediction.issuance_date,
+            pageId: pageId,
+        });
+        this.surname = new fields_1.Field({
+            prediction: prediction.surname,
+            pageId: pageId,
+        });
+        prediction.given_names.map((prediction) => this.givenNames.push(new fields_1.Field({
+            prediction: prediction,
+            pageId: pageId,
+        })));
+    }
+    toString() {
+        const outStr = `----- FR Carte Vitale V1 -----
+Given names: ${this.givenNames.map((name) => name.value).join(" ")}
+Surname: ${this.surname}
+ID Number: ${this.idNumber}
+Issuance date: ${this.issuanceDate}
+----------------------
+`;
+        return CarteVitaleV1.cleanOutString(outStr);
+    }
+}
+exports.CarteVitaleV1 = CarteVitaleV1;

package/src/documents/fr/idCard/idCardV1.d.ts

@@ -1,16 +1,27 @@
 import { Document, DocumentConstructorProps } from "../../document";
 import { Field, DateField, BaseField } from "../../../fields";
 export declare class IdCardV1 extends Document {
+    /** The authority which has issued the card. */
     authority: Field;
+    /** Indicates if it is the recto, the verso or the both of it. */
     documentSide: BaseField;
+    /** The id number of the card. */
     idNumber: Field;
+    /** The birth date of the person. */
     birthDate: DateField;
+    /** The expiry date of the card. */
     expiryDate: DateField;
+    /** The birth place of the person. */
     birthPlace: Field;
+    /** The gender of the person. */
     gender: Field;
+    /** The first mrz value. */
     mrz1: Field;
+    /** The second mrz value. */
     mrz2: Field;
+    /** The surname of the person. */
     surname: Field;
+    /** The list of the names of the person. */
     givenNames: Field[];
     constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
     toString(): string;

package/src/documents/fr/idCard/idCardV1.js

@@ -11,6 +11,7 @@ class IdCardV1 extends document_1.Document {
             orientation: orientation,
             extras: extras,
         });
+        /** The list of the names of the person. */
         this.givenNames = [];
         this.authority = new fields_1.Field({
             prediction: prediction.authority,

package/src/documents/fr/index.d.ts

@@ -1 +1,3 @@
 export { IdCardV1 } from "./idCard/idCardV1";
+export { BankAccountDetailsV1 } from "./bankAccountDetails/bankAccountDetailsV1";
+export { CarteVitaleV1 } from "./carteVitale/carteVitaleV1";

package/src/documents/fr/index.js

@@ -1,5 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IdCardV1 = void 0;
+exports.CarteVitaleV1 = exports.BankAccountDetailsV1 = exports.IdCardV1 = void 0;
 var idCardV1_1 = require("./idCard/idCardV1");
 Object.defineProperty(exports, "IdCardV1", { enumerable: true, get: function () { return idCardV1_1.IdCardV1; } });
+var bankAccountDetailsV1_1 = require("./bankAccountDetails/bankAccountDetailsV1");
+Object.defineProperty(exports, "BankAccountDetailsV1", { enumerable: true, get: function () { return bankAccountDetailsV1_1.BankAccountDetailsV1; } });
+var carteVitaleV1_1 = require("./carteVitale/carteVitaleV1");
+Object.defineProperty(exports, "CarteVitaleV1", { enumerable: true, get: function () { return carteVitaleV1_1.CarteVitaleV1; } });

package/src/documents/index.d.ts

@@ -5,6 +5,8 @@ export { PassportV1 } from "./passport/passportV1";
 export { FinancialDocumentV1 } from "./financialDocument/financialDocumentV1";
 export { CustomV1 } from "./custom";
 export { CropperV1 } from "./cropper/cropperV1";
+export { ShippingContainerV1 } from "./shipping_container/shippingContainerV1";
 export { Document, DocumentConstructorProps, DocumentSig } from "./document";
 export * as fr from "./fr";
 export * as us from "./us";
+export * as eu from "./eu";

package/src/documents/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.us = exports.fr = exports.Document = exports.CropperV1 = exports.CustomV1 = exports.FinancialDocumentV1 = exports.PassportV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.InvoiceV3 = void 0;
+exports.eu = exports.us = exports.fr = exports.Document = exports.ShippingContainerV1 = exports.CropperV1 = exports.CustomV1 = exports.FinancialDocumentV1 = exports.PassportV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.InvoiceV3 = void 0;
 var invoiceV3_1 = require("./invoice/invoiceV3");
 Object.defineProperty(exports, "InvoiceV3", { enumerable: true, get: function () { return invoiceV3_1.InvoiceV3; } });
 var receiptV3_1 = require("./receipt/receiptV3");
@@ -38,7 +38,10 @@ var custom_1 = require("./custom");
 Object.defineProperty(exports, "CustomV1", { enumerable: true, get: function () { return custom_1.CustomV1; } });
 var cropperV1_1 = require("./cropper/cropperV1");
 Object.defineProperty(exports, "CropperV1", { enumerable: true, get: function () { return cropperV1_1.CropperV1; } });
+var shippingContainerV1_1 = require("./shipping_container/shippingContainerV1");
+Object.defineProperty(exports, "ShippingContainerV1", { enumerable: true, get: function () { return shippingContainerV1_1.ShippingContainerV1; } });
 var document_1 = require("./document");
 Object.defineProperty(exports, "Document", { enumerable: true, get: function () { return document_1.Document; } });
 exports.fr = __importStar(require("./fr"));
 exports.us = __importStar(require("./us"));
+exports.eu = __importStar(require("./eu"));

package/src/documents/invoice/invoiceV3.d.ts

@@ -2,22 +2,39 @@ import { Document, DocumentConstructorProps } from "../document";
 import { BaseField, TaxField, PaymentDetails, Locale, Amount, Field, DateField, CompanyRegistration } from "../../fields";
 export declare class InvoiceV3 extends Document {
     #private;
+    /** Total amount with the tax amount of the purchase. */
     locale: Locale;
+    /** The nature of the invoice. */
     documentType: BaseField;
+    /** The total amount with tax included. */
     totalIncl: Amount;
+    /** The creation date of the invoice. */
     date: DateField;
+    /** The due date of the invoice. */
     dueDate: DateField;
+    /** The created time of the invoice */
     time: Field;
+    /** The total tax. */
     totalTax: Amount;
+    /** The total amount without the tax value. */
     totalExcl: Amount;
+    /** The supplier name. */
     supplier: Field;
+    /** The supplier address. */
     supplierAddress: Field;
+    /** The invoice number. */
     invoiceNumber: Field;
+    /** The company regitration information. */
     companyRegistration: CompanyRegistration[];
+    /** The name of the customer. */
     customerName: Field;
+    /** The address of the customer. */
     customerAddress: Field;
+    /** The list of the taxes. */
     taxes: TaxField[];
+    /** The payment information. */
     paymentDetails: PaymentDetails[];
+    /** The company registration information for the customer. */
     customerCompanyRegistration: CompanyRegistration[];
     constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);
     toString(): string;

package/src/documents/invoice/invoiceV3.js

@@ -19,9 +19,13 @@ class InvoiceV3 extends document_1.Document {
             extras: extras,
         });
         _InvoiceV3_instances.add(this);
+        /** The company regitration information. */
         this.companyRegistration = [];
+        /** The list of the taxes. */
         this.taxes = [];
+        /** The payment information. */
         this.paymentDetails = [];
+        /** The company registration information for the customer. */
         this.customerCompanyRegistration = [];
         __classPrivateFieldGet(this, _InvoiceV3_instances, "m", _InvoiceV3_initFromApiPrediction).call(this, prediction, pageId);
         __classPrivateFieldGet(this, _InvoiceV3_instances, "m", _InvoiceV3_checklist).call(this);

package/src/documents/passport/passportV1.d.ts

@@ -2,18 +2,31 @@ import { Document, DocumentConstructorProps } from "../document";
 import { Field, DateField } from "../../fields";
 export declare class PassportV1 extends Document {
     #private;
+    /** The country of issue. */
     country: Field;
+    /** The passport number. */
     idNumber: Field;
+    /** The date of birth of the passport holder. */
     birthDate: DateField;
+    /** The expiration date of the passport. */
     expiryDate: DateField;
+    /** The issuance date.*/
     issuanceDate: DateField;
+    /** The place of birth of the passport holder. */
     birthPlace: Field;
+    /** The sex or gender of the passport holder. */
     gender: Field;
+    /** The surname of the person. */
     surname: Field;
+    /** The value of the first mrz line. */
     mrz1: Field;
+    /** The value of the second mrz line. */
     mrz2: Field;
+    /** List of first (given) names of the passport holder. */
     givenNames: Field[];
+    /** The full name of the passport holder. */
     fullName: Field;
+    /** All the mrz values combined. */
     mrz: Field;
     constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
     static convertMRZDateToDatetime(dateString: string): Date;

package/src/documents/passport/passportV1.js

@@ -43,6 +43,7 @@ class PassportV1 extends document_1.Document {
             extras: extras,
         });
         _PassportV1_instances.add(this);
+        /** List of first (given) names of the passport holder. */
         this.givenNames = [];
         this.country = new fields_1.Field({
             prediction: prediction.country,

package/src/documents/receipt/receiptV3.d.ts

@@ -2,15 +2,23 @@ import { Document, DocumentConstructorProps } from "../document";
 import { TaxField, Field, Amount, Locale, DateField } from "../../fields";
 export declare class ReceiptV3 extends Document {
     #private;
+    /** Total amount with the tax amount of the purchase. */
     locale: Locale;
+    /** Where the purchase was made, the language, and the currency. */
     totalIncl: Amount;
+    /** The purchase date. */
     date: DateField;
-    /** Receipt category as seen on the receipt. */
+    /** The type of purchase. */
     category: Field;
+    /** Merchant's name as seen on the receipt. */
     merchantName: Field;
+    /** Time as seen on the receipt in HH:MM format. */
     time: Field;
+    /** Total tax amount of the purchase. */
     totalTax: Amount;
+    /** Total amount without tax of the purchase. */
     totalExcl: Amount;
+    /** List of different taxe. */
     taxes: TaxField[];
     constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);
     toString(): string;

package/src/documents/receipt/receiptV3.js

@@ -19,6 +19,7 @@ class ReceiptV3 extends document_1.Document {
             fullText: fullText,
         });
         _ReceiptV3_instances.add(this);
+        /** List of different taxe. */
         this.taxes = [];
         this.locale = new fields_1.Locale({
             prediction: prediction.locale,

package/src/documents/shipping_container/shippingContainerV1.d.ts

@@ -0,0 +1,12 @@
+import { Document, DocumentConstructorProps } from "../document";
+import { Field } from "../../fields";
+export declare class ShippingContainerV1 extends Document {
+    /** ISO 6346 code for container owner prefix + equipment identifier. */
+    owner: Field;
+    /** ISO 6346 code for container serial number (6+1 digits). */
+    serialNumber: Field;
+    /** ISO 6346 code for container length, height and type. */
+    sizeType: Field;
+    constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
+    toString(): string;
+}

package/src/documents/shipping_container/shippingContainerV1.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShippingContainerV1 = void 0;
+const document_1 = require("../document");
+const fields_1 = require("../../fields");
+class ShippingContainerV1 extends document_1.Document {
+    constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, pageId = undefined, }) {
+        super({
+            inputSource: inputSource,
+            pageId: pageId,
+            orientation: orientation,
+            extras: extras,
+        });
+        this.owner = new fields_1.Field({
+            prediction: prediction.owner,
+            pageId: pageId,
+        });
+        this.serialNumber = new fields_1.Field({
+            prediction: prediction.serial_number,
+            pageId: pageId,
+        });
+        this.sizeType = new fields_1.Field({
+            prediction: prediction.size_type,
+            pageId: pageId,
+        });
+    }
+    toString() {
+        const outStr = `----- Shipping Container V1 -----
+Owner: ${this.owner}
+Serial number: ${this.serialNumber}
+Size and type: ${this.sizeType}
+----------------------
+`;
+        return ShippingContainerV1.cleanOutString(outStr);
+    }
+}
+exports.ShippingContainerV1 = ShippingContainerV1;

package/src/documents/us/bankCheck/bankCheckV1.d.ts

@@ -1,3 +1,22 @@
-import { Document } from "../../document";
+import { Document, DocumentConstructorProps } from "../../document";
+import { Field, DateField, PositionField, Amount } from "../../../fields";
 export declare class BankCheckV1 extends Document {
+    /** Payer's bank account number. */
+    accountNumber: Field;
+    /** Total including taxes. */
+    amount: Amount;
+    /** Payer's bank account number. */
+    checkNumber: Field;
+    /** Check's position in the image. */
+    checkPosition: PositionField;
+    /** Date the check was issued. */
+    issuanceDate: DateField;
+    /** List of payees (full name or company name). */
+    payees: Field[];
+    /** Payer's bank account routing number. */
+    routingNumber: Field;
+    /** Signatures' positions in the image. */
+    signaturesPositions: PositionField;
+    constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
+    toString(): string;
 }

package/src/documents/us/bankCheck/bankCheckV1.js

@@ -2,6 +2,63 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BankCheckV1 = void 0;
 const document_1 = require("../../document");
+const fields_1 = require("../../../fields");
 class BankCheckV1 extends document_1.Document {
+    constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, pageId = undefined, }) {
+        super({
+            inputSource: inputSource,
+            pageId: pageId,
+            orientation: orientation,
+            extras: extras,
+        });
+        /** List of payees (full name or company name). */
+        this.payees = [];
+        this.accountNumber = new fields_1.Field({
+            prediction: prediction.account_number,
+            pageId: pageId,
+        });
+        this.checkNumber = new fields_1.Field({
+            prediction: prediction.check_number,
+            pageId: pageId,
+        });
+        this.amount = new fields_1.Amount({
+            prediction: prediction.amount,
+            valueKey: "value",
+            pageId: pageId,
+        });
+        this.checkPosition = new fields_1.PositionField({
+            prediction: prediction.check_position,
+            pageId: pageId,
+        });
+        this.issuanceDate = new fields_1.DateField({
+            prediction: prediction.date,
+            pageId: pageId,
+        });
+        prediction.payees.map((prediction) => this.payees.push(new fields_1.Field({
+            prediction: prediction,
+            pageId: pageId,
+        })));
+        this.routingNumber = new fields_1.Field({
+            prediction: prediction.routing_number,
+            pageId: pageId,
+        });
+        this.signaturesPositions = new fields_1.PositionField({
+            prediction: prediction.signatures_positions,
+            pageId: pageId,
+        });
+    }
+    toString() {
+        const outStr = `----- US Bank Check V1 -----
+Filename: ${this.filename}
+Routing number: ${this.routingNumber}
+Account number: ${this.accountNumber}
+Check number: ${this.checkNumber}
+Date: ${this.issuanceDate}
+Amount: ${this.amount}
+Payees: ${this.payees.map((name) => name.value).join(", ")}
+----------------------
+`;
+        return BankCheckV1.cleanOutString(outStr);
+    }
 }
 exports.BankCheckV1 = BankCheckV1;

package/src/fields/amount.d.ts

@@ -1,6 +1,7 @@
 import { Field, FieldConstructor } from "./field";
 export declare function floatToString(value: number): string;
 export declare class Amount extends Field {
+    /** The value. */
     value: number | undefined;
     /**
      * @param {Object} prediction - Prediction object from HTTP response

package/src/fields/apiBuilder.d.ts

@@ -1,6 +1,7 @@
 import { FieldConstructor, stringDict } from "./field";
 import { Polygon } from "../geometry";
 export declare class ClassificationField {
+    /** The value for the classification. */
     value: string;
     /**
      * The confidence score of the prediction.

package/src/fields/companyRegistration.d.ts

@@ -1,6 +1,6 @@
 import { Field, FieldConstructor } from "./field";
 export declare class CompanyRegistration extends Field {
-    /** Type of company registration number */
+    /** Type of company registration number. */
     type: string;
     constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
 }

package/src/fields/field.d.ts

@@ -14,6 +14,7 @@ export interface BaseFieldConstructor {
     reconstructed?: boolean;
 }
 export declare class BaseField {
+    /** The value. */
     value?: any;
     /**
      * True if the field was reconstructed or computed using other fields.

package/src/fields/field.js

@@ -9,6 +9,7 @@ class BaseField {
      * @param {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
      */
     constructor({ prediction, valueKey = "value", reconstructed = false, }) {
+        /** The value. */
         this.value = undefined;
         this.reconstructed = reconstructed;
         if (prediction !== undefined &&

package/src/fields/index.d.ts

@@ -8,4 +8,4 @@ export { BaseField, stringDict, Field } from "./field";
 export { ListField, ListFieldValue, ClassificationField } from "./apiBuilder";
 export { FullText } from "./fullText";
 export { CompanyRegistration } from "./companyRegistration";
-export { CropperField } from "./cropper";
+export { PositionField } from "./position";

package/src/fields/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.PositionField = 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");
@@ -24,5 +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; } });
+var position_1 = require("./position");
+Object.defineProperty(exports, "PositionField", { enumerable: true, get: function () { return position_1.PositionField; } });

package/src/fields/locale.d.ts

@@ -1,7 +1,10 @@
 import { Field } from "./field";
 export declare class Locale extends Field {
+    /** The langage which has been detected */
     language: string | undefined;
+    /** The country which has been detected (ISO Alpha-2)*/
     country: string | undefined;
+    /** The currency which has been detected.*/
     currency: string | undefined;
     /**
      * @param {Object} prediction - Prediction object from HTTP response

package/src/fields/paymentDetails.d.ts

@@ -11,9 +11,13 @@ interface PaymentDetailsConstructor {
 }
 export declare class PaymentDetails extends Field {
     #private;
+    /** The account number. */
     accountNumber: number | undefined;
+    /** The account IBAN. */
     iban: string | undefined;
+    /** The routing number. */
     routingNumber: number | undefined;
+    /** The SWIFT value. */
     swift: number | undefined;
     /**
      * @param {Object} prediction - Prediction object from HTTP response

package/src/fields/{cropper.d.ts → position.d.ts}

@@ -1,6 +1,11 @@
-import { BaseField, FieldConstructor } from "./field";
+import { stringDict } from "./field";
 import { Polygon } from "../geometry";
-export declare class CropperField extends BaseField {
+export interface PositionFieldConstructor {
+    prediction: stringDict;
+    valueKey?: string;
+    pageId?: number | undefined;
+}
+export declare class PositionField {
     /** Straight rectangle. */
     boundingBox: Polygon;
     /** Free polygon with up to 30 vertices. */
@@ -11,6 +16,6 @@ export declare class CropperField extends BaseField {
     rectangle: Polygon;
     /** The document page on which the information was found. */
     pageId: number | undefined;
-    constructor({ prediction, valueKey, pageId }: FieldConstructor);
+    constructor({ prediction, pageId }: PositionFieldConstructor);
     toString(): string;
 }

package/src/fields/{cropper.js → position.js}

@@ -1,10 +1,8 @@
 "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 });
+exports.PositionField = void 0;
+class PositionField {
+    constructor({ prediction, pageId }) {
         this.pageId = pageId;
         this.boundingBox = prediction.bounding_box;
         this.polygon = prediction.polygon;
@@ -15,4 +13,4 @@ class CropperField extends field_1.BaseField {
         return `Polygon with ${this.polygon.length} points.`;
     }
 }
-exports.CropperField = CropperField;
+exports.PositionField = PositionField;

package/src/index.d.ts

@@ -1,3 +1,3 @@
-export { CustomV1, FinancialDocumentV1, InvoiceV3, PassportV1, ReceiptV3, ReceiptV4, CropperV1, fr, us, } from "./documents";
+export { CustomV1, FinancialDocumentV1, InvoiceV3, PassportV1, ReceiptV3, ReceiptV4, CropperV1, ShippingContainerV1, fr, us, eu, } from "./documents";
 export { Client } from "./client";
 export { PageOptionsOperation } from "./inputs";

package/src/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PageOptionsOperation = exports.Client = exports.us = exports.fr = exports.CropperV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PassportV1 = exports.InvoiceV3 = exports.FinancialDocumentV1 = exports.CustomV1 = void 0;
+exports.PageOptionsOperation = exports.Client = exports.eu = exports.us = exports.fr = exports.ShippingContainerV1 = exports.CropperV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PassportV1 = exports.InvoiceV3 = exports.FinancialDocumentV1 = exports.CustomV1 = void 0;
 var documents_1 = require("./documents");
 Object.defineProperty(exports, "CustomV1", { enumerable: true, get: function () { return documents_1.CustomV1; } });
 Object.defineProperty(exports, "FinancialDocumentV1", { enumerable: true, get: function () { return documents_1.FinancialDocumentV1; } });
@@ -9,8 +9,10 @@ Object.defineProperty(exports, "PassportV1", { enumerable: true, get: function (
 Object.defineProperty(exports, "ReceiptV3", { enumerable: true, get: function () { return documents_1.ReceiptV3; } });
 Object.defineProperty(exports, "ReceiptV4", { enumerable: true, get: function () { return documents_1.ReceiptV4; } });
 Object.defineProperty(exports, "CropperV1", { enumerable: true, get: function () { return documents_1.CropperV1; } });
+Object.defineProperty(exports, "ShippingContainerV1", { enumerable: true, get: function () { return documents_1.ShippingContainerV1; } });
 Object.defineProperty(exports, "fr", { enumerable: true, get: function () { return documents_1.fr; } });
 Object.defineProperty(exports, "us", { enumerable: true, get: function () { return documents_1.us; } });
+Object.defineProperty(exports, "eu", { enumerable: true, get: function () { return documents_1.eu; } });
 var client_1 = require("./client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_1.Client; } });
 var inputs_1 = require("./inputs");