@sapui5/sap.ushell 1.126.1 → 1.127.0

package/src/main/js/sap/ushell/ui/shell/ToolAreaItem.js

@@ -18,7 +18,7 @@ sap.ui.define([
      * A control to be placed in the tool area
      * @extends sap.ui.core.Control
      *
-     * @version 1.126.1
+     * @version 1.127.0
      *
      * @public
      * @since 1.30.5
@@ -26,7 +26,7 @@ sap.ui.define([
      * @alias sap.ushell.ui.shell.ToolAreaItem
      */
 
-    var ToolAreaItem = Control.extend("sap.ushell.ui.shell.ToolAreaItem", /** @lends sap.ushell.ui.shell.ShellHeadItem.prototype */ {
+    var ToolAreaItem = Control.extend("sap.ushell.ui.shell.ToolAreaItem", /** @lends sap.ushell.ui.shell.ToolAreaItem.prototype */ {
         metadata: {
             library: "sap.ushell",
             properties: {

package/src/main/js/sap/ushell/ui/utils.js

@@ -6,7 +6,7 @@
  * This is a utility module that collects common activities implemented
  * by controllers of different ui components.
  *
- * @version 1.126.1
+ * @version 1.127.0
  * @private
  */
 

package/src/main/js/sap/ushell/ui5service/ShellUIService.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The ShellUIService UI5 service
  *
- * @version 1.126.1
+ * @version 1.127.0
  */
 sap.ui.define([
     "sap/ui/core/service/ServiceFactoryRegistry",

package/src/main/js/sap/ushell/ui5service/UserStatus.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The UserStatus UI5 service
  *
- * @version 1.126.1
+ * @version 1.127.0
  */
 sap.ui.define([
     "sap/ui/core/service/ServiceFactoryRegistry",

package/src/main/js/sap/ushell/utils/UrlShortening.js

@@ -5,7 +5,7 @@
  *
  * This module is for internal Shell usage only
  *
- * @version 1.126.1
+ * @version 1.127.0
  */
  sap.ui.define(["sap/base/Log", "sap/ushell/utils/UrlParsing"], function (Log, urlParsing) {
     "use strict";

package/src/main/js/sap/ushell/utils/WindowUtils.js

@@ -187,9 +187,9 @@ sap.ui.define([
         var sLocationSearch = ushellUtils.getLocationSearch();
         var sNewLocationSearch = WindowUtils._getAdjustedQueryString(aUrlParams, aObsoleteUrlParams);
 
-        if (sNewLocationSearch) {
-            sNewHref = sNewHref.replace(sLocationSearch, "?" + sNewLocationSearch);
-        }
+        sNewLocationSearch = sNewLocationSearch !== "" ? "?" + sNewLocationSearch : "";
+        sNewHref = sNewHref.replace(sLocationSearch, sNewLocationSearch);
+
         if (ushellUtils.getLocationHref() === sNewHref) {
             ushellUtils.windowLocationReload();
         } else {

package/src/main/js/sap/ushell/utils/workpage/DestinationResolver.js

@@ -0,0 +1,89 @@
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
+
+sap.ui.define(["./WorkPageService", "sap/base/Log"], function (WorkPageService, Log) {
+    "use strict";
+
+    /**
+     * Utilities for resolving destination for given Providers.
+     * <p>
+     *
+     * @since 1.127.0
+     * @private
+    */
+    class DestinationResolver {
+
+        #workPageService;
+        #providers = new Map();
+
+        /**
+         * Instantiate DestinationResolver, fetch all the providers for the site and cache it
+         *
+         * @private
+         * @since 1.127.0
+         */
+        constructor () {
+            this.fetchData();
+        }
+
+        /**
+        * fetch all the providers for the site and cache it
+        * @returns {Promise<string>} Promise with the Destination mapping
+        * @private
+        * @since 1.127.0
+        */
+        async fetchData () {
+            if (!this._dataPromise) {
+                try {
+                    this._dataPromise = new Promise(async (resolve, reject) => {
+                        this.#workPageService = await new WorkPageService();
+                        try {
+                            const oDestinationResponse = await this.#workPageService.loadSiteAndDataDestinationMappings();
+                            const aDestinationMappings = oDestinationResponse?.data?.site?.providers?.nodes;
+                            if (aDestinationMappings && Object.keys(aDestinationMappings[0]).length) {
+                                aDestinationMappings.forEach((provider) => {
+                                    const aLogicalDestinationMaps = new Map();
+                                    provider.logicalDataDestinationMappings.forEach((oDataDestinationMapping) => {
+                                        aLogicalDestinationMaps.set(oDataDestinationMapping.logicalDestinationName, oDataDestinationMapping.resolvedUrl);
+                                    });
+                                    this.#providers.set(provider.id, aLogicalDestinationMaps);
+                                });
+                                return resolve(aDestinationMappings);
+                            }
+                            return reject("DestinationResolver: No Destinations found");
+                        } catch (oError) {
+                            return reject("DestinationResolver: No Destinations found");
+                        }
+                    });
+                } catch (oError) {
+                    throw new Error("Cards DestinationResolver failed -", oError);
+                }
+            }
+            return this._dataPromise;
+        }
+
+        /**
+        * Get the Resolved Destination for a given Destination name and card
+        * @param {string} sDestinationName The name of the destination to resolve
+        * @param {sap.ui.integration.widgets.Card} oCard The card instance.
+        * @returns {Promise<string>} Promise with the Resolved destination URL
+        * @private
+        * @since 1.127.0
+        */
+
+        async resolveCardDestination (sDestinationName, oCard) {
+            if (!sDestinationName || !oCard) {
+                throw new Error("Cards DestinationResolver failed - No Destination or Card name Found");
+            }
+            try {
+                await this.fetchData();
+                const sResolvedDestination = this.#providers.get(oCard.getReferenceId())?.get(sDestinationName);
+                return sResolvedDestination || `${location.origin}/dynamic_dest/${sDestinationName}`;
+            } catch (oError) {
+                Log.error(oError);
+                return Promise.resolve(`${location.origin}/dynamic_dest/${sDestinationName}`);
+            }
+        }
+    }
+    return DestinationResolver;
+}, /*export=*/ true);
+

package/src/main/js/sap/ushell/utils/workpage/WorkPageHost.js

@@ -2,7 +2,7 @@
 
 /**
  * @file WorkPageHost for WorkPageBuilder and DWSPageBuilder
- * @version 1.126.1
+ * @version 1.127.0
  */
 
 sap.ui.define([
@@ -10,13 +10,15 @@ sap.ui.define([
     "sap/ui/model/json/JSONModel",
     "sap/ushell/Container",
     "sap/ushell/EventHub",
-    "sap/ui/model/resource/ResourceModel"
+    "sap/ui/model/resource/ResourceModel",
+    "./DestinationResolver"
 ], function (
     Host,
     JSONModel,
     Container,
     EventHub,
-    ResourceModel
+    ResourceModel,
+    DestinationResolver
 ) {
     "use strict";
 
@@ -38,17 +40,19 @@ sap.ui.define([
         // private variables to store context information , filled lazy after by getContext, getContextValue was called, via _applyHostContext.
         oHost._oHostContext = null;
         oHost._oHostContextModel = null;
+        oHost._destinationResolver = new DestinationResolver();
 
         /**
-         * Resolves the destination for a given name
-         * @param {string} The name of the destination to resolve.
+         * Resolves the destination for a card for the given Destination name
+         * @param {string} sDestinationName The name of the destination to resolve.
+         * @param {sap.ui.integration.widgets.Card} oCard The card instance.
          * @returns {Promise<string>} Promise with the target destination
          */
-        oHost.setResolveDestination(function (sDestinationName) {
-            if (!sDestinationName) {
+        oHost.setResolveDestination(function (sDestinationName, oCard) {
+            if (!sDestinationName || !oCard) {
                 return Promise.reject();
             }
-            return Promise.resolve(location.origin + "/dynamic_dest/" + sDestinationName);
+            return oHost._destinationResolver.resolveCardDestination(sDestinationName, oCard);
         });
 
         /**
@@ -97,51 +101,51 @@ sap.ui.define([
         oHost._executeNavigation = function (oEvent) {
 
             var oParameters = oEvent.getParameter("parameters"),
-                    oCard = oEvent.getParameter("card");
+                oCard = oEvent.getParameter("card");
 
             if (oEvent.getParameter("type") !== "Navigation" ||
-                    this._bNavigationDisabled) {
-                    return Promise.resolve();
+                this._bNavigationDisabled) {
+                return Promise.resolve();
             }
             if (oParameters && oParameters.hasOwnProperty("url")) {
-                    EventHub.emit("UITracer.trace", {
-                            reason: "LaunchApp",
-                            source: "Card",
-                            data: {
-                                    cardId: oCard.getManifestEntry("/sap.app/id"),
-                                    providerId: oCard.getReferenceId(),
-                                    targetUrl: oParameters.url
-                            }
-                    });
-                    return Promise.resolve();
+                EventHub.emit("UITracer.trace", {
+                    reason: "LaunchApp",
+                    source: "Card",
+                    data: {
+                        cardId: oCard.getManifestEntry("/sap.app/id"),
+                        providerId: oCard.getReferenceId(),
+                        targetUrl: oParameters.url
+                    }
+                });
+                return Promise.resolve();
             }
             // Prevent event bubbling here, to avoid opening the same target twice
             oEvent.preventDefault(true);
 
 
             return this.oContainer.getServiceAsync("Navigation")
-                    .then(function (oNavigationService) {
-                            var oNavigationParameters = {};
-                            if (oParameters.hasOwnProperty("ibnTarget")) {
-                                    oNavigationParameters.target = oParameters.ibnTarget;
-                            }
-                            if (oParameters.hasOwnProperty("ibnParams")) {
-                                    oNavigationParameters.params = oParameters.ibnParams;
-                            }
-                            if (oParameters.hasOwnProperty("ibnAppSpecificRoute")) {
-                                    oNavigationParameters.appSpecificRoute = oParameters.ibnAppSpecificRoute;
-                            }
-                            EventHub.emit("UITracer.trace", {
-                                    reason: "LaunchApp",
-                                    source: "Card",
-                                    data: {
-                                            cardId: oCard.getManifestEntry("/sap.app/id"),
-                                            providerId: oCard.getReferenceId(),
-                                            targetUrl: "#" + oNavigationParameters.target.semanticObject + "-" + oNavigationParameters.target.action
-                                    }
-                            });
-                            return oNavigationService.navigate(oNavigationParameters);
+                .then(function (oNavigationService) {
+                    var oNavigationParameters = {};
+                    if (oParameters.hasOwnProperty("ibnTarget")) {
+                        oNavigationParameters.target = oParameters.ibnTarget;
+                    }
+                    if (oParameters.hasOwnProperty("ibnParams")) {
+                        oNavigationParameters.params = oParameters.ibnParams;
+                    }
+                    if (oParameters.hasOwnProperty("ibnAppSpecificRoute")) {
+                        oNavigationParameters.appSpecificRoute = oParameters.ibnAppSpecificRoute;
+                    }
+                    EventHub.emit("UITracer.trace", {
+                        reason: "LaunchApp",
+                        source: "Card",
+                        data: {
+                            cardId: oCard.getManifestEntry("/sap.app/id"),
+                            providerId: oCard.getReferenceId(),
+                            targetUrl: "#" + oNavigationParameters.target.semanticObject + "-" + oNavigationParameters.target.action
+                        }
                     });
+                    return oNavigationService.navigate(oNavigationParameters);
+                });
 
         };
         oHost.attachAction(oHost._executeNavigation.bind(oHost));
@@ -282,10 +286,10 @@ sap.ui.define([
                             .catch(function () {
                                 return oHost._applyHostContext(UserInfo);
                             });
-                })
-                .catch(function () {
-                    return {};
-                });
+                    })
+                    .catch(function () {
+                        return {};
+                    });
             }
             return Promise.resolve(oHost._oHostContext);
         };
@@ -294,7 +298,7 @@ sap.ui.define([
         oHost._getBundle = function () {
             return new ResourceModel({
                 bundleName: "sap.ushell.utils.workpage.resources.resources",
-                        async: true
+                async: true
             }).getResourceBundle();
         };
 

package/src/main/js/sap/ushell/utils/workpage/WorkPageService.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module communicates with the content API graphql service to retrieve workpage and visualization data.
- * @version 1.126.1
+ * @version 1.127.0
  */
 sap.ui.define([
     "sap/base/i18n/Localization",
@@ -83,6 +83,7 @@ sap.ui.define([
      * @property {object} descriptor The descriptor of the visualization
      * @property {object} descriptorResources The descriptor resources of the visualization
      * @property {SiteData} [_siteData] The additional app properties retrieved from the CDM Runtime Site
+     * @property {string} providerId The content provider id of the visualization
     */
 
     /**
@@ -164,6 +165,9 @@ sap.ui.define([
                                 baseUrl,
                                 descriptorPath
                             },
+                            provider{
+                                id
+                            },
                             indicatorDataSource{
                                 url,
                                 refreshInterval
@@ -174,6 +178,28 @@ sap.ui.define([
             }`.replace(/\s\s+/g, "").replace(/\n/gm, ""); // trim spaces and new line
     };
 
+    /**
+     * Load the Site and Data Destination Mappings for the given site id.
+     * @returns {string} A GraphQL Query as a string
+     */
+    WorkPage.prototype.loadSiteAndDataDestinationMappings = function () {
+        const sQuery = `{
+            site(siteId:"${this._sSiteId}") {
+              providers {
+                nodes {
+                  id,
+                  logicalDataDestinationMappings {
+                    logicalDestinationName,
+                    resolvedUrl
+                  }
+                }
+              }
+            }
+           }`.replace(/\s\s+/g, "").replace(/\n/gm, ""); // trim spaces and new line
+
+        return this._doRequest(sQuery);
+    };
+
     /**
      * Helper function to parse the data from the service
      *
@@ -223,6 +249,11 @@ sap.ui.define([
                     indicatorDataSource {
                         url,
                         refreshInterval
+                    },
+                    targetAppIntent {
+                        semanticObject,
+                        action,
+                        businessAppId
                     }
                 }
             }

package/src/main/js/sap/ushell/utils/workpage/WorkPageVizInstantiation.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module provides utilities for creating visualization instances for work pages.
- * @version 1.126.1
+ * @version 1.127.0
  */
 sap.ui.define([
     "sap/ushell/services/VisualizationInstantiation",

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

@@ -6,6 +6,7 @@
  */
 sap.ui.define([
     "sap/base/Log",
+    "sap/base/util/isPlainObject",
     "sap/base/util/ObjectPath",
     "sap/base/util/uid",
     "sap/ui/Device",
@@ -21,6 +22,7 @@ sap.ui.define([
     //"sap/ushell/resources" --> cannot be declared here currently: utils is used very early - before core boot, but resources uses UI5 core.
 ], function (
     Log,
+    isPlainObject,
     ObjectPath,
     uid,
     Device,
@@ -50,6 +52,28 @@ sap.ui.define([
     utils.updateProperties = ushellObjectOperations.updateProperties;
     utils.getNestedObjectProperty = ushellObjectOperations.getNestedObjectProperty;
 
+    /**
+     * Freezes the object and all its properties recursively.
+     * @param {object} oObject The object to freeze.
+     * @returns {object} The frozen object.
+     * @throws {Error} If the object has cyclic references.
+     *
+     * @since 1.127.0
+     * @private
+     */
+    utils.deepFreeze = function (oObject) {
+        Object.keys(oObject)
+            .filter((sProperty) => {
+                const vNestedValue = oObject[sProperty];
+                return isPlainObject(vNestedValue) || Array.isArray(vNestedValue);
+            })
+            .forEach((sProperty) => {
+                oObject[sProperty] = this.deepFreeze(oObject[sProperty]);
+            });
+
+        return Object.freeze(oObject);
+    };
+
     /**
      * Removes duplicated items from the actions array.
      *
@@ -109,7 +133,7 @@ sap.ui.define([
     utils.getLocalSystemInSidFormat = function () {
         const oContainer = sap.ui.require("sap/ushell/Container");
         var oSystem = oContainer.getLogonSystem();
-        var sSystemName = oSystem.getName();
+        var sSystemName = oSystem.getSystemName();
         var sSystemClient = oSystem.getClient();
 
         return "sid(" + sSystemName + "." + sSystemClient + ")";
@@ -308,7 +332,7 @@ sap.ui.define([
 
     /**
      * No redirect happens for a demo platform logout, but a reload is made to ensure the progress indicator is gone.
-     * Used e.g. in ContainerAdapter as part of the local platform.
+     * Used e.g. in ContainerAdapter as part of the local platform and in the cdm ContainerAdapter.
      *
      * @private
      * @since 1.34.0

package/src/test/js/sap/ushell/bootstrap/sandbox.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's bootstrap code for development sandbox scenarios.
  *
- * @version 1.126.1
+ * @version 1.127.0
  */
 
 (function () {

package/src/main/js/sap/ushell/bootstrap/common/common.load.ui5theme.js

@@ -1,67 +0,0 @@
-// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
-sap.ui.define([
-    "sap/base/i18n/Localization",
-    "sap/ushell/bootstrap/common/common.boot.path",
-    "sap/base/Log",
-    "sap/ui/core/Core",
-    "sap/ui/dom/includeStylesheet"
-], function (Localization, bootPath, Log, Core, includeStylesheet) {
-    "use strict";
-
-    function applyBootTheme (oBootTheme) {
-        if (!oBootTheme || !oBootTheme.theme) {
-            Log.error("No boot theme could be applied", null,
-                "common.load.ui5theme"
-            );
-            return;
-        }
-
-        var oSAPUIConfig = window["sap-ui-config"] || {},
-            sAdjustedThemeRoot = adjustThemeRoot(oBootTheme.root),
-            sThemeName = oBootTheme.theme,
-            bHaveDifferentBootTheme = oSAPUIConfig.theme !== sThemeName;
-
-        includePreloadStylesheet(sThemeName, sAdjustedThemeRoot || (bootPath + "/"));
-
-        if (sAdjustedThemeRoot || bHaveDifferentBootTheme) {
-            var aApplyThemeArgs = [sThemeName, sAdjustedThemeRoot]
-                .filter(function (s) { return s; });
-
-            Core.applyTheme.apply(Core, aApplyThemeArgs);
-        }
-
-        Log.debug("Boot theme applied: theme = '" + oBootTheme.theme +
-            "' theme root = '" + oBootTheme.root + "'", null,
-            "common.load.ui5theme"
-        );
-    }
-
-    function adjustThemeRoot (sThemeRoot) {
-        if (sThemeRoot) {
-            return sThemeRoot + "/UI5/";
-        }
-
-        return undefined;
-    }
-
-    function includePreloadStylesheet (sTheme, sThemeBaseUrl) {
-        var sLanguage = Localization.getLanguage(),
-            sThemePrefix = sThemeBaseUrl + "sap/fiori/themes/" + sTheme,
-            bIsRtl = isRtlLanguage(sLanguage),
-            sFileName = bIsRtl ? "library-RTL.css" : "library.css";
-
-        includeStylesheet(sThemePrefix + "/" + sFileName, "sap-ui-theme-sap.fiori");
-    }
-
-    function isRtlLanguage (sLanguage) {
-        // a list of RTL locales ('iw' is an old code for 'he')
-        var A_RTL_LOCALES = ["ar", "fa", "he", "iw"];
-
-        // remove the region part of the locale if it exists
-        sLanguage = sLanguage.toLowerCase().substring(0, 2);
-
-        return A_RTL_LOCALES.indexOf(sLanguage) >= 0;
-    }
-
-    return applyBootTheme;
-});