@mastra/elasticsearch 1.0.0 → 1.1.0-alpha.0

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @mastra/elasticsearch
 
+## 1.1.0-alpha.0
+
+### Minor Changes
+
+- **Added** API key, basic, and bearer authentication options for Elasticsearch connections. ([#11298](https://github.com/mastra-ai/mastra/pull/11298))
+
+  **Changed** vector IDs now come from Elasticsearch `_id`; stored `id` fields are no longer written (breaking if you relied on `source.id`).
+
+  **Why** This aligns with Elasticsearch auth best practices and avoids duplicate IDs in stored documents.
+
+  **Before**
+
+  ```ts
+  const store = new ElasticSearchVector({ url, id: 'my-index' });
+  ```
+
+  **After**
+
+  ```ts
+  const store = new ElasticSearchVector({
+    url,
+    id: 'my-index',
+    auth: { apiKey: process.env.ELASTICSEARCH_API_KEY! },
+  });
+  ```
+
+### Patch Changes
+
+- Updated dependencies [[`e6fc281`](https://github.com/mastra-ai/mastra/commit/e6fc281896a3584e9e06465b356a44fe7faade65), [`97be6c8`](https://github.com/mastra-ai/mastra/commit/97be6c8963130fca8a664fcf99d7b3a38e463595), [`5fe1fe0`](https://github.com/mastra-ai/mastra/commit/5fe1fe0109faf2c87db34b725d8a4571a594f80e), [`f6673b8`](https://github.com/mastra-ai/mastra/commit/f6673b893b65b7d273ad25ead42e990704cc1e17), [`cd6be8a`](https://github.com/mastra-ai/mastra/commit/cd6be8ad32741cd41cabf508355bb31b71e8a5bd), [`9eb4e8e`](https://github.com/mastra-ai/mastra/commit/9eb4e8e39efbdcfff7a40ff2ce07ce2714c65fa8), [`aa37c84`](https://github.com/mastra-ai/mastra/commit/aa37c84d29b7db68c72517337932ef486c316275), [`47eba72`](https://github.com/mastra-ai/mastra/commit/47eba72f0397d0d14fbe324b97940c3d55e5a525)]:
+  - @mastra/core@1.2.0-alpha.0
+
 ## 1.0.0
 
 ### Minor Changes

package/README.md

@@ -23,6 +23,7 @@ import { ElasticSearchVector } from '@mastra/elasticsearch';
 const vectorDB = new ElasticSearchVector({
   url: 'http://localhost:9200',
   id: 'my-vector-store',
+  auth: { apiKey: 'insert-api-key' }
 });
 
 // Create a new vector index
@@ -77,6 +78,9 @@ The ElasticSearchVector store can be initialized with:
 
 - `url`: The ElasticSearch node URL (required)
 - `id`: A unique identifier for the vector store instance (required)
+- `auth` : The authentication mechanism (HTTP basic or API key)
+  - HTTP basic: { auth: { username : 'insert-username', password : 'insert-password' }}
+  - API key: { auth: { apiKey: 'insert-api-key' }}
 
 ## Features
 
@@ -102,7 +106,7 @@ The following filter operators are supported:
 
 - **Comparison**: `$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`
 - **Array**: `$in`, `$nin`, `$all`
-- **Logical**: `$and`, `$or`, `$not`
+- **Logical**: `$and`, `$or`, `$not`, `$nor`
 - **Element**: `$exists`
 - **Regex**: `$regex`
 

package/dist/docs/README.md

@@ -29,4 +29,4 @@ docs/
 ## Version
 
 Package: @mastra/elasticsearch
-Version: 1.0.0
+Version: 1.1.0-alpha.0

package/dist/docs/SKILL.md

@@ -5,7 +5,7 @@ description: Documentation for @mastra/elasticsearch. Includes links to type def
 
 # @mastra/elasticsearch Documentation
 
-> **Version**: 1.0.0
+> **Version**: 1.1.0-alpha.0
 > **Package**: @mastra/elasticsearch
 
 ## Quick Navigation

package/dist/docs/SOURCE_MAP.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.0",
+  "version": "1.1.0-alpha.0",
   "package": "@mastra/elasticsearch",
   "exports": {},
   "modules": {}

package/dist/docs/rag/01-vector-databases.md

@@ -262,7 +262,13 @@ await store.upsert({
 ```ts title="vector-store.ts"
 import { ElasticSearchVector } from "@mastra/elasticsearch";
 
-const store = new ElasticSearchVector({ id: 'elasticsearch-vector', url: process.env.ELASTICSEARCH_URL });
+const store = new ElasticSearchVector({
+  id: 'elasticsearch-vector',
+  url: process.env.ELASTICSEARCH_URL,
+  auth: {
+    apiKey : process.env.ELASTICSEARCH_API_KEY
+  }
+});
 
 await store.createIndex({
   indexName: "my-collection",
@@ -275,6 +281,9 @@ await store.upsert({
   metadata: chunks.map((chunk) => ({ text: chunk.text })),
 });
 ```
+<h3>Using Elasticsearch</h3>
+
+For detailed setup instructions and best practices, see the [official Elasticsearch documentation](https://www.elastic.co/docs/solutions/search/get-started).
 
   
   **couchbase:**
@@ -376,7 +385,7 @@ The dimension size must match the output dimension of your chosen embedding mode
 
 - OpenAI text-embedding-3-small: 1536 dimensions (or custom, e.g., 256)
 - Cohere embed-multilingual-v3: 1024 dimensions
-- Google text-embedding-004: 768 dimensions (or custom)
+- Google gemini-embedding-001: 768 dimensions (or custom)
 
 > **Note:**
 Index dimensions cannot be changed after creation. To use a different model, delete and recreate the index with the new dimension size.

package/dist/docs/vectors/01-reference.md

@@ -14,8 +14,8 @@ It's part of the `@mastra/elasticsearch` package.
 
 ## Installation
 
-```bash
-npm install @mastra/elasticsearch@beta
+```bash npm2yarn
+npm install @mastra/elasticsearch@latest
 ```
 
 ## Usage

package/dist/index.cjs

@@ -11,7 +11,7 @@ var ElasticSearchFilterTranslator = class extends filter.BaseFilterTranslator {
   getSupportedOperators() {
     return {
       ...filter.BaseFilterTranslator.DEFAULT_OPERATORS,
-      logical: ["$and", "$or", "$not"],
+      logical: ["$and", "$or", "$not", "$nor"],
       array: ["$in", "$nin", "$all"],
       regex: ["$regex"],
       custom: []
@@ -130,6 +130,7 @@ var ElasticSearchFilterTranslator = class extends filter.BaseFilterTranslator {
           }
         };
       case "$not":
+      case "$nor":
         return {
           bool: {
             must_not: conditions
@@ -252,9 +253,9 @@ var ElasticSearchFilterTranslator = class extends filter.BaseFilterTranslator {
       if (!hasEndAnchor) {
         wildcardPattern = wildcardPattern + "*";
       }
-      return { wildcard: { [field]: wildcardPattern } };
+      return { wildcard: { [field]: { value: wildcardPattern } } };
     }
-    return { regexp: { [field]: regexValue } };
+    return { regexp: { [field]: { value: regexValue } } };
   }
   addKeywordIfNeeded(field, value) {
     if (typeof value === "string") {
@@ -386,10 +387,11 @@ var ElasticSearchVector = class extends vector.MastraVector {
    * Creates a new ElasticSearchVector client.
    *
    * @param {string} url - The url of the ElasticSearch node.
+   * @param {ElasticSearchAuth} [auth] - The authentication credentials for ElasticSearch.
    */
-  constructor({ url, id }) {
+  constructor({ url, id, auth }) {
     super({ id });
-    this.client = new elasticsearch.Client({ node: url });
+    this.client = new elasticsearch.Client({ node: url, ...auth && { auth } });
   }
   /**
    * Creates a new collection with the specified configuration.
@@ -415,7 +417,6 @@ var ElasticSearchVector = class extends vector.MastraVector {
         mappings: {
           properties: {
             metadata: { type: "object" },
-            id: { type: "keyword" },
             embedding: {
               type: "dense_vector",
               dims: dimension,
@@ -536,12 +537,8 @@ var ElasticSearchVector = class extends vector.MastraVector {
    */
   async deleteIndex({ indexName }) {
     try {
-      await this.client.indices.delete({ index: indexName });
+      await this.client.indices.delete({ index: indexName }, { ignore: [404] });
     } catch (error$1) {
-      const isIndexNotFound = error$1?.statusCode === 404 || error$1?.body?.error?.type === "index_not_found_exception" || error$1?.meta?.statusCode === 404;
-      if (isIndexNotFound) {
-        return;
-      }
       const mastraError = new error.MastraError(
         {
           id: storage.createVectorErrorId("ELASTICSEARCH", "DELETE_INDEX", "FAILED"),
@@ -580,7 +577,6 @@ var ElasticSearchVector = class extends vector.MastraVector {
           }
         };
         const document = {
-          id: vectorIds[i],
           embedding: vectors[i],
           metadata: metadata[i] || {}
         };
@@ -674,6 +670,7 @@ var ElasticSearchVector = class extends vector.MastraVector {
     vector.validateTopK("ELASTICSEARCH", topK);
     try {
       const translatedFilter = this.transformFilter(filter);
+      const sourceFields = includeVector ? ["metadata", "embedding"] : ["metadata"];
       const response = await this.client.search({
         index: indexName,
         knn: {
@@ -683,12 +680,12 @@ var ElasticSearchVector = class extends vector.MastraVector {
           num_candidates: topK * 2,
           ...translatedFilter ? { filter: translatedFilter } : {}
         },
-        _source: ["id", "metadata", "embedding"]
+        _source: sourceFields
       });
       const results = response.hits.hits.map((hit) => {
         const source = hit._source || {};
         return {
-          id: String(source.id || ""),
+          id: String(hit._id),
           score: typeof hit._score === "number" ? hit._score : 0,
           metadata: source.metadata || {},
           ...includeVector && { vector: source.embedding }
@@ -790,7 +787,8 @@ var ElasticSearchVector = class extends vector.MastraVector {
     try {
       const result = await this.client.get({
         index: indexName,
-        id
+        id,
+        _source: ["embedding", "metadata"]
       }).catch(() => {
         throw new Error(`Document with ID ${id} not found in index ${indexName}`);
       });
@@ -813,9 +811,7 @@ var ElasticSearchVector = class extends vector.MastraVector {
       );
     }
     const source = existingDoc._source;
-    const updatedDoc = {
-      id: source?.id || id
-    };
+    const updatedDoc = {};
     try {
       if (update.vector) {
         const indexInfo = await this.describeIndex({ indexName });