@cloudflare/sandbox 0.3.6 → 0.4.1

package/dist/types.js

@@ -1,45 +0,0 @@
-// src/types.ts
-var SandboxError = class extends Error {
-  constructor(message, code) {
-    super(message);
-    this.code = code;
-    this.name = "SandboxError";
-  }
-};
-var ProcessNotFoundError = class extends SandboxError {
-  constructor(processId) {
-    super(`Process not found: ${processId}`, "PROCESS_NOT_FOUND");
-    this.name = "ProcessNotFoundError";
-  }
-};
-var ProcessAlreadyExistsError = class extends SandboxError {
-  constructor(processId) {
-    super(`Process already exists: ${processId}`, "PROCESS_EXISTS");
-    this.name = "ProcessAlreadyExistsError";
-  }
-};
-var ExecutionTimeoutError = class extends SandboxError {
-  constructor(timeout) {
-    super(`Execution timed out after ${timeout}ms`, "EXECUTION_TIMEOUT");
-    this.name = "ExecutionTimeoutError";
-  }
-};
-function isExecResult(value) {
-  return value && typeof value.success === "boolean" && typeof value.exitCode === "number" && typeof value.stdout === "string" && typeof value.stderr === "string";
-}
-function isProcess(value) {
-  return value && typeof value.id === "string" && typeof value.command === "string" && typeof value.status === "string";
-}
-function isProcessStatus(value) {
-  return ["starting", "running", "completed", "failed", "killed", "error"].includes(value);
-}
-export {
-  ExecutionTimeoutError,
-  ProcessAlreadyExistsError,
-  ProcessNotFoundError,
-  SandboxError,
-  isExecResult,
-  isProcess,
-  isProcessStatus
-};
-//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/types.ts"],"sourcesContent":["// Core Types\n\nexport interface BaseExecOptions {\n  /**\n   * Maximum execution time in milliseconds\n   */\n  timeout?: number;\n\n  /**\n   * Environment variables for the command\n   */\n  env?: Record<string, string>;\n\n  /**\n   * Working directory for command execution\n   */\n  cwd?: string;\n\n  /**\n   * Text encoding for output (default: 'utf8')\n   */\n  encoding?: string;\n}\n\nexport interface ExecOptions extends BaseExecOptions {\n  /**\n   * Enable real-time output streaming via callbacks\n   */\n  stream?: boolean;\n\n  /**\n   * Callback for real-time output data\n   */\n  onOutput?: (stream: 'stdout' | 'stderr', data: string) => void;\n\n  /**\n   * Callback when command completes (only when stream: true)\n   */\n  onComplete?: (result: ExecResult) => void;\n\n  /**\n   * Callback for execution errors\n   */\n  onError?: (error: Error) => void;\n\n  /**\n   * AbortSignal for cancelling execution\n   */\n  signal?: AbortSignal;\n}\n\nexport interface ExecResult {\n  /**\n   * Whether the command succeeded (exitCode === 0)\n   */\n  success: boolean;\n\n  /**\n   * Process exit code\n   */\n  exitCode: number;\n\n  /**\n   * Standard output content\n   */\n  stdout: string;\n\n  /**\n   * Standard error content\n   */\n  stderr: string;\n\n  /**\n   * Command that was executed\n   */\n  command: string;\n\n\n  /**\n   * Execution duration in milliseconds\n   */\n  duration: number;\n\n  /**\n   * ISO timestamp when command started\n   */\n  timestamp: string;\n}\n\n// Background Process Types\n\nexport interface ProcessOptions extends BaseExecOptions {\n  /**\n   * Custom process ID for later reference\n   * If not provided, a UUID will be generated\n   */\n  processId?: string;\n\n  /**\n   * Automatically cleanup process record after exit (default: true)\n   */\n  autoCleanup?: boolean;\n\n  /**\n   * Callback when process exits\n   */\n  onExit?: (code: number | null) => void;\n\n  /**\n   * Callback for real-time output (background processes)\n   */\n  onOutput?: (stream: 'stdout' | 'stderr', data: string) => void;\n\n  /**\n   * Callback when process starts successfully\n   */\n  onStart?: (process: Process) => void;\n\n  /**\n   * Callback for process errors\n   */\n  onError?: (error: Error) => void;\n}\n\nexport type ProcessStatus =\n  | 'starting'    // Process is being initialized\n  | 'running'     // Process is actively running\n  | 'completed'   // Process exited successfully (code 0)\n  | 'failed'      // Process exited with non-zero code\n  | 'killed'      // Process was terminated by signal\n  | 'error';      // Process failed to start or encountered error\n\nexport interface Process {\n  /**\n   * Unique process identifier\n   */\n  readonly id: string;\n\n  /**\n   * System process ID (if available and running)\n   */\n  readonly pid?: number;\n\n  /**\n   * Command that was executed\n   */\n  readonly command: string;\n\n\n  /**\n   * Current process status\n   */\n  readonly status: ProcessStatus;\n\n  /**\n   * When the process was started\n   */\n  readonly startTime: Date;\n\n  /**\n   * When the process ended (if completed)\n   */\n  readonly endTime?: Date;\n\n  /**\n   * Process exit code (if completed)\n   */\n  readonly exitCode?: number;\n\n  /**\n   * Kill the process\n   */\n  kill(signal?: string): Promise<void>;\n\n  /**\n   * Get current process status (refreshed)\n   */\n  getStatus(): Promise<ProcessStatus>;\n\n  /**\n   * Get accumulated logs\n   */\n  getLogs(): Promise<{ stdout: string; stderr: string }>;\n}\n\n// Streaming Types\n\nexport interface ExecEvent {\n  type: 'start' | 'stdout' | 'stderr' | 'complete' | 'error';\n  timestamp: string;\n  data?: string;\n  command?: string;\n  exitCode?: number;\n  result?: ExecResult;\n  error?: string; // Changed to string for serialization\n}\n\nexport interface LogEvent {\n  type: 'stdout' | 'stderr' | 'exit' | 'error';\n  timestamp: string;\n  data: string;\n  processId: string;\n  exitCode?: number; // For 'exit' events\n}\n\nexport interface StreamOptions extends BaseExecOptions {\n  /**\n   * Buffer size for streaming output\n   */\n  bufferSize?: number;\n\n  /**\n   * AbortSignal for cancelling stream\n   */\n  signal?: AbortSignal;\n}\n\n// File Streaming Types\n\n/**\n * SSE events for file streaming\n */\nexport type FileStreamEvent =\n  | {\n      type: 'metadata';\n      mimeType: string;\n      size: number;\n      isBinary: boolean;\n      encoding: 'utf-8' | 'base64';\n    }\n  | {\n      type: 'chunk';\n      data: string; // base64 for binary, UTF-8 for text\n    }\n  | {\n      type: 'complete';\n      bytesRead: number;\n    }\n  | {\n      type: 'error';\n      error: string;\n    };\n\n/**\n * File metadata from streaming\n */\nexport interface FileMetadata {\n  mimeType: string;\n  size: number;\n  isBinary: boolean;\n  encoding: 'utf-8' | 'base64';\n}\n\n/**\n * File stream chunk - either string (text) or Uint8Array (binary, auto-decoded)\n */\nexport type FileChunk = string | Uint8Array;\n\n/**\n * AsyncIterable of file chunks with metadata\n */\nexport interface FileStream extends AsyncIterable<FileChunk> {\n  metadata?: FileMetadata;\n}\n\n// Error Types\n\nexport class SandboxError extends Error {\n  constructor(message: string, public code?: string) {\n    super(message);\n    this.name = 'SandboxError';\n  }\n}\n\nexport class ProcessNotFoundError extends SandboxError {\n  constructor(processId: string) {\n    super(`Process not found: ${processId}`, 'PROCESS_NOT_FOUND');\n    this.name = 'ProcessNotFoundError';\n  }\n}\n\nexport class ProcessAlreadyExistsError extends SandboxError {\n  constructor(processId: string) {\n    super(`Process already exists: ${processId}`, 'PROCESS_EXISTS');\n    this.name = 'ProcessAlreadyExistsError';\n  }\n}\n\nexport class ExecutionTimeoutError extends SandboxError {\n  constructor(timeout: number) {\n    super(`Execution timed out after ${timeout}ms`, 'EXECUTION_TIMEOUT');\n    this.name = 'ExecutionTimeoutError';\n  }\n}\n\n// Internal Container Types\n\nexport interface ProcessRecord {\n  id: string;\n  pid?: number;\n  command: string;\n  status: ProcessStatus;\n  startTime: Date;\n  endTime?: Date;\n  exitCode?: number;\n\n  // Internal fields\n  stdout: string;      // Accumulated output (ephemeral)\n  stderr: string;      // Accumulated output (ephemeral)\n\n  // Streaming\n  outputListeners: Set<(stream: 'stdout' | 'stderr', data: string) => void>;\n  statusListeners: Set<(status: ProcessStatus) => void>;\n}\n\n// Container Request/Response Types\n\nexport interface StartProcessRequest {\n  command: string;\n  options?: {\n    processId?: string;\n    timeout?: number;\n    env?: Record<string, string>;\n    cwd?: string;\n    encoding?: string;\n    autoCleanup?: boolean;\n  };\n}\n\nexport interface StartProcessResponse {\n  process: {\n    id: string;\n    pid?: number;\n    command: string;\n    status: ProcessStatus;\n    startTime: string;\n    endTime?: string | null;\n    exitCode?: number | null;\n    sessionId: string;\n  };\n}\n\nexport interface ListProcessesResponse {\n  processes: Array<{\n    id: string;\n    pid?: number;\n    command: string;\n      status: ProcessStatus;\n    startTime: string;\n    endTime?: string;\n    exitCode?: number;\n  }>;\n}\n\nexport interface GetProcessResponse {\n  process: {\n    id: string;\n    pid?: number;\n    command: string;\n      status: ProcessStatus;\n    startTime: string;\n    endTime?: string;\n    exitCode?: number;\n  } | null;\n}\n\nexport interface GetProcessLogsResponse {\n  stdout: string;\n  stderr: string;\n  processId: string;\n}\n\n// Import code interpreter types\nimport type {\n  CodeContext,\n  CreateContextOptions,\n  ExecutionResult, \n  RunCodeOptions\n} from './interpreter-types';\n\n// Main Sandbox Interface\n\nexport interface ISandbox {\n  // Enhanced execution API\n  exec(command: string, options?: ExecOptions): Promise<ExecResult>;\n\n  // Background process management\n  startProcess(command: string, options?: ProcessOptions): Promise<Process>;\n  listProcesses(): Promise<Process[]>;\n  getProcess(id: string): Promise<Process | null>;\n  killProcess(id: string, signal?: string): Promise<void>;\n  killAllProcesses(): Promise<number>;\n\n  // Advanced streaming - returns ReadableStream that can be converted to AsyncIterable\n  execStream(command: string, options?: StreamOptions): Promise<ReadableStream<Uint8Array>>;\n  streamProcessLogs(processId: string, options?: { signal?: AbortSignal }): Promise<ReadableStream<Uint8Array>>;\n\n  // Utility methods\n  cleanupCompletedProcesses(): Promise<number>;\n  getProcessLogs(id: string): Promise<{ stdout: string; stderr: string }>;\n\n  // File operations\n  gitCheckout(repoUrl: string, options: { branch?: string; targetDir?: string }): Promise<GitCheckoutResponse>;\n  mkdir(path: string, options?: { recursive?: boolean }): Promise<MkdirResponse>;\n  writeFile(path: string, content: string, options?: { encoding?: string }): Promise<WriteFileResponse>;\n  deleteFile(path: string): Promise<DeleteFileResponse>;\n  renameFile(oldPath: string, newPath: string): Promise<RenameFileResponse>;\n  moveFile(sourcePath: string, destinationPath: string): Promise<MoveFileResponse>;\n  readFile(path: string, options?: { encoding?: string }): Promise<ReadFileResponse>;\n  readFileStream(path: string): Promise<ReadableStream<Uint8Array>>;\n  listFiles(path: string, options?: { recursive?: boolean; includeHidden?: boolean }): Promise<ListFilesResponse>;\n\n  // Port management\n  exposePort(port: number, options: { name?: string; hostname: string }): Promise<{ url: string; port: number; name?: string }>;\n  unexposePort(port: number): Promise<void>;\n  getExposedPorts(hostname: string): Promise<Array<{ url: string; port: number; name?: string; exposedAt: string }>>;\n\n  // Environment management\n  setEnvVars(envVars: Record<string, string>): Promise<void>;\n  setSandboxName(name: string): Promise<void>;\n\n  // Code Interpreter API\n  createCodeContext(options?: CreateContextOptions): Promise<CodeContext>;\n  runCode(code: string, options?: RunCodeOptions): Promise<ExecutionResult>;\n  runCodeStream(code: string, options?: RunCodeOptions): Promise<ReadableStream>;\n  listCodeContexts(): Promise<CodeContext[]>;\n  deleteCodeContext(contextId: string): Promise<void>;\n}\n\n// Execution session returned by createSession()\n// Sessions are full-featured sandbox objects with scoped execution context\n// Inherits all ISandbox methods except createSession (sessions can't create sub-sessions),\n// and setSandboxName (sessions inherit sandbox name).\nexport interface ExecutionSession extends Omit<ISandbox, 'createSession' | 'setSandboxName'> {\n  /**\n   * Session ID\n   */\n  id: string;\n}\n\n// API Response Types\n\nexport interface ExecuteResponse {\n  success: boolean;\n  stdout: string;\n  stderr: string;\n  exitCode: number;\n  command: string;\n  timestamp: string;\n}\n\nexport interface GitCheckoutResponse {\n  success: boolean;\n  stdout: string;\n  stderr: string;\n  exitCode: number;\n  repoUrl: string;\n  branch: string;\n  targetDir: string;\n  timestamp: string;\n}\n\nexport interface MkdirResponse {\n  success: boolean;\n  stdout: string;\n  stderr: string;\n  exitCode: number;\n  path: string;\n  recursive: boolean;\n  timestamp: string;\n}\n\nexport interface WriteFileResponse {\n  success: boolean;\n  exitCode: number;\n  path: string;\n  timestamp: string;\n}\n\nexport interface ReadFileResponse {\n  success: boolean;\n  exitCode: number;\n  path: string;\n  content: string;\n  timestamp: string;\n\n  /**\n   * Encoding used for content (utf-8 for text, base64 for binary)\n   */\n  encoding?: 'utf-8' | 'base64';\n\n  /**\n   * Whether the file is detected as binary\n   */\n  isBinary?: boolean;\n\n  /**\n   * MIME type of the file (e.g., 'image/png', 'text/plain')\n   */\n  mimeType?: string;\n\n  /**\n   * File size in bytes\n   */\n  size?: number;\n}\n\nexport interface DeleteFileResponse {\n  success: boolean;\n  exitCode: number;\n  path: string;\n  timestamp: string;\n}\n\nexport interface RenameFileResponse {\n  success: boolean;\n  exitCode: number;\n  oldPath: string;\n  newPath: string;\n  timestamp: string;\n}\n\nexport interface MoveFileResponse {\n  success: boolean;\n  exitCode: number;\n  sourcePath: string;\n  destinationPath: string;\n  timestamp: string;\n}\n\nexport interface ListFilesResponse {\n  success: boolean;\n  exitCode: number;\n  path: string;\n  files: Array<{\n    name: string;\n    absolutePath: string;\n    relativePath: string;\n    type: 'file' | 'directory' | 'symlink' | 'other';\n    size: number;\n    modifiedAt: string;\n    mode: string;\n    permissions: {\n      readable: boolean;\n      writable: boolean;\n      executable: boolean;\n    };\n  }>;\n  timestamp: string;\n}\n\n// Type Guards\n\nexport function isExecResult(value: any): value is ExecResult {\n  return value &&\n    typeof value.success === 'boolean' &&\n    typeof value.exitCode === 'number' &&\n    typeof value.stdout === 'string' &&\n    typeof value.stderr === 'string';\n}\n\nexport function isProcess(value: any): value is Process {\n  return value &&\n    typeof value.id === 'string' &&\n    typeof value.command === 'string' &&\n    typeof value.status === 'string';\n}\n\nexport function isProcessStatus(value: string): value is ProcessStatus {\n  return ['starting', 'running', 'completed', 'failed', 'killed', 'error'].includes(value);\n}"],"mappings":";AA2QO,IAAM,eAAN,cAA2B,MAAM;AAAA,EACtC,YAAY,SAAwB,MAAe;AACjD,UAAM,OAAO;AADqB;AAElC,SAAK,OAAO;AAAA,EACd;AACF;AAEO,IAAM,uBAAN,cAAmC,aAAa;AAAA,EACrD,YAAY,WAAmB;AAC7B,UAAM,sBAAsB,SAAS,IAAI,mBAAmB;AAC5D,SAAK,OAAO;AAAA,EACd;AACF;AAEO,IAAM,4BAAN,cAAwC,aAAa;AAAA,EAC1D,YAAY,WAAmB;AAC7B,UAAM,2BAA2B,SAAS,IAAI,gBAAgB;AAC9D,SAAK,OAAO;AAAA,EACd;AACF;AAEO,IAAM,wBAAN,cAAoC,aAAa;AAAA,EACtD,YAAY,SAAiB;AAC3B,UAAM,6BAA6B,OAAO,MAAM,mBAAmB;AACnE,SAAK,OAAO;AAAA,EACd;AACF;AAoQO,SAAS,aAAa,OAAiC;AAC5D,SAAO,SACL,OAAO,MAAM,YAAY,aACzB,OAAO,MAAM,aAAa,YAC1B,OAAO,MAAM,WAAW,YACxB,OAAO,MAAM,WAAW;AAC5B;AAEO,SAAS,UAAU,OAA8B;AACtD,SAAO,SACL,OAAO,MAAM,OAAO,YACpB,OAAO,MAAM,YAAY,YACzB,OAAO,MAAM,WAAW;AAC5B;AAEO,SAAS,gBAAgB,OAAuC;AACrE,SAAO,CAAC,YAAY,WAAW,aAAa,UAAU,UAAU,OAAO,EAAE,SAAS,KAAK;AACzF;","names":[]}