@ruvector/rvf-node 0.3.1 → 0.3.2

package/README.md

@@ -1,3 +1,5 @@
+<p align="center"><img src="https://raw.githubusercontent.com/ruvnet/RuVector/main/assets/ruvector/packages/rvf-node.svg" alt="@ruvector/rvf-node: Native Node.js bindings for the RuVector Format (RVF) vector database, built with Rust via N-API." width="100%"></p>
+
 # @ruvector/rvf-node
 
 Native Node.js bindings for the [RuVector Format](https://github.com/ruvnet/ruvector/tree/main/crates/rvf) (RVF) vector database. Built with Rust via N-API for native speed with zero serialization overhead.
@@ -119,6 +121,7 @@ db.close();
 | `dimension` | `number` | required | Vector dimensionality |
 | `metric` | `string` | `"l2"` | `"l2"`, `"cosine"`, or `"inner_product"` |
 | `profile` | `number` | `0` | Hardware profile: 0=Generic, 1=Core, 2=Hot, 3=Full |
+| `compression` | `string` | `"None"` | `"None"`, `"Scalar"`, or `"Product"` |
 | `signing` | `boolean` | `false` | Enable segment signing |
 | `m` | `number` | `16` | HNSW M parameter (neighbor count) |
 | `efConstruction` | `number` | `200` | HNSW index build quality |
@@ -253,6 +256,9 @@ db.lineageDepth();  // 0 for root files
 const child = db.derive('/tmp/child.rvf');
 child.lineageDepth(); // 1
 child.parentId();     // matches parent's fileId()
+
+// Copy-on-write branch: reads inherited vectors, persists only child edits
+const branch = db.branch('/tmp/branch.rvf');
 ```
 
 ### Kernel & eBPF Embedding
@@ -339,15 +345,15 @@ npm install
 npm run build
 ```
 
-## Related Packages
+## Related packages
+
+- [`@ruvector/rvf`](https://www.npmjs.com/package/@ruvector/rvf) — async TypeScript SDK that uses this addon as its `'node'` backend (string IDs, typed filters).
+- [`@ruvector/rvf-wasm`](https://www.npmjs.com/package/@ruvector/rvf-wasm) — WASM build of RVF for browsers and edge runtimes.
+- [`@ruvector/rvf-mcp-server`](https://www.npmjs.com/package/@ruvector/rvf-mcp-server) — MCP server exposing RVF stores to AI agents.
+- [`ruvector`](https://www.npmjs.com/package/ruvector) — umbrella package and CLI (`npx ruvector`).
 
-| Package | Description |
-|---------|-------------|
-| [`@ruvector/rvf`](https://www.npmjs.com/package/@ruvector/rvf) | Unified TypeScript SDK |
-| [`@ruvector/rvf-wasm`](https://www.npmjs.com/package/@ruvector/rvf-wasm) | Browser WASM package |
-| [`@ruvector/rvf-mcp-server`](https://www.npmjs.com/package/@ruvector/rvf-mcp-server) | MCP server for AI agents |
-| [`rvf-runtime`](https://crates.io/crates/rvf-runtime) | Rust runtime (powers this package) |
+The Rust crate powering this package is [`rvf-runtime`](https://crates.io/crates/rvf-runtime).
 
 ## License
 
-MIT OR Apache-2.0
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruvector/rvf-node",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "RuVector Format Node.js native bindings",
   "main": "index.js",
   "types": "index.d.ts",
@@ -22,10 +22,26 @@
   "scripts": {
     "build": "napi build --platform --release"
   },
+  "keywords": [
+    "ruvector",
+    "rvf",
+    "vector-database",
+    "vector-search",
+    "hnsw",
+    "napi",
+    "napi-rs",
+    "nodejs",
+    "rust"
+  ],
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/ruvnet/ruvector"
+    "url": "git+https://github.com/ruvnet/ruvector.git",
+    "directory": "npm/packages/rvf-node"
+  },
+  "homepage": "https://github.com/ruvnet/ruvector/tree/main/npm/packages/rvf-node#readme",
+  "bugs": {
+    "url": "https://github.com/ruvnet/ruvector/issues"
   },
   "engines": {
     "node": ">= 16"