@mastra/chroma 0.2.15-alpha.2 → 0.2.15-alpha.3

package/.turbo/turbo-build.log

@@ -1,23 +1,23 @@
 
-> @mastra/chroma@0.2.15-alpha.2 build /home/runner/work/mastra/mastra/stores/chroma
+> @mastra/chroma@0.2.15-alpha.3 build /home/runner/work/mastra/mastra/stores/chroma
 > 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 9514ms
+TSC ⚡️ Build success in 9802ms
 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/chroma/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/chroma/dist/_tsup-dts-rollup.d.cts
-DTS ⚡️ Build success in 8745ms
+DTS ⚡️ Build success in 9633ms
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-ESM dist/index.js 11.12 KB
-ESM ⚡️ Build success in 765ms
-CJS dist/index.cjs 11.18 KB
-CJS ⚡️ Build success in 769ms
+ESM dist/index.js 13.93 KB
+ESM ⚡️ Build success in 630ms
+CJS dist/index.cjs 13.98 KB
+CJS ⚡️ Build success in 636ms

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @mastra/chroma
 
+## 0.2.15-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.2.15-alpha.2
 
 ### Patch Changes

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

@@ -63,11 +63,54 @@ declare class ChromaVector extends MastraVector {
     listIndexes(): Promise<string[]>;
     describeIndex(indexName: string): Promise<IndexStats>;
     deleteIndex(indexName: string): Promise<void>;
+    /**
+     * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
+     *
+     * 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.
+     */
     updateIndexById(indexName: string, id: string, update: {
         vector?: number[];
         metadata?: Record<string, any>;
     }): 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(indexName: string, id: string, update: {
+        vector?: number[];
+        metadata?: Record<string, any>;
+    }): Promise<void>;
+    /**
+     * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
+     *
+     * 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.
+     */
     deleteIndexById(indexName: string, id: string): 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(indexName: string, id: string): Promise<void>;
 }
 export { ChromaVector }
 export { ChromaVector as ChromaVector_alias_1 }

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

@@ -63,11 +63,54 @@ declare class ChromaVector extends MastraVector {
     listIndexes(): Promise<string[]>;
     describeIndex(indexName: string): Promise<IndexStats>;
     deleteIndex(indexName: string): Promise<void>;
+    /**
+     * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
+     *
+     * 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.
+     */
     updateIndexById(indexName: string, id: string, update: {
         vector?: number[];
         metadata?: Record<string, any>;
     }): 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(indexName: string, id: string, update: {
+        vector?: number[];
+        metadata?: Record<string, any>;
+    }): Promise<void>;
+    /**
+     * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
+     *
+     * 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.
+     */
     deleteIndexById(indexName: string, id: string): 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(indexName: string, id: string): Promise<void>;
 }
 export { ChromaVector }
 export { ChromaVector as ChromaVector_alias_1 }

package/dist/index.cjs

@@ -218,26 +218,84 @@ var ChromaVector = class extends vector.MastraVector {
     await this.client.deleteCollection({ name: indexName });
     this.collections.delete(indexName);
   }
