mindee 4.29.0-rc5 → 4.29.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## v4.29.0 - 2025-08-29
+### Changes
+* :sparkles: add typed accessors for fields, list, object
+* :sparkles: add typed value accessors
+* :sparkles: add geometry methods to polygon class
+### Fixes
+* :bug: Polygon and BoundingBox should be a real classes
+
+
+## v4.29.0-rc6 - 2025-08-22
+### Changes
+* :recycle: rework local and input sources
+
+
 ## v4.29.0-rc5 - 2025-07-30
 ### Changes
 * :recycle: allow direct import of input sources
@@ -30,7 +44,6 @@
 * :recycle: tweak CI & testing
 * :recycle: deprecate `cutPdf()` in favor of `applyPageOperations()` in `LocalInputSource`
 * :recycle: refactor some internals to account for new changes
-
 ### Fixes
 * :bug: fix bug where polling parameters could ignore validation checks on V1
 
@@ -173,7 +186,6 @@
 * :sparkles: add support for FR Payslips V1
 * :sparkles: add support for Nutrition Facts Label V1
 * :recycle: refactor internals to accommodate for new changes
-
 ### Fixes
 * :bug: fix float numbers not containing more 3 decimals in some instances
 * :bug: fix boolean field display issues
@@ -219,7 +231,6 @@
 * :sparkles: add support for HMAC validation for webhooks
 * :sparkles: add support for US Mail V2
 * :sparkles: add support for boolean fields
-
 ### Fixes
 * :recycle: fixed Locale display
 
