@bigbinary/neeto-playwright-commons 4.2.3 → 4.2.4

package/index.d.ts

@@ -898,6 +898,7 @@ interface RailsEmail {
   htmlBody?: string;
   textBody?: string;
   receivedAt: string;
+  messageId?: string;
   attachments?: RailsEmailAttachment[];
 }
 interface BaseRailsEmailSearchParams {
@@ -1249,6 +1250,7 @@ interface FormattedList$1 {
   subject: string;
   attachments: Attachment$1[];
   blobId: string;
+  messageId?: string;
 }
 interface AttachmentDetails$1 {
   filename: string | null;
@@ -1263,7 +1265,7 @@ declare class RailsEmailUtils {
   private convertRailsEmailToFormattedList;
   clearEmails: () => Promise<unknown>;
   clearStaleEmails: () => Promise<unknown>;
-  getLatestEmail: (searchParams: RailsEmailSearchParams) => Promise<void>;
+  getLatestEmail: (searchParams: RailsEmailSearchParams) => Promise<RailsEmail | null>;
   listEmails: (searchParams?: RailsEmailSearchParams) => Promise<RailsEmail[]>;
   /**
    *
@@ -1403,6 +1405,10 @@ declare class RailsEmailUtils {
     receivedAfter,
     expectedEmailCount
   }?: Partial<FindMessageFilterOptions$1> | undefined, shouldThrowErrorOnTimeout?: boolean) => Promise<FormattedList$1 | Record<string, never>>;
+  getLatestMessageId: (subject: string, {
+    timeout,
+    receivedAfter
+  }?: Partial<FindMessageFilterOptions$1> | undefined) => Promise<string | undefined>;
   /**
    *
    * 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.
@@ -1615,6 +1621,7 @@ interface FormattedList {
   subject: string;
   attachments: Attachment[];
   blobId: string;
+  messageId?: string;
 }
 declare class MailerUtils {
   private neetoPlaywrightUtilities;
@@ -1800,6 +1807,10 @@ declare class MailerUtils {
    *
   */
   generateRandomEmail: () => string;
+  getLatestMessageId: (subject: string, {
+    timeout,
+    receivedAfter
+  }?: Partial<FindMessageFilterOptions> | undefined) => Promise<string | undefined>;
   /**
    *
    * This method is used to return an attachment from the first email matching the search criteria. It supports filtering attachments by name, by MIME content-type, or both. If no matching attachment is found, an error is thrown.

package/index.js

@@ -351,6 +351,7 @@ class RailsEmailApiClient {
         htmlBody: raw.html_body,
         textBody: raw.text_body,
         receivedAt: raw.received_at,
+        ...(raw.message_id && { messageId: raw.message_id }),
         attachments: raw.attachments?.map(({ filename, mime_type, data }) => ({
             name: filename,
             type: mime_type,
@@ -69653,6 +69654,7 @@ class RailsEmailUtils {
                 type: att.type,
             })) || [],
             blobId: "",
+            ...(railsEmail.messageId && { messageId: railsEmail.messageId }),
         };
     };
     clearEmails = () => this.railsEmailClient.clearEmails();
@@ -69662,7 +69664,7 @@ class RailsEmailUtils {
     };
     getLatestEmail = async (searchParams) => {
         await this.clearStaleEmails();
-        await this.railsEmailClient.getLatestEmail(searchParams);
+        return this.railsEmailClient.getLatestEmail(searchParams);
     };
     listEmails = (searchParams) => this.railsEmailClient.listEmails(searchParams);
     listMessages = async (messageSearchCriteria = {}, { receivedAfter = new Date(new Date().valueOf() - 60 * 60 * 1000), } = {}) => {
@@ -69702,6 +69704,12 @@ class RailsEmailUtils {
         }
         return email;
     };
+    getLatestMessageId = async (subject, { timeout = 10_000, receivedAfter = new Date(new Date().valueOf() - 60 * 1000), } = {}) => {
+        const email = await this.findMessage({ subject }, { timeout, receivedAfter }, false);
+        if (!("messageId" in email) || !email.messageId)
+            return undefined;
+        return email.messageId.replace(/^<|>$/g, "");
+    };
     findOtpFromEmail = async ({ email, subjectSubstring = OTP_EMAIL_PATTERN, timeout = 10_000, receivedAfter = new Date(), expectedEmailCount = 1, }) => {
         const otp = await this.neetoPlaywrightUtilities.executeRecursively({
             callback: async () => {
@@ -69815,7 +69823,7 @@ class MailerUtils {
         };
         const { methodResponses: [[, { list }]], } = await this.fastmailApi.apiRequest("Email/get", messageDetailsBody);
         const formattedList = list.map((listItem) => {
-            const { id, from, to, bodyValues, cc, bcc, replyTo, receivedAt, subject, attachments, blobId, } = listItem;
+            const { id, from, to, bodyValues, cc, bcc, replyTo, receivedAt, subject, messageId, attachments, blobId, } = listItem;
             const emailBody = Object.values(pluck("value", bodyValues)).join(" ");
             const emailBodyWithStrippedHead = emailBody.split("</head>").at(-1);
             const links = emailBodyWithStrippedHead.match(LINK_REGEX);
@@ -69846,6 +69854,7 @@ class MailerUtils {
                 subject,
                 attachments,
                 blobId,
+                ...(messageId?.[0] && { messageId: messageId[0] }),
             };
         });
         return formattedList;
@@ -69866,10 +69875,10 @@ class MailerUtils {
                 return ids;
             },
             condition: async () => {
-                const { total } = await this.queryEmail(messageSearchCriteria, {
+                const { ids } = await this.queryEmail(messageSearchCriteria, {
                     receivedAfter,
                 });
-                return total >= expectedEmailCount;
+                return ids.length >= expectedEmailCount;
             },
             timeout,
         }));
@@ -69926,6 +69935,46 @@ class MailerUtils {
         return codes?.[0];
     };
     generateRandomEmail = () => faker.internet.email({ provider: process.env.FASTMAIL_DOMAIN_NAME });
+    getLatestMessageId = async (subject, { timeout = 10_000, receivedAfter = dateTimeOneHourAgo(), } = {}) => {
+        if (IS_DEV_ENV) {
+            return this.railsEmailUtils.getLatestMessageId(subject, {
+                timeout: timeout / 3,
+                receivedAfter,
+            });
+        }
+        if (!this.accountId) {
+            await this.fastmailApi.authorizeAndSetAccountId();
+        }
+        const messageId = (await this.neetoPlaywrightUtilities.executeRecursively({
+            callback: async () => {
+                const { methodResponses: [[, { ids }]], } = await this.fastmailApi.apiRequest("Email/query", {
+                    filter: { subject, after: receivedAfter.toISOString() },
+                    sort: [{ property: "receivedAt", isAscending: false }],
+                    limit: 1,
+                });
+                const emailId = ids?.[0];
+                if (!emailId)
+                    return null;
+                const { methodResponses: [[, { list }]], } = await this.fastmailApi.apiRequest("Email/get", {
+                    ids: [emailId],
+                    properties: ["messageId"],
+                });
+                const rawMessageId = list?.[0]?.messageId?.[0];
+                if (!rawMessageId)
+                    return null;
+                return rawMessageId.replace(/^<|>$/g, "");
+            },
+            condition: async () => {
+                const { methodResponses: [[, { ids }]], } = await this.fastmailApi.apiRequest("Email/query", {
+                    filter: { subject, after: receivedAfter.toISOString() },
+                    limit: 1,
+                });
+                return ids.length >= 1;
+            },
+            timeout,
+        }));
+        return messageId || undefined;
+    };
     getEmailAttachment = async ({ name, type }, messageSearchCriteria = {}, { timeout = 10_000, receivedAfter = dateTimeOneHourAgo(), expectedEmailCount = 1, } = {}, shouldThrowErrorOnTimeout = true) => {
         if (IS_DEV_ENV)
             return this.railsEmailUtils.getEmailAttachment({ name, type }, messageSearchCriteria, { receivedAfter, expectedEmailCount, timeout: timeout / 3 }, shouldThrowErrorOnTimeout);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-playwright-commons",
-  "version": "4.2.3",
+  "version": "4.2.4",
   "description": "A package encapsulating common playwright code across neeto projects.",
   "repository": "git@github.com:bigbinary/neeto-playwright-commons.git",
   "license": "apache-2.0",