lean-s3 0.7.10 → 0.8.0

package/README.md

@@ -41,6 +41,14 @@ if (exists) {
     });
     await otherFile.write(test);
 
+    // Copy the object to a new key in the same bucket
+    await test.copyTo("/test-copy.json");
+
+    // You can also copy to a different bucket
+    await test.copyTo("/test.json", {
+        destinationBucket: "foo-bucket",
+    });
+
     const firstBytesFile = test.slice(0, 100); // lazy-evaluated slicing
     const firstBytes = await firstBytesFile.bytes(); // evaluated using HTTP range requests
     console.log("First 100 bytes:", firstBytes);
@@ -135,6 +143,7 @@ See [DESIGN_DECISIONS.md](./DESIGN_DECISIONS.md) to read about why this library
 - ✅ [`DeleteObjects`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html) via `.deleteObjects`
 - ✅ [`DeleteObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) via `S3File.delete`
 - ✅ [`PutObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) via `S3File.write`
+- ✅ [`CopyObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) via `S3File.copyTo` / `.copyObject`
 - ✅ [`HeadObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html) via `S3File.exists`/`S3File.stat`
 - ✅ [`ListMultipartUploads`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) via `.listMultipartUploads`
 - ✅ [`ListParts`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) via `.listParts`

package/dist/index.d.ts

@@ -124,6 +124,22 @@ interface S3FilePresignOptions extends OverridableS3ClientOptions {
         contentDisposition?: ContentDisposition;
     };
 }
