mindee 5.4.0 → 5.5.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # 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)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "5.4.0",
+    "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/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/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/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.js

@@ -1,6 +1,5 @@
 import { MindeeError } from "../../errors/index.js";
 import { extractImagesFromPolygon } from "../../image/imageExtractor.js";
-import { ExtractedImages } from "../../image/index.js";
 import { logger } from "../../logger.js";
 /**
  * Extracts a single specified crop from a given input source.
@@ -32,6 +31,5 @@ export async function extractMultipleCrops(inputSource, crops, quality) {
         }
         polygonsByPage.get(pageId).push(crop.location.polygon);
     }
-    const extractedCrops = await extractImagesFromPolygon(inputSource, polygonsByPage, quality);
-    return new ExtractedImages(...extractedCrops);
+    return await extractImagesFromPolygon(inputSource, polygonsByPage, quality);
 }

package/src/v2/fileOperations/split.js

@@ -32,7 +32,7 @@ export async function extractMultipleSplits(inputSource, splits) {
     }
     const pageCount = await pdfExtractor.getPageCount();
     if (splits.length === 1 && splits[0].at(-1) === pageCount - 1) {
-        return new ExtractedPdfs(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 ExtractedPdfs(...subDocuments);

package/src/v2/http/mindeeApiV2.d.ts

@@ -4,6 +4,7 @@ import { BaseParameters } from "../../v2/index.js";
 import { JobResponse } from "../../v2/parsing/index.js";
 import { InputSource } from "../../input/index.js";
 import { BaseProduct } from "../../v2/product/baseProduct.js";
+import { SearchResponse } from "../../v2/parsing/search/index.js";
 /**
  * Mindee V2 API handler.
  */
@@ -12,21 +13,33 @@ export declare class MindeeApiV2 {
     settings: ApiSettings;
     constructor(dispatcher?: Dispatcher, apiKey?: string);
     /**
-     * Sends a file to the product inference queue.
-     * @param product product to enqueue.
-     * @param inputSource Local file loaded as an input.
+     * 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.
+     */
+    reqGetSearchModel(name?: string, modelType?: string): Promise<SearchResponse>;
+    /**
+     * Sends a document to the inference queue.
+     * @param product Product to enqueue.
+     * @param inputSource Local or remote file as an input.
      * @param params {ExtractionParameters} parameters relating to the enqueueing options.
-     * @throws Error if the server's response contains an error.
-     * @returns a `Promise` containing a job response.
      */
-    enqueueProduct(product: typeof BaseProduct, inputSource: InputSource, params: BaseParameters): Promise<JobResponse>;
+    reqPostProductEnqueue(product: typeof BaseProduct, inputSource: InputSource, params: BaseParameters): Promise<JobResponse>;
     /**
-     * Get the specified Job.
+     * Get the specified Job by its ID.
      * Throws an error if the server's response contains an error.
      * @param jobId The Job ID as returned by the enqueue request.
      * @returns a `Promise` containing the job response.
      */
-    getJob(jobId: string): Promise<JobResponse>;
+    reqGetJobById(jobId: string): Promise<JobResponse>;
+    /**
+     * Get the specified Job from a polling URL.
+     * Throws an error if the server's response contains an error.
+     * @param pollingUrl The polling URL as returned by a Job's pollingUrl property.
+     * @returns a `Promise` containing the job response.
+     */
+    reqGetJobByUrl(pollingUrl: string): Promise<JobResponse>;
     /**
      * Get the result of a queued document from the API.
      * Throws an error if the server's response contains an error.
@@ -34,7 +47,7 @@ export declare class MindeeApiV2 {
      * @param inferenceId The inference ID for the result.
      * @returns a `Promise` containing the parsed result.
      */
-    getProductResultById<P extends typeof BaseProduct>(product: P, inferenceId: string): Promise<InstanceType<P["responseClass"]>>;
+    reqGetProductResultById<P extends typeof BaseProduct>(product: P, inferenceId: string): Promise<InstanceType<P["responseClass"]>>;
     /**
      * Get the result of a queued document from the API.
      * Throws an error if the server's response contains an error.
@@ -42,5 +55,5 @@ export declare class MindeeApiV2 {
      * @param url The URL as returned by a Job's resultUrl property.
      * @returns a `Promise` containing the parsed result.
      */
-    getProductResultByUrl<P extends typeof BaseProduct>(product: P, url: string): Promise<InstanceType<P["responseClass"]>>;
+    reqGetProductResultByUrl<P extends typeof BaseProduct>(product: P, url: string): Promise<InstanceType<P["responseClass"]>>;
 }

package/src/v2/http/mindeeApiV2.js

