mindee 4.20.0 → 4.22.0

package/src/input/sources/urlInput.d.ts

@@ -0,0 +1,32 @@
+import { InputSource } from "./inputSource";
+import { BytesInput } from "./bytesInput";
+export declare class UrlInput extends InputSource {
+    private readonly url;
+    constructor({ url }: {
+        url: string;
+    });
+    init(): Promise<void>;
+    private fetchFileContent;
+    saveToFile(options: {
+        filepath: string;
+        filename?: string;
+        username?: string;
+        password?: string;
+        token?: string;
+        headers?: Record<string, string>;
+        maxRedirects?: number;
+    }): Promise<string>;
+    asLocalInputSource(options?: {
+        filename?: string;
+        username?: string;
+        password?: string;
+        token?: string;
+        headers?: Record<string, string>;
+        maxRedirects?: number;
+    }): Promise<BytesInput>;
+    private static extractFilenameFromUrl;
+    private static generateFileName;
+    private static getFileExtension;
+    private fillFilename;
+    private makeRequest;
+}

package/src/input/sources/urlInput.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UrlInput = void 0;
+const inputSource_1 = require("./inputSource");
+const url_1 = require("url");
+const path_1 = require("path");
+const crypto_1 = require("crypto");
+const promises_1 = require("fs/promises");
+const https_1 = require("https");
+const bytesInput_1 = require("./bytesInput");
+class UrlInput extends inputSource_1.InputSource {
+    constructor({ url }) {
+        super();
+        this.url = url;
+    }
+    async init() {
+        if (!this.url.toLowerCase().startsWith("https")) {
+            throw new Error("URL must be HTTPS");
+        }
+        this.fileObject = this.url;
+    }
+    async fetchFileContent(options) {
+        const { username, password, token, headers = {}, maxRedirects = 3 } = options;
+        if (token) {
+            headers["Authorization"] = `Bearer ${token}`;
+        }
+        const auth = username && password ? `${username}:${password}` : undefined;
+        return await this.makeRequest(this.url, auth, headers, 0, maxRedirects);
+    }
+    async saveToFile(options) {
+        const { filepath, filename, ...fetchOptions } = options;
+        const { content, finalUrl } = await this.fetchFileContent(fetchOptions);
+        const finalFilename = this.fillFilename(filename, finalUrl);
+        const fullPath = `${filepath}/${finalFilename}`;
+        await (0, promises_1.writeFile)(fullPath, content);
+        return fullPath;
+    }
+    async asLocalInputSource(options = {}) {
+        const { filename, ...fetchOptions } = options;
+        const { content, finalUrl } = await this.fetchFileContent(fetchOptions);
+        const finalFilename = this.fillFilename(filename, finalUrl);
+        return new bytesInput_1.BytesInput({ inputBytes: content, filename: finalFilename });
+    }
+    static extractFilenameFromUrl(uri) {
+        return (0, path_1.basename)(new url_1.URL(uri).pathname || "");
+    }
+    static generateFileName(extension = ".tmp") {
+        const randomString = (0, crypto_1.randomBytes)(4).toString("hex");
+        const timestamp = new Date().toISOString().replace(/[-:]/g, "").split(".")[0];
+        return `mindee_temp_${timestamp}_${randomString}${extension}`;
+    }
+    static getFileExtension(filename) {
+        const ext = (0, path_1.extname)(filename);
+        return ext ? ext.toLowerCase() : null;
+    }
+    fillFilename(filename, finalUrl) {
+        if (!filename) {
+            filename = finalUrl ? UrlInput.extractFilenameFromUrl(finalUrl) : UrlInput.extractFilenameFromUrl(this.url);
+        }
+        if (!filename || !(0, path_1.extname)(filename)) {
+            filename = UrlInput.generateFileName(UrlInput.getFileExtension(filename || "") || undefined);
+        }
+        return filename;
+    }
+    async makeRequest(url, auth, headers, redirects, maxRedirects) {
+        const parsedUrl = new url_1.URL(url);
+        const options = {
+            hostname: parsedUrl.hostname,
+            path: parsedUrl.pathname + parsedUrl.search,
+            method: "GET",
+            headers: headers,
+            auth: auth,
+        };
+        const response = await new Promise((resolve, reject) => {
+            const req = (0, https_1.request)(options, resolve);
+            req.on("error", reject);
+            req.end();
+        });
+        if (response.statusCode && response.statusCode >= 300 && response.statusCode < 400) {
+            if (redirects === maxRedirects) {
+                throw new Error(`Can't reach URL after ${redirects} out of ${maxRedirects} redirects, aborting operation.`);
+            }
+            if (response.headers.location) {
+                return await this.makeRequest(response.headers.location, auth, headers, redirects + 1, maxRedirects);
+            }
+            throw new Error("Redirect location not found");
+        }
+        if (!response.statusCode || response.statusCode >= 400 || response.statusCode < 200) {
+            throw new Error(`Couldn't retrieve file from server, error code ${response.statusCode}.`);
+        }
+        const chunks = [];
+        for await (const chunk of response) {
+            chunks.push(chunk);
+        }
+        return { content: Buffer.concat(chunks), finalUrl: url };
+    }
+}
+exports.UrlInput = UrlInput;

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

