@sapui5/sap.ushell 1.127.2 → 1.128.1

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

@@ -14,13 +14,30 @@
  */
 sap.ui.define([
     "sap/ui/thirdparty/URI",
-    "sap/base/Log"
+    "sap/base/Log",
+    "sap/base/util/deepEqual",
+    "sap/base/util/merge",
+    "sap/ushell/TechnicalParameters"
 ], function (
     URI,
-    Log
+    Log,
+    deepEqual,
+    merge,
+    TechnicalParameters
 ) {
     "use strict";
 
+    /**
+     * @typedef {object} sap.ushell.utils.URLParsing.HashComparison
+     * Type for HashComparison
+     * @property {boolean} sameIntent The intent is the semantic object, action and contextRaw of the hash
+     * @property {boolean} sameParameters The intent parameters are the parameters of the hash that are not technical parameters
+     * @property {boolean} sameAppSpecificRoute The app specific route is the part of the hash after the shell part
+     *
+     * @since 1.128.0
+     * @private
+     */
+
     /**
      * @alias sap.ushell.utils.UrlParsing
      * @namespace
@@ -548,5 +565,108 @@ sap.ui.define([
         return appendIf(shellPart, oShellHash.appSpecificRoute);
     };
 
+    /**
+     * Calculates the similarities of the hashes
+     *
+     * @param {sap.ushell.services.Navigation.TargetIntent} sHash1 The first hash
+     * @param {sap.ushell.services.Navigation.TargetIntent} sHash2 The second hash
+     * @returns {sap.ushell.utils.URLParsing.HashComparison} A object describing the similarities
+     *
+     * @since 1.128.0
+     * @private
+     */
+    UrlParsing.compareHashes = function (sHash1, sHash2) {
+        var oNewHash = this.parseShellHash(sHash1) || {};
+        var oOldHash = this.parseShellHash(sHash2) || {};
+        return {
+            sameIntent: this.haveSameIntent(oNewHash, oOldHash),
+            sameParameters: this.haveSameIntentParameters(oNewHash, oOldHash),
+            sameAppSpecificRoute: oNewHash.appSpecificRoute === oOldHash.appSpecificRoute
+        };
+    };
+
+    /**
+     * Determines whether two hash fragments have the same intent during an
+     * app-to-app navigation.
+     *
+     * @param {sap.ushell.services.URLParsing.DecomposedHash} oHash1 The first hash split by parseShellHash
+     * @param {sap.ushell.services.URLParsing.DecomposedHash} oHash2 The second hash split by parseShellHash
+     *
+     * @returns {boolean}
+     *   Whether two hash fragments have the same semantic object and action
+     *   during an app-to-app navigation.
+     *
+     * @since 1.128.0
+     * @private
+     */
+    UrlParsing.haveSameIntent = function (oHash1, oHash2) {
+        oHash1 = oHash1 || {};
+        oHash2 = oHash2 || {};
+        return oHash1.semanticObject === oHash2.semanticObject &&
+            oHash1.action === oHash2.action &&
+            oHash1.contextRaw === oHash2.contextRaw;
+    };
+
+    /**
+     * Determines whether two sets of parameters have the same intent parameters.
+     *
+     * @param {sap.ushell.services.URLParsing.DecomposedHash} oHash1 The first hash split by parseShellHash
+     * @param {sap.ushell.services.URLParsing.DecomposedHash} oHash2 The second hash split by parseShellHash
+     * @returns {boolean} Whether the two given set of parameters have the same intent parameters.
+     *
+     * @since 1.128.0
+     * @private
+     */
+    UrlParsing.haveSameIntentParameters = function (oHash1, oHash2) {
+        oHash1 = oHash1 || {};
+        oHash2 = oHash2 || {};
+        var oParams1Copy = merge({}, oHash1.params);
+        var oParams2Copy = merge({}, oHash2.params);
+        return !this._parametersChanged(
+            this._removeNonIntentParameters(oParams1Copy),
+            this._removeNonIntentParameters(oParams2Copy)
+        );
+    };
+
+    /**
+     * Removes all technical parameters from the hash parameters that are not intent parameters
+     * and returns the new hash parameters
+     *
+     * @param {Object<string, string[]>} oHashParams the hash parameters that should be checked for non-intent parameters
+     * @returns {Object<string, string[]>} the given hash parameters with the non-intent parameters
+     *
+     * @since 1.128.0
+     * @private
+     */
+    UrlParsing._removeNonIntentParameters = function (oHashParams) {
+        var aTechnicalParameters = TechnicalParameters.getParameters({ isIntentParameter: false });
+        var oTechnicalParam;
+
+        if (oHashParams) {
+            for (var i = 0; i < aTechnicalParameters.length; i++) {
+                oTechnicalParam = aTechnicalParameters[i];
+                if (oHashParams[oTechnicalParam.name]) {
+                    delete oHashParams[oTechnicalParam.name];
+                }
+            }
+        }
+
+        return oHashParams || {};
+    };
+
+    /**
+     * Checks whether shell hash parameters have changed
+     *
+     * @param {Object<string, string[]>} oNewParameters the new parameters
+     * @param {Object<string, string[]>} oOldParameters the old parameters
+     * @returns {boolean} <code>true</code> if oNewParameters are not equal to oOldParameters
+     *
+     * @since 1.128.0
+     * @private
+     */
+    UrlParsing._parametersChanged = function (oNewParameters, oOldParameters) {
+        return !deepEqual(oNewParameters, oOldParameters);
+    };
+
     return UrlParsing;
 });

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

@@ -5,7 +5,7 @@
  *
  * This module is for internal Shell usage only
  *
- * @version 1.127.2
+ * @version 1.128.1
  */
  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);
 
-        sNewLocationSearch = sNewLocationSearch !== "" ? "?" + sNewLocationSearch : "";
-        sNewHref = sNewHref.replace(sLocationSearch, sNewLocationSearch);
-
+        if (sNewLocationSearch) {
+            sNewHref = sNewHref.replace(sLocationSearch, "?" + sNewLocationSearch);
+        }
         if (ushellUtils.getLocationHref() === sNewHref) {
             ushellUtils.windowLocationReload();
         } else {

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

@@ -2,7 +2,7 @@
 
 /**
  * @file WorkPageHost for WorkPageBuilder and DWSPageBuilder
- * @version 1.127.2
+ * @version 1.128.1
  */
 
 sap.ui.define([

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.127.2
+ * @version 1.128.1
  */
 sap.ui.define([
     "sap/base/i18n/Localization",
@@ -14,7 +14,8 @@ sap.ui.define([
     "sap/base/util/deepExtend",
     "sap/ushell/adapters/cdm/v3/utilsCdm",
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readUtils",
-    "sap/ushell/adapters/cdm/v3/_LaunchPage/readVisualizations"
+    "sap/ushell/adapters/cdm/v3/_LaunchPage/readVisualizations",
+    "sap/ushell/utils"
 ], function (
     Localization,
     HttpClient,
@@ -25,7 +26,8 @@ sap.ui.define([
     deepExtend,
     utilsCdm,
     readUtils,
-    readVisualizations
+    readVisualizations,
+    ushellUtils
 ) {
     "use strict";
 
@@ -91,16 +93,17 @@ sap.ui.define([
      * Additionally, load the visualizations used on that WorkPage.
      *
      * @param {string} sPageId The WorkPage id.
+     * @param {boolean} bFilterByDevice Filter visualizations by device type.
      * @returns {Promise<{ workPage: {usedVisualizations: { nodes: ExtendedVisualization[] }, editable: boolean}}>}
      *  A promise resolving with the loaded work page and visualizations, enhanced with app data retrieved from the CDM Runtime Site.
      */
-    WorkPage.prototype.loadWorkPageAndVisualizations = async function (sPageId) {
+    WorkPage.prototype.loadWorkPageAndVisualizations = async function (sPageId, bFilterByDevice) {
         let pageInfo;
         let workPage;
 
         do {
             const bUseIntentNavigation = Config.last("/core/shell/intentNavigation");
-            const sWorkPageQuery = this._createWorkPageQuery(this._sSiteId, sPageId, workPage === undefined, pageInfo?.endCursor, bUseIntentNavigation);
+            const sWorkPageQuery = this._createWorkPageQuery(this._sSiteId, sPageId, workPage === undefined, pageInfo?.endCursor, bUseIntentNavigation, bFilterByDevice);
 
             const oRequestedData = await this._doRequest(sWorkPageQuery);
             const oValidatedData = await this._validateData(oRequestedData);
@@ -126,13 +129,28 @@ sap.ui.define([
      * @param {boolean} bIncludeWorkPage toggles if {id, contents, editable} should also be part of the requetst. undefined object will cause errors
      * @param {string} sEndCursor endCursor of previous request
      * @param {boolean} bUseIntentNavigation Toggle to retrieve targetAppIntent if intentNavigation feature in config is true
+     * @param {boolean} bFilterByDevice Filter visualizations by device type.
      * @returns {string} A GraphQL Query as a string
      */
-    WorkPage.prototype._createWorkPageQuery = function (sSiteId, sPageId, bIncludeWorkPage, sEndCursor, bUseIntentNavigation) {
+    WorkPage.prototype._createWorkPageQuery = function (sSiteId, sPageId, bIncludeWorkPage, sEndCursor, bUseIntentNavigation, bFilterByDevice) {
         if (!sSiteId || !sPageId) {
             throw new Error(`Invalid Arguments, missing either siteId: ${sSiteId} or pageId: ${sPageId}`);
         }
 
+        const sDeviceType = ushellUtils.getFormFactor();
+
+        const sContentFilter = `
+            queryInput: {
+                filterWidgets: {
+                    visualization: {
+                        targetApp: {
+                            deviceType: { eq: "${sDeviceType}" },
+                            launchType: { in: ["embedded", "standalone"] }
+                        }
+                    }
+                }
+            }`;
+
         return `{
             workPage(
                 siteId: "${sSiteId}",
@@ -140,7 +158,7 @@ sap.ui.define([
                 ) {
                     ${bIncludeWorkPage ? `
                         id,
-                        contents,
+                        contents${bFilterByDevice ? `(${sContentFilter})` : ""},
                         editable,
                         ` : ""
             }
@@ -228,9 +246,10 @@ sap.ui.define([
      *
      * @since 1.123.0
      * @param {object} oFilterParams The filter object.
+     * @param {boolean} bFilterByDevice Filter visualizations by device type.
      * @returns {Promise<{visualizations, totalCount}>} The result.
      */
-    WorkPage.prototype.loadVisualizations = function (oFilterParams) {
+    WorkPage.prototype.loadVisualizations = function (oFilterParams, bFilterByDevice) {
         let sQuery = `
         visualizations($queryInput: QueryVisualizationsInput) {
             visualizations(queryInput: $queryInput, siteId: "${this._sSiteId}") {
@@ -266,6 +285,26 @@ sap.ui.define([
 
         sQuery = `query ${sQuery}`;
 
+        if (bFilterByDevice) {
+            const deviceType = ushellUtils.getFormFactor();
+            oFilterParams.filter = oFilterParams.filter || [{}];
+
+            oFilterParams.filter = oFilterParams.filter.map(
+                (filter) => ({
+                    ...filter,
+                    targetApp: {
+                        deviceType: { eq: deviceType },
+                        launchType: {
+                            in: [
+                                "embedded",
+                                "standalone"
+                            ]
+                        }
+                    }
+                })
+            );
+        }
+
         const oVariables = {
             queryInput: oFilterParams
         };

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.127.2
+ * @version 1.128.1
  */
 sap.ui.define([
     "sap/ushell/services/VisualizationInstantiation",
@@ -13,7 +13,7 @@ sap.ui.define([
     "sap/ushell/adapters/cdm/v3/utilsCdm",
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readUtils",
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readVisualizations",
-    "sap/ushell/services/_CommonDataModel/vizTypeDefaults/VizTypeDefaults",
+    "sap/ushell/services/CommonDataModel/vizTypeDefaults/VizTypeDefaults",
     "sap/ushell/utils/tilecard/TileCard",
     "sap/ushell/Config"
 ], function (

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

@@ -18,7 +18,8 @@ sap.ui.define([
     "sap/ushell/utils/UrlParsing",
     "sap/ushell/utils/objectOperations",
     "sap/ushell/utils/type",
-    "sap/ushell/renderer/History"
+    "sap/ushell/renderer/History",
+    "sap/ushell/renderers/fiori2/History" // restore deprecated globals
     //"sap/ushell/resources" --> cannot be declared here currently: utils is used very early - before core boot, but resources uses UI5 core.
 ], function (
     Log,
@@ -34,7 +35,8 @@ sap.ui.define([
     urlParsing,
     ushellObjectOperations,
     ushellType,
-    History
+    History,
+    DeprecatedHistory // restore deprecated globals
 ) {
     "use strict";
 

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.127.2
+ * @version 1.128.1
  */
 
 (function () {

package/ui5.yaml

@@ -65,16 +65,22 @@ builder:
               - sap/ushell/utils/objectOperations.js
               - sap/ushell/EventHub.js
               - sap/ushell/resources.js
+              - sap/ushell/renderer/History
+              - sap/ushell/renderer/utils
+              - sap/ushell/renderer/ShellLayout
               - sap/ushell/renderer/search/HashChangeHandler.js
+              - sap/ushell/renderers/fiori2/History
               - sap/ushell/System.js
               - sap/ushell/Ui5NativeServiceFactory.js
               - sap/ushell/shells/demo/cspJSFiles/AppInfoAdapterSample.js
               - sap/ushell/User.js
               - sap/ushell/services/AppConfiguration.js
               - sap/ushell/Container.js
+              - sap/ushell/services/appstate/AppState
+              - sap/ushell/services/appstate/AppStatePersistencyMethod
               - sap/ushell/services/PluginManager.js
-              - sap/ushell/services/_PluginManager/Extensions.js
-              - sap/ushell/services/_PluginManager/HeaderExtensions.js
+              - sap/ushell/services/PluginManager/Extensions.js
+              - sap/ushell/services/PluginManager/HeaderExtensions.js
               - sap/ushell/services/ShellNavigation.js
               - sap/ushell/services/ShellNavigationInternal.js
               - sap/ushell/services/ShellNavigationHashChanger.js
@@ -82,11 +88,11 @@ builder:
               - sap/ushell/services/URLParsing.js
               - sap/ushell/services/Ui5ComponentLoader.js
               - sap/ushell/services/Ui5ComponentHandle.js
-              - sap/ushell/services/_Ui5ComponentLoader/utils.js
+              - sap/ushell/services/Ui5ComponentLoader/utils.js
               - sap/ushell/TechnicalParameters.js
               - sap/ushell/Config.js
               - sap/ushell/bootstrap/common/common.create.configcontract.core.js
-              - sap/ushell/_Config/utils.js
+              - sap/ushell/Config/utils.js
               - sap/m/
               - sap/m/manifest.json
               - sap/ushell/Fiori20AdapterTest.js
@@ -238,7 +244,7 @@ builder:
               - sap/ui/model/odata/v2/ODataModel.js
               - sap/ui/thirdparty/jquery-mobile-custom.js
               # dynamically required in ApplicationType (which is a dependency of ClientSideTargetResolution service)
-              - sap/ushell/_ApplicationType/
+              - sap/ushell/ApplicationType/
               - sap/ushell/CanvasShapesManager.js
               - sap/ushell/Container.js
               - sap/ushell/Fiori20AdapterTest.js
@@ -264,8 +270,9 @@ builder:
               - sap/ushell/adapters/local/NavTargetResolutionAdapter.js
               - sap/ushell/adapters/local/NavTargetResolutionInternalAdapter.js
               - sap/ushell/adapters/local/UserInfoAdapter.js
+              - sap/ushell/api/Inbox.js
               - sap/ushell/api/RTA.js
-              - sap/ushell/bootstrap/_SchedulingAgent/*.json                    # json files must be explicitly defined
+              - sap/ushell/bootstrap/SchedulingAgent/*.json                    # json files must be explicitly defined
               - sap/ushell/components/ComponentKeysHandler.js
               - sap/ushell/components/container/ApplicationContainer.js
               - sap/ushell/components/pages/controller/PagesAndSpaceId.js

package/src/main/js/sap/ushell/components/tiles/applauncher/StaticTileTmp.view.js

@@ -1,58 +0,0 @@
-// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
-
-/**
- * This copy of the StaticTile.view is needed for compatibility reasons until the changes to applauncher.chip.xml have been delivered.
- * Afterwards this file can be used in all scenarios and StaticTile.view.js can be replaced by it.
- */
-sap.ui.define([
-    "sap/ui/core/mvc/View",
-    "sap/m/GenericTile",
-    "sap/m/ImageContent",
-    "sap/m/TileContent",
-    "sap/ushell/components/tiles/applauncher/StaticTile.controller" // Controller needs to be loaded
-], function (View, GenericTile, ImageContent, TileContent) {
-    "use strict";
-
-    return View.extend("sap.ushell.components.tiles.applauncher.StaticTile", {
-        getControllerName: function () {
-            return "sap.ushell.components.tiles.applauncher.StaticTile";
-        },
-        createContent: function (/*oController*/) {
-            this.setHeight("100%");
-            this.setWidth("100%");
-
-            return this.getTileControl();
-        },
-        getTileControl: function () {
-            var oController = this.getController();
-
-            //Return the GenericTile if it already exists instead of creating a new one
-            if (this.getContent().length === 1) {
-                return this.getContent()[0];
-            }
-
-            return new GenericTile({
-                mode: "{= ${/mode} || (${/config/display_icon_url} ? 'ContentMode' : 'HeaderMode') }",
-                header: "{/config/display_title_text}",
-                subheader: "{/config/display_subtitle_text}",
-                sizeBehavior: "{/sizeBehavior}",
-                wrappingType: "{/wrappingType}",
-                url: {
-                    parts: ["/targetURL", "/nav/navigation_target_url"],
-                    formatter: oController.formatters.leanURL
-                },
-                tileContent: new TileContent({
-                    footer: "{/config/display_info_text}",
-                    content: new ImageContent({
-                        src: "{/config/display_icon_url}"
-                    })
-                }),
-                press: [oController.onPress, oController]
-            });
-        },
-        getMode: function () {
-            return this.getModel().getProperty("/mode")
-                || (this.getModel().getProperty("/config/display_icon_url") ? "ContentMode" : "HeaderMode");
-        }
-    });
-});

package/src/main/js/sap/ushell/components/tiles/applauncherdynamic/DynamicTileTmp.view.js

@@ -1,104 +0,0 @@
-// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
-
-/**
- * This copy of the DynamicTile.view is needed for compatibility reasons until the changes to applauncher_dynamic.chip.xml have been delivered.
- * Afterwards this file can be used in all scenarios and DynamicTile.view.js can be replaced by it.
- */
-sap.ui.define([
-    "sap/ui/core/mvc/View",
-    "sap/m/GenericTile",
-    "sap/m/TileContent",
-    "sap/m/library",
-    "sap/m/NumericContent",
-    "sap/ushell/components/tiles/applauncherdynamic/DynamicTile.controller" // Controller needs to be loaded
-], function (
-    View,
-    GenericTile,
-    TileContent,
-    mobileLibrary,
-    NumericContent
-) {
-    "use strict";
-
-    // shortcut for sap.m.ValueColor
-    var ValueColor = mobileLibrary.ValueColor;
-
-    return View.extend("sap.ushell.components.tiles.applauncherdynamic.DynamicTile", {
-        getControllerName: function () {
-            return "sap.ushell.components.tiles.applauncherdynamic.DynamicTile";
-        },
-
-        createContent: function () {
-            this.setHeight("100%");
-            this.setWidth("100%");
-
-            return this.getTileControl();
-        },
-
-        getTileControl: function () {
-            var oController = this.getController();
-
-            //Return the GenericTile if it already exists instead of creating a new one
-            if (this.getContent().length === 1) {
-                return this.getContent()[0];
-            }
-
-            return new GenericTile({
-                mode: "{/mode}",
-                header: "{/data/display_title_text}",
-                subheader: "{/data/display_subtitle_text}",
-                sizeBehavior: "{/sizeBehavior}",
-                wrappingType: "{/wrappingType}",
-                url: {
-                    parts: ["/targetURL", "/nav/navigation_target_url"],
-                    formatter: oController.formatters.leanURL
-                },
-                tileContent: [new TileContent({
-                    footer: "{/data/display_info_text}",
-                    footerColor: {
-                        path: "/data/display_info_state",
-                        formatter: function (sFooterColor) {
-                            if (sFooterColor === "Positive") {
-                                sFooterColor = ValueColor.Good;
-                            }
-                            if (sFooterColor === "Negative") {
-                                sFooterColor = ValueColor.Error;
-                            }
-
-                            if (!ValueColor[sFooterColor]) {
-                                sFooterColor = ValueColor.Neutral;
-                            }
-
-                            return sFooterColor;
-                        }
-                    },
-                    unit: "{/data/display_number_unit}",
-                    //We'll utilize NumericContent for the "Dynamic" content.
-                    content: [new NumericContent({
-                        scale: "{/data/display_number_factor}",
-                        value: "{/data/display_number_value}",
-                        truncateValueTo: 5, //Otherwise, The default value is 4.
-                        indicator: "{/data/display_state_arrow}",
-                        valueColor: {
-                            path: "/data/display_number_state",
-                            formatter: function (sState) {
-                                if (!sState || sState === "Neutral" || !ValueColor[sState]) {
-                                    return ValueColor.None;
-                                }
-                                return sState;
-                            }
-                        },
-                        icon: "{/data/display_icon_url}",
-                        width: "100%",
-                        withMargin: false
-                    })]
-                })],
-                press: [oController.onPress, oController]
-            });
-        },
-
-        getMode: function () {
-            return this.getModel().getProperty("/mode");
-        }
-    });
-});