@meistrari/tela-sdk-js 2.11.0 → 2.12.0

package/dist/index.cjs

@@ -23,7 +23,7 @@ const changeCase__namespace = /*#__PURE__*/_interopNamespaceCompat(changeCase);
 const z__default = /*#__PURE__*/_interopDefaultCompat(z);
 const Emittery__default = /*#__PURE__*/_interopDefaultCompat(Emittery);
 
-const version = "2.11.0";
+const version = "2.12.0";
 
 var __defProp$a = Object.defineProperty;
 var __defNormalProp$a = (obj, key, value) => key in obj ? __defProp$a(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
@@ -2574,6 +2574,40 @@ var __publicField$4 = (obj, key, value) => {
   __defNormalProp$4(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
+function resolveBatchQueue(queue) {
+  if (!queue) {
+    return void 0;
+  }
+  const type = queue.type === void 0 ? "customer" : queue.type;
+  if (type !== "internal" && type !== "customer") {
+    throw new Error('Batch queue type must be either "internal" or "customer"');
+  }
+  if (typeof queue.application !== "string" || queue.application.trim().length === 0) {
+    throw new Error("Batch queue application is required when queue is provided");
+  }
+  return {
+    type,
+    application: queue.application.trim()
+  };
+}
+function createBatchRequestHeaders(params) {
+  const headers = new Headers();
+  let hasHeaders = false;
+  const queue = resolveBatchQueue(params.queue);
+  if (queue) {
+    headers.set("x-batch-source", queue.type);
+    headers.set("x-batch-source-application", queue.application);
+    hasHeaders = true;
+  }
+  if (params.webhook?.headers) {
+    for (const [key, value] of Object.entries(params.webhook.headers)) {
+      const headerKey = key.toLowerCase().startsWith("x-tela-forward-") ? key : `x-tela-forward-${key}`;
+      headers.set(headerKey, value);
+      hasHeaders = true;
+    }
+  }
+  return hasHeaders ? headers : void 0;
+}
 const BatchResultItem = z__default.looseObject({
   reference_id: z__default.string(),
   status: z__default.string(),
@@ -3304,6 +3338,7 @@ class Batch {
     const client = this._client;
     const params = this._params;
     async function execute() {
+      const headers = createBatchRequestHeaders(params);
       const { fileUrl } = await uploadFile(file, client);
       const webhookUrl = params.webhook?.url ?? params.webhookUrl;
       const body = {
@@ -3311,31 +3346,22 @@ class Batch {
         inputFile: fileUrl,
         webhookUrl
       };
-      const forwardHeaders = {};
-      if (params.webhook?.headers) {
-        for (const [key, value] of Object.entries(params.webhook.headers)) {
-          const headerKey = key.toLowerCase().startsWith("x-tela-forward-") ? key : `x-tela-forward-${key}`;
-          forwardHeaders[headerKey] = value;
-        }
-      }
-      let headers;
-      if (Object.keys(forwardHeaders).length > 0) {
-        headers = new Headers();
-        for (const [key, value] of Object.entries(forwardHeaders)) {
-          headers.set(key, value);
-        }
-      }
       return client.post("/_services/batch/batches", {
         body,
         ...headers && { headers }
       }).then((response) => new BatchExecution(response.id, client, params, response));
     }
+    let executionPromise;
+    function getExecution() {
+      executionPromise ?? (executionPromise = execute());
+      return executionPromise;
+    }
     return {
       then(onfulfilled, onrejected) {
-        return Promise.resolve(execute()).then((execution) => onfulfilled?.(execution) ?? execution).catch(onrejected);
+        return getExecution().then((execution) => onfulfilled?.(execution) ?? execution).catch(onrejected);
       },
       get result() {
-        return Promise.resolve(execute()).then((execution) => execution.result);
+        return getExecution().then((execution) => execution.result);
       }
     };
   }

package/dist/index.d.cts

@@ -1947,6 +1947,27 @@ interface BatchWebhookConfig {
      */
     headers?: Record<string, string>;
 }
+/**
+ * Source type for routing batch executions.
+ *
+ * @category Canvas
+ */
+type BatchQueueType = 'internal' | 'customer';
+/**
+ * Queue/source metadata sent as headers when creating a batch execution.
+ *
+ * @category Canvas
+ */
+interface BatchQueueConfig {
+    /**
+     * Source type for the batch. Defaults to `customer` when omitted.
+     */
+    type?: BatchQueueType;
+    /**
+     * Name of the application creating the batch. Required when `queue` is provided.
+     */
+    application: string;
+}
 /**
  * Configuration options for batch execution.
  *
@@ -2007,6 +2028,14 @@ interface BatchParams extends Omit<BaseExecutionParams, ExcludedParams> {
      * ```
      */
     webhook?: BatchWebhookConfig;
+    /**
+     * Optional queue/source metadata sent as headers when creating the batch.
+     *
+     * Sends:
+     * - `x-batch-source`: `queue.type` or `customer` by default.
+     * - `x-batch-source-application`: `queue.application`.
+     */
+    queue?: BatchQueueConfig;
 }
 /**
  * Promise-like wrapper for batch execution that provides direct result access.
@@ -4280,4 +4309,4 @@ declare class TelaSDK extends BaseClient {
  */
 declare function createTelaClient(opts: TelaSDKOptions): TelaSDK;
 
-export { APIError, AuthenticationError, AuthorizationError, BadRequestError, BaseClient, type BaseClientOptions, type BaseTelaFileOptions, BatchExecutionFailedError, ConflictApiKeyAndJWTError, ConflictAuthMethodsError, ConflictError, ConnectionError, ConnectionTimeout, EmptyFileError, ExecutionFailedError, ExecutionNotStartedError, FileUploadError, type HTTPMethods, InternalServerError, InvalidExecutionModeError, InvalidFileURL, MissingApiKeyOrJWTError, MissingAuthError, type NormalizedTaskStatus, NotFoundError, RateLimitError, type RequestOptions, type SchemaBuilder, type Task, type TaskDeleteBulkResult, type TaskDeleteResult, TaskFailedError, type TaskInputContent, type TaskInputFile, type TaskListItem, type TaskListQuery, type TaskListResult, type TaskOrderBy, type TaskOutputContent, type TaskRerunResult, type TaskStatus, type TaskUndoApprovalBulkResult, type TaskUpdatePayload, Tasks, TelaError, TelaFile, type TelaFileInput, type TelaFileOptions, type TelaFileOptionsWithMimeType, TelaFileSchema, TelaSDK, type TelaSDKOptions, UnprocessableEntityError, UserAbortError, Vault, createTelaClient, extractTaskOutput, isTelaFile, isTelaFileArray, normalizeTaskStatus, toError };
+export { APIError, AuthenticationError, AuthorizationError, BadRequestError, BaseClient, type BaseClientOptions, type BaseTelaFileOptions, BatchExecutionFailedError, type BatchParams, type BatchQueueConfig, type BatchQueueType, type BatchWebhookConfig, ConflictApiKeyAndJWTError, ConflictAuthMethodsError, ConflictError, ConnectionError, ConnectionTimeout, EmptyFileError, ExecutionFailedError, ExecutionNotStartedError, FileUploadError, type HTTPMethods, InternalServerError, InvalidExecutionModeError, InvalidFileURL, MissingApiKeyOrJWTError, MissingAuthError, type NormalizedTaskStatus, NotFoundError, RateLimitError, type RequestOptions, type SchemaBuilder, type Task, type TaskDeleteBulkResult, type TaskDeleteResult, TaskFailedError, type TaskInputContent, type TaskInputFile, type TaskListItem, type TaskListQuery, type TaskListResult, type TaskOrderBy, type TaskOutputContent, type TaskRerunResult, type TaskStatus, type TaskUndoApprovalBulkResult, type TaskUpdatePayload, Tasks, TelaError, TelaFile, type TelaFileInput, type TelaFileOptions, type TelaFileOptionsWithMimeType, TelaFileSchema, TelaSDK, type TelaSDKOptions, UnprocessableEntityError, UserAbortError, Vault, createTelaClient, extractTaskOutput, isTelaFile, isTelaFileArray, normalizeTaskStatus, toError };

package/dist/index.d.mts

@@ -1947,6 +1947,27 @@ interface BatchWebhookConfig {
      */
     headers?: Record<string, string>;
 }
+/**
+ * Source type for routing batch executions.
+ *
+ * @category Canvas
+ */
+type BatchQueueType = 'internal' | 'customer';
+/**
+ * Queue/source metadata sent as headers when creating a batch execution.
+ *
+ * @category Canvas
+ */
+interface BatchQueueConfig {
+    /**
+     * Source type for the batch. Defaults to `customer` when omitted.
+     */
+    type?: BatchQueueType;
+    /**
+     * Name of the application creating the batch. Required when `queue` is provided.
+     */
+    application: string;
+}
 /**
  * Configuration options for batch execution.
  *
@@ -2007,6 +2028,14 @@ interface BatchParams extends Omit<BaseExecutionParams, ExcludedParams> {
      * ```
      */
     webhook?: BatchWebhookConfig;
+    /**
+     * Optional queue/source metadata sent as headers when creating the batch.
+     *
+     * Sends:
+     * - `x-batch-source`: `queue.type` or `customer` by default.
+     * - `x-batch-source-application`: `queue.application`.
+     */
+    queue?: BatchQueueConfig;
 }
 /**
  * Promise-like wrapper for batch execution that provides direct result access.
@@ -4280,4 +4309,4 @@ declare class TelaSDK extends BaseClient {
  */
 declare function createTelaClient(opts: TelaSDKOptions): TelaSDK;
 
-export { APIError, AuthenticationError, AuthorizationError, BadRequestError, BaseClient, type BaseClientOptions, type BaseTelaFileOptions, BatchExecutionFailedError, ConflictApiKeyAndJWTError, ConflictAuthMethodsError, ConflictError, ConnectionError, ConnectionTimeout, EmptyFileError, ExecutionFailedError, ExecutionNotStartedError, FileUploadError, type HTTPMethods, InternalServerError, InvalidExecutionModeError, InvalidFileURL, MissingApiKeyOrJWTError, MissingAuthError, type NormalizedTaskStatus, NotFoundError, RateLimitError, type RequestOptions, type SchemaBuilder, type Task, type TaskDeleteBulkResult, type TaskDeleteResult, TaskFailedError, type TaskInputContent, type TaskInputFile, type TaskListItem, type TaskListQuery, type TaskListResult, type TaskOrderBy, type TaskOutputContent, type TaskRerunResult, type TaskStatus, type TaskUndoApprovalBulkResult, type TaskUpdatePayload, Tasks, TelaError, TelaFile, type TelaFileInput, type TelaFileOptions, type TelaFileOptionsWithMimeType, TelaFileSchema, TelaSDK, type TelaSDKOptions, UnprocessableEntityError, UserAbortError, Vault, createTelaClient, extractTaskOutput, isTelaFile, isTelaFileArray, normalizeTaskStatus, toError };
+export { APIError, AuthenticationError, AuthorizationError, BadRequestError, BaseClient, type BaseClientOptions, type BaseTelaFileOptions, BatchExecutionFailedError, type BatchParams, type BatchQueueConfig, type BatchQueueType, type BatchWebhookConfig, ConflictApiKeyAndJWTError, ConflictAuthMethodsError, ConflictError, ConnectionError, ConnectionTimeout, EmptyFileError, ExecutionFailedError, ExecutionNotStartedError, FileUploadError, type HTTPMethods, InternalServerError, InvalidExecutionModeError, InvalidFileURL, MissingApiKeyOrJWTError, MissingAuthError, type NormalizedTaskStatus, NotFoundError, RateLimitError, type RequestOptions, type SchemaBuilder, type Task, type TaskDeleteBulkResult, type TaskDeleteResult, TaskFailedError, type TaskInputContent, type TaskInputFile, type TaskListItem, type TaskListQuery, type TaskListResult, type TaskOrderBy, type TaskOutputContent, type TaskRerunResult, type TaskStatus, type TaskUndoApprovalBulkResult, type TaskUpdatePayload, Tasks, TelaError, TelaFile, type TelaFileInput, type TelaFileOptions, type TelaFileOptionsWithMimeType, TelaFileSchema, TelaSDK, type TelaSDKOptions, UnprocessableEntityError, UserAbortError, Vault, createTelaClient, extractTaskOutput, isTelaFile, isTelaFileArray, normalizeTaskStatus, toError };

package/dist/index.d.ts

@@ -1947,6 +1947,27 @@ interface BatchWebhookConfig {
      */
     headers?: Record<string, string>;
 }
+/**
+ * Source type for routing batch executions.
+ *
+ * @category Canvas
+ */
+type BatchQueueType = 'internal' | 'customer';
+/**
+ * Queue/source metadata sent as headers when creating a batch execution.
+ *
+ * @category Canvas
+ */
+interface BatchQueueConfig {
+    /**
+     * Source type for the batch. Defaults to `customer` when omitted.
+     */
+    type?: BatchQueueType;
+    /**
+     * Name of the application creating the batch. Required when `queue` is provided.
+     */
+    application: string;
+}
 /**
  * Configuration options for batch execution.
  *
@@ -2007,6 +2028,14 @@ interface BatchParams extends Omit<BaseExecutionParams, ExcludedParams> {
      * ```
      */
     webhook?: BatchWebhookConfig;
+    /**
+     * Optional queue/source metadata sent as headers when creating the batch.
+     *
+     * Sends:
+     * - `x-batch-source`: `queue.type` or `customer` by default.
+     * - `x-batch-source-application`: `queue.application`.
+     */
+    queue?: BatchQueueConfig;
 }
 /**
  * Promise-like wrapper for batch execution that provides direct result access.
@@ -4280,4 +4309,4 @@ declare class TelaSDK extends BaseClient {
  */
 declare function createTelaClient(opts: TelaSDKOptions): TelaSDK;
 
-export { APIError, AuthenticationError, AuthorizationError, BadRequestError, BaseClient, type BaseClientOptions, type BaseTelaFileOptions, BatchExecutionFailedError, ConflictApiKeyAndJWTError, ConflictAuthMethodsError, ConflictError, ConnectionError, ConnectionTimeout, EmptyFileError, ExecutionFailedError, ExecutionNotStartedError, FileUploadError, type HTTPMethods, InternalServerError, InvalidExecutionModeError, InvalidFileURL, MissingApiKeyOrJWTError, MissingAuthError, type NormalizedTaskStatus, NotFoundError, RateLimitError, type RequestOptions, type SchemaBuilder, type Task, type TaskDeleteBulkResult, type TaskDeleteResult, TaskFailedError, type TaskInputContent, type TaskInputFile, type TaskListItem, type TaskListQuery, type TaskListResult, type TaskOrderBy, type TaskOutputContent, type TaskRerunResult, type TaskStatus, type TaskUndoApprovalBulkResult, type TaskUpdatePayload, Tasks, TelaError, TelaFile, type TelaFileInput, type TelaFileOptions, type TelaFileOptionsWithMimeType, TelaFileSchema, TelaSDK, type TelaSDKOptions, UnprocessableEntityError, UserAbortError, Vault, createTelaClient, extractTaskOutput, isTelaFile, isTelaFileArray, normalizeTaskStatus, toError };
+export { APIError, AuthenticationError, AuthorizationError, BadRequestError, BaseClient, type BaseClientOptions, type BaseTelaFileOptions, BatchExecutionFailedError, type BatchParams, type BatchQueueConfig, type BatchQueueType, type BatchWebhookConfig, ConflictApiKeyAndJWTError, ConflictAuthMethodsError, ConflictError, ConnectionError, ConnectionTimeout, EmptyFileError, ExecutionFailedError, ExecutionNotStartedError, FileUploadError, type HTTPMethods, InternalServerError, InvalidExecutionModeError, InvalidFileURL, MissingApiKeyOrJWTError, MissingAuthError, type NormalizedTaskStatus, NotFoundError, RateLimitError, type RequestOptions, type SchemaBuilder, type Task, type TaskDeleteBulkResult, type TaskDeleteResult, TaskFailedError, type TaskInputContent, type TaskInputFile, type TaskListItem, type TaskListQuery, type TaskListResult, type TaskOrderBy, type TaskOutputContent, type TaskRerunResult, type TaskStatus, type TaskUndoApprovalBulkResult, type TaskUpdatePayload, Tasks, TelaError, TelaFile, type TelaFileInput, type TelaFileOptions, type TelaFileOptionsWithMimeType, TelaFileSchema, TelaSDK, type TelaSDKOptions, UnprocessableEntityError, UserAbortError, Vault, createTelaClient, extractTaskOutput, isTelaFile, isTelaFileArray, normalizeTaskStatus, toError };

package/dist/index.mjs

@@ -3,7 +3,7 @@ import { Minimatch } from 'minimatch';
 import z, { z as z$1, ZodError } from 'zod';
 import Emittery from 'emittery';
 
-const version = "2.11.0";
+const version = "2.12.0";
 
 var __defProp$a = Object.defineProperty;
 var __defNormalProp$a = (obj, key, value) => key in obj ? __defProp$a(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
@@ -2554,6 +2554,40 @@ var __publicField$4 = (obj, key, value) => {
   __defNormalProp$4(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
+function resolveBatchQueue(queue) {
+  if (!queue) {
+    return void 0;
+  }
+  const type = queue.type === void 0 ? "customer" : queue.type;
+  if (type !== "internal" && type !== "customer") {
+    throw new Error('Batch queue type must be either "internal" or "customer"');
+  }
+  if (typeof queue.application !== "string" || queue.application.trim().length === 0) {
+    throw new Error("Batch queue application is required when queue is provided");
+  }
+  return {
+    type,
+    application: queue.application.trim()
+  };
+}
+function createBatchRequestHeaders(params) {
+  const headers = new Headers();
+  let hasHeaders = false;
+  const queue = resolveBatchQueue(params.queue);
+  if (queue) {
+    headers.set("x-batch-source", queue.type);
+    headers.set("x-batch-source-application", queue.application);
+    hasHeaders = true;
+  }
+  if (params.webhook?.headers) {
+    for (const [key, value] of Object.entries(params.webhook.headers)) {
+      const headerKey = key.toLowerCase().startsWith("x-tela-forward-") ? key : `x-tela-forward-${key}`;
+      headers.set(headerKey, value);
+      hasHeaders = true;
+    }
+  }
+  return hasHeaders ? headers : void 0;
+}
 const BatchResultItem = z.looseObject({
   reference_id: z.string(),
   status: z.string(),
@@ -3284,6 +3318,7 @@ class Batch {
     const client = this._client;
     const params = this._params;
     async function execute() {
+      const headers = createBatchRequestHeaders(params);
       const { fileUrl } = await uploadFile(file, client);
       const webhookUrl = params.webhook?.url ?? params.webhookUrl;
       const body = {
@@ -3291,31 +3326,22 @@ class Batch {
         inputFile: fileUrl,
         webhookUrl
       };
-      const forwardHeaders = {};
-      if (params.webhook?.headers) {
-        for (const [key, value] of Object.entries(params.webhook.headers)) {
-          const headerKey = key.toLowerCase().startsWith("x-tela-forward-") ? key : `x-tela-forward-${key}`;
-          forwardHeaders[headerKey] = value;
-        }
-      }
-      let headers;
-      if (Object.keys(forwardHeaders).length > 0) {
-        headers = new Headers();
-        for (const [key, value] of Object.entries(forwardHeaders)) {
-          headers.set(key, value);
-        }
-      }
       return client.post("/_services/batch/batches", {
         body,
         ...headers && { headers }
       }).then((response) => new BatchExecution(response.id, client, params, response));
     }
+    let executionPromise;
+    function getExecution() {
+      executionPromise ?? (executionPromise = execute());
+      return executionPromise;
+    }
     return {
       then(onfulfilled, onrejected) {
-        return Promise.resolve(execute()).then((execution) => onfulfilled?.(execution) ?? execution).catch(onrejected);
+        return getExecution().then((execution) => onfulfilled?.(execution) ?? execution).catch(onrejected);
       },
       get result() {
-        return Promise.resolve(execute()).then((execution) => execution.result);
+        return getExecution().then((execution) => execution.result);
       }
     };
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meistrari/tela-sdk-js",
-  "version": "2.11.0",
+  "version": "2.12.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/meistrari/tela-sdk-js.git"