@sapui5/sap.ushell 1.114.0 → 1.115.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sapui5/sap.ushell",
-    "version": "1.114.0",
+    "version": "1.115.0",
     "description": "SAPUI5 Library sap.ushell",
     "homepage": "https://sap.github.io/ui5-tooling/pages/SAPUI5/",
     "keywords": [

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

@@ -2,7 +2,7 @@
 <library xmlns="http://www.sap.com/sap.ui.library.xsd">
     <name>sap.ushell</name>
     <vendor>SAP SE</vendor>
-    <version>1.114.0</version>
+    <version>1.115.0</version>
     <copyright>Copyright (c) 2009-2023 SAP SE, All Rights Reserved</copyright>
     <documentation>SAP library: sap.ushell</documentation>
 

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

@@ -91,38 +91,27 @@ sap.ui.define([
             delete oEffectiveParameters["sap-system-src"];
         }
 
-        return new Promise(function (fnResolve, fnReject) {
-            oSystemAlias.spliceSapSystemIntoURI(
-                oUri,
-                oInboundResolutionResult.systemAlias,
-                sSapSystem,
-                sSapSystemDataSrc,
-                "WCF",
-                oInboundResolutionResult.systemAliasSemantics || oSystemAlias.SYSTEM_ALIAS_SEMANTICS.applied,
-                fnExternalSystemAliasResolver
-            )
-                .done(function (oURI) {
-                    var sParameters = oApplicationTypeUtils.getURLParsing().paramsToString(oEffectiveParameters),
-                        sFinalUrl = oApplicationTypeUtils.appendParametersToUrl(sParameters, oURI.toString());
-
-                    var oResolutionResult = {
-                        url: sFinalUrl,
-                        text: oInboundResolutionResult.text || "",
-                        additionalInformation: oInboundResolutionResult.additionalInformation || "",
-                        applicationType: "WCF",
-                        fullWidth: true,
-                        extendedInfo: getExtendedInfo(oMatchingTarget)
-                    };
-
-                    checkOpenWithPost(oMatchingTarget, oResolutionResult);
-                    addKeepAliveToURLTemplateResult(oResolutionResult);
-                    addIframeCacheHintToURL(oResolutionResult, "WCF");
-                    fnResolve(oResolutionResult);
-                })
-                .fail(function (sError) {
-                    fnReject(sError);
-                });
-        });
+        return oSystemAlias.spliceSapSystemIntoURI(
+            oUri, oInboundResolutionResult.systemAlias, sSapSystem, sSapSystemDataSrc, "WCF",
+            oInboundResolutionResult.systemAliasSemantics || oSystemAlias.SYSTEM_ALIAS_SEMANTICS.applied, fnExternalSystemAliasResolver)
+            .then(function (oURI) {
+                var sParameters = oApplicationTypeUtils.getURLParsing().paramsToString(oEffectiveParameters);
+                var sFinalUrl = oApplicationTypeUtils.appendParametersToUrl(sParameters, oURI);
+
+                var oResolutionResult = {
+                    url: sFinalUrl,
+                    text: oInboundResolutionResult.text || "",
+                    additionalInformation: oInboundResolutionResult.additionalInformation || "",
+                    applicationType: "WCF",
+                    fullWidth: true,
+                    extendedInfo: getExtendedInfo(oMatchingTarget)
+                };
+
+                checkOpenWithPost(oMatchingTarget, oResolutionResult);
+                addKeepAliveToURLTemplateResult(oResolutionResult);
+                addIframeCacheHintToURL(oResolutionResult, "WCF");
+                return oResolutionResult;
+            });
     }
 
     function generateUI5ResolutionResult (oMatchingTarget, sBaseUrl, fnExternalSystemAliasResolver) {
@@ -232,7 +221,7 @@ sap.ui.define([
 
     // extracts the inner app route from the browser hash
     function getInnerAppRoute (oTemplatePayload) {
-        var sInnerAppRoute = undefined;
+        var sInnerAppRoute;
         var sHashFragment = hasher.getHash() || window.location.hash;
         var indexOfInnerRoute = sHashFragment.lastIndexOf("&/");
         var iOffset = 1; //to avoid the starting "&";
@@ -307,7 +296,7 @@ sap.ui.define([
 
                 var debugMode = false;
                 if (window["sap-ui-debug"] !== false && window["sap-ui-debug"] !== undefined) {
-                    debugMode = window['sap-ui-debug'];
+                    debugMode = window["sap-ui-debug"];
                 }
 
                 fnResolve({
@@ -668,11 +657,12 @@ sap.ui.define([
                 // is the only quick way to solve the issue. A more
                 // deep process to solve the issue in a proper way will
                 // be done via a BLI as the issue is very complex
-                var sJamSearchPref = "/universal_search/search?query=",
+                // please do not remove the usage of "window.location.hash"
+                var sJamSearchPref = "/universal_search/search",
                     iJamSearchPos = oRuntime.innerAppRoute && oRuntime.innerAppRoute.indexOf(sJamSearchPref),
-                    JamSearchVal;
+                    JamInnerRoute;
                 if (iJamSearchPos === 0) {
-                    JamSearchVal = oRuntime.innerAppRoute.substring(sJamSearchPref.length);
+                    JamInnerRoute = window.location.hash.split("&/")[1];
                     oRuntime.innerAppRoute = "/JAMSEARCHPATHH?JAMSEARCHVALUEE=VALUEE";
                 }
 
@@ -685,7 +675,7 @@ sap.ui.define([
                 );
 
                 if (iJamSearchPos === 0) {
-                    sURL = sURL.replace("/JAMSEARCHPATHH?JAMSEARCHVALUEE=VALUEE", sJamSearchPref + encodeURIComponent(JamSearchVal));
+                    sURL = sURL.replace("/JAMSEARCHPATHH?JAMSEARCHVALUEE=VALUEE", "/" + JamInnerRoute);
                 }
 
                 if (oRuntime.env.theme === undefined) {
@@ -940,18 +930,13 @@ sap.ui.define([
                 fnResolve(sBaseUrl);
             } else {
                 oSystemAlias.spliceSapSystemIntoURI(
-                    oURI, oInboundResolutionResult.systemAlias,
-                    sSapSystem,
-                    sSapSystemDataSrc,
-                    "URL",
-                    oInboundResolutionResult.systemAliasSemantics || oSystemAlias.SYSTEM_ALIAS_SEMANTICS.applied,
-                    fnExternalSystemAliasResolver
-                )
-                    .fail(fnReject)
-                    .done(function (oSapSystemURI) {
+                    oURI, oInboundResolutionResult.systemAlias, sSapSystem, sSapSystemDataSrc,
+                    "URL", oInboundResolutionResult.systemAliasSemantics || oSystemAlias.SYSTEM_ALIAS_SEMANTICS.applied,
+                    fnExternalSystemAliasResolver)
+                    .then(function (oSapSystemURI) {
                         var sSapSystemUrl = oSapSystemURI.toString();
                         fnResolve(sSapSystemUrl);
-                    });
+                    }, fnReject);
             }
         }))
             .then(function (sUrlWithoutParameters) {

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

@@ -174,7 +174,7 @@ sap.ui.define([
 
         // Redraw if the shapes color has been changed
         onThemeChanged: function () {
-            var sShapesColor = ThemingParameters.get("sapUshellShellBackgroundShapesColor");
+            var sShapesColor = ThemingParameters.get("sapUiShellBackgroundPatternColor");
             if (sShapesColor && sShapesColor !== "transparent") { // sap_fiori_3 has transparent shapes
                 this.sShapesColor = sShapesColor;
                 this.bIsDirty = true;
@@ -345,7 +345,7 @@ sap.ui.define([
                 context.clearRect(0, 0, canvasWidth * 2, canvasHeight * 2);
 
                 if (!this.sShapesColor) {
-                    this.sShapesColor = ThemingParameters.get("sapUshellShellBackgroundShapesColor");
+                    this.sShapesColor = ThemingParameters.get("sapUiShellBackgroundPatternColor");
                 }
 
                 if (this.sShapesColor && this.sShapesColor !== "transparent") { // sap_fiori_3 has transparent shapes

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

@@ -25,6 +25,11 @@ sap.ui.define([
         _reset: function () {
             oFlpConfigChannel = null;
         },
+        // For testing only
+        _resetContract: function () {
+            oChannelContract = CommonCreateConfigContract.createConfigContract(window["sap-ushell-config"]);
+            this._reset();
+        },
         // TODO: this is now more a replace configuration and must be changed
         // to implement the API from future concept.
         registerConfiguration: function (sOwnerName, oContract) {

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

@@ -246,7 +246,7 @@ sap.ui.define([
          *   it is taken from the configuration property <code>defaultRenderer</code> if not given here.
          * @param {boolean} [bAsync] If <code>true</code>, the renderer is created asynchronously and a <code>Promise</code> is returned.
          *
-         * @returns {sap.ui.core.Control|Promise} the renderer or Promise (in asynchronous mode)
+         * @returns {sap.ui.core.Control|Promise<sap.ui.core.Control>|sap.ui.core.ComponentContainer|Promise<sap.ui.core.ComponentContainer>} the renderer or Promise (in asynchronous mode)
          * @since 1.15.0
          * @public
          */
@@ -293,6 +293,7 @@ sap.ui.define([
                 }
 
                 replacePlaceAt(oShellControl);
+                replaceDestroy(oShellControl);
                 oRenderers[sRendererName] = oRenderer;
 
                 oEventProvider.fireEvent("rendererCreated", {
@@ -319,6 +320,7 @@ sap.ui.define([
                                 async: true
                             });
                             replacePlaceAt(oComponentContainer);
+                            replaceDestroy(oComponentContainer);
                             oRenderers[sRendererName] = oRenderer;
                             oRenderer.rootControlLoaded().then(function () {
                                 oEventProvider.fireEvent("rendererCreated", { renderer: oRenderer });
@@ -326,6 +328,7 @@ sap.ui.define([
                             });
                         } else if (oRenderer instanceof Control) {
                             replacePlaceAt(oRenderer);
+                            replaceDestroy(oRenderer);
                             oRenderers[sRendererName] = oRenderer;
                             oEventProvider.fireEvent("rendererCreated", { renderer: oRenderer });
                             resolve(oRenderer);
@@ -370,6 +373,18 @@ sap.ui.define([
                 };
             }
 
+            function replaceDestroy (oControl) {
+                var fnOriginalDestroy = oControl.destroy;
+                oControl.destroy = function () {
+                    if (oControl.isA("sap.ui.core.ComponentContainer")) {
+                        return Promise.resolve(oControl.getComponentInstance().destroy()).then(function () {
+                            return fnOriginalDestroy.apply(oControl, arguments);
+                        });
+                    }
+                    return Promise.resolve(fnOriginalDestroy.apply(oControl, arguments));
+                };
+            }
+
             var sModule = sComponentName.replace(/\./g, "/");
             if (bAsync) {
                 return getRendererInstanceAsync(sModule);
@@ -384,7 +399,7 @@ sap.ui.define([
          *
          * @param {string} [sRendererName] The renderer name, such as "standard" or "fiori2";
          *   it is taken from the configuration property <code>defaultRenderer</code> if not given here.
-         * @returns {object} the renderer with the specified name; the returned object is either a control
+         * @returns {sap.ui.core.Control|sap.ui.core.Component} the renderer with the specified name; the returned object is either a control
          *   (i.e. extend <code>sap.ui.core.Control</code>) or a UI component (i.e. extend <code>sap.ui.core.UIComponent</code>),
          *   i.e. this method unwraps the renderer component from its <code>sap.ui.core.ComponentContainer</code>;
          *   if no renderer name can be determined and a single renderer instance has been created, this single instance is returned.
@@ -762,7 +777,7 @@ sap.ui.define([
          * See registerDirtyStateProvider for more information.
          * Only the last registered function will be deregistered (in case it was registered multiple times).
          *
-         * @param {Function} fnDirty function for determining the state of the application
+         * @param {function} fnDirty function for determining the state of the application
          * @since 1.67.0
          * @public
          */
@@ -844,7 +859,7 @@ sap.ui.define([
          * @param {string} [sParameter] A parameter which is passed to the service constructor and every adapter constructor. (since 1.15.0)
          * @param {boolean} [bAsync] if true, the adapter is loaded asynchronously and a Promise is returned. (since 1.55.0)
          *
-         * @returns {object|Promise} the service or, in asynchronous mode, a Promise that returns the service
+         * @returns {object|Promise<object>} the service or, in asynchronous mode, a Promise that returns the service
          *
          * @throws {Error} If <code>sServiceName</code> is not the name of an available service.
          *
@@ -913,7 +928,7 @@ sap.ui.define([
          *
          * @param {string} sServiceName The service name, such as "Menu"
          * @param {string} [sParameter] A parameter which is passed to the service constructor and every adapter constructor.
-         * @returns {Promise} a Promise that returns the requested service
+         * @returns {Promise<object>} a Promise that returns the requested service
          * @see sap.ushell.services.ContainerInterface
          * @since 1.55.0
          * @public

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

@@ -5,7 +5,7 @@
  *
  * The Fiori20 adapter automatically re-styles old (Fiori 1) applications to match Fiori2 design requirements.
  *
- * @version 1.114.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/ui/base/Object",

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

@@ -4,7 +4,7 @@
  * @fileOverview The purpose Fiori20AdapterTest in this file is to decide whether to load the Fiori20Adapter at all.
  * This file is kept small in size on purpose as it is always required in productive code even when Fiori 2 adaptation is not required.
  *
- * @version 1.114.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -1238,8 +1238,11 @@ sap.ui.define([
     };
 
     var LayoutConstructor = function () { };
+    var fnPromiseResolve;
     LayoutConstructor.prototype = {
-        _initDeferred: jQuery.Deferred(),
+
+        _initDeferred: new Promise(function (fnResolve) { fnPromiseResolve = fnResolve; }),
+
         init: function (cfg) {
             // in some devices this code runs before css filed were loaded and we don't get the correct styleInfo object
             var timeoutLayoutInfo = function () {
@@ -1254,7 +1257,7 @@ sap.ui.define([
                     this.layoutEngine = new CollisionModule({
                         thisLayout: this
                     });
-                    this._initDeferred.resolve();
+                    fnPromiseResolve();
                     return;
                 }
                 setTimeout(timeoutLayoutInfo, 100);
@@ -1301,7 +1304,7 @@ sap.ui.define([
         },
 
         getInitPromise: function () {
-            return this._initDeferred.promise();
+            return this._initDeferred;
         },
 
         getLayoutEngine: function () {
@@ -1487,12 +1490,6 @@ sap.ui.define([
             }
         },
 
-        /**
-         * @param containerWidth
-         * @param tileWidth
-         * @param tileMargin
-         * @returns {number}
-         */
         calcTilesInRow: function (containerWidth, tileWidth, tileMargin) {
             var tilesInRow = Math.floor(containerWidth / (tileWidth + tileMargin));
             // Min number of tile in row that was predefined by UI
@@ -1597,4 +1594,4 @@ sap.ui.define([
     };
     var Layout = new LayoutConstructor();
     return Layout;
-}, /* bExport= */ false);
+});

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

@@ -2,7 +2,7 @@
 /**
  * @fileOverview NWBCInterface for NWBC client
  *
- * @version 1.114.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/ushell/EventHub",

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

@@ -90,8 +90,6 @@ sap.ui.define([
              *
              *    // Automatic signout or reload request dialog (undefined->false)
              *    oConfig.enableAutomaticSignout = true;
-             *
-             *    debugger;
              */
 
             Log.debug("SessionHandler.oConfig.sessionTimeoutIntervalInMinutes: " + oConfig.sessionTimeoutIntervalInMinutes, "", "SessionHandler");
@@ -141,7 +139,7 @@ sap.ui.define([
         this.initLogout = function () {
             if (bLogoutInitialized === false) {
                 sap.ushell.Container.registerLogout(this.logout);
-                this.registerCommHandlers();
+                this._registerCommHandlers();
                 bLogoutInitialized = true;
             }
         };
@@ -172,7 +170,7 @@ sap.ui.define([
             this.monitorUserIsInactive();
         };
 
-        this.registerCommHandlers = function () {
+        this._registerCommHandlers = function () {
             AppLifeCycle.registerShellCommunicationHandler({
                 "sap.ushell.sessionHandler": {
                     oRequestCalls: {

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

@@ -40,7 +40,7 @@
  * parameters. If the application tries to access an internal parameter (e.g.,
  * sap-ui-app-id-hint) via the API, the application receives an error message.
  *
- * @version 1.114.0
+ * @version 1.115.0
  * @private
  */
 sap.ui.define([

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

@@ -26,7 +26,7 @@
  * The language to define parameters in the URL Template parameter set contains a minimal set of conditionals,
  * logical operators, and functions that allow to define the parameter set with a certain degree of control.
  *
- * @version 1.114.0
+ * @version 1.115.0
  * @private
  */
 sap.ui.define([

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

@@ -2,7 +2,7 @@
 /**
  * @fileOverview Ui5 Native Service Factory
  *
- * @version 1.114.0
+ * @version 1.115.0
  */
 
 /**

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

@@ -6,7 +6,7 @@
  * Exposes methods to create a UI5 Service Factory for a specific Unified Shell
  * Service.
  *
- * @version 1.114.0
+ * @version 1.115.0
  */
 
 /**