@mastra/chroma 0.10.3 → 0.10.4-alpha.1

package/.turbo/turbo-build.log

@@ -1,23 +1,23 @@
 
-> @mastra/chroma@0.10.3-alpha.0 build /home/runner/work/mastra/mastra/stores/chroma
+> @mastra/chroma@0.10.4-alpha.1 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.5.0
 TSC Build start
-TSC ⚡️ Build success in 8884ms
+TSC ⚡️ Build success in 8871ms
 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 9546ms
+DTS ⚡️ Build success in 8471ms
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-ESM dist/index.js 12.30 KB
-ESM ⚡️ Build success in 820ms
-CJS dist/index.cjs 12.35 KB
-CJS ⚡️ Build success in 817ms
+CJS dist/index.cjs 15.17 KB
+CJS ⚡️ Build success in 550ms
+ESM dist/index.js 14.87 KB
+ESM ⚡️ Build success in 550ms

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @mastra/chroma
 
+## 0.10.4-alpha.1
+
+### Patch Changes
+
+- 144eb0b: [MASTRA-3669] Metadata Filter Types
+- Updated dependencies [15e9d26]
+- Updated dependencies [07d6d88]
+- Updated dependencies [5d74aab]
+- Updated dependencies [144eb0b]
+  - @mastra/core@0.10.7-alpha.2
+
+## 0.10.4-alpha.0
+
+### Patch Changes
+
+- 0e17048: Throw mastra errors in storage packages
+- Updated dependencies [d1baedb]
+- Updated dependencies [4d21bf2]
+- Updated dependencies [2097952]
+- Updated dependencies [4fb0cc2]
+- Updated dependencies [d2a7a31]
+- Updated dependencies [0e17048]
+  - @mastra/core@0.10.7-alpha.1
+
 ## 0.10.3
 
 ### Patch Changes

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

@@ -1,11 +1,14 @@
 import { BaseFilterTranslator } from '@mastra/core/vector/filter';
+import type { BlacklistedRootOperators } 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 type { LogicalOperatorValueMap } from '@mastra/core/vector/filter';
 import { MastraVector } from '@mastra/core/vector';
 import type { OperatorSupport } from '@mastra/core/vector/filter';
+import type { OperatorValueMap } from '@mastra/core/vector/filter';
 import type { QueryResult } from '@mastra/core/vector';
 import type { QueryVectorParams } from '@mastra/core/vector';
 import type { UpdateVectorParams } from '@mastra/core/vector';
@@ -20,27 +23,37 @@ declare const CHROMA_PROMPT = "When querying Chroma, you can ONLY use the operat
 export { CHROMA_PROMPT }
 export { CHROMA_PROMPT as CHROMA_PROMPT_alias_1 }
 
+declare type ChromaBlacklisted = BlacklistedRootOperators | '$nor' | '$not';
+
+declare type ChromaDocumentBlacklisted = Exclude<ChromaBlacklisted, '$contains'>;
+
+declare type ChromaDocumentOperatorValueMap = ChromaOperatorValueMap;
+
 /**
  * Translator for Chroma filter queries.
  * Maintains MongoDB-compatible syntax while ensuring proper validation
  * and normalization of values.
  */
-export declare class ChromaFilterTranslator extends BaseFilterTranslator {
+export declare class ChromaFilterTranslator extends BaseFilterTranslator<ChromaVectorFilter> {
     protected getSupportedOperators(): OperatorSupport;
-    translate(filter?: VectorFilter): VectorFilter;
+    translate(filter?: ChromaVectorFilter): ChromaVectorFilter;
     private translateNode;
     private translateOperator;
 }
 
-declare interface ChromaQueryVectorParams extends QueryVectorParams {
-    documentFilter?: VectorFilter;
+declare type ChromaLogicalOperatorValueMap = Omit<LogicalOperatorValueMap, '$nor' | '$not'>;
+
+declare type ChromaOperatorValueMap = Omit<OperatorValueMap, '$exists' | '$elemMatch' | '$regex' | '$options'>;
+
+declare interface ChromaQueryVectorParams extends QueryVectorParams<ChromaVectorFilter> {
+    documentFilter?: ChromaVectorDocumentFilter;
 }
 
 declare interface ChromaUpsertVectorParams extends UpsertVectorParams {
     documents?: string[];
 }
 
-declare class ChromaVector extends MastraVector {
+declare class ChromaVector extends MastraVector<ChromaVectorFilter> {
     private client;
     private collections;
     constructor({ path, auth, }: {
@@ -55,7 +68,7 @@ declare class ChromaVector extends MastraVector {
     upsert({ indexName, vectors, metadata, ids, documents }: ChromaUpsertVectorParams): Promise<string[]>;
     private HnswSpaceMap;
     createIndex({ indexName, dimension, metric }: CreateIndexParams): Promise<void>;
-    transformFilter(filter?: VectorFilter): VectorFilter;
+    transformFilter(filter?: ChromaVectorFilter): ChromaVectorFilter;
     query({ indexName, queryVector, topK, filter, includeVector, documentFilter, }: ChromaQueryVectorParams): Promise<QueryResult[]>;
     listIndexes(): Promise<string[]>;
     /**
@@ -77,16 +90,13 @@ declare class ChromaVector extends MastraVector {
      * @throws Will throw an error if no updates are provided or if the update operation fails.
      */
     updateVector({ indexName, 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({ indexName, id }: DeleteVectorParams): Promise<void>;
 }
 export { ChromaVector }
 export { ChromaVector as ChromaVector_alias_1 }
 
+export declare type ChromaVectorDocumentFilter = VectorFilter<keyof ChromaDocumentOperatorValueMap, ChromaDocumentOperatorValueMap, ChromaLogicalOperatorValueMap, ChromaDocumentBlacklisted>;
+
+export declare type ChromaVectorFilter = VectorFilter<keyof ChromaOperatorValueMap, ChromaOperatorValueMap, ChromaLogicalOperatorValueMap, ChromaBlacklisted>;
+
 export { }

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

@@ -1,11 +1,14 @@
 import { BaseFilterTranslator } from '@mastra/core/vector/filter';
+import type { BlacklistedRootOperators } 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 type { LogicalOperatorValueMap } from '@mastra/core/vector/filter';
 import { MastraVector } from '@mastra/core/vector';
 import type { OperatorSupport } from '@mastra/core/vector/filter';
+import type { OperatorValueMap } from '@mastra/core/vector/filter';
 import type { QueryResult } from '@mastra/core/vector';
 import type { QueryVectorParams } from '@mastra/core/vector';
 import type { UpdateVectorParams } from '@mastra/core/vector';
@@ -20,27 +23,37 @@ declare const CHROMA_PROMPT = "When querying Chroma, you can ONLY use the operat
 export { CHROMA_PROMPT }
 export { CHROMA_PROMPT as CHROMA_PROMPT_alias_1 }
 
+declare type ChromaBlacklisted = BlacklistedRootOperators | '$nor' | '$not';
+
+declare type ChromaDocumentBlacklisted = Exclude<ChromaBlacklisted, '$contains'>;
+
+declare type ChromaDocumentOperatorValueMap = ChromaOperatorValueMap;
+
 /**
  * Translator for Chroma filter queries.
  * Maintains MongoDB-compatible syntax while ensuring proper validation
  * and normalization of values.
  */
-export declare class ChromaFilterTranslator extends BaseFilterTranslator {
+export declare class ChromaFilterTranslator extends BaseFilterTranslator<ChromaVectorFilter> {
     protected getSupportedOperators(): OperatorSupport;
-    translate(filter?: VectorFilter): VectorFilter;
+    translate(filter?: ChromaVectorFilter): ChromaVectorFilter;
     private translateNode;
     private translateOperator;
 }
 
-declare interface ChromaQueryVectorParams extends QueryVectorParams {
-    documentFilter?: VectorFilter;
+declare type ChromaLogicalOperatorValueMap = Omit<LogicalOperatorValueMap, '$nor' | '$not'>;
+
+declare type ChromaOperatorValueMap = Omit<OperatorValueMap, '$exists' | '$elemMatch' | '$regex' | '$options'>;
+
+declare interface ChromaQueryVectorParams extends QueryVectorParams<ChromaVectorFilter> {
+    documentFilter?: ChromaVectorDocumentFilter;
 }
 
 declare interface ChromaUpsertVectorParams extends UpsertVectorParams {
     documents?: string[];
 }
 
-declare class ChromaVector extends MastraVector {
+declare class ChromaVector extends MastraVector<ChromaVectorFilter> {
     private client;
     private collections;
     constructor({ path, auth, }: {
@@ -55,7 +68,7 @@ declare class ChromaVector extends MastraVector {
     upsert({ indexName, vectors, metadata, ids, documents }: ChromaUpsertVectorParams): Promise<string[]>;
     private HnswSpaceMap;
     createIndex({ indexName, dimension, metric }: CreateIndexParams): Promise<void>;
-    transformFilter(filter?: VectorFilter): VectorFilter;
+    transformFilter(filter?: ChromaVectorFilter): ChromaVectorFilter;
     query({ indexName, queryVector, topK, filter, includeVector, documentFilter, }: ChromaQueryVectorParams): Promise<QueryResult[]>;
     listIndexes(): Promise<string[]>;
     /**
@@ -77,16 +90,13 @@ declare class ChromaVector extends MastraVector {
      * @throws Will throw an error if no updates are provided or if the update operation fails.
      */
     updateVector({ indexName, 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({ indexName, id }: DeleteVectorParams): Promise<void>;
 }
 export { ChromaVector }
 export { ChromaVector as ChromaVector_alias_1 }
 
+export declare type ChromaVectorDocumentFilter = VectorFilter<keyof ChromaDocumentOperatorValueMap, ChromaDocumentOperatorValueMap, ChromaLogicalOperatorValueMap, ChromaDocumentBlacklisted>;
+
+export declare type ChromaVectorFilter = VectorFilter<keyof ChromaOperatorValueMap, ChromaOperatorValueMap, ChromaLogicalOperatorValueMap, ChromaBlacklisted>;
+
 export { }

package/dist/index.cjs

@@ -1,5 +1,6 @@
 'use strict';
 
+var error = require('@mastra/core/error');
 var vector = require('@mastra/core/vector');
 var chromadb = require('chromadb');
 var filter = require('@mastra/core/vector/filter');
@@ -125,18 +126,31 @@ var ChromaVector = class extends vector.MastraVector {
     }
   }
   async upsert({ indexName, vectors, metadata, ids, documents }) {
-    const collection = await this.getCollection(indexName);
-    const stats = await this.describeIndex({ indexName });
-    this.validateVectorDimensions(vectors, stats.dimension);
-    const generatedIds = ids || vectors.map(() => crypto.randomUUID());
-    const normalizedMetadata = metadata || vectors.map(() => ({}));
-    await collection.upsert({
-      ids: generatedIds,
-      embeddings: vectors,
-      metadatas: normalizedMetadata,
-      documents
-    });
-    return generatedIds;
+    try {
+      const collection = await this.getCollection(indexName);
+      const stats = await this.describeIndex({ indexName });
+      this.validateVectorDimensions(vectors, stats.dimension);
+      const generatedIds = ids || vectors.map(() => crypto.randomUUID());
+      const normalizedMetadata = metadata || vectors.map(() => ({}));
+      await collection.upsert({
+        ids: generatedIds,
+        embeddings: vectors,
+        metadatas: normalizedMetadata,
+        documents
+      });
+      return generatedIds;
+    } catch (error$1) {
+      if (error$1 instanceof error.MastraError) throw error$1;
+      throw new error.MastraError(
+        {
+          id: "CHROMA_VECTOR_UPSERT_FAILED",
+          domain: error.ErrorDomain.MASTRA_VECTOR,
+          category: error.ErrorCategory.THIRD_PARTY,
+          details: { indexName }
+        },
+        error$1
+      );
+    }
   }
   HnswSpaceMap = {
     cosine: "cosine",
@@ -147,11 +161,23 @@ var ChromaVector = class extends vector.MastraVector {
   };
   async createIndex({ indexName, dimension, metric = "cosine" }) {
     if (!Number.isInteger(dimension) || dimension <= 0) {
-      throw new Error("Dimension must be a positive integer");
+      throw new error.MastraError({
+        id: "CHROMA_VECTOR_CREATE_INDEX_INVALID_DIMENSION",
+        text: "Dimension must be a positive integer",
+        domain: error.ErrorDomain.MASTRA_VECTOR,
+        category: error.ErrorCategory.USER,
+        details: { dimension }
+      });
     }
     const hnswSpace = this.HnswSpaceMap[metric];
-    if (!["cosine", "l2", "ip"].includes(hnswSpace)) {
-      throw new Error(`Invalid metric: "${metric}". Must be one of: cosine, euclidean, dotproduct`);
+    if (!hnswSpace || !["cosine", "l2", "ip"].includes(hnswSpace)) {
+      throw new error.MastraError({
+        id: "CHROMA_VECTOR_CREATE_INDEX_INVALID_METRIC",
+        text: `Invalid metric: "${metric}". Must be one of: cosine, euclidean, dotproduct`,
+        domain: error.ErrorDomain.MASTRA_VECTOR,
+        category: error.ErrorCategory.USER,
+        details: { metric }
+      });
     }
     try {
       await this.client.createCollection({
@@ -161,13 +187,21 @@ var ChromaVector = class extends vector.MastraVector {
           "hnsw:space": hnswSpace
         }
       });
-    } catch (error) {
-      const message = error?.message || error?.toString();
+    } catch (error$1) {
+      const message = error$1?.message || error$1?.toString();
       if (message && message.toLowerCase().includes("already exists")) {
         await this.validateExistingIndex(indexName, dimension, metric);
         return;
       }
-      throw error;
+      throw new error.MastraError(
+        {
+          id: "CHROMA_VECTOR_CREATE_INDEX_FAILED",
+          domain: error.ErrorDomain.MASTRA_VECTOR,
+          category: error.ErrorCategory.THIRD_PARTY,
+          details: { indexName }
+        },
+        error$1
+      );
     }
   }
   transformFilter(filter) {
@@ -182,27 +216,51 @@ var ChromaVector = class extends vector.MastraVector {
     includeVector = false,
     documentFilter
   }) {
-    const collection = await this.getCollection(indexName, true);
-    const defaultInclude = ["documents", "metadatas", "distances"];
-    const translatedFilter = this.transformFilter(filter);
-    const results = await collection.query({
-      queryEmbeddings: [queryVector],
-      nResults: topK,
-      where: translatedFilter,
-      whereDocument: documentFilter,
-      include: includeVector ? [...defaultInclude, "embeddings"] : defaultInclude
-    });
-    return (results.ids[0] || []).map((id, index) => ({
-      id,
-      score: results.distances?.[0]?.[index] || 0,
-      metadata: results.metadatas?.[0]?.[index] || {},
-      document: results.documents?.[0]?.[index],
-      ...includeVector && { vector: results.embeddings?.[0]?.[index] || [] }
-    }));
+    try {
+      const collection = await this.getCollection(indexName, true);
+      const defaultInclude = ["documents", "metadatas", "distances"];
+      const translatedFilter = this.transformFilter(filter);
+      const results = await collection.query({
+        queryEmbeddings: [queryVector],
+        nResults: topK,
+        where: translatedFilter,
+        whereDocument: documentFilter,
+        include: includeVector ? [...defaultInclude, "embeddings"] : defaultInclude
+      });
+      return (results.ids[0] || []).map((id, index) => ({
+        id,
+        score: results.distances?.[0]?.[index] || 0,
+        metadata: results.metadatas?.[0]?.[index] || {},
+        document: results.documents?.[0]?.[index],
+        ...includeVector && { vector: results.embeddings?.[0]?.[index] || [] }
+      }));
+    } catch (error$1) {
+      if (error$1 instanceof error.MastraError) throw error$1;
+      throw new error.MastraError(
+        {
+          id: "CHROMA_VECTOR_QUERY_FAILED",
+          domain: error.ErrorDomain.MASTRA_VECTOR,
+          category: error.ErrorCategory.THIRD_PARTY,
+          details: { indexName }
+        },
+        error$1
+      );
+    }
   }
   async listIndexes() {
-    const collections = await this.client.listCollections();
-    return collections.map((collection) => collection);
+    try {
+      const collections = await this.client.listCollections();
+      return collections.map((collection) => collection);
+    } catch (error$1) {
+      throw new error.MastraError(
+        {
+          id: "CHROMA_VECTOR_LIST_INDEXES_FAILED",
+          domain: error.ErrorDomain.MASTRA_VECTOR,
+          category: error.ErrorCategory.THIRD_PARTY
+        },
+        error$1
+      );
+    }
   }
   /**
    * Retrieves statistics about a vector index.
@@ -211,19 +269,44 @@ var ChromaVector = class extends vector.MastraVector {
    * @returns A promise that resolves to the index statistics including dimension, count and metric
    */
   async describeIndex({ indexName }) {
-    const collection = await this.getCollection(indexName);
-    const count = await collection.count();
-    const metadata = collection.metadata;
-    const hnswSpace = metadata?.["hnsw:space"];
-    return {
-      dimension: metadata?.dimension || 0,
-      count,
-      metric: this.HnswSpaceMap[hnswSpace]
-    };
+    try {
+      const collection = await this.getCollection(indexName);
+      const count = await collection.count();
+      const metadata = collection.metadata;
+      const hnswSpace = metadata?.["hnsw:space"];
+      return {
+        dimension: metadata?.dimension || 0,
+        count,
+        metric: this.HnswSpaceMap[hnswSpace]
+      };
+    } catch (error$1) {
+      if (error$1 instanceof error.MastraError) throw error$1;
+      throw new error.MastraError(
+        {
+          id: "CHROMA_VECTOR_DESCRIBE_INDEX_FAILED",
+          domain: error.ErrorDomain.MASTRA_VECTOR,
+          category: error.ErrorCategory.THIRD_PARTY,
+          details: { indexName }
+        },
+        error$1
+      );
+    }
   }
   async deleteIndex({ indexName }) {
-    await this.client.deleteCollection({ name: indexName });
-    this.collections.delete(indexName);
+    try {
+      await this.client.deleteCollection({ name: indexName });
+      this.collections.delete(indexName);
+    } catch (error$1) {
+      throw new error.MastraError(
+        {
+          id: "CHROMA_VECTOR_DELETE_INDEX_FAILED",
+          domain: error.ErrorDomain.MASTRA_VECTOR,
+          category: error.ErrorCategory.THIRD_PARTY,
+          details: { indexName }
+        },
+        error$1
+      );
+    }
   }
   /**
    * Updates a vector by its ID with the provided vector and/or metadata.
@@ -236,10 +319,16 @@ var ChromaVector = class extends vector.MastraVector {
    * @throws Will throw an error if no updates are provided or if the update operation fails.
    */
   async updateVector({ indexName, id, update }) {
+    if (!update.vector && !update.metadata) {
+      throw new error.MastraError({
+        id: "CHROMA_VECTOR_UPDATE_NO_PAYLOAD",
+        text: "No updates provided for vector",
+        domain: error.ErrorDomain.MASTRA_VECTOR,
+        category: error.ErrorCategory.USER,
+        details: { indexName, id }
+      });
+    }
     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) {
@@ -251,23 +340,34 @@ var ChromaVector = class extends vector.MastraVector {
         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}`);
+    } catch (error$1) {
+      if (error$1 instanceof error.MastraError) throw error$1;
+      throw new error.MastraError(
+        {
+          id: "CHROMA_VECTOR_UPDATE_FAILED",
+          domain: error.ErrorDomain.MASTRA_VECTOR,
+          category: error.ErrorCategory.THIRD_PARTY,
+          details: { indexName, id }
+        },
+        error$1
+      );
     }
   }
-  /**
-   * 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 vector by id: ${id} for index name: ${indexName}: ${error.message}`);
+    } catch (error$1) {
+      if (error$1 instanceof error.MastraError) throw error$1;
+      throw new error.MastraError(
+        {
+          id: "CHROMA_VECTOR_DELETE_FAILED",
+          domain: error.ErrorDomain.MASTRA_VECTOR,
+          category: error.ErrorCategory.THIRD_PARTY,
+          details: { indexName, id }
+        },
+        error$1
+      );
     }
   }
 };