@brainwires/idbvec 0.1.0 → 0.2.0

package/README.md

@@ -9,7 +9,7 @@ A high-performance client-side vector database built with Rust/WebAssembly and I
 - **🎯 ANN Search**: HNSW (Hierarchical Navigable Small World) index for approximate nearest neighbor search
 - **📊 Distance Metrics**: Cosine similarity, Euclidean distance, dot product
 - **🔧 Type-Safe**: Full TypeScript support
-- **📦 Zero Dependencies**: Self-contained WASM module
+- **📦 Zero Runtime Dependencies**: Self-contained WASM module
 
 ## Architecture
 
@@ -17,14 +17,14 @@ A high-performance client-side vector database built with Rust/WebAssembly and I
 ┌─────────────────────────────────┐
 │   TypeScript API (wrapper.ts)   │
 ├─────────────────────────────────┤
-│    WASM Module (Rust)            │
-│  - HNSW Index                    │
-│  - Distance Metrics              │
-│  - Vector Operations             │
+│    WASM Module (Rust)           │
+│  - HNSW Index                   │
+│  - Distance Metrics             │
+│  - Vector Operations            │
 ├─────────────────────────────────┤
-│   IndexedDB Storage              │
-│  - Persistent State              │
-│  - Automatic Serialization       │
+│   IndexedDB Storage             │
+│  - Persistent State             │
+│  - Automatic Serialization      │
 └─────────────────────────────────┘
 ```
 
@@ -76,7 +76,7 @@ const results = await db.search(
 
 console.log(results)
 // [
-//   { id: 'doc1', score: 0.95, metadata: { title: 'Document 1', ... } },
+//   { id: 'doc1', distance: 0.05, metadata: { title: 'Document 1', ... } },
 //   ...
 // ]
 
@@ -122,6 +122,7 @@ const dot = await dotProduct(a, b) // 0.0
 | `dimensions` | number | - | Vector dimensionality |
 | `m` | number | 16 | Max connections per layer (higher = better recall, more memory) |
 | `efConstruction` | number | 200 | Construction quality (higher = better index, slower insert) |
+| `metric` | string | "euclidean" | Distance metric: "euclidean", "cosine", or "dotproduct" |
 
 ### Search Options
 
@@ -168,7 +169,7 @@ cp -r rust/idbvec/pkg/bundler public/idbvec-wasm
 ```tsx
 'use client'
 
-import { VectorDatabase } from '@/rust/idbvec/wrapper'
+import { VectorDatabase } from '@brainwires/idbvec'
 import { useEffect, useState } from 'react'
 
 export function VectorSearch() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brainwires/idbvec",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Client-side vector database built on IndexedDB with WASM",
   "main": "wrapper.js",
   "types": "wrapper.d.ts",

package/pkg/bundler/LICENSE-APACHE

@@ -0,0 +1,189 @@
+                              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.
+
+   "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 the 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 the 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 any 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
+
+Copyright 2025 Brainwires
+
+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/pkg/bundler/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Brainwires
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/pkg/bundler/README.md

