@bigbinary/neeto-playwright-commons 1.8.37 → 1.8.38

package/index.d.ts

@@ -1,5 +1,6 @@
 import * as _playwright_test from '@playwright/test';
 import { Page, APIRequestContext, Response, APIResponse, Fixtures, PlaywrightWorkerArgs, PlaywrightWorkerOptions, PlaywrightTestArgs, PlaywrightTestOptions, Browser, BrowserContext, FrameLocator, Locator, CDPSession } from '@playwright/test';
+import * as mailosaur_lib_models from 'mailosaur/lib/models';
 import MailosaurClient from 'mailosaur';
 import { I18nPlaywrightFixture } from 'playwright-i18next-fixture';
 import { TFunction } from 'i18next';
@@ -40,6 +41,11 @@ interface ApiRequestProps {
     method?: HttpMethods;
     params?: ParamProps;
 }
+interface WaitForPageLoadParams {
+    visiblityTimeout: number;
+    retryTimeout: number;
+    customPageContext: Page | undefined;
+}
 type ApiRequest = (props: ApiRequestProps & Record<string, unknown>) => Promise<APIResponse | undefined>;
 interface FieldValue {
     field: string;
@@ -67,22 +73,24 @@ declare class CustomCommands {
     executeRecursively: ExecuteRecursively;
     verifySuccessToast: ({ message, closeAfterVerification, }?: Partial<VerifySuccessToastParams>) => Promise<void>;
     reloadAndWait: (requestCount: number, customPageContext?: Page, interceptMultipleResponsesProps?: Partial<Omit<InterceptMultipleResponsesParams, "times">>) => Promise<void>;
+    waitForPageLoad: ({ visiblityTimeout, customPageContext, }: WaitForPageLoadParams) => Promise<void>;
     apiRequest: ApiRequest;
     selectOptionFromDropdown: ({ selectValueContainer, selectMenu, value, options, }: SelectOptionFromDropdownParams) => Promise<void>;
     verifyFieldValue: VerifyFieldValue;
 }
 
-interface FetchOtpFromEmailFilterParameters {
+interface EmailContentParams {
     email: string;
     subjectSubstring?: string;
     timeout?: number;
     receivedAfter?: Date;
 }
-type FetchOtpFromEmail = (props: FetchOtpFromEmailFilterParameters) => Promise<string | undefined>;
+type FetchOtpFromEmail = (props: EmailContentParams) => Promise<string | undefined>;
 declare class MailosaurUtils {
     mailosaur: MailosaurClient;
     serverId: string;
     constructor(mailosaur: MailosaurClient);
+    getEmailContent: ({ email, subjectSubstring, timeout, receivedAfter, }: EmailContentParams) => Promise<mailosaur_lib_models.Message>;
     fetchOtpFromEmail: FetchOtpFromEmail;
     generateRandomMailosaurEmail: () => string;
 }

package/index.js

@@ -2517,6 +2517,18 @@ class CustomCommands {
             await pageContext.reload();
             await reloadRequests;
         };
+        this.waitForPageLoad = async ({ visiblityTimeout = 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,
+                }),
+                expect(pageContext.getByTestId(COMMON_SELECTORS.spinner)).toBeHidden({
+                    timeout: visiblityTimeout,
+                }),
+            ]);
+        };
         this.apiRequest = async ({ url, failOnStatusCode = true, headers: additionalHeaders, body: data, method = "get", params = {}, ...otherOptions }) => {
             const csrfToken = await this.page
                 .locator("[name='csrf-token']")
@@ -2568,12 +2580,18 @@ class CustomCommands {
 
 class MailosaurUtils {
     constructor(mailosaur) {
+        this.getEmailContent = ({ email, subjectSubstring = "", timeout = 2 * 60 * 1000, receivedAfter = new Date(), }) => this.mailosaur.messages.get(this.serverId, { sentTo: email, subject: subjectSubstring }, { timeout, receivedAfter });
         this.fetchOtpFromEmail = async ({ email, subjectSubstring = OTP_EMAIL_PATTERN, timeout = 2 * 60 * 1000, receivedAfter = new Date(), }) => {
             var _a, _b, _c;
-            const receivedEmail = await this.mailosaur.messages.get(this.serverId, { sentTo: email, subject: subjectSubstring }, { timeout, receivedAfter });
+            const receivedEmail = await this.getEmailContent({
+                email,
+                subjectSubstring,
+                timeout,
+                receivedAfter,
+            });
             const otp = (_c = (_b = (_a = receivedEmail === null || receivedEmail === void 0 ? void 0 : receivedEmail.text) === null || _a === void 0 ? void 0 : _a.codes) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.value;
             if (isNil(otp)) {
-                throw new Error(`No codes found in the email with subject: ${receivedEmail.subject}. Please re-evaluate the filtering parameters.`);
+                throw new Error(`No codes found in the email with subject: ${receivedEmail === null || receivedEmail === void 0 ? void 0 : receivedEmail.subject}. Please re-evaluate the filtering parameters.`);
             }
             return otp;
         };