@axiom-lattice/client-sdk 1.0.13 → 1.0.15

package/dist/types.d.ts

@@ -0,0 +1,304 @@
+/**
+ * Core types for the Axiom Lattice Client SDK
+ */
+import { Message, MessageChunk } from "@axiom-lattice/protocols";
+/**
+ * Transport method for client-server communication
+ * Note: Currently only "ws" is used for tool registration
+ */
+export type Transport = "sse" | "ws";
+/**
+ * Configuration options for the Client
+ */
+export interface ClientConfig {
+    /**
+     * Base URL for the API
+     */
+    baseURL: string;
+    /**
+     * API key for authentication
+     */
+    apiKey: string;
+    /**
+     * Assistant identifier
+     */
+    assistantId: string;
+    /**
+     * Transport method (Server-Sent Events or WebSocket)
+     */
+    transport: Transport;
+    /**
+     * Request timeout in milliseconds (optional, defaults to 30000)
+     */
+    timeout?: number;
+    /**
+     * Additional headers to include in requests (optional)
+     */
+    headers?: Record<string, string>;
+    /**
+     * Configuration for retry behavior (optional)
+     */
+    retry?: RetryConfig;
+}
+/**
+ * Configuration for retry behavior
+ */
+export interface RetryConfig {
+    /**
+     * Maximum number of retry attempts
+     */
+    maxRetries: number;
+    /**
+     * Initial delay between retries in milliseconds
+     */
+    initialDelayMs: number;
+    /**
+     * Maximum delay between retries in milliseconds
+     */
+    maxDelayMs: number;
+    /**
+     * Factor to multiply delay by after each retry attempt
+     */
+    backoffFactor: number;
+}
+/**
+ * Thread creation options
+ */
+export interface CreateThreadOptions {
+    /**
+     * Optional metadata for the thread
+     */
+    metadata?: Record<string, any>;
+}
+/**
+ * Thread information
+ */
+export interface Thread {
+    /**
+     * Thread identifier
+     */
+    id: string;
+    /**
+     * Thread metadata
+     */
+    metadata?: Record<string, any>;
+    /**
+     * Thread creation timestamp
+     */
+    createdAt: string;
+}
+/**
+ * Chat send options
+ */
+export interface ChatSendOptions {
+    /**
+     * Thread identifier
+     */
+    threadId: string;
+    /**
+     * Messages to send
+     */
+    messages: Message[];
+    /**
+     * Files to attach (optional)
+     */
+    files?: any[];
+    /**
+     * Command to execute (optional)
+     */
+    command?: {
+        resume?: {
+            action: string;
+            data: Record<string, any> & {
+                config?: {
+                    thread_id?: string;
+                    work_log_id?: string;
+                };
+            };
+            message: string;
+        };
+        update?: any;
+        send?: {
+            node: string;
+            input: any;
+        };
+    };
+    [key: string]: any;
+}
+/**
+ * Chat stream options
+ */
+export 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
+ */
+export interface StreamCallbacks {
+    /**
+     * Called when a stream event is received
+     */
+    onEvent: (event: MessageChunk) => void;
+    /**
+     * Called when the stream completes, with optional agent state
+     */
+    onComplete?: (state?: AgentState) => void;
+    /**
+     * Called when an error occurs
+     */
+    onError?: (error: Error) => void;
+}
+/**
+ * Chat response
+ */
+export interface ChatResponse {
+    /**
+     * Response messages
+     */
+    messages: Message[];
+    /**
+     * Trace ID for debugging
+     */
+    traceId?: string;
+}
+/**
+ * Tool registration options
+ */
+export interface RegisterToolOptions {
+    /**
+     * Tool name
+     */
+    name: string;
+    /**
+     * Tool parameter schema
+     */
+    schema: object;
+    /**
+     * Tool handler function
+     */
+    handler: (params: any) => Promise<any>;
+}
+/**
+ * Get messages options
+ */
+export interface GetMessagesOptions {
+    /**
+     * Thread identifier
+     */
+    threadId: string;
+    /**
+     * Maximum number of messages to return
+     */
+    limit?: number;
+    /**
+     * Message ID to start from (for pagination)
+     */
+    after?: string;
+    /**
+     * Whether to return messages in reverse chronological order
+     */
+    reverse?: boolean;
+}
+/**
+ * Resume stream options
+ */
+export interface ResumeStreamOptions {
+    /**
+     * Thread identifier
+     */
+    threadId: string;
+    /**
+     * Message identifier (usually run_id)
+     */
+    messageId: string;
+    /**
+     * Content already received (used to find resume position)
+     */
+    knownContent: string;
+    /**
+     * Polling interval in milliseconds (default: 100ms)
+     */
+    pollInterval?: number;
+}
+/**
+ * Thread list options
+ */
+export interface ListThreadsOptions {
+    /**
+     * Maximum number of threads to return
+     */
+    limit?: number;
+    /**
+     * Offset for pagination
+     */
+    offset?: number;
+}
+/**
+ * Run options
+ */
+export type RunOptions = {
+    /**
+     * Thread identifier
+     */
+    threadId: string;
+    /**
+     * Message to send
+     */
+    message: string;
+    /**
+     * Files to attach (optional)
+     */
+    files?: any[];
+    /**
+     * Command to execute (optional)
+     */
+    command?: any;
+    /**
+     * Whether to stream the response (optional)
+     */
+    streaming?: boolean;
+    /**
+     * Whether to run in background (optional)
+     */
+    background?: boolean;
+    /**
+     * Whether to return agent state when stream completes (optional)
+     */
+    enableReturnStateWhenSteamCompleted?: boolean;
+} & Record<string, any>;
+/**
+ * Agent state
+ */
+export interface AgentState {
+    values: {
+        messages: Message[];
+        [key: string]: any;
+    };
+    tasks: Array<{
+        interrupts: Array<{
+            value: any;
+        }>;
+    }>;
+}
+/**
+ * Custom error classes
+ */
+export declare class ApiError extends Error {
+    statusCode: number;
+    responseBody?: any | undefined;
+    constructor(message: string, statusCode: number, responseBody?: any | undefined);
+}
+export declare class NetworkError extends Error {
+    constructor(message: string);
+}
+export declare class AuthenticationError extends Error {
+    constructor(message: string);
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACL,OAAO,EAMP,YAAY,EACb,MAAM,0BAA0B,CAAC;AAElC;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,IAAI,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE;YACP,MAAM,EAAE,MAAM,CAAC;YACf,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;gBAC1B,MAAM,CAAC,EAAE;oBAAE,SAAS,CAAC,EAAE,MAAM,CAAC;oBAAC,WAAW,CAAC,EAAE,MAAM,CAAA;iBAAE,CAAC;aACvD,CAAC;YACF,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;QACF,MAAM,CAAC,EAAE,GAAG,CAAC;QACb,IAAI,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,GAAG,CAAA;SAAE,CAAC;KACrC,CAAC;IAEF,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACxD;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,mCAAmC,CAAC,EAAE,OAAO,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;IAEvC;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,UAAU,KAAK,IAAI,CAAC;IAE1C;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,EAAE,OAAO,EAAE,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,GAAG,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,mCAAmC,CAAC,EAAE,OAAO,CAAC;CAC/C,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE;QACN,QAAQ,EAAE,OAAO,EAAE,CAAC;QACpB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;IACF,KAAK,EAAE,KAAK,CAAC;QACX,UAAU,EAAE,KAAK,CAAC;YAChB,KAAK,EAAE,GAAG,CAAC;SACZ,CAAC,CAAC;KACJ,CAAC,CAAC;CACJ;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,KAAK;IAGxB,UAAU,EAAE,MAAM;IAClB,YAAY,CAAC,EAAE,GAAG;gBAFzB,OAAO,EAAE,MAAM,EACR,UAAU,EAAE,MAAM,EAClB,YAAY,CAAC,EAAE,GAAG,YAAA;CAK5B;AAED,qBAAa,YAAa,SAAQ,KAAK;gBACzB,OAAO,EAAE,MAAM;CAI5B;AAED,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM;CAI5B"}

package/dist/types.js

@@ -0,0 +1,27 @@
+/**
+ * Core types for the Axiom Lattice Client SDK
+ */
+/**
+ * Custom error classes
+ */
+export class ApiError extends Error {
+    constructor(message, statusCode, responseBody) {
+        super(message);
+        this.statusCode = statusCode;
+        this.responseBody = responseBody;
+        this.name = "ApiError";
+    }
+}
+export class NetworkError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "NetworkError";
+    }
+}
+export class AuthenticationError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "AuthenticationError";
+    }
+}
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAmVH;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,KAAK;IACjC,YACE,OAAe,EACR,UAAkB,EAClB,YAAkB;QAEzB,KAAK,CAAC,OAAO,CAAC,CAAC;QAHR,eAAU,GAAV,UAAU,CAAQ;QAClB,iBAAY,GAAZ,YAAY,CAAM;QAGzB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;IACzB,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;IAC7B,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAC5C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF"}

package/dist/wechat-client.d.ts

@@ -0,0 +1,65 @@
+import { MessageChunk } from "@axiom-lattice/protocols";
+import { AgentState, ClientConfig, ResumeStreamOptions, RunOptions } from "./types";
+import { AbstractClient } from "./abstract-client";
+/**
+ * WeChat Mini Program client for interacting with the Axiom Lattice Agent Service API
+ */
+export declare class WeChatClient extends AbstractClient {
+    /**
+     * 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;
+    /**
+     * Implementation of the abstract makeRequest method for WeChat clients
+     * @param url - The URL to make the request to
+     * @param options - Request options
+     * @returns A promise that resolves to the response data
+     */
+    protected makeRequest<T>(url: string, options?: {
+        method?: string;
+        body?: any;
+        headers?: Record<string, string>;
+    }): Promise<T>;
+    /**
+     * Implementation of the abstract streamRequest method for WeChat clients
+     */
+    protected streamRequest(options: RunOptions, onEvent: (event: MessageChunk) => void, onComplete?: (state?: AgentState) => void, onError?: (error: Error) => void): () => void;
+    /**
+     * Resume streaming from a known position
+     * @param options - Options for resuming the stream
+     * @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
+     */
+    resumeStream(options: ResumeStreamOptions, onEvent: (event: MessageChunk) => void, onComplete?: () => void, onError?: (error: Error) => void): () => void;
+    /**
+     * Helper method to make WeChat HTTP requests
+     * @private
+     */
+    private request;
+    /**
+     * 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;
+    decodeUint8Array(uint8Array: ArrayBuffer): any;
+    buf2hex(arrayBuffer: ArrayBuffer): string;
+    /**
+     * Convert hexadecimal string to text (supports Chinese characters)
+     * @param {String} hex - Hexadecimal string
+     * @return {String} Decoded string including Chinese characters
+     */
+    hexToStr(hex: string): any;
+}
+//# sourceMappingURL=wechat-client.d.ts.map

package/dist/wechat-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wechat-client.d.ts","sourceRoot":"","sources":["../src/wechat-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EACL,UAAU,EAMV,YAAY,EAMZ,mBAAmB,EACnB,UAAU,EAEX,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;GAEG;AACH,qBAAa,YAAa,SAAQ,cAAc;IAC9C;;;OAGG;gBACS,MAAM,EAAE,YAAY;IAOhC;;;OAGG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAInC;;;;;OAKG;cACa,WAAW,CAAC,CAAC,EAC3B,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,GAAG,CAAC;QACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC,GACA,OAAO,CAAC,CAAC,CAAC;IA2Bb;;OAEG;IACH,SAAS,CAAC,aAAa,CACrB,OAAO,EAAE,UAAU,EACnB,OAAO,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,EACtC,UAAU,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,UAAU,KAAK,IAAI,EACzC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAC/B,MAAM,IAAI;IAIb;;;;;;;OAOG;IACH,YAAY,CACV,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,EACtC,UAAU,CAAC,EAAE,MAAM,IAAI,EACvB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAC/B,MAAM,IAAI;IAuEb;;;OAGG;YACW,OAAO;IAqDrB;;;;;;;OAOG;IACH,OAAO,CAAC,SAAS;IAqFjB,gBAAgB,CAAC,UAAU,EAAE,WAAW;IAKxC,OAAO,CAAC,WAAW,EAAE,WAAW;IAOhC;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM;CAyBrB"}