@bigbinary/neeto-playwright-commons 1.25.0 → 1.26.0

package/index.cjs.js

@@ -1,14 +1,14 @@
 'use strict';
 
+var neetoCist = require('@bigbinary/neeto-cist');
+var faker = require('@faker-js/faker');
 var require$$0$4 = require('fs');
 var path$1 = require('path');
 var test = require('@playwright/test');
 var playwrightI18nextFixture = require('playwright-i18next-fixture');
 var require$$0$3 = require('util');
 var ramda = require('ramda');
-var neetoCist = require('@bigbinary/neeto-cist');
 var child_process = require('child_process');
-var faker = require('@faker-js/faker');
 var dayjs = require('dayjs');
 var require$$0$6 = require('stream');
 var node_module = require('node:module');
@@ -252,6 +252,43 @@ class RoleApis {
     }
 }
 
+const SECURITY_BASE_URL = `/secure${BASE_URL}/configuration`;
+class SecurityApi {
+    constructor(neetoPlaywrightUtilities) {
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+        this.buildBody = (auth, value) => {
+            switch (auth) {
+                case "password":
+                    return {
+                        configuration: {
+                            auth: "basic",
+                            password: value || faker.faker.internet.password(),
+                        },
+                    };
+                case "invite":
+                    return { configuration: { auth: "invited" } };
+                case "member":
+                    return { configuration: { auth: "session" } };
+                case "email":
+                    return {
+                        configuration: {
+                            auth: "email",
+                            allowed_keywords: [value || faker.faker.internet.domainName()],
+                        },
+                    };
+                default:
+                    return { configuration: { auth: "no" } };
+            }
+        };
+        this.update = ({ ownerId, auth, value }) => this.neetoPlaywrightUtilities.apiRequest({
+            body: this.buildBody(auth, value),
+            url: SECURITY_BASE_URL,
+            ...(ownerId && { params: neetoCist.keysToSnakeCase({ ownerId }) }),
+            method: "put",
+        });
+    }
+}
+
 class TagsApi {
     constructor(neetoPlaywrightUtilities) {
         this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
@@ -263,6 +300,119 @@ class TagsApi {
     }
 }
 
+const ENVIRONMENT = {
+    development: "development",
+    staging: "staging",
+    review: "review",
+};
+const EXAMPLE_URL = "https://example.com";
+const IS_STAGING_ENV = process.env.TEST_ENV === "staging";
+const STORAGE_STATE = "./e2e/auth/user.json";
+const GLOBAL_TRANSLATIONS_PATTERN = "../node_modules/@bigbinary/**/translations/en.json";
+const PROJECT_TRANSLATIONS_PATH = "../app/javascript/src/translations/en.json";
+const CREDENTIALS = {
+    name: "Oliver Smith",
+    email: "oliver@example.com",
+    password: "welcome",
+};
+const OTP_EMAIL_PATTERN = "is your login code";
+const SLACK_DEFAULT_CHANNEL = "general";
+const CUSTOM_DOMAIN_SUFFIX = "aceinvoice.com";
+const ZAPIER_TEST_EMAIL = (product) => `neeto-${product}-zapier-test@${process.env.FASTMAIL_DOMAIN_NAME}`;
+// constants for translation
+const SINGULAR = { count: 1 };
+const PLURAL = { count: 2 };
+const COLOR = {
+    transparent: "rgba(0, 0, 0, 0)",
+    softBlue: "rgb(230, 244, 255)",
+};
+const DATE_TEXTS = { now: "Now", nextYear: "next-year" };
+const EMPTY_STORAGE_STATE = {
+    storageState: { cookies: [], origins: [] },
+};
+const CURRENT_TIME_RANGES = {
+    last24Hours: "Last 24 hours",
+    thisWeek: "This week",
+    thisMonth: "This month",
+    thisYear: "This year",
+    thisQuarter: "This quarter",
+    last30Days: "Last 30 days",
+    last7Days: "Last 7 days",
+};
+const PAST_TIME_RANGES = {
+    lastWeek: "Last week",
+    lastMonth: "Last month",
+    lastYear: "Last year",
+    lastQuarter: "Last quarter",
+};
+const TIME_RANGES = {
+    ...PAST_TIME_RANGES,
+    ...CURRENT_TIME_RANGES,
+    customDuration: "Custom duration",
+};
+const DATE_RANGES = {
+    ...PAST_TIME_RANGES,
+    ...CURRENT_TIME_RANGES,
+    after: "After",
+    before: "Before",
+    customDateRange: "Custom date range",
+};
+const CERTIFICATE_LIMIT_EXCEEDED_REGEXP = `too many certificates \\(\\d+\\) already issued for "${CUSTOM_DOMAIN_SUFFIX}"`;
+const CERTIFICATE_LIMIT_EXCEEDED_MESSAGE = "Certificate limit exceeded for custom domain";
+const EXPORT_FILE_TYPES = {
+    pdf: "pdf",
+    excel: "excel",
+    csv: "csv",
+};
+
+const THANK_YOU_URL = "/neeto_thank_you/thank_you_configurations";
+class ThankYouApi {
+    constructor(neetoPlaywrightUtilities) {
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+        this.create = ({ entityId, title, }) => this.neetoPlaywrightUtilities.apiRequest({
+            method: "post",
+            body: { title, description: "" },
+            url: THANK_YOU_URL,
+            params: neetoCist.keysToSnakeCase({ entityId }),
+        });
+        this.fetch = ({ entityId }) => this.neetoPlaywrightUtilities.apiRequest({
+            url: THANK_YOU_URL,
+            params: neetoCist.keysToSnakeCase({ entityId }),
+        });
+        this.update = ({ thankYouPageId, entityId, }) => this.neetoPlaywrightUtilities.apiRequest({
+            method: "put",
+            url: `${THANK_YOU_URL}/${thankYouPageId}`,
+            body: neetoCist.keysToSnakeCase({
+                entityId,
+                thankYouConfiguration: {
+                    id: thankYouPageId,
+                    kind: "redirect_to_url",
+                    passEventDetailsToRedirectUrl: false,
+                    redirectUrl: EXAMPLE_URL,
+                },
+            }),
+        });
+    }
+}
+
+class SlackApi {
+    constructor(neetoPlaywrightUtilities) {
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+        this.apiRequest = (endpoint, params) => this.neetoPlaywrightUtilities.apiRequest({
+            url: `https://slack.com/api/conversations.${endpoint}`,
+            headers: { Authorization: `Bearer ${this.botToken}` },
+            params,
+        });
+        this.fetchMessages = (channelId, unixTimestamp) => this.apiRequest("history", { channel: channelId, oldest: unixTimestamp });
+        this.createChannel = (channelName) => this.apiRequest("create", { name: channelName });
+        this.addUser = (channelId, userId) => this.apiRequest("invite", { channel: channelId, users: userId });
+        if (!process.env.SLACK_BOT_TOKEN) {
+            throw new Error("SLACK_BOT_TOKEN is not set");
+        }
+        this.botToken = process.env.SLACK_BOT_TOKEN;
+    }
+}
+
 class WebhookSiteApi {
     constructor(request) {
         this.request = request;
@@ -272,6 +422,50 @@ class WebhookSiteApi {
     }
 }
 
+class TwilioApi {
+    constructor(neetoPlaywrightUtilities) {
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+        this.apiRequest = ({ endpoint, params, body, method = "get", }) => this.neetoPlaywrightUtilities.apiRequest({
+            method,
+            url: `/neeto_integrations/${endpoint}`,
+            ...(params && { params }),
+            ...(body && { body }),
+        });
+        this.fetch = ({ integrableId, integrableType }) => this.apiRequest({
+            endpoint: "twilio/sms_configurations",
+            ...(integrableId && {
+                params: neetoCist.keysToSnakeCase({ integrableId, integrableType }),
+            }),
+        });
+        this.disconnect = ({ integrableId, integrableType }) => this.apiRequest({
+            method: "delete",
+            endpoint: "disconnect",
+            body: neetoCist.keysToSnakeCase({
+                disconnect: { slug: "twilio" },
+                ...(integrableId && { integrableId, integrableType }),
+            }),
+        });
+        this.connect = ({ integrableId, integrableType }) => this.apiRequest({
+            endpoint: "twilio/sms_configurations",
+            method: "post",
+            body: neetoCist.keysToSnakeCase({
+                twilioAuthToken: this.authToken,
+                twilioSid: this.sid,
+                twilioPhoneNumberSid: this.defaultPhoneSid,
+                ...(integrableId && { integrableId, integrableType }),
+            }),
+        });
+        if (!process.env.TWILIO_AUTH_TOKEN ||
+            !process.env.TWILIO_SID ||
+            !process.env.TWILIO_DEFAULT_PHONE_SID) {
+            throw new Error("TWILIO_AUTH_TOKEN, TWILIO_SID, and TWILIO_DEFAULT_PHONE_SID are not set");
+        }
+        this.authToken = process.env.TWILIO_AUTH_TOKEN;
+        this.sid = process.env.TWILIO_SID;
+        this.defaultPhoneSid = process.env.TWILIO_DEFAULT_PHONE_SID;
+    }
+}
+
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
 function getDefaultExportFromCjs (x) {
@@ -4389,70 +4583,6 @@ function requireLib$c () {
 var libExports = /*@__PURE__*/ requireLib$c();
 var qs = /*@__PURE__*/getDefaultExportFromCjs(libExports);
 
-const ENVIRONMENT = {
-    development: "development",
-    staging: "staging",
-    review: "review",
-};
-const IS_STAGING_ENV = process.env.TEST_ENV === "staging";
-const STORAGE_STATE = "./e2e/auth/user.json";
-const GLOBAL_TRANSLATIONS_PATTERN = "../node_modules/@bigbinary/**/translations/en.json";
-const PROJECT_TRANSLATIONS_PATH = "../app/javascript/src/translations/en.json";
-const CREDENTIALS = {
-    name: "Oliver Smith",
-    email: "oliver@example.com",
-    password: "welcome",
-};
-const OTP_EMAIL_PATTERN = "is your login code";
-const SLACK_DEFAULT_CHANNEL = "general";
-const CUSTOM_DOMAIN_SUFFIX = "aceinvoice.com";
-const ZAPIER_TEST_EMAIL = (product) => `neeto-${product}-zapier-test@${process.env.FASTMAIL_DOMAIN_NAME}`;
-// constants for translation
-const SINGULAR = { count: 1 };
-const PLURAL = { count: 2 };
-const COLOR = {
-    transparent: "rgba(0, 0, 0, 0)",
-    softBlue: "rgb(230, 244, 255)",
-};
-const DATE_TEXTS = { now: "Now", nextYear: "next-year" };
-const EMPTY_STORAGE_STATE = {
-    storageState: { cookies: [], origins: [] },
-};
-const CURRENT_TIME_RANGES = {
-    last24Hours: "Last 24 hours",
-    thisWeek: "This week",
-    thisMonth: "This month",
-    thisYear: "This year",
-    thisQuarter: "This quarter",
-    last30Days: "Last 30 days",
-    last7Days: "Last 7 days",
-};
-const PAST_TIME_RANGES = {
-    lastWeek: "Last week",
-    lastMonth: "Last month",
-    lastYear: "Last year",
-    lastQuarter: "Last quarter",
-};
-const TIME_RANGES = {
-    ...PAST_TIME_RANGES,
-    ...CURRENT_TIME_RANGES,
-    customDuration: "Custom duration",
-};
-const DATE_RANGES = {
-    ...PAST_TIME_RANGES,
-    ...CURRENT_TIME_RANGES,
-    after: "After",
-    before: "Before",
-    customDateRange: "Custom date range",
-};
-const CERTIFICATE_LIMIT_EXCEEDED_REGEXP = `too many certificates \\(\\d+\\) already issued for "${CUSTOM_DOMAIN_SUFFIX}"`;
-const CERTIFICATE_LIMIT_EXCEEDED_MESSAGE = "Certificate limit exceeded for custom domain";
-const EXPORT_FILE_TYPES = {
-    pdf: "pdf",
-    excel: "excel",
-    csv: "csv",
-};
-
 const COMMON_SELECTORS = {
     emailInputError: "email-input-error",
     pane: "pane-wrapper",
@@ -4851,9 +4981,9 @@ const NEETO_EDITOR_SELECTORS = {
     todoListOption: optionSelector("todoList"),
     editorMenuWrapper: "neeto-editor-fixed-menu-wrapper",
     dataEmojiType: (type) => `[data-emoji="${type}"]`,
-    //Use data-cy once https://github.com/neetozone/neeto-editor/issues/1651 is resolved
+    //Use data-testid once https://github.com/neetozone/neeto-editor/issues/1651 is resolved
     calloutContent: ".callout-content",
-    //Use data-cy once https://github.com/neetozone/neeto-editor/issues/1648 is resolved
+    //Use data-testid once https://github.com/neetozone/neeto-editor/issues/1648 is resolved
     calloutTypeOption: ".neeto-editor-callout-dropdown__type-option",
     editorMediaUploaderTab: "neeto-editor-media-uploader-local-tab",
     dynamicVariableSelector: (variable) => `dynamic-variables-list-item-${joinHyphenCase(variable)}`,
@@ -113943,7 +114073,7 @@ class HelpAndProfilePage {
                 const replayAppLink = this.page.getByTestId(COMMON_SELECTORS.appLink("Replay"));
                 const searchInput = this.page.getByTestId(COMMON_SELECTORS.productSwitcherSearchInput);
                 await searchInput.fill(faker.faker.word.words(3));
-                //TODO: Use data-cy label when this https://github.com/bigbinary/neeto-molecules/issues/2114 is resolved
+                //TODO: Use data-testid label when this https://github.com/bigbinary/neeto-molecules/issues/2114 is resolved
                 await test.expect(this.page.getByText(this.t("neetoMolecules.productSwitcher.noApps"))).toBeVisible();
                 await searchInput.fill(searchQueryPartial);
                 await Promise.all([
@@ -113971,7 +114101,7 @@ class HelpAndProfilePage {
                 const replayAppLink = this.page.getByTestId(COMMON_SELECTORS.appLink("Replay"));
                 const searchInput = this.page.getByTestId(COMMON_SELECTORS.productSwitcherSearchInput);
                 await searchInput.fill(faker.faker.word.words(3));
-                //TODO: Use data-cy label when this https://github.com/bigbinary/neeto-molecules/issues/2114 is resolved
+                //TODO: Use data-testid label when this https://github.com/bigbinary/neeto-molecules/issues/2114 is resolved
                 await test.expect(this.page.getByText(this.t("neetoMolecules.productSwitcher.noApps"))).toBeVisible();
                 await searchInput.fill(searchQueryPartial);
                 await Promise.all([
@@ -116785,7 +116915,7 @@ class ZapierPage extends IntegrationBase {
             await signInPage.waitForLoadState();
             await test.expect(signInPage.getByRole("heading", { name: ZAPIER_WEB_TEXTS.loading })).toBeHidden({ timeout: 10000 });
             // The zapier connect page have two custom fm-prettytext boxes
-            // (not an input/textarea) without aria-label or data-cy
+            // (not an input/textarea) without aria-label or data-testid
             const prettyTextBox = signInPage.locator(ZAPIER_SELECTORS.fmPrettytext);
             // eslint-disable-next-line playwright/no-nth-methods
             const subdomainBox = prettyTextBox.nth(0);
@@ -117075,8 +117205,8 @@ class EditorPage {
                 .all();
             (await this.moreMenuSelector.isVisible()) && fixedMenuButtons.pop();
             return Promise.all(fixedMenuButtons.map(async (button) => {
-                const dataCy = await button.getAttribute("data-cy");
-                return this.cleanString(dataCy);
+                const dataTestid = await button.getAttribute("data-testid");
+                return this.cleanString(dataTestid);
             }));
         };
         this.moreMenuOptions = async () => {
@@ -117084,8 +117214,8 @@ class EditorPage {
             const dropdownContainer = this.page.getByTestId(COMMON_SELECTORS.dropdownContainer);
             const moreMenuButtons = await dropdownContainer.getByRole("button").all();
             const moreMenuButtonLocators = Promise.all(moreMenuButtons.map(async (button) => {
-                const dataCy = await button.getAttribute("data-cy");
-                return this.cleanString(dataCy);
+                const dataTestid = await button.getAttribute("data-testid");
+                return this.cleanString(dataTestid);
             }));
             await this.moreMenuSelector.click();
             await test.expect(dropdownContainer).toBeHidden();
@@ -117100,8 +117230,8 @@ class EditorPage {
                 .getByRole("button")
                 .all();
             const headingLevels = (await Promise.all(headingButtons.map(async (button) => {
-                const dataCy = await button.getAttribute("data-cy");
-                const headingLevel = dataCy === null || dataCy === void 0 ? void 0 : dataCy.split("-").pop();
+                const dataTestid = await button.getAttribute("data-testid");
+                const headingLevel = dataTestid === null || dataTestid === void 0 ? void 0 : dataTestid.split("-").pop();
                 return /^h[1-5]$/.test(headingLevel || "") ? headingLevel : null;
             }))).filter(Boolean);
             const fontSizeDropdown = this.editorWrapper.getByTestId(NEETO_EDITOR_SELECTORS.fontSize);
@@ -124123,7 +124253,6 @@ const definePlaywrightConfig = (overrides) => {
         ...globalOverrides,
         use: {
             baseURL: process.env.BASE_URL,
-            testIdAttribute: "data-cy",
             trace: "on",
             screenshot: "only-on-failure",
             navigationTimeout: 35000,
@@ -124200,6 +124329,7 @@ exports.EMOJI_LABEL = EMOJI_LABEL;
 exports.EMPTY_STORAGE_STATE = EMPTY_STORAGE_STATE;
 exports.ENGAGE_TEXTS = ENGAGE_TEXTS;
 exports.ENVIRONMENT = ENVIRONMENT;
+exports.EXAMPLE_URL = EXAMPLE_URL;
 exports.EXPANDED_FONT_SIZE = EXPANDED_FONT_SIZE;
 exports.EXPORT_FILE_TYPES = EXPORT_FILE_TYPES;
 exports.EditorPage = EditorPage;
@@ -124267,7 +124397,9 @@ exports.SLACK_SELECTORS = SLACK_SELECTORS;
 exports.SLACK_WEB_TEXTS = SLACK_WEB_TEXTS;
 exports.STATUS_TEXTS = STATUS_TEXTS;
 exports.STORAGE_STATE = STORAGE_STATE;
+exports.SecurityApi = SecurityApi;
 exports.SidebarSection = SidebarSection;
+exports.SlackApi = SlackApi;
 exports.SlackPage = SlackPage;
 exports.TABLE_SELECTORS = TABLE_SELECTORS;
 exports.TAB_SELECTORS = TAB_SELECTORS;
@@ -124286,7 +124418,9 @@ exports.TWILIO_SELECTORS = TWILIO_SELECTORS;
 exports.TagsApi = TagsApi;
 exports.TagsPage = TagsPage;
 exports.TeamMembers = TeamMembers;
+exports.ThankYouApi = ThankYouApi;
 exports.ThankYouPage = ThankYouPage;
+exports.TwilioApi = TwilioApi;
 exports.USER_AGENTS = USER_AGENTS;
 exports.WEBHOOK_SELECTORS = WEBHOOK_SELECTORS;
 exports.WebhookSiteApi = WebhookSiteApi;