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

package/src/lib/vectors/StorageVectorsClient.ts

@@ -3,12 +3,16 @@ import VectorDataApi from './VectorDataApi'
 import { Fetch } from './fetch'
 import VectorBucketApi from './VectorBucketApi'
 import {
+  ApiResponse,
   DeleteVectorsOptions,
   GetVectorsOptions,
   ListIndexesOptions,
   ListVectorsOptions,
+  ListVectorBucketsOptions,
+  ListVectorBucketsResponse,
   PutVectorsOptions,
   QueryVectorsOptions,
+  VectorBucket,
 } from './types'
 
 /**
@@ -116,6 +120,112 @@ export class StorageVectorsClient extends VectorBucketApi {
   from(vectorBucketName: string): VectorBucketScope {
     return new VectorBucketScope(this.url, this.headers, vectorBucketName, this.fetch)
   }
+
+  /**
+   *
+   * @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
+   *
+   * @example
+   * ```typescript
+   * const { data, error } = await supabase
+   *   .storage
+   *   .vectors
+   *   .createBucket('embeddings-prod')
+   * ```
+   */
+  async createBucket(vectorBucketName: string): Promise<ApiResponse<undefined>> {
+    return super.createBucket(vectorBucketName)
+  }
+
+  /**
+   *
+   * @alpha
+   *
+   * Retrieves metadata for a specific vector bucket
+   *
+   * **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
+   * @returns Promise with bucket metadata or error
+   *
+   * @example
+   * ```typescript
+   * const { data, error } = await supabase
+   *   .storage
+   *   .vectors
+   *   .getBucket('embeddings-prod')
+   *
+   * console.log('Bucket created:', data?.vectorBucket.creationTime)
+   * ```
+   */
+  async getBucket(vectorBucketName: string): Promise<ApiResponse<{ vectorBucket: VectorBucket }>> {
+    return super.getBucket(vectorBucketName)
+  }
+
+  /**
+   *
+   * @alpha
+   *
+   * Lists all vector buckets with optional filtering and pagination
+   *
+   * **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 - Optional filters (prefix, maxResults, nextToken)
+   * @returns Promise with list of buckets or error
+   *
+   * @example
+   * ```typescript
+   * const { data, error } = await supabase
+   *   .storage
+   *   .vectors
+   *   .listBuckets({ prefix: 'embeddings-' })
+   *
+   * data?.vectorBuckets.forEach(bucket => {
+   *   console.log(bucket.vectorBucketName)
+   * })
+   * ```
+   */
+  async listBuckets(
+    options: ListVectorBucketsOptions = {}
+  ): Promise<ApiResponse<ListVectorBucketsResponse>> {
+    return super.listBuckets(options)
+  }
+
+  /**
+   *
+   * @alpha
+   *
+   * Deletes a vector bucket (bucket must be empty)
+   * All indexes must be deleted before deleting the bucket
+   *
+   * **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
+   *
+   * @example
+   * ```typescript
+   * const { data, error } = await supabase
+   *   .storage
+   *   .vectors
+   *   .deleteBucket('embeddings-old')
+   * ```
+   */
+  async deleteBucket(vectorBucketName: string): Promise<ApiResponse<undefined>> {
+    return super.deleteBucket(vectorBucketName)
+  }
 }
 
 /**
@@ -198,7 +308,7 @@ export class VectorBucketScope extends VectorIndexApi {
    *
    * @category Vector Buckets
    * @param options - Listing options (vectorBucketName is automatically set)
-   * @returns Promise with list of indexes or error
+   * @returns Promise with response containing indexes array and pagination token or error
    *
    * @example
    * ```typescript
@@ -387,7 +497,7 @@ export class VectorIndexScope extends VectorDataApi {
    *
    * @category Vector Buckets
    * @param options - Vector retrieval options (bucket and index names automatically set)
-   * @returns Promise with array of vectors or error
+   * @returns Promise with response containing vectors array or error
    *
    * @example
    * ```typescript
@@ -417,7 +527,7 @@ export class VectorIndexScope extends VectorDataApi {
    *
    * @category Vector Buckets
    * @param options - Listing options (bucket and index names automatically set)
-   * @returns Promise with array of vectors and pagination token
+   * @returns Promise with response containing vectors array and pagination token or error
    *
    * @example
    * ```typescript
@@ -449,7 +559,7 @@ export class VectorIndexScope extends VectorDataApi {
    *
    * @category Vector Buckets
    * @param options - Query options (bucket and index names automatically set)
-   * @returns Promise with array of similar vectors ordered by distance
+   * @returns Promise with response containing matches array of similar vectors ordered by distance or error
    *
    * @example
    * ```typescript

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.84.1-canary.0'
+export const version = '2.85.0'

package/src/packages/StorageAnalyticsClient.ts

@@ -63,7 +63,7 @@ export default class StorageAnalyticsClient {
    *
    * @category Analytics Buckets
    * @param name A unique name for the bucket you are creating
-   * @returns Promise with newly created bucket name or error
+   * @returns Promise with response containing newly created analytics bucket or error
    *
    * @example Create analytics bucket
    * ```js
@@ -124,10 +124,10 @@ export default class StorageAnalyticsClient {
    * @param options Query parameters for listing buckets
    * @param options.limit Maximum number of buckets to return
    * @param options.offset Number of buckets to skip
-   * @param options.sortColumn Column to sort by ('id', 'name', 'created_at', 'updated_at')
+   * @param options.sortColumn Column to sort by ('name', 'created_at', 'updated_at')
    * @param options.sortOrder Sort order ('asc' or 'desc')
    * @param options.search Search term to filter bucket names
-   * @returns Promise with list of analytics buckets or error
+   * @returns Promise with response containing array of analytics buckets or error
    *
    * @example List analytics buckets
    * ```js
@@ -161,7 +161,7 @@ export default class StorageAnalyticsClient {
   async listBuckets(options?: {
     limit?: number
     offset?: number
-    sortColumn?: 'id' | 'name' | 'created_at' | 'updated_at'
+    sortColumn?: 'name' | 'created_at' | 'updated_at'
     sortOrder?: 'asc' | 'desc'
     search?: string
   }): Promise<
@@ -212,7 +212,7 @@ export default class StorageAnalyticsClient {
    *
    * @category Analytics Buckets
    * @param bucketName The unique identifier of the bucket you would like to delete
-   * @returns Promise with success message or error
+   * @returns Promise with response containing success message or error
    *
    * @example Delete analytics bucket
    * ```js

package/src/packages/StorageBucketApi.ts

@@ -53,7 +53,7 @@ export default class StorageBucketApi {
    * @param options.sortColumn Column to sort by ('id', 'name', 'created_at', 'updated_at')
    * @param options.sortOrder Sort order ('asc' or 'desc')
    * @param options.search Search term to filter bucket names
-   * @returns Promise with list of buckets or error
+   * @returns Promise with response containing array of buckets or error
    *
    * @example List buckets
    * ```js
@@ -108,7 +108,7 @@ export default class StorageBucketApi {
    *
    * @category File Buckets
    * @param id The unique identifier of the bucket you would like to retrieve.
-   * @returns Promise with bucket details or error
+   * @returns Promise with response containing bucket details or error
    *
    * @example Get bucket
    * ```js
@@ -175,7 +175,7 @@ export default class StorageBucketApi {
    * Each mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png.
    * @param options.type (private-beta) specifies the bucket type. see `BucketType` for more details.
    *   - default bucket type is `STANDARD`
-   * @returns Promise with newly created bucket id or error
+   * @returns Promise with response containing newly created bucket name or error
    *
    * @example Create bucket
    * ```js
@@ -257,7 +257,7 @@ export default class StorageBucketApi {
    * @param options.allowedMimeTypes specifies the allowed mime types that this bucket can accept during upload.
    * The default value is null, which allows files with all mime types to be uploaded.
    * Each mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png.
-   * @returns Promise with success message or error
+   * @returns Promise with response containing success message or error
    *
    * @example Update bucket
    * ```js

package/src/packages/StorageFileApi.ts

@@ -175,7 +175,7 @@ export default class StorageFileApi {
    * @param path The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload.
    * @param fileBody The body of the file to be stored in the bucket.
    * @param fileOptions Optional file upload options including cacheControl, contentType, upsert, and metadata.
-   * @returns Promise with file path and id or error
+   * @returns Promise with response containing file path, id, and fullPath or error
    *
    * @example Upload file
    * ```js
@@ -237,7 +237,7 @@ export default class StorageFileApi {
    * @param token The token generated from `createSignedUploadUrl`
    * @param fileBody The body of the file to be stored in the bucket.
    * @param fileOptions Optional file upload options including cacheControl and contentType.
-   * @returns Promise with file path and full path or error
+   * @returns Promise with response containing file path and fullPath or error
    *
    * @example Upload to a signed URL
    * ```js
@@ -317,7 +317,7 @@ export default class StorageFileApi {
    * @category File Buckets
    * @param path The file path, including the current file name. For example `folder/image.png`.
    * @param options.upsert If set to true, allows the file to be overwritten if it already exists.
-   * @returns Promise with signed upload URL, token, and path or error
+   * @returns Promise with response containing signed upload URL, token, and path or error
    *
    * @example Create Signed Upload URL
    * ```js
@@ -396,7 +396,7 @@ export default class StorageFileApi {
    * @param path The relative file path. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to update.
    * @param fileBody The body of the file to be stored in the bucket.
    * @param fileOptions Optional file upload options including cacheControl, contentType, upsert, and metadata.
-   * @returns Promise with file path and id or error
+   * @returns Promise with response containing file path, id, and fullPath or error
    *
    * @example Update file
    * ```js
@@ -467,7 +467,7 @@ export default class StorageFileApi {
    * @param fromPath The original file path, including the current file name. For example `folder/image.png`.
    * @param toPath The new file path, including the new file name. For example `folder/image-new.png`.
    * @param options The destination options.
-   * @returns Promise with success message or error
+   * @returns Promise with response containing success message or error
    *
    * @example Move file
    * ```js
@@ -533,7 +533,7 @@ export default class StorageFileApi {
    * @param fromPath The original file path, including the current file name. For example `folder/image.png`.
    * @param toPath The new file path, including the new file name. For example `folder/image-copy.png`.
    * @param options The destination options.
-   * @returns Promise with copied file path or error
+   * @returns Promise with response containing copied file path or error
    *
    * @example Copy file
    * ```js
@@ -600,7 +600,7 @@ export default class StorageFileApi {
    * @param expiresIn The number of seconds until the signed URL expires. For example, `60` for a URL which is valid for one minute.
    * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
    * @param options.transform Transform the asset before serving it to the client.
-   * @returns Promise with signed URL or error
+   * @returns Promise with response containing signed URL or error
    *
    * @example Create Signed URL
    * ```js
@@ -691,7 +691,7 @@ export default class StorageFileApi {
    * @param paths The file paths to be downloaded, including the current file names. For example `['folder/image.png', 'folder2/image2.png']`.
    * @param expiresIn The number of seconds until the signed URLs expire. For example, `60` for URLs which are valid for one minute.
    * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-   * @returns Promise with array of signed URLs or error
+   * @returns Promise with response containing array of objects with signedUrl, path, and error or error
    *
    * @example Create Signed URLs
    * ```js
@@ -828,7 +828,7 @@ export default class StorageFileApi {
    *
    * @category File Buckets
    * @param path The file path, including the file name. For example `folder/image.png`.
-   * @returns Promise with file metadata or error
+   * @returns Promise with response containing file metadata or error
    *
    * @example Get file info
    * ```js
@@ -873,7 +873,7 @@ export default class StorageFileApi {
    *
    * @category File Buckets
    * @param path The file path, including the file name. For example `folder/image.png`.
-   * @returns Promise with boolean indicating file existence or error
+   * @returns Promise with response containing boolean indicating file existence or error
    *
    * @example Check file existence
    * ```js
@@ -1005,7 +1005,7 @@ export default class StorageFileApi {
    *
    * @category File Buckets
    * @param paths An array of files to delete, including the path and file name. For example [`'folder/image.png'`].
-   * @returns Promise with list of deleted files or error
+   * @returns Promise with response containing array of deleted file objects or error
    *
    * @example Delete file
    * ```js
@@ -1123,7 +1123,7 @@ export default class StorageFileApi {
    * @param path The folder path.
    * @param options Search options including limit (defaults to 100), offset, sortBy, and search
    * @param parameters Optional fetch parameters including signal for cancellation
-   * @returns Promise with list of files or error
+   * @returns Promise with response containing array of files or error
    *
    * @example List files in a bucket
    * ```js