withruntime 0.8.4 → 0.10.0

package/dist/runloop/index.d.ts

@@ -0,0 +1,326 @@
+import { PagePromise, DevboxViewsCursorIDPage } from "./pagination.js";
+import type { Runtime } from "../client.js";
+import { Sandbox } from "../sandbox.js";
+import { DiskSnapshots, type DevboxSnapshotDiskParams, type DevboxSnapshotView, type DiskSnapshotListParams } from "./snapshots.js";
+export { DiskSnapshots, type DevboxSnapshotDiskParams, type DevboxSnapshotView, type DevboxSnapshotAsyncStatusView, type DiskSnapshotListParams, } from "./snapshots.js";
+export { PagePromise, DevboxSnapshotViewsDiskSnapshotsCursorIDPage, DevboxViewsCursorIDPage, } from "./pagination.js";
+import { CompatibilityError, type ClientOptions } from "../compat/core.js";
+export { CompatibilityError };
+export declare class LongPollAbortError extends Error {
+    readonly lastResult: unknown;
+    constructor(message: string, lastResult: unknown);
+}
+export declare class PollingTimeoutError extends Error {
+    readonly lastResult: unknown;
+    constructor(message: string, lastResult: unknown);
+}
+export declare class MaxAttemptsExceededError extends Error {
+    readonly lastResult: unknown;
+    constructor(message: string, lastResult: unknown);
+}
+export interface LaunchParameters {
+    architecture?: "x86_64" | "arm64" | null;
+    custom_cpu_cores?: number | null;
+    custom_gb_memory?: number | null;
+    custom_disk_size?: number | null;
+    resource_size_request?: "X_SMALL" | "SMALL" | "MEDIUM" | "LARGE" | "X_LARGE" | "XX_LARGE" | "CUSTOM_SIZE" | null;
+    keep_alive_time_seconds?: number | null;
+    launch_commands?: string[] | null;
+}
+export interface DevboxCreateParams {
+    name?: string | null;
+    metadata?: Record<string, string> | null;
+    environment_variables?: Record<string, string> | null;
+    file_mounts?: Record<string, string> | null;
+    blueprint_id?: string | null;
+    blueprint_name?: string | null;
+    snapshot_id?: string | null;
+    launch_parameters?: LaunchParameters | null;
+}
+export interface DevboxExecuteParams {
+    command: string;
+    shell_name?: string | null;
+    attach_stdin?: boolean | null;
+}
+export interface DevboxExecutionDetailView {
+    devbox_id: string;
+    exit_status: number | null;
+    stdout: string;
+    stderr: string;
+    stdout_truncated: boolean;
+    stderr_truncated: boolean;
+}
+export interface DevboxAsyncExecutionDetailView extends Partial<DevboxExecutionDetailView> {
+    devbox_id: string;
+    execution_id: string;
+    status: "queued" | "running" | "completed";
+}
+export type RequestOptions = {
+    signal?: AbortSignal;
+    timeout?: number;
+    idempotencyKey?: string;
+};
+export type LongPollRequestOptions = RequestOptions & {
+    longPoll?: {
+        timeoutMs?: number;
+    };
+    polling?: {
+        timeoutMs?: number;
+        maxAttempts?: number;
+        initialDelayMs?: number;
+        pollingIntervalMs?: number;
+    };
+};
+declare function view(sandbox: Sandbox): {
+    id: string;
+    name: string | null;
+    metadata: {
+        [k: string]: string;
+    };
+    status: string;
+    create_time_ms: number;
+    end_time_ms: number | null;
+    capabilities: never[];
+    state_transitions: never[];
+    launch_parameters: {
+        custom_cpu_cores: number;
+        custom_gb_memory: number;
+        custom_disk_size: number;
+        keep_alive_time_seconds: number;
+        resource_size_request: "CUSTOM_SIZE";
+    };
+};
+export type DevboxView = ReturnType<typeof view>;
+export interface DevboxListParams {
+    name?: string;
+    limit?: number;
+    starting_after?: string;
+    metadata?: Record<string, string>;
+    include_total_count?: boolean;
+    status?: "scheduled" | "queued" | "provisioning" | "initializing" | "running" | "suspending" | "suspended" | "resuming" | "failure" | "shutdown";
+}
+export declare class Runloop {
+    readonly devboxes: Devboxes;
+    constructor(options?: ClientOptions & {
+        bearerToken?: string;
+        baseURL?: string;
+    });
+}
+export default Runloop;
+export declare class Devboxes {
+    private readonly runtime;
+    readonly executions: Executions;
+    readonly diskSnapshots: DiskSnapshots;
+    private readonly transitions;
+    private transition;
+    constructor(runtime: Runtime);
+    create(input?: DevboxCreateParams, options?: RequestOptions): Promise<{
+        id: string;
+        name: string | null;
+        metadata: {
+            [k: string]: string;
+        };
+        status: string;
+        create_time_ms: number;
+        end_time_ms: number | null;
+        capabilities: never[];
+        state_transitions: never[];
+        launch_parameters: {
+            custom_cpu_cores: number;
+            custom_gb_memory: number;
+            custom_disk_size: number;
+            keep_alive_time_seconds: number;
+            resource_size_request: "CUSTOM_SIZE";
+        };
+    }>;
+    createAndAwaitRunning(input?: DevboxCreateParams, options?: RequestOptions): Promise<{
+        id: string;
+        name: string | null;
+        metadata: {
+            [k: string]: string;
+        };
+        status: string;
+        create_time_ms: number;
+        end_time_ms: number | null;
+        capabilities: never[];
+        state_transitions: never[];
+        launch_parameters: {
+            custom_cpu_cores: number;
+            custom_gb_memory: number;
+            custom_disk_size: number;
+            keep_alive_time_seconds: number;
+            resource_size_request: "CUSTOM_SIZE";
+        };
+    }>;
+    retrieve(id: string, options?: RequestOptions): Promise<{
+        id: string;
+        name: string | null;
+        metadata: {
+            [k: string]: string;
+        };
+        status: string;
+        create_time_ms: number;
+        end_time_ms: number | null;
+        capabilities: never[];
+        state_transitions: never[];
+        launch_parameters: {
+            custom_cpu_cores: number;
+            custom_gb_memory: number;
+            custom_disk_size: number;
+            keep_alive_time_seconds: number;
+            resource_size_request: "CUSTOM_SIZE";
+        };
+    }>;
+    awaitRunning(id: string, options?: LongPollRequestOptions): Promise<{
+        id: string;
+        name: string | null;
+        metadata: {
+            [k: string]: string;
+        };
+        status: string;
+        create_time_ms: number;
+        end_time_ms: number | null;
+        capabilities: never[];
+        state_transitions: never[];
+        launch_parameters: {
+            custom_cpu_cores: number;
+            custom_gb_memory: number;
+            custom_disk_size: number;
+            keep_alive_time_seconds: number;
+            resource_size_request: "CUSTOM_SIZE";
+        };
+    }>;
+    awaitDevboxRunning(id: string, options?: LongPollRequestOptions): Promise<{
+        id: string;
+        name: string | null;
+        metadata: {
+            [k: string]: string;
+        };
+        status: string;
+        create_time_ms: number;
+        end_time_ms: number | null;
+        capabilities: never[];
+        state_transitions: never[];
+        launch_parameters: {
+            custom_cpu_cores: number;
+            custom_gb_memory: number;
+            custom_disk_size: number;
+            keep_alive_time_seconds: number;
+            resource_size_request: "CUSTOM_SIZE";
+        };
+    }>;
+    awaitSuspended(id: string, options?: LongPollRequestOptions): Promise<{
+        id: string;
+        name: string | null;
+        metadata: {
+            [k: string]: string;
+        };
+        status: string;
+        create_time_ms: number;
+        end_time_ms: number | null;
+        capabilities: never[];
+        state_transitions: never[];
+        launch_parameters: {
+            custom_cpu_cores: number;
+            custom_gb_memory: number;
+            custom_disk_size: number;
+            keep_alive_time_seconds: number;
+            resource_size_request: "CUSTOM_SIZE";
+        };
+    }>;
+    private waitForStatus;
+    list(query?: DevboxListParams, options?: RequestOptions): PagePromise<DevboxView, DevboxViewsCursorIDPage<DevboxView>>;
+    list(options?: RequestOptions): PagePromise<DevboxView, DevboxViewsCursorIDPage<DevboxView>>;
+    private listPage;
+    suspend(id: string, options?: RequestOptions): Promise<{
+        id: string;
+        name: string | null;
+        metadata: {
+            [k: string]: string;
+        };
+        status: string;
+        create_time_ms: number;
+        end_time_ms: number | null;
+        capabilities: never[];
+        state_transitions: never[];
+        launch_parameters: {
+            custom_cpu_cores: number;
+            custom_gb_memory: number;
+            custom_disk_size: number;
+            keep_alive_time_seconds: number;
+            resource_size_request: "CUSTOM_SIZE";
+        };
+    }>;
+    resume(id: string, options?: RequestOptions): Promise<{
+        id: string;
+        name: string | null;
+        metadata: {
+            [k: string]: string;
+        };
+        status: string;
+        create_time_ms: number;
+        end_time_ms: number | null;
+        capabilities: never[];
+        state_transitions: never[];
+        launch_parameters: {
+            custom_cpu_cores: number;
+            custom_gb_memory: number;
+            custom_disk_size: number;
+            keep_alive_time_seconds: number;
+            resource_size_request: "CUSTOM_SIZE";
+        };
+    }>;
+    shutdown(id: string, params?: {
+        force?: string;
+    } | RequestOptions, options?: RequestOptions): Promise<DevboxView>;
+    executeSync(id: string, body: DevboxExecuteParams, options?: RequestOptions): Promise<DevboxExecutionDetailView>;
+    executeAsync(id: string, body: DevboxExecuteParams, options?: RequestOptions): Promise<DevboxAsyncExecutionDetailView>;
+    executeAndAwaitCompletion(id: string, body: DevboxExecuteParams, options?: RequestOptions): Promise<DevboxAsyncExecutionDetailView>;
+    readFileContents(id: string, body: {
+        file_path: string;
+    }, options?: RequestOptions): Promise<string>;
+    writeFileContents(id: string, body: {
+        file_path: string;
+        contents: string;
+    }, options?: RequestOptions): Promise<DevboxExecutionDetailView>;
+    snapshotDisk(id: string, body?: DevboxSnapshotDiskParams, options?: RequestOptions): Promise<DevboxSnapshotView>;
+    snapshotDisk(id: string, options?: RequestOptions): Promise<DevboxSnapshotView>;
+    snapshotDiskAsync(_id: string, _body?: DevboxSnapshotDiskParams | RequestOptions, _options?: RequestOptions): Promise<never>;
+    deleteDiskSnapshot(id: string, options?: RequestOptions): Promise<unknown>;
+    listDiskSnapshots(query?: DiskSnapshotListParams, options?: RequestOptions): ReturnType<DiskSnapshots["list"]>;
+    listDiskSnapshots(options?: RequestOptions): ReturnType<DiskSnapshots["list"]>;
+}
+export declare class Executions {
+    private readonly runtime;
+    constructor(runtime: Runtime);
+    executeSync(id: string, body: DevboxExecuteParams, options?: RequestOptions): Promise<DevboxExecutionDetailView>;
+    executeAsync(id: string, body: DevboxExecuteParams, options?: RequestOptions): Promise<DevboxAsyncExecutionDetailView>;
+    retrieve(id: string, execution: string, query?: {
+        last_n?: string;
+    } | RequestOptions, options?: RequestOptions): Promise<DevboxAsyncExecutionDetailView>;
+    awaitCompleted(id: string, execution: string, options?: RequestOptions): Promise<DevboxAsyncExecutionDetailView>;
+    kill(id: string, execution: string, body?: {
+        kill_process_group?: boolean | null;
+    } | RequestOptions, options?: RequestOptions): Promise<DevboxAsyncExecutionDetailView>;
+    sendStdIn(id: string, execution: string, body?: {
+        text?: string | null;
+        signal?: "EOF" | "INTERRUPT" | null;
+    } | RequestOptions, options?: RequestOptions): Promise<{
+        devbox_id: string;
+        execution_id: string;
+        success: boolean;
+    }>;
+    streamStdoutUpdates(id: string, execution: string, query?: {
+        offset?: string;
+    }, options?: RequestOptions): AsyncGenerator<{
+        output: string;
+        offset: number;
+    }, void, unknown>;
+    streamStderrUpdates(id: string, execution: string, query?: {
+        offset?: string;
+    }, options?: RequestOptions): AsyncGenerator<{
+        output: string;
+        offset: number;
+    }, void, unknown>;
+    private stream;
+}