fix: allow importing as native browser module, tests

connor4312 · Feb 12, 2020 · 8c48e49 · 8c48e49
1 parent 7b37f12
commit 8c48e49
Show file tree

Hide file tree

Showing 19 changed files with 270 additions and 96 deletions.
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-TARGETS=nodejs browser
+TARGETS=nodejs browser web
 MODE=dev
 
 RUST_WASM_SRC = $(wildcard rs/wasm/src/*.rs)

diff --git a/browser-async.d.ts b/browser-async.d.ts
@@ -0,0 +1,7 @@
+import * as blake3 from './esm/browser';
+
+/**
+ * Manually loads the WebAssembly module, returning a promise that resolves
+ * to the BLAKE3 implementation once available.
+ */
+export default function load(module: string | URL | Request | object): Promise<typeof blake3>;
diff --git a/browser-async.js b/browser-async.js
@@ -0,0 +1,20 @@
+import { provideWasm } from './esm/browser/wasm.js';
+import * as wasm from './dist/wasm/web/blake3_js.js';
+import * as blake3 from './esm/browser/index.js';
+
+let cached;
+
+/**
+ * Manually loads the WebAssembly module, returning a promise that resolves
+ * to the BLAKE3 implementation once available.
+ */
+export default function load(module) {
+  if (!cached) {
+    cached = wasm.default(module).then(() => {
+      provideWasm(wasm);
+      return blake3;
+    });
+  }
+
+  return cached;
+}
diff --git a/browser-async.test.html b/browser-async.test.html
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>blake3 import async test</title>
+</head>
+
+<body>
+  <script type="module">
+    import init from './browser-async.js';
+    init().then(blake3 => window.blake3 = blake3).catch(console.error);
+  </script>
+</body>
+
+</html>
diff --git a/browser.js b/browser.js
@@ -1 +1,6 @@
+import { provideWasm } from './esm/browser/wasm';
+import * as wasm from './dist/wasm/browser';
+
+provideWasm(wasm);
+
 export * from './esm/browser';
diff --git a/changelog.md b/changelog.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.1.1 - 2019-02-11
+
+- allow importing the module without a bundler or with tools like Parcel
+
 ## 2.1.0 - 2019-01-23
 
 - add keyed hash and key derivation support (fixes [#2](https://github.com/connor4312/blake3/issues/2), [#9](https://github.com/connor4312/blake3/issues/9))

diff --git a/package.json b/package.json
@@ -18,7 +18,7 @@
     "prepack": "make clean && make MODE=release && npm test && rimraf dist/native.node",
     "test": "mocha --require source-map-support/register --recursive \"dist/**/*.test.js\" --timeout 5000",
     "fmt": "make fmt",
-    "compile": "tsc && tsc -p tsconfig.esm.json",
+    "compile": "tsc && tsc -p tsconfig.esm.json && node dist/build/add-js-extensions",
     "watch": "tsc --watch"
   },
   "repository": {

diff --git a/readme.md b/readme.md
@@ -212,7 +212,17 @@ using(hash.reader(), async reader => {
 
 ### Browser
 
-The browser API can be imported via `import('blake3/browser')`.
+The browser API can be imported via `import('blake3/browser')`, which works well with Webpack.
+
+If you aren't using a bundler or using a more "pure" bundler like Parcel, you can import `blake3/browser-async` which exports a function to asynchronously load the WebAssembly code and resolves to the package contents.
+
+```js
+import load from 'blake3/brwoser-async';
+
+load().then(blake3 => {
+  console.log(blake3.hash('hello world'));
+});
+```
 
 #### `hash(data: BinaryLike, options?: { length: number }): Hash`