@mastra/couchbase 0.0.4 → 0.0.5-alpha.0

package/.turbo/turbo-build.log

@@ -1,23 +1,23 @@
 
-> @mastra/couchbase@0.0.4-alpha.4 build /home/runner/work/mastra/mastra/stores/couchbase
+> @mastra/couchbase@0.0.5-alpha.0 build /home/runner/work/mastra/mastra/stores/couchbase
 > 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 6648ms
+TSC ⚡️ Build success in 6132ms
 DTS Build start
 CLI Target: es2022
 Analysis will use the bundled TypeScript version 5.8.3
 Writing package typings: /home/runner/work/mastra/mastra/stores/couchbase/dist/_tsup-dts-rollup.d.ts
 Analysis will use the bundled TypeScript version 5.8.3
 Writing package typings: /home/runner/work/mastra/mastra/stores/couchbase/dist/_tsup-dts-rollup.d.cts
-DTS ⚡️ Build success in 9824ms
+DTS ⚡️ Build success in 8893ms
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-ESM dist/index.js 10.44 KB
-ESM ⚡️ Build success in 685ms
-CJS dist/index.cjs 10.50 KB
-CJS ⚡️ Build success in 686ms
+ESM dist/index.js 12.31 KB
+ESM ⚡️ Build success in 502ms
+CJS dist/index.cjs 12.37 KB
+CJS ⚡️ Build success in 503ms

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @mastra/couchbase
 
+## 0.0.5-alpha.0
+
+### Patch Changes
+
+- d0ee3c6: Change all public functions and constructors in vector stores to use named args and prepare to phase out positional args
+- Updated dependencies [f53a6ac]
+- Updated dependencies [eabdcd9]
+- Updated dependencies [90be034]
+- Updated dependencies [99f050a]
+- Updated dependencies [d0ee3c6]
+- Updated dependencies [23f258c]
+- Updated dependencies [2672a05]
+  - @mastra/core@0.9.5-alpha.0
+
 ## 0.0.4
 
 ### Patch Changes

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

@@ -1,9 +1,14 @@
 import type { Collection } from 'couchbase';
 import type { CreateIndexParams } from '@mastra/core/vector';
+import type { DeleteIndexParams } from '@mastra/core/vector';
+import type { DeleteVectorParams } from '@mastra/core/vector';
+import type { DescribeIndexParams } from '@mastra/core/vector';
 import type { IndexStats } from '@mastra/core/vector';
 import { MastraVector } from '@mastra/core/vector';
+import type { ParamsToArgs } from '@mastra/core/vector';
 import type { QueryResult } from '@mastra/core/vector';
 import type { QueryVectorParams } from '@mastra/core/vector';
+import type { UpdateVectorParams } from '@mastra/core/vector';
 import type { UpsertVectorParams } from '@mastra/core/vector';
 
 declare type CouchbaseMetric = 'cosine' | 'l2_norm' | 'dot_product';
@@ -18,14 +23,26 @@ declare class CouchbaseVector extends MastraVector {
     private bucket;
     private scope;
     private vector_dimension;
-    constructor(cnn_string: string, username: string, password: string, bucketName: string, scopeName: string, collectionName: string);
+    /**
+     * @deprecated Passing parameters as positional arguments is deprecated.
+     * Use the object parameter instead. This signature will be removed on May 20th, 2025.
+     */
+    constructor(connectionString: string, username: string, password: string, bucketName: string, scopeName: string, collectionName: string);
+    constructor(params: CouchbaseVectorParams);
     getCollection(): Promise<Collection>;
     createIndex(params: CreateIndexParams): Promise<void>;
     upsert(params: UpsertVectorParams): Promise<string[]>;
     query(params: QueryVectorParams): Promise<QueryResult[]>;
     listIndexes(): Promise<string[]>;
-    describeIndex(indexName: string): Promise<IndexStats>;
-    deleteIndex(indexName: string): Promise<void>;
+    /**
+     * Retrieves statistics about a vector index.
+     *
+     * @param params - The parameters for describing an index
+     * @param params.indexName - The name of the index to describe
+     * @returns A promise that resolves to the index statistics including dimension, count and metric
+     */
+    describeIndex(...args: ParamsToArgs<DescribeIndexParams>): Promise<IndexStats>;
+    deleteIndex(...args: ParamsToArgs<DeleteIndexParams>): Promise<void>;
     /**
      * Updates a vector by its ID with the provided vector and/or metadata.
      * @param indexName - The name of the index containing the vector.
@@ -36,10 +53,7 @@ declare class CouchbaseVector extends MastraVector {
      * @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.
      */
-    updateVector(_indexName: string, id: string, updates: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): Promise<void>;
+    updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void>;
     /**
      * Deletes a vector by its ID.
      * @param indexName - The name of the index containing the vector.
@@ -47,11 +61,22 @@ declare class CouchbaseVector extends MastraVector {
      * @returns A promise that resolves when the deletion is complete.
      * @throws Will throw an error if the deletion operation fails.
      */
-    deleteVector(_indexName: string, id: string): Promise<void>;
+    deleteVector(...args: ParamsToArgs<DeleteVectorParams>): Promise<void>;
 }
 export { CouchbaseVector }
 export { CouchbaseVector as CouchbaseVector_alias_1 }
 
