@axiom-lattice/client-sdk 1.0.12 → 1.0.14

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

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 };