@openui5/sap.ui.fl 1.120.6 → 1.121.0

package/src/sap/ui/fl/variants/VariantManagement.js

@@ -59,9 +59,10 @@ sap.ui.define([
 			designtime: "sap/ui/fl/designtime/variants/VariantManagement.designtime",
 			properties: {
 				/**
-				 * Determines the intention of setting the current variant based on passed information.
+				 * Indicates whether the current variant is updated based on the passed information in the URL.
 				 * <p>
-				 * <b>Note:</b> The <code>VariantManagement</code> control does not react in any way to this property. It is used internally by the flexibility layer.
+				 * <b>Note:</b> The <code>VariantManagement</code> control itself is not affected by this property.
+				 * It is only used internally by the SAPUI5 flexibility layer.
 				 */
 				updateVariantInURL: {
 					type: "boolean",
@@ -69,9 +70,11 @@ sap.ui.define([
 					defaultValue: false
 				},
 				/**
-				 * When set to <code>false</code>, doesn't reset the <code>VariantManagement</code> control to the default variant, when its binding context is changed.
+				 * If set to <code>false</code>, it does not reset the <code>VariantManagement</code> control to the default variant
+				 * if its binding context is changed.
 				 * <p>
-				 * <b>Note:</b> The <code>VariantManagement</code> control does not react in any way to this property. It is used internally by the flexibility layer.
+				 * <b>Note:</b> The <code>VariantManagement</code> control itself is not affected by this property.
+				 * It is only used internally by the SAPUI5 flexibility layer.
 				 */
 				resetOnContextChange: {
 					type: "boolean",
@@ -87,7 +90,7 @@ sap.ui.define([
 					defaultValue: ""
 				},
 				/**
-				 * Indicated if the buttons on the 'My Views' are visible.
+				 * Indicates whether the buttons on My Views are visible.
 				 */
 				editable: {
 					type: "boolean",
@@ -95,7 +98,8 @@ sap.ui.define([
 					defaultValue: true
 				},
 				/**
-				 * Indicated if the defaulting functionality is enabled.
+				 * Indicates whether the functionality of setting a default variant is enabled.
+				 * The Default column in Manage Views and the Set as Default checkbox in Save View will be disabled if set to <code>false</code>.
 				 */
 				showSetAsDefault: {
 					type: "boolean",
@@ -104,7 +108,8 @@ sap.ui.define([
 				},
 
 				/**
-				 * Indicates that the control is in error state. If set to <code>true</code>, an error message will be displayed whenever the variant is opened.
+				 * Indicates whether the control is in error state.
+				 * If set to <code>true</code>, an error message will be displayed when the variant is opened.
 				 */
 				inErrorState: {
 					type: "boolean",
@@ -114,7 +119,6 @@ sap.ui.define([
 
 				/**
 				 * Determines the behavior for Apply Automatically if the standard variant is marked as the default variant.
-				 *
 				 */
 				executeOnSelectionForStandardDefault: {
 					type: "boolean",
@@ -123,9 +127,10 @@ sap.ui.define([
 				},
 
 				/**
-				 * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application controls this behavior.
+				 * Defines the Apply Automatically text for the standard variant in the Manage Views dialog
+				 * if the application controls this behavior.
 				 * <p>
-				 * <b>Note:</b> the usage of this property is restricted to <code>sap.fe</code> components only.
+				 * <b>Note:</b> The usage of this property is restricted to <code>sap.fe</code> components only.
 				 */
 				displayTextForExecuteOnSelectionForStandardVariant: {
 					type: "string",
@@ -175,7 +180,7 @@ sap.ui.define([
 				initialized: {},
 
 				/**
-				 * This event is fired when the <i>Save View</i> dialog or the <i>Save As</i> dialog is closed with the save button.
+				 * This event is fired when the Save View dialog or the Save As dialog is closed with the Save button.
 				 */
 				save: {
 					parameters: {
@@ -187,28 +192,28 @@ sap.ui.define([
 						},
 
 						/**
-						 * Indicates if an existing variant is overwritten or if a new variant is created.
+						 * Indicates whether an existing variant is overwritten or whether a new variant is created
 						 */
 						overwrite: {
 							type: "boolean"
 						},
 
 						/**
-						 * Variant key
+						 * Variant key. This property is set if <code>overwrite</code> is set to <code>true</code>.
 						 */
 						key: {
 							type: "string"
 						},
 
 						/**
-						 * <i>Apply Automatically</i> indicator
+						 * Apply Automatically indicator
 						 */
 						execute: {
 							type: "boolean"
 						},
 
 						/**
-						 * Indicates the check box state for 'Public'.
+						 * Indicates the checkbox state for Public
 						 */
 						"public": {
 							type: "boolean"
@@ -222,8 +227,16 @@ sap.ui.define([
 						},
 
 						/**
-						 * Indicates the check box state for 'Create Tile'.
-						 * <br>Note:</br>This event parameter is used only internally.
+						 * Array describing the contexts.
+						 * <b>Note:</b> It is only used internally by the SAPUI5 flexibility layer.
+						 */
+						contexts: {
+							type: "object[]"
+						},
+
+						/**
+						 * Indicates the checkbox state for Create Tile
+						 * <b>Note:</b> This event parameter is used only internally.
 						 */
 						tile: {
 							type: "boolean"
@@ -232,18 +245,19 @@ sap.ui.define([
 				},
 
 				/**
-				 * This event is fired when users presses the cancel button inside <i>Save As</i> dialog.
+				 * This event is fired when users press the Cancel button inside the Save As dialog.
 				 */
 				cancel: {},
 
 				/**
-				 * This event is fired when users apply changes to variants in the <i>Manage Views</i> dialog.
+				 * This event is fired when users apply changes to variants in the Manage Views dialog.
 				 */
 
 				manage: {
 					parameters: {
 						/**
-						 * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title of the variant
+						 * List of changed variants.
+						 * Each entry contains a <code>key</code> (the variant key)  and a <code>name</code> (the new title of the variant).
 						 */
 						renamed: {
 							type: "object[]"
@@ -257,17 +271,35 @@ sap.ui.define([
 						},
 
 						/**
-						 * List of variant keys and the associated Execute on Selection indicator
+						 * List of variant keys and the associated Execute on Selection indicator.
+						 * Each entry contains a <code>key</code> (the variant key) and an <code>exe</code> flag describing the intention.
 						 */
 						exe: {
 							type: "object[]"
 						},
 
+						/**
+						 * List of variant keys and the associated favorite indicator.
+						 * Each entry contains a <code>key</code> (the variant key) and a <code>visible</code> flag describing the intention.
+						 */
+						fav: {
+							type: "object[]"
+						},
+
 						/**
 						 * The default variant key
 						 */
 						def: {
 							type: "string"
+						},
+
+						/**
+						 * List of variant keys and the associated contexts array.
+						 * Each entry contains a <code>key</code> (the variant key) and a <code>contexts</code> array describing the contexts.
+						 * <b>Note:</b> It is only used internally by the SAPUI5 flexibility layer.
+						 */
+						contexts: {
+							type: "object[]"
 						}
 					}
 				},
@@ -289,7 +321,7 @@ sap.ui.define([
 			associations: {
 
 				/**
-				 * Contains the ids of the controls for which the variant management is responsible.
+				 * Contains the IDs of the relevant controls for which the variant management is used.
 				 */
 				"for": {
 					type: "sap.ui.core.Control",
@@ -298,7 +330,7 @@ sap.ui.define([
 			},
 			aggregations: {
 				/**
-				 * Used for embedded vm
+				 * Used for embedded variant managment.
 				 */
 				_embeddedVM: {
 					type: "sap.m.VariantManagement",
@@ -319,7 +351,7 @@ sap.ui.define([
 		}
 	});
 
-	/*
+	/**
 	 * Constructs and initializes the <code>VariantManagement</code> control.
 	 */
 	VariantManagement.prototype.init = function() {
@@ -349,11 +381,11 @@ sap.ui.define([
 	};
 
 	/**
-	 * Required by the {@link sap.m.IOverflowToolbarContent} interface.
-	 * Registers invalidations event which is fired when width of the control is changed.
+	 * Registers an invalidation event that is fired when the width of the control is changed.
+	 * <b>Note:</b> This is required by the {@link sap.m.IOverflowToolbarContent} interface.
 	 *
 	 * @protected
-	 * @returns {{canOverflow: boolean, invalidationEvents: string[]}} Configuration information for the <code>sap.m.IOverflowToolbarContent</code> interface.
+	 * @returns {{canOverflow: boolean, invalidationEvents: string[]}} Configuration information for the {@link sap.m.IOverflowToolbarContent} interface
 	 */
 	VariantManagement.prototype.getOverflowToolbarConfig = function() {
 		return {
@@ -396,6 +428,7 @@ sap.ui.define([
 	VariantManagement.prototype.fireManage = function(oEvent) {
 		this._oVM.fireManage(oEvent);
 	};
+
 	VariantManagement.prototype.fireSave = function(oEvent) {
 		this._oVM.fireSave(oEvent);
 	};
@@ -592,13 +625,14 @@ sap.ui.define([
 	// / </EVENT FORWARDING>
 
 	// /<OVERWRITES>
-
 	VariantManagement.prototype._createSaveAsDialog = function() {
 		this._oVM._createSaveAsDialog();
 	};
+
 	VariantManagement.prototype._handleVariantSaveAs = function(sNewVariantName) {
 		this._oVM._handleVariantSaveAs(sNewVariantName);
 	};
+
 	VariantManagement.prototype.getFocusDomRef = function() {
 		if (this._oVM) {
 			return this._oVM.oVariantPopoverTrigger.getFocusDomRef();
@@ -616,13 +650,14 @@ sap.ui.define([
 	};
 
 	/**
-	 * Retrieves all variants.
+	 * Gets all variants.
 	 * @public
-	 * @returns {array} All variants. In case the model is not yet set, an empty array will be returned.
+	 * @returns {Array} All variants; if the model is not yet set, an empty array will be returned.
 	 */
 	VariantManagement.prototype.getVariants = function() {
 		return this._oVM ? this._oVM.getItems() : [];
 	};
+
 	VariantManagement.prototype.getVariantByKey = function(sKey) {
 		return this._oVM ? this._oVM._getItemByKey(sKey) : null;
 	};
@@ -654,8 +689,8 @@ sap.ui.define([
 
 	/**
  	 * Special handling of the rendering of this control.
-	 * @param {boolean} bValue defines the intended rendering
-	 * @returns {sap.ui.fl.variants.VariantManagement} the current instance
+	 * @param {boolean} bValue Defines the intended rendering
+	 * @returns {sap.ui.fl.variants.VariantManagement} The current instance
 	 * @private
 	 * @restricted sap.ui.mdc
  	 */
@@ -666,7 +701,7 @@ sap.ui.define([
 
 	/**
  	 * Special handling of the rendering of this control.
-	 * @returns {boolean} the current intend
+	 * @returns {boolean} The current intent
 	 * @private
 	 * @restricted sap.ui.mdc
  	 */
@@ -724,16 +759,16 @@ sap.ui.define([
 	/**
 	 * Sets the new selected variant.
 	 * @public
-	 * @param {string} sKey - Key of the variant that should be selected.
+	 * @param {string} sKey Key of the variant that is selected
 	 */
 	VariantManagement.prototype.setCurrentVariantKey = function(sKey) {
-		this._oVM.setSelectedKey(sKey);
+		this._oVM.setCurrentVariantKey(sKey);
 	};
 
 	/**
 	 * Gets the currently selected variant key.
 	 * @public
-	 * @returns {string|null} Key of the currently selected variant. In case the model is not yet set <code>null</code> will be returned.
+	 * @returns {string|null} Key of the currently selected variant. In case the model is not yet set <code>null</code> will be returned
 	 */
 	VariantManagement.prototype.getCurrentVariantKey = function() {
 		return this._oVM.getSelectedKey();
@@ -748,15 +783,16 @@ sap.ui.define([
 	};
 
 	/**
-	 * Indicates the design mode was entered.
+	 * Indicates that the design mode was entered.
 	 * @private
 	 * @ui5-restricted sap.ui.fl, sap.ui.rta
 	 */
 	VariantManagement.prototype.enteringDesignMode = function() {
 		this._oVM.setDesignMode(true);
 	};
+
 	/**
-	 * Indicates the design mode was left.
+	 * Indicates that the design mode was left.
 	 * @private
 	 * @ui5-restricted sap.ui.fl, sap.ui.rta
 	 */
@@ -765,9 +801,9 @@ sap.ui.define([
 	};
 
 	/**
-	 * Determines if the current variant is modified.
+	 * Determines whether the current variant is modified.
 	 * @public
-	 * @returns {boolean} If the current variant is modified <code>true</code>, otherwise <code>false</code>
+	 * @returns {boolean} Returns <code>true</code>, if the current variant is modified, otherwise <code>false</code>
 	 */
 	VariantManagement.prototype.getModified = function() {
 		return this._oVM.getModified();
@@ -780,6 +816,7 @@ sap.ui.define([
 	VariantManagement.prototype.getStandardVariantKey = function() {
 		return this._oVM.getStandardVariantKey();
 	};
+
 	// / </OVERWRITES>
 
 	VariantManagement.prototype._getEmbeddedVM = function() {
@@ -951,13 +988,15 @@ sap.ui.define([
 	};
 
 	/**
-	 * Registration of a callback function. The provided callback function is executed to check if apply automatically on standard variant should be considered.
+	 * Registration of a callback function.
+	 * The provided callback function is executed to check if Apply Automatically on standard variant should be considered.
 	 * @private
 	 * @ui5-restricted sap.fe
 	 * @since 1.103
-	 * @param {function} fCallBack Called when standard variant must be applied. It determines if apply automatically on standard variant should be considered.
-	 * As a convenience the current variant will be passed to the callback. This variant instance may not be changed in any ways. It is only intended to provide certain variant information.
-	 * @returns {this} Reference to this in order to allow method chaining.
+	 * @param {function} fCallBack Called when standard variant must be applied. It determines if Apply Automatically on standard variant should be considered.
+	 * As a convenience the current variant will be passed to the callback.
+	 * This variant instance may not be changed in any ways. It is only intended to provide certain variant information.
+	 * @returns {this} Reference to this in order to allow method chaining
 	 */
 	VariantManagement.prototype.registerApplyAutomaticallyOnStandardVariant = function(fCallBack) {
 		this._fRegisteredApplyAutomaticallyOnStandardVariant = fCallBack;
@@ -966,11 +1005,11 @@ sap.ui.define([
 	};
 
 	/**
-	 * Retrieves the apply automatically state for a variant.
+	 * Gets the Apply Automatically state for a variant.
 	 * @private
 	 * @ui5-restricted sap.ui.mdc
-	 * @param {object} oVariant the fl-variant object
-	 * @returns {boolean} apply automatically state
+	 * @param {object} oVariant The fl-variant object
+	 * @returns {boolean} Apply Automatically state
 	 */
 	VariantManagement.prototype.getApplyAutomaticallyOnVariant = function(oVariant) {
 		var bExecuteOnSelection = false;
@@ -1023,9 +1062,9 @@ sap.ui.define([
 
 	/**
 	 * Required by the {@link sap.m.IToolbarInteractiveControl} interface.
-	 * Determines if the Control is interactive.
+	 * Determines whether the control is interactive.
 	 *
-	 * @returns {boolean} If it is an interactive Control
+	 * @returns {boolean} Indicates whether the control is interactive
 	 *
 	 * @private
 	 * @ui5-restricted sap.m.OverflowToolBar, sap.m.Toolbar

package/src/sap/ui/fl/variants/VariantModel.js

@@ -8,7 +8,6 @@ sap.ui.define([
 	"sap/base/util/restricted/_omit",
 	"sap/base/util/restricted/_isEqual",
 	"sap/base/util/each",
-	"sap/base/util/includes",
 	"sap/base/util/isEmptyObject",
 	"sap/base/util/merge",
 	"sap/base/util/ObjectPath",
@@ -21,6 +20,8 @@ sap.ui.define([
 	"sap/ui/fl/apply/_internal/changes/Reverter",
 	"sap/ui/fl/apply/_internal/controlVariants/URLHandler",
 	"sap/ui/fl/apply/_internal/flexObjects/FlexObjectFactory",
+	"sap/ui/fl/apply/_internal/flexState/changes/DependencyHandler",
+	"sap/ui/fl/apply/_internal/flexState/changes/UIChangesState",
 	"sap/ui/fl/apply/_internal/flexState/controlVariants/Switcher",
 	"sap/ui/fl/apply/_internal/flexState/controlVariants/VariantManagementState",
 	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
@@ -36,7 +37,6 @@ sap.ui.define([
 	_omit,
 	_isEqual,
 	each,
-	includes,
 	isEmptyObject,
 	merge,
 	ObjectPath,
@@ -49,6 +49,8 @@ sap.ui.define([
 	Reverter,
 	URLHandler,
 	FlexObjectFactory,
+	DependencyHandler,
+	UIChangesState,
 	Switcher,
 	VariantManagementState,
 	ManifestUtils,
@@ -250,20 +252,21 @@ sap.ui.define([
 			var aServicePromises = [
 				Utils.getUShellService("UserInfo"),
 				Utils.getUShellService("URLParsing"),
-				Utils.getUShellService("CrossApplicationNavigation"),
+				Utils.getUShellService("Navigation"),
 				Utils.getUShellService("ShellNavigation")
 			];
 			return Promise.all(aServicePromises)
 			.then(function(aServices) {
 				setUShellService("UserInfo", aServices[0]);
 				setUShellService("URLParsing", aServices[1]);
-				setUShellService("CrossApplicationNavigation", aServices[2]);
+				setUShellService("Navigation", aServices[2]);
 				setUShellService("ShellNavigation", aServices[3]);
 			})
 			.catch(function(vError) {
 				throw new Error(`Error getting service from Unified Shell: ${vError}`);
 			});
 		}
+		return undefined;
 	}
 
 	function getVariant(aVariants, sVariantKey) {
@@ -287,7 +290,7 @@ sap.ui.define([
 	 * @class Variant model implementation for JSON format.
 	 * @extends sap.ui.model.json.JSONModel
 	 * @author SAP SE
-	 * @version 1.120.6
+	 * @version 1.121.0
 	 * @param {object} oData - Either the URL where to load the JSON from or a JS object
 	 * @param {object} mPropertyBag - Map of properties required for the constructor
 	 * @param {sap.ui.fl.FlexController} mPropertyBag.flexController - <code>FlexController</code> instance for the component which uses the variant model
@@ -329,6 +332,15 @@ sap.ui.define([
 			// Initialize data
 			this.updateData();
 
+			const oLiveDependencyMap = UIChangesState.getLiveDependencyMap(this.sFlexReference);
+			VariantManagementState.getInitialChanges(
+				{reference: this.sFlexReference},
+				this.oAppComponent.getId(),
+				this.sFlexReference
+			).forEach((oFlexObject) => {
+				DependencyHandler.addChangeAndUpdateDependencies(oFlexObject, this.oAppComponent.getId(), oLiveDependencyMap);
+			});
+
 			this.setDefaultBindingMode(BindingMode.OneWay);
 		}
 	});
@@ -356,6 +368,7 @@ sap.ui.define([
 			oCurrentData[sVariantManagementKey].modified = oVariantMapEntry.modified;
 		});
 		this.setData(oCurrentData);
+
 		// Since the model has an one-way binding, some VariantItem properties that were overridden
 		// via direct setter calls need to be updated explicitly
 		this.refresh(true);
@@ -1465,7 +1478,7 @@ sap.ui.define([
 		});
 
 		return this.oChangePersistence.getDirtyChanges().filter(function(oChange) {
-			return includes(aChangeFileNames, oChange.getId()) && !oChange.getSavedToVariant();
+			return aChangeFileNames.includes(oChange.getId()) && !oChange.getSavedToVariant();
 		});
 	};
 

package/src/sap/ui/fl/write/_internal/Storage.js

@@ -8,13 +8,11 @@ sap.ui.define([
 	"sap/base/util/ObjectPath",
 	"sap/ui/fl/apply/_internal/flexObjects/States",
 	"sap/ui/fl/initial/_internal/StorageUtils",
-	"sap/ui/fl/write/_internal/StorageFeaturesMerger",
 	"sap/ui/VersionInfo"
 ], function(
 	ObjectPath,
 	States,
 	StorageUtils,
-	StorageFeaturesMerger,
 	VersionInfo
 ) {
 	"use strict";
@@ -24,7 +22,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.write._internal.Storage
 	 * @since 1.67
-	 * @version 1.120.6
+	 * @version 1.121.0
 	 * @private
 	 * @ui5-restricted sap.ui.fl
 	 */
@@ -60,24 +58,6 @@ sap.ui.define([
 		return undefined;
 	}
 
-	function _sendLoadFeaturesToConnector(aConnectors) {
-		var aConnectorPromises = aConnectors.map(function(oConnectorConfig) {
-			return oConnectorConfig.writeConnectorModule.loadFeatures({url: oConnectorConfig.url})
-			.then(function(oFeatures) {
-				return {
-					features: oFeatures,
-					layers: oConnectorConfig.layers
-				};
-			})
-			.catch(StorageUtils.logAndResolveDefault.bind(null, {
-				features: {},
-				layers: oConnectorConfig.layers
-			}, oConnectorConfig, "loadFeatures"));
-		});
-
-		return Promise.all(aConnectorPromises);
-	}
-
 	/**
 	 * Determines the connector in charge for a given layer.
 	 *
@@ -127,6 +107,7 @@ sap.ui.define([
 
 	async function prepareCondensingForConnector(mPropertyBag) {
 		var mCondense;
+
 		if (
 			mPropertyBag.allChanges
 			&& mPropertyBag.allChanges.length
@@ -140,6 +121,7 @@ sap.ui.define([
 
 			var iOffset = 0;
 			var bAlreadyReordered = false;
+			mPropertyBag.reference ||= mPropertyBag.allChanges[0].convertToFileContent().reference;
 			mPropertyBag.allChanges.forEach(function(oChange, index) {
 				var sFileType = oChange.getFileType();
 				var iChangeCreateIndex = findChangeCreateIndex(oChange, mPropertyBag.condensedChanges);
@@ -389,17 +371,6 @@ sap.ui.define([
 		return _executeActionByName("isContextSharingEnabled", mPropertyBag);
 	};
 
-	/**
-	 * Provides the information which features are provided based on the responses of the involved connectors.
-	 *
-	 * @returns {Promise<Object>} Map feature flags and additional provided information from the connectors
-	 */
-	Storage.loadFeatures = function() {
-		return _getWriteConnectors()
-		.then(_sendLoadFeaturesToConnector)
-		.then(StorageFeaturesMerger.mergeResults);
-	};
-
 	/**
 	 * Transports all the UI changes and app variant descriptor (if exists) to the target system.
 	 *
@@ -516,8 +487,8 @@ sap.ui.define([
 		 *
 		 * @param {object} mPropertyBag - Property bag
 		 * @param {sap.ui.fl.Layer} mPropertyBag.layer - Layer
-		 * @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
+		 * @param {string} mPropertyBag.sourceLanguage - Source language for which the request should be made
+		 * @param {string} mPropertyBag.targetLanguage - Target language for which the request should be made
 		 * @param {string} mPropertyBag.reference - Flexibility reference
 		 * @returns {Promise} Resolving after the languages are retrieved;
 		 * rejects if an error occurs