@ms-cloudpack/esm-stub-utilities 0.0.2

package/CHANGELOG.json

@@ -0,0 +1,20 @@
+{
+  "name": "@ms-cloudpack/esm-stub-utilities",
+  "entries": [
+    {
+      "date": "Fri, 27 May 2022 20:32:33 GMT",
+      "tag": "@ms-cloudpack/esm-stub-utilities_v0.0.2",
+      "version": "0.0.2",
+      "comments": {
+        "patch": [
+          {
+            "author": "dzearing@microsoft.com",
+            "package": "@ms-cloudpack/esm-stub-utilities",
+            "commit": "0cc8ffacb753e45c6fa31b462ea8b90da5b185e5",
+            "comment": "Initial publish of esm-stub-utilities package."
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log - @ms-cloudpack/esm-stub-utilities
+
+This log was last generated on Fri, 27 May 2022 20:32:33 GMT and should not be manually modified.
+
+<!-- Start content -->
+
+## 0.0.2
+
+Fri, 27 May 2022 20:32:33 GMT
+
+### Patches
+
+- Initial publish of esm-stub-utilities package. (dzearing@microsoft.com)

package/README.md

@@ -0,0 +1,45 @@
+# @ms-cloudpack/esm-stub-utilities
+
+This library contains utilities for generating ESM stubs for CommonJS modules. Some bundlers require this for extracting named exports needed to produce a browser-compatible ESM bundle.
+
+## Usage
+
+Generate a stub given a JavaScript entry path:
+
+```js
+import { createESMStub } from '@ms-cloudpack/esm-stub-utilities';
+
+const esmStub = await createESMStub('/path/to/entry.js', '/path/to/stub.js');
+```
+
+This return an esm stub string, based on loading the package in node and parsing exported keys. Example output:
+
+```js
+import content from '/path/to/entry.js';
+
+export {
+  default: content,
+  named1: content.named1,
+  named2: content.named2
+};
+```
+
+Writes the path to the stub to a file:
+
+```js
+import { writeESMStub } from '@ms-cloudpack/esm-stub-utilities';
+
+await writeESMStub('./path/to/entry.js', './path/to/stub.js');
+```
+
+## Special considerations
+
+When evaluating named entries in the `exports` of the cjs file, the library is loaded in the node process. A few libraries are used to simulate the browser environment in order for the script to load. (E.g. some libraries will reference `window` on load, and therefore must be parsed in an environment that accommodates this.)
+
+Libraries which export a `default` entry in their `exports` will have that value preserved as the `default` export in the stub. However libraries which have an object exported which don't have a `default` key will have the entire object exported as the default.
+
+Libraries which export a function or literal value as the `exports` result will have a default export for that entry.
+
+Some libraries don't export anything. In this case, the stub will simply import the entry.
+
+Exported members that are keywords will be ignored. (E.g. `module.exports = { 'delete': "foo" };` would be considered an empty export.)

package/lib/createESMStub.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generates an ESM stub for CommonJS modules.
+ * @param entryPath - The full path to the CommonJS entry file.
+ * @param stubPath - The path where the stub file will live. This is important for determining
+ * relative import paths.
+ * @param packageExport - The exported package.
+ */
+export declare function createESMStub(entryPath: string, stubPath: string): string;

package/lib/createESMStub.js

@@ -0,0 +1,69 @@
+import { slash } from '@ms-cloudpack/path-utilities';
+import path from 'path';
+import { initializeBrowserEnvironment } from './initializeBrowserEnvironment.js';
+import { tryRequire } from './tryRequire.cjs';
+import { forbiddenExportNames } from './forbiddenExportNames.js';
+/**
+ * Generates an ESM stub for CommonJS modules.
+ * @param entryPath - The full path to the CommonJS entry file.
+ * @param stubPath - The path where the stub file will live. This is important for determining
+ * relative import paths.
+ * @param packageExport - The exported package.
+ */
+export function createESMStub(entryPath, stubPath) {
+    const result = [];
+    const relativePath = './' + slash(path.relative(path.dirname(stubPath), entryPath));
+    // Try and require the entry file.
+    initializeBrowserEnvironment();
+    const packageExport = tryRequire(entryPath);
+    if (packageExport) {
+        let isDefaultExported = false;
+        const isExportObject = typeof packageExport === 'object';
+        const isExportFunction = typeof packageExport === 'function';
+        if (isExportObject || isExportFunction) {
+            // Make sure to filter keywords.
+            const namedExports = Object.keys(packageExport).filter((name) => forbiddenExportNames.indexOf(name) < 0);
+            if (namedExports.length || isExportFunction) {
+                result.push(`import packageExport from "${relativePath}";`);
+            }
+            if (namedExports.length) {
+                result.push(`const {`);
+                for (const namedExport of namedExports) {
+                    if (namedExport === 'default') {
+                        isDefaultExported = true;
+                        result.push(`  default: __moduleDefault,`);
+                    }
+                    else {
+                        result.push(`  ${namedExport},`);
+                    }
+                }
+                result.push(`} = packageExport;`, ``);
+                if (isDefaultExported) {
+                    result.push(`export {`, ...namedExports.filter((n) => n !== 'default').map((n) => `${n},`), `__moduleDefault as default,`, `}`);
+                }
+                else {
+                    result.push(`export {`, ...namedExports.map((n) => `  ${n},`), `  packageExport as default,`, `}`);
+                }
+            }
+            else if (isExportObject) {
+                // No named exports...
+                // Object with no members? Must be a polyfill. Just import it and don't export anything.
+                result.push(`import "${relativePath}";`);
+            }
+            else {
+                // Must be a function. Export it as default.
+                result.push(`export default packageExport;`);
+            }
+        }
+        else {
+            // not an object or function
+            result.push(`export default packageExport;`);
+        }
+    }
+    else {
+        // unable to import the module in node.
+        result.push(`import "${relativePath}";`);
+    }
+    return result.join('\n');
+}
+//# sourceMappingURL=createESMStub.js.map

package/lib/createESMStub.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createESMStub.js","sourceRoot":"","sources":["../src/createESMStub.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AACrD,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,SAAiB,EAAE,QAAgB;IAC/D,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,4BAA4B,EAAE,CAAC;IAE/B,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;IAE5C,IAAI,aAAa,EAAE;QACjB,IAAI,iBAAiB,GAAG,KAAK,CAAC;QAC9B,MAAM,cAAc,GAAG,OAAO,aAAa,KAAK,QAAQ,CAAC;QACzD,MAAM,gBAAgB,GAAG,OAAO,aAAa,KAAK,UAAU,CAAC;QAE7D,IAAI,cAAc,IAAI,gBAAgB,EAAE;YACtC,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;YAEzG,IAAI,YAAY,CAAC,MAAM,IAAI,gBAAgB,EAAE;gBAC3C,MAAM,CAAC,IAAI,CAAC,8BAA8B,YAAY,IAAI,CAAC,CAAC;aAC7D;YAED,IAAI,YAAY,CAAC,MAAM,EAAE;gBACvB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAEvB,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;oBACtC,IAAI,WAAW,KAAK,SAAS,EAAE;wBAC7B,iBAAiB,GAAG,IAAI,CAAC;wBACzB,MAAM,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;qBAC5C;yBAAM;wBACL,MAAM,CAAC,IAAI,CAAC,KAAK,WAAW,GAAG,CAAC,CAAC;qBAClC;iBACF;gBAED,MAAM,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;gBAEtC,IAAI,iBAAiB,EAAE;oBACrB,MAAM,CAAC,IAAI,CACT,UAAU,EACV,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAClE,6BAA6B,EAC7B,GAAG,CACJ,CAAC;iBACH;qBAAM;oBACL,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,6BAA6B,EAAE,GAAG,CAAC,CAAC;iBACpG;aACF;iBAAM,IAAI,cAAc,EAAE;gBACzB,sBAAsB;gBACtB,wFAAwF;gBACxF,MAAM,CAAC,IAAI,CAAC,WAAW,YAAY,IAAI,CAAC,CAAC;aAC1C;iBAAM;gBACL,4CAA4C;gBAC5C,MAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;aAC9C;SACF;aAAM;YACL,4BAA4B;YAC5B,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/createESMStub.test.d.ts

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

package/lib/createESMStub.test.js

@@ -0,0 +1,192 @@
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { createESMStub } from './createESMStub.js';
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+const testScenariosPath = path.join(dirname, '../test-scenarios');
+const stubPath = path.join(testScenariosPath, 'esm-stub.js');
+describe('createESMStub', () => {
+    it('should create an ESM stub for CommonJS object export without a default', () => {
+        expect(createESMStub(path.join(testScenariosPath, 'object-export.cjs'), stubPath)).toMatchInlineSnapshot(`
+      "import packageExport from \\"./object-export.cjs\\";
+      const {
+        a,
+        b,
+        c,
+        d,
+      } = packageExport;
+
+      export {
+        a,
+        b,
+        c,
+        d,
+        packageExport as default,
+      }"
+    `);
+    });
+    it('should create an ESM stub for CommonJS object export with a named default', () => {
+        expect(createESMStub(path.join(testScenariosPath, 'object-export-with-default.cjs'), stubPath))
+            .toMatchInlineSnapshot(`
+      "import packageExport from \\"./object-export-with-default.cjs\\";
+      const {
+        default: __moduleDefault,
+        a,
+        b,
+        c,
+        d,
+      } = packageExport;
+
+      export {
+      a,
+      b,
+      c,
+      d,
+      __moduleDefault as default,
+      }"
+    `);
+    });
+    it('should create an ESM stub for CommonJS function export', () => {
+        expect(createESMStub(path.join(testScenariosPath, 'function-export.cjs'), stubPath)).toMatchInlineSnapshot(`
+      "import packageExport from \\"./function-export.cjs\\";
+      export default packageExport;"
+    `);
+    });
+    it('should create an ESM stub for CommonJS string export', () => {
+        expect(createESMStub(path.join(testScenariosPath, 'string-export.cjs'), stubPath)).toMatchInlineSnapshot(`"export default packageExport;"`);
+    });
+    it("should throw when the code can't be parsed", () => {
+        expect(() => createESMStub(path.join(testScenariosPath, 'throws-error.cjs'), stubPath)).toThrow();
+    });
+    it('can handle a CommonJS module with no exports', () => {
+        expect(createESMStub(path.join(testScenariosPath, 'no-exports.cjs'), stubPath)).toMatchInlineSnapshot(`"import \\"./no-exports.cjs\\";"`);
+    });
+    it('can snapshot react', () => {
+        expect(createESMStub('react', stubPath)).toMatchInlineSnapshot(`
+      "import packageExport from \\"./../react\\";
+      const {
+        Fragment,
+        StrictMode,
+        Profiler,
+        Suspense,
+        Children,
+        Component,
+        PureComponent,
+        __SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED,
+        cloneElement,
+        createContext,
+        createElement,
+        createFactory,
+        createRef,
+        forwardRef,
+        isValidElement,
+        lazy,
+        memo,
+        useCallback,
+        useContext,
+        useDebugValue,
+        useEffect,
+        useImperativeHandle,
+        useLayoutEffect,
+        useMemo,
+        useReducer,
+        useRef,
+        useState,
+        version,
+      } = packageExport;
+
+      export {
+        Fragment,
+        StrictMode,
+        Profiler,
+        Suspense,
+        Children,
+        Component,
+        PureComponent,
+        __SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED,
+        cloneElement,
+        createContext,
+        createElement,
+        createFactory,
+        createRef,
+        forwardRef,
+        isValidElement,
+        lazy,
+        memo,
+        useCallback,
+        useContext,
+        useDebugValue,
+        useEffect,
+        useImperativeHandle,
+        useLayoutEffect,
+        useMemo,
+        useReducer,
+        useRef,
+        useState,
+        version,
+        packageExport as default,
+      }"
+    `);
+    });
+    it('can snapshot react-dom', () => {
+        expect(createESMStub('react-dom', stubPath)).toMatchInlineSnapshot(`
+      "import packageExport from \\"./../react-dom\\";
+      const {
+        __SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED,
+        createPortal,
+        findDOMNode,
+        flushSync,
+        hydrate,
+        render,
+        unmountComponentAtNode,
+        unstable_batchedUpdates,
+        unstable_createPortal,
+        unstable_renderSubtreeIntoContainer,
+        version,
+      } = packageExport;
+
+      export {
+        __SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED,
+        createPortal,
+        findDOMNode,
+        flushSync,
+        hydrate,
+        render,
+        unmountComponentAtNode,
+        unstable_batchedUpdates,
+        unstable_createPortal,
+        unstable_renderSubtreeIntoContainer,
+        version,
+        packageExport as default,
+      }"
+    `);
+    });
+    it('can generate a stub for a browser-sensitive CommonJS module', () => {
+        expect(createESMStub(path.join(testScenariosPath, 'browser-sensitive.cjs'), stubPath)).toMatchInlineSnapshot(`
+      "import packageExport from \\"./browser-sensitive.cjs\\";
+      const {
+        getDiv,
+      } = packageExport;
+
+      export {
+        getDiv,
+        packageExport as default,
+      }"
+    `);
+    });
+    it('can ignore JavaScript keywords in named exports', () => {
+        // Should be missing "delete" in the named exports.
+        expect(createESMStub(path.join(testScenariosPath, 'export-with-keyword.cjs'), stubPath)).toMatchInlineSnapshot(`
+      "import packageExport from \\"./export-with-keyword.cjs\\";
+      const {
+        default: __moduleDefault,
+        a,
+      } = packageExport;
+
+      export {
+      a,
+      __moduleDefault as default,
+      }"
+    `);
+    });
+});
+//# sourceMappingURL=createESMStub.test.js.map

package/lib/createESMStub.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createESMStub.test.js","sourceRoot":"","sources":["../src/createESMStub.test.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC7D,MAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;AAClE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;AAE7D,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;QAChF,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;;;KAgBxG,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2EAA2E,EAAE,GAAG,EAAE;QACnF,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,gCAAgC,CAAC,EAAE,QAAQ,CAAC,CAAC;aAC5F,qBAAqB,CAAC;;;;;;;;;;;;;;;;;KAiBxB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,qBAAqB,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;KAG1G,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,qBAAqB,CACtG,iCAAiC,CAClC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,CAAC,GAAG,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACpG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,qBAAqB,CACnG,kCAAkC,CACnC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAC5B,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAgE9D,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;QAChC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KA8BlE,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACrE,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,uBAAuB,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;KAU5G,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,mDAAmD;QACnD,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,yBAAyB,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;KAW9G,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/forbiddenExportNames.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Lists all export names which create problems with esm output. Mostly
+ * this includes the JavaScript keywords, minus "default".
+ */
+export declare const forbiddenExportNames: string[];

package/lib/forbiddenExportNames.js

@@ -0,0 +1,70 @@
+/**
+ * Lists all export names which create problems with esm output. Mostly
+ * this includes the JavaScript keywords, minus "default".
+ */
+export const forbiddenExportNames = [
+    'abstract',
+    'arguments',
+    'await',
+    'boolean',
+    'break',
+    'byte',
+    'case',
+    'catch',
+    'char',
+    'class',
+    'const',
+    'continue',
+    'debugger',
+    'delete',
+    'do',
+    'double',
+    'else',
+    'enum',
+    'eval',
+    'export',
+    'extends',
+    'false',
+    'final',
+    'finally',
+    'float',
+    'for',
+    'function',
+    'goto',
+    'if',
+    'implements',
+    'import',
+    'in',
+    'instanceof',
+    'int',
+    'interface',
+    'let',
+    'long',
+    'native',
+    'new',
+    'null',
+    'package',
+    'private',
+    'protected',
+    'public',
+    'return',
+    'short',
+    'static',
+    'super',
+    'switch',
+    'synchronized',
+    'this',
+    'throw',
+    'throws',
+    'transient',
+    'true',
+    'try',
+    'typeof',
+    'var',
+    'void',
+    'volatile',
+    'while',
+    'with',
+    'yield',
+];
+//# sourceMappingURL=forbiddenExportNames.js.map

package/lib/forbiddenExportNames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"forbiddenExportNames.js","sourceRoot":"","sources":["../src/forbiddenExportNames.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,UAAU;IACV,WAAW;IACX,OAAO;IACP,SAAS;IACT,OAAO;IACP,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,OAAO;IACP,OAAO;IACP,UAAU;IACV,UAAU;IACV,QAAQ;IACR,IAAI;IACJ,QAAQ;IACR,MAAM;IACN,MAAM;IACN,MAAM;IACN,QAAQ;IACR,SAAS;IACT,OAAO;IACP,OAAO;IACP,SAAS;IACT,OAAO;IACP,KAAK;IACL,UAAU;IACV,MAAM;IACN,IAAI;IACJ,YAAY;IACZ,QAAQ;IACR,IAAI;IACJ,YAAY;IACZ,KAAK;IACL,WAAW;IACX,KAAK;IACL,MAAM;IACN,QAAQ;IACR,KAAK;IACL,MAAM;IACN,SAAS;IACT,SAAS;IACT,WAAW;IACX,QAAQ;IACR,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,cAAc;IACd,MAAM;IACN,OAAO;IACP,QAAQ;IACR,WAAW;IACX,MAAM;IACN,KAAK;IACL,QAAQ;IACR,KAAK;IACL,MAAM;IACN,UAAU;IACV,OAAO;IACP,MAAM;IACN,OAAO;CACR,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export { createESMStub } from './createESMStub.js';
+export { writeESMStub } from './writeESMStub.js';

package/lib/index.js

@@ -0,0 +1,3 @@
+export { createESMStub } from './createESMStub.js';
+export { writeESMStub } from './writeESMStub.js';
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC"}

package/lib/initializeBrowserEnvironment.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 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

@@ -0,0 +1,47 @@
+/**
+ * Initializes a browser environment (e.g. by setting up the global `window` in a node environment.)
+ */
+export async function initializeBrowserEnvironment() {
+    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/runtime');
+        const dom = new JSDOM();
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        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;
+        // 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 =
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                    (tagName, ...args) => {
+                        if (tagName === 'canvas') {
+                            return {
+                                getContext: () => ({
+                                    fillRect: () => {
+                                        /* no-op */
+                                    },
+                                }),
+                                measureText: () => ({}),
+                            };
+                        }
+                        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                        return createElement.apply(dom.window.document, [tagName, ...args]);
+                    };
+    }
+}
+//# sourceMappingURL=initializeBrowserEnvironment.js.map

package/lib/initializeBrowserEnvironment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initializeBrowserEnvironment.js","sourceRoot":"","sources":["../src/initializeBrowserEnvironment.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B;IAChD,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;QAClE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC;QACxC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC;QAClC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC;QAElC,MAAM,MAAM,CAAC,cAAc,CAAC,CAAC;QAE7B,6DAA6D;QAC7D,aAAa;QACb,MAAM,MAAM,CAAC,6BAA6B,CAAC,CAAC;QAE5C,MAAM,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,8DAA8D;QAC9D,MAAM,UAAU,GAAQ,MAAM,CAAC;QAE/B,UAAU,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAC/B,UAAU,CAAC,MAAM,CAAC,qBAAqB,GAAG,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC;QAChE,UAAU,CAAC,MAAM,CAAC,oBAAoB,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC;QACjE,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,UAAU,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC;QAC7B,UAAU,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC1C,UAAU,CAAC,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC;QAE5C,6CAA6C;QAC7C,MAAM,aAAa,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAElF,mBAAmB;QACnB,UAAU,CAAC,QAAQ,CAAC,aAAa;YAC/B,UAAU,CAAC,MAAM,CAAC,aAAa;gBAC/B,UAAU,CAAC,aAAa;oBACtB,8DAA8D;oBAC9D,CAAC,OAAe,EAAE,GAAG,IAAW,EAAE,EAAE;wBAClC,IAAI,OAAO,KAAK,QAAQ,EAAE;4BACxB,OAAO;gCACL,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;oCACjB,QAAQ,EAAE,GAAG,EAAE;wCACb,WAAW;oCACb,CAAC;iCACF,CAAC;gCACF,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;6BACxB,CAAC;yBACH;wBAED,8DAA8D;wBAC9D,OAAQ,aAAqB,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;oBAC/E,CAAC,CAAC;KACP;AACH,CAAC"}

package/lib/tryRequire.cjs

@@ -0,0 +1,12 @@
+"use strict";
+/* eslint-disable no-undef */
+/**
+ * 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 = {
+    tryRequire(modulePath) {
+        return require(modulePath);
+    },
+};
+//# sourceMappingURL=tryRequire.cjs.map

package/lib/tryRequire.cjs.map

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

package/lib/tryRequire.d.cts

@@ -0,0 +1,2 @@
+export function tryRequire(modulePath: any): any;
+export function tryRequire(modulePath: any): any;

package/lib/tryRequire.test.d.ts

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

package/lib/tryRequire.test.js

@@ -0,0 +1,15 @@
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { tryRequire } from './tryRequire.cjs';
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+const testScenariosPath = path.join(dirname, '../test-scenarios');
+describe('tryRequire', () => {
+    it('can successfully require a CommonJS module', () => {
+        const module = tryRequire(path.join(testScenariosPath, 'object-export.cjs'));
+        expect(module).toBeTruthy();
+    });
+    it('can throw when the module cannot be required', () => {
+        expect(() => tryRequire('this-module-does-not-exist')).toThrow();
+    });
+});
+//# sourceMappingURL=tryRequire.test.js.map

package/lib/tryRequire.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tryRequire.test.js","sourceRoot":"","sources":["../src/tryRequire.test.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC7D,MAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;AAElE,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,CAAC,CAAC;QAC7E,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,4BAA4B,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACnE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/writeESMStub.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Generates an ESM stub for CommonJS modules.
+ */
+export declare function writeESMStub(entryPath: string, stubPath: string): Promise<void>;

package/lib/writeESMStub.js

@@ -0,0 +1,16 @@
+import { slash } from '@ms-cloudpack/path-utilities';
+import fs from 'fs';
+import { createESMStub } from './createESMStub.js';
+const { writeFile } = fs.promises;
+/**
+ * Generates an ESM stub for CommonJS modules.
+ */
+export async function writeESMStub(entryPath, stubPath) {
+    // Ensure forward slashes
+    entryPath = slash(entryPath);
+    // If we have a package export, we can generate an ESM stub.
+    const esmStub = createESMStub(entryPath, stubPath);
+    // Write the stub to disk.
+    await writeFile(stubPath, esmStub);
+}
+//# sourceMappingURL=writeESMStub.js.map

package/lib/writeESMStub.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeESMStub.js","sourceRoot":"","sources":["../src/writeESMStub.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AACrD,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC;AAClC;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,SAAiB,EAAE,QAAgB;IACpE,yBAAyB;IACzB,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;IAE7B,4DAA4D;IAC5D,MAAM,OAAO,GAAG,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAEnD,0BAA0B;IAC1B,MAAM,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@ms-cloudpack/esm-stub-utilities",
+  "version": "0.0.2",
+  "description": "Generates ESM stubs for CommonJS entry files.",
+  "license": "MIT",
+  "type": "module",
+  "types": "./lib/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js"
+    }
+  },
+  "dependencies": {
+    "@ms-cloudpack/path-utilities": "^0.3.0",
+    "atob": "^2.1.2",
+    "btoa": "^1.2.1",
+    "jsdom-global": "^3.0.2",
+    "jsdom": "^19.0.0",
+    "regenerator-runtime": "^0.13.9"
+  },
+  "devDependencies": {
+    "@ms-cloudpack/eslint-config-base": "*",
+    "@ms-cloudpack/scripts": "*",
+    "@types/atob": "^2.1.2",
+    "@types/btoa": "^1.2.3",
+    "@types/jsdom-global": "^3.0.2",
+    "@types/jsdom": "^16.2.14",
+    "@types/regenerator-runtime": "^0.13.1",
+    "react-dom": "^17.0.2",
+    "react": "^17.0.2"
+  },
+  "scripts": {
+    "api:update": "cloudpack-scripts api-update",
+    "api": "cloudpack-scripts api",
+    "build:watch": "cloudpack-scripts build-watch",
+    "build": "cloudpack-scripts build",
+    "lint:update": "cloudpack-scripts lint-update",
+    "lint": "cloudpack-scripts lint",
+    "test:update": "cloudpack-scripts test-update",
+    "test:watch": "cloudpack-scripts test-watch",
+    "test": "cloudpack-scripts test"
+  },
+  "files": [
+    "/lib"
+  ]
+}