@bigbinary/neeto-playwright-commons 1.16.7 → 1.17.1

package/index.d.ts

@@ -6,6 +6,7 @@ import { TFunction } from 'i18next';
 import { TOTP, Secret } from 'otpauth';
 import { MemberApis } from 'apis/members';
 import * as playwright_core from 'playwright-core';
+import { RoleApis } from 'apis/roles';
 import { TagsApi } from 'apis/tags';
 import { Protocol } from 'playwright-core/types/protocol';
 import * as ts_toolbelt_out_Function_Curry from 'ts-toolbelt/out/Function/Curry';
@@ -2763,6 +2764,96 @@ declare class OrganizationPage {
   }) => Promise<void>;
   changeCountry: (country: string) => Promise<void>;
 }
+interface ApiKeyDetails {
+  label: string;
+  expiryDate?: string;
+}
+declare class ApiKeysPage {
+  page: Page;
+  neetoPlaywrightUtilities: CustomCommands;
+  t: TFunction;
+  constructor(page: Page, neetoPlaywrightUtilities: CustomCommands);
+  /**
+   *
+   * Used to fill in the details for creating or editing an API key.
+   *
+   * label (required): The name for the API key.
+   *
+   * expiryDate (optional): The day of the month for the expiry date, formatted as "dd".
+   *
+   * @example 
+   *
+   * await apiKeysPage.fillApiKeyDetails({
+   *   label: "API Key",
+   *   expiryDate: "15"
+   * });
+   * @endexample
+  */
+  fillApiKeyDetails: ({
+    label,
+    expiryDate
+  }: ApiKeyDetails) => Promise<void>;
+  /**
+   *
+   * Used to verify the values in the API keys table.
+   *
+   * targetRow (required): The locator of the row where the API key should be verified.
+   *
+   * label (required): The name of the API key.
+   *
+   * date (required): The creation date of the API key, formatted as "MMM dd, yyyy".
+   *
+   * @example 
+   *
+   * await apiKeysPage.verifyApiKey({
+   *   targetRow: page.getByRole("row"),
+   *   label: "API Key",
+   *   date: "Mar 11, 2025"
+   * });
+   * @endexample
+  */
+  verifyApiKey: ({
+    targetRow,
+    label,
+    date
+  }: {
+    targetRow: Locator;
+    label: string;
+    date: string;
+  }) => Promise<[void, void, void, void]>;
+  /**
+   *
+   * Used to edit an existing API key.
+   *
+   * label (required): The new name for the API key.
+   *
+   * expiryDate (optional): The day of the month for the expiry date, formatted as "dd".
+   *
+   * @example 
+   *
+   * await apiKeysPage.editApiKey({
+   *   label: "new API Key",
+   *   expiryDate: "20"
+   * });
+   * @endexample
+  */
+  editApiKey: ({
+    label,
+    expiryDate
+  }: ApiKeyDetails) => Promise<void>;
+  /**
+   *
+   * Used to delete an existing API key.
+   *
+   * targetRow (required): The locator of the row containing the API key to delete.
+   *
+   * @example 
+   *
+   * await apiKeysPage.deleteApiKey(targetRow);
+   * @endexample
+  */
+  deleteApiKey: (targetRow: Locator) => Promise<void>;
+}
 interface VerifyAuditLogProps {
   targetRow: Locator;
   action: string;
@@ -2848,6 +2939,198 @@ declare class AuditLogsPage {
     roleName
   }: VerifyDataInPaneProps) => Promise<void>;
 }
