@cloudflare/sandbox 0.3.6 → 0.4.1

package/dist/interpreter-types.d.ts

@@ -1,259 +0,0 @@
-interface CreateContextOptions {
-    /**
-     * Programming language for the context
-     * @default 'python'
-     */
-    language?: "python" | "javascript" | "typescript";
-    /**
-     * Working directory for the context
-     * @default '/workspace'
-     */
-    cwd?: string;
-    /**
-     * Environment variables for the context
-     */
-    envVars?: Record<string, string>;
-    /**
-     * Request timeout in milliseconds
-     * @default 30000
-     */
-    timeout?: number;
-}
-interface CodeContext {
-    /**
-     * Unique identifier for the context
-     */
-    readonly id: string;
-    /**
-     * Programming language of the context
-     */
-    readonly language: string;
-    /**
-     * Current working directory
-     */
-    readonly cwd: string;
-    /**
-     * When the context was created
-     */
-    readonly createdAt: Date;
-    /**
-     * When the context was last used
-     */
-    readonly lastUsed: Date;
-}
-interface RunCodeOptions {
-    /**
-     * Context to run the code in. If not provided, uses default context for the language
-     */
-    context?: CodeContext;
-    /**
-     * Language to use if context is not provided
-     * @default 'python'
-     */
-    language?: "python" | "javascript" | "typescript";
-    /**
-     * Environment variables for this execution
-     */
-    envVars?: Record<string, string>;
-    /**
-     * Execution timeout in milliseconds
-     * @default 60000
-     */
-    timeout?: number;
-    /**
-     * AbortSignal for cancelling execution
-     */
-    signal?: AbortSignal;
-    /**
-     * Callback for stdout output
-     */
-    onStdout?: (output: OutputMessage) => void | Promise<void>;
-    /**
-     * Callback for stderr output
-     */
-    onStderr?: (output: OutputMessage) => void | Promise<void>;
-    /**
-     * Callback for execution results (charts, tables, etc)
-     */
-    onResult?: (result: Result) => void | Promise<void>;
-    /**
-     * Callback for execution errors
-     */
-    onError?: (error: ExecutionError) => void | Promise<void>;
-}
-interface OutputMessage {
-    /**
-     * The output text
-     */
-    text: string;
-    /**
-     * Timestamp of the output
-     */
-    timestamp: number;
-}
-interface Result {
-    /**
-     * Plain text representation
-     */
-    text?: string;
-    /**
-     * HTML representation (tables, formatted output)
-     */
-    html?: string;
-    /**
-     * PNG image data (base64 encoded)
-     */
-    png?: string;
-    /**
-     * JPEG image data (base64 encoded)
-     */
-    jpeg?: string;
-    /**
-     * SVG image data
-     */
-    svg?: string;
-    /**
-     * LaTeX representation
-     */
-    latex?: string;
-    /**
-     * Markdown representation
-     */
-    markdown?: string;
-    /**
-     * JavaScript code to execute
-     */
-    javascript?: string;
-    /**
-     * JSON data
-     */
-    json?: any;
-    /**
-     * Chart data if the result is a visualization
-     */
-    chart?: ChartData;
-    /**
-     * Raw data object
-     */
-    data?: any;
-    /**
-     * Available output formats
-     */
-    formats(): string[];
-}
-interface ChartData {
-    /**
-     * Type of chart
-     */
-    type: "line" | "bar" | "scatter" | "pie" | "histogram" | "heatmap" | "unknown";
-    /**
-     * Chart title
-     */
-    title?: string;
-    /**
-     * Chart data (format depends on library)
-     */
-    data: any;
-    /**
-     * Chart layout/configuration
-     */
-    layout?: any;
-    /**
-     * Additional configuration
-     */
-    config?: any;
-    /**
-     * Library that generated the chart
-     */
-    library?: "matplotlib" | "plotly" | "altair" | "seaborn" | "unknown";
-    /**
-     * Base64 encoded image if available
-     */
-    image?: string;
-}
-interface ExecutionError {
-    /**
-     * Error name/type (e.g., 'NameError', 'SyntaxError')
-     */
-    name: string;
-    /**
-     * Error message
-     */
-    value: string;
-    /**
-     * Stack trace
-     */
-    traceback: string[];
-    /**
-     * Line number where error occurred
-     */
-    lineNumber?: number;
-}
-interface ExecutionResult {
-    code: string;
-    logs: {
-        stdout: string[];
-        stderr: string[];
-    };
-    error?: ExecutionError;
-    executionCount?: number;
-    results: Array<{
-        text?: string;
-        html?: string;
-        png?: string;
-        jpeg?: string;
-        svg?: string;
-        latex?: string;
-        markdown?: string;
-        javascript?: string;
-        json?: any;
-        chart?: ChartData;
-        data?: any;
-    }>;
-}
-declare class Execution {
-    readonly code: string;
-    readonly context: CodeContext;
-    /**
-     * All results from the execution
-     */
-    results: Result[];
-    /**
-     * Accumulated stdout and stderr
-     */
-    logs: {
-        stdout: string[];
-        stderr: string[];
-    };
-    /**
-     * Execution error if any
-     */
-    error?: ExecutionError;
-    /**
-     * Execution count (for interpreter)
-     */
-    executionCount?: number;
-    constructor(code: string, context: CodeContext);
-    /**
-     * Convert to a plain object for serialization
-     */
-    toJSON(): ExecutionResult;
-}
-declare class ResultImpl implements Result {
-    private raw;
-    constructor(raw: any);
-    get text(): string | undefined;
-    get html(): string | undefined;
-    get png(): string | undefined;
-    get jpeg(): string | undefined;
-    get svg(): string | undefined;
-    get latex(): string | undefined;
-    get markdown(): string | undefined;
-    get javascript(): string | undefined;
-    get json(): any;
-    get chart(): ChartData | undefined;
-    get data(): any;
-    formats(): string[];
-}
-
-export { type ChartData, type CodeContext, type CreateContextOptions, Execution, type ExecutionError, type ExecutionResult, type OutputMessage, type Result, ResultImpl, type RunCodeOptions };

