Use "@aws-sdk/client-s3" instead of "aws-sdk"

DennisSnijder commented 1 year ago

Context

At the moment, the library requires you to install the enitre aws-sdk which results into a node module of +- 80MB. AWS has a standalone SDK for the S3 client, which reduces the AWS dependency from 80MB to ~4MB.

What has been done

Removed the aws-sdk package in favor of @aws-sdk/client-s3
Refactored the AdapterAmazonS3 to use the updated S3 SDK API
Minor cleanup to justify the projects ESLint configuration.
Wrote an additional test where it stores a txt file to the storage, and asserts the text contents when read again.

How to test

This change requires the user to define a region when using the S3 Adapter, therefore a new environment variables is added to the .env.example file AWS_REGION

Breaking changes

As mentioned above, the user is now required to use the region paramater when using the S3 adapter.

DennisSnijder commented 1 year ago

@abudaan @marlonbaeten bump

ianatha commented 1 year ago

I'd love to see this!

DennisSnijder commented 1 year ago

@ianatha it's been a while since this PR has been opened, I guess this repository is unmaintainted 😢. I see you're publishing your fork to NPM with this PR, that might be a good solution in the meantime! 🥳

Edit: for anyone else seeing this use: @ianatha/storage-abstraction@2.0.2 😄

marlonbaeten commented 1 year ago

@abudaan could you take a look at this?

tweedegolf / storage-abstraction