@supabase/storage-js 2.81.2-canary.3 → 2.82.1-canary.0

package/dist/module/packages/{StorageAnalyticsApi.d.ts → StorageAnalyticsClient.d.ts}

@@ -2,10 +2,10 @@ import { StorageError } from '../lib/errors';
 import { Fetch } from '../lib/fetch';
 import { AnalyticBucket } from '../lib/types';
 /**
- * API class for managing Analytics Buckets using Iceberg tables
+ * Client class for managing Analytics Buckets using Iceberg tables
  * Provides methods for creating, listing, and deleting analytics buckets
  */
-export default class StorageAnalyticsApi {
+export default class StorageAnalyticsClient {
     protected url: string;
     protected headers: {
         [key: string]: string;
@@ -13,35 +13,64 @@ export default class StorageAnalyticsApi {
     protected fetch: Fetch;
     protected shouldThrowOnError: boolean;
     /**
-     * Creates a new StorageAnalyticsApi instance
+     * @alpha
+     *
+     * Creates a new StorageAnalyticsClient instance
+     *
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
+     *
+     * @category 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
+     *
+     * @example
+     * ```typescript
+     * const client = new StorageAnalyticsClient(url, headers)
+     * ```
      */
     constructor(url: string, headers?: {
         [key: string]: string;
     }, fetch?: 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 Analytics Buckets
      * @returns This instance for method chaining
      */
     throwOnError(): this;
     /**
+     * @alpha
+     *
      * Creates a new analytics bucket using Iceberg tables
      * Analytics buckets are optimized for analytical queries and data processing
      *
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
+     *
+     * @category Analytics Buckets
      * @param name A unique name for the bucket you are creating
      * @returns Promise with newly created bucket name or error
      *
-     * @example
-     * ```typescript
-     * const { data, error } = await storage.analytics.createBucket('analytics-data')
-     * if (error) {
-     *   console.error('Failed to create analytics bucket:', error.message)
-     * } else {
-     *   console.log('Created bucket:', data.name)
+     * @example Create analytics bucket
+     * ```js
+     * const { data, error } = await supabase
+     *   .storage
+     *   .analytics
+     *   .createBucket('analytics-data')
+     * ```
+     *
+     * Response:
+     * ```json
+     * {
+     *   "data": {
+     *     "name": "analytics-data"
+     *   },
+     *   "error": null
      * }
      * ```
      */
@@ -53,9 +82,14 @@ export default class StorageAnalyticsApi {
         error: StorageError;
     }>;
     /**
+     * @alpha
+     *
      * Retrieves the details of all Analytics Storage buckets within an existing project
      * Only returns buckets of type 'ANALYTICS'
      *
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
+     *
+     * @category 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
@@ -64,18 +98,32 @@ export default class StorageAnalyticsApi {
      * @param options.search Search term to filter bucket names
      * @returns Promise with list of analytics buckets or error
      *
-     * @example
-     * ```typescript
-     * const { data, error } = await storage.analytics.listBuckets({
-     *   limit: 10,
-     *   offset: 0,
-     *   sortColumn: 'created_at',
-     *   sortOrder: 'desc',
-     *   search: 'analytics'
-     * })
-     * if (data) {
-     *   console.log('Found analytics buckets:', data.length)
-     *   data.forEach(bucket => console.log(`- ${bucket.name}`))
+     * @example List analytics buckets
+     * ```js
+     * const { data, error } = await supabase
+     *   .storage
+     *   .analytics
+     *   .listBuckets({
+     *     limit: 10,
+     *     offset: 0,
+     *     sortColumn: 'created_at',
+     *     sortOrder: 'desc'
+     *   })
+     * ```
+     *
+     * Response:
+     * ```json
+     * {
+     *   "data": [
+     *     {
+     *       "id": "analytics-data",
+     *       "name": "analytics-data",
+     *       "type": "ANALYTICS",
+     *       "created_at": "2024-05-22T22:26:05.100Z",
+     *       "updated_at": "2024-05-22T22:26:05.100Z"
+     *     }
+     *   ],
+     *   "error": null
      * }
      * ```
      */
@@ -93,20 +141,33 @@ export default class StorageAnalyticsApi {
         error: StorageError;
     }>;
     /**
+     * @alpha
+     *
      * Deletes an existing analytics bucket
      * A bucket can't be deleted with existing objects inside it
      * You must first empty the bucket before deletion
      *
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
+     *
+     * @category Analytics Buckets
      * @param bucketName The unique identifier of the bucket you would like to delete
      * @returns Promise with success message or error
      *
-     * @example
-     * ```typescript
-     * const { data, error } = await analyticsApi.deleteBucket('old-analytics-bucket')
-     * if (error) {
-     *   console.error('Failed to delete bucket:', error.message)
-     * } else {
-     *   console.log('Bucket deleted successfully:', data.message)
+     * @example Delete analytics bucket
+     * ```js
+     * const { data, error } = await supabase
+     *   .storage
+     *   .analytics
+     *   .deleteBucket('analytics-data')
+     * ```
+     *
+     * Response:
+     * ```json
+     * {
+     *   "data": {
+     *     "message": "Successfully deleted"
+     *   },
+     *   "error": null
      * }
      * ```
      */
@@ -120,4 +181,4 @@ export default class StorageAnalyticsApi {
         error: StorageError;
     }>;
 }
-//# sourceMappingURL=StorageAnalyticsApi.d.ts.map
+//# sourceMappingURL=StorageAnalyticsClient.d.ts.map

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

@@ -0,0 +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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;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"}

package/dist/module/packages/{StorageAnalyticsApi.js → StorageAnalyticsClient.js}

@@ -4,15 +4,26 @@ import { isStorageError } from '../lib/errors';
 import { get, post, remove } from '../lib/fetch';
 import { resolveFetch } from '../lib/helpers';
 /**
- * API class for managing Analytics Buckets using Iceberg tables
+ * Client class for managing Analytics Buckets using Iceberg tables
  * Provides methods for creating, listing, and deleting analytics buckets
  */
-export default class StorageAnalyticsApi {
+export default class StorageAnalyticsClient {
     /**
-     * Creates a new StorageAnalyticsApi instance
+     * @alpha
+     *
+     * Creates a new StorageAnalyticsClient instance
+     *
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
+     *
+     * @category 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
+     *
+     * @example
+     * ```typescript
+     * const client = new StorageAnalyticsClient(url, headers)
+     * ```
      */
     constructor(url, headers = {}, fetch) {
         this.shouldThrowOnError = false;
@@ -21,9 +32,14 @@ export default class StorageAnalyticsApi {
         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 Analytics Buckets
      * @returns This instance for method chaining
      */
     throwOnError() {
@@ -31,19 +47,32 @@ export default class StorageAnalyticsApi {
         return this;
     }
     /**
+     * @alpha
+     *
      * Creates a new analytics bucket using Iceberg tables
      * Analytics buckets are optimized for analytical queries and data processing
      *
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
+     *
+     * @category Analytics Buckets
      * @param name A unique name for the bucket you are creating
      * @returns Promise with newly created bucket name or error
      *
-     * @example
-     * ```typescript
-     * const { data, error } = await storage.analytics.createBucket('analytics-data')
-     * if (error) {
-     *   console.error('Failed to create analytics bucket:', error.message)
-     * } else {
-     *   console.log('Created bucket:', data.name)
+     * @example Create analytics bucket
+     * ```js
+     * const { data, error } = await supabase
+     *   .storage
+     *   .analytics
+     *   .createBucket('analytics-data')
+     * ```
+     *
+     * Response:
+     * ```json
+     * {
+     *   "data": {
+     *     "name": "analytics-data"
+     *   },
+     *   "error": null
      * }
      * ```
      */
@@ -65,9 +94,14 @@ export default class StorageAnalyticsApi {
         });
     }
     /**
+     * @alpha
+     *
      * Retrieves the details of all Analytics Storage buckets within an existing project
      * Only returns buckets of type 'ANALYTICS'
      *
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
+     *
+     * @category 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
@@ -76,18 +110,32 @@ export default class StorageAnalyticsApi {
      * @param options.search Search term to filter bucket names
      * @returns Promise with list of analytics buckets or error
      *
-     * @example
-     * ```typescript
-     * const { data, error } = await storage.analytics.listBuckets({
-     *   limit: 10,
-     *   offset: 0,
-     *   sortColumn: 'created_at',
-     *   sortOrder: 'desc',
-     *   search: 'analytics'
-     * })
-     * if (data) {
-     *   console.log('Found analytics buckets:', data.length)
-     *   data.forEach(bucket => console.log(`- ${bucket.name}`))
+     * @example List analytics buckets
+     * ```js
+     * const { data, error } = await supabase
+     *   .storage
+     *   .analytics
+     *   .listBuckets({
+     *     limit: 10,
+     *     offset: 0,
+     *     sortColumn: 'created_at',
+     *     sortOrder: 'desc'
+     *   })
+     * ```
+     *
+     * Response:
+     * ```json
+     * {
+     *   "data": [
+     *     {
+     *       "id": "analytics-data",
+     *       "name": "analytics-data",
+     *       "type": "ANALYTICS",
+     *       "created_at": "2024-05-22T22:26:05.100Z",
+     *       "updated_at": "2024-05-22T22:26:05.100Z"
+     *     }
+     *   ],
+     *   "error": null
      * }
      * ```
      */
@@ -123,20 +171,33 @@ export default class StorageAnalyticsApi {
         });
     }
     /**
+     * @alpha
+     *
      * Deletes an existing analytics bucket
      * A bucket can't be deleted with existing objects inside it
      * You must first empty the bucket before deletion
      *
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
+     *
+     * @category Analytics Buckets
      * @param bucketName The unique identifier of the bucket you would like to delete
      * @returns Promise with success message or error
      *
-     * @example
-     * ```typescript
-     * const { data, error } = await analyticsApi.deleteBucket('old-analytics-bucket')
-     * if (error) {
-     *   console.error('Failed to delete bucket:', error.message)
-     * } else {
-     *   console.log('Bucket deleted successfully:', data.message)
+     * @example Delete analytics bucket
+     * ```js
+     * const { data, error } = await supabase
+     *   .storage
+     *   .analytics
+     *   .deleteBucket('analytics-data')
+     * ```
+     *
+     * Response:
+     * ```json
+     * {
+     *   "data": {
+     *     "message": "Successfully deleted"
+     *   },
+     *   "error": null
      * }
      * ```
      */
@@ -158,4 +219,4 @@ export default class StorageAnalyticsApi {
         });
     }
 }
-//# sourceMappingURL=StorageAnalyticsApi.js.map
+//# sourceMappingURL=StorageAnalyticsClient.js.map

package/dist/module/packages/StorageAnalyticsClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageAnalyticsClient.js","sourceRoot":"","sources":["../../../src/packages/StorageAnalyticsClient.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,cAAc,EAAgB,MAAM,eAAe,CAAA;AAC5D,OAAO,EAAS,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAG7C;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,sBAAsB;IAMzC;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,GAAW,EAAE,UAAqC,EAAE,EAAE,KAAa;QAnBrE,uBAAkB,GAAG,KAAK,CAAA;QAoBlC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACjC,IAAI,CAAC,OAAO,mCAAQ,eAAe,GAAK,OAAO,CAAE,CAAA;QACjD,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IAED;;;;;;;;;;OAUG;IACI,YAAY;QACjB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAA;QAC9B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,YAAY,CAAC,IAAY;;YAU7B,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,SAAS,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;gBAC9F,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC9B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBAED,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,WAAW,CAAC,OAMjB;;YAUC,IAAI,CAAC;gBACH,kCAAkC;gBAClC,MAAM,WAAW,GAAG,IAAI,eAAe,EAAE,CAAA;gBACzC,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,MAAK,SAAS;oBAAE,WAAW,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;gBACpF,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,MAAK,SAAS;oBAAE,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAA;gBACvF,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;oBAAE,WAAW,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,UAAU,CAAC,CAAA;gBAC1E,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS;oBAAE,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;gBACvE,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM;oBAAE,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;gBAE9D,MAAM,WAAW,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAA;gBAC1C,MAAM,GAAG,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,WAAW,WAAW,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAA;gBAEpF,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;gBAElE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YACpC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBAED,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,YAAY,CAAC,UAAkB;;YAUnC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,MAAM,CACvB,IAAI,CAAC,KAAK,EACV,GAAG,IAAI,CAAC,GAAG,WAAW,UAAU,EAAE,EAClC,EAAE,EACF,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAC1B,CAAA;gBACD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC9B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBAED,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;CACF"}

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

@@ -14,10 +14,41 @@ export default class StorageBucketApi {
     }, fetch?: Fetch, opts?: StorageClientOptions);
     /**
      * Enable throwing errors instead of returning them.
+     *
+     * @category File Buckets
      */
     throwOnError(): this;
     /**
      * Retrieves the details of all Storage buckets within an existing project.
+     *
+     * @category 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
+     * @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
+     *
+     * @example List buckets
+     * ```js
+     * const { data, error } = await supabase
+     *   .storage
+     *   .listBuckets()
+     * ```
+     *
+     * @example List buckets with options
+     * ```js
+     * const { data, error } = await supabase
+     *   .storage
+     *   .listBuckets({
+     *     limit: 10,
+     *     offset: 0,
+     *     sortColumn: 'created_at',
+     *     sortOrder: 'desc',
+     *     search: 'prod'
+     *   })
+     * ```
      */
     listBuckets(options?: ListBucketOptions): Promise<{
         data: Bucket[];
@@ -29,7 +60,35 @@ export default class StorageBucketApi {
     /**
      * Retrieves the details of an existing Storage bucket.
      *
+     * @category File Buckets
      * @param id The unique identifier of the bucket you would like to retrieve.
+     * @returns Promise with bucket details or error
+     *
+     * @example Get bucket
+     * ```js
+     * const { data, error } = await supabase
+     *   .storage
+     *   .getBucket('avatars')
+     * ```
+     *
+     * Response:
+     * ```json
+     * {
+     *   "data": {
+     *     "id": "avatars",
+     *     "name": "avatars",
+     *     "owner": "",
+     *     "public": false,
+     *     "file_size_limit": 1024,
+     *     "allowed_mime_types": [
+     *       "image/png"
+     *     ],
+     *     "created_at": "2024-05-22T22:26:05.100Z",
+     *     "updated_at": "2024-05-22T22:26:05.100Z"
+     *   },
+     *   "error": null
+     * }
+     * ```
      */
     getBucket(id: string): Promise<{
         data: Bucket;
@@ -41,6 +100,7 @@ export default class StorageBucketApi {
     /**
      * Creates a new Storage bucket
      *
+     * @category 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.
@@ -49,9 +109,30 @@ 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 newly created bucket id
      * @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
+     *
+     * @example Create bucket
+     * ```js
+     * const { data, error } = await supabase
+     *   .storage
+     *   .createBucket('avatars', {
+     *     public: false,
+     *     allowedMimeTypes: ['image/png'],
+     *     fileSizeLimit: 1024
+     *   })
+     * ```
+     *
+     * Response:
+     * ```json
+     * {
+     *   "data": {
+     *     "name": "avatars"
+     *   },
+     *   "error": null
+     * }
+     * ```
      */
     createBucket(id: string, options?: {
         public: boolean;
@@ -68,6 +149,7 @@ export default class StorageBucketApi {
     /**
      * Updates a Storage bucket
      *
+     * @category 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.
@@ -76,6 +158,28 @@ 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
+     *
+     * @example Update bucket
+     * ```js
+     * const { data, error } = await supabase
+     *   .storage
+     *   .updateBucket('avatars', {
+     *     public: false,
+     *     allowedMimeTypes: ['image/png'],
+     *     fileSizeLimit: 1024
+     *   })
+     * ```
+     *
+     * Response:
+     * ```json
+     * {
+     *   "data": {
+     *     "message": "Successfully updated"
+     *   },
+     *   "error": null
+     * }
+     * ```
      */
     updateBucket(id: string, options: {
         public: boolean;
@@ -93,7 +197,26 @@ export default class StorageBucketApi {
     /**
      * Removes all objects inside a single bucket.
      *
+     * @category File Buckets
      * @param id The unique identifier of the bucket you would like to empty.
+     * @returns Promise with success message or error
+     *
+     * @example Empty bucket
+     * ```js
+     * const { data, error } = await supabase
+     *   .storage
+     *   .emptyBucket('avatars')
+     * ```
+     *
+     * Response:
+     * ```json
+     * {
+     *   "data": {
+     *     "message": "Successfully emptied"
+     *   },
+     *   "error": null
+     * }
+     * ```
      */
     emptyBucket(id: string): Promise<{
         data: {
@@ -108,7 +231,26 @@ export default class StorageBucketApi {
      * Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.
      * You must first `empty()` the bucket.
      *
+     * @category File Buckets
      * @param id The unique identifier of the bucket you would like to delete.
+     * @returns Promise with success message or error
+     *
+     * @example Delete bucket
+     * ```js
+     * const { data, error } = await supabase
+     *   .storage
+     *   .deleteBucket('avatars')
+     * ```
+     *
+     * Response:
+     * ```json
+     * {
+     *   "data": {
+     *     "message": "Successfully deleted"
+     *   },
+     *   "error": null
+     * }
+     * ```
      */
     deleteBucket(id: string): Promise<{
         data: {

package/dist/module/packages/StorageBucketApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StorageBucketApi.d.ts","sourceRoot":"","sources":["../../../src/packages/StorageBucketApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5D,OAAO,EAAE,KAAK,EAA0B,MAAM,cAAc,CAAA;AAE5D,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AAEvD,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,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;gBAGlC,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EACvC,KAAK,CAAC,EAAE,KAAK,EACb,IAAI,CAAC,EAAE,oBAAoB;IAkB7B;;OAEG;IACI,YAAY,IAAI,IAAI;IAK3B;;OAEG;IACG,WAAW,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CACnD;QACE,IAAI,EAAE,MAAM,EAAE,CAAA;QACd,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,YAAY,CAAA;KACpB,CACJ;IAmBD;;;;OAIG;IACG,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAChC;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,YAAY,CAAA;KACpB,CACJ;IAgBD;;;;;;;;;;;;;;OAcG;IACG,YAAY,CAChB,EAAE,EAAE,MAAM,EACV,OAAO,GAAE;QACP,MAAM,EAAE,OAAO,CAAA;QACf,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;QACtC,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;QAClC,IAAI,CAAC,EAAE,UAAU,CAAA;KAGlB,GACA,OAAO,CACN;QACE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC1B,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,YAAY,CAAA;KACpB,CACJ;IA4BD;;;;;;;;;;;OAWG;IACG,YAAY,CAChB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE;QACP,MAAM,EAAE,OAAO,CAAA;QACf,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;QACtC,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;KACnC,GACA,OAAO,CACN;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;IA2BD;;;;OAIG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAClC;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;IAqBD;;;;;OAKG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CACnC;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;IAqBD,OAAO,CAAC,8BAA8B;CAqBvC"}
+{"version":3,"file":"StorageBucketApi.d.ts","sourceRoot":"","sources":["../../../src/packages/StorageBucketApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5D,OAAO,EAAE,KAAK,EAA0B,MAAM,cAAc,CAAA;AAE5D,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AAEvD,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,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;gBAGlC,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EACvC,KAAK,CAAC,EAAE,KAAK,EACb,IAAI,CAAC,EAAE,oBAAoB;IAkB7B;;;;OAIG;IACI,YAAY,IAAI,IAAI;IAK3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,WAAW,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CACnD;QACE,IAAI,EAAE,MAAM,EAAE,CAAA;QACd,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,YAAY,CAAA;KACpB,CACJ;IAmBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAChC;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,YAAY,CAAA;KACpB,CACJ;IAgBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACG,YAAY,CAChB,EAAE,EAAE,MAAM,EACV,OAAO,GAAE;QACP,MAAM,EAAE,OAAO,CAAA;QACf,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;QACtC,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;QAClC,IAAI,CAAC,EAAE,UAAU,CAAA;KAGlB,GACA,OAAO,CACN;QACE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC1B,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,YAAY,CAAA;KACpB,CACJ;IA4BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,YAAY,CAChB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE;QACP,MAAM,EAAE,OAAO,CAAA;QACf,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;QACtC,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;KACnC,GACA,OAAO,CACN;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;IA2BD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAClC;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;IAqBD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CACnC;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;IAqBD,OAAO,CAAC,8BAA8B;CAqBvC"}