@supabase/storage-js 2.115.1-canary.0 → 2.116.0-canary.1

package/README.md

@@ -51,6 +51,7 @@
 - **Image Transformations**: On-the-fly image resizing and optimization
 - **Vector Embeddings**: Store and query high-dimensional embeddings with similarity search
 - **Analytics Buckets**: Iceberg table-based buckets optimized for analytical queries and data processing
+- **Lifecycle**: Expire previous versions of objects after a number of days
 
 ## Quick Start Guide
 
@@ -229,6 +230,27 @@ await storageClient.analytics.deleteBucket('analytics-data')
   })
   ```
 
+- Manage a bucket's lifecycle policy. Rules expire **previous versions** of objects after a number of days, so versioning needs to be enabled or the policy has nothing to act on. This is Standard buckets only, and the project must have lifecycle enabled.
+
+  ```js
+  // Replaces every existing rule
+  const { data, error } = await storageClient.updateBucketLifecycle('test_bucket', {
+    rules: [
+      {
+        id: 'expire-old-versions',
+        status: 'Enabled',
+        filter: {},
+        noncurrentVersionExpiration: { noncurrentDays: 30 },
+      },
+    ],
+  })
+
+  // Fails with NoSuchLifecycleConfiguration when the bucket has no policy
+  const { data: config, error: configError } = await storageClient.getBucketLifecycle('test_bucket')
+
+  await storageClient.deleteBucketLifecycle('test_bucket')
+  ```
+
 #### Handling Files
 
 - Upload a file to an existing bucket:

package/dist/index.cjs

@@ -1629,7 +1629,7 @@ var StorageFileApi = class extends BaseApiClient {
 
 //#endregion
 //#region src/lib/version.ts
-const version = "2.115.1-canary.0";
+const version = "2.116.0-canary.1";
 
 //#endregion
 //#region src/lib/constants.ts
@@ -1932,6 +1932,153 @@ var StorageBucketApi = class extends BaseApiClient {
 		});
 	}
 	/**
+	* Returns the lifecycle policy stored on a bucket.
+	*
+	* Fails with `NoSuchLifecycleConfiguration` when the bucket has no policy.
+	*
+	* These rules expire previous versions of objects, not the current one.
+	* Turn versioning on or there is nothing for the policy to act on.
+	* Standard buckets only. Returns `FeatureNotEnabled` if lifecycle is off
+	* for the project.
+	*
+	* @category Storage
+	* @subcategory File Buckets
+	* @param id The unique identifier of the bucket.
+	* @returns Promise with the lifecycle configuration or error
+	*
+	* @example Get lifecycle configuration
+	* ```js
+	* const { data, error } = await supabase
+	*   .storage
+	*   .getBucketLifecycle('avatars')
+	* ```
+	*
+	* Response:
+	* ```json
+	* {
+	*   "data": {
+	*     "rules": [
+	*       {
+	*         "id": "expire-history",
+	*         "status": "Enabled",
+	*         "filter": {},
+	*         "noncurrentVersionExpiration": {
+	*           "noncurrentDays": 30,
+	*           "newerNoncurrentVersions": 2
+	*         }
+	*       }
+	*     ]
+	*   },
+	*   "error": null
+	* }
+	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: `select`
+	*   - `objects` table permissions: none
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
+	*/
+	async getBucketLifecycle(id) {
+		var _this7 = this;
+		return _this7.handleOperation(async () => {
+			return await get(_this7.fetch, _this7.bucketLifecycleUrl(id), { headers: _this7.headers });
+		});
+	}
+	/**
+	* Replaces the lifecycle policy on a bucket.
+	*
+	* The `rules` array you send is the whole policy. Anything previously stored
+	* is overwritten. Send at least one rule. Call {@link deleteBucketLifecycle}
+	* to remove the policy.
+	*
+	* Each rule currently supports only `noncurrentVersionExpiration`. Set
+	* `filter` to `{}`. Prefix filters, tag filters, and current-object
+	* expiration are rejected. Rule IDs must be unique. Omit `id` and the
+	* server generates one.
+	*
+	* Standard buckets only. Returns `FeatureNotEnabled` if lifecycle is off
+	* for the project.
+	*
+	* @category Storage
+	* @subcategory File Buckets
+	* @param id The unique identifier of the bucket.
+	* @param configuration The full lifecycle configuration to store.
+	* @returns Promise with the stored configuration or error
+	*
+	* @example Replace lifecycle configuration
+	* ```js
+	* const { data, error } = await supabase
+	*   .storage
+	*   .updateBucketLifecycle('avatars', {
+	*     rules: [
+	*       {
+	*         id: 'expire-history',
+	*         status: 'Enabled',
+	*         filter: {},
+	*         noncurrentVersionExpiration: {
+	*           noncurrentDays: 30,
+	*           newerNoncurrentVersions: 2,
+	*         },
+	*       },
+	*     ],
+	*   })
+	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: `select` and `update`
+	*   - `objects` table permissions: none
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
+	*/
+	async updateBucketLifecycle(id, configuration) {
+		var _this8 = this;
+		return _this8.handleOperation(async () => {
+			return await put(_this8.fetch, _this8.bucketLifecycleUrl(id), configuration, { headers: _this8.headers });
+		});
+	}
+	/**
+	* Removes the lifecycle policy from a bucket.
+	*
+	* Safe to call when no policy is stored. The response is still success.
+	* Standard buckets only. Returns `FeatureNotEnabled` if lifecycle is off
+	* for the project.
+	*
+	* @category Storage
+	* @subcategory File Buckets
+	* @param id The unique identifier of the bucket.
+	* @returns Promise with success message or error
+	*
+	* @example Delete lifecycle configuration
+	* ```js
+	* const { data, error } = await supabase
+	*   .storage
+	*   .deleteBucketLifecycle('avatars')
+	* ```
+	*
+	* Response:
+	* ```json
+	* {
+	*   "data": {
+	*     "message": "Successfully deleted"
+	*   },
+	*   "error": null
+	* }
+	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: `select` and `update`
+	*   - `objects` table permissions: none
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
+	*/
+	async deleteBucketLifecycle(id) {
+		var _this9 = this;
+		return _this9.handleOperation(async () => {
+			return await remove(_this9.fetch, _this9.bucketLifecycleUrl(id), {}, { headers: _this9.headers });
+		});
+	}
+	/**
 	* Purges the CDN cache for an entire bucket.
 	*
 	* Maps to `DELETE /cdn/{bucket}` on the Storage API. The server
@@ -1968,14 +2115,17 @@ var StorageBucketApi = class extends BaseApiClient {
 	* ```
 	*/
 	async purgeBucketCache(id, options, parameters) {
-		var _this7 = this;
-		return _this7.handleOperation(async () => {
+		var _this10 = this;
+		return _this10.handleOperation(async () => {
 			const query = new URLSearchParams();
 			if (options === null || options === void 0 ? void 0 : options.transformations) query.set("transformations", "true");
 			const queryString = query.toString();
-			return await remove(_this7.fetch, `${_this7.url}/cdn/${encodeStoragePath(id)}${queryString ? `?${queryString}` : ""}`, {}, { headers: _this7.headers }, parameters);
+			return await remove(_this10.fetch, `${_this10.url}/cdn/${encodeStoragePath(id)}${queryString ? `?${queryString}` : ""}`, {}, { headers: _this10.headers }, parameters);
 		});
 	}
+	bucketLifecycleUrl(id) {
+		return `${this.url}/bucket/${encodeStoragePath(id)}/lifecycle`;
+	}
 	listBucketOptionsToQueryString(options) {
 		const params = {};
 		if (options) {