@bigbinary/neeto-playwright-commons 1.11.13 → 1.11.15

package/index.d.ts

@@ -58,9 +58,10 @@ interface FieldValue {
 }
 type VerifyFieldValue = (values: FieldValue | FieldValue[]) => Promise<void> | Promise<void[]>;
 interface SelectOptionFromDropdownParams {
-  selectValueContainer: string;
-  selectMenu: string;
+  selectValueContainer?: string;
+  selectMenu?: string;
   value: string;
+  page?: Page;
   options?: Partial<{
     visibilityTimeout: number;
     textAssertionTimeout: number;
@@ -232,12 +233,14 @@ declare class CustomCommands {
    *
    * operation is completed. It takes the following parameters:
    *
-   * selectValueContainer: is the selector for the select input container.
+   * selectValueContainer (optional): is the selector for the select input container. Default is nui-select-value-container.
    *
-   * selectMenu: is the selector for the select input menu.
+   * selectMenu (optional): is the selector for the select input menu. Default is nui-select-menu.
    *
    * value: is the value to be selected.
    *
+   * page (optional): is the custom page context. Default is POM's page.
+   *
    * options: is an object with the following optional parameters:
    *
    * visiblityTimeout: is the time to wait for the select input to be visible. Default is 2000ms.
@@ -272,6 +275,7 @@ declare class CustomCommands {
     selectValueContainer,
     selectMenu,
     value,
+    page,
     options
   }: SelectOptionFromDropdownParams) => Promise<void>;
   /**
@@ -1031,6 +1035,16 @@ declare class IntegrationBase {
   */
   gotoIntegrationIndex: () => Promise<void>;
 }
+type StagingConsentFlowParams = {
+  abortFlow?: boolean;
+  allowPermissions: boolean;
+};
+type GooglePageParams = {
+  page: Page;
+  neetoPlaywrightUtilities: CustomCommands;
+  integration: string;
+  integrationRouteIndex?: string;
+};
 declare class GooglePage extends IntegrationBase {
   totp: TOTP;
   t: TFunction;
@@ -1039,32 +1053,8 @@ declare class GooglePage extends IntegrationBase {
     neetoPlaywrightUtilities,
     integration,
     integrationRouteIndex
-  }: {
-    page: Page;
-    neetoPlaywrightUtilities: CustomCommands;
-    integration: string;
-    integrationRouteIndex: string;
-  });
-  /**
-   *
-   * Connects to slack integration and verifies the connection. It takes the following parameters:
-   *
-   * redirectUrl: URL to redirect after connecting.
-   *
-   * customSteps (optional): Custom steps to perform after connection.
-   *
-   * channelToConfigure (optional): Channel to configure.
-   *
-   * @example 
-   *
-   * await slackPage.connectAndVerifyIntegration(
-   *   /example\.com/,
-   *   customSteps,
-   *   "general"
-   * );
-   * @endexample
-  */
-  connectAndVerifyIntegration: () => Promise<void>;
+  }: GooglePageParams);
+  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.
@@ -1074,7 +1064,7 @@ declare class GooglePage extends IntegrationBase {
    * await googlePage.selectGoogleAccount();
    * @endexample
   */
-  selectGoogleAccount: () => 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.
@@ -1106,7 +1096,11 @@ declare class GooglePage extends IntegrationBase {
    * @endexample
   */
   disconnectAndVerifyIntegration: () => Promise<void>;
-  stagingConsentFlow: () => Promise<void>;
+  stagingConsentFlow: ({
+    abortFlow,
+    allowPermissions
+  }?: Partial<StagingConsentFlowParams>) => Promise<void>;
+  private handleNotVerifiedPage;
 }
 type AsyncNoArgsFunction = () => Promise<void>;
 type RedirectUrl = string | RegExp | ((url: URL) => boolean);
@@ -4441,11 +4435,60 @@ declare const ZAPIER_LIMIT_EXHAUSTED_MESSAGE = "Zapier free task limit is exhaus
 declare const EMOJI_LABEL = "thumbs up";
 declare const SELECT_COUNTRY = "Select country";
 declare const GOOGLE_CALENDAR_DATE_FORMAT = "YYYY/M/D";
+/**
+ *
+ * googleAccount: Text for google account.
+ *
+ * connectYourGoogleAccount: Text for connecting to your google account.
+ *
+ * signInWithGoogle: Text for signing in with google.
+ *
+ * signInHeading: Text heading for signing in.
+ *
+ * continue: Text for continue.
+ *
+ * selectAll: Text for selecting all permissions.
+ *
+ * appNotVerified: Text indicating app not verified.
+ *
+ * next: Text for next.
+ *
+ * showPassword: Text for showing password.
+ *
+ * emailOrPhone: Text indicating email or phone.
+ *
+ * enterYourPassword: Text for entering your password.
+ *
+ * twoStepVerification: Text for two-step verification.
+ *
+ * enterCode: "Text for entering code.
+ *
+ * allow: Text for allow.
+ *
+ * signOut: Text for signing out.
+ *
+ * wrongCode: "Text for wrong code.
+ *
+ * verificationCode: Text for verification code.
+ *
+ * confirm: Text for confirm.
+ *
+ * cancel: Text for cancel.
+ *
+ * deleteConnections: Text for deleting connections.
+ *
+ * noLongerConnected: Text indicating no longer connected.
+ *
+ * backToSafety: Text label for back to safety button.
+ *
+ * neetoAutomation: Text indicating neeto automation mail id.
+ *
+*/
 declare const GOOGLE_LOGIN_TEXTS: {
   googleAccount: string;
   connectYourGoogleAccount: string;
   signInWithGoogle: string;
-  signInHeading: string;
+  signInHeading: (appName: string) => string;
   continue: string;
   selectAll: string;
   appNotVerified: string;
@@ -4459,6 +4502,12 @@ declare const GOOGLE_LOGIN_TEXTS: {
   signOut: string;
   wrongCode: string;
   verificationCode: string;
+  confirm: string;
+  cancel: string;
+  deleteConnections: string;
+  noLongerConnected: string;
+  backToSafety: string;
+  neetoAutomation: string;
 };
 declare const DESCRIPTION_EDITOR_TEXTS: {
   fontSize: string;

package/index.js

@@ -3552,23 +3552,23 @@ class CustomCommands {
                 })}`;
             return await this.request[method](formattedUrl, requestOptions);
         };
-        this.selectOptionFromDropdown = async ({ selectValueContainer, selectMenu, value, options = {}, }) => {
+        this.selectOptionFromDropdown = async ({ selectValueContainer = COMMON_SELECTORS.selectValueContainer, selectMenu = COMMON_SELECTORS.dropdownMenu, value, page = this.page, options = {}, }) => {
             Object.assign({
                 visibilityTimeout: 2000,
                 textAssertionTimeout: 1000,
                 retryTimeout: 20000,
             }, options);
             await expect(async () => {
-                await this.page.getByTestId(selectValueContainer).click();
-                await expect(this.page.getByTestId(selectMenu)).toBeVisible({
+                await page.getByTestId(selectValueContainer).click();
+                await expect(page.getByTestId(selectMenu)).toBeVisible({
                     timeout: options.visibilityTimeout,
                 });
-                await this.page.keyboard.type(value);
-                await this.page
+                await page.keyboard.type(value);
+                await page
                     .getByTestId(selectMenu)
                     .getByText(value, { exact: true })
                     .click();
-                await expect(this.page.getByTestId(selectValueContainer)).toContainText(value, { timeout: options.textAssertionTimeout });
+                await expect(page.getByTestId(selectValueContainer)).toContainText(value, { timeout: options.textAssertionTimeout });
             }).toPass({ timeout: options.retryTimeout });
         };
         this.verifyFieldValue = values => {
@@ -13084,7 +13084,7 @@ const GOOGLE_LOGIN_TEXTS = {
     googleAccount: "Google Account:",
     connectYourGoogleAccount: "Connect your Google account",
     signInWithGoogle: "Sign in with Google",
-    signInHeading: "Sign in to neetocal.net",
+    signInHeading: (appName) => `Sign in to ${appName}.net`,
     continue: "Continue",
     selectAll: "Select All",
     appNotVerified: "Google hasn’t verified this app",
@@ -13098,6 +13098,12 @@ const GOOGLE_LOGIN_TEXTS = {
     signOut: "Sign out",
     wrongCode: "Wrong code. Try again",
     verificationCode: "verification code",
+    confirm: "Confirm",
+    cancel: "Cancel",
+    deleteConnections: "Delete all connections you",
+    noLongerConnected: "You’re no longer connected to",
+    backToSafety: "Back to safety",
+    neetoAutomation: "neeto.automation",
 };
 
 const HELP_CENTER_SELECTORS = {
@@ -13373,14 +13379,6 @@ class HelpAndProfilePage {
     }
 }
 
-const INTEGRATION_SELECTORS = {
-    integrationCard: (integration) => `${integration}-integration-card`,
-    connectButton: "connect-button",
-    integrationStatusTag: "integration-status-tag",
-    disconnectButton: "disconnect-button",
-    manageButton: "manage-button",
-};
-
 const GOOGLE_LOGIN_SELECTORS = {
     totpNext: "#totpNext",
     form: "form",
@@ -15134,6 +15132,14 @@ const initializeTotp = ({ issuer, secret, }) => {
     });
 };
 
+const INTEGRATION_SELECTORS = {
+    integrationCard: (integration) => `${integration}-integration-card`,
+    connectButton: "connect-button",
+    integrationStatusTag: "integration-status-tag",
+    disconnectButton: "disconnect-button",
+    manageButton: "manage-button",
+};
+
 class IntegrationBase {
     constructor({ page, neetoPlaywrightUtilities, integration, connectHeader, connectedHeader, pageloaderTimeout, integrationRouteIndex, integrationRouteResponsesParams, }) {
         this.disconnect = async (interceptMultipleResponsesParams = {}) => {
@@ -15209,18 +15215,9 @@ class GooglePage extends IntegrationBase {
             integration,
             integrationRouteIndex,
         });
-        this.connectAndVerifyIntegration = async () => {
-            await this.connect();
-            await expect(this.page.getByRole("heading", {
-                name: GOOGLE_LOGIN_TEXTS.connectYourGoogleAccount,
-            })).toBeVisible({ timeout: 15000 });
-            await this.page
-                .getByRole("link", {
-                name: GOOGLE_LOGIN_TEXTS.signInWithGoogle,
-            })
-                .click();
+        this.connectGoogleAccount = async (appName) => {
             await this.page.waitForURL(new RegExp(THIRD_PARTY_ROUTES.google.chooseAccount));
-            await this.selectGoogleAccount();
+            await this.selectGoogleAccount(appName);
             if (process.env.TEST_ENV === ENVIRONMENT.staging) {
                 await this.stagingConsentFlow();
             }
@@ -15230,22 +15227,26 @@ class GooglePage extends IntegrationBase {
                     .getByRole("button", { name: GOOGLE_LOGIN_TEXTS.allow })
                     .click();
             }
-            await Promise.all([
-                expect(this.page.getByRole("heading", { name: this.connectedHeader })).toBeVisible({ timeout: 20000 }),
-                expect(this.page.getByTestId(INTEGRATION_SELECTORS.manageButton)).toBeVisible({ timeout: 20000 }),
-            ]);
         };
-        this.selectGoogleAccount = async () => {
-            await this.page.getByRole("link", { name: "neeto.automation" }).click();
-            try {
-                const verificationCode = this.page
-                    .locator(GOOGLE_LOGIN_SELECTORS.form)
-                    .getByText(GOOGLE_LOGIN_TEXTS.verificationCode);
-                await expect(verificationCode).toBeVisible({ timeout: 10000 });
+        this.selectGoogleAccount = async (appName) => {
+            const neetoAutomationLocator = this.page.getByRole("link", {
+                name: GOOGLE_LOGIN_TEXTS.neetoAutomation,
+            });
+            await neetoAutomationLocator.click();
+            await expect(neetoAutomationLocator).toBeHidden({ timeout: 10000 });
+            const verificationCode = this.page
+                .locator("form")
+                .getByText(GOOGLE_LOGIN_TEXTS.verificationCode);
+            if (this.page.url().includes(THIRD_PARTY_ROUTES.google.totpChallenge)) {
                 await this.enterTotpCode(verificationCode);
-                // eslint-disable-next-line no-empty
             }
-            catch (error) { }
+            await this.handleNotVerifiedPage();
+            await expect(this.page.getByRole("heading", {
+                name: GOOGLE_LOGIN_TEXTS.signInHeading(appName),
+            })).toBeVisible();
+            await this.page
+                .getByRole("button", { name: GOOGLE_LOGIN_TEXTS.continue })
+                .click();
         };
         this.loginToGoogle = async () => {
             await this.page.goto(THIRD_PARTY_ROUTES.google.signin);
@@ -15268,17 +15269,20 @@ class GooglePage extends IntegrationBase {
             await this.page
                 .getByRole("button", { name: GOOGLE_LOGIN_TEXTS.next })
                 .click();
-            await this.page.waitForURL(new RegExp(THIRD_PARTY_ROUTES.google.challengeSelection));
-            await this.page
-                .locator(GOOGLE_LOGIN_SELECTORS.totpChallengeSelector)
-                .click();
+            if (this.page.url().includes(THIRD_PARTY_ROUTES.google.challengeSelection)) {
+                await this.page
+                    .locator(GOOGLE_LOGIN_SELECTORS.totpChallengeSelector)
+                    .click();
+            }
             await this.page.waitForURL(new RegExp(THIRD_PARTY_ROUTES.google.totpChallenge));
-            const twoStepVerification = this.page
-                .locator(GOOGLE_LOGIN_SELECTORS.form)
-                .getByText(GOOGLE_LOGIN_TEXTS.twoStepVerification);
+            const twoStepVerification = this.page.locator("form").getByRole("heading", {
+                name: GOOGLE_LOGIN_TEXTS.twoStepVerification,
+                level: 2,
+                exact: true,
+            });
             await expect(twoStepVerification).toBeVisible();
             await this.enterTotpCode(twoStepVerification);
-            await this.page.waitForURL(new RegExp(THIRD_PARTY_ROUTES.google.myAccount));
+            await this.page.waitForURL(new RegExp(THIRD_PARTY_ROUTES.google.myAccount), { waitUntil: "load" });
         };
         this.enterTotpCode = async (locator) => {
             await expect(async () => {
@@ -15286,8 +15290,8 @@ class GooglePage extends IntegrationBase {
                 await this.page.getByLabel(GOOGLE_LOGIN_TEXTS.enterCode).fill(totpToken);
                 expect(this.totp.validate({ token: totpToken })).not.toBeNull();
                 await this.page.locator(GOOGLE_LOGIN_SELECTORS.totpNext).click();
-                await expect(this.page.getByText(GOOGLE_LOGIN_TEXTS.wrongCode)).toBeHidden();
-                await expect(locator).toBeHidden({ timeout: 20000 });
+                await expect(this.page.getByText(GOOGLE_LOGIN_TEXTS.wrongCode)).toBeHidden({ timeout: 15000 });
+                await expect(locator).toBeHidden({ timeout: 10000 });
             }).toPass({ timeout: 50000 });
         };
         this.logoutFromGoogle = async () => {
@@ -15302,28 +15306,39 @@ class GooglePage extends IntegrationBase {
             await this.disconnect();
             await this.verifyIntegrationStatus("disconnected");
         };
-        this.stagingConsentFlow = async () => {
-            await this.page.waitForURL(new RegExp(THIRD_PARTY_ROUTES.google.warningScreen));
-            await expect(this.page.getByRole("heading", {
-                name: GOOGLE_LOGIN_TEXTS.appNotVerified,
-            })).toBeVisible();
-            await this.page
-                .getByRole("button", { name: GOOGLE_LOGIN_TEXTS.continue })
-                .click();
-            await expect(this.page.getByRole("heading", {
-                name: GOOGLE_LOGIN_TEXTS.signInHeading,
-            })).toBeVisible();
-            await this.page
-                .getByRole("button", { name: GOOGLE_LOGIN_TEXTS.continue })
-                .click();
+        this.stagingConsentFlow = async ({ abortFlow = false, allowPermissions = true, } = {}) => {
+            await this.handleNotVerifiedPage();
+            if (this.page.url().includes(THIRD_PARTY_ROUTES.google.additionalInfoScreen)) {
+                await this.page
+                    .getByRole("button", { name: GOOGLE_LOGIN_TEXTS.continue })
+                    .click({ timeout: 20000 });
+            }
             await this.page.waitForURL(new RegExp(THIRD_PARTY_ROUTES.google.consentSummary));
+            if (abortFlow) {
+                await this.page
+                    .getByRole("button", { name: GOOGLE_LOGIN_TEXTS.cancel })
+                    .click({ timeout: 20000 });
+                return;
+            }
             const selectAllPermissions = this.page.getByLabel(GOOGLE_LOGIN_TEXTS.selectAll);
-            if (await selectAllPermissions.isVisible()) {
+            if (allowPermissions && (await selectAllPermissions.isVisible())) {
                 await selectAllPermissions.click();
             }
             await this.page
                 .getByRole("button", { name: GOOGLE_LOGIN_TEXTS.continue })
-                .click({ timeout: 15000 });
+                .click({ timeout: 20000 });
+        };
+        this.handleNotVerifiedPage = async () => {
+            const continueUnsafeButton = this.page.getByRole("button", {
+                name: GOOGLE_LOGIN_TEXTS.continue,
+            });
+            const backToSafety = this.page.getByRole("button", {
+                name: GOOGLE_LOGIN_TEXTS.backToSafety,
+            });
+            if (this.page.url().includes(THIRD_PARTY_ROUTES.google.warningScreen)) {
+                await continueUnsafeButton.click();
+                await expect(backToSafety).toBeHidden({ timeout: 10000 });
+            }
         };
         this.totp = initializeTotp({
             issuer: "Google",