@vercel/sandbox 1.9.0 → 1.9.1

package/dist/sandbox.d.ts

@@ -1,143 +1,154 @@
-import type { SandboxMetaData, SandboxRouteData } from "./api-client";
-import { type Writable } from "stream";
-import { APIClient } from "./api-client";
-import { Command, CommandFinished } from "./command";
-import { type Credentials } from "./utils/get-credentials";
-import { WithPrivate } from "./utils/types";
-import { WithFetchOptions } from "./api-client/api-client";
-import { RUNTIMES } from "./constants";
-import { Snapshot } from "./snapshot";
-import { type NetworkPolicy, type NetworkPolicyRule, type NetworkTransformer } from "./network-policy";
-import { type ConvertedSandbox } from "./utils/convert-sandbox";
-export type { NetworkPolicy, NetworkPolicyRule, NetworkTransformer };
+import { Parsed } from "./api-client/base-client.js";
+import { SandboxMetaData, SandboxRouteData } from "./api-client/validators.js";
+import { NetworkPolicy, NetworkPolicyRule, NetworkTransformer } from "./network-policy.js";
+import { WithPrivate } from "./utils/types.js";
+import { RUNTIMES } from "./constants.js";
+import { APIClient, WithFetchOptions } from "./api-client/api-client.js";
+import "./api-client/index.js";
+import { Command, CommandFinished } from "./command.js";
+import { Credentials } from "./utils/get-credentials.js";
+import { Snapshot } from "./snapshot.js";
+import { SandboxSnapshot } from "./utils/sandbox-snapshot.js";
+import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from "@workflow/serde";
+import * as zod0 from "zod";
+import { Writable } from "stream";
+
+//#region src/sandbox.d.ts
 /** @inline */
-export interface BaseCreateSandboxParams {
-    /**
-     * The source of the sandbox.
-     *
-     * Omit this parameter start a sandbox without a source.
-     *
-     * For git sources:
-     * - `depth`: Creates shallow clones with limited commit history (minimum: 1)
-     * - `revision`: Clones and checks out a specific commit, branch, or tag
-     */
-    source?: {
-        type: "git";
-        url: string;
-        depth?: number;
-        revision?: string;
-    } | {
-        type: "git";
-        url: string;
-        username: string;
-        password: string;
-        depth?: number;
-        revision?: string;
-    } | {
-        type: "tarball";
-        url: string;
-    };
-    /**
-     * Array of port numbers to expose from the sandbox. Sandboxes can
-     * expose up to 4 ports.
-     */
-    ports?: number[];
-    /**
-     * Timeout in milliseconds before the sandbox auto-terminates.
-     */
-    timeout?: number;
-    /**
-     * Resources to allocate to the sandbox.
-     *
-     * Your sandbox will get the amount of vCPUs you specify here and
-     * 2048 MB of memory per vCPU.
-     */
-    resources?: {
-        vcpus: number;
-    };
-    /**
-     * The runtime of the sandbox, currently only `node24`, `node22` and `python3.13` are supported.
-     * If not specified, the default runtime `node24` will be used.
-     */
-    runtime?: RUNTIMES | (string & {});
-    /**
-     * Network policy to define network restrictions for the sandbox.
-     * Defaults to full internet access if not specified.
-     */
-    networkPolicy?: NetworkPolicy;
-    /**
-     * Default environment variables for the sandbox.
-     * These are inherited by all commands unless overridden with
-     * the `env` option in `runCommand`.
-     *
-     * @example
-     * const sandbox = await Sandbox.create({
-     *   env: { NODE_ENV: "production", API_KEY: "secret" },
-     * });
-     * // All commands will have NODE_ENV and API_KEY set
-     * await sandbox.runCommand("node", ["app.js"]);
-     */
-    env?: Record<string, string>;
-    /**
-     * An AbortSignal to cancel sandbox creation.
-     */
-    signal?: AbortSignal;
+interface BaseCreateSandboxParams {
+  /**
+   * The source of the sandbox.
+   *
+   * Omit this parameter start a sandbox without a source.
+   *
+   * For git sources:
+   * - `depth`: Creates shallow clones with limited commit history (minimum: 1)
+   * - `revision`: Clones and checks out a specific commit, branch, or tag
+   */
+  source?: {
+    type: "git";
+    url: string;
+    depth?: number;
+    revision?: string;
+  } | {
+    type: "git";
+    url: string;
+    username: string;
+    password: string;
+    depth?: number;
+    revision?: string;
+  } | {
+    type: "tarball";
+    url: string;
+  };
+  /**
+   * Array of port numbers to expose from the sandbox. Sandboxes can
+   * expose up to 4 ports.
+   */
+  ports?: number[];
+  /**
+   * Timeout in milliseconds before the sandbox auto-terminates.
+   */
+  timeout?: number;
+  /**
+   * Resources to allocate to the sandbox.
+   *
+   * Your sandbox will get the amount of vCPUs you specify here and
+   * 2048 MB of memory per vCPU.
+   */
+  resources?: {
+    vcpus: number;
+  };
+  /**
+   * The runtime of the sandbox, currently only `node24`, `node22` and `python3.13` are supported.
+   * If not specified, the default runtime `node24` will be used.
+   */
+  runtime?: RUNTIMES | (string & {});
+  /**
+   * Network policy to define network restrictions for the sandbox.
+   * Defaults to full internet access if not specified.
+   */
+  networkPolicy?: NetworkPolicy;
+  /**
+   * Default environment variables for the sandbox.
+   * These are inherited by all commands unless overridden with
+   * the `env` option in `runCommand`.
+   *
+   * @example
+   * const sandbox = await Sandbox.create({
+   *   env: { NODE_ENV: "production", API_KEY: "secret" },
+   * });
+   * // All commands will have NODE_ENV and API_KEY set
+   * await sandbox.runCommand("node", ["app.js"]);
+   */
+  env?: Record<string, string>;
+  /**
+   * An AbortSignal to cancel sandbox creation.
+   */
+  signal?: AbortSignal;
 }
-export type CreateSandboxParams = BaseCreateSandboxParams | (Omit<BaseCreateSandboxParams, "runtime" | "source"> & {
-    source: {
-        type: "snapshot";
-        snapshotId: string;
-    };
+type CreateSandboxParams = BaseCreateSandboxParams | (Omit<BaseCreateSandboxParams, "runtime" | "source"> & {
+  source: {
+    type: "snapshot";
+    snapshotId: string;
+  };
 });
 /** @inline */
 interface GetSandboxParams {
-    /**
-     * Unique identifier of the sandbox.
-     */
-    sandboxId: string;
-    /**
-     * An AbortSignal to cancel the operation.
-     */
-    signal?: AbortSignal;
+  /**
+   * Unique identifier of the sandbox.
+   */
+  sandboxId: string;
+  /**
+   * An AbortSignal to cancel the operation.
+   */
+  signal?: AbortSignal;
+}
+/**
+ * Serialized representation of a Sandbox for @workflow/serde.
+ */
+interface SerializedSandbox {
+  metadata: SandboxSnapshot;
+  routes: SandboxRouteData[];
 }
 /** @inline */
 interface RunCommandParams {
-    /**
-     * The command to execute
-     */
-    cmd: string;
-    /**
-     * Arguments to pass to the command
-     */
-    args?: string[];
-    /**
-     * Working directory to execute the command in
-     */
-    cwd?: string;
-    /**
-     * Environment variables to set for this command
-     */
-    env?: Record<string, string>;
-    /**
-     * If true, execute this command with root privileges. Defaults to false.
-     */
-    sudo?: boolean;
-    /**
-     * If true, the command will return without waiting for `exitCode`
-     */
-    detached?: boolean;
-    /**
-     * A `Writable` stream where `stdout` from the command will be piped
-     */
-    stdout?: Writable;
-    /**
-     * A `Writable` stream where `stderr` from the command will be piped
-     */
-    stderr?: Writable;
-    /**
-     * An AbortSignal to cancel the command execution
-     */
-    signal?: AbortSignal;
+  /**
+   * The command to execute
+   */
+  cmd: string;
+  /**
+   * Arguments to pass to the command
+   */
+  args?: string[];
+  /**
+   * Working directory to execute the command in
+   */
+  cwd?: string;
+  /**
+   * Environment variables to set for this command
+   */
+  env?: Record<string, string>;
+  /**
+   * If true, execute this command with root privileges. Defaults to false.
+   */
+  sudo?: boolean;
+  /**
+   * If true, the command will return without waiting for `exitCode`
+   */
+  detached?: boolean;
+  /**
+   * A `Writable` stream where `stdout` from the command will be piped
+   */
+  stdout?: Writable;
+  /**
+   * A `Writable` stream where `stderr` from the command will be piped
+   */
+  stderr?: Writable;
+  /**
+   * An AbortSignal to cancel the command execution
+   */
+  signal?: AbortSignal;
 }
 /**
  * A Sandbox is an isolated Linux MicroVM to run commands in.
@@ -145,353 +156,384 @@ interface RunCommandParams {
  * Use {@link Sandbox.create} or {@link Sandbox.get} to construct.
  * @hideconstructor
  */
-export declare class Sandbox {
-    private readonly client;
-    /**
-     * Routes from ports to subdomains.
-    /* @hidden
-     */
-    readonly routes: SandboxRouteData[];
-    /**
-     * Unique ID of this sandbox.
-     */
-    get sandboxId(): string;
-    get interactivePort(): number | undefined;
-    /**
-     * The status of the sandbox.
-     */
-    get status(): SandboxMetaData["status"];
-    /**
-     * The creation date of the sandbox.
-     */
-    get createdAt(): Date;
-    /**
-     * The timeout of the sandbox in milliseconds.
-     */
-    get timeout(): number;
-    /**
-     * The network policy of the sandbox.
-     */
-    get networkPolicy(): NetworkPolicy | undefined;
-    /**
-     * If the sandbox was created from a snapshot, the ID of that snapshot.
-     */
-    get sourceSnapshotId(): string | undefined;
-    /**
-     * The amount of CPU used by the sandbox. Only reported once the VM is stopped.
-     */
-    get activeCpuUsageMs(): number | undefined;
-    /**
-     * The amount of network data used by the sandbox. Only reported once the VM is stopped.
-     */
-    get networkTransfer(): {
+declare class Sandbox {
+  private _client;
+  /**
+   * Lazily resolve credentials and construct an API client.
+   * This is used in step contexts where the Sandbox was deserialized
+   * without a client (e.g. when crossing workflow/step boundaries).
+   * Uses getCredentials() which resolves from OIDC or env vars.
+   * @internal
+   */
+  private ensureClient;
+  /**
+   * Routes from ports to subdomains.
+  /* @hidden
+   */
+  readonly routes: SandboxRouteData[];
+  /**
+   * Unique ID of this sandbox.
+   */
+  get sandboxId(): string;
+  get interactivePort(): number | undefined;
+  /**
+   * The status of the sandbox.
+   */
+  get status(): SandboxMetaData["status"];
+  /**
+   * The creation date of the sandbox.
+   */
+  get createdAt(): Date;
+  /**
+   * The timeout of the sandbox in milliseconds.
+   */
+  get timeout(): number;
+  /**
+   * The network policy of the sandbox.
+   */
+  get networkPolicy(): NetworkPolicy | undefined;
+  /**
+   * If the sandbox was created from a snapshot, the ID of that snapshot.
+   */
+  get sourceSnapshotId(): string | undefined;
+  /**
+   * The amount of CPU used by the sandbox. Only reported once the VM is stopped.
+   */
+  get activeCpuUsageMs(): number | undefined;
+  /**
+   * The amount of network data used by the sandbox. Only reported once the VM is stopped.
+   */
+  get networkTransfer(): {
+    ingress: number;
+    egress: number;
+  } | undefined;
+  /**
+   * Internal metadata about this sandbox.
+   */
+  private sandbox;
+  /**
+   * Allow to get a list of sandboxes for a team narrowed to the given params.
+   * It returns both the sandboxes and the pagination metadata to allow getting
+   * the next page of results.
+   */
+  static list(params?: Partial<Parameters<APIClient["listSandboxes"]>[0]> & Partial<Credentials> & WithFetchOptions): Promise<Parsed<{
+    sandboxes: {
+      status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
+      id: string;
+      memory: number;
+      vcpus: number;
+      region: string;
+      runtime: string;
+      timeout: number;
+      requestedAt: number;
+      createdAt: number;
+      cwd: string;
+      updatedAt: number;
+      startedAt?: number | undefined;
+      requestedStopAt?: number | undefined;
+      stoppedAt?: number | undefined;
+      abortedAt?: number | undefined;
+      duration?: number | undefined;
+      sourceSnapshotId?: string | undefined;
+      snapshottedAt?: number | undefined;
+      interactivePort?: number | undefined;
+      networkPolicy?: zod0.objectInputType<{
+        mode: zod0.ZodLiteral<"allow-all">;
+      }, zod0.ZodTypeAny, "passthrough"> | zod0.objectInputType<{
+        mode: zod0.ZodLiteral<"deny-all">;
+      }, zod0.ZodTypeAny, "passthrough"> | zod0.objectInputType<{
+        mode: zod0.ZodLiteral<"custom">;
+        allowedDomains: zod0.ZodOptional<zod0.ZodArray<zod0.ZodString, "many">>;
+        allowedCIDRs: zod0.ZodOptional<zod0.ZodArray<zod0.ZodString, "many">>;
+        deniedCIDRs: zod0.ZodOptional<zod0.ZodArray<zod0.ZodString, "many">>;
+        injectionRules: zod0.ZodOptional<zod0.ZodArray<zod0.ZodObject<{
+          domain: zod0.ZodString;
+          headers: zod0.ZodOptional<zod0.ZodRecord<zod0.ZodString, zod0.ZodString>>;
+          headerNames: zod0.ZodOptional<zod0.ZodArray<zod0.ZodString, "many">>;
+        }, "strip", zod0.ZodTypeAny, {
+          domain: string;
+          headers?: Record<string, string> | undefined;
+          headerNames?: string[] | undefined;
+        }, {
+          domain: string;
+          headers?: Record<string, string> | undefined;
+          headerNames?: string[] | undefined;
+        }>, "many">>;
+      }, zod0.ZodTypeAny, "passthrough"> | undefined;
+      activeCpuDurationMs?: number | undefined;
+      networkTransfer?: {
         ingress: number;
         egress: number;
-    } | undefined;
-    /**
-     * Internal metadata about this sandbox.
-     */
-    private sandbox;
-    /**
-     * Allow to get a list of sandboxes for a team narrowed to the given params.
-     * It returns both the sandboxes and the pagination metadata to allow getting
-     * the next page of results.
-     */
-    static list(params?: Partial<Parameters<APIClient["listSandboxes"]>[0]> & Partial<Credentials> & WithFetchOptions): Promise<import("./api-client/base-client").Parsed<{
-        sandboxes: {
-            id: string;
-            memory: number;
-            vcpus: number;
-            region: string;
-            runtime: string;
-            timeout: number;
-            status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
-            requestedAt: number;
-            createdAt: number;
-            cwd: string;
-            updatedAt: number;
-            startedAt?: number | undefined;
-            requestedStopAt?: number | undefined;
-            stoppedAt?: number | undefined;
-            abortedAt?: number | undefined;
-            duration?: number | undefined;
-            sourceSnapshotId?: string | undefined;
-            snapshottedAt?: number | undefined;
-            interactivePort?: number | undefined;
-            networkPolicy?: import("zod").objectInputType<{
-                mode: import("zod").ZodLiteral<"allow-all">;
-            }, import("zod").ZodTypeAny, "passthrough"> | import("zod").objectInputType<{
-                mode: import("zod").ZodLiteral<"deny-all">;
-            }, import("zod").ZodTypeAny, "passthrough"> | import("zod").objectInputType<{
-                mode: import("zod").ZodLiteral<"custom">;
-                allowedDomains: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-                allowedCIDRs: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-                deniedCIDRs: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-                injectionRules: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
-                    domain: import("zod").ZodString;
-                    headers: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodString>>;
-                    headerNames: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-                }, "strip", import("zod").ZodTypeAny, {
-                    domain: string;
-                    headers?: Record<string, string> | undefined;
-                    headerNames?: string[] | undefined;
-                }, {
-                    domain: string;
-                    headers?: Record<string, string> | undefined;
-                    headerNames?: string[] | undefined;
-                }>, "many">>;
-            }, import("zod").ZodTypeAny, "passthrough"> | undefined;
-            activeCpuDurationMs?: number | undefined;
-            networkTransfer?: {
-                ingress: number;
-                egress: number;
-            } | undefined;
-        }[];
-        pagination: {
-            count: number;
-            next: number | null;
-            prev: number | null;
-        };
-    }>>;
-    /**
-     * Create a new sandbox.
-     *
-     * @param params - Creation parameters and optional credentials.
-     * @returns A promise resolving to the created {@link Sandbox}.
-     * @example
-     * <caption>Create a sandbox and drop it in the end of the block</caption>
-     * async function fn() {
-     *   await using const sandbox = await Sandbox.create();
-     *   // Sandbox automatically stopped at the end of the lexical scope
-     * }
-     */
-    static create(params?: WithPrivate<CreateSandboxParams | (CreateSandboxParams & Credentials)> & WithFetchOptions): Promise<Sandbox & AsyncDisposable>;
-    /**
-     * Retrieve an existing sandbox.
-     *
-     * @param params - Get parameters and optional credentials.
-     * @returns A promise resolving to the {@link Sandbox}.
-     */
-    static get(params: WithPrivate<GetSandboxParams | (GetSandboxParams & Credentials)> & WithFetchOptions): Promise<Sandbox>;
-    constructor({ client, routes, sandbox, }: {
-        client: APIClient;
-        routes: SandboxRouteData[];
-        sandbox: SandboxMetaData;
-    });
-    /**
-     * Get a previously run command by its ID.
-     *
-     * @param cmdId - ID of the command to retrieve
-     * @param opts - Optional parameters.
-     * @param opts.signal - An AbortSignal to cancel the operation.
-     * @returns A {@link Command} instance representing the command
-     */
-    getCommand(cmdId: string, opts?: {
-        signal?: AbortSignal;
-    }): Promise<Command>;
-    /**
-     * Start executing a command in this sandbox.
-     *
-     * @param command - The command to execute.
-     * @param args - Arguments to pass to the command.
-     * @param opts - Optional parameters.
-     * @param opts.signal - An AbortSignal to cancel the command execution.
-     * @returns A {@link CommandFinished} result once execution is done.
-     */
-    runCommand(command: string, args?: string[], opts?: {
-        signal?: AbortSignal;
-    }): Promise<CommandFinished>;
-    /**
-     * Start executing a command in detached mode.
-     *
-     * @param params - The command parameters.
-     * @returns A {@link Command} instance for the running command.
-     */
-    runCommand(params: RunCommandParams & {
-        detached: true;
-    }): Promise<Command>;
-    /**
-     * Start executing a command in this sandbox.
-     *
-     * @param params - The command parameters.
-     * @returns A {@link CommandFinished} result once execution is done.
-     */
-    runCommand(params: RunCommandParams): Promise<CommandFinished>;
-    /**
-     * Internal helper to start a command in the sandbox.
-     *
-     * @param params - Command execution parameters.
-     * @returns A {@link Command} or {@link CommandFinished}, depending on `detached`.
-     * @internal
-     */
-    _runCommand(params: RunCommandParams): Promise<Command>;
-    /**
-     * Create a directory in the filesystem of this sandbox.
-     *
-     * @param path - Path of the directory to create
-     * @param opts - Optional parameters.
-     * @param opts.signal - An AbortSignal to cancel the operation.
-     */
-    mkDir(path: string, opts?: {
-        signal?: AbortSignal;
-    }): Promise<void>;
-    /**
-     * Read a file from the filesystem of this sandbox as a stream.
-     *
-     * @param file - File to read, with path and optional cwd
-     * @param opts - Optional parameters.
-     * @param opts.signal - An AbortSignal to cancel the operation.
-     * @returns A promise that resolves to a ReadableStream containing the file contents, or null if file not found
-     */
-    readFile(file: {
-        path: string;
-        cwd?: string;
-    }, opts?: {
-        signal?: AbortSignal;
-    }): Promise<NodeJS.ReadableStream | null>;
-    /**
-     * Read a file from the filesystem of this sandbox as a Buffer.
-     *
-     * @param file - File to read, with path and optional cwd
-     * @param opts - Optional parameters.
-     * @param opts.signal - An AbortSignal to cancel the operation.
-     * @returns A promise that resolves to the file contents as a Buffer, or null if file not found
-     */
-    readFileToBuffer(file: {
-        path: string;
-        cwd?: string;
-    }, opts?: {
-        signal?: AbortSignal;
-    }): Promise<Buffer | null>;
-    /**
-     * Download a file from the sandbox to the local filesystem.
-     *
-     * @param src - Source file on the sandbox, with path and optional cwd
-     * @param dst - Destination file on the local machine, with path and optional cwd
-     * @param opts - Optional parameters.
-     * @param opts.mkdirRecursive - If true, create parent directories for the destination if they don't exist.
-     * @param opts.signal - An AbortSignal to cancel the operation.
-     * @returns The absolute path to the written file, or null if the source file was not found
-     */
-    downloadFile(src: {
-        path: string;
-        cwd?: string;
-    }, dst: {
-        path: string;
-        cwd?: string;
-    }, opts?: {
-        mkdirRecursive?: boolean;
-        signal?: AbortSignal;
-    }): Promise<string | null>;
-    /**
-     * Write files to the filesystem of this sandbox.
-     * Defaults to writing to /vercel/sandbox unless an absolute path is specified.
-     * Writes files using the `vercel-sandbox` user.
-     *
-     * @param files - Array of files with path, content, and optional mode (permissions)
-     * @param opts - Optional parameters.
-     * @param opts.signal - An AbortSignal to cancel the operation.
-     * @returns A promise that resolves when the files are written
-     *
-     * @example
-     * // Write an executable script
-     * await sandbox.writeFiles([
-     *   { path: "/usr/local/bin/myscript", content: Buffer.from("#!/bin/bash\necho hello"), mode: 0o755 }
-     * ]);
-     */
-    writeFiles(files: {
-        path: string;
-        content: Buffer;
-        mode?: number;
-    }[], opts?: {
-        signal?: AbortSignal;
-    }): Promise<void>;
-    /**
-     * Get the public domain of a port of this sandbox.
-     *
-     * @param p - Port number to resolve
-     * @returns A full domain (e.g. `https://subdomain.vercel.run`)
-     * @throws If the port has no associated route
-     */
-    domain(p: number): string;
-    /**
-     * Stop the sandbox.
-     *
-     * @param opts - Optional parameters.
-     * @param opts.signal - An AbortSignal to cancel the operation.
-     * @param opts.blocking - If true, poll until the sandbox has fully stopped and return the final state.
-     * @returns The sandbox metadata at the time the stop was acknowledged, or after fully stopped if `blocking` is true.
-     */
-    stop(opts?: {
-        signal?: AbortSignal;
-        blocking?: boolean;
-    }): Promise<ConvertedSandbox>;
-    /**
-     * Update the network policy for this sandbox.
-     *
-     * @param networkPolicy - The new network policy to apply.
-     * @param opts - Optional parameters.
-     * @param opts.signal - An AbortSignal to cancel the operation.
-     * @returns A promise that resolves when the network policy is updated.
-     *
-     * @example
-     * // Restrict to specific domains
-     * await sandbox.updateNetworkPolicy({
-     *   allow: ["*.npmjs.org", "github.com"],
-     * });
-     *
-     * @example
-     * // Inject credentials with per-domain transformers
-     * await sandbox.updateNetworkPolicy({
-     *   allow: {
-     *     "ai-gateway.vercel.sh": [{
-     *       transform: [{
-     *         headers: { authorization: "Bearer ..." }
-     *       }]
-     *     }],
-     *     "*": []
-     *   }
-     * });
-     *
-     * @example
-     * // Deny all network access
-     * await sandbox.updateNetworkPolicy("deny-all");
-     */
-    updateNetworkPolicy(networkPolicy: NetworkPolicy, opts?: {
-        signal?: AbortSignal;
-    }): Promise<NetworkPolicy>;
-    /**
-     * Extend the timeout of the sandbox by the specified duration.
-     *
-     * This allows you to extend the lifetime of a sandbox up until the maximum
-     * execution timeout for your plan.
-     *
-     * @param duration - The duration in milliseconds to extend the timeout by
-     * @param opts - Optional parameters.
-     * @param opts.signal - An AbortSignal to cancel the operation.
-     * @returns A promise that resolves when the timeout is extended
-     *
-     * @example
-     * const sandbox = await Sandbox.create({ timeout: ms('10m') });
-     * // Extends timeout by 5 minutes, to a total of 15 minutes.
-     * await sandbox.extendTimeout(ms('5m'));
-     */
-    extendTimeout(duration: number, opts?: {
-        signal?: AbortSignal;
-    }): Promise<void>;
-    /**
-     * Create a snapshot from this currently running sandbox. New sandboxes can
-     * then be created from this snapshot using {@link Sandbox.createFromSnapshot}.
-     *
-     * Note: this sandbox will be stopped as part of the snapshot creation process.
-     *
-     * @param opts - Optional parameters.
-     * @param opts.expiration - Optional expiration time in milliseconds. Use 0 for no expiration at all.
-     * @param opts.signal - An AbortSignal to cancel the operation.
-     * @returns A promise that resolves to the Snapshot instance
-     */
-    snapshot(opts?: {
-        expiration?: number;
-        signal?: AbortSignal;
-    }): Promise<Snapshot>;
+      } | undefined;
+    }[];
+    pagination: {
+      count: number;
+      next: number | null;
+      prev: number | null;
+    };
+  }>>;
+  /**
+   * Serialize a Sandbox instance to plain data for @workflow/serde.
+   *
+   * @param instance - The Sandbox instance to serialize
+   * @returns A plain object containing sandbox metadata and routes
+   */
+  static [WORKFLOW_SERIALIZE](instance: Sandbox): SerializedSandbox;
+  /**
+   * Deserialize a Sandbox from serialized snapshot data.
+   *
+   * The deserialized instance uses the serialized metadata synchronously and
+   * lazily creates an API client only when methods perform API requests.
+   *
+   * @param data - The serialized sandbox data
+   * @returns The reconstructed Sandbox instance
+   */
+  static [WORKFLOW_DESERIALIZE](data: SerializedSandbox): Sandbox;
+  /**
+   * Create a new sandbox.
+   *
+   * @param params - Creation parameters and optional credentials.
+   * @returns A promise resolving to the created {@link Sandbox}.
+   * @example
+   * <caption>Create a sandbox and drop it in the end of the block</caption>
+   * async function fn() {
+   *   await using const sandbox = await Sandbox.create();
+   *   // Sandbox automatically stopped at the end of the lexical scope
+   * }
+   */
+  static create(params?: WithPrivate<CreateSandboxParams | (CreateSandboxParams & Credentials)> & WithFetchOptions): Promise<Sandbox & AsyncDisposable>;
+  /**
+   * Retrieve an existing sandbox.
+   *
+   * @param params - Get parameters and optional credentials.
+   * @returns A promise resolving to the {@link Sandbox}.
+   */
+  static get(params: WithPrivate<GetSandboxParams | (GetSandboxParams & Credentials)> & WithFetchOptions): Promise<Sandbox>;
+  /**
+   * Create a new Sandbox instance.
+   *
+   * @param params.client - Optional API client. If not provided, will be lazily created using global credentials.
+   * @param params.routes - Port-to-subdomain mappings for exposed ports
+   * @param params.sandbox - Sandbox snapshot metadata
+   */
+  constructor({
+    client,
+    routes,
+    sandbox
+  }: {
+    client?: APIClient;
+    routes: SandboxRouteData[];
+    sandbox: SandboxSnapshot;
+  });
+  /**
+   * Get a previously run command by its ID.
+   *
+   * @param cmdId - ID of the command to retrieve
+   * @param opts - Optional parameters.
+   * @param opts.signal - An AbortSignal to cancel the operation.
+   * @returns A {@link Command} instance representing the command
+   */
+  getCommand(cmdId: string, opts?: {
+    signal?: AbortSignal;
+  }): Promise<Command>;
+  /**
+   * Start executing a command in this sandbox.
+   *
+   * @param command - The command to execute.
+   * @param args - Arguments to pass to the command.
+   * @param opts - Optional parameters.
+   * @param opts.signal - An AbortSignal to cancel the command execution.
+   * @returns A {@link CommandFinished} result once execution is done.
+   */
+  runCommand(command: string, args?: string[], opts?: {
+    signal?: AbortSignal;
+  }): Promise<CommandFinished>;
+  /**
+   * Start executing a command in detached mode.
+   *
+   * @param params - The command parameters.
+   * @returns A {@link Command} instance for the running command.
+   */
+  runCommand(params: RunCommandParams & {
+    detached: true;
+  }): Promise<Command>;
+  /**
+   * Start executing a command in this sandbox.
+   *
+   * @param params - The command parameters.
+   * @returns A {@link CommandFinished} result once execution is done.
+   */
+  runCommand(params: RunCommandParams): Promise<CommandFinished>;
+  /**
+   * Create a directory in the filesystem of this sandbox.
+   *
+   * @param path - Path of the directory to create
+   * @param opts - Optional parameters.
+   * @param opts.signal - An AbortSignal to cancel the operation.
+   */
+  mkDir(path: string, opts?: {
+    signal?: AbortSignal;
+  }): Promise<void>;
+  /**
+   * Read a file from the filesystem of this sandbox as a stream.
+   *
+   * @param file - File to read, with path and optional cwd
+   * @param opts - Optional parameters.
+   * @param opts.signal - An AbortSignal to cancel the operation.
+   * @returns A promise that resolves to a ReadableStream containing the file contents, or null if file not found
+   */
+  readFile(file: {
+    path: string;
+    cwd?: string;
+  }, opts?: {
+    signal?: AbortSignal;
+  }): Promise<NodeJS.ReadableStream | null>;
+  /**
+   * Read a file from the filesystem of this sandbox as a Buffer.
+   *
+   * @param file - File to read, with path and optional cwd
+   * @param opts - Optional parameters.
+   * @param opts.signal - An AbortSignal to cancel the operation.
+   * @returns A promise that resolves to the file contents as a Buffer, or null if file not found
+   */
+  readFileToBuffer(file: {
+    path: string;
+    cwd?: string;
+  }, opts?: {
+    signal?: AbortSignal;
+  }): Promise<Buffer | null>;
+  /**
+   * Download a file from the sandbox to the local filesystem.
+   *
+   * @param src - Source file on the sandbox, with path and optional cwd
+   * @param dst - Destination file on the local machine, with path and optional cwd
+   * @param opts - Optional parameters.
+   * @param opts.mkdirRecursive - If true, create parent directories for the destination if they don't exist.
+   * @param opts.signal - An AbortSignal to cancel the operation.
+   * @returns The absolute path to the written file, or null if the source file was not found
+   */
+  downloadFile(src: {
+    path: string;
+    cwd?: string;
+  }, dst: {
+    path: string;
+    cwd?: string;
+  }, opts?: {
+    mkdirRecursive?: boolean;
+    signal?: AbortSignal;
+  }): Promise<string | null>;
+  /**
+   * Write files to the filesystem of this sandbox.
+   * Defaults to writing to /vercel/sandbox unless an absolute path is specified.
+   * Writes files using the `vercel-sandbox` user.
+   *
+   * @param files - Array of files with path, content, and optional mode (permissions)
+   * @param opts - Optional parameters.
+   * @param opts.signal - An AbortSignal to cancel the operation.
+   * @returns A promise that resolves when the files are written
+   *
+   * @example
+   * // Write an executable script
+   * await sandbox.writeFiles([
+   *   { path: "/usr/local/bin/myscript", content: "#!/bin/bash\necho hello", mode: 0o755 }
+   * ]);
+   */
+  writeFiles(files: {
+    path: string;
+    content: string | Uint8Array;
+    mode?: number;
+  }[], opts?: {
+    signal?: AbortSignal;
+  }): Promise<void>;
+  /**
+   * Get the public domain of a port of this sandbox.
+   *
+   * @param p - Port number to resolve
+   * @returns A full domain (e.g. `https://subdomain.vercel.run`)
+   * @throws If the port has no associated route
+   */
+  domain(p: number): string;
+  /**
+   * Stop the sandbox.
+   *
+   * @param opts - Optional parameters.
+   * @param opts.signal - An AbortSignal to cancel the operation.
+   * @param opts.blocking - If true, poll until the sandbox has fully stopped and return the final state.
+   * @returns The sandbox metadata at the time the stop was acknowledged, or after fully stopped if `blocking` is true.
+   */
+  stop(opts?: {
+    signal?: AbortSignal;
+    blocking?: boolean;
+  }): Promise<SandboxSnapshot>;
+  /**
+   * Update the network policy for this sandbox.
+   *
+   * @param networkPolicy - The new network policy to apply.
+   * @param opts - Optional parameters.
+   * @param opts.signal - An AbortSignal to cancel the operation.
+   * @returns A promise that resolves when the network policy is updated.
+   *
+   * @example
+   * // Restrict to specific domains
+   * await sandbox.updateNetworkPolicy({
+   *   allow: ["*.npmjs.org", "github.com"],
+   * });
+   *
+   * @example
+   * // Inject credentials with per-domain transformers
+   * await sandbox.updateNetworkPolicy({
+   *   allow: {
+   *     "ai-gateway.vercel.sh": [{
+   *       transform: [{
+   *         headers: { authorization: "Bearer ..." }
+   *       }]
+   *     }],
+   *     "*": []
+   *   }
+   * });
+   *
+   * @example
+   * // Deny all network access
+   * await sandbox.updateNetworkPolicy("deny-all");
+   */
+  updateNetworkPolicy(networkPolicy: NetworkPolicy, opts?: {
+    signal?: AbortSignal;
+  }): Promise<NetworkPolicy>;
+  /**
+   * Extend the timeout of the sandbox by the specified duration.
+   *
+   * This allows you to extend the lifetime of a sandbox up until the maximum
+   * execution timeout for your plan.
+   *
+   * @param duration - The duration in milliseconds to extend the timeout by
+   * @param opts - Optional parameters.
+   * @param opts.signal - An AbortSignal to cancel the operation.
+   * @returns A promise that resolves when the timeout is extended
+   *
+   * @example
+   * const sandbox = await Sandbox.create({ timeout: ms('10m') });
+   * // Extends timeout by 5 minutes, to a total of 15 minutes.
+   * await sandbox.extendTimeout(ms('5m'));
+   */
+  extendTimeout(duration: number, opts?: {
+    signal?: AbortSignal;
+  }): Promise<void>;
+  /**
+   * Create a snapshot from this currently running sandbox. New sandboxes can
+   * then be created from this snapshot using {@link Sandbox.createFromSnapshot}.
+   *
+   * Note: this sandbox will be stopped as part of the snapshot creation process.
+   *
+   * @param opts - Optional parameters.
+   * @param opts.expiration - Optional expiration time in milliseconds. Use 0 for no expiration at all.
+   * @param opts.signal - An AbortSignal to cancel the operation.
+   * @returns A promise that resolves to the Snapshot instance
+   */
+  snapshot(opts?: {
+    expiration?: number;
+    signal?: AbortSignal;
+  }): Promise<Snapshot>;
 }
+//#endregion
+export { Sandbox, SerializedSandbox };
+//# sourceMappingURL=sandbox.d.ts.map