@bigbinary/neeto-playwright-commons 1.11.20 → 1.12.0

package/index.cjs.js

@@ -141,6 +141,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",
@@ -3499,6 +3503,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) => {
@@ -3514,18 +3519,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.
@@ -3680,6 +3686,127 @@ 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, receivedAt, subject } = listItem;
+                const emailBody = Object.values(ramda.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,
+                    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.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 });
@@ -3733,6 +3860,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") => {
@@ -149256,6 +149388,7 @@ exports.ENVIRONMENT = ENVIRONMENT;
 exports.EXPANDED_FONT_SIZE = EXPANDED_FONT_SIZE;
 exports.EditorPage = EditorPage;
 exports.EmbedBase = EmbedBase;
+exports.FASTMAIL_ROUTES = FASTMAIL_ROUTES;
 exports.FONT_SIZE_SELECTORS = FONT_SIZE_SELECTORS;
 exports.GLOBAL_TRANSLATIONS_PATTERN = GLOBAL_TRANSLATIONS_PATTERN;
 exports.GOOGLE_CALENDAR_DATE_FORMAT = GOOGLE_CALENDAR_DATE_FORMAT;
@@ -149276,6 +149409,7 @@ exports.MEMBER_FORM_SELECTORS = MEMBER_FORM_SELECTORS;
 exports.MEMBER_SELECTORS = MEMBER_SELECTORS;
 exports.MEMBER_TEXTS = MEMBER_TEXTS;
 exports.MERGE_TAGS_SELECTORS = MERGE_TAGS_SELECTORS;
+exports.MailerUtils = MailerUtils;
 exports.MailosaurUtils = MailosaurUtils;
 exports.NEETO_AUTH_BASE_URL = NEETO_AUTH_BASE_URL;
 exports.NEETO_EDITOR_SELECTORS = NEETO_EDITOR_SELECTORS;