@mastra/chroma 0.1.0-alpha.28

package/CHANGELOG.md

@@ -0,0 +1,260 @@
+# @mastra/chroma
+
+## 0.1.0-alpha.28
+
+### Patch Changes
+
+- Updated dependencies [5285356]
+  - @mastra/core@0.2.0-alpha.93
+
+## 0.1.0-alpha.27
+
+### Minor Changes
+
+- 684d5d1: Move Chroma package from `@mastra/vector-chroma` to `@mastra/chroma`.
+
+  - Move package to `stores/chroma`
+  - Reorganize source files into `src/vector`
+  - Add deprecation notice to old package
+  - Update documentation and examples
+  - No breaking changes in functionality
+
+## 0.1.0-alpha.1
+
+### Major Changes
+
+- Package renamed from @mastra/vector-chroma to @mastra/chroma
+- Moved package to stores/ directory for better organization
+- All functionality remains the same
+
+### Migration
+
+To migrate from @mastra/vector-chroma:
+
+1. Remove @mastra/vector-chroma from dependencies
+2. Install @mastra/chroma
+3. Update imports from '@mastra/vector-chroma' to '@mastra/chroma'
+
+### Previous History
+
+This package was previously published as @mastra/vector-chroma. Key changes from that history:
+
+- Added Chroma Filter translator for improved query filtering
+- Updated operator validation and handling
+- Implemented new filtering for vectorQueryTool
+- Improved vector dimension validation
+- Added collection-based organization
+- Various dependency updates and bug fixes
+
+## 0.1.0-alpha.26
+
+### Patch Changes
+
+- Updated dependencies [4d4f6b6]
+  - @mastra/core@0.2.0-alpha.92
+
+## 0.1.0-alpha.25
+
+### Patch Changes
+
+- a10b7a3: Implemented new filtering for vectorQueryTool and updated docs
+- Updated dependencies [d7d465a]
+- Updated dependencies [d7d465a]
+- Updated dependencies [2017553]
+- Updated dependencies [a10b7a3]
+- Updated dependencies [16e5b04]
+  - @mastra/core@0.2.0-alpha.91
+
+## 0.1.0-alpha.24
+
+### Patch Changes
+
+- Updated dependencies [8151f44]
+- Updated dependencies [e897f1c]
+- Updated dependencies [3700be1]
+  - @mastra/core@0.2.0-alpha.90
+
+## 0.1.0-alpha.23
+
+### Patch Changes
+
+- Updated dependencies [27275c9]
+  - @mastra/core@0.2.0-alpha.89
+
+## 0.1.0-alpha.22
+
+### Patch Changes
+
+- ccbc581: Updated operator validation and handling for all vector stores
+- Updated dependencies [ccbc581]
+  - @mastra/core@0.2.0-alpha.88
+
+## 0.1.0-alpha.21
+
+### Patch Changes
+
+- Updated dependencies [7365b6c]
+  - @mastra/core@0.2.0-alpha.87
+
+## 0.1.0-alpha.20
+
+### Minor Changes
+
+- 5916f9d: Update deps from fixed to ^
+
+### Patch Changes
+
+- 7f24c29: Add Chroma Filter translator and updated vector store tests
+- Updated dependencies [6fa4bd2]
+- Updated dependencies [e2e76de]
+- Updated dependencies [7f24c29]
+- Updated dependencies [67637ba]
+- Updated dependencies [04f3171]
+  - @mastra/core@0.2.0-alpha.86
+
+## 0.0.1-alpha.19
+
+### Patch Changes
+
+- Updated dependencies [e9d1b47]
+  - @mastra/core@0.2.0-alpha.85
+
+## 0.0.1-alpha.18
+
+### Patch Changes
+
+- Updated dependencies [2f17a5f]
+- Updated dependencies [cb290ee]
+- Updated dependencies [b4d7416]
+- Updated dependencies [38b7f66]
+  - @mastra/core@0.2.0-alpha.84
+
+## 0.0.1-alpha.17
+
+### Patch Changes
+
+- 9625602: Use mastra core splitted bundles in other packages
+- Updated dependencies [30322ce]
+- Updated dependencies [78eec7c]
+- Updated dependencies [9625602]
+- Updated dependencies [8769a62]
+  - @mastra/core@0.2.0-alpha.83
+
+## 0.0.1-alpha.16
+
+### Patch Changes
+
+- Updated dependencies [73d112c]
+  - @mastra/core@0.1.27-alpha.82
+
+## 0.0.1-alpha.15
+
+### Patch Changes
+
+- Updated dependencies [9fb3039]
+  - @mastra/core@0.1.27-alpha.81
+
+## 0.0.1-alpha.14
+
+### Patch Changes
+
+- b422ed3: Bundle vector provider packages with tsup
+
+## 0.0.1-alpha.13
+
+### Patch Changes
+
+- Updated dependencies [327ece7]
+  - @mastra/core@0.1.27-alpha.80
+
+## 0.0.1-alpha.12
+
+### Patch Changes
+
+- Updated dependencies [21fe536]
+  - @mastra/core@0.1.27-alpha.79
+
+## 0.0.1-alpha.11
+
+### Patch Changes
+
+- Updated dependencies [685108a]
+- Updated dependencies [685108a]
+  - @mastra/core@0.1.27-alpha.78
+
+## 0.0.1-alpha.10
+
+### Patch Changes
+
+- Updated dependencies [8105fae]
+  - @mastra/core@0.1.27-alpha.77
+
+## 0.0.1-alpha.9
+
+### Patch Changes
+
+- 7a469e7: Bump vectors
+
+## 0.0.1-alpha.8
+
+### Patch Changes
+
+- Updated dependencies [ae7bf94]
+- Updated dependencies [ae7bf94]
+  - @mastra/core@0.1.27-alpha.76
+
+## 0.0.1-alpha.7
+
+### Patch Changes
+
+- Updated dependencies [23dcb23]
+  - @mastra/core@0.1.27-alpha.75
+
+## 0.0.1-alpha.6
+
+### Patch Changes
+
+- Updated dependencies [7b87567]
+  - @mastra/core@0.1.27-alpha.74
+
+## 0.0.1-alpha.5
+
+### Patch Changes
+
+- Updated dependencies [3427b95]
+  - @mastra/core@0.1.27-alpha.73
+
+## 0.0.1-alpha.4
+
+### Patch Changes
+
+- Updated dependencies [e4d4ede]
+- Updated dependencies [06b2c0a]
+  - @mastra/core@0.1.27-alpha.72
+
+## 0.0.1-alpha.3
+
+### Patch Changes
+
+- Updated dependencies [d9c8dd0]
+  - @mastra/core@0.1.27-alpha.71
+
+## 0.0.1-alpha.2
+
+### Patch Changes
+
+- bdaf834: publish packages
+
+## 0.0.1-alpha.1
+
+### Patch Changes
+
+- Updated dependencies [dd6d87f]
+- Updated dependencies [04434b6]
+  - @mastra/core@0.1.27-alpha.70
+
+## 0.0.1-alpha.0
+
+### Patch Changes
+
+- 0d5a03d: Vector store modules

package/LICENSE

@@ -0,0 +1,44 @@
+Elastic License 2.0 (ELv2)
+
+**Acceptance**
+By using the software, you agree to all of the terms and conditions below.
+
+**Copyright License**
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below
+
+**Limitations**
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+**Patents**
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+**Notices**
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+**No Other Rights**
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+**Termination**
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+**No Liability**
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+**Definitions**
+The _licensor_ is the entity offering these terms, and the _software_ is the software the licensor makes available under these terms, including any portion of it.
+
+_you_ refers to the individual or entity agreeing to these terms.
+
+_your company_ is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. _control_ means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+_your licenses_ are all the licenses granted to you for the software under these terms.
+
+_use_ means anything you do with the software requiring one of your licenses.
+
+_trademark_ means trademarks, service marks, and similar rights.

package/README.md

@@ -0,0 +1,86 @@
+# @mastra/chroma
+
+Vector store implementation for ChromaDB using the official chromadb client with added dimension validation and collection management.
+
+## Installation
+
+```bash
+npm install @mastra/chroma
+```
+
+## Usage
+
+```typescript
+import { ChromaVector } from '@mastra/chroma';
+
+const vectorStore = new ChromaVector({
+  path: 'http://localhost:8000',  // ChromaDB server URL
+  auth: {                         // Optional authentication
+    provider: 'token',
+    credentials: 'your-token'
+  }
+});
+
+// Create a new collection
+await vectorStore.createIndex('my-collection', 1536, 'cosine');
+
+// Add vectors
+const vectors = [[0.1, 0.2, ...], [0.3, 0.4, ...]];
+const metadata = [{ text: 'doc1' }, { text: 'doc2' }];
+const ids = await vectorStore.upsert('my-collection', vectors, metadata);
+
+// Query vectors
+const results = await vectorStore.query(
+  'my-collection',
+  [0.1, 0.2, ...],
+  10, // topK
+  { text: { $eq: 'doc1' } }, // optional filter
+  false // includeVector
+);
+```
+
+## Configuration
+
+Required:
+
+- `path`: URL of your ChromaDB server
+
+Optional:
+
+- `auth`: Authentication configuration
+  - `provider`: Authentication provider
+  - `credentials`: Authentication credentials
+
+## Features
+
+- Vector similarity search with cosine, euclidean, and dot product metrics
+- Strict vector dimension validation
+- Collection-based organization
+- Metadata filtering support
+- Optional vector inclusion in query results
+- Automatic UUID generation for vectors
+- Built-in collection caching for performance
+- Built on top of chromadb client
+
+## Methods
+
+- `createIndex(indexName, dimension, metric?)`: Create a new collection
+- `upsert(indexName, vectors, metadata?, ids?)`: Add or update vectors
+- `query(indexName, queryVector, topK?, filter?, includeVector?)`: Search for similar vectors
+- `listIndexes()`: List all collections
+- `describeIndex(indexName)`: Get collection statistics
+- `deleteIndex(indexName)`: Delete a collection
+
+## Query Response Format
+
+Query results include:
+
+- `id`: Vector ID
+- `score`: Distance/similarity score
+- `metadata`: Associated metadata
+- `vector`: Original vector (if includeVector is true)
+
+## Related Links
+
+- [ChromaDB Documentation](https://docs.trychroma.com/)
+- [ChromaDB API Reference](https://docs.trychroma.com/api/client)

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import { Filter } from '@mastra/core/filter';
+import { MastraVector, QueryResult, IndexStats } from '@mastra/core/vector';
+
+declare class ChromaVector extends MastraVector {
+    private client;
+    private collections;
+    constructor({ path, auth, }: {
+        path: string;
+        auth?: {
+            provider: string;
+            credentials: string;
+        };
+    });
+    private getCollection;
+    private validateVectorDimensions;
+    upsert(indexName: string, vectors: number[][], metadata?: Record<string, any>[], ids?: string[]): Promise<string[]>;
+    createIndex(indexName: string, dimension: number, metric?: 'cosine' | 'euclidean' | 'dotproduct'): Promise<void>;
+    transformFilter(filter?: Filter): Filter | undefined;
+    query(indexName: string, queryVector: number[], topK?: number, filter?: Filter, includeVector?: boolean): Promise<QueryResult[]>;
+    listIndexes(): Promise<string[]>;
+    describeIndex(indexName: string): Promise<IndexStats>;
+    deleteIndex(indexName: string): Promise<void>;
+}
+
+export { ChromaVector };

package/dist/index.js

@@ -0,0 +1,190 @@
+import { MastraVector } from '@mastra/core/vector';
+import { ChromaClient } from 'chromadb';
+import { BaseFilterTranslator } from '@mastra/core/filter';
+
+// src/vector/index.ts
+var ChromaFilterTranslator = class extends BaseFilterTranslator {
+  getSupportedOperators() {
+    return {
+      ...BaseFilterTranslator.DEFAULT_OPERATORS,
+      logical: ["$and", "$or"],
+      array: ["$in", "$nin"],
+      element: [],
+      regex: [],
+      custom: []
+    };
+  }
+  translate(filter) {
+    if (this.isEmpty(filter)) return filter;
+    this.validateFilter(filter);
+    return this.translateNode(filter);
+  }
+  translateNode(node, currentPath = "") {
+    if (this.isRegex(node)) {
+      throw new Error("Regex is not supported in Chroma");
+    }
+    if (this.isPrimitive(node)) return this.normalizeComparisonValue(node);
+    if (Array.isArray(node)) return { $in: this.normalizeArrayValues(node) };
+    const entries = Object.entries(node);
+    const firstEntry = entries[0];
+    if (entries.length === 1 && firstEntry && this.isOperator(firstEntry[0])) {
+      const [operator, value] = firstEntry;
+      const translated = this.translateOperator(operator, value);
+      return this.isLogicalOperator(operator) ? { [operator]: translated } : translated;
+    }
+    const result = {};
+    const multiOperatorConditions = [];
+    for (const [key, value] of entries) {
+      const newPath = currentPath ? `${currentPath}.${key}` : key;
+      if (this.isOperator(key)) {
+        result[key] = this.translateOperator(key, value);
+        continue;
+      }
+      if (typeof value === "object" && value !== null && !Array.isArray(value)) {
+        const valueEntries = Object.entries(value);
+        if (valueEntries.every(([op]) => this.isOperator(op)) && valueEntries.length > 1) {
+          valueEntries.forEach(([op, opValue]) => {
+            multiOperatorConditions.push({
+              [newPath]: { [op]: this.normalizeComparisonValue(opValue) }
+            });
+          });
+          continue;
+        }
+        if (Object.keys(value).length === 0) {
+          result[newPath] = this.translateNode(value);
+        } else {
+          const hasOperators = Object.keys(value).some((k) => this.isOperator(k));
+          if (hasOperators) {
+            const normalizedValue = {};
+            for (const [op, opValue] of Object.entries(value)) {
+              normalizedValue[op] = this.isOperator(op) ? this.translateOperator(op, opValue) : opValue;
+            }
+            result[newPath] = normalizedValue;
+          } else {
+            Object.assign(result, this.translateNode(value, newPath));
+          }
+        }
+      } else {
+        result[newPath] = this.translateNode(value);
+      }
+    }
+    if (multiOperatorConditions.length > 0) {
+      return { $and: multiOperatorConditions };
+    }
+    if (Object.keys(result).length > 1 && !currentPath) {
+      return {
+        $and: Object.entries(result).map(([key, value]) => ({ [key]: value }))
+      };
+    }
+    return result;
+  }
+  translateOperator(operator, value) {
+    if (this.isLogicalOperator(operator)) {
+      return Array.isArray(value) ? value.map((item) => this.translateNode(item)) : this.translateNode(value);
+    }
+    return this.normalizeComparisonValue(value);
+  }
+};
+
+// src/vector/index.ts
+var ChromaVector = class extends MastraVector {
+  constructor({
+    path,
+    auth
+  }) {
+    super();
+    this.client = new ChromaClient({
+      path,
+      auth
+    });
+    this.collections = /* @__PURE__ */ new Map();
+  }
+  async getCollection(indexName, throwIfNotExists = true) {
+    try {
+      const collection = await this.client.getCollection({ name: indexName, embeddingFunction: void 0 });
+      this.collections.set(indexName, collection);
+    } catch (error) {
+      if (throwIfNotExists) {
+        throw new Error(`Index ${indexName} does not exist`);
+      }
+      return null;
+    }
+    return this.collections.get(indexName);
+  }
+  validateVectorDimensions(vectors, dimension) {
+    for (let i = 0; i < vectors.length; i++) {
+      if (vectors?.[i]?.length !== dimension) {
+        throw new Error(
+          `Vector at index ${i} has invalid dimension ${vectors?.[i]?.length}. Expected ${dimension} dimensions.`
+        );
+      }
+    }
+  }
+  async upsert(indexName, vectors, metadata, ids) {
+    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
+    });
+    return generatedIds;
+  }
+  async createIndex(indexName, dimension, metric = "cosine") {
+    if (!Number.isInteger(dimension) || dimension <= 0) {
+      throw new Error("Dimension must be a positive integer");
+    }
+    await this.client.createCollection({
+      name: indexName,
+      metadata: {
+        dimension,
+        metric
+      }
+    });
+  }
+  transformFilter(filter) {
+    const chromaFilter = new ChromaFilterTranslator();
+    const translatedFilter = chromaFilter.translate(filter);
+    return translatedFilter;
+  }
+  async query(indexName, queryVector, topK = 10, filter, includeVector = false) {
+    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,
+      include: includeVector ? [...defaultInclude, "embeddings"] : defaultInclude
+    });
+    return (results.ids[0] || []).map((id, index) => ({
+      id,
+      score: results.distances?.[0]?.[index] || 0,
+      metadata: results.metadatas?.[0]?.[index] || {},
+      ...includeVector && { vector: results.embeddings?.[0]?.[index] || [] }
+    }));
+  }
+  async listIndexes() {
+    const collections = await this.client.listCollections();
+    return collections.map((collection) => collection);
+  }
+  async describeIndex(indexName) {
+    const collection = await this.getCollection(indexName);
+    const count = await collection.count();
+    const metadata = collection.metadata;
+    return {
+      dimension: metadata?.dimension || 0,
+      count,
+      metric: metadata?.metric
+    };
+  }
+  async deleteIndex(indexName) {
+    await this.client.deleteCollection({ name: indexName });
+    this.collections.delete(indexName);
+  }
+};
+
+export { ChromaVector };

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@mastra/chroma",
+  "version": "0.1.0-alpha.28",
+  "description": "Chroma vector store provider for Mastra",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "chromadb": "^1.9.4",
+    "@mastra/core": "^0.2.0-alpha.93"
+  },
+  "devDependencies": {
+    "@tsconfig/recommended": "^1.0.7",
+    "@types/node": "^22.9.0",
+    "tsup": "^8.0.1",
+    "vitest": "^3.0.4"
+  },
+  "scripts": {
+    "build": "tsup-node src/index.ts --format esm --dts --clean --treeshake",
+    "dev": "tsup-node src/index.ts --format esm --dts --clean --treeshake --watch",
+    "test": "vitest run"
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './vector/index';