@sapui5/sap.ushell 1.138.1 → 1.139.0

package/src/main/js/sap/ushell/components/shell/SearchCEPNew/SearchProviders/SearchProvider.js

@@ -0,0 +1,141 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+/**
+ * @fileOverview This module is the search provider main interface
+ * @version 1.139.0
+ */
+sap.ui.define([
+    "sap/ushell/components/shell/SearchCEPNew/SearchProviders/FrequentActivityProvider",
+    "sap/ushell/components/shell/SearchCEPNew/SearchProviders/RecentSearchProvider",
+    "sap/ushell/components/shell/SearchCEPNew/SearchProviders/SearchServiceProvider"
+], function (
+    FrequentActivityProvider,
+    RecentSearchProvider,
+    SearchServiceProvider
+) {
+    "use strict";
+
+    const SearchProvider = {
+        _defaultProviders: null
+    };
+
+    /**
+     * Returns the default search providers.
+     * @param {sap.ui.model.JSONModel} i18nModel The i18n model to use for the default provider titles
+     * @returns {object} The default search providers
+     * @private
+     * @since 1.101.0
+     */
+    SearchProvider.getDefaultProviders = function (i18nModel) {
+        /**
+         * We should not evaluate ushellResources.i18n.getText at startup.
+         * Only after it was awaited by the Container.init
+         *
+         * Some tests are overriding some properties of the default providers.
+         */
+        if (!this._defaultProviders) {
+            this._defaultProviders = this._createDefaultProviders(i18nModel);
+        }
+        return this._defaultProviders;
+    };
+
+    /**
+     * Creates the default search providers.
+     *
+     * @typedef {object} sap.ushell.SearchCEP.SearchProvider
+     * @property {string} id - The unique identifier of the search provider.
+     * @property {string} entryType - The type of entry (e.g., "app", "product").
+     * @property {string} title - The title of the search provider.
+     * @property {boolean} titleVisible - Whether the title is visible.
+     * @property {boolean} [showNoData] - Whether to show a "no data" message when there are no results.
+     * @property {boolean} [highlightResult] - Whether to highlight the search results.
+     * @property {boolean} [highlightSearchStringPart] - Whether to highlight the search string in the results.
+     * @property {int} minQueryLength - The minimum query length required to execute the search.
+     * @property {int} maxQueryLength - The maximum query length allowed for the search.
+     * @property {int} defaultItemCount - The default number of items to display in the results.
+     * @property {int} maxItemCount - The maximum number of items to display in the results.
+     * @property {int} priority - The priority of the search provider, relevant when exceeding the maximum item count of the search.
+     * @property {function} execSearch - The function to execute the search for this provider.
+     *
+     **/
+
+    /**
+     * @param {sap.ui.model.JSONModel} i18nModel The i18n model to use for the default provider titles
+     * @returns {object<sap.ushell.SearchCEP.SearchProvider>} The default search providers
+     * @private
+     * @since 1.101.0
+     */
+    SearchProvider._createDefaultProviders = function (i18nModel) {
+        return {
+            recentSearches: {
+                id: "RecentSearchesList",
+                entryType: "app",
+                title: i18nModel.getText("recentSearches"),
+                titleVisible: false,
+                minQueryLength: 0,
+                maxQueryLength: 0,
+                defaultItemCount: 2,
+                maxItemCount: 50,
+                priority: 0,
+                execSearch: RecentSearchProvider.execSearch.bind(RecentSearchProvider)
+            },
+
+            applications: {
+                id: "AppsList",
+                entryType: "app",
+                title: i18nModel.getText("applications"),
+                showNoData: true,
+                titleVisible: false,
+                highlightResult: true,
+                highlightSearchStringPart: true,
+                minQueryLength: 1,
+                maxQueryLength: 100,
+                defaultItemCount: 6,
+                maxItemCount: 50,
+                priority: 0,
+                execSearch: SearchServiceProvider.execSearch.bind(SearchServiceProvider)
+            },
+
+            frequentApplications: {
+                id: "FrequentlyUsedAppsList",
+                entryType: "product",
+                title: i18nModel.getText("frequentAppsCEPSearch"),
+                titleVisible: true,
+                minQueryLength: 0,
+                maxQueryLength: 0,
+                defaultItemCount: 6,
+                maxItemCount: 50,
+                priority: 1,
+                execSearch: FrequentActivityProvider.execSearch.bind(FrequentActivityProvider)
+            },
+
+            products: {
+                id: "ProductsList",
+                entryType: "app",
+                title: i18nModel.getText("products"),
+                titleVisible: true,
+                minQueryLength: 0,
+                maxQueryLength: 0,
+                defaultItemCount: 6,
+                maxItemCount: 50,
+                priority: 2,
+                execSearch: SearchServiceProvider.execSearch.bind(SearchServiceProvider)
+            },
+
+            externalSearchApplications: {
+                id: "ExternalSearchAppsList",
+                entryType: "app",
+                title: i18nModel.getText("searchWithin"),
+                titleVisible: true,
+                minQueryLength: 1,
+                maxQueryLength: 100,
+                defaultItemCount: 4,
+                maxItemCount: 50,
+                priority: 2,
+                execSearch: SearchServiceProvider.execSearch.bind(SearchServiceProvider)
+            }
+        };
+    };
+
+    return SearchProvider;
+}, false);

