@bigbinary/neeto-playwright-commons 4.1.10 → 4.1.11

package/index.d.ts

@@ -33,7 +33,7 @@ interface VerifyToastParams {
   timeout?: number;
   toastCloseTimeout?: number;
   closeAfterVerification: boolean;
-  toastType: "success" | "error";
+  toastType: "success" | "error" | "info" | "warning";
   customPageContext?: Page;
 }
 interface AssertCardDetailsProps {
@@ -212,6 +212,12 @@ declare class CustomCommands {
     condition,
     timeout
   }: ExecuteRecursivelyParams) => Promise<unknown>;
+  /**
+   * @deprecated Targets the react-toastify-based Toastr from
+   * @bigbinary/neetoui. Use verifyToastV2 instead for apps whose Toastr
+   * comes from @bigbinary/neeto-atoms (sonner-based, e.g. neeto-engage-web).
+   * Kept only for apps still on the legacy neetoui Toastr.
+   */
   /**
    *
    * Command to assert the toastr message. It takes the following parameters:
@@ -220,7 +226,7 @@ declare class CustomCommands {
    *
    * 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.
+   * toastType(optional): Type of toast. It takes success, error, info or warning as it's value. Default is success.
    *
    * timeout(optional): Timeout in milliseconds to wait for the toast to appear. Default is 10_000.
    *
@@ -248,6 +254,42 @@ declare class CustomCommands {
     toastCloseTimeout,
     customPageContext
   }?: Partial<VerifyToastParams>) => Promise<void>;
+  /**
+   *
+   * Command to assert the toastr message rendered by @bigbinary/neeto-atoms's sonner-based Toastr. Use this instead of verifyToast for apps that have moved to @bigbinary/neeto-atoms (e.g. neeto-engage-web). 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 success, error, info or warning as it's value. Default is success.
+   *
+   * timeout(optional): Timeout in milliseconds to wait for the toast to appear. Default is 10_000.
+   *
+   * toastCloseTimeout(optional): Timeout in milliseconds to wait for the toast to disappear after closing. Default is 10_000.
+   *
+   * customPageContext(optional): Custom page context on which to verify the toast.
+   *
+   * @example 
+   *
+   *   await neetoPlaywrightUtilities.verifyToastV2({
+   *     message: "Toastr message",
+   *     closeAfterVerification: false,
+   *     toastType: "error",
+   *     timeout: 20_000,
+   *     toastCloseTimeout: 15_000,
+   *     customPageContext: this.page,
+   *   });
+   * @endexample
+  */
+  verifyToastV2: ({
+    message,
+    toastType,
+    closeAfterVerification,
+    timeout,
+    toastCloseTimeout,
+    customPageContext
+  }?: Partial<VerifyToastParams>) => Promise<void>;
   /**
    *
    * Command to wait until the page has no loaders or spinners.
@@ -255,7 +297,7 @@ declare class CustomCommands {
    * @example 
    *
    *   await neetoPlaywrightUtilities.waitForPageLoad({
-   *     visiblityTimeout = 35_000,
+   *     visibilityTimeout: 35_000,
    *     customPageContext,
    *   });
    * @endexample

package/index.js

@@ -1988,6 +1988,7 @@ const getImagePathAndName = (localImagePath) => {
 };
 
 const __dirname$5 = getDirname(import.meta.url);
+const TOAST_DEFAULT_MESSAGE = "👍";
 class CustomCommands {
     page;
     t;
@@ -2048,8 +2049,13 @@ class CustomCommands {
         const startTime = Date.now();
         return await this.recursiveMethod(callback, condition, timeout, startTime, 1);
     };
+    /**
+     * @deprecated Targets the react-toastify-based Toastr from
+     * @bigbinary/neetoui. Use verifyToastV2 instead for apps whose Toastr
+     * comes from @bigbinary/neeto-atoms (sonner-based, e.g. neeto-engage-web).
+     * Kept only for apps still on the legacy neetoui Toastr.
+     */
     verifyToast = async ({ message = "", toastType = "success", closeAfterVerification = true, timeout = 10_000, toastCloseTimeout = 10_000, customPageContext = this.page, } = {}) => {
-        // React-toastify does not support adding data-* attributes to toast DOM elements: https://github.com/fkhadra/react-toastify/issues/1106
         const toastrLocator = customPageContext
             .locator(COMMON_SELECTORS.neetoUiToastr)
             .filter({
@@ -2060,10 +2066,10 @@ class CustomCommands {
             : toastrLocator.filter({ hasText: message }))
             // eslint-disable-next-line playwright/no-nth-methods
             .first();
-        await expect(filteredToastrLocator).toContainText(isEmpty(message) ? "👍" : message, { timeout });
-        const toastrCloseButton = filteredToastrLocator.getByTestId(COMMON_SELECTORS.toastCloseButton);
+        await expect(filteredToastrLocator).toContainText(isEmpty(message) ? TOAST_DEFAULT_MESSAGE : message, { timeout });
         if (!closeAfterVerification)
             return;
+        const toastrCloseButton = filteredToastrLocator.getByTestId(COMMON_SELECTORS.toastCloseButton);
         const buttonHandle = await toastrCloseButton.elementHandle();
         if (buttonHandle) {
             await customPageContext.evaluate(button => {
@@ -2074,6 +2080,27 @@ class CustomCommands {
             });
         }
     };
+    verifyToastV2 = async ({ message = "", toastType = "success", closeAfterVerification = true, timeout = 10_000, toastCloseTimeout = 10_000, customPageContext = this.page, } = {}) => {
+        const toastLocator = customPageContext.getByTestId(COMMON_SELECTORS.toastMessage(toastType));
+        const filteredToastLocator = (isEmpty(message)
+            ? toastLocator
+            : toastLocator.filter({ hasText: message }))
+            // eslint-disable-next-line playwright/no-nth-methods
+            .first();
+        await expect(filteredToastLocator).toContainText(isEmpty(message) ? TOAST_DEFAULT_MESSAGE : message, { timeout });
+        if (!closeAfterVerification)
+            return;
+        const toastCloseButton = filteredToastLocator.getByTestId(COMMON_SELECTORS.toastCloseButton);
+        const buttonHandle = await toastCloseButton.elementHandle();
+        if (buttonHandle) {
+            await customPageContext.evaluate(button => {
+                button.dispatchEvent(new Event("click", { bubbles: true }));
+            }, buttonHandle);
+            await expect(toastCloseButton).toBeHidden({
+                timeout: toastCloseTimeout,
+            });
+        }
+    };
     waitForPageLoad = async ({ visibilityTimeout = 35_000, customPageContext = this.page, waitForOption = "serial", } = {}) => {
         await customPageContext.waitForLoadState();
         const loaders = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-playwright-commons",
-  "version": "4.1.10",
+  "version": "4.1.11",
   "description": "A package encapsulating common playwright code across neeto projects.",
   "repository": "git@github.com:bigbinary/neeto-playwright-commons.git",
   "license": "apache-2.0",