@sap_oss/wdio-qmate-service 1.0.0

package/lib/reuse/modules/util/formatter.d.ts

@@ -0,0 +1,90 @@
+import { DateFormatsType } from "./types/formatter.types";
+/**
+ * @class formatter
+ * @memberof util
+ */
+export declare class Formatter {
+    /**
+     * @function sliceStringAt
+     * @memberOf util.formatter
+     * @description Slices the given string beginning at a specific substring.
+     * @param {String} input - The input string to slice.
+     * @param {String} slicePoint - The substring at which the input string is being sliced.
+     * @param {number} length - The required length of the returning string (starting at the index of the passed slice point).
+     * @returns {String} The sliced string.
+     * @example const sliced = util.formatter.sliceStringAt("prefixNR12345postfix", "NR", 7);
+     * // returns "NR12345"
+     */
+    sliceStringAt(input: string, slicePoint: string, length: number): string;
+    /**
+     * @function sliceStringAfter
+     * @memberOf util.formatter
+     * @description Slices the given string after a specific substring.
+     * @param {String} input - The input string to slice.
+     * @param {String} slicePoint - The substring after which the input string is being sliced.
+     * @param {number} length - The required length of the returning string (starting at the index after the passed slice point).
+     * @returns {String} The sliced string.
+     * @example const sliced = util.formatter.sliceStringAfter("prefixNR12345postfix", "NR", 5);
+     * // returns "12345"
+     */
+    sliceStringAfter(input: string, slicePoint: string, length: number): string;
+    /**
+     * @function trimString
+     * @memberOf util.formatter
+     * @description Removes whitespace from both sides of the given string.
+     * @param {String} input - The input string to trim.
+     * @example const trimmed = util.formatter.trimString("   value ");
+     * // returns "value"
+     */
+    trimString(input: string): string;
+    /**
+     * @function extractNumberFromString
+     * @memberOf util.formatter
+     * @description Extracts all numbers from a string.
+     * @param {String} input - The input string to extract the number.
+     * @param {number} [index=0] - If there are multiple numbers in the string you can pass an index to return a specific number.
+     * @returns {String} The extracted number.
+     * @example const extracted = util.formatter.extractNumberFromString("prefixNR12345postfix");
+     * // returns "12345"
+     * @example const extracted = util.formatter.extractNumberFromString("first12345 someText second 20 abc", 1);
+     * // returns "20"
+     */
+    extractNumberFromString(input: string, index?: number): string;
+    /**
+     * @function stringifyJSON
+     * @memberOf util.formatter
+     * @description Converts a JSON object to string.
+     * @param {Object} object - The JSON to be converted.
+     * @returns {String} The converted JSON object.
+     * @example console.log(`Printing the current selector: ${util.formatter.stringifyJSON(selector)}`);
+     */
+    stringifyJSON(object: object): string;
+    /**
+     * @function addRemoveLeadingZeros
+     * @memberOf util.formatter
+     * @description Adds or removes leading zeros to the passed number to format it to the required length.
+     * @param {String} number - The number to be formatted.
+     * @param {Number} length - The required length of the number.
+     * @returns {String} The formatted number.
+     * @example const itemNumber = util.formatter.addRemoveLeadingZeros(10, 5);
+     */
+    addRemoveLeadingZeros(number: string, length: number): string;
+    /**
+     * @function formatDate
+     * @memberOf util.formatter
+     * @description formats date.
+     * @param {Date} date - The date object to be formatted.
+     * @param {String} format - The expected format ("mm/dd/yyyy", "dd.mm.yyyy", "dd/mm/yyyy", "yyyymmdd", "yyyy/mm/dd", "mmm dd, yyyy", "datetime", "object").
+     * @param {String} [locale="en-US"] - The locale format of the date. E.g. "en-US", "de-DE", etc.
+     * @returns {String} The formatted date as string.
+     * @example const date = new Date(2020, 0, 17);
+     * const formattedDate = util.formatter.formatDate(date, "mm/dd/yyyy");
+     * // returns "01/17/2020"
+     * @example const date = new Date(2022, 3, 12);
+     * const formattedDate = util.formatter.formatDate(date, "mmm dd, yyyy");
+     * // returns "Apr 03, 2022"
+     */
+    formatDate(date: Date, format: DateFormatsType, locale?: string): string | Date;
+}
+declare const _default: Formatter;
+export default _default;

