@vercel/sandbox 0.0.7 → 0.0.9

package/.turbo/turbo-build.log

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

package/.turbo/turbo-typecheck.log

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

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @vercel/sandbox
 
+## 0.0.9
+
+### Patch Changes
+
+- Add `cmd.kill()` to stop/signal commands ([#48](https://github.com/vercel/sandbox-sdk/pull/48))
+- Update SDK to use the new API ([#51](https://github.com/vercel/sandbox-sdk/pull/51))
+
+## 0.0.8
+
+### Patch Changes
+
+- Write files using a single compressed stream ([#44](https://github.com/vercel/sandbox-sdk/pull/44))
+- Expose `runtime` parameter ([#46](https://github.com/vercel/sandbox-sdk/pull/46))
+- Add git depth and revision options to sandbox source ([#47](https://github.com/vercel/sandbox-sdk/pull/47))
+
 ## 0.0.7
 
 ### Patch Changes

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

@@ -1,6 +1,6 @@
 import { BaseClient, type Parsed, type RequestParams } from "./base-client";
-import { Command, CommandFinished, LogLine, StoppedSandbox } from "./validators";
-import { Readable } from "stream";
+import { SandboxResponse, CommandResponse, CommandFinishedResponse, LogLine } from "./validators";
+import { FileWriter } from "./file-writer";
 import { z } from "zod";
 export declare class APIClient extends BaseClient {
     private teamId;
@@ -10,12 +10,39 @@ export declare class APIClient extends BaseClient {
         token: string;
     });
     protected request(path: string, params?: RequestParams): Promise<import("node-fetch").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;
+            requestedAt: number;
+            createdAt: number;
+            updatedAt: number;
+            duration?: number | undefined;
+            startedAt?: number | undefined;
+            requestedStopAt?: number | undefined;
+            stoppedAt?: number | undefined;
+        };
+        routes: {
+            port: number;
+            url: string;
+            subdomain: string;
+        }[];
+    }>>;
     createSandbox(params: {
         ports?: number[];
         projectId: string;
         source?: {
             type: "git";
             url: string;
+            depth?: number;
+            revision?: string;
         } | {
             type: "tarball";
             url: string;
@@ -24,10 +51,27 @@ export declare class APIClient extends BaseClient {
         resources?: {
             vcpus: number;
         };
+        runtime?: "node22" | "python3.13";
     }): Promise<Parsed<{
-        sandboxId: string;
+        sandbox: {
+            region: string;
+            timeout: number;
+            status: "pending" | "running" | "stopping" | "stopped" | "failed";
+            id: string;
+            memory: number;
+            vcpus: number;
+            runtime: string;
+            requestedAt: number;
+            createdAt: number;
+            updatedAt: number;
+            duration?: number | undefined;
+            startedAt?: number | undefined;
+            requestedStopAt?: number | undefined;
+            stoppedAt?: number | undefined;
+        };
         routes: {
             port: number;
+            url: string;
             subdomain: string;
         }[];
     }>>;
@@ -38,28 +82,42 @@ export declare class APIClient extends BaseClient {
         args: string[];
         env: Record<string, string>;
     }): Promise<Parsed<{
-        cmdId: string;
+        command: {
+            name: string;
+            cwd: string;
+            args: string[];
+            id: string;
+            startedAt: number;
+            sandboxId: string;
+            exitCode: number | null;
+        };
     }>>;
     getCommand(params: {
         sandboxId: string;
         cmdId: string;
         wait: true;
-    }): Promise<Parsed<z.infer<typeof CommandFinished>>>;
+    }): Promise<Parsed<z.infer<typeof CommandFinishedResponse>>>;
     getCommand(params: {
         sandboxId: string;
         cmdId: string;
         wait?: boolean;
-    }): Promise<Parsed<z.infer<typeof Command>>>;
+    }): Promise<Parsed<z.infer<typeof CommandResponse>>>;
     mkDir(params: {
         sandboxId: string;
         path: string;
         cwd?: string;
     }): Promise<Parsed<{}>>;
+    getFileWriter(params: {
+        sandboxId: string;
+    }): {
+        response: Promise<import("node-fetch").Response>;
+        writer: FileWriter;
+    };
     writeFiles(params: {
         sandboxId: string;
         files: {
             path: string;
-            stream: Readable | Buffer;
+            stream: Buffer;
         }[];
     }): Promise<void>;
     readFile(params: {
@@ -67,11 +125,26 @@ export declare class APIClient extends BaseClient {
         path: string;
         cwd?: string;
     }): Promise<NodeJS.ReadableStream | null>;
+    killCommand(params: {
+        sandboxId: string;
+        commandId: string;
+        signal: number;
+    }): Promise<Parsed<{
+        command: {
+            name: string;
+            cwd: string;
+            args: string[];
+            id: string;
+            startedAt: number;
+            sandboxId: string;
+            exitCode: number | null;
+        };
+    }>>;
     getLogs(params: {
         sandboxId: string;
         cmdId: string;
     }): AsyncIterable<z.infer<typeof LogLine>>;
     stopSandbox(params: {
         sandboxId: string;
-    }): Promise<Parsed<z.infer<typeof StoppedSandbox>>>;
+    }): Promise<Parsed<z.infer<typeof SandboxResponse>>>;
 }

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

@@ -4,10 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.APIClient = void 0;
-const form_data_1 = __importDefault(require("form-data"));
 const base_client_1 = require("./base-client");
 const validators_1 = require("./validators");
 const api_error_1 = require("./api-error");
+const file_writer_1 = require("./file-writer");
 const lru_cache_1 = require("lru-cache");
 const version_1 = require("../version");
 const jsonlines_1 = __importDefault(require("jsonlines"));
@@ -41,8 +41,11 @@ 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}`));
+    }
     async createSandbox(params) {
-        return (0, base_client_1.parseOrThrow)(validators_1.CreatedSandbox, await this.request("/v1/sandboxes", {
+        return (0, base_client_1.parseOrThrow)(validators_1.SandboxAndRoutesResponse, await this.request("/v1/sandboxes", {
             method: "POST",
             body: JSON.stringify({
                 projectId: params.projectId,
@@ -50,11 +53,12 @@ class APIClient extends base_client_1.BaseClient {
                 source: params.source,
                 timeout: params.timeout,
                 resources: params.resources,
+                runtime: params.runtime,
             }),
         }));
     }
     async runCommand(params) {
-        return (0, base_client_1.parseOrThrow)(validators_1.CreatedCommand, await this.request(`/v1/sandboxes/${params.sandboxId}/cmd`, {
+        return (0, base_client_1.parseOrThrow)(validators_1.CommandResponse, await this.request(`/v1/sandboxes/${params.sandboxId}/cmd`, {
             method: "POST",
             body: JSON.stringify({
                 command: params.command,
@@ -66,25 +70,35 @@ class APIClient extends base_client_1.BaseClient {
     }
     async getCommand(params) {
         return params.wait
-            ? (0, base_client_1.parseOrThrow)(validators_1.CommandFinished, await this.request(`/v1/sandboxes/${params.sandboxId}/cmd/${params.cmdId}`, { query: { wait: "true" } }))
-            : (0, base_client_1.parseOrThrow)(validators_1.Command, 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}`, { query: { wait: "true" } }))
+            : (0, base_client_1.parseOrThrow)(validators_1.CommandResponse, await this.request(`/v1/sandboxes/${params.sandboxId}/cmd/${params.cmdId}`));
     }
     async mkDir(params) {
-        return (0, base_client_1.parseOrThrow)(validators_1.WrittenFile, await this.request(`/v1/sandboxes/${params.sandboxId}/fs/mkdir`, {
+        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 }),
         }));
     }
