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

package/src/StorageClient.ts

@@ -40,7 +40,7 @@ export class StorageClient extends StorageBucketApi {
    *
    * @example
    * ```typescript
-   * const avatars = storage.from('avatars')
+   * const avatars = supabase.storage.from('avatars')
    * ```
    */
   from(id: string): StorageFileApi {
@@ -75,20 +75,6 @@ export class StorageClient extends StorageBucketApi {
    *
    * @category Analytics Buckets
    * @returns A StorageAnalyticsClient instance configured with the current storage settings.
-   * @example
-   * ```typescript
-   * const client = createClient(url, key)
-   * const analytics = client.storage.analytics
-   *
-   * // Create an analytics bucket
-   * await analytics.createBucket('my-analytics-bucket')
-   *
-   * // List all analytics buckets
-   * const { data: buckets } = await analytics.listBuckets()
-   *
-   * // Delete an analytics bucket
-   * await analytics.deleteBucket('old-analytics-bucket')
-   * ```
    */
   get analytics(): StorageAnalyticsClient {
     return new StorageAnalyticsClient(this.url + '/iceberg', this.headers, this.fetch)

package/src/lib/vectors/StorageVectorsClient.ts

@@ -42,32 +42,14 @@ export interface StorageVectorsClientOptions {
  *
  * **Usage Patterns:**
  *
- * 1. **Via StorageClient (recommended for most use cases):**
  * ```typescript
- * import { StorageClient } from '@supabase/storage-js'
- *
- * const storageClient = new StorageClient(url, headers)
- * const vectors = storageClient.vectors
- *
- * // Use vector operations
- * await vectors.createBucket('embeddings-prod')
- * const bucket = vectors.from('embeddings-prod')
- * await bucket.createIndex({ ... })
- * ```
- *
- * 2. **Standalone (for vector-only applications):**
- * ```typescript
- * import { StorageVectorsClient } from '@supabase/storage-js'
- *
- * const vectorsClient = new StorageVectorsClient('https://api.example.com', {
- *   headers: { 'Authorization': 'Bearer token' }
- * })
- *
- * // Access bucket operations
- * await vectorsClient.createBucket('embeddings-prod')
+ * const { data, error } = await supabase
+ *  .storage
+ *  .vectors
+ *  .createBucket('embeddings-prod')
  *
  * // Access index operations via buckets
- * const bucket = vectorsClient.from('embeddings-prod')
+ * const bucket = supabase.storage.vectors.from('embeddings-prod')
  * await bucket.createIndex({
  *   indexName: 'documents',
  *   dataType: 'float32',
@@ -128,18 +110,7 @@ export class StorageVectorsClient extends VectorBucketApi {
    *
    * @example
    * ```typescript
-   * const bucket = client.bucket('embeddings-prod')
-   *
-   * // Create an index in this bucket
-   * await bucket.createIndex({
-   *   indexName: 'documents-openai',
-   *   dataType: 'float32',
-   *   dimension: 1536,
-   *   distanceMetric: 'cosine'
-   * })
-   *
-   * // List indexes in this bucket
-   * const { data } = await bucket.listIndexes()
+   * const bucket = supabase.storage.vectors.from('embeddings-prod')
    * ```
    */
   from(vectorBucketName: string): VectorBucketScope {
@@ -169,7 +140,7 @@ export class VectorBucketScope extends VectorIndexApi {
    * @category Vector Buckets
    * @example
    * ```typescript
-   * const bucket = client.bucket('embeddings-prod')
+   * const bucket = supabase.storage.vectors.from('embeddings-prod')
    * ```
    */
   constructor(
@@ -197,7 +168,7 @@ export class VectorBucketScope extends VectorIndexApi {
    *
    * @example
    * ```typescript
-   * const bucket = client.bucket('embeddings-prod')
+   * const bucket = supabase.storage.vectors.from('embeddings-prod')
    * await bucket.createIndex({
    *   indexName: 'documents-openai',
    *   dataType: 'float32',
@@ -231,7 +202,7 @@ export class VectorBucketScope extends VectorIndexApi {
    *
    * @example
    * ```typescript
-   * const bucket = client.bucket('embeddings-prod')
+   * const bucket = supabase.storage.vectors.from('embeddings-prod')
    * const { data } = await bucket.listIndexes({ prefix: 'documents-' })
    * ```
    */
@@ -257,7 +228,7 @@ export class VectorBucketScope extends VectorIndexApi {
    *
    * @example
    * ```typescript
-   * const bucket = client.bucket('embeddings-prod')
+   * const bucket = supabase.storage.vectors.from('embeddings-prod')
    * const { data } = await bucket.getIndex('documents-openai')
    * console.log('Dimension:', data?.index.dimension)
    * ```
@@ -281,7 +252,7 @@ export class VectorBucketScope extends VectorIndexApi {
    *
    * @example
    * ```typescript
-   * const bucket = client.bucket('embeddings-prod')
+   * const bucket = supabase.storage.vectors.from('embeddings-prod')
    * await bucket.deleteIndex('old-index')
    * ```
    */
@@ -304,7 +275,7 @@ export class VectorBucketScope extends VectorIndexApi {
    *
    * @example
    * ```typescript
-   * const index = client.bucket('embeddings-prod').index('documents-openai')
+   * const index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')
    *
    * // Insert vectors
    * await index.putVectors({
@@ -355,7 +326,7 @@ export class VectorIndexScope extends VectorDataApi {
    * @category Vector Buckets
    * @example
    * ```typescript
-   * const index = client.bucket('embeddings-prod').index('documents-openai')
+   * const index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')
    * ```
    */
   constructor(
@@ -385,7 +356,7 @@ export class VectorIndexScope extends VectorDataApi {
    *
    * @example
    * ```typescript
-   * const index = client.bucket('embeddings-prod').index('documents-openai')
+   * const index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')
    * await index.putVectors({
    *   vectors: [
    *     {
@@ -420,7 +391,7 @@ export class VectorIndexScope extends VectorDataApi {
    *
    * @example
    * ```typescript
-   * const index = client.bucket('embeddings-prod').index('documents-openai')
+   * const index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')
    * const { data } = await index.getVectors({
    *   keys: ['doc-1', 'doc-2'],
    *   returnMetadata: true
@@ -450,7 +421,7 @@ export class VectorIndexScope extends VectorDataApi {
    *
    * @example
    * ```typescript
-   * const index = client.bucket('embeddings-prod').index('documents-openai')
+   * const index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')
    * const { data } = await index.listVectors({
    *   maxResults: 500,
    *   returnMetadata: true
@@ -482,7 +453,7 @@ export class VectorIndexScope extends VectorDataApi {
    *
    * @example
    * ```typescript
-   * const index = client.bucket('embeddings-prod').index('documents-openai')
+   * const index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')
    * const { data } = await index.queryVectors({
    *   queryVector: { float32: [0.1, 0.2, ...] },
    *   topK: 5,
@@ -517,7 +488,7 @@ export class VectorIndexScope extends VectorDataApi {
    *
    * @example
    * ```typescript
-   * const index = client.bucket('embeddings-prod').index('documents-openai')
+   * const index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')
    * await index.deleteVectors({
    *   keys: ['doc-1', 'doc-2', 'doc-3']
    * })

package/src/lib/vectors/VectorBucketApi.ts

@@ -10,13 +10,9 @@ import {
 } from './types'
 
 /**
- *
- * @alpha
- *
- * API class for managing Vector Buckets
- * Provides methods for creating, reading, listing, and deleting vector buckets
- *
- * **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 bucket operations.
+ * Use {@link StorageVectorsClient} via `supabase.storage.vectors` instead.
  */
 export default class VectorBucketApi {
   protected url: string
@@ -24,79 +20,20 @@ export default class VectorBucketApi {
   protected fetch: Fetch
   protected shouldThrowOnError = false
 
-  /**
-   *
-   * @alpha
-   *
-   * Creates a new VectorBucketApi instance
-   *
-   * **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 - 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)
-   * ```
-   */
+  /** Creates a new VectorBucketApi instance */
   constructor(url: string, headers: { [key: string]: string } = {}, fetch?: Fetch) {
     this.url = url.replace(/\/$/, '')
     this.headers = { ...DEFAULT_HEADERS, ...headers }
     this.fetch = 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 VectorBucketApi(url, headers)
-   * client.throwOnError()
-   * const { data } = await client.createBucket('my-bucket') // throws on error
-   * ```
-   */
+  /** Enable throwing errors instead of returning them in the response */
   public throwOnError(): this {
     this.shouldThrowOnError = true
     return this
   }
 
-  /**
-   *
-   * @alpha
-   *
-   * Creates a new vector bucket
-   * Vector buckets are containers for vector indexes and their data
-   *
-   * **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 - Unique name for the vector bucket
-   * @returns Promise with empty response on success or error
-   *
-   * @throws {StorageVectorsApiError} With code:
-   * - `S3VectorConflictException` if bucket already exists (HTTP 409)
-   * - `S3VectorMaxBucketsExceeded` if quota exceeded (HTTP 400)
-   * - `InternalError` for server errors (HTTP 500)
-   *
-   * @example
-   * ```typescript
-   * const { data, error } = await client.createBucket('embeddings-prod')
-   * if (error) {
-   *   console.error('Failed to create bucket:', error.message)
-   * }
-   * ```
-   */
+  /** Creates a new vector bucket */
   async createBucket(vectorBucketName: string): Promise<ApiResponse<undefined>> {
     try {
       const data = await post(
@@ -117,31 +54,7 @@ export default class VectorBucketApi {
     }
   }
 
-  /**
-   *
-   * @alpha
-   *
-   * Retrieves metadata for a specific vector bucket
-   * Returns bucket configuration including encryption settings and creation time
-   *
-   * **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 vector bucket to retrieve
-   * @returns Promise with bucket metadata or error
-   *
-   * @throws {StorageVectorsApiError} With code:
-   * - `S3VectorNotFoundException` if bucket doesn't exist (HTTP 404)
-   * - `InternalError` for server errors (HTTP 500)
-   *
-   * @example
-   * ```typescript
-   * const { data, error } = await client.getBucket('embeddings-prod')
-   * if (data) {
-   *   console.log('Bucket created at:', new Date(data.vectorBucket.creationTime! * 1000))
-   * }
-   * ```
-   */
+  /** Retrieves metadata for a specific vector bucket */
   async getBucket(vectorBucketName: string): Promise<ApiResponse<{ vectorBucket: VectorBucket }>> {
     try {
       const data = await post(
@@ -162,38 +75,7 @@ export default class VectorBucketApi {
     }
   }
 
-  /**
-   *
-   * @alpha
-   *
-   * Lists vector buckets 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.prefix - Filter buckets 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 buckets and pagination token
-   *
-   * @throws {StorageVectorsApiError} With code:
-   * - `InternalError` for server errors (HTTP 500)
-   *
-   * @example
-   * ```typescript
-   * // List all buckets with prefix 'prod-'
-   * const { data, error } = await client.listBuckets({ prefix: 'prod-' })
-   * if (data) {
-   *   console.log('Found buckets:', data.buckets.length)
-   *   // Fetch next page if available
-   *   if (data.nextToken) {
-   *     const next = await client.listBuckets({ nextToken: data.nextToken })
-   *   }
-   * }
-   * ```
-   */
+  /** Lists vector buckets with optional filtering and pagination */
   async listBuckets(
     options: ListVectorBucketsOptions = {}
   ): Promise<ApiResponse<ListVectorBucketsResponse>> {
@@ -213,33 +95,7 @@ export default class VectorBucketApi {
     }
   }
 
-  /**
-   *
-   * @alpha
-   *
-   * Deletes a vector bucket
-   * Bucket must be empty before deletion (all indexes must be removed first)
-   *
-   * **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 vector bucket to delete
-   * @returns Promise with empty response on success or error
-   *
-   * @throws {StorageVectorsApiError} With code:
-   * - `S3VectorBucketNotEmpty` if bucket contains indexes (HTTP 400)
-   * - `S3VectorNotFoundException` if bucket doesn't exist (HTTP 404)
-   * - `InternalError` for server errors (HTTP 500)
-   *
-   * @example
-   * ```typescript
-   * // Delete all indexes first, then delete bucket
-   * const { error } = await client.deleteBucket('old-bucket')
-   * if (error?.statusCode === 'S3VectorBucketNotEmpty') {
-   *   console.error('Must delete all indexes first')
-   * }
-   * ```
-   */
+  /** Deletes a vector bucket (must be empty first) */
   async deleteBucket(vectorBucketName: string): Promise<ApiResponse<undefined>> {
     try {
       const data = await post(