@amaster.ai/client 1.1.43-beta.0 → 1.1.43-beta.3

package/dist/index.d.cts

@@ -5,7 +5,7 @@ export { EntityGetParams, EntityListResponse, EntityQueryParams, FilterGroup, Fi
 import { BpmClient } from '@amaster.ai/bpm-client';
 export { ActivityInstanceTree, CamundaVariable, HistoryActivityInstance, HistoryProcessInstance, HistoryTask, ProcessInstance, ProcessVariable, Task, TaskFormSchema, TaskQueryParams, UserOperationLog } from '@amaster.ai/bpm-client';
 import { WorkflowClient } from '@amaster.ai/workflow-client';
-export { WorkflowFile, WorkflowInputValue, WorkflowNodeUsage, WorkflowRunRequest, WorkflowRunResponse, WorkflowRunUsage, WorkflowUsageSummary } from '@amaster.ai/workflow-client';
+export { WorkflowAsyncRunDetailResponse, WorkflowAsyncRunResponse, WorkflowAsyncRunStatus, WorkflowCallbackConfig, WorkflowFile, WorkflowInputValue, WorkflowNodeUsage, WorkflowRunDetailOptions, WorkflowRunRequest, WorkflowRunResponse, WorkflowRunUsage, WorkflowUsageSummary } from '@amaster.ai/workflow-client';
 import { ASRClientConfig, ASRClient, ASRHttpClientConfig, ASRHttpClient } from '@amaster.ai/asr-client';
 export { ASRClient, ASRClientConfig, ASRHttpClient, ASRHttpClientConfig, ASRLanguage } from '@amaster.ai/asr-client';
 import { CopilotClient } from '@amaster.ai/copilot-client';

package/dist/index.d.ts

@@ -5,7 +5,7 @@ export { EntityGetParams, EntityListResponse, EntityQueryParams, FilterGroup, Fi
 import { BpmClient } from '@amaster.ai/bpm-client';
 export { ActivityInstanceTree, CamundaVariable, HistoryActivityInstance, HistoryProcessInstance, HistoryTask, ProcessInstance, ProcessVariable, Task, TaskFormSchema, TaskQueryParams, UserOperationLog } from '@amaster.ai/bpm-client';
 import { WorkflowClient } from '@amaster.ai/workflow-client';
-export { WorkflowFile, WorkflowInputValue, WorkflowNodeUsage, WorkflowRunRequest, WorkflowRunResponse, WorkflowRunUsage, WorkflowUsageSummary } from '@amaster.ai/workflow-client';
+export { WorkflowAsyncRunDetailResponse, WorkflowAsyncRunResponse, WorkflowAsyncRunStatus, WorkflowCallbackConfig, WorkflowFile, WorkflowInputValue, WorkflowNodeUsage, WorkflowRunDetailOptions, WorkflowRunRequest, WorkflowRunResponse, WorkflowRunUsage, WorkflowUsageSummary } from '@amaster.ai/workflow-client';
 import { ASRClientConfig, ASRClient, ASRHttpClientConfig, ASRHttpClient } from '@amaster.ai/asr-client';
 export { ASRClient, ASRClientConfig, ASRHttpClient, ASRHttpClientConfig, ASRLanguage } from '@amaster.ai/asr-client';
 import { CopilotClient } from '@amaster.ai/copilot-client';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amaster.ai/client",
-  "version": "1.1.43-beta.0",
+  "version": "1.1.43-beta.3",
   "description": "Unified API client for Amaster platform - All services in one package",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -72,16 +72,16 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@amaster.ai/bpm-client": "1.1.43-beta.0",
-    "@amaster.ai/asr-client": "1.1.43-beta.0",
-    "@amaster.ai/auth-client": "1.1.43-beta.0",
-    "@amaster.ai/entity-client": "1.1.43-beta.0",
-    "@amaster.ai/http-client": "1.1.43-beta.0",
-    "@amaster.ai/workflow-client": "1.1.43-beta.0",
-    "@amaster.ai/s3-client": "1.1.43-beta.0",
-    "@amaster.ai/function-client": "1.1.43-beta.0",
-    "@amaster.ai/copilot-client": "1.1.43-beta.0",
-    "@amaster.ai/tts-client": "1.1.43-beta.0"
+    "@amaster.ai/bpm-client": "1.1.43-beta.3",
+    "@amaster.ai/http-client": "1.1.43-beta.3",
+    "@amaster.ai/copilot-client": "1.1.43-beta.3",
+    "@amaster.ai/auth-client": "1.1.43-beta.3",
+    "@amaster.ai/s3-client": "1.1.43-beta.3",
+    "@amaster.ai/entity-client": "1.1.43-beta.3",
+    "@amaster.ai/asr-client": "1.1.43-beta.3",
+    "@amaster.ai/workflow-client": "1.1.43-beta.3",
+    "@amaster.ai/tts-client": "1.1.43-beta.3",
+    "@amaster.ai/function-client": "1.1.43-beta.3"
   },
   "peerDependencies": {
     "axios": "^1.11.0"

package/types/index.d.ts

@@ -399,7 +399,12 @@ export type {
 } from "./bpm";
 export type {
   WorkflowClientAPI,
+  WorkflowAsyncRunDetailResponse,
+  WorkflowAsyncRunResponse,
+  WorkflowAsyncRunStatus,
+  WorkflowCallbackConfig,
   WorkflowNodeUsage,
+  WorkflowRunDetailOptions,
   WorkflowRunRequest,
   WorkflowRunResponse,
   WorkflowRunUsage,

package/types/workflow.d.ts

@@ -9,8 +9,9 @@ import type { ClientResult } from './common';
  * Workflow execution response mode
  * - `blocking`: Wait for workflow completion (default)
  * - `streaming`: Stream workflow execution progress
+ * - `async`: Submit workflow execution and return immediately
  */
-export type WorkflowResponseMode = 'blocking' | 'streaming';
+export type WorkflowResponseMode = 'blocking' | 'streaming' | 'async';
 
 /**
  * Workflow input value (can be any JSON-serializable type)
@@ -39,6 +40,22 @@ export interface WorkflowFile {
   [key: string]: unknown;
 }
 
+/**
+ * Callback config for async workflow runs.
+ */
+export interface WorkflowCallbackConfig {
+  /** Callback endpoint to receive terminal workflow result */
+  url: string;
+  /** Shared secret used for HMAC signature */
+  secret?: string;
+  /** Include workflow outputs in callback payload */
+  include_outputs?: boolean;
+  /** Include usage in callback payload */
+  include_usage?: boolean;
+  /** Include node-level usage detail */
+  usage_detail?: boolean;
+}
+
 /**
  * Workflow execution request parameters
  * 
@@ -63,6 +80,10 @@ export interface WorkflowRunRequest {
   trace_id?: string;
   /** Include workflow and node usage in blocking run response */
   usage?: boolean;
+  /** Include node-level usage details when `usage` is enabled */
+  usage_detail?: boolean;
+  /** Callback config for async workflow runs */
+  callback?: WorkflowCallbackConfig;
 }
 
 /**
@@ -103,8 +124,8 @@ export interface WorkflowNodeUsage {
  */
 export interface WorkflowRunUsage {
   summary: WorkflowUsageSummary;
-  estimated_price_by_currency: Record<string, string>;
-  nodes: WorkflowNodeUsage[];
+  estimated_price_by_currency?: Record<string, string>;
+  nodes?: WorkflowNodeUsage[];
 }
 
 /**
@@ -140,6 +161,54 @@ export interface WorkflowRunResponse<TOutput = Record<string, unknown>> {
   usage?: WorkflowRunUsage;
 }
 
+/**
+ * Async workflow run status.
+ */
+export type WorkflowAsyncRunStatus =
+  | 'pending'
+  | 'queued'
+  | 'running'
+  | 'succeeded'
+  | 'failed'
+  | 'paused'
+  | 'rate_limited'
+  | 'retrying'
+  | string;
+
+/**
+ * Response returned immediately by runAsync.
+ */
+export interface WorkflowAsyncRunResponse {
+  async_run_id: string;
+  workflow_trigger_log_id: string;
+  workflow_run_id: string | null;
+  task_id?: string;
+  status: WorkflowAsyncRunStatus;
+  queue?: string;
+  created_at?: number | null;
+}
+
+/**
+ * Async workflow run detail response.
+ */
+export interface WorkflowAsyncRunDetailResponse extends WorkflowAsyncRunResponse {
+  workflow_id?: string;
+  error?: string | null;
+  outputs?: Record<string, unknown> | null;
+  elapsed_time?: number | null;
+  total_tokens?: number | null;
+  triggered_at?: number | null;
+  finished_at?: number | null;
+}
+
+/**
+ * Workflow run detail query options.
+ */
+export interface WorkflowRunDetailOptions {
+  usage?: boolean;
+  usage_detail?: boolean;
+}
+
 // ==================== Workflow Client API ====================
 
 /**
@@ -187,4 +256,29 @@ export interface WorkflowClientAPI {
     workflowName: string,
     inputs?: Record<string, WorkflowInputValue> | WorkflowRunRequest
   ): Promise<ClientResult<WorkflowRunResponse<TOutput>>>;
+
+  /**
+   * Submit a workflow asynchronously and return immediately.
+   */
+  runAsync(
+    workflowName: string,
+    inputs?: Record<string, WorkflowInputValue> | WorkflowRunRequest
+  ): Promise<ClientResult<WorkflowAsyncRunResponse>>;
+
+  /**
+   * Get async workflow submission status.
+   */
+  getAsyncRun(
+    workflowName: string,
+    asyncRunId: string
+  ): Promise<ClientResult<WorkflowAsyncRunDetailResponse>>;
+
+  /**
+   * Get workflow run detail and optional usage.
+   */
+  getRun<TOutput = Record<string, unknown>>(
+    workflowName: string,
+    workflowRunId: string,
+    options?: WorkflowRunDetailOptions
+  ): Promise<ClientResult<WorkflowRunResponse<TOutput>>>;
 }