@ms-cloudpack/esm-stub-utilities 0.6.25 → 0.7.0

package/lib/worker/initBrowserEnvironment.js

@@ -0,0 +1,67 @@
+// See worker.js for why this is a JS file.
+import btoa from 'btoa';
+import atob from 'atob';
+import { performance } from 'perf_hooks';
+import util from 'util';
+/**
+ * Initialize a fake browser environment.
+ */
+export async function initBrowserEnvironment() {
+    // These must be set up before JSDOM
+    !global.performance && (global.performance = /** @type {*} */ (performance));
+    !global.TextEncoder && (global.TextEncoder = util.TextEncoder);
+    !global.TextDecoder && (global.TextDecoder = /** @type {*} */ (util.TextDecoder));
+    (await import('jsdom-global')).default();
+    await import('regenerator-runtime');
+    // Ensure assigning to and reading from `window.foo` globals works as expected by copying all the
+    // properties from the jsdom `window` to node's `global`, then assigning `global` to `window`.
+    Object.entries(Object.getOwnPropertyDescriptors(window)).forEach(([k, desc]) => {
+        // Skip storage to avoid errors "localStorage is not available for opaque origins"
+        // (these errors could in theory be resolved by passing a URL to jsdom-global setup, but that
+        // triggers some weird issues with whatwg-url using TextDecoder in a way that works in other
+        // environments but throws in the sandbox)
+        if (!(k in global) && !['localStorage', 'sessionStorage'].includes(k)) {
+            Object.defineProperty(global, k, desc);
+        }
+    });
+    /** @type {*} */ (global).window = global;
+    /** @type {*} */ (global).self = global;
+    /** @type {*} */ (document).window = global;
+    window.requestAnimationFrame = window.setTimeout;
+    window.cancelAnimationFrame = window.clearTimeout;
+    global.btoa = btoa;
+    global.atob = atob;
+    // Simulate WebSocket existence. (Needed for isomorphic-ws)
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    global.WebSocket = window.WebSocket = /** @type {*} */ (class WebSocket {
+    });
+    // Fake MessageChannel so scheduler won't hang the process by opening a channel.
+    global.MessageChannel = window.MessageChannel = class MessageChannel {
+        constructor() {
+            this.port1 = ({});
+            this.port2 = ({});
+        }
+    };
+    // eslint-disable-next-line etc/no-deprecated
+    const createElement = window.document.createElement.bind(window.document);
+    // Mock out canvas.
+    // eslint-disable-next-line etc/no-deprecated
+    global.document.createElement =
+        /** @type {*} */ (window).createElement =
+            /** @type {*} */ (global).createElement =
+                (/** @type {string} */ tagName, /** @type {ElementCreationOptions} */ options) => {
+                    if (tagName === 'canvas') {
+                        return /** @type {*} */ ({
+                            getContext: () => ({
+                                fillRect: () => { },
+                            }),
+                            measureText: () => ({}),
+                        });
+                    }
+                    return createElement.apply(window.document, [tagName, options]);
+                };
+    window.fetch = /** @type {*} */ (async () => { });
+    // prevent 'debug' package from accessing process.stderr
+    process.env.DEBUG_COLORS = '0';
+}
+//# sourceMappingURL=initBrowserEnvironment.js.map

