@openui5/sap.ui.fl 1.129.0 → 1.130.1

package/src/sap/ui/fl/write/api/ChangesWriteAPI.js

@@ -21,8 +21,11 @@ sap.ui.define([
 	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
 	"sap/ui/fl/descriptorRelated/api/DescriptorChangeFactory",
 	"sap/ui/fl/initial/_internal/changeHandlers/ChangeHandlerStorage",
-	"sap/ui/fl/write/api/ContextBasedAdaptationsAPI",
 	"sap/ui/fl/write/_internal/appVariant/AppVariantInlineChangeFactory",
+	"sap/ui/fl/write/_internal/controlVariants/ControlVariantWriteUtils",
+	"sap/ui/fl/write/_internal/flexState/FlexObjectManager",
+	"sap/ui/fl/write/api/ContextBasedAdaptationsAPI",
+	"sap/ui/fl/write/api/VersionsAPI",
 	"sap/ui/fl/Layer",
 	"sap/ui/fl/Utils"
 ], function(
@@ -42,8 +45,11 @@ sap.ui.define([
 	ManifestUtils,
 	DescriptorChangeFactory,
 	ChangeHandlerStorage,
-	ContextBasedAdaptationsAPI,
 	AppVariantInlineChangeFactory,
+	ControlVariantWriteUtils,
+	FlexObjectManager,
+	ContextBasedAdaptationsAPI,
+	VersionsAPI,
 	Layer,
 	Utils
 ) {
@@ -99,7 +105,19 @@ sap.ui.define([
 			oFlexObject.getLayer()
 		)
 		.then((oChangeHandler) => {
-			return oChangeHandler.completeChangeContent(oFlexObject, mPropertyBag.changeSpecificData, {
+			const oChangeSpecificData = { ...mPropertyBag.changeSpecificData };
+			// Copy the content properties into the change specific data so any change handler can use the "settings" change structure
+			// TODO: consolidate in all commands/change handlers so the "content" structure is always used. todos#4
+			if (oChangeSpecificData.content) {
+				Object.keys(oChangeSpecificData.content).forEach((sKey) => {
+					if (!oChangeSpecificData[sKey]) {
+						oChangeSpecificData[sKey] = oChangeSpecificData.content[sKey];
+					} else {
+						Log.warning(`The property '${sKey}' is defined both in the change specific data and its content.`);
+					}
+				});
+			}
+			return oChangeHandler.completeChangeContent(oFlexObject, oChangeSpecificData, {
 				modifier: JsControlTreeModifier,
 				appComponent: mPropertyBag.appComponent,
 				view: Utils.getViewForControl(mPropertyBag.selector)
@@ -314,5 +332,57 @@ sap.ui.define([
 		);
 	};
 
+	/**
+	 * Deletes the variants and their related FlexObjects. Only variants that are in the draft or dirty state can be deleted,
+	 * as they have no dependencies on them. Returns all FlexObjects that were deleted in the process.
+	 *
+	 * @param {object} mPropertyBag - Object with parameters as properties
+	 * @param {sap.ui.core.Control} mPropertyBag.variantManagementControl - Variant management control
+	 * @param {string[]} mPropertyBag.variants - Variant IDs to be deleted
+	 * @param {string} mPropertyBag.layer - Layer to get the draft objects from
+	 * @returns {sap.ui.fl.apply._internal.flexObjects.FlexObject[]} Array of deleted FlexObjects
+	 * @private
+	 * @ui5-restricted sap.ui.fl, sap.ui.rta, similar tools
+	 */
+	ChangesWriteAPI.deleteVariantsAndRelatedObjects = function(mPropertyBag) {
+		if (!(mPropertyBag.variantManagementControl?.isA("sap.ui.fl.variants.VariantManagement"))) {
+			throw new Error("Please provide a valid Variant Management control");
+		}
+		const oVariantManagementControl = mPropertyBag.variantManagementControl;
+		const oAppComponent = Utils.getAppComponentForControl(oVariantManagementControl);
+		const sVariantManagementReference = JsControlTreeModifier.getSelector(oVariantManagementControl, oAppComponent).id;
+		const sFlexReference = ManifestUtils.getFlexReferenceForControl(oAppComponent);
+		const aDraftFilenames = VersionsAPI.getDraftFilenames({
+			control: oVariantManagementControl,
+			layer: mPropertyBag.layer
+		});
+		const aDirtyFlexObjectIds = FlexObjectState.getDirtyFlexObjects(sFlexReference).map((oFlexObject) => (
+			oFlexObject.getId()
+		));
+		const aVariantsToBeDeleted = mPropertyBag.variants.filter((sVariantID) => (
+			aDraftFilenames.includes(sVariantID) || aDirtyFlexObjectIds.includes(sVariantID)
+		));
+		return aVariantsToBeDeleted
+		.map((sVariantId) => (
+			ControlVariantWriteUtils.deleteVariant(sFlexReference, sVariantManagementReference, sVariantId)
+		))
+		.flat();
+	};
+
+	/**
+	 * Restores previously deleted FlexObjects. Objects are restored to the state they were in before deletion.
+	 * If the flex object was not persisted, it is added as a dirty object again.
+	 * Once the deletion is persisted, changes will not be restored.
+	 *
+	 * @param {object} mPropertyBag - Object with parameters as properties
+	 * @param {string} mPropertyBag.reference - Flex reference of the application
+	 * @param {sap.ui.fl.apply._internal.flexObjects.FlexObject[]} mPropertyBag.flexObjects - FlexObjects to be restored
+	 * @private
+	 * @ui5-restricted sap.ui.fl, sap.ui.rta, similar tools
+	 */
+	ChangesWriteAPI.restoreDeletedFlexObjects = function(mPropertyBag) {
+		FlexObjectManager.restoreDeletedFlexObjects(mPropertyBag);
+	};
+
 	return ChangesWriteAPI;
 });

package/src/sap/ui/fl/write/api/FieldExtensibility.js

@@ -22,7 +22,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.write.api.FieldExtensibility
 	 * @since 1.87
-	 * @version 1.129.0
+	 * @version 1.130.1
 	 * @private
 	 * @ui5-restricted sap.ui.fl, sap.ui.rta, sap.ui.mdc
 	 */

package/src/sap/ui/fl/write/api/LocalResetAPI.js

@@ -5,25 +5,25 @@
  */
 
 sap.ui.define([
+	"sap/base/util/restricted/_union",
+	"sap/ui/core/util/reflection/JsControlTreeModifier",
 	"sap/ui/fl/apply/_internal/flexObjects/States",
 	"sap/ui/fl/apply/_internal/flexState/changes/UIChangesState",
-	"sap/ui/fl/apply/_internal/flexState/FlexObjectState",
 	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
-	"sap/ui/fl/write/api/PersistenceWriteAPI",
+	"sap/ui/fl/write/_internal/flexState/changes/UIChangeManager",
 	"sap/ui/fl/write/api/ChangesWriteAPI",
-	"sap/ui/core/util/reflection/JsControlTreeModifier",
-	"sap/ui/fl/Utils",
-	"sap/base/util/restricted/_union"
+	"sap/ui/fl/write/api/PersistenceWriteAPI",
+	"sap/ui/fl/Utils"
 ], function(
+	union,
+	JsControlTreeModifier,
 	States,
 	UIChangesState,
-	FlexObjectState,
 	ManifestUtils,
-	PersistenceWriteAPI,
+	UIChangeManager,
 	ChangesWriteAPI,
-	JsControlTreeModifier,
-	Utils,
-	union
+	PersistenceWriteAPI,
+	Utils
 ) {
 	"use strict";
 
@@ -106,28 +106,18 @@ sap.ui.define([
 	};
 
 	LocalResetAPI.restoreChanges = function(aChanges, oAppComponent) {
-		var aApplyQueue = aChanges.map(function(oChange) {
-			return function() {
-				oChange.restorePreviousState();
-				var oControl = JsControlTreeModifier.bySelector(oChange.getSelector(), oAppComponent);
-				if (oChange.getState() === States.LifecycleState.PERSISTED) {
-					const aDirtyChanges = FlexObjectState.getDirtyFlexObjects(oAppComponent.name);
-					var iIndex = aDirtyChanges.indexOf(oChange);
-					if (iIndex >= 0) {
-						aDirtyChanges.splice(iIndex, 1);
-					}
-				}
+		const sReference = ManifestUtils.getFlexReferenceForControl(oAppComponent);
+		UIChangeManager.restoreDeletedChanges(sReference, aChanges, oAppComponent);
+		const aApplyQueue = aChanges.map((oChange) =>
+			() => {
+				const oControl = JsControlTreeModifier.bySelector(oChange.getSelector(), oAppComponent);
 				return ChangesWriteAPI.apply({
 					change: oChange,
 					element: oControl,
 					modifier: JsControlTreeModifier
 				});
-			};
-		});
-		PersistenceWriteAPI.add({
-			flexObjects: aChanges,
-			selector: oAppComponent
-		});
+			}
+		);
 		return Utils.execPromiseQueueSequentially(aApplyQueue);
 	};
 

package/src/sap/ui/fl/write/api/VersionsAPI.js

@@ -147,6 +147,19 @@ sap.ui.define([
 		return !!oDraft;
 	};
 
+	/**
+	 * Returns the list of Flex Objects file names which belong to the current draft.
+	 *
+	 * @param {object} mPropertyBag - Property bag
+	 * @param {sap.ui.core.Control} mPropertyBag.control - Control for which the request is done
+	 * @param {string} mPropertyBag.layer - Layer for which the file names should be retrieved
+	 * @returns {string[]} List of file names for the draft
+	 */
+	VersionsAPI.getDraftFilenames = function(mPropertyBag) {
+		const oModel = getVersionsModel(mPropertyBag);
+		return oModel.getProperty("/draftFilenames");
+	};
+
 	/**
 	 * Returns a flag if the displayed version is not the active version for the current application and layer.
 	 *
@@ -287,6 +300,7 @@ sap.ui.define([
 	 * @param {object} mPropertyBag - Property bag
 	 * @param {sap.ui.core.Control} mPropertyBag.control - Control for which the request is done
 	 * @param {string} mPropertyBag.layer - Layer for which the versions should be retrieved
+	 * @param {boolean} [mPropertyBag.discardDraftAndKeepActiveVersion] - discard draft and keep active version
 	 * @returns {Promise<boolean>} Promise resolving with a flag if a discarding took place;
 	 * rejects if an error occurs or the layer does not support draft handling
 	 */
@@ -310,12 +324,16 @@ sap.ui.define([
 		}
 		return Versions.discardDraft({
 			reference: sReference,
-			layer: mPropertyBag.layer
+			layer: mPropertyBag.layer,
+			discardDraftAndKeepActiveVersion: mPropertyBag.discardDraftAndKeepActiveVersion
 		})
 		.then(function(oDiscardInfo) {
 			// in case of a existing draft known by the backend;
 			// we remove dirty changes only after successful DELETE request
-			const bDirtyChangesRemoved = removeDirtyChanges();
+			var bDirtyChangesRemoved = false;
+			if (!mPropertyBag.discardDraftAndKeepActiveVersion) {
+				bDirtyChangesRemoved = removeDirtyChanges();
+			}
 			oDiscardInfo.dirtyChangesDiscarded = bDirtyChangesRemoved;
 
 			if (oDiscardInfo.backendChangesDiscarded) {
@@ -330,12 +348,16 @@ sap.ui.define([
 						const oFlexInfo = FlexInfoSession.getByReference(sReference);
 						oFlexInfo.displayedAdaptationId = sDisplayedAdaptationId;
 						FlexInfoSession.setByReference(oFlexInfo, sReference);
-						FlexState.clearState(sReference);
+						if (!mPropertyBag.discardDraftAndKeepActiveVersion) {
+							FlexState.clearState(sReference);
+						}
 						return oDiscardInfo;
 					});
 				}
 			}
-			FlexState.clearState(sReference);
+			if (!mPropertyBag.discardDraftAndKeepActiveVersion) {
+				FlexState.clearState(sReference);
+			}
 			return oDiscardInfo;
 		});
 	};