mindee 3.1.1 → 3.3.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # CHANGELOG
 
+## v3.3.0 - 2022-12-01
+### Changes
+* :sparkles: Add Invoice V4 with line items
+* :sparkles: An env variable can be used to change the Mindee base API url
+
+## 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

@@ -66,11 +66,11 @@ const apiResponse = mindeeClient
 
 ### Handling the Return
 ```js
-// Print a brief summary of the parsed data
-invoiceResponse.then((resp) => {
+// Handle the response Promise
+apiResponse.then((resp) => {
 
-    // The document property can be undefined:
-    // * TypeScript will throw an error without this guard clause
+    // The `document` property can be undefined:
+    // * TypeScript will not compile without this guard clause
     //   (or consider using the '?' notation)
     // * JavaScript will be very happy to produce subtle bugs
     //   without this guard clause

package/package.json

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

package/src/api/endpoint.d.ts

@@ -3,6 +3,7 @@ import { InputSource } from "../inputs";
 import { IncomingMessage } from "http";
 export declare const STANDARD_API_OWNER = "mindee";
 export declare const API_KEY_ENVVAR_NAME = "MINDEE_API_KEY";
+export declare const API_BASE_URL_ENVVAR_NAME = "MINDEE_BASE_URL";
 export interface predictResponse {
     messageObj: IncomingMessage;
     data: {
@@ -25,6 +26,7 @@ export declare class Endpoint {
      */
     predictReqPost(input: InputSource, includeWords?: boolean, cropper?: boolean): Promise<predictResponse>;
     protected apiKeyFromEnv(): string;
+    protected baseUrlFromEnv(): string;
 }
 export declare class StandardEndpoint extends Endpoint {
     constructor(endpointName: string, version: string, apiKey: string);

package/src/api/endpoint.js

@@ -26,24 +26,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomEndpoint = exports.StandardEndpoint = exports.Endpoint = exports.API_KEY_ENVVAR_NAME = exports.STANDARD_API_OWNER = void 0;
+exports.CustomEndpoint = exports.StandardEndpoint = exports.Endpoint = exports.API_BASE_URL_ENVVAR_NAME = exports.API_KEY_ENVVAR_NAME = exports.STANDARD_API_OWNER = void 0;
 const https = __importStar(require("https"));
 const os = __importStar(require("os"));
 const package_json_1 = require("../../package.json");
 const url_1 = require("url");
 const form_data_1 = __importDefault(require("form-data"));
 const logger_1 = require("../logger");
-const MINDEE_API_URL = "https://api.mindee.net/v1";
+const DEFAULT_MINDEE_API_URL = "https://api.mindee.net/v1";
 const USER_AGENT = `mindee-api-nodejs@v${package_json_1.version} nodejs-${process.version} ${os.type().toLowerCase()}`;
 exports.STANDARD_API_OWNER = "mindee";
 exports.API_KEY_ENVVAR_NAME = "MINDEE_API_KEY";
+exports.API_BASE_URL_ENVVAR_NAME = "MINDEE_BASE_URL";
 class Endpoint {
     constructor(owner, urlName, version, apiKey) {
         this.owner = owner;
         this.urlName = urlName;
         this.version = version;
         this.apiKey = apiKey || this.apiKeyFromEnv();
-        this.urlRoot = `${MINDEE_API_URL}/products/${owner}/${urlName}/v${version}`;
+        this.urlRoot = `${this.baseUrlFromEnv()}/products/${owner}/${urlName}/v${version}`;
         this.baseHeaders = {
             "User-Agent": USER_AGENT,
             Authorization: `Token ${this.apiKey}`,
@@ -112,6 +113,14 @@ class Endpoint {
         }
         return "";
     }
+    baseUrlFromEnv() {
+        const envVarValue = process.env[exports.API_BASE_URL_ENVVAR_NAME];
+        if (envVarValue) {
+            logger_1.logger.debug(`Set the API base URL to ${envVarValue}`);
+            return envVarValue;
+        }
+        return DEFAULT_MINDEE_API_URL;
+    }
 }
 exports.Endpoint = Endpoint;
 class StandardEndpoint extends Endpoint {

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,
+            description: "Invoice V4",
+            docClass: documents_1.InvoiceV4,
             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 account or 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
@@ -85,6 +83,9 @@ class Client {
         this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.InvoiceV3.name], new documentConfig_1.DocumentConfig(documents_1.InvoiceV3, [
             new api_1.StandardEndpoint("invoices", "3", this.apiKey),
         ]));
+        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.InvoiceV4.name], new documentConfig_1.DocumentConfig(documents_1.InvoiceV4, [
+            new api_1.StandardEndpoint("invoices", "4", this.apiKey),
+        ]));
         this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.ReceiptV3.name], new documentConfig_1.DocumentConfig(documents_1.ReceiptV3, [
             new api_1.StandardEndpoint("expense_receipts", "3", this.apiKey),
         ]));
@@ -100,6 +101,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;