feat: support browsers

Author: jonahsnider

.github/workflows/ci.yml

@@ -19,20 +19,27 @@ jobs:
           cache: 'yarn'
       - name: Install dependencies with Yarn
         run: yarn install --immutable
-      - name: Build TypeScript
-        run: yarn run build
-      - name: Upload compiled TypeScript
-        uses: actions/upload-artifact@v2
-        with:
-          name: dist
-          path: dist
       - name: Build WASM
         run: yarn run asbuild
       - name: Upload compiled TypeScript
         uses: actions/upload-artifact@v2
         with:
           name: wasm
           path: wasm
+      - name: Bundle
+        run: yarn run build
+      - name: Upload bundle
+        uses: actions/upload-artifact@v2
+        with:
+          name: dist
+          path: dist
+      - name: Generate typings
+        run: yarn run types
+      - name: Upload typings
+        uses: actions/upload-artifact@v2
+        with:
+          name: types
+          path: tsc_types
   docs:
     name: Generate docs
 
@@ -49,7 +56,7 @@ jobs:
           cache: 'yarn'
       - name: Install dependencies with Yarn
         run: yarn install --immutable
-      - name: Build TypeScript
+      - name: Generate docs
         run: yarn run docs
       - name: Upload compiled TypeScript
         uses: actions/upload-artifact@v2
@@ -134,8 +141,8 @@ jobs:
           cache: 'yarn'
       - name: Install dependencies with Yarn
         run: yarn install --immutable
-      - name: Build TypeScript
-        run: yarn run build
+      - name: Generate typings
+        run: yarn run types
       - name: Validate API
         run: yarn run validate-api
   release:
@@ -162,12 +169,14 @@ jobs:
           cache: 'yarn'
       - name: Install dependencies with Yarn
         run: yarn install --immutable
+      - name: Build WASM
+        run: yarn run asbuild
       - name: Build TypeScript
         run: yarn run build
+      - name: Generate typings
+        run: yarn run types
       - name: Generate .d.ts rollup
         run: yarn run validate-api
-      - name: Build WASM
-        run: yarn run asbuild
       - name: Release
         run: yarn run release
         env:

.gitignore

@@ -244,3 +244,6 @@ $RECYCLE.BIN/
 
 # Generated documentation
 /docs_out
+
+# Generated typings
+/tsc_types

.prettierignore

@@ -232,9 +232,12 @@ assembly/hash*.ts
 # Autogenerated
 src/types/wasm-raw.ts
 
-# Generated documentation
-/docs_out
-
 # API Extractor
 /temp
 /docs/api.md
+
+# Generated documentation
+/docs_out
+
+# Generated typings
+/tsc_types

api-extractor.json

@@ -45,7 +45,7 @@
 	 *
 	 * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
 	 */
-	"mainEntryPointFilePath": "<projectFolder>/dist/src/index.d.ts",
+	"mainEntryPointFilePath": "<projectFolder>/tsc_types/src/index.d.ts",
 
 	/**
 	 * A list of NPM package names whose exports should be treated as part of this package.

docs/api.md

@@ -6,10 +6,8 @@
 
 /// <reference types="node" />
 
-import { Buffer as Buffer_2 } from 'node:buffer';
-
 // @public
-function hash32(key: ArrayBufferLike, seed: number): Buffer_2;
+function hash32(key: ArrayBufferLike, seed: number): Buffer;
 
 declare namespace MurmurHash3 {
     export {

jest.config.js

@@ -80,7 +80,9 @@ module.exports = {
 	// ],
 
 	// A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
-	// moduleNameMapper: {},
+	moduleNameMapper: {
+		'mod.wasm': '<rootDir>/test/wasm.js',
+	},
 
 	// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
 	// modulePathIgnorePatterns: [],

package.json

@@ -1,12 +1,14 @@
 {
 	"name": "murmurhash-wasm",
 	"version": "0.0.0-development",
-	"description": "MurmurHash implementations in WASM",
+	"description": "MurmurHash in WASM for Node.js and the browser",
 	"keywords": [
 		"murmurhash",
 		"murmurhash3",
 		"crypto",
-		"wasm"
+		"wasm",
+		"hashing",
+		"hash"
 	],
 	"homepage": "https://murmurhash-wasm.jonah.pw",
 	"bugs": {
@@ -24,28 +26,36 @@
 	},
 	"sideEffects": false,
 	"type": "commonjs",
-	"exports": "./dist/src/index.js",
-	"main": "./dist/src/index.js",
-	"types": "./dist/src/index.d.ts",
+	"exports": {
+		"node": "./dist/node.cjs",
+		"default": "./dist/index.js",
+		"import": "./dist/index.mjs",
+		"require": "./dist/index.js"
+	},
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
 	"files": [
 		"dist",
-		"!dist/test",
-		"!dist/**/*.d.ts",
-		"dist/index.d.ts",
-		"wasm"
+		"wasm/mod.wat"
 	],
 	"scripts": {
 		"asbuild": "yarn asbuild:optimized",
 		"asbuild:optimized": "asc assembly/index.ts --target release",
 		"asbuild:untouched": "asc assembly/index.ts --target debug",
 		"prebuild": "rm -rf dist",
-		"build": "yarn run prebuild && tsc",
+		"build": "yarn build:esm && yarn build:cjs && yarn build:node",
+		"build:base": "esbuild --bundle --loader:.wasm=binary --external:@assemblyscript/loader src/index.ts --sourcemap=inline",
+		"build:cjs": "yarn run build:base --outfile=dist/index.js --format=cjs",
+		"build:esm": "yarn run build:base --outfile=dist/index.mjs --format=esm",
+		"build:node": "yarn run build:base --outfile=dist/node.cjs --format=cjs --target=node16.9.0 ",
 		"docs": "typedoc",
 		"lint": "xo",
 		"release": "semantic-release",
 		"style": "prettier --check .",
 		"test": "jest",
 		"test:coverage": "jest --coverage",
+		"pretypes": "rm -rf tsc_types",
+		"types": "tsc",
 		"validate-api": "api-extractor run",
 		"validate-api:local": "api-extractor run --local --verbose"
 	},
