@sapui5/sap.ushell 1.124.1 → 1.125.0

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

@@ -0,0 +1,448 @@
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
+
+/**
+ * @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.125.0
+ */
+sap.ui.define([
+    "sap/base/Log",
+    "sap/m/MessageBox",
+    "sap/ushell/Config",
+    "sap/ushell/resources",
+    "sap/m/Dialog",
+    "sap/m/Text",
+    "sap/m/Link",
+    "sap/m/Button",
+    "sap/m/VBox",
+    "sap/m/FormattedText",
+    "sap/m/library",
+    "sap/ui/core/library"
+], function (
+    Log,
+    MessageBox,
+    Config,
+    resources,
+    Dialog,
+    Text,
+    Link,
+    Button,
+    VBox,
+    FormattedText,
+    mobileLibrary,
+    coreLibrary
+) {
+    "use strict";
+
+    // shortcut for sap.m.ButtonType
+    var ButtonType = mobileLibrary.ButtonType;
+
+    // shortcut for sap.m.DialogType
+    var DialogType = mobileLibrary.DialogType;
+
+    // shortcut for sap.ui.core.ValueState
+    var ValueState = coreLibrary.ValueState;
+
+    // shortcut for sap.m.FlexRendertype
+    var FlexRendertype = mobileLibrary.FlexRendertype;
+
+    /**
+     * @alias sap.ushell.services.MessageInternal
+     * @class
+     * @classdesc MessageInternal service.
+     *
+     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
+     * <pre>
+     *   sap.ui.require(["sap/ushell/Container"], async function (Container) {
+     *     const MessageInternal = await Container.getServiceAsync("MessageInternal");
+     *     // do something with the MessageInternal service
+     *   });
+     * </pre>
+     *
+     * @augments sap.ushell.services.Service
+     * @hideconstructor
+     *
+     * @since 1.124.0
+     * @private
+     */
+    function MessageInternal () {
+        var fnShellCallBackFunction;
+
+        /**
+         * Initialization:
+         * This method is to be invoked by the Shell to register the message callback function.
+         * The signature of the callback is defined via the show function.
+         *
+         * @param {function} fnShellCallback callback for the shell to execute showing the message
+         * @returns {this} <code>this</code> for method chaining
+         *
+         * @private
+         */
+        this.init = function (fnShellCallback) {
+            fnShellCallBackFunction = fnShellCallback;
+
+            return this;
+        };
+
+        /**
+         * Shows a message on the screen.
+         *
+         * @param {sap.ushell.services.MessageInternal.Type} iType message type
+         * @param {string} sMessage the localized message as plain text
+         * @param {object} oParameters Some parameters
+         *
+         * @private
+         */
+        this.show = function (iType, sMessage, oParameters) {
+            if (!sMessage) {
+                Log.error("Message must not be empty.");
+                return;
+            }
+
+            if (fnShellCallBackFunction && typeof fnShellCallBackFunction === "function") {
+                fnShellCallBackFunction(iType, sMessage, oParameters || {});
+            } else {
+                this.buildMessage(iType, sMessage, oParameters || {});
+            }
+        };
+
+        /**
+         * Decides wether a MessageBox or a SupportMessage needs to be send and accordingly builds a configuration for it.
+         *
+         * @param {int} iType message type
+         * @param {string} sMessage message text
+         * @param {object} oParameters message parameters
+         *
+         * @private
+         */
+        this.buildMessage = function (iType, sMessage, oParameters) {
+            var oMessageBoxConfig = {
+                title: oParameters.title,
+                actions: oParameters.actions,
+                details: oParameters.details,
+                onClose: oParameters.callback,
+                emphasizedAction: oParameters.emphasizedAction
+            };
+            var sMessageBoxType;
+
+            switch (iType) {
+                case MessageInternal.Type.ERROR:
+                    this._createAndOpenErrorDialog(sMessage, oMessageBoxConfig);
+                    return;
+                case MessageInternal.Type.CONFIRM:
+                    if (!oParameters.actions) {
+                        sMessageBoxType = "confirm";
+                    } else if (oParameters.actions.indexOf("DELETE") > -1) {
+                        sMessageBoxType = "warning";
+                        oMessageBoxConfig.emphasizedAction = MessageBox.Action.DELETE;
+                    } else {
+                        oMessageBoxConfig.icon = MessageBox.Icon.QUESTION;
+                        sMessageBoxType = "show";
+                    }
+                    break;
+                case MessageInternal.Type.INFO:
+                    sMessageBoxType = "info";
+                    this.buildAndSendMessageToast(sMessage, oParameters.duration || 3000);
+                    // Show only Toast. Don't need to show the MessageBox.
+                    return;
+                default:
+                    oMessageBoxConfig = { duration: oParameters.duration || 3000 };
+                    sMessageBoxType = "show";
+                    break;
+            }
+
+            this.sendMessageBox(sMessage, sMessageBoxType, oMessageBoxConfig); // Give me some parameters please!
+        };
+
+        /**
+         * Copies the content of the dialog to the clipboard.
+         *
+         * @param {string} message The message displayed by the dialog.
+         * @param {object} config The configuration of the dialog.
+         * @param {string} dialogTitle The title of the dialog.
+         *
+         * @private
+         */
+        this._copyToClipboard = function (message, config, dialogTitle) {
+            var 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 || "-")
+            ];
+
+            var oElementWithPrevFocus = document.activeElement;
+            var oTemporaryDomElement = document.createElement("textarea");
+            var sMessageToastText;
+
+            try {
+                oTemporaryDomElement.contentEditable = true;
+                oTemporaryDomElement.readonly = false;
+                oTemporaryDomElement.innerText = aCopiedText.join("\n");
+                document.documentElement.appendChild(oTemporaryDomElement);
+
+                if (navigator.userAgent.match(/ipad|iphone/i)) {
+                    var oRange = document.createRange();
+                    oRange.selectNodeContents(oTemporaryDomElement);
+                    window.getSelection().removeAllRanges();
+                    window.getSelection().addRange(oRange);
+                    oTemporaryDomElement.setSelectionRange(0, 999999);
+                } else {
+                    oTemporaryDomElement.select();
+                }
+
+                var bSuccessful = document.execCommand("copy");
+                sMessageToastText = bSuccessful ? "CopyWasSuccessful" : "CopyWasNotSuccessful";
+            } catch (oException) {
+                sMessageToastText = "CopyWasNotSuccessful";
+            } finally {
+                this.buildAndSendMessageToast(resources.i18n.getText(sMessageToastText));
+                document.documentElement.removeChild(oTemporaryDomElement);
+                window.getSelection().removeAllRanges();
+                oElementWithPrevFocus.focus();
+            }
+        };
+
+        /**
+         * Creates a Dialog from a given error message.
+         *
+         * @param {string} message message text
+         * @param {object} messageConfig message configuration (title and details)
+         *
+         * @private
+         */
+        this._createAndOpenErrorDialog = function (message, messageConfig) {
+            var vDetails = messageConfig.details;
+            var oDetailControl;
+            if (vDetails) {
+                oDetailControl = new FormattedText({
+                    htmlText: typeof vDetails === "object" ? vDetails.info : vDetails
+                });
+            }
+
+            var oErrorDialog = this.errorWithDetails(message, oDetailControl, messageConfig.title);
+
+            // 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
+            // Note: Renderer.qunit.js deletes sap.ushell.container before this code is called.
+            // check if container is available
+            if (sap.ushell.Container
+                && Config.last("/core/extension/SupportTicket")
+                && message !== resources.i18n.getText("supportTicketCreationFailed")) {
+                oErrorDialog.addButton(new Button({
+                    text: resources.i18n.getText("contactSupportBtn"),
+                    tooltip: resources.i18n.getText("contactSupportBtn_tooltip"),
+                    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();
+                                }
+                            });
+
+                        oErrorDialog.close();
+                    }
+                }));
+            }
+
+            if (document.queryCommandSupported("copy")) {
+                oErrorDialog.addButton(new Button({
+                    text: resources.i18n.getText("CopyToClipboardBtn"),
+                    tooltip: resources.i18n.getText("CopyToClipboardBtn_tooltip"),
+                    press: this._copyToClipboard.bind(this, message, messageConfig, oErrorDialog.getTitle())
+                }));
+            }
+
+            oErrorDialog.addButton(new Button({
+                text: resources.i18n.getText("closeBtn"),
+                type: ButtonType.Emphasized,
+                press: oErrorDialog.close.bind(oErrorDialog)
+            }));
+        };
+
+        /**
+         * Sends a MessageToast with provided Message and Duration
+         *
+         * @param {string} sMessage The message
+         * @param {int} iDuration The duration of the MessageToast in ms
+         *
+         * @private
+         */
+        this.buildAndSendMessageToast = function (sMessage, iDuration) {
+            sap.ui.require(["sap/m/MessageToast"], function (MessageToast) {
+                MessageToast.show(sMessage, { duration: iDuration });
+            });
+        };
+
+        /**
+         * Sends a MessageBox based on the provided configuration
+         *
+         * @param {string} sMessage The actual error message
+         * @param {string} sType The type of the MessageBox. e.g.: show, confirm
+         * @param {object} oConfig The configuration of the MessageBox
+         *
+         * @private
+         */
+        this.sendMessageBox = function (sMessage, sType, oConfig) {
+            if (typeof MessageBox[sType] === "function") {
+                MessageBox[sType](sMessage, oConfig);
+            } else {
+                Log.error("Unknown Message type: " + sType, null, "MessageInternal Service");
+            }
+        };
+
+        /**
+         * Shows a MessageToast on the screen.
+         *
+         * @param {string} sMessage the localized message as plain text
+         * @param {int} [iDuration=3000] display duration in ms
+         *
+         * @private
+         */
+        this.info = function (sMessage, iDuration) {
+            this.show(MessageInternal.Type.INFO, sMessage, { duration: iDuration || 3000 });
+        };
+
+        /**
+         * Shows an error message on the screen.
+         *
+         * @param {string} sMessage the localized message as plain text
+         * @param {string} [sTitle] the localized title as plain text
+         *
+         * @private
+         */
+        this.error = function (sMessage, sTitle) {
+            Log.error(sMessage);
+
+            this.show(MessageInternal.Type.ERROR, sMessage, { title: sTitle });
+        };
+
+        /**
+         * Shows an confirmation dialog on the screen.
+         *
+         * The callback is called with the following signature:
+         * <code>function(Action)</code> where Action is the action type that the user has tapped.
+         * For example, when the user has pressed the close button, a sap.m.MessageBox.Action.Close is returned.
+         *
+         * If no actions are provided, "OK" and "Cancel" will be shown. In this case Action is set by one of the following three values:
+         *   1. sap.m.MessageBox.Action.OK: "OK" (confirmed) button is tapped.
+         *   2. sap.m.MessageBox.Action.Cancel: "Cancel" (unconfirmed) button is tapped.
+         *   3. null: Confirm dialog is closed by calling sap.m.InstanceManager.closeAllDialogs()
+         *
+         * @param {string} sMessage the localized message as plain text
+         * @param {function(): string} fnCallback callback function
+         * @param {string} [sTitle] the localized title as plain text
+         * @param {sap.m.MessageBox.Action|sap.m.MessageBox.Action[]|string|string[]} [vActions]
+         *   Either a single action, or an array of two actions.
+         *   If no action(s) are given, the single action MessageBox.Action.OK is taken as a default for the parameter.
+         *   If more than two actions are given, only the first two actions are taken.
+         *   Custom action string(s) can be provided, and then the translation of custom action string(s)
+         *   needs to be done by the application.
+         *
+         * @private
+         */
+        this.confirm = function (sMessage, fnCallback, sTitle, vActions) {
+            this.show(MessageInternal.Type.CONFIRM, sMessage, { title: sTitle, callback: fnCallback, actions: vActions });
+        };
+
+        /**
+         * Shows an error message with details on the screen.
+         * If more than one control should be shown, an {sap.m.VBox} can be used.
+         * The default title is "error".
+         * If no custom buttons are given, an emphasized "close" button is shown.
+         *
+         * @param {string} message The localized message as plain text
+         * @param {sap.ui.core.Control} [detailControl] The control that should be displayed,
+         * once a user presses the "View Details" link
+         * @param {string} [title] The localized title as plain text
+         * @param {sap.m.Button[]} [buttons] The custom buttons that should be shown on the dialog
+         *
+         * @returns {sap.m.Dialog} The error dialog, so it can be destroyed by a custom button
+         *
+         * @private
+         */
+        this.errorWithDetails = function (message, detailControl, title, buttons) {
+            if (Array.isArray(detailControl)) {
+                buttons = detailControl;
+                detailControl = null;
+            }
+
+            if (typeof detailControl === "string") {
+                buttons = title;
+                title = detailControl;
+                detailControl = null;
+            }
+
+            var oText = new Text({
+                text: message,
+                visible: !!message
+            });
+
+            if (detailControl) {
+                oText.addStyleClass("sapUiSmallMarginBottom");
+            }
+            var oErrorDialog = new Dialog({
+                state: ValueState.Error,
+                type: DialogType.Message,
+                contentWidth: "30rem",
+                title: title || resources.i18n.getText("error"),
+                content: [
+                    new VBox({
+                        renderType: FlexRendertype.Bare,
+                        items: [
+                            oText,
+                            new Link({
+                                text: resources.i18n.getText("ViewDetails"),
+                                visible: !!detailControl,
+                                press: function () {
+                                    oErrorDialog.getContent()[0].addItem(detailControl);
+                                    this.destroy();
+                                }
+                            })
+                        ]
+                    })
+                ],
+                buttons: buttons,
+                endButton: new Button({
+                    text: resources.i18n.getText("closeBtn"),
+                    type: ButtonType.Emphasized,
+                    press: function () {
+                        oErrorDialog.close();
+                    }
+                }),
+                afterClose: function () {
+                    this.destroy();
+                }
+            }).addStyleClass("sapContrastPlus");
+            oErrorDialog.open();
+
+            return oErrorDialog;
+        };
+
+        // Expose Type Enum also via MessageInternal Service Instance, so that a user does not have to require the ushell lib.
+        this.Type = MessageInternal.Type;
+    }
+
+    /**
+     * @alias sap.ushell.services.MessageInternal.Type
+     * @private
+     */
+    MessageInternal.Type = {
+        INFO: 0,
+        ERROR: 1,
+        CONFIRM: 2
+    };
+
+    MessageInternal.hasNoAdapter = true;
+    return MessageInternal;
+});

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

