Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@uppy/aws-s3: remove legacy plugin #5070

Merged
merged 3 commits into from
Apr 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions e2e/clients/dashboard-aws-multipart/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ const uppy = new Uppy()
.use(AwsS3Multipart, {
limit: 2,
companionUrl: process.env.VITE_COMPANION_URL,
shouldUseMultipart: true,
// This way we can test that the user provided API still works
// as expected in the flow. We call the default internal function for this,
// otherwise we would have to run another server to pre-sign requests
Expand Down
1 change: 1 addition & 0 deletions e2e/clients/dashboard-aws/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ const uppy = new Uppy()
.use(AwsS3, {
limit: 2,
companionUrl: process.env.VITE_COMPANION_URL,
shouldUseMultipart: false,
})

// Keep this here to access uppy in tests
Expand Down
236 changes: 0 additions & 236 deletions packages/@uppy/aws-s3-multipart/CHANGELOG.md

This file was deleted.

40 changes: 1 addition & 39 deletions packages/@uppy/aws-s3-multipart/README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,3 @@
# @uppy/aws-s3-multipart

<img src="https://uppy.io/img/logo.svg" width="120" alt="Uppy logo: a smiling puppy above a pink upwards arrow" align="right">

[![npm version](https://img.shields.io/npm/v/@uppy/aws-s3-multipart.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/aws-s3-multipart)
![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/Tests/badge.svg)
![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg)
![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg)

The AwsS3Multipart plugin can be used to upload files directly to an S3 bucket using S3’s Multipart upload strategy. With this strategy, files are chopped up in parts of 5MB+ each, so they can be uploaded concurrently. It’s also reliable: if a single part fails to upload, only that 5MB has to be retried.

Uppy is being developed by the folks at [Transloadit](https://transloadit.com), a versatile file encoding service.

## Example

```js
import Uppy from '@uppy/core'
import AwsS3Multipart from '@uppy/aws-s3-multipart'

const uppy = new Uppy()
uppy.use(AwsS3Multipart, {
limit: 2,
companionUrl: 'https://companion.myapp.com/',
})
```

## Installation

```bash
$ npm install @uppy/aws-s3-multipart
```

Alternatively, you can also use this plugin in a pre-built bundle from Transloadit’s CDN: Edgly. In that case `Uppy` will attach itself to the global `window.Uppy` object. See the [main Uppy documentation](https://uppy.io/docs/#Installation) for instructions.

## Documentation

Documentation for this plugin can be found on the [Uppy website](https://uppy.io/docs/aws-s3-multipart).

## License

[The MIT License](./LICENSE).
This package is deprecated. Use [`@uppy/aws-s3`](https://npmjs.org/package/@uppy/aws-s3) instead.
13 changes: 1 addition & 12 deletions packages/@uppy/aws-s3-multipart/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,7 @@
"url": "git+https://github.com/transloadit/uppy.git"
},
"dependencies": {
"@uppy/companion-client": "workspace:^",
"@uppy/utils": "workspace:^"
},
"devDependencies": {
"@aws-sdk/client-s3": "^3.362.0",
"@aws-sdk/s3-request-presigner": "^3.362.0",
"nock": "^13.1.0",
"vitest": "^1.2.1",
"whatwg-fetch": "3.6.2"
},
"peerDependencies": {
"@uppy/core": "workspace:^"
"@uppy/aws-s3": "workspace:^"
},
"stableVersion": "3.11.0"
}
Loading
Loading