feat: expose within/getQueriesForElement

BREAKING CHANGE: rename extendObjectWithTestingUtils to getQueriesForElement

Author: patrickhulce

lib/extend.ts

@@ -1,12 +1,18 @@
 import {Matcher, MatcherOptions, SelectorMatcherOptions} from 'dom-testing-library/typings' // tslint:disable-line no-submodule-imports
-import {extendObjectWithTestingUtils, getDocument} from '.'
+import {getQueriesForElement, getDocument} from '.'
 
-const Page = require('puppeteer/lib/Page.js') // tslint:disable-line
-const ElementHandle = require('puppeteer/lib/ElementHandle.js') // tslint:disable-line
+let Page, ElementHandle
 
-Page.prototype.getDocument = getDocument
+try {
+  Page = require('puppeteer/lib/Page.js') // tslint:disable-line
+  ElementHandle = require('puppeteer/lib/ElementHandle.js') // tslint:disable-line
 
-extendObjectWithTestingUtils(ElementHandle.prototype)
+  Page.prototype.getDocument = getDocument
+  getQueriesForElement(ElementHandle.prototype)
+} catch (err) {
+  console.error('Could not augment puppeteer functions, do you have a conflicting version?')
+  throw err
+}
 
 /* tslint:disable */
 declare module 'puppeteer' {

lib/index.ts

@@ -84,7 +84,7 @@ export async function getDocument(_page?: Page): Promise<ElementHandle> {
   return document
 }
 
-export function extendObjectWithTestingUtils<T>(object: T, contextFn?: ContextFn): T & ITestUtils {
+export function getQueriesForElement<T>(object: T, contextFn?: ContextFn): T & ITestUtils {
   const o = object as any
   o.queryByPlaceholderText = createDelegateFor('queryByPlaceholderText', contextFn)
   o.queryAllByPlaceholderText = createDelegateFor('queryAllByPlaceholderText', contextFn)
@@ -113,6 +113,8 @@ export function extendObjectWithTestingUtils<T>(object: T, contextFn?: ContextFn
   return o
 }
 
+export const within = getQueriesForElement
+
 // @ts-ignore
 export const queries: ITestUtils = {}
-extendObjectWithTestingUtils(queries, el => el)
+getQueriesForElement(queries, el => el)