native-vector-store 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+      (an example is provided in the Appendix below).
+
+      "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 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 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 those 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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/README.md

@@ -0,0 +1,223 @@
+# native-vector-store
+
+High-performance vector store with SIMD optimization for MCP servers and local RAG applications.
+
+## Features
+
+- **🚀 High Performance**: C++ implementation with OpenMP SIMD optimization
+- **📦 Arena Allocation**: Memory-efficient storage with 64MB chunks
+- **⚡ Fast Search**: Sub-10ms similarity search for large document collections
+- **🔧 MCP Integration**: Built for Model Context Protocol servers
+- **🌐 Cross-Platform**: Works on Linux, macOS, and Windows
+- **📊 TypeScript Support**: Full type definitions included
+- **🔄 Producer-Consumer Loading**: Parallel document loading at 178k+ docs/sec
+
+## Performance Targets
+
+- **Load Time**: <1 second for 100,000 documents (achieved: ~560ms)
+- **Search Latency**: <10ms for top-k similarity search (achieved: 1-2ms)
+- **Memory Efficiency**: Minimal fragmentation via arena allocation
+- **Scalability**: Designed for <1M embeddings
+- **Throughput**: 178k+ documents per second with parallel loading
+
+## Installation
+
+```bash
+npm install native-vector-store
+```
+
+### Prerequisites
+
+For most users, **no prerequisites are needed** - prebuilt binaries are included for:
+- Linux (x64, arm64)
+- macOS (x64, arm64/Apple Silicon)
+- Windows (x64)
+
+If building from source, you'll need:
+- Node.js ≥14.0.0
+- C++ compiler with OpenMP support
+- simdjson library (automatically handled by node-gyp)
+
+## Quick Start
+
+```javascript
+const { VectorStore } = require('native-vector-store');
+
+// Initialize with embedding dimensions (e.g., 1536 for OpenAI)
+const store = new VectorStore(1536);
+
+// Load documents from directory
+store.loadDir('./documents'); // Automatically finalizes after loading
+
+// Or add documents manually then finalize
+const document = {
+  id: 'doc-1',
+  text: 'Example document text',
+  metadata: {
+    embedding: new Array(1536).fill(0).map(() => Math.random()),
+    category: 'example'
+  }
+};
+
+store.addDocument(document);
+store.finalize(); // Must call before searching!
+
+// Search for similar documents
+const queryEmbedding = new Float32Array(1536);
+const results = store.search(queryEmbedding, 5); // Top 5 results
+
+console.log(results[0]); // { score: 0.95, id: 'doc-1', text: '...', metadata_json: '...' }
+```
+
+## MCP Server Integration
+
+Perfect for building local RAG capabilities in MCP servers:
+
+```javascript
+const { MCPVectorServer } = require('native-vector-store/examples/mcp-server');
+
+const server = new MCPVectorServer(1536);
+
+// Load document corpus
+await server.loadDocuments('./documents');
+
+// Handle MCP requests
+const response = await server.handleMCPRequest('vector_search', {
+  query: queryEmbedding,
+  k: 5,
+  threshold: 0.7
+});
+```
+
+## API Reference
+
+### `VectorStore`
+
+#### Constructor
+```typescript
+new VectorStore(dimensions: number)
+```
+
+#### Methods
+
+##### `loadDir(path: string): void`
+Load all JSON documents from a directory and automatically finalize the store. Files should contain document objects with embeddings.
+
+##### `addDocument(doc: Document): void`
+Add a single document to the store. Only works during loading phase (before finalization).
+
+```typescript
+interface Document {
+  id: string;
+  text: string;
+  metadata: {
+    embedding: number[];
+    [key: string]: any;
+  };
+}
+```
+
+##### `search(query: Float32Array, k: number, normalizeQuery?: boolean): SearchResult[]`
+Search for k most similar documents.
+
+```typescript
+interface SearchResult {
+  score: number;
+  id: string;
+  text: string;
+  metadata_json: string;
+}
+```
+
+##### `finalize(): void`
+Finalize the store: normalize all embeddings and switch to serving mode. After this, no more documents can be added but searches become available. This is automatically called by `loadDir()`.
+
+##### `isFinalized(): boolean`
+Check if the store has been finalized and is ready for searching.
+
+##### `normalize(): void`
+**Deprecated**: Use `finalize()` instead.
+
+##### `size(): number`
+Get the number of documents in the store.
+
+## Building from Source
+
+```bash
+# Install dependencies
+npm install
+
+# Build native module
+npm run build
+
+# Run tests
+npm test
+
+# Run performance benchmarks
+npm run benchmark
+
+# Try MCP server example
+npm run example
+```
+
+## Architecture
+
+### Memory Layout
+- **Arena Allocator**: 64MB chunks for cache-friendly access
+- **Contiguous Storage**: Embeddings, strings, and metadata in single allocations
+- **Zero-Copy Design**: Direct memory access without serialization overhead
+
+### SIMD Optimization
+- **OpenMP Pragmas**: Vectorized dot product operations
+- **Parallel Processing**: Multi-threaded JSON loading and search
+- **Cache-Friendly**: Aligned memory access patterns
+
+### Performance Characteristics
+- **Load Performance**: O(n) with parallel JSON parsing
+- **Search Performance**: O(n⋅d) with SIMD acceleration
+- **Memory Usage**: ~(d⋅4 + text_size) bytes per document
+
+## Use Cases
+
+### MCP Servers
+Ideal for building local RAG (Retrieval-Augmented Generation) capabilities:
+- Fast document loading from knowledge bases
+- Low-latency similarity search for context retrieval
+- Memory-efficient storage for large document collections
+
+### Knowledge Management
+Perfect for personal knowledge management systems:
+- Index personal documents and notes
+- Fast semantic search across content
+- Offline operation without external dependencies
+
+### Research Applications
+Suitable for academic and research projects:
+- Literature review and citation analysis
+- Semantic clustering of research papers
+- Cross-reference discovery in document collections
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests for new functionality
+5. Ensure all tests pass
+6. Submit a pull request
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Benchmarks
+
+Performance on M1 MacBook Pro with 1536-dimensional embeddings:
+
+| Operation | Document Count | Time | Rate |
+|-----------|---------------|------|------|
+| Load | 10,000 | 245ms | 40.8k docs/sec |
+| Search | 10,000 | 3.2ms | 3.1M docs/sec |
+| Normalize | 10,000 | 12ms | 833k docs/sec |
+
+*Results may vary based on hardware and document characteristics.*

package/binding.gyp

@@ -0,0 +1,45 @@
+{
+  "targets": [
+    {
+      "target_name": "vector_store",
+      "sources": ["src/binding.cc", "src/vector_store_loader.cpp", "src/vector_store_loader_mmap.cpp", "src/vector_store_loader_adaptive.cpp"],
+      "include_dirs": [
+        "<!@(node -p \"require('node-addon-api').include\")",
+        "src"
+      ],
+      "dependencies": ["<!(node -p \"require('node-addon-api').gyp\")"],
+      "cflags_cc": [
+        "-std=c++17",
+        "-O3",
+        "-march=native",
+        "-fno-exceptions"
+      ],
+      "defines": ["NAPI_DISABLE_CPP_EXCEPTIONS"],
+      "conditions": [
+        ["OS=='mac'", {
+          "include_dirs": ["/opt/homebrew/opt/libomp/include", "/opt/homebrew/include"],
+          "xcode_settings": {
+            "GCC_ENABLE_CPP_EXCEPTIONS": "NO",
+            "OTHER_CFLAGS": ["-Xpreprocessor", "-fopenmp"],
+            "OTHER_CPLUSPLUSFLAGS": ["-Xpreprocessor", "-fopenmp"],
+            "OTHER_LDFLAGS": ["-L/opt/homebrew/opt/libomp/lib", "-lomp"]
+          },
+          "libraries": ["-L/opt/homebrew/opt/libomp/lib", "-lomp", "-L/opt/homebrew/lib", "-lsimdjson"]
+        }],
+        ["OS=='linux'", {
+          "cflags_cc": ["-fopenmp"],
+          "libraries": ["-lgomp", "-lsimdjson"]
+        }],
+        ["OS=='win'", {
+          "msvs_settings": {
+            "VCCLCompilerTool": {
+              "ExceptionHandling": 0,
+              "OpenMP": "true"
+            }
+          },
+          "libraries": ["simdjson.lib"]
+        }]
+      ]
+    }
+  ]
+}

