@sapui5/sap.ushell 1.139.0 → 1.141.0

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The app runtime wrapper for {@link sap.ushell.services.CrossApplicationNavigation}.
  *
- * @version 1.139.0
+ * @version 1.141.0
  * @deprecated since 1.120. Use {@link sap.ushell.services.Navigation} instead.
  */
 sap.ui.define([
@@ -12,7 +12,7 @@ sap.ui.define([
     "sap/ui/thirdparty/jquery",
     "sap/base/Log",
     "sap/ushell/appRuntime/ui5/services/Container",
-    "sap/ushell/appRuntime/ui5/AppRuntimeService",
+    "sap/ushell/appRuntime/ui5/AppCommunicationMgr",
     "sap/ushell/appRuntime/ui5/AppRuntimeContext",
     "sap/base/util/deepClone",
     "sap/ushell/utils/UrlParsing"
@@ -22,7 +22,7 @@ sap.ui.define([
     jQuery,
     Log,
     Container,
-    AppRuntimeService,
+    AppCommunicationMgr,
     AppRuntimeContext,
     deepClone,
     UrlParsing
@@ -49,7 +49,7 @@ sap.ui.define([
         this.backToPreviousApp = function () {
             // ready also for scube
             if (AppRuntimeContext.checkDataLossAndContinue()) {
-                return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.backToPreviousApp");
+                return AppCommunicationMgr.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.backToPreviousApp");
             }
         };
 
@@ -59,7 +59,7 @@ sap.ui.define([
             if (AppRuntimeContext.getIsScube()) {
                 return this.expandCompactHashLocal(sHashFragment);
             }
-            return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.expandCompactHash", {
+            return AppCommunicationMgr.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.expandCompactHash", {
                 sHashFragment: sHashFragment
             });
         };
@@ -70,47 +70,104 @@ sap.ui.define([
             if (AppRuntimeContext.getIsScube()) {
                 return this.getDistinctSemanticObjectsLocal();
             }
-            return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.getDistinctSemanticObjects");
+            return AppCommunicationMgr.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.getDistinctSemanticObjects");
         };
 
-        this.getLinksLocal = this.getDistinctSemanticObjects;
-        this.getLinks = function (oArgs) {
+        this.getLinksLocal = this.getLinks;
+
+        /**  Combine the two arrays by concatenating the corresponding inner arrays.
+         * @example
+         * If the two arrays are:
+        [
+            [ * assumption is that this array has only one element
+                [
+                    1a,
+                    1b
+                ]
+            ],
+            [
+                [
+                    2a,2b
+                ]
+            ]
+        ]
+        then the following shall be returned in a promise:
+        [
+            [
+                [
+                    1a,
+                    2a
+                ],
+            ],
+            [
+                [
+                    1b,
+                    2b
+                ]
+            ]
+        ]
+         * @param {Array} aResultLocal - First result array
+         * @param {Array} aResultFlp - Second result array
+         * @returns {Array} Combined result array
+         * @private
+         * @since 1.140.0
+         */
+        this._combineResults = function (aResultLocal, aResultFlp) {
+            // simplify by removing the 2nd level array
+            const aSimpleResultLocal = aResultLocal.map((aElement) => aElement[0]);
+            const aSimpleResultFlp = aResultFlp.map((aElement) => aElement[0]);
+            // combine the two arrays pairwise
+            // [[1a, 1b], [2a, 2b]] -> [[1a, 2a], [1b, 2b]]
+            const aSimpleCombinedResult = aSimpleResultLocal.map((_oLink, iIndex) => {
+                return aSimpleResultFlp[iIndex].concat(aSimpleResultLocal[iIndex]);
+            });
+            // add the 2nd level array again
+            return aSimpleCombinedResult.map((aElement) => [aElement]);
+        };
+
+        /** get links that are available for the user
+         * @param {object|Array<Array<object>>} [vArgs] Either a single object or an array of arrays containing the parameters for the getLinks method.
+         *
+         * @returns {Promise<Array<object>|Array<Array<Array<object>>>>} The links for the provided parameters.
+         *
+         */
+        this.getLinks = function (vArgs) {
             // ready also for scube
             const oDeferred = new jQuery.Deferred();
 
-            function removeComponent (oArgsParam) {
-                if (Array.isArray(oArgsParam)) {
-                    oArgsParam.forEach((element) => {
+            function removeComponent (vArgsParam) {
+                if (Array.isArray(vArgsParam)) {
+                    vArgsParam.forEach((element) => {
                         if (element[0]) {
                             delete element[0].ui5Component;
                         }
                     });
                 } else {
-                    delete oArgsParam.ui5Component;
+                    delete (vArgsParam || {}).ui5Component;
                 }
             }
 
             if (AppRuntimeContext.getIsScube()) {
-                this.getLinksLocal(oArgs).then((arrResult1) => {
-                    removeComponent(oArgs);
-                    AppRuntimeService.postMessageToFLP(
+                this.getLinksLocal(vArgs).then((aResultLocal) => {
+                    removeComponent(vArgs);
+                    AppCommunicationMgr.postMessageToFLP(
                         "sap.ushell.services.CrossApplicationNavigation.getLinks",
-                        oArgs
-                    ).then((arrResult2) => {
-                        if (arrResult1.length === 0) {
-                            oDeferred.resolve(arrResult2);
+                        vArgs
+                    ).then((aResultFlp) => {
+                        if (Array.isArray(vArgs)) {
+                            const aCombinedResult = this._combineResults(aResultLocal, aResultFlp);
+                            oDeferred.resolve(aCombinedResult);
                         } else {
-                            arrResult2 = arrResult2.concat(arrResult1);
-                            oDeferred.resolve(arrResult2);
+                            oDeferred.resolve(aResultFlp.concat(aResultLocal));
                         }
                     });
                 });
             } else {
-                removeComponent(oArgs);
-                AppRuntimeService.postMessageToFLP(
+                removeComponent(vArgs);
+                AppCommunicationMgr.postMessageToFLP(
                     "sap.ushell.services.CrossApplicationNavigation.getLinks",
-                    oArgs
-                ).then(oDeferred.resolve, oDeferred.reject);
+                    vArgs
+                ).then(oDeferred.resolve).catch(oDeferred.reject);
             }
 
             return oDeferred.promise();
@@ -118,7 +175,7 @@ sap.ui.define([
 
         this.getPrimaryIntent = function (sSemanticObject, mParameters) {
             // not ready for scube
-            return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.getPrimaryIntent", {
+            return AppCommunicationMgr.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.getPrimaryIntent", {
                 sSemanticObject: sSemanticObject,
                 mParameters: mParameters
             });
@@ -127,7 +184,7 @@ sap.ui.define([
         this.getSemanticObjectLinks = function (sSemanticObject, mParameters, bIgnoreFormFactor, oComponent,
             sAppStateKey, bCompactIntents) {
             // not ready for scube
-            return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.getSemanticObjectLinks", {
+            return AppCommunicationMgr.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.getSemanticObjectLinks", {
                 sSemanticObject: sSemanticObject,
                 mParameters: mParameters,
                 bIgnoreFormFactor: bIgnoreFormFactor,
@@ -139,7 +196,7 @@ sap.ui.define([
         this.historyBack = function (iSteps) {
             // ready for scube
             if (AppRuntimeContext.checkDataLossAndContinue()) {
-                AppRuntimeService.postMessageToFLP("sap.ushell.services.CrossApplicationNavigation.historyBack", {
+                AppCommunicationMgr.postMessageToFLP("sap.ushell.services.CrossApplicationNavigation.historyBack", {
                     iSteps: iSteps
                 });
             }
@@ -155,14 +212,14 @@ sap.ui.define([
                 return oDeferred.promise();
             }
 
-            return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.isIntentSupported", {
+            return AppCommunicationMgr.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.isIntentSupported", {
                 aIntents: aIntents
             });
         };
 
         this.isNavigationSupported = function (aIntents, oComponent, bCheckInOuterShellOnly) {
             function fnCheckInShell (aIntentsTmp) {
-                return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.isNavigationSupported", {
+                return AppCommunicationMgr.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.isNavigationSupported", {
                     aIntents: aIntentsTmp
                 });
             }
@@ -210,7 +267,7 @@ sap.ui.define([
                     oShellNavigationInternal.toExternal(oArgs, oComponent);
                 });
             } else if (AppRuntimeContext.checkDataLossAndContinue()) {
-                AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.toExternal", {
+                AppCommunicationMgr.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.toExternal", {
                     oArgs: oArgs
                 });
             }
@@ -221,7 +278,7 @@ sap.ui.define([
             // ready also for scube
             const oDeferred = new jQuery.Deferred();
 
-            AppRuntimeService.postMessageToFLP("sap.ushell.services.CrossApplicationNavigation.getAppState", {
+            AppCommunicationMgr.postMessageToFLP("sap.ushell.services.CrossApplicationNavigation.getAppState", {
                 sAppStateKey: sAppStateKey
             }).then((oState) => {
                 Container.getServiceAsync("AppState").then((AppStateService) => {
@@ -247,21 +304,21 @@ sap.ui.define([
                 return this.resolveIntentLocal(sHashFragment);
             }
 
-            return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.resolveIntent", {
+            return AppCommunicationMgr.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.resolveIntent", {
                 sHashFragment: sHashFragment
             });
         };
 
         this.hrefForExternalAsync = function (oArgs) {
             // not ready for scube
-            return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.hrefForExternal", {
+            return AppCommunicationMgr.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.hrefForExternal", {
                 oArgs: oArgs
             });
         };
 
         this.hrefForAppSpecificHashAsync = function (sAppHash) {
             // not ready for scube
-            return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.hrefForAppSpecificHash", {
+            return AppCommunicationMgr.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.hrefForAppSpecificHash", {
                 sAppHash: sAppHash
             });
         };
@@ -277,7 +334,7 @@ sap.ui.define([
 
         this.isInitialNavigationAsync = function () {
             // ready for scube
-            return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.isInitialNavigation", {});
+            return AppCommunicationMgr.sendMessageToOuterShell("sap.ushell.services.CrossApplicationNavigation.isInitialNavigation", {});
         };
     }
 

package/src/main/js/sap/ushell/appRuntime/ui5/services/Extension/Item.js

@@ -3,12 +3,12 @@
 /**
  * @fileOverview Defines a generic interface for extension items in ShellAreas.
  *
- * @version 1.139.0
+ * @version 1.141.0
  */
 sap.ui.define([
-    "sap/ushell/appRuntime/ui5/AppRuntimeService"
+    "sap/ushell/appRuntime/ui5/AppCommunicationMgr"
 ], (
-    AppRuntimeService
+    AppCommunicationMgr
 ) => {
     "use strict";
     /**
@@ -39,7 +39,7 @@ sap.ui.define([
          * @private
          */
         async destroy () {
-            AppRuntimeService.postMessageToFLP("sap.ushell.services.Extension.Item.destroy", {
+            AppCommunicationMgr.postMessageToFLP("sap.ushell.services.Extension.Item.destroy", {
                 itemId: this.#id
             });
         }
@@ -54,7 +54,7 @@ sap.ui.define([
          * @private
          */
         showForCurrentApp () {
-            AppRuntimeService.postMessageToFLP("sap.ushell.services.Extension.Item.showForCurrentApp", {
+            AppCommunicationMgr.postMessageToFLP("sap.ushell.services.Extension.Item.showForCurrentApp", {
                 itemId: this.#id
             });
             return this;
@@ -69,7 +69,7 @@ sap.ui.define([
          * @private
          */
         hideForCurrentApp () {
-            AppRuntimeService.postMessageToFLP("sap.ushell.services.Extension.Item.hideForCurrentApp", {
+            AppCommunicationMgr.postMessageToFLP("sap.ushell.services.Extension.Item.hideForCurrentApp", {
                 itemId: this.#id
             });
             return this;
@@ -84,7 +84,7 @@ sap.ui.define([
          * @private
          */
         showForAllApps () {
-            AppRuntimeService.postMessageToFLP("sap.ushell.services.Extension.Item.showForAllApps", {
+            AppCommunicationMgr.postMessageToFLP("sap.ushell.services.Extension.Item.showForAllApps", {
                 itemId: this.#id
             });
             return this;
@@ -99,7 +99,7 @@ sap.ui.define([
          * @private
          */
         hideForAllApps () {
-            AppRuntimeService.postMessageToFLP("sap.ushell.services.Extension.Item.hideForAllApps", {
+            AppCommunicationMgr.postMessageToFLP("sap.ushell.services.Extension.Item.hideForAllApps", {
                 itemId: this.#id
             });
             return this;
@@ -114,7 +114,7 @@ sap.ui.define([
          * @private
          */
         showOnHome () {
-            AppRuntimeService.postMessageToFLP("sap.ushell.services.Extension.Item.showOnHome", {
+            AppCommunicationMgr.postMessageToFLP("sap.ushell.services.Extension.Item.showOnHome", {
                 itemId: this.#id
             });
             return this;
@@ -129,7 +129,7 @@ sap.ui.define([
          * @private
          */
         hideOnHome () {
-            AppRuntimeService.postMessageToFLP("sap.ushell.services.Extension.Item.hideOnHome", {
+            AppCommunicationMgr.postMessageToFLP("sap.ushell.services.Extension.Item.hideOnHome", {
                 itemId: this.#id
             });
             return this;

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

@@ -3,21 +3,19 @@
 /**
  * @fileOverview The app runtime wrapper for {@link sap.ushell.services.Extension}.
  *
- * @version 1.139.0
+ * @version 1.141.0
  */
 sap.ui.define([
     "sap/base/Log",
     "sap/base/util/isPlainObject",
     "sap/ui/core/Element",
     "sap/ushell/appRuntime/ui5/services/Extension/Item",
-    "sap/ushell/appRuntime/ui5/AppRuntimeService",
     "sap/ushell/appRuntime/ui5/AppCommunicationMgr"
 ], (
     Log,
     isPlainObject,
     Element,
     ExtensionItem,
-    AppRuntimeService,
     AppCommunicationMgr
 ) => {
     "use strict";
@@ -35,27 +33,27 @@ sap.ui.define([
     function ExtensionProxy () {
         this._oItemMap = {};
 
-        AppCommunicationMgr.registerCommHandlers({
-            "sap.ushell.services.Extension": {
-                oServiceCalls: {
-                    handleControlEvent: {
-                        executeServiceCallFn: async (oServiceParams) => {
-                            const { itemId, eventName } = oServiceParams.oMessageData.body;
-                            const oItem = this._oItemMap[itemId];
-                            if (oItem) {
-                                oItem.handleEvent(eventName);
-                            }
-                        }
+        const oRequestHandlers = {
+            "sap.ushell.services.Extension.handleControlEvent": {
+                handler: async (oMessageBody, oMessageEvent) => {
+                    const { itemId, eventName } = oMessageBody;
+                    const oItem = this._oItemMap[itemId];
+                    if (oItem) {
+                        oItem.handleEvent(eventName);
                     }
                 }
             }
+        };
+
+        Object.keys(oRequestHandlers).forEach((sServiceRequest) => {
+            AppCommunicationMgr.setRequestHandler(sServiceRequest, oRequestHandlers[sServiceRequest].handler);
         });
     }
 
     /**
      * Separates the properties of a control into primitive, complex and event properties.
      * @param {object} oControlProperties The properties of the control.
-     * @returns {{ primitive: object<string, int|string|boolean|object>, complex: object, events: object<string, function> }} The separated properties.
+     * @returns {{ primitive: Object<string, int|string|boolean|object>, complex: object, events: Object<string, function> }} The separated properties.
      *
      * @since 1.124.0
      * @private
@@ -113,7 +111,7 @@ sap.ui.define([
             throw new Error("Complex properties (aggregations, controls, non plain objects) are not allowed for header items!");
         }
 
-        const { itemId } = await AppRuntimeService.postMessageToFLP("sap.ushell.services.Extension.createHeaderItem", {
+        const { itemId } = await AppCommunicationMgr.postMessageToFLP("sap.ushell.services.Extension.createHeaderItem", {
             controlProperties: oProperties.primitive,
             events: Object.keys(oProperties.events),
             parameters
@@ -156,7 +154,7 @@ sap.ui.define([
             throw new Error("Complex properties (aggregations, controls, non plain objects) are not allowed for user actions!");
         }
 
-        const { itemId } = await AppRuntimeService.postMessageToFLP("sap.ushell.services.Extension.createUserAction", {
+        const { itemId } = await AppCommunicationMgr.postMessageToFLP("sap.ushell.services.Extension.createUserAction", {
             controlProperties: oProperties.primitive,
             events: Object.keys(oProperties.events),
             parameters
@@ -179,7 +177,7 @@ sap.ui.define([
      * @experimental since 1.125.0
      */
     ExtensionProxy.prototype.setSecondTitle = function (sTitle) {
-        return AppRuntimeService.postMessageToFLP("sap.ushell.services.Extension.setSecondTitle", {
+        return AppCommunicationMgr.postMessageToFLP("sap.ushell.services.Extension.setSecondTitle", {
             title: sTitle
         });
     };

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The app runtime wrapper for {@link sap.ushell.services.FlpLaunchPage}.
  *
- * @version 1.139.0
+ * @version 1.141.0
  */
 sap.ui.define([
 ], (

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The app runtime wrapper for {@link sap.ushell.services.FrameBoundExtension}.
  *
- * @version 1.139.0
+ * @version 1.141.0
  */
 sap.ui.define([
 ], (

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

@@ -3,15 +3,15 @@
 /**
  * @fileOverview The app runtime wrapper for {@link sap.ushell.services.LaunchPage}.
  *
- * @version 1.139.0
+ * @version 1.141.0
  * @deprecated since 1.120. This service has been deprecated as it only works for the classic homepage.
  */
 sap.ui.define([
     "sap/ushell/services/LaunchPage",
-    "sap/ushell/appRuntime/ui5/AppRuntimeService"
+    "sap/ushell/appRuntime/ui5/AppCommunicationMgr"
 ], (
     LaunchPage,
-    AppRuntimeService
+    AppCommunicationMgr
 ) => {
     "use strict";
 
@@ -36,7 +36,7 @@ sap.ui.define([
         // ServiceNow case 560653/2025
 
         this.getGroupsForBookmarks = function () {
-            return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.LaunchPage.getGroupsForBookmarks");
+            return AppCommunicationMgr.sendMessageToOuterShell("sap.ushell.services.LaunchPage.getGroupsForBookmarks");
         };
     }
 

package/src/main/js/sap/ushell/appRuntime/ui5/services/MessageBroker/Client.js

@@ -0,0 +1,114 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+sap.ui.define([
+], (
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.appRuntime.ui5.services.MessageBroker.Client
+     * @class
+     * @classdesc Data structure for managing client connections and subscriptions.
+     * Collects connection calls to support the deprecated use case of providing the
+     * callback only with the subscribe call.
+     *
+     * @since 1.141.0
+     * @private
+     */
+    class Client {
+        #sId; // for debugging
+        #fnClientConnectionCallback;
+        #mChannelSubscriptions = new Map();
+        #aCollectedConnectionCalls = [];
+
+        /**
+         * @param {string} sClientId The id of a client.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        constructor (sClientId) {
+            this.#sId = sClientId;
+        }
+
+        /**
+         * Sets the client connection callback.
+         * @param {sap.ushell.services.MessageBroker.ClientConnectionCallback} fnCallback The callback function to be called on client connection.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        setClientConnectionCallback (fnCallback) {
+            this.#fnClientConnectionCallback = fnCallback;
+        }
+
+        /**
+         * Subscribes to a channel.
+         * @param {string} sChannelId The id of the channel to subscribe to.
+         * @param {sap.ushell.services.MessageBroker.MessageCallback} fnMessageCallback The callback function to be called when a message is received on the channel.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        subscribe (sChannelId, fnMessageCallback) {
+            this.#mChannelSubscriptions.set(sChannelId, fnMessageCallback);
+        }
+
+        /**
+         * Unsubscribes from a channel.
+         * @param {string} sChannelId The id of the channel to unsubscribe from.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        unsubscribe (sChannelId) {
+            this.#mChannelSubscriptions.delete(sChannelId);
+        }
+
+        /**
+         * Gets the message callback for a channel.
+         * @param {string} sChannelId The id of the channel to get the callback for.
+         * @returns {sap.ushell.services.MessageBroker.MessageCallback} The message callback for the channel, or undefined if not subscribed.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        getMessageCallback (sChannelId) {
+            return this.#mChannelSubscriptions.get(sChannelId);
+        }
+
+        /**
+         * Calls the client connection callback if it exists, otherwise collects the arguments for later use.
+         * @param  {...any} args The arguments to pass to the callback.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        callClientConnectionCallback (...args) {
+            if (!this.#fnClientConnectionCallback) {
+                this.#aCollectedConnectionCalls.push(args);
+                return;
+            }
+
+            this.#fnClientConnectionCallback(...args);
+        }
+
+        /**
+         * Applies any previously collected client connection calls.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        applyPreviousConnectionCalls () {
+            if (!this.#fnClientConnectionCallback) {
+                return;
+            }
+
+            this.#aCollectedConnectionCalls.forEach((args) => {
+                this.#fnClientConnectionCallback(...args);
+            });
+            this.#aCollectedConnectionCalls = [];
+        }
+    }
+
+    return Client;
+});