@supabase/storage-js 2.84.0 → 2.84.1-canary.0

package/dist/main/lib/vectors/VectorDataApi.js

@@ -6,102 +6,24 @@ const errors_1 = require("./errors");
 const fetch_1 = require("./fetch");
 const helpers_1 = require("./helpers");
 /**
- *
- * @alpha
- *
- * API class for managing Vector Data within Vector Indexes
- * Provides methods for inserting, querying, listing, and deleting vector embeddings
- *
- * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
+ * @hidden
+ * Base implementation for vector data operations.
+ * Use {@link VectorIndexScope} via `supabase.storage.vectors.from('bucket').index('idx')` instead.
  */
 class VectorDataApi {
-    /**
-     *
-     * @alpha
-     *
-     * Creates a VectorDataApi bound to a Storage Vectors deployment.
-     *
-     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
-     *
-     * @category Vector Buckets
-     * @param url - Base URL for the Storage Vectors API.
-     * @param headers - Default headers (for example authentication tokens).
-     * @param fetch - Optional custom `fetch` implementation for non-browser runtimes.
-     *
-     * @example
-     * ```typescript
-     * const client = new VectorDataApi(url, headers)
-     * ```
-     */
+    /** Creates a new VectorDataApi instance */
     constructor(url, headers = {}, fetch) {
         this.shouldThrowOnError = false;
         this.url = url.replace(/\/$/, '');
         this.headers = Object.assign(Object.assign({}, constants_1.DEFAULT_HEADERS), headers);
         this.fetch = (0, helpers_1.resolveFetch)(fetch);
     }
-    /**
-     *
-     * @alpha
-     *
-     * Enable throwing errors instead of returning them in the response
-     * When enabled, failed operations will throw instead of returning { data: null, error }
-     *
-     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
-     *
-     * @category Vector Buckets
-     * @returns This instance for method chaining
-     * @example
-     * ```typescript
-     * const client = new VectorDataApi(url, headers)
-     * client.throwOnError()
-     * const { data } = await client.putVectors(options) // throws on error
-     * ```
-     */
+    /** Enable throwing errors instead of returning them in the response */
     throwOnError() {
         this.shouldThrowOnError = true;
         return this;
     }
-    /**
-     *
-     * @alpha
-     *
-     * Inserts or updates vectors in batch (upsert operation)
-     * Accepts 1-500 vectors per request. Larger batches should be split
-     *
-     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
-     *
-     * @category Vector Buckets
-     * @param options - Vector insertion options
-     * @param options.vectorBucketName - Name of the parent vector bucket
-     * @param options.indexName - Name of the target index
-     * @param options.vectors - Array of vectors to insert/update (1-500 items)
-     * @returns Promise with empty response on success or error
-     *
-     * @throws {StorageVectorsApiError} With code:
-     * - `S3VectorConflictException` if duplicate key conflict occurs (HTTP 409)
-     * - `S3VectorNotFoundException` if bucket or index doesn't exist (HTTP 404)
-     * - `InternalError` for server errors (HTTP 500)
-     *
-     * @example
-     * ```typescript
-     * const { data, error } = await client.putVectors({
-     *   vectorBucketName: 'embeddings-prod',
-     *   indexName: 'documents-openai-small',
-     *   vectors: [
-     *     {
-     *       key: 'doc-1',
-     *       data: { float32: [0.1, 0.2, 0.3, ...] }, // 1536 dimensions
-     *       metadata: { title: 'Introduction', page: 1 }
-     *     },
-     *     {
-     *       key: 'doc-2',
-     *       data: { float32: [0.4, 0.5, 0.6, ...] },
-     *       metadata: { title: 'Conclusion', page: 42 }
-     *     }
-     *   ]
-     * })
-     * ```
-     */
+    /** Inserts or updates vectors in batch (1-500 per request) */
     putVectors(options) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             try {
@@ -125,43 +47,7 @@ class VectorDataApi {
             }
         });
     }
-    /**
-     *
-     * @alpha
-     *
-     * Retrieves vectors by their keys in batch
-     * Optionally includes vector data and/or metadata in response
-     * Additional permissions required when returning data or metadata
-     *
-     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
-     *
-     * @category Vector Buckets
-     * @param options - Vector retrieval options
-     * @param options.vectorBucketName - Name of the parent vector bucket
-     * @param options.indexName - Name of the index
-     * @param options.keys - Array of vector keys to retrieve
-     * @param options.returnData - Whether to include vector embeddings (requires permission)
-     * @param options.returnMetadata - Whether to include metadata (requires permission)
-     * @returns Promise with array of vectors or error
-     *
-     * @throws {StorageVectorsApiError} With code:
-     * - `S3VectorNotFoundException` if bucket or index doesn't exist (HTTP 404)
-     * - `InternalError` for server errors (HTTP 500)
-     *
-     * @example
-     * ```typescript
-     * const { data, error } = await client.getVectors({
-     *   vectorBucketName: 'embeddings-prod',
-     *   indexName: 'documents-openai-small',
-     *   keys: ['doc-1', 'doc-2', 'doc-3'],
-     *   returnData: false,     // Don't return embeddings
-     *   returnMetadata: true   // Return metadata only
-     * })
-     * if (data) {
-     *   data.vectors.forEach(v => console.log(v.key, v.metadata))
-     * }
-     * ```
-     */
+    /** Retrieves vectors by their keys in batch */
     getVectors(options) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             try {
@@ -181,63 +67,7 @@ class VectorDataApi {
             }
         });
     }
-    /**
-     *
-     * @alpha
-     *
-     * Lists/scans vectors in an index with pagination
-     * Supports parallel scanning via segment configuration for high-throughput scenarios
-     * Additional permissions required when returning data or metadata
-     *
-     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
-     *
-     * @category Vector Buckets
-     * @param options - Vector listing options
-     * @param options.vectorBucketName - Name of the parent vector bucket
-     * @param options.indexName - Name of the index
-     * @param options.maxResults - Maximum results per page (default: 500, max: 1000)
-     * @param options.nextToken - Pagination token from previous response
-     * @param options.returnData - Whether to include vector embeddings (requires permission)
-     * @param options.returnMetadata - Whether to include metadata (requires permission)
-     * @param options.segmentCount - Total parallel segments (1-16) for distributed scanning
-     * @param options.segmentIndex - Zero-based segment index (0 to segmentCount-1)
-     * @returns Promise with array of vectors, pagination token, or error
-     *
-     * @throws {StorageVectorsApiError} With code:
-     * - `S3VectorNotFoundException` if bucket or index doesn't exist (HTTP 404)
-     * - `InternalError` for server errors (HTTP 500)
-     *
-     * @example
-     * ```typescript
-     * // Simple pagination
-     * let nextToken: string | undefined
-     * do {
-     *   const { data, error } = await client.listVectors({
-     *     vectorBucketName: 'embeddings-prod',
-     *     indexName: 'documents-openai-small',
-     *     maxResults: 500,
-     *     nextToken,
-     *     returnMetadata: true
-     *   })
-     *   if (error) break
-     *   console.log('Batch:', data.vectors.length)
-     *   nextToken = data.nextToken
-     * } while (nextToken)
-     *
-     * // Parallel scanning (4 concurrent workers)
-     * const workers = [0, 1, 2, 3].map(async (segmentIndex) => {
-     *   const { data } = await client.listVectors({
-     *     vectorBucketName: 'embeddings-prod',
-     *     indexName: 'documents-openai-small',
-     *     segmentCount: 4,
-     *     segmentIndex,
-     *     returnMetadata: true
-     *   })
-     *   return data?.vectors || []
-     * })
-     * const results = await Promise.all(workers)
-     * ```
-     */
+    /** Lists vectors in an index with pagination */
     listVectors(options) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             try {
@@ -268,54 +98,7 @@ class VectorDataApi {
             }
         });
     }
