@bigbinary/neeto-playwright-commons 1.9.7 → 1.9.8

package/index.d.ts

@@ -4,9 +4,9 @@ import * as mailosaur_lib_models from 'mailosaur/lib/models';
 import MailosaurClient from 'mailosaur';
 import { I18nPlaywrightFixture } from 'playwright-i18next-fixture';
 import { TFunction } from 'i18next';
+import * as playwright_core from 'playwright-core';
 import { Protocol } from 'playwright-core/types/protocol';
 import * as ts_toolbelt_out_Function_Curry from 'ts-toolbelt/out/Function/Curry';
-import * as playwright_core from 'playwright-core';
 import { Secret, TOTP } from 'otpauth';
 interface InterceptMultipleResponsesParams {
   responseUrl: string;
@@ -892,6 +892,324 @@ declare class ImageUploader {
     height
   }?: Partial<SelectImage>) => Promise<void>;
 }
+type sublink = "active" | "deactivated" | "all";
+type emailCondition = "Contains" | "Does not contain" | "Is" | "Is not" | "Starts with" | "Does not start with" | "Ends with" | "Does not end with";
+interface EditMemberProps$1 {
+  email: string;
+  firstName: string;
+  lastName: string;
+  role: string;
+}
+declare class TeamMembers {
+  page: Page;
+  neetoPlaywrightUtilities: CustomCommands;
+  t: TFunction;
+  constructor({
+    page,
+    neetoPlaywrightUtilities
+  }: {
+    page: Page;
+    neetoPlaywrightUtilities: CustomCommands;
+  });
+  /**
+   *
+   * Used to navigate to the specified sublink in the team members page.
+   *
+   * sublink (optional): The sublink to navigate to. Default is all.
+   *
+   * @example 
+   *
+   * await teamMembers.navigateToTeamMembersSublink("all");
+   * @endexample
+  */
+  navigateToTeamMembersSublink: (sublink?: sublink) => Promise<void>;
+  /**
+   *
+   * Used to add a member using the add button in the header. It takes the following parameters:
+   *
+   * emails (optional): The emails of the members to be added. Default is an example email.
+   *
+   * role (optional): The role of the new members. Default is standard.
+   *
+   * @example 
+   *
+   * await teamMembers.addMemberViaUI({
+   *     emails: ["sam@example.com", "tom@example.com"],
+   *     role: "admin",
+   * });
+   * @endexample
+  */
+  addMemberViaUI: ({
+    emails,
+    role
+  }?: {
+    emails?: string[] | undefined;
+    role?: string | undefined;
+  }) => Promise<void>;
+  /**
+   *
+   * Used to search and verify the member by providing email as the search term. It takes the following parameters:
+   *
+   * email (required): The email of the member to be searched.
+   *
+   * interceptOptions (optional): The options to be passed to the waitForMultipleResponse command.
+   *
+   * @example 
+   *
+   * await teamMembers.searchAndVerifyMemberByEmail({
+   *     email: "sam@example.com",
+   *     interceptOptions: { timeout: 10000, requestCount: 1 },
+   * });
+   * @endexample
+  */
+  searchAndVerifyMemberByEmail: ({
+    email,
+    interceptOptions
+  }: {
+    email: string;
+    interceptOptions?: Partial<InterceptMultipleResponsesParams> | undefined;
+  }) => Promise<void>;
+  /**
+   *
+   * Used to edit a member using the edit button in row dropdown. A member has to be searched before editing. It takes the following parameters:
+   *
+   * email (optional): The new email of the member.
+   *
+   * role (optional): The new role of the member. Default is standard.
+   *
+   * firstName (optional): The new first name of the member.
+   *
+   * lastName (optional): The new last name of the member.
+   *
+   * @example 
+   *
+   * await teamMembers.searchAndVerifyMemberByEmail({
+   *     email: "sam@example.com",
+   * });
+   * await teamMembers.editMemberViaUI({
+   *     email: "tom@example.com",
+   *     role: "admin",
+   *     firstName: "Tom",
+   *     lastName: "Hanks",
+   * });
+   * @endexample
+   * @example 
+   *
+   * await teamMembers.searchAndVerifyMemberByEmail({
+   *     email: "sam@example.com",
+   * });
+   * await teamMembers.editMemberViaUI();
+   * 
+   * // This will change the role of the member with email "sam@example.com" to the `standard` role.
+   * @endexample
+  */
+  editMemberViaUI: ({
+    email,
+    firstName,
+    lastName,
+    role
+  }?: Partial<EditMemberProps$1>) => Promise<void>;
+  /**
+   *
+   * Used to toggle the state of a member between active or deactivated, using the activate or deactivate button in row dropdown. A member has to be searched before toggling.
+   *
+   * @example 
+   *
+   * await teamMembers.searchAndVerifyMemberByEmail({
+   *     email: "sam@example.com",
+   * });
+   * await teamMembers.toggleMemberStateViaUI();
+   * @endexample
+  */
+  toggleMemberStateViaUI: () => Promise<void>;
+  /**
+   *
+   * Used to filter members by multi select fields such as role, group, teams, etc. The filter pane should be opened and closed before and after filtering. It takes the following parameters:
+   *
+   * selectedOptions (required): The options to be selected in the multi select field.
+   *
+   * selectContainerLocator (optional): The locator of the container of the multi select field. Default is the container of the role field.
+   *
+   * @example 
+   *
+   * await filterUtils.openFilterPane(page);
+   * await teamMembers.filterMembersByMultiSelect({
+   *     selectedOptions: ["Admin", "Standard"],
+   *     selectContainerLocator: NEETO_FILTERS_SELECTORS.roleSelectContainer
+   * });
+   * @endexample
+  */
+  filterMembersByMultiSelect: ({
+    selectedOptions,
+    selectContainerLocator
+  }: {
+    selectedOptions: string[];
+    selectContainerLocator?: string | undefined;
+  }) => Promise<void>;
+  /**
+   *
+   * Used to filter members by at least one these field: email with conditions, role, or name. It takes the following parameters:
+   *
+   * email (optional): An object with the id and condition as keys to filter by email.
+   *
+   * roles (optional): The roles to filter by.
+   *
+   * name (optional): The name to filter by.
+   *
+   * @example 
+   *
+   * await teamMembers.filterMembers({
+   *     email: { id: "sam", condition: "Contains" },
+   *     roles: ["Admin", "Standard"],
+   * });
+   * @endexample
+   * @example 
+   *
+   * await teamMembers.filterMembers({
+   *     name: "Sam",
+   *     roles: ["Admin"],
+   * });
+   * @endexample
+  */
+  filterMembers: ({
+    email,
+    roles,
+    name
+  }: {
+    email?: {
+      id: string;
+      condition: emailCondition;
+    } | undefined;
+    roles?: string[] | undefined;
+    name?: string | undefined;
+  }) => Promise<void>;
+  /**
+   *
+   * Used to get the row of the team members table by providing the name of the member.
+   *
+   * @example 
+   *
+   * await teamMembers.getMemberRowByName("Sam");
+   * @endexample
+  */
+  getMemberRowByName: (name: string) => playwright_core.Locator;
+  /**
+   *
+   * Used to take action on members by selecting the members and clicking on the take action button in the subheader. It takes the following parameters:
+   *
+   * names (optional): The names of the members to take action on. If not provided, all members will be selected.
+   *
+   * state (optional): The state to change the members to.
+   *
+   * action (optional): An object with actionButtonText and valueButtonText as keys to take action on the members. actionButtonText and valueButtonText are the text of the action button to be clicked and the value of the action to be changed to, respectively.
+   *
+   * @example 
+   *
+   * await teamMembers.takeActionOnMembers({
+   *     names: ["Sam", "Tom"],
+   *     state: "Deactivate",
+   * });
+   * @endexample
+   * @example 
+   *
+   * await teamMembers.takeActionOnMembers({
+   *     action: { actionButtonText: "Change role", valueButtonText: "Admin" },
+   * });
+   * @endexample
+  */
+  takeActionOnMembers: ({
+    names,
+    state,
+    action
+  }: {
+    names?: string[] | undefined;
+    state?: "activate" | "deactivate" | undefined;
+    action?: {
+      actionButtonText: string;
+      valueButtonText: string;
+    } | undefined;
+  }) => Promise<void>;
+  /**
+   *
+   * Used to perform an action on a column header in the team members table. It takes the following parameters:
+   *
+   * columnName (optional): The name of the column to perform the action on. Default is Name.
+   *
+   * actionButtonText (optional): The text of the action button to be clicked. Default is Ascending.
+   *
+   * @example 
+   *
+   * await teamMembers.performColumnAction({
+   *     columnName: "Role",
+   *     actionButtonText: "Hide column",
+   * });
+   * @endexample
+   * @example 
+   *
+   * await teamMembers.performColumnAction();
+   * 
+   * // This will sort the `name` column in ascending order.
+   * @endexample
+  */
+  performColumnAction: ({
+    columnName,
+    actionButtonText
+  }?: {
+    columnName?: string | undefined;
+    actionButtonText?: "Ascending" | "Descending" | "Hide column" | undefined;
+  }) => Promise<void>;
+  /**
+   *
+   * Used to toggle the visibility of columns in the team members table. It takes the following parameters:
+   *
+   * columns (optional): The columns whose visibility is to be toggled.
+   *
+   * bulkAction (optional): The option to show or hide all columns. If not provided, the columns will be toggled individually based on the columns parameter.
+   *
+   * @example 
+   *
+   * await teamMembers.toggleMemberColumns({
+   *     bulkAction: "show",
+   * });
+   * @endexample
+   * @example 
+   *
+   * await teamMembers.toggleMemberColumns({
+   *     columns: ["role", "email"],
+   * });
+   * @endexample
+  */
+  toggleMemberColumns: ({
+    columns,
+    bulkAction
+  }: {
+    columns?: string[] | undefined;
+    bulkAction?: "hide" | "show" | undefined;
+  }) => Promise<void>;
+  /**
+   *
+   * Used to verify the presence of a member in the team members table. It takes the following parameters:
+   *
+   * email (required): The email of the member to be verified.
+   *
+   * name (optional): The name of the member to be verified.
+   *
+   * @example 
+   *
+   * await teamMembers.verifyMemberInTable({
+   *     email: "sam@example.com",
+   *     name: "Sam",
+   * });
+   * @endexample
+  */
+  verifyMemberInTable: ({
+    name,
+    email
+  }: {
+    name: string;
+    email: string;
+  }) => Promise<void>;
+}
 interface BasicUserInfo {
   firstName: string;
   lastName: string;
@@ -1151,6 +1469,9 @@ declare const COMMON_SELECTORS: {
   sidebarSubLink: (label: string) => string;
   sidebarGoBackButton: (label: string) => string;
   selectSingleValue: string;
+  actionSelectIndicator: string;
+  takeActionDropdown: string;
+  columnsSearchInput: string;
 };
 declare const NEETO_EDITOR_SELECTORS: {
   boldOption: string;
@@ -1270,6 +1591,7 @@ declare const MEMBER_SELECTORS: {
   activatedMembersButton: string;
   columnCheckBox: string;
   roleLabel: (role: string) => string;
+  teamMembersTable: string;
   dropDownIcon: string;
   editButton: string;
   menuBarHeading: string;
@@ -1284,6 +1606,9 @@ declare const MEMBER_SELECTORS: {
   deactivateButton: string;
   rolesButton: string;
   statusTag: string;
+  menubarSubLink: (sublink: string) => string;
+  takeActionStateOption: (option?: string) => string;
+  checkboxLabel: (label: string) => string;
 };
 declare const MEMBER_FORM_SELECTORS: {
   emailTextField: string;
@@ -1501,6 +1826,10 @@ declare const CHAT_WIDGET_TEXTS: {
 };
 declare const MEMBER_TEXTS: {
   agent: string;
+  admin: string;
+  selectAll: string;
+  hide: string;
+  show: string;
 };
 declare const INTEGRATIONS_TEXTS: {
   connectHeader: (integration: string) => string;
@@ -1734,6 +2063,18 @@ declare const memberUtils: {
     email,
     neetoPlaywrightUtilities
   }: DeactiveMemberProps) => Promise<playwright_core.APIResponse | undefined>;
+  generateRandomTeamMembers: ({
+    count,
+    role
+  }: {
+    count?: number | undefined;
+    role?: string | undefined;
+  }) => {
+    firstName: string;
+    lastName: string;
+    email: string;
+    role: string;
+  }[];
 };
 interface AssertColumnHeaderVisibilityProps {
   page: Page;
@@ -1826,6 +2167,7 @@ declare const basicHTMLContent: (content: string) => string;
 declare const hexToRGB: (hex: string) => string;
 declare const filterUtils: {
   openFilterPane: (page: Page) => Promise<void>;
+  clearFiltersFromActionBlock: (page: Page) => Promise<void>;
 };
 /**
  *
@@ -1870,4 +2212,4 @@ interface Overrides {
  * @endexample
 */
 declare const definePlaywrightConfig: (overrides: Overrides) => _playwright_test.PlaywrightTestConfig<{}, {}>;
-export { API_ROUTES, ATTACHMENT_DELETION_TOASTR_MESSAGE, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_PICKER_LABEL, ENVIRONMENT, EXPANDED_FONT_SIZE, EditorPage, EmbedBase, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, ImageUploader, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TAGS_SELECTORS, TEXT_MODIFIER_ROLES, TEXT_MODIFIER_SELECTORS, TEXT_MODIFIER_TAGS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, USER_AGENTS, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, filterUtils, generateRandomBypassEmail, generateStagingData, getByDataQA, getGlobalUserState, getImagePathAndName, headerUtils, hexToRGB, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };
+export { API_ROUTES, ATTACHMENT_DELETION_TOASTR_MESSAGE, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_PICKER_LABEL, ENVIRONMENT, EXPANDED_FONT_SIZE, EditorPage, EmbedBase, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, ImageUploader, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TAGS_SELECTORS, TEXT_MODIFIER_ROLES, TEXT_MODIFIER_SELECTORS, TEXT_MODIFIER_TAGS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, TeamMembers, USER_AGENTS, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, filterUtils, generateRandomBypassEmail, generateStagingData, getByDataQA, getGlobalUserState, getImagePathAndName, headerUtils, hexToRGB, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };