sandbox 2.0.0-alpha5 → 2.0.0

package/package.json

@@ -1,38 +1,59 @@
 {
   "name": "sandbox",
-  "version": "2.0.0-alpha5",
-  "description": "A nifty JavaScript sandbox.",
-  "main": "index.js",
+  "description": "Command line interface for Vercel Sandbox",
+  "version": "2.0.0",
+  "keywords": [
+    "vercel",
+    "sandbox",
+    "cli"
+  ],
+  "main": "./dist/index.mjs",
+  "bin": {
+    "sandbox": "./bin/sandbox.mjs",
+    "sbx": "./bin/sandbox.mjs"
+  },
   "files": [
-    "index.js",
-    "index.node",
-    "install.js",
-    "platform-target.js"
+    "bin",
+    "README.md",
+    "dist"
   ],
-  "scripts": {
-    "build": "cargo-cp-artifact -nc index.node -- cargo build --message-format=json-render-diagnostics",
-    "build-debug": "npm run build --",
-    "build-release": "npm run build -- --release",
-    "postinstall": "node ./install.js",
-    "test": "mocha"
+  "license": "MIT",
+  "dependencies": {
+    "debug": "^4.4.1",
+    "zod": "^4.1.1",
+    "@vercel/sandbox": "1.3.0"
   },
-  "author": "Gianni Chiappetta <gianni@runlevel6.org>",
-  "license": "ISC",
   "devDependencies": {
-    "cargo-cp-artifact": "^0.1",
-    "mocha": "^9.1.1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/gf3/sandbox.git"
+    "@types/debug": "^4.1.12",
+    "@types/ms": "^2.1.0",
+    "@types/node": "^22.15.12",
+    "@vercel/oidc": "^3.1.0",
+    "chalk": "^5.6.0",
+    "cmd-ts": "0.14.3",
+    "date-fns": "^4.1.0",
+    "dotenv-flow": "^4.1.0",
+    "listr2": "^9.0.2",
+    "ms": "^2.1.3",
+    "open": "^10.2.0",
+    "ora": "^8.2.0",
+    "tsdown": "0.16.6",
+    "vitest": "3.2.1",
+    "xdg-app-paths": "5.1.0",
+    "@vercel/pty-tunnel": "2.0.3",
+    "@vercel/pty-tunnel-server": "0.0.2",
+    "@vercel/sandbox": "1.3.0"
   },
-  "keywords": [
-    "javascript",
-    "sandbox",
-    "eval"
-  ],
-  "bugs": {
-    "url": "https://github.com/gf3/sandbox/issues"
-  },
-  "homepage": "https://github.com/gf3/sandbox#readme"
-}
+  "scripts": {
+    "clean": "rm -rf node_modules dist",
+    "sandbox": "ts-node ./src/sandbox.ts",
+    "build": "tsdown",
+    "vercel-build": "ts-node ./scripts/create-preview-deployment-tgz.ts",
+    "test": "vitest",
+    "example-whoami": "ts-node ./src/example-whoami.ts",
+    "example-next": "ts-node ./src/example-next.ts",
+    "example-flask": "ts-node ./src/example-flask.ts",
+    "typecheck": "tsc --noEmit",
+    "generate-docs": "ts-node ./scripts/print-usage.ts > docs/index.md",
+    "version:bump": "pnpm generate-docs"
+  }
+}

package/index.js

@@ -1,29 +0,0 @@
-"use strict";
-
-const { shovelNew, shovelEval } = require("./index.node");
-
-/**
- * Sandbox for running JavaScript.
- */
-class Sandbox {
-  constructor() {
-    // Wrapper for boxed `Shovel`
-    this._shovel = shovelNew();
-  }
-
-  /**
-   * Evaluate arbitrary source code.
-   */
-  eval(source, callback) {
-    return shovelEval.call(this._shovel, source, function (err, res) {
-      try {
-        callback.call(undefined, err, res);
-      } catch (e) {
-        console.error("Uncaught %O", e);
-        throw e;
-      }
-    });
-  }
-}
-
-module.exports = Sandbox;

package/install.js

@@ -1,5 +0,0 @@
-#!/usr/bin/env node
-
-const { install } = require("./platform-target");
-
-install();

package/platform-target.js

