@sapui5/sap.ushell 1.120.7 → 1.121.0

package/src/main/js/sap/ushell/adapters/cdm/v3/StaticGroupsAdapter.js

@@ -3,7 +3,7 @@
  * @fileOverview The Unified Shell's LaunchPageAdapter for the
  *               'CDM' platform - Version 3 (V3)
  *
- * @version 1.120.7
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/v3/AdapterBase"

package/src/main/js/sap/ushell/adapters/cdm/v3/_LaunchPage/readApplications.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Helper for accessing application data for the 'CDM' platform.
  *
- * @version 1.120.7
+ * @version 1.121.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/v3/_LaunchPage/readCatalogs.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview Helper for accessing catalog data for the 'CDM' platform.
  *
- * @version 1.120.7
+ * @version 1.121.0
  * @private
  */
 sap.ui.define( [

package/src/main/js/sap/ushell/adapters/cdm/v3/_LaunchPage/readHome.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview Helper for accessing Home Page data for the 'CDM' platform.
  *
- * @version 1.120.7
+ * @version 1.121.0
  * @private
  */
 sap.ui.define([
@@ -25,6 +25,7 @@ sap.ui.define([
      *      Common Data Model site
      *  @returns {object[]}
      *      array of groups
+     * @deprecated As of version 1.120
      */
     readHome.getGroupsArrayFromSite = function (oSite) {
         var aLoadedGroups = [];
@@ -51,6 +52,7 @@ sap.ui.define([
      *  @returns {object}
      *      an object containing all groups as properties (property name
      *      is the groupId, property value is the group data)
+     * @deprecated As of version 1.120
      */
     readHome.getGroupsMapFromSite = function (oSite) {
         return oSite.groups;
@@ -63,6 +65,7 @@ sap.ui.define([
      *      Common Data Model site
      *  @returns {string[]}
      *      array of group IDs
+     * @deprecated As of version 1.120
      */
     readHome.getGroupIdsFromSite = function (oSite) {
         // All existing group ids are stored in the groupsOrder array of the site
@@ -78,6 +81,7 @@ sap.ui.define([
      *      ID of the group to be returned
      *  @returns {object}
      *      the group with the specified ID or undefined if not present
+     * @deprecated As of version 1.120
      */
     readHome.getGroupFromSite = function (oSite, sGroupId) {
         return oSite.groups[sGroupId];
@@ -91,6 +95,7 @@ sap.ui.define([
      *      Array of groups
      *  @returns {object}
      *      the default group or undefined if none exists
+     * @deprecated As of version 1.120
      */
     readHome.getDefaultGroup = function (aGroups) {
         var aDefaultGroups = aGroups.filter(function (oGroup) {
@@ -112,6 +117,7 @@ sap.ui.define([
      *      Group object
      *  @returns {string}
      *      Group ID of the given group
+     * @deprecated As of version 1.120
      */
     readHome.getGroupId = function (oGroup) {
         return oGroup.identification && oGroup.identification.id;
@@ -124,6 +130,7 @@ sap.ui.define([
      *      Group object
      *  @returns {string}
      *      Title of the given group
+     * @deprecated As of version 1.120
      */
     readHome.getGroupTitle = function (oGroup) {
         return oGroup.identification.title;
@@ -138,6 +145,7 @@ sap.ui.define([
      *  @returns {boolean}
      *      Returns true if group was assigned by admin and false if group was
      *      created by the end-user
+     * @deprecated As of version 1.120
      */
     readHome.isGroupPreset = function (oGroup) {
         if (!oGroup.payload.hasOwnProperty("isPreset")) {
@@ -155,6 +163,7 @@ sap.ui.define([
      *  @returns {boolean}
      *      Returns false if the end-user is able to modify (personalize) the group
      *      and true if the user cannot make changes to the group
+     * @deprecated As of version 1.120
      */
     readHome.isGroupLocked = function (oGroup) {
         return !!oGroup.payload.locked;
@@ -169,6 +178,7 @@ sap.ui.define([
      *  @returns {boolean}
      *      Returns false if the end-user has hidden the group and true
      *      if this is not the case. The default is true
+     * @deprecated As of version 1.120
      */
     readHome.isGroupVisible = function (oGroup) {
         return !!(oGroup.identification.isVisible === undefined || oGroup.identification.isVisible === true);
@@ -182,6 +192,7 @@ sap.ui.define([
      *      Group object
      *  @returns {object[]}
      *      array of group tiles
+     * @deprecated As of version 1.120
      */
     readHome.getGroupTiles = function (oGroup) {
         if (oGroup.payload.tiles && oTypeUtils.isArray(oGroup.payload.tiles) && oGroup.payload.tiles.length > 0) {
@@ -198,6 +209,7 @@ sap.ui.define([
      *      Group object
      *  @returns {object[]}
      *      array of group links
+     * @deprecated As of version 1.120
      */
     readHome.getGroupLinks = function (oGroup) {
         if (oGroup.payload.links && oTypeUtils.isArray(oGroup.payload.links) && oGroup.payload.links.length > 0) {

package/src/main/js/sap/ushell/adapters/cdm/v3/_LaunchPage/readPages.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Helper for accessing pages data for the 'CDM' platform.
  *
- * @version 1.120.7
+ * @version 1.121.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/v3/_LaunchPage/readUtils.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Helper for accessing the read utils for the 'CDM' platform.
  *
- * @version 1.120.7
+ * @version 1.121.0
  * @private
  */
 sap.ui.define([
@@ -12,6 +12,7 @@ sap.ui.define([
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readHome",
     "sap/ushell/adapters/cdm/v3/utilsCdm",
     "sap/ushell/Config",
+    "sap/ushell/Container",
     "sap/base/util/deepClone",
     "sap/base/util/isPlainObject",
     "sap/base/util/ObjectPath",
@@ -24,6 +25,7 @@ sap.ui.define([
     readHome,
     utilsCdm,
     Config,
+    Container,
     deepClone,
     isPlainObject,
     ObjectPath,
@@ -38,6 +40,8 @@ sap.ui.define([
     // shortcut for sap.ushell.DisplayFormat
     var DisplayFormat = ushellLibrary.DisplayFormat;
 
+    var oContentProviderLabelPromises = {};
+
     /**
      * @typedef vizData
      * @type {object}
@@ -49,7 +53,7 @@ sap.ui.define([
      * @property {string} icon
      * @property {string} info
      * @property {string[]} keywords
-     *    Search key words
+     *    Search keywords
      * @property {object} target
      *    Same format as in CDM RT schema in visualization/vizConfig/sap.flp/target.
      * @property {object} _instantiationData
@@ -68,7 +72,8 @@ sap.ui.define([
      * @since 1.78.0
      * @private
      */
-    readUtils.getVizData = function (oSite, oVizReference, oSystemContext) {
+    // eslint-disable-next-line complexity
+    readUtils.getVizData = async function (oSite, oVizReference, oSystemContext) {
         if (oVizReference.isBookmark && oVizReference.url) {
             // convert old bookmarks to new
             oVizReference = deepClone(oVizReference);
@@ -76,11 +81,11 @@ sap.ui.define([
             oVizReference.target = utilsCdm.toTargetFromHash(oVizReference.url);
         }
 
-        var aCdmParts = this.getCdmParts(oSite, oVizReference);
-        var oVizConfig = aCdmParts && aCdmParts[1] || {};
-        var oApp = aCdmParts && aCdmParts[3] || {};
-        var oViz = readVisualizations.get(oSite, readHome.getTileVizId(oVizReference)) || {};
-        var oVizData = {
+        const aCdmParts = this.getCdmParts(oSite, oVizReference);
+        const oVizConfig = aCdmParts && aCdmParts[1] || {};
+        const oApp = aCdmParts && aCdmParts[3] || {};
+        const oViz = readVisualizations.get(oSite, readHome.getTileVizId(oVizReference)) || {};
+        const oVizData = {
             id: readHome.getTileId(oVizReference),
             vizId: readHome.getTileVizId(oVizReference) || "",
             vizType: oVizReference.vizType || readVisualizations.getTypeId(oViz) || "",
@@ -100,6 +105,7 @@ sap.ui.define([
         };
         oVizData.target = this.harmonizeTarget(oVizData.target);
         oVizData.targetURL = utilsCdm.toHashFromVizData(oVizData, oSite.applications);
+        oVizData.contentProviderLabel = await this.getContentProviderLabel(oVizData.contentProviderId);
 
         if (oVizData.indicatorDataSource) {
             if (oVizData.indicatorDataSource.dataSource) {
@@ -126,6 +132,37 @@ sap.ui.define([
         return oVizData;
     };
 
+    /**
+     * Determines the contentProviderLabel based on the contentProviderId.
+     *
+     * To get the label, the systemContext is required, which is retrieved by the ClientSideTargetResolution.
+     * The label is cached by contentProviderId.
+     *
+     * @param {string} sContentProviderId The contentProviderId
+     *
+     * @returns {Promise<string>} Returns promise which resolves with the label.
+     *
+     * @since 1.121
+     * @private
+     */
+    readUtils.getContentProviderLabel = function (sContentProviderId) {
+        if (Object.hasOwn(oContentProviderLabelPromises, sContentProviderId)) {
+            return oContentProviderLabelPromises[sContentProviderId];
+        }
+
+        oContentProviderLabelPromises[sContentProviderId] = new Promise(async (resolve) => {
+            try {
+                const oCSTR = await Container.getServiceAsync("ClientSideTargetResolution");
+                const oSystemContext = await oCSTR.getSystemContext(sContentProviderId);
+                resolve(oSystemContext?.label);
+            } catch (oError) {
+                resolve(sContentProviderId);
+            }
+        });
+
+        return oContentProviderLabelPromises[sContentProviderId];
+    };
+
     /**
      * Returns the indicator data source with or without prefix depending on provided parameters
      *
@@ -175,7 +212,7 @@ sap.ui.define([
             numberUnit: oVizData.numberUnit
         };
 
-        // we always want to save without prefix so we reset here in case it is needed
+        // we always want to save without prefix, so we reset here in case it is needed
         if (oVizRef.indicatorDataSource && oVizRef.indicatorDataSource.originalPath) {
             oVizRef.indicatorDataSource.path = oVizRef.indicatorDataSource.originalPath;
             delete oVizRef.indicatorDataSource.originalPath;
@@ -220,6 +257,7 @@ sap.ui.define([
      * Converts target parameters from array to object structure if needed.
      * The array format is often used FLP internal while the object format is used
      * for CDM navigation targets as found in visualizations or bookmarks.
+     * Additionally, the flat object format is supported.
      *
      * Example for the array format:
      * <pre>
@@ -243,6 +281,16 @@ sap.ui.define([
      *  }
      * </pre>
      *
+     * Example for the flat object format:
+     * <pre>
+     *  {
+     *      a: {
+     *          format: "plain",
+     *          value "b"
+     *      }
+     *  }
+     * </pre>
+     *
      * @param {object} oTarget The target of a visualization or vizReference
      * @returns {object} The target with parameters in object format
      *
@@ -250,29 +298,47 @@ sap.ui.define([
      * @private
      */
     readUtils.harmonizeTarget = function (oTarget) {
-        var oParameters = oTarget.parameters;
+        var vParameters = oTarget.parameters;
+        var oParametersOut = {};
 
-        if (!oParameters || isPlainObject(oParameters)) {
+        if (!vParameters) {
             return oTarget;
         }
 
-        var oParametersOut = {};
-        oParameters.forEach(function (oParam) {
-            if (oParametersOut[oParam.name]) {
-                if (!Array.isArray(oParametersOut[oParam.name].value.value)) {
-                    oParametersOut[oParam.name].value.value = [oParametersOut[oParam.name].value.value];
+        if (Array.isArray(vParameters)) {
+            // Array structure
+            vParameters.forEach(function (oParam) {
+                if (oParametersOut[oParam.name]) {
+                    if (!Array.isArray(oParametersOut[oParam.name].value.value)) {
+                        oParametersOut[oParam.name].value.value = [oParametersOut[oParam.name].value.value];
+                    }
+
+                    oParametersOut[oParam.name].value.value.push(oParam.value);
+                } else {
+                    oParametersOut[oParam.name] = {
+                        value: {
+                            value: oParam.value,
+                            format: "plain"
+                        }
+                    };
+                }
+            });
+        } else {
+            // Object structure
+            oParametersOut = Object.keys(vParameters).reduce((oParameters, sKey) => {
+                if (!vParameters[sKey].value || !vParameters[sKey].value.hasOwnProperty("value")) {
+                    // Flat object structure
+                    vParameters[sKey] = {
+                        value: vParameters[sKey]
+                    };
                 }
 
-                oParametersOut[oParam.name].value.value.push(oParam.value);
-            } else {
-                oParametersOut[oParam.name] = {
-                    value: {
-                        value: oParam.value,
-                        format: "plain"
-                    }
+                return {
+                    ...oParameters,
+                    [sKey]: vParameters[sKey]
                 };
-            }
-        });
+            }, {});
+        }
 
         oTarget.parameters = oParametersOut;
         return oTarget;

package/src/main/js/sap/ushell/adapters/cdm/v3/_LaunchPage/readVisualizations.js

@@ -4,7 +4,7 @@
  *
  * TODO: Simplify function names
  *
- * @version 1.120.7
+ * @version 1.121.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cep/MenuAdapter.js

@@ -10,13 +10,13 @@
  */
 sap.ui.define([
     "sap/base/Log",
-    "sap/ui/core/Configuration",
+    "sap/base/i18n/Localization",
     "sap/ushell/Config",
     "sap/ushell/library",
     "sap/ushell/utils/HttpClient"
 ], function (
     Log,
-    Configuration,
+    Localization,
     Config,
     ushellLibrary,
     HttpClient
@@ -102,7 +102,7 @@ sap.ui.define([
     /**
      * Builds a menu which is accepted by the menu service.
      *
-     * @param {array} aSpaces The spaces and pages of the menu
+     * @param {object[]} aSpaces The spaces and pages of the menu
      * @returns {MenuEntry[]} The menu structure required by the menu service, @see sap.ushell.services.menu#MenuEntry
      * @since 1.106.0
      * @private
@@ -179,7 +179,7 @@ sap.ui.define([
     /**
      * Builds content nodes based on the spaces. The property "isContainer" is set to false for WorkPages (which have no pageType)
      *
-     * @param {array} aSpaces The spaces and pages of the menu
+     * @param {object[]} aSpaces The spaces and pages of the menu
      * @returns {ContentNode[]} The content nodes required by the menu service, @see sap.ushell.services.menu#ContentNode
      * @private
      * @since 1.106.0
@@ -316,7 +316,7 @@ sap.ui.define([
             headers: {
                 "Content-Type": "application/json",
                 Accept: "application/json",
-                "Accept-Language": Configuration.getLanguageTag()
+                "Accept-Language": Localization.getLanguageTag().toString()
             }
         }).then(function (oResponse) {
             if (oResponse.status < 200 || oResponse.status >= 300) {
@@ -341,7 +341,7 @@ sap.ui.define([
      * Retrieves the spaces from the GraphQL responded JSON object.
      *
      * @param {object} oSiteData The GraphQL response as JSON object
-     * @returns {array} All spaces as an array
+     * @returns {object[]} All spaces as an array
      * @since 1.106.0
      * @private
      */

package/src/main/js/sap/ushell/adapters/cep/NavTargetResolutionAdapter.js

@@ -2,22 +2,20 @@
 
 /**
  * @fileoverview The NavTargetResolution adapter for SAP MyHome
- * @version 1.120.7
+ * @version 1.121.0
  */
 
 sap.ui.define([
+    "sap/base/i18n/Localization",
     "sap/base/util/ObjectPath",
-    "sap/ui/core/Configuration",
     "sap/ui/thirdparty/jquery",
-    "sap/ushell/Container",
     "sap/ushell/services/_ClientSideTargetResolution/VirtualInbounds",
     "sap/ushell/utils/HttpClient",
     "sap/ushell/Config"
 ], function (
+    Localization,
     ObjectPath,
-    Configuration,
     jQuery,
-    Container,
     oVirtualInbounds,
     HttpClient,
     Config
@@ -96,7 +94,7 @@ sap.ui.define([
         var oHeaders = {
             "Content-Type": "application/json; utf-8",
             Accept: "application/json",
-            "Accept-Language": Configuration.getLanguageTag() || ""
+            "Accept-Language": Localization.getLanguageTag().toString() || ""
         };
 
         var sBasePath = this.oAdapterConfiguration.config.navServiceUrl + "/";
@@ -166,5 +164,32 @@ sap.ui.define([
                     });
             }.bind(this));
     };
+
+    /**
+     * Forwards the given intents and converts them from an array to a combined object.
+     *
+     * @param {string[]} aIntents The intents (such as <code>"#AnObject-Action?A=B&C=e&C=j"</code>) to be forwarded.
+     * @returns {object} A <code>jQuery.Deferred</code> promise containing the intents in an object
+     * with their intents as keys with a single property <code>supported</code> of type <code>boolean</code>.
+     *   Example:
+     *   <pre>
+     *   {
+     *     "#AnObject-Action?A=B&C=e&C=j": { supported: false },
+     *     "#AnotherObject-Action2": { supported: true }
+     *   }
+     *   </pre>
+     * @private
+     * @since 1.121.0
+     */
+    NavTargetResolutionAdapter.prototype.isIntentSupported = function (aIntents) {
+        var oIntents = {};
+        aIntents.forEach((elem, i) => {
+            oIntents[elem] = { supported: true };
+        });
+        var oDeferred = new jQuery.Deferred();
+        oDeferred.resolve(oIntents);
+        return oDeferred.promise();
+    };
+
     return NavTargetResolutionAdapter;
 }, /* bExport= */ false);

package/src/main/js/sap/ushell/adapters/cep/SearchCEPAdapter.js

@@ -2,15 +2,15 @@
 /**
  * @fileOverview The Unified Shell's Search adapter for CEP applications (client-side search).
  *
- * @version 1.120.7
+ * @version 1.121.0
  */
 sap.ui.define([
-    "sap/ushell/utils/UrlParsing",
+    "sap/ui/core/Lib",
     "sap/ui/model/json/JSONModel",
     "sap/ui/model/Filter",
     "sap/ui/model/Sorter"
 ], function (
-    UrlParsing,
+    Library,
     JSONModel,
     Filter,
     Sorter
@@ -54,7 +54,7 @@ sap.ui.define([
         return this._searchWithSearchableContentAndJsSearch(oParameters);
     };
 
-    /*
+    /**
      * Search using the SearchableContent service and the jsSearch implementation
      */
     SearchCEPAdapter.prototype._searchWithSearchableContentAndJsSearch = function (oParameters) {
@@ -64,7 +64,7 @@ sap.ui.define([
             var JsSearch = aPromiseResults[1];
             var oSearchEngine = new JsSearch({
                 objects: aNormalizedSearchableContentApps,
-                fields: ["title", "label", "description", "keywords"],
+                fields: ["title", "label", "contentProviderLabel", "description", "keywords"],
                 shouldNormalize: !String.prototype.normalize,
                 algorithm: {
                     id: "contains-ranked",
@@ -137,6 +137,7 @@ sap.ui.define([
                         keywords: Array.isArray(oVis.keywords) ? oVis.keywords.join(" ") : "",
                         icon: oVis.icon || "",
                         label: label,
+                        contentProviderLabel: oVis.contentProviderLabel || "",
                         visualization: oVis,
                         url: oVis.targetURL,
                         technicalAttributes: Array.isArray(oApp.technicalAttributes) ? oApp.technicalAttributes.join(" ") : ""
@@ -166,7 +167,7 @@ sap.ui.define([
         this._loadJsSearchModulePromise = new Promise(function (resolve) {
             // always load the library first to ensure async loading
             // (even if the JsSearch module is self-contained)
-            sap.ui.getCore().loadLibrary("sap.esh.search.ui", { async: true }).then(function () {
+            Library.load("sap.esh.search.ui").then(function () {
                 sap.ui.require(["sap/esh/search/ui/appsearch/JsSearch"], function (JsSearch) {
                     resolve(JsSearch);
                 });

package/src/main/js/sap/ushell/adapters/cflp/UserDefaultParameterPersistenceAdapter.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's UserDefaultParameterPersistence adapter for the CFLP
  *               platform.
  *
- * @version 1.120.7
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/ushell/utils/HttpClient",
@@ -79,9 +79,7 @@ sap.ui.define([
      * @param {SystemContext} oSystemContext
      *      An object containing inforamtion about the system that holds the parameter value
      *
-     * @returns {object}
-     *      A jQuery promise, whose done handler receives as first argument a rich parameter object
-     *      containing a value, e.g. <code>{ value : "value" }</code>.
+     * @returns {jQuery.Promise} Resolves a rich parameter object containing a value, e.g. <code>{ value : "value" }</code>.
      *      Its fail handler receives a message string as first argument.
      *
      * @since 1.79.0
@@ -157,9 +155,7 @@ sap.ui.define([
      * @param {SystemContext} oSystemContext
      *      object containing information about the system that holds the parameter value
      *
-     * @returns {object}
-     *      A jQuery promise, whose done handler receives no parameters.
-     *      Its fail handler receives a message string as first argument.
+     * @returns {jQuery.Promise} Resolves once the value was stored or rejects with an error message.
      *
      * @since 1.79.0
      * @private
@@ -211,11 +207,9 @@ sap.ui.define([
      * @param {string} sParameterName
      *      Parameter name to be deleted
      * @param {SystemContext} oSystemContext
-     *      object containing inforamtion about the system that holds the parameter value
+     *      object containing information about the system that holds the parameter value
      *
-     * @returns {object}
-     *      A jQuery promise, whose done handler receives no parameters.
-     *      Its fail handler receives a message string as first argument.
+     * @returns {jQuery.Promise} Resolves once the parameter was deleted or rejects with an error message.
      *
      * @since 1.79.0
      * @private
@@ -256,11 +250,9 @@ sap.ui.define([
      * Method to obtain an array of string containing all Stored parameter names
      *
      * @param {SystemContext} oSystemContext
-     *      object containing inforamtion about the system that holds the parameter value
+     *      object containing information about the system that holds the parameter value
      *
-     * @returns {object}
-     *      A jQuery.Deferred whose first argument of resolve is an array of strings. The strings are sorted.
-     *      Its fail handler receives a message string as first argument.
+     * @returns {jQuery.Promise} Resolves an array of sorted strings or rejects with an error message.
      *
      * @since 1.79.0
      * @private
@@ -312,7 +304,7 @@ sap.ui.define([
 
     /**
      * This method checks if a given parameter name is valid and logs an error if not the case.
-     * A paramerter name is valid if it is an alphanumeric string of no more than 40 characters.
+     * A parameter name is valid if it is an alphanumeric string of no more than 40 characters.
      * In case of an invalid parameter name, the function returns false and logs an error.
      *
      * @param {string} sParameterName
@@ -343,10 +335,8 @@ sap.ui.define([
      * @param {SystemContext} oSystemContext
      *      Object containing information about the target system.
      *
-     * @returns {object}
-     *      A jQuery.Deferred whose first argument of resolve is the object representation
-     *      of a PersContainer, as retrieved from the server.
-     *      Its fail handler receives a message string as first argument.
+     * @returns {jQuery.Promise} Resolves the object representation of a PersContainer, as retrieved from the server
+     *      or rejects with an error message.
      *
      * @since 1.79
      * @private

package/src/main/js/sap/ushell/adapters/local/AdapterContainer.js

@@ -5,7 +5,7 @@
  *
  * The local personalization adapter can be configured to store data either in
  * the local storage (default) or in memory.
- * @version 1.120.7
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",