@openui5/sap.ui.fl 1.107.0 → 1.108.0

package/src/sap/ui/fl/write/_internal/flexState/compVariants/CompVariantState.js

@@ -261,7 +261,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.write._internal.flexState.compVariants.CompVariantState
 	 * @since 1.83
-	 * @version 1.107.0
+	 * @version 1.108.0
 	 * @private
 	 * @ui5-restricted sap.ui.fl
 	 */
@@ -439,7 +439,8 @@ sap.ui.define([
 					previousFavorite: oVariant.getFavorite(),
 					previousExecuteOnSelection: oVariant.getExecuteOnSelection(),
 					previousContexts: oVariant.getContexts(),
-					previousName: oVariant.getName()
+					previousName: oVariant.getName(),
+					previousAction: mPropertyBag.action
 				}
 			};
 			oVariant.addRevertData(new CompVariantRevertData(oRevertData));
@@ -468,7 +469,7 @@ sap.ui.define([
 
 		function updateChange(mPropertyBag, oVariant, oChange) {
 			var aRevertData = oChange.getRevertData() || [];
-			var oChangeContent = oChange.getContent();
+			var oChangeContent = Object.assign({}, oChange.getContent());
 			var oRevertData = {
 				previousContent: Object.assign({}, oChangeContent),
 				previousState: oChange.getState(),
@@ -560,6 +561,54 @@ sap.ui.define([
 		return oVariant;
 	};
 
+	/**
+	 * Discards the variant content to the original or last saved content;
+	 *
+	 * @param {object} mPropertyBag - Object with parameters as properties
+	 * @param {string} mPropertyBag.reference - Flex reference of the application
+	 * @param {sap.ui.comp.smartvariants.SmartVariantManagement|
+	 * 			sap.ui.comp.smartfilterbar.SmartFilterBar|
+	 * 			sap.ui.comp.smarttable.SmartTable|
+	 * 			sap.ui.comp.smartchart.SmartChart} mPropertyBag.control - Variant management control for which the variant should be updated
+	 * @param {string} mPropertyBag.id - ID of the variant
+	 * @param {sap.ui.fl.Layer} [mPropertyBag.layer] - Layer in which the save of variant content takes place
+	 * @returns {sap.ui.fl.apply._internal.flexObjects.CompVariant} The discarded variant
+	 */
+	CompVariantState.discardVariantContent = function(mPropertyBag) {
+		var oVariant = getVariantById(mPropertyBag);
+		var aVariantRevertData = oVariant.getRevertData();
+		if (aVariantRevertData.length !== 0) {
+			//Look at revert data backward, to find the content of last save action
+			var bIsVariantSaved = aVariantRevertData.slice().reverse().some(function (oRevertData) {
+				if (oRevertData.getContent().previousAction === CompVariantState.updateActionType.SAVE) {
+					mPropertyBag.content = oRevertData.getContent().previousContent;
+					mPropertyBag.action = CompVariantState.updateActionType.DISCARD;
+					return true;
+				}
+			});
+
+			if (!bIsVariantSaved) {
+				mPropertyBag.content = aVariantRevertData[0].getContent().previousContent;
+				mPropertyBag.action = CompVariantState.updateActionType.DISCARD;
+			}
+			//Update variant content to the last saved or original content
+			CompVariantState.updateVariant(mPropertyBag);
+		}
+		return oVariant;
+	};
+
+	/**
+	 * Defines the different types of actions lead to a variant got update.
+	 *
+	 * @enum {string}
+	 */
+	CompVariantState.updateActionType = {
+		UPDATE: "update",
+		SAVE: "save",
+		DISCARD: "discard",
+		UPDATE_METADATA: "update_metadata"
+	};
+
 	/**
 	 * Defines the different types of operations done on a variant.
 	 * - StateUpdate only changes the variants persistence status. I.e. a removeVariant call only sets the variant to <code>DELETED</code>
@@ -825,5 +874,25 @@ sap.ui.define([
 		return Promise.all(aPromises);
 	};
 
+	/**
+	 * Checks if dirty changes on SmartVariantManagement exist for a flex persistence associated by a reference;
+	 *
+	 * @param {string} sReference - Flex reference of the app
+	 * @returns {boolean} <code>true</code> if dirty changes exist
+	 */
+	CompVariantState.hasDirtyChanges = function (sReference) {
+		var mCompEntities = FlexState.getCompVariantsMap(sReference);
+		var aEntities = [];
+		for (var sPersistencyKey in mCompEntities) {
+			var mCompVariantsOfPersistencyKey = mCompEntities[sPersistencyKey];
+			for (var sId in mCompVariantsOfPersistencyKey.byId) {
+				aEntities.push(mCompVariantsOfPersistencyKey.byId[sId]);
+			}
+		}
+		return aEntities.some(function(oFlexObject) {
+			return oFlexObject.getState() !== States.PERSISTED && !(oFlexObject.getVariantId && oFlexObject.getVariantId() === "*standard*");
+		});
+	};
+
 	return CompVariantState;
 });

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

@@ -26,7 +26,7 @@ sap.ui.define([
 	 * @private
 	 * @alias sap.ui.fl.write._internal.transport.TransportSelection
 	 * @author SAP SE
-	 * @version 1.107.0
+	 * @version 1.108.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.

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

@@ -27,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.107.0
+	 * @version 1.108.0
 	 * @since 1.74.0
 	 * @private
 	 * @ui5-restricted sap.ui.fl.write._internal.transport

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

@@ -5,13 +5,15 @@
  */
 
 sap.ui.define([
-	"sap/ui/fl/write/api/FeaturesAPI",
 	"sap/ui/fl/variants/context/Component",
-	"sap/ui/core/ComponentContainer"
+	"sap/ui/core/ComponentContainer",
+	"sap/ui/fl/Layer",
+	"sap/ui/fl/registry/Settings"
 ], function(
-	FeaturesAPI,
 	ContextSharingComponent,
-	ComponentContainer
+	ComponentContainer,
+	Layer,
+	Settings
 ) {
 	"use strict";
 
@@ -35,12 +37,18 @@ sap.ui.define([
 		 *
 		 * @param {object} mPropertyBag - Object with parameters as properties
 		 * @param {string} [mPropertyBag.layer] - Layer
+		 * @param {string} [mPropertyBag.isComp=true] - Flag if the control owning the Component is the comp.VariantManagement
 		 * @returns {Promise<sap.ui.core.ComponentContainer>} Promise resolving with the ComponentContainer or nothing depending on the availability of the feature in the used back end
 		 * @private
 		 * @ui5-restricted sap.ui.comp, sap.ui.fl
 		 */
 		createComponent: function(mPropertyBag) {
-			return FeaturesAPI.isContextSharingEnabled(mPropertyBag.layer).then(function(bIsEnabled) {
+			if (mPropertyBag.layer !== Layer.CUSTOMER) {
+				return Promise.resolve();
+			}
+			return Settings.getInstance().then(function(oSettings) {
+				return (mPropertyBag.isComp) ? oSettings.isContextSharingEnabledForComp() : oSettings.isContextSharingEnabled();
+			}).then(function(bIsEnabled) {
 				if (bIsEnabled) {
 					if (!oComponentContainer || oComponentContainer.bIsDestroyed) {
 						var oComponent = new ContextSharingComponent("contextSharing");

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

@@ -9,6 +9,7 @@ sap.ui.define([
 	"sap/ui/core/util/reflection/JsControlTreeModifier",
 	"sap/ui/core/Core",
 	"sap/ui/core/Element",
+	"sap/ui/fl/apply/_internal/flexState/FlexState",
 	"sap/ui/fl/apply/_internal/controlVariants/Utils",
 	"sap/ui/fl/apply/api/FlexRuntimeInfoAPI",
 	"sap/ui/fl/initial/_internal/changeHandlers/ChangeHandlerStorage",
@@ -21,6 +22,7 @@ sap.ui.define([
 	JsControlTreeModifier,
 	Core,
 	Element,
+	FlexState,
 	VariantUtils,
 	FlexRuntimeInfoAPI,
 	ChangeHandlerStorage,
@@ -187,15 +189,19 @@ sap.ui.define([
 			// 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;
-				});
+			return FlexState.initialize({
+				componentId: oAppComponent.getId()
+			}).then(function() {
+				return createChanges()
+					.then(applyChanges)
+					.then(function() {
+						(mChangeCreationListeners[sFlexReference] || [])
+							.forEach(function(fnCallback) {
+								fnCallback(aSuccessfulChanges);
+							});
+						return aSuccessfulChanges;
+					});
+			});
 		},
 
 		/**
@@ -226,7 +232,10 @@ sap.ui.define([
 				return sLocalId || sControlId;
 			});
 			var oFlexController = FlexControllerFactory.createForControl(oAppComponent);
-			return oFlexController.resetChanges(Layer.USER, undefined, oAppComponent, aSelectorIds, mPropertyBag.changeTypes);
+			if (FlexState.isInitialized({control: oAppComponent})) {
+				return oFlexController.resetChanges(Layer.USER, undefined, oAppComponent, aSelectorIds, mPropertyBag.changeTypes);
+			}
+			return Promise.resolve();
 		},
 
 		/**
@@ -255,8 +264,11 @@ sap.ui.define([
 			}
 
 			var oFlexController = FlexControllerFactory.createForControl(oAppComponent);
-			// limit the deletion to the passed selector control only
-			return oFlexController.removeDirtyChanges(Layer.USER, oAppComponent, mPropertyBag.selector, mPropertyBag.generator, mPropertyBag.changeTypes);
+			if (FlexState.isInitialized({control: oAppComponent})) {
+				// limit the deletion to the passed selector control only
+				return oFlexController.removeDirtyChanges(Layer.USER, oAppComponent, mPropertyBag.selector, mPropertyBag.generator, mPropertyBag.changeTypes);
+			}
+			return Promise.resolve();
 		},
 
 		/**
@@ -279,11 +291,17 @@ sap.ui.define([
 			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;
-				});
+
+			if (FlexState.isInitialized({control: oAppComponent})) {
+				return oFlexController.saveSequenceOfDirtyChanges(mPropertyBag.changes, oAppComponent)
+					.then(function(oResponse) {
+						if (oVariantModel) {
+							oVariantModel.checkDirtyStateForControlModels(aVariantManagementReferences);
+						}
+						return oResponse;
+					});
+			}
+			return Promise.resolve();
 		},
 
 		/**

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

@@ -6,11 +6,9 @@
 
 sap.ui.define([
 	"sap/ui/fl/registry/Settings",
-	"sap/ui/fl/write/_internal/Storage",
 	"sap/ui/fl/Layer"
 ], function(
 	Settings,
-	Storage,
 	Layer
 ) {
 	"use strict";
@@ -143,13 +141,17 @@ sap.ui.define([
 		 * @param {string} sLayer - Layer to get correct connector
 		 * @returns {Promise<boolean>} Resolves to a boolean indicating if context sharing is enabled
 		 * @private
+		 * @deprecated
 		 * @ui5-restricted sap.ui.fl.write.api.ContextSharingAPI
 		 */
 		isContextSharingEnabled: function (sLayer) {
 			if (sLayer !== Layer.CUSTOMER) {
 				return Promise.resolve(false);
 			}
-			return Storage.isContextSharingEnabled({layer: sLayer});
+			return Settings.getInstance()
+			.then(function (oSettings) {
+				return oSettings.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.107.0
+	 * @version 1.108.0
 	 * @private
 	 * @ui5-restricted sap.ui.fl, sap.ui.rta
 	 */

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

@@ -80,6 +80,17 @@ sap.ui.define([
 			});
 	}
 
+	/**
+	 * Checks if dirty changes exist for the flex persistence associated with the selector control;
+	 *
+	 * @param {object} mPropertyBag Object with parameters as properties
+	 * @param {sap.ui.fl.Selector} mPropertyBag.selector To retrieve the associated flex persistence
+	 * @returns {boolean} <code>true</code> if dirty changes exist
+	 */
+	PersistenceWriteAPI.hasDirtyChanges = function(mPropertyBag) {
+		return FlexObjectState.hasDirtyFlexObjects(mPropertyBag);
+	};
+
 	/**
 	 * Determines if user-specific changes or variants are present in the flex persistence.
 	 *

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

@@ -36,7 +36,7 @@ sap.ui.define([
 	 * @experimental
 	 * @since 1.69.0
 	 * @private
-	 * @ui5-restricted sap.ui.comp
+	 * @ui5-restricted sap.ui.comp, sap.ui.rta
 	 */
 	var SmartVariantManagementWriteAPI = /** @lends sap.ui.fl.write.api.SmartVariantManagementWriteAPI */{
 		/**
@@ -89,7 +89,7 @@ sap.ui.define([
 		 * @param {object} [mPropertyBag.content] - Content of the new change
 		 * @param {object} [mPropertyBag.favorite] - Flag if the variant should be flagged as a favorite
 		 * @param {object} [mPropertyBag.executeOnSelection] - Flag if the variant should be executed on selection
-		 * @param {sap.ui.fl.Layer} [mPropertyBag.layer] - Layer in which the variant removal takes place
+		 * @param {sap.ui.fl.Layer} [mPropertyBag.layer] - Layer in which the variant update 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
@@ -100,6 +100,89 @@ sap.ui.define([
 			return setReferenceAndPersistencyKeyInPropertyBagAndCallFunction(mPropertyBag, CompVariantState.updateVariant);
 		},
 
+		/**
+		 * Updates content of a variant; this may result in an update of the variant or the creation of a change.
+		 *
+		 * @param {object} mPropertyBag - Object with parameters as properties
+		 * @param {string} mPropertyBag.reference - Flex reference of the application
+		 * @param {sap.ui.comp.smartvariants.SmartVariantManagement|
+		 * 			sap.ui.comp.smartfilterbar.SmartFilterBar|
+		 * 			sap.ui.comp.smarttable.SmartTable|
+		 * 			sap.ui.comp.smartchart.SmartChart} mPropertyBag.control - Variant management control for which the variant should be updated
+		 * @param {string} mPropertyBag.id - ID of the variant
+		 * @param {object} mPropertyBag.content - New content of the variant
+		 * @param {sap.ui.fl.Layer} [mPropertyBag.layer] - Layer in which the variant content update takes place
+		 * @returns {sap.ui.fl.apply._internal.flexObjects.CompVariant} The updated variant
+		 * @private
+		 * @ui5-restricted sap.ui.rta.command
+		 */
+		updateVariantContent: function (mPropertyBag) {
+			mPropertyBag.action = CompVariantState.updateActionType.UPDATE;
+			return setReferenceAndPersistencyKeyInPropertyBagAndCallFunction(mPropertyBag, CompVariantState.updateVariant);
+		},
+
+		/**
+		 * Saves the current content of a variant; this does not trigger the back end call to persist the variant.
+		 *
+		 * @param {object} mPropertyBag - Object with parameters as properties
+		 * @param {string} mPropertyBag.reference - Flex reference of the application
+		 * @param {sap.ui.comp.smartvariants.SmartVariantManagement|
+		 * 			sap.ui.comp.smartfilterbar.SmartFilterBar|
+		 * 			sap.ui.comp.smarttable.SmartTable|
+		 * 			sap.ui.comp.smartchart.SmartChart} mPropertyBag.control - Variant management control for which the variant should be updated
+		 * @param {string} mPropertyBag.id - ID of the variant
+		 * @param {sap.ui.fl.Layer} [mPropertyBag.layer] - Layer in which the save of variant content takes place
+		 * @private
+		 * @ui5-restricted sap.ui.rta.command
+		 */
+		saveVariantContent: function (mPropertyBag) {
+			mPropertyBag.action = CompVariantState.updateActionType.SAVE;
+			return setReferenceAndPersistencyKeyInPropertyBagAndCallFunction(mPropertyBag, CompVariantState.updateVariant);
+		},
+
+		/**
+		 * Discards the variant content to the original or last saved content.
+		 *
+		 * @param {object} mPropertyBag - Object with parameters as properties
+		 * @param {string} mPropertyBag.reference - Flex reference of the application
+		 * @param {sap.ui.comp.smartvariants.SmartVariantManagement|
+		 * 			sap.ui.comp.smartfilterbar.SmartFilterBar|
+		 * 			sap.ui.comp.smarttable.SmartTable|
+		 * 			sap.ui.comp.smartchart.SmartChart} mPropertyBag.control - Variant management control for which the variant should be updated
+		 * @param {string} mPropertyBag.id - ID of the variant
+		 * @param {sap.ui.fl.Layer} [mPropertyBag.layer] - Layer in which the save of variant content takes place
+		 * @returns {sap.ui.fl.apply._internal.flexObjects.CompVariant} The discarded variant
+		 * @private
+		 * @ui5-restricted sap.ui.rta.command
+		 */
+		discardVariantContent: function (mPropertyBag) {
+			mPropertyBag.action = CompVariantState.updateActionType.DISCARD;
+			return setReferenceAndPersistencyKeyInPropertyBagAndCallFunction(mPropertyBag, CompVariantState.discardVariantContent);
+		},
+
+		/**
+		 * Updates the metadata of a variant; this may result in an update of the variant or the creation of a change.
+		 * The metadata includes variant name and favorite, automatic apply on selection, default, contexts statuses.
+		 *
+		 * @param {object} mPropertyBag - Object with parameters as properties
+		 * @param {string} mPropertyBag.reference - Flex reference of the application
+		 * @param {sap.ui.comp.smartvariants.SmartVariantManagement|
+		 * 			sap.ui.comp.smartfilterbar.SmartFilterBar|
+		 * 			sap.ui.comp.smarttable.SmartTable|
+		 * 			sap.ui.comp.smartchart.SmartChart} mPropertyBag.control - Variant management control for which the variant should be updated
+		 * @param {string} mPropertyBag.id - ID of the variant
+		 * @param {object} [mPropertyBag.name] - Title of the variant
+		 * @param {object} [mPropertyBag.favorite] - Flag if the variant should be flagged as a favorite
+		 * @param {object} [mPropertyBag.executeOnSelection] - Flag if the variant should be executed on selection
+		 * @param {sap.ui.fl.Layer} [mPropertyBag.layer] - Layer in which the variant metadata update takes place
+		 * @returns {sap.ui.fl.apply._internal.flexObjects.CompVariant} The updated variant
+		 * @private
+		 * @ui5-restricted sap.ui.rta.command
+		 */
+		updateVariantMetadata: function (mPropertyBag) {
+			mPropertyBag.action = CompVariantState.updateActionType.UPDATE_METADATA;
+			return setReferenceAndPersistencyKeyInPropertyBagAndCallFunction(mPropertyBag, CompVariantState.updateVariant);
+		},
 
 		/**
 		 * Removes a variant; this may result in an deletion of the variant or the creation of a change.