@@ -1,217 +0,0 @@
-const http = require("https");
-const fs = require("fs");
-const os = require("os");
-const { gunzip } = require("zlib");
-const { bugs, version, name, repository } = require("./package.json");
-const { debuglog, promisify } = require("util");
-
-const PLATFORMS = [
-  {
-    TYPE: "Windows_NT",
-    ARCHITECTURE: "x64",
-    RUST_TARGET: "x86_64-pc-windows-msvc",
-  },
-  {
-    TYPE: "Linux",
-    ARCHITECTURE: "x64",
-    RUST_TARGET: "x86_64-unknown-linux-gnu",
-  },
-  {
-    TYPE: "Darwin",
-    ARCHITECTURE: "x64",
-    RUST_TARGET: "x86_64-apple-darwin",
-  },
-  {
-    TYPE: "Darwin",
-    ARCHITECTURE: "arm64",
-    RUST_TARGET: "aarch64-apple-darwin",
-  },
-];
-const BINARY_NAME = "index.node";
-
-const log = debuglog("sandbox");
-
-function error(message) {
-  console.error(`💥 ${message}`);
-  process.exit(1);
-}
-
-function getPlatform() {
-  const type = os.type();
-  const arch = os.arch();
-
-  for (let platform of PLATFORMS) {
-    if (type === platform.TYPE && arch === platform.ARCHITECTURE) {
-      return platform;
-    }
-  }
-
-  error(
-    `Platform "${type}" and architecture "${arch}" are not supported by ${name}. Please file an issue: ${bugs.url}`,
-  );
-}
-
-/**
- * @callback BufferCallback
- * @param {any} err - Error, if `undefined` the operation was successful.
- * @param {Buffer} buffer - Result of operation.
- * @returns {void}
- */
-
-/**
- * Download a given URL to a Buffer.
- *
- * @param {string} url - URL to download.
- * @param {BufferCallback} callback - Buffer containing downloaded file.
- * @returns {void}
- */
-function download(url, callback) {
-  log("download: %s", url);
-
-  const chunks = [];
-
-  http
-    .get(url, function (response) {
-      log("download.response: %d", response.statusCode);
-
-      if (
-        response.statusCode >= 300 &&
-        response.statusCode < 400 &&
-        response.headers &&
-        response.headers.location
-      ) {
-        download(response.headers.location, callback);
-        return;
-      }
-
-      if (response.statusCode !== 200) {
-        process.nextTick(callback, `Status ${response.statusCode} for ${url}`);
-        return;
-      }
-
-      response.on("data", function (chunk) {
-        chunks.push(chunk);
-      });
-      response.on("end", function () {
-        process.nextTick(callback, undefined, Buffer.concat(chunks));
-      });
-      response.on("error", callback);
-    })
-    .on("error", function (err) {
-      log("download.error: %O", err);
-      process.nextTick(callback, err);
-    });
-}
-
-/**
- * Decompress a given Buffer.
- *
- * @param {Buffer} buffer - Compressed data.
- * @param {BufferCallback} callback - Buffer containing decompressed data.
- * @returns {void}
- */
-function decompress(buffer, callback) {
-  log("decompress");
-
-  gunzip(buffer, function (err, decompressedBuffer) {
-    if (err) {
-      log("decompress.error: %O", err);
-      process.nextTick(callback, err);
-      return;
-    }
-    process.nextTick(callback, undefined, decompressedBuffer);
-  });
-}
-
-/**
- * Save a buffer to the filesystem.
- *
- * @param {Buffer} buffer - File contents.
- * @param {string} filename - File path and name.
- * @param {Function} callback - Called with the saved filename if sucessful.
- * @returns {void}
- */
-function save(buffer, filename, callback) {
-  log("save: %s", filename);
-
-  const stream = fs.createWriteStream(filename);
-  const done = function () {
-    stream.end();
-    process.nextTick(callback, undefined, filename);
-  };
-
-  if (stream.write(buffer)) {
-    done();
-    return;
-  } else {
-    stream.once("drain", done);
-  }
-}
-
-/**
- * Verify installation.
- *
- * @param {string} filename - File to verify.
- * @param {Function} callback - Called with `true` to indicate the installation
- *                              has been verified.
- * @returns {void}
- */
-function verify(filename, callback) {
-  log("verify: %s", filename);
-
-  fs.existsSync(filename)
-    ? process.nextTick(callback, undefined, true)
-    : process.nextTick(callback, true);
-}
-
-/**
- * Determine the current platform and attempt to download and install a
- * pre-built binary.
- *
- * NOTE: The download will be skipped if an environment variable
- * `SANDBOX_SKIP_DOWNLOAD` exists.
- *
- * @returns {void}
- */
-async function install() {
-  if (process.env.SANDBOX_SKIP_DOWNLOAD) {
-    log("skipping install");
-    return;
-  }
-
-  const platform = getPlatform();
-
-  log("install: %O", platform);
-
-  if (fs.existsSync(BINARY_NAME)) {
-    log("install.exists: %s", BINARY_NAME);
-    console.log(`🎊 ${name} already downloaded!`);
-    return;
-  }
-
-  const repositoryUrl = repository.url
-    .replace("git+https", "https")
-    .replace(`${name}.git`, name);
-  const url = `${repositoryUrl}/releases/download/v${version}/${name}-v${version}-${platform.RUST_TARGET}.gz`;
-
-  log("install.url: %s", url);
-
-  try {
-    const buffer = await promisify(download)(url);
-    const binary = await promisify(decompress)(buffer);
-    const filename = await promisify(save)(binary, BINARY_NAME);
-    const verified = await promisify(verify)(filename);
-
-    if (!verified) {
-      throw new Error(`Unable to verify ${filename}`);
-    }
-
-    console.log(`🥂 Successfully downloaded ${name} ${version}`);
-  } catch (err) {
-    error(err);
-  }
-}
-
-module.exports = {
-  install,
-};