+type CopyObjectOptions = {
+    /** Set this to override the {@link S3ClientOptions#bucket} that was passed on creation of the {@link S3Client}. */
+    sourceBucket?: string;
+    /** Set this to override the {@link S3ClientOptions#bucket} that was passed on creation of the {@link S3Client}. */
+    destinationBucket?: string;
+    /** Signal to abort the request. */
+    signal?: AbortSignal;
+};
+type CopyObjectResult = {
+    etag?: string;
+    lastModified?: Date;
+    checksumCRC32?: string;
+    checksumCRC32C?: string;
+    checksumSHA1?: string;
+    checksumSHA256?: string;
+};
 type ListObjectsOptions = {
     /** Set this to override the {@link S3ClientOptions#bucket} that was passed on creation of the {@link S3Client}. */
     bucket?: string;
@@ -432,6 +448,11 @@ declare class S3Client {
      * ```
      */
     presign(path: string, options?: S3FilePresignOptions): string;
+    /**
+     * Copies an object from a source to a destination.
+     * @remarks Uses [`CopyObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html).
+     */
+    copyObject(sourceKey: string, destinationKey: string, options?: CopyObjectOptions): Promise<CopyObjectResult>;
     createMultipartUpload(key: string, options?: CreateMultipartUploadOptions): Promise<CreateMultipartUploadResult>;
     /**
      * @remarks Uses [`ListMultipartUploads`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html).
@@ -611,6 +632,12 @@ declare class S3File {
      * @returns {Promise<void>}
      */
     write(data: ByteSource, options?: S3FileWriteOptions): Promise<void>;
+    /**
+     * Copies this file to a new destination.
+     * @param destination The destination path, can be a string or another S3File instance.
+     * @param options Options for the copy operation.
+     */
+    copyTo(destination: string | S3File, options?: CopyObjectOptions): Promise<void>;
 }
 interface S3FileDeleteOptions extends OverridableS3ClientOptions {
     /** Signal to abort the request. */

package/dist/index.js

@@ -589,6 +589,46 @@ var S3Client = class {
     res.search = `${query}&X-Amz-Signature=${signature}`;
     return res.toString();
   }
+  /**
+   * Copies an object from a source to a destination.
+   * @remarks Uses [`CopyObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html).
+   */
+  async copyObject(sourceKey, destinationKey, options = {}) {
+    const sourceBucket = options.sourceBucket ? ensureValidBucketName(options.sourceBucket) : this.#options.bucket;
+    const destinationBucket = options.destinationBucket ? ensureValidBucketName(options.destinationBucket) : this.#options.bucket;
+    const normalizedSourceKey = normalizePath(ensureValidPath(sourceKey));
+    const copySource = encodeURIComponent(
+      `/${sourceBucket}/${normalizedSourceKey}`
+    );
+    const response = await this[kSignedRequest](
+      this.#options.region,
+      this.#options.endpoint,
+      destinationBucket,
+      "PUT",
+      ensureValidPath(destinationKey),
+      void 0,
+      void 0,
+      {
+        "x-amz-copy-source": copySource
+      },
+      void 0,
+      void 0,
+      options.signal
+    );
+    if (response.statusCode !== 200) {
+      throw await getResponseError(response, destinationKey);
+    }
+    const text = await response.body.text();
+    const res = ensureParsedXml(text).CopyObjectResult ?? {};
+    return {
+      etag: res.ETag,
+      lastModified: res.LastModified ? new Date(res.LastModified) : void 0,
+      checksumCRC32: res.ChecksumCRC32,
+      checksumCRC32C: res.ChecksumCRC32C,
+      checksumSHA1: res.ChecksumSHA1,
+      checksumSHA256: res.ChecksumSHA256
+    };
+  }
   //#region multipart uploads
   async createMultipartUpload(key, options = {}) {
     const response = await this[kSignedRequest](
@@ -1445,8 +1485,8 @@ var S3Client = class {
                   );
                 }
                 return controller.error(
-                  new S3Error(error.Code || "Unknown", path, {
-                    message: error.Message || void 0
+                  new S3Error(error.Error.Code || "Unknown", path, {
+                    message: error.Error.Message || void 0
                     // Message might be "",
                   })
                 );
@@ -1733,6 +1773,15 @@ var S3File = class _S3File {
       options.signal
     );
   }
+  /**
+   * Copies this file to a new destination.
+   * @param destination The destination path, can be a string or another S3File instance.
+   * @param options Options for the copy operation.
+   */
+  async copyTo(destination, options = {}) {
+    const destinationKey = typeof destination === "string" ? destination : destination.#path;
+    await this.#client.copyObject(this.#path, destinationKey, options);
+  }
 };
 export {
   S3BucketEntry,

package/package.json

@@ -2,7 +2,7 @@
   "name": "lean-s3",
   "author": "Niklas Mollenhauer",
   "license": "MIT",
-  "version": "0.7.10",
+  "version": "0.8.0",
   "description": "A server-side S3 API for the regular user.",
   "keywords": [
     "s3",
@@ -44,20 +44,20 @@
   },
   "dependencies": {
     "fast-xml-parser": "^5.2.5",
-    "undici": "^7.13.0"
+    "undici": "^7.15.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.1.3",
-    "@testcontainers/localstack": "^11.5.0",
-    "@testcontainers/minio": "^11.5.0",
-    "@types/node": "^24.1.0",
-    "@typescript/native-preview": "^7.0.0-dev.20250802.1",
+    "@biomejs/biome": "2.2.2",
+    "@testcontainers/localstack": "^11.5.1",
+    "@testcontainers/minio": "^11.5.1",
+    "@types/node": "^24.3.0",
+    "@typescript/native-preview": "^7.0.0-dev.20250825.1",
     "expect": "^30.0.5",
-    "lefthook": "^1.12.2",
-    "testcontainers": "^11.5.0",
+    "lefthook": "^1.12.3",
+    "testcontainers": "^11.5.1",
     "tsup": "^8.5.0",
-    "tsx": "^4.20.3",
-    "typedoc": "^0.28.9"
+    "tsx": "^4.20.5",
+    "typedoc": "^0.28.11"
   },
   "engines": {
     "node": "^20.19.3 || ^22.17.0 || ^24.4.0"