@vercel/sandbox 0.0.20 → 0.0.22

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
 
-> @vercel/sandbox@0.0.20 build /home/runner/work/sandbox-sdk/sandbox-sdk/packages/sandbox
+> @vercel/sandbox@0.0.22 build /home/runner/work/sandbox-sdk/sandbox-sdk/packages/sandbox
 > tsc
 

package/.turbo/turbo-typecheck.log

@@ -1,4 +1,4 @@
 
-> @vercel/sandbox@0.0.20 typecheck /home/runner/work/sandbox-sdk/sandbox-sdk/packages/sandbox
+> @vercel/sandbox@0.0.22 typecheck /home/runner/work/sandbox-sdk/sandbox-sdk/packages/sandbox
 > tsc --noEmit
 

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @vercel/sandbox
 
+## 0.0.22
+
+### Patch Changes
+
+- add AbortSignal support in public interface ([#137](https://github.com/vercel/sandbox-sdk/pull/137))
+
+- add AbortSignal support to command.wait ([#136](https://github.com/vercel/sandbox-sdk/pull/136))
+
+## 0.0.21
+
+### Patch Changes
+
+- Disable Undici body timeout ([#126](https://github.com/vercel/sandbox-sdk/pull/126))
+
 ## 0.0.20
 
 ### Patch Changes

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

@@ -15,18 +15,19 @@ export declare class APIClient extends BaseClient {
     protected request(path: string, params?: RequestParams): Promise<Response>;
     getSandbox(params: {
         sandboxId: string;
+        signal?: AbortSignal;
     }): Promise<Parsed<{
         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;
@@ -35,8 +36,8 @@ export declare class APIClient extends BaseClient {
         };
         routes: {
             url: string;
-            subdomain: string;
             port: number;
+            subdomain: string;
         }[];
     }>>;
     createSandbox(params: WithPrivate<{
@@ -58,18 +59,19 @@ export declare class APIClient extends BaseClient {
             vcpus: number;
         };
         runtime?: "node22" | "python3.13" | (string & {});
+        signal?: AbortSignal;
     }>): Promise<Parsed<{
         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;
@@ -78,8 +80,8 @@ export declare class APIClient extends BaseClient {
         };
         routes: {
             url: string;
-            subdomain: string;
             port: number;
+            subdomain: string;
         }[];
     }>>;
     runCommand(params: {
@@ -89,13 +91,14 @@ export declare class APIClient extends BaseClient {
         args: string[];
         env: Record<string, string>;
         sudo: boolean;
+        signal?: AbortSignal;
     }): Promise<Parsed<{
         command: {
             name: string;
             args: string[];
+            cwd: string;
             id: string;
             startedAt: number;
-            cwd: string;
             sandboxId: string;
             exitCode: number | null;
         };
@@ -104,20 +107,24 @@ export declare class APIClient extends BaseClient {
         sandboxId: string;
         cmdId: string;
         wait: true;
+        signal?: AbortSignal;
     }): Promise<Parsed<z.infer<typeof CommandFinishedResponse>>>;
     getCommand(params: {
         sandboxId: string;
         cmdId: string;
         wait?: boolean;
+        signal?: AbortSignal;
     }): Promise<Parsed<z.infer<typeof CommandResponse>>>;
     mkDir(params: {
         sandboxId: string;
         path: string;
         cwd?: string;
+        signal?: AbortSignal;
     }): Promise<Parsed<{}>>;
     getFileWriter(params: {
         sandboxId: string;
         extractDir: string;
+        signal?: AbortSignal;
     }): {
         response: Promise<Response>;
         writer: FileWriter;
@@ -143,18 +150,19 @@ export declare class APIClient extends BaseClient {
          * @example 1540095775951
          */
         until?: number | Date;
+        signal?: AbortSignal;
     }): Promise<Parsed<{
         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;
@@ -175,23 +183,26 @@ export declare class APIClient extends BaseClient {
             content: Buffer;
         }[];
         extractDir: string;
+        signal?: AbortSignal;
     }): Promise<void>;
     readFile(params: {
         sandboxId: string;
         path: string;
         cwd?: string;
+        signal?: AbortSignal;
     }): Promise<NodeJS.ReadableStream | null>;
     killCommand(params: {
         sandboxId: string;
         commandId: string;
         signal: number;
+        abortSignal?: AbortSignal;
     }): Promise<Parsed<{
         command: {
             name: string;
             args: string[];
+            cwd: string;
             id: string;
             startedAt: number;
-            cwd: string;
             sandboxId: string;
             exitCode: number | null;
         };
@@ -205,5 +216,6 @@ export declare class APIClient extends BaseClient {
     };
     stopSandbox(params: {
         sandboxId: string;
+        signal?: AbortSignal;
     }): Promise<Parsed<z.infer<typeof SandboxResponse>>>;
 }

package/dist/api-client/api-client.js

@@ -53,7 +53,9 @@ class APIClient extends base_client_1.BaseClient {
         });
     }
     async getSandbox(params) {
-        return (0, base_client_1.parseOrThrow)(validators_1.SandboxAndRoutesResponse, await this.request(`/v1/sandboxes/${params.sandboxId}`));
+        return (0, base_client_1.parseOrThrow)(validators_1.SandboxAndRoutesResponse, await this.request(`/v1/sandboxes/${params.sandboxId}`, {
+            signal: params.signal,
+        }));
     }
     async createSandbox(params) {
         const privateParams = (0, types_1.getPrivateParams)(params);
@@ -68,6 +70,7 @@ class APIClient extends base_client_1.BaseClient {
                 runtime: params.runtime,
                 ...privateParams,
             }),
+            signal: params.signal,
         }));
     }
     async runCommand(params) {
@@ -80,17 +83,19 @@ class APIClient extends base_client_1.BaseClient {
                 env: params.env,
                 sudo: params.sudo,
             }),
+            signal: params.signal,
         }));
     }
     async getCommand(params) {
         return params.wait
-            ? (0, base_client_1.parseOrThrow)(validators_1.CommandFinishedResponse, await this.request(`/v1/sandboxes/${params.sandboxId}/cmd/${params.cmdId}`, { query: { wait: "true" } }))
-            : (0, base_client_1.parseOrThrow)(validators_1.CommandResponse, await this.request(`/v1/sandboxes/${params.sandboxId}/cmd/${params.cmdId}`));
+            ? (0, base_client_1.parseOrThrow)(validators_1.CommandFinishedResponse, await this.request(`/v1/sandboxes/${params.sandboxId}/cmd/${params.cmdId}`, { signal: params.signal, query: { wait: "true" } }))
+            : (0, base_client_1.parseOrThrow)(validators_1.CommandResponse, await this.request(`/v1/sandboxes/${params.sandboxId}/cmd/${params.cmdId}`, { signal: params.signal }));
     }
     async mkDir(params) {
         return (0, base_client_1.parseOrThrow)(validators_1.EmptyResponse, await this.request(`/v1/sandboxes/${params.sandboxId}/fs/mkdir`, {
             method: "POST",
             body: JSON.stringify({ path: params.path, cwd: params.cwd }),
+            signal: params.signal,
         }));
     }
     getFileWriter(params) {
@@ -104,6 +109,7 @@ class APIClient extends base_client_1.BaseClient {
                         "x-cwd": params.extractDir,
                     },
                     body: await (0, consume_readable_1.consumeReadable)(writer.readable),
+                    signal: params.signal,
                 });
             })(),
             writer,
