mindee 4.18.1 → 4.20.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # CHANGELOG
 
+## v4.20.0 - 2024-11-28
+### Changes
+* :sparkles: add support for French Health Card V1
+* :sparkles: add support for Driver License V1
+* :sparkles: add support for Payslip FR V3
+
+
+## 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.20.0",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",

package/src/cli.js

@@ -109,13 +109,13 @@ const CLI_COMMAND_CONFIG = new Map([
         },
     ],
     [
-        "fr-carte-vitale",
+        "fr-health-card",
         {
-            displayName: "FR Carte Vitale",
-            docClass: product.fr.CarteVitaleV1,
+            displayName: "FR Health Card",
+            docClass: product.fr.HealthCardV1,
             allWords: false,
-            async: false,
-            sync: true,
+            async: true,
+            sync: false,
         },
     ],
     [
@@ -139,13 +139,13 @@ const CLI_COMMAND_CONFIG = new Map([
         },
     ],
     [
-        "eu-driver-license",
+        "driver-license",
         {
-            displayName: "EU Driver License",
-            docClass: product.eu.DriverLicenseV1,
+            displayName: "Driver License",
+            docClass: product.DriverLicenseV1,
             allWords: false,
-            async: false,
-            sync: true,
+            async: true,
+            sync: false,
         },
     ],
     [
@@ -228,16 +228,6 @@ const CLI_COMMAND_CONFIG = new Map([
             sync: true,
         },
     ],
-    [
-        "us-driver-license",
-        {
-            displayName: "US Driver License",
-            docClass: product.us.DriverLicenseV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
     [
         "us-healthcare-card",
         {

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