@sapui5/sap.ushell 1.123.1 → 1.124.2

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.123.1
+ * @version 1.124.2
  * @deprecated since 1.120 Please use {@link sap.ushell.services.PersonalizationV2} instead
  */
 sap.ui.define([
@@ -62,9 +62,13 @@ sap.ui.define([
      * @class
      * @classdesc The Unified Shell's personalization service, which provides a personalizer object that handles all personalization operations.
      *
-     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
-     * <code>sap.ushell.Container.getServiceAsync("ClientSideTargetResolution")</code>. For details, see
-     * {@link sap.ushell.Container#getServiceAsync}.
+     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
+     * <pre>
+     *   sap.ui.require(["sap/ushell/Container"], async function (Container) {
+     *     const Personalization = await Container.getServiceAsync("Personalization");
+     *     // do something with the Personalization service
+     *   });
+     * </pre>
      *
      * @param {object} oAdapter the service adapter for the personalization service, as already provided by the container
      * @param {object} oContainerInterface Container Interface

package/src/main/js/sap/ushell/services/PersonalizationV2/constants.js

@@ -6,18 +6,47 @@ sap.ui.define([
     // these constants are exposed through the Personalization prototype
 
     /**
-     * @alias sap.ushell.services.PersonalizationV2.constants
-     * @since 1.120.0
+     * @alias sap.ushell.services.PersonalizationV2.KeyCategory
+     * @enum {string}
+     *
+     * @since 1.124.0
      * @public
      */
+    const oKeyCategory = {
+        /**
+         * A static hard-coded key which does not change. This value is required for caching to take place.
+         * @public
+         */
+        FIXED_KEY: "FIXED_KEY",
+        /**
+         * For all other cases.
+         * @public
+         */
+        GENERATED_KEY: "GENERATED_KEY"
+    };
+
+    /**
+     * @alias sap.ushell.services.PersonalizationV2.WriteFrequency
+     * @enum {string}
+     *
+     * @since 1.124.0
+     * @public
+     */
+    const oWriteFrequency = {
+        /**
+         * @public
+         */
+        HIGH: "HIGH",
+        /**
+         * The key is typically rarely updated, for example in explicit table personalization by end users.
+         * @public
+         */
+        LOW: "LOW"
+    };
+
+
     return {
-        keyCategory: {
-            FIXED_KEY: "FIXED_KEY",
-            GENERATED_KEY: "GENERATED_KEY"
-        },
-        writeFrequency: {
-            HIGH: "HIGH",
-            LOW: "LOW"
-        }
+        keyCategory: oKeyCategory,
+        writeFrequency: oWriteFrequency
     };
 });

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.123.1
+ * @version 1.124.2
  */
 sap.ui.define([
     "sap/base/Log",
@@ -49,22 +49,28 @@ sap.ui.define([
 
     /**
      * @typedef {object} sap.ushell.services.PersonalizationV2.Scope
-     * currently the validity property of the scope object is relevant:
-     * @property {int} [validity=Infinity] validity of the container persistence in minutes<br>
-     *     0 ( per FLP Window), <br>
-     *     Infinity, undefined  (front-end server persistence per user )<br>
-     *     x Minutes (front-end server persistence per user, ignored if older than x minutes)
-     * @property {sap.ushell.services.PersonalizationV2.constants.keyCategory} [keyCategory=GENERATED_KEY] Type or category of key
-     * @property {sap.ushell.services.PersonalizationV2.constants.writeFrequency} [writeFrequency=HIGH] Expected frequency how often users will use this container to store data inside
-     * @property {boolean} [clientStorageAllowed=false] Defines if storage on client side should be allowed or not
-     * @property {boolean} [shared=false] Indicates the container is intended to be shared across multiple applications
+     * The scope controls the behavior of the container used by the personalization service.
+     * @property {int} [validity=Infinity] validity of the container persistence in minutes. Available values:<br>
+     * · 0 - The data is persisted in the launchpad window, and is lost when the window is closed or when the launchpad is reloaded. <br>
+     * · Infinity - The data is persisted on the front-end server without any time restrictions.<br>
+     * · x Minutes - Number of minutes the data is to be persisted on the front-end server, for example 30.<br>
+     *
+     * For validity > 0 (including infinity) a copy of the container is stored in the volatile memory of the launchpad
+     * window in the browser. Therefore, no roundtrip is necessary for reloading a container at a later point in time.
+     * Only if the launchpad itself is reloaded, the copy is lost and a roundtrip is necessary.
+     * @property {sap.ushell.services.PersonalizationV2.KeyCategory} [keyCategory=GENERATED_KEY] Type or category of key
+     * @property {sap.ushell.services.PersonalizationV2.WriteFrequency} [writeFrequency=HIGH] Expected frequency how often users will use this container to store data inside
+     * @property {boolean} [clientStorageAllowed=false] Defines if storage on client side should be allowed or not.
+     * Security-relevant data must not be stored on client side, for instance in local storage or in the HTTP browser cache.
+     * Applications should set this parameter to <code>true</code> only if the data is not critical from a security point of view.
+     * @property {boolean} [shared=false] Indicates the container is intended to be shared across multiple applications.
      *
      * @public
      */
 
     /**
      * @typedef {object} sap.ushell.services.PersonalizationV2.PersId
-     * currently the validity property of the scope object is relevant:
+     * The persId identifies the stored personalization container.
      * @property {string} container Identifies the set of personalization data that is loaded/saved as one bundle from the front-end server.
      * @property {string} item The name of the object the personalization is applied to.
      *
@@ -86,9 +92,13 @@ sap.ui.define([
      * @classdesc The Unified Shell's personalization service.
      * Provides a personalizer object that handles all personalization operations.
      *
-     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
-     * <code>sap.ushell.Container.getServiceAsync("PersonalizationV2")</code>. For details, see
-     * {@link sap.ushell.Container#getServiceAsync}.
+     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
+     * <pre>
+     *   sap.ui.require(["sap/ushell/Container"], async function (Container) {
+     *     const PersonalizationV2 = await Container.getServiceAsync("PersonalizationV2");
+     *     // do something with the PersonalizationV2 service
+     *   });
+     * </pre>
      *
      * @param {object} oAdapter the service adapter for the personalization service, as already provided by the container
      * @param {object} oContainerInterface Container Interface
@@ -123,9 +133,15 @@ sap.ui.define([
     }
 
     PersonalizationV2.prototype.SAVE_DEFERRED_DROPPED = "Deferred save dropped (OK) - Data superseded by subsequent save";
+
     //constants for scope of personalization service
+    // legacy access to constants
     PersonalizationV2.prototype.constants = publicConstants;
 
+    // Expose enums defined in PersonalizationV2/constants.js
+    PersonalizationV2.prototype.KeyCategory = publicConstants.keyCategory;
+    PersonalizationV2.prototype.WriteFrequency = publicConstants.writeFrequency;
+
     /**
      * Configures the adapter to store app variants. When app variant storage is enabled,
      * personalization on app variants is handled and stored using a separate adapter.

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.123.1
+ * @version 1.124.2
  */
 sap.ui.define([
     "sap/base/Log",
@@ -37,9 +37,13 @@ sap.ui.define([
      * @class
      * @classdesc The Unified Shell's PluginManager service.
      *
-     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
-     * <code>sap.ushell.Container.getServiceAsync("PluginManager")</code>. For details, see
-     * {@link sap.ushell.Container#getServiceAsync}.
+     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
+     * <pre>
+     *   sap.ui.require(["sap/ushell/Container"], async function (Container) {
+     *     const PluginManager = await Container.getServiceAsync("PluginManager");
+     *     // do something with the PluginManager service
+     *   });
+     * </pre>
      *
      * @hideconstructor
      *

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview resolves references
- * @version 1.123.1
+ * @version 1.124.2
  */
 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.123.1
+ * @version 1.124.2
  */
 sap.ui.define(["sap/ui/core/Lib"], function (Library) {
     "use strict";
@@ -12,9 +12,13 @@ sap.ui.define(["sap/ui/core/Lib"], function (Library) {
      * @class
      * @classdesc The Unified Shell's Search service.
      *
-     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
-     * <code>sap.ushell.Container.getServiceAsync("Search")</code>. For details, see
-     * {@link sap.ushell.Container#getServiceAsync}.
+     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
+     * <pre>
+     *   sap.ui.require(["sap/ushell/Container"], async function (Container) {
+     *     const Search = await Container.getServiceAsync("Search");
+     *     // do something with the Search service
+     *   });
+     * </pre>
      *
      * @hideconstructor
      *

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's Search for myHome.
  *
- * @version 1.123.1
+ * @version 1.124.2
  */
 sap.ui.define([
     "sap/base/Log",
@@ -24,9 +24,13 @@ sap.ui.define([
      * @class
      * @classdesc The Unified Shell's search service for CEP myHome.
      *
-     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
-     * <code>sap.ushell.Container.getServiceAsync("SearchCEP")</code>. For details, see
-     * {@link sap.ushell.Container#getServiceAsync}.
+     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
+     * <pre>
+     *   sap.ui.require(["sap/ushell/Container"], async function (Container) {
+     *     const SearchCEP = await Container.getServiceAsync("SearchCEP");
+     *     // do something with the SearchCEP service
+     *   });
+     * </pre>
      *
      * @param {object} oAdapter the service adapter for the search service, as already provided by the container
      * @param {object} oContainerInterface oContainerInterface

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module exposes the searchable content.
- * @version 1.123.1
+ * @version 1.124.2
  */
 sap.ui.define([
     "sap/ushell/Config",
@@ -41,9 +41,13 @@ sap.ui.define([
      * @class
      * @classdesc The Unified Shell's SearchableContent service.
      *
-     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
-     * <code>sap.ushell.Container.getServiceAsync("SearchableContent")</code>. For details, see
-     * {@link sap.ushell.Container#getServiceAsync}.
+     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
+     * <pre>
+     *   sap.ui.require(["sap/ushell/Container"], async function (Container) {
+     *     const SearchableContent = await Container.getServiceAsync("SearchableContent");
+     *     // do something with the SearchableContent service
+     *   });
+     * </pre>
      *
      * @hideconstructor
      *

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview Shell Navigation Service.
- * @version 1.123.1
+ * @version 1.124.2
  * @deprecated since 1.120
  */
 sap.ui.define([
@@ -16,9 +16,13 @@ sap.ui.define([
      * @class
      * @classdesc The Unified Shell's internal navigation service (platform independent).
      *
-     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
-     * <code>sap.ushell.Container.getServiceAsync("ShellNavigation")</code>. For details, see
-     * {@link sap.ushell.Container#getServiceAsync}.
+     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
+     * <pre>
+     *   sap.ui.require(["sap/ushell/Container"], async function (Container) {
+     *     const ShellNavigation = await Container.getServiceAsync("ShellNavigation");
+     *     // do something with the ShellNavigation service
+     *   });
+     * </pre>
      *
      * This interface is for consumption by shell renderers/containers only
      *
@@ -84,7 +88,7 @@ sap.ui.define([
          *
          * @see sap.ushell.services.ShellNavigation#registerNavigationFilter
          * @private
-         * @ui5-restricted sap.fl
+         * @ui5-restricted sap.ui.fl
          */
         this.NavigationFilterStatus = this._oShellNavigationInternal.NavigationFilterStatus;
 
@@ -218,7 +222,7 @@ sap.ui.define([
      *
      * @see sap.ushell.services.ShellNavigation#registerNavigationFilter
      * @private
-     * @ui5-restricted sap.fl
+     * @ui5-restricted sap.ui.fl
      */
     ShellNavigation.prototype.registerNavigationFilter = function (fnFilter) {
         this._oShellNavigationInternal.registerNavigationFilter(fnFilter);
@@ -235,7 +239,7 @@ sap.ui.define([
      *
      * @see sap.ushell.services.ShellNavigation#registerNavigationFilter
      * @private
-     * @ui5-restricted sap.fl
+     * @ui5-restricted sap.ui.fl
      */
     ShellNavigation.prototype.unregisterNavigationFilter = function (fnFilter) {
         this._oShellNavigationInternal.unregisterNavigationFilter(fnFilter);

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

@@ -17,9 +17,13 @@ sap.ui.define([
      * @class
      * @classdesc The Unified Shell's internal navigation service (platform independent).
      *
-     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
-     * <code>sap.ushell.Container.getServiceAsync("ShellNavigationInternal")</code>. For details, see
-     * {@link sap.ushell.Container#getServiceAsync}.
+     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
+     * <pre>
+     *   sap.ui.require(["sap/ushell/Container"], async function (Container) {
+     *     const ShellNavigationInternal = await Container.getServiceAsync("ShellNavigationInternal");
+     *     // do something with the ShellNavigationInternal service
+     *   });
+     * </pre>
      *
      * This interface is for consumption by shell renderers/containers only
      *
@@ -65,6 +69,7 @@ sap.ui.define([
      *
      * @since 1.121.0
      * @private
+     * @ui5-restricted sap.ui.fl
      */
     function ShellNavigationInternal (oContainerInterface, sParameters, oServiceConfiguration) {
         function requestReload () {
@@ -129,7 +134,7 @@ sap.ui.define([
          *   This object can be used inside dirty flag providers to take
          *   corresponding actions.
          *
-         * @protected
+         * @private
          */
         this.getNavigationContext = function () {
             var oNavigationState = this.hashChanger.getCurrentNavigationState();
@@ -284,7 +289,7 @@ sap.ui.define([
          * @param {object} [oComponent] optional, a SAP UI5 Component
          * @param {boolean} [bTransient] whether an transient appstate is sufficient
          * @returns {Promise} a promise, whose first argument of resolve is
-         * @protected
+         * @private
          */
         this.compactParams = function (oParams, aRetainedParameters, oComponent, bTransient) {
             return this.hashChanger.compactParams(oParams, aRetainedParameters, oComponent, bTransient);
@@ -342,7 +347,7 @@ sap.ui.define([
          * @param {function} fnShellCallback The callback method for hash changes
          * @returns {object} this
          *
-         * @public
+         * @private
          */
         this.init = function (fnShellCallback) {
             this._bIsInitialNavigation = true;
@@ -402,7 +407,7 @@ sap.ui.define([
          * It's reserved uniquely for internal shell consumption and its signature or result might change at any time.
          *
          * @returns {boolean} Whether <code>hasher#replaceHash</code> was called after the last navigation.
-         * @protected
+         * @private
          */
         this.wasHistoryEntryReplaced = function () {
             return this._lastHashChangeMode === "replaceHash";
@@ -418,7 +423,7 @@ sap.ui.define([
          * This method should not be used externally.
          * It's reserved uniquely for internal shell consumption and its signature or result might change at any time.
          *
-         * @protected
+         * @private
          */
         this.resetHistoryEntryReplaced = function () {
             this._lastHashChangeMode = null;
@@ -429,7 +434,7 @@ sap.ui.define([
          *
          * @param {string} sNewHash new hash fragment
          *
-         * @protected
+         * @private
          */
         this.replaceHashWithoutNavigation = function (sNewHash) {
             hasher.changed.active = false; //disable changed signal
@@ -447,7 +452,7 @@ sap.ui.define([
          *
          * @see sap.ushell.services.ShellNavigationInternal#registerNavigationFilter
          * @private
-         * @ui5-restricted sap.fl
+         * @ui5-restricted sap.ui.fl
          */
         this.NavigationFilterStatus = this.hashChanger.NavigationFilterStatus;
 
@@ -464,7 +469,7 @@ sap.ui.define([
          *
          * @see sap.ushell.services.ShellNavigationInternal#registerNavigationFilter
          * @private
-         * @ui5-restricted sap.fl
+         * @ui5-restricted sap.ui.fl
          */
         this.registerNavigationFilter = function (fnFilter) {
             this.hashChanger.registerNavigationFilter(fnFilter);
@@ -486,7 +491,7 @@ sap.ui.define([
          *
          * @see sap.ushell.services.ShellNavigationInternal#registerNavigationFilter
          * @private
-         * @ui5-restricted sap.fl
+         * @ui5-restricted sap.ui.fl
          */
         this.unregisterNavigationFilter = function (fnFilter) {
             this.hashChanger.unregisterNavigationFilter(fnFilter);

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.123.1
+ * @version 1.124.2
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",
@@ -44,9 +44,13 @@ sap.ui.define([
      * will cause an increment of the frequency count, regardless of whether or not the navigation was successful.
      * <p>
      *
-     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
-     * <code>sap.ushell.Container.getServiceAsync("ClientSideTargetResolution")</code>. For details, see
-     * {@link sap.ushell.Container#getServiceAsync}.
+     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
+     * <pre>
+     *   sap.ui.require(["sap/ushell/Container"], async function (Container) {
+     *     const SmartNavigation = await Container.getServiceAsync("SmartNavigation");
+     *     // do something with the SmartNavigation service
+     *   });
+     * </pre>
      *
      * @augments sap.ushell.services.Service
      * @hideconstructor

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview APIs for the S/4 MyHome
- * @version 1.123.1
+ * @version 1.124.2
  */
 sap.ui.define([
     "sap/ushell/Config",
@@ -32,9 +32,13 @@ sap.ui.define([
      * @classdesc This service provides APIs for the S/4 MyHome.
      * For FLP internal usage, the internal APIs should be used directly.
      *
-     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
-     * <code>sap.ushell.Container.getServiceAsync("SpaceContent")</code>. For details, see
-     * {@link sap.ushell.Container#getServiceAsync}.
+     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
+     * <pre>
+     *   sap.ui.require(["sap/ushell/Container"], async function (Container) {
+     *     const SpaceContent = await Container.getServiceAsync("SpaceContent");
+     *     // do something with the SpaceContent service
+     *   });
+     * </pre>
      *
      * @hideconstructor
      *

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

@@ -13,9 +13,13 @@ sap.ui.define([
      * @class
      * @classdesc The Unified Shell's SupportTicket service.
      *
-     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
-     * <code>sap.ushell.Container.getServiceAsync("SupportTicket")</code>. For details, see
-     * {@link sap.ushell.Container#getServiceAsync}.
+     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
+     * <pre>
+     *   sap.ui.require(["sap/ushell/Container"], async function (Container) {
+     *     const SupportTicket = await Container.getServiceAsync("SupportTicket");
+     *     // do something with the SupportTicket service
+     *   });
+     * </pre>
      *
      * @param {object} oAdapter
      *            the service adapter for the support ticket service,
@@ -23,9 +27,7 @@ sap.ui.define([
      * @param {object} oContainerInterface
      *            the interface provided by the container
      * @param {string} sParameters
-     *            the runtime configuration specified in the
-     *            <code>sap.ushell.Container.getServiceAsync()</code> call (not
-     *            evaluated yet)
+     *            the specified runtime configuration (not evaluated yet)
      * @param {object} oServiceConfiguration
      *            the service configuration defined in the
      *            bootstrap configuration; the boolean property

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's UI tracing service.
  *
- * @version 1.123.1
+ * @version 1.124.2
  */
 sap.ui.define([
     "sap/ushell/EventHub",
@@ -33,9 +33,13 @@ sap.ui.define([
      * @classdesc Allows passing trace entries from the client to a service endpoint in CEP.
      * UI traces can be used for metering or usage analysis.
      *
-     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
-     * <code>sap.ushell.Container.getServiceAsync("UITracer")</code>. For details, see
-     * {@link sap.ushell.Container#getServiceAsync}.
+     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
+     * <pre>
+     *   sap.ui.require(["sap/ushell/Container"], async function (Container) {
+     *     const UITracer = await Container.getServiceAsync("UITracer");
+     *     // do something with the UITracer service
+     *   });
+     * </pre>
      *
      * <p>
      * Besides the trace method the UITracer listens to the EventHub event "UITracer.trace"