@@ -1,7 +1,6 @@
 export { BankAccountDetailsV1 } from "./bankAccountDetails/bankAccountDetailsV1";
 export { BankAccountDetailsV2 } from "./bankAccountDetails/bankAccountDetailsV2";
 export { CarteGriseV1 } from "./carteGrise/carteGriseV1";
-export { CarteVitaleV1 } from "./carteVitale/carteVitaleV1";
 export { EnergyBillV1 } from "./energyBill/energyBillV1";
 export { HealthCardV1 } from "./healthCard/healthCardV1";
 export { IdCardV1 } from "./idCard/idCardV1";

package/src/product/fr/index.js

@@ -1,14 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PayslipV3 = exports.PayslipV2 = exports.IdCardV2 = exports.IdCardV1 = exports.HealthCardV1 = exports.EnergyBillV1 = exports.CarteVitaleV1 = exports.CarteGriseV1 = exports.BankAccountDetailsV2 = exports.BankAccountDetailsV1 = void 0;
+exports.PayslipV3 = exports.PayslipV2 = exports.IdCardV2 = exports.IdCardV1 = exports.HealthCardV1 = exports.EnergyBillV1 = exports.CarteGriseV1 = exports.BankAccountDetailsV2 = exports.BankAccountDetailsV1 = void 0;
 var bankAccountDetailsV1_1 = require("./bankAccountDetails/bankAccountDetailsV1");
 Object.defineProperty(exports, "BankAccountDetailsV1", { enumerable: true, get: function () { return bankAccountDetailsV1_1.BankAccountDetailsV1; } });
 var bankAccountDetailsV2_1 = require("./bankAccountDetails/bankAccountDetailsV2");
 Object.defineProperty(exports, "BankAccountDetailsV2", { enumerable: true, get: function () { return bankAccountDetailsV2_1.BankAccountDetailsV2; } });
 var carteGriseV1_1 = require("./carteGrise/carteGriseV1");
 Object.defineProperty(exports, "CarteGriseV1", { enumerable: true, get: function () { return carteGriseV1_1.CarteGriseV1; } });
-var carteVitaleV1_1 = require("./carteVitale/carteVitaleV1");
-Object.defineProperty(exports, "CarteVitaleV1", { enumerable: true, get: function () { return carteVitaleV1_1.CarteVitaleV1; } });
 var energyBillV1_1 = require("./energyBill/energyBillV1");
 Object.defineProperty(exports, "EnergyBillV1", { enumerable: true, get: function () { return energyBillV1_1.EnergyBillV1; } });
 var healthCardV1_1 = require("./healthCard/healthCardV1");

package/src/product/fr/internal.d.ts

@@ -1,6 +1,5 @@
 export * as bankAccountDetails from "./bankAccountDetails/internal";
 export * as carteGrise from "./carteGrise/internal";
-export * as carteVitale from "./carteVitale/internal";
 export * as energyBill from "./energyBill/internal";
 export * as fr from "./healthCard/internal";
 export * as idCard from "./idCard/internal";

package/src/product/fr/internal.js

@@ -23,10 +23,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.payslip = exports.idCard = exports.fr = exports.energyBill = exports.carteVitale = exports.carteGrise = exports.bankAccountDetails = void 0;
+exports.payslip = exports.idCard = exports.fr = exports.energyBill = exports.carteGrise = exports.bankAccountDetails = void 0;
 exports.bankAccountDetails = __importStar(require("./bankAccountDetails/internal"));
 exports.carteGrise = __importStar(require("./carteGrise/internal"));
-exports.carteVitale = __importStar(require("./carteVitale/internal"));
 exports.energyBill = __importStar(require("./energyBill/internal"));
 exports.fr = __importStar(require("./healthCard/internal"));
 exports.idCard = __importStar(require("./idCard/internal"));

package/src/product/ind/indianPassport/indianPassportV1Document.d.ts

