@economic/agents-react 1.1.1 → 1.1.3

package/dist/index.d.mts

@@ -14,20 +14,20 @@ interface IntermediateEventTarget<EventMap> extends EventTarget {
   removeEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: EventListenerOptions | boolean): void;
 } //#endregion
 //#region src/ws.d.ts
-declare class ErrorEvent extends Event {
+declare class ErrorEvent$1 extends Event {
   message: string;
   error: Error;
   constructor(error: Error, target: any);
 }
-declare class CloseEvent extends Event {
+declare class CloseEvent$1 extends Event {
   code: number;
   reason: string;
   wasClean: boolean;
   constructor(code: number | undefined, reason: string | undefined, target: any);
 }
 interface WebSocketEventMap {
-  close: CloseEvent;
-  error: ErrorEvent;
+  close: CloseEvent$1;
+  error: ErrorEvent$1;
   message: MessageEvent;
   open: Event;
 }
@@ -110,11 +110,11 @@ declare class ReconnectingWebSocket extends ReconnectingWebSocket_base {
   /**
    * An event listener to be called when the WebSocket connection's readyState changes to CLOSED
    */
-  onclose: ((event: CloseEvent) => void) | null;
+  onclose: ((event: CloseEvent$1) => void) | null;
   /**
    * An event listener to be called when an error occurs
    */
-  onerror: ((event: ErrorEvent) => void) | null;
+  onerror: ((event: ErrorEvent$1) => void) | null;
   /**
    * An event listener to be called when a message is received from the server
    */
@@ -219,13 +219,17 @@ type AgentConnectionState = {
 interface UseAgentOptions {
   host: string;
   agentName: string;
-  id: string;
   enabled?: boolean;
   sub?: {
     agent: string;
     name: string;
   }[];
+  onOpen?: (event: Event) => void;
+  onClose?: (event: CloseEvent) => void;
+  onError?: (event: ErrorEvent) => void;
   authToken?: string;
+  userId?: string;
+  id: string;
 }
 declare function useAgent<T extends AgentConnectionState>(options: UseAgentOptions): Omit<PartySocket, "path"> & {
   agent: string;
@@ -243,30 +247,13 @@ declare function useAgent<T extends AgentConnectionState>(options: UseAgentOptio
   getHttpUrl: () => string;
 };
 //#endregion
-//#region src/useAssistant.d.ts
-/** Conversation summary returned by the assistant's `getConversations` RPC. */
-type Conversation = {
-  durable_object_name: string;
-  title?: string;
-  summary?: string;
-  created_at: number;
-  updated_at: number;
-};
-interface UseAssistantOptions<ToolContext extends Record<string, unknown> = Record<string, unknown>> {
-  host: string;
-  assistantName: string;
-  userId: string;
-  chatId?: string;
-  authToken?: string;
+//#region src/useChatAgent.d.ts
+interface UseChatOptions<ToolContext extends Record<string, unknown>> extends UseAgentOptions {
   toolContext?: ToolContext;
+  welcomeMessage?: string;
 }
-declare function useAssistant<ToolContext extends Record<string, unknown>>(options: UseAssistantOptions<ToolContext>): {
-  chatId: string | undefined;
+declare function useChatAgent<ToolContext extends Record<string, unknown>>(options: UseChatOptions<ToolContext>): {
   status: AgentConnectionStatus;
-  getConversations: () => Promise<Conversation[]>;
-  createConversation: () => Promise<string>;
-  openConversation: (chatId: string) => void;
-  deleteConversation: (chatId: string) => Promise<void>;
   agent: Omit<PartySocket, "path"> & {
     agent: string;
     name: string;
@@ -282,7 +269,7 @@ declare function useAssistant<ToolContext extends Record<string, unknown>>(optio
     stub: _$agents_client0.UntypedAgentStub;
     getHttpUrl: () => string;
   };
-  chat: (Omit<_$_ai_sdk_react0.UseChatHelpers<_$ai.UIMessage<unknown, _$ai.UIDataTypes, _$ai.UITools>>, "addToolOutput"> & {
+  chat: Omit<_$_ai_sdk_react0.UseChatHelpers<_$ai.UIMessage<unknown, _$ai.UIDataTypes, _$ai.UITools>>, "addToolOutput"> & {
     clearHistory: () => void;
     addToolOutput: (opts: {
       toolCallId: string;
@@ -294,19 +281,31 @@ declare function useAssistant<ToolContext extends Record<string, unknown>>(optio
     isServerStreaming: boolean;
     isStreaming: boolean;
     isToolContinuation: boolean;
-  }) | undefined;
+  };
+  rateMessage: (messageId: string, rating: number, comment?: string) => Promise<unknown>;
+  getMessageRatings: () => Promise<unknown>;
 };
 //#endregion
-//#region src/useChatAgent.d.ts
-interface UseChatOptions<ToolContext extends Record<string, unknown>> {
-  host: string;
-  agentName: string;
-  id: string;
-  authToken?: string;
-  toolContext?: ToolContext;
+//#region src/useAssistant.d.ts
+/** Conversation summary returned by the assistant's `getConversations` RPC. */
+type Conversation = {
+  durable_object_name: string;
+  title?: string;
+  summary?: string;
+  created_at: number;
+  updated_at: number;
+};
+interface UseAssistantOptions<ToolContext extends Record<string, unknown> = Record<string, unknown>> extends Omit<UseChatOptions<ToolContext>, "id" | "userId"> {
+  userId: string;
+  initialChatId?: string;
 }
-declare function useChatAgent<ToolContext extends Record<string, unknown>>(options: UseChatOptions<ToolContext>): {
+declare function useAssistant<ToolContext extends Record<string, unknown>>(options: UseAssistantOptions<ToolContext>): {
+  chatId: string | undefined;
   status: AgentConnectionStatus;
+  getConversations: () => Promise<Conversation[]>;
+  createConversation: () => Promise<string>;
+  openConversation: (chatId: string) => void;
+  deleteConversation: (chatId: string) => Promise<void>;
   agent: Omit<PartySocket, "path"> & {
     agent: string;
     name: string;
@@ -322,7 +321,7 @@ declare function useChatAgent<ToolContext extends Record<string, unknown>>(optio
     stub: _$agents_client0.UntypedAgentStub;
     getHttpUrl: () => string;
   };
-  chat: Omit<_$_ai_sdk_react0.UseChatHelpers<_$ai.UIMessage<unknown, _$ai.UIDataTypes, _$ai.UITools>>, "addToolOutput"> & {
+  chat: (Omit<_$_ai_sdk_react0.UseChatHelpers<_$ai.UIMessage<unknown, _$ai.UIDataTypes, _$ai.UITools>>, "addToolOutput"> & {
     clearHistory: () => void;
     addToolOutput: (opts: {
       toolCallId: string;
@@ -334,7 +333,7 @@ declare function useChatAgent<ToolContext extends Record<string, unknown>>(optio
     isServerStreaming: boolean;
     isStreaming: boolean;
     isToolContinuation: boolean;
-  };
+  }) | undefined;
 };
 //#endregion
 export { AgentConnectionState, AgentConnectionStatus, AgentConnectionType, Conversation, UseAgentOptions, UseAssistantOptions, UseChatOptions, useAgent, useAssistant, useChatAgent };

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { useAgent as useAgent$1 } from "agents/react";
 import { useAgentChat } from "@cloudflare/ai-chat/react";
-import { useState } from "react";
+import { useEffect, useRef, useState } from "react";
 //#region src/util.ts
 function getTokenArgs(authToken) {
 	if (!authToken) return {};
@@ -12,28 +12,30 @@ function getTokenArgs(authToken) {
 //#endregion
 //#region src/useAgent.ts
 function useAgent(options) {
-	const { host, agentName, id, enabled, sub, authToken } = options;
+	const { host, agentName, userId, id, enabled, sub, authToken, onError, onOpen, onClose } = options;
 	return useAgent$1({
 		enabled,
 		host,
 		agent: agentName,
-		name: id,
+		name: userId ? `${userId}:${id}` : id,
 		sub,
+		onOpen,
+		onClose,
+		onError,
 		...getTokenArgs(authToken)
 	});
 }
 //#endregion
 //#region src/useAssistant.ts
 function useAssistant(options) {
-	const { host, assistantName, userId, chatId: initialChatId, authToken, toolContext } = options;
-	const config = {
+	const { host, agentName, userId, authToken, toolContext, ...agentOptions } = options;
+	const [chatId, setChatId] = useState();
+	const assistant = useAgent({
 		host,
-		agentName: assistantName,
+		agentName,
 		id: userId,
 		authToken
-	};
-	const [chatId, setChatId] = useState(initialChatId);
-	const assistant = useAgent(config);
+	});
 	const getConversations = async () => {
 		return await assistant.call("getConversations");
 	};
@@ -52,12 +54,16 @@ function useAssistant(options) {
 		await getConversations();
 	};
 	const agent = useAgent({
-		...config,
 		enabled: !!chatId,
+		host,
+		agentName,
+		id: userId,
+		authToken,
 		sub: chatId ? [{
 			agent: assistant.state?.subAgentName ?? "",
 			name: chatId
-		}] : void 0
+		}] : void 0,
+		...agentOptions
 	});
 	const isChatReady = !!chatId && agent.state?.status === "connected";
 	const chat = useAgentChat({
@@ -79,21 +85,47 @@ function useAssistant(options) {
 //#endregion
 //#region src/useChatAgent.ts
 function useChatAgent(options) {
-	const { host, agentName, id, authToken, toolContext } = options;
-	const agent = useAgent({
-		host,
-		agentName,
-		id,
-		authToken
-	});
+	const { toolContext, welcomeMessage, ...agentOptions } = options;
+	const agent = useAgent(agentOptions);
 	const chat = useAgentChat({
 		agent,
 		body: toolContext ?? {}
 	});
+	const status = agent.state?.status ?? "connecting";
+	const hasSentWelcome = useRef(false);
+	useEffect(() => {
+		if (welcomeMessage && status === "connected" && chat.messages.length === 0 && !hasSentWelcome.current) {
+			hasSentWelcome.current = true;
+			chat.setMessages([{
+				id: "welcome-message",
+				role: "assistant",
+				parts: [{
+					type: "text",
+					text: welcomeMessage
+				}]
+			}]);
+		}
+	}, [
+		status,
+		chat.messages.length,
+		welcomeMessage
+	]);
+	async function rateMessage(messageId, rating, comment) {
+		return agent.call("rateMessage", [
+			messageId,
+			rating,
+			comment
+		]);
+	}
+	async function getMessageRatings() {
+		return agent.call("getMessageRatings");
+	}
 	return {
-		status: agent.state?.status ?? "connecting",
+		status,
 		agent,
-		chat
+		chat,
+		rateMessage,
+		getMessageRatings
 	};
 }
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@economic/agents-react",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "license": "MIT",
   "files": [
     "dist"