@openui5/sap.ui.fl 1.96.2 → 1.97.0

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

@@ -5,16 +5,24 @@
  */
 
 sap.ui.define([
-	"sap/ui/fl/ControlPersonalizationAPI",
+	"sap/base/Log",
+	"sap/ui/core/util/reflection/JsControlTreeModifier",
+	"sap/ui/core/Element",
+	"sap/ui/fl/apply/_internal/controlVariants/Utils",
+	"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,
+	Element,
+	VariantUtils,
+	ChangeHandlerStorage,
+	Settings,
 	FlexControllerFactory,
 	Layer,
-	Settings,
 	Utils
 ) {
 	"use strict";
@@ -29,6 +37,45 @@ sap.ui.define([
 	 * @ui5-restricted UI5 controls that allow personalization
 	 */
 
+	 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.map(function(sVMControlId) {
+			return JsControlTreeModifier.getSelector(sVMControlId, oAppComponent).id;
+		});
+	}
+
+	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 +90,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 +103,46 @@ sap.ui.define([
 		 * @ui5-restricted
 		 */
 		add: function(mPropertyBag) {
-			mPropertyBag.changes.forEach(function(oPersonalizationChange) {
-				oPersonalizationChange.selectorControl = oPersonalizationChange.selectorElement;
+			if (!mPropertyBag.changes.length) {
+				return Promise.resolve([]);
+			}
+			var oAppComponent = Utils.getAppComponentForControl(mPropertyBag.changes[0].selectorElement || mPropertyBag.changes[0].selectorControl);
+			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;
+							}
+						}
+					} 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);
+				});
+			}, Promise.resolve()).then(function() {
+				return aSuccessfulChanges;
 			});
-			// old API is still using the old name
-			mPropertyBag.controlChanges = mPropertyBag.changes;
-			return OldControlPersonalizationAPI.addPersonalizationChanges(mPropertyBag);
 		},
 
 		/**
@@ -78,8 +158,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);
 		},
 
 		/**
@@ -126,7 +220,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;
+				});
 		},
 
 		/**

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

@@ -101,6 +101,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
 		 */

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.2
+	 * @version 1.97.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

@@ -234,6 +234,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
@@ -322,7 +323,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/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
 		 */

package/ui5.yaml

@@ -1,5 +1,5 @@
 ---
-specVersion: "2.0"
+specVersion: "2.4"
 type: library
 metadata:
   name: sap.ui.fl
@@ -10,3 +10,134 @@ metadata:
 resources:
   configuration:
     propertiesFileSourceEncoding: ISO-8859-1