-    /**
-     *
-     * @alpha
-     *
-     * Queries for similar vectors using approximate nearest neighbor (ANN) search
-     * Returns top-K most similar vectors based on the configured distance metric
-     * Supports optional metadata filtering (requires GetVectors permission)
-     *
-     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
-     *
-     * @category Vector Buckets
-     * @param options - Query options
-     * @param options.vectorBucketName - Name of the parent vector bucket
-     * @param options.indexName - Name of the index
-     * @param options.queryVector - Query embedding to find similar vectors
-     * @param options.topK - Number of nearest neighbors to return (default: 10)
-     * @param options.filter - Optional JSON filter for metadata (requires GetVectors permission)
-     * @param options.returnDistance - Whether to include similarity distances
-     * @param options.returnMetadata - Whether to include metadata (requires GetVectors permission)
-     * @returns Promise with array of similar vectors ordered by distance
-     *
-     * @throws {StorageVectorsApiError} With code:
-     * - `S3VectorNotFoundException` if bucket or index doesn't exist (HTTP 404)
-     * - `InternalError` for server errors (HTTP 500)
-     *
-     * @example
-     * ```typescript
-     * // Semantic search with filtering
-     * const { data, error } = await client.queryVectors({
-     *   vectorBucketName: 'embeddings-prod',
-     *   indexName: 'documents-openai-small',
-     *   queryVector: { float32: [0.1, 0.2, 0.3, ...] }, // 1536 dimensions
-     *   topK: 5,
-     *   filter: {
-     *     category: 'technical',
-     *     published: true
-     *   },
-     *   returnDistance: true,
-     *   returnMetadata: true
-     * })
-     * if (data) {
-     *   data.matches.forEach(match => {
-     *     console.log(`${match.key}: distance=${match.distance}`)
-     *     console.log('Metadata:', match.metadata)
-     *   })
-     * }
-     * ```
-     */
+    /** Queries for similar vectors using approximate nearest neighbor search */
     queryVectors(options) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             try {
@@ -335,38 +118,7 @@ class VectorDataApi {
             }
         });
     }
-    /**
-     *
-     * @alpha
-     *
-     * Deletes vectors by their keys in batch
-     * Accepts 1-500 keys per request
-     *
-     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
-     *
-     * @category Vector Buckets
-     * @param options - Vector deletion options
-     * @param options.vectorBucketName - Name of the parent vector bucket
-     * @param options.indexName - Name of the index
-     * @param options.keys - Array of vector keys to delete (1-500 items)
-     * @returns Promise with empty response on success or error
-     *
-     * @throws {StorageVectorsApiError} With code:
-     * - `S3VectorNotFoundException` if bucket or index doesn't exist (HTTP 404)
-     * - `InternalError` for server errors (HTTP 500)
-     *
-     * @example
-     * ```typescript
-     * const { error } = await client.deleteVectors({
-     *   vectorBucketName: 'embeddings-prod',
-     *   indexName: 'documents-openai-small',
-     *   keys: ['doc-1', 'doc-2', 'doc-3']
-     * })
-     * if (!error) {
-     *   console.log('Vectors deleted successfully')
-     * }
-     * ```
-     */
+    /** Deletes vectors by their keys in batch (1-500 per request) */
     deleteVectors(options) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             try {

package/dist/main/lib/vectors/VectorDataApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"VectorDataApi.js","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorDataApi.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,qCAAgD;AAChD,mCAAqC;AACrC,uCAAwC;AAaxC;;;;;;;;GAQG;AACH,MAAqB,aAAa;IAMhC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,GAAW,EAAE,UAAqC,EAAE,EAAE,KAAa;QApBrE,uBAAkB,GAAG,KAAK,CAAA;QAqBlC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACjC,IAAI,CAAC,OAAO,mCAAQ,2BAAe,GAAK,OAAO,CAAE,CAAA;QACjD,IAAI,CAAC,KAAK,GAAG,IAAA,sBAAY,EAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,YAAY;QACjB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAA;QAC9B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACG,UAAU,CAAC,OAA0B;;YACzC,IAAI,CAAC;gBACH,sBAAsB;gBACtB,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;oBAC/D,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;gBACtE,CAAC;gBAED,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,aAAa,EAAE,OAAO,EAAE;oBACrE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC1C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACG,UAAU,CAAC,OAA0B;;YACzC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,aAAa,EAAE,OAAO,EAAE;oBACrE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC9B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;IACG,WAAW,CAAC,OAA2B;;YAC3C,IAAI,CAAC;gBACH,iCAAiC;gBACjC,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;oBACvC,IAAI,OAAO,CAAC,YAAY,GAAG,CAAC,IAAI,OAAO,CAAC,YAAY,GAAG,EAAE,EAAE,CAAC;wBAC1D,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;oBAC1D,CAAC;oBACD,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;wBACvC,IAAI,OAAO,CAAC,YAAY,GAAG,CAAC,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;4BAC7E,MAAM,IAAI,KAAK,CAAC,sCAAsC,OAAO,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC,CAAA;wBACnF,CAAC;oBACH,CAAC;gBACH,CAAC;gBAED,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,cAAc,EAAE,OAAO,EAAE;oBACtE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC9B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACG,YAAY,CAAC,OAA4B;;YAC7C,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,eAAe,EAAE,OAAO,EAAE;oBACvE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC9B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,aAAa,CAAC,OAA6B;;YAC/C,IAAI,CAAC;gBACH,sBAAsB;gBACtB,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;oBACzD,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;gBACpE,CAAC;gBAED,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,gBAAgB,EAAE,OAAO,EAAE;oBACxE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC1C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;CACF;AAtXD,gCAsXC"}
+{"version":3,"file":"VectorDataApi.js","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorDataApi.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,qCAAgD;AAChD,mCAAqC;AACrC,uCAAwC;AAaxC;;;;GAIG;AACH,MAAqB,aAAa;IAMhC,2CAA2C;IAC3C,YAAY,GAAW,EAAE,UAAqC,EAAE,EAAE,KAAa;QAHrE,uBAAkB,GAAG,KAAK,CAAA;QAIlC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACjC,IAAI,CAAC,OAAO,mCAAQ,2BAAe,GAAK,OAAO,CAAE,CAAA;QACjD,IAAI,CAAC,KAAK,GAAG,IAAA,sBAAY,EAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IAED,uEAAuE;IAChE,YAAY;QACjB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAA;QAC9B,OAAO,IAAI,CAAA;IACb,CAAC;IAED,8DAA8D;IACxD,UAAU,CAAC,OAA0B;;YACzC,IAAI,CAAC;gBACH,sBAAsB;gBACtB,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;oBAC/D,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;gBACtE,CAAC;gBAED,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,aAAa,EAAE,OAAO,EAAE;oBACrE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC1C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED,+CAA+C;IACzC,UAAU,CAAC,OAA0B;;YACzC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,aAAa,EAAE,OAAO,EAAE;oBACrE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC9B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED,gDAAgD;IAC1C,WAAW,CAAC,OAA2B;;YAC3C,IAAI,CAAC;gBACH,iCAAiC;gBACjC,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;oBACvC,IAAI,OAAO,CAAC,YAAY,GAAG,CAAC,IAAI,OAAO,CAAC,YAAY,GAAG,EAAE,EAAE,CAAC;wBAC1D,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;oBAC1D,CAAC;oBACD,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;wBACvC,IAAI,OAAO,CAAC,YAAY,GAAG,CAAC,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;4BAC7E,MAAM,IAAI,KAAK,CAAC,sCAAsC,OAAO,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC,CAAA;wBACnF,CAAC;oBACH,CAAC;gBACH,CAAC;gBAED,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,cAAc,EAAE,OAAO,EAAE;oBACtE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC9B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED,4EAA4E;IACtE,YAAY,CAAC,OAA4B;;YAC7C,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,eAAe,EAAE,OAAO,EAAE;oBACvE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC9B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED,iEAAiE;IAC3D,aAAa,CAAC,OAA6B;;YAC/C,IAAI,CAAC;gBACH,sBAAsB;gBACtB,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;oBACzD,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;gBACpE,CAAC;gBAED,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,gBAAgB,EAAE,OAAO,EAAE;oBACxE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC1C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;CACF;AAlID,gCAkIC"}

