mindee 4.21.0 → 4.23.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## v4.23.0 - 2025-02-21
+### Changes
+* :sparkles: add support for image & PDF compression
+### Fixes
+* :bug: add missing 'failed' value to jobs
+
+
+## v4.22.0 - 2025-01-14
+### Changes
+* :sparkles: add support for US Mail V3
+* :recycle: increase async retry timers
+
+
 ## v4.21.0 - 2024-12-13
 ### Changes
 * :sparkles: allow local downloading of remote sources

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "4.21.0",
+    "version": "4.23.0",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",
@@ -43,6 +43,7 @@
         "@types/chai": "^4.3.4",
         "@types/mocha": "^10.0.9",
         "@types/node": "^18.15.11",
+        "@types/tmp": "^0.2.6",
         "@typescript-eslint/eslint-plugin": "^8.15.0",
         "@typescript-eslint/parser": "^8.15.0",
         "chai": "^4.3.10",
@@ -55,10 +56,15 @@
         "typescript": "^5.6.3"
     },
     "dependencies": {
+        "canvas": "^3.0.1",
         "commander": "~9.4.1",
         "file-type": "~16.5.4",
         "form-data": "~3.0.1",
-        "pdf-lib": "~1.17.1"
+        "node-poppler": "^7.2.2",
+        "pdf-lib": "^1.17.1",
+        "pdf.js-extract": "^0.2.1",
+        "sharp": "^0.33.5",
+        "tmp": "^0.2.3"
     },
     "keywords": [
         "typescript",

package/src/cli.js

@@ -331,7 +331,7 @@ async function callEnqueueAndParse(productClass, command, inputPath, options) {
             cropper: predictParams.cropper,
             initialDelaySec: 2,
             delaySec: 1.5,
-            maxRetries: 60,
+            maxRetries: 80,
         });
     }
     else {
@@ -341,7 +341,7 @@ async function callEnqueueAndParse(productClass, command, inputPath, options) {
             cropper: predictParams.cropper,
             initialDelaySec: 2,
             delaySec: 1.5,
-            maxRetries: 60,
+            maxRetries: 80,
         });
         if (!response.document) {
             throw Error("Document could not be retrieved");

package/src/client.js

@@ -203,7 +203,7 @@ class Client {
         pageOptions: undefined,
         initialDelaySec: 2,
         delaySec: 1.5,
-        maxRetries: 60,
+        maxRetries: 80,
         initialTimerOptions: undefined,
         recurringTimerOptions: undefined,
     }) {
@@ -339,7 +339,7 @@ _Client_instances = new WeakSet(), _Client_setAsyncParams = function _Client_set
     const newAsyncParams = { ...asyncParams };
     newAsyncParams.delaySec ?? (newAsyncParams.delaySec = 1.5);
     newAsyncParams.initialDelaySec ?? (newAsyncParams.initialDelaySec = 2);
-    newAsyncParams.maxRetries ?? (newAsyncParams.maxRetries = 60);
+    newAsyncParams.maxRetries ?? (newAsyncParams.maxRetries = 80);
     if (newAsyncParams.delaySec < minDelaySec) {
         throw Error(`Cannot set auto-parsing delay to less than ${minDelaySec} second(s).`);
     }

package/src/errors/mindeeError.d.ts

@@ -10,3 +10,9 @@ export declare class MindeeError extends Error {
 export declare class MindeeMimeTypeError extends MindeeError {
     constructor(message: string);
 }
+export declare class MindeeImageError extends MindeeError {
+    constructor(message: string);
+}
+export declare class MindeePdfError extends MindeeError {
+    constructor(message: string);
+}

package/src/errors/mindeeError.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MindeeMimeTypeError = exports.MindeeError = void 0;
+exports.MindeePdfError = exports.MindeeImageError = exports.MindeeMimeTypeError = exports.MindeeError = void 0;
 /**
  * Main Mindee Error custom class.
  */
@@ -21,3 +21,17 @@ class MindeeMimeTypeError extends MindeeError {
     }
 }
 exports.MindeeMimeTypeError = MindeeMimeTypeError;
+class MindeeImageError extends MindeeError {
+    constructor(message) {
+        super(message);
+        this.name = "MindeeImageError";
+    }
+}
+exports.MindeeImageError = MindeeImageError;
+class MindeePdfError extends MindeeError {
+    constructor(message) {
+        super(message);
+        this.name = "MindeePdfError";
+    }
+}
+exports.MindeePdfError = MindeePdfError;

package/src/http/apiSettings.d.ts

@@ -11,6 +11,7 @@ export declare class ApiSettings {
     hostname: string;
     timeout: number;
     constructor({ apiKey, }: MindeeApiConstructorProps);
+    protected getUserAgent(): string;
     protected apiKeyFromEnv(): string;
     protected hostnameFromEnv(): string;
 }

package/src/http/apiSettings.js

@@ -33,7 +33,6 @@ exports.API_HOST_ENVVAR_NAME = "MINDEE_API_HOST";
 exports.STANDARD_API_OWNER = "mindee";
 exports.TIMEOUT_DEFAULT = 120;
 const DEFAULT_MINDEE_API_HOST = "api.mindee.net";
-const USER_AGENT = `mindee-api-nodejs@v${package_json_1.version} nodejs-${process.version} ${os.type().toLowerCase()}`;
 class ApiSettings {
     constructor({ apiKey = "", }) {
         if (!apiKey || apiKey.length === 0) {
@@ -47,12 +46,25 @@ class ApiSettings {
                 + `You can set this using the ${exports.API_KEY_ENVVAR_NAME} environment variable.`);
         }
         this.baseHeaders = {
-            "User-Agent": USER_AGENT,
+            "User-Agent": this.getUserAgent(),
             Authorization: `Token ${this.apiKey}`,
         };
         this.hostname = this.hostnameFromEnv();
         this.timeout = process.env.MINDEE_REQUEST_TIMEOUT ? parseInt(process.env.MINDEE_REQUEST_TIMEOUT) : exports.TIMEOUT_DEFAULT;
     }
+    getUserAgent() {
+        let platform = os.type().toLowerCase();
+        if (platform.includes("darwin")) {
+            platform = "macos";
+        }
+        else if (platform.includes("window")) {
+            platform = "windows";
+        }
+        else if (platform.includes("bsd")) {
+            platform = "bsd";
+        }
+        return `mindee-api-nodejs@v${package_json_1.version} nodejs-${process.version} ${platform}`;
+    }
     apiKeyFromEnv() {
         const envVarValue = process.env[exports.API_KEY_ENVVAR_NAME];
         if (envVarValue) {

package/src/imageOperations/imageCompressor.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Compresses an image with the given parameters.
+ *
+ * @param imageBuffer Buffer representation of an image.
+ * @param quality Quality to apply to the image (JPEG).
+ * @param maxWidth Maximum bound for width.
+ * @param maxHeight Maximum bound for height.
+ */
+export declare function compressImage(imageBuffer: Buffer, quality?: number, maxWidth?: number | null, maxHeight?: number | null): Promise<Buffer>;

package/src/imageOperations/imageCompressor.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compressImage = compressImage;
+const sharp_1 = __importDefault(require("sharp"));
+const mindeeError_1 = require("../errors/mindeeError");
+/**
+ * Compresses an image with the given parameters.
+ *
+ * @param imageBuffer Buffer representation of an image.
+ * @param quality Quality to apply to the image (JPEG).
+ * @param maxWidth Maximum bound for width.
+ * @param maxHeight Maximum bound for height.
+ */
+async function compressImage(imageBuffer, quality = 85, maxWidth = null, maxHeight = null) {
+    let sharpImage = (0, sharp_1.default)(imageBuffer);
+    const metadata = await sharpImage.metadata();
+    if (metadata.width === undefined || metadata.height === undefined) {
+        throw new mindeeError_1.MindeeImageError("Source image has invalid dimensions.");
+    }
+    maxWidth ?? (maxWidth = metadata.width);
+    maxHeight ?? (maxHeight = metadata.height);
+    if (maxWidth || maxHeight) {
+        sharpImage = sharpImage.resize({
+            width: maxWidth,
+            height: maxHeight,
+            fit: "inside",
+            withoutEnlargement: true,
+        });
+    }
+    return await sharpImage
+        .jpeg({ quality: quality })
+        .toBuffer();
+}

package/src/imageOperations/index.d.ts

@@ -1,2 +1,3 @@
 export { extractReceipts, ExtractedMultiReceiptImage } from "./multiReceiptsExtractor";
 export { extractInvoices, ExtractedInvoiceSplitterImage } from "./invoiceSplitterExtractor";
+export { compressImage } from "./imageCompressor";

package/src/imageOperations/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExtractedInvoiceSplitterImage = exports.extractInvoices = exports.ExtractedMultiReceiptImage = exports.extractReceipts = void 0;
+exports.compressImage = exports.ExtractedInvoiceSplitterImage = exports.extractInvoices = exports.ExtractedMultiReceiptImage = exports.extractReceipts = void 0;
 var multiReceiptsExtractor_1 = require("./multiReceiptsExtractor");
 Object.defineProperty(exports, "extractReceipts", { enumerable: true, get: function () { return multiReceiptsExtractor_1.extractReceipts; } });
 Object.defineProperty(exports, "ExtractedMultiReceiptImage", { enumerable: true, get: function () { return multiReceiptsExtractor_1.ExtractedMultiReceiptImage; } });
 var invoiceSplitterExtractor_1 = require("./invoiceSplitterExtractor");
 Object.defineProperty(exports, "extractInvoices", { enumerable: true, get: function () { return invoiceSplitterExtractor_1.extractInvoices; } });
 Object.defineProperty(exports, "ExtractedInvoiceSplitterImage", { enumerable: true, get: function () { return invoiceSplitterExtractor_1.ExtractedInvoiceSplitterImage; } });
+var imageCompressor_1 = require("./imageCompressor");
+Object.defineProperty(exports, "compressImage", { enumerable: true, get: function () { return imageCompressor_1.compressImage; } });

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

@@ -17,4 +17,22 @@ export declare abstract class LocalInputSource extends InputSource {
      * @param pageOptions
      */
     cutPdf(pageOptions: PageOptions): Promise<void>;
+    /**
+     * Compresses the file object, either as a PDF or an image.
+     *
+     * @param quality Quality of the compression. For images, this is the JPEG quality.
+     * For PDFs, this affects image quality within the PDF.
+     * @param maxWidth Maximum width for image resizing. Ignored for PDFs.
+     * @param maxHeight Maximum height for image resizing. Ignored for PDFs.
+     * @param forceSourceText For PDFs, whether to force compression even if source text is present.
+     * @param disableSourceText For PDFs, whether to disable source text during compression.
+     *
+     * @returns A Promise that resolves when the compression is complete.
+     */
+    compress(quality?: number, maxWidth?: number | null, maxHeight?: number | null, forceSourceText?: boolean, disableSourceText?: boolean): Promise<void>;
+    /**
+     * Returns true if the object is a PDF and has source text. False otherwise.
+     * @return boolean
+     */
+    hasSourceText(): Promise<boolean>;
 }

package/src/input/sources/localInputSource.js

@@ -29,9 +29,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LocalInputSource = void 0;
 const handler_1 = require("../../errors/handler");
 const logger_1 = require("../../logger");
+const imageOperations_1 = require("../../imageOperations");
+const pdf_1 = require("../../pdf");
 const path_1 = __importDefault(require("path"));
 const fileType = __importStar(require("file-type"));
-const pdf_1 = require("../../pdf");
+const pdf_2 = require("../../pdf");
 const inputSource_1 = require("./inputSource");
 const MIMETYPES = new Map([
     [".pdf", "application/pdf"],
@@ -103,8 +105,46 @@ class LocalInputSource extends inputSource_1.InputSource {
         if (!(this.fileObject instanceof Buffer)) {
             throw new Error(`Cannot modify an input source of type ${this.inputType}.`);
         }
-        const processedPdf = await (0, pdf_1.extractPages)(this.fileObject, pageOptions);
+        const processedPdf = await (0, pdf_2.extractPages)(this.fileObject, pageOptions);
         this.fileObject = processedPdf.file;
     }
+    /**
+     * Compresses the file object, either as a PDF or an image.
+     *
+     * @param quality Quality of the compression. For images, this is the JPEG quality.
+     * For PDFs, this affects image quality within the PDF.
+     * @param maxWidth Maximum width for image resizing. Ignored for PDFs.
+     * @param maxHeight Maximum height for image resizing. Ignored for PDFs.
+     * @param forceSourceText For PDFs, whether to force compression even if source text is present.
+     * @param disableSourceText For PDFs, whether to disable source text during compression.
+     *
+     * @returns A Promise that resolves when the compression is complete.
+     */
+    async compress(quality = 85, maxWidth = null, maxHeight = null, forceSourceText = false, disableSourceText = true) {
+        let buffer;
+        if (typeof this.fileObject === "string") {
+            buffer = Buffer.from(this.fileObject);
+        }
+        else {
+            buffer = this.fileObject;
+        }
+        if (this.isPdf()) {
+            this.fileObject = await (0, pdf_1.compressPdf)(buffer, quality, forceSourceText, disableSourceText);
+        }
+        else {
+            this.fileObject = await (0, imageOperations_1.compressImage)(buffer, quality, maxWidth, maxHeight);
+        }
+    }
+    /**
+     * Returns true if the object is a PDF and has source text. False otherwise.
+     * @return boolean
+     */
+    async hasSourceText() {
+        if (!this.isPdf()) {
+            return false;
+        }
+        const buffer = typeof this.fileObject === "string" ? Buffer.from(this.fileObject) : this.fileObject;
+        return (0, pdf_2.hasSourceText)(buffer);
+    }
 }
 exports.LocalInputSource = LocalInputSource;

package/src/parsing/common/asyncPredictResponse.d.ts

@@ -17,7 +17,7 @@ export declare class Job {
     /** ID of the job. */
     id: string;
     /** Status of the job. */
-    status?: "waiting" | "processing" | "completed";
+    status?: "waiting" | "processing" | "completed" | "failed";
     /** The time taken to process the job, in milliseconds. */
     milliSecsTaken?: number;
     constructor(jsonResponse: StringDict);

package/src/pdf/index.d.ts

@@ -1 +1,3 @@
 export { extractPages, countPages, SplitPdf } from "./pdfOperation";
+export { compressPdf } from "./pdfCompressor";
+export { hasSourceText } from "./pdfUtils";

package/src/pdf/index.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.countPages = exports.extractPages = void 0;
+exports.hasSourceText = exports.compressPdf = exports.countPages = exports.extractPages = void 0;
 var pdfOperation_1 = require("./pdfOperation");
 Object.defineProperty(exports, "extractPages", { enumerable: true, get: function () { return pdfOperation_1.extractPages; } });
 Object.defineProperty(exports, "countPages", { enumerable: true, get: function () { return pdfOperation_1.countPages; } });
+var pdfCompressor_1 = require("./pdfCompressor");
+Object.defineProperty(exports, "compressPdf", { enumerable: true, get: function () { return pdfCompressor_1.compressPdf; } });
+var pdfUtils_1 = require("./pdfUtils");
+Object.defineProperty(exports, "hasSourceText", { enumerable: true, get: function () { return pdfUtils_1.hasSourceText; } });

package/src/pdf/pdfCompressor.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Compresses each page of a provided PDF buffer.
+ * @param pdfData The input PDF as a Buffer.
+ * @param imageQuality Compression quality (70-100 for most JPG images).
+ * @param forceSourceTextCompression If true, attempts to re-write detected text.
+ * @param disableSourceText If true, doesn't re-apply source text to the output PDF.
+ * @returns A Promise resolving to the compressed PDF as a Buffer.
+ */
+export declare function compressPdf(pdfData: Buffer, imageQuality?: number, forceSourceTextCompression?: boolean, disableSourceText?: boolean): Promise<Buffer>;

package/src/pdf/pdfCompressor.js

@@ -0,0 +1,247 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compressPdf = compressPdf;
+const logger_1 = require("../logger");
+const tmp_1 = __importDefault(require("tmp"));
+const pdfUtils_1 = require("./pdfUtils");
+const fs = __importStar(require("node:fs"));
+const node_poppler_1 = require("node-poppler");
+const pdf_lib_1 = require("pdf-lib");
+const imageOperations_1 = require("../imageOperations");
+/**
+ * Compresses each page of a provided PDF buffer.
+ * @param pdfData The input PDF as a Buffer.
+ * @param imageQuality Compression quality (70-100 for most JPG images).
+ * @param forceSourceTextCompression If true, attempts to re-write detected text.
+ * @param disableSourceText If true, doesn't re-apply source text to the output PDF.
+ * @returns A Promise resolving to the compressed PDF as a Buffer.
+ */
+async function compressPdf(pdfData, imageQuality = 85, forceSourceTextCompression = false, disableSourceText = true) {
+    handleCompressionWarnings(forceSourceTextCompression, disableSourceText);
+    if (await (0, pdfUtils_1.hasSourceText)(pdfData)) {
+        if (forceSourceTextCompression) {
+            if (!disableSourceText) {
+                logger_1.logger.warn("Re-writing PDF source-text is an EXPERIMENTAL feature.");
+            }
+            else {
+                logger_1.logger.warn("Source file contains text, but disable_source_text flag. " +
+                    "is set to false. Resulting file will not contain any embedded text.");
+            }
+        }
+        else {
+            logger_1.logger.warn("Found text inside of the provided PDF file. Compression operation aborted since disableSourceText "
+                + "is set to 'true'.");
+            return pdfData;
+        }
+    }
+    const extractedText = disableSourceText ? await (0, pdfUtils_1.extractTextFromPdf)(pdfData) : null;
+    const extractedPdfInfo = await (0, pdfUtils_1.extractTextFromPdf)(pdfData);
+    const compressedPages = await compressPdfPages(pdfData, extractedPdfInfo, imageQuality, disableSourceText, extractedText);
+    if (!compressedPages) {
+        logger_1.logger.warn("Could not compress PDF to a smaller size. Returning original PDF.");
+        return pdfData;
+    }
+    return createNewPdfFromCompressedPages(compressedPages);
+}
+/**
+ * Handles compression warnings based on the provided parameters.
+ * @param forceSourceTextCompression If true, attempts to re-write detected text.
+ * @param disableSourceText If true, doesn't re-apply source text to the output PDF.
+ */
+function handleCompressionWarnings(forceSourceTextCompression, disableSourceText) {
+    if (forceSourceTextCompression) {
+        if (!disableSourceText) {
+            logger_1.logger.warn("Re-writing PDF source-text is an EXPERIMENTAL feature.");
+        }
+        else {
+            logger_1.logger.warn("Source file contains text, but the disable_source_text is set to false. "
+                + "Resulting file will not contain any embedded text.");
+        }
+    }
+}
+/**
+ * Compresses PDF pages and returns an array of compressed page buffers.
+ * @param pdfData The input PDF as a Buffer.
+ * @param extractedPdfInfo Extracted PDF information.
+ * @param imageQuality Initial compression quality.
+ * @param disableSourceText If true, doesn't re-apply source text to the output PDF.
+ * @param extractedText Extracted text from the PDF.
+ * @returns A Promise resolving to an array of compressed page buffers, or null if compression fails.
+ */
+async function compressPdfPages(pdfData, extractedPdfInfo, imageQuality, disableSourceText, extractedText) {
+    const originalSize = pdfData.length;
+    const MIN_QUALITY = 1;
+    let imageQualityLoop = imageQuality;
+    while (imageQualityLoop >= MIN_QUALITY) {
+        const compressedPages = await compressPagesWithQuality(pdfData, extractedPdfInfo, imageQualityLoop, disableSourceText, extractedText);
+        const totalCompressedSize = calculateTotalCompressedSize(compressedPages);
+        if (isCompressionSuccessful(totalCompressedSize, originalSize, imageQuality)) {
+            return compressedPages;
+        }
+        imageQualityLoop -= Math.round(lerp(1, 10, imageQualityLoop / 100));
+    }
+    return null;
+}
+/**
+ * Compresses pages with a specific quality.
+ * @param pdfData The input PDF as a Buffer.
+ * @param extractedPdfInfo Extracted PDF information.
+ * @param imageQuality Compression quality.
+ * @param disableSourceText If true, doesn't re-apply source text to the output PDF.
+ * @param extractedText Extracted text from the PDF.
+ * @returns A Promise resolving to an array of compressed page buffers.
+ */
+async function compressPagesWithQuality(pdfData, extractedPdfInfo, imageQuality, disableSourceText, extractedText) {
+    const pdfDoc = await pdf_lib_1.PDFDocument.load(pdfData);
+    const compressedPages = [];
+    for (let i = 0; i < extractedPdfInfo.pages.length; i++) {
+        const page = pdfDoc.getPages()[i];
+        const rasterizedPage = await rasterizePage(pdfData, i + 1, imageQuality);
+        const compressedImage = await (0, imageOperations_1.compressImage)(Buffer.from(rasterizedPage, "binary"), imageQuality);
+        if (!disableSourceText) {
+            await addTextToPdfPage(page, extractedText);
+        }
+        compressedPages.push(compressedImage);
+    }
+    return compressedPages;
+}
+/**
+ * Calculates the total size of compressed pages.
+ * @param compressedPages Array of compressed page buffers.
+ * @returns The total size of compressed pages.
+ */
+function calculateTotalCompressedSize(compressedPages) {
+    return compressedPages.reduce((sum, page) => sum + page.length, 0);
+}
+/**
+ * Checks if the compression was successful based on the compressed size and original size.
+ * Note: Not quite sure how or why the rasterization quality ratio is correlated with the overhead generated by the
+ * image's inclusion into the pdf data, but this makes the following lerp() necessary if we want consistency during
+ * compression.
+ *
+ * @param totalCompressedSize Total size of compressed pages.
+ * @param originalSize Original PDF size.
+ * @param imageQuality Compression quality.
+ * @returns True if compression was successful, false otherwise.
+ */
+function isCompressionSuccessful(totalCompressedSize, originalSize, imageQuality) {
+    const overhead = lerp(0.54, 0.18, imageQuality / 100);
+    return totalCompressedSize + totalCompressedSize * overhead < originalSize;
+}
+/**
+ * Creates a new PDF document from compressed page buffers.
+ * @param compressedPages Array of compressed page buffers.
+ * @returns A Promise resolving to the new PDF as a Buffer.
+ */
+async function createNewPdfFromCompressedPages(compressedPages) {
+    const newPdfDoc = await pdf_lib_1.PDFDocument.create();
+    for (const compressedPage of compressedPages) {
+        const image = await newPdfDoc.embedJpg(compressedPage);
+        const newPage = newPdfDoc.addPage([image.width, image.height]);
+        newPage.drawImage(image, {
+            x: 0,
+            y: 0,
+            width: image.width,
+            height: image.height,
+        });
+    }
+    const compressedPdfBytes = await newPdfDoc.save();
+    return Buffer.from(compressedPdfBytes);
+}
+async function addTextToPdfPage(page, textInfo) {
+    if (textInfo === null) {
+        return;
+    }
+    for (const textPages of textInfo.pages) {
+        for (const textPage of textPages.content) {
+            page.drawText(textPage.str, {
+                x: textPage.x,
+                y: textPage.y,
+                size: textPage.height,
+                color: (0, pdf_lib_1.rgb)(0, 0, 0),
+                font: await getFontFromName(textPage.fontName)
+            });
+        }
+    }
+}
+async function getFontFromName(fontName) {
+    const pdfDoc = await pdf_lib_1.PDFDocument.create();
+    let font;
+    if (Object.values(pdf_lib_1.StandardFonts).map(value => value.toString()).includes(fontName)) {
+        font = await pdfDoc.embedFont(fontName);
+    }
+    else {
+        font = await pdfDoc.embedFont(pdf_lib_1.StandardFonts.Helvetica);
+    }
+    return font;
+}
+/**
+ * Rasterizes a PDF page.
+ *
+ * @param pdfData Buffer representation of the entire PDF file.
+ * @param index Index of the page to rasterize.
+ * @param quality Quality to apply during rasterization.
+ */
+async function rasterizePage(pdfData, index, quality = 85) {
+    const poppler = new node_poppler_1.Poppler();
+    const tmpPdf = tmp_1.default.fileSync();
+    const tempPdfPath = tmpPdf.name;
+    const antialiasOption = "best";
+    try {
+        await fs.promises.writeFile(tempPdfPath, pdfData);
+        const options = {
+            antialias: antialiasOption,
+            firstPageToConvert: index,
+            lastPageToConvert: index,
+            jpegFile: true,
+            jpegOptions: `quality=${quality}`,
+            singleFile: true
+        };
+        const jpegBuffer = await poppler.pdfToCairo(tempPdfPath, undefined, options);
+        await fs.promises.unlink(tempPdfPath);
+        return jpegBuffer;
+    }
+    catch (error) {
+        console.error("Error rasterizing PDF:", error);
+        throw error;
+    }
+    finally {
+        tmpPdf.removeCallback();
+    }
+}
+/**
+ * Performs linear interpolation between two numbers.
+ * @param start The starting value.
+ * @param end The ending value.
+ * @param t The interpolation factor (0 to 1).
+ * @returns The interpolated value.
+ */
+function lerp(start, end, t) {
+    return start * (1 - t) + end * t;
+}

package/src/pdf/pdfUtils.d.ts

@@ -0,0 +1,30 @@
+export interface PageTextInfo {
+    pageNumber: number;
+    content: Array<{
+        str: string;
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        fontName: string;
+    }>;
+}
+export interface ExtractedPdfInfo {
+    pages: PageTextInfo[];
+    getConcatenatedText: () => string;
+}
+/**
+ * Extracts text from a full PDF document.
+ *
+ * @returns A Promise containing the extracted text as a string.
+ * @param pdfBuffer PDF handle, as a buffer.
+ */
+export declare function extractTextFromPdf(pdfBuffer: Buffer): Promise<ExtractedPdfInfo>;
+/**
+ * Checks if a PDF contains source text.
+ *
+ * @param pdfData Buffer representing the content of the PDF file.
+ *
+ * @returns A Promise containing a boolean indicating if the PDF has source text.
+ */
+export declare function hasSourceText(pdfData: Buffer): Promise<boolean>;

package/src/pdf/pdfUtils.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractTextFromPdf = extractTextFromPdf;
+exports.hasSourceText = hasSourceText;
+const pdf_js_extract_1 = require("pdf.js-extract");
+const mindeeError_1 = require("../errors/mindeeError");
+function getConcatenatedText(pages) {
+    return pages.flatMap(page => page.content.map(item => item.str)).join(" ");
+}
+/**
+ * Extracts text from a full PDF document.
+ *
+ * @returns A Promise containing the extracted text as a string.
+ * @param pdfBuffer PDF handle, as a buffer.
+ */
+async function extractTextFromPdf(pdfBuffer) {
+    const pdfExtract = new pdf_js_extract_1.PDFExtract();
+    const options = {};
+    const pdf = await new Promise((resolve, reject) => {
+        pdfExtract.extractBuffer(pdfBuffer, options, (err, result) => {
+            if (err)
+                reject(err);
+            if (result === undefined)
+                reject(new mindeeError_1.MindeePdfError("Couldn't process result."));
+            else
+                resolve(result);
+        });
+    });
+    const pages = pdf.pages.map((page, index) => ({
+        pageNumber: index + 1,
+        content: page.content.map(item => ({
+            str: item.str,
+            x: item.x,
+            y: item.y,
+            width: item.width,
+            height: item.height,
+            fontName: item.fontName,
+        })),
+    }));
+    return {
+        pages,
+        getConcatenatedText: () => getConcatenatedText(pages),
+    };
+}
+/**
+ * Checks if a PDF contains source text.
+ *
+ * @param pdfData Buffer representing the content of the PDF file.
+ *
+ * @returns A Promise containing a boolean indicating if the PDF has source text.
+ */
+async function hasSourceText(pdfData) {
+    const text = await extractTextFromPdf(pdfData);
+    return text.getConcatenatedText().trim().length > 0;
+}

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/us/usMail/usMailV3.d.ts

@@ -0,0 +1,16 @@
+import { Inference, StringDict, Page } from "../../../parsing/common";
+import { UsMailV3Document } from "./usMailV3Document";
+/**
+ * US Mail API version 3 inference prediction.
+ */
+export declare class UsMailV3 extends Inference {
+    /** The endpoint's name. */
+    endpointName: string;
+    /** The endpoint's version. */
+    endpointVersion: string;
+    /** The document-level prediction. */
+    prediction: UsMailV3Document;
+    /** The document's pages. */
+    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;
+}

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

@@ -0,0 +1,72 @@
+"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 _UsMailV3SenderAddress_instances, _UsMailV3SenderAddress_printableValues;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsMailV3SenderAddress = void 0;
+/**
+ * The address of the sender.
+ */
+class UsMailV3SenderAddress {
+    constructor({ prediction = {} }) {
+        _UsMailV3SenderAddress_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.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, _UsMailV3SenderAddress_instances, "m", _UsMailV3SenderAddress_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, _UsMailV3SenderAddress_instances, "m", _UsMailV3SenderAddress_printableValues).call(this);
+        return `
+  :City: ${printable.city}
+  :Complete Address: ${printable.complete}
+  :Postal Code: ${printable.postalCode}
+  :State: ${printable.state}
+  :Street: ${printable.street}`.trimEnd();
+    }
+}
+exports.UsMailV3SenderAddress = UsMailV3SenderAddress;
+_UsMailV3SenderAddress_instances = new WeakSet(), _UsMailV3SenderAddress_printableValues = function _UsMailV3SenderAddress_printableValues() {
+    return {
+        city: this.city ?? "",
+        complete: this.complete ?? "",
+        postalCode: this.postalCode ?? "",
+        state: this.state ?? "",
+        street: this.street ?? "",
+    };
+};