@sapui5/sap.ushell 1.126.1 → 1.127.1

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

@@ -5,7 +5,7 @@
  * This files exposes an API to extend the launchpad with new elements.
  * It is exposed publicly and meant to be used by apps and plugins.
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/ushell/services/Extension/Item",
@@ -93,6 +93,23 @@ sap.ui.define([
      * Aggregations, controls and types with prototypes are not allowed!</li>
      * <li>The event handlers are not bound to the actual control and do not receive the event arguments.</li>
      * </ul>
+     *
+     * @example
+     *
+     *   FrameBoundExtension.createHeaderItem({
+     *       id: "headerItem1",
+     *       ariaLabel: "headerItem-ariaLabel",
+     *       ariaHaspopup: "dialog",
+     *       icon: "sap-icon://action-settings",
+     *       tooltip: "headerItem-tooltip",
+     *       text: "headerItem-text",
+     *       press: () => {
+     *           MessageToast.show("Press header item");
+     *       }
+     *   }, {
+     *       position: "begin"
+     *   })
+     *
      * @param {sap.ushell.ui.shell.ShellHeadItem.Properties} controlProperties The properties that will be passed to the created control.
      * @param {object} [parameters] Additional parameters.
      * @param {string} [parameters.position=end] Possible values are <code>begin</code> and <code>end</code>.
@@ -172,15 +189,32 @@ sap.ui.define([
 
     /**
      * Creates a user action in the user action menu.<br>
+     * The <code>controlType</code> can be any control and is by default a {@link sap.ushell.ui.launchpad.ActionItem}.
+     * The <code>controlProperties</code> are passed to the constructor of the control.
+     * <br>
      * <b>Restrictions:</b>
      * <ul>
      * <li>The control properties are only allowed to contain primitive properties and event handlers.
      * Aggregations, controls and types with prototypes are not allowed!</li>
      * <li>The event handlers are not bound to the actual control and do not receive the event arguments.</li>
      * </ul>
+     *
+     * @example
+     *
+     *   FrameBoundExtension.createUserAction({
+     *       id: "userAction1",
+     *       text: "New UserAction",
+     *       icon: "sap-icon://refresh",
+     *       press: () => {
+     *           MessageToast.show("Press UserAction");
+     *       }
+     *   }, {
+     *       controlType: "sap.ushell.ui.launchpad.ActionItem"
+     *   })
+     *
      * @param {object} controlProperties The properties that will be passed to the created control.
      * @param {object} [parameters] Additional parameters.
-     * @param {string} [parameters.controlType=sap.ushell.ui.launchpad.ActionItem] Defines the <code>controlType</code>.
+     * @param {string} [parameters.controlType=sap.ushell.ui.launchpad.ActionItem] Defines the <code>controlType</code> of the item.
      * @returns {Promise<sap.ushell.services.Extension.Item>} The newly created user action.
      *
      * @since 1.120.0

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

@@ -4,7 +4,7 @@
  * @file The Unified Shell's page builder service providing the data for the Fiori launchpad's classic Homepage.
  * This is the privately used subset of the previously deprecated public LaunchPage service API
  * @private
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/services/FrameBoundExtension/FloatingContainer.js

@@ -5,7 +5,7 @@
  *
  * This interface does NOT work when called from within a iframe.
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/ui/base/ManagedObject",

package/src/main/js/sap/ushell/services/FrameBoundExtension/Footer.js

@@ -5,7 +5,7 @@
  *
  * This interface does NOT work when called from within a iframe.
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/ushell/Container"

package/src/main/js/sap/ushell/services/FrameBoundExtension/Item.js

@@ -5,14 +5,14 @@
  *
  * This interface does NOT work when called from within a iframe.
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/base/Log",
-    "sap/ushell/Config"
+    "sap/ushell/state/StateManager"
 ], function (
     Log,
-    Config
+    StateManager
 ) {
     "use strict";
 
@@ -193,7 +193,7 @@ sap.ui.define([
          * @private
          */
         #getCurrentState () {
-            const sCurrentState = Config.last("/core/shell/model/currentState/stateName");
+            const sCurrentState = StateManager.getLaunchpadState();
             return sCurrentState;
         }
     }

package/src/main/js/sap/ushell/services/FrameBoundExtension/SidePane.js

@@ -5,7 +5,7 @@
  *
  * This interface does NOT work when called from within a iframe.
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/ushell/services/FrameBoundExtension/Item",
@@ -56,9 +56,25 @@ sap.ui.define([
 
         /**
          * Creates an item in the side pane.
+         *
+         * The <code>controlType</code> can be any control and is by default a {@link sap.m.Button}.
+         * The <code>controlProperties</code> are passed to the constructor of the control.
+         *
+         * @example
+         *
+         *   SidePane.createItem({
+         *       id: "sidePaneContent1",
+         *       text: "SidePaneContent Button",
+         *       press: () => {
+         *           MessageToast.show("Press SidePaneContent Button");
+         *       }
+         *   }, {
+         *       controlType: "sap.m.Button"
+         *   });
+         *
          * @param {object} controlProperties The properties that will be passed to the created control.
          * @param {object} [parameters] Additional parameters.
-         * @param {string} [parameters.controlType=sap.m.Button] Defines the <code>controlType</code>.
+         * @param {string} [parameters.controlType=sap.m.Button] Defines the <code>controlType</code> of the item.
          * @returns {Promise<sap.ushell.services.FrameBoundExtension.Item>} The newly created item.
          *
          * @since 1.124.0

package/src/main/js/sap/ushell/services/FrameBoundExtension/ToolArea.js

@@ -5,7 +5,7 @@
  *
  * This interface does NOT work when called from within a iframe.
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/ushell/services/FrameBoundExtension/Item",
@@ -56,9 +56,27 @@ sap.ui.define([
 
         /**
          * Creates an item in the tool area.
-         * @param {object} controlProperties The properties that will be passed to the created control.
+         *
+         * @example
+         *
+         *   ToolArea.createItem({
+         *       id: "toolAreaItem1",
+         *       icon: "sap-icon://documents",
+         *       text: "My ToolArea Item 1",
+         *       expandable: true,
+         *       press: (evt) => {
+         *           MessageToast.show("Press toolAreaItem1");
+         *       },
+         *       expand: (evt) => {
+         *           MessageToast.show("Expand toolAreaItem1");
+         *       }
+         *   });
+         *
+         * @param {object} controlProperties The properties that will be passed to the {@link sap.ushell.ui.shell.ToolAreaItem}.
          * @returns {Promise<sap.ushell.services.FrameBoundExtension.Item>} The newly created item.
          *
+         * @see sap.ushell.ui.shell.ToolAreaItem
+         *
          * @since 1.124.0
          * @public
          */

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

@@ -8,7 +8,7 @@
  * This service can only be called from the outer shell and is not available
  * in the inner shell or via post message API.
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/ushell/services/FrameBoundExtension/FloatingContainer",
@@ -95,6 +95,23 @@ sap.ui.define([
 
     /**
      * Creates a header item in the shell header.
+     *
+     * @example
+     *
+     *   FrameBoundExtension.createHeaderItem({
+     *       id: "headerItem1",
+     *       ariaLabel: "headerItem-ariaLabel",
+     *       ariaHaspopup: "dialog",
+     *       icon: "sap-icon://action-settings",
+     *       tooltip: "headerItem-tooltip",
+     *       text: "headerItem-text",
+     *       press: () => {
+     *           MessageToast.show("Press header item");
+     *       }
+     *   }, {
+     *       position: "begin"
+     *   })
+     *
      * @param {sap.ushell.ui.shell.ShellHeadItem.Properties} controlProperties The properties that will be passed to the created control.
      * @param {object} [parameters] Additional parameters.
      * @param {string} [parameters.position=end] Possible values are <code>begin</code> and <code>end</code>.
@@ -175,8 +192,38 @@ sap.ui.define([
     /**
      * Creates a new sub header which is positioned below the header.
      *
+     * The <code>controlType</code> can be any control and is by default a {@link sap.m.Bar}.
+     * The <code>controlProperties</code> are passed to the constructor of the control.
+     *
      * <p><b>Note:</b> Only one sub header is displayed at once</p>
      * <p><b>Restriction:</b> NOT available for apps running in an iframe</p>
+     *
+     * @example
+     *
+     *   FrameBoundExtension.createSubHeader({
+     *       id: "subheader1",
+     *       contentLeft: [new Button({
+     *           text: "SubHeader ContentLeftBtn",
+     *           press: () => {
+     *               MessageToast.show("Press subheader1 contentLeft");
+     *           }
+     *       })],
+     *       contentMiddle: [new Button({
+     *           text: "SubHeader contentMiddleBtn",
+     *           press: () => {
+     *               MessageToast.show("Press subheader1 contentMiddle");
+     *           }
+     *       })],
+     *       contentRight: [new Button({
+     *          text: "SubHeader contentRightBtn",
+     *          press: () => {
+     *              MessageToast.show("Press subheader1 contentRight");
+     *          }
+     *       })]
+     *   }, {
+     *       controlType: "sap.m.Bar"
+     *   })
+     *
      * @param {object} controlProperties The properties that will be passed to the created control.
      * @param {object} [parameters] Additional parameters.
      * @param {string} [parameters.controlType=sap.m.Bar] Defines the <code>controlType</code>.
@@ -240,9 +287,26 @@ sap.ui.define([
 
     /**
      * Creates a user action in the user action menu.
+     *
+     * The <code>controlType</code> can be any control and is by default a {@link sap.ushell.ui.launchpad.ActionItem}.
+     * The <code>controlProperties</code> are passed to the constructor of the control.
+     *
+     * @example
+     *
+     *   FrameBoundExtension.createUserAction({
+     *       id: "userAction1",
+     *       text: "New UserAction",
+     *       icon: "sap-icon://refresh",
+     *       press: () => {
+     *           MessageToast.show("Press UserAction");
+     *       }
+     *   }, {
+     *       controlType: "sap.ushell.ui.launchpad.ActionItem"
+     *   })
+     *
      * @param {object} controlProperties The properties that will be passed to the created control.
      * @param {object} [parameters] Additional parameters.
-     * @param {string} [parameters.controlType=sap.ushell.ui.launchpad.ActionItem] Defines the <code>controlType</code>.
+     * @param {string} [parameters.controlType=sap.ushell.ui.launchpad.ActionItem] Defines the <code>controlType</code> of the item.
      * @returns {Promise<sap.ushell.services.FrameBoundExtension.Item>} The newly created user action.
      *
      * @since 1.124.0
@@ -273,8 +337,38 @@ sap.ui.define([
     /**
      * Creates a new footer which is positioned below the launchpad content.
      *
+     * The <code>controlType</code> can be any control and is by default a {@link sap.m.Bar}.
+     * The <code>controlProperties</code> are passed to the constructor of the control.
+     *
      * <p><b>Note:</b> Only one footer is displayed at once. Any new footer will replace the previous one</p>
      * <p><b>Restriction:</b> NOT available for apps running in an iframe</p>
+     *
+     * @example
+     *
+     *   FrameBoundExtension.createFooter({
+     *       id: "footer1",
+     *       contentLeft: [new Button({
+     *           text: "Footer ContentLeftBtn",
+     *           press: () => {
+     *               MessageToast.show("Press footer1 contentLeft");
+     *           }
+     *       })],
+     *       contentMiddle: [new Button({
+     *           text: "Footer contentMiddleBtn",
+     *           press: () => {
+     *               MessageToast.show("Press footer1 contentMiddle");
+     *           }
+     *       })],
+     *       contentRight: [new Button({
+     *          text: "Footer contentRightBtn",
+     *          press: () => {
+     *              MessageToast.show("Press footer1 contentRight");
+     *          }
+     *       })]
+     *   }, {
+     *       controlType: "sap.m.Bar"
+     *   })
+     *
      * @param {object} controlProperties The properties that will be passed to the created control.
      * @param {object} [parameters] Additional parameters.
      * @param {string} [parameters.controlType=sap.m.Bar] Defines the <code>controlType</code>.

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.126.1
+ * @version 1.127.1
  * @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.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/ushell/Config",

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

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

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module exposes API endpoints for Generic Communication
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/ushell/services/_MessageBroker/MessageBrokerEngine",

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.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/base/Log",
@@ -214,7 +214,7 @@ sap.ui.define([
          * Creates a Dialog from a given error message.
          *
          * @param {string} message message text
-         * @param {object} messageConfig message configuration (title and details)
+         * @param {object} messageConfig message configuration (title, details, actions, onClose callback)
          *
          * @private
          */
@@ -227,7 +227,7 @@ sap.ui.define([
                 });
             }
 
-            var oErrorDialog = this.errorWithDetails(message, oDetailControl, messageConfig.title);
+            var oErrorDialog = this.errorWithDetails(message, oDetailControl, messageConfig);
 
             // Check that SupportTicket is enabled and verify that we are not in a flow in which Support ticket creation is failing,
             // if this is the case we don't want to show the user the contact support button again
@@ -364,22 +364,24 @@ sap.ui.define([
          * @param {string} message The localized message as plain text
          * @param {sap.ui.core.Control} [detailControl] The control that should be displayed,
          * once a user presses the "View Details" link
-         * @param {string} [title] The localized title as plain text
+         * @param {string|object} messageConfig The localized title as string or the message configuration object (title, details, actions, onClose callback)
          * @param {sap.m.Button[]} [buttons] The custom buttons that should be shown on the dialog
          *
          * @returns {sap.m.Dialog} The error dialog, so it can be destroyed by a custom button
          *
          * @private
          */
-        this.errorWithDetails = function (message, detailControl, title, buttons) {
+        this.errorWithDetails = function (message, detailControl, messageConfig, buttons) {
             if (Array.isArray(detailControl)) {
                 buttons = detailControl;
                 detailControl = null;
             }
 
+            var sTitle = typeof messageConfig === "string" ? messageConfig : messageConfig?.title;
+
             if (typeof detailControl === "string") {
-                buttons = title;
-                title = detailControl;
+                buttons = sTitle;
+                sTitle = detailControl;
                 detailControl = null;
             }
 
@@ -395,7 +397,7 @@ sap.ui.define([
                 state: ValueState.Error,
                 type: DialogType.Message,
                 contentWidth: "30rem",
-                title: title || resources.i18n.getText("error"),
+                title: sTitle || resources.i18n.getText("error"),
                 content: [
                     new VBox({
                         renderType: FlexRendertype.Bare,
@@ -424,6 +426,9 @@ sap.ui.define([
                     this.destroy();
                 }
             }).addStyleClass("sapContrastPlus");
+            if (typeof messageConfig?.onClose === "function") {
+                oErrorDialog.attachAfterClose(messageConfig.onClose);
+            }
             oErrorDialog.open();
 
             return oErrorDialog;

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.126.1
+ * @version 1.127.1
  */
 
 sap.ui.define([

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

@@ -2,7 +2,7 @@
 /**
  * @fileOverview Navigation utility functions
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 
 

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.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -8,7 +8,7 @@
  *
  * Configured with the ClientSideTargetResolutionAdapter.
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 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.126.1
+ * @version 1.127.1
  */
 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.126.1
+ * @version 1.127.1
  */
 sap.ui.define([], function () {
     "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.126.1
+ * @version 1.127.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.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/base/Log",
@@ -54,7 +54,7 @@ sap.ui.define([
      * @private
      */
     var Pages = function () {
-        this.COMPONENT_NAME = "sap/ushell/services/Pages";
+        this.COMPONENT_NAME = "sap.ushell.services.Pages";
         this._oCdmServicePromise = Container.getServiceAsync("CommonDataModel");
         this._oCSTRServicePromise = Container.getServiceAsync("ClientSideTargetResolution");
         this._oPagesModel = new RestrictedJSONModel({
@@ -1264,7 +1264,8 @@ sap.ui.define([
                         return oViz.id === oVizData.id;
                     });
                     oSection.visualizations.splice(iIndex, 1);
-                    Log.warning("The visualization " + oVizData.vizId + " is filtered out, because it does not have a supported intent.");
+                    Log.warning(`The visualization with title '${oVizData.title}' and ID '${oVizData.vizId}' is filtered out, because intent '${oVizData.targetURL}' is not supported.`,
+                        null, this.COMPONENT_NAME);
                 }
             }));
         }));

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.126.1
+ * @version 1.127.1
  * @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.126.1
+ * @version 1.127.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. Allows handling the loading of Fiori Launchpad plugins.
- * @version 1.126.1
+ * @version 1.127.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.126.1
+ * @version 1.127.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.126.1
+ * @version 1.127.1
  */
 sap.ui.define(["sap/ui/core/Lib"], function (Library) {
     "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.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module exposes the searchable content.
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/ushell/Config",
@@ -509,7 +509,7 @@ sap.ui.define([
      * @private
      */
     SearchableContent.prototype._applyCdmVisualizations = async function (oSite, oAppData, oGetAppsOptions) {
-        for (let sKey in oSite.visualizations) {
+        for (const sKey in oSite.visualizations) {
             try {
                 const oVizReference = {
                     vizId: sKey,
@@ -556,7 +556,7 @@ sap.ui.define([
      * @private
      */
     SearchableContent.prototype._applyCdmPages = async function (oSite, aPages, oAppData, oGetAppsOptions) {
-        for (let oPage of aPages) {
+        for (const oPage of aPages) {
             const aVizReferences = readPages.getVisualizationReferences(oPage);
             for (let oVizReference of aVizReferences) {
                 try {
@@ -626,8 +626,9 @@ sap.ui.define([
      */
     SearchableContent.prototype._buildAppDataFromAppAndInbound = function (oApp, oInb, bAddTargetURL) {
         oInb = oInb || {};
+        var sAppId = readApplications.getId(oApp);
         var oResult = {
-            id: readApplications.getId(oApp),
+            id: sAppId,
             title: oInb.title || readApplications.getTitle(oApp),
             subtitle: oInb.subTitle || readApplications.getSubTitle(oApp),
             icon: oInb.icon || readApplications.getIcon(oApp),
@@ -639,7 +640,7 @@ sap.ui.define([
         var sHashFromInbound;
 
         if (bAddTargetURL) {
-            sHashFromInbound = utilsCdm.toHashFromInbound(oInb);
+            sHashFromInbound = utilsCdm.toHashFromInbound(oInb, sAppId);
             if (sHashFromInbound) {
                 oResult.targetURL = "#" + sHashFromInbound;
             }