+declare type CouchbaseVectorParams = {
+    connectionString: string;
+    username: string;
+    password: string;
+    bucketName: string;
+    scopeName: string;
+    collectionName: string;
+};
+export { CouchbaseVectorParams }
+export { CouchbaseVectorParams as CouchbaseVectorParams_alias_1 }
+
 declare const DISTANCE_MAPPING: Record<MastraMetric, CouchbaseMetric>;
 export { DISTANCE_MAPPING }
 export { DISTANCE_MAPPING as DISTANCE_MAPPING_alias_1 }

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

@@ -1,9 +1,14 @@
 import type { Collection } from 'couchbase';
 import type { CreateIndexParams } from '@mastra/core/vector';
+import type { DeleteIndexParams } from '@mastra/core/vector';
+import type { DeleteVectorParams } from '@mastra/core/vector';
+import type { DescribeIndexParams } from '@mastra/core/vector';
 import type { IndexStats } from '@mastra/core/vector';
 import { MastraVector } from '@mastra/core/vector';
+import type { ParamsToArgs } from '@mastra/core/vector';
 import type { QueryResult } from '@mastra/core/vector';
 import type { QueryVectorParams } from '@mastra/core/vector';
+import type { UpdateVectorParams } from '@mastra/core/vector';
 import type { UpsertVectorParams } from '@mastra/core/vector';
 
 declare type CouchbaseMetric = 'cosine' | 'l2_norm' | 'dot_product';
@@ -18,14 +23,26 @@ declare class CouchbaseVector extends MastraVector {
     private bucket;
     private scope;
     private vector_dimension;
-    constructor(cnn_string: string, username: string, password: string, bucketName: string, scopeName: string, collectionName: string);
+    /**
+     * @deprecated Passing parameters as positional arguments is deprecated.
+     * Use the object parameter instead. This signature will be removed on May 20th, 2025.
+     */
+    constructor(connectionString: string, username: string, password: string, bucketName: string, scopeName: string, collectionName: string);
+    constructor(params: CouchbaseVectorParams);
     getCollection(): Promise<Collection>;
     createIndex(params: CreateIndexParams): Promise<void>;
     upsert(params: UpsertVectorParams): Promise<string[]>;
     query(params: QueryVectorParams): Promise<QueryResult[]>;
     listIndexes(): Promise<string[]>;
-    describeIndex(indexName: string): Promise<IndexStats>;
-    deleteIndex(indexName: string): Promise<void>;
+    /**
+     * Retrieves statistics about a vector index.
+     *
+     * @param params - The parameters for describing an index
+     * @param params.indexName - The name of the index to describe
+     * @returns A promise that resolves to the index statistics including dimension, count and metric
+     */
+    describeIndex(...args: ParamsToArgs<DescribeIndexParams>): Promise<IndexStats>;
+    deleteIndex(...args: ParamsToArgs<DeleteIndexParams>): Promise<void>;
     /**
      * Updates a vector by its ID with the provided vector and/or metadata.
      * @param indexName - The name of the index containing the vector.
@@ -36,10 +53,7 @@ declare class CouchbaseVector extends MastraVector {
      * @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.
      */
-    updateVector(_indexName: string, id: string, updates: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): Promise<void>;
+    updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void>;
     /**
      * Deletes a vector by its ID.
      * @param indexName - The name of the index containing the vector.
@@ -47,11 +61,22 @@ declare class CouchbaseVector extends MastraVector {
      * @returns A promise that resolves when the deletion is complete.
      * @throws Will throw an error if the deletion operation fails.
      */
-    deleteVector(_indexName: string, id: string): Promise<void>;
+    deleteVector(...args: ParamsToArgs<DeleteVectorParams>): Promise<void>;
 }
 export { CouchbaseVector }
 export { CouchbaseVector as CouchbaseVector_alias_1 }
 