package/dist/interpreter-types.js

@@ -1,9 +0,0 @@
-import {
-  Execution,
-  ResultImpl
-} from "./chunk-W7TVRPBG.js";
-export {
-  Execution,
-  ResultImpl
-};
-//# sourceMappingURL=interpreter-types.js.map

package/dist/interpreter-types.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types.d.ts

@@ -1,453 +0,0 @@
-import { CreateContextOptions, CodeContext, RunCodeOptions, ExecutionResult } from './interpreter-types.js';
-
-interface BaseExecOptions {
-    /**
-     * Maximum execution time in milliseconds
-     */
-    timeout?: number;
-    /**
-     * Environment variables for the command
-     */
-    env?: Record<string, string>;
-    /**
-     * Working directory for command execution
-     */
-    cwd?: string;
-    /**
-     * Text encoding for output (default: 'utf8')
-     */
-    encoding?: string;
-}
-interface ExecOptions extends BaseExecOptions {
-    /**
-     * Enable real-time output streaming via callbacks
-     */
-    stream?: boolean;
-    /**
-     * Callback for real-time output data
-     */
-    onOutput?: (stream: 'stdout' | 'stderr', data: string) => void;
-    /**
-     * Callback when command completes (only when stream: true)
-     */
-    onComplete?: (result: ExecResult) => void;
-    /**
-     * Callback for execution errors
-     */
-    onError?: (error: Error) => void;
-    /**
-     * AbortSignal for cancelling execution
-     */
-    signal?: AbortSignal;
-}
-interface ExecResult {
-    /**
-     * Whether the command succeeded (exitCode === 0)
-     */
-    success: boolean;
-    /**
-     * Process exit code
-     */
-    exitCode: number;
-    /**
-     * Standard output content
-     */
-    stdout: string;
-    /**
-     * Standard error content
-     */
-    stderr: string;
-    /**
-     * Command that was executed
-     */
-    command: string;
-    /**
-     * Execution duration in milliseconds
-     */
-    duration: number;
-    /**
-     * ISO timestamp when command started
-     */
-    timestamp: string;
-}
-interface ProcessOptions extends BaseExecOptions {
-    /**
-     * Custom process ID for later reference
-     * If not provided, a UUID will be generated
-     */
-    processId?: string;
-    /**
-     * Automatically cleanup process record after exit (default: true)
-     */
-    autoCleanup?: boolean;
-    /**
-     * Callback when process exits
-     */
-    onExit?: (code: number | null) => void;
-    /**
-     * Callback for real-time output (background processes)
-     */
-    onOutput?: (stream: 'stdout' | 'stderr', data: string) => void;
-    /**
-     * Callback when process starts successfully
-     */
-    onStart?: (process: Process) => void;
-    /**
-     * Callback for process errors
-     */
-    onError?: (error: Error) => void;
-}
-type ProcessStatus = 'starting' | 'running' | 'completed' | 'failed' | 'killed' | 'error';
-interface Process {
-    /**
-     * Unique process identifier
-     */
-    readonly id: string;
-    /**
-     * System process ID (if available and running)
-     */
-    readonly pid?: number;
-    /**
-     * Command that was executed
-     */
-    readonly command: string;
-    /**
-     * Current process status
-     */
-    readonly status: ProcessStatus;
-    /**
-     * When the process was started
-     */
-    readonly startTime: Date;
-    /**
-     * When the process ended (if completed)
-     */
-    readonly endTime?: Date;
-    /**
-     * Process exit code (if completed)
-     */
-    readonly exitCode?: number;
-    /**
-     * Kill the process
-     */
-    kill(signal?: string): Promise<void>;
-    /**
-     * Get current process status (refreshed)
-     */
-    getStatus(): Promise<ProcessStatus>;
-    /**
-     * Get accumulated logs
-     */
-    getLogs(): Promise<{
-        stdout: string;
-        stderr: string;
-    }>;
-}
-interface ExecEvent {
-    type: 'start' | 'stdout' | 'stderr' | 'complete' | 'error';
-    timestamp: string;
-    data?: string;
-    command?: string;
-    exitCode?: number;
-    result?: ExecResult;
-    error?: string;
-}
-interface LogEvent {
-    type: 'stdout' | 'stderr' | 'exit' | 'error';
-    timestamp: string;
-    data: string;
-    processId: string;
-    exitCode?: number;
-}
-interface StreamOptions extends BaseExecOptions {
-    /**
-     * Buffer size for streaming output
-     */
-    bufferSize?: number;
-    /**
-     * AbortSignal for cancelling stream
-     */
-    signal?: AbortSignal;
-}
-/**
- * SSE events for file streaming
- */
-type FileStreamEvent = {
-    type: 'metadata';
-    mimeType: string;
-    size: number;
-    isBinary: boolean;
-    encoding: 'utf-8' | 'base64';
-} | {
-    type: 'chunk';
-    data: string;
-} | {
-    type: 'complete';
-    bytesRead: number;
-} | {
-    type: 'error';
-    error: string;
-};
-/**
- * File metadata from streaming
- */
-interface FileMetadata {
-    mimeType: string;
-    size: number;
-    isBinary: boolean;
-    encoding: 'utf-8' | 'base64';
-}
-/**
- * File stream chunk - either string (text) or Uint8Array (binary, auto-decoded)
- */
-type FileChunk = string | Uint8Array;
-/**
- * AsyncIterable of file chunks with metadata
- */
-interface FileStream extends AsyncIterable<FileChunk> {
-    metadata?: FileMetadata;
-}
-declare class SandboxError extends Error {
-    code?: string | undefined;
-    constructor(message: string, code?: string | undefined);
-}
-declare class ProcessNotFoundError extends SandboxError {
-    constructor(processId: string);
-}
-declare class ProcessAlreadyExistsError extends SandboxError {
-    constructor(processId: string);
-}
-declare class ExecutionTimeoutError extends SandboxError {
-    constructor(timeout: number);
-}
-interface ProcessRecord {
-    id: string;
-    pid?: number;
-    command: string;
-    status: ProcessStatus;
-    startTime: Date;
-    endTime?: Date;
-    exitCode?: number;
-    stdout: string;
-    stderr: string;
-    outputListeners: Set<(stream: 'stdout' | 'stderr', data: string) => void>;
-    statusListeners: Set<(status: ProcessStatus) => void>;
-}
-interface StartProcessRequest {
-    command: string;
-    options?: {
-        processId?: string;
-        timeout?: number;
-        env?: Record<string, string>;
-        cwd?: string;
-        encoding?: string;
-        autoCleanup?: boolean;
-    };
-}
-interface StartProcessResponse {
-    process: {
-        id: string;
-        pid?: number;
-        command: string;
-        status: ProcessStatus;
-        startTime: string;
-        endTime?: string | null;
-        exitCode?: number | null;
-        sessionId: string;
-    };
-}
-interface ListProcessesResponse {
-    processes: Array<{
-        id: string;
-        pid?: number;
-        command: string;
-        status: ProcessStatus;
-        startTime: string;
-        endTime?: string;
-        exitCode?: number;
-    }>;
-}
-interface GetProcessResponse {
-    process: {
-        id: string;
-        pid?: number;
-        command: string;
-        status: ProcessStatus;
-        startTime: string;
-        endTime?: string;
-        exitCode?: number;
-    } | null;
-}
-interface GetProcessLogsResponse {
-    stdout: string;
-    stderr: string;
-    processId: string;
-}
-
-interface ISandbox {
-    exec(command: string, options?: ExecOptions): Promise<ExecResult>;
-    startProcess(command: string, options?: ProcessOptions): Promise<Process>;
-    listProcesses(): Promise<Process[]>;
-    getProcess(id: string): Promise<Process | null>;
-    killProcess(id: string, signal?: string): Promise<void>;
-    killAllProcesses(): Promise<number>;
-    execStream(command: string, options?: StreamOptions): Promise<ReadableStream<Uint8Array>>;
-    streamProcessLogs(processId: string, options?: {
-        signal?: AbortSignal;
-    }): Promise<ReadableStream<Uint8Array>>;
-    cleanupCompletedProcesses(): Promise<number>;
-    getProcessLogs(id: string): Promise<{
-        stdout: string;
-        stderr: string;
-    }>;
-    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>;
-    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;
-    }>>;
-    setEnvVars(envVars: Record<string, string>): Promise<void>;
-    setSandboxName(name: string): Promise<void>;
-    createCodeContext(options?: CreateContextOptions): Promise<CodeContext>;
-    runCode(code: string, options?: RunCodeOptions): Promise<ExecutionResult>;
-    runCodeStream(code: string, options?: RunCodeOptions): Promise<ReadableStream>;
-    listCodeContexts(): Promise<CodeContext[]>;
-    deleteCodeContext(contextId: string): Promise<void>;
-}
-interface ExecutionSession extends Omit<ISandbox, 'createSession' | 'setSandboxName'> {
-    /**
-     * Session ID
-     */
-    id: string;
-}
-interface ExecuteResponse {
-    success: boolean;
-    stdout: string;
-    stderr: string;
-    exitCode: number;
-    command: string;
-    timestamp: string;
-}
-interface GitCheckoutResponse {
-    success: boolean;
-    stdout: string;
-    stderr: string;
-    exitCode: number;
-    repoUrl: string;
-    branch: string;
-    targetDir: string;
-    timestamp: string;
-}
-interface MkdirResponse {
-    success: boolean;
-    stdout: string;
-    stderr: string;
-    exitCode: number;
-    path: string;
-    recursive: boolean;
-    timestamp: string;
-}
-interface WriteFileResponse {
-    success: boolean;
-    exitCode: number;
-    path: string;
-    timestamp: string;
-}
-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;
-}
-interface DeleteFileResponse {
-    success: boolean;
-    exitCode: number;
-    path: string;
-    timestamp: string;
-}
-interface RenameFileResponse {
-    success: boolean;
-    exitCode: number;
-    oldPath: string;
-    newPath: string;
-    timestamp: string;
-}
-interface MoveFileResponse {
-    success: boolean;
-    exitCode: number;
-    sourcePath: string;
-    destinationPath: string;
-    timestamp: string;
-}
-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;
-}
-declare function isExecResult(value: any): value is ExecResult;
-declare function isProcess(value: any): value is Process;
-declare function isProcessStatus(value: string): value is ProcessStatus;
-
-export { type BaseExecOptions, type DeleteFileResponse, type ExecEvent, type ExecOptions, type ExecResult, type ExecuteResponse, type ExecutionSession, ExecutionTimeoutError, type FileChunk, type FileMetadata, type FileStream, type FileStreamEvent, type GetProcessLogsResponse, type GetProcessResponse, type GitCheckoutResponse, type ISandbox, type ListFilesResponse, type ListProcessesResponse, type LogEvent, type MkdirResponse, type MoveFileResponse, type Process, ProcessAlreadyExistsError, ProcessNotFoundError, type ProcessOptions, type ProcessRecord, type ProcessStatus, type ReadFileResponse, type RenameFileResponse, SandboxError, type StartProcessRequest, type StartProcessResponse, type StreamOptions, type WriteFileResponse, isExecResult, isProcess, isProcessStatus };