@sapui5/sap.ushell 1.138.1 → 1.139.0

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's bookmark service. Allows creating shortcuts on the user's home page.
  *
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
     "sap/ui/core/EventBus",
@@ -73,7 +73,6 @@ sap.ui.define([
             return this._oPagesServicePromise;
         };
 
-
         /**
          * Type for data source object.
          *   Metadata for parameter serviceUrl. Mandatory to specify if parameter serviceURL contains semantic date ranges.
@@ -159,7 +158,7 @@ sap.ui.define([
          * @param {boolean} [bCustom] Whether the bookmark is custom or standard
          * @param {string} [sContentProviderId] <b>SAP internal usage only</b> The contentProviderId or undefined outside the cFLP.
          *
-         * @returns {Promise<(undefined|string)>}
+         * @returns {Promise}
          *  The promise is resolved if the bookmark could be added to all content nodes.
          *  The promise is rejected with an error message if the bookmark couldn't be saved.
          *
@@ -188,7 +187,6 @@ sap.ui.define([
             return Promise.all(aPromises);
         };
 
-
         /**
          * Adds a bookmark tile to the provided content nodes.
          *
@@ -297,7 +295,7 @@ sap.ui.define([
          *   Either an array of ContentNodes or a single ContentNode in which the Bookmark will be placed.
          * @param {string} [sContentProviderId] <b>SAP internal usage only</b> The contentProviderId or undefined outside the cFLP.
          *
-         * @returns {Promise<(undefined|string)>}
+         * @returns {Promise}
          *   A promise which resolves on success, but rejects
          *   with a reason-message if the bookmark couldn't be created.
          *
@@ -447,7 +445,7 @@ sap.ui.define([
          *   on the environment in which the application is running. Unsupported parameters will be
          *   ignored.
          *   For list of parameters see the description for the addBookmark function
-         * @param {string} [groupId]
+         * @param {string} [sGroupId]
          *   ID of the group the bookmark tile should be added to.
          * @param {string} [sContentProviderId] <b>SAP internal usage only</b> The contentProviderId or undefined outside the cFLP.
          *   The Content Provider ID.
@@ -462,7 +460,7 @@ sap.ui.define([
          * @deprecated since 1.120. Use {@link sap.ushell.services.BookmarkV2.addBookmark} instead.
          * @private
          */
-        this.addBookmarkByGroupId = async function (oParameters, groupId, sContentProviderId) {
+        this.addBookmarkByGroupId = async function (oParameters, sGroupId, sContentProviderId) {
             // Reject if in launchpad spaces mode
             if (Config.last("/core/spaces/enabled")) {
                 const sError = "Bookmark Service: The API 'addBookmarkByGroupId' is not supported in launchpad spaces mode.";
@@ -471,9 +469,9 @@ sap.ui.define([
 
             const LaunchPage = await this._getLaunchPageService();
             const aGroups = await ushellUtils.promisify(LaunchPage.getGroups());
-            const oGroup = aGroups.find((entry) => entry.id === groupId) || null;
+            const oGroup = aGroups.find((entry) => entry.id === sGroupId) || null;
 
-            return this.addBookmark(oParameters, oGroup, sContentProviderId);
+            await this.addBookmark(oParameters, oGroup, sContentProviderId);
         };
 
         /**
@@ -482,8 +480,8 @@ sap.ui.define([
          * The order of the array is the order in which the groups will be displayed to the user.
          * the API is used from "AddBookmarkButton" by not native UI5 applications
          *
-         * @param {boolean} bGetAll If set to `true`, all groups, including locked groups, are returned.
-         * @returns {Promise} A promise that resolves to the list of groups. In launchpad spaces mode the promise gets rejected.
+         * @param {boolean} [bGetAll=false] If set to `true`, all groups, including locked groups, are returned.
+         * @returns {Promise<object[]>} A promise that resolves to the list of groups. In launchpad spaces mode the promise gets rejected.
          *
          * @since 1.119.0
          * @deprecated since 1.120. Use {@link sap.ushell.services.BookmarkV2.getContentNodes} instead.
@@ -511,7 +509,7 @@ sap.ui.define([
          * Check if the bookmark parameters are valid.
          *
          * @param {object} oParameters The bookmark parameters
-         * @returns {Promise<undefined>} Rejects with an error message if invalid bookmark data is found.
+         * @returns {Promise} Rejects with an error message if invalid bookmark data is found.
          *
          * @since 1.119.0
          * @private
@@ -896,7 +894,6 @@ sap.ui.define([
         };
     }
 
-
     BookmarkV2.hasNoAdapter = true;
     return BookmarkV2;
 }, true /* bExport */);

package/src/main/js/sap/ushell/services/ClientSideTargetResolution/Formatter.js

@@ -13,7 +13,7 @@
  * <p>This is a dependency of ClientSideTargetResolution.  Interfaces exposed
  * by this module may change at any time without notice.</p>
  *
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
 ], () => {

package/src/main/js/sap/ushell/services/ClientSideTargetResolution/InboundIndex.js

@@ -27,7 +27,7 @@
  *
  * @private
  *
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
     "sap/base/util/ObjectPath",

package/src/main/js/sap/ushell/services/ClientSideTargetResolution/InboundProvider.js

@@ -34,7 +34,7 @@
  * <p>This is a dependency of ClientSideTargetResolution.  Interfaces exposed
  * by this module may change at any time without notice.</p>
  *
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
     "sap/ushell/services/ClientSideTargetResolution/VirtualInbounds",

package/src/main/js/sap/ushell/services/ClientSideTargetResolution/PrelaunchOperations.js

@@ -4,7 +4,7 @@
  * @file PrelaunchOperations are executed just before launching the application (post parameter mapping and app state merging) if the
  * <code>sap-prelaunch-operations</code> parameter is specified as a technical parameter.
  *
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/services/ClientSideTargetResolution/Search.js

@@ -8,7 +8,7 @@
  * <p>This is a dependency of ClientSideTargetResolution.  Interfaces exposed
  * by this module may change at any time without notice.</p>
  *
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
     "sap/ushell/utils",

package/src/main/js/sap/ushell/services/ClientSideTargetResolution/StagedLogger.js

@@ -39,7 +39,7 @@
  *
  * This is a dependency of ClientSideTargetResolution. Interfaces exposed by this module may change at any time without notice.
  *
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
     "sap/base/Log"

package/src/main/js/sap/ushell/services/ClientSideTargetResolution/SystemContext.js

@@ -8,7 +8,7 @@
  * <p>This is a dependency of ClientSideTargetResolution. Interfaces exposed
  * by this module may change at any time without notice.</p>
  *
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
     "sap/base/util/ObjectPath",

package/src/main/js/sap/ushell/services/ClientSideTargetResolution/Utils.js

@@ -6,7 +6,7 @@
  * This is a dependency of ClientSideTargetResolution.
  * Interfaces exposed by this module may change at any time without notice.
  *
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
     "sap/base/util/deepExtend"

package/src/main/js/sap/ushell/services/ClientSideTargetResolution/VirtualInbounds.js

@@ -12,7 +12,7 @@
  * <p>This is a dependency of ClientSideTargetResolution.  Interfaces
  * exposed by this module may change at any time without notice.</p>
  *
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([], () => {
     "use strict";

package/src/main/js/sap/ushell/services/ClientSideTargetResolution/XAppStateProcessing.js

@@ -6,7 +6,7 @@
  * Operations in this module are assumed to be executed after the target mapping has been identified (post search).
  *
  * @private
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
     "sap/ushell/services/ClientSideTargetResolution/Utils",

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

@@ -29,7 +29,7 @@
  * In the future, the custom resolver mechanism should be probably moved towards modifying (or only adding to the list of Inbounds),
  * this way a single data source has to be altered to support consistently getLinks, isIntentSupported.
  *
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -379,7 +379,6 @@ sap.ui.define([
      * @since 1.38.0
      */
     ClientSideTargetResolution.prototype.resolveTileIntent = async function (sHashFragment) {
-
         // NOTE: adapter may not implement fallback function
         const aSegments = this._extractInboundFilter(sHashFragment);
 
@@ -436,14 +435,15 @@ sap.ui.define([
 
         const oMatchingTarget = aMatchingTargets[0];
 
+        function fnUndefinedReplacer (sKey, vVal) {
+            return (this[sKey] === undefined) ? "<undefined>" : vVal;
+        }
+        function fnReplacer (key, value) {
+            return (key === "_original") ? undefined : fnUndefinedReplacer.call(this, key, value);
+        }
+
         if (Log.getLevel() >= Log.Level.DEBUG) {
             // replacer for JSON.stringify to show undefined values
-            const fnUndefinedReplacer = function (sKey, vVal) {
-                return (this[sKey] === undefined) ? "<undefined>" : vVal;
-            };
-            const fnReplacer = function (key, value) {
-                return (key === "_original") ? undefined : fnUndefinedReplacer.call(this, key, value);
-            };
             const sMatchedTarget = JSON.stringify(oMatchingTarget, fnReplacer, "   ");
 
             Log.debug(
@@ -577,7 +577,7 @@ sap.ui.define([
         }
     };
 
-    /**‚
+    /**
      * Takes the parameters from startup parameters and inbound parameters.
      * For startup parameters, an array of parameter names is returned.
      * For inbound parameters, it is taken from inbound signature.
@@ -1017,7 +1017,8 @@ sap.ui.define([
         }
 
         /**
-         * Returns ?-prefixed business parameters
+         * @param {object} mParams url parameters.
+         * @returns {string} ?-prefixed business parameters.
          */
         function fnConstructBusinessParamsString (mParams) {
             const sBusinessParams = UrlParsing.paramsToString(mParams);
@@ -1143,22 +1144,20 @@ sap.ui.define([
 
                 aResults.forEach((oResult) => {
                     const sIntent = oResult.intent.split("?")[0];
+                    const oUniqueIntent = oUniqueIntents[sIntent];
+                    let sUniqueIntentText = "";
+
+                    if (oUniqueIntent.hideReason) {
+                        sUniqueIntentText = `(${oUniqueIntent.hideReason})`;
+                    } else if (oUniqueIntent.count > 1) {
+                        sUniqueIntentText = `(${oUniqueIntent.count - 1} others matched)`;
+                    }
+                    const sDebugMessage = `- ${sIntent}${sUniqueIntentText}\n  text: ${oResult.text}\n  full intent: ${oResult.intent}`;
 
-                    if (oUniqueIntents[sIntent].hideReason) {
-                        aHiddenResultLines.push([
-                            "-", `${sIntent}(${oUniqueIntents[sIntent].hideReason})\n`,
-                            " text:", `${oResult.text}\n`,
-                            " full intent:", oResult.intent
-                        ].join(" "));
+                    if (oUniqueIntent.hideReason) {
+                        aHiddenResultLines.push(sDebugMessage);
                     } else {
-                        aResultLines.push([
-                            "-", sIntent,
-                            oUniqueIntents[sIntent].count > 1
-                                ? `(${oUniqueIntents[sIntent].count - 1} others matched)\n`
-                                : "\n",
-                            "text:", `${oResult.text}\n`,
-                            "full intent:", oResult.intent
-                        ].join(" "));
+                        aResultLines.push(sDebugMessage);
                     }
                 });
 
@@ -1218,7 +1217,6 @@ sap.ui.define([
      * @since 1.32.0
      */
     ClientSideTargetResolution.prototype._getMatchingInbounds = async function (oShellHash, oInboundIndex, oConstraints) {
-        const that = this;
         let aTags;
         let iLogId;
         let bExcludeTileInbounds;
@@ -1230,7 +1228,7 @@ sap.ui.define([
         }
 
         if (Log.getLevel() >= Log.Level.DEBUG) {
-            iLogId = ++that._iLogId;
+            iLogId = ++this._iLogId;
         }
 
         _StagedLogger.begin(() => {
@@ -1350,7 +1348,6 @@ sap.ui.define([
             return false;
         });
 
-
         // ========================= Stage 2 ================================
         // resolve references
         let oInitialMatchWithReferencesResult;
@@ -1441,13 +1438,13 @@ sap.ui.define([
 
             oFinalMatchResult = await _Search.match(oShellHash, aMatchingInbounds, oInitialMatchWithReferencesResult.referencesToInclude, fnGetContentProviderLookup, 0 /* iDebugLevel */);
             _StagedLogger.log(() => {
-                const aMatchResults = oFinalMatchResult.matchResults || [];
-                if (aMatchResults.length >= 1) {
+                const aFinalMatchResults = oFinalMatchResult.matchResults || [];
+                if (aFinalMatchResults.length >= 1) {
                     return {
                         logId: iLogId,
                         stage: 3,
                         line: "The following inbounds re-matched:",
-                        lines: aMatchResults.map((oMatchResult) => {
+                        lines: aFinalMatchResults.map((oMatchResult) => {
                             return _Formatter.formatInbound(oMatchResult.inbound);
                         }),
                         prefix: "\u2705" // green checkmark
@@ -1511,7 +1508,6 @@ sap.ui.define([
             };
         });
 
-
         endLogger();
         return aSortedMatchResults;
     };

package/src/main/js/sap/ushell/services/CommonDataModel/SiteConverter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Because the personalization processor only works with a CDM 3.0 site, this converter is used to transform a dedicated
  * CDM 3.1 site object into a CDM 3.0 site and backwards.
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
     "sap/base/Log"

package/src/main/js/sap/ushell/services/CommonDataModel/vizTypeDefaults/VizTypeDefaults.js

@@ -2,7 +2,7 @@
 
 /**
  * @file Utility for loading the default visualization types for the CDM runtime.
- * @version 1.138.1
+ * @version 1.139.0
  */
 
 sap.ui.define([