ruvector 0.1.38 → 0.1.39

package/dist/index.js

@@ -1,98 +1,178 @@
 "use strict";
 /**
- * rUvector - High-performance vector database
- * Smart loader that tries native bindings first, falls back to WASM
+ * ruvector - High-performance vector database for Node.js
+ *
+ * This package automatically detects and uses the best available implementation:
+ * 1. Native (Rust-based, fastest) - if available for your platform
+ * 2. WASM (WebAssembly, universal fallback) - works everywhere
+ *
+ * Also provides safe wrappers for GNN and Attention modules that handle
+ * array type conversions automatically.
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VectorIndex = exports.Utils = void 0;
-exports.getBackendInfo = getBackendInfo;
-exports.isNativeAvailable = isNativeAvailable;
-
-let backend;
-let backendType = 'wasm';
-
-function loadBackend() {
-  if (backend) return backend;
-  try {
-    backend = require('@ruvector/core');
-    backendType = 'native';
-    return backend;
-  } catch (e) {
-    try {
-      backend = require('@ruvector/wasm');
-      backendType = 'wasm';
-      return backend;
-    } catch (wasmError) {
-      throw new Error('Failed to load rUvector backend. Please install @ruvector/core or @ruvector/wasm.');
+exports.NativeVectorDb = exports.VectorDB = exports.VectorDb = void 0;
+exports.getImplementationType = getImplementationType;
+exports.isNative = isNative;
+exports.isWasm = isWasm;
+exports.getVersion = getVersion;
+__exportStar(require("./types"), exports);
+// Export core wrappers (safe interfaces with automatic type conversion)
+__exportStar(require("./core"), exports);
+__exportStar(require("./services"), exports);
+let implementation;
+let implementationType = 'wasm';
+try {
+    // Try to load native module first
+    implementation = require('@ruvector/core');
+    implementationType = 'native';
+    // Verify it's actually working
+    if (typeof implementation.VectorDB !== 'function') {
+        throw new Error('Native module loaded but VectorDB not found');
     }
-  }
 }
-
-class VectorIndex {
-  constructor(options) {
-    const backend = loadBackend();
-    this.index = new backend.VectorIndex(options);
-  }
-  async insert(vector) { return this.index.insert(vector); }
-  async insertBatch(vectors, options) {
-    if (this.index.insertBatch) return this.index.insertBatch(vectors, options);
-    const batchSize = options?.batchSize || 1000;
-    for (let i = 0; i < vectors.length; i += batchSize) {
-      const batch = vectors.slice(i, Math.min(i + batchSize, vectors.length));
-      await Promise.all(batch.map(v => this.insert(v)));
-      if (options?.progressCallback) options.progressCallback(Math.min(i + batchSize, vectors.length) / vectors.length);
-    }
-  }
-  async search(query, options) { return this.index.search(query, options); }
-  async get(id) { return this.index.get(id); }
-  async delete(id) { return this.index.delete(id); }
-  async stats() { return this.index.stats(); }
-  async save(path) { return this.index.save(path); }
-  static async load(path) {
-    const backend = loadBackend();
-    const index = await backend.VectorIndex.load(path);
-    const wrapper = Object.create(VectorIndex.prototype);
-    wrapper.index = index;
-    return wrapper;
-  }
-  async clear() { return this.index.clear(); }
-  async optimize() { if (this.index.optimize) return this.index.optimize(); }
+catch (e) {
+    // No WASM fallback available yet
+    throw new Error(`Failed to load ruvector native module.\n` +
+        `Error: ${e.message}\n` +
+        `\nSupported platforms:\n` +
+        `- Linux x64/ARM64\n` +
+        `- macOS Intel/Apple Silicon\n` +
+        `- Windows x64\n` +
+        `\nIf you're on a supported platform, try:\n` +
+        `  npm install --force @ruvector/core`);
 }
-exports.VectorIndex = VectorIndex;
-
-const Utils = {
-  cosineSimilarity(a, b) {
-    if (a.length !== b.length) throw new Error('Vectors must have the same dimension');
-    let dotProduct = 0, normA = 0, normB = 0;
-    for (let i = 0; i < a.length; i++) { dotProduct += a[i] * b[i]; normA += a[i] * a[i]; normB += b[i] * b[i]; }
-    return dotProduct / (Math.sqrt(normA) * Math.sqrt(normB));
-  },
-  euclideanDistance(a, b) {
-    if (a.length !== b.length) throw new Error('Vectors must have the same dimension');
-    let sum = 0;
-    for (let i = 0; i < a.length; i++) { const diff = a[i] - b[i]; sum += diff * diff; }
-    return Math.sqrt(sum);
-  },
-  normalize(vector) {
-    const norm = Math.sqrt(vector.reduce((sum, val) => sum + val * val, 0));
-    return vector.map(val => val / norm);
-  },
-  randomVector(dimension) {
-    const vector = new Array(dimension);
-    for (let i = 0; i < dimension; i++) vector[i] = Math.random() * 2 - 1;
-    return this.normalize(vector);
-  }
-};
-exports.Utils = Utils;
-
-function getBackendInfo() {
-  loadBackend();
-  const features = backendType === 'native' ? ['SIMD', 'Multi-threading', 'Memory-mapped I/O'] : ['Browser-compatible', 'No native dependencies'];
-  return { type: backendType, version: require('../package.json').version, features };
+/**
+ * Get the current implementation type
+ */
+function getImplementationType() {
+    return implementationType;
 }
