@bigbinary/neeto-playwright-commons 1.8.45 → 1.8.46

package/index.d.ts

@@ -356,14 +356,26 @@ declare class ZapierPage extends IntegrationBase {
     disconnectAndVerify: () => Promise<void>;
 }
 
-interface CreateOrganizationProps {
+interface BasicUserInfo {
+    firstName: string;
+    lastName: string;
     email: string;
+}
+interface CreateOrganizationProps extends BasicUserInfo {
     businessName: string;
     subdomainName: string;
-    firstName: string;
-    lastName: string;
     appName: string;
 }
+interface LoginAndOnboardParams extends BasicUserInfo {
+    handleOnboarding: () => Promise<void>;
+}
+interface Credentials extends BasicUserInfo {
+    otp?: number;
+    domain: string;
+    currentUserName: string;
+    businessName: string;
+    subdomainName: string;
+}
 declare class OrganizationPage {
     page: Page;
     neetoPlaywrightUtilities: CustomCommands;
@@ -372,6 +384,45 @@ declare class OrganizationPage {
     createOrganization: ({ email, businessName, subdomainName, firstName, lastName, appName, }: CreateOrganizationProps) => Promise<void>;
     setupOrganization: (product: string) => Promise<void>;
     updateSubdomainIfExists: (appName: string) => Promise<void>;
+    loginViaSSO: (email?: string) => Promise<void>;
+    setupProfile: ({ firstName, lastName, }?: {
+        firstName?: string | undefined;
+        lastName?: string | undefined;
+    }) => Promise<void>;
+    loginAndOnboard: ({ email, firstName, lastName, handleOnboarding, }: LoginAndOnboardParams) => Promise<void>;
+    signUp: ({ credentials, fetchOtpFromEmail, appName, }: {
+        credentials: Credentials;
+        fetchOtpFromEmail?: ((params: {
+            email: string;
+            timeout: number;
+        }) => Promise<string>) | undefined;
+        appName: string;
+    }) => Promise<{
+        STORAGE_STATE: {
+            cookies: {
+                name: string;
+                value: string;
+                domain: string;
+                path: string;
+                expires: number;
+                httpOnly: boolean;
+                secure: boolean;
+                sameSite: "Strict" | "Lax" | "None";
+            }[];
+            origins: {
+                origin: string;
+                localStorage: {
+                    name: string;
+                    value: string;
+                }[];
+            }[];
+        };
+        baseURL: string | undefined;
+    }>;
+    fillOrganizationDetails: ({ credentials, appName, }: {
+        credentials: Credentials;
+        appName: string;
+    }) => Promise<void>;
 }
 
 declare class SidebarSection {
@@ -413,6 +464,7 @@ declare const ROUTES: {
     neetoAuth: string;
     loginLink: string;
     profile: string;
+    admin: string;
     myProfile: string;
     authSettings: string;
     webhooks: string;

package/index.js

@@ -12522,6 +12522,7 @@ const ROUTES = {
     neetoAuth: NEETO_AUTH_BASE_URL(),
     loginLink: "/login",
     profile: "/profile",
+    admin: "/admin",
     myProfile: "/my/profile",
     authSettings: "/settings",
     webhooks: "/webhooks",
@@ -13446,6 +13447,18 @@ class ZapierPage extends IntegrationBase {
     }
 }
 
+const LOGIN_SELECTORS = {
+    appleAuthenticationButton: "apple-authentication-button",
+    emailTextField: "login-email-text-field",
+    googleAuthenticationButton: "google-authentication-button",
+    githubAuthenticationButton: "github-authentication-button",
+    loginViaEmailButton: "login-via-email-button",
+    passwordTextField: "login-password-text-field",
+    rememberMeCheckBox: "login-remember-me-check-box",
+    submitButton: "login-submit-button",
+    twitterAuthenticationButton: "twitter-authentication-button",
+};
+
 const SIGNUP_SELECTORS = {
     emailTextField: "signup-email-text-field",
     firstNameTextField: "signup-profile-first-name-text-field",
@@ -13462,6 +13475,29 @@ const SIGNUP_SELECTORS = {
     unregisterdEmailError: "unregisterd-email-error",
 };
 
+const loginWithoutSSO = async ({ page, neetoPlaywrightUtilities, loginPath = "/", }) => {
+    if (shouldSkipSetupAndTeardown())
+        return;
+    await page.goto(loginPath);
+    await page.getByTestId("login-email-text-field").fill(CREDENTIALS.email);
+    await page
+        .getByTestId("login-password-text-field")
+        .fill(CREDENTIALS.password);
+    const login = neetoPlaywrightUtilities.interceptMultipleResponses({
+        times: 1,
+    });
+    await page.getByTestId(LOGIN_SELECTORS.submitButton).click();
+    await login;
+    const userCredentials = readFileSyncIfExists();
+    await page.context().storageState({ path: STORAGE_STATE });
+    const mergedCredentials = mergeAll([readFileSyncIfExists(), userCredentials]);
+    writeDataToFile(JSON.stringify(mergedCredentials, null, 2));
+    updateCredentials({ key: "isLoggedIn", value: "true" });
+};
+const login = async ({ page, neetoPlaywrightUtilities, loginPath, }) => !IS_STAGING_ENV &&
+    (await loginWithoutSSO({ page, neetoPlaywrightUtilities, loginPath }));
+const generateRandomBypassEmail = () => `cpt${process.env.OTP_BYPASS_KEY}+${faker.number.int()}@bigbinary.com`;
+
 const extractSubdomainFromError = (errorString) => {
     const regex = /cpt[a-zA-Z0-9-]+/g;
     const matches = errorString.match(regex);
@@ -13494,47 +13530,18 @@ class OrganizationPage {
             await this.page.getByTestId(SIGNUP_SELECTORS.submitButton).click();
             await signup;
             await this.page.getByTestId(SIGNUP_SELECTORS.otpTextBox).fill(defaultOtp);
-            await this.page
-                .getByTestId(SIGNUP_SELECTORS.organizationNameTextField)
-                .fill(businessName);
-            const fetchSubdomainAvailability = this.neetoPlaywrightUtilities.interceptMultipleResponses({
-                responseUrl: ROUTES.subdomainAvailability,
-                timeout: 60 * 1000,
-                baseUrl: NEETO_AUTH_BASE_URL(),
-            });
-            await this.page
-                .getByTestId(SIGNUP_SELECTORS.subdomainNameTextField)
-                .fill(subdomainName);
-            await fetchSubdomainAvailability;
-            const subdomainError = this.page.getByTestId(SIGNUP_SELECTORS.subdomainError);
-            const subdomainErrorCount = await subdomainError.count();
-            if (subdomainErrorCount !== 0) {
-                await this.updateSubdomainIfExists(appNameInLowerCase);
-            }
-            const fetchProfile = this.neetoPlaywrightUtilities.interceptMultipleResponses({
-                times: 2,
-                timeout: 60 * 1000,
-                baseUrl: NEETO_AUTH_BASE_URL(),
-            });
-            await this.page
-                .getByTestId(SIGNUP_SELECTORS.organizationSubmitButton)
-                .click();
-            await fetchProfile;
-            await this.page.waitForURL(`**${ROUTES.profile}`, { timeout: 60 * 1000 });
-            await this.page
-                .getByTestId(SIGNUP_SELECTORS.firstNameTextField)
-                .fill(firstName);
-            await this.page
-                .getByTestId(SIGNUP_SELECTORS.lastNameTextField)
-                .fill(lastName);
-            await this.page.getByTestId(COMMON_SELECTORS.checkbox).click();
-            const submitProfile = this.neetoPlaywrightUtilities.interceptMultipleResponses({
-                responseUrl: ROUTES.signup,
-                timeout: 1000 * 60,
-                baseUrl: NEETO_AUTH_BASE_URL(),
+            await this.fillOrganizationDetails({
+                credentials: {
+                    firstName,
+                    lastName,
+                    email,
+                    currentUserName: email,
+                    businessName,
+                    subdomainName,
+                    domain: appNameInLowerCase,
+                },
+                appName: appNameInLowerCase,
             });
-            await this.page.getByTestId(SIGNUP_SELECTORS.profileSubmitButton).click();
-            await submitProfile;
             await this.page.waitForURL(new RegExp(getGlobalUserState().domain), {
                 waitUntil: "load",
             });
@@ -13603,6 +13610,106 @@ class OrganizationPage {
                 }
             }
         };
+        this.loginViaSSO = async (email = generateRandomBypassEmail()) => {
+            await this.page.getByTestId(LOGIN_SELECTORS.emailTextField).fill(email);
+            await expect(async () => {
+                await this.page.getByTestId(LOGIN_SELECTORS.submitButton).click();
+                await expect(this.page.getByTestId(SIGNUP_SELECTORS.unregisterdEmailError)).toBeHidden();
+            }).toPass({ timeout: 15000 });
+            await this.page
+                .getByTestId(SIGNUP_SELECTORS.otpTextBox)
+                .fill(faker.string.numeric(6));
+        };
+        this.setupProfile = async ({ firstName = faker.person.firstName(), lastName = faker.person.lastName(), } = {}) => {
+            await this.page
+                .getByTestId(SIGNUP_SELECTORS.firstNameTextField)
+                .fill(firstName);
+            await this.page
+                .getByTestId(SIGNUP_SELECTORS.lastNameTextField)
+                .fill(lastName);
+            await this.page.getByTestId(COMMON_SELECTORS.checkbox).click();
+            const submitProfile = this.neetoPlaywrightUtilities.interceptMultipleResponses({
+                customPageContext: this.page,
+                responseUrl: ROUTES.signup,
+                baseUrl: NEETO_AUTH_BASE_URL(),
+                timeout: 60000,
+            });
+            await this.page.getByTestId(SIGNUP_SELECTORS.profileSubmitButton).click();
+            await submitProfile;
+            await expect(this.page.getByTestId(COMMON_SELECTORS.pageLoader)).toBeHidden();
+        };
+        this.loginAndOnboard = async ({ email, firstName, lastName, handleOnboarding, }) => {
+            await this.page.goto(ROUTES.admin);
+            await this.loginViaSSO(email);
+            await this.setupProfile({ firstName, lastName });
+            await this.page.waitForURL(new RegExp(getGlobalUserState().domain), {
+                waitUntil: "load",
+            });
+            await handleOnboarding();
+        };
+        this.signUp = async ({ credentials, fetchOtpFromEmail, appName, }) => {
+            let otp = "123456";
+            await this.page.goto(`${ROUTES.neetoAuthSignup}?redirect_uri=${credentials.domain}`);
+            await this.page
+                .getByTestId(SIGNUP_SELECTORS.emailTextField)
+                .fill(credentials.email);
+            const signup = this.neetoPlaywrightUtilities.interceptMultipleResponses({
+                responseUrl: ROUTES.signup,
+                timeout: 60 * 1000,
+                baseUrl: NEETO_AUTH_BASE_URL(),
+            });
+            await this.page.getByTestId(SIGNUP_SELECTORS.submitButton).click();
+            await signup;
+            if (fetchOtpFromEmail !== undefined) {
+                otp = await fetchOtpFromEmail({
+                    email: credentials.email,
+                    timeout: 4 * 60 * 1000,
+                });
+            }
+            await this.page.getByTestId(SIGNUP_SELECTORS.otpTextBox).fill(otp);
+            await this.fillOrganizationDetails({
+                credentials,
+                appName,
+            });
+            await this.page.waitForURL(new RegExp(credentials.domain));
+            const STORAGE_STATE = await this.page.context().storageState();
+            return { STORAGE_STATE, baseURL: process.env.BASE_URL };
+        };
+        this.fillOrganizationDetails = async ({ credentials, appName, }) => {
+            await this.page
+                .getByTestId(SIGNUP_SELECTORS.organizationNameTextField)
+                .fill(credentials.businessName);
+            const fetchSubdomainAvailability = this.neetoPlaywrightUtilities.interceptMultipleResponses({
+                responseUrl: ROUTES.subdomainAvailability,
+                timeout: 60 * 1000,
+                baseUrl: NEETO_AUTH_BASE_URL(),
+            });
+            await this.page
+                .getByTestId(SIGNUP_SELECTORS.subdomainNameTextField)
+                .fill(credentials.subdomainName);
+            await fetchSubdomainAvailability;
+            const subdomainError = this.page.getByTestId(SIGNUP_SELECTORS.subdomainError);
+            const subdomainErrorCount = await subdomainError.count();
+            if (subdomainErrorCount !== 0) {
+                await this.updateSubdomainIfExists(appName);
+            }
+            const fetchProfile = this.neetoPlaywrightUtilities.interceptMultipleResponses({
+                times: 2,
+                timeout: 60 * 1000,
+                baseUrl: NEETO_AUTH_BASE_URL(),
+            });
+            await this.page
+                .getByTestId(SIGNUP_SELECTORS.organizationSubmitButton)
+                .click();
+            await fetchProfile;
+            await this.page.waitForURL(`**${ROUTES.profile}`, {
+                timeout: 60 * 1000,
+            });
+            await this.setupProfile({
+                firstName: credentials.firstName,
+                lastName: credentials.lastName,
+            });
+        };
         this.page = page;
         this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
     }
@@ -13686,18 +13793,6 @@ const NEETO_FILTERS_SELECTORS = {
     paneModalCrossIcon: "neeto-filters-close-button",
 };
 
-const LOGIN_SELECTORS = {
-    appleAuthenticationButton: "apple-authentication-button",
-    emailTextField: "login-email-text-field",
-    googleAuthenticationButton: "google-authentication-button",
-    githubAuthenticationButton: "github-authentication-button",
-    loginViaEmailButton: "login-via-email-button",
-    passwordTextField: "login-password-text-field",
-    rememberMeCheckBox: "login-remember-me-check-box",
-    submitButton: "login-submit-button",
-    twitterAuthenticationButton: "twitter-authentication-button",
-};
-
 const MEMBER_SELECTORS = {
     membersTab: "members-nav-tab",
     newButton: "ntm-add-member-button",
@@ -13801,29 +13896,6 @@ const initializeCredentials = (product) => {
     }
 };
 
-const loginWithoutSSO = async ({ page, neetoPlaywrightUtilities, loginPath = "/", }) => {
-    if (shouldSkipSetupAndTeardown())
-        return;
-    await page.goto(loginPath);
-    await page.getByTestId("login-email-text-field").fill(CREDENTIALS.email);
-    await page
-        .getByTestId("login-password-text-field")
-        .fill(CREDENTIALS.password);
-    const login = neetoPlaywrightUtilities.interceptMultipleResponses({
-        times: 1,
-    });
-    await page.getByTestId(LOGIN_SELECTORS.submitButton).click();
-    await login;
-    const userCredentials = readFileSyncIfExists();
-    await page.context().storageState({ path: STORAGE_STATE });
-    const mergedCredentials = mergeAll([readFileSyncIfExists(), userCredentials]);
-    writeDataToFile(JSON.stringify(mergedCredentials, null, 2));
-    updateCredentials({ key: "isLoggedIn", value: "true" });
-};
-const login = async ({ page, neetoPlaywrightUtilities, loginPath, }) => !IS_STAGING_ENV &&
-    (await loginWithoutSSO({ page, neetoPlaywrightUtilities, loginPath }));
-const generateRandomBypassEmail = () => `cpt${process.env.OTP_BYPASS_KEY}+${faker.number.int()}@bigbinary.com`;
-
 const addMemberViaRequest = ({ email, role = MEMBER_TEXTS.agent, appName, neetoPlaywrightUtilities, }) => neetoPlaywrightUtilities.apiRequest({
     method: "post",
     url: API_ROUTES.teamMembers.index,