@axiom-lattice/client-sdk 1.0.22 → 1.0.24

package/README.md

@@ -14,6 +14,7 @@ The Client SDK provides a simple interface for interacting with the Axiom Lattic
 - Register client-side tools
 - Handle tool calls and responses
 - Process streaming message chunks with ChunkMessageMerger
+- Standardized HTTP client using axios for all API calls
 
 ## Installation
 
@@ -32,6 +33,7 @@ const client = new Client({
   apiKey: "your-api-key",
   assistantId: "your-assistant-id",
   transport: "sse",
+  environment: "web", // Optional: "web" (default) or "wechat-miniprogram"
 });
 
 // Create a thread
@@ -121,6 +123,35 @@ const messages = merger.getMessages();
 
 ## Migration Notes
 
+### Runtime Environment Support
+
+As of version 1.0.13, the client SDK now supports different runtime environments through the `environment` configuration option. Currently supported environments are:
+
+- `"web"` (default): Uses axios for all HTTP requests, including streaming responses
+- `"wechat-miniprogram"`: Uses a custom WeChat Mini Program HTTP client implementation for compatibility with WeChat Mini Programs
+
+To specify the environment:
+
+```typescript
+const client = new Client({
+  // ... other options
+  environment: "wechat-miniprogram", // For WeChat Mini Program environments
+});
+```
+
+The WeChat Mini Program environment uses a different approach for streaming responses since true streaming is not supported in that environment. It uses a polling mechanism instead.
+
+### HTTP Client Standardization
+
+As of version 1.0.12, the client SDK now uses axios exclusively for all HTTP requests, including streaming responses. Previously, the SDK used a combination of axios for regular requests and the native fetch API for streaming. This change standardizes the HTTP client implementation across the SDK.
+
+Benefits:
+
+- Consistent error handling
+- Unified request/response interceptors
+- Simplified maintenance and debugging
+- Better compatibility with different JavaScript environments
+
 ### ChunkMessageMerger
 
 The `ChunkMessageMerger` module has been moved from the web project to the client-sdk package. It provides functionality for processing streaming message chunks and merging them into complete messages.
@@ -151,6 +182,39 @@ Steps for future migration:
 
 The main client class for interacting with the Axiom Lattice Agent Service API.
 
+### WeChatClient
+
+A specialized client implementation for WeChat Mini Programs that uses the native `wx` API for network requests.
+
+```typescript
+import { WeChatClient } from "@axiom-lattice/client-sdk";
+
+// Create a WeChat client
+const client = new WeChatClient({
+  baseURL: "https://api.example.com",
+  apiKey: "your-api-key",
+  assistantId: "your-assistant-id",
+  transport: "sse",
+});
+
+// Use the same API methods as the standard Client
+const threadId = await client.createThread({
+  metadata: { user: "user123" },
+});
+
+// Send a message
+const response = await client.chat.send({
+  threadId,
+  messages: [
+    {
+      role: "user",
+      content: "Hello, how can you help me?",
+      id: "msg-1",
+    },
+  ],
+});
+```
+
 ### ChunkMessageMerger
 
 A utility for processing streaming message chunks and merging them into complete messages.

package/dist/index.d.ts

@@ -110,6 +110,10 @@ interface ChatStreamOptions extends ChatSendOptions {
      * Whether to run in background (optional)
      */
     background?: boolean;
+    /**
+     * Whether to return agent state when stream completes (optional)
+     */
+    enableReturnStateWhenSteamCompleted?: boolean;
 }
 /**
  * Stream callbacks interface
@@ -120,9 +124,9 @@ interface StreamCallbacks {
      */
     onEvent: (event: MessageChunk) => void;
     /**
-     * Called when the stream completes
+     * Called when the stream completes, with optional agent state
      */
-    onComplete?: () => void;
+    onComplete?: (state?: AgentState) => void;
     /**
      * Called when an error occurs
      */
