@openui5/sap.ui.fl 1.98.0 → 1.101.0

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

@@ -10,6 +10,7 @@ sap.ui.define([
 	"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",
@@ -21,6 +22,7 @@ sap.ui.define([
 	Core,
 	Element,
 	VariantUtils,
+	FlexRuntimeInfoAPI,
 	ChangeHandlerStorage,
 	Settings,
 	FlexControllerFactory,
@@ -39,7 +41,9 @@ sap.ui.define([
 	 * @ui5-restricted UI5 controls that allow personalization
 	 */
 
-	 function checkChangeSpecificData(oChange, sLayer) {
+	var mChangeCreationListeners = {};
+
+	function checkChangeSpecificData(oChange, sLayer) {
 		if (!oChange.changeSpecificData) {
 			return Promise.reject(new Error("No changeSpecificData available"));
 		}
@@ -113,43 +117,85 @@ sap.ui.define([
 			if (!mPropertyBag.changes.length) {
 				return Promise.resolve([]);
 			}
-			var oAppComponent = Utils.getAppComponentForControl(mPropertyBag.changes[0].selectorElement || mPropertyBag.changes[0].selectorControl);
+			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 = [];
 
-			return mPropertyBag.changes.reduce(function(oPromise, oPersonalizationChange) {
-				return oPromise.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;
+			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;
 							}
-						}
-					} 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) {
-					return oFlexController.applyChange(oAddedChange, oPersonalizationChange.selectorControl);
-				}).then(function(oAppliedChange) {
-					aSuccessfulChanges.push(oAppliedChange);
-				}).catch(function(oError) {
-					Log.error("A Change was not added successfully. Reason:", oError.message);
+							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;
 				});
-			}, Promise.resolve()).then(function() {
-				return aSuccessfulChanges;
-			});
 		},
 
 		/**
@@ -157,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
 		 *
@@ -218,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
 		 *
@@ -278,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()
+				);
 			});
 		},
 

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.98.0
+	 * @version 1.101.0
 	 * @private
 	 * @ui5-restricted sap.ui.fl, sap.ui.rta
 	 */

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

@@ -14,11 +14,14 @@ sap.ui.define([
 	"sap/ui/fl/apply/_internal/appVariant/DescriptorChangeTypes",
 	"sap/ui/fl/write/_internal/condenser/Condenser",
 	"sap/ui/fl/write/_internal/flexState/FlexObjectState",
+	"sap/ui/fl/write/_internal/Storage",
 	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
+	"sap/ui/fl/apply/_internal/flexState/controlVariants/VariantManagementState",
 	"sap/ui/fl/write/api/FeaturesAPI",
 	"sap/ui/fl/Layer",
 	"sap/ui/fl/LayerUtils",
-	"sap/ui/fl/registry/Settings"
+	"sap/ui/fl/registry/Settings",
+	"sap/ui/fl/Utils"
 ], function(
 	includes,
 	_omit,
@@ -29,11 +32,14 @@ sap.ui.define([
 	DescriptorChangeTypes,
 	Condenser,
 	FlexObjectState,
+	Storage,
 	ManifestUtils,
+	VariantManagementState,
 	FeaturesAPI,
 	Layer,
 	LayerUtils,
-	Settings
+	Settings,
+	FlUtils
 ) {
 	"use strict";
 
@@ -78,6 +84,37 @@ sap.ui.define([
 			});
 	}
 
+	/**
+	 * Removes variant-dependent changes belonging to variants which are currently not selected
+	 *
+	 * @param {array} aChanges - List of changes to check
+	 * @param {sap.ui.fl.Control} oControl - Control for which the changes are being checked
+	 * @returns {sap.ui.fl.Change[]} List of variant-dependent changes belonging to the currently selected variants
+	 */
+	function filterChangesByCurrentVariants(aChanges, oControl) {
+		// 1. Get current variant references
+		var oComponent = FlUtils.getAppComponentForControl(oControl);
+		var oModel = oComponent.getModel(FlUtils.VARIANT_MODEL_NAME);
+		var sFlexReference = oModel && oModel.sFlexReference;
+		var aVariantManagementReferences = VariantManagementState.getVariantManagementReferences(sFlexReference);
+
+		if (aVariantManagementReferences.length === 0) {
+			return aChanges;
+		}
+
+		var aCurrentVariantReferences = aVariantManagementReferences.map(function(sVMReference) {
+			return oModel.getCurrentVariantReference(sVMReference);
+		});
+
+		// 2. Remove variant-dependent changes not assigned to a current variant reference
+		return aChanges.filter(function(oChange) {
+			return aCurrentVariantReferences.some(function(sCurrentVariantReference) {
+				return oChange.getVariantReference() === sCurrentVariantReference
+					|| !oChange.getVariantReference();
+			});
+		});
+	}
+
 	/**
 	 * Determines if user-specific changes or variants are present in the flex persistence.
 	 *
@@ -154,7 +191,7 @@ sap.ui.define([
 			// If there is change and the layer is transportable , the request to back end is always necessary
 			// because of control variant reset logic through setVisible change and app descriptor changes
 			if (bIsLayerTransportable) {
-				return ChangesController.getFlexControllerInstance(mPropertyBag.selector).getResetAndPublishInfo(mPropertyBag)
+				return Storage.getFlexInfo(mPropertyBag)
 					.then(function(oResponse) {
 						oFlexInfo.allContextsProvided = oResponse.allContextsProvided === undefined || oResponse.allContextsProvided;
 						oFlexInfo.isResetEnabled = oResponse.isResetEnabled;
@@ -365,6 +402,7 @@ sap.ui.define([
 	 * @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
+	 * @param {boolean} [mPropertyBag.onlyCurrentVariants] - Whether only changes for the currently active variants should be considered
 	 *
 	 * @returns {Promise} Promise resolves with an array of all change instances {@see sap.ui.fl.Change}
 	 * @private
@@ -375,7 +413,14 @@ sap.ui.define([
 			mPropertyBag.currentLayer = mPropertyBag.layer;
 		}
 
-		return FlexObjectState.getFlexObjects(mPropertyBag);
+		//TODO: Check the mPropertyBag.selector parameter name - the methods called on FlexObjectState expect a control
+		return FlexObjectState.getFlexObjects(mPropertyBag)
+			.then(function(aChanges) {
+				if (mPropertyBag.onlyCurrentVariants) {
+					return filterChangesByCurrentVariants(aChanges, mPropertyBag.selector);
+				}
+				return aChanges;
+			});
 	};
 
 	return PersistenceWriteAPI;

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

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * Downloads the XLIFF file for the given parameters.
 	 *
 	 * @param {object} mPropertyBag - Property bag
-	 * @param {sap.ui.fl.Selector} mPropertyBag.selector - The root control of key user adaptation
+	 * @param {sap.ui.fl.Selector} mPropertyBag.selector - Root control of key user adaptation
 	 to determine the app component and the reference
 	 * @param {string} mPropertyBag.sourceLanguage - Source language for for which the request should be made
 	 * @param {string} mPropertyBag.targetLanguage - Target language for for which the request should be made
@@ -67,7 +67,7 @@ sap.ui.define([
 	 *
 	 * @param {object} mPropertyBag - Property bag
 	 * @param {sap.ui.fl.Layer} mPropertyBag.layer - Layer
-	 * @param {sap.ui.fl.Selector} mPropertyBag.selector - The root control of key user adaptation
+	 * @param {sap.ui.fl.Selector} mPropertyBag.selector - Root control of key user adaptation
 	 to determine the app component and the reference
 	 * @returns {Promise} Resolves after the languages are retrieved;
 	 * rejects if an error occurs or parameters are missing
@@ -88,6 +88,27 @@ sap.ui.define([
 			.then(Storage.translation.getSourceLanguages.bind(undefined, mPropertyBag));
 	};
 
+	/**
+	 * Uploads an XLIFF file.
+	 *
+	 * @param {object} mPropertyBag - Property bag
+	 * @param {sap.ui.fl.Layer} mPropertyBag.layer - Layer
+	 * @param {object} mPropertyBag.payload - The file to be uploaded
+	 * @returns {Promise} Resolves after the file was uploaded;
+	 * rejects if an error occurs or a parameter is missing
+	 */
+	TranslationAPI.postTranslationTexts = function (mPropertyBag) {
+		if (!mPropertyBag.layer) {
+			return Promise.reject("No layer was provided");
+		}
+		if (!mPropertyBag.payload) {
+			return Promise.reject("No payload was provided");
+		}
+
+		return Promise.resolve()
+			.then(Storage.translation.postTranslationTexts.bind(undefined, mPropertyBag));
+	};
+
 	/* TODO follow up commit
 	TranslationAPI.upload = function (mPropertyBag) {
 	};

package/src/sap/ui/fl/write/connectors/BaseConnector.js

@@ -245,6 +245,19 @@ sap.ui.define([
 			 */
 			getTexts: function () {
 				return Promise.reject("translation.getTexts is not implemented");
+			},
+
+			/**
+			 * Interface called to upload an XLIFF file.
+			 *
+			 * @param {object} mPropertyBag - Property bag
+			 * @param {sap.ui.fl.Layer} mPropertyBag.layer - Layer
+			 * @param {object} mPropertyBag.payload - The file to be uploaded
+			 * @returns {Promise} Resolves after the file was uploaded;
+			 * rejects if an error occurs or a parameter is missing
+			 */
+			postTranslationTexts: function () {
+				return Promise.reject("translation.postTranslationTexts is not implemented");
 			}
 		}
 	};