@bigbinary/neeto-playwright-commons 1.27.0 → 1.27.2

package/index.d.ts

@@ -963,6 +963,7 @@ declare class SlackApi {
   fetchMessages: (channelId: string, unixTimestamp: number) => Promise<playwright_core.APIResponse | undefined>;
   createChannel: (channelName: string) => Promise<playwright_core.APIResponse | undefined>;
   addUser: (channelId: string, userId: string) => Promise<playwright_core.APIResponse | undefined>;
+  mockChannelDeleted: (channelId: string) => Promise<playwright_core.APIResponse | undefined>;
 }
 declare class WebhookSiteApi {
   private readonly request;
@@ -2173,7 +2174,6 @@ declare class HelpAndProfilePage {
     kbDocsBaseURL,
     changelogBaseURL
   }: HelpAndProfilePageInitializerProps);
-  private hoverOnBody;
   /**
    *
    * Opens the Help Center and expects the chat button within it to be visible.
@@ -2689,6 +2689,9 @@ interface CreateNewSlackChannelParams {
 declare class SlackPage extends IntegrationBase {
   slackWebappPage: Page;
   slackWebappPageDataQa: (dataQa: string | [string, string]) => Locator;
+  allowButton: Locator;
+  callbackUrl: string;
+  currentWorkspace: string;
   constructor({
     page,
     neetoPlaywrightUtilities,
@@ -2706,15 +2709,40 @@ declare class SlackPage extends IntegrationBase {
    * @endexample
   */
   setupCloseHandlers: (slackWebappPage?: Page) => Promise<void>;
+  private initializeSlackPermissionPage;
   /**
    *
-   * Connects to slack integration and verifies the connection. It takes the following parameters:
+   * Navigates the page to the captured Slack OAuth callback URL. Uses HTTP in place of HTTPS for local/dev. Call captureCallbackUrl before starting the OAuth flow so the callback URL is set. Used when running test against
    *
-   * redirectUrl: URL to redirect after connecting.
+   * dev env.
+   *
+   * @example 
+   *
+   * await slackPage.navigateToCallbackUrl();
+   * @endexample
+  */
+  navigateToCallbackUrl: () => Promise<void>;
+  /**
+   *
+   * Registers a request listener that captures the Slack OAuth callback URL when a request to /neeto_slack/api/v2/slack/callbacks is made. The URL is stored for use by navigateToCallbackUrl. Call this before starting the OAuth flow (e.g. before clicking the Slack "Allow" button in dev).
+   *
+   * @example 
+   *
+   * slackPage.captureCallbackUrl();
+   * @endexample
+  */
+  captureCallbackUrl: () => Page;
+  private connectAndVerifyInDev;
+  private connectAndVerifyInStaging;
+  /**
+   *
+   * Completes the Slack OAuth flow and verifies the integration is connected. In dev, captures the callback URL and navigates to it; in staging, relies on redirect. Then configures the given channel and runs optional custom steps.
+   *
+   * redirectUrl: URL or pattern to wait for after OAuth redirect.
    *
    * customSteps (optional): Custom steps to perform after connection.
    *
-   * channelToConfigure (optional): Channel to configure.
+   * channelToConfigure (optional): Slack channel to select in the configure step. Defaults to SLACK_DEFAULT_CHANNEL.
    *
    * @example 
    *
@@ -2726,6 +2754,7 @@ declare class SlackPage extends IntegrationBase {
    * @endexample
   */
   connectAndVerifyIntegration: (redirectUrl: RedirectUrl, customSteps?: AsyncNoArgsFunction, channelToConfigure?: string) => Promise<void>;
+  private completeSlackChannelSetup;
   /**
    *
    * Disconnects from Slack integration and verifies disconnection.
@@ -2898,17 +2927,6 @@ declare class WebhooksPage {
   /**
    * @deprecated This method is deprecated. Use getTokenViaAPI instead.
    */
