@bigbinary/neeto-playwright-commons 3.1.0 → 3.1.1

package/index.d.ts

@@ -1136,6 +1136,13 @@ interface BaseMessageSearchCriteria {
   body: string;
 }
 type MessageSearchCriteria$1 = Partial<BaseMessageSearchCriteria>;
+type AttachmentFilter$1 = {
+  name: string;
+  type?: string;
+} | {
+  name?: string;
+  type: string;
+};
 interface FindMessageFilterOptions$1 {
   receivedAfter: Date;
   timeout: number;
@@ -1158,7 +1165,7 @@ interface MessageInferredData$1 {
   body: string;
 }
 interface Attachment$1 {
-  name: string;
+  name: string | null;
   type: string;
 }
 interface FormattedList$1 {
@@ -1176,7 +1183,7 @@ interface FormattedList$1 {
   blobId: string;
 }
 interface AttachmentDetails$1 {
-  filename: string;
+  filename: string | null;
   type: string;
   content: Buffer;
   contentType: string;
@@ -1358,11 +1365,15 @@ declare class RailsEmailUtils {
   }: FindOtpFromEmailParams$1) => Promise<string | undefined>;
   /**
    *
-   * This method is used to return the attachment based on the attachmentName of first email matching the search criteria. On top of the findMessage method, this method matches the attachment name with the attachments associated to the email. If any attachment matches then it will fetch the attachment details and return. If any attachment file name doesn't contain the substring attachmentName then it will throw an error saying No such attachment exists.
+   * 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.
    *
    * Note: In development environment, this method uses the Rails testing HTTP API to fetch attachments. In other environments, it uses Fastmail APIs.
    *
-   * attachmentName: A substring matching the attachment file name. It can be both with or without extension.
+   * attachmentFilter: An object used to identify the attachment. At least one of the following keys should be provided:
+   *
+   * name (optional): A substring matched against the attachment file name.
+   *
+   * type (optional): A prefix matched against the attachment MIME content-type (e.g. "text/calendar"). Useful when the attachment has no filename, such as calendar invite (.ics) parts that omit Content-Disposition: attachment.
    *
    * 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:
    *
@@ -1396,22 +1407,41 @@ declare class RailsEmailUtils {
    *
    * @example 
    *
+   * // Match attachment by name
    * test("sample test", async ({ mailerUtils }) => {
-   *   const message = await mailerUtils.getEmailAttachment(
-   *     "invite",
+   *   const attachment = await mailerUtils.getEmailAttachment(
+   *     { name: "invite" },
    *     {
-   *     to: fastmailEmailId,
-   *     from: senderEmailId,
-   *     subject: "Event details",
-   *   }, {
-   *     receivedAfter: new Date(),
-   *     timeout: 60 * 1000,
-   *     expectedEmailCount: 1,
-   *   }, false);
+   *       to: fastmailEmailId,
+   *       from: senderEmailId,
+   *       subject: "Event details",
+   *     },
+   *     {
+   *       receivedAfter: new Date(),
+   *       timeout: 60 * 1000,
+   *       expectedEmailCount: 1,
+   *     },
+   *     false
+   *   );
+   * });
+   * 
+   * // Match attachment by MIME type (e.g. calendar invite with no filename)
+   * test("sample test", async ({ mailerUtils }) => {
+   *   const attachment = await mailerUtils.getEmailAttachment(
+   *     { type: "text/calendar" },
+   *     {
+   *       to: fastmailEmailId,
+   *       from: senderEmailId,
+   *       subject: "Event details",
+   *     }
+   *   );
    * });
    * @endexample
   */
-  getEmailAttachment: (attachmentName: string, messageSearchCriteria?: MessageSearchCriteria$1, {
+  getEmailAttachment: ({
+    name,
+    type
+  }: AttachmentFilter$1, messageSearchCriteria?: MessageSearchCriteria$1, {
     receivedAfter,
     expectedEmailCount,
     timeout
@@ -1461,6 +1491,13 @@ interface MessageSearchCriteria {
   subject: string;
   body: string;
 }
+type AttachmentFilter = {
+  name: string;
+  type?: string;
+} | {
+  name?: string;
+  type: string;
+};
 interface FindMessageFilterOptions {
   receivedAfter: Date;
   timeout: number;
@@ -1471,7 +1508,7 @@ interface Identifier {
   email: string;
 }
 interface Attachment {
-  name: string;
+  name: string | null;
   type: string;
 }
 interface FindOtpFromEmailParams {
@@ -1492,7 +1529,7 @@ interface MessageInferredData {
   body: string;
 }
 interface AttachmentDetails {
-  filename: string;
+  filename: string | null;
   type: string;
   content: Buffer;
   contentType: string;
@@ -1697,11 +1734,15 @@ declare class MailerUtils {
   generateRandomEmail: () => string;
   /**
    *
-   * This method is used to return the attachment based on the attachmentName of first email matching the search criteria. On top of the findMessage method, this method matches the attachment name with the attachments associated to the email. If any attachment matches then it will fetch the attachment details and return. If any attachment file name doesn't contain the substring attachmentName then it will throw an error saying No such attachment exists.
+   * 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.
    *
    * Note: In development environment, this method uses the Rails testing HTTP API to fetch attachments. In other environments, it uses Fastmail APIs.
    *
-   * attachmentName: A substring matching the attachment file name. It can be both with or without extension.
+   * attachmentFilter: An object used to identify the attachment. At least one of the following keys should be provided:
+   *
+   * name (optional): A substring matched against the attachment file name.
+   *
+   * type (optional): A prefix matched against the attachment MIME content-type (e.g. "text/calendar"). Useful when the attachment has no filename, such as calendar invite (.ics) parts that omit Content-Disposition: attachment.
    *
    * 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:
    *
@@ -1735,22 +1776,41 @@ declare class MailerUtils {
    *
    * @example 
    *
+   * // Match attachment by name
    * test("sample test", async ({ mailerUtils }) => {
-   *   const message = await mailerUtils.getEmailAttachment(
-   *     "invite",
+   *   const attachment = await mailerUtils.getEmailAttachment(
+   *     { name: "invite" },
    *     {
-   *     to: fastmailEmailId,
-   *     from: senderEmailId,
-   *     subject: "Event details",
-   *   }, {
-   *     receivedAfter: new Date(),
-   *     timeout: 60 * 1000,
-   *     expectedEmailCount: 1,
-   *   }, false);
+   *       to: fastmailEmailId,
+   *       from: senderEmailId,
+   *       subject: "Event details",
+   *     },
+   *     {
+   *       receivedAfter: new Date(),
+   *       timeout: 60 * 1000,
+   *       expectedEmailCount: 1,
+   *     },
+   *     false
+   *   );
+   * });
+   * 
+   * // Match attachment by MIME type (e.g. calendar invite with no filename)
+   * test("sample test", async ({ mailerUtils }) => {
+   *   const attachment = await mailerUtils.getEmailAttachment(
+   *     { type: "text/calendar" },
+   *     {
+   *       to: fastmailEmailId,
+   *       from: senderEmailId,
+   *       subject: "Event details",
+   *     }
+   *   );
    * });
    * @endexample
   */
-  getEmailAttachment: (attachmentName: string, messageSearchCriteria?: Partial<MessageSearchCriteria>, {
+  getEmailAttachment: ({
+    name,
+    type
+  }: AttachmentFilter, messageSearchCriteria?: Partial<MessageSearchCriteria>, {
     timeout,
     receivedAfter,
     expectedEmailCount

package/index.js

@@ -60508,7 +60508,7 @@ class RailsEmailUtils {
         });
         return otp || undefined;
     };
-    getEmailAttachment = async (attachmentName, messageSearchCriteria = {}, { receivedAfter = new Date(new Date().valueOf() - 60 * 60 * 1000), expectedEmailCount = 1, timeout = 10_000, } = {}, shouldThrowErrorOnTimeout = true) => {
+    getEmailAttachment = async ({ name, type }, messageSearchCriteria = {}, { receivedAfter = new Date(new Date().valueOf() - 60 * 60 * 1000), expectedEmailCount = 1, timeout = 10_000, } = {}, shouldThrowErrorOnTimeout = true) => {
         const attachmentDetails = (await this.neetoPlaywrightUtilities.executeRecursively({
             callback: async () => {
                 const railsEmail = await this.railsEmailClient.getLatestEmail({
@@ -60517,7 +60517,11 @@ class RailsEmailUtils {
                 });
                 if (!railsEmail)
                     return null;
-                const attachment = railsEmail.attachments?.find(att => att.name.includes(attachmentName));
+                const attachment = railsEmail.attachments?.find(att => {
+                    const matchesName = name ? att.name?.includes(name) : true;
+                    const matchesType = type ? att.type?.startsWith(type) : true;
+                    return matchesName && matchesType;
+                });
                 if (!attachment)
                     return null;
                 return {
@@ -60701,19 +60705,26 @@ class MailerUtils {
         return codes?.[0];
     };
     generateRandomEmail = () => faker.internet.email({ provider: process.env.FASTMAIL_DOMAIN_NAME });
-    getEmailAttachment = async (attachmentName, messageSearchCriteria = {}, { timeout = 10_000, receivedAfter = dateTimeOneHourAgo(), expectedEmailCount = 1, } = {}, shouldThrowErrorOnTimeout = true) => {
-        if (IS_DEV_ENV) {
-            return this.railsEmailUtils.getEmailAttachment(attachmentName, messageSearchCriteria, { receivedAfter, expectedEmailCount, timeout: timeout / 3 }, shouldThrowErrorOnTimeout);
-        }
+    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);
         const { blobId, attachments: attachmentNameAndTypes } = await this.findMessage(messageSearchCriteria, { expectedEmailCount, receivedAfter, timeout }, shouldThrowErrorOnTimeout);
-        const attachment = attachmentNameAndTypes.find(attachment => attachment.name.includes(attachmentName));
+        const attachment = attachmentNameAndTypes.find(att => {
+            const matchesName = name ? att.name?.includes(name) : true;
+            const matchesType = type ? att.type?.startsWith(type) : true;
+            return matchesName && matchesType;
+        });
         if (!attachment)
             throw new Error("No such attachment exists");
         const emailAttachment = await this.fastmailApi.fetchAttachments(blobId, attachment.name);
         const buffer = await emailAttachment.body();
         const parsedEmail = await mailparserExports.simpleParser(buffer);
         const attachments = parsedEmail.attachments;
-        return attachments.find(attachment => attachment.filename.includes(attachmentName));
+        return attachments.find(att => {
+            const matchesName = name ? att.filename?.includes(name) : true;
+            const matchesType = type ? att.contentType?.startsWith(type) : true;
+            return matchesName && matchesType;
+        });
     };
 }