@sapui5/sap.ushell 1.112.1 → 1.113.0

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview
@@ -6,7 +6,7 @@
  * This is *not* an application facing service, but for Shell Internal usage.
  * This service should be accessed by the application via the CrossApplicationNavigation service.
  *
- * @version 1.112.1
+ * @version 1.113.0
  */
 sap.ui.define([
     "sap/ui/base/Object",
@@ -73,14 +73,14 @@ sap.ui.define([
      * @param {object} oContainerInterface The interface.
      * @param {string} sParameter Service instantiation.
      * @param {object} oConfig service configuration. A configuration object which may contain service configuration
-     *   <code>
+     * <pre>
      *   { config : { transient : false } }
-     *   </code>
+     * </pre>
      *   The 'transient' property controls whether app state data is only kept in the browser memory (default) or stored in the database.
      *   Note that persistency might not be supported by the respective FLP platform implementation.
      *   <br>
      *   Additionally initial app state data might be passed at runtime in the configuration object in the format:
-     *     <code>
+     * <pre>
      *     {
      *       config : {
      *         initialAppState : {
@@ -89,17 +89,17 @@ sap.ui.define([
      *           ...
      *         }
      *     }
-     *     </code>
+     * </pre>
      *   Alternatively, it may contain an thenable (ES6 Promise) as member
      *   <code>{ config : { initialAppStatesPromise : <promise> } }</code>
      *   which, when resolved will return a initial AppState map
-     *   <code>
+     * <pre>
      *   {
      *     <Key> : JSON.stringify(<content>),
      *     <Key2> : JSON.stringify(<content>),
      *     ...
      *   }
-     *   </code>
+     * </pre>
      *   as first argument.
      * @private
      * @constructor
@@ -142,9 +142,9 @@ sap.ui.define([
      * @since 1.28.0
      */
     AppState.prototype.getAppState = function (sKey) {
-        var oDeferred = new jQuery.Deferred(),
-            that = this,
-            oAppState;
+        var oDeferred = new jQuery.Deferred();
+        var that = this;
+        var oAppState;
         this._loadAppState(sKey).done(function (sKey, sData, iPersistencyMethod, oPersistencySettings) {
             oAppState = new AppStateAppState(that, sKey, false, sData, undefined, undefined, undefined, iPersistencyMethod, oPersistencySettings);
             oDeferred.resolve(oAppState);
@@ -202,8 +202,6 @@ sap.ui.define([
      * @since 1.28.0
      * @private
      */
-
-    // eslint-disable-next-line complexity
     AppState.prototype.createEmptyAppState = function (oComponent, bTransientEnforced, sPersistencyMethod, oPersistencySettings) {
         var oAppState;
         var sAppName = "";
@@ -256,13 +254,11 @@ sap.ui.define([
      * @since 1.28.0
      */
     AppState.prototype.createEmptyUnmodifiableAppState = function (/*oComponent*/) {
-        var sKey = this._getGeneratedKey(),
-            oAppState;
-        oAppState = new AppStateAppState(this, sKey, false);
+        var sKey = this._getGeneratedKey();
+        var oAppState = new AppStateAppState(this, sKey, false);
         return oAppState;
     };
 
-
     /**
      * Method to save an application state
      *
@@ -282,10 +278,10 @@ sap.ui.define([
      * @since 1.28.0
      */
     AppState.prototype._saveAppState = function (sKey, sData, sAppName, sComponent, bTransient, iPersistencyMethod, oPersistencySettings) {
-        var sSessionKey = this._getSessionKey(),
-            bUseTransientAppState = utils.isDefined(bTransient)
-                ? bTransient
-                : getConfiguredTransientOption(this._oConfig);
+        var sSessionKey = this._getSessionKey();
+        var bUseTransientAppState = utils.isDefined(bTransient)
+            ? bTransient
+            : getConfiguredTransientOption(this._oConfig);
 
         if (bUseTransientAppState) {
             iPersistencyMethod = undefined;
@@ -356,7 +352,7 @@ sap.ui.define([
     };
 
     /**
-     * Method to check if the platform supports a specific persistancy method
+     * Method to check if the platform supports a specific persistency method
      *
      * @param {string} sPersistencyMethod the persistency method
      * @returns {boolean} true if the method supported or through if not
@@ -384,34 +380,34 @@ sap.ui.define([
      * @protected
      */
     AppState.prototype.setAppStateToPublic = function (url) {
-        var sXStateKey = getURLParamValue(url, "sap-xapp-state"),
-            sIStateKey = getURLParamValue(url, "sap-iapp-state"),
-            oXStateDeferred = new jQuery.Deferred().resolve(),
-            oIStateDeferred = new jQuery.Deferred().resolve(),
-            oDeferred = new jQuery.Deferred(),
-            sXStateKeyNew,
-            sIStateKeyNew;
+        var sXStateKey = getURLParamValue(url, "sap-xapp-state");
+        var sIStateKey = getURLParamValue(url, "sap-iapp-state");
+        var oXStateDeferred = new jQuery.Deferred().resolve();
+        var oIStateDeferred = new jQuery.Deferred().resolve();
+        var oDeferred = new jQuery.Deferred();
+        var sXStateKeyNew;
+        var sIStateKeyNew;
 
         if (sXStateKey !== undefined) {
             oXStateDeferred = this.makeStatePersistent(sXStateKey, AppStatePersistencyMethod.PublicState)
-            .done(function (sNewKey) {
-                if (sXStateKey !== sNewKey) {
-                    url = url.replace(sXStateKey, sNewKey);
-                    sXStateKeyNew = sNewKey;
-                }
-            })
-            .fail(oDeferred.reject);
+                .done(function (sNewKey) {
+                    if (sXStateKey !== sNewKey) {
+                        url = url.replace(sXStateKey, sNewKey);
+                        sXStateKeyNew = sNewKey;
+                    }
+                })
+                .fail(oDeferred.reject);
         }
 
         if (sIStateKey !== undefined) {
             oIStateDeferred = this.makeStatePersistent(sIStateKey, AppStatePersistencyMethod.PublicState)
-            .done(function (sNewKey) {
-                if (sIStateKey !== sNewKey) {
-                    url = url.replace(sIStateKey, sNewKey);
-                    sIStateKeyNew = sNewKey;
-                }
-            })
-            .fail(oDeferred.reject);
+                .done(function (sNewKey) {
+                    if (sIStateKey !== sNewKey) {
+                        url = url.replace(sIStateKey, sNewKey);
+                        sIStateKeyNew = sNewKey;
+                    }
+                })
+                .fail(oDeferred.reject);
         }
 
         jQuery.when(oXStateDeferred, oIStateDeferred).done(function () {
@@ -428,9 +424,9 @@ sap.ui.define([
      * @returns {string} The requested param data
      */
     function getURLParamValue (sUrl, sParamName) {
-        var sReg = new RegExp("(?:" + sParamName + "=)([^&/]+)"),
-            sRes = sReg.exec(sUrl),
-            sValue;
+        var sReg = new RegExp("(?:" + sParamName + "=)([^&/]+)");
+        var sRes = sReg.exec(sUrl);
+        var sValue;
 
         if (sRes && sRes.length === 2) {
             sValue = sRes[1];

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/ushell/library",
     "sap/ushell/utils/AppType"

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

@@ -1,10 +1,10 @@
-// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The Unified Shell's bookmark service, which allows you to create shortcuts on the
  * user's home page.
  *
- * @version 1.112.1
+ * @version 1.113.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",
@@ -122,6 +122,8 @@ sap.ui.define([
          *   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]
+         *   Additional settings for the data source.
          * @param {object} [oParameters.dataSource.settings.odataVersion]
          *   The OData version of parameter serviceURL. Valid values are "2.0" and "4.0".
          * @param {string} [oParameters.serviceRefreshInterval]

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
 /**
  * @file
@@ -29,7 +29,7 @@
  * In the future, the custom resolver mechanism should be probably moved towards modifying (or only adding to the list of Inbounds),
  * this way a single data source has to be altered to support consistently getLinks, isIntentSupported.
  *
- * @version 1.112.1
+ * @version 1.113.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -1645,7 +1645,7 @@ sap.ui.define([
      *
      * @param {object} oSystemContext The systemContext for which the user default parameter names should be returned.
      * @returns {jQuery.Deferred.promise} A promise that resolves to an object with the following structure
-     *   <code>
+     * <pre>
      *   {
      *     simple: {
      *       parameternamextractUserDefaultReferenceNamee1: {},
@@ -1656,7 +1656,7 @@ sap.ui.define([
      *       parametername4: {}
      *     }
      *   }
-     *   </code>
+     * </pre>
      *   The name of a user default parameter referenced in an inbound.
      *   NOTE: the parameter names do not include surrounding special syntax. Only the inner part is returned.
      *   For example: "UserDefault.ParameterName" is returned as "ParameterName"

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

@@ -1,13 +1,8 @@
-// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
+
 /**
- * @fileOverview
- *
- * <p>This module exposes a CommonDataModel based site document in a platform neutral format
- * to it's clients
- * </p>
- *
- *
- * @version 1.112.1
+ * @file Exposes a CommonDataModel based site document in a platform neutral format to it's clients
+ * @version 1.113.0
  */
 sap.ui.define([
     "sap/ushell/services/_CommonDataModel/PersonalizationProcessor",
@@ -48,18 +43,20 @@ sap.ui.define([
     Log,
     Manifest
 ) {
-
     "use strict";
 
+    // shortcut for sap.ushell.DisplayFormat
     var DisplayFormat = ushellLibrary.DisplayFormat;
+
+    // shortcut for sap.ushell.ContentNodeType
     var ContentNodeType = ushellLibrary.ContentNodeType;
 
-    var S_COMPONENT_NAME = "sap.ushell.services.CommonDataModel",
-        O_STANDARD_VIZ_TYPES = {
-            STATIC_LAUNCHER: "sap.ushell.StaticAppLauncher",
-            DYNAMIC_LAUNCHER: "sap.ushell.DynamicAppLauncher",
-            CARD: "sap.ushell.Card"
-        };
+    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"
+    };
 
     /**
      * @param {object} oAdapter
@@ -77,7 +74,6 @@ sap.ui.define([
      * @since 1.40.0
      */
     function CommonDataModel (oAdapter, oContainerInterface, sParameters, oServiceConfiguration) {
-
         this._oAdapter = oAdapter;
         this._oPersonalizationProcessor = new PersonalizationProcessor();
         this._oSiteDeferred = new jQuery.Deferred();
@@ -112,7 +108,7 @@ sap.ui.define([
                     if (oPers) {
                         this._oPersonalizationDeltas = deepClone(oPers);
                     } else {
-                        this._oPersonalizationDeltas = {version: "3.0.0", _version: "3.0.0"};
+                        this._oPersonalizationDeltas = { version: "3.0.0", _version: "3.0.0" };
                     }
                     this._triggerMixinPersonalisationInSite(oSite, oPers);
                 }.bind(this))
@@ -266,7 +262,6 @@ sap.ui.define([
      * @private
      */
     CommonDataModel.prototype.getGroups = function () {
-
         var oDeferred = new jQuery.Deferred();
 
         this.getSite().then(function (oSite) {
@@ -329,7 +324,7 @@ sap.ui.define([
      *
      * @since 1.89.0
      */
-     CommonDataModel.prototype.getSiteWithoutPersonalization = function () {
+    CommonDataModel.prototype.getSiteWithoutPersonalization = function () {
         return this._oGetSitePromise;
     };
 
@@ -416,7 +411,6 @@ sap.ui.define([
                     this._oOriginalSite.vizTypes = oVizTypes;
                     return deepClone(oPage, 20);
                 }.bind(this));
-
             }.bind(this));
     };
 
@@ -604,7 +598,6 @@ sap.ui.define([
         }
     };
 
-
     /**
      * Loads all pages which have personalization
      * @returns {Promise<object[]>} Resolves the personalized pages
@@ -746,7 +739,7 @@ sap.ui.define([
             oVizTypePromise = this._oAdapter.getVizType(sVizType);
         }
 
-        return Promise.all([ this._getSiteProperty("vizTypes"), oVizTypePromise ]).then(function (aResults) {
+        return Promise.all([this._getSiteProperty("vizTypes"), oVizTypePromise]).then(function (aResults) {
             var oSiteVizTypes = aResults[0];
             var oVizType = aResults[1];
 
@@ -758,7 +751,6 @@ sap.ui.define([
         });
     };
 
-
     /**
      * Returns all visualizations of the Common Data Model.
      * The method loads all of the available visualizations lazily from the backend
@@ -910,7 +902,6 @@ sap.ui.define([
             this._saveCdmVersion31(pageId)
                 .then(oDeferred.resolve)
                 .catch(oDeferred.reject);
-
         } else {
             this._saveCdmVersion30()
                 .then(oDeferred.resolve)
@@ -955,7 +946,6 @@ sap.ui.define([
                 }
                 return Promise.resolve();
             }.bind(this));
-
     };
 
     /**
@@ -1077,7 +1067,7 @@ sap.ui.define([
     };
 
     /**
-     * Registers extension catalogs. The functionality was removed. The funciton is void.
+     * Registers extension catalogs. The functionality was removed. The function is void.
      *
      * @deprecated
      * @private
@@ -1142,14 +1132,12 @@ sap.ui.define([
      *
      * @param {object} site The site
      * @returns {object} The site with potentially modified groups order
-     *
      * @private
      */
     CommonDataModel.prototype._ensureGroupsOrder = function (site) {
-        var aGroupsOrder = ObjectPath.get("site.payload.groupsOrder", site),
-            oGroups = site.groups,
-            sGroupId,
-            i = 0;
+        var aGroupsOrder = ObjectPath.get("site.payload.groupsOrder", site);
+        var oGroups = site.groups;
+        var i = 0;
 
         if (!aGroupsOrder) {
             return site;
@@ -1157,7 +1145,7 @@ sap.ui.define([
 
         // we could use Array.filter here but as there is nothing to do in the most cases we avoid copying the array
         while (i < aGroupsOrder.length) {
-            sGroupId = aGroupsOrder[i];
+            var sGroupId = aGroupsOrder[i];
             if (!oGroups[sGroupId]) {
                 aGroupsOrder.splice(i, 1);
             } else {
@@ -1168,7 +1156,6 @@ sap.ui.define([
         return site;
     };
 
-
     /**
      * Gets all plugins of every category in the site.
      *
@@ -1184,13 +1171,8 @@ sap.ui.define([
      * @since 1.48.0
      */
     CommonDataModel.prototype.getPlugins = (function () {
-        var fnDeepFreeze,
-            fnExtractPluginConfigFromInboundSignature,
-            oPluginSets;
-
-        fnExtractPluginConfigFromInboundSignature = function (sPluginName, oSignatureInbounds) {
-            var oSignatureParams,
-                iNumInbounds = Object.keys(oSignatureInbounds).length;
+        var fnExtractPluginConfigFromInboundSignature = function (sPluginName, oSignatureInbounds) {
+            var iNumInbounds = Object.keys(oSignatureInbounds).length;
 
             if (iNumInbounds === 0) {
                 return {};
@@ -1215,7 +1197,7 @@ sap.ui.define([
                 );
             }
 
-            oSignatureParams = ObjectPath.get("signature.parameters", oSignatureInbounds["Shell-plugin"]) || {};
+            var oSignatureParams = ObjectPath.get("signature.parameters", oSignatureInbounds["Shell-plugin"]) || {};
 
             return Object.keys(oSignatureParams).reduce(
                 function (oResult, sNextParam) {
@@ -1232,7 +1214,7 @@ sap.ui.define([
         };
 
         // Recursively freezes an object.
-        fnDeepFreeze = function (o) {
+        var fnDeepFreeze = function (o) {
             Object.keys(o)
                 .filter(function (sProperty) {
                     return typeof o[sProperty] === "object";
@@ -1244,8 +1226,8 @@ sap.ui.define([
             return Object.freeze(o);
         };
 
+        var oPluginSets;
         return function (oPluginSetsCache) {
-
             if (oPluginSetsCache !== undefined) {
                 oPluginSets = oPluginSetsCache;
             }
@@ -1260,14 +1242,11 @@ sap.ui.define([
                 var oApplications = oSite.applications || {};
 
                 Object.keys(oApplications).filter(function (sAppName) {
-
                     return ObjectPath.get("type", this[sAppName]["sap.flp"]) === "plugin";
-
                 }, oApplications).forEach(function (sPluginName) {
-                    var oPluginConfig,
-                        oConfigFromInboundSignature,
-                        oPlugin = this[sPluginName],
-                        oComponentProperties = {};
+                    var oConfigFromInboundSignature;
+                    var oPlugin = this[sPluginName];
+                    var oComponentProperties = {};
 
                     if (!isPlainObject(oPlugin["sap.platform.runtime"])) {
                         Log.error("Cannot find 'sap.platform.runtime' section for plugin '"
@@ -1301,7 +1280,7 @@ sap.ui.define([
                         oSignatureInbounds
                     );
 
-                    oPluginConfig = extend(
+                    var oPluginConfig = extend(
                         oComponentProperties.config || {},
                         oConfigFromInboundSignature // has precedence
                     );
@@ -1318,7 +1297,6 @@ sap.ui.define([
                     if (oDeviceTypes) {
                         oPluginSets[sPluginName].deviceTypes = oDeviceTypes;
                     }
-
                 }, oApplications);
 
                 return fnDeepFreeze(oPluginSets);
@@ -1358,7 +1336,6 @@ sap.ui.define([
     };
 
     CommonDataModel.prototype._ensureProperDisplayFormats = function (oSite) {
-
         if (oSite.vizTypes) {
             Object.keys(oSite.vizTypes).forEach(function (sKey) {
                 if (oSite.vizTypes[sKey]["sap.flp"] && oSite.vizTypes[sKey]["sap.flp"].vizOptions) {
@@ -1515,7 +1492,7 @@ sap.ui.define([
                 var oContentProviderIds = {};
 
                 objectValues(oSite.applications).forEach(function (oApplication) {
-                   var sContentProviderId = readApplications.getContentProviderId(oApplication);
+                    var sContentProviderId = readApplications.getContentProviderId(oApplication);
 
                     if (includes(aSystemAliases, sContentProviderId)) {
                         oContentProviderIds[sContentProviderId] = true;
@@ -1529,5 +1506,4 @@ sap.ui.define([
 
     CommonDataModel.hasNoAdapter = false;
     return CommonDataModel;
-
 }, true /* bExport */);

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

@@ -1,10 +1,10 @@
-// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
 /**
  * @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.112.1
+ * @version 1.113.0
  */
 sap.ui.define([
     "sap/ushell/Config",

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

@@ -1,9 +1,9 @@
-// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The Unified Shell's Configuration Defaults service exposes default configurations set in the code base.
  *
- * @version 1.112.1
+ * @version 1.113.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -30,18 +30,22 @@ sap.ui.define([
 
         /**
          * @param {string[]} aConfigurationPaths Array of configuration paths to get the defaults for, like
-         * <code>[
-         *  "renderers/fiori2/componentData/config/enableRecentActivity",
-         *  "a/b/c"
-         * ]</code>
+         * <pre>
+         * [
+         *     "renderers/fiori2/componentData/config/enableRecentActivity",
+         *     "a/b/c"
+         * ]
+         * </pre>
          *
          * @returns {Promise} A promise which returning an object when resolved. That object contains the defaults under the path string:
-         * <code>{
-         *  "renderers/fiori2/componentData/config/enableRecentActivity": {
-         *      defaultValue: true
-         *  },
-         *  "a/b/c": undefined
-         * }</code>
+         * <pre>
+         * {
+         *     "renderers/fiori2/componentData/config/enableRecentActivity": {
+         *         defaultValue: true
+         *     },
+         *     "a/b/c": undefined
+         * }
+         * </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

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
 sap.ui.define([
     "sap/ushell/Container",

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

@@ -1,10 +1,10 @@
-// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 /**
  * @fileOverview Creates an adapter factory for data not handled by the
  * default adapter.
  * Once instantiated, returns a map of adapters to be used by the LaunchPage Service
  *
- * @version 1.112.1
+ * @version 1.113.0
  */
 sap.ui.define([
     "sap/ushell/Config",