@bigbinary/neeto-playwright-commons 1.8.7 → 1.8.9

package/index.cjs.js

@@ -187,7 +187,7 @@ const COMMON_SELECTORS = {
 };
 
 class CustomCommands {
-    constructor(page, request) {
+    constructor(page, request, baseURL = process.env.BASE_URL) {
         this.interceptMultipleResponses = ({ responseUrl = "", times = 1, baseUrl, customPageContext, timeout = 35000, } = {}) => {
             const pageContext = customPageContext !== null && customPageContext !== void 0 ? customPageContext : this.page;
             return Promise.all([...new Array(times)].map(() => pageContext.waitForResponse((response) => {
@@ -195,9 +195,7 @@ class CustomCommands {
                 if (response.request().resourceType() === "xhr" &&
                     response.status() === 200 &&
                     response.url().includes(responseUrl) &&
-                    response
-                        .url()
-                        .startsWith((_a = baseUrl !== null && baseUrl !== void 0 ? baseUrl : process.env.BASE_URL) !== null && _a !== void 0 ? _a : "") &&
+                    response.url().startsWith((_a = baseUrl !== null && baseUrl !== void 0 ? baseUrl : this.baseURL) !== null && _a !== void 0 ? _a : "") &&
                     !this.responses.includes((_b = response.headers()) === null || _b === void 0 ? void 0 : _b["x-request-id"])) {
                     this.responses.push((_c = response.headers()) === null || _c === void 0 ? void 0 : _c["x-request-id"]);
                     return true;
@@ -229,11 +227,13 @@ class CustomCommands {
                 (await this.page.getByTestId(COMMON_SELECTORS.toastCloseButton).click());
             await test.expect(this.page.locator(COMMON_SELECTORS.toastIcon)).toBeHidden();
         };
-        this.reloadAndWait = async (requestCount) => {
+        this.reloadAndWait = async (requestCount, customPageContext, interceptMultipleResponsesProps = {}) => {
+            const pageContext = customPageContext !== null && customPageContext !== void 0 ? customPageContext : this.page;
             const reloadRequests = this.interceptMultipleResponses({
                 times: requestCount,
+                ...interceptMultipleResponsesProps,
             });
-            await this.page.reload();
+            await pageContext.reload();
             await reloadRequests;
         };
         this.apiRequest = async ({ url, failOnStatusCode = true, headers: additionalHeaders, body: data, method = "get", params = {}, ...otherOptions }) => {
@@ -269,6 +269,7 @@ class CustomCommands {
         this.page = page;
         this.responses = [];
         this.request = request;
+        this.baseURL = baseURL;
     }
 }
 
@@ -295,8 +296,8 @@ class MailosaurUtils {
 }
 
 const commands = {
-    neetoPlaywrightUtilities: async ({ page, request }, use) => {
-        const commands = new CustomCommands(page, request);
+    neetoPlaywrightUtilities: async ({ page, request, baseURL }, use) => {
+        const commands = new CustomCommands(page, request, baseURL);
         await use(commands);
     },
     mailosaur: async ({}, use) => {
@@ -323,11 +324,11 @@ const commands = {
 
 const generateStagingData = (product = "invoice") => {
     var _a;
-    const timestamp = `${dayjs__default["default"]().format("YYYYMMDDHH")}${(_a = process.env.JOB_COMPLETION_INDEX) !== null && _a !== void 0 ? _a : ""}`;
+    const timestamp = `${dayjs__default["default"]().format("MMDDHHmmssSSS")}${(_a = process.env.JOB_COMPLETION_INDEX) !== null && _a !== void 0 ? _a : ""}`;
     const firstName = "André";
     const lastName = "O'Reilly";
     const otpBypassKey = process.env.OTP_BYPASS_KEY;
-    const stagingOrganization = `cypresstest-${product}-${timestamp}`;
+    const stagingOrganization = `cpt-${product}-${timestamp}`;
     return {
         firstName,
         lastName,
@@ -339,7 +340,7 @@ const generateStagingData = (product = "invoice") => {
         businessName: stagingOrganization,
         subdomainName: IS_STAGING_ENV ? stagingOrganization : "spinkart",
         email: IS_STAGING_ENV
-            ? `cypresstest${otpBypassKey}+${product}+${timestamp}-playwright@bigbinary.com`
+            ? `cpt${otpBypassKey}+${product}+${timestamp}@bigbinary.com`
             : CREDENTIALS.email,
     };
 };
@@ -7189,6 +7190,7 @@ const ROUTES = {
     profile: "/profile",
     myProfile: "/my/profile",
     authSettings: "/settings",
+    webhooks: "/webhooks",
     login: `${BASE_URL}/login`,
     signup: `${BASE_URL}/signups`,
     subdomainAvailability: `${BASE_URL}/subdomain_availability`,
@@ -7209,6 +7211,9 @@ const API_ROUTES = {
         show: (id) => `/team_members/teams/${id}`,
     },
 };
+const THIRD_PARTY_ROUTES = {
+    webhooks: { site: "https://webhook.site/" },
+};
 
 const CHAT_WIDGET_TEXTS = {
     newConversation: "New Conversation",
@@ -7460,7 +7465,7 @@ class HelpAndProfilePage {
                 .replaceAll(" ", "then")
                 .replaceAll("+", "");
             return osPlatform === "mac"
-                ? formattedShortcut.replace(/ctrl/g, "⌘")
+                ? formattedShortcut.replace(/ctrl/g, "⌘").replace(/alt/g, "opt")
                 : formattedShortcut;
         };
         this.openAndVerifyKeyboardShortcutsPane = async (productShortcuts, osPlatform = "windows") => {
@@ -7653,6 +7658,72 @@ class HelpAndProfilePage {
     }
 }
 
+const WEBHOOK_SELECTORS = {
+    addNewWebhook: "add-new-webhook-button",
+    endpointInputField: "endpoint-input-field",
+    deliveryResponseCode: "delivery-response-code",
+    deliveryRequestPayload: "delivery-request-payload",
+};
+
+class WebhooksPage {
+    constructor({ page, request, neetoPlaywrightUtilities, context, }) {
+        this.getWebhookURL = async () => {
+            const webhookSitePage = await this.context.newPage();
+            await webhookSitePage.goto(THIRD_PARTY_ROUTES.webhooks.site);
+            await webhookSitePage.waitForURL(/.*#!\/\w+/);
+            const webhookToken = webhookSitePage.url().split("#!/")[1];
+            const webhookSiteURL = `${THIRD_PARTY_ROUTES.webhooks.site}${webhookToken}`;
+            await webhookSitePage.close();
+            return { webhookSiteURL, webhookToken };
+        };
+        this.addWebhook = async ({ webhookSiteURL }) => {
+            await this.page.getByTestId(WEBHOOK_SELECTORS.addNewWebhook).click();
+            await this.page
+                .getByTestId(WEBHOOK_SELECTORS.endpointInputField)
+                .fill(webhookSiteURL);
+            const addWebhook = this.neetoPlaywrightUtilities.interceptMultipleResponses({ responseUrl: ROUTES.webhooks, times: 2 });
+            await this.page.getByTestId(COMMON_SELECTORS.saveChangesButton).click();
+            await addWebhook;
+            await test.expect(this.page.getByRole("row", { name: webhookSiteURL })).toBeVisible();
+        };
+        this.verifyLatestWebhookResponse = async ({ callback = () => { }, webhookToken, ...otherParams }) => {
+            let response;
+            await test.expect(async () => {
+                response = await this.request.get(`https://webhook.site/token/${webhookToken}/request/latest`);
+                test.expect(response.status()).toBe(200);
+                if (response.status() === 200) {
+                    const { content } = await response.json();
+                    const parsedResponse = JSON.parse(content).webhook;
+                    callback({ parsedResponse, ...otherParams });
+                }
+            }).toPass({ timeout: 10000 });
+        };
+        this.verifyWebhookDeliveries = async ({ callback = () => { }, ...otherParams }) => {
+            await test.expect(this.page.getByTestId(WEBHOOK_SELECTORS.deliveryResponseCode)).toHaveText("200");
+            const requestPayload = (await this.page
+                .getByTestId(WEBHOOK_SELECTORS.deliveryRequestPayload)
+                .textContent());
+            const parsedResponse = JSON.parse(requestPayload).webhook;
+            callback({ parsedResponse, ...otherParams });
+        };
+        this.verifyWebhookDeliveryByEvent = async ({ event, callbackToVerifyDeliveries, ...fieldsToBeVerified }) => {
+            await this.page
+                .getByRole("row", { name: event })
+                .getByRole("button")
+                .click();
+            await this.verifyWebhookDeliveries({
+                callback: callbackToVerifyDeliveries,
+                ...fieldsToBeVerified,
+            });
+        };
+        this.page = page;
+        this.request = request;
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+        this.context = context;
+        this.t = playwrightI18nextFixture.getI18nInstance().t;
+    }
+}
+
 const SIGNUP_SELECTORS = {
     emailTextField: "signup-email-text-field",
     firstNameTextField: "signup-profile-first-name-text-field",
@@ -7669,7 +7740,7 @@ const SIGNUP_SELECTORS = {
 };
 
 const extractSubdomainFromError = (errorString) => {
-    const regex = /cypresstest[a-zA-Z0-9-]+/g;
+    const regex = /cpt[a-zA-Z0-9-]+/g;
     const matches = errorString.match(regex);
     return matches[1];
 };
@@ -7914,6 +7985,9 @@ const ROLES_SELECTORS = {
     headerColumn: "ntm-roles-table-header",
     dropDownIcon: "ntm-roles-table-header-role-dropdown-button",
     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",
 };
 
 const TAGS_SELECTORS = {
@@ -8599,7 +8673,9 @@ exports.ROUTES = ROUTES;
 exports.SIGNUP_SELECTORS = SIGNUP_SELECTORS;
 exports.STORAGE_STATE = STORAGE_STATE;
 exports.TAGS_SELECTORS = TAGS_SELECTORS;
+exports.THIRD_PARTY_ROUTES = THIRD_PARTY_ROUTES;
 exports.USER_AGENTS = USER_AGENTS;
+exports.WebhooksPage = WebhooksPage;
 exports.clearCredentials = clearCredentials;
 exports.commands = commands;
 exports.definePlaywrightConfig = definePlaywrightConfig;