mindee 5.3.1 → 5.5.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Mindee Node.js API Library Changelog
 
+## v5.5.0 - 2026-07-01
+### Fixes
+* :memo: minor tweak to SKILL file
+* :bug: retry once on connection error
+* :recycle: rework and fix extractors (:boom: some **undocumented** functions break)
+
+
+## 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.5.0",
     "description": "Mindee Client Library for Node.js",
     "author": {
         "name": "Mindee",

package/src/http/apiCore.d.ts

@@ -8,6 +8,7 @@ export interface RequestOptions {
     timeoutSecs: number;
     headers: any;
     body?: FormData | string;
+    queryParams?: Record<string, string>;
 }
 export interface BaseHttpResponse {
     messageObj: any;

package/src/http/apiCore.js

@@ -20,14 +20,32 @@ export async function cutDocPages(inputDoc, pageOptions) {
  * @returns the processed request.
  */
 export async function sendRequestAndReadResponse(dispatcher, options, url) {
-    url ?? (url = `https://${options.hostname}${options.path}`);
-    const response = await request(url, {
+    const requestUrl = new URL(url ?? `https://${options.hostname}${options.path}`);
+    if (options.queryParams) {
+        for (const [key, value] of Object.entries(options.queryParams)) {
+            requestUrl.searchParams.set(key, value);
+        }
+    }
+    const requestParams = {
         method: options.method,
         headers: options.headers,
         headersTimeout: options.timeoutSecs * 1000,
         body: options.body,
         dispatcher: dispatcher,
-    });
+    };
+    let response;
+    try {
+        response = await request(requestUrl, requestParams);
+    }
+    catch (err) {
+        // shenanigans in networking or freezing/thawing of the process in serverless environments
+        if (err.code === "UND_ERR_SOCKET" || err.code === "UND_ERR_CONNECT_TIMEOUT" || err.code === "ECONNRESET") {
+            logger.warn(`Socket error (${err.code}), retrying with a fresh connection...`);
+            response = await request(requestUrl, requestParams);
+        }
+        else
+            throw err;
+    }
     logger.debug("Parsing the response ...");
     let responseBody = await response.body.text();
     // handle empty responses from server, for example, in the case of redirects

package/src/image/extractedImage.d.ts

@@ -1,14 +1,14 @@
 import { Buffer } from "node:buffer";
 import { BufferInput } from "../input/index.js";
 /**
- * Generic class for image extraction
+ * Generic class for image extraction.
  */
 export declare class ExtractedImage {
     buffer: Buffer;
     filename: string;
-    pageId?: number;
-    elementId?: number;
-    constructor(buffer: Uint8Array, fileName: string, pageId?: number, elementId?: number);
+    readonly pageId: number;
+    readonly elementId: number;
+    constructor(buffer: Uint8Array, fileName: string, pageId: number, elementId: number);
     /**
      * Saves the document to a file.
      *
@@ -27,5 +27,5 @@ export declare class ExtractedImage {
      *
      * @returns A BufferInput source.
      */
-    asSource(): BufferInput;
+    asInputSource(): BufferInput;
 }

package/src/image/extractedImage.js

@@ -7,7 +7,7 @@ import { BufferInput, MIMETYPES } from "../input/index.js";
 import { logger } from "../logger.js";
 import { loadOptionalDependency } from "../dependency/index.js";
 /**
- * Generic class for image extraction
+ * Generic class for image extraction.
  */
 export class ExtractedImage {
     constructor(buffer, fileName, pageId, elementId) {
@@ -92,7 +92,7 @@ export class ExtractedImage {
      *
      * @returns A BufferInput source.
      */
-    asSource() {
+    asInputSource() {
         return new BufferInput({
             buffer: this.buffer,
             filename: this.filename,

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/imageExtractor.d.ts

@@ -1,5 +1,5 @@
 import { Polygon } from "../geometry/index.js";
-import { ExtractedImage } from "../image/extractedImage.js";
+import { ExtractedImages } from "../image/extractedImages.js";
 import { LocalInputSource } from "../input/index.js";
 import type * as pdfLibTypes from "@cantoo/pdf-lib";
 /**
@@ -8,7 +8,7 @@ import type * as pdfLibTypes from "@cantoo/pdf-lib";
  * @param polygonsPerPage List of polygons to extract from per page.
  * @param quality JPEG quality of extracted images.
  */
-export declare function extractImagesFromPolygon(inputSource: LocalInputSource, polygonsPerPage: Map<number, Polygon[]>, quality?: number): Promise<ExtractedImage[]>;
+export declare function extractImagesFromPolygon(inputSource: LocalInputSource, polygonsPerPage: Map<number, Polygon[]>, quality?: number): Promise<ExtractedImages>;
 /**
  * Extracts elements from a page based off of a list of bounding boxes.
  *

package/src/image/imageExtractor.js

@@ -3,6 +3,7 @@ import { MindeeImageError } from "../errors/index.js";
 import { getMinMaxX, getMinMaxY } from "../geometry/index.js";
 import { adjustForRotation } from "../geometry/polygonUtils.js";
 import { ExtractedImage } from "../image/extractedImage.js";
+import { ExtractedImages } from "../image/extractedImages.js";
 import { logger } from "../logger.js";
 import { createPdfFromInputSource } from "../pdf/pdfOperation.js";
 import { rasterizePage } from "../pdf/pdfUtils.js";
@@ -21,13 +22,13 @@ async function getPdfLib() {
  * @param quality JPEG quality of extracted images.
  */
 export async function extractImagesFromPolygon(inputSource, polygonsPerPage, quality) {
-    const allExtractedImages = [];
+    const allExtractedImages = new ExtractedImages();
     const pdfDoc = await createPdfFromInputSource(inputSource);
     for (const [pageId, polygons] of polygonsPerPage) {
         logger.debug(`Extracting images from page ${pageId}`);
         const pdfPage = pdfDoc.getPage(pageId);
-        const extractions = (await extractFromPage(pdfPage, polygons, true, quality));
-        const extractedImages = extractions.map((v, i) => new ExtractedImage(v, inputSource.filename + `_page${pageId}-${i}.jpg`, pageId, i));
+        const extractions = await extractFromPage(pdfPage, polygons, true, quality);
+        const extractedImages = extractions.map((buffer, elementId) => new ExtractedImage(buffer, inputSource.filename + `_page-${pageId}-item-${elementId}.jpg`, pageId, elementId));
         allExtractedImages.push(...extractedImages);
     }
     return allExtractedImages;

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/extractedPdf.d.ts

@@ -4,7 +4,8 @@ export declare class ExtractedPdf {
     readonly buffer: Buffer;
     readonly filename: string;
     readonly pageCount: number;
-    constructor(pdfData: Buffer<ArrayBufferLike>, filename: string, pageCount: number);
+    readonly pageIndexes: number[];
+    constructor(pdfData: Buffer<ArrayBufferLike>, filename: string, pageIndexes: number[]);
     /**
      * Saves the document to a file.
      *
@@ -21,5 +22,5 @@ export declare class ExtractedPdf {
      *
      * @returns A BufferInput source.
      */
-    asSource(): BufferInput;
+    asInputSource(): BufferInput;
 }

package/src/pdf/extractedPdf.js

@@ -5,10 +5,11 @@ import { writeFile } from "fs/promises";
 import { logger } from "../logger.js";
 import { writeFileSync } from "node:fs";
 export class ExtractedPdf {
-    constructor(pdfData, filename, pageCount) {
+    constructor(pdfData, filename, pageIndexes) {
         this.buffer = pdfData;
         this.filename = filename;
-        this.pageCount = pageCount;
+        this.pageCount = pageIndexes.length;
+        this.pageIndexes = pageIndexes;
     }
     /**
      * Saves the document to a file.
@@ -56,7 +57,7 @@ export class ExtractedPdf {
      *
      * @returns A BufferInput source.
      */
-    asSource() {
+    asInputSource() {
         return new BufferInput({
             buffer: this.buffer,
             filename: this.filename,

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/pdf/pdfExtractor.d.ts

@@ -1,5 +1,5 @@
 import { LocalInputSource } from "../input/index.js";
-import { ExtractedPdf } from "../pdf/extractedPdf.js";
+import { ExtractedPdfs } from "../pdf/extractedPdfs.js";
 export declare class PdfExtractor {
     /**
      * Buffer containing the PDF data.
@@ -42,5 +42,5 @@ export declare class PdfExtractor {
      * Extracts pages from the PDF.
      * @param pageIndexes
      */
-    extractSubDocuments(pageIndexes: number[][]): Promise<ExtractedPdf[]>;
+    extractSubDocuments(pageIndexes: number[][]): Promise<ExtractedPdfs>;
 }

package/src/pdf/pdfExtractor.js

@@ -121,7 +121,7 @@ export class PdfExtractor {
             const endPage = String(pageRange[pageRange.length - 1] + 1).padStart(3, "0");
             const fieldFilename = `${splitName}_page_${startPage}-${endPage}.pdf`;
             const page = await extractPages(this.sourcePdf, pageOptions);
-            this.extractedPdfs.push(new ExtractedPdf(page.file, fieldFilename, pageRange.length));
+            this.extractedPdfs.push(new ExtractedPdf(page.file, fieldFilename, pageRange));
         }
         return this.extractedPdfs;
     }

package/src/v1/extraction/invoiceSplitterExtractor/extractedInvoiceSplitterImage.d.ts

@@ -1,9 +1,9 @@
-import { ExtractedImage } from "../../../image/extractedImage.js";
+import { ExtractedPdf } from "../../../pdf/index.js";
 /**
  * Wrapper class for extracted invoice pages.
  */
-export declare class ExtractedInvoiceSplitterImage extends ExtractedImage {
+export declare class ExtractedInvoiceSplitterImage extends ExtractedPdf {
     readonly pageIdMin: number;
     readonly pageIdMax: number;
-    constructor(buffer: Uint8Array, pageIndices: [number, number]);
+    constructor(bytes: Uint8Array, pageIndices: [number, number]);
 }

package/src/v1/extraction/invoiceSplitterExtractor/extractedInvoiceSplitterImage.js

@@ -1,10 +1,10 @@
-import { ExtractedImage } from "../../../image/extractedImage.js";
+import { ExtractedPdf } from "../../../pdf/index.js";
 /**
  * Wrapper class for extracted invoice pages.
  */
-export class ExtractedInvoiceSplitterImage extends ExtractedImage {
-    constructor(buffer, pageIndices) {
-        super(buffer, `invoice_p_${pageIndices[0]}-${pageIndices[1]}.pdf`);
+export class ExtractedInvoiceSplitterImage extends ExtractedPdf {
+    constructor(bytes, pageIndices) {
+        super(Buffer.from(bytes), `invoice_p_${pageIndices[0]}-${pageIndices[1]}.pdf`, pageIndices);
         this.pageIdMin = pageIndices[0];
         this.pageIdMax = pageIndices[1];
     }

package/src/v1/extraction/multiReceiptsExtractor/extractedMultiReceiptImage.js

@@ -4,7 +4,7 @@ import { ExtractedImage } from "../../../image/index.js";
  */
 export class ExtractedMultiReceiptImage extends ExtractedImage {
     constructor(buffer, pageId, receiptId) {
-        super(buffer, `receipt_p${pageId}_${receiptId}.pdf`);
+        super(buffer, `receipt_p${pageId}_${receiptId}.pdf`, pageId, receiptId);
         this.pageId = pageId;
         this.receiptId = receiptId;
     }

package/src/v2/client.d.ts

@@ -1,6 +1,7 @@
 import { Dispatcher } from "undici";
 import { InputSource } from "../input/index.js";
 import { JobResponse } from "./parsing/index.js";
+import { SearchResponse } from "./parsing/search/index.js";
 import { MindeeApiV2 } from "./http/mindeeApiV2.js";
 import { PollingOptions, PollingOptionsConstructor } from "./clientOptions/index.js";
 import { BaseProduct } from "../v2/product/baseProduct.js";
@@ -31,6 +32,13 @@ export declare class Client {
      * @param {ClientOptions} options options for the initialization of a client.
      */
     constructor({ apiKey, debug, dispatcher }?: ClientOptions);
+    /**
+     * Search for models available to the account.
+     * @param name Optional name filter.
+     * @param modelType Optional model type filter.
+     * @returns a `Promise` containing the search response.
+     */
+    searchModels(name?: string, modelType?: string): Promise<SearchResponse>;
     enqueue<P extends typeof BaseProduct>(product: P, inputSource: InputSource, params: InstanceType<P["parametersClass"]> | ConstructorParameters<P["parametersClass"]>[0]): Promise<JobResponse>;
     /**
      * Retrieves the result of a previously enqueued request.
@@ -79,5 +87,5 @@ export declare class Client {
      * until the maximum number of tries is reached.
      * @protected
      */
-    protected pollForResult<P extends typeof BaseProduct>(product: typeof BaseProduct, pollingOptions: PollingOptions, jobId: string): Promise<InstanceType<P["responseClass"]>>;
+    protected pollForResult<P extends typeof BaseProduct>(product: typeof BaseProduct, pollingOptions: PollingOptions, jobResponse: JobResponse): Promise<InstanceType<P["responseClass"]>>;
 }

package/src/v2/client.js

@@ -25,6 +25,15 @@ export class Client {
                 : LOG_LEVELS["warn"];
         logger.debug("Client V2 Initialized");
     }
+    /**
+     * Search for models available to the account.
+     * @param name Optional name filter.
+     * @param modelType Optional model type filter.
+     * @returns a `Promise` containing the search response.
+     */
+    async searchModels(name, modelType) {
+        return await this.mindeeApi.reqGetSearchModel(name, modelType);
+    }
     async enqueue(product, inputSource, params) {
         if (inputSource === undefined) {
             throw new MindeeError("An input document is required.");
@@ -33,7 +42,7 @@ export class Client {
             ? params
             : new product.parametersClass(params);
         await inputSource.init();
-        const jobResponse = await this.mindeeApi.enqueueProduct(product, inputSource, paramsInstance);
+        const jobResponse = await this.mindeeApi.reqPostProductEnqueue(product, inputSource, paramsInstance);
         if (jobResponse.job.id === undefined || jobResponse.job.id.length === 0) {
             logger.error(`Failed enqueueing:\n${jobResponse.getRawHttp()}`);
             throw new MindeeError("Enqueueing of the document failed.");
@@ -51,7 +60,7 @@ export class Client {
      */
     async getResult(product, inferenceId) {
         logger.debug(`Attempting to get inference with ID: ${inferenceId} using response type: ${product.name}`);
-        return await this.mindeeApi.getProductResultById(product, inferenceId);
+        return await this.mindeeApi.reqGetProductResultById(product, inferenceId);
     }
     /**
      * Retrieves the result of a previously enqueued request.
@@ -64,7 +73,7 @@ export class Client {
      */
     async getResultByUrl(product, url) {
         logger.debug(`Attempting to get inference from: ${url} using response type: ${product.name}`);
-        return await this.mindeeApi.getProductResultByUrl(product, url);
+        return await this.mindeeApi.reqGetProductResultByUrl(product, url);
     }
     /**
      * Get the processing status of a previously enqueued request.
@@ -76,7 +85,7 @@ export class Client {
      * parsing is complete.
      */
     async getJob(jobId) {
-        return await this.mindeeApi.getJob(jobId);
+        return await this.mindeeApi.reqGetJobById(jobId);
     }
     /**
      * Enqueue a request and poll the server until the result is sent or
@@ -94,22 +103,22 @@ export class Client {
         const paramsInstance = new product.parametersClass(params);
         const pollingOptionsInstance = new PollingOptions(pollingOptions);
         const jobResponse = await this.enqueue(product, inputSource, paramsInstance);
-        return await this.pollForResult(product, pollingOptionsInstance, jobResponse.job.id);
+        return await this.pollForResult(product, pollingOptionsInstance, jobResponse);
     }
     /**
      * Send a document to an endpoint and poll the server until the result is sent or
      * until the maximum number of tries is reached.
      * @protected
      */
-    async pollForResult(product, pollingOptions, jobId) {
+    async pollForResult(product, pollingOptions, jobResponse) {
         logger.debug(`Waiting ${pollingOptions.initialDelaySec} seconds before polling.`);
         await setTimeout(pollingOptions.initialDelaySec * 1000, undefined, pollingOptions.initialTimerOptions);
-        logger.debug(`Start polling for inference using job ID: ${jobId}.`);
+        logger.debug(`Start polling for inference using job ID: ${jobResponse.job.id}.`);
         let retryCounter = 1;
         let pollResults;
         while (retryCounter < pollingOptions.maxRetries + 1) {
             logger.debug(`Attempt ${retryCounter} of ${pollingOptions.maxRetries}`);
-            pollResults = await this.getJob(jobId);
+            pollResults = await this.mindeeApi.reqGetJobByUrl(jobResponse.job.pollingUrl);
             const error = pollResults.job.error;
             if (error) {
                 throw new MindeeHttpErrorV2(error);

package/src/v2/clientOptions/baseParameters.d.ts

@@ -28,8 +28,9 @@ export declare abstract class BaseParameters {
      */
     modelId: string;
     /**
-     * Use an alias to link the file to your own DB.
-     * If empty, no alias will be used.
+     * Optional: a free-form string to tag the request with your own identifier.
+     * For example, an internal document ID, reference number, or database key.
+     * If set, it will be included in the job and result responses.
      */
     alias?: string;
     /**

package/src/v2/clientOptions/pollingOptions.d.ts

@@ -51,6 +51,6 @@ export declare class PollingOptions {
     /** Options passed to every recurring `setTimeout()`. */
     recurringTimerOptions?: TimerOptions;
     constructor(params?: PollingOptionsConstructor);
-    validateOptions(): void;
+    validateSettings(): void;
     toString(): string;
 }

package/src/v2/clientOptions/pollingOptions.js

@@ -62,10 +62,10 @@ export class PollingOptions {
         if (params.recurringTimerOptions) {
             this.recurringTimerOptions = params.recurringTimerOptions;
         }
-        this.validateOptions();
+        this.validateSettings();
         logger.debug(`Polling options initialized: ${this.toString()}`);
     }
-    validateOptions() {
+    validateSettings() {
         if (this.delaySec < minDelaySec) {
             throw new MindeeConfigurationError(`Cannot set auto-parsing delay to less than ${minDelaySec} second(s).`);
         }

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,14 @@
 import { MindeeError } from "../../errors/index.js";
 import { extractImagesFromPolygon } from "../../image/imageExtractor.js";
-import { CropFiles } from "../../v2/fileOperations/cropFiles.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 +17,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.");
     }
@@ -31,6 +31,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 await extractImagesFromPolygon(inputSource, polygonsByPage, quality);
 }

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, splits[0]));
     }
     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.