@ms-cloudpack/esm-stub-utilities 0.5.2 → 0.6.1

package/lib/browserEnvironment.cjs

@@ -0,0 +1,53 @@
+"use strict";
+// This file uses JS because it's loaded directly into the CJS sandbox environment
+// (see runInSandbox.ts)
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable etc/no-deprecated */
+const { JSDOM } = require('jsdom');
+const btoa = require('btoa');
+const atob = require('atob');
+require('jsdom-global');
+require('regenerator-runtime');
+const dom = new JSDOM();
+global.window = dom.window;
+global.window.requestAnimationFrame = dom.window.setTimeout;
+global.window.cancelAnimationFrame = dom.window.clearTimeout;
+global.btoa = btoa;
+global.atob = atob;
+global.self = dom.window;
+global.document = dom.window.document;
+global.navigator = dom.window.navigator;
+// Simulate WebSocket existence. (Needed for isomorphic-ws)
+global.WebSocket = global.window.WebSocket = /** @type {*} */ (class WebSocket {
+});
+// Fake MessageChannel so scheduler won't hang the process by opening a channel.
+global.MessageChannel = global.window.MessageChannel = class MessageChannel {
+    constructor() {
+        this.port1 = ({});
+        this.port2 = ({});
+    }
+};
+const createElement = dom.window.document.createElement.bind(dom.window.document);
+// Mock out canvas.
+global.document.createElement =
+    /** @type {*} */ (global.window).createElement =
+        /** @type {*} */ (global).createElement =
+            (/** @type {string} */ tagName, /** @type {ElementCreationOptions} */ options) => {
+                if (tagName === 'canvas') {
+                    return /** @type {*} */ ({
+                        getContext: () => ({
+                            fillRect: () => {
+                                /* no-op */
+                            },
+                        }),
+                        measureText: () => ({}),
+                    });
+                }
+                return createElement.apply(dom.window.document, [tagName, options]);
+            };
+global.window.fetch = /** @type {*} */ (async () => {
+    /* no-op */
+});
+//# sourceMappingURL=browserEnvironment.cjs.map

package/lib/browserEnvironment.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"browserEnvironment.cjs","sourceRoot":"","sources":["../src/browserEnvironment.cjs"],"names":[],"mappings":";AAAA,kFAAkF;AAClF,wBAAwB;;AAExB,4DAA4D;AAC5D,uDAAuD;AACvD,sCAAsC;AACtC,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AACnC,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAC7B,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAE7B,OAAO,CAAC,cAAc,CAAC,CAAC;AACxB,OAAO,CAAC,qBAAqB,CAAC,CAAC;AAE/B,MAAM,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;AAExB,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;AAC3B,MAAM,CAAC,MAAM,CAAC,qBAAqB,GAAG,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC;AAC5D,MAAM,CAAC,MAAM,CAAC,oBAAoB,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC;AAC7D,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;AACnB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;AACnB,MAAM,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC;AACzB,MAAM,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;AACtC,MAAM,CAAC,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC;AAExC,2DAA2D;AAC3D,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,GAAG,gBAAgB,CAAC,CAAC,MAAM,SAAS;CAAG,CAAC,CAAC;AAEnF,gFAAgF;AAChF,MAAM,CAAC,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,GAAG,MAAM,cAAc;IAApB;QACrD,UAAK,GAAoB,CAAC,EAAE,CAAC,CAAC;QAC9B,UAAK,GAAoB,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC;CAAA,CAAC;AAEF,MAAM,aAAa,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAElF,mBAAmB;AACnB,MAAM,CAAC,QAAQ,CAAC,aAAa;IAC3B,gBAAgB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa;QAC9C,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,aAAa;YACrC,CAAC,qBAAqB,CAAC,OAAO,EAAE,qCAAqC,CAAC,OAAO,EAAE,EAAE;gBAC/E,IAAI,OAAO,KAAK,QAAQ,EAAE;oBACxB,OAAO,gBAAgB,CAAC,CAAC;wBACvB,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;4BACjB,QAAQ,EAAE,GAAG,EAAE;gCACb,WAAW;4BACb,CAAC;yBACF,CAAC;wBACF,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;qBACxB,CAAC,CAAC;iBACJ;gBAED,OAAO,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;YACtE,CAAC,CAAC;AAEN,MAAM,CAAC,MAAM,CAAC,KAAK,GAAG,gBAAgB,CAAC,CACrC,KAAK,IAAI,EAAE;IACT,WAAW;AACb,CAAC,CACF,CAAC"}

