@sap_oss/wdio-qmate-service 1.0.0

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

@@ -0,0 +1,17 @@
+/**
+ * @class navigation
+ * @memberof nonUi5
+ */
+export declare class Navigation {
+    /**
+     * @function navigateToApplication
+     * @memberOf nonUi5.navigation
+     * @description Navigates to the application via the passed relative reference. The path will be added to the baseUrl maintained in the config.
+     * @param {String} relativeReference - Relative reference of an application (path, query and fragment)
+     * @param {Boolean} [refresh=true] - Refresh the page after navigation.
+     * @example await nonUi5.navigation.navigateToApplication("categories");
+     */
+    navigateToApplication(relativeReference: string, refresh?: boolean): Promise<void>;
+}
+declare const _default: Navigation;
+export default _default;

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

@@ -0,0 +1,44 @@
+"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.Navigation = void 0;
+/**
+ * @class navigation
+ * @memberof nonUi5
+ */
+class Navigation {
+    /**
+     * @function navigateToApplication
+     * @memberOf nonUi5.navigation
+     * @description Navigates to the application via the passed relative reference. The path will be added to the baseUrl maintained in the config.
+     * @param {String} relativeReference - Relative reference of an application (path, query and fragment)
+     * @param {Boolean} [refresh=true] - Refresh the page after navigation.
+     * @example await nonUi5.navigation.navigateToApplication("categories");
+     */
+    navigateToApplication(relativeReference, refresh = true) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield browser.navigateTo(`${browser.config.baseUrl}/${relativeReference}`);
+                yield util.browser.logCurrentUrl();
+                if (refresh) {
+                    yield util.browser.refresh();
+                }
+            }
+            catch (error) {
+                throw new Error("Function navigateToApplication failed: " + error);
+            }
+        });
+    }
+    ;
+}
+exports.Navigation = Navigation;
+exports.default = new Navigation();
+//# sourceMappingURL=navigation.js.map

package/lib/reuse/modules/nonUi5/navigation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigation.js","sourceRoot":"","sources":["../../../../src/reuse/modules/nonUi5/navigation.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;;;;;;;AAEb;;;GAGG;AACH,MAAa,UAAU;IAErB;;;;;;;OAOG;IACI,qBAAqB,CAAC,iBAAyB,EAAE,OAAO,GAAG,IAAI;;YACpE,IAAI;gBACF,MAAM,OAAO,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,iBAAiB,EAAE,CAAC,CAAC;gBAC3E,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;gBACnC,IAAI,OAAO,EAAE;oBACX,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;iBAC9B;aACF;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,IAAI,KAAK,CAAC,yCAAyC,GAAG,KAAK,CAAC,CAAC;aACpE;QACH,CAAC;KAAA;IAAA,CAAC;CACH;AArBD,gCAqBC;AACD,kBAAe,IAAI,UAAU,EAAE,CAAC"}

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

