@openui5/sap.ui.fl 1.96.5 → 1.99.0

package/src/sap/ui/fl/write/_internal/transport/TransportSelection.js

@@ -25,13 +25,11 @@ sap.ui.define([
 	/**
 	 * @private
 	 * @alias sap.ui.fl.write._internal.transport.TransportSelection
-	 * @constructor
 	 * @author SAP SE
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 * @since 1.74.0
 	 * Helper object to select an ABAP transport for an LREP object. This is not a generic utility to select a transport request, but part
 	 *        of the SmartVariant control.
-	 * @returns {sap.ui.fl.write._internal.transport.TransportSelection} New instance of <code>sap.ui.fl.write._internal.transport.TransportSelection</code>
 	 */
 	var TransportSelection = function() {};
 
@@ -51,6 +49,7 @@ sap.ui.define([
 	 * @param {function} fError - Callback to be invoked when an error occurred during selection of a transport request
 	 * @param {boolean} bCompactMode - Flag indicating whether the transport dialog should be opened in compact mode
 	 * @param {object} oControl - Control instance
+	 * @param {string} sStyleClass - CSS style class that should be added to any dialogs
 	 * @public
 	 */
 	TransportSelection.prototype.selectTransport = function(oObjectInfo, fOkay, fError, bCompactMode, oControl, sStyleClass) {
@@ -157,6 +156,7 @@ sap.ui.define([
 	 * @param {function} fOkay - Callback to be invoked when a transport request has successfully been selected
 	 * @param {function} fError - Callback to be invoked when an error occurred during selection of a transport request
 	 * @param {boolean} bCompactMode - Flag indicating whether the transport dialog should be opened in compact mode
+	 * @param {string} sStyleClass - CSS style class that should be added to any dialogs
 	 * @returns {sap.ui.fl.write._internal.transport.TransportDialog} Dialog
 	 * @private
 	 */
@@ -202,7 +202,7 @@ sap.ui.define([
 	/**
 	 * Returns whether the dialog to select a transport should be started.
 	 *
-	 * @param {object} oTransports- Available transports
+	 * @param {object} oTransports - Available transports
 	 * @param {boolean} bATOActive - Indicates whether the system is using ATO_NOTIFICATION or not
 	 * @returns {boolean} <code>true</code> if the LREP object is already locked in one of the transports, <code>false</code> otherwise
 	 * @private
@@ -303,7 +303,8 @@ sap.ui.define([
 	 * Opens the transport selection dialog
 	 *
 	 * @param {sap.ui.fl.Change} [oChange] - Change for which the transport information should be retrieved
-	 * @param {object} oControl- Object of the root control for the transport dialog
+	 * @param {object} oControl - Object of the root control for the transport dialog
+	 * @param {string} sStyleClass - CSS style class that should be added to any dialogs
 	 * @returns {Promise} Promise that resolves
 	 * @public
 	 */

package/src/sap/ui/fl/write/_internal/transport/Transports.js

@@ -3,7 +3,6 @@
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
-/*global Promise */
 
 sap.ui.define([
 	"sap/ui/fl/initial/_internal/connectors/LrepConnector",
@@ -28,7 +27,7 @@ sap.ui.define([
 	 * Entity that handles ABAP transport related information.
 	 * @alias sap.ui.fl.write._internal.transport.Transports
 	 * @author SAP SE
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 * @since 1.74.0
 	 * @private
 	 * @ui5-restricted sap.ui.fl.write._internal.transport

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

@@ -5,16 +5,28 @@
  */
 
 sap.ui.define([
-	"sap/ui/fl/ControlPersonalizationAPI",
+	"sap/base/Log",
+	"sap/ui/core/util/reflection/JsControlTreeModifier",
+	"sap/ui/core/Core",
+	"sap/ui/core/Element",
+	"sap/ui/fl/apply/_internal/controlVariants/Utils",
+	"sap/ui/fl/apply/api/FlexRuntimeInfoAPI",
+	"sap/ui/fl/initial/_internal/changeHandlers/ChangeHandlerStorage",
+	"sap/ui/fl/registry/Settings",
 	"sap/ui/fl/FlexControllerFactory",
 	"sap/ui/fl/Layer",
-	"sap/ui/fl/registry/Settings",
 	"sap/ui/fl/Utils"
 ], function(
-	OldControlPersonalizationAPI,
+	Log,
+	JsControlTreeModifier,
+	Core,
+	Element,
+	VariantUtils,
+	FlexRuntimeInfoAPI,
+	ChangeHandlerStorage,
+	Settings,
 	FlexControllerFactory,
 	Layer,
-	Settings,
 	Utils
 ) {
 	"use strict";
@@ -29,6 +41,52 @@ sap.ui.define([
 	 * @ui5-restricted UI5 controls that allow personalization
 	 */
 
+	var mChangeCreationListeners = {};
+
+	function checkChangeSpecificData(oChange, sLayer) {
+		if (!oChange.changeSpecificData) {
+			return Promise.reject(new Error("No changeSpecificData available"));
+		}
+		if (!oChange.changeSpecificData.changeType) {
+			return Promise.reject(new Error("No valid changeType"));
+		}
+
+		if (!(oChange.selectorControl instanceof Element)) {
+			return Promise.reject(new Error("No valid selectorControl"));
+		}
+
+		var sControlType = oChange.selectorControl.getMetadata().getName();
+		return ChangeHandlerStorage.getChangeHandler(
+			oChange.changeSpecificData.changeType,
+			sControlType,
+			oChange.selectorControl,
+			JsControlTreeModifier,
+			sLayer
+		);
+	}
+
+	function getRelevantVariantManagementReference(oAppComponent, oControl, bUseStaticArea) {
+		var sVMControlId = VariantUtils.getRelevantVariantManagementControlId(oControl, [], bUseStaticArea);
+		return JsControlTreeModifier.getSelector(sVMControlId, oAppComponent).id;
+	}
+
+	function getAllVariantManagementReferences(oAppComponent) {
+		var aVMControlIds = VariantUtils.getAllVariantManagementControlIds(oAppComponent);
+		return aVMControlIds.reduce(function(aValidIds, sVMControlId) {
+			var oForControls = Core.byId(sVMControlId).getFor();
+			// without any referenced controls the VM control is not active and should be ignored
+			if (oForControls.length) {
+				aValidIds.push(JsControlTreeModifier.getSelector(sVMControlId, oAppComponent).id);
+			}
+			return aValidIds;
+		}, []);
+	}
+
+	function logAndReject(sMessage) {
+		Log.error(sMessage);
+		return Promise.reject(sMessage);
+	}
+
 	/**
 	 * Object containing attributes of a change, along with the control to which this change should be applied.
 	 *
@@ -43,7 +101,6 @@ sap.ui.define([
 	 */
 
 	var ControlPersonalizationWriteAPI = /** @lends sap.ui.fl.write.api.ControlPersonalizationWriteAPI */{
-
 		/**
 		 * Creates personalization changes, adds them to the flex persistence (not yet saved) and applies them to the control.
 		 *
@@ -57,12 +114,88 @@ sap.ui.define([
 		 * @ui5-restricted
 		 */
 		add: function(mPropertyBag) {
-			mPropertyBag.changes.forEach(function(oPersonalizationChange) {
-				oPersonalizationChange.selectorControl = oPersonalizationChange.selectorElement;
-			});
-			// old API is still using the old name
-			mPropertyBag.controlChanges = mPropertyBag.changes;
-			return OldControlPersonalizationAPI.addPersonalizationChanges(mPropertyBag);
+			if (!mPropertyBag.changes.length) {
+				return Promise.resolve([]);
+			}
+			var oReferenceControl = (
+				mPropertyBag.changes[0].selectorElement
+				|| mPropertyBag.changes[0].selectorControl
+			);
+			var oAppComponent = Utils.getAppComponentForControl(oReferenceControl);
+			var sFlexReference = FlexRuntimeInfoAPI.getFlexReference({element: oReferenceControl});
+			var oFlexController = FlexControllerFactory.createForControl(oAppComponent);
+			var oVariantModel = oAppComponent.getModel(Utils.VARIANT_MODEL_NAME);
+			var sLayer = Layer.USER;
+			var aSuccessfulChanges = [];
+
+			function createChanges() {
+				var aAddedChanges = [];
+				return mPropertyBag.changes.reduce(function(pPromise, oPersonalizationChange) {
+					return pPromise
+						.then(function() {
+							oPersonalizationChange.selectorControl = oPersonalizationChange.selectorElement;
+							return checkChangeSpecificData(oPersonalizationChange, sLayer);
+						})
+						.then(function() {
+							if (!mPropertyBag.ignoreVariantManagement) {
+								// check for preset variantReference
+								if (!oPersonalizationChange.changeSpecificData.variantReference) {
+									var sVariantManagementReference = getRelevantVariantManagementReference(oAppComponent, oPersonalizationChange.selectorControl, mPropertyBag.useStaticArea);
+									if (sVariantManagementReference) {
+										var sCurrentVariantReference = oVariantModel.oData[sVariantManagementReference].currentVariant;
+										oPersonalizationChange.changeSpecificData.variantReference = sCurrentVariantReference;
+									}
+								}
+							} else {
+								// delete preset variantReference
+								delete oPersonalizationChange.changeSpecificData.variantReference;
+							}
+
+							oPersonalizationChange.changeSpecificData = Object.assign(oPersonalizationChange.changeSpecificData, {developerMode: false, layer: sLayer});
+							return oFlexController.addChange(oPersonalizationChange.changeSpecificData, oPersonalizationChange.selectorControl);
+						})
+						.then(function(oAddedChange) {
+							aAddedChanges.push({
+								changeInstance: oAddedChange,
+								selectorControl: oPersonalizationChange.selectorControl
+							});
+						})
+						.catch(function(oError) {
+							Log.error("A Change was not added successfully. Reason:", oError.message);
+						});
+				}, Promise.resolve())
+					.then(function() {
+						return aAddedChanges;
+					});
+			}
+
+			function applyChanges(aAddedChanges) {
+				return aAddedChanges.reduce(function(pPromise, oAddedChange) {
+					return pPromise
+						.then(function() {
+							return oFlexController.applyChange(oAddedChange.changeInstance, oAddedChange.selectorControl);
+						})
+						.then(function(oAppliedChange) {
+							aSuccessfulChanges.push(oAppliedChange);
+						})
+						.catch(function(oError) {
+							Log.error("A Change was not applied successfully. Reason:", oError.message);
+						});
+				}, Promise.resolve());
+			}
+
+			// Make sure to first create and add all changes so that change handlers
+			// that rely on change batching in the applier can wait for them, e.g.
+			// when adding multiple columns at once to a MDC table
+			return createChanges()
+				.then(applyChanges)
+				.then(function() {
+					(mChangeCreationListeners[sFlexReference] || [])
+						.forEach(function(fnCallback) {
+							fnCallback(aSuccessfulChanges);
+						});
+					return aSuccessfulChanges;
+				});
 		},
 
 		/**
@@ -70,7 +203,7 @@ sap.ui.define([
 		 *
 		 * @param {object} mPropertyBag - Object with parameters as properties
 		 * @param {sap.ui.fl.Selector[]} mPropertyBag.selectors - Array of selectors, at least one selector is necessary
-		 * @param {String[]} [mPropertyBag.changeTypes] - Types of changes to be deleted
+		 * @param {string[]} [mPropertyBag.changeTypes] - Types of changes to be deleted
 		 *
 		 * @returns {Promise} Promise that resolves after the deletion took place and changes are reverted
 		 *
@@ -78,8 +211,22 @@ sap.ui.define([
 		 * @ui5-restricted
 		 */
 		reset: function(mPropertyBag) {
-			mPropertyBag.selectors = mPropertyBag.selectors || [];
-			return OldControlPersonalizationAPI.resetChanges(mPropertyBag.selectors, mPropertyBag.changeTypes);
+			if (!mPropertyBag.selectors || mPropertyBag.selectors.length === 0) {
+				return logAndReject("At least one control ID has to be provided as a parameter");
+			}
+
+			var oAppComponent = mPropertyBag.selectors[0].appComponent || Utils.getAppComponentForControl(mPropertyBag.selectors[0]);
+			if (!oAppComponent) {
+				return logAndReject("App Component could not be determined");
+			}
+
+			var aSelectorIds = mPropertyBag.selectors.map(function (vControl) {
+				var sControlId = vControl.id || vControl.getId();
+				var sLocalId = oAppComponent.getLocalId(sControlId);
+				return sLocalId || sControlId;
+			});
+			var oFlexController = FlexControllerFactory.createForControl(oAppComponent);
+			return oFlexController.resetChanges(Layer.USER, undefined, oAppComponent, aSelectorIds, mPropertyBag.changeTypes);
 		},
 
 		/**
@@ -117,7 +264,7 @@ sap.ui.define([
 		 *
 	 	 * @param {object} mPropertyBag - Object with parameters as properties
 		 * @param {sap.ui.fl.Selector} mPropertyBag.selector - Selector
-		 * @param {String[]} [mPropertyBag.changes] - Array of changes to be saved; if not provided, all unsaved changes will be saved
+		 * @param {string[]} [mPropertyBag.changes] - Array of changes to be saved; if not provided, all unsaved changes will be saved
 		 *
 		 * @returns {Promise} Promise that is resolved when the changes have been saved
 		 *
@@ -126,7 +273,17 @@ sap.ui.define([
 		 */
 		save: function(mPropertyBag) {
 			var oAppComponent = mPropertyBag.selector.appComponent || Utils.getAppComponentForControl(mPropertyBag.selector);
-			return OldControlPersonalizationAPI.saveChanges(mPropertyBag.changes, oAppComponent);
+			if (!oAppComponent) {
+				return logAndReject("App Component could not be determined");
+			}
+			var oFlexController = FlexControllerFactory.createForControl(oAppComponent);
+			var oVariantModel = oAppComponent.getModel(Utils.VARIANT_MODEL_NAME);
+			var aVariantManagementReferences = getAllVariantManagementReferences(oAppComponent);
+			return oFlexController.saveSequenceOfDirtyChanges(mPropertyBag.changes, oAppComponent)
+				.then(function(oResponse) {
+					oVariantModel.checkDirtyStateForControlModels(aVariantManagementReferences);
+					return oResponse;
+				});
 		},
 
 		/**
@@ -167,6 +324,53 @@ sap.ui.define([
 				.then(function (oSettings) {
 					return oSettings.isCondensingEnabled(Layer.USER);
 				});
+		},
+
+		/**
+		 * Registers the provided callback function to be called when personalization changes are
+		 * added for the flex reference that the given control belongs to.
+		 *
+		 * @param {sap.ui.core.Control} oControl - Reference control to get the flex reference
+		 * @param {function} fnCallback - Function to be called on change creation
+		 * @private
+		 * @sapui5-restricted sap.ui.rta
+		 */
+		attachChangeCreation: function(oControl, fnCallback) {
+			var sFlexReference = FlexRuntimeInfoAPI.getFlexReference({element: oControl});
+			mChangeCreationListeners[sFlexReference] = (mChangeCreationListeners[sFlexReference] || []).concat(fnCallback);
+		},
+
+		/**
+		 * Removes a previously registered callback function by reference.
+		 *
+		 * @param {sap.ui.core.Control} oControl - Reference control to get the flex reference
+		 * @param {function} fnCallback - Function reference to be removed
+		 * @private
+		 * @sapui5-restricted sap.ui.rta
+		 */
+		detachChangeCreation: function(oControl, fnCallback) {
+			var sFlexReference = FlexRuntimeInfoAPI.getFlexReference({element: oControl});
+			if (Array.isArray(mChangeCreationListeners[sFlexReference])) {
+				mChangeCreationListeners[sFlexReference] = mChangeCreationListeners[sFlexReference].filter(function(fnRegisteredCallback) {
+					return fnRegisteredCallback !== fnCallback;
+				});
+			}
+		},
+
+		/**
+		 * Removes all registered change creation listeners.
+		 *
+		 * @param {sap.ui.core.Control} [oControl] - When provided, listeners are only removed for the flex reference of the given control
+		 * @private
+		 * @sapui5-restricted sap.ui.rta
+		 */
+		detachAllChangeCreationListeners: function(oControl) {
+			if (oControl) {
+				var sFlexReference = FlexRuntimeInfoAPI.getFlexReference({element: oControl});
+				delete mChangeCreationListeners[sFlexReference];
+			} else {
+				mChangeCreationListeners = {};
+			}
 		}
 	};
 

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

@@ -37,7 +37,10 @@ sap.ui.define([
 		 */
 		isPublishAvailable: function () {
 			return Settings.getInstance().then(function (oSettings) {
-				return !oSettings.isProductiveSystem();
+				return (
+					!oSettings.isProductiveSystem()
+					&& oSettings.isSystemWithTransports()
+				);
 			});
 		},
 
@@ -101,6 +104,7 @@ sap.ui.define([
 		/**
 		 * Checks if key user has also the admin role to enable the translation button
 		 *
+		 * @param {sap.ui.fl.Layer} sLayer - Current layer
 		 * @returns {Promise<boolean>} Resolves to a boolean indicating if they keyuser is also admin
 		 * @public
 		 */
@@ -115,13 +119,16 @@ sap.ui.define([
 		},
 
 		/**
-		 * Checks if context sharing is enbaled.
+		 * Checks if context sharing is enabled.
 		 *
 		 * @param {string} sLayer - Layer to get correct connector
 		 * @returns {Promise<boolean>} Resolves to a boolean indicating if context sharing is enabled
 		 * @public
 		 */
 		isContextSharingEnabled: function (sLayer) {
+			if (sLayer !== Layer.CUSTOMER) {
+				return Promise.resolve(false);
+			}
 			return Storage.isContextSharingEnabled({layer: sLayer});
 		}
 	};

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

@@ -24,7 +24,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.write.api.FieldExtensibility
 	 * @since 1.87
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 * @private
 	 * @ui5-restricted sap.ui.fl, sap.ui.rta
 	 */
@@ -68,6 +68,7 @@ sap.ui.define([
 	 * Until this function is called again the control does not change and information can be cached.
 	 *
 	 * @param {sap.ui.base.ManagedObject} oControl - Control instance that was selected
+	 * @returns {Promise} Resolves with the return value of the function in the implementation
 	 */
 	FieldExtensibility.onControlSelected = function(oControl) {
 		return callFunctionInImplementation("onControlSelected", oControl);
@@ -97,6 +98,7 @@ sap.ui.define([
 	 * Removes the flag that identifies the service as outdated.
 	 *
 	 * @param  {string|map} vServiceInfo - service uri or service info map containing <code>serviceName</code>, <code>serviceVersion</code> and <code>serviceType</code>
+	 * @returns {Promise} Resolves with the return value of the function in the implementation
 	 */
 	FieldExtensibility.setServiceValid = function(vServiceInfo) {
 		return callFunctionInImplementation("setServiceValid", vServiceInfo);
@@ -105,7 +107,7 @@ sap.ui.define([
 	/**
 	 * Retrieves the necessary texts.
 	 *
-	 * @returns {object} - Object with <code>tooltip</code> and <code>headerText</code>
+	 * @returns {Promise<object>} - Object with <code>tooltip</code> and <code>headerText</code>
 	 */
 	FieldExtensibility.getTexts = function() {
 		return callFunctionInImplementation("getTexts");
@@ -114,7 +116,7 @@ sap.ui.define([
 	/**
 	 * Retrieves the extension data.
 	 *
-	 * @returns {Object} All necessary information about the extension data. This will be passed to <code>FieldExtensibility.onTriggerCreateExtensionData</code>
+	 * @returns {Promise<object>} All necessary information about the extension data. This will be passed to <code>FieldExtensibility.onTriggerCreateExtensionData</code>
 	 */
 	FieldExtensibility.getExtensionData = function() {
 		// TODO: currently the return value must be an object that includes .BusinessContexts in order to be shown in the Dialog.
@@ -126,6 +128,8 @@ sap.ui.define([
 	 * Handler for the button to trigger extension data creation.
 	 *
 	 * @param {object} oExtensibilityInfo - Information about the extension data. Should be the return value of <code>FieldExtensibility.getExtensionData</code>
+	 * @param {string} sRtaStyleClassName - CSS style class that should be added to any dialogs
+	 * @returns {Promise} Resolves with the return value of the function in the implementation
 	 */
 	FieldExtensibility.onTriggerCreateExtensionData = function(oExtensibilityInfo, sRtaStyleClassName) {
 		return callFunctionInImplementation("onTriggerCreateExtensionData", oExtensibilityInfo, sRtaStyleClassName);

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

@@ -17,7 +17,8 @@ sap.ui.define([
 	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
 	"sap/ui/fl/write/api/FeaturesAPI",
 	"sap/ui/fl/Layer",
-	"sap/ui/fl/LayerUtils"
+	"sap/ui/fl/LayerUtils",
+	"sap/ui/fl/registry/Settings"
 ], function(
 	includes,
 	_omit,
@@ -31,7 +32,8 @@ sap.ui.define([
 	ManifestUtils,
 	FeaturesAPI,
 	Layer,
-	LayerUtils
+	LayerUtils,
+	Settings
 ) {
 	"use strict";
 
@@ -235,6 +237,7 @@ sap.ui.define([
 	 * @param {object} mPropertyBag - Object with parameters as properties
 	 * @param {sap.ui.fl.Change} mPropertyBag.change - Change instance
 	 * @param {sap.ui.fl.Selector} mPropertyBag.selector - To retrieve the associated flex persistence
+	 * @returns {sap.ui.fl.Change} The change instance
 	 *
 	 * @private
 	 * @ui5-restricted
@@ -287,6 +290,41 @@ sap.ui.define([
 			});
 	};
 
+	/**
+	 * Decides which warning should be shown if changes were made
+	 * in a different system or in a P system with no changes at all.
+	 *
+	 * @param {object} mPropertyBag - Object with parameters as properties
+	 * @param {sap.ui.fl.Selector} mPropertyBag.selector - Retrieves the associated flex persistence
+	 * @param {string} [mPropertyBag.layer] - Layer for which changes are to be deleted
+	 * @param {string} [mPropertyBag.generator] - Generator of changes
+	 * @param {string[]} [mPropertyBag.selectorIds] - Selector IDs in local format
+	 * @param {string[]} [mPropertyBag.changeTypes] - Types of changes
+	 * @returns {Promise} Resolves with object that decides if warning should be shown
+	 *
+	 */
+	 PersistenceWriteAPI.getChangesWarning = function (mPropertyBag) {
+		return this._getUIChanges(mPropertyBag).then(function (aChanges) {
+			var bHasChangesFromOtherSystem = aChanges.some(function (oChange) {
+				return oChange.isChangeFromOtherSystem();
+			});
+
+			var oSettingsInstance = Settings.getInstanceOrUndef();
+			var isProductiveSystemWithTransports = oSettingsInstance && oSettingsInstance.isProductiveSystemWithTransports();
+			var bHasNoChanges = aChanges.length === 0;
+			var oChangesWarning = {showWarning: false};
+
+			if (bHasChangesFromOtherSystem) {
+				oChangesWarning = {showWarning: true, warningType: "mixedChangesWarning"};
+			}
+
+			if (isProductiveSystemWithTransports && bHasNoChanges) {
+				oChangesWarning = {showWarning: true, warningType: "noChangesAndPSystemWarning"};
+			}
+			return oChangesWarning;
+		});
+	};
+
 	/**
 	 * Calls the Condenser with all the passed changes.
 	 * ATTENTION: Only to be used by sap.ui.rta.test
@@ -323,7 +361,7 @@ sap.ui.define([
 	 * @param {string} [mPropertyBag.siteId] - ID of the site belonging to the current running component
 	 * @param {string} [mPropertyBag.layer] - Specifies a single layer for loading change; if this parameter is set, the max layer filtering is not applied
 	 * @param {boolean} [mPropertyBag.ignoreMaxLayerParameter] - Indicates that changes are to be loaded without layer filtering
-	 * @param {boolean} [mPropertyBag.includeVariants] - Indicates that smart variants are to be included
+	 * @param {boolean} [mPropertyBag.includeCtrlVariants] - Flag if control variant changes should be included
 	 * @param {boolean} [mPropertyBag.includeDirtyChanges] - Flag if dirty UI changes should be included
 	 * @param {string} [mPropertyBag.cacheKey] - Key to validate the cache entry stored on client side
 	 * @param {boolean} [mPropertyBag.invalidateCache] - Indicates whether the cache is to be invalidated

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

@@ -232,7 +232,7 @@ sap.ui.define([
 		 */
 		initialDraftGotActivated: function(oReloadInfo) {
 			if (oReloadInfo.versioningEnabled) {
-				var bUrlHasVersionParameter = this.hasVersionParameterWithValue({value: sap.ui.fl.Versions.Draft.toString()}, oReloadInfo.URLParsingService);
+				var bUrlHasVersionParameter = this.hasVersionParameterWithValue({value: sap.ui.fl.Versions.Draft}, oReloadInfo.URLParsingService);
 				return !VersionsAPI.isDraftAvailable(oReloadInfo) && bUrlHasVersionParameter;
 			}
 			return false;
@@ -262,10 +262,10 @@ sap.ui.define([
 
 			// TODO fix app descriptor handling and reload behavior
 			// TODO move changesNeedReload near flexState; set flag when saving change that needs a reload
-			oReloadInfo.isDraftAvailable = oReloadInfo.isDraftAvailable || ReloadInfoAPI.hasVersionParameterWithValue({value: sap.ui.fl.Versions.Draft.toString()}, oReloadInfo.URLParsingService);
+			oReloadInfo.isDraftAvailable = oReloadInfo.isDraftAvailable || ReloadInfoAPI.hasVersionParameterWithValue({value: sap.ui.fl.Versions.Draft}, oReloadInfo.URLParsingService);
 
-			if (oReloadInfo.activeVersion > sap.ui.fl.Versions.Original) {
-				oReloadInfo.activeVersionNotSelected = oReloadInfo.activeVersion && !ReloadInfoAPI.hasVersionParameterWithValue({value: oReloadInfo.activeVersion.toString()}, oReloadInfo.URLParsingService);
+			if (oReloadInfo.activeVersion !== sap.ui.fl.Versions.Original) {
+				oReloadInfo.activeVersionNotSelected = oReloadInfo.activeVersion && !ReloadInfoAPI.hasVersionParameterWithValue({value: oReloadInfo.activeVersion}, oReloadInfo.URLParsingService);
 			}
 			oReloadInfo.hasHigherLayerChanges = ReloadInfoAPI.hasMaxLayerParameterWithValue({value: oReloadInfo.layer}, oReloadInfo.URLParsingService);
 			oReloadInfo.initialDraftGotActivated = ReloadInfoAPI.initialDraftGotActivated(oReloadInfo);

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

@@ -92,6 +92,7 @@ sap.ui.define([
 		 * @param {sap.ui.fl.Layer} [mPropertyBag.layer] - Layer in which the variant removal takes place
 		 * @param {boolean} [mPropertyBag.changeSpecificData.isUserDependent] - Flag if the variant is personalization only
 		 * this either updates the variant from the layer or writes a change to that layer.
+		 * @returns {sap.ui.fl.apply._internal.flexObjects.CompVariant} The updated variant
 		 * @private
 		 * @ui5-restricted sap.ui.rta.command, sap.ui.comp.smartvariants.SmartVariantManagement
 		 */
@@ -112,6 +113,7 @@ sap.ui.define([
 		 * @param {string} mPropertyBag.id - ID of the variant
 		 * @param {sap.ui.fl.Layer} mPropertyBag.layer - Layer in which the variant removal takes place;
 		 * this either removes the variant from the layer or writes a change to that layer.
+		 * @returns {sap.ui.fl.apply._internal.flexObjects.CompVariant} The removed variant
 		 * @private
 		 * @ui5-restricted sap.ui.rta.command
 		 */