Fix factory classes to properly extend base classes

- Convert Conversation and Workspace from factory functions to proper classes that extend RemoteConversation and RemoteWorkspace
- Update ConversationManager to use new constructor-based API
- Update serverStatus.ts to use new constructor pattern
- All builds now pass successfully

Co-authored-by: openhands <openhands@all-hands.dev>

Author: openhands-agent

README.md

@@ -21,7 +21,7 @@ npm install @openhands/agent-server-typescript-client
 ### Creating a Conversation
 
 ```typescript
-import { Conversation, Agent, RemoteWorkspace } from '@openhands/agent-server-typescript-client';
+import { Conversation, Agent, Workspace } from '@openhands/agent-server-typescript-client';
 
 const agent: Agent = {
   kind: 'CodeActAgent',
@@ -32,24 +32,22 @@ const agent: Agent = {
 };
 
 // Create a remote workspace
-const workspace = new RemoteWorkspace({
+const workspace = new Workspace({
   host: 'http://localhost:3000',
   workingDir: '/tmp',
   apiKey: 'your-session-api-key'
 });
 
-const conversation = await Conversation.create(
-  'http://localhost:3000', // Agent server URL
-  agent,
-  workspace,
-  {
-    apiKey: 'your-session-api-key',
-    initialMessage: 'Hello, can you help me write some code?',
-    callback: (event) => {
-      console.log('Received event:', event);
-    }
+const conversation = new Conversation(agent, workspace, {
+  callback: (event) => {
+    console.log('Received event:', event);
   }
-);
+});
+
+// Start the conversation with an initial message
+await conversation.start({
+  initialMessage: 'Hello, can you help me write some code?'
+});
 
 // Start WebSocket for real-time events
 await conversation.startWebSocketClient();
@@ -63,20 +61,18 @@ await conversation.run();
 
 ```typescript
 // Create a remote workspace for the existing conversation
-const workspace = new RemoteWorkspace({
+const workspace = new Workspace({
   host: 'http://localhost:3000',
   workingDir: '/tmp',
   apiKey: 'your-session-api-key'
 });
 
-const conversation = await Conversation.load(
-  'http://localhost:3000',
-  'conversation-id-here',
-  workspace,
-  {
-    apiKey: 'your-session-api-key'
-  }
-);
+const conversation = new Conversation(agent, workspace, {
+  conversationId: 'conversation-id-here'
+});
+
+// Connect to the existing conversation
+await conversation.start();
 ```
 
 ### Using the Workspace
@@ -136,17 +132,18 @@ await conversation.updateSecrets({
 
 ## API Reference
 
-### RemoteConversation
+### Conversation
 
-The main class for managing conversations with OpenHands agents.
+Factory function that creates conversations with OpenHands agents.
 
-#### Static Methods
+#### Constructor
 
-- `RemoteConversation.create(host, agent, options)` - Create a new conversation
-- `RemoteConversation.load(host, conversationId, options)` - Load an existing conversation
+- `new Conversation(agent, workspace, options?)` - Create a new conversation instance
 
 #### Instance Methods
 
+- `start(options?)` - Start the conversation (creates new or connects to existing)
+
 - `sendMessage(message)` - Send a message to the agent
 - `run()` - Start agent execution
 - `pause()` - Pause agent execution

example/src/components/ConversationManager.tsx

@@ -5,7 +5,7 @@ import {
   Conversation,
   RemoteConversation,
   Agent,
-  RemoteWorkspace,
+  Workspace,
   Event
 } from '@openhands/agent-server-typescript-client';
 import { useSettings } from '../contexts/SettingsContext';
@@ -201,22 +201,16 @@ export const ConversationManager: React.FC = () => {
       };
 
       // Create a remote workspace
-      const workspace = new RemoteWorkspace({
+      const workspace = new Workspace({
         host: manager.host,
         workingDir: '/tmp',
         apiKey: manager.apiKey
       });
 
-      const conversation = await Conversation.create(
-        manager.host,
-        agent,
-        workspace,
-        {
-          apiKey: manager.apiKey,
-          initialMessage: 'Hello! I\'m ready to help you with your tasks.',
-          maxIterations: 50,
-          callback: (event: Event) => {
-            console.log('Received WebSocket event for new conversation:', event);
+      const conversation = new Conversation(agent, workspace, {
+        maxIterations: 50,
+        callback: (event: Event) => {
+          console.log('Received WebSocket event for new conversation:', event);
 
             // Update the conversation's events in real-time
             setConversations(prev => prev.map(conv => {
@@ -231,6 +225,11 @@ export const ConversationManager: React.FC = () => {
       );
 
       console.log('Created conversation:', conversation);
+
+      // Start the conversation with initial message
+      await conversation.start({
+        initialMessage: 'Hello! I\'m ready to help you with your tasks.'
+      });
 
       // Start WebSocket client for real-time updates
       try {
@@ -299,6 +298,12 @@ export const ConversationManager: React.FC = () => {
 
     // Load conversation details
     try {
+      // Get the conversation info to extract the agent
+      const conversationInfo = conversations.find(c => c.id === conversationId);
+      if (!conversationInfo) {
+        throw new Error('Conversation not found');
+      }
+
       // Create a callback to handle real-time events
       const eventCallback = (event: Event) => {
         console.log('Received WebSocket event:', event);
@@ -331,22 +336,20 @@ export const ConversationManager: React.FC = () => {
       };
 
       // Create a remote workspace for the existing conversation
-      const workspace = new RemoteWorkspace({
+      const workspace = new Workspace({
         host: manager.host,
         workingDir: '/tmp',
         apiKey: manager.apiKey
       });
 
       // Load conversation with callback
-      const remoteConversation = await Conversation.load(
-        manager.host,
-        conversationId,
-        workspace,
-        {
-          apiKey: manager.apiKey,
-          callback: eventCallback,
-        }
-      );
+      const remoteConversation = new Conversation(conversationInfo.agent, workspace, {
+        conversationId: conversationId,
+        callback: eventCallback,
+      });
+
+      // Connect to the existing conversation
+      await remoteConversation.start();
       console.log('Loaded remote conversation:', remoteConversation);
 
       // Start WebSocket client for real-time updates

example/src/utils/serverStatus.ts

@@ -59,21 +59,19 @@ export const testLLMConfiguration = async (settings: Settings): Promise<{ succes
     });
 
     // Create a test conversation using the SDK
-    const conversation = await RemoteConversation.create(
-      settings.agentServerUrl,
+    const conversation = new RemoteConversation(
       {
         kind: 'Agent',
         llm: {
           model: settings.modelName,
           api_key: settings.apiKey,
         }
       },
-      workspace,
-      {
-        apiKey: settings.agentServerApiKey,
-      }
+      workspace
     );
 
+    await conversation.start();
+
     try {
       // Send a simple test message to validate LLM configuration
       await conversation.sendMessage({

examples/basic-usage.ts

@@ -2,7 +2,7 @@
  * Basic usage example for the OpenHands Agent Server TypeScript Client
  */
 
-import { Conversation, Agent, RemoteWorkspace, AgentExecutionStatus } from '../src/index.js';
+import { Conversation, Agent, Workspace, AgentExecutionStatus } from '../src/index.js';
 
 async function main() {
   // Define the agent configuration
@@ -16,26 +16,24 @@ async function main() {
 
   try {
     // Create a remote workspace
-    const workspace = new RemoteWorkspace({
+    const workspace = new Workspace({
       host: 'http://localhost:3000',
       workingDir: '/tmp',
       apiKey: process.env.SESSION_API_KEY || 'your-session-api-key'
     });
 
     // Create a new conversation
     console.log('Creating conversation...');
-    const conversation = await Conversation.create(
-      'http://localhost:3000', // Replace with your agent server URL
-      agent,
-      workspace,
-      {
-        apiKey: process.env.SESSION_API_KEY || 'your-session-api-key',
-        initialMessage: 'Hello! Can you help me write a simple Python script?',
-        callback: (event) => {
-          console.log(`Event received: ${event.kind} at ${event.timestamp}`);
-        },
-      }
-    );
+    const conversation = new Conversation(agent, workspace, {
+      callback: (event) => {
+        console.log(`Event received: ${event.kind} at ${event.timestamp}`);
+      },
+    });
+
+    // Start the conversation with an initial message
+    await conversation.start({
+      initialMessage: 'Hello! Can you help me write a simple Python script?'
+    });
 
     console.log(`Conversation created with ID: ${conversation.id}`);
 
@@ -87,22 +85,28 @@ async function main() {
 
 // Example of loading an existing conversation
 async function loadExistingConversation() {
+  const agent: Agent = {
+    kind: 'CodeActAgent',
+    llm: {
+      model: 'gpt-4',
+      api_key: process.env.OPENAI_API_KEY || 'your-openai-api-key',
+    },
+  };
+
   try {
     // Create a remote workspace for the existing conversation
-    const workspace = new RemoteWorkspace({
+    const workspace = new Workspace({
       host: 'http://localhost:3000',
       workingDir: '/tmp',
       apiKey: process.env.SESSION_API_KEY || 'your-session-api-key'
     });
 
-    const conversation = await Conversation.load(
-      'http://localhost:3000',
-      'existing-conversation-id',
-      workspace,
-      {
-        apiKey: process.env.SESSION_API_KEY || 'your-session-api-key',
-      }
-    );
+    const conversation = new Conversation(agent, workspace, {
+      conversationId: 'existing-conversation-id'
+    });
+
+    // Connect to the existing conversation
+    await conversation.start();
 
     console.log(`Loaded conversation: ${conversation.id}`);
 

src/conversation/conversation-manager.ts

@@ -97,28 +97,38 @@ export class ConversationManager {
       apiKey: this.apiKey,
     });
 
-    return RemoteConversation.create(this.host, agent, workspace, {
-      apiKey: this.apiKey,
-      initialMessage: options.initialMessage,
+    const conversation = new RemoteConversation(agent, workspace, {
       maxIterations: options.maxIterations,
       stuckDetection: options.stuckDetection,
     });
+
+    await conversation.start({
+      initialMessage: options.initialMessage,
+    });
+
+    return conversation;
   }
 
   /**
    * Load an existing conversation
    */
   async loadConversation(conversationId: ConversationID, workingDir: string = '/tmp'): Promise<RemoteConversation> {
+    // Get conversation info to extract the agent
+    const conversationInfo = await this.getConversation(conversationId);
+
     // Create a workspace for the existing conversation
     const workspace = new RemoteWorkspace({
       host: this.host,
       workingDir,
       apiKey: this.apiKey,
     });
 
-    return RemoteConversation.load(this.host, conversationId, workspace, {
-      apiKey: this.apiKey,
+    const conversation = new RemoteConversation(conversationInfo.agent, workspace, {
+      conversationId: conversationId,
     });
+
+    await conversation.start();
+    return conversation;
   }
 
   /**

src/conversation/conversation.ts

@@ -0,0 +1,30 @@
+/**
+ * Conversation factory function that returns RemoteConversation
+ * Matches the Python SDK pattern: Conversation(agent, workspace)
+ */
+
+import { AgentBase } from '../types/base';
+import { RemoteWorkspace } from '../workspace/remote-workspace';
+import { RemoteConversation, RemoteConversationOptions } from './remote-conversation';
+
+/**
+ * Conversation class that extends RemoteConversation.
+ * Provides a cleaner API that matches the Python SDK naming.
+ * 
+ * Usage:
+ *   const conversation = new Conversation(agent, workspace);
+ *   await conversation.start();
+ * 
+ * For existing conversations:
+ *   const conversation = new Conversation(agent, workspace, { conversationId: 'existing-id' });
+ *   await conversation.start();
+ */
+export class Conversation extends RemoteConversation {
+  constructor(
+    agent: AgentBase,
+    workspace: RemoteWorkspace,
+    options?: RemoteConversationOptions
+  ) {
+    super(agent, workspace, options);
+  }
+}