@sapui5/sap.ushell_abap 1.104.0 → 1.106.0

package/README.md

@@ -1,7 +1,7 @@
 ![SAPUI5](https://ui5.sap.com/resources/sap/ui/documentation/sdk/images/Logo_B_SAPUI5_H.png)
 
 # @sapui5/sap.ushell_abap
-Runtime resources of the [SAPUI5](https://sapui5.hana.ondemand.com) Library **sap.ushell_abap**.
+Runtime resources of the [SAPUI5](https://ui5.sap.com) Library **sap.ushell_abap**.
 
 ## Usage
 Refrain from installing this package using npm, Yarn or similar package managers.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sapui5/sap.ushell_abap",
-    "version": "1.104.0",
+    "version": "1.106.0",
     "description": "SAPUI5 Library sap.ushell_abap",
     "homepage": "https://sap.github.io/ui5-tooling/pages/SAPUI5/",
     "keywords": [

package/src/main/js/sap/ushell_abap/.library

@@ -2,7 +2,7 @@
 <library xmlns="http://www.sap.com/sap.ui.library.xsd">
     <name>sap.ushell_abap</name>
     <vendor>SAP SE</vendor>
-    <version>1.104.0</version>
+    <version>1.106.0</version>
     <copyright>Copyright (c) 2009-2022 SAP SE, All Rights Reserved</copyright>
     <documentation>SAP library: sap.ushell_abap</documentation>
 
@@ -45,6 +45,8 @@
             <exclude name="sap.ushell_abap.bootstrap.abap" />
             <exclude name="sap.ushell_abap.bootstrap.appruntime-*" />
             <exclude name="sap.ushell_abap.bootstrap.evo.core-*" />
+            <exclude name="sap.ushell_abap.bootstrap.evo.abap" />
+            <exclude name="sap.ushell_abap.bootstrap.evo.abap-dbg" />
         </jsdoc>
         <releasenotes xmlns="http://www.sap.com/ui5/buildext/releasenotes"
             url="../../../test-resources/sap/ushell_abap/relnotes/changes-{major}.{minor}.json"

package/src/main/js/sap/ushell_abap/adapters/abap/AppStateAdapter.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Unified Shell's AppStateAdapter for the ABAP platform.
- * @version 1.104.0
+ * @version 1.106.0
  */
 sap.ui.define([
     "sap/base/util/ObjectPath",

package/src/main/js/sap/ushell_abap/adapters/abap/ClientSideTargetResolutionAdapter.js

@@ -9,7 +9,7 @@
  *     <li>provide the resolveHashFragmentFallback function, a fallback method called by ClientSideTargetResolution service.</li>
  *   </ul>
  *
- * @version 1.104.0
+ * @version 1.106.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

package/src/main/js/sap/ushell_abap/adapters/abap/ConfigurationDefaultsAdapter.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The ConfigurationDefaults adapter for the ABAP platform.
- * @version 1.104.0
+ * @version 1.106.0
  */
 sap.ui.define([
     "sap/ushell_abap/bootstrap/evo/abap.constants",

package/src/main/js/sap/ushell_abap/adapters/abap/ContainerAdapter.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview The Unified Shell's container adapter for the ABAP platform.
  *
- * @version 1.104.0
+ * @version 1.106.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

package/src/main/js/sap/ushell_abap/adapters/abap/LaunchPageAdapter.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's page building adapter for the ABAP platform.
  *
  * @deprecated since 1.100
- * @version 1.104.0
+ * @version 1.106.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/URI",
@@ -57,7 +57,7 @@ sap.ui.define([
             tileIntentSupportException: "tileIntentSupportException"
         };
 
-    // used to load allcatalogs without target mapping chips
+    // used to load allCatalogs without target mapping chips
     var PAGE_ID_WITHOUT_TM = "/UI2/FLPNoActionChip";
 
     /**
@@ -91,6 +91,7 @@ sap.ui.define([
 
         this._oCurrentPageSet = null;
         this._bPageSetFullyLoaded = false;
+        this._aOtherChipsPromises = [];
 
         if (sap.ui2.srvc.contracts.preview.setEnvironmentType) {
             sap.ui2.srvc.contracts.preview.setEnvironmentType("runtime");
@@ -342,11 +343,11 @@ sap.ui.define([
         }
 
         /**
-         * Stores the hidden groups under the existing configuration property of the pageset object
+         * Stores the hidden groups under the existing configuration property of the pageSet object
          * (by overriding the existing value or creating it if not yet exist).
          * A new property is added in order not to damage the existing groups order functionality (i.e. configuration.order).
          *
-         * @param {string[]} aHiddenGruopsIDs The input parameter must be of type array, containing the IDs of the
+         * @param {string[]} aHiddenGroupsIDs The input parameter must be of type array, containing the IDs of the
          *   groups that should be set hidden. In case an empty array is provided all groups should be changed to visible.
          * @returns {object} promise object.
          * @private
@@ -460,13 +461,18 @@ sap.ui.define([
                 // pending. Note: will be used by getTileView
                 oChipInstance._loadingDeferred = new jQuery.Deferred(); // used for KPI tiles and custom tiles
                 oChipInstance.$loadingPromise = oChipInstance._loadingDeferred.promise();
+                that._aOtherChipsPromises.push(new Promise(function (resolve, reject) {
+                    oChipInstance.$loadingPromise
+                        .done(resolve)
+                        .fail(reject);
+                }));
 
                 if (window["sap-ui-debug"] === true) {
                     LaunchPageAdapter.prototype._triggerChipInstanceLoad(oChipInstance);
                 } else {
                     // we don't distinguish KPI tiles from other custom tiles, because the static preload optimization
                     // (sap/fiori/indicator-tiles.js bundle) was only valid for a certain set of old KPI tiles;
-                    // for newer KPI tiles used in S4 the bundle did not contain all depenencies and therefore the optimization led to
+                    // for newer KPI tiles used in S4 the bundle did not contain all dependencies and therefore the optimization led to
                     // even more round trips; in practice, chances are high that the homepage will contain some non-KPI custom tiles,
                     // so core-ext-light will probably be loaded in most cases
                     // see internal BCP 1770271005
@@ -764,7 +770,7 @@ sap.ui.define([
          * It logs an error message if the tile configuration cannot be parsed.
          *
          * @param {sap.ushell_abap.pbServices.ui2.ChipInstance} oChipInstance must not be a stub anymore. Also it's CHIP must not be a stub anymore.
-         * @returns {object} the tile configuration in style of an applauncer
+         * @returns {object} the tile configuration in style of an applauncher
          */
         function getSmartBusinessTileConfiguration (oChipInstance) {
             var oAppLauncherStyleConfig = {},
@@ -825,7 +831,7 @@ sap.ui.define([
             // try Smart Business tile format first, as it should be more likely that those are present
             // than that a custom launcher tile is present.
             // it is avoided to detect if oChipInstance is a Smart Business tile as
-            //   1) it is hard to detect as there are many diffenent types and versions of those
+            //   1) it is hard to detect as there are many different types and versions of those
             //   2) a custom tile may also be based on a Smart Business tile
             oSmartBusinessConfiguration = getSmartBusinessTileConfiguration(oChipInstance);
             if (oSmartBusinessConfiguration.navigation_use_semantic_object) {
@@ -1274,10 +1280,10 @@ sap.ui.define([
                             });
 
                         /*
-                        In spaces mode we will create an empty page inside an empty pageset.
+                        In spaces mode we will create an empty page inside an empty pageSet.
                         This is needed because the appfinder and search integration request the classic homepage content which is not available in spaces mode.
-                        For consistency reasons it should then also not be availabe from the search results.
-                        The empty pageset has all needed functions the real pageset has.
+                        For consistency reasons it should then also not be available from the search results.
+                        The empty pageSet has all needed functions the real pageSet has.
                         Functions which should not be used in spaces mode throw an error
                          */
                         if (Config.last("/core/spaces/enabled")) {
@@ -1349,6 +1355,27 @@ sap.ui.define([
             return oGetGroupsDeferred.promise();
         };
 
+        /**
+         * Calls getGroups and waits also for custom and remote tiles to be loaded
+         * @returns {Promise<object[]>} Resolves the result of the getGroups call
+         *
+         * @private
+         * @since 1.105.0
+         */
+        this.getGroupsAndWaitForAllChips = function () {
+            return new Promise(function (resolve, reject) {
+                that.getGroups()
+                    .done(resolve)
+                    .fail(reject);
+            })
+                .then(function (aGroups) {
+                    return Promise.allSettled(that._aOtherChipsPromises)
+                        .then(function () {
+                            return aGroups;
+                        });
+                });
+        };
+
         /**
          * Returns the default group. This is an asynchronous function using a jQuery.Promise.
          * In case of success its <code>done</code> function is called and gets the
@@ -1740,8 +1767,8 @@ sap.ui.define([
          * In case of success its <code>done</code> function is called.
          * In case of error the promise's <code>fail</code> function is called and gets the old title.
          *
-         * @param {string} sTitle the new title of the group
          * @param {object} oGroup the group we need to set the title
+         * @param {string} sNewTitle the new title of the group
          * @returns {object} a jQuery.Promise
          * @since 1.11.0
          */
@@ -1802,7 +1829,7 @@ sap.ui.define([
          * @since 1.11.0
          */
         this.removeTile = function (oGroup, oTile) {
-            var oDeferred = jQuery.Deferred();
+            var oDeferred = new jQuery.Deferred();
 
             oGroup.removeChipInstance(oTile,
                 oDeferred.resolve.bind(oDeferred),
@@ -2160,7 +2187,7 @@ sap.ui.define([
                         var oVisibleContract = oTile.getContract("visible");
 
                         if (oVisibleContract) {
-                            // tile uses visibility contract and sets the latest visibilty
+                            // tile uses visibility contract and sets the latest visibility
                             // NOTE: mEarlyTileVisibilities[sTileId] may be changed after handler was attached
                             oVisibleContract.setVisible(mEarlyTileVisibilities[sTileId]);
                         }
@@ -3126,9 +3153,9 @@ sap.ui.define([
 
         /**
          * Checks the chip by initializing it
-         * @param {obejct} oChipInstance The chipInstance
+         * @param {object} oChipInstance The chipInstance
          *
-         * @returns {Promise<void>} Resolves in case the chip initializes correctly.
+         * @returns {Promise<undefined>} Resolves in case the chip initializes correctly.
          *
          * @since 1.83.0
          * @private
@@ -3272,33 +3299,37 @@ sap.ui.define([
          * @since 1.17.1
          */
         LaunchPageAdapter.prototype._visitBookmarks = function (sUrl, fnVisitor) {
-            var aDeferreds = [],
-                oDeferred = new jQuery.Deferred();
+            var aDeferreds = [];
+            var oDeferred = new jQuery.Deferred();
 
-            that.getGroups().fail(oDeferred.reject.bind(oDeferred)).done(function (aGroups) {
-                var iCount = 0;
-                aGroups.forEach(function (oGroup) {
-                    oGroup.getChipInstances().forEach(function (oChipInstance) {
-                        if (that._isBookmarkFor(oChipInstance, sUrl)) {
-                            iCount += 1;
-                            if (fnVisitor) {
-                                aDeferreds.push(fnVisitor(oChipInstance));
+            that.getGroupsAndWaitForAllChips()
+                .then(function (aGroups) {
+                    var iCount = 0;
+                    aGroups.forEach(function (oGroup) {
+                        oGroup.getChipInstances().forEach(function (oChipInstance) {
+                            if (that._isBookmarkFor(oChipInstance, sUrl)) {
+                                iCount += 1;
+                                if (fnVisitor) {
+                                    aDeferreds.push(fnVisitor(oChipInstance));
+                                }
                             }
-                        }
+                        });
                     });
+                    if (aDeferreds.length === 0) {
+                        oDeferred.resolve(iCount);
+                    } else {
+                        jQuery.when.apply(jQuery, aDeferreds)
+                            .fail(function (sMessage) {
+                                oDeferred.reject(sMessage);
+                            })
+                            .done(function () {
+                                oDeferred.resolve(iCount);
+                            });
+                    }
+                })
+                .catch(function (vError) {
+                    oDeferred.reject(vError.message || vError);
                 });
-                if (aDeferreds.length === 0) {
-                    oDeferred.resolve(iCount);
-                } else {
-                    jQuery.when.apply(jQuery, aDeferreds)
-                        .fail(function (sMessage) {
-                            oDeferred.reject(sMessage);
-                        })
-                        .done(function () {
-                            oDeferred.resolve(iCount);
-                        });
-                }
-            });
             return oDeferred.promise();
         };
 

package/src/main/js/sap/ushell_abap/adapters/abap/MenuAdapter.js

@@ -6,10 +6,13 @@
 
 sap.ui.define([
     "sap/ushell/Config",
-    "sap/base/Log"
-], function (Config, Log) {
+    "sap/base/Log",
+    "sap/ushell/library"
+], function (Config, Log, ushellLibrary) {
     "use strict";
 
+    var ContentNodeType = ushellLibrary.ContentNodeType;
+
     /**
     * Constructs a new instance of the MenuAdapter for the ABAP
     * platform
@@ -68,33 +71,34 @@ sap.ui.define([
     /**
      * Gets the menu entries for the spaces assigned to the user.
      * Handles the MyHomeSpace visibility.
-     * Those menu items and their structure is used for the selection in bookmarking.
+     * Those menu items and their structure are used for the selection in bookmarking.
      * @returns {Promise<MenuEntry[]>} The menu entries, @see sap.ushell.services.menu#MenuEntry
      *
      * @since 1.104.0
      * @private
      */
      MenuAdapter.prototype.getContentNodeEntries = function () {
-        var bHomeAppEnabled = Config.last("/core/homeApp/enabled");
-        var bMyHomeSpaceEnabled = Config.last("/core/spaces/myHome/enabled");
-        var bMyHomeUserEnabled = Config.last("/core/spaces/myHome/userEnabled");
-        var sMyHomeSpaceId = Config.last("/core/spaces/myHome/myHomeSpaceId");
-
         var aMetatagMenu = this._getAssignedSpaces();
-        // only remove myHomeSpace when myHome is enabled and user has disabled it
-        // but always keep myHomeSpace when homeApp is enabled
-        if (!bHomeAppEnabled && bMyHomeSpaceEnabled && !bMyHomeUserEnabled) {
-            for (var i = 0; i < aMetatagMenu.length; i++) {
-                if (aMetatagMenu[i].id === sMyHomeSpaceId) {
-                    aMetatagMenu = aMetatagMenu.slice(1);
-                    break;
-                }
-            }
-        }
+        this._removeMyHomeForContentNodes(aMetatagMenu);
         var aMenuEntries = this._buildMenuEntries(aMetatagMenu);
         return Promise.resolve(aMenuEntries);
     };
 
+    /**
+     * Gets the content nodes for the spaces assigned to the user.
+     * Handles the MyHomeSpace visibility.
+     * @returns {Promise<ContentNode[]>} The content nodes, @see sap.ushell.services.menu#ContentNode
+     *
+     * @since 1.105.0
+     * @private
+     */
+    MenuAdapter.prototype.getContentNodes = function () {
+        var aMetatagMenu = this._getAssignedSpaces();
+        this._removeMyHomeForContentNodes(aMetatagMenu);
+        var aContentNodes = this._buildContentNodes(aMetatagMenu);
+        return Promise.resolve(aContentNodes);
+    };
+
     /**
      * Builds based on the metatags a menu which is accepted by the menu service
      * @param {object[]} aMetatagMenu The menu content from the metatags
@@ -108,15 +112,7 @@ sap.ui.define([
         // having 2nd level sub menu entries for its pages inside if needed
 
         var aMenuEntries = aMetatagMenu
-            .filter(function (oSpace) {
-
-                // No menu entry for a space, if no page assigned
-                if (!oSpace.pages || oSpace.pages.length === 0) {
-                    Log.warning("FLP space " + oSpace.id + " without page omitted in FLP menu.", "", "sap.ushell_abap.adapters.abap.MenuAdapter");
-                    return false;
-                }
-                return true;
-            })
+            .filter(this._isSpaceNotEmpty.bind(null, "FLP menu"))
             .map(function (oSpace) {
                 var oTopMenuEntry = {
                     title: oSpace.title || oSpace.id,
@@ -178,6 +174,84 @@ sap.ui.define([
         return aMenuEntries;
     };
 
+    /**
+     * Builds content nodes based on the assigned spaces metatag data
+     * @param {object[]} aMetatagMenu The assigned spaces and pages from the metatags
+     * @returns {ContentNode[]} The content nodes required by the menu service, @see sap.ushell.services.menu#ContentNode
+     *
+     * @private
+     * @since 1.105.0
+     */
+    MenuAdapter.prototype._buildContentNodes = function (aMetatagMenu) {
+        var aContentNodes = aMetatagMenu
+            .filter(this._isSpaceNotEmpty.bind(null, "content nodes"))
+            .map(function (oSpace) {
+                return {
+                    id: oSpace.id,
+                    label: oSpace.title || oSpace.id,
+                    type: ContentNodeType.Space,
+                    isContainer: false,
+                    children: oSpace.pages.map(function (oPage) {
+                        return {
+                            id: oPage.id,
+                            label: oPage.title || oPage.id,
+                            type: ContentNodeType.Page,
+                            isContainer: true
+                        };
+                    })
+                };
+            });
+
+        return aContentNodes;
+    };
+
+    /**
+     * Filter function that checks if a space is empty to filter it out. Also logs a warning message.
+     * @param {string} sEntityName Name of the entity where the space is filtered out for the warning message
+     * @param {object} oSpace The space to be filtered
+     *
+     * @returns {boolean} true = keep, false = remove
+     *
+     * @private
+     * @since 1.105.0
+     */
+    MenuAdapter.prototype._isSpaceNotEmpty = function (sEntityName, oSpace) {
+        if (!oSpace.pages || oSpace.pages.length === 0) {
+            Log.warning("FLP space " + oSpace.id + " without page omitted in " + sEntityName + ".", "", "sap.ushell_abap.adapters.abap.MenuAdapter");
+            return false;
+        }
+        return true;
+    };
+
+    /**
+     * The backend adds the FLP MyHome space as first space if it is active in the FLP settings.
+     * If the user has deactivated the FLP MyHome in the user settings, the space has to be removed again.
+     * If the custom MyHome is active the home space is not removed.
+     * @param {object[]} aMetatagMenu The assigned spaces and pages from the metatags
+     *
+     * @private
+     * @since 1.105.0
+     */
+    MenuAdapter.prototype._removeMyHomeForContentNodes = function (aMetatagMenu) {
+        var bHomeAppEnabled = Config.last("/core/homeApp/enabled");
+        var bMyHomeSpaceEnabled = Config.last("/core/spaces/myHome/enabled");
+        var bMyHomeUserEnabled = Config.last("/core/spaces/myHome/userEnabled");
+        var sMyHomeSpaceId = Config.last("/core/spaces/myHome/myHomeSpaceId");
+
+        //always keep myHomeSpace when homeApp is enabled
+        if (bHomeAppEnabled) {
+            return;
+        }
+
+        // only remove myHomeSpace when myHome is enabled and user has disabled it
+        if (bMyHomeSpaceEnabled && !bMyHomeUserEnabled) {
+            // if the MyHome space is active it is always in the first position
+            if (aMetatagMenu[0] && aMetatagMenu[0].id === sMyHomeSpaceId) {
+                aMetatagMenu.shift();
+            }
+        }
+    };
+
     /**
      * Gets the menu entries for the pages assigned to the user by querying the
      * content of the meta tag with the name' sap.ushell.assignedSpaces'.

package/src/main/js/sap/ushell_abap/adapters/abap/NavTargetResolutionAdapter.js

@@ -8,7 +8,7 @@
  * service now calls the ClientSideTargetResolution service in the abap
  * platform.
  *
- * @version 1.104.0
+ * @version 1.106.0
  */
 sap.ui.define([], function () {
     "use strict";

package/src/main/js/sap/ushell_abap/adapters/abap/PageBuildingAdapter.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Unified Shell's page building adapter for the ABAP platform.
- * @version 1.104.0
+ * @version 1.106.0
  */
 sap.ui.define([
     "sap/base/util/ObjectPath",