@harperfast/hnsw 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,88 @@
+# @harperfast/hnsw
+
+Persistent, incrementally-maintained, concurrently-searchable HNSW vector index for Node.js —
+a native (Rust) traversal engine over a memory-mapped fixed-slot graph file.
+
+Most HNSW libraries for Node either keep the graph in JS objects (slow per-visit cost, GC
+pressure) or wrap an in-memory C++ index with no durable incremental persistence. This one is
+built around a different contract:
+
+- **The file is the index.** One memory-mapped file per index: fixed-size node slots
+  (int8-quantized vector + neighbor ids, page-grouped so slots never straddle page
+  boundaries), an in-file upper-layer region, an id freelist, and a durability watermark.
+  Reopen is instant — no rebuild, no sidecars.
+- **Search never touches the JS event loop.** Queries run on the libuv thread pool with one
+  N-API crossing each; traversal is zero-copy against the mapping with SIMD (AVX2) int8
+  asymmetric-cosine distance.
+- **Reads and writes are genuinely concurrent.** Per-slot seqlocks, no global locks on the
+  search path. Measured on one Linux box at 1M × 768-d (ef 512): **6,300+ QPS aggregate
+  across 8 search threads while a writer sustains ~1,100 inserts/s**, p50 ≈ 1 ms.
+- **Incremental by design.** Insert, update in place, delete with neighbor repair; deleted
+  ids are reused via the freelist, so churn never inflates the graph. Reverse-edge overflow
+  uses coverage-aware pruning (a bounded RobustPrune) — measured recall\@10 of 0.999 at 1M
+  (768-d int8, ef 512) on a calibrated Gaussian-mixture corpus.
+- **Filtering built in.** Allow-bitset filtering (zero callbacks), or a JS predicate
+  evaluated in pipelined batches over a threadsafe function while traversal keeps expanding —
+  a busy event loop costs speculative overshoot, never search-thread stalls.
+- **Two integration modes.** Standalone (the library allocates ids and maintains the graph:
+  `insert`/`remove`/`search`), or mirroring (`writeNodeRaw`/`clearNode`: a host application
+  that already maintains an HNSW graph mirrors it in and gets the native search path —
+  this is how [Harper](https://github.com/HarperFast/harper) integrates it).
+
+Durability is deliberately relaxed: the file is msync'd on a cadence with a transaction
+watermark, and the intended recovery model is "replay indexing from the watermark" against
+the host's authoritative record store. Approximate indexes don't need per-commit fsyncs;
+they need cheap, bounded catch-up. See [DESIGN.md](DESIGN.md) for the format, the
+concurrency model, measured baselines, and the reasoning behind every trade.
+
+## Install & build
+
+```bash
+npm install @harperfast/hnsw
+```
+
+Prebuilds are not published yet: building requires a [Rust toolchain](https://rustup.rs)
+(`npm run build`, or automatically on install when cargo is available). Linux x86_64 is the
+performance target (AVX2); macOS works (scalar fallback); Windows is untested.
+
+## Usage
+
+```js
+const { Plane } = require('@harperfast/hnsw');
+
+const plane = Plane.create('/data/vectors.hnsw', 768, 128, 10_000_000);
+const id = plane.insert(myFloat32Vector);
+const hits = await plane.search(queryVector, 10, 512); // [{ id, distance }, ...]
+
+// filtered: allow-bitset over node ids
+const allowed = new Uint8Array(Math.ceil(plane.idHighWater() / 8));
+// ... set bits ...
+const filtered = await plane.search(queryVector, 10, 512, allowed);
+
+// or a JS predicate, batched off the event loop
+const predicated = await plane.searchWithPredicate(queryVector, 10, 512, (ids) =>
+	Uint8Array.from(ids, (id) => (isVisible(id) ? 1 : 0))
+);
+```
+
+Full API in [index.d.ts](index.d.ts).
+
+## Benchmarks
+
+`cargo run --release --bin bench -- 1000000 768 100 512 /tmp/bench.hnsw 128 8` builds a 1M ×
+768-d graph on a calibrated Gaussian-mixture corpus, reports p50/p95/p99, per-visit cost,
+brute-force recall\@10, and a concurrent-throughput pass. Numbers from the design work
+(Linux, single box): p50 0.75 ms, 0.33 µs/visit, recall\@10 0.999 — ~9× the wall-clock and
+~13× the per-visit cost of a well-optimized pure-JS implementation of the same graph at
+equal recall.
+
+## Status
+
+Extracted from the Harper vector-index engine; the format (v2) and API are young and may
+change with a major version + reindex. Roadmap: prebuilds, binary-quantized slot format
+(~4× smaller traversal plane), Matryoshka dimension truncation, mremap growth, index
+slicing with native top-k merge.
+
+## License
+
+Apache-2.0

package/build.mjs

@@ -0,0 +1,46 @@
+// Builds the NAPI module in place (`npm run build`). With --if-needed (the npm install hook),
+// a missing Rust toolchain or a failed build is a warning and exit 0 — consumers treat the
+// module as optional and fall back to their own path when the artifact is absent.
+import { execSync } from 'node:child_process';
+import { createRequire } from 'node:module';
+import { copyFileSync, existsSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const crateRoot = dirname(fileURLToPath(import.meta.url));
+const ifNeeded = process.argv.includes('--if-needed');
+const artifact = join(crateRoot, 'hnsw-plane.node');
+const prebuilt = join(crateRoot, 'prebuilds', `${process.platform}-${process.arch}`, 'hnsw-plane.node');
+
+// a prebuild satisfies --if-needed only if it actually LOADS on this system (a newer-glibc
+// artifact exists but throws at require; fall through to a local build in that case)
+function loads(path) {
+	if (!existsSync(path)) return false;
+	try {
+		createRequire(import.meta.url)(path);
+		return true;
+	} catch {
+		return false;
+	}
+}
+if (ifNeeded && (loads(artifact) || loads(prebuilt))) {
+	process.exit(0);
+}
+try {
+	// build the lib alone: the bench bin cannot link against unresolved node-api symbols
+	execSync('cargo build --release --features napi --lib', { cwd: crateRoot, stdio: 'inherit' });
+} catch (error) {
+	if (ifNeeded) {
+		console.warn('@harperfast/hnsw: no Rust toolchain or build failed; native module unavailable until `npm run build` succeeds');
+		process.exit(0);
+	}
+	throw error;
+}
+const cdylib =
+	process.platform === 'win32'
+		? 'hnsw_plane.dll'
+		: process.platform === 'darwin'
+			? 'libhnsw_plane.dylib'
+			: 'libhnsw_plane.so';
+copyFileSync(join(crateRoot, 'target', 'release', cdylib), artifact);
+console.log('built hnsw-plane.node');

package/build.rs

@@ -0,0 +1,6 @@
+fn main() {
+    // napi_build wires the node-api link args for the cdylib; only needed for the napi feature
+    if std::env::var("CARGO_FEATURE_NAPI").is_ok() {
+        napi_build::setup();
+    }
+}

package/index.d.ts

@@ -0,0 +1,104 @@
+export interface SearchHit {
+	id: number;
+	distance: number;
+}
+
+/**
+ * A persistent HNSW graph over a memory-mapped fixed-slot file. One file per index; searches
+ * run on the libuv thread pool (one N-API crossing per query) and never block the JS event
+ * loop. Vectors are int8-quantized with asymmetric (float query × int8 stored) cosine
+ * distance. See DESIGN.md for the file format, concurrency model, and durability contract.
+ */
+export declare class Plane {
+	/** Create a new plane file. `maxNodes` is a sparse reservation — pages materialize on write. */
+	static create(path: string, dims: number, layer0Cap: number, maxNodes: number): Plane;
+	/** Open an existing plane file (format-version mismatch throws: rebuild the index). */
+	static open(path: string): Plane;
+
+	/**
+	 * Insert a vector; returns the allocated node id (freed ids are reused). Throws on a
+	 * dimension mismatch or when the plane is full (maxNodes reached).
+	 */
+	insert(vector: Float32Array): number;
+	/** Delete a node; its id returns to the freelist. Pairs with insert(). */
+	remove(id: number): void;
+
+	/**
+	 * Async k-NN search. `filter` is an allow-bitset over node ids (bit i of byte i>>3);
+	 * filtered searches are visit-bounded by ef * filterExpansion (default 24).
+	 */
+	search(vector: Float32Array, k: number, ef: number, filter?: Uint8Array, filterExpansion?: number): Promise<Array<SearchHit>>;
+	/**
+	 * Async k-NN search with a JS predicate, evaluated in batches over a threadsafe function
+	 * while traversal keeps expanding (the search thread never blocks on the event loop).
+	 * The predicate returns one 0/1 byte per id. Do not await it from code the predicate
+	 * itself blocks on.
+	 */
+	searchWithPredicate(
+		vector: Float32Array,
+		k: number,
+		ef: number,
+		predicate: (ids: Array<number>) => Uint8Array,
+		filterExpansion?: number,
+		visitBudget?: number
+	): Promise<Array<SearchHit>>;
+	/** Synchronous search (benchmarks/tests; blocks the calling thread). */
+	searchSync(vector: Float32Array, k: number, ef: number): Array<SearchHit>;
+
+	/**
+	 * Mirror a host-maintained node into the plane (dual-write mode): full node state per
+	 * call, HOST-allocated id (the plane allocator is bypassed), int8 vector bin plus
+	 * quantization scale and cached 1/|v|, layer-0 neighbor ids, and per-upper-level
+	 * neighbor id arrays (level 1 first). An existing upper entry is rewritten in place.
+	 */
+	writeNodeRaw(
+		id: number,
+		level: number,
+		vector: Buffer,
+		scale: number,
+		invMag: number,
+		neighbors: Uint32Array,
+		upper?: Array<Uint32Array> | null
+	): void;
+	/** Mark a node deleted without touching the plane freelist (dual-write mode). */
+	clearNode(id: number): void;
+	/**
+	 * Builder-scan variant of writeNodeRaw: writes only when the slot has never been touched,
+	 * so a backfill scan of an older snapshot can never overwrite newer live-mirrored state.
+	 * Returns true when the scan's state was written.
+	 */
+	writeNodeRawIfAbsent(
+		id: number,
+		level: number,
+		vector: Buffer,
+		scale: number,
+		invMag: number,
+		neighbors: Uint32Array,
+		upper?: Array<Uint32Array> | null
+	): boolean;
+	/**
+	 * Advisory: whether the file recorded a durability barrier (flush) as its last state when
+	 * opened. Crash recovery does not depend on it — a per-slot lock abandoned by a dead
+	 * writer is taken over lazily at that slot by whoever waits past the takeover window.
+	 */
+	openedClean(): boolean;
+	/** Set the graph entry point (dual-write mode mirrors the host's entry updates). */
+	setEntryPoint(id: number, level: number): void;
+	getEntryPoint(): Array<number>;
+
+	/** Lifetime id high-water (allocated ids, including freed ones awaiting reuse). */
+	idHighWater(): number;
+	getWatermark(): number;
+	setWatermark(txn: number): void;
+	/**
+	 * Durability barrier: flush all data, then advance the watermark (omitted = leave the
+	 * stored watermark untouched), then flush the header alone — a crash between the two
+	 * flushes leaves an old watermark over durable data, never a new watermark over missing
+	 * data. Crash recovery is per-slot: a lock abandoned by a dead handle is detected via a
+	 * kernel-owned registration (immune to pid reuse) and taken over, with the slot marked
+	 * deleted until rewritten.
+	 */
+	flush(watermark?: number): void;
+	/** flush() on the libuv thread pool — a whole-map msync can stall its calling thread. */
+	flushAsync(watermark?: number): Promise<void>;
+}

package/index.js

@@ -0,0 +1,57 @@
+// Loads the native module: a bundled prebuild for this platform when present, else a
+// locally built artifact (`npm run build`, requires a Rust toolchain). Linux prebuilds are
+// glibc builds; musl systems build locally.
+'use strict';
+const { existsSync } = require('node:fs');
+const { join } = require('node:path');
+
+const candidates = [
+	join(__dirname, 'prebuilds', `${process.platform}-${process.arch}`, 'hnsw-plane.node'),
+	join(__dirname, 'hnsw-plane.node'),
+];
+// pick the first candidate that actually LOADS (a prebuilt binary can exist but fail to
+// link, e.g. built against a newer glibc than this system's — fall through to a local build)
+let native0;
+const failures = [];
+for (const candidate of candidates) {
+	if (!existsSync(candidate)) continue;
+	try {
+		native0 = require(candidate);
+		break;
+	} catch (error) {
+		failures.push(`${candidate}: ${error.message}`);
+	}
+}
+if (!native0) {
+	throw new Error(
+		`@harperfast/hnsw could not load a native binary for ${process.platform}-${process.arch}. ` +
+			'Build one with `npm run build` in ' +
+			__dirname +
+			' (requires a Rust toolchain: https://rustup.rs).' +
+			(failures.length ? ` Load failures: ${failures.join('; ')}` : '')
+	);
+}
+const native = native0;
+
+// A predicate that throws would surface through the ThreadsafeFunction as a fatal exception
+// (aborting the process); wrap it so a throw denies the batch and rejects the search instead.
+const nativeSearchWithPredicate = native.Plane.prototype.searchWithPredicate;
+native.Plane.prototype.searchWithPredicate = function (vector, k, ef, predicate, ...rest) {
+	let predicateError;
+	const guarded = (ids) => {
+		if (predicateError !== undefined) return new Uint8Array(ids.length);
+		try {
+			const verdicts = predicate(ids);
+			return verdicts instanceof Uint8Array ? verdicts : Uint8Array.from(verdicts ?? []);
+		} catch (error) {
+			predicateError = error;
+			return new Uint8Array(ids.length);
+		}
+	};
+	return nativeSearchWithPredicate.call(this, vector, k, ef, guarded, ...rest).then((hits) => {
+		if (predicateError !== undefined) throw predicateError;
+		return hits;
+	});
+};
+
+module.exports = native;

package/package.json

@@ -0,0 +1,44 @@
+{
+	"name": "@harperfast/hnsw",
+	"version": "0.1.0",
+	"description": "Persistent, incrementally-maintained, concurrently-searchable native HNSW for Node.js: a memory-mapped fixed-slot graph file with off-event-loop search, seqlock concurrency, int8 asymmetric distance, and bitset/predicate filtering.",
+	"license": "Apache-2.0",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/HarperFast/hnsw.git"
+	},
+	"main": "index.js",
+	"types": "index.d.ts",
+	"files": [
+		"index.js",
+		"index.d.ts",
+		"prebuilds",
+		"hnsw-plane.node",
+		"src",
+		"build.rs",
+		"build.mjs",
+		"Cargo.toml",
+		"Cargo.lock",
+		"README.md",
+		"DESIGN.md"
+	],
+	"engines": {
+		"node": ">=18"
+	},
+	"scripts": {
+		"build": "node build.mjs",
+		"install": "node build.mjs --if-needed",
+		"test": "cargo test --release && node build.mjs && node smoke.mjs"
+	},
+	"keywords": [
+		"hnsw",
+		"ann",
+		"vector",
+		"nearest-neighbor",
+		"similarity-search",
+		"embedding",
+		"mmap",
+		"napi",
+		"rust"
+	]
+}