fix: better document API

Author: patrickhulce

lib/extend.ts

@@ -1,8 +1,8 @@
-import {getTestingUtilsForDocument, extendObjectWithTestingUtils} from '.'
+import {extendObjectWithTestingUtils, getDocument} from '.'
 
-const Page = require('puppeteer/lib/Page.js')
-const ElementHandle = require('puppeteer/lib/ElementHandle.js')
+const Page = require('puppeteer/lib/Page.js') // tslint:disable-line
+const ElementHandle = require('puppeteer/lib/ElementHandle.js') // tslint:disable-line
 
-Page.prototype.getTestingUtilsForDocument = getTestingUtilsForDocument
+Page.prototype.document = getDocument
 
 extendObjectWithTestingUtils(ElementHandle.prototype)

lib/index.ts

@@ -1,6 +1,5 @@
-import './typedefs'
-import * as path from 'path'
 import {readFileSync} from 'fs'
+import * as path from 'path'
 import {ElementHandle, EvaluateFn, Page} from 'puppeteer'
 import {ITestUtils} from './typedefs'
 
@@ -38,22 +37,26 @@ function createDelegateFor(
     // @ts-ignore
     const evaluateFn: EvaluateFn = {toString: () => mockFnToExecuteInPage}
 
-    const mappedArgs = args.map(arg => (arg instanceof RegExp ? {regex: arg.source} : arg))
+    let argsToForward = args.map(arg => (arg instanceof RegExp ? {regex: arg.source} : arg))
+    if (containerHandle === args[0]) {
+      argsToForward = args.slice(1)
+    }
+
     const handle = await containerHandle
       .executionContext()
-      .evaluateHandle(evaluateFn, containerHandle, fnName, ...mappedArgs)
+      .evaluateHandle(evaluateFn, containerHandle, fnName, ...argsToForward)
     const element = handle.asElement()
     if (element) return element
     await handle.dispose()
-    return null
+    return null // tslint:disable-line
   }
 }
 
-export async function getTestingUtilsForDocument(context?: Page): Promise<ElementHandle> {
+export async function getDocument(context?: Page): Promise<ElementHandle> {
   // @ts-ignore
   const page: Page = context || this
   const documentHandle = await page.mainFrame().evaluateHandle('document')
-  const document = await documentHandle.asElement()
+  const document = documentHandle.asElement()
   if (!document) throw new Error('Could not find document')
   return document
 }

lib/typedefs.ts

@@ -1,5 +1,5 @@
+import {Matcher, MatcherOptions, SelectorMatcherOptions} from 'dom-testing-library/typings' // tslint:disable-line no-submodule-imports
 import {ElementHandle} from 'puppeteer'
-import {MatcherOptions, Matcher, SelectorMatcherOptions} from 'dom-testing-library/typings/'
 
 type Element = ElementHandle
 
@@ -30,9 +30,10 @@ export interface ITestUtils {
   getAllByTitle(el: Element, m: Matcher, opts?: MatcherOptions): Promise<Element[]>
 }
 
+/* tslint:disable */
 declare module 'puppeteer' {
   interface Page {
-    getTestingUtilsForDocument(): ElementHandle
+    document(): Promise<ElementHandle>
   }
 
   interface ElementHandle {

package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "test": "npm run test:lint && npm run test:unit",
     "test:unit": "jest",
-    "test:lint": "lint",
+    "test:lint": "lint -t typescript './lib/**/*.ts'",
     "semantic-release": "semantic-release",
     "clean": "rm -fR dist/",
     "rebuild": "npm run clean && npm run build",
@@ -32,15 +32,22 @@
     "utility"
   ],
   "config": {
+    "tslint": {
+      "rules": {
+        "no-unsafe-any": false
+      }
+    },
     "exportAliases": {
       "extend": "./dist/extend"
     }
   },
+  "dependencies": {
+    "dom-testing-library": "^2.6.1"
+  },
   "devDependencies": {
     "@patrickhulce/lint": "^2.1.3",
     "@types/jest": "^23.1.1",
     "@types/puppeteer": "^1.3.4",
-    "dom-testing-library": "2.6.1",
     "generate-export-aliases": "^1.1.0",
     "jest": "^23.1.0",
     "puppeteer": "^1.5.0",

test/extend.test.ts

@@ -14,7 +14,7 @@ describe('lib/extend.ts', () => {
   })
 
   it('should extend puppeteer ElementHandle', async () => {
-    document = await page.getTestingUtilsForDocument()
+    document = await page.document()
     expect(typeof document.queryAllByAltText).toBe('function')
   })
 

test/index.test.ts

@@ -0,0 +1,24 @@
+import * as path from 'path'
+import * as puppeteer from 'puppeteer'
+import {getDocument, utils} from '../lib'
+
+describe('lib/index.ts', () => {
+  let browser: puppeteer.Browser
+  let page: puppeteer.Page
+
+  it('should launch puppeteer', async () => {
+    browser = await puppeteer.launch()
+    page = await browser.newPage()
+    await page.goto(`file://${path.join(__dirname, 'fixtures/page.html')}`)
+  })
+
+  it('should export the utilities', async () => {
+    const document = await getDocument(page)
+    const element = await utils.getByText(document, 'Hello h1')
+    expect(await page.evaluate(el => el.textContent, element)).toEqual('Hello h1')
+  })
+
+  afterAll(async () => {
+    await browser.close()
+  })
+})

yarn.lock

@@ -1840,7 +1840,7 @@ doctrine@^2.0.0:
   dependencies:
     esutils "^2.0.2"
 
-[email protected]:
+dom-testing-library@^2.6.1:
   version "2.6.1"
   resolved "https://registry.yarnpkg.com/dom-testing-library/-/dom-testing-library-2.6.1.tgz#ec97192d3ddbc026809d1377eafc22eabdc372d3"
   dependencies: