@sapui5/sap.ushell 1.113.0 → 1.115.0

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileoverview The NavTargetResolution adapter for SAP MyHome
- * @version 1.113.0
+ * @version 1.115.0
  */
 
 sap.ui.define([

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

@@ -2,7 +2,7 @@
 /**
  * @fileOverview The Unified Shell's Search adapter for myHome.
  *
- * @version 1.113.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -22,7 +22,7 @@ sap.ui.define([
      * @param {object} oSystem  The system served by the adapter
      * @param {string} sParameters Parameter string, not in use (legacy, was used before oAdapterConfiguration was added)
      * @param {object} oConfig A potential Adapter Configuration
-     * @constructor
+     * @class
      *
      * @since 1.101.0
      * @private

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

@@ -0,0 +1,264 @@
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
+/**
+ * @fileOverview The Unified Shell's Search adapter for CEP applications (client-side search).
+ *
+ * @version 1.115.0
+ */
+sap.ui.define([
+    "sap/ushell/utils/UrlParsing",
+    "sap/ui/model/json/JSONModel",
+    "sap/ui/model/Filter",
+    "sap/ui/model/Sorter"
+], function (
+    UrlParsing,
+    JSONModel,
+    Filter,
+    Sorter
+) {
+    "use strict";
+    /**
+     * The Unified Shell's Search adapter for SAP Start (client-side search).
+     * This constructor will be initialized when requesting the corresponding service.
+     * Do NOT initialize directly.
+     *
+     * @param {object} oSystem  The system served by the adapter
+     * @param {string} sParameters Parameter string, not in use (legacy, was used before oAdapterConfiguration was added)
+     * @param {object} oConfig A potential Adapter Configuration
+     * @class
+     *
+     * @since 1.115.0
+     * @private
+     */
+    var SearchCEPApplicationAdapter = function (oSystem, sParameters, oConfig) {
+    };
+
+    /**
+     * Searching applications via the a client side search service.
+     * @param {string} sQuery The query string to search.
+     *
+     * @returns {Promise} Promise resolving the search result (array of application objects)
+     *
+     * @private
+     * @since 1.115.0
+     */
+    SearchCEPApplicationAdapter.prototype.execSearch = function (sQuery) {
+        return this.search({
+            searchTerm: sQuery
+        }).then(function (oResult) {
+            var aApplications = oResult.data.map(function (oResultData) {
+                // return semantic object and action for compatibility with navigation service resonse
+                // should be changed in SearchCEP controller and always navigate by URL (currently, parameters are ignored)
+                var sParsedShellHash = UrlParsing.parseShellHash(oResultData.url);
+                return {
+                    text: oResultData.label,
+                    icon: oResultData.icon,
+                    url: oResultData.url,
+                    semanticObject: sParsedShellHash && sParsedShellHash.semanticObject,
+                    semanticObjectAction: sParsedShellHash && sParsedShellHash.action
+                };
+            });
+            return {
+                applications: aApplications
+            };
+        });
+    };
+
+     /**
+     * Searching applications via the a client side search service.
+     *
+     * @param {object} oParameters The parameters for the search
+     * @param {string} oParameters.searchTerm The search term
+     * @param {int} [oParameters.skip] (optional) the specified number of results are skipped.
+     * @param {int} [oParameters.top]
+     *                  (optional) only the specified top (first) results are returned.
+     * @param {object|sap.ui.model.Filter} [oParameters.filter] (optional) the filter json configuration or Filter object.
+     *    Defined as json (expected by sap.ui.model.Filter) or as a sap.ui.model.Filter instance
+     * @param {object|sap.ui.model.Sorter} [oParameters.sort] (optional) the sorter json configuration or Sorter object
+     *    Defined as json (expected by sap.ui.model.Sorter) or as a sap.ui.model.Sorter instance
+     *
+     * @returns {Promise} Promise resolving the search result (array of application objects)
+     *
+     * @private
+     * @since 1.115.0
+     */
+    SearchCEPApplicationAdapter.prototype.search = function (oParameters) {
+        return this._searchWithSearchableContentAndJsSearch(oParameters);
+    };
+
+    /*
+     * Search using the SearchableContent service and the jsSearch implementation
+     */
+    SearchCEPApplicationAdapter.prototype._searchWithSearchableContentAndJsSearch = function (oParameters) {
+
+        return Promise.all([this._getNormalizedSearchableContentApps(), this._loadJsSearchModule()]).then(function (aPromiseResults) {
+            var aNormalizedSearchableContentApps = aPromiseResults[0];
+            var JsSearch = aPromiseResults[1];
+            var oSearchEngine = new JsSearch({
+                objects: aNormalizedSearchableContentApps,
+                fields: ["text", "title", "keywords"],
+                shouldNormalize: !String.prototype.normalize,
+                algorithm: {
+                    id: "contains-ranked",
+                    options: [50, 49, 40, 39, 5, 4, 51]
+                }
+            });
+            var oSearchOptions = {
+                searchFor: oParameters && oParameters.searchTerm || "*", // set wildcard if no search term specified
+                top: Number.MAX_SAFE_INTEGER, // apply pagination after search due to filtering
+                skip: 0
+            };
+            var oSearchResult = oSearchEngine.search(oSearchOptions);
+            var aResultData = oSearchResult.results.map(function (o) {
+                return o.object;
+            });
+
+            return this._getPaginatedResult(
+                this._applyFiltersAndSorter(aResultData, oParameters.filter, oParameters.sort),
+                oParameters.skip || 0,
+                oParameters.top || 10
+            );
+
+        }.bind(this));
+    };
+
+    SearchCEPApplicationAdapter.prototype._getPaginatedResult = function (aResultData, iSkip, iTop) {
+        return {
+            data: aResultData.slice(iSkip, iSkip + iTop),
+            count: aResultData.length
+        };
+    };
+
+    SearchCEPApplicationAdapter.prototype._getSearchableContent = function () {
+        return sap.ushell.Container.getServiceAsync("SearchableContent")
+            .then(function (oService) {
+                return oService.getApps();
+            });
+    };
+
+    SearchCEPApplicationAdapter.prototype._getNormalizedSearchableContentApps = function () {
+        return this._getSearchableContent().then(function (aApps) {
+            return this._normalizeSearchableContentServiceResult(aApps);
+        }.bind(this));
+    };
+
+    SearchCEPApplicationAdapter.prototype._normalizeSearchableContentServiceResult = function (aApps) {
+        if (!Array.isArray(aApps)) {
+            aApps = [];
+        }
+        var aResultApps = [];
+        aApps.forEach(function (oApp) {
+            oApp.visualizations.forEach(function (oVis) {
+                var label = oVis.title;
+                if (oVis.subtitle) {
+                    label = label + " - " + oVis.subtitle;
+                }
+                aResultApps.push({
+                    title: (oVis.vizConfig && oVis.vizConfig["sap.app"] && oVis.vizConfig["sap.app"].title) || oVis.title || oApp.title,
+                    description: (oVis.vizConfig && oVis.vizConfig["sap.app"] && oVis.vizConfig["sap.app"].subTitle) || oVis.subtitle || oApp.subtitle,
+                    keywords: Array.isArray(oVis.keywords) ? oVis.keywords.join(" ") : "",
+                    icon: oVis.icon || "",
+                    label: label,
+                    visualization: oVis,
+                    url: oVis.targetURL,
+                    technicalAttributes: Array.isArray(oApp.technicalAttributes) ? oApp.technicalAttributes.join(" ") : ""
+                });
+            });
+        });
+        return aResultApps;
+    };
+
+    SearchCEPApplicationAdapter.prototype._loadJsSearchModule = function () {
+
+        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 () {
+                sap.ui.require(["sap/esh/search/ui/appsearch/JsSearch"], function (JsSearch) {
+                    resolve(JsSearch);
+                });
+            });
+        });
+
+        return this._loadJsSearchModulePromise;
+    };
+
+    /**
+     * Creates an array of sap.ui.model.Filter instances from the given configuration.
+     *
+     * @param {object|sap.ui.model.Filter} vFilters the filter json configuration or Filter object.
+     *    Defined as json (expected by sap.ui.model.Filter) or as a sap.ui.model.Filter instance
+     * @returns {sap.ui.model.Filter[]} Array or filter instances
+     *
+     * @private
+     * @since 1.115.0
+     */
+     SearchCEPApplicationAdapter.prototype._createFilters = function (vFilters) {
+        var aFilters = null;
+        if (vFilters) {
+            if (typeof vFilters === "object") {
+                if (Array.isArray(vFilters.filters)) {
+                    vFilters.filters = vFilters.filters.map(function (oFilter) {
+                        return oFilter instanceof Filter ? oFilter : new Filter(oFilter);
+                    });
+                }
+                aFilters = [vFilters instanceof Filter ? vFilters : new Filter(vFilters)];
+            }
+        }
+        return aFilters;
+    };
+
+    /**
+     * Creates an array of sap.ui.model.Sorter instances from the given configuration.
+     *
+     * @param {object|sap.ui.model.Sorter} vSorter the sorter json configuration or Sorter object
+     *    Defined as json (expected by sap.ui.model.Sorter) or as a sap.ui.model.Sorter instance
+     * @returns {sap.ui.model.Sorter[]} Array or sorter instances
+     *
+     * @private
+     * @since 1.115.0
+     */
+    SearchCEPApplicationAdapter.prototype._createSorters = function (vSorter) {
+        var aSorters = null;
+        if (vSorter) {
+            if (typeof vSorter === "object" && !Array.isArray(vSorter)) {
+                vSorter = [vSorter];
+            }
+            if (Array.isArray(vSorter)) {
+                aSorters = vSorter.map(function (oSorter) {
+                    return oSorter instanceof Sorter ? oSorter : new Sorter(oSorter);
+                });
+            }
+        }
+        return aSorters;
+    };
+
+    /**
+     * Applies filters and sorters to given data.
+     * The maximum number of data to be filtered and sorted is Number.MAX_SAFE_INTEGER
+     *
+     * @param {object[]} aData the data to be filtered and/or sorted
+     * @param {object|sap.ui.model.Filter} vFilters the filter json configuration or Filter object.
+     *    Defined as json (expected by sap.ui.model.Filter) or as a sap.ui.model.Filter instance
+     * @param {object|sap.ui.model.Sorter} vSorter the sorter json configuration or Sorter object
+     *    Defined as json (expected by sap.ui.model.Sorter) or as a sap.ui.model.Sorter instance
+     * @returns {object[]} The filtered and sorted data array
+     *
+     * @private
+     * @since 1.115.0
+     */
+    SearchCEPApplicationAdapter.prototype._applyFiltersAndSorter = function (aData, vFilters, vSorter) {
+        if (!vFilters && !vSorter) {
+            return aData;
+        }
+        var aFilters = this._createFilters(vFilters),
+            aSorters = this._createSorters(vSorter),
+            oModel = new JSONModel();
+        oModel.setSizeLimit(Number.MAX_SAFE_INTEGER);
+        oModel.setData(aData);
+        return oModel.bindList("/", null, aSorters, aFilters).getContexts().map(function (oContext) {
+            return oContext.getObject();
+        });
+    };
+
+    return SearchCEPApplicationAdapter;
+}, false);

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.113.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/ushell/utils/HttpClient",

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.113.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

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