-
-function isNativeAvailable() {
-  try { require.resolve('@ruvector/core'); return true; } catch { return false; }
+/**
+ * Check if native implementation is being used
+ */
+function isNative() {
+    return implementationType === 'native';
+}
+/**
+ * Check if WASM implementation is being used
+ */
+function isWasm() {
+    return implementationType === 'wasm';
+}
+/**
+ * Get version information
+ */
+function getVersion() {
+    const pkg = require('../package.json');
+    return {
+        version: pkg.version,
+        implementation: implementationType
+    };
+}
+/**
+ * Wrapper class that automatically handles metadata JSON conversion
+ */
+class VectorDBWrapper {
+    constructor(options) {
+        this.db = new implementation.VectorDb(options);
+    }
+    /**
+     * Insert a vector with optional metadata (objects are auto-converted to JSON)
+     */
+    async insert(entry) {
+        const nativeEntry = {
+            id: entry.id,
+            vector: entry.vector instanceof Float32Array ? entry.vector : new Float32Array(entry.vector),
+        };
+        // Auto-convert metadata object to JSON string
+        if (entry.metadata) {
+            nativeEntry.metadata = JSON.stringify(entry.metadata);
+        }
+        return this.db.insert(nativeEntry);
+    }
+    /**
+     * Insert multiple vectors in batch
+     */
+    async insertBatch(entries) {
+        const nativeEntries = entries.map(entry => ({
+            id: entry.id,
+            vector: entry.vector instanceof Float32Array ? entry.vector : new Float32Array(entry.vector),
+            metadata: entry.metadata ? JSON.stringify(entry.metadata) : undefined,
+        }));
+        return this.db.insertBatch(nativeEntries);
+    }
+    /**
+     * Search for similar vectors (metadata is auto-parsed from JSON)
+     */
+    async search(query) {
+        const nativeQuery = {
+            vector: query.vector instanceof Float32Array ? query.vector : new Float32Array(query.vector),
+            k: query.k,
+            efSearch: query.efSearch,
+        };
+        // Auto-convert filter object to JSON string
+        if (query.filter) {
+            nativeQuery.filter = JSON.stringify(query.filter);
+        }
+        const results = await this.db.search(nativeQuery);
+        // Auto-parse metadata JSON strings back to objects
+        return results.map((r) => ({
+            id: r.id,
+            score: r.score,
+            vector: r.vector,
+            metadata: r.metadata ? JSON.parse(r.metadata) : undefined,
+        }));
+    }
+    /**
+     * Get a vector by ID (metadata is auto-parsed from JSON)
+     */
+    async get(id) {
+        const entry = await this.db.get(id);
+        if (!entry)
+            return null;
+        return {
+            id: entry.id,
+            vector: entry.vector,
+            metadata: entry.metadata ? JSON.parse(entry.metadata) : undefined,
+        };
+    }
+    /**
+     * Delete a vector by ID
+     */
+    async delete(id) {
+        return this.db.delete(id);
+    }
+    /**
+     * Get the number of vectors in the database
+     */
+    async len() {
+        return this.db.len();
+    }
+    /**
+     * Check if the database is empty
+     */
+    async isEmpty() {
+        return this.db.isEmpty();
+    }
 }
-
-exports.default = VectorIndex;
+// Export the wrapper class (aliased as VectorDB for backwards compatibility)
+exports.VectorDb = VectorDBWrapper;
+exports.VectorDB = VectorDBWrapper;
+// Also export the raw native implementation for advanced users
+exports.NativeVectorDb = implementation.VectorDb;
+// Export everything from the implementation
+exports.default = implementation;

package/dist/services/embedding-service.d.ts

@@ -0,0 +1,136 @@
+/**
+ * Embedding Service - Unified embedding generation and management
+ *
+ * This service provides a unified interface for generating, caching, and
+ * managing embeddings from various sources (local models, APIs, etc.)
+ */
+/**
+ * Embedding provider interface
+ */
+export interface EmbeddingProvider {
+    /** Provider name */
+    name: string;
+    /** Generate embeddings for texts */
+    embed(texts: string[]): Promise<number[][]>;
+    /** Get embedding dimensions */
+    getDimensions(): number;
+}
+/**
+ * Embedding service configuration
+ */
+export interface EmbeddingServiceConfig {
+    /** Default provider to use */
+    defaultProvider?: string;
+    /** Maximum cache size */
+    maxCacheSize?: number;
+    /** Cache TTL in milliseconds */
+    cacheTtl?: number;
+    /** Batch size for embedding generation */
+    batchSize?: number;
+}
+/**
+ * Mock embedding provider for testing
+ */
+export declare class MockEmbeddingProvider implements EmbeddingProvider {
+    name: string;
+    private dimensions;
+    constructor(dimensions?: number);
+    embed(texts: string[]): Promise<number[][]>;
+    getDimensions(): number;
+}
+/**
+ * Simple local embedding using character n-grams
+ * This is a fallback when no external provider is available
+ */
+export declare class LocalNGramProvider implements EmbeddingProvider {
+    name: string;
+    private dimensions;
+    private ngramSize;
+    constructor(dimensions?: number, ngramSize?: number);
+    embed(texts: string[]): Promise<number[][]>;
+    private embedSingle;
+    private hashNgram;
+    getDimensions(): number;
+}
+/**
+ * Embedding service with caching and batching
+ */
+export declare class EmbeddingService {
+    private providers;
+    private cache;
+    private config;
+    constructor(config?: EmbeddingServiceConfig);
+    /**
+     * Register an embedding provider
+     */
+    registerProvider(provider: EmbeddingProvider): void;
+    /**
+     * Get a registered provider
+     */
+    getProvider(name?: string): EmbeddingProvider;
+    /**
+     * Generate embeddings for texts with caching
+     *
+     * @param texts - Texts to embed
+     * @param provider - Provider name (uses default if not specified)
+     * @returns Array of embeddings
+     */
+    embed(texts: string[], provider?: string): Promise<number[][]>;
+    /**
+     * Generate a single embedding
+     */
+    embedOne(text: string, provider?: string): Promise<number[]>;
+    /**
+     * Add entry to cache with LRU eviction
+     */
+    private addToCache;
+    /**
+     * Compute cosine similarity between two embeddings
+     */
+    cosineSimilarity(a: number[], b: number[]): number;
+    /**
+     * Find most similar texts from a corpus
+     */
+    findSimilar(query: string, corpus: string[], k?: number, provider?: string): Promise<{
+        text: string;
+        similarity: number;
+        index: number;
+    }[]>;
+    /**
+     * Get cache statistics
+     */
+    getCacheStats(): {
+        size: number;
+        maxSize: number;
+        hitRate: number;
+    };
+    /**
+     * Clear the cache
+     */
+    clearCache(): void;
+    /**
+     * Get embedding dimensions for a provider
+     */
+    getDimensions(provider?: string): number;
+    /**
+     * List available providers
+     */
+    listProviders(): string[];
+}
+/**
+ * Create an embedding service instance
+ */
+export declare function createEmbeddingService(config?: EmbeddingServiceConfig): EmbeddingService;
+/**
+ * Get the default embedding service instance
+ */
+export declare function getDefaultEmbeddingService(): EmbeddingService;
+declare const _default: {
+    EmbeddingService: typeof EmbeddingService;
+    LocalNGramProvider: typeof LocalNGramProvider;
+    MockEmbeddingProvider: typeof MockEmbeddingProvider;
+    createEmbeddingService: typeof createEmbeddingService;
+    getDefaultEmbeddingService: typeof getDefaultEmbeddingService;
+};
+export default _default;
+//# sourceMappingURL=embedding-service.d.ts.map

package/dist/services/embedding-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"embedding-service.d.ts","sourceRoot":"","sources":["../../src/services/embedding-service.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC5C,+BAA+B;IAC/B,aAAa,IAAI,MAAM,CAAC;CACzB;AAWD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,8BAA8B;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,yBAAyB;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAeD;;GAEG;AACH,qBAAa,qBAAsB,YAAW,iBAAiB;IAC7D,IAAI,SAAU;IACd,OAAO,CAAC,UAAU,CAAS;gBAEf,UAAU,GAAE,MAAY;IAI9B,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;IAoBjD,aAAa,IAAI,MAAM;CAGxB;AAED;;;GAGG;AACH,qBAAa,kBAAmB,YAAW,iBAAiB;IAC1D,IAAI,SAAiB;IACrB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,SAAS,CAAS;gBAEd,UAAU,GAAE,MAAY,EAAE,SAAS,GAAE,MAAU;IAKrD,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;IAIjD,OAAO,CAAC,WAAW;IAiBnB,OAAO,CAAC,SAAS;IAQjB,aAAa,IAAI,MAAM;CAGxB;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,SAAS,CAA6C;IAC9D,OAAO,CAAC,KAAK,CAAsC;IACnD,OAAO,CAAC,MAAM,CAAmC;gBAErC,MAAM,GAAE,sBAA2B;IAa/C;;OAEG;IACH,gBAAgB,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI;IAInD;;OAEG;IACH,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,iBAAiB;IAS7C;;;;;;OAMG;IACG,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;IAkDpE;;OAEG;IACG,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAKlE;;OAEG;IACH,OAAO,CAAC,UAAU;IAwBlB;;OAEG;IACH,gBAAgB,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM;IAmBlD;;OAEG;IACG,WAAW,CACf,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EAAE,EAChB,CAAC,GAAE,MAAU,EACb,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAcjE;;OAEG;IACH,aAAa,IAAI;QACf,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;KACjB;IAaD;;OAEG;IACH,UAAU,IAAI,IAAI;IAIlB;;OAEG;IACH,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM;IAIxC;;OAEG;IACH,aAAa,IAAI,MAAM,EAAE;CAG1B;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,CAAC,EAAE,sBAAsB,GAC9B,gBAAgB,CAElB;AAKD;;GAEG;AACH,wBAAgB,0BAA0B,IAAI,gBAAgB,CAK7D;;;;;;;;AAED,wBAME"}