@sapui5/sap.ushell 1.118.0 → 1.119.0

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

@@ -5,7 +5,8 @@
  * This file exposes an API to perform (invoke) Cross Application Navigation for applications.
  * It exposes interfaces to perform a hash change and/or trigger an external navigation.
  *
- * @version 1.118.0
+ * @deprecated since 1.120
+ * @version 1.119.0
  */
 sap.ui.define([
     "sap/ushell/services/AppConfiguration",
@@ -595,7 +596,7 @@ sap.ui.define([
                 return "";
             }
 
-            return ShellNavigation.hrefForExternal(oArgsClone, undefined, oComponent, bAsync);
+            return ShellNavigation.hrefForExternalSync(oArgsClone, undefined, oComponent);
         };
 
         /**
@@ -707,9 +708,9 @@ sap.ui.define([
                 }.bind(this))
                 .then(function (ShellNavigation) {
                     return new Promise(function (resolve, reject) {
-                        ShellNavigation.hrefForExternal(oArgsClone, undefined, oComponent, true)
-                            .done(resolve)
-                            .fail(reject);
+                        ShellNavigation.hrefForExternal(oArgsClone, undefined, oComponent)
+                            .then(resolve)
+                            .catch(reject);
                     });
                 })
                 .catch(function () {
@@ -748,7 +749,7 @@ sap.ui.define([
          * Please note that the behavior of this method is subject to change and therefore it may not yield to the expected results
          * especially on mobile devices where "back" is the previous inner-app state if these are put into the history!
          *
-         * @returns {Promise<void>} A promise which resolves once the back navigation was triggered
+         * @returns {Promise<undefined>} A promise which resolves once the back navigation was triggered
          *
          * @public
          * @alias sap.ushell.services.CrossApplicationNavigation#backToPreviousApp
@@ -770,7 +771,7 @@ sap.ui.define([
          * Navigates back in history the number of given steps if this is supported by the underlying platform.
          * If no argument is provided it will navigate back 1 step.
          *
-         * @param {number} iSteps positive integer representing the steps to go back in the history
+         * @param {int} iSteps positive integer representing the steps to go back in the history
          * @public
          * @alias sap.ushell.services.CrossApplicationNavigation#historyBack
          */
@@ -956,7 +957,7 @@ sap.ui.define([
          *
          * @param {object} [oComponent] an optional UI5 component, used to logically attach a possibly generated app state.
          *
-         * @returns {Promise<void>} A <code>Promise</code> which resolves once the navigation was triggered. The <code>Promise</code> might never reject or resolve
+         * @returns {Promise<undefined>} A <code>Promise</code> which resolves once the navigation was triggered. The <code>Promise</code> might never reject or resolve
          * when an error occurs during the navigation.
          *
          * @since 1.15.0
@@ -1780,36 +1781,38 @@ sap.ui.define([
          * It does not validate whether a URL is valid in general.
          *
          * @param {string} sUrl URL to test
-         * @returns {jQuery.Promise} A <code>jQuery.Deferred</code> object's promise which is resolved if the URL
-         *   is supported and rejected if not. The promise does not return parameters.
+         * @returns {Promise} A Promise which is resolved if the URL is supported and rejected if not. The promise does not return parameters.
          * @since 1.30.0
          * @private
          */
         this.isUrlSupported = function (sUrl) {
-            var oDeferred = new jQuery.Deferred();
-
-            if (typeof sUrl !== "string") {
-                oDeferred.reject();
-                return oDeferred.promise();
-            }
+            return new Promise((resolve, reject) => {
+                if (typeof sUrl !== "string") {
+                    reject();
+                }
 
-            if (UrlParsing.isIntentUrl(sUrl)) {
-                var sHash = UrlParsing.getHash(sUrl);
-                this.isIntentSupported(["#" + sHash])
-                    .done(function (oResult) {
-                        if (oResult["#" + sHash] && oResult["#" + sHash].supported) {
-                            oDeferred.resolve();
-                        } else {
-                            oDeferred.reject();
+                if (UrlParsing.isIntentUrl(sUrl)) {
+                    const sHash = UrlParsing.getHash(sUrl);
+                    const oTarget = {
+                        target: {
+                            shellHash: sHash
                         }
-                    })
-                    .fail(function () {
-                        oDeferred.reject();
-                    });
-            } else {
-                oDeferred.resolve();
-            }
-            return oDeferred.promise();
+                    };
+                    this.isNavigationSupported([oTarget])
+                        .done(oResult => {
+                            if (oResult[0].supported) {
+                                resolve();
+                            } else {
+                                reject();
+                            }
+                        })
+                        .fail(() => {
+                            reject();
+                        });
+                } else {
+                    resolve();
+                }
+            });
         };
 
         /**
@@ -2273,7 +2276,7 @@ sap.ui.define([
          * Method to set or modify the AppState's persistency method of a state identified by key
          *
          * @param {string} sKey the AppState key
-         * @param {number} iPersistencyMethod The chosen persistency method
+         * @param {int} iPersistencyMethod The chosen persistency method
          * @param {object} oPersistencySettings The additional settings PersistencySettings
          *
          * @returns {jQuery.Promise<string>} A promise which resolves a new key

package/src/main/js/sap/ushell/services/DarkModeSupport.js

@@ -5,7 +5,7 @@
  *
  * The service provide dark mode support functionality
  *
- * @version 1.118.0
+ * @version 1.119.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -30,7 +30,7 @@ sap.ui.define([
      * Dark Mode service.
      *
      * @name sap.ushell.services.DarkModeSupport
-     * @constructor
+     * @class
      * @since 1.72.0
      * @private
      */

package/src/main/js/sap/ushell/services/EndUserFeedback.js

@@ -52,7 +52,7 @@ sap.ui.define([
         /**
          * The service is deprecated. The function always returns a negative answer.
          *
-         * @returns {Object} Rejected promise
+         * @returns {object} Rejected promise
          * @public
          * @alias sap.ushell.services.EndUserFeedback#isEnabled
          * @since 1.25.1
@@ -63,7 +63,7 @@ sap.ui.define([
         };
 
         /**
-         * @param {String} sURL sURL
+         * @param {string} sURL sURL
          * @returns {string} Path of the given URL (based on URI-API)
          * @private
          * @since 1.30.0

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

@@ -2,7 +2,7 @@
 
 /**
  * @file The Unified Shell's page builder service providing the data for the Fiori launchpad's classic Homepage.
- * @version 1.118.0
+ * @version 1.119.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -45,7 +45,6 @@ sap.ui.define([
      *
      * @param {object} oAdapter the page builder adapter for the logon system
      * @param {object} oContainerInterface the interface provided by the container
-     * @constructor
      * @see sap.ushell.services.Container#getServiceAsync
      * @since 1.15.0
      * @deprecated since 1.99. This service has been deprecated as it only works for the classic homepage.
@@ -872,7 +871,7 @@ sap.ui.define([
          *
          * Use <code>Function.prototype.bind()</code> to determine the callback's <code>this</code> or some of its arguments.
          *
-         * @param {Object} fnProvider A callback which returns an array of action objects.
+         * @param {object} fnProvider A callback which returns an array of action objects.
          * @public
          * @deprecated since 1.99. This feature has been deprecated with the classic homepage. There is no alternative with spaces and pages.
          * @alias sap.ushell.services.LaunchPage#registerTileActionsProvider
@@ -1118,18 +1117,20 @@ sap.ui.define([
          * Returns the UI5 view or control  of a catalog tile
          *
          * @param {object} oCatalogTile The catalog tile
+         * @param {boolean} [bPreview] SAP-internal: Whether the tile should be displayed in preview mode
          * @returns {object} jQuery.deferred.promise object that when resolved, returns the Catalog Tile View
          * @public
          * @alias sap.ushell.services.LaunchPage#getCatalogTileViewControl
          */
-        this.getCatalogTileViewControl = function (oCatalogTile) {
+        this.getCatalogTileViewControl = function (oCatalogTile, bPreview) {
+            // bPreview is only implemented on the abap platform
             var sAdapterName = oCatalogTile && oCatalogTile.contentProvider;
             var oLaunchpageAdapter = this._getAdapter(sAdapterName);
             if (typeof oLaunchpageAdapter.getCatalogTileViewControl === "function") {
-                return oLaunchpageAdapter.getCatalogTileViewControl(oCatalogTile);
+                return oLaunchpageAdapter.getCatalogTileViewControl(oCatalogTile, bPreview);
             }
             var oDeferred = new jQuery.Deferred();
-            var oResult = this.getCatalogTileView(oCatalogTile);
+            var oResult = this.getCatalogTileView(oCatalogTile, bPreview);
 
             oDeferred.resolve(oResult);
             return oDeferred.promise();
@@ -1139,12 +1140,14 @@ sap.ui.define([
          * Returns the UI5 view or control  of a catalog tile
          *
          * @param {object} oCatalogTile The catalog tile
+         * @param {boolean} [bPreview] SAP-internal: Whether the tile should be displayed in preview mode
          * @returns {object} UI5 view or control
          * @public
          * @alias sap.ushell.services.LaunchPage#getCatalogTileView
          * @deprecated since 1.48. Please use {@link #getCatalogTileViewControl} instead.
          */
-        this.getCatalogTileView = function (oCatalogTile) {
+        this.getCatalogTileView = function (oCatalogTile, bPreview) {
+            // bPreview is only implemented on the abap platform
             Log.error("Deprecated API call of 'sap.ushell.LaunchPage.getCatalogTileView'. Please use 'getCatalogTileViewControl' instead",
                 null,
                 "sap.ushell.services.LaunchPage"
@@ -1152,7 +1155,7 @@ sap.ui.define([
             var sAdapterName = oCatalogTile && oCatalogTile.contentProvider;
             var oLaunchpageAdapter = this._getAdapter(sAdapterName);
             if (oLaunchpageAdapter.getCatalogTileView) {
-                return oLaunchpageAdapter.getCatalogTileView(oCatalogTile);
+                return oLaunchpageAdapter.getCatalogTileView(oCatalogTile, bPreview);
             }
             var sTitle = this.getTileTitle(oCatalogTile) || this.getCatalogTileTitle(oCatalogTile);
             return this._createErrorTile(sTitle, "The LaunchPageAdapter does not support getCatalogTileView");

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The menu service provides the entries for the menu bar
- * @version 1.118.0
+ * @version 1.119.0
  */
 sap.ui.define([
     "sap/ushell/Config",
@@ -32,7 +32,7 @@ sap.ui.define([
      * Constructs a new instance of the menu service.
      *
      * @namespace sap.ushell.services.Menu
-     * @constructor
+     * @class
      * @see sap.ushell.services.Container#getServiceAsync
      * @since 1.71.0
      * @private
@@ -97,6 +97,7 @@ sap.ui.define([
             .then(function (aMenuEntries) {
                 if (Config.last("/core/homeApp/enabled")) {
                     var oHomeAppEntry = {
+                        id: Config.last("/core/spaces/myHome/myHomeSpaceId"),
                         title: resources.i18n.getText("HomeApp.Menu.Title"),
                         "help-id": "homeApp-menuEntry",
                         description: "",
@@ -299,46 +300,39 @@ sap.ui.define([
      * @since 1.105.0
      * @private
      */
-    Menu.prototype.getDefaultSpace = function () {
+    Menu.prototype.getDefaultSpace = async function () {
+        const aContentNodes = await this.getContentNodes([ContentNodeType.Space, ContentNodeType.Page]);
         if (Config.last("/core/menu/personalization/enabled")) {
-            return Promise.all([
-                this.getMenuModel(),
-                this.getContentNodes([ContentNodeType.Space, ContentNodeType.Page])
-            ])
-                .then(function (aResult) {
-                    var oModel = aResult[0];
-                    var aContentNodes = aResult[1];
-
-                    //use of pinnedSortOrder property to find default space
-                    // Pinned sort order is always defined.
-                    var oFirstPersonalizedSpace =
-                        oModel.getData()
-                            .filter(function filterOutTheSeparatorAndTheUnpinnedMenuEntries (oMenuEntry) {
-                                return oMenuEntry.type !== "separator" && oMenuEntry.pinned;
-                            })
-                            .filter(function filterOutEmptySpaces (oMenuEntry) {
-                                return aContentNodes.some(function testForSpaceWithAtLeastOnePage (oContentNode) {
-                                    return oMenuEntry.id === oContentNode.id && oContentNode.children.length;
-                                });
-                            })
-                            .reduce(function chooseSpaceWithLowerSortOrder (oCurrentMinimalMenuEntry, oCurrentMenuEntry) {
-                                return oCurrentMinimalMenuEntry.pinnedSortOrder < oCurrentMenuEntry.pinnedSortOrder ? oCurrentMinimalMenuEntry : oCurrentMenuEntry;
-                            }, {});
+            const oMenuModel = await this.getMenuModel();
+
+                //use of pinnedSortOrder property to find default space
+                // Pinned sort order is always defined.
+                const oFirstPersonalizedSpace = oMenuModel.getData()
+                        .filter(function filterOutTheSeparatorAndTheUnpinnedMenuEntries (oMenuEntry) {
+                            return oMenuEntry.type !== "separator" && oMenuEntry.pinned;
+                        })
+                        .filter(function filterOutEmptySpaces (oMenuEntry) {
+                            return aContentNodes.some(function testForSpaceWithAtLeastOnePage (oContentNode) {
+                                return oMenuEntry.id === oContentNode.id && oContentNode.children.length;
+                            });
+                        })
+                        .reduce(function chooseSpaceWithLowerSortOrder (oCurrentMinimalMenuEntry, oCurrentMenuEntry) {
+                            return oCurrentMinimalMenuEntry.pinnedSortOrder < oCurrentMenuEntry.pinnedSortOrder ? oCurrentMinimalMenuEntry : oCurrentMenuEntry;
+                        }, {});
 
-                    var oNonEmptySpace = aContentNodes.find(function findContentNodeForMenuEntry (oContentNode) {
-                        return oFirstPersonalizedSpace.id === oContentNode.id;
-                    });
-                    return oNonEmptySpace;
+                const oNonEmptyPersonalizedSpace = aContentNodes.find(function findContentNodeForMenuEntry (oContentNode) {
+                    return oFirstPersonalizedSpace.id === oContentNode.id;
                 });
+                if (oNonEmptyPersonalizedSpace) {
+                    return oNonEmptyPersonalizedSpace;
+                }
+                // if no space is pinned fallback to content nodes
         }
 
-        return this.getContentNodes([ContentNodeType.Space, ContentNodeType.Page])
-            .then(function (aContentNodes) {
-                var oNonEmptySpace = aContentNodes.find(function (oContentNode) {
-                    return oContentNode.children.length;
-                });
-                return oNonEmptySpace;
-            });
+        const oNonEmptySpace = aContentNodes.find(function (oContentNode) {
+            return oContentNode.children.length;
+        });
+        return oNonEmptySpace;
     };
 
     /**

package/src/main/js/sap/ushell/services/Message.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Unified Shell's message service.
- * @version 1.118.0
+ * @version 1.119.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -53,7 +53,6 @@ sap.ui.define([
      * Message service.
      *
      * @name sap.ushell.services.Message
-     * @constructor
      * @class
      * @see sap.ushell.services.Container#getServiceAsync
      * @since 1.16.0

package/src/main/js/sap/ushell/services/MessageBroker.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module exposes API enpoints for Generic Communication
- * @version 1.118.0
+ * @version 1.119.0
  */
 sap.ui.define([
     "sap/ushell/services/_MessageBroker/MessageBrokerEngine",
@@ -17,7 +17,6 @@ sap.ui.define([
      *
      * @namespace sap.ushell.services.MessageBroker
      *
-     * @constructor
      * @class
      * @see {@link sap.ushell.services.Container#getServiceAsync}
      * @since 1.72.0

package/src/main/js/sap/ushell/services/NavTargetResolution.js

@@ -448,11 +448,12 @@ sap.ui.define([
                         .done(function (oResult) {
                             this._adjustResolutionResultForUi5Components(oResult);
 
-                            // Add navigation mode if it's not already there
-                            if (isPlainObject(oResult)) {
+                            if (oResult && oResult.navigationMode !== undefined) {
                                 oResult.targetNavigationMode = NavigationMode.getExternalNavigationMode(
                                     oResult.navigationMode
                                 );
+                            } else {
+                                Log.error("Resolution Result doesn't contain mandatory navigationMode!", "sap.ushell.services.NavTargetResolution");
                             }
 
                             // add a sap-system if not already there
@@ -659,17 +660,17 @@ sap.ui.define([
 
                     sap.ushell.Container.getServiceAsync("ShellNavigation")
                         .then(function (ShellNavigationService) {
-                            ShellNavigationService.hrefForExternal(oHrefForExternalArg, true, oComponent, true)
-                                .done(function (oResVerboseCompacted) {
+                            ShellNavigationService.hrefForExternal(oHrefForExternalArg, true, oComponent)
+                                .then(function (oResVerboseCompacted) {
                                     // may contain sap-intent-param (but server does nothing with it)
                                     var oMaybeCompactedParameters = oResVerboseCompacted.params || oParameters;
 
                                     fnResolverBound(sSemanticObject, oMaybeCompactedParameters, bIgnoreFormFactor)
-                                        .done(fnHandleGetLinksSuccess)
-                                        .fail(oDeferred.reject);
+                                        .then(fnHandleGetLinksSuccess)
+                                        .catch(oDeferred.reject);
 
                                 })
-                                .fail(oDeferred.reject);
+                                .catch(oDeferred.reject);
                         });
                 } else {
                     // 'this' in fnResolverBound will be client side target resolution
@@ -875,12 +876,60 @@ sap.ui.define([
             return oDeferred.resolve(mResult).promise();
         };
 
+        /**
+         * Tells whether the given intent(s) are supported, taking into account the form factor of the current device.
+         * "Supported" means that navigation to the intent is possible.
+         *
+         * @param {string[]} aIntents the intents (such as <code>"#AnObject-action?A=B&C=e&C=j"</code>) to be checked.
+         *   The intents must be in internal format and expanded.
+         * @returns {jQuery.Promise} A jQuery Promise which is resolved with a map
+         *   containing the intents from <code>aIntents</code> as keys.
+         *   The map values are objects with a property <code>supported</code> of type <code>boolean</code>.<br/>
+         *   Example:
+         *   <pre>
+         *   {
+         *     "#AnObject-action?A=B&C=e&C=j": { supported: false },
+         *     "#AnotherObject-action2": { supported: true }
+         *   }
+         *   </pre>
+         * @private
+         *
+         */
+        this._isIntentSupported = function (aIntents) {
+            var mResult = {};
+            var oDeferred = new jQuery.Deferred();
+
+            if (this._isClientSideTargetResolutionEnabled()) {
+                // NOTE: request ClientSideTargetResolution service only if enabled!
+                sap.ushell.Container.getServiceAsync("ClientSideTargetResolution")
+                    .then(function (ClientSideTargetResolutionService) {
+                        ClientSideTargetResolutionService.isIntentSupported(aIntents)
+                            .done(oDeferred.resolve)
+                            .fail(oDeferred.reject);
+                    })
+                    .catch(oDeferred.reject);
+
+                return oDeferred.promise();
+            }
+
+            // Adapter based implementation
+            if (oAdapter.isIntentSupported) {
+                return oAdapter.isIntentSupported(aIntents);
+            }
+
+            // Fallback for no adapter available
+            aIntents.forEach(function (sIntent) {
+                mResult[sIntent] = { supported: undefined };
+            });
+            return oDeferred.resolve(mResult).promise();
+        };
+
         /**
          * Tells whether the given navigation intent(s) are supported for the given parameters
          * Supported" means that a valid navigation target is configured for the user for the given device form factor.
          *
          * This is effectively a test function for {@link toExternal}/ {@link hrefForExternal}.
-         * It is functionally equivalent to {@link isIntentSupported} but accepts the same input as {@link toExternal}/ {@link hrefForExternal}.
+         * It function accepts the same input as {@link toExternal}/ {@link hrefForExternal}.
          *
          * @param {object[]} aIntents the intents (such as <code>["#AnObject-action?A=B&c=e"]</code>) to be checked
          *   with object being instances the oArgs object of toExternal, hrefForExternal etc.
@@ -967,7 +1016,7 @@ sap.ui.define([
                 }
                 return "#" + UrlParsing.constructShellHash(oArg);
             });
-            this.isIntentSupported(aIntentsAsString).done(function (oResult) {
+            this._isIntentSupported(aIntentsAsString).done(function (oResult) {
                 var aResults = aIntentsAsString.map(function (sIntent) { return oResult[sIntent] || { supported: false }; });
                 oDeferred.resolve(aResults);
             }).fail(oDeferred.reject.bind(oDeferred));