@sap_oss/wdio-qmate-service 2.1.1 → 2.2.1

package/docs/doc.md

@@ -390,7 +390,7 @@ Fills the active input with the given value.
 
 | Param | Type | Description |
 | --- | --- | --- |
-| value | <code>String</code> | The value with witch the input should be filled. |
+| value | <code>String</code> \| <code>Number</code> | The value to enter. |
 
 **Example**  
 ```js
@@ -405,7 +405,7 @@ Enters the given value to the active input field and retries the action in case
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| value | <code>String</code> |  | The value with witch the input should be filled. |
+| value | <code>String</code> |  | The value to enter. |
 | [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
 | [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |
 
@@ -1598,8 +1598,9 @@ Global namespace for UI5 modules.
         * [.doubleClick(selector, [index], [timeout])](#ui5.userInteraction.doubleClick)
         * [.rightClick(selector, [index], [timeout])](#ui5.userInteraction.rightClick)
         * [.clickTab(selector, [index], [timeout])](#ui5.userInteraction.clickTab)
-        * [.selectFromTab(selector, value, [index], [timeout])](#ui5.userInteraction.selectFromTab)
         * [.clickListItem(selector, [index], [timeout])](#ui5.userInteraction.clickListItem)
+        * [.check(selector, [index], [timeout])](#ui5.userInteraction.check)
+        * [.uncheck(selector, [index], [timeout])](#ui5.userInteraction.uncheck)
         * [.fill(selector, value, [index], [timeout])](#ui5.userInteraction.fill)
         * [.fillAndRetry(selector, value, [index], [timeout], [retries], [interval])](#ui5.userInteraction.fillAndRetry)
         * [.clear(selector, [index], [timeout])](#ui5.userInteraction.clear)
@@ -1614,6 +1615,7 @@ Global namespace for UI5 modules.
         * [.selectMultiComboBox(selector, values, [index])](#ui5.userInteraction.selectMultiComboBox)
         * [.clickSelectArrow(selector, [index])](#ui5.userInteraction.clickSelectArrow)
         * [.clickSelectArrowAndRetry(selector, [index], [retries], [interval])](#ui5.userInteraction.clickSelectArrowAndRetry)
+        * [.selectFromTab(selector, value, [index], [timeout])](#ui5.userInteraction.selectFromTab)
         * [.mouseOverElement(selector, [index], [timeout])](#ui5.userInteraction.mouseOverElement)
         * [.scrollToElement(selector, [index], [alignment], [timeout])](#ui5.userInteraction.scrollToElement)
         * [.selectAll([selector], [index], [timeout])](#ui5.userInteraction.selectAll)
@@ -3495,8 +3497,9 @@ await ui5.table.clickSettingsButton(glAccountItemsTable);
     * [.doubleClick(selector, [index], [timeout])](#ui5.userInteraction.doubleClick)
     * [.rightClick(selector, [index], [timeout])](#ui5.userInteraction.rightClick)
     * [.clickTab(selector, [index], [timeout])](#ui5.userInteraction.clickTab)
-    * [.selectFromTab(selector, value, [index], [timeout])](#ui5.userInteraction.selectFromTab)
     * [.clickListItem(selector, [index], [timeout])](#ui5.userInteraction.clickListItem)
+    * [.check(selector, [index], [timeout])](#ui5.userInteraction.check)
+    * [.uncheck(selector, [index], [timeout])](#ui5.userInteraction.uncheck)
     * [.fill(selector, value, [index], [timeout])](#ui5.userInteraction.fill)
     * [.fillAndRetry(selector, value, [index], [timeout], [retries], [interval])](#ui5.userInteraction.fillAndRetry)
     * [.clear(selector, [index], [timeout])](#ui5.userInteraction.clear)
@@ -3511,6 +3514,7 @@ await ui5.table.clickSettingsButton(glAccountItemsTable);
     * [.selectMultiComboBox(selector, values, [index])](#ui5.userInteraction.selectMultiComboBox)
     * [.clickSelectArrow(selector, [index])](#ui5.userInteraction.clickSelectArrow)
     * [.clickSelectArrowAndRetry(selector, [index], [retries], [interval])](#ui5.userInteraction.clickSelectArrowAndRetry)
+    * [.selectFromTab(selector, value, [index], [timeout])](#ui5.userInteraction.selectFromTab)
     * [.mouseOverElement(selector, [index], [timeout])](#ui5.userInteraction.mouseOverElement)
     * [.scrollToElement(selector, [index], [alignment], [timeout])](#ui5.userInteraction.scrollToElement)
     * [.selectAll([selector], [index], [timeout])](#ui5.userInteraction.selectAll)
@@ -3607,31 +3611,29 @@ The function retries the click for maximal 3 times if the selection of the tab (
 ```js
 await ui5.userInteraction.clickTab(selector);
 ```
-<a name="ui5.userInteraction.selectFromTab"></a>
+<a name="ui5.userInteraction.clickListItem"></a>
 
-#### userInteraction.selectFromTab(selector, value, [index], [timeout])
-Selects the passed value on the tab with the given selector and checks if the tab got selected successfully.
-The function retries the click for maximal 3 times if the selection of the tab (blue underline) was not successful.
+#### userInteraction.clickListItem(selector, [index], [timeout])
+Clicks or opens the list item with the given selector (e.g. ColumnListItem, StandardListItem).
+In some cases the default click function is not working correctly (clicks an element within the list item).
+Therefore we recommend to use this function to open a specific list item.
 
 **Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | selector | <code>Object</code> |  | The selector describing the element. |
-| value | <code>String</code> |  | The value to select. |
 | [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
 | [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
 
 **Example**  
 ```js
