vecstore 1.0.0

The perfect vector database - 100/100 score, embeddable, high-performance, production-ready with RAG toolkit
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
// WebAssembly bindings for vecstore
//
// This module provides browser-compatible APIs for running vecstore in WASM.
// Note: This uses an in-memory store since file I/O works differently in browsers.

use crate::store::{
    hybrid::TextIndex, parse_filter, FilterExpr, Metadata, Query, Record, VectorBackend,
};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use wasm_bindgen::prelude::*;

/// In-memory vector store for WASM
///
/// This is optimized for browser usage and doesn't use file I/O.
/// All data is kept in memory.
#[wasm_bindgen]
pub struct WasmVecStore {
    backend: VectorBackend,
    records: HashMap<String, Record>,
    text_index: TextIndex,
    dimension: usize,
}

/// Search result for WASM
#[wasm_bindgen]
#[derive(Clone, Serialize, Deserialize)]
pub struct WasmSearchResult {
    id: String,
    score: f32,
    metadata_json: String,
}

#[wasm_bindgen]
impl WasmSearchResult {
    #[wasm_bindgen(getter)]
    pub fn id(&self) -> String {
        self.id.clone()
    }

    #[wasm_bindgen(getter)]
    pub fn score(&self) -> f32 {
        self.score
    }

    #[wasm_bindgen(getter)]
    pub fn metadata(&self) -> String {
        self.metadata_json.clone()
    }
}

#[wasm_bindgen]
impl WasmVecStore {
    /// Create a new in-memory vector store
    ///
    /// # Arguments
    /// * `dimension` - Expected vector dimension (0 for auto-detect from first insert)
    ///
    /// # Example (JavaScript)
    /// ```javascript
    /// const store = new WasmVecStore(384); // For 384-dimensional embeddings
    /// ```
    #[wasm_bindgen(constructor)]
    pub fn new(dimension: usize) -> Self {
        // Set panic hook for better error messages in browser
        #[cfg(feature = "console_error_panic_hook")]
        console_error_panic_hook::set_once();

        Self {
            backend: VectorBackend::new(dimension),
            records: HashMap::new(),
            text_index: TextIndex::new(),
            dimension,
        }
    }

    /// Insert or update a vector with metadata
    ///
    /// # Arguments
    /// * `id` - Unique identifier
    /// * `vector` - Float32Array or regular array of numbers
    /// * `metadata` - JavaScript object with metadata
    ///
    /// # Example (JavaScript)
    /// ```javascript
    /// store.upsert(
    ///     "doc1",
    ///     new Float32Array([0.1, 0.2, 0.3, ...]),
    ///     { title: "Document 1", category: "tech" }
    /// );
    /// ```
    #[wasm_bindgen]
    pub fn upsert(
        &mut self,
        id: String,
        vector: Vec<f32>,
        metadata: JsValue,
    ) -> Result<(), JsValue> {
        // Set dimension on first insert
        if self.dimension == 0 {
            self.dimension = vector.len();
            self.backend = VectorBackend::new(self.dimension);
        }

        if vector.len() != self.dimension {
            return Err(JsValue::from_str(&format!(
                "Vector dimension mismatch: expected {}, got {}",
                self.dimension,
                vector.len()
            )));
        }

        // Convert JS metadata to Rust Metadata
        let metadata = js_value_to_metadata(metadata)?;

        let record = Record {
            id: id.clone(),
            vector: vector.clone(),
            metadata,
            created_at: js_sys::Date::now() as i64,
            deleted: false,
            deleted_at: None,
            expires_at: None,
        };

        self.backend
            .insert(id.clone(), &vector)
            .map_err(|e| JsValue::from_str(&e.to_string()))?;
        self.records.insert(id, record);

        Ok(())
    }