-  /**
-   *
-   * Retrieves the webhook URL and token from a third-party site.
-   *
-   * Object containing webhook site URL and token.
-   *
-   * @example 
-   *
-   *   const { webhookSiteURL, webhookToken } = await webhooksPage.getWebhookURL();
-   * @endexample
-  */
   getWebhookURL: () => Promise<{
     webhookSiteURL: string;
     webhookToken: string | undefined;
@@ -4580,19 +4598,20 @@ declare class ApiKeysPage {
   neetoPlaywrightUtilities: CustomCommands;
   t: TFunction;
   constructor(page: Page, neetoPlaywrightUtilities: CustomCommands);
+  private enableExpiryDate;
   /**
    *
    * 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".
+   * expiryDate (optional): The expiry date for the API key, formatted as "DD/MM/YYYY".
    *
    * @example 
    *
    * await apiKeysPage.fillApiKeyDetails({
    *   label: "API Key",
-   *   expiryDate: "15"
+   *   expiryDate: "08/11/2025"
    * });
    * @endexample
   */
@@ -4723,23 +4742,6 @@ declare class AuditLogsPage {
   messageBuilders: MessageBuilders;
   private admin;
   constructor(page: Page, neetoPlaywrightUtilities: CustomCommands, product?: NeetoProducts | undefined);
-  verifyAuditLogs: <T extends ActionDataKey>({
-    action,
-    adminName,
-    data
-  }: VerifyAuditLogProps<T>) => Promise<void>;
-  private assertAuditLogContent;
-  /**
-   * @deprecated This method is deprecated. Use verifyAuditLogs instead.
-   */
-  verifyDataInPane: ({}: {}) => void;
-  /**
-   * @deprecated This method is deprecated. Use verifyAuditLogs instead.
-   */
-  verifyAuditLog: ({}: {}) => Promise<void>;
-  /**
-   * @deprecated This method is deprecated. Use verifyAuditLogs instead.
-   */
   /**
    *
    * Verifies an audit log entry by building the expected message based on the action type and data, then checking that the audit log content matches the expected message and current date.
@@ -4752,13 +4754,30 @@ declare class AuditLogsPage {
    *
    * @example 
    *
-   * await auditLogsPage.verifyAuditLogEntry({
+   * await auditLogsPage.verifyAuditLogs({
    *   action: ACTIONS.inviteUsers,
    *   adminName: "Oliver Smith",
    *   data: { emails: ["user1@example.com", "user2@example.com"] },
    * });
    * @endexample
   */
+  verifyAuditLogs: <T extends ActionDataKey>({
+    action,
+    adminName,
+    data
+  }: VerifyAuditLogProps<T>) => Promise<void>;
+  private assertAuditLogContent;
+  /**
+   * @deprecated This method is deprecated. Use verifyAuditLogs instead.
+   */
+  verifyDataInPane: ({}: {}) => void;
+  /**
+   * @deprecated This method is deprecated. Use verifyAuditLogs instead.
+   */
+  verifyAuditLog: ({}: {}) => Promise<void>;
+  /**
+   * @deprecated This method is deprecated. Use verifyAuditLogs instead.
+   */
   verifyAuditLogEntry: ({}: {}) => Promise<void>;
 }
 interface CustomDomainPageProps {
@@ -5533,6 +5552,13 @@ declare const networkConditions: Record<"Slow 3G" | "Fast 3G" | "No Throttling",
 declare const TEAM_MEMBER_TEXTS: {
   emailSubject: string;
 };
+declare const KEYBOARD_SHORTCUT_TEST_CASES: readonly [{
+  readonly os: "windows";
+  readonly agent: string;
+}, {
+  readonly os: "mac";
+  readonly agent: string;
+}];
 /**
  *
  * newConversation: Text for initiating a new conversation.
@@ -6712,6 +6738,7 @@ declare const NEETO_FILTERS_SELECTORS: {
  *
 */
 declare const HELP_CENTER_SELECTORS: {
+  helpMenuBtn: string;
   helpButton: string;
   documentationButton: string;
   keyboardShortcutButton: string;
@@ -7882,6 +7909,23 @@ declare const readFileSyncIfExists: ReadFileSyncIfExists;
  * @example 
  *
  *   const user = getGlobalUserState()
+ * 
+ *   console.log(userProps);
+ * 
+ *   Output:
+ *  {
+ *    firstName: 'André',
+ *    lastName: "O'Reilly",
+ *    otp: 111111,
+ *    domain: 'neetoform.net',
+ *    currentUserName: "André O'Reilly",
+ *    businessName: 'cpt-form-0903-0828-11339',
+ *    subdomainName: 'cpt-form-0903-0828-11339',
+ *    email: 'cpts9gnqty9+form+0903-0828-11339@bigbinary.com',
+ *    isLoggedIn: 'true',
+ *    baseUrl: 'https://cpt-form-0903-0828-11339.neetoform.net'
+ *  }
+ * 
  * @endexample
 */
 declare const getGlobalUserState: () => Record<string, string>;
@@ -7928,19 +7972,6 @@ declare const clearCredentials: ClearCredentials;
 /**
  * @deprecated Use hyphenate from neeto-cist instead.
  */
-/**
- *
- * Used to hyphenize the strings. It takes the following parameters:
- *
- * input: The string that need to hyphenized.
- *
- * @example 
- *
- *   import {hyphenize} from  "@bigbinary/neeto-playwright-commons"
- *   const name = hyphenize("hello world")
- *   console.log(name) // hello-world
- * @endexample
-*/
 declare const hyphenize: Hyphenize;
 /**
  *
@@ -8806,5 +8837,5 @@ interface Overrides {
  * @endexample
 */
 declare const definePlaywrightConfig: (overrides: Overrides) => PlaywrightTestConfig<{}, {}>;
-export { ACTIONS, ADMIN_PANEL_SELECTORS, API_KEYS_SELECTORS, API_ROUTES, AUDIT_LOGS_SELECTORS, AdminPanelPage, 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, EmbedBase, FILE_FORMATS, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, GOOGLE_ANALYTICS_SELECTORS, GOOGLE_CALENDAR_DATE_FORMAT, GOOGLE_LOGIN_SELECTORS, GOOGLE_LOGIN_TEXTS, GOOGLE_SHEETS_SELECTORS, GooglePage, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IPRestrictionsPage, IP_RESTRICTIONS_SELECTORS, IS_DEV_ENV, IS_STAGING_ENV, ImageUploader, IntegrationBase, IpRestrictionsApi, KEYBOARD_SHORTCUTS_SELECTORS, 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, 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, RailsEmailRakeClient, 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_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, headerUtils, hexToRGB, hexToRGBA, hyphenize, i18nFixture, 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, writeDataToFile };
+export { ACTIONS, ADMIN_PANEL_SELECTORS, API_KEYS_SELECTORS, API_ROUTES, AUDIT_LOGS_SELECTORS, AdminPanelPage, 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, EmbedBase, FILE_FORMATS, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, GOOGLE_ANALYTICS_SELECTORS, GOOGLE_CALENDAR_DATE_FORMAT, GOOGLE_LOGIN_SELECTORS, GOOGLE_LOGIN_TEXTS, GOOGLE_SHEETS_SELECTORS, GooglePage, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IPRestrictionsPage, IP_RESTRICTIONS_SELECTORS, 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, 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, RailsEmailRakeClient, 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_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, headerUtils, hexToRGB, hexToRGBA, hyphenize, i18nFixture, 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, writeDataToFile };
 export type { BaseThemeStyle, BaseThemeStyleType, ColumnMenuAction, CountryProps, CustomFixture, IntroPageThemeStyle, IntroPageThemeStyleType, ProjectName, ThemeCategory, ValueOf };