@@ -237,7 +248,6 @@
 # v4.10.0 - 2024-04-12
 ### Changes
 * :sparkles: update Invoice to v4.5 (#264)
-
 ### Fixes
 * :bug: fix error management not following intended flow (#267)
 * :recycle: deprecated old error handler (#266)
@@ -256,14 +266,12 @@
 * :sparkles: add support for resume V1
 * :sparkles: add support for International ID v2
 * :sparkles: add support for EU Driver License V1
-
 ### Fixes
 :memo: misc doc fixes
 
 ## v4.8.2 - 2024-02-09
 ### Changes
 * :recycle: increased update time for async retries
-
 ### Fixes
 * :bug: fixed improper float parsing for Generated list objects
 * :bug: typescript should now allow the use of default values for enqueueAndParse() async options
@@ -287,7 +295,6 @@
 * :recycle: add CLI entry for generated APIs
 * :memo: add documentation entry for generated APIs
 * :recycle: expose a bit more of our internals for easier use (#247)
-
 ### Fixes
 * :memo: fix invoice v4 md doc
 
@@ -334,7 +341,6 @@
 ## v4.3.2 - 2023-11-07
 ### Changes
 * :recycle: update invoice splitter
-
 ### Fixes
 * :bug: fix display issues when products didn't have pages
 * :memo: fix doc typos
@@ -364,7 +370,6 @@
 * :sparkles: add support for FR Id Card V2
 * :sparkles: add support for OTS Cropper V1
 * :memo: update documentation
-
 ### Fixes
 * :bug: fix missing position field display issues
 * :bug: fix issues with asynchronous timeouts crashing in some instances
@@ -373,7 +378,6 @@
 ## v4.1.1 - 2023-09-04
 ### Changes
 * :recycle: tweaked timer management in async
-
 ### Fixes
 * :bug: fix ocr option not being generated as an Ocr object
 
@@ -390,7 +394,6 @@
 * :recycle: remove deprecated examples
 * :recycle: update linting rules
 * :arrow_up: update testing library
-
 ### Fixes
 * :bug: fix miscellaneous bugs related to http parsing issues
 
@@ -398,7 +401,6 @@
 ## v4.0.2 - 2023-08-24
 ### Changes
 * :recycle: updated technical documentation
-
 ### Fixes
 * :bug: fix url source document not being sent properly
 
@@ -413,7 +415,6 @@
 * :art: :boom: harmonize response types with other libraries
 * :art: :boom: change endpoint management & syntax
 * :art: :boom: move products to `product` module
-
 ### Changes
 * :sparkles: add full support for page-specific attributes
 * :sparkles: add support for FR Id Card
@@ -434,7 +435,6 @@
 ## v3.10.1 - 2023-07-04
 ### Changes
 * :arrow_up: update dependencies
-
 ### Fixes
 * :pencil2: added missing entry in changelog
 
@@ -450,8 +450,6 @@
 ### Changes
 * :sparkles: support for financial document v1.1
 * :recycle: change http status code handling for async requests
-
-
 ### Fixes
 * :bug: fix typing in PaymentDetails
 * :bug: locale value should always be set
@@ -467,7 +465,6 @@
 ## v3.7.4 - 2023-04-20
 ### Changes
 * :white_check_mark: minor improvements to tests
-
 ### Fixes
 * :bug: fix for options not being passed properly in the CLI tool
 
@@ -497,7 +494,6 @@
 * :art: harmonize bbox and bounding box terminology
 * :arrow_up: update test files, minor updates to string output
 * :label: classification fields are always strings
-
 ### Fixes
 * :bug: fix error message for missing API key, document type may be undefined
 
@@ -527,7 +523,6 @@ Usage is otherwise identical.
 ### Changes
 * :memo: updates to class documentation
 * :sparkles: Add invoice splitter support (beta)
-
 ### Fixes
 * :bug: fix for CLI command option description
 
@@ -588,7 +583,6 @@ Usage is otherwise identical.
 * :sparkles: Document (endpoints) are now versioned, providing better backward-compatible support.
 * :recycle: Pass the document class instead of the response class to the `parse` method.
 * :recycle: Some methods and parameters renamed for better clarity.
-
 ### Changes
 * :sparkles: New URL input source, `docFromUrl`.
 * :sparkles: Add support for expense receipts V4
@@ -625,15 +619,14 @@ It's **not** backwards compatible with previous versions.
 
 
 ## v1.4.0
+### Changes
+* :sparkles: Add TIFF and HEIC support
+* :white_check_mark: fully test PDF cut function
 ### Fixes
 * :bug: cut/merge pages of an encrypted PDF leads to unexpected results
 * :bug: logger not activating in some cases
 * :bug: align PDF cut/merge with other client libs
 
-### Changes
-* :sparkles: Add TIFF and HEIC support
-* :white_check_mark: fully test PDF cut function
-
 
 ## v1.3.3
 ### Fixes

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "4.29.0-rc5",
+    "version": "4.29.0",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",
@@ -40,12 +40,12 @@
     },
     "homepage": "https://mindee.com/",
     "devDependencies": {
-        "@types/chai": "^4.3.4",
+        "@types/chai": "^4.3.20",
         "@types/mocha": "^10.0.10",
-        "@types/node": "^18.15.11",
+        "@types/node": "^18.15.13",
         "@types/tmp": "^0.2.6",
-        "@typescript-eslint/eslint-plugin": "^8.36.0",
-        "@typescript-eslint/parser": "^8.36.0",
+        "@typescript-eslint/eslint-plugin": "^8.40.0",
+        "@typescript-eslint/parser": "^8.40.0",
         "chai": "^4.3.10",
         "eslint": "^9.15.0",
         "eslint-plugin-jsdoc": "^50.5.0",

package/src/client.js

@@ -121,10 +121,11 @@ class Client {
          * @returns A valid prediction
          */
         try {
-            if (Object.prototype.hasOwnProperty.call(localResponse.asDict(), "job")) {
-                return new common_1.AsyncPredictResponse(productClass, localResponse.asDict());
+            const asDict = await localResponse.asDict();
+            if (Object.prototype.hasOwnProperty.call(asDict, "job")) {
+                return new common_1.AsyncPredictResponse(productClass, asDict);
             }
-            return new common_1.PredictResponse(productClass, localResponse.asDict());
+            return new common_1.PredictResponse(productClass, asDict);
         }
         catch {
             throw new errors_1.MindeeError("No prediction found in local response.");

package/src/clientV2.d.ts

@@ -1,7 +1,6 @@
-import { Base64Input, BufferInput, BytesInput, InputSource, PathInput, StreamInput, UrlInput } from "./input";
+import { InputSource } from "./input";
 import { InferenceResponse, JobResponse } from "./parsing/v2";
 import { MindeeApiV2 } from "./http/mindeeApiV2";
-import { Readable } from "stream";
 /**
  * Parameters for the internal polling loop in {@link ClientV2.enqueueAndGetInference | enqueueAndGetInference()} .
  *
@@ -145,46 +144,12 @@ export declare class ClientV2 {
      * Send a document to an endpoint and poll the server until the result is sent or
      * until the maximum number of tries is reached.
      *
-     * @param inputDoc document to parse.
+     * @param inputSource file or URL to parse.
      * @param params parameters relating to prediction options.
      *
      * @typeParam T an extension of an `Inference`. Can be omitted as it will be inferred from the `productClass`.
      * @category Synchronous
      * @returns a `Promise` containing parsing results.
      */
-    enqueueAndGetInference(inputDoc: InputSource, params: InferenceParameters): Promise<InferenceResponse>;
-    /**
-     * Load an input source from a local path.
-     * @param inputPath
-     */
-    sourceFromPath(inputPath: string): PathInput;
-    /**
-     * Load an input source from a base64 encoded string.
-     * @param inputString input content, as a string.
-     * @param filename file name.
-     */
-    sourceFromBase64(inputString: string, filename: string): Base64Input;
-    /**
-     * Load an input source from a `stream.Readable` object.
-     * @param inputStream input content, as a readable stream.
-     * @param filename file name.
-     */
-    sourceFromStream(inputStream: Readable, filename: string): StreamInput;
-    /**
-     * Load an input source from bytes.
-     * @param inputBytes input content, as a Uint8Array or Buffer.
-     * @param filename file name.
-     */
-    sourceFromBytes(inputBytes: Uint8Array, filename: string): BytesInput;
-    /**
-     * Load an input source from a Buffer.
-     * @param buffer input content, as a buffer.
-     * @param filename file name.
-     */
-    sourceFromBuffer(buffer: Buffer, filename: string): BufferInput;
-    /**
-     * Load an input source from a URL.
-     * @param url input url. Must be HTTPS.
-     */
-    sourceFromUrl(url: string): UrlInput;
+    enqueueAndGetInference(inputSource: InputSource, params: InferenceParameters): Promise<InferenceResponse>;
 }

package/src/clientV2.js

@@ -7,7 +7,6 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _ClientV2_instances, _ClientV2_setAsyncParams;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientV2 = void 0;
-const input_1 = require("./input");
 const handler_1 = require("./errors/handler");
 const logger_1 = require("./logger");
 const promises_1 = require("node:timers/promises");
@@ -47,6 +46,9 @@ class ClientV2 {
         if (inputSource === undefined) {
             throw new Error("The 'enqueue' function requires an input document.");
         }
+        if (!inputSource.isInitialized()) {
+            await inputSource.init();
+        }
         return await this.mindeeApi.reqPostInferenceEnqueue(inputSource, params);
     }
     /**
@@ -78,16 +80,16 @@ class ClientV2 {
      * Send a document to an endpoint and poll the server until the result is sent or
      * until the maximum number of tries is reached.
      *
-     * @param inputDoc document to parse.
+     * @param inputSource file or URL to parse.
      * @param params parameters relating to prediction options.
      *
      * @typeParam T an extension of an `Inference`. Can be omitted as it will be inferred from the `productClass`.
      * @category Synchronous
      * @returns a `Promise` containing parsing results.
      */
-    async enqueueAndGetInference(inputDoc, params) {
+    async enqueueAndGetInference(inputSource, params) {
         const validatedAsyncParams = __classPrivateFieldGet(this, _ClientV2_instances, "m", _ClientV2_setAsyncParams).call(this, params.pollingOptions);
-        const enqueueResponse = await this.enqueueInference(inputDoc, params);
+        const enqueueResponse = await this.enqueueInference(inputSource, params);
         if (enqueueResponse.job.id === undefined || enqueueResponse.job.id.length === 0) {
             logger_1.logger.error(`Failed enqueueing:\n${enqueueResponse.getRawHttp()}`);
             throw Error("Enqueueing of the document failed.");
@@ -119,68 +121,6 @@ Job status: ${pollResults.job.status}.`);
             validatedAsyncParams.delaySec * retryCounter +
             " seconds");
     }
-    /**
-     * Load an input source from a local path.
-     * @param inputPath
-     */
-    sourceFromPath(inputPath) {
-        return new input_1.PathInput({
-            inputPath: inputPath,
-        });
-    }
-    /**
-     * Load an input source from a base64 encoded string.
-     * @param inputString input content, as a string.
-     * @param filename file name.
-     */
-    sourceFromBase64(inputString, filename) {
-        return new input_1.Base64Input({
-            inputString: inputString,
-            filename: filename,
-        });
-    }
-    /**
-     * Load an input source from a `stream.Readable` object.
-     * @param inputStream input content, as a readable stream.
-     * @param filename file name.
-     */
-    sourceFromStream(inputStream, filename) {
-        return new input_1.StreamInput({
-            inputStream: inputStream,
-            filename: filename,
-        });
-    }
-    /**
-     * Load an input source from bytes.
-     * @param inputBytes input content, as a Uint8Array or Buffer.
-     * @param filename file name.
-     */
-    sourceFromBytes(inputBytes, filename) {
-        return new input_1.BytesInput({
-            inputBytes: inputBytes,
-            filename: filename,
-        });
-    }
-    /**
-     * Load an input source from a Buffer.
-     * @param buffer input content, as a buffer.
-     * @param filename file name.
-     */
-    sourceFromBuffer(buffer, filename) {
-        return new input_1.BufferInput({
-            buffer: buffer,
-            filename: filename,
-        });
-    }
-    /**
-     * Load an input source from a URL.
-     * @param url input url. Must be HTTPS.
-     */
-    sourceFromUrl(url) {
-        return new input_1.UrlInput({
-            url: url,
-        });
-    }
 }
 exports.ClientV2 = ClientV2;
 _ClientV2_instances = new WeakSet(), _ClientV2_setAsyncParams = function _ClientV2_setAsyncParams(asyncParams = undefined) {

package/src/geometry/boundingBox.d.ts

@@ -1,4 +1,5 @@
 import { Point } from "./point";
+import { Polygon } from "./polygon";
 /** A simple bounding box defined by 4 coordinates: xMin, yMin, xMax, yMax */
 export declare class BBox {
     xMin: number;
@@ -8,4 +9,6 @@ export declare class BBox {
     constructor(xMin: number, yMin: number, xMax: number, yMax: number);
 }
 /** A bounding box defined by 4 points. */
-export type BoundingBox = [Point, Point, Point, Point];
+export declare class BoundingBox extends Polygon {
+    constructor(topLeft: Point, topRight: Point, bottomRight: Point, bottomLeft: Point);
+}

package/src/geometry/boundingBox.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BBox = void 0;
+exports.BoundingBox = exports.BBox = void 0;
+const polygon_1 = require("./polygon");
 /** A simple bounding box defined by 4 coordinates: xMin, yMin, xMax, yMax */
 class BBox {
     constructor(xMin, yMin, xMax, yMax) {
@@ -11,3 +12,10 @@ class BBox {
     }
 }
 exports.BBox = BBox;
+/** A bounding box defined by 4 points. */
+class BoundingBox extends polygon_1.Polygon {
+    constructor(topLeft, topRight, bottomRight, bottomLeft) {
+        super(topLeft, topRight, bottomRight, bottomLeft);
+    }
+}
+exports.BoundingBox = BoundingBox;

package/src/geometry/boundingBoxUtils.js

@@ -17,12 +17,7 @@ function getBoundingBox(polygon) {
  * Given a BBox, generate the associated bounding box.
  */
 function getBoundingBoxFromBBox(bbox) {
-    return [
-        [bbox.xMin, bbox.yMin],
-        [bbox.xMax, bbox.yMin],
-        [bbox.xMax, bbox.yMax],
-        [bbox.xMin, bbox.yMax],
-    ];
+    return new boundingBox_1.BoundingBox([bbox.xMin, bbox.yMin], [bbox.xMax, bbox.yMin], [bbox.xMax, bbox.yMax], [bbox.xMin, bbox.yMax]);
 }
 /**
  * Given 2 bbox, merge them.

package/src/geometry/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeBbox = exports.getBoundingBoxFromBBox = exports.getBoundingBox = exports.getBBoxForPolygons = exports.getBbox = exports.BBox = exports.getMinMaxY = exports.getMinMaxX = exports.relativeY = exports.relativeX = exports.isPointInPolygonY = exports.isPointInPolygonX = exports.getCentroid = exports.compareOnY = exports.compareOnX = exports.Polygon = void 0;
+exports.mergeBbox = exports.getBoundingBoxFromBBox = exports.getBoundingBox = exports.getBBoxForPolygons = exports.getBbox = exports.BBox = exports.BoundingBox = exports.getMinMaxY = exports.getMinMaxX = exports.relativeY = exports.relativeX = exports.isPointInPolygonY = exports.isPointInPolygonX = exports.getCentroid = exports.compareOnY = exports.compareOnX = exports.Polygon = void 0;
 var polygon_1 = require("./polygon");
 Object.defineProperty(exports, "Polygon", { enumerable: true, get: function () { return polygon_1.Polygon; } });
 var polygonUtils_1 = require("./polygonUtils");
@@ -14,6 +14,7 @@ Object.defineProperty(exports, "relativeY", { enumerable: true, get: function ()
 Object.defineProperty(exports, "getMinMaxX", { enumerable: true, get: function () { return polygonUtils_1.getMinMaxX; } });
 Object.defineProperty(exports, "getMinMaxY", { enumerable: true, get: function () { return polygonUtils_1.getMinMaxY; } });
 var boundingBox_1 = require("./boundingBox");
+Object.defineProperty(exports, "BoundingBox", { enumerable: true, get: function () { return boundingBox_1.BoundingBox; } });
 Object.defineProperty(exports, "BBox", { enumerable: true, get: function () { return boundingBox_1.BBox; } });
 var boundingBoxUtils_1 = require("./boundingBoxUtils");
 Object.defineProperty(exports, "getBbox", { enumerable: true, get: function () { return boundingBoxUtils_1.getBbox; } });

package/src/geometry/polygon.d.ts

@@ -1,4 +1,26 @@
 import { Point } from "./point";
+import { MinMax } from "./minMax";
 /** A polygon, composed of several Points. */
 export declare class Polygon extends Array<Point> {
+    constructor(...args: Point[]);
+    /**
+     * Get the central point (centroid) of the polygon.
+     */
+    getCentroid(): Point;
+    /**
+     * Get the maximum and minimum X coordinates of the polygon.
+     */
+    getMinMaxX(): MinMax;
+    /**
+     * Get the maximum and minimum Y coordinates of the polygon.
+     */
+    getMinMaxY(): MinMax;
+    /**
+     * Determine if a Point is within the Polygon's X axis (same column).
+     */
+    isPointInX(point: Point): boolean;
+    /**
+     * Determine if a Point is within the Polygon's Y axis (same line).
+     */
+    isPointInY(point: Point): boolean;
 }

package/src/geometry/polygon.js

@@ -1,7 +1,43 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Polygon = void 0;
+const polygonUtils_1 = require("./polygonUtils");
 /** A polygon, composed of several Points. */
 class Polygon extends Array {
+    constructor(...args) {
+        super(...args);
+    }
+    /**
+     * Get the central point (centroid) of the polygon.
+     */
+    getCentroid() {
+        return (0, polygonUtils_1.getCentroid)(this);
+    }
+    /**
+     * Get the maximum and minimum X coordinates of the polygon.
+     */
+    getMinMaxX() {
+        return (0, polygonUtils_1.getMinMaxX)(this);
+    }
+    /**
+     * Get the maximum and minimum Y coordinates of the polygon.
+     */
+    getMinMaxY() {
+        return (0, polygonUtils_1.getMinMaxY)(this);
+    }
+    /**
+     * Determine if a Point is within the Polygon's X axis (same column).
+     */
+    isPointInX(point) {
+        const xCoords = this.getMinMaxX();
+        return (0, polygonUtils_1.isPointInX)(point, xCoords.min, xCoords.max);
+    }
+    /**
+     * Determine if a Point is within the Polygon's Y axis (same line).
+     */
+    isPointInY(point) {
+        const yCoords = this.getMinMaxY();
+        return (0, polygonUtils_1.isPointInY)(point, yCoords.min, yCoords.max);
+    }
 }
 exports.Polygon = Polygon;

package/src/geometry/polygonUtils.d.ts

@@ -1,6 +1,5 @@
 import { MinMax } from "./minMax";
 import { Point } from "./point";
-import { Polygon } from "./polygon";
 /**
  * Get the central point (centroid) given a list of points.
  */
@@ -16,13 +15,13 @@ export declare function getMinMaxY(vertices: Array<Point>): MinMax;
 /**
  * Determine if a Point is within a Polygon's Y axis.
  */
-export declare function isPointInPolygonY(centroid: Point, polygon: Polygon): boolean;
+export declare function isPointInPolygonY(centroid: Point, polygon: Array<Point>): boolean;
 /**
  * Calculate the relative Y position of a Polygon.
  *
  * Can be used to order (sort) words in the same column.
  */
-export declare function relativeY(polygon: Polygon): number;
+export declare function relativeY(polygon: Array<Point>): number;
 /**
  * Determine if a Point is within two X coordinates.
  */
@@ -34,14 +33,14 @@ export declare function getMinMaxX(vertices: Array<Point>): MinMax;
 /**
  * Determine if a Point is within a Polygon's X axis.
  */
-export declare function isPointInPolygonX(centroid: Point, polygon: Polygon): boolean;
+export declare function isPointInPolygonX(centroid: Point, polygon: Array<Point>): boolean;
 /**
  * Calculate the relative X position of a Polygon.
  *
  * Can be used to order (sort) words in the same line.
  */
-export declare function relativeX(polygon: Polygon): number;
-export declare function getMinYCoordinate(polygon: Polygon): number;
-export declare function getMinXCoordinate(polygon: Polygon): number;
-export declare function compareOnY(polygon1: Polygon, polygon2: Polygon): number;
-export declare function compareOnX(polygon1: Polygon, polygon2: Polygon): number;
+export declare function relativeX(polygon: Array<Point>): number;
+export declare function getMinYCoordinate(polygon: Array<Point>): number;
+export declare function getMinXCoordinate(polygon: Array<Point>): number;
+export declare function compareOnY(polygon1: Array<Point>, polygon2: Array<Point>): number;
+export declare function compareOnX(polygon1: Array<Point>, polygon2: Array<Point>): number;

package/src/index.d.ts

@@ -1,7 +1,8 @@
 export * as product from "./product";
-export { Client, PredictOptions } from "./client";
+export { Client, PredictOptions, WorkflowOptions } from "./client";
 export { ClientV2, InferenceParameters, PollingOptions } from "./clientV2";
 export { AsyncPredictResponse, PredictResponse, Inference, Prediction, Document, Page, } from "./parsing/common";
+export { InferenceFile, InferenceResponse, JobResponse, RawText, } from "./parsing/v2";
 export { InputSource, Base64Input, BufferInput, BytesInput, PathInput, StreamInput, UrlInput, PageOptions, PageOptionsOperation, LocalResponse } from "./input";
 export * as internal from "./internal";
 export * as imageOperations from "./imageOperations";

package/src/index.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.imageOperations = exports.internal = exports.LocalResponse = exports.PageOptionsOperation = exports.UrlInput = exports.StreamInput = exports.PathInput = exports.BytesInput = exports.BufferInput = exports.Base64Input = exports.InputSource = exports.Page = exports.Document = exports.Prediction = exports.Inference = exports.PredictResponse = exports.AsyncPredictResponse = exports.ClientV2 = exports.Client = exports.product = void 0;
+exports.imageOperations = exports.internal = exports.LocalResponse = exports.PageOptionsOperation = exports.UrlInput = exports.StreamInput = exports.PathInput = exports.BytesInput = exports.BufferInput = exports.Base64Input = exports.InputSource = exports.RawText = exports.JobResponse = exports.InferenceResponse = exports.InferenceFile = exports.Page = exports.Document = exports.Prediction = exports.Inference = exports.PredictResponse = exports.AsyncPredictResponse = exports.ClientV2 = exports.Client = exports.product = void 0;
 exports.product = __importStar(require("./product"));
 var client_1 = require("./client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_1.Client; } });
@@ -46,6 +46,11 @@ Object.defineProperty(exports, "Inference", { enumerable: true, get: function ()
 Object.defineProperty(exports, "Prediction", { enumerable: true, get: function () { return common_1.Prediction; } });
 Object.defineProperty(exports, "Document", { enumerable: true, get: function () { return common_1.Document; } });
 Object.defineProperty(exports, "Page", { enumerable: true, get: function () { return common_1.Page; } });
+var v2_1 = require("./parsing/v2");
+Object.defineProperty(exports, "InferenceFile", { enumerable: true, get: function () { return v2_1.InferenceFile; } });
+Object.defineProperty(exports, "InferenceResponse", { enumerable: true, get: function () { return v2_1.InferenceResponse; } });
+Object.defineProperty(exports, "JobResponse", { enumerable: true, get: function () { return v2_1.JobResponse; } });
+Object.defineProperty(exports, "RawText", { enumerable: true, get: function () { return v2_1.RawText; } });
 var input_1 = require("./input");
 Object.defineProperty(exports, "InputSource", { enumerable: true, get: function () { return input_1.InputSource; } });
 Object.defineProperty(exports, "Base64Input", { enumerable: true, get: function () { return input_1.Base64Input; } });

package/src/input/localResponse.d.ts

@@ -8,6 +8,7 @@ import { CommonResponse } from "../parsing/v2";
 export declare class LocalResponse {
     private file;
     private readonly inputHandle;
+    protected initialized: boolean;
     /**
      * Creates an instance of LocalResponse.
      */
@@ -17,7 +18,7 @@ export declare class LocalResponse {
      * Returns the dictionary representation of the file.
      * @returns A JSON-like object.
      */
-    asDict(): StringDict;
+    asDict(): Promise<StringDict>;
     /**
      * Returns the HMAC signature of the local response, from the secret key provided.
      * @param secretKey - Secret key, either a string or a byte/byte array.
@@ -32,15 +33,14 @@ export declare class LocalResponse {
      */
     isValidHmacSignature(secretKey: string | Buffer | Uint8Array, signature: string): boolean;
     /**
-     * Deserialize the loaded local response into the requested CommonResponse`-derived class.
+     * Deserialize the loaded local response into the requested CommonResponse-derived class.
      *
      * Typically used when dealing with V2 webhook callbacks.
      *
      * @typeParam ResponseT - A class that extends `CommonResponse`.
-     * @param responseClass - The constructor of the class into which
-     *                        the payload should be deserialized.
+     * @param responseClass - The constructor of the class into which the payload should be deserialized.
      * @returns An instance of `responseClass` populated with the file content.
      * @throws MindeeError If the provided class cannot be instantiated.
      */
-    deserializeResponse<ResponseT extends CommonResponse>(responseClass: new (serverResponse: StringDict) => ResponseT): ResponseT;
+    deserializeResponse<ResponseT extends CommonResponse>(responseClass: new (serverResponse: StringDict) => ResponseT): Promise<ResponseT>;
 }