mindee 5.9.0 → 5.10.0

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

@@ -1,16 +1,28 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { BaseFieldConstructor } from "../standard/index.js";
-/** A JSON-like object, with miscellaneous values. */
+/**
+ * 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 "../standard/index.js";
-/** A JSON-like object, with miscellaneous values. */
+/**
+ * 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

@@ -6,6 +6,8 @@ import { StringDict } from "../../parsing/index.js";
  * 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

@@ -6,7 +6,9 @@ import { MindeeError } from "../../errors/index.js";
  * 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.

package/src/v1/parsing/standard/amount.js

@@ -9,7 +9,9 @@ export class AmountField extends Field {
      */
     constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId = undefined, }) {
         super({ prediction, valueKey, reconstructed, pageId });
-        /** The value. */
+        /**
+         * The value.
+         */
         this.value = undefined;
         this.value = +parseFloat(prediction[valueKey]);
         if (isNaN(this.value)) {

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

@@ -5,32 +5,50 @@ import { StringDict } from "../../../parsing/stringDict.js";
  * @property {boolean} reconstructed - Is the object reconstructed (not extracted by the API).
  * @property {number} pageId - Page ID for multi-page document.
  */
-/** Constructor payload shared by standard v1 fields. */
+/**
+ * Constructor payload shared by standard v1 fields.
+ */
 export interface BaseFieldConstructor {
-    /** Raw field payload from API response. */
+    /**
+     * Raw field payload from API response.
+     */
     prediction: StringDict;
-    /** Key to read from `prediction` as field value. */
+    /**
+     * Key to read from `prediction` as field value.
+     */
     valueKey?: string;
-    /** Whether the field was reconstructed locally. */
+    /**
+     * Whether the field was reconstructed locally.
+     */
     reconstructed?: boolean;
-    /** Optional page identifier for multi-page documents. */
+    /**
+     * Optional page identifier for multi-page documents.
+     */
     pageId?: number;
 }
 /**
  * Base class for most fields.
  */
 export declare class BaseField {
-    /** The value. */
+    /**
+     * The value.
+     */
     value?: string | number | boolean;
-    /** `true` when the field was reconstructed or computed using other fields. */
+    /**
+     * `true` when the field was reconstructed or computed using other fields.
+     */
     reconstructed: boolean;
-    /** Page ID for multi-page document. */
+    /**
+     * Page ID for multi-page document.
+     */
     pageId?: number;
     /**
      * @param {BaseFieldConstructor} constructor Constructor parameters.
      */
     constructor({ prediction, valueKey, reconstructed, pageId, }: BaseFieldConstructor);
-    /** Compares two field values for semantic equality. */
+    /**
+     * Compares two field values for semantic equality.
+     */
     compare(other: BaseField): boolean;
     /**
      * @param {BaseField[]} array - Array of Fields

package/src/v1/parsing/standard/base.js

@@ -6,7 +6,9 @@ export class BaseField {
      * @param {BaseFieldConstructor} constructor Constructor parameters.
      */
     constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId = undefined, }) {
-        /** The value. */
+        /**
+         * The value.
+         */
         this.value = undefined;
         this.reconstructed = reconstructed;
         if (prediction !== undefined &&
@@ -17,7 +19,9 @@ export class BaseField {
             this.pageId = pageId !== undefined ? pageId : prediction["page_id"];
         }
     }
-    /** Compares two field values for semantic equality. */
+    /**
+     * Compares two field values for semantic equality.
+     */
     compare(other) {
         if (this.value === null && other.value === null)
             return true;

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

@@ -10,7 +10,9 @@ export interface FieldConstructor {
  * A field containing a text value.
  */
 export declare class BooleanField extends Field {
-    /** The value. */
+    /**
+     * The value.
+     */
     value?: boolean;
     constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
     toString(): string;

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

@@ -3,9 +3,13 @@ import { BaseField, BaseFieldConstructor } from "./base.js";
  * Represents a classifier value.
  */
 export declare class ClassificationField extends BaseField {
-    /** The confidence score of the prediction. */
+    /**
+     * The confidence score of the prediction.
+     */
     confidence: number;
-    /** The classification. */
+    /**
+     * The classification.
+     */
     value?: string;
     constructor({ prediction, valueKey, reconstructed, pageId, }: BaseFieldConstructor);
 }

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

@@ -4,12 +4,18 @@ import { BaseFieldConstructor } from "./base.js";
  * A company registration item.
  */
 export declare class CompanyRegistrationField extends Field {
-    /** Registration identifier. */
+    /**
+     * Registration identifier.
+     */
     value?: string;
-    /** Type of company registration. */
+    /**
+     * Type of company registration.
+     */
     type: string;
     constructor({ prediction, valueKey, reconstructed, pageId, }: BaseFieldConstructor);
-    /** Returns a row-formatted representation for table output. */
+    /**
+     * Returns a row-formatted representation for table output.
+     */
     toTableLine(): string;
     toString(): string;
     private printableValues;

package/src/v1/parsing/standard/companyRegistration.js

@@ -8,7 +8,9 @@ export class CompanyRegistrationField extends Field {
         super({ prediction, valueKey, reconstructed, pageId });
         this.type = prediction["type"];
     }
-    /** Returns a row-formatted representation for table output. */
+    /**
+     * Returns a row-formatted representation for table output.
+     */
     toTableLine() {
         const printable = this.printableValues();
         return `| ${printable["type"].padEnd(15)} | ${printable["value"].padEnd(20)} `;

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

@@ -4,16 +4,24 @@ import { BaseFieldConstructor } from "./base.js";
  * A field containing a date value.
  */
 export declare class DateField extends Field {
-    /** Date string in ISO format. */
+    /**
+     * Date string in ISO format.
+     */
     value?: string;
-    /** Date as a standard JavaScript `Date` object. */
+    /**
+     * Date as a standard JavaScript `Date` object.
+     */
     dateObject?: Date;
-    /** Whether the field was computed or retrieved directly from the document. */
+    /**
+     * Whether the field was computed or retrieved directly from the document.
+     */
     isComputed?: boolean;
     /**
      * @param {BaseFieldConstructor} constructor Constructor parameters.
      */
     constructor({ prediction, valueKey, reconstructed, pageId, }: BaseFieldConstructor);
-    /** Compares two dates by calendar day (year/month/day). */
+    /**
+     * Compares two dates by calendar day (year/month/day).
+     */
     static compareDates(date1: Date, date2: Date): boolean;
 }

package/src/v1/parsing/standard/date.js

@@ -23,7 +23,9 @@ export class DateField extends Field {
             }
         }
     }
-    /** Compares two dates by calendar day (year/month/day). */
+    /**
+     * Compares two dates by calendar day (year/month/day).
+     */
     static compareDates(date1, date2) {
         return date1.getFullYear() === date2.getFullYear() &&
             date1.getMonth() === date2.getMonth() &&

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

@@ -14,17 +14,19 @@ export declare class Field extends BaseField {
      * the field in the document.
      */
     polygon: Polygon;
-    /** The confidence score of the prediction. */
+    /**
+     * The confidence score of the prediction.
+     */
     confidence: number;
     /**
      * @param {BaseFieldConstructor} constructor Constructor parameters.
      */
     constructor({ prediction, valueKey, reconstructed, pageId, }: BaseFieldConstructor);
     /**
-    @param array1 first Array of Fields
-    @param array2 second Array of Fields
-    @param attr Attribute to compare
-    @returns true if all elements in array1 exist in array2 and vice-versa, false otherwise
+     * @param array1 first Array of Fields
+     * @param array2 second Array of Fields
+     * @param attr Attribute to compare
+     * @returns true if all elements in array1 exist in array2 and vice-versa, false otherwise
      */
     static compareArrays(array1: Field[], array2: Field[], attr?: string): boolean;
     /**

package/src/v1/parsing/standard/field.js

@@ -21,10 +21,10 @@ export class Field extends BaseField {
         this.boundingBox = getBoundingBox(this.polygon);
     }
     /**
-    @param array1 first Array of Fields
-    @param array2 second Array of Fields
-    @param attr Attribute to compare
-    @returns true if all elements in array1 exist in array2 and vice-versa, false otherwise
+     * @param array1 first Array of Fields
+     * @param array2 second Array of Fields
+     * @param attr Attribute to compare
+     * @returns true if all elements in array1 exist in array2 and vice-versa, false otherwise
      */
     static compareArrays(array1, array2, attr = "value") {
         const list1 = array1.map((item) => item[attr]);

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

@@ -3,15 +3,25 @@ import { BaseField, BaseFieldConstructor } from "./base.js";
  * The locale detected on the document.
  */
 export declare class LocaleField extends BaseField {
-    /** Locale in ISO format. */
+    /**
+     * Locale in ISO format.
+     */
     value?: string;
-    /** The confidence score of the prediction. */
+    /**
+     * The confidence score of the prediction.
+     */
     confidence: number;
-    /** ISO 639-1 language code */
+    /**
+     * ISO 639-1 language code
+     */
     language?: string;
-    /** ISO 3166-1 alpha-2 (or alpha-3) country code */
+    /**
+     * ISO 3166-1 alpha-2 (or alpha-3) country code
+     */
     country?: string;
-    /** ISO 4217 currency code */
+    /**
+     * ISO 4217 currency code
+     */
     currency?: string;
     /**
      * @param {BaseFieldConstructor} constructor Constructor parameters.

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

@@ -25,15 +25,25 @@ interface PaymentDetailsConstructor {
  */
 export declare class PaymentDetailsField extends Field {
     #private;
-    /** Synonym for the `iban` property */
+    /**
+     * Synonym for the `iban` property
+     */
     value?: string;
-    /** The account number. */
+    /**
+     * The account number.
+     */
     accountNumber?: string;
-    /** The International Bank Account Number (IBAN). */
+    /**
+     * The International Bank Account Number (IBAN).
+     */
     iban?: string;
-    /** The routing number. */
+    /**
+     * The routing number.
+     */
     routingNumber?: string;
-    /** The bank's SWIFT Business Identifier Code (BIC). */
+    /**
+     * The bank's SWIFT Business Identifier Code (BIC).
+     */
     swift?: string;
     /**
      * @param {PaymentDetailsConstructor} constructor Constructor parameters.

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

@@ -9,15 +9,25 @@ export interface PositionFieldConstructor {
  * A field indicating a position or area on the document.
  */
 export declare class PositionField {
-    /** Straight rectangle. */
+    /**
+     * Straight rectangle.
+     */
     boundingBox: Polygon;
-    /** Free polygon with up to 30 vertices. */
+    /**
+     * Free polygon with up to 30 vertices.
+     */
     polygon: Polygon;
-    /** Free polygon with 4 vertices. */
+    /**
+     * Free polygon with 4 vertices.
+     */
     quadrangle: Polygon;
-    /** Rectangle that may be oriented (can go beyond the canvas). */
+    /**
+     * Rectangle that may be oriented (can go beyond the canvas).
+     */
     rectangle: Polygon;
-    /** The document page on which the information was found. */
+    /**
+     * The document page on which the information was found.
+     */
     pageId?: number;
     constructor({ prediction, pageId }: PositionFieldConstructor);
     /**

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

@@ -16,15 +16,25 @@ interface TaxConstructor extends BaseFieldConstructor {
  */
 export declare class TaxField extends Field {
     #private;
-    /** The tax amount. */
+    /**
+     * The tax amount.
+     */
     value?: number;
-    /** The tax rate. */
+    /**
+     * The tax rate.
+     */
     rate?: number;
-    /**  The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..). */
+    /**
+     * The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..).
+     */
     code?: string;
-    /**  The tax base */
+    /**
+     * The tax base
+     */
     base?: number;
-    /** The document page on which the information was found. */
+    /**
+     * The document page on which the information was found.
+     */
     pageId: number;
     /**
      * @param {TaxConstructor} constructor Constructor parameters.
@@ -44,7 +54,9 @@ export declare class TaxField extends Field {
  */
 export declare class Taxes extends Array<TaxField> {
     #private;
-    /** Populates the taxes collection from raw prediction entries. */
+    /**
+     * Populates the taxes collection from raw prediction entries.
+     */
     init(prediction: StringDict[] | undefined, pageId: number | undefined): this;
     /**
      * Default string representation.

package/src/v1/parsing/standard/tax.js

@@ -16,13 +16,21 @@ export class TaxField extends Field {
     constructor({ prediction = {}, valueKey = "value", rateKey = "rate", codeKey = "code", baseKey = "base", reconstructed = false, pageId = undefined, }) {
         super({ prediction, valueKey, reconstructed, pageId });
         _TaxField_instances.add(this);
-        /** The tax amount. */
+        /**
+         * The tax amount.
+         */
         this.value = undefined;
-        /** The tax rate. */
+        /**
+         * The tax rate.
+         */
         this.rate = undefined;
-        /**  The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..). */
+        /**
+         * The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..).
+         */
         this.code = undefined;
-        /**  The tax base */
+        /**
+         * The tax base
+         */
         this.base = undefined;
         this.rate = +parseFloat(prediction[rateKey]);
         if (isNaN(this.rate))
@@ -86,7 +94,9 @@ export class Taxes extends Array {
         super(...arguments);
         _Taxes_instances.add(this);
     }
-    /** Populates the taxes collection from raw prediction entries. */
+    /**
+     * Populates the taxes collection from raw prediction entries.
+     */
     init(prediction = [], pageId) {
         for (const entry of prediction) {
             this.push(new TaxField({

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

@@ -10,9 +10,13 @@ export interface FieldConstructor {
  * A field containing a text value.
  */
 export declare class StringField extends Field {
-    /** The value. */
+    /**
+     * The value.
+     */
     value?: string;
-    /** Value as it appears on the document. */
+    /**
+     * Value as it appears on the document.
+     */
     rawValue?: string;
     constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
 }

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

@@ -1,15 +1,21 @@
 import { Polygon } from "../../../geometry/index.js";
 import { StringDict } from "../../../parsing/index.js";
-/** OCR word item with text, confidence, and location polygon. */
+/**
+ * OCR word item with text, confidence, and location polygon.
+ */
 export declare class Word {
     /**
      * Contains the relative vertices coordinates (points) of a polygon containing
      * the field in the document.
      */
     polygon: Polygon;
-    /** OCR text content for the word. */
+    /**
+     * OCR text content for the word.
+     */
     text: string;
-    /** Confidence score for the OCR word. */
+    /**
+     * Confidence score for the OCR word.
+     */
     confidence: number;
     constructor(rawPrediction: StringDict);
 }

package/src/v1/parsing/standard/word.js

@@ -1,5 +1,7 @@
 import { Polygon } from "../../../geometry/index.js";
-/** OCR word item with text, confidence, and location polygon. */
+/**
+ * OCR word item with text, confidence, and location polygon.
+ */
 export class Word {
     constructor(rawPrediction) {
         this.polygon = new Polygon(...rawPrediction["polygon"]);