@bigbinary/neeto-playwright-commons 1.15.3 → 1.16.0

package/index.d.ts

@@ -41,6 +41,11 @@ interface VerifyHelpPopoverProps {
   helpURL?: string;
   customPageContext?: Page;
 }
+interface SaveChangesProps {
+  closeAfterVerification?: boolean;
+  isPane?: boolean;
+  customPageContext?: Page;
+}
 type ConditionProps = Record<string, string>[];
 type FilterProps = Record<string, ConditionProps>;
 type ParamFilters = FilterProps[];
@@ -453,6 +458,34 @@ declare class CustomCommands {
    * @endexample
   */
   verifySearchTermBlock: (searchTerm?: string) => Promise<void>;
+  /**
+   *
+   * Used to save the changes made on the thank you page.
+   *
+   * @example 
+   *
+   * await thankYouPage.saveChanges();
+   * @endexample
+  */
+  saveChanges: ({
+    isPane,
+    customPageContext,
+    closeAfterVerification
+  }?: SaveChangesProps) => Promise<[void, false | void, void]>;
+  /**
+   *
+   * Method to hide the tooltip.
+   *
+   * triggerElement: Locator hovering on which tooltip was shown.
+   *
+   * customPageContext(optional): Custom page context on which tooltip is shown. Default to this.page.
+   *
+   * @example 
+   *
+   * await hideTooltip();
+   * @endexample
+  */
+  hideTooltip: (triggerElement: Locator, customPageContext?: Page) => Promise<void>;
 }
 type Range<N extends number, Acc extends number[] = []> = Acc["length"] extends N ? Exclude<Acc[number], 0 | Acc["length"]> | N : Range<N, [...Acc, Acc["length"]]>;
 interface MessageSearchCriteria {
@@ -1568,6 +1601,7 @@ interface VerifyWebhookResponseParams extends Record<string, unknown> {
   callback?: CallbackFunction;
   parseFullResponseContent?: boolean;
   webhookToken: string;
+  timeout?: number;
 }
 interface VerifyWebhookDeliveriesParams extends Record<string, unknown> {
   callback: CallbackFunction;
@@ -1631,11 +1665,14 @@ declare class WebhooksPage {
    *
    * Other parameters to be passed to the callback function.
    *
+   * timeout(optional): Timeout in milliseconds to fetch the latest response. Default is 20_000.
+   *
    * @example 
    *
    *   await webhooksPage.verifyLatestWebhookResponse({
    *     callback: ({ parsedResponse }) => console.log(parsedResponse),
-   *     webhookToken: "exampleToken"
+   *     webhookToken: "exampleToken",
+   *     timeout: 35_000
    *   });
    * @endexample
   */
@@ -1643,6 +1680,7 @@ declare class WebhooksPage {
     callback,
     webhookToken,
     parseFullResponseContent,
+    timeout,
     ...otherParams
   }: VerifyWebhookResponseParams) => Promise<void>;
   /**
@@ -3249,6 +3287,9 @@ declare const PLURAL: {
 declare const USER_AGENTS: {
   windows: string;
   mac: string;
+  iPhone: string;
+  iPad: string;
+  android: string;
 };
 /**
  *
@@ -6023,6 +6064,51 @@ declare const isGithubIssueOpen: (issueLinks: string[]) => Promise<boolean>;
  * @endexample
 */
 declare const hexToRGBA: (hex: string) => string;
+/**
+ *
+ * Simulates typing with a delay.
+ *
+ * @example 
+ *
+ * import { simulateTypingWithDelay } from "@bigbinary/neeto-playwright-commons";
+ * 
+ * await simulateTypingWithDelay({
+ *   field: page.getByTestId("email-field"),
+ *   value: "oliver@example.com",
+ *   delay: 600,
+ * });
+ * @endexample
+*/
+declare const simulateTypingWithDelay: ({
+  field,
+  value,
+  delay
+}: {
+  field: Locator;
+  value: string;
+  delay?: number;
+}) => Promise<void>;
+/**
+ *
+ * Simulates a click with a delay.
+ *
+ * @example 
+ *
+ * import { simulateClickWithDelay } from "@bigbinary/neeto-playwright-commons";
+ * 
+ * await simulateClickWithDelay({
+ *   element: page.getByTestId("submit-button"),
+ *   page: page,
+ * });
+ * @endexample
+*/
+declare const simulateClickWithDelay: ({
+  element,
+  page
+}: {
+  element: Locator;
+  page: Page;
+}) => Promise<void>;
 interface PlaydashOverrides {
   projectKey: string;
 }
@@ -6050,4 +6136,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, 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, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };
+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, 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, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, simulateClickWithDelay, simulateTypingWithDelay, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };