mindee 4.19.0 → 4.21.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # CHANGELOG
 
+## v4.21.0 - 2024-12-13
+### Changes
+* :sparkles: allow local downloading of remote sources
+* :coffin: remove support for (FR) Carte Vitale V1 in favor of French Health Card V1
+### Fixes
+* :bug: fix broken loading from bytes
+
+
+## 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/README.md

@@ -35,26 +35,40 @@ const apiResponse = mindeeClient.parse(mindee.product.InvoiceV4, inputSource);
 
 **Note:** Files can also be loaded from:
 
-A URL (`https` only): 
+A base64 encoded string:
 ```js
-const inputSource = mindeeClient.docFromUrl("https://my-url");
+const inputSource = mindeeClient.docFromBase64(myInputString, "my-file-name.ext")
 ```
 
-A base64 encoded string:
+A byte sequence:
 ```js
-const inputSource = mindeeClient.docFromBase64(myInputString, "my-file-name")
+const inputSource = mindeeClient.docFromBytes(myInputBytes, "my-file-name.ext")
 ```
 
 A stream:
 ```js
-const inputSource = mindeeClient.docFromStream(myReadableStream, "my-file-name")
+const inputSource = mindeeClient.docFromStream(myReadableStream, "my-file-name.ext")
 ```
 
 A buffer:
 ```js
-const inputSource = mindeeClient.docFromBuffer(myBuffer, "my-file-name")
+const inputSource = mindeeClient.docFromBuffer(myBuffer, "my-file-name.ext")
+```
+
+A URL (`https` only):
+```js
+const inputSource = mindeeClient.docFromUrl("https://my-url");
+```
+
+You can also load the document locally before sending it:
+```js
+const inputSource = mindeeClient.docFromUrl("https://my-url");
+await inputSource.init();
+const localInputSource = inputSource.asLocalInputSource();
 ```
 
+**Note:** Files hidden behind redirections are rejected by the server; this solution helps to circumvent that issue.
+
 #### Region-Specific Documents
 
 Region-Specific Documents use the following syntax:
@@ -72,7 +86,7 @@ const inputSource = mindeeClient.docFromPath("/path/to/the/file.ext");
 const apiResponse = mindeeClient.parse(mindee.product.fr.IdCardV1, inputSource);
 ```
 
-#### Custom Documents (API Builder)
+#### Custom Documents (docTI & Custom APIs)
 
 Custom documents will require you to provide their endpoint manually.
 
@@ -97,9 +111,9 @@ const customEndpoint = mindeeClient.createEndpoint(
 );
 
 // Parse it
-const apiResponse = mindeeClient
-  .parse(
-    mindee.product.CustomV1,
+const apiResponse = await mindeeClient
+  .enqueueAndParse(
+    mindee.product.GeneratedV1,
     inputSource,
     {
       endpoint: customEndpoint
@@ -156,7 +170,7 @@ Complete details on the working of the library are available in the following gu
 * [Node.js EU License Plate OCR](https://developers.mindee.com/docs/nodejs-eu-license-plate-ocr)
 * [Node.js EU Driver License OCR](https://developers.mindee.com/docs/nodejs-eu-driver-license-ocr)
 * [Node.js FR Bank Account Detail OCR](https://developers.mindee.com/docs/nodejs-fr-bank-account-details-ocr)
-* [Node.js FR Carte Vitale OCR](https://developers.mindee.com/docs/nodejs-fr-carte-vitale-ocr)
+* [Node.js FR Health Card OCR](https://developers.mindee.com/docs/nodejs-fr-health-card-ocr)
 * [Node.js FR ID Card OCR](https://developers.mindee.com/docs/nodejs-fr-carte-nationale-didentite-ocr)
 * [Node.js US Bank Check OCR](https://developers.mindee.com/docs/nodejs-us-bank-check-ocr)
 * [Node.js US W9 OCR](https://developers.mindee.com/docs/nodejs-us-w9-ocr)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "4.19.0",
+    "version": "4.21.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/client.d.ts

@@ -221,11 +221,11 @@ export declare class Client {
      */
     docFromStream(inputStream: Readable, filename: string): StreamInput;
     /**
-     * Load an input document from a bytes string.
-     * @param inputBytes input content, as readable bytes.
+     * Load an input document from bytes.
+     * @param inputBytes input content, as a Uint8Array or Buffer.
      * @param filename file name.
      */
-    docFromBytes(inputBytes: string, filename: string): BytesInput;
+    docFromBytes(inputBytes: Uint8Array, filename: string): BytesInput;
     /**
      * Load an input document from a URL.
      * @param url input url. Must be HTTPS.

package/src/client.js

@@ -300,8 +300,8 @@ Job status: ${pollResults.job.status}.`);
         });
     }
     /**
-     * Load an input document from a bytes string.
-     * @param inputBytes input content, as readable bytes.
+     * Load an input document from bytes.
+     * @param inputBytes input content, as a Uint8Array or Buffer.
      * @param filename file name.
      */
     docFromBytes(inputBytes, filename) {

package/src/http/baseEndpoint.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseEndpoint = void 0;
 const logger_1 = require("../logger");
 const https_1 = require("https");
-const base_1 = require("../input/base");
+const input_1 = require("../input");
 /**
  * Base endpoint for the Mindee API.
  */
@@ -18,7 +18,7 @@ class BaseEndpoint {
      * @param pageOptions page cutting options.
      */
     async cutDocPages(inputDoc, pageOptions) {
-        if (inputDoc instanceof base_1.LocalInputSource && inputDoc.isPdf()) {
+        if (inputDoc instanceof input_1.LocalInputSource && inputDoc.isPdf()) {
             await inputDoc.cutPdf(pageOptions);
         }
     }

package/src/http/endpoint.js

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Endpoint = void 0;
 const url_1 = require("url");
 const form_data_1 = __importDefault(require("form-data"));
-const base_1 = require("../input/base");
+const input_1 = require("../input");
 const error_1 = require("./error");
 const baseEndpoint_1 = require("./baseEndpoint");
 const responseValidation_1 = require("./responseValidation");
@@ -140,7 +140,7 @@ class Endpoint extends baseEndpoint_1.BaseEndpoint {
                 searchParams.append("full_text_ocr", "true");
             }
             const form = new form_data_1.default();
-            if (input instanceof base_1.LocalInputSource && input.fileObject instanceof Buffer) {
+            if (input instanceof input_1.LocalInputSource && input.fileObject instanceof Buffer) {
                 form.append("document", input.fileObject, {
                     filename: input.filename,
                 });

package/src/http/workflowEndpoint.js

@@ -13,7 +13,7 @@ exports.WorkflowEndpoint = void 0;
 const baseEndpoint_1 = require("./baseEndpoint");
 const url_1 = require("url");
 const form_data_1 = __importDefault(require("form-data"));
-const base_1 = require("../input/base");
+const input_1 = require("../input");
 const responseValidation_1 = require("./responseValidation");
 const error_1 = require("./error");
 /**
@@ -57,7 +57,7 @@ class WorkflowEndpoint extends baseEndpoint_1.BaseEndpoint {
                 searchParams.append("full_text_ocr", "true");
             }
             const form = new form_data_1.default();
-            if (input instanceof base_1.LocalInputSource && input.fileObject instanceof Buffer) {
+            if (input instanceof input_1.LocalInputSource && input.fileObject instanceof Buffer) {
                 form.append("document", input.fileObject, {
                     filename: input.filename,
                 });

package/src/imageOperations/invoiceSplitterExtractor/invoiceSplitterExtractor.d.ts

@@ -1,5 +1,5 @@
 import { InvoiceSplitterV1 } from "../../product";
-import { LocalInputSource } from "../../input/base";
+import { LocalInputSource } from "../../input";
 import { ExtractedInvoiceSplitterImage } from "./extractedInvoiceSplitterImage";
 /**
  * Extracts & cuts the pages of a main document invoice according to the provided indexes.

package/src/imageOperations/multiReceiptsExtractor/multiReceiptsExtractor.d.ts

@@ -1,6 +1,6 @@
 import { MultiReceiptsDetectorV1 } from "../../product";
 import { ExtractedMultiReceiptImage } from "./extractedMultiReceiptImage";
-import { LocalInputSource } from "../../input/base";
+import { LocalInputSource } from "../../input";
 /**
  * Extracts individual receipts from multi-receipts documents.
  *

package/src/input/index.d.ts

@@ -1,4 +1,3 @@
 export { PageOptions, PageOptionsOperation } from "./pageOptions";
-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_BUFFER, } from "./base";
+export * from "./sources";
 export { LocalResponse } from "./localResponse";

package/src/input/index.js

@@ -1,21 +1,22 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LocalResponse = exports.INPUT_TYPE_BUFFER = 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;
+exports.LocalResponse = 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");
-Object.defineProperty(exports, "Base64Input", { enumerable: true, get: function () { return sources_1.Base64Input; } });
-Object.defineProperty(exports, "BytesInput", { enumerable: true, get: function () { return sources_1.BytesInput; } });
-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; } });
-Object.defineProperty(exports, "INPUT_TYPE_BYTES", { enumerable: true, get: function () { return base_1.INPUT_TYPE_BYTES; } });
-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_BUFFER", { enumerable: true, get: function () { return base_1.INPUT_TYPE_BUFFER; } });
+__exportStar(require("./sources"), exports);
 var localResponse_1 = require("./localResponse");
 Object.defineProperty(exports, "LocalResponse", { enumerable: true, get: function () { return localResponse_1.LocalResponse; } });

package/src/input/sources/base64Input.d.ts

@@ -0,0 +1,12 @@
+import { LocalInputSource } from "./localInputSource";
+interface Base64InputProps {
+    inputString: string;
+    filename: string;
+}
+export declare class Base64Input extends LocalInputSource {
+    private inputString;
+    fileObject: Buffer;
+    constructor({ inputString, filename }: Base64InputProps);
+    init(): Promise<void>;
+}
+export {};

package/src/input/sources/base64Input.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Base64Input = void 0;
+const localInputSource_1 = require("./localInputSource");
+const inputSource_1 = require("./inputSource");
+class Base64Input extends localInputSource_1.LocalInputSource {
+    constructor({ inputString, filename }) {
+        super({
+            inputType: inputSource_1.INPUT_TYPE_BASE64,
+        });
+        this.fileObject = Buffer.alloc(0);
+        this.filename = filename;
+        this.inputString = inputString;
+    }
+    async init() {
+        this.fileObject = Buffer.from(this.inputString, "base64");
+        this.mimeType = await this.checkMimetype();
+        // clear out the string
+        this.inputString = "";
+    }
+}
+exports.Base64Input = Base64Input;

package/src/input/sources/bufferInput.d.ts

@@ -0,0 +1,10 @@
+import { LocalInputSource } from "./localInputSource";
+interface BufferInputProps {
+    buffer: Buffer;
+    filename: string;
+}
+export declare class BufferInput extends LocalInputSource {
+    constructor({ buffer, filename }: BufferInputProps);
+    init(): Promise<void>;
+}
+export {};

package/src/input/sources/bufferInput.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BufferInput = void 0;
+const localInputSource_1 = require("./localInputSource");
+const inputSource_1 = require("./inputSource");
+class BufferInput extends localInputSource_1.LocalInputSource {
+    constructor({ buffer, filename }) {
+        super({
+            inputType: inputSource_1.INPUT_TYPE_BUFFER,
+        });
+        this.fileObject = buffer;
+        this.filename = filename;
+    }
+    async init() {
+        this.mimeType = await this.checkMimetype();
+    }
+}
+exports.BufferInput = BufferInput;

package/src/input/sources/bytesInput.d.ts

@@ -0,0 +1,12 @@
+import { LocalInputSource } from "./localInputSource";
+interface BytesInputProps {
+    inputBytes: Uint8Array;
+    filename: string;
+}
+export declare class BytesInput extends LocalInputSource {
+    private inputBytes;
+    fileObject: Buffer;
+    constructor({ inputBytes, filename }: BytesInputProps);
+    init(): Promise<void>;
+}
+export {};

package/src/input/sources/bytesInput.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BytesInput = void 0;
+const inputSource_1 = require("./inputSource");
+const localInputSource_1 = require("./localInputSource");
+class BytesInput extends localInputSource_1.LocalInputSource {
+    constructor({ inputBytes, filename }) {
+        super({
+            inputType: inputSource_1.INPUT_TYPE_BYTES,
+        });
+        this.fileObject = Buffer.alloc(0);
+        this.filename = filename;
+        this.inputBytes = inputBytes;
+    }
+    async init() {
+        this.fileObject = Buffer.from(this.inputBytes);
+        this.mimeType = await this.checkMimetype();
+        this.inputBytes = new Uint8Array(0);
+    }
+}
+exports.BytesInput = BytesInput;

package/src/input/sources/index.d.ts

@@ -0,0 +1,8 @@
+export { Base64Input } from "./base64Input";
+export { BufferInput } from "./bufferInput";
+export { BytesInput } from "./bytesInput";
+export { InputSource, INPUT_TYPE_PATH, INPUT_TYPE_STREAM, InputConstructor, INPUT_TYPE_BUFFER, INPUT_TYPE_BASE64, INPUT_TYPE_BYTES } from "./inputSource";
+export { LocalInputSource } from "./localInputSource";
+export { PathInput } from "./pathInput";
+export { StreamInput } from "./streamInput";
+export { UrlInput } from "./urlInput";

package/src/input/sources/index.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UrlInput = exports.StreamInput = exports.PathInput = exports.LocalInputSource = exports.INPUT_TYPE_BYTES = exports.INPUT_TYPE_BASE64 = exports.INPUT_TYPE_BUFFER = exports.INPUT_TYPE_STREAM = exports.INPUT_TYPE_PATH = exports.InputSource = exports.BytesInput = exports.BufferInput = exports.Base64Input = void 0;
+var base64Input_1 = require("./base64Input");
+Object.defineProperty(exports, "Base64Input", { enumerable: true, get: function () { return base64Input_1.Base64Input; } });
+var bufferInput_1 = require("./bufferInput");
+Object.defineProperty(exports, "BufferInput", { enumerable: true, get: function () { return bufferInput_1.BufferInput; } });
+var bytesInput_1 = require("./bytesInput");
+Object.defineProperty(exports, "BytesInput", { enumerable: true, get: function () { return bytesInput_1.BytesInput; } });
+var inputSource_1 = require("./inputSource");
+Object.defineProperty(exports, "InputSource", { enumerable: true, get: function () { return inputSource_1.InputSource; } });
+Object.defineProperty(exports, "INPUT_TYPE_PATH", { enumerable: true, get: function () { return inputSource_1.INPUT_TYPE_PATH; } });
+Object.defineProperty(exports, "INPUT_TYPE_STREAM", { enumerable: true, get: function () { return inputSource_1.INPUT_TYPE_STREAM; } });
+Object.defineProperty(exports, "INPUT_TYPE_BUFFER", { enumerable: true, get: function () { return inputSource_1.INPUT_TYPE_BUFFER; } });
+Object.defineProperty(exports, "INPUT_TYPE_BASE64", { enumerable: true, get: function () { return inputSource_1.INPUT_TYPE_BASE64; } });
+Object.defineProperty(exports, "INPUT_TYPE_BYTES", { enumerable: true, get: function () { return inputSource_1.INPUT_TYPE_BYTES; } });
+var localInputSource_1 = require("./localInputSource");
+Object.defineProperty(exports, "LocalInputSource", { enumerable: true, get: function () { return localInputSource_1.LocalInputSource; } });
+var pathInput_1 = require("./pathInput");
+Object.defineProperty(exports, "PathInput", { enumerable: true, get: function () { return pathInput_1.PathInput; } });
+var streamInput_1 = require("./streamInput");
+Object.defineProperty(exports, "StreamInput", { enumerable: true, get: function () { return streamInput_1.StreamInput; } });
+var urlInput_1 = require("./urlInput");
+Object.defineProperty(exports, "UrlInput", { enumerable: true, get: function () { return urlInput_1.UrlInput; } });

package/src/input/sources/inputSource.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @param {string} inputType - the type of input used in file ("base64", "path", "dummy").
+ *                             NB: dummy is only used for tests purposes
+ */
+export interface InputConstructor {
+    inputType: string;
+}
+export declare const INPUT_TYPE_STREAM = "stream";
+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_BUFFER = "buffer";
+export declare abstract class InputSource {
+    fileObject: Buffer | string;
+    init(): Promise<void>;
+}

package/src/input/sources/inputSource.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InputSource = exports.INPUT_TYPE_BUFFER = exports.INPUT_TYPE_PATH = exports.INPUT_TYPE_BYTES = exports.INPUT_TYPE_BASE64 = exports.INPUT_TYPE_STREAM = void 0;
+exports.INPUT_TYPE_STREAM = "stream";
+exports.INPUT_TYPE_BASE64 = "base64";
+exports.INPUT_TYPE_BYTES = "bytes";
+exports.INPUT_TYPE_PATH = "path";
+exports.INPUT_TYPE_BUFFER = "buffer";
+class InputSource {
+    constructor() {
+        this.fileObject = "";
+    }
+    async init() {
+        throw new Error("not Implemented");
+    }
+}
+exports.InputSource = InputSource;

package/src/input/sources/localInputSource.d.ts

@@ -0,0 +1,20 @@
+import { PageOptions } from "../pageOptions";
+import { InputSource, InputConstructor } from "./inputSource";
+export declare abstract class LocalInputSource extends InputSource {
+    inputType: string;
+    filename: string;
+    filepath?: string;
+    mimeType: string;
+    fileObject: Buffer | string;
+    /**
+     * @param {InputConstructor} constructor Constructor parameters.
+     */
+    protected constructor({ inputType }: InputConstructor);
+    isPdf(): boolean;
+    checkMimetype(): Promise<string>;
+    /**
+     * Cut PDF pages.
+     * @param pageOptions
+     */
+    cutPdf(pageOptions: PageOptions): Promise<void>;
+}

package/src/input/{base.js → sources/localInputSource.js}

@@ -22,18 +22,17 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LocalInputSource = exports.InputSource = exports.INPUT_TYPE_BUFFER = exports.INPUT_TYPE_PATH = exports.INPUT_TYPE_BYTES = exports.INPUT_TYPE_BASE64 = exports.INPUT_TYPE_STREAM = void 0;
+exports.LocalInputSource = void 0;
+const handler_1 = require("../../errors/handler");
+const logger_1 = require("../../logger");
+const path_1 = __importDefault(require("path"));
 const fileType = __importStar(require("file-type"));
-const path = __importStar(require("path"));
-const pdf_1 = require("../pdf");
-const logger_1 = require("../logger");
-const handler_1 = require("../errors/handler");
-exports.INPUT_TYPE_STREAM = "stream";
-exports.INPUT_TYPE_BASE64 = "base64";
-exports.INPUT_TYPE_BYTES = "bytes";
-exports.INPUT_TYPE_PATH = "path";
-exports.INPUT_TYPE_BUFFER = "buffer";
+const pdf_1 = require("../../pdf");
+const inputSource_1 = require("./inputSource");
 const MIMETYPES = new Map([
     [".pdf", "application/pdf"],
     [".heic", "image/heic"],
@@ -45,22 +44,13 @@ const MIMETYPES = new Map([
     [".webp", "image/webp"],
 ]);
 const ALLOWED_INPUT_TYPES = [
-    exports.INPUT_TYPE_STREAM,
-    exports.INPUT_TYPE_BASE64,
-    exports.INPUT_TYPE_BYTES,
-    exports.INPUT_TYPE_PATH,
-    exports.INPUT_TYPE_BUFFER,
+    inputSource_1.INPUT_TYPE_STREAM,
+    inputSource_1.INPUT_TYPE_BASE64,
+    inputSource_1.INPUT_TYPE_BYTES,
+    inputSource_1.INPUT_TYPE_PATH,
+    inputSource_1.INPUT_TYPE_BUFFER,
 ];
-class InputSource {
-    constructor() {
-        this.fileObject = "";
-    }
-    async init() {
-        throw new Error("not Implemented");
-    }
-}
-exports.InputSource = InputSource;
-class LocalInputSource extends InputSource {
+class LocalInputSource extends inputSource_1.InputSource {
     /**
      * @param {InputConstructor} constructor Constructor parameters.
      */
@@ -84,7 +74,7 @@ class LocalInputSource extends InputSource {
             throw new Error(`MIME type cannot be verified on input source of type ${this.inputType}.`);
         }
         let mimeType;
-        const fileExt = path.extname(this.filename);
+        const fileExt = path_1.default.extname(this.filename);
         if (fileExt) {
             mimeType = MIMETYPES.get(fileExt.toLowerCase()) || "";
         }

package/src/input/sources/pathInput.d.ts

@@ -0,0 +1,11 @@
+import { LocalInputSource } from "./localInputSource";
+interface PathInputProps {
+    inputPath: string;
+}
+export declare class PathInput extends LocalInputSource {
+    readonly inputPath: string;
+    fileObject: Buffer;
+    constructor({ inputPath }: PathInputProps);
+    init(): Promise<void>;
+}
+export {};

package/src/input/sources/pathInput.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathInput = void 0;
+const inputSource_1 = require("./inputSource");
+const localInputSource_1 = require("./localInputSource");
+const path_1 = __importDefault(require("path"));
+const logger_1 = require("../../logger");
+const fs_1 = require("fs");
+class PathInput extends localInputSource_1.LocalInputSource {
+    constructor({ inputPath }) {
+        super({
+            inputType: inputSource_1.INPUT_TYPE_PATH,
+        });
+        this.fileObject = Buffer.alloc(0);
+        this.inputPath = inputPath;
+        this.filename = path_1.default.basename(this.inputPath);
+    }
+    async init() {
+        logger_1.logger.debug(`Loading from: ${this.inputPath}`);
+        this.fileObject = Buffer.from(await fs_1.promises.readFile(this.inputPath));
+        this.mimeType = await this.checkMimetype();
+    }
+}
+exports.PathInput = PathInput;

package/src/input/sources/streamInput.d.ts

@@ -0,0 +1,14 @@
+import { Readable } from "stream";
+import { LocalInputSource } from "./localInputSource";
+interface StreamInputProps {
+    inputStream: Readable;
+    filename: string;
+}
+export declare class StreamInput extends LocalInputSource {
+    private readonly inputStream;
+    fileObject: Buffer;
+    constructor({ inputStream, filename }: StreamInputProps);
+    init(): Promise<void>;
+    stream2buffer(stream: Readable): Promise<Buffer>;
+}
+export {};