@@ -0,0 +1,170 @@
+import { Element } from "../../../../@types/wdio";
+import { AlignmentValues } from "./constants/userInteraction.constants";
+/**
+ * @class userInteraction
+ * @memberof nonUi5
+ */
+export declare class UserInteraction {
+    /**
+     * @function click
+     * @memberOf nonUi5.userInteraction
+     * @description Clicks on the passed element.
+     * @param {Object} element - The element.
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example const elem = await nonUi5.element.getById("button01");
+     * await nonUi5.userInteraction.click(elem);
+     */
+    click(element: Element, timeout?: string | number): Promise<void>;
+    /**
+     * @function clickAndRetry
+     * @memberOf nonUi5.userInteraction
+     * @description Clicks on the passed element, retries in case it fails.
+     * @param {Object} element - The element.
+     * @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 const elem = await nonUi5.element.getById("button01");
+     * await nonUi5.userInteraction.clickAndRetry(elem);
+     */
+    clickAndRetry(element: Element, timeout?: string | number, retries?: number, interval?: number): Promise<void>;
+    /**
+     * @function doubleClick
+     * @memberOf nonUi5.userInteraction
+     * @description Double Clicks on the passed element.
+     * @param {Object} element - The element.
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example const elem = await nonUi5.element.getById("button01");
+     * await nonUi5.userInteraction.doubleClick(elem);
+     */
+    doubleClick(element: Element, timeout?: string | number): Promise<void>;
+    /**
+     * @function rightClick
+     * @memberOf nonUi5.userInteraction
+     * @description Right Clicks on the passed element.
+     * @param {Object} element - The element.
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example const elem = await nonUi5.element.getById("button01");
+     * await nonUi5.userInteraction.rightClick(elem);
+     */
+    rightClick(element: Element, timeout?: string | number): Promise<void>;
+    /**
+     * @function fill
+     * @memberOf nonUi5.userInteraction
+     * @description Fills the given value into the passed input.
+     * @param {Object} element - The element.
+     * @param {String} value - The value to be filled.
+     * @example const elem = await nonUi5.element.getById("input01");
+     * await nonUi5.userInteraction.fill(elem, "Service 01");
+     */
+    fill(element: Element, value: string): Promise<void>;
+    /**
+     * @function fillAndRetry
+     * @memberOf nonUi5.userInteraction
+     * @description Fills the given value into the passed input, retries in case of a failure.
+     * @param {Object} element - The element.
+     * @param {String} value - The value to be filled.
+     * @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 const elem = await nonUi5.element.getById("input01");
+     * await nonUi5.userInteraction.fillAndRetry(elem, "Service 01");
+     */
+    fillAndRetry(element: Element, value: string, retries?: number, interval?: number): Promise<void>;
+    /**
+     * @function clear
+     * @memberOf nonUi5.userInteraction
+     * @description Clears the passed input element.
+     * @param {Object} element - The element.
+     * @example const elem = await nonUi5.element.getById("input01");
+     * await nonUi5.userInteraction.clear(elem);
+     */
+    clear(element: Element): Promise<void>;
+    /**
+     * @function clearAndRetry
+     * @memberOf nonUi5.userInteraction
+     * @description Clears the passed input element, retries in case of a failure.
+     * @param {Object} element - The element.
+     * @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 const elem = await nonUi5.element.getById("input01", 10000);
+     * await nonUi5.userInteraction.clearAndRetry(elem);
+     */
+    clearAndRetry(element: Element, retries?: number, interval?: number): Promise<void>;
+    /**
+     * @function clearAndFill
+     * @memberOf nonUi5.userInteraction
+     * @description Clears and fills the passed input element.
+     * @param {Object} element - The element.
+     * @param {String} value - The value to be filled in.
+     * @example const elem = await nonUi5.element.getById("input01");
+     * await nonUi5.userInteraction.clearAndFill(elem, "Service 01");
+     */
+    clearAndFill(element: Element, value: string): Promise<void>;
+    /**
+     * @function clearAndFillAndRetry
+     * @memberOf nonUi5.userInteraction
+     * @description Clears and fills the passed input, retries in case it fails.
+     * @param {Object} element - The element.
+     * @param {String} value - The value to be filled in.
+     * @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 const elem = await nonUi5.element.getById("input01");
+     * await nonUi5.userInteraction.clearAndFillAndRetry(elem, "Service 01");
+     */
+    clearAndFillAndRetry(element: Element, value: string, retries?: number, interval?: number, verify?: boolean): Promise<void>;
+    /**
+     * @function mouseOverElement
+     * @memberOf nonUi5.userInteraction
+     * @description Moves the cursor/focus to the passed element.
+     * @param {Object} element - The selector describing the element.
+     * @param {Number} [xOffset] - 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.
+     * @param {Number} [yOffset] - 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.
+     * @example const elem = await nonUi5.element.getById("dropdown42");
+     * await nonUi5.userInteraction.mouseOverElement(elem);
+     */
+    mouseOverElement(elem: Element, xOffset: number, yOffset: number): Promise<void>;
+    /**
+     * @function scrollToElement
+     * @memberOf nonUi5.userInteraction
+     * @description Scrolls to the passed element to get it into view.
+     * @param {Object} elem - The element.
+     * @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'
+     * @example const elem = await nonUi5.userInteraction.getElementById("footer01");
+     * await nonUi5.userInteraction.scrollToElement(elem);
+     */
+    scrollToElement(elem: Element, alignment?: AlignmentValues): Promise<void>;
+    /**
+     * @function dragAndDrop
+     * @memberOf nonUi5.userInteraction
+     * @description Drags and drops the given element to the given target element.
+     * @param {Object} element - The element to drag.
+     * @param {Object} targetElem - The target element to drop the element.
+     * @example const elem = await nonUi5.element.getById("drag01");
+     * @example const targetElem = await nonUi5.element.getById("drop02");
+     * await nonUi5.userInteraction.dragAndDrop(elem, targetElem);
+     */
+    dragAndDrop(element: Element, targetElem: Element): Promise<void>;
+    /**
+     * @function moveCursorAndClick
+     * @memberOf nonUi5.userInteraction
+     * @description Moves the cursor to the target element and clicks on it. Can be used for charts.
+     * @param {Object} element - The element to be clicked.
+     * @example const elem = await nonUi5.element.getById("chartPartToClick");
+     * await nonUi5.userInteraction.moveCursorAndClick(elem);
+     */
+    moveCursorAndClick(element: Element): Promise<void>;
+    /**
+     * @function clickElementInSvg
+     * @memberOf nonUi5.userInteraction
+     * @description Clicks on an inner element within a SVG element.
+     * @param {Object} svgElem - The SVG element.
+     * @param {String} innerSelector - The CSS selector describing the inner element to be clicked.
+     * @example const svgElem = await nonUi5.element.getByCss("svg");
+     * const innerSelector = "circle:nth-child(6)";
+     * await nonUi5.userInteraction.clickElementInSvg(svgElem, innerSelector);
+     */
+    clickElementInSvg(svgElem: Element, innerSelector: string): Promise<void>;
+}
+declare const _default: UserInteraction;
+export default _default;

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

@@ -0,0 +1,415 @@
+"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;
+const userInteraction_constants_1 = require("./constants/userInteraction.constants");
+/**
+ * @class userInteraction
+ * @memberof nonUi5
+ */
+class UserInteraction {
+    // =================================== CLICK ===================================
+    /**
+     * @function click
+     * @memberOf nonUi5.userInteraction
+     * @description Clicks on the passed element.
+     * @param {Object} element - The element.
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example const elem = await nonUi5.element.getById("button01");
+     * await nonUi5.userInteraction.click(elem);
+     */
+    click(element, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield Promise.all([
+                expect(element).toBeDisplayed({
+                    wait: timeout,
+                    interval: 100,
+                    message: `Timeout '${+timeout / 1000}s' by waiting for element is displayed.`
+                }),
+                expect(element).toBeEnabled({
+                    wait: timeout,
+                    interval: 100,
+                    message: `Timeout '${+timeout / 1000}s' by waiting for element is enabled.`
+                })
+            ]);
+            try {
+                yield element.click();
+            }
+            catch (error) {
+                const errorMessage = yield util.function.mapWdioErrorToQmateErrorMessage(error, "click");
+                throw new Error(errorMessage);
+            }
+        });
+    }
+    ;
+    /**
+     * @function clickAndRetry
+     * @memberOf nonUi5.userInteraction
+     * @description Clicks on the passed element, retries in case it fails.
+     * @param {Object} element - The element.
+     * @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 const elem = await nonUi5.element.getById("button01");
+     * await nonUi5.userInteraction.clickAndRetry(elem);
+     */
+    clickAndRetry(element, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000, retries = 3, interval = 5000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!element) {
+                throw new Error("Function 'clearAndRetry' failed. Please provide an element as first argument.");
+            }
+            return util.function.retry(this.click, [element, timeout], retries, interval, this);
+        });
+    }
+    ;
+    /**
+     * @function doubleClick
+     * @memberOf nonUi5.userInteraction
+     * @description Double Clicks on the passed element.
+     * @param {Object} element - The element.
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example const elem = await nonUi5.element.getById("button01");
+     * await nonUi5.userInteraction.doubleClick(elem);
+     */
+    doubleClick(element, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield Promise.all([
+                expect(element).toBeDisplayed({
+                    wait: timeout,
+                    interval: 100,
+                    message: `Timeout '${+timeout / 1000}s' by waiting for element is displayed.`
+                }),
+                expect(element).toBeEnabled({
+                    wait: timeout,
+                    interval: 100,
+                    message: `Timeout '${+timeout / 1000}s' by waiting for element is enabled.`
+                })
+            ]);
+            try {
+                yield element.doubleClick();
+            }
+            catch (error) {
+                const errorMessage = yield util.function.mapWdioErrorToQmateErrorMessage(error, "doubleClick");
+                throw new Error(errorMessage);
+            }
+        });
+    }
+    ;
+    /**
+     * @function rightClick
+     * @memberOf nonUi5.userInteraction
+     * @description Right Clicks on the passed element.
+     * @param {Object} element - The element.
+     * @param {Number} [timeout=30000] - The timeout to wait (ms).
+     * @example const elem = await nonUi5.element.getById("button01");
+     * await nonUi5.userInteraction.rightClick(elem);
+     */
+    rightClick(element, timeout = process.env.QMATE_CUSTOM_TIMEOUT || 30000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield Promise.all([
+                expect(element).toBeDisplayed({
+                    wait: timeout,
+                    interval: 100,
+                    message: `Timeout '${+timeout / 1000}s' by waiting for element is displayed.`
+                }),
+                expect(element).toBeEnabled({
+                    wait: timeout,
+                    interval: 100,
+                    message: `Timeout '${+timeout / 1000}s' by waiting for element is enabled.`
+                })
+            ]);
+            try {
+                yield element.click({
+                    button: "right"
+                });
+            }
+            catch (error) {
+                const errorMessage = yield util.function.mapWdioErrorToQmateErrorMessage(error, "rightClick");
+                throw new Error(errorMessage);
+            }
+        });
+    }
+    ;
+    // =================================== FILL ===================================
+    /**
+     * @function fill
+     * @memberOf nonUi5.userInteraction
+     * @description Fills the given value into the passed input.
+     * @param {Object} element - The element.
+     * @param {String} value - The value to be filled.
+     * @example const elem = await nonUi5.element.getById("input01");
+     * await nonUi5.userInteraction.fill(elem, "Service 01");
+     */
+    fill(element, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield element.setValue(value);
+            }
+            catch (error) {
+                // @ts-ignore
+                if (error.message && error.message.match(new RegExp(/(invalid element state|element not interactable)/))) {
+                    const errorMessage = yield util.function.mapWdioErrorToQmateErrorMessage(error, "fill");
+                    throw new Error(errorMessage);
+                }
+                else {
+                    if (!value) {
+                        throw new Error("Function 'fill' failed: Please provide a value as second argument: " + error);
+                    }
+                    else {
+                        throw error;
+                    }
+                }
+            }
+        });
+    }
+    ;
+    /**
+     * @function fillAndRetry
+     * @memberOf nonUi5.userInteraction
+     * @description Fills the given value into the passed input, retries in case of a failure.
+     * @param {Object} element - The element.
+     * @param {String} value - The value to be filled.
+     * @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 const elem = await nonUi5.element.getById("input01");
+     * await nonUi5.userInteraction.fillAndRetry(elem, "Service 01");
+     */
+    fillAndRetry(element, value, retries = 3, interval = 5000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!element || (value === null || value === undefined || value === "")) {
+                throw new Error("Function 'fillAndRetry' failed: Please provide an element and value as arguments.");
+            }
+            else {
+                return util.function.retry(this.fill, [element, value], retries, interval, this);
+            }
+        });
+    }
+    ;
+    // =================================== CLEAR ===================================
+    /**
+     * @function clear
+     * @memberOf nonUi5.userInteraction
+     * @description Clears the passed input element.
+     * @param {Object} element - The element.
+     * @example const elem = await nonUi5.element.getById("input01");
+     * await nonUi5.userInteraction.clear(elem);
+     */
+    clear(element) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!element) {
+                throw new Error("Function 'clear' failed: Please provide an element as first argument.");
+            }
+            return element.clearValue();
+        });
+    }
+    ;
+    /**
+     * @function clearAndRetry
+     * @memberOf nonUi5.userInteraction
+     * @description Clears the passed input element, retries in case of a failure.
+     * @param {Object} element - The element.
+     * @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 const elem = await nonUi5.element.getById("input01", 10000);
+     * await nonUi5.userInteraction.clearAndRetry(elem);
+     */
+    clearAndRetry(element, retries = 3, interval = 5000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!element) {
+                throw new Error("Function 'clearAndRetry' failed: Please provide an element as first argument.");
+            }
+            return util.function.retry(this.clear, [element], retries, interval, this);
+        });
+    }
+    ;
+    /**
+     * @function clearAndFill
+     * @memberOf nonUi5.userInteraction
+     * @description Clears and fills the passed input element.
+     * @param {Object} element - The element.
+     * @param {String} value - The value to be filled in.
+     * @example const elem = await nonUi5.element.getById("input01");
+     * await nonUi5.userInteraction.clearAndFill(elem, "Service 01");
+     */
+    clearAndFill(element, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            //arg. 'value' needs to be checked in case of numeric values. E.g.: 0 or 1 will be handled as boolean value in if.
+            if (!element || (value === null || value === undefined || value === "")) {
+                throw new Error("Function 'clearAndFill' failed: Please provide an element and value as arguments.");
+            }
+            else {
+                try {
+                    yield this.clear(element);
+                    yield element.setValue(value);
+                }
+                catch (error) {
+                    throw new Error(`Function 'clearAndFill' failed: ${error}`);
+                }
+            }
+        });
+    }
+    ;
+    /**
+     * @function clearAndFillAndRetry
+     * @memberOf nonUi5.userInteraction
+     * @description Clears and fills the passed input, retries in case it fails.
+     * @param {Object} element - The element.
+     * @param {String} value - The value to be filled in.
+     * @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 const elem = await nonUi5.element.getById("input01");
+     * await nonUi5.userInteraction.clearAndFillAndRetry(elem, "Service 01");
+     */
+    clearAndFillAndRetry(element, value, retries = 3, interval = 5000, verify = true) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return util.function.retry((elem, value) => __awaiter(this, void 0, void 0, function* () {
+                yield this.clearAndFill(elem, value);
+                if (verify) {
+                    const elemValue = yield elem.getValue();
+                    if (elemValue != value)
+                        throw new Error("Function 'clearAndFillAndRetry' failed. Verification of value failed.");
+                }
+            }), [element, value], retries, interval, this);
+        });
+    }
+    ;
+    // =================================== OTHERS ===================================
+    /**
+     * @function mouseOverElement
+     * @memberOf nonUi5.userInteraction
+     * @description Moves the cursor/focus to the passed element.
+     * @param {Object} element - The selector describing the element.
+     * @param {Number} [xOffset] - 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.
+     * @param {Number} [yOffset] - 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.
+     * @example const elem = await nonUi5.element.getById("dropdown42");
+     * await nonUi5.userInteraction.mouseOverElement(elem);
+     */
+    mouseOverElement(elem, xOffset, yOffset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield elem.moveTo({ xOffset, yOffset });
+            }
+            catch (error) {
+                // @ts-ignore
+                throw new Error("Function: 'mouseOverElement' failed: ", error);
+            }
+        });
+    }
+    ;
+    /**
+     * @function scrollToElement
+     * @memberOf nonUi5.userInteraction
+     * @description Scrolls to the passed element to get it into view.
+     * @param {Object} elem - The element.
+     * @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'
+     * @example const elem = await nonUi5.userInteraction.getElementById("footer01");
+     * await nonUi5.userInteraction.scrollToElement(elem);
+     */
+    scrollToElement(elem, alignment = userInteraction_constants_1.AlignmentValues.CENTER) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const options = {
+                "block": alignment,
+                "inline": alignment
+            };
+            yield elem.scrollIntoView(options);
+        });
+    }
+    ;
+    /**
+     * @function dragAndDrop
+     * @memberOf nonUi5.userInteraction
+     * @description Drags and drops the given element to the given target element.
+     * @param {Object} element - The element to drag.
+     * @param {Object} targetElem - The target element to drop the element.
+     * @example const elem = await nonUi5.element.getById("drag01");
+     * @example const targetElem = await nonUi5.element.getById("drop02");
+     * await nonUi5.userInteraction.dragAndDrop(elem, targetElem);
+     */
+    dragAndDrop(element, targetElem) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // await element.dragAndDrop(targetElem);
+            const sourceSize = yield element.getSize();
+            const targetSize = yield targetElem.getSize();
+            const sourceLocation = yield element.getLocation();
+            const targetLocation = yield targetElem.getLocation();
+            // Get centers of elements to move from center to center (e.g. to avoid errors in rounded elements)
+            const sourceCenterLocation = {
+                x: +Number(sourceSize.width / 2).toFixed(0) + +Number(sourceLocation.x).toFixed(0) + 1,
+                y: +Number(sourceSize.height / 2).toFixed(0) + +Number(sourceLocation.y).toFixed(0) + 1
+            };
+            const targetCenterLocation = {
+                x: +Number(targetSize.width / 2).toFixed(0) + +Number(targetLocation.x).toFixed(0) + 1,
+                y: +Number(targetSize.height / 2).toFixed(0) + +Number(targetLocation.y).toFixed(0) + 1
+            };
+            yield browser.performActions([
+                {
+                    type: "pointer",
+                    id: "finger1",
+                    parameters: { pointerType: "mouse" },
+                    actions: [
+                        { type: "pointerMove", duration: 0, x: sourceCenterLocation.x, y: sourceCenterLocation.y },
+                        { type: "pointerDown", button: 0 },
+                        { type: "pointerMove", duration: 0, x: targetCenterLocation.x, y: targetCenterLocation.y },
+                        { type: "pointerUp", button: 0 },
+                    ],
+                },
+            ]);
+        });
+    }
+    ;
+    /**
+     * @function moveCursorAndClick
+     * @memberOf nonUi5.userInteraction
+     * @description Moves the cursor to the target element and clicks on it. Can be used for charts.
+     * @param {Object} element - The element to be clicked.
+     * @example const elem = await nonUi5.element.getById("chartPartToClick");
+     * await nonUi5.userInteraction.moveCursorAndClick(elem);
+     */
+    moveCursorAndClick(element) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield element.moveTo();
+            yield element.click();
+        });
+    }
+    ;
+    /**
+     * @function clickElementInSvg
+     * @memberOf nonUi5.userInteraction
+     * @description Clicks on an inner element within a SVG element.
+     * @param {Object} svgElem - The SVG element.
+     * @param {String} innerSelector - The CSS selector describing the inner element to be clicked.
+     * @example const svgElem = await nonUi5.element.getByCss("svg");
+     * const innerSelector = "circle:nth-child(6)";
+     * await nonUi5.userInteraction.clickElementInSvg(svgElem, innerSelector);
+     */
+    clickElementInSvg(svgElem, innerSelector) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const innerElem = yield $(innerSelector);
+            const svgPos = yield svgElem.getLocation();
+            const innerPos = yield innerElem.getLocation();
+            const svgSize = yield svgElem.getSize();
+            const innerSize = yield innerElem.getSize();
+            const diffX = innerPos.x - svgPos.x;
+            const diffY = innerPos.y - svgPos.y;
+            const centerOffsetX = -(svgSize.width / 2) + diffX + (innerSize.width / 2);
+            const centerOffsetY = -(svgSize.height / 2) + diffY + (innerSize.height / 2);
+            // @ts-ignore
+            yield svgElem.click({ x: parseInt(centerOffsetX), y: parseInt(centerOffsetY) });
+        });
+    }
+    ;
+}
+exports.UserInteraction = UserInteraction;
+;
+exports.default = new UserInteraction();
+//# sourceMappingURL=userInteraction.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"userInteraction.js","sourceRoot":"","sources":["../../../../src/reuse/modules/nonUi5/userInteraction.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;;;;;;;AAGb,qFAAwE;AAExE;;;GAGG;AACH,MAAa,eAAe;IAE1B,gFAAgF;IAChF;;;;;;;;OAQG;IACG,KAAK,CAAE,OAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB,IAAI,KAAK;;YAChF,MAAM,OAAO,CAAC,GAAG,CAAC;gBAChB,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBAC5B,IAAI,EAAE,OAAO;oBACb,QAAQ,EAAE,GAAG;oBACb,OAAO,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,yCAAyC;iBAC9E,CAAC;gBACF,MAAM,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC;oBAC1B,IAAI,EAAE,OAAO;oBACb,QAAQ,EAAE,GAAG;oBACb,OAAO,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,uCAAuC;iBAC5E,CAAC;aACH,CAAC,CAAC;YACH,IAAI;gBACF,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;aACvB;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,+BAA+B,CAAC,KAAc,EAAE,OAAO,CAAC,CAAC;gBAClG,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;aAC/B;QACH,CAAC;KAAA;IAAA,CAAC;IAEF;;;;;;;;;;OAUG;IACG,aAAa,CAAE,OAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB,IAAI,KAAK,EAAE,OAAO,GAAG,CAAC,EAAE,QAAQ,GAAG,IAAI;;YACtH,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAM,IAAI,KAAK,CAAC,+EAA+E,CAAC,CAAC;aAClG;YACD,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QACtF,CAAC;KAAA;IAAA,CAAC;IAEF;;;;;;;;OAQG;IACG,WAAW,CAAE,OAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB,IAAI,KAAK;;YACtF,MAAM,OAAO,CAAC,GAAG,CAAC;gBAChB,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBAC5B,IAAI,EAAE,OAAO;oBACb,QAAQ,EAAE,GAAG;oBACb,OAAO,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,yCAAyC;iBAC9E,CAAC;gBACF,MAAM,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC;oBAC1B,IAAI,EAAE,OAAO;oBACb,QAAQ,EAAE,GAAG;oBACb,OAAO,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,uCAAuC;iBAC5E,CAAC;aACH,CAAC,CAAC;YACH,IAAI;gBACF,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;aAC7B;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,+BAA+B,CAAC,KAAc,EAAE,aAAa,CAAC,CAAC;gBACxG,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;aAC/B;QACH,CAAC;KAAA;IAAA,CAAC;IAEF;;;;;;;;OAQG;IACG,UAAU,CAAE,OAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB,IAAI,KAAK;;YACrF,MAAM,OAAO,CAAC,GAAG,CAAC;gBAChB,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBAC5B,IAAI,EAAE,OAAO;oBACb,QAAQ,EAAE,GAAG;oBACb,OAAO,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,yCAAyC;iBAC9E,CAAC;gBACF,MAAM,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC;oBAC1B,IAAI,EAAE,OAAO;oBACb,QAAQ,EAAE,GAAG;oBACb,OAAO,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,uCAAuC;iBAC5E,CAAC;aACH,CAAC,CAAC;YACH,IAAI;gBACF,MAAM,OAAO,CAAC,KAAK,CAAC;oBAClB,MAAM,EAAE,OAAO;iBAChB,CAAC,CAAC;aACJ;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,+BAA+B,CAAC,KAAc,EAAE,YAAY,CAAC,CAAC;gBACvG,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;aAC/B;QACH,CAAC;KAAA;IAAA,CAAC;IAGF,+EAA+E;IAC/E;;;;;;;;OAQG;IACG,IAAI,CAAE,OAAgB,EAAE,KAAa;;YACzC,IAAI;gBACF,MAAM,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;aAC/B;YAAC,OAAO,KAAK,EAAE;gBACd,aAAa;gBACb,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,kDAAkD,CAAC,CAAC,EAAE;oBACxG,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,+BAA+B,CAAC,KAAc,EAAE,MAAM,CAAC,CAAC;oBACjG,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;iBAC/B;qBAAM;oBACL,IAAI,CAAC,KAAK,EAAE;wBACV,MAAM,IAAI,KAAK,CAAC,qEAAqE,GAAG,KAAK,CAAC,CAAC;qBAChG;yBAAM;wBACL,MAAM,KAAK,CAAC;qBACb;iBACF;aACF;QACH,CAAC;KAAA;IAAA,CAAC;IAEF;;;;;;;;;;OAUG;IACG,YAAY,CAAE,OAAgB,EAAE,KAAa,EAAE,UAAkB,CAAC,EAAE,WAAmB,IAAI;;YAC/F,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE,CAAC,EAAE;gBACvE,MAAM,IAAI,KAAK,CAAC,mFAAmF,CAAC,CAAC;aACtG;iBAAM;gBACL,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;aAClF;QACH,CAAC;KAAA;IAAA,CAAC;IAGF,gFAAgF;IAChF;;;;;;;OAOG;IACG,KAAK,CAAE,OAAgB;;YAC3B,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;aAC1F;YACD,OAAO,OAAO,CAAC,UAAU,EAAE,CAAC;QAC9B,CAAC;KAAA;IAAA,CAAC;IAEF;;;;;;;;;OASG;IACG,aAAa,CAAE,OAAgB,EAAE,OAAO,GAAG,CAAC,EAAE,QAAQ,GAAG,IAAI;;YACjE,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAM,IAAI,KAAK,CAAC,+EAA+E,CAAC,CAAC;aAClG;YACD,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC7E,CAAC;KAAA;IAAA,CAAC;IAEF;;;;;;;;OAQG;IACG,YAAY,CAAE,OAAgB,EAAE,KAAa;;YACjD,kHAAkH;YAClH,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE,CAAC,EAAE;gBACvE,MAAM,IAAI,KAAK,CAAC,mFAAmF,CAAC,CAAC;aACtG;iBAAM;gBACL,IAAI;oBACF,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;oBAC1B,MAAM,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;iBAC/B;gBAAC,OAAO,KAAK,EAAE;oBACd,MAAM,IAAI,KAAK,CAAC,mCAAmC,KAAK,EAAE,CAAC,CAAC;iBAC7D;aACF;QACH,CAAC;KAAA;IAAA,CAAC;IAEF;;;;;;;;;;;OAWG;IACG,oBAAoB,CAAE,OAAgB,EAAE,KAAa,EAAE,UAAkB,CAAC,EAAE,WAAmB,IAAI,EAAE,SAAkB,IAAI;;YAC/H,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAO,IAAa,EAAE,KAAa,EAAE,EAAE;gBAChE,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBACrC,IAAI,MAAM,EAAE;oBACV,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACxC,IAAI,SAAS,IAAI,KAAK;wBAAE,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;iBAClH;YACH,CAAC,CAAA,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAAA,CAAC;IAGF,iFAAiF;IACjF;;;;;;;;;OASG;IACI,gBAAgB,CAAE,IAAa,EAAE,OAAe,EAAE,OAAe;;YACtE,IAAI;gBACF,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;aACzC;YAAC,OAAO,KAAK,EAAE;gBACd,aAAa;gBACb,MAAM,IAAI,KAAK,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAAC;aACjE;QACH,CAAC;KAAA;IAAA,CAAC;IAEF;;;;;;;;;OASG;IACG,eAAe,CAAE,IAAa,EAAE,YAA6B,2CAAe,CAAC,MAAM;;YACvF,MAAM,OAAO,GAAG;gBACd,OAAO,EAAE,SAAS;gBAClB,QAAQ,EAAE,SAAS;aACpB,CAAC;YACF,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;KAAA;IAAA,CAAC;IAEF;;;;;;;;;OASG;IACG,WAAW,CAAE,OAAgB,EAAE,UAAmB;;YACtD,yCAAyC;YAEzC,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;YAC3C,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC;YAC9C,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;YACnD,MAAM,cAAc,GAAG,MAAM,UAAU,CAAC,WAAW,EAAE,CAAC;YAEtD,mGAAmG;YACnG,MAAM,oBAAoB,GAAG;gBAC3B,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,GAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;gBACpF,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,GAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;aACtF,CAAC;YAEF,MAAM,oBAAoB,GAAG;gBAC3B,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,GAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;gBACpF,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,GAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;aACtF,CAAC;YAEF,MAAM,OAAO,CAAC,cAAc,CAAC;gBAC3B;oBACE,IAAI,EAAE,SAAS;oBACf,EAAE,EAAE,SAAS;oBACb,UAAU,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE;oBACpC,OAAO,EAAE;wBACP,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,oBAAoB,CAAC,CAAC,EAAE,CAAC,EAAE,oBAAoB,CAAC,CAAC,EAAC;wBACzF,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,EAAE;wBAClC,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,oBAAoB,CAAC,CAAC,EAAE,CAAC,EAAE,oBAAoB,CAAC,CAAC,EAAC;wBACzF,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,EAAE;qBACjC;iBACF;aACF,CAAC,CAAC;QACL,CAAC;KAAA;IAAA,CAAC;IAEF;;;;;;;OAOG;IACG,kBAAkB,CAAE,OAAgB;;YACxC,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC;YACvB,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;QACxB,CAAC;KAAA;IAAA,CAAC;IAEF;;;;;;;;;OASG;IACI,iBAAiB,CAAE,OAAgB,EAAE,aAAqB;;YAC/D,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC;YAEzC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;YAC3C,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,WAAW,EAAE,CAAC;YAE/C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;YACxC,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;YAE5C,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;YACpC,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;YAEpC,MAAM,aAAa,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;YAC3E,MAAM,aAAa,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAE7E,aAAa;YACb,MAAM,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QAClF,CAAC;KAAA;IAAA,CAAC;CAEH;AA7WD,0CA6WC;AAAA,CAAC;AACF,kBAAe,IAAI,eAAe,EAAE,CAAC"}