mindee 4.36.2 → 5.0.0-alpha1

package/src/parsing/common/workflowResponse.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkflowResponse = void 0;
-const apiResponse_1 = require("./apiResponse");
-const execution_1 = require("./execution");
-/** Wrapper for workflow requests.
- *
- * @category API Response
- * @category Workflow
- */
-class WorkflowResponse extends apiResponse_1.ApiResponse {
-    constructor(inferenceClass, serverResponse) {
-        super(serverResponse);
-        this.execution = new execution_1.Execution(inferenceClass, serverResponse["execution"]);
-    }
-}
-exports.WorkflowResponse = WorkflowResponse;

package/src/parsing/custom/classificationField.d.ts

@@ -1,19 +0,0 @@
-import { StringDict } from "../common";
-export declare class ClassificationField {
-    /** The value for the classification. */
-    value: string;
-    /**
-     * The confidence score of the prediction.
-     * Note: Score is calculated on **word selection**, not its textual content (OCR).
-     */
-    confidence: number;
-    pageId?: number;
-    constructor({ prediction, pageId, }: {
-        prediction: StringDict;
-        pageId?: number;
-    });
-    /**
-     * Default string representation.
-     */
-    toString(): string;
-}

package/src/parsing/custom/classificationField.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ClassificationField = void 0;
-class ClassificationField {
-    constructor({ prediction, pageId, }) {
-        this.value = prediction["value"];
-        this.confidence = prediction["confidence"];
-        this.pageId ?? (this.pageId = pageId);
-    }
-    /**
-     * Default string representation.
-     */
-    toString() {
-        return `${this.value}`;
-    }
-}
-exports.ClassificationField = ClassificationField;

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

@@ -1,3 +0,0 @@
-export { CustomLine, CustomLines, getLineItems } from "./lineItems";
-export { ClassificationField } from "./classificationField";
-export { ListField, ListFieldValue } from "./listField";

package/src/parsing/custom/index.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListFieldValue = exports.ListField = exports.ClassificationField = exports.getLineItems = exports.CustomLines = exports.CustomLine = void 0;
-var lineItems_1 = require("./lineItems");
-Object.defineProperty(exports, "CustomLine", { enumerable: true, get: function () { return lineItems_1.CustomLine; } });
-Object.defineProperty(exports, "CustomLines", { enumerable: true, get: function () { return lineItems_1.CustomLines; } });
-Object.defineProperty(exports, "getLineItems", { enumerable: true, get: function () { return lineItems_1.getLineItems; } });
-var classificationField_1 = require("./classificationField");
-Object.defineProperty(exports, "ClassificationField", { enumerable: true, get: function () { return classificationField_1.ClassificationField; } });
-var listField_1 = require("./listField");
-Object.defineProperty(exports, "ListField", { enumerable: true, get: function () { return listField_1.ListField; } });
-Object.defineProperty(exports, "ListFieldValue", { enumerable: true, get: function () { return listField_1.ListFieldValue; } });

package/src/parsing/custom/lineItems.d.ts

@@ -1,33 +0,0 @@
-import { BBox, Polygon } from "../../geometry";
-import { ListField, ListFieldValue } from "./listField";
-export declare class CustomLine {
-    /**
-     * Number of the current line.
-     * Starts at 1.
-     */
-    rowNumber: number;
-    /**
-     * List of the fields associated to the current line, identified by their column name.
-     */
-    fields: Map<string, ListFieldValue>;
-    /**
-     * The BBox of the entire line, all fields included.
-     */
-    bbox: BBox;
-    constructor(rowNumber: number);
-    /**
-     * Extends the current bbox of the line with the bbox.
-     */
-    extendWithBbox(bbox: BBox): void;
-    /**
-     * Extends the current bbox of the line with the polygon.
-     */
-    extendWith(polygon: Polygon): void;
-    updateField(name: string, fieldValue: ListFieldValue): void;
-}
-export declare class CustomLines extends Array<CustomLine> {
-}
-/**
- * Get line items from fields.
- */
-export declare function getLineItems(anchorNames: string[], fieldNames: string[], fields: Map<string, ListField>, heightLineTolerance: number): CustomLines;

package/src/parsing/custom/lineItems.js

@@ -1,130 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomLines = exports.CustomLine = void 0;
-exports.getLineItems = getLineItems;
-const handler_1 = require("../../errors/handler");
-const errors_1 = require("../../errors");
-const geometry_1 = require("../../geometry");
-const listField_1 = require("./listField");
-class CustomLine {
-    constructor(rowNumber) {
-        this.rowNumber = rowNumber;
-        this.bbox = new geometry_1.BBox(1, 1, 0, 0);
-        this.fields = new Map();
-    }
-    /**
-     * Extends the current bbox of the line with the bbox.
-     */
-    extendWithBbox(bbox) {
-        this.bbox = (0, geometry_1.mergeBbox)(this.bbox, bbox);
-    }
-    /**
-     * Extends the current bbox of the line with the polygon.
-     */
-    extendWith(polygon) {
-        this.bbox = (0, geometry_1.mergeBbox)(this.bbox, (0, geometry_1.getBbox)(polygon));
-    }
-    updateField(name, fieldValue) {
-        if (!this.fields.has(name)) {
-            this.fields.set(name, fieldValue);
-        }
-        else {
-            const existingField = this.fields.get(name);
-            if (existingField === undefined) {
-                handler_1.errorHandler.throw(new errors_1.MindeeError(`The field '${name}' should exist but was not found.`));
-                return;
-            }
-            const mergedContent = existingField?.content === undefined
-                ? fieldValue.content
-                : existingField.content + " " + fieldValue.content;
-            const mergedBbox = (0, geometry_1.getBBoxForPolygons)([
-                existingField.polygon,
-                fieldValue.polygon,
-            ]);
-            this.fields.set(name, new listField_1.ListFieldValue({
-                content: mergedContent,
-                confidence: existingField.confidence * fieldValue.confidence,
-                polygon: (0, geometry_1.getBoundingBoxFromBBox)(mergedBbox),
-            }));
-        }
-    }
-}
-exports.CustomLine = CustomLine;
-class CustomLines extends Array {
-}
-exports.CustomLines = CustomLines;
-/**
- * Get line items from fields.
- */
-function getLineItems(anchorNames, fieldNames, fields, heightLineTolerance) {
-    const fieldsToTransformIntoLines = new Map([...fields].filter(([k]) => fieldNames.includes(k)));
-    const anchorName = findBestAnchor(anchorNames, fieldsToTransformIntoLines);
-    const linesPrepared = prepare(anchorName, fieldsToTransformIntoLines, heightLineTolerance);
-    linesPrepared.forEach((currentLine) => {
-        fieldsToTransformIntoLines.forEach((field, fieldName) => {
-            field.values.forEach((listFieldValue) => {
-                const minMaxY = (0, geometry_1.getMinMaxY)(listFieldValue.polygon);
-                if (Math.abs(minMaxY.max - currentLine.bbox.yMax) <= heightLineTolerance &&
-                    Math.abs(minMaxY.min - currentLine.bbox.yMin) <= heightLineTolerance) {
-                    currentLine.updateField(fieldName, listFieldValue);
-                }
-            });
-        });
-    });
-    return linesPrepared;
-}
-/**
- * Loop through the possible anchor fields and find the one with the most values.
- */
-function findBestAnchor(possibleAnchorNames, fields) {
-    let anchorName = "";
-    let anchorRows = 0;
-    possibleAnchorNames.forEach((fieldName) => {
-        const fieldValues = fields.get(fieldName)?.values;
-        if (fieldValues !== undefined && fieldValues.length > anchorRows) {
-            anchorRows = fieldValues.length;
-            anchorName = fieldName;
-        }
-    });
-    if (anchorName === "") {
-        handler_1.errorHandler.throw(new errors_1.MindeeError("No anchor was found."));
-    }
-    return anchorName;
-}
-/**
- * Check if the bbox fits inside the line.
- */
-function isBboxInLine(line, bbox, heightTolerance) {
-    if (Math.abs(bbox.yMin - line.bbox.yMin) <= heightTolerance) {
-        return true;
-    }
-    return Math.abs(line.bbox.yMin - bbox.yMin) <= heightTolerance;
-}
-function prepare(anchorName, fields, heightLineTolerance) {
-    const linesPrepared = [];
-    const anchorField = fields.get(anchorName);
-    if (anchorField === undefined || anchorField.values.length === 0) {
-        handler_1.errorHandler.throw(new errors_1.MindeeError("No lines have been detected."));
-    }
-    let currentLineNumber = 1;
-    let currentLine = new CustomLine(currentLineNumber);
-    if (anchorField !== undefined) {
-        let currentValue = anchorField.values[0];
-        currentLine.extendWith(currentValue.polygon);
-        for (let index = 1; index < anchorField.values.length; index++) {
-            currentValue = anchorField.values[index];
-            const currentFieldBbox = (0, geometry_1.getBbox)(currentValue.polygon);
-            if (!isBboxInLine(currentLine, currentFieldBbox, heightLineTolerance)) {
-                linesPrepared.push(currentLine);
-                currentLineNumber++;
-                currentLine = new CustomLine(currentLineNumber);
-            }
-            currentLine.extendWithBbox(currentFieldBbox);
-        }
-        if (linesPrepared.filter((line) => line.rowNumber === currentLineNumber)
-            .length === 0) {
-            linesPrepared.push(currentLine);
-        }
-    }
-    return linesPrepared;
-}

