@sapui5/sap.ushell 1.131.1 → 1.132.1

package/src/main/js/sap/ushell/User.js

@@ -66,12 +66,12 @@ sap.ui.define([
     // "public class" -----------------------------------------------------------
 
     /**
-     * Constructs a new representation (wrapper) of the user object as loaded by the startup service.
+     * Constructs a new representation (wrapper) of the user object as loaded by the ContainerAdapter.
      * @class
-     * @param {object} oContainerAdapterConfig the result of the startup service call
+     * @param {object} oSettings the result provided by the ContainerAdapter
      * @since 1.15.0
      */
-    var User = function (oContainerAdapterConfig) {
+    var User = function (oSettings) {
         // actually the parameter contains the container adapter config
         var aChangedProperties = [];
         var oBootTheme;
@@ -79,8 +79,34 @@ sap.ui.define([
         var oCurrentTheme;
         var oStartupTheme;
         var oEventProvider = new EventProvider();
+
+        // todo: ABAP specific code should be moved to ushell_abap
+        // User profile and edit states are only available on ABAP platform
+        const oEditStates = {};
+        oSettings.userProfile?.forEach((entry) => {
+            if (entry.id && entry.editState) {
+                oEditStates[entry.id] = entry.editState;
+            }
+        });
         // constructor code below
 
+        /**
+         * Get the edit state of a user profile entry on ABAP platform.
+         *
+         * @param {string} sParameterId ID of the parameter like "CALENDAR_WEEK_NUMBERING" in ABAP notation
+         * @returns {int} edit state of an entry. The possible values are:
+         *   0: hidden
+         *   1: readonly
+         *   3: optional (editable)
+         *   7: mandatory
+         *   undefined: the entry is not available or user profile is not provided
+         * @since 1.131.0
+         * @private
+         */
+        this.getEditState = function (sParameterId) {
+            return oEditStates[sParameterId];
+        };
+
         /**
          * Returns this user's email address.
          *
@@ -88,7 +114,7 @@ sap.ui.define([
          * @since 1.15.0
          */
         this.getEmail = function () {
-            return oContainerAdapterConfig.email;
+            return oSettings.email;
         };
 
         /**
@@ -98,7 +124,7 @@ sap.ui.define([
          * @since 1.15.0
          */
         this.getFirstName = function () {
-            return oContainerAdapterConfig.firstName;
+            return oSettings.firstName;
         };
 
         /**
@@ -108,7 +134,7 @@ sap.ui.define([
          * @since 1.15.0
          */
         this.getFullName = function () {
-            return oContainerAdapterConfig.fullName;
+            return oSettings.fullName;
         };
 
         /**
@@ -118,7 +144,7 @@ sap.ui.define([
          * @since 1.85
          */
         this.getTimeZone = function () {
-            return oContainerAdapterConfig.timeZone;
+            return oSettings.timeZone;
         };
 
         /**
@@ -128,7 +154,7 @@ sap.ui.define([
          * @since 1.84.0
          */
         this.getInitials = function () {
-            var sFullName = oContainerAdapterConfig.fullName || "";
+            var sFullName = oSettings.fullName || "";
             var sInitials = "";
             var bNext = true;
 
@@ -151,7 +177,7 @@ sap.ui.define([
          * @since 1.15.0
          */
         this.getId = function () {
-            return oContainerAdapterConfig.id;
+            return oSettings.id;
         };
 
         /**
@@ -161,7 +187,7 @@ sap.ui.define([
          * @since 1.15.0
          */
         this.getLanguage = function () {
-            return oContainerAdapterConfig.language;
+            return oSettings.language;
         };
 
         /**
@@ -171,7 +197,7 @@ sap.ui.define([
          * @since 1.15.0
          */
         this.getLanguageBcp47 = function () {
-            return oContainerAdapterConfig.languageBcp47;
+            return oSettings.languageBcp47;
         };
 
         /**
@@ -194,7 +220,7 @@ sap.ui.define([
          * @since 1.15.0
          */
         this.getLastName = function () {
-            return oContainerAdapterConfig.lastName;
+            return oSettings.lastName;
         };
 
         /**
@@ -204,7 +230,7 @@ sap.ui.define([
          * @since 1.21.1
          */
         this.getImage = function () {
-            return oContainerAdapterConfig.image;
+            return oSettings.image;
         };
 
         /**
@@ -214,7 +240,7 @@ sap.ui.define([
          * @since 1.118.0
          */
         this.getCalendarWeekNumbering = function () {
-            return oContainerAdapterConfig.calendarWeekNumbering || "Default";
+            return oSettings.calendarWeekNumbering || "Default";
         };
 
         /**
@@ -224,7 +250,7 @@ sap.ui.define([
          * @since 1.35.0
          */
         this.setImage = function (sUserImageURI) {
-            oContainerAdapterConfig.image = sUserImageURI;
+            oSettings.image = sUserImageURI;
             oEventProvider.fireEvent("onSetImage", sUserImageURI);
         };
 
@@ -248,7 +274,7 @@ sap.ui.define([
          * @since 1.15.0
          */
         this.isJamActive = function () {
-            return oContainerAdapterConfig.isJamActive === true;
+            return oSettings.isJamActive === true;
         };
 
         /**
@@ -259,7 +285,7 @@ sap.ui.define([
          * @since 1.48.0
          */
         this.isLanguagePersonalized = function () {
-            return oContainerAdapterConfig.isLanguagePersonalized === true;
+            return oSettings.isLanguagePersonalized === true;
         };
 
         /**
@@ -304,10 +330,10 @@ sap.ui.define([
          * @since 1.50.0
          */
         this.getThemeRoot = function (sTheme) {
-            if (oContainerAdapterConfig.ranges && oContainerAdapterConfig.ranges.theme &&
-                oContainerAdapterConfig.ranges.theme[sTheme] &&
-                oContainerAdapterConfig.ranges.theme[sTheme].themeRoot) {
-                return oContainerAdapterConfig.ranges.theme[sTheme].themeRoot;
+            if (oSettings.ranges && oSettings.ranges.theme &&
+                oSettings.ranges.theme[sTheme] &&
+                oSettings.ranges.theme[sTheme].themeRoot) {
+                return oSettings.ranges.theme[sTheme].themeRoot;
             }
             return "";
         };
@@ -407,8 +433,8 @@ sap.ui.define([
                 this.setChangedProperties({
                     propertyName: "language",
                     name: "LANGUAGE"
-                }, oContainerAdapterConfig.language, sNewLanguage);
-                oContainerAdapterConfig.language = sNewLanguage;
+                }, oSettings.language, sNewLanguage);
+                oSettings.language = sNewLanguage;
             }
         };
 
@@ -419,7 +445,7 @@ sap.ui.define([
          * @since 1.15.0
          */
         this.getAccessibilityMode = function () {
-            return oContainerAdapterConfig.accessibility;
+            return oSettings.accessibility;
         };
 
         /**
@@ -435,7 +461,7 @@ sap.ui.define([
                 throw new Error(sErrorMsg);
             }
 
-            oContainerAdapterConfig.accessibility = bAccessibility;
+            oSettings.accessibility = bAccessibility;
         };
 
         /**
@@ -447,7 +473,7 @@ sap.ui.define([
          * @since 1.107.0
          */
         this.isAdminUser = function () {
-            return oContainerAdapterConfig.isAdminUser === true;
+            return oSettings.isAdminUser === true;
         };
 
         /**
@@ -457,7 +483,7 @@ sap.ui.define([
          * @since 1.15.0
          */
         this.isSetAccessibilityPermitted = function () {
-            return oContainerAdapterConfig.setAccessibilityPermitted;
+            return oSettings.setAccessibilityPermitted;
         };
 
         /**
@@ -467,7 +493,7 @@ sap.ui.define([
          * @since 1.15.0
          */
         this.isSetThemePermitted = function () {
-            return oContainerAdapterConfig.setThemePermitted;
+            return oSettings.setThemePermitted;
         };
 
         /**
@@ -478,7 +504,7 @@ sap.ui.define([
          * @since 1.30.0
          */
         this.getContentDensity = function () {
-            return oContainerAdapterConfig.contentDensity;
+            return oSettings.contentDensity;
         };
 
         /**
@@ -498,9 +524,9 @@ sap.ui.define([
             this.setChangedProperties({
                 propertyName: "contentDensity",
                 name: "CONTENT_DENSITY"
-            }, oContainerAdapterConfig.contentDensity, sContentDensity);
+            }, oSettings.contentDensity, sContentDensity);
             // test that setChangedProperties is called if it is allowed to change contentDensity
-            oContainerAdapterConfig.contentDensity = sContentDensity;
+            oSettings.contentDensity = sContentDensity;
         };
 
         /**
@@ -511,7 +537,7 @@ sap.ui.define([
          * @since 1.30.0
          */
         this.isSetContentDensityPermitted = function () {
-            return oContainerAdapterConfig.setContentDensityPermitted;
+            return oSettings.setContentDensityPermitted;
         };
 
         /**
@@ -568,15 +594,15 @@ sap.ui.define([
         };
 
         this.getTrackUsageAnalytics = function () {
-            return oContainerAdapterConfig.trackUsageAnalytics;
+            return oSettings.trackUsageAnalytics;
         };
 
         this.setTrackUsageAnalytics = function (bTrackUsageAnalytics) {
             this.setChangedProperties({
                 propertyName: "trackUsageAnalytics",
                 name: "TRACKING_USAGE_ANALYTICS"
-            }, oContainerAdapterConfig.trackUsageAnalytics, bTrackUsageAnalytics);
-            oContainerAdapterConfig.trackUsageAnalytics = bTrackUsageAnalytics;
+            }, oSettings.trackUsageAnalytics, bTrackUsageAnalytics);
+            oSettings.trackUsageAnalytics = bTrackUsageAnalytics;
         };
 
         /**
@@ -588,8 +614,8 @@ sap.ui.define([
             this.setChangedProperties({
                 propertyName: "isImageConsent",
                 name: "ISIMAGECONSENT"
-            }, oContainerAdapterConfig.isImageConsent, isImageConsent);
-            oContainerAdapterConfig.isImageConsent = isImageConsent;
+            }, oSettings.isImageConsent, isImageConsent);
+            oSettings.isImageConsent = isImageConsent;
         };
 
         /**
@@ -598,7 +624,7 @@ sap.ui.define([
          * @returns {boolean} Whether the user gave his consent to present his profile picture or not
          */
         this.getImageConsent = function () {
-            return oContainerAdapterConfig.isImageConsent;
+            return oSettings.isImageConsent;
         };
 
         /**
@@ -608,7 +634,7 @@ sap.ui.define([
          * @private
          */
         this.getImportBookmarksFlag = function () {
-            return oContainerAdapterConfig.importBookmarks || null;
+            return oSettings.importBookmarks || null;
         };
 
         /**
@@ -623,7 +649,7 @@ sap.ui.define([
                 propertyName: "importBookmarks",
                 name: "MYHOME_IMPORT_FROM_CLASSIC"
             }, this.getImportBookmarksFlag() || "", sImportBookmarks);
-            oContainerAdapterConfig.importBookmarks = sImportBookmarks;
+            oSettings.importBookmarks = sImportBookmarks;
         };
 
         /**
@@ -633,7 +659,7 @@ sap.ui.define([
          * @private
          */
         this.getShowMyHome = function () {
-            return oContainerAdapterConfig.showMyHome !== false;
+            return oSettings.showMyHome !== false;
         };
 
         /**
@@ -647,8 +673,8 @@ sap.ui.define([
             this.setChangedProperties({
                 propertyName: "showMyHome",
                 name: "MYHOME_ENABLEMENT"
-            }, oContainerAdapterConfig.showMyHome, bShow);
-            oContainerAdapterConfig.showMyHome = bShow;
+            }, oSettings.showMyHome, bShow);
+            oSettings.showMyHome = bShow;
         };
 
         /**
@@ -658,7 +684,7 @@ sap.ui.define([
          * @private
          */
         this.getDetectDarkMode = function () {
-            return oContainerAdapterConfig.detectDarkMode !== false;
+            return oSettings.detectDarkMode !== false;
         };
 
         /**
@@ -672,15 +698,15 @@ sap.ui.define([
             this.setChangedProperties({
                 propertyName: "detectDarkMode",
                 name: "THEME_DARKMODE_AUTO_DETECTION"
-            }, oContainerAdapterConfig.detectDarkMode, bDetectDarkMode);
-            oContainerAdapterConfig.detectDarkMode = bDetectDarkMode;
+            }, oSettings.detectDarkMode, bDetectDarkMode);
+            oSettings.detectDarkMode = bDetectDarkMode;
         };
 
         // ------- Constructor -------
         oSystemTheme = {
             locationPathUi5: (new URI(sap.ui.require.toUrl(""))).absoluteTo(document.location).pathname(),
             // ensure an absolute path
-            locationPathCustom: oContainerAdapterConfig.themeRoot || "",
+            locationPathCustom: oSettings.themeRoot || "",
             locationOrigin: getOrigin(new URI(document.location))
         };
         if (!oSystemTheme.locationPathUi5) {
@@ -692,7 +718,7 @@ sap.ui.define([
         if (!oSystemTheme.locationOrigin) {
             Log.warning("User: Could not set front-end server location origin");
         }
-        oBootTheme = oContainerAdapterConfig.bootTheme || { theme: "", root: "" };
+        oBootTheme = oSettings.bootTheme || { theme: "", root: "" };
         oCurrentTheme = this._amendTheme(oBootTheme, oSystemTheme);
         oStartupTheme = oCurrentTheme;
     };

package/src/main/js/sap/ushell/adapters/cdm/ClientSideTargetResolutionAdapter.js

@@ -9,7 +9,7 @@
  * <li>provide the resolveHashFragment function, a fallback method called by ClientSideTargetResolution service.</li>
  * </ul>
  *
- * @version 1.131.1
+ * @version 1.132.1
  */
 sap.ui.define([
     "sap/base/util/Version",

package/src/main/js/sap/ushell/adapters/cdm/CommonDataModelAdapter.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's sap.ushell.adapters.cdm.CommonDataModelAdapter for the 'CDM'
  *               platform.
  *
- * @version 1.131.1
+ * @version 1.132.1
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/adapters/cdm/ConfigurationDefaultsAdapter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The ConfigurationDefaults adapter for the CDM platform.
  *
- * @version 1.131.1
+ * @version 1.132.1
  */
 sap.ui.define([
     "sap/ushell/bootstrap/cdm/cdm.constants",

package/src/main/js/sap/ushell/adapters/cdm/ContainerAdapter.js

@@ -2,10 +2,11 @@
 /**
  * @fileOverview The Unified Shell"s container adapter for the Common Data Model (CDM) platform.
  *
- * @version 1.131.1
+ * @version 1.132.1
  */
 sap.ui.define([
     "sap/base/Log",
+    "sap/base/util/deepClone",
     "sap/base/util/extend",
     "sap/base/util/ObjectPath",
     "sap/ui/thirdparty/URI",
@@ -17,6 +18,7 @@ sap.ui.define([
     "sap/ushell/resources"
 ], function (
     Log,
+    deepClone,
     extend,
     ObjectPath,
     URI,
@@ -87,7 +89,10 @@ sap.ui.define([
                 );
             }
 
-            return new User(oUserSettings || getNewUserSettingsWithDefaults());
+            // safe guard user settings
+            const oEffectiveUserSettings = removeUnsupportedUserProperties(oUserSettings || getNewUserSettingsWithDefaults());
+
+            return new User(oEffectiveUserSettings);
         }
 
         function createSystem (oOldSystem, oConfig) {
@@ -136,12 +141,12 @@ sap.ui.define([
          *
          * @param {object} oDefaults
          * @param {object} oPersonalization
-         * @param {object} oUserMetaData
+         * @param {object} oUserMetadata
          * @returns {object} UserSettings
          *
          * @private
          */
-        function createUserSettingsAsExpectedByUser (oDefaults, oPersonalization, oUserMetaData) {
+        function createUserSettingsAsExpectedByUser (oDefaults, oPersonalization, oUserMetadata) {
             var oUserSettings = extend(getNewUserSettingsWithDefaults(), oDefaults, oPersonalization);
 
             oUserSettings.bootTheme = oUserSettings.bootTheme || {
@@ -151,15 +156,15 @@ sap.ui.define([
 
             // ... remove redundant theme properties
             delete oUserSettings.theme;
-            if (oUserMetaData) {
+            if (oUserMetadata) {
                 // set edit modes
-                if (oUserMetaData.editablePropterties) {
-                    oUserSettings.setThemePermitted = oUserMetaData.editablePropterties.indexOf("theme") > -1;
-                    oUserSettings.setAccessibilityPermitted = oUserMetaData.editablePropterties.indexOf("accessibility") > -1;
-                    oUserSettings.setContentDensityPermitted = oUserMetaData.editablePropterties.indexOf("contentDensity") > -1;
+                if (oUserMetadata.editablePropterties) {
+                    oUserSettings.setThemePermitted = oUserMetadata.editablePropterties.indexOf("theme") > -1;
+                    oUserSettings.setAccessibilityPermitted = oUserMetadata.editablePropterties.indexOf("accessibility") > -1;
+                    oUserSettings.setContentDensityPermitted = oUserMetadata.editablePropterties.indexOf("contentDensity") > -1;
                 }
-                if (oUserMetaData.ranges) {
-                    oUserSettings.ranges = oUserMetaData.ranges;
+                if (oUserMetadata.ranges) {
+                    oUserSettings.ranges = oUserMetadata.ranges;
                 }
             }
             return oUserSettings;
@@ -419,7 +424,58 @@ sap.ui.define([
         this._getSessionKeepAliveConfig = function () {
             return oSessionKeepAliveConfig;
         };
+
+        /**
+         * Removes all unsupported user properties from the given user settings. This allows to safely
+         * create a new User object with the given settings.
+         * @param {object} oProperties The user settings
+         * @returns {object} The user settings without unsupported properties
+         *
+         * @since 1.132.0
+         * @private
+         */
+        function removeUnsupportedUserProperties (oProperties) {
+            const oPropertiesClone = deepClone(oProperties);
+
+            const aSupportedProperties = [
+                "id",
+                "email",
+                "firstName",
+                "lastName",
+                "fullName",
+                "isJamActive",
+                "isAdminUser",
+                "timeZone",
+                "language",
+                "languageBcp47",
+                "image",
+                "isImageConsent",
+                "isLanguagePersonalized",
+                "calendarWeekNumbering",
+                "trackUsageAnalytics",
+                "contentDensity",
+                "setContentDensityPermitted",
+                "accessibility",
+                "setAccessibilityPermitted",
+                "bootTheme",
+                "themeRoot",
+                "ranges",
+                "setThemePermitted",
+                "importBookmarks",
+                "showMyHome",
+                "detectDarkMode"
+            ];
+
+            Object.keys(oPropertiesClone).forEach(function (sKey) {
+                if (!aSupportedProperties.includes(sKey)) {
+                    delete oPropertiesClone[sKey];
+                }
+            });
+
+            return oPropertiesClone;
+        }
     };
+
     return ContainerAdapter;
 
 }, /* bExport= */ false);

package/src/main/js/sap/ushell/adapters/cdm/LaunchPageAdapter.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's LaunchPageAdapter for the
  *               'CDM' platform - Version 2 (V2)
  * @deprecated since 1.100
- * @version 1.131.1
+ * @version 1.132.1
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/_LaunchPage/readHome",

package/src/main/js/sap/ushell/adapters/cdm/MenuAdapter.js

@@ -7,7 +7,7 @@ sap.ui.define([
     "sap/ushell/library",
     "sap/ushell/Config",
     "sap/ushell/Container"
-], function(
+], function (
     ushellLibrary,
     Config,
     Container

package/src/main/js/sap/ushell/adapters/cdm/PagesCommonDataModelAdapter.js

@@ -5,7 +5,7 @@
  * It combines the page data, tile data, navigation data and personalization into a CDM 3.1 site.
  * Only used on the ABAP platform and on local for testing.
  *
- * @version 1.131.1
+ * @version 1.132.1
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/adapters/cdm/PersonalizationAdapter.js

@@ -5,7 +5,7 @@
  *
  *
  * The CDM personalization adapter can be used to store data in the RA@ABAP platform.
- * @version 1.131.1
+ * @version 1.132.1
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/_Personalization/internals",

package/src/main/js/sap/ushell/adapters/cdm/PersonalizationV2Adapter.js

@@ -5,7 +5,7 @@
  *
  *
  * The CDM personalization adapter can be used to store data in the RA@ABAP platform.
- * @version 1.131.1
+ * @version 1.132.1
  */
 sap.ui.define([
     "./PersonalizationAdapter"

package/src/main/js/sap/ushell/adapters/cdm/Ui5ComponentLoaderAdapter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's Ui5ComponentLoaderAdapter for the CDM platform
  *
- * @version 1.131.1
+ * @version 1.132.1
  */
 sap.ui.define([
 ], function () {

package/src/main/js/sap/ushell/adapters/cdm/_LaunchPage/modifyHome.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview Helper of modifying the home page data for the 'CDM' platform.
- * @version 1.131.1
+ * @version 1.132.1
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/_LaunchPage/readCatalogs.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview Helper of accessing catalog data for the 'CDM' platform.
- * @version 1.131.1
+ * @version 1.132.1
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/_LaunchPage/readHome.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Helper of accessing Home Page data for the 'CDM' platform.
  *
- * @version 1.131.1
+ * @version 1.132.1
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/_LaunchPage/uri.transform.js

@@ -4,7 +4,7 @@
  * @fileOverview Transforms relative URIs as used e.g. for data sources in the
  * manifest.json
  *
- * @version 1.131.1
+ * @version 1.132.1
  */
 sap.ui.define([
     "sap/ui/thirdparty/URI"

package/src/main/js/sap/ushell/adapters/cdm/util/AppForInbound.js

@@ -5,7 +5,7 @@
  * Creates CDM site entries for apps with the provided data.
  * Only used on the ABAP platform and on local for testing.
  *
- * @version 1.131.1
+ * @version 1.132.1
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/util/cdmSiteUtils.js

@@ -5,7 +5,7 @@
  * Creates CDM site entities with the provided data.
  * Only used on the ABAP platform and on local for testing.
  *
- * @version 1.131.1
+ * @version 1.132.1
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/v3/AdapterBase.js

@@ -4,7 +4,7 @@
  * @fileOverview The Base of Unified Shell's LaunchPageAdapter for the 'CDM' platform - Version 3 (V3)
  *   and StaticGroupsContainer for Featured Group
  *
- * @version 1.131.1
+ * @version 1.132.1
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readHome",

package/src/main/js/sap/ushell/adapters/cdm/v3/FlpLaunchPageAdapter.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's LaunchPageAdapter for the
  *               'CDM' platform - Version 3 (V3)
  *
- * @version 1.131.1
+ * @version 1.132.1
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readHome",