@mastra/opensearch 0.1.2-alpha.0 → 0.2.0-alpha.1

package/.turbo/turbo-build.log

@@ -1,23 +1,23 @@
 
-> @mastra/opensearch@0.1.2-alpha.0 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 10177ms
+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 10541ms
+DTS ⚡️ Build success in 11166ms
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-ESM dist/index.js 24.34 KB
-ESM ⚡️ Build success in 870ms
-CJS dist/index.cjs 24.39 KB
-CJS ⚡️ Build success in 870ms
+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,26 @@
 # @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

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

@@ -6,7 +6,6 @@ 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 { ParamsToArgs } from '@mastra/core';
 import type { QueryResult } from '@mastra/core';
 import type { QueryVectorParams } from '@mastra/core';
 import type { UpdateVectorParams } from '@mastra/core';
@@ -55,17 +54,12 @@ export declare class OpenSearchFilterTranslator extends BaseFilterTranslator {
 
 declare class OpenSearchVector extends MastraVector {
     private client;
-    /**
-     * @deprecated Passing a string URL is deprecated. Use an object parameter: { url }.
-     * @param url - The OpenSearch node URL (deprecated)
-     */
-    constructor(url: string);
     /**
      * Creates a new OpenSearchVector client.
      *
-     * @param params - An object with a url property specifying the OpenSearch node.
+     * @param {string} url - The url of the OpenSearch node.
      */
-    constructor(params: {
+    constructor({ url }: {
         url: string;
     });
     /**
@@ -76,7 +70,7 @@ 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.
      *
@@ -86,18 +80,17 @@ declare class OpenSearchVector extends MastraVector {
     /**
      * Retrieves statistics about a vector index.
      *
-     * @param params - The parameters for describing an index
-     * @param params.indexName - The name of the index to describe
+     * @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(...args: ParamsToArgs<DescribeIndexParams>): Promise<IndexStats>;
+    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(...args: ParamsToArgs<DeleteIndexParams>): Promise<void>;
+    deleteIndex({ indexName }: DeleteIndexParams): Promise<void>;
     /**
      * Inserts or updates vectors in the specified collection.
      *
@@ -107,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.
      *
@@ -118,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.
      *
@@ -135,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.
@@ -146,31 +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(...args: ParamsToArgs<UpdateVectorParams>): 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.
@@ -178,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(...args: ParamsToArgs<DeleteVectorParams>): Promise<void>;
+    deleteVector({ indexName, id }: DeleteVectorParams): Promise<void>;
 }
 export { OpenSearchVector }
 export { OpenSearchVector as OpenSearchVector_alias_1 }

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

@@ -6,7 +6,6 @@ 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 { ParamsToArgs } from '@mastra/core';
 import type { QueryResult } from '@mastra/core';
 import type { QueryVectorParams } from '@mastra/core';
 import type { UpdateVectorParams } from '@mastra/core';
@@ -55,17 +54,12 @@ export declare class OpenSearchFilterTranslator extends BaseFilterTranslator {
 
 declare class OpenSearchVector extends MastraVector {
     private client;
-    /**
-     * @deprecated Passing a string URL is deprecated. Use an object parameter: { url }.
-     * @param url - The OpenSearch node URL (deprecated)
-     */
-    constructor(url: string);
     /**
      * Creates a new OpenSearchVector client.
      *
-     * @param params - An object with a url property specifying the OpenSearch node.
+     * @param {string} url - The url of the OpenSearch node.
      */
-    constructor(params: {
+    constructor({ url }: {
         url: string;
     });
     /**
@@ -76,7 +70,7 @@ 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.
      *
@@ -86,18 +80,17 @@ declare class OpenSearchVector extends MastraVector {
     /**
      * Retrieves statistics about a vector index.
      *
-     * @param params - The parameters for describing an index
-     * @param params.indexName - The name of the index to describe
+     * @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(...args: ParamsToArgs<DescribeIndexParams>): Promise<IndexStats>;
+    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(...args: ParamsToArgs<DeleteIndexParams>): Promise<void>;
+    deleteIndex({ indexName }: DeleteIndexParams): Promise<void>;
     /**
      * Inserts or updates vectors in the specified collection.
      *
@@ -107,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.
      *
@@ -118,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.
      *
@@ -135,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.
@@ -146,31 +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(...args: ParamsToArgs<UpdateVectorParams>): 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.
@@ -178,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(...args: ParamsToArgs<DeleteVectorParams>): Promise<void>;
+    deleteVector({ indexName, id }: DeleteVectorParams): Promise<void>;
 }
 export { OpenSearchVector }
 export { OpenSearchVector as OpenSearchVector_alias_1 }

package/dist/index.cjs

@@ -364,21 +364,13 @@ var REVERSE_METRIC_MAPPING = {
 };
 var OpenSearchVector = class extends vector.MastraVector {
   client;
-  constructor(paramsOrUrl) {
+  /**
+   * Creates a new OpenSearchVector client.
+   *
+   * @param {string} url - The url of the OpenSearch node.
+   */
+  constructor({ url }) {
     super();
-    let url;
-    if (typeof paramsOrUrl === "string") {
-      if (typeof console !== "undefined" && console.warn) {
-        console.warn(
-          "Deprecation Warning: OpenSearchVector constructor positional arguments are deprecated. Please use a single object parameter instead. This signature will be removed on May 20th, 2025."
-        );
-      }
-      url = paramsOrUrl;
-    } else if (typeof paramsOrUrl === "object" && paramsOrUrl !== null && "url" in paramsOrUrl) {
-      url = paramsOrUrl.url;
-    } else {
-      throw new Error("Invalid parameters for OpenSearchVector constructor. Expected { url: string }.");
-    }
     this.client = new opensearch.Client({ node: url });
   }
   /**
@@ -389,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");
     }
@@ -445,13 +436,10 @@ var OpenSearchVector = class extends vector.MastraVector {
   /**
    * Retrieves statistics about a vector index.
    *
-   * @param params - The parameters for describing an index
-   * @param params.indexName - The name of the index to describe
+   * @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(...args) {
-    const params = this.normalizeArgs("describeIndex", args);
-    const { indexName } = params;
+  async describeIndex({ indexName }) {
     const { body: indexInfo } = await this.client.indices.get({ index: indexName });
     const mappings = indexInfo[indexName]?.mappings;
     const embedding = mappings?.properties?.embedding;
@@ -469,9 +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(...args) {
-    const params = this.normalizeArgs("deleteIndex", args);
-    const { indexName } = params;
+  async deleteIndex({ indexName }) {
     try {
       await this.client.indices.delete({ index: indexName });
     } catch (error) {
@@ -487,8 +473,7 @@ 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 });
@@ -528,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({
@@ -581,26 +571,6 @@ var OpenSearchVector = class extends vector.MastraVector {
     const translator = new OpenSearchFilterTranslator();
     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, 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.
@@ -611,9 +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 updateVector(...args) {
-    const params = this.normalizeArgs("updateVector", args);
-    const { indexName, id, update } = params;
+  async updateVector({ indexName, id, update }) {
     if (!update.vector && !update.metadata) {
       throw new Error("No updates provided");
     }
@@ -654,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.
@@ -678,9 +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(...args) {
-    const params = this.normalizeArgs("deleteVector", args);
-    const { indexName, id } = params;
+  async deleteVector({ indexName, id }) {
     try {
       await this.client.delete({
         index: indexName,

package/dist/index.js

@@ -362,21 +362,13 @@ var REVERSE_METRIC_MAPPING = {
 };
 var OpenSearchVector = class extends MastraVector {
   client;
-  constructor(paramsOrUrl) {
+  /**
+   * Creates a new OpenSearchVector client.
+   *
+   * @param {string} url - The url of the OpenSearch node.
+   */
+  constructor({ url }) {
     super();
-    let url;
-    if (typeof paramsOrUrl === "string") {
-      if (typeof console !== "undefined" && console.warn) {
-        console.warn(
-          "Deprecation Warning: OpenSearchVector constructor positional arguments are deprecated. Please use a single object parameter instead. This signature will be removed on May 20th, 2025."
-        );
-      }
-      url = paramsOrUrl;
-    } else if (typeof paramsOrUrl === "object" && paramsOrUrl !== null && "url" in paramsOrUrl) {
-      url = paramsOrUrl.url;
-    } else {
-      throw new Error("Invalid parameters for OpenSearchVector constructor. Expected { url: string }.");
-    }
     this.client = new Client({ node: url });
   }
   /**
@@ -387,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");
     }
@@ -443,13 +434,10 @@ var OpenSearchVector = class extends MastraVector {
   /**
    * Retrieves statistics about a vector index.
    *
-   * @param params - The parameters for describing an index
-   * @param params.indexName - The name of the index to describe
+   * @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(...args) {
-    const params = this.normalizeArgs("describeIndex", args);
-    const { indexName } = params;
+  async describeIndex({ indexName }) {
     const { body: indexInfo } = await this.client.indices.get({ index: indexName });
     const mappings = indexInfo[indexName]?.mappings;
     const embedding = mappings?.properties?.embedding;
@@ -467,9 +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(...args) {
-    const params = this.normalizeArgs("deleteIndex", args);
-    const { indexName } = params;
+  async deleteIndex({ indexName }) {
     try {
       await this.client.indices.delete({ index: indexName });
     } catch (error) {
@@ -485,8 +471,7 @@ 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 });
@@ -526,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({
@@ -579,26 +569,6 @@ var OpenSearchVector = class extends MastraVector {
     const translator = new OpenSearchFilterTranslator();
     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, 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.
@@ -609,9 +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 updateVector(...args) {
-    const params = this.normalizeArgs("updateVector", args);
-    const { indexName, id, update } = params;
+  async updateVector({ indexName, id, update }) {
     if (!update.vector && !update.metadata) {
       throw new Error("No updates provided");
     }
@@ -652,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.
@@ -676,9 +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(...args) {
-    const params = this.normalizeArgs("deleteVector", args);
-    const { indexName, id } = params;
+  async deleteVector({ indexName, id }) {
     try {
       await this.client.delete({
         index: indexName,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/opensearch",
-  "version": "0.1.2-alpha.0",
+  "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.5-alpha.0"
+    "@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.ts

@@ -4,7 +4,6 @@ import type {
   DeleteVectorParams,
   DescribeIndexParams,
   IndexStats,
-  ParamsToArgs,
   QueryResult,
   QueryVectorParams,
   UpdateVectorParams,
@@ -30,33 +29,13 @@ const REVERSE_METRIC_MAPPING = {
 export class OpenSearchVector extends MastraVector {
   private client: OpenSearchClient;
 
-  /**
-   * @deprecated Passing a string URL is deprecated. Use an object parameter: { url }.
-   * @param url - The OpenSearch node URL (deprecated)
-   */
-  constructor(url: string);
   /**
    * Creates a new OpenSearchVector client.
    *
-   * @param params - An object with a url property specifying the OpenSearch node.
+   * @param {string} url - The url of the OpenSearch node.
    */
-  constructor(params: { url: string });
-  constructor(paramsOrUrl: { url: string } | string) {
+  constructor({ url }: { url: string }) {
     super();
-    let url: string;
-    if (typeof paramsOrUrl === 'string') {
-      // Deprecation warning for positional argument
-      if (typeof console !== 'undefined' && console.warn) {
-        console.warn(
-          'Deprecation Warning: OpenSearchVector constructor positional arguments are deprecated. Please use a single object parameter instead. This signature will be removed on May 20th, 2025.',
-        );
-      }
-      url = paramsOrUrl;
-    } else if (typeof paramsOrUrl === 'object' && paramsOrUrl !== null && 'url' in paramsOrUrl) {
-      url = paramsOrUrl.url;
-    } else {
-      throw new Error('Invalid parameters for OpenSearchVector constructor. Expected { url: string }.');
-    }
     this.client = new OpenSearchClient({ node: url });
   }
 
@@ -68,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');
     }
@@ -132,14 +109,10 @@ export class OpenSearchVector extends MastraVector {
   /**
    * Retrieves statistics about a vector index.
    *
-   * @param params - The parameters for describing an index
-   * @param params.indexName - The name of the index to describe
+   * @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(...args: ParamsToArgs<DescribeIndexParams>): Promise<IndexStats> {
-    const params = this.normalizeArgs<DescribeIndexParams>('describeIndex', args);
-
-    const { indexName } = params;
+  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;
@@ -160,10 +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(...args: ParamsToArgs<DeleteIndexParams>): Promise<void> {
-    const params = this.normalizeArgs<DeleteIndexParams>('deleteIndex', args);
-
-    const { indexName } = params;
+  async deleteIndex({ indexName }: DeleteIndexParams): Promise<void> {
     try {
       await this.client.indices.delete({ index: indexName });
     } catch (error) {
@@ -180,9 +150,7 @@ 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 = [];
 
@@ -232,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);
 
@@ -292,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.
@@ -327,9 +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(...args: ParamsToArgs<UpdateVectorParams>): Promise<void> {
-    const params = this.normalizeArgs<UpdateVectorParams>('updateVector', args);
-    const { indexName, id, update } = params;
+  async updateVector({ indexName, id, update }: UpdateVectorParams): Promise<void> {
     if (!update.vector && !update.metadata) {
       throw new Error('No updates provided');
     }
@@ -387,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.
@@ -412,9 +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(...args: ParamsToArgs<DeleteVectorParams>): Promise<void> {
-    const params = this.normalizeArgs<DeleteVectorParams>('deleteVector', args);
-    const { indexName, id } = params;
+  async deleteVector({ indexName, id }: DeleteVectorParams): Promise<void> {
     try {
       await this.client.delete({
         index: indexName,