@bigbinary/neeto-playwright-commons 3.0.4 → 3.0.6

package/index.d.ts

@@ -783,53 +783,6 @@ declare class MemberApis {
   update: (memberId: string, body: Record<string, unknown>) => Promise<playwright_core.APIResponse | undefined>;
   bulkUpdate: (body: Record<string, unknown>) => Promise<playwright_core.APIResponse | undefined>;
 }
-type EmailDeliveryProvider = "gmail" | "outlook";
-interface EmailDeliveryConnectParams {
-  emailProvider: EmailDeliveryProvider;
-  refreshToken: string;
-  ownerId?: string;
-}
-interface EmailDeliveryVerifyEmailParams {
-  emailProvider: EmailDeliveryProvider;
-  subject: string;
-  to: string;
-  from: string;
-  body?: string;
-  ownerId?: string;
-}
-interface EmailDeliveryVerifiedEmail {
-  subject: string;
-  from: string;
-  to: string;
-  date: string;
-  body: string;
-}
-interface EmailDeliveryVerifyEmailResponse {
-  exists: boolean;
-  email?: EmailDeliveryVerifiedEmail;
-}
-declare class NeetoEmailDeliveryApi {
-  private neetoPlaywrightUtilities;
-  constructor(neetoPlaywrightUtilities: CustomCommands);
-  /**
-   *
-   * Connects an integration. It takes the following parameters:
-   *
-   * skipGoTo: Boolean indicating whether to skip navigating to integration index (default: false).
-   *
-   * @example 
-   *
-   *   await integrationBase.connect();
-   *   // OR
-   *   await integrationBase.connect(true);
-   * @endexample
-  */
-  connect: ({
-    ownerId,
-    ...payload
-  }: EmailDeliveryConnectParams) => Promise<playwright_core.APIResponse | undefined>;
-  verifyEmail: (params: EmailDeliveryVerifyEmailParams) => Promise<playwright_core.APIResponse | undefined>;
-}
 type EmailAddress = string | string[];
 interface RailsEmailAttachment {
   name: string;
@@ -868,6 +821,7 @@ declare class RailsEmailApiClient {
   listEmails: (searchParams?: RailsEmailSearchParams) => Promise<RailsEmail[]>;
   getLatestEmail: (searchParams?: RailsEmailSearchParams) => Promise<RailsEmail | null>;
   clearEmails: () => Promise<unknown>;
+  clearStaleEmails: (receivedBefore: string) => Promise<unknown>;
 }
 declare class RoleApis {
   private neetoPlaywrightUtilities;
@@ -1201,7 +1155,8 @@ declare class RailsEmailUtils {
   constructor(neetoPlaywrightUtilities: CustomCommands);
   private convertRailsEmailToFormattedList;
   clearEmails: () => Promise<unknown>;
-  getLatestEmail: (searchParams: RailsEmailSearchParams) => Promise<RailsEmail | null>;
+  clearStaleEmails: () => Promise<unknown>;
+  getLatestEmail: (searchParams: RailsEmailSearchParams) => Promise<void>;
   listEmails: (searchParams?: RailsEmailSearchParams) => Promise<RailsEmail[]>;
   /**
    *
@@ -8972,6 +8927,58 @@ declare class NeetoAuthServer {
   start: () => Promise<void>;
   stop: () => Promise<void>;
 }
+type EmailDeliveryProvider = "gmail" | "outlook" | "sparkpost";
+type OAuthEmailDeliveryProvider = Exclude<EmailDeliveryProvider, "sparkpost">;
+type EmailDeliveryConnectParams = {
+  emailProvider: OAuthEmailDeliveryProvider;
+  refreshToken: string;
+  ownerId?: string;
+} | {
+  emailProvider: "sparkpost";
+  email: string;
+  ownerId?: string;
+};
+interface EmailDeliveryVerifyEmailParams {
+  emailProvider: EmailDeliveryProvider;
+  subject: string;
+  to: string;
+  from: string;
+  body?: string;
+  ownerId?: string;
+}
+interface EmailDeliveryVerifiedEmail {
+  subject: string;
+  from: string;
+  to: string;
+  date: string;
+  body: string | null;
+}
+interface EmailDeliveryVerifyEmailResponse {
+  exists: boolean;
+  email?: EmailDeliveryVerifiedEmail;
+}
+declare class NeetoEmailDeliveryApi {
+  private neetoPlaywrightUtilities;
+  constructor(neetoPlaywrightUtilities: CustomCommands);
+  /**
+   *
+   * Connects an integration. It takes the following parameters:
+   *
+   * skipGoTo: Boolean indicating whether to skip navigating to integration index (default: false).
+   *
+   * @example 
+   *
+   *   await integrationBase.connect();
+   *   // OR
+   *   await integrationBase.connect(true);
+   * @endexample
+  */
+  connect: ({
+    ownerId,
+    ...payload
+  }: EmailDeliveryConnectParams) => Promise<playwright_core.APIResponse | undefined>;
+  verifyEmail: (params: EmailDeliveryVerifyEmailParams) => Promise<playwright_core.APIResponse | undefined>;
+}
 interface ConnectRequestParams {
   provider: EmailDeliveryProvider;
   ownerId?: string;
@@ -9055,4 +9062,4 @@ interface Overrides {
 */
 declare const definePlaywrightConfig: (overrides: Overrides) => PlaywrightTestConfig<{}, {}>;
 export { ACTIONS, ADMIN_PANEL_SELECTORS, ANALYTICS_RESOURCES, API_KEYS_SELECTORS, API_ROUTES, APP_RESOURCES, AUDIT_LOGS_SELECTORS, ApiKeysApi, ApiKeysPage, AuditLogsPage, BASE_URL, CALENDAR_LABELS, CERTIFICATE_LIMIT_EXCEEDED_MESSAGE, CERTIFICATE_LIMIT_EXCEEDED_REGEXP, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COLOR, COMMON_SELECTORS, COMMON_TEXTS, COMMUNITY_TEXTS, CREDENTIALS, CURRENT_TIME_RANGES, CUSTOM_DOMAIN_SELECTORS, CUSTOM_DOMAIN_SUFFIX, CustomCommands, CustomDomainApi, CustomDomainPage, DATE_FORMATS, DATE_PICKER_SELECTORS, DATE_RANGES, DATE_TEXTS, DEFAULT_WEBHOOKS_RESPONSE_TEXT, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_LABEL, EMPTY_STORAGE_STATE, ENGAGE_TEXTS, ENVIRONMENT, EXAMPLE_URL, EXPANDED_FONT_SIZE, EXPORT_FILE_TYPES, EditorPage, EmailDeliveryUtils, EmbedBase, FILE_FORMATS, FONTS_RESOURCES, FONT_SIZE_SELECTORS, FROM_EMAIL_ENV_KEYS, GLOBAL_TRANSLATIONS_PATTERN, GOOGLE_ANALYTICS_SELECTORS, GOOGLE_CALENDAR_DATE_FORMAT, GOOGLE_LOGIN_SELECTORS, GOOGLE_LOGIN_TEXTS, GOOGLE_SHEETS_SELECTORS, GooglePage, HELP_CENTER_ROUTES, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IPRestrictionsPage, IP_RESTRICTIONS_SELECTORS, IS_CI, IS_DEV_ENV, IS_STAGING_ENV, ImageUploader, IntegrationBase, IpRestrictionsApi, KEYBOARD_SHORTCUTS_SELECTORS, KEYBOARD_SHORTCUT_TEST_CASES, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MICROSOFT_LOGIN_SELECTORS, MICROSOFT_LOGIN_TEXTS, MailerUtils, Member, MemberApis, MicrosoftPage, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_SEO_SELECTORS, NEETO_TEXT_MODIFIER_SELECTORS, NeetoAuthServer, NeetoEmailDeliveryApi, NeetoTowerApi, ONBOARDING_SELECTORS, ORGANIZATION_TEXTS, OTP_EMAIL_PATTERN, OrganizationPage, PAST_TIME_RANGES, PHONE_NUMBER_FORMATS, PLURAL, PROFILE_LINKS, PROFILE_SECTION_SELECTORS, PROJECT_NAMES, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, RailsEmailApiClient, RailsEmailUtils, RoleApis, RolesPage, SIGNUP_SELECTORS, SINGULAR, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STATUS_TEXTS, STORAGE_STATE, SecurityApi, SidebarSection, SlackApi, SlackPage, TABLE_SELECTORS, TAB_SELECTORS, TAGS_SELECTORS, TEAM_MEMBER_TEXTS, TEXT_MODIFIER_ROLES, TEXT_MODIFIER_SELECTORS, TEXT_MODIFIER_TAGS, THANK_YOU_SELECTORS, THEMES_SELECTORS, THEMES_TEXTS, THIRD_PARTY_RESOURCES, THIRD_PARTY_ROUTES, TIME_RANGES, TOASTR_MESSAGES, TWILIO_SELECTORS, TagsApi, TagsPage, TeamMembers, ThankYouApi, ThankYouPage, TwilioApi, USER_AGENTS, WEBHOOK_SELECTORS, WebhookSiteApi, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, baseURLGenerator, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, createOrganizationViaRake, currencyUtils, dataQa, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, fillCredentialsAndSubmit, filterUtils, generatePhoneNumber, generatePhoneNumberDetails, generateRandomBypassEmail, generateRandomFile, generateStagingData, getByDataQA, getClipboardContent, getFormattedPhoneNumber, getFullUrl, getGlobalUserProps, getGlobalUserState, getImagePathAndName, getIsoCodeFromPhoneCode, getListCount, globalShortcuts, grantClipboardPermissions, hexToRGB, hexToRGBA, i18nFixture, imageRegex, initializeCredentials, initializeTestData, initializeTotp, isGithubIssueOpen, joinHyphenCase, joinString, login, loginWithoutSSO, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, serializeFileForBrowser, shouldSkipCustomDomainSetup, shouldSkipSetupAndTeardown, simulateClickWithDelay, simulateTypingWithDelay, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, warmup, writeDataToFile };
-export type { BaseThemeStyle, BaseThemeStyleType, ColumnMenuAction, CountryProps, CustomFixture, EmailDeliveryConnectParams, EmailDeliveryProvider, EmailDeliveryVerifiedEmail, EmailDeliveryVerifyEmailParams, EmailDeliveryVerifyEmailResponse, EmailMatchCriteria, IntroPageThemeStyle, IntroPageThemeStyleType, ProjectName, ThemeCategory, ValueOf };
+export type { BaseThemeStyle, BaseThemeStyleType, ColumnMenuAction, CountryProps, CustomFixture, EmailDeliveryConnectParams, EmailDeliveryProvider, EmailDeliveryVerifiedEmail, EmailDeliveryVerifyEmailParams, EmailDeliveryVerifyEmailResponse, EmailMatchCriteria, IntroPageThemeStyle, IntroPageThemeStyleType, OAuthEmailDeliveryProvider, ProjectName, ThemeCategory, ValueOf };

package/index.js

@@ -319,23 +319,6 @@ class MemberApis {
     });
 }
 
-const NEETO_EMAIL_DELIVERY_TESTING_BASE_URL = "/neeto_email_delivery/api/v1/testing";
-class NeetoEmailDeliveryApi {
-    neetoPlaywrightUtilities;
-    constructor(neetoPlaywrightUtilities) {
-        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
-    }
-    connect = ({ ownerId, ...payload }) => this.neetoPlaywrightUtilities.apiRequest({
-        method: "post",
-        url: `${NEETO_EMAIL_DELIVERY_TESTING_BASE_URL}/connect`,
-        body: keysToSnakeCase({ ownerId, connect: payload }),
-    });
-    verifyEmail = (params) => this.neetoPlaywrightUtilities.apiRequest({
-        url: `${NEETO_EMAIL_DELIVERY_TESTING_BASE_URL}/verify_email`,
-        params: keysToSnakeCase(params),
-    });
-}
-
 class RailsEmailApiClient {
     port = process.env.RAILS_SERVER_PORT;
     subdomain = process.env.SUBDOMAIN ?? "spinkart";
@@ -393,6 +376,7 @@ class RailsEmailApiClient {
     clearEmails = () => this.fetchJson(this.emailsEndpoint, {
         method: "DELETE",
     });
+    clearStaleEmails = (receivedBefore) => this.fetchJson(`${this.emailsEndpoint}?received_before=${encodeURIComponent(receivedBefore)}`, { method: "DELETE" });
 }
 
 class RoleApis {
@@ -60453,7 +60437,14 @@ class RailsEmailUtils {
         };
     };
     clearEmails = () => this.railsEmailClient.clearEmails();
-    getLatestEmail = (searchParams) => this.railsEmailClient.getLatestEmail(searchParams);
+    clearStaleEmails = () => {
+        const tenMinutesAgo = new Date(Date.now() - 10 * 60 * 1000);
+        return this.railsEmailClient.clearStaleEmails(tenMinutesAgo.toISOString());
+    };
+    getLatestEmail = async (searchParams) => {
+        await this.clearStaleEmails();
+        await this.railsEmailClient.getLatestEmail(searchParams);
+    };
     listEmails = (searchParams) => this.railsEmailClient.listEmails(searchParams);
     listMessages = async (messageSearchCriteria = {}, { receivedAfter = new Date(new Date().valueOf() - 60 * 60 * 1000), } = {}) => {
         const emails = await this.railsEmailClient.listEmails({
@@ -107383,6 +107374,7 @@ const commands = {
         const mailerUtils = new MailerUtils(neetoPlaywrightUtilities);
         await mailerUtils.fastmailApi.authorizeAndSetAccountId();
         await use(mailerUtils);
+        IS_DEV_ENV && (await mailerUtils.railsEmailUtils.clearStaleEmails());
     },
     colorPicker: async ({ page }, use) => {
         const colorPicker = new ColorPickerUtils(page);
@@ -125267,6 +125259,23 @@ class NeetoAuthServer {
     };
 }
 
+const NEETO_EMAIL_DELIVERY_TESTING_BASE_URL = "/neeto_email_delivery/api/v1/testing";
+class NeetoEmailDeliveryApi {
+    neetoPlaywrightUtilities;
+    constructor(neetoPlaywrightUtilities) {
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+    }
+    connect = ({ ownerId, ...payload }) => this.neetoPlaywrightUtilities.apiRequest({
+        method: "post",
+        url: `${NEETO_EMAIL_DELIVERY_TESTING_BASE_URL}/connect`,
+        body: keysToSnakeCase({ ownerId, connect: payload }),
+    });
+    verifyEmail = (params) => this.neetoPlaywrightUtilities.apiRequest({
+        url: `${NEETO_EMAIL_DELIVERY_TESTING_BASE_URL}/verify_email`,
+        params: keysToSnakeCase(params),
+    });
+}
+
 const REFRESH_TOKEN_ENV_KEYS = {
     gmail: "EMAIL_DELIVERY_GMAIL_REFRESH_TOKEN",
     outlook: "EMAIL_DELIVERY_OUTLOOK_REFRESH_TOKEN",
@@ -125274,6 +125283,7 @@ const REFRESH_TOKEN_ENV_KEYS = {
 const FROM_EMAIL_ENV_KEYS = {
     gmail: "EMAIL_DELIVERY_CONNECTED_GMAIL",
     outlook: "EMAIL_DELIVERY_CONNECTED_OUTLOOK",
+    sparkpost: "EMAIL_DELIVERY_CONNECTED_SPARKPOST",
 };
 class EmailDeliveryUtils {
     neetoPlaywrightUtilities;
@@ -125283,6 +125293,20 @@ class EmailDeliveryUtils {
         this.emailDeliveryApi = new NeetoEmailDeliveryApi(neetoPlaywrightUtilities);
     }
     connectViaRequest = async ({ provider, ownerId }) => {
+        if (provider === "sparkpost") {
+            const sparkpostEmailEnvKey = FROM_EMAIL_ENV_KEYS.sparkpost;
+            const email = process.env[sparkpostEmailEnvKey];
+            if (isNil(email)) {
+                throw new Error(`ENV variable ${sparkpostEmailEnvKey} is not properly configured`);
+            }
+            const response = await this.emailDeliveryApi.connect({
+                emailProvider: "sparkpost",
+                email,
+                ownerId,
+            });
+            expect(response?.ok()).toBeTruthy();
+            return response;
+        }
         const refreshTokenEnvKey = REFRESH_TOKEN_ENV_KEYS[provider];
         const refreshToken = process.env[refreshTokenEnvKey];
         if (isNil(refreshToken)) {