@bigbinary/neeto-playwright-commons 1.22.34 → 1.22.36

package/index.d.ts

@@ -1886,15 +1886,18 @@ type GooglePageParams = {
   neetoPlaywrightUtilities: CustomCommands;
   integration: string;
   integrationRouteIndex?: string;
+  appName?: string;
 };
 declare class GooglePage extends IntegrationBase {
   totp: TOTP;
   t: TFunction;
+  appName: string;
   constructor({
     page,
     neetoPlaywrightUtilities,
     integration,
-    integrationRouteIndex
+    integrationRouteIndex,
+    appName
   }: GooglePageParams);
   waitForGoogleAuthURL: () => Promise<void>;
   /**
@@ -1908,7 +1911,7 @@ declare class GooglePage extends IntegrationBase {
    * await googlePage.connectGoogleAccount("neetoForm");
    * @endexample
   */
-  connectGoogleAccount: (appName: string) => Promise<void>;
+  connectGoogleAccount: (appName?: string) => Promise<void>;
   /**
    *
    * Selects the Google account to be used during the integration. If a verification code is required (e.g., for 2FA), it enters the TOTP code.
@@ -1920,7 +1923,7 @@ declare class GooglePage extends IntegrationBase {
    * await googlePage.selectGoogleAccount("neetoForm");
    * @endexample
   */
-  selectGoogleAccount: (appName: string) => Promise<void>;
+  selectGoogleAccount: (appName?: string) => Promise<void>;
   /**
    *
    * Automates the login process to a Google account, filling in the email, password, and handling 2FA (Two-Factor Authentication) via TOTP.
@@ -1973,6 +1976,16 @@ declare class GooglePage extends IntegrationBase {
     allowPermissions
   }?: Partial<StagingConsentFlowParams>) => Promise<void>;
   private handleNotVerifiedPage;
+  /**
+   *
+   * Revokes permissions for the Google integration by navigating to Google's connections page and removing the application connection. This method handles the complete flow of disconnecting the app from Google's side.
+   *
+   * @example 
+   *
+   * await googlePage.revokePermissions();
+   * @endexample
+  */
+  revokePermissions: () => Promise<void>;
 }
 type AsyncNoArgsFunction = () => Promise<void>;
 type RedirectUrl = string | RegExp | ((url: URL) => boolean);
@@ -3515,7 +3528,7 @@ declare class ApiKeysPage {
   deleteApiKey: (targetRow: Locator) => Promise<void>;
 }
 interface VerifyAuditLogProps {
-  targetRow: Locator;
+  targetRow?: Locator;
   action: string;
   date: string;
   adminName: string;
@@ -3528,12 +3541,58 @@ interface VerifyDataInPaneProps {
   lastName?: string;
   roleName?: string;
 }
+interface VerifyAuditLogEntryProps {
+  page?: Page;
+  tableDetails: VerifyAuditLogProps;
+  paneDetails: {
+    values: string[];
+    userDetails?: {
+      firstName?: string;
+      lastName?: string;
+      roleName?: string;
+    };
+  };
+}
 declare class AuditLogsPage {
   page: Page;
   neetoPlaywrightUtilities: CustomCommands;
   t: TFunction;
   targetRow: Locator;
   constructor(page: Page, neetoPlaywrightUtilities: CustomCommands);
+  /**
+   *
+   * Used to verify both the audit log table entry and the detailed information in the pane. This method combines verifyAuditLog and verifyDataInPane for comprehensive verification.
+   *
+   * page (optional): The custom page context. Default is POM's page.
+   *
+   * tableDetails (required): Object containing details for table verification.
+   *
+   * @example 
+   *
+   * await auditLogsPage.verifyAuditLogEntry({
+   *   page,
+   *   tableDetails: {
+   *     targetRow: page.getByRole("row"),
+   *     action: "Updated user",
+   *     date: "Nov 27, 2024",
+   *     adminName: "Oliver Smith"
+   *   },
+   *   paneDetails: {
+   *     values: ["johnluther@example.com"],
+   *     userDetails: {
+   *       firstName: "John",
+   *       lastName: "Luther",
+   *       roleName: "Agent"
+   *     }
+   *   }
+   * });
+   * @endexample
+  */
+  verifyAuditLogEntry: ({
+    page,
+    tableDetails,
+    paneDetails
+  }: VerifyAuditLogEntryProps) => Promise<void>;
   /**
    *
    * Used to verify the values in the audit logs table.
@@ -4424,6 +4483,7 @@ declare const THIRD_PARTY_ROUTES: {
     signin: string;
     password: string;
     totpChallenge: string;
+    connections: string;
     challengeSelection: string;
     myAccount: string;
     chooseAccount: string;
@@ -4681,6 +4741,7 @@ declare const GOOGLE_LOGIN_TEXTS: {
   connectYourGoogleAccount: string;
   signInWithGoogle: string;
   signInHeading: (appName: string) => RegExp;
+  stagingAppName: (appName: string) => string;
   continue: string;
   selectAll: string;
   appNotVerified: string;

package/index.js

@@ -96,6 +96,7 @@ const THIRD_PARTY_ROUTES = {
         signin: "https://accounts.google.com/v3/signin/identifier?hl=en-gb&ifkv=ASKXGp0nW770RS7xin2puSwbGDpGCeaVKDtCgfpEU73fYmhMKbqUjukBQ5x8kdvEVxQ7OvcrnUo8sg&flowName=GlifWebSignIn&flowEntry=ServiceLogin&dsh=S688843923%3A1704795906762870&theme=glif",
         password: "https://accounts.google.com/v3/signin/challenge/pwd",
         totpChallenge: "https://accounts.google.com/v3/signin/challenge/totp",
+        connections: "https://myaccount.google.com/connections",
         challengeSelection: "https://accounts.google.com/v3/signin/challenge/selection",
         myAccount: "https://myaccount.google.com/",
         chooseAccount: "accounts.google.com/o/oauth2/auth/oauthchooseaccount",
@@ -189403,6 +189404,7 @@ const GOOGLE_LOGIN_TEXTS = {
     connectYourGoogleAccount: "Connect your Google account",
     signInWithGoogle: "Sign in with Google",
     signInHeading: (appName) => new RegExp(`(You’re signing back in to ${appName}\\.net|Sign in to ${appName}\\.net)`, "i"),
+    stagingAppName: (appName) => `${appName} - Staging`,
     continue: "Continue",
     selectAll: "Select All",
     appNotVerified: "Google hasn’t verified this app",
@@ -191679,7 +191681,7 @@ class IntegrationBase {
 }
 
 class GooglePage extends IntegrationBase {
-    constructor({ page, neetoPlaywrightUtilities, integration, integrationRouteIndex, }) {
+    constructor({ page, neetoPlaywrightUtilities, integration, integrationRouteIndex, appName, }) {
         var _a;
         super({
             page,
@@ -191691,7 +191693,7 @@ class GooglePage extends IntegrationBase {
             await this.page.waitForLoadState("load", { timeout: 25000 });
             await this.page.waitForURL(new RegExp(`${THIRD_PARTY_ROUTES.google.accountchooser}|${THIRD_PARTY_ROUTES.google.chooseAccount}`));
         };
-        this.connectGoogleAccount = async (appName) => {
+        this.connectGoogleAccount = async (appName = this.appName) => {
             await this.waitForGoogleAuthURL();
             await this.selectGoogleAccount(appName);
             await this.page.waitForLoadState("load", { timeout: 25000 });
@@ -191700,7 +191702,7 @@ class GooglePage extends IntegrationBase {
                 .getByRole("button", { name: GOOGLE_LOGIN_TEXTS.allow })
                 .click();
         };
-        this.selectGoogleAccount = async (appName) => {
+        this.selectGoogleAccount = async (appName = this.appName) => {
             const chooseAnAccountHeading = this.page.getByText(GOOGLE_LOGIN_TEXTS.chooseAnAccount, { exact: true });
             await expect(chooseAnAccountHeading).toBeVisible({ timeout: 10000 });
             await this.page
@@ -191816,11 +191818,28 @@ class GooglePage extends IntegrationBase {
                 name: GOOGLE_LOGIN_TEXTS.backToSafety,
             })).toBeHidden({ timeout: 10000 });
         };
+        this.revokePermissions = async () => {
+            const stagingAppName = GOOGLE_LOGIN_TEXTS.stagingAppName(this.appName);
+            await this.page.goto(THIRD_PARTY_ROUTES.google.connections);
+            await this.page.waitForLoadState("load", { timeout: 15000 });
+            const app = this.page.getByRole("link", { name: stagingAppName });
+            if (await app.isHidden())
+                return;
+            await app.click();
+            await this.page
+                .getByRole("button", { name: GOOGLE_LOGIN_TEXTS.deleteConnections })
+                .click();
+            await this.page
+                .getByRole("button", { name: GOOGLE_LOGIN_TEXTS.confirm })
+                .click();
+            await expect(this.page.getByText(GOOGLE_LOGIN_TEXTS.noLongerConnected)).toBeVisible();
+        };
+        this.t = getI18nInstance().t;
+        this.appName = appName !== null && appName !== void 0 ? appName : "";
         this.totp = initializeTotp({
             issuer: "Google",
             secret: (_a = process.env.GOOGLE_2FA_SECRET_KEY) !== null && _a !== void 0 ? _a : "",
         });
-        this.t = getI18nInstance().t;
     }
 }
 
@@ -193579,36 +193598,46 @@ class ApiKeysPage {
 
 class AuditLogsPage {
     constructor(page, neetoPlaywrightUtilities) {
+        this.page = page;
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+        this.verifyAuditLogEntry = async ({ page = this.page, tableDetails, paneDetails, }) => {
+            await this.verifyAuditLog(tableDetails);
+            await this.verifyDataInPane({
+                ...paneDetails,
+                page,
+                action: tableDetails.action,
+            });
+        };
         this.verifyAuditLog = async ({ targetRow, action, date, adminName, }) => {
-            this.targetRow = targetRow;
-            await expect(targetRow.getByRole("cell", { name: action })).toBeVisible();
-            await expect(targetRow.getByRole("cell", {
-                name: this.t("neetoMolecules.common.success"),
-            })).toBeVisible();
-            await expect(targetRow.getByRole("cell", { name: adminName })).toBeVisible();
-            await expect(targetRow.getByRole("cell", { name: date })).toBeVisible();
+            if (targetRow) {
+                this.targetRow = targetRow;
+            }
+            await Promise.all([action, this.t("neetoMolecules.common.success"), adminName, date].map(name => expect(this.targetRow.getByRole("cell", { name })).toBeVisible()));
         };
         this.verifyDataInPane = async ({ page = this.page, action, values, firstName, lastName, roleName, }) => {
-            await this.targetRow.getByText(action).click();
-            await Promise.all(values.map(value => expect(page.getByTestId(COMMON_SELECTORS.paneBody).getByText(value)).toBeVisible()));
             const rowInPane = page
                 .getByTestId(COMMON_SELECTORS.paneBody)
                 .getByRole("row");
-            firstName &&
-                (await expect(rowInPane
-                    .filter({ hasText: this.t("neetoTeamMembers.labels.firstName") })
-                    .getByText(firstName)).toBeVisible());
-            lastName &&
-                (await expect(rowInPane
-                    .filter({ hasText: this.t("neetoTeamMembers.labels.lastName") })
-                    .getByText(lastName)).toBeVisible());
-            roleName &&
-                (await expect(rowInPane
-                    .filter({ hasText: AUDIT_LOGS_TEXTS.organizationRole })
-                    .getByText(roleName)).toBeVisible());
+            await this.targetRow.getByText(action).click();
+            await Promise.all([
+                ...values.map(value => expect(page.getByTestId(COMMON_SELECTORS.paneBody).getByText(value)).toBeVisible()),
+                firstName &&
+                    // eslint-disable-next-line playwright/missing-playwright-await
+                    expect(rowInPane
+                        .filter({ hasText: this.t("neetoTeamMembers.labels.firstName") })
+                        .getByText(firstName)).toBeVisible(),
+                lastName &&
+                    // eslint-disable-next-line playwright/missing-playwright-await
+                    expect(rowInPane
+                        .filter({ hasText: this.t("neetoTeamMembers.labels.lastName") })
+                        .getByText(lastName)).toBeVisible(),
+                roleName &&
+                    // eslint-disable-next-line playwright/missing-playwright-await
+                    expect(rowInPane
+                        .filter({ hasText: AUDIT_LOGS_TEXTS.organizationRole })
+                        .getByText(roleName)).toBeVisible(),
+            ]);
         };
-        this.page = page;
-        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
         this.t = getI18nInstance().t;
     }
 }