mindee 5.8.0 → 5.10.0

package/src/v1/parsing/common/executionPriority.js

@@ -1,10 +1,18 @@
-/** Execution priority levels available for workflow requests. */
+/**
+ * Execution priority levels available for workflow requests.
+ */
 export var ExecutionPriority;
 (function (ExecutionPriority) {
-    /** Low-priority background processing. */
+    /**
+     * Low-priority background processing.
+     */
     ExecutionPriority["low"] = "low";
-    /** Standard processing priority. */
+    /**
+     * Standard processing priority.
+     */
     ExecutionPriority["medium"] = "medium";
-    /** High-priority processing. */
+    /**
+     * High-priority processing.
+     */
     ExecutionPriority["high"] = "high";
 })(ExecutionPriority || (ExecutionPriority = {}));

package/src/v1/parsing/common/extras/cropperExtra.d.ts

@@ -1,9 +1,13 @@
-import { PositionField } from "../../../../v1/parsing/standard/position.js";
 import { StringDict } from "../../../../parsing/stringDict.js";
+import { PositionField } from "../../standard/position.js";
 import { ExtraField } from "./extras.js";
-/** Cropper extra payload returned by compatible APIs. */
+/**
+ * Cropper extra payload returned by compatible APIs.
+ */
 export declare class CropperExtra extends ExtraField {
-    /** Cropped regions detected on the page. */
+    /**
+     * Cropped regions detected on the page.
+     */
     cropping: PositionField[];
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/parsing/common/extras/cropperExtra.js

@@ -1,12 +1,15 @@
-import { PositionField } from "../../../../v1/parsing/standard/position.js";
-// eslint-disable-next-line no-restricted-imports
+import { PositionField } from "../../standard/position.js";
 import { cleanOutString } from "../summaryHelper.js";
 import { ExtraField } from "./extras.js";
-/** Cropper extra payload returned by compatible APIs. */
+/**
+ * Cropper extra payload returned by compatible APIs.
+ */
 export class CropperExtra extends ExtraField {
     constructor(rawPrediction, pageId) {
         super();
-        /** Cropped regions detected on the page. */
+        /**
+         * Cropped regions detected on the page.
+         */
         this.cropping = [];
         if (rawPrediction["cropping"] !== undefined) {
             rawPrediction["cropping"].forEach((crop) => {

package/src/v1/parsing/common/extras/extras.d.ts

@@ -1,12 +1,18 @@
-/** Base class for optional extras attached to predictions. */
+/**
+ * Base class for optional extras attached to predictions.
+ */
 export declare abstract class ExtraField {
 }
 interface ExtraDict<T extends ExtraField> {
     [key: string]: T | (() => string);
 }
-/** Dictionary-like container for extra fields. */
+/**
+ * Dictionary-like container for extra fields.
+ */
 export declare class Extras<ExtraT extends ExtraField = ExtraField> implements ExtraDict<ExtraT> {
-    /** Dynamic map of extra values keyed by extra name. */
+    /**
+     * Dynamic map of extra values keyed by extra name.
+     */
     [key: string]: ExtraT | (() => string);
     constructor(fields: Record<string, ExtraT>);
     /**

package/src/v1/parsing/common/extras/extras.js

@@ -1,7 +1,11 @@
-/** Base class for optional extras attached to predictions. */
+/**
+ * Base class for optional extras attached to predictions.
+ */
 export class ExtraField {
 }
-/** Dictionary-like container for extra fields. */
+/**
+ * Dictionary-like container for extra fields.
+ */
 export class Extras {
     constructor(fields) {
         if (Object.keys(fields).length > 0) {

package/src/v1/parsing/common/extras/fullTextOcrExtra.d.ts

@@ -1,10 +1,16 @@
 import { StringDict } from "../../../../parsing/stringDict.js";
 import { ExtraField } from "./extras.js";
-/** Full-text OCR extra payload returned by compatible APIs. */
+/**
+ * Full-text OCR extra payload returned by compatible APIs.
+ */
 export declare class FullTextOcrExtra extends ExtraField {
-    /** Concatenated OCR content. */
+    /**
+     * Concatenated OCR content.
+     */
     content?: string;
-    /** OCR language hints associated with the content. */
+    /**
+     * OCR language hints associated with the content.
+     */
     languages?: string;
     constructor(rawPrediction: StringDict);
     /**

package/src/v1/parsing/common/extras/fullTextOcrExtra.js

@@ -1,5 +1,7 @@
 import { ExtraField } from "./extras.js";
-/** Full-text OCR extra payload returned by compatible APIs. */
+/**
+ * Full-text OCR extra payload returned by compatible APIs.
+ */
 export class FullTextOcrExtra extends ExtraField {
     constructor(rawPrediction) {
         super();

package/src/v1/parsing/common/extras/ragExtra.d.ts

@@ -1,6 +1,8 @@
 import { ExtraField } from "./extras.js";
 import { StringDict } from "../../../../parsing/stringDict.js";
-/** RAG extra payload returned by compatible APIs. */
+/**
+ * RAG extra payload returned by compatible APIs.
+ */
 export declare class RAGExtra extends ExtraField {
     /**
      * ID reference of the document matched by the Retrieval-Augmented Generation.

package/src/v1/parsing/common/extras/ragExtra.js

@@ -1,5 +1,7 @@
 import { ExtraField } from "./extras.js";
-/** RAG extra payload returned by compatible APIs. */
+/**
+ * RAG extra payload returned by compatible APIs.
+ */
 export class RAGExtra extends ExtraField {
     constructor(rawPrediction) {
         super();

package/src/v1/parsing/common/feedback/feedbackResponse.d.ts

@@ -6,7 +6,9 @@ import { StringDict } from "../../../../parsing/stringDict.js";
  * @category Synchronous
  */
 export declare class FeedbackResponse extends ApiResponse {
-    /** A document feedback response. */
+    /**
+     * A document feedback response.
+     */
     feedback: StringDict;
     /**
      * @param serverResponse JSON response from the server.

package/src/v1/parsing/common/feedback/feedbackResponse.js

@@ -1,4 +1,3 @@
-// eslint-disable-next-line no-restricted-imports
 import { ApiResponse } from "../apiResponse.js";
 /**
  * Wrapper for feedback response.

package/src/v1/parsing/common/inference.d.ts

@@ -12,25 +12,41 @@ import { Extras } from "./extras/index.js";
  * if a document's pages have specific implementation.
  */
 export declare abstract class Inference<DocT extends Prediction = Prediction, PageT extends DocT = DocT> {
-    /** A boolean denoting whether a given inference result was rotated. */
+    /**
+     * A boolean denoting whether a given inference result was rotated.
+     */
     isRotationApplied?: boolean;
-    /** Name and version of a given product. */
+    /**
+     * Name and version of a given product.
+     */
     product: Product;
-    /** Wrapper for a document's pages prediction. */
+    /**
+     * Wrapper for a document's pages prediction.
+     */
     pages: Page<PageT>[];
-    /** A document's top-level `Prediction`. */
+    /**
+     * A document's top-level `Prediction`.
+     */
     prediction: DocT;
-    /** Extraneous fields relating to specific tools for some APIs. */
+    /**
+     * Extraneous fields relating to specific tools for some APIs.
+     */
     extras?: Extras;
-    /** Name of a document's endpoint. Has a default value for OTS APIs. */
+    /**
+     * Name of a document's endpoint. Has a default value for OTS APIs.
+     */
     endpointName?: string;
-    /** A document's version. Has a default value for OTS APIs. */
+    /**
+     * A document's version. Has a default value for OTS APIs.
+     */
     endpointVersion?: string;
     constructor(rawPrediction: StringDict);
     /**
      * Default string representation.
      */
-    /** Returns a human-readable representation of the inference payload. */
+    /**
+     * Returns a human-readable representation of the inference payload.
+     */
     toString(): string;
     /**
      * Takes in an input string and replaces line breaks with `\n`.

package/src/v1/parsing/common/inference.js

@@ -10,7 +10,9 @@ import { MindeeConfigurationError } from "../../../errors/index.js";
  */
 export class Inference {
     constructor(rawPrediction) {
-        /** Wrapper for a document's pages prediction. */
+        /**
+         * Wrapper for a document's pages prediction.
+         */
         this.pages = [];
         this.isRotationApplied = rawPrediction?.is_rotation_applied ?? undefined;
         this.product = rawPrediction?.product;
@@ -36,7 +38,9 @@ export class Inference {
     /**
      * Default string representation.
      */
-    /** Returns a human-readable representation of the inference payload. */
+    /**
+     * Returns a human-readable representation of the inference payload.
+     */
     toString() {
         let pages = "";
         if (this.pages.toString().length > 0) {

package/src/v1/parsing/common/mvisionV1.d.ts

@@ -1,7 +1,9 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { OcrPage } from "./ocrPage.js";
 export declare class MvisionV1 {
-    /** List of words found on the page. */
+    /**
+     * List of words found on the page.
+     */
     pages: OcrPage[];
     constructor(rawPrediction: StringDict);
     /**

package/src/v1/parsing/common/mvisionV1.js

@@ -1,7 +1,9 @@
 import { OcrPage } from "./ocrPage.js";
 export class MvisionV1 {
     constructor(rawPrediction) {
-        /** List of words found on the page. */
+        /**
+         * List of words found on the page.
+         */
         this.pages = [];
         rawPrediction["pages"].map((page) => {
             this.pages.push(new OcrPage(page));

package/src/v1/parsing/common/ocr.d.ts

@@ -1,7 +1,9 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { MvisionV1 } from "./mvisionV1.js";
 export declare class Ocr {
-    /** Default Mindee OCR */
+    /**
+     * Default Mindee OCR
+     */
     mVisionV1: MvisionV1;
     constructor(rawPrediction: StringDict);
     /**

package/src/v1/parsing/common/ocrPage.d.ts

@@ -1,10 +1,14 @@
-import { Word } from "../../../v1/parsing/standard/index.js";
+import { Word } from "../standard/index.js";
 import { StringDict } from "../../../parsing/stringDict.js";
 export declare class OcrPage {
     #private;
-    /** Flat list of all words read */
+    /**
+     * Flat list of all words read
+     */
     allWords: Word[];
-    /** List of words by which line they are on */
+    /**
+     * List of words by which line they are on
+     */
     allLines: Word[][];
     constructor(rawPrediction: StringDict);
     /**

package/src/v1/parsing/common/ocrPage.js

@@ -5,13 +5,17 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _OcrPage_instances, _OcrPage_areWordsOnSameLine, _OcrPage_toLines;
 import { compareOnX, compareOnY, isPointInPolygonY, } from "../../../geometry/index.js";
-import { Word } from "../../../v1/parsing/standard/index.js";
+import { Word } from "../standard/index.js";
 export class OcrPage {
     constructor(rawPrediction) {
         _OcrPage_instances.add(this);
-        /** Flat list of all words read */
+        /**
+         * Flat list of all words read
+         */
         this.allWords = [];
-        /** List of words by which line they are on */
+        /**
+         * List of words by which line they are on
+         */
         this.allLines = [];
         const allWords = [];
         if (rawPrediction["all_words"]) {

package/src/v1/parsing/common/orientation.d.ts

@@ -1,4 +1,4 @@
-import { BaseField, BaseFieldConstructor } from "../../../v1/parsing/standard/index.js";
+import { BaseField, BaseFieldConstructor } from "../standard/index.js";
 interface OrientationFieldConstructor extends BaseFieldConstructor {
     pageId: number;
 }
@@ -6,9 +6,13 @@ interface OrientationFieldConstructor extends BaseFieldConstructor {
  * The clockwise rotation to apply (in degrees) to make the image upright.
  */
 export declare class OrientationField extends BaseField {
-    /** Degrees of the rotation. */
+    /**
+     * Degrees of the rotation.
+     */
     value: number;
-    /** Page id. */
+    /**
+     * Page id.
+     */
     pageId: number;
     /**
      * @param {OrientationFieldConstructor} constructor Constructor parameters.

package/src/v1/parsing/common/orientation.js

@@ -1,4 +1,4 @@
-import { BaseField } from "../../../v1/parsing/standard/index.js";
+import { BaseField } from "../standard/index.js";
 /**
  * The clockwise rotation to apply (in degrees) to make the image upright.
  */

package/src/v1/parsing/common/page.d.ts

@@ -8,13 +8,21 @@ import { StringDict } from "../../../parsing/stringDict.js";
  * @typeParam T an extension of an `Prediction`. Mandatory in order to properly create a page-level prediction.
  */
 export declare class Page<T extends Prediction> {
-    /** The page's index (identifier). */
+    /**
+     * The page's index (identifier).
+     */
     id: number;
-    /** The page's orientation */
+    /**
+     * The page's orientation
+     */
     orientation?: OrientationField;
-    /** A page-level prediction. Can either be specific to pages or identical to the document prediction. */
+    /**
+     * A page-level prediction. Can either be specific to pages or identical to the document prediction.
+     */
     prediction: T;
-    /** Potential `Extras` fields sent back along with the prediction. */
+    /**
+     * Potential `Extras` fields sent back along with the prediction.
+     */
     extras?: Extras;
     /**
      * @param predictionType constructor signature for an inference.

package/src/v1/parsing/common/predictResponse.d.ts

@@ -8,7 +8,9 @@ import { StringDict } from "../../../parsing/stringDict.js";
  * @category Synchronous
  */
 export declare class PredictResponse<T extends Inference> extends ApiResponse {
-    /** A document prediction response. */
+    /**
+     * A document prediction response.
+     */
     document: Document<T>;
     /**
      *

package/src/v1/parsing/common/prediction.d.ts

@@ -1,3 +1,5 @@
-/** Marker base type for v1 prediction payload models. */
+/**
+ * Marker base type for v1 prediction payload models.
+ */
 export declare class Prediction {
 }

package/src/v1/parsing/common/prediction.js

@@ -1,3 +1,5 @@
-/** Marker base type for v1 prediction payload models. */
+/**
+ * Marker base type for v1 prediction payload models.
+ */
 export class Prediction {
 }

package/src/v1/parsing/generated/generatedList.d.ts

@@ -1,5 +1,5 @@
 import { StringDict } from "../../../parsing/stringDict.js";
-import { StringField } from "../../../v1/parsing/standard/index.js";
+import { StringField } from "../standard/index.js";
 import { GeneratedObjectField } from "./generatedObject.js";
 export interface GeneratedListFieldConstructor {
     prediction: StringDict[];
@@ -9,9 +9,13 @@ export interface GeneratedListFieldConstructor {
  * A list of values or objects, used in generated APIs.
  */
 export declare class GeneratedListField {
-    /** Id of the page the object was found on. */
+    /**
+     * Id of the page the object was found on.
+     */
     pageId?: number;
-    /** List of word values. */
+    /**
+     * List of word values.
+     */
     values: Array<GeneratedObjectField | StringField>;
     constructor({ prediction, pageId, }: GeneratedListFieldConstructor);
     /**

package/src/v1/parsing/generated/generatedList.js

@@ -1,4 +1,4 @@
-import { StringField } from "../../../v1/parsing/standard/index.js";
+import { StringField } from "../standard/index.js";
 import { GeneratedObjectField, isGeneratedObject } from "./generatedObject.js";
 /**
  * A list of values or objects, used in generated APIs.

package/src/v1/parsing/generated/generatedObject.d.ts

@@ -1,16 +1,28 @@
 import { StringDict } from "../../../parsing/stringDict.js";
-import { BaseFieldConstructor } from "../../../v1/parsing/standard/index.js";
-/** A JSON-like object, with miscellaneous values. */
+import { BaseFieldConstructor } from "../standard/index.js";
+/**
+ * A JSON-like object, with miscellaneous values.
+ */
 export declare class GeneratedObjectField {
-    /** The document page on which the information was found. */
+    /**
+     * The document page on which the information was found.
+     */
     pageId?: number;
-    /** Confidence with which the value was assessed. */
+    /**
+     * Confidence with which the value was assessed.
+     */
     confidence?: number;
-    /** Raw unprocessed value, as it was sent by the server. */
+    /**
+     * Raw unprocessed value, as it was sent by the server.
+     */
     rawValue?: string;
-    /** List of all printable field names. */
+    /**
+     * List of all printable field names.
+     */
     private printableValues;
-    /** All potentially present fields. */
+    /**
+     * All potentially present fields.
+     */
     [key: string]: string | number | boolean | object | undefined;
     constructor({ prediction, pageId, }: BaseFieldConstructor);
     private static readonly positionFieldNames;
@@ -19,7 +31,7 @@ export declare class GeneratedObjectField {
     private assignScalarField;
     /**
      * ReSTructured-compliant string representation.
-     Takes into account level of indentation & displays elements as list elements.
+     * Takes into account level of indentation & displays elements as list elements.
      * @param level Level of indentation. 0 by default.
      */
     toStringLevel(level?: number): string;
@@ -29,9 +41,13 @@ export declare class GeneratedObjectField {
      * @returns
      */
     private toNumberString;
-    /** Returns the default string representation. */
+    /**
+     * Returns the default string representation.
+     */
     toString(): string;
-    /** Returns a field value by key from this generated object. */
+    /**
+     * Returns a field value by key from this generated object.
+     */
     get(fieldName: string): string | number | boolean | object | undefined;
 }
 /**

package/src/v1/parsing/generated/generatedObject.js

@@ -1,5 +1,7 @@
-import { PositionField } from "../../../v1/parsing/standard/index.js";
-/** A JSON-like object, with miscellaneous values. */
+import { PositionField } from "../standard/index.js";
+/**
+ * A JSON-like object, with miscellaneous values.
+ */
 export class GeneratedObjectField {
     constructor({ prediction = {}, pageId, }) {
         let itemPageId = null;
@@ -54,7 +56,7 @@ export class GeneratedObjectField {
     }
     /**
      * ReSTructured-compliant string representation.
-     Takes into account level of indentation & displays elements as list elements.
+     * Takes into account level of indentation & displays elements as list elements.
      * @param level Level of indentation. 0 by default.
      */
     toStringLevel(level = 0) {
@@ -77,11 +79,15 @@ export class GeneratedObjectField {
         }
         return n.toString();
     }
-    /** Returns the default string representation. */
+    /**
+     * Returns the default string representation.
+     */
     toString() {
         return this.toStringLevel();
     }
-    /** Returns a field value by key from this generated object. */
+    /**
+     * Returns a field value by key from this generated object.
+     */
     get(fieldName) {
         return this[fieldName];
     }
@@ -94,7 +100,7 @@ GeneratedObjectField.positionFieldNames = new Set([
  * @param strDict input dictionary to check.
  */
 export function isGeneratedObject(strDict) {
-    const commonKeys = [
+    const commonKeys = new Set([
         "value",
         "polygon",
         "rectangle",
@@ -103,9 +109,9 @@ export function isGeneratedObject(strDict) {
         "quadrangle",
         "values",
         "raw_value",
-    ];
+    ]);
     for (const key in strDict) {
-        if (Object.prototype.hasOwnProperty.call(strDict, key) && !commonKeys.includes(key)) {
+        if (Object.prototype.hasOwnProperty.call(strDict, key) && !commonKeys.has(key)) {
             return true;
         }
     }

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

@@ -1,11 +1,13 @@
 import { BaseLocalResponse } from "../../parsing/baseLocalResponse.js";
-import { AsyncPredictResponse, Inference, PredictResponse } from "../../v1/index.js";
+import { AsyncPredictResponse, Inference, PredictResponse } from "../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 BaseLocalResponse {
-    /** Loads a local JSON payload into a typed prediction response wrapper. */
+    /**
+     * 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,12 +1,14 @@
 import { BaseLocalResponse } from "../../parsing/baseLocalResponse.js";
-import { AsyncPredictResponse, PredictResponse } from "../../v1/index.js";
+import { AsyncPredictResponse, PredictResponse } from "../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 BaseLocalResponse {
-    /** Loads a local JSON payload into a typed prediction response wrapper. */
+    /**
+     * Loads a local JSON payload into a typed prediction response wrapper.
+     */
     async loadPrediction(productClass) {
         /**
          * Load a prediction.

package/src/v1/parsing/standard/addressField.d.ts

@@ -5,21 +5,37 @@ import { StringField, FieldConstructor } from "./text.js";
  * address string through {@link StringField.value}.
  */
 export declare class AddressField extends StringField {
-    /** Street number. */
+    /**
+     * Street number.
+     */
     streetNumber?: string;
-    /** Street name. */
+    /**
+     * Street name.
+     */
     streetName?: string;
-    /** PO-box number. */
+    /**
+     * PO-box number.
+     */
     poBox?: string;
-    /** Additional address complement. */
+    /**
+     * Additional address complement.
+     */
     addressComplement?: string;
-    /** City or locality. */
+    /**
+     * City or locality.
+     */
     city?: string;
-    /** Postal / ZIP code. */
+    /**
+     * Postal / ZIP code.
+     */
     postalCode?: string;
-    /** State, province or region. */
+    /**
+     * State, province or region.
+     */
     state?: string;
-    /** Country. */
+    /**
+     * Country.
+     */
     country?: string;
     constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
 }

package/src/v1/parsing/standard/amount.d.ts

@@ -4,7 +4,9 @@ import { BaseFieldConstructor } from "./base.js";
  * A field containing an amount value.
  */
 export declare class AmountField extends Field {
-    /** The value. */
+    /**
+     * The value.
+     */
     value?: number;
     /**
      * @param {BaseFieldConstructor} constructor Constructor parameters.