@sapui5/sap.ushell 1.120.7 → 1.121.0

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

@@ -2,10 +2,11 @@
 
 /**
  * @file Exposes a CommonDataModel-based site document in a platform-neutral format to it's clients
- * @version 1.120.7
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/ushell/services/_CommonDataModel/PersonalizationProcessor",
+    "sap/ushell/services/_CommonDataModel/vizTypeDefaults/VizTypeDefaults",
     "sap/base/util/ObjectPath",
     "sap/ui/thirdparty/jquery",
     "sap/base/util/isPlainObject",
@@ -21,10 +22,10 @@ sap.ui.define([
     "sap/ushell/library",
     "sap/ushell/utils",
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readApplications",
-    "sap/base/Log",
-    "sap/ui/core/Manifest"
+    "sap/base/Log"
 ], function (
     PersonalizationProcessor,
+    VizTypeDefaults,
     ObjectPath,
     jQuery,
     isPlainObject,
@@ -40,8 +41,7 @@ sap.ui.define([
     ushellLibrary,
     ushellUtils,
     readApplications,
-    Log,
-    Manifest
+    Log
 ) {
     "use strict";
 
@@ -52,11 +52,6 @@ sap.ui.define([
     var ContentNodeType = ushellLibrary.ContentNodeType;
 
     var S_COMPONENT_NAME = "sap.ushell.services.CommonDataModel";
-    var O_STANDARD_VIZ_TYPES = {
-        STATIC_LAUNCHER: "sap.ushell.StaticAppLauncher",
-        DYNAMIC_LAUNCHER: "sap.ushell.DynamicAppLauncher",
-        CARD: "sap.ushell.Card"
-    };
 
     /**
      * @alias sap.ushell.services.CommonDataModel
@@ -66,7 +61,7 @@ sap.ui.define([
      *
      * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
      * <code>sap.ushell.Container.getServiceAsync("CommonDataModel")</code>. For details, see
-     * {@link sap.ushell.services.Container#getServiceAsync}.
+     * {@link sap.ushell.Container#getServiceAsync}.
      *
      * @param {object} oAdapter
      *   Adapter, provides an array of Inbounds
@@ -92,7 +87,6 @@ sap.ui.define([
         this._oSiteConverter = new SiteConverter();
         this._oPersonalizationDeltas = {};
         this._bLoadPersonalization = ushellUtils.isFlpHomeIntent();
-        this._oManifestCache = {};
         this._bPersonalizationLoadingFailed = false;
 
         // load site and personalization as early as possible in case of homepage loading
@@ -308,7 +302,7 @@ sap.ui.define([
      *   - groups
      * Everything else must not be changed.
      *
-     * @returns {jQuery.promise}
+     * @returns {jQuery.Promise}
      *    resolves with the Common Data Model site
      * @private
      *
@@ -328,7 +322,7 @@ sap.ui.define([
      * Returns the Common Data Model site without mixed personalization.
      * In case of the deep link we don't need to load and apply personalization
      * to the origin site, because personalization is used only for homepage
-     * @returns {jQuery.promise}
+     * @returns {jQuery.Promise}
      *    resolves with the Common Data Model site without personalization
      * @private
      *
@@ -353,8 +347,6 @@ sap.ui.define([
         var bEnablePersonalization = Config.last("/core/shell/enablePersonalization");
         var bEnableMyHome = Config.last("/core/spaces/myHome/enabled");
         var sMyHomePageId = Config.last("/core/spaces/myHome/myHomePageId");
-        var bStableIDsEnabled = Config.last("/core/stableIDs/enabled");
-        var bStableIDMigrationEnabled = Config.last("/core/stableIDs/migratePersonalization");
 
         return Promise.resolve(this._oGetSitePromise)
             .then(function () {
@@ -379,13 +371,10 @@ sap.ui.define([
                                 });
                         }.bind(this))
                         .then(function (oPersonalizedPage) {
-                            if (bStableIDsEnabled && bStableIDMigrationEnabled) {
-                                return this._migratePersonalizedPages([oPersonalizedPage])
-                                    .then(function (aMigratedPages) {
-                                        return aMigratedPages[0];
-                                    });
-                            }
-                            return oPersonalizedPage;
+                            return this._migratePersonalizedPages([oPersonalizedPage])
+                                .then(function (aMigratedPages) {
+                                    return aMigratedPages[0];
+                                });
                         }.bind(this));
                 }
                 return this._getPageFromAdapter(sPageId);
@@ -450,8 +439,6 @@ sap.ui.define([
         var bEnablePersonalization = Config.last("/core/shell/enablePersonalization");
         var bEnableMyHome = Config.last("/core/spaces/myHome/enabled");
         var sMyHomePageId = Config.last("/core/spaces/myHome/myHomePageId");
-        var bStableIDsEnabled = Config.last("/core/stableIDs/enabled");
-        var bStableIDMigrationEnabled = Config.last("/core/stableIDs/migratePersonalization");
 
         return Promise.resolve(this._oGetSitePromise)
             .then(function () {
@@ -481,10 +468,7 @@ sap.ui.define([
                                     });
                             }.bind(this)))
                                 .then(function (aPersonalizedPages) {
-                                    if (bStableIDsEnabled && bStableIDMigrationEnabled) {
-                                        return this._migratePersonalizedPages(aPersonalizedPages);
-                                    }
-                                    return aPersonalizedPages;
+                                    return this._migratePersonalizedPages(aPersonalizedPages);
                                 }.bind(this))
                                 .then(function (aPages) {
                                     return this._filterForProperPages(aPages);
@@ -843,7 +827,7 @@ sap.ui.define([
      *
      * @param {string} sGroupId
      *  Group id
-     * @returns {jQuery.promise}
+     * @returns {jQuery.Promise}
      *  Resolves with the respective group from the original site.
      *  In case the group is not existing in the original site,
      *  a respective error message is passed to the fail handler.
@@ -885,9 +869,7 @@ sap.ui.define([
      * changes since the last FLP reload.
      *
      * @param {string | string[]} [pageId] The ID of the page or an array of pageIds. Needs to be provided for CDM 3.1.0
-     * @returns {jQuery.promise}
-     *   The promise's done handler indicates whether the collected personalization has been saved successfully.
-     *   In case an error occurred, the promise's fail handler returns an error message.
+     * @returns {jQuery.Promise} Resolves once the save action was successful or rejects instead with an error message.
      * @private
      *
      * @see #getSite
@@ -946,10 +928,11 @@ sap.ui.define([
             })
             .then(function (oPersonalization) {
                 if (!isEmptyObject(oPersonalization)) {
-                    /* This is a problem based on the ADR which said ".version" but the CDM Adapter checks for "._version".
-                    * Now we have to check for both version notations and make sure both have been written so personalization
-                    * does not fail the version check.
-                    */
+                    /*
+                     * This is a problem based on the ADR which said ".version" but the CDM Adapter checks for "._version".
+                     * Now we have to check for both version notations and make sure both have been written so personalization
+                     * does not fail the version check.
+                     */
                     if (this._oPersonalizationDeltas.version === undefined || this._oPersonalizationDeltas._version === undefined) {
                         this._oPersonalizationDeltas.version = this._oOriginalSite._version;
                         this._oPersonalizationDeltas._version = this._oOriginalSite._version;
@@ -1001,10 +984,11 @@ sap.ui.define([
                     }
                     if (!isEmptyObject(oDelta.personalization)) {
                         bShouldSave = true;
-                        /* This is a problem based on the ADR which said ".version" but the CDM Adapter checks for "._version".
-                        * Now we have to check for both version notations and make sure both have been written so personalization
-                        * does not fail the version check.
-                        */
+                        /*
+                         * This is a problem based on the ADR which said ".version" but the CDM Adapter checks for "._version".
+                         * Now we have to check for both version notations and make sure both have been written so personalization
+                         * does not fail the version check.
+                         */
                         if (this._oPersonalizationDeltas.version === undefined || this._oPersonalizationDeltas._version === undefined) {
                             this._oPersonalizationDeltas.version = this._oOriginalSite._version;
                             this._oPersonalizationDeltas._version = this._oOriginalSite._version;
@@ -1194,7 +1178,7 @@ sap.ui.define([
      * This is useful for testing, if the value is undefined then an internal cache will be used.
      * To invalidate the internal cache, pass null as the value.
      *
-     * @returns {jQuery.promise}
+     * @returns {jQuery.Promise}
      *  A promise which may resolve to the list of plugins on the site.
      *  In the case where the promise gets resolved, it resolves to an immutable
      *  reference.
@@ -1425,7 +1409,7 @@ sap.ui.define([
      *  The site, including the standard visualization types
      * @private
      */
-    CommonDataModel.prototype._ensureStandardVizTypesPresent = function (oSite) {
+    CommonDataModel.prototype._ensureStandardVizTypesPresent = async function (oSite) {
         if (!(oSite._version && oSite._version.startsWith("3."))) {
             return Promise.resolve(oSite);
         }
@@ -1434,59 +1418,12 @@ sap.ui.define([
             oSite.vizTypes = {};
         }
 
-        var aPromises = [];
-
-        var oStandardManifests = {};
-        oStandardManifests[O_STANDARD_VIZ_TYPES.STATIC_LAUNCHER] = "sap/ushell/components/tiles/cdm/applauncher/manifest.json";
-        oStandardManifests[O_STANDARD_VIZ_TYPES.DYNAMIC_LAUNCHER] = "sap/ushell/components/tiles/cdm/applauncherdynamic/manifest.json";
-        oStandardManifests[O_STANDARD_VIZ_TYPES.CARD] = "sap/ushell/services/_CommonDataModel/vizTypeDefaults/cardManifest.json";
-
-        Object.keys(oStandardManifests).forEach(function (sVizType) {
-            if (!oSite.vizTypes[sVizType]) {
-                var sManifestUrl = oStandardManifests[sVizType];
-
-                var oPromise = this._loadManifest(sManifestUrl).then(function (oManifest) {
-                    oSite.vizTypes[sVizType] = oManifest;
-                });
-
-                aPromises.push(oPromise);
-            }
-        }.bind(this));
-
-        if (aPromises.length === 0) {
-            return Promise.resolve(oSite);
-        }
-        return Promise.all(aPromises).then(function () {
-            return oSite;
+        const oStandardVizTypes = await VizTypeDefaults.getAll();
+        Object.keys(oStandardVizTypes).map((sKey) => {
+            oSite.vizTypes[sKey] = oSite.vizTypes[sKey] || oStandardVizTypes[sKey];
         });
-    };
-
-    /**
-     * Loads the manifest and caches the result
-     * @param {string} sUrl
-     * path to the manifest e.g. "sap/ushell/components/tiles/cdm/applauncher/manifest.json"
-     * @returns {Promise<object>} Resolves the manifest
-     *
-     * @since 1.98.0
-     * @private
-     */
-    CommonDataModel.prototype._loadManifest = function (sUrl) {
-        if (!this._oManifestCache[sUrl]) {
-            var sManifestUrl = sap.ui.require.toUrl(sUrl);
 
-            this._oManifestCache[sUrl] = Manifest.load({
-                manifestUrl: sManifestUrl,
-                async: true
-            })
-                .then(function (oManifest) {
-                    return oManifest.getRawJson();
-                });
-        }
-        return this._oManifestCache[sUrl].then(function (oManifest) {
-            // we need to clone the object since the original is read only
-            // in addition we want to avoid inconsistencies
-            return deepClone(oManifest);
-        });
+        return Promise.resolve(oSite);
     };
 
     /**

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's Configuration service enables Components of any kind to consume parts of Configuration
  * provided by the shell. It allows to attach on updates and receive the current values
  *
- * @version 1.120.7
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/ushell/Config",
@@ -20,8 +20,9 @@ sap.ui.define([
      *
      * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
      * <code>sap.ushell.Container.getServiceAsync("Configuration")</code>. For details, see
-     * {@link sap.ushell.services.Container#getServiceAsync}.
+     * {@link sap.ushell.Container#getServiceAsync}.
      *
+     * @augments sap.ushell.services.Service
      * @hideconstructor
      *
      * @since 1.64.0
@@ -64,10 +65,9 @@ sap.ui.define([
          * @param {function} fnCallback The function to be called once the property changes. It receives
          *   a parameter of type {@link sap.m.TileSizeBehavior}.
          *
-         * @returns {object} detach handler - call detach() to detach from further updates
+         * @returns {{ detach: function }} detach handler - call detach() to detach from further updates
          *
          * @public
-         * @alias  sap.ushell.services.Configuration#attachSizeBehaviorUpdate
          */
         this.attachSizeBehaviorUpdate = function (fnCallback) {
             var oDoable = Config.on("/core/home/sizeBehavior");
@@ -84,8 +84,8 @@ sap.ui.define([
          *
          * @returns {Promise} a promise that is resolved with the site system aliases list
          *
-         * @private
          * @since 1.81.0
+         * @private
          */
         this.getAppsSystems = function () {
             var oDeferred = new jQuery.Deferred();

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's Configuration Defaults service exposes default configurations set in the code base.
  *
- * @version 1.120.7
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -19,7 +19,7 @@ sap.ui.define([
      *
      * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
      * <code>sap.ushell.Container.getServiceAsync("ConfigurationDefaults")</code>. For details, see
-     * {@link sap.ushell.services.Container#getServiceAsync}.
+     * {@link sap.ushell.Container#getServiceAsync}.
      *
      * @param {object} oAdapter The service adapter for the ConfigurationDefaults service
      *
@@ -51,7 +51,6 @@ sap.ui.define([
          * </pre>
          * If the configuration path was not found in the default settings, undefined value for this path is returned.
          * @private
-         * @alias  sap.ushell.services.Configuration#attachSizeBehaviorUpdate
          */
         this.getDefaults = function (aConfigurationPaths) {
             var that = this;

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

@@ -10,16 +10,17 @@ sap.ui.define([
     "use strict";
 
     /**
-     * Constructs a new Unified Shell container for the given container adapter.
+     * @alias sap.ushell.services.Container
+     * @namespace
+     * @description The Unified Shell's container. Manages renderers, services, and adapters.
      *
      * @param {object} oAdapter the platform-specific adapter corresponding to this service
-     * @class
-     * @classdesc The Unified Shell's container. Manages renderers, services, and adapters.
-     * @alias sap.ushell.services.Container
+     *
+     * @hideconstructor
+     *
      * @since 1.15.0
      * @deprecated since 1.101
      * @public
-     * @hideconstructor
      */
 
     Log.warning("The use of sap/ushell/services/Container is deprecated. Please use sap/ushell/Container instead!");

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

@@ -4,7 +4,7 @@
  * default adapter.
  * Once instantiated, returns a map of adapters to be used by the LaunchPage Service
  *
- * @version 1.120.7
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/ushell/Config",
@@ -18,10 +18,12 @@ sap.ui.define([
     "use strict";
 
     /**
-     * @name sap.ushell.services.ContentExtensionAdapterFactory
+     * @alias sap.ushell.services.ContentExtensionAdapterFactory
+     * @namespace
+     *
      * @since 1.62.0
-     * @deprecated
      * @protected
+     * @deprecated
      */
     var ContentExtensionFactory = {};
 
@@ -49,7 +51,7 @@ sap.ui.define([
      * @param {string} vConfigs[].adapter The path to the adapter
      * @param {string} vConfigs[].config The path to the configuration flag for this adapter
      * @param {object} vConfigs[].system A system object for creating the system when instantiating the adapter
-     * @param {function} vConfigs[].configHandler Afunction that returns any needed configuration for the adapter
+     * @param {function} vConfigs[].configHandler A function that returns any needed configuration for the adapter
      * @returns {Promise<object>} A promise that resolves to a map of content provider names to adapter instances
      *                            Note that the map might contain undefined entries if the adapters are disabled.
      *
@@ -104,7 +106,7 @@ sap.ui.define([
 
     /**
      * Asynchronously loads the module associated to the adapter given in the configuration object and instantiates
-     * an andapter from the module.
+     * an adapter from the module.
      *
      * @param {object} oConfig An adapter configuration object
      * @returns {Promise<object>} A Promise that resolves to the adapter instance