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

package/dist/module/packages/StorageAnalyticsClient.d.ts

@@ -54,7 +54,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
@@ -97,10 +97,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
@@ -134,7 +134,7 @@ export default class StorageAnalyticsClient {
     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<{
@@ -155,7 +155,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/dist/module/packages/StorageAnalyticsClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StorageAnalyticsClient.d.ts","sourceRoot":"","sources":["../../../src/packages/StorageAnalyticsClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5D,OAAO,EAAE,KAAK,EAAqB,MAAM,cAAc,CAAA;AAEvD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAE7C;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,sBAAsB;IACzC,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;;;;;;;;;;;;;;;;OAgBG;gBACS,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EAAE,KAAK,CAAC,EAAE,KAAK;IAM/E;;;;;;;;;;OAUG;IACI,YAAY,IAAI,IAAI;IAK3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CACrC;QACE,IAAI,EAAE,cAAc,CAAA;QACpB,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,YAAY,CAAA;KACpB,CACJ;IAgBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,WAAW,CAAC,OAAO,CAAC,EAAE;QAC1B,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,YAAY,GAAG,YAAY,CAAA;QACxD,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;QAC1B,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,GAAG,OAAO,CACP;QACE,IAAI,EAAE,cAAc,EAAE,CAAA;QACtB,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,YAAY,CAAA;KACpB,CACJ;IA4BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAC3C;QACE,IAAI,EAAE;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,CAAA;QACzB,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,YAAY,CAAA;KACpB,CACJ;CAoBF"}
+{"version":3,"file":"StorageAnalyticsClient.d.ts","sourceRoot":"","sources":["../../../src/packages/StorageAnalyticsClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5D,OAAO,EAAE,KAAK,EAAqB,MAAM,cAAc,CAAA;AAEvD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAE7C;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,sBAAsB;IACzC,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;;;;;;;;;;;;;;;;OAgBG;gBACS,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EAAE,KAAK,CAAC,EAAE,KAAK;IAM/E;;;;;;;;;;OAUG;IACI,YAAY,IAAI,IAAI;IAK3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CACrC;QACE,IAAI,EAAE,cAAc,CAAA;QACpB,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,YAAY,CAAA;KACpB,CACJ;IAgBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,WAAW,CAAC,OAAO,CAAC,EAAE;QAC1B,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,UAAU,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,YAAY,CAAA;QACjD,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;QAC1B,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,GAAG,OAAO,CACP;QACE,IAAI,EAAE,cAAc,EAAE,CAAA;QACtB,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,YAAY,CAAA;KACpB,CACJ;IA4BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAC3C;QACE,IAAI,EAAE;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,CAAA;QACzB,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,YAAY,CAAA;KACpB,CACJ;CAoBF"}

package/dist/module/packages/StorageAnalyticsClient.js

@@ -56,7 +56,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
@@ -109,10 +109,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
@@ -185,7 +185,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/dist/module/packages/StorageBucketApi.d.ts

@@ -28,7 +28,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
@@ -62,7 +62,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
@@ -111,7 +111,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
@@ -158,7 +158,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/dist/module/packages/StorageBucketApi.js

@@ -38,7 +38,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
@@ -85,7 +85,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
@@ -144,7 +144,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
@@ -205,7 +205,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/dist/module/packages/StorageFileApi.d.ts

@@ -35,7 +35,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
@@ -91,7 +91,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
@@ -130,7 +130,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
@@ -172,7 +172,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
@@ -227,7 +227,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
@@ -263,7 +263,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
@@ -300,7 +300,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
@@ -362,7 +362,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
@@ -452,7 +452,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
@@ -474,7 +474,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
@@ -554,7 +554,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
@@ -595,7 +595,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

package/dist/module/packages/StorageFileApi.js

@@ -109,7 +109,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
@@ -159,7 +159,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
@@ -229,7 +229,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
@@ -285,7 +285,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
@@ -334,7 +334,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
@@ -383,7 +383,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
@@ -433,7 +433,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
@@ -506,7 +506,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
@@ -617,7 +617,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
@@ -652,7 +652,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
@@ -763,7 +763,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
@@ -864,7 +864,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