@sapui5/sap.ushell 1.119.2 → 1.120.0

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module exposes API enpoints for Generic Communication
- * @version 1.119.2
+ * @version 1.120.0
  */
 sap.ui.define([
     "sap/ushell/services/_MessageBroker/MessageBrokerEngine",
@@ -10,22 +10,22 @@ sap.ui.define([
 ], function (MessageBrokerEngine, Log) {
     "use strict";
 
+    var oServiceConfig = {};
+
     /**
-     * This constructor MUST be called DIRECTLY only by the Unified Shell Container entities, others MUST call
-     * <code>sap.ushell.Container.getServiceAsync("MessageBroker").then(function (MessageBroker) {});</code>.
-     * Constructs a new instance of the message broker service.
+     * @alias sap.ushell.services.MessageBroker
+     * @class
+     * @classdesc The Unified Shell's MessageBroker service.
      *
-     * @namespace sap.ushell.services.MessageBroker
+     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
+     * <code>sap.ushell.Container.getServiceAsync("MessageBroker")</code>. For details, see
+     * {@link sap.ushell.services.Container#getServiceAsync}.
      *
-     * @class
-     * @see {@link sap.ushell.services.Container#getServiceAsync}
-     * @since 1.72.0
+     * @hideconstructor
      *
+     * @since 1.72.0
      * @private
      */
-
-    var oServiceConfig = {};
-
     var MessageBroker = function (oContainerInterface, sParameters, oServiceConfiguration) {
         oServiceConfig = oServiceConfiguration && oServiceConfiguration.config || {};
         MessageBrokerEngine.setEnabled(this.isEnabled());
@@ -175,4 +175,4 @@ sap.ui.define([
 
     MessageBroker.hasNoAdapter = true;
     return MessageBroker;
-}, false);
+});

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

@@ -35,8 +35,8 @@ sap.ui.define([
      * @class
      * @classdesc The Unified Shell's internal navigation target resolution service.
      *
-     * <b>Please note:</b> To retrieve a valid instance of this service you must call
-     * <code>sap.ushell.Container.getServiceAsync("NavTargetResolution")</code>. For details see
+     * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
+     * <code>sap.ushell.Container.getServiceAsync("NavTargetResolution")</code>. For details, see
      * {@link sap.ushell.services.Container#getServiceAsync}.
      *
      * Methods in this class deal with *internal* representations of the shell hash.
@@ -46,33 +46,33 @@ sap.ui.define([
      *   allow to redefine the Test-url, Test-local1, Test-local2 applications via url parameters
      *   (sap-ushell-test-local1-url=  / sap-ushell-test-local1-additionalInformation=  ... )
      *
-     * @hideconstructor
-     *
      * @param {object} oAdapter Adapter
      * @param {object} oContainerInterface not used
      * @param {string} sParameters not used
      * @param {object} oServiceConfiguration oServiceConfiguration
      *
+     * @hideconstructor
+     *
      * @since 1.15.0
      * @public
      */
     function NavTargetResolution (oAdapter, oContainerInterface, sParameters, oServiceConfiguration) {
-        var oServiceConfig = oServiceConfiguration && oServiceConfiguration.config,
-            fnResolveHashFragment = function (sHashFragment) {
-                var oResolutionPromise = this._isClientSideTargetResolutionEnabled()
-                    ? this._resolveHashFragmentClientSide(sHashFragment)
-                    : oAdapter.resolveHashFragment(sHashFragment);
-
-                return oResolutionPromise;
-            }.bind(this),
-            aLocalResolvedNavTargets,
-            // oAdapter resolver is the "last" custom resolver
-            aResolvers = [{
-                name: "DefaultAdapter",
-                isApplicable: function () { return true; },
-                resolveHashFragment: fnResolveHashFragment.bind(this)
-            }],
-            oCurrentResolution;
+        var oServiceConfig = oServiceConfiguration && oServiceConfiguration.config;
+        var fnResolveHashFragment = function (sHashFragment) {
+            var oResolutionPromise = this._isClientSideTargetResolutionEnabled()
+                ? this._resolveHashFragmentClientSide(sHashFragment)
+                : oAdapter.resolveHashFragment(sHashFragment);
+
+            return oResolutionPromise;
+        }.bind(this);
+        var aLocalResolvedNavTargets;
+        // oAdapter resolver is the "last" custom resolver
+        var aResolvers = [{
+            name: "DefaultAdapter",
+            isApplicable: function () { return true; },
+            resolveHashFragment: fnResolveHashFragment.bind(this)
+        }];
+        var oCurrentResolution;
 
         var oHttpClient = new HttpClient();
 
@@ -102,15 +102,12 @@ sap.ui.define([
          * @since 1.34.0
          */
         this._resolveHashFragmentClientSide = function (sHashFragment) {
-            var oHashValidationResult = this._validateHashFragment(sHashFragment),
-                sFragmentNoHash;
-
+            var oHashValidationResult = this._validateHashFragment(sHashFragment);
             if (!oHashValidationResult.success) {
                 return new jQuery.Deferred().reject(sHashFragment + " is not a valid hash fragment").promise();
             }
 
-            sFragmentNoHash = oHashValidationResult.hashFragmentWithoutHash;
-
+            var sFragmentNoHash = oHashValidationResult.hashFragmentWithoutHash;
             return this._resolveHashFragmentClientSideAndFixApplicationType(sFragmentNoHash);
         };
 
@@ -160,10 +157,10 @@ sap.ui.define([
          * @since 1.34.0
          */
         this._validateHashFragment = function (sHashFragment) {
-            var sHashFragmentWithoutHash = "",
-                oValidationResult = {
-                    success: false
-                };
+            var sHashFragmentWithoutHash = "";
+            var oValidationResult = {
+                success: false
+            };
 
             if (sHashFragment && sHashFragment.charAt(0) !== "#") {
                 throw new utils.Error(
@@ -196,12 +193,10 @@ sap.ui.define([
          * @alias sap.ushell.services.NavTargetResolution#expandCompactHash
          */
         this.expandCompactHash = function (sHashFragment) {
-            var oParsedShellHash,
-                oDeferred = new jQuery.Deferred();
+            var oDeferred = new jQuery.Deferred();
 
             // augment URL with application parameters from sHashFragment
-            oParsedShellHash = UrlParsing.parseShellHash(sHashFragment);
-
+            var oParsedShellHash = UrlParsing.parseShellHash(sHashFragment);
             if (oParsedShellHash && oParsedShellHash.params && oParsedShellHash.params["sap-intent-param"]) {
                 sap.ushell.Container.getServiceAsync("AppState")
                     .then(function (AppStateService) {
@@ -247,9 +242,6 @@ sap.ui.define([
          * @private
          */
         this._adjustResolutionResultForUi5Components = function (oResolvedHashFragment) {
-            var aMatches,
-                sComponentName;
-
             if (typeof oResolvedHashFragment !== "object") {
                 return;
             }
@@ -260,9 +252,8 @@ sap.ui.define([
             }
 
             if (oResolvedHashFragment.applicationType === "URL") {
-                aMatches = /^SAPUI5\.Component=(.*)/.exec(oResolvedHashFragment.additionalInformation);
-                sComponentName = aMatches && aMatches[1];
-
+                var aMatches = /^SAPUI5\.Component=(.*)/.exec(oResolvedHashFragment.additionalInformation);
+                var sComponentName = aMatches && aMatches[1];
                 if (sComponentName) {
                     oResolvedHashFragment.ui5ComponentName = sComponentName;
                 }
@@ -375,9 +366,9 @@ sap.ui.define([
          * Example of the returned data:
          *   <pre>
          *   {
-         *     "additionalInformation": "SAPUI5.Component=sap.ushell.renderers.fiori2.search.container",
+         *     "additionalInformation": "SAPUI5.Component=sap.ushell.renderer.search.container",
          *     "applicationType": "URL",
-         *     "url": "/sap/bc/ui5_ui5/ui2/ushell/resources/sap/ushell/renderers/fiori2/search/container",
+         *     "url": "/sap/bc/ui5_ui5/ui2/ushell/resources/sap/ushell/renderer/search/container",
          *     "navigationMode": "embedded"
          *   }
          *   </pre>
@@ -517,7 +508,6 @@ sap.ui.define([
 
             if (Object.prototype.toString.apply(oArgs.paramsOptions) === "[object Array]"
                 && oArgs.paramsOptions.length > 0) {
-
                 Log.warning(
                     "Parameter options supplied to #getLinks will be ignored because FLP is not configured to use sap.ushell.services.ClientSideTargetResolution for target resolution",
                     "provided parameters options: " + JSON.stringify(oArgs.paramsOptions, null, 4),
@@ -668,7 +658,6 @@ sap.ui.define([
                                     fnResolverBound(sSemanticObject, oMaybeCompactedParameters, bIgnoreFormFactor)
                                         .then(fnHandleGetLinksSuccess)
                                         .catch(oDeferred.reject);
-
                                 })
                                 .catch(oDeferred.reject);
                         });
@@ -678,7 +667,6 @@ sap.ui.define([
                         .done(fnHandleGetLinksSuccess)
                         .fail(oDeferred.reject);
                 }
-
             } else {
                 oDeferred.resolve([]);
             }
@@ -751,7 +739,6 @@ sap.ui.define([
                         oCallWithExpandedParamsDeferred.resolve(oParsedHash.params); // expanded params
                     })
                     .fail(oDeferred.reject);
-
             } else {
                 oCallWithExpandedParamsDeferred.resolve(oArgs.params);
             }
@@ -1008,8 +995,8 @@ sap.ui.define([
          * @alias sap.ushell.services.NavTargetResolution#isNavigationSupported
          */
         this.isNavigationSupported = function (aIntents) {
-            var oDeferred = new jQuery.Deferred(),
-                aIntentsAsString = [];
+            var oDeferred = new jQuery.Deferred();
+            var aIntentsAsString = [];
             aIntentsAsString = aIntents.map(function (oArg) {
                 if (typeof oArg === "string") {
                     return oArg;
@@ -1113,21 +1100,16 @@ sap.ui.define([
                 },
                 // replace hash, then resolve to app
                 resolveHashFragment: function (sHashFragment) {
-                    var oDeferred,
-                        idx = this._getIndex(sHashFragment),
-                        oResolvedResult,
-                        obj,
-                        hasQM,
-                        newsh;
-                    oDeferred = new jQuery.Deferred();
-                    oResolvedResult = JSON.parse(JSON.stringify(oServiceConfig.resolveLocal[idx].resolveTo));
+                    var idx = this._getIndex(sHashFragment);
+                    var oDeferred = new jQuery.Deferred();
+                    var oResolvedResult = JSON.parse(JSON.stringify(oServiceConfig.resolveLocal[idx].resolveTo));
 
                     // augment url with application parameters from sHashFragment
-                    obj = UrlParsing.parseShellHash(sHashFragment);
+                    var obj = UrlParsing.parseShellHash(sHashFragment);
                     if (obj && obj.params) {
-                        newsh = UrlParsing.paramsToString(obj.params);
+                        var newsh = UrlParsing.paramsToString(obj.params);
                         if (newsh) {
-                            hasQM = oResolvedResult.url.indexOf("?") >= 0;
+                            var hasQM = oResolvedResult.url.indexOf("?") >= 0;
                             oResolvedResult.url = oResolvedResult.url + (hasQM ? "&" : "?") + newsh;
                         }
                     }
@@ -1177,19 +1159,15 @@ sap.ui.define([
                 return this.aElement;
             },
             resolveHashFragment: function (sHashFragment) {
-                var oDeferred = new jQuery.Deferred(),
-                    hardCoded = null,
-                    res,
-                    oLocal,
-                    additionalInformation,
-                    sPrefix,
-                    url,
-                    that = this;
+                var oDeferred = new jQuery.Deferred();
+                var res;
+                var oLocal;
+                var that = this;
                 sHashFragment = this.cleanHash(sHashFragment);
                 if (!sHashFragment) {
                     return false;
                 }
-                hardCoded = {
+                var hardCoded = {
                     "#Test-config": {
                         applicationType: "URL",
                         url: "/sap/bc/ui5_ui5/ui2/ushell/test-resources/sap/ushell/demoapps/FioriSandboxConfigApp",
@@ -1241,12 +1219,12 @@ sap.ui.define([
                     // unless explicitly enabled by config
                     if ((window.location.hostname === "localhost") ||
                         (oServiceConfig && oServiceConfig.allowTestUrlComponentConfig)) {
-                        sPrefix = "sap-ushell-test-" + sHashFragment.substring(6);
-                        additionalInformation = getURLParameter(sPrefix + "-additionalInformation");
+                        var sPrefix = "sap-ushell-test-" + sHashFragment.substring(6);
+                        var additionalInformation = getURLParameter(sPrefix + "-additionalInformation");
                         if (additionalInformation) {
                             oLocal.additionalInformation = additionalInformation;
                         }
-                        url = getURLParameter(sPrefix + "-url");
+                        var url = getURLParameter(sPrefix + "-url");
                         if (url) {
                             oLocal.url = localURL(url);
                         }