Revert ambient

changelog.md

@@ -4,7 +4,11 @@
 
 // TODO
 
-### 2.0.0-alpha.2
+### 2.0.0-alpha.4
+
+* Allow running a dangerfile entirely from memory using the `Executor` API - orta
+
+### 2.0.0-alpha.2-3
 
 * Removes the `jest-*` dependencies - orta
 

source/ambient.d.ts

@@ -13,3 +13,132 @@ declare module "jsonpointer"
 declare module "parse-link-header"
 
 declare module "*/package.json"
+
+declare module "vm2" {
+  /**
+   *  Require options for a VM
+   */
+  export interface VMRequire {
+    /** Array of allowed builtin modules, accepts ["*"] for all (default: none) */
+    builtin?: string[]
+    /*
+    * `host` (default) to require modules in host and proxy them to sandbox. `sandbox` to load, compile and
+    * require modules in sandbox. Builtin modules except `events` always required in host and proxied to sandbox
+    */
+    context?: "host" | "sandbox"
+    /** `true` or an array of allowed external modules (default: `false`) */
+    external?: boolean | string[]
+    /** Array of modules to be loaded into NodeVM on start. */
+    import?: string[]
+    /** Restricted path where local modules can be required (default: every path). */
+    root?: string
+    /** Collection of mock modules (both external or builtin). */
+    mock?: any
+  }
+
+  /**
+   * A custom compiler function for all of the JS that comes
+   * into the VM
+   */
+  type CompilerFunction = (code: string, filename: string) => string
+
+  /**
+   *  Options for creating a NodeVM
+   */
+  export interface VMOptions {
+    /**
+     * `javascript` (default) or `coffeescript` or custom compiler function (which receives the code, and it's filepath).
+     *  The library expects you to have coffee-script pre-installed if the compiler is set to `coffeescript`.
+     */
+    compiler?: "javascript" | "coffeescript" | CompilerFunction
+    /** VM's global object. */
+    sandbox?: any
+    /**
+     * Script timeout in milliseconds.  Timeout is only effective on code you run through `run`.
+     * Timeout is NOT effective on any method returned by VM.
+     */
+    timeout?: number
+  }
+
+  /**
+   *  Options specific o
+   */
+  export interface NodeVMOptions extends VMOptions {
+    /** `inherit` to enable console, `redirect` to redirect to events, `off` to disable console (default: `inherit`). */
+    console?: "inherit" | "redirect"
+    /** `true` or an object to enable `require` optionss (default: `false`). */
+    require?: true | VMRequire
+    /** `true` to enable VMs nesting (default: `false`). */
+    nesting?: boolean
+    /** `commonjs` (default) to wrap script into CommonJS wrapper, `none` to retrieve value returned by the script. */
+    wrapper?: "commonjs" | "none"
+  }
+
+  /**
+   * A VM with behavior more similar to running inside Node.
+   */
+  export class NodeVM {
+    constructor(options?: NodeVMOptions)
+    /** Runs the code */
+    run(js: string, path: string): any
+    /** Runs the VMScript object */
+    run(script: VMScript): any
+
+    /** Freezes the object inside VM making it read-only. Not available for primitive values. */
+    freeze(object: any, name: string): any
+    /** Protects the object inside VM making impossible to set functions as it's properties. Not available for primitive values. */
+    protect(object: any, name: string): any
+    /** Require a module in VM and return it's exports. */
+    require(module: string): any
+  }
+
+  /**
+   * VM is a simple sandbox, without `require` feature, to synchronously run an untrusted code.
+   * Only JavaScript built-in objects + Buffer are available. Scheduling functions
+   * (`setInterval`, `setTimeout` and `setImmediate`) are not available by default.
+   */
+  export class VM {
+    constructor(options?: VMOptions)
+    /** Runs the code */
+    run(js: string): any
+    /** Runs the VMScript object */
+    run(script: VMScript): any
+    /** Freezes the object inside VM making it read-only. Not available for primitive values. */
+    freeze(object: any, name: string): any
+    /** Protects the object inside VM making impossible to set functions as it's properties. Not available for primitive values */
+    protect(object: any, name: string): any
+
+    /**
+     * Create NodeVM and run code inside it.
+     *
+     * @param {String} script Javascript code.
+     * @param {String} [filename] File name (used in stack traces only).
+     * @param {Object} [options] VM options.
+     */
+    static code(script: string, filename: string, options: NodeVMOptions): NodeVM
+
+    /**
+     * Create NodeVM and run script from file inside it.
+     *
+     * @param {String} [filename] File name (used in stack traces only).
+     * @param {Object} [options] VM options.
+     */
+    static file(filename: string, options: NodeVMOptions): NodeVM
+  }
+
+  /**
+   * You can increase performance by using pre-compiled scripts.
+   * The pre-compiled VMScript can be run later multiple times. It is important to note that the code is not bound
+   * to any VM (context); rather, it is bound before each run, just for that run.
+   */
+  export class VMScript {
+    constructor(code: string, path: string)
+    /** Wraps the code */
+    wrap(prefix: string, postfix: string): VMScript
+    /** Compiles the code. If called multiple times, the code is only compiled once. */
+    compile(): any
+  }
+
+  /** Custom Error class */
+  export class VMError extends Error {}
+}