@@ -5,7 +5,7 @@
  *   TODO will be replaced by true persistence within this SP!
  *   This adapter delegates to the Personalization Adapter
  *
- * @version 1.113.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/ushell/services/_AppState/AppStatePersistencyMethod",

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's ClientSideTargetResolutionAdapter for the local
  *               platform.
  *
- * @version 1.113.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

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

@@ -2,7 +2,7 @@
 /**
  * @fileOverview The Unified Shell's container adapter for standalone demos.
  *
- * @version 1.113.0
+ * @version 1.115.0
  */
 /**
  * @namespace Default namespace for Unified Shell adapters for standalone demos. They can usually

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's page builder adapter for the 'demo' platform.
  *
  * @deprecated since 1.100
- * @version 1.113.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The NavTargetResolution adapter for the demo platform.
- * @version 1.113.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/ushell/services/_ClientSideTargetResolution/VirtualInbounds",

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's page builder adapter for the 'demo' platform.
  * It creates chip instances from chip raw data. Compared to the other platforms this adapter has restricted functionality.
- * @version 1.113.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/ui/core/ComponentContainer",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview PagePersistenceAdapter for the local platform.
- * @version 1.113.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/ushell/utils",

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

@@ -6,7 +6,7 @@
  *
  * The local personalization adapter can be configured to store data either in
  * the local storage (default) or in memory.
- * @version 1.113.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/ushell/utils",

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

@@ -2,7 +2,7 @@
 /**
  * @fileOverview The Search adapter for the demo platform.
  *
- * @version 1.113.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery"
@@ -17,13 +17,11 @@ sap.ui.define([
     var SearchAdapter = function (oSystem, sParameter, oAdapterConfiguration) {
 
         this.isSearchAvailable = function () {
-            var oDeferred = jQuery.Deferred();
-            oDeferred.resolve(true);
-            return oDeferred.promise();
+            return Promise.resolve(true);
         };
     };
 
 
 	return SearchAdapter;
 
-}, /* bExport= */ false);
+});

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's Search adapter for myHome.
  *