package/lib/worker/initBrowserEnvironment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initBrowserEnvironment.js","sourceRoot":"","sources":["../../src/worker/initBrowserEnvironment.js"],"names":[],"mappings":"AAAA,2CAA2C;AAE3C,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB;IAC1C,oCAAoC;IACpC,CAAC,MAAM,CAAC,WAAW,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,gBAAgB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;IAC7E,CAAC,MAAM,CAAC,WAAW,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;IAC/D,CAAC,MAAM,CAAC,WAAW,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,gBAAgB,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAElF,CAAC,MAAM,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAEzC,MAAM,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAEpC,iGAAiG;IACjG,8FAA8F;IAC9F,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE;QAC7E,kFAAkF;QAClF,6FAA6F;QAC7F,4FAA4F;QAC5F,0CAA0C;QAC1C,IAAI,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;YACrE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;SACxC;IACH,CAAC,CAAC,CAAC;IACH,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC;IAC1C,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,GAAG,MAAM,CAAC;IACxC,gBAAgB,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC;IAE5C,MAAM,CAAC,qBAAqB,GAAG,MAAM,CAAC,UAAU,CAAC;IACjD,MAAM,CAAC,oBAAoB,GAAG,MAAM,CAAC,YAAY,CAAC;IAClD,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;IAEnB,2DAA2D;IAC3D,mEAAmE;IACnE,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,GAAG,gBAAgB,CAAC,CAAC,MAAM,SAAS;KAAG,CAAC,CAAC;IAE5E,gFAAgF;IAChF,MAAM,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,GAAG,MAAM,cAAc;QAApB;YAC9C,UAAK,GAAoB,CAAC,EAAE,CAAC,CAAC;YAC9B,UAAK,GAAoB,CAAC,EAAE,CAAC,CAAC;QAChC,CAAC;KAAA,CAAC;IAEF,6CAA6C;IAC7C,MAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAE1E,mBAAmB;IACnB,6CAA6C;IAC7C,MAAM,CAAC,QAAQ,CAAC,aAAa;QAC3B,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,aAAa;YACvC,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,aAAa;gBACrC,CAAC,qBAAqB,CAAC,OAAO,EAAE,qCAAqC,CAAC,OAAO,EAAE,EAAE;oBAC/E,IAAI,OAAO,KAAK,QAAQ,EAAE;wBACxB,OAAO,gBAAgB,CAAC,CAAC;4BACvB,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;gCACjB,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC;6BACnB,CAAC;4BACF,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;yBACxB,CAAC,CAAC;qBACJ;oBAED,OAAO,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;gBAClE,CAAC,CAAC;IAEN,MAAM,CAAC,KAAK,GAAG,gBAAgB,CAAC,CAAC,KAAK,IAAI,EAAE,GAAE,CAAC,CAAC,CAAC;IAEjD,wDAAwD;IACxD,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,GAAG,CAAC;AACjC,CAAC","sourcesContent":["// See worker.js for why this is a JS file.\n\nimport btoa from 'btoa';\nimport atob from 'atob';\nimport { performance } from 'perf_hooks';\nimport util from 'util';\n\n/**\n * Initialize a fake browser environment.\n */\nexport async function initBrowserEnvironment() {\n  // These must be set up before JSDOM\n  !global.performance && (global.performance = /** @type {*} */ (performance));\n  !global.TextEncoder && (global.TextEncoder = util.TextEncoder);\n  !global.TextDecoder && (global.TextDecoder = /** @type {*} */ (util.TextDecoder));\n\n  (await import('jsdom-global')).default();\n\n  await import('regenerator-runtime');\n\n  // Ensure assigning to and reading from `window.foo` globals works as expected by copying all the\n  // properties from the jsdom `window` to node's `global`, then assigning `global` to `window`.\n  Object.entries(Object.getOwnPropertyDescriptors(window)).forEach(([k, desc]) => {\n    // Skip storage to avoid errors \"localStorage is not available for opaque origins\"\n    // (these errors could in theory be resolved by passing a URL to jsdom-global setup, but that\n    // triggers some weird issues with whatwg-url using TextDecoder in a way that works in other\n    // environments but throws in the sandbox)\n    if (!(k in global) && !['localStorage', 'sessionStorage'].includes(k)) {\n      Object.defineProperty(global, k, desc);\n    }\n  });\n  /** @type {*} */ (global).window = global;\n  /** @type {*} */ (global).self = global;\n  /** @type {*} */ (document).window = global;\n\n  window.requestAnimationFrame = window.setTimeout;\n  window.cancelAnimationFrame = window.clearTimeout;\n  global.btoa = btoa;\n  global.atob = atob;\n\n  // Simulate WebSocket existence. (Needed for isomorphic-ws)\n  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n  global.WebSocket = window.WebSocket = /** @type {*} */ (class WebSocket {});\n\n  // Fake MessageChannel so scheduler won't hang the process by opening a channel.\n  global.MessageChannel = window.MessageChannel = class MessageChannel {\n    port1 = /** @type {*} */ ({});\n    port2 = /** @type {*} */ ({});\n  };\n\n  // eslint-disable-next-line etc/no-deprecated\n  const createElement = window.document.createElement.bind(window.document);\n\n  // Mock out canvas.\n  // eslint-disable-next-line etc/no-deprecated\n  global.document.createElement =\n    /** @type {*} */ (window).createElement =\n    /** @type {*} */ (global).createElement =\n      (/** @type {string} */ tagName, /** @type {ElementCreationOptions} */ options) => {\n        if (tagName === 'canvas') {\n          return /** @type {*} */ ({\n            getContext: () => ({\n              fillRect: () => {},\n            }),\n            measureText: () => ({}),\n          });\n        }\n\n        return createElement.apply(window.document, [tagName, options]);\n      };\n\n  window.fetch = /** @type {*} */ (async () => {});\n\n  // prevent 'debug' package from accessing process.stderr\n  process.env.DEBUG_COLORS = '0';\n}\n"]}

package/lib/worker/worker.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=worker.d.ts.map

package/lib/worker/worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker.d.ts","sourceRoot":"","sources":["../../src/worker/worker.js"],"names":[],"mappings":""}

package/lib/worker/worker.js

@@ -0,0 +1,85 @@
+// These files use JS because they're loaded directly into a worker (see runInSandbox.ts),
+// which must work both during tests (where the files are loaded from "src") and at runtime.
+// They can still be type checked like TS, and the transpilation step doesn't do anything that
+// should change the desired runtime behavior.
+import { createRequire } from 'module';
+import { isMainThread, parentPort } from 'worker_threads';
+import { initBrowserEnvironment } from './initBrowserEnvironment.js';
+import { cleanUpGlobals, getGlobalProperties } from './globals.js';
+if (isMainThread || !parentPort) {
+    throw new Error('This file should only be loaded in a worker thread');
+}
+const require = createRequire(import.meta.url);
+await initBrowserEnvironment();
+// TODO should the globals be marked as readonly if possible?
+const initialGlobalProperties = getGlobalProperties();
+/**
+ * Type helper for sending messages to the parent.
+ * @param {import('../types/SandboxWorkerResponse.js').SandboxWorkerResponse} message
+ */
+function emitMessage(message) {
+    parentPort?.postMessage(message);
+}
+parentPort.on('message', (/** @type {string} */ entryPath) => {
+    if (typeof entryPath !== 'string') {
+        emitMessage({
+            error: { message: `Expected message to be a string; received: ${JSON.stringify(entryPath)}` },
+            entryPath: '',
+        });
+        return;
+    }
+    function onExit() {
+        // In this case, throw an error rather than sending a message to avoid handling it twice.
+        // Don't include the filename since that's potentially ambiguous (and redundant with info
+        // included by the runInSandbox error handler).
+        throw new Error('process.exit() was unexpectedly called');
+    }
+    process.on('exit', onExit);
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        const moduleExports = require(entryPath);
+        emitMessage({
+            entryPath,
+            exportInfo: getExportInfo(moduleExports),
+        });
+    }
+    catch (e) {
+        // Some errors running a module have a string `code` property.
+        // MODULE_NOT_FOUND errors have a `requireStack` property with a list of paths
+        // (right now we're using the call stack instead, but we could reconsider depending on
+        // which one seems more useful in practice).
+        const err = /** @type {Error & { code?: string; requireStack?: string[] }} */ (e);
+        emitMessage({
+            entryPath,
+            // Spreading doesn't work with errors, so copy manually
+            error: {
+                message: String(err),
+                name: err.name,
+                code: err.code,
+                stack: err.stack,
+            },
+        });
+    }
+    finally {
+        cleanUpGlobals(initialGlobalProperties);
+        process.off('exit', onExit);
+    }
+});
+/**
+ * Get information about a CJS module's exports, for purposes of creating a stub.
+ * @param {unknown} moduleExport The module's exports.
+ * @returns {import('../types/StubExportInfo.js').StubExportInfo}
+ */
+function getExportInfo(moduleExport) {
+    if (moduleExport === undefined) {
+        return { type: 'none' };
+    }
+    if (typeof moduleExport === 'function') {
+        return { type: 'function', keys: Object.keys(moduleExport) };
+    }
+    if (moduleExport && typeof moduleExport === 'object' && !Array.isArray(moduleExport)) {
+        return { type: 'object', keys: Object.keys(moduleExport) };
+    }
+    return { type: 'other' };
+}
+//# sourceMappingURL=worker.js.map