+builder:
+  bundles:
+    - bundleDefinition:
+        name: sap/ui/fl/library-preload.js
+        sections:
+          - mode: provided
+            filters:
+              - ui5loader-autoconfig.js
+              - sap/base/
+              - sap/m/
+              - sap/ui/Device.js
+              - sap/ui/base/
+              - sap/ui/core/
+              - sap/ui/dom/
+              - sap/ui/events/
+              - sap/ui/layout/
+              - sap/ui/model/
+              - sap/ui/performance/
+              - sap/ui/thirdparty/
+              - sap/ui/unified/
+              - sap/ui/util/
+          - mode: preload
+            name: sap/ui/fl/library-preload
+            filters:
+              - sap/ui/fl/changeHandler/
+              - sap/ui/fl/library.js
+              - sap/ui/fl/manifest.json
+              - sap/ui/fl/util/ManagedObjectModel.js
+              - sap/ui/fl/apply/_internal/DelegateMediator.js
+              - sap/ui/fl/apply/api/DelegateMediatorAPI.js
+              - sap/ui/fl/codeExt/CodeExtManager.js
+              - sap/ui/fl/library-dbg.support.js
+              - sap/ui/fl/registry/SimpleChanges.js
+              - sap/ui/fl/interfaces/Delegate.js
+              - sap/ui/fl/initial/_internal/connectors/StaticFileConnector.js
+              - sap/ui/fl/interfaces/BaseLoadConnector.js
+            resolve: true
+          - mode: bundleInfo
+            name: sap/ui/fl/library-preload-apply.js
+            filters:
+              - sap/ui/fl/apply/
+              - sap/ui/fl/transport/TransportDialog.js
+              - sap/ui/fl/transport/TransportSelection.js
+              - sap/ui/fl/util/IFrame.flexibility.js
+            resolve: true
+          - mode: bundleInfo
+            name: sap/ui/fl/library-preload-write.js
+            filters:
+              - sap/ui/fl/write/
+              - sap/ui/fl/descriptorRelated/api/DescriptorVariantFactory.js
+              - sap/ui/fl/descriptorRelated/api/DescriptorInlineChangeFactory.js
+              - sap/ui/fl/FakeLrepConnectorLocalStorage.js
+              - sap/ui/fl/FakeLrepConnectorSessionStorage.js
+              - sap/ui/fl/FakeLrepLocalStorage.js
+              - sap/ui/fl/FakeLrepConnector.js
+              - sap/ui/fl/util/resolveBinding.js
+            resolve: true
+      bundleOptions:
+        optimize: true
+        usePredefineCalls: true
+    - bundleDefinition:
+        name: sap/ui/fl/library-preload-apply.js
+        sections:
+          - mode: provided
+            filters:
+              - sap/ui/fl/library.js
+              - sap/ui/fl/changeHandler/
+              - ui5loader-autoconfig.js
+              - sap/base/
+              - sap/m/
+              - sap/ui/Device.js
+              - sap/ui/base/
+              - sap/ui/core/
+              - sap/ui/dom/
+              - sap/ui/events/
+              - sap/ui/layout/
+              - sap/ui/model/
+              - sap/ui/performance/
+              - sap/ui/thirdparty/
+              - sap/ui/unified/
+              - sap/ui/util/
+            resolve: true
+          - mode: preload
+            name: sap/ui/fl/library-preload-apply
+            filters:
+              - sap/ui/fl/apply/
+              - sap/ui/fl/transport/TransportDialog.js
+              - sap/ui/fl/transport/TransportSelection.js
+              - sap/ui/fl/util/IFrame.flexibility.js
+            resolve: true
+      bundleOptions:
+        optimize: true
+        usePredefineCalls: true
+    - bundleDefinition:
+        name: sap/ui/fl/library-preload-write.js
+        sections:
+          - mode: provided
+            filters:
+              - sap/ui/fl/library.js
+              - sap/ui/fl/apply/
+              - sap/ui/fl/changeHandler/
+              - ui5loader-autoconfig.js
+              - sap/base/
+              - sap/m/
+              - sap/ui/Device.js
+              - sap/ui/base/
+              - sap/ui/core/
+              - sap/ui/dom/
+              - sap/ui/events/
+              - sap/ui/layout/
+              - sap/ui/model/
+              - sap/ui/performance/
+              - sap/ui/thirdparty/
+              - sap/ui/unified/
+              - sap/ui/util/
+            resolve: true
+          - mode: preload
+            name: sap/ui/fl/library-preload-write
+            filters:
+              - sap/ui/fl/write/
+              - sap/ui/fl/descriptorRelated/api/DescriptorVariantFactory.js
+              - sap/ui/fl/descriptorRelated/api/DescriptorInlineChangeFactory.js
+              - sap/ui/fl/FakeLrepConnectorLocalStorage.js
+              - sap/ui/fl/FakeLrepConnectorSessionStorage.js
+              - sap/ui/fl/FakeLrepLocalStorage.js
+              - sap/ui/fl/FakeLrepConnector.js
+              - sap/ui/fl/util/resolveBinding.js
+            resolve: true
+      bundleOptions:
+        optimize: true
+        usePredefineCalls: true