feat!: replace userEvent.paste

[ph-fritsche]

BREAKING CHANGE: The userEvent.paste API has new parameters.

What:

Replace userEvent.paste(element, text, init, options) API with:

userEvent.paste('textToBePasted')
userEvent.paste(clipboardData) // DataTransfer object
userEvent.paste() // Read from Clipboard API

Why:

Closes #782

How:

Implement logic as outlined in #782
This includes workarounds for the missing APIs in Jsdom.

userEvent.setup() replaces window.navigator.clipboard as the API is not available outside of secure context.
Uses DataTransfer and ClipboardItem if available, otherwise(Jsdom) it comes with stubs implementing most features.

A second parameter options exist to allow the usage on documents that are not global.document.

userEvent.paste(data, {document: myDocument})
userEvent.setup({document: myDocument}).paste(data) // or per setup

Checklist:

• Documentation
• Tests
• Ready to be merged

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 3e0c5a3:

Sandbox	Source
userEvent-PR-template	Configuration

[codecov]

Codecov Report

Merging #785 (3e0c5a3) into alpha (051fe20) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             alpha      #785    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files           64        68     +4     
  Lines         1387      1539   +152     
  Branches       542       580    +38     
==========================================
+ Hits          1387      1539   +152     

Impacted Files	Coverage Δ
src/paste.ts	100.00% <100.00%> (ø)
src/setup.ts	100.00% <100.00%> (ø)
src/utils/dataTransfer/Blob.ts	100.00% <100.00%> (ø)
src/utils/dataTransfer/Clipboard.ts	100.00% <100.00%> (ø)
src/utils/dataTransfer/DataTransfer.ts	100.00% <100.00%> (ø)
src/utils/dataTransfer/FileList.ts	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 051fe20...3e0c5a3. Read the comment docs.