feat: remove -Instance suffix and rename to useXXXReturn

Author: 1egoman

packages/react/src/hooks/useAgent.ts

@@ -142,7 +142,7 @@ type AgentActions = {
 };
 
 type AgentStateCases = AgentStateConnecting | AgentStateAvailable | AgentStateAvailableListening | AgentStateUnAvailable | AgentStateFailed;
-export type AgentInstance = AgentStateCases & AgentActions;
+export type UseAgentReturn = AgentStateCases & AgentActions;
 
 const generateDerivedStateValues = <State extends AgentState>(state: State) => ({
   isAvailable: (
@@ -240,7 +240,7 @@ type ConversationStub = Pick<ConversationInstance, 'connectionState' | 'subtle'>
 /**
   * useAgent encapculates all agent state, normalizing some quirks around how LiveKit Agents work.
   */
-export function useAgent(conversation: ConversationStub, _name?: string): AgentInstance {
+export function useAgent(conversation: ConversationStub, _name?: string): UseAgentReturn {
   const { room } = conversation.subtle;
 
   const emitter = useMemo(() => new EventEmitter() as TypedEventEmitter<AgentCallbacks>, []);
@@ -268,7 +268,7 @@ export function useAgent(conversation: ConversationStub, _name?: string): AgentI
       return;
     }
 
-    const handleAttributesChanged = (attributes: AgentInstance["attributes"]) => {
+    const handleAttributesChanged = (attributes: UseAgentReturn["attributes"]) => {
       setAgentParticipantAttributes(attributes);
       emitter.emit(AgentEvent.AttributesChanged, attributes);
     };

packages/react/src/hooks/useConversationWith.ts

@@ -116,13 +116,13 @@ type ConversationActions = {
   end: () => Promise<void>;
 };
 
-export type ConversationInstance = (ConversationStateConnecting | ConversationStateConnected | ConversationStateDisconnected) & ConversationActions;
+export type UseConversationReturn = (ConversationStateConnecting | ConversationStateConnected | ConversationStateDisconnected) & ConversationActions;
 
 /**
  * AgentSession represents a connection to a LiveKit Agent, providing abstractions to make 1:1
  * agent/participant rooms easier to work with.
  */
-export function useConversationWith(agentToDispatch: string | RoomAgentDispatch | null, options: ConversationOptions): ConversationInstance {
+export function useConversationWith(agentToDispatch: string | RoomAgentDispatch | null, options: ConversationOptions): UseConversationReturn {
   const roomFromContext = useMaybeRoomContext();
   const room = useMemo(() => roomFromContext ?? options.room ?? new Room(), [roomFromContext, options.room]);
 
@@ -145,7 +145,7 @@ export function useConversationWith(agentToDispatch: string | RoomAgentDispatch
     };
   }, [options.tokenSource]);
 
-  const generateDerivedConnectionStateValues = useCallback(<State extends ConversationInstance["connectionState"]>(connectionState: State) => ({
+  const generateDerivedConnectionStateValues = useCallback(<State extends UseConversationReturn["connectionState"]>(connectionState: State) => ({
     isConnected: (
       connectionState === ConnectionState.Connected ||
       connectionState === ConnectionState.Reconnecting ||
@@ -275,13 +275,13 @@ export function useConversationWith(agentToDispatch: string | RoomAgentDispatch
     emitter.emit(ConversationEvent.ConnectionStateChanged, conversationState.connectionState);
   }, [emitter, conversationState.connectionState]);
 
-  const waitUntilConnectionState = useCallback(async (state: ConversationInstance["connectionState"], signal?: AbortSignal) => {
+  const waitUntilConnectionState = useCallback(async (state: UseConversationReturn["connectionState"], signal?: AbortSignal) => {
     if (conversationState.connectionState === state) {
       return;
     }
 
     return new Promise<void>((resolve, reject) => {
-      const onceEventOccurred = (newState: ConversationInstance["connectionState"]) => {
+      const onceEventOccurred = (newState: UseConversationReturn["connectionState"]) => {
         if (newState !== state) {
           return;
         }
@@ -393,6 +393,6 @@ export function useConversationWith(agentToDispatch: string | RoomAgentDispatch
   ]);
 }
 
-export function useConversation(options: ConversationOptions): ConversationInstance {
+export function useConversation(options: ConversationOptions): UseConversationReturn {
   return useConversationWith(null, options);
 }