mindee 4.29.0 → 4.31.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## v4.31.0 - 2025-10-07
+### Changes
+* :sparkles: allow comparing v2 field confidence
+* :coffin: remove obsolete US Mail V2
+
+
+## v4.30.0 - 2025-09-04
+### Changes
+* :sparkles: add support for inference options
+* :recycle: refactor rst display to match other SDKs
+### ¡Breaking Changes!
+* :recycle: :boom: update raw text output from server
+
 ## v4.29.0 - 2025-08-29
 ### Changes
 * :sparkles: add typed accessors for fields, list, object

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "4.29.0",
+    "version": "4.31.0",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",

package/src/clientV2.d.ts

@@ -52,7 +52,11 @@ export interface PollingOptions {
  * All fields are optional except `modelId`.
  *
  * @property modelId Identifier of the model that must process the document. **Required**.
- * @property rag When `true`, activates Retrieval-Augmented Generation (RAG).
+ * @property rag Enhance extraction accuracy with Retrieval-Augmented Generation.
+ * @property rawText Extract the full text content from the document as strings, and fill the `raw_text` attribute.
+ * @property polygon Calculate bounding box polygons for all fields, and fill their `locations` attribute.
+ * @property confidence Boost the precision and accuracy of all extractions.
+ *     Calculate confidence scores for all fields and fill their `confidence` attribute.
  * @property alias Custom alias assigned to the uploaded document.
  * @property webhookIds List of webhook UUIDs that will receive the final API response.
  * @property pollingOptions Client-side polling configuration (see {@link PollingOptions}).
@@ -73,6 +77,9 @@ export interface PollingOptions {
 export interface InferenceParameters {
     modelId: string;
     rag?: boolean;
+    rawText?: boolean;
+    polygon?: boolean;
+    confidence?: boolean;
     alias?: string;
     webhookIds?: string[];
     pollingOptions?: PollingOptions;

package/src/http/mindeeApiV2.js

@@ -82,8 +82,17 @@ _MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_processResponse = function
 }, _MindeeApiV2_documentEnqueuePost = function _MindeeApiV2_documentEnqueuePost(inputSource, params) {
     const form = new form_data_1.default();
     form.append("model_id", params.modelId);
-    if (params.rag) {
-        form.append("rag", "true");
+    if (params.rag !== undefined && params.rag !== null) {
+        form.append("rag", params.rag.toString());
+    }
+    if (params.polygon !== undefined && params.polygon !== null) {
+        form.append("polygon", params.polygon.toString().toLowerCase());
+    }
+    if (params.confidence !== undefined && params.confidence !== null) {
+        form.append("confidence", params.confidence.toString().toLowerCase());
+    }
+    if (params.rawText !== undefined && params.rawText !== null) {
+        form.append("raw_text", params.rawText.toString().toLowerCase());
     }
     if (params.webhookIds && params.webhookIds.length > 0) {
         form.append("webhook_ids", params.webhookIds.join(","));

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

@@ -7,3 +7,39 @@ export declare enum FieldConfidence {
     Medium = "Medium",
     Low = "Low"
 }
+export declare namespace 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: FieldConfidence | undefined): number;
+    /**
+     * 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: FieldConfidence | undefined, b: FieldConfidence | undefined): boolean;
+    /**
+     * 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: FieldConfidence | undefined, b: FieldConfidence | undefined): boolean;
+    /**
+     * 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: FieldConfidence | undefined, b: FieldConfidence | undefined): boolean;
+    /**
+     * 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: FieldConfidence | undefined, b: FieldConfidence | undefined): boolean;
+}

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

@@ -12,3 +12,66 @@ var FieldConfidence;
     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/index.d.ts

@@ -1,6 +1,7 @@
 export { CommonResponse } from "./commonResponse";
 export { ErrorResponse } from "./errorResponse";
 export { Inference } from "./inference";
+export { InferenceActiveOptions } from "./inferenceActiveOptions";
 export { InferenceFile } from "./inferenceFile";
 export { InferenceModel } from "./inferenceModel";
 export { InferenceResponse } from "./inferenceResponse";

package/src/parsing/v2/index.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.JobWebhook = exports.RawText = exports.JobResponse = exports.Job = exports.InferenceResult = exports.InferenceResponse = exports.InferenceModel = exports.InferenceFile = exports.Inference = exports.ErrorResponse = exports.CommonResponse = void 0;
+exports.JobWebhook = exports.RawText = exports.JobResponse = exports.Job = exports.InferenceResult = exports.InferenceResponse = exports.InferenceModel = exports.InferenceFile = exports.InferenceActiveOptions = exports.Inference = 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 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");

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

@@ -2,6 +2,7 @@ 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.
@@ -19,6 +20,10 @@ export declare class Inference {
      * ID of the inference.
      */
     id?: string;
+    /**
+     * Active options for the inference.
+     */
+    activeOptions: InferenceActiveOptions;
     constructor(serverResponse: StringDict);
     toString(): string;
 }

package/src/parsing/v2/inference.js

@@ -4,22 +4,20 @@ 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"]);
-        if ("id" in serverResponse) {
-            this.id = serverResponse["id"];
-        }
+        this.activeOptions = new inferenceActiveOptions_1.InferenceActiveOptions(serverResponse["active_options"]);
     }
     toString() {
         return ("Inference\n" +
             "#########\n" +
-            "Model\n" +
-            "=====\n" +
-            `:ID: ${this.model.id}\n\n` +
+            this.model.toString() + "\n" +
             this.file.toString() + "\n" +
+            this.activeOptions.toString() + "\n" +
             this.result + "\n");
     }
 }

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

@@ -0,0 +1,21 @@
+import { StringDict } from "../common";
+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;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/parsing/v2/inferenceActiveOptions.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InferenceActiveOptions = void 0;
+class InferenceActiveOptions {
+    constructor(serverResponse) {
+        this.rag = serverResponse["rag"];
+        this.rawText = serverResponse["raw_text"];
+        this.polygon = serverResponse["polygon"];
+        this.confidence = serverResponse["confidence"];
+    }
+    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`;
+    }
+}
+exports.InferenceActiveOptions = InferenceActiveOptions;

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

@@ -5,4 +5,5 @@ export declare class InferenceModel {
      */
     id: string;
     constructor(serverResponse: StringDict);
+    toString(): string;
 }

package/src/parsing/v2/inferenceModel.js

@@ -5,5 +5,10 @@ class InferenceModel {
     constructor(serverResponse) {
         this.id = serverResponse["id"];
     }
+    toString() {
+        return "Model\n" +
+            "=====\n" +
+            `:ID: ${this.id}\n`;
+    }
 }
 exports.InferenceModel = InferenceModel;

package/src/parsing/v2/inferenceResult.js

@@ -11,12 +11,7 @@ class InferenceResult {
         }
     }
     toString() {
-        const parts = [
-            "Fields",
-            "======",
-            this.fields.toString(),
-        ];
-        return parts.join("\n");
+        return `Fields\n======\n${this.fields}`;
     }
 }
 exports.InferenceResult = InferenceResult;

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

@@ -6,4 +6,5 @@ export declare class RawText {
      */
     pages: Array<RawTextPage>;
     constructor(serverResponse: StringDict);
+    toString(): string;
 }

package/src/parsing/v2/rawText.js

@@ -6,5 +6,8 @@ class RawText {
     constructor(serverResponse) {
         this.pages = serverResponse["pages"] ? serverResponse["pages"].map((rawTextPage) => new rawTextPage_1.RawTextPage(rawTextPage)) : [];
     }
+    toString() {
+        return this.pages.map(page => page.toString()).join("\n\n");
+    }
 }
 exports.RawText = RawText;

package/src/product/us/index.d.ts

@@ -1,4 +1,3 @@
 export { BankCheckV1 } from "./bankCheck/bankCheckV1";
 export { HealthcareCardV1 } from "./healthcareCard/healthcareCardV1";
-export { UsMailV2 } from "./usMail/usMailV2";
 export { UsMailV3 } from "./usMail/usMailV3";

package/src/product/us/index.js

@@ -1,11 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UsMailV3 = exports.UsMailV2 = exports.HealthcareCardV1 = exports.BankCheckV1 = void 0;
+exports.UsMailV3 = exports.HealthcareCardV1 = exports.BankCheckV1 = void 0;
 var bankCheckV1_1 = require("./bankCheck/bankCheckV1");
 Object.defineProperty(exports, "BankCheckV1", { enumerable: true, get: function () { return bankCheckV1_1.BankCheckV1; } });
 var healthcareCardV1_1 = require("./healthcareCard/healthcareCardV1");
 Object.defineProperty(exports, "HealthcareCardV1", { enumerable: true, get: function () { return healthcareCardV1_1.HealthcareCardV1; } });
-var usMailV2_1 = require("./usMail/usMailV2");
-Object.defineProperty(exports, "UsMailV2", { enumerable: true, get: function () { return usMailV2_1.UsMailV2; } });
 var usMailV3_1 = require("./usMail/usMailV3");
 Object.defineProperty(exports, "UsMailV3", { enumerable: true, get: function () { return usMailV3_1.UsMailV3; } });

package/src/product/us/usMail/index.d.ts

@@ -1,2 +1 @@
-export { UsMailV2 } from "./usMailV2";
 export { UsMailV3 } from "./usMailV3";

package/src/product/us/usMail/index.js

@@ -1,7 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UsMailV3 = exports.UsMailV2 = void 0;
-var usMailV2_1 = require("./usMailV2");
-Object.defineProperty(exports, "UsMailV2", { enumerable: true, get: function () { return usMailV2_1.UsMailV2; } });
+exports.UsMailV3 = void 0;
 var usMailV3_1 = require("./usMailV3");
 Object.defineProperty(exports, "UsMailV3", { enumerable: true, get: function () { return usMailV3_1.UsMailV3; } });

package/src/product/us/usMail/internal.d.ts

@@ -1,7 +1,3 @@
-export { UsMailV2 } from "./usMailV2";
-export { UsMailV2Document } from "./usMailV2Document";
-export { UsMailV2RecipientAddress } from "./usMailV2RecipientAddress";
-export { UsMailV2SenderAddress } from "./usMailV2SenderAddress";
 export { UsMailV3 } from "./usMailV3";
 export { UsMailV3Document } from "./usMailV3Document";
 export { UsMailV3RecipientAddress } from "./usMailV3RecipientAddress";

package/src/product/us/usMail/internal.js

@@ -1,14 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UsMailV3SenderAddress = exports.UsMailV3RecipientAddress = exports.UsMailV3Document = exports.UsMailV3 = exports.UsMailV2SenderAddress = exports.UsMailV2RecipientAddress = exports.UsMailV2Document = exports.UsMailV2 = void 0;
-var usMailV2_1 = require("./usMailV2");
-Object.defineProperty(exports, "UsMailV2", { enumerable: true, get: function () { return usMailV2_1.UsMailV2; } });
-var usMailV2Document_1 = require("./usMailV2Document");
-Object.defineProperty(exports, "UsMailV2Document", { enumerable: true, get: function () { return usMailV2Document_1.UsMailV2Document; } });
-var usMailV2RecipientAddress_1 = require("./usMailV2RecipientAddress");
-Object.defineProperty(exports, "UsMailV2RecipientAddress", { enumerable: true, get: function () { return usMailV2RecipientAddress_1.UsMailV2RecipientAddress; } });
-var usMailV2SenderAddress_1 = require("./usMailV2SenderAddress");
-Object.defineProperty(exports, "UsMailV2SenderAddress", { enumerable: true, get: function () { return usMailV2SenderAddress_1.UsMailV2SenderAddress; } });
+exports.UsMailV3SenderAddress = exports.UsMailV3RecipientAddress = exports.UsMailV3Document = exports.UsMailV3 = void 0;
 var usMailV3_1 = require("./usMailV3");
 Object.defineProperty(exports, "UsMailV3", { enumerable: true, get: function () { return usMailV3_1.UsMailV3; } });
 var usMailV3Document_1 = require("./usMailV3Document");

package/src/product/us/usMail/usMailV2.d.ts

@@ -1,16 +0,0 @@
-import { Inference, StringDict, Page } from "../../../parsing/common";
-import { UsMailV2Document } from "./usMailV2Document";
-/**
- * US Mail API version 2 inference prediction.
- */
-export declare class UsMailV2 extends Inference {
-    /** The endpoint's name. */
-    endpointName: string;
-    /** The endpoint's version. */
-    endpointVersion: string;
-    /** The document-level prediction. */
-    prediction: UsMailV2Document;
-    /** The document's pages. */
-    pages: Page<UsMailV2Document>[];
-    constructor(rawPrediction: StringDict);
-}

package/src/product/us/usMail/usMailV2.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UsMailV2 = void 0;
-const common_1 = require("../../../parsing/common");
-const usMailV2Document_1 = require("./usMailV2Document");
-/**
- * US Mail API version 2 inference prediction.
- */
-class UsMailV2 extends common_1.Inference {
-    constructor(rawPrediction) {
-        super(rawPrediction);
-        /** The endpoint's name. */
-        this.endpointName = "us_mail";
-        /** The endpoint's version. */
-        this.endpointVersion = "2";
-        /** The document's pages. */
-        this.pages = [];
-        this.prediction = new usMailV2Document_1.UsMailV2Document(rawPrediction["prediction"]);
-        rawPrediction["pages"].forEach((page) => {
-            if (page.prediction !== undefined && page.prediction !== null &&
-                Object.keys(page.prediction).length > 0) {
-                this.pages.push(new common_1.Page(usMailV2Document_1.UsMailV2Document, page, page["id"], page["orientation"]));
-            }
-        });
-    }
-}
-exports.UsMailV2 = UsMailV2;

package/src/product/us/usMail/usMailV2Document.d.ts

@@ -1,22 +0,0 @@
-import { Prediction, StringDict } from "../../../parsing/common";
-import { UsMailV2SenderAddress } from "./usMailV2SenderAddress";
-import { UsMailV2RecipientAddress } from "./usMailV2RecipientAddress";
-import { StringField } from "../../../parsing/standard";
-/**
- * US Mail API version 2.0 document data.
- */
-export declare class UsMailV2Document implements Prediction {
-    /** The addresses of the recipients. */
-    recipientAddresses: UsMailV2RecipientAddress[];
-    /** The names of the recipients. */
-    recipientNames: StringField[];
-    /** The address of the sender. */
-    senderAddress: UsMailV2SenderAddress;
-    /** The name of the sender. */
-    senderName: StringField;
-    constructor(rawPrediction: StringDict, pageId?: number);
-    /**
-     * Default string representation.
-     */
-    toString(): string;
-}

package/src/product/us/usMail/usMailV2Document.js

@@ -1,62 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UsMailV2Document = void 0;
-const common_1 = require("../../../parsing/common");
-const usMailV2SenderAddress_1 = require("./usMailV2SenderAddress");
-const usMailV2RecipientAddress_1 = require("./usMailV2RecipientAddress");
-const standard_1 = require("../../../parsing/standard");
-/**
- * US Mail API version 2.0 document data.
- */
-class UsMailV2Document {
-    constructor(rawPrediction, pageId) {
-        /** The addresses of the recipients. */
-        this.recipientAddresses = [];
-        /** The names of the recipients. */
-        this.recipientNames = [];
-        rawPrediction["recipient_addresses"] &&
-            rawPrediction["recipient_addresses"].map((itemPrediction) => this.recipientAddresses.push(new usMailV2RecipientAddress_1.UsMailV2RecipientAddress({
-                prediction: itemPrediction,
-                pageId: pageId,
-            })));
-        rawPrediction["recipient_names"] &&
-            rawPrediction["recipient_names"].map((itemPrediction) => this.recipientNames.push(new standard_1.StringField({
-                prediction: itemPrediction,
-                pageId: pageId,
-            })));
-        this.senderAddress = new usMailV2SenderAddress_1.UsMailV2SenderAddress({
-            prediction: rawPrediction["sender_address"],
-            pageId: pageId,
-        });
-        this.senderName = new standard_1.StringField({
-            prediction: rawPrediction["sender_name"],
-            pageId: pageId,
-        });
-    }
-    /**
-     * Default string representation.
-     */
-    toString() {
-        const recipientNames = this.recipientNames.join("\n                  ");
-        let recipientAddressesSummary = "";
-        if (this.recipientAddresses && this.recipientAddresses.length > 0) {
-            const recipientAddressesColSizes = [17, 37, 19, 13, 24, 7, 27];
-            recipientAddressesSummary += "\n" + (0, common_1.lineSeparator)(recipientAddressesColSizes, "-") + "\n  ";
-            recipientAddressesSummary += "| City            ";
-            recipientAddressesSummary += "| Complete Address                    ";
-            recipientAddressesSummary += "| Is Address Change ";
-            recipientAddressesSummary += "| Postal Code ";
-            recipientAddressesSummary += "| Private Mailbox Number ";
-            recipientAddressesSummary += "| State ";
-            recipientAddressesSummary += "| Street                    ";
-            recipientAddressesSummary += "|\n" + (0, common_1.lineSeparator)(recipientAddressesColSizes, "=");
-            recipientAddressesSummary += this.recipientAddresses.map((item) => "\n  " + item.toTableLine() + "\n" + (0, common_1.lineSeparator)(recipientAddressesColSizes, "-")).join("");
-        }
-        const outStr = `:Sender Name: ${this.senderName}
-:Sender Address: ${this.senderAddress.toFieldList()}
-:Recipient Names: ${recipientNames}
-:Recipient Addresses: ${recipientAddressesSummary}`.trimEnd();
-        return (0, common_1.cleanOutString)(outStr);
-    }
-}
-exports.UsMailV2Document = UsMailV2Document;

package/src/product/us/usMail/usMailV2RecipientAddress.d.ts

@@ -1,40 +0,0 @@
-import { StringDict } from "../../../parsing/common";
-import { Polygon } from "../../../geometry";
-/**
- * The addresses of the recipients.
- */
-export declare class UsMailV2RecipientAddress {
-    #private;
-    /** The city of the recipient's address. */
-    city: string | null;
-    /** The complete address of the recipient. */
-    complete: string | null;
-    /** Indicates if the recipient's address is a change of address. */
-    isAddressChange: boolean | null;
-    /** The postal code of the recipient's address. */
-    postalCode: string | null;
-    /** The private mailbox number of the recipient's address. */
-    privateMailboxNumber: string | null;
-    /** Second part of the ISO 3166-2 code, consisting of two letters indicating the US State. */
-    state: string | null;
-    /** The street of the recipient's address. */
-    street: string | null;
-    /** Confidence score */
-    confidence: number;
-    /** The document page on which the information was found. */
-    pageId: number;
-    /**
-     * Contains the relative vertices coordinates (points) of a polygon containing
-     * the field in the document.
-     */
-    polygon: Polygon;
-    constructor({ prediction }: StringDict);
-    /**
-     * Default string representation.
-     */
-    toString(): string;
-    /**
-     * Output in a format suitable for inclusion in an rST table.
-     */
-    toTableLine(): string;
-}

package/src/product/us/usMail/usMailV2RecipientAddress.js

@@ -1,119 +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 _UsMailV2RecipientAddress_instances, _UsMailV2RecipientAddress_printableValues;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UsMailV2RecipientAddress = void 0;
-const common_1 = require("../../../parsing/common");
-const geometry_1 = require("../../../geometry");
-/**
- * The addresses of the recipients.
- */
-class UsMailV2RecipientAddress {
-    constructor({ prediction = {} }) {
-        _UsMailV2RecipientAddress_instances.add(this);
-        /** Confidence score */
-        this.confidence = 0.0;
-        /**
-         * Contains the relative vertices coordinates (points) of a polygon containing
-         * the field in the document.
-         */
-        this.polygon = new geometry_1.Polygon();
-        this.city = prediction["city"];
-        this.complete = prediction["complete"];
-        this.isAddressChange = prediction["is_address_change"];
-        this.postalCode = prediction["postal_code"];
-        this.privateMailboxNumber = prediction["private_mailbox_number"];
-        this.state = prediction["state"];
-        this.street = prediction["street"];
-        this.pageId = prediction["page_id"];
-        this.confidence = prediction["confidence"] ? prediction.confidence : 0.0;
-        if (prediction["polygon"]) {
-            this.polygon = prediction.polygon;
-        }
-    }
-    /**
-     * Default string representation.
-     */
-    toString() {
-        const printable = __classPrivateFieldGet(this, _UsMailV2RecipientAddress_instances, "m", _UsMailV2RecipientAddress_printableValues).call(this);
-        return ("City: " +
-            printable.city +
-            ", Complete Address: " +
-            printable.complete +
-            ", Is Address Change: " +
-            printable.isAddressChange +
-            ", Postal Code: " +
-            printable.postalCode +
-            ", Private Mailbox Number: " +
-            printable.privateMailboxNumber +
-            ", State: " +
-            printable.state +
-            ", Street: " +
-            printable.street);
-    }
-    /**
-     * Output in a format suitable for inclusion in an rST table.
-     */
-    toTableLine() {
-        const printable = __classPrivateFieldGet(this, _UsMailV2RecipientAddress_instances, "m", _UsMailV2RecipientAddress_printableValues).call(this);
-        return ("| " +
-            printable.city.padEnd(15) +
-            " | " +
-            printable.complete.padEnd(35) +
-            " | " +
-            printable.isAddressChange.padEnd(17) +
-            " | " +
-            printable.postalCode.padEnd(11) +
-            " | " +
-            printable.privateMailboxNumber.padEnd(22) +
-            " | " +
-            printable.state.padEnd(5) +
-            " | " +
-            printable.street.padEnd(25) +
-            " |");
-    }
-}
-exports.UsMailV2RecipientAddress = UsMailV2RecipientAddress;
-_UsMailV2RecipientAddress_instances = new WeakSet(), _UsMailV2RecipientAddress_printableValues = function _UsMailV2RecipientAddress_printableValues() {
-    return {
-        city: this.city ?
-            this.city.length <= 15 ?
-                (0, common_1.cleanSpecialChars)(this.city) :
-                (0, common_1.cleanSpecialChars)(this.city).slice(0, 12) + "..." :
-            "",
-        complete: this.complete ?
-            this.complete.length <= 35 ?
-                (0, common_1.cleanSpecialChars)(this.complete) :
-                (0, common_1.cleanSpecialChars)(this.complete).slice(0, 32) + "..." :
-            "",
-        isAddressChange: this.isAddressChange === true ?
-            "True" :
-            this.isAddressChange === false ?
-                "False" :
-                "",
-        postalCode: this.postalCode ?
-            this.postalCode.length <= 11 ?
-                (0, common_1.cleanSpecialChars)(this.postalCode) :
-                (0, common_1.cleanSpecialChars)(this.postalCode).slice(0, 8) + "..." :
-            "",
-        privateMailboxNumber: this.privateMailboxNumber ?
-            this.privateMailboxNumber.length <= 22 ?
-                (0, common_1.cleanSpecialChars)(this.privateMailboxNumber) :
-                (0, common_1.cleanSpecialChars)(this.privateMailboxNumber).slice(0, 19) + "..." :
-            "",
-        state: this.state ?
-            this.state.length <= 5 ?
-                (0, common_1.cleanSpecialChars)(this.state) :
-                (0, common_1.cleanSpecialChars)(this.state).slice(0, 2) + "..." :
-            "",
-        street: this.street ?
-            this.street.length <= 25 ?
-                (0, common_1.cleanSpecialChars)(this.street) :
-                (0, common_1.cleanSpecialChars)(this.street).slice(0, 22) + "..." :
-            "",
-    };
-};

package/src/product/us/usMail/usMailV2SenderAddress.d.ts

@@ -1,36 +0,0 @@
-import { StringDict } from "../../../parsing/common";
-import { Polygon } from "../../../geometry";
-/**
- * The address of the sender.
- */
-export declare class UsMailV2SenderAddress {
-    #private;
-    /** The city of the sender's address. */
-    city: string | null;
-    /** The complete address of the sender. */
-    complete: string | null;
-    /** The postal code of the sender's address. */
-    postalCode: string | null;
-    /** Second part of the ISO 3166-2 code, consisting of two letters indicating the US State. */
-    state: string | null;
-    /** The street of the sender's address. */
-    street: string | null;
-    /** Confidence score */
-    confidence: number;
-    /** The document page on which the information was found. */
-    pageId: number;
-    /**
-     * Contains the relative vertices coordinates (points) of a polygon containing
-     * the field in the document.
-     */
-    polygon: Polygon;
-    constructor({ prediction }: StringDict);
-    /**
-     * Default string representation.
-     */
-    toString(): string;
-    /**
-     * Output in a format suitable for inclusion in a field list.
-     */
-    toFieldList(): string;
-}

package/src/product/us/usMail/usMailV2SenderAddress.js

@@ -1,73 +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 _UsMailV2SenderAddress_instances, _UsMailV2SenderAddress_printableValues;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UsMailV2SenderAddress = void 0;
-const geometry_1 = require("../../../geometry");
-/**
- * The address of the sender.
- */
-class UsMailV2SenderAddress {
-    constructor({ prediction = {} }) {
-        _UsMailV2SenderAddress_instances.add(this);
-        /** Confidence score */
-        this.confidence = 0.0;
-        /**
-         * Contains the relative vertices coordinates (points) of a polygon containing
-         * the field in the document.
-         */
-        this.polygon = new geometry_1.Polygon();
-        this.city = prediction["city"];
-        this.complete = prediction["complete"];
-        this.postalCode = prediction["postal_code"];
-        this.state = prediction["state"];
-        this.street = prediction["street"];
-        this.pageId = prediction["page_id"];
-        this.confidence = prediction["confidence"] ? prediction.confidence : 0.0;
-        if (prediction["polygon"]) {
-            this.polygon = prediction.polygon;
-        }
-    }
-    /**
-     * Default string representation.
-     */
-    toString() {
-        const printable = __classPrivateFieldGet(this, _UsMailV2SenderAddress_instances, "m", _UsMailV2SenderAddress_printableValues).call(this);
-        return ("City: " +
-            printable.city +
-            ", Complete Address: " +
-            printable.complete +
-            ", Postal Code: " +
-            printable.postalCode +
-            ", State: " +
-            printable.state +
-            ", Street: " +
-            printable.street);
-    }
-    /**
-     * Output in a format suitable for inclusion in a field list.
-     */
-    toFieldList() {
-        const printable = __classPrivateFieldGet(this, _UsMailV2SenderAddress_instances, "m", _UsMailV2SenderAddress_printableValues).call(this);
-        return `
-  :City: ${printable.city}
-  :Complete Address: ${printable.complete}
-  :Postal Code: ${printable.postalCode}
-  :State: ${printable.state}
-  :Street: ${printable.street}`.trimEnd();
-    }
-}
-exports.UsMailV2SenderAddress = UsMailV2SenderAddress;
-_UsMailV2SenderAddress_instances = new WeakSet(), _UsMailV2SenderAddress_printableValues = function _UsMailV2SenderAddress_printableValues() {
-    return {
-        city: this.city ?? "",
-        complete: this.complete ?? "",
-        postalCode: this.postalCode ?? "",
-        state: this.state ?? "",
-        street: this.street ?? "",
-    };
-};