package/dist/main/lib/vectors/VectorIndexApi.d.ts

@@ -1,7 +1,6 @@
 import { Fetch } from './fetch';
 import { ApiResponse, VectorIndex, ListIndexesOptions, ListIndexesResponse, VectorDataType, DistanceMetric, MetadataConfiguration } from './types';
 /**
- *
  * @alpha
  *
  * Options for creating a vector index
@@ -17,13 +16,9 @@ export interface CreateIndexOptions {
     metadataConfiguration?: MetadataConfiguration;
 }
 /**
- *
- * @alpha
- *
- * API class for managing Vector Indexes within Vector Buckets
- * Provides methods for creating, reading, listing, and deleting vector indexes
- *
- * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
+ * @hidden
+ * Base implementation for vector index operations.
+ * Use {@link VectorBucketScope} via `supabase.storage.vectors.from('bucket')` instead.
  */
 export default class VectorIndexApi {
     protected url: string;
@@ -32,184 +27,21 @@ export default class VectorIndexApi {
     };
     protected fetch: Fetch;
     protected shouldThrowOnError: boolean;
-    /**
-     *
-     * @alpha
-     *
-     * Creates an API client for managing vector indexes.
-     *
-     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
-     *
-     * @category Vector Buckets
-     * @param url - Base URL for the Storage Vectors API.
-     * @param headers - Default headers sent with each request.
-     * @param fetch - Optional custom `fetch` implementation for non-browser runtimes.
-     *
-     * @example
-     * ```typescript
-     * const client = new VectorIndexApi(url, headers)
-     * ```
-     */
+    /** Creates a new VectorIndexApi instance */
     constructor(url: string, headers?: {
         [key: string]: string;
     }, fetch?: Fetch);
-    /**
-     *
-     * @alpha
-     *
-     * Enable throwing errors instead of returning them in the response
-     * When enabled, failed operations will throw instead of returning { data: null, error }
-     *
-     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
-     *
-     * @category Vector Buckets
-     * @returns This instance for method chaining
-     * @example
-     * ```typescript
-     * const client = new VectorIndexApi(url, headers)
-     * client.throwOnError()
-     * const { data } = await client.createIndex(options) // throws on error
-     * ```
-     */
+    /** Enable throwing errors instead of returning them in the response */
     throwOnError(): this;
-    /**
-     *
-     * @alpha
-     *
-     * Creates a new vector index within a bucket
-     * Defines the schema for vectors including dimensionality, distance metric, and metadata config
-     *
-     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
-     *
-     * @category Vector Buckets
-     * @param options - Index configuration
-     * @param options.vectorBucketName - Name of the parent vector bucket
-     * @param options.indexName - Unique name for the index within the bucket
-     * @param options.dataType - Data type for vector components (currently only 'float32')
-     * @param options.dimension - Dimensionality of vectors (e.g., 384, 768, 1536)
-     * @param options.distanceMetric - Similarity metric ('cosine', 'euclidean', 'dotproduct')
-     * @param options.metadataConfiguration - Optional config for non-filterable metadata keys
-     * @returns Promise with empty response on success or error
-     *
-     * @throws {StorageVectorsApiError} With code:
-     * - `S3VectorConflictException` if index already exists (HTTP 409)
-     * - `S3VectorMaxIndexesExceeded` if quota exceeded (HTTP 400)
-     * - `S3VectorNotFoundException` if bucket doesn't exist (HTTP 404)
-     * - `InternalError` for server errors (HTTP 500)
-     *
-     * @example
-     * ```typescript
-     * const { data, error } = await client.createIndex({
-     *   vectorBucketName: 'embeddings-prod',
-     *   indexName: 'documents-openai-small',
-     *   dataType: 'float32',
-     *   dimension: 1536,
-     *   distanceMetric: 'cosine',
-     *   metadataConfiguration: {
-     *     nonFilterableMetadataKeys: ['raw_text', 'internal_id']
-     *   }
-     * })
-     * ```
-     */
+    /** Creates a new vector index within a bucket */
     createIndex(options: CreateIndexOptions): Promise<ApiResponse<undefined>>;
-    /**
-     *
-     * @alpha
-     *
-     * Retrieves metadata for a specific vector index
-     * Returns index configuration including dimension, distance metric, and metadata settings
-     *
-     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
-     *
-     * @category Vector Buckets
-     * @param vectorBucketName - Name of the parent vector bucket
-     * @param indexName - Name of the index to retrieve
-     * @returns Promise with index metadata or error
-     *
-     * @throws {StorageVectorsApiError} With code:
-     * - `S3VectorNotFoundException` if index or bucket doesn't exist (HTTP 404)
-     * - `InternalError` for server errors (HTTP 500)
-     *
-     * @example
-     * ```typescript
-     * const { data, error } = await client.getIndex('embeddings-prod', 'documents-openai-small')
-     * if (data) {
-     *   console.log('Index dimension:', data.index.dimension)
-     *   console.log('Distance metric:', data.index.distanceMetric)
-     * }
-     * ```
-     */
+    /** Retrieves metadata for a specific vector index */
     getIndex(vectorBucketName: string, indexName: string): Promise<ApiResponse<{
         index: VectorIndex;
     }>>;
-    /**
-     *
-     * @alpha
-     *
-     * Lists vector indexes within a bucket with optional filtering and pagination
-     * Supports prefix-based filtering and paginated results
-     *
-     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
-     *
-     * @category Vector Buckets
-     * @param options - Listing options
-     * @param options.vectorBucketName - Name of the parent vector bucket
-     * @param options.prefix - Filter indexes by name prefix
-     * @param options.maxResults - Maximum results per page (default: 100)
-     * @param options.nextToken - Pagination token from previous response
-     * @returns Promise with list of indexes and pagination token
-     *
-     * @throws {StorageVectorsApiError} With code:
-     * - `S3VectorNotFoundException` if bucket doesn't exist (HTTP 404)
-     * - `InternalError` for server errors (HTTP 500)
-     *
-     * @example
-     * ```typescript
-     * // List all indexes in a bucket
-     * const { data, error } = await client.listIndexes({
-     *   vectorBucketName: 'embeddings-prod',
-     *   prefix: 'documents-'
-     * })
-     * if (data) {
-     *   console.log('Found indexes:', data.indexes.map(i => i.indexName))
-     *   // Fetch next page if available
-     *   if (data.nextToken) {
-     *     const next = await client.listIndexes({
-     *       vectorBucketName: 'embeddings-prod',
-     *       nextToken: data.nextToken
-     *     })
-     *   }
-     * }
-     * ```
-     */
+    /** Lists vector indexes within a bucket with optional filtering and pagination */
     listIndexes(options: ListIndexesOptions): Promise<ApiResponse<ListIndexesResponse>>;
-    /**
-     *
-     * @alpha
-     *
-     * Deletes a vector index and all its data
-     * This operation removes the index schema and all vectors stored in the index
-     *
-     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
-     *
-     * @category Vector Buckets
-     * @param vectorBucketName - Name of the parent vector bucket
-     * @param indexName - Name of the index to delete
-     * @returns Promise with empty response on success or error
-     *
-     * @throws {StorageVectorsApiError} With code:
-     * - `S3VectorNotFoundException` if index or bucket doesn't exist (HTTP 404)
-     * - `InternalError` for server errors (HTTP 500)
-     *
-     * @example
-     * ```typescript
-     * // Delete an index and all its vectors
-     * const { error } = await client.deleteIndex('embeddings-prod', 'old-index')
-     * if (!error) {
-     *   console.log('Index deleted successfully')
-     * }
-     * ```
-     */
+    /** Deletes a vector index and all its data */
     deleteIndex(vectorBucketName: string, indexName: string): Promise<ApiResponse<undefined>>;
 }
 //# sourceMappingURL=VectorIndexApi.d.ts.map

