@sapui5/sap.ushell 1.136.2 → 1.138.0

package/src/main/js/sap/ushell/URLTemplateProcessor.js

@@ -26,7 +26,7 @@
  * The language to define parameters in the URL Template parameter set contains a minimal set of conditionals,
  * logical operators, and functions that allow to define the parameter set with a certain degree of control.
  *
- * @version 1.136.2
+ * @version 1.138.0
  * @private
  */
 sap.ui.define([
@@ -38,7 +38,7 @@ sap.ui.define([
     "sap/ushell/URLTemplateProcessor/Resolvers",
     "sap/ushell/URLTemplateProcessor/TemplateParameterParser",
     "sap/ushell/URLTemplateProcessor/utils"
-], function (
+], (
     Log,
     URI,
     URITemplate,
@@ -47,7 +47,7 @@ sap.ui.define([
     _Resolvers,
     _TemplateParameterParser,
     _utils
-) {
+) => {
     "use strict";
 
     function log (s) {
@@ -62,20 +62,20 @@ sap.ui.define([
             if (vValue === "") {
                 return "<empty string>";
             }
-            return "'" + vValue + "'";
+            return `'${vValue}'`;
         }
         if (typeof vValue === "number") {
-            return "(number) " + vValue;
+            return `(number) ${vValue}`;
         }
         if (typeof vValue === "boolean") {
-            return "(bool) " + vValue;
+            return `(bool) ${vValue}`;
         }
 
-        var sSerializedObject;
+        let sSerializedObject;
         if (typeof vValue === "object") {
             sSerializedObject = JSON.stringify(vValue);
             if (sSerializedObject.length > 255) {
-                sSerializedObject = sSerializedObject.substr(0, 255) + "...";
+                sSerializedObject = `${sSerializedObject.substr(0, 255)}...`;
             }
         } else {
             sSerializedObject = "{other type}";
@@ -85,23 +85,23 @@ sap.ui.define([
     }
 
     function extractPostExpansionOperations (oParameterSet) {
-        var aParametersWithOperations = Object.keys(oParameterSet).filter(function (sParamName) {
+        const aParametersWithOperations = Object.keys(oParameterSet).filter((sParamName) => {
             return typeof oParameterSet[sParamName] === "object"
                 && oParameterSet[sParamName].hasOwnProperty("renameTo");
         });
 
-        var aOperations = [];
+        const aOperations = [];
 
-        aParametersWithOperations.forEach(function (sParamName) {
-            var oParamDef = oParameterSet[sParamName];
+        aParametersWithOperations.forEach((sParamName) => {
+            const oParamDef = oParameterSet[sParamName];
             if (oParamDef.hasOwnProperty("renameTo")) {
-                aOperations.push(function (sUrlTemplate, sUrl) {
+                aOperations.push((sUrlTemplate, sUrl) => {
                     // limit replacement to query only
-                    var sReplacedUrl = sUrl;
+                    let sReplacedUrl = sUrl;
 
                     sReplacedUrl = sUrl.replace(
-                        new RegExp(sParamName + "=", "g"),
-                        oParamDef.renameTo + "="
+                        new RegExp(`${sParamName}=`, "g"),
+                        `${oParamDef.renameTo}=`
                     );
 
                     return sReplacedUrl;
@@ -112,54 +112,26 @@ sap.ui.define([
         return aOperations;
     }
 
-    /**
-     * Expands a URL Template, logging any activity via <code>Log.debug</code>.
-     *
-     * @param {object} oTemplatePayload The template payload, an object including the url template and the url template parameter set.
-     * @param {object} oSite The reference to the site containing all data. This is used to resolve parameters of (absolute) path types.
-     * @param {object} oRuntime The runtime. It is an object containing namespaces defined by the runtime
-     *   that exposes URL templating functionality (e.g., ClientSideTargetResolution).
-     *   Each namespace can be a single string value, or an object containing a set of parameters, for example like:
-     *   <pre>
-     *   {
-     *     innerAppRoute: "/some/app/route",
-     *     intentParameters: {
-     *       p1: ["v1"],
-     *       p2: "v2"
-     *     }
-     *   }
-     *   </pre>
-     * @param {object} oApplicationContext The application context. This is an object used to resolve parameters with relative path type.
-     *   It's normally a subset of the site, but this is not a necessity.  It can be a completely separate object.
-     * @param {string} sDefaultNamespace The default namespace from <code>oRuntime</code>
-     *   where the values of parameters without specified namespace can be recovered.
-     * @returns {string} A URL expanded according to the given template.
-     */
-    function expand (oTemplatePayload, oSite, oRuntime, oApplicationContext, sDefaultNamespace) {
-        var oExpandProcessData = prepareExpandData(oTemplatePayload, oSite, oRuntime, oApplicationContext, sDefaultNamespace);
-        return _expand(oTemplatePayload, oExpandProcessData);
-    }
-
     function prepareExpandData (oTemplatePayload, oSite, oRuntime, oApplicationContext, sDefaultNamespace) {
-        log("[TEMPLATE EXPANSION] " + oTemplatePayload.urlTemplate);
+        log(`[TEMPLATE EXPANSION] ${oTemplatePayload.urlTemplate}`);
 
-        var oDefinitionParamsSet = _DefinitionParameterSetBuilder.buildDefinitionParameterSet(oTemplatePayload.parameters, oSite, sDefaultNamespace) || {};
-        var oRuntimeParamsSimpleSet = _utils.removeArrayParameterNotation(oRuntime[sDefaultNamespace] || {});
-        var oDefinitionParameterSetParsed = _TemplateParameterParser.parseTemplateParameterSet(oDefinitionParamsSet, sDefaultNamespace);
-        var oRuntimeParamsSimpleSetParsed = _TemplateParameterParser.parseTemplateParameterSetAsLiterals(oRuntimeParamsSimpleSet);
-        var oParameterSetParsed = _utils.mergeObject(oRuntimeParamsSimpleSetParsed, oDefinitionParameterSetParsed);
+        const oDefinitionParamsSet = _DefinitionParameterSetBuilder.buildDefinitionParameterSet(oTemplatePayload.parameters, oSite, sDefaultNamespace) || {};
+        const oRuntimeParamsSimpleSet = _utils.removeArrayParameterNotation(oRuntime[sDefaultNamespace] || {});
+        const oDefinitionParameterSetParsed = _TemplateParameterParser.parseTemplateParameterSet(oDefinitionParamsSet, sDefaultNamespace);
+        const oRuntimeParamsSimpleSetParsed = _TemplateParameterParser.parseTemplateParameterSetAsLiterals(oRuntimeParamsSimpleSet);
+        const oParameterSetParsed = _utils.mergeObject(oRuntimeParamsSimpleSetParsed, oDefinitionParameterSetParsed);
 
-        log("- parsed template parameters: " + JSON.stringify(oParameterSetParsed, null, 3));
+        log(`- parsed template parameters: ${JSON.stringify(oParameterSetParsed, null, 3)}`);
 
-        var oGraph = _DependencyGraph.buildDependencyGraph(oParameterSetParsed);
+        const oGraph = _DependencyGraph.buildDependencyGraph(oParameterSetParsed);
 
-        log("- created dependency graph: " + JSON.stringify(oGraph, null, 3));
+        log(`- created dependency graph: ${JSON.stringify(oGraph, null, 3)}`);
 
-        var aResolutionOrder = _DependencyGraph.getDependencyResolutionOrder(oGraph);
+        const aResolutionOrder = _DependencyGraph.getDependencyResolutionOrder(oGraph);
 
-        log("- resolving in order: " + aResolutionOrder.join(" > "));
+        log(`- resolving in order: ${aResolutionOrder.join(" > ")}`);
 
-        var oResolvedParameters = _Resolvers.resolveAllParameters(
+        const oResolvedParameters = _Resolvers.resolveAllParameters(
             oParameterSetParsed,
             aResolutionOrder,
             oSite,
@@ -168,9 +140,9 @@ sap.ui.define([
             sDefaultNamespace
         );
 
-        Object.keys(oResolvedParameters).forEach(function (sParamName) {
-            var sParamValue = oResolvedParameters[sParamName];
-            log(sParamName + " --> " + formatValueForLogging(sParamValue));
+        Object.keys(oResolvedParameters).forEach((sParamName) => {
+            const sParamValue = oResolvedParameters[sParamName];
+            log(`${sParamName} --> ${formatValueForLogging(sParamValue)}`);
         });
 
         return {
@@ -180,23 +152,51 @@ sap.ui.define([
     }
 
     function _expand (oTemplatePayload, oExpandProcessData) {
-        var aPostExpansionOperations = extractPostExpansionOperations(oExpandProcessData.oDefinitionParamsSet || {});
-        var sUrlTemplate = oTemplatePayload.urlTemplate;
+        const aPostExpansionOperations = extractPostExpansionOperations(oExpandProcessData.oDefinitionParamsSet || {});
+        const sUrlTemplate = oTemplatePayload.urlTemplate;
 
-        var sUrl = URI.expand(sUrlTemplate, oExpandProcessData.oResolvedParameters).toString();
-        log("- created URL: " + sUrl);
+        let sUrl = URI.expand(sUrlTemplate, oExpandProcessData.oResolvedParameters).toString();
+        log(`- created URL: ${sUrl}`);
 
-        aPostExpansionOperations.forEach(function (fnOperation) {
+        aPostExpansionOperations.forEach((fnOperation) => {
             sUrl = fnOperation(sUrlTemplate, sUrl);
         });
 
         if (aPostExpansionOperations.length > 0) {
-            log("- created URL (post expansion): " + sUrl);
+            log(`- created URL (post expansion): ${sUrl}`);
         }
 
         return sUrl;
     }
 
+    /**
+     * Expands a URL Template, logging any activity via <code>Log.debug</code>.
+     *
+     * @param {object} oTemplatePayload The template payload, an object including the url template and the url template parameter set.
+     * @param {object} oSite The reference to the site containing all data. This is used to resolve parameters of (absolute) path types.
+     * @param {object} oRuntime The runtime. It is an object containing namespaces defined by the runtime
+     *   that exposes URL templating functionality (e.g., ClientSideTargetResolution).
+     *   Each namespace can be a single string value, or an object containing a set of parameters, for example like:
+     *   <pre>
+     *   {
+     *     innerAppRoute: "/some/app/route",
+     *     intentParameters: {
+     *       p1: ["v1"],
+     *       p2: "v2"
+     *     }
+     *   }
+     *   </pre>
+     * @param {object} oApplicationContext The application context. This is an object used to resolve parameters with relative path type.
+     *   It's normally a subset of the site, but this is not a necessity.  It can be a completely separate object.
+     * @param {string} sDefaultNamespace The default namespace from <code>oRuntime</code>
+     *   where the values of parameters without specified namespace can be recovered.
+     * @returns {string} A URL expanded according to the given template.
+     */
+    function expand (oTemplatePayload, oSite, oRuntime, oApplicationContext, sDefaultNamespace) {
+        const oExpandProcessData = prepareExpandData(oTemplatePayload, oSite, oRuntime, oApplicationContext, sDefaultNamespace);
+        return _expand(oTemplatePayload, oExpandProcessData);
+    }
+
     return {
         prepareExpandData: prepareExpandData,
         expand: expand

package/src/main/js/sap/ushell/Ui5NativeServiceFactory.js

@@ -2,60 +2,57 @@
 /**
  * @fileOverview Ui5 Native Service Factory
  *
- * @version 1.136.2
+ * @version 1.138.0
  */
 
 sap.ui.define([
     "sap/ui/core/service/ServiceFactory"
 ],
-    function (ServiceFactory) {
-        "use strict";
+(ServiceFactory) => {
+    "use strict";
 
-        /**
+    /**
          * @alias sap.ushell.Ui5NativeServiceFactory
          * @namespace
          *
          * @private
          */
-        var oUi5NativeServiceFactory = {
-            _servicePromises: {},
+    const oUi5NativeServiceFactory = {
+        _servicePromises: {},
 
-            /**
+        /**
              * Creates UI5 service factories for the given service name. The once created service
              * instances are reused on every service instantiation.
              *
              * @param {string} sServiceName The card service name
              * @returns {object} The card service factory
              */
-            createServiceFactory: function (sServiceName) {
-                var oServicePromises = this._servicePromises;
-                var Ui5NativeServiceFactory = ServiceFactory.extend("sap.ushell.ui5Service." + sServiceName + "Factory", {
-                    createInstance: function () {
-                        var oServicePromise = oServicePromises[sServiceName];
-
-                        if (!oServicePromise) {
-                            oServicePromise = new Promise(function (resolve, reject) {
-                                sap.ui.require(["sap/ushell/ui5service/" + sServiceName], function (Service) {
-                                    var oService;
-
-                                    if (!Service) {
-                                        reject();
-                                    }
-                                    oService = new Service();
-                                    resolve(oService);
-                                });
+        createServiceFactory: function (sServiceName) {
+            const oServicePromises = this._servicePromises;
+            const Ui5NativeServiceFactory = ServiceFactory.extend(`sap.ushell.ui5Service.${sServiceName}Factory`, {
+                createInstance: function () {
+                    let oServicePromise = oServicePromises[sServiceName];
+
+                    if (!oServicePromise) {
+                        oServicePromise = new Promise((resolve, reject) => {
+                            sap.ui.require([`sap/ushell/ui5service/${sServiceName}`], (Service) => {
+                                if (!Service) {
+                                    reject();
+                                }
+                                const oService = new Service();
+                                resolve(oService);
                             });
-                            oServicePromises[sServiceName] = oServicePromise;
-                        }
-
-                        return oServicePromise;
+                        });
+                        oServicePromises[sServiceName] = oServicePromise;
                     }
-                });
 
-                return new Ui5NativeServiceFactory();
-            }
-        };
+                    return oServicePromise;
+                }
+            });
 
-    return oUi5NativeServiceFactory;
+            return new Ui5NativeServiceFactory();
+        }
+    };
 
+    return oUi5NativeServiceFactory;
 });

package/src/main/js/sap/ushell/Ui5ServiceFactory.js

@@ -6,7 +6,7 @@
  * Exposes methods to create a UI5 Service Factory for a specific Unified Shell
  * Service.
  *
- * @version 1.136.2
+ * @version 1.138.0
  */
 
 sap.ui.define([
@@ -15,10 +15,10 @@ sap.ui.define([
     "sap/base/Log",
     "sap/base/util/ObjectPath",
     "sap/base/util/isPlainObject"
-], function (ServiceFactory, Service, Log, ObjectPath, isPlainObject) {
+], (ServiceFactory, Service, Log, ObjectPath, isPlainObject) => {
     "use strict";
 
-    var sActiveComponentId;
+    let sActiveComponentId;
 
     /**
      * Sets the id of the active component, that is, the component allowed
@@ -69,8 +69,8 @@ sap.ui.define([
      * @private
      */
     function getAllProperties (oObject) {
-        var sProperty,
-            aProperties = [];
+        let sProperty;
+        const aProperties = [];
 
         for (sProperty in oObject) {
             aProperties.push(sProperty);
@@ -79,7 +79,7 @@ sap.ui.define([
         return aProperties;
     }
 
-        /**
+    /**
      * Wraps a given public service interface method with a check that
      * determines whether the method can be called. This helps preventing
      * cases in which calling the method would disrupt the functionality of
@@ -99,26 +99,26 @@ sap.ui.define([
      * @private
      */
     function addCallAllowedCheck (oPublicServiceContext, oPublicServiceInstance, sPublicServiceMethod) {
-        var fnOriginalMethod = oPublicServiceInstance[sPublicServiceMethod];
+        const fnOriginalMethod = oPublicServiceInstance[sPublicServiceMethod];
 
         oPublicServiceInstance[sPublicServiceMethod] = function () {
-            var i,
-                aArgs, sComponentId = getActiveComponentId();
+            let i;
+            const sComponentId = getActiveComponentId();
 
             if (!oPublicServiceContext || oPublicServiceContext.scopeObject.getId() !== sComponentId) {
                 Log.warning(
-                    "Call to " + sPublicServiceMethod + " is not allowed",
-                    "This may be caused by an app component other than the active '"
-                    + sComponentId + "' that tries to call the method",
+                    `Call to ${sPublicServiceMethod} is not allowed`,
+                    `This may be caused by an app component other than the active '${
+                        sComponentId}' that tries to call the method`,
                     "sap.ushell.Ui5ServiceFactory"
                 );
                 return undefined; // eslint
             }
 
             // clone args to allow Chrome to optimize addCallAllowedCheck
-            aArgs = new Array(arguments.length);
+            const aArgs = new Array(arguments.length);
             for (i = 0; i < aArgs.length; ++i) {
-              aArgs[i] = arguments[i];
+                aArgs[i] = arguments[i];
             }
 
             return fnOriginalMethod.apply(oPublicServiceInstance, aArgs);
@@ -156,18 +156,16 @@ sap.ui.define([
      * @private
      */
     function setPublicMethods (oUshellServiceInstance, oPublicServiceInstance, oPublicServiceContext, bAddCallProtection) {
-
         getAllProperties(oUshellServiceInstance)
             .filter(isPublicMember)
-            .filter(function (sName) {
+            .filter((sName) => {
                 // copy all public functions/members
-                var vValue = oUshellServiceInstance[sName];
+                const vValue = oUshellServiceInstance[sName];
                 oPublicServiceInstance[sName] = vValue;
 
                 return typeof vValue === "function";
             })
-            .forEach(function (sFunctionName) { // special function treatment
-
+            .forEach((sFunctionName) => { // special function treatment
                 oPublicServiceInstance[sFunctionName] =
                     oPublicServiceInstance[sFunctionName].bind(
                         oUshellServiceInstance);
@@ -191,8 +189,6 @@ sap.ui.define([
      * @private
      */
     function isValidContext (oContext) {
-        var fnGetId;
-
         if (typeof oContext === "undefined") {
             return true; // undefined is ok -> (when factory get method used)
         }
@@ -205,7 +201,7 @@ sap.ui.define([
             return false;
         }
 
-        fnGetId = ObjectPath.get("scopeObject.getId", oContext);
+        const fnGetId = ObjectPath.get("scopeObject.getId", oContext);
         if (typeof fnGetId !== "function") {
             return false;
         }
@@ -259,7 +255,7 @@ sap.ui.define([
      * @private
      */
     function getServiceInfo (oPublicServiceContext, oUshellService, bAddCallProtection) {
-        var oPublicService = {};
+        const oPublicService = {};
 
         if (bAddCallProtection) {
             bAddCallProtection = typeof oPublicServiceContext === "object";
@@ -276,7 +272,6 @@ sap.ui.define([
             && oPublicServiceContext.scopeType === "component"
             && oPublicServiceContext.scopeObject
             && oPublicServiceContext.scopeObject.getId) { // scopeObject : app component
-
             setActiveComponentId(oPublicServiceContext.scopeObject.getId());
         }
 
@@ -295,9 +290,9 @@ sap.ui.define([
      * @private
      */
     function getServiceAsync (sUshellServiceName) {
-        return new Promise(function (resolve, reject) {
+        return new Promise((resolve, reject) => {
             // avoid cyclic dependencies to sap/ushell/Container. Hence the Container is required here
-            sap.ui.require(["sap/ushell/Container"], function (Container) {
+            sap.ui.require(["sap/ushell/Container"], (Container) => {
                 Container.getServiceAsync(sUshellServiceName).then(
                     (serviceInstance) => { resolve(serviceInstance); });
             });
@@ -328,50 +323,43 @@ sap.ui.define([
      * @private
      */
     function createServiceFactory (sUshellServiceName, bAddCallProtection) {
-
         /**
          * @alias sap.ushell.Ui5ServiceFactory
          * @namespace
          *
          * @private
          */
-        var Ui5ServiceFactory = ServiceFactory.extend("sap.ushell.ui5service." + sUshellServiceName + "Factory", /** @lends sap.ushell.Ui5ServiceFactory.prototype */ {
+        const Ui5ServiceFactory = ServiceFactory.extend(`sap.ushell.ui5service.${sUshellServiceName}Factory`, /** @lends sap.ushell.Ui5ServiceFactory.prototype */ {
 
             createInstance: function (oPublicServiceContext) {
-
-                return new Promise(function (fnResolve, fnReject) {
-
-                    getServiceAsync(sUshellServiceName).then(function (oUshellService) {
-                        var oUi5ServiceInstance,
-                            oUi5ServiceInfo,
-                            Ui5Service;
-
+                return new Promise((fnResolve, fnReject) => {
+                    getServiceAsync(sUshellServiceName).then((oUshellService) => {
                         if (!isValidContext(oPublicServiceContext)) {
                             Log.error(
-                                "Invalid context for " + sUshellServiceName + " service interface",
+                                `Invalid context for ${sUshellServiceName} service interface`,
                                 "The context must be empty or an object like { scopeType: ..., scopeObject: ... }",
                                 "sap.ushell.Ui5ServiceFactory"
                             );
-                            fnReject("Invalid Context for " + sUshellServiceName + " service");
+                            fnReject(`Invalid Context for ${sUshellServiceName} service`);
                             return;
                         }
 
-                        oUi5ServiceInfo = getServiceInfo(oPublicServiceContext, oUshellService, bAddCallProtection);
+                        const oUi5ServiceInfo = getServiceInfo(oPublicServiceContext, oUshellService, bAddCallProtection);
 
                         // Alternative approach is to use
                         // Service.create(oUi5ServiceInfo), but this causes
                         // UI5 anonymous service implementation to hide public
                         // members of oUi5ServiceInfo.
-                        Ui5Service = Service.extend("sap.ushell.ui5service." + sUshellServiceName, {
+                        const Ui5Service = Service.extend(`sap.ushell.ui5service.${sUshellServiceName}`, {
                             getInterface: function () {
                                 return oUi5ServiceInfo;
                             }
                         });
 
-                        oUi5ServiceInstance = new Ui5Service(oPublicServiceContext);
+                        const oUi5ServiceInstance = new Ui5Service(oPublicServiceContext);
 
                         fnResolve(oUi5ServiceInstance);
-                    }, function (oGetServiceError) {
+                    }, (oGetServiceError) => {
                         fnReject(oGetServiceError);
                     });
                 });
@@ -384,5 +372,4 @@ sap.ui.define([
     return {
         createServiceFactory: createServiceFactory
     };
-
 });