ruvector 0.1.20 → 0.1.21

package/dist/types.d.ts

@@ -1,145 +0,0 @@
-/**
- * Vector entry representing a document with its embedding
- */
-export interface VectorEntry {
-    /** Unique identifier for the vector */
-    id: string;
-    /** Vector embedding (array of floats) */
-    vector: number[];
-    /** Optional metadata associated with the vector */
-    metadata?: Record<string, any>;
-}
-/**
- * Search query parameters
- */
-export interface SearchQuery {
-    /** Query vector to search for */
-    vector: number[];
-    /** Number of results to return */
-    k?: number;
-    /** Optional metadata filters */
-    filter?: Record<string, any>;
-    /** Minimum similarity threshold (0-1) */
-    threshold?: number;
-}
-/**
- * Search result containing matched vector and similarity score
- */
-export interface SearchResult {
-    /** ID of the matched vector */
-    id: string;
-    /** Similarity score (0-1, higher is better) */
-    score: number;
-    /** Vector data */
-    vector: number[];
-    /** Associated metadata */
-    metadata?: Record<string, any>;
-}
-/**
- * Database configuration options
- */
-export interface DbOptions {
-    /** Vector dimension size */
-    dimension: number;
-    /** Distance metric to use */
-    metric?: 'cosine' | 'euclidean' | 'dot';
-    /** Path to persist database */
-    path?: string;
-    /** Enable auto-persistence */
-    autoPersist?: boolean;
-    /** HNSW index parameters */
-    hnsw?: {
-        /** Maximum number of connections per layer */
-        m?: number;
-        /** Size of the dynamic candidate list */
-        efConstruction?: number;
-        /** Size of the dynamic candidate list for search */
-        efSearch?: number;
-    };
-}
-/**
- * Database statistics
- */
-export interface DbStats {
-    /** Total number of vectors */
-    count: number;
-    /** Vector dimension */
-    dimension: number;
-    /** Distance metric */
-    metric: string;
-    /** Memory usage in bytes */
-    memoryUsage?: number;
-    /** Index type */
-    indexType?: string;
-}
-/**
- * Main VectorDB class interface
- */
-export interface VectorDB {
-    /**
-     * Create a new vector database
-     * @param options Database configuration
-     */
-    new (options: DbOptions): VectorDB;
-    /**
-     * Insert a single vector
-     * @param entry Vector entry to insert
-     */
-    insert(entry: VectorEntry): void;
-    /**
-     * Insert multiple vectors in batch
-     * @param entries Array of vector entries
-     */
-    insertBatch(entries: VectorEntry[]): void;
-    /**
-     * Search for similar vectors
-     * @param query Search query parameters
-     * @returns Array of search results
-     */
-    search(query: SearchQuery): SearchResult[];
-    /**
-     * Get vector by ID
-     * @param id Vector ID
-     * @returns Vector entry or null
-     */
-    get(id: string): VectorEntry | null;
-    /**
-     * Delete vector by ID
-     * @param id Vector ID
-     * @returns true if deleted, false if not found
-     */
-    delete(id: string): boolean;
-    /**
-     * Update vector metadata
-     * @param id Vector ID
-     * @param metadata New metadata
-     */
-    updateMetadata(id: string, metadata: Record<string, any>): void;
-    /**
-     * Get database statistics
-     */
-    stats(): DbStats;
-    /**
-     * Save database to disk
-     * @param path Optional path (uses configured path if not provided)
-     */
-    save(path?: string): void;
-    /**
-     * Load database from disk
-     * @param path Path to database file
-     */
-    load(path: string): void;
-    /**
-     * Clear all vectors from database
-     */
-    clear(): void;
-    /**
-     * Build HNSW index for faster search
-     */
-    buildIndex(): void;
-    /**
-     * Optimize database (rebuild indices, compact storage)
-     */
-    optimize(): void;
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,uCAAuC;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,yCAAyC;IACzC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,mDAAmD;IACnD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,iCAAiC;IACjC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,kCAAkC;IAClC,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,gCAAgC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,+BAA+B;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,+CAA+C;IAC/C,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB;IAClB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,4BAA4B;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,MAAM,CAAC,EAAE,QAAQ,GAAG,WAAW,GAAG,KAAK,CAAC;IACxC,+BAA+B;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8BAA8B;IAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,4BAA4B;IAC5B,IAAI,CAAC,EAAE;QACL,8CAA8C;QAC9C,CAAC,CAAC,EAAE,MAAM,CAAC;QACX,yCAAyC;QACzC,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,oDAAoD;QACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,sBAAsB;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;;OAGG;IACH,KAAI,OAAO,EAAE,SAAS,GAAG,QAAQ,CAAC;IAElC;;;OAGG;IACH,MAAM,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IAE1C;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,WAAW,GAAG,YAAY,EAAE,CAAC;IAE3C;;;;OAIG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,CAAC;IAEpC;;;;OAIG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;IAE5B;;;;OAIG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAEhE;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC;IAEjB;;;OAGG;IACH,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;OAEG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;OAEG;IACH,QAAQ,IAAI,IAAI,CAAC;CAClB"}

package/dist/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/examples/api-usage.js

@@ -1,211 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * ruvector API Usage Examples
- *
- * This demonstrates how to use ruvector in your Node.js applications
- */
-
-// For this demo, we use the mock implementation
-// In production, you would use: const { VectorDB } = require('ruvector');
-const { VectorDB } = require('../test/mock-implementation.js');
-
-console.log('ruvector API Examples\n');
-console.log('='.repeat(60));
-
-// Show info
-console.log('\nUsing: Mock implementation (for demo purposes)');
-console.log('In production: npm install ruvector\n');
-
-// Example 1: Basic usage
-console.log('Example 1: Basic Vector Operations');
-console.log('-'.repeat(60));
-
-const db = new VectorDB({
-  dimension: 3,
-  metric: 'cosine'
-});
-
-// Insert some vectors
-db.insert({
-  id: 'doc1',
-  vector: [1, 0, 0],
-  metadata: { title: 'First Document', category: 'A' }
-});
-
-db.insertBatch([
-  { id: 'doc2', vector: [0, 1, 0], metadata: { title: 'Second Document', category: 'B' } },
-  { id: 'doc3', vector: [0, 0, 1], metadata: { title: 'Third Document', category: 'C' } },
-  { id: 'doc4', vector: [0.7, 0.7, 0], metadata: { title: 'Fourth Document', category: 'A' } }
-]);
-
-console.log('✓ Inserted 4 vectors');
-
-// Get stats
-const stats = db.stats();
-console.log(`✓ Database has ${stats.count} vectors, dimension ${stats.dimension}`);
-
-// Search
-const results = db.search({
-  vector: [1, 0, 0],
-  k: 3
-});
-
-console.log(`✓ Search returned ${results.length} results:`);
-results.forEach((result, i) => {
-  console.log(`  ${i + 1}. ${result.id} (score: ${result.score.toFixed(4)}) - ${result.metadata.title}`);
-});
-
-// Get by ID
-const doc = db.get('doc2');
-console.log(`✓ Retrieved document: ${doc.metadata.title}`);
-
-// Update metadata
-db.updateMetadata('doc1', { updated: true, timestamp: Date.now() });
-console.log('✓ Updated metadata');
-
-// Delete
-db.delete('doc3');
-console.log('✓ Deleted doc3');
-console.log(`✓ Database now has ${db.stats().count} vectors\n`);
-
-// Example 2: Semantic Search Simulation
-console.log('Example 2: Semantic Search Simulation');
-console.log('-'.repeat(60));
-
-const semanticDb = new VectorDB({
-  dimension: 5,
-  metric: 'cosine'
-});
-
-// Simulate document embeddings
-const documents = [
-  { id: 'machine-learning', vector: [0.9, 0.8, 0.1, 0.2, 0.1], metadata: { title: 'Introduction to Machine Learning', topic: 'AI' } },
-  { id: 'deep-learning', vector: [0.85, 0.9, 0.15, 0.25, 0.1], metadata: { title: 'Deep Learning Fundamentals', topic: 'AI' } },
-  { id: 'web-dev', vector: [0.1, 0.2, 0.9, 0.8, 0.1], metadata: { title: 'Web Development Guide', topic: 'Web' } },
-  { id: 'react', vector: [0.15, 0.2, 0.85, 0.9, 0.1], metadata: { title: 'React Tutorial', topic: 'Web' } },
-  { id: 'database', vector: [0.2, 0.3, 0.3, 0.4, 0.9], metadata: { title: 'Database Design', topic: 'Data' } }
-];
-
-semanticDb.insertBatch(documents);
-console.log(`✓ Indexed ${documents.length} documents`);
-
-// Search for AI-related content
-const aiQuery = [0.9, 0.85, 0.1, 0.2, 0.1];
-const aiResults = semanticDb.search({ vector: aiQuery, k: 2 });
-
-console.log('\nQuery: AI-related content');
-console.log('Results:');
-aiResults.forEach((result, i) => {
-  console.log(`  ${i + 1}. ${result.metadata.title} (score: ${result.score.toFixed(4)})`);
-});
-
-// Search for Web-related content
-const webQuery = [0.1, 0.2, 0.9, 0.85, 0.1];
-const webResults = semanticDb.search({ vector: webQuery, k: 2 });
-
-console.log('\nQuery: Web-related content');
-console.log('Results:');
-webResults.forEach((result, i) => {
-  console.log(`  ${i + 1}. ${result.metadata.title} (score: ${result.score.toFixed(4)})`);
-});
-
-// Example 3: Different Distance Metrics
-console.log('\n\nExample 3: Distance Metrics Comparison');
-console.log('-'.repeat(60));
-
-const metrics = ['cosine', 'euclidean', 'dot'];
-const testVectors = [
-  { id: 'v1', vector: [1, 0, 0] },
-  { id: 'v2', vector: [0.7, 0.7, 0] },
-  { id: 'v3', vector: [0, 1, 0] }
-];
-
-metrics.forEach(metric => {
-  const metricDb = new VectorDB({ dimension: 3, metric });
-  metricDb.insertBatch(testVectors);
-
-  const results = metricDb.search({ vector: [1, 0, 0], k: 3 });
-
-  console.log(`\n${metric.toUpperCase()} metric:`);
-  results.forEach((result, i) => {
-    console.log(`  ${i + 1}. ${result.id}: ${result.score.toFixed(4)}`);
-  });
-});
-
-// Example 4: Batch Operations Performance
-console.log('\n\nExample 4: Batch Operations Performance');
-console.log('-'.repeat(60));
-
-const perfDb = new VectorDB({ dimension: 128, metric: 'cosine' });
-
-// Generate random vectors
-const numVectors = 1000;
-const vectors = [];
-for (let i = 0; i < numVectors; i++) {
-  vectors.push({
-    id: `vec_${i}`,
-    vector: Array.from({ length: 128 }, () => Math.random()),
-    metadata: { index: i, batch: Math.floor(i / 100) }
-  });
-}
-
-console.log(`Inserting ${numVectors} vectors...`);
-const insertStart = Date.now();
-perfDb.insertBatch(vectors);
-const insertTime = Date.now() - insertStart;
-
-console.log(`✓ Inserted ${numVectors} vectors in ${insertTime}ms`);
-console.log(`✓ Rate: ${Math.round(numVectors / (insertTime / 1000))} vectors/sec`);
-
-// Search performance
-const numQueries = 100;
-console.log(`\nRunning ${numQueries} searches...`);
-const searchStart = Date.now();
-
-for (let i = 0; i < numQueries; i++) {
-  const query = {
-    vector: Array.from({ length: 128 }, () => Math.random()),
-    k: 10
-  };
-  perfDb.search(query);
-}
-
-const searchTime = Date.now() - searchStart;
-console.log(`✓ Completed ${numQueries} searches in ${searchTime}ms`);
-console.log(`✓ Rate: ${Math.round(numQueries / (searchTime / 1000))} queries/sec`);
-console.log(`✓ Avg latency: ${(searchTime / numQueries).toFixed(2)}ms`);
-
-// Example 5: Persistence (conceptual, would need real implementation)
-console.log('\n\nExample 5: Persistence');
-console.log('-'.repeat(60));
-
-const persistDb = new VectorDB({
-  dimension: 3,
-  metric: 'cosine',
-  path: './my-vectors.db',
-  autoPersist: true
-});
-
-persistDb.insertBatch([
-  { id: 'p1', vector: [1, 0, 0], metadata: { name: 'First' } },
-  { id: 'p2', vector: [0, 1, 0], metadata: { name: 'Second' } }
-]);
-
-console.log('✓ Created database with auto-persist enabled');
-console.log('✓ Insert operations will automatically save to disk');
-console.log('✓ Use db.save(path) for manual saves');
-console.log('✓ Use db.load(path) to restore from disk');
-
-// Summary
-console.log('\n' + '='.repeat(60));
-console.log('\n✅ All examples completed successfully!');
-console.log('\nKey Features Demonstrated:');
-console.log('  • Basic CRUD operations (insert, search, get, update, delete)');
-console.log('  • Batch operations for better performance');
-console.log('  • Multiple distance metrics (cosine, euclidean, dot)');
-console.log('  • Semantic search simulation');
-console.log('  • Performance benchmarking');
-console.log('  • Metadata filtering and updates');
-console.log('  • Persistence (save/load)');
-console.log('\nFor more examples, see: /workspaces/ruvector/npm/packages/ruvector/examples/');

package/examples/cli-demo.sh

@@ -1,85 +0,0 @@
-#!/bin/bash
-
-# ruvector CLI Demo
-# This demonstrates the CLI functionality with a simple example
-
-echo "🚀 ruvector CLI Demo"
-echo "===================="
-echo ""
-
-# 1. Show version info
-echo "1. Checking ruvector info..."
-ruvector info
-echo ""
-
-# 2. Create a database
-echo "2. Creating a new database..."
-ruvector create demo.vec --dimension 3 --metric cosine
-echo ""
-
-# 3. Create sample data
-echo "3. Creating sample vectors..."
-cat > demo-vectors.json << 'EOF'
-[
-  {
-    "id": "cat",
-    "vector": [0.9, 0.1, 0.1],
-    "metadata": {"animal": "cat", "category": "feline"}
-  },
-  {
-    "id": "dog",
-    "vector": [0.1, 0.9, 0.1],
-    "metadata": {"animal": "dog", "category": "canine"}
-  },
-  {
-    "id": "tiger",
-    "vector": [0.8, 0.2, 0.15],
-    "metadata": {"animal": "tiger", "category": "feline"}
-  },
-  {
-    "id": "wolf",
-    "vector": [0.2, 0.8, 0.15],
-    "metadata": {"animal": "wolf", "category": "canine"}
-  },
-  {
-    "id": "lion",
-    "vector": [0.85, 0.15, 0.1],
-    "metadata": {"animal": "lion", "category": "feline"}
-  }
-]
-EOF
-echo "   Created demo-vectors.json with 5 animals"
-echo ""
-
-# 4. Insert vectors
-echo "4. Inserting vectors into database..."
-ruvector insert demo.vec demo-vectors.json
-echo ""
-
-# 5. Show statistics
-echo "5. Database statistics..."
-ruvector stats demo.vec
-echo ""
-
-# 6. Search for cat-like animals
-echo "6. Searching for cat-like animals (vector: [0.9, 0.1, 0.1])..."
-ruvector search demo.vec --vector "[0.9, 0.1, 0.1]" --top-k 3
-echo ""
-
-# 7. Search for dog-like animals
-echo "7. Searching for dog-like animals (vector: [0.1, 0.9, 0.1])..."
-ruvector search demo.vec --vector "[0.1, 0.9, 0.1]" --top-k 3
-echo ""
-
-# 8. Run benchmark
-echo "8. Running performance benchmark..."
-ruvector benchmark --dimension 128 --num-vectors 1000 --num-queries 100
-echo ""
-
-# Cleanup
-echo "9. Cleanup (removing demo files)..."
-rm -f demo.vec demo-vectors.json
-echo "   ✓ Demo files removed"
-echo ""
-
-echo "✅ Demo complete!"