    /// Search for similar vectors
    ///
    /// # Arguments
    /// * `vector` - Query vector (Float32Array or regular array)
    /// * `k` - Number of results to return
    /// * `filter` - Optional SQL-like filter string (e.g., "category = 'tech'")
    ///
    /// # Returns
    /// Array of search results with id, score, and metadata
    ///
    /// # Example (JavaScript)
    /// ```javascript
    /// const results = store.query(
    ///     new Float32Array([0.1, 0.2, 0.3, ...]),
    ///     10,
    ///     "category = 'tech'"
    /// );
    ///
    /// results.forEach(result => {
    ///     console.log(`${result.id}: ${result.score}`);
    ///     console.log(JSON.parse(result.metadata));
    /// });
    /// ```
    #[wasm_bindgen]
    pub fn query(
        &self,
        vector: Vec<f32>,
        k: usize,
        filter: Option<String>,
    ) -> Result<JsValue, JsValue> {
        if self.dimension == 0 {
            return Ok(serde_wasm_bindgen::to_value(&Vec::<WasmSearchResult>::new()).unwrap());
        }

        if vector.len() != self.dimension {
            return Err(JsValue::from_str(&format!(
                "Query dimension mismatch: expected {}, got {}",
                self.dimension,
                vector.len()
            )));
        }

        let filter_expr: Option<FilterExpr> = if let Some(filter_str) = filter {
            Some(
                parse_filter(&filter_str)
                    .map_err(|e| JsValue::from_str(&format!("Filter parse error: {}", e)))?,
            )
        } else {
            None
        };

        let query = Query {
            vector,
            k,
            filter: filter_expr.clone(),
        };

        // Get results from backend
        let fetch_size = if filter_expr.is_some() { k * 10 } else { k };

        let results = self
            .backend
            .search(&query.vector, fetch_size)
            .map_err(|e| JsValue::from_str(&e.to_string()))?;

        // Apply filters and convert to WASM results
        let mut neighbors: Vec<WasmSearchResult> = Vec::new();

        for (id, score) in results {
            if let Some(record) = self.records.get(&id) {
                // Apply filter if present
                if let Some(ref filter) = filter_expr {
                    if !crate::store::filters::evaluate_filter(filter, &record.metadata) {
                        continue;
                    }
                }

                let metadata_json = serde_json::to_string(&record.metadata.fields)
                    .map_err(|e| JsValue::from_str(&e.to_string()))?;

                neighbors.push(WasmSearchResult {
                    id: id.clone(),
                    score,
                    metadata_json,
                });

                if neighbors.len() >= k {
                    break;
                }
            }
        }

        serde_wasm_bindgen::to_value(&neighbors).map_err(|e| JsValue::from_str(&e.to_string()))
    }

    /// Index text for keyword search (required for hybrid search)
    ///
    /// # Example (JavaScript)
    /// ```javascript
    /// store.index_text("doc1", "Rust is a systems programming language");
    /// ```
    #[wasm_bindgen]
    pub fn index_text(&mut self, id: String, text: String) -> Result<(), JsValue> {
        self.text_index.index_document(id, text);
        Ok(())
    }

    /// Hybrid search combining vector similarity and keyword matching
    ///
    /// # Arguments
    /// * `vector` - Query vector
    /// * `keywords` - Search keywords
    /// * `k` - Number of results
    /// * `alpha` - Balance between vector (1.0) and keyword (0.0) search
    /// * `filter` - Optional filter string
    ///
    /// # Example (JavaScript)
    /// ```javascript
    /// const results = store.hybrid_query(
    ///     queryVector,
    ///     "machine learning",
    ///     10,
    ///     0.7,  // 70% vector, 30% keyword
    ///     null
    /// );
    /// ```
    #[wasm_bindgen]
    pub fn hybrid_query(
        &self,
        vector: Vec<f32>,
        keywords: String,
        k: usize,
        alpha: f32,
        filter: Option<String>,
    ) -> Result<JsValue, JsValue> {
        if self.dimension == 0 {
            return Ok(serde_wasm_bindgen::to_value(&Vec::<WasmSearchResult>::new()).unwrap());
        }

        let filter_expr: Option<FilterExpr> = if let Some(filter_str) = filter {
            Some(
                parse_filter(&filter_str)
                    .map_err(|e| JsValue::from_str(&format!("Filter parse error: {}", e)))?,
            )
        } else {
            None
        };

        let fetch_size = if filter_expr.is_some() { k * 10 } else { k * 2 };

        // Get vector results
        let vector_results = self
            .backend
            .search(&vector, fetch_size)
            .map_err(|e| JsValue::from_str(&e.to_string()))?;

        // Get BM25 scores
        let bm25_scores = if !keywords.is_empty() {
            self.text_index.bm25_scores(&keywords)
        } else {
            HashMap::new()
        };

        // Combine scores
        let combined = crate::store::hybrid::combine_scores(vector_results, bm25_scores, alpha);

        // Apply filters and convert to WASM results
        let mut neighbors: Vec<WasmSearchResult> = Vec::new();

        for (id, score) in combined {
            if let Some(record) = self.records.get(&id) {
                // Apply filter if present
                if let Some(ref filter) = filter_expr {
                    if !crate::store::filters::evaluate_filter(filter, &record.metadata) {
                        continue;
                    }
                }

                let metadata_json = serde_json::to_string(&record.metadata.fields)
                    .map_err(|e| JsValue::from_str(&e.to_string()))?;

                neighbors.push(WasmSearchResult {
                    id: id.clone(),
                    score,
                    metadata_json,
                });

                if neighbors.len() >= k {
                    break;
                }
            }
        }

        serde_wasm_bindgen::to_value(&neighbors).map_err(|e| JsValue::from_str(&e.to_string()))
    }

