@sapui5/sap.ushell 1.136.3 → 1.138.0

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

@@ -2,7 +2,7 @@
 /**
  * @fileOverview The Unified Shell"s container adapter for the Common Data Model (CDM) platform.
  *
- * @version 1.136.3
+ * @version 1.138.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -17,7 +17,7 @@ sap.ui.define([
     "sap/ushell/Container",
     "sap/ushell/resources",
     "sap/ushell/Config"
-], function (
+], (
     Log,
     deepClone,
     extend,
@@ -30,8 +30,7 @@ sap.ui.define([
     Container,
     resources,
     ushellConfig
-) {
-
+) => {
     "use strict";
 
     /**
@@ -43,7 +42,7 @@ sap.ui.define([
      * @private
      */
 
-    var oLogger = Log.getLogger("sap/ushell/adapters/cdm/ContainerAdapter", Log.Level.INFO);
+    const oLogger = Log.getLogger("sap/ushell/adapters/cdm/ContainerAdapter", Log.Level.INFO);
 
     /**
      * @class
@@ -54,6 +53,8 @@ sap.ui.define([
      * Constructs a new instance of the container adapter for the Common Data Model (CDM) platform.
      *
      * @param {sap.ushell.System} oInitialSystem the logon system (alias, platform, base URL)
+     * @param {string} sParameter parameter string, not in use.
+     * @param {object} oProperties configuration object for the adapter.
      *
      * @see sap.ushell.services.initializeContainer
      *
@@ -62,15 +63,7 @@ sap.ui.define([
      * @since 1.48.0
      * @private
      */
