@openui5/sap.ui.fl 1.115.1 → 1.117.0

package/src/sap/ui/fl/Utils.js

@@ -5,7 +5,6 @@
  */
 
 sap.ui.define([
-	"sap/base/strings/formatMessage",
 	"sap/base/util/ObjectPath",
 	"sap/base/util/isPlainObject",
 	"sap/base/util/uid",
@@ -20,7 +19,6 @@ sap.ui.define([
 	"sap/ui/core/mvc/View",
 	"sap/ui/core/Configuration"
 ], function(
-	formatMessage,
 	ObjectPath,
 	isPlainObject,
 	uid,
@@ -37,7 +35,6 @@ sap.ui.define([
 ) {
 	"use strict";
 
-
 	/**
 	 * Returns the type of "sap.app" from the manifest object passed.
 	 * @param {sap.ui.core.Manifest} oManifest - Manifest object
@@ -67,26 +64,12 @@ sap.ui.define([
 	 * @namespace
 	 * @alias sap.ui.fl.Utils
 	 * @author SAP SE
-	 * @version 1.115.1
+	 * @version 1.117.0
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.fl, sap.ui.rta
 	 */
 	var Utils = {
-		/**
-		 * Formats the log message by replacing placeholders with values and logging the message.
-		 *
-		 * @param {string} sLogType - Logging type to be used. Possible values: info | warning | debug | error
-		 * @param {array.<string>} aMessageComponents - Individual parts of the message text
-		 * @param {array.<any>} aValuesToInsert - The values to be used instead of the placeholders in the message
-		 * @param {string} [sCallStack] - Passes the callstack to the logging function
-		 */
-		formatAndLogMessage: function(sLogType, aMessageComponents, aValuesToInsert, sCallStack) {
-			var sLogMessage = aMessageComponents.join(' ');
-			sLogMessage = formatMessage(sLogMessage, aValuesToInsert);
-			Log[sLogType](sLogMessage, sCallStack || "");
-		},
-
 		isVariantByStartupParameter: function(oControl) {
 			// determine UI5 component out of given control
 			if (oControl) {
@@ -125,21 +108,6 @@ sap.ui.define([
 			}
 		},
 
-		/**
-		 * Returns the siteId of a component when you already have the component data.
-		 *
-		 * @param {object} oComponentData - Component data
-		 * @returns {string} siteId - that represent the found siteId
-		 * @function
-		 * @name sap.ui.fl.Utils.getSiteIdByComponentData
-		 *
-		 * @private
-		 * @ui5-restricted sap.ui.fl.apply._internal.flexState.Loader
-		 */
-		getSiteIdByComponentData: function(oComponentData) {
-			return getStartUpParameter(oComponentData, "hcpApplicationId");
-		},
-
 		/**
 		 * Indicates if the property value represents a binding
 		 *
@@ -170,23 +138,6 @@ sap.ui.define([
 			);
 		},
 
-		/**
-		 * Determines if the passed change is related to control variants.
-		 * @see sap.ui.fl.variants.VariantManagement
-		 * @param {sap.ui.fl.apply._internal.flexObjects.FlexObject} oChange Change object
-		 * @returns {boolean} If the passed change is a variant management change
-		 * @name sap.ui.fl.Utils.isChangeRelatedToVariants
-		 *
-		 * @private
-		 * @ui5-restricted sap.ui.fl.ChangePersistence
-		 */
-		isChangeRelatedToVariants: function(oChange) {
-			return oChange.getFileType() === "ctrl_variant_change"
-				|| oChange.getFileType() === "ctrl_variant_management_change"
-				|| oChange.getFileType() === "ctrl_variant"
-				|| oChange.getVariantReference();
-		},
-
 		/**
 		 * Returns the Component that belongs to given control. If the control has no component, it walks up the control tree in order to find a
 		 * control having one.
@@ -197,7 +148,7 @@ sap.ui.define([
 		 * @ui5-restricted sap.ui.fl
 		 */
 		getComponentForControl: function(oControl) {
-			function getComponentIdForControl (oControl) {
+			function getComponentIdForControl(oControl) {
 				var sComponentId = Component.getOwnerIdFor(oControl);
 				if (!sComponentId) {
 					if (oControl && typeof oControl.getParent === "function") {
@@ -224,7 +175,7 @@ sap.ui.define([
 		 * If the control has no component, it walks up the control tree in order to find a control having one.
 		 *
 		 * @param {sap.ui.base.ManagedObject} oControl - Managed object instance
-		 * @returns {sap.ui.core.Component} component instance if found or null
+		 * @returns {sap.ui.core.Component} Component instance if found or undefined
 		 * @private
 		 * @ui5-restricted sap.ui.fl
 		 */
@@ -257,6 +208,20 @@ sap.ui.define([
 			return oComponent;
 		},
 
+		/**
+		 * Returns the component that belongs to the passed selector whose type is "application".
+		 * If the control has no component, it walks up the control tree in order to find a control having one.
+		 * This does not work if called with a {@link sap.ui.fl.ComponentSelector}
+		 *
+		 * @param {sap.ui.fl.Selector} oSelector - Selector object
+		 * @returns {sap.ui.core.Component} Component instance if found or undefined
+		 * @private
+		 * @ui5-restricted sap.ui.fl
+		 */
+		getAppComponentForSelector: function(oSelector) {
+			return oSelector.appComponent || Utils.getAppComponentForControl(oSelector);
+		},
+
 		/**
 		 * Returns the parent view of the control. If there are nested views, only the one closest to the control will be returned. If no view can be
 		 * found, undefiend will be returned.
@@ -316,33 +281,16 @@ sap.ui.define([
 		 */
 		getCurrentLanguage: function() {
 			var sLanguage = Configuration.getLanguage();
-			return Utils.convertBrowserLanguageToISO639_1(sLanguage);
-		},
-
-
-		/**
-		 * Converts the browser language into a 2-character ISO 639-1 language. If the browser language is in format RFC4646, the first part will be
-		 * used: For example en-us will be converted to EN. If the browser language already is in ISO 639-1, it will be returned after an upper case
-		 * conversion: For example de will be converted to DE.
-		 *
-		 * @function
-		 * @name sap.ui.fl.Utils.convertBrowserLanguageToISO639_1
-		 * @param {string} sBrowserLanguage - Language in RFC4646
-		 * @returns {string} Language in ISO 639-1. Empty string if conversion was not successful
-		 *
-		 * @private
-		 */
-		convertBrowserLanguageToISO639_1: function(sBrowserLanguage) {
-			if (!sBrowserLanguage || typeof sBrowserLanguage !== "string") {
+			if (!sLanguage || typeof sLanguage !== "string") {
 				return "";
 			}
 
-			var nIndex = sBrowserLanguage.indexOf("-");
-			if ((nIndex < 0) && (sBrowserLanguage.length <= 2)) {
-				return sBrowserLanguage.toUpperCase();
+			var nIndex = sLanguage.indexOf("-");
+			if ((nIndex < 0) && (sLanguage.length <= 2)) {
+				return sLanguage.toUpperCase();
 			}
 			if (nIndex > 0 && nIndex <= 2) {
-				return sBrowserLanguage.substring(0, nIndex).toUpperCase();
+				return sLanguage.substring(0, nIndex).toUpperCase();
 			}
 
 			return "";
@@ -418,7 +366,7 @@ sap.ui.define([
 		createDefaultFileName: function(sNameAddition) {
 			var sFileName = uid().replace(/-/g, "_");
 			if (sNameAddition) {
-				sFileName += '_' + sNameAddition;
+				sFileName += "_" + sNameAddition;
 			}
 			return sFileName;
 		},
@@ -428,8 +376,8 @@ sap.ui.define([
 			if (sFileType === "ctrl_variant") {
 				sSubfolder = "variants";
 			}
-			var sReferenceName = oPropertyBag.reference.replace('.Component', '');
-			var sNamespace = 'apps/' + sReferenceName + "/" + sSubfolder + "/";
+			var sReferenceName = oPropertyBag.reference.replace(".Component", "");
+			var sNamespace = "apps/" + sReferenceName + "/" + sSubfolder + "/";
 			return sNamespace;
 		},
 
@@ -506,13 +454,21 @@ sap.ui.define([
 
 		/** Returns <code>true</code> if the passed component is an embedded component.
 		 * @param {sap.ui.core.Component} oComponent - Component instance
-		 * @returns {boolean} <code>true</code> if the passed component is of type "component"
+		 * @returns {boolean} <code>true</code> if the passed component is of type "component" and has a parent app component
 		 *
 		 * @private
 		 * @ui5-restricted sap.ui.fl
 		 */
 		isEmbeddedComponent: function(oComponent) {
-			return oComponent instanceof Component && getComponentType(oComponent.getManifestObject()) === "component";
+			var oAppComponent = Utils.getAppComponentForControl(oComponent);
+			return !!(
+				oComponent instanceof Component
+				&& getComponentType(oComponent.getManifestObject()) === "component"
+				// Some embedded components might not have an app component
+				// e.g. sap.ushell.plugins.rta, sap.ushell.plugins.rta-personalize
+				&& oAppComponent
+				&& Utils.isApplicationComponent(oAppComponent)
+			);
 		},
 
 		/**
@@ -570,7 +526,7 @@ sap.ui.define([
 				if (bAsync) {
 					return Promise.resolve();
 				}
-				return new Utils.FakePromise();
+				return (Utils.FakePromise ? new Utils.FakePromise() : Promise.resolve());
 			}
 			var fnPromise = aPromiseQueue.shift();
 			if (typeof fnPromise === "function") {
@@ -614,6 +570,7 @@ sap.ui.define([
 		 * @param {any} vError - value on reject FakePromise
 		 * @param {string} sInitialPromiseIdentifier - value identifies previous promise in chain. If the identifier is passed to the function and don't match with the FakePromiseIdentifier then native Promise execution is used for further processing
 		 * @returns {sap.ui.fl.Utils.FakePromise|Promise} Returns instantiated FakePromise only if no Promise is passed by value parameter
+		 * @deprecated As of Version 1.114
 		 * @private
 		 * @ui5-restricted
 		 */
@@ -724,7 +681,7 @@ sap.ui.define([
 					sParameters = "?" + aFilterUrl.join("&");
 				}
 			} else {
-				sParameters += (sParameters.length > 0 ? '&' : '?') + sParameterName + "=" + sParameterValue;
+				sParameters += (sParameters.length > 0 ? "&" : "?") + sParameterName + "=" + sParameterValue;
 			}
 			return sParameters;
 		},
@@ -748,7 +705,7 @@ sap.ui.define([
 		 * @param  {sap.ushell.services.URLParsing} oURLParsingService - The Unified Shell's internal URL parsing service
 		 * @returns {string} The value of the given parameter or undefined
 		 */
-		getParameter: function (sParameterName, oURLParsingService) {
+		getParameter: function(sParameterName, oURLParsingService) {
 			if (oURLParsingService) {
 				var mParsedHash = Utils.getParsedURLHash(oURLParsingService);
 				return mParsedHash.params &&
@@ -783,7 +740,7 @@ sap.ui.define([
 		 * @param {string} sAggregationName - Aggregation name
 		 * @returns {sap.ui.base.ManagedObject[]|Element[]} Aggregation content
 		 */
-		getAggregation: function (oParent, sAggregationName) {
+		getAggregation: function(oParent, sAggregationName) {
 			var oAggregation = Utils.findAggregation(oParent, sAggregationName);
 			if (oAggregation) {
 				return oParent[oAggregation._sGetter]();
@@ -797,7 +754,7 @@ sap.ui.define([
 		 * @param {string} sPropertyName - Property name
 		 * @returns {any} Value of the property
 		 */
-		getProperty: function (oControl, sPropertyName) {
+		getProperty: function(oControl, sPropertyName) {
 			var oMetadata = oControl.getMetadata().getPropertyLikeSetting(sPropertyName);
 			if (oMetadata) {
 				var sPropertyGetter = oMetadata._sGetter;
@@ -827,12 +784,12 @@ sap.ui.define([
 		 * @param {array} aServiceNames - List of service names
 		 * @returns {Promise<object>} Resolves to an object with the requested ushell services
 		 */
-		getUShellServices: function (aServiceNames) {
-			var aServicePromises = aServiceNames.map(function (sServiceName) {
+		getUShellServices: function(aServiceNames) {
+			var aServicePromises = aServiceNames.map(function(sServiceName) {
 				return this.getUShellService(sServiceName);
 			}.bind(this));
-			return Promise.all(aServicePromises).then(function (aServices) {
-				return aServiceNames.reduce(function (mServices, sService, iIndex) {
+			return Promise.all(aServicePromises).then(function(aServices) {
+				return aServiceNames.reduce(function(mServices, sService, iIndex) {
 					mServices[sService] = aServices && aServices[iIndex];
 					return mServices;
 				}, {});

package/src/sap/ui/fl/apply/_internal/DelegateMediator.js

@@ -25,7 +25,7 @@ sap.ui.define([
 	 *
 	 * @private
 	 * @author SAP SE
-	 * @version 1.115.1
+	 * @version 1.117.0
 	 *
 	 * @experimental Since 1.80 This class is experimental and provides only limited functionality. Also the API might be
 	 *               changed in future.
@@ -57,7 +57,7 @@ sap.ui.define([
 	function getDefaultDelegateInfo(oControl, sModelType) {
 		sModelType = getModelTypeForControl(oControl, sModelType);
 		var aDelegateInfo = DelegateMediator._mDefaultDelegateItems[sModelType];
-		return (aDelegateInfo || []).map(function (mDelegateInfo) {
+		return (aDelegateInfo || []).map(function(mDelegateInfo) {
 			mDelegateInfo.payload = {};
 			return mDelegateInfo;
 		});
@@ -65,27 +65,27 @@ sap.ui.define([
 
 	function loadDelegates(oModifier, oControl, aDelegates) {
 		if (!aDelegates.length) {
-			//it is a valid case to ask for a delegate and there is none
-			//a broken delegate is logged below
+			// it is a valid case to ask for a delegate and there is none
+			// a broken delegate is logged below
 			return Promise.resolve([]);
 		}
 		var aPromises = [];
-		aDelegates.forEach(function (mDelegateInfo) {
-			aPromises.push(function (aLoadedDelegates) {
+		aDelegates.forEach(function(mDelegateInfo) {
+			aPromises.push(function(aLoadedDelegates) {
 				return requireAsync(mDelegateInfo.name)
-					.then(function (oDelegate) {
-						mDelegateInfo.instance = oDelegate || {};
-						aLoadedDelegates.push(mDelegateInfo);
-						return aLoadedDelegates;
-					})
-					.catch(function(oError) {
-						Log.error("Failed to load the delegate for the control " + oModifier.getId(oControl) +
+				.then(function(oDelegate) {
+					mDelegateInfo.instance = oDelegate || {};
+					aLoadedDelegates.push(mDelegateInfo);
+					return aLoadedDelegates;
+				})
+				.catch(function(oError) {
+					Log.error("Failed to load the delegate for the control " + oModifier.getId(oControl) +
 							"\n" + oError.message);
-						return aLoadedDelegates;
-					});
+					return aLoadedDelegates;
+				});
 			});
 		});
-		return aPromises.reduce(function (oPreviousPromise, oCurrentPromise) {
+		return aPromises.reduce(function(oPreviousPromise, oCurrentPromise) {
 			return oPreviousPromise.then(oCurrentPromise);
 		}, Promise.resolve([]));
 	}
@@ -122,6 +122,9 @@ sap.ui.define([
 			// is available maximum once for instancespecific delegate
 			mTargetDelegateInfo.payload = mDelegateInfo.payload;
 		}
+		if (mDelegateInfo.delegateType) {
+			mTargetDelegateInfo.delegateType = mDelegateInfo.delegateType;
+		}
 		return mTargetDelegateInfo;
 	}
 
@@ -173,7 +176,7 @@ sap.ui.define([
 	}
 
 	function validateInputParameters(oControl, oModifier) {
-		return new Promise(function (resolve, reject) {
+		return new Promise(function(resolve, reject) {
 			if (!oControl) {
 				reject(new Error("The control parameter is missing"));
 			}
@@ -194,14 +197,14 @@ sap.ui.define([
 	}
 
 	function isValidType(mPropertyBag) {
-		return Object.values(DelegateMediator.types).some(function (sDelegateMediatorType) {
+		return Object.values(DelegateMediator.types).some(function(sDelegateMediatorType) {
 			return sDelegateMediatorType === mPropertyBag.delegateType;
 		});
 	}
 
 	function isCompetingDelegateAlreadyRegistered(mPropertyBag) {
 		var aDefaultDelegates = DelegateMediator._mDefaultDelegateItems[mPropertyBag.modelType] || [];
-		var aDefaultDelegateTypes = aDefaultDelegates.map(function (mDefaultDelegateInfo) {
+		var aDefaultDelegateTypes = aDefaultDelegates.map(function(mDefaultDelegateInfo) {
 			return mDefaultDelegateInfo.delegateType;
 		});
 		return aDefaultDelegateTypes.indexOf(DelegateMediator.types.COMPLETE) > -1
@@ -209,7 +212,7 @@ sap.ui.define([
 			|| (mPropertyBag.delegateType === DelegateMediator.types.COMPLETE && aDefaultDelegateTypes.length);
 	}
 
-	DelegateMediator.getKnownDefaultDelegateLibraries = function () {
+	DelegateMediator.getKnownDefaultDelegateLibraries = function() {
 		return ["sap.ui.comp"]; // OdataV2Delegate is defined in sap.ui.comp
 	};
 
@@ -222,10 +225,10 @@ sap.ui.define([
 	 * @param {string} [sModelType] - Model type, if none is provided the default model of oControl is taken instead
 	 * @returns {string[]} Required libraries
 	 */
-	DelegateMediator.getRequiredLibrariesForDefaultDelegate = function (aDelegateNames, oControl, sModelType) {
+	DelegateMediator.getRequiredLibrariesForDefaultDelegate = function(aDelegateNames, oControl, sModelType) {
 		sModelType = getModelTypeForControl(oControl, sModelType);
 		var aDelegateInfo = DelegateMediator._mDefaultDelegateItems[sModelType] || [];
-		return aDelegateInfo.reduce(function (aRequiredLibNames, mDelegateInfo) {
+		return aDelegateInfo.reduce(function(aRequiredLibNames, mDelegateInfo) {
 			var bIsDefaultDelegate = aDelegateNames.indexOf(mDelegateInfo.name) > -1;
 			return aRequiredLibNames.concat(Object.keys((bIsDefaultDelegate && mDelegateInfo.requiredLibraries) || {}));
 		}, []);
@@ -237,7 +240,7 @@ sap.ui.define([
 	 * @param {string} sModelType - Delegate model type
 	 * @returns {boolean} <code>true</code> if a delegate is already registered for the model type
 	 */
-	DelegateMediator.isDelegateRegistered = function (sModelType) {
+	DelegateMediator.isDelegateRegistered = function(sModelType) {
 		return !!DelegateMediator._mDefaultDelegateItems[sModelType];
 	};
 
@@ -250,7 +253,7 @@ sap.ui.define([
 	 * @param {object} mPropertyBag.delegateType - Defines the type of the default delegate. Please look at <code>DelegageMediator.types</code> for possible entries
 	 * @param {object} [mPropertyBag.requiredLibraries] - map of required libraries
 	 */
-	DelegateMediator.registerDefaultDelegate = function (mPropertyBag) {
+	DelegateMediator.registerDefaultDelegate = function(mPropertyBag) {
 		if (!(mPropertyBag.modelType && mPropertyBag.delegate)) {
 			throw new Error("'modelType' and 'delegate' properties are required for registration!");
 		}
@@ -282,23 +285,23 @@ sap.ui.define([
 	 * @param {boolean} [bSupportsDefault] - Include default delegate if no instance specific delegate is available
 	 * @returns {Promise.<sap.ui.core.util.reflection.FlexDelegateInfo>} Delegate information including the lazy loaded instance of the delegate
 	 */
-	DelegateMediator.getDelegateForControl = function (oControl, oModifier, sModelType, bSupportsDefault) {
+	DelegateMediator.getDelegateForControl = function(oControl, oModifier, sModelType, bSupportsDefault) {
 		return validateInputParameters(oControl, oModifier)
-			.then(function () {
-				return oModifier.getFlexDelegate(oControl);
-			})
-			.then(function (mInstanceSpecificDelegate) {
-				var aDelegateInfo = (bSupportsDefault && getDefaultDelegateInfo(oControl, sModelType)) || [];
-				if (mInstanceSpecificDelegate) {
-					//instance specific delegate always takes over
-					aDelegateInfo.push(mInstanceSpecificDelegate);
-				}
-				return loadDelegates(oModifier, oControl, aDelegateInfo);
-			})
-			.then(mergeDelegates.bind(this));
+		.then(function() {
+			return oModifier.getFlexDelegate(oControl);
+		})
+		.then(function(mInstanceSpecificDelegate) {
+			var aDelegateInfo = (bSupportsDefault && getDefaultDelegateInfo(oControl, sModelType)) || [];
+			if (mInstanceSpecificDelegate) {
+				// instance specific delegate always takes over
+				aDelegateInfo.push(mInstanceSpecificDelegate);
+			}
+			return loadDelegates(oModifier, oControl, aDelegateInfo);
+		})
+		.then(mergeDelegates.bind(this));
 	};
 
-	DelegateMediator.clear = function () {
+	DelegateMediator.clear = function() {
 		DelegateMediator._mDefaultDelegateItems = {};
 	};
 

package/src/sap/ui/fl/apply/_internal/appVariant/DescriptorChangeTypes.js

@@ -5,7 +5,7 @@
  */
 
 sap.ui.define([
-], function (
+], function(
 ) {
 	"use strict";