@useago/sdk 0.1.6 → 0.1.7

package/dist/state/ClientContextRegistry.d.ts

@@ -0,0 +1,64 @@
+/**
+ * A single piece of context the client wants the LLM to know about.
+ */
+export interface ContextEntry {
+    /** Human-readable label (e.g. "Order detail", "Current user") */
+    name?: string;
+    /** Short description of what this context represents */
+    description?: string;
+    /** Arbitrary structured data the AI should know about */
+    data?: Record<string, unknown>;
+}
+/**
+ * Serialised client context sent with each message.
+ */
+export interface ContextSnapshot {
+    /** All active context entries keyed by their registration key */
+    entries: Record<string, ContextEntry>;
+}
+/**
+ * A function that returns a fresh context entry on demand.
+ * Evaluated every time a message is sent — use it to pull data from stores,
+ * refs, or any source that isn't captured by React state.
+ */
+export type DynamicContextProvider = () => ContextEntry | null | undefined;
+/**
+ * Registry that collects client-side context from across the component tree.
+ *
+ * Components register/unregister context slices via unique keys.
+ * When a message is sent the registry produces a single snapshot.
+ */
+export declare class ClientContextRegistry {
+    private entries;
+    private dynamicProviders;
+    /**
+     * Register or update a static context entry.
+     */
+    set(key: string, entry: ContextEntry): void;
+    /**
+     * Remove a static context entry (typically on component unmount).
+     */
+    remove(key: string): boolean;
+    /**
+     * Register a dynamic context provider. The function is called every time
+     * a message is sent, so it always returns the freshest data.
+     *
+     * Use this for context that lives outside React state — global stores,
+     * refs, or computed values that shouldn't trigger re-renders.
+     */
+    addDynamicProvider(key: string, provider: DynamicContextProvider): void;
+    /**
+     * Remove a dynamic context provider.
+     */
+    removeDynamicProvider(key: string): boolean;
+    /**
+     * Build a snapshot of the current client context.
+     * Evaluates every registered dynamic provider. Returns `null` when there is
+     * nothing to report.
+     */
+    getSnapshot(): ContextSnapshot | null;
+    /**
+     * Remove all entries and dynamic providers.
+     */
+    clear(): void;
+}

package/dist/streaming/helpers.d.ts

@@ -0,0 +1,67 @@
+import type { AgoClient } from "../client/AgoClient";
+import type { AgoMessage, AgoClientEvents, ToolCallData, ClientFunctionInvocation } from "../client/types";
+/**
+ * Subscribe to complete messages with a simple callback. Returns an unsubscribe function.
+ *
+ * ```ts
+ * const unsub = onMessage(client, (msg) => console.log(msg.content));
+ * // later: unsub();
+ * ```
+ */
+export declare function onMessage(client: AgoClient, callback: (message: AgoMessage) => void): () => void;
+/**
+ * Subscribe to streaming text chunks.
+ *
+ * ```ts
+ * onMessageChunk(client, ({ content }) => {
+ *   outputEl.textContent += content;
+ * });
+ * ```
+ */
+export declare function onMessageChunk(client: AgoClient, callback: (data: AgoClientEvents["message:chunk"]) => void): () => void;
+/**
+ * Subscribe to message start events.
+ */
+export declare function onMessageStart(client: AgoClient, callback: (data: AgoClientEvents["message:start"]) => void): () => void;
+/**
+ * Subscribe to message errors.
+ */
+export declare function onMessageError(client: AgoClient, callback: (data: AgoClientEvents["message:error"]) => void): () => void;
+/**
+ * Subscribe to tool call events.
+ */
+export declare function onToolCall(client: AgoClient, callback: (toolCall: ToolCallData) => void): () => void;
+/**
+ * Subscribe to client function invocations.
+ */
+export declare function onFunctionInvoke(client: AgoClient, callback: (data: ClientFunctionInvocation) => void): () => void;
+/**
+ * Send a message and iterate over chunks as an async generator.
+ * Gives you full control over how you process the stream.
+ *
+ * ```ts
+ * for await (const chunk of createMessageStream(client, "Hello!")) {
+ *   console.log(chunk.type, chunk.data);
+ * }
+ * ```
+ */
+export declare function createMessageStream(client: AgoClient, content: string, options?: {
+    conversationId?: string;
+    agentId?: string;
+    files?: File[];
+}): AsyncGenerator<{
+    type: "start";
+    data: AgoClientEvents["message:start"];
+} | {
+    type: "chunk";
+    data: AgoClientEvents["message:chunk"];
+} | {
+    type: "complete";
+    data: AgoMessage;
+} | {
+    type: "error";
+    data: AgoClientEvents["message:error"];
+} | {
+    type: "toolCall";
+    data: ToolCallData;
+}>;

package/dist/vue/composables/useAgo.d.ts

@@ -0,0 +1,17 @@
+import { AgoClient } from "../../client/AgoClient";
+import type { AgoConfig } from "../../client/types";
+/**
+ * Get or create an AgoClient.
+ *
+ * - Without args: returns the client from `AgoPlugin` (throws if none).
+ * - With config: creates a new client instance.
+ *
+ * ```ts
+ * // From plugin
+ * const client = useAgo();
+ *
+ * // Standalone
+ * const client = useAgo({ baseUrl: "https://YOUR-DOMAIN.useago.com" });
+ * ```
+ */
+export declare function useAgo(config?: AgoConfig): AgoClient;

package/dist/vue/composables/useAgoEvents.d.ts

@@ -0,0 +1,11 @@
+import type { AgoClientEvents, AgoEventName } from "../../client/types";
+/**
+ * Subscribe to AGO client events with auto-cleanup on unmount.
+ *
+ * ```ts
+ * useAgoEvents("message:complete", (msg) => {
+ *   console.log("Got message:", msg.content);
+ * });
+ * ```
+ */
+export declare function useAgoEvents<K extends AgoEventName>(event: K, handler: (data: AgoClientEvents[K]) => void): void;

package/dist/vue/composables/useAgoFunction.d.ts

@@ -0,0 +1,34 @@
+import type { ClientFunctionHandler, ClientFunctionSchema } from "../../functions/types";
+/**
+ * Register a client-side function with auto-cleanup on unmount.
+ *
+ * ```ts
+ * useAgoFunction("showToast", {
+ *   description: "Show a toast",
+ *   parameters: { type: "object", properties: { message: { type: "string" } } },
+ *   handler: async (args) => { toast(args.message); return { shown: true }; },
+ * });
+ * ```
+ */
+export declare function useAgoFunction(name: string, options: {
+    description: string;
+    parameters: ClientFunctionSchema["parameters"];
+    handler: ClientFunctionHandler;
+}): void;
+export interface AgoRoute {
+    name: string;
+    path: string;
+    description: string;
+}
+/**
+ * Register navigation routes with auto-cleanup on unmount.
+ * Works with vue-router's `useRouter().push`.
+ *
+ * ```ts
+ * const router = useRouter();
+ * useAgoNavigation((path) => router.push(path), [
+ *   { name: "dashboard", path: "/dashboard", description: "Main dashboard" },
+ * ]);
+ * ```
+ */
+export declare function useAgoNavigation(navigate: (path: string) => void, routes: AgoRoute[]): void;

package/dist/vue/composables/useChat.d.ts

@@ -0,0 +1,251 @@
+import type { AgoClient } from "../../client/AgoClient";
+export interface UseChatOptions {
+    client?: AgoClient;
+    conversationId?: string;
+    autoLoad?: boolean;
+}
+/**
+ * All-in-one composable combining messages + conversations.
+ *
+ * ```ts
+ * const { messages, sendMessage, conversations, selectConversation } = useChat();
+ * ```
+ */
+export declare function useChat(options?: UseChatOptions): {
+    messages: import("vue").Ref<{
+        id: string;
+        conversationId: string;
+        content: string;
+        role: "user" | "assistant";
+        status: import("../..").MessageStatus;
+        agent?: {
+            id: string;
+            name: string;
+            displayName?: string | undefined;
+        } | undefined;
+        sources?: {
+            id: string;
+            title: string;
+            url?: string | undefined;
+        }[] | undefined;
+        toolCalls?: {
+            id: string;
+            type: import("../..").ToolCallType;
+            status: string;
+            toolName: string;
+            toolDisplayName?: string | undefined;
+            message?: string | undefined;
+            formSchema?: {
+                type: "object";
+                properties: Record<string, import("../..").FormField>;
+                required?: string[] | undefined;
+            } | undefined;
+            data?: Record<string, unknown> | undefined;
+            functionName?: string | undefined;
+            arguments?: Record<string, unknown> | undefined;
+        }[] | undefined;
+        followUpReplies?: string[] | undefined;
+        createdAt: Date;
+    }[], import("..").AgoMessage[] | {
+        id: string;
+        conversationId: string;
+        content: string;
+        role: "user" | "assistant";
+        status: import("../..").MessageStatus;
+        agent?: {
+            id: string;
+            name: string;
+            displayName?: string | undefined;
+        } | undefined;
+        sources?: {
+            id: string;
+            title: string;
+            url?: string | undefined;
+        }[] | undefined;
+        toolCalls?: {
+            id: string;
+            type: import("../..").ToolCallType;
+            status: string;
+            toolName: string;
+            toolDisplayName?: string | undefined;
+            message?: string | undefined;
+            formSchema?: {
+                type: "object";
+                properties: Record<string, import("../..").FormField>;
+                required?: string[] | undefined;
+            } | undefined;
+            data?: Record<string, unknown> | undefined;
+            functionName?: string | undefined;
+            arguments?: Record<string, unknown> | undefined;
+        }[] | undefined;
+        followUpReplies?: string[] | undefined;
+        createdAt: Date;
+    }[]>;
+    isLoading: import("vue").Ref<boolean, boolean>;
+    error: import("vue").ComputedRef<Error | null>;
+    sendMessage: (content: string, files?: File[]) => Promise<import("..").AgoMessage | null>;
+    clearMessages: () => void;
+    conversationId: import("vue").Ref<string | undefined, string | undefined>;
+    conversations: import("vue").Ref<{
+        id: string;
+        title: string;
+        lastMessageDate: Date;
+        messages?: {
+            id: string;
+            conversationId: string;
+            content: string;
+            role: "user" | "assistant";
+            status: import("../..").MessageStatus;
+            agent?: {
+                id: string;
+                name: string;
+                displayName?: string | undefined;
+            } | undefined;
+            sources?: {
+                id: string;
+                title: string;
+                url?: string | undefined;
+            }[] | undefined;
+            toolCalls?: {
+                id: string;
+                type: import("../..").ToolCallType;
+                status: string;
+                toolName: string;
+                toolDisplayName?: string | undefined;
+                message?: string | undefined;
+                formSchema?: {
+                    type: "object";
+                    properties: Record<string, import("../..").FormField>;
+                    required?: string[] | undefined;
+                } | undefined;
+                data?: Record<string, unknown> | undefined;
+                functionName?: string | undefined;
+                arguments?: Record<string, unknown> | undefined;
+            }[] | undefined;
+            followUpReplies?: string[] | undefined;
+            createdAt: Date;
+        }[] | undefined;
+    }[], import("..").Conversation[] | {
+        id: string;
+        title: string;
+        lastMessageDate: Date;
+        messages?: {
+            id: string;
+            conversationId: string;
+            content: string;
+            role: "user" | "assistant";
+            status: import("../..").MessageStatus;
+            agent?: {
+                id: string;
+                name: string;
+                displayName?: string | undefined;
+            } | undefined;
+            sources?: {
+                id: string;
+                title: string;
+                url?: string | undefined;
+            }[] | undefined;
+            toolCalls?: {
+                id: string;
+                type: import("../..").ToolCallType;
+                status: string;
+                toolName: string;
+                toolDisplayName?: string | undefined;
+                message?: string | undefined;
+                formSchema?: {
+                    type: "object";
+                    properties: Record<string, import("../..").FormField>;
+                    required?: string[] | undefined;
+                } | undefined;
+                data?: Record<string, unknown> | undefined;
+                functionName?: string | undefined;
+                arguments?: Record<string, unknown> | undefined;
+            }[] | undefined;
+            followUpReplies?: string[] | undefined;
+            createdAt: Date;
+        }[] | undefined;
+    }[]>;
+    currentConversation: import("vue").Ref<{
+        id: string;
+        title: string;
+        lastMessageDate: Date;
+        messages?: {
+            id: string;
+            conversationId: string;
+            content: string;
+            role: "user" | "assistant";
+            status: import("../..").MessageStatus;
+            agent?: {
+                id: string;
+                name: string;
+                displayName?: string | undefined;
+            } | undefined;
+            sources?: {
+                id: string;
+                title: string;
+                url?: string | undefined;
+            }[] | undefined;
+            toolCalls?: {
+                id: string;
+                type: import("../..").ToolCallType;
+                status: string;
+                toolName: string;
+                toolDisplayName?: string | undefined;
+                message?: string | undefined;
+                formSchema?: {
+                    type: "object";
+                    properties: Record<string, import("../..").FormField>;
+                    required?: string[] | undefined;
+                } | undefined;
+                data?: Record<string, unknown> | undefined;
+                functionName?: string | undefined;
+                arguments?: Record<string, unknown> | undefined;
+            }[] | undefined;
+            followUpReplies?: string[] | undefined;
+            createdAt: Date;
+        }[] | undefined;
+    } | null, import("..").Conversation | {
+        id: string;
+        title: string;
+        lastMessageDate: Date;
+        messages?: {
+            id: string;
+            conversationId: string;
+            content: string;
+            role: "user" | "assistant";
+            status: import("../..").MessageStatus;
+            agent?: {
+                id: string;
+                name: string;
+                displayName?: string | undefined;
+            } | undefined;
+            sources?: {
+                id: string;
+                title: string;
+                url?: string | undefined;
+            }[] | undefined;
+            toolCalls?: {
+                id: string;
+                type: import("../..").ToolCallType;
+                status: string;
+                toolName: string;
+                toolDisplayName?: string | undefined;
+                message?: string | undefined;
+                formSchema?: {
+                    type: "object";
+                    properties: Record<string, import("../..").FormField>;
+                    required?: string[] | undefined;
+                } | undefined;
+                data?: Record<string, unknown> | undefined;
+                functionName?: string | undefined;
+                arguments?: Record<string, unknown> | undefined;
+            }[] | undefined;
+            followUpReplies?: string[] | undefined;
+            createdAt: Date;
+        }[] | undefined;
+    } | null>;
+    isConversationsLoading: import("vue").Ref<boolean, boolean>;
+    selectConversation: (id: string) => Promise<void>;
+    startNewConversation: () => void;
+    refreshConversations: () => Promise<void>;
+};

package/dist/vue/composables/useConversation.d.ts

@@ -0,0 +1,178 @@
+import type { AgoClient } from "../../client/AgoClient";
+import type { Conversation } from "../../client/types";
+export interface UseConversationOptions {
+    client?: AgoClient;
+    autoLoad?: boolean;
+}
+/**
+ * Composable to manage conversations.
+ *
+ * ```ts
+ * const { conversations, selectConversation } = useConversation();
+ * ```
+ */
+export declare function useConversation(options?: UseConversationOptions): {
+    conversations: import("vue").Ref<{
+        id: string;
+        title: string;
+        lastMessageDate: Date;
+        messages?: {
+            id: string;
+            conversationId: string;
+            content: string;
+            role: "user" | "assistant";
+            status: import("../..").MessageStatus;
+            agent?: {
+                id: string;
+                name: string;
+                displayName?: string | undefined;
+            } | undefined;
+            sources?: {
+                id: string;
+                title: string;
+                url?: string | undefined;
+            }[] | undefined;
+            toolCalls?: {
+                id: string;
+                type: import("../..").ToolCallType;
+                status: string;
+                toolName: string;
+                toolDisplayName?: string | undefined;
+                message?: string | undefined;
+                formSchema?: {
+                    type: "object";
+                    properties: Record<string, import("../..").FormField>;
+                    required?: string[] | undefined;
+                } | undefined;
+                data?: Record<string, unknown> | undefined;
+                functionName?: string | undefined;
+                arguments?: Record<string, unknown> | undefined;
+            }[] | undefined;
+            followUpReplies?: string[] | undefined;
+            createdAt: Date;
+        }[] | undefined;
+    }[], Conversation[] | {
+        id: string;
+        title: string;
+        lastMessageDate: Date;
+        messages?: {
+            id: string;
+            conversationId: string;
+            content: string;
+            role: "user" | "assistant";
+            status: import("../..").MessageStatus;
+            agent?: {
+                id: string;
+                name: string;
+                displayName?: string | undefined;
+            } | undefined;
+            sources?: {
+                id: string;
+                title: string;
+                url?: string | undefined;
+            }[] | undefined;
+            toolCalls?: {
+                id: string;
+                type: import("../..").ToolCallType;
+                status: string;
+                toolName: string;
+                toolDisplayName?: string | undefined;
+                message?: string | undefined;
+                formSchema?: {
+                    type: "object";
+                    properties: Record<string, import("../..").FormField>;
+                    required?: string[] | undefined;
+                } | undefined;
+                data?: Record<string, unknown> | undefined;
+                functionName?: string | undefined;
+                arguments?: Record<string, unknown> | undefined;
+            }[] | undefined;
+            followUpReplies?: string[] | undefined;
+            createdAt: Date;
+        }[] | undefined;
+    }[]>;
+    currentConversation: import("vue").Ref<{
+        id: string;
+        title: string;
+        lastMessageDate: Date;
+        messages?: {
+            id: string;
+            conversationId: string;
+            content: string;
+            role: "user" | "assistant";
+            status: import("../..").MessageStatus;
+            agent?: {
+                id: string;
+                name: string;
+                displayName?: string | undefined;
+            } | undefined;
+            sources?: {
+                id: string;
+                title: string;
+                url?: string | undefined;
+            }[] | undefined;
+            toolCalls?: {
+                id: string;
+                type: import("../..").ToolCallType;
+                status: string;
+                toolName: string;
+                toolDisplayName?: string | undefined;
+                message?: string | undefined;
+                formSchema?: {
+                    type: "object";
+                    properties: Record<string, import("../..").FormField>;
+                    required?: string[] | undefined;
+                } | undefined;
+                data?: Record<string, unknown> | undefined;
+                functionName?: string | undefined;
+                arguments?: Record<string, unknown> | undefined;
+            }[] | undefined;
+            followUpReplies?: string[] | undefined;
+            createdAt: Date;
+        }[] | undefined;
+    } | null, Conversation | {
+        id: string;
+        title: string;
+        lastMessageDate: Date;
+        messages?: {
+            id: string;
+            conversationId: string;
+            content: string;
+            role: "user" | "assistant";
+            status: import("../..").MessageStatus;
+            agent?: {
+                id: string;
+                name: string;
+                displayName?: string | undefined;
+            } | undefined;
+            sources?: {
+                id: string;
+                title: string;
+                url?: string | undefined;
+            }[] | undefined;
+            toolCalls?: {
+                id: string;
+                type: import("../..").ToolCallType;
+                status: string;
+                toolName: string;
+                toolDisplayName?: string | undefined;
+                message?: string | undefined;
+                formSchema?: {
+                    type: "object";
+                    properties: Record<string, import("../..").FormField>;
+                    required?: string[] | undefined;
+                } | undefined;
+                data?: Record<string, unknown> | undefined;
+                functionName?: string | undefined;
+                arguments?: Record<string, unknown> | undefined;
+            }[] | undefined;
+            followUpReplies?: string[] | undefined;
+            createdAt: Date;
+        }[] | undefined;
+    } | null>;
+    isLoading: import("vue").Ref<boolean, boolean>;
+    error: import("vue").Ref<Error | null, Error | null>;
+    selectConversation: (id: string) => Promise<void>;
+    startNewConversation: () => void;
+    refreshConversations: () => Promise<void>;
+};