mindee 4.36.3 → 5.0.0-alpha1

package/src/parsing/standard/amount.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AmountField = void 0;
-const field_1 = require("./field");
-const common_1 = require("../common");
-/**
- * A field containing an amount value.
- */
-class AmountField extends field_1.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 (0, common_1.floatToString)(this.value);
-        }
-        return "";
-    }
-}
-exports.AmountField = AmountField;

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

@@ -1,38 +0,0 @@
-import { StringDict } from "../common";
-/**
- * @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/parsing/standard/base.js

@@ -1,58 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseField = void 0;
-/**
- * Base class for most fields.
- */
-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 "";
-    }
-}
-exports.BaseField = BaseField;

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

@@ -1,17 +0,0 @@
-import { StringDict } from "../common";
-import { Field } from "./field";
-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/parsing/standard/boolean.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BooleanField = void 0;
-const field_1 = require("./field");
-/**
- * A field containing a text value.
- */
-class BooleanField extends field_1.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 "";
-    }
-}
-exports.BooleanField = BooleanField;

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

@@ -1,11 +0,0 @@
-import { BaseField, BaseFieldConstructor } from "./base";
-/**
- * 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/parsing/standard/classification.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ClassificationField = void 0;
-const base_1 = require("./base");
-/**
- * Represents a classifier value.
- */
-class ClassificationField extends base_1.BaseField {
-    constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId = undefined, }) {
-        super({ prediction, valueKey, reconstructed, pageId });
-        this.confidence = prediction["confidence"] ? prediction["confidence"] : 0.0;
-    }
-}
-exports.ClassificationField = ClassificationField;

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

@@ -1,15 +0,0 @@
-import { Field } from "./field";
-import { BaseFieldConstructor } from "./base";
-/**
- * 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/parsing/standard/companyRegistration.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CompanyRegistrationField = void 0;
-const field_1 = require("./field");
-const common_1 = require("../common");
-/**
- * A company registration item.
- */
-class CompanyRegistrationField extends field_1.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"] = (0, common_1.cleanOutString)(this.type);
-        printable["value"] = (0, common_1.cleanOutString)((this.value ?? "").toString());
-        return printable;
-    }
-}
-exports.CompanyRegistrationField = CompanyRegistrationField;

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

@@ -1,18 +0,0 @@
-import { Field } from "./field";
-import { BaseFieldConstructor } from "./base";
-/**
- * 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/parsing/standard/date.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DateField = void 0;
-const field_1 = require("./field");
-/**
- * A field containing a date value.
- */
-class DateField extends field_1.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();
-    }
-}
-exports.DateField = DateField;

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

@@ -1,35 +0,0 @@
-import { BaseField, BaseFieldConstructor } from "./base";
-import { Polygon, BoundingBox } from "../../geometry";
-/**
- * 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/parsing/standard/field.js

@@ -1,57 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Field = void 0;
-const base_1 = require("./base");
-const geometry_1 = require("../../geometry");
-/**
- * A basic field with position and page information.
- */
-class Field extends base_1.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 geometry_1.Polygon();
-        this.confidence = prediction["confidence"] ? prediction["confidence"] : 0.0;
-        if (prediction["polygon"]) {
-            this.polygon = prediction["polygon"];
-        }
-        this.boundingBox = (0, geometry_1.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;
-    }
-}
-exports.Field = Field;

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

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