@@ -3,7 +3,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _MindeeApiV2_instances, _MindeeApiV2_processResponse, _MindeeApiV2_reqPostProductEnqueue, _MindeeApiV2_reqGetJob, _MindeeApiV2_reqGetProductResult;
+var _MindeeApiV2_instances, _MindeeApiV2_processResponse;
 import { ApiSettings } from "./apiSettings.js";
 import { ErrorResponse, JobResponse, } from "../../v2/parsing/index.js";
 import { sendRequestAndReadResponse } from "../../http/apiCore.js";
@@ -11,6 +11,7 @@ import { LocalInputSource } from "../../input/index.js";
 import { MindeeDeserializationError, MindeeError } from "../../errors/index.js";
 import { MindeeHttpErrorV2 } from "./errors.js";
 import { logger } from "../../logger.js";
+import { SearchResponse } from "../../v2/parsing/search/index.js";
 /**
  * Mindee V2 API handler.
  */
@@ -20,29 +21,82 @@ export class MindeeApiV2 {
         this.settings = new ApiSettings({ dispatcher: dispatcher, apiKey: apiKey });
     }
     /**
-     * Sends a file to the product inference queue.
-     * @param product product to enqueue.
-     * @param inputSource Local file loaded as an input.
+     * 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 reqGetSearchModel(name, modelType) {
+        const queryParams = {};
+        if (name)
+            queryParams["name"] = name;
+        if (modelType)
+            queryParams["model_type"] = modelType;
+        const options = {
+            method: "GET",
+            headers: this.settings.baseHeaders,
+            hostname: this.settings.hostname,
+            path: "/v2/search/models",
+            queryParams: queryParams,
+            timeoutSecs: this.settings.timeoutSecs,
+        };
+        const response = await sendRequestAndReadResponse(this.settings.dispatcher, options);
+        return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, response, SearchResponse);
+    }
+    /**
+     * Sends a document to the inference queue.
+     * @param product Product to enqueue.
+     * @param inputSource Local or remote file as an input.
      * @param params {ExtractionParameters} parameters relating to the enqueueing options.
-     * @throws Error if the server's response contains an error.
-     * @returns a `Promise` containing a job response.
      */
-    async enqueueProduct(product, inputSource, params) {
-        await inputSource.init();
-        const result = await __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_reqPostProductEnqueue).call(this, product, inputSource, params);
+    async reqPostProductEnqueue(product, inputSource, params) {
+        const form = params.getFormData();
+        if (inputSource instanceof LocalInputSource) {
+            form.set("file", new Blob([inputSource.fileObject]), inputSource.filename);
+        }
+        else {
+            form.set("url", inputSource.url);
+        }
+        const path = `/v2/products/${product.slug}/enqueue`;
+        const options = {
+            method: "POST",
+            headers: this.settings.baseHeaders,
+            hostname: this.settings.hostname,
+            path: path,
+            body: form,
+            timeoutSecs: this.settings.timeoutSecs,
+        };
+        const result = await sendRequestAndReadResponse(this.settings.dispatcher, options);
         if (result.data.error !== undefined) {
             throw new MindeeHttpErrorV2(result.data.error);
         }
         return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, result, JobResponse);
     }
     /**
-     * Get the specified Job.
+     * Get the specified Job by its ID.
      * Throws an error if the server's response contains an error.
      * @param jobId The Job ID as returned by the enqueue request.
      * @returns a `Promise` containing the job response.
      */
-    async getJob(jobId) {
-        const response = await __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_reqGetJob).call(this, jobId);
+    async reqGetJobById(jobId) {
+        return this.reqGetJobByUrl(`https://${this.settings.hostname}/v2/jobs/${jobId}`);
+    }
+    /**
+     * Get the specified Job from a polling URL.
+     * Throws an error if the server's response contains an error.
+     * @param pollingUrl The polling URL as returned by a Job's pollingUrl property.
+     * @returns a `Promise` containing the job response.
+     */
+    async reqGetJobByUrl(pollingUrl) {
+        if (!pollingUrl.startsWith("https://")) {
+            throw new MindeeError(`Invalid URL: ${pollingUrl}`);
+        }
+        const options = {
+            method: "GET",
+            headers: this.settings.baseHeaders,
+            timeoutSecs: this.settings.timeoutSecs,
+        };
+        const response = await sendRequestAndReadResponse(this.settings.dispatcher, options, pollingUrl);
         return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, response, JobResponse);
     }
     /**
@@ -52,9 +106,8 @@ export class MindeeApiV2 {
      * @param inferenceId The inference ID for the result.
      * @returns a `Promise` containing the parsed result.
      */
