mindee 4.36.3 → 5.0.0-alpha2

package/src/parsing/standard/position.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PositionField = void 0;
-/**
- * A field indicating a position or area on the document.
- */
-class PositionField {
-    constructor({ prediction = {}, pageId }) {
-        this.pageId = pageId;
-        this.boundingBox = "bounding_box" in prediction ? prediction["bounding_box"] : [];
-        this.polygon = "polygon" in prediction ? prediction["polygon"] : [];
-        this.quadrangle = "quadrangle" in prediction ? prediction["quadrangle"] : [];
-        this.rectangle = "rectangle" in prediction ? prediction["rectangle"] : [];
-    }
-    /**
-     * Default string representation.
-     */
-    toString() {
-        if (this.polygon && this.polygon.length > 0)
-            return `Polygon with ${this.polygon.length} points.`;
-        if (this.boundingBox && this.boundingBox.length > 0) {
-            return `Polygon with ${this.boundingBox.length} points.`;
-        }
-        if (this.rectangle && this.rectangle.length > 0) {
-            return `Polygon with ${this.rectangle.length} points.`;
-        }
-        if (this.quadrangle && this.quadrangle.length > 0) {
-            return `Polygon with ${this.quadrangle.length} points.`;
-        }
-        return "";
-    }
-}
-exports.PositionField = PositionField;

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

@@ -1,53 +0,0 @@
-import { StringDict } from "../common";
-import { Field } from "./field";
-import { BaseFieldConstructor } from "./base";
-/**
- * @property {string} constructor.rateKey - Key to use to get the tax rate in the prediction dict.
- * @property {string} constructor.codeKey - Key to use to get the tax code in the prediction dict.
- * @property {string} constructor.baseKey - Key to use to get the base tax in the prediction dict.
- */
-interface TaxConstructor extends BaseFieldConstructor {
-    rateKey?: string;
-    codeKey?: string;
-    baseKey?: string;
-}
-/**
- * Represent a single tax line.
- */
-export declare class TaxField extends Field {
-    #private;
-    /** The tax amount. */
-    value?: number;
-    /** The tax rate. */
-    rate?: number;
-    /**  The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..). */
-    code?: string;
-    /**  The tax base */
-    base?: number;
-    /** The document page on which the information was found. */
-    pageId: number;
-    /**
-     * @param {TaxConstructor} constructor Constructor parameters.
-     */
-    constructor({ prediction, valueKey, rateKey, codeKey, baseKey, reconstructed, pageId, }: TaxConstructor);
-    /**
-     * Output in a format suitable for inclusion in an rST table.
-     */
-    toTableLine(): string;
-    /**
-     * Default string representation.
-     */
-    toString(): string;
-}
-/**
- * Represent all items.
- */
-export declare class Taxes extends Array<TaxField> {
-    #private;
-    init(prediction: StringDict[] | undefined, pageId: number | undefined): this;
-    /**
-     * Default string representation.
-     */
-    toString(): string;
-}
-export {};

package/src/parsing/standard/tax.js

@@ -1,124 +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 _TaxField_instances, _TaxField_printableValues, _Taxes_instances, _Taxes_lineSeparator;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Taxes = exports.TaxField = void 0;
-const common_1 = require("../common");
-const field_1 = require("./field");
-/**
- * Represent a single tax line.
- */
-class TaxField extends field_1.Field {
-    /**
-     * @param {TaxConstructor} constructor Constructor parameters.
-     */
-    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. */
-        this.value = undefined;
-        /** The tax rate. */
-        this.rate = undefined;
-        /**  The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..). */
-        this.code = undefined;
-        /**  The tax base */
-        this.base = undefined;
-        this.rate = +parseFloat(prediction[rateKey]);
-        if (isNaN(this.rate))
-            this.rate = undefined;
-        this.code = prediction[codeKey]?.toString();
-        if (this.code === "N/A" || this.code === "None") {
-            this.code = undefined;
-        }
-        this.value = parseFloat(prediction[valueKey]);
-        if (isNaN(this.value)) {
-            this.value = undefined;
-            this.confidence = 0.0;
-        }
-        this.base = parseFloat(prediction[baseKey]);
-        if (isNaN(this.base))
-            this.base = undefined;
-    }
-    /**
-     * Output in a format suitable for inclusion in an rST table.
-     */
-    toTableLine() {
-        const printable = __classPrivateFieldGet(this, _TaxField_instances, "m", _TaxField_printableValues).call(this);
-        return ("| " +
-            printable.base.padEnd(13) +
-            " | " +
-            printable.code.padEnd(6) +
-            " | " +
-            printable.rate.padEnd(8) +
-            " | " +
-            printable.value.padEnd(13) +
-            " |");
-    }
-    /**
-     * Default string representation.
-     */
-    toString() {
-        const printable = __classPrivateFieldGet(this, _TaxField_instances, "m", _TaxField_printableValues).call(this);
-        return ("Base: " +
-            printable.base +
-            ", Code: " +
-            printable.code +
-            ", Rate (%): " +
-            printable.rate +
-            ", Amount: " +
-            printable.value).trim();
-    }
-}
-exports.TaxField = TaxField;
-_TaxField_instances = new WeakSet(), _TaxField_printableValues = function _TaxField_printableValues() {
-    return {
-        code: this.code ?? "",
-        base: this.base !== undefined ? (0, common_1.floatToString)(this.base) : "",
-        rate: this.rate !== undefined ? (0, common_1.floatToString)(this.rate) : "",
-        value: this.value !== undefined ? (0, common_1.floatToString)(this.value) : "",
-    };
-};
-/**
- * Represent all items.
- */
-class Taxes extends Array {
-    constructor() {
-        super(...arguments);
-        _Taxes_instances.add(this);
-    }
-    init(prediction = [], pageId) {
-        for (const entry of prediction) {
-            this.push(new TaxField({
-                prediction: entry,
-                pageId: pageId,
-            }));
-        }
-        return this;
-    }
-    /**
-     * Default string representation.
-     */
-    toString() {
-        let outStr = `
-${__classPrivateFieldGet(this, _Taxes_instances, "m", _Taxes_lineSeparator).call(this, "-")}
-  | Base          | Code   | Rate (%) | Amount        |
-${__classPrivateFieldGet(this, _Taxes_instances, "m", _Taxes_lineSeparator).call(this, "=")}`;
-        for (const entry of this.entries()) {
-            outStr += `\n  ${entry[1].toTableLine()}\n${__classPrivateFieldGet(this, _Taxes_instances, "m", _Taxes_lineSeparator).call(this, "-")}`;
-        }
-        return outStr;
-    }
-}
-exports.Taxes = Taxes;
-_Taxes_instances = new WeakSet(), _Taxes_lineSeparator = function _Taxes_lineSeparator(char) {
-    let outStr = "  ";
-    outStr += `+${char.repeat(15)}`;
-    outStr += `+${char.repeat(8)}`;
-    outStr += `+${char.repeat(10)}`;
-    outStr += `+${char.repeat(15)}`;
-    return outStr + "+";
-};

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

@@ -1,18 +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 StringField extends Field {
-    /** The value. */
-    value?: string;
-    /** Value as it appears on the document. */
-    rawValue?: string;
-    constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
-}

package/src/parsing/standard/text.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StringField = void 0;
-const field_1 = require("./field");
-/**
- * A field containing a text value.
- */
-class StringField extends field_1.Field {
-    constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId, }) {
-        super({ prediction, valueKey, reconstructed, pageId });
-        if (prediction["raw_value"]) {
-            this.rawValue = prediction["raw_value"];
-        }
-    }
-}
-exports.StringField = StringField;

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

@@ -1,10 +0,0 @@
-import * as geometry from "../../geometry";
-export type Word = {
-    /**
-     * Contains the relative vertices coordinates (points) of a polygon containing
-     * the field in the document.
-     */
-    polygon: geometry.Polygon;
-    text: string;
-    confidence: number;
-};

package/src/parsing/standard/word.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/src/parsing/v2/commonResponse.d.ts

@@ -1,16 +0,0 @@
-import { StringDict } from "../common";
-export declare abstract class CommonResponse {
-    /**
-     * Raw text representation of the API's response.
-     */
-    private readonly rawHttp;
-    /**
-     * @param serverResponse JSON response from the server.
-     */
-    protected constructor(serverResponse: StringDict);
-    /**
-     * Raw HTTP request sent from server, as a JSON-like structure
-     * @returns The HTTP request
-     */
-    getRawHttp(): StringDict;
-}