-    var ContainerAdapter = function (oInitialSystem, sParameter, oProperties) {
-        var S_LOGOUT_URL_DEFAULT = "/sap/public/bc/icf/logoff",
-            sLogoutUrl = getLogoffUrl(oProperties.config, S_LOGOUT_URL_DEFAULT),
-            sLogoutMethod = ObjectPath.get("systemProperties.logoutMethod", oProperties.config) || "GET",
-            sCsrfTokenUrl = ObjectPath.get("systemProperties.csrfTokenUrl", oProperties.config),
-            oUser = createUser(oProperties.config),
-            oSystem = createSystem(oInitialSystem, oProperties.config),
-            oSessionKeepAliveConfig = getSessionKeepAliveConfig(oProperties.config);
-
+    function ContainerAdapter (oInitialSystem, sParameter, oProperties) {
         function getLogoffUrl (oConfig, sDefaultLogoffUrl) {
             if (oConfig.systemProperties && oConfig.systemProperties.logoutUrl) {
                 return oConfig.systemProperties.logoutUrl;
@@ -79,9 +72,115 @@ sap.ui.define([
             return sDefaultLogoffUrl;
         }
 
+        /**
+         * Returns an object with default settings as sap.ushell.Container expects it.
+         * @returns {object}
+         *   The user settings defaults within a new object
+         * @private
+         */
+        function getNewUserSettingsWithDefaults () {
+            return {
+                setThemePermitted: false,
+                setAccessibilityPermitted: false,
+                setContentDensityPermitted: false,
+                getLanguageAndRegionSettingsEntry: async function () {
+                    const [oEntry] = await ushellUtils.requireAsync(["sap/ushell/adapters/cdm/Settings/UserLanguageAndRegion/UserLanguageAndRegionEntry"]);
+
+                    return oEntry;
+                }
+            };
+        }
+
+        /**
+         * sap.ushell.User expects an object with user settings. This looks different than in
+         * oProperties.config.userProfile as the interface expects the structure as the ABAP
+         * start_up service returned it.
+         *
+         * @param {object} oDefaults the defaults.
+         * @param {object} oPersonalization the personalization.
+         * @param {object} oUserMetadata the user metadata.
+         * @returns {object} UserSettings
+         *
+         * @private
+         */
+        function createUserSettingsAsExpectedByUser (oDefaults, oPersonalization, oUserMetadata) {
+            const oUserSettings = extend(getNewUserSettingsWithDefaults(), oDefaults, oPersonalization);
+
+            oUserSettings.bootTheme = oUserSettings.bootTheme || {
+                theme: oUserSettings.theme,
+                root: ""
+            };
+
+            // ... remove redundant theme properties
+            delete oUserSettings.theme;
+            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.ranges) {
+                    oUserSettings.ranges = oUserMetadata.ranges;
+                }
+            }
+            return oUserSettings;
+        }
+
+        /**
+         * 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",
+                "getLanguageAndRegionSettingsEntry"
+            ];
+
+            Object.keys(oPropertiesClone).forEach((sKey) => {
+                if (!aSupportedProperties.includes(sKey)) {
+                    delete oPropertiesClone[sKey];
+                }
+            });
+
+            return oPropertiesClone;
+        }
+
         function createUser (oConfig) {
-            var oUserSettings,
-                oUserProfile = oConfig.userProfile;
+            let oUserSettings;
+            const oUserProfile = oConfig.userProfile;
 
             if (oUserProfile) {
                 oUserSettings = createUserSettingsAsExpectedByUser(
@@ -98,17 +197,17 @@ sap.ui.define([
         }
 
         function createSystem (oOldSystem, oConfig) {
-            var oSystemProperties = oConfig.systemProperties,
-                sAlias = oOldSystem.getAlias(),
-                sPlatform = oOldSystem.getPlatform(),
-                sBaseUrl = oOldSystem.getBaseUrl(),
-                sSID,
-                sClient,
-                sProductName,
-                sProductVersion,
-                sSystemName,
-                sSystemRole,
-                sTenantRole;
+            const oSystemProperties = oConfig.systemProperties;
+            let sAlias = oOldSystem.getAlias();
+            let sPlatform = oOldSystem.getPlatform();
+            const sBaseUrl = oOldSystem.getBaseUrl();
+            let sSID;
+            let sClient;
+            let sProductName;
+            let sProductVersion;
+            let sSystemName;
+            let sSystemRole;
+            let sTenantRole;
 
             if (oSystemProperties) {
                 sAlias = oSystemProperties.alias || sAlias;
@@ -136,61 +235,6 @@ sap.ui.define([
             });
         }
 
-        /**
-         * sap.ushell.User expects an object with user settings. This looks different than in
-         * oProperties.config.userProfile as the interface expects the structure as the ABAP
-         * start_up service returned it.
-         *
-         * @param {object} oDefaults
-         * @param {object} oPersonalization
-         * @param {object} oUserMetadata
-         * @returns {object} UserSettings
-         *
-         * @private
-         */
-        function createUserSettingsAsExpectedByUser (oDefaults, oPersonalization, oUserMetadata) {
-            var oUserSettings = extend(getNewUserSettingsWithDefaults(), oDefaults, oPersonalization);
-
-            oUserSettings.bootTheme = oUserSettings.bootTheme || {
-                theme: oUserSettings.theme,
-                root: ""
-            };
-
-            // ... remove redundant theme properties
-            delete oUserSettings.theme;
-            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.ranges) {
-                    oUserSettings.ranges = oUserMetadata.ranges;
-                }
-            }
-            return oUserSettings;
-        }
-
-        /**
-         * Returns an object with default settings as sap.ushell.Container expects it.
-         * @returns {object}
-         *   The user settings defaults within a new object
-         * @private
-         */
-        function getNewUserSettingsWithDefaults () {
-            return {
-                setThemePermitted: false,
-                setAccessibilityPermitted: false,
-                setContentDensityPermitted: false,
-                getLanguageAndRegionSettingsEntry: async function () {
-                    var [oEntry] = await ushellUtils.requireAsync(["sap/ushell/adapters/cdm/Settings/UserLanguageAndRegion/UserLanguageAndRegionEntry"]);
-
-                    return oEntry;
-                }
-            };
-        }
-
         /**
          * Validates and extracts the sessionKeepAlive configuration from the adapter configuration
          *
@@ -198,7 +242,7 @@ sap.ui.define([
          * @returns {object} the extracted sessionKeepAlive config or <code>null</code> if invalid of undefined
          */
         function getSessionKeepAliveConfig (oAdapterConfig) {
-            var oConfig = oAdapterConfig && oAdapterConfig.systemProperties
+            const oConfig = oAdapterConfig && oAdapterConfig.systemProperties
                 && oAdapterConfig.systemProperties.sessionKeepAlive;
 
             if (!oConfig) {
@@ -217,6 +261,14 @@ sap.ui.define([
             return oConfig;
         }
 
+        const S_LOGOUT_URL_DEFAULT = "/sap/public/bc/icf/logoff";
+        const sLogoutUrl = getLogoffUrl(oProperties.config, S_LOGOUT_URL_DEFAULT);
+        const sLogoutMethod = ObjectPath.get("systemProperties.logoutMethod", oProperties.config) || "GET";
+        const sCsrfTokenUrl = ObjectPath.get("systemProperties.csrfTokenUrl", oProperties.config);
+        const oUser = createUser(oProperties.config);
+        const oSystem = createSystem(oInitialSystem, oProperties.config);
+        const oSessionKeepAliveConfig = getSessionKeepAliveConfig(oProperties.config);
+
         /**
          * Returns the logout URL.
          *
@@ -232,14 +284,13 @@ sap.ui.define([
         /**
          * Sets the given sLocation as window.document.location in order to force a redirect
          *
-         * @param {string} sLocation
+         * @param {string} sLocation the current document location
          * @private
          */
         this._setDocumentLocation = function (sLocation) {
             document.location = sLocation;
         };
 
-
         this._setWindowLocation = function (data) {
             window.location.href = data;
         };
@@ -302,7 +353,7 @@ sap.ui.define([
          * @since 1.48.0
          */
         this.logout = async function (bLogonSystem) {
-            var sFullLogOffUrl;
+            let sFullLogOffUrl;
 
             if (!bLogonSystem) {
                 // this is the logout from a non-logon system
@@ -334,7 +385,7 @@ sap.ui.define([
             // adjust the URL, e.g. by applying sap-client or base URL
             const sCurrentLogout = oSystem.adjustUrl(this._getLogoutUrl());
 
-            //new support for logoff via POST and not GET (currently used in CF)
+            // new support for logoff via POST and not GET (currently used in CF)
             if (sLogoutMethod === "POST") {
                 Log.info("performing logout from system via POST", undefined, "sap.ushell.adapters.cdm.ContainerAdapter::logoutRedirect");
 
@@ -353,7 +404,7 @@ sap.ui.define([
                 }
 
                 if (bError || !responseCsrfToken.ok) {
-                    Log.error("fetching X-CSRF-Token for logout via POST failed for system: " + oSystem.getAlias(),
+                    Log.error(`fetching X-CSRF-Token for logout via POST failed for system: ${oSystem.getAlias()}`,
                         undefined, "sap.ushell.adapters.cdm.ContainerAdapter::logoutRedirect");
 
                     // Unauthorized, no need to log off
@@ -386,7 +437,7 @@ sap.ui.define([
                 }
 
                 if (bError || !responseLogout.ok) {
-                    Log.error("logout via POST failed for system: " + oSystem.getAlias(),
+                    Log.error(`logout via POST failed for system: ${oSystem.getAlias()}`,
                         undefined, "sap.ushell.adapters.cdm.ContainerAdapter::logoutRedirect");
                 }
             } else {
@@ -404,16 +455,15 @@ sap.ui.define([
          * @since 1.66.0
          */
         this.sessionKeepAlive = function () {
-
             if (!oSessionKeepAliveConfig) {
                 return;
             }
 
-            var oXHR = new XMLHttpRequest();
-            oXHR.open(oSessionKeepAliveConfig.method, oSessionKeepAliveConfig.url, /*async=*/true);
+            const oXHR = new XMLHttpRequest();
+            oXHR.open(oSessionKeepAliveConfig.method, oSessionKeepAliveConfig.url, /* async=*/true);
 
             oXHR.onreadystatechange = function () {
-                if (this.readyState === /*DONE*/4) {
+                if (this.readyState === /* DONE */4) {
                     oLogger.debug("Server session was extended");
                 }
             };
@@ -431,59 +481,7 @@ 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",
-                "getLanguageAndRegionSettingsEntry"
-            ];
-
-            Object.keys(oPropertiesClone).forEach(function (sKey) {
-                if (!aSupportedProperties.includes(sKey)) {
-                    delete oPropertiesClone[sKey];
-                }
-            });
-
-            return oPropertiesClone;
-        }
-    };
+    }
 
     return ContainerAdapter;
-
 }, /* bExport= */ false);