package/index.js

@@ -0,0 +1,3 @@
+const { VectorStore } = require('node-gyp-build')(__dirname);
+
+module.exports = { VectorStore };

package/lib/index.d.ts

@@ -0,0 +1,60 @@
+export interface Document {
+  id: string;
+  text: string;
+  metadata: {
+    embedding?: number[];
+    [key: string]: any;
+  };
+}
+
+export interface SearchResult {
+  score: number;
+  id: string;
+  text: string;
+  metadata_json: string;
+}
+
+export class VectorStore {
+  constructor(dimensions: number);
+  
+  /**
+   * Load all JSON documents from a directory
+   * Files should contain Document objects with embeddings in metadata
+   */
+  loadDir(path: string): void;
+  
+  /**
+   * Add a single document
+   */
+  addDocument(doc: Document): void;
+  
+  /**
+   * Search for k most similar documents
+   * @param query - Query embedding vector
+   * @param k - Number of results to return
+   * @param normalizeQuery - Whether to L2 normalize the query (default: true)
+   */
+  search(query: Float32Array, k: number, normalizeQuery?: boolean): SearchResult[];
+  
+  /**
+   * Normalize all stored embeddings
+   * @deprecated Use finalize() instead
+   */
+  normalize(): void;
+  
+  /**
+   * Finalize the store: normalize embeddings and switch to serving mode
+   * After calling this, no more documents can be added
+   */
+  finalize(): void;
+  
+  /**
+   * Check if the store has been finalized
+   */
+  isFinalized(): boolean;
+  
+  /**
+   * Get the number of documents in the store
+   */
+  size(): number;
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "native-vector-store",
+  "version": "0.1.0",
+  "description": "High-performance local vector store with SIMD optimization for MCP servers",
+  "main": "index.js",
+  "types": "lib/index.d.ts",
+  "author": "Martin Boros <mboros04@gmail.com>",
+  "license": "Apache 2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mboros1/native-vector-store.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mboros1/native-vector-store/issues"
+  },
+  "homepage": "https://github.com/mboros1/native-vector-store#readme",
+  "scripts": {
+    "build": "node-gyp rebuild",
+    "clean": "node-gyp clean",
+    "test": "node test/test.js",
+    "install": "node-gyp-build",
+    "prebuildify": "prebuildify --napi --strip",
+    "prebuildify-cross": "prebuildify-cross -i centos7-devtoolset7 -i alpine -i linux-arm64 -i darwin-arm64 -i darwin-x64+arm64",
+    "benchmark": "node test/test.js",
+    "example": "node examples/mcp-server.js demo",
+    "embed": "node embed_dir.js"
+  },
+  "keywords": [
+    "vector",
+    "embedding",
+    "similarity",
+    "search",
+    "simd",
+    "mcp"
+  ],
+  "dependencies": {
+    "dotenv": "^17.2.0",
+    "node-addon-api": "^7.0.0",
+    "node-gyp-build": "^4.8.0",
+    "openai": "^5.8.3"
+  },
+  "devDependencies": {
+    "node-gyp": "^10.0.0",
+    "prebuildify": "^6.0.0"
+  },
+  "os": ["darwin", "linux", "win32"],
+  "cpu": ["x64", "arm64"],
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "gypfile": true
+}

package/scripts/build-prebuilds.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+# Build prebuilds for current platform
+echo "Building prebuilds for native-vector-store..."
+
+# Clean previous builds
+rm -rf prebuilds/
+
+# Build for current platform and architecture
+echo "Building for current platform..."
+npx prebuildify --napi --strip
+
+# For local testing on macOS, build both architectures if on Apple Silicon
+if [[ "$OSTYPE" == "darwin"* ]] && [[ "$(uname -m)" == "arm64" ]]; then
+    echo "Building universal binary for macOS..."
+    npx prebuildify --napi --strip --arch x64
+    npx prebuildify --napi --strip --arch arm64
+fi
+
+echo "Prebuilds created:"
+find prebuilds -type f -name "*.node" | sort
+
+echo "Done!"