mindee 4.29.0-rc6 → 4.30.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # CHANGELOG
 
+## v4.30.0 - 2025-09-04
+### Changes
+* :sparkles: add support for inference options
+* :recycle: refactor rst display to match other SDKs
+### ¡Breaking Changes!
+* :recycle: :boom: update raw text output from server
+
+## 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
@@ -35,7 +51,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
 
@@ -178,7 +193,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
@@ -224,7 +238,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
 
@@ -242,7 +255,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)
@@ -261,14 +273,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
@@ -292,7 +302,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
 
@@ -339,7 +348,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
@@ -369,7 +377,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
@@ -378,7 +385,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
 
@@ -395,7 +401,6 @@
 * :recycle: remove deprecated examples
 * :recycle: update linting rules
 * :arrow_up: update testing library
-
 ### Fixes
 * :bug: fix miscellaneous bugs related to http parsing issues
 
@@ -403,7 +408,6 @@
 ## v4.0.2 - 2023-08-24
 ### Changes
 * :recycle: updated technical documentation
-
 ### Fixes
 * :bug: fix url source document not being sent properly
 
@@ -418,7 +422,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
@@ -439,7 +442,6 @@
 ## v3.10.1 - 2023-07-04
 ### Changes
 * :arrow_up: update dependencies
-
 ### Fixes
 * :pencil2: added missing entry in changelog
 
@@ -455,8 +457,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
@@ -472,7 +472,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
 
@@ -502,7 +501,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
 
@@ -532,7 +530,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
 
@@ -593,7 +590,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
@@ -630,15 +626,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-rc6",
+    "version": "4.30.0",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",

package/src/clientV2.d.ts