-    async getProductResultById(product, inferenceId) {
-        const queueResponse = await __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_reqGetProductResult).call(this, `https://${this.settings.hostname}/v2/products/${product.slug}/results/${inferenceId}`);
-        return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, queueResponse, product.responseClass);
+    async reqGetProductResultById(product, inferenceId) {
+        return this.reqGetProductResultByUrl(product, `https://${this.settings.hostname}/v2/products/${product.slug}/results/${inferenceId}`);
     }
     /**
      * Get the result of a queued document from the API.
@@ -63,9 +116,17 @@ export class MindeeApiV2 {
      * @param url The URL as returned by a Job's resultUrl property.
      * @returns a `Promise` containing the parsed result.
      */
-    async getProductResultByUrl(product, url) {
-        const queueResponse = await __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_reqGetProductResult).call(this, url);
-        return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, queueResponse, product.responseClass);
+    async reqGetProductResultByUrl(product, url) {
+        const options = {
+            method: "GET",
+            headers: this.settings.baseHeaders,
+            timeoutSecs: this.settings.timeoutSecs,
+        };
+        if (!url.startsWith("https://")) {
+            throw new MindeeError(`Invalid URL: ${url}`);
+        }
+        const response = await sendRequestAndReadResponse(this.settings.dispatcher, options, url);
+        return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, response, product.responseClass);
     }
 }
 _MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_processResponse = function _MindeeApiV2_processResponse(result, responseClass) {
@@ -88,54 +149,4 @@ _MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_processResponse = function
         logger.error(`Raised '${e}' Couldn't deserialize response object:\n${JSON.stringify(result.data)}`);
         throw new MindeeDeserializationError("Couldn't deserialize response object.");
     }
-}, _MindeeApiV2_reqPostProductEnqueue = 
-/**
- * Sends a document to the inference queue.
- * @param product Product to enqueue.
- * @param inputSource Local or remote file as an input.
- * @param params {ExtractionParameters} parameters relating to the enqueueing options.
- */
-async function _MindeeApiV2_reqPostProductEnqueue(product, inputSource, params) {
-    const form = params.getFormData();
-    if (inputSource instanceof LocalInputSource) {
-        form.set("file", new Blob([inputSource.fileObject]), inputSource.filename);
-    }
-    else {
-        form.set("url", inputSource.url);
-    }
-    const path = `/v2/products/${product.slug}/enqueue`;
-    const options = {
-        method: "POST",
-        headers: this.settings.baseHeaders,
-        hostname: this.settings.hostname,
-        path: path,
-        body: form,
-        timeoutSecs: this.settings.timeoutSecs,
-    };
-    return await sendRequestAndReadResponse(this.settings.dispatcher, options);
-}, _MindeeApiV2_reqGetJob = async function _MindeeApiV2_reqGetJob(jobId) {
-    const options = {
-        method: "GET",
-        headers: this.settings.baseHeaders,
-        hostname: this.settings.hostname,
-        path: `/v2/jobs/${jobId}`,
-        timeoutSecs: this.settings.timeoutSecs,
-    };
-    return await sendRequestAndReadResponse(this.settings.dispatcher, options);
-}, _MindeeApiV2_reqGetProductResult = 
-/**
- * Make a request to GET the status of a document in the queue.
- * @param url URL path to the result.
- * @returns a `Promise` containing the parsed result.
- */
-async function _MindeeApiV2_reqGetProductResult(url) {
-    const options = {
-        method: "GET",
-        headers: this.settings.baseHeaders,
-        timeoutSecs: this.settings.timeoutSecs,
-    };
-    if (!url.startsWith("https://")) {
-        throw new MindeeError(`Invalid URL: ${url}`);
-    }
-    return await sendRequestAndReadResponse(this.settings.dispatcher, options, url);
 };

package/src/v2/parsing/search/index.d.ts

@@ -0,0 +1,4 @@
+export { PaginationMetadata } from "./paginationMetadata.js";
+export { SearchModel } from "./searchModel.js";
+export { SearchResponse } from "./searchResponse.js";
+export { ModelWebhook } from "./modelWebhook.js";

package/src/v2/parsing/search/index.js

@@ -0,0 +1,4 @@
+export { PaginationMetadata } from "./paginationMetadata.js";
+export { SearchModel } from "./searchModel.js";
+export { SearchResponse } from "./searchResponse.js";
+export { ModelWebhook } from "./modelWebhook.js";

package/src/v2/parsing/search/modelWebhook.d.ts

