feat: enhance browser navigation

assert-equals · Jun 12, 2024 · 36ea825 · 36ea825
1 parent 8898eb5
commit 36ea825
Show file tree

Hide file tree

Showing 57 changed files with 1,618 additions and 2,268 deletions.
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/flask.ExperimentalArea.html b/docs/classes/flask.ExperimentalArea.html
diff --git a/docs/classes/index.PageObject.html b/docs/classes/index.PageObject.html
diff --git a/docs/classes/metamask.AddNetwork.html b/docs/classes/metamask.AddNetwork.html
diff --git a/docs/classes/metamask.Approve.html b/docs/classes/metamask.Approve.html
diff --git a/docs/classes/metamask.Completion.html b/docs/classes/metamask.Completion.html
diff --git a/docs/classes/metamask.ConfirmAddSuggestedToken.html b/docs/classes/metamask.ConfirmAddSuggestedToken.html
diff --git a/docs/classes/metamask.ConfirmRecoveryPhrase.html b/docs/classes/metamask.ConfirmRecoveryPhrase.html
diff --git a/docs/classes/metamask.ConfirmTransaction.html b/docs/classes/metamask.ConfirmTransaction.html
diff --git a/docs/classes/metamask.Connect.html b/docs/classes/metamask.Connect.html
diff --git a/docs/classes/metamask.CreatePassword.html b/docs/classes/metamask.CreatePassword.html
diff --git a/docs/classes/metamask.Home.html b/docs/classes/metamask.Home.html
diff --git a/docs/classes/metamask.ImportWithRecoveryPhrase.html b/docs/classes/metamask.ImportWithRecoveryPhrase.html
diff --git a/docs/classes/metamask.Metametrics.html b/docs/classes/metamask.Metametrics.html
diff --git a/docs/classes/metamask.PinExtension.html b/docs/classes/metamask.PinExtension.html
diff --git a/docs/classes/metamask.ReviewRecoveryPhrase.html b/docs/classes/metamask.ReviewRecoveryPhrase.html
diff --git a/docs/classes/metamask.SecureYourWallet.html b/docs/classes/metamask.SecureYourWallet.html
diff --git a/docs/classes/metamask.SignMessage.html b/docs/classes/metamask.SignMessage.html
diff --git a/docs/classes/metamask.SignatureRequest.html b/docs/classes/metamask.SignatureRequest.html
diff --git a/docs/classes/metamask.Welcome.html b/docs/classes/metamask.Welcome.html
diff --git a/docs/classes/rainbow.AddNetwork.html b/docs/classes/rainbow.AddNetwork.html
diff --git a/docs/classes/rainbow.Approve.html b/docs/classes/rainbow.Approve.html
diff --git a/docs/classes/rainbow.ApproveRequest.html b/docs/classes/rainbow.ApproveRequest.html
diff --git a/docs/classes/rainbow.ConfirmTransaction.html b/docs/classes/rainbow.ConfirmTransaction.html
diff --git a/docs/classes/rainbow.Connect.html b/docs/classes/rainbow.Connect.html
diff --git a/docs/classes/rainbow.CreatePassword.html b/docs/classes/rainbow.CreatePassword.html
diff --git a/docs/classes/rainbow.Import.html b/docs/classes/rainbow.Import.html
diff --git a/docs/classes/rainbow.ImportOrConnect.html b/docs/classes/rainbow.ImportOrConnect.html
diff --git a/docs/classes/rainbow.ImportSeed.html b/docs/classes/rainbow.ImportSeed.html
diff --git a/docs/classes/rainbow.ImportSelect.html b/docs/classes/rainbow.ImportSelect.html
diff --git a/docs/classes/rainbow.Ready.html b/docs/classes/rainbow.Ready.html
diff --git a/docs/classes/rainbow.RevealSeed.html b/docs/classes/rainbow.RevealSeed.html
diff --git a/docs/classes/rainbow.SeedBackup.html b/docs/classes/rainbow.SeedBackup.html
diff --git a/docs/classes/rainbow.SeedVerify.html b/docs/classes/rainbow.SeedVerify.html
diff --git a/docs/classes/rainbow.SignMessage.html b/docs/classes/rainbow.SignMessage.html
diff --git a/docs/classes/rainbow.SignatureRequest.html b/docs/classes/rainbow.SignatureRequest.html
diff --git a/docs/classes/rainbow.Welcome.html b/docs/classes/rainbow.Welcome.html
diff --git a/docs/classes/zerion.AddNetwork.html b/docs/classes/zerion.AddNetwork.html
diff --git a/docs/classes/zerion.Approve.html b/docs/classes/zerion.Approve.html
diff --git a/docs/classes/zerion.BackUp.html b/docs/classes/zerion.BackUp.html
diff --git a/docs/classes/zerion.ConfirmPassword.html b/docs/classes/zerion.ConfirmPassword.html
diff --git a/docs/classes/zerion.Connect.html b/docs/classes/zerion.Connect.html
diff --git a/docs/classes/zerion.ImportWallet.html b/docs/classes/zerion.ImportWallet.html
diff --git a/docs/classes/zerion.Information.html b/docs/classes/zerion.Information.html
diff --git a/docs/classes/zerion.Password.html b/docs/classes/zerion.Password.html
diff --git a/docs/classes/zerion.RecoveryPhrase.html b/docs/classes/zerion.RecoveryPhrase.html
diff --git a/docs/classes/zerion.SelectWallets.html b/docs/classes/zerion.SelectWallets.html
diff --git a/docs/classes/zerion.SendTransaction.html b/docs/classes/zerion.SendTransaction.html
diff --git a/docs/classes/zerion.SignMessage.html b/docs/classes/zerion.SignMessage.html
diff --git a/docs/classes/zerion.SignatureRequest.html b/docs/classes/zerion.SignatureRequest.html
diff --git a/docs/classes/zerion.Success.html b/docs/classes/zerion.Success.html
diff --git a/docs/classes/zerion.Verify.html b/docs/classes/zerion.Verify.html
diff --git a/docs/classes/zerion.Welcome.html b/docs/classes/zerion.Welcome.html
diff --git a/src/interface/page/page-object.ts b/src/interface/page/page-object.ts
@@ -2,7 +2,8 @@ import { IConfirmation } from '../wallet/confirmation';
 
 export interface IPageObject {
   back(): Promise<void>;
-  backToPage<TPage>(page: new () => TPage): Promise<TPage>;
+  back<TPage>(page: new () => TPage): Promise<TPage>;
+  back<TPage>(page?: new () => TPage): Promise<any>;
   close(): Promise<void>;
   closeAndSwitchToMainWindow<TPage>(page: new () => TPage): Promise<TPage>;
   createNewWindow(): Promise<void>;
@@ -14,14 +15,16 @@ export interface IPageObject {
   getWindowHandle(): Promise<any>;
   maximize(): Promise<void>;
   navigateTo(url: string): Promise<void>;
-  navigateToPage<TPage>(url: string, page: new () => TPage): Promise<TPage>;
+  navigateTo<TPage>(url: string, page: new () => TPage): Promise<TPage>;
+  navigateTo<TPage>(url: string, page?: new () => TPage): Promise<any>;
   navigateToPageInNewWindow<TPage>(url: string, page: new () => TPage): Promise<TPage>;
   opensInExtension<TPage extends IConfirmation>(page: new () => TPage): Promise<TPage>;
   opensInNewWindow(): Promise<void>;
   opensInNewWindow<TPage>(page: new () => TPage): Promise<TPage>;
   opensInNewWindow<TPage>(page?: new () => TPage): Promise<any>;
   refresh(): Promise<void>;
-  refreshPage<TPage>(page: new () => TPage): Promise<TPage>;
+  refresh<TPage>(page: new () => TPage): Promise<TPage>;
+  refresh<TPage>(page?: new () => TPage): Promise<any>;
   setSize(width: number, height: number): Promise<void>;
   switchBack(): Promise<void>;
   switchToFrame(cssLocator: string): Promise<void>;

diff --git a/src/page/index.ts b/src/page/index.ts
@@ -105,22 +105,17 @@ export class PageObject implements IPageObject {
   /**
    *
    * Schedules a command to navigate to the previous URL
-   * @return {*}  {Promise<void>}
-   * @memberof PageObject
-   */
-  async back(): Promise<void> {
-    return this.callIfMethodExists('back');
-  }
-  /**
-   *
-   * Schedules a command to navigate to the previous page
    * @template TPage
-   * @param {new () => TPage} page
-   * @return {*}  {Promise<TPage>}
+   * @param {new () => TPage} [page]
+   * @return {*}  {Promise<any>}
    * @memberof PageObject
    */
-  async backToPage<TPage>(page: new () => TPage): Promise<TPage> {
-    return this.callIfMethodExists('backToPage', [page]);
+  async back<TPage>(page?: new () => TPage): Promise<any> {
+    if (page) {
+      return this.callIfMethodExists('back', [page]);
+    } else {
+      return this.callIfMethodExists('back');
+    }
   }
   /**
    *
@@ -224,26 +219,19 @@ export class PageObject implements IPageObject {
   /**
    *
    * Schedules a command to navigate to a new URL
-   * @param {string} url
-   * @return {*}  {Promise<void>}
-   * @memberof PageObject
-   */
-  async navigateTo(url: string): Promise<void> {
-    url = this.getFullURL(url);
-    return this.callIfMethodExists('navigateTo', [url]);
-  }
-  /**
-   *
-   * Schedules a command to navigate to a new page
    * @template TPage
    * @param {string} url
-   * @param {new () => TPage} page
-   * @return {*}  {Promise<TPage>}
+   * @param {new () => TPage} [page]
+   * @return {*}  {Promise<any>}
    * @memberof PageObject
    */
-  async navigateToPage<TPage>(url: string, page: new () => TPage): Promise<TPage> {
+  async navigateTo<TPage>(url: string, page?: new () => TPage): Promise<any> {
     url = this.getFullURL(url);
-    return this.callIfMethodExists('navigateToPage', [url, page]);
+    if (page) {
+      return this.callIfMethodExists('navigateTo', [url, page]);
+    } else {
+      return this.callIfMethodExists('navigateTo', [url]);
+    }
   }
   /**
    *
@@ -284,25 +272,20 @@ export class PageObject implements IPageObject {
       return this.callIfMethodExists('opensInNewWindow');
     }
   }
-  /**
-   *
-   * Schedules a command to refresh the current page
-   * @return {*}  {Promise<void>}
-   * @memberof PageObject
-   */
-  async refresh(): Promise<void> {
-    return this.callIfMethodExists('refresh');
-  }
   /**
    *
    * Schedules a command to refresh the current page
    * @template TPage
-   * @param {new () => TPage} page
-   * @return {*}  {Promise<TPage>}
+   * @param {new () => TPage} [page]
+   * @return {*}  {Promise<any>}
    * @memberof PageObject
    */
-  async refreshPage<TPage>(page: new () => TPage): Promise<TPage> {
-    return this.callIfMethodExists('refreshPage', [page]);
+  async refresh<TPage>(page?: new () => TPage): Promise<any> {
+    if (page) {
+      return this.callIfMethodExists('refresh', [page]);
+    } else {
+      return this.callIfMethodExists('refresh');
+    }
   }
   /**
    *

diff --git a/src/playwright/page-object.ts b/src/playwright/page-object.ts
@@ -21,13 +21,11 @@ export class PlaywrightPageObject implements IPageObject {
     DappDriver.Instance.Page = this.page;
   }
 
-  async back(): Promise<void> {
+  async back<TPage>(page?: new () => TPage): Promise<any> {
     await this.page.goBack();
-  }
-
-  async backToPage<TPage>(page: new () => TPage): Promise<TPage> {
-    await this.back();
-    return DappDriver.getPage(page);
+    if (page) {
+      return DappDriver.getPage(page);
+    }
   }
 
   async close(): Promise<void> {
@@ -77,18 +75,16 @@ export class PlaywrightPageObject implements IPageObject {
     await this.page.setViewportSize({ width, height });
   }
 
-  async navigateTo(url: string): Promise<void> {
+  async navigateTo<TPage>(url: string, page?: new () => TPage): Promise<any> {
     await this.page.goto(url);
-  }
-
-  async navigateToPage<TPage>(url: string, page: new () => TPage): Promise<TPage> {
-    await this.navigateTo(url);
-    return DappDriver.getPage(page);
+    if (page) {
+      return DappDriver.getPage(page);
+    }
   }
 
   async navigateToPageInNewWindow<TPage>(url: string, page: new () => TPage): Promise<TPage> {
     await this.createNewWindow();
-    return this.navigateToPage<TPage>(url, page);
+    return this.navigateTo<TPage>(url, page);
   }
 
   async opensInExtension<TPage extends IConfirmation>(page: new () => TPage): Promise<TPage> {
@@ -104,13 +100,11 @@ export class PlaywrightPageObject implements IPageObject {
     }
   }
 
-  async refresh(): Promise<void> {
+  async refresh<TPage>(page?: new () => TPage): Promise<any> {
     await this.page.reload();
-  }
-
-  async refreshPage<TPage>(page: new () => TPage): Promise<TPage> {
-    await this.refresh();
-    return DappDriver.getPage(page);
+    if (page) {
+      return DappDriver.getPage(page);
+    }
   }
 
   async setSize(width: number, height: number): Promise<void> {

diff --git a/src/webdriver/page-object.ts b/src/webdriver/page-object.ts
@@ -11,13 +11,11 @@ export class WebDriverPageObject implements IPageObject {
     this.driver = DappDriver.Instance.Driver as WebDriver;
   }
 
-  async back(): Promise<void> {
+  async back<TPage>(page?: new () => TPage): Promise<any> {
     await this.driver.navigate().back();
-  }
-
-  async backToPage<TPage>(page: new () => TPage): Promise<TPage> {
-    await this.back();
-    return DappDriver.getPage(page);
+    if (page) {
+      return DappDriver.getPage(page);
+    }
   }
 
   async close(): Promise<void> {
@@ -67,18 +65,16 @@ export class WebDriverPageObject implements IPageObject {
     await this.driver.manage().window().maximize();
   }
 
-  async navigateTo(url: string): Promise<void> {
+  async navigateTo<TPage>(url: string, page?: new () => TPage): Promise<any> {
     await this.driver.navigate().to(url);
-  }
-
-  async navigateToPage<TPage>(url: string, page: new () => TPage): Promise<TPage> {
-    await this.navigateTo(url);
-    return DappDriver.getPage(page);
+    if (page) {
+      return DappDriver.getPage(page);
+    }
   }
 
   async navigateToPageInNewWindow<TPage>(url: string, page: new () => TPage): Promise<TPage> {
     await this.createNewWindow();
-    return this.navigateToPage<TPage>(url, page);
+    return this.navigateTo<TPage>(url, page);
   }
 
   async opensInExtension<TPage extends IConfirmation>(page: new () => TPage): Promise<TPage> {
@@ -97,13 +93,11 @@ export class WebDriverPageObject implements IPageObject {
     }
   }
 
-  async refresh(): Promise<void> {
+  async refresh<TPage>(page?: new () => TPage): Promise<any> {
     await this.driver.navigate().refresh();
-  }
-
-  async refreshPage<TPage>(page: new () => TPage): Promise<TPage> {
-    await this.refresh();
-    return DappDriver.getPage(page);
+    if (page) {
+      return DappDriver.getPage(page);
+    }
   }
 
   async setSize(width: number, height: number): Promise<void> {