@bigbinary/neeto-playwright-commons 1.18.2 → 1.18.3

package/index.d.ts

@@ -515,6 +515,12 @@ interface MessageInferredData {
   codes: string[] | null;
   body: string;
 }
+interface AttachmentDetails {
+  filename: string;
+  type: string;
+  content: Buffer;
+  contentType: string;
+}
 interface FormattedList {
   html: MessageInferredData;
   text: MessageInferredData;
@@ -527,6 +533,7 @@ interface FormattedList {
   received: string;
   subject: string;
   attachments: Attachment[];
+  blobId: string;
 }
 declare class MailerUtils {
   private neetoPlaywrightUtilities;
@@ -600,6 +607,11 @@ declare class MailerUtils {
    * @endexample
   */
   listMessages: (messageSearchCriteria?: Partial<MessageSearchCriteria> | undefined, listMessagesFilterCriteria?: Partial<ListMessagesFilterCriteria> | undefined) => Promise<FormattedList[]>;
+  getEmailIds: (messageSearchCriteria?: Partial<MessageSearchCriteria>, {
+    timeout,
+    receivedAfter,
+    expectedEmailCount
+  }?: Partial<FindMessageFilterOptions> | undefined, shouldThrowErrorOnTimeout?: boolean) => Promise<string[]>;
   /**
    *
    * 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.
@@ -696,6 +708,61 @@ 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.
+   *
+   * attachmentName: A substring matching the attachment file name. It can be both with or without extension.
+   *
+   * 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 a promise object with details of attachment. The object will have the following shape.
+   *
+   * filename: A string representing the file name of attachment.
+   *
+   * type: A string representing the type of attachment file.
+   *
+   * content: A buffer with the content of attachment file.
+   *
+   * contentType: A string representing the content type of attachment file.
+   *
+   * @example 
+   *
+   * test("sample test", async ({ mailerUtils }) => {
+   *   const message = await mailerUtils.getEmailAttachment(
+   *     "invite",
+   *     {
+   *     to: fastmailEmailId,
+   *     from: senderEmailId,
+   *     subject: "Event details",
+   *   }, {
+   *     receivedAfter: new Date(),
+   *     timeout: 60 * 1000,
+   *   }, false);
+   * });
+   * @endexample
+  */
+  getEmailAttachment: (attachmentName: string, messageSearchCriteria?: Partial<MessageSearchCriteria>, {
+    timeout,
+    receivedAfter,
+    expectedEmailCount
+  }?: Partial<FindMessageFilterOptions> | undefined, shouldThrowErrorOnTimeout?: boolean) => Promise<AttachmentDetails | undefined>;
 }
 type Hex = Lowercase<`#${string}`>;
 interface BaseThemeStyle {
@@ -2618,6 +2685,7 @@ interface CreateOrganizationProps extends BasicUserInfo {
 interface LoginAndOnboardParams extends BasicUserInfo {
   handleOnboarding: () => Promise<void>;
   baseURL?: string;
+  fetchOtpFromEmail?: FetchOtpFromEmail;
 }
 interface Credentials extends BasicUserInfo {
   otp?: number;
@@ -2626,6 +2694,15 @@ interface Credentials extends BasicUserInfo {
   businessName: string;
   subdomainName: string;
 }
+type FetchOtpFromEmail = (params: {
+  email: string;
+  timeout: number;
+}) => Promise<string>;
+interface LoginWithFastmailEmail {
+  email: string;
+  loginTimeout?: number;
+  fetchOtpFromEmail: FetchOtpFromEmail;
+}
 declare class OrganizationPage {
   page: Page;
   neetoPlaywrightUtilities: CustomCommands;
@@ -2704,6 +2781,7 @@ declare class OrganizationPage {
    * @endexample
   */
   updateSubdomainIfExists: (appName: string) => Promise<void>;
+  fillEmailAndSubmit: (email: string, loginTimeout: number) => Promise<void>;
   /**
    *
    * Used to login via SSO. It takes the following parameters:
@@ -2718,6 +2796,33 @@ declare class OrganizationPage {
    * @endexample
   */
   loginViaSSO: (email?: string, loginTimeout?: number) => Promise<void>;
+  /**
+   *
+   * This method is used to login NeetoAuth using Fastmail email id. It takes the following parameters:
+   *
+   * email: A Fastmail email id. You can generate a Fastmail email id using the method generateRandomEmail in MailerUtils.
+   *
+   * loginTimeout (optional): Specifies the maximum amount of time the method will wait for the login process to complete before timing out. Default is 15s.
+   *
+   * fetchOtpFromEmail: Method to fetch OTP from Fastmail email.
+   *
+   * @example 
+   *
+   *  await organizationPage.loginWithFastmailEmail({
+   *   email,
+   *   fetchOtpFromEmail: () =>
+   *     mailerUtils.findOtpFromEmail({
+   *       ...newHost,
+   *       timeout: 5 * 60 * 1000,
+   *     }),
+   *  })
+   * @endexample
+  */
+  loginWithFastmailEmail: ({
+    email,
+    loginTimeout,
+    fetchOtpFromEmail
+  }: LoginWithFastmailEmail) => Promise<void>;
   /**
    *
    * Used to fill and submit all the profile info. It takes the following parameters:
@@ -2771,7 +2876,8 @@ declare class OrganizationPage {
     lastName,
     country,
     handleOnboarding,
-    baseURL
+    baseURL,
+    fetchOtpFromEmail
   }: LoginAndOnboardParams) => Promise<void>;
   /**
    *
@@ -2806,10 +2912,7 @@ declare class OrganizationPage {
     appName
   }: {
     credentials: Credentials;
-    fetchOtpFromEmail?: (params: {
-      email: string;
-      timeout: number;
-    }) => Promise<string>;
+    fetchOtpFromEmail?: FetchOtpFromEmail;
     appName: string;
   }) => Promise<{
     STORAGE_STATE: {