@sapui5/sap.ushell_abap 1.139.0 → 1.140.0

package/src/main/js/sap/ushell_abap/adapters/abap/NavTargetResolutionInternalAdapter.js

@@ -8,7 +8,7 @@
  * service now calls the ClientSideTargetResolution service in the ABAP
  * platform.
  *
- * @version 1.139.0
+ * @version 1.140.0
  * @since 1.121
  */
 sap.ui.define([], () => {

package/src/main/js/sap/ushell_abap/adapters/abap/PageBuildingAdapter.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Unified Shell's page building adapter for the ABAP platform.
- * @version 1.139.0
+ * @version 1.140.0
  */
 sap.ui.define([
     "sap/base/util/ObjectPath",
@@ -67,22 +67,12 @@ sap.ui.define([
      * @private
      */
     return function (oSystem, sParameter, oProperties) {
-        let oFactory;
         let sScope = "PERS";
         let sPageBuilderServiceUrl = "/sap/opu/odata/UI2/PAGE_BUILDER_PERS/"; // 3rd Priority (fallback)
         const mRemoteCatalogServices = oProperties.config.remoteCatalogServices || {};
         const sConfigBaseUrl = ObjectPath.get("config.services.pageBuilding.baseUrl", oProperties);
 
         // BEWARE: constructor code below!
-
-        /**
-         * Returns the UI2 page building factory.
-         * @returns {sap.ushell_abap.pbServices.ui2.Factory} the page building factory
-         */
-        this.getFactory = function () {
-            return oFactory;
-        };
-
         // constructor code -------------------------------------------------------
 
         // accept lower case parameter as in FLPD this is set as query parameter the user alters manually
@@ -102,13 +92,21 @@ sap.ui.define([
         // Get CacheId for PAGE_BUILDER_PERS when available
         const sCacheId = ObjectPath.get("sap-ushell-config.services.Container.adapter.config.services.pbFioriHome.cacheId");
 
-        oFactory = Factory.createFactory(
+        const oFactory = Factory.createFactory(
             sPageBuilderServiceUrl,
             undefined,
             sScope === "PERS",
             sCacheId
         );
 
+        /**
+         * Returns the UI2 page building factory.
+         * @returns {sap.ushell_abap.pbServices.ui2.Factory} the page building factory
+         */
+        this.getFactory = function () {
+            return oFactory;
+        };
+
         /**
          * Remote Catalogs are deprecated
          * @deprecated since 1.120

package/src/main/js/sap/ushell_abap/adapters/abap/PagePersistenceAdapter.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview PagePersistenceAdapter for the ABAP platform.
- * @version 1.139.0
+ * @version 1.140.0
  */
 sap.ui.define([
     "sap/base/i18n/Localization",
@@ -42,9 +42,9 @@ sap.ui.define([
      * @experimental Since 1.67.0
      * @private
      */
-    const PagePersistenceAdapter = function () {
+    function PagePersistenceAdapter () {
         this.S_COMPONENT_NAME = "sap.ushell_abap.adapters.abap.PagePersistenceAdapter";
-    };
+    }
 
     /**
      * Returns a page

package/src/main/js/sap/ushell_abap/adapters/abap/PersonalizationAdapter.js

@@ -7,7 +7,7 @@
  *               Container header properties transported via pseudo-items are mapped to the
  *               respective header properties in setItem/getItem/delItem
  *
- * @version 1.139.0
+ * @version 1.140.0
  */
 sap.ui.define([
     "sap/ushell_abap/adapters/abap/AdapterContainer",
@@ -44,7 +44,7 @@ sap.ui.define([
      * @since 1.11.0
      * @private
      */
-    const PersonalizationAdapter = function (oSystem, sParameters, oConfig) {
+    function PersonalizationAdapter (oSystem, sParameters, oConfig) {
         Log.debug("[000] PersonalizationAdapter: constructor", "PersonalizationAdapter");
         this._oConfig = oConfig && oConfig.config;
         const sPersonalizationServiceURL = `${ObjectPath.get("config.services.personalization.baseUrl", oConfig) || "/sap/opu/odata/UI2/INTEROP"}/`;
@@ -58,7 +58,7 @@ sap.ui.define([
             throw new SrvcError(oMessage, "sap.ushell_abap.adapters.abap.PersonalizationAdapter");
         }
         ODataService.call(this, this._oWrapper, fnDefaultFailure);
-    };
+    }
 
     // historically, the service always called  getAdapterContainer and then load
     // thus an implementation was not required to initialize a fully implemented container on getAdapterContainer

package/src/main/js/sap/ushell_abap/adapters/abap/PersonalizationV2Adapter.js

@@ -7,7 +7,7 @@
  *               Container header properties transported via pseudo-items are mapped to the
  *               respective header properties in setItem/getItem/delItem
  *
- * @version 1.139.0
+ * @version 1.140.0
  */
 sap.ui.define([
     "./PersonalizationAdapter"

package/src/main/js/sap/ushell_abap/adapters/abap/SearchAdapter.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Search adapter for the ABAP platform.
- * @version 1.139.0
+ * @version 1.140.0
  */
 sap.ui.define([], () => {
     "use strict";

package/src/main/js/sap/ushell_abap/adapters/abap/SupportTicketAdapter.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The SupportTicket adapter for the ABAP platform.
- * @version 1.139.0
+ * @version 1.140.0
  */
 sap.ui.define([
     "sap/base/util/isEmptyObject",

package/src/main/js/sap/ushell_abap/adapters/abap/Ui5ComponentLoaderAdapter.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview The Unified Shell's Ui5ComponentLoaderAdapter for the ABAP platform
  *
- * @version 1.139.0
+ * @version 1.140.0
  */
 sap.ui.define([
 ], () => {

package/src/main/js/sap/ushell_abap/adapters/abap/UserInfoAdapter.js

@@ -264,30 +264,28 @@ sap.ui.define([
         this.updateUserPreferences = function (oUser) {
             Log.debug("[000] updateUserPreferences", "UserInfoAdapter");
             const that = this;
-            let oDeferred;
             let sRelativeUrl;
-            let aUserChangedProperties;
             let iODataRequestsRunning;
             let oDataObj;
-            const fnSuccess = function () {
+            const oDeferred = new jQuery.Deferred();
+            function fnSuccess () {
                 iODataRequestsRunning -= 1;
                 if (iODataRequestsRunning === 0) {
                     oDeferred.resolve();
                 }
-            };
-            const fnFailure = function (sErrorMessage, oParsedErrorInformation) {
+            }
+            function fnFailure (sErrorMessage, oParsedErrorInformation) {
                 oDeferred.reject(sErrorMessage, oParsedErrorInformation);
-            };
+            }
             Log.debug("[000] updateUserPreferences: _createWrapper", "UserInfoAdapter");
             oDataWrapper = this._createWrapper("/sap/opu/odata/UI2/INTEROP/");
-            oDeferred = new jQuery.Deferred();
 
             // prepare
             Log.debug("[000] updateUserPreferences: oDataWrapper.openBatchQueue", "UserInfoAdapter");
             oDataWrapper.openBatchQueue();
 
             // put the preferences to update in the OData batch queue
-            aUserChangedProperties = oUser.getChangedProperties() || [];
+            const aUserChangedProperties = oUser.getChangedProperties() || [];
             Log.debug("[000] updateUserPreferences: getChangedProperties", "UserInfoAdapter");
             iODataRequestsRunning = aUserChangedProperties.length;
             aUserChangedProperties.forEach((oUserChangedProperty) => {

package/src/main/js/sap/ushell_abap/adapters/hana/ContainerAdapter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's container adapter for the HANA platform.
  *
- * @version 1.139.0
+ * @version 1.140.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

package/src/main/js/sap/ushell_abap/bootstrap/evo/SAPCompanionConditionSetter.js

@@ -27,7 +27,7 @@ sap.ui.define([
             Setter._ushellConfig = window["sap-ushell-config"];
         }
 
-        const fnTryToSetConditions = function () {
+        function fnTryToSetConditions () {
             if (window.Help4 !== undefined) {
                 const oSpacesConfig = Setter._ushellConfig.ushell.spaces;
                 const oConditions = {};
@@ -44,9 +44,9 @@ sap.ui.define([
                 return true;
             }
             return false;
-        };
+        }
 
-        const fnKeepTrying = function () {
+        function fnKeepTrying () {
             if (counter < Setter._timeoutCounter) {
                 counter++;
                 if (!fnTryToSetConditions()) {
@@ -58,7 +58,7 @@ sap.ui.define([
             } else {
                 oDeferred.reject();
             }
-        };
+        }
         fnKeepTrying();
         return oDeferred.promise;
     };

package/src/main/js/sap/ushell_abap/bootstrap/evo/XhrLogonEventHandler.js

@@ -17,6 +17,8 @@ sap.ui.define([
 
     /**
      * Helper class for handling events from XHR logon frame provider
+     * @param {Window} [oWindow=window] - the window object to use for reloading the page
+     * @param {string} [sXhrLogonMode="reload"] - the XHR logon mode, either "reload" or "logoffAndRedirect"
      *
      * @private
      */
@@ -126,9 +128,8 @@ sap.ui.define([
     XhrLogonEventHandler.prototype._logoffAndRedirect = function () {
         const sLocationHref = oAbapUtils.getLocationHref();
         const sClientId = ObjectPath.get("sap-ushell-config.services.Container.adapter.config.client");
-        let sUrl;
 
-        sUrl = new URI("/sap/public/bc/icf/logoff")
+        const sUrl = new URI("/sap/public/bc/icf/logoff")
             .absoluteTo(sLocationHref)
             .search(`sap-client=${sClientId}&propagateLogoff=false&redirectURL=${encodeURIComponent(sLocationHref)}`)
             .toString();
@@ -138,6 +139,8 @@ sap.ui.define([
     /**
      * Checks if the page is currently being reloaded by the XHR logon which triggers this by setting query-parameter sap-ushell-reloaded
      *
+     * @returns {boolean} true if the page is reloaded, false otherwise
+     *
      * @private
      */
     XhrLogonEventHandler.prototype._isPageReloaded = function () {

package/src/main/js/sap/ushell_abap/bootstrap/evo/abap.bootstrap.utils.js

@@ -153,7 +153,7 @@ sap.ui.define([
      */
     utils.getLocationOrigin = function () {
         // location.origin might not be supported by all browsers
-        return `${location.protocol}//${location.host}`;
+        return `${window.location.protocol}//${window.location.host}`;
     };
 
     /**
@@ -165,7 +165,7 @@ sap.ui.define([
      * @private
      */
     utils.getLocationHref = function () {
-        return location.href;
+        return window.location.href;
     };
 
     return utils;

package/src/main/js/sap/ushell_abap/bootstrap/evo/abap.configure.ushell.js

@@ -14,7 +14,7 @@
  * It furthermore calculates if FLP pages get activated and if needed sets up
  * the configuration environment to run these.
  *
- * @version 1.139.0
+ * @version 1.140.0
  */
 sap.ui.define([
     "./abap.constants",

package/src/main/js/sap/ushell_abap/bootstrap/evo/abap.request.pageset.js

@@ -28,36 +28,22 @@ sap.ui.define([
     // Check (only once for this file) if sap-statistics is set in query parameter or local storage
     let bSapStatistics = BootstrapUtils.isSapStatisticsSet();
 
-    function requestPageSet (oStartupResult) {
-        const sPageSetServiceUrl = getAndAdjustPageSetServiceURL(oStartupResult);
-        const oDeferred = createODataDeferred(sPageSetServiceUrl);// TODO make as Promise.all
-
-        requestOData(sPageSetServiceUrl, oStartupResult, (iStatus, sCsrfToken, sResponse) => {
-            processOData(oDeferred, iStatus, sCsrfToken, sResponse);
-        });
-    }
-
-    /**
-     * Determines the URL for the PageSets OData service from the startup service result. If the URL is not set
-     * a hard-coded fallback URL is returned and set in the startupResult.
-     */
-    function getAndAdjustPageSetServiceURL (oStartupCallResult) {
-        const sUI2CacheDisable = oAbapUtils.getUrlParameterValue("sap-ui2-cache-disable");
-        if (sUI2CacheDisable && oStartupCallResult && oStartupCallResult.services && oStartupCallResult.services.pbFioriHome) {
-            oStartupCallResult.services.pbFioriHome["sap-ui2-cache-disable"] = sUI2CacheDisable;
-        }
-        return getAndAdjustServiceURL(
-            oStartupCallResult,
-            "pbFioriHome",
-            S_PAGE_SETS_FALLBACK_URL_BASE,
-            S_PAGE_SETS_FALLBACK_URL_RELATIVE,
-            S_PAGE_SETS_FALLBACK_EXPAND
-        );
-    }
-
     /**
      * Determines the URL for the PageSets OData service from the startup service result. If the URL is not set
      * a hard-coded fallback URL is returned and set in the startupResult.
+     *
+     * @param {object} oStartupCallResult
+     * the startup service result object
+     * @param {string} sServicePropertyName
+     * the name of the service property in the startup result
+     * @param {string} sFallbackBaseUrl
+     * the fallback base URL to be used if the service URL is not set
+     * @param {string} sFallbackRelativeUrl
+     * the fallback relative URL to be used if the service URL is not set
+     * @param {string} sFallbackExpand
+     * the fallback expand parameter to be used if the service URL is not set
+     * @returns {string}
+     * the URL for the service, adjusted with the fallback values if necessary
      */
     function getAndAdjustServiceURL (oStartupCallResult, sServicePropertyName, sFallbackBaseUrl, sFallbackRelativeUrl, sFallbackExpand) {
         let sServiceUrl;
@@ -143,11 +129,36 @@ sap.ui.define([
         }
     }
 
+    /**
+     * Determines the URL for the PageSets OData service from the startup service result. If the URL is not set
+     * a hard-coded fallback URL is returned and set in the startupResult.
+     *
+     * @param {object} oStartupCallResult
+     * the startup service result object
+     * @returns {string}
+     * the URL for the PageSets OData service
+     */
+    function getAndAdjustPageSetServiceURL (oStartupCallResult) {
+        const sUI2CacheDisable = oAbapUtils.getUrlParameterValue("sap-ui2-cache-disable");
+        if (sUI2CacheDisable && oStartupCallResult && oStartupCallResult.services && oStartupCallResult.services.pbFioriHome) {
+            oStartupCallResult.services.pbFioriHome["sap-ui2-cache-disable"] = sUI2CacheDisable;
+        }
+        return getAndAdjustServiceURL(
+            oStartupCallResult,
+            "pbFioriHome",
+            S_PAGE_SETS_FALLBACK_URL_BASE,
+            S_PAGE_SETS_FALLBACK_URL_RELATIVE,
+            S_PAGE_SETS_FALLBACK_EXPAND
+        );
+    }
+
     /**
      * Creates the Deferred in the OData.read cache to keep the result of the request with the
      * given URL.
      * @param {string} sUrl
+     * the URL to be requested
      * @returns {jQuery.Deferred}
+     * the deferred object which will be resolved with the response of the request
      *
      * @private
      */
@@ -165,13 +176,16 @@ sap.ui.define([
 
     /**
      * Performs an OData GET request using a plain XHR.
-     * @param {function(number, object, function)}
+     * @param {string} sUrl
+     * the url to be requested
+     * @param {object} oStartupResult
+     * the startup result object, containing the base URL and the CSRF token
+     * @param {function(number, object, function)} fnCallback
      *    callback function to be called when the request finished, taking the status code, the
      *    CSRF token and the response message
      */
     function requestOData (sUrl, oStartupResult, fnCallback) {
-        let oXHR;
-        oXHR = oAbapUtils.createAndOpenXHR(sUrl, oStartupResult);
+        const oXHR = oAbapUtils.createAndOpenXHR(sUrl, oStartupResult);
         // set sap-statistics header, see
         // http://help.sap.com/saphelp_nw74/helpdata/de/40/93b81292194d6a926e105c10d5048d/content.htm
         if (bSapStatistics) {
@@ -186,6 +200,15 @@ sap.ui.define([
         oXHR.send();
     }
 
+    function requestPageSet (oStartupResult) {
+        const sPageSetServiceUrl = getAndAdjustPageSetServiceURL(oStartupResult);
+        const oDeferred = createODataDeferred(sPageSetServiceUrl);// TODO make as Promise.all
+
+        requestOData(sPageSetServiceUrl, oStartupResult, (iStatus, sCsrfToken, sResponse) => {
+            processOData(oDeferred, iStatus, sCsrfToken, sResponse);
+        });
+    }
+
     oPagesetHandler.requestPageSet = requestPageSet;
     oPagesetHandler._getAndAdjustServiceURL = getAndAdjustServiceURL; // Only for testing
     oPagesetHandler._getAndAdjustPageSetServiceURL = getAndAdjustPageSetServiceURL; // Only for testing

package/src/main/js/sap/ushell_abap/bootstrap/evo/abap.theme.handler.js

@@ -16,8 +16,9 @@ sap.ui.define([
 
     /**
      * Checks if ThemeRoot is part of the allowlist
+     * @param {string} sOrigin the origin of the theme root to be validated
      *
-     * @param {string} sOrigin
+     * @returns {boolean} if it is part of the allowlist
      */
     function validateThemeOrigin (sOrigin) {
         const aArrayOfAllowedOrigins = oMetaTagHandler.readMetaTags(

package/src/main/js/sap/ushell_abap/bootstrap/evo/boottask.js

@@ -53,6 +53,10 @@ sap.ui.define([
      *
      * The root intent (e.g., #Shell-home) will
      * not determine a direct start condition.
+     *
+     * @param {string} sHash the hash
+     *
+     * @returns {boolean} if it is a direct start
      * @private
      */
     function isDirectStart (sHash) {
@@ -60,9 +64,9 @@ sap.ui.define([
          * Determine whether sHash is a standalone hash.
          * In this case, the hash is not set as initial target for the start_up service.
          *
-         * @param {string} sName
+         * @param {string} sCurrentHash
          *   URL parameter name
-         * @returns {boolean}
+         * @returns {boolean} if it is a standalone hash
          * @private
          */
         function isStandaloneHash (sCurrentHash) {
@@ -109,14 +113,13 @@ sap.ui.define([
      */
     // TODO Refactor: Align with URLParsing.getShellHash
     function getFullShellHash () {
-        let sHashDecoded;
         const sHref = oAbapUtils.getLocationHref();
         const iHashIndex = sHref.indexOf("#");
         if (iHashIndex < 0) {
             return "";
         }
         // decode hash: identical behavior to ShellNavigationInternal.hrefForExternal
-        sHashDecoded = decodeURI(sHref.slice(iHashIndex + 1));
+        const sHashDecoded = decodeURI(sHref.slice(iHashIndex + 1));
         return sHashDecoded;
     }
 
@@ -261,7 +264,7 @@ sap.ui.define([
 
     /**
      * Extracts the theme root from the startup service result or fall back
-     * @param {object} oStartupServiceResult
+     * @param {object} oStartupServiceResult the startup service result
      * @returns {string} the system theme root
      *
      * @private
@@ -288,7 +291,7 @@ sap.ui.define([
 
     /**
      * Extracts the theme from the startup service result
-     * @param {object} startup service result
+     * @param {object} oStartupServiceResult startup service result
      * @returns {string} the theme or undefined
      *
      * @private
@@ -318,8 +321,8 @@ sap.ui.define([
      * theme root is set to "". The theme is then loaded by the UI5 http handler. This is necessary
      * as the themeing infrastructure is not mandatory and therefore it cannot be ensured that the
      * http handler of the theming infrastructure is running.
-     * @params {string} theme
-     * @params {string} system theme root
+     * @param {string} sTheme theme
+     * @param {string} sSystemThemeRoot system theme root
      * @returns {string} theme root for the given theme
      *
      * @private
@@ -337,16 +340,14 @@ sap.ui.define([
      * Assumption: The theme returned in the startup service does not have a root.
      * It is only the theme name!
      * The theme root is amended here in.
-     * @params {string} startup theme
-     * @params {string} system theme root
+     * @param {string} oStartupServiceResult startup theme
+     * @param {string} sSystemThemeRoot system theme root
      * @returns {object} theme root for the startup theme
      *
      * @private
      */
     function determineStartupTheme (oStartupServiceResult, sSystemThemeRoot) {
-        let sTheme;
-
-        sTheme = extractThemeFromStartupServiceResult(oStartupServiceResult);
+        const sTheme = extractThemeFromStartupServiceResult(oStartupServiceResult);
         return {
             theme: sTheme,
             root: determineThemeRoot(sTheme, sSystemThemeRoot)
@@ -355,15 +356,18 @@ sap.ui.define([
 
     /**
      * Extracts the theme from the URL and determines the theme root
+     *
+     * @param {string} sSystemThemeRoot
+     * the system theme root, as determined by the startup service
+     *
      * @returns {object} contains the theme and the theme root, undefined if no URL theme supplied
      *
      * @private
      */
     function determineUrlTheme (sSystemThemeRoot) {
-        let sThemeUrlParameter;
         let aThemeParts;
 
-        sThemeUrlParameter = oAbapUtils.getUrlParameterValue("sap-theme") || oAbapUtils.getUrlParameterValue("sap-ui-theme");
+        const sThemeUrlParameter = oAbapUtils.getUrlParameterValue("sap-theme") || oAbapUtils.getUrlParameterValue("sap-ui-theme");
         if (sThemeUrlParameter) {
             if (sThemeUrlParameter.indexOf("@") > 0) {
                 aThemeParts = sThemeUrlParameter.split("@", 2);
@@ -428,6 +432,12 @@ sap.ui.define([
     /**
      * Process themes
      *
+     *  @param {object} oStartupTheme
+     *  the theme from the startup service
+     *  @param {string} sSystemThemeRoot
+     *  the system theme root, as determined by the startup service
+     *
+     *  @returns {object} oBootTheme
      * @private
      */
     function processTheme (oStartupTheme, sSystemThemeRoot) {
@@ -690,13 +700,12 @@ sap.ui.define([
     function createWaitForRendererCreatedPromise () {
         const oPromise = new Promise((resolve, reject) => {
             let oRenderer;
-            let fnOnRendererCreated;
 
-            fnOnRendererCreated = function () {
+            function fnOnRendererCreated () {
                 Log.info("Direct application start: resolving component waitFor promise after shell renderer created event fired.");
                 resolve();
                 getContainer().detachRendererCreatedEvent(fnOnRendererCreated);
-            };
+            }
 
             EventHub.once("ShellNavigationInitialized").do(() => {
                 oRenderer = getContainer().getRendererInternal();