+  /**
+   * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
+   *
+   * 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 updateIndexById(indexName, id, update) {
-    if (!update.vector && !update.metadata) {
-      throw new Error("No updates provided");
-    }
-    const collection = await this.getCollection(indexName, true);
-    const updateOptions = { ids: [id] };
-    if (update?.vector) {
-      updateOptions.embeddings = [update.vector];
-    }
-    if (update?.metadata) {
-      updateOptions.metadatas = [update.metadata];
+    this.logger.warn(
+      `Deprecation Warning: updateIndexById() is deprecated. 
+    Please use updateVector() instead. 
+    updateIndexById() will be removed on May 20th, 2025.`
+    );
+    await this.updateVector(indexName, id, update);
+  }
+  /**
+   * 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(indexName, id, update) {
+    try {
+      if (!update.vector && !update.metadata) {
+        throw new Error("No updates provided");
+      }
+      const collection = await this.getCollection(indexName, true);
+      const updateOptions = { ids: [id] };
+      if (update?.vector) {
+        const stats = await this.describeIndex(indexName);
+        this.validateVectorDimensions([update.vector], stats.dimension);
+        updateOptions.embeddings = [update.vector];
+      }
+      if (update?.metadata) {
+        updateOptions.metadatas = [update.metadata];
+      }
+      return await collection.update(updateOptions);
+    } catch (error) {
+      throw new Error(`Failed to update vector by id: ${id} for index name: ${indexName}: ${error.message}`);
     }
-    return await collection.update(updateOptions);
   }
+  /**
+   * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
+   *
+   * 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 deleteIndexById(indexName, id) {
+    this.logger.warn(
+      `Deprecation Warning: deleteIndexById() is deprecated. Please use deleteVector() instead. deleteIndexById() will be removed on May 20th.`
+    );
+    await this.deleteVector(indexName, id);
+  }
+  /**
+   * 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(indexName, id) {
     try {
       const collection = await this.getCollection(indexName, true);
       await collection.delete({ ids: [id] });
     } catch (error) {
-      throw new Error(`Failed to delete index by id: ${id} for index name: ${indexName}: ${error.message}`);
+      throw new Error(`Failed to delete vector by id: ${id} for index name: ${indexName}: ${error.message}`);
     }
   }
 };

package/dist/index.js

@@ -216,26 +216,84 @@ var ChromaVector = class extends MastraVector {
     await this.client.deleteCollection({ name: indexName });
     this.collections.delete(indexName);
   }
+  /**
+   * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
+   *
+   * 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 updateIndexById(indexName, id, update) {
-    if (!update.vector && !update.metadata) {
-      throw new Error("No updates provided");
-    }
-    const collection = await this.getCollection(indexName, true);
-    const updateOptions = { ids: [id] };
-    if (update?.vector) {
-      updateOptions.embeddings = [update.vector];
-    }
-    if (update?.metadata) {
-      updateOptions.metadatas = [update.metadata];
+    this.logger.warn(
+      `Deprecation Warning: updateIndexById() is deprecated. 
+    Please use updateVector() instead. 
+    updateIndexById() will be removed on May 20th, 2025.`
+    );
+    await this.updateVector(indexName, id, update);
+  }
+  /**
+   * 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(indexName, id, update) {
+    try {
+      if (!update.vector && !update.metadata) {
+        throw new Error("No updates provided");
+      }
+      const collection = await this.getCollection(indexName, true);
+      const updateOptions = { ids: [id] };
+      if (update?.vector) {
+        const stats = await this.describeIndex(indexName);
+        this.validateVectorDimensions([update.vector], stats.dimension);
+        updateOptions.embeddings = [update.vector];
+      }
+      if (update?.metadata) {
+        updateOptions.metadatas = [update.metadata];
+      }
+      return await collection.update(updateOptions);
+    } catch (error) {
+      throw new Error(`Failed to update vector by id: ${id} for index name: ${indexName}: ${error.message}`);
     }
-    return await collection.update(updateOptions);
   }
+  /**
+   * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
+   *
+   * 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 deleteIndexById(indexName, id) {
+    this.logger.warn(
+      `Deprecation Warning: deleteIndexById() is deprecated. Please use deleteVector() instead. deleteIndexById() will be removed on May 20th.`
+    );
+    await this.deleteVector(indexName, id);
+  }
+  /**
+   * 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(indexName, id) {
     try {
       const collection = await this.getCollection(indexName, true);
       await collection.delete({ ids: [id] });
     } catch (error) {
-      throw new Error(`Failed to delete index by id: ${id} for index name: ${indexName}: ${error.message}`);
+      throw new Error(`Failed to delete vector by id: ${id} for index name: ${indexName}: ${error.message}`);
     }
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/chroma",
-  "version": "0.2.15-alpha.2",
+  "version": "0.2.15-alpha.3",
   "description": "Chroma vector store provider for Mastra",
   "type": "module",
   "main": "dist/index.js",
@@ -21,7 +21,7 @@
   "license": "MIT",
   "dependencies": {
     "chromadb": "^2.2.0",
-    "@mastra/core": "^0.9.4-alpha.2"
+    "@mastra/core": "^0.9.4-alpha.3"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.52.5",

package/src/vector/index.test.ts

@@ -133,7 +133,7 @@ describe('ChromaVector Integration Tests', () => {
         metadata: newMetaData,
       };
 
-      await vectorDB.updateIndexById(testIndexName, idToBeUpdated, update);
+      await vectorDB.updateVector(testIndexName, idToBeUpdated, update);
 
       const results: QueryResult[] = await vectorDB.query({
         indexName: testIndexName,
@@ -159,7 +159,7 @@ describe('ChromaVector Integration Tests', () => {
         metadata: newMetaData,
       };
 
-      await vectorDB.updateIndexById(testIndexName, idToBeUpdated, update);
+      await vectorDB.updateVector(testIndexName, idToBeUpdated, update);
 
       const results: QueryResult[] = await vectorDB.query({
         indexName: testIndexName,
@@ -183,7 +183,7 @@ describe('ChromaVector Integration Tests', () => {
         vector: newVector,
       };
 
-      await vectorDB.updateIndexById(testIndexName, idToBeUpdated, update);
+      await vectorDB.updateVector(testIndexName, idToBeUpdated, update);
 
       const results: QueryResult[] = await vectorDB.query({
         indexName: testIndexName,
@@ -196,7 +196,7 @@ describe('ChromaVector Integration Tests', () => {
     });
 
     it('should throw exception when no updates are given', async () => {
-      await expect(vectorDB.updateIndexById(testIndexName, 'id', {})).rejects.toThrow('No updates provided');
+      await expect(vectorDB.updateVector(testIndexName, 'id', {})).rejects.toThrow('No updates provided');
     });
 
     it('should delete the vector by id', async () => {
@@ -204,7 +204,7 @@ describe('ChromaVector Integration Tests', () => {
       expect(ids).toHaveLength(3);
       const idToBeDeleted = ids[0];
 
-      await vectorDB.deleteIndexById(testIndexName, idToBeDeleted);
+      await vectorDB.deleteVector(testIndexName, idToBeDeleted);
 
       const results: QueryResult[] = await vectorDB.query({
         indexName: testIndexName,

package/src/vector/index.ts

@@ -196,36 +196,100 @@ export class ChromaVector extends MastraVector {
     this.collections.delete(indexName);
   }
 
+  /**
+   * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
+   *
+   * 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 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');
-    }
+    this.logger.warn(
+      `Deprecation Warning: updateIndexById() is deprecated. 
+    Please use updateVector() instead. 
+    updateIndexById() will be removed on May 20th, 2025.`,
+    );
+    await this.updateVector(indexName, id, update);
+  }
+
+  /**
+   * 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(
+    indexName: string,
+    id: string,
+    update: { vector?: number[]; metadata?: Record<string, any> },
+  ): Promise<void> {
+    try {
+      if (!update.vector && !update.metadata) {
+        throw new Error('No updates provided');
+      }
 
-    const collection: Collection = await this.getCollection(indexName, true);
+      const collection: Collection = await this.getCollection(indexName, true);
 
-    const updateOptions: UpdateRecordsParams = { ids: [id] };
+      const updateOptions: UpdateRecordsParams = { ids: [id] };
 
-    if (update?.vector) {
-      updateOptions.embeddings = [update.vector];
-    }
+      if (update?.vector) {
+        const stats = await this.describeIndex(indexName);
+        this.validateVectorDimensions([update.vector], stats.dimension);
+        updateOptions.embeddings = [update.vector];
+      }
 
-    if (update?.metadata) {
-      updateOptions.metadatas = [update.metadata];
-    }
+      if (update?.metadata) {
+        updateOptions.metadatas = [update.metadata];
+      }
 
-    return await collection.update(updateOptions);
+      return await collection.update(updateOptions);
+    } catch (error: any) {
+      throw new Error(`Failed to update vector by id: ${id} for index name: ${indexName}: ${error.message}`);
+    }
   }
 
+  /**
+   * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
+   *
+   * 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 deleteIndexById(indexName: string, id: string): Promise<void> {
+    this.logger.warn(
+      `Deprecation Warning: deleteIndexById() is deprecated. Please use deleteVector() instead. deleteIndexById() will be removed on May 20th.`,
+    );
+    await this.deleteVector(indexName, id);
+  }
+
+  /**
+   * 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(indexName: string, id: string): Promise<void> {
     try {
       const collection: Collection = await this.getCollection(indexName, true);
       await collection.delete({ ids: [id] });
     } catch (error: any) {
-      throw new Error(`Failed to delete index by id: ${id} for index name: ${indexName}: ${error.message}`);
+      throw new Error(`Failed to delete vector by id: ${id} for index name: ${indexName}: ${error.message}`);
     }
   }
 }