package/lib/browserEnvironment.d.cts

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

package/lib/createESMStub.js

@@ -1,8 +1,7 @@
-import { slash } from '@ms-cloudpack/path-string-parsing';
 import path from 'path';
-import { initializeBrowserEnvironment } from './initializeBrowserEnvironment.js';
+import { slash } from '@ms-cloudpack/path-string-parsing';
 import { forbiddenExportNames } from './forbiddenExportNames.js';
-import { tryRequire } from './tryRequire.cjs';
+import { runInSandbox } from './runInSandbox.js';
 /**
  * Generates an ESM stub for CommonJS modules.
  * @param entryPath - The full path to the CommonJS entry file.
@@ -13,9 +12,8 @@ import { tryRequire } from './tryRequire.cjs';
 export async function createESMStub(entryPath, stubPath) {
     const result = [];
     const relativePath = './' + slash(path.relative(path.dirname(stubPath), entryPath));
-    // Try and require the entry file.
-    await initializeBrowserEnvironment();
-    const packageExport = tryRequire(entryPath);
+    // Run the entry point file in a sandbox to determine the exports
+    const packageExport = (await runInSandbox(entryPath));
     if (packageExport !== undefined) {
         const isExportObject = typeof packageExport === 'object';
         const isExportFunction = typeof packageExport === 'function';

package/lib/createESMStub.js.map

@@ -1 +1 @@
-{"version":3,"file":"createESMStub.js","sourceRoot":"","sources":["../src/createESMStub.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAC;AAC1D,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AACjF,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,SAAiB,EAAE,QAAgB;IACrE,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,MAAM,YAAY,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;IAEpF,kCAAkC;IAClC,MAAM,4BAA4B,EAAE,CAAC;IAErC,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAA4B,CAAC;IAEvE,IAAI,aAAa,KAAK,SAAS,EAAE;QAC/B,MAAM,cAAc,GAAG,OAAO,aAAa,KAAK,QAAQ,CAAC;QACzD,MAAM,gBAAgB,GAAG,OAAO,aAAa,KAAK,UAAU,CAAC;QAE7D,IAAI,gBAAgB,IAAI,CAAC,cAAc,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,EAAE;YACzE,gCAAgC;YAChC,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,oBAAoB,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YACzG,MAAM,gBAAgB,GAAG,SAAS,IAAI,aAAa,CAAC;YAEpD,IAAI,YAAY,CAAC,MAAM,IAAI,gBAAgB,EAAE;gBAC3C,MAAM,CAAC,IAAI,CAAC,UAAU,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,uBAAuB,YAAY,IAAI,CAAC,CAAC;gBAE9F,IAAI,YAAY,CAAC,MAAM,EAAE;oBACvB,MAAM,CAAC,IAAI,CAAC,WAAW,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;iBACtE;gBAED,IAAI,gBAAgB,EAAE;oBACpB,MAAM,CAAC,IAAI,CACT,oIAAoI,CACrI,CAAC;oBACF,MAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;iBAC9C;qBAAM;oBACL,MAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;iBAC9C;gBAED,IAAI,YAAY,CAAC,MAAM,EAAE;oBACvB,MAAM,CAAC,IAAI,CAAC,YAAY,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACtD;aACF;iBAAM;gBACL,sBAAsB;gBACtB,wFAAwF;gBACxF,IAAI,gBAAgB,EAAE;oBACpB,MAAM,CAAC,IAAI,CAAC,4BAA4B,YAAY,IAAI,CAAC,CAAC;iBAC3D;qBAAM;oBACL,MAAM,CAAC,IAAI,CAAC,WAAW,YAAY,IAAI,CAAC,CAAC;iBAC1C;aACF;SACF;aAAM,IAAI,OAAO,aAAa,KAAK,SAAS,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;YAClF,qBAAqB;YACrB,MAAM,CAAC,IAAI,CAAC,kBAAkB,aAAa,GAAG,CAAC,CAAC;SACjD;aAAM,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;YAC5C,qBAAqB;YACrB,MAAM,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;SACjE;aAAM;YACL,iDAAiD;YACjD,MAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;SAC9C;KACF;SAAM;QACL,uCAAuC;QACvC,MAAM,CAAC,IAAI,CAAC,WAAW,YAAY,IAAI,CAAC,CAAC;KAC1C;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC"}
+{"version":3,"file":"createESMStub.js","sourceRoot":"","sources":["../src/createESMStub.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,SAAiB,EAAE,QAAgB;IACrE,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,MAAM,YAAY,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;IAEpF,iEAAiE;IACjE,MAAM,aAAa,GAAG,CAAC,MAAM,YAAY,CAAC,SAAS,CAAC,CAA4B,CAAC;IAEjF,IAAI,aAAa,KAAK,SAAS,EAAE;QAC/B,MAAM,cAAc,GAAG,OAAO,aAAa,KAAK,QAAQ,CAAC;QACzD,MAAM,gBAAgB,GAAG,OAAO,aAAa,KAAK,UAAU,CAAC;QAE7D,IAAI,gBAAgB,IAAI,CAAC,cAAc,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,EAAE;YACzE,gCAAgC;YAChC,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,oBAAoB,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YACzG,MAAM,gBAAgB,GAAG,SAAS,IAAI,aAAa,CAAC;YAEpD,IAAI,YAAY,CAAC,MAAM,IAAI,gBAAgB,EAAE;gBAC3C,MAAM,CAAC,IAAI,CAAC,UAAU,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,uBAAuB,YAAY,IAAI,CAAC,CAAC;gBAE9F,IAAI,YAAY,CAAC,MAAM,EAAE;oBACvB,MAAM,CAAC,IAAI,CAAC,WAAW,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;iBACtE;gBAED,IAAI,gBAAgB,EAAE;oBACpB,MAAM,CAAC,IAAI,CACT,oIAAoI,CACrI,CAAC;oBACF,MAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;iBAC9C;qBAAM;oBACL,MAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;iBAC9C;gBAED,IAAI,YAAY,CAAC,MAAM,EAAE;oBACvB,MAAM,CAAC,IAAI,CAAC,YAAY,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACtD;aACF;iBAAM;gBACL,sBAAsB;gBACtB,wFAAwF;gBACxF,IAAI,gBAAgB,EAAE;oBACpB,MAAM,CAAC,IAAI,CAAC,4BAA4B,YAAY,IAAI,CAAC,CAAC;iBAC3D;qBAAM;oBACL,MAAM,CAAC,IAAI,CAAC,WAAW,YAAY,IAAI,CAAC,CAAC;iBAC1C;aACF;SACF;aAAM,IAAI,OAAO,aAAa,KAAK,SAAS,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;YAClF,qBAAqB;YACrB,MAAM,CAAC,IAAI,CAAC,kBAAkB,aAAa,GAAG,CAAC,CAAC;SACjD;aAAM,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;YAC5C,qBAAqB;YACrB,MAAM,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;SACjE;aAAM;YACL,iDAAiD;YACjD,MAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;SAC9C;KACF;SAAM;QACL,uCAAuC;QACvC,MAAM,CAAC,IAAI,CAAC,WAAW,YAAY,IAAI,CAAC,CAAC;KAC1C;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC"}

package/lib/runInSandbox.d.ts

@@ -0,0 +1,11 @@
+import { NodeVM } from 'vm2';
+/** Reset `vms` and `sandboxRoots` for testing */
+export declare function _clearSandboxCaches(): void;
+/** Get `vms` state for testing */
+export declare function _getSandboxVms(): Record<string, NodeVM>;
+/**
+ * Run a CommonJS file within a sandboxed environment.
+ * @param entryPath - Path to a CommonJS file to run in a sandbox (does not work with ESM files)
+ * @returns The module's exports
+ */
+export declare function runInSandbox(entryPath: string): Promise<unknown>;

