mindee 5.7.0 → 5.7.1

package/CHANGELOG.md

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

package/package.json

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

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/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

@@ -42,10 +42,10 @@ export declare class Client {
      */
     searchModels(name?: string, modelType?: string): Promise<SearchResponse>;
     /**
-     * Searches for resources matching the given criteria.
-     * @param search
+     * 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.
+     * @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. */

package/src/v2/client.js

@@ -37,10 +37,10 @@ export class Client {
         return await this.search(ModelSearch, { name: name, modelType: modelType });
     }
     /**
-     * Searches for resources matching the given criteria.
-     * @param search
+     * 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.
+     * @returns a `Promise` containing the search response with the matching resources.
      */
     async search(search, searchParameters) {
         if (!searchParameters) {

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

@@ -51,8 +51,8 @@ export declare class MindeeApiV2 {
      */
     reqGetProductResultByUrl<P extends typeof BaseProduct>(product: P, url: string): Promise<InstanceType<P["responseClass"]>>;
     /**
-     * Searches for resources matching the given criteria.
-     * @param search
+     * Retrieves a list of resources with the given criteria.
+     * @param search Search definition class to use.
      * @param parameters Search parameters.
      * @returns a `Promise` containing the search response.
      */

package/src/v2/http/mindeeApiV2.js

@@ -106,8 +106,8 @@ export class MindeeApiV2 {
         return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, response, product.responseClass);
     }
     /**
-     * Searches for resources matching the given criteria.
-     * @param search
+     * Retrieves a list of resources with the given criteria.
+     * @param search Search definition class to use.
      * @param parameters Search parameters.
      * @returns a `Promise` containing the search response.
      */

package/src/v2/parsing/inference/field/ragMetadata.d.ts

@@ -1,5 +1,5 @@
 import { StringDict } from "../../../../parsing/stringDict.js";
-/** Metadata produced by RAG-enabled extraction. */
+/** Metadata about the RAG operation. */
 export declare class RagMetadata {
     /**
      * The UUID of the matched document used during the RAG operation.

package/src/v2/parsing/inference/field/ragMetadata.js

@@ -1,4 +1,4 @@
-/** Metadata produced by RAG-enabled extraction. */
+/** Metadata about the RAG operation. */
 export class RagMetadata {
     constructor(serverResponse) {
         this.retrievedDocumentId = serverResponse["retrieved_document_id"] ?? undefined;

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

@@ -1,11 +1,11 @@
 import { StringDict } from "../../parsing/stringDict.js";
-import { LocalResponseBase } from "../../parsing/localResponseBase.js";
+import { BaseLocalResponse } from "../../parsing/baseLocalResponse.js";
 import { BaseResponse } from "./baseResponse.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 {
     /**
      * Deserialize the loaded local response into a product response class.
      *

package/src/v2/parsing/localResponse.js

@@ -1,10 +1,10 @@
 import { MindeeError } from "../../errors/index.js";
-import { LocalResponseBase } from "../../parsing/localResponseBase.js";
+import { BaseLocalResponse } from "../../parsing/baseLocalResponse.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 {
     /**
      * Deserialize the loaded local response into a product response class.
      *

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

@@ -11,7 +11,8 @@ export declare abstract class BaseSearchResponse extends BaseResponse {
     pagination: PaginationMetadata;
     protected constructor(serverResponse: StringDict);
     /**
-     * List of strings representing the search response.
+     * Lines composing the response-specific body (header + items).
+     * @returns An array of body lines.
      */
     protected abstract bodyLines(): string[];
     toString(): string;

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

@@ -1,6 +1,6 @@
 import { StringDict } from "../../../parsing/index.js";
 /**
- * Model webhook info.
+ * Information about a model's webhook.
  */
 export declare class ModelWebhook {
     /**

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

@@ -1,5 +1,5 @@
 /**
- * Model webhook info.
+ * Information about a model's webhook.
  */
 export class ModelWebhook {
     constructor(serverResponse) {

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

@@ -1,6 +1,6 @@
 import { StringDict } from "../../../parsing/index.js";
 /**
- * PaginationMetadata data associated with model search.
+ * Pagination metadata associated with searches.
  */
 export declare class PaginationMetadata {
     /**

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

@@ -1,5 +1,5 @@
 /**
- * PaginationMetadata data associated with model search.
+ * Pagination metadata associated with searches.
  */
 export class PaginationMetadata {
     constructor(serverResponse) {

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

@@ -1,7 +1,7 @@
 import { StringDict } from "../../../parsing/index.js";
 import { ModelWebhook } from "./modelWebhook.js";
 /**
- * Models search response.
+ * Individual model information.
  */
 export declare class SearchModel {
     /**
@@ -17,7 +17,7 @@ export declare class SearchModel {
      */
     modelType: string;
     /**
-     * Webhooks associated with the model.
+     * List of webhooks associated with the model.
      */
     webhooks: ModelWebhook[];
     constructor(serverResponse: StringDict);

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

@@ -1,6 +1,6 @@
 import { ModelWebhook } from "./modelWebhook.js";
 /**
- * Models search response.
+ * Individual model information.
  */
 export class SearchModel {
     constructor(serverResponse) {

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

@@ -1,5 +1,8 @@
 import { SearchModel } from "../../../v2/parsing/search/searchModel.js";
 import { StringDict } from "../../../parsing/index.js";
+/**
+ * List of search models.
+ */
 export declare class SearchModels extends Array<SearchModel> {
     constructor(serverResponse?: StringDict[]);
     toString(): string;

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

@@ -1,4 +1,7 @@
 import { SearchModel } from "../../../v2/parsing/search/searchModel.js";
+/**
+ * List of search models.
+ */
 export class SearchModels extends Array {
     constructor(serverResponse = []) {
         super();

package/src/v2/search/models/modelSearch.d.ts

@@ -2,7 +2,12 @@ import { ModelSearchParameters } from "../../../v2/search/index.js";
 import { BaseSearch } from "../../../v2/search/baseSearch.js";
 import { ModelSearchResponse } from "../../../v2/search/models/modelSearchResponse.js";
 /**
- * Search for models.
+ * Search for models within the organization linked to the API key.
+ *
+ * All search filters are optional.
+ * If no search filters are given, all models belonging to the organization are returned.
+ *
+ * Results are paginated.
  */
 export declare class ModelSearch extends BaseSearch {
     /** @inheritDoc */

package/src/v2/search/models/modelSearch.js

@@ -2,7 +2,12 @@ import { ModelSearchParameters } from "../../../v2/search/index.js";
 import { BaseSearch } from "../../../v2/search/baseSearch.js";
 import { ModelSearchResponse } from "../../../v2/search/models/modelSearchResponse.js";
 /**
- * Search for models.
+ * Search for models within the organization linked to the API key.
+ *
+ * All search filters are optional.
+ * If no search filters are given, all models belonging to the organization are returned.
+ *
+ * Results are paginated.
  */
 export class ModelSearch extends BaseSearch {
     /** @inheritDoc */

package/src/v2/search/models/modelSearchParameters.d.ts

@@ -11,11 +11,11 @@ export interface ModelSearchParametersConstructor extends BaseSearchParametersCo
  */
 export declare class ModelSearchParameters extends BaseSearchParameters {
     /**
-     * Case-insensitive search term for the model name
+     * Filter models by partial name match, case-insensitive.
      */
     name?: string;
     /**
-     * Case-insensitive search term for the model type
+     * Filter by an exact model type.
      */
     modelType?: string;
     constructor(params?: ModelSearchParametersConstructor);

package/src/v2/search/models/modelSearchResponse.d.ts

@@ -6,7 +6,7 @@ import { SearchModels } from "../../../v2/parsing/search/searchModels.js";
  */
 export declare class ModelSearchResponse extends BaseSearchResponse {
     /**
-     * List of models returned by the search.
+     * Paginated list of matching models.
      */
     models: SearchModels;
     constructor(serverResponse: StringDict);

package/src/v2/search/ragDocuments/ragDocumentSearchResponse.d.ts

@@ -2,7 +2,7 @@ import { StringDict } from "../../../parsing/index.js";
 import { BaseSearchResponse } from "../../../v2/parsing/search/index.js";
 import { SearchRagDocuments } from "../../../v2/parsing/search/searchRagDocuments.js";
 /**
- * RAG documents search response.
+ * RAG Documents search response.
  */
 export declare class RagDocumentSearchResponse extends BaseSearchResponse {
     /**

package/src/v2/search/ragDocuments/ragDocumentSearchResponse.js

@@ -1,7 +1,7 @@
 import { BaseSearchResponse } from "../../../v2/parsing/search/index.js";
 import { SearchRagDocuments } from "../../../v2/parsing/search/searchRagDocuments.js";
 /**
- * RAG documents search response.
+ * RAG Documents search response.
  */
 export class RagDocumentSearchResponse extends BaseSearchResponse {
     constructor(serverResponse) {