@neural-tools/vector-db 0.1.3

package/LICENSE.md

@@ -0,0 +1,80 @@
+# Neural Tools License
+
+Copyright (c) 2025 Luke Amy. All rights reserved.
+
+## License Agreement
+
+This software is provided under a dual-license model:
+
+### 1. Free Tier License (MIT)
+
+The following components are licensed under the MIT License:
+
+- Basic MCP generation functionality
+- Claude command generation
+- Core utilities and types
+- Basic templates
+- Documentation and examples
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of the free tier components to use, copy, modify, merge, publish, and distribute, 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.
+
+### 2. Pro/Enterprise License (Proprietary)
+
+The following features require a valid Pro or Enterprise license:
+
+**Pro Features:**
+- Vector database integration
+- Semantic caching
+- Fine-tuning workflows
+- Cloud deployment templates (AWS/GCP)
+- Premium templates and examples
+- GitHub automation features
+
+**Enterprise Features:**
+- White-label support
+- Custom integrations
+- Priority support
+- SLA guarantees
+- Team collaboration features
+
+These features are proprietary and may not be used without a valid license key purchased from neural-tools.dev.
+
+### License Terms
+
+1. **Free Tier**: You may use the free tier features for any purpose, including commercial use, under the MIT License terms.
+
+2. **Pro/Enterprise**: You must purchase a license to access Pro or Enterprise features. Each license is:
+   - Per-user for individual licenses
+   - Per-organization for team/enterprise licenses
+   - Non-transferable without written consent
+   - Subject to the terms at neural-tools.dev/terms
+
+3. **Source Code**: This repository is private. You may not:
+   - Redistribute the source code
+   - Create derivative works for redistribution
+   - Reverse engineer Pro/Enterprise features
+   - Remove or circumvent license checks
+
+4. **Support**: Support is provided based on your license tier:
+   - Free: Community support only
+   - Pro: Email support (48-hour response)
+   - Enterprise: Priority support with SLA
+
+### Warranty Disclaimer
+
+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.
+
+### Contact
+
+For licensing inquiries:
+- Email: licensing@neural-tools.dev
+- Website: https://neural-tools.dev/pricing
+- Support: support@neural-tools.dev
+
+---
+
+**Last Updated:** January 2025

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import { VectorDBConfig, VectorStore } from './types';
+export * from './types';
+export { LocalVectorStore } from './local-store';
+/**
+ * Create a vector store instance based on the configuration
+ */
+export declare function createVectorStore(config: VectorDBConfig): Promise<VectorStore>;
+/**
+ * Helper function to create embeddings from text
+ * In production, this would call OpenAI, Anthropic, or other embedding APIs
+ */
+export declare function createEmbedding(text: string): Promise<number[]>;
+/**
+ * Batch text into chunks for embedding
+ */
+export declare function chunkText(text: string, options?: {
+    chunkSize?: number;
+    overlap?: number;
+}): string[];

package/dist/index.js

