@supabase/storage-js 2.81.1 → 2.81.2-canary.1

package/src/StorageClient.ts

@@ -9,6 +9,19 @@ export interface StorageClientOptions {
 }
 
 export class StorageClient extends StorageBucketApi {
+  /**
+   * Creates a client for Storage buckets, files, analytics, and vectors.
+   *
+   * @example
+   * ```ts
+   * import { StorageClient } from '@supabase/storage-js'
+   *
+   * const storage = new StorageClient('https://xyzcompany.supabase.co/storage/v1', {
+   *   apikey: 'public-anon-key',
+   * })
+   * const avatars = storage.from('avatars')
+   * ```
+   */
   constructor(
     url: string,
     headers: { [key: string]: string } = {},
@@ -30,6 +43,8 @@ export class StorageClient extends StorageBucketApi {
   /**
    * Access vector storage operations.
    *
+   * **Private alpha:** This API is part of a private alpha release and may change or be removed without notice.
+   *
    * @returns A StorageVectorsClient instance configured with the current storage settings.
    */
   get vectors(): StorageVectorsClient {

package/src/lib/vectors/StorageVectorsClient.ts

@@ -13,6 +13,8 @@ import {
 
 /**
  * Configuration options for the Storage Vectors client
+ *
+ * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
  */
 export interface StorageVectorsClientOptions {
   /**
@@ -30,6 +32,8 @@ export interface StorageVectorsClientOptions {
  * Main client for interacting with S3 Vectors API
  * Provides access to bucket, index, and vector data operations
  *
+ * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+ *
  * **Usage Patterns:**
  *
  * 1. **Via StorageClient (recommended for most use cases):**
@@ -82,6 +86,15 @@ export interface StorageVectorsClientOptions {
  * ```
  */
 export class StorageVectorsClient extends VectorBucketApi {
+  /**
+   * Creates a StorageVectorsClient that can manage buckets, indexes, and vectors.
+   *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
+   * @param url - Base URL of the Storage Vectors REST API.
+   * @param options.headers - Optional headers (for example `Authorization`) applied to every request.
+   * @param options.fetch - Optional custom `fetch` implementation for non-browser runtimes.
+   */
   constructor(url: string, options: StorageVectorsClientOptions = {}) {
     super(url, options.headers || {}, options.fetch)
   }
@@ -90,6 +103,8 @@ export class StorageVectorsClient extends VectorBucketApi {
    * Access operations for a specific vector bucket
    * Returns a scoped client for index and vector operations within the bucket
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param vectorBucketName - Name of the vector bucket
    * @returns Bucket-scoped client with index and vector operations
    *
@@ -117,10 +132,17 @@ export class StorageVectorsClient extends VectorBucketApi {
 /**
  * Scoped client for operations within a specific vector bucket
  * Provides index management and access to vector operations
+ *
+ * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
  */
 export class VectorBucketScope extends VectorIndexApi {
   private vectorBucketName: string
 
+  /**
+   * Creates a helper that automatically scopes all index operations to the provided bucket.
+   *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   */
   constructor(
     url: string,
     headers: { [key: string]: string },
@@ -135,6 +157,8 @@ export class VectorBucketScope extends VectorIndexApi {
    * Creates a new vector index in this bucket
    * Convenience method that automatically includes the bucket name
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param options - Index configuration (vectorBucketName is automatically set)
    * @returns Promise with empty response on success or error
    *
@@ -163,6 +187,8 @@ export class VectorBucketScope extends VectorIndexApi {
    * Lists indexes in this bucket
    * Convenience method that automatically includes the bucket name
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param options - Listing options (vectorBucketName is automatically set)
    * @returns Promise with list of indexes or error
    *
@@ -183,6 +209,8 @@ export class VectorBucketScope extends VectorIndexApi {
    * Retrieves metadata for a specific index in this bucket
    * Convenience method that automatically includes the bucket name
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param indexName - Name of the index to retrieve
    * @returns Promise with index metadata or error
    *
@@ -201,6 +229,8 @@ export class VectorBucketScope extends VectorIndexApi {
    * Deletes an index from this bucket
    * Convenience method that automatically includes the bucket name
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param indexName - Name of the index to delete
    * @returns Promise with empty response on success or error
    *
@@ -218,6 +248,8 @@ export class VectorBucketScope extends VectorIndexApi {
    * Access operations for a specific index within this bucket
    * Returns a scoped client for vector data operations
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param indexName - Name of the index
    * @returns Index-scoped client with vector data operations
    *
@@ -253,11 +285,18 @@ export class VectorBucketScope extends VectorIndexApi {
 /**
  * Scoped client for operations within a specific vector index
  * Provides vector data operations (put, get, list, query, delete)
+ *
+ * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
  */
 export class VectorIndexScope extends VectorDataApi {
   private vectorBucketName: string
   private indexName: string
 
+  /**
+   * Creates a helper that automatically scopes all vector operations to the provided bucket/index names.
+   *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   */
   constructor(
     url: string,
     headers: { [key: string]: string },
@@ -274,6 +313,8 @@ export class VectorIndexScope extends VectorDataApi {
    * Inserts or updates vectors in this index
    * Convenience method that automatically includes bucket and index names
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param options - Vector insertion options (bucket and index names automatically set)
    * @returns Promise with empty response on success or error
    *
@@ -303,6 +344,8 @@ export class VectorIndexScope extends VectorDataApi {
    * Retrieves vectors by keys from this index
    * Convenience method that automatically includes bucket and index names
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param options - Vector retrieval options (bucket and index names automatically set)
    * @returns Promise with array of vectors or error
    *
@@ -327,6 +370,8 @@ export class VectorIndexScope extends VectorDataApi {
    * Lists vectors in this index with pagination
    * Convenience method that automatically includes bucket and index names
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param options - Listing options (bucket and index names automatically set)
    * @returns Promise with array of vectors and pagination token
    *
@@ -353,6 +398,8 @@ export class VectorIndexScope extends VectorDataApi {
    * Queries for similar vectors in this index
    * Convenience method that automatically includes bucket and index names
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param options - Query options (bucket and index names automatically set)
    * @returns Promise with array of similar vectors ordered by distance
    *
@@ -382,6 +429,8 @@ export class VectorIndexScope extends VectorDataApi {
    * Deletes vectors by keys from this index
    * Convenience method that automatically includes bucket and index names
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param options - Deletion options (bucket and index names automatically set)
    * @returns Promise with empty response on success or error
    *

package/src/lib/vectors/VectorBucketApi.ts

@@ -12,6 +12,8 @@ import {
 /**
  * API class for managing Vector Buckets
  * Provides methods for creating, reading, listing, and deleting vector buckets
+ *
+ * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
  */
 export default class VectorBucketApi {
   protected url: string
@@ -21,9 +23,16 @@ export default class VectorBucketApi {
 
   /**
    * Creates a new VectorBucketApi instance
+   *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
    * @param url - The base URL for the storage vectors API
    * @param headers - HTTP headers to include in requests
    * @param fetch - Optional custom fetch implementation
+   *
+   * @example
+   * ```typescript
+   * const client = new VectorBucketApi(url, headers)
+   * ```
    */
   constructor(url: string, headers: { [key: string]: string } = {}, fetch?: Fetch) {
     this.url = url.replace(/\/$/, '')
@@ -35,6 +44,8 @@ export default class VectorBucketApi {
    * Enable throwing errors instead of returning them in the response
    * When enabled, failed operations will throw instead of returning { data: null, error }
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @returns This instance for method chaining
    * @example
    * ```typescript
@@ -52,6 +63,8 @@ export default class VectorBucketApi {
    * Creates a new vector bucket
    * Vector buckets are containers for vector indexes and their data
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param vectorBucketName - Unique name for the vector bucket
    * @returns Promise with empty response on success or error
    *
@@ -92,6 +105,8 @@ export default class VectorBucketApi {
    * Retrieves metadata for a specific vector bucket
    * Returns bucket configuration including encryption settings and creation time
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param vectorBucketName - Name of the vector bucket to retrieve
    * @returns Promise with bucket metadata or error
    *
@@ -107,9 +122,7 @@ export default class VectorBucketApi {
    * }
    * ```
    */
-  async getBucket(
-    vectorBucketName: string
-  ): Promise<ApiResponse<{ vectorBucket: VectorBucket }>> {
+  async getBucket(vectorBucketName: string): Promise<ApiResponse<{ vectorBucket: VectorBucket }>> {
     try {
       const data = await post(
         this.fetch,
@@ -133,6 +146,8 @@ export default class VectorBucketApi {
    * Lists vector buckets with optional filtering and pagination
    * Supports prefix-based filtering and paginated results
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param options - Listing options
    * @param options.prefix - Filter buckets by name prefix
    * @param options.maxResults - Maximum results per page (default: 100)
@@ -178,6 +193,8 @@ export default class VectorBucketApi {
    * Deletes a vector bucket
    * Bucket must be empty before deletion (all indexes must be removed first)
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param vectorBucketName - Name of the vector bucket to delete
    * @returns Promise with empty response on success or error
    *

package/src/lib/vectors/VectorDataApi.ts

@@ -17,6 +17,8 @@ import {
 /**
  * API class for managing Vector Data within Vector Indexes
  * Provides methods for inserting, querying, listing, and deleting vector embeddings
+ *
+ * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
  */
 export default class VectorDataApi {
   protected url: string
@@ -24,6 +26,15 @@ export default class VectorDataApi {
   protected fetch: Fetch
   protected shouldThrowOnError = false
 
+  /**
+   * Creates a VectorDataApi bound to a Storage Vectors deployment.
+   *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
+   * @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.
+   */
   constructor(url: string, headers: { [key: string]: string } = {}, fetch?: Fetch) {
     this.url = url.replace(/\/$/, '')
     this.headers = { ...DEFAULT_HEADERS, ...headers }
@@ -34,6 +45,8 @@ export default class VectorDataApi {
    * Enable throwing errors instead of returning them in the response
    * When enabled, failed operations will throw instead of returning { data: null, error }
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @returns This instance for method chaining
    * @example
    * ```typescript
@@ -51,6 +64,8 @@ export default class VectorDataApi {
    * Inserts or updates vectors in batch (upsert operation)
    * Accepts 1-500 vectors per request. Larger batches should be split
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param options - Vector insertion options
    * @param options.vectorBucketName - Name of the parent vector bucket
    * @param options.indexName - Name of the target index
@@ -109,6 +124,8 @@ export default class VectorDataApi {
    * Optionally includes vector data and/or metadata in response
    * Additional permissions required when returning data or metadata
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param options - Vector retrieval options
    * @param options.vectorBucketName - Name of the parent vector bucket
    * @param options.indexName - Name of the index
@@ -157,6 +174,8 @@ export default class VectorDataApi {
    * Supports parallel scanning via segment configuration for high-throughput scenarios
    * Additional permissions required when returning data or metadata
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param options - Vector listing options
    * @param options.vectorBucketName - Name of the parent vector bucket
    * @param options.indexName - Name of the index
@@ -237,6 +256,8 @@ export default class VectorDataApi {
    * Returns top-K most similar vectors based on the configured distance metric
    * Supports optional metadata filtering (requires GetVectors permission)
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param options - Query options
    * @param options.vectorBucketName - Name of the parent vector bucket
    * @param options.indexName - Name of the index
@@ -295,6 +316,8 @@ export default class VectorDataApi {
    * Deletes vectors by their keys in batch
    * Accepts 1-500 keys per request
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param options - Vector deletion options
    * @param options.vectorBucketName - Name of the parent vector bucket
    * @param options.indexName - Name of the index

package/src/lib/vectors/VectorIndexApi.ts

@@ -14,6 +14,8 @@ import {
 
 /**
  * Options for creating a vector index
+ *
+ * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
  */
 export interface CreateIndexOptions {
   vectorBucketName: string
@@ -27,6 +29,8 @@ export interface CreateIndexOptions {
 /**
  * API class for managing Vector Indexes within Vector Buckets
  * Provides methods for creating, reading, listing, and deleting vector indexes
+ *
+ * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
  */
 export default class VectorIndexApi {
   protected url: string
@@ -34,6 +38,15 @@ export default class VectorIndexApi {
   protected fetch: Fetch
   protected shouldThrowOnError = false
 
+  /**
+   * Creates an API client for managing vector indexes.
+   *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
+   * @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.
+   */
   constructor(url: string, headers: { [key: string]: string } = {}, fetch?: Fetch) {
     this.url = url.replace(/\/$/, '')
     this.headers = { ...DEFAULT_HEADERS, ...headers }
@@ -44,6 +57,8 @@ export default class VectorIndexApi {
    * Enable throwing errors instead of returning them in the response
    * When enabled, failed operations will throw instead of returning { data: null, error }
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @returns This instance for method chaining
    * @example
    * ```typescript
@@ -61,6 +76,8 @@ export default class VectorIndexApi {
    * Creates a new vector index within a bucket
    * Defines the schema for vectors including dimensionality, distance metric, and metadata config
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param options - Index configuration
    * @param options.vectorBucketName - Name of the parent vector bucket
    * @param options.indexName - Unique name for the index within the bucket
@@ -111,6 +128,8 @@ export default class VectorIndexApi {
    * Retrieves metadata for a specific vector index
    * Returns index configuration including dimension, distance metric, and metadata settings
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param vectorBucketName - Name of the parent vector bucket
    * @param indexName - Name of the index to retrieve
    * @returns Promise with index metadata or error
@@ -155,6 +174,8 @@ export default class VectorIndexApi {
    * Lists vector indexes within a bucket with optional filtering and pagination
    * Supports prefix-based filtering and paginated results
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @param options - Listing options
    * @param options.vectorBucketName - Name of the parent vector bucket
    * @param options.prefix - Filter indexes by name prefix
@@ -206,6 +227,8 @@ export default class VectorIndexApi {
    * Deletes a vector index and all its data
    * This operation removes the index schema and all vectors stored in the index
    *
+   * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+   *
    * @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

package/src/lib/version.ts

@@ -4,4 +4,4 @@
 // - Debugging and support (identifying which version is running)
 // - Telemetry and logging (version reporting in errors/analytics)
 // - Ensuring build artifacts match the published package version
-export const version = '2.81.1'
+export const version = '2.81.2-canary.1'