@@ -66,6 +76,7 @@
 		"assemblyscript": "0.19.22",
 		"babel-jest": "27.4.6",
 		"enhanced-resolve": "5.8.3",
+		"esbuild": "0.14.11",
 		"jest": "27.4.7",
 		"prettier": "2.5.1",
 		"semantic-release": "18.0.1",

readme.md

@@ -4,10 +4,12 @@
 [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)
 [![codecov](https://codecov.io/gh/jonahsnider/murmurhash-wasm/branch/main/graph/badge.svg)](https://codecov.io/jonahsnider/murmurhash-wasm)
 
-MurmurHash implementations in WASM.
+MurmurHash in WASM for Node.js and the browser.
 
 Generated documentation is here: <https://murmurhash-wasm.jonah.pw>.
 
+The WASM is inlined into the JS file to prevent issues from loading the module.
+
 ## Usage
 
 ### MurmurHash3
@@ -35,3 +37,7 @@ npm install murmurhash-wasm
 # or
 yarn add murmurhash-wasm
 ```
+
+### Browsers
+
+When running in the browser you will to polyfill `Buffer`.

src/murmur-hash3/hash-32.ts

@@ -1,7 +1,5 @@
 /* eslint-disable no-bitwise */
 
-import assert from 'assert/strict';
-import {Buffer} from 'buffer';
 import {UINT32_MAX_VALUE} from '../constants';
 import {wasm} from '../wasm';
 
@@ -31,11 +29,9 @@ import {wasm} from '../wasm';
  * @public
  */
 export function hash32(key: ArrayBufferLike, seed: number): Buffer {
-	assert.equal(
-		seed >= 0 && seed <= UINT32_MAX_VALUE,
-		true,
-		new RangeError(`The value of "value" is out of range. It must be >= 0 and <= ${UINT32_MAX_VALUE}.`),
-	);
+	if (seed < 0 || seed > UINT32_MAX_VALUE) {
+		throw new RangeError(`The value of "value" is out of range. It must be >= 0 and <= ${UINT32_MAX_VALUE}.`);
+	}
 
 	const keyPointer = wasm.__pin(wasm.__newArrayBuffer(key));
 

src/wasm.ts

@@ -1,16 +1,7 @@
-import fs from 'fs';
-import path from 'path';
 import {instantiateSync} from '@assemblyscript/loader';
+import wasmBuffer from '../wasm/mod.wasm';
 import type * as Wasm from './types/wasm.js';
 
-let PROJECT_ROOT = path.join(__dirname, '..');
-
-if (path.basename(PROJECT_ROOT) === 'dist') {
-	PROJECT_ROOT = path.join(PROJECT_ROOT, '..');
-}
-
-const WASM_PATH = path.join(PROJECT_ROOT, 'wasm', 'mod.wasm');
-
-const wasmModule = instantiateSync<Wasm.Exports>(fs.readFileSync(WASM_PATH));
+const wasmModule = instantiateSync<Wasm.Exports>(wasmBuffer);
 
 export const wasm = wasmModule.exports;