@amaster.ai/client 1.1.17 → 1.1.19

package/README.md

@@ -562,6 +562,10 @@ const result = await client.function.invoke<{ result: string }>("sendEmail", {
 if (result.data) {
   console.log("Function result:", result.data.result);
 }
+
+// Keep this id with bug reports or failed UI actions.
+// It maps the response back to the exact edge-function console logs.
+console.log("Invocation:", result.invocationId);
 ```
 
 ## ☁️ S3 Storage

package/dist/index.d.cts

@@ -11,7 +11,7 @@ export { ASRClient, ASRClientConfig, ASRHttpClient, ASRHttpClientConfig, ASRLang
 import { CopilotClient } from '@amaster.ai/copilot-client';
 export { AutoVoiceReplyController, AutoVoiceReplyConversation, AutoVoiceReplyMessage, AutoVoiceReplySnapshot, AutoVoiceReplySource, AutoVoiceReplySourceSnapshot, AutoVoiceReplySpeechDriver, AutoVoiceReplySpeechSnapshot, AutoVoiceReplyStorage, Conversation, ConversationController, ConversationControllerOptions, ConversationControllerSnapshot, ConversationRequestState, ConversationRuntimeError, CopilotClient, CopilotFileConstraints, CopilotFileManager, CopilotFileManagerSnapshot, CopilotManagedFile, Role as CopilotRole, CreateAutoVoiceReplyControllerOptions, ErrorMessage, FileContent, FileMessage, ImageContent, MessageContent, MessageFileAttachment, MessagesItem, SendMessageOptions, TextContent, TextMessage, ThoughtMessage, ToolMessage, UIRenderMessage, createAutoVoiceReplyController, createCopilotFileManager } from '@amaster.ai/copilot-client';
 import { FunctionClient } from '@amaster.ai/function-client';
-export { FunctionClient } from '@amaster.ai/function-client';
+export { FunctionClient, FunctionInvocationResult } from '@amaster.ai/function-client';
 import { TTSClientConfig, TTSClient } from '@amaster.ai/tts-client';
 export { TTSClient, TTSClientConfig, TTSRuntime, TTSSnapshot, TTSSpeakController, TTSSpeakControllerOptions, TTSSpeakOptions, TTSStorageAdapter, createTTSSpeakController, preprocessTTSContent, splitTextIntoFragments } from '@amaster.ai/tts-client';
 import { S3Client } from '@amaster.ai/s3-client';

package/dist/index.d.ts

@@ -11,7 +11,7 @@ export { ASRClient, ASRClientConfig, ASRHttpClient, ASRHttpClientConfig, ASRLang
 import { CopilotClient } from '@amaster.ai/copilot-client';
 export { AutoVoiceReplyController, AutoVoiceReplyConversation, AutoVoiceReplyMessage, AutoVoiceReplySnapshot, AutoVoiceReplySource, AutoVoiceReplySourceSnapshot, AutoVoiceReplySpeechDriver, AutoVoiceReplySpeechSnapshot, AutoVoiceReplyStorage, Conversation, ConversationController, ConversationControllerOptions, ConversationControllerSnapshot, ConversationRequestState, ConversationRuntimeError, CopilotClient, CopilotFileConstraints, CopilotFileManager, CopilotFileManagerSnapshot, CopilotManagedFile, Role as CopilotRole, CreateAutoVoiceReplyControllerOptions, ErrorMessage, FileContent, FileMessage, ImageContent, MessageContent, MessageFileAttachment, MessagesItem, SendMessageOptions, TextContent, TextMessage, ThoughtMessage, ToolMessage, UIRenderMessage, createAutoVoiceReplyController, createCopilotFileManager } from '@amaster.ai/copilot-client';
 import { FunctionClient } from '@amaster.ai/function-client';
-export { FunctionClient } from '@amaster.ai/function-client';
+export { FunctionClient, FunctionInvocationResult } from '@amaster.ai/function-client';
 import { TTSClientConfig, TTSClient } from '@amaster.ai/tts-client';
 export { TTSClient, TTSClientConfig, TTSRuntime, TTSSnapshot, TTSSpeakController, TTSSpeakControllerOptions, TTSSpeakOptions, TTSStorageAdapter, createTTSSpeakController, preprocessTTSContent, splitTextIntoFragments } from '@amaster.ai/tts-client';
 import { S3Client } from '@amaster.ai/s3-client';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amaster.ai/client",
-  "version": "1.1.17",
+  "version": "1.1.19",
   "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/auth-client": "1.1.17",
-    "@amaster.ai/bpm-client": "1.1.17",
-    "@amaster.ai/asr-client": "1.1.17",
-    "@amaster.ai/copilot-client": "1.1.17",
-    "@amaster.ai/function-client": "1.1.17",
-    "@amaster.ai/http-client": "1.1.17",
-    "@amaster.ai/s3-client": "1.1.17",
-    "@amaster.ai/entity-client": "1.1.17",
-    "@amaster.ai/tts-client": "1.1.17",
-    "@amaster.ai/workflow-client": "1.1.17"
+    "@amaster.ai/asr-client": "1.1.19",
+    "@amaster.ai/auth-client": "1.1.19",
+    "@amaster.ai/bpm-client": "1.1.19",
+    "@amaster.ai/copilot-client": "1.1.19",
+    "@amaster.ai/entity-client": "1.1.19",
+    "@amaster.ai/http-client": "1.1.19",
+    "@amaster.ai/s3-client": "1.1.19",
+    "@amaster.ai/tts-client": "1.1.19",
+    "@amaster.ai/workflow-client": "1.1.19",
+    "@amaster.ai/function-client": "1.1.19"
   },
   "peerDependencies": {
     "axios": "^1.11.0"

package/types/common.d.ts

@@ -65,12 +65,17 @@ export interface ClientResult<T> {
    * HTTP response status code
    */
   status: number;
+
+  /**
+   * Raw response headers when the underlying adapter exposes them.
+   */
+  headers?: unknown;
 }
 
 /**
  * HTTP request methods
  */
-export type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete';
+export type HttpMethod = "get" | "post" | "put" | "patch" | "delete";
 
 /**
  * Pagination parameters for list queries

package/types/function.d.ts

@@ -1,41 +1,59 @@
 /**
  *  * Invoke serverless functions deployed on the Amaster platform.
- * 
+ *
  * @module function
  */
 
-import type { ClientResult } from './common';
+import type { ClientResult } from "./common";
+
+/**
+ * Function invocation result.
+ *
+ * Includes the standard client result fields and runtime metadata from
+ * response headers. Use `invocationId` to query edge-function invocation logs.
+ */
+export type FunctionInvocationResult<T> = ClientResult<T> & {
+  /**
+   * Runtime invocation id for this function call.
+   */
+  invocationId: string | null;
+
+  /**
+   * Function version selected by the runtime for this call.
+   */
+  functionVersion: string | null;
+};
 
 /**
  * Function Client API
- * 
+ *
  * Execute serverless functions with type-safe parameters and results.
- * 
+ *
  * @since 1.0.0
  */
 export interface FunctionClientAPI {
   /**
    * Invoke a serverless function
-   * 
+   *
    * @param funcName - Function name (corresponds to directory in src/functions/)
    * @param params - Function parameters (sent as JSON body)
    * @returns Function execution result
-   * 
+   *
    * @example
    * const result = await client.function.invoke<{ message: string }>('sendEmail', {
    *   to: 'user@example.com',
    *   subject: 'Hello',
    *   body: 'Welcome!'
    * });
-   * 
+   *
    * if (result.data) {
    *   console.log(result.data.message);
    * }
-   * 
+   *
    * @since 1.0.0
    */
   invoke<T = unknown>(
     funcName: string,
     params?: Record<string, unknown>
-  ): Promise<ClientResult<T>>;
+  ): Promise<FunctionInvocationResult<T>>;
 }

package/types/http.d.ts

@@ -1,91 +1,92 @@
-import { AxiosRequestConfig, AxiosInstance } from 'axios';
+import { AxiosRequestConfig, AxiosInstance } from "axios";
 
 type ClientError = {
-    message: string;
-    status?: number;
-    code?: string;
-    details?: unknown;
+  message: string;
+  status?: number;
+  code?: string;
+  details?: unknown;
 };
 type ClientResult<T> = {
-    data: T | null;
-    error: ClientError | null;
-    status: number;
+  data: T | null;
+  error: ClientError | null;
+  status: number;
+  headers?: unknown;
 };
 type RequestConfig = AxiosRequestConfig & {
-    url: string;
-    method: NonNullable<AxiosRequestConfig["method"]> | string;
+  url: string;
+  method: NonNullable<AxiosRequestConfig["method"]> | string;
 };
 type AdapterResponse = {
-    status: number;
-    data: unknown;
-    headers?: unknown;
+  status: number;
+  data: unknown;
+  headers?: unknown;
 };
 type HttpAdapter = (_config: RequestConfig) => Promise<AdapterResponse>;
 type MiniProgramRequest = (_opts: any) => any;
 type MiniProgramRuntime = {
-    Taro?: {
-        request?: (_opts: any) => any;
-        login?: (_opts?: any) => any;
-        getEnv?: () => unknown;
-        ENV_TYPE?: Record<string, unknown>;
-        miniGlobal?: unknown;
-        options?: {
-            miniGlobal?: unknown;
-        };
+  Taro?: {
+    request?: (_opts: any) => any;
+    login?: (_opts?: any) => any;
+    getEnv?: () => unknown;
+    ENV_TYPE?: Record<string, unknown>;
+    miniGlobal?: unknown;
+    options?: {
+      miniGlobal?: unknown;
     };
+  };
 };
 type HttpClientOptions = {
-    /**
-     * HTTP adapter to use:
-     * - undefined: auto-detect (taro if mini-program APIs exist, otherwise axios)
-     * - "taro": force mini-program request (wx/tt/my/...) or global Taro.request
-     * - "axios": force axios
-     * - AxiosInstance: use provided axios instance
-     * - function: custom adapter
-     */
-    adapter?: "taro" | "axios" | AxiosInstance | HttpAdapter;
-    /**
-     * Base URL to prefix when `config.url` is relative (e.g. "/api/...").
-     *
-     * If not provided:
-     * - Taro/mini-program: auto-reads from process.env.TARO_APP_API_BASE_URL or process.env.VITE_API_BASE_URL
-     * - H5/Browser: no baseURL (expects dev proxy or absolute URLs)
-     */
-    baseURL?: string;
-    /** Default headers merged into each request */
-    headers?: Record<string, string>;
-    /**
-     * Custom response transform function to extract/modify data from backend response
-     * If not provided, uses default transform logic for { status: 0/1, data: {...} }
-     *
-     * Similar to axios's transformResponse option
-     *
-     * @example
-     * ```typescript
-     * // For backend that returns: { statusCode: 200, data: {...} }
-     * const client = createHttpClient({
-     *   transformResponse: (response) => {
-     *     if (response && typeof response === 'object' && 'data' in response) {
-     *       return response.data;
-     *     }
-     *     return response;
-     *   }
-     * });
-     * ```
-     */
-    transformResponse?: <T>(responseData: unknown) => T;
-    /**
-     * Whether to log errors to console (default: true)
-     * Set to false to disable automatic error logging
-     */
-    logErrors?: boolean;
-    /**
-     * Explicitly provide the Taro runtime object when it is not exposed on `globalThis`.
-     */
-    runtime?: Partial<MiniProgramRuntime>;
+  /**
+   * HTTP adapter to use:
+   * - undefined: auto-detect (taro if mini-program APIs exist, otherwise axios)
+   * - "taro": force mini-program request (wx/tt/my/...) or global Taro.request
+   * - "axios": force axios
+   * - AxiosInstance: use provided axios instance
+   * - function: custom adapter
+   */
+  adapter?: "taro" | "axios" | AxiosInstance | HttpAdapter;
+  /**
+   * Base URL to prefix when `config.url` is relative (e.g. "/api/...").
+   *
+   * If not provided:
+   * - Taro/mini-program: auto-reads from process.env.TARO_APP_API_BASE_URL or process.env.VITE_API_BASE_URL
+   * - H5/Browser: no baseURL (expects dev proxy or absolute URLs)
+   */
+  baseURL?: string;
+  /** Default headers merged into each request */
+  headers?: Record<string, string>;
+  /**
+   * Custom response transform function to extract/modify data from backend response
+   * If not provided, uses default transform logic for { status: 0/1, data: {...} }
+   *
+   * Similar to axios's transformResponse option
+   *
+   * @example
+   * ```typescript
+   * // For backend that returns: { statusCode: 200, data: {...} }
+   * const client = createHttpClient({
+   *   transformResponse: (response) => {
+   *     if (response && typeof response === 'object' && 'data' in response) {
+   *       return response.data;
+   *     }
+   *     return response;
+   *   }
+   * });
+   * ```
+   */
+  transformResponse?: <T>(responseData: unknown) => T;
+  /**
+   * Whether to log errors to console (default: true)
+   * Set to false to disable automatic error logging
+   */
+  logErrors?: boolean;
+  /**
+   * Explicitly provide the Taro runtime object when it is not exposed on `globalThis`.
+   */
+  runtime?: Partial<MiniProgramRuntime>;
 };
 type HttpClient = {
-    request<T>(_config: RequestConfig): Promise<ClientResult<T>>;
+  request<T>(_config: RequestConfig): Promise<ClientResult<T>>;
 };
 declare function resolveMiniProgramGlobals(): any;
 declare function getMiniProgramRequest(): MiniProgramRequest | null;
@@ -109,6 +110,21 @@ declare function getMiniProgramRequest(): MiniProgramRequest | null;
  * });
  * ```
  */
-declare function createHttpClient(axiosInstanceOrOptions?: AxiosInstance | HttpClientOptions): HttpClient;
+declare function createHttpClient(
+  axiosInstanceOrOptions?: AxiosInstance | HttpClientOptions
+): HttpClient;
 
-export { type AdapterResponse, type ClientError, type ClientResult, type HttpAdapter, type HttpClient, type HttpClientOptions, type MiniProgramRequest, type MiniProgramRuntime, type RequestConfig, createHttpClient, getMiniProgramRequest, resolveMiniProgramGlobals };
+export {
+  type AdapterResponse,
+  type ClientError,
+  type ClientResult,
+  type HttpAdapter,
+  type HttpClient,
+  type HttpClientOptions,
+  type MiniProgramRequest,
+  type MiniProgramRuntime,
+  type RequestConfig,
+  createHttpClient,
+  getMiniProgramRequest,
+  resolveMiniProgramGlobals,
+};

package/types/index.d.ts

@@ -9,11 +9,11 @@
  *
  * ## Quick Start
  * ```typescript
-* import { createClient } from '@amaster.ai/client';
-*
-* const client = createClient({
-*   onUnauthorized: () => window.location.href = '/login'
-* });
+ * import { createClient } from '@amaster.ai/client';
+ *
+ * const client = createClient({
+ *   onUnauthorized: () => window.location.href = '/login'
+ * });
  *
  * // Login
  * await client.auth.login({ email, password });
@@ -268,7 +268,7 @@ export interface AmasterClient {
    * It automatically includes authentication headers and base URL.
    * You can use this client to make custom requests to the Amaster API
    * or your own backend while still benefiting from automatic token management.
-     * For example:
+   * For example:
    * ```typescript
    * const response = await client.http.request({
    *   url: '/api/custom-endpoint',
@@ -277,7 +277,7 @@ export interface AmasterClient {
    * });
    * console.log(response.data);
    * ```
-     * Note: The `http` client is an instance of the same HTTP client used internally by the Amaster client.
+   * Note: The `http` client is an instance of the same HTTP client used internally by the Amaster client.
    * It automatically includes the base URL and authentication headers configured in `createClient()`.
    */
   http: HttpClient;
@@ -337,11 +337,7 @@ export interface AmasterClient {
 export declare function createClient(options?: AmasterClientOptions): AmasterClient;
 
 export { createAutoVoiceReplyController, createCopilotFileManager } from "./copilot";
-export {
-  createTTSSpeakController,
-  preprocessTTSContent,
-  splitTextIntoFragments,
-} from "./tts";
+export { createTTSSpeakController, preprocessTTSContent, splitTextIntoFragments } from "./tts";
 
 // Re-export shared common types
 export type { ClientError, ClientResult } from "./common";
@@ -378,13 +374,99 @@ export type {
   RoleDetail,
   PermissionDetail,
 } from "./auth";
-export type { EntityClientAPI, EntityQueryParams, EntityListResponse, FilterOperator, FilterItem, FilterGroup } from "./entity";
-export type { BpmClientAPI, ProcessInstance, Task, TaskQueryParams, ProcessVariable, HistoryTask, HistoryProcessInstance, HistoryActivityInstance, ActivityInstanceTree, UserOperationLog, CamundaVariable, TaskFormSchema } from "./bpm";
-export type { WorkflowClientAPI, WorkflowRunRequest, WorkflowRunResponse, WorkflowInputValue, WorkflowFile } from "./workflow";
-export type { ASRClient, ASRClientConfig, ASRHttpClient, ASRHttpClientConfig, Recorder, RecorderOptions } from "./asr";
-export type { CopilotClientAPI, CopilotClientAPI as CopilotClient, MessageContent, TextContent, ImageContent, FileContent, MessageFileAttachment, SendMessageOptions, CopilotFileConstraints, CopilotFileManager, CopilotFileManagerSnapshot, CopilotManagedFile, ConversationController, ConversationControllerOptions, ConversationControllerSnapshot, AutoVoiceReplyController, AutoVoiceReplyConversation, AutoVoiceReplyMessage, AutoVoiceReplySnapshot, AutoVoiceReplySource, AutoVoiceReplySourceSnapshot, AutoVoiceReplySpeechDriver, AutoVoiceReplySpeechSnapshot, AutoVoiceReplyStorage, CreateAutoVoiceReplyControllerOptions, ConversationRequestState, ConversationRuntimeError, Conversation, MessagesItem, TextMessage, FileMessage, ErrorMessage, ThoughtMessage, ToolMessage, UIRenderMessage, Role as CopilotRole } from "./copilot";
-export type { FunctionClientAPI, FunctionClientAPI as FunctionClient } from "./function";
-export type { TTSClientAPI, TTSClientAPI as TTSClient, TTSClientConfig, TTSAudioFormat, TTSSnapshot, TTSSpeakController, TTSSpeakControllerOptions, TTSSpeakOptions, TTSStreamOptions, TTSRuntime, TTSStorageAdapter } from "./tts";
+export type {
+  EntityClientAPI,
+  EntityQueryParams,
+  EntityListResponse,
+  FilterOperator,
+  FilterItem,
+  FilterGroup,
+} from "./entity";
+export type {
+  BpmClientAPI,
+  ProcessInstance,
+  Task,
+  TaskQueryParams,
+  ProcessVariable,
+  HistoryTask,
+  HistoryProcessInstance,
+  HistoryActivityInstance,
+  ActivityInstanceTree,
+  UserOperationLog,
+  CamundaVariable,
+  TaskFormSchema,
+} from "./bpm";
+export type {
+  WorkflowClientAPI,
+  WorkflowRunRequest,
+  WorkflowRunResponse,
+  WorkflowInputValue,
+  WorkflowFile,
+} from "./workflow";
+export type {
+  ASRClient,
+  ASRClientConfig,
+  ASRHttpClient,
+  ASRHttpClientConfig,
+  Recorder,
+  RecorderOptions,
+} from "./asr";
+export type {
+  CopilotClientAPI,
+  CopilotClientAPI as CopilotClient,
+  MessageContent,
+  TextContent,
+  ImageContent,
+  FileContent,
+  MessageFileAttachment,
+  SendMessageOptions,
+  CopilotFileConstraints,
+  CopilotFileManager,
+  CopilotFileManagerSnapshot,
+  CopilotManagedFile,
+  ConversationController,
+  ConversationControllerOptions,
+  ConversationControllerSnapshot,
+  AutoVoiceReplyController,
+  AutoVoiceReplyConversation,
+  AutoVoiceReplyMessage,
+  AutoVoiceReplySnapshot,
+  AutoVoiceReplySource,
+  AutoVoiceReplySourceSnapshot,
+  AutoVoiceReplySpeechDriver,
+  AutoVoiceReplySpeechSnapshot,
+  AutoVoiceReplyStorage,
+  CreateAutoVoiceReplyControllerOptions,
+  ConversationRequestState,
+  ConversationRuntimeError,
+  Conversation,
+  MessagesItem,
+  TextMessage,
+  FileMessage,
+  ErrorMessage,
+  ThoughtMessage,
+  ToolMessage,
+  UIRenderMessage,
+  Role as CopilotRole,
+} from "./copilot";
+export type {
+  FunctionClientAPI,
+  FunctionClientAPI as FunctionClient,
+  FunctionInvocationResult,
+} from "./function";
+export type {
+  TTSClientAPI,
+  TTSClientAPI as TTSClient,
+  TTSClientConfig,
+  TTSAudioFormat,
+  TTSSnapshot,
+  TTSSpeakController,
+  TTSSpeakControllerOptions,
+  TTSSpeakOptions,
+  TTSStreamOptions,
+  TTSRuntime,
+  TTSStorageAdapter,
+} from "./tts";
 export type { S3ClientAPI, UploadRes, S3Metadata, S3ClientAPI as S3Client } from "./s3";
 export type { HttpClient, MiniProgramRuntime, RequestConfig } from "./http";