mindee 5.5.0 → 5.6.1

package/src/v1/product/invoice/invoiceV4LineItem.js

@@ -4,12 +4,13 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _InvoiceV4LineItem_instances, _InvoiceV4LineItem_printableValues;
-import { cleanSpecialChars, floatToString } from "../../../v1/parsing/common/index.js";
+import { cleanAndTruncate, floatToString } from "../../../v1/parsing/common/index.js";
 import { Polygon } from "../../../geometry/index.js";
 /**
  * List of all the line items present on the invoice.
  */
 export class InvoiceV4LineItem {
+    // eslint-disable-next-line sonarjs/cognitive-complexity
     constructor({ prediction = {} }) {
         _InvoiceV4LineItem_instances.add(this);
         /** Confidence score */
@@ -116,25 +117,13 @@ export class InvoiceV4LineItem {
 }
 _InvoiceV4LineItem_instances = new WeakSet(), _InvoiceV4LineItem_printableValues = function _InvoiceV4LineItem_printableValues() {
     return {
-        description: this.description ?
-            this.description.length <= 36 ?
-                cleanSpecialChars(this.description) :
-                cleanSpecialChars(this.description).slice(0, 33) + "..." :
-            "",
-        productCode: this.productCode ?
-            this.productCode.length <= 12 ?
-                cleanSpecialChars(this.productCode) :
-                cleanSpecialChars(this.productCode).slice(0, 9) + "..." :
-            "",
+        description: cleanAndTruncate(this.description, 36),
+        productCode: cleanAndTruncate(this.productCode, 12),
         quantity: this.quantity !== undefined ? floatToString(this.quantity) : "",
         taxAmount: this.taxAmount !== undefined ? floatToString(this.taxAmount) : "",
         taxRate: this.taxRate !== undefined ? floatToString(this.taxRate) : "",
         totalAmount: this.totalAmount !== undefined ? floatToString(this.totalAmount) : "",
-        unitMeasure: this.unitMeasure ?
-            this.unitMeasure.length <= 15 ?
-                cleanSpecialChars(this.unitMeasure) :
-                cleanSpecialChars(this.unitMeasure).slice(0, 12) + "..." :
-            "",
+        unitMeasure: cleanAndTruncate(this.unitMeasure, 15),
         unitPrice: this.unitPrice !== undefined ? floatToString(this.unitPrice) : "",
     };
 };

package/src/v1/product/receipt/receiptV5LineItem.js

@@ -4,7 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ReceiptV5LineItem_instances, _ReceiptV5LineItem_printableValues;
-import { cleanSpecialChars, floatToString } from "../../../v1/parsing/common/index.js";
+import { cleanAndTruncate, floatToString } from "../../../v1/parsing/common/index.js";
 import { Polygon } from "../../../geometry/index.js";
 /**
  * List of all line items on the receipt.
@@ -82,11 +82,7 @@ export class ReceiptV5LineItem {
 }
 _ReceiptV5LineItem_instances = new WeakSet(), _ReceiptV5LineItem_printableValues = function _ReceiptV5LineItem_printableValues() {
     return {
-        description: this.description ?
-            this.description.length <= 36 ?
-                cleanSpecialChars(this.description) :
-                cleanSpecialChars(this.description).slice(0, 33) + "..." :
-            "",
+        description: cleanAndTruncate(this.description, 36),
         quantity: this.quantity !== undefined ? floatToString(this.quantity) : "",
         totalAmount: this.totalAmount !== undefined ? floatToString(this.totalAmount) : "",
         unitPrice: this.unitPrice !== undefined ? floatToString(this.unitPrice) : "",

package/src/v1/product/resume/resumeV1Certificate.js

@@ -4,7 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ResumeV1Certificate_instances, _ResumeV1Certificate_printableValues;
-import { cleanSpecialChars } from "../../../v1/parsing/common/index.js";
+import { cleanAndTruncate } from "../../../v1/parsing/common/index.js";
 import { Polygon } from "../../../geometry/index.js";
 /**
  * The list of certificates obtained by the candidate.
@@ -61,25 +61,9 @@ export class ResumeV1Certificate {
 }
 _ResumeV1Certificate_instances = new WeakSet(), _ResumeV1Certificate_printableValues = function _ResumeV1Certificate_printableValues() {
     return {
-        grade: this.grade ?
-            this.grade.length <= 10 ?
-                cleanSpecialChars(this.grade) :
-                cleanSpecialChars(this.grade).slice(0, 7) + "..." :
-            "",
-        name: this.name ?
-            this.name.length <= 30 ?
-                cleanSpecialChars(this.name) :
-                cleanSpecialChars(this.name).slice(0, 27) + "..." :
-            "",
-        provider: this.provider ?
-            this.provider.length <= 25 ?
-                cleanSpecialChars(this.provider) :
-                cleanSpecialChars(this.provider).slice(0, 22) + "..." :
-            "",
-        year: this.year ?
-            this.year.length <= 4 ?
-                cleanSpecialChars(this.year) :
-                cleanSpecialChars(this.year).slice(0, 1) + "..." :
-            "",
+        grade: cleanAndTruncate(this.grade, 10),
+        name: cleanAndTruncate(this.name, 30),
+        provider: cleanAndTruncate(this.provider, 25),
+        year: cleanAndTruncate(this.year, 4),
     };
 };

package/src/v1/product/resume/resumeV1Education.js

@@ -4,7 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ResumeV1Education_instances, _ResumeV1Education_printableValues;
-import { cleanSpecialChars } from "../../../v1/parsing/common/index.js";
+import { cleanAndTruncate } from "../../../v1/parsing/common/index.js";
 import { Polygon } from "../../../geometry/index.js";
 /**
  * The list of the candidate's educational background.
@@ -76,40 +76,12 @@ export class ResumeV1Education {
 }
 _ResumeV1Education_instances = new WeakSet(), _ResumeV1Education_printableValues = function _ResumeV1Education_printableValues() {
     return {
-        degreeDomain: this.degreeDomain ?
-            this.degreeDomain.length <= 15 ?
-                cleanSpecialChars(this.degreeDomain) :
-                cleanSpecialChars(this.degreeDomain).slice(0, 12) + "..." :
-            "",
-        degreeType: this.degreeType ?
-            this.degreeType.length <= 25 ?
-                cleanSpecialChars(this.degreeType) :
-                cleanSpecialChars(this.degreeType).slice(0, 22) + "..." :
-            "",
-        endMonth: this.endMonth ?
-            this.endMonth.length <= 9 ?
-                cleanSpecialChars(this.endMonth) :
-                cleanSpecialChars(this.endMonth).slice(0, 6) + "..." :
-            "",
-        endYear: this.endYear ?
-            this.endYear.length <= 8 ?
-                cleanSpecialChars(this.endYear) :
-                cleanSpecialChars(this.endYear).slice(0, 5) + "..." :
-            "",
-        school: this.school ?
-            this.school.length <= 25 ?
-                cleanSpecialChars(this.school) :
-                cleanSpecialChars(this.school).slice(0, 22) + "..." :
-            "",
-        startMonth: this.startMonth ?
-            this.startMonth.length <= 11 ?
-                cleanSpecialChars(this.startMonth) :
-                cleanSpecialChars(this.startMonth).slice(0, 8) + "..." :
-            "",
-        startYear: this.startYear ?
-            this.startYear.length <= 10 ?
-                cleanSpecialChars(this.startYear) :
-                cleanSpecialChars(this.startYear).slice(0, 7) + "..." :
-            "",
+        degreeDomain: cleanAndTruncate(this.degreeDomain, 15),
+        degreeType: cleanAndTruncate(this.degreeType, 25),
+        endMonth: cleanAndTruncate(this.endMonth, 9),
+        endYear: cleanAndTruncate(this.endYear, 8),
+        school: cleanAndTruncate(this.school, 25),
+        startMonth: cleanAndTruncate(this.startMonth, 11),
+        startYear: cleanAndTruncate(this.startYear, 10),
     };
 };

package/src/v1/product/resume/resumeV1Language.js

@@ -4,7 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ResumeV1Language_instances, _ResumeV1Language_printableValues;
-import { cleanSpecialChars } from "../../../v1/parsing/common/index.js";
+import { cleanAndTruncate } from "../../../v1/parsing/common/index.js";
 import { Polygon } from "../../../geometry/index.js";
 /**
  * The list of languages that the candidate is proficient in.
@@ -51,15 +51,7 @@ export class ResumeV1Language {
 }
 _ResumeV1Language_instances = new WeakSet(), _ResumeV1Language_printableValues = function _ResumeV1Language_printableValues() {
     return {
-        language: this.language ?
-            this.language.length <= 8 ?
-                cleanSpecialChars(this.language) :
-                cleanSpecialChars(this.language).slice(0, 5) + "..." :
-            "",
-        level: this.level ?
-            this.level.length <= 20 ?
-                cleanSpecialChars(this.level) :
-                cleanSpecialChars(this.level).slice(0, 17) + "..." :
-            "",
+        language: cleanAndTruncate(this.language, 8),
+        level: cleanAndTruncate(this.level, 20),
     };
 };

package/src/v1/product/resume/resumeV1ProfessionalExperience.js

@@ -4,7 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ResumeV1ProfessionalExperience_instances, _ResumeV1ProfessionalExperience_printableValues;
-import { cleanSpecialChars } from "../../../v1/parsing/common/index.js";
+import { cleanAndTruncate } from "../../../v1/parsing/common/index.js";
 import { Polygon } from "../../../geometry/index.js";
 /**
  * The list of the candidate's professional experiences.
@@ -86,50 +86,14 @@ export class ResumeV1ProfessionalExperience {
 }
 _ResumeV1ProfessionalExperience_instances = new WeakSet(), _ResumeV1ProfessionalExperience_printableValues = function _ResumeV1ProfessionalExperience_printableValues() {
     return {
-        contractType: this.contractType ?
-            this.contractType.length <= 15 ?
-                cleanSpecialChars(this.contractType) :
-                cleanSpecialChars(this.contractType).slice(0, 12) + "..." :
-            "",
-        department: this.department ?
-            this.department.length <= 10 ?
-                cleanSpecialChars(this.department) :
-                cleanSpecialChars(this.department).slice(0, 7) + "..." :
-            "",
-        description: this.description ?
-            this.description.length <= 36 ?
-                cleanSpecialChars(this.description) :
-                cleanSpecialChars(this.description).slice(0, 33) + "..." :
-            "",
-        employer: this.employer ?
-            this.employer.length <= 25 ?
-                cleanSpecialChars(this.employer) :
-                cleanSpecialChars(this.employer).slice(0, 22) + "..." :
-            "",
-        endMonth: this.endMonth ?
-            this.endMonth.length <= 9 ?
-                cleanSpecialChars(this.endMonth) :
-                cleanSpecialChars(this.endMonth).slice(0, 6) + "..." :
-            "",
-        endYear: this.endYear ?
-            this.endYear.length <= 8 ?
-                cleanSpecialChars(this.endYear) :
-                cleanSpecialChars(this.endYear).slice(0, 5) + "..." :
-            "",
-        role: this.role ?
-            this.role.length <= 20 ?
-                cleanSpecialChars(this.role) :
-                cleanSpecialChars(this.role).slice(0, 17) + "..." :
-            "",
-        startMonth: this.startMonth ?
-            this.startMonth.length <= 11 ?
-                cleanSpecialChars(this.startMonth) :
-                cleanSpecialChars(this.startMonth).slice(0, 8) + "..." :
-            "",
-        startYear: this.startYear ?
-            this.startYear.length <= 10 ?
-                cleanSpecialChars(this.startYear) :
-                cleanSpecialChars(this.startYear).slice(0, 7) + "..." :
-            "",
+        contractType: cleanAndTruncate(this.contractType, 15),
+        department: cleanAndTruncate(this.department, 10),
+        description: cleanAndTruncate(this.description, 36),
+        employer: cleanAndTruncate(this.employer, 25),
+        endMonth: cleanAndTruncate(this.endMonth, 9),
+        endYear: cleanAndTruncate(this.endYear, 8),
+        role: cleanAndTruncate(this.role, 20),
+        startMonth: cleanAndTruncate(this.startMonth, 11),
+        startYear: cleanAndTruncate(this.startYear, 10),
     };
 };

package/src/v1/product/resume/resumeV1SocialNetworksUrl.js

@@ -4,7 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ResumeV1SocialNetworksUrl_instances, _ResumeV1SocialNetworksUrl_printableValues;
-import { cleanSpecialChars } from "../../../v1/parsing/common/index.js";
+import { cleanAndTruncate } from "../../../v1/parsing/common/index.js";
 import { Polygon } from "../../../geometry/index.js";
 /**
  * The list of social network profiles of the candidate.
@@ -51,15 +51,7 @@ export class ResumeV1SocialNetworksUrl {
 }
 _ResumeV1SocialNetworksUrl_instances = new WeakSet(), _ResumeV1SocialNetworksUrl_printableValues = function _ResumeV1SocialNetworksUrl_printableValues() {
     return {
-        name: this.name ?
-            this.name.length <= 20 ?
-                cleanSpecialChars(this.name) :
-                cleanSpecialChars(this.name).slice(0, 17) + "..." :
-            "",
-        url: this.url ?
-            this.url.length <= 50 ?
-                cleanSpecialChars(this.url) :
-                cleanSpecialChars(this.url).slice(0, 47) + "..." :
-            "",
+        name: cleanAndTruncate(this.name, 20),
+        url: cleanAndTruncate(this.url, 50),
     };
 };

package/src/v2/cli.d.ts

@@ -1 +1,4 @@
+/**
+ * Build the CLI.
+ */
 export declare function cli(): void;

package/src/v2/cli.js

@@ -6,12 +6,22 @@ const program = new Command();
 //
 // EXECUTE THE COMMANDS
 //
+/**
+ * Initialize the client.
+ * @param options Options.
+ */
 function initClient(options) {
     return new Client({
         apiKey: options.apiKey,
         debug: options.debug,
     });
 }
+/**
+ * Enqueue and get inference.
+ * @param product Product.
+ * @param inputPath Input path.
+ * @param options Options.
+ */
 async function enqueueAndGetInference(product, inputPath, options) {
     const mindeeClient = initClient(options);
     let inputSource;
@@ -31,6 +41,10 @@ async function enqueueAndGetInference(product, inputPath, options) {
     }
     printResponse(response.inference);
 }
+/**
+ * Print response.
+ * @param document Document.
+ */
 function printResponse(document) {
     if (document) {
         console.log(`\n${document}`);
@@ -39,10 +53,17 @@ function printResponse(document) {
 //
 // BUILD THE COMMANDS
 //
+/**
+ * Add main options.
+ * @param prog Program.
+ */
 function addMainOptions(prog) {
     prog.requiredOption("-m, --model <model_id>", "Model ID (required)");
     prog.argument("<input_path>", "full path or URL to the file");
 }
+/**
+ * Build the CLI.
+ */
 export function cli() {
     program.name("mindee")
         .description("Command line interface for Mindee V2 products.")

package/src/v2/client.d.ts

@@ -39,6 +39,7 @@ export declare class Client {
      * @returns a `Promise` containing the search response.
      */
     searchModels(name?: string, modelType?: string): Promise<SearchResponse>;
+    /** Enqueues a product inference job without waiting for completion. */
     enqueue<P extends typeof BaseProduct>(product: P, inputSource: InputSource, params: InstanceType<P["parametersClass"]> | ConstructorParameters<P["parametersClass"]>[0]): Promise<JobResponse>;
     /**
      * Retrieves the result of a previously enqueued request.

package/src/v2/client.js

@@ -34,6 +34,7 @@ export class Client {
     async searchModels(name, modelType) {
         return await this.mindeeApi.reqGetSearchModel(name, modelType);
     }
+    /** Enqueues a product inference job without waiting for completion. */
     async enqueue(product, inputSource, params) {
         if (inputSource === undefined) {
             throw new MindeeError("An input document is required.");

package/src/v2/clientOptions/pollingOptions.d.ts

@@ -1,5 +1,8 @@
+/** Optional timer settings used by polling delays. */
 export interface TimerOptions {
+    /** Whether the timer should keep the event loop active. */
     ref?: boolean;
+    /** Optional signal used to abort timer waits. */
     signal?: AbortSignal;
 }
 export interface PollingOptionsConstructor {
@@ -51,6 +54,8 @@ export declare class PollingOptions {
     /** Options passed to every recurring `setTimeout()`. */
     recurringTimerOptions?: TimerOptions;
     constructor(params?: PollingOptionsConstructor);
+    /** Validates polling options against minimum accepted values. */
     validateSettings(): void;
+    /** Returns a compact string representation of the polling options. */
     toString(): string;
 }

package/src/v2/clientOptions/pollingOptions.js

@@ -65,6 +65,7 @@ export class PollingOptions {
         this.validateSettings();
         logger.debug(`Polling options initialized: ${this.toString()}`);
     }
+    /** Validates polling options against minimum accepted values. */
     validateSettings() {
         if (this.delaySec < minDelaySec) {
             throw new MindeeConfigurationError(`Cannot set auto-parsing delay to less than ${minDelaySec} second(s).`);
@@ -76,6 +77,7 @@ export class PollingOptions {
             throw new MindeeConfigurationError(`Cannot set retry to less than ${minRetries}.`);
         }
     }
+    /** Returns a compact string representation of the polling options. */
     toString() {
         return `{ initialDelaySec: ${this.initialDelaySec}, delaySec: ${this.delaySec}, maxRetries: ${this.maxRetries} }`;
     }

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

@@ -1,4 +1,5 @@
 import { StringDict } from "../../parsing/stringDict.js";
+/** Base response contract for v2 product responses. */
 export declare abstract class BaseResponse {
     /**
      * Raw text representation of the API's response.
@@ -14,4 +15,5 @@ export declare abstract class BaseResponse {
      */
     getRawHttp(): StringDict;
 }
+/** Constructor signature for typed v2 response classes. */
 export type ResponseConstructor<T extends BaseResponse> = new (serverResponse: StringDict) => T;

package/src/v2/parsing/baseResponse.js

@@ -1,4 +1,5 @@
 import { logger } from "../../logger.js";
+/** Base response contract for v2 product responses. */
 export class BaseResponse {
     /**
      * @param serverResponse JSON response from the server.

package/src/v2/parsing/error/errorDetails.d.ts

@@ -1,4 +1,5 @@
 import { ErrorItem } from "./errorItem.js";
+/** Structured error payload returned by v2 APIs. */
 export interface ErrorDetails {
     /**
      * The HTTP status code returned by the server.

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

@@ -1,6 +1,6 @@
 export { ErrorResponse, ErrorItem, } from "./error/index.js";
 export type { ErrorDetails } from "./error/index.js";
-export { Job, JobResponse, JobWebhook } from "./job/index.js";
+export { Job, JobResponse, JobWebhook, } from "./job/index.js";
 export { BaseInference, InferenceFile, InferenceModel, } from "./inference/index.js";
 export { LocalResponse } from "./localResponse.js";
 export { BaseResponse } from "./baseResponse.js";

package/src/v2/parsing/index.js

@@ -1,5 +1,5 @@
 export { ErrorResponse, ErrorItem, } from "./error/index.js";
-export { Job, JobResponse, JobWebhook } from "./job/index.js";
+export { Job, JobResponse, JobWebhook, } from "./job/index.js";
 export { BaseInference, InferenceFile, InferenceModel, } from "./inference/index.js";
 export { LocalResponse } from "./localResponse.js";
 export { BaseResponse } from "./baseResponse.js";

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

@@ -2,6 +2,7 @@ import { StringDict } from "../../../parsing/index.js";
 import { InferenceModel } from "./inferenceModel.js";
 import { InferenceFile } from "./inferenceFile.js";
 import { InferenceJob } from "./inferenceJob.js";
+/** Shared metadata container for v2 inference payloads. */
 export declare abstract class BaseInference {
     /**
      * Model info for the inference.
@@ -20,5 +21,6 @@ export declare abstract class BaseInference {
      */
     id: string;
     protected constructor(serverResponse: StringDict);
+    /** Returns a printable representation of inference metadata. */
     toString(): string;
 }

package/src/v2/parsing/inference/baseInference.js

@@ -1,6 +1,7 @@
 import { InferenceModel } from "./inferenceModel.js";
 import { InferenceFile } from "./inferenceFile.js";
 import { InferenceJob } from "./inferenceJob.js";
+/** Shared metadata container for v2 inference payloads. */
 export class BaseInference {
     constructor(serverResponse) {
         this.id = serverResponse["id"];
@@ -8,6 +9,7 @@ export class BaseInference {
         this.model = new InferenceModel(serverResponse["model"]);
         this.file = new InferenceFile(serverResponse["file"]);
     }
+    /** Returns a printable representation of inference metadata. */
     toString() {
         return ("Inference\n" +
             "#########\n" +

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

@@ -0,0 +1,33 @@
+import { StringDict } from "../../../parsing/index.js";
+import { ErrorResponse } from "../../../v2/index.js";
+import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+/**
+ * Webhook payload returned when an inference fails before producing a result.
+ */
+export declare class FailedInferenceResponse extends BaseResponse {
+    /**
+     * UUID of the failed inference.
+     */
+    inferenceId: string;
+    /**
+     * UUID of the model used.
+     */
+    modelId: string;
+    /**
+     * Name of the input file.
+     */
+    fileName: string;
+    /**
+     * Alias sent for the file, if any.
+     */
+    fileAlias?: string;
+    /**
+     * Problem details for the failure, if available.
+     */
+    error: ErrorResponse;
+    /**
+     * Date and time when the inference was started.
+     */
+    createdAt: Date | null;
+    constructor(serverResponse: StringDict);
+}

package/src/v2/parsing/inference/failedInferenceResponse.js

@@ -0,0 +1,17 @@
+import { parseDate } from "../../../parsing/index.js";
+import { ErrorResponse } from "../../../v2/index.js";
+import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+/**
+ * Webhook payload returned when an inference fails before producing a result.
+ */
+export class FailedInferenceResponse extends BaseResponse {
+    constructor(serverResponse) {
+        super(serverResponse);
+        this.inferenceId = serverResponse["inference_id"];
+        this.modelId = serverResponse["model_id"];
+        this.fileName = serverResponse["file_name"];
+        this.fileAlias = serverResponse["file_alias"];
+        this.error = new ErrorResponse(serverResponse["error"]);
+        this.createdAt = parseDate(serverResponse["created_at"]);
+    }
+}

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

@@ -2,8 +2,11 @@ import { FieldConfidence } from "./fieldConfidence.js";
 import { StringDict } from "../../../../parsing/stringDict.js";
 import { FieldLocation } from "./fieldLocation.js";
 export declare abstract class BaseField {
+    /** Indentation level used when rendering field text output. */
     protected _indentLevel: number;
+    /** Confidence level associated with this field. */
     confidence: FieldConfidence | undefined;
+    /** Optional list of source locations for this field. */
     locations: Array<FieldLocation> | undefined;
     protected constructor(rawResponse: StringDict, indentLevel?: number);
 }

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

@@ -2,9 +2,13 @@
  * Confidence level of a field as returned by the V2 API.
  */
 export declare enum FieldConfidence {
+    /** Maximum confidence level. */
     Certain = "Certain",
+    /** High confidence level. */
     High = "High",
+    /** Medium confidence level. */
     Medium = "Medium",
+    /** Low confidence level. */
     Low = "Low"
 }
 export declare namespace FieldConfidence {

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

@@ -4,9 +4,13 @@
  */
 export var FieldConfidence;
 (function (FieldConfidence) {
+    /** Maximum confidence level. */
     FieldConfidence["Certain"] = "Certain";
+    /** High confidence level. */
     FieldConfidence["High"] = "High";
+    /** Medium confidence level. */
     FieldConfidence["Medium"] = "Medium";
+    /** Low confidence level. */
     FieldConfidence["Low"] = "Low";
 })(FieldConfidence || (FieldConfidence = {}));
 // eslint-disable-next-line @typescript-eslint/no-namespace

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

@@ -5,4 +5,9 @@ import { StringDict } from "../../../../parsing/stringDict.js";
 import { ListField } from "./listField.js";
 import { ObjectField } from "./objectField.js";
 import { SimpleField } from "./simpleField.js";
+/**
+ * Create a field from a server response.
+ * @param serverResponse Server response.
+ * @param indentLevel Indent level.
+ */
 export declare function createField(serverResponse: StringDict, indentLevel?: number): SimpleField | ObjectField | ListField;

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

@@ -2,6 +2,11 @@ import { MindeeDeserializationError } from "../../../../errors/index.js";
 import { ListField } from "./listField.js";
 import { ObjectField } from "./objectField.js";
 import { SimpleField } from "./simpleField.js";
+/**
+ * Create a field from a server response.
+ * @param serverResponse Server response.
+ * @param indentLevel Indent level.
+ */
 export function createField(serverResponse, indentLevel = 0) {
     if (typeof serverResponse !== "object" || serverResponse === null) {
         throw new MindeeDeserializationError(`Unrecognized field format ${JSON.stringify(serverResponse)}.`);

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

@@ -9,5 +9,6 @@ export declare class FieldLocation {
     /** 0-based page index of where the polygon is located. */
     readonly page: any;
     constructor(serverResponse: StringDict);
+    /** Returns a readable location string. */
     toString(): string;
 }

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

@@ -7,6 +7,7 @@ export class FieldLocation {
         this.polygon = new Polygon(...serverResponse["polygon"]);
         this.page = serverResponse["page"];
     }
+    /** Returns a readable location string. */
     toString() {
         return `${this.polygon} on page ${this.page}`;
     }

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

@@ -2,11 +2,16 @@ import { StringDict } from "../../../../parsing/stringDict.js";
 import type { ListField } from "./listField.js";
 import type { ObjectField } from "./objectField.js";
 import type { SimpleField } from "./simpleField.js";
+/** Typed map of extraction fields returned by the API. */
 export declare class InferenceFields extends Map<string, SimpleField | ObjectField | ListField> {
+    /** Indentation level used when rendering text output. */
     protected _indentLevel: number;
     constructor(serverResponse: StringDict, indentLevel?: number);
+    /** Returns a field as a `SimpleField`, or throws if the type mismatches. */
     getSimpleField(fieldName: string): SimpleField;
+    /** Returns a field as an `ObjectField`, or throws if the type mismatches. */
     getObjectField(fieldName: string): ObjectField;
+    /** Returns a field as a `ListField`, or throws if the type mismatches. */
     getListField(fieldName: string): ListField;
     toString(indent?: number): string;
 }