mindee 4.27.1 → 4.29.0-rc1

package/src/http/workflowEndpoint.js

@@ -34,7 +34,7 @@ class WorkflowEndpoint extends baseEndpoint_1.BaseEndpoint {
     async executeWorkflow(params) {
         await params.inputDoc.init();
         if (params.pageOptions !== undefined) {
-            await super.cutDocPages(params.inputDoc, params.pageOptions);
+            await baseEndpoint_1.BaseEndpoint.cutDocPages(params.inputDoc, params.pageOptions);
         }
         const response = await __classPrivateFieldGet(this, _WorkflowEndpoint_instances, "m", _WorkflowEndpoint_workflowReqPost).call(this, params);
         if (!(0, responseValidation_1.isValidSyncResponse)(response)) {
@@ -90,7 +90,7 @@ class WorkflowEndpoint extends baseEndpoint_1.BaseEndpoint {
                 path: path,
                 timeout: this.settings.timeout,
             };
-            const req = this.readResponse(options, resolve, reject);
+            const req = baseEndpoint_1.BaseEndpoint.readResponse(options, resolve, reject);
             form.pipe(req);
             // potential ECONNRESET if we don't end the request.
             req.end();

package/src/imageOperations/common/imageExtractor.d.ts

@@ -1,4 +1,4 @@
-import { PDFPage } from "pdf-lib";
+import { PDFPage } from "@cantoo/pdf-lib";
 import { Polygon } from "../../geometry";
 /**
  * Extracts elements from a page based off of a list of bounding boxes.
@@ -6,4 +6,4 @@ import { Polygon } from "../../geometry";
  * @param pdfPage PDF Page to extract from.
  * @param polygons List of coordinates to pull the elements from.
  */
-export declare function extractFromPage(pdfPage: PDFPage, polygons: Polygon[]): Promise<Uint8Array[]>;
+export declare function extractFromPage(pdfPage: PDFPage, polygons: Polygon[]): Promise<Uint8Array<ArrayBufferLike>[]>;

package/src/imageOperations/common/imageExtractor.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractFromPage = extractFromPage;
-const pdf_lib_1 = require("pdf-lib");
+const pdf_lib_1 = require("@cantoo/pdf-lib");
 const geometry_1 = require("../../geometry");
 /**
  * Extracts elements from a page based off of a list of bounding boxes.

package/src/imageOperations/imageCompressor.d.ts

@@ -6,4 +6,4 @@
  * @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>;
+export declare function compressImage(imageBuffer: Buffer, quality?: number, maxWidth?: number | null, maxHeight?: number | null): Promise<Buffer<ArrayBufferLike>>;

package/src/imageOperations/invoiceSplitterExtractor/invoiceSplitterExtractor.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractInvoices = extractInvoices;
-const pdf_lib_1 = require("pdf-lib");
+const pdf_lib_1 = require("@cantoo/pdf-lib");
 const errors_1 = require("../../errors");
 const product_1 = require("../../product");
 const extractedInvoiceSplitterImage_1 = require("./extractedInvoiceSplitterImage");
@@ -30,7 +30,10 @@ async function getPdfDoc(inputFile) {
     if (!inputFile.isPdf()) {
         throw new errors_1.MindeeMimeTypeError("Invoice Splitter is only compatible with pdf documents.");
     }
-    const pdfDoc = await pdf_lib_1.PDFDocument.load(inputFile.fileObject);
+    const pdfDoc = await pdf_lib_1.PDFDocument.load(inputFile.fileObject, {
+        ignoreEncryption: true,
+        password: ""
+    });
     if (pdfDoc.getPageCount() < 2) {
         throw new errors_1.MindeeError("Invoice Splitter is only compatible with multi-page-pdf documents.");
     }

package/src/imageOperations/multiReceiptsExtractor/multiReceiptsExtractor.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractReceipts = extractReceipts;
-const pdf_lib_1 = require("pdf-lib");
+const pdf_lib_1 = require("@cantoo/pdf-lib");
 const errors_1 = require("../../errors");
 const extractedMultiReceiptImage_1 = require("./extractedMultiReceiptImage");
 const common_1 = require("../common");
@@ -30,7 +30,10 @@ async function loadPdfDoc(inputFile) {
             '" Currently supported types are .png, .jpg and .pdf');
     }
     else if (inputFile.isPdf()) {
-        pdfDoc = await pdf_lib_1.PDFDocument.load(inputFile.fileObject);
+        pdfDoc = await pdf_lib_1.PDFDocument.load(inputFile.fileObject, {
+            ignoreEncryption: true,
+            password: ""
+        });
     }
     else {
         pdfDoc = await pdf_lib_1.PDFDocument.create();

package/src/index.d.ts

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

package/src/index.js

@@ -15,18 +15,30 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-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.imageOperations = exports.internal = exports.LocalResponse = exports.PageOptionsOperation = exports.InputSource = exports.Page = exports.Document = exports.Prediction = exports.Inference = exports.PredictResponse = exports.AsyncPredictResponse = exports.ClientV2 = 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; } });
+var clientV2_1 = require("./clientV2");
+Object.defineProperty(exports, "ClientV2", { enumerable: true, get: function () { return clientV2_1.ClientV2; } });
 var common_1 = require("./parsing/common");
 Object.defineProperty(exports, "AsyncPredictResponse", { enumerable: true, get: function () { return common_1.AsyncPredictResponse; } });
 Object.defineProperty(exports, "PredictResponse", { enumerable: true, get: function () { return common_1.PredictResponse; } });

package/src/input/localResponse.d.ts

@@ -1,5 +1,6 @@
 import { StringDict } from "../parsing/common";
 import { Buffer } from "buffer";
+import { CommonResponse } from "../parsing/v2";
 /**
  * Local response loaded from a file.
  * Note: Has to be initialized through init() before use.
@@ -30,4 +31,16 @@ export declare class LocalResponse {
      * @returns True if the HMAC signature is valid.
      */
     isValidHmacSignature(secretKey: string | Buffer | Uint8Array, signature: string): boolean;
+    /**
+     * Deserialize the loaded local response into the requested CommonResponse`-derived class.
+     *
+     * Typically used when dealing with V2 webhook callbacks.
+     *
+     * @typeParam ResponseT - A class that extends `CommonResponse`.
+     * @param responseClass - The constructor of the class into which
+     *                        the payload should be deserialized.
+     * @returns An instance of `responseClass` populated with the file content.
+     * @throws MindeeError If the provided class cannot be instantiated.
+     */
+    deserializeResponse<ResponseT extends CommonResponse>(responseClass: new (serverResponse: StringDict) => ResponseT): ResponseT;
 }

package/src/input/localResponse.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LocalResponse = void 0;
 const crypto = __importStar(require("crypto"));
@@ -100,5 +110,24 @@ class LocalResponse {
     isValidHmacSignature(secretKey, signature) {
         return signature === this.getHmacSignature(secretKey);
     }
+    /**
+     * Deserialize the loaded local response into the requested CommonResponse`-derived class.
+     *
+     * Typically used when dealing with V2 webhook callbacks.
+     *
+     * @typeParam ResponseT - A class that extends `CommonResponse`.
+     * @param responseClass - The constructor of the class into which
+     *                        the payload should be deserialized.
+     * @returns An instance of `responseClass` populated with the file content.
+     * @throws MindeeError If the provided class cannot be instantiated.
+     */
+    deserializeResponse(responseClass) {
+        try {
+            return new responseClass(this.asDict());
+        }
+        catch {
+            throw new errors_1.MindeeError("Invalid class specified for deserialization.");
+        }
+    }
 }
 exports.LocalResponse = LocalResponse;

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

@@ -16,6 +16,12 @@ export declare abstract class LocalInputSource extends InputSource {
      * Cut PDF pages.
      * @param pageOptions
      */
+    applyPageOptions(pageOptions: PageOptions): Promise<void>;
+    /**
+     * Cut PDF pages.
+     * @param pageOptions
+     * @deprecated Deprecated in favor of {@link LocalInputSource.applyPageOptions applyPageOptions()}.
+     */
     cutPdf(pageOptions: PageOptions): Promise<void>;
     /**
      * Compresses the file object, either as a PDF or an image.

package/src/input/sources/localInputSource.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -101,13 +111,21 @@ class LocalInputSource extends inputSource_1.InputSource {
      * Cut PDF pages.
      * @param pageOptions
      */
-    async cutPdf(pageOptions) {
+    async applyPageOptions(pageOptions) {
         if (!(this.fileObject instanceof Buffer)) {
             throw new Error(`Cannot modify an input source of type ${this.inputType}.`);
         }
         const processedPdf = await (0, pdf_2.extractPages)(this.fileObject, pageOptions);
         this.fileObject = processedPdf.file;
     }
+    /**
+     * Cut PDF pages.
+     * @param pageOptions
+     * @deprecated Deprecated in favor of {@link LocalInputSource.applyPageOptions applyPageOptions()}.
+     */
+    async cutPdf(pageOptions) {
+        return this.applyPageOptions(pageOptions);
+    }
     /**
      * Compresses the file object, either as a PDF or an image.
      *

package/src/internal.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.product = exports.pdf = exports.parsing = exports.imageOperations = exports.http = exports.geometry = exports.input = void 0;
 exports.input = __importStar(require("./input"));

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

@@ -0,0 +1 @@
+export declare function parseDate(dateString: string | null): Date | null;

package/src/parsing/common/dateParser.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseDate = parseDate;
+function parseDate(dateString) {
+    if (!dateString) {
+        return null;
+    }
+    if (!/Z$/.test(dateString) && !/[+-][0-9]{2}:[0-9]{2}$/.test(dateString)) {
+        dateString += "Z";
+    }
+    return new Date(dateString);
+}

package/src/parsing/common/document.js

@@ -55,6 +55,7 @@ ${this.inference?.toString()}`;
     }
     injectFullTextOcr(rawPrediction) {
         if (rawPrediction["inference"]["pages"].length < 1 ||
+            !("extras" in rawPrediction["inference"]["pages"][0]) ||
             rawPrediction["inference"]["pages"][0]["extras"].length < 1 ||
             !("full_text_ocr" in rawPrediction["inference"]["pages"][0]["extras"]) ||
             !rawPrediction["inference"]["pages"][0]["extras"]["full_text_ocr"] ||

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

@@ -35,5 +35,4 @@ export declare class Execution<T extends Inference> {
     /** Identifier for the workflow. */
     workflowId: string;
     constructor(inferenceClass: new (serverResponse: StringDict) => T, jsonResponse: StringDict);
-    private parseDate;
 }

package/src/parsing/common/execution.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Execution = void 0;
 const generatedV1Document_1 = require("../../product/generated/generatedV1Document");
+const dateParser_1 = require("./dateParser");
 /**
  * Representation of an execution for a workflow.
  * @category Workflow
@@ -9,24 +10,19 @@ const generatedV1Document_1 = require("../../product/generated/generatedV1Docume
 class Execution {
     constructor(inferenceClass, jsonResponse) {
         this.batchName = jsonResponse["batch_name"];
-        this.createdAt = jsonResponse["created_at"] ? this.parseDate(jsonResponse["created_at"]) : null;
+        this.createdAt = (0, dateParser_1.parseDate)(jsonResponse["created_at"]);
         this.file = jsonResponse["file"];
         this.id = jsonResponse["id"];
         this.inference = jsonResponse["inference"] ? new inferenceClass(jsonResponse["inference"]) : null;
         this.priority = jsonResponse["priority"];
-        this.reviewedAt = this.parseDate(jsonResponse["reviewed_at"]);
-        this.availableAt = this.parseDate(jsonResponse["available_at"]);
+        this.reviewedAt = (0, dateParser_1.parseDate)(jsonResponse["reviewed_at"]);
+        this.availableAt = (0, dateParser_1.parseDate)(jsonResponse["available_at"]);
         this.reviewedPrediction = jsonResponse["reviewed_prediction"] ?
             new generatedV1Document_1.GeneratedV1Document(jsonResponse["reviewed_prediction"]) : null;
         this.status = jsonResponse["status"];
         this.type = jsonResponse["type"];
-        this.uploadedAt = this.parseDate(jsonResponse["uploaded_at"]);
+        this.uploadedAt = (0, dateParser_1.parseDate)(jsonResponse["uploaded_at"]);
         this.workflowId = jsonResponse["workflow_id"];
     }
-    parseDate(dateString) {
-        if (!dateString)
-            return null;
-        return new Date(dateString);
-    }
 }
 exports.Execution = Execution;

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

@@ -13,3 +13,4 @@ export { Page } from "./page";
 export { cleanOutString, lineSeparator } from "./summaryHelper";
 export * as extras from "./extras";
 export { floatToString, cleanSpecialChars } from "./summaryHelper";
+export { parseDate } from "./dateParser";

package/src/parsing/common/index.js

@@ -15,15 +15,25 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cleanSpecialChars = exports.floatToString = exports.extras = exports.lineSeparator = exports.cleanOutString = exports.Page = exports.Prediction = exports.PredictResponse = exports.AsyncPredictResponse = exports.OrientationField = exports.FeedbackResponse = exports.Inference = exports.ExecutionPriority = exports.ExecutionFile = exports.Execution = exports.Document = void 0;
+exports.parseDate = exports.cleanSpecialChars = exports.floatToString = exports.extras = exports.lineSeparator = exports.cleanOutString = exports.Page = exports.Prediction = exports.PredictResponse = exports.AsyncPredictResponse = exports.OrientationField = exports.FeedbackResponse = exports.Inference = exports.ExecutionPriority = exports.ExecutionFile = exports.Execution = exports.Document = void 0;
 var document_1 = require("./document");
 Object.defineProperty(exports, "Document", { enumerable: true, get: function () { return document_1.Document; } });
 var execution_1 = require("./execution");
@@ -53,3 +63,5 @@ exports.extras = __importStar(require("./extras"));
 var summaryHelper_2 = require("./summaryHelper");
 Object.defineProperty(exports, "floatToString", { enumerable: true, get: function () { return summaryHelper_2.floatToString; } });
 Object.defineProperty(exports, "cleanSpecialChars", { enumerable: true, get: function () { return summaryHelper_2.cleanSpecialChars; } });
+var dateParser_1 = require("./dateParser");
+Object.defineProperty(exports, "parseDate", { enumerable: true, get: function () { return dateParser_1.parseDate; } });

package/src/parsing/index.d.ts

@@ -2,3 +2,4 @@ export * as common from "./common";
 export * as custom from "./custom";
 export * as standard from "./standard";
 export * as generated from "./generated";
+export * as v2 from "./v2";

package/src/parsing/index.js

@@ -15,16 +15,27 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generated = exports.standard = exports.custom = exports.common = void 0;
+exports.v2 = exports.generated = exports.standard = exports.custom = exports.common = void 0;
 exports.common = __importStar(require("./common"));
 exports.custom = __importStar(require("./custom"));
 exports.standard = __importStar(require("./standard"));
 exports.generated = __importStar(require("./generated"));
+exports.v2 = __importStar(require("./v2"));

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

@@ -0,0 +1,25 @@
+import { StringField, FieldConstructor } from "./text";
+/**
+ * A field containing a detailed address value broken down into components
+ * (street number, city, postal code, …) while still exposing the full
+ * address string through {@link StringField.value}.
+ */
+export declare class AddressField extends StringField {
+    /** Street number. */
+    streetNumber?: string;
+    /** Street name. */
+    streetName?: string;
+    /** PO-box number. */
+    poBox?: string;
+    /** Additional address complement. */
+    addressComplement?: string;
+    /** City or locality. */
+    city?: string;
+    /** Postal / ZIP code. */
+    postalCode?: string;
+    /** State, province or region. */
+    state?: string;
+    /** Country. */
+    country?: string;
+    constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
+}

package/src/parsing/standard/addressField.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddressField = void 0;
+const text_1 = require("./text");
+/**
+ * A field containing a detailed address value broken down into components
+ * (street number, city, postal code, …) while still exposing the full
+ * address string through {@link StringField.value}.
+ */
+class AddressField extends text_1.StringField {
+    constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId, }) {
+        super({ prediction, valueKey, reconstructed, pageId });
+        // Populate the sub-components if they exist in the prediction object
+        if (prediction["street_number"]) {
+            this.streetNumber = prediction["street_number"];
+        }
+        if (prediction["street_name"]) {
+            this.streetName = prediction["street_name"];
+        }
+        if (prediction["po_box"]) {
+            this.poBox = prediction["po_box"];
+        }
+        if (prediction["address_complement"]) {
+            this.addressComplement = prediction["address_complement"];
+        }
+        if (prediction["city"]) {
+            this.city = prediction["city"];
+        }
+        if (prediction["postal_code"]) {
+            this.postalCode = prediction["postal_code"];
+        }
+        if (prediction["state"]) {
+            this.state = prediction["state"];
+        }
+        if (prediction["country"]) {
+            this.country = prediction["country"];
+        }
+    }
+}
+exports.AddressField = AddressField;

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

@@ -1,13 +1,14 @@
-export { ClassificationField } from "./classification";
-export { Taxes, TaxField } from "./tax";
-export { PaymentDetailsField } from "./paymentDetails";
-export { BooleanField } from "./boolean";
-export { LocaleField } from "./locale";
+export { AddressField } from "./addressField";
 export { AmountField } from "./amount";
-export { DateField } from "./date";
 export { BaseField, BaseFieldConstructor } from "./base";
-export { Word } from "./word";
+export { BooleanField } from "./boolean";
+export { ClassificationField } from "./classification";
 export { CompanyRegistrationField } from "./companyRegistration";
-export { PositionField } from "./position";
-export { StringField } from "./text";
+export { DateField } from "./date";
+export { LocaleField } from "./locale";
 export { Field } from "./field";
+export { Taxes, TaxField } from "./tax";
+export { StringField } from "./text";
+export { PaymentDetailsField } from "./paymentDetails";
+export { PositionField } from "./position";
+export { Word } from "./word";

package/src/parsing/standard/index.js

@@ -1,28 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Field = exports.StringField = exports.PositionField = exports.CompanyRegistrationField = exports.BaseField = exports.DateField = exports.AmountField = exports.LocaleField = exports.BooleanField = exports.PaymentDetailsField = exports.TaxField = exports.Taxes = exports.ClassificationField = void 0;
+exports.PositionField = exports.PaymentDetailsField = exports.StringField = exports.TaxField = exports.Taxes = exports.Field = exports.LocaleField = exports.DateField = exports.CompanyRegistrationField = exports.ClassificationField = exports.BooleanField = exports.BaseField = exports.AmountField = exports.AddressField = void 0;
+var addressField_1 = require("./addressField");
+Object.defineProperty(exports, "AddressField", { enumerable: true, get: function () { return addressField_1.AddressField; } });
+var amount_1 = require("./amount");
+Object.defineProperty(exports, "AmountField", { enumerable: true, get: function () { return amount_1.AmountField; } });
+var base_1 = require("./base");
+Object.defineProperty(exports, "BaseField", { enumerable: true, get: function () { return base_1.BaseField; } });
+var boolean_1 = require("./boolean");
+Object.defineProperty(exports, "BooleanField", { enumerable: true, get: function () { return boolean_1.BooleanField; } });
 var classification_1 = require("./classification");
 Object.defineProperty(exports, "ClassificationField", { enumerable: true, get: function () { return classification_1.ClassificationField; } });
+var companyRegistration_1 = require("./companyRegistration");
+Object.defineProperty(exports, "CompanyRegistrationField", { enumerable: true, get: function () { return companyRegistration_1.CompanyRegistrationField; } });
+var date_1 = require("./date");
+Object.defineProperty(exports, "DateField", { enumerable: true, get: function () { return date_1.DateField; } });
+var locale_1 = require("./locale");
+Object.defineProperty(exports, "LocaleField", { enumerable: true, get: function () { return locale_1.LocaleField; } });
+var field_1 = require("./field");
+Object.defineProperty(exports, "Field", { enumerable: true, get: function () { return field_1.Field; } });
 var tax_1 = require("./tax");
 Object.defineProperty(exports, "Taxes", { enumerable: true, get: function () { return tax_1.Taxes; } });
 Object.defineProperty(exports, "TaxField", { enumerable: true, get: function () { return tax_1.TaxField; } });
+var text_1 = require("./text");
+Object.defineProperty(exports, "StringField", { enumerable: true, get: function () { return text_1.StringField; } });
 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");
-Object.defineProperty(exports, "AmountField", { enumerable: true, get: function () { return amount_1.AmountField; } });
-var date_1 = require("./date");
-Object.defineProperty(exports, "DateField", { enumerable: true, get: function () { return date_1.DateField; } });
-var base_1 = require("./base");
-Object.defineProperty(exports, "BaseField", { enumerable: true, get: function () { return base_1.BaseField; } });
-var companyRegistration_1 = require("./companyRegistration");
-Object.defineProperty(exports, "CompanyRegistrationField", { enumerable: true, get: function () { return companyRegistration_1.CompanyRegistrationField; } });
 var position_1 = require("./position");
 Object.defineProperty(exports, "PositionField", { enumerable: true, get: function () { return position_1.PositionField; } });
-var text_1 = require("./text");
-Object.defineProperty(exports, "StringField", { enumerable: true, get: function () { return text_1.StringField; } });
-var field_1 = require("./field");
-Object.defineProperty(exports, "Field", { enumerable: true, get: function () { return field_1.Field; } });