@arcjet/stable-hash 1.0.0-beta.10 → 1.0.0-beta.12

package/README.md

@@ -63,6 +63,12 @@ console.log(id);
 
 [Apache License, Version 2.0][apache-license] © [Arcjet Labs, Inc.][arcjet]
 
+Derivative work based on [`feross/buffer`][github-buffer] licensed under
+[MIT][github-buffer-license] © Feross Aboukhadijeh and contributors.
+Our work picks its internal hex encoding logic adjusted for our use.
+
 [apache-license]: http://www.apache.org/licenses/LICENSE-2.0
 [arcjet]: https://arcjet.com
 [arcjet-get-started]: https://docs.arcjet.com/get-started
+[github-buffer-license]: https://github.com/feross/buffer/blob/5857e295f4d37e3ad02c3abcbf7e8e5ef51f3be6/LICENSE
+[github-buffer]: https://github.com/feross/buffer/tree/5857e295f4d37e3ad02c3abcbf7e8e5ef51f3be6

package/edge-light.js

@@ -1,6 +1,10 @@
 import { makeHasher } from './hasher.js';
 export { bool, string, stringSliceOrdered, uint32 } from './hasher.js';
 
+// @ts-ignore: this value exists in Edge Light, as it implements the DOM type for it.
+// See <https://vercel.com/docs/functions/runtimes/edge#crypto-apis>.
+// This can be verified by adding `/// <reference lib="dom" />` above.
+// But we don’t want to load the entire DOM types or edge-light-specific types.
 const hash = makeHasher(crypto.subtle);
 
 export { hash, makeHasher };

package/hasher.d.ts

@@ -1,13 +1,75 @@
+/**
+ * Writer.
+ */
 export interface StringWriter {
+    /**
+     * Write data.
+     *
+     * @param data
+     *   Value.
+     */
     writeString(data: string): void;
 }
 interface SubtleCryptoLike {
-    digest(algorithm: AlgorithmIdentifier, data: BufferSource): Promise<ArrayBuffer>;
+    digest(algorithm: {
+        name: string;
+    } | string, data: ArrayBufferView<ArrayBufferLike> | ArrayBufferLike): Promise<ArrayBuffer>;
 }
+/**
+ * Hash a field.
+ */
 export type FieldHasher = (data: StringWriter) => void;
+/**
+ * Create a hasher for a boolean.
+ *
+ * @param key
+ *   Key.
+ * @param value
+ *   Value.
+ * @returns
+ *   Hasher.
+ */
 export declare function bool(key: string, value: boolean): FieldHasher;
+/**
+ * Create a hasher for an unsigned 32-bit integer.
+ *
+ * @param key
+ *   Key.
+ * @param value
+ *   Value.
+ * @returns
+ *   Hasher.
+ */
 export declare function uint32(key: string, value: number): FieldHasher;
+/**
+ * Create a hasher for a string.
+ *
+ * @param key
+ *   Key.
+ * @param value
+ *   Value.
+ * @returns
+ *   Hasher.
+ */
 export declare function string(key: string, value: string): FieldHasher;
+/**
+ * Create a hasher for an array of strings.
+ *
+ * @param key
+ *   Key.
+ * @param values
+ *   Values.
+ * @returns
+ *   Hasher.
+ */
 export declare function stringSliceOrdered(key: string, values: string[]): FieldHasher;
+/**
+ * Create a hasher.
+ *
+ * @param subtle
+ *   Subtle crypto.
+ * @returns
+ *   Hasher.
+ */
 export declare function makeHasher(subtle: SubtleCryptoLike): (...hashers: FieldHasher[]) => Promise<string>;
 export {};

package/hasher.js

@@ -20,6 +20,16 @@ class Sha256 {
 const maxUint32 = 4294967295;
 const fieldSeparator = ":";
 const itemSeparator = ",";
+/**
+ * Create a hasher for a boolean.
+ *
+ * @param key
+ *   Key.
+ * @param value
+ *   Value.
+ * @returns
+ *   Hasher.
+ */
 function bool(key, value) {
     return (data) => {
         data.writeString(key);
@@ -32,6 +42,16 @@ function bool(key, value) {
         }
     };
 }
+/**
+ * Create a hasher for an unsigned 32-bit integer.
+ *
+ * @param key
+ *   Key.
+ * @param value
+ *   Value.
+ * @returns
+ *   Hasher.
+ */
 function uint32(key, value) {
     return (data) => {
         data.writeString(key);
@@ -44,6 +64,16 @@ function uint32(key, value) {
         }
     };
 }
+/**
+ * Create a hasher for a string.
+ *
+ * @param key
+ *   Key.
+ * @param value
+ *   Value.
+ * @returns
+ *   Hasher.
+ */
 function string(key, value) {
     return (data) => {
         data.writeString(key);
@@ -53,6 +83,16 @@ function string(key, value) {
         data.writeString(`"`);
     };
 }
+/**
+ * Create a hasher for an array of strings.
+ *
+ * @param key
+ *   Key.
+ * @param values
+ *   Values.
+ * @returns
+ *   Hasher.
+ */
 function stringSliceOrdered(key, values) {
     return (data) => {
         data.writeString(key);
@@ -67,7 +107,23 @@ function stringSliceOrdered(key, values) {
         data.writeString("]");
     };
 }
+/**
+ * Create a hasher.
+ *
+ * @param subtle
+ *   Subtle crypto.
+ * @returns
+ *   Hasher.
+ */
 function makeHasher(subtle) {
+    /**
+     * Hash fields.
+     *
+     * @param hashers
+     *   Hashers.
+     * @returns
+     *   Promise to a hash.
+     */
     return async function hash(...hashers) {
         const h = new Sha256(subtle);
         for (const hasher of hashers) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcjet/stable-hash",
-  "version": "1.0.0-beta.10",
+  "version": "1.0.0-beta.12",
   "description": "Arcjet stable hashing utility",
   "keywords": [
     "arcjet",
@@ -32,6 +32,7 @@
   "types": "./index.d.ts",
   "exports": {
     "edge-light": "./edge-light.js",
+    "workerd": "./workerd.js",
     "default": "./index.js"
   },
   "files": [
@@ -40,7 +41,9 @@
     "hasher.d.ts",
     "hasher.js",
     "index.d.ts",
-    "index.js"
+    "index.js",
+    "workerd.d.ts",
+    "workerd.js"
   ],
   "scripts": {
     "build": "rollup --config rollup.config.js",
@@ -52,12 +55,11 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@arcjet/eslint-config": "1.0.0-beta.10",
-    "@arcjet/rollup-config": "1.0.0-beta.10",
-    "@arcjet/tsconfig": "1.0.0-beta.10",
-    "@rollup/wasm-node": "4.46.2",
-    "@types/node": "18.18.0",
-    "eslint": "9.32.0",
+    "@arcjet/eslint-config": "1.0.0-beta.12",
+    "@arcjet/rollup-config": "1.0.0-beta.12",
+    "@rollup/wasm-node": "4.50.0",
+    "@types/node": "24.3.0",
+    "eslint": "9.34.0",
     "typescript": "5.9.2"
   },
   "publishConfig": {

package/workerd.d.ts

@@ -0,0 +1,2 @@
+export * from "./hasher.js";
+export declare const hash: (...hashers: import("./hasher.js").FieldHasher[]) => Promise<string>;

package/workerd.js

@@ -0,0 +1,10 @@
+import { makeHasher } from './hasher.js';
+export { bool, string, stringSliceOrdered, uint32 } from './hasher.js';
+
+// @ts-ignore: this value exists in Workerd, as it implements the DOM type for it.
+// See <https://developers.cloudflare.com/workers/runtime-apis/web-crypto/>.
+// This can be verified by adding `/// <reference lib="dom" />` above.
+// But we don’t want to load the entire DOM types or workerd-specific types.
+const hash = makeHasher(crypto.subtle);
+
+export { hash, makeHasher };