add headers to requests

client.ts

@@ -387,15 +387,23 @@ export class Client {
    */
   async deleteObject(
     objectName: string,
-    options: { bucketName?: string; versionId?: string; governanceBypass?: boolean } = {},
+    options: {
+      bucketName?: string;
+      versionId?: string;
+      governanceBypass?: boolean;
+      /**
+       * Additional headers to include in the request
+       */
+      headers?: Record<string, string>;
+    } = {},
   ) {
     const bucketName = this.getBucketName(options);
     if (!isValidObjectName(objectName)) {
       throw new errors.InvalidObjectNameError(`Invalid object name: ${objectName}`);
     }
 
     const query: Record<string, string> = options.versionId ? { versionId: options.versionId } : {};
-    const headers = new Headers();
+    const headers = new Headers(options.headers ?? {});
     if (options.governanceBypass) {
       headers.set("X-Amz-Bypass-Governance-Retention", "true");
     }
@@ -441,6 +449,10 @@ export class Client {
       bucketName?: string;
       versionId?: string;
       responseParams?: ResponseOverrideParams;
+      /**
+       * Additional headers to include in the request
+       */
+      headers?: Record<string, string>;
     },
   ): Promise<Response> {
     return this.getPartialObject(objectName, { ...options, offset: 0, length: 0 });
@@ -462,6 +474,10 @@ export class Client {
       bucketName?: string;
       versionId?: string;
       responseParams?: ResponseOverrideParams;
+      /**
+       * Additional headers to include in the request
+       */
+      headers?: Record<string, string>;
     },
   ): Promise<Response> {
     const bucketName = this.getBucketName(options);
@@ -471,7 +487,8 @@ export class Client {
       );
     }
 
-    const headers = new Headers(Object.entries(options.metadata ?? {}));
+    const init = { ...options?.headers, ...options?.metadata };
+    const headers = new Headers(init);
     let statusCode = 200; // Expected status code
     if (offset || length) {
       let range = "";
@@ -586,6 +603,10 @@ export class Client {
        * This will not affect the shape of the result, just its efficiency.
        */
       pageSize?: number;
+      /**
+       * Additional headers to include in the request
+       */
+      headers?: Record<string, string>;
     } = {},
   ): AsyncGenerator<S3Object, void, undefined> {
     for await (const result of this.listObjectsGrouped({ ...options, delimiter: "" })) {
@@ -617,6 +638,10 @@ export class Client {
        * This will not affect the shape of the result, just its efficiency.
        */
       pageSize?: number;
+      /**
+       * Additional headers to include in the request
+       */
+      headers?: Record<string, string>;
     },
   ): AsyncGenerator<S3Object | CommonPrefix, void, undefined> {
     const bucketName = this.getBucketName(options);
@@ -645,6 +670,7 @@ export class Client {
           "max-keys": String(maxKeys),
           ...(continuationToken ? { "continuation-token": continuationToken } : {}),
         },
+        headers: new Headers(options.headers ?? {}),
         returnBody: true,
       });
       const responseText = await pageResponse.text();
@@ -719,6 +745,10 @@ export class Client {
        * This is a minimum; larger part sizes may be required for large uploads or if the total size is unknown.
        */
       partSize?: number;
+      /**
+       * Additional headers to include in the request
+       */
+      headers?: Record<string, string>;
     },
   ): Promise<UploadedObjectInfo> {
     const bucketName = this.getBucketName(options);
@@ -797,6 +827,7 @@ export class Client {
       objectName,
       partSize,
       metadata: options?.metadata ?? {},
+      headers: options?.headers ?? {},
     });
     // stream => chunker => uploader
     await stream.pipeThrough(chunker).pipeTo(uploader);
@@ -865,7 +896,7 @@ export class Client {
       objectName,
       query,
       // Add custom headers if provided
-      headers: new Headers(options?.headers),
+      headers: new Headers(options?.headers ?? {}),
     });
 
     const metadata: ObjectMetadata = {};
@@ -902,6 +933,10 @@ export class Client {
       bucketName?: string;
       /** Metadata for the new object. If not specified, metadata will be copied from the source. */
       metadata?: ObjectMetadata;
+      /**
+       * Additional headers to include in the request
+       */
+      headers?: Record<string, string>;
     },
   ): Promise<CopiedObjectInfo> {
     const bucketName = this.getBucketName(options);
@@ -915,7 +950,8 @@ export class Client {
     let xAmzCopySource = `${sourceBucketName}/${source.sourceKey}`;
     if (source.sourceVersionId) xAmzCopySource += `?versionId=${source.sourceVersionId}`;
 
-    const headers = new Headers(options?.metadata);
+    const init = { ...options?.headers, ...options?.metadata };
+    const headers = new Headers(init);
     if (options?.metadata !== undefined) {
       headers.set("x-amz-metadata-directive", "REPLACE");
     }

object-uploader.ts

@@ -24,12 +24,13 @@ const multipartTagAlongMetadataKeys = [
 export class ObjectUploader extends WritableStream<Uint8Array> {
   public readonly getResult: () => UploadedObjectInfo;
 
-  constructor({ client, bucketName, objectName, partSize, metadata }: {
+  constructor({ client, bucketName, objectName, partSize, metadata, headers }: {
     client: Client;
     bucketName: string;
     objectName: string;
     partSize: number;
     metadata: Record<string, string>;
+    headers: Record<string, string>;
   }) {
     let result: UploadedObjectInfo;
     let nextPartNumber = 1;
@@ -53,6 +54,7 @@ export class ObjectUploader extends WritableStream<Uint8Array> {
                 // Set user metadata as this is not a multipart upload
                 ...metadata,
                 "Content-Length": String(chunk.length),
+                ...headers,
               }),
               bucketName,
               objectName,