feat: implement pinch, pan, rotate and scroll

Still in experimental mode

Author: SvetoslavTsenov

lib/appium-driver.ts

@@ -484,7 +484,7 @@ export class AppiumDriver {
      * @param xOffset
      */
     public async scroll(direction: Direction, y: number, x: number, yOffset: number, xOffset: number = 0) {
-        await scroll(this._wd, this._driver, direction, this._webio.isIOS, y, x, yOffset, xOffset, this._args.verbose);
+        await scroll(this._wd, this._driver, direction, this._webio.isIOS, y, x, yOffset, xOffset);
     }
 
     /**
@@ -504,7 +504,7 @@ export class AppiumDriver {
                 el = await element();
                 isDisplayed = await el.isDisplayed();
                 if (!isDisplayed) {
-                    await scroll(this._wd, this._driver, direction, this._webio.isIOS, startPoint.y, startPoint.x, offsetPoint.x, offsetPoint.y, this._args.verbose);
+                    await scroll(this._wd, this._driver, direction, this._webio.isIOS, startPoint.y, startPoint.x, offsetPoint.x, offsetPoint.y);
                     el = null;
                 }
             } catch (error) {

lib/ui-element.d.ts

@@ -16,6 +16,10 @@ export declare class UIElement {
      * Click on element
      */
     click(): Promise<any>;
+    getCenter(): Promise<{
+        x: number;
+        y: number;
+    }>;
     tapCenter(): Promise<void>;
     tapAtTheEnd(): Promise<void>;
     /**
@@ -26,17 +30,22 @@ export declare class UIElement {
      */
     tap(): Promise<any>;
     /**
+     * @experimental
      * Double tap on element
      */
     doubleTap(): Promise<any>;
+    longPress(duration: number): Promise<void>;
     /**
      * Get location of element
      */
     location(): Promise<Point>;
     /**
      * Get size of element
      */
-    size(): Promise<Point>;
+    size(): Promise<{
+        width: number;
+        height: number;
+    }>;
     /**
      * Get text of element
      */
@@ -113,13 +122,6 @@ export declare class UIElement {
      */
     scrollTo(direction: Direction, elementToSearch: () => Promise<UIElement>, yOffset?: number, xOffset?: number, retries?: number): Promise<UIElement>;
     /**
- * Drag element with specific offset
- * @param direction
- * @param yOffset
- * @param xOffset - default value 0
- */
-    drag(direction: Direction, yOffset: number, xOffset?: number): Promise<void>;
-    /**
      * Click and hold over an element
      * @param time in milliseconds to increase the default press period.
      */
@@ -164,5 +166,51 @@ export declare class UIElement {
     * Swipe element left/right
     * @param direction
     */
-    swipe(direction: Direction): Promise<void>;
+    swipe(direction: "up" | "down" | "left" | "right"): Promise<void>;
+    /**
+    * Drag element with specific offset
+    * @experimental
+    * @param direction
+    * @param yOffset
+    * @param xOffset - default value 0
+    */
+    drag(direction: Direction, yOffset: number, xOffset?: number): Promise<void>;
+    /**
+    *@experimental
+    * Pan element with specific offset
+    * @param points where the finger should move to.
+    * @param initPointOffset element.getRectangle() is used as start point. In case some additional offset should be provided use this param.
+    */
+    pan(points: {
+        x: number;
+        y: number;
+    }[], initPointOffset?: {
+        x: number;
+        y: number;
+    }): Promise<void>;
+    /**
+     * @experimental
+     * This method will try to move two fingers from opposite corners.
+     * One finger starts from
+     * { x: elementRect.x + offset.x, y: elementRect.y + offset.y }
+     * and ends to
+     * { x: elementRect.x + elementRect.width - offset.x, y: elementRect.height + elementRect.y - offset.y }
+     * and the other finger starts from
+     * { x: elementRect.width + elementRect.x - offset.x, y: elementRect.height + elementRect.y - offset.y }
+     * and ends to
+     * { x: elementRect.x + offset.x, y: elementRect.y + offset.y }
+     */
+    rotate(offset?: {
+        x: number;
+        y: number;
+    }): Promise<void>;
+    /**
+     * @experimental
+     * @param zoomFactory - zoomIn or zoomOut. Only zoomIn action is implemented
+     * @param offset
+     */
+    pinch(zoomType: "in" | "out", offset?: {
+        x: number;
+        y: number;
+    }): Promise<void>;
 }