@bigbinary/neeto-playwright-commons 1.8.35 → 1.8.37

package/index.d.ts

@@ -1,5 +1,5 @@
 import * as _playwright_test from '@playwright/test';
-import { Page, APIRequestContext, Response, APIResponse, Fixtures, PlaywrightWorkerArgs, PlaywrightWorkerOptions, PlaywrightTestArgs, PlaywrightTestOptions, Browser, Locator, FrameLocator, BrowserContext, CDPSession } from '@playwright/test';
+import { Page, APIRequestContext, Response, APIResponse, Fixtures, PlaywrightWorkerArgs, PlaywrightWorkerOptions, PlaywrightTestArgs, PlaywrightTestOptions, Browser, BrowserContext, FrameLocator, Locator, CDPSession } from '@playwright/test';
 import MailosaurClient from 'mailosaur';
 import { I18nPlaywrightFixture } from 'playwright-i18next-fixture';
 import { TFunction } from 'i18next';
@@ -111,6 +111,78 @@ declare const _default: _playwright_test.TestType<_playwright_test.PlaywrightTes
 
 declare const i18nFixture: Fixtures<I18nPlaywrightFixture, PlaywrightWorkerArgs & PlaywrightWorkerOptions, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
 
+type EmbedType = "inline" | "floatingPopup" | "elementClick";
+type GetByRoleOptions = {
+    checked?: boolean;
+    disabled?: boolean;
+    exact?: boolean;
+    expanded?: boolean;
+    includeHidden?: boolean;
+    level?: number;
+    name?: string | RegExp;
+    pressed?: boolean;
+    selected?: boolean;
+};
+type InlineCustomizationOptions = {
+    embedHeight: string;
+    embedWidth: string;
+    embedDivContainerId: string;
+};
+type VerifyInlineCustomizationParams = {
+    headingTestId: string;
+    inlineEmbedInterceptParams: Partial<InterceptMultipleResponsesParams>;
+    customizationOptions: InlineCustomizationOptions;
+};
+type FloatingPopupCustomizationOptions = {
+    buttonText: string;
+    buttonColorHex: string;
+    buttonTextColorHex: string;
+    buttonPosition: "Bottom left" | "Bottom right";
+};
+type ElementClickCustomizationOptions = {
+    customId: string;
+};
+type initializeEmbedPageParams = {
+    embedType: EmbedType;
+    embedCode: string;
+    customElementText?: string;
+};
+type EmbedBasePageConstructorParams = {
+    context: BrowserContext;
+    page: Page;
+    neetoPlaywrightUtilities: CustomCommands;
+    appName: string;
+};
+declare class EmbedBase {
+    context: BrowserContext;
+    page: Page;
+    neetoPlaywrightUtilities: CustomCommands;
+    appName: string;
+    t: TFunction;
+    embedTestPage: Page;
+    embedTestPageType: EmbedType;
+    embeddedFrame: FrameLocator;
+    filePath: string;
+    codeBlock: Locator;
+    previewTab: Locator;
+    constructor({ context, page, neetoPlaywrightUtilities, appName, }: EmbedBasePageConstructorParams);
+    initializeEmbedPage: ({ embedType, embedCode, customElementText, }: initializeEmbedPageParams) => Promise<Page>;
+    closeEmbedModalAndPage: () => Promise<void>;
+    clickOnPopupButton: (popUpButtonSelectorOptions: GetByRoleOptions) => Promise<void>;
+    copyEmbedScript: ({ embedLabel }: {
+        embedLabel: string;
+    }) => Promise<string>;
+    selectEmbedType: (embedLabel: string) => Promise<void>;
+    verifyInlineCustomization: ({ headingTestId, inlineEmbedInterceptParams, customizationOptions, }: VerifyInlineCustomizationParams) => Promise<void>;
+    verifyFloatingPopupCustomization: (customizationOptions: FloatingPopupCustomizationOptions) => Promise<void>;
+    verifyElementClickCustomization: (customizationOptions: ElementClickCustomizationOptions) => Promise<void>;
+    expectMultipleTextsInCodeblock: (containTextOptions: [
+        string | RegExp,
+        string | RegExp,
+        ...(string | RegExp)[]
+    ]) => Promise<void>;
+}
+
 interface HelpAndProfilePageInitializerProps {
     page: Page;
     neetoPlaywrightUtilities: CustomCommands;
@@ -320,6 +392,7 @@ declare const THIRD_PARTY_ROUTES: {
 declare const networkConditions: Record<"Slow 3G" | "Fast 3G" | "No Throttling", Protocol.Network.emulateNetworkConditionsParameters>;
 
 declare const COMMON_SELECTORS: {
+    copyButton: string;
     spinner: string;
     subheaderText: string;
     alertTitle: string;
@@ -334,6 +407,7 @@ declare const COMMON_SELECTORS: {
     paneHeader: string;
     profileSidebar: string;
     selectOption: (label: string) => string;
+    radioLabel: (embedLabel: string) => string;
     toastMessage: string;
     toastCloseButton: string;
     windowAlert: string;
@@ -649,6 +723,7 @@ declare const skipTest: {
 };
 declare const shouldSkipSetupAndTeardown: () => boolean | "";
 declare const squish: (text: string) => string;
+declare const toCamelCase: (string: string) => string;
 
 interface LoginProps {
     page: Page;
@@ -756,4 +831,4 @@ interface Overrides {
 }
 declare const definePlaywrightConfig: (overrides: Overrides) => _playwright_test.PlaywrightTestConfig<{}, {}>;
 
-export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SlackPage, TAGS_SELECTORS, THIRD_PARTY_ROUTES, USER_AGENTS, WebhooksPage, clearCredentials, commands, cpuThrottlingUsingCDP, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, generateStagingData, getGlobalUserState, headerUtils, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, _default as stealthTest, tableUtils, updateCredentials, writeDataToFile };
+export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, ENVIRONMENT, EmbedBase, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SlackPage, TAGS_SELECTORS, THIRD_PARTY_ROUTES, USER_AGENTS, WebhooksPage, clearCredentials, commands, cpuThrottlingUsingCDP, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, generateStagingData, getGlobalUserState, headerUtils, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };