mindee 4.4.0 → 4.5.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## v4.5.0 - 2023-11-29
+### Changes
+* :sparkles: add Multi-Receipts auto-extraction feature
+* :art: add example file to illustrate multi-receipt image extraction feature
+* :recycle: add new imageOperations namespace
+* :recycle: fix loose typing issues for inputsources
+
+
 ## v4.4.0 - 2023-11-17
 ### Changes
 * :sparkles: add support for Carte Grise V1

package/package.json

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

package/src/client.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
 import { Readable } from "stream";
-import { InputSource, PageOptions } from "./input";
+import { Base64Input, BytesInput, InputSource, PathInput, StreamInput, PageOptions, UrlInput, BufferInput } from "./input";
 import { Endpoint } from "./http";
 import { AsyncPredictResponse, FeedbackResponse, Inference, PredictResponse, StringDict } from "./parsing/common";
 /**
@@ -160,34 +160,34 @@ export declare class Client {
      * Load an input document from a local path.
      * @param inputPath
      */
-    docFromPath(inputPath: string): InputSource;
+    docFromPath(inputPath: string): PathInput;
     /**
      * Load an input document from a base64 encoded string.
      * @param inputString input content, as a string.
      * @param filename file name.
      */
-    docFromBase64(inputString: string, filename: string): InputSource;
+    docFromBase64(inputString: string, filename: string): Base64Input;
     /**
      * Load an input document from a `stream.Readable` object.
      * @param inputStream input content, as a readable stream.
      * @param filename file name.
      */
-    docFromStream(inputStream: Readable, filename: string): InputSource;
+    docFromStream(inputStream: Readable, filename: string): StreamInput;
     /**
      * Load an input document from a bytes string.
      * @param inputBytes input content, as readable bytes.
      * @param filename file name.
      */
-    docFromBytes(inputBytes: string, filename: string): InputSource;
+    docFromBytes(inputBytes: string, filename: string): BytesInput;
     /**
      * Load an input document from a URL.
      * @param url input url. Must be HTTPS.
      */
-    docFromUrl(url: string): InputSource;
+    docFromUrl(url: string): UrlInput;
     /**
      * Load an input document from a Buffer.
      * @param buffer input content, as a buffer.
      * @param filename file name.
      */
-    docFromBuffer(buffer: Buffer, filename: string): InputSource;
+    docFromBuffer(buffer: Buffer, filename: string): BufferInput;
 }

package/src/errors/MindeeError.d.ts

@@ -1,3 +1,6 @@
 export declare class MindeeError extends Error {
     constructor(message: string);
 }
+export declare class MindeeMimeTypeError extends MindeeError {
+    constructor(message: string);
+}

