computesdk 1.11.0 → 1.12.0

package/README.md

@@ -283,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
@@ -391,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

@@ -1103,25 +1103,64 @@ declare class Terminal {
  * Server - Resource namespace for managed server operations
  */
 
+/**
+ * Options for starting a managed server
+ */
+interface ServerStartOptions {
+    /** Unique server identifier (URL-safe) */
+    slug: string;
+    /** Command to start the server */
+    command: string;
+    /** Working directory (optional) */
+    path?: string;
+    /** Path to .env file relative to path (optional) */
+    env_file?: string;
+    /** Inline environment variables (merged with env_file if both provided) */
+    environment?: Record<string, string>;
+    /**
+     * When to automatically restart the server:
+     * - `never`: No automatic restart (default)
+     * - `on-failure`: Restart only on non-zero exit code
+     * - `always`: Always restart on exit (including exit code 0)
+     */
+    restart_policy?: RestartPolicy;
+    /** Maximum restart attempts (0 = unlimited, default: 0) */
+    max_restarts?: number;
+    /** Delay between restart attempts in milliseconds (default: 1000) */
+    restart_delay_ms?: number;
+    /** Graceful shutdown timeout in milliseconds - SIGTERM → wait → SIGKILL (default: 10000) */
+    stop_timeout_ms?: number;
+}
 /**
  * Server resource namespace
  *
  * @example
  * ```typescript
- * // Start a new server
+ * // Start a basic server
  * const server = await sandbox.server.start({
  *   slug: 'api',
  *   command: 'npm start',
  *   path: '/app',
  * });
  *
+ * // Start with supervisor settings (auto-restart on failure)
+ * const server = await sandbox.server.start({
+ *   slug: 'web',
+ *   command: 'node server.js',
+ *   path: '/app',
+ *   environment: { NODE_ENV: 'production', PORT: '3000' },
+ *   restart_policy: 'on-failure',
+ *   max_restarts: 5,
+ *   restart_delay_ms: 2000,
+ * });
+ *
  * // List all servers
  * const servers = await sandbox.server.list();
  *
  * // Retrieve a specific server
  * const server = await sandbox.server.retrieve('api');
  *
- * // Stop a server
+ * // Stop a server (graceful shutdown with SIGTERM → SIGKILL)
  * await sandbox.server.stop('api');
  *
  * // Restart a server
@@ -1136,12 +1175,7 @@ declare class Server {
     private restartHandler;
     private updateStatusHandler;
     constructor(handlers: {
-        start: (options: {
-            slug: string;
-            command: string;
-            path?: string;
-            env_file?: string;
-        }) => Promise<ServerResponse>;
+        start: (options: ServerStartOptions) => Promise<ServerResponse>;
         list: () => Promise<ServersListResponse>;
         retrieve: (slug: string) => Promise<ServerResponse>;
         stop: (slug: string) => Promise<ServerStopResponse | void>;
@@ -1149,20 +1183,40 @@ declare class Server {
         updateStatus: (slug: string, status: ServerStatus) => Promise<void>;
     });
     /**
-     * Start a new managed server
+     * Start a new managed server with optional supervisor settings
+     *
+     * **Restart Policies:**
+     * - `never` (default): No automatic restart on exit
+     * - `on-failure`: Restart only on non-zero exit code
+     * - `always`: Always restart on exit (including exit code 0)
+     *
+     * **Graceful Shutdown:**
+     * When stopping a server, it first sends SIGTERM and waits for `stop_timeout_ms`
+     * before sending SIGKILL if the process hasn't exited.
+     *
      * @param options - Server configuration
-     * @param options.slug - Unique server slug (URL-safe identifier)
-     * @param options.command - Command to start the server
-     * @param options.path - Working directory (optional)
-     * @param options.env_file - Path to env file (optional)
      * @returns Server info
+     *
+     * @example
+     * ```typescript
+     * // Basic server
+     * const server = await sandbox.server.start({
+     *   slug: 'web',
+     *   command: 'npm run dev',
+     *   path: '/app',
+     * });
+     *
+     * // With supervisor settings
+     * const server = await sandbox.server.start({
+     *   slug: 'api',
+     *   command: 'node server.js',
+     *   environment: { NODE_ENV: 'production' },
+     *   restart_policy: 'always',
+     *   max_restarts: 0, // unlimited
+     * });
+     * ```
      */
-    start(options: {
-        slug: string;
-        command: string;
-        path?: string;
-        env_file?: string;
-    }): Promise<ServerInfo>;
+    start(options: ServerStartOptions): Promise<ServerInfo>;
     /**
      * List all managed servers
      * @returns Array of server info
@@ -2301,23 +2355,61 @@ interface TerminalResponse {
 }
 /**
  * Server status types
+ *
+ * - `starting`: Initial startup of the server process
+ * - `running`: Server process is running
+ * - `ready`: Server is running and ready to accept traffic
+ * - `failed`: Server failed to start or encountered a fatal error
+ * - `stopped`: Server was intentionally stopped
+ * - `restarting`: Server is being automatically restarted by the supervisor
+ */
+type ServerStatus = 'starting' | 'running' | 'ready' | 'failed' | 'stopped' | 'restarting';
+/**
+ * Server restart policy
+ * - `never`: No automatic restart (default)
+ * - `on-failure`: Restart only on non-zero exit code
+ * - `always`: Always restart on exit (including exit code 0)
  */
-type ServerStatus = 'starting' | 'running' | 'ready' | 'failed' | 'stopped';
+type RestartPolicy = 'never' | 'on-failure' | 'always';
 /**
  * Server information
  */
 interface ServerInfo {
+    /** Unique server identifier */
     slug: string;
+    /** Command used to start the server */
     command: string;
+    /** Working directory path */
     path: string;
+    /** Original path before resolution */
     original_path?: string;
+    /** Path to .env file */
     env_file?: string;
+    /** Inline environment variables */
+    environment?: Record<string, string>;
+    /** Auto-detected port number (populated when port monitor detects listening port) */
     port?: number;
+    /** Generated URL from subdomain + port (populated when port is detected) */
     url?: string;
+    /** Server lifecycle status */
     status: ServerStatus;
+    /** Process ID (direct process, not shell wrapper) */
     pid?: number;
-    terminal_id?: string;
+    /** Configured restart policy */
+    restart_policy?: RestartPolicy;
+    /** Maximum restart attempts (0 = unlimited) */
+    max_restarts?: number;
+    /** Delay between restarts in nanoseconds (input uses milliseconds via restart_delay_ms) */
+    restart_delay?: number;
+    /** Graceful shutdown timeout in nanoseconds (input uses milliseconds via stop_timeout_ms) */
+    stop_timeout?: number;
+    /** Number of times the server has been automatically restarted */
+    restart_count?: number;
+    /** Last exit code (null if process is still running) */
+    exit_code?: number | null;
+    /** When the server was created */
     created_at: string;
+    /** When the server was last updated */
     updated_at: string;
 }
 /**
@@ -2882,14 +2974,51 @@ declare class Sandbox {
      */
     listServers(): Promise<ServersListResponse>;
     /**
-     * Start a new managed server
+     * Start a new managed server with optional supervisor settings
+     *
      * @param options - Server configuration
+     * @param options.slug - Unique server identifier
+     * @param options.command - Command to start the server
+     * @param options.path - Working directory (optional)
+     * @param options.env_file - Path to .env file relative to path (optional)
+     * @param options.environment - Inline environment variables (merged with env_file if both provided)
+     * @param options.restart_policy - When to automatically restart: 'never' (default), 'on-failure', 'always'
+     * @param options.max_restarts - Maximum restart attempts, 0 = unlimited (default: 0)
+     * @param options.restart_delay_ms - Delay between restart attempts in milliseconds (default: 1000)
+     * @param options.stop_timeout_ms - Graceful shutdown timeout in milliseconds (default: 10000)
+     *
+     * @example
+     * ```typescript
+     * // Basic server
+     * await sandbox.startServer({
+     *   slug: 'web',
+     *   command: 'npm run dev',
+     *   path: '/app',
+     * });
+     *
+     * // With supervisor settings
+     * await sandbox.startServer({
+     *   slug: 'api',
+     *   command: 'node server.js',
+     *   path: '/app',
+     *   environment: { NODE_ENV: 'production', PORT: '3000' },
+     *   restart_policy: 'on-failure',
+     *   max_restarts: 5,
+     *   restart_delay_ms: 2000,
+     *   stop_timeout_ms: 5000,
+     * });
+     * ```
      */
     startServer(options: {
         slug: string;
         command: string;
         path?: string;
         env_file?: string;
+        environment?: Record<string, string>;
+        restart_policy?: RestartPolicy;
+        max_restarts?: number;
+        restart_delay_ms?: number;
+        stop_timeout_ms?: number;
     }): Promise<ServerResponse>;
     /**
      * Get information about a specific server