+interface RoleDetails {
+  roleName: string;
+  permissions: string[];
+}
+interface VerifyAdminPanelCardProps {
+  cardLocator: Locator;
+  title: string;
+  description: string;
+}
+declare class RolesPage {
+  page: Page;
+  neetoPlaywrightUtilities: CustomCommands;
+  roleApis: RoleApis;
+  t: TFunction;
+  constructor(page: Page, neetoPlaywrightUtilities: CustomCommands);
+  private getPermissionIds;
+  private getRoleIdAndOrganizationId;
+  /**
+   *
+   * Used to add a custom role via API request.
+   *
+   * roleName (required): The name of the role to add.
+   *
+   * targetPermissions (required): Array of permission names to assign.
+   *
+   * @example 
+   *
+   * await rolesPage.addCustomRoleViaRequest("Custom Role", ["Manage themes", "View roles"]);
+   * @endexample
+  */
+  addCustomRoleViaRequest: (roleName: string, targetPermissions: string[]) => Promise<playwright_core.APIResponse | undefined>;
+  /**
+   *
+   * Used to edit an existing role via API request.
+   *
+   * roleName (required): The name of the role to edit.
+   *
+   * targetPermissions (required): Array of permission names to update.
+   *
+   * @example 
+   *
+   * await rolesPage.editRoleViaRequest("Custom Role", ["Manage roles"]);
+   * @endexample
+  */
+  editRoleViaRequest: (roleName: string, targetPermissions: string[]) => Promise<playwright_core.APIResponse | undefined>;
+  /**
+   *
+   * Used to delete a role via API request.
+   *
+   * roleName (required): The name of the role to delete.
+   *
+   * @example 
+   *
+   * await rolesPage.deleteRoleViaRequest("Custom Role");
+   * @endexample
+  */
+  deleteRoleViaRequest: (roleName: string) => Promise<playwright_core.APIResponse | undefined>;
+  /**
+   *
+   * Used to add a role through the UI.
+   *
+   * roleName (required): The name of the role to add.
+   *
+   * permissions (required): Array of permission names to assign.
+   *
+   * @example 
+   *
+   * await rolesPage.addRoleViaUI({
+   *   roleName: "Custom Role",
+   *   permissions: ["Manage themes", "View roles"]
+   * });
+   * @endexample
+  */
+  addRoleViaUI: ({
+    roleName,
+    permissions
+  }: RoleDetails) => Promise<void>;
+  /**
+   *
+   * Used to edit an existing role through the UI.
+   *
+   * roleName (required): The name of the role to edit.
+   *
+   * permissions (required): Array of permission names to update.
+   *
+   * @example 
+   *
+   * await rolesPage.editRoleViaUI({
+   *   roleName: "Custom Role",
+   *   permissions: ["Manage roles"]
+   * });
+   * @endexample
+  */
+  editRoleViaUI: ({
+    roleName,
+    permissions
+  }: RoleDetails) => Promise<void>;
+  /**
+   *
+   * Used to select permissions.
+   *
+   * permissions (required): Array of permission names to select.
+   *
+   * @example 
+   *
+   * await rolesPage.selectAndSubmitPermissions(["Manage themes", "View roles"]);
+   * @endexample
+  */
+  selectAndSubmitPermissions: (permissions: string[]) => Promise<void>;
+  /**
+   *
+   * Used to verify the admin panel card details.
+   *
+   * cardLocator (required): The locator of the card to verify.
+   *
+   * title (required): The title of the card.
+   *
+   * description (required): The description of the card.
+   *
+   * @example 
+   *
+   * await rolesPage.verifyAdminPanelCard({
+   *   description: "Roles card description",
+   *   title: "Roles card title",
+   *   cardLocator: page.getByTestId("roles-tab"),
+   * });
+   * @endexample
+  */
+  verifyAdminPanelCard: ({
+    cardLocator,
+    title,
+    description
+  }: VerifyAdminPanelCardProps) => Promise<[void, void, void]>;
+  /**
+   *
+   * Used to delete a role through the UI.
+   *
+   * roleName (required): The name of the role to delete.
+   *
+   * @example 
+   *
+   * await rolesPage.deleteRoleViaUI("Custom Role");
+   * @endexample
+  */
+  deleteRoleViaUI: (roleName: string) => Promise<void>;
+  /**
+   *
+   * Used to verify role permissions visibility.
+   *
+   * allPermissions (required): Object containing all possible permissions.
+   *
+   * rolePermissions (required): Array of permissions assigned to the role.
+   *
+   * @example 
+   *
+   * await rolesPage.verifyPermissions({
+   *   allPermissions: { adminPanel: "settings-nav-tab", members: "members-nav-tab" },
+   *   rolePermissions: ["members-nav-tab"]
+   * });
+   * @endexample
+  */
+  verifyPermissions: ({
+    allPermissions,
+    rolePermissions
+  }: {
+    allPermissions: object;
+    rolePermissions: string[];
+  }) => Promise<void[]>;
+  /**
+   *
+   * Used to verify role-specific link access.
+   *
+   * roleAccessableLinks (optional): Array of links the role can access.
+   *
+   * adminAccessableLinks (required): Array of links an admin can access.
+   *
+   * @example 
+   *
+   * await rolesPage.verifyRoleSpecificLinkAccess({
+   *   roleAccessableLinks: ["/themes","/seo","roles"],
+   *   adminAccessableLinks: ["/themes"]
+   * });
+   * @endexample
+  */
+  verifyRoleSpecificLinkAccess: ({
+    roleAccessableLinks,
+    adminAccessableLinks
+  }: {
+    roleAccessableLinks?: string[];
+    adminAccessableLinks: string[];
+  }) => Promise<void>;
+}
 declare class SidebarSection {
   page: Page;
   neetoPlaywrightUtilities: CustomCommands;
@@ -3178,6 +3461,14 @@ declare const SINGULAR: {
 declare const PLURAL: {
   count: number;
 };
+declare const COLOR: {
+  transparent: string;
+  softBlue: string;
+};
+declare const DATE_TEXTS: {
+  now: string;
+  nextYear: string;
+};
 declare const USER_AGENTS: {
   windows: string;
   mac: string;
@@ -5135,6 +5426,8 @@ declare const ZAPIER_SELECTORS: {
  *
  * columnHeaderTitle: Selector for column header title.
  *
+ * columnMenuButton: Selector for column menu button.
+ *
 */
 declare const TABLE_SELECTORS: {
   freezeUnfreezeButton: string;
@@ -5142,6 +5435,7 @@ declare const TABLE_SELECTORS: {
   descendingButton: string;
   hideButton: string;
   columnHeaderTitle: (columnName: string) => string;
+  columnMenuButton: string;
 };
 /**
  *
@@ -5987,4 +6281,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, COMMON_TEXTS, 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, TABLE_SELECTORS, 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, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, simulateClickWithDelay, simulateTypingWithDelay, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };
+export { API_ROUTES, AUDIT_LOGS_TEXTS, ApiKeysPage, AuditLogsPage, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COLOR, COMMON_SELECTORS, COMMON_TEXTS, CREDENTIALS, CustomCommands, type CustomFixture, DATE_TEXTS, 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, RolesPage, SELECT_COUNTRY, SIGNUP_SELECTORS, SINGULAR, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TABLE_SELECTORS, 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, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, simulateClickWithDelay, simulateTypingWithDelay, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };