@bigbinary/neeto-playwright-commons 1.9.0 → 1.9.2

package/index.d.ts

@@ -42,8 +42,7 @@ interface ApiRequestProps {
   params?: ParamProps;
 }
 interface WaitForPageLoadParams {
-  visiblityTimeout: number;
-  retryTimeout: number;
+  visibilityTimeout: number;
   customPageContext: Page | undefined;
 }
 type ApiRequest = (props: ApiRequestProps & Record<string, unknown>) => Promise<APIResponse | undefined>;
@@ -57,11 +56,17 @@ interface SelectOptionFromDropdownParams {
   selectMenu: string;
   value: string;
   options?: Partial<{
-    visiblityTimeout: number;
+    visibilityTimeout: number;
     textAssertionTimeout: number;
     retryTimeout: number;
   }>;
 }
+interface SearchAndVerifyProps {
+  searchTerm: string;
+  countSelector: string;
+  searchInputSelector?: string;
+  countText: string;
+}
 declare class CustomCommands {
   page: Page;
   responses: string[];
@@ -146,9 +151,9 @@ declare class CustomCommands {
   */
   reloadAndWait: (requestCount: number, customPageContext?: Page, interceptMultipleResponsesProps?: Partial<Omit<InterceptMultipleResponsesParams, "times">>) => Promise<void>;
   waitForPageLoad: ({
-    visiblityTimeout,
+    visibilityTimeout,
     customPageContext
-  }: WaitForPageLoadParams) => Promise<void>;
+  }?: Partial<WaitForPageLoadParams>) => Promise<void>;
   /**
    *
    * Command to send a request.
@@ -197,6 +202,26 @@ declare class CustomCommands {
    * @endexample
   */
   verifyFieldValue: VerifyFieldValue;
+  /**
+   *
+   * Command to search for a term and verify the results and its count.
+   *
+   * @example 
+   *
+   * await neetoPlaywrightUtilities.searchAndVerify({
+   *   searchTerm: "searchTerm",
+   *   searchInputSelector: COMMON_SELECTORS.inputField,
+   *   countSelector: COMMON_SELECTORS.count,
+   *   countText: "43 items",
+   * });
+   * @endexample
+  */
+  searchAndVerify: ({
+    searchTerm,
+    searchInputSelector,
+    countSelector,
+    countText
+  }: SearchAndVerifyProps) => Promise<void>;
 }
 interface EmailContentParams {
   email: string;
@@ -776,6 +801,9 @@ declare const networkConditions: Record<"Slow 3G" | "Fast 3G" | "No Throttling",
  * @endexample
 */
 declare const COMMON_SELECTORS: {
+  emailInputError: string;
+  pane: string;
+  sideBar: string;
   copyButton: string;
   spinner: string;
   subheaderText: string;
@@ -882,6 +910,7 @@ declare const NEETO_FILTERS_SELECTORS: {
   allMenubarBlock: string;
   filtersEmailFilter: string;
   paneModalCrossIcon: string;
+  searchTermBlock: string;
 };
 declare const HELP_CENTER_SELECTORS: {
   helpButton: string;

package/index.js

@@ -26,6 +26,25 @@ import require$$1$2 from 'string_decoder';
 import require$$4$1 from 'timers';
 import require$$3$2 from 'crypto';
 
+const NEETO_FILTERS_SELECTORS = {
+    emailSelectContainer: "email-select-container-wrapper",
+    filterPaneHeading: "neeto-filters-pane-header",
+    neetoFiltersEmailBlock: "neeto-filters-email-block",
+    neetoFiltersRoleBlock: "neeto-filters-role-block",
+    neetoFiltersBarClearButton: "neeto-filters-bar-clear-btn",
+    neetoFiltersNameFilterField: "neeto-filters-name-filter",
+    neetoFilterNameBlock: "neeto-filters-name-block",
+    roleSelectContainer: "role-select-container-wrapper",
+    filterButton: "neeto-filters-toggle-btn",
+    filtersClearButton: "neeto-filters-clear-btn",
+    filterDoneButton: "neeto-filters-done-btn",
+    filteredMembersCount: "ntm-filtered-members-count",
+    allMenubarBlock: "ntm-members-menubar-all-block",
+    filtersEmailFilter: "neeto-filters-email-filter",
+    paneModalCrossIcon: "neeto-filters-close-button",
+    searchTermBlock: "neeto-filters-search-term-block",
+};
+
 const ENVIRONMENT = {
     development: "development",
     staging: "staging",
@@ -139,6 +158,9 @@ const getByDataQA = curry((page, dataQa) => {
 });
 
 const COMMON_SELECTORS = {
+    emailInputError: "email-input-error",
+    pane: "pane-wrapper",
+    sideBar: "sidebar",
     copyButton: "copy-button",
     spinner: ".neeto-ui-spinner",
     subheaderText: "subheader-left",
@@ -2532,15 +2554,15 @@ class CustomCommands {
             await pageContext.reload();
             await reloadRequests;
         };
-        this.waitForPageLoad = async ({ visiblityTimeout = 35000, customPageContext, }) => {
+        this.waitForPageLoad = async ({ visibilityTimeout = 35000, customPageContext, } = {}) => {
             const pageContext = customPageContext !== null && customPageContext !== void 0 ? customPageContext : this.page;
             await pageContext.waitForLoadState("load");
             await Promise.all([
                 expect(pageContext.getByTestId(COMMON_SELECTORS.pageLoader)).toBeHidden({
-                    timeout: visiblityTimeout,
+                    timeout: visibilityTimeout,
                 }),
                 expect(pageContext.getByTestId(COMMON_SELECTORS.spinner)).toBeHidden({
-                    timeout: visiblityTimeout,
+                    timeout: visibilityTimeout,
                 }),
             ]);
         };
@@ -2567,14 +2589,14 @@ class CustomCommands {
         };
         this.selectOptionFromDropdown = async ({ selectValueContainer, selectMenu, value, options = {}, }) => {
             Object.assign({
-                visiblityTimeout: 2000,
+                visibilityTimeout: 2000,
                 textAssertionTimeout: 1000,
                 retryTimeout: 20000,
             }, options);
             await expect(async () => {
                 await this.page.getByTestId(selectValueContainer).click();
                 await expect(this.page.getByTestId(selectMenu)).toBeVisible({
-                    timeout: options.visiblityTimeout,
+                    timeout: options.visibilityTimeout,
                 });
                 await this.page.getByTestId(selectMenu).getByText(value).click();
                 await expect(this.page.getByTestId(selectValueContainer)).toContainText(value, { timeout: options.textAssertionTimeout });
@@ -2586,6 +2608,16 @@ class CustomCommands {
                 ? Promise.all(values.map(value => verifyEachFieldValue(value)))
                 : verifyEachFieldValue(values);
         };
+        this.searchAndVerify = async ({ searchTerm, searchInputSelector = COMMON_SELECTORS.inputField, countSelector, countText, }) => {
+            await expect(async () => {
+                await this.page.getByTestId(searchInputSelector).fill(searchTerm);
+                await expect(this.page.getByTestId(NEETO_FILTERS_SELECTORS.searchTermBlock)).toBeVisible();
+                await this.page.reload({ waitUntil: "load" });
+                await expect(this.page.getByTestId(COMMON_SELECTORS.pageLoader)).toBeHidden({ timeout: 10000 });
+                await expect(this.page.getByRole("cell", { name: searchTerm })).toBeVisible();
+                await expect(this.page.getByTestId(countSelector)).toContainText(countText);
+            }).toPass({ timeout: 15000 });
+        };
         this.page = page;
         this.responses = [];
         this.request = request;
@@ -13776,24 +13808,6 @@ const NEETO_EDITOR_SELECTORS = {
     submitLinkButton: "neeto-editor-add-link",
 };
 
-const NEETO_FILTERS_SELECTORS = {
-    emailSelectContainer: "email-select-container-wrapper",
-    filterPaneHeading: "neeto-filters-pane-header",
-    neetoFiltersEmailBlock: "neeto-filters-email-block",
-    neetoFiltersRoleBlock: "neeto-filters-role-block",
-    neetoFiltersBarClearButton: "neeto-filters-bar-clear-btn",
-    neetoFiltersNameFilterField: "neeto-filters-name-filter",
-    neetoFilterNameBlock: "neeto-filters-name-block",
-    roleSelectContainer: "role-select-container-wrapper",
-    filterButton: "neeto-filters-toggle-btn",
-    filtersClearButton: "neeto-filters-clear-btn",
-    filterDoneButton: "neeto-filters-done-btn",
-    filteredMembersCount: "ntm-filtered-members-count",
-    allMenubarBlock: "ntm-members-menubar-all-block",
-    filtersEmailFilter: "neeto-filters-email-filter",
-    paneModalCrossIcon: "neeto-filters-close-button",
-};
-
 const MEMBER_SELECTORS = {
     membersTab: "members-nav-tab",
     newButton: "ntm-add-member-button",
@@ -13844,7 +13858,7 @@ const ROLES_SELECTORS = {
     tableHeaderRoleTitle: "ntm-roles-table-header-role-title",
     permissionCheckbox: "ntm-roles-permission-checkbox",
     editRoleButton: "ntm-roles-table-edit-role-button",
-    deleteRoleButton: " ntm-roles-table-delete-role-button",
+    deleteRoleButton: "ntm-roles-table-delete-role-button",
     permissionCard: "ntm-roles-permission-card",
 };