@vercel/sandbox 0.0.2 → 0.0.4

package/.turbo/turbo-build.log

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

package/.turbo/turbo-typecheck.log

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

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @vercel/sandbox
 
+## 0.0.4
+
+### Patch Changes
+
+- Rename `SandboxSDK` to `SDK` and incorporate `projectId` as a required parameter ([#21](https://github.com/vercel/sandbox-sdk/pull/21))
+
+## 0.0.3
+
+### Patch Changes
+
+- Do not include dev scripts in package output ([#16](https://github.com/vercel/sandbox-sdk/pull/16))
+
 ## 0.0.2
 
 ### Patch Changes

package/README.md

@@ -12,31 +12,36 @@ infrastructure][hive] that powers 1M+ builds a day at Vercel.
 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 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:
-
-```
-$ mkdir sandbox-test
-$ pnpm init
-$ pnpm add @vercel/sandbox
-$ pnpm add --save-dev tsx
+- Go to your team settings, and copy the team 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:
+
+```sh
+mkdir sandbox-test
+cd sandbox-test
+pnpm init
+pnpm add @vercel/sandbox ms
 ```
 
-Now create `whoami.ts`:
+Now create `next-dev.ts`:
 
-{@includeCode ../cli/src/example-whoami.ts}
+{@includeCode ../cli/src/example-next.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> pnpm tsx ./whoami.ts
-Running as: vercel-sandbox
-Working dir: /vercel/sandbox
-```
 
-Now have a look at the sidebar for which classes exist.
+This will:
+
+- Start a sandbox, seeding it with a git repository.
+- Install dependencies.
+- Run a `next dev` server
+- Open it in your browser
+
+All while streaming logs to your local terminal.
 
 ## Limitations
 

package/dist/{src/client → client}/client.d.ts

@@ -9,11 +9,12 @@ export declare class SandboxClient extends APIClient {
     });
     protected request(path: string, params?: RequestParams): Promise<import("node-fetch").Response>;
     createSandbox(params: {
+        ports: number[];
+        projectId: string;
         source: {
             type: "git";
             url: string;
         };
-        ports: number[];
         timeout?: number;
     }): Promise<import("./base-client").Parsed<{
         sandboxId: string;

package/dist/{src/client → client}/client.js

@@ -36,6 +36,7 @@ class SandboxClient extends base_client_1.APIClient {
         return (0, base_client_1.parseOrThrow)(validators_1.CreatedSandbox, await this.request("/v1/sandboxes", {
             method: "POST",
             body: JSON.stringify({
+                projectId: params.projectId,
                 ports: params.ports,
                 source: params.source,
                 timeout: params.timeout,

package/dist/{src/create-sandbox.d.ts → create-sandbox.d.ts}

@@ -1,36 +1,57 @@
 import { SandboxClient } from "./client/client";
 import { Readable } from "stream";
 /**
- * Create a new instance of the SandboxSDK.
+ * SDK for interacting with the Sandbox API. Provides methods to create and
+ * manage sandboxes configured with specific source code and network ports.
  *
- * ````
- * const teamId = process.env.VERCEL_TEAM_ID
- * const token = process.env.VERCEL_TOKEN
- * const sdk = new SandboxSDK({ teamId: teamId!, token: token! });
- * ````
+ * Example:
+ * ```ts
+ * const sdk = new SDK({
+ *   teamId: process.env.VERCEL_TEAM_ID!,
+ *   token: process.env.VERCEL_TOKEN!,
+ * });
+ * ```
  *
- * @see {@link createSandbox} to start a sandbox.
+ * @see {@link SDK.createSandbox} to start a new sandbox.
  */
-export declare class SandboxSDK {
-    client: SandboxClient;
+export declare class SDK {
+    /**
+     * Internal API client for communicating with the sandbox backend.
+     */
+    private client;
+    /**
+     * Create a new instance of `SDK`.
+     *
+     * @param config - Configuration options for the SDK.
+     * @param config.teamId - The Vercel team ID used to scope the Sandbox.
+     * @param config.token - The API token used for authentication.
+     */
     constructor({ teamId, token }: {
         teamId: string;
         token: string;
     });
     /**
-     * Create a new Sandbox with the given resources, source code, and ports.
+     * Creates a new sandbox instance using the provided Git repository and exposed ports.
+     *
+     * The repository must be public. On start, the sandbox will clone the repository
+     * and expose the specified ports for access.
      *
-     * Upon start, the sandbox will perform a `git clone` of the repository given.
-     * This repo needs to be public.
+     * @param params - Configuration parameters for the sandbox.
+     * @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.ports - Array of port numbers to expose from the sandbox.
+     * @param params.timeout - (Optional) Timeout in seconds before the sandbox auto-terminates.
      *
-     * @param params
-     * @returns a
+     * @returns A promise that resolves to a `Sandbox` instance.
      */
     createSandbox(params: {
         source: {
             type: "git";
             url: string;
         };
+        projectId: string;
         ports: number[];
         timeout?: number;
     }): Promise<Sandbox>;
@@ -46,7 +67,7 @@ export declare class SandboxSDK {
 /**
  * A Sandbox is an isolated Linux MicroVM that you can your experiments on.
  *
- * @see {@link SandboxSDK.createSandbox} to construct a Sandbox.
+ * @see {@link SDK.createSandbox} to construct a Sandbox.
  * @hideconstructor
  */
 export declare class Sandbox {

package/dist/{src/create-sandbox.js → create-sandbox.js}

@@ -1,35 +1,53 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Command = exports.Sandbox = exports.SandboxSDK = void 0;
+exports.Command = exports.Sandbox = exports.SDK = void 0;
 const client_1 = require("./client/client");
 /**
- * Create a new instance of the SandboxSDK.
+ * SDK for interacting with the Sandbox API. Provides methods to create and
+ * manage sandboxes configured with specific source code and network ports.
  *
- * ````
- * const teamId = process.env.VERCEL_TEAM_ID
- * const token = process.env.VERCEL_TOKEN
- * const sdk = new SandboxSDK({ teamId: teamId!, token: token! });
- * ````
+ * Example:
+ * ```ts
+ * const sdk = new SDK({
+ *   teamId: process.env.VERCEL_TEAM_ID!,
+ *   token: process.env.VERCEL_TOKEN!,
+ * });
+ * ```
  *
- * @see {@link createSandbox} to start a sandbox.
+ * @see {@link SDK.createSandbox} to start a new sandbox.
  */
-class SandboxSDK {
+class SDK {
+    /**
+     * Create a new instance of `SDK`.
+     *
+     * @param config - Configuration options for the SDK.
+     * @param config.teamId - The Vercel team ID used to scope the Sandbox.
+     * @param config.token - The API token used for authentication.
+     */
     constructor({ teamId, token }) {
         this.client = new client_1.SandboxClient({ teamId, token });
     }
     /**
-     * Create a new Sandbox with the given resources, source code, and ports.
+     * Creates a new sandbox instance using the provided Git repository and exposed ports.
+     *
+     * The repository must be public. On start, the sandbox will clone the repository
+     * and expose the specified ports for access.
      *
-     * Upon start, the sandbox will perform a `git clone` of the repository given.
-     * This repo needs to be public.
+     * @param params - Configuration parameters for the sandbox.
+     * @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.ports - Array of port numbers to expose from the sandbox.
+     * @param params.timeout - (Optional) Timeout in seconds before the sandbox auto-terminates.
      *
-     * @param params
-     * @returns a
+     * @returns A promise that resolves to a `Sandbox` instance.
      */
     async createSandbox(params) {
         const { client } = this;
         const sandbox = await client.createSandbox({
             source: params.source,
+            projectId: params.projectId,
             ports: params.ports,
             timeout: params.timeout,
         });
@@ -48,11 +66,11 @@ class SandboxSDK {
         });
     }
 }
-exports.SandboxSDK = SandboxSDK;
+exports.SDK = SDK;
 /**
  * A Sandbox is an isolated Linux MicroVM that you can your experiments on.
  *
- * @see {@link SandboxSDK.createSandbox} to construct a Sandbox.
+ * @see {@link SDK.createSandbox} to construct a Sandbox.
  * @hideconstructor
  */
 class Sandbox {

package/dist/index.d.ts

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

package/dist/{src/index.js → index.js}

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SandboxClient = exports.Command = exports.Sandbox = exports.SandboxSDK = void 0;
+exports.SandboxClient = exports.Command = exports.Sandbox = exports.SDK = void 0;
 var create_sandbox_1 = require("./create-sandbox");
-Object.defineProperty(exports, "SandboxSDK", { enumerable: true, get: function () { return create_sandbox_1.SandboxSDK; } });
+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");

package/dist/version.d.ts

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

package/dist/{src/version.js → 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.2";
+exports.VERSION = "0.0.4";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/sandbox",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -23,6 +23,7 @@
     "typescript": "5.8.3"
   },
   "scripts": {
+    "clean": "rm -rf node_modules dist",
     "build": "tsc",
     "typedoc": "typedoc",
     "typecheck": "tsc --noEmit",

package/src/client/client.ts

@@ -41,8 +41,9 @@ export class SandboxClient extends APIClient {
   }
 
   async createSandbox(params: {
-    source: { type: "git"; url: string };
     ports: number[];
+    projectId: string;
+    source: { type: "git"; url: string };
     timeout?: number;
   }) {
     return parseOrThrow(
@@ -50,6 +51,7 @@ export class SandboxClient extends APIClient {
       await this.request("/v1/sandboxes", {
         method: "POST",
         body: JSON.stringify({
+          projectId: params.projectId,
           ports: params.ports,
           source: params.source,
           timeout: params.timeout,

package/src/create-sandbox.ts

@@ -2,40 +2,62 @@ import { SandboxClient } from "./client/client";
 import { Readable } from "stream";
 
 /**
- * Create a new instance of the SandboxSDK.
+ * SDK for interacting with the Sandbox API. Provides methods to create and
+ * manage sandboxes configured with specific source code and network ports.
  *
- * ````
- * const teamId = process.env.VERCEL_TEAM_ID
- * const token = process.env.VERCEL_TOKEN
- * const sdk = new SandboxSDK({ teamId: teamId!, token: token! });
- * ````
+ * Example:
+ * ```ts
+ * const sdk = new SDK({
+ *   teamId: process.env.VERCEL_TEAM_ID!,
+ *   token: process.env.VERCEL_TOKEN!,
+ * });
+ * ```
  *
- * @see {@link createSandbox} to start a sandbox.
+ * @see {@link SDK.createSandbox} to start a new sandbox.
  */
-export class SandboxSDK {
-  public client: SandboxClient;
+export class SDK {
+  /**
+   * Internal API client for communicating with the sandbox backend.
+   */
+  private client: SandboxClient;
 
+  /**
+   * Create a new instance of `SDK`.
+   *
+   * @param config - Configuration options for the SDK.
+   * @param config.teamId - The Vercel team ID used to scope the Sandbox.
+   * @param config.token - The API token used for authentication.
+   */
   constructor({ teamId, token }: { teamId: string; token: string }) {
     this.client = new SandboxClient({ teamId, token });
   }
 
   /**
-   * Create a new Sandbox with the given resources, source code, and ports.
+   * Creates a new sandbox instance using the provided Git repository and exposed ports.
+   *
+   * The repository must be public. On start, the sandbox will clone the repository
+   * and expose the specified ports for access.
    *
-   * Upon start, the sandbox will perform a `git clone` of the repository given.
-   * This repo needs to be public.
+   * @param params - Configuration parameters for the sandbox.
+   * @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.ports - Array of port numbers to expose from the sandbox.
+   * @param params.timeout - (Optional) Timeout in seconds before the sandbox auto-terminates.
    *
-   * @param params
-   * @returns a
+   * @returns A promise that resolves to a `Sandbox` instance.
    */
   async createSandbox(params: {
     source: { type: "git"; url: string };
+    projectId: string;
     ports: number[];
     timeout?: number;
   }) {
     const { client } = this;
     const sandbox = await client.createSandbox({
       source: params.source,
+      projectId: params.projectId,
       ports: params.ports,
       timeout: params.timeout,
     });
@@ -66,7 +88,7 @@ export class SandboxSDK {
 /**
  * A Sandbox is an isolated Linux MicroVM that you can your experiments on.
  *
- * @see {@link SandboxSDK.createSandbox} to construct a Sandbox.
+ * @see {@link SDK.createSandbox} to construct a Sandbox.
  * @hideconstructor
  */
 export class Sandbox {

package/src/index.ts

@@ -1,2 +1,2 @@
-export { SandboxSDK, Sandbox, Command } from "./create-sandbox";
+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.2";
+export const VERSION = "0.0.4";

package/tsconfig.json

@@ -9,5 +9,5 @@
     "module": "commonjs",
     "resolveJsonModule": true
   },
-  "include": ["scripts/**/*", "src/**/*"]
+  "include": ["src/**/*"]
 }

package/dist/package.json

@@ -1,31 +0,0 @@
-{
-    "name": "@vercel/sandbox",
-    "version": "0.0.2",
-    "description": "",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "scripts": {
-        "build": "tsc",
-        "typedoc": "typedoc",
-        "typecheck": "tsc --noEmit",
-        "inject-version": "ts-node scripts/inject-version.ts"
-    },
-    "keywords": [],
-    "author": "",
-    "license": "ISC",
-    "dependencies": {
-        "async-retry": "1.3.3",
-        "form-data": "3.0.0",
-        "jsonlines": "0.1.1",
-        "node-fetch": "2.6.11",
-        "zod": "3.24.4"
-    },
-    "devDependencies": {
-        "@types/async-retry": "1.4.9",
-        "@types/jsonlines": "0.1.5",
-        "@types/node": "22.15.12",
-        "@types/node-fetch": "2.6.12",
-        "typedoc": "^0.28.4",
-        "typescript": "5.8.3"
-    }
-}

package/dist/scripts/inject-version.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/scripts/inject-version.js

@@ -1,14 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const package_json_1 = require("../package.json");
-const promises_1 = require("fs/promises");
-const path_1 = __importDefault(require("path"));
-async function main() {
-    const outPath = path_1.default.resolve(__dirname, "../src/version.ts");
-    const content = `// Autogenerated by inject-version.ts\nexport const VERSION = "${package_json_1.version}";\n`;
-    await (0, promises_1.writeFile)(outPath, content);
-}
-main().catch(console.error);

package/dist/src/index.d.ts

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

package/dist/src/version.d.ts

@@ -1 +0,0 @@
-export declare const VERSION = "0.0.2";