@mastra/turbopuffer 0.0.15 → 0.0.16-alpha.0

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

@@ -1,12 +1,17 @@
 import { BaseFilterTranslator } from '@mastra/core/vector/filter';
 import type { CreateIndexParams } from '@mastra/core/vector';
+import type { DeleteIndexParams } from '@mastra/core/vector';
+import type { DeleteVectorParams } from '@mastra/core/vector';
+import type { DescribeIndexParams } from '@mastra/core/vector';
 import type { Filters } from '@turbopuffer/turbopuffer';
 import type { IndexStats } from '@mastra/core/vector';
 import { MastraVector } from '@mastra/core/vector';
 import type { OperatorSupport } from '@mastra/core/vector/filter';
+import type { ParamsToArgs } from '@mastra/core/vector';
 import type { QueryResult } from '@mastra/core/vector';
 import type { QueryVectorParams } from '@mastra/core/vector';
 import type { Schema } from '@turbopuffer/turbopuffer';
+import type { UpdateVectorParams } from '@mastra/core/vector';
 import type { UpsertVectorParams } from '@mastra/core/vector';
 import type { VectorFilter } from '@mastra/core/vector/filter';
 
@@ -62,8 +67,15 @@ declare class TurbopufferVector extends MastraVector {
     upsert({ indexName, vectors, metadata, ids }: UpsertVectorParams): Promise<string[]>;
     query({ indexName, queryVector, topK, filter, includeVector }: QueryVectorParams): Promise<QueryResult[]>;
     listIndexes(): Promise<string[]>;
-    describeIndex(indexName: string): Promise<IndexStats>;
-    deleteIndex(indexName: string): Promise<void>;
+    /**
+     * Retrieves statistics about a vector index.
+     *
+     * @param params - The parameters for describing an index
+     * @param params.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>;
+    deleteIndex(...args: ParamsToArgs<DeleteIndexParams>): 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.
@@ -74,10 +86,7 @@ declare class TurbopufferVector 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.
      */
-    updateVector(indexName: string, id: string, updates: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): Promise<void>;
+    updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void>;
     /**
      * Deletes a vector by its ID.
      * @param indexName - The name of the index containing the vector.
@@ -85,7 +94,7 @@ declare class TurbopufferVector 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(...args: ParamsToArgs<DeleteVectorParams>): Promise<void>;
 }
 export { TurbopufferVector }
 export { TurbopufferVector as TurbopufferVector_alias_1 }

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

@@ -1,12 +1,17 @@
 import { BaseFilterTranslator } from '@mastra/core/vector/filter';
 import type { CreateIndexParams } from '@mastra/core/vector';
+import type { DeleteIndexParams } from '@mastra/core/vector';
+import type { DeleteVectorParams } from '@mastra/core/vector';
+import type { DescribeIndexParams } from '@mastra/core/vector';
 import type { Filters } from '@turbopuffer/turbopuffer';
 import type { IndexStats } from '@mastra/core/vector';
 import { MastraVector } from '@mastra/core/vector';
 import type { OperatorSupport } from '@mastra/core/vector/filter';
+import type { ParamsToArgs } from '@mastra/core/vector';
 import type { QueryResult } from '@mastra/core/vector';
 import type { QueryVectorParams } from '@mastra/core/vector';
 import type { Schema } from '@turbopuffer/turbopuffer';
+import type { UpdateVectorParams } from '@mastra/core/vector';
 import type { UpsertVectorParams } from '@mastra/core/vector';
 import type { VectorFilter } from '@mastra/core/vector/filter';
 
@@ -62,8 +67,15 @@ declare class TurbopufferVector extends MastraVector {
     upsert({ indexName, vectors, metadata, ids }: UpsertVectorParams): Promise<string[]>;
     query({ indexName, queryVector, topK, filter, includeVector }: QueryVectorParams): Promise<QueryResult[]>;
     listIndexes(): Promise<string[]>;
-    describeIndex(indexName: string): Promise<IndexStats>;
-    deleteIndex(indexName: string): Promise<void>;
+    /**
+     * Retrieves statistics about a vector index.
+     *
+     * @param params - The parameters for describing an index
+     * @param params.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>;
+    deleteIndex(...args: ParamsToArgs<DeleteIndexParams>): 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.
@@ -74,10 +86,7 @@ declare class TurbopufferVector 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.
      */
-    updateVector(indexName: string, id: string, updates: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): Promise<void>;
+    updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void>;
     /**
      * Deletes a vector by its ID.
      * @param indexName - The name of the index containing the vector.
@@ -85,7 +94,7 @@ declare class TurbopufferVector 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(...args: ParamsToArgs<DeleteVectorParams>): Promise<void>;
 }
 export { TurbopufferVector }
 export { TurbopufferVector as TurbopufferVector_alias_1 }

package/dist/index.cjs

@@ -303,7 +303,16 @@ var TurbopufferVector = class extends vector.MastraVector {
       throw new Error(`Failed to list Turbopuffer namespaces: ${error}`);
     }
   }
-  async describeIndex(indexName) {
+  /**
+   * Retrieves statistics about a vector index.
+   *
+   * @param params - The parameters for describing an index
+   * @param params.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;
     try {
       const namespace = this.client.namespace(indexName);
       const metadata = await namespace.metadata();
@@ -322,7 +331,9 @@ var TurbopufferVector = class extends vector.MastraVector {
       throw new Error(`Failed to describe Turbopuffer namespace ${indexName}: ${error}`);
     }
   }
-  async deleteIndex(indexName) {
+  async deleteIndex(...args) {
+    const params = this.normalizeArgs("deleteIndex", args);
+    const { indexName } = params;
     try {
       const namespace = this.client.namespace(indexName);
       await namespace.deleteAll();
@@ -341,7 +352,9 @@ var TurbopufferVector = 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(indexName, id, updates) {
+  async updateVector(...args) {
+    const params = this.normalizeArgs("updateVector", args);
+    const { indexName, id, update } = params;
     try {
       const namespace = this.client.namespace(indexName);
       const createIndex = this.createIndexCache.get(indexName);
@@ -350,8 +363,8 @@ var TurbopufferVector = class extends vector.MastraVector {
       }
       const distanceMetric = createIndex.tpufDistanceMetric;
       const record = { id };
-      if (updates.vector) record.vector = updates.vector;
-      if (updates.metadata) record.attributes = updates.metadata;
+      if (update.vector) record.vector = update.vector;
+      if (update.metadata) record.attributes = update.metadata;
       await namespace.upsert({
         vectors: [record],
         distance_metric: distanceMetric
@@ -367,7 +380,9 @@ var TurbopufferVector = 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(...args) {
+    const params = this.normalizeArgs("deleteVector", args);
+    const { indexName, id } = params;
     try {
       const namespace = this.client.namespace(indexName);
       await namespace.delete({ ids: [id] });

package/dist/index.js

@@ -301,7 +301,16 @@ var TurbopufferVector = class extends MastraVector {
       throw new Error(`Failed to list Turbopuffer namespaces: ${error}`);
     }
   }
-  async describeIndex(indexName) {
+  /**
+   * Retrieves statistics about a vector index.
+   *
+   * @param params - The parameters for describing an index
+   * @param params.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;
     try {
       const namespace = this.client.namespace(indexName);
       const metadata = await namespace.metadata();
@@ -320,7 +329,9 @@ var TurbopufferVector = class extends MastraVector {
       throw new Error(`Failed to describe Turbopuffer namespace ${indexName}: ${error}`);
     }
   }
-  async deleteIndex(indexName) {
+  async deleteIndex(...args) {
+    const params = this.normalizeArgs("deleteIndex", args);
+    const { indexName } = params;
     try {
       const namespace = this.client.namespace(indexName);
       await namespace.deleteAll();
@@ -339,7 +350,9 @@ var TurbopufferVector = 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(indexName, id, updates) {
+  async updateVector(...args) {
+    const params = this.normalizeArgs("updateVector", args);
+    const { indexName, id, update } = params;
     try {
       const namespace = this.client.namespace(indexName);
       const createIndex = this.createIndexCache.get(indexName);
@@ -348,8 +361,8 @@ var TurbopufferVector = class extends MastraVector {
       }
       const distanceMetric = createIndex.tpufDistanceMetric;
       const record = { id };
-      if (updates.vector) record.vector = updates.vector;
-      if (updates.metadata) record.attributes = updates.metadata;
+      if (update.vector) record.vector = update.vector;
+      if (update.metadata) record.attributes = update.metadata;
       await namespace.upsert({
         vectors: [record],
         distance_metric: distanceMetric
@@ -365,7 +378,9 @@ var TurbopufferVector = 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(...args) {
+    const params = this.normalizeArgs("deleteVector", args);
+    const { indexName, id } = params;
     try {
       const namespace = this.client.namespace(indexName);
       await namespace.delete({ ids: [id] });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/turbopuffer",
-  "version": "0.0.15",
+  "version": "0.0.16-alpha.0",
   "description": "Turbopuffer vector store provider for Mastra",
   "type": "module",
   "files": [
@@ -24,7 +24,7 @@
   "license": "MIT",
   "dependencies": {
     "@turbopuffer/turbopuffer": "^0.6.4",
-    "@mastra/core": "^0.9.4"
+    "@mastra/core": "^0.9.5-alpha.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.52.5",