@openui5/sap.ui.rta 1.139.0 → 1.141.0

package/src/sap/ui/rta/command/CommandFactory.js

@@ -102,13 +102,9 @@ sap.ui.define([
 	}
 
 	function configureAddXmlCommand(oElement, mSettings, oDesignTimeMetadata) {
-		let vAction;
-		if (oDesignTimeMetadata) {
-			vAction = oDesignTimeMetadata.getAction(mSettings.name, oElement);
-		}
 		// the change type is not configurable via designtime
 		// it can also not be disabled with 'not-adaptable' or null
-		const oAction = vAction || {};
+		const oAction = oDesignTimeMetadata?.getAction(mSettings.name, oElement) || {};
 		Object.assign(oAction, {
 			changeType: mSettings.name
 		});
@@ -116,13 +112,9 @@ sap.ui.define([
 	}
 
 	function configureExtendControllerCommand(oElement, mSettings, oDesignTimeMetadata) {
-		var vAction;
-		if (oDesignTimeMetadata) {
-			vAction = oDesignTimeMetadata.getAction(mSettings.name, oElement);
-		}
 		// the change type is not configurable via designtime
 		// it can also not be disabled with 'not-adaptable' or null
-		var oAction = vAction || {};
+		const oAction = oDesignTimeMetadata?.getAction(mSettings.name, oElement) || {};
 		Object.assign(oAction, {
 			changeType: mSettings.name
 		});
@@ -188,10 +180,8 @@ sap.ui.define([
 	}
 
 	function configureRemoveCommand(oElement, mSettings, oDesignTimeMetadata) {
-		let oRemovedElement = mSettings.removedElement;
-		if (!oRemovedElement) {
-			oRemovedElement = oElement;
-		} else if (!(oRemovedElement instanceof ManagedObject)) {
+		const oRemovedElement = mSettings.removedElement || oElement;
+		if (!(oRemovedElement instanceof ManagedObject)) {
 			throw new Error("No valid 'removedElement' found");
 		}
 		const oAction = oDesignTimeMetadata.getAction("remove", oRemovedElement);
@@ -252,9 +242,7 @@ sap.ui.define([
 	}
 
 	function configureRevealCommand(oElement, mSettings, oDesignTimeMetadata) {
-		const oRevealedElement = mSettings.element;
-		const oAction = oDesignTimeMetadata.getAction("reveal", oRevealedElement);
-		return oAction;
+		return oDesignTimeMetadata.getAction("reveal", mSettings.element);
 	}
 
 	function adjustRevealCommand(mSettings) {
@@ -285,7 +273,8 @@ sap.ui.define([
 	}
 
 	function configureAddIFrame(oElement, mSettings, oDesignTimeMetadata) {
-		return oDesignTimeMetadata.getAction("addIFrame", mSettings.element) || oDesignTimeMetadata.getActionDataFromAggregations("addIFrame", mSettings.element)[0];
+		return oDesignTimeMetadata.getAction("addIFrame", mSettings.element)
+			|| oDesignTimeMetadata.getActionDataFromAggregations("addIFrame", mSettings.element)[0];
 	}
 
 	function configureBindPropertyCommand() {
@@ -429,85 +418,74 @@ sap.ui.define([
 		}
 	};
 
-	function getCommandFor(vElement, sCommand, mSettings, oDesignTimeMetadata, mFlexSettings, sVariantManagementReference) {
-		let oCommand;
-		sCommand = sCommand[0].toLowerCase() + sCommand.slice(1); // first char of command name is lower case
-		const mCommand = mCommands[sCommand];
-		let mAllFlexSettings = mFlexSettings;
-
-		if (!mCommand) {
-			return Promise.reject(DtUtil.createError("CommandFactory#getCommandFor", `Command '${sCommand}' doesn't exist, check typing`, "sap.ui.rta"));
-		}
-
+	function requireModule(mCommand) {
 		return new Promise(function(fnResolve) {
 			const sClassName = mCommand.clazz;
 			sap.ui.require([sClassName], function(Command) {
 				fnResolve(Command);
 			});
-		})
+		});
+	}
 
-		.then(function(Command) {
-			const bIsUiElement = vElement instanceof ManagedObject;
+	async function getCommandFor(vElement, sCommand, mSettings, oDesignTimeMetadata, mFlexSettings, sVariantManagementReference) {
+		const sAdjustedCommandName = sCommand[0].toLowerCase() + sCommand.slice(1); // first char of command name is lower case
+		const mCommand = mCommands[sAdjustedCommandName];
+		let mAllFlexSettings = mFlexSettings;
 
-			// only sap.ui.rta.command.FlexCommand requires a selector property
-			if (!mCommand.noSelector && !bIsUiElement) {
-				mSettings = { ...mSettings, selector: vElement };
-			}
+		if (!mCommand) {
+			return DtUtil.createError("CommandFactory#getCommandFor", `Command '${sAdjustedCommandName}' doesn't exist, check typing`, "sap.ui.rta");
+		}
 
-			mSettings = {
-				...mSettings,
-				element: bIsUiElement ? vElement : undefined,
-				name: sCommand
-			};
+		const Command = await requireModule(mCommand);
 
-			let oAction;
-			if (mCommand.configure) {
-				oAction = mCommand.configure(vElement, mSettings, oDesignTimeMetadata);
-			}
+		const bIsUiElement = vElement instanceof ManagedObject;
 
-			let oElementOverlay;
-			if (bIsUiElement) {
-				oElementOverlay = OverlayRegistry.getOverlay(vElement);
-			}
+		// only sap.ui.rta.command.FlexCommand requires a selector property
+		if (!mCommand.noSelector && !bIsUiElement) {
+			mSettings = { ...mSettings, selector: vElement };
+		}
 
-			if (oAction && oAction.changeOnRelevantContainer) {
-				Object.assign(mSettings, {
-					element: oElementOverlay.getRelevantContainer()
-				});
-				vElement = mSettings.element;
-				oElementOverlay = OverlayRegistry.getOverlay(vElement);
-			}
+		mSettings = {
+			...mSettings,
+			element: bIsUiElement ? vElement : undefined,
+			name: sAdjustedCommandName
+		};
 
-			let mTemplateSettings;
-			if (oElementOverlay && vElement.sParentAggregationName) {
-				mTemplateSettings = evaluateTemplateBinding(oElementOverlay);
-			}
+		const oAction = mCommand.configure ? mCommand.configure(vElement, mSettings, oDesignTimeMetadata) : undefined;
+
+		let oElementOverlay = bIsUiElement ? OverlayRegistry.getOverlay(vElement) : undefined;
+
+		if (oAction?.changeOnRelevantContainer) {
+			Object.assign(mSettings, {
+				element: oElementOverlay.getRelevantContainer()
+			});
+			vElement = mSettings.element;
+			oElementOverlay = OverlayRegistry.getOverlay(vElement);
+		}
 
+		if (oElementOverlay && vElement.sParentAggregationName) {
+			const mTemplateSettings = evaluateTemplateBinding(oElementOverlay);
 			if (mTemplateSettings) {
 				if (mCommand.adjustForBinding) {
 					mCommand.adjustForBinding(mSettings);
 				}
 				mAllFlexSettings = merge(mTemplateSettings, mAllFlexSettings);
 			}
+		}
 
-			oCommand = new Command(mSettings);
+		const oCommand = new Command(mSettings);
 
-			let bSuccessfullyConfigured = true; // configuration is optional
-			if (mCommand.configure) {
-				bSuccessfullyConfigured = configureActionCommand(oCommand, oAction);
-			}
+		// configuration is optional
+		const bSuccessfullyConfigured = mCommand.configure ? configureActionCommand(oCommand, oAction) : true;
 
-			if (bSuccessfullyConfigured) {
-				return oCommand.prepare(mAllFlexSettings, sVariantManagementReference, sCommand);
-			}
-			return undefined;
-		}).then(function(bPrepareStatus) {
+		if (bSuccessfullyConfigured) {
+			const bPrepareStatus = await oCommand.prepare(mAllFlexSettings, sVariantManagementReference, sAdjustedCommandName);
 			if (bPrepareStatus) {
 				return oCommand;
 			}
-			oCommand.destroy();
-			return undefined;
-		});
+		}
+		oCommand.destroy();
+		return undefined;
 	}
 
 	/**
@@ -517,7 +495,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.ManagedObject
 	 *
 	 * @author SAP SE
-	 * @version 1.139.0
+	 * @version 1.141.0
 	 *
 	 * @constructor
 	 * @private
@@ -568,7 +546,7 @@ sap.ui.define([
 	 * Static method for generating command
 	 * @param {sap.ui.core.Element|string} vElement - Could be either an element or a selector for the element for which the command is to be created
 	 * @param {string} sCommand - Command type
-	 * @param {object} mSettings -  Initial settings for the new command (command specific settings, looks different for each and every command)
+	 * @param {object} mSettings - Initial settings for the new command (command specific settings, looks different for each and every command)
 	 * @param {sap.ui.dt.DesignTimeMetadata} oDesignTimeMetadata - Contains the action used in the command
 	 * @param {object} [mFlexSettings] - Property bag
 	 * @param {string} [mFlexSettings.layer] - The Layer in which RTA should be started. Default: "CUSTOMER"
@@ -586,9 +564,9 @@ sap.ui.define([
 		};
 
 		if (mFlexSettings.scenario || mFlexSettings.baseId) {
-			const sLRepRootNamespace = FlexUtils.buildLrepRootNamespace(mFlexSettings.baseId, mFlexSettings.scenario, mFlexSettings.projectId);
-			mFlexSettings.rootNamespace = sLRepRootNamespace;
-			mFlexSettings.namespace = `${sLRepRootNamespace}changes/`;
+			const sLRepNamespace = FlexUtils.buildLrepRootNamespace(mFlexSettings.baseId, mFlexSettings.scenario, mFlexSettings.projectId);
+			mFlexSettings.rootNamespace = sLRepNamespace;
+			mFlexSettings.namespace = `${sLRepNamespace}changes/`;
 		}
 
 		return getCommandFor(vElement, sCommand, mSettings, oDesignTimeMetadata, mFlexSettings);

package/src/sap/ui/rta/command/CompositeCommand.js

@@ -21,7 +21,7 @@ sap.ui.define([
 	 * @extends sap.ui.rta.command.BaseCommand
 	 *
 	 * @author SAP SE
-	 * @version 1.139.0
+	 * @version 1.141.0
 	 *
 	 * @constructor
 	 * @private
@@ -47,50 +47,30 @@ sap.ui.define([
 	 *
 	 * @returns {Promise} empty resolved promise or rejected promise
 	 */
-	CompositeCommand.prototype.execute = function() {
-		const aPromises = [];
-		this._forEachCommand(function(oCommand) {
-			aPromises.push(oCommand.execute.bind(oCommand));
-		});
-		return FlUtils.execPromiseQueueSequentially(aPromises, true)
-
-		.catch(function(e) {
+	CompositeCommand.prototype.execute = async function() {
+		try {
+			await FlUtils.execPromiseQueueSequentially(this.getCommands().map((oCommand) => {
+				return oCommand.execute.bind(oCommand);
+			}), true);
+		} catch (oError) {
+			await this.undo();
 			const aCommands = this.getCommands();
-			aCommands.forEach(function(oCommand) {
+			aCommands.forEach((oCommand) => {
 				if (oCommand instanceof FlexCommand) {
 					this.removeCommand(oCommand);
 				}
-			}.bind(this));
-
-			return this.undo()
-
-			.then(function() {
-				return Promise.reject(e);
 			});
-		}.bind(this));
+			throw oError;
+		}
 	};
 
 	CompositeCommand.prototype.undo = function() {
-		const aPromises = [];
-		this._forEachCommandInReverseOrder(function(oCommand) {
-			aPromises.push(oCommand.undo.bind(oCommand));
-		});
-		return FlUtils.execPromiseQueueSequentially(aPromises);
-	};
-
-	CompositeCommand.prototype._forEachCommand = function(fnDo) {
-		const aCommands = this.getCommands();
-		aCommands.forEach(fnDo, this);
+		return FlUtils.execPromiseQueueSequentially(this.getCommands().toReversed().map((oCommand) => {
+			return oCommand.undo.bind(oCommand);
+		}));
 	};
 
-	CompositeCommand.prototype._forEachCommandInReverseOrder = function(fnDo) {
-		const aCommands = this.getCommands();
-		for (let i = aCommands.length - 1; i >= 0; i--) {
-			fnDo.call(this, aCommands[i]);
-		}
-	};
-
-	CompositeCommand.prototype._addCompositeIdToChange = function(oCommand) {
+	function addCompositeIdToChange(oCommand) {
 		this._sCompositeId ||= FlUtils.createDefaultFileName("composite");
 		const oPreparedChange = oCommand.getPreparedChange && oCommand.getPreparedChange();
 		if (oPreparedChange) {
@@ -100,10 +80,10 @@ sap.ui.define([
 				oPreparedChange.setSupportInformation(oChangeSupportInformation);
 			}
 		} else if (oCommand.setCompositeId) {
-			// relevant for manifest commands
+			// relevant for manifest commands, as the change is not yet created when this function is called
 			oCommand.setCompositeId(this._sCompositeId);
 		}
-	};
+	}
 
 	/**
 	 * @override
@@ -112,7 +92,7 @@ sap.ui.define([
 	 * @returns {object} the composite command
 	 */
 	CompositeCommand.prototype.addCommand = function(oCommand, bSuppressInvalidate) {
-		this._addCompositeIdToChange(oCommand);
+		addCompositeIdToChange.call(this, oCommand);
 		return this.addAggregation("commands", oCommand, bSuppressInvalidate);
 	};
 
@@ -124,7 +104,7 @@ sap.ui.define([
 	 * @returns {object} the composite command
 	 */
 	CompositeCommand.prototype.insertCommand = function(oCommand, iIndex, bSuppressInvalidate) {
-		this._addCompositeIdToChange(oCommand);
+		addCompositeIdToChange.call(this, oCommand);
 		return this.insertAggregation("commands", oCommand, iIndex, bSuppressInvalidate);
 	};
 

package/src/sap/ui/rta/command/ControlVariantConfigure.js

@@ -4,7 +4,6 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
-	"sap/ui/core/util/reflection/JsControlTreeModifier",
 	"sap/ui/fl/apply/api/ControlVariantApplyAPI",
 	"sap/ui/fl/apply/api/FlexRuntimeInfoAPI",
 	"sap/ui/fl/variants/VariantManager",
@@ -13,7 +12,6 @@ sap.ui.define([
 	"sap/ui/rta/command/BaseCommand",
 	"sap/ui/rta/library"
 ], function(
-	JsControlTreeModifier,
 	ControlVariantApplyAPI,
 	FlexRuntimeInfoAPI,
 	VariantManager,
@@ -30,13 +28,13 @@ sap.ui.define([
 	 * @class
 	 * @extends sap.ui.rta.command.BaseCommand
 	 * @author SAP SE
-	 * @version 1.139.0
+	 * @version 1.141.0
 	 * @constructor
 	 * @private
 	 * @since 1.52
 	 * @alias sap.ui.rta.command.ControlVariantConfigure
 	 */
-	var ControlVariantConfigure = BaseCommand.extend("sap.ui.rta.command.ControlVariantConfigure", {
+	const ControlVariantConfigure = BaseCommand.extend("sap.ui.rta.command.ControlVariantConfigure", {
 		metadata: {
 			library: "sap.ui.rta",
 			properties: {
@@ -76,25 +74,24 @@ sap.ui.define([
 	 * @returns {Promise} Returns resolve after execution
 	 */
 	ControlVariantConfigure.prototype.execute = async function() {
-		var oVariantManagementControl = this.getControl();
+		const oVariantManagementControl = this.getControl();
 		this.oAppComponent = FlUtils.getAppComponentForControl(oVariantManagementControl);
-		this.oModel = this.oAppComponent.getModel(ControlVariantApplyAPI.getVariantModelName());
-		this.sVariantManagementReference = JsControlTreeModifier.getSelector(oVariantManagementControl, this.oAppComponent).id;
+		this.sVariantManagementReference = oVariantManagementControl.getVariantManagementReference();
 
 		this._aPreparedChanges = [];
 		if (this.getChanges().some((oChange) => {
 			if (
 				oChange.visible === false
-				&& oChange.variantReference === this.oModel.getCurrentVariantReference(this.sVariantManagementReference)
+				&& oChange.variantReference === oVariantManagementControl.getCurrentVariantKey()
 			) {
 				this._sOldVReference = oChange.variantReference;
 				return true;
 			}
 			return false;
 		})) {
-			await this.oModel.updateCurrentVariant({
-				variantManagementReference: this.sVariantManagementReference,
-				newVariantReference: this.sVariantManagementReference
+			await ControlVariantApplyAPI.activateVariant({
+				element: oVariantManagementControl,
+				variantReference: this.sVariantManagementReference
 			});
 		}
 
@@ -126,12 +123,12 @@ sap.ui.define([
 		});
 		delete this._aDeletedFlexObjects;
 
-		this.getChanges().forEach(function(mChangeProperties, index) {
+		this.getChanges().forEach((mChangeProperties, index) => {
 			const mPropertyBag = {
 				appComponent: this.oAppComponent
 			};
 			Object.keys(mChangeProperties).forEach(function(sProperty) {
-				var sOriginalProperty = `original${sProperty.charAt(0).toUpperCase()}${sProperty.substr(1)}`;
+				const sOriginalProperty = `original${sProperty.charAt(0).toUpperCase()}${sProperty.substr(1)}`;
 				if (sProperty === "visible") {
 					mPropertyBag[sProperty] = true; /* visibility of the variant always set back to true on undo */
 				} else if (mChangeProperties[sOriginalProperty]) {
@@ -141,18 +138,17 @@ sap.ui.define([
 					mPropertyBag[sProperty] = mChangeProperties[sProperty];
 				}
 			});
-			var oChange = this._aPreparedChanges[index];
+			const oChange = this._aPreparedChanges[index];
 			VariantManager.deleteVariantChange(this.sVariantManagementReference, mPropertyBag, oChange);
-		}.bind(this));
+		});
 
 		this._aPreparedChanges = null;
 		if (this._sOldVReference) {
-			await this.oModel.updateCurrentVariant({
-				variantManagementReference: this.sVariantManagementReference,
-				newVariantReference: this._sOldVReference
-			}).then(() => {
-				delete this._sOldVReference;
+			await ControlVariantApplyAPI.activateVariant({
+				element: this.getControl(),
+				variantReference: this._sOldVReference
 			});
+			delete this._sOldVReference;
 		}
 	};
 

package/src/sap/ui/rta/command/ControlVariantSave.js

@@ -4,13 +4,13 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
-	"sap/ui/rta/command/BaseCommand",
-	"sap/ui/core/util/reflection/JsControlTreeModifier",
-	"sap/ui/fl/Utils"
+	"sap/ui/fl/apply/api/FlexRuntimeInfoAPI",
+	"sap/ui/fl/variants/VariantManager",
+	"sap/ui/rta/command/BaseCommand"
 ], function(
-	BaseCommand,
-	JsControlTreeModifier,
-	flUtils
+	FlexRuntimeInfoAPI,
+	VariantManager,
+	BaseCommand
 ) {
 	"use strict";
 
@@ -20,49 +20,40 @@ sap.ui.define([
 	 * @class
 	 * @extends sap.ui.rta.command.BaseCommand
 	 * @author SAP SE
-	 * @version 1.139.0
+	 * @version 1.141.0
 	 * @constructor
 	 * @private
 	 * @since 1.86
 	 * @alias sap.ui.rta.command.ControlVariantSave
 	 */
-	var ControlVariantSave = BaseCommand.extend("sap.ui.rta.command.ControlVariantSave", {
+	const ControlVariantSave = BaseCommand.extend("sap.ui.rta.command.ControlVariantSave", {
 		metadata: {
 			library: "sap.ui.rta",
-			properties: {
-				model: {
-					type: "object"
-				}
-			},
 			associations: {},
 			events: {}
 		}
 	});
 
-	/**
-	 * @override
-	 */
-	ControlVariantSave.prototype.prepare = function() {
-		this.oAppComponent = flUtils.getAppComponentForControl(this.getElement());
-		this.sVariantManagementReference = JsControlTreeModifier.getSelector(this.getElement(), this.oAppComponent).id;
-		return true;
-	};
-
 	/**
 	 * Triggers the Save of a variant.
 	 * @public
 	 * @returns {Promise} Promise that resolves after execution
 	 */
 	ControlVariantSave.prototype.execute = function() {
-		var sCurrentVariantReference = this.getModel().getCurrentVariantReference(this.sVariantManagementReference);
-		this._aControlChanges = this.getModel().getVariant(sCurrentVariantReference, this.sVariantManagementReference).controlChanges;
-		this._aDirtyChanges = this.getModel()._getDirtyChangesFromVariantChanges(this._aControlChanges);
-		this._aDirtyChanges.forEach(function(oChange) {
+		const oVMControl = this.getElement();
+		this.sFlexReference = FlexRuntimeInfoAPI.getFlexReference({ element: oVMControl });
+		this._aControlChanges = VariantManager.getControlChangesForVariant(
+			this.sFlexReference,
+			oVMControl.getVariantManagementReference(),
+			oVMControl.getCurrentVariantKey()
+		);
+		this._aDirtyChanges = VariantManager.getDirtyChangesFromVariantChanges(this._aControlChanges, this.sFlexReference);
+		this._aDirtyChanges.forEach((oChange) => {
 			if (oChange.getFileType() === "change") {
 				oChange.setSavedToVariant(true);
 			}
 		});
-		this.getModel().invalidateMap();
+		VariantManager.updateVariantManagementMap(this.sFlexReference);
 		return Promise.resolve();
 	};
 
@@ -77,7 +68,7 @@ sap.ui.define([
 				oChange.setSavedToVariant(false);
 			}
 		});
-		this.getModel().invalidateMap();
+		VariantManager.updateVariantManagementMap(this.sFlexReference);
 		return Promise.resolve();
 	};