@@ -122,12 +128,14 @@ class APIClient extends base_client_1.BaseClient {
                     : params.until?.getTime(),
             },
             method: "GET",
+            signal: params.signal,
         }));
     }
     async writeFiles(params) {
         const { writer, response } = this.getFileWriter({
             sandboxId: params.sandboxId,
             extractDir: params.extractDir,
+            signal: params.signal,
         });
         for (const file of params.files) {
             await writer.addFile({
@@ -146,6 +154,7 @@ class APIClient extends base_client_1.BaseClient {
         const response = await this.request(`/v1/sandboxes/${params.sandboxId}/fs/read`, {
             method: "POST",
             body: JSON.stringify({ path: params.path, cwd: params.cwd }),
+            signal: params.signal,
         });
         if (response.status === 404) {
             return null;
@@ -159,6 +168,7 @@ class APIClient extends base_client_1.BaseClient {
         return (0, base_client_1.parseOrThrow)(validators_1.CommandResponse, await this.request(`/v1/sandboxes/${params.sandboxId}/${params.commandId}/kill`, {
             method: "POST",
             body: JSON.stringify({ signal: params.signal }),
+            signal: params.abortSignal,
         }));
     }
     getLogs(params) {
@@ -200,7 +210,7 @@ class APIClient extends base_client_1.BaseClient {
     }
     async stopSandbox(params) {
         const url = `/v1/sandboxes/${params.sandboxId}/stop`;
-        return (0, base_client_1.parseOrThrow)(validators_1.SandboxResponse, await this.request(url, { method: "POST" }));
+        return (0, base_client_1.parseOrThrow)(validators_1.SandboxResponse, await this.request(url, { method: "POST", signal: params.signal }));
     }
 }
 exports.APIClient = APIClient;

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

@@ -19,6 +19,7 @@ export declare class BaseClient {
     private fetch;
     private debug;
     private host;
+    private agent;
     constructor(params: {
         debug?: boolean;
         host: string;

package/dist/api-client/base-client.js

@@ -6,6 +6,7 @@ exports.parseOrThrow = parseOrThrow;
 const api_error_1 = require("./api-error");
 const array_1 = require("../utils/array");
 const with_retry_1 = require("./with-retry");
+const undici_1 = require("undici");
 /**
  * A base API client that provides a convenience wrapper for fetching where
  * we can pass query parameters as an object, support retries, debugging
@@ -17,6 +18,9 @@ class BaseClient {
         this.host = params.host;
         this.debug = params.debug ?? process.env.DEBUG_FETCH === "true";
         this.token = params.token;
+        this.agent = new undici_1.Agent({
+            bodyTimeout: 0, // disable body timeout to allow long logs streaming
+        });
     }
     async request(path, opts) {
         const url = new URL(path, this.host);
@@ -35,6 +39,9 @@ class BaseClient {
             headers: this.token
                 ? { Authorization: `Bearer ${this.token}`, ...opts?.headers }
                 : opts?.headers,
+            // @ts-expect-error Node.js' and undici's Agent have different types
+            dispatcher: this.agent,
+            signal: opts?.signal,
         });
         if (this.debug) {
             const duration = Date.now() - start;