@@ -52,7 +52,11 @@ export interface PollingOptions {
  * All fields are optional except `modelId`.
  *
  * @property modelId Identifier of the model that must process the document. **Required**.
- * @property rag When `true`, activates Retrieval-Augmented Generation (RAG).
+ * @property rag Enhance extraction accuracy with Retrieval-Augmented Generation.
+ * @property rawText Extract the full text content from the document as strings, and fill the `raw_text` attribute.
+ * @property polygon Calculate bounding box polygons for all fields, and fill their `locations` attribute.
+ * @property confidence Boost the precision and accuracy of all extractions.
+ *     Calculate confidence scores for all fields and fill their `confidence` attribute.
  * @property alias Custom alias assigned to the uploaded document.
  * @property webhookIds List of webhook UUIDs that will receive the final API response.
  * @property pollingOptions Client-side polling configuration (see {@link PollingOptions}).
@@ -73,6 +77,9 @@ export interface PollingOptions {
 export interface InferenceParameters {
     modelId: string;
     rag?: boolean;
+    rawText?: boolean;
+    polygon?: boolean;
+    confidence?: boolean;
     alias?: string;
     webhookIds?: string[];
     pollingOptions?: PollingOptions;

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/http/mindeeApiV2.js

@@ -82,8 +82,17 @@ _MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_processResponse = function
 }, _MindeeApiV2_documentEnqueuePost = function _MindeeApiV2_documentEnqueuePost(inputSource, params) {
     const form = new form_data_1.default();
     form.append("model_id", params.modelId);
-    if (params.rag) {
-        form.append("rag", "true");
+    if (params.rag !== undefined && params.rag !== null) {
+        form.append("rag", params.rag.toString());
+    }
+    if (params.polygon !== undefined && params.polygon !== null) {
+        form.append("polygon", params.polygon.toString().toLowerCase());
+    }
+    if (params.confidence !== undefined && params.confidence !== null) {
+        form.append("confidence", params.confidence.toString().toLowerCase());
+    }
+    if (params.rawText !== undefined && params.rawText !== null) {
+        form.append("raw_text", params.rawText.toString().toLowerCase());
     }
     if (params.webhookIds && params.webhookIds.length > 0) {
         form.append("webhook_ids", params.webhookIds.join(","));

package/src/index.d.ts

@@ -2,7 +2,7 @@ export * as product from "./product";
 export { Client, PredictOptions, WorkflowOptions } from "./client";
 export { ClientV2, InferenceParameters, PollingOptions } from "./clientV2";
 export { AsyncPredictResponse, PredictResponse, Inference, Prediction, Document, Page, } from "./parsing/common";
-export { InferenceResponse, JobResponse, } from "./parsing/v2";
+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.JobResponse = exports.InferenceResponse = 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; } });
@@ -47,8 +47,10 @@ Object.defineProperty(exports, "Prediction", { enumerable: true, get: function (
 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/parsing/custom/listField.d.ts

@@ -1,5 +1,5 @@
 import { BaseFieldConstructor } from "../standard";
-import { Polygon } from "../../geometry";
+import { Polygon, BoundingBox } from "../../geometry";
 import { StringDict } from "../common";
 export declare class ListFieldValue {
     /** Extracted content of the prediction */
@@ -13,7 +13,7 @@ export declare class ListFieldValue {
      * Contains exactly 4 relative vertices coordinates (points) of a right
      * rectangle containing the word in the document.
      */
-    bbox: Polygon;
+    bbox?: BoundingBox;
     /**
      * Contains the relative vertices coordinates (points) of a polygon containing
      * the word in the document.

package/src/parsing/custom/listField.js

@@ -4,16 +4,11 @@ exports.ListField = exports.ListFieldValue = void 0;
 const geometry_1 = require("../../geometry");
 class ListFieldValue {
     constructor(prediction, pageId) {
-        /**
-         * Contains exactly 4 relative vertices coordinates (points) of a right
-         * rectangle containing the word in the document.
-         */
-        this.bbox = [];
         /**
          * Contains the relative vertices coordinates (points) of a polygon containing
          * the word in the document.
          */
-        this.polygon = [];
+        this.polygon = new geometry_1.Polygon();
         this.content = prediction["content"];
         this.confidence = prediction["confidence"];
         if (prediction["polygon"]) {

package/src/parsing/standard/field.js

@@ -16,7 +16,7 @@ class Field extends base_1.BaseField {
          * Contains the relative vertices coordinates (points) of a polygon containing
          * the field in the document.
          */
-        this.polygon = [];
+        this.polygon = new geometry_1.Polygon();
         this.confidence = prediction["confidence"] ? prediction["confidence"] : 0.0;
         if (prediction["polygon"]) {
             this.polygon = prediction["polygon"];

package/src/parsing/v2/field/fieldFactory.d.ts

@@ -5,4 +5,4 @@ import { StringDict } from "../../common";
 import { ListField } from "./listField";
 import { ObjectField } from "./objectField";
 import { SimpleField } from "./simpleField";
-export declare function createField(serverResponse: StringDict, indentLevel?: number): ObjectField | SimpleField | ListField;
+export declare function createField(serverResponse: StringDict, indentLevel?: number): SimpleField | ObjectField | ListField;

package/src/parsing/v2/field/inferenceFields.d.ts

@@ -5,5 +5,8 @@ import type { SimpleField } from "./simpleField";
 export declare class InferenceFields extends Map<string, SimpleField | ObjectField | ListField> {
     protected _indentLevel: number;
     constructor(serverResponse: StringDict, indentLevel?: number);
+    getSimpleField(fieldName: string): SimpleField;
+    getObjectField(fieldName: string): ObjectField;
+    getListField(fieldName: string): ListField;
     toString(indent?: number): string;
 }

package/src/parsing/v2/field/inferenceFields.js

@@ -9,6 +9,36 @@ class InferenceFields extends Map {
         }));
         this._indentLevel = indentLevel;
     }
+    getSimpleField(fieldName) {
+        const field = this.get(fieldName);
+        if (field === undefined) {
+            throw new Error(`The field '${fieldName}' was not found.`);
+        }
+        if (field.constructor.name !== "SimpleField") {
+            throw new Error(`The field '${fieldName}' is not a SimpleField.`);
+        }
+        return field;
+    }
+    getObjectField(fieldName) {
+        const field = this.get(fieldName);
+        if (field === undefined) {
+            throw new Error(`The field '${fieldName}' was not found.`);
+        }
+        if (field.constructor.name !== "ObjectField") {
+            throw new Error(`The field '${fieldName}' is not an ObjectField.`);
+        }
+        return field;
+    }
+    getListField(fieldName) {
+        const field = this.get(fieldName);
+        if (field === undefined) {
+            throw new Error(`The field '${fieldName}' was not found.`);
+        }
+        if (field.constructor.name !== "ListField") {
+            throw new Error(`The field '${fieldName}' is not a ListField.`);
+        }
+        return field;
+    }
     toString(indent = this._indentLevel) {
         if (this.size === 0) {
             return "";

package/src/parsing/v2/field/listField.d.ts

@@ -7,6 +7,14 @@ export declare class ListField extends BaseField {
      * Items contained in the list.
      */
     items: Array<ListField | ObjectField | SimpleField>;
+    /**
+     * SimpleField items from the list.
+     */
+    get simpleItems(): Array<SimpleField>;
+    /**
+     * SimpleField items from the list.
+     */
+    get objectItems(): Array<ObjectField>;
     constructor(serverResponse: StringDict, indentLevel?: number);
     toString(): string;
 }

package/src/parsing/v2/field/listField.js

@@ -4,8 +4,39 @@ exports.ListField = void 0;
 const mindeeError_1 = require("../../../errors/mindeeError");
 const baseField_1 = require("./baseField");
 const objectField_1 = require("./objectField");
+const simpleField_1 = require("./simpleField");
 const fieldFactory_1 = require("./fieldFactory");
 class ListField extends baseField_1.BaseField {
+    /**
+     * SimpleField items from the list.
+     */
+    get simpleItems() {
+        const result = [];
+        for (const item of this.items) {
+            if (item instanceof simpleField_1.SimpleField) {
+                result.push(item);
+            }
+            else {
+                throw new mindeeError_1.MindeeApiV2Error(`All items must be SimpleField, found item of type ${item.constructor.name}.`);
+            }
+        }
+        return result;
+    }
+    /**
+     * SimpleField items from the list.
+     */
+    get objectItems() {
+        const result = [];
+        for (const item of this.items) {
+            if (item instanceof objectField_1.ObjectField) {
+                result.push(item);
+            }
+            else {
+                throw new mindeeError_1.MindeeApiV2Error(`All items must be ObjectField, found item of type ${item.constructor.name}.`);
+            }
+        }
+        return result;
+    }
     constructor(serverResponse, indentLevel = 0) {
         super(serverResponse, indentLevel);
         if (!Array.isArray(serverResponse["items"])) {

package/src/parsing/v2/field/objectField.d.ts

@@ -1,8 +1,10 @@
 import { InferenceFields } from "./inferenceFields";
 import { StringDict } from "../../common";
 import { BaseField } from "./baseField";
+import type { SimpleField } from "./simpleField";
 export declare class ObjectField extends BaseField {
     readonly fields: InferenceFields;
+    get simpleFields(): Map<string, SimpleField>;
     constructor(serverResponse: StringDict, indentLevel?: number);
     toString(): string;
     toStringFromList(): string;

package/src/parsing/v2/field/objectField.js

@@ -4,6 +4,18 @@ exports.ObjectField = void 0;
 const inferenceFields_1 = require("./inferenceFields");
 const baseField_1 = require("./baseField");
 class ObjectField extends baseField_1.BaseField {
+    get simpleFields() {
+        const result = new Map();
+        for (const [fieldName, fieldValue] of this.fields) {
+            if (fieldValue.constructor.name === "SimpleField") {
+                result.set(fieldName, fieldValue);
+            }
+            else {
+                throw new Error(`The field '${fieldName}' is not a SimpleField.`);
+            }
+        }
+        return result;
+    }
     constructor(serverResponse, indentLevel = 0) {
         super(serverResponse, indentLevel);
         this.fields = new inferenceFields_1.InferenceFields(serverResponse["fields"], this._indentLevel + 1);

package/src/parsing/v2/field/simpleField.d.ts

@@ -3,5 +3,17 @@ import { BaseField } from "./baseField";
 export declare class SimpleField extends BaseField {
     readonly value: string | number | boolean | null;
     constructor(serverResponse: StringDict, indentLevel?: number);
+    /**
+     * Retrieves a string field value as a string.
+     */
+    get stringValue(): string | null;
+    /**
+     * Retrieves a number field value as a number.
+     */
+    get numberValue(): number | null;
+    /**
+     * Retrieves a boolean field value as a boolean.
+     */
+    get booleanValue(): boolean | null;
     toString(): string;
 }