@sapui5/sap.ushell 1.111.0 → 1.112.0

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

@@ -7,7 +7,7 @@
  * </p>
  *
  *
- * @version 1.111.0
+ * @version 1.112.0
  */
 sap.ui.define([
     "sap/ushell/services/_CommonDataModel/PersonalizationProcessor",
@@ -1077,251 +1077,13 @@ sap.ui.define([
     };
 
     /**
-     * Finds invalid applications in a site.
-     *
-     * @param {object} oExtensionSite
-     *   The extension site to be checked
-     *
-     * @returns {object}
-     *   An object indicating which apps from which catalogs are invalid:
-     *   {
-     *      CatalogId1: {   // only lists invalid apps
-     *          AppId1: true,
-     *          AppId2: true,
-     *          ...
-     *          AppIdN: true
-     *      },
-     *      ...
-     *   }
-     *   </pre>
-     *   This method guarantees non-empty objects. Therefore it can be assumed
-     *   that if the result is an empty object, there are no errors
+     * Registers extension catalogs. The functionality was removed. The funciton is void.
      *
+     * @deprecated
      * @private
      */
-    CommonDataModel.prototype._getUnreferencedCatalogApplications = function (oExtensionSite) {
-        var oUnreferencedApplicationPerCatalogIndex = {};
-
-        // the id property counts in the end...
-        var oAllApplicationIdsIndex = Object.keys(oExtensionSite.applications)
-            .map(function (sAppId) {
-                return oExtensionSite.applications[sAppId]["sap.app"].id;
-            })
-            .reduce(function (oIndex, sAppId) {
-                oIndex[sAppId] = true;
-                return oIndex;
-            }, {});
-
-        var oCatalogs = oExtensionSite.catalogs;
-
-        Object.keys(oCatalogs).forEach(function (sCatalog) {
-            var aAppDescriptors = oCatalogs[sCatalog].payload.appDescriptors;
-
-            aAppDescriptors.map(function (oAppDescriptor) {
-                return oAppDescriptor.id;
-            }).filter(function (sAppIdFromAppDescriptors) {
-                // only invalid: avoids empty catalogs
-                return !oAllApplicationIdsIndex[sAppIdFromAppDescriptors];
-            }).forEach(function (sBadAppIdFromAppDescriptors) {
-                if (!oUnreferencedApplicationPerCatalogIndex.hasOwnProperty(sCatalog)) {
-                    oUnreferencedApplicationPerCatalogIndex[sCatalog] = {};
-                }
-
-                // mark as invalid
-                oUnreferencedApplicationPerCatalogIndex[sCatalog][sBadAppIdFromAppDescriptors]
-                    = true;
-            });
-        });
-
-        return oUnreferencedApplicationPerCatalogIndex;
-    };
-
-    /**
-     * Formats an invalid application index into a human readable string.
-     *
-     * @param {string} sContentProviderId
-     *   The id of the provider that returned the site.
-     *
-     * @param {object} oUnreferencedApplicationPerCatalogIndex
-     *   An index of all the invalid applications per catalog as returned by
-     *   <code>#_getUnreferencedCatalogApplications</code>.
-     *
-     * @returns {string}
-     *   A nice error message
-     *
-     * @private
-     */
-    CommonDataModel.prototype._formatUnreferencedApplications = function (sContentProviderId, oUnreferencedApplicationPerCatalogIndex) {
-        return "One or more apps from " + sContentProviderId
-            + " content provider are not listed among the applications section " +
-            "of the extended site and will be discarded - "
-            + Object.keys(oUnreferencedApplicationPerCatalogIndex)
-                .map(function (sCatalogId) {
-
-                    var aBadCatalogAppsQuoted = Object.keys(oUnreferencedApplicationPerCatalogIndex[sCatalogId])
-                        .map(function (sUnquoted) {
-                            return "'" + sUnquoted + "'";
-                        });
-
-                    return "From catalog '" + sCatalogId + "': "
-                        + aBadCatalogAppsQuoted.join(", ");
-
-                }).join("; ");
-    };
-    /**
-     * Removes invalid appDescriptors from an extended site according to the
-     * index. This method operates in place on the site.
-     *
-     * @param {object} oExtensionSite
-     *   The extended site
-     *
-     * @param {object} oUnreferencedApplicationPerCatalogIndex
-     *   An index of all the invalid applications per catalog as returned by
-     *   <code>#_getUnreferencedCatalogApplications</code>.
-     */
-    CommonDataModel.prototype._removeUnreferencedApplications = function (oExtensionSite, oUnreferencedApplicationPerCatalogIndex) {
-        Object.keys(oExtensionSite.catalogs).forEach(function (sCatalogId) {
-            var oCatalogPayload = oExtensionSite.catalogs[sCatalogId].payload;
-            var aAppDescriptors = oCatalogPayload.appDescriptors;
-
-            oCatalogPayload.appDescriptors = aAppDescriptors.filter(function (oAppDescriptor) {
-                return oUnreferencedApplicationPerCatalogIndex[sCatalogId]
-                    && !oUnreferencedApplicationPerCatalogIndex[sCatalogId][oAppDescriptor.id];
-            });
-        });
-    };
-
-    /**
-     * Loads extension sites from ContentProvider plugins.
-     *
-     * @returns {jQuery.promise}
-     *   A promise that resolves when all the ContentProviders have returned a
-     *   site or failed to do so. This promise is always resolved (and never
-     *   rejected) with an array of "report" objects also indicating if the
-     *   operation of retrieving the site was successful. For example, when the
-     *   site is correctly retrieved, an item of this array is an object like:
-     *   <pre>
-     *   {
-     *      providerId: "SomeProviderId",
-     *      success: true,
-     *      site: { ... }  // the extension site
-     *   }
-     *   </pre>
-     *   Likewise, when the operation fails, the object looks more like:
-     *   <pre>
-     *   {
-     *      providerId: "SomeProviderId",
-     *      success: false,
-     *      error: "..."
-     *   }
-     *   </pre>
-     *   The promise .progress handler is called only when a site is
-     *   successfully loaded, therefore the consumer must check the result of
-     *   the done handler to inspect or report failures.
-     *
-     * @private
-     */
-    CommonDataModel.prototype.getExtensionSites = function () {
-        var oDeferred = new jQuery.Deferred();
-
-        sap.ushell.Container.getServiceAsync("PluginManager")
-            .then(function (PluginManagerService) {
-                PluginManagerService.loadPlugins("ContentProvider")
-                    .done(function () {
-                        var aContentProviderIds = Object.keys(this._oContentProviderIndex),
-                            iTotalContentProviders = aContentProviderIds.length;
-
-                        if (iTotalContentProviders === 0) {
-                            oDeferred.resolve([]);
-                            return;
-                        }
-
-                        // assumption: all ContentProvider register themselves on init
-                        var aGetSitePromises = aContentProviderIds.map(function (sContentProviderId) {
-                            var oContentProvider = this._oContentProviderIndex[sContentProviderId];
-
-                            var oGetSitePromise;
-                            try {
-                                oGetSitePromise = oContentProvider.getSite();
-
-                                if (!oGetSitePromise || typeof oGetSitePromise.then !== "function") {
-                                    oGetSitePromise = Promise.reject("Call to getSite failed: getSite did not return a Promise");
-                                }
-                            } catch (oError) {
-                                oGetSitePromise = Promise.reject("Call to getSite failed: " + oError);
-                            }
-
-                            return oGetSitePromise
-                                .then(function (/* bound */ sContentProviderId, oExtensionSite) {
-                                    var oExtensionSiteClone = deepExtend({}, oExtensionSite);
-
-                                    var oUnreferencedApplicationPerCatalogIndex = this._getUnreferencedCatalogApplications(oExtensionSite);
-
-                                    if (Object.keys(oUnreferencedApplicationPerCatalogIndex).length > 0) {
-                                        var sErrorMessage = this._formatUnreferencedApplications(sContentProviderId, oUnreferencedApplicationPerCatalogIndex);
-
-                                        Log.error(sErrorMessage, null, S_COMPONENT_NAME);
-
-                                        this._removeUnreferencedApplications(oExtensionSiteClone, oUnreferencedApplicationPerCatalogIndex);
-                                    }
-
-                                    var oLoadResult = {
-                                        providerId: sContentProviderId,
-                                        success: true,
-                                        site: oExtensionSiteClone
-                                    };
-
-                                    oDeferred.notify(oLoadResult);
-
-                                    return oLoadResult;
-                                }.bind(this, sContentProviderId))
-                                .catch(function (/* bound */ sContentProviderId, sErrorMessage) {
-                                    return {
-                                        providerId: sContentProviderId,
-                                        success: false,
-                                        error: sErrorMessage
-                                    };
-                                }.bind(null, sContentProviderId));
-                        }.bind(this));
-
-                        Promise.all(aGetSitePromises).then(oDeferred.resolve);
-                    }.bind(this));
-                // .fail({
-                //   On failure just leave promise in pending state. This should be fine
-                //   with the caller.
-                // });
-            }.bind(this)); // See comment above: no .catch here either.
-
-        return oDeferred.promise();
-
-    };
-
-    /**
-     * Registers extension catalogs (i.e., 3rd Party catalogs).
-     *
-     * @param {string} sId
-     *   The unique id of the content provider.
-     * @param {object} oSiteContentProvider
-     *   The site content provider implementation.
-     * @private
-     */
-    CommonDataModel.prototype.registerContentProvider = function (sId, oSiteContentProvider) {
-        if (this._oContentProviderIndex[sId]) {
-            Log.error(
-                "a content provider with ID '" + sId + "' is already registered",
-                null,
-                S_COMPONENT_NAME
-            );
-            return;
-        }
-
-        this._oContentProviderIndex[sId] = oSiteContentProvider;
-
-        Log.debug(
-            "ContentProvider '" + sId + "' was registered",
-            null,
-            S_COMPONENT_NAME
-        );
+    CommonDataModel.prototype.registerContentProvider = function () {
+        Log.error("CommonDataModel.registerContentProvider is obsolete and should not be used.");
     };
 
     /**

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

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

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

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

@@ -5,7 +5,7 @@
  * This file exposes an API to perform (invoke) Cross Application Navigation for applications.
  * It exposes interfaces to perform a hash change and/or trigger an external navigation.
  *
- * @version 1.111.0
+ * @version 1.112.0
  */
 sap.ui.define([
     "sap/ushell/services/AppConfiguration",

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

@@ -5,7 +5,7 @@
  *
  * The service provide dark mode support functionality
  *
- * @version 1.111.0
+ * @version 1.112.0
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -2,7 +2,7 @@
 
 /**
  * @file The Unified Shell's page builder service providing the data for the Fiori launchpad's classic Homepage.
- * @version 1.111.0
+ * @version 1.112.0
  */
 sap.ui.define([
     "sap/base/Log",

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

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module exposes API enpoints for Generic Communication
- * @version 1.111.0
+ * @version 1.112.0
  */
 sap.ui.define([
     "sap/ushell/services/_MessageBroker/MessageBrokerEngine"
@@ -27,11 +27,35 @@ sap.ui.define([
     var MessageBroker = function () {};
 
     /**
-     * This is an api for Shell Container UI5 clients.
+     *
+     * @param {string} sClientId client id.
+     * @returns {Promise} Promise result.
+     *
+     * @since 1.110.0
+     * @private
+     */
+
+    MessageBroker.prototype.connect = function (sClientId) {
+        return MessageBrokerEngine.connect(sClientId);
+    };
+
+    /**
+     *
+     * @param {string} sClientId client ID.
+     * @returns {Promise} Promise result.
+     *
+     * @since 1.110.0
+     * @private
+     */
+
+    MessageBroker.prototype.disconnect = function (sClientId) {
+        return MessageBrokerEngine.disconnect(sClientId);
+    };
+
+    /**
      *
      * @param {string} sClientId client id.
      * @param {array} aSubscribedChannels array of channel-objects.
-     * @param {object} data additional data.
      * @param {function} fnMessageCallback callback function returns promise.
      * @param {function} fnClientConnectionCallback callback function returns promise.
      * @returns {Promise} Promise result.
@@ -43,35 +67,32 @@ sap.ui.define([
     MessageBroker.prototype.subscribe = function (
         sClientId,
         aSubscribedChannels,
-        data,
         fnMessageCallback,
         fnClientConnectionCallback
     ) {
         return MessageBrokerEngine.subscribe(
             sClientId,
             aSubscribedChannels,
-            data,
             fnMessageCallback,
             fnClientConnectionCallback
         );
     };
 
     /**
-     * This is an api for Shell Container UI5 clients.
      *
      * @param {string} sClientId client ID.
+     * @param {array} aUnsubscribedChannels channels to unsubscribe from.
      * @returns {Promise} Promise result.
      *
      * @since 1.110.0
      * @private
      */
 
-    MessageBroker.prototype.unsubscribe = function (sClientId) {
-        return MessageBrokerEngine.unsubscribe(sClientId);
+    MessageBroker.prototype.unsubscribe = function (sClientId, aUnsubscribedChannels) {
+        return MessageBrokerEngine.unsubscribe(sClientId, aUnsubscribedChannels);
     };
 
     /**
-     * This is an api for Shell Container UI5 clients.
      *
      * @param {string} sChannelId channel Id.
      * @param {string} sClientId client Id.
@@ -103,7 +124,6 @@ sap.ui.define([
     };
 
     /**
-     * This is an api for Shell Container UI5 clients.
      *
      * @param {string} sOrigin iframe src.
      *
@@ -116,7 +136,6 @@ sap.ui.define([
     };
 
     /**
-     * This is an api for Shell Container UI5 clients.
      *
      * @param {string} sOrigin iframe src.
      *
@@ -129,7 +148,7 @@ sap.ui.define([
     };
 
     /**
-     * This is an api for Shell Container UI5 clients.
+     *
      * @returns {Promise} Promise result.
      * @since 1.110.0
      * @private

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

@@ -1005,8 +1005,10 @@ sap.ui.define([
          * @private
          */
         this._recordNavigation = function (sFunctionName, oParameters, vResult) {
-            if (oServiceConfig && oServiceConfig.usageRecorder && oServiceConfig.usageRecorder.enabled) {
-                oHttpClient.post("/navigation/api/v2/record", {
+            var oUsageRecorderConfig = oServiceConfig && oServiceConfig.usageRecorder || {};
+            if (oUsageRecorderConfig.enabled) {
+                var sUsageRecorderEndpoint = oUsageRecorderConfig.serviceUrl || "/navigation/api/v2/record";
+                oHttpClient.post(sUsageRecorderEndpoint, {
                     data: {
                         function: sFunctionName,
                         parameters: JSON.stringify(oParameters),

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

@@ -4,7 +4,7 @@
  *
  * <p>This module prepares the navigation data needed by the page dereferencer.</p>
  *
- * @version 1.111.0
+ * @version 1.112.0
  */
 
 sap.ui.define([

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

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

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

@@ -4,7 +4,7 @@
  *
  * <p>This module deals with the page persistence.</p>
  *
- * @version 1.111.0
+ * @version 1.112.0
  */
 
 sap.ui.define([], function () {

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.111.0
+ * @version 1.112.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.111.0
+ * @version 1.112.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -15,7 +15,8 @@ sap.ui.define([
     "sap/ushell/Config",
     "sap/ushell/adapters/cdm/v3/utilsCdm",
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readUtils",
-    "sap/ushell/adapters/cdm/v3/_LaunchPage/readVisualizations"
+    "sap/ushell/adapters/cdm/v3/_LaunchPage/readVisualizations",
+    "sap/base/util/ObjectPath"
 ], function (
     Log,
     RestrictedJSONModel,
@@ -27,7 +28,8 @@ sap.ui.define([
     Config,
     utilsCdm,
     readUtils,
-    readVisualizations
+    readVisualizations,
+    ObjectPath
 ) {
     "use strict";
 
@@ -1321,6 +1323,13 @@ sap.ui.define([
      *   The optional subtitle of the bookmark.
      * @param {string} [bookmark.serviceUrl]
      *   The URL to a REST or OData service that provides some dynamic information for the bookmark.
+     * @param {object} [oParameters.dataSource]
+     *   Metadata for parameter serivceUrl. Mandatory to specify if parameter serviceURL contains semantic date ranges.
+     *   This does not influence the data source of the app itself.
+     * @param {string} [oParameters.dataSource.type]
+     *   The type of the serviceURL's service. Only "OData" is supported.
+     * @param {object} [oParameters.dataSource.settings.odataVersion]
+     *   The OData version of parameter serviceURL. Valid values are "2.0" and "4.0".
      * @param {string} [bookmark.serviceRefreshInterval]
      *   The refresh interval for the <code>serviceUrl</code> in seconds.
      * @param {string} [bookmark.numberUnit]
@@ -1403,6 +1412,15 @@ sap.ui.define([
                     isBookmark: true
                 };
 
+                if (bookmark.dataSource) {
+                    oVizRef.dataSource = {
+                        type: bookmark.dataSource.type,
+                        settings: {
+                            odataVersion: ObjectPath.get(["dataSource", "settings", "odataVersion"], bookmark)
+                        }
+                    };
+                }
+
                 if (sContentProviderId) {
                     oVizRef.contentProviderId = sContentProviderId;
                 }

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.111.0
+ * @version 1.112.0
  */
 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, which allows you to handle the loading of Fiori Launchpad plugins.
- * @version 1.111.0
+ * @version 1.112.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -27,10 +27,8 @@ sap.ui.define([
     var S_FLP_AREAS_PLUGIN_COMPONENT = "sap.ushell.components.shell.defaults"; // contains Me Area and Notifications Area
     var aSupportedPluginCategories = [
         S_DEFAULT_PLUGIN_CATEGORY,
-        "EarlyLoading",
         "UserDefaults",
         "UserImage",
-        "ContentProvider",
         "AppWarmup"
     ];