@@ -2,6 +2,7 @@
 
 /**
  * @fileOverview The NavTargetResolution service.
+ * @deprecated since 1.120. Use {@link sap.ushell.services.Navigation} for Navigation instead.
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",
@@ -46,7 +47,7 @@ sap.ui.define([
      *
      * @since 1.15.0
      * @public
-     * @deprecated since 1.120
+     * @deprecated since 1.120. Use {@link sap.ushell.services.Navigation} for Navigation instead.
      */
     function NavTargetResolution (oAdapter, oContainerInterface, sParameters, oServiceConfiguration) {
         Log.error("NavTargetResolution service has been called, which is deprecated. Remove all dependencies!", null, "sap.ushell.services.NavTargetResolution");

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

@@ -420,7 +420,7 @@ sap.ui.define([
                             if (sSapUshellEncTestValue !== "A%20B%2520C") {
                                 oErrorDeferred = new jQuery.Deferred();
 
-                                Container.getServiceAsync("Message")
+                                Container.getServiceAsync("MessageInternal")
                                     .then(function (MessageService) {
                                         MessageService.error("This navigation is flagged as erroneous because" +
                                             " (likely the calling procedure) generated a wrong encoded hash." +

package/src/main/js/sap/ushell/services/Navigation/compatibility.js

@@ -4,7 +4,7 @@
  * compatible with the CrossApplicationNavigation service.
  * This shall only be used for the AppRuntime to enable 1.x inner shell running in 2.x host.
  *
- * @version 1.124.1
+ * @version 1.125.0
  */
 
 sap.ui.define([

package/src/main/js/sap/ushell/services/Navigation/utils.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview Navigation utility functions
  *
- * @version 1.124.1
+ * @version 1.125.0
  */
 
 

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

@@ -5,7 +5,7 @@
  * This file exposes an API to perform (invoke) Navigation for applications.
  * It exposes interfaces to perform a hash change and trigger a navigation.
  *
- * @version 1.124.1
+ * @version 1.125.0
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -8,7 +8,7 @@
  *
  * Configured with the ClientSideTargetResolutionAdapter.
  *
- * @version 1.124.1
+ * @version 1.125.0
  */
 sap.ui.define([
     "sap/ushell/resources"

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

@@ -5,9 +5,11 @@
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",
+    "sap/ushell/Container",
     "sap/ushell/services/NotificationsV2" // preload NotificationsV2 early
 ], function (
-    jQuery
+    jQuery,
+    Container
 ) {
     "use strict";
 
@@ -59,7 +61,7 @@ sap.ui.define([
         // Get the reference to the NotificationsV2 service promise
         this._getNotificationsV2 = function () {
             if (!this.oNotificationsV2Promise) {
-                this.oNotificationsV2Promise = sap.ushell.Container.getServiceAsync("NotificationsV2");
+                this.oNotificationsV2Promise = Container.getServiceAsync("NotificationsV2");
                 this.oNotificationsV2Promise.then(function (oService) {
                     this._oNotificationsV2Service = oService; // Save ref to the service for static calls, beware race conditions
                 }.bind(this));

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

@@ -8,7 +8,8 @@ sap.ui.define([
     "sap/ui/core/ws/SapPcpWebSocket",
     "sap/ui/model/json/JSONModel",
     "sap/ui/thirdparty/datajs",
-    "sap/ushell/utils"
+    "sap/ushell/utils",
+    "sap/ushell/Container"
 ], function (
     Log,
     Localization,
@@ -17,7 +18,8 @@ sap.ui.define([
     SapPcpWebSocket,
     JSONModel,
     OData,
-    ushellUtils
+    ushellUtils,
+    Container
 ) {
     "use strict";
 
@@ -1408,11 +1410,11 @@ sap.ui.define([
         // *************************************************************************************************
 
         this._updateNotificationsConsumers = function () {
-            aUpdateNotificationsCallbacks.forEach(callback => callback());
+            aUpdateNotificationsCallbacks.forEach((callback) => callback());
         };
 
         this._updateNotificationsCountConsumers = function () {
-            aUpdateNotificationsCountCallbacks.forEach(callback => callback());
+            aUpdateNotificationsCountCallbacks.forEach((callback) => callback());
         };
 
         this._updateAllConsumers = function () {
@@ -1969,7 +1971,7 @@ sap.ui.define([
 
         this._getUserSettingsPersonalizer = function () {
             if (!this.oUserSettingsPersonalizerPromise) {
-                this.oUserSettingsPersonalizerPromise = sap.ushell.Container.getServiceAsync("PersonalizationV2")
+                this.oUserSettingsPersonalizerPromise = Container.getServiceAsync("PersonalizationV2")
                     .then((PersonalizationService) => {
                         const oScope = {
                             keyCategory: PersonalizationService.KeyCategory.FIXED_KEY,

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's page building service.
  *
- * @version 1.124.1
+ * @version 1.125.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery"

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

@@ -6,7 +6,7 @@
  * It provides the layout and tile data of pages in the pages runtime.
  * Only used on the ABAP platform and on local for testing.
  *
- * @version 1.124.1
+ * @version 1.125.0
  */
 sap.ui.define([], function () {
     "use strict";

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module deals with page related referencing and dereferencing.
- * @version 1.124.1
+ * @version 1.125.0
  */
 sap.ui.define([
     "sap/ushell/services/_PageReferencing/PageReferencer"

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module exposes a model containing the pages hierarchy to its clients.
- * @version 1.124.1
+ * @version 1.125.0
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's personalization service, which provides generic read and write access to the currently logged on user's
  * personalization settings for the app currently executed in the shell.
  *
- * @version 1.124.1
+ * @version 1.125.0
  * @deprecated since 1.120 Please use {@link sap.ushell.services.PersonalizationV2} instead
  */
 sap.ui.define([

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's personalization service, which provides generic read and write access to the currently logged on user's
  * personalization settings for the app currently executed in the shell.
  *
- * @version 1.124.1
+ * @version 1.125.0
  */
 sap.ui.define([
     "sap/base/Log",