Merge branch 'master' into patch-1

Author: nickserv

.all-contributorsrc

@@ -944,6 +944,79 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "Lukas-Kullmann",
+      "name": "Lukas",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/387547?v=4",
+      "profile": "https://github.com/Lukas-Kullmann",
+      "contributions": [
+        "code",
+        "test"
+      ]
+    },
+    {
+      "login": "pelotom",
+      "name": "Tom Crockett",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/128019?v=4",
+      "profile": "https://twitter.com/pelotom",
+      "contributions": [
+        "code",
+        "test"
+      ]
+    },
+    {
+      "login": "appleJax",
+      "name": "Kevin Brewer",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/13618860?v=4",
+      "profile": "https://github.com/appleJax",
+      "contributions": [
+        "code",
+        "test"
+      ]
+    },
+    {
+      "login": "benmonro",
+      "name": "Ben Monro",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/399236?v=4",
+      "profile": "https://github.com/benmonro",
+      "contributions": [
+        "code",
+        "ideas",
+        "test",
+        "doc"
+      ]
+    },
+    {
+      "login": "smeijer",
+      "name": "Stephan Meijer",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/1196524?v=4",
+      "profile": "https://github.com/smeijer",
+      "contributions": [
+        "ideas",
+        "code",
+        "test"
+      ]
+    },
+    {
+      "login": "Jnforja",
+      "name": "João Forja",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/7002157?v=4",
+      "profile": "https://joaoforja.com/",
+      "contributions": [
+        "code",
+        "test"
+      ]
+    },
+    {
+      "login": "nickmccurdy",
+      "name": "Nick McCurdy",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/927220?v=4",
+      "profile": "https://nickmccurdy.com/",
+      "contributions": [
+        "doc",
+        "code"
+      ]
     }
   ],
   "repoHost": "https://github.com"

.github/PULL_REQUEST_TEMPLATE.md

@@ -36,9 +36,8 @@ merge of your pull request!
 
 - [ ] Documentation added to the
       [docs site](https://github.com/testing-library/testing-library-docs)
-- [ ] I've prepared a PR for types targeting
-      [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__dom)
 - [ ] Tests
+- [ ] Typescript definitions updated
 - [ ] Ready to be merged
       <!-- In your opinion, is this ready to be merged as soon as it's reviewed? -->
 

README.md

@@ -254,6 +254,15 @@ Thanks goes to these people ([emoji key][emojis]):
     <td align="center"><a href="https://github.com/mzdunek93"><img src="https://avatars0.githubusercontent.com/u/10826511?v=4" width="100px;" alt=""/><br /><sub><b>Michał Zdunek</b></sub></a><br /><a href="https://github.com/testing-library/dom-testing-library/commits?author=mzdunek93" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/Lagily"><img src="https://avatars2.githubusercontent.com/u/42535205?v=4" width="100px;" alt=""/><br /><sub><b>Ali Nasserzadeh</b></sub></a><br /><a href="https://github.com/testing-library/dom-testing-library/commits?author=Lagily" title="Code">💻</a></td>
     <td align="center"><a href="https://darekkay.com"><img src="https://avatars0.githubusercontent.com/u/3101914?v=4" width="100px;" alt=""/><br /><sub><b>Darek Kay</b></sub></a><br /><a href="https://github.com/testing-library/dom-testing-library/commits?author=darekkay" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/Lukas-Kullmann"><img src="https://avatars0.githubusercontent.com/u/387547?v=4" width="100px;" alt=""/><br /><sub><b>Lukas</b></sub></a><br /><a href="https://github.com/testing-library/dom-testing-library/commits?author=Lukas-Kullmann" title="Code">💻</a> <a href="https://github.com/testing-library/dom-testing-library/commits?author=Lukas-Kullmann" title="Tests">⚠️</a></td>
+    <td align="center"><a href="https://twitter.com/pelotom"><img src="https://avatars2.githubusercontent.com/u/128019?v=4" width="100px;" alt=""/><br /><sub><b>Tom Crockett</b></sub></a><br /><a href="https://github.com/testing-library/dom-testing-library/commits?author=pelotom" title="Code">💻</a> <a href="https://github.com/testing-library/dom-testing-library/commits?author=pelotom" title="Tests">⚠️</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/appleJax"><img src="https://avatars1.githubusercontent.com/u/13618860?v=4" width="100px;" alt=""/><br /><sub><b>Kevin Brewer</b></sub></a><br /><a href="https://github.com/testing-library/dom-testing-library/commits?author=appleJax" title="Code">💻</a> <a href="https://github.com/testing-library/dom-testing-library/commits?author=appleJax" title="Tests">⚠️</a></td>
+    <td align="center"><a href="https://github.com/benmonro"><img src="https://avatars3.githubusercontent.com/u/399236?v=4" width="100px;" alt=""/><br /><sub><b>Ben Monro</b></sub></a><br /><a href="https://github.com/testing-library/dom-testing-library/commits?author=benmonro" title="Code">💻</a> <a href="#ideas-benmonro" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/testing-library/dom-testing-library/commits?author=benmonro" title="Tests">⚠️</a> <a href="https://github.com/testing-library/dom-testing-library/commits?author=benmonro" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/smeijer"><img src="https://avatars1.githubusercontent.com/u/1196524?v=4" width="100px;" alt=""/><br /><sub><b>Stephan Meijer</b></sub></a><br /><a href="#ideas-smeijer" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/testing-library/dom-testing-library/commits?author=smeijer" title="Code">💻</a> <a href="https://github.com/testing-library/dom-testing-library/commits?author=smeijer" title="Tests">⚠️</a></td>
+    <td align="center"><a href="https://joaoforja.com/"><img src="https://avatars2.githubusercontent.com/u/7002157?v=4" width="100px;" alt=""/><br /><sub><b>João Forja</b></sub></a><br /><a href="https://github.com/testing-library/dom-testing-library/commits?author=Jnforja" title="Code">💻</a> <a href="https://github.com/testing-library/dom-testing-library/commits?author=Jnforja" title="Tests">⚠️</a></td>
+    <td align="center"><a href="https://nickmccurdy.com/"><img src="https://avatars0.githubusercontent.com/u/927220?v=4" width="100px;" alt=""/><br /><sub><b>Nick McCurdy</b></sub></a><br /><a href="https://github.com/testing-library/dom-testing-library/commits?author=nickmccurdy" title="Documentation">📖</a> <a href="https://github.com/testing-library/dom-testing-library/commits?author=nickmccurdy" title="Code">💻</a></td>
   </tr>
 </table>
 

package.json

@@ -38,19 +38,20 @@
     "types"
   ],
   "dependencies": {
-    "@babel/runtime": "^7.9.6",
+    "@babel/runtime": "^7.10.2",
     "aria-query": "^4.0.2",
-    "dom-accessibility-api": "^0.4.4",
+    "dom-accessibility-api": "^0.4.5",
     "pretty-format": "^25.5.0"
   },
   "devDependencies": {
-    "dtslint": "^3.4.2",
-    "@testing-library/jest-dom": "^5.5.0",
+    "@testing-library/jest-dom": "^5.9.0",
+    "dtslint": "^3.6.9",
     "jest-in-case": "^1.0.2",
     "jest-serializer-ansi": "^1.0.3",
     "jest-watch-select-projects": "^2.0.0",
     "jsdom": "^16.2.2",
-    "kcd-scripts": "^6.0.0"
+    "kcd-scripts": "^6.2.0",
+    "typescript": "^3.9.5"
   },
   "eslintConfig": {
     "extends": "./node_modules/kcd-scripts/eslint.js",

src/__tests__/base-queries-warn-on-invalid-container.js

@@ -0,0 +1,127 @@
+import {
+  getByLabelText,
+  getAllByLabelText,
+  queryAllByLabelText,
+  queryByLabelText,
+  findByLabelText,
+  findAllByLabelText,
+  getByPlaceholderText,
+  getAllByPlaceholderText,
+  queryAllByPlaceholderText,
+  queryByPlaceholderText,
+  findByPlaceholderText,
+  findAllByPlaceholderText,
+  getByText,
+  getAllByText,
+  queryAllByText,
+  queryByText,
+  findByText,
+  findAllByText,
+  getByAltText,
+  getAllByAltText,
+  queryAllByAltText,
+  queryByAltText,
+  findByAltText,
+  findAllByAltText,
+  getByTitle,
+  getAllByTitle,
+  queryAllByTitle,
+  queryByTitle,
+  findByTitle,
+  findAllByTitle,
+  getByDisplayValue,
+  getAllByDisplayValue,
+  queryAllByDisplayValue,
+  queryByDisplayValue,
+  findByDisplayValue,
+  findAllByDisplayValue,
+  getByRole,
+  getAllByRole,
+  queryAllByRole,
+  queryByRole,
+  findByRole,
+  findAllByRole,
+  getByTestId,
+  getAllByTestId,
+  queryAllByTestId,
+  queryByTestId,
+  findByTestId,
+  findAllByTestId,
+} from '..'
+
+describe('synchronous queries throw on invalid container type', () => {
+  test.each([
+    ['getByLabelText', getByLabelText],
+    ['getAllByLabelText', getAllByLabelText],
+    ['queryByLabelText', queryByLabelText],
+    ['queryAllByLabelText', queryAllByLabelText],
+    ['getByPlaceholderText', getByPlaceholderText],
+    ['getAllByPlaceholderText', getAllByPlaceholderText],
+    ['queryByPlaceholderText', queryByPlaceholderText],
+    ['queryAllByPlaceholderText', queryAllByPlaceholderText],
+    ['getByText', getByText],
+    ['getAllByText', getAllByText],
+    ['queryByText', queryByText],
+    ['queryAllByText', queryAllByText],
+    ['getByAltText', getByAltText],
+    ['getAllByAltText', getAllByAltText],
+    ['queryByAltText', queryByAltText],
+    ['queryAllByAltText', queryAllByAltText],
+    ['getByTitle', getByTitle],
+    ['getAllByTitle', getAllByTitle],
+    ['queryByTitle', queryByTitle],
+    ['queryAllByTitle', queryAllByTitle],
+    ['getByDisplayValue', getByDisplayValue],
+    ['getAllByDisplayValue', getAllByDisplayValue],
+    ['queryByDisplayValue', queryByDisplayValue],
+    ['queryAllByDisplayValue', queryAllByDisplayValue],
+    ['getByRole', getByRole],
+    ['getAllByRole', getAllByRole],
+    ['queryByRole', queryByRole],
+    ['queryAllByRole', queryAllByRole],
+    ['getByTestId', getByTestId],
+    ['getAllByTestId', getAllByTestId],
+    ['queryByTestId', queryByTestId],
+    ['queryAllByTestId', queryAllByTestId],
+  ])('%s', (_queryName, query) => {
+    expect(() =>
+      query('invalid type for container', 'irrelevant text'),
+    ).toThrowErrorMatchingInlineSnapshot(
+      `"Expected container to be an Element, a Document or a DocumentFragment but got string."`,
+    )
+  })
+})
+
+describe('asynchronous queries throw on invalid container type', () => {
+  test.each([
+    ['findByLabelText', findByLabelText],
+    ['findAllByLabelText', findAllByLabelText],
+    ['findByPlaceholderText', findByPlaceholderText],
+    ['findAllByPlaceholderText', findAllByPlaceholderText],
+    ['findByText', findByText],
+    ['findAllByText', findAllByText],
+    ['findByAltText', findByAltText],
+    ['findAllByAltText', findAllByAltText],
+    ['findByTitle', findByTitle],
+    ['findAllByTitle', findAllByTitle],
+    ['findByDisplayValue', findByDisplayValue],
+    ['findAllByDisplayValue', findAllByDisplayValue],
+    ['findByRole', findByRole],
+    ['findAllByRole', findAllByRole],
+    ['findByTestId', findByTestId],
+    ['findAllByTestId', findAllByTestId],
+  ])('%s', (_queryName, query) => {
+    const queryOptions = {}
+    const waitOptions = {timeout: 1}
+    return expect(
+      query(
+        'invalid type for container',
+        'irrelevant text',
+        queryOptions,
+        waitOptions,
+      ),
+    ).rejects.toThrowErrorMatchingInlineSnapshot(
+      `"Expected container to be an Element, a Document or a DocumentFragment but got string."`,
+    )
+  })
+})

src/__tests__/event-wrapper.js

@@ -0,0 +1,31 @@
+import {configure, fireEvent} from '..'
+
+let originalConfig
+
+beforeEach(() => {
+  configure(oldConfig => {
+    originalConfig = oldConfig
+    return null
+  })
+})
+
+afterEach(() => {
+  jest.clearAllMocks()
+  configure(originalConfig)
+})
+
+test('fireEvent calls the eventWrapper', () => {
+  const mockEventWrapper = jest.fn()
+  configure(() => {
+    return {eventWrapper: mockEventWrapper}
+  })
+  const el = document.createElement('div')
+  fireEvent.click(el)
+  expect(mockEventWrapper).toHaveBeenCalledWith(expect.any(Function))
+  expect(mockEventWrapper).toHaveBeenCalledTimes(1)
+})
+
+test('fireEvent has a default eventWrapper', () => {
+  const el = document.createElement('div')
+  expect(() => fireEvent.click(el)).not.toThrow()
+})

src/__tests__/helpers.js

@@ -1,5 +1,30 @@
-import {getDocument} from '../helpers'
+import {getDocument, checkContainerType} from '../helpers'
 
 test('returns global document if exists', () => {
   expect(getDocument()).toBe(document)
 })
+
+describe('query container validation throws when validation fails', () => {
+  test('undefined as container', () => {
+    expect(() =>
+      checkContainerType(undefined),
+    ).toThrowErrorMatchingInlineSnapshot(
+      `"Expected container to be an Element, a Document or a DocumentFragment but got undefined."`,
+    )
+  })
+  test('null as container', () => {
+    expect(() => checkContainerType(null)).toThrowErrorMatchingInlineSnapshot(
+      `"Expected container to be an Element, a Document or a DocumentFragment but got null."`,
+    )
+  })
+  test('array as container', () => {
+    expect(() => checkContainerType([])).toThrowErrorMatchingInlineSnapshot(
+      `"Expected container to be an Element, a Document or a DocumentFragment but got Array."`,
+    )
+  })
+  test('object as container', () => {
+    expect(() => checkContainerType({})).toThrowErrorMatchingInlineSnapshot(
+      `"Expected container to be an Element, a Document or a DocumentFragment but got Object."`,
+    )
+  })
+})

src/__tests__/role.js

@@ -343,6 +343,12 @@ Here are the accessible roles:
 `)
 })
 
+test('has no useful error message in findBy', async () => {
+  const {findByRole} = render(`<li />`)
+
+  await expect(findByRole('option', {timeout: 1})).rejects.toThrow('Unable to find role="option"')
+})
+
 test('explicit role is most specific', () => {
   const {getByRole} = renderIntoDocument(
     `<button role="tab" aria-label="my-tab" />`,