@bigbinary/neeto-playwright-commons 1.7.1 → 1.8.0

package/index.d.ts

@@ -3,6 +3,7 @@ import { Page, APIRequestContext, Response, APIResponse, Fixtures, PlaywrightWor
 import MailosaurClient from 'mailosaur';
 import { I18nPlaywrightFixture } from 'playwright-i18next-fixture';
 import { TFunction } from 'i18next';
+import * as playwright_core from 'playwright-core';
 
 interface InterceptMultipleResponsesParams {
     responseUrl: string;
@@ -139,6 +140,7 @@ declare class OrganizationPage {
     page: Page;
     neetoPlaywrightUtilities: CustomCommands;
     constructor(page: Page, neetoPlaywrightUtilities: CustomCommands);
+    baseUrlGenerator: (appName: string) => string;
     createOrganization: ({ email, businessName, subdomainName, firstName, lastName, appName, }: CreateOrganizationProps) => Promise<void>;
     setupOrganization: (product: string) => Promise<void>;
     updateSubdomainIfExists: (appName: string) => Promise<void>;
@@ -186,6 +188,14 @@ declare const ROUTES: {
         show: (id: string) => string;
     };
 };
+declare const API_ROUTES: {
+    teamMembers: {
+        all: string;
+        bulkUpdate: string;
+        index: string;
+        show: (id: string) => string;
+    };
+};
 
 declare const COMMON_SELECTORS: {
     spinner: string;
@@ -441,8 +451,10 @@ type Hyphenize = (input: number | string) => string;
 type JoinHyphenCase = (args: string) => string;
 declare const joinString: JoinString;
 declare const readFileSyncIfExists: ReadFileSyncIfExists;
+declare const getGlobalUserState: () => Record<string, string>;
 declare const writeDataToFile: WriteDataToFile;
 declare const updateCredentials: UpdateCredentials;
+declare const removeCredentialFile: ClearCredentials;
 declare const clearCredentials: ClearCredentials;
 declare const hyphenize: Hyphenize;
 declare const joinHyphenCase: JoinHyphenCase;
@@ -451,6 +463,7 @@ declare const skipTest: {
     forReviewEnv: () => void;
     forAllExceptStagingEnv: () => void;
 };
+declare const shouldSkipSetupAndTeardown: () => boolean | "";
 
 interface LoginProps {
     page: Page;
@@ -462,6 +475,32 @@ declare const login: ({ page, neetoPlaywrightUtilities, loginPath, }: LoginProps
 
 declare const extractSubdomainFromError: (errorString: string) => string;
 
+interface AddMemberProps {
+    email: string;
+    role?: string;
+    appName: string;
+    requestCount?: number;
+    neetoPlaywrightUtilities: CustomCommands;
+}
+interface EditMemberProps {
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    newRole?: string;
+    requestCount?: number;
+    neetoPlaywrightUtilities: CustomCommands;
+}
+interface DeactiveMemberProps {
+    email: string;
+    neetoPlaywrightUtilities: CustomCommands;
+    requestCount?: number;
+}
+declare const memberUtils: {
+    addMemberViaRequest: ({ email, role, appName, neetoPlaywrightUtilities, }: AddMemberProps) => Promise<playwright_core.APIResponse | undefined>;
+    editMemberViaRequest: ({ email, firstName, lastName, newRole, neetoPlaywrightUtilities, }: EditMemberProps) => Promise<void>;
+    deactivateMemberViaRequest: ({ email, neetoPlaywrightUtilities, }: DeactiveMemberProps) => Promise<playwright_core.APIResponse | undefined>;
+};
+
 interface CurrentsOverrides {
     projectId: string;
 }
@@ -474,4 +513,4 @@ interface Overrides {
 }
 declare const definePlaywrightConfig: (overrides: Overrides) => _playwright_test.PlaywrightTestConfig<{}, {}>;
 
-export { BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, IS_STAGING_ENV, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, TAGS_SELECTORS, USER_AGENTS, clearCredentials, commands, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, readFileSyncIfExists, skipTest, updateCredentials, writeDataToFile };
+export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, IS_STAGING_ENV, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, TAGS_SELECTORS, USER_AGENTS, clearCredentials, commands, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, getGlobalUserState, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, updateCredentials, writeDataToFile };

package/index.js

@@ -1,7 +1,7 @@
 import test, { expect, test as test$1, defineConfig, devices } from '@playwright/test';
 import * as require$$0 from 'fs';
 import require$$0__default from 'fs';
-import { isEmpty as isEmpty$1, isNil, isNotNil, mergeDeepLeft, mergeAll, mergeLeft } from 'ramda';
+import { isEmpty as isEmpty$1, isNil, isNotNil, mergeDeepLeft, mergeAll } from 'ramda';
 import { faker } from '@faker-js/faker';
 import MailosaurClient from 'mailosaur';
 import dayjs from 'dayjs';
@@ -44,6 +44,7 @@ const readFileSyncIfExists = (path = STORAGE_STATE) => {
         return {};
     }
 };
+const getGlobalUserState = () => { var _a; return (_a = readFileSyncIfExists()) === null || _a === void 0 ? void 0 : _a.user; };
 const writeDataToFile = data => {
     try {
         require$$0.writeFileSync(STORAGE_STATE, data, "utf8");
@@ -58,13 +59,18 @@ const updateCredentials = ({ key, value }) => {
     data["user"][key] = value;
     return writeDataToFile(JSON.stringify(data));
 };
-const clearCredentials = () => {
+const removeCredentialFile = () => {
     require$$0.unlink(STORAGE_STATE, error => {
         if (!error)
             return;
         console.log(error); // eslint-disable-line
     });
 };
+const clearCredentials = () => {
+    if (shouldSkipSetupAndTeardown())
+        return;
+    removeCredentialFile();
+};
 const hyphenize = input => {
     const fallbackString = "";
     if (typeof input === "number")
@@ -84,6 +90,7 @@ const skipTest = {
     forReviewEnv: () => test.skip(process.env.TEST_ENV === ENVIRONMENT.review),
     forAllExceptStagingEnv: () => test.skip(process.env.TEST_ENV !== ENVIRONMENT.staging),
 };
+const shouldSkipSetupAndTeardown = () => { var _a; return ((_a = getGlobalUserState()) === null || _a === void 0 ? void 0 : _a.isLoggedIn) && process.env.SKIP_SETUP === "true"; };
 
 const COMMON_SELECTORS = {
     spinner: ".neeto-ui-spinner",
@@ -7157,11 +7164,22 @@ const ROUTES = {
         show: (id) => `/team_members/teams/${id}`,
     },
 };
+const API_ROUTES = {
+    teamMembers: {
+        all: "/team_members*/**",
+        bulkUpdate: "/team_members/teams/bulk_update",
+        index: "/team_members/teams",
+        show: (id) => `/team_members/teams/${id}`,
+    },
+};
 
 const CHAT_WIDGET_TEXTS = {
     newConversation: "New Conversation",
     welcomeChatBubble: "Hi! I'm here to assist you with any questions you may have. What can I do for you?",
 };
+const MEMBER_TEXTS = {
+    agent: "Agent",
+};
 
 const HELP_CENTER_SELECTORS = {
     helpButton: "help-button",
@@ -7396,6 +7414,8 @@ class HelpAndProfilePage {
             }));
         };
         this.verifyLogout = async () => {
+            if (shouldSkipSetupAndTeardown())
+                return;
             await test$1.step("Step 1: Open Profile popup and verify", this.openProfilePopup);
             await test$1.step("Step 2: Click logout and verify", async () => {
                 await this.page
@@ -7441,9 +7461,15 @@ const extractSubdomainFromError = (errorString) => {
 
 class OrganizationPage {
     constructor(page, neetoPlaywrightUtilities) {
+        this.baseUrlGenerator = (appName) => {
+            const { subdomainName } = getGlobalUserState();
+            return `https://${subdomainName}.${appName}.net`;
+        };
         this.createOrganization = async ({ email, businessName, subdomainName, firstName, lastName, appName, }) => {
             if (!IS_STAGING_ENV)
                 return;
+            if (shouldSkipSetupAndTeardown())
+                return;
             const defaultOtp = "123456";
             const appNameInLowerCase = appName.toLowerCase();
             const isNeetoAuth = appNameInLowerCase === "neetoauth";
@@ -7496,6 +7522,8 @@ class OrganizationPage {
         this.setupOrganization = async (product) => {
             if (!IS_STAGING_ENV)
                 return;
+            if (shouldSkipSetupAndTeardown())
+                return;
             const { user } = readFileSyncIfExists();
             await this.createOrganization({
                 businessName: user.businessName,
@@ -7513,6 +7541,11 @@ class OrganizationPage {
                 userCredentials,
             ]);
             writeDataToFile(JSON.stringify(mergedCredentials, null, 2));
+            updateCredentials({ key: "isLoggedIn", value: "true" });
+            updateCredentials({
+                key: "baseUrl",
+                value: this.baseUrlGenerator(`neeto${product}`),
+            });
         };
         this.updateSubdomainIfExists = async (appName) => {
             const subdomainError = this.page.getByTestId(SIGNUP_SELECTORS.subdomainError);
@@ -7534,8 +7567,7 @@ class OrganizationPage {
                         key: "businessName",
                         value: newOrganizationName,
                     });
-                    const newBaseUrl = `https://${newOrganizationName}.${appName}.net`;
-                    process.env.BASE_URL = newBaseUrl;
+                    process.env.BASE_URL = this.baseUrlGenerator(appName);
                     await this.page
                         .getByTestId(SIGNUP_SELECTORS.organizationNameTextField)
                         .fill(newOrganizationName);
@@ -7679,17 +7711,35 @@ const MERGE_TAGS_SELECTORS = {
 };
 
 const initializeCredentials = (product) => {
-    const { user } = readFileSyncIfExists();
+    var _a;
+    if (process.env.SKIP_SETUP === "true" && getGlobalUserState()) {
+        const { email } = getGlobalUserState();
+        if (IS_STAGING_ENV) {
+            email.endsWith("example.com") && removeCredentialFile();
+        }
+        else {
+            email.endsWith("bigbinary.com") && removeCredentialFile();
+        }
+        readFileSyncIfExists();
+    }
+    const skipSetup = shouldSkipSetupAndTeardown();
+    if (skipSetup) {
+        if (IS_STAGING_ENV) {
+            process.env.BASE_URL = (_a = getGlobalUserState()) === null || _a === void 0 ? void 0 : _a.baseUrl;
+        }
+        return;
+    }
     const stagingData = generateStagingData(product);
-    const newUserState = mergeLeft(user, stagingData);
-    writeDataToFile(JSON.stringify({ user: newUserState }, null, 2));
+    writeDataToFile(JSON.stringify({ user: stagingData }, null, 2));
     if (IS_STAGING_ENV) {
-        const baseUrl = `https://${newUserState.subdomainName}.${stagingData.domain}`;
+        const baseUrl = `https://${stagingData.subdomainName}.${stagingData.domain}`;
         process.env.BASE_URL = baseUrl;
     }
 };
 
 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
@@ -7704,10 +7754,57 @@ const loginWithoutSSO = async ({ page, neetoPlaywrightUtilities, loginPath = "/"
     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 addMemberViaRequest = ({ email, role = MEMBER_TEXTS.agent, appName, neetoPlaywrightUtilities, }) => neetoPlaywrightUtilities.apiRequest({
+    method: "post",
+    url: API_ROUTES.teamMembers.index,
+    body: {
+        user: {
+            emails: [email],
+            organization_role: role,
+            app_roles: [{ app_name: appName, active_role: role, is_enabled: true }],
+        },
+    },
+});
+const editMemberViaRequest = async ({ email, firstName, lastName, newRole, neetoPlaywrightUtilities, }) => {
+    const response = await neetoPlaywrightUtilities.apiRequest({
+        method: "get",
+        url: API_ROUTES.teamMembers.index,
+        params: { search: email },
+    });
+    if (response) {
+        const responseBodyBuffer = await response.body();
+        const responseBody = JSON.parse(responseBodyBuffer.toString());
+        const memberDetails = responseBody === null || responseBody === void 0 ? void 0 : responseBody.members[0];
+        await neetoPlaywrightUtilities.apiRequest({
+            method: "put",
+            url: API_ROUTES.teamMembers.show(memberDetails.id),
+            body: {
+                team: {
+                    active: true,
+                    first_name: firstName,
+                    last_name: lastName,
+                    organization_role: newRole,
+                },
+            },
+        });
+    }
+};
+const deactivateMemberViaRequest = ({ email, neetoPlaywrightUtilities, }) => neetoPlaywrightUtilities.apiRequest({
+    method: "patch",
+    url: API_ROUTES.teamMembers.bulkUpdate,
+    body: { users: { active: false, emails: [email] } },
+});
+const memberUtils = {
+    addMemberViaRequest,
+    editMemberViaRequest,
+    deactivateMemberViaRequest,
+};
+
 var main$2 = {exports: {}};
 
 var name = "dotenv";
@@ -8244,5 +8341,5 @@ const definePlaywrightConfig = (overrides) => {
     });
 };
 
-export { BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, IS_STAGING_ENV, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, TAGS_SELECTORS, USER_AGENTS, clearCredentials, commands, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, readFileSyncIfExists, skipTest, updateCredentials, writeDataToFile };
+export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, IS_STAGING_ENV, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, TAGS_SELECTORS, USER_AGENTS, clearCredentials, commands, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, getGlobalUserState, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, updateCredentials, writeDataToFile };
 //# sourceMappingURL=index.js.map