Provide a single default export that works for all targets

Author: pimterry

index.browser.js

@@ -3,5 +3,10 @@
 // allow synchronous import of WebAssembly from an entrypoint.
 module.exports = import("./pkg.bundler/brotli_wasm.js");
 
-// We don't want to do this for _all_ usage, because dynamic import isn't
-// supported in older node versions.
+// In addition, we provide a default export with the same value, for compatibility
+// with the pure ESM web bundle:
+module.exports.default = module.exports;
+
+// Without this, ts-loader gets annoyed by imports for the pure type. Clear ts-loader bug,
+// but this is a quick & easy fix on our end:
+module.exports.BrotliWasmType = undefined;

index.d.ts

@@ -0,0 +1,9 @@
+import * as BrotliWasm from './pkg.node/brotli_wasm';
+
+// Re-export the core API - although this will only work OOTB for node usage.
+export * from './pkg.node/brotli_wasm';
+
+declare const promisedValue: Promise<typeof BrotliWasm>;
+export default promisedValue;
+
+export type BrotliWasmType = typeof BrotliWasm;

index.node.js

@@ -0,0 +1,6 @@
+// In Node, everything is conveniently available synchronously.
+const nodePkg = require('./pkg.node/brotli_wasm');
+module.exports = nodePkg;
+
+// In addition though, we provide a default export, to match the pure ESM web bundle:
+module.exports.default = Promise.resolve(nodePkg);

index.web.d.ts

@@ -1,5 +1,5 @@
-// The web version needs to be explicitly initiated, but we want the API to be the same
-// as the bundler version, so we write this small wrapper to make it work.
+// In pure ESM web bundles, you must call init() and wait for the promised result before you can
+// call any module methods. To make that as easy as possible, this module directly exposes the
+// init() promise result, and returns the methods at the end of the promise.
 import init, * as brotliWasm from "./pkg.web/brotli_wasm";
-
-export default initOpts => init(initOpts).then(() => brotliWasm);
+export default init().then(() => brotliWasm);

index.web.js

@@ -0,0 +1,33 @@
+// Karma-vite breaks Karma in Node <14, and browser tests don't depend on Node versions, so
+// we just skip the tests in those environments.
+const nodeMajorVersion = parseInt(process.versions.node.split('.'));
+if (nodeMajorVersion <= 14) {
+    console.log('Skipping browser tests in old node version');
+    process.exit(0);
+}
+
+module.exports = function(config) {
+    config.set({
+        frameworks: ['mocha', 'chai', 'vite'],
+        files: [
+            {
+              pattern: 'test/**/*.spec.ts',
+              type: 'module',
+              watched: false,
+              served: false,
+            }
+        ],
+        mime: {
+            'text/x-typescript': ['ts']
+        },
+        reporters: ['spec'],
+        port: 9876,
+        logLevel: config.LOG_INFO,
+
+        browsers: ['ChromeHeadless'],
+
+        autoWatch: false,
+        singleRun: true,
+        concurrency: Infinity
+    });
+};

karma-esm.conf.js

@@ -1,8 +1,14 @@
+// Karma-vite breaks Karma in Node <14, and browser tests don't depend on Node versions, so
+// we just skip the tests in those environments.
+const nodeMajorVersion = parseInt(process.versions.node.split('.'));
+if (nodeMajorVersion <= 14) {
+    console.log('Skipping browser tests in old node version');
+    process.exit(0);
+}
+
 const tmp = require('tmp');
 tmp.setGracefulCleanup();
 
