@mastra/mongodb 0.0.0-vnext-inngest-20250508122351 → 0.0.0-vnext-20251104230439

package/src/vector/index.ts

@@ -1,380 +0,0 @@
-import { MastraVector } from '@mastra/core/vector';
-import type {
-  QueryResult,
-  IndexStats,
-  CreateIndexParams,
-  UpsertVectorParams,
-  QueryVectorParams,
-  ParamsToArgs,
-  QueryVectorArgs,
-  UpsertVectorArgs,
-} from '@mastra/core/vector';
-import type { VectorFilter } from '@mastra/core/vector/filter';
-import { MongoClient } from 'mongodb';
-import type { MongoClientOptions, Document, Db, Collection } from 'mongodb';
-import { v4 as uuidv4 } from 'uuid';
-
-import { MongoDBFilterTranslator } from './filter';
-
-// Define necessary types and interfaces
-export type MongoDBUpsertArgs = [...UpsertVectorArgs, string[]?];
-export type MongoDBQueryArgs = [...QueryVectorArgs, string?];
-export type MongoDBUpsertParams = ParamsToArgs<MongoDBUpsertArgs>;
-
-export interface MongoDBUpsertVectorParams extends UpsertVectorParams {
-  documents?: string[];
-}
-
-export interface MongoDBQueryVectorParams extends QueryVectorParams {
-  documentFilter?: VectorFilter;
-}
-
-// Define the document interface
-interface MongoDBDocument extends Document {
-  _id: string; // Explicitly declare '_id' as string
-  embedding?: number[];
-  metadata?: Record<string, any>;
-  document?: string;
-  [key: string]: any; // Index signature for additional properties
-}
-// The MongoDBVector class
-export class MongoDBVector extends MastraVector {
-  private client: MongoClient;
-  private db: Db;
-  private collections: Map<string, Collection<MongoDBDocument>>;
-  private readonly embeddingFieldName = 'embedding';
-  private readonly metadataFieldName = 'metadata';
-  private readonly documentFieldName = 'document';
-  private collectionForValidation: Collection<MongoDBDocument> | null = null;
-  private mongoMetricMap: { [key: string]: string } = {
-    cosine: 'cosine',
-    euclidean: 'euclidean',
-    dotproduct: 'dotProduct',
-  };
-
-  constructor({ uri, dbName, options }: { uri: string; dbName: string; options?: MongoClientOptions }) {
-    super();
-    this.client = new MongoClient(uri, options);
-    this.db = this.client.db(dbName);
-    this.collections = new Map();
-  }
-
-  // Public methods
-  async connect(): Promise<void> {
-    await this.client.connect();
-  }
-
-  async disconnect(): Promise<void> {
-    await this.client.close();
-  }
-
-  async createIndex(params: CreateIndexParams): Promise<void> {
-    const { indexName, dimension, metric = 'cosine' } = params;
-
-    if (!Number.isInteger(dimension) || dimension <= 0) {
-      throw new Error('Dimension must be a positive integer');
-    }
-
-    const mongoMetric = this.mongoMetricMap[metric];
-    if (!mongoMetric) {
-      throw new Error(`Invalid metric: "${metric}". Must be one of: cosine, euclidean, dotproduct`);
-    }
-
-    // Check if collection exists
-    const collectionExists = await this.db.listCollections({ name: indexName }).hasNext();
-    if (!collectionExists) {
-      await this.db.createCollection(indexName);
-    }
-    const collection = await this.getCollection(indexName);
-
-    const indexNameInternal = `${indexName}_vector_index`;
-
-    const embeddingField = this.embeddingFieldName;
-    const numDimensions = dimension;
-
-    try {
-      // Create the search index
-      await (collection as any).createSearchIndex({
-        definition: {
-          fields: [
-            {
-              type: 'vector',
-              path: embeddingField,
-              numDimensions: numDimensions,
-              similarity: mongoMetric,
-            },
-          ],
-        },
-        name: indexNameInternal,
-        type: 'vectorSearch',
-      });
-    } catch (error: any) {
-      if (error.codeName !== 'IndexAlreadyExists') {
-        throw error;
-      }
-    }
-
-    // Store the dimension and metric in a special metadata document
-    await collection.updateOne({ _id: '__index_metadata__' }, { $set: { dimension, metric } }, { upsert: true });
-  }
-
-  async waitForIndexReady(indexName: string, timeoutMs: number = 60000, checkIntervalMs: number = 2000): Promise<void> {
-    const collection = await this.getCollection(indexName, true);
-    const indexNameInternal = `${indexName}_vector_index`;
-
-    const startTime = Date.now();
-    while (Date.now() - startTime < timeoutMs) {
-      const indexInfo: any[] = await (collection as any).listSearchIndexes().toArray();
-      const indexData = indexInfo.find((idx: any) => idx.name === indexNameInternal);
-      const status = indexData?.status;
-      if (status === 'READY') {
-        return;
-      }
-      await new Promise(resolve => setTimeout(resolve, checkIntervalMs));
-    }
-    throw new Error(`Index "${indexNameInternal}" did not become ready within timeout`);
-  }
-
-  async upsert(params: MongoDBUpsertVectorParams): Promise<string[]> {
-    const { indexName, vectors, metadata, ids, documents } = params;
-
-    const collection = await this.getCollection(indexName);
-
-    this.collectionForValidation = collection;
-
-    // Get index stats to check dimension
-    const stats = await this.describeIndex(indexName);
-
-    // Validate vector dimensions
-    await this.validateVectorDimensions(vectors, stats.dimension);
-
-    // Generate IDs if not provided
-    const generatedIds = ids || vectors.map(() => uuidv4());
-
-    const operations = vectors.map((vector, idx) => {
-      const id = generatedIds[idx];
-      const meta = metadata?.[idx] || {};
-      const doc = documents?.[idx];
-
-      // Normalize metadata - convert Date objects to ISO strings
-      const normalizedMeta = Object.keys(meta).reduce(
-        (acc, key) => {
-          acc[key] = meta[key] instanceof Date ? meta[key].toISOString() : meta[key];
-          return acc;
-        },
-        {} as Record<string, any>,
-      );
-
-      const updateDoc: Partial<MongoDBDocument> = {
-        [this.embeddingFieldName]: vector,
-        [this.metadataFieldName]: normalizedMeta,
-      };
-      if (doc !== undefined) {
-        updateDoc[this.documentFieldName] = doc;
-      }
-
-      return {
-        updateOne: {
-          filter: { _id: id }, // '_id' is a string as per MongoDBDocument interface
-          update: { $set: updateDoc },
-          upsert: true,
-        },
-      };
-    });
-
-    await collection.bulkWrite(operations);
-
-    return generatedIds;
-  }
-
-  async query(params: MongoDBQueryVectorParams): Promise<QueryResult[]> {
-    const { indexName, queryVector, topK = 10, filter, includeVector = false, documentFilter } = params;
-
-    const collection = await this.getCollection(indexName, true);
-    const indexNameInternal = `${indexName}_vector_index`;
-
-    // Transform the filters using MongoDBFilterTranslator
-    const mongoFilter = this.transformFilter(filter);
-    const documentMongoFilter = documentFilter ? { [this.documentFieldName]: documentFilter } : {};
-
-    // Combine the filters
-    let combinedFilter: any = {};
-    if (Object.keys(mongoFilter).length > 0 && Object.keys(documentMongoFilter).length > 0) {
-      combinedFilter = { $and: [mongoFilter, documentMongoFilter] };
-    } else if (Object.keys(mongoFilter).length > 0) {
-      combinedFilter = mongoFilter;
-    } else if (Object.keys(documentMongoFilter).length > 0) {
-      combinedFilter = documentMongoFilter;
-    }
-
-    // Build the aggregation pipeline
-    const pipeline = [
-      {
-        $vectorSearch: {
-          index: indexNameInternal,
-          queryVector: queryVector,
-          path: this.embeddingFieldName,
-          numCandidates: 100,
-          limit: topK,
-        },
-      },
-      // Apply the filter using $match stage
-      ...(Object.keys(combinedFilter).length > 0 ? [{ $match: combinedFilter }] : []),
-      {
-        $set: { score: { $meta: 'vectorSearchScore' } },
-      },
-      {
-        $project: {
-          _id: 1,
-          score: 1,
-          metadata: `$${this.metadataFieldName}`,
-          document: `$${this.documentFieldName}`,
-          ...(includeVector && { vector: `$${this.embeddingFieldName}` }),
-        },
-      },
-    ];
-
-    try {
-      const results = await collection.aggregate(pipeline).toArray();
-
-      return results.map((result: any) => ({
-        id: result._id,
-        score: result.score,
-        metadata: result.metadata,
-        vector: includeVector ? result.vector : undefined,
-        document: result.document,
-      }));
-    } catch (error) {
-      console.error('Error during vector search:', error);
-      throw error;
-    }
-  }
-
-  async listIndexes(): Promise<string[]> {
-    const collections = await this.db.listCollections().toArray();
-    return collections.map(col => col.name);
-  }
-
-  async describeIndex(indexName: string): Promise<IndexStats> {
-    const collection = await this.getCollection(indexName, true);
-
-    // Get the count of documents, excluding the metadata document
-    const count = await collection.countDocuments({ _id: { $ne: '__index_metadata__' } });
-
-    // Retrieve the dimension and metric from the metadata document
-    const metadataDoc = await collection.findOne({ _id: '__index_metadata__' });
-    const dimension = metadataDoc?.dimension || 0;
-    const metric = metadataDoc?.metric || 'cosine';
-
-    return {
-      dimension,
-      count,
-      metric: metric as 'cosine' | 'euclidean' | 'dotproduct',
-    };
-  }
-
-  async deleteIndex(indexName: string): Promise<void> {
-    const collection = await this.getCollection(indexName, false); // Do not throw error if collection doesn't exist
-    if (collection) {
-      await collection.drop();
-      this.collections.delete(indexName);
-    } else {
-      // Optionally, you can log or handle the case where the collection doesn't exist
-      throw new Error(`Index (Collection) "${indexName}" does not exist`);
-    }
-  }
-
-  async updateIndexById(
-    indexName: string,
-    id: string,
-    update: { vector?: number[]; metadata?: Record<string, any> },
-  ): Promise<void> {
-    if (!update.vector && !update.metadata) {
-      throw new Error('No updates provided');
-    }
-
-    const collection = await this.getCollection(indexName, true);
-    const updateDoc: Record<string, any> = {};
-
-    if (update.vector) {
-      updateDoc[this.embeddingFieldName] = update.vector;
-    }
-
-    if (update.metadata) {
-      // Normalize metadata in updates too
-      const normalizedMeta = Object.keys(update.metadata).reduce(
-        (acc, key) => {
-          acc[key] =
-            update.metadata![key] instanceof Date ? update.metadata![key].toISOString() : update.metadata![key];
-          return acc;
-        },
-        {} as Record<string, any>,
-      );
-
-      updateDoc[this.metadataFieldName] = normalizedMeta;
-    }
-
-    await collection.findOneAndUpdate({ _id: id }, { $set: updateDoc });
-  }
-
-  async deleteIndexById(indexName: string, id: string): Promise<void> {
-    try {
-      const collection = await this.getCollection(indexName, true);
-      await collection.deleteOne({ _id: id });
-    } catch (error: any) {
-      throw new Error(`Failed to delete index by id: ${id} for index name: ${indexName}: ${error.message}`);
-    }
-  }
-
-  // Private methods
-  private async getCollection(
-    indexName: string,
-    throwIfNotExists: boolean = true,
-  ): Promise<Collection<MongoDBDocument>> {
-    if (this.collections.has(indexName)) {
-      return this.collections.get(indexName)!;
-    }
-
-    const collection = this.db.collection<MongoDBDocument>(indexName);
-
-    // Check if collection exists
-    const collectionExists = await this.db.listCollections({ name: indexName }).hasNext();
-    if (!collectionExists && throwIfNotExists) {
-      throw new Error(`Index (Collection) "${indexName}" does not exist`);
-    }
-
-    this.collections.set(indexName, collection);
-    return collection;
-  }
-
-  private async validateVectorDimensions(vectors: number[][], dimension: number): Promise<void> {
-    if (vectors.length === 0) {
-      throw new Error('No vectors provided for validation');
-    }
-
-    if (dimension === 0) {
-      // If dimension is not set, retrieve and set it from the vectors
-      dimension = vectors[0] ? vectors[0].length : 0;
-      await this.setIndexDimension(dimension);
-    }
-
-    for (let i = 0; i < vectors.length; i++) {
-      let v = vectors[i]?.length;
-      if (v !== dimension) {
-        throw new Error(`Vector at index ${i} has invalid dimension ${v}. Expected ${dimension} dimensions.`);
-      }
-    }
-  }
-
-  private async setIndexDimension(dimension: number): Promise<void> {
-    // Store the dimension in a special metadata document
-    const collection = this.collectionForValidation!; // 'collectionForValidation' is set in 'upsert' method
-    await collection.updateOne({ _id: '__index_metadata__' }, { $set: { dimension } }, { upsert: true });
-  }
-
-  private transformFilter(filter?: VectorFilter): any {
-    const translator = new MongoDBFilterTranslator();
-    if (!filter) return {};
-    return translator.translate(filter);
-  }
-}

