@vercel/sandbox 0.0.15 → 0.0.16

package/.turbo/turbo-build.log

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

package/.turbo/turbo-typecheck.log

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

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @vercel/sandbox
 
+## 0.0.16
+
+### Patch Changes
+
+- Add sandbox.status property ([#95](https://github.com/vercel/sandbox-sdk/pull/95))
+
 ## 0.0.15
 
 ### Patch Changes

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

@@ -9,18 +9,18 @@ export declare class APIClient extends BaseClient {
         teamId: string;
         token: string;
     });
-    protected request(path: string, params?: RequestParams): Promise<import("node-fetch").Response>;
+    protected request(path: string, params?: RequestParams): Promise<Response>;
     getSandbox(params: {
         sandboxId: string;
     }): Promise<Parsed<{
         sandbox: {
             region: string;
-            timeout: number;
             status: "pending" | "running" | "stopping" | "stopped" | "failed";
             id: string;
             memory: number;
             vcpus: number;
             runtime: string;
+            timeout: number;
             requestedAt: number;
             createdAt: number;
             updatedAt: number;
@@ -30,9 +30,9 @@ export declare class APIClient extends BaseClient {
             stoppedAt?: number | undefined;
         };
         routes: {
-            port: number;
             url: string;
             subdomain: string;
+            port: number;
         }[];
     }>>;
     createSandbox(params: {
@@ -57,12 +57,12 @@ export declare class APIClient extends BaseClient {
     }): Promise<Parsed<{
         sandbox: {
             region: string;
-            timeout: number;
             status: "pending" | "running" | "stopping" | "stopped" | "failed";
             id: string;
             memory: number;
             vcpus: number;
             runtime: string;
+            timeout: number;
             requestedAt: number;
             createdAt: number;
             updatedAt: number;
@@ -72,9 +72,9 @@ export declare class APIClient extends BaseClient {
             stoppedAt?: number | undefined;
         };
         routes: {
-            port: number;
             url: string;
             subdomain: string;
+            port: number;
         }[];
     }>>;
     runCommand(params: {
@@ -87,10 +87,10 @@ export declare class APIClient extends BaseClient {
     }): Promise<Parsed<{
         command: {
             name: string;
-            cwd: string;
             args: string[];
             id: string;
             startedAt: number;
+            cwd: string;
             sandboxId: string;
             exitCode: number | null;
         };
@@ -113,7 +113,7 @@ export declare class APIClient extends BaseClient {
     getFileWriter(params: {
         sandboxId: string;
     }): {
-        response: Promise<import("node-fetch").Response>;
+        response: Promise<Response>;
         writer: FileWriter;
     };
     writeFiles(params: {
@@ -135,10 +135,10 @@ export declare class APIClient extends BaseClient {
     }): Promise<Parsed<{
         command: {
             name: string;
-            cwd: string;
             args: string[];
             id: string;
             startedAt: number;
+            cwd: string;
             sandboxId: string;
             exitCode: number | null;
         };

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

@@ -12,6 +12,7 @@ const version_1 = require("../version");
 const consume_readable_1 = require("../utils/consume-readable");
 const jsonlines_1 = __importDefault(require("jsonlines"));
 const os_1 = __importDefault(require("os"));
+const stream_1 = require("stream");
 class APIClient extends base_client_1.BaseClient {
     constructor(params) {
         super({
@@ -102,7 +103,10 @@ class APIClient extends base_client_1.BaseClient {
         if (response.status === 404) {
             return null;
         }
-        return response.body;
+        if (response.body === null) {
+            return null;
+        }
+        return stream_1.Readable.fromWeb(response.body);
     }
     async killCommand(params) {
         return (0, base_client_1.parseOrThrow)(validators_1.CommandResponse, await this.request(`/v1/sandboxes/${params.sandboxId}/${params.commandId}/kill`, {
@@ -118,7 +122,12 @@ class APIClient extends base_client_1.BaseClient {
                 message: "Expected a stream of logs",
             });
         }
-        for await (const chunk of response.body.pipe(jsonlines_1.default.parse())) {
+        if (response.body === null) {
+            throw new api_error_1.APIError(response, {
+                message: "No response body",
+            });
+        }
+        for await (const chunk of stream_1.Readable.fromWeb(response.body).pipe(jsonlines_1.default.parse())) {
             yield validators_1.LogLine.parse(chunk);
         }
     }

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

@@ -1,4 +1,3 @@
-import type { Response } from "node-fetch";
 interface Options<ErrorData> {
     message?: string;
     json?: ErrorData;

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

@@ -2,7 +2,6 @@ import type { Options as RetryOptions } from "async-retry";
 import { APIError } from "./api-error";
 import { ZodType } from "zod";
 import { type RequestOptions } from "./with-retry";
-import nodeFetch, { type Response, type RequestInit } from "node-fetch";
 export interface RequestParams extends RequestInit {
     headers?: Record<string, string>;
     method?: string;
@@ -25,7 +24,7 @@ export declare class BaseClient {
         host: string;
         token?: string;
     });
-    protected request(path: string, opts?: RequestParams): Promise<nodeFetch.Response>;
+    protected request(path: string, opts?: RequestParams): Promise<Response>;
 }
 export interface Parsed<Data> {
     response: Response;

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

@@ -1,7 +1,4 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseClient = void 0;
 exports.parse = parse;
@@ -9,7 +6,6 @@ exports.parseOrThrow = parseOrThrow;
 const api_error_1 = require("./api-error");
 const array_1 = require("../utils/array");
 const with_retry_1 = require("./with-retry");
-const node_fetch_1 = __importDefault(require("node-fetch"));
 /**
  * A base API client that provides a convenience wrapper for fetching where
  * we can pass query parameters as an object, support retries, debugging
@@ -17,7 +13,7 @@ const node_fetch_1 = __importDefault(require("node-fetch"));
  */
 class BaseClient {
     constructor(params) {
-        this.fetch = (0, with_retry_1.withRetry)(node_fetch_1.default);
+        this.fetch = (0, with_retry_1.withRetry)(globalThis.fetch);
         this.host = params.host;
         this.debug = params.debug ?? process.env.DEBUG_FETCH === "true";
         this.token = params.token;

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

@@ -1,5 +1,5 @@
 import { z } from "zod";
-export type SandboxData = z.infer<typeof Sandbox>;
+export type SandboxMetaData = z.infer<typeof Sandbox>;
 export declare const Sandbox: z.ZodObject<{
     id: z.ZodString;
     memory: z.ZodNumber;
@@ -17,12 +17,12 @@ export declare const Sandbox: z.ZodObject<{
     updatedAt: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
     region: string;
-    timeout: number;
     status: "pending" | "running" | "stopping" | "stopped" | "failed";
     id: string;
     memory: number;
     vcpus: number;
     runtime: string;
+    timeout: number;
     requestedAt: number;
     createdAt: number;
     updatedAt: number;
@@ -32,12 +32,12 @@ export declare const Sandbox: z.ZodObject<{
     stoppedAt?: number | undefined;
 }, {
     region: string;
-    timeout: number;
     status: "pending" | "running" | "stopping" | "stopped" | "failed";
     id: string;
     memory: number;
     vcpus: number;
     runtime: string;
+    timeout: number;
     requestedAt: number;
     createdAt: number;
     updatedAt: number;
@@ -52,13 +52,13 @@ export declare const SandboxRoute: z.ZodObject<{
     subdomain: z.ZodString;
     port: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    port: number;
     url: string;
     subdomain: string;
-}, {
     port: number;
+}, {
     url: string;
     subdomain: string;
+    port: number;
 }>;
 export type CommandData = z.infer<typeof Command>;
 export declare const Command: z.ZodObject<{
@@ -71,18 +71,18 @@ export declare const Command: z.ZodObject<{
     startedAt: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
     name: string;
-    cwd: string;
     args: string[];
     id: string;
     startedAt: number;
+    cwd: string;
     sandboxId: string;
     exitCode: number | null;
 }, {
     name: string;
-    cwd: string;
     args: string[];
     id: string;
     startedAt: number;
+    cwd: string;
     sandboxId: string;
     exitCode: number | null;
 }>;
@@ -104,12 +104,12 @@ export declare const SandboxResponse: z.ZodObject<{
         updatedAt: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
         region: string;
-        timeout: number;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
+        timeout: number;
         requestedAt: number;
         createdAt: number;
         updatedAt: number;
@@ -119,12 +119,12 @@ export declare const SandboxResponse: z.ZodObject<{
         stoppedAt?: number | undefined;
     }, {
         region: string;
-        timeout: number;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
+        timeout: number;
         requestedAt: number;
         createdAt: number;
         updatedAt: number;
@@ -136,12 +136,12 @@ export declare const SandboxResponse: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     sandbox: {
         region: string;
-        timeout: number;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
+        timeout: number;
         requestedAt: number;
         createdAt: number;
         updatedAt: number;
@@ -153,12 +153,12 @@ export declare const SandboxResponse: z.ZodObject<{
 }, {
     sandbox: {
         region: string;
-        timeout: number;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
+        timeout: number;
         requestedAt: number;
         createdAt: number;
         updatedAt: number;
@@ -186,12 +186,12 @@ export declare const SandboxAndRoutesResponse: z.ZodObject<{
         updatedAt: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
         region: string;
-        timeout: number;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
+        timeout: number;
         requestedAt: number;
         createdAt: number;
         updatedAt: number;
@@ -201,12 +201,12 @@ export declare const SandboxAndRoutesResponse: z.ZodObject<{
         stoppedAt?: number | undefined;
     }, {
         region: string;
-        timeout: number;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
+        timeout: number;
         requestedAt: number;
         createdAt: number;
         updatedAt: number;
@@ -221,23 +221,23 @@ export declare const SandboxAndRoutesResponse: z.ZodObject<{
         subdomain: z.ZodString;
         port: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
-        port: number;
         url: string;
         subdomain: string;
-    }, {
         port: number;
+    }, {
         url: string;
         subdomain: string;
+        port: number;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     sandbox: {
         region: string;
-        timeout: number;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
+        timeout: number;
         requestedAt: number;
         createdAt: number;
         updatedAt: number;
@@ -247,19 +247,19 @@ export declare const SandboxAndRoutesResponse: z.ZodObject<{
         stoppedAt?: number | undefined;
     };
     routes: {
-        port: number;
         url: string;
         subdomain: string;
+        port: number;
     }[];
 }, {
     sandbox: {
         region: string;
-        timeout: number;
         status: "pending" | "running" | "stopping" | "stopped" | "failed";
         id: string;
         memory: number;
         vcpus: number;
         runtime: string;
+        timeout: number;
         requestedAt: number;
         createdAt: number;
         updatedAt: number;
@@ -269,9 +269,9 @@ export declare const SandboxAndRoutesResponse: z.ZodObject<{
         stoppedAt?: number | undefined;
     };
     routes: {
-        port: number;
         url: string;
         subdomain: string;
+        port: number;
     }[];
 }>;
 export declare const CommandResponse: z.ZodObject<{
@@ -285,38 +285,38 @@ export declare const CommandResponse: z.ZodObject<{
         startedAt: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
         name: string;
-        cwd: string;
         args: string[];
         id: string;
         startedAt: number;
+        cwd: string;
         sandboxId: string;
         exitCode: number | null;
     }, {
         name: string;
-        cwd: string;
         args: string[];
         id: string;
         startedAt: number;
+        cwd: string;
         sandboxId: string;
         exitCode: number | null;
     }>;
 }, "strip", z.ZodTypeAny, {
     command: {
         name: string;
-        cwd: string;
         args: string[];
         id: string;
         startedAt: number;
+        cwd: string;
         sandboxId: string;
         exitCode: number | null;
     };
 }, {
     command: {
         name: string;
-        cwd: string;
         args: string[];
         id: string;
         startedAt: number;
+        cwd: string;
         sandboxId: string;
         exitCode: number | null;
     };
@@ -333,38 +333,38 @@ export declare const CommandFinishedResponse: z.ZodObject<{
         exitCode: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
         name: string;
-        cwd: string;
         args: string[];
         id: string;
         startedAt: number;
+        cwd: string;
         sandboxId: string;
         exitCode: number;
     }, {
         name: string;
-        cwd: string;
         args: string[];
         id: string;
         startedAt: number;
+        cwd: string;
         sandboxId: string;
         exitCode: number;
     }>;
 }, "strip", z.ZodTypeAny, {
     command: {
         name: string;
-        cwd: string;
         args: string[];
         id: string;
         startedAt: number;
+        cwd: string;
         sandboxId: string;
         exitCode: number;
     };
 }, {
     command: {
         name: string;
-        cwd: string;
         args: string[];
         id: string;
         startedAt: number;
+        cwd: string;
         sandboxId: string;
         exitCode: number;
     };
@@ -374,9 +374,9 @@ export declare const LogLine: z.ZodObject<{
     stream: z.ZodEnum<["stdout", "stderr"]>;
     data: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    data: string;
     stream: "stdout" | "stderr";
-}, {
     data: string;
+}, {
     stream: "stdout" | "stderr";
+    data: string;
 }>;

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

@@ -1,4 +1,3 @@
-import type { RequestInit, Response } from "node-fetch";
 import type { Options as RetryOptions } from "async-retry";
 export interface RequestOptions {
     onRetry?(error: any, options: RequestOptions): void;

package/dist/command.d.ts

@@ -61,8 +61,8 @@ export declare class Command {
      * to access output as a string.
      */
     logs(): AsyncIterable<{
-        data: string;
         stream: "stdout" | "stderr";
+        data: string;
     }>;
     /**
      * Wait for a command to exit and populate its exit code.

package/dist/sandbox.d.ts

@@ -1,4 +1,4 @@
-import type { SandboxData, SandboxRouteData } from "./api-client";
+import type { SandboxMetaData, SandboxRouteData } from "./api-client";
 import type { Writable } from "stream";
 import { APIClient } from "./api-client";
 import { Command, type CommandFinished } from "./command";
@@ -113,7 +113,11 @@ export declare class Sandbox {
      */
     get sandboxId(): string;
     /**
-     * Data about this sandbox.
+     * The status of the sandbox.
+     */
+    get status(): SandboxMetaData["status"];
+    /**
+     * Internal metadata about this sandbox.
      */
     private readonly sandbox;
     /**
@@ -140,7 +144,7 @@ export declare class Sandbox {
     constructor({ client, routes, sandbox, }: {
         client: APIClient;
         routes: SandboxRouteData[];
-        sandbox: SandboxData;
+        sandbox: SandboxMetaData;
     });
     /**
      * Get a previously run command by its ID.

package/dist/sandbox.js

@@ -17,6 +17,12 @@ class Sandbox {
     get sandboxId() {
         return this.sandbox.id;
     }
+    /**
+     * The status of the sandbox.
+     */
+    get status() {
+        return this.sandbox.status;
+    }
     /**
      * Create a new sandbox.
      *

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "0.0.15";
+export declare const VERSION = "0.0.16";

package/dist/version.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 // Autogenerated by inject-version.ts
-exports.VERSION = "0.0.15";
+exports.VERSION = "0.0.16";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/sandbox",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,10 +11,8 @@
   "dependencies": {
     "@vercel/oidc": "^2.0.0",
     "async-retry": "1.3.3",
-    "form-data": "3.0.0",
     "jsonlines": "0.1.1",
     "ms": "2.1.3",
-    "node-fetch": "2.6.11",
     "tar-stream": "3.1.7",
     "zod": "3.24.4"
   },
@@ -23,7 +21,6 @@
     "@types/jsonlines": "0.1.5",
     "@types/ms": "2.1.0",
     "@types/node": "22.15.12",
-    "@types/node-fetch": "2.6.12",
     "@types/tar-stream": "3.1.4",
     "dotenv": "16.5.0",
     "typedoc": "0.28.5",

package/src/api-client/api-client.ts

@@ -19,6 +19,7 @@ import { consumeReadable } from "../utils/consume-readable";
 import { z } from "zod";
 import jsonlines from "jsonlines";
 import os from "os";
+import { Readable } from "stream";
 
 export class APIClient extends BaseClient {
   private teamId: string;
@@ -196,7 +197,11 @@ export class APIClient extends BaseClient {
       return null;
     }
 
-    return response.body;
+    if (response.body === null) {
+      return null;
+    }
+
+    return Readable.fromWeb(response.body);
   }
 
   async killCommand(params: {
@@ -228,7 +233,15 @@ export class APIClient extends BaseClient {
       });
     }
 
-    for await (const chunk of response.body.pipe(jsonlines.parse())) {
+    if (response.body === null) {
+      throw new APIError(response, {
+        message: "No response body",
+      });
+    }
+
+    for await (const chunk of Readable.fromWeb(response.body).pipe(
+      jsonlines.parse(),
+    )) {
       yield LogLine.parse(chunk);
     }
   }

package/src/api-client/api-error.ts

@@ -1,5 +1,3 @@
-import type { Response } from "node-fetch";
-
 interface Options<ErrorData> {
   message?: string;
   json?: ErrorData;

package/src/api-client/base-client.ts

@@ -3,7 +3,6 @@ import { APIError } from "./api-error";
 import { ZodType } from "zod";
 import { array } from "../utils/array";
 import { withRetry, type RequestOptions } from "./with-retry";
-import nodeFetch, { type Response, type RequestInit } from "node-fetch";
 
 export interface RequestParams extends RequestInit {
   headers?: Record<string, string>;
@@ -25,7 +24,7 @@ export class BaseClient {
   private host: string;
 
   constructor(params: { debug?: boolean; host: string; token?: string }) {
-    this.fetch = withRetry(nodeFetch);
+    this.fetch = withRetry(globalThis.fetch);
     this.host = params.host;
     this.debug = params.debug ?? process.env.DEBUG_FETCH === "true";
     this.token = params.token;

package/src/api-client/validators.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
 
-export type SandboxData = z.infer<typeof Sandbox>;
+export type SandboxMetaData = z.infer<typeof Sandbox>;
 
 export const Sandbox = z.object({
   id: z.string(),

package/src/api-client/with-retry.ts

@@ -1,4 +1,3 @@
-import type { RequestInit, Response } from "node-fetch";
 import type { Options as RetryOptions } from "async-retry";
 import { APIError } from "./api-error";
 import { setTimeout } from "timers/promises";

package/src/sandbox.ts

@@ -1,4 +1,4 @@
-import type { SandboxData, SandboxRouteData } from "./api-client";
+import type { SandboxMetaData, SandboxRouteData } from "./api-client";
 import type { Writable } from "stream";
 import { APIClient } from "./api-client";
 import { Command, type CommandFinished } from "./command";
@@ -121,9 +121,16 @@ export class Sandbox {
   }
 
   /**
-   * Data about this sandbox.
+   * The status of the sandbox.
    */
-  private readonly sandbox: SandboxData;
+  public get status(): SandboxMetaData["status"] {
+    return this.sandbox.status;
+  }
+
+  /**
+   * Internal metadata about this sandbox.
+   */
+  private readonly sandbox: SandboxMetaData;
 
   /**
    * Create a new sandbox.
@@ -196,7 +203,7 @@ export class Sandbox {
   }: {
     client: APIClient;
     routes: SandboxRouteData[];
-    sandbox: SandboxData;
+    sandbox: SandboxMetaData;
   }) {
     this.client = client;
     this.routes = routes;

package/src/version.ts

@@ -1,2 +1,2 @@
 // Autogenerated by inject-version.ts
-export const VERSION = "0.0.15";
+export const VERSION = "0.0.16";