@sapui5/sap.ushell 1.140.0 → 1.141.0

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

@@ -227,12 +227,13 @@ sap.ui.define([
                 const sAppId = oApplication.sId || "<unknown>";
                 try {
                     oApplication.destroy();
-                } catch (e) {
-                    Log.error(`exception when trying to close sapui5 application with id '${sAppId
-                    }' when running inside the appruntime iframe '${document.URL
-                    }'. This error must be fixed in order for the iframe to operate properly.\n`,
-                    e.stack,
-                    "sap.ushell.appRuntime.ui5.services.AppLifeCycleAgent::destroy");
+                } catch (oError) {
+                    Log.error(
+                        // eslint-disable-next-line max-len
+                        `exception when trying to close sapui5 application with id '${sAppId}' when running inside the appruntime iframe '${document.URL}'. This error must be fixed in order for the iframe to operate properly.\n`,
+                        oError,
+                        "sap.ushell.appRuntime.ui5.services.AppLifeCycleAgent::destroy"
+                    );
                 }
             }
 

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

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

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The app runtime wrapper for {@link sap.ushell.services.Bookmark}.
  *
- * @version 1.140.0
+ * @version 1.141.0
  * @deprecated since 1.120. Use {@link sap.ushell.services.BookmarkV2} instead.
  */
 sap.ui.define([
@@ -50,10 +50,10 @@ sap.ui.define([
             if (oParameters.url.startsWith("#")) {
                 AppRuntimeContext.checkIntentsConversionForScube([{ intent: oParameters.url }]).then((aIntentResult) => {
                     oParameters.url = aIntentResult[0].intent;
-                    fnAddBookmark().then(oDeferred.resolve, oDeferred.reject);
+                    fnAddBookmark().then(oDeferred.resolve).catch(oDeferred.reject);
                 });
             } else {
-                fnAddBookmark().then(oDeferred.resolve, oDeferred.reject);
+                fnAddBookmark().then(oDeferred.resolve).catch(oDeferred.reject);
             }
 
             return oDeferred.promise();

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

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

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

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

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

@@ -3,15 +3,17 @@
 /**
  * @fileOverview The app runtime wrapper for {@link sap.ushell.Container}.
  *
- * @version 1.140.0
+ * @version 1.141.0
  */
 sap.ui.define([
     "sap/ushell/Container",
     "sap/ushell/appRuntime/ui5/AppCommunicationMgr",
+    "sap/ushell/utils",
     "sap/base/assert"
 ], function (
     Container,
     AppCommunicationMgr,
+    ushellUtils,
     assert
 ) {
     "use strict";
@@ -33,13 +35,13 @@ sap.ui.define([
     Container.runningInIframe = this.inAppRuntime;
 
     Container.getFLPUrl = function (bIncludeHash) {
-        return AppCommunicationMgr.sendMessageToOuterShell("sap.ushell.services.Container.getFLPUrl", {
+        return AppCommunicationMgr.postMessageToFLP("sap.ushell.services.Container.getFLPUrl", {
             bIncludeHash: bIncludeHash
         });
     };
 
     Container.getFLPUrlAsync = function (bIncludeHash) {
-        return this.getFLPUrl(bIncludeHash);
+        return ushellUtils.toDeferred(this.getFLPUrl(bIncludeHash));
     };
 
     /**

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.140.0
+ * @version 1.141.0
  * @deprecated since 1.120. Use {@link sap.ushell.services.Navigation} instead.
  */
 sap.ui.define([
@@ -73,44 +73,101 @@ sap.ui.define([
             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);
+                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);
+                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();

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Defines a generic interface for extension items in ShellAreas.
  *
- * @version 1.140.0
+ * @version 1.141.0
  */
 sap.ui.define([
     "sap/ushell/appRuntime/ui5/AppCommunicationMgr"

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The app runtime wrapper for {@link sap.ushell.services.Extension}.
  *
- * @version 1.140.0
+ * @version 1.141.0
  */
 sap.ui.define([
     "sap/base/Log",

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.140.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.140.0
+ * @version 1.141.0
  */
 sap.ui.define([
 ], (

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The app runtime wrapper for {@link sap.ushell.services.LaunchPage}.
  *
- * @version 1.140.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([

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;
+});