@openui5/sap.ui.fl 1.102.2 → 1.104.0

package/src/sap/ui/fl/apply/_internal/flexObjects/CompVariant.js

@@ -7,22 +7,101 @@
 sap.ui.define([
 	"sap/base/util/restricted/_pick",
 	"sap/ui/fl/apply/_internal/flexObjects/States",
-	"sap/ui/fl/Change",
+	"sap/ui/fl/apply/_internal/flexObjects/Variant",
+	"sap/ui/fl/LayerUtils",
 	"sap/ui/fl/Layer",
 	"sap/ui/fl/registry/Settings",
-	"sap/ui/fl/LayerUtils",
 	"sap/ui/fl/Utils"
 ], function (
 	_pick,
 	States,
-	Change,
+	Variant,
+	LayerUtils,
 	Layer,
 	Settings,
-	LayerUtils,
 	Utils
 ) {
 	"use strict";
 
+	/**
+	 * Flexibility CompVariant class. Stores variant content and related information.
+	 *
+	 * @param {object} mPropertyBag - Initial object properties
+	 *
+	 * @class CompVariant instance
+	 * @extends sap.ui.fl.apply._internal.flexObjects.Variant
+	 * @alias sap.ui.fl.apply._internal.flexObjects.CompVariant
+	 * @since 1.103
+	 * @version 1.104.0
+	 * @private
+	 * @ui5-restricted sap.ui.fl sap.ui.comp
+	 */
+	var CompVariant = Variant.extend("sap.ui.fl.apply._internal.flexObjects.CompVariant", /** @lends sap.ui.fl.apply._internal.flexObjects.CompVariant.prototype */ {
+		metadata: {
+			properties: {
+				/**
+				 * Indicates whether the variant is persisted
+				 */
+				persisted: {
+					type: "boolean",
+					defaultValue: true
+				},
+				/**
+				 * Key used by SmartVariantManagement to access personalization data
+				 */
+				persistencyKey: {
+					type: "string"
+				}
+			},
+			aggregations: {
+				/**
+				 * Stores required data to revert variant updates.
+				 * TODO: When the FL Variant is also a FlexObject, try to consolidate RevertData from both
+				 */
+				revertData: {
+					type: "sap.ui.fl.apply._internal.flexObjects.CompVariantRevertData",
+					multiple: true,
+					singularName: "revertData",
+					defaultValue: []
+				}
+			}
+		},
+		constructor: function(mPropertyBag) {
+			Variant.apply(this, arguments);
+
+			// fileType "variant" is only for compVariant
+			this.setFileType("variant");
+
+			if (mPropertyBag.favorite !== undefined) {
+				this.setFavorite(!!mPropertyBag.favorite);
+			} else if (mPropertyBag.layer === Layer.VENDOR || mPropertyBag.layer === Layer.CUSTOMER_BASE) {
+				this.setFavorite(true);
+			}
+		}
+	});
+
+	CompVariant.STANDARD_VARIANT_ID = "*standard*";
+
+	/**
+	 * Returns the mapping between flex object properties and file content properties in the back-end response.
+	 * @returns {object} Mapping information
+	 * @static
+	 */
+	 CompVariant.getMappingInfo = function () {
+		return Object.assign(Variant.getMappingInfo(), {
+			persistencyKey: "selector.persistencyKey"
+		});
+	};
+
+	/**
+	 * Returns the mapping between flex object properties and file content properties in the back-end response.
+	 * Can be overridden to avoid access of static mapping within base methods.
+	 * @returns {object} Mapping information
+	 */
+	CompVariant.prototype.getMappingInfo = function () {
+		return CompVariant.getMappingInfo();
+	};
+
 	function isUserAuthor(oAuthor) {
 		var oSettings = Settings.getInstanceOrUndef();
 		var vUserId = oSettings && oSettings.getUserId();
@@ -35,8 +114,6 @@ sap.ui.define([
 	 * @param {sap.ui.fl.Layer} [sActiveLayer] - Layer in which the operation may take place
 	 * @param {string} sUserId - ID of the variants creator
 	 * @returns {boolean} <code>true</code> if the variant is read only
-	 *
-	 * @private
 	 */
 	 function checkLayerAndUserAuthorization(sLayer, sActiveLayer, sUserId) {
 		if (sActiveLayer) {
@@ -61,12 +138,8 @@ sap.ui.define([
 	 * A variant can only be modified if the current language equals the original language.
 	 * Returns <code>false</code> if the current language does not equal the original language of the variant file.
 	 * Returns <code>false</code> if the original language is initial.
-	 *
 	 * @param {string} sOriginalLanguage - Language code of the language used on the variant creation
-	 *
 	 * @returns {boolean} <code>true</code> if the current logon language equals the original language of the variant file
-	 *
-	 * @private
 	 */
 	function isRenameEnableDueToOriginalLanguage(sOriginalLanguage) {
 		return !sOriginalLanguage || Utils.getCurrentLanguage() === sOriginalLanguage;
@@ -87,144 +160,78 @@ sap.ui.define([
 	}
 
 	/**
-	 * Flexibility CompVariant class. Stores variant content and related information.
-	 *
-	 * @param {object} oFile - File content and admin data
-	 *
-	 * @class sap.ui.fl.apply._internal.flexObjects.CompVariant
-	 * @extends sap.ui.fl.Change
-	 * @private
-	 * @ui5-restricted
-	 * @since 1.86.0
+	 * Returns the package name of the variant.
+	 * Used by the SmartVariantManagement control.
+	 * @returns {string} Package name
 	 */
-	var CompVariant = Change.extend("sap.ui.fl.apply._internal.flexObjects.Variant", /** @lends sap.ui.fl.apply._internal.flexObjects.CompVariant.prototype */ {
-		metadata: {
-			properties: {
-				favorite: {
-					type: "boolean",
-					defaultValue: false
-				},
-				executeOnSelection: {
-					type: "boolean",
-					defaultValue: false
-				},
-				standardVariant: {
-					type: "boolean",
-					defaultValue: false
-				},
-				contexts: {
-					type: "object",
-					defaultValue: {}
-				},
-				persisted: {
-					type: "boolean",
-					defaultValue: true
-				},
-				name: {
-					type: "string",
-					defaultValue: ""
-				},
-				content: {
-					type: "object",
-					defaultValue: {}
-				}
-			},
-			aggregations: {
-				// TODO: change to revertData for alignment, but this will conflict with the derived Change.getRevertData as of today
-				revertInfo: {
-					type: "sap.ui.fl.apply._internal.flexObjects.CompVariantRevertData",
-					multiple: true,
-					singularName: "revertInfo",
-					defaultValue: []
-				},
-				changes: {
-					type: "sap.ui.fl.Change",
-					multiple: true,
-					defaultValue: []
-				}
-			}
-		},
-
-		constructor: function(oFile) {
-			Change.apply(this, arguments);
-
-			var bExecuteOnSelect = oFile.content && (oFile.content.executeOnSelect || oFile.content.executeOnSelection);
-
-			// new property always overrules older content
-			if (oFile.executeOnSelection !== undefined) {
-				bExecuteOnSelect = oFile.executeOnSelection;
-			}
-			this.setExecuteOnSelection(bExecuteOnSelect);
-
-			this.setContexts(oFile.contexts || {});
-			this.setContent(oFile.content || {});
-
-			this.setName(this.getText("variantName"));
-
-			if (oFile.layer === Layer.VENDOR || oFile.layer === Layer.CUSTOMER_BASE) {
-				this.setFavorite(true);
-			}
-
-			if (oFile.favorite !== undefined) {
-				this.setFavorite(!!oFile.favorite);
-			}
+	CompVariant.prototype.getPackage = function() {
+		return this.getFlexObjectMetadata().packageName;
+	};
 
-			if (oFile.persisted !== undefined) {
-				this.setPersisted(!!oFile.persisted);
-			}
-		}
-	});
+	/**
+	 * Sets the transport request.
+	 * Used by the SmartVariantManagement control.
+	 * @param {string} sRequest Transport request
+	 */
+	CompVariant.prototype.setRequest = function (sRequest) {
+		this._sRequest = sRequest;
+	};
 
-	CompVariant.STANDARD_VARIANT_ID = "*standard*";
+	/**
+	 * Gets the transport request.
+	 * Used by the SmartVariantManagement control.
+	 * @returns {string} Transport request
+	 */
+	CompVariant.prototype.getRequest = function () {
+		return this._sRequest;
+	};
 
 	/**
-	 * Returns the id of the variant object
-	 * @returns {string} the id of the variant object.
+	 * Checks if the object is a variant from smart variant management.
+	 * Used by the SmartVariantManagement control.
+	 * @returns {boolean} <code>true</code> if object is a variant
 	 */
-	CompVariant.prototype.getVariantId = function () {
-		return this.getId();
+	CompVariant.prototype.isVariant = function () {
+		return true;
 	};
 
 	/**
 	 * Checks whenever the variant can be renamed updating the entity or crating an <code>updateChange</code>.
-	 *
 	 * @param {sap.ui.fl.Layer} [sLayer] - Layer in which the edition may take place
-	 *
 	 * @returns {boolean} <code>true</code> if the variant can be updated
-	 *
-	 * @public
 	 */
 	CompVariant.prototype.isRenameEnabled = function (sLayer) {
-		return !this.getStandardVariant() && this.isEditEnabled(sLayer) && isRenameEnableDueToOriginalLanguage(this._oDefinition.content.originalLanguage);
+		return !this.getStandardVariant()
+			&& this.isEditEnabled(sLayer)
+			&& isRenameEnableDueToOriginalLanguage(this.getSupportInformation().originalLanguage);
 	};
 
 	/**
 	 * Checks whenever the variant can be edited (a save operation) updating the entity or crating an <code>updateChange</code>.
-	 *
 	 * @param {sap.ui.fl.Layer} [sActiveLayer] - Layer in which the edition may take place
-	 *
 	 * @returns {boolean} <code>true</code> if the variant can be updated
-	 *
-	 * @public
 	 */
 	CompVariant.prototype.isEditEnabled = function (sActiveLayer) {
 		var bDeveloperLayer = sActiveLayer && LayerUtils.isDeveloperLayer(sActiveLayer);
-		var bOriginSystem = isOriginSystem(this._oDefinition.sourceSystem, this._oDefinition.sourceClient);
+		var bOriginSystem = isOriginSystem(
+			this.getSupportInformation().sourceSystem,
+			this.getSupportInformation().sourceClient
+		);
 		var bUserAuthorized = checkLayerAndUserAuthorization(this.getLayer(), sActiveLayer, this.getOwnerId());
 		return bDeveloperLayer || bOriginSystem && bUserAuthorized;
 	};
 
 	/**
 	 * Checks whenever the variant can be deleted.
-	 *
 	 * @param {sap.ui.fl.Layer} [sLayer] - Layer in which the deletion may take place
-	 *
 	 * @returns {boolean} <code>true</code> if the variant file can be deleted
-	 *
-	 * @public
 	 */
 	CompVariant.prototype.isDeleteEnabled = function (sLayer) {
-		return isOriginSystem(this._oDefinition.sourceSystem, this._oDefinition.sourceClient)
+		var bOriginSystem = isOriginSystem(
+			this.getSupportInformation().sourceSystem,
+			this.getSupportInformation().sourceClient
+		);
+		return bOriginSystem
 			&& checkLayerAndUserAuthorization(this.getLayer(), sLayer, this.getOwnerId())
 			&& !this.getStandardVariant();
 	};
@@ -232,153 +239,73 @@ sap.ui.define([
 	/**
 	 * Sets the favorite flag of the runtime instance as well as the persistent representation.
 	 * This results in setting the definition as well as flagging the entity as 'dirty'.
-	 *
 	 * @param {boolean} bFavorite - Boolean to which the favorite flag should be set
-	 *
 	 * @private
 	 * @ui5-restricted sap.ui.fl
 	 */
 	CompVariant.prototype.storeFavorite = function (bFavorite) {
-		if (bFavorite !== undefined) {
-			this._oDefinition.favorite = bFavorite;
-		} else {
-			delete this._oDefinition.favorite;
+		if (bFavorite !== this.getFavorite()) {
+			this.setState(States.DIRTY);
+			this.setFavorite(bFavorite);
 		}
-		this.setState(States.DIRTY);
-		this.setFavorite(bFavorite);
-	};
-
-	/**
-	 * Sets the content of the runtime instance.
-	 *
-	 * @param {object} [oContent={}] - Content object to be set
-	 *
-	 * @private
-	 * @ui5-restricted sap.ui.fl
-	 */
-	CompVariant.prototype.setContent = function (oContent) {
-		// TODO: remove after the extended Change.js does not overwrite the default setContent
-		this.setProperty("content", oContent || {});
 	};
 
 	/**
-	 * Sets the content of the runtime instance.
-	 *
-	 * @returns {object} Content object of the variant
-	 *
-	 * @private
-	 * @ui5-restricted sap.ui.fl
+	 * Retrieves the owner ID (user)
+	 * @returns {string} User ID
 	 */
-	CompVariant.prototype.getContent = function () {
-		// TODO: remove after the extended Change.js does not overwrite the default getContent
-		return this.getProperty("content");
-	};
-
-
 	CompVariant.prototype.getOwnerId = function() {
-		return this._oDefinition.support ? this._oDefinition.support.user : "";
+		return this.getSupportInformation().user || "";
 	};
 
 	/**
 	 * Sets the content of the runtime instance as well as the persistent representation.
 	 * This results in setting the definition as well as flagging the entity as 'dirty'.
-	 *
 	 * @param {object} [oContent={}] - Content object to be stored
-	 *
 	 * @private
 	 * @ui5-restricted sap.ui.fl
 	 */
 	CompVariant.prototype.storeContent = function (oContent) {
-		this._oDefinition.content = oContent || {};
-		this.setState(States.DIRTY);
+		// setContent() already sets the dirty state by default
 		this.setContent(oContent);
 	};
 
 	/**
 	 * Sets the e'Apply Automatically' flag of the runtime instance as well as the persistent representation.
 	 * This results in setting the definition as well as flagging the entity as 'dirty'.
-	 *
 	 * @param {boolean} bExecuteOnSelection - Boolean to which the 'Apply Automatically' flag should be set
-	 *
 	 * @private
 	 * @ui5-restricted sap.ui.fl
 	 */
 	CompVariant.prototype.storeExecuteOnSelection = function (bExecuteOnSelection) {
-		if (bExecuteOnSelection !== undefined) {
-			this._oDefinition.executeOnSelection = bExecuteOnSelection;
-		} else {
-			delete this._oDefinition.executeOnSelection;
+		if (bExecuteOnSelection !== this.getExecuteOnSelection()) {
+			this.setState(States.DIRTY);
+			this.setExecuteOnSelection(bExecuteOnSelection);
 		}
-		delete this._oDefinition.content.executeOnSelection;
-		this.setState(States.DIRTY);
-		this.setExecuteOnSelection(bExecuteOnSelection);
 	};
 
 	/**
 	 * Sets the name of the runtime instance as well as the persistent representation.
 	 * This results in a entity within the texts section flagged as a field for translation.
-	 *
 	 * @param {string} sName - Name to be set
-	 *
 	 * @private
 	 * @ui5-restricted sap.ui.fl
 	 */
 	CompVariant.prototype.storeName = function (sName) {
-		this._oDefinition.texts.variantName.value = sName;
-
-		this.setState(States.DIRTY);
+		// setName() already sets the dirty state by default
 		this.setName(sName);
 	};
 
 	/**
 	 * Sets the object of the contexts attribute.
-	 *
 	 * @param {object} mContexts - Contexts of the variant file
-	 *
 	 * @private
 	 * @ui5-restricted sap.ui.fl
 	 */
 	CompVariant.prototype.storeContexts = function (mContexts) {
-		if (mContexts !== undefined) {
-			this._oDefinition.contexts = mContexts;
-		} else {
-			delete this._oDefinition.contexts;
-		}
 		this.setContexts(mContexts);
 		this.setState(States.DIRTY);
 	};
 
-	CompVariant.createInitialFileContent = function (oPropertyBag) {
-		var oNewFile = Change.createInitialFileContent(oPropertyBag);
-		if (oPropertyBag.contexts) {
-			oNewFile.contexts = oPropertyBag.contexts;
-		}
-		if (oPropertyBag.favorite !== undefined) {
-			oNewFile.favorite = oPropertyBag.favorite;
-		}
-		if (oPropertyBag.executeOnSelection !== undefined) {
-			oNewFile.executeOnSelection = oPropertyBag.executeOnSelection;
-		}
-
-		// TODO: clean up the createInitialFileContent within the Change class plus create a base class FlexObject
-		return _pick(oNewFile, [
-			"changeType",
-			"namespace",
-			"service",
-			"content",
-			"reference",
-			"fileName",
-			"fileType",
-			"packageName",
-			"layer",
-			"favorite",
-			"executeOnSelection",
-			"selector",
-			"texts",
-			"support",
-			"contexts"
-		]);
-	};
-
 	return CompVariant;
 });

package/src/sap/ui/fl/apply/_internal/flexObjects/FlexObject.js

@@ -35,6 +35,7 @@ sap.ui.define([
 	 * @static
 	 * @constant
 	 * @typedef {object} sap.ui.fl.apply._internal.flexObjects.FlexObject.FlexObjectMetadata
+	 * @property {string} changeType - Type of the flexObject
 	 * @property {string} reference - Application component name
 	 * @property {string} namespace - Namespace of the flex object file
 	 * @property {string} creation - Timestamp of creation date
@@ -70,7 +71,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.ManagedObject
 	 * @alias sap.ui.fl.apply._internal.flexObjects.FlexObject
 	 * @since 1.100
-	 * @version 1.102.2
+	 * @version 1.104.0
 	 * @private
 	 * @ui5-restricted sap.ui.fl
 	 */
@@ -121,7 +122,8 @@ sap.ui.define([
 				 * Content of the flex object that is used to apply the flex object.
 				 */
 				content: {
-					type: "any"
+					type: "any",
+					defaultValue: {}
 				},
 				/**
 				 * Map of texts that should be translated.
@@ -165,6 +167,7 @@ sap.ui.define([
 	 */
 	FlexObject.getMappingInfo = function () {
 		return Object.assign({}, {
+			"flexObjectMetadata.changeType": "changeType",
 			"flexObjectMetadata.reference": "reference",
 			"flexObjectMetadata.namespace": "namespace",
 			"flexObjectMetadata.creation": "creation",
@@ -184,8 +187,8 @@ sap.ui.define([
 			"supportInformation.originalLanguage": "originalLanguage",
 			layer: "layer",
 			fileType: "fileType",
-			content: "content",
 			id: "fileName",
+			content: "content",
 			texts: "texts"
 		});
 	};
@@ -202,11 +205,14 @@ sap.ui.define([
 	/**
 	 * Sets the content of the flex object and marks the state as DIRTY.
 	 * @param {any} oContent - Flex object content
+	 * @param {boolean} [bSkipStateChange] - If set to true, doesn't set the state to dirty
 	 * @returns {sap.ui.fl.apply._internal.flexObjects.FlexObject} <code>this</code> for chaining
 	 */
-	FlexObject.prototype.setContent = function (oContent) {
+	FlexObject.prototype.setContent = function (oContent, bSkipStateChange) {
 		this.setProperty("content", oContent);
-		this.setState(States.DIRTY);
+		if (!bSkipStateChange) {
+			this.setState(States.DIRTY);
+		}
 		return this;
 	};
 
@@ -294,6 +300,22 @@ sap.ui.define([
 		return (sSourceSystem !== sSystem || sSourceClient !== sClient);
 	};
 
+	/**
+	 * Getter for the namespace from the FlexObjectMetadata.
+	 * @returns {string} Namespace
+	 */
+	FlexObject.prototype.getNamespace = function() {
+		return this.getFlexObjectMetadata().namespace;
+	};
+
+	/**
+	 * Getter for the change type from the FlexObjectMetadata.
+	 * @returns {string} Change type
+	 */
+	FlexObject.prototype.getChangeType = function() {
+		return this.getFlexObjectMetadata().changeType;
+	};
+
 	/**
 	 * Returns <code>true</code> if the flex object is user dependent.
 	 * @returns {boolean} <code>true</code> if the flex object is only relevant for the current user
@@ -313,18 +335,19 @@ sap.ui.define([
 	};
 
 	/**
-	 * Sets the new text for the given text ID.
+	 * Sets the new text for the given text ID or creates new text with the given ID.
 	 * @param {string} sTextId - Text ID which was used as part of the <code>texts</code> property
 	 * @param {string} sNewText - New text for the given text ID
+	 * @param {boolean} [bSkipStateChange] - If set to <code>true</code>, doesn't set the state to dirty
 	 * @returns {sap.ui.fl.apply._internal.flexObjects.FlexObject} <code>this</code> context for chaining
 	 */
-	FlexObject.prototype.setText = function (sTextId, sNewText) {
+	FlexObject.prototype.setText = function (sTextId, sNewText, bSkipStateChange) {
 		var oTexts = Object.assign({}, this.getTexts());
-		if (oTexts[sTextId]) {
-			oTexts[sTextId] = Object.assign({}, oTexts[sTextId], {
-				value: sNewText
-			});
-			this.setTexts(oTexts);
+		oTexts[sTextId] = Object.assign({}, oTexts[sTextId], {
+			value: sNewText
+		});
+		this.setTexts(oTexts);
+		if (!bSkipStateChange) {
 			this.setState(States.DIRTY);
 		}
 		return this;
@@ -429,8 +452,9 @@ sap.ui.define([
 	 * @param {object} oFileContent - File content of the flex object
 	 */
 	FlexObject.prototype.update = function (oFileContent) {
-		var oFilteredFileContent = _omit(oFileContent, ["fileName"]);
-		var mProperties = FlexObject.mapFileContent(oFilteredFileContent, this.getMappingInfo());
+		// filename is mapped to id and this is not updatable
+		var oNewFileContent = _omit(oFileContent, ["fileName"]);
+		var mProperties = FlexObject.mapFileContent(oNewFileContent, this.getMappingInfo());
 		Object.entries(mProperties).forEach(function (aProperty) {
 			updateProperty.call(this, aProperty[0], aProperty[1]);
 		}.bind(this));