@bigbinary/neeto-playwright-commons 1.1.3 → 1.3.0

package/index.d.ts

@@ -19,13 +19,13 @@ interface VerifySuccessToastParams {
     closeAfterVerification: boolean;
 }
 type VerifySuccessToast = (params: VerifySuccessToastParams) => Promise<void>;
-declare const HTTP_METHODS: readonly ["get", "post", "put", "delete", "GET", "POST", "PUT", "DELETE"];
 type BasicTypesInterface = Record<string, number | string | boolean>;
+type HttpMethods = "get" | "post" | "put" | "delete";
 interface ApiRequestProps {
     url: string;
     headers?: BasicTypesInterface;
     data?: Record<string, unknown>;
-    method?: typeof HTTP_METHODS[number];
+    method?: HttpMethods;
     params?: BasicTypesInterface;
 }
 type ApiRequest = (props: ApiRequestProps & Record<string, unknown>) => Promise<APIResponse | undefined>;
@@ -55,7 +55,7 @@ interface CustomFixture {
 type Commands = Fixtures<CustomFixture, PlaywrightWorkerArgs & PlaywrightWorkerOptions, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
 declare const commands: Commands;
 
-declare const stagingData: {
+declare const generateStagingData: (product?: string) => {
     firstName: string;
     lastName: string;
     otp: number;
@@ -93,7 +93,7 @@ declare class OrganizationPage {
     neetoPlaywrightUtilities: CustomCommands;
     constructor(page: Page, neetoPlaywrightUtilities: CustomCommands);
     createOrganization: ({ email, businessName, subdomainName, firstName, lastName, appName, }: CreateOrganizationProps) => Promise<void>;
-    setupOrganization: () => Promise<void>;
+    setupOrganization: (product: string) => Promise<void>;
     updateSubdomainIfExists: (appName: string) => Promise<void>;
 }
 
@@ -107,6 +107,7 @@ declare const STORAGE_STATE = "./e2e/auth/user.json";
 declare const GLOBAL_TRANSLATIONS_PATTERN = "../node_modules/@bigbinary/**/translations/en.json";
 declare const PROJECT_TRANSLATIONS_PATH = "../app/javascript/src/translations/en.json";
 declare const CREDENTIALS: {
+    name: string;
     email: string;
     password: string;
 };
@@ -114,25 +115,189 @@ declare const CREDENTIALS: {
 declare const BASE_URL = "/api/v1";
 declare const ROUTES: {
     neetoAuth: string;
+    neetoAuthSignup: string;
     profile: string;
     login: string;
     signup: string;
     subdomainAvailability: string;
     countries: string;
     neetoApps: string;
+    teamMembers: {
+        all: string;
+        bulkUpdate: string;
+        index: string;
+        show: (id: string) => string;
+    };
 };
 
 declare const COMMON_SELECTORS: {
-    toastMessage: string;
-    toastIcon: string;
-    toastCloseButton: string;
-    dropdownIcon: string;
-    checkbox: string;
     spinner: string;
-    input: string;
+    subheaderText: string;
+    alertTitle: string;
+    alertModalMessage: string;
     alertModalSubmitButton: string;
+    checkbox: string;
+    checkboxLabel: string;
+    dropdownContainer: string;
+    dropdownIcon: string;
+    heading: string;
+    paneBody: string;
+    paneHeader: string;
+    profileSidebar: string;
+    selectOption: (label: string) => string;
+    toastMessage: string;
+    toastCloseButton: string;
+    windowAlert: string;
+    body: string;
+    toastIcon: string;
+    paneModalCrossIcon: string;
+    inputField: string;
+    alertConfirmationText: string;
+    alertCancelButton: string;
+    alertModalCrossIcon: string;
+    saveChangesButton: string;
+    cancelButton: string;
+    inputFieldError: string;
+    selectDropDownError: string;
+    subTitleHeading: string;
+    noDataTitle: string;
+    noDataDescription: string;
+    backdrop: string;
+    menuBarHeading: string;
+    dropdownWrapper: string;
+    toggleButton: string;
+    tooltip: string;
+    articlePageTitle: string;
+    tabItem: string;
+    labelInputError: string;
+    urlInputError: string;
+    noDataPrimaryButton: string;
+    modalHeader: string;
+    nameInputError: string;
     selectContainer: string;
-    subheaderText: string;
+    dropdownMenu: string;
+    sidebarToggle: string;
+    subheader: string;
+    settingsLink: string;
+    ticketFieldTextInput: (label: string | number) => string;
+};
+
+declare const NEETO_EDITOR_SELECTORS: {
+    boldOption: string;
+    italicOption: string;
+    underlineOption: string;
+    strikeOption: string;
+    codeBlockOption: string;
+    highlightOption: string;
+    linkInput: string;
+    linkSubmitButton: string;
+    commandList: (index: number) => string;
+    imageUploadUrlSubmitButton: string;
+    imageUploadUrlInputTextField: string;
+    uploadInput: string;
+    editorMenuBarWrapper: string;
+    undoOption: string;
+    redoOption: string;
+    imageWrapper: string;
+};
+
+declare const NEETO_FILTERS_SELECTORS: {
+    emailSelectContainer: string;
+    filterPaneHeading: string;
+    neetoFiltersEmailBlock: string;
+    neetoFiltersRoleBlock: string;
+    neetoFiltersBarClearButton: string;
+    neetoFiltersNameFilterField: string;
+    neetoFilterNameBlock: string;
+    roleSelectContainer: string;
+    filterButton: string;
+    filtersClearButton: string;
+    filterDoneButton: string;
+    filteredMembersCount: string;
+    allMenubarBlock: string;
+    filtersEmailFilter: string;
+    paneModalCrossIcon: string;
+};
+
+declare const HELP_CENTER_SELECTORS: {
+    helpButton: string;
+    documentationButton: string;
+    keyboardShortcutButton: string;
+    chatButton: string;
+    whatsNewButton: string;
+    whatsNewWidgetInfo: string;
+    whatsNewWidgetCloseButton: string;
+    keyboardShortcutPaneHeading: string;
+    keyboardShortcutPaneCrossIcon: string;
+};
+declare const CHAT_WIDGET_SELECTORS: {
+    chatWidgetHomeCard: string;
+    widgetSubmitButton: string;
+    chatBubbleMessage: string;
+    chatCloseButton: string;
+    widgetIframe: string;
+};
+
+declare const LOGIN_SELECTORS: {
+    appleAuthenticationButton: string;
+    emailTextField: string;
+    googleAuthenticationButton: string;
+    githubAuthenticationButton: string;
+    loginViaEmailButton: string;
+    passwordTextField: string;
+    rememberMeCheckBox: string;
+    submitButton: string;
+    twitterAuthenticationButton: string;
+};
+
+declare const MEMBER_SELECTORS: {
+    membersTab: string;
+    newButton: string;
+    continueButton: string;
+    submitButton: string;
+    searchTextField: string;
+    deactivatedAgentsButton: string;
+    activatedMembersButton: string;
+    columnCheckBox: string;
+    roleLabel: (role: string) => string;
+    dropDownIcon: string;
+    editButton: string;
+    menuBarHeading: string;
+    activateOrDeactivateMember: string;
+    columnsButton: string;
+    columnsDropdownContainer: string;
+    emailDropdownItemLabel: string;
+    roleDropdownItemLabel: string;
+    inviteStatusDropdownItemLabel: string;
+    heading: string;
+    activateButton: string;
+    deactivateButton: string;
+    rolesButton: string;
+    statusTag: string;
+};
+declare const MEMBER_FORM_SELECTORS: {
+    emailTextField: string;
+    firstNameTextField: string;
+    lastNameTextField: string;
+    emailInput: string;
+    emailErrorField: string;
+    cancelButton: string;
+};
+
+declare const ROLES_SELECTORS: {
+    newButton: string;
+    proceedButton: string;
+    cancelButton: string;
+    tableHeaderRoleName: string;
+    nameTextField: string;
+    searchTextField: string;
+    updateRolePaneHeading: string;
+    updateRoleCancelButton: string;
+    descriptionTextField: string;
+    permissionCategoryTitle: string;
+    headerColumn: string;
+    dropDownIcon: string;
+    tableHeaderRoleTitle: string;
 };
 
 declare const SIGNUP_SELECTORS: {
@@ -150,23 +315,29 @@ declare const SIGNUP_SELECTORS: {
     tryFreeButton: string;
 };
 
-declare const LOGIN_SELECTORS: {
-    appleAuthenticationButton: string;
-    emailTextField: string;
-    googleAuthenticationButton: string;
-    githubAuthenticationButton: string;
-    loginViaEmailButton: string;
-    passwordTextField: string;
-    rememberMeCheckBox: string;
+declare const TAGS_SELECTORS: {
+    newTagButton: string;
+    tagNameTextField: string;
+    editButton: string;
+    deleteButton: string;
+    cancelButton: string;
     submitButton: string;
-    twitterAuthenticationButton: string;
+    searchTextField: string;
+    descriptionTextArea: string;
 };
-
-declare const COMMON_TEXTS: {
-    edit: string;
+declare const MERGE_TAGS_SELECTORS: {
+    mergeTagsButton: string;
+    mergeButton: string;
+    sourceSearchTextField: string;
+    sourceTagsList: string;
+    destinationTagsList: string;
+    destinationSearchTextField: string;
+    cancelButton: string;
+    proceedButton: string;
+    disabledTag: string;
 };
 
-declare const initializeCredentials: () => void;
+declare const initializeCredentials: (product: string) => void;
 
 interface KeyValue {
     key: string;
@@ -181,19 +352,24 @@ type ReadFileSyncIfExists = (path?: string) => UserContext & Record<string, obje
 type WriteDataToFile = (data: string) => boolean;
 type UpdateCredentials = ({ key, value }: KeyValue) => boolean;
 type ClearCredentials = () => void;
+type Hyphenize = (input: number | string) => string;
+type JoinHyphenCase = (args: string) => string;
 declare const joinString: JoinString;
 declare const readFileSyncIfExists: ReadFileSyncIfExists;
 declare const writeDataToFile: WriteDataToFile;
 declare const updateCredentials: UpdateCredentials;
 declare const clearCredentials: ClearCredentials;
 declare const readTranslations: () => Record<string, unknown>;
+declare const hyphenize: Hyphenize;
+declare const joinHyphenCase: JoinHyphenCase;
 
 interface LoginProps {
     page: Page;
     neetoPlaywrightUtilities: CustomCommands;
+    loginPath: string;
 }
-declare const loginWithoutSSO: ({ page, neetoPlaywrightUtilities, }: LoginProps) => Promise<void>;
-declare const login: ({ page, neetoPlaywrightUtilities }: LoginProps) => Promise<false | void>;
+declare const loginWithoutSSO: ({ page, neetoPlaywrightUtilities, loginPath, }: LoginProps) => Promise<void>;
+declare const login: ({ page, neetoPlaywrightUtilities, loginPath, }: LoginProps) => Promise<false | void>;
 
 interface CurrentsOverrides {
     projectId: string;
@@ -206,4 +382,4 @@ interface Overrides {
 }
 declare const definePlaywrightConfig: (overrides: Overrides) => _playwright_test.PlaywrightTestConfig<{}, {}>;
 
-export { BASE_URL, COMMON_SELECTORS, COMMON_TEXTS, CREDENTIALS, CustomCommands, type CustomFixture, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, IS_STAGING_ENV, LOGIN_SELECTORS, OrganizationPage, PROJECT_TRANSLATIONS_PATH, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, clearCredentials, commands, definePlaywrightConfig, i18n, initializeCredentials, joinString, login, loginWithoutSSO, readFileSyncIfExists, readTranslations, stagingData, updateCredentials, writeDataToFile };
+export { BASE_URL, CHAT_WIDGET_SELECTORS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, HELP_CENTER_SELECTORS, IS_STAGING_ENV, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MERGE_TAGS_SELECTORS, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, OrganizationPage, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, TAGS_SELECTORS, clearCredentials, commands, definePlaywrightConfig, generateStagingData, hyphenize, i18n, initializeCredentials, joinHyphenCase, joinString, login, loginWithoutSSO, readFileSyncIfExists, readTranslations, updateCredentials, writeDataToFile };