n8n-nodes-minimemory 0.1.0

package/README.md

@@ -0,0 +1,204 @@
+# n8n-nodes-minimemory
+
+An n8n community node for embedded vector database operations - **100% serverless**.
+
+Perform vector similarity search directly within n8n without any external server. Perfect for:
+- RAG (Retrieval Augmented Generation)
+- Semantic search
+- Recommendations
+- Deduplication
+
+## Features
+
+- **No server required** - Everything runs locally within n8n
+- **Similarity search** - Find the k most similar vectors
+- **Multiple metrics** - Cosine, Euclidean, Dot Product
+- **Metadata support** - Associate additional information with each vector
+- **Persistence** - Save/load from JSON files
+- **Bulk insert** - Insert multiple vectors from previous nodes
+
+## Installation
+
+### From n8n UI (Recommended)
+
+1. Go to **Settings** > **Community Nodes**
+2. Search for `n8n-nodes-minimemory`
+3. Click **Install**
+
+### From npm
+
+```bash
+cd ~/.n8n/nodes
+npm install n8n-nodes-minimemory
+```
+
+Then restart n8n.
+
+## Operations
+
+### Create Database
+Create a new vector database in memory.
+
+| Parameter | Description | Example |
+|-----------|-------------|---------|
+| Database Name | Unique name for the DB | `my_vectors` |
+| Dimensions | Number of dimensions | `384` (MiniLM), `1536` (OpenAI) |
+| Distance Metric | Similarity metric | `cosine`, `euclidean`, `dot` |
+| Index Type | Index type | `flat` (exact), `hnsw` (fast) |
+
+### Insert Vector
+Insert a single vector with ID and optional metadata.
+
+| Parameter | Description |
+|-----------|-------------|
+| Vector ID | Unique identifier |
+| Vector | Array of numbers `[0.1, 0.2, ...]` |
+| Metadata | JSON object `{"title": "Doc 1"}` |
+
+### Insert Many
+Bulk insert vectors from input items.
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| ID Field | Field containing the ID | `id` |
+| Vector Field | Field containing the vector | `embedding` |
+| Metadata Fields | Fields for metadata (empty = all) | |
+
+**Example input:**
+```json
+[
+  {"id": "doc1", "embedding": [0.1, 0.2, ...], "title": "Document 1"},
+  {"id": "doc2", "embedding": [0.3, 0.4, ...], "title": "Document 2"}
+]
+```
+
+### Search
+Search for the k nearest neighbors.
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| Query Vector | Query vector | |
+| Number of Results (K) | Number of results | `10` |
+| Include Vectors | Include vectors in result | `false` |
+| Minimum Similarity | Filter by minimum similarity | `0` |
+
+**Output:**
+```json
+{
+  "success": true,
+  "results": [
+    {"id": "doc1", "distance": 0.1, "similarity": 0.9, "metadata": {...}},
+    {"id": "doc2", "distance": 0.2, "similarity": 0.8, "metadata": {...}}
+  ]
+}
+```
+
+### Get
+Get a vector by its ID.
+
+### Delete Vector
+Delete a vector by its ID.
+
+### Save to File
+Save the database to a JSON file.
+
+### Load from File
+Load a database from a JSON file.
+
+### Get Info
+Get database information and statistics.
+
+### List Databases
+List all databases in memory.
+
+### Clear Database
+Remove all vectors from the database.
+
+### Delete Database
+Remove a database from memory.
+
+## Example Workflow
+
+### Basic RAG with OpenAI
+
+```
+[Trigger]
+    |
+[OpenAI Embeddings] -> [Minimemory: Insert Many]
+    |
+[Query Input]
+    |
+[OpenAI Embeddings] -> [Minimemory: Search] -> [OpenAI Chat]
+    |
+[Response]
+```
+
+### Step by step:
+
+1. **Create DB** (run once):
+   - Operation: `Create Database`
+   - Database Name: `docs`
+   - Dimensions: `1536` (OpenAI)
+   - Distance: `cosine`
+
+2. **Index documents**:
+   - Connect node that generates embeddings
+   - Operation: `Insert Many`
+   - ID Field: `id`
+   - Vector Field: `embedding`
+
+3. **Search**:
+   - Connect query with embedding
+   - Operation: `Search`
+   - Query Vector: `{{ $json.embedding }}`
+   - K: `5`
+
+## Persistence
+
+Databases live in memory while n8n is running. To persist:
+
+```
+[Startup Trigger] -> [Minimemory: Load from File]
+                           |
+                    (DB available for use)
+                           |
+[Before shutdown] -> [Minimemory: Save to File]
+```
+
+## Embedding Compatibility
+
+| Model | Dimensions | Notes |
+|-------|------------|-------|
+| all-MiniLM-L6-v2 | 384 | Fast, good for short text |
+| all-mpnet-base-v2 | 768 | Better quality |
+| text-embedding-ada-002 | 1536 | OpenAI legacy |
+| text-embedding-3-small | 1536 | OpenAI new |
+| text-embedding-3-large | 3072 | OpenAI high quality |
+| embed-english-v3.0 | 1024 | Cohere |
+
+## Performance
+
+- **Flat Index**: O(n) - Exact, ideal for < 10,000 vectors
+- **HNSW Index**: O(log n) - Approximate, for large datasets
+
+## Troubleshooting
+
+### "Database not found"
+Make sure to run `Create Database` or `Load from File` first.
+
+### "Dimension mismatch"
+The inserted/searched vector has a different number of dimensions than the DB.
+
+### Node doesn't appear
+1. Verify `npm run build` completed without errors
+2. Check the link with `npm ls -g --link`
+3. Restart n8n
+
+## Support
+
+For issues and feature requests, please visit:
+https://github.com/yourusername/n8n-nodes-minimemory/issues
+
+## License
+
+MIT

