@sap_oss/wdio-qmate-service 1.0.0

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

@@ -0,0 +1,56 @@
+/**
+ * @class console
+ * @memberof util
+ */
+export declare class Console {
+    private colorReset;
+    /**
+     * @function log
+     * @memberOf util.console
+     * @description Logs a message to the console in the given color.
+     * @param {String} message - The message to log.
+     * @param {String} [textColor] - The color of the text: "black, white", "red", "yellow", "green", "blue", "cyan", "magenta".
+     * @param {String} [backgroundColor] - The color of the background: "black, white", "red", "yellow", "green", "blue", "cyan", "magenta".
+     * @param {String} [brightness] - Adjusts the brightness of the color: "bright", "dim". Leave empty for default.
+     * @example util.console.log("The document has been saved.", "green");
+     */
+    log(message: string, textColor?: string, backgroundColor?: string, brightness?: string): void;
+    /**
+     * @function error
+     * @memberOf util.console
+     * @description Logs a error message to the console in red.
+     * @param {String} message - The message to log.
+     * @example util.console.error("Error: Please investigate.");
+     */
+    error(message: string): void;
+    /**
+     * @function warn
+     * @memberOf util.console
+     * @description Logs a warning message to the console in yellow.
+     * @param {String} message - The message to log.
+     * @example util.console.warn("Optional step not executed.");
+     */
+    warn(message: string): void;
+    /**
+     * @function success
+     * @memberOf util.console
+     * @description Logs a success message to the console in green.
+     * @param {String} message - The message to log.
+     * @example util.console.success("The document has been saved.");
+     */
+    success(message: string): void;
+    /**
+     * @function info
+     * @memberOf util.console
+     * @description Logs a info message to the console in cyan.
+     * @param {String} message - The message to log.
+     * @example util.console.success("The document has been saved.");
+     */
+    info(message: string): void;
+    private colors;
+    private getColorValue;
+    private getBackgroundColorValue;
+    private getBrightnessValue;
+}
+declare const _default: Console;
+export default _default;

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

