mindee 4.11.0 → 4.13.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # CHANGELOG
 
+## v4.13.0 - 2024-05-28
+### Changes
+* :sparkles: add support for local response loading
+* :sparkles: add support for HMAC validation for webhooks
+* :sparkles: add support for US Mail V2
+* :sparkles: add support for boolean fields
+
+### Fixes
+* :recycle: fixed Locale display
+
+
+## v4.12.0 - 2024-05-16
+### Changes
+* :sparkles: update receipt to 5.2 and financial document to 1.7 (#270)
+
+
 # v4.11.0 - 2024-04-30
 ### Changes
 * :sparkles: update invoice to 4.6 & financial document to 1.6 (#269)

package/package.json

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

package/src/client.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
 import { Readable } from "stream";
-import { Base64Input, BytesInput, InputSource, PathInput, StreamInput, PageOptions, UrlInput, BufferInput } from "./input";
+import { Base64Input, BytesInput, InputSource, PathInput, StreamInput, PageOptions, UrlInput, BufferInput, LocalResponse } from "./input";
 import { Endpoint } from "./http";
 import { AsyncPredictResponse, FeedbackResponse, Inference, PredictResponse, StringDict } from "./parsing/common";
 /**
@@ -111,6 +111,7 @@ export declare class Client {
      * parsing is complete.
      */
     parseQueued<T extends Inference>(productClass: new (httpResponse: StringDict) => T, queueId: string, params?: PredictOptions): Promise<AsyncPredictResponse<T>>;
+    loadPrediction<T extends Inference>(productClass: new (httpResponse: StringDict) => T, localResponse: LocalResponse): Promise<AsyncPredictResponse<T> | PredictResponse<T>>;
     /**
      * Fetch prediction results from a document already processed.
      *

package/src/client.js

@@ -15,6 +15,7 @@ const logger_1 = require("./logger");
 const inference_1 = require("./parsing/common/inference");
 const product_1 = require("./product");
 const promises_1 = require("node:timers/promises");
+const errors_1 = require("./errors");
 /**
  * Mindee Client class that centralizes most basic operations.
  *
@@ -103,6 +104,25 @@ class Client {
         const docResponse = await endpoint.getQueuedDocument(queueId);
         return new common_1.AsyncPredictResponse(productClass, docResponse.data);
     }
+    async loadPrediction(productClass, localResponse) {
+        /**
+         * Load a prediction.
+         *
+         * @param productClass Product class to use for calling  the API and parsing the response.
+         * @param localResponse Local response to load.
+         * @category Asynchronous
+         * @returns A valid prediction
+         */
+        try {
+            if (Object.prototype.hasOwnProperty.call(localResponse.asDict(), "job")) {
+                return new common_1.AsyncPredictResponse(productClass, localResponse.asDict());
+            }
+            return new common_1.PredictResponse(productClass, localResponse.asDict());
+        }
+        catch (err) {
+            throw new errors_1.MindeeError("No prediction found in local response.");
+        }
+    }
     /**
      * Fetch prediction results from a document already processed.
      *

package/src/index.d.ts

@@ -1,6 +1,6 @@
 export * as product from "./product";
 export { Client, PredictOptions } from "./client";
 export { AsyncPredictResponse, PredictResponse, Inference, Prediction, Document, Page, } from "./parsing/common";
-export { InputSource, PageOptionsOperation } from "./input";
+export { InputSource, PageOptionsOperation, LocalResponse } from "./input";
 export * as internal from "./internal";
 export * as imageOperations from "./imageOperations";

package/src/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.imageOperations = exports.internal = exports.PageOptionsOperation = exports.InputSource = exports.Page = exports.Document = exports.Prediction = exports.Inference = exports.PredictResponse = exports.AsyncPredictResponse = exports.Client = exports.product = void 0;
+exports.imageOperations = exports.internal = exports.LocalResponse = exports.PageOptionsOperation = exports.InputSource = exports.Page = exports.Document = exports.Prediction = exports.Inference = exports.PredictResponse = exports.AsyncPredictResponse = exports.Client = exports.product = void 0;
 exports.product = __importStar(require("./product"));
 var client_1 = require("./client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_1.Client; } });
@@ -37,5 +37,6 @@ Object.defineProperty(exports, "Page", { enumerable: true, get: function () { re
 var input_1 = require("./input");
 Object.defineProperty(exports, "InputSource", { enumerable: true, get: function () { return input_1.InputSource; } });
 Object.defineProperty(exports, "PageOptionsOperation", { enumerable: true, get: function () { return input_1.PageOptionsOperation; } });
+Object.defineProperty(exports, "LocalResponse", { enumerable: true, get: function () { return input_1.LocalResponse; } });
 exports.internal = __importStar(require("./internal"));
 exports.imageOperations = __importStar(require("./imageOperations"));

package/src/input/index.d.ts

@@ -1,3 +1,4 @@
 export { PageOptions, PageOptionsOperation } from "./pageOptions";
 export { Base64Input, BytesInput, PathInput, StreamInput, UrlInput, BufferInput, } from "./sources";
 export { InputSource, INPUT_TYPE_BASE64, INPUT_TYPE_BYTES, INPUT_TYPE_PATH, INPUT_TYPE_STREAM, INPUT_TYPE_BUFFER, } from "./base";
+export { LocalResponse } from "./localResponse";

package/src/input/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.INPUT_TYPE_BUFFER = exports.INPUT_TYPE_STREAM = exports.INPUT_TYPE_PATH = exports.INPUT_TYPE_BYTES = exports.INPUT_TYPE_BASE64 = exports.InputSource = exports.BufferInput = exports.UrlInput = exports.StreamInput = exports.PathInput = exports.BytesInput = exports.Base64Input = exports.PageOptionsOperation = void 0;
+exports.LocalResponse = exports.INPUT_TYPE_BUFFER = exports.INPUT_TYPE_STREAM = exports.INPUT_TYPE_PATH = exports.INPUT_TYPE_BYTES = exports.INPUT_TYPE_BASE64 = exports.InputSource = exports.BufferInput = exports.UrlInput = exports.StreamInput = exports.PathInput = exports.BytesInput = exports.Base64Input = exports.PageOptionsOperation = void 0;
 var pageOptions_1 = require("./pageOptions");
 Object.defineProperty(exports, "PageOptionsOperation", { enumerable: true, get: function () { return pageOptions_1.PageOptionsOperation; } });
 var sources_1 = require("./sources");
@@ -17,3 +17,5 @@ Object.defineProperty(exports, "INPUT_TYPE_BYTES", { enumerable: true, get: func
 Object.defineProperty(exports, "INPUT_TYPE_PATH", { enumerable: true, get: function () { return base_1.INPUT_TYPE_PATH; } });
 Object.defineProperty(exports, "INPUT_TYPE_STREAM", { enumerable: true, get: function () { return base_1.INPUT_TYPE_STREAM; } });
 Object.defineProperty(exports, "INPUT_TYPE_BUFFER", { enumerable: true, get: function () { return base_1.INPUT_TYPE_BUFFER; } });
+var localResponse_1 = require("./localResponse");
+Object.defineProperty(exports, "LocalResponse", { enumerable: true, get: function () { return localResponse_1.LocalResponse; } });

package/src/input/localResponse.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="node" />
+import { StringDict } from "../parsing/common";
+import { Buffer } from "buffer";
+/**
+ * Local response loaded from a file.
+ */
+export declare class LocalResponse {
+    private file;
+    private readonly inputHandle;
+    /**
+     * Creates an instance of LocalResponse.
+     */
+    constructor(inputFile: Buffer | string);
+    init(): Promise<void>;
+    /**
+     * Returns the dictionary representation of the file.
+     * @returns A JSON-like object.
+     */
+    asDict(): StringDict;
+    /**
+     * Returns the HMAC signature of the local response, from the secret key provided.
+     * @param secretKey - Secret key, either a string or a byte/byte array.
+     * @returns The HMAC signature of the local response.
+     */
+    getHmacSignature(secretKey: string | Buffer | Uint8Array): string;
+    /**
+     * Checks if the HMAC signature of the local response is valid.
+     * @param secretKey - Secret key, either a string or a byte/byte array.
+     * @param signature - The signature to be compared with.
+     * @returns True if the HMAC signature is valid.
+     */
+    isValidHmacSignature(secretKey: string | Buffer | Uint8Array, signature: string): boolean;
+}

package/src/input/localResponse.js

@@ -0,0 +1,103 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalResponse = void 0;
+const crypto = __importStar(require("crypto"));
+const fs = __importStar(require("node:fs/promises"));
+const errors_1 = require("../errors");
+const buffer_1 = require("buffer");
+/**
+ * Local response loaded from a file.
+ */
+class LocalResponse {
+    /**
+     * Creates an instance of LocalResponse.
+     */
+    constructor(inputFile) {
+        this.file = buffer_1.Buffer.alloc(0);
+        this.inputHandle = inputFile;
+    }
+    async init() {
+        /**
+         * @param inputFile - The input file, which can be a Buffer, string, or PathLike.
+         */
+        if (buffer_1.Buffer.isBuffer(this.inputHandle)) {
+            this.file = this.inputHandle;
+        }
+        else if (typeof this.inputHandle === "string") {
+            let fileContents;
+            try {
+                await fs.access(this.inputHandle);
+                fileContents = await fs.readFile(this.inputHandle, { encoding: "utf-8" });
+            }
+            catch {
+                fileContents = this.inputHandle;
+            }
+            this.file = buffer_1.Buffer.from(fileContents.replace(/\r/g, "").replace(/\n/g, ""), "utf-8");
+        }
+        else {
+            throw new errors_1.MindeeError("Incompatible type for input.");
+        }
+    }
+    /**
+     * Returns the dictionary representation of the file.
+     * @returns A JSON-like object.
+     */
+    asDict() {
+        try {
+            const content = this.file.toString("utf-8");
+            return JSON.parse(content);
+        }
+        catch (error) {
+            throw new errors_1.MindeeError("File is not a valid dictionary.");
+        }
+    }
+    /**
+     * Returns the HMAC signature of the local response, from the secret key provided.
+     * @param secretKey - Secret key, either a string or a byte/byte array.
+     * @returns The HMAC signature of the local response.
+     */
+    getHmacSignature(secretKey) {
+        const algorithm = "sha256";
+        try {
+            const hmac = crypto.createHmac(algorithm, secretKey);
+            hmac.update(this.file);
+            return hmac.digest("hex");
+        }
+        catch (error) {
+            throw new errors_1.MindeeError("Could not get HMAC signature from payload.");
+        }
+    }
+    /**
+     * Checks if the HMAC signature of the local response is valid.
+     * @param secretKey - Secret key, either a string or a byte/byte array.
+     * @param signature - The signature to be compared with.
+     * @returns True if the HMAC signature is valid.
+     */
+    isValidHmacSignature(secretKey, signature) {
+        return signature === this.getHmacSignature(secretKey);
+    }
+}
+exports.LocalResponse = LocalResponse;

package/src/parsing/standard/base.d.ts

@@ -16,7 +16,7 @@ export interface BaseFieldConstructor {
  */
 export declare class BaseField {
     /** The value. */
-    value?: string | number;
+    value?: string | number | boolean;
     /** `true` when the field was reconstructed or computed using other fields. */
     reconstructed: boolean;
     /** Page ID for multi-page document. */

package/src/parsing/standard/boolean.d.ts

@@ -0,0 +1,17 @@
+import { StringDict } from "../common";
+import { Field } from "./field";
+export interface FieldConstructor {
+    prediction: StringDict;
+    valueKey?: string;
+    reconstructed?: boolean;
+    pageId?: number | undefined;
+}
+/**
+ * A field containing a text value.
+ */
+export declare class BooleanField extends Field {
+    /** The value. */
+    value?: boolean;
+    constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
+    toString(): string;
+}

package/src/parsing/standard/boolean.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BooleanField = void 0;
+const field_1 = require("./field");
+/**
+ * A field containing a text value.
+ */
+class BooleanField extends field_1.Field {
+    constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId, }) {
+        super({ prediction, valueKey, reconstructed, pageId });
+    }
+    toString() {
+        if (this.value === true) {
+            return "True";
+        }
+        else if (this.value === false) {
+            return "False";
+        }
+        return "";
+    }
+}
+exports.BooleanField = BooleanField;

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

@@ -1,6 +1,7 @@
 export { ClassificationField } from "./classification";
 export { Taxes, TaxField } from "./tax";
 export { PaymentDetailsField } from "./paymentDetails";
+export { BooleanField } from "./boolean";
 export { LocaleField } from "./locale";
 export { AmountField, floatToString } from "./amount";
 export { DateField } from "./date";

package/src/parsing/standard/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Field = exports.StringField = exports.PositionField = exports.CompanyRegistrationField = exports.BaseField = exports.DateField = exports.floatToString = exports.AmountField = exports.LocaleField = exports.PaymentDetailsField = exports.TaxField = exports.Taxes = exports.ClassificationField = void 0;
+exports.Field = exports.StringField = exports.PositionField = exports.CompanyRegistrationField = exports.BaseField = exports.DateField = exports.floatToString = exports.AmountField = exports.LocaleField = exports.BooleanField = exports.PaymentDetailsField = exports.TaxField = exports.Taxes = exports.ClassificationField = void 0;
 var classification_1 = require("./classification");
 Object.defineProperty(exports, "ClassificationField", { enumerable: true, get: function () { return classification_1.ClassificationField; } });
 var tax_1 = require("./tax");
@@ -8,6 +8,8 @@ Object.defineProperty(exports, "Taxes", { enumerable: true, get: function () { r
 Object.defineProperty(exports, "TaxField", { enumerable: true, get: function () { return tax_1.TaxField; } });
 var paymentDetails_1 = require("./paymentDetails");
 Object.defineProperty(exports, "PaymentDetailsField", { enumerable: true, get: function () { return paymentDetails_1.PaymentDetailsField; } });
+var boolean_1 = require("./boolean");
+Object.defineProperty(exports, "BooleanField", { enumerable: true, get: function () { return boolean_1.BooleanField; } });
 var locale_1 = require("./locale");
 Object.defineProperty(exports, "LocaleField", { enumerable: true, get: function () { return locale_1.LocaleField; } });
 var amount_1 = require("./amount");

package/src/parsing/standard/locale.js

@@ -10,7 +10,7 @@ class LocaleField extends base_1.BaseField {
      * @param {BaseFieldConstructor} constructor Constructor parameters.
      */
     constructor({ prediction = {}, reconstructed = false, pageId = undefined, }) {
-        const valueKey = prediction["value"] !== undefined ? "value" : "language";
+        const valueKey = prediction["value"] ? "value" : "language";
         super({ prediction, valueKey, reconstructed, pageId });
         this.confidence = prediction["confidence"] ? prediction["confidence"] : 0.0;
         this.language =

package/src/product/financialDocument/financialDocumentV1Document.d.ts

@@ -2,7 +2,7 @@ import { Prediction, StringDict } from "../../parsing/common";
 import { FinancialDocumentV1LineItem } from "./financialDocumentV1LineItem";
 import { AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, PaymentDetailsField, StringField, Taxes } from "../../parsing/standard";
 /**
- * Financial Document API version 1.6 document data.
+ * Financial Document API version 1.7 document data.
  */
 export declare class FinancialDocumentV1Document implements Prediction {
     /** The customer's address used for billing. */
@@ -19,16 +19,20 @@ export declare class FinancialDocumentV1Document implements Prediction {
     customerName: StringField;
     /** The date the purchase was made. */
     date: DateField;
+    /** The document number or identifier. */
+    documentNumber: StringField;
     /** One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'. */
     documentType: ClassificationField;
     /** The date on which the payment is due. */
     dueDate: DateField;
-    /** The invoice number or identifier. */
+    /** The invoice number or identifier only if document is an invoice. */
     invoiceNumber: StringField;
     /** List of line item details. */
     lineItems: FinancialDocumentV1LineItem[];
     /** The locale detected on the document. */
     locale: LocaleField;
+    /** The receipt number or identifier only if document is a receipt. */
+    receiptNumber: StringField;
     /** List of Reference numbers, including PO number. */
     referenceNumbers: StringField[];
     /** The customer's address used for shipping. */

package/src/product/financialDocument/financialDocumentV1Document.js

@@ -5,7 +5,7 @@ const common_1 = require("../../parsing/common");
 const financialDocumentV1LineItem_1 = require("./financialDocumentV1LineItem");
 const standard_1 = require("../../parsing/standard");
 /**
- * Financial Document API version 1.6 document data.
+ * Financial Document API version 1.7 document data.
  */
 class FinancialDocumentV1Document {
     constructor(rawPrediction, pageId) {
@@ -47,6 +47,10 @@ class FinancialDocumentV1Document {
             prediction: rawPrediction["date"],
             pageId: pageId,
         });
+        this.documentNumber = new standard_1.StringField({
+            prediction: rawPrediction["document_number"],
+            pageId: pageId,
+        });
         this.documentType = new standard_1.ClassificationField({
             prediction: rawPrediction["document_type"],
         });
@@ -66,6 +70,10 @@ class FinancialDocumentV1Document {
         this.locale = new standard_1.LocaleField({
             prediction: rawPrediction["locale"],
         });
+        this.receiptNumber = new standard_1.StringField({
+            prediction: rawPrediction["receipt_number"],
+            pageId: pageId,
+        });
         rawPrediction["reference_numbers"] &&
             rawPrediction["reference_numbers"].map((itemPrediction) => this.referenceNumbers.push(new standard_1.StringField({
                 prediction: itemPrediction,
@@ -154,6 +162,8 @@ class FinancialDocumentV1Document {
         }
         const outStr = `:Locale: ${this.locale}
 :Invoice Number: ${this.invoiceNumber}
+:Receipt Number: ${this.receiptNumber}
+:Document Number: ${this.documentNumber}
 :Reference Numbers: ${referenceNumbers}
 :Purchase Date: ${this.date}
 :Due Date: ${this.dueDate}

package/src/product/receipt/receiptV5Document.d.ts

@@ -2,7 +2,7 @@ import { Prediction, StringDict } from "../../parsing/common";
 import { ReceiptV5LineItem } from "./receiptV5LineItem";
 import { AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, StringField, Taxes } from "../../parsing/standard";
 /**
- * Receipt API version 5.1 document data.
+ * Receipt API version 5.2 document data.
  */
 export declare class ReceiptV5Document implements Prediction {
     /** The purchase category among predefined classes. */
@@ -15,6 +15,8 @@ export declare class ReceiptV5Document implements Prediction {
     lineItems: ReceiptV5LineItem[];
     /** The locale detected on the document. */
     locale: LocaleField;
+    /** The receipt number or identifier. */
+    receiptNumber: StringField;
     /** The purchase subcategory among predefined classes for transport and food. */
     subcategory: ClassificationField;
     /** The address of the supplier or merchant. */

package/src/product/receipt/receiptV5Document.js

@@ -5,7 +5,7 @@ const common_1 = require("../../parsing/common");
 const receiptV5LineItem_1 = require("./receiptV5LineItem");
 const standard_1 = require("../../parsing/standard");
 /**
- * Receipt API version 5.1 document data.
+ * Receipt API version 5.2 document data.
  */
 class ReceiptV5Document {
     constructor(rawPrediction, pageId) {
@@ -31,6 +31,10 @@ class ReceiptV5Document {
         this.locale = new standard_1.LocaleField({
             prediction: rawPrediction["locale"],
         });
+        this.receiptNumber = new standard_1.StringField({
+            prediction: rawPrediction["receipt_number"],
+            pageId: pageId,
+        });
         this.subcategory = new standard_1.ClassificationField({
             prediction: rawPrediction["subcategory"],
         });
@@ -104,6 +108,7 @@ class ReceiptV5Document {
 :Supplier Company Registrations: ${supplierCompanyRegistrations}
 :Supplier Address: ${this.supplierAddress}
 :Supplier Phone Number: ${this.supplierPhoneNumber}
+:Receipt Number: ${this.receiptNumber}
 :Line Items: ${lineItemsSummary}`.trimEnd();
         return (0, common_1.cleanOutString)(outStr);
     }

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

@@ -1,3 +1,4 @@
 export { BankCheckV1 } from "./bankCheck/bankCheckV1";
 export { DriverLicenseV1 } from "./driverLicense/driverLicenseV1";
 export { W9V1 } from "./w9/w9V1";
+export { UsMailV2 } from "./usMail/usMailV2";

package/src/product/us/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.W9V1 = exports.DriverLicenseV1 = exports.BankCheckV1 = void 0;
+exports.UsMailV2 = exports.W9V1 = 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");
 Object.defineProperty(exports, "DriverLicenseV1", { enumerable: true, get: function () { return driverLicenseV1_1.DriverLicenseV1; } });
 var w9V1_1 = require("./w9/w9V1");
 Object.defineProperty(exports, "W9V1", { enumerable: true, get: function () { return w9V1_1.W9V1; } });
+var usMailV2_1 = require("./usMail/usMailV2");
+Object.defineProperty(exports, "UsMailV2", { enumerable: true, get: function () { return usMailV2_1.UsMailV2; } });

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

@@ -1,2 +1,4 @@
 export * as bankCheck from "./bankCheck/internal";
 export * as driverLicense from "./driverLicense/internal";
+export * as usMail from "./usMail/internal";
+export * as w9 from "./w9/internal";

package/src/product/us/internal.js

@@ -23,6 +23,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.driverLicense = exports.bankCheck = void 0;
+exports.w9 = exports.usMail = exports.driverLicense = exports.bankCheck = void 0;
 exports.bankCheck = __importStar(require("./bankCheck/internal"));
 exports.driverLicense = __importStar(require("./driverLicense/internal"));
+exports.usMail = __importStar(require("./usMail/internal"));
+exports.w9 = __importStar(require("./w9/internal"));

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

@@ -0,0 +1,4 @@
+export { UsMailV2 } from "./usMailV2";
+export { UsMailV2Document } from "./usMailV2Document";
+export { UsMailV2RecipientAddress } from "./usMailV2RecipientAddress";
+export { UsMailV2SenderAddress } from "./usMailV2SenderAddress";

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

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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; } });

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

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,27 @@
+"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

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,62 @@
+"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

@@ -0,0 +1,40 @@
+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 | undefined;
+    /** The complete address of the recipient. */
+    complete: string | undefined;
+    /** Indicates if the recipient's address is a change of address. */
+    isAddressChange: boolean | undefined;
+    /** The postal code of the recipient's address. */
+    postalCode: string | undefined;
+    /** The private mailbox number of the recipient's address. */
+    privateMailboxNumber: string | undefined;
+    /** Second part of the ISO 3166-2 code, consisting of two letters indicating the US State. */
+    state: string | undefined;
+    /** The street of the recipient's address. */
+    street: string | undefined;
+    /** 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

@@ -0,0 +1,116 @@
+"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;
+/**
+ * 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 = [];
+        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 ?
+                this.city :
+                this.city.slice(0, 12) + "..." :
+            "",
+        complete: this.complete ?
+            this.complete.length <= 35 ?
+                this.complete :
+                this.complete.slice(0, 32) + "..." :
+            "",
+        isAddressChange: this.isAddressChange === true ?
+            "True" : this.isAddressChange === false ?
+            "False" :
+            "",
+        postalCode: this.postalCode ?
+            this.postalCode.length <= 11 ?
+                this.postalCode :
+                this.postalCode.slice(0, 8) + "..." :
+            "",
+        privateMailboxNumber: this.privateMailboxNumber ?
+            this.privateMailboxNumber.length <= 22 ?
+                this.privateMailboxNumber :
+                this.privateMailboxNumber.slice(0, 19) + "..." :
+            "",
+        state: this.state ?
+            this.state.length <= 5 ?
+                this.state :
+                this.state.slice(0, 2) + "..." :
+            "",
+        street: this.street ?
+            this.street.length <= 25 ?
+                this.street :
+                this.street.slice(0, 22) + "..." :
+            "",
+    };
+};

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

@@ -0,0 +1,36 @@
+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 | undefined;
+    /** The complete address of the sender. */
+    complete: string | undefined;
+    /** The postal code of the sender's address. */
+    postalCode: string | undefined;
+    /** Second part of the ISO 3166-2 code, consisting of two letters indicating the US State. */
+    state: string | undefined;
+    /** The street of the sender's address. */
+    street: string | undefined;
+    /** 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

@@ -0,0 +1,92 @@
+"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;
+/**
+ * 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 = [];
+        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 ?
+            this.city.length <= 15 ?
+                this.city :
+                this.city.slice(0, 12) + "..." :
+            "",
+        complete: this.complete ?
+            this.complete.length <= 35 ?
+                this.complete :
+                this.complete.slice(0, 32) + "..." :
+            "",
+        postalCode: this.postalCode ?
+            this.postalCode.length <= 11 ?
+                this.postalCode :
+                this.postalCode.slice(0, 8) + "..." :
+            "",
+        state: this.state ?
+            this.state.length <= 5 ?
+                this.state :
+                this.state.slice(0, 2) + "..." :
+            "",
+        street: this.street ?
+            this.street.length <= 25 ?
+                this.street :
+                this.street.slice(0, 22) + "..." :
+            "",
+    };
+};