package/src/parsing/standard/index.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PositionField = exports.PaymentDetailsField = exports.StringField = exports.TaxField = exports.Taxes = exports.Field = exports.LocaleField = exports.DateField = exports.CompanyRegistrationField = exports.ClassificationField = exports.BooleanField = exports.BaseField = exports.AmountField = exports.AddressField = void 0;
-var addressField_1 = require("./addressField");
-Object.defineProperty(exports, "AddressField", { enumerable: true, get: function () { return addressField_1.AddressField; } });
-var amount_1 = require("./amount");
-Object.defineProperty(exports, "AmountField", { enumerable: true, get: function () { return amount_1.AmountField; } });
-var base_1 = require("./base");
-Object.defineProperty(exports, "BaseField", { enumerable: true, get: function () { return base_1.BaseField; } });
-var boolean_1 = require("./boolean");
-Object.defineProperty(exports, "BooleanField", { enumerable: true, get: function () { return boolean_1.BooleanField; } });
-var classification_1 = require("./classification");
-Object.defineProperty(exports, "ClassificationField", { enumerable: true, get: function () { return classification_1.ClassificationField; } });
-var companyRegistration_1 = require("./companyRegistration");
-Object.defineProperty(exports, "CompanyRegistrationField", { enumerable: true, get: function () { return companyRegistration_1.CompanyRegistrationField; } });
-var date_1 = require("./date");
-Object.defineProperty(exports, "DateField", { enumerable: true, get: function () { return date_1.DateField; } });
-var locale_1 = require("./locale");
-Object.defineProperty(exports, "LocaleField", { enumerable: true, get: function () { return locale_1.LocaleField; } });
-var field_1 = require("./field");
-Object.defineProperty(exports, "Field", { enumerable: true, get: function () { return field_1.Field; } });
-var tax_1 = require("./tax");
-Object.defineProperty(exports, "Taxes", { enumerable: true, get: function () { return tax_1.Taxes; } });
-Object.defineProperty(exports, "TaxField", { enumerable: true, get: function () { return tax_1.TaxField; } });
-var text_1 = require("./text");
-Object.defineProperty(exports, "StringField", { enumerable: true, get: function () { return text_1.StringField; } });
-var paymentDetails_1 = require("./paymentDetails");
-Object.defineProperty(exports, "PaymentDetailsField", { enumerable: true, get: function () { return paymentDetails_1.PaymentDetailsField; } });
-var position_1 = require("./position");
-Object.defineProperty(exports, "PositionField", { enumerable: true, get: function () { return position_1.PositionField; } });

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

@@ -1,24 +0,0 @@
-import { BaseField, BaseFieldConstructor } from "./base";
-/**
- * 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/parsing/standard/locale.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LocaleField = void 0;
-const base_1 = require("./base");
-/**
- * The locale detected on the document.
- */
-class LocaleField extends base_1.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();
-    }
-}
-exports.LocaleField = LocaleField;

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

@@ -1,47 +0,0 @@
-import { StringDict } from "../common";
-import { Field } from "./field";
-/**
- * @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/parsing/standard/paymentDetails.js

@@ -1,60 +0,0 @@
-"use strict";
-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;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PaymentDetailsField = void 0;
-const field_1 = require("./field");
-/**
- * Information on a single payment.
- */
-class PaymentDetailsField extends field_1.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;
-    }
-}
-exports.PaymentDetailsField = PaymentDetailsField;
-_a = PaymentDetailsField, _PaymentDetailsField_isKeySet = function _PaymentDetailsField_isKeySet(value) {
-    return typeof value === "string" && value !== "N/A";
-};

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

@@ -1,27 +0,0 @@
-import { StringDict } from "../common";
-import { Polygon } from "../../geometry";
-export interface PositionFieldConstructor {
-    prediction: StringDict;
-    valueKey?: string;
-    pageId?: number | undefined;
-}
-/**
- * A field indicating a position or area on the document.
- */
-export declare class PositionField {
-    /** Straight rectangle. */
-    boundingBox: Polygon;
-    /** Free polygon with up to 30 vertices. */
-    polygon: Polygon;
-    /** Free polygon with 4 vertices. */
-    quadrangle: Polygon;
-    /** Rectangle that may be oriented (can go beyond the canvas). */
-    rectangle: Polygon;
-    /** The document page on which the information was found. */
-    pageId: number | undefined;
-    constructor({ prediction, pageId }: PositionFieldConstructor);
-    /**
-     * Default string representation.
-     */
-    toString(): string;
-}