@sapui5/sap.ushell 1.141.3 → 1.143.0

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileoverview The Unified Shell's page builder service providing the data for the Fiori launchpad's classic Homepage.
- * @version 1.141.3
+ * @version 1.143.0
  * @deprecated since 1.120
  */
 sap.ui.define([

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.141.3
+ * @version 1.143.0
  */
 sap.ui.define([
     "sap/ushell/Config",
@@ -693,186 +693,6 @@ sap.ui.define([
         return false;
     };
 
-    /**
-     * Retrieves info about the given nodeId
-     *
-     * @param {string} nodeId The nodeId to search for.
-     * @param {object[]} nodes The array of nodes and their children.
-     * @param {boolean} [isChild] If the current node is a child node.
-     * @param {string} [managerId] The managerId - to be called recursively.
-     * @returns {object} The result object.
-     * @private
-     */
-    Menu.prototype._getNodeInfo = function (nodeId, nodes, isChild, managerId) {
-        let oNodeInfo;
-        for (let i = 0; i < nodes.length; i++) {
-            if (!isChild) { managerId = this._getManagerIdInNodeTree(nodeId, nodes[i]); }
-            if (nodes[i].id === nodeId) {
-                return {
-                    node: nodes[i],
-                    isRootNode: !isChild,
-                    managerId: managerId || null
-                };
-            }
-
-            if (nodes[i].menuEntries && nodes[i].menuEntries.length > 0) {
-                oNodeInfo = this._getNodeInfo(nodeId, nodes[i].menuEntries, true, managerId);
-                if (oNodeInfo.node) { return oNodeInfo; }
-            }
-        }
-        return {
-            node: null,
-            isRootNode: false,
-            managerId: null
-        };
-    };
-
-    /**
-     * Checks if the given nodeId exists and if the managerId is allowed to manage the given nodeId.
-     *
-     * @param {string} nodeId The node id to search for.
-     * @param {object[]} rootNodes The nodes in the menu.
-     * @param {string} managerId The managerId to check.
-     * @returns {boolean} The result - True if the managerId of the node is null or equal to the given managerId.
-     * @private
-     */
-    Menu.prototype._nodeManagementPermitted = function (nodeId, rootNodes, managerId) {
-        const oNodeInfo = this._getNodeInfo(nodeId, rootNodes);
-        if (!oNodeInfo.node) {
-            Log.error(`Node with id ${nodeId} cannot be found and will be skipped.`);
-            return false;
-        }
-        if (oNodeInfo.managerId && oNodeInfo.managerId !== managerId) {
-            Log.error(`Node with id ${nodeId} cannot be managed by '${managerId}'` +
-                ` because it is already managed by '${oNodeInfo.managerId}'.`);
-            return false;
-        }
-        return true;
-    };
-
-    /**
-     * Returns the managerId for a given node if it exists on itself or on a parent.
-     *
-     * @param {string} nodeId The node id to search for.
-     * @param {object} node The node to start the search.
-     * @param {string} [managerId] The if of the entry manager.
-     * @returns {string|null} The managerId if a managed node is found.
-     * @private
-     */
-    Menu.prototype._getManagerIdInNodeTree = function (nodeId, node, managerId) {
-        if (node.id === nodeId) { return managerId || node.managerId; }
-        if (node.managerId) { managerId = node.managerId; }
-        if (node.menuEntries && node.menuEntries.length > 0) {
-            for (let i = 0; i < node.menuEntries.length; ++i) {
-                managerId = this._getManagerIdInNodeTree(nodeId, node.menuEntries[i], managerId);
-            }
-            return managerId;
-        }
-        return null;
-    };
-
-    /**
-     * Replaces the node and all its menuEntries with the given managedTree.
-     *
-     * @param {string} nodeId The nodeId to replace.
-     * @param {object[]} nodes The nodes tree.
-     * @param {object} managedTree The tree to replace the node with.
-     * @returns {object[]} The new nodes tree.
-     * @private
-     */
-    Menu.prototype._updateNode = function (nodeId, nodes, managedTree) {
-        const oTree = deepClone(managedTree || {});
-        // Make sure that all menu entries have uid:
-        function addUid (treeObj) {
-            if (treeObj) {
-                treeObj.uid = treeObj.uid || ushellUtils.generateUniqueId([]);
-                (treeObj.menuEntries || []).forEach(addUid);
-            }
-        }
-        addUid(oTree);
-
-        // traverse the tree to find the menu entry with the required ID and replace it
-        return nodes.map((node) => {
-            if (node.id === nodeId) {
-                return oTree;
-            }
-            if (node.menuEntries && node.menuEntries.length > 0) {
-                node.menuEntries = this._updateNode(nodeId, node.menuEntries, oTree);
-            }
-            return node;
-        });
-    };
-
-    /**
-     * Creates entry provider functions, mapped to the given nodeIds.
-     *
-     * @param {string} managerId The ID of the entry manager.
-     * @param {string[]} nodeIds The nodeIds to update.
-     * @param {object} model The model bound to the UI.
-     * @returns {object} The entry provider functions mapped to the nodeIds.
-     * @private
-     */
-    Menu.prototype._createEntryProviders = function (managerId, nodeIds, model) {
-        const aNodes = model.getData();
-        const oMenuEntryProvider = {};
-        let sNodeId;
-
-        for (let i = 0; i < nodeIds.length; ++i) {
-            sNodeId = nodeIds[i];
-
-            if (!this._nodeManagementPermitted(sNodeId, aNodes, managerId)) {
-                continue;
-            }
-
-            oMenuEntryProvider[sNodeId] = {
-                setData: function (nodeId, managedTree) {
-                    const aUpdatedNodes = this._updateNode(nodeId, aNodes, managedTree);
-
-                    model.setData(aUpdatedNodes);
-                }.bind(this, sNodeId)
-            };
-        }
-
-        return oMenuEntryProvider;
-    };
-
-    /**
-     * @param {string} managerId The ID of the entry manager.
-     * @returns {boolean} True if the given managerId is in the blocked list, otherwise false.
-     * @private
-     */
-    Menu.prototype._isManagerBlocked = function (managerId) {
-        return this._aBlockedList.indexOf(managerId) > -1;
-    };
-
-    /**
-     * Adds the given managerId to the blocked list.
-     *
-     * @param {string} managerId The ID of the entry manager.
-     * @private
-     */
-    Menu.prototype._setManagerBlocked = function (managerId) {
-        this._aBlockedList.push(managerId);
-    };
-
-    /**
-     * Checks if the given managerId (pluginName) is blocked. If not, blocks it and resolves to
-     * the entry provider functions for the given nodeIds.
-     *
-     * @param {string} pluginName The ID of the plugin.
-     * @param {string[]} nodeIds An array of nodeId strings.
-     * @returns {Promise<object>} The entry provider functions mapped to the nodeIds.
-     */
-    Menu.prototype.getEntryProvider = async function (pluginName, nodeIds) {
-        if (this._isManagerBlocked(pluginName)) {
-            Log.error(`ManagerId '${pluginName}' is already listed as an entry manager.`);
-            throw new Error(`ManagerId ${pluginName} is already listed as an entry manager.`);
-        }
-        this._setManagerBlocked(pluginName);
-        const oModel = await this.getMenuModel();
-        return this._createEntryProviders(pluginName, nodeIds, oModel);
-    };
-
     // Return menu service from this module
     Menu.hasNoAdapter = false;
     return Menu;

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Unified Shell's message service.
- * @version 1.141.3
+ * @version 1.143.0
  * @deprecated since 1.120
  */
 sap.ui.define([

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module contains the implementation of the message broker
- * @version 1.141.3
+ * @version 1.143.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -237,7 +237,7 @@ sap.ui.define([
          * The message callback is overwritten on subsequent calls to subscribe.
          * Every channel can has its own message callback.
          * @param {sap.ushell.services.MessageBroker.ClientConnectionCallback} fnClientConnectionCallback
-         * <b>DEPRECATED</b> Should be provided as part of {@link #connect}.
+         * <b>DEPRECATED since 1.141.0</b> Should be provided as part of {@link #connect}.
          * @returns {Promise} Resolves once the client is subscribed to the channels.
          *
          * @since 1.110.0
@@ -394,7 +394,7 @@ sap.ui.define([
          * @param {ChannelId} sChannelId channel id.
          * @param {ClientId} sClientId The client id of the sender.
          * @param {string} sMessageId
-         * <b>DEPRECATED</b> Should not be provided.
+         * <b>DEPRECATED since 1.141.0</b> Should not be provided.
          * @param {string} sMessageName message name. Can be used to identify the message type or as a topic.
          * @param {string[]|sap.ushell.services.MessageBroker.ClientAlias.AllClients} vTargetClientIds
          * list of target client ids. Can include the wildcard "*" to send the message to all clients subscribed to the channel.

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module exposes API endpoints for Generic Communication
- * @version 1.141.3
+ * @version 1.143.0
  */
 sap.ui.define([
     "sap/ushell/services/MessageBroker/ClientAlias",
@@ -147,7 +147,7 @@ sap.ui.define([
      * The message callback is overwritten on subsequent calls to subscribe.
      * Every channel can has its own message callback.
      * @param {sap.ushell.services.MessageBroker.ClientConnectionCallback} fnClientConnectionCallback
-     * <b>DEPRECATED</b> Should be provided as part of {@link #connect}.
+     * <b>DEPRECATED since 1.141.0</b> Should be provided as part of {@link #connect}.
      * @returns {Promise} Resolves once the client is subscribed to the channels.
      *
      * @since 1.110.0
@@ -185,7 +185,7 @@ sap.ui.define([
      * @param {string} sChannelId channel id.
      * @param {string} sClientId The client id of the sender.
      * @param {string} sMessageId
-     * <b>DEPRECATED</b> Should not be provided.
+     * <b>DEPRECATED since 1.141.0</b> Should not be provided.
      * @param {string} sMessageName message name. Can be used to identify the message type or as a topic.
      * @param {string[]|sap.ushell.services.MessageBroker.ClientAlias.AllClients} vTargetClientIds
      * list of target client ids. Can include the wildcard "*" to send the message to all clients subscribed to the channel.

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's message service.
  * This is a private service replacing the depercated Message service, as the functionality is used thoughout the ushell.
  *
- * @version 1.141.3
+ * @version 1.143.0
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -200,11 +200,11 @@ sap.ui.define([
             const oDeferred = new jQuery.Deferred();
 
             // augment URL with application parameters from sHashFragment
-            const oParsedShellHash = UrlParsing.parseShellHash(sHashFragment);
-            if (oParsedShellHash && oParsedShellHash.params && oParsedShellHash.params["sap-intent-param"]) {
+            const oParsedHash = UrlParsing.parseShellHash(sHashFragment);
+            if (oParsedHash && oParsedHash.params && oParsedHash.params["sap-intent-param"]) {
                 Container.getServiceAsync("AppState")
                     .then((AppStateService) => {
-                        AppStateService.getAppState(oParsedShellHash.params["sap-intent-param"][0])
+                        AppStateService.getAppState(oParsedHash.params["sap-intent-param"][0])
                             .done((oContainer) => {
                                 const sValue = oContainer.getData("sap-intent-param");
                                 let sHashFragmentPotentiallyExpanded = sHashFragment;

package/src/main/js/sap/ushell/services/Navigation/compatibility.js

@@ -4,7 +4,7 @@
  * compatible with the CrossApplicationNavigation service.
  * This shall only be used for the AppRuntime to enable 1.x inner shell running in 2.x host.
  *
- * @version 1.141.3
+ * @version 1.143.0
  */
 
 sap.ui.define([

package/src/main/js/sap/ushell/services/Navigation/utils.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview Navigation utility functions
  *
- * @version 1.141.3
+ * @version 1.143.0
  */
 
 sap.ui.define([

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

@@ -5,7 +5,7 @@
  * This file exposes an API to perform (invoke) Navigation for applications.
  * It exposes interfaces to perform a hash change and trigger a navigation.
  *
- * @version 1.141.3
+ * @version 1.143.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -552,16 +552,16 @@ sap.ui.define([
                 let oArgsClone = deepClone(oTarget); // clone to keep input unchanged and to avoid side effects
                 if (!oArgsClone.target) {
                     Log.debug("Navigation.getHref: No target provided using current hash as fallback", "sap.ushell.services.Navigation");
-                    const oParsedShellHash = UrlParsing.parseShellHash(hasher.getHash());
+                    const oParsedHash = UrlParsing.parseShellHash(hasher.getHash());
                     oArgsClone.target = {
-                        semanticObject: oParsedShellHash.semanticObject,
-                        action: oParsedShellHash.action,
-                        contextRaw: oParsedShellHash.contextRaw
+                        semanticObject: oParsedHash.semanticObject,
+                        action: oParsedHash.action,
+                        contextRaw: oParsedHash.contextRaw
                     };
-                    oArgsClone.params = oParsedShellHash.params;
+                    oArgsClone.params = oParsedHash.params;
 
-                    if (oParsedShellHash.appSpecificRoute && !oArgsClone.appSpecificRoute) {
-                        oArgsClone.appSpecificRoute = oParsedShellHash.appSpecificRoute;
+                    if (oParsedHash.appSpecificRoute && !oArgsClone.appSpecificRoute) {
+                        oArgsClone.appSpecificRoute = oParsedHash.appSpecificRoute;
                     }
                 }
 
@@ -753,15 +753,15 @@ sap.ui.define([
 
             if (oTarget.target.shellHash) {
                 // convert shell hash in to semantic object and action form
-                const oHash = UrlParsing.parseShellHash(oTarget.target.shellHash) || {};
+                const oParsedHash = UrlParsing.parseShellHash(oTarget.target.shellHash) || {};
 
                 oTarget.target = {
-                    semanticObject: oHash.semanticObject,
-                    action: oHash.action,
-                    contextRaw: oHash.contextRaw
+                    semanticObject: oParsedHash.semanticObject,
+                    action: oParsedHash.action,
+                    contextRaw: oParsedHash.contextRaw
                 };
-                oTarget.appSpecificRoute = oHash.appSpecificRoute;
-                oTarget.params = Object.assign({}, oTarget.params, oHash.params);
+                oTarget.appSpecificRoute = oParsedHash.appSpecificRoute;
+                oTarget.params = Object.assign({}, oTarget.params, oParsedHash.params);
             }
 
             if (oTarget.appSpecificRoute) {
@@ -1200,15 +1200,15 @@ sap.ui.define([
                 const sShellHash = ObjectPath.get("target.shellHash", oTarget);
                 const oParams = oTarget.params;
                 if (bEnabled && sShellHash && isPlainObject(oParams)) {
-                    const oHash = UrlParsing.parseShellHash(sShellHash);
+                    const oParsedHash = UrlParsing.parseShellHash(sShellHash);
 
                     oTarget.target = {
-                        semanticObject: oHash.semanticObject,
-                        action: oHash.action,
-                        contextRaw: oHash.contextRaw
+                        semanticObject: oParsedHash.semanticObject,
+                        action: oParsedHash.action,
+                        contextRaw: oParsedHash.contextRaw
                     };
-                    oTarget.appSpecificRoute = oHash.appSpecificRoute;
-                    oTarget.params = Object.assign({}, oParams, oHash.params);
+                    oTarget.appSpecificRoute = oParsedHash.appSpecificRoute;
+                    oTarget.params = Object.assign({}, oParams, oParsedHash.params);
                 }
             }
         };

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

@@ -9,7 +9,7 @@
  *
  * Configured with the ClientSideTargetResolutionAdapter.
  *
- * @version 1.141.3
+ * @version 1.143.0
  */
 sap.ui.define([
     "sap/ushell/resources",

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

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

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

@@ -6,7 +6,7 @@
  * It provides the layout and tile data of pages in the pages runtime.
  * Only used on the ABAP platform and on local for testing.
  *
- * @version 1.141.3
+ * @version 1.143.0
  */
 sap.ui.define([], () => {
     "use strict";

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.141.3
+ * @version 1.143.0
  */
 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.141.3
+ * @version 1.143.0
  */
 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.141.3
+ * @version 1.143.0
  * @deprecated since 1.120. Please use {@link sap.ushell.services.PersonalizationV2} instead.
  */
 sap.ui.define([

package/src/main/js/sap/ushell/services/PersonalizationV2.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.141.3
+ * @version 1.143.0
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -4,7 +4,7 @@
  * This allows to enter simple postfix expressions and to test if an id complies with the expression.
  * It can replace unsafe regular expressions that are vulnerable to ReDoS attacks.
  *
- * @version 1.141.3
+ * @version 1.143.0
  */
 
 sap.ui.define([], () => {

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

@@ -2,13 +2,12 @@
 
 /**
  * @fileOverview The Unified Shell's PluginManager service. Allows handling the loading of Fiori Launchpad plugins.
- * @version 1.141.3
+ * @version 1.143.0
  */
 sap.ui.define([
     "sap/base/Log",
     "sap/ui/thirdparty/jquery",
     "sap/ushell/appIntegration/PostMessagePluginInterface",
-    "sap/ushell/services/PluginManager/Extensions",
     "sap/ushell/UI5ComponentType",
     "sap/ushell/utils",
     "sap/ushell/Container",
@@ -17,7 +16,6 @@ sap.ui.define([
     Log,
     jQuery,
     PostMessagePluginInterface,
-    fnGetExtensions,
     UI5ComponentType,
     ushellUtils,
     Container,
@@ -207,8 +205,7 @@ sap.ui.define([
             const oComponentOptions = JSON.parse(JSON.stringify(oPlugin));
             const oApplicationProperties = {
                 ui5ComponentName: oComponentOptions.component,
-                url: oComponentOptions.url,
-                getExtensions: fnGetExtensions.bind(null, oPlugin.component)
+                url: oComponentOptions.url
             };
 
             function makeRejectHandler (sErrorMessage) {
@@ -259,7 +256,6 @@ sap.ui.define([
                             UI5ComponentLoaderService
                                 .createComponent(
                                     oApplicationProperties,
-                                    {},
                                     [],
                                     UI5ComponentType.Plugin
                                 )

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview resolves references
- * @version 1.141.3
+ * @version 1.143.0
  */
 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.141.3
+ * @version 1.143.0
  */
 sap.ui.define([
     "sap/ui/core/Lib"

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's Search for myHome.
  *
- * @version 1.141.3
+ * @version 1.143.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -63,8 +63,7 @@ sap.ui.define([
     };
 
     /**
-     * @typedef SearchResults
-     * @type {object}
+     * @typedef {object} SearchResults
      * @property {int} count the total number of results
      * @property {object[]} data an array of search results
      */
@@ -133,10 +132,10 @@ sap.ui.define([
 
         if (sUrl.startsWith("#")) {
             if (sSearchTerm) {
-                const oShellHash = UrlParsing.parseShellHash(sUrl);
-                if (oShellHash) {
-                    oShellHash.params.searchTerm = sSearchTerm;
-                    sUrl = UrlParsing.constructShellHash(oShellHash);
+                const oParsedHash = UrlParsing.parseShellHash(sUrl);
+                if (oParsedHash) {
+                    oParsedHash.params.searchTerm = sSearchTerm;
+                    sUrl = UrlParsing.constructShellHash(oParsedHash);
                 }
             }
 

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module exposes the searchable content.
- * @version 1.141.3
+ * @version 1.143.0
  */
 sap.ui.define([
     "sap/ushell/Config",
@@ -59,8 +59,7 @@ sap.ui.define([
     SearchableContent.COMPONENT_NAME = "sap/ushell/services/SearchableContent";
 
     /**
-     * @typedef sap.ushell.services.SearchableContent.AppData
-     * @type {object}
+     * @typedef {object} sap.ushell.services.SearchableContent.AppData
      * @property {string} id
      * @property {string} title
      * @property {string} subtitle
@@ -81,8 +80,7 @@ sap.ui.define([
      */
 
     /**
-     * @typedef sap.ushell.services.SearchableContent.VizData
-     * @type {object}
+     * @typedef {object} sap.ushell.services.SearchableContent.VizData
      * @property {string} id
      * @property {string} vizId
      * @property {string} vizType

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview Shell Navigation Service.
- * @version 1.141.3
+ * @version 1.143.0
  * @deprecated since 1.120. Use {@link sap.ushell.services.Navigation} for Navigation instead.
  */
 sap.ui.define([