@bigbinary/neeto-playwright-commons 1.8.7 → 1.8.9

package/index.d.ts

@@ -1,5 +1,5 @@
 import * as _playwright_test from '@playwright/test';
-import { Page, APIRequestContext, Response, APIResponse, Fixtures, PlaywrightWorkerArgs, PlaywrightWorkerOptions, PlaywrightTestArgs, PlaywrightTestOptions, Locator, FrameLocator } from '@playwright/test';
+import { Page, APIRequestContext, Response, APIResponse, Fixtures, PlaywrightWorkerArgs, PlaywrightWorkerOptions, PlaywrightTestArgs, PlaywrightTestOptions, Locator, FrameLocator, BrowserContext } from '@playwright/test';
 import MailosaurClient from 'mailosaur';
 import { I18nPlaywrightFixture } from 'playwright-i18next-fixture';
 import { TFunction } from 'i18next';
@@ -43,12 +43,13 @@ declare class CustomCommands {
     page: Page;
     responses: string[];
     request: APIRequestContext;
-    constructor(page: Page, request: APIRequestContext);
+    baseURL: string | undefined;
+    constructor(page: Page, request: APIRequestContext, baseURL?: string | undefined);
     interceptMultipleResponses: ({ responseUrl, times, baseUrl, customPageContext, timeout, }?: Partial<InterceptMultipleResponsesParams>) => Promise<Response[]>;
     private recursiveMethod;
     executeRecursively: ExecuteRecursively;
     verifySuccessToast: ({ message, closeAfterVerification, }?: Partial<VerifySuccessToastParams>) => Promise<void>;
-    reloadAndWait: (requestCount: number) => Promise<void>;
+    reloadAndWait: (requestCount: number, customPageContext?: Page, interceptMultipleResponsesProps?: Partial<Omit<InterceptMultipleResponsesParams, "times">>) => Promise<void>;
     apiRequest: ApiRequest;
     verifyFieldValue: VerifyFieldValue;
 }
@@ -140,6 +141,43 @@ declare class HelpAndProfilePage {
     verifyLogoutV2: () => Promise<void>;
 }
 
