@axiom-lattice/react-sdk 1.0.11

package/dist/index.d.mts

@@ -0,0 +1,287 @@
+import { Message, MessageChunk } from '@axiom-lattice/protocols';
+export * from '@axiom-lattice/protocols';
+import { ReactNode } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { Client } from '@axiom-lattice/client-sdk';
+
+/**
+ * Types for the Axiom Lattice React SDK
+ */
+
+/**
+ * Client configuration
+ */
+interface ClientConfig {
+    baseURL: string;
+    apiKey: string;
+    assistantId: string;
+    transport: "sse" | "ws";
+    timeout?: number;
+    headers?: Record<string, string>;
+}
+/**
+ * Props for the AxiomLatticeProvider component
+ */
+interface AxiomLatticeProviderProps {
+    /**
+     * Configuration for the client
+     */
+    config: ClientConfig;
+    /**
+     * Children components
+     */
+    children: ReactNode;
+}
+/**
+ * Thread interface
+ */
+interface Thread {
+    id: string;
+    metadata?: Record<string, any>;
+    createdAt: string;
+}
+/**
+ * Chat response interface
+ */
+interface ChatResponse {
+    message: {
+        role: "assistant";
+        content: string;
+        id: string;
+    };
+    traceId: string;
+}
+/**
+ * Agent state interface
+ */
+interface AgentState {
+    values: {
+        messages: Message[];
+        [key: string]: any;
+    };
+    tasks: Array<{
+        interrupts: Array<{
+            value: any;
+        }>;
+    }>;
+}
+/**
+ * Chat hook state
+ */
+interface ChatState {
+    /**
+     * Array of messages in the chat
+     */
+    messages: Message[];
+    /**
+     * Whether a message is currently being sent
+     */
+    isLoading: boolean;
+    /**
+     * Error that occurred during sending a message
+     */
+    error: Error | null;
+    /**
+     * Current streaming message (if any)
+     */
+    streamingMessage: MessageChunk | null;
+}
+/**
+ * Chat hook options
+ */
+interface UseChatOptions {
+    /**
+     * Whether to use streaming for messages
+     */
+    streaming?: boolean;
+    /**
+     * Initial messages to populate the chat with
+     */
+    initialMessages?: Message[];
+}
+/**
+ * Thread hook state
+ */
+interface ThreadState {
+    /**
+     * Array of threads
+     */
+    threads: Thread[];
+    /**
+     * Currently selected thread
+     */
+    currentThread: Thread | null;
+    /**
+     * Whether threads are being loaded
+     */
+    isLoading: boolean;
+    /**
+     * Error that occurred during thread operations
+     */
+    error: Error | null;
+}
+/**
+ * Agent state hook options
+ */
+interface UseAgentStateOptions {
+    /**
+     * Polling interval in milliseconds
+     */
+    pollingInterval?: number;
+    /**
+     * Whether to automatically start polling
+     */
+    autoStart?: boolean;
+}
+/**
+ * Agent state hook return value
+ */
+interface UseAgentStateReturn {
+    /**
+     * Current agent state
+     */
+    agentState: AgentState | null;
+    /**
+     * Whether the agent state is loading
+     */
+    isLoading: boolean;
+    /**
+     * Error that occurred during fetching agent state
+     */
+    error: Error | null;
+    /**
+     * Start polling for agent state
+     */
+    startPolling: () => void;
+    /**
+     * Stop polling for agent state
+     */
+    stopPolling: () => void;
+    /**
+     * Refresh agent state manually
+     */
+    refresh: () => Promise<void>;
+}
+/**
+ * Stream event handler options
+ */
+interface StreamEventHandlerOptions {
+    /**
+     * Handler for text events
+     */
+    onText?: (text: string) => void;
+    /**
+     * Handler for thinking events
+     */
+    onThinking?: (data: any) => void;
+    /**
+     * Handler for tool call events
+     */
+    onToolCall?: (toolCall: any) => void;
+    /**
+     * Handler for error events
+     */
+    onError?: (error: Error) => void;
+    /**
+     * Handler for completion events
+     */
+    onComplete?: (response: ChatResponse) => void;
+}
+
+/**
+ * Hook for managing chat interactions with an agent
+ *
+ * This hook provides functionality for:
+ * - Sending messages to an agent
+ * - Receiving streaming and non-streaming responses
+ * - Loading message history
+ * - Managing the chat state
+ *
+ * @param threadId - Thread ID to use for chat
+ * @param options - Chat options
+ * @returns Chat state and operations
+ */
+declare function useChat(threadId: string | null, options?: UseChatOptions): ChatState & {
+    sendMessage: (data: {
+        input?: {
+            message: string;
+            files?: {
+                name: string;
+                id: string;
+            }[];
+        };
+        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;
+            };
+        };
+        streaming?: boolean;
+    }) => Promise<void>;
+    stopStreaming: () => void;
+    loadMessages: (limit?: number) => Promise<void>;
+    clearMessages: () => void;
+};
+
+/**
+ * Interface for thread creation options
+ */
+interface CreateThreadOptions {
+    metadata?: Record<string, any>;
+}
+/**
+ * Hook for managing threads
+ * @returns Thread state and operations
+ */
+declare function useThread(): ThreadState & {
+    createThread: (options?: CreateThreadOptions) => Promise<string>;
+    getThread: (threadId: string) => Promise<Thread>;
+    listThreads: (limit?: number, offset?: number) => Promise<void>;
+    deleteThread: (threadId: string) => Promise<void>;
+    selectThread: (threadId: string) => Promise<void>;
+};
+
+/**
+ * Hook for monitoring agent state
+ * @param threadId - Thread ID to monitor
+ * @param options - Agent state options
+ * @returns Agent state and control functions
+ */
+declare function useAgentState(threadId: string | null, options?: UseAgentStateOptions): UseAgentStateReturn;
+
+/**
+ * Hook for fetching agent graph visualization
+ * @returns Graph state and operations
+ */
+declare function useAgentGraph(): {
+    graphImage: string | null;
+    isLoading: boolean;
+    error: Error | null;
+    fetchGraph: () => Promise<void>;
+};
+
+/**
+ * Provider component for the Axiom Lattice client
+ * @param props - Provider props
+ * @returns Provider component
+ */
+declare function AxiomLatticeProvider({ config, children, }: AxiomLatticeProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Hook to access the Axiom Lattice client
+ * @returns The Axiom Lattice client
+ * @throws Error if used outside of AxiomLatticeProvider
+ */
+declare function useAxiomLattice(): Client;
+
+export { type AgentState, AxiomLatticeProvider, type AxiomLatticeProviderProps, type ChatResponse, type ChatState, type ClientConfig, type StreamEventHandlerOptions, type Thread, type ThreadState, type UseAgentStateOptions, type UseAgentStateReturn, type UseChatOptions, useAgentGraph, useAgentState, useAxiomLattice, useChat, useThread };

package/dist/index.d.ts

@@ -0,0 +1,287 @@
+import { Message, MessageChunk } from '@axiom-lattice/protocols';
+export * from '@axiom-lattice/protocols';
+import { ReactNode } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { Client } from '@axiom-lattice/client-sdk';
+
+/**
+ * Types for the Axiom Lattice React SDK
+ */
+
+/**
+ * Client configuration
+ */
+interface ClientConfig {
+    baseURL: string;
+    apiKey: string;
+    assistantId: string;
+    transport: "sse" | "ws";
+    timeout?: number;
+    headers?: Record<string, string>;
+}
+/**
+ * Props for the AxiomLatticeProvider component
+ */
+interface AxiomLatticeProviderProps {
+    /**
+     * Configuration for the client
+     */
+    config: ClientConfig;
+    /**
+     * Children components
+     */
+    children: ReactNode;
+}
+/**
+ * Thread interface
+ */
+interface Thread {
+    id: string;
+    metadata?: Record<string, any>;
+    createdAt: string;
+}
+/**
+ * Chat response interface
+ */
+interface ChatResponse {
+    message: {
+        role: "assistant";
+        content: string;
+        id: string;
+    };
+    traceId: string;
+}
+/**
+ * Agent state interface
+ */
+interface AgentState {
+    values: {
+        messages: Message[];
+        [key: string]: any;
+    };
+    tasks: Array<{
+        interrupts: Array<{
+            value: any;
+        }>;
+    }>;
+}
+/**
+ * Chat hook state
+ */
+interface ChatState {
+    /**
+     * Array of messages in the chat
+     */
+    messages: Message[];
+    /**
+     * Whether a message is currently being sent
+     */
+    isLoading: boolean;
+    /**
+     * Error that occurred during sending a message
+     */
+    error: Error | null;
+    /**
+     * Current streaming message (if any)
+     */
+    streamingMessage: MessageChunk | null;
+}
+/**
+ * Chat hook options
+ */
+interface UseChatOptions {
+    /**
+     * Whether to use streaming for messages
+     */
+    streaming?: boolean;
+    /**
+     * Initial messages to populate the chat with
+     */
+    initialMessages?: Message[];
+}
+/**
+ * Thread hook state
+ */
+interface ThreadState {
+    /**
+     * Array of threads
+     */
+    threads: Thread[];
+    /**
+     * Currently selected thread
+     */
+    currentThread: Thread | null;
+    /**
+     * Whether threads are being loaded
+     */
+    isLoading: boolean;
+    /**
+     * Error that occurred during thread operations
+     */
+    error: Error | null;
+}
+/**
+ * Agent state hook options
+ */
+interface UseAgentStateOptions {
+    /**
+     * Polling interval in milliseconds
+     */
+    pollingInterval?: number;
+    /**
+     * Whether to automatically start polling
+     */
+    autoStart?: boolean;
+}
+/**
+ * Agent state hook return value
+ */
+interface UseAgentStateReturn {
+    /**
+     * Current agent state
+     */
+    agentState: AgentState | null;
+    /**
+     * Whether the agent state is loading
+     */
+    isLoading: boolean;
+    /**
+     * Error that occurred during fetching agent state
+     */
+    error: Error | null;
+    /**
+     * Start polling for agent state
+     */
+    startPolling: () => void;
+    /**
+     * Stop polling for agent state
+     */
+    stopPolling: () => void;
+    /**
+     * Refresh agent state manually
+     */
+    refresh: () => Promise<void>;
+}
+/**
+ * Stream event handler options
+ */
+interface StreamEventHandlerOptions {
+    /**
+     * Handler for text events
+     */
+    onText?: (text: string) => void;
+    /**
+     * Handler for thinking events
+     */
+    onThinking?: (data: any) => void;
+    /**
+     * Handler for tool call events
+     */
+    onToolCall?: (toolCall: any) => void;
+    /**
+     * Handler for error events
+     */
+    onError?: (error: Error) => void;
+    /**
+     * Handler for completion events
+     */
+    onComplete?: (response: ChatResponse) => void;
+}
+
+/**
+ * Hook for managing chat interactions with an agent
+ *
+ * This hook provides functionality for:
+ * - Sending messages to an agent
+ * - Receiving streaming and non-streaming responses
+ * - Loading message history
+ * - Managing the chat state
+ *
+ * @param threadId - Thread ID to use for chat
+ * @param options - Chat options
+ * @returns Chat state and operations
+ */
+declare function useChat(threadId: string | null, options?: UseChatOptions): ChatState & {
+    sendMessage: (data: {
+        input?: {
+            message: string;
+            files?: {
+                name: string;
+                id: string;
+            }[];
+        };
+        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;
+            };
+        };
+        streaming?: boolean;
+    }) => Promise<void>;
+    stopStreaming: () => void;
+    loadMessages: (limit?: number) => Promise<void>;
+    clearMessages: () => void;
+};
+
+/**
+ * Interface for thread creation options
+ */
+interface CreateThreadOptions {
+    metadata?: Record<string, any>;
+}
+/**
+ * Hook for managing threads
+ * @returns Thread state and operations
+ */
+declare function useThread(): ThreadState & {
+    createThread: (options?: CreateThreadOptions) => Promise<string>;
+    getThread: (threadId: string) => Promise<Thread>;
+    listThreads: (limit?: number, offset?: number) => Promise<void>;
+    deleteThread: (threadId: string) => Promise<void>;
+    selectThread: (threadId: string) => Promise<void>;
+};
+
+/**
+ * Hook for monitoring agent state
+ * @param threadId - Thread ID to monitor
+ * @param options - Agent state options
+ * @returns Agent state and control functions
+ */
+declare function useAgentState(threadId: string | null, options?: UseAgentStateOptions): UseAgentStateReturn;
+
+/**
+ * Hook for fetching agent graph visualization
+ * @returns Graph state and operations
+ */
+declare function useAgentGraph(): {
+    graphImage: string | null;
+    isLoading: boolean;
+    error: Error | null;
+    fetchGraph: () => Promise<void>;
+};
+
+/**
+ * Provider component for the Axiom Lattice client
+ * @param props - Provider props
+ * @returns Provider component
+ */
+declare function AxiomLatticeProvider({ config, children, }: AxiomLatticeProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Hook to access the Axiom Lattice client
+ * @returns The Axiom Lattice client
+ * @throws Error if used outside of AxiomLatticeProvider
+ */
+declare function useAxiomLattice(): Client;
+
+export { type AgentState, AxiomLatticeProvider, type AxiomLatticeProviderProps, type ChatResponse, type ChatState, type ClientConfig, type StreamEventHandlerOptions, type Thread, type ThreadState, type UseAgentStateOptions, type UseAgentStateReturn, type UseChatOptions, useAgentGraph, useAgentState, useAxiomLattice, useChat, useThread };