vita-playwright 1.2.0 → 1.2.2

package/README.md

@@ -107,27 +107,59 @@ __Note__: getElementRefByRole() method will work for all types of roles, example
 
 #### filltheData
 ```ts
-// will be added in next versions.
+/**
+ * @description: sets the text in inputbox.
+ * @param {string}  locator - css selector/xpath of the inputbox.
+ * @param {string}  data  - Text to be set to inputbox
+ * @returns {Promise<void>} - returns Promise of void
+ */
+async filltheData(locator: any, data: any)
 ```
 #### clickonWebElement
 ```ts
-// will be added in next versions.
+/**
+ * @description: click the given locator element.
+ * @param {string}  locator - css selector/xpath of the element.
+ * @returns {Promise<void>} - returns Promise of void
+ */
+async clickonWebElement(locator: any)
 ```
 #### getInnerHTML
 ```ts
-// will be added in next versions.
+/**
+ * @description: returns inner html of locator element.
+ * @param {string}  locator - css selector/xpath of the element.
+ * @returns {string} - returns inner html string
+ */
+async getInnerHTML(locator: any)
 ```
 #### getInnerText
 ```ts
-// will be added in next versions.
+/**
+ * @description: returns inner text of locator element.
+ * @param {string}  locator - css selector/xpath of the element.
+ * @returns {string} - returns inner text string
+ */
+async getInnerText(locator: any)
 ```
 #### getText
 ```ts
-// will be added in next versions.
+/**
+ * @description: returns text of locator element.
+ * @param {string}  locator - css selector/xpath of the element.
+ * @returns {string} - returns text string
+ */
+async getText(locator: any)
 ```
 #### getAttribute
 ```ts
-// will be added in next versions.
+/**
+ * @description: returns given attribute value of locator element.
+ * @param {string}  locator - css selector/xpath of the element.
+ * @param {string} attribute - html attribute to get value
+ * @returns {string} - returns text string
+ */
+async getAttribute(locator: any, attribute: any))
 ```
 #### evaluateJS
 ```ts
@@ -135,31 +167,70 @@ __Note__: getElementRefByRole() method will work for all types of roles, example
 ```
 #### isElementPresent
 ```ts
-// will be added in next versions.
+/**
+ * @description: verifies given locator element is displayed or not.
+ * @param {string}  locator - css selector/xpath of the element.
+ * @returns {boolean} - returns true/false
+ */
+async isElementPresent(locator: any)
 ```
 #### isElementEnabled
 ```ts
-// will be added in next versions.
+/**
+ * @description: verifies given locator element is enabled or not.
+ * @param {string}  locator - css selector/xpath of the element.
+ * @returns {boolean} - returns true/false
+ */
+async isElementEnabled(locator: any)
 ```
 #### waitTillElementIsVisible
 ```ts
-// will be added in next versions.
+/**
+ * @description: waits until locator element visibles.
+ * @param {elementReference}  elementSelector - element reference.
+ * @param {number} wait time
+ * @returns {Promise<void>} - returns Promise of void
+ */
+async waitTillElementIsVisible(elementSelector: any, waitTime = 60000)
 ```
 #### getInputBoxValue
 ```ts
-// will be added in next versions.
+/**
+ * @description: returns value of inputbox.
+ * @param {string}  locator - css selector/xpath of the element.
+ * @returns {string} - returns text string
+ */
+async getInputBoxValue(locator: any)
 ```
 #### downloadAFile
 ```ts
-// will be added in next versions.
+/**
+ * @description: wait untill download process completes and save file with custom name.
+ * @param {string}  locator - css selector/xpath of the element.
+ * @param {string}  filePath - Complete path of the excel file, example: C:/resources/****.xlsx.
+ * @returns {Promise<void>} - returns Promise of void
+ */
+async downloadAFile(downloadButton: String, filePath: string)
 ```
 #### uploadAFile
 ```ts
-// will be added in next versions.
+/**
+ * @description: wait untill upload process completes and save file with custom name.
+ * @param {string}  locator - css selector/xpath of the element.
+ * @param {string}  filePath - Complete path of the excel file, example: C:/resources/****.xlsx.
+ * @returns {Promise<void>} - returns Promise of void
+ */
+async uploadAFile(uploadButton: String, uploadFilePath: String)
 ```
 #### getElementRefByRole
 ```ts
-// will be added in next versions.
+/**
+ * @description: will perform click action.
+ * @param {string}  roleType - example: "alert"|"alertdialog"|"application"|"article"|"banner"|"blockquote"|"button"|"caption"|"cell"|"checkbox"|"code"|"columnheader"|"combobox"|"complementary"|"contentinfo"|"definition"|"deletion"|"dialog"|"directory"|"document"|"emphasis"|"feed"|"figure"|"form"|"generic"|"grid"|"gridcell"|"group"|"heading"|"img"|"insertion"|"link"|"list"|"listbox"|"listitem"|"log"|"main"|"marquee"|"math"|"meter"|"menu"|"menubar"|"menuitem"|"menuitemcheckbox"|"menuitemradio"|"navigation"|"none"|"note"|"option"|"paragraph"|"presentation"|"progressbar"|"radio"|"radiogroup"|"region"|"row"|"rowgroup"|"rowheader"|"scrollbar"|"search"|"searchbox"|"separator"|"slider"|"spinbutton"|"status"|"strong"|"subscript"|"superscript"|"switch"|"tab"|"table"|"tablist"|"tabpanel"|"term"|"textbox"|"time"|"timer"|"toolbar"|"tooltip"|"tree"|"treegrid"|"treeitem".
+ * @param {string}  roleName - name of the element.
+ * @returns {Promise<void>} - returns Promise of void
+ */
+async getElementRefByRole(roleType: string, roleName: string)
 ```
 
 ## Utilities

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vita-playwright",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "email": "noreply_testautomation@vialto.com",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -50,6 +50,6 @@
   "description": "common functions for VITA framework",
   "repository": {
     "type": "git",
-    "url": "https://github.com/Vialto/fbt-test-automation"
+    "url": "https://github.com/Vialto/vialto-test-automation/"
   }
 }