sandbox 0.8.6 → 1.0.0-beta.1

package/bin/sandbox.mjs

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import "@vercel/sandbox-cli/dist/sandbox.mjs";

package/dist/cli.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This module is re-exported from `@vercel/sandbox-cli`.
+ *
+ * It provides a programmatic interface to embed the Vercel Sandbox CLI
+ * in a different CLI or application.
+ *
+ * @module sandbox/cli
+ * @packageDocumentation
+ * @private
+ */
+export * from "@vercel/sandbox-cli";

package/dist/cli.js

@@ -0,0 +1,27 @@
+"use strict";
+/**
+ * This module is re-exported from `@vercel/sandbox-cli`.
+ *
+ * It provides a programmatic interface to embed the Vercel Sandbox CLI
+ * in a different CLI or application.
+ *
+ * @module sandbox/cli
+ * @packageDocumentation
+ * @private
+ */
+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 });
+__exportStar(require("@vercel/sandbox-cli"), exports);

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+/**
+ * A programmatic interface to interact with Vercel Sandboxes.
+ *
+ * Using this package you can create, destroy, and run commands on Vercel Sandboxes.
+ *
+ * @see https://vercel.com/docs/vercel-sandbox
+ *
+ * @example Create a sandbox and run a command on the remote machine
+ * ```typescript
+ * import { Sandbox } from 'sandbox'
+ *
+ * const sandbox = await Sandbox.create();
+ * await sandbox.runCommand({
+ *   cmd: 'echo',
+ *   args: ['Hello, World!'],
+ *   stdout: process.stdout,
+ *   stderr: process.stderr,
+ * });
+ * ```
+ *
+ * @example Grab an existing sandbox by its ID:
+ * ```typescript
+ * import { Sandbox } from 'sandbox'
+ *
+ * const sandbox = await Sandbox.get({ sandboxId: "sbx_..." });
+ * ```
+ *
+ * @packageDocumentation
+ */
+export * from "@vercel/sandbox";

package/dist/index.js

@@ -0,0 +1,46 @@
+"use strict";
+/**
+ * A programmatic interface to interact with Vercel Sandboxes.
+ *
+ * Using this package you can create, destroy, and run commands on Vercel Sandboxes.
+ *
+ * @see https://vercel.com/docs/vercel-sandbox
+ *
+ * @example Create a sandbox and run a command on the remote machine
+ * ```typescript
+ * import { Sandbox } from 'sandbox'
+ *
+ * const sandbox = await Sandbox.create();
+ * await sandbox.runCommand({
+ *   cmd: 'echo',
+ *   args: ['Hello, World!'],
+ *   stdout: process.stdout,
+ *   stderr: process.stderr,
+ * });
+ * ```
+ *
+ * @example Grab an existing sandbox by its ID:
+ * ```typescript
+ * import { Sandbox } from 'sandbox'
+ *
+ * const sandbox = await Sandbox.get({ sandboxId: "sbx_..." });
+ * ```
+ *
+ * @packageDocumentation
+ */
+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 });
+__exportStar(require("@vercel/sandbox"), exports);

package/package.json

@@ -1,35 +1,39 @@
 {
   "name": "sandbox",
-  "description": "A nifty javascript sandbox for node.js",
-  "homepage": "http://gf3.github.com/sandbox/",
-  "author": "Gianni Chiappetta <gianni@runlevel6.org> (http://gf3.ca)",
-  "bugs": "https://github.com/gf3/sandbox/issues",
-  "contributors": [
-    "Bradley Meck <bradley.meck@gmail.com>",
-    "Dominic Tarr (http://cyber-hobo.blogspot.com)"
-  ],
-  "version": "0.8.6",
-  "main": "./lib/sandbox",
-  "directories": {
-    "lib": "./lib"
+  "version": "1.0.0-beta.1",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "sandbox": "./bin/sandbox.mjs"
   },
-  "engines": [
-    "node >=0.5.0"
-  ],
-  "devDependencies": {
-    "mocha": "1.20.1",
-    "should": "0.6.3",
-    "sinon": "~1.10.2"
+  "exports": {
+    ".": {
+      "default": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./cli": {
+      "default": "./dist/cli.js",
+      "types": "./dist/cli.d.ts"
+    }
   },
-  "repository": {
-    "type": "git",
-    "url": "https://gf3@github.com/gf3/sandbox.git"
+  "files": [
+    "README.md",
+    "dist",
+    "bin"
+  ],
+  "private": false,
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@vercel/sandbox": "1.0.0-beta.0",
+    "@vercel/sandbox-cli": "1.0.0-beta.0"
   },
   "scripts": {
-    "test": "mocha"
-  },
-  "license": {
-    "type": "Public Domain",
-    "url": "http://github.com/gf3/sandbox/raw/master/UNLICENSE"
+    "clean": "rm -rf node_modules dist",
+    "build": "tsc",
+    "typedoc": "turbo run build && typedoc",
+    "typecheck": "tsc --noEmit"
   }
-}
+}

package/.npmignore

@@ -1,2 +0,0 @@
-*.swp
-node_modules

package/README.md

@@ -1,128 +0,0 @@
-# Node Sandbox
-
-A nifty javascript sandbox for node.js.
-
-
-## Some features
-
-- Can be used to execute untrusted code.
-- Support for timeouts (e.g. prevent infinite loops)
-- Support for memory errors (and memory errors)
-- Handles errors gracefully
-- Restricted code (cannot access node.js methods)
-- Supports `console.log` and `print` utility methods
-- Supports interprocess messaging with the sandboxed code
-
-
-## Example
-
-Be sure to check out [example/example.js](https://github.com/gf3/sandbox/blob/master/example/example.js)
-
-```javascript
-var s = new Sandbox();
-s.run('1 + 1 + " apples"', function(output) {
-  // output.result == "2 apples"
-});
-```
-
-
-## Documentation
-
-### `Sandbox`#`run`(`code`, `hollaback`)
-
-* `code` {`String`} — string of Javascript to be executed.
-* `hollaback` {`Function`} — called after execution with a single argument, `output`.
-    - `output` is an object with two properties: `result` and `console`. The `result`
-      property is an inspected string of the return value of the code. The `console`
-      property is an array of all console output.
-
-For example, given the following code:
-
-```javascript
-function add(a, b){
-  console.log(a);
-  console.log(b);
-  return a + b;
-}
-
-add(20, 22);
-```
-
-The resulting output object is:
-
-```javascript
-{
-  result: "42",
-  console: ["20", "22"]
-}
-```
-
-### `Sandbox`#`postMessage`(`message`)
-
-* `message` {`String`} - message to send to the sandboxed code
-
-For example, the following code will send a message from outside of the sandbox in
-and then the sandboxed code will respond with its own message. Note that the sandboxed
-code handles incoming messages by defining a global `onmessage` function and can
-send messages to the outside using the `postMessage` function.
-
-Sandboxed code:
-```javascript
-onmessage = function(message){
-  if (message === 'hello from outside') {
-    postMessage('hello from inside');
-  }
-};
-```
-
-Sandbox:
-```
-var sandbox = new Sandbox();
-sandbox.run(sandboxed_code);
-sandbox.on('message', function(message){
-  // Handle message sent from the inside
-  // In this example message will be 'hello from inside'
-});
-sandbox.postMessage('hello from outside');
-```
-
-The process will ONLY be considered finished if `onmessage` is NOT a function.
-If `onmessage` is defined the sandbox will assume that it is waiting for an
-incoming message.
-
-
-## Installation & Running
-
-Let's get it! The easiest way is through npm:
-
-    npm install sandbox
-
-Or if you'd like to play with the code, see the examples, run the tests,
-what-the-fuck-ever...
-
-    git clone git://github.com/gf3/sandbox.git
-
-And run some examples:
-
-    node example/example.js
-
-
-## Tests
-
-To run the tests simply run the test file with node.
-
-    npm test
-
-
-## License
-
-Sandbox is [UNLICENSED](http://unlicense.org/).
-
-
-## Contributors
-
-- [Gianni Chiappetta](http://github.com/gf3) – [gf3.ca](http://gf3.ca)
-- [Bradley Meck](https://github.com/bmeck)
-- [Dominic Tarr](http://github.com/dominictarr) – [cyber-hobo.blogspot.com](http://cyber-hobo.blogspot.com/)
-- [Eli Mallon](https://github.com/iameli) – [iame.li](http://iame.li/)
-- [Evan Schwartz](https://github.com/emschwartz)

package/UNLICENSE

@@ -1,25 +0,0 @@
-This is free and unencumbered software released into the public domain.
-
-Anyone is free to copy, modify, publish, use, compile, sell, or
-distribute this software, either in source code form or as a compiled
-binary, for any purpose, commercial or non-commercial, and by any
-means.
-
-In jurisdictions that recognize copyright laws, the author or authors
-of this software dedicate any and all copyright interest in the
-software to the public domain. We make this dedication for the benefit
-of the public at large and to the detriment of our heirs and
-successors. We intend this dedication to be an overt act of
-relinquishment in perpetuity of all present and future rights to this
-software under copyright law.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
-OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
-
-For more information, please refer to <http://unlicense.org/>
-