@bigbinary/neeto-playwright-commons 1.14.3 → 1.15.0

package/index.d.ts

@@ -1,8 +1,6 @@
 import * as _playwright_test from '@playwright/test';
 import { Page, APIRequestContext, Response, Locator, APIResponse, Fixtures, PlaywrightWorkerArgs, PlaywrightWorkerOptions, PlaywrightTestArgs, PlaywrightTestOptions, Browser, BrowserContext, FrameLocator, CDPSession } from '@playwright/test';
 import { FastmailApi } from 'apis/fastmail';
-import * as mailosaur_lib_models from 'mailosaur/lib/models';
-import MailosaurClient from 'mailosaur';
 import { I18nPlaywrightFixture } from 'playwright-i18next-fixture';
 import { TFunction } from 'i18next';
 import { TOTP, Secret } from 'otpauth';
@@ -675,104 +673,9 @@ declare class MailerUtils {
   */
   generateRandomEmail: () => string;
 }
-interface EmailContentParams {
-  email: string;
-  subjectSubstring?: string;
-  timeout?: number;
-  receivedAfter?: Date;
-}
-type FetchOtpFromEmail = (props: EmailContentParams) => Promise<string | undefined>;
-declare class MailosaurUtils {
-  mailosaur: MailosaurClient;
-  serverId: string;
-  constructor(mailosaur: MailosaurClient);
-  /**
-   *
-   * Used to extract the email content. It takes the following parameters:
-   *
-   * email (required): The Mailosaur email to which the OTP was sent to.
-   *
-   * subjectSubstring (optional): A substring of the email subject to filter it.
-   *
-   * timeout (optional): The timeout time in milliseconds after which the method
-   *
-   * throws an error if an email is not found. Defaults to 2 minutes
-   *
-   * receivedAfter: A date object used to filter the emails based on the time of
-   *
-   * receiving it. Only emails incoming after this timestamp will be taken into
-   *
-   * account. Defaults to the timestamp of invoking this method.
-   *
-   * @example 
-   *
-   * test("sample test", async ({ mailosaurUtils }) => {
-   *   const email = mailosaurUtils.getEmailContent({
-   *     email: `someone@${process.env.MAILOSAUR_SERVER_ID}.mailosaur.net`,
-   *     subjectSubstring: "is your OTP",
-   *     timeout: 60 * 1000,
-   *     receivedAfter: new Date(),
-   *   });
-   * });
-   * @endexample
-  */
-  getEmailContent: ({
-    email,
-    subjectSubstring,
-    timeout,
-    receivedAfter
-  }: EmailContentParams) => Promise<mailosaur_lib_models.Message>;
-  /**
-   *
-   * Used to extract the OTP from the neeto OTP emails. It takes the following parameters:
-   *
-   * email(required): The Mailosaur email to which the OTP was sent to.
-   *
-   * subjectSubstring (optional): A substring of the email subject to filter it.
-   *
-   * Defaults to "is your login code"
-   *
-   * timeout (optional): The timeout time in milliseconds after which the method
-   *
-   * throws an error if an email is not found. Defaults to 2 minutes
-   *
-   * receivedAfter: A date object used to filter the emails based on the time of
-   *
-   * receiving it. Only emails incoming after this timestamp will be taken into
-   *
-   * account. Defaults to the timestamp of invoking this method.
-   *
-   * @example 
-   *
-   * test("sample test", async ({ mailosaurUtils }) => {
-   *   mailosaurUtils.fetchOtpFromEmail({
-   *     email: `someone@${process.env.MAILOSAUR_SERVER_ID}.mailosaur.net`,
-   *     subjectSubstring: "is your OTP",
-   *     timeout: 60 * 1000,
-   *     receivedAfter: new Date(),
-   *   });
-   * });
-   * @endexample
-  */
-  fetchOtpFromEmail: FetchOtpFromEmail;
-  /**
-   *
-   * Used to generate a random Email ID to the Mailosaur Server.
-   *
-   * @example 
-   *
-   * test("sample test", async ({ mailosaurUtils }) => {
-   *   const email = mailosaurUtils.generateRandomMailosaurEmail();
-   * });
-   * @endexample
-  */
-  generateRandomMailosaurEmail: () => string;
-}
 interface CustomFixture {
   neetoPlaywrightUtilities: CustomCommands;
   page: Page;
-  mailosaur: MailosaurClient;
-  mailosaurUtils: MailosaurUtils;
   mailerUtils: MailerUtils;
 }
 type Commands = Fixtures<CustomFixture, PlaywrightWorkerArgs & PlaywrightWorkerOptions, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
