@sapui5/sap.ushell 1.136.3 → 1.138.0

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

@@ -13,7 +13,7 @@ sap.ui.define([
     "sap/ui/core/LocaleData",
     "sap/ui/thirdparty/URI",
     "sap/ushell/utils"
-], function (
+], (
     Log,
     Localization,
     deepExtend,
@@ -23,7 +23,7 @@ sap.ui.define([
     LocaleData,
     URI,
     ushellUtils
-) {
+) => {
     "use strict";
 
     // "private" methods (static) without need to access properties -------------
@@ -43,12 +43,12 @@ sap.ui.define([
     }
 
     function getOrigin (oUri) {
-        var sOrigin;
+        let sOrigin;
 
         if (oUri.host && typeof oUri.host === "function" && oUri.host()) {
             sOrigin = oUri.host();
             if (typeof oUri.protocol === "function" && oUri.protocol()) {
-                sOrigin = oUri.protocol() + "://" + sOrigin;
+                sOrigin = `${oUri.protocol()}://${sOrigin}`;
             }
             return sOrigin;
         }
@@ -73,14 +73,12 @@ sap.ui.define([
      * @param {object} oSettings the result provided by the ContainerAdapter
      * @since 1.15.0
      */
-    var User = function (oSettings = {}) {
+    function User (oSettings = {}) {
         // actually the parameter contains the container adapter config
-        var aChangedProperties = [];
-        var oBootTheme;
-        var oSystemTheme;
-        var oCurrentTheme;
-        var oStartupTheme;
-        var oEventProvider = new EventProvider();
+        let aChangedProperties = [];
+        let oCurrentTheme;
+        let oStartupTheme;
+        const oEventProvider = new EventProvider();
 
         // todo: ABAP specific code should be moved to ushell_abap
         // User profile and edit states are only available on ABAP platform
@@ -175,11 +173,11 @@ sap.ui.define([
          * @since 1.84.0
          */
         this.getInitials = function () {
-            var sFullName = oSettings.fullName || "";
-            var sInitials = "";
-            var bNext = true;
+            const sFullName = oSettings.fullName || "";
+            let sInitials = "";
+            let bNext = true;
 
-            for (var i = 0, len = sFullName.length; i < len; ++i) {
+            for (let i = 0, len = sFullName.length; i < len; ++i) {
                 if (sFullName[i] === " ") {
                     bNext = true;
                 } else if (bNext) {
@@ -228,9 +226,9 @@ sap.ui.define([
          * @since 1.67.0
          */
         this.getLanguageText = function () {
-            var oLocale = new Locale(Localization.getLanguageTag());
-            var oLocaleData = new LocaleData(oLocale);
-            var sLanguageTag = Localization.getLanguageTag().toString();
+            const oLocale = new Locale(Localization.getLanguageTag());
+            const oLocaleData = new LocaleData(oLocale);
+            const sLanguageTag = Localization.getLanguageTag().toString();
             return (oLocaleData.getLanguageName(sLanguageTag) || this.getLanguage());
         };
 
@@ -330,7 +328,7 @@ sap.ui.define([
             }
             if (sThemeFormat === User.prototype.constants.themeFormat.THEME_NAME_PLUS_URL) {
                 return oCurrentTheme.theme + (oCurrentTheme.locationPath
-                    ? "@" + oCurrentTheme.locationOrigin + oCurrentTheme.locationPath
+                    ? `@${oCurrentTheme.locationOrigin}${oCurrentTheme.locationPath}`
                     : "");
             }
             if (sThemeFormat === User.prototype.constants.themeFormat.NWBC) {
@@ -371,50 +369,6 @@ sap.ui.define([
             return "";
         };
 
-        /**
-         * Sets this user's selected theme and applies it.
-         * Also the theme is prepared to be stored as next start theme on the front-end server.
-         * The save itself has to be triggered by method updateUserPreferences of the UserInfo service.
-         * The theme can have the following formats:
-         *   - <SAP theme> (starts with sap_)
-         *     Theme will be loaded from the standard UI5 theme path from the front-end server
-         *   - <custom theme> (does not start with sap_)
-         *     If root is supplied explicitly in oContainerAdapterConfig.ranges.theme[].themeRoot, it will be used.
-         *     theme will be loaded from the standard custom theme path (system theme root) from the front-end server
-         *   - <theme name>@<theme path>
-         *     Theme will be loaded from the supplied path from the front-end server
-         *   - <theme name>@<theme URL> (not only the theme path but has also the origin)
-         *     Theme will be loaded from the supplied URL. There could occur same origin issues.
-         * The theme root where the theme to be applied is read from is determined considering the theme name.
-         * If the theme starts with sap_ the theme is read from the standard UI5 theme path.
-         * For all other themes the front-end server's system theme root is used.
-         *
-         * @param {string} sNewTheme The theme to be applied
-         * @since 1.15.0
-         */
-        this.setTheme = function (sNewTheme) {
-            if (this.isSetThemePermitted() === false) {
-                var sErrorMsg = "setTheme not permitted";
-                Log.error(sErrorMsg);
-                throw new Error(sErrorMsg);
-            }
-
-            oCurrentTheme = this._amendTheme({
-                theme: sNewTheme,
-                root: this.getThemeRoot(sNewTheme)
-            }, oSystemTheme);
-
-            if (sNewTheme !== oStartupTheme.originalTheme.theme) {
-                this.setChangedProperties({
-                    propertyName: "theme",
-                    name: "THEME"
-                }, oStartupTheme.originalTheme.theme, sNewTheme);
-                oStartupTheme = oCurrentTheme;
-            }
-
-            this.applyTheme(sNewTheme);
-        };
-
         /**
          * Mark the new theme set for saving.
          *
@@ -437,48 +391,6 @@ sap.ui.define([
             }
         };
 
-        /**
-         * Applies the given theme temporarily, without changing the
-         * current preference of the user.
-         *
-         * @param {string} sNewTheme
-         *   The new theme
-         *
-         * @protected
-         */
-        this.applyTheme = function (sNewTheme) {
-            var oTheme = this._amendTheme({
-                theme: sNewTheme,
-                root: this.getThemeRoot(sNewTheme)
-            }, oSystemTheme);
-
-            // change current display theme
-            oCurrentTheme = oTheme;
-
-            const _applyTheme = Core.applyTheme;
-            if (!_applyTheme) { // ui5 v.2
-                sap.ui.require("sap/ui/core/Theming").setTheme(oTheme.theme);
-            } else if (oTheme.suppliedRoot) { // Keep the legacy code until Workzone/cFLP adds all theme roots to sap-ui-config correctly
-                _applyTheme(oTheme.theme, oTheme.suppliedRoot + "/UI5/"); // the supplied path is the first choice
-            } else if (oTheme.path) {
-                _applyTheme(oTheme.theme, oTheme.path + "/UI5/"); // second choice is the amended path
-            } else {
-                _applyTheme(oTheme.theme); // sap_ theme from the front-end server
-            }
-
-            // send a message the Iframe to change its theme
-            sap.ui.require(["sap/ushell/appIntegration/PostMessageManager"], function (PostMessageManager) {
-                PostMessageManager.sendRequestToAllApplications(
-                    "sap.ushell.appRuntime.themeChange",
-                    {
-                        currentThemeId: this.getTheme(User.prototype.constants.themeFormat.NWBC),
-                        themeServiceRoute: window.location.protocol + "//" + window.location.host + "/comsapuitheming.runtime/themeroot/v1"
-                    },
-                    false
-                );
-            }.bind(this));
-        };
-
         /**
          * Sets this user's selected language and applies it.
          * Also the language is prepared to be stored as next start language on the front-end server.
@@ -515,7 +427,7 @@ sap.ui.define([
          */
         this.setAccessibilityMode = function (bAccessibility) {
             if (this.isSetAccessibilityPermitted() === false) {
-                var sErrorMsg = "setAccessibilityMode not permitted";
+                const sErrorMsg = "setAccessibilityMode not permitted";
                 Log.error(sErrorMsg);
                 throw new Error(sErrorMsg);
             }
@@ -575,7 +487,7 @@ sap.ui.define([
          */
         this.setContentDensity = function (sContentDensity) {
             if (this.isSetContentDensityPermitted() === false) {
-                var sErrorMsg = "setContentDensity not permitted";
+                const sErrorMsg = "setContentDensity not permitted";
                 Log.error(sErrorMsg);
                 throw new Error(sErrorMsg);
             }
@@ -647,7 +559,7 @@ sap.ui.define([
         this.resetChangedProperty = function (sPropertyName) {
             Log.debug("[000] resetChangedProperty: sPropertyName:", sPropertyName, "User");
 
-            aChangedProperties = aChangedProperties.filter(function (oProperty) {
+            aChangedProperties = aChangedProperties.filter((oProperty) => {
                 return !(sPropertyName === oProperty.propertyName);
             });
         };
@@ -762,7 +674,7 @@ sap.ui.define([
         };
 
         // ------- Constructor -------
-        oSystemTheme = {
+        const oSystemTheme = {
             locationPathUi5: (new URI(sap.ui.require.toUrl(""))).absoluteTo(document.location).pathname(),
             // ensure an absolute path
             locationPathCustom: oSettings.themeRoot || "",
@@ -777,10 +689,96 @@ sap.ui.define([
         if (!oSystemTheme.locationOrigin) {
             Log.warning("User: Could not set front-end server location origin");
         }
-        oBootTheme = oSettings.bootTheme || { theme: "", root: "" };
+        const oBootTheme = oSettings.bootTheme || { theme: "", root: "" };
         oCurrentTheme = this._amendTheme(oBootTheme, oSystemTheme);
         oStartupTheme = oCurrentTheme;
-    };
+
+        /**
+         * Sets this user's selected theme and applies it.
+         * Also the theme is prepared to be stored as next start theme on the front-end server.
+         * The save itself has to be triggered by method updateUserPreferences of the UserInfo service.
+         * The theme can have the following formats:
+         *   - <SAP theme> (starts with sap_)
+         *     Theme will be loaded from the standard UI5 theme path from the front-end server
+         *   - <custom theme> (does not start with sap_)
+         *     If root is supplied explicitly in oContainerAdapterConfig.ranges.theme[].themeRoot, it will be used.
+         *     theme will be loaded from the standard custom theme path (system theme root) from the front-end server
+         *   - <theme name>@<theme path>
+         *     Theme will be loaded from the supplied path from the front-end server
+         *   - <theme name>@<theme URL> (not only the theme path but has also the origin)
+         *     Theme will be loaded from the supplied URL. There could occur same origin issues.
+         * The theme root where the theme to be applied is read from is determined considering the theme name.
+         * If the theme starts with sap_ the theme is read from the standard UI5 theme path.
+         * For all other themes the front-end server's system theme root is used.
+         *
+         * @param {string} sNewTheme The theme to be applied
+         * @since 1.15.0
+         */
+        this.setTheme = function (sNewTheme) {
+            if (this.isSetThemePermitted() === false) {
+                const sErrorMsg = "setTheme not permitted";
+                Log.error(sErrorMsg);
+                throw new Error(sErrorMsg);
+            }
+
+            oCurrentTheme = this._amendTheme({
+                theme: sNewTheme,
+                root: this.getThemeRoot(sNewTheme)
+            }, oSystemTheme);
+
+            if (sNewTheme !== oStartupTheme.originalTheme.theme) {
+                this.setChangedProperties({
+                    propertyName: "theme",
+                    name: "THEME"
+                }, oStartupTheme.originalTheme.theme, sNewTheme);
+                oStartupTheme = oCurrentTheme;
+            }
+
+            this.applyTheme(sNewTheme);
+        };
+
+        /**
+         * Applies the given theme temporarily, without changing the
+         * current preference of the user.
+         *
+         * @param {string} sNewTheme
+         *   The new theme
+         *
+         * @protected
+         */
+        this.applyTheme = function (sNewTheme) {
+            const oTheme = this._amendTheme({
+                theme: sNewTheme,
+                root: this.getThemeRoot(sNewTheme)
+            }, oSystemTheme);
+
+            // change current display theme
+            oCurrentTheme = oTheme;
+
+            const _applyTheme = Core.applyTheme;
+            if (!_applyTheme) { // ui5 v.2
+                sap.ui.require("sap/ui/core/Theming").setTheme(oTheme.theme);
+            } else if (oTheme.suppliedRoot) { // Keep the legacy code until Workzone/cFLP adds all theme roots to sap-ui-config correctly
+                _applyTheme(oTheme.theme, `${oTheme.suppliedRoot}/UI5/`); // the supplied path is the first choice
+            } else if (oTheme.path) {
+                _applyTheme(oTheme.theme, `${oTheme.path}/UI5/`); // second choice is the amended path
+            } else {
+                _applyTheme(oTheme.theme); // sap_ theme from the front-end server
+            }
+
+            // send a message the Iframe to change its theme
+            sap.ui.require(["sap/ushell/appIntegration/PostMessageManager"], (PostMessageManager) => {
+                PostMessageManager.sendRequestToAllApplications(
+                    "sap.ushell.appRuntime.themeChange",
+                    {
+                        currentThemeId: this.getTheme(User.prototype.constants.themeFormat.NWBC),
+                        themeServiceRoute: `${window.location.protocol}//${window.location.host}/comsapuitheming.runtime/themeroot/v1`
+                    },
+                    false
+                );
+            });
+        };
+    }
 
     /**
      * Completes missing parts of a theme data set returning a new object
@@ -825,8 +823,8 @@ sap.ui.define([
         }
 
         function splitRootAndAmend (sRoot, oTheme) {
-            var oUrl = new URI(sRoot);
-            var sOrigin = getOrigin(oUrl);
+            const oUrl = new URI(sRoot);
+            const sOrigin = getOrigin(oUrl);
 
             // root has no origin -> use the system origin
             return {
@@ -835,12 +833,12 @@ sap.ui.define([
             };
         }
 
-        var oThemeResult = {
+        const oThemeResult = {
             originalTheme: clone(oThemeInput)
         };
-        var oRootParts;
+        let oRootParts;
         if (oThemeResult.originalTheme.theme.indexOf("@") > 0) {
-            var aThemeParts = oThemeResult.originalTheme.theme.split("@", 2);
+            const aThemeParts = oThemeResult.originalTheme.theme.split("@", 2);
             oThemeResult.theme = aThemeParts[0];
             oThemeResult.suppliedRoot = aThemeParts[1];
             oRootParts = splitRootAndAmend(aThemeParts[1], oSystemTheme);