@sap_oss/wdio-qmate-service 2.12.1 → 2.13.0

package/docs/doc.md

@@ -19,6 +19,9 @@
 <dt><a href="#mobile">mobile</a></dt>
 <dd><p>Global namespace for mobile modules.</p>
 </dd>
+<dt><a href="#flp">flp</a></dt>
+<dd><p>Global namespace for Fiori Launchpad (FLP) modules.</p>
+</dd>
 </dl>
 
 <a name="common"></a>
@@ -45,7 +48,7 @@ Global namespace for common modules.
         * [.getNextYear([format])](#common.date.getNextYear) ⇒ <code>String</code>
         * [.getPreviousYear([format])](#common.date.getPreviousYear) ⇒ <code>String</code>
         * [.getSpecific(date, [format])](#common.date.getSpecific) ⇒ <code>String</code>
-        * [.calculate([date], [format])](#common.date.calculate) ⇒ <code>String</code>
+        * [.calculate([date], [format])](#common.date.calculate) ⇒ <code>String</code> \| <code>Date</code>
     * [.navigation](#common.navigation)
         * [.navigateToUrl(url)](#common.navigation.navigateToUrl)
         * [.navigateToUrlAndRetry(url, [retries], [interval])](#common.navigation.navigateToUrlAndRetry)
@@ -192,7 +195,7 @@ await common.assertion.expectUrlToBe("www.sap.com");
     * [.getNextYear([format])](#common.date.getNextYear) ⇒ <code>String</code>
     * [.getPreviousYear([format])](#common.date.getPreviousYear) ⇒ <code>String</code>
     * [.getSpecific(date, [format])](#common.date.getSpecific) ⇒ <code>String</code>
-    * [.calculate([date], [format])](#common.date.calculate) ⇒ <code>String</code>
+    * [.calculate([date], [format])](#common.date.calculate) ⇒ <code>String</code> \| <code>Date</code>
 
 <a name="common.date.getToday"></a>
 
@@ -309,11 +312,11 @@ const date = await common.date.getSpecific("2020, 0, 17", "mm/dd/yyyy");
 ```
 <a name="common.date.calculate"></a>
 
-#### date.calculate([date], [format]) ⇒ <code>String</code>
+#### date.calculate([date], [format]) ⇒ <code>String</code> \| <code>Date</code>
 Calculates the date based on the input parameter and returns it in the given format.
 
 **Kind**: static method of [<code>date</code>](#common.date)  
-**Returns**: <code>String</code> - The calculated date in the given format.  
+**Returns**: <code>String</code> \| <code>Date</code> - The calculated date in the given format.  
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
@@ -619,6 +622,7 @@ Global namespace for util modules.
         * [.executeOptional(fct, args)](#util.function.executeOptional)
     * [.system](#util.system)
         * [.getOS()](#util.system.getOS) ⇒ <code>String</code>
+    * [.userSettings](#util.userSettings)
 
 <a name="util.browser"></a>
 
@@ -1676,6 +1680,10 @@ Returns the current operating system.
 ```js
 const os = await util.system.getOS();
 ```
+<a name="util.userSettings"></a>
+
+### util.userSettings
+**Kind**: static class of [<code>util</code>](#util)  
 <a name="ui5"></a>
 
 ## ui5
@@ -5776,7 +5784,7 @@ Global namespace for mobile modules.
         * [.pressKeyByName(keyName)](#mobile.android.pressKeyByName)
         * [.pressKeyByCode(keyCode)](#mobile.android.pressKeyByCode)
     * [.device](#mobile.device)
-        * [.isAppInstalled(packageIdorBundleId)](#mobile.device.isAppInstalled) ⇒ <code>boolean</code>
+        * [.isAppInstalled(packageIdOrBundleId)](#mobile.device.isAppInstalled) ⇒ <code>boolean</code>
         * [.installApp(appPath)](#mobile.device.installApp)
     * [.element](#mobile.element)
         * [.isVisible(element, [strict])](#mobile.element.isVisible) ⇒ <code>Boolean</code>
@@ -5786,7 +5794,7 @@ Global namespace for mobile modules.
         * [.waitToBeClickable(selector, [timeout])](#mobile.element.waitToBeClickable)
         * [.isSelected(elem)](#mobile.element.isSelected) ⇒ <code>boolean</code>
     * [.gestures](#mobile.gestures)
-        * [.waitToBeClickable(startX, startY, endX, endY, duration)](#mobile.gestures.waitToBeClickable) ⇒ <code>Promise.&lt;void&gt;</code>
+        * [.swipe(startX, startY, endX, endY, duration)](#mobile.gestures.swipe) ⇒ <code>Promise.&lt;void&gt;</code>
     * [.ios](#mobile.ios)
     * [.userInteraction](#mobile.userInteraction)
         * [.tap(element, [timeout])](#mobile.userInteraction.tap)
@@ -5820,76 +5828,13 @@ await mobile.device.pressKeyByName("back");
 ```js
 await mobile.device.pressKeyByName("home");
 ```
-**Example**  
-```js
-await mobile.device.pressKeyByName("volumeUp");
-```
-**Example**  
-```js
-await mobile.device.pressKeyByName("volumeDown");
-```
-**Example**  
-```js
-await mobile.device.pressKeyByName("volumeMute");
-```
-**Example**  
-```js
-await mobile.device.pressKeyByName("power");
-```
-**Example**  
-```js
-await mobile.device.pressKeyByName("enter");
-```
-**Example**  
-```js
-await mobile.device.pressKeyByName("space");
-```
-**Example**  
-```js
-await mobile.device.pressKeyByName("delete");
-```
-**Example**  
-```js
-await mobile.device.pressKeyByName("menu");
-```
-**Example**  
-```js
-await mobile.device.pressKeyByName("search");
-```
-**Example**  
-```js
-await mobile.device.pressKeyByName("camera");
-```
-**Example**  
-```js
-await mobile.device.pressKeyByName("focus");
-```
-**Example**  
-```js
-await mobile.device.pressKeyByName("notification");
-```
-**Example**  
-```js
-await mobile.device.pressKeyByName("call");
-```
-**Example**  
-```js
-await mobile.device.pressKeyByName("calendar");
-```
-**Example**  
-```js
-await mobile.device.pressKeyByName("recent");
-```
-**Example**  
-```js
-await mobile.device.pressKeyByName("settings");
-```
 <a name="mobile.android.pressKeyByCode"></a>
 
 #### android.pressKeyByCode(keyCode)
 Simulate pressing a hardware key on the android device (e.g., back button, home button, etc.),
 
 **Kind**: static method of [<code>android</code>](#mobile.android)  
+**See**: https://developer.android.com/reference/android/view/KeyEvent  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -5905,12 +5850,12 @@ await mobile.android.pressKeyByCode(4);
 **Kind**: static class of [<code>mobile</code>](#mobile)  
 
 * [.device](#mobile.device)
-    * [.isAppInstalled(packageIdorBundleId)](#mobile.device.isAppInstalled) ⇒ <code>boolean</code>
+    * [.isAppInstalled(packageIdOrBundleId)](#mobile.device.isAppInstalled) ⇒ <code>boolean</code>
     * [.installApp(appPath)](#mobile.device.installApp)
 
 <a name="mobile.device.isAppInstalled"></a>
 
-#### device.isAppInstalled(packageIdorBundleId) ⇒ <code>boolean</code>
+#### device.isAppInstalled(packageIdOrBundleId) ⇒ <code>boolean</code>
 Check wether given package/bundle app is installed or not in the device.
 
 **Kind**: static method of [<code>device</code>](#mobile.device)  
@@ -5918,7 +5863,7 @@ Check wether given package/bundle app is installed or not in the device.
 
 | Param | Type | Description |
 | --- | --- | --- |
-| packageIdorBundleId | <code>string</code> | Android package Id, or iOS bundle Id. |
+| packageIdOrBundleId | <code>string</code> | Android package Id, or iOS bundle Id. |
 
 **Example**  
 ```js
@@ -6079,9 +6024,9 @@ const isSelected = await mobile.element.isSelected(elem);
 
 ### mobile.gestures
 **Kind**: static class of [<code>mobile</code>](#mobile)  
-<a name="mobile.gestures.waitToBeClickable"></a>
+<a name="mobile.gestures.swipe"></a>
 
-#### gestures.waitToBeClickable(startX, startY, endX, endY, duration) ⇒ <code>Promise.&lt;void&gt;</code>
+#### gestures.swipe(startX, startY, endX, endY, duration) ⇒ <code>Promise.&lt;void&gt;</code>
 Swipe from one point to another on the screen.
 
 **Kind**: static method of [<code>gestures</code>](#mobile.gestures)  
@@ -6138,3 +6083,143 @@ Checks the given checkbox.
 ```js
 await mobile.userInteraction.check(selector);
 ```
+<a name="flp"></a>
+
+## flp
+Global namespace for Fiori Launchpad (FLP) modules.
+
+**Kind**: global constant  
+
+* [flp](#flp)
+    * [.userLocks](#flp.userLocks)
+        * [.getNumberOfLockEntries(user, password, [technicalUserId])](#flp.userLocks.getNumberOfLockEntries) ⇒ <code>Promise.&lt;Number&gt;</code>
+        * [.deleteExistingLockEntries(user, password, [technicalUserId])](#flp.userLocks.deleteExistingLockEntries)
+    * [.userSettings](#flp.userSettings)
+        * [.setLanguageFromUserSettings(user, password)](#flp.userSettings.setLanguageFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
+        * [.setDateFormatFromUserSettings(user, password)](#flp.userSettings.setDateFormatFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
+        * [.setDateFormatFromUserSettings(user, password)](#flp.userSettings.setDateFormatFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
+        * [.setTimeZoneFromUserSettings(user, password)](#flp.userSettings.setTimeZoneFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
+
+<a name="flp.userLocks"></a>
+
+### flp.userLocks
+**Kind**: static class of [<code>flp</code>](#flp)  
+
+* [.userLocks](#flp.userLocks)
+    * [.getNumberOfLockEntries(user, password, [technicalUserId])](#flp.userLocks.getNumberOfLockEntries) ⇒ <code>Promise.&lt;Number&gt;</code>
+    * [.deleteExistingLockEntries(user, password, [technicalUserId])](#flp.userLocks.deleteExistingLockEntries)
+
+<a name="flp.userLocks.getNumberOfLockEntries"></a>
+
+#### userLocks.getNumberOfLockEntries(user, password, [technicalUserId]) ⇒ <code>Promise.&lt;Number&gt;</code>
+Gets the number of lock entries for the given user.
+
+**Kind**: static method of [<code>userLocks</code>](#flp.userLocks)  
+**Returns**: <code>Promise.&lt;Number&gt;</code> - The number of lock entries.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| user | <code>String</code> | The user name. |
+| password | <code>String</code> | The password. |
+| [technicalUserId] | <code>String</code> | The technical user ID. |
+
+**Example**  
+```js
+const lockCount = await flp.userLocks.getNumberOfLockEntries("user", "password");
+```
+<a name="flp.userLocks.deleteExistingLockEntries"></a>
+
+#### userLocks.deleteExistingLockEntries(user, password, [technicalUserId])
+Deletes the existing lock entries for the given user.
+
+**Kind**: static method of [<code>userLocks</code>](#flp.userLocks)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| user | <code>String</code> | The user name. |
+| password | <code>String</code> | The password. |
+| [technicalUserId] | <code>String</code> | The technical user ID. |
+
+**Example**  
+```js
+await flp.userLocks.deleteExistingLockEntries("user", "password");
+```
+<a name="flp.userSettings"></a>
+
+### flp.userSettings
+**Kind**: static class of [<code>flp</code>](#flp)  
+
+* [.userSettings](#flp.userSettings)
+    * [.setLanguageFromUserSettings(user, password)](#flp.userSettings.setLanguageFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
+    * [.setDateFormatFromUserSettings(user, password)](#flp.userSettings.setDateFormatFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
+    * [.setDateFormatFromUserSettings(user, password)](#flp.userSettings.setDateFormatFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
+    * [.setTimeZoneFromUserSettings(user, password)](#flp.userSettings.setTimeZoneFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
+
+<a name="flp.userSettings.setLanguageFromUserSettings"></a>
+
+#### userSettings.setLanguageFromUserSettings(user, password) ⇒ <code>Promise.&lt;void&gt;</code>
+Sets the environment variable 'USER_SETTINGS_LANG_KEY' language from user settings.
+
+**Kind**: static method of [<code>userSettings</code>](#flp.userSettings)  
+**Returns**: <code>Promise.&lt;void&gt;</code> - A promise that resolves when the language has been set.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| user | <code>String</code> | The username for authentication. |
+| password | <code>String</code> | The password for authentication. |
+
+**Example**  
+```js
+await flp.userSettings.setLanguageFromUserSettings("user", "password");
+```
+<a name="flp.userSettings.setDateFormatFromUserSettings"></a>
+
+#### userSettings.setDateFormatFromUserSettings(user, password) ⇒ <code>Promise.&lt;void&gt;</code>
+Sets the environment variable 'USER_SETTINGS_DATE_FORMAT' date format from user settings.
+
+**Kind**: static method of [<code>userSettings</code>](#flp.userSettings)  
+**Returns**: <code>Promise.&lt;void&gt;</code> - A promise that resolves when the date format has been set.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| user | <code>String</code> | The username for authentication. |
+| password | <code>String</code> | The password for authentication. |
+
+**Example**  
+```js
+await flp.userSettings.setDateFormatFromUserSettings("user", "password");
+```
+<a name="flp.userSettings.setDateFormatFromUserSettings"></a>
+
+#### userSettings.setDateFormatFromUserSettings(user, password) ⇒ <code>Promise.&lt;void&gt;</code>
+Sets the environment variable 'USER_SETTINGS_DATE_FORMAT' date format from user settings.
+
+**Kind**: static method of [<code>userSettings</code>](#flp.userSettings)  
+**Returns**: <code>Promise.&lt;void&gt;</code> - A promise that resolves when the date format has been set.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| user | <code>String</code> | The username for authentication. |
+| password | <code>String</code> | The password for authentication. |
+
+**Example**  
+```js
+await flp.userSettings.setDateFormatFromUserSettings("user", "password");
+```
+<a name="flp.userSettings.setTimeZoneFromUserSettings"></a>
+
+#### userSettings.setTimeZoneFromUserSettings(user, password) ⇒ <code>Promise.&lt;void&gt;</code>
+Sets the environment variable 'USER_SETTINGS_TIME_ZONE' time zone from user settings.
+
+**Kind**: static method of [<code>userSettings</code>](#flp.userSettings)  
+**Returns**: <code>Promise.&lt;void&gt;</code> - A promise that resolves when the time zone has been set.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| user | <code>String</code> | The username for authentication. |
+| password | <code>String</code> | The password for authentication. |
+
+**Example**  
+```js
+await flp.userSettings.setTimeZoneFromUserSettings("user", "password");
+```

package/lib/index.js

@@ -24,6 +24,7 @@ module.exports = class CustomWorkerService {
      */
     // @ts-ignore
     constructor(serviceOptions, capabilities, config) {
+        this._statsUsageId = null;
         this.config = config;
     }
     /**
@@ -42,7 +43,9 @@ module.exports = class CustomWorkerService {
       `;
         console.log(logo);
         try {
-            await (0, onPrepare_1.default)(config, capabilities);
+            await (0, onPrepare_1.default)(config, capabilities, (statsUsageId) => {
+                this._statsUsageId = statsUsageId;
+            });
         }
         catch (e) {
             console.error(`onPrepare hook failed: ${e}`);
@@ -147,7 +150,7 @@ module.exports = class CustomWorkerService {
      */
     async onComplete(exitCode, config, capabilities, results) {
         try {
-            await (0, onComplete_1.default)(exitCode, config, capabilities, results);
+            await (0, onComplete_1.default)(exitCode, config, capabilities, results, this._statsUsageId);
         }
         catch (e) {
             util.console.error(`onComplete hook failed: ${e}`);

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,YAAY,CAAC;;;;;AAEb,kFAA+D;AAC/D,oEAAiD;AACjD,0EAAsD;AACtD,4EAAwD;AACxD,kEAA8C;AAC9C,6EAA0E;AAC1E,MAAM,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAEtC,MAAM,CAAC,OAAO,GAAG,MAAM,mBAAmB;IAExC;;;;;;;;;OASG;IACH,aAAa;IACb,YAAY,cAAc,EAAE,YAAY,EAAE,MAAM;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,aAAa;IACb,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,YAAY;QAClC,MAAM,IAAI,GAAG;;;;;4BAKW,EAAE,CAAC,OAAO;OAC/B,CAAC;QACJ,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClB,IAAI,CAAC;YACH,MAAM,IAAA,mBAAa,EAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAC5C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,0BAA0B,CAAC,EAAE,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,aAAa;IACb,KAAK,CAAC,aAAa,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK;QAC7C,IAAI,CAAC;YACH,IAAI,IAAA,mCAAgB,GAAE,EAAE,CAAC;gBACvB,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;YAC1B,CAAC;YACD,MAAM,IAAA,uBAAkB,EAAC,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;YACtD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACvB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtB,mEAAmE;gBACnE,OAAO,CAAC,KAAK,CAAC,0DAA0D,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC7F,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,iDAAiD,CAAC,EAAE,CAAC,CAAC;YACtE,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,aAAa;IACb,KAAK,CAAC,MAAM,CAAC,YAAY,EAAE,KAAK,EAAE,OAAO;QACvC,8GAA8G;QAC9G,IAAI,CAAC;YACH,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YAC7B,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;YACvC,MAAM,IAAA,gBAAW,EAAC,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAClD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtB,mEAAmE;gBACnE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,mDAAmD,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC3F,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,0CAA0C,CAAC,EAAE,CAAC,CAAC;YACpE,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,KAAU;QAC1B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,SAAS,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,aAAa;IACb,KAAK,CAAC,SAAS,CAAC,IAAS,EAAE,OAAY,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE;QACnF,mCAAmC;QACnC,2CAA2C;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC;QAChD,sDAAsD;QACtD,IAAI,CAAC,KAAK,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YAC9B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,QAAQ,aAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QACzF,CAAC;aAAM,IAAI,KAAK,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACpC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,QAAQ,aAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1F,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAAC,MAAc,EAAE,YAAiB,EAAE,KAAU;QACvD,IAAI,CAAC;YACH,MAAM,IAAA,eAAS,EAAC,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,MAAW,EAAE,YAAiB,EAAE,OAAY;QAC7E,IAAI,CAAC;YACH,MAAM,IAAA,oBAAc,EAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;QAChE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,2BAA2B,CAAC,EAAE,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;CACF,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,YAAY,CAAC;;;;;AAEb,kFAA+D;AAC/D,oEAAiD;AACjD,0EAAsD;AACtD,4EAAwD;AACxD,kEAA8C;AAC9C,6EAA0E;AAC1E,MAAM,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAEtC,MAAM,CAAC,OAAO,GAAG,MAAM,mBAAmB;IAGxC;;;;;;;;;OASG;IACH,aAAa;IACb,YAAY,cAAc,EAAE,YAAY,EAAE,MAAM;QAbxC,kBAAa,GAAkB,IAAI,CAAC;QAc1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,aAAa;IACb,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,YAAY;QAClC,MAAM,IAAI,GAAG;;;;;4BAKW,EAAE,CAAC,OAAO;OAC/B,CAAC;QACJ,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClB,IAAI,CAAC;YACH,MAAM,IAAA,mBAAa,EAAC,MAAM,EAAE,YAAY,EAAE,CAAC,YAAY,EAAE,EAAE;gBACzD,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;YACpC,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,0BAA0B,CAAC,EAAE,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,aAAa;IACb,KAAK,CAAC,aAAa,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK;QAC7C,IAAI,CAAC;YACH,IAAI,IAAA,mCAAgB,GAAE,EAAE,CAAC;gBACvB,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;YAC1B,CAAC;YACD,MAAM,IAAA,uBAAkB,EAAC,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;YACtD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACvB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtB,mEAAmE;gBACnE,OAAO,CAAC,KAAK,CAAC,0DAA0D,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC7F,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,iDAAiD,CAAC,EAAE,CAAC,CAAC;YACtE,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,aAAa;IACb,KAAK,CAAC,MAAM,CAAC,YAAY,EAAE,KAAK,EAAE,OAAO;QACvC,8GAA8G;QAC9G,IAAI,CAAC;YACH,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YAC7B,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;YACvC,MAAM,IAAA,gBAAW,EAAC,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAClD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtB,mEAAmE;gBACnE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,mDAAmD,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC3F,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,0CAA0C,CAAC,EAAE,CAAC,CAAC;YACpE,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,KAAU;QAC1B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,SAAS,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,aAAa;IACb,KAAK,CAAC,SAAS,CAAC,IAAS,EAAE,OAAY,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE;QACnF,mCAAmC;QACnC,2CAA2C;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC;QAChD,sDAAsD;QACtD,IAAI,CAAC,KAAK,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YAC9B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,QAAQ,aAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QACzF,CAAC;aAAM,IAAI,KAAK,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACpC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,QAAQ,aAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1F,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAAC,MAAc,EAAE,YAAiB,EAAE,KAAU;QACvD,IAAI,CAAC;YACH,MAAM,IAAA,eAAS,EAAC,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,MAAW,EAAE,YAAiB,EAAE,OAAY;QAC7E,IAAI,CAAC;YACH,MAAM,IAAA,oBAAc,EAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACpF,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,2BAA2B,CAAC,EAAE,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;CACF,CAAC"}

package/lib/reuse/modules/flp/userLocks.d.ts

@@ -28,13 +28,111 @@ export declare class UserLocks {
      * @example await flp.userLocks.deleteExistingLockEntries("user", "password");
      */
     deleteExistingLockEntries(user: string, password: string, technicalUserId?: string): Promise<void>;
+    /**
+     * @private
+     * @function getLockCount
+     * @memberOf flp.userLocks
+     * @description Gets the number of locks for the user on the same session.
+     * @param {Array} sessions - The sessions.
+     * @returns {Number} The number of locks.
+     * @example const lockCount = flp.userLocks.getLockCount(sessions);
+     */
+    private _getLockCount;
+    /**
+     * @private
+     * @function _getSessionId
+     * @memberOf flp.userLocks
+     * @description Gets the session ID.
+     * @param {Array} sessions - The sessions.
+     * @returns {String} The session ID.
+     * @example const sessionId = flp.userLocks.getSessionId(sessions);
+     */
+    private _getSessionId;
+    /**
+     * @private
+     * @function _initializeService
+     * @memberOf flp.userLocks
+     * @description Initializes the service.
+     * @param {Object} instance - The service instance.
+     * @param {String} serviceName - The service name.
+     * @param {String} user - The user name.
+     * @param {String} [password] - The password.
+     * @returns {Promise<Object>} The service instance.
+     */
     private _initializeService;
+    /**
+     * @private
+     * @function _initializeUserLockService
+     * @memberOf flp.userLocks
+     * @description Initializes the User Lock Service.
+     * @param {String} user - The user name.
+     * @param {String} password - The password.
+     * @returns {Promise<void>}
+     */
     private _initializeUserLockService;
+    /**
+     * @private
+     * @function _initializeSearchService
+     * @memberOf flp.userLocks
+     * @description Initializes the Search Service.
+     * @param {String} user - The user name.
+     * @param {String} password - The password.
+     * @returns {Promise<void>}
+     */
     private _initializeSearchService;
+    /**
+     * @private
+     * @function _initializeRequestOptions
+     * @memberOf flp.userLocks
+     * @description Initializes the request options.
+     * @param {String} client - The client number.
+     * @param {String} userId - The user ID.
+     * @param {String} [sessionId] - The session ID.
+     * @returns {void}
+     */
     private _initializeRequestOptions;
+    /**
+     * @private
+     * @function _getUserInfo
+     * @memberOf flp.userLocks
+     * @description Gets the user info.
+     * @returns {Promise<UserInfo>} The user info.
+     * @throws {Error} If the user info cannot be retrieved.
+     * @example const userInfo = await flp.userLocks.getUserInfo();
+     * @example console.log(userInfo.Id);
+     * @example console.log(userInfo.Name);
+     */
     private _getUserInfo;
+    /**
+     * @private
+     * @function _extractClientFromUrl
+     * @memberOf flp.userLocks
+     * @description Extracts the client number from the URL.
+     * @param {String} url - The URL.
+     * @returns {String} The client number.
+     * @throws {Error} If the client number cannot be found in the URL.
+     * @example const client = flp.userLocks.extractClientFromUrl("https://www-123.example.com");
+     * @example console.log(client);
+     * @example // Output: 123
+     */
     private _extractClientFromUrl;
-    private _getLockEntries;
+    /**
+     * @private
+     * @function _getSession
+     * @memberOf flp.userLocks
+     * @description Gets the session.
+     * @returns {Promise<any>} The session.
+     * @example const session = await flp.userLocks.getSession();
+     */
+    private _getSession;
+    /**
+     * @private
+     * @function _deleteLockEntries
+     * @memberOf flp.userLocks
+     * @description Deletes the lock entries.
+     * @returns {Promise<void>}
+     * @example await flp.userLocks.deleteLockEntries();
+     */
     private _deleteLockEntries;
 }
 declare const _default: UserLocks;

package/lib/reuse/modules/flp/userLocks.js

@@ -15,7 +15,7 @@ class UserLocks {
         this._requestOptions = {
             Client: "",
             UserId: "",
-            SessionId: "*" // Default to all sessions
+            SessionId: ""
         };
     }
     // Public Functions
@@ -44,13 +44,12 @@ class UserLocks {
         // Extract client and prepare request options
         const client = this._extractClientFromUrl(browser.config.params.systemUrl);
         this._initializeRequestOptions(client, resolvedUserId);
-        // Get lock entries
-        const locks = await this._getLockEntries();
-        const lockCount = locks.NumberOfLocks;
-        // Log the result
+        const sessions = await this._getSession();
+        const lockCount = this._getLockCount(sessions);
         if (lockCount > 0) {
             util.console.warn(`User '${resolvedUserName}' with ID '${resolvedUserId}' has ${lockCount} lock/s.`);
-            this._requestOptions.SessionId = locks.SessionId;
+            //if there are locks, set the session ID to the first session, since it is needed for deletion.
+            this._requestOptions.SessionId = this._getSessionId(sessions);
         }
         else {
             util.console.success(`User '${resolvedUserName}' with ID '${resolvedUserId}' has no locks.`);
@@ -73,6 +72,46 @@ class UserLocks {
         }
     }
     // Private Functions
+    /**
+     * @private
+     * @function getLockCount
+     * @memberOf flp.userLocks
+     * @description Gets the number of locks for the user on the same session.
+     * @param {Array} sessions - The sessions.
+     * @returns {Number} The number of locks.
+     * @example const lockCount = flp.userLocks.getLockCount(sessions);
+     */
+    _getLockCount(sessions) {
+        if (sessions.length > 0) {
+            return sessions[0].NumberOfLocks; //Always uses the first session.
+        }
+        else {
+            return 0;
+        }
+    }
+    /**
+     * @private
+     * @function _getSessionId
+     * @memberOf flp.userLocks
+     * @description Gets the session ID.
+     * @param {Array} sessions - The sessions.
+     * @returns {String} The session ID.
+     * @example const sessionId = flp.userLocks.getSessionId(sessions);
+     */
+    _getSessionId(sessions) {
+        return sessions[0].SessionId;
+    }
+    /**
+     * @private
+     * @function _initializeService
+     * @memberOf flp.userLocks
+     * @description Initializes the service.
+     * @param {Object} instance - The service instance.
+     * @param {String} serviceName - The service name.
+     * @param {String} user - The user name.
+     * @param {String} [password] - The password.
+     * @returns {Promise<Object>} The service instance.
+     */
     async _initializeService(instance, serviceName, user, password = "Welcome1!") {
         if (!instance) {
             const params = browser.config.params;
@@ -89,12 +128,40 @@ class UserLocks {
         }
         return instance;
     }
+    /**
+     * @private
+     * @function _initializeUserLockService
+     * @memberOf flp.userLocks
+     * @description Initializes the User Lock Service.
+     * @param {String} user - The user name.
+     * @param {String} password - The password.
+     * @returns {Promise<void>}
+     */
     async _initializeUserLockService(user, password) {
         this._srvUserLockInstance = await this._initializeService(this._srvUserLockInstance, "APS_IAM_MUS_V2UI", user, password);
     }
+    /**
+     * @private
+     * @function _initializeSearchService
+     * @memberOf flp.userLocks
+     * @description Initializes the Search Service.
+     * @param {String} user - The user name.
+     * @param {String} password - The password.
+     * @returns {Promise<void>}
+     */
     async _initializeSearchService(user, password) {
         this._srvEshInstance = await this._initializeService(this._srvEshInstance, "ESH_SEARCH_SRV", user, password);
     }
+    /**
+     * @private
+     * @function _initializeRequestOptions
+     * @memberOf flp.userLocks
+     * @description Initializes the request options.
+     * @param {String} client - The client number.
+     * @param {String} userId - The user ID.
+     * @param {String} [sessionId] - The session ID.
+     * @returns {void}
+     */
     _initializeRequestOptions(client, userId, sessionId = "*") {
         this._requestOptions = {
             Client: client,
@@ -102,6 +169,17 @@ class UserLocks {
             SessionId: sessionId
         };
     }
+    /**
+     * @private
+     * @function _getUserInfo
+     * @memberOf flp.userLocks
+     * @description Gets the user info.
+     * @returns {Promise<UserInfo>} The user info.
+     * @throws {Error} If the user info cannot be retrieved.
+     * @example const userInfo = await flp.userLocks.getUserInfo();
+     * @example console.log(userInfo.Id);
+     * @example console.log(userInfo.Name);
+     */
     async _getUserInfo() {
         try {
             const users = await service.odata.get(this._srvEshInstance, "Users", {});
@@ -112,6 +190,18 @@ class UserLocks {
             throw new Error(`Failed to get user info: ${errorMessage}`);
         }
     }
+    /**
+     * @private
+     * @function _extractClientFromUrl
+     * @memberOf flp.userLocks
+     * @description Extracts the client number from the URL.
+     * @param {String} url - The URL.
+     * @returns {String} The client number.
+     * @throws {Error} If the client number cannot be found in the URL.
+     * @example const client = flp.userLocks.extractClientFromUrl("https://www-123.example.com");
+     * @example console.log(client);
+     * @example // Output: 123
+     */
     _extractClientFromUrl(url) {
         const regex = /https:\/\/\w{3}-(\d{3})\./;
         const match = url.match(regex);
@@ -119,9 +209,25 @@ class UserLocks {
             return match[1];
         throw new Error("Client number not found in the URL");
     }
-    async _getLockEntries() {
-        return service.odata.get(this._srvUserLockInstance, "Session", this._requestOptions);
+    /**
+     * @private
+     * @function _getSession
+     * @memberOf flp.userLocks
+     * @description Gets the session.
+     * @returns {Promise<any>} The session.
+     * @example const session = await flp.userLocks.getSession();
+     */
+    async _getSession() {
+        return service.odata.get(this._srvUserLockInstance, "Session", {});
     }
+    /**
+     * @private
+     * @function _deleteLockEntries
+     * @memberOf flp.userLocks
+     * @description Deletes the lock entries.
+     * @returns {Promise<void>}
+     * @example await flp.userLocks.deleteLockEntries();
+     */
     async _deleteLockEntries() {
         const response = await service.odata.callFunctionImport(this._srvUserLockInstance, "delete_session", this._requestOptions, true);
         const sapMessage = JSON.parse(response.headers.get("sap-message"));