@sapui5/sap.ushell 1.120.8 → 1.121.0

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

@@ -1,9 +1,9 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
 sap.ui.define([
-    "sap/ui/core/Core",
+    "sap/ui/core/Element",
     "sap/ui/thirdparty/jquery"
-], function (Core, jQuery) {
+], function (Element, jQuery) {
     "use strict";
 
     /**
@@ -178,37 +178,33 @@ sap.ui.define([
          * Iterates over array-like object and calls callback function
          * for each item
          *
-         * @param {Array|NodeList|Arguments} scope - array-like object
-         * @param {Function} callback - function to be called for each element in scope
-         * @returns {Array|NodeList|Arguments} scope
+         * @param {Array<*>|NodeList|arguments} scope - array-like object
+         * @param {function} callback - function to be called for each element in scope
+         * @returns {Array<*>|NodeList|Arguments} scope
          */
         this.forEach = function (scope, callback) {
-            /*
-             * NodeList and Arguments don't have forEach,
-             * therefore borrow it from Array.prototype
-             */
+            // NodeList and Arguments don't have forEach,
+            // therefore borrow it from Array.prototype
             return Array.prototype.forEach.call(scope, callback);
         };
 
         /**
          * Returns index of item in array-like object
          *
-         * @param {Array|NodeList|Arguments} scope - array-like object
+         * @param {Array<*>|NodeList|Arguments} scope - array-like object
          * @param {*} item - item which index to be found
          * @returns {int} index of item in the array-like object
          */
         this.indexOf = function (scope, item) {
-            /*
-             * NodeList and Arguments don't have indexOf,
-             * therefore borrow it from Array.prototype
-             */
+            // NodeList and Arguments don't have indexOf,
+            // therefore borrow it from Array.prototype
             return Array.prototype.indexOf.call(scope, item);
         };
 
         /**
          * Cuts item from array-like object and pastes before reference item
          *
-         * @param {Array|NodeList|Arguments} scope
+         * @param {Array<*>|NodeList|Arguments} scope
          * @param {*} item
          * @param {*} referenceItem
          */
@@ -590,8 +586,8 @@ sap.ui.define([
                 rect;
 
             this.preventClickFlag = true;
-            if (Core.byId(this.element.id) && Core.byId(this.element.id).getBoundingRects) {
-                rect = Core.byId(this.element.id).getBoundingRects()[0];
+            if (Element.getElementById(this.element.id) && Element.getElementById(this.element.id).getBoundingRects) {
+                rect = Element.getElementById(this.element.id).getBoundingRects()[0];
                 rect.top = rect.offset.y;
                 rect.left = rect.offset.x;
                 rect.width += 5;
@@ -654,14 +650,14 @@ sap.ui.define([
          */
         this.dragAndScroll = function () {
             var
-                /*
+                /**
                  * Indicates how much pixels of draggable element are overflowing in a vertical axis.
                  * When deltaY is negative - content should be scrolled down,
                  * when deltaY is positive - content should be scrolled up,
                  * when deltaY is zero - content should not be scrolled
                  */
                 deltaY,
-                /*
+                /**
                  * Duration of scrolling animation in milliseconds.
                  * Greater value makes scroll faster, lower values - smoother
                  */
@@ -735,11 +731,9 @@ sap.ui.define([
                 movedElementPositionAboveMiddle = true;
 
             this.forEach(this.draggable, function (item, index) {
-                /*
-                 * There is no way to break native forEach,
-                 * so just speed it up using fast check
-                 * before executing expensive DOM manipulations
-                 */
+                // There is no way to break native forEach,
+                // so just speed it up using fast check
+                // before executing expensive DOM manipulations
                 if (!hoverElement) {
                     rect = item.getBoundingClientRect();
                     isVerticalIntersection = !(rect.bottom < this.moveY || rect.top > this.moveY);
@@ -755,9 +749,7 @@ sap.ui.define([
                 }
             }.bind(this));
             if (hoverElement && this.element !== hoverElement) {
-                /*
-                 * Reorder draggable elements
-                 */
+                // Reorder draggable elements
                 if (movedElementPositionAboveMiddle) {
                     this.insertBefore(this.draggable, this.element, hoverElement);
                     hoverElement.parentNode.insertBefore(this.element, hoverElement);
@@ -790,11 +782,9 @@ sap.ui.define([
                 rect;
 
             this.forEach(this.draggable, function (item, index) {
-                /*
-                 * There is no way to break native forEach,
-                 * so just speed it up using fast check
-                 * before executing expensive DOM manipulations
-                 */
+                // There is no way to break native forEach,
+                // so just speed it up using fast check
+                // before executing expensive DOM manipulations
                 if (!hoverElement) {
                     rect = item.getBoundingClientRect();
                     //style = window.getComputedStyle(item);
@@ -808,9 +798,7 @@ sap.ui.define([
             }.bind(this));
 
             if (hoverElement && this.element !== hoverElement) {
-                /*
-                 * Reorder draggable elements
-                 */
+                // Reorder draggable elements
                 elementIndex = this.indexOf(this.draggable, this.element);
                 //Check if there was enough movement in order to mover the element
                 if (Math.abs(this.lastMoveX - this.moveX) >= this.moveTolerance || Math.abs(this.lastMoveY - this.moveY) >= this.moveTolerance) {
@@ -834,6 +822,8 @@ sap.ui.define([
         /**
          * Enable feature
          *
+         * @returns {this} Reference to <code>this</code> for method chaining.
+         *
          * @public
          */
         this.enable = function () {
@@ -892,6 +882,8 @@ sap.ui.define([
         /**
          * Disable feature
          *
+         * @returns {this} Reference to <code>this</code> for method chaining.
+         *
          * @public
          */
         this.disable = function () {
@@ -923,10 +915,7 @@ sap.ui.define([
             return this;
         };
 
-        /*
-         * Initialize dynamic feature state
-         * and behaviour using configuration
-         */
+        // Initialize dynamic feature state and behaviour using configuration
         this.init(cfg);
 
         /**

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

@@ -26,7 +26,7 @@
  * The language to define parameters in the URL Template parameter set contains a minimal set of conditionals,
  * logical operators, and functions that allow to define the parameter set with a certain degree of control.
  *
- * @version 1.120.8
+ * @version 1.121.0
  * @private
  */
 sap.ui.define([

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

@@ -2,26 +2,27 @@
 /**
  * @fileOverview Ui5 Native Service Factory
  *
- * @version 1.120.8
+ * @version 1.121.0
  */
 
-/**
- * @namespace sap.ushell.Ui5NativeServiceFactory
- *
- * @private
- */
 sap.ui.define([
     "sap/ui/core/service/ServiceFactory"
 ],
     function (ServiceFactory) {
         "use strict";
 
+        /**
+         * @alias sap.ushell.Ui5NativeServiceFactory
+         * @namespace
+         *
+         * @private
+         */
         var oUi5NativeServiceFactory = {
             _servicePromises: {},
 
             /**
              * Creates UI5 service factories for the given service name. The once created service
-             * instances are reused on every service instanciation.
+             * instances are reused on every service instantiation.
              *
              * @param {string} sServiceName The card service name
              * @returns {object} The card service factory

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

@@ -6,13 +6,7 @@
  * Exposes methods to create a UI5 Service Factory for a specific Unified Shell
  * Service.
  *
- * @version 1.120.8
- */
-
-/**
- * @namespace sap.ushell.Ui5ServiceFactory
- *
- * @private
+ * @version 1.121.0
  */
 
 sap.ui.define([
@@ -33,7 +27,7 @@ sap.ui.define([
      * @param {string} sId
      *    The id of the active component.
      * @private
-    */
+     */
     function setActiveComponentId (sId) {
         sActiveComponentId = sId;
     }
@@ -69,7 +63,7 @@ sap.ui.define([
      * @param {object} oObject
      *    An object.
      *
-     * @returns {array}
+     * @returns {string[]}
      *    The names of the object properties (owned and not).
      *
      * @private
@@ -329,7 +323,13 @@ sap.ui.define([
      */
     function createServiceFactory (sUshellServiceName, bAddCallProtection) {
 
-        var Ui5ServiceFactory = ServiceFactory.extend("sap.ushell.ui5service." + sUshellServiceName + "Factory", {
+        /**
+         * @alias sap.ushell.Ui5ServiceFactory
+         * @namespace
+         *
+         * @private
+         */
+        var Ui5ServiceFactory = ServiceFactory.extend("sap.ushell.ui5service." + sUshellServiceName + "Factory", /** @lends sap.ushell.Ui5ServiceFactory.prototype */ {
 
             createInstance: function (oPublicServiceContext) {
 

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

@@ -5,18 +5,20 @@
  */
 sap.ui.define([
     "sap/base/Log",
+    "sap/base/i18n/Localization",
     "sap/base/util/deepExtend",
     "sap/ui/base/EventProvider",
-    "sap/ui/core/Configuration",
     "sap/ui/core/Core",
+    "sap/ui/core/Locale",
     "sap/ui/core/LocaleData",
     "sap/ui/thirdparty/URI"
 ], function (
     Log,
+    Localization,
     deepExtend,
     EventProvider,
-    Configuration,
     Core,
+    Locale,
     LocaleData,
     URI
 ) {
@@ -179,9 +181,9 @@ sap.ui.define([
          * @since 1.67.0
          */
         this.getLanguageText = function () {
-            var oLocale = Configuration.getLocale();
+            var oLocale = new Locale(Localization.getLanguageTag());
             var oLocaleData = new LocaleData(oLocale);
-            var sLanguageTag = Configuration.getLanguageTag();
+            var sLanguageTag = Localization.getLanguageTag().toString();
             return (oLocaleData.getLanguageName(sLanguageTag) || this.getLanguage());
         };
 

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

@@ -26,7 +26,8 @@
 sap.ui.define([
     "sap/base/Log",
     "sap/base/util/extend",
-    "sap/ui/core/Core",
+    "sap/ui/core/Element",
+    "sap/ui/core/EventBus",
     "sap/ui/thirdparty/hasher",
     "sap/ushell/EventHub",
     "sap/ushell/ui/launchpad/Tile",
@@ -35,7 +36,8 @@ sap.ui.define([
 ], function (
     Log,
     extend,
-    Core,
+    Element,
+    EventBus,
     hasher,
     EventHub,
     Tile,
@@ -83,7 +85,7 @@ sap.ui.define([
 
             this._isActive = true;
 
-            var oEventBus = Core.getEventBus();
+            var oEventBus = EventBus.getInstance();
 
             // Action logging: Subscribe to all the events in  _observedLaunchpadActions - User actions
             this._observedLaunchpadActions.forEach(function (item) {
@@ -115,7 +117,7 @@ sap.ui.define([
 
             this._isActive = false;
 
-            var oEventBus = Core.getEventBus();
+            var oEventBus = EventBus.getInstance();
 
             // Action logging: Unsubscribe to all the events in  _observedLaunchpadActions - User actions
             this._observedLaunchpadActions.forEach(function (item, i, arr) {
@@ -150,7 +152,7 @@ sap.ui.define([
         /**
          * Returns the queue that contains the last user actions and errors
          *
-         * @returns {Array} Log queue
+         * @returns {object[]} Log queue
          */
         getLog: function () {
             // return this._loggingQueue;
@@ -226,10 +228,10 @@ sap.ui.define([
                     var sNavigationHash = hasher.getHash();
 
                     /*
-                    according to wiki PSSEC/SEC-222
-                    we need to make sure we don't store sensitive data in the
-                    sessionStorage, therefore we remove the application parameters
-                    which might contains sensitive data like account number
+                     * according to wiki PSSEC/SEC-222
+                     * we need to make sure we don't store sensitive data in the
+                     * sessionStorage, therefore we remove the application parameters
+                     * which might contains sensitive data like account number
                      */
                     if (sNavigationHash) {
                         var oNavObj = urlParsing.parseShellHash(sNavigationHash);
@@ -247,7 +249,7 @@ sap.ui.define([
                     oLastNavigationActionData.tileDebugInfo = this.getDebugInfo();
 
                     // Get tile title
-                    var oTile = Core.byId(this.getId());
+                    var oTile = Element.getElementById(this.getId());
                     var oModel = oTile.getModel();
                     var oBindingContext = this.getBindingContext();
                     var sPath = oBindingContext.getPath();
@@ -427,7 +429,7 @@ sap.ui.define([
          * @private
          */
         _getShellState: function () {
-            var oViewPortContainer = Core.byId("viewPortContainer");
+            var oViewPortContainer = Element.getElementById("viewPortContainer");
             var sResult = "";
 
             if (oViewPortContainer !== undefined) {

package/src/main/js/sap/ushell/_ApplicationType/guiResolution.js

@@ -22,7 +22,7 @@ sap.ui.define([
      * removes properties of an object
      * @param {*} oObject
      *   Object that is modified and that has its properties deleted
-     * @param {array} aKeysToRemove The keys of properties to be removed
+     * @param {string[]} aKeysToRemove The keys of properties to be removed
      */
     function removeObjectKey (oObject, aKeysToRemove) {
         aKeysToRemove.forEach(function (sKeyToRemove) {
@@ -46,7 +46,7 @@ sap.ui.define([
      * @param {object} oInbound
      *    The inbound of the matching target
      *
-     * @returns {array}
+     * @returns {string[]}
      *    The name parameters from <code>oEffectiveParameters</code> that
      *    should not be included in a WebGUI URL.
      */
@@ -226,7 +226,7 @@ sap.ui.define([
      * @param {string} sSapSystemDataSrc
      *   The name of the system that contains data about the system alias.
      *
-     * @param {Function} fnExternalSystemAliasResolver
+     * @param {function} fnExternalSystemAliasResolver
      *   The alias resolver for remote system names.
      *
      * @returns {Promise}
@@ -434,10 +434,9 @@ sap.ui.define([
         var oWebguiURI = new URI(sBaseUrl);
 
         // construct effective parameters
-        /*
-        /* NOTE: do not include defaultedParameterNames for wrapped URLs,
-         * as they may cause a crash the called application.
-         */
+
+        // NOTE: do not include defaultedParameterNames for wrapped URLs,
+        // as they may cause a crash the called application.
         var oEffectiveParameters = deepExtend({}, oMatchingTarget.mappedIntentParamsPlusSimpleDefaults);
 
         var sSapSystem = oEffectiveParameters["sap-system"] && oEffectiveParameters["sap-system"][0];
@@ -547,10 +546,9 @@ sap.ui.define([
 
         // construct effective parameters
 
-        /*
-        /* NOTE: do not include defaultedParameterNames for wrapped URLs,
-         * as they may cause a crash the called application.
-         */
+
+        // NOTE: do not include defaultedParameterNames for wrapped URLs,
+        // as they may cause a crash the called application.
         var oEffectiveParameters = deepExtend({}, oMatchingTarget.mappedIntentParamsPlusSimpleDefaults);
 
         var sSapSystem = oEffectiveParameters["sap-system"] && oEffectiveParameters["sap-system"][0];
@@ -669,10 +667,9 @@ sap.ui.define([
         var oWebguiURI = new URI(sBaseUrl);
 
         // construct effective parameters
-        /*
-        /* NOTE: do not include defaultedParameterNames for wrapped URLs,
-         * as they may cause a crash the called application.
-         */
+
+        // NOTE: do not include defaultedParameterNames for wrapped URLs,
+        // as they may cause a crash the called application.
         var oEffectiveParameters = deepExtend({}, oMatchingTarget.mappedIntentParamsPlusSimpleDefaults);
 
         var sSapSystem = oEffectiveParameters["sap-system"] && oEffectiveParameters["sap-system"][0];
@@ -725,10 +722,9 @@ sap.ui.define([
         var oResolutionResult = {};
 
         // construct effective parameters
-        /*
-        /* NOTE: do not include defaultedParameterNames for wrapped URLs,
-         * as they may cause a crash the called application.
-         */
+
+        // NOTE: do not include defaultedParameterNames for wrapped URLs,
+        // as they may cause a crash the called application.
         var oEffectiveParameters = deepExtend({}, oMappedIntentParamsPlusSimpleDefaults);
         var sSapSystem = oEffectiveParameters["sap-system"] && oEffectiveParameters["sap-system"][0];
         var sSapSystemDataSrc = oEffectiveParameters["sap-system-src"] && oEffectiveParameters["sap-system-src"][0];

package/src/main/js/sap/ushell/_ApplicationType/systemAlias.js

@@ -4,12 +4,14 @@ sap.ui.define([
     "sap/ui/thirdparty/URI",
     "sap/ushell/utils",
     "sap/base/util/isPlainObject",
-    "sap/base/Log"
+    "sap/base/Log",
+    "sap/ushell/Container"
 ], function (
     URI,
     oUtils,
     isPlainObject,
-    Log
+    Log,
+    Container
 ) {
     "use strict";
 
@@ -183,7 +185,7 @@ sap.ui.define([
                             if (typeof oResolvedSystemAlias.language === "string" && oResolvedSystemAlias.language !== "") {
                                 sLanguage = oResolvedSystemAlias.language;
                             } else {
-                                oUser = sap.ushell.Container.getUser();
+                                oUser = Container.getUser();
                                 if (!oUser) {
                                     Log.error(
                                         "Cannot retieve the User object via sap.ushell.Container while determining sap-language",

package/src/main/js/sap/ushell/_ApplicationType/ui5Resolution.js

@@ -52,20 +52,20 @@ sap.ui.define([
          */
         oResolutionResult.reservedParameters = {};
         var oReservedParameters = {
-            //
-            // Used by the RT plugin to determine whether the RT change was made
-            // by a key user or by a end-user.
-            //
+            // Not set or read by RTA
+            // We still treat this as a technical parameter to avoid issues with existing usages (e.g. bookmarks) which might
+            // leak this parameter into the startupParameters
+            // Used by the RT plugin to determine whether the RT change was made by a key user or by a end-user.
             "sap-ui-fl-max-layer": true,
-            //
+
             // Used by RTA to determine which control variant id(s) should be
             // selected when the application is loaded.
-            //
             "sap-ui-fl-control-variant-id": true,
-            //
-            // Used by RTA to determine draft app which user starts to
-            // adapt but don't want to activate immediately.
-            //
+
+            // Not set or read by RTA
+            // We still treat this as a technical parameter to avoid issues with existing usages (e.g. bookmarks) which might
+            // leak this parameter into the startupParameters
+            // Used by RTA to determine draft app which user starts to adapt but don't want to activate immediately.
             "sap-ui-fl-version": true
         };
         Object.keys(oReservedParameters).forEach(function (sName) {
@@ -111,6 +111,7 @@ sap.ui.define([
         }
 
         oResolutionResult.text = oInbound.title;
+        oResolutionResult.extendedInfo = oApplicationTypeUtils.getExtendedInfo(oMatchingTarget);
 
         return Promise.resolve(oResolutionResult);
     }

package/src/main/js/sap/ushell/_ApplicationType/urlTemplateResolution.js

@@ -1,28 +1,30 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/base/Log",
+    "sap/base/i18n/Localization",
     "sap/ui/thirdparty/hasher",
     "sap/base/util/ObjectPath",
     "sap/ushell/utils",
     "sap/ushell/User",
-    "sap/ui/core/Configuration",
     "sap/ushell/Config",
     "sap/ui/thirdparty/URI",
     "sap/ui/core/routing/History",
     "sap/ushell/_ApplicationType/utils",
-    "sap/base/util/deepClone"
+    "sap/base/util/deepClone",
+    "sap/ushell/Container"
 ], function (
     Log,
+    Localization,
     hasher,
     ObjectPath,
     ushellUtils,
     User,
-    Configuration,
     Config,
     URI,
     History,
     oApplicationTypeUtils,
-    deepClone
+    deepClone,
+    Container
 ) {
     "use strict";
 
@@ -186,7 +188,7 @@ sap.ui.define([
                     addLanguageToURLTemplateResult(oResult, oTemplateContext.siteAppSection, oRuntime);
 
                     var oPromisePostTemplateProcessing = new Promise(function (fnResolve) {
-                        sap.ushell.Container.getServiceAsync("URLTemplate").then(function (srv) {
+                        Container.getServiceAsync("URLTemplate").then(function (srv) {
                             sap.ui.require(["sap/ushell/components/applicationIntegration/application/BlueBoxesCache"], function (BlueBoxesCache) {
                                 var bForNewIframe = (BlueBoxesCache.get(oResult.url) === undefined);
                                 srv.handlePostTemplateProcessing(oResult.url, oTemplateContext.siteAppSection, bForNewIframe).then(fnResolve);
@@ -223,9 +225,9 @@ sap.ui.define([
         });
     }
 
-    /*
-    add "sap-spaces" parameter as a url parameter
-    */
+    /**
+     * add "sap-spaces" parameter as a url parameter
+     */
     function addSpacesModeToURLTemplateResult (oResult) {
 
         if (oResult.url && typeof oResult.url === "string") {
@@ -241,7 +243,7 @@ sap.ui.define([
         }
     }
 
-    /*
+    /**
      * this is a temp solution until the url template is changed
      */
     function addLanguageToURLTemplateResult (oResult, oSiteAppSection, oRuntime) {
@@ -269,8 +271,8 @@ sap.ui.define([
             if (vTargetNavMode === "explace") {
                 bIsTransient = false;
             }
-            sap.ushell.Container.getServiceAsync("ShellNavigation").then(function (oShellNavigationService) {
-                oShellNavigationService.compactParams(
+            Container.getServiceAsync("ShellNavigationInternal").then(function (oShellNavigationInternal) {
+                oShellNavigationInternal.compactParams(
                     oParams,
                     aRetainParameterList,
                     undefined /* no Component*/,
@@ -545,8 +547,8 @@ sap.ui.define([
     function createEnv () {
         return new Promise(function (fnResolve) {
             Promise.all([
-                sap.ushell.Container.getServiceAsync("UserInfo"),
-                sap.ushell.Container.getServiceAsync("PluginManager"),
+                Container.getServiceAsync("UserInfo"),
+                Container.getServiceAsync("PluginManager"),
                 ushellUtils.getUi5Version()
             ]).then(function (aResults) {
                 var oUserInfoService = aResults[0];
@@ -561,8 +563,8 @@ sap.ui.define([
                     sTheme = oUser.getTheme(sThemeFormat);
                 }
 
-                var sLanguage = Configuration.getLanguage && Configuration.getLanguage();
-                var sLogonLanguage = Configuration.getSAPLogonLanguage && Configuration.getSAPLogonLanguage();
+                var sLanguage = Localization.getLanguage();
+                var sLogonLanguage = Localization.getSAPLogonLanguage();
 
                 var themeServiceRoot = window.location.protocol + "//" + window.location.host // host
                     + "/comsapuitheming.runtime/themeroot/v1"; // route to theme service

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

@@ -211,9 +211,9 @@ sap.ui.define([
         return oInfo;
     }
 
-    /*
-    add "sap-iframe-hint" parameter that will help to identify the
-     correct cached iframe in case the URL is opened in stateful container
+    /**
+     * add "sap-iframe-hint" parameter that will help to identify the
+     * correct cached iframe in case the URL is opened in stateful container
      */
     function addIframeCacheHintToURL (oResult, sFrameworkId) {
         if (sFrameworkId) {
@@ -221,8 +221,8 @@ sap.ui.define([
         }
     }
 
-    /*
-    allow legacy app to be opened with GET and not POST when a parameter is set in the app
+    /**
+     * allow legacy app to be opened with GET and not POST when a parameter is set in the app
      */
     function checkOpenWithPost (oMatchingTarget, oResult) {
         var oAppParams = oMatchingTarget.intentParamsPlusAllDefaults;
@@ -231,8 +231,8 @@ sap.ui.define([
         }
     }
 
-    /*
-    add "sap-keep-alive" parameter as a url parameter
+    /**
+     * add "sap-keep-alive" parameter as a url parameter
      */
     function addKeepAliveToURLTemplateResult (oResult) {
         var sKeepAlive;