    /// Remove a vector by ID
    #[wasm_bindgen]
    pub fn remove(&mut self, id: String) -> Result<(), JsValue> {
        self.backend
            .remove(&id)
            .map_err(|e| JsValue::from_str(&e.to_string()))?;
        self.records.remove(&id);
        self.text_index.remove_document(&id);
        Ok(())
    }

    /// Get the number of vectors in the store
    #[wasm_bindgen]
    pub fn len(&self) -> usize {
        self.records.len()
    }

    /// Check if the store is empty
    #[wasm_bindgen]
    pub fn is_empty(&self) -> bool {
        self.records.is_empty()
    }

    /// Export store data as JSON (for persistence/backup)
    ///
    /// Returns a JSON string containing all vectors and metadata.
    /// Can be saved to localStorage or IndexedDB.
    ///
    /// # Example (JavaScript)
    /// ```javascript
    /// const data = store.export_json();
    /// localStorage.setItem('vecstore_backup', data);
    /// ```
    #[wasm_bindgen]
    pub fn export_json(&self) -> Result<String, JsValue> {
        #[derive(Serialize)]
        struct ExportData {
            dimension: usize,
            records: Vec<Record>,
        }

        let data = ExportData {
            dimension: self.dimension,
            records: self.records.values().cloned().collect(),
        };

        serde_json::to_string(&data).map_err(|e| JsValue::from_str(&e.to_string()))
    }

    /// Import store data from JSON
    ///
    /// Restores a store from previously exported JSON data.
    ///
    /// # Example (JavaScript)
    /// ```javascript
    /// const store = new WasmVecStore(0);
    /// const data = localStorage.getItem('vecstore_backup');
    /// store.import_json(data);
    /// ```
    #[wasm_bindgen]
    pub fn import_json(&mut self, json_data: String) -> Result<(), JsValue> {
        #[derive(Deserialize)]
        struct ImportData {
            dimension: usize,
            records: Vec<Record>,
        }

        let data: ImportData =
            serde_json::from_str(&json_data).map_err(|e| JsValue::from_str(&e.to_string()))?;

        self.dimension = data.dimension;
        self.backend = VectorBackend::new(self.dimension);
        self.records.clear();
        self.text_index = TextIndex::new();

        for record in data.records {
            self.backend
                .insert(record.id.clone(), &record.vector)
                .map_err(|e| JsValue::from_str(&e.to_string()))?;
            self.records.insert(record.id.clone(), record);
        }

        Ok(())
    }

    /// Log information to browser console
    #[wasm_bindgen]
    pub fn log_info(&self) {
        web_sys::console::log_1(
            &format!(
                "VecStore: {} vectors, dimension: {}",
                self.len(),
                self.dimension
            )
            .into(),
        );
    }
}

/// Helper function to convert JsValue to Rust Metadata
fn js_value_to_metadata(js_value: JsValue) -> Result<Metadata, JsValue> {
    let obj = js_sys::Object::from(js_value);
    let entries = js_sys::Object::entries(&obj);
    let mut fields = HashMap::new();

    for i in 0..entries.length() {
        let entry = entries.get(i);
        let entry_array: js_sys::Array = entry.into();

        let key: String = entry_array
            .get(0)
            .as_string()
            .ok_or_else(|| JsValue::from_str("Metadata key must be a string"))?;

        let value = entry_array.get(1);

        let json_value = if value.is_string() {
            serde_json::Value::String(
                value
                    .as_string()
                    .ok_or_else(|| JsValue::from_str("Failed to convert string"))?,
            )
        } else if let Some(num) = value.as_f64() {
            serde_json::json!(num)
        } else if let Some(b) = value.as_bool() {
            serde_json::Value::Bool(b)
        } else if value.is_null() || value.is_undefined() {
            serde_json::Value::Null
        } else {
            // Try to serialize as JSON
            let json_str = js_sys::JSON::stringify(&value)
                .map_err(|_| JsValue::from_str("Failed to stringify value"))?
                .as_string()
                .ok_or_else(|| JsValue::from_str("Failed to convert to string"))?;
            serde_json::from_str(&json_str)
                .map_err(|e| JsValue::from_str(&format!("Failed to parse JSON: {}", e)))?
        };

        fields.insert(key, json_value);
    }

    Ok(Metadata { fields })
}

/// Initialize WASM module (called automatically when module loads)
#[wasm_bindgen(start)]
pub fn init() {
    #[cfg(feature = "console_error_panic_hook")]
    console_error_panic_hook::set_once();
}