package/src/main/js/sap/ushell/components/shell/SearchCEPNew/SearchProviders/SearchServiceProvider.js

@@ -0,0 +1,177 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+/**
+ * @fileOverview This module handles the navigation service search actions
+ * @version 1.139.0
+ */
+sap.ui.define([
+    "sap/base/Log",
+    "sap/ushell/Config",
+    "sap/ushell/resources",
+    "sap/base/util/ObjectPath",
+    "sap/ushell/Container"
+], (
+    Log,
+    Config,
+    resources,
+    ObjectPath,
+    Container
+) => {
+    "use strict";
+
+    /**
+     * @class
+     * @since 1.101.0
+     * @private
+     */
+    const SearchServiceProvider = function () { };
+
+    /**
+     * returns the name of the search provider
+     *
+     * @returns {string} the name of the provider
+     *
+     * @since 1.101.0
+     * @private
+     */
+    SearchServiceProvider.prototype.getName = function () {
+        return "Search Service Provider";
+    };
+
+    /**
+     * provide search results from the navigation service search api
+     *
+     * @param {string} sQuery the string to search
+     * @param {string} sGroupName the group that we need to filter by
+     * @returns {Promise} when resolved, contains the search result array
+     *
+     * @since 1.101.0
+     * @private
+     */
+    SearchServiceProvider.prototype.execSearch = function (sQuery, sGroupName) {
+        const oParams = {
+            top: 50,
+            skip: 0,
+            sort: {
+                path: "title",
+                descending: false
+            }
+        };
+        switch (sGroupName) {
+            case "products":
+                oParams.searchTerm = "";
+                oParams.filter = {
+                    path: "technicalAttributes",
+                    operator: "Contains",
+                    value1: "APPTYPE_HOMEPAGE"
+                };
+                oParams.includeAppsWithoutVisualizations = true;
+                break;
+            case "applications":
+                oParams.searchTerm = sQuery;
+                oParams.filter = {
+                    filters: [{
+                        path: "technicalAttributes",
+                        operator: "NotContains",
+                        value1: "APPTYPE_SEARCHAPP"
+                    }, {
+                        path: "technicalAttributes",
+                        operator: "NotContains",
+                        value1: "APPTYPE_HOMEPAGE"
+                    }],
+                    and: true
+                };
+                break;
+            case "externalSearchApplications":
+                oParams.searchTerm = "";
+                oParams.filter = {
+                    path: "technicalAttributes",
+                    operator: "Contains",
+                    value1: "APPTYPE_SEARCHAPP"
+                };
+                oParams.includeAppsWithoutVisualizations = true;
+                break;
+            default:
+                break;
+        }
+
+        return Container.getServiceAsync("SearchCEP").then((SearchCEPService) => {
+            return SearchCEPService.suggest(oParams).then((oResult) => {
+                const bIsSearchCEPEnabled = ObjectPath.get("sap-ushell-config.services.SearchCEP") !== undefined;
+                const sPlatform = Container.getFLPPlatform(true);
+                const bIsCEPStandard = bIsSearchCEPEnabled === true && sPlatform === "cFLP";
+                let aFinalResult = [];
+                const bESSearchEnabled = ObjectPath.get("sap-ushell-config.renderers.fiori2.componentData.config.searchBusinessObjects");
+                const oDefaultIcons = {
+                    applications: "sap-icon://SAP-icons-TNT/application",
+                    products: "sap-icon://SAP-icons-TNT/product",
+                    externalSearchApplications: "sap-icon://world"
+                };
+
+                if (oResult) {
+                    aFinalResult = oResult.data.map((item) => {
+                        item.text = item.text || item.label || item.title;
+                        item.icon = item.icon || oDefaultIcons[sGroupName];
+                        return item;
+                    });
+                }
+
+                if (bESSearchEnabled === true && bIsCEPStandard === true && sGroupName === "externalSearchApplications") {
+                    this._addESToResult(aFinalResult, sQuery);
+                }
+                return aFinalResult;
+            });
+        }, (sError) => {
+            Log.error("Search service Provider failed", `error: ${sError}`, "sap.ushell.components.shell.SearchCEP.SearchProviders.SearchServiceProvider::execSearch");
+            return [];
+        });
+    };
+
+    /**
+     * Adds the enterprise search as an external search provider.
+     * Added only in CEP Standard and when enterprise search is enabled in the site.
+     *
+     * @typedef {object} sap.ushell.SearchCEP.SearchResult
+     * @property {string} text - The display text of the search result.
+     * @property {string} description - The description of the search result.
+     * @property {string} icon - The icon associated with the search result.
+     * @property {string} inboundIdentifier - The inbound identifier of the search result.
+     * @property {string} url - The URL to navigate to when the search result is clicked.
+     * @property {string} target - The target where the URL should open (e.g., "_blank").
+     * @property {boolean} recent - Whether the search result is marked as recent.
+     * @property {string} semanticObject - The semantic object associated with the search result.
+     * @property {string} semanticObjectAction - The semantic object action associated with the search result.
+     * @property {string} _type - The type of the search result (e.g., "app").
+     * @property {boolean} isEnterpriseSearch - Whether the search result is an enterprise search result.
+     **/
+
+    /**
+     * @param {sap.ushell.SearchCEP.SearchResult[]} aResult - The search result array to which the enterprise search result will be added.
+     * @param {string} sQuery - The string to search derived from the search field.
+     *
+     * @since 1.106.0
+     * @private
+     */
+    SearchServiceProvider.prototype._addESToResult = function (aResult, sQuery) {
+        const sHash = "#Action-search&/top=20&filter={\"dataSource\":{\"type\":\"Category\",\"id\":\"All\",\"label\":\"All\",\"labelPlural\":\"All\"},\"" +
+            `searchTerm":"${sQuery}","rootCondition":{"type":"Complex","operator":"And","conditions":[]}}`;
+        const sUrl = Container.getFLPUrl() + sHash;
+        const oESearch = {
+            text: resources.i18n.getText("enterprise_search"),
+            description: resources.i18n.getText("enterprise_search"),
+            icon: "sap-icon://search",
+            inboundIdentifier: "38cd162a-e185-448c-9c37-a4fc02b3d39d___GenericDefaultSemantic-__GenericDefaultAction",
+            url: sUrl,
+            target: "_blank",
+            recent: false,
+            semanticObject: "Action",
+            semanticObjectAction: "search",
+            _type: "app",
+            isEnterpriseSearch: true
+        };
+
+        aResult.push(oESearch);
+    };
+
+    return new SearchServiceProvider();
+}, false);