@@ -0,0 +1,152 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Console = void 0;
+/**
+ * @class console
+ * @memberof util
+ */
+class Console {
+    constructor() {
+        this.colorReset = "\x1b[0m";
+        this.colors = [
+            {
+                key: "black",
+                value: "\x1b[30m",
+                valueBg: "\x1b[40m",
+            },
+            {
+                key: "white",
+                value: "\x1b[37m",
+                valueBg: "\x1b[47m",
+            },
+            {
+                key: "red",
+                value: "\x1b[31m",
+                valueBg: "\x1b[41m",
+            },
+            {
+                key: "green",
+                value: "\x1b[32m",
+                valueBg: "\x1b[42m",
+            },
+            {
+                key: "yellow",
+                value: "\x1b[33m",
+                valueBg: "\x1b[30m\x1b[43m",
+            },
+            {
+                key: "blue",
+                value: "\x1b[34m",
+                valueBg: "\x1b[44m",
+            },
+            {
+                key: "magenta",
+                value: "\x1b[35m",
+                valueBg: "\x1b[45m",
+            },
+            {
+                key: "cyan",
+                value: "\x1b[36m",
+                valueBg: "\x1b[30m\x1b[46m",
+            },
+        ];
+    }
+    /**
+     * @function log
+     * @memberOf util.console
+     * @description Logs a message to the console in the given color.
+     * @param {String} message - The message to log.
+     * @param {String} [textColor] - The color of the text: "black, white", "red", "yellow", "green", "blue", "cyan", "magenta".
+     * @param {String} [backgroundColor] - The color of the background: "black, white", "red", "yellow", "green", "blue", "cyan", "magenta".
+     * @param {String} [brightness] - Adjusts the brightness of the color: "bright", "dim". Leave empty for default.
+     * @example util.console.log("The document has been saved.", "green");
+     */
+    log(message, textColor, backgroundColor, brightness) {
+        let colorValue = "";
+        if (textColor) {
+            const textColorValue = this.getColorValue(textColor);
+            colorValue = textColorValue;
+        }
+        if (backgroundColor) {
+            const backgroundColorValue = this.getBackgroundColorValue(backgroundColor);
+            colorValue = colorValue + backgroundColorValue;
+        }
+        if (brightness) {
+            const brightnessValue = this.getBrightnessValue(brightness);
+            colorValue = colorValue + brightnessValue;
+        }
+        console.log(colorValue, message + this.colorReset);
+    }
+    /**
+     * @function error
+     * @memberOf util.console
+     * @description Logs a error message to the console in red.
+     * @param {String} message - The message to log.
+     * @example util.console.error("Error: Please investigate.");
+     */
+    error(message) {
+        const colorValue = this.getColorValue("red");
+        console.error(colorValue, message + this.colorReset);
+    }
+    /**
+     * @function warn
+     * @memberOf util.console
+     * @description Logs a warning message to the console in yellow.
+     * @param {String} message - The message to log.
+     * @example util.console.warn("Optional step not executed.");
+     */
+    warn(message) {
+        const colorValue = this.getColorValue("yellow");
+        console.warn(colorValue, message + this.colorReset);
+    }
+    /**
+     * @function success
+     * @memberOf util.console
+     * @description Logs a success message to the console in green.
+     * @param {String} message - The message to log.
+     * @example util.console.success("The document has been saved.");
+     */
+    success(message) {
+        const colorValue = this.getColorValue("green");
+        console.log(colorValue, message + this.colorReset);
+    }
+    /**
+     * @function info
+     * @memberOf util.console
+     * @description Logs a info message to the console in cyan.
+     * @param {String} message - The message to log.
+     * @example util.console.success("The document has been saved.");
+     */
+    info(message) {
+        const colorValue = this.getColorValue("cyan");
+        console.log(colorValue, message + this.colorReset);
+    }
+    // =================================== HELPER ===================================
+    getColorValue(key) {
+        const object = this.colors.find((obj) => obj.key === key);
+        if (object === undefined) {
+            return "";
+        }
+        return object.value;
+    }
+    getBackgroundColorValue(key) {
+        const object = this.colors.find((obj) => obj.key === key);
+        if (object === undefined) {
+            return "";
+        }
+        return object.valueBg;
+    }
+    getBrightnessValue(key) {
+        switch (key) {
+            case "bright":
+                return "\x1b[1m";
+            case "dim":
+                return "\x1b[2m";
+            default:
+                return "";
+        }
+    }
+}
+exports.Console = Console;
+exports.default = new Console();
+//# sourceMappingURL=console.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"console.js","sourceRoot":"","sources":["../../../../src/reuse/modules/util/console.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;AACb;;;GAGG;AACH,MAAa,OAAO;IAApB;QACU,eAAU,GAAG,SAAS,CAAC;QA8EvB,WAAM,GAAG;YACf;gBACE,GAAG,EAAE,OAAO;gBACZ,KAAK,EAAE,UAAU;gBACjB,OAAO,EAAE,UAAU;aACpB;YACD;gBACE,GAAG,EAAE,OAAO;gBACZ,KAAK,EAAE,UAAU;gBACjB,OAAO,EAAE,UAAU;aACpB;YACD;gBACE,GAAG,EAAE,KAAK;gBACV,KAAK,EAAE,UAAU;gBACjB,OAAO,EAAE,UAAU;aACpB;YACD;gBACE,GAAG,EAAE,OAAO;gBACZ,KAAK,EAAE,UAAU;gBACjB,OAAO,EAAE,UAAU;aACpB;YACD;gBACE,GAAG,EAAE,QAAQ;gBACb,KAAK,EAAE,UAAU;gBACjB,OAAO,EAAE,kBAAkB;aAC5B;YACD;gBACE,GAAG,EAAE,MAAM;gBACX,KAAK,EAAE,UAAU;gBACjB,OAAO,EAAE,UAAU;aACpB;YACD;gBACE,GAAG,EAAE,SAAS;gBACd,KAAK,EAAE,UAAU;gBACjB,OAAO,EAAE,UAAU;aACpB;YACD;gBACE,GAAG,EAAE,MAAM;gBACX,KAAK,EAAE,UAAU;gBACjB,OAAO,EAAE,kBAAkB;aAC5B;SACF,CAAC;IA6BJ,CAAC;IAnJC;;;;;;;;;OASG;IACH,GAAG,CAAC,OAAe,EAAE,SAAkB,EAAE,eAAwB,EAAE,UAAmB;QACpF,IAAI,UAAU,GAAG,EAAE,CAAC;QAEpB,IAAI,SAAS,EAAE;YACb,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;YACrD,UAAU,GAAG,cAAc,CAAC;SAC7B;QACD,IAAI,eAAe,EAAE;YACnB,MAAM,oBAAoB,GAAG,IAAI,CAAC,uBAAuB,CAAC,eAAe,CAAC,CAAC;YAC3E,UAAU,GAAG,UAAU,GAAG,oBAAoB,CAAC;SAChD;QACD,IAAI,UAAU,EAAE;YACd,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;YAC5D,UAAU,GAAG,UAAU,GAAG,eAAe,CAAC;SAC3C;QAED,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAe;QACnB,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC7C,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CAAC,OAAe;QAClB,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAChD,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,OAAe;QACrB,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC/C,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CAAC,OAAe;QAClB,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC9C,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;IACrD,CAAC;IA6CD,iFAAiF;IACzE,aAAa,CAAC,GAAW;QAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;QAC1D,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,OAAO,EAAE,CAAC;SACX;QACD,OAAO,MAAM,CAAC,KAAK,CAAC;IACtB,CAAC;IAEO,uBAAuB,CAAC,GAAW;QACzC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;QAC1D,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,OAAO,EAAE,CAAC;SACX;QACD,OAAO,MAAM,CAAC,OAAO,CAAC;IACxB,CAAC;IAEO,kBAAkB,CAAC,GAAW;QACpC,QAAQ,GAAG,EAAE;YACX,KAAK,QAAQ;gBACX,OAAO,SAAS,CAAC;YACnB,KAAK,KAAK;gBACR,OAAO,SAAS,CAAC;YACnB;gBACE,OAAO,EAAE,CAAC;SACb;IACH,CAAC;CACF;AArJD,0BAqJC;AACD,kBAAe,IAAI,OAAO,EAAE,CAAC"}

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