@@ -0,0 +1,19 @@
+import { StringDict } from "../../../parsing/index.js";
+/**
+ * Model webhook info.
+ */
+export declare class ModelWebhook {
+    /**
+     * ID of the webhook.
+     */
+    id: string;
+    /**
+     * Name of the webhook.
+     */
+    name: string;
+    /**
+     * URL of the webhook.
+     */
+    url: string;
+    constructor(serverResponse: StringDict);
+}

package/src/v2/parsing/search/modelWebhook.js

@@ -0,0 +1,10 @@
+/**
+ * Model webhook info.
+ */
+export class ModelWebhook {
+    constructor(serverResponse) {
+        this.id = serverResponse["id"];
+        this.name = serverResponse["name"];
+        this.url = serverResponse["url"];
+    }
+}

package/src/v2/parsing/search/paginationMetadata.d.ts

@@ -0,0 +1,24 @@
+import { StringDict } from "../../../parsing/index.js";
+/**
+ * PaginationMetadata data associated with model search.
+ */
+export declare class PaginationMetadata {
+    /**
+     * Number of items per page.
+     */
+    perPage: number;
+    /**
+     * 1-indexed page number.
+     */
+    page: number;
+    /**
+     * Total items.
+     */
+    totalItems: number;
+    /**
+     * Total number of pages.
+     */
+    totalPages: number;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/parsing/search/paginationMetadata.js

@@ -0,0 +1,19 @@
+/**
+ * PaginationMetadata data associated with model search.
+ */
+export class PaginationMetadata {
+    constructor(serverResponse) {
+        this.perPage = serverResponse["per_page"];
+        this.page = serverResponse["page"];
+        this.totalItems = serverResponse["total_items"];
+        this.totalPages = serverResponse["total_pages"];
+    }
+    toString() {
+        return [
+            `:Per Page: ${this.perPage}`,
+            `:Page: ${this.page}`,
+            `:Total Items: ${this.totalItems}`,
+            `:Total Pages: ${this.totalPages}`,
+        ].join("\n");
+    }
+}

package/src/v2/parsing/search/searchModel.d.ts

@@ -0,0 +1,25 @@
+import { StringDict } from "../../../parsing/index.js";
+import { ModelWebhook } from "./modelWebhook.js";
+/**
+ * Models search response.
+ */
+export declare class SearchModel {
+    /**
+     * ID of the model.
+     */
+    id: string;
+    /**
+     * Name of the model.
+     */
+    name: string;
+    /**
+     * Type of the model.
+     */
+    modelType: string;
+    /**
+     * Webhooks associated with the model.
+     */
+    webhooks: ModelWebhook[];
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/parsing/search/searchModel.js

@@ -0,0 +1,19 @@
+import { ModelWebhook } from "./modelWebhook.js";
+/**
+ * Models search response.
+ */
+export class SearchModel {
+    constructor(serverResponse) {
+        this.id = serverResponse["id"];
+        this.name = serverResponse["name"];
+        this.modelType = serverResponse["model_type"];
+        this.webhooks = (serverResponse["webhooks"] ?? []).map((webhook) => new ModelWebhook(webhook));
+    }
+    toString() {
+        return [
+            `:Name: ${this.name}`,
+            `:ID: ${this.id}`,
+            `:Model Type: ${this.modelType}`,
+        ].join("\n");
+    }
+}

package/src/v2/parsing/search/searchResponse.d.ts

@@ -0,0 +1,19 @@
+import { StringDict } from "../../../parsing/index.js";
+import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+import { PaginationMetadata } from "./paginationMetadata.js";
+import { SearchModel } from "./searchModel.js";
+/**
+ * Models search response.
+ */
+export declare class SearchResponse extends BaseResponse {
+    /**
+     * List of models returned by the search.
+     */
+    models: SearchModel[];
+    /**
+     * Pagination metadata.
+     */
+    pagination: PaginationMetadata;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/parsing/search/searchResponse.js

@@ -0,0 +1,24 @@
+import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+import { PaginationMetadata } from "./paginationMetadata.js";
+import { SearchModel } from "./searchModel.js";
+/**
+ * Models search response.
+ */
+export class SearchResponse extends BaseResponse {
+    constructor(serverResponse) {
+        super(serverResponse);
+        this.models = (serverResponse["models"] ?? []).map((model) => new SearchModel(model));
+        this.pagination = new PaginationMetadata(serverResponse["pagination"]);
+    }
+    toString() {
+        const lines = ["Models", "#######"];
+        for (const model of this.models) {
+            lines.push(`* :Name: ${model.name}`);
+            lines.push(`  :ID: ${model.id}`);
+            lines.push(`  :Model Type: ${model.modelType}`);
+        }
+        lines.push("Pagination", "##########");
+        lines.push(this.pagination.toString());
+        return lines.join("\n");
+    }
+}