@bigbinary/neeto-playwright-commons 1.19.6 → 1.19.7

package/index.d.ts

@@ -1,9 +1,9 @@
 import * as playwright_core from 'playwright-core';
 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 { TFunction } from 'i18next';
 import { FastmailApi } from 'apis/fastmail';
 import { I18nPlaywrightFixture } from 'playwright-i18next-fixture';
-import { TFunction } from 'i18next';
 import { TOTP, Secret } from 'otpauth';
 import { MemberApis as MemberApis$1 } from 'apis/members';
 import { RoleApis } from 'apis/roles';
@@ -101,6 +101,7 @@ interface VerifyTooltipProps {
 }
 declare class CustomCommands {
   page: Page;
+  t: TFunction;
   responses: string[];
   request: APIRequestContext;
   baseURL: string | undefined;
@@ -442,6 +443,18 @@ declare class CustomCommands {
     helpURL,
     customPageContext
   }: VerifyHelpPopoverProps) => Promise<void>;
+  /**
+   *
+   * Method to verify the help link on the page.
+   *
+   * helpURL: URL to match against the help link's href attribute. Matching is case-insensitive.
+   *
+   * @example 
+   *
+   * await neetoPlaywrightUtilities.verifyHelpText("https://help.neetoform.com/a-sj53mrx");
+   * @endexample
+  */
+  verifyHelpText: (helpURL: string) => Promise<void>;
   /**
    *
    * Method to verify the term in the search term block.
@@ -541,6 +554,18 @@ declare class CustomCommands {
     dispatchEvent?: string;
     droppableZone?: Locator;
   }) => Promise<void>;
+  /**
+   *
+   * Method to verify the presence and content of the unsaved changes modal.
+   *
+   * shouldLeavePage (optional): A boolean indicating whether to simulate leaving the page (true) or staying on the page (false).Defaults to false.
+   *
+   * @example 
+   *
+   * await neetoPlaywrightUtilities.verifyUnsavedChangesModal(true);
+   * @endexample
+  */
+  verifyUnsavedChangesModal: (shouldLeavePage?: boolean) => Promise<void>;
 }
 declare class MemberApis {
   private neetoPlaywrightUtilities;
@@ -4607,7 +4632,35 @@ declare const LIST_MODIFIER_TAGS: {
  *
  * pendingTagContainer: Selector for pending tag container.
  *
- * nextYearButton: Selector for next-year button,
+ * nextYearButton: Selector for next-year button.
+ *
+ * secretKeyInputField: Selector for the secret key input field.
+ *
+ * activeSwitch: Selector for the active/inactive toggle switch.
+ *
+ * labelInputField: Selector for a generic label input field.
+ *
+ * imageUploadModal: Selector for the image upload modal.
+ *
+ * neetoLogo: Selector for the sidebar logo.
+ *
+ * clearSelectIndicator: Selector for the clear option.
+ *
+ * menubarContainer: Selector for the menubar container.
+ *
+ * multiEmailInputContainer: Selector for the multi-email input field.
+ *
+ * linkInputError: Selector for displaying link input validation errors.
+ *
+ * continueButton: Selector for the continue button.
+ *
+ * clearAllButton: Selector for the clear all button.
+ *
+ * requiredSwitch: Selector for the required toggle switch.
+ *
+ * customSwitch: Selector for a custom-labeled switch.
+ *
+ * `customMenuItem: Selector for a custom menu item.
  *
 */
 declare const COMMON_SELECTORS: {
@@ -4670,7 +4723,7 @@ declare const COMMON_SELECTORS: {
   sidebarToggle: string;
   subheader: string;
   settingsLink: string;
-  ticketFieldTextInput: (label: string | number) => string;
+  ticketFieldTextInput: (label: string) => string;
   appSwitcherButton: string;
   appSwitcherWrapper: string;
   tableSpinner: string;
@@ -4700,17 +4753,31 @@ declare const COMMON_SELECTORS: {
   buttonSpinner: string;
   pendingTagContainer: string;
   nextYearButton: string;
-  customSelectValueContainer: (label?: string) => string;
-  customDropDownMenu: (label?: string) => string;
   popoverTitle: string;
   helpPopoverButton: string;
   helpPopoverDesc: string;
   helpPopoverLinkButton: string;
   copyToClipboardButton: string;
   subheaderRight: string;
+  secretKeyInputField: string;
+  activeSwitch: string;
+  labelInputField: string;
+  imageUploadModal: string;
+  neetoLogo: string;
+  clearSelectIndicator: string;
+  menubarContainer: string;
+  multiEmailInputContainer: string;
+  linkInputError: string;
+  continueButton: string;
+  clearAllButton: string;
+  requiredSwitch: string;
+  customSwitch: (switchLabel: string) => string;
+  customMenuItem: (label: string) => string;
   customInputLabel: (name?: string) => string;
   customInputField: (name?: string) => string;
   customSelectContainer: (name: string) => string;
+  customSelectContainerWrapper: (label: string) => string;
+  customSelectValueContainer: (label?: string) => string;
   customCheckboxLabel: (name: string) => string;
   errorImage: string;
   customDropdownIcon: (label?: string) => string;
@@ -4718,6 +4785,7 @@ declare const COMMON_SELECTORS: {
   checkboxInput: (option?: string) => string;
   radioInput: (option?: string) => string;
   selectOptionError: (option: string) => string;
+  customDropDownMenu: (label?: string) => string;
 };
 /**
  *
@@ -4830,6 +4898,16 @@ declare const THANK_YOU_SELECTORS: {
  *
  * characterCount: Selector for the character count.
  *
+ * tableOption: Selector for the table option in the editor menu.
+ *
+ * tableCreateButton: Selector for the button that creates a table in the editor.
+ *
+ * videoUploadOption: Selector for the video upload option in the editor.
+ *
+ * editorMenuWrapper: Selector for the wrapper of the fixed editor menu.
+ *
+ * editorMediaUploaderTab: Selector for the media upload tab.
+ *
 */
 declare const NEETO_EDITOR_SELECTORS: {
   fontSize: string;
@@ -4884,6 +4962,11 @@ declare const NEETO_EDITOR_SELECTORS: {
   dynamicVariablesButton: string;
   emojiContainer: string;
   characterCount: string;
+  tableOption: string;
+  tableCreateButton: string;
+  videoUploadOption: string;
+  editorMenuWrapper: string;
+  editorMediaUploaderTab: string;
   dynamicVariableSelector: (variable: string) => string;
 };
 declare const NEETO_TEXT_MODIFIER_SELECTORS: {
@@ -5033,6 +5116,14 @@ declare const EMBED_SELECTORS: {
  *
  * filtersTermBlock: Custom selector for filters term block.
  *
+ * filtersSegmentName: Selector for the filter segment name input.
+ *
+ * activeSelectContainer: Selector for the container holding the active status filter.
+ *
+ * dateRange: Selector for a specific date range filter by name.
+ *
+ * segmentLabel: Selector for a specific segment block label.
+ *
 */
 declare const NEETO_FILTERS_SELECTORS: {
   emailSelectContainer: string;
@@ -5052,8 +5143,12 @@ declare const NEETO_FILTERS_SELECTORS: {
   paneModalCrossIcon: string;
   searchTermBlock: string;
   categoriesFilter: string;
+  filtersSegmentName: string;
+  activeSelectContainer: string;
   neetoFiltersFilter: (filterName: string) => string;
   filtersTermBlock: (filterType?: string) => string;
+  dateRange: (filterName: string) => string;
+  segmentLabel: (label: string) => string;
 };
 /**
  *
@@ -5498,6 +5593,20 @@ declare const TAB_SELECTORS: {
  *
  * descriptionTextArea: Selector for the description text area for tags.
  *
+ * addTagButton: Selector for the button to add a new tag.
+ *
+ * tagSearchField: Selector for the tag search input field.
+ *
+ * deleteTagButton: Selector for the button to delete a tag.
+ *
+ * metaDataCard: Selector for the metadata card container.
+ *
+ * metaDataBlock: Selector for individual metadata blocks inside the card.
+ *
+ * tagContainer: Selector for the tag container.
+ *
+ * tagsCount: Selector for tags count text.
+ *
 */
 declare const TAGS_SELECTORS: {
   newTagButton: string;
@@ -5514,6 +5623,7 @@ declare const TAGS_SELECTORS: {
   metaDataCard: string;
   metaDataBlock: string;
   tagContainer: string;
+  tagsCount: string;
 };
 /**
  *
@@ -5579,7 +5689,9 @@ declare const MERGE_TAGS_SELECTORS: {
  *
  * chatQuestionHeader: Selector for the chat question header.
  *
- * openButton: Selector for the chat widget open button.
+ * openChat: Selector for the chat widget open button.
+ *
+ * homeScreenSubtitle: Selector for the home screen subtitle.
  *
 */
 declare const CHAT_WIDGET_SELECTORS: {
@@ -5592,6 +5704,7 @@ declare const CHAT_WIDGET_SELECTORS: {
   closeChat: string;
   chatQuestionHeader: string;
   openChat: string;
+  homeScreenSubtitle: string;
 };
 /**
  *
@@ -5651,6 +5764,8 @@ declare const KEYBOARD_SHORTCUTS_SELECTORS: {
  *
  * manageButton: Selector for the manage button.
  *
+ * integrationConnectedTag: Selector for the connected tag.
+ *
 */
 declare const INTEGRATION_SELECTORS: {
   integrationCard: (integration: string) => string;
@@ -5658,6 +5773,7 @@ declare const INTEGRATION_SELECTORS: {
   integrationStatusTag: string;
   disconnectButton: string;
   manageButton: string;
+  integrationConnectedTag: string;
 };
 declare const GOOGLE_LOGIN_SELECTORS: {
   totpNext: string;
@@ -5796,6 +5912,10 @@ declare const SLACK_DATA_QA_SELECTORS: {
  *
  * deleteSecret: Selector for delete secret key button.
  *
+ * editWebhookButton: Selector for edit API key button.
+ *
+ * deleteWebhookButton: Selector for delete API key button.
+ *
 */
 declare const WEBHOOK_SELECTORS: {
   addNewWebhook: string;
@@ -5808,6 +5928,8 @@ declare const WEBHOOK_SELECTORS: {
   eventsSelectError: string;
   regenerateSecret: string;
   deleteSecret: string;
+  editWebhookButton: string;
+  deleteWebhookButton: string;
 };
 /**
  *
@@ -5978,11 +6100,55 @@ declare const CUSTOM_DOMAIN_SELECTORS: {
  *
  * addApiKeyButton: Selector for the add API key button.
  *
+ * apiKeysLabelField: Selector for the API key label input field.
+ *
+ * apiKeysExpiresAtField: Selector for the API key expiry input field.
+ *
+ * expiryDateInputError: Selector for the expiry date input error message.
+ *
+ * expiryDateInput: Selector for the expiry date input field.
+ *
+ * tokenField: Selector for the token input or display field.
+ *
+ * expiresAtField: Selector for the expiry date field.
+ *
+ * createdAtField: Selector for the API key creation date field.
+ *
 */
 declare const API_KEYS_SELECTORS: {
   editApiKeyButton: string;
   deleteApiKeyButton: string;
   addApiKeyButton: string;
+  apiKeysLabelField: string;
+  apiKeysExpiresAtField: string;
+  expiryDateInputError: string;
+  expiryDateInput: string;
+  apiKeysField: string;
+  tokenField: string;
+  expiresAtField: string;
+  createdAtField: string;
+};
+/**
+ *
+ * Selectors for date picker components.
+ *
+ * pickerInput: Selector for the picker input field.
+ *
+ * datePicker: Selector for the date picker component.
+ *
+ * timePicker: Selector for the time picker component.
+ *
+ * nextYearButton: Selector for the button to navigate to the next year.
+ *
+ * prevYearButton: Selector for the button to navigate to the previous year.
+ *
+*/
+declare const DATE_PICKER_SELECTORS: {
+  pickerInput: string;
+  datePicker: string;
+  timePicker: string;
+  nextYearButton: string;
+  prevYearButton: string;
 };
 /**
  *
@@ -6903,4 +7069,4 @@ interface Overrides {
  * @endexample
 */
 declare const definePlaywrightConfig: (overrides: Overrides) => _playwright_test.PlaywrightTestConfig<{}, {}>;
-export { ADMIN_PANEL_SELECTORS, API_KEYS_SELECTORS, API_ROUTES, AUDIT_LOGS_TEXTS, AdminPanelPage, ApiKeysPage, AuditLogsPage, BASE_URL, type BaseThemeStyle, type BaseThemeStyleType, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COLOR, COMMON_SELECTORS, COMMON_TEXTS, CREDENTIALS, CUSTOM_DOMAIN_SELECTORS, CustomCommands, CustomDomainPage as CustomDomainsPage, type CustomFixture, DATE_TEXTS, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_LABEL, EMPTY_STORAGE_STATE, 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, type IntroPageThemeStyle, type IntroPageThemeStyleType, KEYBOARD_SHORTCUTS_SELECTORS, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailerUtils, Member, MemberApis, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, ORGANIZATION_TEXTS, 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, THEMES_SELECTORS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, TagsPage, TeamMembers, ThankYouPage, type ThemeCategory, 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, generateRandomFile, generateStagingData, getByDataQA, getClipboardContent, getGlobalUserProps, getGlobalUserState, getImagePathAndName, getListCount, headerUtils, hexToRGB, hexToRGBA, hyphenize, i18nFixture, initializeCredentials, initializeTotp, isGithubIssueOpen, joinHyphenCase, joinString, login, loginWithoutSSO, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, serializeFileForBrowser, shouldSkipSetupAndTeardown, simulateClickWithDelay, simulateTypingWithDelay, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };
+export { ADMIN_PANEL_SELECTORS, API_KEYS_SELECTORS, API_ROUTES, AUDIT_LOGS_TEXTS, AdminPanelPage, ApiKeysPage, AuditLogsPage, BASE_URL, type BaseThemeStyle, type BaseThemeStyleType, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COLOR, COMMON_SELECTORS, COMMON_TEXTS, CREDENTIALS, CUSTOM_DOMAIN_SELECTORS, CustomCommands, CustomDomainPage as CustomDomainsPage, type CustomFixture, DATE_PICKER_SELECTORS, DATE_TEXTS, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_LABEL, EMPTY_STORAGE_STATE, 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, type IntroPageThemeStyle, type IntroPageThemeStyleType, KEYBOARD_SHORTCUTS_SELECTORS, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailerUtils, Member, MemberApis, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, ORGANIZATION_TEXTS, 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, THEMES_SELECTORS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, TagsPage, TeamMembers, ThankYouPage, type ThemeCategory, 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, generateRandomFile, generateStagingData, getByDataQA, getClipboardContent, getGlobalUserProps, getGlobalUserState, getImagePathAndName, getListCount, headerUtils, hexToRGB, hexToRGBA, hyphenize, i18nFixture, initializeCredentials, initializeTotp, isGithubIssueOpen, joinHyphenCase, joinString, login, loginWithoutSSO, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, serializeFileForBrowser, shouldSkipSetupAndTeardown, simulateClickWithDelay, simulateTypingWithDelay, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };