@vercel/sandbox 0.0.20 → 0.0.22

package/dist/api-client/validators.d.ts

@@ -19,14 +19,14 @@ export declare const Sandbox: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     region: string;
     status: "pending" | "running" | "stopping" | "stopped" | "failed";
+    timeout: number;
+    cwd: string;
     id: string;
     memory: number;
     vcpus: number;
     runtime: string;
-    timeout: number;
     requestedAt: number;
     createdAt: number;
-    cwd: string;
     updatedAt: number;
     duration?: number | undefined;
     startedAt?: number | undefined;
@@ -35,14 +35,14 @@ export declare const Sandbox: z.ZodObject<{
 }, {
     region: string;
     status: "pending" | "running" | "stopping" | "stopped" | "failed";
+    timeout: number;
+    cwd: string;
     id: string;
     memory: number;
     vcpus: number;
     runtime: string;
-    timeout: number;
     requestedAt: number;
     createdAt: number;
-    cwd: string;
     updatedAt: number;
     duration?: number | undefined;
     startedAt?: number | undefined;
@@ -56,12 +56,12 @@ export declare const SandboxRoute: z.ZodObject<{
     port: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
     url: string;
-    subdomain: string;
     port: number;
+    subdomain: string;
 }, {
     url: string;
-    subdomain: string;
     port: number;
+    subdomain: string;
 }>;
 export declare const Pagination: z.ZodObject<{
     /**
@@ -100,17 +100,17 @@ export declare const Command: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     name: string;
     args: string[];
+    cwd: string;
     id: string;
     startedAt: number;
-    cwd: string;
     sandboxId: string;
     exitCode: number | null;
 }, {
     name: string;
     args: string[];
+    cwd: string;
     id: string;
     startedAt: number;
-    cwd: string;
     sandboxId: string;
     exitCode: number | null;
 }>;
@@ -134,14 +134,14 @@ export declare const SandboxResponse: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         region: string;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        timeout: number;
+        cwd: string;
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
-        timeout: number;
         requestedAt: number;
         createdAt: number;
-        cwd: string;
         updatedAt: number;
         duration?: number | undefined;
         startedAt?: number | undefined;
@@ -150,14 +150,14 @@ export declare const SandboxResponse: z.ZodObject<{
     }, {
         region: string;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        timeout: number;
+        cwd: string;
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
-        timeout: number;
         requestedAt: number;
         createdAt: number;
-        cwd: string;
         updatedAt: number;
         duration?: number | undefined;
         startedAt?: number | undefined;
@@ -168,14 +168,14 @@ export declare const SandboxResponse: z.ZodObject<{
     sandbox: {
         region: string;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        timeout: number;
+        cwd: string;
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
-        timeout: number;
         requestedAt: number;
         createdAt: number;
-        cwd: string;
         updatedAt: number;
         duration?: number | undefined;
         startedAt?: number | undefined;
@@ -186,14 +186,14 @@ export declare const SandboxResponse: z.ZodObject<{
     sandbox: {
         region: string;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        timeout: number;
+        cwd: string;
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
-        timeout: number;
         requestedAt: number;
         createdAt: number;
-        cwd: string;
         updatedAt: number;
         duration?: number | undefined;
         startedAt?: number | undefined;
@@ -221,14 +221,14 @@ export declare const SandboxAndRoutesResponse: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         region: string;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        timeout: number;
+        cwd: string;
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
-        timeout: number;
         requestedAt: number;
         createdAt: number;
-        cwd: string;
         updatedAt: number;
         duration?: number | undefined;
         startedAt?: number | undefined;
@@ -237,14 +237,14 @@ export declare const SandboxAndRoutesResponse: z.ZodObject<{
     }, {
         region: string;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        timeout: number;
+        cwd: string;
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
-        timeout: number;
         requestedAt: number;
         createdAt: number;
-        cwd: string;
         updatedAt: number;
         duration?: number | undefined;
         startedAt?: number | undefined;
@@ -258,25 +258,25 @@ export declare const SandboxAndRoutesResponse: z.ZodObject<{
         port: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
         url: string;
-        subdomain: string;
         port: number;
+        subdomain: string;
     }, {
         url: string;
-        subdomain: string;
         port: number;
+        subdomain: string;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     sandbox: {
         region: string;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        timeout: number;
+        cwd: string;
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
-        timeout: number;
         requestedAt: number;
         createdAt: number;
-        cwd: string;
         updatedAt: number;
         duration?: number | undefined;
         startedAt?: number | undefined;
@@ -285,21 +285,21 @@ export declare const SandboxAndRoutesResponse: z.ZodObject<{
     };
     routes: {
         url: string;
-        subdomain: string;
         port: number;
+        subdomain: string;
     }[];
 }, {
     sandbox: {
         region: string;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        timeout: number;
+        cwd: string;
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
-        timeout: number;
         requestedAt: number;
         createdAt: number;
-        cwd: string;
         updatedAt: number;
         duration?: number | undefined;
         startedAt?: number | undefined;
@@ -308,8 +308,8 @@ export declare const SandboxAndRoutesResponse: z.ZodObject<{
     };
     routes: {
         url: string;
-        subdomain: string;
         port: number;
+        subdomain: string;
     }[];
 }>;
 export declare const CommandResponse: z.ZodObject<{
@@ -324,17 +324,17 @@ export declare const CommandResponse: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         name: string;
         args: string[];
+        cwd: string;
         id: string;
         startedAt: number;
-        cwd: string;
         sandboxId: string;
         exitCode: number | null;
     }, {
         name: string;
         args: string[];
+        cwd: string;
         id: string;
         startedAt: number;
-        cwd: string;
         sandboxId: string;
         exitCode: number | null;
     }>;
@@ -342,9 +342,9 @@ export declare const CommandResponse: z.ZodObject<{
     command: {
         name: string;
         args: string[];
+        cwd: string;
         id: string;
         startedAt: number;
-        cwd: string;
         sandboxId: string;
         exitCode: number | null;
     };
@@ -352,9 +352,9 @@ export declare const CommandResponse: z.ZodObject<{
     command: {
         name: string;
         args: string[];
+        cwd: string;
         id: string;
         startedAt: number;
-        cwd: string;
         sandboxId: string;
         exitCode: number | null;
     };
@@ -372,17 +372,17 @@ export declare const CommandFinishedResponse: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         name: string;
         args: string[];
+        cwd: string;
         id: string;
         startedAt: number;
-        cwd: string;
         sandboxId: string;
         exitCode: number;
     }, {
         name: string;
         args: string[];
+        cwd: string;
         id: string;
         startedAt: number;
-        cwd: string;
         sandboxId: string;
         exitCode: number;
     }>;
@@ -390,9 +390,9 @@ export declare const CommandFinishedResponse: z.ZodObject<{
     command: {
         name: string;
         args: string[];
+        cwd: string;
         id: string;
         startedAt: number;
-        cwd: string;
         sandboxId: string;
         exitCode: number;
     };
@@ -400,9 +400,9 @@ export declare const CommandFinishedResponse: z.ZodObject<{
     command: {
         name: string;
         args: string[];
+        cwd: string;
         id: string;
         startedAt: number;
-        cwd: string;
         sandboxId: string;
         exitCode: number;
     };
@@ -412,11 +412,11 @@ export declare const LogLine: z.ZodObject<{
     stream: z.ZodEnum<["stdout", "stderr"]>;
     data: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    stream: "stdout" | "stderr";
     data: string;
-}, {
     stream: "stdout" | "stderr";
+}, {
     data: string;
+    stream: "stdout" | "stderr";
 }>;
 export declare const SandboxesResponse: z.ZodObject<{
     sandboxes: z.ZodArray<z.ZodObject<{
@@ -438,14 +438,14 @@ export declare const SandboxesResponse: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         region: string;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        timeout: number;
+        cwd: string;
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
-        timeout: number;
         requestedAt: number;
         createdAt: number;
-        cwd: string;
         updatedAt: number;
         duration?: number | undefined;
         startedAt?: number | undefined;
@@ -454,14 +454,14 @@ export declare const SandboxesResponse: z.ZodObject<{
     }, {
         region: string;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        timeout: number;
+        cwd: string;
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
-        timeout: number;
         requestedAt: number;
         createdAt: number;
-        cwd: string;
         updatedAt: number;
         duration?: number | undefined;
         startedAt?: number | undefined;
@@ -497,14 +497,14 @@ export declare const SandboxesResponse: z.ZodObject<{
     sandboxes: {
         region: string;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        timeout: number;
+        cwd: string;
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
-        timeout: number;
         requestedAt: number;
         createdAt: number;
-        cwd: string;
         updatedAt: number;
         duration?: number | undefined;
         startedAt?: number | undefined;
@@ -520,14 +520,14 @@ export declare const SandboxesResponse: z.ZodObject<{
     sandboxes: {
         region: string;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        timeout: number;
+        cwd: string;
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
-        timeout: number;
         requestedAt: number;
         createdAt: number;
-        cwd: string;
         updatedAt: number;
         duration?: number | undefined;
         startedAt?: number | undefined;

package/dist/command.d.ts

@@ -68,8 +68,8 @@ export declare class Command {
     logs(opts?: {
         signal?: AbortSignal;
     }): AsyncGenerator<{
-        stream: "stdout" | "stderr";
         data: string;
+        stream: "stdout" | "stderr";
     }, void, void> & Disposable & {
         close(): void;
     };
@@ -88,9 +88,13 @@ export declare class Command {
      * }
      * ```
      *
+     * @param params - Optional parameters.
+     * @param params.signal - An AbortSignal to cancel waiting.
      * @returns A {@link CommandFinished} instance with populated exit code.
      */
-    wait(): Promise<CommandFinished>;
+    wait(params?: {
+        signal?: AbortSignal;
+    }): Promise<CommandFinished>;
     /**
      * Get the output of `stdout`, `stderr`, or both as a string.
      *
@@ -98,35 +102,50 @@ export declare class Command {
      * not output valid Unicode.
      *
      * @param stream - The output stream to read: "stdout", "stderr", or "both".
+     * @param opts - Optional parameters.
+     * @param opts.signal - An AbortSignal to cancel output streaming.
      * @returns The output of the specified stream(s) as a string.
      */
-    output(stream?: "stdout" | "stderr" | "both"): Promise<string>;
+    output(stream?: "stdout" | "stderr" | "both", opts?: {
+        signal?: AbortSignal;
+    }): Promise<string>;
     /**
      * Get the output of `stdout` as a string.
      *
      * NOTE: This may throw string conversion errors if the command does
      * not output valid Unicode.
      *
+     * @param opts - Optional parameters.
+     * @param opts.signal - An AbortSignal to cancel output streaming.
      * @returns The standard output of the command.
      */
-    stdout(): Promise<string>;
+    stdout(opts?: {
+        signal?: AbortSignal;
+    }): Promise<string>;
     /**
      * Get the output of `stderr` as a string.
      *
      * NOTE: This may throw string conversion errors if the command does
      * not output valid Unicode.
      *
+     * @param opts - Optional parameters.
+     * @param opts.signal - An AbortSignal to cancel output streaming.
      * @returns The standard error output of the command.
      */
-    stderr(): Promise<string>;
+    stderr(opts?: {
+        signal?: AbortSignal;
+    }): Promise<string>;
     /**
      * Kill a running command in a sandbox.
      *
-     * @param params - commandId and the signal to send the running process.
-     * Defaults to SIGTERM.
+     * @param signal - The signal to send the running process. Defaults to SIGTERM.
+     * @param opts - Optional parameters.
+     * @param opts.abortSignal - An AbortSignal to cancel the kill operation.
      * @returns Promise<void>.
      */
-    kill(signal?: Signal): Promise<void>;
+    kill(signal?: Signal, opts?: {
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
 }
 /**
  * A command that has finished executing.

package/dist/command.js

@@ -82,13 +82,17 @@ class Command {
      * }
      * ```
      *
+     * @param params - Optional parameters.
+     * @param params.signal - An AbortSignal to cancel waiting.
      * @returns A {@link CommandFinished} instance with populated exit code.
      */
-    async wait() {
+    async wait(params) {
+        params?.signal?.throwIfAborted();
         const command = await this.client.getCommand({
             sandboxId: this.sandboxId,
             cmdId: this.cmd.id,
             wait: true,
+            signal: params?.signal,
         });
         return new CommandFinished({
             client: this.client,
@@ -104,11 +108,13 @@ class Command {
      * not output valid Unicode.
      *
      * @param stream - The output stream to read: "stdout", "stderr", or "both".
+     * @param opts - Optional parameters.
+     * @param opts.signal - An AbortSignal to cancel output streaming.
      * @returns The output of the specified stream(s) as a string.
      */
-    async output(stream = "both") {
+    async output(stream = "both", opts) {
         let data = "";
-        for await (const log of this.logs()) {
+        for await (const log of this.logs({ signal: opts?.signal })) {
             if (stream === "both" || log.stream === stream) {
                 data += log.data;
             }
@@ -121,10 +127,12 @@ class Command {
      * NOTE: This may throw string conversion errors if the command does
      * not output valid Unicode.
      *
+     * @param opts - Optional parameters.
+     * @param opts.signal - An AbortSignal to cancel output streaming.
      * @returns The standard output of the command.
      */
-    async stdout() {
-        return this.output("stdout");
+    async stdout(opts) {
+        return this.output("stdout", opts);
     }
     /**
      * Get the output of `stderr` as a string.
@@ -132,23 +140,27 @@ class Command {
      * NOTE: This may throw string conversion errors if the command does
      * not output valid Unicode.
      *
+     * @param opts - Optional parameters.
+     * @param opts.signal - An AbortSignal to cancel output streaming.
      * @returns The standard error output of the command.
      */
-    async stderr() {
-        return this.output("stderr");
+    async stderr(opts) {
+        return this.output("stderr", opts);
     }
     /**
      * Kill a running command in a sandbox.
      *
-     * @param params - commandId and the signal to send the running process.
-     * Defaults to SIGTERM.
+     * @param signal - The signal to send the running process. Defaults to SIGTERM.
+     * @param opts - Optional parameters.
+     * @param opts.abortSignal - An AbortSignal to cancel the kill operation.
      * @returns Promise<void>.
      */
-    async kill(signal) {
+    async kill(signal, opts) {
         await this.client.killCommand({
             sandboxId: this.sandboxId,
             commandId: this.cmd.id,
             signal: (0, resolveSignal_1.resolveSignal)(signal ?? "SIGTERM"),
+            abortSignal: opts?.abortSignal,
         });
     }
 }

package/dist/sandbox.d.ts

@@ -54,6 +54,10 @@ export interface CreateSandboxParams {
      * If not specified, the default runtime `node22` will be used.
      */
     runtime?: "node22" | "python3.13" | (string & {});
+    /**
+     * An AbortSignal to cancel sandbox creation.
+     */
+    signal?: AbortSignal;
 }
 /** @inline */
 interface GetSandboxParams {
@@ -61,6 +65,10 @@ interface GetSandboxParams {
      * Unique identifier of the sandbox.
      */
     sandboxId: string;
+    /**
+     * An AbortSignal to cancel the operation.
+     */
+    signal?: AbortSignal;
 }
 /** @inline */
 interface RunCommandParams {
@@ -96,6 +104,10 @@ interface RunCommandParams {
      * 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.
@@ -131,14 +143,14 @@ export declare class Sandbox {
         sandboxes: {
             region: string;
             status: "pending" | "running" | "stopping" | "stopped" | "failed";
+            timeout: number;
+            cwd: string;
             id: string;
             memory: number;
             vcpus: number;
             runtime: string;
-            timeout: number;
             requestedAt: number;
             createdAt: number;
-            cwd: string;
             updatedAt: number;
             duration?: number | undefined;
             startedAt?: number | undefined;
@@ -181,17 +193,25 @@ export declare class Sandbox {
      * 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): Promise<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[]): Promise<CommandFinished>;
+    runCommand(command: string, args?: string[], opts?: {
+        signal?: AbortSignal;
+    }): Promise<CommandFinished>;
     /**
      * Start executing a command in detached mode.
      *
@@ -220,17 +240,25 @@ export declare class Sandbox {
      * 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): Promise<void>;
+    mkDir(path: string, opts?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
     /**
      * Read a file from the filesystem of this sandbox.
      *
      * @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
      */
     readFile(file: {
         path: string;
         cwd?: string;
+    }, opts?: {
+        signal?: AbortSignal;
     }): Promise<NodeJS.ReadableStream | null>;
     /**
      * Write files to the filesystem of this sandbox.
@@ -238,12 +266,16 @@ export declare class Sandbox {
      * Writes files using the `vercel-sandbox` user.
      *
      * @param files - Array of files with path and stream/buffer contents
+     * @param opts - Optional parameters.
+     * @param opts.signal - An AbortSignal to cancel the operation.
      * @returns A promise that resolves when the files are written
      */
     writeFiles(files: {
         path: string;
         content: Buffer;
-    }[]): Promise<void>;
+    }[], opts?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
     /**
      * Get the public domain of a port of this sandbox.
      *
@@ -255,8 +287,12 @@ export declare class Sandbox {
     /**
      * Stop the sandbox.
      *
+     * @param opts - Optional parameters.
+     * @param opts.signal - An AbortSignal to cancel the operation.
      * @returns A promise that resolves when the sandbox is stopped
      */
-    stop(): Promise<void>;
+    stop(opts?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
 }
 export {};