Async

Author: s1hofmann

demo/clipboard.js

@@ -4,6 +4,6 @@
 const { clipboard } = require("../dist");
 
 (async () => {
-    clipboard.copy("clipboard test!");
-    console.log(clipboard.paste());
+    await clipboard.copy("clipboard test!");
+    console.log(await clipboard.paste());
 })();

demo/mouse.js

@@ -5,10 +5,10 @@
 const { mouse, movement, screen, Location } = require("../dist");
 
 const square = async () => {
-  await mouse.move(movement.right(500));
-  await mouse.move(movement.down(500));
-  await mouse.move(movement.left(500));
-  await mouse.move(movement.up(500));
+  await mouse.move(await movement.right(500));
+  await mouse.move(await movement.down(500));
+  await mouse.move(await movement.left(500));
+  await mouse.move(await movement.up(500));
 };
 
 (async () => {
@@ -18,13 +18,13 @@ const square = async () => {
   try {
     screen.config.resourceDirectory = "./assets";
     const whale = await screen.findOnScreen("docker.png");
-    mouse.move(movement.straightTo(Location.centerOf(whale)));
+    mouse.move(await movement.straightTo(Location.centerOf(whale)));
 
     const gitlens = await screen.findOnScreen("gitlens.png");
-    mouse.move(movement.straightTo(Location.centerOf(gitlens)));
-    mouse.drag(movement.right(600));
-    mouse.move(movement.straightTo(Location.centerOf(gitlens)));
-    mouse.drag(movement.straightTo(Location.centerOf(whale)));
+    mouse.move(await movement.straightTo(Location.centerOf(gitlens)));
+    mouse.drag(await movement.right(600));
+    mouse.move(await movement.straightTo(Location.centerOf(gitlens)));
+    mouse.drag(await movement.straightTo(Location.centerOf(whale)));
   } catch (error) {
     console.log(error);
   }

lib/adapter/native.adapter.class.ts

@@ -58,6 +58,16 @@ export class NativeAdapter {
     this.mouse.setMouseDelay(delay);
   }
 
+  /**
+   * setKeyboardDelay configures keyboard delay between key presses
+   *
+   * @param {number} delay The delay
+   * @memberof NativeAdapter
+   */
+  public setKeyboardDelay(delay: number): void {
+    this.keyboard.setKeyboardDelay(delay);
+  }
+
   /**
    * setMousePosition changes the current mouse cursor position to a given point
    *
@@ -71,10 +81,10 @@ export class NativeAdapter {
   /**
    * getMousePosition returns the current mouse position
    *
-   * @returns {Point} Current cursor position
+   * @returns {Promise<Point>} Current cursor position
    * @memberof NativeAdapter
    */
-  public currentMousePosition(): Point {
+  public currentMousePosition(): Promise<Point> {
     return this.mouse.currentMousePosition();
   }
 
@@ -83,10 +93,10 @@ export class NativeAdapter {
    * Please notice that on e.g. Apples Retina display the reported width
    * and the actual pixel size may differ
    *
-   * @returns {number} The main screen's width as reported by the OS
+   * @returns {Promise<number>} The main screen's width as reported by the OS
    * @memberof NativeAdapter
    */
-  public screenWidth(): number {
+  public screenWidth(): Promise<number> {
     return this.screen.screenWidth();
   }
 
@@ -95,10 +105,10 @@ export class NativeAdapter {
    * Please notice that on e.g. Apples Retina display the reported width
    * and the actual pixel size may differ
    *
-   * @returns {number} The main screen's height as reported by the OS
+   * @returns {Promise<number>} The main screen's height as reported by the OS
    * @memberof NativeAdapter
    */
-  public screenHeight(): number {
+  public screenHeight(): Promise<number> {
     return this.screen.screenHeight();
   }
 
@@ -107,10 +117,10 @@ export class NativeAdapter {
    * Please notice that on e.g. Apples Retina display the reported width
    * and the actual pixel size may differ
    *
-   * @returns {Region} The Region object the size of your main screen
+   * @returns {Promise<Region>} The Region object the size of your main screen
    * @memberof NativeAdapter
    */
-  public screenSize(): Region {
+  public screenSize(): Promise<Region> {
     return this.screen.screenSize();
   }
 
@@ -182,21 +192,21 @@ export class NativeAdapter {
   /**
    * pressKey presses and holds a given Key
    *
-   * @param {Key} key The Key to press and hold
+   * @param {Key[]} keys The Keys to press and hold
    * @memberof NativeAdapter
    */
-  public pressKey(key: Key): void {
-    this.keyboard.pressKey(key);
+  public pressKey(...keys: Key[]): void {
+    this.keyboard.pressKey(...keys);
   }
 
   /**
    * releaseKey releases a Key previously presses via pressKey
    *
-   * @param {Key} key The Key to release
+   * @param {Key[]} keys The Keys to release
    * @memberof NativeAdapter
    */
-  public releaseKey(key: Key): void {
-    this.keyboard.releaseKey(key);
+  public releaseKey(...keys: Key[]): void {
+    this.keyboard.releaseKey(...keys);
   }
 
   /**
@@ -252,10 +262,10 @@ export class NativeAdapter {
   /**
    * paste pastes the current text on the system clipboard
    *
-   * @returns {string} The clipboard text
+   * @returns {Promise<string>} The clipboard text
    * @memberof NativeAdapter
    */
-  public paste(): string {
+  public paste(): Promise<string> {
     return this.clipboard.paste();
   }
 }

lib/clipboard.class.ts

@@ -7,7 +7,7 @@ export class Clipboard {
     this.nativeAdapter.copy(text);
   }
 
-  public paste(): string {
+  public paste(): Promise<string> {
     return this.nativeAdapter.paste();
   }
 }

lib/keyboard.class.spec.ts

@@ -9,61 +9,87 @@ beforeEach(() => {
 });
 
 describe("Keyboard", () => {
-    it("should pass input strings down to the type call.", () => {
+    it("should have a default delay of 20 ms", () => {
+        // GIVEN
         const adapterMock = new NativeAdapter();
         const SUT = new Keyboard(adapterMock);
 
+        // WHEN
+
+        // THEN
+        expect(SUT.config.autoDelayMs).toEqual(20);
+    });
+
+    it("should pass input strings down to the type call.", () => {
+        // GIVEN
+        const adapterMock = new NativeAdapter();
+        const SUT = new Keyboard(adapterMock);
         const payload = "Test input!";
 
+        // WHEN
         SUT.type(payload);
+
+        // THEN
         expect(adapterMock.type).toHaveBeenCalledTimes(1);
         expect(adapterMock.type).toHaveBeenCalledWith(payload);
     });
 
     it("should pass input keys down to the click call.", () => {
+        // GIVEN
         const adapterMock = new NativeAdapter();
         const SUT = new Keyboard(adapterMock);
-
         const payload = Key.A;
 
+        // WHEN
         SUT.type(payload);
+
+        // THEN
         expect(adapterMock.click).toHaveBeenCalledTimes(1);
         expect(adapterMock.click).toHaveBeenCalledWith(payload);
     });
 
     it("should pass a list of input keys down to the click call.", () => {
+        // GIVEN
         const adapterMock = new NativeAdapter();
         const SUT = new Keyboard(adapterMock);
-
         const payload = [Key.A, Key.S, Key.D, Key.F];
 
+        // WHEN
         for (const key of payload) {
             SUT.type(key);
         }
+
+        // THEN
         expect(adapterMock.click).toHaveBeenCalledTimes(payload.length);
     });
 
     it("should pass a list of input keys down to the pressKey call.", () => {
+        // GIVEN
         const adapterMock = new NativeAdapter();
         const SUT = new Keyboard(adapterMock);
-
         const payload = [Key.A, Key.S, Key.D, Key.F];
 
+        // WHEN
         for (const key of payload) {
             SUT.pressKey(key);
         }
+
+        // THEN
         expect(adapterMock.pressKey).toHaveBeenCalledTimes(payload.length);
     });
 
     it("should pass a list of input keys down to the releaseKey call.", () => {
+        // GIVEN
         const adapterMock = new NativeAdapter();
         const SUT = new Keyboard(adapterMock);
-
         const payload = [Key.A, Key.S, Key.D, Key.F];
 
+        // WHEN
         for (const key of payload) {
             SUT.releaseKey(key);
         }
+
+        // THEN
         expect(adapterMock.releaseKey).toHaveBeenCalledTimes(payload.length);
     });
 });

lib/keyboard.class.ts

@@ -2,10 +2,17 @@ import { NativeAdapter } from "./adapter/native.adapter.class";
 import { Key } from "./key.enum";
 
 export class Keyboard {
+
   private static keyIsString(input: string | Key): input is string {
     return typeof input === "string";
   }
-  constructor(private nativeAdapter: NativeAdapter) {}
+  public config = {
+    autoDelayMs: 20,
+  };
+
+  constructor(private nativeAdapter: NativeAdapter) {
+    this.nativeAdapter.setKeyboardDelay(this.config.autoDelayMs);
+  }
 
   public type(input: string | Key): Keyboard {
     if (Keyboard.keyIsString(input)) {
@@ -16,13 +23,13 @@ export class Keyboard {
     return this;
   }
 
-  public pressKey(key: Key): Keyboard {
-    this.nativeAdapter.pressKey(key);
+  public pressKey(...keys: Key[]): Keyboard {
+    this.nativeAdapter.pressKey(...keys);
     return this;
   }
 
-  public releaseKey(key: Key): Keyboard {
-    this.nativeAdapter.releaseKey(key);
+  public releaseKey(...keys: Key[]): Keyboard {
+    this.nativeAdapter.releaseKey(...keys);
     return this;
   }
 }

lib/mouse.class.ts

@@ -18,7 +18,7 @@ export class Mouse {
     return this;
   }
 
-  public getPosition(): Point {
+  public getPosition(): Promise<Point> {
     return this.native.currentMousePosition();
   }
 

lib/movement.class.ts

@@ -6,33 +6,33 @@ export class Movement {
   constructor(private native: NativeAdapter, private lineHelper: LineHelper) {
   }
 
-  public straightTo(target: Point): Point[] {
-    const origin = this.getPosition();
+  public async straightTo(target: Point): Promise<Point[]> {
+    const origin = await this.getPosition();
     return this.lineHelper.straightLine(origin, target);
   }
 
-  public down(px: number): Point[] {
-    const pos = this.getPosition();
+  public async down(px: number): Promise<Point[]> {
+    const pos = await this.getPosition();
     return this.straightTo(new Point(pos.x, pos.y + px));
   }
 
-  public up(px: number): Point[] {
-    const pos = this.getPosition();
+  public async up(px: number): Promise<Point[]> {
+    const pos = await this.getPosition();
     return this.straightTo(new Point(pos.x, pos.y - px));
   }
 
-  public left(px: number): Point[] {
-    const pos = this.getPosition();
+  public async left(px: number): Promise<Point[]> {
+    const pos = await this.getPosition();
     return this.straightTo(new Point(pos.x - px, pos.y));
   }
 
-  public right(px: number): Point[] {
-    const pos = this.getPosition();
+  public async right(px: number): Promise<Point[]> {
+    const pos = await this.getPosition();
     return this.straightTo(new Point(pos.x + px, pos.y));
   }
 
-  private getPosition(): Point {
-    const pos = this.native.currentMousePosition();
+  private async getPosition(): Promise<Point> {
+    const pos = await this.native.currentMousePosition();
     return new Point(pos.x, pos.y);
   }
 }

lib/provider/native/clipboard-action-provider.interface.ts

@@ -7,18 +7,18 @@ export interface ClipboardActionProvider {
   /**
    * hasText should return whether the system clipboard currently holds text or not
    *
-   * @returns {boolean} True if there's text on the clipboard, false otherwise
+   * @returns {Promise<boolean>} True if there's text on the clipboard, false otherwise
    * @memberof ClipboardActionProvider
    */
-  hasText(): boolean;
+  hasText(): Promise<boolean>;
 
   /**
    * clear should allow to clear the system clipboard
    *
-   * @returns {boolean}
+   * @returns {Promise<boolean>} Successfully cleared or not
    * @memberof ClipboardActionProvider
    */
-  clear(): boolean;
+  clear(): Promise<boolean>;
 
   /**
    * copy should allow to copy text to the system's clipboard
@@ -31,8 +31,8 @@ export interface ClipboardActionProvider {
   /**
    * paste should allow to paste the current text on the system's clipboard
    *
-   * @returns {string} The current clipboard text
+   * @returns {Promise<string>} The current clipboard text
    * @memberof ClipboardActionProvider
    */
-  paste(): string;
+  paste(): Promise<string>;
 }