package/lib/worker/worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker.js","sourceRoot":"","sources":["../../src/worker/worker.js"],"names":[],"mappings":"AAAA,0FAA0F;AAC1F,4FAA4F;AAC5F,8FAA8F;AAC9F,8CAA8C;AAE9C,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnE,IAAI,YAAY,IAAI,CAAC,UAAU,EAAE;IAC/B,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;CACvE;AAED,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAE/C,MAAM,sBAAsB,EAAE,CAAC;AAC/B,6DAA6D;AAC7D,MAAM,uBAAuB,GAAG,mBAAmB,EAAE,CAAC;AAEtD;;;GAGG;AACH,SAAS,WAAW,CAAC,OAAO;IAC1B,UAAU,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC;AAED,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,qBAAqB,CAAC,SAAS,EAAE,EAAE;IAC3D,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;QACjC,WAAW,CAAC;YACV,KAAK,EAAE,EAAE,OAAO,EAAE,8CAA8C,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE;YAC7F,SAAS,EAAE,EAAE;SACd,CAAC,CAAC;QACH,OAAO;KACR;IAED,SAAS,MAAM;QACb,yFAAyF;QACzF,yFAAyF;QACzF,+CAA+C;QAC/C,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE3B,IAAI;QACF,mEAAmE;QACnE,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;QACzC,WAAW,CAAC;YACV,SAAS;YACT,UAAU,EAAE,aAAa,CAAC,aAAa,CAAC;SACzC,CAAC,CAAC;KACJ;IAAC,OAAO,CAAC,EAAE;QACV,8DAA8D;QAC9D,8EAA8E;QAC9E,sFAAsF;QACtF,4CAA4C;QAC5C,MAAM,GAAG,GAAG,iEAAiE,CAAC,CAAC,CAAC,CAAC,CAAC;QAClF,WAAW,CAAC;YACV,SAAS;YACT,uDAAuD;YACvD,KAAK,EAAE;gBACL,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC;gBACpB,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,KAAK,EAAE,GAAG,CAAC,KAAK;aACjB;SACF,CAAC,CAAC;KACJ;YAAS;QACR,cAAc,CAAC,uBAAuB,CAAC,CAAC;QACxC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAC7B;AACH,CAAC,CAAC,CAAC;AAEH;;;;GAIG;AACH,SAAS,aAAa,CAAC,YAAY;IACjC,IAAI,YAAY,KAAK,SAAS,EAAE;QAC9B,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;KACzB;IAED,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE;QACtC,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;KAC9D;IAED,IAAI,YAAY,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;QACpF,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;KAC5D;IAED,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAC3B,CAAC","sourcesContent":["// These files use JS because they're loaded directly into a worker (see runInSandbox.ts),\n// which must work both during tests (where the files are loaded from \"src\") and at runtime.\n// They can still be type checked like TS, and the transpilation step doesn't do anything that\n// should change the desired runtime behavior.\n\nimport { createRequire } from 'module';\nimport { isMainThread, parentPort } from 'worker_threads';\nimport { initBrowserEnvironment } from './initBrowserEnvironment.js';\nimport { cleanUpGlobals, getGlobalProperties } from './globals.js';\n\nif (isMainThread || !parentPort) {\n  throw new Error('This file should only be loaded in a worker thread');\n}\n\nconst require = createRequire(import.meta.url);\n\nawait initBrowserEnvironment();\n// TODO should the globals be marked as readonly if possible?\nconst initialGlobalProperties = getGlobalProperties();\n\n/**\n * Type helper for sending messages to the parent.\n * @param {import('../types/SandboxWorkerResponse.js').SandboxWorkerResponse} message\n */\nfunction emitMessage(message) {\n  parentPort?.postMessage(message);\n}\n\nparentPort.on('message', (/** @type {string} */ entryPath) => {\n  if (typeof entryPath !== 'string') {\n    emitMessage({\n      error: { message: `Expected message to be a string; received: ${JSON.stringify(entryPath)}` },\n      entryPath: '',\n    });\n    return;\n  }\n\n  function onExit() {\n    // In this case, throw an error rather than sending a message to avoid handling it twice.\n    // Don't include the filename since that's potentially ambiguous (and redundant with info\n    // included by the runInSandbox error handler).\n    throw new Error('process.exit() was unexpectedly called');\n  }\n  process.on('exit', onExit);\n\n  try {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const moduleExports = require(entryPath);\n    emitMessage({\n      entryPath,\n      exportInfo: getExportInfo(moduleExports),\n    });\n  } catch (e) {\n    // Some errors running a module have a string `code` property.\n    // MODULE_NOT_FOUND errors have a `requireStack` property with a list of paths\n    // (right now we're using the call stack instead, but we could reconsider depending on\n    // which one seems more useful in practice).\n    const err = /** @type {Error & { code?: string; requireStack?: string[] }} */ (e);\n    emitMessage({\n      entryPath,\n      // Spreading doesn't work with errors, so copy manually\n      error: {\n        message: String(err), // handle non-Errors, and include the error name if present\n        name: err.name,\n        code: err.code,\n        stack: err.stack,\n      },\n    });\n  } finally {\n    cleanUpGlobals(initialGlobalProperties);\n    process.off('exit', onExit);\n  }\n});\n\n/**\n * Get information about a CJS module's exports, for purposes of creating a stub.\n * @param {unknown} moduleExport The module's exports.\n * @returns {import('../types/StubExportInfo.js').StubExportInfo}\n */\nfunction getExportInfo(moduleExport) {\n  if (moduleExport === undefined) {\n    return { type: 'none' };\n  }\n\n  if (typeof moduleExport === 'function') {\n    return { type: 'function', keys: Object.keys(moduleExport) };\n  }\n\n  if (moduleExport && typeof moduleExport === 'object' && !Array.isArray(moduleExport)) {\n    return { type: 'object', keys: Object.keys(moduleExport) };\n  }\n\n  return { type: 'other' };\n}\n"]}

