mindee 4.36.3 → 5.0.0-alpha1

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

@@ -1,68 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InferenceFields = void 0;
-const fieldFactory_1 = require("./fieldFactory");
-class InferenceFields extends Map {
-    constructor(serverResponse, indentLevel = 0) {
-        super(Object.entries(serverResponse).map(([key, value]) => {
-            return [key, (0, fieldFactory_1.createField)(value, 1)];
-        }));
-        this._indentLevel = indentLevel;
-    }
-    getSimpleField(fieldName) {
-        const field = this.get(fieldName);
-        if (field === undefined) {
-            throw new Error(`The field '${fieldName}' was not found.`);
-        }
-        if (field.constructor.name !== "SimpleField") {
-            throw new Error(`The field '${fieldName}' is not a SimpleField.`);
-        }
-        return field;
-    }
-    getObjectField(fieldName) {
-        const field = this.get(fieldName);
-        if (field === undefined) {
-            throw new Error(`The field '${fieldName}' was not found.`);
-        }
-        if (field.constructor.name !== "ObjectField") {
-            throw new Error(`The field '${fieldName}' is not an ObjectField.`);
-        }
-        return field;
-    }
-    getListField(fieldName) {
-        const field = this.get(fieldName);
-        if (field === undefined) {
-            throw new Error(`The field '${fieldName}' was not found.`);
-        }
-        if (field.constructor.name !== "ListField") {
-            throw new Error(`The field '${fieldName}' is not a ListField.`);
-        }
-        return field;
-    }
-    toString(indent = this._indentLevel) {
-        if (this.size === 0) {
-            return "";
-        }
-        const padding = "  ".repeat(indent);
-        const lines = [];
-        for (const [fieldKey, fieldValue] of this.entries()) {
-            let line = `${padding}:${fieldKey}:`;
-            if (fieldValue.constructor.name === "ListField") {
-                const listField = fieldValue;
-                if (Array.isArray(listField.items) && listField.items.length > 0) {
-                    line += listField.toString();
-                }
-            }
-            else if (fieldValue.constructor.name === "ObjectField") {
-                line += fieldValue.toString();
-            }
-            else if (fieldValue.constructor.name === "SimpleField") {
-                const val = fieldValue.toString();
-                line += val.length > 0 ? " " + val.toString() : "";
-            }
-            lines.push(line);
-        }
-        return lines.join("\n").trimEnd();
-    }
-}
-exports.InferenceFields = InferenceFields;

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

@@ -1,20 +0,0 @@
-import { StringDict } from "../../common";
-import { BaseField } from "./baseField";
-import { ObjectField } from "./objectField";
-import { SimpleField } from "./simpleField";
-export declare class ListField extends BaseField {
-    /**
-     * Items contained in the list.
-     */
-    items: Array<ListField | ObjectField | SimpleField>;
-    /**
-     * SimpleField items from the list.
-     */
-    get simpleItems(): Array<SimpleField>;
-    /**
-     * SimpleField items from the list.
-     */
-    get objectItems(): Array<ObjectField>;
-    constructor(serverResponse: StringDict, indentLevel?: number);
-    toString(): string;
-}

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

@@ -1,67 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListField = void 0;
-const mindeeError_1 = require("../../../errors/mindeeError");
-const baseField_1 = require("./baseField");
-const objectField_1 = require("./objectField");
-const simpleField_1 = require("./simpleField");
-const fieldFactory_1 = require("./fieldFactory");
-class ListField extends baseField_1.BaseField {
-    /**
-     * SimpleField items from the list.
-     */
-    get simpleItems() {
-        const result = [];
-        for (const item of this.items) {
-            if (item instanceof simpleField_1.SimpleField) {
-                result.push(item);
-            }
-            else {
-                throw new mindeeError_1.MindeeApiV2Error(`All items must be SimpleField, found item of type ${item.constructor.name}.`);
-            }
-        }
-        return result;
-    }
-    /**
-     * SimpleField items from the list.
-     */
-    get objectItems() {
-        const result = [];
-        for (const item of this.items) {
-            if (item instanceof objectField_1.ObjectField) {
-                result.push(item);
-            }
-            else {
-                throw new mindeeError_1.MindeeApiV2Error(`All items must be ObjectField, found item of type ${item.constructor.name}.`);
-            }
-        }
-        return result;
-    }
-    constructor(serverResponse, indentLevel = 0) {
-        super(serverResponse, indentLevel);
-        if (!Array.isArray(serverResponse["items"])) {
-            throw new mindeeError_1.MindeeApiV2Error(`Expected "items" to be an array in ${JSON.stringify(serverResponse)}.`);
-        }
-        this.items = serverResponse["items"].map((item) => {
-            return (0, fieldFactory_1.createField)(item, indentLevel + 1);
-        });
-    }
-    toString() {
-        if (!this.items || this.items.length === 0) {
-            return "\n";
-        }
-        const parts = [""];
-        for (const item of this.items) {
-            if (!item)
-                continue;
-            if (item instanceof objectField_1.ObjectField) {
-                parts.push(item.toStringFromList());
-            }
-            else {
-                parts.push(item.toString());
-            }
-        }
-        return parts.join("\n  * ");
-    }
-}
-exports.ListField = ListField;

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

@@ -1,11 +0,0 @@
-import { InferenceFields } from "./inferenceFields";
-import { StringDict } from "../../common";
-import { BaseField } from "./baseField";
-import type { SimpleField } from "./simpleField";
-export declare class ObjectField extends BaseField {
-    readonly fields: InferenceFields;
-    get simpleFields(): Map<string, SimpleField>;
-    constructor(serverResponse: StringDict, indentLevel?: number);
-    toString(): string;
-    toStringFromList(): string;
-}

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

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectField = void 0;
-const inferenceFields_1 = require("./inferenceFields");
-const baseField_1 = require("./baseField");
-class ObjectField extends baseField_1.BaseField {
-    get simpleFields() {
-        const result = new Map();
-        for (const [fieldName, fieldValue] of this.fields) {
-            if (fieldValue.constructor.name === "SimpleField") {
-                result.set(fieldName, fieldValue);
-            }
-            else {
-                throw new Error(`The field '${fieldName}' is not a SimpleField.`);
-            }
-        }
-        return result;
-    }
-    constructor(serverResponse, indentLevel = 0) {
-        super(serverResponse, indentLevel);
-        this.fields = new inferenceFields_1.InferenceFields(serverResponse["fields"], this._indentLevel + 1);
-    }
-    toString() {
-        return "\n" + (this.fields ? this.fields.toString(1) : "");
-    }
-    toStringFromList() {
-        return this.fields ? this.fields.toString(2).substring(4) : "";
-    }
-}
-exports.ObjectField = ObjectField;

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

@@ -1,19 +0,0 @@
-import { StringDict } from "../../common";
-import { BaseField } from "./baseField";
-export declare class SimpleField extends BaseField {
-    readonly value: string | number | boolean | null;
-    constructor(serverResponse: StringDict, indentLevel?: number);
-    /**
-     * Retrieves a string field value as a string.
-     */
-    get stringValue(): string | null;
-    /**
-     * Retrieves a number field value as a number.
-     */
-    get numberValue(): number | null;
-    /**
-     * Retrieves a boolean field value as a boolean.
-     */
-    get booleanValue(): boolean | null;
-    toString(): string;
-}

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

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SimpleField = void 0;
-const baseField_1 = require("./baseField");
-class SimpleField extends baseField_1.BaseField {
-    constructor(serverResponse, indentLevel = 0) {
-        super(serverResponse, indentLevel);
-        this.value =
-            serverResponse["value"] !== undefined ? serverResponse["value"] : null;
-    }
-    /**
-     * Retrieves a string field value as a string.
-     */
-    get stringValue() {
-        if (this.value !== null && typeof this.value !== "string") {
-            throw new Error("Value is not a string");
-        }
-        return this.value;
-    }
-    /**
-     * Retrieves a number field value as a number.
-     */
-    get numberValue() {
-        if (this.value !== null && typeof this.value !== "number") {
-            throw new Error("Value is not a number");
-        }
-        return this.value;
-    }
-    /**
-     * Retrieves a boolean field value as a boolean.
-     */
-    get booleanValue() {
-        if (this.value !== null && typeof this.value !== "boolean") {
-            throw new Error("Value is not a boolean");
-        }
-        return this.value;
-    }
-    toString() {
-        if (this.value === null) {
-            return "";
-        }
-        if (typeof this.value === "number" && Number.isInteger(this.value)) {
-            return this.value.toString() + ".0";
-        }
-        if (typeof this.value === "boolean") {
-            return this.value ? "True" : "False";
-        }
-        return this.value.toString();
-    }
-}
-exports.SimpleField = SimpleField;

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

@@ -1,14 +0,0 @@
-export { CommonResponse } from "./commonResponse";
-export { ErrorResponse, ErrorDetails } from "./errorResponse";
-export { ErrorItem } from "./errorItem";
-export { Inference } from "./inference";
-export { InferenceActiveOptions } from "./inferenceActiveOptions";
-export { InferenceFile } from "./inferenceFile";
-export { InferenceModel } from "./inferenceModel";
-export { InferenceResponse } from "./inferenceResponse";
-export { InferenceResult } from "./inferenceResult";
-export { Job } from "./job";
-export { JobResponse } from "./jobResponse";
-export { RawText } from "./rawText";
-export { JobWebhook } from "./jobWebhook";
-export { RagMetadata } from "./ragMetadata";

package/src/parsing/v2/index.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RagMetadata = exports.JobWebhook = exports.RawText = exports.JobResponse = exports.Job = exports.InferenceResult = exports.InferenceResponse = exports.InferenceModel = exports.InferenceFile = exports.InferenceActiveOptions = exports.Inference = exports.ErrorItem = exports.ErrorResponse = exports.CommonResponse = void 0;
-var commonResponse_1 = require("./commonResponse");
-Object.defineProperty(exports, "CommonResponse", { enumerable: true, get: function () { return commonResponse_1.CommonResponse; } });
-var errorResponse_1 = require("./errorResponse");
-Object.defineProperty(exports, "ErrorResponse", { enumerable: true, get: function () { return errorResponse_1.ErrorResponse; } });
-var errorItem_1 = require("./errorItem");
-Object.defineProperty(exports, "ErrorItem", { enumerable: true, get: function () { return errorItem_1.ErrorItem; } });
-var inference_1 = require("./inference");
-Object.defineProperty(exports, "Inference", { enumerable: true, get: function () { return inference_1.Inference; } });
-var inferenceActiveOptions_1 = require("./inferenceActiveOptions");
-Object.defineProperty(exports, "InferenceActiveOptions", { enumerable: true, get: function () { return inferenceActiveOptions_1.InferenceActiveOptions; } });
-var inferenceFile_1 = require("./inferenceFile");
-Object.defineProperty(exports, "InferenceFile", { enumerable: true, get: function () { return inferenceFile_1.InferenceFile; } });
-var inferenceModel_1 = require("./inferenceModel");
-Object.defineProperty(exports, "InferenceModel", { enumerable: true, get: function () { return inferenceModel_1.InferenceModel; } });
-var inferenceResponse_1 = require("./inferenceResponse");
-Object.defineProperty(exports, "InferenceResponse", { enumerable: true, get: function () { return inferenceResponse_1.InferenceResponse; } });
-var inferenceResult_1 = require("./inferenceResult");
-Object.defineProperty(exports, "InferenceResult", { enumerable: true, get: function () { return inferenceResult_1.InferenceResult; } });
-var job_1 = require("./job");
-Object.defineProperty(exports, "Job", { enumerable: true, get: function () { return job_1.Job; } });
-var jobResponse_1 = require("./jobResponse");
-Object.defineProperty(exports, "JobResponse", { enumerable: true, get: function () { return jobResponse_1.JobResponse; } });
-var rawText_1 = require("./rawText");
-Object.defineProperty(exports, "RawText", { enumerable: true, get: function () { return rawText_1.RawText; } });
-var jobWebhook_1 = require("./jobWebhook");
-Object.defineProperty(exports, "JobWebhook", { enumerable: true, get: function () { return jobWebhook_1.JobWebhook; } });
-var ragMetadata_1 = require("./ragMetadata");
-Object.defineProperty(exports, "RagMetadata", { enumerable: true, get: function () { return ragMetadata_1.RagMetadata; } });

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

@@ -1,29 +0,0 @@
-import { StringDict } from "../common";
-import { InferenceModel } from "./inferenceModel";
-import { InferenceResult } from "./inferenceResult";
-import { InferenceFile } from "./inferenceFile";
-import { InferenceActiveOptions } from "./inferenceActiveOptions";
-export declare class Inference {
-    /**
-     * Model info for the inference.
-     */
-    model: InferenceModel;
-    /**
-     * File info for the inference.
-     */
-    file: InferenceFile;
-    /**
-     * Result of the inference.
-     */
-    result: InferenceResult;
-    /**
-     * ID of the inference.
-     */
-    id?: string;
-    /**
-     * Active options for the inference.
-     */
-    activeOptions: InferenceActiveOptions;
-    constructor(serverResponse: StringDict);
-    toString(): string;
-}

