mindee 4.9.0 → 4.9.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## v4.9.1 - 2024-03-05
+### Changes
+* :recycle: update error handling to account for future evolutions
+* :recycle: expose the input, geometry & imageOperations modules in internals for better fine-tuning
+* :recycle: fix inconsistencies with naming conventions
+* :memo: add missing reference documentation
+
+
 ## v4.9.0 - 2024-02-21
 ### Changes
 * :sparkles: add support for resume V1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "4.9.0",
+    "version": "4.9.1",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",

package/src/errors/handler.d.ts

@@ -1,7 +1,9 @@
-declare class ErrorHandler {
+/**
+ * Custom Error handling class.
+ */
+export declare class ErrorHandler {
     throwOnError: boolean;
     constructor(throwOnError?: boolean);
     throw(error: Error): void;
 }
 export declare const errorHandler: ErrorHandler;
-export {};

package/src/errors/handler.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.errorHandler = void 0;
+exports.errorHandler = exports.ErrorHandler = void 0;
 const logger_1 = require("../logger");
+/**
+ * Custom Error handling class.
+ */
 class ErrorHandler {
     constructor(throwOnError = true) {
         this.throwOnError = throwOnError;
@@ -15,4 +18,5 @@ class ErrorHandler {
         }
     }
 }
+exports.ErrorHandler = ErrorHandler;
 exports.errorHandler = new ErrorHandler();

package/src/errors/index.d.ts

@@ -1 +1 @@
-export { MindeeError, MindeeMimeTypeError } from "./MindeeError";
+export { MindeeError, MindeeMimeTypeError } from "./mindeeError";

package/src/errors/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MindeeMimeTypeError = exports.MindeeError = void 0;
-var MindeeError_1 = require("./MindeeError");
-Object.defineProperty(exports, "MindeeError", { enumerable: true, get: function () { return MindeeError_1.MindeeError; } });
-Object.defineProperty(exports, "MindeeMimeTypeError", { enumerable: true, get: function () { return MindeeError_1.MindeeMimeTypeError; } });
+var mindeeError_1 = require("./mindeeError");
+Object.defineProperty(exports, "MindeeError", { enumerable: true, get: function () { return mindeeError_1.MindeeError; } });
+Object.defineProperty(exports, "MindeeMimeTypeError", { enumerable: true, get: function () { return mindeeError_1.MindeeMimeTypeError; } });

package/src/errors/{MindeeError.d.ts → mindeeError.d.ts}

@@ -1,6 +1,12 @@
+/**
+ * Main Mindee Error custom class.
+ */
 export declare class MindeeError extends Error {
     constructor(message: string);
 }
+/**
+ * Custom Mindee error relating to improper mimetypes in inputs.
+ */
 export declare class MindeeMimeTypeError extends MindeeError {
     constructor(message: string);
 }

package/src/errors/{MindeeError.js → mindeeError.js}

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MindeeMimeTypeError = exports.MindeeError = void 0;
+/**
+ * Main Mindee Error custom class.
+ */
 class MindeeError extends Error {
     constructor(message) {
         super(message);
@@ -8,6 +11,9 @@ class MindeeError extends Error {
     }
 }
 exports.MindeeError = MindeeError;
+/**
+ * Custom Mindee error relating to improper mimetypes in inputs.
+ */
 class MindeeMimeTypeError extends MindeeError {
     constructor(message) {
         super(message);

package/src/http/apiSettings.js

@@ -24,6 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiSettings = exports.STANDARD_API_OWNER = exports.API_HOST_ENVVAR_NAME = exports.API_KEY_ENVVAR_NAME = void 0;
+/* eslint-disable @typescript-eslint/naming-convention */
 const logger_1 = require("../logger");
 const package_json_1 = require("../../package.json");
 const os = __importStar(require("os"));

package/src/http/endpoint.js

@@ -15,6 +15,7 @@ const form_data_1 = __importDefault(require("form-data"));
 const base_1 = require("../input/base");
 const error_1 = require("./error");
 const baseEndpoint_1 = require("./baseEndpoint");
+const responseValidation_1 = require("./responseValidation");
 /**
  * Endpoint for a product (OTS or Custom).
  */
@@ -40,9 +41,8 @@ class Endpoint extends baseEndpoint_1.BaseEndpoint {
             await __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_cutDocPages).call(this, params.inputDoc, params.pageOptions);
         }
         const response = await __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_predictReqPost).call(this, params.inputDoc, params.includeWords, params.cropper);
-        const statusCode = response.messageObj.statusCode;
-        if (statusCode === undefined || statusCode >= 400) {
-            (0, error_1.handleError)(this.urlName, response, statusCode, response.messageObj?.statusMessage);
+        if (!(0, responseValidation_1.isValidSyncResponse)(response)) {
+            (0, error_1.handleError)(this.urlName, response, response.messageObj?.statusMessage);
         }
         return response;
     }
@@ -59,9 +59,8 @@ class Endpoint extends baseEndpoint_1.BaseEndpoint {
             await __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_cutDocPages).call(this, params.inputDoc, params.pageOptions);
         }
         const response = await __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_predictAsyncReqPost).call(this, params.inputDoc, params.includeWords, params.cropper);