package/src/parsing/custom/listField.d.ts

@@ -1,45 +0,0 @@
-import { BaseFieldConstructor } from "../standard";
-import { Polygon, BoundingBox } from "../../geometry";
-import { StringDict } from "../common";
-export declare class ListFieldValue {
-    /** Extracted content of the prediction */
-    content: string;
-    /**
-     * The confidence score of the prediction.
-     * Note: Score is calculated on **word selection**, not its textual content (OCR).
-     */
-    confidence: number;
-    /**
-     * Contains exactly 4 relative vertices coordinates (points) of a right
-     * rectangle containing the word in the document.
-     */
-    bbox?: BoundingBox;
-    /**
-     * Contains the relative vertices coordinates (points) of a polygon containing
-     * the word in the document.
-     */
-    polygon: Polygon;
-    /** The document page on which the information was found. */
-    pageId?: number;
-    constructor(prediction: StringDict, pageId?: number);
-    /**
-     * Default string representation.
-     */
-    toString(): string;
-}
-export declare class ListField {
-    readonly values: ListFieldValue[];
-    confidence: number;
-    /** True if the field was reconstructed or computed using other fields. */
-    reconstructed: boolean;
-    /**
-     * @param {BaseFieldConstructor} constructor Constructor parameters.
-     */
-    constructor({ prediction, reconstructed, pageId, }: BaseFieldConstructor);
-    contentsList(): Array<string | number>;
-    contentsString(separator?: string): string;
-    /**
-     * Default string representation.
-     */
-    toString(): string;
-}

package/src/parsing/custom/listField.js

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListField = exports.ListFieldValue = void 0;
-const geometry_1 = require("../../geometry");
-class ListFieldValue {
-    constructor(prediction, pageId) {
-        /**
-         * Contains the relative vertices coordinates (points) of a polygon containing
-         * the word in the document.
-         */
-        this.polygon = new geometry_1.Polygon();
-        this.content = prediction["content"];
-        this.confidence = prediction["confidence"];
-        if (prediction["polygon"]) {
-            this.polygon = prediction["polygon"];
-            this.bbox = (0, geometry_1.getBoundingBox)(prediction["polygon"]);
-        }
-        if (pageId !== undefined) {
-            this.pageId = pageId;
-        }
-    }
-    /**
-     * Default string representation.
-     */
-    toString() {
-        return `${this.content}`;
-    }
-}
-exports.ListFieldValue = ListFieldValue;
-class ListField {
-    /**
-     * @param {BaseFieldConstructor} constructor Constructor parameters.
-     */
-    constructor({ prediction = {}, reconstructed = false, pageId, }) {
-        this.values = [];
-        this.confidence = prediction["confidence"];
-        this.reconstructed = reconstructed;
-        if (prediction["values"] !== undefined) {
-            prediction["values"].forEach((field) => {
-                if (pageId === undefined) {
-                    pageId = field["page_id"];
-                }
-                this.values.push(new ListFieldValue(field, pageId));
-            });
-        }
-    }
-    contentsList() {
-        return this.values.map((item) => item.content);
-    }
-    contentsString(separator = " ") {
-        return this.values.map((item) => `${item.content}`).join(separator);
-    }
-    /**
-     * Default string representation.
-     */
-    toString() {
-        return this.contentsString();
-    }
-}
-exports.ListField = ListField;

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

