Skip to content

Commit

Permalink
Merge branch '4.x' into xhr-new-hooks
Browse files Browse the repository at this point in the history 
* 4.x:
  Release: uppy@4.0.0-beta.5 (#5141)
  meta: run Prettier in the release workflow
  Release: uppy@3.25.1 (#5139)
  Bump ejs from 3.1.9 to 3.1.10 (#5135)
  Update ru_RU locale  (#5120)
  meta: fix `update-contributors` script (#5137)
  meta: fix `bullet` setting for ReMark
  meta: add prettier to `.md` pre-commit hooks
  @uppy/core: make UppyEventMap more readable
  Format
  • Loading branch information
@Murderlon
Murderlon committed May 6, 2024
2 parents a5012c4 + cc103ce commit 3e22424
Show file tree
Hide file tree
Showing 80 changed files with 2,818 additions and 820 deletions.
83 changes: 41 additions & 42 deletions .github/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ corepack enable
```

[Corepack]: https://nodejs.org/api/corepack.html

[Yarn]: https://yarnpkg.com/

## Development
Expand Down Expand Up @@ -79,28 +78,28 @@ throughout this section.
The following steps describe the actions that take place when a user
Authenticates and Uploads from Dropbox through Companion:

* The visitor to a website with Uppy clicks `Connect to Dropbox`.
* Uppy sends a request to Companion, which in turn sends an OAuth request to
- The visitor to a website with Uppy clicks `Connect to Dropbox`.
- Uppy sends a request to Companion, which in turn sends an OAuth request to
Dropbox (Requires that OAuth credentials from Dropbox have been added to
Companion).
* Dropbox asks the visitor to log in, and whether the Website should be allowed
- Dropbox asks the visitor to log in, and whether the Website should be allowed
to access your files
* If the visitor agrees, Companion will receive a token from Dropbox, with which
- If the visitor agrees, Companion will receive a token from Dropbox, with which
we can temporarily download files.
* Companion encrypts the token with a secret key and sends the encrypted token
- Companion encrypts the token with a secret key and sends the encrypted token
to Uppy (client)
* Every time the visitor clicks on a folder in Uppy, it asks Companion for the
- Every time the visitor clicks on a folder in Uppy, it asks Companion for the
new list of files, with this question, the token (still encrypted by
Companion) is sent along.
* Companion decrypts the token, requests the list of files from Dropbox and
- Companion decrypts the token, requests the list of files from Dropbox and
sends it to Uppy.
* When a file is selected for upload, Companion receives the token again
- When a file is selected for upload, Companion receives the token again
according to this procedure, decrypts it again, and thereby downloads the file
from Dropbox.
* As the bytes arrive, Companion uploads the bytes to the final destination
- As the bytes arrive, Companion uploads the bytes to the final destination
(depending on the configuration: Apache, a Tus server, S3 bucket, etc).
* Companion reports progress to Uppy, as if it were a local upload.
* Completed!
- Companion reports progress to Uppy, as if it were a local upload.
- Completed!

### Instagram integration

Expand Down Expand Up @@ -159,11 +158,11 @@ Now you should be able to test the Instagram integration.

### Requiring files

* If we are `require()`ing a file from the same subpackage, we can freely use
- If we are `require()`ing a file from the same subpackage, we can freely use
relative imports as long as the required file is under the `src` directory
(for example to import `@uppy/dashboard/src/utils/hi.js` from
`@uppy/dashboard/src/index.js`, use `require('./utils/hi.js')`).
* But if we want to `require()` some file from another subpackage - we should
- But if we want to `require()` some file from another subpackage - we should
use global @uppy requires, and they should always be in the form of
`@uppy/:packageName/(lib instead of src)/(same path).js`

Expand Down Expand Up @@ -231,25 +230,25 @@ cancelled later), for example using their iOS app.
Releases are managed by GitHub Actions, here’s an overview of the process to
release a new Uppy version:

* Run `yarn release` on your local machine.
* Follow the instructions and select what packages to release. **Warning:**
- Run `yarn release` on your local machine.
- Follow the instructions and select what packages to release. **Warning:**
skipping packages results in those changes being “lost”, meaning they won’t be
picked up in the changelog automatically next release. Always try to release
all.
* Before committing, check if the generated files look good.
* When asked to edit the next CHANGELOG, only include changes related to the
- Before committing, check if the generated files look good.
- When asked to edit the next CHANGELOG, only include changes related to the
package(s) you selected for release.
* Push to the Transloadit repository using the command given by the tool. Do not
- Push to the Transloadit repository using the command given by the tool. Do not
open a PR yourself, the GitHub Actions will create one and assign you to it.
* Wait for all the GitHub Actions checks to pass. If one fails, try to figure
- Wait for all the GitHub Actions checks to pass. If one fails, try to figure
out why. Do not go ahead without consulting the rest of the team.
* Review the PR thoroughly, and if everything looks good to you, approve the PR.
- Review the PR thoroughly, and if everything looks good to you, approve the PR.
Do not merge it manually!
* After the PR is automatically merged, the demos on transloadit.com should also
- After the PR is automatically merged, the demos on transloadit.com should also
be updated. Check that some things work locally:
* the demos in the demo section work (try one that uses an import robot, and
- the demos in the demo section work (try one that uses an import robot, and
one that you need to upload to)
* the demos on the homepage work and can import from Google Drive, Instagram,
- the demos on the homepage work and can import from Google Drive, Instagram,
Dropbox, etc.

If you don’t have access to the transloadit.com source code ping @arturi or
Expand Down Expand Up @@ -395,9 +394,9 @@ queries to add any styles to the tablet or desktop breakpoints.

### Selector, rule ordering

* All selectors are sorted alphabetically and by type.
* HTML elements go above classes and IDs in a file.
* Rules are sorted alphabetically.
- All selectors are sorted alphabetically and by type.
- HTML elements go above classes and IDs in a file.
- Rules are sorted alphabetically.

```scss
/* BAD */
Expand Down Expand Up @@ -438,11 +437,11 @@ said integration with the Uppy team. After discussing the integration, you can
get started on it. First off, you need to construct the basic components for
your integration. The following components are the current standard:

* `Dashboard`: Inline Dashboard (`inline: true`)
* `DashboardModal`: Dashboard as a modal
* `DragDrop`
* `ProgressBar`
* `StatusBar`
- `Dashboard`: Inline Dashboard (`inline: true`)
- `DashboardModal`: Dashboard as a modal
- `DragDrop`
- `ProgressBar`
- `StatusBar`

All these components should function as references to the normal component.
Depending on how the framework you’re using handles references to the DOM, your
Expand All @@ -457,10 +456,10 @@ through the code of those integrations, as they lay out a pretty good structure.
After the basic components have been built, here are a few more important tasks
to get done:

* Add TypeScript support in some capacity (if possible)
* Write documentation
* Add an example
* Configuring the build system
- Add TypeScript support in some capacity (if possible)
- Write documentation
- Add an example
- Configuring the build system

### Common issues

Expand Down Expand Up @@ -509,12 +508,12 @@ Generally, documentation for integrations can be broken down into a few pieces
that apply to every component, and then documentation for each component. The
structure should look something like this:

* Installation
* Initializing Uppy (may vary depending on how the framework handles reactivity)
* Usage
* _For each component_
* Loading CSS
* Props
- Installation
- Initializing Uppy (may vary depending on how the framework handles reactivity)
- Usage
- _For each component_
- Loading CSS
- Props

It may be easier to copy the documentation of earlier integrations and change
the parts that need to be changed rather than writing this from scratch.
Expand Down
2 changes: 1 addition & 1 deletion BUNDLE-README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Hi, thanks for trying out the bundled version of the Uppy File Uploader. You can
use this from a CDN
(`<script src="https://releases.transloadit.com/uppy/v4.0.0-beta.4/uppy.min.js"></script>`)
(`<script src="https://releases.transloadit.com/uppy/v4.0.0-beta.5/uppy.min.js"></script>`)
or bundle it with your webapp.

Note that the recommended way to use Uppy is to install it with yarn/npm and use
Expand Down
58 changes: 58 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,45 @@ Please add your entries in this format:

In the current stage we aim to release a new version at least every month.

## 4.0.0-beta.5

Released: 2024-05-03

| Package | Version | Package | Version |
| ------------------------- | ------------ | ------------------------- | ------------ |
| @uppy/audio | 2.0.0-beta.5 | @uppy/progress-bar | 4.0.0-beta.4 |
| @uppy/aws-s3 | 4.0.0-beta.3 | @uppy/provider-views | 4.0.0-beta.5 |
| @uppy/aws-s3-multipart | 4.0.0-beta.5 | @uppy/react | 4.0.0-beta.5 |
| @uppy/box | 3.0.0-beta.5 | @uppy/redux-dev-tools | 4.0.0-beta.2 |
| @uppy/companion | 5.0.0-beta.5 | @uppy/remote-sources | 2.0.0-beta.4 |
| @uppy/companion-client | 4.0.0-beta.5 | @uppy/screen-capture | 4.0.0-beta.4 |
| @uppy/compressor | 2.0.0-beta.5 | @uppy/status-bar | 4.0.0-beta.5 |
| @uppy/core | 4.0.0-beta.5 | @uppy/store-default | 4.0.0-beta.2 |
| @uppy/dashboard | 4.0.0-beta.5 | @uppy/store-redux | 4.0.0-beta.3 |
| @uppy/drag-drop | 4.0.0-beta.4 | @uppy/svelte | 4.0.0-beta.3 |
| @uppy/dropbox | 4.0.0-beta.5 | @uppy/thumbnail-generator | 4.0.0-beta.4 |
| @uppy/facebook | 4.0.0-beta.5 | @uppy/transloadit | 4.0.0-beta.5 |
| @uppy/file-input | 4.0.0-beta.5 | @uppy/tus | 4.0.0-beta.4 |
| @uppy/form | 4.0.0-beta.3 | @uppy/unsplash | 4.0.0-beta.5 |
| @uppy/golden-retriever | 4.0.0-beta.4 | @uppy/url | 4.0.0-beta.5 |
| @uppy/google-drive | 4.0.0-beta.5 | @uppy/utils | 6.0.0-beta.5 |
| @uppy/image-editor | 3.0.0-beta.3 | @uppy/vue | 2.0.0-beta.2 |
| @uppy/informer | 4.0.0-beta.2 | @uppy/webcam | 4.0.0-beta.5 |
| @uppy/instagram | 4.0.0-beta.5 | @uppy/xhr-upload | 4.0.0-beta.3 |
| @uppy/locales | 4.0.0-beta.1 | @uppy/zoom | 3.0.0-beta.5 |
| @uppy/onedrive | 4.0.0-beta.5 | uppy | 4.0.0-beta.5 |

- @uppy/core: make UppyEventMap more readable (Murderlon)
- @uppy/audio,@uppy/compressor,@uppy/core,@uppy/dashboard,@uppy/remote-sources,@uppy/tus,@uppy/utils: Format (Murderlon)
- @uppy/aws-s3-multipart: Format (Murderlon)
- meta: enable prettier for markdown (Merlijn Vos / #5133)
- @uppy/xhr-upload: do not throw when res is missing url (Merlijn Vos / #5132)
- @uppy/companion: coerce `requestUrl` to a string (Antoine du Hamel / #5128)
- meta: enforce use of `.js` extension in `import type` declarations (Antoine du Hamel / #5126)
- @uppy/core: add instance ID to generated IDs (Merlijn Vos / #5080)
- @uppy/core: reference updated i18n in Restricter (Merlijn Vos / #5118)


## 4.0.0-beta.4

Released: 2024-04-29
Expand Down Expand Up @@ -236,6 +275,25 @@ Released: 2024-03-28
- meta: prepare release workflow for beta versions (Antoine du Hamel)


## 3.25.1

Released: 2024-05-03

| Package | Version | Package | Version |
| ---------------- | ------- | ---------------- | ------- |
| @uppy/companion | 4.13.2 | @uppy/xhr-upload | 3.6.6 |
| @uppy/core | 3.11.1 | uppy | 3.25.1 |
| @uppy/locales | 3.5.3 | | |

- @uppy/locales: Update ru_RU locale (Uladzislau Bodryi / #5120)
- meta: fix `update-contributors` script (Antoine du Hamel / #5137)
- meta: fix `bullet` setting for ReMark (Antoine du Hamel)
- meta: add prettier to `.md` pre-commit hooks (Antoine du Hamel)
- @uppy/core: make UppyEventMap more readable (Murderlon)
- meta: enable prettier for markdown (Merlijn Vos / #5133)
- @uppy/xhr-upload: do not throw when res is missing url (Merlijn Vos / #5132)
- @uppy/companion: coerce `requestUrl` to a string (Antoine du Hamel / #5128)


## 3.25.0

Expand Down
Loading

0 comments on commit 3e22424

Please sign in to comment.