+    getFileWriter(params) {
+        const writer = new file_writer_1.FileWriter();
+        return {
+            response: this.request(`/v1/sandboxes/${params.sandboxId}/fs/write`, {
+                method: "POST",
+                headers: { "content-type": "application/gzip" },
+                body: writer.readable,
+            }),
+            writer,
+        };
+    }
     async writeFiles(params) {
-        const formData = new form_data_1.default();
+        const { writer, response } = this.getFileWriter({
+            sandboxId: params.sandboxId,
+        });
         for (const file of params.files) {
-            formData.append(file.path, file.stream, file.path);
+            await writer.addFile({ name: file.path, content: file.stream });
         }
-        await (0, base_client_1.parseOrThrow)(validators_1.WrittenFile, await this.request(`/v1/sandboxes/${params.sandboxId}/fs/write`, {
-            method: "POST",
-            headers: { ...formData.getHeaders() },
-            body: formData,
-        }));
+        await writer.end();
+        await (0, base_client_1.parseOrThrow)(validators_1.EmptyResponse, await response);
     }
     async readFile(params) {
         const response = await this.request(`/v1/sandboxes/${params.sandboxId}/fs/read`, {
@@ -96,6 +110,12 @@ class APIClient extends base_client_1.BaseClient {
         }
         return response.body;
     }
+    async killCommand(params) {
+        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 }),
+        }));
+    }
     async *getLogs(params) {
         const url = `/v1/sandboxes/${params.sandboxId}/cmd/${params.cmdId}/logs`;
         const response = await this.request(url, { method: "GET" });
@@ -122,7 +142,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.StoppedSandbox, await this.request(url, { method: "POST" }));
+        return (0, base_client_1.parseOrThrow)(validators_1.SandboxResponse, await this.request(url, { method: "POST" }));
     }
 }
 exports.APIClient = APIClient;

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

