@openui5/sap.ui.fl 1.96.2 → 1.98.0

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

@@ -1,53 +1,43 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
 sap.ui.define([
-	"sap/ui/thirdparty/jquery",
-	"sap/ui/core/Component",
-	"sap/ui/core/util/reflection/BaseTreeModifier",
-	"sap/ui/thirdparty/hasher",
-	"sap/base/Log",
-	"sap/base/util/UriParameters",
-	"sap/base/util/uid",
 	"sap/base/strings/formatMessage",
-	"sap/ui/base/ManagedObject",
-	"sap/ui/core/mvc/View",
 	"sap/base/util/isPlainObject",
-	"sap/ui/base/SyncPromise"
-],
-function(
-	jQuery,
-	Component,
-	BaseTreeModifier,
-	hasher,
-	Log,
-	UriParameters,
-	uid,
+	"sap/base/util/uid",
+	"sap/base/util/UriParameters",
+	"sap/base/Log",
+	"sap/ui/base/SyncPromise",
+	"sap/ui/base/ManagedObject",
+	"sap/ui/core/util/reflection/BaseTreeModifier",
+	"sap/ui/core/Component",
+	"sap/ui/thirdparty/hasher",
+	"sap/ui/thirdparty/jquery"
+], function(
 	formatMessage,
-	ManagedObject,
-	View,
 	isPlainObject,
-	SyncPromise
+	uid,
+	UriParameters,
+	Log,
+	SyncPromise,
+	ManagedObject,
+	BaseTreeModifier,
+	Component,
+	hasher,
+	jQuery
 ) {
 	"use strict";
 
-	function appendComponentToString(sComponentName) {
-		if (sComponentName.length > 0 && sComponentName.indexOf(".Component") < 0) {
-			sComponentName += ".Component";
-		}
-		return sComponentName;
-	}
-
 	/**
 	 * Provides utility functions for the SAPUI5 flexibility library
 	 *
 	 * @namespace
 	 * @alias sap.ui.fl.Utils
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.98.0
 	 * @experimental Since 1.25.0
 	 */
 	var Utils = {
@@ -68,85 +58,6 @@ function(
 			Log[sLogType](sLogMessage, sCallStack || "");
 		},
 
-		/**
-		 * Tries to retrieve the xsrf token from the controls OData Model. Returns empty string if retrieval failed.
-		 *
-		 * @param {sap.ui.core.Control} oControl - SAPUI5 control
-		 * @returns {String} XSRF Token
-		 * @public
-		 * @function
-		 * @name sap.ui.fl.Utils.getXSRFTokenFromControl
-		 */
-		getXSRFTokenFromControl: function(oControl) {
-			var oModel;
-			if (!oControl) {
-				return "";
-			}
-
-			// Get Model
-			if (oControl && typeof oControl.getModel === "function") {
-				oModel = oControl.getModel();
-				return Utils._getXSRFTokenFromModel(oModel);
-			}
-			return "";
-		},
-
-		/**
-		 * Returns XSRF Token from the Odata Model. Returns empty string if retrieval failed
-		 *
-		 * @param {sap.ui.model.odata.ODataModel} oModel - OData Model
-		 * @returns {String} XSRF Token
-		 * @private
-		 */
-		_getXSRFTokenFromModel: function(oModel) {
-			var mHeaders;
-			if (!oModel) {
-				return "";
-			}
-			if (typeof oModel.getHeaders === "function") {
-				mHeaders = oModel.getHeaders();
-				if (mHeaders) {
-					return mHeaders["x-csrf-token"];
-				}
-			}
-			return "";
-		},
-
-		/**
-		 * Returns the class name of the component the given control belongs to.
-		 *
-		 * @param {sap.ui.core.Control} oControl - SAPUI5 control
-		 *
-		 * @returns {String} The component class name, ending with ".Component"
-		 * @see sap.ui.core.Component.getOwnerIdFor
-		 * @public
-		 * @function
-		 * @name sap.ui.fl.Utils.getComponentClassName
-		 */
-		getComponentClassName: function(oControl) {
-			var oAppComponent;
-
-			// determine UI5 component out of given control
-			if (oControl) {
-				// always return the app component
-				oAppComponent = this.getAppComponentForControl(oControl);
-
-				// check if the component is an application variant and assigned an application descriptor then use this as reference
-				if (oAppComponent) {
-					var sVariantId = this._getComponentStartUpParameter(oAppComponent, "sap-app-id");
-					if (sVariantId) {
-						return sVariantId;
-					}
-
-					if (oAppComponent.getManifestEntry("sap.ui5") && oAppComponent.getManifestEntry("sap.ui5").appVariantId) {
-						return oAppComponent.getManifestEntry("sap.ui5").appVariantId;
-					}
-				}
-			}
-
-			return Utils.getComponentName(oAppComponent);
-		},
-
 		isVariantByStartupParameter: function(oControl) {
 			// determine UI5 component out of given control
 			if (oControl) {
@@ -159,22 +70,6 @@ function(
 			return false;
 		},
 
-		/**
-		 * Returns the class name of the application component owning the passed component or the component name itself if
-		 * this is already an application component.
-		 *
-		 * @param {sap.ui.core.Component} oComponent - SAPUI5 component
-		 * @returns {String} The component class name, ending with ".Component"
-		 * @see sap.ui.core.Component.getOwnerIdFor
-		 * @public
-		 * @since 1.40
-		 * @function
-		 * @name getAppComponentClassNameForComponent
-		 */
-		getAppComponentClassNameForComponent: function(oComponent) {
-			return Utils.getComponentClassName(oComponent);
-		},
-
 		/**
 		 * Returns the appDescriptor of the component for the given control
 		 *
@@ -205,37 +100,6 @@ function(
 			return oManifest;
 		},
 
-		/**
-		 * Returns the siteId of a component
-		 *
-		 * @param {sap.ui.core.Control} oControl - SAPUI5 control
-		 * @returns {string} siteId - that represent the found siteId
-		 * @public
-		 * @function
-		 * @name sap.ui.fl.Utils.getSiteId
-		 */
-		getSiteId: function(oControl) {
-			var sSiteId = null;
-			var oAppComponent = null;
-
-			// determine UI5 component out of given control
-			if (oControl) {
-				oAppComponent = this.getAppComponentForControl(oControl);
-
-				// determine siteId from ComponentData
-				if (oAppComponent) {
-					//Workaround for back-end check: isApplicationPermitted
-					//As long as FLP does not know about appDescriptorId we have to pass siteID and applicationID.
-					//With startUpParameter hcpApplicationId we will get a concatenation of “siteId:applicationId”
-
-					//sSiteId = this._getComponentStartUpParameter(oComponent, "scopeId");
-					sSiteId = this._getComponentStartUpParameter(oAppComponent, "hcpApplicationId");
-				}
-			}
-
-			return sSiteId;
-		},
-
 		/**
 		 * Returns the siteId of a component when you already have the component data.
 		 *
@@ -277,22 +141,6 @@ function(
 			);
 		},
 
-		/**
-		 * Indicates if the current application is a variant of an existing one
-		 *
-		 * @param {sap.ui.core.Control} oControl - SAPUI5 control
-		 * @returns {boolean} true if it's an application variant
-		 * @public
-		 * @function
-		 * @name sap.ui.fl.Utils.isApplicationVariant
-		 */
-		isApplicationVariant: function(oControl) {
-			var sFlexReference = Utils.getComponentClassName(oControl);
-			var oAppComponent = Utils.getAppComponentForControl(oControl);
-			var sComponentName = Utils.getComponentName(oAppComponent);
-			return sFlexReference !== sComponentName;
-		},
-
 		/**
 		 * Determines if the passed change is related to control variants.
 		 * @see sap.ui.fl.variants.VariantManagement
@@ -336,21 +184,6 @@ function(
 			}
 		},
 
-		/**
-		 * Gets the component name for a component instance.
-		 *
-		 * @param {sap.ui.core.Component} oComponent component instance
-		 * @returns {String} component name
-		 * @public
-		 */
-		getComponentName: function(oComponent) {
-			var sComponentName = "";
-			if (oComponent) {
-				sComponentName = oComponent.getMetadata().getName();
-			}
-			return appendComponentToString(sComponentName);
-		},
-
 		/**
 		 * Gets the component instance for a component ID.
 		 *
@@ -511,41 +344,6 @@ function(
 			}
 		},
 
-		hasControlAncestorWithId: function(sControlId, sAncestorControlId) {
-			var oControl;
-
-			if (sControlId === sAncestorControlId) {
-				return true;
-			}
-
-			oControl = sap.ui.getCore().byId(sControlId);
-			while (oControl) {
-				if (oControl.getId() === sAncestorControlId) {
-					return true;
-				}
-
-				if (typeof oControl.getParent === "function") {
-					oControl = oControl.getParent();
-				} else {
-					return false;
-				}
-			}
-
-			return false;
-		},
-
-		/**
-		 * Checks whether the provided control is a view
-		 *
-		 * @param {sap.ui.core.Control} oControl - SAPUI5 control
-		 * @returns {boolean} Flag
-		 * @see sap.ui.core.Component.getOwnerIdFor
-		 * @private
-		 */
-		_isView: function(oControl) {
-			return oControl instanceof View;
-		},
-
 		/**
 		 * Returns OwnerId of the control
 		 *
@@ -717,19 +515,6 @@ function(
 			return window.location.search.substring(1);
 		},
 
-		/**
-		 * Returns a map of technical parameters for the passed component.
-		 *
-		 * @param  {object} oComponent - Component instance used to get the technical parameters
-		 * @returns {object|undefined} Returns the requested technical parameter object or undefined if unavailable
-		 */
-		getTechnicalParametersForComponent: function(oComponent) {
-			return oComponent
-				&& oComponent.getComponentData
-				&& oComponent.getComponentData()
-				&& oComponent.getComponentData().technicalParameters;
-		},
-
 		/**
 		 * Returns URL hash when ushell container is available synchronously.
 		 *
@@ -743,25 +528,6 @@ function(
 			return {};
 		},
 
-		/**
-		 * Checks the SAPUI5 debug settings to determine whether all or at least the <code>sap.ui.fl</code> library is debugged.
-		 *
-		 * @returns {boolean} Returns a flag if the flexibility library is debugged
-		 * @public
-		 */
-		isDebugEnabled: function() {
-			var oUriParams = this._getUriParameters();
-			var sDebugParameters = oUriParams.get("sap-ui-debug") || "";
-
-			// true if SAPUI5 is in complete debug mode
-			if (sap.ui.getCore().getConfiguration().getDebug() || sDebugParameters === "true") {
-				return true;
-			}
-
-			var aDebugParameters = sDebugParameters.split(",");
-			return aDebugParameters.indexOf("sap/ui/fl") !== -1 || aDebugParameters.indexOf("sap/ui/fl/") !== -1;
-		},
-
 		/**
 		 * Returns the value of the specified url parameter of the current url
 		 *
@@ -850,7 +616,7 @@ function(
 
 		/** Returns the type of "sap.app" from the manifest object passed.
 		 * @param {sap.ui.core.Manifest} oManifest - Manifest object
-		 * @returns {string | undefined} Manifest object's "type" property for "sap.app" entry
+		 * @returns {string|undefined} Manifest object's <code>type</code> property for <code>sap.app</code> entry
 		 * @private
 		 */
 		_getComponentTypeFromManifest: function(oManifest) {
@@ -858,8 +624,8 @@ function(
 		},
 
 		/** Returns the type of "sap.app" from the manifest object passed.
-		 * @param {sap.ui.core.Manifest} oRawManifest - raw manifest object
-		 * @returns {string | undefined} Manifest object's "type" property for "sap.app" entry
+		 * @param {sap.ui.core.Manifest} oManifest - Raw manifest object
+		 * @returns {string|undefined} Manifest object's <code>type</code> property for <code>sap.app</code> entry
 		 * @private
 		 */
 		_getComponentTypeFromRawManifest: function(oManifest) {
@@ -895,36 +661,10 @@ function(
 			return oComponent instanceof Component && Utils._getComponentTypeFromManifest(oComponent.getManifestObject()) === "component";
 		},
 
-		/**
-		 * Returns the reference of a component, according to the following logic:
-		 * First appVariantId, if not, componentName + ".Component", if not appId + ".Component" (unless they already have ".Component" at the end).
-		 *
-		 * @param {object} oManifest - Manifest of the component
-		 * @returns {string} flex reference
-		 * @public
-		 */
-		getFlexReference: function(oManifest) {
-			if (oManifest) {
-				if (oManifest.getEntry("sap.ui5")) {
-					if (oManifest.getEntry("sap.ui5").appVariantId) {
-						return oManifest.getEntry("sap.ui5").appVariantId;
-					}
-					if (oManifest.getEntry("sap.ui5").componentName) {
-						return appendComponentToString(oManifest.getEntry("sap.ui5").componentName);
-					}
-				}
-				if (oManifest.getEntry("sap.app") && oManifest.getEntry("sap.app").id) {
-					return appendComponentToString(Utils.getAppIdFromManifest(oManifest));
-				}
-			}
-			Log.warning("No Manifest received.");
-			return "";
-		},
-
 		/**
 		 * Returns the descriptor Id, which is always the reference for descriptor changes
 		 *
-		 * @param {object} oManifest - Manifest of the component
+		 * @param {object|sap.ui.core.Manifest} oManifest - Manifest of the component
 		 * @returns {string} Version of application if it is available in the manifest, otherwise an empty string
 		 * @public
 		 */
@@ -932,8 +672,13 @@ function(
 			if (oManifest) {
 				var oSapApp = (oManifest.getEntry) ? oManifest.getEntry("sap.app") : oManifest["sap.app"];
 				var sAppId = oSapApp && oSapApp.id;
-				if (sAppId === Utils.APP_ID_AT_DESIGN_TIME && oManifest.getComponentName) {
-					sAppId = oManifest.getComponentName();
+				if (sAppId === Utils.APP_ID_AT_DESIGN_TIME) {
+					if (oManifest.getComponentName) {
+						return oManifest.getComponentName();
+					}
+					if (oManifest.name) {
+						return oManifest.name;
+					}
 				}
 				return sAppId;
 			}
@@ -941,26 +686,6 @@ function(
 			throw new Error("No Manifest received, descriptor changes are not possible");
 		},
 
-		/**
-		 * Returns the uri of the main service specified in the app manifest
-		 *
-		 * @param {object} oManifest - Manifest of the component
-		 * @returns {string} Returns the uri if the manifest is available, otherwise an empty string
-		 * @public
-		 */
-		getODataServiceUriFromManifest: function(oManifest) {
-			var sUri = "";
-			if (oManifest) {
-				var oSapApp = (oManifest.getEntry) ? oManifest.getEntry("sap.app") : oManifest["sap.app"];
-				if (oSapApp && oSapApp.dataSources && oSapApp.dataSources.mainService && oSapApp.dataSources.mainService.uri) {
-					sUri = oSapApp.dataSources.mainService.uri;
-				}
-			} else {
-				Log.warning("No Manifest received.");
-			}
-			return sUri;
-		},
-
 		/**
 		 * Checks if an object is in an array or not and returns the index or -1
 		 *
@@ -1018,8 +743,9 @@ function(
 			}
 			var fnPromise = aPromiseQueue.shift();
 			if (typeof fnPromise === "function") {
+				var vResult;
 				try {
-					var vResult = fnPromise();
+					vResult = fnPromise();
 				} catch (e) {
 					vResult = Promise.reject(e);
 				}
@@ -1165,7 +891,7 @@ function(
 
 		/**
 		 * Normalize reference, delete .Component at the end of the incoming string.
-		 * @param {string} reference
+		 * @param {string} sReference - Flex reference
 		 * @returns {string} Returns reference without .Component
 		 */
 		normalizeReference: function(sReference) {

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -33,7 +33,7 @@ sap.ui.define([
 	 * @class Variant class.
 	 * @extends sap.ui.base.ManagedObject
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.98.0
 	 * @alias sap.ui.fl.Variant
 	 * @experimental Since 1.52.0
 	 */
@@ -188,20 +188,6 @@ sap.ui.define([
 		return this._oDefinition.controlChanges;
 	};
 
-	/**
-	 * Returns the original language in ISO 639-1 format
-	 *
-	 * @returns {String} Original language
-	 *
-	 * @public
-	 */
-	Variant.prototype.getOriginalLanguage = function () {
-		if (this._oDefinition && this._oDefinition.content.originalLanguage) {
-			return this._oDefinition.content.originalLanguage;
-		}
-		return "";
-	};
-
 	/**
 	 * Returns the abap package name
 	 * @returns {string} ABAP package where the variant is assigned to
@@ -287,16 +273,6 @@ sap.ui.define([
 		return this._oDefinition.content.variantReference;
 	};
 
-	/**
-	 * Returns the user ID of the owner
-	 * @returns {string} ID of the owner
-	 *
-	 * @public
-	 */
-	Variant.prototype.getOwnerId = function () {
-		return this._oDefinition.content.support ? this._oDefinition.content.support.user : "";
-	};
-
 	/**
 	 * Returns the text in the current language for a given id
 	 *
@@ -340,77 +316,6 @@ sap.ui.define([
 		}
 	};
 
-	/**
-	 * Returns true if the current layer is the same as the layer
-	 * in which the variant was created or the variant is from the
-	 * end-user layer and for this user created.
-	 * @returns {boolean} is the variant read only
-	 *
-	 * @public
-	 */
-	Variant.prototype.isReadOnly = function () {
-		return this._isReadOnlyDueToLayer() || this._isReadOnlyWhenNotKeyUser();
-	};
-
-	/**
-	 * Checks if the variant is read-only
-	 * because the current user is not a key user and the change is "shared"
-	 * @returns {boolean} Flag whether variant is read only
-	 *
-	 * @private
-	 */
-	Variant.prototype._isReadOnlyWhenNotKeyUser = function () {
-		if (this.isUserDependent()) {
-			return false; // the user always can edit its own variants
-		}
-
-		var sReference = this.getDefinition().reference;
-		if (!sReference) {
-			return true; // without a reference the right to edit or delete a variant cannot be determined
-		}
-
-		var oSettings = Settings.getInstanceOrUndef();
-		if (!oSettings) {
-			return true; // without settings the right to edit or delete a variant cannot be determined
-		}
-
-		return !oSettings.isKeyUser(); // a key user can edit changes
-	};
-
-	/**
-	 * Checks if the layer allows modifying the file
-	 * @returns {boolean} Flag whether variant is read only
-	 *
-	 * @private
-	 */
-	Variant.prototype._isReadOnlyDueToLayer = function () {
-		var sCurrentLayer;
-		sCurrentLayer = this._bUserDependent ? Layer.USER : LayerUtils.getCurrentLayer();
-		return (this._oDefinition.content.layer !== sCurrentLayer);
-	};
-
-	/**
-	 * A variant can only be modified if the current language equals the original language.
-	 * Returns false if the current language does not equal the original language of the variant's change file.
-	 * Returns false if the original language is initial.
-	 *
-	 * @returns {boolean} flag whether the current logon language differs from the original language of the variant's change document
-	 *
-	 * @private
-	 */
-	Variant.prototype._isReadOnlyDueToOriginalLanguage = function () {
-		var sCurrentLanguage;
-		var sOriginalLanguage;
-
-		sOriginalLanguage = this.getOriginalLanguage();
-		if (!sOriginalLanguage) {
-			return false;
-		}
-
-		sCurrentLanguage = Utils.getCurrentLanguage();
-		return (sCurrentLanguage !== sOriginalLanguage);
-	};
-
 	/**
 	 * Marks the current variant to be deleted persistently
 	 *
@@ -485,16 +390,6 @@ sap.ui.define([
 		return this._oDefinition.content.creation;
 	};
 
-	/**
-	 * Returns true if the variant is user dependent
-	 * @returns {boolean} Variant is only relevant for the current user
-	 *
-	 * @public
-	 */
-	Variant.prototype.isUserDependent = function () {
-		return (this._bUserDependent);
-	};
-
 	/**
 	 * Gets the JSON definition of the variant
 	 * @returns {object} the content of the variant
@@ -520,15 +415,6 @@ sap.ui.define([
 		}
 	};
 
-	Variant.prototype.getFullFileIdentifier = function () {
-		var sLayer = this.getLayer();
-		var sNamespace = this.getNamespace();
-		var sFileName = this.getDefinition().content.fileName;
-		var sFileType = this.getDefinition().content.fileType;
-
-		return sLayer + "/" + sNamespace + "/" + sFileName + "." + sFileType;
-	};
-
 	/**
 	 * Returns the revert specific data
 	 *

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

@@ -1,17 +1,19 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
 sap.ui.define([
 	"sap/ui/core/Component",
+	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
 	"sap/ui/fl/FlexControllerFactory",
 	"sap/ui/fl/Utils",
 	"sap/ui/fl/ChangePersistenceFactory",
 	"sap/base/Log"
 ], function(
 	Component,
+	ManifestUtils,
 	FlexControllerFactory,
 	Utils,
 	ChangePersistenceFactory,
@@ -26,21 +28,19 @@ sap.ui.define([
 	 * @class
 	 * @constructor
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.98.0
 	 * @experimental Since 1.27.0
 	 */
-	var XmlPreprocessorImpl = function() {
-	};
+	var XmlPreprocessorImpl = function() {};
 
 	/**
 	 * Asynchronous view processing method.
 	 *
-	 * @param {Node} oView XML node of the view to process
-	 * @param {object} mProperties
-	 * @param {string} mProperties.componentId - id of the component creating the view
-	 * @param {string} mPropertyBag.id - id of the processed view
-	 *
-	 * @returns {Promise.<Node>|Node} result of the processing, promise if executed asynchronously
+	 * @param {Node} oView - XML node of the view to process
+	 * @param {object} mProperties - Property Bag
+	 * @param {string} mProperties.componentId - ID of the component creating the view
+	 * @param {string} mPropertyBag.id - ID of the processed view
+	 * @returns {Promise.<Node>|Node} Result of the processing, promise if executed asynchronously
 	 *
 	 * @public
 	 */
@@ -68,7 +68,7 @@ sap.ui.define([
 				return Promise.resolve(oView);
 			}
 
-			var sFlexReference = Utils.getComponentClassName(oAppComponent);
+			var sFlexReference = ManifestUtils.getFlexReferenceForControl(oAppComponent);
 			var oFlexController = FlexControllerFactory.create(sFlexReference);
 
 			return oFlexController.processXmlView(oView, mProperties)
@@ -92,8 +92,9 @@ sap.ui.define([
 	/**
 	 * Asynchronous determination of a hash key for caching purposes
 	 *
-	 * @param {Node} oView XML node of the view for which the key should be determined
-	 * @returns {Promise} promise returning the hash key
+	 * @param {object} mProperties - Property Bag
+	 * @param {string} mProperties.componentId - Component instance ID
+	 * @returns {Promise} Resolves with the hash key
 	 *
 	 * @public
 	 */
@@ -106,7 +107,7 @@ sap.ui.define([
 			return Promise.resolve();
 		}
 
-		var sFlexReference = Utils.getComponentClassName(oAppComponent);
+		var sFlexReference = ManifestUtils.getFlexReferenceForControl(oAppComponent);
 		var oChangePersistence = ChangePersistenceFactory.getChangePersistenceForComponent(sFlexReference);
 		return oChangePersistence.getCacheKey(oAppComponent);
 	};