withruntime 0.8.4 → 0.10.0

package/dist/cloudflare/worker.d.ts

@@ -0,0 +1,419 @@
+/** Workers conditional entry. The Durable Object coordinates requests and stores
+ * configuration; Runtime owns compute. Existing Container/Wrangler declarations
+ * still need removal during infrastructure migration. */
+import { DurableObject } from "cloudflare:workers";
+import type { DurableObjectState, DurableObjectNamespace, Request as WorkerRequest, Response as WorkerResponse } from "@cloudflare/workers-types/index.ts";
+import { Sandbox as RuntimeSandbox, type SandboxOptions, type SessionOptions, type ExecOptions, type ProcessOptions, type ReadFileResult, type ReadFileStreamResult } from "./index.js";
+export * from "./index.js";
+export interface RuntimeWorkerEnv {
+    RUNTIME_API_KEY: string;
+    RUNTIME_API_URL?: string;
+}
+type Configuration = {
+    sandboxName?: {
+        name: string;
+        normalizeId?: boolean;
+    };
+    nativeSandboxId?: string;
+    sleepAfter?: string | number;
+    keepAlive?: boolean;
+};
+export declare class Sandbox<Env extends RuntimeWorkerEnv = RuntimeWorkerEnv> extends DurableObject<Env> {
+    private configuration;
+    private configurationIntent?;
+    private facade?;
+    private configurationTail;
+    private configurationOperation;
+    private previewTail;
+    private previewOperation;
+    private readonly initialized;
+    constructor(ctx: DurableObjectState, env: Env);
+    private sandbox;
+    configure(configuration: Configuration): Promise<void>;
+    setSandboxName(name: string, normalizeId?: boolean): Promise<void>;
+    setSleepAfter(sleepAfter: string | number): Promise<void>;
+    setKeepAlive(keepAlive: boolean): Promise<void>;
+    exec(command: string, options?: ExecOptions): Promise<import("./index.js").ExecResult>;
+    execStream(command: string, options?: ExecOptions): Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>;
+    startProcess(command: string, options?: ProcessOptions): Promise<{
+        id: string;
+        command: string;
+        status: string;
+        startTime: Date;
+        endTime: Date | undefined;
+        exitCode: number | undefined;
+        sessionId: string | 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;
+        }>;
+    }>;
+    listProcesses(): Promise<{
+        id: string;
+        command: string;
+        status: string;
+        startTime: Date;
+        endTime: Date | undefined;
+        exitCode: number | undefined;
+        sessionId: string | 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;
+        }>;
+    }[]>;
+    getProcess(id: string): Promise<{
+        id: string;
+        command: string;
+        status: string;
+        startTime: Date;
+        endTime: Date | undefined;
+        exitCode: number | undefined;
+        sessionId: string | 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;
+        }>;
+    } | null>;
+    getProcessLogs(id: string): Promise<{
+        stdout: string;
+        stderr: string;
+        processId: string;
+    }>;
+    killProcess(id: string, signal?: string): Promise<void>;
+    killAllProcesses(): Promise<number>;
+    createSession(options?: SessionOptions): Promise<{
+        id: string;
+        exec: (command: string, options?: ExecOptions) => Promise<import("./index.js").ExecResult>;
+        execStream: (command: string, options?: ExecOptions) => Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>;
+        startProcess: (command: string, options?: ProcessOptions) => Promise<{
+            id: string;
+            command: string;
+            status: string;
+            startTime: Date;
+            endTime: Date | undefined;
+            exitCode: number | undefined;
+            sessionId: string | 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;
+            }>;
+        }>;
+        writeFile: (path: string, content: string | ReadableStream<Uint8Array<ArrayBufferLike>>, options?: {
+            encoding?: string;
+        } | undefined) => Promise<{
+            success: boolean;
+            path: string;
+            bytesWritten: number;
+            timestamp: string;
+        }>;
+        readFile: {
+            (path: string, options: {
+                encoding: "none";
+            }): Promise<ReadFileStreamResult>;
+            (path: string, options?: {
+                encoding?: "utf8" | "utf-8" | "base64";
+            }): Promise<ReadFileResult>;
+        };
+        mkdir: (path: string, options?: {
+            recursive?: boolean;
+        } | undefined) => Promise<{
+            success: boolean;
+            path: string;
+            timestamp: string;
+        }>;
+        deleteFile: (path: string) => Promise<{
+            success: boolean;
+            path: string;
+            timestamp: string;
+        }>;
+        renameFile: (path: string, to: string) => Promise<{
+            success: boolean;
+            path: string;
+            newPath: string;
+            timestamp: string;
+        }>;
+        moveFile: (path: string, to: 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;
+        } | undefined) => 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>;
+    }>;
+    getSession(id: string): Promise<{
+        id: string;
+        exec: (command: string, options?: ExecOptions) => Promise<import("./index.js").ExecResult>;
+        execStream: (command: string, options?: ExecOptions) => Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>;
+        startProcess: (command: string, options?: ProcessOptions) => Promise<{
+            id: string;
+            command: string;
+            status: string;
+            startTime: Date;
+            endTime: Date | undefined;
+            exitCode: number | undefined;
+            sessionId: string | 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;
+            }>;
+        }>;
+        writeFile: (path: string, content: string | ReadableStream<Uint8Array<ArrayBufferLike>>, options?: {
+            encoding?: string;
+        } | undefined) => Promise<{
+            success: boolean;
+            path: string;
+            bytesWritten: number;
+            timestamp: string;
+        }>;
+        readFile: {
+            (path: string, options: {
+                encoding: "none";
+            }): Promise<ReadFileStreamResult>;
+            (path: string, options?: {
+                encoding?: "utf8" | "utf-8" | "base64";
+            }): Promise<ReadFileResult>;
+        };
+        mkdir: (path: string, options?: {
+            recursive?: boolean;
+        } | undefined) => Promise<{
+            success: boolean;
+            path: string;
+            timestamp: string;
+        }>;
+        deleteFile: (path: string) => Promise<{
+            success: boolean;
+            path: string;
+            timestamp: string;
+        }>;
+        renameFile: (path: string, to: string) => Promise<{
+            success: boolean;
+            path: string;
+            newPath: string;
+            timestamp: string;
+        }>;
+        moveFile: (path: string, to: 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;
+        } | undefined) => 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>;
+    }>;
+    deleteSession(id: string): Promise<{
+        success: boolean;
+        sessionId: string;
+        timestamp: string;
+    }>;
+    writeFile(...args: Parameters<RuntimeSandbox["writeFile"]>): 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(...args: Parameters<RuntimeSandbox["mkdir"]>): Promise<{
+        success: boolean;
+        path: string;
+        timestamp: string;
+    }>;
+    deleteFile(path: string): Promise<{
+        success: boolean;
+        path: string;
+        timestamp: string;
+    }>;
+    renameFile(path: string, to: string): Promise<{
+        success: boolean;
+        path: string;
+        newPath: string;
+        timestamp: string;
+    }>;
+    moveFile(path: string, to: string): Promise<{
+        success: boolean;
+        path: string;
+        newPath: string;
+        timestamp: string;
+    }>;
+    listFiles(...args: Parameters<RuntimeSandbox["listFiles"]>): 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;
+    }>;
+    setEnvVars(...args: Parameters<RuntimeSandbox["setEnvVars"]>): Promise<void>;
+    exposePort(port: number, options: {
+        name?: string;
+        hostname: string;
+        token?: string;
+    }): Promise<{
+        url: string;
+        port: number;
+        name: string | undefined;
+    }>;
+    private expose;
+    unexposePort(port: number): Promise<void>;
+    isPortExposed(port: number): Promise<boolean>;
+    validatePortToken(port: number, token: string): Promise<boolean>;
+    getExposedPorts(hostname: string): Promise<{
+        url: string;
+        port: number;
+        status: "active";
+    }[]>;
+    fetch(request: WorkerRequest): Promise<WorkerResponse>;
+    private forwardPreview;
+    destroy(): Promise<void>;
+}
+export declare function getSandbox<T extends Sandbox>(namespace: DurableObjectNamespace<T>, id: string, options?: SandboxOptions): T;
+export declare function proxyToSandbox(request: Request, env: {
+    Sandbox: DurableObjectNamespace<Sandbox>;
+}): Promise<Response | null>;