add pageobject

Author: licanhua

src/index.ts

@@ -5,4 +5,5 @@
 
 export { By2 } from './by2';
 export { IAppiumDriver, createAppiumWebDriver } from './appiumdriver'
-export { windowsNativeAppCapabilities } from './appiumdriver.windows'
+export { windowsNativeAppCapabilities } from './appiumdriver.windows'
+export { IPageObject, PageObject } from './pageobject'

src/pageobject.ts

@@ -0,0 +1,84 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { WebDriver, WebElementCondition, By } from "selenium-webdriver";
+import { IAppiumDriver } from './appiumdriver';
+
+export interface IPageObject {
+  clickAndGotoPage<T extends IPageObject>(type: (new (...args: any[]) => T), by: By, timeout?: number): Promise<T>;
+  gotoPage<T extends IPageObject>(type: (new (...args: any[]) => T), timeout?: number): Promise<T>;
+  isReadyConditions(): WebElementCondition[];
+  waitUntilReady(timeout?: number): Promise<void>;
+};
+
+function getInstance<T>(type: (new (...args: any[]) => T), ...args: any[]): T {
+  return new type(...args);
+};
+
+function gotoPage<T extends IPageObject>(type: (new (...args: any[]) => T), driver: IAppiumDriver, timeout?: number): Promise<T> {
+  const page = getInstance(type, driver);
+  return new Promise<T>((resolve) => {
+    page.waitUntilReady(timeout).then(() => resolve(page))
+  });
+}
+
+function clickAndGotoPage<T extends IPageObject>(type: (new (...args: any[]) => T), driver: IAppiumDriver, by: By, timeout?: number): Promise<T> {
+  return new Promise<T>((resolve) => {
+    driver.get(by, timeout)
+      .then(el => { return el.click(); })
+      .then(() => { return gotoPage(type, driver, timeout); })
+      .then(page => resolve(page));
+  });
+}
+
+export class PageObject implements IPageObject {
+  private static defaultTimeout: number = 20000; //ms
+  private timeout?: number;
+  private getTimeout(timeout?: number): number {
+    if (timeout)
+      return timeout;
+    if (this.timeout)
+      return this.timeout;
+    return PageObject.defaultTimeout;
+  }
+
+  static setDefaultTimeout(ms: number) {
+    this.defaultTimeout = ms;
+  }
+
+  protected appiumDriver: IAppiumDriver;
+
+  constructor(dirver: IAppiumDriver, timeout?: number) {
+    this.timeout = timeout;
+    this.appiumDriver = dirver;
+  }
+
+  isReadyConditions(): WebElementCondition[] {
+    throw new Error("Not implemented");
+  }
+
+  waitUntilReady(timeout?: number): Promise<void> {
+    const webDriver = this.appiumDriver.seleniumDriver();
+    if (webDriver) {
+      return PageObject.waitForConditions(webDriver, this.isReadyConditions(), this.getTimeout(timeout));
+    } else {
+      return Promise.reject("no driver found");
+    }
+  }
+
+  clickAndGotoPage<T extends IPageObject>(type: (new (...args: any[]) => T), by: By, timeout?: number): Promise<T> {
+    return clickAndGotoPage(type, this.appiumDriver, by, this.getTimeout(timeout));
+  }
+
+  gotoPage<T extends IPageObject>(type: (new (...args: any[]) => T), timeout?: number): Promise<T> {
+    return gotoPage(type, this.appiumDriver, this.getTimeout(timeout));
+  }
+
+  private static async  waitForConditions(driver: WebDriver, conditions: WebElementCondition[], timeout?: number) {
+    for (var i = 0; i < conditions.length; i++) {
+      await driver.wait(conditions[i], timeout);
+    }
+  }
+}