package/src/errors/MindeeError.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MindeeError = void 0;
+exports.MindeeMimeTypeError = exports.MindeeError = void 0;
 class MindeeError extends Error {
     constructor(message) {
         super(message);
@@ -8,3 +8,10 @@ class MindeeError extends Error {
     }
 }
 exports.MindeeError = MindeeError;
+class MindeeMimeTypeError extends MindeeError {
+    constructor(message) {
+        super(message);
+        this.name = "MindeeMimeTypeError";
+    }
+}
+exports.MindeeMimeTypeError = MindeeMimeTypeError;

package/src/errors/index.d.ts

@@ -1 +1 @@
-export { MindeeError } from "./MindeeError";
+export { MindeeError, MindeeMimeTypeError } from "./MindeeError";

package/src/errors/index.js

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

package/src/imageOperations/extractedImage.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import { Buffer } from "node:buffer";
+import { BufferInput } from "../input/sources";
+export interface ExtractedImage {
+    readonly pageId: number;
+    imageData: Buffer;
+    asSource(): BufferInput;
+}

package/src/imageOperations/extractedImage.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/imageOperations/extractedMultiReceiptImage.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="node" />
+import { BufferInput } from "../input";
+import { ExtractedImage } from "./extractedImage";
+export declare class ExtractedMultiReceiptImage implements ExtractedImage {
+    readonly receiptId: number;
+    readonly pageId: number;
+    imageData: Buffer;
+    constructor(imageData: Uint8Array, pageId: number, receiptId: number);
+    asSource(): BufferInput;
+}

package/src/imageOperations/extractedMultiReceiptImage.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtractedMultiReceiptImage = void 0;
+const input_1 = require("../input");
+class ExtractedMultiReceiptImage {
+    constructor(imageData, pageId, receiptId) {
+        this.pageId = pageId;
+        this.imageData = Buffer.from(imageData);
+        this.receiptId = receiptId;
+    }
+    asSource() {
+        return new input_1.BufferInput({
+            buffer: this.imageData,
+            filename: `receipt_p${this.pageId}_${this.receiptId}.pdf`,
+        });
+    }
+}
+exports.ExtractedMultiReceiptImage = ExtractedMultiReceiptImage;

package/src/imageOperations/index.d.ts

@@ -0,0 +1,2 @@
+export { extractReceipts } from "./multiReceiptsExtractor";
+export { ExtractedMultiReceiptImage } from "./extractedMultiReceiptImage";

package/src/imageOperations/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtractedMultiReceiptImage = exports.extractReceipts = void 0;
+var multiReceiptsExtractor_1 = require("./multiReceiptsExtractor");
+Object.defineProperty(exports, "extractReceipts", { enumerable: true, get: function () { return multiReceiptsExtractor_1.extractReceipts; } });
+var extractedMultiReceiptImage_1 = require("./extractedMultiReceiptImage");
+Object.defineProperty(exports, "ExtractedMultiReceiptImage", { enumerable: true, get: function () { return extractedMultiReceiptImage_1.ExtractedMultiReceiptImage; } });

package/src/imageOperations/internal.d.ts

@@ -0,0 +1,3 @@
+export { extractReceipts } from "./multiReceiptsExtractor";
+export { ExtractedMultiReceiptImage } from "./extractedMultiReceiptImage";
+export { ExtractedImage } from "./extractedImage";

package/src/imageOperations/internal.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtractedMultiReceiptImage = exports.extractReceipts = void 0;
+var multiReceiptsExtractor_1 = require("./multiReceiptsExtractor");
+Object.defineProperty(exports, "extractReceipts", { enumerable: true, get: function () { return multiReceiptsExtractor_1.extractReceipts; } });
+var extractedMultiReceiptImage_1 = require("./extractedMultiReceiptImage");
+Object.defineProperty(exports, "ExtractedMultiReceiptImage", { enumerable: true, get: function () { return extractedMultiReceiptImage_1.ExtractedMultiReceiptImage; } });

package/src/imageOperations/multiReceiptsExtractor.d.ts

@@ -0,0 +1,4 @@
+import { MultiReceiptsDetectorV1 } from "../product";
+import { ExtractedMultiReceiptImage } from "./extractedMultiReceiptImage";
+import { LocalInputSource } from "../input/base";
+export declare function extractReceipts(inputFile: LocalInputSource, inference: MultiReceiptsDetectorV1): Promise<ExtractedMultiReceiptImage[]>;

package/src/imageOperations/multiReceiptsExtractor.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractReceipts = void 0;
+const pdf_lib_1 = require("pdf-lib");
+const errors_1 = require("../errors");
+const geometry_1 = require("../geometry");
+const extractedMultiReceiptImage_1 = require("./extractedMultiReceiptImage");
+async function addPage(pdfPage, boundingBox, pageId, receiptId) {
+    const { width, height } = pdfPage.getSize();
+    const receiptPdf = await pdf_lib_1.PDFDocument.create();
+    const newWidth = width * ((0, geometry_1.getMinMaxX)(boundingBox).max - (0, geometry_1.getMinMaxX)(boundingBox).min);
+    const newHeight = height * ((0, geometry_1.getMinMaxY)(boundingBox).max - (0, geometry_1.getMinMaxY)(boundingBox).min);
+    //Note: PDF-lib seems to invert y coordinates, giving us the following horror:
+    const croppedReceipt = await receiptPdf.embedPage(pdfPage, {
+        left: (0, geometry_1.getMinMaxX)(boundingBox).min * width,
+        right: (0, geometry_1.getMinMaxX)(boundingBox).max * width,
+        top: height - ((0, geometry_1.getMinMaxY)(boundingBox).min * height),
+        bottom: height - ((0, geometry_1.getMinMaxY)(boundingBox).max * height),
+    });
+    const receiptPage = receiptPdf.addPage([newWidth, newHeight]);
+    receiptPage.drawPage(croppedReceipt, {
+        width: newWidth,
+        height: newHeight,
+    });
+    const receiptBytes = await receiptPdf.save();
+    return new extractedMultiReceiptImage_1.ExtractedMultiReceiptImage(receiptBytes, pageId, receiptId);
+}
+async function loadPdfDoc(inputFile) {
+    let pdfDoc;
+    if (!["image/jpeg", "image/jpg", "image/png", "application/pdf"].includes(inputFile.mimeType)) {
+        throw new errors_1.MindeeMimeTypeError(`Unsupported file type "${inputFile.mimeType}" Currently supported types are .png, .jpg and .pdf`);
+    }
+    else if (inputFile.isPdf()) {
+        pdfDoc = await pdf_lib_1.PDFDocument.load(inputFile.fileObject);
+    }
+    else {
+        pdfDoc = await pdf_lib_1.PDFDocument.create();
+        let image;
+        if (inputFile.mimeType === "image/png") {
+            image = await pdfDoc.embedPng(inputFile.fileObject);
+        }
+        else {
+            image = await pdfDoc.embedJpg(inputFile.fileObject);
+        }
+        const imageDims = image.scale(1);
+        const pageImage = pdfDoc.addPage([imageDims.width, imageDims.height]);
+        pageImage.drawImage(image);
+    }
+    return pdfDoc;
+}
+async function extractReceipts(inputFile, inference) {
+    const images = [];
+    if (!inference.prediction.receipts) {
+        throw new errors_1.MindeeError("No possible receipts candidates found for MultiReceipts extraction.");
+    }
+    const pdfDoc = await loadPdfDoc(inputFile);
+    for (let pageId = 0; pageId < pdfDoc.getPageCount(); pageId++) {
+        const [page] = await pdfDoc.copyPages(pdfDoc, [pageId]);
+        for (let receiptId = 0; receiptId < inference.pages[pageId].prediction.receipts.length; receiptId++) {
+            const receipt = inference.pages[pageId].prediction.receipts[receiptId];
+            images.push(await addPage(page, receipt.boundingBox, pageId, receiptId));
+        }
+    }
+    return images;
+}
+exports.extractReceipts = extractReceipts;

package/src/index.d.ts

@@ -3,3 +3,4 @@ export { Client, PredictOptions } from "./client";
 export { AsyncPredictResponse, PredictResponse, Document, Page, } from "./parsing/common";
 export { InputSource, PageOptionsOperation } from "./input";
 export * as internal from "./internal";
+export * as imageOperations from "./imageOperations";

package/src/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.internal = exports.PageOptionsOperation = exports.InputSource = exports.Page = exports.Document = exports.PredictResponse = exports.AsyncPredictResponse = exports.Client = exports.product = void 0;
+exports.imageOperations = exports.internal = exports.PageOptionsOperation = exports.InputSource = exports.Page = exports.Document = exports.PredictResponse = exports.AsyncPredictResponse = exports.Client = exports.product = void 0;
 exports.product = __importStar(require("./product"));
 var client_1 = require("./client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_1.Client; } });
@@ -36,3 +36,4 @@ var input_1 = require("./input");
 Object.defineProperty(exports, "InputSource", { enumerable: true, get: function () { return input_1.InputSource; } });
 Object.defineProperty(exports, "PageOptionsOperation", { enumerable: true, get: function () { return input_1.PageOptionsOperation; } });
 exports.internal = __importStar(require("./internal"));
+exports.imageOperations = __importStar(require("./imageOperations"));