@@ -0,0 +1,11 @@
+export declare enum DateFormats {
+    MONTH_DAY_YEAR_SLASH = "mm/dd/yyyy",
+    DAY_MONTH_YEAR_DOT = "dd.mm.yyyy",
+    DAY_MONTH_YEAR_SLASH = "dd/mm/yyyy",
+    YEAR_MONTH_DAY_PLAIN = "yyyymmdd",
+    YEAR_MONTH_DAY_SLASH = "yyyy/mm/dd",
+    DAY_MONTH_YEAR_TIME_DOT = "dd.mm.yyyy.hh.mm",
+    MONTH_DAY_YEAR_COMMA = "mmm dd, yyyy",
+    DATETIME = "datetime",
+    OBJECT = "object"
+}

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DateFormats = void 0;
+var DateFormats;
+(function (DateFormats) {
+    DateFormats["MONTH_DAY_YEAR_SLASH"] = "mm/dd/yyyy";
+    DateFormats["DAY_MONTH_YEAR_DOT"] = "dd.mm.yyyy";
+    DateFormats["DAY_MONTH_YEAR_SLASH"] = "dd/mm/yyyy";
+    DateFormats["YEAR_MONTH_DAY_PLAIN"] = "yyyymmdd";
+    DateFormats["YEAR_MONTH_DAY_SLASH"] = "yyyy/mm/dd";
+    DateFormats["DAY_MONTH_YEAR_TIME_DOT"] = "dd.mm.yyyy.hh.mm";
+    DateFormats["MONTH_DAY_YEAR_COMMA"] = "mmm dd, yyyy";
+    DateFormats["DATETIME"] = "datetime";
+    DateFormats["OBJECT"] = "object";
+})(DateFormats = exports.DateFormats || (exports.DateFormats = {}));
+//# sourceMappingURL=formatter.constants.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"formatter.constants.js","sourceRoot":"","sources":["../../../../../src/reuse/modules/util/constants/formatter.constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,WAUX;AAVD,WAAY,WAAW;IACrB,kDAAmC,CAAA;IACnC,gDAAiC,CAAA;IACjC,kDAAmC,CAAA;IACnC,gDAAiC,CAAA;IACjC,kDAAmC,CAAA;IACnC,2DAA4C,CAAA;IAC5C,oDAAqC,CAAA;IACrC,oCAAqB,CAAA;IACrB,gCAAiB,CAAA;AACnB,CAAC,EAVW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAUtB"}

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

