@mastra/elasticsearch 1.1.2 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,65 @@
 # @mastra/elasticsearch
 
+## 1.2.0
+
+### Minor Changes
+
+- Added support for constructing `ElasticSearchVector` with a pre-configured Elasticsearch client. You can now pass either a `client` instance or connection parameters (`url` and optional `auth`), giving you full control over client configuration when needed. ([#12802](https://github.com/mastra-ai/mastra/pull/12802))
+
+  **Using connection parameters:**
+
+  ```typescript
+  const vectorDB = new ElasticSearchVector({
+    id: 'my-store',
+    url: 'http://localhost:9200',
+    auth: { apiKey: 'my-key' },
+  });
+  ```
+
+  **Using a pre-configured client:**
+
+  ```typescript
+  import { Client } from '@elastic/elasticsearch';
+
+  const client = new Client({ node: 'http://localhost:9200' });
+  const vectorDB = new ElasticSearchVector({ id: 'my-store', client });
+  ```
+
+### Patch Changes
+
+- Updated dependencies [[`51970b3`](https://github.com/mastra-ai/mastra/commit/51970b3828494d59a8dd4df143b194d37d31e3f5), [`4444280`](https://github.com/mastra-ai/mastra/commit/444428094253e916ec077e66284e685fde67021e), [`085e371`](https://github.com/mastra-ai/mastra/commit/085e3718a7d0fe9a210fe7dd1c867b9bdfe8d16b), [`b77aa19`](https://github.com/mastra-ai/mastra/commit/b77aa1981361c021f2c881bee8f0c703687f00da), [`dbb879a`](https://github.com/mastra-ai/mastra/commit/dbb879af0b809c668e9b3a9d8bac97d806caa267), [`8b4ce84`](https://github.com/mastra-ai/mastra/commit/8b4ce84aed0808b9805cc4fd7147c1f8a2ef7a36), [`8d4cfe6`](https://github.com/mastra-ai/mastra/commit/8d4cfe6b9a7157d3876206227ec9f04cde6dbc4a), [`dd6ca1c`](https://github.com/mastra-ai/mastra/commit/dd6ca1cdea3b8b6182f4cf61df41070ba0cc0deb), [`ce26fe2`](https://github.com/mastra-ai/mastra/commit/ce26fe2166dd90254f8bee5776e55977143e97de), [`68a019d`](https://github.com/mastra-ai/mastra/commit/68a019d30d22251ddd628a2947d60215c03c350a), [`4cb4edf`](https://github.com/mastra-ai/mastra/commit/4cb4edf3c909d197ec356c1790d13270514ffef6), [`8de3555`](https://github.com/mastra-ai/mastra/commit/8de355572c6fd838f863a3e7e6fe24d0947b774f), [`b26307f`](https://github.com/mastra-ai/mastra/commit/b26307f050df39629511b0e831b8fc26973ce8b1), [`68a019d`](https://github.com/mastra-ai/mastra/commit/68a019d30d22251ddd628a2947d60215c03c350a)]:
+  - @mastra/core@1.14.0
+
+## 1.2.0-alpha.0
+
+### Minor Changes
+
+- Added support for constructing `ElasticSearchVector` with a pre-configured Elasticsearch client. You can now pass either a `client` instance or connection parameters (`url` and optional `auth`), giving you full control over client configuration when needed. ([#12802](https://github.com/mastra-ai/mastra/pull/12802))
+
+  **Using connection parameters:**
+
+  ```typescript
+  const vectorDB = new ElasticSearchVector({
+    id: 'my-store',
+    url: 'http://localhost:9200',
+    auth: { apiKey: 'my-key' },
+  });
+  ```
+
+  **Using a pre-configured client:**
+
+  ```typescript
+  import { Client } from '@elastic/elasticsearch';
+
+  const client = new Client({ node: 'http://localhost:9200' });
+  const vectorDB = new ElasticSearchVector({ id: 'my-store', client });
+  ```
+
+### Patch Changes
+
+- Updated dependencies [[`51970b3`](https://github.com/mastra-ai/mastra/commit/51970b3828494d59a8dd4df143b194d37d31e3f5), [`085e371`](https://github.com/mastra-ai/mastra/commit/085e3718a7d0fe9a210fe7dd1c867b9bdfe8d16b), [`ce26fe2`](https://github.com/mastra-ai/mastra/commit/ce26fe2166dd90254f8bee5776e55977143e97de), [`b26307f`](https://github.com/mastra-ai/mastra/commit/b26307f050df39629511b0e831b8fc26973ce8b1)]:
+  - @mastra/core@1.13.3-alpha.0
+
 ## 1.1.2
 
 ### Patch Changes

package/README.md

@@ -74,13 +74,29 @@ await vectorDB.deleteVectors({
 
 ## Configuration
 
-The ElasticSearchVector store can be initialized with:
+The ElasticSearchVector store accepts either connection parameters or a pre-configured client:
 
+### Using connection parameters
+
+- `id`: A unique identifier for the vector store instance (required)
 - `url`: The ElasticSearch node URL (required)
+- `auth`: The authentication mechanism (optional)
+  - HTTP basic: `{ auth: { username: 'insert-username', password: 'insert-password' } }`
+  - API key: `{ auth: { apiKey: 'insert-api-key' } }`
+  - Bearer token: `{ auth: { bearer: 'insert-token' } }`
+
+### Using a pre-configured client
+
 - `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' }}
+- `client`: An existing `@elastic/elasticsearch` `Client` instance (required)
+
+```typescript
+import { Client } from '@elastic/elasticsearch';
+import { ElasticSearchVector } from '@mastra/elasticsearch';
+
+const client = new Client({ node: 'http://localhost:9200' });
+const vectorDB = new ElasticSearchVector({ id: 'my-vector-store', client });
+```
 
 ## Features
 

package/dist/docs/SKILL.md

@@ -3,7 +3,7 @@ name: mastra-elasticsearch
 description: Documentation for @mastra/elasticsearch. Use when working with @mastra/elasticsearch APIs, configuration, or implementation.
 metadata:
   package: "@mastra/elasticsearch"
-  version: "1.1.2"
+  version: "1.2.0"
 ---
 
 ## When to use
@@ -16,11 +16,11 @@ Read the individual reference documents for detailed explanations and code examp
 
 ### Docs
 
-- [Storing Embeddings in A Vector Database](references/docs-rag-vector-databases.md) - Guide on vector storage options in Mastra, including embedded and dedicated vector databases for similarity search.
+- [Storing embeddings in a vector database](references/docs-rag-vector-databases.md) - Guide on vector storage options in Mastra, including embedded and dedicated vector databases for similarity search.
 
 ### Reference
 
-- [Reference: ElasticSearch Vector Store](references/reference-vectors-elasticsearch.md) - Documentation for the ElasticSearchVector class in Mastra, which provides vector search using ElasticSearch.
+- [Reference: Elasticsearch vector store](references/reference-vectors-elasticsearch.md) - Documentation for the ElasticSearchVector class in Mastra, which provides vector search using Elasticsearch.
 
 
 Read [assets/SOURCE_MAP.json](assets/SOURCE_MAP.json) for source code references.

package/dist/docs/assets/SOURCE_MAP.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.1.2",
+  "version": "1.2.0",
   "package": "@mastra/elasticsearch",
   "exports": {},
   "modules": {}

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

@@ -1,8 +1,8 @@
-# Storing Embeddings in A Vector Database
+# Storing embeddings in a vector database
 
 After generating embeddings, you need to store them in a database that supports vector similarity search. Mastra provides a consistent interface for storing and querying embeddings across various vector databases.
 
-## Supported Databases
+## Supported databases
 
 **MongoDB**:
 
@@ -234,7 +234,7 @@ await store.upsert({
 })
 ```
 
-**ElasticSearch**:
+**Elasticsearch**:
 
 ```ts
 import { ElasticSearchVector } from '@mastra/elasticsearch'
@@ -337,7 +337,7 @@ await store.upsert({
 })
 ```
 
-## Using Vector Storage
+## Using vector storage
 
 Once initialized, all vector stores share the same interface for creating indexes, upserting embeddings, and querying.
 
@@ -355,11 +355,11 @@ await store.createIndex({
 
 The dimension size must match the output dimension of your chosen embedding model. Common dimension sizes are:
 
-- OpenAI text-embedding-3-small: 1536 dimensions (or custom, e.g., 256)
-- Cohere embed-multilingual-v3: 1024 dimensions
-- Google gemini-embedding-001: 768 dimensions (or custom)
+- `OpenAI text-embedding-3-small`: 1536 dimensions (or custom, e.g., 256)
+- `Cohere embed-multilingual-v3`: 1024 dimensions
+- `Google gemini-embedding-001`: 768 dimensions (or custom)
 
-> **Warning:** Index dimensions cannot be changed after creation. To use a different model, delete and recreate the index with the new dimension size.
+> **Warning:** Index dimensions can't be changed after creation. To use a different model, delete and recreate the index with the new dimension size.
 
 ### Naming Rules for Databases
 
@@ -490,7 +490,7 @@ Index names must:
 - Example: `My_Index` is not valid (contains uppercase letters)
 - Example: `_myindex` is not valid (begins with underscore)
 
-**ElasticSearch**:
+**Elasticsearch**:
 
 Index names must:
 
@@ -543,7 +543,7 @@ The upsert operation:
 - Creates new vectors if they don't exist
 - Automatically handles batching for large datasets
 
-## Adding Metadata
+## Adding metadata
 
 Vector stores support rich metadata (any JSON-serializable fields) for filtering and organization. Since metadata is stored with no fixed schema, use consistent field naming to avoid unexpected query results.
 
@@ -581,9 +581,9 @@ Key metadata considerations:
 - Only include fields you plan to filter or sort by - extra fields add overhead
 - Add timestamps (e.g., 'createdAt', 'lastUpdated') to track content freshness
 
-## Deleting Vectors
+## Deleting vectors
 
-When building RAG applications, you often need to clean up stale vectors when documents are deleted or updated. Mastra provides the `deleteVectors` method that supports deleting vectors by metadata filters, making it easy to remove all embeddings associated with a specific document.
+When building RAG applications, you often need to clean up stale vectors when documents are deleted or updated. Mastra provides the `deleteVectors` method that supports deleting vectors by metadata filters, making it straightforward to remove all embeddings associated with a specific document.
 
 ### Delete by Metadata Filter
 
@@ -637,7 +637,7 @@ await store.deleteVectors({
 })
 ```
 
-## Best Practices
+## Best practices
 
 - Create indexes before bulk insertions
 - Use batch operations for large insertions (the upsert method handles batching automatically)

package/dist/docs/references/reference-vectors-elasticsearch.md

@@ -1,6 +1,6 @@
-# ElasticSearch Vector Store
+# Elasticsearch vector store
 
-The ElasticSearchVector class provides vector search using [ElasticSearch](https://www.elastic.co/elasticsearch/) with its `dense_vector` field type and k-NN search capabilities. It's part of the `@mastra/elasticsearch` package.
+The `ElasticSearchVector` class provides vector search using [Elasticsearch](https://www.elastic.co/elasticsearch/) with its `dense_vector` field type and k-NN search capabilities. It's part of the `@mastra/elasticsearch` package.
 
 ## Installation
 
@@ -65,15 +65,15 @@ const results = await store.query({
 });
 ```
 
-## Constructor Options
+## Constructor options
 
 **id** (`string`): Unique identifier for this vector store instance
 
-**url** (`string`): ElasticSearch connection URL (e.g., 'http\://localhost:9200')
+**url** (`string`): Elasticsearch connection URL (e.g., 'http\://localhost:9200')
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 Creates a new index with the specified configuration.
 
@@ -83,7 +83,7 @@ Creates a new index with the specified configuration.
 
 **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
-### upsert()
+### `upsert()`
 
 Adds or updates vectors and their metadata in the index.
 
@@ -95,7 +95,7 @@ Adds or updates vectors and their metadata in the index.
 
 **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
-### query()
+### `query()`
 
 Searches for similar vectors with optional metadata filtering.
 
@@ -109,7 +109,7 @@ Searches for similar vectors with optional metadata filtering.
 
 **includeVector** (`boolean`): Whether to include vector data in results (Default: `false`)
 
-### describeIndex()
+### `describeIndex()`
 
 Gets information about an index.
 
@@ -125,19 +125,19 @@ interface IndexStats {
 }
 ```
 
-### deleteIndex()
+### `deleteIndex()`
 
 Deletes an index and all its data.
 
 **indexName** (`string`): Name of the index to delete
 
-### listIndexes()
+### `listIndexes()`
 
 Lists all vector indexes.
 
 Returns: `Promise<string[]>`
 
-### updateVector()
+### `updateVector()`
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
@@ -153,7 +153,7 @@ Update a single vector by ID or by metadata filter. Either `id` or `filter` must
 
 **update.metadata** (`Record<string, any>`): New metadata
 
-### deleteVector()
+### `deleteVector()`
 
 Deletes a single vector by its ID.
 
@@ -161,7 +161,7 @@ Deletes a single vector by its ID.
 
 **id** (`string`): ID of the vector to delete
 
-### deleteVectors()
+### `deleteVectors()`
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
@@ -171,7 +171,7 @@ Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` m
 
 **filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 

package/dist/index.cjs

@@ -10,7 +10,7 @@ var filter = require('@mastra/core/vector/filter');
 
 // package.json
 var package_default = {
-  version: "1.1.2"};
+  version: "1.2.0"};
 var ElasticSearchFilterTranslator = class extends filter.BaseFilterTranslator {
   getSupportedOperators() {
     return {
@@ -390,17 +390,29 @@ 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.
+   * Accepts either a pre-configured ElasticSearch client or connection parameters:
+   * - `{ id, client }` - Use an existing ElasticSearch client
+   * - `{ id, url, auth? }` - Create a new client from connection parameters
    */
-  constructor({ url, id, auth }) {
-    super({ id });
-    this.client = new elasticsearch.Client({
-      node: url,
-      ...auth && { auth },
-      name: "mastra-elasticsearch",
-      headers: { "user-agent": `mastra-es/${package_default.version}` }
-    });
+  constructor(config) {
+    super({ id: config.id });
+    if ("client" in config && config.client) {
+      this.client = config.client;
+    } else if ("url" in config && config.url) {
+      this.client = new elasticsearch.Client({
+        node: config.url,
+        ...config.auth && { auth: config.auth },
+        name: "mastra-elasticsearch",
+        headers: { "user-agent": `mastra-es/${package_default.version}` }
+      });
+    } else {
+      throw new error.MastraError({
+        id: "ELASTIC_SEARCH_CONSTRUCTOR_ERROR",
+        domain: error.ErrorDomain.STORAGE,
+        category: error.ErrorCategory.SYSTEM,
+        text: "Invalid config: provide either { client } or { url }."
+      });
+    }
   }
   /**
    * Creates a new collection with the specified configuration.