@mastra/opensearch 0.1.1 → 0.2.0-alpha.1

package/.turbo/turbo-build.log

@@ -1,23 +1,23 @@
 
-> @mastra/opensearch@0.1.1-alpha.4 build /home/runner/work/mastra/mastra/stores/opensearch
+> @mastra/opensearch@0.2.0-alpha.1 build /home/runner/work/mastra/mastra/stores/opensearch
 > tsup src/index.ts --format esm,cjs --experimental-dts --clean --treeshake=smallest --splitting
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
 CLI tsup v8.4.0
 TSC Build start
-TSC ⚡️ Build success in 11037ms
+TSC ⚡️ Build success in 10415ms
 DTS Build start
 CLI Target: es2022
 Analysis will use the bundled TypeScript version 5.8.3
 Writing package typings: /home/runner/work/mastra/mastra/stores/opensearch/dist/_tsup-dts-rollup.d.ts
 Analysis will use the bundled TypeScript version 5.8.3
 Writing package typings: /home/runner/work/mastra/mastra/stores/opensearch/dist/_tsup-dts-rollup.d.cts
-DTS ⚡️ Build success in 9888ms
+DTS ⚡️ Build success in 11166ms
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-ESM dist/index.js 23.06 KB
-ESM ⚡️ Build success in 932ms
-CJS dist/index.cjs 23.10 KB
-CJS ⚡️ Build success in 941ms
+ESM dist/index.js 21.72 KB
+ESM ⚡️ Build success in 764ms
+CJS dist/index.cjs 21.76 KB
+CJS ⚡️ Build success in 763ms

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # @mastra/opensearch
 
+## 0.2.0-alpha.1
+
+### Minor Changes
+
+- 83da932: Move @mastra/core to peerdeps
+
+### Patch Changes
+
+- a7292b0: BREAKING(@mastra/core, all vector stores): Vector store breaking changes (remove deprecated functions and positional arguments)
+- Updated dependencies [b3a3d63]
+- Updated dependencies [344f453]
+- Updated dependencies [0a3ae6d]
+- Updated dependencies [95911be]
+- Updated dependencies [5eb5a99]
+- Updated dependencies [7e632c5]
+- Updated dependencies [1e9fbfa]
+- Updated dependencies [b2ae5aa]
+- Updated dependencies [a7292b0]
+- Updated dependencies [0dcb9f0]
+  - @mastra/core@0.10.0-alpha.1
+
+## 0.1.2-alpha.0
+
+### Patch Changes
+
+- d0ee3c6: Change all public functions and constructors in vector stores to use named args and prepare to phase out positional args
+- Updated dependencies [f53a6ac]
+- Updated dependencies [eabdcd9]
+- Updated dependencies [90be034]
+- Updated dependencies [99f050a]
+- Updated dependencies [d0ee3c6]
+- Updated dependencies [23f258c]
+- Updated dependencies [2672a05]
+  - @mastra/core@0.9.5-alpha.0
+
 ## 0.1.1
 
 ### Patch Changes

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

@@ -1,10 +1,14 @@
 import { BaseFilterTranslator } from '@mastra/core/vector/filter';
 import type { CreateIndexParams } from '@mastra/core';
+import type { DeleteIndexParams } from '@mastra/core';
+import type { DeleteVectorParams } from '@mastra/core';
+import type { DescribeIndexParams } 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 { UpdateVectorParams } from '@mastra/core';
 import type { UpsertVectorParams } from '@mastra/core';
 import type { VectorFilter } from '@mastra/core/vector/filter';
 
