@mastra/upstash 0.3.4-alpha.1 → 0.3.4-alpha.3

package/.turbo/turbo-build.log

@@ -1,23 +1,23 @@
 
-> @mastra/upstash@0.3.4-alpha.1 build /home/runner/work/mastra/mastra/stores/upstash
+> @mastra/upstash@0.3.4-alpha.3 build /home/runner/work/mastra/mastra/stores/upstash
 > 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 10813ms
+TSC ⚡️ Build success in 9618ms
 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/upstash/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/upstash/dist/_tsup-dts-rollup.d.cts
-DTS ⚡️ Build success in 10647ms
+DTS ⚡️ Build success in 11439ms
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-ESM dist/index.js 28.88 KB
-ESM ⚡️ Build success in 1110ms
-CJS dist/index.cjs 29.03 KB
-CJS ⚡️ Build success in 1110ms
+CJS dist/index.cjs 31.78 KB
+CJS ⚡️ Build success in 1286ms
+ESM dist/index.js 31.64 KB
+ESM ⚡️ Build success in 1286ms

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @mastra/upstash
 
+## 0.3.4-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.3.4-alpha.2
+
+### Patch Changes
+
+- Updated dependencies [3171b5b]
+- Updated dependencies [973e5ac]
+- Updated dependencies [9e1eff5]
+  - @mastra/core@0.9.4-alpha.2
+
 ## 0.3.4-alpha.1
 
 ### Patch Changes

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

@@ -156,11 +156,54 @@ declare class UpstashVector extends MastraVector {
         metric: "cosine" | "euclidean" | "dotproduct";
     }>;
     deleteIndex(indexName: string): Promise<void>;
+    /**
+     * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
+     *
+     * Updates a vector by its ID with the provided vector and/or metadata.
+     * @param indexName - The name of the index containing the vector.
+     * @param id - The ID of the vector to update.
+     * @param update - An object containing the vector and/or metadata to update.
+     * @param update.vector - An optional array of numbers representing the new vector.
+     * @param update.metadata - An optional record containing the new metadata.
+     * @returns A promise that resolves when the update is complete.
+     * @throws Will throw an error if no updates are provided or if the update operation fails.
+     */
     updateIndexById(indexName: string, id: string, update: {
         vector?: number[];
         metadata?: Record<string, any>;
     }): Promise<void>;
+    /**
+     * Updates a vector by its ID with the provided vector and/or metadata.
+     * @param indexName - The name of the index containing the vector.
+     * @param id - The ID of the vector to update.
+     * @param update - An object containing the vector and/or metadata to update.
+     * @param update.vector - An optional array of numbers representing the new vector.
+     * @param update.metadata - An optional record containing the new metadata.
+     * @returns A promise that resolves when the update is complete.
+     * @throws Will throw an error if no updates are provided or if the update operation fails.
+     */
+    updateVector(indexName: string, id: string, update: {
+        vector?: number[];
+        metadata?: Record<string, any>;
+    }): Promise<void>;
+    /**
+     * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
+     *
+     * Deletes a vector by its ID.
+     * @param indexName - The name of the index containing the vector.
+     * @param id - The ID of the vector to delete.
+     * @returns A promise that resolves when the deletion is complete.
+     * @throws Will throw an error if the deletion operation fails.
+     */
     deleteIndexById(indexName: string, id: string): Promise<void>;
+    /**
+     * Deletes a vector by its ID.
+     * @param indexName - The name of the index containing the vector.
+     * @param id - The ID of the vector to delete.
+     * @returns A promise that resolves when the deletion is complete.
+     * @throws Will throw an error if the deletion operation fails.
+     */
+    deleteVector(indexName: string, id: string): Promise<void>;
 }
 export { UpstashVector }
 export { UpstashVector as UpstashVector_alias_1 }

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

@@ -156,11 +156,54 @@ declare class UpstashVector extends MastraVector {
         metric: "cosine" | "euclidean" | "dotproduct";
     }>;
     deleteIndex(indexName: string): Promise<void>;
+    /**
+     * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
+     *
+     * Updates a vector by its ID with the provided vector and/or metadata.
+     * @param indexName - The name of the index containing the vector.
+     * @param id - The ID of the vector to update.
+     * @param update - An object containing the vector and/or metadata to update.
+     * @param update.vector - An optional array of numbers representing the new vector.
+     * @param update.metadata - An optional record containing the new metadata.
+     * @returns A promise that resolves when the update is complete.
+     * @throws Will throw an error if no updates are provided or if the update operation fails.
+     */
     updateIndexById(indexName: string, id: string, update: {
         vector?: number[];
         metadata?: Record<string, any>;
     }): Promise<void>;
