@bigbinary/neeto-playwright-commons 2.2.5 → 2.3.0

package/README.md

@@ -130,6 +130,7 @@ import { COMMON_SELECTORS } from "@bigbinary/neeto-playwright-common";
 - [Routes](./docs/routes.md)
 - [Custom commands](./docs/custom-commands.md)
 - [MailerUtils](./docs/utils/mailer-utils.md)
+- [EmailDeliveryUtils](./docs/utils/email-delivery-utils.md)
 - [NeetoAuthServer](./docs/utils/neeto-auth-server.md)
 - [Util functions](./docs/utils)
 - [POMs](./docs/poms)

package/index.cjs.js

@@ -247,6 +247,25 @@ class MemberApis {
     });
 }
 
+const NEETO_EMAIL_DELIVERY_TESTING_BASE_URL = "/neeto_email_delivery/api/v1/testing";
+class NeetoEmailDeliveryApi {
+    neetoPlaywrightUtilities;
+    constructor(neetoPlaywrightUtilities) {
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+    }
+    connect = (payload) => this.neetoPlaywrightUtilities.apiRequest({
+        method: "post",
+        url: `${NEETO_EMAIL_DELIVERY_TESTING_BASE_URL}/connect`,
+        body: {
+            connect: neetoCist.keysToSnakeCase(payload),
+        },
+    });
+    verifyEmail = (params) => this.neetoPlaywrightUtilities.apiRequest({
+        url: `${NEETO_EMAIL_DELIVERY_TESTING_BASE_URL}/verify_email`,
+        params: neetoCist.keysToSnakeCase(params),
+    });
+}
+
 class RailsEmailApiClient {
     port = process.env.RAILS_SERVER_PORT;
     subdomain = process.env.SUBDOMAIN ?? "spinkart";
@@ -121461,6 +121480,70 @@ class TagsPage {
     };
 }
 
+const REFRESH_TOKEN_ENV_KEYS = {
+    gmail: "EMAIL_DELIVERY_GMAIL_REFRESH_TOKEN",
+    outlook: "EMAIL_DELIVERY_OUTLOOK_REFRESH_TOKEN",
+};
+const FROM_EMAIL_ENV_KEYS = {
+    gmail: "EMAIL_DELIVERY_CONNECTED_GMAIL",
+    outlook: "EMAIL_DELIVERY_CONNECTED_OUTLOOK",
+};
+class EmailDeliveryUtils {
+    neetoPlaywrightUtilities;
+    emailDeliveryApi;
+    constructor(neetoPlaywrightUtilities) {
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+        this.emailDeliveryApi = new NeetoEmailDeliveryApi(neetoPlaywrightUtilities);
+    }
+    connectViaRequest = async ({ provider }) => {
+        const refreshTokenEnvKey = REFRESH_TOKEN_ENV_KEYS[provider];
+        const refreshToken = process.env[refreshTokenEnvKey];
+        if (ramda.isNil(refreshToken)) {
+            throw new Error(`ENV variable ${refreshTokenEnvKey} is not properly configured`);
+        }
+        const response = await this.emailDeliveryApi.connect({
+            emailProvider: provider,
+            refreshToken,
+        });
+        test.expect(response?.ok()).toBeTruthy();
+        return response;
+    };
+    verifyEmailViaRequest = async ({ subject, to, partialBody, from }, { provider, timeout = 30 * 1000, shouldThrowErrorOnTimeout = true, }) => {
+        const fromEmail = from ?? process.env[FROM_EMAIL_ENV_KEYS[provider]];
+        if (ramda.isNil(fromEmail)) {
+            throw new Error(`ENV variable ${FROM_EMAIL_ENV_KEYS[provider]} is not properly configured`);
+        }
+        const verifyParams = {
+            emailProvider: provider,
+            subject,
+            to,
+            from: fromEmail,
+            body: partialBody,
+        };
+        let lastResult = null;
+        const fetchEmail = async () => {
+            const response = await this.emailDeliveryApi.verifyEmail(verifyParams);
+            if (!response?.ok()) {
+                lastResult = null;
+                return;
+            }
+            lastResult = (await response.json());
+        };
+        const email = (await this.neetoPlaywrightUtilities.executeRecursively({
+            condition: async () => {
+                await fetchEmail();
+                return Boolean(lastResult?.exists);
+            },
+            callback: async () => lastResult?.exists ? (lastResult.email ?? null) : null,
+            timeout,
+        }));
+        if (!email && shouldThrowErrorOnTimeout) {
+            throw new Error(`Timed out waiting for ${provider} email matching subject "${subject}"`);
+        }
+        return email;
+    };
+}
+
 const USER_AGENTS = {
     windows: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36",
     mac: "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
@@ -126025,6 +126108,7 @@ exports.EXAMPLE_URL = EXAMPLE_URL;
 exports.EXPANDED_FONT_SIZE = EXPANDED_FONT_SIZE;
 exports.EXPORT_FILE_TYPES = EXPORT_FILE_TYPES;
 exports.EditorPage = EditorPage;
+exports.EmailDeliveryUtils = EmailDeliveryUtils;
 exports.EmbedBase = EmbedBase;
 exports.FILE_FORMATS = FILE_FORMATS;
 exports.FONT_SIZE_SELECTORS = FONT_SIZE_SELECTORS;
@@ -126070,6 +126154,7 @@ exports.NEETO_ROUTES = NEETO_ROUTES;
 exports.NEETO_SEO_SELECTORS = NEETO_SEO_SELECTORS;
 exports.NEETO_TEXT_MODIFIER_SELECTORS = NEETO_TEXT_MODIFIER_SELECTORS;
 exports.NeetoAuthServer = NeetoAuthServer;
+exports.NeetoEmailDeliveryApi = NeetoEmailDeliveryApi;
 exports.NeetoTowerApi = NeetoTowerApi;
 exports.ONBOARDING_SELECTORS = ONBOARDING_SELECTORS;
 exports.ORGANIZATION_TEXTS = ORGANIZATION_TEXTS;