omendb 0.0.1

package/README.md

@@ -0,0 +1,82 @@
+# omendb
+
+Fast embedded vector database with HNSW indexing for Node.js and Bun.
+
+## Installation
+
+```bash
+npm install omendb
+```
+
+## Usage
+
+```typescript
+import { open } from "omendb";
+
+// Open or create a database
+const db = open("./vectors", { dimensions: 384 });
+
+// Insert vectors
+db.set([
+  {
+    id: "doc1",
+    embedding: new Float32Array(384).fill(0.1),
+    metadata: { title: "Hello" },
+  },
+  {
+    id: "doc2",
+    embedding: new Float32Array(384).fill(0.2),
+    metadata: { title: "World" },
+  },
+]);
+
+// Search
+const results = db.search(new Float32Array(384).fill(0.15), { k: 5 });
+console.log(results);
+// [{ id: 'doc1', distance: 0.05, metadata: { title: 'Hello' } }, ...]
+
+// Batch search (async, parallel)
+const batchResults = await db.searchBatch(queries, { k: 10 });
+```
+
+## Features
+
+- HNSW indexing for fast approximate nearest neighbor search
+- ACORN-1 filtered search
+- RaBitQ compression (2/4/8-bit quantization)
+- Collections for multi-tenancy
+- Persistent storage with auto-save
+- Works with Node.js 18+ and Bun
+
+## API
+
+### `open(path, options?)`
+
+Open or create a vector database.
+
+- `path`: Database directory path
+- `options.dimensions`: Vector dimensionality (default: 128)
+
+### `db.set(items)`
+
+Insert or update vectors.
+
+### `db.search(query, options)`
+
+Search for k nearest neighbors (sync).
+
+### `db.searchBatch(queries, options)`
+
+Batch search with parallel execution (async).
+
+### `db.get(id)`
+
+Get a vector by ID.
+
+### `db.delete(ids)`
+
+Delete vectors by ID.
+
+## License
+
+Apache-2.0

package/index.d.ts

@@ -0,0 +1,89 @@
+/* auto-generated by NAPI-RS */
+/* eslint-disable */
+export declare class VectorDatabase {
+  /**
+   * Insert or update vectors.
+   *
+   * Accepts an array of items with id, embedding, and optional metadata.
+   */
+  set(items: Array<VectorItem>): Array<number>
+  /**
+   * Search for k nearest neighbors.
+   *
+   * @param query - Query vector (number[] or Float32Array)
+   * @param k - Number of results to return
+   * @param ef - Optional search width override
+   * @returns Array of {id, distance, metadata}
+   */
+  search(query: Array<number> | Float32Array, k: number, ef?: number | undefined | null): Array<SearchResult>
+  /**
+   * Batch search with parallel execution (async).
+   *
+   * Runs searches in parallel using rayon, returns Promise.
+   */
+  searchBatch(queries: Array<Array<number> | Float32Array>, k: number, ef?: number | undefined | null): Promise<Array<Array<SearchResult>>>
+  /** Get a vector by ID. */
+  get(id: string): GetResult | null
+  /**
+   * Delete vectors by ID.
+   *
+   * @returns Number of vectors deleted
+   */
+  delete(ids: Array<string>): number
+  /** Update a vector's embedding and/or metadata. */
+  update(id: string, embedding: Array<number> | Float32Array, metadata?: Record<string, unknown> | undefined): void
+  /** Save database to disk. */
+  save(): void
+  /** Get number of vectors in database. */
+  get count(): number
+  /** Get current ef_search value. */
+  get efSearch(): number | null
+  /** Set ef_search value. */
+  set efSearch(efSearch: number)
+  /** Get or create a named collection. */
+  collection(name: string): VectorDatabase
+  /** List all collections. */
+  collections(): Array<string>
+  /** Delete a collection. */
+  deleteCollection(name: string): void
+  /** Merge another database into this one. */
+  mergeFrom(other: VectorDatabase): number
+}
+
+export interface GetResult {
+  id: string
+  embedding: Array<number>
+  metadata: Record<string, unknown>
+}
+
+/**
+ * Open or create a vector database.
+ *
+ * @param path - Database directory path (use ":memory:" for in-memory)
+ * @param options - Optional configuration
+ * @returns VectorDatabase instance
+ */
+export declare function open(path: string, options?: OpenOptions | undefined | null): VectorDatabase
+
+export interface OpenOptions {
+  dimensions?: number
+  m?: number
+  efConstruction?: number
+}
+
+export interface SearchResult {
+  id: string
+  distance: number
+  /** Metadata as JSON (using serde-json feature) */
+  metadata: Record<string, unknown>
+}
+
+export interface VectorItem {
+  id: string
+  /** Embedding as array of numbers */
+  embedding: Array<number>
+  /** Optional metadata */
+  metadata?: Record<string, unknown> | undefined
+  /** Optional document text (stored in metadata.document) */
+  document?: string
+}

