@vercel/sandbox 0.0.4 → 0.0.5

package/.turbo/turbo-build.log

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

package/.turbo/turbo-typecheck.log

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

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @vercel/sandbox
 
+## 0.0.5
+
+### Patch Changes
+
+- Allow specifying env vars and cwd when running commands ([#25](https://github.com/vercel/sandbox-sdk/pull/25))
+
+- createSandbox: do not require ports to be specified ([#27](https://github.com/vercel/sandbox-sdk/pull/27))
+
 ## 0.0.4
 
 ### Patch Changes

package/README.md

@@ -13,6 +13,7 @@ Vercel Sandbox is in private beta. These examples will not work unless these
 APIs are enabled for your team.
 
 - Go to your team settings, and copy the team ID.
+- Go to a project's settings, and copy the project ID.
 - Go to your Vercel account settings and [create a token][create-token]. Make
   sure it is scoped to the team ID from the previous step.
 - Create a new project:
@@ -31,7 +32,7 @@ Now create `next-dev.ts`:
 Run it like this:
 
 ```sh
-VERCEL_TEAM_ID=<team_id> VERCEL_TOKEN=<token> node --experimental-strip-types ./next-dev.ts
+VERCEL_TEAM_ID=<team_id> VERCEL_TOKEN=<token> VERCEL_PROJECT_ID=<project_id> node --experimental-strip-types ./next-dev.ts
 ```
 
 This will:

package/dist/client/client.d.ts

@@ -28,6 +28,7 @@ export declare class SandboxClient extends APIClient {
         cwd?: string;
         command: string;
         args: string[];
+        env: Record<string, string>;
     }): Promise<import("./base-client").Parsed<{
         cmdId: string;
     }>>;

package/dist/client/client.js

@@ -50,6 +50,7 @@ class SandboxClient extends base_client_1.APIClient {
                 command: params.command,
                 args: params.args,
                 cwd: params.cwd,
+                env: params.env,
             }),
         }));
     }

package/dist/create-sandbox.d.ts

@@ -40,7 +40,7 @@ export declare class SDK {
      * @param params.source - The source of the sandbox, currently supports Git repositories only.
      * @param params.source.type - Type of source, must be `"git"`.
      * @param params.source.url - The URL of the public Git repository to clone.
-     * @param config.projectId - The Vercel project ID used to link the Sandbox to.
+     * @param params.projectId - The Vercel project ID used to link the Sandbox to.
      * @param params.ports - Array of port numbers to expose from the sandbox.
      * @param params.timeout - (Optional) Timeout in seconds before the sandbox auto-terminates.
      *
@@ -52,7 +52,7 @@ export declare class SDK {
             url: string;
         };
         projectId: string;
-        ports: number[];
+        ports?: number[];
         timeout?: number;
     }): Promise<Sandbox>;
     /** @hidden */
@@ -64,6 +64,17 @@ export declare class SDK {
         sandboxId: string;
     }): Promise<Sandbox>;
 }
+/** @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>;
+}
 /**
  * A Sandbox is an isolated Linux MicroVM that you can your experiments on.
  *
@@ -91,11 +102,22 @@ export declare class Sandbox {
     });
     /**
      * Start executing a command in this sandbox.
-     * @param command
-     * @param args
-     * @returns
+     *
+     * @param command - The command to execute.
+     * @param args - Arguments to pass to the command.
+     *
+     * @returns A {@link Command} instance.
      */
     runCommand(command: string, args?: string[]): Promise<Command>;
+    /**
+     * Start executing a command in this sandbox.
+     *
+     * @param params - What should be executed.
+     *
+     * @returns A {@link Command} instance.
+     */
+    runCommand(params: RunCommandParams): Promise<Command>;
+    _runCommand(params: RunCommandParams): Promise<Command>;
     /**
      * Write files to the filesystem of this sandbox.
      */
@@ -194,3 +216,4 @@ export declare class Command {
      */
     stderr(): Promise<string>;
 }
+export {};

package/dist/create-sandbox.js

@@ -37,7 +37,7 @@ class SDK {
      * @param params.source - The source of the sandbox, currently supports Git repositories only.
      * @param params.source.type - Type of source, must be `"git"`.
      * @param params.source.url - The URL of the public Git repository to clone.
-     * @param config.projectId - The Vercel project ID used to link the Sandbox to.
+     * @param params.projectId - The Vercel project ID used to link the Sandbox to.
      * @param params.ports - Array of port numbers to expose from the sandbox.
      * @param params.timeout - (Optional) Timeout in seconds before the sandbox auto-terminates.
      *
@@ -48,7 +48,7 @@ class SDK {
         const sandbox = await client.createSandbox({
             source: params.source,
             projectId: params.projectId,
-            ports: params.ports,
+            ports: params.ports ?? [],
             timeout: params.timeout,
         });
         return new Sandbox({
@@ -79,17 +79,18 @@ class Sandbox {
         this.routes = routes;
         this.sandboxId = sandboxId;
     }
-    /**
-     * Start executing a command in this sandbox.
-     * @param command
-     * @param args
-     * @returns
-     */
-    async runCommand(command, args = []) {
+    async runCommand(commandOrParams, args) {
+        return typeof commandOrParams === "string"
+            ? this._runCommand({ cmd: commandOrParams, args })
+            : this._runCommand(commandOrParams);
+    }
+    async _runCommand(params) {
         const commandResponse = await this.client.runCommand({
             sandboxId: this.sandboxId,
-            command,
-            args,
+            command: params.cmd,
+            args: params.args ?? [],
+            cwd: params.cwd,
+            env: params.env ?? {},
         });
         return new Command({
             client: this.client,

package/dist/index.d.ts

@@ -1,2 +1 @@
 export { SDK, Sandbox, Command } from "./create-sandbox";
-export { SandboxClient } from "./client/client";

package/dist/index.js

@@ -1,9 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SandboxClient = exports.Command = exports.Sandbox = exports.SDK = void 0;
+exports.Command = exports.Sandbox = exports.SDK = void 0;
 var create_sandbox_1 = require("./create-sandbox");
 Object.defineProperty(exports, "SDK", { enumerable: true, get: function () { return create_sandbox_1.SDK; } });
 Object.defineProperty(exports, "Sandbox", { enumerable: true, get: function () { return create_sandbox_1.Sandbox; } });
 Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return create_sandbox_1.Command; } });
-var client_1 = require("./client/client");
-Object.defineProperty(exports, "SandboxClient", { enumerable: true, get: function () { return client_1.SandboxClient; } });

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "0.0.4";
+export declare const VERSION = "0.0.5";

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.4";
+exports.VERSION = "0.0.5";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/sandbox",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/client/client.ts

@@ -65,6 +65,7 @@ export class SandboxClient extends APIClient {
     cwd?: string;
     command: string;
     args: string[];
+    env: Record<string, string>;
   }) {
     return parseOrThrow(
       CreatedCommand,
@@ -74,6 +75,7 @@ export class SandboxClient extends APIClient {
           command: params.command,
           args: params.args,
           cwd: params.cwd,
+          env: params.env,
         }),
       }),
     );

package/src/create-sandbox.ts

@@ -42,7 +42,7 @@ export class SDK {
    * @param params.source - The source of the sandbox, currently supports Git repositories only.
    * @param params.source.type - Type of source, must be `"git"`.
    * @param params.source.url - The URL of the public Git repository to clone.
-   * @param config.projectId - The Vercel project ID used to link the Sandbox to.
+   * @param params.projectId - The Vercel project ID used to link the Sandbox to.
    * @param params.ports - Array of port numbers to expose from the sandbox.
    * @param params.timeout - (Optional) Timeout in seconds before the sandbox auto-terminates.
    *
@@ -51,14 +51,14 @@ export class SDK {
   async createSandbox(params: {
     source: { type: "git"; url: string };
     projectId: string;
-    ports: number[];
+    ports?: number[];
     timeout?: number;
   }) {
     const { client } = this;
     const sandbox = await client.createSandbox({
       source: params.source,
       projectId: params.projectId,
-      ports: params.ports,
+      ports: params.ports ?? [],
       timeout: params.timeout,
     });
 
@@ -85,6 +85,18 @@ export class SDK {
   }
 }
 
+/** @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>;
+}
+
 /**
  * A Sandbox is an isolated Linux MicroVM that you can your experiments on.
  *
@@ -118,15 +130,39 @@ export class Sandbox {
 
   /**
    * Start executing a command in this sandbox.
-   * @param command
-   * @param args
-   * @returns
+   *
+   * @param command - The command to execute.
+   * @param args - Arguments to pass to the command.
+   *
+   * @returns A {@link Command} instance.
    */
-  async runCommand(command: string, args: string[] = []) {
+  async runCommand(command: string, args?: string[]): Promise<Command>;
+
+  /**
+   * Start executing a command in this sandbox.
+   *
+   * @param params - What should be executed.
+   *
+   * @returns A {@link Command} instance.
+   */
+  async runCommand(params: RunCommandParams): Promise<Command>;
+
+  async runCommand(
+    commandOrParams: string | RunCommandParams,
+    args?: string[],
+  ): Promise<Command> {
+    return typeof commandOrParams === "string"
+      ? this._runCommand({ cmd: commandOrParams, args })
+      : this._runCommand(commandOrParams);
+  }
+
+  async _runCommand(params: RunCommandParams) {
     const commandResponse = await this.client.runCommand({
       sandboxId: this.sandboxId,
-      command,
-      args,
+      command: params.cmd,
+      args: params.args ?? [],
+      cwd: params.cwd,
+      env: params.env ?? {},
     });
 
     return new Command({

package/src/index.ts

@@ -1,2 +1 @@
 export { SDK, Sandbox, Command } from "./create-sandbox";
-export { SandboxClient } from "./client/client";

package/src/version.ts

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