@@ -0,0 +1,208 @@
+# idbvec - Vector Database (WASM + IndexedDB)
+
+A high-performance client-side vector database built with Rust/WebAssembly and IndexedDB for persistence.
+
+## Features
+
+- **🚀 WASM-Accelerated**: Near-native performance for vector operations
+- **💾 Persistent**: Automatic IndexedDB persistence
+- **🎯 ANN Search**: HNSW (Hierarchical Navigable Small World) index for approximate nearest neighbor search
+- **📊 Distance Metrics**: Cosine similarity, Euclidean distance, dot product
+- **🔧 Type-Safe**: Full TypeScript support
+- **📦 Zero Runtime Dependencies**: Self-contained WASM module
+
+## Architecture
+
+```
+┌─────────────────────────────────┐
+│   TypeScript API (wrapper.ts)   │
+├─────────────────────────────────┤
+│    WASM Module (Rust)           │
+│  - HNSW Index                   │
+│  - Distance Metrics             │
+│  - Vector Operations            │
+├─────────────────────────────────┤
+│   IndexedDB Storage             │
+│  - Persistent State             │
+│  - Automatic Serialization      │
+└─────────────────────────────────┘
+```
+
+## Building
+
+```bash
+# Install wasm-pack (if not already installed)
+cargo install wasm-pack
+
+# Build WASM modules
+./build-wasm.sh
+
+# Outputs:
+# - pkg/bundler  (for webpack/rollup/vite)
+# - pkg/nodejs   (for Node.js)
+# - pkg/web      (for ES modules)
+```
+
+## Usage
+
+### Basic Example
+
+```typescript
+import { VectorDatabase } from './wrapper'
+
+// Create database
+const db = new VectorDatabase({
+  name: 'my-vectors',
+  dimensions: 384, // e.g., for all-MiniLM-L6-v2 embeddings
+  m: 16, // max connections per layer
+  efConstruction: 200, // construction quality
+})
+
+// Initialize
+await db.init()
+
+// Insert vectors
+await db.insert(
+  'doc1',
+  new Float32Array([0.1, 0.2, 0.3, ...]),
+  { title: 'Document 1', category: 'tech' }
+)
+
+// Search
+const results = await db.search(
+  queryVector,
+  { k: 5, ef: 50 }
+)
+
+console.log(results)
+// [
+//   { id: 'doc1', distance: 0.05, metadata: { title: 'Document 1', ... } },
+//   ...
+// ]
+
+// Delete
+await db.delete('doc1')
+
+// Close
+db.close()
+```
+
+### Batch Insert
+
+```typescript
+const records = [
+  { id: 'vec1', vector: new Float32Array([...]), metadata: { ... } },
+  { id: 'vec2', vector: new Float32Array([...]), metadata: { ... } },
+  // ...
+]
+
+await db.insertBatch(records)
+```
+
+### Distance Functions
+
+```typescript
+import { cosineSimilarity, euclideanDistance, dotProduct } from './wrapper'
+
+const a = new Float32Array([1, 0, 0])
+const b = new Float32Array([0, 1, 0])
+
+const similarity = await cosineSimilarity(a, b) // 0.0
+const distance = await euclideanDistance(a, b) // 1.414...
+const dot = await dotProduct(a, b) // 0.0
+```
+
+## Configuration
+
+### VectorDBConfig
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `name` | string | - | Database name (IndexedDB key) |
+| `dimensions` | number | - | Vector dimensionality |
+| `m` | number | 16 | Max connections per layer (higher = better recall, more memory) |
+| `efConstruction` | number | 200 | Construction quality (higher = better index, slower insert) |
+| `metric` | string | "euclidean" | Distance metric: "euclidean", "cosine", or "dotproduct" |
+
+### Search Options
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `k` | number | 10 | Number of nearest neighbors to return |
+| `ef` | number | 50 | Search quality (higher = better recall, slower search) |
+
+## HNSW Parameters Guide
+
+### M (Max Connections)
+- **8-12**: Low memory, faster search, lower recall
+- **16-32**: Balanced (recommended)
+- **32+**: High recall, more memory
+
+### ef_construction
+- **100**: Fast build, lower quality
+- **200**: Balanced (recommended)
+- **400+**: Slow build, high quality
+
+### ef (search)
+- **k**: Minimum (fast, lower recall)
+- **k * 2-5**: Balanced
+- **k * 10+**: High recall (slower)
+
+## Performance
+
+Typical performance on modern hardware:
+
+- **Insert**: ~1-10ms per vector (depends on ef_construction)
+- **Search**: ~1-5ms for k=10 (depends on ef and database size)
+- **Memory**: ~(dimensions * 4 + M * 8) bytes per vector
+
+## Integration with Next.js
+
+1. Copy WASM build to `public/`:
+
+```bash
+cp -r rust/idbvec/pkg/bundler public/idbvec-wasm
+```
+
+2. Use in a client component:
+
+```tsx
+'use client'
+
+import { VectorDatabase } from '@brainwires/idbvec'
+import { useEffect, useState } from 'react'
+
+export function VectorSearch() {
+  const [db, setDb] = useState<VectorDatabase | null>(null)
+
+  useEffect(() => {
+    const initDB = async () => {
+      const vectorDB = new VectorDatabase({
+        name: 'app-vectors',
+        dimensions: 384,
+      })
+      await vectorDB.init()
+      setDb(vectorDB)
+    }
+    initDB()
+  }, [])
+
+  // Use db for search, insert, etc.
+}
+```
+
+## Browser Compatibility
+
+- ✅ Chrome 90+
+- ✅ Firefox 88+
+- ✅ Safari 15+
+- ✅ Edge 90+
+
+Requires:
+- WebAssembly support
+- IndexedDB support
+- ES modules
+
+## License
+
+MIT OR Apache-2.0

package/pkg/bundler/idbvec.d.ts

@@ -0,0 +1,63 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Main VectorDB class - exposed to JavaScript
+ */
+export class VectorDB {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Delete a vector by ID
+     */
+    delete(id: string): boolean;
+    /**
+     * Delete multiple vectors by ID, returns number of deletions
+     */
+    delete_batch(ids: string[]): number;
+    /**
+     * Deserialize and restore database from JSON
+     */
+    static deserialize(json: string): VectorDB;
+    /**
+     * Get a vector and its metadata by ID
+     */
+    get(id: string): any;
+    /**
+     * Check if a vector exists by ID
+     */
+    has(id: string): boolean;
+    /**
+     * Insert a vector into the database
+     */
+    insert(id: string, vector: Float32Array, metadata: any): void;
+    /**
+     * List all vector IDs
+     */
+    list_ids(): any;
+    /**
+     * Create a new VectorDB instance
+     */
+    constructor(dimensions: number, m: number, ef_construction: number, metric?: string | null);
+    /**
+     * Search for nearest neighbors
+     */
+    search(query: Float32Array, k: number, ef: number): any;
+    /**
+     * Serialize the entire database to JSON
+     */
+    serialize(): string;
+    /**
+     * Get total number of vectors
+     */
+    size(): number;
+}
+
+/**
+ * Standalone distance functions exposed to JS
+ */
+export function cosine_similarity(a: Float32Array, b: Float32Array): number;
+
+export function dot_product(a: Float32Array, b: Float32Array): number;
+
+export function euclidean_distance(a: Float32Array, b: Float32Array): number;

package/pkg/bundler/idbvec.js

@@ -0,0 +1,9 @@
+/* @ts-self-types="./idbvec.d.ts" */
+
+import * as wasm from "./idbvec_bg.wasm";
+import { __wbg_set_wasm } from "./idbvec_bg.js";
+__wbg_set_wasm(wasm);
+wasm.__wbindgen_start();
+export {
+    VectorDB, cosine_similarity, dot_product, euclidean_distance
+} from "./idbvec_bg.js";