@sapui5/sap.ushell 1.138.1 → 1.139.0

package/src/main/js/sap/ushell/services/Message.js

@@ -2,14 +2,14 @@
 
 /**
  * @fileOverview The Unified Shell's message service.
- * @version 1.138.1
+ * @version 1.139.0
  * @deprecated since 1.120
  */
 sap.ui.define([
     "sap/ushell/services/MessageInternal"
-], function (
+], (
     MessageInternal
-) {
+) => {
     "use strict";
 
     /**

package/src/main/js/sap/ushell/services/MessageBroker/MessageBrokerEngine.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module contains the implementation of the message broker
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -19,11 +19,10 @@ sap.ui.define([
     const oConnectedClients = {};
     const oSubscribedClients = {};
 
-    //add default origin
+    // add default origin
     oAcceptedOrigins[window.location.origin] = true;
 
     function MessageBrokerEngine () {
-
         this.setEnabled = function (bVal) {
             bEnabled = bVal;
         };
@@ -110,13 +109,10 @@ sap.ui.define([
             } else if (!oConnectedClients[sClientId]) {
                 sError = "Client is already disconnected";
             } else {
-
                 for (const sChannelKey in oClientsPerChannel) {
-
                     const aChannelClients = oClientsPerChannel[sChannelKey];
                     // find client and remove from the channel
                     for (const oClientKey in aChannelClients) {
-
                         const oClient = aChannelClients[oClientKey];
 
                         if (oClient.clientId === sClientId) {
@@ -177,7 +173,6 @@ sap.ui.define([
                 sError = "Client is not connected";
             } else {
                 for (const sChannelKey in aSubscribedChannels) {
-
                     const oChannel = aSubscribedChannels[sChannelKey];
 
                     // add new client to the channel
@@ -220,7 +215,6 @@ sap.ui.define([
 
                 // if new client
                 if (!oSubscribedClients[sClientId]) {
-
                     bIsNewClient = true;
 
                     const oSubscriptionData = {
@@ -303,14 +297,12 @@ sap.ui.define([
             }
 
             for (const sChannelIndex in aUnsubscribedChannels) {
-
                 const oChannel = aUnsubscribedChannels[sChannelIndex];
 
                 if (oClientsPerChannel[oChannel.channelId]) {
                     const aChannelClients = oClientsPerChannel[oChannel.channelId];
                     // find client and remove from the channel
                     for (const oClientKey in aChannelClients) {
-
                         const oClient = aChannelClients[oClientKey];
 
                         if (oClient.clientId === sClientId) {
@@ -383,7 +375,6 @@ sap.ui.define([
             }
 
             for (const sClientKey in aTargetClientIds) {
-
                 const sTargetClientId = aTargetClientIds[sClientKey];
 
                 // if message is for all clients in the channel
@@ -494,15 +485,12 @@ sap.ui.define([
             const oNotifiedClients = {};
 
             for (const sChannelKey in oClientsPerChannel) {
-
                 const oChannel = oClientsPerChannel[sChannelKey];
 
                 for (const sClientKey in oChannel) {
-
                     const oClient = oChannel[sClientKey];
                     // do not notify the same client who initiated the event
                     if (oClient.clientId !== sClientId && !oNotifiedClients[oClient.clientId]) {
-
                         const oParams = {
                             clientId: sClientId,
                             channels: aChannels
@@ -511,7 +499,6 @@ sap.ui.define([
                         if (oClient.isUI5 !== false) {
                             oClient.clientConnectionCallback(sMessageName, sClientId, aChannels);
                         } else {
-
                             oParams.channelId = "sap.ushell.MessageBroker";
                             oParams.messageName = sMessageName;
 
@@ -542,7 +529,6 @@ sap.ui.define([
 
         this._sendMessage = function (aTargetClients, sChannelId, sMessageId, sMessageName, sClientId, data) {
             for (const sClientKey in aTargetClients) {
-
                 const oClient = aTargetClients[sClientKey];
 
                 // do not send message to the same client who requested to send it
@@ -592,7 +578,6 @@ sap.ui.define([
 
         this._handlePostMessageRequest = function (oMessageDataBody, oIframe, sOrigin) {
             return new Promise((resolve, reject) => {
-
                 const sClientId = oMessageDataBody.clientId;
                 const sChannelId = oMessageDataBody.channelId;
                 const sRequestId = oMessageDataBody.requestId;
@@ -683,7 +668,6 @@ sap.ui.define([
                     true
                 );
                 return oResponse;
-
             }
 
             if (sObjectType === "event") {
@@ -698,7 +682,6 @@ sap.ui.define([
                     oMessageBody
                 );
                 return oRequest;
-
             }
 
             if (sObjectType === "request") {
@@ -740,15 +723,13 @@ sap.ui.define([
                     correlationMessageId: oParams.requestId,
                     messageName: oParams.messageName
                 };
-                const oResult = {
+                return {
                     isRequest: false,
                     requestId: oParams.requestId,
                     isSuccess: true,
                     serviceRequest: sServiceName,
                     messageBody: oMessageBody
                 };
-                return oResult;
-
             }
 
             if (sObjectType === "event") {
@@ -758,13 +739,11 @@ sap.ui.define([
                     messageName: oParams.messageName,
                     channels: oParams.channels
                 };
-                const oResult = {
+                return {
                     isRequest: true,
                     serviceRequest: sServiceName,
                     messageBody: oMessageBody
                 };
-                return oResult;
-
             }
 
             if (sObjectType === "request") {
@@ -774,19 +753,17 @@ sap.ui.define([
                     messageName: oParams.messageName,
                     data: oParams.data
                 };
-                const oResult = {
+                return {
                     isRequest: true,
                     serviceRequest: sServiceName,
                     messageBody: oMessageBody
                 };
-                return oResult;
             }
 
-            const oResult = {
+            return {
                 isRequest: true,
                 serviceRequest: sServiceName
             };
-            return oResult;
         };
 
         this._sendPostMessage = function (PostMessageManager, oResult, oContentWindow, sTargetOrigin) {

package/src/main/js/sap/ushell/services/MessageBroker.js

@@ -2,15 +2,18 @@
 
 /**
  * @fileOverview This module exposes API endpoints for Generic Communication
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
     "sap/ushell/services/MessageBroker/MessageBrokerEngine",
     "sap/base/Log"
-], function (MessageBrokerEngine, Log) {
+], (
+    MessageBrokerEngine,
+    Log
+) => {
     "use strict";
 
-    var oServiceConfig = {};
+    let oServiceConfig = {};
 
     /**
      * @alias sap.ushell.services.MessageBroker
@@ -27,22 +30,23 @@ sap.ui.define([
      *
      * @hideconstructor
      *
+     * @param {object} oContainerInterface the container interface, not in use.
+     * @param {object} sParameters the parameter string, not in use.
+     * @param {object} oServiceConfiguration the service configuration.
+     *
      * @since 1.72.0
      * @private
      */
-    var MessageBroker = function (oContainerInterface, sParameters, oServiceConfiguration) {
-        oServiceConfig = oServiceConfiguration && oServiceConfiguration.config || {};
+    function MessageBroker (oContainerInterface, sParameters, oServiceConfiguration) {
+        oServiceConfig = oServiceConfiguration?.config || {};
         MessageBrokerEngine.setEnabled(this.isEnabled());
         if (!this.isEnabled()) {
             Log.warning("FLP's message broker service is disabled by shell configuration");
         }
-    };
+    }
 
     MessageBroker.prototype.isEnabled = function () {
-        if (oServiceConfig.enabled === undefined || oServiceConfig.enabled === true) {
-            return true;
-        }
-        return false;
+        return oServiceConfig.enabled || oServiceConfig.enabled === undefined;
     };
 
     /**

package/src/main/js/sap/ushell/services/MessageInternal.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's message service.
  * This is a private service replacing the depercated Message service, as the functionality is used thoughout the ushell.
  *
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -19,7 +19,7 @@ sap.ui.define([
     "sap/m/FormattedText",
     "sap/m/library",
     "sap/ui/core/library"
-], function (
+], (
     Log,
     MessageBox,
     Config,
@@ -32,20 +32,20 @@ sap.ui.define([
     FormattedText,
     mobileLibrary,
     coreLibrary
-) {
+) => {
     "use strict";
 
     // shortcut for sap.m.ButtonType
-    var ButtonType = mobileLibrary.ButtonType;
+    const ButtonType = mobileLibrary.ButtonType;
 
     // shortcut for sap.m.DialogType
-    var DialogType = mobileLibrary.DialogType;
+    const DialogType = mobileLibrary.DialogType;
 
     // shortcut for sap.ui.core.ValueState
-    var ValueState = coreLibrary.ValueState;
+    const ValueState = coreLibrary.ValueState;
 
     // shortcut for sap.m.FlexRendertype
-    var FlexRendertype = mobileLibrary.FlexRendertype;
+    const FlexRendertype = mobileLibrary.FlexRendertype;
 
     /**
      * @alias sap.ushell.services.MessageInternal
@@ -67,7 +67,7 @@ sap.ui.define([
      * @private
      */
     function MessageInternal () {
-        var fnShellCallBackFunction;
+        let fnShellCallBackFunction;
 
         /**
          * Initialization:
@@ -117,14 +117,14 @@ sap.ui.define([
          * @private
          */
         this.buildMessage = function (iType, sMessage, oParameters) {
-            var oMessageBoxConfig = {
+            let oMessageBoxConfig = {
                 title: oParameters.title,
                 actions: oParameters.actions,
                 details: oParameters.details,
                 onClose: oParameters.callback,
                 emphasizedAction: oParameters.emphasizedAction
             };
-            var sMessageBoxType;
+            let sMessageBoxType;
 
             switch (iType) {
                 case MessageInternal.Type.ERROR:
@@ -165,22 +165,22 @@ sap.ui.define([
          * @private
          */
         this._copyToClipboard = function (message, config, dialogTitle) {
-            var sFormattedDetails = config.details;
+            let sFormattedDetails = config.details;
 
             if (typeof config.details === "object") {
                 // Using stringify() with "tab" as space argument and escaping the JSON to prevent binding
                 sFormattedDetails = JSON.stringify(config.details, null, "\t");
             }
 
-            var aCopiedText = [
-                "Title: " + (dialogTitle || "-"),
-                "Message: " + (message || "-"),
-                "Details: " + (sFormattedDetails || "-")
+            const aCopiedText = [
+                `Title: ${dialogTitle || "-"}`,
+                `Message: ${message || "-"}`,
+                `Details: ${sFormattedDetails || "-"}`
             ];
 
-            var oElementWithPrevFocus = document.activeElement;
-            var oTemporaryDomElement = document.createElement("textarea");
-            var sMessageToastText;
+            const oElementWithPrevFocus = document.activeElement;
+            const oTemporaryDomElement = document.createElement("textarea");
+            let sMessageToastText;
 
             try {
                 oTemporaryDomElement.contentEditable = true;
@@ -189,7 +189,7 @@ sap.ui.define([
                 document.documentElement.appendChild(oTemporaryDomElement);
 
                 if (navigator.userAgent.match(/ipad|iphone/i)) {
-                    var oRange = document.createRange();
+                    const oRange = document.createRange();
                     oRange.selectNodeContents(oTemporaryDomElement);
                     window.getSelection().removeAllRanges();
                     window.getSelection().addRange(oRange);
@@ -198,7 +198,7 @@ sap.ui.define([
                     oTemporaryDomElement.select();
                 }
 
-                var bSuccessful = document.execCommand("copy");
+                const bSuccessful = document.execCommand("copy");
                 sMessageToastText = bSuccessful ? "CopyWasSuccessful" : "CopyWasNotSuccessful";
             } catch (oException) {
                 sMessageToastText = "CopyWasNotSuccessful";
@@ -219,31 +219,30 @@ sap.ui.define([
          * @private
          */
         this._createAndOpenErrorDialog = function (message, messageConfig) {
-            var vDetails = messageConfig.details;
-            var oDetailControl;
+            const vDetails = messageConfig.details;
+            let oDetailControl;
             if (vDetails) {
                 oDetailControl = new FormattedText({
                     htmlText: typeof vDetails === "object" ? vDetails.info : vDetails
                 });
             }
 
-            var oErrorDialog = this.errorWithDetails(message, oDetailControl, messageConfig);
+            const oErrorDialog = this.errorWithDetails(message, oDetailControl, messageConfig);
 
             // Check that SupportTicket is enabled and verify that we are not in a flow in which Support ticket creation is failing,
             // if this is the case we don't want to show the user the contact support button again
             if (Config.last("/core/extension/SupportTicket") && message !== resources.i18n.getText("supportTicketCreationFailed")) {
                 oErrorDialog.addButton(new Button({
                     text: resources.i18n.getText("contactSupportBtn"),
-                    press: function () {
-                        sap.ui.require(["sap/ushell/ui/footerbar/ContactSupportButton"],
-                            function (ContactSupportButton) {
-                                var oContactSupport = new ContactSupportButton();
-                                if (oContactSupport) {
-                                    oContactSupport.showContactSupportDialog();
-                                    // oContactSupport is redundant after creation of the Contact Support Dialog.
-                                    oContactSupport.destroy();
-                                }
-                            });
+                    press: () => {
+                        sap.ui.require(["sap/ushell/ui/footerbar/ContactSupportButton"], (ContactSupportButton) => {
+                            const oContactSupport = new ContactSupportButton();
+                            if (oContactSupport) {
+                                oContactSupport.showContactSupportDialog();
+                                // oContactSupport is redundant after creation of the Contact Support Dialog.
+                                oContactSupport.destroy();
+                            }
+                        });
 
                         oErrorDialog.close();
                     }
@@ -273,7 +272,7 @@ sap.ui.define([
          * @private
          */
         this.buildAndSendMessageToast = function (sMessage, iDuration) {
-            sap.ui.require(["sap/m/MessageToast"], function (MessageToast) {
+            sap.ui.require(["sap/m/MessageToast"], (MessageToast) => {
                 MessageToast.show(sMessage, { duration: iDuration });
             });
         };
@@ -291,7 +290,7 @@ sap.ui.define([
             if (typeof MessageBox[sType] === "function") {
                 MessageBox[sType](sMessage, oConfig);
             } else {
-                Log.error("Unknown Message type: " + sType, null, "MessageInternal Service");
+                Log.error(`Unknown Message type: ${sType}`, null, "MessageInternal Service");
             }
         };
 
@@ -371,7 +370,7 @@ sap.ui.define([
                 detailControl = null;
             }
 
-            var sTitle = typeof messageConfig === "string" ? messageConfig : messageConfig?.title;
+            let sTitle = typeof messageConfig === "string" ? messageConfig : messageConfig?.title;
 
             if (typeof detailControl === "string") {
                 buttons = sTitle;
@@ -379,7 +378,7 @@ sap.ui.define([
                 detailControl = null;
             }
 
-            var oText = new Text({
+            const oText = new Text({
                 text: message,
                 visible: !!message
             });
@@ -387,7 +386,7 @@ sap.ui.define([
             if (detailControl) {
                 oText.addStyleClass("sapUiSmallMarginBottom");
             }
-            var oErrorDialog = new Dialog({
+            const oErrorDialog = new Dialog({
                 state: ValueState.Error,
                 type: DialogType.Message,
                 contentWidth: "30rem",

package/src/main/js/sap/ushell/services/NavTargetResolution.js

@@ -5,16 +5,14 @@
  * @deprecated since 1.120. Use {@link sap.ushell.services.Navigation} for Navigation instead.
  */
 sap.ui.define([
-    "sap/ui/thirdparty/jquery",
     "sap/base/Log",
     "sap/ushell/Container",
     "sap/ushell/services/NavTargetResolutionInternal"
-], function (
-    jQuery,
+], (
     Log,
     Container
     /* NavTargetResolutionInternal - here to async preload the module */
-) {
+) => {
     "use strict";
 
     /**
@@ -276,7 +274,6 @@ sap.ui.define([
         this.isNavigationSupported = function (aIntents) {
             return this._oNavTargetResolutionInternal.isNavigationSupported(aIntents);
         };
-
     }
 
     // Note: we set it to true to allow platforms that did not yet switch to ClientSideTargetResolution to keep using the adapter.