@@ -220,6 +224,10 @@ interface RunOptions {
      * Whether to run in background (optional)
      */
     background?: boolean;
+    /**
+     * Whether to return agent state when stream completes (optional)
+     */
+    enableReturnStateWhenSteamCompleted?: boolean;
 }
 /**
  * Agent state
@@ -254,21 +262,26 @@ declare class AuthenticationError extends Error {
  * Main client class for interacting with the Axiom Lattice Agent Service API
  */
 declare class Client {
-    private client;
     private config;
     private assistantId;
     private tenantId;
     private registeredTools;
+    private headers;
     /**
      * Creates a new Client instance
      * @param config - Configuration options for the client
      */
     constructor(config: ClientConfig);
     /**
-     * Sets up axios interceptors for error handling
+     * Helper method to handle fetch responses and errors
      * @private
      */
-    private setupInterceptors;
+    private handleResponse;
+    /**
+     * Helper method to make fetch requests
+     * @private
+     */
+    private fetchWithTimeout;
     /**
      * Set tenant ID for multi-tenant environments
      * @param tenantId - Tenant identifier
@@ -318,7 +331,7 @@ declare class Client {
     /**
      * Run agent with options
      * @param options - Options for running the agent
-     * @returns A promise that resolves to the run result or a stream
+     * @returns A promise that resolves to the run result
      */
     run(options: RunOptions): Promise<any>;
     /**
@@ -348,7 +361,123 @@ declare class Client {
          * @param onError - Optional callback function called when an error occurs
          * @returns A function that can be called to stop the stream
          */
-        stream: (options: ChatStreamOptions, onEvent: (event: MessageChunk) => void, onComplete?: () => void, onError?: (error: Error) => void) => (() => void);
+        stream: (options: ChatStreamOptions, onEvent: (event: MessageChunk) => void, onComplete?: (state?: AgentState) => void, onError?: (error: Error) => void) => (() => void);
+    };
+    /**
+     * Tools namespace for registering and unregistering client-side tools
+     */
+    tools: {
+        /**
+         * Registers a client-side tool
+         * @param options - Options for registering a tool
+         */
+        register: (options: RegisterToolOptions) => void;
+        /**
+         * Unregisters a client-side tool
+         * @param name - Tool name
+         */
+        unregister: (name: string) => void;
+    };
+}
+
+/**
+ * WeChat Mini Program client for interacting with the Axiom Lattice Agent Service API
+ */
+declare class WeChatClient {
+    private config;
+    private assistantId;
+    private tenantId;
+    private registeredTools;
+    /**
+     * Creates a new WeChatClient instance
+     * @param config - Configuration options for the client
+     */
+    constructor(config: ClientConfig);
+    /**
+     * Set tenant ID for multi-tenant environments
+     * @param tenantId - Tenant identifier
+     */
+    setTenantId(tenantId: string): void;
+    /**
+     * Helper method to make WeChat HTTP requests
+     * @private
+     */
+    private request;
+    /**
+     * Creates a new thread
+     * @param options - Options for creating a thread
+     * @returns A promise that resolves to the thread ID
+     */
+    createThread(options: CreateThreadOptions): Promise<string>;
+    /**
+     * Retrieves thread information
+     * @param threadId - Thread identifier
+     * @returns A promise that resolves to the thread information
+     */
+    getThread(threadId: string): Promise<Thread>;
+    /**
+     * Lists all threads
+     * @param options - Options for listing threads
+     * @returns A promise that resolves to an array of threads
+     */
+    listThreads(options?: ListThreadsOptions): Promise<Thread[]>;
+    /**
+     * Deletes a thread
+     * @param threadId - Thread identifier
+     * @returns A promise that resolves when the thread is deleted
+     */
+    deleteThread(threadId: string): Promise<void>;
+    /**
+     * Retrieves messages from a thread
+     * @param options - Options for retrieving messages
+     * @returns A promise that resolves to an array of messages
+     */
+    getMessages(options: GetMessagesOptions): Promise<Message[]>;
+    /**
+     * Retrieves agent state
+     * @param threadId - Thread identifier
+     * @returns A promise that resolves to the agent state
+     */
+    getAgentState(threadId: string): Promise<AgentState>;
+    /**
+     * Gets agent graph visualization
+     * @returns A promise that resolves to the graph visualization data
+     */
+    getAgentGraph(): Promise<string>;
+    /**
+     * Run agent with options
+     * @param options - Options for running the agent
+     * @returns A promise that resolves to the run result
+     */
+    run(options: RunOptions): Promise<any>;
+    /**
+     * Stream run results using WeChat's downloadFile API
+     * @param options - Options for streaming run results
+     * @param onEvent - Callback function that receives stream events
+     * @param onComplete - Optional callback function called when streaming completes
+     * @param onError - Optional callback function called when an error occurs
+     * @returns A function that can be called to stop the stream
+     */
+    private streamRun;
+    /**
+     * Chat namespace for sending messages and streaming responses
+     */
+    chat: {
+        /**
+         * Sends a message to a thread and receives a response
+         * @param options - Options for sending a message
+         * @returns A promise that resolves to the chat response
+         */
+        send: (options: ChatSendOptions) => Promise<ChatResponse>;
+        /**
+         * Sends a message to a thread and streams the response
+         * @param options - Options for streaming a message
+         * @param onEvent - Callback function that receives stream events
+         * @param onComplete - Optional callback function called when streaming completes
+         * @param onError - Optional callback function called when an error occurs
+         * @returns A function that can be called to stop the stream
+         */
+        stream: (options: ChatStreamOptions, onEvent: (event: MessageChunk) => void, onComplete?: (state?: AgentState) => void, onError?: (error: Error) => void) => (() => void);
     };
     /**
      * Tools namespace for registering and unregistering client-side tools
@@ -385,4 +514,4 @@ declare function createSimpleMessageMerger(): {
     reset: () => void;
 };
 
-export { AgentState, ApiError, AuthenticationError, ChatResponse, ChatSendOptions, ChatStreamOptions, Client, ClientConfig, CreateThreadOptions, GetMessagesOptions, ListThreadsOptions, NetworkError, RegisterToolOptions, RetryConfig, RunOptions, StreamCallbacks, Thread, Transport, createSimpleMessageMerger };
+export { AgentState, ApiError, AuthenticationError, ChatResponse, ChatSendOptions, ChatStreamOptions, Client, ClientConfig, CreateThreadOptions, GetMessagesOptions, ListThreadsOptions, NetworkError, RegisterToolOptions, RetryConfig, RunOptions, StreamCallbacks, Thread, Transport, WeChatClient, createSimpleMessageMerger };