mindee 3.0.1 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## v3.1.0 - 2022-11-08
+### Changes
+* :sparkles:  Add support for French ID cards.
+* :sparkles: add buffer input source
+
 ## v3.0.1 - 2022-11-02
 ### Fixes
 * :bug: Fix for `supplier` property name in `ReceiptV4` document.

package/README.md

@@ -21,7 +21,7 @@ const mindee = require("mindee");
 // import * as mindee from "mindee";
 
 // Init a new client
-const mindeeClient = new mindee.Client({apiKey: "my-api-key"});
+const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
 
 // Load a file from disk and parse it
 const invoiceResponse = mindeeClient
@@ -54,7 +54,7 @@ const mindee = require("mindee");
 // import * as mindee from "mindee";
 
 // Init a new client and add your document endpoint
-const mindeeClient = new mindee.Client({apiKey: "my-api-key"})
+const mindeeClient = new mindee.Client({ apiKey: "my-api-key" })
     .addEndpoint({
         accountName: "john",
         endpointName: "wsnine",
@@ -83,7 +83,7 @@ There's more to it than that for those that need more features, or want to
 customize the experience.
 
 All the juicy details are described in the
-**[Official Documentation](https://developers.mindee.com/docs/nodejs-sdk)**.
+**[Official Guide](https://developers.mindee.com/docs/nodejs-sdk)**.
 
 ## License
 Copyright © Mindee

package/package.json

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

package/src/cli.js

@@ -10,6 +10,7 @@ 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";
 const CLI_COMMAND_CONFIG = new Map([
     [
@@ -44,6 +45,14 @@ const CLI_COMMAND_CONFIG = new Map([
             fullText: true,
         },
     ],
+    [
+        COMMAND_FR_ID_CARD,
+        {
+            description: "FR ID Card V1",
+            docType: documents_1.DOC_TYPE_IDCARD_V1,
+            fullText: false,
+        },
+    ],
     [
         COMMAND_CUSTOM,
         {
@@ -95,6 +104,9 @@ async function predictCall(command, inputPath, options) {
         case COMMAND_PASSPORT:
             response = await doc.parse(documents_1.PassportV1, predictParams);
             break;
+        case COMMAND_FR_ID_CARD:
+            response = await doc.parse(documents_1.IdCardV1, predictParams);
+            break;
         case COMMAND_CUSTOM:
             response = await doc.parse(documents_1.CustomV1, predictParams);
             break;

package/src/client.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { InputSource, PageOptions } from "./inputs";
 import { Response } from "./api";
 import { Document, DocumentSig } from "./documents";
@@ -79,5 +80,11 @@ export declare class Client {
      * @param url
      */
     docFromUrl(url: string): DocumentClient;
+    /**
+     * Load an input document from a Buffer.
+     * @param buffer
+     * @param filename
+     */
+    docFromBuffer(buffer: Buffer, filename: string): DocumentClient;
 }
 export {};

package/src/client.js

@@ -97,6 +97,9 @@ class Client {
         this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.CropperV1.name], new documentConfig_1.DocumentConfig(documents_1.CropperV1, [
             new api_1.StandardEndpoint("cropper", "1", this.apiKey),
         ]));
+        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.IdCardV1.name], new documentConfig_1.DocumentConfig(documents_1.IdCardV1, [
+            new api_1.StandardEndpoint("idcard_fr", "1", this.apiKey),
+        ]));
     }
     /**
      * Add a custom endpoint to the client.
@@ -169,5 +172,17 @@ class Client {
         });
         return new DocumentClient(doc, this.docConfigs);
     }
+    /**
+     * Load an input document from a Buffer.
+     * @param buffer
+     * @param filename
+     */
+    docFromBuffer(buffer, filename) {
+        const doc = new inputs_1.BufferInput({
+            buffer: buffer,
+            filename: filename,
+        });
+        return new DocumentClient(doc, this.docConfigs);
+    }
 }
 exports.Client = Client;

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

@@ -1,3 +1,17 @@
-import { Document } from "../../document";
+import { Document, DocumentConstructorProps } from "../../document";
+import { Field, DateField, BaseField } from "../../../fields";
 export declare class IdCardV1 extends Document {
+    authority: Field;
+    documentSide: BaseField;
+    idNumber: Field;
+    birthDate: DateField;
+    expiryDate: DateField;
+    birthPlace: Field;
+    gender: Field;
+    mrz1: Field;
+    mrz2: Field;
+    surname: Field;
+    givenNames: Field[];
+    constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
+    toString(): string;
 }

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

@@ -2,6 +2,77 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IdCardV1 = void 0;
 const document_1 = require("../../document");
+const fields_1 = require("../../../fields");
 class IdCardV1 extends document_1.Document {
+    constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, pageId = undefined, }) {
+        super({
+            inputSource: inputSource,
+            pageId: pageId,
+            orientation: orientation,
+            extras: extras,
+        });
+        this.givenNames = [];
+        this.authority = new fields_1.Field({
+            prediction: prediction.authority,
+            pageId: pageId,
+        });
+        this.documentSide = new fields_1.BaseField({
+            prediction: prediction.document_side,
+        });
+        this.idNumber = new fields_1.Field({
+            prediction: prediction.id_number,
+            pageId: pageId,
+        });
+        this.birthDate = new fields_1.DateField({
+            prediction: prediction.birth_date,
+            pageId: pageId,
+        });
+        this.expiryDate = new fields_1.DateField({
+            prediction: prediction.expiry_date,
+            pageId: pageId,
+        });
+        this.birthPlace = new fields_1.Field({
+            prediction: prediction.birth_place,
+            pageId: pageId,
+        });
+        this.gender = new fields_1.Field({
+            prediction: prediction.gender,
+            pageId: pageId,
+        });
+        this.surname = new fields_1.Field({
+            prediction: prediction.surname,
+            pageId: pageId,
+        });
+        this.mrz1 = new fields_1.Field({
+            prediction: prediction.mrz1,
+            pageId: pageId,
+        });
+        this.mrz2 = new fields_1.Field({
+            prediction: prediction.mrz2,
+            pageId: pageId,
+        });
+        prediction.given_names.map((prediction) => this.givenNames.push(new fields_1.Field({
+            prediction: prediction,
+            pageId: pageId,
+        })));
+    }
+    toString() {
+        const outStr = `----- FR ID Card V1 -----
+Filename: ${this.filename}
+Document side: ${this.documentSide}
+Authority: ${this.authority}
+Given names: ${this.givenNames.map((name) => name.value).join(" ")}
+Surname: ${this.surname}
+Gender: ${this.gender}
+ID Number: ${this.idNumber}
+Birth date: ${this.birthDate}
+Birth place: ${this.birthPlace}
+Expiry date: ${this.expiryDate}
+MRZ 1: ${this.mrz1}
+MRZ 2: ${this.mrz2}
+----------------------
+`;
+        return IdCardV1.cleanOutString(outStr);
+    }
 }
 exports.IdCardV1 = IdCardV1;

package/src/documents/index.d.ts

@@ -5,8 +5,9 @@ import { PassportV1 } from "./passport/passportV1";
 import { FinancialDocumentV1 } from "./financialDocument/financialDocumentV1";
 import { CustomV1 } from "./custom";
 import { CropperV1 } from "./cropper/cropperV1";
+import { IdCardV1 } from "./fr/idCard/idCardV1";
 export { Document, DocumentConstructorProps, DocumentSig } from "./document";
-export { ReceiptV3, ReceiptV4, InvoiceV3, FinancialDocumentV1, PassportV1, CustomV1, CropperV1, };
+export { ReceiptV3, ReceiptV4, InvoiceV3, FinancialDocumentV1, PassportV1, CustomV1, CropperV1, IdCardV1, };
 export declare const DOC_TYPE_CUSTOM: string;
 export declare const DOC_TYPE_INVOICE_V3: string;
 export declare const DOC_TYPE_RECEIPT_V3: string;
@@ -14,3 +15,4 @@ export declare const DOC_TYPE_RECEIPT_V4: string;
 export declare const DOC_TYPE_PASSPORT_V1: string;
 export declare const DOC_TYPE_FINANCIAL_V1: string;
 export declare const DOC_TYPE_CROPPER_V1: string;
+export declare const DOC_TYPE_IDCARD_V1: string;

package/src/documents/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DOC_TYPE_CROPPER_V1 = exports.DOC_TYPE_FINANCIAL_V1 = exports.DOC_TYPE_PASSPORT_V1 = exports.DOC_TYPE_RECEIPT_V4 = exports.DOC_TYPE_RECEIPT_V3 = exports.DOC_TYPE_INVOICE_V3 = exports.DOC_TYPE_CUSTOM = exports.CropperV1 = exports.CustomV1 = exports.PassportV1 = exports.FinancialDocumentV1 = exports.InvoiceV3 = exports.ReceiptV4 = exports.ReceiptV3 = exports.Document = void 0;
+exports.DOC_TYPE_IDCARD_V1 = exports.DOC_TYPE_CROPPER_V1 = exports.DOC_TYPE_FINANCIAL_V1 = exports.DOC_TYPE_PASSPORT_V1 = exports.DOC_TYPE_RECEIPT_V4 = exports.DOC_TYPE_RECEIPT_V3 = exports.DOC_TYPE_INVOICE_V3 = exports.DOC_TYPE_CUSTOM = exports.IdCardV1 = exports.CropperV1 = exports.CustomV1 = exports.PassportV1 = exports.FinancialDocumentV1 = exports.InvoiceV3 = exports.ReceiptV4 = exports.ReceiptV3 = exports.Document = void 0;
 const invoiceV3_1 = require("./invoice/invoiceV3");
 Object.defineProperty(exports, "InvoiceV3", { enumerable: true, get: function () { return invoiceV3_1.InvoiceV3; } });
 const receiptV3_1 = require("./receipt/receiptV3");
@@ -15,6 +15,8 @@ const custom_1 = require("./custom");
 Object.defineProperty(exports, "CustomV1", { enumerable: true, get: function () { return custom_1.CustomV1; } });
 const cropperV1_1 = require("./cropper/cropperV1");
 Object.defineProperty(exports, "CropperV1", { enumerable: true, get: function () { return cropperV1_1.CropperV1; } });
+const idCardV1_1 = require("./fr/idCard/idCardV1");
+Object.defineProperty(exports, "IdCardV1", { enumerable: true, get: function () { return idCardV1_1.IdCardV1; } });
 var document_1 = require("./document");
 Object.defineProperty(exports, "Document", { enumerable: true, get: function () { return document_1.Document; } });
 exports.DOC_TYPE_CUSTOM = custom_1.CustomV1.name;
@@ -24,3 +26,4 @@ exports.DOC_TYPE_RECEIPT_V4 = receiptV4_1.ReceiptV4.name;
 exports.DOC_TYPE_PASSPORT_V1 = passportV1_1.PassportV1.name;
 exports.DOC_TYPE_FINANCIAL_V1 = financialDocumentV1_1.FinancialDocumentV1.name;
 exports.DOC_TYPE_CROPPER_V1 = cropperV1_1.CropperV1.name;
+exports.DOC_TYPE_IDCARD_V1 = idCardV1_1.IdCardV1.name;

package/src/fields/field.d.ts

@@ -25,6 +25,7 @@ export declare class BaseField {
      * @param {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
      */
     constructor({ prediction, valueKey, reconstructed, }: BaseFieldConstructor);
+    toString(): string;
 }
 export declare class Field extends BaseField {
     /**
@@ -69,5 +70,4 @@ export declare class Field extends BaseField {
      * @returns {Number} Sum of all the Fields values in the array
      */
     static arraySum(array: any): number;
-    toString(): string;
 }

package/src/fields/field.js

@@ -11,10 +11,19 @@ class BaseField {
     constructor({ prediction, valueKey = "value", reconstructed = false, }) {
         this.value = undefined;
         this.reconstructed = reconstructed;
-        if (valueKey in prediction && prediction[valueKey] !== null) {
+        if (prediction !== undefined &&
+            prediction !== null &&
+            valueKey in prediction &&
+            prediction[valueKey] !== null) {
             this.value = prediction[valueKey];
         }
     }
+    toString() {
+        if (this.value !== undefined) {
+            return `${this.value}`;
+        }
+        return "";
+    }
 }
 exports.BaseField = BaseField;
 class Field extends BaseField {
@@ -97,11 +106,5 @@ class Field extends BaseField {
         }
         return total;
     }
-    toString() {
-        if (this.value !== undefined) {
-            return `${this.value}`;
-        }
-        return "";
-    }
 }
 exports.Field = Field;

package/src/index.d.ts

@@ -1,3 +1,3 @@
-export { CustomV1, FinancialDocumentV1, InvoiceV3, PassportV1, ReceiptV3, ReceiptV4, CropperV1, } from "./documents";
+export { CustomV1, FinancialDocumentV1, InvoiceV3, PassportV1, ReceiptV3, ReceiptV4, CropperV1, IdCardV1, } 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.CropperV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PassportV1 = exports.InvoiceV3 = exports.FinancialDocumentV1 = exports.CustomV1 = void 0;
+exports.PageOptionsOperation = exports.Client = exports.IdCardV1 = 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,6 +9,7 @@ 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, "IdCardV1", { enumerable: true, get: function () { return documents_1.IdCardV1; } });
 var client_1 = require("./client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_1.Client; } });
 var inputs_1 = require("./inputs");

package/src/inputs/base.d.ts

@@ -8,6 +8,7 @@ export declare const INPUT_TYPE_BASE64 = "base64";
 export declare const INPUT_TYPE_BYTES = "bytes";
 export declare const INPUT_TYPE_PATH = "path";
 export declare const INPUT_TYPE_URL = "URL";
+export declare const INPUT_TYPE_BUFFER = "buffer";
 export declare class InputSource {
     inputType: string;
     filename: string;

package/src/inputs/base.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InputSource = exports.INPUT_TYPE_URL = exports.INPUT_TYPE_PATH = exports.INPUT_TYPE_BYTES = exports.INPUT_TYPE_BASE64 = exports.INPUT_TYPE_STREAM = void 0;
+exports.InputSource = exports.INPUT_TYPE_BUFFER = exports.INPUT_TYPE_URL = exports.INPUT_TYPE_PATH = exports.INPUT_TYPE_BYTES = exports.INPUT_TYPE_BASE64 = exports.INPUT_TYPE_STREAM = void 0;
 const fileType = __importStar(require("file-type"));
 const path = __importStar(require("path"));
 const pdf_1 = require("../pdf");
@@ -34,6 +34,7 @@ exports.INPUT_TYPE_BASE64 = "base64";
 exports.INPUT_TYPE_BYTES = "bytes";
 exports.INPUT_TYPE_PATH = "path";
 exports.INPUT_TYPE_URL = "URL";
+exports.INPUT_TYPE_BUFFER = "buffer";
 const MIMETYPES = new Map([
     [".pdf", "application/pdf"],
     [".heic", "image/heic"],
@@ -50,6 +51,7 @@ const ALLOWED_INPUT_TYPES = [
     exports.INPUT_TYPE_BYTES,
     exports.INPUT_TYPE_PATH,
     exports.INPUT_TYPE_URL,
+    exports.INPUT_TYPE_BUFFER,
 ];
 class InputSource {
     /**

package/src/inputs/index.d.ts

@@ -1,3 +1,3 @@
 export { PageOptions, PageOptionsOperation } from "./pageOptions";
-export { Base64Input, BytesInput, PathInput, StreamInput, UrlInput, } from "./sources";
-export { InputSource, INPUT_TYPE_BASE64, INPUT_TYPE_BYTES, INPUT_TYPE_PATH, INPUT_TYPE_STREAM, INPUT_TYPE_URL, } from "./base";
+export { Base64Input, BytesInput, PathInput, StreamInput, UrlInput, BufferInput, } from "./sources";
+export { InputSource, INPUT_TYPE_BASE64, INPUT_TYPE_BYTES, INPUT_TYPE_PATH, INPUT_TYPE_STREAM, INPUT_TYPE_URL, INPUT_TYPE_BUFFER, } from "./base";

package/src/inputs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.INPUT_TYPE_URL = exports.INPUT_TYPE_STREAM = exports.INPUT_TYPE_PATH = exports.INPUT_TYPE_BYTES = exports.INPUT_TYPE_BASE64 = exports.InputSource = exports.UrlInput = exports.StreamInput = exports.PathInput = exports.BytesInput = exports.Base64Input = exports.PageOptionsOperation = void 0;
+exports.INPUT_TYPE_BUFFER = exports.INPUT_TYPE_URL = exports.INPUT_TYPE_STREAM = exports.INPUT_TYPE_PATH = exports.INPUT_TYPE_BYTES = exports.INPUT_TYPE_BASE64 = exports.InputSource = exports.BufferInput = exports.UrlInput = exports.StreamInput = exports.PathInput = exports.BytesInput = exports.Base64Input = exports.PageOptionsOperation = void 0;
 var pageOptions_1 = require("./pageOptions");
 Object.defineProperty(exports, "PageOptionsOperation", { enumerable: true, get: function () { return pageOptions_1.PageOptionsOperation; } });
 var sources_1 = require("./sources");
@@ -9,6 +9,7 @@ Object.defineProperty(exports, "BytesInput", { enumerable: true, get: function (
 Object.defineProperty(exports, "PathInput", { enumerable: true, get: function () { return sources_1.PathInput; } });
 Object.defineProperty(exports, "StreamInput", { enumerable: true, get: function () { return sources_1.StreamInput; } });
 Object.defineProperty(exports, "UrlInput", { enumerable: true, get: function () { return sources_1.UrlInput; } });
+Object.defineProperty(exports, "BufferInput", { enumerable: true, get: function () { return sources_1.BufferInput; } });
 var base_1 = require("./base");
 Object.defineProperty(exports, "InputSource", { enumerable: true, get: function () { return base_1.InputSource; } });
 Object.defineProperty(exports, "INPUT_TYPE_BASE64", { enumerable: true, get: function () { return base_1.INPUT_TYPE_BASE64; } });
@@ -16,3 +17,4 @@ Object.defineProperty(exports, "INPUT_TYPE_BYTES", { enumerable: true, get: func
 Object.defineProperty(exports, "INPUT_TYPE_PATH", { enumerable: true, get: function () { return base_1.INPUT_TYPE_PATH; } });
 Object.defineProperty(exports, "INPUT_TYPE_STREAM", { enumerable: true, get: function () { return base_1.INPUT_TYPE_STREAM; } });
 Object.defineProperty(exports, "INPUT_TYPE_URL", { enumerable: true, get: function () { return base_1.INPUT_TYPE_URL; } });
+Object.defineProperty(exports, "INPUT_TYPE_BUFFER", { enumerable: true, get: function () { return base_1.INPUT_TYPE_BUFFER; } });

package/src/inputs/sources.d.ts

@@ -52,4 +52,12 @@ export declare class UrlInput extends InputSource {
     constructor({ url }: UrlInputProps);
     init(): Promise<void>;
 }
+interface BufferInputProps {
+    buffer: Buffer;
+    filename: string;
+}
+export declare class BufferInput extends InputSource {
+    constructor({ buffer, filename }: BufferInputProps);
+    init(): Promise<void>;
+}
 export {};

package/src/inputs/sources.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UrlInput = exports.BytesInput = exports.StreamInput = exports.Base64Input = exports.PathInput = void 0;
+exports.BufferInput = exports.UrlInput = exports.BytesInput = exports.StreamInput = exports.Base64Input = exports.PathInput = void 0;
 const fs_1 = require("fs");
 const path = __importStar(require("path"));
 const handler_1 = require("../errors/handler");
@@ -115,7 +115,19 @@ class UrlInput extends base_1.InputSource {
             handler_1.errorHandler.throw(new Error("URL must be HTTPS"));
         }
         this.fileObject = this.url;
-        this.filename = "hello.jpg";
     }
 }
 exports.UrlInput = UrlInput;
+class BufferInput extends base_1.InputSource {
+    constructor({ buffer, filename }) {
+        super({
+            inputType: base_1.INPUT_TYPE_BUFFER,
+        });
+        this.fileObject = buffer;
+        this.filename = filename;
+    }
+    async init() {
+        this.mimeType = await this.checkMimetype();
+    }
+}
+exports.BufferInput = BufferInput;