@@ -0,0 +1,52 @@
+import { Readable } from "stream";
+interface FileBuffer {
+    /**
+     * The name (path) of the file to write.
+     */
+    name: string;
+    /**
+     * The content of the file as a Buffer.
+     */
+    content: Buffer;
+}
+interface FileStream {
+    /**
+     * The name (path) of the file to write.
+     */
+    name: string;
+    /**
+     * A Readable stream to consume the content of the file.
+     */
+    content: Readable;
+    /**
+     * The expected size of the file. This is required to write
+     * the header of the compressed file.
+     */
+    size: number;
+}
+/**
+ * Allows to create a Readable stream with methods to write files
+ * to it and to finish it. Files written are compressed together
+ * and gzipped in the stream.
+ */
+export declare class FileWriter {
+    readable: Readable;
+    private pack;
+    constructor();
+    /**
+     * Allows to add a file to the stream. Size is required to write
+     * the tarball header so when content is a stream it must be
+     * provided.
+     *
+     * Returns a Promise resolved once the file is written in the
+     * stream.
+     */
+    addFile(file: FileBuffer | FileStream): Promise<void>;
+    /**
+     * Allows to finish the stream returning a Promise that will
+     * resolve once the readable is effectively closed or
+     * errored.
+     */
+    end(): Promise<void>;
+}
+export {};

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

@@ -0,0 +1,62 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileWriter = void 0;
+const zlib_1 = __importDefault(require("zlib"));
+const tar_stream_1 = __importDefault(require("tar-stream"));
+const stream_1 = require("stream");
+/**
+ * Allows to create a Readable stream with methods to write files
+ * to it and to finish it. Files written are compressed together
+ * and gzipped in the stream.
+ */
+class FileWriter {
+    constructor() {
+        const gzip = zlib_1.default.createGzip();
+        this.pack = tar_stream_1.default.pack();
+        this.readable = this.pack.pipe(gzip);
+    }
+    /**
+     * Allows to add a file to the stream. Size is required to write
+     * the tarball header so when content is a stream it must be
+     * provided.
+     *
+     * Returns a Promise resolved once the file is written in the
+     * stream.
+     */
+    async addFile(file) {
+        return new Promise((resolve, reject) => {
+            const entry = this.pack.entry("size" in file
+                ? { name: file.name, size: file.size }
+                : { name: file.name, size: file.content.length }, (error) => {
+                if (error) {
+                    return reject(error);
+                }
+                else {
+                    resolve();
+                }
+            });
+            if (file.content instanceof stream_1.Readable) {
+                file.content.pipe(entry);
+            }
+            else {
+                entry.end(file.content);
+            }
+        });
+    }
+    /**
+     * Allows to finish the stream returning a Promise that will
+     * resolve once the readable is effectively closed or
+     * errored.
+     */
+    async end() {
+        return new Promise((resolve, reject) => {
+            this.readable.on("error", reject);
+            this.readable.on("end", resolve);
+            this.pack.finalize();
+        });
+    }
+}
+exports.FileWriter = FileWriter;

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

@@ -1 +1,2 @@
 export { APIClient } from "./api-client";
+export * from "./validators";

package/dist/api-client/index.js

@@ -1,5 +1,20 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.APIClient = void 0;
 var api_client_1 = require("./api-client");
 Object.defineProperty(exports, "APIClient", { enumerable: true, get: function () { return api_client_1.APIClient; } });
+__exportStar(require("./validators"), exports);