withruntime 0.8.4 → 0.9.0

package/dist/cloudflare/index.d.ts

@@ -0,0 +1,294 @@
+import { Runtime } from "../client.js";
+import type { Process as NativeProcess, Sandbox as NativeSandbox } from "../sandbox.js";
+import { CompatibilityError, type ClientOptions } from "../compat/core.js";
+export { CompatibilityError };
+export declare class SandboxSecurityError extends Error {
+    readonly code: string;
+    constructor(message: string, code: string);
+}
+export declare function sanitizeSandboxId(id: string): string;
+export interface SandboxOptions {
+    sleepAfter?: string | number;
+    keepAlive?: boolean;
+    normalizeId?: boolean;
+    runtime?: ClientOptions;
+}
+export interface ExecOptions {
+    timeout?: number;
+    env?: Record<string, string | undefined>;
+    cwd?: string;
+    encoding?: string;
+    stream?: boolean;
+    onOutput?: (stream: "stdout" | "stderr", data: string) => void;
+    onComplete?: (result: ExecResult) => void;
+    onError?: (error: Error) => void;
+    signal?: AbortSignal;
+}
+export interface ExecResult {
+    success: boolean;
+    exitCode: number;
+    stdout: string;
+    stderr: string;
+    command: string;
+    duration: number;
+    timestamp: string;
+    sessionId?: string;
+}
+export interface ReadFileResult {
+    success: boolean;
+    path: string;
+    content: string;
+    encoding: "utf-8" | "base64";
+    isBinary: boolean;
+    size: number;
+    timestamp: string;
+}
+export interface ReadFileStreamResult {
+    success: true;
+    path: string;
+    content: ReadableStream<Uint8Array>;
+    size: number;
+    mimeType: string;
+    timestamp: string;
+}
+export interface SessionOptions {
+    id?: string;
+    name?: string;
+    env?: Record<string, string | undefined>;
+    cwd?: string;
+    isolation?: boolean;
+    commandTimeoutMs?: number;
+}
+export interface ProcessOptions {
+    timeout?: number;
+    env?: Record<string, string | undefined>;
+    cwd?: string;
+    encoding?: string;
+    sessionId?: string;
+    onOutput?: (stream: "stdout" | "stderr", data: string) => void;
+    onExit?: (code: number | null) => void;
+    onStart?: (process: Process) => void;
+    onError?: (error: Error) => void;
+}
+/** Worker bindings are deliberately not inspected or invoked. Supply Runtime credentials
+ * through options.runtime in Workers; Node also supports RUNTIME_API_KEY/login. */
+export declare function getSandbox(namespace: unknown, id: string, options?: SandboxOptions): Sandbox;
+export declare class Sandbox {
+    readonly runtime: Runtime;
+    private readonly options;
+    private pending?;
+    readonly id: string;
+    constructor(runtime: Runtime, id: string, options?: SandboxOptions);
+    configure(options: Pick<SandboxOptions, "sleepAfter" | "keepAlive">): Promise<void>;
+    native(): Promise<NativeSandbox>;
+    private session;
+    exec(command: string, options?: ExecOptions): Promise<ExecResult>;
+    execStream(command: string, options?: ExecOptions): Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>;
+    startProcess(command: string, options?: ProcessOptions): Promise<Process>;
+    createSession(options?: SessionOptions): Promise<ExecutionSession>;
+    getSession(id: string): Promise<ExecutionSession>;
+    deleteSession(id: string): Promise<{
+        success: boolean;
+        sessionId: string;
+        timestamp: string;
+    }>;
+    destroy(): Promise<void>;
+    setEnvVars(env: Record<string, string | undefined>): Promise<void>;
+    writeFile(path: string, content: string | ReadableStream<Uint8Array>, options?: {
+        encoding?: string;
+    }): Promise<{
+        success: boolean;
+        path: string;
+        bytesWritten: number;
+        timestamp: string;
+    }>;
+    readFile(path: string, options: {
+        encoding: "none";
+    }): Promise<ReadFileStreamResult>;
+    readFile(path: string, options?: {
+        encoding?: "utf8" | "utf-8" | "base64";
+    }): Promise<ReadFileResult>;
+    mkdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<{
+        success: boolean;
+        path: string;
+        timestamp: string;
+    }>;
+    deleteFile(path: string): Promise<{
+        success: boolean;
+        path: string;
+        timestamp: string;
+    }>;
+    renameFile(from: string, to: string): Promise<{
+        success: boolean;
+        path: string;
+        newPath: string;
+        timestamp: string;
+    }>;
+    moveFile(from: string, to: string): Promise<{
+        success: boolean;
+        path: string;
+        newPath: string;
+        timestamp: string;
+    }>;
+    listFiles(path: string, options?: {
+        recursive?: boolean;
+        includeHidden?: boolean;
+    }): Promise<{
+        success: boolean;
+        path: string;
+        files: {
+            absolutePath: string;
+            relativePath: string;
+            permissions: {
+                readable: boolean;
+                writable: boolean;
+                executable: boolean;
+            };
+            name: string;
+            path: string;
+            type: "file" | "directory" | "symlink" | "other";
+            size: number;
+            mode: string;
+            modifiedAt: string;
+            uid?: number;
+            gid?: number;
+            owner?: string;
+            group?: string;
+            symlinkTarget?: string;
+        }[];
+        count: number;
+        timestamp: string;
+    }>;
+    exists(path: string): Promise<{
+        success: boolean;
+        path: string;
+        exists: boolean;
+        timestamp: string;
+    }>;
+    listProcesses(): Promise<Process[]>;
+    getProcess(id: string): Promise<Process | null>;
+    killProcess(id: string, signal?: string): Promise<void>;
+    killAllProcesses(): Promise<number>;
+    getProcessLogs(id: string): Promise<{
+        stdout: string;
+        stderr: string;
+        processId: string;
+    }>;
+    exposePort(port: number, options: {
+        name?: string;
+        hostname: string;
+        token?: string;
+    }): Promise<{
+        url: string;
+        port: number;
+        name: string | undefined;
+    }>;
+    unexposePort(port: number): Promise<void>;
+}
+export declare class ExecutionSession {
+    private readonly sandbox;
+    readonly id: string;
+    private options;
+    constructor(sandbox: Sandbox, id: string, options: SessionOptions);
+    private context;
+    exec(command: string, options?: ExecOptions): Promise<ExecResult>;
+    execStream(command: string, options?: ExecOptions): Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>;
+    startProcess(command: string, options?: ProcessOptions): Promise<Process>;
+    private path;
+    writeFile(path: string, content: string | ReadableStream<Uint8Array>, options?: {
+        encoding?: string;
+    }): Promise<{
+        success: boolean;
+        path: string;
+        bytesWritten: number;
+        timestamp: string;
+    }>;
+    readFile(path: string, options: {
+        encoding: "none";
+    }): Promise<ReadFileStreamResult>;
+    readFile(path: string, options?: {
+        encoding?: "utf8" | "utf-8" | "base64";
+    }): Promise<ReadFileResult>;
+    mkdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<{
+        success: boolean;
+        path: string;
+        timestamp: string;
+    }>;
+    deleteFile(path: string): Promise<{
+        success: boolean;
+        path: string;
+        timestamp: string;
+    }>;
+    renameFile(path: string, newPath: string): Promise<{
+        success: boolean;
+        path: string;
+        newPath: string;
+        timestamp: string;
+    }>;
+    exists(path: string): Promise<{
+        success: boolean;
+        path: string;
+        exists: boolean;
+        timestamp: string;
+    }>;
+    listFiles(path: string, options?: {
+        recursive?: boolean;
+        includeHidden?: boolean;
+    }): Promise<{
+        success: boolean;
+        path: string;
+        files: {
+            absolutePath: string;
+            relativePath: string;
+            permissions: {
+                readable: boolean;
+                writable: boolean;
+                executable: boolean;
+            };
+            name: string;
+            path: string;
+            type: "file" | "directory" | "symlink" | "other";
+            size: number;
+            mode: string;
+            modifiedAt: string;
+            uid?: number;
+            gid?: number;
+            owner?: string;
+            group?: string;
+            symlinkTarget?: string;
+        }[];
+        count: number;
+        timestamp: string;
+    }>;
+    setEnvVars(env: Record<string, string | undefined>): Promise<void>;
+}
+export declare class Process {
+    private readonly sandbox;
+    private readonly native;
+    readonly sessionId?: string | undefined;
+    constructor(sandbox: Sandbox, native: NativeProcess, sessionId?: string | undefined);
+    get id(): string;
+    get command(): string;
+    get status(): "running" | "killed" | "unknown" | "failed" | "completed";
+    get startTime(): Date;
+    get endTime(): Date | undefined;
+    get exitCode(): number | undefined;
+    kill(signal?: string): Promise<void>;
+    getStatus(): Promise<"running" | "killed" | "unknown" | "failed" | "completed">;
+    getLogs(): Promise<{
+        stdout: string;
+        stderr: string;
+        processId: string;
+    }>;
+    waitForExit(timeout?: number): Promise<{
+        exitCode: number;
+    }>;
+    waitForLog(pattern: string | RegExp, timeout?: number): Promise<{
+        match?: true | RegExpMatchArray | undefined;
+        line: string;
+    }>;
+}