@@ -1,7 +1,7 @@
 import { Prediction, StringDict } from "../../../parsing/common";
 import { ClassificationField, DateField, StringField } from "../../../parsing/standard";
 /**
- * Passport - India API version 1.1 document data.
+ * Passport - India API version 1.2 document data.
  */
 export declare class IndianPassportV1Document implements Prediction {
     /** The first line of the address of the passport holder. */

package/src/product/ind/indianPassport/indianPassportV1Document.js

@@ -4,7 +4,7 @@ exports.IndianPassportV1Document = void 0;
 const common_1 = require("../../../parsing/common");
 const standard_1 = require("../../../parsing/standard");
 /**
- * Passport - India API version 1.1 document data.
+ * Passport - India API version 1.2 document data.
  */
 class IndianPassportV1Document {
     constructor(rawPrediction, pageId) {

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

@@ -2,4 +2,5 @@ export { BankCheckV1 } from "./bankCheck/bankCheckV1";
 export { DriverLicenseV1 } from "./driverLicense/driverLicenseV1";
 export { HealthcareCardV1 } from "./healthcareCard/healthcareCardV1";
 export { UsMailV2 } from "./usMail/usMailV2";
+export { UsMailV3 } from "./usMail/usMailV3";
 export { W9V1 } from "./w9/w9V1";

package/src/product/us/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.W9V1 = exports.UsMailV2 = exports.HealthcareCardV1 = exports.DriverLicenseV1 = exports.BankCheckV1 = void 0;
+exports.W9V1 = exports.UsMailV3 = exports.UsMailV2 = exports.HealthcareCardV1 = exports.DriverLicenseV1 = exports.BankCheckV1 = void 0;
 var bankCheckV1_1 = require("./bankCheck/bankCheckV1");
 Object.defineProperty(exports, "BankCheckV1", { enumerable: true, get: function () { return bankCheckV1_1.BankCheckV1; } });
 var driverLicenseV1_1 = require("./driverLicense/driverLicenseV1");
@@ -9,5 +9,7 @@ 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; } });
 var w9V1_1 = require("./w9/w9V1");
 Object.defineProperty(exports, "W9V1", { enumerable: true, get: function () { return w9V1_1.W9V1; } });

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

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

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

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

@@ -2,3 +2,7 @@ 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";
+export { UsMailV3SenderAddress } from "./usMailV3SenderAddress";

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UsMailV2SenderAddress = exports.UsMailV2RecipientAddress = exports.UsMailV2Document = exports.UsMailV2 = void 0;
+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");
@@ -9,3 +9,11 @@ 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; } });
+var usMailV3_1 = require("./usMailV3");
+Object.defineProperty(exports, "UsMailV3", { enumerable: true, get: function () { return usMailV3_1.UsMailV3; } });
+var usMailV3Document_1 = require("./usMailV3Document");
+Object.defineProperty(exports, "UsMailV3Document", { enumerable: true, get: function () { return usMailV3Document_1.UsMailV3Document; } });
+var usMailV3RecipientAddress_1 = require("./usMailV3RecipientAddress");
+Object.defineProperty(exports, "UsMailV3RecipientAddress", { enumerable: true, get: function () { return usMailV3RecipientAddress_1.UsMailV3RecipientAddress; } });
+var usMailV3SenderAddress_1 = require("./usMailV3SenderAddress");
+Object.defineProperty(exports, "UsMailV3SenderAddress", { enumerable: true, get: function () { return usMailV3SenderAddress_1.UsMailV3SenderAddress; } });

package/src/product/{fr/carteVitale/carteVitaleV1.d.ts → us/usMail/usMailV3.d.ts}

@@ -1,16 +1,16 @@
 import { Inference, StringDict, Page } from "../../../parsing/common";
-import { CarteVitaleV1Document } from "./carteVitaleV1Document";
+import { UsMailV3Document } from "./usMailV3Document";
 /**
- * Carte Vitale API version 1 inference prediction.
+ * US Mail API version 3 inference prediction.
  */
-export declare class CarteVitaleV1 extends Inference {
+export declare class UsMailV3 extends Inference {
     /** The endpoint's name. */
     endpointName: string;
     /** The endpoint's version. */
     endpointVersion: string;
     /** The document-level prediction. */
-    prediction: CarteVitaleV1Document;
+    prediction: UsMailV3Document;
     /** The document's pages. */
-    pages: Page<CarteVitaleV1Document>[];
+    pages: Page<UsMailV3Document>[];
     constructor(rawPrediction: StringDict);
 }

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

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsMailV3 = void 0;
+const common_1 = require("../../../parsing/common");
+const usMailV3Document_1 = require("./usMailV3Document");
+/**
+ * US Mail API version 3 inference prediction.
+ */
+class UsMailV3 extends common_1.Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "us_mail";
+        /** The endpoint's version. */
+        this.endpointVersion = "3";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new usMailV3Document_1.UsMailV3Document(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(usMailV3Document_1.UsMailV3Document, page, page["id"], page["orientation"]));
+            }
+        });
+    }
+}
+exports.UsMailV3 = UsMailV3;

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

