@bigbinary/neeto-playwright-commons 1.9.20 → 1.9.22

package/index.d.ts

@@ -27,6 +27,11 @@ interface VerifySuccessToastParams {
   message: string;
   closeAfterVerification: boolean;
 }
+interface VerifyToastParams {
+  message: string;
+  closeAfterVerification: boolean;
+  toastType: "success" | "error";
+}
 type ConditionProps = Record<string, string>[];
 type FilterProps = Record<string, ConditionProps>;
 type ParamFilters = FilterProps[];
@@ -119,9 +124,12 @@ declare class CustomCommands {
    * @endexample
   */
   executeRecursively: ExecuteRecursively;
+  /**
+   * @deprecated Use verifyToast instead.
+   */
   /**
    *
-   * Command to assert the toastr message. It takes the following parameters:
+   * Command to assert the success toastr message. It takes the following parameters:
    *
    * closeAfterVerification(optional): Boolean to close the toast after verification. Default is true.
    *
@@ -139,6 +147,30 @@ declare class CustomCommands {
     message,
     closeAfterVerification
   }?: Partial<VerifySuccessToastParams>) => Promise<void>;
+  /**
+   *
+   * Command to assert the toastr message. It takes the following parameters:
+   *
+   * closeAfterVerification(optional): Boolean to close the toast after verification. Default is true.
+   *
+   * message(optional): Text that should be on toast.
+   *
+   * toastType(optional): Type of toast. It takes either success or error as it's value. Default is success.
+   *
+   * @example 
+   *
+   *   await neetoPlaywrightUtilities.verifyToast({
+   *     message: "Toastr message",
+   *     closeAfterVerification: false,
+   *     toastType: "error"
+   *   });
+   * @endexample
+  */
+  verifyToast: ({
+    message,
+    toastType,
+    closeAfterVerification
+  }?: Partial<VerifyToastParams>) => Promise<void>;
   /**
    *
    * Command to reload and wait for the API responses.
@@ -1327,7 +1359,7 @@ declare class ZapierPage extends IntegrationBase {
 interface VerifyDescriptionEditorParams {
   text: string;
   linkUrl?: string;
-  fileName?: string;
+  filePath?: string;
   attachedImageName?: string;
   imageUrl?: string;
   videoUrl?: string;
@@ -1350,10 +1382,34 @@ declare class EditorPage {
   videoWrapperSelector: Locator;
   emojiDropdownIcon: Locator;
   constructor(page: Page, neetoPlaywrightUtilities: CustomCommands);
+  /**
+   *
+   * Used to verify description editor functionality
+   *
+   * text (required): The text to be filled in editor content field.
+   *
+   * linkUrl (optional): The url to be added when we select the button on the editor menu to link a url to a text. Default is faker.internet.url().
+   *
+   * filePath (optional): The file path to be added when we select the button on the editor menu to attach a file in the editor. Default is "../../../e2e/assets/images/BigBinary.png".
+   *
+   * imageUrl (optional): The url to be added when we select the button on the editor menu to upload an image in the editor. Default is https://picsum.photos/200/300.
+   *
+   * videoUrl (optional): The url to be added when we select the button on the editor menu to upload a video in the editor. Default is https://youtu.be/jNQXAC9IVRw.
+   *
+   * cannedResponseSuccessMessage (optional): The success toastr message after applying canned reesponse.
+   *
+   * @example 
+   *
+   * await editorPage.verifyDescriptionEditor({
+   *     text: t("tickets.updated_one"),
+   *     cannedResponseSuccessMessage: t("messages.successCannedResponse"),
+   * });
+   * @endexample
+  */
   verifyDescriptionEditor: ({
     text,
     linkUrl,
-    fileName,
+    filePath,
     imageUrl,
     videoUrl,
     cannedResponseSuccessMessage
@@ -2709,6 +2765,7 @@ declare const COMMON_SELECTORS: {
   actionSelectIndicator: string;
   takeActionDropdown: string;
   columnsSearchInput: string;
+  errorToastIcon: string;
 };
 /**
  *
@@ -2812,6 +2869,7 @@ declare const NEETO_EDITOR_SELECTORS: {
   imageUploadLinkButton: string;
   errorText: string;
   content: string;
+  imageUploadDeleteButton: string;
 };
 declare const NEETO_TEXT_MODIFIER_SELECTORS: {
   strikeOption: string;

package/index.js

@@ -313,6 +313,7 @@ const COMMON_SELECTORS = {
     actionSelectIndicator: "action-select-indicator",
     takeActionDropdown: "take-action-dropdown-icon",
     columnsSearchInput: "neeto-ui-columns-search",
+    errorToastIcon: "error-toast-icon",
 };
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
@@ -3427,6 +3428,9 @@ class CustomCommands {
             const startTime = Date.now();
             await this.recursiveMethod(callback, condition, timeout, startTime);
         };
+        /**
+         * @deprecated Use verifyToast instead.
+         */
         this.verifySuccessToast = async ({ message = "", closeAfterVerification = true, } = {}) => {
             if (!isEmpty$1(message)) {
                 await expect(this.page.getByTestId(COMMON_SELECTORS.toastMessage)).toContainText(message);
@@ -3438,6 +3442,22 @@ class CustomCommands {
                 (await this.page.getByTestId(COMMON_SELECTORS.toastCloseButton).click());
             await expect(this.page.locator(COMMON_SELECTORS.toastIcon)).toBeHidden();
         };
+        this.verifyToast = async ({ message = "", toastType = "success", closeAfterVerification = true, } = {}) => {
+            if (toastType === "error") {
+                await expect(this.page.getByTestId(COMMON_SELECTORS.errorToastIcon)).toBeVisible({ timeout: 10000 });
+            }
+            const toastrCloseButton = this.page.getByTestId(COMMON_SELECTORS.toastCloseButton);
+            if (!isEmpty$1(message)) {
+                await expect(this.page.getByTestId(COMMON_SELECTORS.toastMessage)).toContainText(message, { timeout: 10000 });
+            }
+            else {
+                await expect(this.page.locator(COMMON_SELECTORS.toastIcon)).toContainText("👍");
+            }
+            if (closeAfterVerification && (await toastrCloseButton.isVisible())) {
+                await toastrCloseButton.click();
+                await expect(toastrCloseButton).toBeHidden();
+            }
+        };
         this.reloadAndWait = async (requestCount, customPageContext, interceptMultipleResponsesProps = {}) => {
             const pageContext = customPageContext !== null && customPageContext !== void 0 ? customPageContext : this.page;
             const reloadRequests = this.interceptMultipleResponses({
@@ -14424,13 +14444,13 @@ const NEETO_EDITOR_SELECTORS = {
     videoEmbedOption: "neeto-editor-fixed-menu-video-embed-option",
     videoEmbedInput: "neeto-editor-embed-input",
     videoEmbedSubmit: "neeto-editor-embed-cancel",
-    // TODO: Fix the selector after the issue is resolved: https://github.com/bigbinary/neeto-editor/issues/1047
-    videoWrapper: ".neeto-editor__video-wrapper",
+    videoWrapper: "neeto-editor-video-wrapper",
     paragraphOption: "neeto-editor-fixed-menu-font-size-option-body2",
     attachmentPreview: "ne-attachments-wrapper",
     imageUploadLinkButton: "neeto-editor-media-uploader-link-tab",
     errorText: "neeto-editor-error-text",
     content: "editor-content",
+    imageUploadDeleteButton: "neeto-editor-image-menu-Delete",
 };
 const NEETO_TEXT_MODIFIER_SELECTORS = {
     strikeOption: "neeto-editor-fixed-menu-strike-option",
@@ -14459,7 +14479,7 @@ const FONT_SIZE_SELECTORS = {
 /* eslint-disable playwright/no-nth-methods */
 class EditorPage {
     constructor(page, neetoPlaywrightUtilities) {
-        this.verifyDescriptionEditor = async ({ text, linkUrl = faker.internet.url(), fileName = "../../../e2e/assets/images/BigBinary.png", imageUrl = "https://picsum.photos/200/300", videoUrl = "https://youtu.be/jNQXAC9IVRw", cannedResponseSuccessMessage, }) => {
+        this.verifyDescriptionEditor = async ({ text, linkUrl = faker.internet.url(), filePath = "../../../e2e/assets/images/BigBinary.png", imageUrl = "https://picsum.photos/200/300", videoUrl = "https://youtu.be/jNQXAC9IVRw", cannedResponseSuccessMessage, }) => {
             await this.page.getByTestId(NEETO_EDITOR_SELECTORS.contentField).fill(text);
             await this.page
                 .getByTestId(NEETO_EDITOR_SELECTORS.fontSizeDropdown())
@@ -14540,7 +14560,7 @@ class EditorPage {
                 const fileUploaderPromise = this.page.waitForEvent("filechooser");
                 await this.editorAttachmentsButton.click();
                 const fileUploader = await fileUploaderPromise;
-                const imagePath = Path.join(__dirname, fileName);
+                const imagePath = Path.join(__dirname, filePath);
                 await fileUploader.setFiles(imagePath);
                 await this.neetoPlaywrightUtilities.interceptMultipleResponses({
                     responseUrl: ROUTES.attachment,
@@ -14567,7 +14587,7 @@ class EditorPage {
                     .getByTestId(NEETO_EDITOR_SELECTORS.imageUploadButton)
                     .click();
                 const fileUploader = await fileUploaderPromise;
-                const imagePath = Path.join(__dirname, fileName);
+                const imagePath = Path.join(__dirname, filePath);
                 await fileUploader.setFiles(imagePath);
                 await expect(this.imageWrapper).toBeVisible({ timeout: 15000 });
                 await this.neetoPlaywrightUtilities.verifySuccessToast();
@@ -14648,16 +14668,11 @@ class EditorPage {
         this.attachmentPreview = this.page.getByTestId(NEETO_EDITOR_SELECTORS.attachmentPreview);
         this.editorAttachmentsButton = this.page.getByTestId(NEETO_EDITOR_SELECTORS.editorAttachmentsButton);
         this.imageWrapper = this.page.getByTestId(NEETO_EDITOR_SELECTORS.imageWrapper);
-        // TODO: Fix the selector after the issue is resolved: https://github.com/bigbinary/neeto-editor/issues/1047
-        this.imageUploadDeleteButton = this.page
-            .getByTestId(COMMON_SELECTORS.dropdownContainer)
-            .getByRole("button")
-            .nth(3);
+        this.imageUploadDeleteButton = this.page.getByTestId(NEETO_EDITOR_SELECTORS.imageUploadDeleteButton);
         this.imageUploadOption = this.page.getByTestId(NEETO_EDITOR_SELECTORS.imageUploadOption);
         this.cannedResponseOption = this.page.getByTestId(NEETO_EDITOR_SELECTORS.cannedResponseOption);
         this.videoEmbedOption = this.page.getByTestId(NEETO_EDITOR_SELECTORS.videoEmbedOption);
-        // TODO: Fix the selector after the issue is resolved: https://github.com/bigbinary/neeto-editor/issues/1047
-        this.videoWrapperSelector = this.page.locator(NEETO_EDITOR_SELECTORS.videoWrapper);
+        this.videoWrapperSelector = this.page.getByTestId(NEETO_EDITOR_SELECTORS.videoWrapper);
         this.emojiDropdownIcon = this.page
             .getByTestId(NEETO_EDITOR_SELECTORS.fixedMenuWrapper)
             .getByTestId(COMMON_SELECTORS.dropdownIcon);