@mastra/opensearch 0.0.0-cloud-transporter-20250513033346

package/CHANGELOG.md

@@ -0,0 +1,64 @@
+# @mastra/opensearch
+
+## 0.0.0-cloud-transporter-20250513033346
+
+### Patch Changes
+
+- c3bd795: [MASTRA-3358] Deprecate updateIndexById and deleteIndexById
+- Updated dependencies [396be50]
+- Updated dependencies [ab80e7e]
+- Updated dependencies [c3bd795]
+- Updated dependencies [da082f8]
+- Updated dependencies [a5810ce]
+- Updated dependencies [3171b5b]
+- Updated dependencies [973e5ac]
+- Updated dependencies [daf942f]
+- Updated dependencies [0b8b868]
+- Updated dependencies [9e1eff5]
+- Updated dependencies [6fa1ad1]
+- Updated dependencies [c28d7a0]
+- Updated dependencies [edf1e88]
+  - @mastra/core@0.0.0-cloud-transporter-20250513033346
+
+## 0.1.1-alpha.2
+
+### Patch Changes
+
+- Updated dependencies [3171b5b]
+- Updated dependencies [973e5ac]
+- Updated dependencies [9e1eff5]
+  - @mastra/core@0.9.4-alpha.2
+
+## 0.1.1-alpha.1
+
+### Patch Changes
+
+- Updated dependencies [ab80e7e]
+- Updated dependencies [6fa1ad1]
+- Updated dependencies [c28d7a0]
+- Updated dependencies [edf1e88]
+  - @mastra/core@0.9.4-alpha.1
+
+## 0.1.1-alpha.0
+
+### Patch Changes
+
+- Updated dependencies [daf942f]
+- Updated dependencies [0b8b868]
+  - @mastra/core@0.9.4-alpha.0
+
+## 0.1.0
+
+### Patch Changes
+
+- 4aeff69: feat: add OpenSearch vector storage support
+- Updated dependencies [e450778]
+- Updated dependencies [8902157]
+- Updated dependencies [ca0dc88]
+- Updated dependencies [526c570]
+- Updated dependencies [d7a6a33]
+- Updated dependencies [9cd1a46]
+- Updated dependencies [b5d2de0]
+- Updated dependencies [644f8ad]
+- Updated dependencies [70dbf51]
+  - @mastra/core@0.9.3

package/LICENSE.md

