@supabase/storage-js 3.0.0-next.21 → 3.0.0-next.23

package/dist/index.cjs

@@ -623,7 +623,8 @@ var StorageFileApi = class extends BaseApiClient {
 	/**
 	* Uploads a file to an existing bucket.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @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.
@@ -677,7 +678,8 @@ var StorageFileApi = class extends BaseApiClient {
 	/**
 	* Upload a file with a token generated from `createSignedUploadUrl`.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @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 token The token generated from `createSignedUploadUrl`
 	* @param fileBody The body of the file to be stored in the bucket.
@@ -750,7 +752,8 @@ var StorageFileApi = class extends BaseApiClient {
 	* Signed upload URLs can be used to upload files to the bucket without further authentication.
 	* They are valid for 2 hours.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory 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 response containing signed upload URL, token, and path or error
@@ -801,7 +804,8 @@ var StorageFileApi = class extends BaseApiClient {
 	/**
 	* Replaces an existing file at the specified path with a new one.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @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, and metadata.
@@ -858,7 +862,8 @@ var StorageFileApi = class extends BaseApiClient {
 	/**
 	* Moves an existing file to a new path in the same bucket.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @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.
@@ -902,7 +907,8 @@ var StorageFileApi = class extends BaseApiClient {
 	/**
 	* Copies an existing file to a new path in the same bucket.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @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.
@@ -946,7 +952,8 @@ var StorageFileApi = class extends BaseApiClient {
 	/**
 	* Creates a signed URL. Use a signed URL to share a file for a fixed amount of time.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @param path The file path, including the current file name. For example `folder/image.png`.
 	* @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.
@@ -1017,7 +1024,8 @@ var StorageFileApi = class extends BaseApiClient {
 	/**
 	* Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @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.
@@ -1076,7 +1084,8 @@ var StorageFileApi = class extends BaseApiClient {
 	/**
 	* Downloads a file from a private bucket. For public buckets, make a request to the URL returned from `getPublicUrl` instead.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @param path The full path and file name of the file to be downloaded. For example `folder/image.png`.
 	* @param options.transform Transform the asset before serving it to the client.
 	* @param options.cacheNonce Append a cache nonce parameter to the URL to invalidate the cache.
@@ -1157,7 +1166,8 @@ var StorageFileApi = class extends BaseApiClient {
 	* Returns detailed file metadata including size, content type, and timestamps.
 	* Note: The API returns `last_modified` field, not `updated_at`.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @param path The file path, including the file name. For example `folder/image.png`.
 	* @returns Promise with response containing file metadata or error
 	*
@@ -1184,7 +1194,8 @@ var StorageFileApi = class extends BaseApiClient {
 	/**
 	* Checks the existence of a file.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @param path The file path, including the file name. For example `folder/image.png`.
 	* @returns `{ data: true, error: null }` when the file exists, `{ data: false, error: null }` when it does not (HTTP 400 or 404), or throws/returns a `StorageError` for any other failure.
 	*
@@ -1222,7 +1233,8 @@ var StorageFileApi = class extends BaseApiClient {
 	* A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.
 	* This function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @param path The path and name of the file to generate the public URL for. For example `folder/image.png`.
 	* @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.
@@ -1292,7 +1304,8 @@ var StorageFileApi = class extends BaseApiClient {
 	* Returns an array of FileObject entries for the deleted files. Note that deprecated
 	* fields like `bucket_id` may or may not be present in the response - do not rely on them.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @param paths An array of files to delete, including the path and file name. For example [`'folder/image.png'`].
 	* @returns Promise with response containing array of deleted file objects or error
 	*
@@ -1341,7 +1354,8 @@ var StorageFileApi = class extends BaseApiClient {
 	* Additionally, deprecated fields like `bucket_id`, `owner`, and `buckets` are NOT returned
 	* by this method.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @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
@@ -1430,7 +1444,8 @@ var StorageFileApi = class extends BaseApiClient {
 	*
 	* @experimental this method signature might change in the future
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @param options Search options including prefix, cursor for pagination, limit, with_delimiter
 	* @param parameters Optional fetch parameters including signal for cancellation
 	* @returns Promise with response containing folders/objects arrays with pagination info or error
@@ -1500,7 +1515,7 @@ var StorageFileApi = class extends BaseApiClient {
 
 //#endregion
 //#region src/lib/version.ts
-const version = "3.0.0-next.21";
+const version = "3.0.0-next.23";
 
 //#endregion
 //#region src/lib/constants.ts
@@ -1521,7 +1536,8 @@ var StorageBucketApi = class extends BaseApiClient {
 	/**
 	* Retrieves the details of all Storage buckets within an existing project.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @param options Query parameters for listing buckets
 	* @param options.limit Maximum number of buckets to return
 	* @param options.offset Number of buckets to skip
@@ -1566,7 +1582,8 @@ var StorageBucketApi = class extends BaseApiClient {
 	/**
 	* Retrieves the details of an existing Storage bucket.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @param id The unique identifier of the bucket you would like to retrieve.
 	* @returns Promise with response containing bucket details or error
 	*
@@ -1611,7 +1628,8 @@ var StorageBucketApi = class extends BaseApiClient {
 	/**
 	* Creates a new Storage bucket
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @param id A unique identifier for the bucket you are creating.
 	* @param options.public The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private.
 	* @param options.fileSizeLimit specifies the max file size in bytes that can be uploaded to this bucket.
@@ -1667,7 +1685,8 @@ var StorageBucketApi = class extends BaseApiClient {
 	/**
 	* Updates a Storage bucket
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @param id A unique identifier for the bucket you are updating.
 	* @param options.public The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations.
 	* @param options.fileSizeLimit specifies the max file size in bytes that can be uploaded to this bucket.
@@ -1720,7 +1739,8 @@ var StorageBucketApi = class extends BaseApiClient {
 	/**
 	* Removes all objects inside a single bucket.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @param id The unique identifier of the bucket you would like to empty.
 	* @returns Promise with success message or error
 	*
@@ -1757,7 +1777,8 @@ var StorageBucketApi = class extends BaseApiClient {
 	* Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.
 	* You must first `empty()` the bucket.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
 	* @param id The unique identifier of the bucket you would like to delete.
 	* @returns Promise with success message or error
 	*
@@ -1817,7 +1838,8 @@ var StorageAnalyticsClient = class extends BaseApiClient {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Analytics Buckets
+	* @category Storage
+	* @subcategory Analytics Buckets
 	* @param url - The base URL for the storage API
 	* @param headers - HTTP headers to include in requests
 	* @param fetch - Optional custom fetch implementation
@@ -1850,7 +1872,8 @@ var StorageAnalyticsClient = class extends BaseApiClient {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Analytics Buckets
+	* @category Storage
+	* @subcategory Analytics Buckets
 	* @param name A unique name for the bucket you are creating
 	* @returns Promise with response containing newly created analytics bucket or error
 	*
@@ -1894,7 +1917,8 @@ var StorageAnalyticsClient = class extends BaseApiClient {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Analytics Buckets
+	* @category Storage
+	* @subcategory Analytics Buckets
 	* @param options Query parameters for listing buckets
 	* @param options.limit Maximum number of buckets to return
 	* @param options.offset Number of buckets to skip
@@ -1959,7 +1983,8 @@ var StorageAnalyticsClient = class extends BaseApiClient {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Analytics Buckets
+	* @category Storage
+	* @subcategory Analytics Buckets
 	* @param bucketName The unique identifier of the bucket you would like to delete
 	* @returns Promise with response containing success message or error
 	*
@@ -2000,7 +2025,8 @@ var StorageAnalyticsClient = class extends BaseApiClient {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Analytics Buckets
+	* @category Storage
+	* @subcategory Analytics Buckets
 	* @param bucketName - The name of the analytics bucket (warehouse) to connect to
 	* @returns The wrapped Iceberg catalog client
 	* @throws {StorageError} If the bucket name is invalid
@@ -2352,7 +2378,8 @@ var StorageVectorsClient = class extends VectorBucketApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @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.
@@ -2384,7 +2411,8 @@ var StorageVectorsClient = class extends VectorBucketApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @param vectorBucketName - Name of the vector bucket
 	* @returns Bucket-scoped client with index and vector operations
 	*
@@ -2405,7 +2433,8 @@ var StorageVectorsClient = class extends VectorBucketApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @param vectorBucketName - Unique name for the vector bucket
 	* @returns Promise with empty response on success or error
 	*
@@ -2429,7 +2458,8 @@ var StorageVectorsClient = class extends VectorBucketApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @param vectorBucketName - Name of the vector bucket
 	* @returns Promise with bucket metadata or error
 	*
@@ -2455,7 +2485,8 @@ var StorageVectorsClient = class extends VectorBucketApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @param options - Optional filters (prefix, maxResults, nextToken)
 	* @returns Promise with list of buckets or error
 	*
@@ -2484,7 +2515,8 @@ var StorageVectorsClient = class extends VectorBucketApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @param vectorBucketName - Name of the vector bucket to delete
 	* @returns Promise with empty response on success or error
 	*
@@ -2518,7 +2550,8 @@ var VectorBucketScope = class extends VectorIndexApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @example Creating a vector bucket scope
 	* ```typescript
 	* const bucket = supabase.storage.vectors.from('embeddings-prod')
@@ -2537,7 +2570,8 @@ var VectorBucketScope = class extends VectorIndexApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @param options - Index configuration (vectorBucketName is automatically set)
 	* @returns Promise with empty response on success or error
 	*
@@ -2568,7 +2602,8 @@ var VectorBucketScope = class extends VectorIndexApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @param options - Listing options (vectorBucketName is automatically set)
 	* @returns Promise with response containing indexes array and pagination token or error
 	*
@@ -2591,7 +2626,8 @@ var VectorBucketScope = class extends VectorIndexApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @param indexName - Name of the index to retrieve
 	* @returns Promise with index metadata or error
 	*
@@ -2615,7 +2651,8 @@ var VectorBucketScope = class extends VectorIndexApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @param indexName - Name of the index to delete
 	* @returns Promise with empty response on success or error
 	*
@@ -2638,7 +2675,8 @@ var VectorBucketScope = class extends VectorIndexApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @param indexName - Name of the index
 	* @returns Index-scoped client with vector data operations
 	*
@@ -2682,7 +2720,8 @@ var VectorIndexScope = class extends VectorDataApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @example Creating a vector index scope
 	* ```typescript
 	* const index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')
@@ -2702,7 +2741,8 @@ var VectorIndexScope = class extends VectorDataApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @param options - Vector insertion options (bucket and index names automatically set)
 	* @returns Promise with empty response on success or error
 	*
@@ -2736,7 +2776,8 @@ var VectorIndexScope = class extends VectorDataApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @param options - Vector retrieval options (bucket and index names automatically set)
 	* @returns Promise with response containing vectors array or error
 	*
@@ -2765,7 +2806,8 @@ var VectorIndexScope = class extends VectorDataApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @param options - Listing options (bucket and index names automatically set)
 	* @returns Promise with response containing vectors array and pagination token or error
 	*
@@ -2794,7 +2836,8 @@ var VectorIndexScope = class extends VectorDataApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @param options - Query options (bucket and index names automatically set)
 	* @returns Promise with response containing matches array of similar vectors ordered by distance or error
 	*
@@ -2826,7 +2869,8 @@ var VectorIndexScope = class extends VectorDataApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
 	* @param options - Deletion options (bucket and index names automatically set)
 	* @returns Promise with empty response on success or error
 	*
@@ -2853,7 +2897,9 @@ var StorageClient = class extends StorageBucketApi {
 	/**
 	* Creates a client for Storage buckets, files, analytics, and vectors.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
+	*
 	* @example Using supabase-js (recommended)
 	* ```ts
 	* import { createClient } from '@supabase/supabase-js'
@@ -2878,7 +2924,9 @@ var StorageClient = class extends StorageBucketApi {
 	/**
 	* Perform file operation in a bucket.
 	*
-	* @category File Buckets
+	* @category Storage
+	* @subcategory File Buckets
+	*
 	* @param id The bucket id to operate on.
 	*
 	* @example Accessing a bucket
@@ -2897,7 +2945,9 @@ var StorageClient = class extends StorageBucketApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Vector Buckets
+	* @category Storage
+	* @subcategory Vector Buckets
+	*
 	* @returns A StorageVectorsClient instance configured with the current storage settings.
 	*/
 	get vectors() {
@@ -2914,7 +2964,9 @@ var StorageClient = class extends StorageBucketApi {
 	*
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
-	* @category Analytics Buckets
+	* @category Storage
+	* @subcategory Analytics Buckets
+	*
 	* @returns A StorageAnalyticsClient instance configured with the current storage settings.
 	*/
 	get analytics() {