@@ -0,0 +1,36 @@
+/**
+ * @class data
+ * @memberof util
+ */
+export declare class Data {
+    /**
+     * @function getData
+     * @memberOf util.data
+     * @description Returns the data object with the given filename (JSON, stored in data folder).
+     * @param {String} filename - The name of the data file.
+     * @returns {String} The data object.
+     * @example const data = util.data.getData("myTest");
+     */
+    getData(filename: string): string;
+    /**
+     * @function getSecureData
+     * @memberOf util.data
+     * @description Returns and encrypts the data object with the given filename (JSON, stored in data folder). Will return the local file object if private key is not accessible.
+     * @param {String} filename - The name of the data file (without suffix '.secure' or '.local').
+     * @returns {String} The encrypted or local data object.
+     * @example const secureData = util.data.getSecureData("myTest");
+     */
+    getSecureData(filename: string): string;
+    /**
+     * @function decrypt
+     * @memberOf util.data
+     * @description Decrypts the passed input data.
+     * @param {String} data - The encrypted data to decrypt.
+     * @returns {String} The decrypted data.
+     * @example const decrypted = util.data.decrypt("d704004c262faa8ef4bdcf34c8a94883e15524872c7bef334d26a391a1934cf47338b749d99426980ee4cc7a81deaef21439c6894ab0324cdb29b9b6332635baca442651c5d37847f52bb90b8868e037271a7d456024b39b65fdf4dc62e8d82a3d5683a72e4324c59d339742fc79749f0ee74abef916d38e306218adc48e3547a2b346962249320c962d22cb46d9998de36d8219a2496c0997d0fc389f76fb1431a9b57c317886e9c9795c0a09ad98d9fa0b7687d10814dc7973397f3f72a227a04ead4c3d1d428c096a51922ffc4d7afc3952df1c130def5c5fb3e834605cbf1454885966cc65c77046343f4c678e74931fb2dd6cac8dae17837cf674f288d6550dd7fa6b01f5b7ea68aa6bd27d79dd5d53edb5fd4b4edce824bd31b3939352ad7a71a16bab8c54025c2bb92c54e022fcd23ff08bc54a17fc50d00dc3b884cadbfdefe1e75901fdf80e7324ad02a891f2c4863fa120ca238520b79126c65a03");
+     */
+    decrypt(data: string): string;
+    private _decryptRecursively;
+}
+declare const _default: Data;
+export default _default;

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

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Data = void 0;
+/**
+ * @class data
+ * @memberof util
+ */
+class Data {
+    /**
+     * @function getData
+     * @memberOf util.data
+     * @description Returns the data object with the given filename (JSON, stored in data folder).
+     * @param {String} filename - The name of the data file.
+     * @returns {String} The data object.
+     * @example const data = util.data.getData("myTest");
+     */
+    getData(filename) {
+        if (browser.config.params && browser.config.params.import && browser.config.params.import.data) {
+            if (browser.config.params.import.data[filename]) {
+                return browser.config.params.import.data[filename];
+            }
+            else {
+                throw new Error(`Function 'getData' failed. No file with name ${filename} found'`);
+            }
+        }
+        else {
+            throw new Error(`Function 'getData' failed. No data path defined in config.`);
+        }
+    }
+    /**
+     * @function getSecureData
+     * @memberOf util.data
+     * @description Returns and encrypts the data object with the given filename (JSON, stored in data folder). Will return the local file object if private key is not accessible.
+     * @param {String} filename - The name of the data file (without suffix '.secure' or '.local').
+     * @returns {String} The encrypted or local data object.
+     * @example const secureData = util.data.getSecureData("myTest");
+     */
+    getSecureData(filename) {
+        const privateKeyFound = global.util.data.privateKeyFound === true;
+        if (privateKeyFound) {
+            filename = `${filename}.secure`;
+        }
+        else {
+            filename = `${filename}.local`;
+        }
+        if (browser.config.params && browser.config.params.import && browser.config.params.import.data) {
+            if (browser.config.params.import.data[filename]) {
+                const data = browser.config.params.import.data[filename];
+                if (privateKeyFound) {
+                    this._decryptRecursively(data);
+                }
+                return data;
+            }
+            else {
+                throw new Error(`Function 'getSecureData' failed. File '${filename}.json' not found'`);
+            }
+        }
+        else {
+            throw new Error(`Function 'getSecureData' failed. No data path defined in config.`);
+        }
+    }
+    /**
+     * @function decrypt
+     * @memberOf util.data
+     * @description Decrypts the passed input data.
+     * @param {String} data - The encrypted data to decrypt.
+     * @returns {String} The decrypted data.
+     * @example const decrypted = util.data.decrypt("d704004c262faa8ef4bdcf34c8a94883e15524872c7bef334d26a391a1934cf47338b749d99426980ee4cc7a81deaef21439c6894ab0324cdb29b9b6332635baca442651c5d37847f52bb90b8868e037271a7d456024b39b65fdf4dc62e8d82a3d5683a72e4324c59d339742fc79749f0ee74abef916d38e306218adc48e3547a2b346962249320c962d22cb46d9998de36d8219a2496c0997d0fc389f76fb1431a9b57c317886e9c9795c0a09ad98d9fa0b7687d10814dc7973397f3f72a227a04ead4c3d1d428c096a51922ffc4d7afc3952df1c130def5c5fb3e834605cbf1454885966cc65c77046343f4c678e74931fb2dd6cac8dae17837cf674f288d6550dd7fa6b01f5b7ea68aa6bd27d79dd5d53edb5fd4b4edce824bd31b3939352ad7a71a16bab8c54025c2bb92c54e022fcd23ff08bc54a17fc50d00dc3b884cadbfdefe1e75901fdf80e7324ad02a891f2c4863fa120ca238520b79126c65a03");
+     */
+    decrypt(data) {
+        return global.util.data.decrypt(data); // Function is defined under: scripts\hooks\utils\decryption.js
+    }
+    _decryptRecursively(data) {
+        for (const key in data) {
+            if (typeof data[key] === "object") {
+                data[key] = this._decryptRecursively(data[key]);
+            }
+            else if (typeof data[key] === "string") {
+                data[key] = global.util.data.decrypt(data[key]);
+            }
+        }
+        return data;
+    }
+}
+exports.Data = Data;
+exports.default = new Data();
+//# sourceMappingURL=data.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"data.js","sourceRoot":"","sources":["../../../../src/reuse/modules/util/data.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;AACb;;;GAGG;AACH,MAAa,IAAI;IAEf;;;;;;;OAOG;IACH,OAAO,CAAC,QAAgB;QACtB,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;YAC9F,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;gBAC/C,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aACpD;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,gDAAgD,QAAQ,SAAS,CAAC,CAAC;aACpF;SACF;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;SAC/E;IACH,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CAAC,QAAgB;QAC5B,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,KAAK,IAAI,CAAC;QAElE,IAAI,eAAe,EAAE;YACnB,QAAQ,GAAG,GAAG,QAAQ,SAAS,CAAC;SACjC;aAAM;YACL,QAAQ,GAAG,GAAG,QAAQ,QAAQ,CAAC;SAChC;QAED,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;YAC9F,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;gBAC/C,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAEzD,IAAI,eAAe,EAAE;oBACnB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;iBAChC;gBAED,OAAO,IAAI,CAAC;aACb;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,0CAA0C,QAAQ,mBAAmB,CAAC,CAAC;aACxF;SACF;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;SACrF;IACH,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,IAAY;QAClB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,+DAA+D;IACxG,CAAC;IAEO,mBAAmB,CAAC,IAAS;QACnC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,IAAI,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE;gBACjC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;aACjD;iBAAM,IAAI,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE;gBACxC,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;aACjD;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA9ED,oBA8EC;AACD,kBAAe,IAAI,IAAI,EAAE,CAAC"}

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

