mindee 4.18.1 → 4.19.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## v4.19.0 - 2024-11-27
+### Changes
+* :coffin: remove support for international ID V1
+* :sparkles: add support for workflows
+* :sparkles: add configurable http request timeout
+### Fixes
+* :bug: fix http errors improperly showing as 500 in rare instances
+
+
 ## v4.18.1 - 2024-11-19
 ### Fixes
 * :bug: fix composed API server response not properly filling full_text_ocr in pages

package/package.json

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

package/src/client.d.ts

@@ -1,11 +1,27 @@
 import { Readable } from "stream";
 import { Base64Input, BufferInput, BytesInput, InputSource, LocalResponse, PageOptions, PathInput, StreamInput, UrlInput } from "./input";
 import { Endpoint } from "./http";
-import { AsyncPredictResponse, FeedbackResponse, Inference, PredictResponse, StringDict } from "./parsing/common";
+import { AsyncPredictResponse, ExecutionPriority, FeedbackResponse, Inference, PredictResponse, StringDict } from "./parsing/common";
+import { GeneratedV1 } from "./product";
+import { WorkflowResponse } from "./parsing/common/workflowResponse";
+/**
+ * Common options for workflows & predictions.
+ */
+interface BaseOptions {
+    /**
+     * Whether to include the full ocr text. Only available on compatible APIs.
+     */
+    fullText?: boolean;
+    /**
+     * If set, remove pages from the document as specified.
+     * This is done before sending the file to the server and is useful to avoid page limitations.
+     */
+    pageOptions?: PageOptions;
+}
 /**
  * Options relating to predictions.
  */
-export interface PredictOptions {
+export interface PredictOptions extends BaseOptions {
     /** A custom endpoint. */
     endpoint?: Endpoint;
     /**
@@ -14,19 +30,28 @@ export interface PredictOptions {
      * This performs a full OCR operation on the server and will increase response time.
      */
     allWords?: boolean;
-    /**
-     * Whether to include the full ocr text. Only available on compatible APIs.
-     */
-    fullText?: boolean;
     /**
      * Whether to include cropper results for each page.
      */
     cropper?: boolean;
+}
+/**
+ * Options relating to workflows.
+ * @category Workflow
+ */
+export interface WorkflowOptions extends BaseOptions {
     /**
-     * If set, remove pages from the document as specified.
-     * This is done before sending the file to the server and is useful to avoid page limitations.
+     * Alias to give to the document.
      */
-    pageOptions?: PageOptions;
+    alias?: string;
+    /**
+     * Priority to give to the document.
+     */
+    priority?: ExecutionPriority;
+    /**
+     * A unique, encrypted URL for accessing the document validation interface without requiring authentication.
+     */
+    publicUrl?: string;
 }
 /**
  * Asynchronous polling parameters.
@@ -111,6 +136,15 @@ export declare class Client {
      */
     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>>;
+    /**
+     * Send the document to an asynchronous endpoint and return its ID in the queue.
+     * @param inputSource file to send to the API.
+     * @param workflowId ID of the workflow.
+     * @param params parameters relating to prediction options.
+     * @category Workflow
+     * @returns a `Promise` containing the job (queue) corresponding to a document.
+     */
+    executeWorkflow(inputSource: InputSource, workflowId: string, params?: WorkflowOptions): Promise<WorkflowResponse<GeneratedV1>>;
     /**
      * Fetch prediction results from a document already processed.
      *
@@ -204,3 +238,4 @@ export declare class Client {
      */
     docFromBuffer(buffer: Buffer, filename: string): BufferInput;
 }
+export {};

package/src/client.js

@@ -16,6 +16,8 @@ const inference_1 = require("./parsing/common/inference");
 const product_1 = require("./product");
 const promises_1 = require("node:timers/promises");
 const errors_1 = require("./errors");
+const workflowResponse_1 = require("./parsing/common/workflowResponse");
+const workflowEndpoint_1 = require("./http/workflowEndpoint");
 /**
  * Mindee Client class that centralizes most basic operations.
  *
@@ -126,6 +128,28 @@ class Client {
             throw new errors_1.MindeeError("No prediction found in local response.");
         }
     }
+    /**
+     * Send the document to an asynchronous endpoint and return its ID in the queue.
+     * @param inputSource file to send to the API.
+     * @param workflowId ID of the workflow.
+     * @param params parameters relating to prediction options.
+     * @category Workflow
+     * @returns a `Promise` containing the job (queue) corresponding to a document.
+     */
+    async executeWorkflow(inputSource, workflowId, params = {}) {
+        const workflowEndpoint = new workflowEndpoint_1.WorkflowEndpoint(__classPrivateFieldGet(this, _Client_instances, "m", _Client_buildApiSettings).call(this), workflowId);
+        if (inputSource === undefined) {
+            throw new Error("The 'parse' function requires an input document.");
+        }
+        const rawResponse = await workflowEndpoint.executeWorkflow({
+            inputDoc: inputSource,
+            alias: params.alias,
+            priority: params.priority,
+            pageOptions: params?.pageOptions,
+            fullText: this.getBooleanParam(params.fullText),
+        });
+        return new workflowResponse_1.WorkflowResponse(product_1.GeneratedV1, rawResponse.data);
+    }
     /**
      * Fetch prediction results from a document already processed.
      *

package/src/http/apiSettings.d.ts

@@ -1,6 +1,7 @@
 export declare const API_KEY_ENVVAR_NAME: string;
 export declare const API_HOST_ENVVAR_NAME: string;
 export declare const STANDARD_API_OWNER: string;
+export declare const TIMEOUT_DEFAULT: number;
 interface MindeeApiConstructorProps {
     apiKey: string;
 }
@@ -8,6 +9,7 @@ export declare class ApiSettings {
     apiKey: string;
     baseHeaders: Record<string, string>;
     hostname: string;
+    timeout: number;
     constructor({ apiKey, }: MindeeApiConstructorProps);
     protected apiKeyFromEnv(): string;
     protected hostnameFromEnv(): string;

package/src/http/apiSettings.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiSettings = exports.STANDARD_API_OWNER = exports.API_HOST_ENVVAR_NAME = exports.API_KEY_ENVVAR_NAME = void 0;
+exports.ApiSettings = exports.TIMEOUT_DEFAULT = exports.STANDARD_API_OWNER = exports.API_HOST_ENVVAR_NAME = exports.API_KEY_ENVVAR_NAME = void 0;
 /* eslint-disable @typescript-eslint/naming-convention */
 const logger_1 = require("../logger");
 const package_json_1 = require("../../package.json");
@@ -31,6 +31,7 @@ const os = __importStar(require("os"));
 exports.API_KEY_ENVVAR_NAME = "MINDEE_API_KEY";
 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 {
@@ -50,6 +51,7 @@ class ApiSettings {
             Authorization: `Token ${this.apiKey}`,
         };
         this.hostname = this.hostnameFromEnv();
+        this.timeout = process.env.MINDEE_REQUEST_TIMEOUT ? parseInt(process.env.MINDEE_REQUEST_TIMEOUT) : exports.TIMEOUT_DEFAULT;
     }
     apiKeyFromEnv() {
         const envVarValue = process.env[exports.API_KEY_ENVVAR_NAME];

package/src/http/baseEndpoint.d.ts

@@ -1,6 +1,7 @@
 import { ApiSettings } from "./apiSettings";
 import { IncomingMessage, ClientRequest } from "http";
 import { RequestOptions } from "https";
+import { InputSource, PageOptions } from "../input";
 export interface EndpointResponse {
     messageObj: IncomingMessage;
     data: {
@@ -13,7 +14,15 @@ export interface EndpointResponse {
 export declare abstract class BaseEndpoint {
     /** Settings relating to the API. */
     settings: ApiSettings;
-    protected constructor(settings: ApiSettings);
+    /** Entire root of the URL for API calls. */
+    urlRoot: string;
+    protected constructor(settings: ApiSettings, urlRoot: string);
+    /**
+     * Cuts a document's pages according to the given options.
+     * @param inputDoc input document.
+     * @param pageOptions page cutting options.
+     */
+    protected cutDocPages(inputDoc: InputSource, pageOptions: PageOptions): Promise<void>;
     /**
      * Reads a response from the API and processes it.
      * @param options options related to the request itself.

package/src/http/baseEndpoint.js

@@ -3,12 +3,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseEndpoint = void 0;
 const logger_1 = require("../logger");
 const https_1 = require("https");
+const base_1 = require("../input/base");
 /**
  * Base endpoint for the Mindee API.
  */
 class BaseEndpoint {
-    constructor(settings) {
+    constructor(settings, urlRoot) {
         this.settings = settings;
+        this.urlRoot = urlRoot;
+    }
+    /**
+     * Cuts a document's pages according to the given options.
+     * @param inputDoc input document.
+     * @param pageOptions page cutting options.
+     */
+    async cutDocPages(inputDoc, pageOptions) {
+        if (inputDoc instanceof base_1.LocalInputSource && inputDoc.isPdf()) {
+            await inputDoc.cutPdf(pageOptions);
+        }
     }
     /**
      * Reads a response from the API and processes it.

package/src/http/endpoint.d.ts

@@ -1,15 +1,8 @@
 import { InputSource } from "../input";
-import { PageOptions } from "../input";
 import { ApiSettings } from "./apiSettings";
 import { BaseEndpoint, EndpointResponse } from "./baseEndpoint";
 import { StringDict } from "../parsing/common";
-export interface PredictParams {
-    inputDoc: InputSource;
-    includeWords: boolean;
-    fullText: boolean;
-    pageOptions?: PageOptions;
-    cropper: boolean;
-}
+import { PredictParams } from "./httpParams";
 /**
  * Endpoint for a product (OTS or Custom).
  */
@@ -21,11 +14,9 @@ export declare class Endpoint extends BaseEndpoint {
     owner: string;
     /** Product's version, as a string. */
     version: string;
-    /** Entire root of the URL for API calls. */
-    urlRoot: string;
     constructor(urlName: string, owner: string, version: string, settings: ApiSettings);
     /**
-     * Sends a prediction to the API and parses out the result.
+     * Sends a document to the API and parses out the result.
      * Throws an error if the server's response contains one.
      * @param {PredictParams} params parameters relating to prediction options.
      * @category Synchronous
@@ -40,6 +31,7 @@ export declare class Endpoint extends BaseEndpoint {
      * @returns a `Promise` containing queue data.
      */
     predictAsync(params: PredictParams): Promise<EndpointResponse>;
+    private extractStatusMessage;
     /**
      * Requests the results of a queued document from the API.
      * Throws an error if the server's response contains one.

package/src/http/endpoint.js

@@ -7,7 +7,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _Endpoint_instances, _Endpoint_cutDocPages, _Endpoint_predictReqPost, _Endpoint_predictAsyncReqPost, _Endpoint_documentQueueReqGet, _Endpoint_documentGetReq, _Endpoint_documentFeedbackPutReq;
+var _Endpoint_instances, _Endpoint_predictReqPost, _Endpoint_predictAsyncReqPost, _Endpoint_documentQueueReqGet, _Endpoint_documentGetReq, _Endpoint_documentFeedbackPutReq;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Endpoint = void 0;
 const url_1 = require("url");
@@ -21,15 +21,14 @@ const responseValidation_1 = require("./responseValidation");
  */
 class Endpoint extends baseEndpoint_1.BaseEndpoint {
     constructor(urlName, owner, version, settings) {
-        super(settings);
+        super(settings, `/v1/products/${owner}/${urlName}/v${version}`);
         _Endpoint_instances.add(this);
         this.owner = owner;
         this.urlName = urlName;
         this.version = version;
-        this.urlRoot = `/v1/products/${owner}/${urlName}/v${version}`;
     }
     /**
-     * Sends a prediction to the API and parses out the result.
+     * Sends a document to the API and parses out the result.
      * Throws an error if the server's response contains one.
      * @param {PredictParams} params parameters relating to prediction options.
      * @category Synchronous
@@ -38,11 +37,11 @@ class Endpoint extends baseEndpoint_1.BaseEndpoint {
     async predict(params) {
         await params.inputDoc.init();
         if (params.pageOptions !== undefined) {
-            await __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_cutDocPages).call(this, params.inputDoc, params.pageOptions);
+            await super.cutDocPages(params.inputDoc, params.pageOptions);
         }
         const response = await __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_predictReqPost).call(this, params.inputDoc, params.includeWords, params.fullText, params.cropper);
         if (!(0, responseValidation_1.isValidSyncResponse)(response)) {
-            (0, error_1.handleError)(this.urlName, response, response.messageObj?.statusMessage);
+            (0, error_1.handleError)(this.urlName, response, this.extractStatusMessage(response));
         }
         return response;
     }
@@ -56,14 +55,28 @@ class Endpoint extends baseEndpoint_1.BaseEndpoint {
     async predictAsync(params) {
         await params.inputDoc.init();
         if (params.pageOptions !== undefined) {
-            await __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_cutDocPages).call(this, params.inputDoc, params.pageOptions);
+            await super.cutDocPages(params.inputDoc, params.pageOptions);
         }
         const response = await __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_predictAsyncReqPost).call(this, params.inputDoc, params.includeWords, params.fullText, params.cropper);
         if (!(0, responseValidation_1.isValidAsyncResponse)(response)) {
-            (0, error_1.handleError)(this.urlName, response, response.messageObj?.statusMessage);
+            (0, error_1.handleError)(this.urlName, response, this.extractStatusMessage(response));
         }
         return response;
     }
+    extractStatusMessage(response) {
+        if (response.messageObj?.statusMessage !== undefined && response.messageObj?.statusMessage !== null) {
+            return response.messageObj?.statusMessage;
+        }
+        const errorDetail = response.data?.api_request?.error?.detail;
+        if (errorDetail) {
+            return JSON.stringify(errorDetail);
+        }
+        const errorMessage = response.data?.api_request?.error?.message;
+        if (errorMessage) {
+            return JSON.stringify(errorMessage);
+        }
+        return undefined;
+    }
     /**
      * Requests the results of a queued document from the API.
      * Throws an error if the server's response contains one.
@@ -75,7 +88,7 @@ class Endpoint extends baseEndpoint_1.BaseEndpoint {
         const queueResponse = await __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_documentQueueReqGet).call(this, queueId);
         const queueStatusCode = queueResponse.messageObj.statusCode;
         if (!(0, responseValidation_1.isValidAsyncResponse)(queueResponse)) {
-            (0, error_1.handleError)(this.urlName, queueResponse, queueResponse.messageObj?.statusMessage);
+            (0, error_1.handleError)(this.urlName, queueResponse, this.extractStatusMessage(queueResponse));
         }
         if (queueStatusCode === 302 &&
             queueResponse.messageObj.headers.location !== undefined) {
@@ -93,7 +106,7 @@ class Endpoint extends baseEndpoint_1.BaseEndpoint {
     async getDocument(documentId) {
         const response = await __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_documentGetReq).call(this, documentId);
         if (!(0, responseValidation_1.isValidAsyncResponse)(response)) {
-            (0, error_1.handleError)("document", response, response.messageObj?.statusMessage);
+            (0, error_1.handleError)("document", response, this.extractStatusMessage(response));
         }
         return response;
     }
@@ -105,7 +118,7 @@ class Endpoint extends baseEndpoint_1.BaseEndpoint {
     async sendFeedback(documentId, feedback) {
         const response = await __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_documentFeedbackPutReq).call(this, documentId, feedback);
         if (!(0, responseValidation_1.isValidSyncResponse)(response)) {
-            (0, error_1.handleError)("feedback", response, response.messageObj?.statusMessage);
+            (0, error_1.handleError)("feedback", response, this.extractStatusMessage(response));
         }
         return response;
     }
@@ -148,6 +161,7 @@ class Endpoint extends baseEndpoint_1.BaseEndpoint {
                 headers: headers,
                 hostname: this.settings.hostname,
                 path: path,
+                timeout: this.settings.timeout,
             };
             const req = this.readResponse(options, resolve, reject);
             form.pipe(req);
@@ -157,17 +171,7 @@ class Endpoint extends baseEndpoint_1.BaseEndpoint {
     }
 }
 exports.Endpoint = Endpoint;
-_Endpoint_instances = new WeakSet(), _Endpoint_cutDocPages = 
-/**
- * Cuts a document's pages according to the given options.
- * @param inputDoc input document.
- * @param pageOptions page cutting options.
- */
-async function _Endpoint_cutDocPages(inputDoc, pageOptions) {
-    if (inputDoc instanceof base_1.LocalInputSource && inputDoc.isPdf()) {
-        await inputDoc.cutPdf(pageOptions);
-    }
-}, _Endpoint_predictReqPost = function _Endpoint_predictReqPost(input, includeWords = false, fullText = false, cropper = false) {
+_Endpoint_instances = new WeakSet(), _Endpoint_predictReqPost = function _Endpoint_predictReqPost(input, includeWords = false, fullText = false, cropper = false) {
     return this.sendFileForPrediction(input, "predict", includeWords, fullText, cropper);
 }, _Endpoint_predictAsyncReqPost = function _Endpoint_predictAsyncReqPost(input, includeWords = false, fullText = false, cropper = false) {
     return this.sendFileForPrediction(input, "predict_async", includeWords, fullText, cropper);

package/src/http/error.js

@@ -11,7 +11,7 @@ function handleError(urlName, response, serverError) {
             code = 500;
             response.data.api_request.error = response.data.job.error;
         }
-        else {
+        else if (response.data) {
             code = response.data.api_request["status_code"];
         }
     }

package/src/http/httpParams.d.ts

@@ -0,0 +1,17 @@
+import { InputSource, PageOptions } from "../input";
+import { ExecutionPriority } from "../parsing/common";
+interface HTTPParams {
+    inputDoc: InputSource;
+    fullText: boolean;
+    pageOptions?: PageOptions;
+}
+export interface PredictParams extends HTTPParams {
+    includeWords: boolean;
+    cropper: boolean;
+}
+export interface WorkflowParams extends HTTPParams {
+    alias?: string;
+    priority?: ExecutionPriority;
+    publicUrl?: string;
+}
+export {};

package/src/http/httpParams.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/http/index.d.ts

@@ -3,3 +3,4 @@ export { EndpointResponse } from "./baseEndpoint";
 export { STANDARD_API_OWNER, API_KEY_ENVVAR_NAME, ApiSettings, } from "./apiSettings";
 export { MindeeHttpError, MindeeHttp400Error, MindeeHttp401Error, MindeeHttp403Error, MindeeHttp404Error, MindeeHttp413Error, MindeeHttp429Error, MindeeHttp500Error, MindeeHttp504Error, handleError, } from "./error";
 export { isValidSyncResponse, isValidAsyncResponse, cleanRequestData, } from "./responseValidation";
+export { PredictParams, WorkflowParams } from "./httpParams";

package/src/http/responseValidation.js

@@ -13,6 +13,12 @@ function isValidSyncResponse(response) {
     if (!response.messageObj || !response.messageObj.statusCode) {
         return false;
     }
+    if (response.data &&
+        response.data["api_request"] &&
+        response.data["api_request"]["status_code"] &&
+        response.data["api_request"]["status_code"] > 399) {
+        return false;
+    }
     return !(isNaN(response.messageObj.statusCode) ||
         parseInt(response.messageObj.statusCode.toString()) < 200 ||
         parseInt(response.messageObj.statusCode.toString()) > 302);

package/src/http/workflowEndpoint.d.ts

@@ -0,0 +1,29 @@
+import { BaseEndpoint, EndpointResponse } from "./baseEndpoint";
+import { ApiSettings } from "./apiSettings";
+import { InputSource } from "../input";
+import { WorkflowParams } from "./httpParams";
+import { ExecutionPriority } from "../parsing/common";
+/**
+ * Endpoint for a workflow.
+ */
+export declare class WorkflowEndpoint extends BaseEndpoint {
+    #private;
+    constructor(settings: ApiSettings, workflowId: string);
+    /**
+     * Sends a document to a workflow execution.
+     * Throws an error if the server's response contains one.
+     * @param {WorkflowParams} params parameters relating to prediction options.
+     * @category Synchronous
+     * @returns a `Promise` containing parsing results.
+     */
+    executeWorkflow(params: WorkflowParams): Promise<EndpointResponse>;
+    /**
+     * Send a file to a prediction API.
+     * @param input
+     * @param alias
+     * @param priority
+     * @param fullText
+     * @param publicUrl
+     */
+    protected sendFileForPrediction(input: InputSource, alias?: string | null, priority?: ExecutionPriority | null, fullText?: boolean, publicUrl?: string | null): Promise<EndpointResponse>;
+}

package/src/http/workflowEndpoint.js

@@ -0,0 +1,99 @@
+"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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _WorkflowEndpoint_instances, _WorkflowEndpoint_workflowReqPost;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowEndpoint = void 0;
+const baseEndpoint_1 = require("./baseEndpoint");
+const url_1 = require("url");
+const form_data_1 = __importDefault(require("form-data"));
+const base_1 = require("../input/base");
+const responseValidation_1 = require("./responseValidation");
+const error_1 = require("./error");
+/**
+ * Endpoint for a workflow.
+ */
+class WorkflowEndpoint extends baseEndpoint_1.BaseEndpoint {
+    constructor(settings, workflowId) {
+        super(settings, `/v1/workflows/${workflowId}/executions`);
+        _WorkflowEndpoint_instances.add(this);
+    }
+    /**
+     * Sends a document to a workflow execution.
+     * Throws an error if the server's response contains one.
+     * @param {WorkflowParams} params parameters relating to prediction options.
+     * @category Synchronous
+     * @returns a `Promise` containing parsing results.
+     */
+    async executeWorkflow(params) {
+        await params.inputDoc.init();
+        if (params.pageOptions !== undefined) {
+            await super.cutDocPages(params.inputDoc, params.pageOptions);
+        }
+        const response = await __classPrivateFieldGet(this, _WorkflowEndpoint_instances, "m", _WorkflowEndpoint_workflowReqPost).call(this, params.inputDoc, params.alias, params.priority, params.fullText, params.publicUrl);
+        if (!(0, responseValidation_1.isValidSyncResponse)(response)) {
+            (0, error_1.handleError)(this.urlRoot, response, response.messageObj?.statusMessage);
+        }
+        return response;
+    }
+    /**
+     * Send a file to a prediction API.
+     * @param input
+     * @param alias
+     * @param priority
+     * @param fullText
+     * @param publicUrl
+     */
+    sendFileForPrediction(input, alias = null, priority = null, fullText = false, publicUrl = null) {
+        return new Promise((resolve, reject) => {
+            const searchParams = new url_1.URLSearchParams();
+            if (fullText) {
+                searchParams.append("full_text_ocr", "true");
+            }
+            const form = new form_data_1.default();
+            if (input instanceof base_1.LocalInputSource && input.fileObject instanceof Buffer) {
+                form.append("document", input.fileObject, {
+                    filename: input.filename,
+                });
+            }
+            else {
+                form.append("document", input.fileObject);
+            }
+            if (alias) {
+                form.append("alias", alias);
+            }
+            if (publicUrl) {
+                form.append("public_url", publicUrl);
+            }
+            if (priority) {
+                form.append("priority", priority.toString());
+            }
+            const headers = { ...this.settings.baseHeaders, ...form.getHeaders() };
+            let path = this.urlRoot;
+            if (searchParams.toString().length > 0) {
+                path += `?${searchParams}`;
+            }
+            const options = {
+                method: "POST",
+                headers: headers,
+                hostname: this.settings.hostname,
+                path: path,
+                timeout: this.settings.timeout,
+            };
+            const req = this.readResponse(options, resolve, reject);
+            form.pipe(req);
+            // potential ECONNRESET if we don't end the request.
+            req.end();
+        });
+    }
+}
+exports.WorkflowEndpoint = WorkflowEndpoint;
+_WorkflowEndpoint_instances = new WeakSet(), _WorkflowEndpoint_workflowReqPost = function _WorkflowEndpoint_workflowReqPost(input, alias = null, priority = null, fullText = false, publicUrl = null) {
+    return this.sendFileForPrediction(input, alias, priority, fullText, publicUrl);
+};

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

@@ -21,8 +21,8 @@ export declare class Job {
     /** The time taken to process the job, in milliseconds. */
     milliSecsTaken?: number;
     constructor(jsonResponse: StringDict);
-    protected datetimeWithTimezone(date: string): Date;
 }
+export declare function datetimeWithTimezone(date: string): Date;
 /** Wrapper for asynchronous jobs and parsing results.
  *
  * @category API Response

package/src/parsing/common/asyncPredictResponse.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AsyncPredictResponse = exports.Job = void 0;
+exports.datetimeWithTimezone = datetimeWithTimezone;
 const apiResponse_1 = require("./apiResponse");
 const document_1 = require("./document");
 /** Wrapper for asynchronous request queues. Holds information regarding a job (queue).
@@ -10,10 +11,10 @@ const document_1 = require("./document");
  */
 class Job {
     constructor(jsonResponse) {
-        this.issuedAt = this.datetimeWithTimezone(jsonResponse["issued_at"]);
+        this.issuedAt = datetimeWithTimezone(jsonResponse["issued_at"]);
         if (jsonResponse["available_at"] !== undefined &&
             jsonResponse["available_at"] !== null) {
-            this.availableAt = this.datetimeWithTimezone(jsonResponse["available_at"]);
+            this.availableAt = datetimeWithTimezone(jsonResponse["available_at"]);
         }
         this.id = jsonResponse["id"];
         this.status = jsonResponse["status"];
@@ -22,15 +23,15 @@ class Job {
                 this.availableAt.getTime() - this.issuedAt.getTime();
         }
     }
-    // Hideous thing to make sure dates sent back by the server are parsed correctly in UTC.
-    datetimeWithTimezone(date) {
-        if (date.search(/\+[0-9]{2}:[0-9]{2}$/) === -1) {
-            date += "+00:00";
-        }
-        return new Date(date);
-    }
 }
 exports.Job = Job;
+// Hideous thing to make sure dates sent back by the server are parsed correctly in UTC.
+function datetimeWithTimezone(date) {
+    if (date.search(/\+[0-9]{2}:[0-9]{2}$/) === -1) {
+        date += "+00:00";
+    }
+    return new Date(date);
+}
 /** Wrapper for asynchronous jobs and parsing results.
  *
  * @category API Response

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

@@ -0,0 +1,39 @@
+import { Inference } from "./inference";
+import { GeneratedV1Document } from "../../product/generated/generatedV1Document";
+import { ExecutionFile } from "./executionFile";
+import { StringDict } from "./stringDict";
+import { ExecutionPriority } from "./executionPriority";
+/**
+ * Representation of an execution for a workflow.
+ * @category Workflow
+ */
+export declare class Execution<T extends Inference> {
+    /** Identifier for the batch to which the execution belongs. */
+    batchName: string;
+    /** The time at which the execution started. */
+    createdAt: Date | null;
+    /** File representation within a workflow execution. */
+    file: ExecutionFile;
+    /** Identifier for the execution. */
+    id: string;
+    /** Deserialized inference object. */
+    inference: T | null;
+    /** Priority of the execution. */
+    priority: ExecutionPriority | null;
+    /** The time at which the file was tagged as reviewed. */
+    reviewedAt: Date | null;
+    /** The time at which the file was uploaded to a workflow. */
+    availableAt: Date | null;
+    /** Reviewed fields and values. */
+    reviewedPrediction: GeneratedV1Document | null;
+    /** Execution Status. */
+    status: string;
+    /** Execution type. */
+    type: string | null;
+    /** The time at which the file was uploaded to a workflow. */
+    uploadedAt: Date | null;
+    /** Identifier for the workflow. */
+    workflowId: string;
+    constructor(inferenceClass: new (serverResponse: StringDict) => T, jsonResponse: StringDict);
+    private parseDate;
+}

package/src/parsing/common/execution.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Execution = void 0;
+const generatedV1Document_1 = require("../../product/generated/generatedV1Document");
+/**
+ * Representation of an execution for a workflow.
+ * @category Workflow
+ */
+class Execution {
+    constructor(inferenceClass, jsonResponse) {
+        this.batchName = jsonResponse["batch_name"];
+        this.createdAt = jsonResponse["created_at"] ? this.parseDate(jsonResponse["created_at"]) : null;
+        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.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.workflowId = jsonResponse["workflow_id"];
+    }
+    parseDate(dateString) {
+        if (!dateString)
+            return null;
+        return new Date(dateString);
+    }
+}
+exports.Execution = Execution;

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

@@ -0,0 +1,12 @@
+import { StringDict } from "./stringDict";
+/**
+ * Representation of an execution's file info.
+ * @category Workflow
+ */
+export declare class ExecutionFile {
+    /** File name. */
+    name: string | null;
+    /** Optional alias for the fil. */
+    alias: string | null;
+    constructor(jsonResponse: StringDict);
+}

package/src/parsing/common/executionFile.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExecutionFile = void 0;
+/**
+ * Representation of an execution's file info.
+ * @category Workflow
+ */
+class ExecutionFile {
+    constructor(jsonResponse) {
+        this.name = jsonResponse["name"];
+        this.alias = jsonResponse["alias"];
+    }
+}
+exports.ExecutionFile = ExecutionFile;

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

@@ -0,0 +1,5 @@
+export declare enum ExecutionPriority {
+    low = "low",
+    medium = "medium",
+    high = "high"
+}

package/src/parsing/common/executionPriority.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExecutionPriority = void 0;
+var ExecutionPriority;
+(function (ExecutionPriority) {
+    ExecutionPriority["low"] = "low";
+    ExecutionPriority["medium"] = "medium";
+    ExecutionPriority["high"] = "high";
+})(ExecutionPriority || (exports.ExecutionPriority = ExecutionPriority = {}));

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

@@ -1,8 +1,11 @@
 export { Document } from "./document";
+export { Execution } from "./execution";
+export { ExecutionFile } from "./executionFile";
+export { ExecutionPriority } from "./executionPriority";
+export { Inference } from "./inference";
 export { FeedbackResponse } from "./feedback/feedbackResponse";
 export { OrientationField } from "./orientation";
 export { StringDict } from "./stringDict";
-export { Inference } from "./inference";
 export { AsyncPredictResponse } from "./asyncPredictResponse";
 export { PredictResponse } from "./predictResponse";
 export { Prediction } from "./prediction";

package/src/parsing/common/index.js

@@ -23,15 +23,21 @@ var __importStar = (this && this.__importStar) || function (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.Inference = exports.OrientationField = exports.FeedbackResponse = exports.Document = void 0;
+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");
+Object.defineProperty(exports, "Execution", { enumerable: true, get: function () { return execution_1.Execution; } });
+var executionFile_1 = require("./executionFile");
+Object.defineProperty(exports, "ExecutionFile", { enumerable: true, get: function () { return executionFile_1.ExecutionFile; } });
+var executionPriority_1 = require("./executionPriority");
+Object.defineProperty(exports, "ExecutionPriority", { enumerable: true, get: function () { return executionPriority_1.ExecutionPriority; } });
+var inference_1 = require("./inference");
+Object.defineProperty(exports, "Inference", { enumerable: true, get: function () { return inference_1.Inference; } });
 var feedbackResponse_1 = require("./feedback/feedbackResponse");
 Object.defineProperty(exports, "FeedbackResponse", { enumerable: true, get: function () { return feedbackResponse_1.FeedbackResponse; } });
 var orientation_1 = require("./orientation");
 Object.defineProperty(exports, "OrientationField", { enumerable: true, get: function () { return orientation_1.OrientationField; } });
-var inference_1 = require("./inference");
-Object.defineProperty(exports, "Inference", { enumerable: true, get: function () { return inference_1.Inference; } });
 var asyncPredictResponse_1 = require("./asyncPredictResponse");
 Object.defineProperty(exports, "AsyncPredictResponse", { enumerable: true, get: function () { return asyncPredictResponse_1.AsyncPredictResponse; } });
 var predictResponse_1 = require("./predictResponse");

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

@@ -0,0 +1,17 @@
+import { StringDict } from "./stringDict";
+import { ApiResponse } from "./apiResponse";
+import { Execution } from "./execution";
+import { Inference } from "./inference";
+/** Wrapper for workflow requests.
+ *
+ * @category API Response
+ * @category Workflow
+ */
+export declare class WorkflowResponse<T extends Inference> extends ApiResponse {
+    /**
+     * Set the prediction model used to parse the document.
+     * The response object will be instantiated based on this parameter.
+     */
+    execution: Execution<T>;
+    constructor(inferenceClass: new (serverResponse: StringDict) => T, serverResponse: StringDict);
+}

package/src/parsing/common/workflowResponse.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowResponse = void 0;
+const apiResponse_1 = require("./apiResponse");
+const execution_1 = require("./execution");
+/** Wrapper for workflow requests.
+ *
+ * @category API Response
+ * @category Workflow
+ */
+class WorkflowResponse extends apiResponse_1.ApiResponse {
+    constructor(inferenceClass, serverResponse) {
+        super(serverResponse);
+        this.execution = new execution_1.Execution(inferenceClass, serverResponse["execution"]);
+    }
+}
+exports.WorkflowResponse = WorkflowResponse;

package/src/product/index.d.ts

@@ -6,7 +6,6 @@ export { CustomV1 } from "./custom/customV1";
 export { DeliveryNoteV1 } from "./deliveryNote/deliveryNoteV1";
 export { FinancialDocumentV1 } from "./financialDocument/financialDocumentV1";
 export { GeneratedV1 } from "./generated/generatedV1";
-export { InternationalIdV1 } from "./internationalId/internationalIdV1";
 export { InternationalIdV2 } from "./internationalId/internationalIdV2";
 export { InvoiceV4 } from "./invoice/invoiceV4";
 export { InvoiceSplitterV1 } from "./invoiceSplitter/invoiceSplitterV1";

package/src/product/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.us = exports.ind = exports.fr = exports.eu = exports.ResumeV1 = exports.ReceiptV5 = exports.ReceiptV4 = exports.ProofOfAddressV1 = exports.PassportV1 = exports.NutritionFactsLabelV1 = exports.MultiReceiptsDetectorV1 = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.InternationalIdV2 = exports.InternationalIdV1 = exports.GeneratedV1 = exports.FinancialDocumentV1 = exports.DeliveryNoteV1 = exports.CustomV1 = exports.CropperV1 = exports.BusinessCardV1 = exports.BillOfLadingV1 = exports.BarcodeReaderV1 = void 0;
+exports.us = exports.ind = exports.fr = exports.eu = exports.ResumeV1 = exports.ReceiptV5 = exports.ReceiptV4 = exports.ProofOfAddressV1 = exports.PassportV1 = exports.NutritionFactsLabelV1 = exports.MultiReceiptsDetectorV1 = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.InternationalIdV2 = exports.GeneratedV1 = exports.FinancialDocumentV1 = exports.DeliveryNoteV1 = exports.CustomV1 = exports.CropperV1 = exports.BusinessCardV1 = exports.BillOfLadingV1 = exports.BarcodeReaderV1 = void 0;
 var barcodeReaderV1_1 = require("./barcodeReader/barcodeReaderV1");
 Object.defineProperty(exports, "BarcodeReaderV1", { enumerable: true, get: function () { return barcodeReaderV1_1.BarcodeReaderV1; } });
 var billOfLadingV1_1 = require("./billOfLading/billOfLadingV1");
@@ -40,8 +40,6 @@ var financialDocumentV1_1 = require("./financialDocument/financialDocumentV1");
 Object.defineProperty(exports, "FinancialDocumentV1", { enumerable: true, get: function () { return financialDocumentV1_1.FinancialDocumentV1; } });
 var generatedV1_1 = require("./generated/generatedV1");
 Object.defineProperty(exports, "GeneratedV1", { enumerable: true, get: function () { return generatedV1_1.GeneratedV1; } });
-var internationalIdV1_1 = require("./internationalId/internationalIdV1");
-Object.defineProperty(exports, "InternationalIdV1", { enumerable: true, get: function () { return internationalIdV1_1.InternationalIdV1; } });
 var internationalIdV2_1 = require("./internationalId/internationalIdV2");
 Object.defineProperty(exports, "InternationalIdV2", { enumerable: true, get: function () { return internationalIdV2_1.InternationalIdV2; } });
 var invoiceV4_1 = require("./invoice/invoiceV4");

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

@@ -1,4 +1,2 @@
-export { InternationalIdV1 } from "./internationalIdV1";
-export { InternationalIdV1Document } from "./internationalIdV1Document";
 export { InternationalIdV2 } from "./internationalIdV2";
 export { InternationalIdV2Document } from "./internationalIdV2Document";

package/src/product/internationalId/internal.js

@@ -1,10 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InternationalIdV2Document = exports.InternationalIdV2 = exports.InternationalIdV1Document = exports.InternationalIdV1 = void 0;
-var internationalIdV1_1 = require("./internationalIdV1");
-Object.defineProperty(exports, "InternationalIdV1", { enumerable: true, get: function () { return internationalIdV1_1.InternationalIdV1; } });
-var internationalIdV1Document_1 = require("./internationalIdV1Document");
-Object.defineProperty(exports, "InternationalIdV1Document", { enumerable: true, get: function () { return internationalIdV1Document_1.InternationalIdV1Document; } });
+exports.InternationalIdV2Document = exports.InternationalIdV2 = void 0;
 var internationalIdV2_1 = require("./internationalIdV2");
 Object.defineProperty(exports, "InternationalIdV2", { enumerable: true, get: function () { return internationalIdV2_1.InternationalIdV2; } });
 var internationalIdV2Document_1 = require("./internationalIdV2Document");

package/src/product/internationalId/internationalIdV1.d.ts

@@ -1,16 +0,0 @@
-import { Inference, StringDict, Page } from "../../parsing/common";
-import { InternationalIdV1Document } from "./internationalIdV1Document";
-/**
- * Inference prediction for International ID, API version 1.
- */
-export declare class InternationalIdV1 extends Inference {
-    /** The endpoint's name. */
-    endpointName: string;
-    /** The endpoint's version. */
-    endpointVersion: string;
-    /** The document-level prediction. */
-    prediction: InternationalIdV1Document;
-    /** The document's pages. */
-    pages: Page<InternationalIdV1Document>[];
-    constructor(rawPrediction: StringDict);
-}

package/src/product/internationalId/internationalIdV1.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InternationalIdV1 = void 0;
-const common_1 = require("../../parsing/common");
-const internationalIdV1Document_1 = require("./internationalIdV1Document");
-/**
- * Inference prediction for International ID, API version 1.
- */
-class InternationalIdV1 extends common_1.Inference {
-    constructor(rawPrediction) {
-        super(rawPrediction);
-        /** The endpoint's name. */
-        this.endpointName = "international_id";
-        /** The endpoint's version. */
-        this.endpointVersion = "1";
-        /** The document's pages. */
-        this.pages = [];
-        this.prediction = new internationalIdV1Document_1.InternationalIdV1Document(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(internationalIdV1Document_1.InternationalIdV1Document, page, page["id"], page["orientation"]));
-            }
-        });
-    }
-}
-exports.InternationalIdV1 = InternationalIdV1;

package/src/product/internationalId/internationalIdV1Document.d.ts

@@ -1,42 +0,0 @@
-import { Prediction, StringDict } from "../../parsing/common";
-import { ClassificationField, DateField, StringField } from "../../parsing/standard";
-/**
- * Document data for International ID, API version 1.
- */
-export declare class InternationalIdV1Document implements Prediction {
-    /** The physical location of the document holder's residence. */
-    address: StringField;
-    /** The date of birth of the document holder. */
-    birthDate: DateField;
-    /** The location where the document holder was born. */
-    birthPlace: StringField;
-    /** The country that issued the identification document. */
-    countryOfIssue: StringField;
-    /** The unique identifier assigned to the identification document. */
-    documentNumber: StringField;
-    /** The type of identification document being used. */
-    documentType: ClassificationField;
-    /** The date when the document will no longer be valid for use. */
-    expiryDate: DateField;
-    /** The first names or given names of the document holder. */
-    givenNames: StringField[];
-    /** The date when the document was issued. */
-    issueDate: DateField;
-    /** First line of information in a standardized format for easy machine reading and processing. */
-    mrz1: StringField;
-    /** Second line of information in a standardized format for easy machine reading and processing. */
-    mrz2: StringField;
-    /** Third line of information in a standardized format for easy machine reading and processing. */
-    mrz3: StringField;
-    /** Indicates the country of citizenship or nationality of the document holder. */
-    nationality: StringField;
-    /** The document holder's biological sex, such as male or female. */
-    sex: StringField;
-    /** The surnames of the document holder. */
-    surnames: StringField[];
-    constructor(rawPrediction: StringDict, pageId?: number);
-    /**
-     * Default string representation.
-     */
-    toString(): string;
-}

package/src/product/internationalId/internationalIdV1Document.js

@@ -1,101 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InternationalIdV1Document = void 0;
-const common_1 = require("../../parsing/common");
-const standard_1 = require("../../parsing/standard");
-/**
- * Document data for International ID, API version 1.
- */
-class InternationalIdV1Document {
-    constructor(rawPrediction, pageId) {
-        /** The first names or given names of the document holder. */
-        this.givenNames = [];
-        /** The surnames of the document holder. */
-        this.surnames = [];
-        this.address = new standard_1.StringField({
-            prediction: rawPrediction["address"],
-            pageId: pageId,
-        });
-        this.birthDate = new standard_1.DateField({
-            prediction: rawPrediction["birth_date"],
-            pageId: pageId,
-        });
-        this.birthPlace = new standard_1.StringField({
-            prediction: rawPrediction["birth_place"],
-            pageId: pageId,
-        });
-        this.countryOfIssue = new standard_1.StringField({
-            prediction: rawPrediction["country_of_issue"],
-            pageId: pageId,
-        });
-        this.documentNumber = new standard_1.StringField({
-            prediction: rawPrediction["document_number"],
-            pageId: pageId,
-        });
-        this.documentType = new standard_1.ClassificationField({
-            prediction: rawPrediction["document_type"],
-        });
-        this.expiryDate = new standard_1.DateField({
-            prediction: rawPrediction["expiry_date"],
-            pageId: pageId,
-        });
-        rawPrediction["given_names"] &&
-            rawPrediction["given_names"].map((itemPrediction) => this.givenNames.push(new standard_1.StringField({
-                prediction: itemPrediction,
-                pageId: pageId,
-            })));
-        this.issueDate = new standard_1.DateField({
-            prediction: rawPrediction["issue_date"],
-            pageId: pageId,
-        });
-        this.mrz1 = new standard_1.StringField({
-            prediction: rawPrediction["mrz1"],
-            pageId: pageId,
-        });
-        this.mrz2 = new standard_1.StringField({
-            prediction: rawPrediction["mrz2"],
-            pageId: pageId,
-        });
-        this.mrz3 = new standard_1.StringField({
-            prediction: rawPrediction["mrz3"],
-            pageId: pageId,
-        });
-        this.nationality = new standard_1.StringField({
-            prediction: rawPrediction["nationality"],
-            pageId: pageId,
-        });
-        this.sex = new standard_1.StringField({
-            prediction: rawPrediction["sex"],
-            pageId: pageId,
-        });
-        rawPrediction["surnames"] &&
-            rawPrediction["surnames"].map((itemPrediction) => this.surnames.push(new standard_1.StringField({
-                prediction: itemPrediction,
-                pageId: pageId,
-            })));
-    }
-    /**
-     * Default string representation.
-     */
-    toString() {
-        const surnames = this.surnames.join("\n           ");
-        const givenNames = this.givenNames.join("\n              ");
-        const outStr = `:Document Type: ${this.documentType}
-:Document Number: ${this.documentNumber}
-:Country of Issue: ${this.countryOfIssue}
-:Surnames: ${surnames}
-:Given Names: ${givenNames}
-:Gender: ${this.sex}
-:Birth date: ${this.birthDate}
-:Birth Place: ${this.birthPlace}
-:Nationality: ${this.nationality}
-:Issue Date: ${this.issueDate}
-:Expiry Date: ${this.expiryDate}
-:Address: ${this.address}
-:Machine Readable Zone Line 1: ${this.mrz1}
-:Machine Readable Zone Line 2: ${this.mrz2}
-:Machine Readable Zone Line 3: ${this.mrz3}`.trimEnd();
-        return (0, common_1.cleanOutString)(outStr);
-    }
-}
-exports.InternationalIdV1Document = InternationalIdV1Document;