+interface WebhooksPageParams {
+    page: Page;
+    request: APIRequestContext;
+    neetoPlaywrightUtilities: CustomCommands;
+    context: BrowserContext;
+}
+type CallbackFunction = (args: Record<string, unknown>) => void;
+interface VerifyWebhookResponseParams extends Record<string, unknown> {
+    callback?: CallbackFunction;
+    webhookToken: string;
+}
+interface VerifyWebhookDeliveriesParams extends Record<string, unknown> {
+    callback: CallbackFunction;
+}
+interface VerifyWebhookDeliveryByEventParams extends Record<string, unknown> {
+    event: string;
+    callbackToVerifyDeliveries: (args: Record<string, unknown>) => void;
+}
+declare class WebhooksPage {
+    page: Page;
+    request: APIRequestContext;
+    context: BrowserContext;
+    neetoPlaywrightUtilities: CustomCommands;
+    t: TFunction;
+    constructor({ page, request, neetoPlaywrightUtilities, context, }: WebhooksPageParams);
+    getWebhookURL: () => Promise<{
+        webhookSiteURL: string;
+        webhookToken: string;
+    }>;
+    addWebhook: ({ webhookSiteURL }: {
+        webhookSiteURL: string;
+    }) => Promise<void>;
+    verifyLatestWebhookResponse: ({ callback, webhookToken, ...otherParams }: VerifyWebhookResponseParams) => Promise<void>;
+    verifyWebhookDeliveries: ({ callback, ...otherParams }: VerifyWebhookDeliveriesParams) => Promise<void>;
+    verifyWebhookDeliveryByEvent: ({ event, callbackToVerifyDeliveries, ...fieldsToBeVerified }: VerifyWebhookDeliveryByEventParams) => Promise<void>;
+}
+
 interface CreateOrganizationProps {
     email: string;
     businessName: string;
@@ -188,6 +226,7 @@ declare const ROUTES: {
     profile: string;
     myProfile: string;
     authSettings: string;
+    webhooks: string;
     login: string;
     signup: string;
     subdomainAvailability: string;
@@ -208,6 +247,11 @@ declare const API_ROUTES: {
         show: (id: string) => string;
     };
 };
+declare const THIRD_PARTY_ROUTES: {
+    webhooks: {
+        site: string;
+    };
+};
 
 declare const COMMON_SELECTORS: {
     spinner: string;
@@ -378,6 +422,9 @@ declare const ROLES_SELECTORS: {
     headerColumn: string;
     dropDownIcon: string;
     tableHeaderRoleTitle: string;
+    permissionCheckbox: string;
+    editRoleButton: string;
+    deleteRoleButton: string;
 };
 
 declare const SIGNUP_SELECTORS: {
@@ -526,4 +573,4 @@ interface Overrides {
 }
 declare const definePlaywrightConfig: (overrides: Overrides) => _playwright_test.PlaywrightTestConfig<{}, {}>;
 
-export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, IS_STAGING_ENV, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, TAGS_SELECTORS, USER_AGENTS, clearCredentials, commands, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, getGlobalUserState, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, updateCredentials, writeDataToFile };
+export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, IS_STAGING_ENV, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, TAGS_SELECTORS, THIRD_PARTY_ROUTES, USER_AGENTS, WebhooksPage, clearCredentials, commands, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, getGlobalUserState, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, updateCredentials, writeDataToFile };

package/index.js

@@ -152,7 +152,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) => {
@@ -160,9 +160,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;
@@ -194,11 +192,13 @@ class CustomCommands {
                 (await this.page.getByTestId(COMMON_SELECTORS.toastCloseButton).click());
             await 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 }) => {
@@ -234,6 +234,7 @@ class CustomCommands {
         this.page = page;
         this.responses = [];
         this.request = request;
+        this.baseURL = baseURL;
     }
 }
 
@@ -260,8 +261,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) => {
@@ -288,11 +289,11 @@ const commands = {
 
 const generateStagingData = (product = "invoice") => {
     var _a;
-    const timestamp = `${dayjs().format("YYYYMMDDHH")}${(_a = process.env.JOB_COMPLETION_INDEX) !== null && _a !== void 0 ? _a : ""}`;
+    const timestamp = `${dayjs().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,
@@ -304,7 +305,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,
     };
 };
@@ -7154,6 +7155,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`,
@@ -7174,6 +7176,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",
@@ -7425,7 +7430,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") => {
@@ -7618,6 +7623,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 expect(this.page.getByRole("row", { name: webhookSiteURL })).toBeVisible();
+        };
+        this.verifyLatestWebhookResponse = async ({ callback = () => { }, webhookToken, ...otherParams }) => {
+            let response;
+            await expect(async () => {
+                response = await this.request.get(`https://webhook.site/token/${webhookToken}/request/latest`);
+                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 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 = getI18nInstance().t;
+    }
+}
+
 const SIGNUP_SELECTORS = {
     emailTextField: "signup-email-text-field",
     firstNameTextField: "signup-profile-first-name-text-field",
@@ -7634,7 +7705,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];
 };
@@ -7879,6 +7950,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 = {
@@ -8534,5 +8608,5 @@ const definePlaywrightConfig = (overrides) => {
     });
 };
 
-export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, IS_STAGING_ENV, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, TAGS_SELECTORS, USER_AGENTS, clearCredentials, commands, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, getGlobalUserState, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, updateCredentials, writeDataToFile };
+export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, IS_STAGING_ENV, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, TAGS_SELECTORS, THIRD_PARTY_ROUTES, USER_AGENTS, WebhooksPage, clearCredentials, commands, definePlaywrightConfig, extractSubdomainFromError, generateStagingData, getGlobalUserState, hyphenize, i18nFixture, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, updateCredentials, writeDataToFile };
 //# sourceMappingURL=index.js.map