mindee 4.36.3 → 5.0.0-alpha1

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

@@ -0,0 +1,25 @@
+import { StringField, FieldConstructor } from "./text.js";
+/**
+ * A field containing a detailed address value broken down into components
+ * (street number, city, postal code, …) while still exposing the full
+ * address string through {@link StringField.value}.
+ */
+export declare class AddressField extends StringField {
+    /** Street number. */
+    streetNumber?: string;
+    /** Street name. */
+    streetName?: string;
+    /** PO-box number. */
+    poBox?: string;
+    /** Additional address complement. */
+    addressComplement?: string;
+    /** City or locality. */
+    city?: string;
+    /** Postal / ZIP code. */
+    postalCode?: string;
+    /** State, province or region. */
+    state?: string;
+    /** Country. */
+    country?: string;
+    constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
+}

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

@@ -0,0 +1,36 @@
+import { StringField } from "./text.js";
+/**
+ * A field containing a detailed address value broken down into components
+ * (street number, city, postal code, …) while still exposing the full
+ * address string through {@link StringField.value}.
+ */
+export class AddressField extends StringField {
+    constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId, }) {
+        super({ prediction, valueKey, reconstructed, pageId });
+        // Populate the sub-components if they exist in the prediction object
+        if (prediction["street_number"]) {
+            this.streetNumber = prediction["street_number"];
+        }
+        if (prediction["street_name"]) {
+            this.streetName = prediction["street_name"];
+        }
+        if (prediction["po_box"]) {
+            this.poBox = prediction["po_box"];
+        }
+        if (prediction["address_complement"]) {
+            this.addressComplement = prediction["address_complement"];
+        }
+        if (prediction["city"]) {
+            this.city = prediction["city"];
+        }
+        if (prediction["postal_code"]) {
+            this.postalCode = prediction["postal_code"];
+        }
+        if (prediction["state"]) {
+            this.state = prediction["state"];
+        }
+        if (prediction["country"]) {
+            this.country = prediction["country"];
+        }
+    }
+}

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

@@ -0,0 +1,17 @@
+import { Field } from "./field.js";
+import { BaseFieldConstructor } from "./base.js";
+/**
+ * A field containing an amount value.
+ */
+export declare class AmountField extends Field {
+    /** The value. */
+    value?: number;
+    /**
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
+     */
+    constructor({ prediction, valueKey, reconstructed, pageId, }: BaseFieldConstructor);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

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

@@ -0,0 +1,29 @@
+import { Field } from "./field.js";
+import { floatToString } from "../../../v1/parsing/common/index.js";
+/**
+ * A field containing an amount value.
+ */
+export class AmountField extends Field {
+    /**
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
+     */
+    constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId = undefined, }) {
+        super({ prediction, valueKey, reconstructed, pageId });
+        /** The value. */
+        this.value = undefined;
+        this.value = +parseFloat(prediction[valueKey]);
+        if (isNaN(this.value)) {
+            this.value = undefined;
+            this.confidence = 0.0;
+        }
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        if (this.value !== undefined) {
+            return floatToString(this.value);
+        }
+        return "";
+    }
+}

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

@@ -0,0 +1,38 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+/**
+ * @property {object} prediction - Prediction object from HTTP response.
+ * @property {string} valueKey - Key to use in the prediction dict.
+ * @property {boolean} reconstructed - Is the object reconstructed (not extracted by the API).
+ * @property {number} pageId - Page ID for multi-page document.
+ */
+export interface BaseFieldConstructor {
+    prediction: StringDict;
+    valueKey?: string;
+    reconstructed?: boolean;
+    pageId?: number;
+}
+/**
+ * Base class for most fields.
+ */
+export declare class BaseField {
+    /** The value. */
+    value?: string | number | boolean;
+    /** `true` when the field was reconstructed or computed using other fields. */
+    reconstructed: boolean;
+    /** Page ID for multi-page document. */
+    pageId?: number;
+    /**
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
+     */
+    constructor({ prediction, valueKey, reconstructed, pageId, }: BaseFieldConstructor);
+    compare(other: BaseField): boolean;
+    /**
+     * @param {BaseField[]} array - Array of Fields
+     * @returns {number} Sum of all the Fields values in the array
+     */
+    static arraySum(array: BaseField[]): number;
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

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

@@ -0,0 +1,54 @@
+/**
+ * Base class for most fields.
+ */
+export class BaseField {
+    /**
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
+     */
+    constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId = undefined, }) {
+        /** The value. */
+        this.value = undefined;
+        this.reconstructed = reconstructed;
+        if (prediction !== undefined &&
+            prediction !== null &&
+            valueKey in prediction &&
+            prediction[valueKey] !== null) {
+            this.value = prediction[valueKey];
+            this.pageId = pageId !== undefined ? pageId : prediction["page_id"];
+        }
+    }
+    compare(other) {
+        if (this.value === null && other.value === null)
+            return true;
+        if (this.value === null || other.value === null)
+            return false;
+        if (typeof this.value === "string" && typeof other.value === "string") {
+            return this.value.toLowerCase() === other.value.toLowerCase();
+        }
+        return this.value === other.value;
+    }
+    /**
+     * @param {BaseField[]} array - Array of Fields
+     * @returns {number} Sum of all the Fields values in the array
+     */
+    static arraySum(array) {
+        let total = 0.0;
+        for (const field of array) {
+            if (typeof field.value !== "number")
+                return 0.0;
+            total += field.value;
+            if (isNaN(total))
+                return 0.0;
+        }
+        return total;
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        if (this.value !== undefined) {
+            return `${this.value}`;
+        }
+        return "";
+    }
+}

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