@@ -50,7 +54,14 @@ export declare class OpenSearchFilterTranslator extends BaseFilterTranslator {
 
 declare class OpenSearchVector extends MastraVector {
     private client;
-    constructor(url: string);
+    /**
+     * Creates a new OpenSearchVector client.
+     *
+     * @param {string} url - The url of the OpenSearch node.
+     */
+    constructor({ url }: {
+        url: string;
+    });
     /**
      * Creates a new collection with the specified configuration.
      *
@@ -59,21 +70,27 @@ declare class OpenSearchVector extends MastraVector {
      * @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>;
+    createIndex({ indexName, dimension, metric }: 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>;
+    /**
+     * Retrieves statistics about a vector index.
+     *
+     * @param {string} indexName - The name of the index to describe
+     * @returns A promise that resolves to the index statistics including dimension, count and metric
+     */
+    describeIndex({ indexName }: DescribeIndexParams): 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>;
+    deleteIndex({ indexName }: DeleteIndexParams): Promise<void>;
     /**
      * Inserts or updates vectors in the specified collection.
      *
@@ -83,7 +100,7 @@ declare class OpenSearchVector extends MastraVector {
      * @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[]>;
+    upsert({ indexName, vectors, metadata, ids }: UpsertVectorParams): Promise<string[]>;
     /**
      * Queries the specified collection using a vector and optional filter.
      *
@@ -94,7 +111,7 @@ declare class OpenSearchVector extends MastraVector {
      * @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[]>;
+    query({ indexName, queryVector, filter, topK, includeVector, }: QueryVectorParams): Promise<QueryResult[]>;
     /**
      * Validates the dimensions of the vectors.
      *
@@ -111,8 +128,6 @@ declare class OpenSearchVector extends MastraVector {
      */
     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.
@@ -122,34 +137,7 @@ declare class OpenSearchVector extends MastraVector {
      * @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>;
+    updateVector({ indexName, id, update }: UpdateVectorParams): Promise<void>;
     /**
      * Deletes a vector by its ID.
      * @param indexName - The name of the index containing the vector.
@@ -157,7 +145,7 @@ declare class OpenSearchVector extends MastraVector {
      * @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>;
+    deleteVector({ indexName, id }: DeleteVectorParams): Promise<void>;
 }
 export { OpenSearchVector }
 export { OpenSearchVector as OpenSearchVector_alias_1 }

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

@@ -1,10 +1,14 @@
 import { BaseFilterTranslator } from '@mastra/core/vector/filter';
 import type { CreateIndexParams } from '@mastra/core';
+import type { DeleteIndexParams } from '@mastra/core';
+import type { DeleteVectorParams } from '@mastra/core';
+import type { DescribeIndexParams } 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 { UpdateVectorParams } from '@mastra/core';
 import type { UpsertVectorParams } from '@mastra/core';
 import type { VectorFilter } from '@mastra/core/vector/filter';
 
@@ -50,7 +54,14 @@ export declare class OpenSearchFilterTranslator extends BaseFilterTranslator {
 
 declare class OpenSearchVector extends MastraVector {
     private client;
-    constructor(url: string);
+    /**
+     * Creates a new OpenSearchVector client.
+     *
+     * @param {string} url - The url of the OpenSearch node.
+     */
+    constructor({ url }: {
+        url: string;
+    });
     /**
      * Creates a new collection with the specified configuration.
      *
@@ -59,21 +70,27 @@ declare class OpenSearchVector extends MastraVector {
      * @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>;
+    createIndex({ indexName, dimension, metric }: 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>;
+    /**
+     * Retrieves statistics about a vector index.
+     *
+     * @param {string} indexName - The name of the index to describe
+     * @returns A promise that resolves to the index statistics including dimension, count and metric
+     */
+    describeIndex({ indexName }: DescribeIndexParams): 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>;
+    deleteIndex({ indexName }: DeleteIndexParams): Promise<void>;
     /**
      * Inserts or updates vectors in the specified collection.
      *
@@ -83,7 +100,7 @@ declare class OpenSearchVector extends MastraVector {
      * @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[]>;
+    upsert({ indexName, vectors, metadata, ids }: UpsertVectorParams): Promise<string[]>;
     /**
      * Queries the specified collection using a vector and optional filter.
      *
@@ -94,7 +111,7 @@ declare class OpenSearchVector extends MastraVector {
      * @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[]>;
+    query({ indexName, queryVector, filter, topK, includeVector, }: QueryVectorParams): Promise<QueryResult[]>;
     /**
      * Validates the dimensions of the vectors.
      *
@@ -111,8 +128,6 @@ declare class OpenSearchVector extends MastraVector {
      */
     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.
@@ -122,34 +137,7 @@ declare class OpenSearchVector extends MastraVector {
      * @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>;
+    updateVector({ indexName, id, update }: UpdateVectorParams): Promise<void>;
     /**
      * Deletes a vector by its ID.
      * @param indexName - The name of the index containing the vector.
@@ -157,7 +145,7 @@ declare class OpenSearchVector extends MastraVector {
      * @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>;
+    deleteVector({ indexName, id }: DeleteVectorParams): Promise<void>;
 }
 export { OpenSearchVector }
 export { OpenSearchVector as OpenSearchVector_alias_1 }

package/dist/index.cjs

@@ -364,7 +364,12 @@ var REVERSE_METRIC_MAPPING = {
 };
 var OpenSearchVector = class extends vector.MastraVector {
   client;
-  constructor(url) {
+  /**
+   * Creates a new OpenSearchVector client.
+   *
+   * @param {string} url - The url of the OpenSearch node.
+   */
+  constructor({ url }) {
     super();
     this.client = new opensearch.Client({ node: url });
   }
@@ -376,8 +381,7 @@ var OpenSearchVector = class extends vector.MastraVector {
    * @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(params) {
-    const { indexName, dimension, metric = "cosine" } = params;
+  async createIndex({ indexName, dimension, metric = "cosine" }) {
     if (!Number.isInteger(dimension) || dimension <= 0) {
       throw new Error("Dimension must be a positive integer");
     }
@@ -429,7 +433,13 @@ var OpenSearchVector = class extends vector.MastraVector {
       throw new Error(`Failed to list indexes: ${error.message}`);
     }
   }
-  async describeIndex(indexName) {
+  /**
+   * Retrieves statistics about a vector index.
+   *
+   * @param {string} indexName - The name of the index to describe
+   * @returns A promise that resolves to the index statistics including dimension, count and metric
+   */
+  async describeIndex({ indexName }) {
     const { body: indexInfo } = await this.client.indices.get({ index: indexName });
     const mappings = indexInfo[indexName]?.mappings;
     const embedding = mappings?.properties?.embedding;
@@ -447,7 +457,7 @@ var OpenSearchVector = class extends vector.MastraVector {
    * @param {string} indexName - The name of the index to delete.
    * @returns {Promise<void>} A promise that resolves when the index is deleted.
    */
-  async deleteIndex(indexName) {
+  async deleteIndex({ indexName }) {
     try {
       await this.client.indices.delete({ index: indexName });
     } catch (error) {
@@ -463,11 +473,10 @@ var OpenSearchVector = class extends vector.MastraVector {
    * @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(params) {
-    const { indexName, vectors, metadata = [], ids } = params;
+  async upsert({ indexName, vectors, metadata = [], ids }) {
     const vectorIds = ids || vectors.map(() => crypto.randomUUID());
     const operations = [];
-    const indexInfo = await this.describeIndex(indexName);
+    const indexInfo = await this.describeIndex({ indexName });
     this.validateVectorDimensions(vectors, indexInfo.dimension);
     for (let i = 0; i < vectors.length; i++) {
       const operation = {
@@ -504,8 +513,13 @@ var OpenSearchVector = class extends vector.MastraVector {
    * @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(params) {
-    const { indexName, queryVector, filter, topK = 10, includeVector = false } = params;
+  async query({
+    indexName,
+    queryVector,
+    filter,
+    topK = 10,
+    includeVector = false
+  }) {
     try {
       const translatedFilter = this.transformFilter(filter);
       const response = await this.client.search({
@@ -558,8 +572,6 @@ var OpenSearchVector = class extends vector.MastraVector {
     return translator.translate(filter);
   }
   /**
-   * @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.
@@ -569,25 +581,7 @@ var OpenSearchVector = class extends vector.MastraVector {
    * @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.
    */
-  async updateIndexById(indexName, id, update) {
-    this.logger.warn(
-      `Deprecation Warning: updateIndexById() is deprecated. 
-      Please use updateVector() instead. 
-      updateIndexById() will be removed on May 20th, 2025.`
-    );
-    await this.updateVector(indexName, id, update);
-  }
-  /**
-   * 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.
-   */
-  async updateVector(indexName, id, update) {
+  async updateVector({ indexName, id, update }) {
     if (!update.vector && !update.metadata) {
       throw new Error("No updates provided");
     }
@@ -606,7 +600,7 @@ var OpenSearchVector = class extends vector.MastraVector {
         id: source.id || id
       };
       if (update.vector) {
-        const indexInfo = await this.describeIndex(indexName);
+        const indexInfo = await this.describeIndex({ indexName });
         this.validateVectorDimensions([update.vector], indexInfo.dimension);
         updatedDoc.embedding = update.vector;
       } else if (source.embedding) {
@@ -628,23 +622,6 @@ var OpenSearchVector = class extends vector.MastraVector {
       throw error;
     }
   }
-  /**
-   * @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.
-   */
-  async deleteIndexById(indexName, id) {
-    this.logger.warn(
-      `Deprecation Warning: deleteIndexById() is deprecated. 
-      Please use deleteVector() instead. 
-      deleteIndexById() will be removed on May 20th, 2025.`
-    );
-    await this.deleteVector(indexName, id);
-  }
   /**
    * Deletes a vector by its ID.
    * @param indexName - The name of the index containing the vector.
@@ -652,7 +629,7 @@ var OpenSearchVector = class extends vector.MastraVector {
    * @returns A promise that resolves when the deletion is complete.
    * @throws Will throw an error if the deletion operation fails.
    */
-  async deleteVector(indexName, id) {
+  async deleteVector({ indexName, id }) {
     try {
       await this.client.delete({
         index: indexName,

package/dist/index.js

@@ -362,7 +362,12 @@ var REVERSE_METRIC_MAPPING = {
 };
 var OpenSearchVector = class extends MastraVector {
   client;
-  constructor(url) {
+  /**
+   * Creates a new OpenSearchVector client.
+   *
+   * @param {string} url - The url of the OpenSearch node.
+   */
+  constructor({ url }) {
     super();
     this.client = new Client({ node: url });
   }
@@ -374,8 +379,7 @@ var OpenSearchVector = class extends MastraVector {
    * @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(params) {
-    const { indexName, dimension, metric = "cosine" } = params;
+  async createIndex({ indexName, dimension, metric = "cosine" }) {
     if (!Number.isInteger(dimension) || dimension <= 0) {
       throw new Error("Dimension must be a positive integer");
     }
@@ -427,7 +431,13 @@ var OpenSearchVector = class extends MastraVector {
       throw new Error(`Failed to list indexes: ${error.message}`);
     }
   }
-  async describeIndex(indexName) {
+  /**
+   * Retrieves statistics about a vector index.
+   *
+   * @param {string} indexName - The name of the index to describe
+   * @returns A promise that resolves to the index statistics including dimension, count and metric
+   */
+  async describeIndex({ indexName }) {
     const { body: indexInfo } = await this.client.indices.get({ index: indexName });
     const mappings = indexInfo[indexName]?.mappings;
     const embedding = mappings?.properties?.embedding;
@@ -445,7 +455,7 @@ var OpenSearchVector = class extends MastraVector {
    * @param {string} indexName - The name of the index to delete.
    * @returns {Promise<void>} A promise that resolves when the index is deleted.
    */
-  async deleteIndex(indexName) {
+  async deleteIndex({ indexName }) {
     try {
       await this.client.indices.delete({ index: indexName });
     } catch (error) {
@@ -461,11 +471,10 @@ var OpenSearchVector = class extends MastraVector {
    * @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(params) {
-    const { indexName, vectors, metadata = [], ids } = params;
+  async upsert({ indexName, vectors, metadata = [], ids }) {
     const vectorIds = ids || vectors.map(() => crypto.randomUUID());
     const operations = [];
-    const indexInfo = await this.describeIndex(indexName);
+    const indexInfo = await this.describeIndex({ indexName });
     this.validateVectorDimensions(vectors, indexInfo.dimension);
     for (let i = 0; i < vectors.length; i++) {
       const operation = {
@@ -502,8 +511,13 @@ var OpenSearchVector = class extends MastraVector {
    * @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(params) {
-    const { indexName, queryVector, filter, topK = 10, includeVector = false } = params;
+  async query({
+    indexName,
+    queryVector,
+    filter,
+    topK = 10,
+    includeVector = false
+  }) {
     try {
       const translatedFilter = this.transformFilter(filter);
       const response = await this.client.search({
@@ -556,8 +570,6 @@ var OpenSearchVector = class extends MastraVector {
     return translator.translate(filter);
   }
   /**
-   * @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.
@@ -567,25 +579,7 @@ var OpenSearchVector = class extends MastraVector {
    * @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.
    */
-  async updateIndexById(indexName, id, update) {
-    this.logger.warn(
-      `Deprecation Warning: updateIndexById() is deprecated. 
-      Please use updateVector() instead. 
-      updateIndexById() will be removed on May 20th, 2025.`
-    );
-    await this.updateVector(indexName, id, update);
-  }
-  /**
-   * 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.
-   */
-  async updateVector(indexName, id, update) {
+  async updateVector({ indexName, id, update }) {
     if (!update.vector && !update.metadata) {
       throw new Error("No updates provided");
     }
@@ -604,7 +598,7 @@ var OpenSearchVector = class extends MastraVector {
         id: source.id || id
       };
       if (update.vector) {
-        const indexInfo = await this.describeIndex(indexName);
+        const indexInfo = await this.describeIndex({ indexName });
         this.validateVectorDimensions([update.vector], indexInfo.dimension);
         updatedDoc.embedding = update.vector;
       } else if (source.embedding) {
@@ -626,23 +620,6 @@ var OpenSearchVector = class extends MastraVector {
       throw error;
     }
   }
-  /**
-   * @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.
-   */
-  async deleteIndexById(indexName, id) {
-    this.logger.warn(
-      `Deprecation Warning: deleteIndexById() is deprecated. 
-      Please use deleteVector() instead. 
-      deleteIndexById() will be removed on May 20th, 2025.`
-    );
-    await this.deleteVector(indexName, id);
-  }
   /**
    * Deletes a vector by its ID.
    * @param indexName - The name of the index containing the vector.
@@ -650,7 +627,7 @@ var OpenSearchVector = class extends MastraVector {
    * @returns A promise that resolves when the deletion is complete.
    * @throws Will throw an error if the deletion operation fails.
    */
-  async deleteVector(indexName, id) {
+  async deleteVector({ indexName, id }) {
     try {
       await this.client.delete({
         index: indexName,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/opensearch",
-  "version": "0.1.1",
+  "version": "0.2.0-alpha.1",
   "description": "OpenSearch vector store provider for Mastra",
   "type": "module",
   "main": "dist/index.js",
@@ -19,8 +19,7 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@opensearch-project/opensearch": "^3.4.0",
-    "@mastra/core": "^0.9.4"
+    "@opensearch-project/opensearch": "^3.4.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.52.1",
@@ -29,7 +28,11 @@
     "tsup": "^8.4.0",
     "typescript": "^5.8.2",
     "vitest": "^3.0.8",
-    "@internal/lint": "0.0.5"
+    "@internal/lint": "0.0.5",
+    "@mastra/core": "0.10.0-alpha.1"
+  },
+  "peerDependencies": {
+    "@mastra/core": "^0.9.4"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --experimental-dts --clean --treeshake=smallest --splitting",

package/src/vector/index.test.ts

@@ -39,31 +39,31 @@ describe('OpenSearchVector', () => {
 
   beforeAll(async () => {
     // Initialize PgVector
-    vectorDB = new OpenSearchVector(url);
+    vectorDB = new OpenSearchVector({ url });
   });
 
   afterAll(async () => {
     // Clean up test tables
-    await vectorDB.deleteIndex(testIndexName);
+    await vectorDB.deleteIndex({ indexName: testIndexName });
   });
 
   // Index Management Tests
   describe('Index Management', () => {
     describe('createIndex', () => {
       afterAll(async () => {
-        await vectorDB.deleteIndex(testIndexName2);
+        await vectorDB.deleteIndex({ indexName: testIndexName2 });
       });
 
       it('should create a new vector table with specified dimensions', async () => {
         await vectorDB.createIndex({ indexName: testIndexName, dimension: 3 });
-        const stats = await vectorDB.describeIndex(testIndexName);
+        const stats = await vectorDB.describeIndex({ indexName: testIndexName });
         expect(stats?.dimension).toBe(3);
         expect(stats?.count).toBe(0);
       });
 
       it('should create index with specified metric', async () => {
         await vectorDB.createIndex({ indexName: testIndexName2, dimension: 3, metric: 'euclidean' });
-        const stats = await vectorDB.describeIndex(testIndexName2);
+        const stats = await vectorDB.describeIndex({ indexName: testIndexName2 });
         expect(stats.metric).toBe('euclidean');
       });
 
@@ -75,7 +75,7 @@ describe('OpenSearchVector', () => {
     describe('metrics', () => {
       const testIndex = 'test_metric';
       afterEach(async () => {
-        await vectorDB.deleteIndex(testIndex);
+        await vectorDB.deleteIndex({ indexName: testIndex });
       });
       it('should create index with cosine metric', async () => {
         await vectorDB.createIndex({
@@ -83,7 +83,7 @@ describe('OpenSearchVector', () => {
           dimension: 3,
           metric: 'cosine',
         });
-        const stats = await vectorDB.describeIndex(testIndex);
+        const stats = await vectorDB.describeIndex({ indexName: testIndex });
         expect(stats.metric).toBe('cosine');
       });
 
@@ -93,7 +93,7 @@ describe('OpenSearchVector', () => {
           dimension: 3,
           metric: 'euclidean',
         });
-        const stats = await vectorDB.describeIndex(testIndex);
+        const stats = await vectorDB.describeIndex({ indexName: testIndex });
         expect(stats.metric).toBe('euclidean');
       });
 
@@ -103,7 +103,7 @@ describe('OpenSearchVector', () => {
           dimension: 3,
           metric: 'dotproduct',
         });
-        const stats = await vectorDB.describeIndex(testIndex);
+        const stats = await vectorDB.describeIndex({ indexName: testIndex });
         expect(stats.metric).toBe('dotproduct');
       });
     });
@@ -115,7 +115,7 @@ describe('OpenSearchVector', () => {
       });
 
       afterAll(async () => {
-        await vectorDB.deleteIndex(indexName);
+        await vectorDB.deleteIndex({ indexName });
       });
 
       it('should list all vector tables', async () => {
@@ -124,7 +124,7 @@ describe('OpenSearchVector', () => {
       });
 
       it('should not return created index in list if it is deleted', async () => {
-        await vectorDB.deleteIndex(indexName);
+        await vectorDB.deleteIndex({ indexName });
         const indexes = await vectorDB.listIndexes();
         expect(indexes).not.toContain(indexName);
       });
@@ -137,7 +137,7 @@ describe('OpenSearchVector', () => {
       });
 
       afterAll(async () => {
-        await vectorDB.deleteIndex(indexName);
+        await vectorDB.deleteIndex({ indexName });
       });
 
       it('should return correct index stats', async () => {
@@ -147,7 +147,7 @@ describe('OpenSearchVector', () => {
         ];
         await vectorDB.upsert({ indexName, vectors });
 
-        const stats = await vectorDB.describeIndex(indexName);
+        const stats = await vectorDB.describeIndex({ indexName });
         expect(stats).toEqual({
           dimension: 3,
           count: 2,
@@ -156,7 +156,7 @@ describe('OpenSearchVector', () => {
       });
 
       it('should throw error for non-existent index', async () => {
-        await expect(vectorDB.describeIndex('non_existent')).rejects.toThrow();
+        await expect(vectorDB.describeIndex({ indexName: 'non_existent' })).rejects.toThrow();
       });
     });
 
@@ -170,7 +170,7 @@ describe('OpenSearchVector', () => {
         expect(indexes).toContain(testIndexName);
 
         // Delete the index after the test
-        await vectorDB.deleteIndex(testIndexName);
+        await vectorDB.deleteIndex({ indexName: testIndexName });
       });
 
       it('should throw an error if dimension is not a positive integer', async () => {
@@ -186,7 +186,7 @@ describe('OpenSearchVector', () => {
         let indexes = await vectorDB.listIndexes();
         expect(indexes).toContain(deleteTestIndex);
 
-        await vectorDB.deleteIndex(deleteTestIndex);
+        await vectorDB.deleteIndex({ indexName: deleteTestIndex });
 
         indexes = await vectorDB.listIndexes();
         expect(indexes).not.toContain(deleteTestIndex);
@@ -201,7 +201,7 @@ describe('OpenSearchVector', () => {
     });
 
     afterEach(async () => {
-      await vectorDB.deleteIndex(testIndexName);
+      await vectorDB.deleteIndex({ indexName: testIndexName });
     });
 
     describe('query', () => {
@@ -421,7 +421,7 @@ describe('OpenSearchVector', () => {
       });
 
       afterEach(async () => {
-        await vectorDB.deleteIndex(testIndexName);
+        await vectorDB.deleteIndex({ indexName: testIndexName });
       });
 
       it('should insert new vectors', async () => {
@@ -432,7 +432,7 @@ describe('OpenSearchVector', () => {
         const ids = await vectorDB.upsert({ indexName: testIndexName, vectors });
 
         expect(ids).toHaveLength(2);
-        const stats = await vectorDB.describeIndex(testIndexName);
+        const stats = await vectorDB.describeIndex({ indexName: testIndexName });
         expect(stats.count).toBe(2);
       });
 
@@ -485,7 +485,7 @@ describe('OpenSearchVector', () => {
       });
 
       afterEach(async () => {
-        await vectorDB.deleteIndex(testIndexName);
+        await vectorDB.deleteIndex({ indexName: testIndexName });
       });
 
       it('should update the vector by id', async () => {
@@ -503,7 +503,7 @@ describe('OpenSearchVector', () => {
           metadata: newMetaData,
         };
 
-        await vectorDB.updateVector(testIndexName, idToBeUpdated, update);
+        await vectorDB.updateVector({ indexName: testIndexName, id: idToBeUpdated, update });
 
         const results: QueryResult[] = await vectorDB.query({
           indexName: testIndexName,
@@ -530,7 +530,7 @@ describe('OpenSearchVector', () => {
           metadata: newMetaData,
         };
 
-        await vectorDB.updateVector(testIndexName, idToBeUpdated, update);
+        await vectorDB.updateVector({ indexName: testIndexName, id: idToBeUpdated, update });
 
         const results: QueryResult[] = await vectorDB.query({
           indexName: testIndexName,
@@ -555,7 +555,7 @@ describe('OpenSearchVector', () => {
           vector: newVector,
         };
 
-        await vectorDB.updateVector(testIndexName, idToBeUpdated, update);
+        await vectorDB.updateVector({ indexName: testIndexName, id: idToBeUpdated, update });
 
         const results: QueryResult[] = await vectorDB.query({
           indexName: testIndexName,
@@ -569,7 +569,9 @@ describe('OpenSearchVector', () => {
       });
 
       it('should throw exception when no updates are given', async () => {
-        await expect(vectorDB.updateVector(testIndexName, 'id', {})).rejects.toThrow('No updates provided');
+        await expect(vectorDB.updateVector({ indexName: testIndexName, id: 'id', update: {} })).rejects.toThrow(
+          'No updates provided',
+        );
       });
     });
 
@@ -586,7 +588,7 @@ describe('OpenSearchVector', () => {
       });
 
       afterEach(async () => {
-        await vectorDB.deleteIndex(testIndexName);
+        await vectorDB.deleteIndex({ indexName: testIndexName });
       });
 
       it('should delete the vector by id', async () => {
@@ -594,7 +596,7 @@ describe('OpenSearchVector', () => {
         expect(ids).toHaveLength(3);
         const idToBeDeleted = ids[0];
 
-        await vectorDB.deleteVector(testIndexName, idToBeDeleted);
+        await vectorDB.deleteVector({ indexName: testIndexName, id: idToBeDeleted });
 
         const results: QueryResult[] = await vectorDB.query({
           indexName: testIndexName,
@@ -663,7 +665,7 @@ describe('OpenSearchVector', () => {
     });
 
     afterEach(async () => {
-      await vectorDB.deleteIndex(indexName);
+      await vectorDB.deleteIndex({ indexName });
     });
 
     // Numeric Comparison Tests
@@ -1487,7 +1489,7 @@ describe('OpenSearchVector', () => {
     });
 
     afterAll(async () => {
-      await vectorDB.deleteIndex(testIndexName);
+      await vectorDB.deleteIndex({ indexName: testIndexName });
     });
 
     it('should handle non-existent index queries', async () => {
@@ -1550,7 +1552,7 @@ describe('OpenSearchVector', () => {
         infoSpy.mockRestore();
         warnSpy.mockRestore();
         // Cleanup
-        await vectorDB.deleteIndex(duplicateIndexName);
+        await vectorDB.deleteIndex({ indexName: duplicateIndexName });
       }
     });
   });

package/src/vector/index.ts

@@ -1,4 +1,14 @@
-import type { CreateIndexParams, IndexStats, QueryResult, QueryVectorParams, UpsertVectorParams } from '@mastra/core';
+import type {
+  CreateIndexParams,
+  DeleteIndexParams,
+  DeleteVectorParams,
+  DescribeIndexParams,
+  IndexStats,
+  QueryResult,
+  QueryVectorParams,
+  UpdateVectorParams,
+  UpsertVectorParams,
+} from '@mastra/core';
 import { MastraVector } from '@mastra/core/vector';
 import type { VectorFilter } from '@mastra/core/vector/filter';
 import { Client as OpenSearchClient } from '@opensearch-project/opensearch';
@@ -19,7 +29,12 @@ const REVERSE_METRIC_MAPPING = {
 export class OpenSearchVector extends MastraVector {
   private client: OpenSearchClient;
 
-  constructor(url: string) {
+  /**
+   * Creates a new OpenSearchVector client.
+   *
+   * @param {string} url - The url of the OpenSearch node.
+   */
+  constructor({ url }: { url: string }) {
     super();
     this.client = new OpenSearchClient({ node: url });
   }
@@ -32,9 +47,7 @@ export class OpenSearchVector extends MastraVector {
    * @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(params: CreateIndexParams): Promise<void> {
-    const { indexName, dimension, metric = 'cosine' } = params;
-
+  async createIndex({ indexName, dimension, metric = 'cosine' }: CreateIndexParams): Promise<void> {
     if (!Number.isInteger(dimension) || dimension <= 0) {
       throw new Error('Dimension must be a positive integer');
     }
@@ -93,7 +106,13 @@ export class OpenSearchVector extends MastraVector {
     }
   }
 
-  async describeIndex(indexName: string): Promise<IndexStats> {
+  /**
+   * Retrieves statistics about a vector index.
+   *
+   * @param {string} indexName - The name of the index to describe
+   * @returns A promise that resolves to the index statistics including dimension, count and metric
+   */
+  async describeIndex({ indexName }: DescribeIndexParams): Promise<IndexStats> {
     const { body: indexInfo } = await this.client.indices.get({ index: indexName });
     const mappings = indexInfo[indexName]?.mappings;
     const embedding: any = mappings?.properties?.embedding;
@@ -114,7 +133,7 @@ export class OpenSearchVector extends MastraVector {
    * @param {string} indexName - The name of the index to delete.
    * @returns {Promise<void>} A promise that resolves when the index is deleted.
    */
-  async deleteIndex(indexName: string): Promise<void> {
+  async deleteIndex({ indexName }: DeleteIndexParams): Promise<void> {
     try {
       await this.client.indices.delete({ index: indexName });
     } catch (error) {
@@ -131,14 +150,12 @@ export class OpenSearchVector extends MastraVector {
    * @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(params: UpsertVectorParams): Promise<string[]> {
-    const { indexName, vectors, metadata = [], ids } = params;
-
+  async upsert({ indexName, vectors, metadata = [], ids }: UpsertVectorParams): Promise<string[]> {
     const vectorIds = ids || vectors.map(() => crypto.randomUUID());
     const operations = [];
 
     // Get index stats to check dimension
-    const indexInfo = await this.describeIndex(indexName);
+    const indexInfo = await this.describeIndex({ indexName });
 
     // Validate vector dimensions
     this.validateVectorDimensions(vectors, indexInfo.dimension);
@@ -183,9 +200,13 @@ export class OpenSearchVector extends MastraVector {
    * @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(params: QueryVectorParams): Promise<QueryResult[]> {
-    const { indexName, queryVector, filter, topK = 10, includeVector = false } = params;
-
+  async query({
+    indexName,
+    queryVector,
+    filter,
+    topK = 10,
+    includeVector = false,
+  }: QueryVectorParams): Promise<QueryResult[]> {
     try {
       const translatedFilter = this.transformFilter(filter);
 
@@ -243,31 +264,6 @@ export class OpenSearchVector extends MastraVector {
     return translator.translate(filter);
   }
 
-  /**
-   * @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.
-   */
-  async updateIndexById(
-    indexName: string,
-    id: string,
-    update: { vector?: number[]; metadata?: Record<string, any> },
-  ): Promise<void> {
-    this.logger.warn(
-      `Deprecation Warning: updateIndexById() is deprecated. 
-      Please use updateVector() instead. 
-      updateIndexById() will be removed on May 20th, 2025.`,
-    );
-    await this.updateVector(indexName, id, update);
-  }
-
   /**
    * Updates a vector by its ID with the provided vector and/or metadata.
    * @param indexName - The name of the index containing the vector.
@@ -278,14 +274,7 @@ export class OpenSearchVector extends MastraVector {
    * @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.
    */
-  async updateVector(
-    indexName: string,
-    id: string,
-    update: {
-      vector?: number[];
-      metadata?: Record<string, any>;
-    },
-  ): Promise<void> {
+  async updateVector({ indexName, id, update }: UpdateVectorParams): Promise<void> {
     if (!update.vector && !update.metadata) {
       throw new Error('No updates provided');
     }
@@ -313,7 +302,7 @@ export class OpenSearchVector extends MastraVector {
       // Update vector if provided
       if (update.vector) {
         // Get index stats to check dimension
-        const indexInfo = await this.describeIndex(indexName);
+        const indexInfo = await this.describeIndex({ indexName });
 
         // Validate vector dimensions
         this.validateVectorDimensions([update.vector], indexInfo.dimension);
@@ -343,24 +332,6 @@ export class OpenSearchVector extends MastraVector {
     }
   }
 
-  /**
-   * @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.
-   */
-  async deleteIndexById(indexName: string, id: string): Promise<void> {
-    this.logger.warn(
-      `Deprecation Warning: deleteIndexById() is deprecated. 
-      Please use deleteVector() instead. 
-      deleteIndexById() will be removed on May 20th, 2025.`,
-    );
-    await this.deleteVector(indexName, id);
-  }
-
   /**
    * Deletes a vector by its ID.
    * @param indexName - The name of the index containing the vector.
@@ -368,7 +339,7 @@ export class OpenSearchVector extends MastraVector {
    * @returns A promise that resolves when the deletion is complete.
    * @throws Will throw an error if the deletion operation fails.
    */
-  async deleteVector(indexName: string, id: string): Promise<void> {
+  async deleteVector({ indexName, id }: DeleteVectorParams): Promise<void> {
     try {
       await this.client.delete({
         index: indexName,