- * @version 1.113.0
+ * @version 1.115.0
  */
 /*eslint-disable quote-props*/
 sap.ui.define([], function () {

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The SupportTicket adapter for the local platform.
  *
- * @version 1.113.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery"
@@ -12,13 +12,10 @@ sap.ui.define([
 
     var SupportTicketAdapter = function (oSystem, sParameter, oAdapterConfiguration) {
         this.createTicket = function (oSupportObject) {
-            var oDeferred = new jQuery.Deferred(),
-                sTicketId = "1234567";
-
-            oDeferred.resolve(sTicketId);
-            return oDeferred.promise();
+            var sTicketId = "1234567";
+            return Promise.resolve(sTicketId);
         };
     };
 
     return SupportTicketAdapter;
-}, /* bExport= */ false);
+});

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's Ui5ComponentLoaderAdapter for the local platform
  *
- * @version 1.113.0
+ * @version 1.115.0
  */
 sap.ui.define([
 ], function () {

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

@@ -6,7 +6,7 @@
  *               TODO will be replaced by true persistence within this SP!
  *               This adapter delegates to the Personalization Adapter
  *
- * @version 1.113.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The UserInfo adapter for the demo platform.
- * @version 1.113.0
+ * @version 1.115.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

package/src/main/js/sap/ushell/appRuntime/ui5/AppCommunicationMgr.js

@@ -209,7 +209,7 @@ sap.ui.define([
             }
         };
 
-        this.sendMessageToOuterShell = function (sMessageId, oParams, sRequestId) {
+        this.sendMessageToOuterShell = function (sMessageId, oParams, sRequestId, nTimeout, oDefaultVal) {
             var oDeferred = new jQuery.Deferred(),
                 oMsg = {
                     type: "request",
@@ -220,6 +220,11 @@ sap.ui.define([
 
             this.postMessage(oMsg);
             arrPostResultPromises[oMsg.request_id] = oDeferred;
+            if (nTimeout) {
+                setTimeout(function () {
+                    oDeferred.resolve(oDefaultVal);
+                }, nTimeout);
+            }
             return oDeferred.promise();
         };