Merge pull request #151 from criticalbh/feature/clear

feat: clear API

Author: adieuadieu

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 - `placeholder()` API method [#000](https://github.com/graphcool/chromeless/pull/000) @contributor
+- `clearInput()` API method
 
 ### Changed
 

README.md

@@ -169,6 +169,7 @@ const chromeless = new Chromeless({
 - [`cookiesSet(cookies: Cookie[])`](docs/api.md#api-cookiesset-many)
 - [`cookiesClear(name: string)`](docs/api.md#api-cookiesclear)
 - [`cookiesClearAll()`](docs/api.md#api-cookiesclearall)
+- [`clearInput(selector: string)`](docs/api.md#api-clearInput)
 
 ## Configuring Development Environment
 

docs/api.md

@@ -609,3 +609,17 @@ __Example__
 ```js
 await chromeless.cookiesClearAll()
 ```
+---------------------------------------
+
+<a name="api-clearInput" />
+
+### clearInput(selector: string): Chromeless<T>
+
+Clear input text.
+
+
+__Example__
+
+```js
+await chromeless.clearInput('#username')
+```

src/api.ts

@@ -276,6 +276,11 @@ export default class Chromeless<T extends any> implements Promise<T> {
     return this
   }
 
+    clearInput(selector: string): Chromeless<T> {
+    this.queue.enqueue({type: 'clearInput', selector})
+    return this
+  }
+
   async end(): Promise<T> {
     const result = await this.lastReturnPromise
     await this.queue.end()

src/chrome/local-runtime.ts

@@ -32,6 +32,7 @@ import {
   mousedown,
   mouseup,
   focus,
+  clearInput,
 } from '../util'
 
 export default class LocalRuntime {
@@ -97,6 +98,8 @@ export default class LocalRuntime {
         return this.mousup(command.selector)
       case 'focus':
         return this.focus(command.selector)
+      case 'clearInput':
+        return this.clearInput(command.selector)
       default:
         throw new Error(`No such command: ${JSON.stringify(command)}`)
     }
@@ -362,6 +365,22 @@ export default class LocalRuntime {
     }
   }
 
+  async clearInput(selector: string): Promise<void> {
+    if (selector) {
+      if (this.chromelessOptions.implicitWait) {
+        this.log(`clearInput(): Waiting for ${selector}`)
+        await waitForNode(this.client, selector, this.chromelessOptions.waitTimeout)
+      }
+
+      const exists = await nodeExists(this.client, selector)
+      if (!exists) {
+        throw new Error(`clearInput(): Node not found for selector: ${selector}`)
+      }
+    }
+    await clearInput(this.client, selector)
+    this.log(`${selector} cleared`)
+  }
+
   private log(msg: string): void {
     if (this.chromelessOptions.debug) {
       console.log(msg)

src/types.ts

@@ -154,6 +154,10 @@ export type Command =
       type: 'focus'
       selector: string
     }
+  | {
+    type: 'clearInput'
+    selector: string
+  }
 
 export interface Cookie {
   url?: string

src/util.ts

@@ -422,6 +422,44 @@ export async function pdf(
   return pdf.data
 }
 
+export async function clearInput(client: Client, selector: string): Promise<void> {
+  await wait(500)
+  await focus(client, selector)
+
+  const {Input} = client
+
+  const text = await getValue(client, selector)
+
+  const optionsDelete = {
+    nativeVirtualKeyCode: 46,
+    windowsVirtualKeyCode: 46,
+  }
+
+  const optionsBackspace = {
+    nativeVirtualKeyCode: 8,
+    windowsVirtualKeyCode: 8,
+  }
+
+  for (let i = 0; i < text.length; i++) {
+    await Input.dispatchKeyEvent({
+      ...optionsDelete,
+      type: 'rawKeyDown',
+    })
+    Input.dispatchKeyEvent({
+      ...optionsDelete,
+      type: 'keyUp',
+    })
+    await Input.dispatchKeyEvent({
+      ...optionsBackspace,
+      type: 'rawKeyDown',
+    })
+    Input.dispatchKeyEvent({
+      ...optionsBackspace,
+      type: 'keyUp',
+    })
+  }
+}
+
 export function getDebugOption(): boolean {
   if (
     process &&