@bigbinary/neeto-playwright-commons 1.16.7 → 1.17.0

package/index.cjs.js

@@ -135,6 +135,11 @@ const ZAPIER_TEST_EMAIL = (product) => `neeto-${product}-zapier-test@${process.e
 // 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" };
 
 /* eslint-disable playwright/no-skipped-test */
 const execCommand = (command) => child_process.execSync(command)
@@ -25297,6 +25302,69 @@ class OrganizationPage {
     }
 }
 
+const ADMIN_PANEL_SELECTORS = {
+    settingsItemHeading: "settings-item-heading",
+    settingsItemDescription: "settings-item-description",
+    expiryDateInput: "expiry-date-input",
+};
+
+class ApiKeysPage {
+    constructor(page, neetoPlaywrightUtilities) {
+        this.fillApiKeyDetails = async ({ label, expiryDate }) => {
+            await this.page
+                .getByTestId(COMMON_SELECTORS.paneBody)
+                .getByTestId(COMMON_SELECTORS.customInputField("label"))
+                .fill(label);
+            if (expiryDate) {
+                await this.page
+                    .getByTestId(COMMON_SELECTORS.checkboxInput("never-expires"))
+                    .uncheck();
+                await this.page
+                    .getByTestId(COMMON_SELECTORS.paneBody)
+                    .getByTestId(ADMIN_PANEL_SELECTORS.expiryDateInput)
+                    .click();
+                //TODO: Use data-cy labels when this https://github.com/bigbinary/neeto-kb-playwright/issues/47 is resolved
+                await this.page.getByLabel(DATE_TEXTS.nextYear, { exact: true }).click();
+                await this.page.getByText(expiryDate, { exact: true }).click();
+            }
+            await this.page.getByTestId(COMMON_SELECTORS.saveChangesButton).click();
+            await this.neetoPlaywrightUtilities.verifyToast();
+        };
+        this.verifyApiKey = ({ targetRow, label, date, }) => Promise.all([
+            test$1.expect(targetRow.getByRole("cell", { name: label })).toBeVisible(),
+            test$1.expect(targetRow.getByTestId(TAGS_SELECTORS.tagContainer)).toHaveText(this.t("common.active")),
+            test$1.expect(targetRow.getByRole("cell", { name: date })).toBeVisible(),
+            test$1.expect(targetRow.getByRole("cell", {
+                name: this.t("neetoApiKeys.common.never"),
+            })).toBeVisible(),
+        ]);
+        this.editApiKey = async ({ label, expiryDate }) => {
+            //TODO: Use data-cy labels when this https://github.com/bigbinary/neeto-kb-playwright/issues/46 is resolved
+            await this.page
+                .getByTestId(COMMON_SELECTORS.dropdownContainer)
+                .getByRole("button", { name: this.t("common.edit") })
+                .click();
+            await this.fillApiKeyDetails({ label, expiryDate });
+        };
+        this.deleteApiKey = async (targetRow) => {
+            await targetRow.getByTestId(COMMON_SELECTORS.dropdownIcon).click();
+            //TODO: Use data-cy labels when this https://github.com/bigbinary/neeto-kb-playwright/issues/46 is resolved
+            await this.page
+                .getByTestId(COMMON_SELECTORS.dropdownContainer)
+                .getByRole("button", { name: this.t("common.delete") })
+                .click();
+            await this.page
+                .getByTestId(COMMON_SELECTORS.alertModalSubmitButton)
+                .click();
+            await this.neetoPlaywrightUtilities.verifyToast();
+            await test$1.expect(targetRow).toBeHidden();
+        };
+        this.page = page;
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+        this.t = playwrightI18nextFixture.getI18nInstance().t;
+    }
+}
+
 class AuditLogsPage {
     constructor(page, neetoPlaywrightUtilities) {
         this.verifyAuditLog = async ({ targetRow, action, date, adminName, }) => {
@@ -25336,6 +25404,141 @@ class AuditLogsPage {
     }
 }
 
+class RoleApis {
+    constructor(neetoPlaywrightUtilities) {
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+        this.BASE_URL = "/team_members";
+        this.ORGANIZATION_ROLES_URL = `${this.BASE_URL}/organization_roles`;
+        this.fetch = (endpoint) => this.neetoPlaywrightUtilities.apiRequest({
+            url: `${this.BASE_URL}/${endpoint}`,
+        });
+        this.addRole = (roleName, permissionIds) => this.neetoPlaywrightUtilities.apiRequest({
+            url: this.ORGANIZATION_ROLES_URL,
+            method: "post",
+            data: {
+                organization_role: {
+                    name: roleName,
+                    permission_ids: permissionIds,
+                },
+            },
+        });
+        this.editRole = (roleId, body) => this.neetoPlaywrightUtilities.apiRequest({
+            url: `${this.ORGANIZATION_ROLES_URL}/${roleId}`,
+            method: "patch",
+            body: { organization_role: body },
+        });
+        this.deleteRole = (roleId, standardRoleId) => this.neetoPlaywrightUtilities.apiRequest({
+            url: `${this.ORGANIZATION_ROLES_URL}/${roleId}`,
+            method: "delete",
+            body: { new_role_id: standardRoleId },
+        });
+    }
+}
+
+class RolesPage {
+    constructor(page, neetoPlaywrightUtilities) {
+        this.getPermissionIds = async (targetPermissions) => {
+            const { permissions } = await this.roleApis
+                .fetch("permissions")
+                .then(response => response === null || response === void 0 ? void 0 : response.json());
+            const permissionObjects = targetPermissions.map(permission => neetoCist.findBy({ category: permission }, permissions));
+            return ramda.pluck("id", permissionObjects);
+        };
+        this.getRoleIdAndOrganizationId = async (roleName) => {
+            const roles = await this.roleApis
+                .fetch("organization_roles")
+                .then(response => response === null || response === void 0 ? void 0 : response.json());
+            const { id: roleId, organization_id: organizationId } = neetoCist.findBy({ name: roleName }, roles.organization_roles);
+            return { roleId, organizationId };
+        };
+        this.addCustomRoleViaRequest = async (roleName, targetPermissions) => {
+            const permissionIds = await this.getPermissionIds(targetPermissions);
+            return this.roleApis.addRole(roleName, permissionIds);
+        };
+        this.editRoleViaRequest = async (roleName, targetPermissions) => {
+            const [permissionIds, { roleId, organizationId }] = await Promise.all([
+                this.getPermissionIds(targetPermissions),
+                this.getRoleIdAndOrganizationId(roleName),
+            ]);
+            return this.roleApis.editRole(roleId, {
+                id: roleId,
+                kind: "custom",
+                name: roleName,
+                organization_id: organizationId,
+                permission_ids: permissionIds,
+            });
+        };
+        this.deleteRoleViaRequest = async (roleName) => {
+            const [{ roleId }, { roleId: editorRoleId }] = await Promise.all([roleName, "Editor"].map(this.getRoleIdAndOrganizationId));
+            return this.roleApis.deleteRole(roleId, editorRoleId);
+        };
+        this.addRoleViaUI = async ({ roleName, permissions }) => {
+            await this.page.getByTestId(ROLES_SELECTORS.newButton).click();
+            await this.page.getByTestId(ROLES_SELECTORS.nameTextField).fill(roleName);
+            await this.selectAndSubmitPermissions(permissions);
+        };
+        this.editRoleViaUI = async ({ roleName, permissions }) => {
+            await this.page
+                .getByTestId(ROLES_SELECTORS.tableHeaderRoleName)
+                .filter({ hasText: roleName })
+                .getByTestId(ROLES_SELECTORS.dropDownIcon)
+                .click();
+            await this.page.getByTestId(ROLES_SELECTORS.editRoleButton).click();
+            await this.selectAndSubmitPermissions(permissions);
+        };
+        this.selectAndSubmitPermissions = async (permissions) => {
+            for (const permission of permissions) {
+                await this.page
+                    .getByTestId(MEMBER_SELECTORS.checkboxLabel(permission))
+                    .check();
+            }
+            await this.page.getByTestId(ROLES_SELECTORS.proceedButton).click();
+            await this.neetoPlaywrightUtilities.verifyToast();
+        };
+        this.verifyAdminPanelCard = ({ cardLocator, title, description, }) => Promise.all([
+            test$1.expect(cardLocator.getByTestId(ADMIN_PANEL_SELECTORS.settingsItemHeading)).toHaveText(title),
+            test$1.expect(cardLocator.getByTestId(ADMIN_PANEL_SELECTORS.settingsItemDescription)).toHaveText(description),
+            test$1.expect(this.page.getByTestId(COMMON_SELECTORS.sidebarSubLink(title))).toHaveCSS("background-color", COLOR.transparent),
+        ]);
+        this.deleteRoleViaUI = async (roleName) => {
+            await this.page
+                .getByTestId(ROLES_SELECTORS.tableHeaderRoleName)
+                .filter({ hasText: roleName })
+                .getByTestId(ROLES_SELECTORS.dropDownIcon)
+                .click();
+            await this.page.getByTestId(ROLES_SELECTORS.deleteRoleButton).click();
+            await this.page
+                .getByTestId(COMMON_SELECTORS.alertModalSubmitButton)
+                .click();
+            await this.neetoPlaywrightUtilities.verifyToast();
+        };
+        this.verifyPermissions = ({ allPermissions, rolePermissions, }) => Promise.all(Object.values(allPermissions).map(async (permission) => rolePermissions.includes(permission)
+            ? await test$1.expect(this.page.getByTestId(permission)).toBeVisible()
+            : await test$1.expect(this.page.getByTestId(permission)).toBeHidden()));
+        this.verifyRoleSpecificLinkAccess = async ({ roleAccessableLinks = [], adminAccessableLinks = [], }) => {
+            if (neetoCist.isNotEqualDeep(roleAccessableLinks, adminAccessableLinks)) {
+                for (const link of adminAccessableLinks) {
+                    await this.page.goto(link);
+                    await this.neetoPlaywrightUtilities.waitForPageLoad();
+                    await test$1.expect(this.page.locator(COMMON_SELECTORS.tableSpinner)).toBeHidden({
+                        timeout: 15000,
+                    });
+                    const unauthorizedHeading = this.page.getByRole("heading", {
+                        name: this.t("neetoMolecules.errorPage.unauthorized"),
+                    });
+                    roleAccessableLinks.includes(link)
+                        ? await test$1.expect(unauthorizedHeading).toBeHidden()
+                        : await test$1.expect(unauthorizedHeading).toBeVisible();
+                }
+            }
+        };
+        this.page = page;
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+        this.roleApis = new RoleApis(neetoPlaywrightUtilities);
+        this.t = playwrightI18nextFixture.getI18nInstance().t;
+    }
+}
+
 class SidebarSection {
     constructor(page, neetoPlaywrightUtilities) {
         this.clickOnSubLink = (label) => this.page.getByTestId(COMMON_SELECTORS.sidebarSubLink(label)).click();
@@ -158655,15 +158858,18 @@ const definePlaywrightConfig = (overrides) => {
 
 exports.API_ROUTES = API_ROUTES;
 exports.AUDIT_LOGS_TEXTS = AUDIT_LOGS_TEXTS;
+exports.ApiKeysPage = ApiKeysPage;
 exports.AuditLogsPage = AuditLogsPage;
 exports.BASE_URL = BASE_URL;
 exports.CHANGELOG_WIDGET_SELECTORS = CHANGELOG_WIDGET_SELECTORS;
 exports.CHAT_WIDGET_SELECTORS = CHAT_WIDGET_SELECTORS;
 exports.CHAT_WIDGET_TEXTS = CHAT_WIDGET_TEXTS;
+exports.COLOR = COLOR;
 exports.COMMON_SELECTORS = COMMON_SELECTORS;
 exports.COMMON_TEXTS = COMMON_TEXTS;
 exports.CREDENTIALS = CREDENTIALS;
 exports.CustomCommands = CustomCommands;
+exports.DATE_TEXTS = DATE_TEXTS;
 exports.DESCRIPTION_EDITOR_TEXTS = DESCRIPTION_EDITOR_TEXTS;
 exports.EMBED_SELECTORS = EMBED_SELECTORS;
 exports.EMOJI_LABEL = EMOJI_LABEL;
@@ -158708,6 +158914,7 @@ exports.PROFILE_SECTION_SELECTORS = PROFILE_SECTION_SELECTORS;
 exports.PROJECT_TRANSLATIONS_PATH = PROJECT_TRANSLATIONS_PATH;
 exports.ROLES_SELECTORS = ROLES_SELECTORS;
 exports.ROUTES = ROUTES;
+exports.RolesPage = RolesPage;
 exports.SELECT_COUNTRY = SELECT_COUNTRY;
 exports.SIGNUP_SELECTORS = SIGNUP_SELECTORS;
 exports.SINGULAR = SINGULAR;