@bigbinary/neeto-playwright-commons 1.7.0 → 1.7.2

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;
@@ -19,10 +20,9 @@ interface ExecuteRecursivelyParams {
 }
 type ExecuteRecursively = (params: ExecuteRecursivelyParams) => Promise<void>;
 interface VerifySuccessToastParams {
-    message?: string;
+    message: string;
     closeAfterVerification: boolean;
 }
-type VerifySuccessToast = (params: VerifySuccessToastParams) => Promise<void>;
 type BasicTypesInterface = Record<string, number | string | boolean>;
 type HttpMethods = "get" | "patch" | "post" | "put" | "delete";
 interface ApiRequestProps {
@@ -47,7 +47,7 @@ declare class CustomCommands {
     interceptMultipleResponses: ({ responseUrl, times, baseUrl, customPageContext, timeout, }?: Partial<InterceptMultipleResponsesParams>) => Promise<Response[]>;
     private recursiveMethod;
     executeRecursively: ExecuteRecursively;
-    verifySuccessToast: VerifySuccessToast;
+    verifySuccessToast: ({ message, closeAfterVerification, }?: Partial<VerifySuccessToastParams>) => Promise<void>;
     reloadAndWait: (requestCount: number) => Promise<void>;
     apiRequest: ApiRequest;
     verifyFieldValue: VerifyFieldValue;
@@ -187,6 +187,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;
@@ -463,6 +471,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;
 }
@@ -475,4 +509,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, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, readFileSyncIfExists, skipTest, updateCredentials, writeDataToFile };

package/index.js

@@ -1,8 +1,8 @@
 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 { faker } from '@faker-js/faker';
-import { isNil, isNotNil, mergeDeepLeft, mergeAll, mergeLeft } from 'ramda';
 import MailosaurClient from 'mailosaur';
 import dayjs from 'dayjs';
 import require$$2 from 'os';
@@ -175,8 +175,8 @@ class CustomCommands {
             const startTime = Date.now();
             await this.recursiveMethod(callback, condition, timeout, startTime);
         };
-        this.verifySuccessToast = async ({ message = null, closeAfterVerification = true, }) => {
-            if (message) {
+        this.verifySuccessToast = async ({ message = "", closeAfterVerification = true, } = {}) => {
+            if (isEmpty$1(message)) {
                 await expect(this.page.getByTestId(COMMON_SELECTORS.toastMessage)).toContainText(message);
             }
             else {
@@ -7157,11 +7157,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",
@@ -7708,6 +7719,52 @@ const loginWithoutSSO = async ({ page, neetoPlaywrightUtilities, loginPath = "/"
 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 +8301,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, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, readFileSyncIfExists, skipTest, updateCredentials, writeDataToFile };
 //# sourceMappingURL=index.js.map