@bigbinary/neeto-playwright-commons 1.11.20 → 1.12.1

package/index.d.ts

@@ -22,7 +22,6 @@ interface ExecuteRecursivelyParams {
   condition: GenericCallback;
   timeout: number;
 }
-type ExecuteRecursively = (params: ExecuteRecursivelyParams) => Promise<void>;
 interface VerifySuccessToastParams {
   message: string;
   closeAfterVerification: boolean;
@@ -85,6 +84,7 @@ declare class CustomCommands {
   request: APIRequestContext;
   baseURL: string | undefined;
   constructor(page: Page, request: APIRequestContext, baseURL?: string | undefined);
+  private waitUntilTimeout;
   /**
    *
    * Command to wait until a response with URL responseUrl is found. Optionally,
@@ -130,7 +130,11 @@ declare class CustomCommands {
    *  });
    * @endexample
   */
-  executeRecursively: ExecuteRecursively;
+  executeRecursively: ({
+    callback,
+    condition,
+    timeout
+  }: ExecuteRecursivelyParams) => Promise<unknown>;
   /**
    * @deprecated Use verifyToast instead.
    */
@@ -362,6 +366,223 @@ declare class CustomCommands {
     content: string;
   }) => Promise<void>;
 }
+type Range<N extends number, Acc extends number[] = []> = Acc["length"] extends N ? Exclude<Acc[number], 0 | Acc["length"]> | N : Range<N, [...Acc, Acc["length"]]>;
+interface MessageSearchCriteria {
+  from: string;
+  to: string;
+  subject: string;
+  body: string;
+}
+interface FindMessageFilterOptions {
+  receivedAfter: Date;
+  timeout: number;
+}
+interface Identifier {
+  name: string;
+  email: string;
+}
+interface FindOtpFromEmailParams {
+  email: string;
+  subjectSubstring?: string;
+  timeout?: number;
+  receivedAfter?: Date;
+}
+interface ListMessagesFilterCriteria {
+  receivedAfter: Date;
+  page: number;
+  itemsPerPage: Range<100>;
+}
+interface MessageInferredData {
+  links: string[] | null;
+  codes: string[] | null;
+  body: string;
+}
+interface FormattedList {
+  html: MessageInferredData;
+  text: MessageInferredData;
+  id: string;
+  from: Identifier[];
+  to: Identifier[];
+  cc: Identifier[];
+  bcc: Identifier[];
+  replyTo: Identifier[];
+  received: string;
+  subject: string;
+}
+declare class MailerUtils {
+  private neetoPlaywrightUtilities;
+  private fastmailHeaders;
+  accountId: string | undefined;
+  constructor(neetoPlaywrightUtilities: CustomCommands);
+  /**
+   *
+   * Used to authorize the Fastmail API and get the account details. There is usually no need to call this method since this is invoked when the fixture is setup and will save the credentials for all the future callback of mailerUtils methods.
+   *
+   * This method doesn't accept any arguments and doesn't return anything.
+   *
+  */
+  authorizeAndSetAccountId: () => Promise<void>;
+  private fastmailApiRequest;
+  private queryEmail;
+  private getEmails;
+  /**
+   *
+   * This method is used to list a set of messages matching a specific search criteria. It immediately returns the available list of messages matching the search criteria and doesn't wait until a matching message is found. Due to this reason delays in email deliveries should be accounted while using this method. This method is useful in asserting negative test cases and asserting a list of emails matching a certain pattern.
+   *
+   * Note: If the intention is to find a matching message within a certain time frame, prefer using the findMessage method.
+   *
+   * messageSearchCriteria: An object containing the search criteria for matching the messages. The object can contain the keys, from, to, subject and body. All the keys of the object are optional. The values of the object are of string type and are case-insensitive. The following key-value pairs can be used:
+   *
+   * from: The complete email address from which the email was sent.
+   *
+   * to: The complete email address to which the email was sent to.
+   *
+   * subject: A complete string or a substring used to match the subject of the email.
+   *
+   * body: A complete string or a substring used to match the body of the email.
+   *
+   * messageFilterCriteria (optional): An object containing the criteria which are used to filter the messages that match the search criteria. The object can contain the keys receivedAfter, page and itemsPerPage. The following key-value pairs can be used:
+   *
+   * receivedAfter: A JavaScript Date object used to filter the matching messages on the date-time of email delivery. Defaults to one hour before the method call.
+   *
+   * page: A number specifying the page number for paginating the results. Starts from 1 (default value). If a page number greater than the total number of matching emails is specified, an empty array will be returned.
+   *
+   * itemsPerPage: A number specifying the number of results per page. Default value is 50. The value can range from 1 to 100.
+   *
+   * Returns an array of objects with details about the emails matching the search and filter criteria. The object will have the following shape.
+   *
+   * html: Contains an object with the codes (Array of number strings having length greater than or equal to 4 in the email), links (Array of links in the email) and the body of the email with the HTML tags intact.
+   *
+   * text: Contains an object with the codes (Array of number strings having length greater than or equal to 4 in the email), links (Array of links in the email) and the body of the email with the HTML tags stripped off.
+   *
+   * id: A unique identifier string used to identify the email.
+   *
+   * from: An array of objects containing the name and email of the sender of the email.
+   *
+   * to: An array of objects containing the name and email of the receiver of the email.
+   *
+   * cc: An array of objects containing the name and email of the sender of the email as part of the cc list.
+   *
+   * replyTo: An array of objects containing the name and email of the individuals to whom replies should be directed.
+   *
+   * bcc: An array of objects containing the name and email of the recipients of the email as part of the bcc list.
+   *
+   * received: A JavaScript Date object containing the date-time of the email delivery.
+   *
+   * subject: A string containing the subject of the email.
+   *
+   * @example 
+   *
+   * test("sample test", async ({ mailerUtils }) => {
+   *   const message = await mailerUtils.listMessages({
+   *     to: fastmailEmailId,
+   *     from: senderEmailId,
+   *     subject: "login code",
+   *     body: "neeto",
+   *   }, {
+   *     receivedAfter: new Date(),
+   *     page: 1,
+   *     itemsPerPage: 50,
+   *   });
+   * });
+   * @endexample
+  */
+  listMessages: (messageSearchCriteria?: Partial<MessageSearchCriteria> | undefined, listMessagesFilterCriteria?: Partial<ListMessagesFilterCriteria> | undefined) => Promise<FormattedList[]>;
+  /**
+   *
+   * This method is used to find a first email matching the search criteria. On top of the listMessage method, this method waits until a specific mail is received or the timeout is exceeded. This method is useful for fetching an email once an action is triggered since it waits for the message delivery and can be customized according to delays in email deliveries.
+   *
+   * messageSearchCriteria: An object containing the search criteria for matching the messages. The object can contain the keys, from, to, subject and body. All the keys of the object are optional. The values of the object are of string type and are case-insensitive. The following key-value pairs can be used:
+   *
+   * from: The complete email address from which the email was sent.
+   *
+   * to: The complete email address to which the email was sent to.
+   *
+   * subject: A complete string or a substring used to match the subject of the email.
+   *
+   * body: A complete string or a substring used to match the body of the email.
+   *
+   * messageFilterCriteria (optional): An object containing the criteria which are used to filter the messages that match the search criteria. The object can contain the keys receivedAfter, page and itemsPerPage. The following key-value pairs can be used:
+   *
+   * receivedAfter: A JavaScript Date object used to filter the matching messages on the date-time of email delivery. Defaults to one hour before the method call.
+   *
+   * timeout: A number indicating the number of milliseconds to retry fetching the message before timing out. Defaults to 10 seconds.
+   *
+   * shouldThrowErrorOnTimeout (optional): A boolean value indicating whether the method show throw an error if a matching message is not found within the timeout time. If set to false, no error is thrown if the timeout is exceeded and just returns an empty object. Defaults to true.
+   *
+   * Returns an object with details about the first email matching the search and filter criteria. The object will have the following shape.
+   *
+   * html: Contains an object with the codes (Array of number strings having length greater than or equal to 4 in the email), links (Array of links in the email) and the body of the email with the HTML tags intact.
+   *
+   * text: Contains an object with the codes (Array of number strings having length greater than or equal to 4 in the email), links (Array of links in the email) and the body of the email with the HTML tags stripped off.
+   *
+   * id: A unique identifier string used to identify the email.
+   *
+   * from: An array of objects containing the name and email of the sender of the email.
+   *
+   * to: An array of objects containing the name and email of the receiver of the email.
+   *
+   * cc: An array of objects containing the name and email of the sender of the email as part of the cc list.
+   *
+   * replyTo: An array of objects containing the name and email of the individuals to whom replies should be directed.
+   *
+   * bcc: An array of objects containing the name and email of the recipients of the email as part of the bcc list.
+   *
+   * received: A JavaScript Date object containing the date-time of the email delivery.
+   *
+   * subject: A string containing the subject of the email.
+   *
+   * @example 
+   *
+   * test("sample test", async ({ mailerUtils }) => {
+   *   const message = await mailerUtils.listMessages({
+   *     to: fastmailEmailId,
+   *     from: senderEmailId,
+   *     subject: "login code",
+   *     body: "neeto",
+   *   }, {
+   *     receivedAfter: new Date(),
+   *     timeout: 60 * 1000,
+   *   }, false);
+   * });
+   * @endexample
+  */
+  findMessage: (messageSearchCriteria?: Partial<MessageSearchCriteria>, {
+    timeout,
+    receivedAfter
+  }?: Partial<FindMessageFilterOptions> | undefined, shouldThrowErrorOnTimeout?: boolean) => Promise<FormattedList | Record<string, never>>;
+  /**
+   *
+   * A helper method that is used to find the first code value from the matching email body. This method has been built to match the Neeto OTP emails.
+   *
+   * The method accepts the following named arguments:
+   *
+   * email: The recipient email address used to find the email
+   *
+   * subjectSubstring: The subject of the email used to match it. Defaults to the string is your login code to match Neeto OTP emails
+   *
+   * timeout: The timeout duration number in milliseconds, which when exceeded without finding matching emails, the method throws an error. Default to 2 minutes.
+   *
+   * receivedAfter: = A JavaScript Date object used to filter the matching messages on the date-time of email delivery. Defaults to the time of method call.
+   *
+   * The method returns the OTP as a string from the matching email.
+   *
+  */
+  findOtpFromEmail: ({
+    email,
+    subjectSubstring,
+    timeout,
+    receivedAfter
+  }: FindOtpFromEmailParams) => Promise<string | undefined>;
+  /**
+   *
+   * Generates a random Fastmail email based on the value of the FASTMAIL_DOMAIN_NAME environment variable.
+   *
+   * Returns a random mixed-cased email ending with the FASTMAIL_DOMAIN_NAME.
+   *
+  */
+  generateRandomEmail: () => string;
+}
 interface EmailContentParams {
   email: string;
   subjectSubstring?: string;
@@ -460,6 +681,7 @@ interface CustomFixture {
   page: Page;
   mailosaur: MailosaurClient;
   mailosaurUtils: MailosaurUtils;
+  mailerUtils: MailerUtils;
 }
 type Commands = Fixtures<CustomFixture, PlaywrightWorkerArgs & PlaywrightWorkerOptions, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
 declare const commands: Commands;
@@ -2971,6 +3193,10 @@ declare const THIRD_PARTY_ROUTES: {
 declare const NEETO_ROUTES: {
   imageUploader: string;
 };
+declare const FASTMAIL_ROUTES: {
+  authorize: string;
+  api: string;
+};
 declare const networkConditions: Record<"Slow 3G" | "Fast 3G" | "No Throttling", Protocol.Network.emulateNetworkConditionsParameters>;
 /**
  *
@@ -5444,4 +5670,4 @@ interface Overrides {
  * @endexample
 */
 declare const definePlaywrightConfig: (overrides: Overrides) => _playwright_test.PlaywrightTestConfig<{}, {}>;
-export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_LABEL, ENVIRONMENT, EXPANDED_FONT_SIZE, EditorPage, EmbedBase, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, GOOGLE_CALENDAR_DATE_FORMAT, GOOGLE_LOGIN_TEXTS, GooglePage, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, ImageUploader, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PLURAL, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SELECT_COUNTRY, SIGNUP_SELECTORS, SINGULAR, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TAB_SELECTORS, TAGS_SELECTORS, TEXT_MODIFIER_ROLES, TEXT_MODIFIER_SELECTORS, TEXT_MODIFIER_TAGS, THANK_YOU_SELECTORS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, TagsPage, TeamMembers, ThankYouPage, USER_AGENTS, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, currencyUtils, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, filterUtils, generateRandomBypassEmail, generateStagingData, getByDataQA, getGlobalUserState, getImagePathAndName, getListCount, headerUtils, hexToRGB, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };
+export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_LABEL, ENVIRONMENT, EXPANDED_FONT_SIZE, EditorPage, EmbedBase, FASTMAIL_ROUTES, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, GOOGLE_CALENDAR_DATE_FORMAT, GOOGLE_LOGIN_TEXTS, GooglePage, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, ImageUploader, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailerUtils, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PLURAL, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SELECT_COUNTRY, SIGNUP_SELECTORS, SINGULAR, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TAB_SELECTORS, TAGS_SELECTORS, TEXT_MODIFIER_ROLES, TEXT_MODIFIER_SELECTORS, TEXT_MODIFIER_TAGS, THANK_YOU_SELECTORS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, TagsPage, TeamMembers, ThankYouPage, USER_AGENTS, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, currencyUtils, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, filterUtils, generateRandomBypassEmail, generateStagingData, getByDataQA, getGlobalUserState, getImagePathAndName, getListCount, headerUtils, hexToRGB, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };

package/index.js

@@ -4,7 +4,7 @@ import * as Path from 'path';
 import Path__default from 'path';
 import { execSync } from 'child_process';
 import test$1, { expect, test as test$2, defineConfig, devices } from '@playwright/test';
-import { curry, not, isEmpty as isEmpty$1, isNil, isNotNil, mergeDeepLeft, mergeAll } from 'ramda';
+import { curry, not, isEmpty as isEmpty$1, pluck, isNil, isNotNil, mergeDeepLeft, mergeAll } from 'ramda';
 import require$$0$1 from 'util';
 import { faker } from '@faker-js/faker';
 import MailosaurClient from 'mailosaur';
@@ -94,6 +94,10 @@ const THIRD_PARTY_ROUTES = {
 const NEETO_ROUTES = {
     imageUploader: "/neeto_image_uploader_engine",
 };
+const FASTMAIL_ROUTES = {
+    authorize: "https://api.fastmail.com/.well-known/jmap",
+    api: "https://api.fastmail.com/jmap/api/",
+};
 
 const ENVIRONMENT = {
     development: "development",
@@ -3452,6 +3456,7 @@ const getImagePathAndName = (localImagePath) => {
 
 class CustomCommands {
     constructor(page, request, baseURL = process.env.BASE_URL) {
+        this.waitUntilTimeout = (timeout) => new Promise(resolve => setTimeout(resolve, timeout));
         this.interceptMultipleResponses = ({ responseUrl = "", responseStatus = 200, 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) => {
@@ -3467,18 +3472,19 @@ class CustomCommands {
                 return false;
             }, { timeout })));
         };
-        this.recursiveMethod = async (callback, condition, timeout, startTime) => {
+        this.recursiveMethod = async (callback, condition, timeout, startTime, iteration) => {
             if (Date.now() - timeout >= startTime) {
                 return false;
             }
             else if (await condition()) {
                 return await callback();
             }
-            return await this.recursiveMethod(callback, condition, timeout, startTime);
+            await this.waitUntilTimeout(Math.pow(2, iteration) * 1000);
+            return await this.recursiveMethod(callback, condition, timeout, startTime, iteration + 1);
         };
         this.executeRecursively = async ({ callback, condition, timeout = 5000, }) => {
             const startTime = Date.now();
-            await this.recursiveMethod(callback, condition, timeout, startTime);
+            return await this.recursiveMethod(callback, condition, timeout, startTime, 1);
         };
         /**
          * @deprecated Use verifyToast instead.
@@ -3633,6 +3639,128 @@ class CustomCommands {
     }
 }
 
+const dateTimeOneHourAgo = () => new Date(new Date().valueOf() - 60 * 60 * 1000);
+class MailerUtils {
+    constructor(neetoPlaywrightUtilities) {
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+        this.authorizeAndSetAccountId = async () => {
+            const response = await this.neetoPlaywrightUtilities.apiRequest({
+                method: "get",
+                url: FASTMAIL_ROUTES.authorize,
+                headers: this.fastmailHeaders,
+            });
+            const { primaryAccounts: { "urn:ietf:params:jmap:mail": accountId }, } = await response.json();
+            this.accountId = accountId;
+        };
+        this.fastmailApiRequest = async (method, body) => {
+            const response = await this.neetoPlaywrightUtilities.apiRequest({
+                method: "post",
+                url: FASTMAIL_ROUTES.api,
+                headers: this.fastmailHeaders,
+                data: {
+                    using: ["urn:ietf:params:jmap:core", "urn:ietf:params:jmap:mail"],
+                    methodCalls: [[method, { accountId: this.accountId, ...body }, "0"]],
+                },
+            });
+            return response === null || response === void 0 ? void 0 : response.json();
+        };
+        this.queryEmail = async (messageSearchCriteria, { receivedAfter = dateTimeOneHourAgo(), page = 1, itemsPerPage = 50, }) => {
+            const limit = itemsPerPage;
+            const position = (page - 1) * itemsPerPage;
+            if (itemsPerPage > 100 || itemsPerPage < 1)
+                throw new Error("itemsPerPage should be in the range of 1-100");
+            const body = {
+                filter: { ...messageSearchCriteria, after: receivedAfter.toISOString() },
+                sort: [{ property: "receivedAt", isAscending: false }],
+                limit,
+                position,
+            };
+            const { methodResponses: [[, { ids, total }]], } = await this.fastmailApiRequest("Email/query", body);
+            return { ids, total };
+        };
+        this.getEmails = async (ids) => {
+            const messageDetailsBody = {
+                ids,
+                bodyProperties: ["type"],
+                fetchHTMLBodyValues: true,
+            };
+            const { methodResponses: [[, { list }]], } = await this.fastmailApiRequest("Email/get", messageDetailsBody);
+            const formattedList = list.map((listItem) => {
+                const { id, from, to, bodyValues, cc, bcc, replyTo, receivedAt, subject, } = listItem;
+                const emailBody = Object.values(pluck("value", bodyValues)).join(" ");
+                const emailBodyWithStrippedHead = emailBody.split("</head>").at(-1);
+                const links = emailBodyWithStrippedHead.match(/(http|ftp|https):\/\/([\w_-]+(?:(?:\.[\w_-]+)+))([\w.,@?^=%&:/~+#-]*[\w@?^=%&/~+#-])/g);
+                const codes = emailBodyWithStrippedHead.match(/(?<![#/])\b\d{4,}\b/g);
+                const contentRecognitions = {
+                    links: links && [...links],
+                    codes: codes && [...codes],
+                };
+                const html = {
+                    body: emailBody,
+                    ...contentRecognitions,
+                };
+                const text = {
+                    body: emailBody.replace(/<\/[^>]+(>|$)/g, ""),
+                    ...contentRecognitions,
+                };
+                return {
+                    html,
+                    text,
+                    id,
+                    from,
+                    to,
+                    cc,
+                    bcc,
+                    replyTo,
+                    received: new Date(receivedAt),
+                    subject,
+                };
+            });
+            return formattedList;
+        };
+        this.listMessages = async (messageSearchCriteria = {}, listMessagesFilterCriteria = {}) => {
+            const { ids } = await this.queryEmail(messageSearchCriteria, listMessagesFilterCriteria);
+            return this.getEmails(ids);
+        };
+        this.findMessage = async (messageSearchCriteria = {}, { timeout = 10000, receivedAfter = dateTimeOneHourAgo(), } = {}, shouldThrowErrorOnTimeout = true) => {
+            const ids = (await this.neetoPlaywrightUtilities.executeRecursively({
+                callback: async () => {
+                    const { ids } = await this.queryEmail(messageSearchCriteria, {
+                        receivedAfter,
+                    });
+                    return ids;
+                },
+                condition: async () => {
+                    const { total } = await this.queryEmail(messageSearchCriteria, {
+                        receivedAfter,
+                    });
+                    return total > 0;
+                },
+                timeout,
+            }));
+            if (!ids) {
+                if (shouldThrowErrorOnTimeout)
+                    throw new Error("Timed out waiting for matching message");
+                return {};
+            }
+            return (await this.getEmails(ids))[0];
+        };
+        this.findOtpFromEmail = async ({ email, subjectSubstring = OTP_EMAIL_PATTERN, timeout = 2 * 60 * 1000, receivedAfter = new Date(), }) => {
+            const { html: { codes }, } = await this.findMessage({ to: email, subject: subjectSubstring }, { timeout, receivedAfter });
+            return codes === null || codes === void 0 ? void 0 : codes[0];
+        };
+        this.generateRandomEmail = () => faker.internet.email({
+            provider: process.env.FASTMAIL_DOMAIN_NAME,
+        });
+        if (!process.env.NEETO_AUTOMATION_FASTMAIL_API_KEY)
+            throw new Error("Please set the environment variable NEETO_AUTOMATION_FASTMAIL_API_KEYS. Credentials can be found in the Automation Credentials vault in the BigBinary 1Password account.");
+        this.fastmailHeaders = {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${process.env.NEETO_AUTOMATION_FASTMAIL_API_KEY}`,
+        };
+    }
+}
+
 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 });
@@ -3686,6 +3814,11 @@ const commands = {
         const mailosaurUtils = new MailosaurUtils(mailosaur);
         await use(mailosaurUtils);
     },
+    mailerUtils: async ({ neetoPlaywrightUtilities }, use) => {
+        const mailerUtils = new MailerUtils(neetoPlaywrightUtilities);
+        await mailerUtils.authorizeAndSetAccountId();
+        await use(mailerUtils);
+    },
 };
 
 const generateStagingData = (product = "invoice") => {
@@ -149194,5 +149327,5 @@ const definePlaywrightConfig = (overrides) => {
     });
 };
 
-export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_LABEL, ENVIRONMENT, EXPANDED_FONT_SIZE, EditorPage, EmbedBase, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, GOOGLE_CALENDAR_DATE_FORMAT, GOOGLE_LOGIN_TEXTS, GooglePage, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, ImageUploader, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PLURAL, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SELECT_COUNTRY, SIGNUP_SELECTORS, SINGULAR, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TAB_SELECTORS, TAGS_SELECTORS, TEXT_MODIFIER_ROLES, TEXT_MODIFIER_SELECTORS, TEXT_MODIFIER_TAGS, THANK_YOU_SELECTORS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, TagsPage, TeamMembers, ThankYouPage, USER_AGENTS, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, currencyUtils, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, filterUtils, generateRandomBypassEmail, generateStagingData, getByDataQA, getGlobalUserState, getImagePathAndName, getListCount, headerUtils, hexToRGB, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, stealth as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };
+export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_LABEL, ENVIRONMENT, EXPANDED_FONT_SIZE, EditorPage, EmbedBase, FASTMAIL_ROUTES, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, GOOGLE_CALENDAR_DATE_FORMAT, GOOGLE_LOGIN_TEXTS, GooglePage, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, ImageUploader, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailerUtils, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PLURAL, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SELECT_COUNTRY, SIGNUP_SELECTORS, SINGULAR, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TAB_SELECTORS, TAGS_SELECTORS, TEXT_MODIFIER_ROLES, TEXT_MODIFIER_SELECTORS, TEXT_MODIFIER_TAGS, THANK_YOU_SELECTORS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, TagsPage, TeamMembers, ThankYouPage, USER_AGENTS, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, currencyUtils, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, filterUtils, generateRandomBypassEmail, generateStagingData, getByDataQA, getGlobalUserState, getImagePathAndName, getListCount, headerUtils, hexToRGB, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, stealth as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };
 //# sourceMappingURL=index.js.map