@sapui5/sap.ushell 1.113.0 → 1.114.1

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.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/ushell/Config",
@@ -51,8 +51,9 @@ sap.ui.define([
      */
     Menu.prototype._init = function (adapter) {
         this.oAdapter = adapter;
-        this.oModel = new JSONModel();
+        this.oModel = new JSONModel([]);
         this.oModel.setSizeLimit(1000); // At least one customer works with a composite role with more than 200 pages.
+        this.bIsMenuModelFilled = false;
         this._aBlockedList = [];
     };
 
@@ -91,7 +92,7 @@ sap.ui.define([
      * @since 1.71.0
      * @private
      */
-     Menu.prototype.getMenuEntries = function () {
+    Menu.prototype.getMenuEntries = function () {
         return this.oAdapter.getMenuEntries()
             .then(function (aMenuEntries) {
                 if (Config.last("/core/homeApp/enabled")) {
@@ -107,6 +108,7 @@ sap.ui.define([
                             parameters: [],
                             innerAppRoute: undefined
                         },
+                        isHomeEntry: true,
                         menuEntries: []
                     };
                     aMenuEntries.splice(0, 0, oHomeAppEntry);
@@ -132,7 +134,7 @@ sap.ui.define([
 
     /**
      * @typedef {object} SpacePagesHierarchyEntry
-     *    An entry in the space-spages-hierarchy which briefly describes a space and its pages
+     *    An entry in the space-pages-hierarchy which briefly describes a space and its pages
      * @property {string} title Text of the space
      * @property {string} id ID of the space
      * @property {array} pages
@@ -146,7 +148,7 @@ sap.ui.define([
      * when a user is about to pin an app on a page in a space.
      *
      * For performance reasons the promise response of <code>Menu.prototype.getSpacesPagesHierarchy</code>
-     * is cached, similiar to <code>Menu.prototype.getMenuEntries</code>. As a consequence dynamic
+     * is cached, similar to <code>Menu.prototype.getMenuEntries</code>. As a consequence dynamic
      * menus and a dynamic changing of the spaces/pages structure, e.g. in a design time scenario,
      * is not supported.
      *
@@ -282,7 +284,15 @@ sap.ui.define([
     };
 
     /**
-     * Returns the first non-empty page and its space assigned to the user.
+     * Gets the Default space.
+     *
+     * In case menu personalization is enabled:
+     * Returns the space that has got a page and has been pinned by the user and has the lowest sort order.
+     *
+     * In case personalization is disabled:
+     * Returns the first space that has got a page.
+     *
+     * Returns undefined if no suitable space is available.
      * @see #getContentNodes
      * @returns {Promise<object>} Resolves to the first space.
      *
@@ -290,12 +300,45 @@ sap.ui.define([
      * @private
      */
     Menu.prototype.getDefaultSpace = function () {
-        return this.getContentNodes([ContentNodeType.Space, ContentNodeType.Page]).then(function (aContentNodes) {
-            var oNonEmptySpace = aContentNodes.find(function (oContentNode) {
-                return oContentNode.children.length;
+        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;
+                            }, {});
+
+                    var oNonEmptySpace = aContentNodes.find(function findContentNodeForMenuEntry (oContentNode) {
+                        return oFirstPersonalizedSpace.id === oContentNode.id;
+                    });
+                    return oNonEmptySpace;
+                });
+        }
+
+        return this.getContentNodes([ContentNodeType.Space, ContentNodeType.Page])
+            .then(function (aContentNodes) {
+                var oNonEmptySpace = aContentNodes.find(function (oContentNode) {
+                    return oContentNode.children.length;
+                });
+                return oNonEmptySpace;
             });
-            return oNonEmptySpace;
-        });
     };
 
     /**
@@ -429,23 +472,217 @@ sap.ui.define([
                     });
                 }
                 if (oPage) {
-                    return {spaceTitle: oSpace.label, pageTitle: oPage.label};
+                    return { spaceTitle: oSpace.label, pageTitle: oPage.label };
                 }
                 return null;
             }
-        );
+            );
     };
 
     /**
-     * Returns the model attached to the MenuBar UI.
+     * Returns the model attached to the navigation bar UI.
+     * if menu personalization is enabled the data of the model,
+     * contains the menu entries enriched by personalization data.
      *
      * @returns {Promise<sap.ui.model.json.JSONModel>} Resolves to the JSONModel attached to the UI.
      */
     Menu.prototype.getMenuModel = function () {
-        return this.getMenuEntries().then(function (entries) {
-            this.oModel.setData(entries);
-            return this.oModel;
-        }.bind(this));
+        if (this.bIsMenuModelFilled) {
+            return Promise.resolve(this.oModel);
+        }
+
+        var oMenuEntriesPromise;
+        if (Config.last("/core/menu/personalization/enabled")) {
+            oMenuEntriesPromise = this._getMenuEntriesWithPersonalizationData();
+        } else {
+            oMenuEntriesPromise = this.getMenuEntries();
+        }
+
+        return oMenuEntriesPromise
+            .then(function (entries) {
+                var aMenuEntries = entries;
+                this.oModel.setData(aMenuEntries);
+                this.bIsMenuModelFilled = true;
+                return this.oModel;
+            }.bind(this));
+    };
+
+    /** Returns menu entries including personalization Data
+     *  separator and home entry if configured.
+     *  Personalization Data is pinned sort order, and the pinned property
+     *  The order of array that is returned represents the order of all menu entries
+     * @returns {object[]} nodes The array of nodes and their children.
+     * @since 1.114.0
+     */
+    Menu.prototype._getMenuEntriesWithPersonalizationData = function () {
+        return Promise.all([
+            this.getMenuEntries(),
+            this.oAdapter.getMenuPersonalization()
+        ])
+            .then(function (oResult) {
+                var aMenuEntries = oResult[0];
+                var oMenuPersonalization = oResult[1];
+                var aPersonalizedMenuEntries;
+
+                // The navigation bar items are created via data binding therefore the separator,
+                // has to be in the model as well.
+                var oSeparator = {
+                    type: "separator",
+                    pinned: true
+                };
+                if (aMenuEntries[0].isHomeEntry) {
+                    aMenuEntries.splice(1, 0, oSeparator);
+                } else {
+                    aMenuEntries.splice(0, 0, oSeparator);
+                }
+
+                if (!oMenuPersonalization) {
+                    // If there is no personalization yet, initially all the spaces are displayed as pinned.
+                    aPersonalizedMenuEntries = aMenuEntries.map(function addPinnedPropertyAndSortOrder (oMenuEntry, iIndex) {
+                        oMenuEntry.pinned = true;
+                        oMenuEntry.pinnedSortOrder = iIndex;
+                        return oMenuEntry;
+                    });
+                } else {
+                    // The personalization does not contain the MyHome entry and the separator
+                    // therefore the index of the of the pinned spaces has to be adapted accordingly.
+                    var iIndexOffset = 1;
+                    if (aMenuEntries[0].isHomeEntry) {
+                        iIndexOffset = 2;
+                    }
+                    // Adds the pinned property and the pinned propery sort order.
+                    // unpinned entries get sort order -1
+                    aPersonalizedMenuEntries = aMenuEntries.map(function addPinnedPropertyAndSortOrder (oMenuEntry) {
+                        oMenuEntry.pinned = oMenuPersonalization.pinnedSpaces.includes(oMenuEntry.id);
+                        oMenuEntry.pinnedSortOrder = oMenuPersonalization.pinnedSpaces.indexOf(oMenuEntry.id);
+                        if (oMenuEntry.pinnedSortOrder > -1) {
+                            oMenuEntry.pinnedSortOrder = oMenuEntry.pinnedSortOrder + iIndexOffset;
+                        }
+                        return oMenuEntry;
+                    });
+
+                    // Set the MyHome entry and the separator to be pinned.
+                    aMenuEntries[0].pinned = true;
+                    aMenuEntries[0].pinnedSortOrder = 0;
+                    if (aMenuEntries[0].isHomeEntry) {
+                        aMenuEntries[1].pinned = true;
+                        aMenuEntries[1].pinnedSortOrder = 1;
+                    }
+                }
+                return aPersonalizedMenuEntries;
+            });
+    };
+
+    /**
+     * Extracts the pinned spaces and sorts them ascending according to the pinned sort order.
+     * @returns {string[]} aPinnedSpaceIds keys of pinned spaces
+     * @since 1.114.0
+     */
+    Menu.prototype._extractPersonalization = function () {
+        var oMenuPersonalization = {
+            version: "1.0.0",
+            pinnedSpaces: []
+        };
+
+        var aMenuEntriesWithPersonalizationData = this.oModel.getData();
+
+        oMenuPersonalization.pinnedSpaces = aMenuEntriesWithPersonalizationData
+            .filter(function filterOutHomeEntryAndSeparatorAndUnpinned (oMenuEntry) {
+                return !oMenuEntry.isHomeEntry && oMenuEntry.type !== "separator" && oMenuEntry.pinned;
+            }).sort(function (oMenuEntryA, oMenuEntryB) {
+                return oMenuEntryA.pinnedSortOrder - oMenuEntryB.pinnedSortOrder;
+            }).map(function (oMenuEntry) {
+                return oMenuEntry.id;
+            });
+
+        return oMenuPersonalization;
+    };
+
+    /**
+     * Saves the personalization data
+     * @returns {Promise} Resolved when saved successfully, rejected if saving fails
+     * @since 1.114.0
+     */
+    Menu.prototype.savePersonalization = function () {
+        var oMenuPersonalizationData = this._extractPersonalization();
+
+        return sap.ushell.Container.getServiceAsync("Personalization")
+            .then(function (oPersonalizationService) {
+                var oPersId;
+
+                oPersId = {
+                    container: "sap.ushell.menuPersonalization",
+                    item: "data"
+                };
+
+                // The data is read from the metatags which dos not use any cachebuster tokens.
+                var oScope = {
+                    validity: "Infinity",
+                    keyCategory: oPersonalizationService.constants.keyCategory.FIXED_KEY,
+                    writeFrequency: oPersonalizationService.constants.writeFrequency.HIGH,
+                    clientStorageAllowed: false
+                };
+
+                return new Promise(function (resolve, reject) {
+                    oPersonalizationService.getPersonalizer(oPersId, oScope).setPersData(oMenuPersonalizationData)
+                        .done(resolve)
+                        .fail(reject);
+                });
+            });
+    };
+
+    /**
+     * Moves a menu entry in the menu model from a source index to a target index.
+     *
+     * @param {int} iSourceIndex index of the menu entry that shall be moved
+     * @param {int} iTargetIndex target index for the menu entry
+     *
+     * @since 1.115.0
+     * @private
+     */
+    Menu.prototype.moveMenuEntry = function (iSourceIndex, iTargetIndex) {
+        var aMenuEntries = this.oModel.getData();
+        var oMenuEntryToMove = aMenuEntries.find(function (oMenuEntry) {
+            return oMenuEntry.pinnedSortOrder === iSourceIndex;
+        });
+        oMenuEntryToMove.pinnedSortOrder = iTargetIndex - 0.5;
+        aMenuEntries.map(function (oMenuEntry) {
+            // create a shallow copy of the array so that the following array functions
+            // don't change the original one
+            return oMenuEntry;
+        }).filter(function (oMenuEntry) {
+            return oMenuEntry.pinned;
+        }).sort(function (oMenuEntryA, oMenuEntryB) {
+            return oMenuEntryA.pinnedSortOrder - oMenuEntryB.pinnedSortOrder;
+        }).forEach(function (oMenuEntry, iIndex) {
+            oMenuEntry.pinnedSortOrder = iIndex;
+        });
+        this.oModel.refresh(true);
+    };
+
+    /**
+     * Checks if a space is pinned.
+     *
+     * @param {string} sSpaceId
+     *   The ID of the space to check
+     * @returns {Promise<boolean>}
+     *   The promise resolves to true if the space is pinned and false if it is not pinned.
+     *   The promise always resolves to true if the menu personalization is disabled.
+     *
+     * @since 1.115.0
+     * @private
+     */
+    Menu.prototype.isPinned = function (sSpaceId) {
+        if (Config.last("/core/menu/personalization/enabled") === false) {
+            return Promise.resolve(true);
+        }
+
+        return this.getMenuModel()
+            .then(function (oModel) {
+                return oModel.getData().some(function (oMenuEntry) {
+                    return oMenuEntry.id === sSpaceId && oMenuEntry.pinned;
+                });
+            });
     };
 
     /**

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Unified Shell's message service.
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -2,11 +2,12 @@
 
 /**
  * @fileOverview This module exposes API enpoints for Generic Communication
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
-    "sap/ushell/services/_MessageBroker/MessageBrokerEngine"
-], function (MessageBrokerEngine) {
+    "sap/ushell/services/_MessageBroker/MessageBrokerEngine",
+    "sap/base/Log"
+], function (MessageBrokerEngine, Log) {
     "use strict";
 
     /**
@@ -24,7 +25,22 @@ sap.ui.define([
      * @private
      */
 
-    var MessageBroker = function () {};
+    var oServiceConfig = {};
+
+    var MessageBroker = function (oContainerInterface, sParameters, oServiceConfiguration) {
+        oServiceConfig = oServiceConfiguration && oServiceConfiguration.config || {};
+        MessageBrokerEngine.setEnabled(this.isEnabled());
+        if (!this.isEnabled()) {
+            Log.warning("FLP's message broker service is disabled by shell configuration");
+        }
+    };
+
+    MessageBroker.prototype.isEnabled = function () {
+        if (oServiceConfig.enabled === undefined || oServiceConfig.enabled === true) {
+            return true;
+        }
+        return false;
+    };
 
     /**
      *

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

@@ -4,7 +4,7 @@
  *
  * <p>This module prepares the navigation data needed by the page dereferencer.</p>
  *
- * @version 1.113.0
+ * @version 1.114.1
  */
 
 sap.ui.define([

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's page building service.
  *
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery"

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

@@ -4,7 +4,7 @@
  *
  * <p>This module deals with the page persistence.</p>
  *
- * @version 1.113.0
+ * @version 1.114.1
  */
 
 sap.ui.define([], function () {

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module deals with page related referencing and dereferencing.
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/ushell/services/_PageReferencing/PageReferencer"

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module exposes a model containing the pages hierarchy to its clients.
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's personalization service, which provides generic read and write access to the currently logged on user's
  * personalization settings for the app currently executed in the shell.
  *
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Unified Shell's PluginManager service, which allows you to handle the loading of Fiori Launchpad plugins.
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview resolves references
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Unified Shell's search service which provides Enterprise Search via SINA.
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([], function () {
     "use strict";

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's Search for myHome.
  *
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([], function () {
     "use strict";

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module exposes the searchable content.
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/ushell/Config",

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

@@ -12,7 +12,7 @@
  * it is pertinent that the API user employs this service's version of <code>toExternal()</code> for cross application
  * navigation (instead) of using the one provided by CrossApplicationNavigation service.</p>
  *
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview APIs for the S/4 MyHome
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/ushell/Config",

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

@@ -6,7 +6,7 @@
  * Service wrapper for the sap/ushell/utils/UrlShortening module.
  * Deprecated. Please use the UrlShortening module directly.
  *
- * @version 1.113.0
+ * @version 1.114.1
  */
  sap.ui.define(["sap/ushell/utils/UrlShortening"], function (UrlShortening) {
     "use strict";

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

@@ -1,7 +1,7 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 /**
  * @fileOverview The URLTemplate service provides utilities when working with URL templates
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/ushell/utils",

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's UI5 component loader service.
  * This is a shell-internal service and no public or application facing API!
  *
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/ushell/Config",

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

@@ -14,7 +14,7 @@
  *
  * This is *not* an application facing service, but for Shell Internal usage.
  *
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -7,7 +7,7 @@
  *               This service should be accessed by the application
  *               via the CrossApplicationNavigation service.
  *
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's user information service, which allows you to retrieve
  *     information about the user.
  *
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Unified Shell's user activity service.
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/ui/base/Object",

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

@@ -2,7 +2,7 @@
 
 /**
  * @file deals with the retrieval of visualization data in a platform independent way.
- * @version 1.113.0
+ * @version 1.114.1
  */
 
 sap.ui.define([

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module deals with the instantiation of visualizations in a platform independent way.
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/ushell/services/_VisualizationInstantiation/VizInstance",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/Formatter.js

@@ -13,7 +13,7 @@
  * <p>This is a dependency of ClientSideTargetResolution.  Interfaces exposed
  * by this module may change at any time without notice.</p>
  *
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
 ], function () {

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/InboundIndex.js

@@ -27,7 +27,7 @@
  *
  * @private
  *
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
 "sap/base/util/ObjectPath",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/InboundProvider.js

@@ -34,7 +34,7 @@
  * <p>This is a dependency of ClientSideTargetResolution.  Interfaces exposed
  * by this module may change at any time without notice.</p>
  *
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/ushell/services/_ClientSideTargetResolution/VirtualInbounds",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/PrelaunchOperations.js

@@ -4,7 +4,7 @@
  * @file PrelaunchOperations are executed just before launching the application (post parameter mapping and app state merging) if the
  * <code>sap-prelaunch-operations</code> parameter is specified as a technical parameter.
  *
- * @version 1.113.0
+ * @version 1.114.1
  */
 sap.ui.define([
     "sap/base/Log",