@rqmii_immersive/agent-react-sdk 1.0.0 → 1.0.2

package/README.frameworks.md

@@ -15,8 +15,8 @@ npm install @rqmii_immersive/agent-react-sdk
 `.env`:
 
 ```env
-VITE_FASTAPI_BACKEND_URL=https://api.example.com
-VITE_WS_AUDIO_URL=wss://realtime.example.com
+VITE_AGENT_API_URL=https://api.example.com
+VITE_AGENT_WS_URL=wss://realtime.example.com
 ```
 
 ### App Example
@@ -35,8 +35,8 @@ function UI() {
 export default function App() {
   return (
     <RqmiiAgentRoom
-      wsUrl={import.meta.env.VITE_WS_AUDIO_URL}
-      restUrl={import.meta.env.VITE_FASTAPI_BACKEND_URL}
+      wsUrl={import.meta.env.VITE_AGENT_WS_URL}
+      restUrl={import.meta.env.VITE_AGENT_API_URL}
       session={{ mode: "initialize", apiKey: "YOUR_API_KEY", language: "en" }}
       connect
     >
@@ -61,8 +61,8 @@ npm install @rqmii_immersive/agent-react-sdk
 `.env.local`:
 
 ```env
-NEXT_PUBLIC_FASTAPI_BACKEND_URL=https://api.example.com
-NEXT_PUBLIC_WS_AUDIO_URL=wss://realtime.example.com
+NEXT_PUBLIC_AGENT_API_URL=https://api.example.com
+NEXT_PUBLIC_AGENT_WS_URL=wss://realtime.example.com
 ```
 
 ### Client Component
@@ -94,8 +94,8 @@ function UI() {
 export default function AgentPage() {
   return (
     <RqmiiAgentRoom
-      wsUrl={process.env.NEXT_PUBLIC_WS_AUDIO_URL}
-      restUrl={process.env.NEXT_PUBLIC_FASTAPI_BACKEND_URL}
+      wsUrl={process.env.NEXT_PUBLIC_AGENT_WS_URL}
+      restUrl={process.env.NEXT_PUBLIC_AGENT_API_URL}
       session={{ mode: "initialize", apiKey: "YOUR_API_KEY", language: "en" }}
       connect
     >
@@ -124,8 +124,8 @@ npm install @rqmii_immersive/agent-react-sdk
 `.env`:
 
 ```env
-REACT_APP_FASTAPI_BACKEND_URL=https://api.example.com
-REACT_APP_WS_AUDIO_URL=wss://realtime.example.com
+REACT_APP_AGENT_API_URL=https://api.example.com
+REACT_APP_AGENT_WS_URL=wss://realtime.example.com
 ```
 
 ### App Example
@@ -144,8 +144,8 @@ function UI() {
 export default function App() {
   return (
     <RqmiiAgentRoom
-      wsUrl={process.env.REACT_APP_WS_AUDIO_URL}
-      restUrl={process.env.REACT_APP_FASTAPI_BACKEND_URL}
+      wsUrl={process.env.REACT_APP_AGENT_WS_URL}
+      restUrl={process.env.REACT_APP_AGENT_API_URL}
       session={{ mode: "initialize", apiKey: "YOUR_API_KEY", language: "en" }}
       connect
     >

package/README.md

@@ -1,15 +1,6 @@
 # Rqmii React Agent SDK
 
-Standalone React SDK for integrating React apps with:
-
-- `RqmiiAgentBackendAPI` REST endpoints (`/sessions/init`, `/sessions/join`)
-- `RqmiiAgentBackendJs` realtime Socket.IO server
-
-Quick navigation:
-
-- Full guide: `README.md` (this file)
-- Simple guide: `README.simple.md`
-- Framework recipes (Vite/Next.js/CRA): `README.frameworks.md`
+Standalone React SDK for building realtime agent experiences in web apps.
 
 This SDK gives you a LiveKit-style integration model:
 
@@ -29,18 +20,18 @@ If you are testing locally from this mono-repo:
 npm install file:../RqmiiAgentReactSDK
 ```
 
-## 2. Required Backend Configuration
+## 2. Required Configuration
 
 You must provide both URLs to the SDK:
 
-- `restUrl`: FastAPI backend base URL (for session init/join)
-- `wsUrl`: realtime coordinator Socket.IO URL
+- `restUrl`: REST API base URL (for session init/join)
+- `wsUrl`: realtime Socket.IO URL
 
 Typical env values:
 
 ```env
-VITE_FASTAPI_BACKEND_URL=https://api.example.com
-VITE_WS_AUDIO_URL=wss://realtime.example.com
+VITE_AGENT_API_URL=https://api.example.com
+VITE_AGENT_WS_URL=wss://realtime.example.com
 ```
 
 ## 3. Import Surface
@@ -109,8 +100,8 @@ function ChatUI() {
 export default function App() {
   return (
     <RqmiiAgentRoom
-      wsUrl={import.meta.env.VITE_WS_AUDIO_URL}
-      restUrl={import.meta.env.VITE_FASTAPI_BACKEND_URL}
+      wsUrl={import.meta.env.VITE_AGENT_WS_URL}
+      restUrl={import.meta.env.VITE_AGENT_API_URL}
       session={{ mode: "initialize", apiKey: "YOUR_API_KEY", language: "en" }}
       connect
       onError={(e) => console.error(e)}
@@ -427,4 +418,5 @@ Check:
 
 ## 14. Current Scope
 
-This SDK currently targets React integration and browser runtime. If you need Next.js SSR-specific wrappers or TypeScript declaration generation (`.d.ts`), add them in your package pipeline as a next step.
+This SDK supports React, TypeScript (ships `.d.ts`), and Next.js client-side integration.
+Use it inside client components (`"use client"`), since realtime sockets/media APIs are browser runtime features.

package/README.simple.md

@@ -12,14 +12,14 @@ npm install @rqmii_immersive/agent-react-sdk
 
 You need:
 
-- `restUrl` -> FastAPI backend URL
+- `restUrl` -> REST API URL
 - `wsUrl` -> realtime Socket.IO URL
 
 Example env:
 
 ```env
-VITE_FASTAPI_BACKEND_URL=https://api.example.com
-VITE_WS_AUDIO_URL=wss://realtime.example.com
+VITE_AGENT_API_URL=https://api.example.com
+VITE_AGENT_WS_URL=wss://realtime.example.com
 ```
 
 ## Basic Usage
@@ -55,8 +55,8 @@ function ChatUI() {
 export default function App() {
   return (
     <RqmiiAgentRoom
-      wsUrl={import.meta.env.VITE_WS_AUDIO_URL}
-      restUrl={import.meta.env.VITE_FASTAPI_BACKEND_URL}
+      wsUrl={import.meta.env.VITE_AGENT_WS_URL}
+      restUrl={import.meta.env.VITE_AGENT_API_URL}
       session={{ mode: "initialize", apiKey: "YOUR_API_KEY", language: "en" }}
       connect
     >

package/dist/index.d.ts

@@ -135,6 +135,10 @@ export interface UseRqmiiConnectionReturn {
   initializeSession: (args?: InitializeSessionArgs) => Promise<any>;
   joinDesktopSession: (args: JoinDesktopSessionArgs) => Promise<any>;
   disconnect: () => void;
+  interrupt: () => boolean;
+  refreshSessionActivity: () => boolean;
+  clearSessionHistory: () => boolean;
+  changeSessionLanguage: (language: string) => boolean;
 }
 
 export interface UseRqmiiMessagesReturn {
@@ -230,6 +234,7 @@ export interface RqmiiAgentContextValue extends UseRqmiiConnectionReturn {
   interrupt: () => boolean;
   refreshSessionActivity: () => boolean;
   clearSessionHistory: () => boolean;
+  changeSessionLanguage: (language: string) => boolean;
   clearMessages: () => void;
   resumeAudioPlayback: () => Promise<void>;
   attachAudioElement: (element: HTMLAudioElement | null) => void;
@@ -282,4 +287,3 @@ export function useRqmiiVAD(options?: UseRqmiiVADOptions): UseRqmiiVADReturn;
 export function RqmiiAgentRoom(props: RqmiiAgentRoomProps): React.JSX.Element;
 export function RqmiiCloudAvatarPlayer(props: RqmiiCloudAvatarPlayerProps): React.JSX.Element | null;
 export const EpicPixelStreamingPlayer: React.ComponentType<EpicPixelStreamingPlayerProps>;
-