@sap_oss/wdio-qmate-service 1.0.0

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

@@ -0,0 +1,690 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserInteraction = void 0;
+/**
+ * @class userInteraction
+ * @memberof ui5
+ */
+class UserInteraction {
+    // =================================== CLICK ===================================
+    /**
+     * @function click
+     * @memberOf ui5.userInteraction
+     * @description Clicks on the element with the given selector.
+     * @param {Object} selector - The selector describing the element.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example await ui5.userInteraction.click(selector);
+     */
+    click(selector, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let elem = null;
+            yield browser.waitUntil(function () {
+                return __awaiter(this, void 0, void 0, function* () {
+                    elem = yield ui5.element.getDisplayed(selector, index, timeout);
+                    if (!elem)
+                        return false;
+                    return elem.isClickable();
+                });
+            }, {
+                timeout,
+                timeoutMsg: `Element not clickable after ${+timeout / 1000}s`
+            });
+            try {
+                // @ts-ignore
+                yield elem.click();
+            }
+            catch (error) {
+                // @ts-ignore
+                if (error.message && error.message.match(new RegExp(/is not clickable at point/))) {
+                    // @ts-ignore
+                    const errorMessage = yield util.function.mapWdioErrorToQmateErrorMessage(error, "click");
+                    throw new Error(errorMessage);
+                }
+            }
+        });
+    }
+    ;
+    /**
+     * @function clickAndRetry
+     * @memberOf ui5.userInteraction
+     * @description Clicks on the element with the given selector and retries the action in case of a failure.
+     * @param {Object} selector - The selector describing the element.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @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 ui5.userInteraction.clickAndRetry(selector);
+     */
+    clickAndRetry(selector, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000, retries = 3, interval = 5000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield util.function.retry(this.click, [selector, index, timeout], retries, interval, this);
+        });
+    }
+    ;
+    /**
+     * @function clickTab
+     * @memberOf ui5.userInteraction
+     * @description Clicks 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.
+     * @param {Object} selector - The selector describing the element.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example await ui5.userInteraction.clickTab(selector);
+     */
+    clickTab(selector, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield util.function.retry(function (selector, index, timeout) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    yield ui5.userInteraction.click(selector);
+                    const tab = yield ui5.element.getDisplayed(selector, index, timeout);
+                    const classList = yield tab.getAttribute("class");
+                    if (!classList.includes("sapUxAPAnchorBarButtonSelected")) {
+                        throw new Error();
+                    }
+                });
+            }, [selector, index, timeout], 3, 5000, this);
+        });
+    }
+    ;
+    /**
+     * @function clickListItem
+     * @memberOf ui5.userInteraction
+     * @description 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.
+     * @param {Object} selector - The selector describing the element.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example await ui5.userInteraction.clickListItem(selector);
+     */
+    clickListItem(selector, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const elem = yield ui5.element.getDisplayed(selector, index, timeout);
+            yield ui5.control.execute(function (control, done) {
+                control.attachPress(function () {
+                    done();
+                });
+                control.firePress();
+            }, elem);
+        });
+    }
+    ;
+    // =================================== FILL ===================================
+    /**
+     * @function fill
+     * @memberOf ui5.userInteraction
+     * @description Fills the input field with the given selector.
+     * @param {Object} selector - The selector describing the element.
+     * @param {String} value - The value to fill.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example await ui5.userInteraction.fill(selector, "My Value");
+     */
+    fill(selector, value, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (value !== null) {
+                const id = yield ui5.element.getId(selector, index, timeout);
+                let elem = null;
+                if (selector.elementProperties.metadata === "sap.m.TextArea") {
+                    elem = yield nonUi5.element.getByCss("[id='" + id + "'] textarea", index, timeout);
+                }
+                else {
+                    elem = yield nonUi5.element.getByCss("[id='" + id + "'] input", index, timeout);
+                }
+                yield elem.setValue(value);
+            }
+        });
+    }
+    ;
+    /**
+     * @function fillAndRetry
+     * @memberOf ui5.userInteraction
+     * @description Fills the input field with the given selector and retries the action in case of a failure.
+     * @param {Object} selector - The selector describing the element.
+     * @param {String} value - The value to fill.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @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 ui5.userInteraction.fillAndRetry(selector, "My Value");
+     */
+    fillAndRetry(selector, value, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000, retries = 3, interval = 5000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield util.function.retry(this.fill, [selector, value, index, timeout], retries, interval, this);
+        });
+    }
+    ;
+    // =================================== CLEAR ===================================
+    /**
+     * @function clear
+     * @memberOf ui5.userInteraction
+     * @description Clears the input with the given selector.
+     * @param {Object} selector - The selector describing the element.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example await ui5.userInteraction.clear(selector);
+     */
+    //TODO remove clearHelper and use clear
+    clear(selector, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this._clearHelper(selector, index, timeout);
+        });
+    }
+    ;
+    /**
+     * @function clearAndRetry
+     * @memberOf ui5.userInteraction
+     * @description  Clears the input with the given selector and retries the action in case of a failure
+     * @param {Object} selector - The selector describing the element.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @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 ui5.userInteraction.clearAndRetry(selector);
+     */
+    clearAndRetry(selector, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000, retries = 3, interval = 5000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield util.function.retry(this.clear, [selector, index, timeout], retries, interval, this);
+        });
+    }
+    ;
+    /**
+     * @function clearAndFill
+     * @memberOf ui5.userInteraction
+     * @description Clears the input field with the given selector and fills the given value.
+     * @param {Object} selector - The selector describing the element.
+     * @param {String} value - The value to fill.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example await ui5.userInteraction.clearAndFill(selector, "My Value");
+     */
+    clearAndFill(selector, value, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (value !== null) {
+                yield this.clear(selector, index, timeout);
+                yield common.userInteraction.fillActive(value);
+            }
+            else {
+                throw new Error("Function 'clearAndFill' failed. Please provide a value as second parameter.");
+            }
+        });
+    }
+    ;
+    /**
+     * @function clearAndFillAndRetry
+     * @memberOf ui5.userInteraction
+     * @description Clears the input field with the given selector and fills the given value. Retries the action in case of a failure.
+     * @param {Object} selector - The selector describing the element.
+     * @param {String} value - The value to fill.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @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.
+     * @param {Boolean} [verify=true] - Specifies if the filled value should be verified.
+     * @example await ui5.userInteraction.clearAndFillAndRetry(selector, "My Value");
+     */
+    clearAndFillAndRetry(selector, value, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000, retries = 3, interval = 5000, verify = true) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield util.function.retry((selector, value, index, timeout) => __awaiter(this, void 0, void 0, function* () {
+                yield this.clearAndFill(selector, value, index, timeout);
+                if (verify) {
+                    const elem = yield ui5.element.getDisplayed(selector);
+                    let elemValue = yield ui5.element.getValue(selector, index);
+                    if (elemValue != value) { // IMPORTANT: keep non-strict comparison for format changes after input (10 -> 10.00)
+                        elemValue = yield ui5.element.getInnerAttribute(elem, "data-" + "value");
+                        if (elemValue != value) { // IMPORTANT: keep non-strict comparison for format changes after input (10 -> 10.00)
+                            throw new Error(`Actual value '${elemValue}' not equal to expected value '${value}'`);
+                        }
+                    }
+                }
+            }), [selector, value, index, timeout], retries, interval, this);
+        });
+    }
+    ;
+    /**
+     * @function clearSmartFieldInput
+     * @memberOf ui5.userInteraction
+     * @description Clears the smart filed with the given selector.
+     * @param {Object} selector - The selector describing the element.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example await ui5.userInteraction.clearSmartFieldInput(selector);
+     */
+    clearSmartFieldInput(selector, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield ui5.userInteraction.clear(selector, index, timeout);
+        });
+    }
+    ;
+    /**
+     * @function clearAndFillSmartFieldInput
+     * @memberOf ui5.userInteraction
+     * @description Clears the smart filed with the given selector and fills the given value.
+     * @param {Object} selector - The selector describing the element.
+     * @param {String} value - The value to fill.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example await ui5.userInteraction.clearAndFillSmartFieldInput(selector, "My Value");
+     */
+    clearAndFillSmartFieldInput(selector, value, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const id = yield ui5.element.getId(selector, index, timeout);
+            const elem = yield nonUi5.element.getByCss(`input[id*='${id}']`);
+            yield elem.click();
+            yield ui5.userInteraction.selectAll(selector, index, timeout);
+            yield elem.setValue(value);
+        });
+    }
+    ;
+    /**
+     * @function clearAndFillSmartFieldInputAndRetry
+     * @memberOf ui5.userInteraction
+     * @description Clears the smart filed with the given selector and fills the given value and retries the action in case of a failure.
+     * @param {Object} selector - The selector describing the element.
+     * @param {String} value - The value to fill.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @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 ui5.userInteraction.clearAndFillSmartFieldInputAndRetry(selector, "My Value");
+     */
+    clearAndFillSmartFieldInputAndRetry(selector, value, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000, retries = 3, interval = 5000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield util.function.retry(this.clearAndFillSmartFieldInput, [selector, value, index, timeout], retries, interval, this);
+        });
+    }
+    ;
+    // =================================== SELECT ===================================
+    /**
+     * @function selectBox
+     * @memberOf ui5.userInteraction
+     * @description Selects the passed value of the Select box.
+     * Please note that the function will only work for the default select Box.
+     * In special cases, please use the clickSelectArrow function.
+     * @param {Object} selector - The selector describing the element.
+     * @param {String} value - The value to select.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @example await ui5.userInteraction.selectBox(selector, "Germany");
+     */
+    selectBox(selector, value, index = 0) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.clickSelectArrow(selector, index);
+            if (value) {
+                const itemSelector = {
+                    "elementProperties": {
+                        "mProperties": {
+                            "text": value
+                        },
+                        "ancestorProperties": selector.elementProperties
+                    }
+                };
+                yield this.scrollToElement(itemSelector);
+                yield this.click(itemSelector);
+            }
+            else {
+                throw new Error("Function 'selectBox' failed: Please provide a value as second argument.");
+            }
+        });
+    }
+    ;
+    /**
+     * @function selectComboBox
+     * @memberOf ui5.userInteraction
+     * @description Selects the passed value from the ComboBox with the given selector.
+     * Please note that the function will only work for the default ComboBox.
+     * In special cases you need to use the 'clickSelectArrow' function.
+     * @param {Object} selector - The selector describing the element.
+     * @param {String} value - The value to select.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @example await ui5.userInteraction.selectComboBox(selector, "Germany");
+     */
+    selectComboBox(selector, value, index = 0) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.clickSelectArrow(selector, index);
+            if (value) {
+                const selector = {
+                    "elementProperties": {
+                        "metadata": "sap.m.StandardListItem",
+                        "mProperties": {
+                            "title": value
+                        }
+                    },
+                    "parentProperties": {
+                        "metadata": "sap.m.List"
+                    }
+                };
+                yield this.scrollToElement(selector);
+                yield this.click(selector);
+            }
+        });
+    }
+    ;
+    /**
+     * @function selectMultiComboBox
+     * @memberOf ui5.userInteraction
+     * @description Selects the passed values of the MultiComboBox with the given selector.
+     * Please note that the function will only work for the default MultiComboBox.
+     * In special cases, please use the clickSelectArrow function.
+     * @param {Object} selector - The selector describing the element.
+     * @param {Array} values - The values to select.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @example await ui5.userInteraction.selectMultiComboBox(selector, ["Option 1", "Option 2"]);
+     */
+    selectMultiComboBox(selector, values, index = 0) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.clickSelectArrow(selector, index);
+            for (const v in values) {
+                const ui5ControlProperties = {
+                    "elementProperties": {
+                        "metadata": "sap.m.CheckBox",
+                        "mProperties": {}
+                    },
+                    "parentProperties": {
+                        "metadata": "sap.m.StandardListItem",
+                        "mProperties": {
+                            "title": values[v]
+                        }
+                    }
+                };
+                yield this.scrollToElement(ui5ControlProperties);
+                yield this.click(ui5ControlProperties);
+            }
+            yield common.userInteraction.pressEnter();
+        });
+    }
+    ;
+    /**
+     * @function clickSelectArrow
+     * @memberOf ui5.userInteraction
+     * @description Clicks the arrow icon at the passed selector (select box).
+     * @param {Object} selector - The selector describing the element.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @example await ui5.userInteraction.clickSelectArrow(selector);
+     */
+    clickSelectArrow(selector, index = 0) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const id = yield ui5.element.getId(selector, index);
+            const arrow = yield nonUi5.element.getByCss("[id='" + id + "-arrow']", 0, 3000);
+            yield arrow.click();
+        });
+    }
+    ;
+    /**
+     * @function clickSelectArrowAndRetry
+     * @memberOf ui5.userInteraction
+     * @description Clicks the arrow icon at the passed selector (select box), and retries in case it fails.
+     * @param {Object} selector - The selector describing the element
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @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 ui5.userInteraction.clickSelectArrowAndRetry(selector);
+     */
+    clickSelectArrowAndRetry(selector, index = 0, retries = 3, interval = 5000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield util.function.retry(this.clickSelectArrow, [selector, index], retries, interval, this);
+        });
+    }
+    ;
+    // =================================== OTHERS ===================================
+    /**
+     * @function mouseOverElement
+     * @memberOf ui5.userInteraction
+     * @description Moves the cursor/focus to the element with the given selector.
+     * @param {Object} selector - The selector describing the element.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example await ui5.userInteraction.mouseOverElement(selector);
+     */
+    mouseOverElement(selector, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let elem;
+            try {
+                elem = yield ui5.element.getDisplayed(selector, index, timeout);
+            }
+            catch (error) {
+                throw new Error(`Function: 'mouseOverElement' failed: No element found for selector ${selector}`);
+            }
+            yield elem.moveTo();
+        });
+    }
+    ;
+    /**
+     * @function scrollToElement
+     * @memberOf ui5.userInteraction
+     * @description Scrolls to the element with the given selector to get it into view.
+     * @param {Object} selector - The selector describing the element.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {String} [alignment="center"] - Defines vertical/horizontal alignment. One of "start", "center", "end", or "nearest".
+     * Affects the alignToTop parameter of scrollIntoView function. By default, it takes 'up'
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example await ui5.userInteraction.scrollToElement(selector);
+     * @example await ui5.userInteraction.scrollToElement(selector, 0, "start", 5000);
+     */
+    scrollToElement(selector, index = 0, alignment = "center", timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const elem = yield ui5.element.getDisplayed(selector, index, timeout);
+            if (elem) {
+                const options = {
+                    "block": alignment,
+                    "inline": alignment
+                };
+                yield elem.scrollIntoView(options);
+            }
+        });
+    }
+    ;
+    /**
+     * @function selectAll
+     * @memberOf ui5.userInteraction
+     * @description Performs "select all" (ctrl + a) at the element with the given selector.
+     * @param {Object} [selector] - The selector describing the element.
+     * @param {Number} [index=0] - The index of the selector, in case there are more than one elements visible at the same time.
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example await ui5.userInteraction.selectAll(selector);
+     */
+    selectAll(selector, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (selector !== undefined) {
+                yield this.click(selector, index, timeout);
+            }
+            else {
+                util.console.info("Selector properties are undefined. Action will be performed on current element.");
+            }
+            yield common.userInteraction.pressKey(["\uE051", "a"]);
+        });
+    }
+    ;
+    /**
+     * @function openF4Help
+     * @memberOf ui5.userInteraction
+     * @description Opens the F4-help of the element with the given selector.
+     * @param {Object} selector - The selector describing the element.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @param {Boolean} useF4Key - Specifies if the help is opened by pressing the F4-key or via the button.
+     * The default value is true (triggered by pressing the F4-key). Set "useF4Key" to false, to trigger the search by clicking the button.
+     * @example await ui5.userInteraction.openF4Help(selector, 0, 30000, false);
+     */
+    openF4Help(selector, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000, useF4Key = true) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield ui5.userInteraction.click(selector, index, timeout);
+            if (useF4Key === true) {
+                yield common.userInteraction.pressF4();
+            }
+            else {
+                const id = yield ui5.element.getId(selector);
+                const button = yield nonUi5.element.getByCss("[id='" + id + "-vhi']", 0, timeout);
+                yield button.click();
+            }
+        });
+    }
+    ;
+    /**
+     * @function searchFor
+     * @memberOf ui5.userInteraction
+     * @description Searches for the passed value and executes the search.
+     * In case that the search is already filled, it will reset the field first.
+     * @param {Object} selector - The selector describing the element.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @param {Boolean} useEnter - Specifies if the search is triggered by pressing the Enter-key or via the search button.
+     * The default value is true (triggered by pressing the Enter-key). Set "useEnter" to false, to trigger the search by clicking the search button.
+     * @example await ui5.userInteraction.searchFor(selector, "My Value", 0, 30000, false);
+     */
+    searchFor(selector, value, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000, useEnter = true) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield ui5.userInteraction.clearAndFillAndRetry(selector, value, index, timeout);
+            if (useEnter === true) {
+                yield common.userInteraction.pressEnter();
+            }
+            else {
+                const id = yield ui5.element.getId(selector, index, timeout);
+                const searchButton = yield nonUi5.element.getByCss("[id='" + id + "-search']", 0, timeout);
+                yield searchButton.click();
+            }
+        });
+    }
+    ;
+    /**
+     * @function resetSearch
+     * @memberOf ui5.userInteraction
+     * @description Resets the search field.
+     * @param {Object} selector - The selector describing the element.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example await ui5.userInteraction.resetSearch(selector);
+     */
+    resetSearch(selector, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const id = yield ui5.element.getId(selector, index, timeout);
+            const resetButton = yield nonUi5.element.getByCss("[id='" + id + "-reset']", 0, timeout);
+            yield resetButton.click();
+        });
+    }
+    ;
+    // =================================== HELPER ===================================
+    //TODO: rework function in its whole. Why don't we use the clear function from native wdio here?
+    _clearHelper(selector, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let id, elem;
+            if (selector) {
+                yield ui5.userInteraction.click(selector, index, timeout);
+                id = yield ui5.element.getId(selector, index, timeout);
+                elem = yield browser.getActiveElement();
+            }
+            else {
+                elem = yield browser.getActiveElement();
+                yield elem.click();
+                // @ts-ignore
+                id = yield util.function.getAttribute(elem, "id");
+            }
+            const tokenizers = yield browser.execute(function (id) {
+                // @ts-ignore
+                const t = document.getElementById(id).querySelectorAll(".sapMTokenizer");
+                // @ts-ignore
+                const inputs = document.getElementById(id).getElementsByTagName("input");
+                // @ts-ignore
+                const textareas = document.getElementById(id).getElementsByTagName("textarea");
+                if (inputs.length) {
+                    inputs[0].value = "";
+                    inputs[0].focus();
+                }
+                if (textareas.length) {
+                    textareas[0].value = "";
+                }
+                return t;
+            }, id);
+            if ((yield tokenizers) && (yield tokenizers.length)) {
+                yield ui5.userInteraction.selectAll(selector, index, timeout);
+                yield common.userInteraction.pressBackspace();
+            }
+        });
+    }
+    /**
+     * @function doubleClick
+     * @memberOf ui5.userInteraction
+     * @description Double Clicks on the passed element.
+     * @param {Object} selector - The selector describing the element.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example await ui5.userInteraction.doubleClick(selector);
+     */
+    doubleClick(selector, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let elem = null;
+            yield browser.waitUntil(function () {
+                return __awaiter(this, void 0, void 0, function* () {
+                    elem = yield ui5.element.getDisplayed(selector, index, timeout);
+                    if (!elem)
+                        return false;
+                    return elem.isClickable();
+                });
+            }, {
+                timeout,
+                timeoutMsg: `Element not clickable after ${+timeout / 1000}s`
+            });
+            try {
+                // @ts-ignore
+                yield elem.doubleClick();
+            }
+            catch (error) {
+                // @ts-ignore
+                const errorMessage = yield util.function.mapWdioErrorToQmateErrorMessage(error, "doubleClick");
+                throw new Error(errorMessage);
+            }
+        });
+    }
+    ;
+    /**
+     * @function rightClick
+     * @memberOf ui5.userInteraction
+     * @description Right Clicks on the passed element.
+     * @param {Object} selector - The selector describing the element.
+     * @param {Number} [index=0] - The index of the selector (in case there are more than one elements visible at the same time).
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example const elem = await nonUi5.element.getById("button01");
+     * await ui5.userInteraction.rightClick(elem);
+     */
+    rightClick(selector, index = 0, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let elem = null;
+            yield browser.waitUntil(function () {
+                return __awaiter(this, void 0, void 0, function* () {
+                    elem = yield ui5.element.getDisplayed(selector, index, timeout);
+                    if (!elem)
+                        return false;
+                    return elem.isClickable();
+                });
+            }, {
+                timeout,
+                timeoutMsg: `Element not clickable after ${+timeout / 1000}s`
+            });
+            try {
+                // @ts-ignore
+                yield elem.click({
+                    button: "right"
+                });
+            }
+            catch (error) {
+                // @ts-ignore
+                const errorMessage = yield util.function.mapWdioErrorToQmateErrorMessage(error, "rightClick");
+                throw new Error(errorMessage);
+            }
+        });
+    }
+    ;
+}
+exports.UserInteraction = UserInteraction;
+;
+exports.default = new UserInteraction();
+//# sourceMappingURL=userInteraction.js.map