@bigbinary/neeto-playwright-commons 1.9.24 → 1.9.26

package/index.d.ts

@@ -941,16 +941,16 @@ declare class SlackPage extends IntegrationBase {
   }: SlackPageParams);
   /**
    *
-   * Closes the coach mark modal that appears when a user logs in to Slack for the first time. It can be useful in scenarios where the coach mark is blocking the view of the elements that need to be interacted with. It takes the following parameters:
+   * Closes the coach mark modal, upgrades banner, and permissions banner that appears when a user logs in to Slack for the first time, if present. It can be useful in scenarios where the banners are blocking the view of the elements that needs to be interacted with. It takes the following parameters:
    *
    * slackWebappPage (optional): Playwright Page object for Slack web app.
    *
    * @example 
    *
-   *   await slackPage.closeCoachMark(slackWebappPageInstance);
+   *   await slackPage.setupCloseHandlers(slackWebappPageInstance);
    * @endexample
   */
-  closeCoachMark: (slackWebappPage?: Page) => Promise<void>;
+  setupCloseHandlers: (slackWebappPage?: Page) => Promise<void>;
   /**
    *
    * Connects to slack integration and verifies the connection. It takes the following parameters:
@@ -2246,15 +2246,44 @@ interface SearchAndSelectProps {
 interface MergeTagsViaUIProps {
   sourceTagName: string;
   destinationTagName: string;
-  mergeTagsLabel: string;
-  tagsBreadcrumbLabel: string;
+  tagsBreadcrumbSelector: string;
 }
 declare class TagsPage {
   page: Page;
   neetoPlaywrightUtilities: CustomCommands;
   t: TFunction;
   constructor(page: Page, neetoPlaywrightUtilities: CustomCommands);
+  /**
+   *
+   * Used to search and verify the tags by providing tag name as the search term. It takes the following parameters:
+   *
+   * tagName (required): The name of the tag to be searched.
+   *
+   * @example 
+   *
+   * await tagsPage.searchAndVerifyTags("tagName");
+   * @endexample
+  */
   searchAndVerifyTags: (tagName: string) => Promise<void>;