package/src/parsing/v2/inference.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Inference = void 0;
-const inferenceModel_1 = require("./inferenceModel");
-const inferenceResult_1 = require("./inferenceResult");
-const inferenceFile_1 = require("./inferenceFile");
-const inferenceActiveOptions_1 = require("./inferenceActiveOptions");
-class Inference {
-    constructor(serverResponse) {
-        this.model = new inferenceModel_1.InferenceModel(serverResponse["model"]);
-        this.file = new inferenceFile_1.InferenceFile(serverResponse["file"]);
-        this.result = new inferenceResult_1.InferenceResult(serverResponse["result"]);
-        this.activeOptions = new inferenceActiveOptions_1.InferenceActiveOptions(serverResponse["active_options"]);
-    }
-    toString() {
-        return ("Inference\n" +
-            "#########\n" +
-            this.model.toString() + "\n" +
-            this.file.toString() + "\n" +
-            this.activeOptions.toString() + "\n" +
-            this.result + "\n");
-    }
-}
-exports.Inference = Inference;

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

@@ -1,30 +0,0 @@
-import { StringDict } from "../common";
-import { DataSchemaActiveOption } from "./dataSchemaActiveOption";
-export declare class InferenceActiveOptions {
-    /**
-     * Whether the RAG feature was activated.
-     */
-    rag: boolean;
-    /**
-     * Whether the Raw Text feature was activated.
-     */
-    rawText: boolean;
-    /**
-     * Whether the polygon feature was activated.
-     */
-    polygon: boolean;
-    /**
-     * Whether the confidence feature was activated.
-     */
-    confidence: boolean;
-    /**
-     * Whether the text context feature was activated.
-     */
-    textContext: boolean;
-    /**
-     * Data schema options provided for the inference.
-     */
-    dataSchema: DataSchemaActiveOption;
-    constructor(serverResponse: StringDict);
-    toString(): string;
-}

package/src/parsing/v2/inferenceActiveOptions.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InferenceActiveOptions = void 0;
-const dataSchemaActiveOption_1 = require("./dataSchemaActiveOption");
-class InferenceActiveOptions {
-    constructor(serverResponse) {
-        this.rag = serverResponse["rag"];
-        this.rawText = serverResponse["raw_text"];
-        this.polygon = serverResponse["polygon"];
-        this.confidence = serverResponse["confidence"];
-        this.textContext = serverResponse["text_context"];
-        this.dataSchema = new dataSchemaActiveOption_1.DataSchemaActiveOption(serverResponse["data_schema"]);
-    }
-    toString() {
-        return "Active Options\n" +
-            "==============\n" +
-            `:Raw Text: ${this.rawText ? "True" : "False"}\n` +
-            `:Polygon: ${this.polygon ? "True" : "False"}\n` +
-            `:Confidence: ${this.confidence ? "True" : "False"}\n` +
-            `:RAG: ${this.rag ? "True" : "False"}\n` +
-            `:Text Context: ${this.textContext ? "True" : "False"}\n\n` +
-            `${this.dataSchema}\n`;
-    }
-}
-exports.InferenceActiveOptions = InferenceActiveOptions;

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

@@ -1,21 +0,0 @@
-import { StringDict } from "../common";
-export declare class InferenceFile {
-    /**
-     * Name of the file.
-     */
-    name: string;
-    /**
-     * Optional alias for the file.
-     */
-    alias: string;
-    /**
-     * Page count.
-     */
-    pageCount: number;
-    /**
-     * MIME type.
-     */
-    mimeType: string;
-    constructor(serverResponse: StringDict);
-    toString(): string;
-}

package/src/parsing/v2/inferenceFile.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InferenceFile = void 0;
-class InferenceFile {
-    constructor(serverResponse) {
-        this.name = serverResponse["name"];
-        this.alias = serverResponse["alias"];
-        this.pageCount = serverResponse["page_count"];
-        this.mimeType = serverResponse["mime_type"];
-    }
-    toString() {
-        return ("File\n" +
-            "====\n" +
-            `:Name: ${this.name}\n` +
-            `:Alias:${this.alias ? " " + this.alias : ""}\n`) +
-            `:Page Count: ${this.pageCount}\n` +
-            `:MIME Type: ${this.mimeType}\n`;
-    }
-}
-exports.InferenceFile = InferenceFile;

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

@@ -1,9 +0,0 @@
-import { StringDict } from "../common";
-export declare class InferenceModel {
-    /**
-     * ID of the model.
-     */
-    id: string;
-    constructor(serverResponse: StringDict);
-    toString(): string;
-}

package/src/parsing/v2/inferenceModel.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InferenceModel = void 0;
-class InferenceModel {
-    constructor(serverResponse) {
-        this.id = serverResponse["id"];
-    }
-    toString() {
-        return "Model\n" +
-            "=====\n" +
-            `:ID: ${this.id}\n`;
-    }
-}
-exports.InferenceModel = InferenceModel;

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

@@ -1,10 +0,0 @@
-import { CommonResponse } from "./commonResponse";
-import { Inference } from "./inference";
-import { StringDict } from "../common";
-export declare class InferenceResponse extends CommonResponse {
-    /**
-     * Inference result.
-     */
-    inference: Inference;
-    constructor(serverResponse: StringDict);
-}

package/src/parsing/v2/inferenceResponse.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InferenceResponse = void 0;
-const commonResponse_1 = require("./commonResponse");
-const inference_1 = require("./inference");
-class InferenceResponse extends commonResponse_1.CommonResponse {
-    constructor(serverResponse) {
-        super(serverResponse);
-        this.inference = new inference_1.Inference(serverResponse["inference"]);
-    }
-}
-exports.InferenceResponse = InferenceResponse;

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

@@ -1,20 +0,0 @@
-import { InferenceFields } from "./field";
-import { StringDict } from "../common";
-import { RawText } from "./rawText";
-import { RagMetadata } from "./ragMetadata";
-export declare class InferenceResult {
-    /**
-     * Fields contained in the inference.
-     */
-    fields: InferenceFields;
-    /**
-     * Raw text extracted from all pages.
-     */
-    rawText?: RawText;
-    /**
-     * RAG metadata.
-     */
-    rag?: RagMetadata;
-    constructor(serverResponse: StringDict);
-    toString(): string;
-}

package/src/parsing/v2/inferenceResult.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InferenceResult = void 0;
-const field_1 = require("./field");
-const rawText_1 = require("./rawText");
-const ragMetadata_1 = require("./ragMetadata");
-class InferenceResult {
-    constructor(serverResponse) {
-        this.fields = new field_1.InferenceFields(serverResponse["fields"]);
-        if (serverResponse["raw_text"]) {
-            this.rawText = new rawText_1.RawText(serverResponse["raw_text"]);
-        }
-        if (serverResponse["rag"]) {
-            this.rag = new ragMetadata_1.RagMetadata(serverResponse["rag"]);
-        }
-    }
-    toString() {
-        return `Fields\n======\n${this.fields}`;
-    }
-}
-exports.InferenceResult = InferenceResult;

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

@@ -1,49 +0,0 @@
-import { StringDict } from "../common";
-import { ErrorResponse } from "./errorResponse";
-import { JobWebhook } from "./jobWebhook";
-/**
- * Job information for a V2 polling attempt.
- */
-export declare class Job {
-    /**
-     * Job ID.
-     */
-    id: string;
-    /**
-     * Error response if any.
-     */
-    error?: ErrorResponse;
-    /**
-     * Timestamp of the job creation.
-     */
-    createdAt: Date | null;
-    /**
-     * ID of the model.
-     */
-    modelId: string;
-    /**
-     * Name for the file.
-     */
-    filename: string;
-    /**
-     * Optional alias for the file.
-     */
-    alias: string;
-    /**
-     * Status of the job.
-     */
-    status?: string;
-    /**
-     * URL to poll for the job status.
-     */
-    pollingUrl: string;
-    /**
-     * URL to poll for the job result, redirects to the result if available.
-     */
-    resultUrl?: string;
-    /**
-     * ID of webhooks associated with the job.
-     */
-    webhooks: Array<JobWebhook>;
-    constructor(serverResponse: StringDict);
-}

package/src/parsing/v2/job.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Job = void 0;
-const errorResponse_1 = require("./errorResponse");
-const common_1 = require("../common");
-/**
- * Job information for a V2 polling attempt.
- */
-class Job {
-    constructor(serverResponse) {
-        this.id = serverResponse["id"];
-        if (serverResponse["status"] !== undefined) {
-            this.status = serverResponse["status"];
-        }
-        if (serverResponse["error"] !== undefined &&
-            serverResponse["error"] !== null &&
-            Object.keys(serverResponse["error"]).length > 0) {
-            this.error = new errorResponse_1.ErrorResponse(serverResponse["error"]);
-        }
-        this.createdAt = (0, common_1.parseDate)(serverResponse["created_at"]);
-        this.modelId = serverResponse["model_id"];
-        this.pollingUrl = serverResponse["polling_url"];
-        this.filename = serverResponse["filename"];
-        this.resultUrl = serverResponse["result_url"];
-        this.alias = serverResponse["alias"];
-        this.webhooks = serverResponse["webhooks"];
-    }
-}
-exports.Job = Job;

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

@@ -1,10 +0,0 @@
-import { CommonResponse } from "./commonResponse";
-import { StringDict } from "../common";
-import { Job } from "./job";
-export declare class JobResponse extends CommonResponse {
-    /**
-     * Job for the polling.
-     */
-    job: Job;
-    constructor(serverResponse: StringDict);
-}