+    /**
+     * Updates a vector by its ID with the provided vector and/or metadata.
+     * @param indexName - The name of the index containing the vector.
+     * @param id - The ID of the vector to update.
+     * @param update - An object containing the vector and/or metadata to update.
+     * @param update.vector - An optional array of numbers representing the new vector.
+     * @param update.metadata - An optional record containing the new metadata.
+     * @returns A promise that resolves when the update is complete.
+     * @throws Will throw an error if no updates are provided or if the update operation fails.
+     */
+    updateVector(indexName: string, id: string, update: {
+        vector?: number[];
+        metadata?: Record<string, any>;
+    }): Promise<void>;
+    /**
+     * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
+     *
+     * Deletes a vector by its ID.
+     * @param indexName - The name of the index containing the vector.
+     * @param id - The ID of the vector to delete.
+     * @returns A promise that resolves when the deletion is complete.
+     * @throws Will throw an error if the deletion operation fails.
+     */
     deleteIndexById(indexName: string, id: string): Promise<void>;
+    /**
+     * Deletes a vector by its ID.
+     * @param indexName - The name of the index containing the vector.
+     * @param id - The ID of the vector to delete.
+     * @returns A promise that resolves when the deletion is complete.
+     * @throws Will throw an error if the deletion operation fails.
+     */
+    deleteVector(indexName: string, id: string): Promise<void>;
 }
 export { UpstashVector }
 export { UpstashVector as UpstashVector_alias_1 }

package/dist/index.cjs

@@ -734,36 +734,94 @@ var UpstashVector = class extends vector.MastraVector {
       console.error("Failed to delete namespace:", error);
     }
   }
