fix(types): allow bound function to accept string and regex matcher

[timdeschryver]

What:

• Currently it isn't possible to use bound byRole queries (for example with screen) in combination with a string or regexp matcher, screen.getByRole('foo') or screen.getByRole(/head/). The types only allow an ARIARole, e.g. screen.getByRole('button')
• Closes Signature for BoundFunction<getByRole> does not accept RegExp in 7.20.0 #680

Why:

• feat: add allowed roles to role query types #670 introduced an unexpected breaking change
• We want our users to use strings and regexp matchers

How:

• Removed the method overload on the getByRole queries
• Creating a ByRoleMatcher that uses the String type instead of the string type we can have intellisense while not introducing a breaking change (we are still able to use a string that isn't included in the AriaRole union).
• In 3938e92 I tried to explicit type the bound functions, but this also introduced a breaking change to several parts of the API.

Checklist:

• Documentation added to the
  docs site
• Tests
• Typescript definitions updated
• Ready to be merged
  

I think for now, using String is the best solution. We can provide intellisense while not introducing a breaking change. We could revisit the types when we release a new major version.

[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 5d628fa:

Sandbox	Source
kentcdodds/react-testing-library-examples	Configuration

[codecov]

Codecov Report

Merging #683 into master will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #683   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           24        24           
  Lines          614       614           
  Branches       156       156           
=========================================
  Hits           614       614           

---

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 fd0d670...5d628fa. Read the comment docs.

[eps1lon]

This use case is tracked in microsoft/TypeScript#29729.

I'd prefer we go with the approach that is documented in that issue: 'literal' | (string & {}) (microsoft/TypeScript#29729 (comment)). Then we at least follow community best practices. And we should probably link the issue in the comment in case it gets resolved.

[timdeschryver]

🤯 I was looking for a workaround but I couldn't find any.
Thanks for also giving this a look @eps1lon , this is simply great!

[benmonro]

@timdeschryver looks 7.20.0 also broke @testing-library/testcafe as well with the following failure:

FAIL ./selectors.test.ts
[test:unit:monorepo]   ● Test suite failed to run
[test:unit:monorepo] 
[test:unit:monorepo]     ../../src/index.ts:71:14 - error TS2349: This expression is not callable.
[test:unit:monorepo]       Each member of the union type '{ (container: HTMLElement, role: Matcher, options?: ByRoleOptions | undefined): HTMLElement[]; (container: HTMLElement, role: ARIARole, options?: ByRoleOptions | undefined): HTMLElement[]; } | ... 13 more ... | FindAllByBoundAttribute' has signatures, but none of those signatures are compatible with each other.
[test:unit:monorepo] 
[test:unit:monorepo]     71       return window.TestingLibraryDom[query](
[test:unit:monorepo]                     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[test:unit:monorepo] 
[test:unit:monorepo] Test Suites: 1 failed, 1 total

Here's the link w/ all the details: https://github.com/testing-library/testcafe-testing-library/pull/204/checks?check_run_id=830176994

seems related, but maybe i'm wrong...

[timdeschryver]

@benmonro this fix should also resolve that issue.

[timdeschryver]

I have rebased this branch, should be good to go for another review.

[kentcdodds]

This looks fine to me, but I'm not super experienced with TypeScript and would prefer someone else give this the 👍

[kentcdodds]

Anyone with rights can feel free to merge.

[kentcdodds]

🎉 This PR is included in version 7.21.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