@mastra/mongodb 0.0.2-alpha.0

package/.turbo/turbo-build.log

@@ -0,0 +1,23 @@
+
+> @mastra/mongodb@0.0.2-alpha.0 build /home/runner/work/mastra/mastra/stores/mongodb
+> tsup src/index.ts --format esm,cjs --experimental-dts --clean --treeshake=smallest --splitting
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.4.0
+TSC Build start
+TSC ⚡️ Build success in 7439ms
+DTS Build start
+CLI Target: es2022
+Analysis will use the bundled TypeScript version 5.8.2
+Writing package typings: /home/runner/work/mastra/mastra/stores/mongodb/dist/_tsup-dts-rollup.d.ts
+Analysis will use the bundled TypeScript version 5.8.2
+Writing package typings: /home/runner/work/mastra/mastra/stores/mongodb/dist/_tsup-dts-rollup.d.cts
+DTS ⚡️ Build success in 9094ms
+CLI Cleaning output folder
+ESM Build start
+CJS Build start
+CJS dist/index.cjs 12.43 KB
+CJS ⚡️ Build success in 784ms
+ESM dist/index.js 12.39 KB
+ESM ⚡️ Build success in 784ms

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @mastra/mongodb
+
+## 0.0.2-alpha.0
+
+### Patch Changes
+
+- c18f562: MongoDBVector for Vector Database support
+- Updated dependencies [20275d4]
+- Updated dependencies [7d1892c]
+- Updated dependencies [a90a082]
+- Updated dependencies [35955b0]
+- Updated dependencies [c1409ef]
+- Updated dependencies [11d4485]
+- Updated dependencies [2d4001d]
+  - @mastra/core@0.9.1-alpha.1

package/LICENSE.md

@@ -0,0 +1,46 @@
+# Elastic License 2.0 (ELv2)
+
+Copyright (c) 2025 Mastra AI, Inc.
+
+**Acceptance**
+By using the software, you agree to all of the terms and conditions below.
+
+**Copyright License**
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below
+
+**Limitations**
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+**Patents**
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+**Notices**
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+**No Other Rights**
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+**Termination**
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+**No Liability**
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+**Definitions**
+The _licensor_ is the entity offering these terms, and the _software_ is the software the licensor makes available under these terms, including any portion of it.
+
+_you_ refers to the individual or entity agreeing to these terms.
+
+_your company_ is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. _control_ means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+_your licenses_ are all the licenses granted to you for the software under these terms.
+
+_use_ means anything you do with the software requiring one of your licenses.
+
+_trademark_ means trademarks, service marks, and similar rights.

package/README.md