@@ -1,31 +0,0 @@
-import { StringDict } from "../common";
-import { StringField } from "../standard";
-import { GeneratedObjectField } from "./generatedObject";
-export interface GeneratedListFieldConstructor {
-    prediction: StringDict[];
-    pageId?: number;
-}
-/**
- * A list of values or objects, used in generated APIs.
- */
-export declare class GeneratedListField {
-    /** Id of the page the object was found on. */
-    pageId?: number;
-    /** List of word values. */
-    values: Array<GeneratedObjectField | StringField>;
-    constructor({ prediction, pageId, }: GeneratedListFieldConstructor);
-    /**
-     * Returns an array of the contents of all values.
-     */
-    contentsList(): string[];
-    /**
-     * Return a string representation of all values.
-     * @param separator Character(s) to use when concatenating fields.
-     * @returns string representation.
-     */
-    contentsString(separator?: string): string;
-    /**
-     * Default string representation.
-     */
-    toString(): string;
-}

package/src/parsing/generated/generatedList.js

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GeneratedListField = void 0;
-const standard_1 = require("../standard");
-const generatedObject_1 = require("./generatedObject");
-/**
- * A list of values or objects, used in generated APIs.
- */
-class GeneratedListField {
-    constructor({ prediction = [], pageId = undefined, }) {
-        this.values = [];
-        for (const value of prediction) {
-            if (value["page_id"] !== undefined && value["page_id"] !== null) {
-                this.pageId = value["page_id"];
-            }
-            if ((0, generatedObject_1.isGeneratedObject)(value)) {
-                this.values.push(new generatedObject_1.GeneratedObjectField({ prediction: value, pageId }));
-            }
-            else {
-                const valueStr = { ...value };
-                if (valueStr["value"] !== null && valueStr["value"] !== undefined) {
-                    valueStr["value"] = value["value"].toString();
-                }
-                this.values.push(new standard_1.StringField({ prediction: valueStr, pageId: pageId }));
-            }
-        }
-    }
-    /**
-     * Returns an array of the contents of all values.
-     */
-    contentsList() {
-        return this.values.map((item) => item.toString());
-    }
-    /**
-     * Return a string representation of all values.
-     * @param separator Character(s) to use when concatenating fields.
-     * @returns string representation.
-     */
-    contentsString(separator = " ") {
-        return this.contentsList().map((item) => `${item.toString()}`).join(separator);
-    }
-    /**
-     * Default string representation.
-     */
-    toString() {
-        return this.contentsString();
-    }
-}
-exports.GeneratedListField = GeneratedListField;

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

@@ -1,35 +0,0 @@
-import { StringDict } from "../common";
-import { BaseFieldConstructor } from "../standard";
-/** A JSON-like object, with miscellaneous values. */
-export declare class GeneratedObjectField {
-    /** The document page on which the information was found. */
-    pageId?: number;
-    /** Confidence with which the value was assessed. */
-    confidence?: number;
-    /** Raw unprocessed value, as it was sent by the server. */
-    rawValue?: string;
-    /** List of all printable field names. */
-    private printableValues;
-    /** All potentially present fields. */
-    [key: string]: string | number | boolean | object | undefined;
-    constructor({ prediction, pageId, }: BaseFieldConstructor);
-    /**
-     * ReSTructured-compliant string representation.
-     Takes into account level of indentation & displays elements as list elements.
-     * @param level Level of indentation. 0 by default.
-     */
-    toStringLevel(level?: number): string;
-    /**
-     * Formats a float number to have at least one decimal place.
-     * @param n Input number.
-     * @returns
-     */
-    private toNumberString;
-    toString(): string;
-    get(fieldName: string): string | number | boolean | object | undefined;
-}
-/**
- * Checks whether a field is a custom object or not.
- * @param strDict input dictionary to check.
- */
-export declare function isGeneratedObject(strDict: StringDict): boolean;

package/src/parsing/generated/generatedObject.js