package/lib/reuse/modules/util/formatter.js

@@ -0,0 +1,210 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Formatter = void 0;
+const formatter_constants_1 = require("./constants/formatter.constants");
+/**
+ * @class formatter
+ * @memberof util
+ */
+class Formatter {
+    // =================================== STRING ===================================
+    /**
+     * @function sliceStringAt
+     * @memberOf util.formatter
+     * @description Slices the given string beginning at a specific substring.
+     * @param {String} input - The input string to slice.
+     * @param {String} slicePoint - The substring at which the input string is being sliced.
+     * @param {number} length - The required length of the returning string (starting at the index of the passed slice point).
+     * @returns {String} The sliced string.
+     * @example const sliced = util.formatter.sliceStringAt("prefixNR12345postfix", "NR", 7);
+     * // returns "NR12345"
+     */
+    sliceStringAt(input, slicePoint, length) {
+        if (input && slicePoint && length) {
+            const index = input.indexOf(slicePoint);
+            if (index !== -1) {
+                return input.slice(index, index + length);
+            }
+            else {
+                throw new Error(`Char '${slicePoint}' not found in input '${input}'.`);
+            }
+        }
+        else {
+            throw new Error("Function 'sliceStringAt' failed: Incorrect or missing arguments.");
+        }
+    }
+    ;
+    /**
+     * @function sliceStringAfter
+     * @memberOf util.formatter
+     * @description Slices the given string after a specific substring.
+     * @param {String} input - The input string to slice.
+     * @param {String} slicePoint - The substring after which the input string is being sliced.
+     * @param {number} length - The required length of the returning string (starting at the index after the passed slice point).
+     * @returns {String} The sliced string.
+     * @example const sliced = util.formatter.sliceStringAfter("prefixNR12345postfix", "NR", 5);
+     * // returns "12345"
+     */
+    sliceStringAfter(input, slicePoint, length) {
+        if (input && slicePoint && length) {
+            let index = input.indexOf(slicePoint);
+            if (index !== -1) {
+                index = index + slicePoint.length;
+                return input.slice(index, index + length);
+            }
+            throw new Error(`Char '${slicePoint}' not found in input '${input}'.`);
+        }
+        throw new Error("Function 'sliceStringAfter' failed: Incorrect or missing arguments.");
+    }
+    ;
+    /**
+     * @function trimString
+     * @memberOf util.formatter
+     * @description Removes whitespace from both sides of the given string.
+     * @param {String} input - The input string to trim.
+     * @example const trimmed = util.formatter.trimString("   value ");
+     * // returns "value"
+     */
+    trimString(input) {
+        if (input) {
+            return input.trim();
+        }
+        throw new Error("Function 'trimString' failed: Incorrect or missing arguments.");
+    }
+    ;
+    /**
+     * @function extractNumberFromString
+     * @memberOf util.formatter
+     * @description Extracts all numbers from a string.
+     * @param {String} input - The input string to extract the number.
+     * @param {number} [index=0] - If there are multiple numbers in the string you can pass an index to return a specific number.
+     * @returns {String} The extracted number.
+     * @example const extracted = util.formatter.extractNumberFromString("prefixNR12345postfix");
+     * // returns "12345"
+     * @example const extracted = util.formatter.extractNumberFromString("first12345 someText second 20 abc", 1);
+     * // returns "20"
+     */
+    extractNumberFromString(input, index = 0) {
+        if (input) {
+            // @ts-ignore
+            return input.match(/\d+/g).map(Number)[index].toString();
+        }
+        throw new Error("Function 'extractNumberFromString' failed: Incorrect or missing arguments.");
+    }
+    ;
+    /**
+     * @function stringifyJSON
+     * @memberOf util.formatter
+     * @description Converts a JSON object to string.
+     * @param {Object} object - The JSON to be converted.
+     * @returns {String} The converted JSON object.
+     * @example console.log(`Printing the current selector: ${util.formatter.stringifyJSON(selector)}`);
+     */
+    stringifyJSON(object) {
+        try {
+            return JSON.stringify(object);
+        }
+        catch (error) {
+            throw new Error(`Function 'stringifyJSON' failed: Incorrect JSON object. ${error}`);
+        }
+    }
+    ;
+    // =================================== NUMBER ===================================
+    /**
+     * @function addRemoveLeadingZeros
+     * @memberOf util.formatter
+     * @description Adds or removes leading zeros to the passed number to format it to the required length.
+     * @param {String} number - The number to be formatted.
+     * @param {Number} length - The required length of the number.
+     * @returns {String} The formatted number.
+     * @example const itemNumber = util.formatter.addRemoveLeadingZeros(10, 5);
+     */
+    addRemoveLeadingZeros(number, length) {
+        const numberParsed = parseInt(number, 10);
+        const zero = "0";
+        const char = zero.repeat(length) + numberParsed;
+        return char.slice(-length);
+    }
+    ;
+    // =================================== DATE ===================================
+    /**
+     * @function formatDate
+     * @memberOf util.formatter
+     * @description formats date.
+     * @param {Date} date - The date object to be formatted.
+     * @param {String} format - The expected format ("mm/dd/yyyy", "dd.mm.yyyy", "dd/mm/yyyy", "yyyymmdd", "yyyy/mm/dd", "mmm dd, yyyy", "datetime", "object").
+     * @param {String} [locale="en-US"] - The locale format of the date. E.g. "en-US", "de-DE", etc.
+     * @returns {String} The formatted date as string.
+     * @example const date = new Date(2020, 0, 17);
+     * const formattedDate = util.formatter.formatDate(date, "mm/dd/yyyy");
+     * // returns "01/17/2020"
+     * @example const date = new Date(2022, 3, 12);
+     * const formattedDate = util.formatter.formatDate(date, "mmm dd, yyyy");
+     * // returns "Apr 03, 2022"
+     */
+    formatDate(date, format, locale = "en-US") {
+        let formattedDate = date;
+        let hour = date.getHours();
+        let min = date.getMinutes();
+        let sec = date.getSeconds();
+        let dd = date.getDate();
+        let mm = date.getMonth() + 1;
+        const month = date.toLocaleString(locale, { month: "short" });
+        const yyyy = date.getFullYear();
+        if (sec < 10) {
+            sec = `0${sec}`;
+        }
+        if (min < 10) {
+            min = `0${min}`;
+        }
+        if (hour < 10) {
+            hour = `0${hour}`;
+        }
+        if (dd < 10) {
+            dd = `0${dd}`;
+        }
+        if (mm < 10) {
+            mm = `0${mm}`;
+        }
+        if (format) {
+            format = format.toLowerCase();
+            switch (format) {
+                case formatter_constants_1.DateFormats.MONTH_DAY_YEAR_SLASH:
+                    formattedDate = `${mm}/${dd}/${yyyy}`;
+                    break;
+                case formatter_constants_1.DateFormats.DAY_MONTH_YEAR_DOT:
+                    formattedDate = `${dd}.${mm}.${yyyy}`;
+                    break;
+                case formatter_constants_1.DateFormats.DAY_MONTH_YEAR_SLASH:
+                    formattedDate = `${dd}/${mm}/${yyyy}`;
+                    break;
+                case formatter_constants_1.DateFormats.YEAR_MONTH_DAY_PLAIN:
+                    formattedDate = `${yyyy}${mm}${dd}`;
+                    break;
+                case formatter_constants_1.DateFormats.YEAR_MONTH_DAY_SLASH:
+                    formattedDate = `${yyyy}/${mm}/${dd}`;
+                    break;
+                case formatter_constants_1.DateFormats.DAY_MONTH_YEAR_TIME_DOT:
+                    formattedDate = `${dd}.${mm}.${yyyy}.${hour}.${min}`;
+                    break;
+                case formatter_constants_1.DateFormats.MONTH_DAY_YEAR_COMMA:
+                    formattedDate = `${month} ${dd}, ${yyyy}`;
+                    break;
+                case formatter_constants_1.DateFormats.DATETIME:
+                    formattedDate = `datetime'${yyyy}-${mm}-${dd}T${hour}:${min}:${sec}'`;
+                    break;
+                case formatter_constants_1.DateFormats.OBJECT:
+                    formattedDate = date;
+                    break;
+                default:
+                    break;
+            }
+        }
+        return formattedDate;
+    }
+    ;
+}
+exports.Formatter = Formatter;
+;
+exports.default = new Formatter();
+//# sourceMappingURL=formatter.js.map