package/dist/credentials/MinimemoryConfig.credentials.d.ts

@@ -0,0 +1,8 @@
+import { ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class MinimemoryConfig implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+}
+//# sourceMappingURL=MinimemoryConfig.credentials.d.ts.map

package/dist/credentials/MinimemoryConfig.credentials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MinimemoryConfig.credentials.d.ts","sourceRoot":"","sources":["../../credentials/MinimemoryConfig.credentials.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,eAAe,EACf,eAAe,EACf,MAAM,cAAc,CAAC;AAEtB,qBAAa,gBAAiB,YAAW,eAAe;IACvD,IAAI,SAAsB;IAC1B,WAAW,SAA8B;IACzC,gBAAgB,SAA8C;IAE9D,UAAU,EAAE,eAAe,EAAE,CA2B3B;CACF"}

package/dist/credentials/MinimemoryConfig.credentials.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MinimemoryConfig = void 0;
+class MinimemoryConfig {
+    constructor() {
+        this.name = 'minimemoryConfig';
+        this.displayName = 'Minimemory Configuration';
+        this.documentationUrl = 'https://github.com/minimemory/minimemory';
+        this.properties = [
+            {
+                displayName: 'Default Data Directory',
+                name: 'dataDirectory',
+                type: 'string',
+                default: './data/minimemory',
+                description: 'Default directory for storing .mmdb database files',
+            },
+            {
+                displayName: 'Default Dimensions',
+                name: 'defaultDimensions',
+                type: 'number',
+                default: 384,
+                description: 'Default number of dimensions for new databases (384 for all-MiniLM-L6-v2, 1536 for OpenAI)',
+            },
+            {
+                displayName: 'Default Distance Metric',
+                name: 'defaultDistance',
+                type: 'options',
+                options: [
+                    { name: 'Cosine', value: 'cosine' },
+                    { name: 'Euclidean', value: 'euclidean' },
+                    { name: 'Dot Product', value: 'dot' },
+                ],
+                default: 'cosine',
+                description: 'Default distance metric for new databases',
+            },
+        ];
+    }
+}
+exports.MinimemoryConfig = MinimemoryConfig;
+//# sourceMappingURL=MinimemoryConfig.credentials.js.map

package/dist/credentials/MinimemoryConfig.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MinimemoryConfig.credentials.js","sourceRoot":"","sources":["../../credentials/MinimemoryConfig.credentials.ts"],"names":[],"mappings":";;;AAKA,MAAa,gBAAgB;IAA7B;QACC,SAAI,GAAG,kBAAkB,CAAC;QAC1B,gBAAW,GAAG,0BAA0B,CAAC;QACzC,qBAAgB,GAAG,0CAA0C,CAAC;QAE9D,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,wBAAwB;gBACrC,IAAI,EAAE,eAAe;gBACrB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,mBAAmB;gBAC5B,WAAW,EAAE,oDAAoD;aACjE;YACD;gBACC,WAAW,EAAE,oBAAoB;gBACjC,IAAI,EAAE,mBAAmB;gBACzB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,GAAG;gBACZ,WAAW,EAAE,4FAA4F;aACzG;YACD;gBACC,WAAW,EAAE,yBAAyB;gBACtC,IAAI,EAAE,iBAAiB;gBACvB,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE;oBACR,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE;oBACnC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE;oBACzC,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,KAAK,EAAE;iBACrC;gBACD,OAAO,EAAE,QAAQ;gBACjB,WAAW,EAAE,2CAA2C;aACxD;SACD,CAAC;IACH,CAAC;CAAA;AAjCD,4CAiCC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { Minimemory } from './nodes/Minimemory/Minimemory.node';
+export { MinimemoryConfig } from './credentials/MinimemoryConfig.credentials';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC"}

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MinimemoryConfig = exports.Minimemory = void 0;
+var Minimemory_node_1 = require("./nodes/Minimemory/Minimemory.node");
+Object.defineProperty(exports, "Minimemory", { enumerable: true, get: function () { return Minimemory_node_1.Minimemory; } });
+var MinimemoryConfig_credentials_1 = require("./credentials/MinimemoryConfig.credentials");
+Object.defineProperty(exports, "MinimemoryConfig", { enumerable: true, get: function () { return MinimemoryConfig_credentials_1.MinimemoryConfig; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,sEAAgE;AAAvD,6GAAA,UAAU,OAAA;AACnB,2FAA8E;AAArE,gIAAA,gBAAgB,OAAA"}

package/dist/nodes/Minimemory/Minimemory.node.d.ts

@@ -0,0 +1,6 @@
+import { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class Minimemory implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}
+//# sourceMappingURL=Minimemory.node.d.ts.map

package/dist/nodes/Minimemory/Minimemory.node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Minimemory.node.d.ts","sourceRoot":"","sources":["../../../nodes/Minimemory/Minimemory.node.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,iBAAiB,EACjB,kBAAkB,EAClB,SAAS,EACT,oBAAoB,EAGpB,MAAM,cAAc,CAAC;AAYtB,qBAAa,UAAW,YAAW,SAAS;IAC3C,WAAW,EAAE,oBAAoB,CA6U/B;IAEI,OAAO,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;CAsRvE"}