@sapui5/sap.ushell 1.117.2 → 1.119.0

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module exposes the searchable content.
- * @version 1.117.2
+ * @version 1.119.0
  */
 sap.ui.define([
     "sap/ushell/Config",
@@ -91,10 +91,13 @@ sap.ui.define([
      * Collects and returns all apps
      *
      * @param {object} [oParameters] the parameters for the search.
-     * @param {boolean} [oParameters.includeAppsWithoutVisualizations]
+     * @param {boolean} [oParameters.includeAppsWithoutVisualizations=false]
      *      if set to <code>true</code>, apps without visualizations are also
      *      included in the result (default is <code>false</code>); this option
      *      is only supported when spaces and pages are used
+     * @param {boolean} [oParameters.enableVisualizationPreview=true]
+     *      if set to <code>true</code>, will be put into preview mode. This
+     *      might include a conversion of the tile type.
      *
      * @returns {Promise<appData[]>} A list of appData.
      *
@@ -102,16 +105,26 @@ sap.ui.define([
      * @private
      * @ui5-restricted sap.esh.search.ui
      */
-    SearchableContent.prototype.getApps = function (oParameters) {
-        var bIncludeAppsWithoutVisualizations = !!(oParameters && oParameters.includeAppsWithoutVisualizations);
+    SearchableContent.prototype.getApps = function (oParameters = {}) {
+        const oDefaults = {
+            includeAppsWithoutVisualizations: false,
+            enableVisualizationPreview: true
+        };
+        const oOptions = {
+            includeAppsWithoutVisualizations: oParameters.includeAppsWithoutVisualizations ?? oDefaults.includeAppsWithoutVisualizations,
+            enableVisualizationPreview: oParameters.enableVisualizationPreview ?? oDefaults.enableVisualizationPreview
+        };
+
         if (Config.last("/core/spaces/enabled")) {
-            return this._getPagesAppData(bIncludeAppsWithoutVisualizations)
+            return this._getPagesAppData(oOptions)
                 .then(function (aAppData) {
-                    return this._filterGetApps(aAppData, bIncludeAppsWithoutVisualizations);
+                    return this._filterGetApps(aAppData, oOptions);
                 }.bind(this));
         }
-        return this._getLaunchPageAppData()
-            .then(this._filterGetApps)
+        return this._getLaunchPageAppData(oOptions)
+            .then(function (aAppData) {
+                return this._filterGetApps(aAppData, oOptions);
+            }.bind(this))
             .then(function (aApps) {
                 Log.debug("SearchableContent@getApps in classic mode found " + aApps.length + " apps");
                 return aApps;
@@ -125,15 +138,14 @@ sap.ui.define([
     /**
      * Filters duplicates and appData with empty vizData
      * @param {appData[]} aAppData An array of appData
-     * @param {boolean} bIncludeAppsWithoutVisualizations
-     *      if set to <code>true</code>, apps without visualizations are also
-     *      included in the result (default is <code>false</code>)
+     * @param {object} oGetAppsOptions Options set from consumer
+     * @see #getApps
      * @returns {appData[]} The filtered array of appData
      *
      * @since 1.77.0
      * @private
      */
-    SearchableContent.prototype._filterGetApps = function (aAppData, bIncludeAppsWithoutVisualizations) {
+    SearchableContent.prototype._filterGetApps = function (aAppData, oGetAppsOptions) {
         var aResult = aAppData;
         aResult.forEach(function (oAppData) {
             // remove duplicates
@@ -154,7 +166,7 @@ sap.ui.define([
             });
         });
 
-        if (!bIncludeAppsWithoutVisualizations) {
+        if (!oGetAppsOptions.includeAppsWithoutVisualizations) {
             aResult = aResult.filter(function (oAppData) {
                 // remove apps without visualization
                 return oAppData.visualizations.length > 0;
@@ -166,12 +178,14 @@ sap.ui.define([
 
     /**
      * Collects all appData occurrences within the classic homepage scenario
+     * @param {object} oGetAppsOptions Options set from consumer
+     * @see #getApps
      * @returns {Promise<appData[]>} An array of appData
      *
      * @since 1.77.0
      * @private
      */
-    SearchableContent.prototype._getLaunchPageAppData = function () {
+    SearchableContent.prototype._getLaunchPageAppData = function (oGetAppsOptions) {
         return sap.ushell.Container.getServiceAsync("LaunchPage")
             .then(function (oLaunchPageService) {
                 this._oLaunchPageService = oLaunchPageService;
@@ -231,7 +245,7 @@ sap.ui.define([
                 var aVizData = aTileData
                     .map(function (oTileData) {
                         try {
-                            return this._buildVizDataFromLaunchPageTile(oTileData.tile);
+                            return this._buildVizDataFromLaunchPageTile(oTileData.tile, oGetAppsOptions);
                         } catch (oError) {
                             Log.error("Could not get search data from tile " + oTileData.tileId, oError);
                             return null;
@@ -289,10 +303,10 @@ sap.ui.define([
         }.bind(this));
 
         var oCatalogTilesPromise = this._oLaunchPageService.getCatalogs().then(function (aCatalogs) {
-            return aCatalogs.reduce(function (oTilesPromise, oGroup) {
+            return aCatalogs.reduce(function (oTilesPromise, oCatalog) {
                 return Promise.all([
                     oTilesPromise,
-                    this._oLaunchPageService.getCatalogTiles(oGroup)
+                    this._oLaunchPageService.getCatalogTiles(oCatalog)
                 ]).then(function (aTileResults) {
                     var aTiles = aTileResults[0];
                     var aCatalogTiles = aTileResults[1];
@@ -310,15 +324,14 @@ sap.ui.define([
     /**
      * Collects all appData occurrences within the pages scenario
      *
-     * @param {boolean} bIncludeAppsWithoutVisualizations
-     *      if set to <code>true</code>, apps without visualizations are also
-     *      included in the result (default is <code>false</code>)
+     * @param {object} oGetAppsOptions Options set from consumer
+     * @see #getApps
      * @returns {Promise<appData[]>} An array of appData
      *
      * @since 1.77.0
      * @private
      */
-    SearchableContent.prototype._getPagesAppData = function (bIncludeAppsWithoutVisualizations) {
+    SearchableContent.prototype._getPagesAppData = function (oGetAppsOptions) {
         var oAppData;
         var oSite;
 
@@ -346,12 +359,12 @@ sap.ui.define([
                 };
                 oAppData = {};
 
-                this._applyCdmVisualizations(oSite, oAppData);
-                this._applyCdmPages(oSite, aPages, oAppData);
+                this._applyCdmVisualizations(oSite, oAppData, oGetAppsOptions);
+                this._applyCdmPages(oSite, aPages, oAppData, oGetAppsOptions);
                 return this._filterAppDataByIntent(oAppData, oCSTRService);
             }.bind(this))
             .then(function () {
-                this._applyCdmApplications(oSite, bIncludeAppsWithoutVisualizations, oAppData);
+                this._applyCdmApplications(oSite, oAppData, oGetAppsOptions);
 
                 return objectValues(oAppData);
             }.bind(this));
@@ -399,15 +412,14 @@ sap.ui.define([
     /**
      * Manipulates the map of appData by adding all applications
      * @param {object} oSite The cdm site containing at least applications and visualizations
-     * @param {boolean} bIncludeAppsWithoutVisualizations
-     *      if set to <code>true</code>, apps without visualizations are also
-     *      included in the result (default is <code>false</code>)
-    * @param {object} oAppData The map of appData
+     * @param {object} oAppData The map of appData
+     * @param {object} oGetAppsOptions Options set from consumer
+     * @see #getApps
      *
      * @since 1.77.0
      * @private
      */
-    SearchableContent.prototype._applyCdmApplications = function (oSite, bIncludeAppsWithoutVisualizations, oAppData) {
+    SearchableContent.prototype._applyCdmApplications = function (oSite, oAppData, oGetAppsOptions) {
         var oAppsByAppId = {};
         Object.keys(oAppData).forEach(function (sKey) {
             try {
@@ -433,7 +445,7 @@ sap.ui.define([
             }
         }.bind(this));
 
-        if (bIncludeAppsWithoutVisualizations) {
+        if (oGetAppsOptions.includeAppsWithoutVisualizations) {
             // oAppData uses intents as keys - need to remap to object with appIds
             objectValues(oAppData).forEach(function (oApp) {
                 oAppsByAppId[oApp.id] = oApp;
@@ -453,11 +465,13 @@ sap.ui.define([
      * Manipulates the map of appData by adding visualizations from the cdm site
      * @param {object} oSite The cdm site containing at least applications and visualizations
      * @param {object} oAppData The map of appData
+     * @param {object} oGetAppsOptions Options set from consumer
+     * @see #getApps
      *
      * @since 1.78.0
      * @private
      */
-    SearchableContent.prototype._applyCdmVisualizations = function (oSite, oAppData) {
+    SearchableContent.prototype._applyCdmVisualizations = function (oSite, oAppData, oGetAppsOptions) {
         Object.keys(oSite.visualizations).forEach(function (sKey) {
             try {
                 var oVizReference = {
@@ -467,10 +481,12 @@ sap.ui.define([
                     displayFormatHint: DisplayFormat.Standard
                 };
                 var oVizData = readUtils.getVizData(oSite, oVizReference /*, oSystemContext*/);
-                this._changeVizType(oVizData);
-
                 var sTarget = oVizData.targetURL;
-                oVizData.preview = true;
+
+                if (oGetAppsOptions.enableVisualizationPreview) {
+                    this._changeVizType(oVizData);
+                    oVizData.preview = true;
+                }
 
                 if (sTarget) {
                     if (oAppData[sTarget]) {
@@ -494,11 +510,13 @@ sap.ui.define([
      * @param {object} oSite The cdm site containing at least applications and visualizations
      * @param {object[]} aPages The list of pages
      * @param {object} oAppData The map of appData
+     * @param {object} oGetAppsOptions Options set from consumer
+     * @see #getApps
      *
      * @since 1.77.0
      * @private
      */
-    SearchableContent.prototype._applyCdmPages = function (oSite, aPages, oAppData) {
+    SearchableContent.prototype._applyCdmPages = function (oSite, aPages, oAppData, oGetAppsOptions) {
         aPages.forEach(function (oPage) {
             var aVizReferences = readPages.getVisualizationReferences(oPage);
             aVizReferences.forEach(function (oVizReference) {
@@ -513,11 +531,12 @@ sap.ui.define([
                     }
 
                     var oVizData = readUtils.getVizData(oSite, oVizReference /*, oSystemContext*/);
-                    this._changeVizType(oVizData);
-
                     var sTarget = oVizData.targetURL;
 
-                    oVizData.preview = true;
+                    if (oGetAppsOptions.enableVisualizationPreview) {
+                        this._changeVizType(oVizData);
+                        oVizData.preview = true;
+                    }
 
                     if (sTarget) {
                         if (oAppData[sTarget]) {
@@ -546,8 +565,7 @@ sap.ui.define([
      * @private
      */
     SearchableContent.prototype._changeVizType = function (oVizData) {
-        if (oVizData._instantiationData.platform === "CDM" &&
-            !readVisualizations.isStandardVizType(oVizData.vizType)) {
+        if (oVizData._instantiationData.platform === "CDM" && !readVisualizations.isStandardVizType(oVizData.vizType)) {
             oVizData.vizType = "sap.ushell.StaticAppLauncher";
             oVizData._instantiationData.vizType = {
                 "sap.ui5": {
@@ -618,14 +636,15 @@ sap.ui.define([
     /**
      * Constructs an vizData object based on a LaunchPage tile
      * @param {object} oLaunchPageTile A LaunchPage tile
+     * @param {object} oGetAppsOptions Options set from consumer
+     * @see #getApps
      * @returns {vizData} The vizData object
      *
      * @since 1.77.0
      * @private
      */
-    SearchableContent.prototype._buildVizDataFromLaunchPageTile = function (oLaunchPageTile) {
+    SearchableContent.prototype._buildVizDataFromLaunchPageTile = function (oLaunchPageTile, oGetAppsOptions) {
         var oVizData;
-
         // Filter all tiles that cannot be launched due to a missing target
         if (this._oLaunchPageService.getCatalogTileTargetURL(oLaunchPageTile) &&
             this._oLaunchPageService.isTileIntentSupported(oLaunchPageTile)) {
@@ -657,25 +676,32 @@ sap.ui.define([
                 targetURL: this._oLaunchPageService.getCatalogTileTargetURL(oLaunchPageTile)
             };
 
-            // This is basically a test if this is an ABAP LaunchPage tile, which is not very clean.
-            // On ABAP the tiles and especially custom tiles can be displayed properly in the search
-            // as they offer a preview mode.
-            if (oLaunchPageTile.getChip) {
-                oVizData._instantiationData = {
-                    platform: "LAUNCHPAGE",
-                    launchPageTile: oLaunchPageTile
-                };
-            } else {
-                // On CDM there is no preview mode for tiles, therefore the search only displays static tiles
-                oVizData._instantiationData = {
-                    platform: "CDM",
-                    vizType: {
-                        "sap.ui5": {
-                            componentName: "sap.ushell.components.tiles.cdm.applauncher"
+            oVizData._instantiationData = {
+                platform: "LAUNCHPAGE",
+                launchPageTile: oLaunchPageTile
+            };
+
+            if (oLaunchPageTile.getContract) {
+                oLaunchPageTile.getContract("preview").setEnabled(oGetAppsOptions.enableVisualizationPreview);
+            }
+
+            if (oGetAppsOptions.enableVisualizationPreview) {
+                // This is basically a test if this is an ABAP LaunchPage tile, which is not very clean.
+                // On ABAP the tiles and especially custom tiles can be displayed properly in the search
+                // as they offer a preview mode.
+                if (!oLaunchPageTile.getChip) {
+                    // On CDM there is no preview mode for tiles, therefore the search only displays static tiles
+                    oVizData._instantiationData = {
+                        platform: "CDM",
+                        vizType: {
+                            "sap.ui5": {
+                                componentName: "sap.ushell.components.tiles.cdm.applauncher"
+                            }
                         }
-                    }
-                };
+                    };
+                }
             }
+
         }
 
         return oVizData;

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

@@ -66,7 +66,6 @@ sap.ui.define([
      * @param {object} oContainerInterface interface
      * @param {string} sParameters parameters
      * @param {object} oServiceConfiguration configuration
-     * @constructor
      * @class
      * @see sap.ushell.services.Container#getServiceAsync
      * @since 1.15.0
@@ -175,10 +174,10 @@ sap.ui.define([
         };
 
         /**
-         * Returns a string which can be put into the DOM (e.g. in a link tag)
+         * Returns a string which can be put into the DOM (e.g. in a link tag), asynchronously.
          * Please use CrossApplicationNavigation service and do not invoke this method directly if you are an application.
          *
-         * @param {Object} oArgs object encoding a semantic object and action, e.g.:
+         * @param {object} oArgs object encoding a semantic object and action, e.g.:
          *   <pre>
          *   {
          *     target: {
@@ -193,10 +192,7 @@ sap.ui.define([
          * @param {boolean} [bVerbose] whether the response should be returned in verbose format.
          *   If this flag is set to true, this function returns an object instead of a string.
          * @param {object} [oComponent] an optional instance of sap.ui.core.UIComponent
-         * @param {boolean} [bAsync] indicates whether the method should return the result asynchronously.
-         *   When set to <code>true</code>, the method returns a jQuery Deferred object that is resolved only
-         *   after the URLShortening save operation is completed.
-         * @returns {object} <p>a string that can be put into an href attribute of an HTML anchor.
+         * @returns {Promise<object>} <p>a string that can be put into a href attribute of an HTML anchor.
          *   The returned string will always start with a hash character.</p>
          *   <p>
          *   In case the <b>bVerbose</b> parameter is set to true, an object that wraps the result string will be returned instead:
@@ -213,13 +209,59 @@ sap.ui.define([
          *     <li><code>params</code> is an object containing non-truncated parameters</li>
          *     <li><code>skippedParams</code> is an object containing truncated parameters if truncation occurred or undefined if not</li>
          *   </ul>
-         * @methodOf sap.ushell.services.ShellNavigation#
+         * @memberof sap.ushell.services.ShellNavigation#
          * @name hrefForExternal
          * @since 1.15.0
          * @private
          */
-        this.hrefForExternal = function (oArgs, bVerbose, oComponent, bAsync) {
-            return this.hashChanger.hrefForExternal(oArgs, bVerbose, oComponent, bAsync);
+        this.hrefForExternal = function (oArgs, bVerbose, oComponent) {
+            return this.hashChanger.hrefForExternal(oArgs, bVerbose, oComponent);
+        };
+
+        /**
+         * Returns a string which can be put into the DOM (e.g. in a link tag), synchronously.
+         * Please use CrossApplicationNavigation service and do not invoke this method directly if you are an application.
+         *
+         * @param {object} oArgs object encoding a semantic object and action, e.g.:
+         *   <pre>
+         *   {
+         *     target: {
+         *       semanticObject: "AnObject",
+         *       action: "Action"
+         *     },
+         *     params: { A: "B" }
+         *   }
+         *   </pre>
+         *   or
+         *   <pre>{ target: { shellHash: "SO-36&jumper=postman" } } </pre>
+         * @param {boolean} [bVerbose] whether the response should be returned in verbose format.
+         *   If this flag is set to true, this function returns an object instead of a string.
+         * @param {object} [oComponent] an optional instance of sap.ui.core.UIComponent
+         * @returns {object} <p>a string that can be put into an href attribute of an HTML anchor.
+         *   The returned string will always start with a hash character.</p>
+         *   <p>
+         *   In case the <b>bVerbose</b> parameter is set to true, an object that wraps the result string will be returned instead:
+         *   <pre>
+         *   {
+         *     hash : {string},
+         *     params : {object}
+         *     skippedParams : {object}
+         *   }
+         *   </pre>
+         *   </p>
+         *   where:
+         *   <ul>
+         *     <li><code>params</code> is an object containing non-truncated parameters</li>
+         *     <li><code>skippedParams</code> is an object containing truncated parameters if truncation occurred or undefined if not</li>
+         *   </ul>
+         * @memberof sap.ushell.services.ShellNavigation#
+         * @name hrefForExternalSync
+         * @since 1.119.0
+         * @deprecated since 1.119.0 Please use {@link #hrefForExternal} instead.
+         * @private
+         */
+        this.hrefForExternalSync = function (oArgs, bVerbose, oComponent) {
+            return this.hashChanger.hrefForExternalSync(oArgs, bVerbose, oComponent);
         };
 
         /**
@@ -230,7 +272,7 @@ sap.ui.define([
          * @returns {string} a string which can be put into the link tag,
          *   containing the current shell hash as prefix and the specified application hash as suffix
          *   example: hrefForAppSpecificHash("View1/details/0/") returns "#MyApp-Display&/View1/details/0/"
-         * @methodOf sap.ushell.services.ShellNavigation#
+         * @memberof sap.ushell.services.ShellNavigation#
          * @name parseShellHash
          * @since 1.15.0
          * @private
@@ -247,7 +289,7 @@ sap.ui.define([
          * @param {Array} [aRetainedParameters] An array of string value of parameters which shall not be compacted
          *   The array may contains a *-terminated string, which will match and strings with the same prefix
          *   ( e.g. "sap-*" will match "sap-ushell", "sap-wd", "sap-" etc. )
-         * @param {Object} [oComponent] optional, a SAP UI5 Component
+         * @param {object} [oComponent] optional, a SAP UI5 Component
          * @param {boolean} [bTransient] whether an transient appstate is sufficient
          * @returns {promise} a promise, whose first argument of resolve is
          * @protected
@@ -259,16 +301,16 @@ sap.ui.define([
         /**
          * Navigate to an external target
          *
-         * @param {Object} oArgs configuration object describing the target, e.g.:
+         * @param {object} oArgs configuration object describing the target, e.g.:
          *   {
          *     target : { semanticObject : "AnObject", action: "Action" },
          *     params : { A : "B" }
          *   }
          *   constructs sth like http://....ushell#AnObject-Action?A=B ....
          *   and navigates to it.
-         * @param {Object} oComponent optional, a SAP UI5 Component
+         * @param {object} oComponent optional, a SAP UI5 Component
          * @param {boolean} bWriteHistory writeHistory whether to create a history record (true, undefined) or replace the hash (false)
-         * @returns {Promise<void>} A Promise which resolves once the navigation was triggered
+         * @returns {Promise<undefined>} A Promise which resolves once the navigation was triggered
          *
          * @private
          */
@@ -426,7 +468,7 @@ sap.ui.define([
          *
          * Use <code>Function.prototype.bind()</code> to determine the callback's <code>this</code> or some of its arguments.
          *
-         * @param {Object} fnFilter navigation filter function
+         * @param {object} fnFilter navigation filter function
          */
         this.registerNavigationFilter = function (fnFilter) {
             this.hashChanger.registerNavigationFilter(fnFilter);
@@ -445,7 +487,7 @@ sap.ui.define([
          *
          * Note the same filter function that was registered should be passed as a parameter to this method.
          *
-         * @param {Object} fnFilter navigation filter function
+         * @param {object} fnFilter navigation filter function
          */
         this.unregisterNavigationFilter = function (fnFilter) {
             this.hashChanger.unregisterNavigationFilter(fnFilter);