@@ -0,0 +1,17 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+import { Field } from "./field.js";
+export interface FieldConstructor {
+    prediction: StringDict;
+    valueKey?: string;
+    reconstructed?: boolean;
+    pageId?: number | undefined;
+}
+/**
+ * A field containing a text value.
+ */
+export declare class BooleanField extends Field {
+    /** The value. */
+    value?: boolean;
+    constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
+    toString(): string;
+}

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

@@ -0,0 +1,18 @@
+import { Field } from "./field.js";
+/**
+ * A field containing a text value.
+ */
+export class BooleanField extends Field {
+    constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId, }) {
+        super({ prediction, valueKey, reconstructed, pageId });
+    }
+    toString() {
+        if (this.value === true) {
+            return "True";
+        }
+        else if (this.value === false) {
+            return "False";
+        }
+        return "";
+    }
+}

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

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

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

@@ -0,0 +1,10 @@
+import { BaseField } from "./base.js";
+/**
+ * Represents a classifier value.
+ */
+export class ClassificationField extends BaseField {
+    constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId = undefined, }) {
+        super({ prediction, valueKey, reconstructed, pageId });
+        this.confidence = prediction["confidence"] ? prediction["confidence"] : 0.0;
+    }
+}

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

@@ -0,0 +1,15 @@
+import { Field } from "./field.js";
+import { BaseFieldConstructor } from "./base.js";
+/**
+ * A company registration item.
+ */
+export declare class CompanyRegistrationField extends Field {
+    /** Registration identifier. */
+    value?: string;
+    /** Type of company registration. */
+    type: string;
+    constructor({ prediction, valueKey, reconstructed, pageId, }: BaseFieldConstructor);
+    toTableLine(): string;
+    toString(): string;
+    private printableValues;
+}

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

@@ -0,0 +1,25 @@
+import { Field } from "./field.js";
+import { cleanOutString } from "../../../v1/parsing/common/index.js";
+/**
+ * A company registration item.
+ */
+export class CompanyRegistrationField extends Field {
+    constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId, }) {
+        super({ prediction, valueKey, reconstructed, pageId });
+        this.type = prediction["type"];
+    }
+    toTableLine() {
+        const printable = this.printableValues();
+        return `| ${printable["type"].padEnd(15)} | ${printable["value"].padEnd(20)} `;
+    }
+    toString() {
+        const printable = this.printableValues();
+        return `Type: ${printable["type"]}, Value: ${printable["value"]}`;
+    }
+    printableValues() {
+        const printable = {};
+        printable["type"] = cleanOutString(this.type);
+        printable["value"] = cleanOutString((this.value ?? "").toString());
+        return printable;
+    }
+}

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

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

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

@@ -0,0 +1,31 @@
+import { Field } from "./field.js";
+/**
+ * A field containing a date value.
+ */
+export class DateField extends Field {
+    /**
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
+     */
+    constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId, }) {
+        super({ prediction, valueKey, reconstructed, pageId });
+        if ("is_computed" in prediction) {
+            this.isComputed = prediction["is_computed"];
+        }
+        if (typeof this.value === "string") {
+            this.dateObject = new Date(this.value);
+            if (isNaN(this.dateObject.valueOf())) {
+                this.dateObject = undefined;
+                this.confidence = 0.0;
+                this.value = undefined;
+            }
+            else {
+                this.dateObject.setUTCHours(0, 0, 0, 0);
+            }
+        }
+    }
+    static compareDates(date1, date2) {
+        return date1.getFullYear() === date2.getFullYear() &&
+            date1.getMonth() === date2.getMonth() &&
+            date1.getDate() === date2.getDate();
+    }
+}

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

@@ -0,0 +1,35 @@
+import { BaseField, BaseFieldConstructor } from "./base.js";
+import { Polygon, BoundingBox } from "../../../geometry/index.js";
+/**
+ * A basic field with position and page information.
+ */
+export declare class Field extends BaseField {
+    /**
+     * Contains exactly 4 relative vertices coordinates (points) of a right
+     * rectangle containing the field in the document.
+     */
+    boundingBox: BoundingBox;
+    /**
+     * Contains the relative vertices coordinates (points) of a polygon containing
+     * the field in the document.
+     */
+    polygon: Polygon;
+    /** 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
+     */
+    static compareArrays(array1: Field[], array2: Field[], attr?: string): boolean;
+    /**
+     * @param {Field[]} array - Array of Fields
+     * @returns {number} product of all the fields probability
+     */
+    static arrayConfidence(array: Field[]): number;
+}

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

@@ -0,0 +1,53 @@
+import { BaseField } from "./base.js";
+import { Polygon, getBoundingBox } from "../../../geometry/index.js";
+/**
+ * A basic field with position and page information.
+ */
+export class Field extends BaseField {
+    /**
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
+     */
+    constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId, }) {
+        super({ prediction, valueKey, reconstructed, pageId });
+        /**
+         * Contains the relative vertices coordinates (points) of a polygon containing
+         * the field in the document.
+         */
+        this.polygon = new Polygon();
+        this.confidence = prediction["confidence"] ? prediction["confidence"] : 0.0;
+        if (prediction["polygon"]) {
+            this.polygon = prediction["polygon"];
+        }
+        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
+     */
+    static compareArrays(array1, array2, attr = "value") {
+        const list1 = array1.map((item) => item[attr]);
+        const list2 = array2.map((item) => item[attr]);
+        if (list1.length !== list2.length)
+            return false;
+        for (const item1 of list1) {
+            if (!list2.includes(item1))
+                return false;
+        }
+        return true;
+    }
+    /**
+     * @param {Field[]} array - Array of Fields
+     * @returns {number} product of all the fields probability
+     */
+    static arrayConfidence(array) {
+        let total = 1.0;
+        for (const field of array) {
+            total *= field.confidence;
+            if (isNaN(total))
+                return 0.0;
+        }
+        return total;
+    }
+}

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

@@ -0,0 +1,15 @@
+export { AddressField } from "./addressField.js";
+export { AmountField } from "./amount.js";
+export { BaseField } from "./base.js";
+export type { BaseFieldConstructor } from "./base.js";
+export { BooleanField } from "./boolean.js";
+export { ClassificationField } from "./classification.js";
+export { CompanyRegistrationField } from "./companyRegistration.js";
+export { DateField } from "./date.js";
+export { LocaleField } from "./locale.js";
+export { Field } from "./field.js";
+export { Taxes, TaxField } from "./tax.js";
+export { StringField } from "./text.js";
+export { PaymentDetailsField } from "./paymentDetails.js";
+export { PositionField } from "./position.js";
+export type { Word } from "./word.js";

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

@@ -0,0 +1,13 @@
+export { AddressField } from "./addressField.js";
+export { AmountField } from "./amount.js";
+export { BaseField } from "./base.js";
+export { BooleanField } from "./boolean.js";
+export { ClassificationField } from "./classification.js";
+export { CompanyRegistrationField } from "./companyRegistration.js";
+export { DateField } from "./date.js";
+export { LocaleField } from "./locale.js";
+export { Field } from "./field.js";
+export { Taxes, TaxField } from "./tax.js";
+export { StringField } from "./text.js";
+export { PaymentDetailsField } from "./paymentDetails.js";
+export { PositionField } from "./position.js";

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

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

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

@@ -0,0 +1,39 @@
+import { BaseField } from "./base.js";
+/**
+ * The locale detected on the document.
+ */
+export class LocaleField extends BaseField {
+    /**
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
+     */
+    constructor({ prediction = {}, reconstructed = false, pageId = undefined, }) {
+        const valueKey = prediction["value"] ? "value" : "language";
+        super({ prediction, valueKey, reconstructed, pageId });
+        this.confidence = prediction["confidence"] ? prediction["confidence"] : 0.0;
+        this.language =
+            prediction["language"] !== undefined ? prediction["language"] : undefined;
+        this.country =
+            prediction["country"] !== undefined ? prediction["country"] : undefined;
+        this.currency =
+            prediction["currency"] !== undefined ? prediction["currency"] : undefined;
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        let outStr = "";
+        if (this.value) {
+            outStr += `${this.value}; `;
+        }
+        if (this.language) {
+            outStr += `${this.language}; `;
+        }
+        if (this.country) {
+            outStr += `${this.country}; `;
+        }
+        if (this.currency) {
+            outStr += `${this.currency};`;
+        }
+        return outStr.trimEnd();
+    }
+}

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

@@ -0,0 +1,47 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+import { Field } from "./field.js";
+/**
+ * @property {StringDict} constructor.prediction - Prediction object from HTTP response
+ * @property {string} constructor.valueKey - Key to use in the prediction dict to get the iban.
+ * @property {string} constructor.accountNumberKey - Key to use to get the account number in the prediction dict.
+ * @property {string} constructor.ibanKey - Key to use to get the IBAN in the prediction dict.
+ * @property {string} constructor.routingNumberKey - Key to use to get the routing number in the prediction dict.
+ * @property {string} constructor.swiftKey - Key to use to get the SWIFT in the prediction dict.
+ * @property {boolean} constructor.reconstructed - Is the object reconstructed (not extracted by the API).
+ * @property {number} constructor.pageId - Page ID for multi-page document.
+ */
+interface PaymentDetailsConstructor {
+    prediction: StringDict;
+    valueKey?: string;
+    accountNumberKey?: string;
+    ibanKey?: string;
+    routingNumberKey?: string;
+    swiftKey?: string;
+    reconstructed?: boolean;
+    pageId?: number;
+}
+/**
+ * Information on a single payment.
+ */
+export declare class PaymentDetailsField extends Field {
+    #private;
+    /** Synonym for the `iban` property */
+    value?: string | undefined;
+    /** The account number. */
+    accountNumber: string | undefined;
+    /** The International Bank Account Number (IBAN). */
+    iban: string | undefined;
+    /** The routing number. */
+    routingNumber: string | undefined;
+    /** The bank's SWIFT Business Identifier Code (BIC). */
+    swift: string | undefined;
+    /**
+     * @param {PaymentDetailsConstructor} constructor Constructor parameters.
+     */
+    constructor({ prediction, valueKey, accountNumberKey, ibanKey, routingNumberKey, swiftKey, reconstructed, pageId, }: PaymentDetailsConstructor);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}
+export {};

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

@@ -0,0 +1,56 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _a, _PaymentDetailsField_isKeySet;
+import { Field } from "./field.js";
+/**
+ * Information on a single payment.
+ */
+export class PaymentDetailsField extends Field {
+    /**
+     * @param {PaymentDetailsConstructor} constructor Constructor parameters.
+     */
+    constructor({ prediction = {}, valueKey = "iban", accountNumberKey = "account_number", ibanKey = "iban", routingNumberKey = "routing_number", swiftKey = "swift", reconstructed = false, pageId = undefined, }) {
+        super({ prediction, valueKey, reconstructed, pageId });
+        this.accountNumber = undefined;
+        this.iban = undefined;
+        this.routingNumber = undefined;
+        this.swift = undefined;
+        if (__classPrivateFieldGet(_a, _a, "m", _PaymentDetailsField_isKeySet).call(_a, prediction[accountNumberKey])) {
+            this.accountNumber = prediction[accountNumberKey];
+        }
+        if (__classPrivateFieldGet(_a, _a, "m", _PaymentDetailsField_isKeySet).call(_a, prediction[ibanKey])) {
+            this.iban = prediction[ibanKey];
+        }
+        if (__classPrivateFieldGet(_a, _a, "m", _PaymentDetailsField_isKeySet).call(_a, prediction[routingNumberKey])) {
+            this.routingNumber = prediction[routingNumberKey];
+        }
+        if (__classPrivateFieldGet(_a, _a, "m", _PaymentDetailsField_isKeySet).call(_a, prediction[swiftKey])) {
+            this.swift = prediction[swiftKey];
+        }
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        let str = "";
+        if (this.accountNumber !== undefined) {
+            str += `${this.accountNumber}; `;
+        }
+        if (this.iban !== undefined) {
+            str += `${this.iban}; `;
+        }
+        if (this.routingNumber !== undefined) {
+            str += `${this.routingNumber}; `;
+        }
+        if (this.swift !== undefined) {
+            str += `${this.swift}; `;
+        }
+        return str;
+    }
+}
+_a = PaymentDetailsField, _PaymentDetailsField_isKeySet = function _PaymentDetailsField_isKeySet(value) {
+    return typeof value === "string" && value !== "N/A";
+};