@@ -0,0 +1,24 @@
+import { Prediction, StringDict } from "../../../parsing/common";
+import { UsMailV3SenderAddress } from "./usMailV3SenderAddress";
+import { UsMailV3RecipientAddress } from "./usMailV3RecipientAddress";
+import { BooleanField, StringField } from "../../../parsing/standard";
+/**
+ * US Mail API version 3.0 document data.
+ */
+export declare class UsMailV3Document implements Prediction {
+    /** Whether the mailing is marked as return to sender. */
+    isReturnToSender: BooleanField;
+    /** The addresses of the recipients. */
+    recipientAddresses: UsMailV3RecipientAddress[];
+    /** The names of the recipients. */
+    recipientNames: StringField[];
+    /** The address of the sender. */
+    senderAddress: UsMailV3SenderAddress;
+    /** The name of the sender. */
+    senderName: StringField;
+    constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

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

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsMailV3Document = void 0;
+const common_1 = require("../../../parsing/common");
+const usMailV3SenderAddress_1 = require("./usMailV3SenderAddress");
+const usMailV3RecipientAddress_1 = require("./usMailV3RecipientAddress");
+const standard_1 = require("../../../parsing/standard");
+/**
+ * US Mail API version 3.0 document data.
+ */
+class UsMailV3Document {
+    constructor(rawPrediction, pageId) {
+        /** The addresses of the recipients. */
+        this.recipientAddresses = [];
+        /** The names of the recipients. */
+        this.recipientNames = [];
+        this.isReturnToSender = new standard_1.BooleanField({
+            prediction: rawPrediction["is_return_to_sender"],
+            pageId: pageId,
+        });
+        rawPrediction["recipient_addresses"] &&
+            rawPrediction["recipient_addresses"].map((itemPrediction) => this.recipientAddresses.push(new usMailV3RecipientAddress_1.UsMailV3RecipientAddress({
+                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 usMailV3SenderAddress_1.UsMailV3SenderAddress({
+            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, 17];
+            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 += "| Unit            ";
+            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}
+:Return to Sender: ${this.isReturnToSender}`.trimEnd();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.UsMailV3Document = UsMailV3Document;

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

@@ -0,0 +1,42 @@
+import { StringDict } from "../../../parsing/common";
+import { Polygon } from "../../../geometry";
+/**
+ * The addresses of the recipients.
+ */
+export declare class UsMailV3RecipientAddress {
+    #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;
+    /** The unit number of the recipient's address. */
+    unit: 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/usMailV3RecipientAddress.js

@@ -0,0 +1,128 @@
+"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 _UsMailV3RecipientAddress_instances, _UsMailV3RecipientAddress_printableValues;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsMailV3RecipientAddress = void 0;
+const common_1 = require("../../../parsing/common");
+/**
+ * The addresses of the recipients.
+ */
+class UsMailV3RecipientAddress {
+    constructor({ prediction = {} }) {
+        _UsMailV3RecipientAddress_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 = [];
+        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.unit = prediction["unit"];
+        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, _UsMailV3RecipientAddress_instances, "m", _UsMailV3RecipientAddress_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 +
+            ", Unit: " +
+            printable.unit);
+    }
+    /**
+     * Output in a format suitable for inclusion in an rST table.
+     */
+    toTableLine() {
+        const printable = __classPrivateFieldGet(this, _UsMailV3RecipientAddress_instances, "m", _UsMailV3RecipientAddress_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) +
+            " | " +
+            printable.unit.padEnd(15) +
+            " |");
+    }
+}
+exports.UsMailV3RecipientAddress = UsMailV3RecipientAddress;
+_UsMailV3RecipientAddress_instances = new WeakSet(), _UsMailV3RecipientAddress_printableValues = function _UsMailV3RecipientAddress_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) + "..." :
+            "",
+        unit: this.unit ?
+            this.unit.length <= 15 ?
+                (0, common_1.cleanSpecialChars)(this.unit) :
+                (0, common_1.cleanSpecialChars)(this.unit).slice(0, 12) + "..." :
+            "",
+    };
+};

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

@@ -0,0 +1,36 @@
+import { StringDict } from "../../../parsing/common";
+import { Polygon } from "../../../geometry";
+/**
+ * The address of the sender.
+ */
+export declare class UsMailV3SenderAddress {
+    #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;
+}