-await ui5.userInteraction.selectFromTab(selector);
+await ui5.userInteraction.clickListItem(selector);
 ```
-<a name="ui5.userInteraction.clickListItem"></a>
+<a name="ui5.userInteraction.check"></a>
 
-#### userInteraction.clickListItem(selector, [index], [timeout])
-Clicks or opens the list item with the given selector (e.g. ColumnListItem, StandardListItem).
-In some cases the default click function is not working correctly (clicks an element within the list item).
-Therefore we recommend to use this function to open a specific list item.
+#### userInteraction.check(selector, [index], [timeout])
+Checks the checkbox with the given selector.
 
 **Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  
 
@@ -3643,7 +3645,24 @@ Therefore we recommend to use this function to open a specific list item.
 
 **Example**  
 ```js
-await ui5.userInteraction.clickListItem(selector);
+await ui5.userInteraction.check(selector);
+```
+<a name="ui5.userInteraction.uncheck"></a>
+
+#### userInteraction.uncheck(selector, [index], [timeout])
+Unchecks the checkbox with the given selector.
+
+**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| selector | <code>Object</code> |  | The selector describing the element. |
+| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
+| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
+
+**Example**  
+```js
+await ui5.userInteraction.uncheck(selector);
 ```
 <a name="ui5.userInteraction.fill"></a>
 
@@ -3655,7 +3674,7 @@ Fills the input field with the given selector.
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | selector | <code>Object</code> |  | The selector describing the element. |
-| value | <code>String</code> |  | The value to fill. |
+| value | <code>String</code> \| <code>Number</code> |  | The value to enter. |
 | [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
 | [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
 
@@ -3673,7 +3692,7 @@ Fills the input field with the given selector and retries the action in case of
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | selector | <code>Object</code> |  | The selector describing the element. |
-| value | <code>String</code> |  | The value to fill. |
+| value | <code>String</code> \| <code>Number</code> |  | The value to enter. |
 | [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
 | [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
 | [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
@@ -3729,7 +3748,7 @@ Clears the input field with the given selector and fills the given value.
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | selector | <code>Object</code> |  | The selector describing the element. |
-| value | <code>String</code> |  | The value to fill. |
+| value | <code>String</code> \| <code>Number</code> |  | The value to enter. |
 | [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
 | [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
 
@@ -3747,7 +3766,7 @@ Clears the input field with the given selector and fills the given value. Retrie
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | selector | <code>Object</code> |  | The selector describing the element. |
-| value | <code>String</code> |  | The value to fill. |
+| value | <code>String</code> |  | The value to enter. |
 | [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
 | [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
 | [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
@@ -3785,7 +3804,7 @@ Clears the smart filed with the given selector and fills the given value.
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | selector | <code>Object</code> |  | The selector describing the element. |
-| value | <code>String</code> |  | The value to fill. |
+| value | <code>String</code> |  | The value to enter. |
 | [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
 | [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
 
@@ -3803,7 +3822,7 @@ Clears the smart filed with the given selector and fills the given value and ret
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | selector | <code>Object</code> |  | The selector describing the element. |
-| value | <code>String</code> |  | The value to fill. |
+| value | <code>String</code> |  | The value to enter. |
 | [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
 | [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
 | [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
@@ -3904,6 +3923,25 @@ Clicks the arrow icon at the passed selector (select box), and retries in case i
 ```js
 await ui5.userInteraction.clickSelectArrowAndRetry(selector);
 ```
+<a name="ui5.userInteraction.selectFromTab"></a>
+
+#### userInteraction.selectFromTab(selector, value, [index], [timeout])
+Selects the passed value on the tab with the given selector and checks if the tab got selected successfully.
+The function retries the click for maximal 3 times if the selection of the tab (blue underline) was not successful.
+
+**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| selector | <code>Object</code> |  | The selector describing the element. |
+| value | <code>String</code> |  | The value to select. |
+| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
+| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
+
+**Example**  
+```js
+await ui5.userInteraction.selectFromTab(selector);
+```
 <a name="ui5.userInteraction.mouseOverElement"></a>
 
 #### userInteraction.mouseOverElement(selector, [index], [timeout])
@@ -4047,6 +4085,7 @@ Global namespace for non UI5 modules.
         * [.isPresent(elem)](#nonUi5.element.isPresent) ⇒ <code>Boolean</code>
         * [.isPresentByCss(css, [index], [timeout])](#nonUi5.element.isPresentByCss) ⇒ <code>boolean</code>
         * [.isPresentByXPath(xpath, [index], [timeout])](#nonUi5.element.isPresentByXPath) ⇒ <code>boolean</code>
+        * [.isSelected(elem)](#nonUi5.element.isSelected) ⇒ <code>boolean</code>
         * [.getAttributeValue(elem, [attribute])](#nonUi5.element.getAttributeValue) ⇒ <code>String</code>
         * [.getValue(elem)](#nonUi5.element.getValue) ⇒ <code>String</code>
         * [.setInnerHTML(elem)](#nonUi5.element.setInnerHTML) ⇒ <code>String</code>
@@ -4062,6 +4101,8 @@ Global namespace for non UI5 modules.
         * [.clickAndRetry(element, [timeout], [retries], [interval])](#nonUi5.userInteraction.clickAndRetry)
         * [.doubleClick(element, [timeout])](#nonUi5.userInteraction.doubleClick)
         * [.rightClick(element, [timeout])](#nonUi5.userInteraction.rightClick)
+        * [.check(element)](#nonUi5.userInteraction.check)
+        * [.uncheck(element)](#nonUi5.userInteraction.uncheck)
         * [.fill(element, value)](#nonUi5.userInteraction.fill)
         * [.fillAndRetry(element, value, [retries], [interval])](#nonUi5.userInteraction.fillAndRetry)
         * [.clear(element)](#nonUi5.userInteraction.clear)
@@ -4201,6 +4242,7 @@ await nonUi5.assertion.expectToBeNotVisible(elem, 5000);
     * [.isPresent(elem)](#nonUi5.element.isPresent) ⇒ <code>Boolean</code>
     * [.isPresentByCss(css, [index], [timeout])](#nonUi5.element.isPresentByCss) ⇒ <code>boolean</code>
     * [.isPresentByXPath(xpath, [index], [timeout])](#nonUi5.element.isPresentByXPath) ⇒ <code>boolean</code>
+    * [.isSelected(elem)](#nonUi5.element.isSelected) ⇒ <code>boolean</code>
     * [.getAttributeValue(elem, [attribute])](#nonUi5.element.getAttributeValue) ⇒ <code>String</code>
     * [.getValue(elem)](#nonUi5.element.getValue) ⇒ <code>String</code>
     * [.setInnerHTML(elem)](#nonUi5.element.setInnerHTML) ⇒ <code>String</code>
@@ -4543,7 +4585,7 @@ await nonUi5.element.isPresentByCss(".button01");
 <a name="nonUi5.element.isPresentByXPath"></a>
 
 #### element.isPresentByXPath(xpath, [index], [timeout]) ⇒ <code>boolean</code>
-returns a boolean if the element is present at the DOM or not.
+Returns a boolean if the element is present at the DOM or not.
 
 **Kind**: static method of [<code>element</code>](#nonUi5.element)  
 
@@ -4557,6 +4599,22 @@ returns a boolean if the element is present at the DOM or not.
 ```js
 await nonUi5.element.isPresentByXPath(".//*[text()='Create']");
 ```
+<a name="nonUi5.element.isSelected"></a>
+
+#### element.isSelected(elem) ⇒ <code>boolean</code>
+Returns a boolean if the element (e.g. checkbox) is selected.
+
+**Kind**: static method of [<code>element</code>](#nonUi5.element)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| elem | <code>Object</code> | The element. |
+
+**Example**  
+```js
+const elem = await nonUi5.element.getById("elem01");
+const isSelected = await nonUi5.element.isSelected(elem);
+```
 <a name="nonUi5.element.getAttributeValue"></a>
 
 #### element.getAttributeValue(elem, [attribute]) ⇒ <code>String</code>
@@ -4721,6 +4779,8 @@ await nonUi5.session.loginSapNetWeaver("john", "abc123!");
     * [.clickAndRetry(element, [timeout], [retries], [interval])](#nonUi5.userInteraction.clickAndRetry)
     * [.doubleClick(element, [timeout])](#nonUi5.userInteraction.doubleClick)
     * [.rightClick(element, [timeout])](#nonUi5.userInteraction.rightClick)
+    * [.check(element)](#nonUi5.userInteraction.check)
+    * [.uncheck(element)](#nonUi5.userInteraction.uncheck)
     * [.fill(element, value)](#nonUi5.userInteraction.fill)
     * [.fillAndRetry(element, value, [retries], [interval])](#nonUi5.userInteraction.fillAndRetry)
     * [.clear(element)](#nonUi5.userInteraction.clear)
@@ -4803,6 +4863,36 @@ Right Clicks on the passed element.
 const elem = await nonUi5.element.getById("button01");
 await nonUi5.userInteraction.rightClick(elem);
 ```