@@ -0,0 +1,46 @@
+# Elastic License 2.0 (ELv2)
+
+Copyright (c) 2025 Mastra AI, Inc.
+
+**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/opensearch
+
+Vector store implementation for OpenSearch using the official @opensearch-project/opensearch SDK
+
+## Installation
+
+```bash
+pnpm add @mastra/opensearch
+```
+
+## Usage
+
+```typescript
+import { OpenSearchVector } from '@mastra/opensearch';
+
+const vectorStore = new OpenSearchVector('http://localhost:9200');
+
+// Create an index
+await vectorStore.createIndex({ indexName: 'my-collection', dimension: 1536, metric: 'cosine' });
+
+// Add vectors with documents
+const vectors = [[0.1, 0.2, ...], [0.3, 0.4, ...]];
+const metadata = [{ text: 'doc1' }, { text: 'doc2' }];
+const ids = await vectorStore.upsert({ indexName: 'my-collection', vectors, metadata });
+
+// Query vectors with document filtering
+const results = await vectorStore.query({
+  indexName: 'my-collection',
+  queryVector: [0.1, 0.2, ...],
+  topK: 10, // topK
+  filter: { text: { $eq: 'doc1' } }, // metadata filter
+  includeVector: false, // includeVector
+});
+```
+
+## Configuration
+
+Required:
+
+- `url`: URL of your OpenSearch instance
+
+## Features
+
+- Vector similarity search with Cosine, Euclidean, and Dot Product metrics
+- Metadata filtering
+- Optional vector inclusion in query results
+- Automatic UUID generation for vectors
+- Built on top of @opensearch-project/opensearch SDK
+
+## Distance Metrics
+
+The following distance metrics are supported:
+
+- `cosine` → Cosine distance
+- `euclidean` → Euclidean distance
+- `dotproduct` → Dot product
+
+## 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
+
+- [OpenSearch Documentation](https://opensearch.org/docs/latest/about/)
+- [OpenSearch REST API Reference](https://opensearch.org/docs/latest/api-reference/)

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

@@ -0,0 +1,165 @@
+import { BaseFilterTranslator } from '@mastra/core/vector/filter';
+import type { CreateIndexParams } from '@mastra/core';
+import type { IndexStats } from '@mastra/core';
+import { MastraVector } from '@mastra/core/vector';
+import type { OperatorSupport } from '@mastra/core/vector/filter';
+import type { QueryResult } from '@mastra/core';
+import type { QueryVectorParams } from '@mastra/core';
+import type { UpsertVectorParams } from '@mastra/core';
+import type { VectorFilter } from '@mastra/core/vector/filter';
+
+/**
+ * Translator for OpenSearch filter queries.
+ * Maintains OpenSearch-compatible syntax while ensuring proper validation
+ * and normalization of values.
+ */
+export declare class OpenSearchFilterTranslator extends BaseFilterTranslator {
+    protected getSupportedOperators(): OperatorSupport;
+    translate(filter?: VectorFilter): VectorFilter;
+    private translateNode;
+    /**
+     * Handles translation of nested objects with dot notation fields
+     */
+    private translateNestedObject;
+    private translateLogicalOperator;
+    private translateFieldOperator;
+    /**
+     * Translates regex patterns to OpenSearch query syntax
+     */
+    private translateRegexOperator;
+    private addKeywordIfNeeded;
+    /**
+     * Helper method to handle special cases for the $not operator
+     */
+    private handleNotOperatorSpecialCases;
+    private translateOperator;
+    /**
+     * Translates field conditions to OpenSearch query syntax
+     * Handles special cases like range queries and multiple operators
+     */
+    private translateFieldConditions;
+    /**
+     * Checks if conditions can be optimized to a range query
+     */
+    private canOptimizeToRangeQuery;
+    /**
+     * Creates a range query from numeric operators
+     */
+    private createRangeQuery;
+}
+
+declare class OpenSearchVector extends MastraVector {
+    private client;
+    constructor(url: string);
+    /**
+     * 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(params: CreateIndexParams): Promise<void>;
+    /**
+     * Lists all indexes.
+     *
+     * @returns {Promise<string[]>} A promise that resolves to an array of indexes.
+     */
+    listIndexes(): Promise<string[]>;
+    describeIndex(indexName: string): Promise<IndexStats>;
+    /**
+     * Deletes the specified index.
+     *
+     * @param {string} indexName - The name of the index to delete.
+     * @returns {Promise<void>} A promise that resolves when the index is deleted.
+     */
+    deleteIndex(indexName: string): 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(params: UpsertVectorParams): Promise<string[]>;
+    /**
+     * 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 OpenSearch, see the filtering reference: https://opensearch.org/docs/latest/query-dsl/
+     * @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(params: QueryVectorParams): Promise<QueryResult[]>;
+    /**
+     * Validates the dimensions of the vectors.
+     *
+     * @param {number[][]} vectors - The vectors to validate.
+     * @param {number} dimension - The dimension of the vectors.
+     * @returns {void}
+     */
+    private validateVectorDimensions;
+    /**
+     * Transforms the filter to the OpenSearch DSL.
+     *
+     * @param {VectorFilter} filter - The filter to transform.
+     * @returns {Record<string, any>} The transformed filter.
+     */
+    private transformFilter;
+    /**
+     * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
+     *
+     * Updates a vector by its ID with the provided vector and/or metadata.
+     * @param indexName - The name of the index containing the vector.
+     * @param id - The ID of the vector to update.
+     * @param update - An object containing the vector and/or metadata to update.
+     * @param update.vector - An optional array of numbers representing the new vector.
+     * @param update.metadata - An optional record containing the new metadata.
+     * @returns A promise that resolves when the update is complete.
+     * @throws Will throw an error if no updates are provided or if the update operation fails.
+     */
+    updateIndexById(indexName: string, id: string, update: {
+        vector?: number[];
+        metadata?: Record<string, any>;
+    }): Promise<void>;
+    /**
+     * Updates a vector by its ID with the provided vector and/or metadata.
+     * @param indexName - The name of the index containing the vector.
+     * @param id - The ID of the vector to update.
+     * @param update - An object containing the vector and/or metadata to update.
+     * @param update.vector - An optional array of numbers representing the new vector.
+     * @param update.metadata - An optional record containing the new metadata.
+     * @returns A promise that resolves when the update is complete.
+     * @throws Will throw an error if no updates are provided or if the update operation fails.
+     */
+    updateVector(indexName: string, id: string, update: {
+        vector?: number[];
+        metadata?: Record<string, any>;
+    }): Promise<void>;
+    /**
+     * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
+     *
+     * 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.
+     */
+    deleteIndexById(indexName: string, id: string): 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: string, id: string): Promise<void>;
+}
+export { OpenSearchVector }
+export { OpenSearchVector as OpenSearchVector_alias_1 }
+
+export { }

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

@@ -0,0 +1,165 @@
+import { BaseFilterTranslator } from '@mastra/core/vector/filter';
+import type { CreateIndexParams } from '@mastra/core';
+import type { IndexStats } from '@mastra/core';
+import { MastraVector } from '@mastra/core/vector';
+import type { OperatorSupport } from '@mastra/core/vector/filter';
+import type { QueryResult } from '@mastra/core';
+import type { QueryVectorParams } from '@mastra/core';
+import type { UpsertVectorParams } from '@mastra/core';
+import type { VectorFilter } from '@mastra/core/vector/filter';
+
+/**
+ * Translator for OpenSearch filter queries.
+ * Maintains OpenSearch-compatible syntax while ensuring proper validation
+ * and normalization of values.
+ */
+export declare class OpenSearchFilterTranslator extends BaseFilterTranslator {
+    protected getSupportedOperators(): OperatorSupport;
+    translate(filter?: VectorFilter): VectorFilter;
+    private translateNode;
+    /**
+     * Handles translation of nested objects with dot notation fields
+     */
+    private translateNestedObject;
+    private translateLogicalOperator;
+    private translateFieldOperator;
+    /**
+     * Translates regex patterns to OpenSearch query syntax
+     */
+    private translateRegexOperator;
+    private addKeywordIfNeeded;
+    /**
+     * Helper method to handle special cases for the $not operator
+     */
+    private handleNotOperatorSpecialCases;
+    private translateOperator;
+    /**
+     * Translates field conditions to OpenSearch query syntax
+     * Handles special cases like range queries and multiple operators
+     */
+    private translateFieldConditions;
+    /**
+     * Checks if conditions can be optimized to a range query
+     */
+    private canOptimizeToRangeQuery;
+    /**
+     * Creates a range query from numeric operators
+     */
+    private createRangeQuery;
+}
+
+declare class OpenSearchVector extends MastraVector {
+    private client;
+    constructor(url: string);
+    /**
+     * 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(params: CreateIndexParams): Promise<void>;
+    /**
+     * Lists all indexes.
+     *
+     * @returns {Promise<string[]>} A promise that resolves to an array of indexes.
+     */
+    listIndexes(): Promise<string[]>;
+    describeIndex(indexName: string): Promise<IndexStats>;
+    /**
+     * Deletes the specified index.
+     *
+     * @param {string} indexName - The name of the index to delete.
+     * @returns {Promise<void>} A promise that resolves when the index is deleted.
+     */
+    deleteIndex(indexName: string): 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(params: UpsertVectorParams): Promise<string[]>;
+    /**
+     * 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 OpenSearch, see the filtering reference: https://opensearch.org/docs/latest/query-dsl/
+     * @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(params: QueryVectorParams): Promise<QueryResult[]>;
+    /**
+     * Validates the dimensions of the vectors.
+     *
+     * @param {number[][]} vectors - The vectors to validate.
+     * @param {number} dimension - The dimension of the vectors.
+     * @returns {void}
+     */
+    private validateVectorDimensions;
+    /**
+     * Transforms the filter to the OpenSearch DSL.
+     *
+     * @param {VectorFilter} filter - The filter to transform.
+     * @returns {Record<string, any>} The transformed filter.
+     */
+    private transformFilter;
+    /**
+     * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
+     *
+     * Updates a vector by its ID with the provided vector and/or metadata.
+     * @param indexName - The name of the index containing the vector.
+     * @param id - The ID of the vector to update.
+     * @param update - An object containing the vector and/or metadata to update.
+     * @param update.vector - An optional array of numbers representing the new vector.
+     * @param update.metadata - An optional record containing the new metadata.
+     * @returns A promise that resolves when the update is complete.
+     * @throws Will throw an error if no updates are provided or if the update operation fails.
+     */
+    updateIndexById(indexName: string, id: string, update: {
+        vector?: number[];
+        metadata?: Record<string, any>;
+    }): Promise<void>;
+    /**
+     * Updates a vector by its ID with the provided vector and/or metadata.
+     * @param indexName - The name of the index containing the vector.
+     * @param id - The ID of the vector to update.
+     * @param update - An object containing the vector and/or metadata to update.
+     * @param update.vector - An optional array of numbers representing the new vector.
+     * @param update.metadata - An optional record containing the new metadata.
+     * @returns A promise that resolves when the update is complete.
+     * @throws Will throw an error if no updates are provided or if the update operation fails.
+     */
+    updateVector(indexName: string, id: string, update: {
+        vector?: number[];
+        metadata?: Record<string, any>;
+    }): Promise<void>;
+    /**
+     * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
+     *
+     * 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.
+     */
+    deleteIndexById(indexName: string, id: string): 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: string, id: string): Promise<void>;
+}
+export { OpenSearchVector }
+export { OpenSearchVector as OpenSearchVector_alias_1 }
+
+export { }