package/lib/runInSandbox.js

@@ -0,0 +1,172 @@
+import fs from 'fs';
+import path from 'path';
+import { builtinModules } from 'module';
+import { fileURLToPath } from 'url';
+import { NodeVM, VMError } from 'vm2';
+import { findPackageRoot } from '@ms-cloudpack/path-utilities';
+const filename = fileURLToPath(import.meta.url);
+const dirname = path.dirname(filename);
+const browserEnvSetup = path.join(dirname, 'browserEnvironment.cjs');
+/** Allow the sandbox to load these built-in modules */
+// ('events' and 'stream' export classes which other things extend and can't be proxied)
+const allowedBuiltins = ['events', 'path', 'stream', 'url', 'util'];
+/** Built-in modules provided by vm2 */
+const includedBuiltins = ['buffer'];
+/** Empty mocks of all built-in modules that aren't allowed (to ensure that requires succeed) */
+const mockBuiltins = Object.fromEntries(builtinModules.filter((m) => !allowedBuiltins.includes(m) && !includedBuiltins.includes(m)).map((m) => [m, {}]));
+/** Mapping from sandbox root to VM */
+const vms = {};
+/** Mapping from directory to sandbox root */
+const sandboxRoots = {};
+/** Sandbox root for this file and other cloudpack-related files */
+let cloudpackSandboxRoot = '';
+/** Reset `vms` and `sandboxRoots` for testing */
+export function _clearSandboxCaches() {
+    Object.keys(vms).forEach((k) => delete vms[k]);
+    Object.keys(sandboxRoots).forEach((k) => delete sandboxRoots[k]);
+}
+/** Get `vms` state for testing */
+export function _getSandboxVms() {
+    return vms;
+}
+/**
+ * Try to figure out a root directory where the sandbox should be allowed to require files from.
+ * This prefers the git root if found, falling back to package root or parent directory.
+ *
+ * (This is very likely overly permissive and might be good to restrict in the future.)
+ */
+function findSandboxRoot(filePath) {
+    const root = path.parse(filePath).root;
+    let dir = path.dirname(filePath);
+    if (!sandboxRoots[dir]) {
+        // try to find a git root first
+        while (dir !== root && !fs.existsSync(path.join(dir, '.git'))) {
+            dir = path.dirname(dir);
+        }
+        if (dir === root) {
+            // fallback: package root
+            dir = findPackageRoot(filePath);
+            if (!dir) {
+                // final fallback: parent directory
+                dir = path.dirname(filePath);
+            }
+        }
+        sandboxRoots[dir] = dir;
+    }
+    return sandboxRoots[dir];
+}
+function handleError(action, err, sandboxRoot) {
+    const message = err.message || String(err);
+    const stack = err.stack?.split(/\r?\n/g) || [];
+    // instanceof checks don't work with errors from code run within the sandbox, but name is preserved
+    const errorName = err.name;
+    const newMessage = [`Error ${action}:`, message];
+    if (stack.length && err instanceof VMError && err.message.includes('Cannot find module')) {
+        newMessage.push('', 'Ensure that this file exists on disk. If it exists, this may be a bug with the choice of `root` ' +
+            '(allowed parent directories) settings in @ms-cloudpack/esm-stub-utilities runInSandbox.', `- Root for file being stubbed: ${sandboxRoot}`, `- Root for cloudpack files: ${cloudpackSandboxRoot}`);
+        // Find the actual line which caused the error
+        const errorLines = stack.filter((line) => line.trim().startsWith('at') && !line.includes('vm2'));
+        if (errorLines.length) {
+            newMessage.push('', 'Code that may have required this module:', ...errorLines);
+        }
+    }
+    else if (errorName === 'TypeError') {
+        newMessage.push('', 'If the code was referencing a built-in global or a property of a Node built-in module, ' +
+            'this error may be caused by a missing mock or other issue with the sandbox environment ' +
+            'configured in @ms-cloudpack/esm-stub-utilities runInSandbox.');
+    }
+    else if (errorName === 'SyntaxError' &&
+        (/Unexpected token '(import|export)'/.test(message) ||
+            message.includes(`'import' and 'export' may appear only with`))) {
+        newMessage.push('', "It appears you're trying to load an ES module, which is not currently supported in the sandbox. " +
+            'If this module is loaded at startup within a CommonJS file, please file an issue with cloudpack. ');
+    }
+    if (stack.length) {
+        newMessage.push('', 'Original stack:', ...stack.slice(1));
+    }
+    throw new Error(newMessage.join('\n'));
+}
+/**
+ * Run a CommonJS file within a sandboxed environment.
+ * @param entryPath - Path to a CommonJS file to run in a sandbox (does not work with ESM files)
+ * @returns The module's exports
+ */
+// eslint-disable-next-line @typescript-eslint/require-await -- using async to catch async errors
+export async function runInSandbox(entryPath) {
+    if (!path.isAbsolute(entryPath)) {
+        throw new Error('Entry path must be absolute. Received: ' + entryPath);
+    }
+    if (!fs.existsSync(entryPath)) {
+        throw new Error('Entry path does not exist: ' + entryPath);
+    }
+    // Allow code in the sandbox to require files under the requested file's package root,
+    // or under its directory if it's not in a package.
+    const sandboxRoot = findSandboxRoot(entryPath);
+    if (!vms[sandboxRoot]) {
+        if (!cloudpackSandboxRoot) {
+            cloudpackSandboxRoot = findSandboxRoot(filename);
+        }
+        console.log('esm-stub-utilities: Creating sandbox for ' + sandboxRoot);
+        try {
+            vms[sandboxRoot] = new NodeVM({
+                // disable console logging instead of passing through to the host console
+                console: 'off',
+                // look for these import extensions (mjs is not included because this doesn't support loading ESM)
+                sourceExtensions: ['js', 'cjs'],
+                // use a commonjs module wrapper
+                wrapper: 'commonjs',
+                require: {
+                    // allow local and dependency modules to be required under here
+                    root: [cloudpackSandboxRoot, sandboxRoot],
+                    // load, compile, and require modules in the sandbox (instead of requiring in the host)
+                    context: 'sandbox',
+                    // allowed built-in modules
+                    builtin: allowedBuiltins,
+                    // allow loading "external" modules under the given roots
+                    external: true,
+                    // simulate the browser at startup (can throw errors)
+                    import: [browserEnvSetup],
+                    // mock these modules so they can be successfully required
+                    mock: {
+                        ...mockBuiltins,
+                        // some modules reference these built-ins during their setup
+                        perf_hooks: {
+                            performance: { now: () => Date.now() },
+                        },
+                        vm: {
+                            isContext: () => false,
+                        },
+                    },
+                },
+                sandbox: {
+                    // these are normally available in the global context (and are referenced by some modules)
+                    // but for some reason are not passed through by vm2
+                    TextEncoder,
+                    TextDecoder,
+                },
+                env: {
+                    // prevent debug from accessing process.stderr
+                    DEBUG_COLORS: 0,
+                },
+            });
+        }
+        catch (err) {
+            handleError(`initializing sandbox for ${sandboxRoot} (to create stub of ${entryPath})`, err, sandboxRoot);
+        }
+    }
+    const onError = (err) => {
+        handleError(`running ${entryPath} in sandbox (to create stub)`, err, sandboxRoot);
+    };
+    process.on('uncaughtException', onError);
+    try {
+        const cjsFile = fs.readFileSync(entryPath, 'utf8');
+        return vms[sandboxRoot].run(cjsFile, { filename: entryPath });
+    }
+    catch (err) {
+        onError(err);
+    }
+    finally {
+        process.off('uncaughtException', onError);
+    }
+}
+//# sourceMappingURL=runInSandbox.js.map