package/index.js

@@ -0,0 +1,107 @@
+/* auto-generated by NAPI-RS */
+/* eslint-disable */
+/* prettier-ignore */
+
+const { existsSync, readFileSync } = require("fs");
+const { join } = require("path");
+
+const { platform, arch } = process;
+
+let nativeBinding = null;
+let localFileExisted = false;
+let loadError = null;
+
+function isMusl() {
+	// For Node 10
+	if (!process.report || typeof process.report.getReport !== "function") {
+		try {
+			const lddPath = require("child_process")
+				.execSync("which ldd")
+				.toString()
+				.trim();
+			return readFileSync(lddPath, "utf8").includes("musl");
+		} catch {
+			return true;
+		}
+	} else {
+		const { glibcVersionRuntime } = process.report.getReport().header;
+		return !glibcVersionRuntime;
+	}
+}
+
+switch (platform) {
+	case "darwin":
+		localFileExisted = existsSync(join(__dirname, "omendb.node"));
+		try {
+			if (localFileExisted) {
+				nativeBinding = require("./omendb.node");
+			} else {
+				if (arch === "x64") {
+					nativeBinding = require("@omendb/darwin-x64");
+				} else if (arch === "arm64") {
+					nativeBinding = require("@omendb/darwin-arm64");
+				} else {
+					throw new Error(`Unsupported architecture on macOS: ${arch}`);
+				}
+			}
+		} catch (e) {
+			loadError = e;
+		}
+		break;
+	case "linux":
+		localFileExisted = existsSync(join(__dirname, "omendb.node"));
+		try {
+			if (localFileExisted) {
+				nativeBinding = require("./omendb.node");
+			} else if (isMusl()) {
+				if (arch === "x64") {
+					nativeBinding = require("@omendb/linux-x64-musl");
+				} else if (arch === "arm64") {
+					nativeBinding = require("@omendb/linux-arm64-musl");
+				} else {
+					throw new Error(`Unsupported architecture on Linux musl: ${arch}`);
+				}
+			} else {
+				if (arch === "x64") {
+					nativeBinding = require("@omendb/linux-x64-gnu");
+				} else if (arch === "arm64") {
+					nativeBinding = require("@omendb/linux-arm64-gnu");
+				} else {
+					throw new Error(`Unsupported architecture on Linux: ${arch}`);
+				}
+			}
+		} catch (e) {
+			loadError = e;
+		}
+		break;
+	case "win32":
+		localFileExisted = existsSync(join(__dirname, "omendb.node"));
+		try {
+			if (localFileExisted) {
+				nativeBinding = require("./omendb.node");
+			} else {
+				if (arch === "x64") {
+					nativeBinding = require("@omendb/win32-x64-msvc");
+				} else {
+					throw new Error(`Unsupported architecture on Windows: ${arch}`);
+				}
+			}
+		} catch (e) {
+			loadError = e;
+		}
+		break;
+	default:
+		throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`);
+}
+
+if (!nativeBinding) {
+	if (loadError) {
+		throw loadError;
+	}
+	throw new Error(`Failed to load native binding`);
+}
+
+const { VectorDatabase, open } = nativeBinding;
+
+module.exports.VectorDatabase = VectorDatabase;
+module.exports.open = open;

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "omendb",
+  "version": "0.0.1",
+  "description": "Fast embedded vector database with HNSW indexing",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nijaru/omendb"
+  },
+  "keywords": [
+    "vector",
+    "database",
+    "embeddings",
+    "hnsw",
+    "similarity-search",
+    "ai",
+    "machine-learning",
+    "napi-rs",
+    "rust"
+  ],
+  "author": "Nick Jaru",
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">= 18"
+  },
+  "napi": {
+    "binaryName": "omendb",
+    "targets": [
+      "x86_64-apple-darwin",
+      "aarch64-apple-darwin",
+      "x86_64-unknown-linux-gnu",
+      "aarch64-unknown-linux-gnu",
+      "x86_64-pc-windows-msvc"
+    ]
+  },
+  "scripts": {
+    "build": "napi build --release",
+    "build:debug": "napi build",
+    "test": "vitest run",
+    "prepublishOnly": "napi prepublish -t npm"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^3.0.0-alpha.65",
+    "vitest": "^2.1.0"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "omendb.node"
+  ],
+  "optionalDependencies": {
+    "omendb-darwin-x64": "0.0.1",
+    "omendb-darwin-arm64": "0.0.1",
+    "omendb-linux-x64-gnu": "0.0.1",
+    "omendb-linux-arm64-gnu": "0.0.1",
+    "omendb-win32-x64-msvc": "0.0.1"
+  }
+}