-        const statusCode = response.messageObj.statusCode;
-        if (statusCode === undefined || statusCode >= 400) {
-            (0, error_1.handleError)(this.urlName, response, statusCode, response.messageObj?.statusMessage);
+        if (!(0, responseValidation_1.isValidAsyncResponse)(response)) {
+            (0, error_1.handleError)(this.urlName, response, response.messageObj?.statusMessage);
         }
         return response;
     }
@@ -75,10 +74,8 @@ class Endpoint extends baseEndpoint_1.BaseEndpoint {
     async getQueuedDocument(queueId) {
         const queueResponse = await __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_documentQueueReqGet).call(this, queueId);
         const queueStatusCode = queueResponse.messageObj.statusCode;
-        if (queueStatusCode === undefined ||
-            queueStatusCode < 200 ||
-            queueStatusCode > 400) {
-            (0, error_1.handleError)(this.urlName, queueResponse, queueStatusCode, queueResponse.messageObj?.statusMessage);
+        if (!(0, responseValidation_1.isValidAsyncResponse)(queueResponse)) {
+            (0, error_1.handleError)(this.urlName, queueResponse, queueResponse.messageObj?.statusMessage);
         }
         if (queueStatusCode === 302 &&
             queueResponse.messageObj.headers.location !== undefined) {
@@ -95,9 +92,8 @@ class Endpoint extends baseEndpoint_1.BaseEndpoint {
      */
     async getDocument(documentId) {
         const response = await __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_documentGetReq).call(this, documentId);
-        const statusCode = response.messageObj.statusCode;
-        if (statusCode === undefined || statusCode >= 400) {
-            (0, error_1.handleError)("document", response, statusCode, response.messageObj?.statusMessage);
+        if (!(0, responseValidation_1.isValidAsyncResponse)(response)) {
+            (0, error_1.handleError)("document", response, response.messageObj?.statusMessage);
         }
         return response;
     }
@@ -108,9 +104,8 @@ class Endpoint extends baseEndpoint_1.BaseEndpoint {
      */
     async sendFeedback(documentId, feedback) {
         const response = await __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_documentFeedbackPutReq).call(this, documentId, feedback);
-        const statusCode = response.messageObj.statusCode;
-        if (statusCode === undefined || statusCode >= 400) {
-            (0, error_1.handleError)("feedback", response, statusCode, response.messageObj?.statusMessage);
+        if (!(0, responseValidation_1.isValidSyncResponse)(response)) {
+            (0, error_1.handleError)("feedback", response, response.messageObj?.statusMessage);
         }
         return response;
     }

package/src/http/error.d.ts

@@ -1,7 +1,7 @@
 import { MindeeError } from "../errors";
 import { StringDict } from "../parsing/common";
 import { EndpointResponse } from "./baseEndpoint";
-export declare function handleError(urlName: string, response: EndpointResponse, code?: number, serverError?: string): void;
+export declare function handleError(urlName: string, response: EndpointResponse, serverError?: string): void;
 /**
  * `Error` wrapper for server (HTTP) errors.
  * Is used when an error is lacking a handled error code.

package/src/http/error.js

@@ -3,9 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MindeeHttp504Error = exports.MindeeHttp500Error = exports.MindeeHttp429Error = exports.MindeeHttp413Error = exports.MindeeHttp404Error = exports.MindeeHttp403Error = exports.MindeeHttp401Error = exports.MindeeHttp400Error = exports.MindeeHttpError = exports.handleError = void 0;
 const errors_1 = require("../errors");
 const handler_1 = require("../errors/handler");
-function handleError(urlName, response, code, serverError) {
-    if (code === undefined) {
-        throw new MindeeHttpError({ message: "Missing HTTP Error code.", details: response.data, undefined }, urlName);
+function handleError(urlName, response, serverError) {
+    let code;
+    if (response.messageObj.statusCode && !Number.isNaN(response.data.statusCode)) {
+        code = response.messageObj.statusCode;
+    }
+    else {
+        code = 500;
     }
     let errorObj;
     try {

package/src/http/index.d.ts

@@ -2,3 +2,4 @@ export { Endpoint } from "./endpoint";
 export { EndpointResponse } from "./baseEndpoint";
 export { STANDARD_API_OWNER, API_KEY_ENVVAR_NAME, ApiSettings, } from "./apiSettings";
 export { MindeeHttpError, MindeeHttp400Error, MindeeHttp401Error, MindeeHttp403Error, MindeeHttp404Error, MindeeHttp413Error, MindeeHttp429Error, MindeeHttp500Error, MindeeHttp504Error, handleError, } from "./error";
+export { isValidSyncResponse, isValidAsyncResponse, cleanRequestData, } from "./responseValidation";

package/src/http/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleError = exports.MindeeHttp504Error = exports.MindeeHttp500Error = exports.MindeeHttp429Error = exports.MindeeHttp413Error = exports.MindeeHttp404Error = exports.MindeeHttp403Error = exports.MindeeHttp401Error = exports.MindeeHttp400Error = exports.MindeeHttpError = exports.ApiSettings = exports.API_KEY_ENVVAR_NAME = exports.STANDARD_API_OWNER = exports.Endpoint = void 0;
+exports.cleanRequestData = exports.isValidAsyncResponse = exports.isValidSyncResponse = exports.handleError = exports.MindeeHttp504Error = exports.MindeeHttp500Error = exports.MindeeHttp429Error = exports.MindeeHttp413Error = exports.MindeeHttp404Error = exports.MindeeHttp403Error = exports.MindeeHttp401Error = exports.MindeeHttp400Error = exports.MindeeHttpError = exports.ApiSettings = exports.API_KEY_ENVVAR_NAME = exports.STANDARD_API_OWNER = exports.Endpoint = void 0;
 var endpoint_1 = require("./endpoint");
 Object.defineProperty(exports, "Endpoint", { enumerable: true, get: function () { return endpoint_1.Endpoint; } });
 var apiSettings_1 = require("./apiSettings");
@@ -18,3 +18,7 @@ Object.defineProperty(exports, "MindeeHttp429Error", { enumerable: true, get: fu
 Object.defineProperty(exports, "MindeeHttp500Error", { enumerable: true, get: function () { return error_1.MindeeHttp500Error; } });
 Object.defineProperty(exports, "MindeeHttp504Error", { enumerable: true, get: function () { return error_1.MindeeHttp504Error; } });
 Object.defineProperty(exports, "handleError", { enumerable: true, get: function () { return error_1.handleError; } });
+var responseValidation_1 = require("./responseValidation");
+Object.defineProperty(exports, "isValidSyncResponse", { enumerable: true, get: function () { return responseValidation_1.isValidSyncResponse; } });
+Object.defineProperty(exports, "isValidAsyncResponse", { enumerable: true, get: function () { return responseValidation_1.isValidAsyncResponse; } });
+Object.defineProperty(exports, "cleanRequestData", { enumerable: true, get: function () { return responseValidation_1.cleanRequestData; } });

package/src/http/responseValidation.d.ts

@@ -0,0 +1,23 @@
+import { EndpointResponse } from "./baseEndpoint";
+/**
+ * Checks if the synchronous response is valid. Returns True if the response is valid.
+ *
+ * @param response an endpoint response object.
+ * @returns bool
+ */
+export declare function isValidSyncResponse(response: EndpointResponse): boolean;
+/**
+ * Checks if the asynchronous response is valid. Also checks if it is a valid synchronous response.
+ * Returns True if the response is valid.
+ *
+ * @param response an endpoint response object.
+ * @returns bool
+ */
+export declare function isValidAsyncResponse(response: EndpointResponse): boolean;
+/**
+ * Checks and correct the response object depending on the possible kinds of returns.
+ *
+ * @param response an endpoint response object.
+ * @returns EndpointResponse Returns the job error if the error is due to parsing, returns the http error otherwise.
+ */
+export declare function cleanRequestData(response: EndpointResponse): EndpointResponse;

package/src/http/responseValidation.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cleanRequestData = exports.isValidAsyncResponse = exports.isValidSyncResponse = void 0;
+/**
+ * Checks if the synchronous response is valid. Returns True if the response is valid.
+ *
+ * @param response an endpoint response object.
+ * @returns bool
+ */
+function isValidSyncResponse(response) {
+    if (!response.messageObj || !response.messageObj.statusCode) {
+        return false;
+    }
+    return !(isNaN(response.messageObj.statusCode) || parseInt(response.messageObj.statusCode.toString()) < 200 || parseInt(response.messageObj.statusCode.toString()) > 302);
+}
+exports.isValidSyncResponse = isValidSyncResponse;
+/**
+ * Checks if the asynchronous response is valid. Also checks if it is a valid synchronous response.
+ * Returns True if the response is valid.
+ *
+ * @param response an endpoint response object.
+ * @returns bool
+ */
+function isValidAsyncResponse(response) {
+    if (!isValidSyncResponse(response)) {
+        return false;
+    }
+    if (response.messageObj.statusCode) {
+        if (response.messageObj.statusCode >= 300 && response.messageObj.statusCode <= 302) {
+            // Skip next check for redirections as the final payload will be checked anyway.
+            return true;
+        }
+        else if (response.messageObj.statusCode < 200 || response.messageObj.statusCode > 302) {
+            return false;
+        }
+    }
+    if (!response.data["job"]) {
+        return false;
+    }
+    return !(response.data["job"] && response.data["job"]["error"] && Object.keys(response.data["job"]["error"]).length > 0);
+}
+exports.isValidAsyncResponse = isValidAsyncResponse;
+/**
+ * Checks and correct the response object depending on the possible kinds of returns.
+ *
+ * @param response an endpoint response object.
+ * @returns EndpointResponse Returns the job error if the error is due to parsing, returns the http error otherwise.
+ */
+function cleanRequestData(response) {
+    if (response.messageObj &&
+        response.messageObj.statusCode &&
+        (response.messageObj.statusCode < 200 ||
+            response.messageObj.statusCode > 302)) {
+        return response;
+    }
+    if (response.data) {
+        if (response.data["api_request"] && response.data["api_request"]["status_code"] && parseInt(response.data["api_request"]["status_code"].toString()) > 399) {
+            response.messageObj.statusCode = parseInt(response.data["api_request"]["status_code"].toString());
+        }
+        if (response.data["job"] && response.data["job"]["error"] && Object.keys(response.data["job"]["error"]).length > 0) {
+            response.messageObj.statusCode = 500;
+        }
+    }
+    return response;
+}
+exports.cleanRequestData = cleanRequestData;

package/src/input/pageOptions.d.ts

@@ -1,4 +1,6 @@
-/** Options to pass to the `parse` method for cutting multi-page documents. */
+/**
+ * Options to pass to the `parse` method for cutting multi-page documents.
+ */
 export interface PageOptions {
     /**
      * Zero-based list of page indexes.
@@ -15,7 +17,9 @@ export interface PageOptions {
      */
     onMinPages: number;
 }
-/** Operation to apply on the document, given the page indexes specified. */
+/**
+ * Operation to apply on the document, given the page indexes specified.
+ */
 export declare enum PageOptionsOperation {
     /** Only keep pages matching the provided indexes. */
     KeepOnly = "KEEP_ONLY",

package/src/input/pageOptions.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PageOptionsOperation = void 0;
-/** Operation to apply on the document, given the page indexes specified. */
+/**
+ * Operation to apply on the document, given the page indexes specified.
+ */
 var PageOptionsOperation;
 (function (PageOptionsOperation) {
     /** Only keep pages matching the provided indexes. */

package/src/internal.d.ts

@@ -1,5 +1,7 @@
-export * as product from "./product/internal";
-export * as parsing from "./parsing";
-export * as pdf from "./pdf";
+export * as input from "./input";
 export * as geometry from "./geometry";
 export * as http from "./http";
+export * as imageOperations from "./imageOperations/internal";
+export * as parsing from "./parsing";
+export * as pdf from "./pdf";
+export * as product from "./product/internal";

package/src/internal.js

@@ -23,9 +23,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.http = exports.geometry = exports.pdf = exports.parsing = exports.product = void 0;
-exports.product = __importStar(require("./product/internal"));
-exports.parsing = __importStar(require("./parsing"));
-exports.pdf = __importStar(require("./pdf"));
+exports.product = exports.pdf = exports.parsing = exports.imageOperations = exports.http = exports.geometry = exports.input = void 0;
+exports.input = __importStar(require("./input"));
 exports.geometry = __importStar(require("./geometry"));
 exports.http = __importStar(require("./http"));
+exports.imageOperations = __importStar(require("./imageOperations/internal"));
+exports.parsing = __importStar(require("./parsing"));
+exports.pdf = __importStar(require("./pdf"));
+exports.product = __importStar(require("./product/internal"));

package/src/parsing/common/asyncPredictResponse.d.ts

@@ -12,6 +12,8 @@ export declare class Job {
     issuedAt: Date;
     /** Timestamp noting the availability of a prediction for an enqueued document. */
     availableAt?: Date;
+    /** Information about an error that occurred during the job processing. */
+    error?: StringDict;
     /** ID of the job. */
     id: string;
     /** Status of the job. */