@pixagram/pixahash 0.1.0

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@pixagram/pixahash",
+  "version": "0.1.0",
+  "description": "Fast WASM-optimized non-cryptographic hash (fingerprint) tuned for 5-30 kB payloads. Flexible output: uint32, uint64, 128-bit, up to a 256-bit digest as raw bytes, hex, or base58btc. Sync + auto-init async API plus an isomorphic worker pool for data-parallel hashing.",
+  "type": "module",
+  "main": "./index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js"
+    },
+    "./pool": {
+      "types": "./index.d.ts",
+      "import": "./pool.js"
+    },
+    "./worker": "./worker.js",
+    "./load": "./load.js",
+    "./wasm": "./pkg/pixahash.js"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "load.js",
+    "worker.js",
+    "pool.js",
+    "pkg/pixahash.js",
+    "pkg/pixahash.d.ts",
+    "pkg/pixahash_bg.wasm",
+    "pkg/pixahash_bg.wasm.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "bash build.sh",
+    "test": "node test-node.mjs"
+  },
+  "keywords": [
+    "hash",
+    "hashing",
+    "non-cryptographic",
+    "fingerprint",
+    "checksum",
+    "wasm",
+    "webassembly",
+    "rust",
+    "xxhash",
+    "rapidhash",
+    "museair",
+    "base58",
+    "hex",
+    "worker",
+    "parallel",
+    "pixagram"
+  ],
+  "author": "Pixagram SA",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pixagram/pixahash"
+  }
+}

package/pkg/pixahash.d.ts

@@ -0,0 +1,97 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Incremental hasher, exported to JS as a class.
+ */
+export class Hasher {
+    free(): void;
+    [Symbol.dispose](): void;
+    digest32(): number;
+    digest64(): bigint;
+    digestBase58(bits: number): string;
+    digestHex(bits: number): string;
+    constructor(seed: bigint);
+    update(data: Uint8Array): void;
+}
+
+/**
+ * The full 32-byte digest.
+ */
+export function digest(data: Uint8Array, seed: bigint): Uint8Array;
+
+/**
+ * 128-bit hash as a 32-char hex string.
+ */
+export function hash128Hex(data: Uint8Array, seed: bigint): string;
+
+/**
+ * 32-bit hash as a JS number.
+ */
+export function hash32(data: Uint8Array, seed: number): number;
+
+/**
+ * 64-bit hash as a JS BigInt.
+ */
+export function hash64(data: Uint8Array, seed: bigint): bigint;
+
+/**
+ * 64-bit hash as a 16-char hex string.
+ */
+export function hash64Hex(data: Uint8Array, seed: bigint): string;
+
+/**
+ * base58btc string of the first `bits` bits of the digest (bits in 1..=256).
+ */
+export function hashBase58(data: Uint8Array, seed: bigint, bits: number): string;
+
+/**
+ * Hex string of the first `bits` bits of the digest (bits in 1..=256).
+ */
+export function hashHex(data: Uint8Array, seed: bigint, bits: number): string;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_hasher_free: (a: number, b: number) => void;
+    readonly digest: (a: number, b: number, c: bigint) => [number, number];
+    readonly hash128Hex: (a: number, b: number, c: bigint) => [number, number];
+    readonly hash32: (a: number, b: number, c: number) => number;
+    readonly hash64: (a: number, b: number, c: bigint) => bigint;
+    readonly hash64Hex: (a: number, b: number, c: bigint) => [number, number];
+    readonly hashBase58: (a: number, b: number, c: bigint, d: number) => [number, number];
+    readonly hashHex: (a: number, b: number, c: bigint, d: number) => [number, number];
+    readonly hasher_digest32: (a: number) => number;
+    readonly hasher_digest64: (a: number) => bigint;
+    readonly hasher_digestBase58: (a: number, b: number) => [number, number];
+    readonly hasher_digestHex: (a: number, b: number) => [number, number];
+    readonly hasher_new: (a: bigint) => number;
+    readonly hasher_update: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;

package/pkg/pixahash.js

