@sapui5/sap.ushell 1.139.0 → 1.141.0

package/src/main/js/sap/ushell/ui/shell/ToolAreaItem.js

@@ -18,7 +18,7 @@ sap.ui.define([
      * A control to be placed in the tool area
      * @extends sap.ui.core.Control
      *
-     * @version 1.139.0
+     * @version 1.141.0
      *
      * @public
      * @since 1.30.5

package/src/main/js/sap/ushell/ui/tile/TileBase.js

@@ -87,15 +87,15 @@ sap.ui.define([
         renderer: TileBaseRenderer
     });
 
-    TileBase.prototype.ontap = function (e) {
+    TileBase.prototype.ontap = function (oEvent) {
         this.firePress({});
     };
 
-    TileBase.prototype.onsapenter = function (e) {
+    TileBase.prototype.onsapenter = function (oEvent) {
         this.firePress({});
     };
 
-    TileBase.prototype.onsapspace = function (e) {
+    TileBase.prototype.onsapspace = function (oEvent) {
         this.firePress({});
     };
 

package/src/main/js/sap/ushell/ui/utils.js

@@ -6,7 +6,7 @@
  * This is a utility module that collects common activities implemented
  * by controllers of different ui components.
  *
- * @version 1.139.0
+ * @version 1.141.0
  * @private
  */
 
@@ -59,7 +59,7 @@ sap.ui.define([
         let failureCount = 0;
         let successCount = 0;
         const promiseArray = [];
-        const failureMsgArr = [];
+        const aFailedMessages = [];
         let currEntryTitle;
         const oAfterSave = {
             refresh: false
@@ -73,10 +73,10 @@ sap.ui.define([
             resultDeferred.notify();
         }
 
-        function onSaveFail (err) {
-            failureMsgArr.push({
+        function onSaveFail (oError) {
+            aFailedMessages.push({
                 entry: currEntryTitle,
-                message: err
+                message: oError
             });
             failureCount++;
             resultDeferred.notify();
@@ -102,7 +102,7 @@ sap.ui.define([
 
         resultDeferred.progress(() => {
             if (failureCount > 0 && (failureCount + successCount === totalPromisesCount)) {
-                resultDeferred.reject(failureMsgArr);
+                resultDeferred.reject(aFailedMessages);
             }
         });
 

package/src/main/js/sap/ushell/ui5service/ShellUIService.js

@@ -879,6 +879,9 @@ sap.ui.define([
 
         /**
          * Sets the application screen size to either full width or letterbox.
+         *
+         * This method sets the application width dynamically. This can cause flickering depending on the current environment.
+         * As an alternative you can set the application width statically using the manifest property <code>sap.ui/fullWidth</code>.
          * @param {boolean} bFullWidth Whether the application should be displayed in full width.
          *
          * @since 1.133.0

package/src/main/js/sap/ushell/ui5service/ShellUIServiceFactory.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The ShellUIService UI5 service factory
  *
- * @version 1.139.0
+ * @version 1.141.0
  */
 sap.ui.define([
     "sap/base/util/Deferred",

package/src/main/js/sap/ushell/ui5service/UserStatus.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The UserStatus UI5 service
  *
- * @version 1.139.0
+ * @version 1.141.0
  * @deprecated since 1.70. Support for this service has been discontinued.
  */
 sap.ui.define([

package/src/main/js/sap/ushell/utils/CallbackQueue.js

@@ -0,0 +1,114 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+sap.ui.define([
+    "sap/base/Log",
+    "sap/base/util/Deferred",
+    "sap/ushell/utils"
+], (
+    Log,
+    Deferred,
+    ushellUtils
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.utils.CallbackQueue
+     * @class
+     * @classdesc A queue for managing promises in a sequential manner.
+     * It ensures that async processes are strictly executed after each other.
+     * This is useful when the effects on the callbacks might interfere with each other.
+     * In case a promise is failed the error handler is called and execution continues.
+     *
+     * @since 1.141.0
+     * @private
+     */
+    class CallbackQueue {
+        #pLastPromise = Promise.resolve();
+        #iIndex = 1;
+
+        /**
+         * Adds a callback on top of the queue.
+         * @param {function ():Promise} fnCallback
+         * A callback which is called when all previous callbacks in the queue have settled.
+         * @param {function ():Promise} fnErrorCallback
+         * A callback function to handle errors. It is called in case the main callback fails
+         * @returns {Promise}
+         * Resolves when this step is done with the result of fnCallback.
+         * If fnCallback failed it rejects with the error.
+         *
+         * Unless fnErrorCallback is provided.
+         * Then it resolves or rejects with the result or error of the fnErrorCallback.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        async push (fnCallback, fnErrorCallback) {
+            // Save current state of promise chain
+            const pLastPromise = this.#pLastPromise;
+
+            // Create Deferred for async resolve
+            const oNextPromiseDeferred = new Deferred();
+
+            // Update promise with deferred
+            this.#pLastPromise = pLastPromise.then(() => oNextPromiseDeferred.promise);
+            this.#pLastPromise.index = this.#iIndex++; // add index for easier debugging
+
+            // Await current state of promise chain
+            await pLastPromise;
+
+            let bFailed = false;
+            let vResult;
+            try {
+                // Now execute target callback
+                vResult = await ushellUtils.promisify(fnCallback());
+            } catch (oError) {
+                Log.error("Error occurred in CallbackQueue:", oError);
+
+                bFailed = true;
+                vResult = oError;
+
+                if (fnErrorCallback) {
+                    try {
+                        vResult = await ushellUtils.promisify(fnErrorCallback(oError));
+                        bFailed = false;
+                    } catch (oNestedError) {
+                        Log.error("Error occurred in CallbackQueue:", oNestedError);
+
+                        bFailed = true;
+                        vResult = oNestedError;
+                    }
+                }
+
+                // Continue with next promise
+            }
+
+            // Finally resolve deferred to execute next step
+            oNextPromiseDeferred.resolve();
+
+            if (bFailed) {
+                throw vResult;
+            }
+            return vResult;
+        }
+
+        /**
+         * Waits for all promises in the queue to settle.
+         * When more callbacks are added to the queue, this method will ensure that they are also awaited.
+         * @returns {Promise} A promise that resolves when all queued promises have settled.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        async waitAllSettled () {
+            const pLastPromise = this.#pLastPromise;
+
+            await pLastPromise;
+
+            if (pLastPromise !== this.#pLastPromise) {
+                // new promise was added
+                return this.waitAllSettled();
+            }
+        }
+    }
+
+    return CallbackQueue;
+});

package/src/main/js/sap/ushell/utils/Deferred.js

@@ -63,13 +63,13 @@ sap.ui.define([], () => {
 
         /**
          * Sets the Promise object into rejected state.
-         * @param {any} args reject value of the promise.
+         * @param {any} vArgument reject value of the promise.
          * @returns {Promise} the promise object
          * @public
          */
-        reject (args) {
+        reject (vArgument) {
             this.#promise._state = "rejected";
-            this.#reject(args);
+            this.#reject(vArgument);
             return this.#promise;
         }
 

package/src/main/js/sap/ushell/utils/DynamicTileRequest.js

@@ -80,8 +80,8 @@ sap.ui.define([
                         this.#sUrlWithResolvedUserDefaults = sUrlResolvedUserDefaults;
                     }
                 })
-                .catch((vError) => {
-                    Log.error("Was not able to create a DynamicTileRequest:", vError, sModuleName);
+                .catch((oError) => {
+                    Log.error("Was not able to create a DynamicTileRequest:", oError, sModuleName);
                 });
 
             this._oInitialRefreshPromise = this.#oUserDefaultsPromise.then(() => {
@@ -161,9 +161,9 @@ sap.ui.define([
                 this.#bResolveSemanticDateRanges = oResult.hasSemanticDateRanges;
 
                 return oResult.url;
-            } catch (vError) {
-                Log.error("Could not resolve semantic date ranges:", vError, sModuleName);
-                return Promise.reject(vError);
+            } catch (oError) {
+                Log.error("Could not resolve semantic date ranges:", oError, sModuleName);
+                throw oError;
             }
         }
 
@@ -252,7 +252,7 @@ sap.ui.define([
             let vResult;
             try {
                 vResult = JSON.parse(oResult.responseText);
-            } catch (err) {
+            } catch {
                 throw new Error("Was not able to parse response of dynamic tile request");
             }
 

package/src/main/js/sap/ushell/utils/HttpClient.js

@@ -32,8 +32,9 @@
 sap.ui.define([
     "sap/ui/core/Supportability",
     "sap/ui/thirdparty/URI",
-    "sap/ushell/utils"
-], (Supportability, URI, utils) => {
+    "sap/ushell/utils",
+    "sap/ushell/utils/LaunchpadError"
+], (Supportability, URI, utils, LaunchpadError) => {
     "use strict";
 
     // JSDoc Type definitions
@@ -245,81 +246,79 @@ sap.ui.define([
      * @since 1.88.0
      * @private
      */
-    HttpClient.prototype._executeRequest = function (sRequestMethod, sResourcePath, oData) {
-        const oInvalidURLError = new Error("The provided resource path is not a valid URL.");
-
+    HttpClient.prototype._executeRequest = async function (sRequestMethod, sResourcePath, oData) {
         const oDefaultHeaders = {};
         const bSapStatisticsEnabled = Supportability.isStatisticsEnabled();
         if (bSapStatisticsEnabled) {
             oDefaultHeaders["sap-statistics"] = bSapStatisticsEnabled;
         }
 
-        try {
-            // Build URI and create XHR
-            let oCompleteResourceURI;
-            const oResourceURI = new URI(sResourcePath);
-            if (!oResourceURI.is("url")) {
-                return Promise.reject(oInvalidURLError);
-            }
+        // Build URI and create XHR
+        let oCompleteResourceURI;
+        const oResourceURI = new URI(sResourcePath);
+        if (!oResourceURI.is("url")) {
+            throw new Error("The provided resource path is not a valid URL.");
+        }
 
-            if (this._oBasePath) {
-                oCompleteResourceURI = oResourceURI.absoluteTo(this._oBasePath);
-            } else {
-                oCompleteResourceURI = oResourceURI;
-            }
+        if (this._oBasePath) {
+            oCompleteResourceURI = oResourceURI.absoluteTo(this._oBasePath);
+        } else {
+            oCompleteResourceURI = oResourceURI;
+        }
+
+        const oXhr = new XMLHttpRequest();
+
+        // Add unique id to the request & cache it in ongoing requests
+        oXhr._sapUshellHttpClientId = utils.generateUniqueId(Object.keys(this._oOngoingRequests));
+        this._oOngoingRequests[oXhr._sapUshellHttpClientId] = oXhr;
 
-            const oXhr = new XMLHttpRequest();
-
-            // Add unique id to the request & cache it in ongoing requests
-            oXhr._sapUshellHttpClientId = utils.generateUniqueId(Object.keys(this._oOngoingRequests));
-            this._oOngoingRequests[oXhr._sapUshellHttpClientId] = oXhr;
-
-            // Merge additional headers
-            const oHeaders = Object.assign({}, oDefaultHeaders, this._oDefaultOptions.headers, oData && oData.headers);
-
-            return this._getCSRFTokenHeader(sRequestMethod, oCompleteResourceURI)
-                .then((oCSRFHeader) => {
-                    // Merge x-csrf-token header
-                    Object.assign(oHeaders, oCSRFHeader);
-
-                    return new Promise((resolve, reject) => {
-                        // Configure and submit XHR
-
-                        const sCompleteResourceURI = oCompleteResourceURI.href();
-
-                        oXhr.onload = this._onLoad.bind(this, resolve, reject, {
-                            xhr: oXhr,
-                            method: sRequestMethod,
-                            url: sCompleteResourceURI,
-                            data: oData
-                        });
-                        oXhr.onerror = function () {
-                            reject.call(this, this._getFormattedResponse(oXhr));
-                        }.bind(this);
-                        oXhr.onabort = function () {
-                            oXhr.bAborted = true;
-                            reject.call(this, this._getFormattedResponse(oXhr));
-                        }.bind(this);
-                        oXhr.onloadend = function () {
-                            // Delete finished requests from the ongoing requests queue
-                            delete this._oOngoingRequests[oXhr._sapUshellHttpClientId];
-                        }.bind(this);
-
-                        oXhr.open(sRequestMethod, sCompleteResourceURI);
-                        Object.keys(oHeaders).forEach((sKey) => {
-                            oXhr.setRequestHeader(sKey, oHeaders[sKey]);
-                        });
-
-                        let sBody = oData && oData.data || "";
-                        if (typeof sBody !== "string") {
-                            sBody = JSON.stringify(sBody);
-                        }
-                        oXhr.send(sBody);
+        // Merge additional headers
+        const oHeaders = Object.assign({}, oDefaultHeaders, this._oDefaultOptions.headers, oData && oData.headers);
+
+        return this._getCSRFTokenHeader(sRequestMethod, oCompleteResourceURI)
+            .then((oCSRFHeader) => {
+                // Merge x-csrf-token header
+                Object.assign(oHeaders, oCSRFHeader);
+
+                return new Promise((resolve, reject) => {
+                    // Configure and submit XHR
+
+                    const sCompleteResourceURI = oCompleteResourceURI.href();
+
+                    oXhr.onload = this._onLoad.bind(this, resolve, reject, {
+                        xhr: oXhr,
+                        method: sRequestMethod,
+                        url: sCompleteResourceURI,
+                        data: oData
                     });
+                    oXhr.onerror = function () {
+                        const oResponse = this._getFormattedResponse(oXhr);
+                        const oError = new LaunchpadError(`Failed to execute HTTP request: ${oResponse.status} (${oResponse.status})`, oResponse);
+                        reject(oError);
+                    }.bind(this);
+                    oXhr.onabort = function () {
+                        oXhr.bAborted = true;
+                        const oResponse = this._getFormattedResponse(oXhr);
+                        const oError = new LaunchpadError(`Failed to execute HTTP request: ${oResponse.status} (${oResponse.status})`, oResponse);
+                        reject(oError);
+                    }.bind(this);
+                    oXhr.onloadend = function () {
+                        // Delete finished requests from the ongoing requests queue
+                        delete this._oOngoingRequests[oXhr._sapUshellHttpClientId];
+                    }.bind(this);
+
+                    oXhr.open(sRequestMethod, sCompleteResourceURI);
+                    Object.keys(oHeaders).forEach((sKey) => {
+                        oXhr.setRequestHeader(sKey, oHeaders[sKey]);
+                    });
+
+                    let sBody = oData && oData.data || "";
+                    if (typeof sBody !== "string") {
+                        sBody = JSON.stringify(sBody);
+                    }
+                    oXhr.send(sBody);
                 });
-        } catch (error) {
-            return Promise.reject(oInvalidURLError);
-        }
+            });
     };
 
     /**
@@ -441,7 +440,8 @@ sap.ui.define([
             return fnResolve(oFormattedResponse);
         }
 
-        return fnReject(oFormattedResponse);
+        const oError = new LaunchpadError(`Failed to execute HTTP request: ${oFormattedResponse.status} (${oFormattedResponse.status})`, oFormattedResponse);
+        fnReject(oError);
     };
 
     /**

package/src/main/js/sap/ushell/utils/LaunchpadError.js

@@ -0,0 +1,21 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+/**
+ * @fileOverview Custom Error class to transport more details
+ */
+sap.ui.define([
+], (
+) => {
+    "use strict";
+
+    class LaunchpadError extends Error {
+        constructor (sMessage, oDetails, oOriginalError) {
+            super(sMessage);
+            this.name = "LaunchpadError";
+            this.details = oDetails;
+            this.originalError = oOriginalError;
+        }
+    }
+
+    return LaunchpadError;
+});

package/src/main/js/sap/ushell/utils/UrlParsing.js

@@ -17,13 +17,15 @@ sap.ui.define([
     "sap/base/Log",
     "sap/base/util/deepEqual",
     "sap/base/util/merge",
-    "sap/ushell/TechnicalParameters"
+    "sap/ushell/TechnicalParameters",
+    "sap/ushell/utils"
 ], (
     URI,
     Log,
     deepEqual,
     merge,
-    TechnicalParameters
+    TechnicalParameters,
+    ushellUtils
 ) => {
     "use strict";
 
@@ -160,14 +162,10 @@ sap.ui.define([
      * @since 1.94.0
      * @protected
      */
-    UrlParsing.isIntentUrlAsync = function (sUrl) {
-        return new Promise((resolve, reject) => {
-            // in the app runtime this returns the URL of the outer FLP
-            sap.ui.require("sap/ushell/Container").getFLPUrlAsync(true).done(resolve).fail(reject);
-        })
-            .then((sFlpUrl) => {
-                return this._isIntentUrl(sUrl, sFlpUrl);
-            });
+    UrlParsing.isIntentUrlAsync = async function (sUrl) {
+        const [Container] = await ushellUtils.requireAsync(["sap/ushell/Container"]);
+        const sFlpUrl = await Container.getFLPUrlAsync(true);
+        return this._isIntentUrl(sUrl, sFlpUrl);
     };
 
     /**
@@ -228,8 +226,8 @@ sap.ui.define([
                 oKey = vKeys.next();
             }
             return oParamObject;
-        } catch (err) {
-            Log.error("URL parsing - malformed URL parameters string:", sParams);
+        } catch (oError) {
+            Log.error(`URL parsing - malformed URL parameters string: ${sParams}`, oError);
             return {};
         }
     };
@@ -323,7 +321,7 @@ sap.ui.define([
      * @since 1.94.0
      * @private
      */
-    UrlParsing.privparamsToString = function (oParams, sDelimiter, sAssign) {
+    UrlParsing.urlParametersToString = function (oParams, sDelimiter, sAssign) {
         return _urlParametersToString(oParams, sDelimiter, sAssign);
     };
 
@@ -708,6 +706,7 @@ sap.ui.define([
                 contextRaw: oHash.contextRaw
             },
             params: oSortedParams
+            // ignore appSpecificRoute
         });
     };
 
@@ -715,8 +714,8 @@ sap.ui.define([
      * Removes all technical parameters from the hash parameters that are not intent parameters
      * and returns the new hash parameters
      *
-     * @param {object<string, string[]>} oHashParams the hash parameters that should be checked for non-intent parameters
-     * @returns {object<string, string[]>} the given hash parameters with the non-intent parameters
+     * @param {Object<string, string[]>} oHashParams the hash parameters that should be checked for non-intent parameters
+     * @returns {Object<string, string[]>} the given hash parameters with the non-intent parameters
      *
      * @since 1.128.0
      * @private
@@ -740,8 +739,8 @@ sap.ui.define([
     /**
      * Checks whether shell hash parameters have changed
      *
-     * @param {object<string, string[]>} oNewParameters the new parameters
-     * @param {object<string, string[]>} oOldParameters the old parameters
+     * @param {Object<string, string[]>} oNewParameters the new parameters
+     * @param {Object<string, string[]>} oOldParameters the old parameters
      * @returns {boolean} <code>true</code> if oNewParameters are not equal to oOldParameters
      *
      * @since 1.128.0

package/src/main/js/sap/ushell/utils/UrlShortening.js

@@ -5,7 +5,7 @@
  *
  * This module is for internal Shell usage only
  *
- * @version 1.139.0
+ * @version 1.141.0
  */
 sap.ui.define(["sap/base/Log", "sap/ushell/utils/UrlParsing"], (Log, urlParsing) => {
     "use strict";
@@ -71,7 +71,7 @@ sap.ui.define(["sap/base/Log", "sap/ushell/utils/UrlParsing"], (Log, urlParsing)
             }
             try {
                 oValue = JSON.parse(value);
-            } catch (ex) {
+            } catch (oError) {
                 Log.error("This cannot happen: sap-xapp-state parameter value is neither key nor JSON parseable");
                 return value;
             }

package/src/main/js/sap/ushell/utils/WindowUtils.js

@@ -6,11 +6,13 @@
 sap.ui.define([
     "sap/base/Log",
     "sap/ui/util/isCrossOriginURL",
-    "sap/ushell/utils"
+    "sap/ushell/utils",
+    "sap/ushell/utils/UrlParsing"
 ], (
     Log,
     isCrossOriginURL,
-    ushellUtils
+    ushellUtils,
+    UrlParsing
 ) => {
     "use strict";
 
@@ -174,7 +176,7 @@ sap.ui.define([
                 delete oNewUrlParameter[sParam];
             });
         }
-        const sParamString = ushellUtils.urlParametersToString(oNewUrlParameter);
+        const sParamString = UrlParsing.urlParametersToString(oNewUrlParameter);
         return sParamString !== "" ? `?${sParamString}` : "";
     };
 

package/src/main/js/sap/ushell/utils/chipsUtils.js

@@ -141,7 +141,7 @@ sap.ui.define([
         try {
             sTileConfig = oChip.getConfigurationParameter(sConfigParameterId);
             oTileConfig = JSON.parse(sTileConfig);
-        } catch (e) {
+        } catch {
             // most likely this is not a static or dynamic applauncher
             return;
         }
@@ -201,11 +201,11 @@ sap.ui.define([
         const sConfigParam = oChipInstance.getConfigurationParameter("tileConfiguration");
         try {
             oParsedTileConfiguration = JSON.parse(sConfigParam || "{}");
-        } catch (oEx) {
+        } catch (oError) {
             Log.error(`Tile with ID '${oChipInstance.getId()
             }' has a corrupt configuration containing a 'tileConfiguration' value '${sConfigParam
             }' which could not be parsed. If present, a (stringified) JSON is expected as value.`,
-            oEx.message,
+            oError,
             "sap.ushell_abap.adapters.abap.LaunchPageAdapter"
             );
             return {}; // the FLP must react robust on broken single tiles
@@ -410,7 +410,9 @@ sap.ui.define([
 
                 this.addBagDataToChipInstance(oChipInstance, oBags);
                 return new Promise((resolve, reject) => {
-                    oChipInstance.load(resolve, reject);
+                    oChipInstance.load(resolve, (sErrorMessage) => {
+                        reject(new Error(sErrorMessage));
+                    });
                 })
                     .then(() => {
                         return oChipInstance;
@@ -445,7 +447,7 @@ sap.ui.define([
                     oBag.setText(sPropertyId, oBagData.texts[sPropertyId]);
                 }
             } catch (oError) {
-                Log.error(`chipsUtils.addBagDataToChipInstance: ${oError.toString()}`);
+                Log.error("chipsUtils.addBagDataToChipInstance:", oError);
             }
         }
     };

package/src/main/js/sap/ushell/utils/tilecard/TileCard.js

@@ -313,9 +313,9 @@ sap.ui.define([
                 throw new Error("No custom tile and no descriptor value");
             }
             oLogger.debug("TileCard was initialized.", JSON.stringify(oData));
-        } catch (ex) {
+        } catch (oError) {
             oLogger.debug("TileCard cannot be initialized.", JSON.stringify(oData));
-            oLogger.info("TileCard initialization failed", ex.message);
+            oLogger.info("TileCard initialization failed", oError);
             oResult = {
                 descriptor: {
                     value: errorTile