feat: extend interaction with text (#208)

* feat: extend interaction with text

Author: SvetoslavTsenov

Diff for: lib/appium-driver.d.ts

@@ -198,6 +198,11 @@ export declare class AppiumDriver {
      * @param time in minutes
      */
     backgroundApp(minutes: number): Promise<void>;
+    /**
+     * Hides device keyboard
+     */
+    hideDeviceKeyboard(): Promise<void>;
+    isKeyboardShown(): Promise<any>;
     resetApp(): Promise<void>;
     init(): Promise<void>;
     quit(): Promise<void>;

Diff for: lib/appium-driver.ts

@@ -734,6 +734,17 @@ export class AppiumDriver {
         await this._driver.backgroundApp(minutes);
     }
 
+    /**
+     * Hides device keyboard
+     */
+    public async hideDeviceKeyboard() {
+        await this._driver.hideDeviceKeyboard();
+    }
+
+    public async isKeyboardShown() {
+        return await this._driver.isKeyboardShown();
+    }
+
     public async resetApp() {
         await this._driver.resetApp();
     }

Diff for: lib/ui-element.d.ts

@@ -17,6 +17,7 @@ export declare class UIElement {
      */
     click(): Promise<any>;
     tapCenter(): Promise<void>;
+    tapAtTheEnd(): Promise<void>;
     /**
      * Tap on element
      */
@@ -107,7 +108,7 @@ export declare class UIElement {
      * @param yOffset
      * @param xOffset
      */
-    scrollTo(direction: Direction, elementToSearch: any, yOffset?: number, xOffset?: number): Promise<UIElement>;
+    scrollTo(direction: Direction, elementToSearch: () => Promise<UIElement>, yOffset?: number, xOffset?: number, retries?: number): Promise<UIElement>;
     /**
  * Scroll with offset from element with minimum inertia
  * @param direction
@@ -123,8 +124,24 @@ export declare class UIElement {
     /**
      * Send keys to field or other UI component
      * @param text
+     * @param shouldClearText, default value is true
      */
-    sendKeys(text: string): Promise<void>;
+    sendKeys(text: string, shouldClearText?: boolean): Promise<void>;
+    /**
+    * Type text to field or other UI component
+    * @param text
+    * @param shouldClearText, default value is true
+    */
+    type(text: string, shouldClearText?: boolean): Promise<void>;
+    /**
+    * Send key code to device
+    * @param key code
+    */
+    pressKeycode(keyCode: number): Promise<void>;
+    /**
+    * Clears text form ui element
+    */
+    clearText(): Promise<void>;
     log(): Promise<void>;
     refetch(): Promise<any>;
     /**

Diff for: lib/ui-element.ts

@@ -1,9 +1,9 @@
 import { Point } from "./point";
 import { Direction } from "./direction";
 import { INsCapabilities } from "./interfaces/ns-capabilities";
-import { IRectangle } from "./interfaces/rectangle";
 import { AutomationName } from "./automation-name";
 import { calculateOffset } from "./utils";
+import { AndroidKeyEvent } from "mobile-devices-controller";
 
 export class UIElement {
     private static readonly DEFAULT_REFETCH_TIME = 1000;
@@ -33,6 +33,15 @@ export class UIElement {
         await this._driver.sleep(150);
     }
 
+    public async tapAtTheEnd() {
+        let action = new this._wd.TouchAction(this._driver);
+        const rect = await this.getActualRectangle();
+        action
+            .tap({ x: (rect.x + rect.width) - 1, y: rect.y + rect.height / 2 });
+        await action.perform();
+        await this._driver.sleep(150);
+    }
+
     /**
      * Tap on element
      */
@@ -364,11 +373,43 @@ export class UIElement {
     /**
      * Send keys to field or other UI component
      * @param text
+     * @param shouldClearText, default value is true
      */
-    public async sendKeys(text: string) {
+    public async sendKeys(text: string, shouldClearText: boolean = true) {
+        if (shouldClearText) {
+            await this.clearText();
+        }
         await this._element.sendKeys(text);
     }
 
+    /**
+    * Type text to field or other UI component
+    * @param text
+    * @param shouldClearText, default value is true
+    */
+    public async type(text: string, shouldClearText: boolean = true) {
+        if (shouldClearText) {
+            await this.clearText();
+        }
+        await this._element.type(text);
+    }
+
+    /**
+    * Send key code to device
+    * @param key code
+    */
+    public async pressKeycode(keyCode: number) {
+        await this._driver.pressKeycode(keyCode);
+    }
+
+    /**
+    * Clears text form ui element
+    */
+    public async clearText() {
+        await this.click();
+        await this._element.clear();
+    }
+
     public async log() {
         console.dir(await this.element());
     }