@mastra/astra 0.1.0-alpha.28

package/CHANGELOG.md

@@ -0,0 +1,263 @@
+# @mastra/astra
+
+## 0.1.0-alpha.28
+
+### Patch Changes
+
+- Updated dependencies [5285356]
+  - @mastra/core@0.2.0-alpha.93
+
+## 0.1.0-alpha.27
+
+### Minor Changes
+
+- c87eb4e: Move Astra package from `@mastra/vector-astra` to `@mastra/astra`.
+
+  - Move package to `stores/astra`
+  - 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-astra to @mastra/astra
+- Moved package to stores/ directory for better organization
+- All functionality remains the same
+
+### Migration
+
+To migrate from @mastra/vector-astra:
+
+1. Remove @mastra/vector-astra from dependencies
+2. Install @mastra/astra
+3. Update imports from '@mastra/vector-astra' to '@mastra/astra'
+
+### Previous History
+
+This package was previously published as @mastra/vector-astra. Key changes from that history:
+
+- Implemented unified filter API for vector stores
+- Added support for cosine, euclidean, and dot product metrics
+- Added metadata filtering support
+- Added batch vector operations
+- Improved collection management
+- Updated operator validation and handling
+- 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
+
+- 34048bb: Hook up Astra filter and added tests
+- 78eec7c: Started implementation on Unified Filter API for several vector stores.
+- 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,70 @@
+# @mastra/astra
+
+Vector store implementation for DataStax Astra DB, providing vector similarity search capabilities using Cassandra's vector search functionality.
+
+## Installation
+
+```bash
+npm install @mastra/astra
+```
+
+## Usage
+
+```typescript
+import { AstraVector } from '@mastra/astra';
+
+const vectorStore = new AstraVector({
+  token: 'your-astra-token',
+  endpoint: 'your-astra-endpoint',
+  keyspace: 'your-keyspace' // optional
+});
+
+// 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 // includeVectors
+);
+```
+
+## Configuration
+
+The Astra DB vector store requires:
+
+- `token`: Your Astra DB token
+- `endpoint`: Your Astra DB endpoint
+- `keyspace`: (Optional) The keyspace to use
+
+## Features
+
+- Vector similarity search with cosine, euclidean, and dot product metrics
+- Metadata filtering support
+- Batch vector upsert operations
+- Collection management (create, list, describe, delete)
+- Optional vector inclusion in query results
+- Automatic UUID generation for vectors
+- Built on top of @datastax/astra-db-ts 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
+
+## Related Links
+
+- [Astra DB Vector Search Documentation](https://docs.datastax.com/en/astra-db/docs/vector-search.html)
+- [Astra DB API Reference](https://docs.datastax.com/en/astra-db-serverless/api-reference/documents.html)

package/dist/index.d.ts

@@ -0,0 +1,59 @@
+import { Filter } from '@mastra/core/filter';
+import { MastraVector, QueryResult, IndexStats } from '@mastra/core/vector';
+
+interface AstraDbOptions {
+    token: string;
+    endpoint: string;
+    keyspace?: string;
+}
+declare class AstraVector extends MastraVector {
+    #private;
+    constructor({ token, endpoint, keyspace }: AstraDbOptions);
+    /**
+     * Creates a new collection with the specified configuration.
+     *
+     * @param {string} indexName - The name of the collection to create.
+     * @param {number} dimension - The dimension of the vectors to be stored in the collection.
+     * @param {'cosine' | 'euclidean' | 'dotproduct'} [metric=cosine] - The metric to use to sort vectors in the collection.
+     * @returns {Promise<void>} A promise that resolves when the collection is created.
+     */
+    createIndex(indexName: string, dimension: number, metric?: 'cosine' | 'euclidean' | 'dotproduct'): Promise<void>;
+    /**
+     * Inserts or updates vectors in the specified collection.
+     *
+     * @param {string} indexName - The name of the collection to upsert into.
+     * @param {number[][]} vectors - An array of vectors to upsert.
+     * @param {Record<string, any>[]} [metadata] - An optional array of metadata objects corresponding to each vector.
+     * @param {string[]} [ids] - An optional array of IDs corresponding to each vector. If not provided, new IDs will be generated.
+     * @returns {Promise<string[]>} A promise that resolves to an array of IDs of the upserted vectors.
+     */
+    upsert(indexName: string, vectors: number[][], metadata?: Record<string, any>[], ids?: string[]): Promise<string[]>;
+    transformFilter(filter?: Filter): Filter;
+    /**
+     * Queries the specified collection using a vector and optional filter.
+     *
+     * @param {string} indexName - The name of the collection to query.
+     * @param {number[]} queryVector - The vector to query with.
+     * @param {number} [topK] - The maximum number of results to return.
+     * @param {Record<string, any>} [filter] - An optional filter to apply to the query. For more on filters in Astra DB, see the filtering reference: https://docs.datastax.com/en/astra-db-serverless/api-reference/documents.html#operators
+     * @param {boolean} [includeVectors=false] - Whether to include the vectors in the response.
+     * @returns {Promise<QueryResult[]>} A promise that resolves to an array of query results.
+     */
+    query(indexName: string, queryVector: number[], topK?: number, filter?: Filter, includeVector?: boolean): Promise<QueryResult[]>;
+    /**
+     * Lists all collections in the database.
+     *
+     * @returns {Promise<string[]>} A promise that resolves to an array of collection names.
+     */
+    listIndexes(): Promise<string[]>;
+    describeIndex(indexName: string): Promise<IndexStats>;
+    /**
+     * Deletes the specified collection.
+     *
+     * @param {string} indexName - The name of the collection to delete.
+     * @returns {Promise<void>} A promise that resolves when the collection is deleted.
+     */
+    deleteIndex(indexName: string): Promise<void>;
+}
+
+export { type AstraDbOptions, AstraVector };

package/dist/index.js

@@ -0,0 +1,177 @@
+import { DataAPIClient, UUID } from '@datastax/astra-db-ts';
+import { MastraVector } from '@mastra/core/vector';
+import { BaseFilterTranslator } from '@mastra/core/filter';
+
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), member.set(obj, value), value);
+var AstraFilterTranslator = class extends BaseFilterTranslator {
+  getSupportedOperators() {
+    return {
+      ...BaseFilterTranslator.DEFAULT_OPERATORS,
+      array: ["$all", "$in", "$nin"],
+      logical: ["$and", "$or", "$not"],
+      regex: [],
+      custom: ["$size"]
+    };
+  }
+  translate(filter) {
+    if (this.isEmpty(filter)) return filter;
+    this.validateFilter(filter);
+    return this.translateNode(filter);
+  }
+  translateNode(node) {
+    if (this.isRegex(node)) {
+      throw new Error("Regex is not supported in Astra DB");
+    }
+    if (this.isPrimitive(node) || Array.isArray(node)) {
+      return node;
+    }
+    const entries = Object.entries(node);
+    const translatedEntries = entries.map(([key, value]) => {
+      if (this.isOperator(key)) {
+        return [key, this.translateOperatorValue(key, value)];
+      }
+      return [key, this.translateNode(value)];
+    });
+    return Object.fromEntries(translatedEntries);
+  }
+  translateOperatorValue(operator, value) {
+    if (this.isBasicOperator(operator) || this.isNumericOperator(operator)) {
+      return this.normalizeComparisonValue(value);
+    }
+    if (this.isArrayOperator(operator) && Array.isArray(value)) {
+      return this.normalizeArrayValues(value);
+    }
+    return this.translateNode(value);
+  }
+};
+
+// src/vector/index.ts
+var metricMap = {
+  cosine: "cosine",
+  euclidean: "euclidean",
+  dotproduct: "dot_product"
+};
+var _db;
+var AstraVector = class extends MastraVector {
+  constructor({ token, endpoint, keyspace }) {
+    super();
+    __privateAdd(this, _db);
+    const client = new DataAPIClient(token);
+    __privateSet(this, _db, client.db(endpoint, { keyspace }));
+  }
+  /**
+   * Creates a new collection with the specified configuration.
+   *
+   * @param {string} indexName - The name of the collection to create.
+   * @param {number} dimension - The dimension of the vectors to be stored in the collection.
+   * @param {'cosine' | 'euclidean' | 'dotproduct'} [metric=cosine] - The metric to use to sort vectors in the collection.
+   * @returns {Promise<void>} A promise that resolves when the collection is created.
+   */
+  async createIndex(indexName, dimension, metric = "cosine") {
+    if (!Number.isInteger(dimension) || dimension <= 0) {
+      throw new Error("Dimension must be a positive integer");
+    }
+    await __privateGet(this, _db).createCollection(indexName, {
+      vector: {
+        dimension,
+        metric: metricMap[metric]
+      },
+      checkExists: false
+    });
+  }
+  /**
+   * Inserts or updates vectors in the specified collection.
+   *
+   * @param {string} indexName - The name of the collection to upsert into.
+   * @param {number[][]} vectors - An array of vectors to upsert.
+   * @param {Record<string, any>[]} [metadata] - An optional array of metadata objects corresponding to each vector.
+   * @param {string[]} [ids] - An optional array of IDs corresponding to each vector. If not provided, new IDs will be generated.
+   * @returns {Promise<string[]>} A promise that resolves to an array of IDs of the upserted vectors.
+   */
+  async upsert(indexName, vectors, metadata, ids) {
+    const collection = __privateGet(this, _db).collection(indexName);
+    const vectorIds = ids || vectors.map(() => UUID.v7().toString());
+    const records = vectors.map((vector, i) => ({
+      id: vectorIds[i],
+      $vector: vector,
+      metadata: metadata?.[i] || {}
+    }));
+    const result = await collection.insertMany(records);
+    return result.insertedIds.map((id) => (id || "").toString());
+  }
+  transformFilter(filter) {
+    const astraFilter = new AstraFilterTranslator();
+    const translatedFilter = astraFilter.translate(filter ?? {});
+    return translatedFilter;
+  }
+  /**
+   * Queries the specified collection using a vector and optional filter.
+   *
+   * @param {string} indexName - The name of the collection to query.
+   * @param {number[]} queryVector - The vector to query with.
+   * @param {number} [topK] - The maximum number of results to return.
+   * @param {Record<string, any>} [filter] - An optional filter to apply to the query. For more on filters in Astra DB, see the filtering reference: https://docs.datastax.com/en/astra-db-serverless/api-reference/documents.html#operators
+   * @param {boolean} [includeVectors=false] - Whether to include the vectors in the response.
+   * @returns {Promise<QueryResult[]>} A promise that resolves to an array of query results.
+   */
+  async query(indexName, queryVector, topK, filter, includeVector = false) {
+    const collection = __privateGet(this, _db).collection(indexName);
+    const translatedFilter = this.transformFilter(filter);
+    const cursor = collection.find(translatedFilter ?? {}, {
+      sort: { $vector: queryVector },
+      limit: topK,
+      includeSimilarity: true,
+      projection: {
+        $vector: includeVector ? true : false
+      }
+    });
+    const results = await cursor.toArray();
+    return results.map((result) => ({
+      id: result.id,
+      score: result.$similarity,
+      metadata: result.metadata,
+      ...includeVector && { vector: result.$vector }
+    }));
+  }
+  /**
+   * Lists all collections in the database.
+   *
+   * @returns {Promise<string[]>} A promise that resolves to an array of collection names.
+   */
+  listIndexes() {
+    return __privateGet(this, _db).listCollections({ nameOnly: true });
+  }
+  async describeIndex(indexName) {
+    const collection = __privateGet(this, _db).collection(indexName);
+    const optionsPromise = collection.options();
+    const countPromise = collection.countDocuments({}, 100);
+    const [options, count] = await Promise.all([optionsPromise, countPromise]);
+    console.log(options, count);
+    const keys = Object.keys(metricMap);
+    const metric = keys.find((key) => metricMap[key] === options.vector?.metric);
+    return {
+      dimension: options.vector?.dimension,
+      metric,
+      count
+    };
+  }
+  /**
+   * Deletes the specified collection.
+   *
+   * @param {string} indexName - The name of the collection to delete.
+   * @returns {Promise<void>} A promise that resolves when the collection is deleted.
+   */
+  async deleteIndex(indexName) {
+    const collection = __privateGet(this, _db).collection(indexName);
+    await collection.drop();
+  }
+};
+_db = new WeakMap();
+
+export { AstraVector };

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@mastra/astra",
+  "version": "0.1.0-alpha.28",
+  "description": "Astra DB provider for Mastra - includes vector store capabilities",
+  "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": {
+    "@datastax/astra-db-ts": "^1.5.0",
+    "@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';