@sapui5/sap.ushell 1.120.7 → 1.121.0

package/src/main/js/sap/ushell/ui5service/UserStatus.js

@@ -3,16 +3,8 @@
 /**
  * @fileOverview The UserStatus UI5 service
  *
- * @version 1.120.7
+ * @version 1.121.0
  */
-
-/**
- * @namespace sap.ushell.ui5service.UserStatus
- *
- * @public
- * @deprecated since 1.70. Support for this service has been discontinued.
- */
-
 sap.ui.define([
     "sap/ui/core/service/ServiceFactoryRegistry",
     "sap/ui/core/service/ServiceFactory",
@@ -26,7 +18,14 @@ sap.ui.define([
         serviceStateChanged: "serviceStateChanged"
     };
 
-    var UserStatus = Service.extend("sap.ushell.ui5service.UserStatus", /** @lends sap.ushell.ui5service.UserStatus# */ {
+    /**
+     * @alias sap.ushell.ui5service.UserStatus
+     * @class
+     *
+     * @public
+     * @deprecated since 1.70. Support for this service has been discontinued.
+     */
+    var UserStatus = Service.extend("sap.ushell.ui5service.UserStatus", /** @lends sap.ushell.ui5service.UserStatus.prototype */ {
         init: function () {
             // Service injection
             UserStatus.prototype.isEnabled = false;
@@ -58,7 +57,7 @@ sap.ui.define([
      * If the user already agreed to share their online status, the setStatus method will be called with the default online status that was set by the user.
      * If the user already declined to share their online status, the setStatus method will be called with a null value.
      *
-     * @param {variant} bEnable boolean.
+     * @param {boolean} bEnable boolean.
      * @since 1.46
      * @public
      * @deprecated since 1.70
@@ -80,7 +79,7 @@ sap.ui.define([
      *   2) the status is null or exists in the list of available statuses (sap.ushell.ui5service.UserStatus.prototype.AvailableStatus)
      *   3) the user has agreed to share their online status
      *
-     * @param {variant} oNewStatus sap.ushell.ui5service.UserStatus.prototype.AvailableStatus
+     * @param {object} oNewStatus sap.ushell.ui5service.UserStatus.prototype.AvailableStatus
      * @since 1.46
      * @public
      * @deprecated since 1.70

package/src/main/js/sap/ushell/ui5service/_ShellUIService/shelluiservice.class.factory.js

@@ -45,7 +45,7 @@ sap.ui.define([
          * Instead, this service should be consumed by app components as described
          * in the overview section of this class.
          *
-         * @name sap.ushell.ui5service.ShellUIService
+         * @alias sap.ushell.ui5service.ShellUIService
          * @class
          *
          * @classdesc The Unified Shell's ShellUIService service.
@@ -72,7 +72,7 @@ sap.ui.define([
          * <pre>
          * // Component.js (the app root component)
          * ...
-         * this.getServiceAsync("ShellUIService").then( // promise is returned
+         * this.getService("ShellUIService").then( // promise is returned
          *    function (oService) {
          *       oService.setTitle("Application Title");
          *    },
@@ -130,11 +130,9 @@ sap.ui.define([
          * @extends sap.ui.core.service.Service
          * @since 1.38.0
          */
-        var ShellUIService = Service.extend("sap.ushell.ui5service.ShellUIService", /** @lends sap.ushell.ui5service.ShellUIService# */ {
+        var ShellUIService = Service.extend("sap.ushell.ui5service.ShellUIService", /** @lends sap.ushell.ui5service.ShellUIService.prototype */ {
             init: function () {
-                /*
-                 * Service injection
-                 */
+                // Service injection
                 var that = this;
                 var oPublicInterface = this.getInterface();
 
@@ -178,7 +176,7 @@ sap.ui.define([
             _getActiveComponentId: function () {
                 return sActiveComponentId;
             },
-            /*
+            /**
              * Determines whether the hierarchy should be set automatically
              * using the UI5 router for the given App component.
              *
@@ -196,7 +194,7 @@ sap.ui.define([
                 return typeof oAppComponent.getManifestEntry === "function"
                     && oAppComponent.getManifestEntry("/sap.ui5/services/ShellUIService/settings/setHierarchy") === "auto";
             },
-            /*
+            /**
              * Determines whether the title should be set automatically using the
              * UI5 router for the given App component.
              *

package/src/main/js/sap/ushell/utils/DynamicTileRequest.js

@@ -4,6 +4,7 @@
  */
 
 sap.ui.define([
+    "sap/base/i18n/Localization",
     "sap/ushell/utils/HttpClient",
     "sap/ui/thirdparty/URI",
     "sap/base/util/isEmptyObject",
@@ -14,6 +15,7 @@ sap.ui.define([
     "sap/ushell/EventHub",
     "sap/ushell/utils"
 ], function (
+    Localization,
     HttpClient,
     URI,
     isEmptyObject,
@@ -184,7 +186,7 @@ sap.ui.define([
 
             // Adding a query parameter triggers the encoding of the whole query string.
             // Therefore, append the additional parameters as late as possible to avoid encoding the placeholders.
-            const sSAPLogonLanguage = Configuration.getSAPLogonLanguage();
+            const sSAPLogonLanguage = Localization.getSAPLogonLanguage();
             if (sSAPLogonLanguage && !oUri.hasQuery("sap-language")) {
                 oUri.addQuery("sap-language", sSAPLogonLanguage);
             }
@@ -372,11 +374,11 @@ sap.ui.define([
                 "Cache-Control": "no-cache, no-store, must-revalidate",
                 Pragma: "no-cache",
                 Expires: "0",
-                "Accept-Language": Configuration.getLanguage() || "",
+                "Accept-Language": Localization.getLanguage() || "",
                 Accept: "application/json, text/plain"
             };
 
-            const sSAPLogonLanguage = Configuration.getSAPLogonLanguage();
+            const sSAPLogonLanguage = Localization.getSAPLogonLanguage();
             if (sSAPLogonLanguage) {
                 oHeaders["sap-language"] = sSAPLogonLanguage;
             }

package/src/main/js/sap/ushell/utils/HttpClient.js

@@ -30,10 +30,10 @@
  *
  */
 sap.ui.define([
-    "sap/ui/core/Configuration",
+    "sap/ui/core/Supportability",
     "sap/ui/thirdparty/URI",
     "sap/ushell/utils"
-], function (Configuration, URI, utils) {
+], function (Supportability, URI, utils) {
     "use strict";
 
     // JSDoc Type definitions
@@ -69,14 +69,13 @@ sap.ui.define([
      */
 
     /**
-     * An HTTP client that can submit GET, PUT, POST, PATCH, DELETE and OPTIONS requests
+     * @alias sap.ushell.utils.XHttpClient
+     * @class
+     * @classdesc An HTTP client that can submit GET, PUT, POST, PATCH, DELETE and OPTIONS requests
      * and that supports cross-site request forgery (CSRF) token fetching and injection.
      *
      * The necessary CSRF token handling is done automatically.
      *
-     * @class
-     * @namespace sap.ushell.utils.XHttpClient
-     *
      * @param {string} [basePath]
      *     Base path that is prepended to the resource path specified in each method call
      *
@@ -251,7 +250,7 @@ sap.ui.define([
         var oInvalidURLError = new Error("The provided resource path is not a valid URL.");
 
         var oDefaultHeaders = {};
-        var bSapStatisticsEnabled = Configuration.getStatisticsEnabled();
+        var bSapStatisticsEnabled = Supportability.isStatisticsEnabled();
         if (bSapStatisticsEnabled) {
             oDefaultHeaders["sap-statistics"] = bSapStatisticsEnabled;
         }

package/src/main/js/sap/ushell/utils/RestrictedJSONModel.js

@@ -22,7 +22,7 @@ sap.ui.define([
      *
      * @private
      */
-    return JSONModel.extend("sap.ushell.utils.RestrictedJSONModel", /** @lends sap.ushell.utils.RestrictedJSONModel */ {
+    return JSONModel.extend("sap.ushell.utils.RestrictedJSONModel", /** @lends sap.ushell.utils.RestrictedJSONModel.prototype */ {
         constructor: function () {
             JSONModel.prototype.constructor.apply(this, arguments);
 

package/src/main/js/sap/ushell/utils/UrlParsing.js

@@ -23,16 +23,10 @@ sap.ui.define([
 ) {
     "use strict";
 
-    // usage : sap.ushell.Container.getServiceAsync("URLParsing").then(function (URLParsing) {
-    //             URLParsing.parseShellHash();
-    //         });
-    //         etc.
-
     /**
-     * The Unified Shell's internal URL parsing service (platform independent)
-     * This method MUST be called by the Unified Shell's container only, others MUST call
-     * <code>sap.ushell.Container.getServiceAsync("URLParsing").then(function (URLParsing) {});</code>.
-     * Constructs a new instance of the URL parsing service.
+     * @alias sap.ushell.utils.UrlParsing
+     * @namespace
+     * @description The Unified Shell's internal URL parsing utils (platform independent)
      *
      * Methods in this class allow to break down a shell compliant hash into it's respective parts
      * (SemanticObject,Action,Context, Parameters, appSpecificHash) or (ShellPart,appSpecificHash) respectively
@@ -49,12 +43,10 @@ sap.ui.define([
      * behaviour for non-compliant hashes is undefined and subject to change,
      * notably we do not aim do "degrade" nicefully or support partial parsing of corrupted urls.
      *
-     * @name sap.ushell.utils.UrlParsing
-     * @class
      * @since 1.94.0
      * @private
      */
-    function UrlParsing () { }
+    const UrlParsing = {};
     var reValidShellPart = /^(([A-Za-z0-9_/]+)-([A-Za-z0-9_/-]+)(~([A-Z0-9a-z=+/]+))?)?([?]([^&]|(&[^/]))*&?)?$/;
 
 
@@ -378,9 +370,8 @@ sap.ui.define([
     /**
      * Internal function
      *
-     * @name privstripLeadingHash
      * @param {string} sHash Shell hash
-     * @returns {string} the string wihtout a leading #
+     * @returns {string} the string without a leading #
      * @since 1.94.0
      * @private
      */

package/src/main/js/sap/ushell/utils/UrlShortening.js

@@ -5,7 +5,7 @@
  *
  * This module is for internal Shell usage only
  *
- * @version 1.120.7
+ * @version 1.121.0
  */
  sap.ui.define(["sap/base/Log", "sap/ushell/utils/UrlParsing"], function (Log, urlParsing) {
     "use strict";
@@ -103,7 +103,7 @@
          * The inverse operation expandHash replaces a sap-intent-param=KEY value.
          *
          * @param {string} sUrl A shell hash parameter string
-         * @param {Array} aRetainParameterList an array listing parameter names (in order) which should be preferably
+         * @param {string[]} aRetainParameterList an array listing parameter names (in order) which should be preferably
          *   not compacted (=retained in the parameter list),
          *   note that this is only a hint, some system parameters may be retained before this list is respected!
          * @param {object} oStoreContext an object <code>{ getNextKey : function(); store: function(sValue) }</code>
@@ -258,7 +258,7 @@
          * example _findIndex(["A","B*C", "B-A"],"B-C") returns -1
          * </pre>
          *
-         * @param {Array} aArray an array of string containing the strings to match
+         * @param {string[]} aArray an array of string containing the strings to match
          * @param {string} sTest the string to test for
          * @returns {int} the index of a matching entry, or -1 if not found
          * @since 1.32.0
@@ -323,7 +323,7 @@
          * split a parameters object, return a triple key, headParams, tailParams if split, otherwise key is undefined
          *
          * @param {object} oParams Parameter collection
-         * @param {array<string>} aRetainParameterList A list of parameters to retain in the parameter list
+         * @param {string[]} aRetainParameterList A list of parameters to retain in the parameter list
          *   (parameters listed here will be retained in order of priority if possible).
          * @param {function} sKey A function used to generate the key
          * @returns {object} a triple { key, headParams, tailParams } if split, otherwise key is undefined, tailParams is an empty object

package/src/main/js/sap/ushell/utils/chipsUtils.js

@@ -369,16 +369,16 @@ sap.ui.define([
     };
 
     /**
-    * The function checks the chipId of the provided simplified chip to determine if it is a custom tile.
-    *
-    * @param {object} oSimplifiedChip
-    *  A simplified version of the sap.ushell_abap.pbServices.ui2.ChipInstance.
-    *  The object structure of the simplified chip model can be viewed in the "simplifiedChipModel.md" document in the FLP core-concepts GitHub repository.
-    *
-    * @since 1.90.0
-    * @returns {boolean} True if the tile is a custom tile.
-    * @private
-    */
+     * The function checks the chipId of the provided simplified chip to determine if it is a custom tile.
+     *
+     * @param {object} oSimplifiedChip
+     *  A simplified version of the sap.ushell_abap.pbServices.ui2.ChipInstance.
+     *  The object structure of the simplified chip model can be viewed in the "simplifiedChipModel.md" document in the FLP core-concepts GitHub repository.
+     *
+     * @since 1.90.0
+     * @returns {boolean} True if the tile is a custom tile.
+     * @private
+     */
     chipsUtils.isCustomTileFromSimplifiedChip = function (oSimplifiedChip) {
         var sChipId = oSimplifiedChip.chipId;
         return sChipId !== DYNAMIC_BASE_CHIP_ID && sChipId !== STATIC_BASE_CHIP_ID;

package/src/main/js/sap/ushell/utils/workpage/WorkPageService.js

@@ -0,0 +1,234 @@
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
+
+/**
+ * @fileOverview This module communicates with the content API graphql service to retrieve workpage and visualization data.
+ * @version 1.121.0
+ */
+sap.ui.define([
+    "sap/base/i18n/Localization",
+    "sap/ushell/utils/HttpClient",
+    "sap/base/util/ObjectPath",
+    "sap/ushell/Config",
+    "sap/base/Log",
+    "sap/ushell/Container",
+    "sap/base/util/deepExtend",
+    "sap/ushell/adapters/cdm/v3/utilsCdm",
+    "sap/ushell/adapters/cdm/v3/_LaunchPage/readUtils",
+    "sap/ushell/adapters/cdm/v3/_LaunchPage/readVisualizations"
+], function (
+    Localization,
+    HttpClient,
+    ObjectPath,
+    Config,
+    Log,
+    Container,
+    deepExtend,
+    utilsCdm,
+    readUtils,
+    readVisualizations
+) {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.utils.workpage.WorkPageService
+     * @class
+     * @classdesc Service for loading WorkPages.
+     *
+     * @since 1.121.0
+     * @private
+     */
+    var WorkPage = function () {
+        this.httpClient = new HttpClient();
+        this._sBaseUrl = Config.last("/core/workPages/contentApiUrl");
+
+        const oUrlParams = new URLSearchParams(window.location.search);
+        this._sSiteId = oUrlParams.get("siteId") || Config.last("/core/site/siteId");
+    };
+
+
+    /**
+     * Validates the given page data. Returns a rejected promise if validation fails.
+     * @param {object} oPageData The page data.
+     * @returns {Promise} A promise, that is resolved if the page data is valid, else it is rejected.
+     * @private
+     */
+    WorkPage.prototype._validateData = function (oPageData) {
+        Log.debug("cep/editMode: load Page: validate", "Work Page service");
+        if (oPageData.errors && oPageData.errors.length > 0) {
+            return Promise.reject(oPageData.errors
+                .map(function (oError) { return oError.message; })
+                .join(",\n"));
+
+        }
+        if (!ObjectPath.get("data.workPage", oPageData)) {
+            Log.debug("cep/editMode: load Page: validate: reject: data is empty", "Work Page service");
+            return Promise.reject("Work Page data is empty");
+        }
+        return Promise.resolve(oPageData);
+    };
+
+    /**
+     * @typedef {object} SiteData Additional visualization properties retrieved from the CDM Runtime Site
+     * @property {object} [target] The harmonized navigation target of the visualization
+     * @property {string} [targetURL] The target URL of the visualization
+     * @property {object} [dataSource] The data source for the indicator data source of the visualization
+     * @property {string} [contentProviderId] The content provider id of the visualization
+     * @property {string} [contentProviderLabel] The label for the content provider of the visualization
+     */
+
+    /**
+     * @typedef {object} ExtendedVisualization An extension of a visualization retrieved from the content API
+     * @property {string} id The id of the visualization
+     * @property {string} type The type of the visualization
+     * @property {object} descriptor The descriptor of the visualization
+     * @property {object} descriptorResources The descriptor resources of the visualization
+     * @property {SiteData} [_siteData] The additional app properties retrieved from the CDM Runtime Site
+    */
+
+    /**
+     * Load the WorkPage data for the given page id.
+     * Additionally, load the visualizations used on that WorkPage.
+     *
+     * @param {string} sPageId The WorkPage id.
+     * @returns {Promise<{ workPage: {usedVisualizations: { nodes: ExtendedVisualization[] }, editable: boolean}}>}
+     *  A promise resolving with the loaded work page and visualizations, enhanced with app data retrieved from the CDM Runtime Site.
+     */
+    WorkPage.prototype.loadWorkPageAndVisualizations = function (sPageId) {
+        var sQuery = "{" +
+            "workPage(" +
+              "siteId:\"" + this._sSiteId + "\"," +
+              "workPageId:\"" + sPageId + "\"" +
+            ") {" +
+                "id," +
+                "contents," +
+                "editable," +
+                "usedVisualizations{" +
+                    "nodes{" +
+                        "id," +
+                        "type," +
+                        "descriptor{" +
+                            "value" +
+                        "}," +
+                        "descriptorResources{" +
+                            "baseUrl," +
+                            "descriptorPath" +
+                        "}" +
+                    "}" +
+                "}" +
+            "}" +
+        "}";
+        return this._doRequest(sQuery)
+            .then(this._validateData)
+            .then((oPageData) => {
+                var oWorkPageData = ObjectPath.get("data.workPage.contents", oPageData);
+                var aVizData = ObjectPath.get("data.workPage.usedVisualizations.nodes", oPageData) || [];
+                var bEditable = ObjectPath.get("data.workPage.editable", oPageData) === true;
+                return this._transformVizData(aVizData).then((aTransformedVizData) => {
+                    return {
+                        workPage: {
+                            contents: oWorkPageData,
+                            usedVisualizations: { nodes: aTransformedVizData },
+                            editable: bEditable
+                        }
+                    };
+                });
+            });
+    };
+
+    /**
+     * Do the XHR request with the given query.
+     *
+     * @param {string} sQuery The query.
+     * @returns {Promise} Promise that resolves with the parsed JSON response if the request was successful, otherwise it is rejected.
+     * @private
+     */
+    WorkPage.prototype._doRequest = function (sQuery) {
+        return this.httpClient.get(this._sBaseUrl + "?query=" + sQuery, {
+            headers: {
+                "Content-Type": "application/json",
+                Accept: "application/json",
+                "Accept-Language": Localization.getLanguageTag().toString()
+            }
+        }).then(function (oResponse) {
+            if (oResponse.status < 200 || oResponse.status >= 300) {
+                return Promise.reject("HTTP request failed with status: " + oResponse.status + " - " + oResponse.statusText);
+            }
+            return JSON.parse(oResponse.responseText || "{}");
+        });
+    };
+
+    /**
+     * Transforms the visualization data in the result.
+     * <p>
+     * For all static and dynamic app launchers, the navigation target URL is
+     * set in the visualization by lookup of the target app in the CDM runtime site.
+     * For all dynamic app launchers, the path of the indicator data source in the
+     * visualization is replaced by the corresponding path of the corresponding target
+     * app which is looked up in the CDM runtime site.
+     *
+     * @param {object[]} aVizData the visualization data as retrieved from the content API in the usedVisualizations property.
+     * @returns {Promise<object[]>} Promise that resolves with the modified visualizations data.
+     * @private
+     */
+    WorkPage.prototype._transformVizData = async function (aVizData) {
+
+        // performance optimization: load CDM site only if page contains standard app launcher visualizations
+        const oStandardAppLauncherVizData = aVizData.find(function (oVizData) {
+            return (oVizData.type === "sap.ushell.StaticAppLauncher")
+                || (oVizData.type === "sap.ushell.DynamicAppLauncher");
+        });
+        if (!oStandardAppLauncherVizData) {
+            return Promise.resolve(aVizData);
+        }
+
+        const oCdmService = await Container.getServiceAsync("CommonDataModel");
+        const oApplications = await oCdmService.getApplications();
+        const aTransformedVizData = await Promise.all(aVizData.map((oVizData) => {
+            if (oVizData.type === "sap.ushell.StaticAppLauncher" || oVizData.type === "sap.ushell.DynamicAppLauncher") {
+                return this._setApplicationProperties(oVizData, oApplications);
+            }
+
+            return oVizData;
+        }));
+        return Promise.resolve(aTransformedVizData);
+    };
+
+    /**
+     * Sets the properties which are determined from the target app in the provided visualization data.
+     * <p>
+     * Target app properties are the navigation target and targetURL, the dataSources and indicatorDataSource,
+     * and the contentProviderId.
+     *
+     * @param {object} oVizData the visualization data as retrieved from the content API in the usedVisualizations property.
+     * @param {object} oApplications the applications as returned from the CommonDataModel service.
+     * @returns {Promise<object>} a promise resolving with the visualization data extended with a <code>_siteData</code> object containing the
+     *  additional properties retrieved from the CDM runtime site.
+     * @private
+     */
+    WorkPage.prototype._setApplicationProperties = async function (oVizData, oApplications) {
+        const sAppId = ObjectPath.get(["descriptor", "value", "sap.flp", "target", "appId"], oVizData);
+        const oApplication = oApplications[sAppId];
+        const sIndicatorDataSourceName = ObjectPath.get(["descriptor", "value", "sap.flp", "indicatorDataSource", "dataSource"], oVizData);
+        const oDataSourceFromApp = ObjectPath.get(["sap.app", "dataSources", sIndicatorDataSourceName], oApplication);
+        const sContentProviderId = ObjectPath.get(["sap.app", "contentProviderId"], oApplication);
+        const sContentProviderLabel = await readUtils.getContentProviderLabel(sContentProviderId);
+        const oInstantiationVizData = {
+            vizConfig: ObjectPath.get(["descriptor", "value"], oVizData)
+        };
+        oInstantiationVizData.target = readUtils.harmonizeTarget(readVisualizations.getTarget(oInstantiationVizData) || {});
+
+        const oExtendedVizData = deepExtend({}, oVizData, {
+            _siteData: {
+                contentProviderId: sContentProviderId,
+                contentProviderLabel: sContentProviderLabel,
+                target: oInstantiationVizData.target,
+                targetURL: utilsCdm.toHashFromVizData(oInstantiationVizData, oApplications),
+                dataSource: oDataSourceFromApp
+            }
+        });
+
+        return oExtendedVizData;
+    };
+
+    return WorkPage;
+}, /*export=*/ true);