@bigbinary/neeto-playwright-commons 1.9.2 → 1.9.4

package/index.d.ts

@@ -222,6 +222,16 @@ declare class CustomCommands {
     countSelector,
     countText
   }: SearchAndVerifyProps) => Promise<void>;
+  /**
+   *
+   * Command to upload an image to image uploader and verify it.
+   *
+   * @example 
+   *
+   * await neetoPlaywrightUtilities.uploadImage("../assets/image.png");
+   * @endexample
+  */
+  uploadImage: (localImagePath: string) => Promise<void>;
 }
 interface EmailContentParams {
   email: string;
@@ -616,6 +626,249 @@ declare class ZapierPage extends IntegrationBase {
   }) => Promise<string>;
   disconnectAndVerify: () => Promise<void>;
 }
+interface VerifyDescriptionEditorParams {
+  text: string;
+  linkUrl?: string;
+  fileName?: string;
+  attachedImageName?: string;
+  imageUrl?: string;
+  videoUrl?: string;
+  cannedResponseSuccessMessage?: string;
+}
+declare class EditorPage {
+  page: Page;
+  neetoPlaywrightUtilities: CustomCommands;
+  t: TFunction;
+  paragraphSelector: Locator;
+  fixedMenuArrowSelector: Locator;
+  editorLinkButton: Locator;
+  attachmentPreview: Locator;
+  editorAttachmentsButton: Locator;
+  imageUploadDeleteButton: Locator;
+  imageWrapper: Locator;
+  imageUploadOption: Locator;
+  cannedResponseOption: Locator;
+  videoEmbedOption: Locator;
+  videoWrapperSelector: Locator;
+  emojiDropdownIcon: Locator;
+  constructor(page: Page, neetoPlaywrightUtilities: CustomCommands);
+  verifyDescriptionEditor: ({
+    text,
+    linkUrl,
+    fileName,
+    imageUrl,
+    videoUrl,
+    cannedResponseSuccessMessage
+  }: VerifyDescriptionEditorParams) => Promise<void>;
+}
+interface CropImageProps {
+  toggleAspectRatioLock: boolean;
+  aspectRatioHeight: string;
+  aspectRatioWidth: string;
+  width: string;
+  height: string;
+}
+interface ImageLibraryProps extends Partial<CropImageProps> {
+  toggleOrginalImage?: boolean;
+  localImagePath: string;
+}
+interface SelectImage extends CropImageProps {
+  toggleOrginalImage: boolean;
+  searchTerm: string;
+  nthImage: number;
+}
+declare class ImageUploader {
+  page: Page;
+  neetoPlaywrightUtilities: CustomCommands;
+  constructor({
+    page,
+    neetoPlaywrightUtilities
+  }: {
+    page: Page;
+    neetoPlaywrightUtilities: CustomCommands;
+  });
+  private submitCroppedImage;
+  /**
+   *
+   * Used to remove an image already uploaded from the image uploader amd verify it.
+   *
+   * @example 
+   *
+   * await imageUploader.removeImage()
+   * @endexample
+  */
+  removeImage: () => Promise<void>;
+  /**
+   *
+   * Used to open the image library modal.
+   *
+   * @example 
+   *
+   * await imageUploader.openImageLibrary()
+   * @endexample
+  */
+  openImageLibrary: () => Promise<void>;
+  /**
+   *
+   * Used to crop the image. It takes the following parameters:
+   *
+   * toggleAspectRatioLock (optional): A boolean value to toggle the aspect ratio lock switch which is checked by default. Default is false.
+   *
+   * aspectRatioHeight (optional): The height of the aspect ratio. Default is 9.
+   *
+   * aspectRatioWidth (optional): The width of the aspect ratio. Default is 16.
+   *
+   * width (optional): The width of the cropped image. Default is 100.
+   *
+   * height (optional): The height of the cropped image. Default is 100.
+   *
+   * @example 
+   *
+   * await imageUploader.cropImage({
+   *     toggleAspectRatioLock: false
+   *     aspectRatioHeight: "9",
+   *     aspectRatioWidth: "16",
+   *     width: "100",
+   *     height: "100",
+   * })
+   * @endexample
+  */
+  cropImage: ({
+    toggleAspectRatioLock,
+    width,
+    height,
+    aspectRatioHeight,
+    aspectRatioWidth
+  }?: Partial<CropImageProps>) => Promise<void>;
+  /**
+   *
+   * Used to upload a new image from the library and crop it if required. It takes the following parameters:
+   *
+   * localImagePath: The path of the image to be uploaded.
+   *
+   * toggleOrginalImage (optional): A boolean value to toggle the original image switch which is not checked by default. Default is false.
+   *
+   * toggleAspectRatioLock (optional): A boolean value to toggle the aspect ratio lock switch which is checked by default. Default is false.
+   *
+   * aspectRatioHeight (optional): The height of the aspect ratio. Default is 9.
+   *
+   * aspectRatioWidth (optional): The width of the aspect ratio. Default is 16.
+   *
+   * width (optional): The width of the cropped image. Default is 100.
+   *
+   * height (optional): The height of the cropped image. Default is 100.
+   *
+   * @example 
+   *
+   * await imageUploader.uploadNewImageFromLibrary({
+   *     localImagePath,
+   *     toggleOrginalImage: false,
+   *     toggleAspectRatioLock: false,
+   *     aspectRatioHeight: "9",
+   *     aspectRatioWidth: "16",
+   *     width: "100",
+   *     height: "100",
+   * })
+   * @endexample
+  */
+  uploadNewImageFromLibrary: ({
+    localImagePath,
+    toggleOrginalImage,
+    toggleAspectRatioLock,
+    aspectRatioHeight,
+    aspectRatioWidth,
+    width,
+    height
+  }: ImageLibraryProps) => Promise<void>;
+  /**
+   *
+   * Used to select an image from the unsplash and crop it if required. It takes the following parameters:
+   *
+   * nthImage (optional): The index of the image to be selected. Default is 0.
+   *
+   * searchTerm (optional): The input for the search field.
+   *
+   * toggleOrginalImage (optional): A boolean value to toggle the original image switch which is not checked by default. Default is false.
+   *
+   * toggleAspectRatioLock (optional): A boolean value to toggle the aspect ratio lock switch which is checked by default. Default is false.
+   *
+   * aspectRatioHeight (optional): The height of the aspect ratio. Default is 9.
+   *
+   * aspectRatioWidth (optional): The width of the aspect ratio. Default is 16.
+   *
+   * width (optional): The width of the cropped image. Default is 100.
+   *
+   * height (optional): The height of the cropped image. Default is 100.
+   *
+   * @example 
+   *
+   * await imageUploader.selectImageFromWeb({
+   *     nthImage: 0,
+   *     searchTerm: "",
+   *     toggleOrginalImage: false,
+   *     toggleAspectRatioLock: false,
+   *     aspectRatioHeight: "9",
+   *     aspectRatioWidth: "16",
+   *     width: "100",
+   *     height: "100",
+   * })
+   * @endexample
+  */
+  selectImageFromWeb: ({
+    nthImage,
+    searchTerm,
+    toggleOrginalImage,
+    toggleAspectRatioLock,
+    aspectRatioHeight,
+    aspectRatioWidth,
+    width,
+    height
+  }?: Partial<SelectImage>) => Promise<void>;
+  /**
+   *
+   * Used to select an image from the library and crop it if required. It takes the following parameters
+   *
+   * nthImage (optional): The index of the image to be selected. Default is 0.
+   *
+   * searchTerm (optional): The input for the search field.
+   *
+   * toggleOrginalImage (optional): A boolean value to toggle the original image switch which is not checked by default. Default is false.
+   *
+   * toggleAspectRatioLock (optional): A boolean value to toggle the aspect ratio lock switch which is checked by default. Default is false.
+   *
+   * aspectRatioHeight (optional): The height of the aspect ratio. Default is 9.
+   *
+   * aspectRatioWidth (optional): The width of the aspect ratio. Default is 16.
+   *
+   * width (optional): The width of the cropped image. Default is 100.
+   *
+   * height (optional): The height of the cropped image. Default is 100.
+   *
+   * @example 
+   *
+   * await imageUploader.selectImageFromLibrary({
+   *     nthImage: 0,
+   *     searchTerm: "",
+   *     toggleOrginalImage: false,
+   *     toggleAspectRatioLock: false,
+   *     aspectRatioHeight: "9",
+   *     aspectRatioWidth: "16",
+   *     width: "100",
+   *     height: "100",
+   * })
+   * @endexample
+  */
+  selectImageFromLibrary: ({
+    nthImage,
+    searchTerm,
+    toggleOrginalImage,
+    toggleAspectRatioLock,
+    aspectRatioHeight,
+    aspectRatioWidth,
+    width,
+    height
+  }?: Partial<SelectImage>) => Promise<void>;
+}
 interface BasicUserInfo {
   firstName: string;
   lastName: string;
@@ -751,12 +1004,14 @@ declare const ROUTES: {
   subdomainAvailability: string;
   countries: string;
   neetoApps: string;
+  directUploads: string;
   teamMembers: {
     all: string;
     bulkUpdate: string;
     index: string;
     show: (id: string) => string;
   };
+  attachment: string;
 };
 declare const API_ROUTES: {
   teamMembers: {
@@ -784,6 +1039,9 @@ declare const THIRD_PARTY_ROUTES: {
     zapEditor: (zapId: string) => string;
   };
 };
+declare const NEETO_ROUTES: {
+  imageUploader: string;
+};
 declare const networkConditions: Record<"Slow 3G" | "Fast 3G" | "No Throttling", Protocol.Network.emulateNetworkConditionsParameters>;
 /**
  *
@@ -893,6 +1151,51 @@ declare const NEETO_EDITOR_SELECTORS: {
   addLinkTextField: string;
   addURLTextField: string;
   submitLinkButton: string;
+  fontSizeDropdown: (currentOption?: string) => string;
+  fixedMenuArrow: string;
+  cannedResponseOption: string;
+  cannedResponseSelectContainer: string;
+  fixedMenuWrapper: string;
+  linkOption: string;
+  addLinkUrlInput: string;
+  addLinkDoneButton: string;
+  unlinkButton: string;
+  editorAttachmentsButton: string;
+  attachmentPreviewDeleteButton: string;
+  imageUploadOption: string;
+  imageUploadLinkInput: string;
+  imageUploadButton: string;
+  imageUploadLinkSubmitButton: string;
+  applyButton: string;
+  videoEmbedOption: string;
+  videoEmbedInput: string;
+  videoEmbedSubmit: string;
+  videoWrapper: string;
+  paragraphOption: string;
+  attachmentPreview: string;
+};
+declare const NEETO_TEXT_MODIFIER_SELECTORS: {
+  strikeOption: string;
+  underlineOption: string;
+  highlightOption: string;
+};
+declare const TEXT_MODIFIER_SELECTORS: {
+  boldOption: string;
+  italicsOption: string;
+  codeOption: string;
+  blockquoteOption: string;
+  codeblockOption: string;
+};
+declare const LIST_MODIFIER_SELECTORS: {
+  bulletListOption: string;
+  orderedListOption: string;
+};
+declare const FONT_SIZE_SELECTORS: {
+  h1: string;
+  h2: string;
+  h3: string;
+  h4: string;
+  h5: string;
 };
 declare const NEETO_FILTERS_SELECTORS: {
   emailSelectContainer: string;
@@ -1142,6 +1445,33 @@ declare const EMBED_SELECTORS: {
   elementIdInput: string;
   previewElementPopupButton: string;
 };
+declare const NEETO_IMAGE_UPLOADER_SELECTORS: {
+  imageUploaderWrapper: string;
+  browseText: string;
+  fileInput: string;
+  uploadedImage: string;
+  uploadNewAsset: string;
+  basicImageUploaderRemoveButton: string;
+  removeButton: string;
+  openImageLibraryButton: string;
+  openAssetLibraryButton: string;
+  imageEditorBackButton: string;
+  aspectRatioWidthInput: string;
+  aspectRatioHeightInput: string;
+  cropSubmitButton: string;
+  restrictionMessage: string;
+  progressBar: string;
+  myImagesTab: string;
+  unsplashTab: string;
+  nthLibraryImage: (index: number) => string;
+  nthUnsplashImage: (index: number) => string;
+  unsplashSearchInput: string;
+  imageEditorUploadedImage: string;
+  selectOriginalImageSwitch: string;
+  lockAspectRatioSwitch: string;
+  widthInputField: string;
+  heightInputField: string;
+};
 declare const CHAT_WIDGET_TEXTS: {
   newConversation: string;
   welcomeChatBubble: string;
@@ -1190,6 +1520,43 @@ declare const TOASTR_MESSAGES: {
   zapierApiKeyGenerated: string;
 };
 declare const ZAPIER_LIMIT_EXHAUSTED_MESSAGE = "Zapier free task limit is exhausted. Test will be aborted";
+declare const EMOJI_PICKER_LABEL = "Smileys & People";
+declare const ATTACHMENT_DELETION_TOASTR_MESSAGE = "Attachment has been successfully deleted.";
+declare const DESCRIPTION_EDITOR_TEXTS: {
+  fontSize: string;
+  paragraph: string;
+  pasteLink: string;
+  invalidURLError: string;
+  pasteURL: string;
+  delete: string;
+  linkTag: string;
+  link: string;
+  cannedResponseHeader: string;
+  paragraphOption: string;
+};
+declare const EXPANDED_FONT_SIZE: {
+  h1: string;
+  h2: string;
+  h3: string;
+  h4: string;
+  h5: string;
+};
+declare const TEXT_MODIFIER_TAGS: {
+  underlineOption: string;
+  strikeOption: string;
+  highlightOption: string;
+};
+declare const TEXT_MODIFIER_ROLES: {
+  boldOption: string;
+  italicsOption: string;
+  blockquoteOption: string;
+  codeblockOption: string;
+  codeOption: string;
+};
+declare const LIST_MODIFIER_TAGS: {
+  bulletListOption: string;
+  orderedListOption: string;
+};
 /**
  *
  * Function to initialize credentials of the current user in the storageState.
@@ -1437,6 +1804,21 @@ declare const hexToRGB: (hex: string) => string;
 declare const filterUtils: {
   openFilterPane: (page: Page) => Promise<void>;
 };
+/**
+ *
+ * Function to get the image path and name from the image in a given path.
+ *
+ * @example 
+ *
+ * import { getImagePathAndName } from "@bigbinary/neeto-playwright-commons";
+ * 
+ * const { imagePath, imageName } = getImagePathAndName("../assets/images/image.png");
+ * @endexample
+*/
+declare const getImagePathAndName: (localImagePath: string) => {
+  imagePath: string;
+  imageName: string;
+};
 interface CurrentsOverrides {
   projectId: string;
 }
@@ -1465,4 +1847,4 @@ interface Overrides {
  * @endexample
 */
 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, EMBED_SELECTORS, 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_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TAGS_SELECTORS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, USER_AGENTS, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, filterUtils, generateRandomBypassEmail, generateStagingData, getByDataQA, getGlobalUserState, headerUtils, hexToRGB, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };
+export { API_ROUTES, ATTACHMENT_DELETION_TOASTR_MESSAGE, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_PICKER_LABEL, ENVIRONMENT, EXPANDED_FONT_SIZE, EditorPage, EmbedBase, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, 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, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SIGNUP_SELECTORS, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TAGS_SELECTORS, TEXT_MODIFIER_ROLES, TEXT_MODIFIER_SELECTORS, TEXT_MODIFIER_TAGS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, USER_AGENTS, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, filterUtils, generateRandomBypassEmail, generateStagingData, getByDataQA, getGlobalUserState, getImagePathAndName, headerUtils, hexToRGB, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };