@sapui5/sap.ushell 1.117.2 → 1.119.0

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

@@ -1,12 +1,14 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 /**
- * @fileOverview
+ * @fileOverview This module prepares the navigation data.
  *
- * <p>This module prepares the navigation data needed by the page dereferencer.</p>
+ * It provides the inbound and systemAlias data for the pages runtime.
+ * Only used on the ABAP platform and on local for testing.
  *
- * @version 1.117.2
+ * Configured with the ClientSideTargetResolutionAdapter.
+ *
+ * @version 1.119.0
  */
-
 sap.ui.define([
     "sap/ushell/resources"
 ], function (resources) {
@@ -19,7 +21,7 @@ sap.ui.define([
      *
      * @namespace sap.ushell.services.NavigationDataProvider
      *
-     * @constructor
+     * @class
      * @see sap.ushell.services.Container#getServiceAsync
      * @experimental Since 1.68.0
      *

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

@@ -226,7 +226,7 @@ sap.ui.define([
          * Returns the number of  notifications<br>
          * e.g. Notifications for user.
          *
-         * @returns {number} Returns the number of notifications of the user
+         * @returns {int} Returns the number of notifications of the user
          * @since 1.44
          * @public
          * @alias sap.ushell.services.Notifications#getNotificationsCount
@@ -786,7 +786,7 @@ sap.ui.define([
         };
 
         /**
-         * @return {boolean} boolean value whether first request was already performed and data was returned.<br>
+         * @returns {boolean} boolean value whether first request was already performed and data was returned.<br>
          * @since 1.38
          * @public
          * @alias sap.ushell.services.Notifications#isFirstDataLoaded
@@ -796,7 +796,7 @@ sap.ui.define([
         };
 
         /**
-         * @return {Promise} Promise object that is resolved with the settings from the sever
+         * @returns {Promise} Promise object that is resolved with the settings from the sever
          * @since 1.41
          * @private
          */
@@ -809,7 +809,7 @@ sap.ui.define([
         };
 
         /**
-         * @returns {Object} oPromise
+         * @returns {object} oPromise
          * @since 1.41
          * @private
          */
@@ -819,7 +819,7 @@ sap.ui.define([
         };
 
         /**
-         * @returns {Object} promise
+         * @returns {object} promise
          * @since 1.41
          * @private
          */
@@ -854,7 +854,7 @@ sap.ui.define([
         };
 
         /**
-         * @returns {Boolean} value indicating whether the Push to Mobile capability is supported by the Notification channel
+         * @returns {boolean} value indicating whether the Push to Mobile capability is supported by the Notification channel
          * @since 1.43
          * @private
          */
@@ -902,7 +902,7 @@ sap.ui.define([
         };
 
         /**
-         * @returns {Boolean} value indicating whether the Push to Mobile capability is supported by the Notification channel
+         * @returns {boolean} value indicating whether the Push to Mobile capability is supported by the Notification channel
          * @since 1.43
          * @private
          */
@@ -946,8 +946,8 @@ sap.ui.define([
          * This function is similar to _readNotificationsData.
          * In the future the two functions will be sent together in a single batch request, when batch is supported.
          *
-         * @param {Boolean} bUpdateCustomers boolean parameter indicating whether to update the registered consumers or not
-         * @returns {Object} promise
+         * @param {boolean} bUpdateCustomers boolean parameter indicating whether to update the registered consumers or not
+         * @returns {object} promise
          * @private
          */
         this._readUnseenNotificationsCount = function (bUpdateCustomers) {
@@ -992,7 +992,7 @@ sap.ui.define([
 
         /**
          * Fetching the number of notifications for user<br>
-         * @returns {Object} promise
+         * @returns {object} promise
          */
         this.readNotificationsCount = function () {
             var oDeferred = new jQuery.Deferred(),
@@ -1031,7 +1031,7 @@ sap.ui.define([
         };
 
         /**
-         * @return {Promise} Returns promise object that is resolved if Notification settings data is available, and rejected if not
+         * @returns {Promise} Returns promise object that is resolved if Notification settings data is available, and rejected if not
          * @private
          */
         this._getNotificationSettingsAvailability = function () {
@@ -1088,8 +1088,8 @@ sap.ui.define([
          *   - Notifications update consumers are updated
          *   - Dependent consumers are updated (i.e. call that._updateDependentNotificationsConsumers())
          *
-         * @param {Boolean} bUpdateConsumers value indicating whether the consumers should be updated
-         * @returns {Object} oDeferred.promise() object, indicating success of both read actions
+         * @param {boolean} bUpdateConsumers value indicating whether the consumers should be updated
+         * @returns {object} oDeferred.promise() object, indicating success of both read actions
          * @private
          */
         this._readNotificationsData = function (bUpdateConsumers) {
@@ -1320,7 +1320,7 @@ sap.ui.define([
         /**
          * Verifying whether the "push notifications to mobile" feature is supported.
          *
-         * @return {Object} A Deferred.promise object that is always resolved even if the request failed.<br>
+         * @returns {object} A Deferred.promise object that is always resolved even if the request failed.<br>
          *   In case of failure - the response property successStatus gets the value <code>false</code>
          */
         this._readMobileSettingsFromServer = function () {
@@ -1330,7 +1330,7 @@ sap.ui.define([
         /**
          * Verifying whether the "push notifications to mobile" feature is supported.
          *
-         * @return {Object} A Deferred.promise object that is always resolved even if the request failed.<br>
+         * @returns {object} A Deferred.promise object that is always resolved even if the request failed.<br>
          *   In case of failure - the response property successStatus gets the value <code>false</code>
          */
         this._readEmailSettingsFromServer = function () {
@@ -1384,7 +1384,7 @@ sap.ui.define([
         /**
          * Verifying whether the WebSocket is active (while it is already opened)
          *
-         * @return {Object} A Deferred.promise object that is always resolved even if the request fails.<br>
+         * @returns {object} A Deferred.promise object that is always resolved even if the request fails.<br>
          *   The actual response is returned as the done function's boolean parameter:<br>
          *   In case of active WebSocket - the value <code>true</code> is returned, and <code>false</code> otherwise.
          */

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's page building service.
  *
- * @version 1.117.2
+ * @version 1.119.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery"
@@ -22,7 +22,6 @@ sap.ui.define([
      *
      * @class The Unified Shell's page building service.
      *
-     * @constructor
      * @see sap.ushell.services.Container#getServiceAsync
      * @since 1.15.0
      * @private

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

@@ -1,12 +1,12 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 /**
- * @fileOverview
+ * @fileOverview <p>This module deals with the page persistence.</p>
  *
- * <p>This module deals with the page persistence.</p>
+ * 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.117.2
+ * @version 1.119.0
  */
-
 sap.ui.define([], function () {
     "use strict";
 
@@ -18,11 +18,11 @@ sap.ui.define([], function () {
      * @namespace sap.ushell.services.PagePersistence
      *
      * @param {object} adapter
-     *     the page persistancy adapter for the frontend server
+     *     the page persistency adapter for the frontend server
      * @param {object} serviceConfiguration
      *     the page persistency service configuration
      *
-     * @constructor
+     * @class
      * @see sap.ushell.services.Container#getServiceAsync
      * @experimental Since 1.67.0
      *

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.117.2
+ * @version 1.119.0
  */
 sap.ui.define([
     "sap/ushell/services/_PageReferencing/PageReferencer"
@@ -15,7 +15,7 @@ sap.ui.define([
      * Constructs a new instance of the page referencing service.
      *
      * @namespace sap.ushell.services.PageReferencing
-     * @constructor
+     * @class
      * @see sap.ushell.services.Container#getServiceAsync
      * @experimental Since 1.68.0
      *

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.117.2
+ * @version 1.119.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -40,7 +40,6 @@ sap.ui.define([
      *
      * @namespace sap.ushell.services.PageReferencing
      *
-     * @constructor
      * @class
      * @see {@link sap.ushell.services.Container#getServiceAsync}
      * @since 1.72.0
@@ -409,7 +408,7 @@ sap.ui.define([
      * @param {int} iSourceSectionIndex The index of the section from where the visualization is deleted.
      * @param {int} iSourceVisualizationIndex The index of the deleted visualization.
      *
-     * @returns {Promise<void>} Promise which resolves after the personalization was saved.
+     * @returns {Promise<undefined>} Promise which resolves after the personalization was saved.
      *
      * @since 1.75.0
      * @private
@@ -520,7 +519,7 @@ sap.ui.define([
      * @param {string} sVizId The id of the visualization to add.
      * @param {string} sDisplayFormatHint The form factor of the visualization to add.
      *
-     * @returns {Promise<void>} Promise which resolves after the personalization was saved.
+     * @returns {Promise<undefined>} Promise which resolves after the personalization was saved.
      *
      * @since 1.75.0
      *
@@ -615,7 +614,7 @@ sap.ui.define([
      * @param {string} sPageId The id of the page the visualization should be added to.
      * @param {string|null} [sSectionId] The id of the section the visualization should be added to. If null is given, the default section is used.
      * @param {object} oVizData An object containing the vizData from the model.
-     * @return {Promise<undefined>} A promise resolving when the copy action was completed.
+     * @returns {Promise<undefined>} A promise resolving when the copy action was completed.
      *
      * @private
      * @since 1.94.0
@@ -648,7 +647,7 @@ sap.ui.define([
      * @param {int} iSourceSectionIndex The index of the moved section.
      * @param {int} iTargetSectionIndex The new index of the moved section.
      *
-     * @returns {Promise<void>} Promise which resolves after the personalization was saved.
+     * @returns {Promise<undefined>} Promise which resolves after the personalization was saved.
      *
      * @since 1.75.0
      *
@@ -708,7 +707,7 @@ sap.ui.define([
      * @param {int} iSectionIndex The index of the added section.
      * @param {object} [oSectionProperties] Properties of the added section.
      *
-     * @returns {Promise<void>} Promise which resolves after the personalization was saved.
+     * @returns {Promise<undefined>} Promise which resolves after the personalization was saved.
      *
      * @since 1.75.0
      *
@@ -795,7 +794,7 @@ sap.ui.define([
      * @param {int} iPageIndex The index of the page containing the deleted section.
      * @param {int} iSectionIndex The index of deleted section.
      *
-     * @returns {Promise<void>} Promise which resolves after the personalization was saved.
+     * @returns {Promise<undefined>} Promise which resolves after the personalization was saved.
      *
      * @since 1.75.0
      *
@@ -834,9 +833,9 @@ sap.ui.define([
      *
      * @param {int} iPageIndex The index of the page containing the section.
      * @param {int} iSectionIndex The index of the section.
-     * @param {bool} bVisibility The new visibility value.
+     * @param {boolean} bVisibility The new visibility value.
      *
-     * @returns {Promise<void>} Promise which resolves after the personalization was saved.
+     * @returns {Promise<undefined>} Promise which resolves after the personalization was saved.
      *
      * @since 1.75.0
      *
@@ -881,7 +880,7 @@ sap.ui.define([
      * @param {int} iSectionIndex The index of the section.
      * @param {string} sNewTitle The new title value.
      *
-     * @returns {Promise<void>} Promise which resolves after the personalization was saved.
+     * @returns {Promise<undefined>} Promise which resolves after the personalization was saved.
      *
      * @since 1.75.0
      * @private
@@ -918,7 +917,7 @@ sap.ui.define([
      * @param {int} iPageIndex The index of the page containing the section.
      * @param {int} iSectionIndex The index of the section.
      *
-     * @returns {Promise<void>} Promise which resolves after the personalization was saved.
+     * @returns {Promise<undefined>} Promise which resolves after the personalization was saved.
      *
      * @since 1.75.0
      *
@@ -1010,7 +1009,7 @@ sap.ui.define([
      *
      * @param {int} iPageIndex The index of the page.
      *
-     * @returns {Promise<void>} Promise which resolves after the personalization was saved.
+     * @returns {Promise<undefined>} Promise which resolves after the personalization was saved.
      *
      * @since 1.75.0
      *
@@ -1070,7 +1069,7 @@ sap.ui.define([
      *
      * @since 1.76.0
      *
-     * @param {bool} bState The new personalization state
+     * @param {boolean} bState The new personalization state
      *
      * @private
      */
@@ -1089,7 +1088,7 @@ sap.ui.define([
      * In case no page id was provided and if {@link #enableImplicitSave} was set to false, all unsaved modified pages are saved.
      * @param {string} [sPageId] the id of the page which should be saved
      *
-     * @returns {Promise<void>} Promise which resolves after the personalization was saved.
+     * @returns {Promise<undefined>} Promise which resolves after the personalization was saved.
      * @see #enableImplicitSave()
      *
      * @since 1.74.0
@@ -1135,7 +1134,7 @@ sap.ui.define([
      * Saves the personalization depending on the default of the implicit save
      * @param {string} sPageId the id of the page which should be saved
      *
-     * @returns {Promise<void>} Promise which resolves after the personalization was saved.
+     * @returns {Promise<undefined>} Promise which resolves after the personalization was saved.
      *
      * @since 1.85.0
      * @private
@@ -1237,7 +1236,7 @@ sap.ui.define([
      *
      * @param {int} pageIndex The index of the page containing the section.
      * @param {int} sectionIndex The index of the section containing the visualizations.
-     * @returns {Promise<void>} Promise which resolves after all visualizations have been checked (and removed).
+     * @returns {Promise<undefined>} Promise which resolves after all visualizations have been checked (and removed).
      *
      * @since 1.90.0
      * @private
@@ -1340,7 +1339,7 @@ sap.ui.define([
      * @param {string} [sectionId] The id of the section to which the bookmark should be added.
      * @param {string} [sContentProviderId] The contentProviderId or undefined outside the cFLP
      *
-     * @returns {Promise<void>} Promise which resolves after the personalization was saved.
+     * @returns {Promise<undefined>} Promise which resolves after the personalization was saved.
      *
      * @since 1.75.0
      *
@@ -1480,7 +1479,7 @@ sap.ui.define([
      * Currently the returned Promise does not wait for the visitorFunctions to finish asynchronous tasks!
      *
      * @param {function} fnVisitor The visitor function
-     * @returns {Promise<void>} A Promise that resolves once all the pages were visited
+     * @returns {Promise<undefined>} A Promise that resolves once all the pages were visited
      *
      * @since 1.82.0
      * @private
@@ -1503,7 +1502,7 @@ sap.ui.define([
      * Currently the returned Promise does not wait for the visitorFunctions to finish asynchronous tasks!
      *
      * @param {function} fnVisitor The visitor function
-     * @returns {Promise<void>} A Promise that resolves once all the pages were visited
+     * @returns {Promise<undefined>} A Promise that resolves once all the pages were visited
      *
      * @since 1.82.0
      * @private
@@ -1522,7 +1521,7 @@ sap.ui.define([
      * Currently the returned Promise does not wait for the visitorFunctions to finish asynchronous tasks!
      *
      * @param {function} fnVisitor The visitor function
-     * @returns {Promise<void>} A Promise that resolves once all the pages were visited
+     * @returns {Promise<undefined>} A Promise that resolves once all the pages were visited
      *
      * @since 1.82.0
      * @private
@@ -1586,7 +1585,7 @@ sap.ui.define([
      *   The target URL of the bookmark
      * @param {string} [oIdentifier.vizType]
      *   The visualization type of the bookmark
-     * @returns {Promise<number>} A Promise that resolves to the number of bookmarks
+     * @returns {Promise<int>} A Promise that resolves to the number of bookmarks
      *
      * @since 1.82.0
      * @private
@@ -1610,7 +1609,7 @@ sap.ui.define([
      * @param {string} [pageId] The id of the page from which the bookmark should be removed.
      * @param {string} [sectionId] The id of the sectionId in the specified page from which the bookmark should be removed.
      *
-     * @returns {Promise<number>} A Promise that resolves to the number of deleted bookmarks
+     * @returns {Promise<int>} A Promise that resolves to the number of deleted bookmarks
      *
      * @since 1.82.0
      * @private
@@ -1663,7 +1662,7 @@ sap.ui.define([
      *   The visualization type of the bookmark
      * @param {object} oParameters The object of parameters to be changed
      *
-     * @returns {Promise<number>} A Promise that resolves to the number of updated bookmarks
+     * @returns {Promise<int>} A Promise that resolves to the number of updated bookmarks
      *
      * @since 1.83.0
      * @private
@@ -1854,7 +1853,7 @@ sap.ui.define([
      * @param {string} sVizRefId The the vizReference ID
      * @param {object} oUpdatedVisualization The updated visualization properties
      *
-     * @returns {Promise<void>} The promise resolves when the personalization was saved successfully
+     * @returns {Promise<undefined>} The promise resolves when the personalization was saved successfully
      *
      * @since 1.83
      * @private

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.117.2
+ * @version 1.119.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -107,7 +107,7 @@ sap.ui.define([
      * personalization on app variants is handled and stored using a separate adapter.
      *
      * @param {object} oAppVariantStorageConfig The service configuration for app variant storage.
-     * @return {object} An object like:
+     * @returns {object} An object like:
      *   <pre>
      *   {
      *     lazy: true,
@@ -220,7 +220,7 @@ sap.ui.define([
     /**
      * Attempts to retrieve the component of the currently running application.
      *
-     * @return {object} sap.ui.core.UIComponent
+     * @returns {object} sap.ui.core.UIComponent
      * @private
      */
     Personalization.prototype._getApplicationComponent = function () {
@@ -544,7 +544,7 @@ sap.ui.define([
      * This interface is deprecated since 1.22, please use getContainer / delContainer.
      *
      * Note: the underlying storage model for Objects stored with getContainer / getPersonalizationContainer is identical.<br/>
-     * Thus you can safely migrate your client implementation from the deprecated getContainer to getPersonalizationContainer without loss of data.
+     * Thus you can safely migrate your client implementation from the deprecated <code>getPersonalizationContainer</code> to <code>getContainer</code> without loss of data.
      * One may even run mixed set of applications on the same container keys.
      * The sole differences are w.r.t. client side handling of the Context data within one session.
      *
@@ -674,7 +674,7 @@ sap.ui.define([
      *
      * isResetEntirePersonalizationSupported needs to be called upfront in order to check if the current platform supports this method at all. Otherwise the method call will be rejected.
      *
-     * @returns {Promise<void>} promise for the deletion operation
+     * @returns {Promise<undefined>} promise for the deletion operation
      *
      * @see #isResetEntirePersonalizationSupported
      * @since 1.86.0

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.117.2
+ * @version 1.119.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -38,7 +38,6 @@ sap.ui.define([
      * Constructs a new instance of the PluginManager service.
      *
      * @class
-     * @constructor
      * @see sap.ushell.services.Container#getServiceAsync
      * @since 1.38
      * @private

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview resolves references
- * @version 1.117.2
+ * @version 1.119.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -86,7 +86,7 @@ sap.ui.define([
                 sValue = (sap.ushell.Container.getUser().getAccessibilityMode()) ? "X" : undefined;
             }
             if (sReference === "User.env.sap-statistics") {
-                sValue = (Configuration.getStatistics()) ? "true" : undefined;
+                sValue = (Configuration.getStatisticsEnabled()) ? "true" : undefined;
             }
             if (sReference === "User.env.sap-theme") {
                 sValue = sap.ushell.Container.getUser().getTheme(User.prototype.constants.themeFormat.THEME_NAME_PLUS_URL);

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.117.2
+ * @version 1.119.0
  */
 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.117.2
+ * @version 1.119.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -227,6 +227,7 @@ sap.ui.define([
                 defaultItemCount: 3,
                 maxItemCount: 10,
                 priority: 10,
+                closePopover: true,
                 itemPress: fnNoOpFunction,
                 popoverClosed: fnNoOpFunction
             };