-const webpack = require('webpack');
-
 const outputDir = tmp.dirSync({ unsafeCleanup: true }).name;
 
 module.exports = function(config) {
@@ -38,21 +44,12 @@ module.exports = function(config) {
             resolve: {
                 extensions: ['.ts', '.js'],
                 fallback: {
-                    buffer: require.resolve('buffer/'),
-                    fs: require.resolve('graceful-fs/graceful-fs'),
-                    path: require.resolve('path-browserify/'),
-                    constants: require.resolve('constants-browserify/'),
-                    stream: require.resolve('stream-browserify/'),
+                    crypto: false
                 }
             },
             experiments: {
                 asyncWebAssembly: true
             },
-            plugins: [
-                new webpack.ProvidePlugin({
-                    Buffer: ['buffer', 'Buffer'],process: 'process/browser',
-                })
-            ],
             output: {
                 path: outputDir
             }

karma.conf.js renamed to karma-webpack.conf.js

@@ -2,25 +2,36 @@
   "name": "brotli-wasm",
   "version": "1.2.0",
   "description": "A reliable compressor and decompressor for Brotli, supporting node & browsers via wasm",
-  "main": "./pkg.node/brotli_wasm.js",
-  "types": "./pkg.node/brotli_wasm.d.ts",
+  "types": "./index.d.ts",
+  "main": "./index.node.js",
   "browser": "./index.browser.js",
+  "exports": {
+    ".": {
+      "import": "./index.web.js",
+      "browser": "./index.browser.js",
+      "require": "./index.node.js",
+      "default": "./index.web.js"
+    }
+  },
   "sideEffects": false,
   "files": [
     "pkg.node",
     "pkg.bundler",
     "pkg.web",
+    "index.node.js",
     "index.browser.js",
-    "index.web.d.ts",
-    "index.web.js"
+    "index.web.js",
+    "index.d.ts"
   ],
   "scripts": {
     "build": "node ./build.js",
     "pretest": "npm run build",
-    "test": "npm run test:node && npm run test:browser",
-    "test:node": "ts-mocha -r esm -p test/tsconfig.json 'test/**/*.spec.ts'",
-    "test:browser": "karma start",
-    "test:browser:debug": "npm run test:browser -- --single-run=false --browsers Chrome"
+    "test": "npm run test:node && npm run test:esm && npm run test:webpack",
+    "test:node": "ts-mocha -p test/tsconfig.json 'test/**/*.spec.ts'",
+    "test:webpack": "karma start ./karma-webpack.conf.js",
+    "test:esm": "karma start ./karma-esm.conf.js",
+    "test:webpack:debug": "npm run test:webpack -- --single-run=false --browsers Chrome",
+    "test:esm:debug": "npm run test:esm -- --single-run=false --browsers Chrome"
   },
   "repository": {
     "type": "git",
@@ -39,10 +50,15 @@
   },
   "homepage": "https://github.com/httptoolkit/brotli-wasm#readme",
   "devDependencies": {
+    "@peculiar/webcrypto": "^1.4.0",
+    "@types/atob": "^2.1.2",
+    "@types/btoa": "^1.2.3",
     "@types/chai": "^4.2.18",
     "@types/mocha": "^8.2.2",
     "@types/node": "^15.6.0",
     "@types/text-encoding": "0.0.36",
+    "atob": "^2.1.2",
+    "btoa": "^1.2.1",
     "buffer": "^6.0.3",
     "chai": "^4.3.4",
     "karma": "^6.3.2",
@@ -52,16 +68,16 @@
     "karma-sourcemap-loader": "^0.3.8",
     "karma-spec-reporter": "0.0.32",
     "karma-typescript": "^5.5.1",
+    "karma-vite": "^1.0.1",
     "karma-webpack": "^5.0.0",
     "mocha": "^8.4.0",
     "shelljs": "^0.8.4",
+    "text-encoding": "^0.7.0",
     "ts-loader": "^9.2.1",
+    "ts-mocha": "^10.0.0",
     "ts-node": "^9.1.1",
     "typescript": "^4.2.4",
     "wasm-pack": "^0.10.3",
-    "webpack": "^5.37.1",
-    "esm": "^3.2.25",
-    "text-encoding": "^0.7.0",
-    "ts-mocha": "^10.0.0"
+    "webpack": "^5.37.1"
   }
 }