package/lib/reuse/modules/util/formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../../../src/reuse/modules/util/formatter.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;AAEb,yEAA8D;AAG9D;;;GAGG;AACH,MAAa,SAAS;IAEpB,iFAAiF;IACjF;;;;;;;;;;OAUG;IACH,aAAa,CAAE,KAAa,EAAE,UAAkB,EAAE,MAAc;QAC9D,IAAI,KAAK,IAAI,UAAU,IAAI,MAAM,EAAE;YACjC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACxC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;gBAChB,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,CAAC;aAC3C;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,SAAS,UAAU,yBAAyB,KAAK,IAAI,CAAC,CAAC;aACxE;SACF;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;SACrF;IACH,CAAC;IAAA,CAAC;IAEF;;;;;;;;;;OAUG;IACH,gBAAgB,CAAE,KAAa,EAAE,UAAkB,EAAE,MAAc;QACjE,IAAI,KAAK,IAAI,UAAU,IAAI,MAAM,EAAE;YACjC,IAAI,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACtC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;gBAChB,KAAK,GAAG,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC;gBAClC,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,CAAC;aAC3C;YACD,MAAM,IAAI,KAAK,CAAC,SAAS,UAAU,yBAAyB,KAAK,IAAI,CAAC,CAAC;SACxE;QACD,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;IACzF,CAAC;IAAA,CAAC;IAEF;;;;;;;OAOG;IACH,UAAU,CAAE,KAAa;QACvB,IAAI,KAAK,EAAE;YACT,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC;SACrB;QACD,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;IACnF,CAAC;IAAA,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,uBAAuB,CAAE,KAAa,EAAE,QAAgB,CAAC;QACvD,IAAI,KAAK,EAAE;YACT,aAAa;YACb,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;SAC1D;QACD,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;IAChG,CAAC;IAAA,CAAC;IAEF;;;;;;;OAOG;IACH,aAAa,CAAE,MAAc;QAC3B,IAAI;YACF,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;SAC/B;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,2DAA2D,KAAK,EAAE,CAAC,CAAC;SACrF;IACH,CAAC;IAAA,CAAC;IAGF,iFAAiF;IACjF;;;;;;;;OAQG;IACH,qBAAqB,CAAE,MAAc,EAAE,MAAc;QACnD,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,GAAG,CAAC;QACjB,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC;QAChD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAAA,CAAC;IAGF,+EAA+E;IAC/E;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAE,IAAU,EAAE,MAAuB,EAAE,MAAM,GAAG,OAAO;QAC/D,IAAI,aAAa,GAAkB,IAAI,CAAC;QACxC,IAAI,IAAI,GAAoB,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC5C,IAAI,GAAG,GAAoB,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7C,IAAI,GAAG,GAAoB,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7C,IAAI,EAAE,GAAoB,IAAI,CAAC,OAAO,EAAE,CAAC;QACzC,IAAI,EAAE,GAAoB,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QAC9D,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAEhC,IAAI,GAAG,GAAG,EAAE,EAAE;YACZ,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;SACjB;QAED,IAAI,GAAG,GAAG,EAAE,EAAE;YACZ,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;SACjB;QAED,IAAI,IAAI,GAAG,EAAE,EAAE;YACb,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;SACnB;QAED,IAAI,EAAE,GAAG,EAAE,EAAE;YACX,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC;SACf;QAED,IAAI,EAAE,GAAG,EAAE,EAAE;YACX,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC;SACf;QAED,IAAI,MAAM,EAAE;YACV,MAAM,GAAG,MAAM,CAAC,WAAW,EAAiB,CAAC;YAE7C,QAAQ,MAAM,EAAE;gBACd,KAAK,iCAAW,CAAC,oBAAoB;oBACnC,aAAa,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC;oBACtC,MAAM;gBACR,KAAK,iCAAW,CAAC,kBAAkB;oBACjC,aAAa,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC;oBACtC,MAAM;gBACR,KAAK,iCAAW,CAAC,oBAAoB;oBACnC,aAAa,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC;oBACtC,MAAM;gBACR,KAAK,iCAAW,CAAC,oBAAoB;oBACnC,aAAa,GAAG,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;oBACpC,MAAM;gBACR,KAAK,iCAAW,CAAC,oBAAoB;oBACnC,aAAa,GAAG,GAAG,IAAI,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC;oBACtC,MAAM;gBACR,KAAK,iCAAW,CAAC,uBAAuB;oBACtC,aAAa,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,IAAI,IAAI,IAAI,IAAI,GAAG,EAAE,CAAC;oBACrD,MAAM;gBACR,KAAK,iCAAW,CAAC,oBAAoB;oBACnC,aAAa,GAAG,GAAG,KAAK,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;oBAC1C,MAAM;gBACR,KAAK,iCAAW,CAAC,QAAQ;oBACvB,aAAa,GAAG,YAAY,IAAI,IAAI,EAAE,IAAI,EAAE,IAAI,IAAI,IAAI,GAAG,IAAI,GAAG,GAAG,CAAC;oBACtE,MAAM;gBACR,KAAK,iCAAW,CAAC,MAAM;oBACrB,aAAa,GAAG,IAAI,CAAC;oBACrB,MAAM;gBACR;oBACE,MAAM;aACT;SACF;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAAA,CAAC;CAEH;AA7MD,8BA6MC;AAAA,CAAC;AACF,kBAAe,IAAI,SAAS,EAAE,CAAC"}

package/lib/reuse/modules/util/function.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @class function
+ * @memberof util
+ */
+export declare class FunctionModule {
+    overallRetries: number;
+    /**
+     * @function retry
+     * @memberOf util.function
+     * @description Retries the passed function n times with a specific interval until it executed successfully.
+     * @param {Function} fct - The function to retry.
+     * @param {Array} args - An array of the arguments passed to the function.
+     * @param {Integer} [retries=3] - The number of retries. Can be set in config for all functions under "params" - "stepsRetries".
+     * @param {Integer} [interval=5000] - The interval of the retries (ms). Can be set in config for all functions under "params" - "stepRetriesIntervals".
+     * @param {Object} [scope=null] - The function scope. Defaults is the global object.
+     * @example await util.function.retry(ui5.userInteraction.fill, [selector, value], 4, 10000);
+     * @example await util.function.retry(async () => {
+     *  await ui5.userInteraction.fill(selector, "ABC");
+     * }, [], 2, 30000);
+     */
+    retry(fct: Function, args: Array<any>, retries: number, interval: number, scope?: any): Promise<void>;
+    /**
+     * @function executeOptional
+     * @memberOf util.function
+     * @description Executes the given function optionally. If it fails, a promise will be returned anyway.
+     * @param {Function} fct - The function to execute.
+     * @param {Array} args - An array of the arguments passed to the function.
+     * @example await util.function.executeOptional(ui5.userInteraction.fill, [selector, value]);
+     * @example await util.function.executeOptional(async () => {
+     *  await ui5.userInteraction.fill(selector, "ABC");
+     * }, []);
+     */
+    executeOptional(fct: any, args?: Array<any>): Promise<void>;
+    /**
+     * @function mapWdioErrorToQmateErrorMessage
+     * @memberOf util.function
+     * @private
+     * @description Maps Wdio Error to Qmate Error Message
+     * @param {Error} wdioError - The wdio error
+     * @param {string} action - An action performed upon the element ("click", "fill")
+     * @example await util.function.mapWdioErrorToQmateErrorMessage(error, "click");
+     */
+    mapWdioErrorToQmateErrorMessage(wdioError: Error, action: string): Promise<string>;
+    private _getRetryProperties;
+    private _retry;
+}
+declare const _default: FunctionModule;
+export default _default;

package/lib/reuse/modules/util/function.js

@@ -0,0 +1,161 @@
+"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.FunctionModule = void 0;
+/**
+ * @class function
+ * @memberof util
+ */
+class FunctionModule {
+    constructor() {
+        this.overallRetries = 3;
+    }
+    // =================================== MAIN ===================================
+    /**
+     * @function retry
+     * @memberOf util.function
+     * @description Retries the passed function n times with a specific interval until it executed successfully.
+     * @param {Function} fct - The function to retry.
+     * @param {Array} args - An array of the arguments passed to the function.
+     * @param {Integer} [retries=3] - The number of retries. Can be set in config for all functions under "params" - "stepsRetries".
+     * @param {Integer} [interval=5000] - The interval of the retries (ms). Can be set in config for all functions under "params" - "stepRetriesIntervals".
+     * @param {Object} [scope=null] - The function scope. Defaults is the global object.
+     * @example await util.function.retry(ui5.userInteraction.fill, [selector, value], 4, 10000);
+     * @example await util.function.retry(async () => {
+     *  await ui5.userInteraction.fill(selector, "ABC");
+     * }, [], 2, 30000);
+     */
+    // NOTE: Don't set default values since they will be calculated with "_getRetryProperties".
+    retry(fct, args, retries, interval, scope = null) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.overallRetries = retries;
+            const res = yield this._getRetryProperties(retries, interval);
+            yield this._retry(fct, args, res.retries, res.interval, scope);
+        });
+    }
+    ;
+    /**
+     * @function executeOptional
+     * @memberOf util.function
+     * @description Executes the given function optionally. If it fails, a promise will be returned anyway.
+     * @param {Function} fct - The function to execute.
+     * @param {Array} args - An array of the arguments passed to the function.
+     * @example await util.function.executeOptional(ui5.userInteraction.fill, [selector, value]);
+     * @example await util.function.executeOptional(async () => {
+     *  await ui5.userInteraction.fill(selector, "ABC");
+     * }, []);
+     */
+    executeOptional(fct, args = []) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield fct.apply(this, args);
+            }
+            catch (e) {
+                if (fct.name) {
+                    util.console.info(`Optional function '${fct.name}' not executed, continue ...`);
+                }
+                else {
+                    util.console.info(`Optional anonymous function not executed, continue ...`);
+                }
+                return Promise.resolve();
+            }
+        });
+    }
+    ;
+    // =================================== HELPER ===================================
+    /**
+     * @function mapWdioErrorToQmateErrorMessage
+     * @memberOf util.function
+     * @private
+     * @description Maps Wdio Error to Qmate Error Message
+     * @param {Error} wdioError - The wdio error
+     * @param {string} action - An action performed upon the element ("click", "fill")
+     * @example await util.function.mapWdioErrorToQmateErrorMessage(error, "click");
+     */
+    mapWdioErrorToQmateErrorMessage(wdioError, action) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const errorMessage = wdioError.message;
+            let qmateMessage = "";
+            if (action === "fill") {
+                if (errorMessage.match(new RegExp(/(invalid element state|element not interactable)/))) {
+                    qmateMessage = `Function fill failed. Element can not be filled - make sure that the selector matches input \n\n` + wdioError.stack;
+                }
+            }
+            else if (action === "click") {
+                if (errorMessage.match(new RegExp(/is not clickable at point/))) {
+                    const reg = new RegExp(/(?<=Element <.* )(.*)(?=>...<)/).exec(errorMessage);
+                    const foundAttributes = reg ? reg[0] : undefined;
+                    let elementAttributes = foundAttributes;
+                    if (reg && foundAttributes) {
+                        if (foundAttributes.includes("id=")) {
+                            // @ts-ignore
+                            elementAttributes = foundAttributes.match(new RegExp(/(?=id)(.*)(?<=")/));
+                        }
+                        else if (foundAttributes.includes("class=")) {
+                            // @ts-ignore
+                            elementAttributes = foundAttributes.match(new RegExp(/(?=class)(.*)(?<=")/));
+                        }
+                    }
+                    if (wdioError && wdioError.stack && elementAttributes) {
+                        qmateMessage = `Element with attribute(s) ${elementAttributes[0]} is hidden by another element \n\n` + wdioError.stack;
+                    }
+                    else {
+                        qmateMessage = "Error clicking element \n\n" + wdioError;
+                    }
+                }
+            }
+            return qmateMessage;
+        });
+    }
+    ;
+    // =================================== HELPER ===================================
+    _getRetryProperties(retries, interval) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = {
+                retries: retries,
+                interval: interval
+            };
+            if (res.retries === undefined) {
+                res.retries = browser.config.stepsRetries;
+                if (res.retries === undefined) {
+                    res.retries = 3;
+                }
+            }
+            if (res.interval === undefined) {
+                res.interval = browser.config.stepRetriesIntervals;
+                if (res.interval === undefined) {
+                    res.interval = 5000;
+                }
+            }
+            return res;
+        });
+    }
+    _retry(fct, args, retries, interval, scope = null) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield fct.apply(scope, args);
+            }
+            catch (e) {
+                retries = retries - 1;
+                if (retries < 0) {
+                    throw new Error(`Retries done. Failed to execute the function: ${e}`);
+                }
+                yield browser.pause(interval);
+                util.console.log(`Retrying function again (${this.overallRetries - retries}/${this.overallRetries})`);
+                yield this._retry(fct, args, retries, interval, scope);
+            }
+        });
+    }
+}
+exports.FunctionModule = FunctionModule;
+;
+exports.default = new FunctionModule();
+//# sourceMappingURL=function.js.map

package/lib/reuse/modules/util/function.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"function.js","sourceRoot":"","sources":["../../../../src/reuse/modules/util/function.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;;;;;;;AACb;;;GAGG;AACH,MAAa,cAAc;IAA3B;QACE,mBAAc,GAAW,CAAC,CAAC;IA4H7B,CAAC;IA1HC,+EAA+E;IAC/E;;;;;;;;;;;;;OAaG;IACH,2FAA2F;IACrF,KAAK,CAAE,GAAa,EAAE,IAAgB,EAAE,OAAe,EAAE,QAAgB,EAAE,QAAa,IAAI;;YAChG,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC;YAC9B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC9D,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACjE,CAAC;KAAA;IAAA,CAAC;IAEF;;;;;;;;;;OAUG;IACG,eAAe,CAAE,GAAQ,EAAE,OAAmB,EAAE;;YACpD,IAAI;gBACF,MAAM,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;aAC7B;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI,GAAG,CAAC,IAAI,EAAE;oBACZ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,GAAG,CAAC,IAAI,8BAA8B,CAAC,CAAC;iBACjF;qBAAM;oBACL,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;iBAC7E;gBACD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;aAC1B;QACH,CAAC;KAAA;IAAA,CAAC;IAEF,iFAAiF;IACjF;;;;;;;;OAQG;IACG,+BAA+B,CAAE,SAAgB,EAAE,MAAc;;YACrE,MAAM,YAAY,GAAG,SAAS,CAAC,OAAO,CAAC;YACvC,IAAI,YAAY,GAAG,EAAE,CAAC;YACtB,IAAI,MAAM,KAAK,MAAM,EAAE;gBACrB,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,kDAAkD,CAAC,CAAC,EAAE;oBACtF,YAAY,GAAG,kGAAkG,GAAG,SAAS,CAAC,KAAK,CAAC;iBACrI;aACF;iBAAM,IAAI,MAAM,KAAK,OAAO,EAAE;gBAC7B,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,2BAA2B,CAAC,CAAC,EAAE;oBAC/D,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,gCAAgC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;oBAC5E,MAAM,eAAe,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;oBACjD,IAAI,iBAAiB,GAAG,eAAe,CAAC;oBACxC,IAAI,GAAG,IAAI,eAAe,EAAE;wBAC1B,IAAI,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;4BACnC,aAAa;4BACb,iBAAiB,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC;yBAC3E;6BAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;4BAC7C,aAAa;4BACb,iBAAiB,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,qBAAqB,CAAC,CAAC,CAAC;yBAC9E;qBACF;oBACD,IAAI,SAAS,IAAI,SAAS,CAAC,KAAK,IAAI,iBAAiB,EAAE;wBACrD,YAAY,GAAG,6BAA6B,iBAAiB,CAAC,CAAC,CAAC,oCAAoC,GAAG,SAAS,CAAC,KAAK,CAAC;qBACxH;yBAAM;wBACL,YAAY,GAAG,6BAA6B,GAAG,SAAS,CAAC;qBAC1D;iBACF;aACF;YACD,OAAO,YAAY,CAAC;QACtB,CAAC;KAAA;IAAA,CAAC;IAGF,iFAAiF;IACnE,mBAAmB,CAAC,OAAe,EAAE,QAAgB;;YACjE,MAAM,GAAG,GAAG;gBACV,OAAO,EAAE,OAAO;gBAChB,QAAQ,EAAE,QAAQ;aACnB,CAAC;YACF,IAAI,GAAG,CAAC,OAAO,KAAK,SAAS,EAAE;gBAC7B,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC;gBAC1C,IAAI,GAAG,CAAC,OAAO,KAAK,SAAS,EAAE;oBAC7B,GAAG,CAAC,OAAO,GAAG,CAAC,CAAC;iBACjB;aACF;YACD,IAAI,GAAG,CAAC,QAAQ,KAAK,SAAS,EAAE;gBAC9B,GAAG,CAAC,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC;gBACnD,IAAI,GAAG,CAAC,QAAQ,KAAK,SAAS,EAAE;oBAC9B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;iBACrB;aACF;YACD,OAAO,GAAG,CAAC;QACb,CAAC;KAAA;IAEa,MAAM,CAAC,GAAQ,EAAE,IAAgB,EAAE,OAAe,EAAE,QAAgB,EAAE,KAAK,GAAG,IAAI;;YAC9F,IAAI;gBACF,OAAO,MAAM,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;aACrC;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,GAAG,OAAO,GAAG,CAAC,CAAC;gBACtB,IAAI,OAAO,GAAG,CAAC,EAAE;oBACf,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,EAAE,CAAC,CAAC;iBACvE;gBACD,MAAM,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAC9B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,IAAI,CAAC,cAAc,GAAG,OAAO,IAAI,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;gBACtG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;aACxD;QACH,CAAC;KAAA;CACF;AA7HD,wCA6HC;AAAA,CAAC;AAEF,kBAAe,IAAI,cAAc,EAAE,CAAC"}

package/lib/reuse/modules/util/system.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @class system
+ * @memberof util
+ */
+export declare class System {
+    operatingSystem: any;
+    /**
+     * @function getOS
+     * @memberOf util.system
+     * @description Returns the current operating system.
+     * @returns {String} AIX | Android | MacOS | FreeBSD | Linux | OpenBSD | Windows | SunOS
+     * @example const os = await util.system.getOS();
+     */
+    getOS(): Promise<string>;
+}
+declare const _default: System;
+export default _default;

package/lib/reuse/modules/util/system.js

@@ -0,0 +1,58 @@
+"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.System = void 0;
+/**
+ * @class system
+ * @memberof util
+ */
+class System {
+    constructor() {
+        this.operatingSystem = require("os");
+    }
+    /**
+     * @function getOS
+     * @memberOf util.system
+     * @description Returns the current operating system.
+     * @returns {String} AIX | Android | MacOS | FreeBSD | Linux | OpenBSD | Windows | SunOS
+     * @example const os = await util.system.getOS();
+     */
+    getOS() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const platform = this.operatingSystem.platform();
+            switch (platform) {
+                case "aix":
+                    return "AIX";
+                case "android":
+                    return "Android";
+                case "darwin":
+                    return "MacOS";
+                case "freebsd":
+                    return "FreeBSD";
+                case "linux":
+                    return "Linux";
+                case "openbsd":
+                    return "OpenBSD";
+                case "sunos":
+                    return "SunOS";
+                case "win32":
+                    return "Windows";
+                default:
+                    return "unknown platform";
+            }
+        });
+    }
+    ;
+}
+exports.System = System;
+;
+exports.default = new System();
+//# sourceMappingURL=system.js.map

package/lib/reuse/modules/util/system.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"system.js","sourceRoot":"","sources":["../../../../src/reuse/modules/util/system.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;;;;;;;AACb;;;GAGG;AACH,MAAa,MAAM;IAAnB;QACE,oBAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAiClC,CAAC;IA/BC;;;;;;OAMG;IACG,KAAK;;YACT,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC;YACjD,QAAQ,QAAQ,EAAE;gBAChB,KAAK,KAAK;oBACR,OAAO,KAAK,CAAC;gBACf,KAAK,SAAS;oBACZ,OAAO,SAAS,CAAC;gBACnB,KAAK,QAAQ;oBACX,OAAO,OAAO,CAAC;gBACjB,KAAK,SAAS;oBACZ,OAAO,SAAS,CAAC;gBACnB,KAAK,OAAO;oBACV,OAAO,OAAO,CAAC;gBACjB,KAAK,SAAS;oBACZ,OAAO,SAAS,CAAC;gBACnB,KAAK,OAAO;oBACV,OAAO,OAAO,CAAC;gBACjB,KAAK,OAAO;oBACV,OAAO,SAAS,CAAC;gBACnB;oBACE,OAAO,kBAAkB,CAAC;aAC7B;QACH,CAAC;KAAA;IAAA,CAAC;CAEH;AAlCD,wBAkCC;AAAA,CAAC;AACF,kBAAe,IAAI,MAAM,EAAE,CAAC"}

package/lib/reuse/modules/util/types/formatter.types.d.ts

@@ -0,0 +1,2 @@
+import { DateFormats } from "../constants/formatter.constants";
+export declare type DateFormatsType = `${DateFormats}`;

package/lib/reuse/modules/util/types/formatter.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=formatter.types.js.map

package/lib/reuse/modules/util/types/formatter.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatter.types.js","sourceRoot":"","sources":["../../../../../src/reuse/modules/util/types/formatter.types.ts"],"names":[],"mappings":""}

package/lib/scripts/clientsideUI5scripts.d.ts

@@ -0,0 +1 @@
+export const installInBrowser: string;