@openui5/sap.ui.fl 1.128.0 → 1.130.0

package/src/sap/ui/fl/variants/VariantModel.js

@@ -5,8 +5,8 @@
  */
 
 sap.ui.define([
-	"sap/base/util/restricted/_omit",
 	"sap/base/util/restricted/_isEqual",
+	"sap/base/util/restricted/_omit",
 	"sap/base/util/each",
 	"sap/base/util/isEmptyObject",
 	"sap/base/util/merge",
@@ -19,23 +19,26 @@ sap.ui.define([
 	"sap/ui/fl/apply/_internal/changes/Applier",
 	"sap/ui/fl/apply/_internal/changes/Reverter",
 	"sap/ui/fl/apply/_internal/controlVariants/URLHandler",
+	"sap/ui/fl/apply/_internal/controlVariants/Utils",
 	"sap/ui/fl/apply/_internal/flexObjects/FlexObjectFactory",
 	"sap/ui/fl/apply/_internal/flexState/changes/DependencyHandler",
 	"sap/ui/fl/apply/_internal/flexState/controlVariants/Switcher",
 	"sap/ui/fl/apply/_internal/flexState/controlVariants/VariantManagementState",
 	"sap/ui/fl/apply/_internal/flexState/FlexObjectState",
 	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
-	"sap/ui/fl/apply/_internal/controlVariants/Utils",
+	"sap/ui/fl/registry/Settings",
+	"sap/ui/fl/write/_internal/flexState/changes/UIChangeManager",
+	"sap/ui/fl/write/_internal/flexState/FlexObjectManager",
+	"sap/ui/fl/write/_internal/controlVariants/ControlVariantWriteUtils",
 	"sap/ui/fl/write/api/ContextBasedAdaptationsAPI",
 	"sap/ui/fl/Layer",
 	"sap/ui/fl/LayerUtils",
 	"sap/ui/fl/Utils",
-	"sap/ui/fl/registry/Settings",
-	"sap/ui/model/BindingMode",
-	"sap/ui/model/json/JSONModel"
+	"sap/ui/model/json/JSONModel",
+	"sap/ui/model/BindingMode"
 ], function(
-	_omit,
 	_isEqual,
+	_omit,
 	each,
 	isEmptyObject,
 	merge,
@@ -48,20 +51,23 @@ sap.ui.define([
 	Applier,
 	Reverter,
 	URLHandler,
+	VariantUtil,
 	FlexObjectFactory,
 	DependencyHandler,
 	Switcher,
 	VariantManagementState,
 	FlexObjectState,
 	ManifestUtils,
-	VariantUtil,
+	Settings,
+	UIChangeManager,
+	FlexObjectManager,
+	ControlVariantWriteUtils,
 	ContextBasedAdaptationsAPI,
 	Layer,
 	LayerUtils,
 	Utils,
-	Settings,
-	BindingMode,
-	JSONModel
+	JSONModel,
+	BindingMode
 ) {
 	"use strict";
 
@@ -156,7 +162,10 @@ sap.ui.define([
 			return undefined;
 		})
 		.then(function() {
-			mPropertyBag.model.oChangePersistence.deleteChanges(aVariantDirtyChanges);
+			FlexObjectManager.deleteFlexObjects({
+				reference: mPropertyBag.model.sFlexReference,
+				flexObjects: aVariantDirtyChanges
+			});
 		});
 	}
 
@@ -306,7 +315,7 @@ sap.ui.define([
 	 * @class Variant model implementation for JSON format.
 	 * @extends sap.ui.model.json.JSONModel
 	 * @author SAP SE
-	 * @version 1.128.0
+	 * @version 1.130.0
 	 * @param {object} oData - Either the URL where to load the JSON from or a JS object
 	 * @param {object} mPropertyBag - Map of properties required for the constructor
 	 * @param {sap.ui.fl.FlexController} mPropertyBag.flexController - <code>FlexController</code> instance for the component which uses the variant model
@@ -362,22 +371,18 @@ sap.ui.define([
 	});
 
 	VariantModel.prototype.updateData = function() {
-		var oNewVariantsMap = this.oDataSelector.get({ reference: this.sFlexReference });
-		var oCurrentData = Object.assign({}, this.getData());
+		const oNewVariantsMap = this.oDataSelector.get({ reference: this.sFlexReference });
+		const oCurrentData = { ...this.getData() };
 		Object.entries(oNewVariantsMap).forEach(function(aVariants) {
-			var sVariantManagementKey = aVariants[0];
-			var oVariantMapEntry = Object.assign({}, aVariants[1]);
+			const sVariantManagementKey = aVariants[0];
+			const oVariantMapEntry = { ...aVariants[1] };
 			oCurrentData[sVariantManagementKey] ||= {};
 			oCurrentData[sVariantManagementKey].variants = oVariantMapEntry.variants.map(function(oVariant) {
-				var oCurrentVariantData = (oCurrentData[sVariantManagementKey].variants || [])
+				const oCurrentVariantData = (oCurrentData[sVariantManagementKey].variants || [])
 				.find(function(oVariantToCheck) {
 					return oVariantToCheck.key === oVariant.key;
 				});
-				return Object.assign(
-					{},
-					oCurrentVariantData || {},
-					oVariant
-				);
+				return { ...(oCurrentVariantData || {}), ...oVariant };
 			});
 			oCurrentData[sVariantManagementKey].currentVariant = oVariantMapEntry.currentVariant;
 			oCurrentData[sVariantManagementKey].defaultVariant = oVariantMapEntry.defaultVariant;
@@ -616,10 +621,12 @@ sap.ui.define([
 	 * @returns {Promise} Promise resolving when all changes are applied
 	 */
 	VariantModel.prototype.addAndApplyChangesOnVariant = function(aChanges) {
-		this.oChangePersistence.addChanges(aChanges, this.oAppComponent);
-		return aChanges.reduce(function(oPreviousPromise, oChange) {
+		const aAddedChanges = UIChangeManager.addDirtyChanges(this.sFlexReference, aChanges, this.oAppComponent);
+		return aAddedChanges.reduce(function(oPreviousPromise, oChange) {
 			return oPreviousPromise.then(function() {
-				var oControl = Element.getElementById(JsControlTreeModifier.getControlIdBySelector(oChange.getSelector(), this.oAppComponent));
+				const oControl = Element.getElementById(
+					JsControlTreeModifier.getControlIdBySelector(oChange.getSelector(), this.oAppComponent)
+				);
 				return Applier.applyChangeOnControl(oChange, oControl, {
 					modifier: JsControlTreeModifier,
 					appComponent: this.oAppComponent,
@@ -628,7 +635,10 @@ sap.ui.define([
 				.then((oReturn) => {
 					if (!oReturn.success) {
 						var oException = oReturn.error || new Error("The change could not be applied.");
-						this.oChangePersistence.deleteChange(oChange, true);
+						FlexObjectManager.deleteFlexObjects({
+							reference: this.sFlexReference,
+							flexObjects: [oChange]
+						});
 						throw oException;
 					}
 				});
@@ -770,7 +780,8 @@ sap.ui.define([
 		}
 
 		// sets copied variant and associated changes as dirty
-		aChanges = this.oChangePersistence.addDirtyChanges(
+		aChanges = FlexObjectManager.addDirtyFlexObjects(
+			this.sFlexReference,
 			aChanges
 			.concat([oDuplicateVariantData.instance]
 			.concat(oDuplicateVariantData.controlChanges)
@@ -800,7 +811,10 @@ sap.ui.define([
 			newVariantReference: mPropertyBag.sourceVariantReference,
 			appComponent: mPropertyBag.component
 		}).then(function() {
-			this.oChangePersistence.deleteChanges(aChangesToBeDeleted);
+			FlexObjectManager.deleteFlexObjects({
+				reference: this.sFlexReference,
+				flexObjects: aChangesToBeDeleted
+			});
 		}.bind(this));
 	};
 
@@ -809,6 +823,7 @@ sap.ui.define([
 		const aModelVariants = oData.variants;
 		const aChanges = [];
 		const oSettings = Settings.getInstanceOrUndef();
+		const aVariantsToBeDeleted = [];
 
 		const findVariant = (sVariantKey) => {
 			return aModelVariants.find((oModelVariant) => oModelVariant.key === sVariantKey);
@@ -873,6 +888,7 @@ sap.ui.define([
 					visible: false
 				}
 			);
+			aVariantsToBeDeleted.push(sVariantKey);
 		});
 		oEvent.getParameter("contexts")?.forEach(({key: sVariantKey, contexts: aNewContexts}) => {
 			const oVariant = findVariant(sVariantKey);
@@ -896,7 +912,10 @@ sap.ui.define([
 			});
 		}
 
-		return aChanges;
+		return {
+			changes: aChanges,
+			variantsToBeDeleted: aVariantsToBeDeleted
+		};
 	};
 
 	/**
@@ -972,7 +991,7 @@ sap.ui.define([
 	 */
 	VariantModel.prototype.addVariantChange = function(sVariantManagementReference, mPropertyBag) {
 		var oChange = this.createVariantChange(sVariantManagementReference, mPropertyBag);
-		this.oChangePersistence.addDirtyChange(oChange);
+		FlexObjectManager.addDirtyFlexObjects(this.sFlexReference, [oChange]);
 
 		return oChange;
 	};
@@ -987,7 +1006,7 @@ sap.ui.define([
 		var aChanges = aChangePropertyMaps.map(function(mProperties) {
 			return this.createVariantChange(sVariantManagementReference, mProperties);
 		}.bind(this));
-		this.oChangePersistence.addDirtyChanges(aChanges);
+		FlexObjectManager.addDirtyFlexObjects(this.sFlexReference, aChanges);
 
 		return aChanges;
 	};
@@ -1000,7 +1019,10 @@ sap.ui.define([
 	 */
 	VariantModel.prototype.deleteVariantChange = function(sVariantManagementReference, mPropertyBag, oChange) {
 		this.setVariantProperties(sVariantManagementReference, mPropertyBag);
-		this.oChangePersistence.deleteChange(oChange);
+		FlexObjectManager.deleteFlexObjects({
+			reference: this.sFlexReference,
+			flexObjects: [oChange]
+		});
 	};
 
 	/**
@@ -1189,33 +1211,48 @@ sap.ui.define([
 
 	VariantModel.prototype._initializeManageVariantsEvents = function() {
 		this.fnManageClickRta = function(oEvent, oData) {
-			var aConfiguredChanges = this._collectModelChanges(oData.variantManagementReference, oData.layer, oEvent);
-			oData.resolve(aConfiguredChanges);
+			const oModelChanges = this._collectModelChanges(oData.variantManagementReference, oData.layer, oEvent);
+			oData.resolve(oModelChanges);
 		};
 
 		this.fnManageClick = function(oEvent, oData) {
 			(async () => {
+				const sVMReference = oData.variantManagementReference;
 				if (!this.oFlexController || !this.getData()) {
 					return;
 				}
-				var aConfigurationChangesContent = this._collectModelChanges(oData.variantManagementReference, Layer.USER, oEvent);
+				const {
+					changes: aConfigurationChangesContent,
+					variantsToBeDeleted: aVariantsToBeDeleted
+				} = this._collectModelChanges(sVMReference, Layer.USER, oEvent);
 
 				if (aConfigurationChangesContent.some((oChange) => {
 					return oChange.visible === false
-					&& oChange.variantReference === this.getCurrentVariantReference(oData.variantManagementReference);
+					&& oChange.variantReference === this.getCurrentVariantReference(sVMReference);
 				})) {
 					await this.updateCurrentVariant({
-						variantManagementReference: oData.variantManagementReference,
-						newVariantReference: oData.variantManagementReference
+						variantManagementReference: sVMReference,
+						newVariantReference: sVMReference
 					});
 				}
 
-				var aChanges = [];
 				aConfigurationChangesContent.forEach(function(oChangeProperties) {
 					oChangeProperties.appComponent = this.oAppComponent;
 				}.bind(this));
-				aChanges = aChanges.concat(this.addVariantChanges(oData.variantManagementReference, aConfigurationChangesContent));
-				this.oChangePersistence.saveDirtyChanges(this.oAppComponent, false, aChanges);
+
+				this.addVariantChanges(sVMReference, aConfigurationChangesContent);
+				aVariantsToBeDeleted
+				.forEach((sVariantKey) => {
+					const oVariant = VariantManagementState.getVariant({
+						reference: this.sFlexReference,
+						vmReference: sVMReference,
+						vReference: sVariantKey
+					});
+					if (oVariant.layer === Layer.USER) {
+						ControlVariantWriteUtils.deleteVariant(this.sFlexReference, sVMReference, sVariantKey);
+					}
+				});
+				this.oChangePersistence.saveDirtyChanges(this.oAppComponent, false);
 			})();
 		};
 	};
@@ -1555,8 +1592,10 @@ sap.ui.define([
 			return mCurrentVariant.controlChanges;
 		})
 		.flat();
+		const oLiveDependencyMap = FlexObjectState.getLiveDependencyMap(this.sFlexReference);
 		aVariantDependentControlChanges.forEach((oChange) => {
-			this.oChangePersistence.removeChange(oChange);
+			DependencyHandler.removeChangeFromMap(oLiveDependencyMap, oChange.getId());
+			DependencyHandler.removeChangeFromDependencies(oLiveDependencyMap, oChange.getId());
 		});
 
 		this.oDataSelector.removeUpdateListener(this.fnUpdateListener);

package/src/sap/ui/fl/variants/context/controller/ContextVisibility.controller.js

@@ -19,8 +19,8 @@ sap.ui.define([
 	"use strict";
 
 	function buildQueryParameterMap(mConfig) {
-		var mDefaultValues = {layer: Layer.CUSTOMER, type: "role"};
-		return Object.assign({}, mDefaultValues, mConfig);
+		const mDefaultValues = { layer: Layer.CUSTOMER, type: "role" };
+		return { ...mDefaultValues, ...mConfig };
 	}
 
 	function assignDescriptionsToSelectedRoles(oSelectedRoles) {

package/src/sap/ui/fl/write/_internal/SaveAs.js

@@ -11,9 +11,11 @@ sap.ui.define([
 	"sap/ui/fl/apply/_internal/appVariant/DescriptorChangeTypes",
 	"sap/ui/fl/apply/_internal/flexState/FlexObjectState",
 	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
+	"sap/ui/fl/apply/api/FlexRuntimeInfoAPI",
 	"sap/ui/fl/registry/Settings",
 	"sap/ui/fl/write/_internal/appVariant/AppVariantFactory",
 	"sap/ui/fl/write/_internal/appVariant/AppVariantInlineChangeFactory",
+	"sap/ui/fl/write/_internal/flexState/FlexObjectManager",
 	"sap/ui/fl/FlexControllerFactory",
 	"sap/ui/fl/Layer",
 	"sap/ui/fl/Utils"
@@ -24,9 +26,11 @@ sap.ui.define([
 	DescriptorChangeTypes,
 	FlexObjectState,
 	ManifestUtils,
+	FlexRuntimeInfoAPI,
 	Settings,
 	AppVariantFactory,
 	AppVariantInlineChangeFactory,
+	FlexObjectManager,
 	FlexControllerFactory,
 	Layer,
 	Utils
@@ -151,15 +155,19 @@ sap.ui.define([
 	}
 
 	function _deleteDescrChangesFromPersistence(vSelector) {
+		const sReference = ManifestUtils.getFlexReferenceForSelector(vSelector);
 		var aChangesToBeDeleted = [];
-		// In case of app variant, both persistences hold descriptor changes and have to be removed from one of the persistences
+		// In case of app variant, both persistencies hold descriptor changes and have to be removed from one of the persistencies
 		_getDirtyDescrChanges(vSelector).forEach(function(oChange) {
 			if (DescriptorChangeTypes.getChangeTypes().includes(oChange.getChangeType())) {
 				// If there are UI changes, they are sent to the backend in the last resolved promise and removed from the persistence
 				aChangesToBeDeleted.push(oChange);
 			}
 		});
-		FlexControllerFactory.createForSelector(vSelector)._oChangePersistence.deleteChanges(aChangesToBeDeleted);
+		FlexObjectManager.deleteFlexObjects({
+			reference: sReference,
+			flexObjects: aChangesToBeDeleted
+		});
 	}
 
 	function _addPackageAndTransport(oAppVariant, mPropertyBag) {
@@ -225,7 +233,8 @@ sap.ui.define([
 					// Save the dirty UI changes to backend => firing PersistenceWriteApi.save
 					return oFlexController.saveAll(Utils.getAppComponentForSelector(mPropertyBag.selector), true)
 					.then(function() {
-						oFlexController._oChangePersistence.removeDirtyChanges();
+						const sReference = FlexRuntimeInfoAPI.getFlexReference({ element: mPropertyBag.selector });
+						FlexObjectManager.removeDirtyFlexObjects({ reference: sReference });
 					})
 					.catch(function(oError) {
 						// Delete the inconsistent app variant if the UI changes failed to save

package/src/sap/ui/fl/write/_internal/Storage.js

@@ -22,7 +22,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.write._internal.Storage
 	 * @since 1.67
-	 * @version 1.128.0
+	 * @version 1.130.0
 	 * @private
 	 * @ui5-restricted sap.ui.fl
 	 */
@@ -238,22 +238,22 @@ sap.ui.define([
 	 * @returns {Promise} Promise resolving as soon as the writing was completed or was not needed; or rejects in case of an error
 	 */
 	Storage.condense = async function(mPropertyBag) {
-		const mProperties = Object.assign({}, mPropertyBag);
+		const mProperties = { ...mPropertyBag };
 		const mCondense = await prepareCondensingForConnector(mProperties);
 		if (!mCondense) {
 			return Promise.reject("No changes were provided");
 		}
 		if (mCondense.create || mCondense.reorder || mCondense.update || mCondense.delete) {
-			var oCreatedChanges = [];
+			let aCreatedChanges = [];
 			if (mCondense.create) {
-				oCreatedChanges = (mCondense.create.change ? mCondense.create.change : [])
+				aCreatedChanges = (mCondense.create.change ? mCondense.create.change : [])
 				.concat(mCondense.create.ctrl_variant ? mCondense.create.ctrl_variant : []);
 			}
 			mProperties.flexObjects = mCondense;
 
 			const oResult = await _executeActionByName("condense", mProperties);
-			if (oResult && oResult.status && oResult.status === 205 && oCreatedChanges.length) {
-				var aResponse = oCreatedChanges.map(function(oChange) {
+			if (oResult && oResult.status && oResult.status === 205 && aCreatedChanges.length) {
+				const aResponse = aCreatedChanges.map(function(oChange) {
 					return Object.values(oChange).pop();
 				});
 				oResult.response = aResponse;

package/src/sap/ui/fl/write/_internal/Versions.js

@@ -159,7 +159,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.write._internal.Versions
 	 * @since 1.74
-	 * @version 1.128.0
+	 * @version 1.130.0
 	 * @private
 	 * @ui5-restricted sap.ui.fl
 	 */
@@ -323,6 +323,7 @@ sap.ui.define([
 	 * @param {object} mPropertyBag - Property Bag
 	 * @param {string} mPropertyBag.reference - ID of the application for which the versions are requested (this reference must not contain the ".Component" suffix)
 	 * @param {string} mPropertyBag.layer - Layer for which the versions should be retrieved
+	 * @param {boolean} [mPropertyBag.discardDraftAndKeepActiveVersion] - discard draft and keep active version
 	 * @returns {Promise<object>} Promise resolving to an object to indicate if a discarding took place on backend side and/or dirty changes were discarded;
 	 * rejects if an error occurs or the layer does not support draft handling
 	 */
@@ -334,8 +335,11 @@ sap.ui.define([
 		return oDiscardPromise.then(function() {
 			var aVersions = oModel.getProperty("/versions");
 			aVersions.shift();
-			_updateVersionModelWhenDiscardOrActivate(oModel, oModel.getProperty("/activeVersion"));
-
+			let sDisplayedVersion = oModel.getProperty("/activeVersion");
+			if (mPropertyBag.discardDraftAndKeepActiveVersion) {
+				sDisplayedVersion = oModel.getProperty("/displayedVersion");
+			}
+			_updateVersionModelWhenDiscardOrActivate(oModel, sDisplayedVersion);
 			return {
 				backendChangesDiscarded: bBackendDraftExists
 			};

package/src/sap/ui/fl/write/_internal/appVariant/AppVariant.js

@@ -35,7 +35,7 @@ sap.ui.define([
 	 * @constructor
 	 * @alias sap.ui.fl.write._internal.appVariant.AppVariant
 	 * @author SAP SE
-	 * @version 1.128.0
+	 * @version 1.130.0
 	 * @private
 	 * @ui5-restricted sap.ui.rta, smart business
 	 */

package/src/sap/ui/fl/write/_internal/appVariant/AppVariantFactory.js

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * @namespace
 	 * @alias sap.ui.fl.write._internal.appVariant.AppVariantFactory
 	 * @author SAP SE
-	 * @version 1.128.0
+	 * @version 1.130.0
 	 * @private
 	 * @ui5-restricted sap.ui.rta, smart business
 	 */

package/src/sap/ui/fl/write/_internal/appVariant/AppVariantInlineChange.js

@@ -28,7 +28,7 @@ sap.ui.define([
 	 * @constructor
 	 * @alias sap.ui.fl.write._internal.appVariant.AppVariantInlineChange
 	 * @author SAP SE
-	 * @version 1.128.0
+	 * @version 1.130.0
 	 * @private
 	 * @ui5-restricted sap.ui.rta, smart business
 	 */

package/src/sap/ui/fl/write/_internal/appVariant/AppVariantInlineChangeFactory.js

@@ -33,7 +33,7 @@ sap.ui.define([
 	 * @namespace
 	 * @alias sap.ui.fl.write._internal.appVariant.AppVariantInlineChangeFactory
 	 * @author SAP SE
-	 * @version 1.128.0
+	 * @version 1.130.0
 	 * @private
 	 * @ui5-restricted sap.ui.rta, smart business
 	 */
@@ -988,6 +988,39 @@ sap.ui.define([
 		return _createAppVariantInlineChange(mPropertyBag);
 	};
 
+	/**
+	* Creates an inline change of change type <code>appdescr_fe_addNewPage</code>.
+	*
+	* @param {object} mPropertyBag Parameters of the change type
+	* @param {string} mPropertyBag.changeType Inline change type of an app variant
+	* @param {object} mPropertyBag.sourcePage Source page details
+	* @param {string} mPropertyBag.sourcePage.id ID of the source page
+	* @param {string} mPropertyBag.sourcePage.navigationSource Navigation source of the source page
+	* @param {object} mPropertyBag.targetPage Target page details
+	* @param {string} mPropertyBag.targetPage.id ID of the target page
+	* @param {string} mPropertyBag.targetPage.type Type of the target page
+	* @param {string} mPropertyBag.targetPage.name Name of the target page component
+	* @param {string} mPropertyBag.targetPage.routePattern Route pattern for navigation
+	* @param {object} mPropertyBag.targetPage.settings Additional settings for the target page
+	*
+	* @return {Promise} Resolving when creating the app variant inline change was successful (without back end access)
+	*
+	* @private
+	*/
+	AppVariantInlineChangeFactory.create_fe_addNewPage = function(mPropertyBag) {
+		Utils.checkParameterAndType(mPropertyBag.sourcePage, "id", "string");
+		Utils.checkParameterAndType(mPropertyBag.sourcePage, "navigationSource", "string");
+		Utils.checkParameterAndType(mPropertyBag.targetPage, "id", "string");
+		Utils.checkParameterAndType(mPropertyBag.targetPage, "type", "string");
+		Utils.checkParameterAndType(mPropertyBag.targetPage, "name", "string");
+		Utils.checkParameterAndType(mPropertyBag.targetPage, "routePattern", "string");
+		Utils.checkParameterAndType(mPropertyBag.targetPage, "settings", "object");
+		Utils.checkParameterAndType(mPropertyBag.targetPage.settings, "contextPath", "string");
+		Utils.checkParameterAndType(mPropertyBag.targetPage.settings, "pageLayout", "string");
+		Utils.checkParameterAndType(mPropertyBag.targetPage.settings, "controlConfiguration", "object");
+		return _createAppVariantInlineChange(mPropertyBag);
+	};
+
 	/**
 	 * Creates an inline change of change type <code>appdescr_ui_generic_app_changePageConfiguration</code>.
 	 *