@mastra/opensearch 0.1.1-alpha.2 → 0.1.1-alpha.4

package/.turbo/turbo-build.log

@@ -1,23 +1,23 @@
 
-> @mastra/opensearch@0.1.1-alpha.2 build /home/runner/work/mastra/mastra/stores/opensearch
+> @mastra/opensearch@0.1.1-alpha.4 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 11556ms
+TSC ⚡️ Build success in 9556ms
 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 11669ms
+DTS ⚡️ Build success in 10879ms
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-CJS dist/index.cjs 21.37 KB
-CJS ⚡️ Build success in 915ms
-ESM dist/index.js 21.32 KB
-ESM ⚡️ Build success in 928ms
+ESM dist/index.js 23.06 KB
+ESM ⚡️ Build success in 1008ms
+CJS dist/index.cjs 23.10 KB
+CJS ⚡️ Build success in 1007ms

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @mastra/opensearch
 
+## 0.1.1-alpha.4
+
+### Patch Changes
+
+- Updated dependencies [3e9c131]
+  - @mastra/core@0.9.4-alpha.4
+
+## 0.1.1-alpha.3
+
+### Patch Changes
+
+- c3bd795: [MASTRA-3358] Deprecate updateIndexById and deleteIndexById
+- Updated dependencies [396be50]
+- Updated dependencies [c3bd795]
+- Updated dependencies [da082f8]
+- Updated dependencies [a5810ce]
+  - @mastra/core@0.9.4-alpha.3
+
 ## 0.1.1-alpha.2
 
 ### Patch Changes

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