package/src/main/js/sap/ushell/components/shell/SearchCEPNew/manifest.json

@@ -0,0 +1,43 @@
+{
+    "_version": "1.70.0",
+    "sap.app": {
+        "id": "sap.ushell.components.shell.SearchCEPNew",
+        "type": "component",
+        "title": "SearchCEPNew",
+        "ach": "CA-FLP-FE-UI",
+        "applicationVersion": {
+            "version": "1.139.0"
+        }
+    },
+    "sap.ui": {
+        "technology": "UI5",
+        "deviceTypes": {
+            "desktop": true,
+            "phone": true,
+            "tablet": true
+        }
+    },
+    "sap.ui5": {
+        "dependencies": {
+            "minUI5Version": "1.135",
+            "libs": {
+                "sap.ui.core": {},
+                "sap.ushell": {}
+            }
+        },
+        "contentDensities": {
+            "compact": true,
+            "cozy": true
+        },
+        "componentName": "sap.ushell.components.shell.SearchCEPNew",
+        "models": {
+            "i18n": {
+                "type": "sap.ui.model.resource.ResourceModel",
+                "settings": {
+                    "bundleName": "sap.ushell.components.shell.SearchCEPNew.resources.resources",
+                    "async": true
+                }
+            }
+        }
+    }
+}