@@ -0,0 +1,55 @@
+/// <reference types="node" />
+/**
+ * @class file
+ * @memberof util
+ */
+export declare class File {
+    path: any;
+    pdf: any;
+    /**
+     * @function upload
+     * @memberOf util.file
+     * @description Uploads all the file/s by the paths given in the Array.
+     * @param {String[]} files - Array with path/s of file/s to be uploaded.
+     * @param {String} [selector="input[type='file']"] - Custom selector of uploader control (in case there are more then one present).
+     * @example await util.file.upload(["path/to/text1.txt", "path/to/text2.txt"]); // uses the default uploader control
+     * @example await util.file.upload(["path/to/text1.txt", "path/to/text2.txt"], "input[id='myUpload']"); // upload to file uploader with matching selector
+     */
+    upload(files: Array<string>, selector?: string): Promise<void>;
+    /**
+     * @function parsePdf
+     * @memberOf util.file
+     * @description Parses the text from PDF stream. Returned text can be asserted to verify the PDF document content.
+     * @param {Buffer} pdfStream - PDF stream to be downloaded.
+     * @param {Function} renderingMethod - Function to customize the parsing process.
+     * @returns {String} The parsed PDF text.
+     * @see <a href="TODO">Parse PDF</a>
+     * @example await util.file.parsePdf(pdfStream, customRenderingMethod);
+     */
+    parsePdf(pdfStream: Buffer, renderingMethod?: Function): Promise<String>;
+    /**
+     * @function expectPdfContainsText
+     * @memberOf util.file
+     * @description Parses the PDF and checks for given text to be contained in PDF.
+     * @param {Buffer} pdfStream - PDF stream to be downloaded.
+     * @param {String} text - The expected text.
+     * @param {Function} renderingMethod - Function to customize the parsing process.
+     * @see <a href="TODO">Parse pdf</a>
+     * @example await util.file.expectPdfContainsText(pdfStream, "abc");
+     */
+    expectPdfContainsText(pdfStream: Buffer, text: string, renderingMethod?: Function): Promise<any>;
+    /**
+     * @function expectPdfNotContainsText
+     * @memberOf util.file
+     * @description Parses the PDF and checks for given text not to be contained in PDF.
+     * @param {Buffer} pdfStream - PDF stream to be downloaded
+     * @param {String} text - The text expected to be not contained in the PDF.
+     * @param {Function} renderingMethod - Function to customize the parsing process.
+     * @see <a href="TODO">Parse pdf</a>
+     * @example await util.file.expectPdfNotContainsText(pdfStream, "abc");
+     */
+    expectPdfNotContainsText(pdfStream: Buffer, text: string, renderingMethod?: Function): Promise<boolean>;
+    private _renderPage;
+}
+declare const _default: File;
+export default _default;

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

@@ -0,0 +1,159 @@
+"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.File = void 0;
+/**
+ * @class file
+ * @memberof util
+ */
+class File {
+    constructor() {
+        this.path = require("path");
+        this.pdf = require("pdf-parse");
+    }
+    // =================================== UPLOAD ===================================
+    /**
+     * @function upload
+     * @memberOf util.file
+     * @description Uploads all the file/s by the paths given in the Array.
+     * @param {String[]} files - Array with path/s of file/s to be uploaded.
+     * @param {String} [selector="input[type='file']"] - Custom selector of uploader control (in case there are more then one present).
+     * @example await util.file.upload(["path/to/text1.txt", "path/to/text2.txt"]); // uses the default uploader control
+     * @example await util.file.upload(["path/to/text1.txt", "path/to/text2.txt"], "input[id='myUpload']"); // upload to file uploader with matching selector
+     */
+    upload(files, selector = "input[type = 'file']") {
+        return __awaiter(this, void 0, void 0, function* () {
+            let elem;
+            try {
+                if (typeof selector === "string") {
+                    elem = yield $(selector);
+                    const isDisplayed = yield elem.isDisplayed();
+                    if (!isDisplayed) {
+                        yield browser.execute(function (selector) {
+                            // @ts-ignore
+                            document.querySelector(selector).style.visibility = "visible";
+                        }, selector);
+                        yield elem.waitForDisplayed();
+                    }
+                }
+                else if (typeof selector === "object") {
+                    const elemId = yield ui5.element.getId(selector);
+                    elem = yield nonUi5.element.getByXPath(`.//input[contains(@id,'${elemId}')][@type='file']`);
+                }
+                for (const file of files) {
+                    const filePath = this.path.resolve(file);
+                    const remoteFilePath = yield browser.uploadFile(filePath);
+                    yield elem.setValue(remoteFilePath);
+                }
+            }
+            catch (error) {
+                throw new Error(`Function 'upload' failed': ${error}`);
+            }
+        });
+    }
+    ;
+    // =================================== PDF ===================================
+    /**
+     * @function parsePdf
+     * @memberOf util.file
+     * @description Parses the text from PDF stream. Returned text can be asserted to verify the PDF document content.
+     * @param {Buffer} pdfStream - PDF stream to be downloaded.
+     * @param {Function} renderingMethod - Function to customize the parsing process.
+     * @returns {String} The parsed PDF text.
+     * @see <a href="TODO">Parse PDF</a>
+     * @example await util.file.parsePdf(pdfStream, customRenderingMethod);
+     */
+    parsePdf(pdfStream, renderingMethod = this._renderPage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (typeof renderingMethod !== "function") {
+                throw new Error("Function 'parsePdf' failed: Please provide a custom rendering method as second parameter.");
+            }
+            const options = {
+                pagerender: renderingMethod,
+            };
+            // @ts-ignore
+            const data = yield this.pdf(pdfStream, options);
+            return data.text;
+        });
+    }
+    /**
+     * @function expectPdfContainsText
+     * @memberOf util.file
+     * @description Parses the PDF and checks for given text to be contained in PDF.
+     * @param {Buffer} pdfStream - PDF stream to be downloaded.
+     * @param {String} text - The expected text.
+     * @param {Function} renderingMethod - Function to customize the parsing process.
+     * @see <a href="TODO">Parse pdf</a>
+     * @example await util.file.expectPdfContainsText(pdfStream, "abc");
+     */
+    expectPdfContainsText(pdfStream, text, renderingMethod = this._renderPage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!text) {
+                throw new Error("Function 'expectPdfContainsText' failed: Please provide a text as second parameter.");
+            }
+            const parsedText = yield this.parsePdf(pdfStream, renderingMethod);
+            return expect(parsedText).toContain(text);
+        });
+    }
+    /**
+     * @function expectPdfNotContainsText
+     * @memberOf util.file
+     * @description Parses the PDF and checks for given text not to be contained in PDF.
+     * @param {Buffer} pdfStream - PDF stream to be downloaded
+     * @param {String} text - The text expected to be not contained in the PDF.
+     * @param {Function} renderingMethod - Function to customize the parsing process.
+     * @see <a href="TODO">Parse pdf</a>
+     * @example await util.file.expectPdfNotContainsText(pdfStream, "abc");
+     */
+    expectPdfNotContainsText(pdfStream, text, renderingMethod = this._renderPage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!text) {
+                throw new Error("Function 'expectPdfNotContainsText' failed: Please provide a text as second parameter.");
+            }
+            const parsedText = yield this.parsePdf(pdfStream, renderingMethod);
+            return expect(parsedText).not.toContain(text);
+        });
+    }
+    // =================================== HELPER ===================================
+    _renderPage(pageData) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // should be in scope of render page due to library specific implementation
+            const _parseText = function (textContent) {
+                if (textContent === undefined || textContent === null || !textContent.items || !Array.isArray(textContent.items)) {
+                    return;
+                }
+                let lastY, text = "";
+                for (const item of textContent.items) {
+                    if (Array.isArray(item.transform) && item.transform.length === 6) {
+                        if (lastY == item.transform[5] || !lastY) {
+                            text += " " + item.str;
+                        }
+                        else {
+                            text += "\n" + item.str;
+                        }
+                        lastY = item.transform[5];
+                    }
+                }
+                return text;
+            };
+            const render_options = {
+                // replaces all occurrences of whitespace with standard spaces (0x20). The default value is `false`.
+                normalizeWhitespace: false,
+                // do not attempt to combine same line TextItem's. The default value is `false`.
+                disableCombineTextItems: false,
+            };
+            return pageData.getTextContent(render_options).then(_parseText);
+        });
+    }
+}
+exports.File = File;
+exports.default = new File();
+//# sourceMappingURL=file.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"file.js","sourceRoot":"","sources":["../../../../src/reuse/modules/util/file.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;;;;;;;AACb;;;GAGG;AAEH,MAAa,IAAI;IAAjB;QACE,SAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QACvB,QAAG,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IA6I7B,CAAC;IA3IC,iFAAiF;IACjF;;;;;;;;OAQG;IACG,MAAM,CAAC,KAAoB,EAAE,WAAmB,sBAAsB;;YAC1E,IAAI,IAAI,CAAC;YAET,IAAI;gBACF,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;oBAChC,IAAI,GAAG,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC;oBACzB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;oBAE7C,IAAI,CAAC,WAAW,EAAE;wBAChB,MAAM,OAAO,CAAC,OAAO,CAAC,UAAU,QAAgB;4BAC9C,aAAa;4BACb,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,UAAU,GAAG,SAAS,CAAC;wBAChE,CAAC,EAAE,QAAQ,CAAC,CAAC;wBACb,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;qBAC/B;iBAEF;qBAAM,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;oBACvC,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;oBACjD,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,0BAA0B,MAAM,mBAAmB,CAAC,CAAC;iBAC7F;gBAED,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;oBACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBACzC,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;oBAC1D,MAAM,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;iBACrC;aAEF;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,EAAE,CAAC,CAAC;aACxD;QACH,CAAC;KAAA;IAAA,CAAC;IAEF,8EAA8E;IAC9E;;;;;;;;;OASG;IACG,QAAQ,CAAC,SAAiB,EAAE,kBAA4B,IAAI,CAAC,WAAW;;YAC5E,IAAI,OAAO,eAAe,KAAK,UAAU,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC,2FAA2F,CAAC,CAAC;aAC9G;YAED,MAAM,OAAO,GAAG;gBACd,UAAU,EAAE,eAAe;aAC5B,CAAC;YACF,aAAa;YACb,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,IAAI,CAAC;QACnB,CAAC;KAAA;IAED;;;;;;;;;OASG;IACG,qBAAqB,CAAC,SAAiB,EAAE,IAAY,EAAE,kBAA4B,IAAI,CAAC,WAAW;;YACvG,IAAI,CAAC,IAAI,EAAE;gBACT,MAAM,IAAI,KAAK,CAAC,qFAAqF,CAAC,CAAC;aACxG;YACD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YACnE,OAAO,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;KAAA;IAED;;;;;;;;;OASG;IACG,wBAAwB,CAC5B,SAAiB,EACjB,IAAY,EACZ,kBAA4B,IAAI,CAAC,WAAW;;YAE5C,IAAI,CAAC,IAAI,EAAE;gBACT,MAAM,IAAI,KAAK,CAAC,wFAAwF,CAAC,CAAC;aAC3G;YACD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YACnE,OAAO,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAED,iFAAiF;IACnE,WAAW,CAAC,QAAa;;YAErC,2EAA2E;YAC3E,MAAM,UAAU,GAAG,UAAU,WAAgB;gBAC3C,IAAI,WAAW,KAAK,SAAS,IAAI,WAAW,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;oBAChH,OAAO;iBACR;gBACD,IAAI,KAAK,EACP,IAAI,GAAG,EAAE,CAAC;gBACZ,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,KAAK,EAAE;oBACpC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;wBAChE,IAAI,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE;4BACxC,IAAI,IAAI,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;yBACxB;6BAAM;4BACL,IAAI,IAAI,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC;yBACzB;wBACD,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;qBAC3B;iBACF;gBACD,OAAO,IAAI,CAAC;YACd,CAAC,CAAA;YAED,MAAM,cAAc,GAAG;gBACrB,oGAAoG;gBACpG,mBAAmB,EAAE,KAAK;gBAC1B,gFAAgF;gBAChF,uBAAuB,EAAE,KAAK;aAC/B,CAAC;YACF,OAAO,QAAQ,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAClE,CAAC;KAAA;CAGF;AA/ID,oBA+IC;AACD,kBAAe,IAAI,IAAI,EAAE,CAAC"}