package/lib/writeESMStub.d.ts

@@ -1,5 +1,9 @@
+import type { StubError } from './index.js';
 /**
  * Generates an ESM stub for CommonJS modules.
+ * @returns Path to the stub, or error info if there was an issue.
+ * Should only throw an error on bad input or other cases that likely indicate either a bug
+ * or bad configuration (as opposed to a problem with the file being stubbed).
  */
-export declare function writeESMStub(entryPath: string, stubPath?: string): Promise<string>;
+export declare function writeESMStub(entryPath: string): Promise<string | StubError>;
 //# sourceMappingURL=writeESMStub.d.ts.map

package/lib/writeESMStub.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"writeESMStub.d.ts","sourceRoot":"","sources":["../src/writeESMStub.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,wBAAsB,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CA0BxF"}
+{"version":3,"file":"writeESMStub.d.ts","sourceRoot":"","sources":["../src/writeESMStub.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAyBjF"}

package/lib/writeESMStub.js

@@ -5,26 +5,30 @@ import { findPackageRoot } from '@ms-cloudpack/path-utilities';
 import { slash } from '@ms-cloudpack/path-string-parsing';
 /**
  * Generates an ESM stub for CommonJS modules.
+ * @returns Path to the stub, or error info if there was an issue.
+ * Should only throw an error on bad input or other cases that likely indicate either a bug
+ * or bad configuration (as opposed to a problem with the file being stubbed).
  */
-export async function writeESMStub(entryPath, stubPath) {
+export async function writeESMStub(entryPath) {
     // Ensure forward slashes
     entryPath = slash(entryPath);
-    // Ensure stub path is provided.
-    if (!stubPath) {
-        const rootPath = findPackageRoot(entryPath);
-        if (!rootPath) {
-            throw new Error(`Unable to find package root for ${entryPath}`);
-        }
-        const extension = path.extname(entryPath);
-        const stubFilename = path.basename(entryPath, extension) + '-stub.js';
-        const stubFolderPath = path.join(rootPath, 'node_modules/.cache/cloudpack-stubs/');
-        await fsPromises.mkdir(stubFolderPath, { recursive: true });
-        stubPath = path.join(stubFolderPath, stubFilename);
+    // Figure out where to put the stub
+    const packageRoot = findPackageRoot(entryPath);
+    if (!packageRoot) {
+        throw new Error(`Unable to find package root for ${entryPath}`);
     }
-    // If we have a package export, we can generate an ESM stub.
-    const esmStub = await createESMStub(entryPath, stubPath);
-    // Write the stub to disk.
-    await fsPromises.writeFile(stubPath, esmStub);
-    return stubPath;
+    const stubFilename = path.basename(entryPath, path.extname(entryPath)) + '-stub.mjs';
+    const stubFolderPath = path.join(packageRoot, 'node_modules/.cache/cloudpack-stubs/');
+    const stubPath = path.join(stubFolderPath, stubFilename);
+    // Create parent directories for the stub
+    await fsPromises.mkdir(stubFolderPath, { recursive: true });
+    // Generate and write the stub
+    const esmStubResult = await createESMStub({ entryPath, stubPath });
+    if (typeof esmStubResult === 'string') {
+        await fsPromises.writeFile(stubPath, esmStubResult);
+        return stubPath;
+    }
+    // There was an error, so return that instead
+    return esmStubResult;
 }
 //# sourceMappingURL=writeESMStub.js.map

package/lib/writeESMStub.js.map

@@ -1 +1 @@
-{"version":3,"file":"writeESMStub.js","sourceRoot":"","sources":["../src/writeESMStub.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAC;AAE1D;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,SAAiB,EAAE,QAAiB;IACrE,yBAAyB;IACzB,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;IAE7B,gCAAgC;IAChC,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,QAAQ,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,mCAAmC,SAAS,EAAE,CAAC,CAAC;SACjE;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC1C,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,UAAU,CAAC;QACtE,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,sCAAsC,CAAC,CAAC;QAEnF,MAAM,UAAU,CAAC,KAAK,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAE5D,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;KACpD;IAED,4DAA4D;IAC5D,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAEzD,0BAA0B;IAC1B,MAAM,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAE9C,OAAO,QAAQ,CAAC;AAClB,CAAC","sourcesContent":["import fsPromises from 'fs/promises';\nimport path from 'path';\nimport { createESMStub } from './createESMStub.js';\nimport { findPackageRoot } from '@ms-cloudpack/path-utilities';\nimport { slash } from '@ms-cloudpack/path-string-parsing';\n\n/**\n * Generates an ESM stub for CommonJS modules.\n */\nexport async function writeESMStub(entryPath: string, stubPath?: string): Promise<string> {\n  // Ensure forward slashes\n  entryPath = slash(entryPath);\n\n  // Ensure stub path is provided.\n  if (!stubPath) {\n    const rootPath = findPackageRoot(entryPath);\n    if (!rootPath) {\n      throw new Error(`Unable to find package root for ${entryPath}`);\n    }\n    const extension = path.extname(entryPath);\n    const stubFilename = path.basename(entryPath, extension) + '-stub.js';\n    const stubFolderPath = path.join(rootPath, 'node_modules/.cache/cloudpack-stubs/');\n\n    await fsPromises.mkdir(stubFolderPath, { recursive: true });\n\n    stubPath = path.join(stubFolderPath, stubFilename);\n  }\n\n  // If we have a package export, we can generate an ESM stub.\n  const esmStub = await createESMStub(entryPath, stubPath);\n\n  // Write the stub to disk.\n  await fsPromises.writeFile(stubPath, esmStub);\n\n  return stubPath;\n}\n"]}
+{"version":3,"file":"writeESMStub.js","sourceRoot":"","sources":["../src/writeESMStub.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAC;AAG1D;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,SAAiB;IAClD,yBAAyB;IACzB,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;IAE7B,mCAAmC;IACnC,MAAM,WAAW,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;IAC/C,IAAI,CAAC,WAAW,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,mCAAmC,SAAS,EAAE,CAAC,CAAC;KACjE;IACD,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,GAAG,WAAW,CAAC;IACrF,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,sCAAsC,CAAC,CAAC;IACtF,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;IAEzD,yCAAyC;IACzC,MAAM,UAAU,CAAC,KAAK,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAE5D,8BAA8B;IAC9B,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;IACnE,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;QACrC,MAAM,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACpD,OAAO,QAAQ,CAAC;KACjB;IAED,6CAA6C;IAC7C,OAAO,aAAa,CAAC;AACvB,CAAC","sourcesContent":["import fsPromises from 'fs/promises';\nimport path from 'path';\nimport { createESMStub } from './createESMStub.js';\nimport { findPackageRoot } from '@ms-cloudpack/path-utilities';\nimport { slash } from '@ms-cloudpack/path-string-parsing';\nimport type { StubError } from './index.js';\n\n/**\n * Generates an ESM stub for CommonJS modules.\n * @returns Path to the stub, or error info if there was an issue.\n * Should only throw an error on bad input or other cases that likely indicate either a bug\n * or bad configuration (as opposed to a problem with the file being stubbed).\n */\nexport async function writeESMStub(entryPath: string): Promise<string | StubError> {\n  // Ensure forward slashes\n  entryPath = slash(entryPath);\n\n  // Figure out where to put the stub\n  const packageRoot = findPackageRoot(entryPath);\n  if (!packageRoot) {\n    throw new Error(`Unable to find package root for ${entryPath}`);\n  }\n  const stubFilename = path.basename(entryPath, path.extname(entryPath)) + '-stub.mjs';\n  const stubFolderPath = path.join(packageRoot, 'node_modules/.cache/cloudpack-stubs/');\n  const stubPath = path.join(stubFolderPath, stubFilename);\n\n  // Create parent directories for the stub\n  await fsPromises.mkdir(stubFolderPath, { recursive: true });\n\n  // Generate and write the stub\n  const esmStubResult = await createESMStub({ entryPath, stubPath });\n  if (typeof esmStubResult === 'string') {\n    await fsPromises.writeFile(stubPath, esmStubResult);\n    return stubPath;\n  }\n\n  // There was an error, so return that instead\n  return esmStubResult;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/esm-stub-utilities",
-  "version": "0.6.25",
+  "version": "0.7.0",
   "description": "Generates ESM stubs for CommonJS entry files.",
   "license": "MIT",
   "type": "module",
@@ -14,14 +14,13 @@
   },
   "dependencies": {
     "@ms-cloudpack/json-utilities": "^0.0.7",
-    "@ms-cloudpack/path-utilities": "^2.3.3",
+    "@ms-cloudpack/path-utilities": "^2.3.4",
     "@ms-cloudpack/path-string-parsing": "^1.1.0",
     "atob": "^2.1.2",
     "btoa": "^1.2.1",
     "jsdom-global": "^3.0.2",
     "jsdom": "^22.0.0",
-    "regenerator-runtime": "^0.13.9",
-    "vm2": "^3.9.13"
+    "regenerator-runtime": "^0.14.0"
   },
   "devDependencies": {
     "@ms-cloudpack/bundler-types": "*",
@@ -31,7 +30,9 @@
     "@types/atob": "^2.1.2",
     "@types/btoa": "^1.2.3",
     "@types/jsdom": "^21.1.1",
-    "@types/regenerator-runtime": "^0.13.1"
+    "@types/regenerator-runtime": "^0.13.1",
+    "lodash": "^4.17.21",
+    "pretty-format": "^29.7.0"
   },
   "scripts": {
     "api": "cloudpack-scripts api",
@@ -44,7 +45,6 @@
     "test": "cloudpack-scripts test"
   },
   "files": [
-    "browserEnvironment",
     "lib/**/!(*.test.*)"
   ]
 }

package/browserEnvironment/index.cjs

@@ -1,81 +0,0 @@
-// @ts-check
-/* eslint-disable @typescript-eslint/triple-slash-reference */
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable etc/no-deprecated */
-
-// This file uses JS because it's loaded directly into the CJS sandbox environment (see runInSandbox.ts).
-// It's located in a separate file because we don't want to run it through the typescript compiler
-// to avoid adding "use strict" or having issues with different versions of the file being used by
-// jest vs. actual runtime usage (jest would use the version from "src").
-
-/// <reference path="./typings.d.ts" />
-
-const btoa = require('btoa');
-const atob = require('atob');
-const { performance } = require('perf_hooks');
-const util = require('util');
-
-// These must be set up before JSDOM
-!global.performance && (global.performance = /** @type {*} */ (performance));
-!global.TextEncoder && (global.TextEncoder = util.TextEncoder);
-!global.TextDecoder && (global.TextDecoder = /** @type {*} */ (util.TextDecoder));
-
-require('jsdom-global')();
-
-require('regenerator-runtime');
-
-// Ensure assigning to and reading from `window.foo` globals works as expected by copying all the
-// properties from the jsdom `window` to node's `global`, then assigning `global` to `window`.
-Object.entries(Object.getOwnPropertyDescriptors(window)).forEach(([k, desc]) => {
-  // Skip storage to avoid errors "localStorage is not available for opaque origins"
-  // (these errors could in theory be resolved by passing a URL to jsdom-global setup, but that
-  // triggers some weird issues with whatwg-url using TextDecoder in a way that works in other
-  // environments but throws in the sandbox)
-  if (!(k in global) && !['localStorage', 'sessionStorage'].includes(k)) {
-    Object.defineProperty(global, k, desc);
-  }
-});
-/** @type {*} */ (global).window = global;
-/** @type {*} */ (global).self = global;
-/** @type {*} */ (document).window = global;
-
-window.requestAnimationFrame = window.setTimeout;
-window.cancelAnimationFrame = window.clearTimeout;
-global.btoa = btoa;
-global.atob = atob;
-
-// Simulate WebSocket existence. (Needed for isomorphic-ws)
-global.WebSocket = window.WebSocket = /** @type {*} */ (class WebSocket {});
-
-// Fake MessageChannel so scheduler won't hang the process by opening a channel.
-global.MessageChannel = window.MessageChannel = class MessageChannel {
-  port1 = /** @type {*} */ ({});
-  port2 = /** @type {*} */ ({});
-};
-
-const createElement = window.document.createElement.bind(window.document);
-
-// Mock out canvas.
-global.document.createElement =
-  /** @type {*} */ (window).createElement =
-  /** @type {*} */ (global).createElement =
-    (/** @type {string} */ tagName, /** @type {ElementCreationOptions} */ options) => {
-      if (tagName === 'canvas') {
-        return /** @type {*} */ ({
-          getContext: () => ({
-            fillRect: () => {
-              /* no-op */
-            },
-          }),
-          measureText: () => ({}),
-        });
-      }
-
-      return createElement.apply(window.document, [tagName, options]);
-    };
-
-window.fetch = /** @type {*} */ (
-  async () => {
-    /* no-op */
-  }
-);

package/browserEnvironment/typings.d.ts

@@ -1,5 +0,0 @@
-declare module 'jsdom-global' {
-  import type jsdom from 'jsdom';
-  function setup(html?: string, options?: jsdom.ConstructorOptions): () => void;
-  export = setup;
-}