fix(within): types should list custom and base queries (#1045)

testing-library · Oct 4, 2021 · b28586e · b28586e
1 parent 8c5c05d
commit b28586e
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/types/__tests__/type-tests.ts b/types/__tests__/type-tests.ts
@@ -117,6 +117,21 @@ export async function testQueryHelpers() {
   await findByAutomationId(element, ['id', 'id'], {})
   await findAllByAutomationId(element, ['id', 'id'])
   await findByAutomationId(element, ['id', 'id'])
+
+  const screenWithCustomQueries = within(document.body, {
+    ...queries,
+    queryByAutomationId,
+    getAllByAutomationId,
+    getByAutomationId,
+    findAllByAutomationId,
+    findByAutomationId,
+  })
+
+  screenWithCustomQueries.queryByAutomationId('id')
+  screenWithCustomQueries.getAllByAutomationId('id')
+  screenWithCustomQueries.getByAutomationId(['id', 'automationId'])
+  await screenWithCustomQueries.findAllByAutomationId('id', {}, {timeout: 1000})
+  await screenWithCustomQueries.findByAutomationId('id', {}, {timeout: 1000})
 }
 
 export function testBoundFunctions() {

diff --git a/types/get-queries-for-element.d.ts b/types/get-queries-for-element.d.ts
@@ -153,6 +153,8 @@ export type BoundFunctions<Q> = Q extends typeof queries
       findAllByTestId<T extends HTMLElement = HTMLElement>(
         ...args: Parameters<BoundFunction<queries.FindAllByBoundAttribute<T>>>
       ): ReturnType<queries.FindAllByBoundAttribute<T>>
+    } & {
+      [P in keyof Q]: BoundFunction<Q[P]>
     }
   : {
       [P in keyof Q]: BoundFunction<Q[P]>