package/lib/runInSandbox.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runInSandbox.js","sourceRoot":"","sources":["../src/runInSandbox.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE/D,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAChD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AACvC,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAC;AAErE,uDAAuD;AACvD,wFAAwF;AACxF,MAAM,eAAe,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AACpE,uCAAuC;AACvC,MAAM,gBAAgB,GAAG,CAAC,QAAQ,CAAC,CAAC;AACpC,gGAAgG;AAChG,MAAM,YAAY,GAAG,MAAM,CAAC,WAAW,CACrC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAChH,CAAC;AAEF,sCAAsC;AACtC,MAAM,GAAG,GAA2B,EAAE,CAAC;AAEvC,6CAA6C;AAC7C,MAAM,YAAY,GAA2B,EAAE,CAAC;AAChD,mEAAmE;AACnE,IAAI,oBAAoB,GAAG,EAAE,CAAC;AAE9B,iDAAiD;AACjD,MAAM,UAAU,mBAAmB;IACjC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/C,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;AACnE,CAAC;AAED,kCAAkC;AAClC,MAAM,UAAU,cAAc;IAC5B,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;GAKG;AACH,SAAS,eAAe,CAAC,QAAgB;IACvC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;IACvC,IAAI,GAAG,GAAuB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAErD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;QACtB,+BAA+B;QAC/B,OAAO,GAAG,KAAK,IAAI,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE;YAC7D,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;SACzB;QAED,IAAI,GAAG,KAAK,IAAI,EAAE;YAChB,yBAAyB;YACzB,GAAG,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;YAChC,IAAI,CAAC,GAAG,EAAE;gBACR,mCAAmC;gBACnC,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;aAC9B;SACF;QAED,YAAY,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;KACzB;IAED,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC;AAC3B,CAAC;AAED,SAAS,WAAW,CAAC,MAAc,EAAE,GAAY,EAAE,WAAmB;IACpE,MAAM,OAAO,GAAI,GAAa,CAAC,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC;IACtD,MAAM,KAAK,GAAI,GAAa,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC1D,mGAAmG;IACnG,MAAM,SAAS,GAAI,GAAa,CAAC,IAAI,CAAC;IAEtC,MAAM,UAAU,GAAG,CAAC,SAAS,MAAM,GAAG,EAAE,OAAO,CAAC,CAAC;IAEjD,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG,YAAY,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAAE;QACxF,UAAU,CAAC,IAAI,CACb,EAAE,EACF,kGAAkG;YAChG,yFAAyF,EAC3F,kCAAkC,WAAW,EAAE,EAC/C,+BAA+B,oBAAoB,EAAE,CACtD,CAAC;QAEF,8CAA8C;QAC9C,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QACjG,IAAI,UAAU,CAAC,MAAM,EAAE;YACrB,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,0CAA0C,EAAE,GAAG,UAAU,CAAC,CAAC;SAChF;KACF;SAAM,IAAI,SAAS,KAAK,WAAW,EAAE;QACpC,UAAU,CAAC,IAAI,CACb,EAAE,EACF,yFAAyF;YACvF,yFAAyF;YACzF,8DAA8D,CACjE,CAAC;KACH;SAAM,IACL,SAAS,KAAK,aAAa;QAC3B,CAAC,oCAAoC,CAAC,IAAI,CAAC,OAAO,CAAC;YACjD,OAAO,CAAC,QAAQ,CAAC,4CAA4C,CAAC,CAAC,EACjE;QACA,UAAU,CAAC,IAAI,CACb,EAAE,EACF,kGAAkG;YAChG,mGAAmG,CACtG,CAAC;KACH;IAED,IAAI,KAAK,CAAC,MAAM,EAAE;QAChB,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,iBAAiB,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;KAC3D;IAED,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACzC,CAAC;AAED;;;;GAIG;AACH,iGAAiG;AACjG,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,SAAiB;IAClD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,yCAAyC,GAAG,SAAS,CAAC,CAAC;KACxE;IAED,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,6BAA6B,GAAG,SAAS,CAAC,CAAC;KAC5D;IAED,sFAAsF;IACtF,mDAAmD;IACnD,MAAM,WAAW,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;IAE/C,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;QACrB,IAAI,CAAC,oBAAoB,EAAE;YACzB,oBAAoB,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;SAClD;QACD,OAAO,CAAC,GAAG,CAAC,2CAA2C,GAAG,WAAW,CAAC,CAAC;QACvE,IAAI;YACF,GAAG,CAAC,WAAW,CAAC,GAAG,IAAI,MAAM,CAAC;gBAC5B,yEAAyE;gBACzE,OAAO,EAAE,KAAK;gBACd,kGAAkG;gBAClG,gBAAgB,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC;gBAC/B,gCAAgC;gBAChC,OAAO,EAAE,UAAU;gBACnB,OAAO,EAAE;oBACP,+DAA+D;oBAC/D,IAAI,EAAE,CAAC,oBAAoB,EAAE,WAAW,CAAC;oBACzC,uFAAuF;oBACvF,OAAO,EAAE,SAAS;oBAClB,2BAA2B;oBAC3B,OAAO,EAAE,eAAe;oBACxB,yDAAyD;oBACzD,QAAQ,EAAE,IAAI;oBACd,qDAAqD;oBACrD,MAAM,EAAE,CAAC,eAAe,CAAC;oBACzB,0DAA0D;oBAC1D,IAAI,EAAE;wBACJ,GAAG,YAAY;wBACf,4DAA4D;wBAC5D,UAAU,EAAE;4BACV,WAAW,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE;yBACvC;wBACD,EAAE,EAAE;4BACF,SAAS,EAAE,GAAG,EAAE,CAAC,KAAK;yBACvB;qBACF;iBACF;gBACD,OAAO,EAAE;oBACP,0FAA0F;oBAC1F,oDAAoD;oBACpD,WAAW;oBACX,WAAW;iBACZ;gBACD,GAAG,EAAE;oBACH,8CAA8C;oBAC9C,YAAY,EAAE,CAAC;iBAChB;aACF,CAAC,CAAC;SACJ;QAAC,OAAO,GAAG,EAAE;YACZ,WAAW,CAAC,4BAA4B,WAAW,uBAAuB,SAAS,GAAG,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;SAC3G;KACF;IAED,MAAM,OAAO,GAAG,CAAC,GAAY,EAAE,EAAE;QAC/B,WAAW,CAAC,WAAW,SAAS,8BAA8B,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;IACpF,CAAC,CAAC;IACF,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IAEzC,IAAI;QACF,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QACnD,OAAO,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAY,CAAC;KAC1E;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,CAAC,GAAG,CAAC,CAAC;KACd;YAAS;QACR,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;KAC3C;AACH,CAAC"}

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.34.2"
+      "packageVersion": "7.34.3"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/esm-stub-utilities",
-  "version": "0.5.2",
+  "version": "0.6.1",
   "description": "Generates ESM stubs for CommonJS entry files.",
   "license": "MIT",
   "type": "module",
@@ -13,13 +13,14 @@
     }
   },
   "dependencies": {
-    "@ms-cloudpack/path-utilities": "^2.1.0",
+    "@ms-cloudpack/path-utilities": "^2.1.1",
     "@ms-cloudpack/path-string-parsing": "^1.0.1",
     "atob": "^2.1.2",
     "btoa": "^1.2.1",
     "jsdom-global": "^3.0.2",
     "jsdom": "^21.1.0",
-    "regenerator-runtime": "^0.13.9"
+    "regenerator-runtime": "^0.13.9",
+    "vm2": "^3.9.13"
   },
   "devDependencies": {
     "@ms-cloudpack/eslint-config-base": "*",

package/lib/initializeBrowserEnvironment.d.ts

@@ -1,4 +0,0 @@
-/**
- * Initializes a browser environment (e.g. by setting up the global `window` in a node environment).
- */
-export declare function initializeBrowserEnvironment(): Promise<void>;

package/lib/initializeBrowserEnvironment.js

@@ -1,67 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-call */
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable @typescript-eslint/no-unsafe-return */
-let hasInitialized = false;
-/**
- * Initializes a browser environment (e.g. by setting up the global `window` in a node environment).
- */
-export async function initializeBrowserEnvironment() {
-    if (!hasInitialized) {
-        hasInitialized = true;
-        if (typeof window === 'undefined' && typeof global !== 'undefined') {
-            const { JSDOM } = await import('jsdom');
-            const btoa = await import('btoa');
-            const atob = await import('atob');
-            await import('jsdom-global');
-            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-            // @ts-ignore
-            await import('regenerator-runtime');
-            const dom = new JSDOM();
-            const globalThis = global;
-            globalThis.window = dom.window;
-            globalThis.window.requestAnimationFrame = dom.window.setTimeout;
-            globalThis.window.cancelAnimationFrame = dom.window.clearTimeout;
-            globalThis.btoa = btoa;
-            globalThis.atob = atob;
-            globalThis.self = dom.window;
-            globalThis.document = dom.window.document;
-            globalThis.navigator = dom.window.navigator;
-            // Simulate WebSocket existence. (Needed for isomorphic-ws)
-            globalThis.WebSocket = globalThis.window.WebSocket = function () {
-                /* noop */
-            };
-            // Fake MessageChannel so scheduler won't hang the process by opening a channel.
-            globalThis.MessageChannel = globalThis.window.MessageChannel = class MessageChannel {
-                constructor() {
-                    this.port1 = {};
-                    this.port2 = {};
-                }
-            };
-            // eslint-disable-next-line etc/no-deprecated
-            const createElement = dom.window.document.createElement.bind(dom.window.document);
-            // Mock out canvas.
-            globalThis.document.createElement =
-                globalThis.window.createElement =
-                    globalThis.createElement =
-                        (tagName, ...args) => {
-                            if (tagName === 'canvas') {
-                                return {
-                                    getContext: () => ({
-                                        fillRect: () => {
-                                            /* no-op */
-                                        },
-                                    }),
-                                    measureText: () => ({}),
-                                };
-                            }
-                            return createElement.apply(dom.window.document, [tagName, ...args]);
-                        };
-            globalThis.window.fetch = async () => {
-                /* no-op */
-            };
-        }
-    }
-}
-//# sourceMappingURL=initializeBrowserEnvironment.js.map

package/lib/initializeBrowserEnvironment.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"initializeBrowserEnvironment.js","sourceRoot":"","sources":["../src/initializeBrowserEnvironment.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,4DAA4D;AAC5D,sDAAsD;AACtD,+DAA+D;AAC/D,wDAAwD;AACxD,IAAI,cAAc,GAAG,KAAK,CAAC;AAE3B;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B;IAChD,IAAI,CAAC,cAAc,EAAE;QACnB,cAAc,GAAG,IAAI,CAAC;QACtB,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;YAClE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC;YACxC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC;YAClC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC;YAElC,MAAM,MAAM,CAAC,cAAc,CAAC,CAAC;YAE7B,6DAA6D;YAC7D,aAAa;YACb,MAAM,MAAM,CAAC,qBAAqB,CAAC,CAAC;YAEpC,MAAM,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;YACxB,MAAM,UAAU,GAAG,MAAa,CAAC;YAEjC,UAAU,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;YAC/B,UAAU,CAAC,MAAM,CAAC,qBAAqB,GAAG,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC;YAChE,UAAU,CAAC,MAAM,CAAC,oBAAoB,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC;YACjE,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC;YACvB,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC;YACvB,UAAU,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC;YAC7B,UAAU,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;YAC1C,UAAU,CAAC,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC;YAE5C,2DAA2D;YAC3D,UAAU,CAAC,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,GAAG;gBACnD,UAAU;YACZ,CAAC,CAAC;YAEF,gFAAgF;YAChF,UAAU,CAAC,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,GAAG,MAAM,cAAc;gBAApB;oBAC7D,UAAK,GAAG,EAAE,CAAC;oBACX,UAAK,GAAG,EAAE,CAAC;gBACb,CAAC;aAAA,CAAC;YAEF,6CAA6C;YAC7C,MAAM,aAAa,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAElF,mBAAmB;YACnB,UAAU,CAAC,QAAQ,CAAC,aAAa;gBAC/B,UAAU,CAAC,MAAM,CAAC,aAAa;oBAC/B,UAAU,CAAC,aAAa;wBACtB,CAAC,OAAe,EAAE,GAAG,IAAW,EAAE,EAAE;4BAClC,IAAI,OAAO,KAAK,QAAQ,EAAE;gCACxB,OAAO;oCACL,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;wCACjB,QAAQ,EAAE,GAAG,EAAE;4CACb,WAAW;wCACb,CAAC;qCACF,CAAC;oCACF,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;iCACxB,CAAC;6BACH;4BAED,OAAQ,aAAqB,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;wBAC/E,CAAC,CAAC;YAEN,UAAU,CAAC,MAAM,CAAC,KAAK,GAAG,KAAK,IAAI,EAAE;gBACnC,WAAW;YACb,CAAC,CAAC;SACH;KACF;AACH,CAAC"}

package/lib/tryRequire.cjs

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Requires a CommonJS entry file. We need to call require to ensure the cjs module is
- * parsed and we aren't redirected to an esm via exports maps.
- */
-module.exports = {
-    /** @param {string} modulePath */
-    tryRequire(modulePath) {
-        return /** @type {unknown} */ (require(modulePath));
-    },
-};
-//# sourceMappingURL=tryRequire.cjs.map

package/lib/tryRequire.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"tryRequire.cjs","sourceRoot":"","sources":["../src/tryRequire.cjs"],"names":[],"mappings":";;AAAA;;;GAGG;AACH,MAAM,CAAC,OAAO,GAAG;IACf,iCAAiC;IACjC,UAAU,CAAC,UAAU;QACnB,OAAO,sBAAsB,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;IACtD,CAAC;CACF,CAAC"}

package/lib/tryRequire.d.cts

@@ -1,2 +0,0 @@
-/** @param {string} modulePath */
-export function tryRequire(modulePath: string): unknown;