@sapui5/sap.ushell 1.120.8 → 1.121.0

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

@@ -2,14 +2,14 @@
 
 /**
  * @fileOverview This module deals with the instantiation of visualizations in a platform independent way.
- * @version 1.120.8
+ * @version 1.121.0
  */
 sap.ui.define([
-    "sap/ushell/services/_VisualizationInstantiation/VizInstance",
-    "sap/ushell/services/_VisualizationInstantiation/VizInstanceAbap",
-    "sap/ushell/services/_VisualizationInstantiation/VizInstanceCdm",
-    "sap/ushell/services/_VisualizationInstantiation/VizInstanceLaunchPage",
-    "sap/ushell/services/_VisualizationInstantiation/VizInstanceLink",
+    "sap/ushell/ui/launchpad/VizInstance",
+    "sap/ushell/ui/launchpad/VizInstanceAbap",
+    "sap/ushell/ui/launchpad/VizInstanceCdm",
+    "sap/ushell/ui/launchpad/VizInstanceLaunchPage",
+    "sap/ushell/ui/launchpad/VizInstanceLink",
     "sap/m/library",
     "sap/ushell/library",
     "sap/base/util/ObjectPath",
@@ -41,7 +41,7 @@ sap.ui.define([
      *
      * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
      * <code>sap.ushell.Container.getServiceAsync("VisualizationInstantiation")</code>. For details, see
-     * {@link sap.ushell.services.Container#getServiceAsync}.
+     * {@link sap.ushell.Container#getServiceAsync}.
      *
      * @hideconstructor
      *
@@ -56,7 +56,7 @@ sap.ui.define([
      *
      * @param {object} vizData VisualizationData for one single visualization
      *
-     * @returns {sap.ushell.ui.launchpad.VizInstance} A VizInstance based on the source platform
+     * @returns {sap.ushell.ui.launchpad.VizInstanceBase} A VizInstance based on the source platform
      * @since 1.77
      *
      * @private
@@ -76,6 +76,7 @@ sap.ui.define([
             indicatorDataSource: vizData.indicatorDataSource,
             dataSource: vizData.dataSource,
             contentProviderId: vizData.contentProviderId,
+            contentProviderLabel: vizData.contentProviderLabel,
             vizConfig: vizData.vizConfig,
             supportedDisplayFormats: vizData.supportedDisplayFormats,
             displayFormat: vizData.displayFormatHint,
@@ -95,24 +96,23 @@ sap.ui.define([
             sPlatform = "LINK";
         }
 
-        switch (sPlatform) {
-            case "ABAP":
-                oVizInstance = new VizInstanceAbap(oVizInstanceData);
-                break;
-            case "CDM":
-                oVizInstance = new VizInstanceCdm(oVizInstanceData);
-                break;
-            case "LINK":
-                oVizInstance = new VizInstanceLink(oVizInstanceData);
-                break;
-            case "LAUNCHPAGE":
-                // own visualization type for search application through SearchableContent service
-                oVizInstance = new VizInstanceLaunchPage(oVizInstanceData);
-                break;
-            default:
-                return new VizInstance({
-                    state: LoadState.Failed
-                });
+        if (sPlatform === "ABAP") {
+            oVizInstance = new VizInstanceAbap(oVizInstanceData);
+        } else if (sPlatform === "CDM") {
+            oVizInstance = new VizInstanceCdm(oVizInstanceData);
+        } else if (sPlatform === "LINK") {
+            oVizInstance = new VizInstanceLink(oVizInstanceData);
+        }
+        /**
+         * @deprecated As of version 1.120
+         */
+        if (sPlatform === "LAUNCHPAGE") {
+            oVizInstance = new VizInstanceLaunchPage(oVizInstanceData);
+        }
+        if (!oVizInstance) {
+            return new VizInstance({
+                state: LoadState.Failed
+            });
         }
 
         // we need to set these properties separately because it is likely that they contain stringified objects
@@ -172,6 +172,7 @@ sap.ui.define([
         delete oVizInstanceData.instantiationData;
         delete oVizInstanceData.dataSource;
         delete oVizInstanceData.contentProviderId;
+        delete oVizInstanceData.contentProviderLabel;
         delete oVizInstanceData.vizConfig;
         delete oVizInstanceData.numberUnit;
         delete oVizInstanceData.indicatorDataSource;

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.120.8
+ * @version 1.121.0
  */
 sap.ui.define([
 ], function () {

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

@@ -27,7 +27,7 @@
  *
  * @private
  *
- * @version 1.120.8
+ * @version 1.121.0
  */
 sap.ui.define([
 "sap/base/util/ObjectPath",
@@ -38,7 +38,7 @@ sap.ui.define([
     /**
      * Returns all the inbounds.
      *
-     * @returns {array}
+     * @returns {object[]}
      *   An array containing all the known inbounds
      */
     function getAllInbounds () {
@@ -51,7 +51,7 @@ sap.ui.define([
      * @param {string} sSemanticObject
      *   The semantic object
      *
-     * @returns {array}
+     * @returns {object[]}
      *   An array of inbounds
      */
     function getSegment (sSemanticObject) {
@@ -64,10 +64,10 @@ sap.ui.define([
     /**
      * Returns a union of the segments in the specified tag set.
      *
-     * @param {array} aTags
+     * @param {string[]} aTags
      *   The tags to obtain the group from.
      *
-     * @returns {array}
+     * @returns {object[]}
      *   A list representing union of the inbounds in the specified tag set.
      */
     function getSegmentByTags (aTags) {
@@ -131,7 +131,7 @@ sap.ui.define([
     /**
      * Creates an index of the given inbounds.
      *
-     * @param {array} aInbounds
+     * @param {object[]} aInbounds
      *   An array of inbounds to be indexed.
      *
      * @param {object} oApplyTagsFn

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.120.8
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/ushell/services/_ClientSideTargetResolution/VirtualInbounds",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/ParameterMapping.js

@@ -50,7 +50,7 @@ sap.ui.define([
      * @param {object} oSignature
      *   The signature object that may contain a mapping for
      *   <code>sParamName</code>
-     * @param {array} aParamValue
+     * @param {Array<*>} aParamValue
      *   The value of <code>sParamName</code> into an array (as one
      *   parameter may have multiple values).
      *

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.120.8
+ * @version 1.121.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.120.8
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/ushell/utils",
@@ -344,7 +344,7 @@ sap.ui.define([
      * Update oMissingReferenceOut (containing filter user defaults)
      * with any default parameters that were found during defaulting.
      *
-     * @param {array} aReferenceIfMatch
+     * @param {string[]} aReferenceIfMatch
      *     The user default references that must be added to
      *     <code>oUserDefaultRefsOut</code> if the match occurred
      * @param {object} oMissingReferenceOut
@@ -489,13 +489,13 @@ sap.ui.define([
              * g: generic  x: explicit/exact semantic object (NOTE: "x" > "g")
              */
             oMatchResult.genericSO ? "g" : "x",
-            /**
+            /*
              * Techmatch: whether the technology is explicitly specified
              * and matches (1) or not (0)
              *
              */
             "TECM=" + calculateTechnologyMatch(oMatchResult),
-            /**
+            /*
              * Number of matching parameters.
              *
              * Number of inbound parameters that match the intent. For
@@ -620,7 +620,7 @@ sap.ui.define([
      *    oIntent.treatTechHintAsFilter is truthy, only
      *    inbounds with matching technology are considered
      *
-     * @param {array} aInbounds
+     * @param {object[]} aInbounds
      *    List of inbound items
      * @param {object} oKnownReferences
      *    An input parameter used during the matching procedure to resolve
@@ -629,9 +629,7 @@ sap.ui.define([
      *    The function to get list providers with the list of compatible data origins
      * @param {boolean} bDebugEnabled
      *    Whether should include debugging information
-     * @returns {jQuery.Deferred.Promise}
-     *
-     * A jQuery promise, that always resolves to the following match result
+     * @returns {jQuery.Promise} Always resolves to the following match result
      * structure:
      *
      * <pre>
@@ -732,7 +730,7 @@ sap.ui.define([
      * @param {object} oInbound inbound
      * @param {object} oIntentParamsPlusAllDefaults intent parameters with default parameters
      * @param {object} oIntentParams intent parameters without default parameters
-     * @param {array} aDefaultedParameterNames list of the default parameters
+     * @param {Array<*>} aDefaultedParameterNames list of the default parameters
      * @param {boolean} bAdditionalParametersIgnored true if the additional parameters are ignored
      *
      * @returns {InboundStats} Inbound statistic based on the intent parameters

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.120.8
+ * @version 1.121.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.120.8
+ * @version 1.121.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.120.8
+ * @version 1.121.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.120.8
+ * @version 1.121.0
  */
 sap.ui.define([], function () {
     "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.120.8
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/ushell/services/_ClientSideTargetResolution/Utils",
@@ -66,7 +66,7 @@ sap.ui.define([
      *
      * @param {object} oMatchingTarget One of the objects returned by {@link #_getMatchingInbounds}.
      * @param {object} oAppStateService the app state service instance
-     * @returns {object} jQuery promise
+     * @returns {jQuery.Promise} Resolves the mixed resolution result.
      * @private
      * @since 1.34.0
      */

package/src/main/js/sap/ushell/services/_CommonDataModel/PersonalizationProcessor.js

@@ -33,7 +33,7 @@ sap.ui.define([
      * "item" must be an object with existing "item.id" (like in tiles or links), which will
      * be compared against "sItemId".
      *
-     * @param {Array} aItemArray
+     * @param {object[]} aItemArray
      *   An array of "items" as described before.
      * @param {string} sItemId
      *   ID of the item, which position should be returned.
@@ -131,8 +131,7 @@ sap.ui.define([
      * @param {object} oPersonalizationDelta
      *  Personalization delta
      *
-     * @returns {Promise}
-     *    jQuery promise that is resolved with a copy of oOriginalSite with mixed-in personalization.
+     * @returns {jQuery.Promise} Resolves a copy of oOriginalSite with mixed-in personalization.
      *
      * @see #extractPersonalization
      * @private
@@ -471,8 +470,7 @@ sap.ui.define([
      * @param {object} oOriginalSite
      *   Site without personalization
      *
-     * @returns {Promise}
-     *    jQuery promise that is resolved with personalization delta
+     * @returns {jQuery.Promise} Resolves the personalization delta.
      */
     PersonalizationProcessor.prototype.extractPersonalization = function (oPersonalizedSite, oOriginalSite) {
         var oDeferred = new jQuery.Deferred(),
@@ -1128,9 +1126,9 @@ sap.ui.define([
     /**
      * Sets order of items (tiles, links) in original site object as determined by ITEMOrder array, if any.
      *
-     * @param {Array} aOriginalSiteItems
+     * @param {object[]} aOriginalSiteItems
      *   The ITEMS array of a certain group in the original site object (e.g. "payload.tiles" or "payload.links").
-     * @param {Array} aItemOrder
+     * @param {string[]} aItemOrder
      *   The ITEMOrder array for that group, got from personalization delta (e.g. "payload.tileOrder" or "payload.linkOrder").
      *
      * @returns {boolean}

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.120.8
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/base/Log"
@@ -152,7 +152,7 @@ sap.ui.define([
     /**
      * Creates from all the tiles in a group object into a sections object which is needed in the CDM 3.1 page
      *
-     * @param {array} aTiles All tiles in a site object of one page
+     * @param {object[]} aTiles All tiles in a site object of one page
      * @returns {object} An object for the CDM 3.1 page of sections
      * @since 1.75
      * @private

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

@@ -0,0 +1,105 @@
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
+
+/**
+ * @file Utility for loading the default visualization types for the CDM runtime.
+ * @version 1.121.0
+ */
+
+sap.ui.define([
+    "sap/base/Log",
+    "sap/ui/core/Manifest",
+    "sap/base/util/deepClone",
+    "sap/base/util/extend",
+    "sap/base/util/isEmptyObject",
+    "sap/base/util/ObjectPath"
+], function (
+    Log,
+    Manifest,
+    deepClone,
+    extend,
+    isEmptyObject,
+    ObjectPath
+) {
+
+    "use strict";
+
+    const O_STANDARD_VIZ_TYPES = {
+        STATIC_LAUNCHER: "sap.ushell.StaticAppLauncher",
+        DYNAMIC_LAUNCHER: "sap.ushell.DynamicAppLauncher",
+        CARD: "sap.ushell.Card"
+    };
+
+    class VizTypeDefaults {
+
+        static #instance = null;
+        #oVizTypes = null;
+
+        /**
+         * Gets all default viz types.
+         * <p>
+         * This method MAY be used without a running ushell container.
+         *
+         * @returns {Promise<object>}
+         *   An object of default viz types, keys are the viz type IDs.
+         *
+         * @private
+         * @since 1.121.0
+         */
+        static async getAll () {
+            if (!VizTypeDefaults.#instance) {
+                VizTypeDefaults.#instance = new VizTypeDefaults();
+            }
+
+            return VizTypeDefaults.#instance._getAll();
+        }
+
+        /**
+         * Gets all viz types
+         * @returns {Promise<object>} Resolves with an object of viz types
+         *
+         * @since 1.121.0
+         * @private
+         */
+        async _getAll () {
+            if (!this.#oVizTypes) {
+                this.#oVizTypes = {};
+                const oStandardManifests = {};
+                oStandardManifests[O_STANDARD_VIZ_TYPES.STATIC_LAUNCHER] = "sap/ushell/components/tiles/cdm/applauncher/manifest.json";
+                oStandardManifests[O_STANDARD_VIZ_TYPES.DYNAMIC_LAUNCHER] = "sap/ushell/components/tiles/cdm/applauncherdynamic/manifest.json";
+                oStandardManifests[O_STANDARD_VIZ_TYPES.CARD] = "sap/ushell/services/_CommonDataModel/vizTypeDefaults/cardManifest.json";
+
+                await Promise.all(Object.keys(oStandardManifests).map(async (sVizType) => {
+                    const sManifestUrl = oStandardManifests[sVizType];
+                    const oManifest = await this._loadManifest(sManifestUrl);
+                    this.#oVizTypes[sVizType] = oManifest;
+                }));
+            }
+
+            return this.#oVizTypes;
+        }
+
+        /**
+         * Loads the manifest
+         * @param {string} sUrl
+         * path to the manifest e.g. "sap/ushell/components/tiles/cdm/applauncher/manifest.json"
+         * @returns {Promise<object>} Resolves the manifest
+         *
+         * @since 1.121.0
+         * @private
+         */
+        async _loadManifest (sUrl) {
+            const sManifestUrl = sap.ui.require.toUrl(sUrl);
+
+            const oManifest = await Manifest.load({
+                manifestUrl: sManifestUrl,
+                async: true
+            });
+
+            // we need to clone the object since the original is read only
+            // in addition we want to avoid inconsistencies
+            return deepClone(oManifest.getRawJson());
+        }
+    }
+
+    return VizTypeDefaults;
+});

package/src/main/js/sap/ushell/services/_ContentExtensionAdapterFactory/ContentExtensionAdapterConfig.js

@@ -7,7 +7,7 @@
  *  config handler which is called by the factory to generate an explicit
  *  Adapter configuration
  *
- * @version 1.120.8
+ * @version 1.121.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/services/_ContentExtensionAdapterFactory/FeaturedGroupConfig.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Provide mock feature group data
  *
- * @version 1.120.8
+ * @version 1.121.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/services/_CrossApplicationNavigation/utils.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview Cross Application Navigation utility functions
  *
- * @version 1.120.8
+ * @version 1.121.0
  * @deprecated since 1.120.0
  */
 

package/src/main/js/sap/ushell/services/_MessageBroker/MessageBrokerEngine.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module contains the implementation of the message broker
- * @version 1.120.8
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -144,7 +144,7 @@ sap.ui.define([
         /**
          *
          * @param {string} sClientId client id.
-         * @param {array} aSubscribedChannels array of channel-objects.
+         * @param {Array<*>} aSubscribedChannels array of channel-objects.
          * @param {function} fnMessageCallback callback function returns promise.
          * @param {function} fnClientConnectionCallback callback function returns promise.
          * @param {object} oIframe iframe object if iframe client.
@@ -278,7 +278,7 @@ sap.ui.define([
         /**
          *
          * @param {string} sClientId client id.
-         * @param {array} aUnsubscribedChannels channels to unsubscribe from.
+         * @param {object[]} aUnsubscribedChannels channels to unsubscribe from.
          * @returns {Promise} the resolve or error.
          *
          * @since 1.110.0
@@ -344,7 +344,7 @@ sap.ui.define([
          * @param {string} sClientId client id.
          * @param {string} sMessageId request id for iframe clients or message id for UI5 clients.
          * @param {string} sMessageName message name.
-         * @param {array} aTargetClientIds array of target clients Ids.
+         * @param {string[]} aTargetClientIds array of target clients Ids.
          * @param {object} data additional data.
          * @returns {Promise} Promise result.
          *
@@ -455,7 +455,7 @@ sap.ui.define([
 
         /**
          *
-         * @returns {array} the result.
+         * @returns {string[]} the result.
          *
          * @since 1.110.0
          * @private
@@ -487,7 +487,7 @@ sap.ui.define([
          *
          * @param {string} sMessageName message name.
          * @param {string} sClientId client id.
-         * @param {array} aChannels subscribed/unsubscribed channels of the client.
+         * @param {Array<*>} aChannels subscribed/unsubscribed channels of the client.
          *
          * @since 1.110.0
          * @private
@@ -530,7 +530,7 @@ sap.ui.define([
 
         /**
          *
-         * @param {array} aTargetClients target clients.
+         * @param {object[]} aTargetClients target clients.
          * @param {string} sChannelId channel id.
          * @param {string} sMessageId request id for iframe clients or message id for UI5 clients.
          * @param {string} sMessageName message name.
@@ -568,7 +568,7 @@ sap.ui.define([
         /**
          *
          * @param {string} sEndpoint api method name.
-         * @param {array} aParams api parameters.
+         * @param {Array<*>} aParams api parameters.
          * @returns {Promise} Promise result.
          *
          * @since 1.110.0

package/src/main/js/sap/ushell/services/_PageReferencing/PageReferencer.js

@@ -4,7 +4,7 @@
  * @file This module is responsible to create reference pages,
  * which are shareable JSON representations of layout and navigation targets in the specific format.
  *
- * @version 1.120.8
+ * @version 1.121.0
  * @private
  */
 sap.ui.define([