@@ -0,0 +1,366 @@
+/* @ts-self-types="./pixahash.d.ts" */
+
+/**
+ * Incremental hasher, exported to JS as a class.
+ */
+export class Hasher {
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        HasherFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_hasher_free(ptr, 0);
+    }
+    /**
+     * @returns {number}
+     */
+    digest32() {
+        const ret = wasm.hasher_digest32(this.__wbg_ptr);
+        return ret >>> 0;
+    }
+    /**
+     * @returns {bigint}
+     */
+    digest64() {
+        const ret = wasm.hasher_digest64(this.__wbg_ptr);
+        return BigInt.asUintN(64, ret);
+    }
+    /**
+     * @param {number} bits
+     * @returns {string}
+     */
+    digestBase58(bits) {
+        let deferred1_0;
+        let deferred1_1;
+        try {
+            const ret = wasm.hasher_digestBase58(this.__wbg_ptr, bits);
+            deferred1_0 = ret[0];
+            deferred1_1 = ret[1];
+            return getStringFromWasm0(ret[0], ret[1]);
+        } finally {
+            wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+        }
+    }
+    /**
+     * @param {number} bits
+     * @returns {string}
+     */
+    digestHex(bits) {
+        let deferred1_0;
+        let deferred1_1;
+        try {
+            const ret = wasm.hasher_digestHex(this.__wbg_ptr, bits);
+            deferred1_0 = ret[0];
+            deferred1_1 = ret[1];
+            return getStringFromWasm0(ret[0], ret[1]);
+        } finally {
+            wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+        }
+    }
+    /**
+     * @param {bigint} seed
+     */
+    constructor(seed) {
+        const ret = wasm.hasher_new(seed);
+        this.__wbg_ptr = ret;
+        HasherFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+    /**
+     * @param {Uint8Array} data
+     */
+    update(data) {
+        const ptr0 = passArray8ToWasm0(data, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        wasm.hasher_update(this.__wbg_ptr, ptr0, len0);
+    }
+}
+if (Symbol.dispose) Hasher.prototype[Symbol.dispose] = Hasher.prototype.free;
+
+/**
+ * The full 32-byte digest.
+ * @param {Uint8Array} data
+ * @param {bigint} seed
+ * @returns {Uint8Array}
+ */
+export function digest(data, seed) {
+    const ptr0 = passArray8ToWasm0(data, wasm.__wbindgen_malloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ret = wasm.digest(ptr0, len0, seed);
+    var v2 = getArrayU8FromWasm0(ret[0], ret[1]).slice();
+    wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
+    return v2;
+}
+
+/**
+ * 128-bit hash as a 32-char hex string.
+ * @param {Uint8Array} data
+ * @param {bigint} seed
+ * @returns {string}
+ */
+export function hash128Hex(data, seed) {
+    let deferred2_0;
+    let deferred2_1;
+    try {
+        const ptr0 = passArray8ToWasm0(data, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.hash128Hex(ptr0, len0, seed);
+        deferred2_0 = ret[0];
+        deferred2_1 = ret[1];
+        return getStringFromWasm0(ret[0], ret[1]);
+    } finally {
+        wasm.__wbindgen_free(deferred2_0, deferred2_1, 1);
+    }
+}
+
+/**
+ * 32-bit hash as a JS number.
+ * @param {Uint8Array} data
+ * @param {number} seed
+ * @returns {number}
+ */
+export function hash32(data, seed) {
+    const ptr0 = passArray8ToWasm0(data, wasm.__wbindgen_malloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ret = wasm.hash32(ptr0, len0, seed);
+    return ret >>> 0;
+}
+
+/**
+ * 64-bit hash as a JS BigInt.
+ * @param {Uint8Array} data
+ * @param {bigint} seed
+ * @returns {bigint}
+ */
+export function hash64(data, seed) {
+    const ptr0 = passArray8ToWasm0(data, wasm.__wbindgen_malloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ret = wasm.hash64(ptr0, len0, seed);
+    return BigInt.asUintN(64, ret);
+}
+
+/**
+ * 64-bit hash as a 16-char hex string.
+ * @param {Uint8Array} data
+ * @param {bigint} seed
+ * @returns {string}
+ */
+export function hash64Hex(data, seed) {
+    let deferred2_0;
+    let deferred2_1;
+    try {
+        const ptr0 = passArray8ToWasm0(data, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.hash64Hex(ptr0, len0, seed);
+        deferred2_0 = ret[0];
+        deferred2_1 = ret[1];
+        return getStringFromWasm0(ret[0], ret[1]);
+    } finally {
+        wasm.__wbindgen_free(deferred2_0, deferred2_1, 1);
+    }
+}
+
+/**
+ * base58btc string of the first `bits` bits of the digest (bits in 1..=256).
+ * @param {Uint8Array} data
+ * @param {bigint} seed
+ * @param {number} bits
+ * @returns {string}
+ */
+export function hashBase58(data, seed, bits) {
+    let deferred2_0;
+    let deferred2_1;
+    try {
+        const ptr0 = passArray8ToWasm0(data, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.hashBase58(ptr0, len0, seed, bits);
+        deferred2_0 = ret[0];
+        deferred2_1 = ret[1];
+        return getStringFromWasm0(ret[0], ret[1]);
+    } finally {
+        wasm.__wbindgen_free(deferred2_0, deferred2_1, 1);
+    }
+}
+
+/**
+ * Hex string of the first `bits` bits of the digest (bits in 1..=256).
+ * @param {Uint8Array} data
+ * @param {bigint} seed
+ * @param {number} bits
+ * @returns {string}
+ */
+export function hashHex(data, seed, bits) {
+    let deferred2_0;
+    let deferred2_1;
+    try {
+        const ptr0 = passArray8ToWasm0(data, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.hashHex(ptr0, len0, seed, bits);
+        deferred2_0 = ret[0];
+        deferred2_1 = ret[1];
+        return getStringFromWasm0(ret[0], ret[1]);
+    } finally {
+        wasm.__wbindgen_free(deferred2_0, deferred2_1, 1);
+    }
+}
+function __wbg_get_imports() {
+    const import0 = {
+        __proto__: null,
+        __wbg___wbindgen_throw_1506f2235d1bdba0: function(arg0, arg1) {
+            throw new Error(getStringFromWasm0(arg0, arg1));
+        },
+        __wbindgen_init_externref_table: function() {
+            const table = wasm.__wbindgen_externrefs;
+            const offset = table.grow(4);
+            table.set(0, undefined);
+            table.set(offset + 0, undefined);
+            table.set(offset + 1, null);
+            table.set(offset + 2, true);
+            table.set(offset + 3, false);
+        },
+    };
+    return {
+        __proto__: null,
+        "./pixahash_bg.js": import0,
+    };
+}
+
+const HasherFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_hasher_free(ptr, 1));
+
+function getArrayU8FromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return getUint8ArrayMemory0().subarray(ptr / 1, ptr / 1 + len);
+}
+
+function getStringFromWasm0(ptr, len) {
+    return decodeText(ptr >>> 0, len);
+}
+
+let cachedUint8ArrayMemory0 = null;
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachedUint8ArrayMemory0;
+}
+
+function passArray8ToWasm0(arg, malloc) {
+    const ptr = malloc(arg.length * 1, 1) >>> 0;
+    getUint8ArrayMemory0().set(arg, ptr / 1);
+    WASM_VECTOR_LEN = arg.length;
+    return ptr;
+}
+
+let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+cachedTextDecoder.decode();
+const MAX_SAFARI_DECODE_BYTES = 2146435072;
+let numBytesDecoded = 0;
+function decodeText(ptr, len) {
+    numBytesDecoded += len;
+    if (numBytesDecoded >= MAX_SAFARI_DECODE_BYTES) {
+        cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+        cachedTextDecoder.decode();
+        numBytesDecoded = len;
+    }
+    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
+let WASM_VECTOR_LEN = 0;
+
+let wasmModule, wasmInstance, wasm;
+function __wbg_finalize_init(instance, module) {
+    wasmInstance = instance;
+    wasm = instance.exports;
+    wasmModule = module;
+    cachedUint8ArrayMemory0 = null;
+    wasm.__wbindgen_start();
+    return wasm;
+}
+
+async function __wbg_load(module, imports) {
+    if (typeof Response === 'function' && module instanceof Response) {
+        if (typeof WebAssembly.instantiateStreaming === 'function') {
+            try {
+                return await WebAssembly.instantiateStreaming(module, imports);
+            } catch (e) {
+                const validResponse = module.ok && expectedResponseType(module.type);
+
+                if (validResponse && module.headers.get('Content-Type') !== 'application/wasm') {
+                    console.warn("`WebAssembly.instantiateStreaming` failed because your server does not serve Wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n", e);
+
+                } else { throw e; }
+            }
+        }
+
+        const bytes = await module.arrayBuffer();
+        return await WebAssembly.instantiate(bytes, imports);
+    } else {
+        const instance = await WebAssembly.instantiate(module, imports);
+
+        if (instance instanceof WebAssembly.Instance) {
+            return { instance, module };
+        } else {
+            return instance;
+        }
+    }
+
+    function expectedResponseType(type) {
+        switch (type) {
+            case 'basic': case 'cors': case 'default': return true;
+        }
+        return false;
+    }
+}
+
+function initSync(module) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (module !== undefined) {
+        if (Object.getPrototypeOf(module) === Object.prototype) {
+            ({module} = module)
+        } else {
+            console.warn('using deprecated parameters for `initSync()`; pass a single object instead')
+        }
+    }
+
+    const imports = __wbg_get_imports();
+    if (!(module instanceof WebAssembly.Module)) {
+        module = new WebAssembly.Module(module);
+    }
+    const instance = new WebAssembly.Instance(module, imports);
+    return __wbg_finalize_init(instance, module);
+}
+
+async function __wbg_init(module_or_path) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (module_or_path !== undefined) {
+        if (Object.getPrototypeOf(module_or_path) === Object.prototype) {
+            ({module_or_path} = module_or_path)
+        } else {
+            console.warn('using deprecated parameters for the initialization function; pass a single object instead')
+        }
+    }
+
+    if (module_or_path === undefined) {
+        module_or_path = new URL('pixahash_bg.wasm', import.meta.url);
+    }
+    const imports = __wbg_get_imports();
+
+    if (typeof module_or_path === 'string' || (typeof Request === 'function' && module_or_path instanceof Request) || (typeof URL === 'function' && module_or_path instanceof URL)) {
+        module_or_path = fetch(module_or_path);
+    }
+
+    const { instance, module } = await __wbg_load(await module_or_path, imports);
+
+    return __wbg_finalize_init(instance, module);
+}
+
+export { initSync, __wbg_init as default };

package/pkg/pixahash_bg.wasm.d.ts

@@ -0,0 +1,21 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const __wbg_hasher_free: (a: number, b: number) => void;
+export const digest: (a: number, b: number, c: bigint) => [number, number];
+export const hash128Hex: (a: number, b: number, c: bigint) => [number, number];
+export const hash32: (a: number, b: number, c: number) => number;
+export const hash64: (a: number, b: number, c: bigint) => bigint;
+export const hash64Hex: (a: number, b: number, c: bigint) => [number, number];
+export const hashBase58: (a: number, b: number, c: bigint, d: number) => [number, number];
+export const hashHex: (a: number, b: number, c: bigint, d: number) => [number, number];
+export const hasher_digest32: (a: number) => number;
+export const hasher_digest64: (a: number) => bigint;
+export const hasher_digestBase58: (a: number, b: number) => [number, number];
+export const hasher_digestHex: (a: number, b: number) => [number, number];
+export const hasher_new: (a: bigint) => number;
+export const hasher_update: (a: number, b: number, c: number) => void;
+export const __wbindgen_externrefs: WebAssembly.Table;
+export const __wbindgen_malloc: (a: number, b: number) => number;
+export const __wbindgen_free: (a: number, b: number, c: number) => void;
+export const __wbindgen_start: () => void;