package/dist/main/lib/vectors/VectorIndexApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"VectorIndexApi.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorIndexApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAQ,MAAM,SAAS,CAAA;AAErC,OAAO,EACL,WAAW,EACX,WAAW,EACX,kBAAkB,EAClB,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,qBAAqB,EACtB,MAAM,SAAS,CAAA;AAEhB;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,cAAc,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,cAAc,CAAA;IAC9B,qBAAqB,CAAC,EAAE,qBAAqB,CAAA;CAC9C;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IAC5C,SAAS,CAAC,KAAK,EAAE,KAAK,CAAA;IACtB,SAAS,CAAC,kBAAkB,UAAQ;IAEpC;;;;;;;;;;;;;;;;;OAiBG;gBACS,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EAAE,KAAK,CAAC,EAAE,KAAK;IAM/E;;;;;;;;;;;;;;;;;OAiBG;IACI,YAAY,IAAI,IAAI;IAK3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAiB/E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,QAAQ,CACZ,gBAAgB,EAAE,MAAM,EACxB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,WAAW,CAAC;QAAE,KAAK,EAAE,WAAW,CAAA;KAAE,CAAC,CAAC;IAoB/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;IAiBzF;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,WAAW,CAAC,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAmBhG"}
+{"version":3,"file":"VectorIndexApi.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorIndexApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAQ,MAAM,SAAS,CAAA;AAErC,OAAO,EACL,WAAW,EACX,WAAW,EACX,kBAAkB,EAClB,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,qBAAqB,EACtB,MAAM,SAAS,CAAA;AAEhB;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,cAAc,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,cAAc,CAAA;IAC9B,qBAAqB,CAAC,EAAE,qBAAqB,CAAA;CAC9C;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IAC5C,SAAS,CAAC,KAAK,EAAE,KAAK,CAAA;IACtB,SAAS,CAAC,kBAAkB,UAAQ;IAEpC,4CAA4C;gBAChC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EAAE,KAAK,CAAC,EAAE,KAAK;IAM/E,uEAAuE;IAChE,YAAY,IAAI,IAAI;IAK3B,iDAAiD;IAC3C,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAiB/E,qDAAqD;IAC/C,QAAQ,CACZ,gBAAgB,EAAE,MAAM,EACxB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,WAAW,CAAC;QAAE,KAAK,EAAE,WAAW,CAAA;KAAE,CAAC,CAAC;IAoB/C,kFAAkF;IAC5E,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;IAiBzF,8CAA8C;IACxC,WAAW,CAAC,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAmBhG"}