@mastra/couchbase 0.0.0-vnext-inngest-20250508131921 → 0.0.0-workflow-deno-20250616115451

package/dist/index.js

@@ -1,5 +1,5 @@
 import { MastraVector } from '@mastra/core/vector';
-import { connect, SearchRequest, VectorSearch, VectorQuery } from 'couchbase';
+import { connect, SearchRequest, VectorSearch, VectorQuery, MutateInSpec } from 'couchbase';
 
 // src/vector/index.ts
 var DISTANCE_MAPPING = {
@@ -17,9 +17,9 @@ var CouchbaseVector = class extends MastraVector {
   bucket;
   scope;
   vector_dimension;
-  constructor(cnn_string, username, password, bucketName, scopeName, collectionName) {
+  constructor({ connectionString, username, password, bucketName, scopeName, collectionName }) {
     super();
-    const baseClusterPromise = connect(cnn_string, {
+    const baseClusterPromise = connect(connectionString, {
       username,
       password,
       configProfile: "wanDevelopment"
@@ -51,8 +51,7 @@ var CouchbaseVector = class extends MastraVector {
     }
     return this.collection;
   }
-  async createIndex(params) {
-    const { indexName, dimension, metric = "dotproduct" } = params;
+  async createIndex({ indexName, dimension, metric = "dotproduct" }) {
     await this.getCollection();
     if (!Number.isInteger(dimension) || dimension <= 0) {
       throw new Error("Dimension must be a positive integer");
@@ -147,8 +146,7 @@ var CouchbaseVector = class extends MastraVector {
       throw error;
     }
   }
-  async upsert(params) {
-    const { vectors, metadata, ids } = params;
+  async upsert({ vectors, metadata, ids }) {
     await this.getCollection();
     if (!vectors || vectors.length === 0) {
       throw new Error("No vectors provided");
@@ -179,10 +177,9 @@ var CouchbaseVector = class extends MastraVector {
     await Promise.all(allPromises);
     return pointIds;
   }
-  async query(params) {
-    const { indexName, queryVector, topK = 10, includeVector = false } = params;
+  async query({ indexName, queryVector, topK = 10, includeVector = false }) {
     await this.getCollection();
-    const index_stats = await this.describeIndex(indexName);
+    const index_stats = await this.describeIndex({ indexName });
     if (queryVector.length !== index_stats.dimension) {
       throw new Error(`Query vector dimension mismatch. Expected ${index_stats.dimension}, got ${queryVector.length}`);
     }
@@ -219,7 +216,13 @@ var CouchbaseVector = class extends MastraVector {
     const indexes = await this.scope.searchIndexes().getAllIndexes();
     return indexes?.map((index) => index.name) || [];
   }
-  async describeIndex(indexName) {
+  /**
+   * Retrieves statistics about a vector index.
+   *
+   * @param {string} indexName - The name of the index to describe
+   * @returns A promise that resolves to the index statistics including dimension, count and metric
+   */
+  async describeIndex({ indexName }) {
     await this.getCollection();
     if (!(await this.listIndexes()).includes(indexName)) {
       throw new Error(`Index ${indexName} does not exist`);
@@ -236,7 +239,7 @@ var CouchbaseVector = class extends MastraVector {
       )
     };
   }
-  async deleteIndex(indexName) {
+  async deleteIndex({ indexName }) {
     await this.getCollection();
     if (!(await this.listIndexes()).includes(indexName)) {
       throw new Error(`Index ${indexName} does not exist`);
@@ -244,6 +247,62 @@ var CouchbaseVector = class extends MastraVector {
     await this.scope.searchIndexes().dropIndex(indexName);
     this.vector_dimension = null;
   }
+  /**
+   * Updates a vector by its ID with the provided vector and/or metadata.
+   * @param indexName - The name of the index containing the vector.
+   * @param id - The ID of the vector to update.
+   * @param update - An object containing the vector and/or metadata to update.
+   * @param update.vector - An optional array of numbers representing the new vector.
+   * @param update.metadata - An optional record containing the new metadata.
+   * @returns A promise that resolves when the update is complete.
+   * @throws Will throw an error if no updates are provided or if the update operation fails.
+   */
+  async updateVector({ id, update }) {
+    if (!update.vector && !update.metadata) {
+      throw new Error("No updates provided");
+    }
+    if (update.vector && this.vector_dimension && update.vector.length !== this.vector_dimension) {
+      throw new Error("Vector dimension mismatch");
+    }
+    const collection = await this.getCollection();
+    try {
+      await collection.get(id);
+    } catch (err) {
+      if (err.code === 13 || err.message?.includes("document not found")) {
+        throw new Error(`Vector with id ${id} does not exist`);
+      }
+      throw err;
+    }
+    const specs = [];
+    if (update.vector) specs.push(MutateInSpec.replace("embedding", update.vector));
+    if (update.metadata) specs.push(MutateInSpec.replace("metadata", update.metadata));
+    await collection.mutateIn(id, specs);
+  }
+  /**
+   * Deletes a vector by its ID.
+   * @param indexName - The name of the index containing the vector.
+   * @param id - The ID of the vector to delete.
+   * @returns A promise that resolves when the deletion is complete.
+   * @throws Will throw an error if the deletion operation fails.
+   */
+  async deleteVector({ id }) {
+    const collection = await this.getCollection();
+    try {
+      await collection.get(id);
+    } catch (err) {
+      if (err.code === 13 || err.message?.includes("document not found")) {
+        throw new Error(`Vector with id ${id} does not exist`);
+      }
+      throw err;
+    }
+    await collection.remove(id);
+  }
+  async disconnect() {
+    if (!this.cluster) {
+      return;
+    }
+    await this.cluster.close();
+  }
 };
 
 export { CouchbaseVector, DISTANCE_MAPPING };

package/docker-compose.yaml

@@ -2,20 +2,20 @@ services:
   mastra_couchbase_testing:
     image: couchbase:enterprise-7.6.4
     ports:
-      - "8091-8095:8091-8095"
-      - "11210:11210"
-      - "9102:9102"
+      - '8091-8095:8091-8095'
+      - '11210:11210'
+      - '9102:9102'
     expose:
-      - "8091"
-      - "8092"
-      - "8093"
-      - "8094"
-      - "8095"
-      - "9102"
-      - "11210"
+      - '8091'
+      - '8092'
+      - '8093'
+      - '8094'
+      - '8095'
+      - '9102'
+      - '11210'
     healthcheck: # checks couchbase server is up
-      test: ["CMD", "curl", "-v", "http://localhost:8091/pools"]
+      test: ['CMD', 'curl', '-v', 'http://localhost:8091/pools']
       interval: 20s
       timeout: 20s
       retries: 5
-    container_name: mastra_couchbase_testing
+    container_name: mastra_couchbase_testing

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/couchbase",
-  "version": "0.0.0-vnext-inngest-20250508131921",
+  "version": "0.0.0-workflow-deno-20250616115451",
   "description": "Couchbase vector store provider for Mastra",
   "type": "module",
   "main": "dist/index.js",
@@ -19,20 +19,23 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "couchbase": "^4.4.5",
-    "@mastra/core": "0.0.0-vnext-inngest-20250508131921"
+    "couchbase": "^4.5.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.52.1",
-    "@types/node": "^20.17.27",
-    "@vitest/coverage-v8": "3.0.9",
-    "@vitest/ui": "3.0.9",
-    "axios": "^1.8.4",
-    "eslint": "^9.23.0",
-    "tsup": "^8.4.0",
-    "typescript": "^5.8.2",
-    "vitest": "^3.0.9",
-    "@internal/lint": "0.0.0-vnext-inngest-20250508131921"
+    "@microsoft/api-extractor": "^7.52.8",
+    "@types/node": "^20.19.0",
+    "@vitest/coverage-v8": "3.2.2",
+    "@vitest/ui": "3.2.2",
+    "axios": "^1.9.0",
+    "eslint": "^9.28.0",
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.3",
+    "@internal/lint": "0.0.0-workflow-deno-20250616115451",
+    "@mastra/core": "0.0.0-workflow-deno-20250616115451"
+  },
+  "peerDependencies": {
+    "@mastra/core": ">=0.10.4-0 <0.11.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --experimental-dts --clean --treeshake=smallest --splitting",

package/src/vector/index.integration.test.ts

@@ -173,14 +173,14 @@ describe('Integration Testing CouchbaseVector', async () => {
 
   describe('Connection', () => {
     it('should connect to couchbase', async () => {
-      couchbase_client = new CouchbaseVector(
+      couchbase_client = new CouchbaseVector({
         connectionString,
         username,
         password,
-        test_bucketName,
-        test_scopeName,
-        test_collectionName,
-      );
+        bucketName: test_bucketName,
+        scopeName: test_scopeName,
+        collectionName: test_collectionName,
+      });
       expect(couchbase_client).toBeDefined();
       const collection = await couchbase_client.getCollection();
       expect(collection).toBeDefined();
@@ -211,14 +211,14 @@ describe('Integration Testing CouchbaseVector', async () => {
     }, 50000);
 
     it('should describe index', async () => {
-      const stats = await couchbase_client.describeIndex(test_indexName);
+      const stats = await couchbase_client.describeIndex({ indexName: test_indexName });
       expect(stats.dimension).toBe(dimension);
       expect(stats.metric).toBe('euclidean'); // similiarity(=="l2_norm") is mapped to euclidean in couchbase
       expect(typeof stats.count).toBe('number');
     }, 50000);
 
     it('should delete index', async () => {
-      await couchbase_client.deleteIndex(test_indexName);
+      await couchbase_client.deleteIndex({ indexName: test_indexName });
       await new Promise(resolve => setTimeout(resolve, 5000));
       await expect(scope.searchIndexes().getIndex(test_indexName)).rejects.toThrowError();
     }, 50000);
@@ -246,7 +246,7 @@ describe('Integration Testing CouchbaseVector', async () => {
     }, 50000);
 
     afterAll(async () => {
-      await couchbase_client.deleteIndex(test_indexName);
+      await couchbase_client.deleteIndex({ indexName: test_indexName });
       await new Promise(resolve => setTimeout(resolve, 5000));
     }, 50000);
 
@@ -380,6 +380,120 @@ describe('Integration Testing CouchbaseVector', async () => {
         }),
       ).rejects.toThrow('Including vectors in search results is not yet supported by the Couchbase vector store');
     }, 50000);
+
+    it('should upsert vectors with generated ids', async () => {
+      const ids = await couchbase_client.upsert({ indexName: test_indexName, vectors: testVectors });
+      expect(ids).toHaveLength(testVectors.length);
+      ids.forEach(id => expect(typeof id).toBe('string'));
+
+      // Count is not supported by Couchbase
+      const stats = await couchbase_client.describeIndex({ indexName: test_indexName });
+      expect(stats.count).toBe(-1);
+    });
+
+    it('should update existing vectors', async () => {
+      // Initial upsert
+      await couchbase_client.upsert({
+        indexName: test_indexName,
+        vectors: testVectors,
+        metadata: testMetadata,
+        ids: testVectorIds,
+      });
+
+      // Update first vector
+      const updatedVector = [[0.5, 0.5, 0.0]];
+      const updatedMetadata = [{ label: 'updated-x-axis' }];
+      await couchbase_client.upsert({
+        indexName: test_indexName,
+        vectors: updatedVector,
+        metadata: updatedMetadata,
+        ids: [testVectorIds?.[0]!],
+      });
+
+      // Verify update
+      const result = await collection.get(testVectorIds?.[0]!);
+      expect(result.content.embedding).toEqual(updatedVector[0]);
+      expect(result.content.metadata).toEqual(updatedMetadata[0]);
+    });
+
+    it('should update the vector by id', async () => {
+      const ids = await couchbase_client.upsert({ indexName: test_indexName, vectors: testVectors });
+      expect(ids).toHaveLength(3);
+
+      const idToBeUpdated = ids[0];
+      const newVector = [1, 2, 3];
+      const newMetaData = {
+        test: 'updates',
+      };
+
+      const update = {
+        vector: newVector,
+        metadata: newMetaData,
+      };
+
+      await couchbase_client.updateVector({ indexName: test_indexName, id: idToBeUpdated, update });
+
+      const result = await collection.get(idToBeUpdated);
+      expect(result.content.embedding).toEqual(newVector);
+      expect(result.content.metadata).toEqual(newMetaData);
+    });
+
+    it('should only update the metadata by id', async () => {
+      const ids = await couchbase_client.upsert({ indexName: test_indexName, vectors: testVectors });
+      expect(ids).toHaveLength(3);
+
+      const idToBeUpdated = ids[0];
+      const newMetaData = {
+        test: 'updates',
+      };
+
+      const update = {
+        metadata: newMetaData,
+      };
+
+      await couchbase_client.updateVector({ indexName: test_indexName, id: idToBeUpdated, update });
+
+      const result = await collection.get(idToBeUpdated);
+      expect(result.content.embedding).toEqual(testVectors[0]);
+      expect(result.content.metadata).toEqual(newMetaData);
+    });
+
+    it('should only update vector embeddings by id', async () => {
+      const ids = await couchbase_client.upsert({ indexName: test_indexName, vectors: testVectors });
+      expect(ids).toHaveLength(3);
+
+      const idToBeUpdated = ids[0];
+      const newVector = [1, 2, 3];
+
+      const update = {
+        vector: newVector,
+      };
+
+      await couchbase_client.updateVector({ indexName: test_indexName, id: idToBeUpdated, update });
+
+      const result = await collection.get(idToBeUpdated);
+      expect(result.content.embedding).toEqual(newVector);
+    });
+
+    it('should throw exception when no updates are given', async () => {
+      await expect(couchbase_client.updateVector({ indexName: test_indexName, id: 'id', update: {} })).rejects.toThrow(
+        'No updates provided',
+      );
+    });
+
+    it('should delete the vector by id', async () => {
+      const ids = await couchbase_client.upsert({ indexName: test_indexName, vectors: testVectors });
+      expect(ids).toHaveLength(3);
+      const idToBeDeleted = ids[0];
+
+      await couchbase_client.deleteVector({ indexName: test_indexName, id: idToBeDeleted });
+
+      try {
+        await collection.get(idToBeDeleted);
+      } catch (error) {
+        expect(error).toBeInstanceOf(Error);
+      }
+    });
   });
 
   describe('Error Cases and Edge Cases', () => {
@@ -409,7 +523,7 @@ describe('Integration Testing CouchbaseVector', async () => {
       expect(allIndexes.find(idx => idx.name === nonExistentIndex)).toBeUndefined();
 
       // Now test the couchbase_client method
-      await expect(couchbase_client.describeIndex(nonExistentIndex)).rejects.toThrow();
+      await expect(couchbase_client.describeIndex({ indexName: nonExistentIndex })).rejects.toThrow();
     }, 50000);
 
     it('should throw error when deleting a non-existent index', async () => {
@@ -420,7 +534,7 @@ describe('Integration Testing CouchbaseVector', async () => {
       expect(allIndexes.find(idx => idx.name === nonExistentIndex)).toBeUndefined();
 
       // Now test the couchbase_client method
-      await expect(couchbase_client.deleteIndex(nonExistentIndex)).rejects.toThrow();
+      await expect(couchbase_client.deleteIndex({ indexName: nonExistentIndex })).rejects.toThrow();
     }, 50000);
 
     it('should throw error for empty vectors array in upsert', async () => {
@@ -489,7 +603,7 @@ describe('Integration Testing CouchbaseVector', async () => {
         infoSpy.mockRestore();
         warnSpy.mockRestore();
         // Cleanup
-        await couchbase_client.deleteIndex(duplicateIndexName);
+        await couchbase_client.deleteIndex({ indexName: duplicateIndexName });
       }
     }, 50000);
   });
@@ -499,7 +613,7 @@ describe('Integration Testing CouchbaseVector', async () => {
       const indexes = await couchbase_client.listIndexes();
       if (indexes.length > 0) {
         for (const index of indexes) {
-          await couchbase_client.deleteIndex(index);
+          await couchbase_client.deleteIndex({ indexName: index });
           await new Promise(resolve => setTimeout(resolve, 5000));
         }
       }
@@ -562,7 +676,7 @@ describe('Integration Testing CouchbaseVector', async () => {
       expect((couchbase_client as any).vector_dimension).toBe(testDimension);
 
       // Delete the index
-      await couchbase_client.deleteIndex(testIndexName);
+      await couchbase_client.deleteIndex({ indexName: testIndexName });
       await new Promise(resolve => setTimeout(resolve, 5000));
 
       // Verify dimension is reset
@@ -578,7 +692,7 @@ describe('Integration Testing CouchbaseVector', async () => {
       const indexes = await couchbase_client.listIndexes();
       if (indexes.length > 0) {
         for (const index of indexes) {
-          await couchbase_client.deleteIndex(index);
+          await couchbase_client.deleteIndex({ indexName: index });
           await new Promise(resolve => setTimeout(resolve, 5000));
         }
       }
@@ -607,11 +721,11 @@ describe('Integration Testing CouchbaseVector', async () => {
         expect(similarityParam).toBe(couchbaseMetric);
 
         // Verify through our API
-        const stats = await couchbase_client.describeIndex(testIndexName);
+        const stats = await couchbase_client.describeIndex({ indexName: testIndexName });
         expect(stats.metric).toBe(mastraMetric);
 
         // Clean up
-        await couchbase_client.deleteIndex(testIndexName);
+        await couchbase_client.deleteIndex({ indexName: testIndexName });
         await new Promise(resolve => setTimeout(resolve, 5000));
       }
     }, 50000);

package/src/vector/index.ts

@@ -5,9 +5,13 @@ import type {
   CreateIndexParams,
   UpsertVectorParams,
   QueryVectorParams,
+  DescribeIndexParams,
+  DeleteIndexParams,
+  DeleteVectorParams,
+  UpdateVectorParams,
 } from '@mastra/core/vector';
 import type { Bucket, Cluster, Collection, Scope } from 'couchbase';
-import { connect, SearchRequest, VectorQuery, VectorSearch } from 'couchbase';
+import { MutateInSpec, connect, SearchRequest, VectorQuery, VectorSearch } from 'couchbase';
 
 type MastraMetric = 'cosine' | 'euclidean' | 'dotproduct';
 type CouchbaseMetric = 'cosine' | 'l2_norm' | 'dot_product';
@@ -17,6 +21,15 @@ export const DISTANCE_MAPPING: Record<MastraMetric, CouchbaseMetric> = {
   dotproduct: 'dot_product',
 };
 
+export type CouchbaseVectorParams = {
+  connectionString: string;
+  username: string;
+  password: string;
+  bucketName: string;
+  scopeName: string;
+  collectionName: string;
+};
+
 export class CouchbaseVector extends MastraVector {
   private clusterPromise: Promise<Cluster>;
   private cluster: Cluster;
@@ -28,17 +41,10 @@ export class CouchbaseVector extends MastraVector {
   private scope: Scope;
   private vector_dimension: number;
 
-  constructor(
-    cnn_string: string,
-    username: string,
-    password: string,
-    bucketName: string,
-    scopeName: string,
-    collectionName: string,
-  ) {
+  constructor({ connectionString, username, password, bucketName, scopeName, collectionName }: CouchbaseVectorParams) {
     super();
 
-    const baseClusterPromise = connect(cnn_string, {
+    const baseClusterPromise = connect(connectionString, {
       username,
       password,
       configProfile: 'wanDevelopment',
@@ -76,8 +82,7 @@ export class CouchbaseVector extends MastraVector {
     return this.collection;
   }
 
-  async createIndex(params: CreateIndexParams): Promise<void> {
-    const { indexName, dimension, metric = 'dotproduct' as MastraMetric } = params;
+  async createIndex({ indexName, dimension, metric = 'dotproduct' as MastraMetric }: CreateIndexParams): Promise<void> {
     await this.getCollection();
 
     if (!Number.isInteger(dimension) || dimension <= 0) {
@@ -172,8 +177,7 @@ export class CouchbaseVector extends MastraVector {
     }
   }
 
-  async upsert(params: UpsertVectorParams): Promise<string[]> {
-    const { vectors, metadata, ids } = params;
+  async upsert({ vectors, metadata, ids }: UpsertVectorParams): Promise<string[]> {
     await this.getCollection();
 
     if (!vectors || vectors.length === 0) {
@@ -210,12 +214,10 @@ export class CouchbaseVector extends MastraVector {
     return pointIds;
   }
 
-  async query(params: QueryVectorParams): Promise<QueryResult[]> {
-    const { indexName, queryVector, topK = 10, includeVector = false } = params;
-
+  async query({ indexName, queryVector, topK = 10, includeVector = false }: QueryVectorParams): Promise<QueryResult[]> {
     await this.getCollection();
 
-    const index_stats = await this.describeIndex(indexName);
+    const index_stats = await this.describeIndex({ indexName });
     if (queryVector.length !== index_stats.dimension) {
       throw new Error(`Query vector dimension mismatch. Expected ${index_stats.dimension}, got ${queryVector.length}`);
     }
@@ -255,7 +257,13 @@ export class CouchbaseVector extends MastraVector {
     return indexes?.map(index => index.name) || [];
   }
 
-  async describeIndex(indexName: string): Promise<IndexStats> {
+  /**
+   * Retrieves statistics about a vector index.
+   *
+   * @param {string} indexName - The name of the index to describe
+   * @returns A promise that resolves to the index statistics including dimension, count and metric
+   */
+  async describeIndex({ indexName }: DescribeIndexParams): Promise<IndexStats> {
     await this.getCollection();
     if (!(await this.listIndexes()).includes(indexName)) {
       throw new Error(`Index ${indexName} does not exist`);
@@ -276,7 +284,7 @@ export class CouchbaseVector extends MastraVector {
     };
   }
 
-  async deleteIndex(indexName: string): Promise<void> {
+  async deleteIndex({ indexName }: DeleteIndexParams): Promise<void> {
     await this.getCollection();
     if (!(await this.listIndexes()).includes(indexName)) {
       throw new Error(`Index ${indexName} does not exist`);
@@ -284,4 +292,70 @@ export class CouchbaseVector extends MastraVector {
     await this.scope.searchIndexes().dropIndex(indexName);
     this.vector_dimension = null as unknown as number;
   }
+
+  /**
+   * Updates a vector by its ID with the provided vector and/or metadata.
+   * @param indexName - The name of the index containing the vector.
+   * @param id - The ID of the vector to update.
+   * @param update - An object containing the vector and/or metadata to update.
+   * @param update.vector - An optional array of numbers representing the new vector.
+   * @param update.metadata - An optional record containing the new metadata.
+   * @returns A promise that resolves when the update is complete.
+   * @throws Will throw an error if no updates are provided or if the update operation fails.
+   */
+  async updateVector({ id, update }: UpdateVectorParams): Promise<void> {
+    if (!update.vector && !update.metadata) {
+      throw new Error('No updates provided');
+    }
+    if (update.vector && this.vector_dimension && update.vector.length !== this.vector_dimension) {
+      throw new Error('Vector dimension mismatch');
+    }
+    const collection = await this.getCollection();
+
+    // Check if document exists
+    try {
+      await collection.get(id);
+    } catch (err: any) {
+      if (err.code === 13 || err.message?.includes('document not found')) {
+        throw new Error(`Vector with id ${id} does not exist`);
+      }
+      throw err;
+    }
+
+    const specs: MutateInSpec[] = [];
+    if (update.vector) specs.push(MutateInSpec.replace('embedding', update.vector));
+    if (update.metadata) specs.push(MutateInSpec.replace('metadata', update.metadata));
+
+    await collection.mutateIn(id, specs);
+  }
+
+  /**
+   * Deletes a vector by its ID.
+   * @param indexName - The name of the index containing the vector.
+   * @param id - The ID of the vector to delete.
+   * @returns A promise that resolves when the deletion is complete.
+   * @throws Will throw an error if the deletion operation fails.
+   */
+  async deleteVector({ id }: DeleteVectorParams): Promise<void> {
+    const collection = await this.getCollection();
+
+    // Check if document exists
+    try {
+      await collection.get(id);
+    } catch (err: any) {
+      if (err.code === 13 || err.message?.includes('document not found')) {
+        throw new Error(`Vector with id ${id} does not exist`);
+      }
+      throw err;
+    }
+
+    await collection.remove(id);
+  }
+
+  async disconnect() {
+    if (!this.cluster) {
+      return;
+    }
+    await this.cluster.close();
+  }
 }