@@ -1,107 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GeneratedObjectField = void 0;
-exports.isGeneratedObject = isGeneratedObject;
-const standard_1 = require("../standard");
-/** A JSON-like object, with miscellaneous values. */
-class GeneratedObjectField {
-    constructor({ prediction = {}, pageId, }) {
-        let itemPageId = null;
-        this.printableValues = [];
-        for (const [fieldName, fieldValue] of Object.entries(prediction)) {
-            if (fieldName === "page_id") {
-                itemPageId = fieldValue;
-            }
-            else if (["polygon", "rectangle", "quadrangle", "bounding_box"].includes(fieldName)) {
-                Object.assign(this, {
-                    [fieldName]: new standard_1.PositionField({
-                        prediction: { [fieldName]: fieldValue },
-                        valueKey: fieldName,
-                        pageId: pageId,
-                    }),
-                });
-                this.printableValues.push(fieldName);
-            }
-            else if (fieldName === "confidence") {
-                this.confidence = fieldValue;
-            }
-            else if (fieldName === "raw_value") {
-                this.rawValue = fieldValue;
-            }
-            else {
-                if (fieldValue !== null &&
-                    fieldValue !== undefined &&
-                    typeof fieldValue === "number" &&
-                    !isNaN(fieldValue) &&
-                    fieldName !== "degrees") {
-                    Object.assign(this, { [fieldName]: this.toNumberString(fieldValue) });
-                }
-                else if (typeof fieldValue === "boolean") {
-                    Object.assign(this, { [fieldName]: fieldValue });
-                }
-                else {
-                    Object.assign(this, {
-                        [fieldName]: (fieldValue !== undefined && fieldValue !== null) ?
-                            String(fieldValue) : null,
-                    });
-                }
-                this.printableValues.push(fieldName);
-            }
-            this.pageId = pageId ?? itemPageId;
-        }
-    }
-    /**
-     * ReSTructured-compliant string representation.
-     Takes into account level of indentation & displays elements as list elements.
-     * @param level Level of indentation. 0 by default.
-     */
-    toStringLevel(level = 0) {
-        const indent = "  " + "  ".repeat(level);
-        let outStr = "";
-        this.printableValues.forEach((printableValue) => {
-            const strValue = this[printableValue];
-            outStr += `\n${indent}:${printableValue}: ${strValue !== null && strValue !== undefined ? strValue : ""}`;
-        });
-        return `\n${indent}${outStr.trim()}`;
-    }
-    /**
-     * Formats a float number to have at least one decimal place.
-     * @param n Input number.
-     * @returns
-     */
-    toNumberString(n) {
-        if (Number.isInteger(n)) {
-            return n + ".0";
-        }
-        return n.toString();
-    }
-    toString() {
-        return this.toStringLevel();
-    }
-    get(fieldName) {
-        return this[fieldName];
-    }
-}
-exports.GeneratedObjectField = GeneratedObjectField;
-/**
- * Checks whether a field is a custom object or not.
- * @param strDict input dictionary to check.
- */
-function isGeneratedObject(strDict) {
-    const commonKeys = [
-        "value",
-        "polygon",
-        "rectangle",
-        "page_id",
-        "confidence",
-        "quadrangle",
-        "values",
-        "raw_value",
-    ];
-    for (const key in strDict) {
-        if (Object.prototype.hasOwnProperty.call(strDict, key) && !commonKeys.includes(key)) {
-            return true;
-        }
-    }
-    return false;
-}

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

@@ -1,2 +0,0 @@
-export { GeneratedObjectField, isGeneratedObject } from "./generatedObject";
-export { GeneratedListField } from "./generatedList";

package/src/parsing/generated/index.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GeneratedListField = exports.isGeneratedObject = exports.GeneratedObjectField = void 0;
-var generatedObject_1 = require("./generatedObject");
-Object.defineProperty(exports, "GeneratedObjectField", { enumerable: true, get: function () { return generatedObject_1.GeneratedObjectField; } });
-Object.defineProperty(exports, "isGeneratedObject", { enumerable: true, get: function () { return generatedObject_1.isGeneratedObject; } });
-var generatedList_1 = require("./generatedList");
-Object.defineProperty(exports, "GeneratedListField", { enumerable: true, get: function () { return generatedList_1.GeneratedListField; } });

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

@@ -1,25 +0,0 @@
-import { StringField, FieldConstructor } from "./text";
-/**
- * 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/parsing/standard/addressField.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AddressField = void 0;
-const text_1 = require("./text");
-/**
- * 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}.
- */
-class AddressField extends text_1.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"];
-        }
-    }
-}
-exports.AddressField = AddressField;

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

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