+  /**
+   * @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) {
-    if (!update.vector && !update.metadata) {
-      throw new Error("No update data provided");
-    }
-    if (!update.vector && update.metadata) {
-      throw new Error("Both vector and metadata must be provided for an update");
-    }
-    const updatePayload = { id };
-    if (update.vector) {
-      updatePayload.vector = update.vector;
-    }
-    if (update.metadata) {
-      updatePayload.metadata = update.metadata;
-    }
-    const points = {
-      id: updatePayload.id,
-      vector: updatePayload.vector,
-      metadata: updatePayload.metadata
-    };
-    await this.client.upsert(points, {
-      namespace: indexName
-    });
-  }
+    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) {
+    try {
+      if (!update.vector && !update.metadata) {
+        throw new Error("No update data provided");
+      }
+      if (!update.vector && update.metadata) {
+        throw new Error("Both vector and metadata must be provided for an update");
+      }
+      const updatePayload = { id };
+      if (update.vector) {
+        updatePayload.vector = update.vector;
+      }
+      if (update.metadata) {
+        updatePayload.metadata = update.metadata;
+      }
+      const points = {
+        id: updatePayload.id,
+        vector: updatePayload.vector,
+        metadata: updatePayload.metadata
+      };
+      await this.client.upsert(points, {
+        namespace: indexName
+      });
+    } catch (error) {
+      throw new Error(`Failed to update vector by id: ${id} for index name: ${indexName}: ${error.message}`);
+    }
+  }
+  /**
+   * @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.
+   * @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(id, {
         namespace: indexName
       });
     } catch (error) {
-      console.error("Failed to delete index by ID:", error);
+      console.error(`Failed to delete vector by id: ${id} for index name: ${indexName}:`, error);
     }
   }
 };

package/dist/index.js

@@ -732,36 +732,94 @@ var UpstashVector = class extends MastraVector {
       console.error("Failed to delete namespace:", error);
     }
   }
+  /**
+   * @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) {
-    if (!update.vector && !update.metadata) {
-      throw new Error("No update data provided");
-    }
-    if (!update.vector && update.metadata) {
-      throw new Error("Both vector and metadata must be provided for an update");
-    }
-    const updatePayload = { id };
-    if (update.vector) {
-      updatePayload.vector = update.vector;
-    }
-    if (update.metadata) {
-      updatePayload.metadata = update.metadata;
-    }
-    const points = {
-      id: updatePayload.id,
-      vector: updatePayload.vector,
-      metadata: updatePayload.metadata
-    };
-    await this.client.upsert(points, {
-      namespace: indexName
-    });
-  }
+    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) {
+    try {
+      if (!update.vector && !update.metadata) {
+        throw new Error("No update data provided");
+      }
+      if (!update.vector && update.metadata) {
+        throw new Error("Both vector and metadata must be provided for an update");
+      }
+      const updatePayload = { id };
+      if (update.vector) {
+        updatePayload.vector = update.vector;
+      }
+      if (update.metadata) {
+        updatePayload.metadata = update.metadata;
+      }
+      const points = {
+        id: updatePayload.id,
+        vector: updatePayload.vector,
+        metadata: updatePayload.metadata
+      };
+      await this.client.upsert(points, {
+        namespace: indexName
+      });
+    } catch (error) {
+      throw new Error(`Failed to update vector by id: ${id} for index name: ${indexName}: ${error.message}`);
+    }
+  }
+  /**
+   * @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.
+   * @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(id, {
         namespace: indexName
       });
     } catch (error) {
-      console.error("Failed to delete index by ID:", error);
+      console.error(`Failed to delete vector by id: ${id} for index name: ${indexName}:`, error);
     }
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/upstash",
-  "version": "0.3.4-alpha.1",
+  "version": "0.3.4-alpha.3",
   "description": "Upstash provider for Mastra - includes both vector and db storage capabilities",
   "type": "module",
   "main": "dist/index.js",
@@ -22,7 +22,7 @@
   "dependencies": {
     "@upstash/redis": "^1.34.5",
     "@upstash/vector": "^1.2.1",
-    "@mastra/core": "^0.9.4-alpha.1"
+    "@mastra/core": "^0.9.4-alpha.3"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.52.5",

package/src/vector/index.test.ts

@@ -140,7 +140,7 @@ describe.skipIf(!process.env.UPSTASH_VECTOR_URL || !process.env.UPSTASH_VECTOR_T
           metadata: newMetaData,
         };
 
-        await vectorStore.updateIndexById(testIndexName, idToBeUpdated, update);
+        await vectorStore.updateVector(testIndexName, idToBeUpdated, update);
 
         await waitUntilVectorsIndexed(vectorStore, testIndexName, 3);
 
@@ -167,7 +167,7 @@ describe.skipIf(!process.env.UPSTASH_VECTOR_URL || !process.env.UPSTASH_VECTOR_T
           metadata: newMetaData,
         };
 
-        await expect(vectorStore.updateIndexById(testIndexName, 'id', update)).rejects.toThrow(
+        await expect(vectorStore.updateVector(testIndexName, 'id', update)).rejects.toThrow(
           'Both vector and metadata must be provided for an update',
         );
       });
@@ -183,7 +183,7 @@ describe.skipIf(!process.env.UPSTASH_VECTOR_URL || !process.env.UPSTASH_VECTOR_T
           vector: newVector,
         };
 
-        await vectorStore.updateIndexById(testIndexName, idToBeUpdated, update);
+        await vectorStore.updateVector(testIndexName, idToBeUpdated, update);
 
         await waitUntilVectorsIndexed(vectorStore, testIndexName, 3);
 
@@ -198,7 +198,7 @@ describe.skipIf(!process.env.UPSTASH_VECTOR_URL || !process.env.UPSTASH_VECTOR_T
       }, 500000);
 
       it('should throw exception when no updates are given', async () => {
-        await expect(vectorStore.updateIndexById(testIndexName, 'id', {})).rejects.toThrow('No update data provided');
+        await expect(vectorStore.updateVector(testIndexName, 'id', {})).rejects.toThrow('No update data provided');
       });
     });
 
@@ -214,7 +214,7 @@ describe.skipIf(!process.env.UPSTASH_VECTOR_URL || !process.env.UPSTASH_VECTOR_T
         expect(ids).toHaveLength(3);
         const idToBeDeleted = ids[0];
 
-        await vectorStore.deleteIndexById(testIndexName, idToBeDeleted);
+        await vectorStore.deleteVector(testIndexName, idToBeDeleted);
 
         const results: QueryResult[] = await vectorStore.query({
           indexName: testIndexName,

package/src/vector/index.ts

@@ -98,7 +98,42 @@ export class UpstashVector extends MastraVector {
     }
   }
 
+  /**
+   * @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.
+   * @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: {
@@ -106,42 +141,71 @@ export class UpstashVector extends MastraVector {
       metadata?: Record<string, any>;
     },
   ): Promise<void> {
-    if (!update.vector && !update.metadata) {
-      throw new Error('No update data provided');
-    }
-
-    // The upstash client throws an exception as: 'This index requires dense vectors' when
-    // only metadata is present in the update object.
-    if (!update.vector && update.metadata) {
-      throw new Error('Both vector and metadata must be provided for an update');
-    }
-
-    const updatePayload: any = { id: id };
-    if (update.vector) {
-      updatePayload.vector = update.vector;
-    }
-    if (update.metadata) {
-      updatePayload.metadata = update.metadata;
+    try {
+      if (!update.vector && !update.metadata) {
+        throw new Error('No update data provided');
+      }
+
+      // The upstash client throws an exception as: 'This index requires dense vectors' when
+      // only metadata is present in the update object.
+      if (!update.vector && update.metadata) {
+        throw new Error('Both vector and metadata must be provided for an update');
+      }
+
+      const updatePayload: any = { id: id };
+      if (update.vector) {
+        updatePayload.vector = update.vector;
+      }
+      if (update.metadata) {
+        updatePayload.metadata = update.metadata;
+      }
+
+      const points = {
+        id: updatePayload.id,
+        vector: updatePayload.vector,
+        metadata: updatePayload.metadata,
+      };
+
+      await this.client.upsert(points, {
+        namespace: indexName,
+      });
+    } catch (error: any) {
+      throw new Error(`Failed to update vector by id: ${id} for index name: ${indexName}: ${error.message}`);
     }
-
-    const points = {
-      id: updatePayload.id,
-      vector: updatePayload.vector,
-      metadata: updatePayload.metadata,
-    };
-
-    await this.client.upsert(points, {
-      namespace: indexName,
-    });
   }
 
+  /**
+   * @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.
+   * @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(id, {
         namespace: indexName,
       });
     } catch (error) {
-      console.error('Failed to delete index by ID:', error);
+      console.error(`Failed to delete vector by id: ${id} for index name: ${indexName}:`, error);
     }
   }
 }