mindee 4.13.0 → 4.13.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v4.13.1 - 2024-06-10
+### Fixes
+* :recycle: refactored image extraction module to allow for more generic manipulations
+* :recycle: add tests for multipage receipts extraction
+
+
 ## v4.13.0 - 2024-05-28
 ### Changes
 * :sparkles: add support for local response loading

package/package.json

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

package/src/imageOperations/{extractedImage.d.ts → common/extractedImage.d.ts}

@@ -1,10 +1,13 @@
 /// <reference types="node" />
 import { Buffer } from "node:buffer";
-import { BufferInput } from "../input";
-export declare abstract class ExtractedImage {
+import { BufferInput } from "../../input";
+/**
+ * Generic class for image extraction
+ */
+export declare class ExtractedImage {
     buffer: Buffer;
     protected internalFileName: string;
-    constructor(buffer: Uint8Array, fileName: string);
+    protected constructor(buffer: Uint8Array, fileName: string);
     /**
      * Saves the document to a file.
      *

package/src/imageOperations/{extractedImage.js → common/extractedImage.js}

@@ -5,11 +5,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExtractedImage = void 0;
 const node_buffer_1 = require("node:buffer");
-const errors_1 = require("../errors");
+const errors_1 = require("../../errors");
 const node_fs_1 = require("node:fs");
 const node_path_1 = __importDefault(require("node:path"));
-const logger_1 = require("../logger");
-const input_1 = require("../input");
+const logger_1 = require("../../logger");
+const input_1 = require("../../input");
+/**
+ * Generic class for image extraction
+ */
 class ExtractedImage {
     constructor(buffer, fileName) {
         this.buffer = node_buffer_1.Buffer.from(buffer);

package/src/imageOperations/common/imageExtractor.d.ts

@@ -0,0 +1,9 @@
+import { PDFPage } from "pdf-lib";
+import { Polygon } from "../../geometry";
+/**
+ * Extracts elements from a page based off of a list of bounding boxes.
+ *
+ * @param pdfPage PDF Page to extract from.
+ * @param polygons List of coordinates to pull the elements from.
+ */
+export declare function extractFromPage(pdfPage: PDFPage, polygons: Polygon[]): Promise<Uint8Array[]>;

package/src/imageOperations/common/imageExtractor.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractFromPage = void 0;
+const pdf_lib_1 = require("pdf-lib");
+const geometry_1 = require("../../geometry");
+/**
+ * Extracts elements from a page based off of a list of bounding boxes.
+ *
+ * @param pdfPage PDF Page to extract from.
+ * @param polygons List of coordinates to pull the elements from.
+ */
+async function extractFromPage(pdfPage, polygons) {
+    const { width, height } = pdfPage.getSize();
+    const extractedElements = [];
+    for (const polygon of polygons) {
+        const tempPdf = await pdf_lib_1.PDFDocument.create();
+        const newWidth = width * ((0, geometry_1.getMinMaxX)(polygon).max - (0, geometry_1.getMinMaxX)(polygon).min);
+        const newHeight = height * ((0, geometry_1.getMinMaxY)(polygon).max - (0, geometry_1.getMinMaxY)(polygon).min);
+        const cropped = await tempPdf.embedPage(pdfPage, {
+            left: (0, geometry_1.getMinMaxX)(polygon).min * width,
+            right: (0, geometry_1.getMinMaxX)(polygon).max * width,
+            top: height - ((0, geometry_1.getMinMaxY)(polygon).min * height),
+            bottom: height - ((0, geometry_1.getMinMaxY)(polygon).max * height),
+        });
+        const samplePage = tempPdf.addPage([newWidth, newHeight]);
+        samplePage.drawPage(cropped, {
+            width: newWidth,
+            height: newHeight,
+        });
+        extractedElements.push(await tempPdf.save());
+    }
+    return extractedElements;
+}
+exports.extractFromPage = extractFromPage;

package/src/imageOperations/common/index.d.ts

@@ -0,0 +1,2 @@
+export { ExtractedImage } from "./extractedImage";
+export { extractFromPage } from "./imageExtractor";

package/src/imageOperations/common/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractFromPage = exports.ExtractedImage = void 0;
+var extractedImage_1 = require("./extractedImage");
+Object.defineProperty(exports, "ExtractedImage", { enumerable: true, get: function () { return extractedImage_1.ExtractedImage; } });
+var imageExtractor_1 = require("./imageExtractor");
+Object.defineProperty(exports, "extractFromPage", { enumerable: true, get: function () { return imageExtractor_1.extractFromPage; } });

package/src/imageOperations/index.d.ts

@@ -1,4 +1,2 @@
-export { extractReceipts } from "./multiReceiptsExtractor";
-export { extractInvoices } from "./invoiceSplitterExtractor";
-export { ExtractedMultiReceiptImage } from "./extractedMultiReceiptImage";
-export { ExtractedInvoiceSplitterImage } from "./extractedInvoiceSplitterDocument";
+export { extractReceipts, ExtractedMultiReceiptImage } from "./multiReceiptsExtractor";
+export { extractInvoices, ExtractedInvoiceSplitterImage } from "./invoiceSplitterExtractor";

package/src/imageOperations/index.js

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

package/src/imageOperations/internal.d.ts

@@ -1,5 +1,3 @@
-export { extractReceipts } from "./multiReceiptsExtractor";
-export { extractInvoices } from "./invoiceSplitterExtractor";
-export { ExtractedMultiReceiptImage } from "./extractedMultiReceiptImage";
-export { ExtractedInvoiceSplitterImage } from "./extractedInvoiceSplitterDocument";
-export { ExtractedImage } from "./extractedImage";
+export { extractReceipts, ExtractedMultiReceiptImage } from "./multiReceiptsExtractor";
+export { extractInvoices, ExtractedInvoiceSplitterImage } from "./invoiceSplitterExtractor";
+export { ExtractedImage } from "./common";

package/src/imageOperations/internal.js

@@ -1,13 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExtractedImage = exports.ExtractedInvoiceSplitterImage = exports.ExtractedMultiReceiptImage = exports.extractInvoices = exports.extractReceipts = void 0;
+exports.ExtractedImage = exports.ExtractedInvoiceSplitterImage = exports.extractInvoices = exports.ExtractedMultiReceiptImage = exports.extractReceipts = void 0;
 var multiReceiptsExtractor_1 = require("./multiReceiptsExtractor");
 Object.defineProperty(exports, "extractReceipts", { enumerable: true, get: function () { return multiReceiptsExtractor_1.extractReceipts; } });
+Object.defineProperty(exports, "ExtractedMultiReceiptImage", { enumerable: true, get: function () { return multiReceiptsExtractor_1.ExtractedMultiReceiptImage; } });
 var invoiceSplitterExtractor_1 = require("./invoiceSplitterExtractor");
 Object.defineProperty(exports, "extractInvoices", { enumerable: true, get: function () { return invoiceSplitterExtractor_1.extractInvoices; } });
-var extractedMultiReceiptImage_1 = require("./extractedMultiReceiptImage");
-Object.defineProperty(exports, "ExtractedMultiReceiptImage", { enumerable: true, get: function () { return extractedMultiReceiptImage_1.ExtractedMultiReceiptImage; } });
-var extractedInvoiceSplitterDocument_1 = require("./extractedInvoiceSplitterDocument");
-Object.defineProperty(exports, "ExtractedInvoiceSplitterImage", { enumerable: true, get: function () { return extractedInvoiceSplitterDocument_1.ExtractedInvoiceSplitterImage; } });
-var extractedImage_1 = require("./extractedImage");
-Object.defineProperty(exports, "ExtractedImage", { enumerable: true, get: function () { return extractedImage_1.ExtractedImage; } });
+Object.defineProperty(exports, "ExtractedInvoiceSplitterImage", { enumerable: true, get: function () { return invoiceSplitterExtractor_1.ExtractedInvoiceSplitterImage; } });
+var common_1 = require("./common");
+Object.defineProperty(exports, "ExtractedImage", { enumerable: true, get: function () { return common_1.ExtractedImage; } });

package/src/imageOperations/{extractedInvoiceSplitterDocument.d.ts → invoiceSplitterExtractor/extractedInvoiceSplitterImage.d.ts}

@@ -1,4 +1,7 @@
-import { ExtractedImage } from "./extractedImage";
+import { ExtractedImage } from "../common/extractedImage";
+/**
+ * Wrapper class for extracted invoice pages.
+ */
 export declare class ExtractedInvoiceSplitterImage extends ExtractedImage {
     readonly pageIdMin: number;
     readonly pageIdMax: number;

package/src/imageOperations/{extractedInvoiceSplitterDocument.js → invoiceSplitterExtractor/extractedInvoiceSplitterImage.js}

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExtractedInvoiceSplitterImage = void 0;
-const extractedImage_1 = require("./extractedImage");
+const extractedImage_1 = require("../common/extractedImage");
+/**
+ * Wrapper class for extracted invoice pages.
+ */
 class ExtractedInvoiceSplitterImage extends extractedImage_1.ExtractedImage {
     constructor(buffer, pageIndices) {
         super(buffer, `invoice_p_${pageIndices[0]}-${pageIndices[1]}.pdf`);

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

@@ -0,0 +1,2 @@
+export { extractInvoices } from "./invoiceSplitterExtractor";
+export { ExtractedInvoiceSplitterImage } from "./extractedInvoiceSplitterImage";

package/src/imageOperations/invoiceSplitterExtractor/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtractedInvoiceSplitterImage = exports.extractInvoices = void 0;
+var invoiceSplitterExtractor_1 = require("./invoiceSplitterExtractor");
+Object.defineProperty(exports, "extractInvoices", { enumerable: true, get: function () { return invoiceSplitterExtractor_1.extractInvoices; } });
+var extractedInvoiceSplitterImage_1 = require("./extractedInvoiceSplitterImage");
+Object.defineProperty(exports, "ExtractedInvoiceSplitterImage", { enumerable: true, get: function () { return extractedInvoiceSplitterImage_1.ExtractedInvoiceSplitterImage; } });

package/src/imageOperations/{invoiceSplitterExtractor.d.ts → invoiceSplitterExtractor/invoiceSplitterExtractor.d.ts}

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

package/src/imageOperations/{invoiceSplitterExtractor.js → invoiceSplitterExtractor/invoiceSplitterExtractor.js}

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractInvoices = void 0;
 const pdf_lib_1 = require("pdf-lib");
-const errors_1 = require("../errors");
-const product_1 = require("../product");
-const extractedInvoiceSplitterDocument_1 = require("./extractedInvoiceSplitterDocument");
+const errors_1 = require("../../errors");
+const product_1 = require("../../product");
+const extractedInvoiceSplitterImage_1 = require("./extractedInvoiceSplitterImage");
 async function splitPdf(pdfDoc, invoicePageGroups) {
     if (invoicePageGroups.length === 0) {
         return [];
@@ -21,7 +21,7 @@ async function splitPdf(pdfDoc, invoicePageGroups) {
             subdocument.addPage(page);
         });
         const subdocumentBytes = await subdocument.save();
-        generatedPdfs.push(new extractedInvoiceSplitterDocument_1.ExtractedInvoiceSplitterImage(subdocumentBytes, [invoicePageGroups[i][0], invoicePageGroups[i][invoicePageGroups[i].length - 1]]));
+        generatedPdfs.push(new extractedInvoiceSplitterImage_1.ExtractedInvoiceSplitterImage(subdocumentBytes, [invoicePageGroups[i][0], invoicePageGroups[i][invoicePageGroups[i].length - 1]]));
     }
     return generatedPdfs;
 }

package/src/imageOperations/{extractedMultiReceiptImage.d.ts → multiReceiptsExtractor/extractedMultiReceiptImage.d.ts}

@@ -1,4 +1,7 @@
-import { ExtractedImage } from "./extractedImage";
+import { ExtractedImage } from "../common";
+/**
+ * Wrapper class for extracted multiple-receipts images.
+ */
 export declare class ExtractedMultiReceiptImage extends ExtractedImage {
     readonly receiptId: number;
     readonly pageId: number;

package/src/imageOperations/{extractedMultiReceiptImage.js → multiReceiptsExtractor/extractedMultiReceiptImage.js}

@@ -1,8 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExtractedMultiReceiptImage = void 0;
-const extractedImage_1 = require("./extractedImage");
-class ExtractedMultiReceiptImage extends extractedImage_1.ExtractedImage {
+const common_1 = require("../common");
+/**
+ * Wrapper class for extracted multiple-receipts images.
+ */
+class ExtractedMultiReceiptImage extends common_1.ExtractedImage {
     constructor(buffer, pageId, receiptId) {
         super(buffer, `receipt_p${pageId}_${receiptId}.pdf`);
         this.pageId = pageId;

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

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

package/src/imageOperations/multiReceiptsExtractor/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/{multiReceiptsExtractor.d.ts → multiReceiptsExtractor/multiReceiptsExtractor.d.ts}

@@ -1,11 +1,11 @@
-import { MultiReceiptsDetectorV1 } from "../product";
+import { MultiReceiptsDetectorV1 } from "../../product";
 import { ExtractedMultiReceiptImage } from "./extractedMultiReceiptImage";
-import { LocalInputSource } from "../input/base";
+import { LocalInputSource } from "../../input/base";
 /**
  * Extracts individual receipts from multi-receipts documents.
  *
  * @param inputFile File to extract sub-receipts from.
  * @param inference Results of the inference.
- * @returns Individual extracted receipts as an array of ExtractedMultiReceiptsImage.
+ * @returns Individual extracted receipts as an array of ExtractedMultiReceiptImage.
  */
 export declare function extractReceipts(inputFile: LocalInputSource, inference: MultiReceiptsDetectorV1): Promise<ExtractedMultiReceiptImage[]>;

package/src/imageOperations/{multiReceiptsExtractor.js → multiReceiptsExtractor/multiReceiptsExtractor.js}

@@ -2,27 +2,25 @@
 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 errors_1 = require("../../errors");
 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);
-    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);
+const common_1 = require("../common");
+/**
+ * Given a page and a set of coordinates, extracts & assigns individual receipts to an ExtractedMultiReceiptImage
+ * object.
+ *
+ * @param pdfPage PDF Page to extract from.
+ * @param boundingBoxes A set of coordinates delimiting the position of each receipt.
+ * @param pageId Id of the page the receipt is extracted from. Caution: this starts at 0, unlike the numbering in PDF
+ * pages.
+ */
+async function extractReceiptsFromPage(pdfPage, boundingBoxes, pageId) {
+    const extractedReceiptsRaw = await (0, common_1.extractFromPage)(pdfPage, boundingBoxes);
+    const extractedReceipts = [];
+    for (let i = 0; i < extractedReceiptsRaw.length; i++) {
+        extractedReceipts.push(new extractedMultiReceiptImage_1.ExtractedMultiReceiptImage(extractedReceiptsRaw[i], pageId, i));
+    }
+    return extractedReceipts;
 }
 async function loadPdfDoc(inputFile) {
     let pdfDoc;
@@ -52,7 +50,7 @@ async function loadPdfDoc(inputFile) {
  *
  * @param inputFile File to extract sub-receipts from.
  * @param inference Results of the inference.
- * @returns Individual extracted receipts as an array of ExtractedMultiReceiptsImage.
+ * @returns Individual extracted receipts as an array of ExtractedMultiReceiptImage.
  */
 async function extractReceipts(inputFile, inference) {
     const images = [];
@@ -62,10 +60,9 @@ async function extractReceipts(inputFile, inference) {
     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));
-        }
+        const receiptPositions = inference.pages[pageId].prediction.receipts.map((receipt) => receipt.boundingBox);
+        const extractedReceipts = await extractReceiptsFromPage(page, receiptPositions, pageId);
+        images.push(...extractedReceipts);
     }
     return images;
 }