@@ -1894,7 +1797,9 @@ declare class ZapierPage extends IntegrationBase {
    *
    * @example 
    *
-   * const apiKey = await zapierPage.connectAndVerify({ apiKeyLabel: "Your API Key" });
+   * const apiKey = await zapierPage.connectAndVerify({
+   *   apiKeyLabel: "Your API Key",
+   * });
    * @endexample
   */
   connectAndVerify: ({
@@ -3328,7 +3233,7 @@ declare const SLACK_DEFAULT_CHANNEL = "general";
  *
  * const testEmail = ZAPIER_TEST_EMAIL("neetoChat");
  * 
- * console.log(testEmail) // `neeto-neetoChat-zapier-test@${process.env.INTEGRATION_MAILOSAUR_SERVER_ID}.mailosaur.net`
+ * console.log(testEmail) // `neeto-neetoChat-zapier-test@${process.env.FASTMAIL_DOMAIN_NAME}`
  * @endexample
 */
 declare const ZAPIER_TEST_EMAIL: (product: string) => string;
@@ -6131,4 +6036,4 @@ interface Overrides {
  * @endexample
 */
 declare const definePlaywrightConfig: (overrides: Overrides) => _playwright_test.PlaywrightTestConfig<{}, {}>;
-export { API_ROUTES, AUDIT_LOGS_TEXTS, AuditLogsPage, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_LABEL, ENGAGE_TEXTS, ENVIRONMENT, EXPANDED_FONT_SIZE, EditorPage, EmbedBase, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, GOOGLE_CALENDAR_DATE_FORMAT, GOOGLE_LOGIN_SELECTORS, GOOGLE_LOGIN_TEXTS, GooglePage, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, ImageUploader, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailerUtils, MailosaurUtils, Member, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PLURAL, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SELECT_COUNTRY, SIGNUP_SELECTORS, SINGULAR, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TAB_SELECTORS, TAGS_SELECTORS, TEXT_MODIFIER_ROLES, TEXT_MODIFIER_SELECTORS, TEXT_MODIFIER_TAGS, THANK_YOU_SELECTORS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, TagsPage, TeamMembers, ThankYouPage, USER_AGENTS, WEBHOOK_SELECTORS, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, currencyUtils, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, filterUtils, generateRandomBypassEmail, generateStagingData, getByDataQA, getGlobalUserState, getImagePathAndName, getListCount, headerUtils, hexToRGB, hexToRGBA, hyphenize, i18nFixture, initializeCredentials, initializeTotp, isGithubIssueOpen, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };
+export { API_ROUTES, AUDIT_LOGS_TEXTS, AuditLogsPage, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_LABEL, ENGAGE_TEXTS, ENVIRONMENT, EXPANDED_FONT_SIZE, EditorPage, EmbedBase, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, GOOGLE_CALENDAR_DATE_FORMAT, GOOGLE_LOGIN_SELECTORS, GOOGLE_LOGIN_TEXTS, GooglePage, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, ImageUploader, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailerUtils, Member, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PLURAL, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SELECT_COUNTRY, SIGNUP_SELECTORS, SINGULAR, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TAB_SELECTORS, TAGS_SELECTORS, TEXT_MODIFIER_ROLES, TEXT_MODIFIER_SELECTORS, TEXT_MODIFIER_TAGS, THANK_YOU_SELECTORS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, TagsPage, TeamMembers, ThankYouPage, USER_AGENTS, WEBHOOK_SELECTORS, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, currencyUtils, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, filterUtils, generateRandomBypassEmail, generateStagingData, getByDataQA, getGlobalUserState, getImagePathAndName, getListCount, headerUtils, hexToRGB, hexToRGBA, hyphenize, i18nFixture, initializeCredentials, initializeTotp, isGithubIssueOpen, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };

package/index.js

@@ -4,10 +4,9 @@ import * as Path from 'path';
 import Path__default from 'path';
 import test$1, { expect, test as test$2, chromium as chromium$1, defineConfig, devices } from '@playwright/test';
 import { execSync } from 'child_process';
-import { curry, not, isEmpty as isEmpty$1, pluck, isNil, isNotNil, mergeDeepLeft, mergeAll } from 'ramda';
+import { curry, not, isEmpty as isEmpty$1, pluck, mergeDeepLeft, isNotNil, isNil, mergeAll } from 'ramda';
 import require$$0$1 from 'util';
 import { faker } from '@faker-js/faker';
-import MailosaurClient from 'mailosaur';
 import dayjs from 'dayjs';
 import require$$0$3 from 'tty';
 import require$$0$2 from 'os';
@@ -12162,59 +12161,16 @@ class MailerUtils {
     }
 }
 
-class MailosaurUtils {
-    constructor(mailosaur) {
-        this.getEmailContent = ({ email, subjectSubstring = "", timeout = 2 * 60 * 1000, receivedAfter = new Date(), }) => this.mailosaur.messages.get(this.serverId, { sentTo: email, subject: subjectSubstring }, { timeout, receivedAfter });
-        this.fetchOtpFromEmail = async ({ email, subjectSubstring = OTP_EMAIL_PATTERN, timeout = 2 * 60 * 1000, receivedAfter = new Date(), }) => {
-            var _a, _b, _c;
-            const receivedEmail = await this.getEmailContent({
-                email,
-                subjectSubstring,
-                timeout,
-                receivedAfter,
-            });
-            const otp = (_c = (_b = (_a = receivedEmail === null || receivedEmail === void 0 ? void 0 : receivedEmail.text) === null || _a === void 0 ? void 0 : _a.codes) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.value;
-            if (isNil(otp)) {
-                throw new Error(`No codes found in the email with subject: ${receivedEmail === null || receivedEmail === void 0 ? void 0 : receivedEmail.subject}. Please re-evaluate the filtering parameters.`);
-            }
-            return otp;
-        };
-        this.generateRandomMailosaurEmail = () => faker.internet.email({ provider: `${this.serverId}.mailosaur.net` });
-        this.mailosaur = mailosaur;
-        if (isNotNil(process.env.MAILOSAUR_SERVER_ID)) {
-            this.serverId = process.env.MAILOSAUR_SERVER_ID;
-        }
-        else {
-            throw new Error("ENV variable MAILOSAUR_SERVER_ID is not defined. Please add the Server ID to use this method. Please visit https://mailosaur.com/app/servers to find the Server ID.");
-        }
-    }
-}
-
 const commands = {
     neetoPlaywrightUtilities: async ({ page, request, baseURL }, use) => {
         const commands = new CustomCommands(page, request, baseURL);
         await use(commands);
     },
-    mailosaur: async ({}, use) => {
-        skipTest.forAllExceptStagingEnv();
-        if (isNotNil(process.env.MAILOSAUR_API_KEY)) {
-            const mailosaur = new MailosaurClient(process.env.MAILOSAUR_API_KEY);
-            await use(mailosaur);
-        }
-        else {
-            throw new Error("ENV variable MAILOSAUR_API_KEY is not defined. Please add the API key to use this fixture. Please visit https://mailosaur.com/app/account/keys to find the API key.");
-        }
-    },
     page: async ({ page }, use) => {
         await page.goto("/", { timeout: 20000 });
         await page.waitForLoadState();
         await use(page);
     },
-    mailosaurUtils: async ({ mailosaur }, use) => {
-        skipTest.forAllExceptStagingEnv();
-        const mailosaurUtils = new MailosaurUtils(mailosaur);
-        await use(mailosaurUtils);
-    },
     mailerUtils: async ({ neetoPlaywrightUtilities }, use) => {
         const mailerUtils = new MailerUtils(neetoPlaywrightUtilities);
         await mailerUtils.fastmailApi.authorizeAndSetAccountId();
@@ -158589,5 +158545,5 @@ const definePlaywrightConfig = (overrides) => {
     });
 };
 
-export { API_ROUTES, AUDIT_LOGS_TEXTS, AuditLogsPage, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_LABEL, ENGAGE_TEXTS, ENVIRONMENT, EXPANDED_FONT_SIZE, EditorPage, EmbedBase, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, GOOGLE_CALENDAR_DATE_FORMAT, GOOGLE_LOGIN_SELECTORS, GOOGLE_LOGIN_TEXTS, GooglePage, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, ImageUploader, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailerUtils, MailosaurUtils, Member, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PLURAL, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SELECT_COUNTRY, SIGNUP_SELECTORS, SINGULAR, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TAB_SELECTORS, TAGS_SELECTORS, TEXT_MODIFIER_ROLES, TEXT_MODIFIER_SELECTORS, TEXT_MODIFIER_TAGS, THANK_YOU_SELECTORS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, TagsPage, TeamMembers, ThankYouPage, USER_AGENTS, WEBHOOK_SELECTORS, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, currencyUtils, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, filterUtils, generateRandomBypassEmail, generateStagingData, getByDataQA, getGlobalUserState, getImagePathAndName, getListCount, headerUtils, hexToRGB, hexToRGBA, hyphenize, i18nFixture, initializeCredentials, initializeTotp, isGithubIssueOpen, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, stealth as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };
+export { API_ROUTES, AUDIT_LOGS_TEXTS, AuditLogsPage, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_LABEL, ENGAGE_TEXTS, ENVIRONMENT, EXPANDED_FONT_SIZE, EditorPage, EmbedBase, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, GOOGLE_CALENDAR_DATE_FORMAT, GOOGLE_LOGIN_SELECTORS, GOOGLE_LOGIN_TEXTS, GooglePage, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, ImageUploader, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailerUtils, Member, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PLURAL, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SELECT_COUNTRY, SIGNUP_SELECTORS, SINGULAR, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TAB_SELECTORS, TAGS_SELECTORS, TEXT_MODIFIER_ROLES, TEXT_MODIFIER_SELECTORS, TEXT_MODIFIER_TAGS, THANK_YOU_SELECTORS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, TagsPage, TeamMembers, ThankYouPage, USER_AGENTS, WEBHOOK_SELECTORS, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, currencyUtils, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, filterUtils, generateRandomBypassEmail, generateStagingData, getByDataQA, getGlobalUserState, getImagePathAndName, getListCount, headerUtils, hexToRGB, hexToRGBA, hyphenize, i18nFixture, initializeCredentials, initializeTotp, isGithubIssueOpen, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, stealth as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };
 //# sourceMappingURL=index.js.map