+<a name="nonUi5.userInteraction.check"></a>
+
+#### userInteraction.check(element)
+Checks the given checkbox.
+
+**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| element | <code>Object</code> | The element. |
+
+**Example**  
+```js
+await nonUi5.userInteraction.check(selector);
+```
+<a name="nonUi5.userInteraction.uncheck"></a>
+
+#### userInteraction.uncheck(element)
+Unchecks the given checkbox.
+
+**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| element | <code>Object</code> | The element. |
+
+**Example**  
+```js
+await nonUi5.userInteraction.uncheck(selector);
+```
 <a name="nonUi5.userInteraction.fill"></a>
 
 #### userInteraction.fill(element, value)
@@ -4813,7 +4903,7 @@ Fills the given value into the passed input.
 | Param | Type | Description |
 | --- | --- | --- |
 | element | <code>Object</code> | The element. |
-| value | <code>String</code> | The value to be filled. |
+| value | <code>String</code> \| <code>Number</code> | The value to enter. |
 
 **Example**  
 ```js
@@ -4830,7 +4920,7 @@ Fills the given value into the passed input, retries in case of a failure.
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | element | <code>Object</code> |  | The element. |
-| value | <code>String</code> |  | The value to be filled. |
+| value | <code>String</code> \| <code>Number</code> |  | The value to enter. |
 | [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
 | [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |
 
@@ -4883,7 +4973,7 @@ Clears and fills the passed input element.
 | Param | Type | Description |
 | --- | --- | --- |
 | element | <code>Object</code> | The element. |
-| value | <code>String</code> | The value to be filled in. |
+| value | <code>String</code> \| <code>Number</code> | The value to enter in. |
 
 **Example**  
 ```js
@@ -4900,7 +4990,7 @@ Clears and fills the passed input, retries in case it fails.
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | element | <code>Object</code> |  | The element. |
-| value | <code>String</code> |  | The value to be filled in. |
+| value | <code>String</code> \| <code>Number</code> |  | The value to enter in. |
 | [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
 | [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |
 | [verify] | <code>Boolean</code> | <code>true</code> | Specifies if the filled value should be verified. |
@@ -4919,7 +5009,7 @@ Moves the cursor/focus to the passed element.
 
 | Param | Type | Description |
 | --- | --- | --- |
-| element | <code>Object</code> | The selector describing the element. |
+| element | <code>Object</code> | The element. |
 | [xOffset] | <code>Number</code> | X offset to move to, relative to the top-left corner of the element. If not specified, the mouse will move to the middle of the element. |
 | [yOffset] | <code>Number</code> | Y offset to move to, relative to the top-left corner of the element. If not specified, the mouse will move to the middle of the element. |
 

package/docs/index.md

@@ -1,9 +1,8 @@
 # **Qmate** Service
 **Qmate Service** is a custom [WebdriverIO](https://webdriver.io/) service for testing web applications and APIs.
 
-!!! warning
-    The latest version of **WebdriverIO V8** is **not** yet supported. Support will follow soon.
-
+!!! note
+    The latest release of the Qmate Service is compatible with **WebdriverIO V8**.
 ## Main features
 The main features of this service are:
 

package/lib/reuse/modules/common/userInteraction.d.ts

@@ -8,15 +8,15 @@ export declare class UserInteraction {
      * @function fillActive
      * @memberOf common.userInteraction
      * @description Fills the active input with the given value.
-     * @param {String} value - The value with witch the input should be filled.
+     * @param {String | Number} value - The value to enter.
      * @example await common.userInteraction.fillActive("My Value");
      */
-    fillActive(value: string): Promise<void>;
+    fillActive(value: string | number): Promise<void>;
     /**
      * @function fillActiveAndRetry
      * @memberOf common.userInteraction
      * @description Enters the given value to the active input field and retries the action in case it fails.
-     * @param {String} value - The value with witch the input should be filled.
+     * @param {String} value - The value to enter.
      * @param {Number} [retries=3] - The number of retries, can be set in config for all functions under params stepsRetries.
      * @param {Number} [interval=5000] - The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals.
      * @example await common.userInteraction.fillActiveAndRetry("My Value");

package/lib/reuse/modules/common/userInteraction.js

@@ -16,16 +16,14 @@ class UserInteraction {
      * @function fillActive
      * @memberOf common.userInteraction
      * @description Fills the active input with the given value.
-     * @param {String} value - The value with witch the input should be filled.
+     * @param {String | Number} value - The value to enter.
      * @example await common.userInteraction.fillActive("My Value");
      */
     async fillActive(value) {
-        const vlf = this.vlf.initLog(this.fillActive);
-        if (!(typeof value === "number" || typeof value === "string")) {
-            throw new Error("Function 'fillActive' failed: Please provide a value(datatype - number/string) as argument.");
-        }
-        else {
+        const vl = this.vlf.initLog(this.fillActive);
+        if (typeof value === "number" || typeof value === "string") {
             try {
+                vl.log(`Setting the value of element to ${value}`);
                 const elem = await $(await browser.getActiveElement());
                 await elem.addValue(value);
             }
@@ -33,18 +31,21 @@ class UserInteraction {
                 throw new Error(`Function 'fillActive' failed: ${error}`);
             }
         }
+        else {
+            throw new Error("Function 'fillActive' failed: Please provide a value(datatype - number/string) as argument.");
+        }
     }
     /**
      * @function fillActiveAndRetry
      * @memberOf common.userInteraction
      * @description Enters the given value to the active input field and retries the action in case it fails.
-     * @param {String} value - The value with witch the input should be filled.
+     * @param {String} value - The value to enter.
      * @param {Number} [retries=3] - The number of retries, can be set in config for all functions under params stepsRetries.
      * @param {Number} [interval=5000] - The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals.
      * @example await common.userInteraction.fillActiveAndRetry("My Value");
      */
     async fillActiveAndRetry(value, retries = 3, interval = 5000) {
-        const vlf = this.vlf.initLog(this.fillActiveAndRetry);
+        const vl = this.vlf.initLog(this.fillActiveAndRetry);
         await util.function.retry(this.fillActive, [value], retries, interval, this);
     }
     /**
@@ -55,7 +56,7 @@ class UserInteraction {
      * @example await common.userInteraction.clearAndFillActive("My Value");
      */
     async clearAndFillActive(value) {
-        const vlf = this.vlf.initLog(this.clearAndFillActive);
+        const vl = this.vlf.initLog(this.clearAndFillActive);
         if (typeof value === "number" || typeof value === "string") {
             const elem = await $(await browser.getActiveElement());
             await elem.setValue(value);
@@ -74,7 +75,7 @@ class UserInteraction {
      * @example await common.userInteraction.clearAndFillActiveAndRetry("My Value");
      */
     async clearAndFillActiveAndRetry(value, retries = 3, interval = 5000) {
-        const vlf = this.vlf.initLog(this.clearAndFillActiveAndRetry);
+        const vl = this.vlf.initLog(this.clearAndFillActiveAndRetry);
         await util.function.retry(this.clearAndFillActive, [value], retries, interval, this);
     }
     // =================================== KEYS ===================================
@@ -88,7 +89,7 @@ class UserInteraction {
      * @example await common.userInteraction.pressKey(["\uE009", "Alt"]);
      */
     async pressKey(keys) {
-        const vlf = this.vlf.initLog(this.pressKey);
+        const vl = this.vlf.initLog(this.pressKey);
         await browser.keys(keys);
     }
     /**
@@ -98,7 +99,7 @@ class UserInteraction {
      * @example await common.userInteraction.pressEnter();
      */
     async pressEnter() {
-        const vlf = this.vlf.initLog(this.pressEnter);
+        const vl = this.vlf.initLog(this.pressEnter);
         await browser.keys(userInteraction_constants_1.KeyCodes.ENTER);
     }
     /**
@@ -108,7 +109,7 @@ class UserInteraction {
      * @example await common.userInteraction.pressTab();
      */
     async pressTab() {
-        const vlf = this.vlf.initLog(this.pressTab);
+        const vl = this.vlf.initLog(this.pressTab);
         await browser.keys(userInteraction_constants_1.KeyCodes.TAB);
     }
     /**
@@ -118,7 +119,7 @@ class UserInteraction {
      * @example await common.userInteraction.pressF4();
      */
     async pressF4() {
-        const vlf = this.vlf.initLog(this.pressF4);
+        const vl = this.vlf.initLog(this.pressF4);
         await browser.keys(userInteraction_constants_1.KeyCodes.F4);
     }
     /**
@@ -128,7 +129,7 @@ class UserInteraction {
      * @example await common.userInteraction.pressBackspace();
      */
     async pressBackspace() {
-        const vlf = this.vlf.initLog(this.pressBackspace);
+        const vl = this.vlf.initLog(this.pressBackspace);
         await browser.keys(userInteraction_constants_1.KeyCodes.BACKSPACE);
     }
     /**
@@ -139,7 +140,7 @@ class UserInteraction {
      * @example await common.userInteraction.pressEscape();
      */
     async pressEscape() {
-        const vlf = this.vlf.initLog(this.pressEscape);
+        const vl = this.vlf.initLog(this.pressEscape);
         await browser.keys(userInteraction_constants_1.KeyCodes.ESCAPE);
     }
     /**
@@ -149,7 +150,7 @@ class UserInteraction {
      * @example await common.userInteraction.pressArrowLeft();
      */
     async pressArrowLeft() {
-        const vlf = this.vlf.initLog(this.pressArrowLeft);
+        const vl = this.vlf.initLog(this.pressArrowLeft);
         await browser.keys(userInteraction_constants_1.KeyCodes.ARROW_LEFT);
     }
     /**
@@ -159,7 +160,7 @@ class UserInteraction {
      * @example await common.userInteraction.pressArrowRight();
      */
     async pressArrowRight() {
-        const vlf = this.vlf.initLog(this.pressArrowRight);
+        const vl = this.vlf.initLog(this.pressArrowRight);
         await browser.keys(userInteraction_constants_1.KeyCodes.ARROW_RIGHT);
     }
 }

package/lib/reuse/modules/common/userInteraction.js.map

@@ -1 +1 @@
-{"version":3,"file":"userInteraction.js","sourceRoot":"","sources":["../../../../src/reuse/modules/common/userInteraction.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;AAEb,8DAAkE;AAClE,qFAAiE;AAEjE;;;GAGG;AACH,MAAa,eAAe;IAA5B;QACU,QAAG,GAAG,IAAI,oCAAoB,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IAiKtE,CAAC;IA/JC,+EAA+E;IAC/E;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,KAAa;QAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC9C,IAAI,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,EAAE;YAC7D,MAAM,IAAI,KAAK,CAAC,6FAA6F,CAAC,CAAC;SAChH;aAAM;YACL,IAAI;gBACF,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,MAAM,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;gBACvD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;aAC5B;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,EAAE,CAAC,CAAC;aAC3D;SACF;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,kBAAkB,CAAC,KAAa,EAAE,UAAkB,CAAC,EAAE,WAAmB,IAAI;QAClF,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACtD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,kBAAkB,CAAC,KAAa;QACpC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACtD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC1D,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,MAAM,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;YACvD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SAC5B;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,qGAAqG,CAAC,CAAC;SACxH;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,0BAA0B,CAAC,KAAa,EAAE,UAAkB,CAAC,EAAE,WAAmB,IAAI;QAC1F,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAC9D,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IACvF,CAAC;IAED,+EAA+E;IAC/E;;;;;;;;OAQG;IACH,KAAK,CAAC,QAAQ,CAAC,IAAuB;QACpC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5C,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU;QACd,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC9C,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAQ,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ;QACZ,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5C,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAQ,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3C,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAQ,CAAC,EAAE,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc;QAClB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAClD,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAQ,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW;QACf,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC/C,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAQ,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc;QAClB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAClD,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAQ,CAAC,UAAU,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe;QACnB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACnD,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAQ,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;CACF;AAlKD,0CAkKC;AACD,kBAAe,IAAI,eAAe,EAAE,CAAC"}
+{"version":3,"file":"userInteraction.js","sourceRoot":"","sources":["../../../../src/reuse/modules/common/userInteraction.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;AAEb,8DAAkE;AAClE,qFAAiE;AAEjE;;;GAGG;AACH,MAAa,eAAe;IAA5B;QACU,QAAG,GAAG,IAAI,oCAAoB,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IAoKtE,CAAC;IAlKC,+EAA+E;IAC/E;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,KAAsB;QACrC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC1D,IAAI;gBACF,EAAE,CAAC,GAAG,CAAC,mCAAmC,KAAK,EAAE,CAAC,CAAC;gBAEnD,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,MAAM,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;gBACvD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;aAC5B;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,EAAE,CAAC,CAAC;aAC3D;SACF;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,6FAA6F,CAAC,CAAC;SAChH;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,kBAAkB,CAAC,KAAa,EAAE,UAAkB,CAAC,EAAE,WAAmB,IAAI;QAClF,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACrD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,kBAAkB,CAAC,KAAa;QACpC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACrD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC1D,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,MAAM,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;YACvD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SAC5B;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,qGAAqG,CAAC,CAAC;SACxH;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,0BAA0B,CAAC,KAAa,EAAE,UAAkB,CAAC,EAAE,WAAmB,IAAI;QAC1F,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAC7D,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IACvF,CAAC;IAED,+EAA+E;IAC/E;;;;;;;;OAQG;IACH,KAAK,CAAC,QAAQ,CAAC,IAAuB;QACpC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3C,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU;QACd,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7C,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAQ,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ;QACZ,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3C,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAQ,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAQ,CAAC,EAAE,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc;QAClB,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACjD,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAQ,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW;QACf,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9C,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAQ,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc;QAClB,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACjD,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAQ,CAAC,UAAU,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe;QACnB,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAClD,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAQ,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;CACF;AArKD,0CAqKC;AACD,kBAAe,IAAI,eAAe,EAAE,CAAC"}

package/lib/reuse/modules/nonUi5/element.d.ts

@@ -204,7 +204,7 @@ export declare class ElementModule {
     /**
      * @function isPresentByXPath
      * @memberOf nonUi5.element
-     * @description returns a boolean if the element is present at the DOM or not.
+     * @description Returns a boolean if the element is present at the DOM or not.
      * @param {String} xpath - The XPath describing the element.
      * @param {Number} [index=0] - The index of the element (in case there are more than one elements visible at the same time).
      * @param {Number} [timeout=30000] - The timeout to wait (ms).
@@ -212,6 +212,16 @@ export declare class ElementModule {
      * @example await nonUi5.element.isPresentByXPath(".//*[text()='Create']");
      */
     isPresentByXPath(xpath: string, index?: number, timeout?: any): Promise<boolean>;
+    /**
+     * @function isSelected
+     * @memberOf nonUi5.element
+     * @description Returns a boolean if the element (e.g. checkbox) is selected.
+     * @param {Object} elem - The element.
+     * @returns {boolean}
+     * @example const elem = await nonUi5.element.getById("elem01");
+     * const isSelected = await nonUi5.element.isSelected(elem);
+     */
+    isSelected(elem: Element): Promise<boolean>;
     /**
      * @function getAttributeValue
      * @memberOf nonUi5.element

package/lib/reuse/modules/nonUi5/element.js

@@ -415,7 +415,7 @@ class ElementModule {
     /**
      * @function isPresentByXPath
      * @memberOf nonUi5.element
-     * @description returns a boolean if the element is present at the DOM or not.
+     * @description Returns a boolean if the element is present at the DOM or not.
      * @param {String} xpath - The XPath describing the element.
      * @param {Number} [index=0] - The index of the element (in case there are more than one elements visible at the same time).
      * @param {Number} [timeout=30000] - The timeout to wait (ms).
@@ -426,6 +426,19 @@ class ElementModule {
         const vl = this.vlf.initLog(this.isPresentByXPath);
         return this.isPresentByCss(xpath, index, timeout);
     }
+    /**
+     * @function isSelected
+     * @memberOf nonUi5.element
+     * @description Returns a boolean if the element (e.g. checkbox) is selected.
+     * @param {Object} elem - The element.
+     * @returns {boolean}
+     * @example const elem = await nonUi5.element.getById("elem01");
+     * const isSelected = await nonUi5.element.isSelected(elem);
+     */
+    async isSelected(elem) {
+        const vl = this.vlf.initLog(this.isSelected);
+        return elem.isSelected();
+    }
     /**
      * @function getAttributeValue
      * @memberOf nonUi5.element