@sapui5/sap.ushell 1.118.0 → 1.119.2

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

@@ -30,9 +30,8 @@ sap.ui.define([
      * @extends sap.ui.core.Control
      *
      * @author SAP SE
-     * @version 1.118.0
+     * @version 1.119.2
      *
-     * @constructor
      * @private
      * @since 1.15.1
      * @alias sap.ushell.ui.shell.ShellHeadItem
@@ -255,8 +254,8 @@ sap.ui.define([
                 } else {
                     var maxValue = this.getFloatingNumberMaxValue();
                     this._oAriaDescribedbyText.setText((count > maxValue)
-                        ? resources.i18n.getText("NotificationToggleButton.NewNotifications.MaxExceeded", maxValue)
-                        : resources.i18n.getText("NotificationToggleButton.NewNotifications", count)
+                        ? resources.i18n.getText("NotificationToggleButton.NewNotifications.MaxExceeded", [maxValue])
+                        : resources.i18n.getText("NotificationToggleButton.NewNotifications", [count])
                     );
                 }
                 break;
@@ -282,14 +281,14 @@ sap.ui.define([
             case FloatingNumberType.Notifications:
                 if (!count) { return resources.i18n.getText("NotificationToggleButton.NoNewNotifications"); }
                 return (count > maxValue
-                    ? resources.i18n.getText("NotificationToggleButton.NewNotifications.MaxExceeded", maxValue)
-                    : resources.i18n.getText("NotificationToggleButton.NewNotifications", count));
+                    ? resources.i18n.getText("NotificationToggleButton.NewNotifications.MaxExceeded", [maxValue])
+                    : resources.i18n.getText("NotificationToggleButton.NewNotifications", [count]));
             case FloatingNumberType.OverflowButton:
                 var sTooltip = resources.i18n.getText("shellHeaderOverflowBtn_tooltip");
                 if (!count) { return sTooltip; }
                 sTooltip += " (" + (count > maxValue
-                    ? resources.i18n.getText("NotificationToggleButton.NewNotifications.MaxExceeded", maxValue)
-                    : resources.i18n.getText("NotificationToggleButton.NewNotifications", count)) + ")";
+                    ? resources.i18n.getText("NotificationToggleButton.NewNotifications.MaxExceeded", [maxValue])
+                    : resources.i18n.getText("NotificationToggleButton.NewNotifications", [count])) + ")";
                 return sTooltip;
         }
     };

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

@@ -45,7 +45,7 @@ sap.ui.define([
      * @extends sap.ui.core.Control
      *
      * @author SAP SE
-     * @version 1.118.0
+     * @version 1.119.2
      *
      * @private
      * @alias sap.ushell.ui.shell.SysInfoBar

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

@@ -18,9 +18,8 @@ sap.ui.define([
      * A control to be placed in the tool area
      * @extends sap.ui.core.Control
      *
-     * @version 1.118.0
+     * @version 1.119.2
      *
-     * @constructor
      * @public
      * @since 1.30.5
      *

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

@@ -28,7 +28,6 @@ sap.ui.define([
      * An applauncher for apps that need to display dynamically updated information
      * @extends sap.ushell.ui.tile.TileBase
      *
-     * @constructor
      * @public
      * @name sap.ushell.ui.tile.DynamicTile
      * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel

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

@@ -22,7 +22,6 @@ sap.ui.define([
      * Add your documentation for the newui/tile/ImageTile
      * @extends sap.ushell.ui.tile.TileBase
      *
-     * @constructor
      * @public
      * @name sap.ushell.ui.tile.ImageTile
      * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel

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

@@ -25,7 +25,6 @@ sap.ui.define([
      * An applauncher tile for simple, static apps, displaying title, subtitle, an icon and additional information
      * @extends sap.ushell.ui.tile.TileBase
      *
-     * @constructor
      * @since   1.15.0
      * @public
      * @name sap.ushell.ui.tile.StaticTile

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

@@ -29,7 +29,6 @@ sap.ui.define([
      * Base class for tiles that already provides several visual elements like title, subtitle, icon and additional information
      * @extends sap.ui.core.Control
      *
-     * @constructor
      * @public
      * @name sap.ushell.ui.tile.TileBase
      * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel

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.118.0
+ * @version 1.119.2
  * @private
  */
 

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The ShellUIService UI5 service
  *
- * @version 1.118.0
+ * @version 1.119.2
  */
 
 /**

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The UserStatus UI5 service
  *
- * @version 1.118.0
+ * @version 1.119.2
  */
 
 /**

package/src/main/js/sap/ushell/ui5service/_ShellUIService/shelluiservice.class.factory.js

@@ -749,7 +749,7 @@ sap.ui.define([
              * Returns version number in use (e.g. 2 for Fiori 2.0). Will be used
              * for checking whether the Fiori 2.0 header should be used or not.
              *
-             * @returns {number}
+             * @returns {int}
              *    the version number
              *
              * @since 1.38.0

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

@@ -74,7 +74,6 @@ sap.ui.define([
      *
      * The necessary CSRF token handling is done automatically.
      *
-     * @constructor
      * @class
      * @namespace sap.ushell.utils.XHttpClient
      *

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

@@ -17,7 +17,7 @@ sap.ui.define([
      * Constructor for a new RestrictedJSONModel.
      *
      * @extends sap.ui.model.json.JSONModel
-     * @constructor
+     * @class
      * @since 1.72.0
      *
      * @private

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

@@ -50,7 +50,6 @@ sap.ui.define([
      * notably we do not aim do "degrade" nicefully or support partial parsing of corrupted urls.
      *
      * @name sap.ushell.utils.UrlParsing
-     * @constructor
      * @class
      * @since 1.94.0
      * @private
@@ -83,7 +82,7 @@ sap.ui.define([
      *
      * @param {string} sShellHashString a valid (Shell) url, e.g. <br/>
      *   <code>http://xx.b.c#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH</code>
-     * @returns {Object} the parsed result
+     * @returns {object} the parsed result
      * @since 1.94.0
      * @protected
      */
@@ -220,18 +219,23 @@ sap.ui.define([
      * @protected
      */
     UrlParsing.parseParameters = function (sParams) {
-        var oUriParams = UriParameters.fromQuery(sParams);
-        var vKeys = oUriParams.keys();
-        var oKey = vKeys.next();
-        var oParamObject = {};
+        try {
+            var oUriParams = UriParameters.fromQuery(sParams);
+            var vKeys = oUriParams.keys();
+            var oKey = vKeys.next();
+            var oParamObject = {};
 
-        while (oKey.done === false) {
-            // decodeURIComponent: required when a key has double encoding, e.g. "%2524" (BCP: 2180415300)
-            // this extra decode is fine as long as literal "%" characters are not used on keys
-            oParamObject[decodeURIComponent(oKey.value)] = oUriParams.getAll(oKey.value);
-            oKey = vKeys.next();
+            while (oKey.done === false) {
+                // decodeURIComponent: required when a key has double encoding, e.g. "%2524" (BCP: 2180415300)
+                // this extra decode is fine as long as literal "%" characters are not used on keys
+                oParamObject[decodeURIComponent(oKey.value)] = oUriParams.getAll(oKey.value);
+                oKey = vKeys.next();
+            }
+            return oParamObject;
+        } catch (err) {
+            Log.error("URL parsing - malformed URL parameters string:", sParams);
+            return {};
         }
-        return oParamObject;
     };
 
     /**
@@ -285,7 +289,7 @@ sap.ui.define([
      * combine members of a javascript object into a parameter string,
      * note that parameters are ordered in an arbitrary manner which is subject to change
      *
-     * @param {Object} oParams any value { ABC : [1,"1 2"], DEF : ["4"]}
+     * @param {object} oParams any value { ABC : [1,"1 2"], DEF : ["4"]}
      * @returns {string} <code>ABC=1&ABC=1%202DEF=4</code>
      *   Note that the result is *not* prefixed with a "?", parameter values are encodeURIComponent encoded.
      * @since 1.94.0
@@ -298,7 +302,7 @@ sap.ui.define([
     /**
      * Internal function
      *
-     * @param {Object} oParams parameter object
+     * @param {object} oParams parameter object
      * @param {string} sDelimiter string to use as parameter delimiter (e.g., "&")
      * @param {string} sAssign string to use for parameter assignment (e.g., "=")
      * @returns {string} the result parameters

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

@@ -5,7 +5,7 @@
  *
  * This module is for internal Shell usage only
  *
- * @version 1.118.0
+ * @version 1.119.2
  */
  sap.ui.define(["sap/base/Log", "sap/ushell/utils/UrlParsing"], function (Log, urlParsing) {
     "use strict";
@@ -260,7 +260,7 @@
          *
          * @param {Array} aArray an array of string containing the strings to match
          * @param {string} sTest the string to test for
-         * @returns {integer} the index of a matching entry, or -1 if not found
+         * @returns {int} the index of a matching entry, or -1 if not found
          * @since 1.32.0
          * @private
          */

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

@@ -61,7 +61,7 @@ sap.ui.define([
      * @param  {string|array} oAccessPath one or more access paths to nested properties as string or array.
      *   E.g. "sap|flp.type" giving access to property o["sap.flp"].type of object o.
      *   A bar '|' is used to signal a dot in the property name.
-     * @param  {Object} [oDefault] default value
+     * @param  {object} [oDefault] default value
      * @returns {any} the value of the desired property, or the default value if the desired property is not defined in any object of <code>aObjects</code>.
      *   <code>undefined</code> is taken as default value if not explicitly specified.
      * @private

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

@@ -47,7 +47,7 @@ sap.ui.define([
      * @param {variant} v
      *   Any value
      *
-     * @return {boolean}
+     * @returns {boolean}
      *   Whether the passed value is defined
      *
      * @private

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

@@ -253,7 +253,7 @@ sap.ui.define([
      * Formats the target mappings contained in the CDM site projection into inbounds.
      *
      * @param {object} oSite the CDM site projection.
-     * @return {object[]} The inbounds suitable for ClientSideTargetResolution service consumption.
+     * @returns {object[]} The inbounds suitable for ClientSideTargetResolution service consumption.
      */
     function formatSite (oSite) {
         if (!oSite) {
@@ -298,7 +298,7 @@ sap.ui.define([
      * Constructs a hash string from the given inbound.
      *
      * @param {object} oInbound oInbound structure as specified in App Descriptor schema.
-     * @return {string} The constructed hash without leading "#", or undefined if not successful.
+     * @returns {string} The constructed hash without leading "#", or undefined if not successful.
      */
     function toHashFromInbound (oInbound) {
         var oShellHash,
@@ -340,7 +340,7 @@ sap.ui.define([
      * Constructs an hash string from the given outbound.
      *
      * @param {object} oOutbound Outbound structure as specified in App Descriptor schema.
-     * @return {string} The constructed hash without leading "#", or undefined if not successful.
+     * @returns {string} The constructed hash without leading "#", or undefined if not successful.
      */
     function toHashFromOutbound (oOutbound) {
         var oShellHash,

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

@@ -467,7 +467,11 @@ sap.ui.define([
     };
 
     /**
-     * Determines whether the given application type is to be embedded in an iframe (like gui or WDA applications).
+     * Determines whether the given application type is to be embedded in an iframe (like GUI or NWBC-wrapped WDA applications).
+     *
+     * Note:
+     * For now directly embedded WDA apps are handled differently! Therefore, application type "WDA" is NOT embedded in iframe
+     * in the sense of this function.
      *
      * @param {string} sApplicationType The type of the application.
      * @returns {boolean} Whether the ApplicationType is to be rendered embedded into an iframe
@@ -475,7 +479,7 @@ sap.ui.define([
      * @private
      */
     utils.isApplicationTypeEmbeddedInIframe = function (sApplicationType) {
-        return sApplicationType === "NWBC" || sApplicationType === "WDA" || sApplicationType === "TR" || sApplicationType === "WCF";
+        return sApplicationType === "NWBC" || sApplicationType === "TR" || sApplicationType === "WCF";
     };
 
     /**
@@ -563,14 +567,38 @@ sap.ui.define([
      *
      * @param {string} sUrl The URL to be amended.
      * @param {string} sApplicationType The application type for the given URL.
+     *
      * @returns {string} The URL where the parameter should be appended to.
      * @private
+     * @deprecated since 1.119.0
      */
-    utils.appendSapShellParam = function (sUrl, sApplicationType) {
+    utils.appendSapShellParamSync = function (sUrl, sApplicationType) {
         var sUrlSuffix = sApplicationType === "TR"
             ? ""
             : "-NWBC",
-            sVersion = utils.getUi5Version();
+            sVersion = utils.getUi5VersionSync();
+        if (sVersion) {
+            // we pass it either completely or not at all
+            sUrl += sUrl.indexOf("?") >= 0 ? "&" : "?"; // FIXME: This is a bug.
+            sUrl += "sap-shell=" + encodeURIComponent("FLP" + sVersion + sUrlSuffix);
+        }
+        return sUrl;
+    };
+
+    /**
+     * Appends a "sap-shell" parameter to the given URL to indicate the FLP version to legacy applications.
+     * This method should be called only when it is necessary to add the sap-shell parameter to the URL.
+     *
+     * @param {string} sUrl The URL to be amended.
+     * @param {string} sApplicationType The application type for the given URL.
+     *
+     * @returns {Promise<string>} The URL where the parameter should be appended to.
+     * @private
+     * @since 1.119.0
+     */
+    utils.appendSapShellParam = async function (sUrl, sApplicationType) {
+        const sUrlSuffix = sApplicationType === "TR" ? "" : "-NWBC";
+        const sVersion = await utils.getUi5Version();
         if (sVersion) {
             // we pass it either completely or not at all
             sUrl += sUrl.indexOf("?") >= 0 ? "&" : "?"; // FIXME: This is a bug.
@@ -616,13 +644,20 @@ sap.ui.define([
         return undefined;
     }
 
-    utils.getUi5VersionAsync = function () {
+    /**
+     * Returns the current UI5 version e.g. "1.119.0"
+     * @returns {Promise<string>} the UI5 version
+     * @since 1.119.0
+     * @private
+     */
+    utils.getUi5Version = function () {
         return new Promise(function (resolve, reject) {
             sap.ui.require(["sap/ui/VersionInfo"], function (VersionInfo) {
-                VersionInfo.load().then(
-                    function (oVersionInfo) {
+                VersionInfo.load()
+                    .then(function (oVersionInfo) {
                         resolve(_extractUi5Version(oVersionInfo.version));
-                    }).catch(function () {
+                    })
+                    .catch(function () {
                         Log.error("sap ui version could not be determined, using Configuration.getVersion() (core version) as fallback");
                         resolve(_extractUi5Version(Configuration.getVersion()));
                     });
@@ -630,7 +665,13 @@ sap.ui.define([
         });
     };
 
-    utils.getUi5Version = function () {
+    /**
+     * Returns the current UI5 version e.g. "1.119.0"
+     * @returns {string} the UI5 version
+     * @private
+     * @deprecated since 1.119.0
+     */
+    utils.getUi5VersionSync = function () {
         var sVersion;
 
         try { // in the sandbox localhost scenario, "sap.ui.getVersionInfo()" triggers an exception
@@ -1058,10 +1099,30 @@ sap.ui.define([
     };
 
     /**
-     * @param {function} fnFunction The function.
-     * @param {array} aArguments The arguments.
-     * @param {string[]} aArgumentsNames array of the argument names for non-trivial functions with more than one argument
-     * @returns {jQuery.Deferred.promise|function} a promise or a function
+     * Calls the handler with the provided list of arguments
+     * simple case:
+     *   aArguments=[a,b,c] => fnFunction(a,b,c)
+     *   returns <return value of call>
+     *
+     * complex case:
+     *   aArguments=[[
+     *     [a,b,c],    // => fnFunction(a,b,c)
+     *     [d,e,f],    // => fnFunction(d,e,f)
+     *     [g,h,i]     // => fnFunction(g,h,i)
+     *   ]]
+     *   returns [
+     *     [<return value of first call>],
+     *     [<return value of second call>]
+     *     [<return value of third call>]
+     *   ]
+     *
+     * edge case:
+     *   aArguments=[[]] => no call
+     *   returns []
+     *
+     * @param {function} fnFunction The function to call
+     * @param {object[]} aArguments A list of arguments or a list of calls with their arguments
+     * @returns {jQuery.Deferred.promise} Resolves once all handlers are done
      */
     utils.invokeUnfoldingArrayArguments = function (fnFunction, aArguments) {
         var that = this,
@@ -1160,23 +1221,23 @@ sap.ui.define([
         iDays = parseInt(iTimeGap / (1000 * 60 * 60 * 24), 10);
         if (iDays > 0) {
             if (iDays === 1) {
-                return ushellResources.i18n.getText("time_day", iDays);
+                return ushellResources.i18n.getText("time_day", [iDays]);
             }
-            return ushellResources.i18n.getText("time_days", iDays);
+            return ushellResources.i18n.getText("time_days", [iDays]);
         }
         iHours = parseInt(iTimeGap / (1000 * 60 * 60), 10);
         if (iHours > 0) {
             if (iHours === 1) {
-                return ushellResources.i18n.getText("time_hour", iHours);
+                return ushellResources.i18n.getText("time_hour", [iHours]);
             }
-            return ushellResources.i18n.getText("time_hours", iHours);
+            return ushellResources.i18n.getText("time_hours", [iHours]);
         }
         iMinutes = parseInt(iTimeGap / (1000 * 60), 10);
         if (iMinutes > 0) {
             if (iMinutes === 1) {
-                return ushellResources.i18n.getText("time_minute", iMinutes);
+                return ushellResources.i18n.getText("time_minute", [iMinutes]);
             }
-            return ushellResources.i18n.getText("time_minutes", iMinutes);
+            return ushellResources.i18n.getText("time_minutes", [iMinutes]);
         }
         return ushellResources.i18n.getText("just_now");
     };
@@ -1611,9 +1672,14 @@ sap.ui.define([
      */
     utils.promisify = function (vValue) {
         if (vValue.done) { // jQuery.Deferred
-            return new Promise(function (resolve, reject) {
+            return new Promise((resolve, reject) => {
                 vValue
-                    .done(resolve)
+                    .done((...args) => {
+                        if (args.length > 1) {
+                            Log.warning("jQuery.Deferred provided multiple return values, but only single return values are supported!");
+                        }
+                        resolve(args[0]);
+                    })
                     .fail(reject);
             });
         }
@@ -1623,5 +1689,46 @@ sap.ui.define([
         return Promise.resolve(vValue);
     };
 
+    /**
+     * Wraps the sap.ui.require into a promise
+     * @param {string[]} aModuleNames A list of module names
+     * @returns {Promise<object[]>} Resolves the list of required modules
+     * @private
+     * @since 1.119.0
+     */
+    utils.requireAsync = function (aModuleNames) {
+        return new Promise(function (resolve, reject) {
+            sap.ui.require(aModuleNames, (...aModules) => {
+                resolve(aModules);
+            });
+        });
+    };
+
+
+    /**
+     * Requests Theming Parameters in an async way
+     * @param {string[]} aNames A list of ThemingParameters names
+     * @returns {Promise<string[]>} Resolves the list of requested parameters
+     *
+     * @private
+     * @since 1.119.0
+     */
+    utils.getThemingParameters = async function (aNames) {
+        const oParameterMap = await new Promise((resolve, reject) => {
+            sap.ui.require(["sap/ui/core/theming/Parameters"], (ThemingParameters) => {
+                const oParameterMap = ThemingParameters.get({
+                    name: aNames,
+                    callback: resolve
+                });
+                if (oParameterMap) {
+                    resolve(oParameterMap);
+                }
+            });
+        });
+        return aNames.map((sName) => {
+            return oParameterMap[sName];
+        });
+    };
+
     return utils;
 }, /* bExport= */ false);

package/src/test/js/sap/ushell/bootstrap/sandbox.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's bootstrap code for development sandbox scenarios.
  *
- * @version 1.118.0
+ * @version 1.119.2
  */
 
 (function () {
@@ -221,7 +221,7 @@
                  * Get the path of our own script; module paths are registered relative to this path, not
                  * relative to the HTML page we introduce an ID for the bootstrap script, similar to UI5;
                  * allows to reference it later as well
-                 * @return {String} path of the bootstrap script
+                 * @returns {string} path of the bootstrap script
                  */
                 function getBootstrapScriptPath () {
                     var oScripts, oBootstrapScript, sBootstrapScriptUrl, sBootstrapScriptPath;

package/ui5.yaml

@@ -267,6 +267,7 @@ builder:
               - sap/ushell/iconfonts.js
               - sap/ushell/override.js
               - sap/ushell/renderers/fiori2/Renderer.js
+              - sap/ushell/renderers/fiori2/RendererExtensions.js
               - sap/ushell/renderers/fiori2/Shell.controller.js
               - sap/ushell/renderers/fiori2/Shell.view.js
               - sap/ushell/renderers/fiori2/ShellAsync.view.js

package/src/main/js/sap/ushell/appRuntime/ui5/services/Menu.js

@@ -1,22 +0,0 @@
-// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
-sap.ui.define([
-    "sap/ushell/services/Menu",
-    "sap/ushell/appRuntime/ui5/AppRuntimeService"
-], function (Menu, AppRuntimeService) {
-    "use strict";
-
-    function MenuProxy () {
-        Menu.call(this, arguments);
-
-        this.getSpacesPagesHierarchy = function () {
-            return new Promise(function (fnResolve) {
-                AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.Menu.getSpacesPagesHierarchy").done(fnResolve);
-            });
-        };
-    }
-
-    MenuProxy.prototype = Menu.prototype;
-    MenuProxy.hasNoAdapter = Menu.hasNoAdapter;
-
-    return MenuProxy;
-});