mindee 4.36.3 → 5.0.0-alpha1

package/src/v1/product/fr/carteGrise/carteGriseV1Document.js

@@ -0,0 +1,220 @@
+import { cleanOutString, } from "../../../../v1/parsing/common/index.js";
+import { DateField, StringField } from "../../../../v1/parsing/standard/index.js";
+/**
+ * Carte Grise API version 1.1 document data.
+ */
+export class CarteGriseV1Document {
+    constructor(rawPrediction, pageId) {
+        this.a = new StringField({
+            prediction: rawPrediction["a"],
+            pageId: pageId,
+        });
+        this.b = new DateField({
+            prediction: rawPrediction["b"],
+            pageId: pageId,
+        });
+        this.c1 = new StringField({
+            prediction: rawPrediction["c1"],
+            pageId: pageId,
+        });
+        this.c3 = new StringField({
+            prediction: rawPrediction["c3"],
+            pageId: pageId,
+        });
+        this.c41 = new StringField({
+            prediction: rawPrediction["c41"],
+            pageId: pageId,
+        });
+        this.c4A = new StringField({
+            prediction: rawPrediction["c4a"],
+            pageId: pageId,
+        });
+        this.d1 = new StringField({
+            prediction: rawPrediction["d1"],
+            pageId: pageId,
+        });
+        this.d3 = new StringField({
+            prediction: rawPrediction["d3"],
+            pageId: pageId,
+        });
+        this.e = new StringField({
+            prediction: rawPrediction["e"],
+            pageId: pageId,
+        });
+        this.f1 = new StringField({
+            prediction: rawPrediction["f1"],
+            pageId: pageId,
+        });
+        this.f2 = new StringField({
+            prediction: rawPrediction["f2"],
+            pageId: pageId,
+        });
+        this.f3 = new StringField({
+            prediction: rawPrediction["f3"],
+            pageId: pageId,
+        });
+        this.formulaNumber = new StringField({
+            prediction: rawPrediction["formula_number"],
+            pageId: pageId,
+        });
+        this.g = new StringField({
+            prediction: rawPrediction["g"],
+            pageId: pageId,
+        });
+        this.g1 = new StringField({
+            prediction: rawPrediction["g1"],
+            pageId: pageId,
+        });
+        this.i = new DateField({
+            prediction: rawPrediction["i"],
+            pageId: pageId,
+        });
+        this.j = new StringField({
+            prediction: rawPrediction["j"],
+            pageId: pageId,
+        });
+        this.j1 = new StringField({
+            prediction: rawPrediction["j1"],
+            pageId: pageId,
+        });
+        this.j2 = new StringField({
+            prediction: rawPrediction["j2"],
+            pageId: pageId,
+        });
+        this.j3 = new StringField({
+            prediction: rawPrediction["j3"],
+            pageId: pageId,
+        });
+        this.mrz1 = new StringField({
+            prediction: rawPrediction["mrz1"],
+            pageId: pageId,
+        });
+        this.mrz2 = new StringField({
+            prediction: rawPrediction["mrz2"],
+            pageId: pageId,
+        });
+        this.ownerFirstName = new StringField({
+            prediction: rawPrediction["owner_first_name"],
+            pageId: pageId,
+        });
+        this.ownerSurname = new StringField({
+            prediction: rawPrediction["owner_surname"],
+            pageId: pageId,
+        });
+        this.p1 = new StringField({
+            prediction: rawPrediction["p1"],
+            pageId: pageId,
+        });
+        this.p2 = new StringField({
+            prediction: rawPrediction["p2"],
+            pageId: pageId,
+        });
+        this.p3 = new StringField({
+            prediction: rawPrediction["p3"],
+            pageId: pageId,
+        });
+        this.p6 = new StringField({
+            prediction: rawPrediction["p6"],
+            pageId: pageId,
+        });
+        this.q = new StringField({
+            prediction: rawPrediction["q"],
+            pageId: pageId,
+        });
+        this.s1 = new StringField({
+            prediction: rawPrediction["s1"],
+            pageId: pageId,
+        });
+        this.s2 = new StringField({
+            prediction: rawPrediction["s2"],
+            pageId: pageId,
+        });
+        this.u1 = new StringField({
+            prediction: rawPrediction["u1"],
+            pageId: pageId,
+        });
+        this.u2 = new StringField({
+            prediction: rawPrediction["u2"],
+            pageId: pageId,
+        });
+        this.v7 = new StringField({
+            prediction: rawPrediction["v7"],
+            pageId: pageId,
+        });
+        this.x1 = new StringField({
+            prediction: rawPrediction["x1"],
+            pageId: pageId,
+        });
+        this.y1 = new StringField({
+            prediction: rawPrediction["y1"],
+            pageId: pageId,
+        });
+        this.y2 = new StringField({
+            prediction: rawPrediction["y2"],
+            pageId: pageId,
+        });
+        this.y3 = new StringField({
+            prediction: rawPrediction["y3"],
+            pageId: pageId,
+        });
+        this.y4 = new StringField({
+            prediction: rawPrediction["y4"],
+            pageId: pageId,
+        });
+        this.y5 = new StringField({
+            prediction: rawPrediction["y5"],
+            pageId: pageId,
+        });
+        this.y6 = new StringField({
+            prediction: rawPrediction["y6"],
+            pageId: pageId,
+        });
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        const outStr = `:a: ${this.a}
+:b: ${this.b}
+:c1: ${this.c1}
+:c3: ${this.c3}
+:c41: ${this.c41}
+:c4a: ${this.c4A}
+:d1: ${this.d1}
+:d3: ${this.d3}
+:e: ${this.e}
+:f1: ${this.f1}
+:f2: ${this.f2}
+:f3: ${this.f3}
+:g: ${this.g}
+:g1: ${this.g1}
+:i: ${this.i}
+:j: ${this.j}
+:j1: ${this.j1}
+:j2: ${this.j2}
+:j3: ${this.j3}
+:p1: ${this.p1}
+:p2: ${this.p2}
+:p3: ${this.p3}
+:p6: ${this.p6}
+:q: ${this.q}
+:s1: ${this.s1}
+:s2: ${this.s2}
+:u1: ${this.u1}
+:u2: ${this.u2}
+:v7: ${this.v7}
+:x1: ${this.x1}
+:y1: ${this.y1}
+:y2: ${this.y2}
+:y3: ${this.y3}
+:y4: ${this.y4}
+:y5: ${this.y5}
+:y6: ${this.y6}
+:Formula Number: ${this.formulaNumber}
+:Owner's First Name: ${this.ownerFirstName}
+:Owner's Surname: ${this.ownerSurname}
+:MRZ Line 1: ${this.mrz1}
+:MRZ Line 2: ${this.mrz2}`.trimEnd();
+        return cleanOutString(outStr);
+    }
+}

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

@@ -0,0 +1,2 @@
+export { CarteGriseV1 } from "./carteGriseV1.js";
+export { CarteGriseV1Document } from "./carteGriseV1Document.js";

package/src/v1/product/fr/carteGrise/index.js

@@ -0,0 +1,2 @@
+export { CarteGriseV1 } from "./carteGriseV1.js";
+export { CarteGriseV1Document } from "./carteGriseV1Document.js";

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

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

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

@@ -0,0 +1,24 @@
+import { Inference, Page } from "../../../../v1/parsing/common/index.js";
+import { IdCardV2Document } from "./idCardV2Document.js";
+import { IdCardV2Page } from "./idCardV2Page.js";
+/**
+ * Carte Nationale d'Identité API version 2 inference prediction.
+ */
+export class IdCardV2 extends Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "idcard_fr";
+        /** The endpoint's version. */
+        this.endpointVersion = "2";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new IdCardV2Document(rawPrediction["prediction"]);
+        rawPrediction["pages"].forEach((page) => {
+            if (page.prediction !== undefined && page.prediction !== null &&
+                Object.keys(page.prediction).length > 0) {
+                this.pages.push(new Page(IdCardV2Page, page, page["id"], page["orientation"]));
+            }
+        });
+    }
+}

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

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

package/src/v1/product/fr/idCard/idCardV2Document.js

@@ -0,0 +1,95 @@
+import { cleanOutString, } from "../../../../v1/parsing/common/index.js";
+import { DateField, StringField } from "../../../../v1/parsing/standard/index.js";
+/**
+ * Carte Nationale d'Identité API version 2.0 document data.
+ */
+export class IdCardV2Document {
+    constructor(rawPrediction, pageId) {
+        /** The given name(s) of the card holder. */
+        this.givenNames = [];
+        this.alternateName = new StringField({
+            prediction: rawPrediction["alternate_name"],
+            pageId: pageId,
+        });
+        this.authority = new StringField({
+            prediction: rawPrediction["authority"],
+            pageId: pageId,
+        });
+        this.birthDate = new DateField({
+            prediction: rawPrediction["birth_date"],
+            pageId: pageId,
+        });
+        this.birthPlace = new StringField({
+            prediction: rawPrediction["birth_place"],
+            pageId: pageId,
+        });
+        this.cardAccessNumber = new StringField({
+            prediction: rawPrediction["card_access_number"],
+            pageId: pageId,
+        });
+        this.documentNumber = new StringField({
+            prediction: rawPrediction["document_number"],
+            pageId: pageId,
+        });
+        this.expiryDate = new DateField({
+            prediction: rawPrediction["expiry_date"],
+            pageId: pageId,
+        });
+        this.gender = new StringField({
+            prediction: rawPrediction["gender"],
+            pageId: pageId,
+        });
+        if (rawPrediction["given_names"]) {
+            rawPrediction["given_names"].map((itemPrediction) => this.givenNames.push(new StringField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+        }
+        this.issueDate = new DateField({
+            prediction: rawPrediction["issue_date"],
+            pageId: pageId,
+        });
+        this.mrz1 = new StringField({
+            prediction: rawPrediction["mrz1"],
+            pageId: pageId,
+        });
+        this.mrz2 = new StringField({
+            prediction: rawPrediction["mrz2"],
+            pageId: pageId,
+        });
+        this.mrz3 = new StringField({
+            prediction: rawPrediction["mrz3"],
+            pageId: pageId,
+        });
+        this.nationality = new StringField({
+            prediction: rawPrediction["nationality"],
+            pageId: pageId,
+        });
+        this.surname = new StringField({
+            prediction: rawPrediction["surname"],
+            pageId: pageId,
+        });
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        const givenNames = this.givenNames.join("\n                ");
+        const outStr = `:Nationality: ${this.nationality}
+:Card Access Number: ${this.cardAccessNumber}
+:Document Number: ${this.documentNumber}
+:Given Name(s): ${givenNames}
+:Surname: ${this.surname}
+:Alternate Name: ${this.alternateName}
+:Date of Birth: ${this.birthDate}
+:Place of Birth: ${this.birthPlace}
+:Gender: ${this.gender}
+:Expiry Date: ${this.expiryDate}
+:Mrz Line 1: ${this.mrz1}
+:Mrz Line 2: ${this.mrz2}
+:Mrz Line 3: ${this.mrz3}
+:Date of Issue: ${this.issueDate}
+:Issuing Authority: ${this.authority}`.trimEnd();
+        return cleanOutString(outStr);
+    }
+}

package/src/v1/product/fr/idCard/idCardV2Page.d.ts

@@ -0,0 +1,14 @@
+import { StringDict } from "../../../../v1/parsing/common/index.js";
+import { ClassificationField } from "../../../../v1/parsing/standard/index.js";
+import { IdCardV2Document } from "./idCardV2Document.js";
+/**
+ * Carte Nationale d'Identité API version 2.0 page data.
+ */
+export declare class IdCardV2Page extends IdCardV2Document {
+    /** The sides of the document which are visible. */
+    documentSide: ClassificationField;
+    /** The document type or format. */
+    documentType: ClassificationField;
+    constructor(rawPrediction: StringDict, pageId?: number);
+    toString(): string;
+}

package/src/v1/product/fr/idCard/idCardV2Page.js

@@ -0,0 +1,23 @@
+import { cleanOutString } from "../../../../v1/parsing/common/index.js";
+import { ClassificationField } from "../../../../v1/parsing/standard/index.js";
+import { IdCardV2Document } from "./idCardV2Document.js";
+/**
+ * Carte Nationale d'Identité API version 2.0 page data.
+ */
+export class IdCardV2Page extends IdCardV2Document {
+    constructor(rawPrediction, pageId) {
+        super(rawPrediction, pageId);
+        this.documentSide = new ClassificationField({
+            prediction: rawPrediction["document_side"],
+        });
+        this.documentType = new ClassificationField({
+            prediction: rawPrediction["document_type"],
+        });
+    }
+    toString() {
+        let outStr = `:Document Type: ${this.documentType}
+:Document Sides: ${this.documentSide}`.trimEnd();
+        outStr += "\n" + super.toString();
+        return cleanOutString(outStr);
+    }
+}

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

@@ -0,0 +1,3 @@
+export { IdCardV2 } from "./idCardV2.js";
+export { IdCardV2Document } from "./idCardV2Document.js";
+export { IdCardV2Page } from "./idCardV2Page.js";

package/src/v1/product/fr/idCard/index.js

@@ -0,0 +1,3 @@
+export { IdCardV2 } from "./idCardV2.js";
+export { IdCardV2Document } from "./idCardV2Document.js";
+export { IdCardV2Page } from "./idCardV2Page.js";

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

@@ -0,0 +1,6 @@
+export { BankAccountDetailsV1 } from "./bankAccountDetails/index.js";
+export { BankAccountDetailsV2 } from "./bankAccountDetails/index.js";
+export { IdCardV2 } from "./idCard/index.js";
+export { CarteGriseV1 } from "./carteGrise/index.js";
+export * as bankAccountDetails from "./bankAccountDetails/index.js";
+export * as idCard from "./idCard/index.js";

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

@@ -0,0 +1,6 @@
+export { BankAccountDetailsV1 } from "./bankAccountDetails/index.js";
+export { BankAccountDetailsV2 } from "./bankAccountDetails/index.js";
+export { IdCardV2 } from "./idCard/index.js";
+export { CarteGriseV1 } from "./carteGrise/index.js";
+export * as bankAccountDetails from "./bankAccountDetails/index.js";
+export * as idCard from "./idCard/index.js";

package/src/v1/product/generated/generatedV1.d.ts

@@ -0,0 +1,17 @@
+import { Inference, Page, StringDict } from "../../../v1/parsing/common/index.js";
+import { GeneratedV1Document } from "./generatedV1Document.js";
+import { GeneratedV1Page } from "./generatedV1Page.js";
+/**
+ * Generated API V1 inference results.
+ */
+export declare class GeneratedV1 extends Inference {
+    /** The endpoint's name. Note: placeholder for custom APIs. */
+    endpointName: string;
+    /** The endpoint's version. Note: placeholder for custom APIs. */
+    endpointVersion: string;
+    /** The document-level prediction. */
+    prediction: GeneratedV1Document;
+    /** The document's pages. */
+    pages: Page<GeneratedV1Page>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/v1/product/generated/generatedV1.js

@@ -0,0 +1,20 @@
+import { Inference, Page } from "../../../v1/parsing/common/index.js";
+import { GeneratedV1Document } from "./generatedV1Document.js";
+import { GeneratedV1Page } from "./generatedV1Page.js";
+/**
+ * Generated API V1 inference results.
+ */
+export class GeneratedV1 extends Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. Note: placeholder for custom APIs. */
+        this.endpointName = "custom";
+        /** The endpoint's version. Note: placeholder for custom APIs. */
+        this.endpointVersion = "1";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new GeneratedV1Document(rawPrediction["prediction"]);
+        this.pages = rawPrediction["pages"].length > 0 && Object.keys(rawPrediction["pages"][0]["prediction"]).length > 0 ?
+            rawPrediction["pages"].map((page) => new Page(GeneratedV1Page, page, page["id"])) : [];
+    }
+}

package/src/v1/product/generated/generatedV1Document.d.ts

@@ -0,0 +1,8 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+import { GeneratedV1Prediction } from "./generatedV1Prediction.js";
+/**
+ * Generated V1 document prediction results.
+ */
+export declare class GeneratedV1Document extends GeneratedV1Prediction {
+    constructor(rawPrediction: StringDict);
+}

package/src/v1/product/generated/generatedV1Document.js

@@ -0,0 +1,26 @@
+import { GeneratedListField, GeneratedObjectField, isGeneratedObject } from "../../../v1/parsing/generated/index.js";
+import { StringField } from "../../../v1/parsing/standard/index.js";
+import { GeneratedV1Prediction } from "./generatedV1Prediction.js";
+/**
+ * Generated V1 document prediction results.
+ */
+export class GeneratedV1Document extends GeneratedV1Prediction {
+    constructor(rawPrediction) {
+        super();
+        Object.entries(rawPrediction).forEach(([fieldName, fieldValue]) => {
+            if (Array.isArray(fieldValue)) {
+                this.fields.set(fieldName, new GeneratedListField({ prediction: fieldValue }));
+            }
+            else if (typeof fieldValue === "object" && fieldValue !== null && isGeneratedObject(fieldValue)) {
+                this.fields.set(fieldName, new GeneratedObjectField({ prediction: fieldValue }));
+            }
+            else {
+                const fieldValueStr = fieldValue;
+                if (Object.prototype.hasOwnProperty.call(fieldValueStr, "value") && fieldValueStr["value"] !== null) {
+                    fieldValueStr["value"] = fieldValueStr["value"].toString();
+                }
+                this.fields.set(fieldName, new StringField({ prediction: fieldValueStr }));
+            }
+        });
+    }
+}

package/src/v1/product/generated/generatedV1Page.d.ts

@@ -0,0 +1,8 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+import { GeneratedV1Prediction } from "./generatedV1Prediction.js";
+/**
+ * Generated V1 page prediction results.
+ */
+export declare class GeneratedV1Page extends GeneratedV1Prediction {
+    constructor(rawPrediction: StringDict, pageId?: number);
+}

package/src/v1/product/generated/generatedV1Page.js

@@ -0,0 +1,26 @@
+import { GeneratedListField, GeneratedObjectField, isGeneratedObject } from "../../../v1/parsing/generated/index.js";
+import { StringField } from "../../../v1/parsing/standard/index.js";
+import { GeneratedV1Prediction } from "./generatedV1Prediction.js";
+/**
+ * Generated V1 page prediction results.
+ */
+export class GeneratedV1Page extends GeneratedV1Prediction {
+    constructor(rawPrediction, pageId) {
+        super();
+        Object.entries(rawPrediction).forEach(([fieldName, fieldValue]) => {
+            if (Array.isArray(fieldValue)) {
+                this.fields.set(fieldName, new GeneratedListField({ prediction: fieldValue, pageId: pageId }));
+            }
+            else if (typeof fieldValue === "object" && fieldValue !== null && isGeneratedObject(fieldValue)) {
+                this.fields.set(fieldName, new GeneratedObjectField({ prediction: fieldValue, pageId: pageId }));
+            }
+            else {
+                const fieldValueStr = fieldValue;
+                if (Object.prototype.hasOwnProperty.call(fieldValueStr, "value") && fieldValueStr["value"] !== null) {
+                    fieldValueStr["value"] = fieldValueStr["value"].toString();
+                }
+                this.fields.set(fieldName, new StringField({ prediction: fieldValueStr, pageId: pageId }));
+            }
+        });
+    }
+}

package/src/v1/product/generated/generatedV1Prediction.d.ts

@@ -0,0 +1,25 @@
+import { Prediction } from "../../../v1/parsing/common/index.js";
+import { GeneratedListField } from "../../../v1/parsing/generated/index.js";
+import { StringField } from "../../../v1/parsing/standard/index.js";
+export declare class GeneratedV1Prediction implements Prediction {
+    /** Map of all fields in the document. */
+    fields: Map<string, any>;
+    constructor();
+    toString(): string;
+    /**
+     * Returns a dictionary of all fields that aren't a collection.
+     */
+    getSingleField(): Map<string, StringField>;
+    /**
+     * Returns a dictionary of all array-like fields.
+     */
+    getArrayFields(): Map<string, GeneratedListField>;
+    /**
+     * Returns a dictionary of all object-like fields.
+     */
+    getObjectFields(): Map<string, GeneratedListField>;
+    /**
+     * Lists names of all top-level field keys.
+     */
+    listFieldNames(): string[];
+}