fix: module name highwayhasher

asonnleitner · Mar 1, 2022 · 4abe1c5 · 4abe1c5
1 parent 13fb46a
commit 4abe1c5
Show file tree

Hide file tree

Showing 24 changed files with 76 additions and 174 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-![highway-wasm](./docs/preview.png)
+![highwayhash-wasm](./docs/preview.png)
 
-# highway-wasm
+# highwayhash-wasm
 
 [![npm version][npm-version-src]][npm-href]
 [![npm downloads][npm-downloads-src]][npm-href]
@@ -22,17 +22,17 @@
 
 ## Install
 
-Add `highway-wasm` dependency to your project:
+Add `highwayhash-wasm` dependency to your project:
 
 ```shell
 # using npm
-npm i highway-wasm
+npm i highwayhash-wasm
 
 # using yarn
-yarn add highway-wasm
+yarn add highwayhash-wasm
 
 # using pnpm
-pnpm add highway-wasm
+pnpm add highwayhash-wasm
 ```
 
 ## Usage
@@ -41,16 +41,16 @@ Use this method to generate hashes is the length of the data is not known in adv
 
 ```javascript
 // import the library using esm or cjs syntax
-import { useHighway } from 'highway-wasm'
-const { useHighway } = require('highway-wasm')
+import { useHighwayHash } from 'highwayhash-wasm'
+const { useHighwayHash } = require('highwayhash-wasm')
 
 // Some 32 byte key
 const key = new Uint8Array(32).fill(8)
 // Some data to hash
 const data = Uint8Array.from([0])
 
 // Load the wasm module which returns the the Highway object
-const highway = await useHighway({
+const highway = await useHighwayHash({
   // Optional: pass a key and keep it hidden from attackers to ensure
   // unpredictability, and attackers can't mount a DoS attack
   key: key,
@@ -133,10 +133,10 @@ const hash = hasher.hash64(key, data).toBigUint64Array()
 
 
 <!-- badges -->
-[npm-version-src]: https://badgen.net/npm/v/highway-wasm
-[npm-href]: https://www.npmjs.com/package/highway-wasm
-[npm-downloads-src]: https://badgen.net/npm/dm/highway-wasm
-[github-actions-ci-src]: https://github.com/asonnleitner/highway-wasm/actions/workflows/ci.yaml/badge.svg
-[github-actions-ci-href]: https://github.com/asonnleitner/highway-wasm/actions/workflows/ci.yaml
+[npm-version-src]: https://badgen.net/npm/v/highwayhash-wasm
+[npm-href]: https://www.npmjs.com/package/highwayhash-wasm
+[npm-downloads-src]: https://badgen.net/npm/dm/highwayhash-wasm
+[github-actions-ci-src]: https://github.com/asonnleitner/highwayhash-wasm/actions/workflows/ci.yaml/badge.svg
+[github-actions-ci-href]: https://github.com/asonnleitner/highwayhash-wasm/actions/workflows/ci.yaml
 
-[license-src]: https://badgen.net/npm/license/highway-wasm
+[license-src]: https://badgen.net/npm/license/highwayhash-wasm
diff --git a/api-extractor.json b/api-extractor.json
@@ -1,7 +1,7 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
   "projectFolder": ".",
-  "mainEntryPointFilePath": "<projectFolder>/js/highway-wasm/src/index.d.ts",
+  "mainEntryPointFilePath": "<projectFolder>/js/highwayhash-wasm/src/index.d.ts",
   "bundledPackages": [],
   "compiler": {
     "tsconfigFilePath": "<projectFolder>/tsconfig.json"

diff --git a/dist/highway-wasm.cjs.js b/dist/highway-wasm.cjs.js
diff --git a/dist/highway-wasm.d.ts b/dist/highway-wasm.d.ts
diff --git a/dist/highway-wasm.esm.js b/dist/highway-wasm.esm.js
diff --git a/dist/highway-wasm.global.js b/dist/highway-wasm.global.js
diff --git a/docs/preview.png b/docs/preview.png
diff --git a/highway/Cargo.toml b/highway/Cargo.toml
@@ -1,9 +1,9 @@
 [package]
-name = "highway"
+name = "highwayhash"
 version = "0.1.0"
 authors = ["asonnleitner <andreassonnleitner@gmail.com>"]
 description = "A wasm game of life implementation"
-repository = "https://github.com/asonnleitner/highway-wasm"
+repository = "https://github.com/asonnleitner/highwayhash-wasm"
 license = "MIT"
 edition = "2021"
 

diff --git a/highway/src/lib.rs b/highway/src/lib.rs
@@ -108,12 +108,12 @@ impl Hash {
 }
 
 #[wasm_bindgen]
-pub struct WasmHighway {
+pub struct WasmHighwayHash {
     hasher: HighwayHasher,
 }
 
 #[wasm_bindgen]
-impl WasmHighway {
+impl WasmHighwayHash {
     fn hasher(key: &[u8]) -> HighwayHasher {
         // console_error_panic_hook::set_once();
         return HighwayHasher::new(if key.is_empty() {
@@ -124,7 +124,7 @@ impl WasmHighway {
     }
 
     pub fn new(key: &[u8]) -> Self {
-        WasmHighway {
+        WasmHighwayHash {
             hasher: Self::hasher(key),
         }
     }

diff --git a/index.html b/index.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <title>highwayhash-wasm</title>
-  <script src="js/highway-wasm/dist/index.js"></script>
+  <script src="js/highwayhash-wasm/dist/index.js"></script>
 <!--    <script type="module" src="./packages/highway/src/index.ts"></script>-->
 <!--  <script src="./bootstrap.js"></script>-->
 </head>

diff --git a/jest.config.ts b/jest.config.ts
@@ -20,7 +20,7 @@ const config: InitialOptionsTsJest = {
   // transform: {
   //   '^.+\\.(ts|js)x?$': 'ts-jest'
   // },
-  // transformIgnorePatterns: ['js/highway-wasm/lib/(?!(highway|highway-simd))']
+  // transformIgnorePatterns: ['js/highwayhash-wasm/lib/(?!(highway|highway-simd))']
 }
 
 export default config
diff --git a/js/highway-wasm/src/index.d.ts b/js/highway-wasm/src/index.d.ts
diff --git a/js/highwayhash-wasm/src/index.d.ts b/js/highwayhash-wasm/src/index.d.ts
@@ -0,0 +1,17 @@
+import { WasmHighwayHash, Hash } from '../lib/highwayhash/highwayhash'
+
+export declare const useSimd: () => boolean
+
+interface HighwayHashOptions {
+  key?: Uint8Array
+  simd?: boolean
+}
+export declare const useHighwayHash: (options?: HighwayHashOptions) => Promise<{
+  hasher: typeof WasmHighwayHash
+  new: (key: Uint8Array) => WasmHighwayHash
+  hash64: (data: Uint8Array) => Hash
+  hash128: (data: Uint8Array) => Hash
+  hash256: (data: Uint8Array) => Hash
+}>
+
+export {}
diff --git a/js/highway-wasm/src/index.ts → js/highwayhash-wasm/src/index.ts b/js/highway-wasm/src/index.ts → js/highwayhash-wasm/src/index.ts
@@ -1,9 +1,11 @@
-import init, { WasmHighway as Highway } from '../lib/highway/highway.js'
-import { default as WASM } from '../lib/highway/highway_bg.wasm'
+import init, {
+  WasmHighwayHash as HighwayHash
+} from '../lib/highwayhash/highwayhash'
+import { default as WASM } from '../lib/highwayhash/highwayhash_bg.wasm'
 import initSimd, {
-  WasmHighway as HighwaySimd
-} from '../lib/highway-simd/highway-simd'
-import { default as simdWASM } from '../lib/highway-simd/highway-simd_bg.wasm'
+  WasmHighwayHash as HighwayHashSimd
+} from '../lib/highwayhash-simd/highwayhash-simd'
+import { default as simdWASM } from '../lib/highwayhash-simd/highwayhash-simd_bg.wasm'
 
 // https://github.com/GoogleChromeLabs/wasm-feature-detect/blob/master/src/detectors/simd/module.wat
 export const useSimd = () =>
@@ -14,7 +16,7 @@ export const useSimd = () =>
     ])
   )
 
-const useModule = (hasher: typeof Highway) => (key: Uint8Array) => {
+const useModule = (hasher: typeof HighwayHash) => (key: Uint8Array) => {
   if (key.length && key.length !== 32) throw new Error('Key must be 32 bytes')
 
   return {
@@ -43,15 +45,15 @@ interface HighwayOptions {
   simd?: boolean
 }
 
-export const useHighway = async (options?: HighwayOptions) => {
+export const useHighwayHash = async (options?: HighwayOptions) => {
   const simd =
     useSimd() && options && options.simd !== undefined
       ? Boolean(options.simd)
       : true
 
   console.log({ simd })
   simd ? await initSimd(simdWASM) : await init(WASM)
-  return useModule(simd ? HighwaySimd : Highway)(
+  return useModule(simd ? HighwayHashSimd : HighwayHash)(
     options && options.key ? options.key : Uint8Array.from({ length: 32 })
   )
 }
diff --git a/js/highway-wasm/src/use-key.ts → js/highwayhash-wasm/src/use-key.ts b/js/highway-wasm/src/use-key.ts → js/highwayhash-wasm/src/use-key.ts
diff --git a/js/index.ts b/js/index.ts
@@ -1,5 +1,5 @@
 // import the library
-import { useHighway } from 'highway-wasm'
+import { useHighwayHash } from 'highwayhash-wasm'
 
 // Load the wasm module
 const main = async () => {
@@ -9,7 +9,7 @@ const main = async () => {
   const data = Uint8Array.from([0])
 
   // Load the wasm module which returns the the Highway object
-  const highway = await useHighway({
+  const highway = await useHighwayHash({
     // Optional: pass a key and keep it hidden from attackers to ensure
     // unpredictability, and attackers can't mount a DoS attack
     key: key,

diff --git a/package.json b/package.json
@@ -1,18 +1,18 @@
 {
-  "name": "highway-wasm",
+  "name": "highwayhash-wasm",
   "version": "1.2.3",
   "description": "HighwayHash WASM bindings for browser and node environments",
   "author": "Andreas Sonnleitner <asonnleitner@gmail.com>",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git://github.com:asonnleitner/highway-wasm.git"
+    "url": "git://github.com:asonnleitner/highwayhash-wasm.git"
   },
-  "main": "dist/highway-wasm.cjs.js",
-  "module": "dist/highway-wasm.esm.js",
-  "unpkg": "dist/highway-wasm.global.js",
-  "jsdelivr": "dist/highway-wasm.global.js",
-  "types": "dist/highway-wasm.d.ts",
+  "main": "dist/highwayhash-wasm.cjs.js",
+  "module": "dist/highwayhash-wasm.esm.js",
+  "unpkg": "dist/highwayhash-wasm.global.js",
+  "jsdelivr": "dist/highwayhash-wasm.global.js",
+  "types": "dist/highwayhash-wasm.d.ts",
   "files": [
     "dist"
   ],
@@ -25,11 +25,11 @@
     "build": "pnpm clean && pnpm optimized-build:wasm && pnpm build:js && pnpm make-types",
     "make-types": "api-extractor run --local --verbose",
     "build:js": "pnpm build:esm && pnpm build:cjs && pnpm build:global",
-    "build:esm": "ts-node scripts/build.ts highway-wasm -f esm",
-    "build:cjs": "ts-node scripts/build.ts highway-wasm -f cjs",
-    "build:global": "ts-node scripts/build.ts highway-wasm -f global",
+    "build:esm": "ts-node scripts/build.ts highwayhash-wasm -f esm",
+    "build:cjs": "ts-node scripts/build.ts highwayhash-wasm -f cjs",
+    "build:global": "ts-node scripts/build.ts highwayhash-wasm -f global",
     "optimized-build:wasm": "scripts/build && scripts/optimize",
-    "clean": "rm -rf dist/* && rm -rf js/highway-wasm/lib/*",
+    "clean": "rm -rf dist/* && rm -rf js/highwayhash-wasm/lib/*",
     "prepare": "husky install"
   },
   "lint-staged": {

diff --git a/release.config.js b/release.config.js
@@ -1,6 +1,6 @@
 module.exports = {
   branches: 'master',
-  repositoryUrl: 'https://github.com/asonnleitner/highway-wasm',
+  repositoryUrl: 'https://github.com/asonnleitner/highwayhash-wasm',
   plugins: [
     '@semantic-release/commit-analyzer',
     '@semantic-release/release-notes-generator',
@@ -16,7 +16,7 @@ module.exports = {
       {
         assets: [
           {
-            path: 'highway-wasm/dist.tar.gz',
+            path: 'highwayhash-wasm/dist.tar.gz',
             label: 'dist'
           }
         ]

diff --git a/scripts/build b/scripts/build
@@ -22,8 +22,8 @@ function build() {
 }
 
 function main() {
-  build "highway" "${ROOT_DIR}/js/highway-wasm/lib/highway"
-  RUSTFLAGS="-C target-feature=+simd128" build "highway-simd" "${ROOT_DIR}/js/highway-wasm/lib/highway-simd"
+  build "highwayhash" "${ROOT_DIR}/js/highwayhash-wasm/lib/highwayhash"
+  RUSTFLAGS="-C target-feature=+simd128" build "highwayhash-simd" "${ROOT_DIR}/js/highwayhash-wasm/lib/highwayhash-simd"
 }
 
 main "$@"