package/src/main/js/sap/ushell/components/shell/SearchCEPNew/resources/resources.properties

@@ -0,0 +1,17 @@
+# Translatable texts for the SearchCEPNew component if desired
+# __ldi.translation.uuid=f04f2112-46f4-4cb4-8af8-0b58ae28ca69
+
+#XFLD
+SHELL_SEARCH_PLACEHOLDER=Search
+#XBUT
+showAllSearchResults=Show All Search Results ({0})
+#XGRP
+applications=Applications
+#XGRP
+recentSearches=Recent Searches
+#XGRP
+frequentAppsCEPSearch=Frequently Used Apps
+#XGRP
+products=Products
+#XGRP
+searchWithin=Search Within

package/src/main/js/sap/ushell/components/shell/Settings/Component.js

@@ -18,7 +18,7 @@ sap.ui.define([
     "sap/ushell/utils",
     "sap/ushell/Container",
     "sap/ushell/state/StateManager"
-], function (
+], (
     Element,
     XMLView,
     UIComponent,
@@ -36,18 +36,18 @@ sap.ui.define([
     Utils,
     Container,
     StateManager
-) {
+) => {
     "use strict";
 
     // shortcut for sap.ushell.state.StateManager.Operation
     const Operation = StateManager.Operation;
 
-    var aDoables = [];
+    const aDoables = [];
 
     return UIComponent.extend("sap.ushell.components.shell.Settings.Component", {
 
         metadata: {
-            version: "1.138.1",
+            version: "1.139.0",
             library: "sap.ushell",
             dependencies: {
                 libs: {
@@ -66,7 +66,7 @@ sap.ui.define([
          */
         init: function () {
             UIComponent.prototype.init.apply(this, arguments);
-            var oShellConfig = Container.getRendererInternal("fiori2").getShellConfig();
+            const oShellConfig = Container.getRendererInternal("fiori2").getShellConfig();
 
             if (oShellConfig.moveUserSettingsActionToShellHeader) {
                 this.oSettingsBtn = this._addUserSettingsButton();
@@ -93,13 +93,13 @@ sap.ui.define([
          * @private
          */
         _addUserLanguageAndRegionSettings: function () {
-            var oUser = Container.getUser();
+            const oUser = Container.getUser();
 
-            oUser.getLanguageAndRegionSettingsEntry().then(function (oLanguageAndRegionEntry) {
-                var aEntities = Config.last("/core/userPreferences/entries");
+            oUser.getLanguageAndRegionSettingsEntry().then((oLanguageAndRegionEntry) => {
+                const aEntities = Config.last("/core/userPreferences/entries");
                 aEntities.push(oLanguageAndRegionEntry.getEntry());
                 this._updateUserPreferencesEntries(aEntities);
-            }.bind(this));
+            });
         },
 
         /**
@@ -108,7 +108,7 @@ sap.ui.define([
          * @private
          */
         _addStandardEntityToConfig: function () {
-            var aEntities = Config.last("/core/userPreferences/entries");
+            let aEntities = Config.last("/core/userPreferences/entries");
 
             aEntities.push(UserAccountEntry.getEntry()); // User account
             aEntities.push(AppearanceEntry.getEntry()); // Appearance
@@ -123,11 +123,11 @@ sap.ui.define([
 
             // Search
             if (Config.last("/core/shell/model/searchAvailable")) {
-                Container.getFLPPlatform().then(function (sPlatform) {
+                Container.getFLPPlatform().then((sPlatform) => {
                     if (sPlatform !== "MYHOME") {
-                        sap.ui.require(["sap/ushell/components/shell/Settings/search/SearchEntry"], function (SearchEntry) {
-                            SearchEntry.getEntry().then(function (searchEntry) {
-                                searchEntry.isActive().then(function (isActive) {
+                        sap.ui.require(["sap/ushell/components/shell/Settings/search/SearchEntry"], (SearchEntry) => {
+                            SearchEntry.getEntry().then((searchEntry) => {
+                                searchEntry.isActive().then((isActive) => {
                                     if (!isActive) {
                                         return;
                                     }
@@ -135,11 +135,11 @@ sap.ui.define([
                                     aEntities = Config.last("/core/userPreferences/entries");
                                     aEntities.push(searchEntry);
                                     this._updateUserPreferencesEntries(aEntities);
-                                }.bind(this));
-                            }.bind(this));
-                        }.bind(this));
+                                });
+                            });
+                        });
                     }
-                }.bind(this));
+                });
             }
 
             if (Config.last("/core/home/enableHomePageSettings") && !Config.last("/core/spaces/enabled")) {
@@ -161,16 +161,16 @@ sap.ui.define([
          * @private
          */
         _addNotificationSettings: function () {
-            Container.getServiceAsync("NotificationsV2").then(function (service) {
+            Container.getServiceAsync("NotificationsV2").then((service) => {
                 service._userSettingInitialization();
-                service._getNotificationSettingsAvailability().then(function (status) {
+                service._getNotificationSettingsAvailability().then((status) => {
                     if (status.settingsAvailable) {
-                        var aEntities = Config.last("/core/userPreferences/entries");
+                        const aEntities = Config.last("/core/userPreferences/entries");
                         aEntities.push(NotificationsEntry.getEntry());
                         this._updateUserPreferencesEntries(aEntities);
                     }
-                }.bind(this));
-            }.bind(this)).catch(() => {}); // Notification settings are not available, do nothing.
+                });
+            }).catch(() => {}); // Notification settings are not available, do nothing.
         },
 
         /**
@@ -184,15 +184,15 @@ sap.ui.define([
                 this.oDialogPromise = XMLView.create({
                     id: "settingsView",
                     viewName: "sap.ushell.components.shell.Settings.UserSettings"
-                }).then(function (oSettingsView) {
+                }).then((oSettingsView) => {
                     this.oSettingsView = oSettingsView;
-                    var sControlId = oEvent.controlId || "shell-header";
+                    const sControlId = oEvent.controlId || "shell-header";
                     Element.getElementById(sControlId).addDependent(oSettingsView);
                     return oSettingsView;
-                }.bind(this));
+                });
             }
 
-            return this.oDialogPromise.then(function (oSettingsView) {
+            return this.oDialogPromise.then((oSettingsView) => {
                 oSettingsView.getController().open(oEvent?.targetEntryId);
             });
         },
@@ -203,13 +203,28 @@ sap.ui.define([
          * @returns {sap.ushell.ui.shell.ShellHeadItem} settings button
          */
         _addUserSettingsButton: function () {
-            var oUserSettingsButton = new ShellHeadItem({
-                id: "userSettingsBtn",
-                icon: "sap-icon://action-settings",
-                text: resources.i18n.getText("userSettings"),
-                ariaHaspopup: "dialog",
-                press: this._openUserSettings.bind(this)
-            });
+            let oUserSettingsButton;
+            if (Config.last("/core/shellBar/enabled")) {
+                const ShellBarItem = sap.ui.require("sap/ushell/gen/ui5/webcomponents-fiori/dist/ShellBarItem");
+                oUserSettingsButton = new ShellBarItem({
+                    id: "userSettingsBtn",
+                    icon: "sap-icon://action-settings",
+                    text: resources.i18n.getText("userSettings"),
+                    accessibilityAttributes: {
+                        hasPopup: "dialog"
+                    },
+                    click: this._openUserSettings.bind(this)
+                });
+            } else {
+                oUserSettingsButton = new ShellHeadItem({
+                    id: "userSettingsBtn",
+                    icon: "sap-icon://action-settings",
+                    text: resources.i18n.getText("userSettings"),
+                    ariaHaspopup: "dialog",
+                    press: this._openUserSettings.bind(this)
+                });
+            }
+
 
             // Add to userActions. The actual move happens within the state management
             StateManager.updateAllBaseStates("userActions.items", Operation.Add, oUserSettingsButton.getId());
@@ -223,7 +238,7 @@ sap.ui.define([
          * @private
          */
         exit: function () {
-            for (var i = 0; i < aDoables.length; i++) {
+            for (let i = 0; i < aDoables.length; i++) {
                 aDoables[i].off();
             }
             if (this.oSettingsView) {

package/src/main/js/sap/ushell/components/shell/Settings/ErrorMessageHelper.js

@@ -2,15 +2,9 @@
 
 sap.ui.define([
     "sap/ui/core/Messaging"
-], function (Messaging) {
+], (Messaging) => {
     "use strict";
-    var sUserSettingsErrorDialogTarget = "sapUshellSettingsDialog/";
-
-    return {
-        addMessage: addMessage,
-        filterMessagesToDisplay: filterMessagesToDisplay,
-        removeErrorMessages: removeErrorMessages
-    };
+    const sUserSettingsErrorDialogTarget = "sapUshellSettingsDialog/";
 
     /**
      * Add a message to the MessageManager with the correct target
@@ -30,7 +24,7 @@ sap.ui.define([
      * @private
      */
     function filterMessagesToDisplay () {
-        return Messaging.getMessageModel().getData().filter(function (oMessage) {
+        return Messaging.getMessageModel().getData().filter((oMessage) => {
             return oMessage.getTargets() && oMessage.getTargets().indexOf(sUserSettingsErrorDialogTarget) === 0;
         });
     }
@@ -41,10 +35,16 @@ sap.ui.define([
      * @private
      */
     function removeErrorMessages () {
-        Messaging.getMessageModel().getData().forEach(function (oMessage) {
+        Messaging.getMessageModel().getData().forEach((oMessage) => {
             if (oMessage.getTargets() && oMessage.getTargets().indexOf(sUserSettingsErrorDialogTarget) === 0) {
                 Messaging.removeMessages(oMessage);
             }
         });
     }
+
+    return {
+        addMessage: addMessage,
+        filterMessagesToDisplay: filterMessagesToDisplay,
+        removeErrorMessages: removeErrorMessages
+    };
 });