+declare type CouchbaseVectorParams = {
+    connectionString: string;
+    username: string;
+    password: string;
+    bucketName: string;
+    scopeName: string;
+    collectionName: string;
+};
+export { CouchbaseVectorParams }
+export { CouchbaseVectorParams as CouchbaseVectorParams_alias_1 }
+
 declare const DISTANCE_MAPPING: Record<MastraMetric, CouchbaseMetric>;
 export { DISTANCE_MAPPING }
 export { DISTANCE_MAPPING as DISTANCE_MAPPING_alias_1 }

package/dist/index.cjs

@@ -19,11 +19,32 @@ var CouchbaseVector = class extends vector.MastraVector {
   bucket;
   scope;
   vector_dimension;
-  constructor(cnn_string, username, password, bucketName, scopeName, collectionName) {
+  constructor(paramsOrConnectionString, username, password, bucketName, scopeName, collectionName) {
+    let connectionString_, username_, password_, bucketName_, scopeName_, collectionName_;
+    if (typeof paramsOrConnectionString === "object" && paramsOrConnectionString !== null && "connectionString" in paramsOrConnectionString) {
+      connectionString_ = paramsOrConnectionString.connectionString;
+      username_ = paramsOrConnectionString.username;
+      password_ = paramsOrConnectionString.password;
+      bucketName_ = paramsOrConnectionString.bucketName;
+      scopeName_ = paramsOrConnectionString.scopeName;
+      collectionName_ = paramsOrConnectionString.collectionName;
+    } else {
+      if (arguments.length > 1) {
+        console.warn(
+          "Deprecation Warning: CouchbaseVector constructor positional arguments are deprecated. Please use a single object parameter instead. This signature will be removed on May 20th, 2025."
+        );
+      }
+      connectionString_ = paramsOrConnectionString;
+      username_ = username;
+      password_ = password;
+      bucketName_ = bucketName;
+      scopeName_ = scopeName;
+      collectionName_ = collectionName;
+    }
     super();
-    const baseClusterPromise = couchbase.connect(cnn_string, {
-      username,
-      password,
+    const baseClusterPromise = couchbase.connect(connectionString_, {
+      username: username_,
+      password: password_,
       configProfile: "wanDevelopment"
     });
     const telemetry = this.__getTelemetry();
@@ -34,9 +55,9 @@ var CouchbaseVector = class extends vector.MastraVector {
       }
     }) ?? baseClusterPromise;
     this.cluster = null;
-    this.bucketName = bucketName;
-    this.collectionName = collectionName;
-    this.scopeName = scopeName;
+    this.bucketName = bucketName_;
+    this.collectionName = collectionName_;
+    this.scopeName = scopeName_;
     this.collection = null;
     this.bucket = null;
     this.scope = null;
@@ -221,7 +242,16 @@ var CouchbaseVector = class extends vector.MastraVector {
     const indexes = await this.scope.searchIndexes().getAllIndexes();
     return indexes?.map((index) => index.name) || [];
   }
-  async describeIndex(indexName) {
+  /**
+   * Retrieves statistics about a vector index.
+   *
+   * @param params - The parameters for describing an index
+   * @param params.indexName - The name of the index to describe
+   * @returns A promise that resolves to the index statistics including dimension, count and metric
+   */
+  async describeIndex(...args) {
+    const params = this.normalizeArgs("describeIndex", args);
+    const { indexName } = params;
     await this.getCollection();
     if (!(await this.listIndexes()).includes(indexName)) {
       throw new Error(`Index ${indexName} does not exist`);
@@ -238,7 +268,9 @@ var CouchbaseVector = class extends vector.MastraVector {
       )
     };
   }
-  async deleteIndex(indexName) {
+  async deleteIndex(...args) {
+    const params = this.normalizeArgs("deleteIndex", args);
+    const { indexName } = params;
     await this.getCollection();
     if (!(await this.listIndexes()).includes(indexName)) {
       throw new Error(`Index ${indexName} does not exist`);
@@ -256,10 +288,15 @@ var CouchbaseVector = class extends vector.MastraVector {
    * @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(_indexName, id, updates) {
-    if (!updates.vector && !updates.metadata) {
+  async updateVector(...args) {
+    const params = this.normalizeArgs("updateVector", args);
+    const { id, update } = params;
+    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);
@@ -270,8 +307,8 @@ var CouchbaseVector = class extends vector.MastraVector {
       throw err;
     }
     const specs = [];
-    if (updates.vector) specs.push(couchbase.MutateInSpec.replace("embedding", updates.vector));
-    if (updates.metadata) specs.push(couchbase.MutateInSpec.replace("metadata", updates.metadata));
+    if (update.vector) specs.push(couchbase.MutateInSpec.replace("embedding", update.vector));
+    if (update.metadata) specs.push(couchbase.MutateInSpec.replace("metadata", update.metadata));
     await collection.mutateIn(id, specs);
   }
   /**
@@ -281,7 +318,9 @@ var CouchbaseVector = class extends vector.MastraVector {
    * @returns A promise that resolves when the deletion is complete.
    * @throws Will throw an error if the deletion operation fails.
    */
-  async deleteVector(_indexName, id) {
+  async deleteVector(...args) {
+    const params = this.normalizeArgs("deleteVector", args);
+    const { id } = params;
     const collection = await this.getCollection();
     try {
       await collection.get(id);

package/dist/index.d.cts

@@ -1,2 +1,3 @@
 export { DISTANCE_MAPPING } from './_tsup-dts-rollup.cjs';
+export { CouchbaseVectorParams } from './_tsup-dts-rollup.cjs';
 export { CouchbaseVector } from './_tsup-dts-rollup.cjs';

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export { DISTANCE_MAPPING } from './_tsup-dts-rollup.js';
+export { CouchbaseVectorParams } from './_tsup-dts-rollup.js';
 export { CouchbaseVector } from './_tsup-dts-rollup.js';

package/dist/index.js

@@ -17,11 +17,32 @@ var CouchbaseVector = class extends MastraVector {
   bucket;
   scope;
   vector_dimension;
-  constructor(cnn_string, username, password, bucketName, scopeName, collectionName) {
+  constructor(paramsOrConnectionString, username, password, bucketName, scopeName, collectionName) {
+    let connectionString_, username_, password_, bucketName_, scopeName_, collectionName_;
+    if (typeof paramsOrConnectionString === "object" && paramsOrConnectionString !== null && "connectionString" in paramsOrConnectionString) {
+      connectionString_ = paramsOrConnectionString.connectionString;
+      username_ = paramsOrConnectionString.username;
+      password_ = paramsOrConnectionString.password;
+      bucketName_ = paramsOrConnectionString.bucketName;
+      scopeName_ = paramsOrConnectionString.scopeName;
+      collectionName_ = paramsOrConnectionString.collectionName;
+    } else {
+      if (arguments.length > 1) {
+        console.warn(
+          "Deprecation Warning: CouchbaseVector constructor positional arguments are deprecated. Please use a single object parameter instead. This signature will be removed on May 20th, 2025."
+        );
+      }
+      connectionString_ = paramsOrConnectionString;
+      username_ = username;
+      password_ = password;
+      bucketName_ = bucketName;
+      scopeName_ = scopeName;
+      collectionName_ = collectionName;
+    }
     super();
-    const baseClusterPromise = connect(cnn_string, {
-      username,
-      password,
+    const baseClusterPromise = connect(connectionString_, {
+      username: username_,
+      password: password_,
       configProfile: "wanDevelopment"
     });
     const telemetry = this.__getTelemetry();
@@ -32,9 +53,9 @@ var CouchbaseVector = class extends MastraVector {
       }
     }) ?? baseClusterPromise;
     this.cluster = null;
-    this.bucketName = bucketName;
-    this.collectionName = collectionName;
-    this.scopeName = scopeName;
+    this.bucketName = bucketName_;
+    this.collectionName = collectionName_;
+    this.scopeName = scopeName_;
     this.collection = null;
     this.bucket = null;
     this.scope = null;
@@ -219,7 +240,16 @@ 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 params - The parameters for describing an index
+   * @param params.indexName - The name of the index to describe
+   * @returns A promise that resolves to the index statistics including dimension, count and metric
+   */
+  async describeIndex(...args) {
+    const params = this.normalizeArgs("describeIndex", args);
+    const { indexName } = params;
     await this.getCollection();
     if (!(await this.listIndexes()).includes(indexName)) {
       throw new Error(`Index ${indexName} does not exist`);
@@ -236,7 +266,9 @@ var CouchbaseVector = class extends MastraVector {
       )
     };
   }
-  async deleteIndex(indexName) {
+  async deleteIndex(...args) {
+    const params = this.normalizeArgs("deleteIndex", args);
+    const { indexName } = params;
     await this.getCollection();
     if (!(await this.listIndexes()).includes(indexName)) {
       throw new Error(`Index ${indexName} does not exist`);
@@ -254,10 +286,15 @@ var CouchbaseVector = class extends MastraVector {
    * @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(_indexName, id, updates) {
-    if (!updates.vector && !updates.metadata) {
+  async updateVector(...args) {
+    const params = this.normalizeArgs("updateVector", args);
+    const { id, update } = params;
+    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);
@@ -268,8 +305,8 @@ var CouchbaseVector = class extends MastraVector {
       throw err;
     }
     const specs = [];
-    if (updates.vector) specs.push(MutateInSpec.replace("embedding", updates.vector));
-    if (updates.metadata) specs.push(MutateInSpec.replace("metadata", updates.metadata));
+    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);
   }
   /**
@@ -279,7 +316,9 @@ var CouchbaseVector = class extends MastraVector {
    * @returns A promise that resolves when the deletion is complete.
    * @throws Will throw an error if the deletion operation fails.
    */
-  async deleteVector(_indexName, id) {
+  async deleteVector(...args) {
+    const params = this.normalizeArgs("deleteVector", args);
+    const { id } = params;
     const collection = await this.getCollection();
     try {
       await collection.get(id);

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.4",
+  "version": "0.0.5-alpha.0",
   "description": "Couchbase vector store provider for Mastra",
   "type": "module",
   "main": "dist/index.js",
@@ -20,7 +20,7 @@
   },
   "dependencies": {
     "couchbase": "^4.4.5",
-    "@mastra/core": "^0.9.4"
+    "@mastra/core": "^0.9.5-alpha.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.52.1",

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);
 
@@ -387,7 +387,7 @@ describe('Integration Testing CouchbaseVector', async () => {
       ids.forEach(id => expect(typeof id).toBe('string'));
 
       // Count is not supported by Couchbase
-      const stats = await couchbase_client.describeIndex(test_indexName);
+      const stats = await couchbase_client.describeIndex({ indexName: test_indexName });
       expect(stats.count).toBe(-1);
     });
 
@@ -431,7 +431,7 @@ describe('Integration Testing CouchbaseVector', async () => {
         metadata: newMetaData,
       };
 
-      await couchbase_client.updateVector(test_indexName, idToBeUpdated, update);
+      await couchbase_client.updateVector({ indexName: test_indexName, id: idToBeUpdated, update });
 
       const result = await collection.get(idToBeUpdated);
       expect(result.content.embedding).toEqual(newVector);
@@ -451,7 +451,7 @@ describe('Integration Testing CouchbaseVector', async () => {
         metadata: newMetaData,
       };
 
-      await couchbase_client.updateVector(test_indexName, idToBeUpdated, update);
+      await couchbase_client.updateVector({ indexName: test_indexName, id: idToBeUpdated, update });
 
       const result = await collection.get(idToBeUpdated);
       expect(result.content.embedding).toEqual(testVectors[0]);
@@ -469,14 +469,16 @@ describe('Integration Testing CouchbaseVector', async () => {
         vector: newVector,
       };
 
-      await couchbase_client.updateVector(test_indexName, idToBeUpdated, update);
+      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(test_indexName, 'id', {})).rejects.toThrow('No updates provided');
+      await expect(couchbase_client.updateVector({ indexName: test_indexName, id: 'id', update: {} })).rejects.toThrow(
+        'No updates provided',
+      );
     });
 
     it('should delete the vector by id', async () => {
@@ -484,7 +486,7 @@ describe('Integration Testing CouchbaseVector', async () => {
       expect(ids).toHaveLength(3);
       const idToBeDeleted = ids[0];
 
-      await couchbase_client.deleteVector(test_indexName, idToBeDeleted);
+      await couchbase_client.deleteVector({ indexName: test_indexName, id: idToBeDeleted });
 
       try {
         await collection.get(idToBeDeleted);
@@ -521,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 () => {
@@ -532,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 () => {
@@ -601,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);
   });
@@ -611,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));
         }
       }
@@ -674,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
@@ -690,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));
         }
       }
@@ -719,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,6 +5,11 @@ import type {
   CreateIndexParams,
   UpsertVectorParams,
   QueryVectorParams,
+  DescribeIndexParams,
+  ParamsToArgs,
+  DeleteIndexParams,
+  DeleteVectorParams,
+  UpdateVectorParams,
 } from '@mastra/core/vector';
 import type { Bucket, Cluster, Collection, Scope } from 'couchbase';
 import { MutateInSpec, connect, SearchRequest, VectorQuery, VectorSearch } from 'couchbase';
@@ -17,6 +22,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,19 +42,66 @@ export class CouchbaseVector extends MastraVector {
   private scope: Scope;
   private vector_dimension: number;
 
+  /**
+   * @deprecated Passing parameters as positional arguments is deprecated.
+   * Use the object parameter instead. This signature will be removed on May 20th, 2025.
+   */
   constructor(
-    cnn_string: string,
+    connectionString: string,
     username: string,
     password: string,
     bucketName: string,
     scopeName: string,
     collectionName: string,
+  );
+  constructor(params: CouchbaseVectorParams);
+  constructor(
+    paramsOrConnectionString: CouchbaseVectorParams | string,
+    username?: string,
+    password?: string,
+    bucketName?: string,
+    scopeName?: string,
+    collectionName?: string,
   ) {
+    let connectionString_: string,
+      username_: string,
+      password_: string,
+      bucketName_: string,
+      scopeName_: string,
+      collectionName_: string;
+
+    if (
+      typeof paramsOrConnectionString === 'object' &&
+      paramsOrConnectionString !== null &&
+      'connectionString' in paramsOrConnectionString
+    ) {
+      // Object params (preferred)
+      connectionString_ = paramsOrConnectionString.connectionString as string;
+      username_ = paramsOrConnectionString.username;
+      password_ = paramsOrConnectionString.password;
+      bucketName_ = paramsOrConnectionString.bucketName;
+      scopeName_ = paramsOrConnectionString.scopeName;
+      collectionName_ = paramsOrConnectionString.collectionName;
+    } else {
+      // Positional args (deprecated)
+      if (arguments.length > 1) {
+        console.warn(
+          'Deprecation Warning: CouchbaseVector constructor positional arguments are deprecated. Please use a single object parameter instead. This signature will be removed on May 20th, 2025.',
+        );
+      }
+      connectionString_ = paramsOrConnectionString as string;
+      username_ = username!;
+      password_ = password!;
+      bucketName_ = bucketName!;
+      scopeName_ = scopeName!;
+      collectionName_ = collectionName!;
+    }
+
     super();
 
-    const baseClusterPromise = connect(cnn_string, {
-      username,
-      password,
+    const baseClusterPromise = connect(connectionString_, {
+      username: username_,
+      password: password_,
       configProfile: 'wanDevelopment',
     });
 
@@ -53,9 +114,9 @@ export class CouchbaseVector extends MastraVector {
         },
       }) ?? baseClusterPromise;
     this.cluster = null as unknown as Cluster;
-    this.bucketName = bucketName;
-    this.collectionName = collectionName;
-    this.scopeName = scopeName;
+    this.bucketName = bucketName_;
+    this.collectionName = collectionName_;
+    this.scopeName = scopeName_;
     this.collection = null as unknown as Collection;
     this.bucket = null as unknown as Bucket;
     this.scope = null as unknown as Scope;
@@ -255,7 +316,16 @@ export class CouchbaseVector extends MastraVector {
     return indexes?.map(index => index.name) || [];
   }
 
-  async describeIndex(indexName: string): Promise<IndexStats> {
+  /**
+   * Retrieves statistics about a vector index.
+   *
+   * @param params - The parameters for describing an index
+   * @param params.indexName - The name of the index to describe
+   * @returns A promise that resolves to the index statistics including dimension, count and metric
+   */
+  async describeIndex(...args: ParamsToArgs<DescribeIndexParams>): Promise<IndexStats> {
+    const params = this.normalizeArgs<DescribeIndexParams>('describeIndex', args);
+    const { indexName } = params;
     await this.getCollection();
     if (!(await this.listIndexes()).includes(indexName)) {
       throw new Error(`Index ${indexName} does not exist`);
@@ -276,7 +346,9 @@ export class CouchbaseVector extends MastraVector {
     };
   }
 
-  async deleteIndex(indexName: string): Promise<void> {
+  async deleteIndex(...args: ParamsToArgs<DeleteIndexParams>): Promise<void> {
+    const params = this.normalizeArgs<DeleteIndexParams>('deleteIndex', args);
+    const { indexName } = params;
     await this.getCollection();
     if (!(await this.listIndexes()).includes(indexName)) {
       throw new Error(`Index ${indexName} does not exist`);
@@ -295,14 +367,15 @@ export class CouchbaseVector extends MastraVector {
    * @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(
-    _indexName: string,
-    id: string,
-    updates: { vector?: number[]; metadata?: Record<string, any> },
-  ): Promise<void> {
-    if (!updates.vector && !updates.metadata) {
+  async updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void> {
+    const params = this.normalizeArgs<UpdateVectorParams>('updateVector', args);
+    const { id, update } = params;
+    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
@@ -316,8 +389,8 @@ export class CouchbaseVector extends MastraVector {
     }
 
     const specs: MutateInSpec[] = [];
-    if (updates.vector) specs.push(MutateInSpec.replace('embedding', updates.vector));
-    if (updates.metadata) specs.push(MutateInSpec.replace('metadata', updates.metadata));
+    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);
   }
@@ -329,7 +402,10 @@ export class CouchbaseVector extends MastraVector {
    * @returns A promise that resolves when the deletion is complete.
    * @throws Will throw an error if the deletion operation fails.
    */
-  async deleteVector(_indexName: string, id: string): Promise<void> {
+  async deleteVector(...args: ParamsToArgs<DeleteVectorParams>): Promise<void> {
+    const params = this.normalizeArgs<DeleteVectorParams>('deleteVector', args);
+
+    const { id } = params;
     const collection = await this.getCollection();
 
     // Check if document exists

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

@@ -165,14 +165,14 @@ describe('Unit Testing CouchbaseVector', () => {
     });
 
     it('should connect to couchbase', async () => {
-      couchbase_client = new CouchbaseVector(
-        'COUCHBASE_CONNECTION_STRING',
-        'COUCHBASE_USERNAME',
-        'COUCHBASE_PASSWORD',
-        test_bucketName,
-        test_scopeName,
-        test_collectionName,
-      );
+      couchbase_client = new CouchbaseVector({
+        connectionString: 'COUCHBASE_CONNECTION_STRING',
+        username: 'COUCHBASE_USERNAME',
+        password: 'COUCHBASE_PASSWORD',
+        bucketName: test_bucketName,
+        scopeName: test_scopeName,
+        collectionName: test_collectionName,
+      });
       expect(mockCouchbaseConnectFn).toHaveBeenCalledTimes(1);
       expect(mockCouchbaseConnectFn).toHaveBeenCalledWith('COUCHBASE_CONNECTION_STRING', {
         username: 'COUCHBASE_USERNAME',
@@ -200,14 +200,14 @@ describe('Unit Testing CouchbaseVector', () => {
   describe('Index Operations', () => {
     beforeAll(async () => {
       clearAllMocks();
-      couchbase_client = new CouchbaseVector(
-        'COUCHBASE_CONNECTION_STRING',
-        'COUCHBASE_USERNAME',
-        'COUCHBASE_PASSWORD',
-        test_bucketName,
-        test_scopeName,
-        test_collectionName,
-      );
+      couchbase_client = new CouchbaseVector({
+        connectionString: 'COUCHBASE_CONNECTION_STRING',
+        username: 'COUCHBASE_USERNAME',
+        password: 'COUCHBASE_PASSWORD',
+        bucketName: test_bucketName,
+        scopeName: test_scopeName,
+        collectionName: test_collectionName,
+      });
       await couchbase_client.getCollection();
     });
 
@@ -311,7 +311,7 @@ describe('Unit Testing CouchbaseVector', () => {
     }, 50000);
 
     it('should describe index', async () => {
-      const stats = await couchbase_client.describeIndex(test_indexName);
+      const stats = await couchbase_client.describeIndex({ indexName: test_indexName });
 
       expect(mockScopeSearchIndexesFn).toHaveBeenCalledTimes(2);
 
@@ -328,7 +328,7 @@ describe('Unit Testing CouchbaseVector', () => {
     }, 50000);
 
     it('should delete index', async () => {
-      await couchbase_client.deleteIndex(test_indexName);
+      await couchbase_client.deleteIndex({ indexName: test_indexName });
 
       expect(mockScopeSearchIndexesFn).toHaveBeenCalledTimes(2);
 
@@ -343,14 +343,14 @@ describe('Unit Testing CouchbaseVector', () => {
 
   describe('Vector Operations', () => {
     beforeAll(async () => {
-      couchbase_client = new CouchbaseVector(
-        'COUCHBASE_CONNECTION_STRING',
-        'COUCHBASE_USERNAME',
-        'COUCHBASE_PASSWORD',
-        test_bucketName,
-        test_scopeName,
-        test_collectionName,
-      );
+      couchbase_client = new CouchbaseVector({
+        connectionString: 'COUCHBASE_CONNECTION_STRING',
+        username: 'COUCHBASE_USERNAME',
+        password: 'COUCHBASE_PASSWORD',
+        bucketName: test_bucketName,
+        scopeName: test_scopeName,
+        collectionName: test_collectionName,
+      });
 
       await couchbase_client.getCollection();
     });
@@ -510,14 +510,14 @@ describe('Unit Testing CouchbaseVector', () => {
   describe('Error Cases and Edge Cases', () => {
     beforeAll(async () => {
       clearAllMocks();
-      couchbase_client = new CouchbaseVector(
-        'COUCHBASE_CONNECTION_STRING',
-        'COUCHBASE_USERNAME',
-        'COUCHBASE_PASSWORD',
-        test_bucketName,
-        test_scopeName,
-        test_collectionName,
-      );
+      couchbase_client = new CouchbaseVector({
+        connectionString: 'COUCHBASE_CONNECTION_STRING',
+        username: 'COUCHBASE_USERNAME',
+        password: 'COUCHBASE_PASSWORD',
+        bucketName: test_bucketName,
+        scopeName: test_scopeName,
+        collectionName: test_collectionName,
+      });
       await couchbase_client.getCollection();
     });
 
@@ -542,13 +542,13 @@ describe('Unit Testing CouchbaseVector', () => {
     });
 
     it('should throw error when describing a non-existent index', async () => {
-      await expect(couchbase_client.describeIndex('non_existent_index')).rejects.toThrow(
+      await expect(couchbase_client.describeIndex({ indexName: 'non_existent_index' })).rejects.toThrow(
         `Index non_existent_index does not exist`,
       );
     });
 
     it('should throw error when deleting a non-existent index', async () => {
-      await expect(couchbase_client.deleteIndex('non_existent_index')).rejects.toThrow(
+      await expect(couchbase_client.deleteIndex({ indexName: 'non_existent_index' })).rejects.toThrow(
         `Index non_existent_index does not exist`,
       );
     });
@@ -577,14 +577,14 @@ describe('Unit Testing CouchbaseVector', () => {
   describe('Vector Dimension Tracking', () => {
     beforeEach(async () => {
       clearAllMocks();
-      couchbase_client = new CouchbaseVector(
-        'COUCHBASE_CONNECTION_STRING',
-        'COUCHBASE_USERNAME',
-        'COUCHBASE_PASSWORD',
-        test_bucketName,
-        test_scopeName,
-        test_collectionName,
-      );
+      couchbase_client = new CouchbaseVector({
+        connectionString: 'COUCHBASE_CONNECTION_STRING',
+        username: 'COUCHBASE_USERNAME',
+        password: 'COUCHBASE_PASSWORD',
+        bucketName: test_bucketName,
+        scopeName: test_scopeName,
+        collectionName: test_collectionName,
+      });
       await couchbase_client.getCollection();
     });
 
@@ -637,7 +637,7 @@ describe('Unit Testing CouchbaseVector', () => {
       clearAllMocks();
 
       // Delete the index
-      await couchbase_client.deleteIndex(test_indexName);
+      await couchbase_client.deleteIndex({ indexName: test_indexName });
 
       // Verify dimension is reset
       expect((couchbase_client as any).vector_dimension).toBeNull();
@@ -647,14 +647,14 @@ describe('Unit Testing CouchbaseVector', () => {
   describe('Implementation Details', () => {
     beforeEach(async () => {
       clearAllMocks();
-      couchbase_client = new CouchbaseVector(
-        'COUCHBASE_CONNECTION_STRING',
-        'COUCHBASE_USERNAME',
-        'COUCHBASE_PASSWORD',
-        test_bucketName,
-        test_scopeName,
-        test_collectionName,
-      );
+      couchbase_client = new CouchbaseVector({
+        connectionString: 'COUCHBASE_CONNECTION_STRING',
+        username: 'COUCHBASE_USERNAME',
+        password: 'COUCHBASE_PASSWORD',
+        bucketName: test_bucketName,
+        scopeName: test_scopeName,
+        collectionName: test_collectionName,
+      });
       await couchbase_client.getCollection();
     });
 
@@ -713,7 +713,7 @@ describe('Unit Testing CouchbaseVector', () => {
           },
         });
 
-        const stats = await couchbase_client.describeIndex(test_indexName);
+        const stats = await couchbase_client.describeIndex({ indexName: test_indexName });
         expect(stats.metric).toBe(mastraMetric);
       }
     });