@@ -0,0 +1,140 @@
+# @mastra/mongodb
+
+MongoDB Atlas Search implementation for Mastra, providing vector similarity search and index management using MongoDB Atlas Local or Atlas Cloud.
+
+## Installation
+
+```bash
+npm install @mastra/mongodb
+```
+
+## Prerequisites
+
+- MongoDB Atlas Local (via Docker) or MongoDB Atlas Cloud instance with Atlas Search enabled
+- MongoDB 7.0+ recommended
+
+## Usage
+
+### Vector Store
+
+```typescript
+import { MongoDBVector } from '@mastra/mongodb';
+
+const vectorDB = new MongoDBVector({
+  uri: 'mongodb://mongodb:mongodb@localhost:27018/?authSource=admin&directConnection=true',
+  dbName: 'vector_db',
+});
+
+// Connect to MongoDB
+await vectorDB.connect();
+
+// Create a new vector index (collection)
+await vectorDB.createIndex({
+  indexName: 'my_vectors',
+  dimension: 1536,
+  metric: 'cosine', // or 'euclidean', 'dotproduct'
+});
+
+// Upsert vectors
+const ids = await vectorDB.upsert({
+  indexName: 'my_vectors',
+  vectors: [[0.1, 0.2, ...], [0.3, 0.4, ...]],
+  metadata: [{ text: 'doc1' }, { text: 'doc2' }],
+});
+
+// Query vectors
+const results = await vectorDB.query({
+  indexName: 'my_vectors',
+  queryVector: [0.1, 0.2, ...],
+  topK: 10,
+  filter: { text: 'doc1' },
+  includeVector: false,
+  minScore: 0.5,
+});
+
+// Clean up
+await vectorDB.disconnect();
+```
+
+## Configuration
+
+The MongoDB vector store is initialized with:
+
+- `uri`: MongoDB connection string (with credentials and options)
+- `dbName`: Name of the database to use
+
+Example:
+
+```typescript
+const vectorDB = new MongoDBVector({
+  uri: 'mongodb://mongodb:mongodb@localhost:27018/?authSource=admin&directConnection=true',
+  dbName: 'vector_db',
+});
+```
+
+## Features
+
+### Vector Store Features
+
+- Vector similarity search with cosine, euclidean, and dotproduct metrics (Atlas Search)
+- Metadata filtering with MongoDB-style query syntax
+- Minimum score threshold for queries
+- Automatic UUID generation for vectors
+- Collection (index) management: create, list, describe, delete
+- Atlas Search readiness checks for reliable testing
+
+## Supported Filter Operators
+
+- Comparison: `$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`
+- Logical: `$and`, `$or`
+- Array: `$in`, `$nin`
+- Text: `$regex`, `$like`
+
+Example filter:
+
+```typescript
+{
+  $and: [{ age: { $gt: 25 } }, { tags: { $in: ['tag1', 'tag2'] } }];
+}
+```
+
+## Distance Metrics
+
+The following distance metrics are supported:
+
+- `cosine` → Cosine similarity (default)
+- `euclidean` → Euclidean distance
+- `dotproduct` → Dot product
+
+## Vector Store Methods
+
+- `createIndex({indexName, dimension, metric})`: Create a new collection with vector search support
+- `upsert({indexName, vectors, metadata?, ids?})`: Add or update vectors
+- `query({indexName, queryVector, topK?, filter?, includeVector?, minScore?, documentFilter?})`: Search for similar vectors (optionally filter by document content)
+
+> **Note:** `documentFilter` allows filtering results based on the content of the `document` field. Example: `{ $contains: 'specific text' }` will return only vectors whose associated document contains the specified text.
+
+- `listIndexes()`: List all vector-enabled collections
+- `describeIndex(indexName)`: Get collection statistics (dimension, count, metric)
+- `updateIndexById(indexName, id, { vector?, metadata? })`: Update a vector and/or its metadata by ID
+- `deleteIndexById(indexName, id)`: Delete a vector by ID
+- `deleteIndex(indexName)`: Delete a collection
+- `disconnect()`: Close the MongoDB connection
+
+## Query Response Format
+
+Each query result includes:
+
+- `id`: Vector ID
+- `score`: Similarity score (higher is more similar)
+- `metadata`: Associated metadata
+- `vector`: Original vector (if `includeVector` is true)
+
+## Testing
+
+Integration tests use MongoDB Atlas Local via Docker. See `docker-compose.yml` for setup. The test suite includes readiness checks for Atlas Search before running vector operations.
+
+## Related Links
+
+- [MongoDB Atlas Search Documentation](https://www.mongodb.com/docs/atlas/atlas-search/)
+- [MongoDB Node.js Driver](https://mongodb.github.io/node-mongodb-native/)

package/dist/_tsup-dts-rollup.d.cts

@@ -0,0 +1,88 @@
+import { BaseFilterTranslator } from '@mastra/core/vector/filter';
+import type { CreateIndexParams } from '@mastra/core/vector';
+import type { IndexStats } from '@mastra/core/vector';
+import { MastraVector } from '@mastra/core/vector';
+import type { MongoClientOptions } from 'mongodb';
+import type { OperatorSupport } from '@mastra/core/vector/filter';
+import type { ParamsToArgs } from '@mastra/core/vector';
+import type { QueryResult } from '@mastra/core/vector';
+import type { QueryVectorArgs } from '@mastra/core/vector';
+import type { QueryVectorParams } from '@mastra/core/vector';
+import type { UpsertVectorArgs } from '@mastra/core/vector';
+import type { UpsertVectorParams } from '@mastra/core/vector';
+import type { VectorFilter } from '@mastra/core/vector/filter';
+
+/**
+ * Translator for MongoDB filter queries.
+ * Maintains MongoDB-compatible syntax while ensuring proper validation
+ * and normalization of values.
+ */
+export declare class MongoDBFilterTranslator extends BaseFilterTranslator {
+    protected getSupportedOperators(): OperatorSupport;
+    translate(filter?: VectorFilter): any;
+    private translateNode;
+    private translateOperatorValue;
+    isEmpty(filter: any): boolean;
+}
+
+declare type MongoDBQueryArgs = [...QueryVectorArgs, string?];
+export { MongoDBQueryArgs }
+export { MongoDBQueryArgs as MongoDBQueryArgs_alias_1 }
+
+declare interface MongoDBQueryVectorParams extends QueryVectorParams {
+    documentFilter?: VectorFilter;
+}
+export { MongoDBQueryVectorParams }
+export { MongoDBQueryVectorParams as MongoDBQueryVectorParams_alias_1 }
+
+declare type MongoDBUpsertArgs = [...UpsertVectorArgs, string[]?];
+export { MongoDBUpsertArgs }
+export { MongoDBUpsertArgs as MongoDBUpsertArgs_alias_1 }
+
+declare type MongoDBUpsertParams = ParamsToArgs<MongoDBUpsertArgs>;
+export { MongoDBUpsertParams }
+export { MongoDBUpsertParams as MongoDBUpsertParams_alias_1 }
+
+declare interface MongoDBUpsertVectorParams extends UpsertVectorParams {
+    documents?: string[];
+}
+export { MongoDBUpsertVectorParams }
+export { MongoDBUpsertVectorParams as MongoDBUpsertVectorParams_alias_1 }
+
+declare class MongoDBVector extends MastraVector {
+    private client;
+    private db;
+    private collections;
+    private readonly embeddingFieldName;
+    private readonly metadataFieldName;
+    private readonly documentFieldName;
+    private collectionForValidation;
+    private mongoMetricMap;
+    constructor({ uri, dbName, options }: {
+        uri: string;
+        dbName: string;
+        options?: MongoClientOptions;
+    });
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    createIndex(params: CreateIndexParams): Promise<void>;
+    waitForIndexReady(indexName: string, timeoutMs?: number, checkIntervalMs?: number): Promise<void>;
+    upsert(params: MongoDBUpsertVectorParams): Promise<string[]>;
+    query(params: MongoDBQueryVectorParams): Promise<QueryResult[]>;
+    listIndexes(): Promise<string[]>;
+    describeIndex(indexName: string): Promise<IndexStats>;
+    deleteIndex(indexName: string): Promise<void>;
+    updateIndexById(indexName: string, id: string, update: {
+        vector?: number[];
+        metadata?: Record<string, any>;
+    }): Promise<void>;
+    deleteIndexById(indexName: string, id: string): Promise<void>;
+    private getCollection;
+    private validateVectorDimensions;
+    private setIndexDimension;
+    private transformFilter;
+}
+export { MongoDBVector }
+export { MongoDBVector as MongoDBVector_alias_1 }
+
+export { }

package/dist/_tsup-dts-rollup.d.ts

@@ -0,0 +1,88 @@
+import { BaseFilterTranslator } from '@mastra/core/vector/filter';
+import type { CreateIndexParams } from '@mastra/core/vector';
+import type { IndexStats } from '@mastra/core/vector';
+import { MastraVector } from '@mastra/core/vector';
+import type { MongoClientOptions } from 'mongodb';
+import type { OperatorSupport } from '@mastra/core/vector/filter';
+import type { ParamsToArgs } from '@mastra/core/vector';
+import type { QueryResult } from '@mastra/core/vector';
+import type { QueryVectorArgs } from '@mastra/core/vector';
+import type { QueryVectorParams } from '@mastra/core/vector';
+import type { UpsertVectorArgs } from '@mastra/core/vector';
+import type { UpsertVectorParams } from '@mastra/core/vector';
+import type { VectorFilter } from '@mastra/core/vector/filter';
+
+/**
+ * Translator for MongoDB filter queries.
+ * Maintains MongoDB-compatible syntax while ensuring proper validation
+ * and normalization of values.
+ */
+export declare class MongoDBFilterTranslator extends BaseFilterTranslator {
+    protected getSupportedOperators(): OperatorSupport;
+    translate(filter?: VectorFilter): any;
+    private translateNode;
+    private translateOperatorValue;
+    isEmpty(filter: any): boolean;
+}
+
+declare type MongoDBQueryArgs = [...QueryVectorArgs, string?];
+export { MongoDBQueryArgs }
+export { MongoDBQueryArgs as MongoDBQueryArgs_alias_1 }
+
+declare interface MongoDBQueryVectorParams extends QueryVectorParams {
+    documentFilter?: VectorFilter;
+}
+export { MongoDBQueryVectorParams }
+export { MongoDBQueryVectorParams as MongoDBQueryVectorParams_alias_1 }
+
+declare type MongoDBUpsertArgs = [...UpsertVectorArgs, string[]?];
+export { MongoDBUpsertArgs }
+export { MongoDBUpsertArgs as MongoDBUpsertArgs_alias_1 }
+
+declare type MongoDBUpsertParams = ParamsToArgs<MongoDBUpsertArgs>;
+export { MongoDBUpsertParams }
+export { MongoDBUpsertParams as MongoDBUpsertParams_alias_1 }
+
+declare interface MongoDBUpsertVectorParams extends UpsertVectorParams {
+    documents?: string[];
+}
+export { MongoDBUpsertVectorParams }
+export { MongoDBUpsertVectorParams as MongoDBUpsertVectorParams_alias_1 }
+
+declare class MongoDBVector extends MastraVector {
+    private client;
+    private db;
+    private collections;
+    private readonly embeddingFieldName;
+    private readonly metadataFieldName;
+    private readonly documentFieldName;
+    private collectionForValidation;
+    private mongoMetricMap;
+    constructor({ uri, dbName, options }: {
+        uri: string;
+        dbName: string;
+        options?: MongoClientOptions;
+    });
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    createIndex(params: CreateIndexParams): Promise<void>;
+    waitForIndexReady(indexName: string, timeoutMs?: number, checkIntervalMs?: number): Promise<void>;
+    upsert(params: MongoDBUpsertVectorParams): Promise<string[]>;
+    query(params: MongoDBQueryVectorParams): Promise<QueryResult[]>;
+    listIndexes(): Promise<string[]>;
+    describeIndex(indexName: string): Promise<IndexStats>;
+    deleteIndex(indexName: string): Promise<void>;
+    updateIndexById(indexName: string, id: string, update: {
+        vector?: number[];
+        metadata?: Record<string, any>;
+    }): Promise<void>;
+    deleteIndexById(indexName: string, id: string): Promise<void>;
+    private getCollection;
+    private validateVectorDimensions;
+    private setIndexDimension;
+    private transformFilter;
+}
+export { MongoDBVector }
+export { MongoDBVector as MongoDBVector_alias_1 }
+
+export { }