computesdk 1.10.3 → 1.11.1

package/README.md

@@ -40,8 +40,11 @@ For more control, use `setConfig()` to explicitly configure the provider:
 import { compute } from 'computesdk';
 
 compute.setConfig({
-  provider: 'e2b',
-  e2b: { apiKey: 'your_api_key' }
+  provider: 'your-provider',
+  apiKey: process.env.COMPUTESDK_API_KEY,
+  'your-provider': {
+    apiKey: process.env.YOUR_PROVIDER_API_KEY
+  }
 });
 
 const sandbox = await compute.sandbox.create();
@@ -84,8 +87,11 @@ Configure the gateway with explicit provider settings.
 
 ```typescript
 compute.setConfig({
-  provider: 'e2b',
-  e2b: { apiKey: 'your_api_key' }
+  provider: 'your-provider',
+  apiKey: process.env.COMPUTESDK_API_KEY,
+  'your-provider': {
+    apiKey: process.env.YOUR_PROVIDER_API_KEY
+  }
 });
 ```
 
@@ -95,6 +101,7 @@ compute.setConfig({
 // E2B
 compute.setConfig({
   provider: 'e2b',
+  apiKey: process.env.COMPUTESDK_API_KEY,
   e2b: { 
     apiKey: 'e2b_xxx',
     templateId: 'optional_template' 
@@ -104,6 +111,7 @@ compute.setConfig({
 // Modal
 compute.setConfig({
   provider: 'modal',
+  apiKey: process.env.COMPUTESDK_API_KEY,
   modal: { 
     tokenId: 'ak-xxx',
     tokenSecret: 'as-xxx'
@@ -113,6 +121,7 @@ compute.setConfig({
 // Railway
 compute.setConfig({
   provider: 'railway',
+  apiKey: process.env.COMPUTESDK_API_KEY,
   railway: { 
     apiToken: 'your_token',
     projectId: 'project_id',
@@ -123,12 +132,14 @@ compute.setConfig({
 // Daytona
 compute.setConfig({
   provider: 'daytona',
+  apiKey: process.env.COMPUTESDK_API_KEY,
   daytona: { apiKey: 'your_api_key' }
 });
 
 // Vercel
 compute.setConfig({
   provider: 'vercel',
+  apiKey: process.env.COMPUTESDK_API_KEY,
   vercel: { 
     token: 'your_token',
     teamId: 'team_xxx',
@@ -272,6 +283,209 @@ Remove a file or directory.
 await sandbox.filesystem.remove('/tmp/hello.py');
 ```
 
+### Terminal Operations
+
+The sandbox provides terminal access in two modes: **PTY mode** (interactive shell) and **Exec mode** (command tracking).
+
+#### `sandbox.terminal.create(options?)`
+
+Create a new terminal session.
+
+```typescript
+// PTY mode - Interactive shell
+const pty = await sandbox.terminal.create({ pty: true, shell: '/bin/bash' });
+
+// Exec mode - Command tracking (default)
+const exec = await sandbox.terminal.create({ pty: false });
+```
+
+**Options:**
+- `pty?: boolean` - Terminal mode: `true` = PTY (interactive), `false` = exec (command tracking). Default: `false`
+- `shell?: string` - Shell to use (e.g., '/bin/bash'). PTY mode only
+- `encoding?: 'raw' | 'base64'` - Output encoding. Default: `'raw'`
+
+**Returns:** `TerminalInstance`
+
+#### `sandbox.terminal.list()`
+
+List all active terminals.
+
+```typescript
+const terminals = await sandbox.terminal.list();
+console.log(terminals); // [{ id: 'term-1', pty: true, status: 'running', ... }]
+```
+
+#### `sandbox.terminal.retrieve(id)`
+
+Retrieve a specific terminal by ID.
+
+```typescript
+const terminal = await sandbox.terminal.retrieve('term-123');
+console.log(terminal.id, terminal.status);
+```
+
+#### `sandbox.terminal.destroy(id)`
+
+Destroy a terminal by ID.
+
+```typescript
+await sandbox.terminal.destroy('term-123');
+```
+
+### PTY Mode (Interactive Shell)
+
+PTY mode creates an interactive shell session with real-time input/output over WebSocket.
+
+#### `terminal.write(input)`
+
+Send input to the terminal shell.
+
+```typescript
+const pty = await sandbox.terminal.create({ pty: true });
+pty.on('output', (data) => console.log(data));
+pty.write('ls -la\n');
+pty.write('pwd\n');
+await pty.destroy();
+```
+
+#### `terminal.resize(cols, rows)`
+
+Resize the terminal window.
+
+```typescript
+pty.resize(120, 40);
+```
+
+#### `terminal.on(event, handler)`
+
+Register an event handler. Events: `'output'`, `'error'`, `'destroyed'`.
+
+```typescript
+pty.on('output', (data) => console.log('Output:', data));
+pty.on('error', (error) => console.error('Error:', error));
+pty.on('destroyed', () => console.log('Terminal destroyed'));
+```
+
+#### `terminal.off(event, handler)`
+
+Unregister an event handler.
+
+```typescript
+const handler = (data) => console.log(data);
+pty.on('output', handler);
+pty.off('output', handler);
+```
+
+#### Terminal Properties
+
+```typescript
+console.log(pty.id);       // Terminal ID
+console.log(pty.status);   // 'running' | 'stopped' | 'active' | 'ready'
+console.log(pty.channel);  // WebSocket channel (PTY only)
+console.log(pty.pty);      // true for PTY mode
+```
+
+### Exec Mode (Command Tracking)
+
+Exec mode executes commands with structured result tracking, suitable for automation.
+
+#### `terminal.command.run(command, options?)`
+
+Execute a command in the terminal.
+
+```typescript
+const exec = await sandbox.terminal.create({ pty: false });
+
+// Foreground execution (waits for completion)
+const cmd = await exec.command.run('npm test');
+console.log(cmd.stdout);
+console.log(cmd.stderr);
+console.log(cmd.exitCode);
+
+// Background execution (returns immediately)
+const bgCmd = await exec.command.run('npm install', { background: true });
+console.log(bgCmd.status); // 'running'
+await bgCmd.wait(); // Wait for completion
+console.log(bgCmd.exitCode);
+```
+
+**Parameters:**
+- `command: string` - The command to execute
+- `options?: { background?: boolean }` - Execution options
+
+**Returns:** `Command` object
+
+#### `terminal.command.list()`
+
+List all commands executed in this terminal.
+
+```typescript
+const commands = await exec.command.list();
+commands.forEach(cmd => {
+  console.log(cmd.id, cmd.command, cmd.status, cmd.exitCode);
+});
+```
+
+#### `terminal.command.retrieve(cmdId)`
+
+Retrieve a specific command by ID.
+
+```typescript
+const cmd = await exec.command.retrieve('cmd-123');
+console.log(cmd.stdout);
+```
+
+### Command Object
+
+The `Command` object represents a command execution result.
+
+#### Command Properties
+
+```typescript
+console.log(cmd.id);          // Command ID
+console.log(cmd.terminalId);  // Parent terminal ID
+console.log(cmd.command);     // Executed command
+console.log(cmd.status);      // 'running' | 'completed' | 'failed'
+console.log(cmd.stdout);      // Standard output
+console.log(cmd.stderr);      // Standard error
+console.log(cmd.exitCode);    // Exit code (undefined if running)
+console.log(cmd.durationMs);  // Execution time in milliseconds
+console.log(cmd.startedAt);   // Start timestamp
+console.log(cmd.finishedAt);  // Finish timestamp (undefined if running)
+```
+
+#### `command.wait(timeout?)`
+
+Wait for a background command to complete.
+
+```typescript
+const cmd = await exec.command.run('sleep 5', { background: true });
+await cmd.wait(); // Waits up to default timeout
+console.log(cmd.exitCode);
+
+// With custom timeout (in seconds, 0 = no timeout)
+await cmd.wait(10);
+```
+
+#### `command.refresh()`
+
+Refresh the command status from the server.
+
+```typescript
+const cmd = await exec.command.run('npm build', { background: true });
+// ... later ...
+await cmd.refresh();
+console.log(cmd.status, cmd.exitCode);
+```
+
+#### `terminal.destroy()`
+
+Destroy the terminal and clean up resources.
+
+```typescript
+await exec.destroy();
+```
+
 ## Examples
 
 ### Data Science Workflow
@@ -380,6 +594,82 @@ console.log(runResult.stdout);
 await sandbox.destroy();
 ```
 
+### Terminal Command Execution
+
+```typescript
+import { compute } from 'computesdk';
+
+const sandbox = await compute.sandbox.create({ runtime: 'node' });
+
+// Create exec mode terminal for command tracking
+const terminal = await sandbox.terminal.create({ pty: false });
+
+// Run build commands with tracking
+const install = await terminal.command.run('npm install');
+console.log('Install exit code:', install.exitCode);
+
+const build = await terminal.command.run('npm run build');
+console.log('Build output:', build.stdout);
+
+// Run tests in background
+const tests = await terminal.command.run('npm test', { background: true });
+console.log('Tests started:', tests.status);
+
+// Wait for tests to complete
+await tests.wait(60); // 60 second timeout
+console.log('Tests completed:', tests.exitCode === 0 ? 'PASSED' : 'FAILED');
+console.log('Test output:', tests.stdout);
+
+// List all commands
+const commands = await terminal.command.list();
+console.log(`Executed ${commands.length} commands`);
+
+await terminal.destroy();
+await sandbox.destroy();
+```
+
+### Interactive Terminal Session
+
+```typescript
+import { compute } from 'computesdk';
+
+const sandbox = await compute.sandbox.create({ runtime: 'node' });
+
+// Create PTY terminal for interactive shell
+const pty = await sandbox.terminal.create({ 
+  pty: true, 
+  shell: '/bin/bash' 
+});
+
+// Collect all output
+let output = '';
+pty.on('output', (data) => {
+  output += data;
+  console.log(data);
+});
+
+pty.on('error', (error) => {
+  console.error('Terminal error:', error);
+});
+
+// Execute interactive commands
+pty.write('echo "Starting project setup"\n');
+pty.write('mkdir -p /workspace/myproject\n');
+pty.write('cd /workspace/myproject\n');
+pty.write('npm init -y\n');
+pty.write('npm install express\n');
+pty.write('echo "Setup complete"\n');
+
+// Wait for operations to complete
+await new Promise(resolve => setTimeout(resolve, 5000));
+
+// Clean up
+await pty.destroy();
+await sandbox.destroy();
+
+console.log('Complete output:', output);
+```
+
 ### Using Different Providers
 
 ```typescript

package/dist/index.d.mts

@@ -250,6 +250,42 @@ interface TerminalErrorMessage {
         error: string;
     };
 }
+/**
+ * Command stdout streaming message (exec mode with stream: true)
+ */
+interface CommandStdoutMessage {
+    type: 'command:stdout';
+    channel: string;
+    data: {
+        terminal_id: string;
+        cmd_id: string;
+        output: string;
+    };
+}
+/**
+ * Command stderr streaming message (exec mode with stream: true)
+ */
+interface CommandStderrMessage {
+    type: 'command:stderr';
+    channel: string;
+    data: {
+        terminal_id: string;
+        cmd_id: string;
+        output: string;
+    };
+}
+/**
+ * Command exit message (exec mode with stream: true)
+ */
+interface CommandExitMessage {
+    type: 'command:exit';
+    channel: string;
+    data: {
+        terminal_id: string;
+        cmd_id: string;
+        exit_code: number;
+    };
+}
 /**
  * File watcher created notification
  */
@@ -427,6 +463,12 @@ declare class WebSocketManager {
      * Resize terminal window
      */
     resizeTerminal(terminalId: string, cols: number, rows: number): void;
+    /**
+     * Start a pending streaming command
+     * Used in two-phase streaming flow: HTTP request creates pending command,
+     * then this signal triggers execution after client has subscribed.
+     */
+    startCommand(cmdId: string): void;
     /**
      * Register event handler
      */
@@ -438,6 +480,9 @@ declare class WebSocketManager {
     on(event: 'terminal:output', handler: MessageHandler<TerminalOutputMessage>): void;
     on(event: 'terminal:destroyed', handler: MessageHandler<TerminalDestroyedMessage>): void;
     on(event: 'terminal:error', handler: MessageHandler<TerminalErrorMessage>): void;
+    on(event: 'command:stdout', handler: MessageHandler<CommandStdoutMessage>): void;
+    on(event: 'command:stderr', handler: MessageHandler<CommandStderrMessage>): void;
+    on(event: 'command:exit', handler: MessageHandler<CommandExitMessage>): void;
     on(event: 'watcher:created', handler: MessageHandler<WatcherCreatedMessage>): void;
     on(event: 'file:changed', handler: MessageHandler<FileChangedMessage>): void;
     on(event: 'watcher:destroyed', handler: MessageHandler<WatcherDestroyedMessage>): void;
@@ -1957,6 +2002,13 @@ interface SandboxConfig {
     protocol?: 'json' | 'binary';
     /** Optional metadata associated with the sandbox */
     metadata?: Record<string, unknown>;
+    /**
+     * Handler called when destroy() is invoked.
+     * If provided, this is called to destroy the sandbox (e.g., via gateway API).
+     * If not provided, destroy() only disconnects the WebSocket.
+     * @internal
+     */
+    destroyHandler?: () => Promise<void>;
 }
 /**
  * Health check response
@@ -2076,7 +2128,7 @@ interface FileResponse {
     };
 }
 /**
- * Command execution response
+ * Command execution response (used by both /run/command and /terminals/{id}/execute)
  */
 interface CommandExecutionResponse {
     message: string;
@@ -2084,12 +2136,12 @@ interface CommandExecutionResponse {
         terminal_id?: string;
         cmd_id?: string;
         command: string;
-        output?: string;
         stdout: string;
         stderr: string;
         exit_code?: number;
         duration_ms?: number;
         status?: 'running' | 'completed' | 'failed';
+        channel?: string;
         pty?: boolean;
     };
 }
@@ -2142,22 +2194,6 @@ interface CodeExecutionResponse {
         language: string;
     };
 }
-/**
- * Run command response (POST /run/command)
- */
-interface RunCommandResponse {
-    message: string;
-    data: {
-        terminal_id?: string;
-        cmd_id?: string;
-        command: string;
-        stdout: string;
-        stderr: string;
-        exit_code?: number;
-        duration_ms?: number;
-        status?: 'running' | 'completed' | 'failed';
-    };
-}
 /**
  * File watcher information
  */
@@ -2629,9 +2665,10 @@ declare class Sandbox {
         command: string;
         shell?: string;
         background?: boolean;
+        stream?: boolean;
         cwd?: string;
         env?: Record<string, string>;
-    }): Promise<RunCommandResponse>;
+    }): Promise<CommandExecutionResponse>;
     /**
      * List files at the specified path
      */
@@ -2644,6 +2681,11 @@ declare class Sandbox {
      * Get file metadata (without content)
      */
     getFile(path: string): Promise<FileResponse>;
+    /**
+     * Encode a file path for use in URLs
+     * Strips leading slash and encodes each segment separately to preserve path structure
+     */
+    private encodeFilePath;
     /**
      * Read file content
      */
@@ -2916,6 +2958,8 @@ declare class Sandbox {
      * @param options.background - Run in background (server uses goroutines)
      * @param options.cwd - Working directory (server uses cmd.Dir)
      * @param options.env - Environment variables (server uses cmd.Env)
+     * @param options.onStdout - Callback for streaming stdout data
+     * @param options.onStderr - Callback for streaming stderr data
      * @returns Command execution result
      *
      * @example
@@ -2931,12 +2975,20 @@ declare class Sandbox {
      *   background: true,
      *   env: { PORT: '3000' }
      * })
+     *
+     * // With streaming output
+     * await sandbox.runCommand('npm install', {
+     *   onStdout: (data) => console.log(data),
+     *   onStderr: (data) => console.error(data),
+     * })
      * ```
      */
     runCommand(command: string, options?: {
         background?: boolean;
         cwd?: string;
         env?: Record<string, string>;
+        onStdout?: (data: string) => void;
+        onStderr?: (data: string) => void;
     }): Promise<{
         stdout: string;
         stderr: string;
@@ -2979,6 +3031,9 @@ declare class Sandbox {
     getInstance(): this;
     /**
      * Destroy the sandbox (Sandbox interface method)
+     *
+     * If a destroyHandler was provided (e.g., from gateway), calls it to destroy
+     * the sandbox on the backend. Otherwise, only disconnects the WebSocket.
      */
     destroy(): Promise<void>;
     /**
@@ -3076,8 +3131,13 @@ declare function getMissingEnvVars(provider: ProviderName): string[];
 interface ExplicitComputeConfig {
     /** Provider name to use */
     provider: ProviderName;
+    /**
+     * ComputeSDK API key (required for gateway mode)
+     * @deprecated Use `computesdkApiKey` for clarity
+     */
+    apiKey?: string;
     /** ComputeSDK API key (required for gateway mode) */
-    apiKey: string;
+    computesdkApiKey?: string;
     /** Optional gateway URL override */
     gatewayUrl?: string;
     /** Provider-specific configurations */