mindee 5.3.1 → 5.4.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Mindee Node.js API Library Changelog
 
+## v5.4.0 - 2026-06-22
+### Fixes
+* :bug: :boom: harmonize Crop and Split extraction (now ready for public use)
+
+
 ## v5.3.1 - 2026-06-11
 ### Fixes
 * :arrow_up: bump 'tmp' and 'file-type'

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "5.3.1",
+    "version": "5.4.0",
     "description": "Mindee Client Library for Node.js",
     "author": {
         "name": "Mindee",

package/src/image/extractedImages.d.ts

@@ -0,0 +1,4 @@
+import { ExtractedImage } from "../image/index.js";
+export declare class ExtractedImages extends Array<ExtractedImage> {
+    constructor(...items: ExtractedImage[]);
+}

package/src/image/extractedImages.js

@@ -0,0 +1,5 @@
+export class ExtractedImages extends Array {
+    constructor(...items) {
+        super(...items);
+    }
+}

package/src/image/index.d.ts

@@ -1,3 +1,4 @@
 export { compressImage } from "./imageCompressor.js";
 export { ExtractedImage } from "./extractedImage.js";
+export { ExtractedImages } from "./extractedImages.js";
 export { extractFromPage } from "./imageExtractor.js";

package/src/image/index.js

@@ -1,3 +1,4 @@
 export { compressImage } from "./imageCompressor.js";
 export { ExtractedImage } from "./extractedImage.js";
+export { ExtractedImages } from "./extractedImages.js";
 export { extractFromPage } from "./imageExtractor.js";

package/src/pdf/extractedPdfs.d.ts

@@ -0,0 +1,4 @@
+import { ExtractedPdf } from "../pdf/extractedPdf.js";
+export declare class ExtractedPdfs extends Array<ExtractedPdf> {
+    constructor(...items: ExtractedPdf[]);
+}

package/src/{v2/fileOperations/cropFiles.js → pdf/extractedPdfs.js}

@@ -1,4 +1,4 @@
-export class CropFiles extends Array {
+export class ExtractedPdfs extends Array {
     constructor(...items) {
         super(...items);
     }

package/src/pdf/index.d.ts

@@ -2,3 +2,5 @@ export { extractPages, countPages } from "./pdfOperation.js";
 export type { SplitPdf } from "./pdfOperation.js";
 export { compressPdf } from "./pdfCompressor.js";
 export { hasSourceText } from "./pdfUtils.js";
+export { ExtractedPdf } from "./extractedPdf.js";
+export { ExtractedPdfs } from "./extractedPdfs.js";

package/src/pdf/index.js

@@ -1,3 +1,5 @@
 export { extractPages, countPages } from "./pdfOperation.js";
 export { compressPdf } from "./pdfCompressor.js";
 export { hasSourceText } from "./pdfUtils.js";
+export { ExtractedPdf } from "./extractedPdf.js";
+export { ExtractedPdfs } from "./extractedPdfs.js";

package/src/v2/fileOperations/crop.d.ts

@@ -1,13 +1,13 @@
 import { LocalInputSource } from "../../input/index.js";
 import { CropItem } from "../../v2/product/crop/index.js";
-import { CropFiles } from "../../v2/fileOperations/cropFiles.js";
-import { ExtractedImage } from "../../image/index.js";
+import { ExtractedImage, ExtractedImages } from "../../image/index.js";
 /**
  * Extracts a single specified crop from a given input source.
  * @param inputSource Local input source.
  * @param crop Crop to extract.
+ * @param quality JPEG quality of extracted image.
  */
-export declare function extractSingleCrop(inputSource: LocalInputSource, crop: CropItem): Promise<ExtractedImage>;
+export declare function extractSingleCrop(inputSource: LocalInputSource, crop: CropItem, quality?: number): Promise<ExtractedImage>;
 /**
  * Extracts a list of crops from a document.
  * @param inputSource Local input source.
@@ -15,4 +15,4 @@ export declare function extractSingleCrop(inputSource: LocalInputSource, crop: C
  * @param quality JPEG quality of extracted images.
  * @return a list of extracted files, as a CropFiles object.
  */
-export declare function extractCrops(inputSource: LocalInputSource, crops: CropItem[], quality?: number): Promise<CropFiles>;
+export declare function extractMultipleCrops(inputSource: LocalInputSource, crops: CropItem[], quality?: number): Promise<ExtractedImages>;

package/src/v2/fileOperations/crop.js

@@ -1,14 +1,15 @@
 import { MindeeError } from "../../errors/index.js";
 import { extractImagesFromPolygon } from "../../image/imageExtractor.js";
-import { CropFiles } from "../../v2/fileOperations/cropFiles.js";
+import { ExtractedImages } from "../../image/index.js";
 import { logger } from "../../logger.js";
 /**
  * Extracts a single specified crop from a given input source.
  * @param inputSource Local input source.
  * @param crop Crop to extract.
+ * @param quality JPEG quality of extracted image.
  */
-export async function extractSingleCrop(inputSource, crop) {
-    return (await extractCrops(inputSource, [crop]))[0];
+export async function extractSingleCrop(inputSource, crop, quality) {
+    return (await extractMultipleCrops(inputSource, [crop], quality))[0];
 }
 /**
  * Extracts a list of crops from a document.
@@ -17,7 +18,7 @@ export async function extractSingleCrop(inputSource, crop) {
  * @param quality JPEG quality of extracted images.
  * @return a list of extracted files, as a CropFiles object.
  */
-export async function extractCrops(inputSource, crops, quality) {
+export async function extractMultipleCrops(inputSource, crops, quality) {
     if (crops.length === 0) {
         throw new MindeeError("No crop indexes provided.");
     }
@@ -32,5 +33,5 @@ export async function extractCrops(inputSource, crops, quality) {
         polygonsByPage.get(pageId).push(crop.location.polygon);
     }
     const extractedCrops = await extractImagesFromPolygon(inputSource, polygonsByPage, quality);
-    return new CropFiles(...extractedCrops);
+    return new ExtractedImages(...extractedCrops);
 }

package/src/v2/fileOperations/split.d.ts

@@ -1,11 +1,11 @@
 import { LocalInputSource } from "../../input/index.js";
-import { SplitFiles } from "../../v2/fileOperations/splitFiles.js";
+import { ExtractedPdfs } from "../../pdf/extractedPdfs.js";
 /**
  * Extracts a single specified split from a
  * @param inputSource
  * @param split
  */
-export declare function extractSingleSplit(inputSource: LocalInputSource, split: number[]): Promise<SplitFiles>;
+export declare function extractSingleSplit(inputSource: LocalInputSource, split: number[]): Promise<ExtractedPdfs>;
 /**
  * Extracts splits as complete PDFs from the document.
  * @param inputSource Local input source.
@@ -13,7 +13,7 @@ export declare function extractSingleSplit(inputSource: LocalInputSource, split:
  * @return a list of extracted files.
  * @throws MindeeError if no indexes are provided.
  */
-export declare function extractSplits(inputSource: LocalInputSource, splits: number[][]): Promise<SplitFiles>;
+export declare function extractMultipleSplits(inputSource: LocalInputSource, splits: number[][]): Promise<ExtractedPdfs>;
 /**
  * Expands a range of pages into a list of page indexes.
  * @param range start and end of the page range

package/src/v2/fileOperations/split.js

@@ -1,15 +1,15 @@
 import { MindeeError } from "../../errors/index.js";
 import { PdfExtractor } from "../../pdf/pdfExtractor.js";
-import { SplitFiles } from "../../v2/fileOperations/splitFiles.js";
 import { logger } from "../../logger.js";
 import { ExtractedPdf } from "../../pdf/extractedPdf.js";
+import { ExtractedPdfs } from "../../pdf/extractedPdfs.js";
 /**
  * Extracts a single specified split from a
  * @param inputSource
  * @param split
  */
 export async function extractSingleSplit(inputSource, split) {
-    return await extractSplits(inputSource, [split]);
+    return await extractMultipleSplits(inputSource, [split]);
 }
 /**
  * Extracts splits as complete PDFs from the document.
@@ -18,7 +18,7 @@ export async function extractSingleSplit(inputSource, split) {
  * @return a list of extracted files.
  * @throws MindeeError if no indexes are provided.
  */
-export async function extractSplits(inputSource, splits) {
+export async function extractMultipleSplits(inputSource, splits) {
     const pageGroups = splits.filter(e => e.length > 0);
     if (pageGroups.length === 0) {
         throw new MindeeError("No valid split indexes provided.");
@@ -28,14 +28,14 @@ export async function extractSplits(inputSource, splits) {
     const pdfExtractor = new PdfExtractor(inputSource);
     await pdfExtractor.init();
     if (splits.length === 0) {
-        return new SplitFiles();
+        return new ExtractedPdfs();
     }
     const pageCount = await pdfExtractor.getPageCount();
     if (splits.length === 1 && splits[0].at(-1) === pageCount - 1) {
-        return new SplitFiles(new ExtractedPdf(inputSource.fileObject, inputSource.filename, pageCount));
+        return new ExtractedPdfs(new ExtractedPdf(inputSource.fileObject, inputSource.filename, pageCount));
     }
     const subDocuments = await pdfExtractor.extractSubDocuments(pageGroups);
-    return new SplitFiles(...subDocuments);
+    return new ExtractedPdfs(...subDocuments);
 }
 /**
  * Expands a range of pages into a list of page indexes.

package/src/v2/product/crop/cropItem.d.ts

@@ -23,5 +23,5 @@ export declare class CropItem {
      * @param inputSource The input file to extract from.
      * @param quality Optional quality parameter for image extraction, default is undefined (full quality).
      */
-    extractFromFile(inputSource: LocalInputSource, quality?: number): Promise<ExtractedImage>;
+    extractFromInputSource(inputSource: LocalInputSource, quality?: number): Promise<ExtractedImage>;
 }

package/src/v2/product/crop/cropItem.js

@@ -1,5 +1,5 @@
 import { FieldLocation } from "../../../v2/parsing/inference/field/index.js";
-import { extractCrops } from "../../../v2/fileOperations/crop.js";
+import { extractSingleCrop } from "../../../v2/fileOperations/crop.js";
 import { ExtractionResponse } from "../../../v2/product/index.js";
 export class CropItem {
     constructor(serverResponse) {
@@ -17,7 +17,7 @@ export class CropItem {
      * @param inputSource The input file to extract from.
      * @param quality Optional quality parameter for image extraction, default is undefined (full quality).
      */
-    async extractFromFile(inputSource, quality = 1) {
-        return (await extractCrops(inputSource, [this], quality))[0];
+    async extractFromInputSource(inputSource, quality = 1) {
+        return (await extractSingleCrop(inputSource, this, quality));
     }
 }

package/src/v2/product/crop/cropResponse.d.ts

@@ -1,6 +1,4 @@
-import { LocalInputSource } from "../../../input/index.js";
 import { StringDict } from "../../../parsing/stringDict.js";
-import { CropFiles } from "../../../v2/fileOperations/cropFiles.js";
 import { BaseResponse } from "../../../v2/parsing/index.js";
 import { CropInference } from "./cropInference.js";
 export declare class CropResponse extends BaseResponse {
@@ -12,10 +10,4 @@ export declare class CropResponse extends BaseResponse {
      * @param serverResponse JSON response from the server.
      */
     constructor(serverResponse: StringDict);
-    /**
-     * Extracts all crops from an input.
-     * @param inputSource The input file to extract from.
-     * @param quality Optional quality parameter for image extraction, default is undefined (full quality).
-     */
-    extractFromFile(inputSource: LocalInputSource, quality?: number): Promise<CropFiles>;
 }

package/src/v2/product/crop/cropResponse.js

@@ -1,4 +1,3 @@
-import { extractCrops } from "../../../v2/fileOperations/crop.js";
 import { BaseResponse } from "../../../v2/parsing/index.js";
 import { CropInference } from "./cropInference.js";
 export class CropResponse extends BaseResponse {
@@ -9,12 +8,4 @@ export class CropResponse extends BaseResponse {
         super(serverResponse);
         this.inference = new CropInference(serverResponse["inference"]);
     }
-    /**
-     * Extracts all crops from an input.
-     * @param inputSource The input file to extract from.
-     * @param quality Optional quality parameter for image extraction, default is undefined (full quality).
-     */
-    async extractFromFile(inputSource, quality = 1) {
-        return await extractCrops(inputSource, this.inference.result.crops, quality);
-    }
 }

package/src/v2/product/crop/cropResult.d.ts

@@ -1,5 +1,7 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { CropItem } from "../../../v2/product/crop/cropItem.js";
+import { LocalInputSource } from "../../../input/index.js";
+import { ExtractedImages } from "../../../image/extractedImages.js";
 export declare class CropResult {
     /**
      * Fields contained in the inference.
@@ -7,4 +9,10 @@ export declare class CropResult {
     crops: CropItem[];
     constructor(serverResponse: StringDict);
     toString(): string;
+    /**
+     * Extracts a single crop from an input.
+     * @param inputSource The input file to extract from.
+     * @param quality Optional quality parameter for image extraction, default is undefined (full quality).
+     */
+    extractFromInputSource(inputSource: LocalInputSource, quality?: number): Promise<ExtractedImages>;
 }

package/src/v2/product/crop/cropResult.js

@@ -1,4 +1,5 @@
 import { CropItem } from "../../../v2/product/crop/cropItem.js";
+import { extractMultipleCrops } from "../../../v2/fileOperations/crop.js";
 export class CropResult {
     constructor(serverResponse) {
         /**
@@ -11,4 +12,12 @@ export class CropResult {
         const crops = this.crops.map(item => item.toString()).join("\n");
         return `Crops\n=====\n${crops}`;
     }
+    /**
+     * Extracts a single crop from an input.
+     * @param inputSource The input file to extract from.
+     * @param quality Optional quality parameter for image extraction, default is undefined (full quality).
+     */
+    async extractFromInputSource(inputSource, quality = 1) {
+        return (await extractMultipleCrops(inputSource, this.crops, quality));
+    }
 }

package/src/v2/product/split/splitRange.d.ts

@@ -1,6 +1,7 @@
 import { StringDict } from "../../../parsing/index.js";
 import { LocalInputSource } from "../../../input/index.js";
 import { ExtractionResponse } from "../../../v2/product/index.js";
+import { ExtractedPdf } from "../../../pdf/index.js";
 /**
  * Split inference result.
  */
@@ -24,5 +25,5 @@ export declare class SplitRange {
      * Extracts a single split from the input file.
      * @param inputSource The input file to extract from.
      */
-    extractFromFile(inputSource: LocalInputSource): Promise<import("../../../pdf/extractedPdf.js").ExtractedPdf>;
+    extractFromFile(inputSource: LocalInputSource): Promise<ExtractedPdf>;
 }

package/src/v2/product/split/splitRange.js

@@ -1,4 +1,4 @@
-import { expandRange, extractSplits } from "../../../v2/fileOperations/split.js";
+import { expandRange, extractMultipleSplits } from "../../../v2/fileOperations/split.js";
 import { ExtractionResponse } from "../../../v2/product/index.js";
 /**
  * Split inference result.
@@ -21,6 +21,6 @@ export class SplitRange {
      */
     async extractFromFile(inputSource) {
         const pageRange = [expandRange(this.pageRange)];
-        return (await extractSplits(inputSource, pageRange))[0];
+        return (await extractMultipleSplits(inputSource, pageRange))[0];
     }
 }

package/src/v2/product/split/splitResponse.d.ts

@@ -1,8 +1,6 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { SplitInference } from "./splitInference.js";
 import { BaseResponse } from "../../../v2/parsing/index.js";
-import { LocalInputSource } from "../../../input/index.js";
-import { SplitFiles } from "../../../v2/fileOperations/splitFiles.js";
 export declare class SplitResponse extends BaseResponse {
     /**
      * Response for an OCR utility inference.
@@ -12,9 +10,4 @@ export declare class SplitResponse extends BaseResponse {
      * @param serverResponse JSON response from the server.
      */
     constructor(serverResponse: StringDict);
-    /**
-     * Extracts all splits from an input PDF.
-     * @param inputSource The input file to extract from.
-     */
-    extractFromFile(inputSource: LocalInputSource): Promise<SplitFiles>;
 }

package/src/v2/product/split/splitResponse.js

@@ -1,6 +1,5 @@
 import { SplitInference } from "./splitInference.js";
 import { BaseResponse } from "../../../v2/parsing/index.js";
-import { expandRange, extractSplits } from "../../../v2/fileOperations/split.js";
 export class SplitResponse extends BaseResponse {
     /**
      * @param serverResponse JSON response from the server.
@@ -9,15 +8,4 @@ export class SplitResponse extends BaseResponse {
         super(serverResponse);
         this.inference = new SplitInference(serverResponse["inference"]);
     }
-    /**
-     * Extracts all splits from an input PDF.
-     * @param inputSource The input file to extract from.
-     */
-    async extractFromFile(inputSource) {
-        const splits = [];
-        for (const split of this.inference.result.splits) {
-            splits.push(expandRange(split.pageRange));
-        }
-        return await extractSplits(inputSource, splits);
-    }
 }

package/src/v2/product/split/splitResult.d.ts

@@ -1,5 +1,7 @@
 import { SplitRange } from "./splitRange.js";
 import { StringDict } from "../../../parsing/index.js";
+import { LocalInputSource } from "../../../input/index.js";
+import { ExtractedPdfs } from "../../../pdf/index.js";
 /**
  * Split result info.
  */
@@ -9,5 +11,10 @@ export declare class SplitResult {
      */
     splits: SplitRange[];
     constructor(rawResponse: StringDict);
+    /**
+     * Extracts all splits from an input PDF.
+     * @param inputSource The input file to extract from.
+     */
+    extractFromInputSource(inputSource: LocalInputSource): Promise<ExtractedPdfs>;
     toString(): string;
 }

package/src/v2/product/split/splitResult.js

@@ -1,4 +1,5 @@
 import { SplitRange } from "./splitRange.js";
+import { extractMultipleSplits, expandRange } from "../../../v2/fileOperations/split.js";
 /**
  * Split result info.
  */
@@ -6,6 +7,17 @@ export class SplitResult {
     constructor(rawResponse) {
         this.splits = rawResponse.splits.map((split) => new SplitRange(split));
     }
+    /**
+     * Extracts all splits from an input PDF.
+     * @param inputSource The input file to extract from.
+     */
+    async extractFromInputSource(inputSource) {
+        const splits = [];
+        for (const split of this.splits) {
+            splits.push(expandRange(split.pageRange));
+        }
+        return await extractMultipleSplits(inputSource, splits);
+    }
     toString() {
         let splits = "\n";
         if (this.splits.length > 0) {

package/src/v2/fileOperations/cropFiles.d.ts

@@ -1,4 +0,0 @@
-import { ExtractedImage } from "../../image/index.js";
-export declare class CropFiles extends Array<ExtractedImage> {
-    constructor(...items: ExtractedImage[]);
-}

package/src/v2/fileOperations/splitFiles.d.ts

@@ -1,4 +0,0 @@
-import { ExtractedPdf } from "../../pdf/extractedPdf.js";
-export declare class SplitFiles extends Array<ExtractedPdf> {
-    constructor(...args: ExtractedPdf[]);
-}

package/src/v2/fileOperations/splitFiles.js

@@ -1,5 +0,0 @@
-export class SplitFiles extends Array {
-    constructor(...args) {
-        super(...args);
-    }
-}