mindee 4.19.0 → 4.20.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## v4.20.0 - 2024-11-28
+### Changes
+* :sparkles: add support for French Health Card V1
+* :sparkles: add support for Driver License V1
+* :sparkles: add support for Payslip FR V3
+
+
 ## v4.19.0 - 2024-11-27
 ### Changes
 * :coffin: remove support for international ID V1

package/package.json

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

package/src/cli.js

@@ -109,13 +109,13 @@ const CLI_COMMAND_CONFIG = new Map([
         },
     ],
     [
-        "fr-carte-vitale",
+        "fr-health-card",
         {
-            displayName: "FR Carte Vitale",
-            docClass: product.fr.CarteVitaleV1,
+            displayName: "FR Health Card",
+            docClass: product.fr.HealthCardV1,
             allWords: false,
-            async: false,
-            sync: true,
+            async: true,
+            sync: false,
         },
     ],
     [
@@ -139,13 +139,13 @@ const CLI_COMMAND_CONFIG = new Map([
         },
     ],
     [
-        "eu-driver-license",
+        "driver-license",
         {
-            displayName: "EU Driver License",
-            docClass: product.eu.DriverLicenseV1,
+            displayName: "Driver License",
+            docClass: product.DriverLicenseV1,
             allWords: false,
-            async: false,
-            sync: true,
+            async: true,
+            sync: false,
         },
     ],
     [
@@ -228,16 +228,6 @@ const CLI_COMMAND_CONFIG = new Map([
             sync: true,
         },
     ],
-    [
-        "us-driver-license",
-        {
-            displayName: "US Driver License",
-            docClass: product.us.DriverLicenseV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
     [
         "us-healthcare-card",
         {

package/src/product/driverLicense/driverLicenseV1.d.ts

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

package/src/product/driverLicense/driverLicenseV1.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DriverLicenseV1 = void 0;
+const common_1 = require("../../parsing/common");
+const driverLicenseV1Document_1 = require("./driverLicenseV1Document");
+/**
+ * Driver License API version 1 inference prediction.
+ */
+class DriverLicenseV1 extends common_1.Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "driver_license";
+        /** The endpoint's version. */
+        this.endpointVersion = "1";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new driverLicenseV1Document_1.DriverLicenseV1Document(rawPrediction["prediction"]);
+        rawPrediction["pages"].forEach((page) => {
+            if (page.prediction !== undefined && page.prediction !== null &&
+                Object.keys(page.prediction).length > 0) {
+                this.pages.push(new common_1.Page(driverLicenseV1Document_1.DriverLicenseV1Document, page, page["id"], page["orientation"]));
+            }
+        });
+    }
+}
+exports.DriverLicenseV1 = DriverLicenseV1;

package/src/product/driverLicense/driverLicenseV1Document.d.ts

@@ -0,0 +1,38 @@
+import { Prediction, StringDict } from "../../parsing/common";
+import { DateField, StringField } from "../../parsing/standard";
+/**
+ * Driver License API version 1.0 document data.
+ */
+export declare class DriverLicenseV1Document implements Prediction {
+    /** The category or class of the driver license. */
+    category: StringField;
+    /** The alpha-3 ISO 3166 code of the country where the driver license was issued. */
+    countryCode: StringField;
+    /** The date of birth of the driver license holder. */
+    dateOfBirth: DateField;
+    /** The DD number of the driver license. */
+    ddNumber: StringField;
+    /** The expiry date of the driver license. */
+    expiryDate: DateField;
+    /** The first name of the driver license holder. */
+    firstName: StringField;
+    /** The unique identifier of the driver license. */
+    id: StringField;
+    /** The date when the driver license was issued. */
+    issuedDate: DateField;
+    /** The authority that issued the driver license. */
+    issuingAuthority: StringField;
+    /** The last name of the driver license holder. */
+    lastName: StringField;
+    /** The Machine Readable Zone (MRZ) of the driver license. */
+    mrz: StringField;
+    /** The place of birth of the driver license holder. */
+    placeOfBirth: StringField;
+    /** Second part of the ISO 3166-2 code, consisting of two letters indicating the US State. */
+    state: StringField;
+    constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

package/src/product/driverLicense/driverLicenseV1Document.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DriverLicenseV1Document = void 0;
+const common_1 = require("../../parsing/common");
+const standard_1 = require("../../parsing/standard");
+/**
+ * Driver License API version 1.0 document data.
+ */
+class DriverLicenseV1Document {
+    constructor(rawPrediction, pageId) {
+        this.category = new standard_1.StringField({
+            prediction: rawPrediction["category"],
+            pageId: pageId,
+        });
+        this.countryCode = new standard_1.StringField({
+            prediction: rawPrediction["country_code"],
+            pageId: pageId,
+        });
+        this.dateOfBirth = new standard_1.DateField({
+            prediction: rawPrediction["date_of_birth"],
+            pageId: pageId,
+        });
+        this.ddNumber = new standard_1.StringField({
+            prediction: rawPrediction["dd_number"],
+            pageId: pageId,
+        });
+        this.expiryDate = new standard_1.DateField({
+            prediction: rawPrediction["expiry_date"],
+            pageId: pageId,
+        });
+        this.firstName = new standard_1.StringField({
+            prediction: rawPrediction["first_name"],
+            pageId: pageId,
+        });
+        this.id = new standard_1.StringField({
+            prediction: rawPrediction["id"],
+            pageId: pageId,
+        });
+        this.issuedDate = new standard_1.DateField({
+            prediction: rawPrediction["issued_date"],
+            pageId: pageId,
+        });
+        this.issuingAuthority = new standard_1.StringField({
+            prediction: rawPrediction["issuing_authority"],
+            pageId: pageId,
+        });
+        this.lastName = new standard_1.StringField({
+            prediction: rawPrediction["last_name"],
+            pageId: pageId,
+        });
+        this.mrz = new standard_1.StringField({
+            prediction: rawPrediction["mrz"],
+            pageId: pageId,
+        });
+        this.placeOfBirth = new standard_1.StringField({
+            prediction: rawPrediction["place_of_birth"],
+            pageId: pageId,
+        });
+        this.state = new standard_1.StringField({
+            prediction: rawPrediction["state"],
+            pageId: pageId,
+        });
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        const outStr = `:Country Code: ${this.countryCode}
+:State: ${this.state}
+:ID: ${this.id}
+:Category: ${this.category}
+:Last Name: ${this.lastName}
+:First Name: ${this.firstName}
+:Date of Birth: ${this.dateOfBirth}
+:Place of Birth: ${this.placeOfBirth}
+:Expiry Date: ${this.expiryDate}
+:Issued Date: ${this.issuedDate}
+:Issuing Authority: ${this.issuingAuthority}
+:MRZ: ${this.mrz}
+:DD Number: ${this.ddNumber}`.trimEnd();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.DriverLicenseV1Document = DriverLicenseV1Document;

package/src/product/driverLicense/index.d.ts

@@ -0,0 +1 @@
+export { DriverLicenseV1 } from "./driverLicenseV1";

package/src/product/driverLicense/index.js

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

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

@@ -0,0 +1,2 @@
+export { DriverLicenseV1 } from "./driverLicenseV1";
+export { DriverLicenseV1Document } from "./driverLicenseV1Document";

package/src/product/driverLicense/internal.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DriverLicenseV1Document = exports.DriverLicenseV1 = void 0;
+var driverLicenseV1_1 = require("./driverLicenseV1");
+Object.defineProperty(exports, "DriverLicenseV1", { enumerable: true, get: function () { return driverLicenseV1_1.DriverLicenseV1; } });
+var driverLicenseV1Document_1 = require("./driverLicenseV1Document");
+Object.defineProperty(exports, "DriverLicenseV1Document", { enumerable: true, get: function () { return driverLicenseV1Document_1.DriverLicenseV1Document; } });

package/src/product/fr/healthCard/healthCardV1.d.ts

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

package/src/product/fr/healthCard/healthCardV1.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthCardV1 = void 0;
+const common_1 = require("../../../parsing/common");
+const healthCardV1Document_1 = require("./healthCardV1Document");
+/**
+ * Health Card API version 1 inference prediction.
+ */
+class HealthCardV1 extends common_1.Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "french_healthcard";
+        /** The endpoint's version. */
+        this.endpointVersion = "1";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new healthCardV1Document_1.HealthCardV1Document(rawPrediction["prediction"]);
+        rawPrediction["pages"].forEach((page) => {
+            if (page.prediction !== undefined && page.prediction !== null &&
+                Object.keys(page.prediction).length > 0) {
+                this.pages.push(new common_1.Page(healthCardV1Document_1.HealthCardV1Document, page, page["id"], page["orientation"]));
+            }
+        });
+    }
+}
+exports.HealthCardV1 = HealthCardV1;

package/src/product/fr/healthCard/healthCardV1Document.d.ts

@@ -0,0 +1,20 @@
+import { Prediction, StringDict } from "../../../parsing/common";
+import { DateField, StringField } from "../../../parsing/standard";
+/**
+ * Health Card API version 1.0 document data.
+ */
+export declare class HealthCardV1Document implements Prediction {
+    /** The given names of the card holder. */
+    givenNames: StringField[];
+    /** The date when the carte vitale document was issued. */
+    issuanceDate: DateField;
+    /** The social security number of the card holder. */
+    socialSecurity: StringField;
+    /** The surname of the card holder. */
+    surname: StringField;
+    constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

package/src/product/fr/healthCard/healthCardV1Document.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthCardV1Document = void 0;
+const common_1 = require("../../../parsing/common");
+const standard_1 = require("../../../parsing/standard");
+/**
+ * Health Card API version 1.0 document data.
+ */
+class HealthCardV1Document {
+    constructor(rawPrediction, pageId) {
+        /** The given names of the card holder. */
+        this.givenNames = [];
+        rawPrediction["given_names"] &&
+            rawPrediction["given_names"].map((itemPrediction) => this.givenNames.push(new standard_1.StringField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+        this.issuanceDate = new standard_1.DateField({
+            prediction: rawPrediction["issuance_date"],
+            pageId: pageId,
+        });
+        this.socialSecurity = new standard_1.StringField({
+            prediction: rawPrediction["social_security"],
+            pageId: pageId,
+        });
+        this.surname = new standard_1.StringField({
+            prediction: rawPrediction["surname"],
+            pageId: pageId,
+        });
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        const givenNames = this.givenNames.join("\n                ");
+        const outStr = `:Given Name(s): ${givenNames}
+:Surname: ${this.surname}
+:Social Security Number: ${this.socialSecurity}
+:Issuance Date: ${this.issuanceDate}`.trimEnd();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.HealthCardV1Document = HealthCardV1Document;

package/src/product/fr/healthCard/index.d.ts

@@ -0,0 +1 @@
+export { HealthCardV1 } from "./healthCardV1";

package/src/product/fr/healthCard/index.js

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

package/src/product/fr/healthCard/internal.d.ts

@@ -0,0 +1,2 @@
+export { HealthCardV1 } from "./healthCardV1";
+export { HealthCardV1Document } from "./healthCardV1Document";

package/src/product/fr/healthCard/internal.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthCardV1Document = exports.HealthCardV1 = void 0;
+var healthCardV1_1 = require("./healthCardV1");
+Object.defineProperty(exports, "HealthCardV1", { enumerable: true, get: function () { return healthCardV1_1.HealthCardV1; } });
+var healthCardV1Document_1 = require("./healthCardV1Document");
+Object.defineProperty(exports, "HealthCardV1Document", { enumerable: true, get: function () { return healthCardV1Document_1.HealthCardV1Document; } });

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

@@ -3,6 +3,8 @@ export { BankAccountDetailsV2 } from "./bankAccountDetails/bankAccountDetailsV2"
 export { CarteGriseV1 } from "./carteGrise/carteGriseV1";
 export { CarteVitaleV1 } from "./carteVitale/carteVitaleV1";
 export { EnergyBillV1 } from "./energyBill/energyBillV1";
+export { HealthCardV1 } from "./healthCard/healthCardV1";
 export { IdCardV1 } from "./idCard/idCardV1";
 export { IdCardV2 } from "./idCard/idCardV2";
 export { PayslipV2 } from "./payslip/payslipV2";
+export { PayslipV3 } from "./payslip/payslipV3";

package/src/product/fr/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PayslipV2 = exports.IdCardV2 = exports.IdCardV1 = exports.EnergyBillV1 = exports.CarteVitaleV1 = exports.CarteGriseV1 = exports.BankAccountDetailsV2 = exports.BankAccountDetailsV1 = void 0;
+exports.PayslipV3 = exports.PayslipV2 = exports.IdCardV2 = exports.IdCardV1 = exports.HealthCardV1 = exports.EnergyBillV1 = exports.CarteVitaleV1 = exports.CarteGriseV1 = exports.BankAccountDetailsV2 = exports.BankAccountDetailsV1 = void 0;
 var bankAccountDetailsV1_1 = require("./bankAccountDetails/bankAccountDetailsV1");
 Object.defineProperty(exports, "BankAccountDetailsV1", { enumerable: true, get: function () { return bankAccountDetailsV1_1.BankAccountDetailsV1; } });
 var bankAccountDetailsV2_1 = require("./bankAccountDetails/bankAccountDetailsV2");
@@ -11,9 +11,13 @@ var carteVitaleV1_1 = require("./carteVitale/carteVitaleV1");
 Object.defineProperty(exports, "CarteVitaleV1", { enumerable: true, get: function () { return carteVitaleV1_1.CarteVitaleV1; } });
 var energyBillV1_1 = require("./energyBill/energyBillV1");
 Object.defineProperty(exports, "EnergyBillV1", { enumerable: true, get: function () { return energyBillV1_1.EnergyBillV1; } });
+var healthCardV1_1 = require("./healthCard/healthCardV1");
+Object.defineProperty(exports, "HealthCardV1", { enumerable: true, get: function () { return healthCardV1_1.HealthCardV1; } });
 var idCardV1_1 = require("./idCard/idCardV1");
 Object.defineProperty(exports, "IdCardV1", { enumerable: true, get: function () { return idCardV1_1.IdCardV1; } });
 var idCardV2_1 = require("./idCard/idCardV2");
 Object.defineProperty(exports, "IdCardV2", { enumerable: true, get: function () { return idCardV2_1.IdCardV2; } });
 var payslipV2_1 = require("./payslip/payslipV2");
 Object.defineProperty(exports, "PayslipV2", { enumerable: true, get: function () { return payslipV2_1.PayslipV2; } });
+var payslipV3_1 = require("./payslip/payslipV3");
+Object.defineProperty(exports, "PayslipV3", { enumerable: true, get: function () { return payslipV3_1.PayslipV3; } });

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

@@ -2,5 +2,6 @@ export * as bankAccountDetails from "./bankAccountDetails/internal";
 export * as carteGrise from "./carteGrise/internal";
 export * as carteVitale from "./carteVitale/internal";
 export * as energyBill from "./energyBill/internal";
+export * as fr from "./healthCard/internal";
 export * as idCard from "./idCard/internal";
 export * as payslip from "./payslip/internal";

package/src/product/fr/internal.js

@@ -23,10 +23,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.payslip = exports.idCard = exports.energyBill = exports.carteVitale = exports.carteGrise = exports.bankAccountDetails = void 0;
+exports.payslip = exports.idCard = exports.fr = exports.energyBill = exports.carteVitale = exports.carteGrise = exports.bankAccountDetails = void 0;
 exports.bankAccountDetails = __importStar(require("./bankAccountDetails/internal"));
 exports.carteGrise = __importStar(require("./carteGrise/internal"));
 exports.carteVitale = __importStar(require("./carteVitale/internal"));
 exports.energyBill = __importStar(require("./energyBill/internal"));
+exports.fr = __importStar(require("./healthCard/internal"));
 exports.idCard = __importStar(require("./idCard/internal"));
 exports.payslip = __importStar(require("./payslip/internal"));

package/src/product/fr/payslip/index.d.ts

@@ -1 +1,2 @@
 export { PayslipV2 } from "./payslipV2";
+export { PayslipV3 } from "./payslipV3";

package/src/product/fr/payslip/index.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PayslipV2 = void 0;
+exports.PayslipV3 = exports.PayslipV2 = void 0;
 var payslipV2_1 = require("./payslipV2");
 Object.defineProperty(exports, "PayslipV2", { enumerable: true, get: function () { return payslipV2_1.PayslipV2; } });
+var payslipV3_1 = require("./payslipV3");
+Object.defineProperty(exports, "PayslipV3", { enumerable: true, get: function () { return payslipV3_1.PayslipV3; } });

package/src/product/fr/payslip/internal.d.ts

@@ -8,3 +8,13 @@ export { PayslipV2PayDetail } from "./payslipV2PayDetail";
 export { PayslipV2PayPeriod } from "./payslipV2PayPeriod";
 export { PayslipV2Pto } from "./payslipV2Pto";
 export { PayslipV2SalaryDetail } from "./payslipV2SalaryDetail";
+export { PayslipV3 } from "./payslipV3";
+export { PayslipV3BankAccountDetail } from "./payslipV3BankAccountDetail";
+export { PayslipV3Document } from "./payslipV3Document";
+export { PayslipV3Employee } from "./payslipV3Employee";
+export { PayslipV3Employer } from "./payslipV3Employer";
+export { PayslipV3Employment } from "./payslipV3Employment";
+export { PayslipV3PaidTimeOff } from "./payslipV3PaidTimeOff";
+export { PayslipV3PayDetail } from "./payslipV3PayDetail";
+export { PayslipV3PayPeriod } from "./payslipV3PayPeriod";
+export { PayslipV3SalaryDetail } from "./payslipV3SalaryDetail";

package/src/product/fr/payslip/internal.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PayslipV2SalaryDetail = exports.PayslipV2Pto = exports.PayslipV2PayPeriod = exports.PayslipV2PayDetail = exports.PayslipV2Employment = exports.PayslipV2Employer = exports.PayslipV2Employee = exports.PayslipV2Document = exports.PayslipV2BankAccountDetail = exports.PayslipV2 = void 0;
+exports.PayslipV3SalaryDetail = exports.PayslipV3PayPeriod = exports.PayslipV3PayDetail = exports.PayslipV3PaidTimeOff = exports.PayslipV3Employment = exports.PayslipV3Employer = exports.PayslipV3Employee = exports.PayslipV3Document = exports.PayslipV3BankAccountDetail = exports.PayslipV3 = exports.PayslipV2SalaryDetail = exports.PayslipV2Pto = exports.PayslipV2PayPeriod = exports.PayslipV2PayDetail = exports.PayslipV2Employment = exports.PayslipV2Employer = exports.PayslipV2Employee = exports.PayslipV2Document = exports.PayslipV2BankAccountDetail = exports.PayslipV2 = void 0;
 var payslipV2_1 = require("./payslipV2");
 Object.defineProperty(exports, "PayslipV2", { enumerable: true, get: function () { return payslipV2_1.PayslipV2; } });
 var payslipV2BankAccountDetail_1 = require("./payslipV2BankAccountDetail");
@@ -21,3 +21,23 @@ var payslipV2Pto_1 = require("./payslipV2Pto");
 Object.defineProperty(exports, "PayslipV2Pto", { enumerable: true, get: function () { return payslipV2Pto_1.PayslipV2Pto; } });
 var payslipV2SalaryDetail_1 = require("./payslipV2SalaryDetail");
 Object.defineProperty(exports, "PayslipV2SalaryDetail", { enumerable: true, get: function () { return payslipV2SalaryDetail_1.PayslipV2SalaryDetail; } });
+var payslipV3_1 = require("./payslipV3");
+Object.defineProperty(exports, "PayslipV3", { enumerable: true, get: function () { return payslipV3_1.PayslipV3; } });
+var payslipV3BankAccountDetail_1 = require("./payslipV3BankAccountDetail");
+Object.defineProperty(exports, "PayslipV3BankAccountDetail", { enumerable: true, get: function () { return payslipV3BankAccountDetail_1.PayslipV3BankAccountDetail; } });
+var payslipV3Document_1 = require("./payslipV3Document");
+Object.defineProperty(exports, "PayslipV3Document", { enumerable: true, get: function () { return payslipV3Document_1.PayslipV3Document; } });
+var payslipV3Employee_1 = require("./payslipV3Employee");
+Object.defineProperty(exports, "PayslipV3Employee", { enumerable: true, get: function () { return payslipV3Employee_1.PayslipV3Employee; } });
+var payslipV3Employer_1 = require("./payslipV3Employer");
+Object.defineProperty(exports, "PayslipV3Employer", { enumerable: true, get: function () { return payslipV3Employer_1.PayslipV3Employer; } });
+var payslipV3Employment_1 = require("./payslipV3Employment");
+Object.defineProperty(exports, "PayslipV3Employment", { enumerable: true, get: function () { return payslipV3Employment_1.PayslipV3Employment; } });
+var payslipV3PaidTimeOff_1 = require("./payslipV3PaidTimeOff");
+Object.defineProperty(exports, "PayslipV3PaidTimeOff", { enumerable: true, get: function () { return payslipV3PaidTimeOff_1.PayslipV3PaidTimeOff; } });
+var payslipV3PayDetail_1 = require("./payslipV3PayDetail");
+Object.defineProperty(exports, "PayslipV3PayDetail", { enumerable: true, get: function () { return payslipV3PayDetail_1.PayslipV3PayDetail; } });
+var payslipV3PayPeriod_1 = require("./payslipV3PayPeriod");
+Object.defineProperty(exports, "PayslipV3PayPeriod", { enumerable: true, get: function () { return payslipV3PayPeriod_1.PayslipV3PayPeriod; } });
+var payslipV3SalaryDetail_1 = require("./payslipV3SalaryDetail");
+Object.defineProperty(exports, "PayslipV3SalaryDetail", { enumerable: true, get: function () { return payslipV3SalaryDetail_1.PayslipV3SalaryDetail; } });

package/src/product/fr/payslip/payslipV3.d.ts

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

package/src/product/fr/payslip/payslipV3.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayslipV3 = void 0;
+const common_1 = require("../../../parsing/common");
+const payslipV3Document_1 = require("./payslipV3Document");
+/**
+ * Payslip API version 3 inference prediction.
+ */
+class PayslipV3 extends common_1.Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "payslip_fra";
+        /** The endpoint's version. */
+        this.endpointVersion = "3";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new payslipV3Document_1.PayslipV3Document(rawPrediction["prediction"]);
+        rawPrediction["pages"].forEach((page) => {
+            if (page.prediction !== undefined && page.prediction !== null &&
+                Object.keys(page.prediction).length > 0) {
+                this.pages.push(new common_1.Page(payslipV3Document_1.PayslipV3Document, page, page["id"], page["orientation"]));
+            }
+        });
+    }
+}
+exports.PayslipV3 = PayslipV3;

package/src/product/fr/payslip/payslipV3BankAccountDetail.d.ts

@@ -0,0 +1,32 @@
+import { StringDict } from "../../../parsing/common";
+import { Polygon } from "../../../geometry";
+/**
+ * Information about the employee's bank account.
+ */
+export declare class PayslipV3BankAccountDetail {
+    #private;
+    /** The name of the bank. */
+    bankName: string | null;
+    /** The IBAN of the bank account. */
+    iban: string | null;
+    /** The SWIFT code of the bank. */
+    swift: string | null;
+    /** Confidence score */
+    confidence: number;
+    /** The document page on which the information was found. */
+    pageId: number;
+    /**
+     * Contains the relative vertices coordinates (points) of a polygon containing
+     * the field in the document.
+     */
+    polygon: Polygon;
+    constructor({ prediction }: StringDict);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+    /**
+     * Output in a format suitable for inclusion in a field list.
+     */
+    toFieldList(): string;
+}