@mastra/vectorize 0.2.10-alpha.4 → 0.2.11-alpha.0

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

@@ -1,11 +1,16 @@
 import { BaseFilterTranslator } from '@mastra/core/vector/filter';
 import Cloudflare from 'cloudflare';
 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 { 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 { UpdateVectorParams } from '@mastra/core/vector';
 import type { UpsertVectorParams } from '@mastra/core/vector';
 import type { VectorFilter } from '@mastra/core/vector/filter';
 
@@ -22,12 +27,15 @@ declare class CloudflareVector extends MastraVector {
     createIndex(...args: ParamsToArgs<CreateIndexParams>): Promise<void>;
     query(...args: ParamsToArgs<QueryVectorParams>): Promise<QueryResult[]>;
     listIndexes(): Promise<string[]>;
-    describeIndex(indexName: string): Promise<{
-        dimension: number;
-        count: number;
-        metric: "cosine" | "euclidean" | "dotproduct";
-    }>;
-    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>;
     createMetadataIndex(indexName: string, propertyName: string, indexType: 'string' | 'number' | 'boolean'): Promise<void>;
     deleteMetadataIndex(indexName: string, propertyName: string): Promise<void>;
     listMetadataIndexes(indexName: string): Promise<Cloudflare.Vectorize.Indexes.MetadataIndex.MetadataIndexListResponse.MetadataIndex[]>;
@@ -57,10 +65,7 @@ declare class CloudflareVector 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, update: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): Promise<void>;
+    updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void>;
     /**
      * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
      *
@@ -78,7 +83,7 @@ declare class CloudflareVector 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 { CloudflareVector }
 export { CloudflareVector as CloudflareVector_alias_1 }

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

@@ -1,11 +1,16 @@
 import { BaseFilterTranslator } from '@mastra/core/vector/filter';
 import Cloudflare from 'cloudflare';
 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 { 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 { UpdateVectorParams } from '@mastra/core/vector';
 import type { UpsertVectorParams } from '@mastra/core/vector';
 import type { VectorFilter } from '@mastra/core/vector/filter';
 
@@ -22,12 +27,15 @@ declare class CloudflareVector extends MastraVector {
     createIndex(...args: ParamsToArgs<CreateIndexParams>): Promise<void>;
     query(...args: ParamsToArgs<QueryVectorParams>): Promise<QueryResult[]>;
     listIndexes(): Promise<string[]>;
-    describeIndex(indexName: string): Promise<{
-        dimension: number;
-        count: number;
-        metric: "cosine" | "euclidean" | "dotproduct";
-    }>;
-    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>;
     createMetadataIndex(indexName: string, propertyName: string, indexType: 'string' | 'number' | 'boolean'): Promise<void>;
     deleteMetadataIndex(indexName: string, propertyName: string): Promise<void>;
     listMetadataIndexes(indexName: string): Promise<Cloudflare.Vectorize.Indexes.MetadataIndex.MetadataIndexListResponse.MetadataIndex[]>;
@@ -57,10 +65,7 @@ declare class CloudflareVector 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, update: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): Promise<void>;
+    updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void>;
     /**
      * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
      *
@@ -78,7 +83,7 @@ declare class CloudflareVector 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 { CloudflareVector }
 export { CloudflareVector as CloudflareVector_alias_1 }

package/dist/index.cjs

@@ -152,7 +152,16 @@ var CloudflareVector = class extends vector.MastraVector {
     });
     return res?.result?.map((index) => index.name) || [];
   }
-  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;
     const index = await this.client.vectorize.indexes.get(indexName, {
       account_id: this.accountId
     });
@@ -167,7 +176,9 @@ var CloudflareVector = class extends vector.MastraVector {
       metric: index?.config?.metric
     };
   }
-  async deleteIndex(indexName) {
+  async deleteIndex(...args) {
+    const params = this.normalizeArgs("deleteIndex", args);
+    const { indexName } = params;
     await this.client.vectorize.indexes.delete(indexName, {
       account_id: this.accountId
     });
@@ -209,7 +220,7 @@ var CloudflareVector = class extends vector.MastraVector {
       Please use updateVector() instead. 
       updateIndexById() will be removed on May 20th, 2025.`
     );
-    await this.updateVector(indexName, id, update);
+    await this.updateVector({ indexName, id, update });
   }
   /**
    * Updates a vector by its ID with the provided vector and/or metadata.
@@ -221,7 +232,9 @@ var CloudflareVector = 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, update) {
+  async updateVector(...args) {
+    const params = this.normalizeArgs("updateVector", args);
+    const { indexName, id, update } = params;
     try {
       if (!update.vector && !update.metadata) {
         throw new Error("No update data provided");
@@ -254,7 +267,7 @@ var CloudflareVector = class extends vector.MastraVector {
       Please use deleteVector() instead. 
       deleteIndexById() will be removed on May 20th, 2025.`
     );
-    await this.deleteVector(indexName, id);
+    await this.deleteVector({ indexName, id });
   }
   /**
    * Deletes a vector by its ID.
@@ -263,7 +276,9 @@ var CloudflareVector = 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 {
       await this.client.vectorize.indexes.deleteByIds(indexName, {
         ids: [id],

package/dist/index.js

@@ -146,7 +146,16 @@ var CloudflareVector = class extends MastraVector {
     });
     return res?.result?.map((index) => index.name) || [];
   }
-  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;
     const index = await this.client.vectorize.indexes.get(indexName, {
       account_id: this.accountId
     });
@@ -161,7 +170,9 @@ var CloudflareVector = class extends MastraVector {
       metric: index?.config?.metric
     };
   }
-  async deleteIndex(indexName) {
+  async deleteIndex(...args) {
+    const params = this.normalizeArgs("deleteIndex", args);
+    const { indexName } = params;
     await this.client.vectorize.indexes.delete(indexName, {
       account_id: this.accountId
     });
@@ -203,7 +214,7 @@ var CloudflareVector = class extends MastraVector {
       Please use updateVector() instead. 
       updateIndexById() will be removed on May 20th, 2025.`
     );
-    await this.updateVector(indexName, id, update);
+    await this.updateVector({ indexName, id, update });
   }
   /**
    * Updates a vector by its ID with the provided vector and/or metadata.
@@ -215,7 +226,9 @@ var CloudflareVector = 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, update) {
+  async updateVector(...args) {
+    const params = this.normalizeArgs("updateVector", args);
+    const { indexName, id, update } = params;
     try {
       if (!update.vector && !update.metadata) {
         throw new Error("No update data provided");
@@ -248,7 +261,7 @@ var CloudflareVector = class extends MastraVector {
       Please use deleteVector() instead. 
       deleteIndexById() will be removed on May 20th, 2025.`
     );
-    await this.deleteVector(indexName, id);
+    await this.deleteVector({ indexName, id });
   }
   /**
    * Deletes a vector by its ID.
@@ -257,7 +270,9 @@ var CloudflareVector = 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 {
       await this.client.vectorize.indexes.deleteByIds(indexName, {
         ids: [id],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/vectorize",
-  "version": "0.2.10-alpha.4",
+  "version": "0.2.11-alpha.0",
   "description": "Cloudflare Vectorize store provider for Mastra",
   "type": "module",
   "files": [
@@ -24,7 +24,7 @@
   "license": "MIT",
   "dependencies": {
     "cloudflare": "^4.1.0",
-    "@mastra/core": "^0.9.4-alpha.4"
+    "@mastra/core": "^0.9.5-alpha.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.52.5",
@@ -34,7 +34,7 @@
     "tsup": "^8.4.0",
     "typescript": "^5.8.2",
     "vitest": "^3.1.2",
-    "@internal/lint": "0.0.4"
+    "@internal/lint": "0.0.5"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --experimental-dts --clean --treeshake=smallest --splitting",