feat: getObjectFromS3 returns the whole object instead of the buffer; chore: rename functions

Author: ZackPedretti

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ialac/s3-utils",
-  "version": "1.2.3",
+  "version": "1.3.0",
   "main": "dist/index.js",
   "scripts": {
     "test": "vitest",

src/index.ts

@@ -29,7 +29,7 @@ export function getS3Client(config?: { endpoint: string, credentials: { accessKe
   return s3Client;
 }
 
-export async function putFileToS3(bucket: string, key: string, file: Buffer<ArrayBuffer>, s3Client?: S3Client) {
+export async function putObjectToS3(bucket: string, key: string, file: Buffer<ArrayBuffer>, s3Client?: S3Client) {
   s3Client ??= getS3Client();
   await s3Client.send(
     new PutObjectCommand({
@@ -40,15 +40,15 @@ export async function putFileToS3(bucket: string, key: string, file: Buffer<Arra
   )
 }
 
-export async function getFileFromS3(bucket: string, key: string, s3Client?: S3Client) {
+export async function getObjectFromS3(bucket: string, key: string, s3Client?: S3Client) {
   s3Client ??= getS3Client();
   const response = await s3Client.send(
     new GetObjectCommand({
       Bucket: bucket,
       Key: key
     })
   );
-  return response.Body;
+  return response;
 }
 
 export async function* listObjectsGenerator(bucket: string, prefix: string, options?: { maxKeys?: number, delimiter?: string, s3Client?: S3Client }) {
@@ -118,8 +118,8 @@ export function getEnvConfig() {
 }
 
 export async function getSHA1OfObject(bucket: string, key: string, s3Client?: S3Client) {
-  const obj = await getFileFromS3(bucket, key, s3Client);
-  const buffer = await obj?.transformToByteArray()
+  const obj = await getObjectFromS3(bucket, key, s3Client);
+  const buffer = await obj.Body?.transformToByteArray()
   if (buffer === undefined) {
     throw new Error("Buffer was undefined");
   }

test/index.test.ts

@@ -1,7 +1,7 @@
 import {
   getS3Client,
-  putFileToS3,
-  getFileFromS3,
+  putObjectToS3,
+  getObjectFromS3,
   resetS3Client,
   getListObjectsFromS3,
   s3FileExists,
@@ -51,7 +51,7 @@ describe("putFileToS3(bucket, key, file, s3Client?)", () => {
     const file = fs.readFileSync("test/test.xml");
 
     await expect(
-      putFileToS3("dev", "put_test/test.xml", file),
+      putObjectToS3("dev", "put_test/test.xml", file),
     ).rejects.toThrow();
   });
 
@@ -63,7 +63,7 @@ describe("putFileToS3(bucket, key, file, s3Client?)", () => {
   it("Should write the file in S3 (test/s3_mock) successfully", async () => {
     const file = fs.readFileSync("test/test.xml");
 
-    await putFileToS3("dev", "put_test/test.xml", file, mockClient);
+    await putObjectToS3("dev", "put_test/test.xml", file, mockClient);
 
     fs.readFileSync("test/s3_mock/dev/put_test/test.xml");
   });
@@ -74,7 +74,7 @@ describe("getFileFromS3(bucket, key, s3Client?)", () => {
 
   it("Should fail because s3Client is not set", async () => {
     await expect(
-      getFileFromS3("dev", "get_test/test.xml"),
+      getObjectFromS3("dev", "get_test/test.xml"),
     ).rejects.toThrow();
   });
 
@@ -84,10 +84,10 @@ describe("getFileFromS3(bucket, key, s3Client?)", () => {
       bucket: "dev",
     });
 
-    const s3File = await getFileFromS3("dev", "get_test/test.xml", mockClient);
+    const s3File = await getObjectFromS3("dev", "get_test/test.xml", mockClient);
     expect(s3File).not.toBeUndefined();
 
-    expect(await s3File?.transformToString()).toBe(
+    expect(await s3File.Body?.transformToString()).toBe(
       fs.readFileSync("test/s3_mock/dev/get_test/test.xml").toString(),
     );
   });