@@ -111,27 +111,53 @@ declare class OpenSearchVector extends MastraVector {
      */
     private transformFilter;
     /**
-     * Updates a specific document in the index by ID.
+     * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
      *
-     * @param {string} indexName - The name of the index containing the document.
-     * @param {string} id - The ID of the document to update.
-     * @param {Object} update - The update to apply to the document.
-     * @param {number[]} [update.vector] - Optional new vector to update.
-     * @param {Record<string, any>} [update.metadata] - Optional new metadata to update.
-     * @returns {Promise<void>} A promise that resolves when the document is updated.
+     * 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>;
     /**
-     * Deletes a specific document from the index by ID.
+     * 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.
      *
-     * @param {string} indexName - The name of the index containing the document.
-     * @param {string} id - The ID of the document to delete.
-     * @returns {Promise<void>} A promise that resolves when the document is deleted.
+     * 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 }

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

@@ -111,27 +111,53 @@ declare class OpenSearchVector extends MastraVector {
      */
     private transformFilter;
     /**
-     * Updates a specific document in the index by ID.
+     * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
      *
-     * @param {string} indexName - The name of the index containing the document.
-     * @param {string} id - The ID of the document to update.
-     * @param {Object} update - The update to apply to the document.
-     * @param {number[]} [update.vector] - Optional new vector to update.
-     * @param {Record<string, any>} [update.metadata] - Optional new metadata to update.
-     * @returns {Promise<void>} A promise that resolves when the document is updated.
+     * 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>;
     /**
-     * Deletes a specific document from the index by ID.
+     * 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.
      *
-     * @param {string} indexName - The name of the index containing the document.
-     * @param {string} id - The ID of the document to delete.
-     * @returns {Promise<void>} A promise that resolves when the document is deleted.
+     * 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 }

package/dist/index.cjs

@@ -558,16 +558,36 @@ var OpenSearchVector = class extends vector.MastraVector {
     return translator.translate(filter);
   }
   /**
-   * Updates a specific document in the index by ID.
+   * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
    *
-   * @param {string} indexName - The name of the index containing the document.
-   * @param {string} id - The ID of the document to update.
-   * @param {Object} update - The update to apply to the document.
-   * @param {number[]} [update.vector] - Optional new vector to update.
-   * @param {Record<string, any>} [update.metadata] - Optional new metadata to update.
-   * @returns {Promise<void>} A promise that resolves when the document is updated.
+   * 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.
+   * @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) {
     if (!update.vector && !update.metadata) {
       throw new Error("No updates provided");
     }
@@ -609,13 +629,30 @@ var OpenSearchVector = class extends vector.MastraVector {
     }
   }
   /**
-   * Deletes a specific document from the index by ID.
+   * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
    *
-   * @param {string} indexName - The name of the index containing the document.
-   * @param {string} id - The ID of the document to delete.
-   * @returns {Promise<void>} A promise that resolves when the document is deleted.
+   * 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.
+   * @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 deleteVector(indexName, id) {
     try {
       await this.client.delete({
         index: indexName,

package/dist/index.js

@@ -556,16 +556,36 @@ var OpenSearchVector = class extends MastraVector {
     return translator.translate(filter);
   }
   /**
-   * Updates a specific document in the index by ID.
+   * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
    *
-   * @param {string} indexName - The name of the index containing the document.
-   * @param {string} id - The ID of the document to update.
-   * @param {Object} update - The update to apply to the document.
-   * @param {number[]} [update.vector] - Optional new vector to update.
-   * @param {Record<string, any>} [update.metadata] - Optional new metadata to update.
-   * @returns {Promise<void>} A promise that resolves when the document is updated.
+   * 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.
+   * @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) {
     if (!update.vector && !update.metadata) {
       throw new Error("No updates provided");
     }
@@ -607,13 +627,30 @@ var OpenSearchVector = class extends MastraVector {
     }
   }
   /**
-   * Deletes a specific document from the index by ID.
+   * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
    *
-   * @param {string} indexName - The name of the index containing the document.
-   * @param {string} id - The ID of the document to delete.
-   * @returns {Promise<void>} A promise that resolves when the document is deleted.
+   * 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.
+   * @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 deleteVector(indexName, id) {
     try {
       await this.client.delete({
         index: indexName,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/opensearch",
-  "version": "0.1.1-alpha.2",
+  "version": "0.1.1-alpha.4",
   "description": "OpenSearch vector store provider for Mastra",
   "type": "module",
   "main": "dist/index.js",
@@ -20,7 +20,7 @@
   },
   "dependencies": {
     "@opensearch-project/opensearch": "^3.4.0",
-    "@mastra/core": "^0.9.4-alpha.2"
+    "@mastra/core": "^0.9.4-alpha.4"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.52.1",

package/src/vector/index.test.ts

@@ -503,7 +503,7 @@ describe('OpenSearchVector', () => {
           metadata: newMetaData,
         };
 
-        await vectorDB.updateIndexById(testIndexName, idToBeUpdated, update);
+        await vectorDB.updateVector(testIndexName, idToBeUpdated, update);
 
         const results: QueryResult[] = await vectorDB.query({
           indexName: testIndexName,
@@ -530,7 +530,7 @@ describe('OpenSearchVector', () => {
           metadata: newMetaData,
         };
 
-        await vectorDB.updateIndexById(testIndexName, idToBeUpdated, update);
+        await vectorDB.updateVector(testIndexName, idToBeUpdated, update);
 
         const results: QueryResult[] = await vectorDB.query({
           indexName: testIndexName,
@@ -555,7 +555,7 @@ describe('OpenSearchVector', () => {
           vector: newVector,
         };
 
-        await vectorDB.updateIndexById(testIndexName, idToBeUpdated, update);
+        await vectorDB.updateVector(testIndexName, idToBeUpdated, update);
 
         const results: QueryResult[] = await vectorDB.query({
           indexName: testIndexName,
@@ -569,7 +569,7 @@ describe('OpenSearchVector', () => {
       });
 
       it('should throw exception when no updates are given', async () => {
-        await expect(vectorDB.updateIndexById(testIndexName, 'id', {})).rejects.toThrow('No updates provided');
+        await expect(vectorDB.updateVector(testIndexName, 'id', {})).rejects.toThrow('No updates provided');
       });
     });
 
@@ -594,7 +594,7 @@ describe('OpenSearchVector', () => {
         expect(ids).toHaveLength(3);
         const idToBeDeleted = ids[0];
 
-        await vectorDB.deleteIndexById(testIndexName, idToBeDeleted);
+        await vectorDB.deleteVector(testIndexName, idToBeDeleted);
 
         const results: QueryResult[] = await vectorDB.query({
           indexName: testIndexName,

package/src/vector/index.ts

@@ -244,16 +244,41 @@ export class OpenSearchVector extends MastraVector {
   }
 
   /**
-   * Updates a specific document in the index by ID.
+   * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
    *
-   * @param {string} indexName - The name of the index containing the document.
-   * @param {string} id - The ID of the document to update.
-   * @param {Object} update - The update to apply to the document.
-   * @param {number[]} [update.vector] - Optional new vector to update.
-   * @param {Record<string, any>} [update.metadata] - Optional new metadata to update.
-   * @returns {Promise<void>} A promise that resolves when the document is updated.
+   * 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.
+   * @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: string,
     id: string,
     update: {
@@ -319,13 +344,31 @@ export class OpenSearchVector extends MastraVector {
   }
 
   /**
-   * Deletes a specific document from the index by ID.
+   * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
    *
-   * @param {string} indexName - The name of the index containing the document.
-   * @param {string} id - The ID of the document to delete.
-   * @returns {Promise<void>} A promise that resolves when the document is deleted.
+   * 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.
+   * @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 deleteVector(indexName: string, id: string): Promise<void> {
     try {
       await this.client.delete({
         index: indexName,