@openui5/sap.ui.fl 1.112.2 → 1.113.0

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

@@ -5,12 +5,14 @@
  */
 
 sap.ui.define([
+	"sap/ui/fl/registry/Settings",
 	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
 	"sap/ui/fl/Utils",
 	"sap/ui/fl/write/_internal/Storage",
 	"sap/ui/fl/write/_internal/Versions",
 	"sap/ui/model/json/JSONModel"
 ], function (
+	Settings,
 	ManifestUtils,
 	FlexUtils,
 	Storage,
@@ -19,6 +21,8 @@ sap.ui.define([
 ) {
 	"use strict";
 
+	var _mInstances = {};
+
 	/**
 	 * Provides an API for creating and managing context-based adaptation.
 	 *
@@ -59,14 +63,122 @@ sap.ui.define([
 		return oResponse;
 	}
 
+	/**
+	 * Initializes the context-based adaptations for a given control and layer
+	 * @param {object} mPropertyBag - Object with parameters as properties
+	 * @param {sap.ui.core.Control} mPropertyBag.control - Control for which the request is done
+	 * @param {string} mPropertyBag.layer - Layer
+	 * @returns {sap.ui.model.json.JSONModel} - Model of adaptations enhanced with additional properties
+	 */
+	ContextBasedAdaptationsAPI.initialize = function (mPropertyBag) {
+		if (!mPropertyBag.layer) {
+			return Promise.reject("No layer was provided");
+		}
+		if (!mPropertyBag.control) {
+			return Promise.reject("No control was provided");
+		}
+		var sReference = getFlexReferenceForControl(mPropertyBag.control);
+		mPropertyBag.reference = sReference;
+		var sLayer = mPropertyBag.layer;
+		return Settings.getInstance()
+			.then(function(oSettings) {
+				var bContextBasedAdaptationsEnabled = oSettings.isContextBasedAdaptationEnabled();
+				var oAdaptationsPromise = bContextBasedAdaptationsEnabled ? ContextBasedAdaptationsAPI.load(mPropertyBag) : Promise.resolve({adaptations: []});
+				return oAdaptationsPromise;
+			})
+			.then(function(oAdaptations) {
+				return ContextBasedAdaptationsAPI.createModel(oAdaptations.adaptations);
+			})
+			.then(function(oModel) {
+				_mInstances[sReference] = _mInstances[sReference] || {};
+				_mInstances[sReference][sLayer] = _mInstances[sReference][sLayer] || {};
+				_mInstances[sReference][sLayer] = oModel;
+				return _mInstances[sReference][sLayer];
+			});
+	};
+
+	/**
+	 * Initializes and creates an new adaptation Model
+	 * @param {string[]} aAdaptations - List of adaptations from backend
+	 * @returns {sap.ui.model.json.JSONModel} - Model of adaptations enhanced with additional properties
+	 */
+	ContextBasedAdaptationsAPI.createModel = function(aAdaptations) {
+		if (!Array.isArray(aAdaptations)) {
+			throw Error("Adaptations model can only be initialized with an array of adaptations");
+		}
+		var oModel = new JSONModel({
+			adaptations: aAdaptations,
+			count: aAdaptations.length,
+			displayedAdaptation: aAdaptations.length > 0 ? aAdaptations[0] : {}
+		});
+		oModel.updateAdaptations = function(aAdaptations) {
+			oModel.setProperty("/adaptations", aAdaptations);
+			oModel.setProperty("/count", aAdaptations.length);
+			if (aAdaptations.length > 0) {
+				var oDisplayedAdaptation = oModel.getProperty("/adaptations/0/"); //TODO: might be changed in future
+				oModel.setProperty("/displayedAdaptation", oDisplayedAdaptation);
+			}
+			oModel.updateBindings(true);
+		};
+		oModel.insertAdaptation = function(oNewAdaptation) {
+			aAdaptations = oModel.getProperty("/adaptations");
+			aAdaptations.splice(oNewAdaptation.priority, 0, oNewAdaptation);
+			delete oNewAdaptation.priority;
+			oModel.updateAdaptations(aAdaptations);
+		};
+		return oModel;
+	};
+
+	/**
+	 * Returns adaptations model given reference id and layer.
+	 * @param {object} mPropertyBag - Object with parameters as properties
+	 * @param {sap.ui.core.Control} mPropertyBag.control - Control for which the request is done
+	 * @param {string} mPropertyBag.layer - Layer
+	 * @returns {sap.ui.model.json.JSONModel} - Model of adaptations enhanced with additional properties
+	 */
+	ContextBasedAdaptationsAPI.getAdaptationsModel = function(mPropertyBag) {
+		if (!mPropertyBag.layer) {
+			throw Error("No layer was provided");
+		}
+		if (!mPropertyBag.control) {
+			throw Error("No control was provided");
+		}
+		mPropertyBag.reference = getFlexReferenceForControl(mPropertyBag.control);
+		var sReference = mPropertyBag.reference;
+		var sLayer = mPropertyBag.layer;
+		if (!ContextBasedAdaptationsAPI.hasAdaptationsModel(mPropertyBag)) {
+			throw Error("Adaptations model for reference '" + sReference + "' and layer '" + sLayer + "' were not initialized.");
+		}
+		return _mInstances[sReference][sLayer];
+	};
+
+	/**
+	 * Checks if adaptations model for a given reference and layer exists.
+	 * @param {object} mPropertyBag - Object with parameters as properties
+	 * @param {string} mPropertyBag.reference - ID of the application for which the versions are requested
+	 * @param {string} mPropertyBag.layer - Layer
+	 * @returns {boolean} checks if an adaptation model exists for this reference and layer
+	 */
+	ContextBasedAdaptationsAPI.hasAdaptationsModel = function(mPropertyBag) {
+		var sReference = mPropertyBag.reference;
+		var sLayer = mPropertyBag.layer;
+		return _mInstances[sReference] && _mInstances[sReference][sLayer];
+	};
+
+	ContextBasedAdaptationsAPI.clearInstances = function() {
+		_mInstances = {};
+	};
+
 	/**
 	 * Create new context-based adaptation and saves it in the backend
 	 * @param {object} mPropertyBag - Object with parameters as properties
 	 * @param {sap.ui.core.Control} mPropertyBag.control - Control for which the request is done
 	 * @param {string} mPropertyBag.layer - Layer
-	 * @param {object} mPropertyBag.contextBasedAdaptation - Parameters
+	 * @param {object} mPropertyBag.contextBasedAdaptation - Parameters for new adaptation
 	 * @param {string} mPropertyBag.contextBasedAdaptation.title - Title of the new adaptation
 	 * @param {object} mPropertyBag.contextBasedAdaptation.contexts - Contexts of the new adaptation, for example roles for which the adaptation is created
+	 * @param {object} mPropertyBag.contextBasedAdaptation.priority - Priority of the new adaptation
+	 * @param {object} mPropertyBag.contextBasedAdaptation.priority - ID of the new adaptation
 	 * @returns {Promise} Promise that resolves with the context-based adaptation
 	 */
 	ContextBasedAdaptationsAPI.create = function (mPropertyBag) {
@@ -87,8 +199,10 @@ sap.ui.define([
 			reference: mPropertyBag.reference,
 			parentVersion: Versions.getVersionsModel({ layer: mPropertyBag.layer, reference: mPropertyBag.reference }).getProperty("/displayedVersion")
 		}).then(function (oResponse) {
+			var oModel = this.getAdaptationsModel(mPropertyBag);
+			oModel.insertAdaptation(mPropertyBag.contextBasedAdaptation);
 			return handleResponseForVersioning(oResponse, 201, mPropertyBag);
-		});
+		}.bind(this));
 	};
 
 	/**
@@ -126,7 +240,7 @@ sap.ui.define([
 	 * @param {object} mPropertyBag - Object with parameters as properties
 	 * @param {sap.ui.core.Control} mPropertyBag.control - Control for which the request is done
 	 * @param {string} mPropertyBag.layer - Layer
-	 * @returns {Promise} Promise that resolves with the list of context-based adaptations
+	 * @returns {Promise<object>} Promise that resolves with the list of context-based adaptations
 	 */
 	ContextBasedAdaptationsAPI.load = function (mPropertyBag) {
 		if (!mPropertyBag.layer) {
@@ -145,7 +259,7 @@ sap.ui.define([
 			if (!oAdaptations) {
 				oAdaptations = { adaptations: [] };
 			}
-			return new JSONModel(oAdaptations);
+			return oAdaptations;
 		});
 	};
 	return ContextBasedAdaptationsAPI;

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

@@ -15,6 +15,7 @@ sap.ui.define([
 	"sap/ui/fl/apply/api/FlexRuntimeInfoAPI",
 	"sap/ui/fl/initial/_internal/changeHandlers/ChangeHandlerStorage",
 	"sap/ui/fl/registry/Settings",
+	"sap/ui/fl/write/api/ChangesWriteAPI",
 	"sap/ui/fl/FlexControllerFactory",
 	"sap/ui/fl/Layer",
 	"sap/ui/fl/Utils"
@@ -29,6 +30,7 @@ sap.ui.define([
 	FlexRuntimeInfoAPI,
 	ChangeHandlerStorage,
 	Settings,
+	ChangesWriteAPI,
 	FlexControllerFactory,
 	Layer,
 	Utils
@@ -99,6 +101,7 @@ sap.ui.define([
 	 * @property {object} changeSpecificData - Map of change-specific data to perform a flex change
 	 * @property {string} changeSpecificData.changeType - Change type for which a change handler is registered
 	 * @property {object} changeSpecificData.content - Content for the change
+	 * @property {boolean} [transient=false] - Transient changes are not persisted
 	 * @since 1.69
 	 * @private
 	 * @ui5-restricted UI5 controls that allow personalization
@@ -113,7 +116,7 @@ sap.ui.define([
 		 * @param {boolean} [mPropertyBag.ignoreVariantManagement=false] - If flag is set to <code>true</code>, the changes will not belong to any variant, otherwise it will be detected if the changes are done in the context of variant mangement
 		 * @param {boolean} [mPropertyBag.useStaticArea=false] - If flag is set to true then the static area is used to determine the variant management control
 		 *
-		 * @returns {Promise} Promise resolving to an array of successfully applied changes, after the changes have been written to the map of dirty changes and applied to the control
+		 * @returns {Promise} Promise resolving to an array of successfully applied changes, after the changes have been written to the map of dirty changes (except transient changes) and applied to the control
 		 * @private
 		 * @ui5-restricted
 		 */
@@ -133,7 +136,7 @@ sap.ui.define([
 			var aSuccessfulChanges = [];
 
 			function createChanges() {
-				var aAddedChanges = [];
+				var aChanges = [];
 				return mPropertyBag.changes.reduce(function(pPromise, oPersonalizationChange) {
 					return pPromise
 						.then(function() {
@@ -141,7 +144,8 @@ sap.ui.define([
 							return checkChangeSpecificData(oPersonalizationChange, sLayer);
 						})
 						.then(function() {
-							if (!mPropertyBag.ignoreVariantManagement) {
+							// 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);
@@ -156,11 +160,18 @@ sap.ui.define([
 							}
 
 							oPersonalizationChange.changeSpecificData = Object.assign(oPersonalizationChange.changeSpecificData, {developerMode: false, layer: sLayer});
-							return oFlexController.addChange(oPersonalizationChange.changeSpecificData, oPersonalizationChange.selectorControl);
+							return ChangesWriteAPI.create({
+								changeSpecificData: oPersonalizationChange.changeSpecificData,
+								selector: oPersonalizationChange.selectorControl
+							});
 						})
-						.then(function(oAddedChange) {
-							aAddedChanges.push({
-								changeInstance: oAddedChange,
+						.then(function(oCreatedChange) {
+							if (!oPersonalizationChange.transient) {
+								oCreatedChange = oFlexController.addPreparedChange(oCreatedChange, oAppComponent);
+							}
+
+							aChanges.push({
+								changeInstance: oCreatedChange,
 								selectorControl: oPersonalizationChange.selectorControl
 							});
 						})
@@ -169,21 +180,30 @@ sap.ui.define([
 						});
 				}, Promise.resolve())
 					.then(function() {
-						return aAddedChanges;
+						return aChanges;
 					});
 			}
 
-			function applyChanges(aAddedChanges) {
-				return aAddedChanges.reduce(function(pPromise, oAddedChange) {
+			function applyChanges(aChanges) {
+				return aChanges.reduce(function(pPromise, oChange) {
 					return pPromise
 						.then(function() {
-							return oFlexController.applyChange(oAddedChange.changeInstance, oAddedChange.selectorControl);
+							oChange.changeInstance.setQueuedForApply();
+							return ChangesWriteAPI.apply({
+								change: oChange.changeInstance,
+								element: oChange.selectorControl
+							});
 						})
-						.then(function(oAppliedChange) {
-							aSuccessfulChanges.push(oAppliedChange);
+						.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) {
-							Log.error("A Change was not applied successfully. Reason:", oError.message);
+							oFlexController.deleteChange(oChange.changeInstance, oAppComponent);
+							Log.error("A Change was not applied successfully. Reason: ", oError.message);
 						});
 				}, Promise.resolve());
 			}

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

@@ -6,10 +6,12 @@
 
 sap.ui.define([
 	"sap/ui/fl/registry/Settings",
-	"sap/ui/fl/Layer"
+	"sap/ui/fl/Layer",
+	"sap/ui/fl/Utils"
 ], function(
 	Settings,
-	Layer
+	Layer,
+	Utils
 ) {
 	"use strict";
 
@@ -50,24 +52,32 @@ sap.ui.define([
 		 * @description App variant functionality is only supported in S/4HANA Cloud Platform & S/4HANA on Premise.
 		 * App variant functionality should be available if the following conditions are met:
 		 * When the current layer is 'CUSTOMER'.
-		 * When it is not a standalone app running on Neo Cloud.
+		 * When it is not a standalone app.
 		 * When the backend supports this feature.
 		 * @private
 	 	 * @ui5-restricted
 		 */
 		isSaveAsAvailable: function (sLayer) {
-			return Settings.getInstance().then(function (oSettings) {
-				if (
+			return Promise.all([
+				Settings.getInstance(),
+				Utils.getUShellService("CrossApplicationNavigation")
+			])
+			.then(function (aPromises) {
+				var oSettings = aPromises[0];
+				var oCrossAppNav = aPromises[1];
+				return (
 					oSettings.isAppVariantSaveAsEnabled()
 					&& sLayer === Layer.CUSTOMER
-					&& sap.ushell_abap /* gravity todo*/ // Not a standalone app
-				) {
-					return true;
-				}
+					&& oCrossAppNav !== undefined // Not a standalone app
+				);
+			})
+			.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
 		 *

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

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

@@ -157,11 +157,13 @@ sap.ui.define([
 		if (!mPropertyBag.layer) {
 			return Promise.reject("No layer was provided");
 		}
-		if (mPropertyBag.version === undefined) {
-			var oModel = getVersionsModel(mPropertyBag);
-			if (oModel) {
+		var oModel = getVersionsModel(mPropertyBag);
+		if (oModel) {
+			if (mPropertyBag.version === undefined) {
 				mPropertyBag.version = oModel.getProperty("/activeVersion");
 			}
+			oModel.setProperty("/displayedVersion", mPropertyBag.version);
+			oModel.setProperty("/persistedVersion", mPropertyBag.version);
 		}
 
 		var oAppComponent = Utils.getAppComponentForControl(mPropertyBag.control);

package/src/sap/ui/fl/write/api/connectors/ObjectStorageConnector.js

@@ -296,7 +296,8 @@ sap.ui.define([
 				isKeyUser: true,
 				isVariantSharingEnabled: true,
 				isProductiveSystem: false,
-				isCondensingEnabled: true
+				isCondensingEnabled: true,
+				isContextSharingEnabled: false
 			});
 		},