package/src/vector/prompt.ts

@@ -1,97 +0,0 @@
-/**
- * Vector store specific prompt that details supported operators and examples.
- * This prompt helps users construct valid filters for MongoDB Vector.
- */
-export const MONGODB_PROMPT = `When querying MongoDB Vector, you can ONLY use the operators listed below. Any other operators will be rejected.
-Important: Don't explain how to construct the filter - use the specified operators and fields to search the content and return relevant results.
-If a user tries to give an explicit operator that is not supported, reject the filter entirely and let them know that the operator is not supported.
-
-Basic Comparison Operators:
-- $eq: Exact match (default when using field: value)
-  Example: { "category": "electronics" }
-- $ne: Not equal
-  Example: { "category": { "$ne": "electronics" } }
-- $gt: Greater than
-  Example: { "price": { "$gt": 100 } }
-- $gte: Greater than or equal
-  Example: { "price": { "$gte": 100 } }
-- $lt: Less than
-  Example: { "price": { "$lt": 100 } }
-- $lte: Less than or equal
-  Example: { "price": { "$lte": 100 } }
-
-Array Operators:
-- $in: Match any value in array
-  Example: { "category": { "$in": ["electronics", "books"] } }
-- $nin: Does not match any value in array
-  Example: { "category": { "$nin": ["electronics", "books"] } }
-- $all: Match all values in array
-  Example: { "tags": { "$all": ["premium", "sale"] } }
-- $elemMatch: Match array elements that meet all specified conditions
-  Example: { "items": { "$elemMatch": { "price": { "$gt": 100 } } } }
-- $size: Match arrays with specific length
-  Example: { "tags": { "$size": 3 } }
-
-Logical Operators:
-- $and: Logical AND (can be implicit or explicit)
-  Implicit Example: { "price": { "$gt": 100 }, "category": "electronics" }
-  Explicit Example: { "$and": [{ "price": { "$gt": 100 } }, { "category": "electronics" }] }
-- $or: Logical OR
-  Example: { "$or": [{ "price": { "$lt": 50 } }, { "category": "books" }] }
-- $not: Logical NOT
-  Example: { "$not": { "category": "electronics" } }
-- $nor: Logical NOR
-  Example: { "$nor": [{ "price": { "$lt": 50 } }, { "category": "books" }] }
-
-Element Operators:
-- $exists: Check if field exists
-  Example: { "rating": { "$exists": true } }
-- $type: Check field type
-  Example: { "price": { "$type": "number" } }
-
-Text Search Operators:
-- $text: Full text search
-  Example: { "$text": { "$search": "gaming laptop" } }
-- $regex: Regular expression match
-  Example: { "name": { "$regex": "^Gaming" } }
-
-Restrictions:
-- Only logical operators ($and, $or, $not, $nor) can be used at the top level
-- Empty arrays in array operators will return no results
-- Nested fields are supported using dot notation
-- Multiple conditions on the same field are supported
-- At least one key-value pair is required in filter object
-- Empty objects and undefined values are treated as no filter
-- Invalid types in comparison operators will throw errors
-- All non-logical operators must be used within a field condition
-  Valid: { "field": { "$gt": 100 } }
-  Valid: { "$and": [...] }
-  Invalid: { "$gt": 100 }
-- Logical operators must contain field conditions, not direct operators
-  Valid: { "$and": [{ "field": { "$gt": 100 } }] }
-  Invalid: { "$and": [{ "$gt": 100 }] }
-- Logical operators ($and, $or, $not, $nor):
-  - Can only be used at top level or nested within other logical operators
-  - Can not be used on a field level, or be nested inside a field
-  - Can not be used inside an operator
-  - Valid: { "$and": [{ "field": { "$gt": 100 } }] }
-  - Valid: { "$or": [{ "$and": [{ "field": { "$gt": 100 } }] }] }
-  - Invalid: { "field": { "$and": [{ "$gt": 100 }] } }
-  - Invalid: { "field": { "$or": [{ "$gt": 100 }] } }
-  - Invalid: { "field": { "$gt": { "$and": [{...}] } } }
-
-Example Complex Query:
-{
-  "$and": [
-    { "category": { "$in": ["electronics", "computers"] } },
-    { "price": { "$gte": 100, "$lte": 1000 } },
-    { "tags": { "$all": ["premium", "sale"] } },
-    { "items": { "$elemMatch": { "price": { "$gt": 50 }, "inStock": true } } },
-    { "$text": { "$search": "gaming laptop" } },
-    { "$or": [
-      { "stock": { "$gt": 0 } },
-      { "preorder": true }
-    ]},
-    { "$not": { "status": "discontinued" } }
-  ]
-}`;

package/tsconfig.json

@@ -1,5 +0,0 @@
-{
-  "extends": "../../tsconfig.node.json",
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "**/*.test.ts"]
-}

package/vitest.config.ts

@@ -1,11 +0,0 @@
-import { defineConfig } from 'vitest/config';
-
-export default defineConfig({
-  test: {
-    environment: 'node',
-    include: ['src/**/*.test.ts'],
-    coverage: {
-      reporter: ['text', 'json', 'html'],
-    },
-  },
-});