@@ -0,0 +1,87 @@
+"use strict";
+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.LocalVectorStore = void 0;
+exports.createVectorStore = createVectorStore;
+exports.createEmbedding = createEmbedding;
+exports.chunkText = chunkText;
+const local_store_1 = require("./local-store");
+const core_1 = require("@neural-tools/core");
+__exportStar(require("./types"), exports);
+var local_store_2 = require("./local-store");
+Object.defineProperty(exports, "LocalVectorStore", { enumerable: true, get: function () { return local_store_2.LocalVectorStore; } });
+/**
+ * Create a vector store instance based on the configuration
+ */
+async function createVectorStore(config) {
+    switch (config.provider) {
+        case 'local':
+            return new local_store_1.LocalVectorStore(config);
+        case 'pinecone':
+            await (0, core_1.requireFeature)('vector-db', 'Vector Database Integration');
+            throw new Error('Pinecone integration coming soon. Use local provider for now.');
+        case 'qdrant':
+            await (0, core_1.requireFeature)('vector-db', 'Vector Database Integration');
+            throw new Error('Qdrant integration coming soon. Use local provider for now.');
+        case 'chromadb':
+            await (0, core_1.requireFeature)('vector-db', 'Vector Database Integration');
+            throw new Error('ChromaDB integration coming soon. Use local provider for now.');
+        default:
+            throw new Error(`Unknown vector store provider: ${config.provider}`);
+    }
+}
+/**
+ * Helper function to create embeddings from text
+ * In production, this would call OpenAI, Anthropic, or other embedding APIs
+ */
+async function createEmbedding(text) {
+    // Placeholder: Simple hash-based embedding for testing
+    // In production, use proper embedding models
+    const hash = simpleHash(text);
+    const dimension = 384; // Common embedding dimension
+    const embedding = new Array(dimension).fill(0);
+    // Create a deterministic but distributed embedding from hash
+    for (let i = 0; i < dimension; i++) {
+        embedding[i] = Math.sin(hash + i) * Math.cos(hash / (i + 1));
+    }
+    // Normalize
+    const norm = Math.sqrt(embedding.reduce((sum, val) => sum + val * val, 0));
+    return embedding.map(val => val / norm);
+}
+function simpleHash(str) {
+    let hash = 0;
+    for (let i = 0; i < str.length; i++) {
+        const char = str.charCodeAt(i);
+        hash = ((hash << 5) - hash) + char;
+        hash = hash & hash; // Convert to 32-bit integer
+    }
+    return Math.abs(hash);
+}
+/**
+ * Batch text into chunks for embedding
+ */
+function chunkText(text, options = {}) {
+    const chunkSize = options.chunkSize || 500;
+    const overlap = options.overlap || 50;
+    const chunks = [];
+    let start = 0;
+    while (start < text.length) {
+        const end = Math.min(start + chunkSize, text.length);
+        chunks.push(text.slice(start, end));
+        start += chunkSize - overlap;
+    }
+    return chunks;
+}

package/dist/local-store.d.ts

@@ -0,0 +1,30 @@
+import { VectorStore, Vector, QueryResult, QueryOptions, UpsertOptions } from './types';
+/**
+ * Simple in-memory vector store for local development and testing
+ */
+export declare class LocalVectorStore extends VectorStore {
+    private vectors;
+    connect(): Promise<void>;
+    upsert(vectors: Vector[], options?: UpsertOptions): Promise<void>;
+    query(vector: number[], options?: QueryOptions): Promise<QueryResult[]>;
+    delete(ids: string[]): Promise<void>;
+    fetch(ids: string[]): Promise<Vector[]>;
+    deleteNamespace(): Promise<void>;
+    disconnect(): Promise<void>;
+    /**
+     * Calculate cosine similarity between two vectors
+     */
+    private cosineSimilarity;
+    /**
+     * Check if metadata matches filter
+     */
+    private matchesFilter;
+    /**
+     * Get all vectors (for testing/debugging)
+     */
+    getAll(): Vector[];
+    /**
+     * Get count of vectors
+     */
+    count(): number;
+}

package/dist/local-store.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalVectorStore = void 0;
+const types_1 = require("./types");
+/**
+ * Simple in-memory vector store for local development and testing
+ */
+class LocalVectorStore extends types_1.VectorStore {
+    vectors = new Map();
+    async connect() {
+        // No connection needed for local store
+    }
+    async upsert(vectors, options) {
+        for (const vector of vectors) {
+            this.vectors.set(vector.id, vector);
+        }
+    }
+    async query(vector, options) {
+        const topK = options?.topK || 10;
+        const results = [];
+        // Calculate similarity for all vectors
+        for (const [id, storedVector] of this.vectors) {
+            // Skip if filter doesn't match
+            if (options?.filter && !this.matchesFilter(storedVector.metadata, options.filter)) {
+                continue;
+            }
+            const score = this.cosineSimilarity(vector, storedVector.values);
+            results.push({
+                id,
+                score,
+                metadata: options?.includeMetadata !== false ? storedVector.metadata : undefined,
+                values: options?.includeValues ? storedVector.values : undefined
+            });
+        }
+        // Sort by score descending and take topK
+        results.sort((a, b) => b.score - a.score);
+        return results.slice(0, topK);
+    }
+    async delete(ids) {
+        for (const id of ids) {
+            this.vectors.delete(id);
+        }
+    }
+    async fetch(ids) {
+        const results = [];
+        for (const id of ids) {
+            const vector = this.vectors.get(id);
+            if (vector) {
+                results.push(vector);
+            }
+        }
+        return results;
+    }
+    async deleteNamespace() {
+        this.vectors.clear();
+    }
+    async disconnect() {
+        // No cleanup needed for local store
+    }
+    /**
+     * Calculate cosine similarity between two vectors
+     */
+    cosineSimilarity(a, b) {
+        if (a.length !== b.length) {
+            throw new Error('Vectors must have same length');
+        }
+        let dotProduct = 0;
+        let normA = 0;
+        let 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));
+    }
+    /**
+     * Check if metadata matches filter
+     */
+    matchesFilter(metadata, filter) {
+        if (!metadata)
+            return false;
+        for (const [key, value] of Object.entries(filter)) {
+            if (metadata[key] !== value) {
+                return false;
+            }
+        }
+        return true;
+    }
+    /**
+     * Get all vectors (for testing/debugging)
+     */
+    getAll() {
+        return Array.from(this.vectors.values());
+    }
+    /**
+     * Get count of vectors
+     */
+    count() {
+        return this.vectors.size;
+    }
+}
+exports.LocalVectorStore = LocalVectorStore;

