@mastra/chroma 0.2.15 → 0.2.16-alpha.0

package/.turbo/turbo-build.log

@@ -1,23 +1,23 @@
 
-> @mastra/chroma@0.2.15-alpha.4 build /home/runner/work/mastra/mastra/stores/chroma
+> @mastra/chroma@0.2.16-alpha.0 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 8734ms
+TSC ⚡️ Build success in 8644ms
 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 8679ms
+DTS ⚡️ Build success in 7313ms
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-CJS dist/index.cjs 13.98 KB
-CJS ⚡️ Build success in 675ms
-ESM dist/index.js 13.93 KB
-ESM ⚡️ Build success in 682ms
+ESM dist/index.js 14.59 KB
+ESM ⚡️ Build success in 707ms
+CJS dist/index.cjs 14.64 KB
+CJS ⚡️ Build success in 707ms

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @mastra/chroma
 
+## 0.2.16-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.2.15
 
 ### Patch Changes

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

@@ -1,5 +1,8 @@
 import { BaseFilterTranslator } from '@mastra/core/vector/filter';
 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 { OperatorSupport } from '@mastra/core/vector/filter';
@@ -7,6 +10,7 @@ import type { ParamsToArgs } from '@mastra/core/vector';
 import type { QueryResult } from '@mastra/core/vector';
 import type { QueryVectorArgs } from '@mastra/core/vector';
 import type { QueryVectorParams } from '@mastra/core/vector';
+import type { UpdateVectorParams } from '@mastra/core/vector';
 import type { UpsertVectorArgs } from '@mastra/core/vector';
 import type { UpsertVectorParams } from '@mastra/core/vector';
 import type { VectorFilter } from '@mastra/core/vector/filter';
@@ -61,8 +65,15 @@ declare class ChromaVector extends MastraVector {
     transformFilter(filter?: VectorFilter): VectorFilter;
     query(...args: ParamsToArgs<ChromaQueryVectorParams> | ChromaQueryArgs): 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>;
     /**
      * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
      *
@@ -89,10 +100,7 @@ declare class ChromaVector 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, update: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): Promise<void>;
+    updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void>;
     /**
      * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
      *
@@ -110,7 +118,7 @@ declare class ChromaVector 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 { ChromaVector }
 export { ChromaVector as ChromaVector_alias_1 }

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

@@ -1,5 +1,8 @@
 import { BaseFilterTranslator } from '@mastra/core/vector/filter';
 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 { OperatorSupport } from '@mastra/core/vector/filter';
@@ -7,6 +10,7 @@ import type { ParamsToArgs } from '@mastra/core/vector';
 import type { QueryResult } from '@mastra/core/vector';
 import type { QueryVectorArgs } from '@mastra/core/vector';
 import type { QueryVectorParams } from '@mastra/core/vector';
+import type { UpdateVectorParams } from '@mastra/core/vector';
 import type { UpsertVectorArgs } from '@mastra/core/vector';
 import type { UpsertVectorParams } from '@mastra/core/vector';
 import type { VectorFilter } from '@mastra/core/vector/filter';
@@ -61,8 +65,15 @@ declare class ChromaVector extends MastraVector {
     transformFilter(filter?: VectorFilter): VectorFilter;
     query(...args: ParamsToArgs<ChromaQueryVectorParams> | ChromaQueryArgs): 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>;
     /**
      * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
      *
@@ -89,10 +100,7 @@ declare class ChromaVector 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, update: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): Promise<void>;
+    updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void>;
     /**
      * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
      *
@@ -110,7 +118,7 @@ declare class ChromaVector 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 { ChromaVector }
 export { ChromaVector as ChromaVector_alias_1 }

package/dist/index.cjs

@@ -128,7 +128,7 @@ var ChromaVector = class extends vector.MastraVector {
     const params = this.normalizeArgs("upsert", args, ["documents"]);
     const { indexName, vectors, metadata, ids, documents } = params;
     const collection = await this.getCollection(indexName);
-    const stats = await this.describeIndex(indexName);
+    const stats = await this.describeIndex({ indexName });
     this.validateVectorDimensions(vectors, stats.dimension);
     const generatedIds = ids || vectors.map(() => crypto.randomUUID());
     const normalizedMetadata = metadata || vectors.map(() => ({}));
@@ -203,7 +203,16 @@ var ChromaVector = class extends vector.MastraVector {
     const collections = await this.client.listCollections();
     return collections.map((collection) => collection);
   }
-  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;
     const collection = await this.getCollection(indexName);
     const count = await collection.count();
     const metadata = collection.metadata;
@@ -214,7 +223,9 @@ var ChromaVector = class extends vector.MastraVector {
       metric: this.HnswSpaceMap[hnswSpace]
     };
   }
-  async deleteIndex(indexName) {
+  async deleteIndex(...args) {
+    const params = this.normalizeArgs("deleteIndex", args);
+    const { indexName } = params;
     await this.client.deleteCollection({ name: indexName });
     this.collections.delete(indexName);
   }
@@ -236,7 +247,7 @@ var ChromaVector = class extends vector.MastraVector {
     Please use updateVector() instead. 
     updateIndexById() will be removed on May 20th, 2025.`
     );
-    await this.updateVector(indexName, id, update);
+    await this.updateVector({ indexName, id, update });
   }
   /**
    * Updates a vector by its ID with the provided vector and/or metadata.
@@ -248,7 +259,9 @@ var ChromaVector = 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, update) {
+  async updateVector(...args) {
+    const params = this.normalizeArgs("updateVector", args);
+    const { indexName, id, update } = params;
     try {
       if (!update.vector && !update.metadata) {
         throw new Error("No updates provided");
@@ -256,7 +269,7 @@ var ChromaVector = class extends vector.MastraVector {
       const collection = await this.getCollection(indexName, true);
       const updateOptions = { ids: [id] };
       if (update?.vector) {
-        const stats = await this.describeIndex(indexName);
+        const stats = await this.describeIndex({ indexName });
         this.validateVectorDimensions([update.vector], stats.dimension);
         updateOptions.embeddings = [update.vector];
       }
@@ -290,7 +303,9 @@ var ChromaVector = 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 { indexName, id } = params;
     try {
       const collection = await this.getCollection(indexName, true);
       await collection.delete({ ids: [id] });

package/dist/index.js

@@ -126,7 +126,7 @@ var ChromaVector = class extends MastraVector {
     const params = this.normalizeArgs("upsert", args, ["documents"]);
     const { indexName, vectors, metadata, ids, documents } = params;
     const collection = await this.getCollection(indexName);
-    const stats = await this.describeIndex(indexName);
+    const stats = await this.describeIndex({ indexName });
     this.validateVectorDimensions(vectors, stats.dimension);
     const generatedIds = ids || vectors.map(() => crypto.randomUUID());
     const normalizedMetadata = metadata || vectors.map(() => ({}));
@@ -201,7 +201,16 @@ var ChromaVector = class extends MastraVector {
     const collections = await this.client.listCollections();
     return collections.map((collection) => collection);
   }
-  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;
     const collection = await this.getCollection(indexName);
     const count = await collection.count();
     const metadata = collection.metadata;
@@ -212,7 +221,9 @@ var ChromaVector = class extends MastraVector {
       metric: this.HnswSpaceMap[hnswSpace]
     };
   }
-  async deleteIndex(indexName) {
+  async deleteIndex(...args) {
+    const params = this.normalizeArgs("deleteIndex", args);
+    const { indexName } = params;
     await this.client.deleteCollection({ name: indexName });
     this.collections.delete(indexName);
   }
@@ -234,7 +245,7 @@ var ChromaVector = class extends MastraVector {
     Please use updateVector() instead. 
     updateIndexById() will be removed on May 20th, 2025.`
     );
-    await this.updateVector(indexName, id, update);
+    await this.updateVector({ indexName, id, update });
   }
   /**
    * Updates a vector by its ID with the provided vector and/or metadata.
@@ -246,7 +257,9 @@ var ChromaVector = 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, update) {
+  async updateVector(...args) {
+    const params = this.normalizeArgs("updateVector", args);
+    const { indexName, id, update } = params;
     try {
       if (!update.vector && !update.metadata) {
         throw new Error("No updates provided");
@@ -254,7 +267,7 @@ var ChromaVector = class extends MastraVector {
       const collection = await this.getCollection(indexName, true);
       const updateOptions = { ids: [id] };
       if (update?.vector) {
-        const stats = await this.describeIndex(indexName);
+        const stats = await this.describeIndex({ indexName });
         this.validateVectorDimensions([update.vector], stats.dimension);
         updateOptions.embeddings = [update.vector];
       }
@@ -288,7 +301,9 @@ var ChromaVector = 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 { indexName, id } = params;
     try {
       const collection = await this.getCollection(indexName, true);
       await collection.delete({ ids: [id] });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/chroma",
-  "version": "0.2.15",
+  "version": "0.2.16-alpha.0",
   "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"
+    "@mastra/core": "^0.9.5-alpha.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.52.5",

package/src/vector/index.test.ts

@@ -16,7 +16,7 @@ describe('ChromaVector Integration Tests', () => {
   beforeEach(async () => {
     // Clean up any existing test index
     try {
-      await vectorDB.deleteIndex(testIndexName);
+      await vectorDB.deleteIndex({ indexName: testIndexName });
     } catch {
       // Ignore errors if index doesn't exist
     }
@@ -26,7 +26,7 @@ describe('ChromaVector Integration Tests', () => {
   afterEach(async () => {
     // Cleanup after tests
     try {
-      await vectorDB.deleteIndex(testIndexName);
+      await vectorDB.deleteIndex({ indexName: testIndexName });
     } catch {
       // Ignore cleanup errors
     }
@@ -39,14 +39,14 @@ describe('ChromaVector Integration Tests', () => {
     });
 
     it('should describe index correctly', async () => {
-      const stats: IndexStats = await vectorDB.describeIndex(testIndexName);
+      const stats: IndexStats = await vectorDB.describeIndex({ indexName: testIndexName });
       expect(stats.dimension).toBe(dimension);
       expect(stats.count).toBe(0);
       expect(stats.metric).toBe('cosine');
     });
 
     it('should delete index', async () => {
-      await vectorDB.deleteIndex(testIndexName);
+      await vectorDB.deleteIndex({ indexName: testIndexName });
       const indexes = await vectorDB.listIndexes();
       expect(indexes).not.toContain(testIndexName);
     });
@@ -58,10 +58,10 @@ describe('ChromaVector Integration Tests', () => {
         const testIndex = `test-index-${metric}`;
         await vectorDB.createIndex({ indexName: testIndex, dimension, metric });
 
-        const stats = await vectorDB.describeIndex(testIndex);
+        const stats = await vectorDB.describeIndex({ indexName: testIndex });
         expect(stats.metric).toBe(metric);
 
-        await vectorDB.deleteIndex(testIndex);
+        await vectorDB.deleteIndex({ indexName: testIndex });
       }
     });
   });
@@ -80,14 +80,14 @@ describe('ChromaVector Integration Tests', () => {
       expect(ids).toHaveLength(testVectors.length);
       ids.forEach(id => expect(typeof id).toBe('string'));
 
-      const stats = await vectorDB.describeIndex(testIndexName);
+      const stats = await vectorDB.describeIndex({ indexName: testIndexName });
       expect(stats.count).toBe(testVectors.length);
     });
 
     it('should upsert vectors with provided ids and metadata', async () => {
       await vectorDB.upsert({ indexName: testIndexName, vectors: testVectors, metadata: testMetadata, ids: testIds });
 
-      const stats = await vectorDB.describeIndex(testIndexName);
+      const stats = await vectorDB.describeIndex({ indexName: testIndexName });
       expect(stats.count).toBe(testVectors.length);
 
       // Query each vector to verify metadata
@@ -133,7 +133,7 @@ describe('ChromaVector Integration Tests', () => {
         metadata: newMetaData,
       };
 
-      await vectorDB.updateVector(testIndexName, idToBeUpdated, update);
+      await vectorDB.updateVector({ indexName: testIndexName, id: idToBeUpdated, update });
 
       const results: QueryResult[] = await vectorDB.query({
         indexName: testIndexName,
@@ -159,7 +159,7 @@ describe('ChromaVector Integration Tests', () => {
         metadata: newMetaData,
       };
 
-      await vectorDB.updateVector(testIndexName, idToBeUpdated, update);
+      await vectorDB.updateVector({ indexName: testIndexName, id: idToBeUpdated, update });
 
       const results: QueryResult[] = await vectorDB.query({
         indexName: testIndexName,
@@ -183,7 +183,7 @@ describe('ChromaVector Integration Tests', () => {
         vector: newVector,
       };
 
-      await vectorDB.updateVector(testIndexName, idToBeUpdated, update);
+      await vectorDB.updateVector({ indexName: testIndexName, id: idToBeUpdated, update });
 
       const results: QueryResult[] = await vectorDB.query({
         indexName: testIndexName,
@@ -196,7 +196,9 @@ describe('ChromaVector Integration Tests', () => {
     });
 
     it('should throw exception when no updates are given', async () => {
-      await expect(vectorDB.updateVector(testIndexName, 'id', {})).rejects.toThrow('No updates provided');
+      await expect(vectorDB.updateVector({ indexName: testIndexName, id: 'id', update: {} })).rejects.toThrow(
+        'No updates provided',
+      );
     });
 
     it('should delete the vector by id', async () => {
@@ -204,7 +206,7 @@ describe('ChromaVector Integration Tests', () => {
       expect(ids).toHaveLength(3);
       const idToBeDeleted = ids[0];
 
-      await vectorDB.deleteVector(testIndexName, idToBeDeleted);
+      await vectorDB.deleteVector({ indexName: testIndexName, id: idToBeDeleted });
 
       const results: QueryResult[] = await vectorDB.query({
         indexName: testIndexName,
@@ -279,7 +281,7 @@ describe('ChromaVector Integration Tests', () => {
     });
 
     afterAll(async () => {
-      await vectorDB.deleteIndex(testIndexName);
+      await vectorDB.deleteIndex({ indexName: testIndexName });
     });
 
     it('should handle non-existent index queries', async () => {
@@ -342,7 +344,7 @@ describe('ChromaVector Integration Tests', () => {
         infoSpy.mockRestore();
         warnSpy.mockRestore();
         // Cleanup
-        await vectorDB.deleteIndex(duplicateIndexName);
+        await vectorDB.deleteIndex({ indexName: duplicateIndexName });
       }
     });
   });
@@ -519,7 +521,7 @@ describe('ChromaVector Integration Tests', () => {
     // Set up test vectors and metadata
     beforeAll(async () => {
       try {
-        await vectorDB.deleteIndex(testIndexName2);
+        await vectorDB.deleteIndex({ indexName: testIndexName2 });
       } catch {
         // Ignore errors if index doesn't exist
       }
@@ -567,7 +569,7 @@ describe('ChromaVector Integration Tests', () => {
     afterAll(async () => {
       // Cleanup after tests
       try {
-        await vectorDB.deleteIndex(testIndexName2);
+        await vectorDB.deleteIndex({ indexName: testIndexName2 });
       } catch {
         // Ignore cleanup errors
       }
@@ -1238,7 +1240,7 @@ describe('ChromaVector Integration Tests', () => {
 
     beforeAll(async () => {
       try {
-        await vectorDB.deleteIndex(testIndexName3);
+        await vectorDB.deleteIndex({ indexName: testIndexName3 });
       } catch {
         // Ignore errors if index doesn't exist
       }
@@ -1272,7 +1274,7 @@ describe('ChromaVector Integration Tests', () => {
     afterAll(async () => {
       // Cleanup after tests
       try {
-        await vectorDB.deleteIndex(testIndexName3);
+        await vectorDB.deleteIndex({ indexName: testIndexName3 });
       } catch {
         // Ignore cleanup errors
       }
@@ -1468,17 +1470,17 @@ describe('ChromaVector Integration Tests', () => {
     let warnSpy;
 
     beforeAll(async () => {
-      await vectorDB.createIndex({ indexName: indexName, dimension: 3 });
+      await vectorDB.createIndex({ indexName, dimension: 3 });
     });
 
     afterAll(async () => {
       try {
-        await vectorDB.deleteIndex(indexName);
+        await vectorDB.deleteIndex({ indexName });
       } catch {
         // Ignore errors if index doesn't exist
       }
       try {
-        await vectorDB.deleteIndex(indexName2);
+        await vectorDB.deleteIndex({ indexName: indexName2 });
       } catch {
         // Ignore errors if index doesn't exist
       }
@@ -1491,7 +1493,7 @@ describe('ChromaVector Integration Tests', () => {
     afterEach(async () => {
       warnSpy.mockRestore();
       try {
-        await vectorDB.deleteIndex(indexName2);
+        await vectorDB.deleteIndex({ indexName: indexName2 });
       } catch {
         // Ignore errors if index doesn't exist
       }
@@ -1575,7 +1577,7 @@ describe('ChromaVector Integration Tests', () => {
 
     beforeEach(async () => {
       try {
-        await vectorDB.deleteIndex(perfTestIndex);
+        await vectorDB.deleteIndex({ indexName: perfTestIndex });
       } catch {
         // Ignore errors if index doesn't exist
       }
@@ -1584,7 +1586,7 @@ describe('ChromaVector Integration Tests', () => {
 
     afterEach(async () => {
       try {
-        await vectorDB.deleteIndex(perfTestIndex);
+        await vectorDB.deleteIndex({ indexName: perfTestIndex });
       } catch {
         // Ignore cleanup errors
       }
@@ -1627,7 +1629,7 @@ describe('ChromaVector Integration Tests', () => {
       });
 
       // Verify all vectors were inserted
-      const stats = await vectorDB.describeIndex(perfTestIndex);
+      const stats = await vectorDB.describeIndex({ indexName: perfTestIndex });
       expect(stats.count).toBe(batchSize);
 
       const results = await vectorDB.query({

package/src/vector/index.ts

@@ -8,6 +8,10 @@ import type {
   ParamsToArgs,
   QueryVectorArgs,
   UpsertVectorArgs,
+  DescribeIndexParams,
+  DeleteIndexParams,
+  DeleteVectorParams,
+  UpdateVectorParams,
 } from '@mastra/core/vector';
 
 import type { VectorFilter } from '@mastra/core/vector/filter';
@@ -80,7 +84,7 @@ export class ChromaVector extends MastraVector {
     const collection = await this.getCollection(indexName);
 
     // Get index stats to check dimension
-    const stats = await this.describeIndex(indexName);
+    const stats = await this.describeIndex({ indexName });
 
     // Validate vector dimensions
     this.validateVectorDimensions(vectors, stats.dimension);
@@ -177,7 +181,17 @@ export class ChromaVector extends MastraVector {
     return collections.map(collection => collection);
   }
 
-  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;
+
     const collection = await this.getCollection(indexName);
     const count = await collection.count();
     const metadata = collection.metadata;
@@ -191,7 +205,9 @@ export class ChromaVector 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.client.deleteCollection({ name: indexName });
     this.collections.delete(indexName);
   }
@@ -218,7 +234,7 @@ export class ChromaVector extends MastraVector {
     Please use updateVector() instead. 
     updateIndexById() will be removed on May 20th, 2025.`,
     );
-    await this.updateVector(indexName, id, update);
+    await this.updateVector({ indexName, id, update });
   }
 
   /**
@@ -231,11 +247,9 @@ export class ChromaVector 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,
-    update: { vector?: number[]; metadata?: Record<string, any> },
-  ): Promise<void> {
+  async updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void> {
+    const params = this.normalizeArgs<UpdateVectorParams>('updateVector', args);
+    const { indexName, id, update } = params;
     try {
       if (!update.vector && !update.metadata) {
         throw new Error('No updates provided');
@@ -246,7 +260,7 @@ export class ChromaVector extends MastraVector {
       const updateOptions: UpdateRecordsParams = { ids: [id] };
 
       if (update?.vector) {
-        const stats = await this.describeIndex(indexName);
+        const stats = await this.describeIndex({ indexName });
         this.validateVectorDimensions([update.vector], stats.dimension);
         updateOptions.embeddings = [update.vector];
       }
@@ -284,7 +298,10 @@ export class ChromaVector 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 { indexName, id } = params;
     try {
       const collection: Collection = await this.getCollection(indexName, true);
       await collection.delete({ ids: [id] });