package/src/parsing/v2/commonResponse.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommonResponse = void 0;
-class CommonResponse {
-    /**
-     * @param serverResponse JSON response from the server.
-     */
-    constructor(serverResponse) {
-        this.rawHttp = serverResponse;
-    }
-    /**
-     * Raw HTTP request sent from server, as a JSON-like structure
-     * @returns The HTTP request
-     */
-    getRawHttp() {
-        return this.rawHttp;
-    }
-}
-exports.CommonResponse = CommonResponse;

package/src/parsing/v2/dataSchemaActiveOption.d.ts

@@ -1,12 +0,0 @@
-import { StringDict } from "../common";
-/**
- * Data schema options activated during the inference.
- */
-export declare class DataSchemaActiveOption {
-    /**
-     * Whether to replace the data schema.
-     */
-    replace: boolean;
-    constructor(serverResponse: StringDict);
-    toString(): string;
-}

package/src/parsing/v2/dataSchemaActiveOption.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataSchemaActiveOption = void 0;
-/**
- * Data schema options activated during the inference.
- */
-class DataSchemaActiveOption {
-    constructor(serverResponse) {
-        this.replace = serverResponse["replace"];
-    }
-    toString() {
-        return `Data Schema\n-----------\n:Replace: ${this.replace ? "True" : "False"}`;
-    }
-}
-exports.DataSchemaActiveOption = DataSchemaActiveOption;

package/src/parsing/v2/errorItem.d.ts

@@ -1,18 +0,0 @@
-import { StringDict } from "../common";
-/**
- * Explicit details on a problem.
- */
-export declare class ErrorItem {
-    /**
-     * A JSON Pointer to the location of the body property.
-     */
-    pointer?: string;
-    /**
-     * Explicit information on the issue.
-     */
-    detail: string;
-    /**
-     * @param serverResponse JSON response from the server.
-     */
-    constructor(serverResponse: StringDict);
-}

package/src/parsing/v2/errorItem.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorItem = void 0;
-/**
- * Explicit details on a problem.
- */
-class ErrorItem {
-    /**
-     * @param serverResponse JSON response from the server.
-     */
-    constructor(serverResponse) {
-        if (serverResponse["pointer"] !== undefined) {
-            this.pointer = serverResponse["pointer"];
-        }
-        this.detail = serverResponse["detail"];
-    }
-}
-exports.ErrorItem = ErrorItem;

package/src/parsing/v2/errorResponse.d.ts

@@ -1,38 +0,0 @@
-import { StringDict } from "../common";
-import { ErrorItem } from "./errorItem";
-export interface ErrorDetails {
-    /**
-     * The HTTP status code returned by the server.
-     */
-    status: number;
-    /**
-     * A human-readable explanation specific to the occurrence of the problem.
-     */
-    detail: string;
-    /**
-     * A short, human-readable summary of the problem.
-     */
-    title: string;
-    /**
-     * A machine-readable code specific to the occurrence of the problem.
-     */
-    code: string;
-    /**
-     * A list of explicit error details.
-     */
-    errors: ErrorItem[];
-}
-/**
- * Error response detailing a problem. The format adheres to RFC 9457.
- */
-export declare class ErrorResponse implements ErrorDetails {
-    status: number;
-    detail: string;
-    title: string;
-    code: string;
-    errors: ErrorItem[];
-    /**
-     * @param serverResponse JSON response from the server.
-     */
-    constructor(serverResponse: StringDict);
-}

package/src/parsing/v2/errorResponse.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorResponse = void 0;
-const errorItem_1 = require("./errorItem");
-/**
- * Error response detailing a problem. The format adheres to RFC 9457.
- */
-class ErrorResponse {
-    /**
-     * @param serverResponse JSON response from the server.
-     */
-    constructor(serverResponse) {
-        this.status = serverResponse["status"];
-        this.detail = serverResponse["detail"];
-        this.title = serverResponse["title"];
-        this.code = serverResponse["code"];
-        if (serverResponse["errors"] !== undefined) {
-            this.errors = serverResponse["errors"].map((error) => new errorItem_1.ErrorItem(error));
-        }
-        else {
-            this.errors = [];
-        }
-    }
-}
-exports.ErrorResponse = ErrorResponse;

package/src/parsing/v2/field/baseField.d.ts

@@ -1,9 +0,0 @@
-import { FieldConfidence } from "./fieldConfidence";
-import { StringDict } from "../../common";
-import { FieldLocation } from "./fieldLocation";
-export declare abstract class BaseField {
-    protected _indentLevel: number;
-    confidence: FieldConfidence | undefined;
-    locations: Array<FieldLocation> | undefined;
-    protected constructor(rawResponse: StringDict, indentLevel?: number);
-}

package/src/parsing/v2/field/baseField.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseField = void 0;
-const fieldLocation_1 = require("./fieldLocation");
-class BaseField {
-    constructor(rawResponse, indentLevel = 0) {
-        this._indentLevel = indentLevel;
-        if ("confidence" in rawResponse && rawResponse["confidence"] !== null) {
-            this.confidence = rawResponse["confidence"];
-        }
-        if ("locations" in rawResponse && rawResponse["locations"]) {
-            this.locations = rawResponse["locations"].map((location) => {
-                return location ? new fieldLocation_1.FieldLocation(location) : "";
-            });
-        }
-    }
-}
-exports.BaseField = BaseField;

package/src/parsing/v2/field/fieldConfidence.js

@@ -1,77 +0,0 @@
-"use strict";
-/* eslint-disable @typescript-eslint/naming-convention */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FieldConfidence = void 0;
-/**
- * Confidence level of a field as returned by the V2 API.
- */
-var FieldConfidence;
-(function (FieldConfidence) {
-    FieldConfidence["Certain"] = "Certain";
-    FieldConfidence["High"] = "High";
-    FieldConfidence["Medium"] = "Medium";
-    FieldConfidence["Low"] = "Low";
-})(FieldConfidence || (exports.FieldConfidence = FieldConfidence = {}));
-// eslint-disable-next-line @typescript-eslint/no-namespace
-(function (FieldConfidence) {
-    /**
-     * Converts a FieldConfidence value to an integer.
-     * @param confidence The FieldConfidence value to convert
-     * @returns Integer representation (Certain=4, High=3, Medium=2, Low=1)
-     */
-    function toInt(confidence) {
-        switch (confidence) {
-            case FieldConfidence.Certain:
-                return 4;
-            case FieldConfidence.High:
-                return 3;
-            case FieldConfidence.Medium:
-                return 2;
-            case FieldConfidence.Low:
-                return 1;
-            default:
-                throw new Error(`Unknown FieldConfidence value: ${confidence}`);
-        }
-    }
-    FieldConfidence.toInt = toInt;
-    /**
-     * Checks if the first FieldConfidence is greater than the second.
-     * @param a First FieldConfidence value
-     * @param b Second FieldConfidence value
-     * @returns true if a > b
-     */
-    function greaterThan(a, b) {
-        return toInt(a) > toInt(b);
-    }
-    FieldConfidence.greaterThan = greaterThan;
-    /**
-     * Checks if the first FieldConfidence is greater than or equal to the second.
-     * @param a First FieldConfidence value
-     * @param b Second FieldConfidence value
-     * @returns true if a >= b
-     */
-    function greaterThanOrEqual(a, b) {
-        return toInt(a) >= toInt(b);
-    }
-    FieldConfidence.greaterThanOrEqual = greaterThanOrEqual;
-    /**
-     * Checks if the first FieldConfidence is less than the second.
-     * @param a First FieldConfidence value
-     * @param b Second FieldConfidence value
-     * @returns true if a < b
-     */
-    function lessThan(a, b) {
-        return toInt(a) < toInt(b);
-    }
-    FieldConfidence.lessThan = lessThan;
-    /**
-     * Checks if the first FieldConfidence is less than or equal to the second.
-     * @param a First FieldConfidence value
-     * @param b Second FieldConfidence value
-     * @returns true if a <= b
-     */
-    function lessThanOrEqual(a, b) {
-        return toInt(a) <= toInt(b);
-    }
-    FieldConfidence.lessThanOrEqual = lessThanOrEqual;
-})(FieldConfidence || (exports.FieldConfidence = FieldConfidence = {}));

package/src/parsing/v2/field/fieldFactory.d.ts

@@ -1,8 +0,0 @@
-/**
- * Factory helper.
- */
-import { StringDict } from "../../common";
-import { ListField } from "./listField";
-import { ObjectField } from "./objectField";
-import { SimpleField } from "./simpleField";
-export declare function createField(serverResponse: StringDict, indentLevel?: number): SimpleField | ObjectField | ListField;

package/src/parsing/v2/field/fieldFactory.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createField = createField;
-const mindeeError_1 = require("../../../errors/mindeeError");
-const listField_1 = require("./listField");
-const objectField_1 = require("./objectField");
-const simpleField_1 = require("./simpleField");
-function createField(serverResponse, indentLevel = 0) {
-    if (typeof serverResponse !== "object" || serverResponse === null) {
-        throw new mindeeError_1.MindeeApiV2Error(`Unrecognized field format ${JSON.stringify(serverResponse)}.`);
-    }
-    if ("items" in serverResponse) {
-        return new listField_1.ListField(serverResponse, indentLevel);
-    }
-    if ("fields" in serverResponse) {
-        return new objectField_1.ObjectField(serverResponse, indentLevel);
-    }
-    if ("value" in serverResponse) {
-        return new simpleField_1.SimpleField(serverResponse, indentLevel);
-    }
-    throw new mindeeError_1.MindeeApiV2Error(`Unrecognized field format in ${JSON.stringify(serverResponse)}.`);
-}

package/src/parsing/v2/field/fieldLocation.d.ts

@@ -1,13 +0,0 @@
-import { Polygon } from "../../../geometry";
-import { StringDict } from "../../common";
-/**
- * Location of a field.
- */
-export declare class FieldLocation {
-    /** Free polygon made up of points (can be null when not provided). */
-    readonly polygon: Polygon | null;
-    /** Page ID. */
-    readonly page: number | undefined;
-    constructor(serverResponse: StringDict);
-    toString(): string;
-}

package/src/parsing/v2/field/fieldLocation.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FieldLocation = void 0;
-/**
- * Location of a field.
- */
-class FieldLocation {
-    constructor(serverResponse) {
-        this.polygon = serverResponse["polygon"];
-        this.page = "page" in serverResponse ? serverResponse["page"] : undefined;
-    }
-    toString() {
-        return this.polygon?.toString() ?? "";
-    }
-}
-exports.FieldLocation = FieldLocation;

package/src/parsing/v2/field/index.d.ts

@@ -1,6 +0,0 @@
-export { InferenceFields } from "./inferenceFields";
-export { FieldConfidence } from "./fieldConfidence";
-export { FieldLocation } from "./fieldLocation";
-export { ListField } from "./listField";
-export { ObjectField } from "./objectField";
-export { SimpleField } from "./simpleField";

package/src/parsing/v2/field/index.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SimpleField = exports.ObjectField = exports.ListField = exports.FieldLocation = exports.FieldConfidence = exports.InferenceFields = void 0;
-var inferenceFields_1 = require("./inferenceFields");
-Object.defineProperty(exports, "InferenceFields", { enumerable: true, get: function () { return inferenceFields_1.InferenceFields; } });
-var fieldConfidence_1 = require("./fieldConfidence");
-Object.defineProperty(exports, "FieldConfidence", { enumerable: true, get: function () { return fieldConfidence_1.FieldConfidence; } });
-var fieldLocation_1 = require("./fieldLocation");
-Object.defineProperty(exports, "FieldLocation", { enumerable: true, get: function () { return fieldLocation_1.FieldLocation; } });
-var listField_1 = require("./listField");
-Object.defineProperty(exports, "ListField", { enumerable: true, get: function () { return listField_1.ListField; } });
-var objectField_1 = require("./objectField");
-Object.defineProperty(exports, "ObjectField", { enumerable: true, get: function () { return objectField_1.ObjectField; } });
-var simpleField_1 = require("./simpleField");
-Object.defineProperty(exports, "SimpleField", { enumerable: true, get: function () { return simpleField_1.SimpleField; } });

package/src/parsing/v2/field/inferenceFields.d.ts

@@ -1,12 +0,0 @@
-import { StringDict } from "../../common";
-import type { ListField } from "./listField";
-import type { ObjectField } from "./objectField";
-import type { SimpleField } from "./simpleField";
-export declare class InferenceFields extends Map<string, SimpleField | ObjectField | ListField> {
-    protected _indentLevel: number;
-    constructor(serverResponse: StringDict, indentLevel?: number);
-    getSimpleField(fieldName: string): SimpleField;
-    getObjectField(fieldName: string): ObjectField;
-    getListField(fieldName: string): ListField;
-    toString(indent?: number): string;
-}