@cloudflare/sandbox 0.0.0-c87db11 → 0.0.0-cdb8197

package/src/types.ts

@@ -1,11 +1,6 @@
 // Core Types
 
 export interface BaseExecOptions {
-  /**
-   * Session ID for grouping related commands
-   */
-  sessionId?: string;
-
   /**
    * Maximum execution time in milliseconds
    */
@@ -90,11 +85,6 @@ export interface ExecResult {
    * ISO timestamp when command started
    */
   timestamp: string;
-
-  /**
-   * Session ID if provided
-   */
-  sessionId?: string;
 }
 
 // Background Process Types
@@ -177,11 +167,6 @@ export interface Process {
    */
   readonly exitCode?: number;
 
-  /**
-   * Session ID if provided
-   */
-  readonly sessionId?: string;
-
   /**
    * Kill the process
    */
@@ -208,7 +193,6 @@ export interface ExecEvent {
   exitCode?: number;
   result?: ExecResult;
   error?: string; // Changed to string for serialization
-  sessionId?: string;
 }
 
 export interface LogEvent {
@@ -216,7 +200,6 @@ export interface LogEvent {
   timestamp: string;
   data: string;
   processId: string;
-  sessionId?: string;
   exitCode?: number; // For 'exit' events
 }
 
@@ -232,6 +215,54 @@ export interface StreamOptions extends BaseExecOptions {
   signal?: AbortSignal;
 }
 
+// File Streaming Types
+
+/**
+ * SSE events for file streaming
+ */
+export type FileStreamEvent =
+  | {
+      type: 'metadata';
+      mimeType: string;
+      size: number;
+      isBinary: boolean;
+      encoding: 'utf-8' | 'base64';
+    }
+  | {
+      type: 'chunk';
+      data: string; // base64 for binary, UTF-8 for text
+    }
+  | {
+      type: 'complete';
+      bytesRead: number;
+    }
+  | {
+      type: 'error';
+      error: string;
+    };
+
+/**
+ * File metadata from streaming
+ */
+export interface FileMetadata {
+  mimeType: string;
+  size: number;
+  isBinary: boolean;
+  encoding: 'utf-8' | 'base64';
+}
+
+/**
+ * File stream chunk - either string (text) or Uint8Array (binary, auto-decoded)
+ */
+export type FileChunk = string | Uint8Array;
+
+/**
+ * AsyncIterable of file chunks with metadata
+ */
+export interface FileStream extends AsyncIterable<FileChunk> {
+  metadata?: FileMetadata;
+}
+
 // Error Types
 
 export class SandboxError extends Error {
@@ -272,10 +303,8 @@ export interface ProcessRecord {
   startTime: Date;
   endTime?: Date;
   exitCode?: number;
-  sessionId?: string;
 
   // Internal fields
-  childProcess?: any;  // Node.js ChildProcess
   stdout: string;      // Accumulated output (ephemeral)
   stderr: string;      // Accumulated output (ephemeral)
 
@@ -290,7 +319,6 @@ export interface StartProcessRequest {
   command: string;
   options?: {
     processId?: string;
-    sessionId?: string;
     timeout?: number;
     env?: Record<string, string>;
     cwd?: string;
@@ -304,9 +332,11 @@ export interface StartProcessResponse {
     id: string;
     pid?: number;
     command: string;
-      status: ProcessStatus;
+    status: ProcessStatus;
     startTime: string;
-    sessionId?: string;
+    endTime?: string | null;
+    exitCode?: number | null;
+    sessionId: string;
   };
 }
 
@@ -319,7 +349,6 @@ export interface ListProcessesResponse {
     startTime: string;
     endTime?: string;
     exitCode?: number;
-    sessionId?: string;
   }>;
 }
 
@@ -332,7 +361,6 @@ export interface GetProcessResponse {
     startTime: string;
     endTime?: string;
     exitCode?: number;
-    sessionId?: string;
   } | null;
 }
 
@@ -371,6 +399,26 @@ export interface ISandbox {
   cleanupCompletedProcesses(): Promise<number>;
   getProcessLogs(id: string): Promise<{ stdout: string; stderr: string }>;
 
+  // File operations
+  gitCheckout(repoUrl: string, options: { branch?: string; targetDir?: string }): Promise<GitCheckoutResponse>;
+  mkdir(path: string, options?: { recursive?: boolean }): Promise<MkdirResponse>;
+  writeFile(path: string, content: string, options?: { encoding?: string }): Promise<WriteFileResponse>;
+  deleteFile(path: string): Promise<DeleteFileResponse>;
+  renameFile(oldPath: string, newPath: string): Promise<RenameFileResponse>;
+  moveFile(sourcePath: string, destinationPath: string): Promise<MoveFileResponse>;
+  readFile(path: string, options?: { encoding?: string }): Promise<ReadFileResponse>;
+  readFileStream(path: string): Promise<ReadableStream<Uint8Array>>;
+  listFiles(path: string, options?: { recursive?: boolean; includeHidden?: boolean }): Promise<ListFilesResponse>;
+
+  // Port management
+  exposePort(port: number, options: { name?: string; hostname: string }): Promise<{ url: string; port: number; name?: string }>;
+  unexposePort(port: number): Promise<void>;
+  getExposedPorts(hostname: string): Promise<Array<{ url: string; port: number; name?: string; exposedAt: string }>>;
+
+  // Environment management
+  setEnvVars(envVars: Record<string, string>): Promise<void>;
+  setSandboxName(name: string): Promise<void>;
+
   // Code Interpreter API
   createCodeContext(options?: CreateContextOptions): Promise<CodeContext>;
   runCode(code: string, options?: RunCodeOptions): Promise<ExecutionResult>;
@@ -379,6 +427,128 @@ export interface ISandbox {
   deleteCodeContext(contextId: string): Promise<void>;
 }
 
+// Execution session returned by createSession()
+// Sessions are full-featured sandbox objects with scoped execution context
+// Inherits all ISandbox methods except createSession (sessions can't create sub-sessions),
+// and setSandboxName (sessions inherit sandbox name).
+export interface ExecutionSession extends Omit<ISandbox, 'createSession' | 'setSandboxName'> {
+  /**
+   * Session ID
+   */
+  id: string;
+}
+
+// API Response Types
+
+export interface ExecuteResponse {
+  success: boolean;
+  stdout: string;
+  stderr: string;
+  exitCode: number;
+  command: string;
+  timestamp: string;
+}
+
+export interface GitCheckoutResponse {
+  success: boolean;
+  stdout: string;
+  stderr: string;
+  exitCode: number;
+  repoUrl: string;
+  branch: string;
+  targetDir: string;
+  timestamp: string;
+}
+
+export interface MkdirResponse {
+  success: boolean;
+  stdout: string;
+  stderr: string;
+  exitCode: number;
+  path: string;
+  recursive: boolean;
+  timestamp: string;
+}
+
+export interface WriteFileResponse {
+  success: boolean;
+  exitCode: number;
+  path: string;
+  timestamp: string;
+}
+
+export interface ReadFileResponse {
+  success: boolean;
+  exitCode: number;
+  path: string;
+  content: string;
+  timestamp: string;
+
+  /**
+   * Encoding used for content (utf-8 for text, base64 for binary)
+   */
+  encoding?: 'utf-8' | 'base64';
+
+  /**
+   * Whether the file is detected as binary
+   */
+  isBinary?: boolean;
+
+  /**
+   * MIME type of the file (e.g., 'image/png', 'text/plain')
+   */
+  mimeType?: string;
+
+  /**
+   * File size in bytes
+   */
+  size?: number;
+}
+
+export interface DeleteFileResponse {
+  success: boolean;
+  exitCode: number;
+  path: string;
+  timestamp: string;
+}
+
+export interface RenameFileResponse {
+  success: boolean;
+  exitCode: number;
+  oldPath: string;
+  newPath: string;
+  timestamp: string;
+}
+
+export interface MoveFileResponse {
+  success: boolean;
+  exitCode: number;
+  sourcePath: string;
+  destinationPath: string;
+  timestamp: string;
+}
+
+export interface ListFilesResponse {
+  success: boolean;
+  exitCode: number;
+  path: string;
+  files: Array<{
+    name: string;
+    absolutePath: string;
+    relativePath: string;
+    type: 'file' | 'directory' | 'symlink' | 'other';
+    size: number;
+    modifiedAt: string;
+    mode: string;
+    permissions: {
+      readable: boolean;
+      writable: boolean;
+      executable: boolean;
+    };
+  }>;
+  timestamp: string;
+}
+
 // Type Guards
 
 export function isExecResult(value: any): value is ExecResult {