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

package/CHANGELOG.md

@@ -1,16 +1,260 @@
 # @mastra/couchbase
 
-## 0.0.0-vnext-inngest-20250508131921
+## 0.0.0-workflow-deno-20250616115451
+
+### Patch Changes
+
+- 63f6b7d: dependencies updates:
+  - Updated dependency [`couchbase@^4.5.0` ↗︎](https://www.npmjs.com/package/couchbase/v/4.5.0) (from `^4.4.5`, in `dependencies`)
+- Updated dependencies [63f6b7d]
+- Updated dependencies [ee9af57]
+- Updated dependencies [36f1c36]
+- Updated dependencies [10d352e]
+- Updated dependencies [3ca9a67]
+- Updated dependencies [53d3c37]
+- Updated dependencies [577ce3a]
+- Updated dependencies [9260b3a]
+  - @mastra/core@0.0.0-workflow-deno-20250616115451
+
+## 0.10.3-alpha.0
+
+### Patch Changes
+
+- 63f6b7d: dependencies updates:
+  - Updated dependency [`couchbase@^4.5.0` ↗︎](https://www.npmjs.com/package/couchbase/v/4.5.0) (from `^4.4.5`, in `dependencies`)
+- Updated dependencies [63f6b7d]
+- Updated dependencies [36f1c36]
+- Updated dependencies [10d352e]
+- Updated dependencies [53d3c37]
+  - @mastra/core@0.10.6-alpha.0
+
+## 0.10.2
+
+### Patch Changes
+
+- 66f4424: Update peerdeps
+- Updated dependencies [d1ed912]
+- Updated dependencies [f6fd25f]
+- Updated dependencies [dffb67b]
+- Updated dependencies [f1f1f1b]
+- Updated dependencies [925ab94]
+- Updated dependencies [f9816ae]
+- Updated dependencies [82090c1]
+- Updated dependencies [1b443fd]
+- Updated dependencies [ce97900]
+- Updated dependencies [f1309d3]
+- Updated dependencies [14a2566]
+- Updated dependencies [f7f8293]
+- Updated dependencies [48eddb9]
+  - @mastra/core@0.10.4
+
+## 0.10.2-alpha.0
+
+### Patch Changes
+
+- 66f4424: Update peerdeps
+
+## 0.10.1
+
+### Patch Changes
+
+- f0d559f: Fix peerdeps for alpha channel
+- 915ca1a: Added disconnect function for couchbase and added docs
+  Added prompt for OpenSearchVector
+- Updated dependencies [ee77e78]
+- Updated dependencies [592a2db]
+- Updated dependencies [e5dc18d]
+- Updated dependencies [ab5adbe]
+- Updated dependencies [1e8bb40]
+- Updated dependencies [1b5fc55]
+- Updated dependencies [195c428]
+- Updated dependencies [f73e11b]
+- Updated dependencies [37643b8]
+- Updated dependencies [99fd6cf]
+- Updated dependencies [c5bf1ce]
+- Updated dependencies [add596e]
+- Updated dependencies [8dc94d8]
+- Updated dependencies [ecebbeb]
+- Updated dependencies [79d5145]
+- Updated dependencies [12b7002]
+- Updated dependencies [2901125]
+  - @mastra/core@0.10.2
+
+## 0.10.1-alpha.1
+
+### Patch Changes
+
+- f0d559f: Fix peerdeps for alpha channel
+- Updated dependencies [1e8bb40]
+  - @mastra/core@0.10.2-alpha.2
+
+## 0.10.1-alpha.0
+
+### Patch Changes
+
+- 915ca1a: Added disconnect function for couchbase and added docs
+  Added prompt for OpenSearchVector
+- Updated dependencies [ee77e78]
+- Updated dependencies [2901125]
+  - @mastra/core@0.10.2-alpha.1
+
+## 0.10.0
+
+### Minor Changes
+
+- 83da932: Move @mastra/core to peerdeps
+
+### Patch Changes
+
+- d0ee3c6: Change all public functions and constructors in vector stores to use named args and prepare to phase out positional args
+- a7292b0: BREAKING(@mastra/core, all vector stores): Vector store breaking changes (remove deprecated functions and positional arguments)
+- Updated dependencies [b3a3d63]
+- Updated dependencies [344f453]
+- Updated dependencies [0a3ae6d]
+- Updated dependencies [95911be]
+- Updated dependencies [f53a6ac]
+- Updated dependencies [5eb5a99]
+- Updated dependencies [7e632c5]
+- Updated dependencies [1e9fbfa]
+- Updated dependencies [eabdcd9]
+- Updated dependencies [90be034]
+- Updated dependencies [99f050a]
+- Updated dependencies [d0ee3c6]
+- Updated dependencies [b2ae5aa]
+- Updated dependencies [23f258c]
+- Updated dependencies [a7292b0]
+- Updated dependencies [0dcb9f0]
+- Updated dependencies [2672a05]
+  - @mastra/core@0.10.0
+
+## 0.1.0-alpha.1
+
+### Minor Changes
+
+- 83da932: Move @mastra/core to peerdeps
+
+### Patch Changes
+
+- a7292b0: BREAKING(@mastra/core, all vector stores): Vector store breaking changes (remove deprecated functions and positional arguments)
+- Updated dependencies [b3a3d63]
+- Updated dependencies [344f453]
+- Updated dependencies [0a3ae6d]
+- Updated dependencies [95911be]
+- Updated dependencies [5eb5a99]
+- Updated dependencies [7e632c5]
+- Updated dependencies [1e9fbfa]
+- Updated dependencies [b2ae5aa]
+- Updated dependencies [a7292b0]
+- Updated dependencies [0dcb9f0]
+  - @mastra/core@0.10.0-alpha.1
+
+## 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
+
+- c3bd795: [MASTRA-3358] Deprecate updateIndexById and deleteIndexById
+- Updated dependencies [396be50]
+- Updated dependencies [ab80e7e]
+- Updated dependencies [c3bd795]
+- Updated dependencies [da082f8]
+- Updated dependencies [a5810ce]
+- Updated dependencies [3e9c131]
+- Updated dependencies [3171b5b]
+- Updated dependencies [973e5ac]
+- Updated dependencies [daf942f]
+- Updated dependencies [0b8b868]
+- Updated dependencies [9e1eff5]
+- Updated dependencies [6fa1ad1]
+- Updated dependencies [c28d7a0]
+- Updated dependencies [edf1e88]
+  - @mastra/core@0.9.4
+
+## 0.0.4-alpha.4
+
+### Patch Changes
+
+- Updated dependencies [3e9c131]
+  - @mastra/core@0.9.4-alpha.4
+
+## 0.0.4-alpha.3
+
+### Patch Changes
+
+- c3bd795: [MASTRA-3358] Deprecate updateIndexById and deleteIndexById
+- Updated dependencies [396be50]
+- Updated dependencies [c3bd795]
+- Updated dependencies [da082f8]
+- Updated dependencies [a5810ce]
+  - @mastra/core@0.9.4-alpha.3
+
+## 0.0.4-alpha.2
+
+### Patch Changes
+
+- Updated dependencies [3171b5b]
+- Updated dependencies [973e5ac]
+- Updated dependencies [9e1eff5]
+  - @mastra/core@0.9.4-alpha.2
+
+## 0.0.4-alpha.1
+
+### Patch Changes
+
+- Updated dependencies [ab80e7e]
+- Updated dependencies [6fa1ad1]
+- Updated dependencies [c28d7a0]
+- Updated dependencies [edf1e88]
+  - @mastra/core@0.9.4-alpha.1
+
+## 0.0.4-alpha.0
+
+### Patch Changes
+
+- Updated dependencies [daf942f]
+- Updated dependencies [0b8b868]
+  - @mastra/core@0.9.4-alpha.0
+
+## 0.0.3
 
 ### Patch Changes
 
 - 9cd1a46: [MASTRA-3338] update naming scheme for embedding index based on vector store rules and added duplicate index checks
+- Updated dependencies [e450778]
+- Updated dependencies [8902157]
+- Updated dependencies [ca0dc88]
 - Updated dependencies [526c570]
+- Updated dependencies [d7a6a33]
 - Updated dependencies [9cd1a46]
 - Updated dependencies [b5d2de0]
 - Updated dependencies [644f8ad]
 - Updated dependencies [70dbf51]
-  - @mastra/core@0.0.0-vnext-inngest-20250508131921
+  - @mastra/core@0.9.3
+
+## 0.0.3-alpha.1
+
+### Patch Changes
+
+- 9cd1a46: [MASTRA-3338] update naming scheme for embedding index based on vector store rules and added duplicate index checks
+- Updated dependencies [e450778]
+- Updated dependencies [8902157]
+- Updated dependencies [ca0dc88]
+- Updated dependencies [9cd1a46]
+- Updated dependencies [70dbf51]
+  - @mastra/core@0.9.3-alpha.1
 
 ## 0.0.3-alpha.0
 

package/README.md

@@ -51,7 +51,14 @@ const bucketName = 'your_vector_bucket';
 const scopeName = '_default'; // Or your custom scope name
 const collectionName = 'vector_data'; // Or your custom collection name
 
-const vectorStore = new CouchbaseVector(connectionString, username, password, bucketName, scopeName, collectionName);
+const vectorStore = new CouchbaseVector({
+  connectionString,
+  username,
+  password,
+  bucketName,
+  scopeName,
+  collectionName,
+});
 
 console.log('CouchbaseVector instance created. Connecting...');
 ```
@@ -214,6 +221,9 @@ _Note_: Deleting Index does NOT delete the vectors in the associated Couchbase C
 - `listIndexes()`: Lists the names of all Search Indexes in the cluster. Returns fully qualified names (e.g., `bucket.scope.index`).
 - `describeIndex(indexName)`: Gets the configured dimension, metric (Mastra name), and document count (currently returns -1) for a specific Search Index (using its short name).
 - `deleteIndex(indexName)`: Deletes a Search Index (using its short name).
+- `deleteVector(indexName, id)`: Deletes a specific vector entry from an index by its ID.
+- `updateVector(indexName, id, update)`: Updates a specific vector entry by its ID with new vector data and/or metadata.
+- `disconnect()`: Closes the Couchbase client connection. Should be called when done using the store.
 
 ## Configuration Details
 

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

@@ -1,9 +1,13 @@
 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 { 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,18 +22,55 @@ 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);
+    constructor({ connectionString, username, password, bucketName, scopeName, collectionName }: CouchbaseVectorParams);
     getCollection(): Promise<Collection>;
-    createIndex(params: CreateIndexParams): Promise<void>;
-    upsert(params: UpsertVectorParams): Promise<string[]>;
-    query(params: QueryVectorParams): Promise<QueryResult[]>;
+    createIndex({ indexName, dimension, metric }: CreateIndexParams): Promise<void>;
+    upsert({ vectors, metadata, ids }: UpsertVectorParams): Promise<string[]>;
+    query({ indexName, queryVector, topK, includeVector }: QueryVectorParams): Promise<QueryResult[]>;
     listIndexes(): Promise<string[]>;
-    describeIndex(indexName: string): Promise<IndexStats>;
-    deleteIndex(indexName: string): Promise<void>;
+    /**
+     * 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
+     */
+    describeIndex({ indexName }: DescribeIndexParams): Promise<IndexStats>;
+    deleteIndex({ indexName }: 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.
+     * @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.
+     */
+    updateVector({ id, update }: UpdateVectorParams): Promise<void>;
+    /**
+     * 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.
+     */
+    deleteVector({ id }: DeleteVectorParams): Promise<void>;
+    disconnect(): 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,13 @@
 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 { 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,18 +22,55 @@ 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);
+    constructor({ connectionString, username, password, bucketName, scopeName, collectionName }: CouchbaseVectorParams);
     getCollection(): Promise<Collection>;
-    createIndex(params: CreateIndexParams): Promise<void>;
-    upsert(params: UpsertVectorParams): Promise<string[]>;
-    query(params: QueryVectorParams): Promise<QueryResult[]>;
+    createIndex({ indexName, dimension, metric }: CreateIndexParams): Promise<void>;
+    upsert({ vectors, metadata, ids }: UpsertVectorParams): Promise<string[]>;
+    query({ indexName, queryVector, topK, includeVector }: QueryVectorParams): Promise<QueryResult[]>;
     listIndexes(): Promise<string[]>;
-    describeIndex(indexName: string): Promise<IndexStats>;
-    deleteIndex(indexName: string): Promise<void>;
+    /**
+     * 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
+     */
+    describeIndex({ indexName }: DescribeIndexParams): Promise<IndexStats>;
+    deleteIndex({ indexName }: 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.
+     * @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.
+     */
+    updateVector({ id, update }: UpdateVectorParams): Promise<void>;
+    /**
+     * 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.
+     */
+    deleteVector({ id }: DeleteVectorParams): Promise<void>;
+    disconnect(): 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,9 +19,9 @@ var CouchbaseVector = class extends vector.MastraVector {
   bucket;
   scope;
   vector_dimension;
-  constructor(cnn_string, username, password, bucketName, scopeName, collectionName) {
+  constructor({ connectionString, username, password, bucketName, scopeName, collectionName }) {
     super();
-    const baseClusterPromise = couchbase.connect(cnn_string, {
+    const baseClusterPromise = couchbase.connect(connectionString, {
       username,
       password,
       configProfile: "wanDevelopment"
@@ -53,8 +53,7 @@ var CouchbaseVector = class extends vector.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");
@@ -149,8 +148,7 @@ var CouchbaseVector = class extends vector.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");
@@ -181,10 +179,9 @@ var CouchbaseVector = class extends vector.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}`);
     }
@@ -221,7 +218,13 @@ 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 {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`);
@@ -238,7 +241,7 @@ var CouchbaseVector = class extends vector.MastraVector {
       )
     };
   }
-  async deleteIndex(indexName) {
+  async deleteIndex({ indexName }) {
     await this.getCollection();
     if (!(await this.listIndexes()).includes(indexName)) {
       throw new Error(`Index ${indexName} does not exist`);
@@ -246,6 +249,62 @@ var CouchbaseVector = class extends vector.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(couchbase.MutateInSpec.replace("embedding", update.vector));
+    if (update.metadata) specs.push(couchbase.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();
+  }
 };
 
 exports.CouchbaseVector = CouchbaseVector;

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';