+  /**
+   *
+   * Used to add a tag using the add button in the header. It takes the following parameters:
+   *
+   * tagName (required): The name of the tag to be added.
+   *
+   * addTagsLabel (required): The label of the add new tags pane header.
+   *
+   * tagsResponseUrl (required): the response URL of tags when the save button is clicked while adding new tags.
+   *
+   * @example 
+   *
+   * await tagsPage.addTagViaUI({
+   *     tagName: "tagName",
+   *     addTagsLabel: "Add new tag",
+   *     tagsResponseUrl: API_ROUTES.tags.index,
+   * });
+   * @endexample
+  */
   addTagViaUI: ({
     tagName,
     addTagsLabel,
@@ -2264,7 +2293,36 @@ declare class TagsPage {
     addTagsLabel: string;
     tagsResponseUrl: string;
   }) => Promise<void>;
+  /**
+   *
+   * Used to filter tags using the filter button in the header. It takes the following parameters:
+   *
+   * tagName (required): The name of the tag to be filtered.
+   *
+   * @example 
+   *
+   * await tagsPage.filterTagsViaUI({
+   *     tagName: "tagName",
+   * });
+   * @endexample
+  */
   filterTagsViaUI: (tagName: string) => Promise<void>;
+  /**
+   *
+   * Used to edit a tag using the edit button in row dropdown. It takes the following parameters:
+   *
+   * tagName (required): The name of the tag to be edited.
+   *
+   * newTagName (required): The new name of the tag.
+   *
+   * @example 
+   *
+   * await tagsPage.editTagViaUI({
+   *     tagName: "tagName",
+   *     newTagName: "newTagName",
+   * });
+   * @endexample
+  */
   editTagViaUI: ({
     tagName,
     newTagName
@@ -2272,27 +2330,105 @@ declare class TagsPage {
     tagName: string;
     newTagName: string;
   }) => Promise<void>;
+  /**
+   *
+   * Used to delete a tag using the delete button in row dropdown. It takes the following parameters:
+   *
+   * tagName (required): The name of the tag to be deleted.
+   *
+   * @example 
+   *
+   * await tagsPage.deleteTagViaUI({
+   *     tagName: "tagName",
+   * });
+   * @endexample
+  */
   deleteTagViaUI: (tagName: string) => Promise<void>;
-  addTagsViaResponse: ({
+  /**
+   *
+   * Used to add tags via API request. It takes the following parameters:
+   *
+   * name (required): The name of the tag to be added.
+   *
+   * description (optional): The description of the tag to be added. Default is "".
+   *
+   * tagsRequestUrl (required): The URL of the tags API endpoint.
+   *
+   * @example 
+   *
+   * await tagsPage.addTagsViaRequest({
+   *     name: "tagName",
+   *     description: "tagDescription",
+   *     tagsRequestUrl: ROUTES.tags.index,
+   * });
+   * @endexample
+  */
+  addTagsViaRequest: ({
     name,
     description,
-    tagsResponseUrl
+    tagsRequestUrl
   }: {
     name: string;
-    description: string;
-    tagsResponseUrl: string;
+    description?: string;
+    tagsRequestUrl: string;
   }) => Promise<playwright_core.APIResponse | undefined>;
-  navigateToMergeTagsPage: (mergeTagsLabel: string) => Promise<void>;
+  /**
+   *
+   * Used to navigate to merge tags page.
+   *
+   * @example 
+   *
+   * await tagsPage.navigateToMergeTagsPage();
+   * @endexample
+  */
+  navigateToMergeTagsPage: () => Promise<void>;
+  /**
+   *
+   * Used to search a tag and select that tag in the tags table. It takes the following parameters:
+   *
+   * selector (required): The selector used to search a tag.
+   *
+   * tagName (required): The name of the tag to be searched and selected.
+   *
+   * rowSelector (required): The selector of the row used to select a tag.
+   *
+   * @example 
+   *
+   * await tagsPage.searchAndSelect({
+   *     selector: MERGE_TAGS_SELECTORS.sourceSearchTextField,
+   *     tagName: "tagName",
+   *     rowSelector: MERGE_TAGS_SELECTORS.sourceTagRow,
+   * });
+   * @endexample
+  */
   searchAndSelect: ({
     selector,
     tagName,
     rowSelector
   }: SearchAndSelectProps) => Promise<void>;
-  mergeTagsViaUI: ({
+  /**
+   *
+   * Used to merge tags and verify the merged tags in tags table. It takes the following parameters:
+   *
+   * sourceTagName (required): The name of the source tag to be merged.
+   *
+   * destinationTagName (required): The name of the destination tag to be merged.
+   *
+   * tagsBreadcrumbSelector (required): The selector of the tags breadcrumb used to redirect to the tags page.
+   *
+   * @example 
+   *
+   * tagsPage.mergeAndVerifyTagsViaUI({
+   *     sourceTagName: "sourceTagName",
+   *     destinationTagName: "destinationTagName",
+   *     tagsBreadcrumbSelector: SETTINGS_SELECTORS.ticketTagsBreadcrumb,
+   * })
+   * @endexample
+  */
+  mergeAndVerifyTagsViaUI: ({
     sourceTagName,
     destinationTagName,
-    mergeTagsLabel,
-    tagsBreadcrumbLabel
+    tagsBreadcrumbSelector
   }: MergeTagsViaUIProps) => Promise<void>;
 }
 /**
@@ -3543,6 +3679,8 @@ declare const SLACK_SELECTORS: {
 declare const SLACK_DATA_QA_SELECTORS: {
   sectionHeadingButton: string;
   coachMarkCloseButton: string;
+  messagePaneBannerCloseIcon: string;
+  permissionBannerCloseIcon: string;
   channelSectionSubmenuCreate: string;
   channelSectionMenuCreateChannel: string;
   skModalContent: string;

package/index.js

@@ -13885,6 +13885,8 @@ const SLACK_SELECTORS = {
 const SLACK_DATA_QA_SELECTORS = {
     sectionHeadingButton: "section_heading_button__channels",
     coachMarkCloseButton: "coachmark-close-button",
+    messagePaneBannerCloseIcon: "message_pane_banner_close_icon",
+    permissionBannerCloseIcon: "banner_close_btn",
     channelSectionSubmenuCreate: "channel_section_submenu_create",
     channelSectionMenuCreateChannel: "channel_section_menu__create_channel",
     skModalContent: "sk-modal-content",
@@ -13907,10 +13909,11 @@ class SlackPage extends IntegrationBase {
             integration: "slack",
             integrationRouteIndex,
         });
-        this.closeCoachMark = async (slackWebappPage = this.page) => {
+        this.setupCloseHandlers = async (slackWebappPage = this.page) => {
             const slackWebappPageDataQa = getByDataQA(slackWebappPage);
-            const closeCoachMarkButton = slackWebappPageDataQa(SLACK_DATA_QA_SELECTORS.coachMarkCloseButton);
-            await closeCoachMarkButton.click();
+            await slackWebappPage.addLocatorHandler(slackWebappPageDataQa(SLACK_DATA_QA_SELECTORS.coachMarkCloseButton), () => slackWebappPageDataQa(SLACK_DATA_QA_SELECTORS.coachMarkCloseButton).click());
+            await slackWebappPage.addLocatorHandler(slackWebappPageDataQa(SLACK_DATA_QA_SELECTORS.messagePaneBannerCloseIcon), () => slackWebappPageDataQa(SLACK_DATA_QA_SELECTORS.messagePaneBannerCloseIcon).click());
+            await slackWebappPage.addLocatorHandler(slackWebappPageDataQa(SLACK_DATA_QA_SELECTORS.permissionBannerCloseIcon), () => slackWebappPageDataQa(SLACK_DATA_QA_SELECTORS.permissionBannerCloseIcon).click());
         };
         this.connectAndVerifyIntegration = async (redirectUrl, customSteps, channelToConfigure = SLACK_DEFAULT_CHANNEL) => {
             await this.connect();
@@ -14016,7 +14019,7 @@ class SlackPage extends IntegrationBase {
                 await slackWebappPage
                     .locator(SLACK_SELECTORS.redirectOpenInBrowser)
                     .click();
-                await this.closeCoachMark(slackWebappPage);
+                await this.setupCloseHandlers(slackWebappPage);
             }
             else {
                 throw new Error("ENV variable SLACK_LOGIN_EMAIL or SLACK_LOGIN_PASSWORD or SLACK_WORKSPACE is not defined.");
@@ -14039,9 +14042,6 @@ class SlackPage extends IntegrationBase {
                 .click();
         };
         this.createNewSlackChannel = async ({ channelName, kind = "public", }) => {
-            const closeCoachMarkButton = this.slackWebappPageDataQa(SLACK_DATA_QA_SELECTORS.coachMarkCloseButton);
-            (await closeCoachMarkButton.isVisible()) &&
-                (await closeCoachMarkButton.click());
             await this.slackWebappPageDataQa(SLACK_DATA_QA_SELECTORS.sectionHeadingButton).click();
             await this.slackWebappPageDataQa(SLACK_DATA_QA_SELECTORS.channelSectionSubmenuCreate).click();
             await this.slackWebappPageDataQa(SLACK_DATA_QA_SELECTORS.channelSectionMenuCreateChannel).click();
@@ -14575,7 +14575,7 @@ class EditorPage {
                 await this.neetoPlaywrightUtilities.interceptMultipleResponses({
                     responseUrl: ROUTES.attachment,
                 });
-                await this.neetoPlaywrightUtilities.verifySuccessToast();
+                await this.neetoPlaywrightUtilities.verifyToast();
                 await expect(this.attachmentPreview).toBeVisible();
                 await this.attachmentPreview
                     .getByTestId(COMMON_SELECTORS.dropdownIcon)
@@ -14587,7 +14587,7 @@ class EditorPage {
                     .getByTestId(COMMON_SELECTORS.alertModalSubmitButton)
                     .click();
             }
-            await this.neetoPlaywrightUtilities.verifySuccessToast({
+            await this.neetoPlaywrightUtilities.verifyToast({
                 message: ATTACHMENT_DELETION_TOASTR_MESSAGE,
             });
             if (await this.imageUploadOption.isVisible()) {
@@ -14600,7 +14600,7 @@ class EditorPage {
                 const imagePath = Path.join(__dirname, filePath);
                 await fileUploader.setFiles(imagePath);
                 await expect(this.imageWrapper).toBeVisible({ timeout: 15000 });
-                await this.neetoPlaywrightUtilities.verifySuccessToast();
+                await this.neetoPlaywrightUtilities.verifyToast();
                 await this.imageWrapper
                     .getByTestId(COMMON_SELECTORS.dropdownIcon)
                     .click();
@@ -14637,7 +14637,7 @@ class EditorPage {
                     .getByTestId(COMMON_SELECTORS.selectOption(this.t("neetoRules.labels.feedback")))
                     .click();
                 await this.page.getByTestId(NEETO_EDITOR_SELECTORS.applyButton).click();
-                await this.neetoPlaywrightUtilities.verifySuccessToast({
+                await this.neetoPlaywrightUtilities.verifyToast({
                     message: cannedResponseSuccessMessage,
                 });
             }
@@ -15390,7 +15390,7 @@ class TagsPage {
             });
             await this.page.getByTestId(TAGS_SELECTORS.submitButton).click();
             await waitForSave;
-            await this.neetoPlaywrightUtilities.verifySuccessToast();
+            await this.neetoPlaywrightUtilities.verifyToast();
             await this.searchAndVerifyTags(tagName);
         };
         this.filterTagsViaUI = async (tagName) => {
@@ -15422,7 +15422,7 @@ class TagsPage {
                 .getByTestId(TAGS_SELECTORS.tagNameTextField)
                 .fill(newTagName);
             await this.page.getByTestId(TAGS_SELECTORS.submitButton).click();
-            await this.neetoPlaywrightUtilities.verifySuccessToast();
+            await this.neetoPlaywrightUtilities.verifyToast();
             await expect(this.page.getByRole("row", { name: tagName })).toBeHidden();
             await expect(this.page.getByRole("row", { name: newTagName })).toBeVisible();
         };
@@ -15435,18 +15435,18 @@ class TagsPage {
             await this.page
                 .getByTestId(COMMON_SELECTORS.alertModalSubmitButton)
                 .click();
-            await this.neetoPlaywrightUtilities.verifySuccessToast();
+            await this.neetoPlaywrightUtilities.verifyToast();
             await expect(this.page.getByRole("row", { name: tagName })).toBeHidden();
         };
-        this.addTagsViaResponse = ({ name, description, tagsResponseUrl, }) => this.neetoPlaywrightUtilities.apiRequest({
-            url: tagsResponseUrl,
+        this.addTagsViaRequest = ({ name, description = "", tagsRequestUrl, }) => this.neetoPlaywrightUtilities.apiRequest({
+            url: tagsRequestUrl,
             body: { name, description },
             method: "post",
         });
-        this.navigateToMergeTagsPage = async (mergeTagsLabel) => {
+        this.navigateToMergeTagsPage = async () => {
             await this.page.getByTestId(MERGE_TAGS_SELECTORS.mergeTagsButton).click();
             await this.neetoPlaywrightUtilities.waitForPageLoad();
-            await expect(this.page.getByTestId(COMMON_SELECTORS.heading)).toHaveText(mergeTagsLabel);
+            await expect(this.page.getByTestId(COMMON_SELECTORS.heading)).toHaveText(this.t("neetoTags.common.mergeTag_other"));
         };
         this.searchAndSelect = async ({ selector, tagName, rowSelector, }) => {
             await this.page.getByTestId(selector).fill(tagName);
@@ -15455,7 +15455,7 @@ class TagsPage {
                 .filter({ hasText: tagName })
                 .click();
         };
-        this.mergeTagsViaUI = async ({ sourceTagName, destinationTagName, mergeTagsLabel, tagsBreadcrumbLabel, }) => {
+        this.mergeAndVerifyTagsViaUI = async ({ sourceTagName, destinationTagName, tagsBreadcrumbSelector, }) => {
             await this.searchAndSelect({
                 selector: MERGE_TAGS_SELECTORS.sourceSearchTextField,
                 tagName: sourceTagName,
@@ -15467,10 +15467,10 @@ class TagsPage {
                 rowSelector: MERGE_TAGS_SELECTORS.destinationTagRow,
             });
             await this.page.getByTestId(MERGE_TAGS_SELECTORS.mergeButton).click();
-            await expect(this.page.getByTestId(COMMON_SELECTORS.modalHeader)).toHaveText(mergeTagsLabel);
+            await expect(this.page.getByTestId(COMMON_SELECTORS.modalHeader)).toHaveText(this.t("neetoTags.common.mergeTag_other"));
             await this.page.getByTestId(MERGE_TAGS_SELECTORS.proceedButton).click();
-            await this.neetoPlaywrightUtilities.verifySuccessToast();
-            await this.page.getByTestId(tagsBreadcrumbLabel).click();
+            await this.neetoPlaywrightUtilities.verifyToast();
+            await this.page.getByTestId(tagsBreadcrumbSelector).click();
             await expect(this.page.getByText(sourceTagName)).toBeHidden();
             await expect(this.page.getByText(destinationTagName)).toBeVisible();
         };