package/dist/types.d.ts

@@ -0,0 +1,61 @@
+export interface VectorDBConfig {
+    provider: 'pinecone' | 'qdrant' | 'chromadb' | 'local';
+    apiKey?: string;
+    endpoint?: string;
+    dimension?: number;
+    metric?: 'cosine' | 'euclidean' | 'dotproduct';
+    namespace?: string;
+}
+export interface Vector {
+    id: string;
+    values: number[];
+    metadata?: Record<string, any>;
+}
+export interface QueryResult {
+    id: string;
+    score: number;
+    metadata?: Record<string, any>;
+    values?: number[];
+}
+export interface QueryOptions {
+    topK?: number;
+    filter?: Record<string, any>;
+    includeValues?: boolean;
+    includeMetadata?: boolean;
+}
+export interface UpsertOptions {
+    namespace?: string;
+    batch?: boolean;
+}
+export declare abstract class VectorStore {
+    protected config: VectorDBConfig;
+    constructor(config: VectorDBConfig);
+    /**
+     * Initialize the vector store connection
+     */
+    abstract connect(): Promise<void>;
+    /**
+     * Insert or update vectors
+     */
+    abstract upsert(vectors: Vector[], options?: UpsertOptions): Promise<void>;
+    /**
+     * Query for similar vectors
+     */
+    abstract query(vector: number[], options?: QueryOptions): Promise<QueryResult[]>;
+    /**
+     * Delete vectors by ID
+     */
+    abstract delete(ids: string[], namespace?: string): Promise<void>;
+    /**
+     * Get vector by ID
+     */
+    abstract fetch(ids: string[], namespace?: string): Promise<Vector[]>;
+    /**
+     * Delete all vectors in a namespace
+     */
+    abstract deleteNamespace(namespace: string): Promise<void>;
+    /**
+     * Close the connection
+     */
+    abstract disconnect(): Promise<void>;
+}

package/dist/types.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VectorStore = void 0;
+class VectorStore {
+    config;
+    constructor(config) {
+        this.config = config;
+    }
+}
+exports.VectorStore = VectorStore;

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@neural-tools/vector-db",
+  "version": "0.1.3",
+  "description": "Vector database abstraction layer for Neural Tools",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "SEE LICENSE IN ../../LICENSE.md",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MacLeanLuke/ai-toolkit.git",
+    "directory": "packages/vector-db"
+  },
+  "dependencies": {
+    "@neural-tools/core": "0.1.3"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.5",
+    "typescript": "^5.3.3"
+  },
+  "peerDependencies": {
+    "@pinecone-database/pinecone": "^2.0.0",
+    "chromadb": "^1.7.0",
+    "@qdrant/js-client-rest": "^1.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@pinecone-database/pinecone": {
+      "optional": true
+    },
+    "chromadb": {
+      "optional": true
+    },
+    "@qdrant/js-client-rest": {
+      "optional": true
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "clean": "rm -rf dist",
+    "test": "echo 'Tests coming soon'"
+  }
+}