@openui5/sap.ui.fl 1.115.1 → 1.117.0

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

@@ -15,6 +15,7 @@ sap.ui.define([
 	"sap/ui/fl/initial/_internal/changeHandlers/ChangeHandlerStorage",
 	"sap/ui/fl/registry/Settings",
 	"sap/ui/fl/write/api/ChangesWriteAPI",
+	"sap/ui/fl/ChangePersistenceFactory",
 	"sap/ui/fl/FlexControllerFactory",
 	"sap/ui/fl/Layer",
 	"sap/ui/fl/Utils"
@@ -29,6 +30,7 @@ sap.ui.define([
 	ChangeHandlerStorage,
 	Settings,
 	ChangesWriteAPI,
+	ChangePersistenceFactory,
 	FlexControllerFactory,
 	Layer,
 	Utils
@@ -116,81 +118,93 @@ sap.ui.define([
 			);
 			var oAppComponent = Utils.getAppComponentForControl(oReferenceControl);
 			var sFlexReference = FlexRuntimeInfoAPI.getFlexReference({element: oReferenceControl});
-			var oFlexController = FlexControllerFactory.createForControl(oAppComponent);
+			var oChangePersistence = ChangePersistenceFactory.getChangePersistenceForControl(oAppComponent);
 			var oVariantModel = oAppComponent.getModel(ControlVariantApplyAPI.getVariantModelName());
 			var sLayer = Layer.USER;
 			var aSuccessfulChanges = [];
 
 			function createChanges() {
 				var aChanges = [];
+				var aChangesToBeAdded = [];
 				return mPropertyBag.changes.reduce(function(pPromise, oPersonalizationChange) {
 					return pPromise
-						.then(function() {
-							oPersonalizationChange.selectorControl = oPersonalizationChange.selectorElement;
-							return checkChangeSpecificData(oPersonalizationChange, sLayer);
-						})
-						.then(function() {
-							// Transient changes are always VM-independent
-							if (!oPersonalizationChange.transient && !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;
-									}
+					.then(function() {
+						oPersonalizationChange.selectorControl = oPersonalizationChange.selectorElement;
+						return checkChangeSpecificData(oPersonalizationChange, sLayer);
+					})
+					.then(function() {
+						// Transient changes are always VM-independent
+						if (!oPersonalizationChange.transient && !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;
 							}
+						} else {
+							// delete preset variantReference
+							delete oPersonalizationChange.changeSpecificData.variantReference;
+						}
 
-							oPersonalizationChange.changeSpecificData = Object.assign(oPersonalizationChange.changeSpecificData, {developerMode: false, layer: sLayer});
-							return ChangesWriteAPI.create({
-								changeSpecificData: oPersonalizationChange.changeSpecificData,
-								selector: oPersonalizationChange.selectorControl
-							});
-						})
-						.then(function(oCreatedChange) {
-							if (!oPersonalizationChange.transient) {
-								oCreatedChange = oFlexController.addPreparedChange(oCreatedChange, oAppComponent);
-							}
+						oPersonalizationChange.changeSpecificData = Object.assign(
+							oPersonalizationChange.changeSpecificData,
+							{developerMode: false, layer: sLayer}
+						);
+						return ChangesWriteAPI.create({
+							changeSpecificData: oPersonalizationChange.changeSpecificData,
+							selector: oPersonalizationChange.selectorControl
+						});
+					})
+					.then(function(oCreatedChange) {
+						if (!oPersonalizationChange.transient) {
+							aChangesToBeAdded.push(oCreatedChange);
+						}
 
-							aChanges.push({
-								changeInstance: oCreatedChange,
-								selectorControl: oPersonalizationChange.selectorControl
-							});
-						})
-						.catch(function(oError) {
-							Log.error("A Change was not added successfully. Reason: ", oError.message);
+						aChanges.push({
+							changeInstance: oCreatedChange,
+							selectorControl: oPersonalizationChange.selectorControl
 						});
-				}, Promise.resolve())
-					.then(function() {
-						return aChanges;
+					})
+					.catch(function(oError) {
+						Log.error("A Change was not created successfully. Reason: ", oError.message);
 					});
+				}, Promise.resolve())
+				.then(function() {
+					oChangePersistence.addChanges(aChangesToBeAdded, oAppComponent);
+					return aChanges;
+				})
+				.catch(function(oError) {
+					Log.error("Changes were not added successfully. Reason: ", oError.message);
+				});
 			}
 
 			function applyChanges(aChanges) {
 				return aChanges.reduce(function(pPromise, oChange) {
 					return pPromise
-						.then(function() {
-							oChange.changeInstance.setQueuedForApply();
-							return ChangesWriteAPI.apply({
-								change: oChange.changeInstance,
-								element: oChange.selectorControl
-							});
-						})
-						.then(function(oResult) {
-							if (oResult.success) {
-								aSuccessfulChanges.push(oChange.changeInstance);
-							} else {
-								throw oResult.error || new Error("ChangesWriteAPI.apply failed with unspecified error");
-							}
-						})
-						.catch(function(oError) {
-							oFlexController.deleteChange(oChange.changeInstance, oAppComponent);
-							Log.error("A Change was not applied successfully. Reason: ", oError.message);
+					.then(function() {
+						oChange.changeInstance.setQueuedForApply();
+						return ChangesWriteAPI.apply({
+							change: oChange.changeInstance,
+							element: oChange.selectorControl
 						});
+					})
+					.then(function(oResult) {
+						if (oResult.success) {
+							aSuccessfulChanges.push(oChange.changeInstance);
+						} else {
+							throw oResult.error || new Error("ChangesWriteAPI.apply failed with unspecified error");
+						}
+					})
+					.catch(function(oError) {
+						oChangePersistence.deleteChange(oChange.changeInstance);
+						Log.error("A Change was not applied successfully. Reason: ", oError.message);
+					});
 				}, Promise.resolve());
 			}
 
@@ -201,14 +215,14 @@ sap.ui.define([
 				componentId: oAppComponent.getId()
 			}).then(function() {
 				return createChanges()
-					.then(applyChanges)
-					.then(function() {
-						(mChangeCreationListeners[sFlexReference] || [])
-							.forEach(function(fnCallback) {
-								fnCallback(aSuccessfulChanges);
-							});
-						return aSuccessfulChanges;
+				.then(applyChanges)
+				.then(function() {
+					(mChangeCreationListeners[sFlexReference] || [])
+					.forEach(function(fnCallback) {
+						fnCallback(aSuccessfulChanges);
 					});
+					return aSuccessfulChanges;
+				});
 			});
 		},
 
@@ -234,7 +248,7 @@ sap.ui.define([
 				return logAndReject("App Component could not be determined");
 			}
 
-			var aSelectorIds = mPropertyBag.selectors.map(function (vControl) {
+			var aSelectorIds = mPropertyBag.selectors.map(function(vControl) {
 				var sControlId = vControl.id || vControl.getId();
 				var sLocalId = oAppComponent.getLocalId(sControlId);
 				return sLocalId || sControlId;
@@ -260,7 +274,7 @@ sap.ui.define([
 		 * @private
 		 * @ui5-restricted
 		 */
-		restore: function (mPropertyBag) {
+		restore: function(mPropertyBag) {
 			if (!mPropertyBag || !mPropertyBag.selector) {
 				return Promise.reject("No selector was provided");
 			}
@@ -279,6 +293,46 @@ sap.ui.define([
 			return Promise.resolve();
 		},
 
+		/**
+		 * Checks for dirty flex objects that match the given parameters.
+		 * This function can be used to determine if a restore should be enabled.
+		 *
+		 * @param {object} mPropertyBag - Object with parameters as properties
+		 * @param {sap.ui.core.Control} mPropertyBag.selector - Control for which dirty flex objects are checked
+		 * @param {string} [mPropertyBag.generator] - Generator of changes
+		 * @param {string[]} [mPropertyBag.changeTypes] - Types of changes
+		 * @returns {boolean} True if the control has dirty flex objects
+		 */
+		hasDirtyFlexObjects: function(mPropertyBag) {
+			if (!mPropertyBag || !mPropertyBag.selector) {
+				throw Error("No selector was provided");
+			}
+			var oAppComponent = Utils.getAppComponentForControl(mPropertyBag.selector);
+			if (!oAppComponent) {
+				throw Error("App Component could not be determined");
+			}
+
+			var oChangePersistence = ChangePersistenceFactory.getChangePersistenceForControl(oAppComponent);
+			var aDirtyFlexObjects = oChangePersistence.getDirtyChanges();
+
+			return aDirtyFlexObjects.some(function(oFlexObject) {
+				if (oFlexObject.getLayer() !== Layer.USER) {
+					return false;
+				}
+
+				if (mPropertyBag.generator && oFlexObject.getSupportInformation().generator !== mPropertyBag.generator) {
+					return false;
+				}
+
+				if (mPropertyBag.changeTypes && mPropertyBag.changeTypes.indexOf(oFlexObject.getChangeType()) === -1) {
+					return false;
+				}
+
+				var vSelector = oFlexObject.getSelector();
+				return mPropertyBag.selector.getId() === JsControlTreeModifier.getControlIdBySelector(vSelector, oAppComponent);
+			});
+		},
+
 		/**
 		 * Saves unsaved changes to the backend service.
 		 *
@@ -337,11 +391,11 @@ sap.ui.define([
 		 * @private
 		 * @sapui5-restricted sap.ovp
 		 */
-		isCondensingEnabled: function () {
+		isCondensingEnabled: function() {
 			return Settings.getInstance()
-				.then(function (oSettings) {
-					return oSettings.isCondensingEnabled(Layer.USER);
-				});
+			.then(function(oSettings) {
+				return oSettings.isCondensingEnabled(Layer.USER);
+			});
 		},
 
 		/**

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

@@ -29,17 +29,17 @@ sap.ui.define([
 		 * @param {object} mPropertyBag.view - View object
 		 * @returns {object} mExtensionPointInfo - Map of extension point information
 		 */
-		getExtensionPointInfo: function (mPropertyBag) {
+		getExtensionPointInfo: function(mPropertyBag) {
 			return ExtensionPointRegistry.getExtensionPointInfo(mPropertyBag.name, mPropertyBag.view);
 		},
 
 		/**
 		 * Returns the extension point information by view ID.
-		 * @param {string} mPropertyBag - Object with parameters as properties
+		 * @param {object} mPropertyBag - Object with parameters as properties
 		 * @param {string} mPropertyBag.viewId - ID of the view
 		 * @returns {object} map of extension points
 		 */
-		getExtensionPointInfoByViewId: function (mPropertyBag) {
+		getExtensionPointInfoByViewId: function(mPropertyBag) {
 			return ExtensionPointRegistry.getExtensionPointInfoByViewId(mPropertyBag.viewId);
 		},
 
@@ -50,8 +50,23 @@ sap.ui.define([
 		 * @param {string} mPropertyBag.parentId - ID of the extension point parent control
 		 * @returns {Array} Array of extension point information
 		 */
-		getExtensionPointInfoByParentId: function (mPropertyBag) {
+		getExtensionPointInfoByParentId: function(mPropertyBag) {
 			return ExtensionPointRegistry.getExtensionPointInfoByParentId(mPropertyBag.parentId);
+		},
+
+		/**
+		 * Adds the ids of controls created in an extension point to the registry.
+		 * @param {object} mPropertyBag - Object with parameters as properties
+		 * @param {string} mPropertyBag.name - Name of the extension point
+		 * @param {object} mPropertyBag.viewId - ID of the view
+		 * @param {string[]} mPropertyBag.createdControlsIds - Array with the IDs of the created controls
+		 */
+		addCreatedControlsToExtensionPointInfo: function(mPropertyBag) {
+			ExtensionPointRegistry.addCreatedControls(
+				mPropertyBag.name,
+				mPropertyBag.viewId,
+				mPropertyBag.createdControlsIds
+			);
 		}
 	};
 

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

@@ -34,8 +34,8 @@ sap.ui.define([
 		 * @private
 		 * @ui5-restricted
 		 */
-		isPublishAvailable: function () {
-			return Settings.getInstance().then(function (oSettings) {
+		isPublishAvailable: function() {
+			return Settings.getInstance().then(function(oSettings) {
 				return (
 					oSettings.isPublishAvailable() ||
 					(!oSettings.isProductiveSystem() && oSettings.isSystemWithTransports())
@@ -57,12 +57,12 @@ sap.ui.define([
 		 * @private
 		 * @ui5-restricted
 		 */
-		isSaveAsAvailable: function (sLayer) {
+		isSaveAsAvailable: function(sLayer) {
 			return Promise.all([
 				Settings.getInstance(),
 				Utils.getUShellService("CrossApplicationNavigation")
 			])
-			.then(function (aPromises) {
+			.then(function(aPromises) {
 				var oSettings = aPromises[0];
 				var oCrossAppNav = aPromises[1];
 				return (
@@ -71,13 +71,12 @@ sap.ui.define([
 					&& oCrossAppNav !== undefined // Not a standalone app
 				);
 			})
-			.catch(function () {
-				//either Settings or CrossApplicationNavigation service from Unified Shell failed -> disable save as app variant
+			.catch(function() {
+				// either Settings or CrossApplicationNavigation service from Unified Shell failed -> disable save as app variant
 				return false;
 			});
 		},
 
-
 		/**
 		 * Determine if the context-based adaptation feature is available in the connected backend
 		 *
@@ -88,7 +87,7 @@ sap.ui.define([
 		 * @ui5-restricted
 		 */
 		isContextBasedAdaptationAvailable: function(sLayer) {
-			return Settings.getInstance().then(function (oSettings) {
+			return Settings.getInstance().then(function(oSettings) {
 				if (oSettings.isContextBasedAdaptationEnabled() && sLayer === Layer.CUSTOMER) {
 					return true;
 				}
@@ -105,11 +104,11 @@ sap.ui.define([
 		 * @returns {Promise<boolean>} Resolves to a boolean indicating if the key user role is assigned to the user
 		 * @public
 		 */
-		isKeyUser: function () {
+		isKeyUser: function() {
 			return Settings.getInstance()
-				.then(function (oSettings) {
-					return oSettings.isKeyUser();
-				});
+			.then(function(oSettings) {
+				return oSettings.isKeyUser();
+			});
 		},
 
 		/**
@@ -120,11 +119,11 @@ sap.ui.define([
 		 * @private
 		 * @ui5-restricted sap.ui.rta
 		 */
-		isVersioningEnabled: function (sLayer) {
+		isVersioningEnabled: function(sLayer) {
 			return Settings.getInstance()
-				.then(function (oSettings) {
-					return oSettings.isVersioningEnabled(sLayer);
-				});
+			.then(function(oSettings) {
+				return oSettings.isVersioningEnabled(sLayer);
+			});
 		},
 
 		/**
@@ -135,10 +134,10 @@ sap.ui.define([
 		 * @private
 		 * @ui5-restricted sap.ui.rta
 		 */
-		isKeyUserTranslationEnabled: function (sLayer) {
+		isKeyUserTranslationEnabled: function(sLayer) {
 			if (sLayer === Layer.CUSTOMER) {
 				return Settings.getInstance()
-				.then(function (oSettings) {
+				.then(function(oSettings) {
 					return oSettings.isKeyUserTranslationEnabled();
 				});
 			}
@@ -154,12 +153,12 @@ sap.ui.define([
 		 * @deprecated
 		 * @ui5-restricted sap.ui.fl.write.api.ContextSharingAPI
 		 */
-		isContextSharingEnabled: function (sLayer) {
+		isContextSharingEnabled: function(sLayer) {
 			if (sLayer !== Layer.CUSTOMER) {
 				return Promise.resolve(false);
 			}
 			return Settings.getInstance()
-			.then(function (oSettings) {
+			.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.115.1
+	 * @version 1.117.0
 	 * @private
 	 * @ui5-restricted sap.ui.fl, sap.ui.rta
 	 */

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

@@ -41,12 +41,12 @@ sap.ui.define([
 		};
 		var oChangePersistence = ChangePersistenceFactory.getChangePersistenceForControl(oControl);
 		return oChangePersistence.getAllUIChanges(mPropertyBag)
-			.filter(function(oChange) {
-				return (
-					oChange.getState() !== States.LifecycleState.DELETED
+		.filter(function(oChange) {
+			return (
+				oChange.getState() !== States.LifecycleState.DELETED
 					&& oChange.getVariantReference() === (sCurrentVariant || undefined)
-				);
-			});
+			);
+		});
 	}
 
 	function getNestedChangesForControlCheck(oTargetControl) {
@@ -70,50 +70,46 @@ sap.ui.define([
 
 		function checkChange(oChange) {
 			return oChange.getDependentSelectorList()
-				.map(function (sSelector) {
-					return JsControlTreeModifier.bySelector(sSelector, oComponent);
-				})
-				.filter(Boolean)
-				.some(function (oDependent) {
-					return isPartOfTargetControlTree(oDependent);
-				});
+			.map(function(sSelector) {
+				return JsControlTreeModifier.bySelector(sSelector, oComponent);
+			})
+			.filter(Boolean)
+			.some(function(oDependent) {
+				return isPartOfTargetControlTree(oDependent);
+			});
 		}
 
 		return checkChange;
 	}
 
-	LocalResetAPI.resetChanges = function (aChanges, oAppComponent) {
+	LocalResetAPI.resetChanges = function(aChanges, oAppComponent) {
 		// Reset in reverse order, make sure not to mutate the original order as it is used to restore
 		var aReverseChanges = aChanges.slice().reverse();
 
-		var aRevertQueue = aReverseChanges.map(function (oChange) {
+		var aRevertQueue = aReverseChanges.map(function(oChange) {
 			var oControl = JsControlTreeModifier.bySelector(oChange.getSelector(), oAppComponent);
-			return function () {
-				return PersistenceWriteAPI.remove({
+			// execPromiseQueueSequentially expects promises wrapped inside a function
+			return function() {
+				oChange.setQueuedForRevert();
+				return ChangesWriteAPI.revert({
 					change: oChange,
-					selector: oControl
-				})
-				.then(function () {
-					oChange.setQueuedForRevert();
-					return ChangesWriteAPI.revert({
-						change: oChange,
-						element: oControl
-					});
+					element: oControl
 				});
 			};
 		});
-		return Utils.execPromiseQueueSequentially(aRevertQueue);
+
+		return PersistenceWriteAPI.remove({
+			flexObjects: aReverseChanges,
+			selector: oAppComponent
+		})
+		.then(Utils.execPromiseQueueSequentially.bind(Utils, aRevertQueue));
 	};
 
-	LocalResetAPI.restoreChanges = function (aChanges, oAppComponent) {
-		var aApplyQueue = aChanges.map(function (oChange) {
-			return function () {
+	LocalResetAPI.restoreChanges = function(aChanges, oAppComponent) {
+		var aApplyQueue = aChanges.map(function(oChange) {
+			return function() {
 				oChange.restorePreviousState();
 				var oControl = JsControlTreeModifier.bySelector(oChange.getSelector(), oAppComponent);
-				PersistenceWriteAPI.add({
-					change: oChange,
-					selector: oControl
-				});
 				if (oChange.getState() === States.LifecycleState.PERSISTED) {
 					var oChangePersistence = ChangePersistenceFactory.getChangePersistenceForControl(oAppComponent);
 					var aDirtyChanges = oChangePersistence.getDirtyChanges();
@@ -122,7 +118,6 @@ sap.ui.define([
 						aDirtyChanges.splice(iIndex, 1);
 					}
 				}
-
 				return ChangesWriteAPI.apply({
 					change: oChange,
 					element: oControl,
@@ -130,6 +125,10 @@ sap.ui.define([
 				});
 			};
 		});
+		PersistenceWriteAPI.add({
+			flexObjects: aChanges,
+			selector: oAppComponent
+		});
 		return Utils.execPromiseQueueSequentially(aApplyQueue);
 	};