@supabase/storage-js 2.118.0-canary.2 → 2.118.0

package/README.md

@@ -1292,6 +1292,8 @@ pnpm nx test:clean-post storage-js
 
 The test infrastructure is managed via the Supabase CLI (`pnpm exec supabase start --workdir test`), which starts a local Supabase stack defined by the config in `test/`. This includes PostgreSQL, the Storage API, Kong Gateway, and supporting services.
 
+`test:infra` pins the Storage API image to the version in `test/supabase/storage-version`, since the encoding integration tests require Storage v1.80.0+. Update this file when upgrading the test server. CI includes this file in its Docker image cache key.
+
 #### Common Issues and Solutions
 
 | Issue                             | Solution                                                                                          |

package/dist/index.cjs

@@ -624,6 +624,7 @@ var StorageFileApi = class extends BaseApiClient {
 				body = fileBody;
 				headers["cache-control"] = `max-age=${options.cacheControl}`;
 				headers["content-type"] = options.contentType;
+				if (options.contentEncoding) headers["content-encoding"] = options.contentEncoding;
 				if (metadata) headers["x-metadata"] = _this.toBase64(_this.encodeMetadata(metadata));
 				if ((typeof ReadableStream !== "undefined" && body instanceof ReadableStream || body && typeof body === "object" && "pipe" in body && typeof body.pipe === "function") && !options.duplex) options.duplex = "half";
 			}
@@ -645,7 +646,7 @@ var StorageFileApi = class extends BaseApiClient {
 	* @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.
+	* @param fileOptions Optional file upload options including cacheControl, contentType, contentEncoding, upsert, and metadata.
 	* @returns Promise with response containing file path, id, and fullPath or error
 	*
 	* @example Upload file
@@ -716,7 +717,7 @@ var StorageFileApi = class extends BaseApiClient {
 	* @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.
-	* @param fileOptions HTTP headers (cacheControl, contentType, etc.).
+	* @param fileOptions HTTP headers (cacheControl, contentType, contentEncoding, etc.).
 	* **Note:** The `upsert` option has no effect here. To enable upsert behavior,
 	* pass `{ upsert: true }` when calling `createSignedUploadUrl()` instead.
 	* @returns Promise with response containing file path and fullPath or error
@@ -762,6 +763,7 @@ var StorageFileApi = class extends BaseApiClient {
 				body = fileBody;
 				headers["cache-control"] = `max-age=${options.cacheControl}`;
 				headers["content-type"] = options.contentType;
+				if (options.contentEncoding) headers["content-encoding"] = options.contentEncoding;
 				if (metadata) headers["x-metadata"] = _this3.toBase64(_this3.encodeMetadata(metadata));
 				if ((typeof ReadableStream !== "undefined" && body instanceof ReadableStream || body && typeof body === "object" && "pipe" in body && typeof body.pipe === "function") && !options.duplex) options.duplex = "half";
 			}
@@ -833,7 +835,7 @@ var StorageFileApi = class extends BaseApiClient {
 	* @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.
+	* @param fileOptions Optional file upload options including cacheControl, contentType, contentEncoding, and metadata.
 	* **Note:** The `upsert` option has no effect here. `update()` always replaces the
 	* file at the given path, so the `x-upsert` header is not sent. To control upsert
 	* behavior, use `upload()` instead.
@@ -938,8 +940,10 @@ var StorageFileApi = class extends BaseApiClient {
 	* @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.
+	* @param options The destination and metadata options.
 	* @param options.sourceVersionId The version id of the source object to copy.
+	* @param options.copyMetadata Whether to copy the source metadata. Defaults to true. Set to false to apply metadata overrides; custom user metadata is not copied when false.
+	* @param options.metadata File metadata overrides, applied only when copyMetadata is false. Unspecified fields retain their source values.
 	* @returns Promise with response containing copied file path or error
 	*
 	* @example Copy file
@@ -960,6 +964,18 @@ var StorageFileApi = class extends BaseApiClient {
 	* }
 	* ```
 	*
+	* @example Copy file with content encoding
+	* ```js
+	* const { data, error } = await supabase
+	*   .storage
+	*   .from('documents')
+	*   .copy('source.txt.gz', 'copy.txt.gz', {
+	*     copyMetadata: false,
+	*     metadata: { contentEncoding: 'gzip' },
+	*   })
+	* ```
+	* The source must already contain gzip-encoded bytes. Copying changes metadata only.
+	*
 	* @remarks
 	* - RLS policy permissions required:
 	*   - `buckets` table permissions: none
@@ -969,12 +985,15 @@ var StorageFileApi = class extends BaseApiClient {
 	async copy(fromPath, toPath, options) {
 		var _this7 = this;
 		return _this7.handleOperation(async () => {
+			const copyOptions = options;
 			return { path: (await post(_this7.fetch, `${_this7.url}/object/copy`, {
 				bucketId: _this7.bucketId,
 				sourceKey: fromPath,
 				destinationKey: toPath,
 				destinationBucket: options === null || options === void 0 ? void 0 : options.destinationBucket,
-				sourceVersionId: options === null || options === void 0 ? void 0 : options.sourceVersionId
+				sourceVersionId: options === null || options === void 0 ? void 0 : options.sourceVersionId,
+				copyMetadata: typeof (copyOptions === null || copyOptions === void 0 ? void 0 : copyOptions.copyMetadata) === "boolean" ? copyOptions.copyMetadata : void 0,
+				metadata: (copyOptions === null || copyOptions === void 0 ? void 0 : copyOptions.copyMetadata) === false ? copyOptions.metadata : void 0
 			}, { headers: _this7.headers })).Key };
 		});
 	}
@@ -1600,6 +1619,7 @@ var StorageFileApi = class extends BaseApiClient {
 		else files.push(["", fileBody]);
 		if (!body.has("cacheControl")) body.append("cacheControl", options.cacheControl);
 		if (options.metadata && !body.has("metadata")) body.append("metadata", this.encodeMetadata(options.metadata));
+		if (options.contentEncoding && !body.has("contentEncoding")) body.append("contentEncoding", options.contentEncoding);
 		for (const [name, file] of files) body.append(name, file);
 		return body;
 	}
@@ -1629,7 +1649,7 @@ var StorageFileApi = class extends BaseApiClient {
 
 //#endregion
 //#region src/lib/version.ts
-const version = "2.118.0-canary.2";
+const version = "2.118.0";
 
 //#endregion
 //#region src/lib/constants.ts