mindee 5.6.1 → 5.7.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Mindee Node.js API Library Changelog
 
+## v5.7.1 - 2026-09-10
+### Fixes
+* :bug: constant-time HMAC security fix
+
+
+## v5.7.0 - 2026-08-20
+### Changes
+* :sparkles: add support for RAG search API
+* :recycle: rework and mutualize a lot of http classes
+
+### Fixes
+* :bug: fix undici unexpectedly re-using request agents when not specified
+
+
 ## v5.6.1 - 2026-08-19
 ### Changes
 * :arrow_up: security updates

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "5.6.1",
+    "version": "5.7.1",
     "description": "Mindee Client Library for Node.js",
     "author": {
         "name": "Mindee",
@@ -32,11 +32,9 @@
         "test:integration:light": "node tests/runner.mjs integration",
         "test:v2": "tsc --noEmit && node tests/runner.mjs spec v2",
         "lint": "tsc --noEmit && eslint --report-unused-disable-directives './src/**/*.ts' './tests/**/*.ts'",
-        "lint:check": "npm run lint",
         "lint:fix": "tsc --noEmit && eslint --fix --report-unused-disable-directives './src/**/*.ts' './tests/**/*.ts'",
         "lint:package": "npm run build:dist && publint ./dist && attw --pack ./dist --profile esm-only",
         "lint:secrets": "secretlint '**/*'",
-        "lint:full": "npm run lint:check && npm run lint:package && npm run lint:secrets",
         "license:check": "license-checker-rseidelsohn --onlyAllow \"MIT;Apache-2.0;BSD-2-Clause;BSD-3-Clause;ISC;LGPL-3.0-or-later;Python-2.0;BlueOak-1.0.0;CC-BY-3.0;CC0-1.0;0BSD;LGPL-3.0-only;WTFPL;Artistic-2.0;Unlicense\"",
         "docs": "typedoc --out docs/_build ./src/index.ts",
         "docs:dist": "typedoc --out docs/_build ./src/index.ts && cp -r ./docs/code_samples ./docs/_build/",

package/src/http/apiCore.d.ts

@@ -1,5 +1,4 @@
 import { Dispatcher, FormData } from "undici";
-import { InputSource, PageOptions } from "../input/index.js";
 export declare const TIMEOUT_SECS_DEFAULT: number;
 export interface RequestOptions {
     hostname?: string;
@@ -16,12 +15,6 @@ export interface BaseHttpResponse {
         [key: string]: any;
     };
 }
-/**
- * Cuts a document's pages according to the given options.
- * @param inputDoc input document.
- * @param pageOptions page cutting options.
- */
-export declare function cutDocPages(inputDoc: InputSource, pageOptions: PageOptions): Promise<void>;
 /**
  * Reads a response from the API and processes it.
  * @param dispatcher custom dispatcher to use for the request.

package/src/http/apiCore.js

@@ -1,17 +1,6 @@
 import { logger } from "../logger.js";
 import { request } from "undici";
-import { LocalInputSource } from "../input/index.js";
 export const TIMEOUT_SECS_DEFAULT = 120;
-/**
- * Cuts a document's pages according to the given options.
- * @param inputDoc input document.
- * @param pageOptions page cutting options.
- */
-export async function cutDocPages(inputDoc, pageOptions) {
-    if (inputDoc instanceof LocalInputSource && inputDoc.isPdf()) {
-        await inputDoc.applyPageOptions(pageOptions);
-    }
-}
 /**
  * Reads a response from the API and processes it.
  * @param dispatcher custom dispatcher to use for the request.

package/src/http/baseSettings.js

@@ -1,8 +1,8 @@
-import { getGlobalDispatcher } from "undici";
 // eslint-disable-next-line no-restricted-imports
 import packageJson from "../../package.json" with { type: "json" };
 import * as os from "os";
 import { TIMEOUT_SECS_DEFAULT } from "./apiCore.js";
+import { resolveDefaultDispatcher } from "./dispatcher.js";
 export class BaseSettings {
     constructor(apiKey, dispatcher) {
         if (apiKey === undefined || !apiKey || apiKey.length === 0) {
@@ -11,7 +11,7 @@ export class BaseSettings {
         else {
             this.apiKey = apiKey;
         }
-        this.dispatcher = dispatcher ?? getGlobalDispatcher();
+        this.dispatcher = dispatcher ?? resolveDefaultDispatcher();
         this.hostname = this.hostnameFromEnv();
         this.timeoutSecs = process.env.MINDEE_REQUEST_TIMEOUT
             ? parseInt(process.env.MINDEE_REQUEST_TIMEOUT)

package/src/http/dispatcher.d.ts

@@ -0,0 +1,6 @@
+import { Dispatcher } from "undici";
+/**
+ * Returns the global undici dispatcher, provided it was created by the same
+ * undici copy this library imports.
+ */
+export declare function resolveDefaultDispatcher(): Dispatcher;

package/src/http/dispatcher.js

@@ -0,0 +1,17 @@
+import { Agent, Dispatcher, getGlobalDispatcher } from "undici";
+import { logger } from "../logger.js";
+/** Library-owned fallback dispatcher, shared across all components. */
+let fallbackDispatcher;
+/**
+ * Returns the global undici dispatcher, provided it was created by the same
+ * undici copy this library imports.
+ */
+export function resolveDefaultDispatcher() {
+    const globalDispatcher = getGlobalDispatcher();
+    if (globalDispatcher instanceof Dispatcher) {
+        return globalDispatcher;
+    }
+    logger.debug("Global dispatcher belongs to a different undici instance, using a library-owned Agent instead.");
+    fallbackDispatcher ?? (fallbackDispatcher = new Agent());
+    return fallbackDispatcher;
+}

package/src/http/index.d.ts

@@ -1,3 +1,4 @@
 export type { BaseHttpResponse } from "./apiCore.js";
 export { isValidSyncResponse, isValidAsyncResponse, cleanRequestData, } from "../v1/http/responseValidation.js";
 export { BaseSettings } from "./baseSettings.js";
+export { resolveDefaultDispatcher } from "./dispatcher.js";

package/src/http/index.js

@@ -1,2 +1,3 @@
 export { isValidSyncResponse, isValidAsyncResponse, cleanRequestData, } from "../v1/http/responseValidation.js";
 export { BaseSettings } from "./baseSettings.js";
+export { resolveDefaultDispatcher } from "./dispatcher.js";

package/src/input/urlInput.js

@@ -3,16 +3,17 @@ import { URL } from "url";
 import { basename, extname } from "path";
 import { randomBytes } from "crypto";
 import { writeFile } from "fs/promises";
-import { request, getGlobalDispatcher } from "undici";
+import { request } from "undici";
 import { logger } from "../logger.js";
 import { MindeeInputSourceError } from "../errors/index.js";
+import { resolveDefaultDispatcher } from "../http/dispatcher.js";
 import { BytesInput } from "./bytesInput.js";
 /** Remote input source represented by a validated HTTPS URL. */
 export class UrlInput extends InputSource {
     constructor({ url, dispatcher }) {
         super();
         this.url = url;
-        this.dispatcher = dispatcher ?? getGlobalDispatcher();
+        this.dispatcher = dispatcher ?? resolveDefaultDispatcher();
         logger.debug("Initialized URL input source.");
     }
     /** Initializes this source by validating and storing the URL. */

package/src/parsing/{localResponseBase.d.ts → baseLocalResponse.d.ts}

@@ -4,8 +4,8 @@ import { Buffer } from "buffer";
  * Local response loaded from a file.
  * Note: Has to be initialized through init() before use.
  */
-export declare abstract class LocalResponseBase {
-    private file;
+export declare abstract class BaseLocalResponse {
+    private fileBytes;
     private readonly inputHandle;
     /** Whether the local response payload has been loaded. */
     protected initialized: boolean;
@@ -33,4 +33,8 @@ export declare abstract class LocalResponseBase {
      * @returns True if the HMAC signature is valid.
      */
     isValidHmacSignature(secretKey: string | Buffer | Uint8Array, signature: string): boolean;
+    /**
+     * Print the file as a UTF-8 string.
+     */
+    toString(): string;
 }

package/src/parsing/{localResponseBase.js → baseLocalResponse.js}

@@ -6,14 +6,20 @@ import { Buffer } from "buffer";
  * Local response loaded from a file.
  * Note: Has to be initialized through init() before use.
  */
-export class LocalResponseBase {
+export class BaseLocalResponse {
     /**
      * Creates an instance of LocalResponse.
      */
     constructor(inputFile) {
         /** Whether the local response payload has been loaded. */
         this.initialized = false;
-        this.file = Buffer.alloc(0);
+        if (inputFile === undefined || inputFile === null) {
+            throw new TypeError("input cannot be null or undefined");
+        }
+        if (typeof inputFile === "string" ? !inputFile.trim() : !inputFile.length) {
+            throw new TypeError("input cannot be empty");
+        }
+        this.fileBytes = Buffer.alloc(0);
         this.inputHandle = inputFile;
     }
     /** Loads the local payload from a string, buffer, or file path. */
@@ -25,7 +31,7 @@ export class LocalResponseBase {
             return;
         }
         if (Buffer.isBuffer(this.inputHandle)) {
-            this.file = this.inputHandle;
+            this.fileBytes = this.inputHandle;
         }
         else if (typeof this.inputHandle === "string") {
             let fileContents;
@@ -36,7 +42,7 @@ export class LocalResponseBase {
             catch {
                 fileContents = this.inputHandle;
             }
-            this.file = Buffer.from(fileContents.replace(/\r/g, "").replace(/\n/g, ""), "utf-8");
+            this.fileBytes = Buffer.from(fileContents.replace(/\r/g, "").replace(/\n/g, ""), "utf-8");
         }
         else {
             throw new MindeeError("Incompatible type for input.");
@@ -52,7 +58,7 @@ export class LocalResponseBase {
             await this.init();
         }
         try {
-            const content = this.file.toString("utf-8");
+            const content = this.fileBytes.toString("utf-8");
             return JSON.parse(content);
         }
         catch {
@@ -71,7 +77,7 @@ export class LocalResponseBase {
         const algorithm = "sha256";
         try {
             const hmac = crypto.createHmac(algorithm, secretKey);
-            hmac.update(this.file);
+            hmac.update(this.fileBytes);
             return hmac.digest("hex");
         }
         catch {
@@ -88,6 +94,25 @@ export class LocalResponseBase {
         if (!this.initialized) {
             throw new Error("The `init()` method must be called before calling `isValidHmacSignature()`.");
         }
-        return signature === this.getHmacSignature(secretKey);
+        if ((!signature || !signature?.trim())
+            || (!secretKey || (typeof secretKey === "string" ? !secretKey?.trim() : !secretKey?.length))) {
+            return false;
+        }
+        const expectedSignature = this.getHmacSignature(secretKey);
+        if (!expectedSignature?.trim()) {
+            return false;
+        }
+        const expectedBytes = Buffer.from(expectedSignature, "utf-8");
+        const actualBytes = Buffer.from(signature.toLowerCase(), "utf-8");
+        if (expectedBytes.length !== actualBytes.length) {
+            return false;
+        }
+        return crypto.timingSafeEqual(expectedBytes, actualBytes);
+    }
+    /**
+     * Print the file as a UTF-8 string.
+     */
+    toString() {
+        return this.fileBytes.toString("utf-8");
     }
 }

package/src/pdf/pdfCompressor.js

@@ -22,7 +22,6 @@ async function getPdfLib() {
  * @returns A Promise resolving to the compressed PDF as a Buffer.
  */
 export async function compressPdf(pdfData, imageQuality = 85, forceSourceTextCompression = false, disableSourceText = true) {
-    handleCompressionWarnings(forceSourceTextCompression, disableSourceText);
     if (await hasSourceText(pdfData)) {
         if (forceSourceTextCompression) {
             if (!disableSourceText) {
@@ -48,22 +47,6 @@ export async function compressPdf(pdfData, imageQuality = 85, forceSourceTextCom
     }
     return createNewPdfFromCompressedPages(compressedPages);
 }
-/**
- * Handles compression warnings based on the provided parameters.
- * @param forceSourceTextCompression If true, attempts to re-write detected text.
- * @param disableSourceText If true, doesn't re-apply source text to the output PDF.
- */
-function handleCompressionWarnings(forceSourceTextCompression, disableSourceText) {
-    if (forceSourceTextCompression) {
-        if (!disableSourceText) {
-            logger.warn("Re-writing PDF source-text is an EXPERIMENTAL feature.");
-        }
-        else {
-            logger.warn("Source file contains text, but the disable_source_text is set to false. "
-                + "Resulting file will not contain any embedded text.");
-        }
-    }
-}
 /**
  * Compresses PDF pages and returns an array of compressed page buffers.
  * @param pdfData The input PDF as a Buffer.

package/src/v1/http/baseEndpoint.d.ts

@@ -0,0 +1,15 @@
+import { InputSource, PageOptions } from "../../input/index.js";
+import { ApiSettingsV1 } from "../../v1/http/apiSettingsV1.js";
+export declare abstract class BaseEndpoint {
+    /** Settings relating to the API. */
+    settings: ApiSettingsV1;
+    /** Root of the URL for API calls. */
+    urlRoot: string;
+    protected constructor(settings: ApiSettingsV1, urlRoot: string);
+    /**
+     * Cuts a document's pages according to the given options.
+     * @param inputDoc input document.
+     * @param pageOptions page cutting options.
+     */
+    cutDocPages(inputDoc: InputSource, pageOptions: PageOptions): Promise<void>;
+}

package/src/v1/http/baseEndpoint.js

@@ -0,0 +1,17 @@
+import { LocalInputSource } from "../../input/index.js";
+export class BaseEndpoint {
+    constructor(settings, urlRoot) {
+        this.settings = settings;
+        this.urlRoot = urlRoot;
+    }
+    /**
+     * Cuts a document's pages according to the given options.
+     * @param inputDoc input document.
+     * @param pageOptions page cutting options.
+     */
+    async cutDocPages(inputDoc, pageOptions) {
+        if (inputDoc instanceof LocalInputSource && inputDoc.isPdf()) {
+            await inputDoc.applyPageOptions(pageOptions);
+        }
+    }
+}

package/src/v1/http/endpoint.d.ts

@@ -3,15 +3,12 @@ import { StringDict } from "../../parsing/stringDict.js";
 import { BaseHttpResponse } from "../../http/apiCore.js";
 import { ApiSettingsV1 } from "./apiSettingsV1.js";
 import { PredictParams } from "./httpParams.js";
+import { BaseEndpoint } from "../../v1/http/baseEndpoint.js";
 /**
  * Endpoint for a product (OTS or Custom).
  */
-export declare class Endpoint {
+export declare class Endpoint extends BaseEndpoint {
     #private;
-    /** Settings relating to the API. */
-    settings: ApiSettingsV1;
-    /** Root of the URL for API calls. */
-    urlRoot: string;
     /** URL of a product. */
     urlName: string;
     /** Account owning the product. */

package/src/v1/http/endpoint.js

@@ -7,17 +7,17 @@ var _Endpoint_instances, _Endpoint_predictReqPost, _Endpoint_predictAsyncReqPost
 import { URLSearchParams } from "url";
 import { FormData } from "undici";
 import { LocalInputSource } from "../../input/index.js";
-import { cutDocPages, sendRequestAndReadResponse, } from "../../http/apiCore.js";
+import { sendRequestAndReadResponse, } from "../../http/apiCore.js";
 import { handleError } from "./errors.js";
 import { isValidAsyncResponse, isValidSyncResponse } from "./responseValidation.js";
+import { BaseEndpoint } from "../../v1/http/baseEndpoint.js";
 /**
  * Endpoint for a product (OTS or Custom).
  */
-export class Endpoint {
+export class Endpoint extends BaseEndpoint {
     constructor(urlName, owner, version, settings) {
+        super(settings, `/v1/products/${owner}/${urlName}/v${version}`);
         _Endpoint_instances.add(this);
-        this.settings = settings;
-        this.urlRoot = `/v1/products/${owner}/${urlName}/v${version}`;
         this.owner = owner;
         this.urlName = urlName;
         this.version = version;
@@ -32,7 +32,7 @@ export class Endpoint {
     async predict(params) {
         await params.inputDoc.init();
         if (params.pageOptions !== undefined) {
-            await cutDocPages(params.inputDoc, params.pageOptions);
+            await this.cutDocPages(params.inputDoc, params.pageOptions);
         }
         const response = await __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_predictReqPost).call(this, params.inputDoc, params.includeWords, params.fullText, params.cropper);
         if (!isValidSyncResponse(response)) {
@@ -50,7 +50,7 @@ export class Endpoint {
     async predictAsync(params) {
         await params.inputDoc.init();
         if (params.pageOptions !== undefined) {
-            await cutDocPages(params.inputDoc, params.pageOptions);
+            await this.cutDocPages(params.inputDoc, params.pageOptions);
         }
         const response = await __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_predictAsyncReqPost).call(this, params.inputDoc, params.includeWords, params.fullText, params.cropper, params.rag, params.workflowId);
         if (!isValidAsyncResponse(response)) {

package/src/v1/http/workflowEndpoint.d.ts

@@ -3,15 +3,12 @@ import { ExecutionPriority } from "../../v1/parsing/common/index.js";
 import { BaseHttpResponse } from "../../http/apiCore.js";
 import { ApiSettingsV1 } from "./apiSettingsV1.js";
 import { WorkflowParams } from "./httpParams.js";
+import { BaseEndpoint } from "../../v1/http/baseEndpoint.js";
 /**
  * Endpoint for a workflow.
  */
-export declare class WorkflowEndpoint {
+export declare class WorkflowEndpoint extends BaseEndpoint {
     #private;
-    /** Settings relating to the API. */
-    settings: ApiSettingsV1;
-    /** Root of the URL for API calls. */
-    urlRoot: string;
     constructor(settings: ApiSettingsV1, workflowId: string);
     /**
      * Sends a document to a workflow execution.

package/src/v1/http/workflowEndpoint.js

@@ -7,17 +7,17 @@ var _WorkflowEndpoint_instances, _WorkflowEndpoint_workflowReqPost;
 import { URLSearchParams } from "url";
 import { FormData } from "undici";
 import { LocalInputSource } from "../../input/index.js";
-import { cutDocPages, sendRequestAndReadResponse, } from "../../http/apiCore.js";
+import { sendRequestAndReadResponse, } from "../../http/apiCore.js";
 import { handleError } from "./errors.js";
 import { isValidSyncResponse } from "./responseValidation.js";
+import { BaseEndpoint } from "../../v1/http/baseEndpoint.js";
 /**
  * Endpoint for a workflow.
  */
-export class WorkflowEndpoint {
+export class WorkflowEndpoint extends BaseEndpoint {
     constructor(settings, workflowId) {
+        super(settings, `/v1/workflows/${workflowId}/executions`);
         _WorkflowEndpoint_instances.add(this);
-        this.settings = settings;
-        this.urlRoot = `/v1/workflows/${workflowId}/executions`;
     }
     /**
      * Sends a document to a workflow execution.
@@ -29,7 +29,7 @@ export class WorkflowEndpoint {
     async executeWorkflow(params) {
         await params.inputDoc.init();
         if (params.pageOptions !== undefined) {
-            await cutDocPages(params.inputDoc, params.pageOptions);
+            await this.cutDocPages(params.inputDoc, params.pageOptions);
         }
         const response = await __classPrivateFieldGet(this, _WorkflowEndpoint_instances, "m", _WorkflowEndpoint_workflowReqPost).call(this, params);
         if (!isValidSyncResponse(response)) {

package/src/v1/parsing/localResponse.d.ts

@@ -1,11 +1,11 @@
-import { LocalResponseBase } from "../../parsing/localResponseBase.js";
+import { BaseLocalResponse } from "../../parsing/baseLocalResponse.js";
 import { AsyncPredictResponse, Inference, PredictResponse } from "../../v1/index.js";
 import { StringDict } from "../../parsing/index.js";
 /**
  * Local response loaded from a file.
  * Note: Has to be initialized through init() before use.
  */
-export declare class LocalResponse extends LocalResponseBase {
+export declare class LocalResponse extends BaseLocalResponse {
     /** Loads a local JSON payload into a typed prediction response wrapper. */
     loadPrediction<T extends Inference>(productClass: new (httpResponse: StringDict) => T): Promise<AsyncPredictResponse<T> | PredictResponse<T>>;
 }

package/src/v1/parsing/localResponse.js

@@ -1,11 +1,11 @@
-import { LocalResponseBase } from "../../parsing/localResponseBase.js";
+import { BaseLocalResponse } from "../../parsing/baseLocalResponse.js";
 import { AsyncPredictResponse, PredictResponse } from "../../v1/index.js";
 import { MindeeError } from "../../errors/index.js";
 /**
  * Local response loaded from a file.
  * Note: Has to be initialized through init() before use.
  */
-export class LocalResponse extends LocalResponseBase {
+export class LocalResponse extends BaseLocalResponse {
     /** Loads a local JSON payload into a typed prediction response wrapper. */
     async loadPrediction(productClass) {
         /**

package/src/v2/client.d.ts

@@ -5,6 +5,7 @@ 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";
+import { BaseSearch } from "../v2/search/baseSearch.js";
 /**
  * Options for the V2 Mindee Client.
  * @example
@@ -37,8 +38,16 @@ export declare class Client {
      * @param name Optional name filter.
      * @param modelType Optional model type filter.
      * @returns a `Promise` containing the search response.
+     * @deprecated Use `search(ModelSearch, {})` instead.
      */
     searchModels(name?: string, modelType?: string): Promise<SearchResponse>;
+    /**
+     * Search for resources matching the given criteria.
+     * @param search Search definition class to use.
+     * @param searchParameters Search parameters.
+     * @returns a `Promise` containing the search response with the matching resources.
+     */
+    search<S extends typeof BaseSearch>(search: S, searchParameters: InstanceType<S["parametersClass"]> | ConstructorParameters<S["parametersClass"]>[0]): Promise<InstanceType<S["responseClass"]>>;
     /** Enqueues a product inference job without waiting for completion. */
     enqueue<P extends typeof BaseProduct>(product: P, inputSource: InputSource, params: InstanceType<P["parametersClass"]> | ConstructorParameters<P["parametersClass"]>[0]): Promise<JobResponse>;
     /**

package/src/v2/client.js

@@ -5,6 +5,7 @@ import { LOG_LEVELS, logger } from "../logger.js";
 import { MindeeApiV2 } from "./http/mindeeApiV2.js";
 import { MindeeHttpErrorV2 } from "./http/errors.js";
 import { PollingOptions } from "./clientOptions/index.js";
+import { ModelSearch } from "../v2/search/models/modelSearch.js";
 /**
  * Mindee Client V2 class that centralizes most basic operations.
  */
@@ -30,9 +31,25 @@ export class Client {
      * @param name Optional name filter.
      * @param modelType Optional model type filter.
      * @returns a `Promise` containing the search response.
+     * @deprecated Use `search(ModelSearch, {})` instead.
      */
     async searchModels(name, modelType) {
-        return await this.mindeeApi.reqGetSearchModel(name, modelType);
+        return await this.search(ModelSearch, { name: name, modelType: modelType });
+    }
+    /**
+     * Search for resources matching the given criteria.
+     * @param search Search definition class to use.
+     * @param searchParameters Search parameters.
+     * @returns a `Promise` containing the search response with the matching resources.
+     */
+    async search(search, searchParameters) {
+        if (!searchParameters) {
+            throw new MindeeError("Search parameters are required.");
+        }
+        const paramsInstance = searchParameters instanceof search.parametersClass
+            ? searchParameters
+            : new search.parametersClass(searchParameters);
+        return await this.mindeeApi.reqGetSearch(search, paramsInstance);
     }
     /** Enqueues a product inference job without waiting for completion. */
     async enqueue(product, inputSource, params) {

package/src/v2/clientOptions/{baseParameters.d.ts → baseProductParameters.d.ts}

@@ -1,28 +1,16 @@
-import { FormData } from "undici";
 /**
  * Constructor parameters for BaseParameters and its subclasses.
  */
-export interface BaseParametersConstructor {
+export interface BaseProductParametersConstructor {
     modelId: string;
     alias?: string;
     webhookIds?: string[];
     closeFile?: boolean;
 }
 /**
- * Parameters accepted by all v2 products.
- *
- * All fields are optional except `modelId`.
- *
- * @category ClientV2
- * @example
- * const params = {
- *   modelId: "YOUR_MODEL_ID",
- *   rag: true,
- *   alias: "YOUR_ALIAS",
- *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
- * };
+ * Base parameters for sending a file to a Mindee V2 product.
  */
-export declare abstract class BaseParameters {
+export declare abstract class BaseProductParameters {
     /**
      * Model ID to use for the inference. **Required.**
      */
@@ -43,10 +31,10 @@ export declare abstract class BaseParameters {
      * Set to `false` to keep it open.
      */
     closeFile?: boolean;
-    protected constructor(params: BaseParametersConstructor);
+    protected constructor(params: BaseProductParametersConstructor);
     /**
-     * Returns the form data to send to the API.
-     * @returns A `FormData` object.
+     * Gets the request parameters for the enqueue request.
+     * @returns A `Record` mapping parameter names to their string values.
      */
-    getFormData(): FormData;
+    getRequestParameters(): Record<string, string>;
 }

package/src/v2/clientOptions/baseProductParameters.js

@@ -0,0 +1,30 @@
+import { MindeeConfigurationError } from "../../errors/index.js";
+/**
+ * Base parameters for sending a file to a Mindee V2 product.
+ */
+export class BaseProductParameters {
+    constructor(params) {
+        if (params.modelId === undefined || params.modelId === null || params.modelId === "") {
+            throw new MindeeConfigurationError("Model ID must be provided");
+        }
+        this.modelId = params.modelId;
+        this.alias = params.alias;
+        this.webhookIds = params.webhookIds;
+        this.closeFile = params.closeFile;
+    }
+    /**
+     * Gets the request parameters for the enqueue request.
+     * @returns A `Record` mapping parameter names to their string values.
+     */
+    getRequestParameters() {
+        const parameters = {};
+        parameters["model_id"] = this.modelId;
+        if (this.alias !== undefined && this.alias !== null) {
+            parameters["alias"] = this.alias;
+        }
+        if (this.webhookIds && this.webhookIds.length > 0) {
+            parameters["webhook_ids"] = this.webhookIds.join(",");
+        }
+        return parameters;
+    }
+}

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

@@ -0,0 +1,26 @@
+/**
+ * Constructor parameters for BaseSearchParameters and its subclasses.
+ */
+export interface BaseSearchParametersConstructor {
+    page?: number;
+    perPage?: number;
+}
+/**
+ * Base parameters for searches.
+ */
+export declare abstract class BaseSearchParameters {
+    /**
+     * 1-based page index.
+     */
+    page?: number;
+    /**
+     * Number of items per page.
+     */
+    perPage?: number;
+    protected constructor(params: BaseSearchParametersConstructor);
+    /**
+     * Gets the request parameters for the search request.
+     * @returns A `Record` mapping parameter names to their string values.
+     */
+    getRequestParameters(): Record<string, string>;
+}