@openui5/sap.ui.fl 1.129.0 → 1.130.1

package/src/sap/ui/fl/util/DescriptorChangeCheck.js

@@ -93,10 +93,10 @@ sap.ui.define([
 		return (sKey !== "dataSource") ? aObjectKeys[aObjectKeys.length - 1] : aObjectKeys;
 	}
 
-	function checkChange(oEntityPropertyChange, aSupportedProperties, aSupportedOperations, oSupportedPropertyPattern, aNotAllowedToBeDeleteProperties) {
+	function checkChange(oEntityPropertyChange, aSupportedProperties, aSupportedOperations, oSupportedPropertyPattern, aNotAllowedToBeDeleteProperties, oSupportedPropertyTypes) {
 		const aEntityPropertyChanges = Array.isArray(oEntityPropertyChange) ? oEntityPropertyChange : [oEntityPropertyChange];
 		aEntityPropertyChanges.forEach(function(oChange) {
-			formatEntityCheck(oChange, aSupportedProperties, aSupportedOperations, aNotAllowedToBeDeleteProperties);
+			formatEntityCheck(oChange, aSupportedProperties, aSupportedOperations, aNotAllowedToBeDeleteProperties, oSupportedPropertyTypes);
 			checkPropertyValuePattern(oChange, oSupportedPropertyPattern);
 		});
 	}
@@ -132,13 +132,20 @@ sap.ui.define([
 	 * @returns {boolean} Property Path is supported or is not supported
 	 */
 	function isGenericPropertyPathSupported(aSupportedProperties, sPropertyPath) {
-		var aClearedGenericPath = getClearedGenericPath(aSupportedProperties);
-		return aClearedGenericPath.some(function(path) {
-			return sPropertyPath.startsWith(path);
+		const aClearedGenericPath = getClearedGenericPath(aSupportedProperties);
+		let bIsGenericPathSupported = false;
+		aClearedGenericPath.forEach(function(path) {
+			if (sPropertyPath.startsWith(path)) {
+				const sPathWithoutRoot = sPropertyPath.replace(path, "");
+				if (sPathWithoutRoot.startsWith("/") || sPathWithoutRoot === "") {
+					bIsGenericPathSupported = true;
+				}
+			}
 		});
+		return bIsGenericPathSupported;
 	}
 
-	function formatEntityCheck(oChangeEntity, aSupportedProperties, aSupportedOperations, aNotAllowedToBeDeleteProperties) {
+	function formatEntityCheck(oChangeEntity, aSupportedProperties, aSupportedOperations, aNotAllowedToBeDeleteProperties, oSupportedPropertyTypes) {
 		if (!oChangeEntity.propertyPath) {
 			throw new Error("Invalid change format: The mandatory 'propertyPath' is not defined. Please define the mandatory property 'propertyPath'");
 		}
@@ -147,8 +154,10 @@ sap.ui.define([
 		}
 		const sOpertationUpperCase = oChangeEntity.operation.toUpperCase();
 		if (sOpertationUpperCase === "DELETE") {
-			if (aNotAllowedToBeDeleteProperties.includes(oChangeEntity.propertyPath)) {
-				throw new Error(`The property '${oChangeEntity.propertyPath}' was attempted to be deleted. The mandatory properties ${aNotAllowedToBeDeleteProperties.join("|")} cannot be deleted.`);
+			if (aNotAllowedToBeDeleteProperties) {
+				if (aNotAllowedToBeDeleteProperties.includes(oChangeEntity.propertyPath)) {
+					throw new Error(`The property '${oChangeEntity.propertyPath}' was attempted to be deleted. The mandatory properties ${aNotAllowedToBeDeleteProperties.join("|")} cannot be deleted.`);
+				}
 			}
 			if (oChangeEntity.hasOwnProperty("propertyValue")) {
 				throw new Error(`The property 'propertyValue' must not be provided in a 'DELETE' operation. Please remove 'propertyValue'.`);
@@ -158,10 +167,18 @@ sap.ui.define([
 			if (!oChangeEntity.hasOwnProperty("propertyValue")) {
 				throw new Error("Invalid change format: The mandatory 'propertyValue' is not defined. Please define the mandatory property 'propertyValue'");
 			}
-
 			if (!aSupportedProperties.includes(oChangeEntity.propertyPath) && !isGenericPropertyPathSupported(aSupportedProperties, oChangeEntity.propertyPath)) {
 				throw new Error(`Changing ${oChangeEntity.propertyPath} is not supported. The supported 'propertyPath' is: ${aSupportedProperties.join("|")}`);
 			}
+			if (oSupportedPropertyTypes) {
+				const aPropertyPath = oChangeEntity.propertyPath.split("/");
+				const sProperty = aPropertyPath[aPropertyPath.length - 1];
+				if (oSupportedPropertyTypes[sProperty]) {
+					if (String(typeof oChangeEntity.propertyValue) !== oSupportedPropertyTypes[sProperty]) {
+						throw new Error(`The property '${sProperty}' is type of '${typeof oChangeEntity.propertyValue}'. Supported type for property '${sProperty}' is '${oSupportedPropertyTypes[sProperty]}'.`);
+					}
+				}
+			}
 		}
 		if (!aSupportedOperations.includes(sOpertationUpperCase)) {
 			throw new Error(`Operation ${sOpertationUpperCase} is not supported. The supported 'operation' is ${aSupportedOperations.join("|")}`);
@@ -180,7 +197,7 @@ sap.ui.define([
 	 * @private
 	 * @ui5-restricted sap.ui.fl, sap.suite.ui.generic.template
 	 */
-	function checkEntityPropertyChange(oChange, aSupportedProperties, aSupportedOperations, oSupportedPropertyPattern, aNotAllowedToBeDeleteProperties) {
+	function checkEntityPropertyChange(oChange, aSupportedProperties, aSupportedOperations, oSupportedPropertyPattern, aNotAllowedToBeDeleteProperties, oSupportedPropertyTypes) {
 		var sId = Object.keys(oChange).filter(function(sKey) {
 			return sKey.endsWith("Id");
 		}).shift();
@@ -191,7 +208,7 @@ sap.ui.define([
 			throw new Error(`Changes for "${oChange[sId]}" are not provided.`);
 		}
 
-		checkChange(oChange.entityPropertyChange, aSupportedProperties, aSupportedOperations, oSupportedPropertyPattern, aNotAllowedToBeDeleteProperties);
+		checkChange(oChange.entityPropertyChange, aSupportedProperties, aSupportedOperations, oSupportedPropertyPattern, aNotAllowedToBeDeleteProperties, oSupportedPropertyTypes);
 	}
 
 	var layer_prefixes = {};
@@ -250,11 +267,13 @@ sap.ui.define([
 	 * @ui5-restricted sap.ui.fl, sap.suite.ui.generic.template
 	 */
 	function checkPropertyValuePattern(oChange, oSupportedPattern) {
-		// if no pattern is provided, everything is allowed
-		if (!Object.keys(oSupportedPattern).includes(oChange.propertyPath)) { return; }
-		if (!oChange.propertyValue.match(oSupportedPattern[oChange.propertyPath])) {
-			throw new Error(`Not supported format for propertyPath ${oChange.propertyPath}. ` +
-							`The supported pattern is ${oSupportedPattern[oChange.propertyPath]}`);
+		if (oSupportedPattern) {
+			// if no pattern is provided, everything is allowed
+			if (!Object.keys(oSupportedPattern).includes(oChange.propertyPath)) { return; }
+			if (!oChange.propertyValue.match(oSupportedPattern[oChange.propertyPath])) {
+				throw new Error(`Not supported format for propertyPath ${oChange.propertyPath}. ` +
+								`The supported pattern is ${oSupportedPattern[oChange.propertyPath]}`);
+			}
 		}
 	}
 

package/src/sap/ui/fl/util/IFrame.js

@@ -50,7 +50,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.129.0
+	 * @version 1.130.1
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/fl/util/ManagedObjectModel.js

@@ -25,7 +25,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Element
 	 *
 	 * @author SAP SE
-	 * @version 1.129.0
+	 * @version 1.130.1
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/fl/util/resolveBinding.js

@@ -34,7 +34,7 @@ sap.ui.define([
 	 *
 	 * @function
 	 * @author SAP SE
-	 * @version 1.129.0
+	 * @version 1.130.1
 	 * @alias sap.ui.fl.util.resolveBinding
 	 * @since 1.91
 	 * @private

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

@@ -29,6 +29,7 @@ sap.ui.define([
 	"sap/ui/fl/registry/Settings",
 	"sap/ui/fl/write/_internal/flexState/changes/UIChangeManager",
 	"sap/ui/fl/write/_internal/flexState/FlexObjectManager",
+	"sap/ui/fl/write/_internal/controlVariants/ControlVariantWriteUtils",
 	"sap/ui/fl/write/api/ContextBasedAdaptationsAPI",
 	"sap/ui/fl/Layer",
 	"sap/ui/fl/LayerUtils",
@@ -60,6 +61,7 @@ sap.ui.define([
 	Settings,
 	UIChangeManager,
 	FlexObjectManager,
+	ControlVariantWriteUtils,
 	ContextBasedAdaptationsAPI,
 	Layer,
 	LayerUtils,
@@ -313,7 +315,7 @@ sap.ui.define([
 	 * @class Variant model implementation for JSON format.
 	 * @extends sap.ui.model.json.JSONModel
 	 * @author SAP SE
-	 * @version 1.129.0
+	 * @version 1.130.1
 	 * @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
@@ -821,6 +823,7 @@ sap.ui.define([
 		const aModelVariants = oData.variants;
 		const aChanges = [];
 		const oSettings = Settings.getInstanceOrUndef();
+		const aVariantsToBeDeleted = [];
 
 		const findVariant = (sVariantKey) => {
 			return aModelVariants.find((oModelVariant) => oModelVariant.key === sVariantKey);
@@ -885,6 +888,7 @@ sap.ui.define([
 					visible: false
 				}
 			);
+			aVariantsToBeDeleted.push(sVariantKey);
 		});
 		oEvent.getParameter("contexts")?.forEach(({key: sVariantKey, contexts: aNewContexts}) => {
 			const oVariant = findVariant(sVariantKey);
@@ -908,7 +912,10 @@ sap.ui.define([
 			});
 		}
 
-		return aChanges;
+		return {
+			changes: aChanges,
+			variantsToBeDeleted: aVariantsToBeDeleted
+		};
 	};
 
 	/**
@@ -1204,33 +1211,48 @@ sap.ui.define([
 
 	VariantModel.prototype._initializeManageVariantsEvents = function() {
 		this.fnManageClickRta = function(oEvent, oData) {
-			var aConfiguredChanges = this._collectModelChanges(oData.variantManagementReference, oData.layer, oEvent);
-			oData.resolve(aConfiguredChanges);
+			const oModelChanges = this._collectModelChanges(oData.variantManagementReference, oData.layer, oEvent);
+			oData.resolve(oModelChanges);
 		};
 
 		this.fnManageClick = function(oEvent, oData) {
 			(async () => {
+				const sVMReference = oData.variantManagementReference;
 				if (!this.oFlexController || !this.getData()) {
 					return;
 				}
-				var aConfigurationChangesContent = this._collectModelChanges(oData.variantManagementReference, Layer.USER, oEvent);
+				const {
+					changes: aConfigurationChangesContent,
+					variantsToBeDeleted: aVariantsToBeDeleted
+				} = this._collectModelChanges(sVMReference, Layer.USER, oEvent);
 
 				if (aConfigurationChangesContent.some((oChange) => {
 					return oChange.visible === false
-					&& oChange.variantReference === this.getCurrentVariantReference(oData.variantManagementReference);
+					&& oChange.variantReference === this.getCurrentVariantReference(sVMReference);
 				})) {
 					await this.updateCurrentVariant({
-						variantManagementReference: oData.variantManagementReference,
-						newVariantReference: oData.variantManagementReference
+						variantManagementReference: sVMReference,
+						newVariantReference: sVMReference
 					});
 				}
 
-				var aChanges = [];
 				aConfigurationChangesContent.forEach(function(oChangeProperties) {
 					oChangeProperties.appComponent = this.oAppComponent;
 				}.bind(this));
-				aChanges = aChanges.concat(this.addVariantChanges(oData.variantManagementReference, aConfigurationChangesContent));
-				this.oChangePersistence.saveDirtyChanges(this.oAppComponent, false, aChanges);
+
+				this.addVariantChanges(sVMReference, aConfigurationChangesContent);
+				aVariantsToBeDeleted
+				.forEach((sVariantKey) => {
+					const oVariant = VariantManagementState.getVariant({
+						reference: this.sFlexReference,
+						vmReference: sVMReference,
+						vReference: sVariantKey
+					});
+					if (oVariant.layer === Layer.USER) {
+						ControlVariantWriteUtils.deleteVariant(this.sFlexReference, sVMReference, sVariantKey);
+					}
+				});
+				this.oChangePersistence.saveDirtyChanges(this.oAppComponent, false);
 			})();
 		};
 	};

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

@@ -22,7 +22,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.write._internal.Storage
 	 * @since 1.67
-	 * @version 1.129.0
+	 * @version 1.130.1
 	 * @private
 	 * @ui5-restricted sap.ui.fl
 	 */

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

@@ -159,7 +159,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.write._internal.Versions
 	 * @since 1.74
-	 * @version 1.129.0
+	 * @version 1.130.1
 	 * @private
 	 * @ui5-restricted sap.ui.fl
 	 */
@@ -323,6 +323,7 @@ sap.ui.define([
 	 * @param {object} mPropertyBag - Property Bag
 	 * @param {string} mPropertyBag.reference - ID of the application for which the versions are requested (this reference must not contain the ".Component" suffix)
 	 * @param {string} mPropertyBag.layer - Layer for which the versions should be retrieved
+	 * @param {boolean} [mPropertyBag.discardDraftAndKeepActiveVersion] - discard draft and keep active version
 	 * @returns {Promise<object>} Promise resolving to an object to indicate if a discarding took place on backend side and/or dirty changes were discarded;
 	 * rejects if an error occurs or the layer does not support draft handling
 	 */
@@ -334,8 +335,11 @@ sap.ui.define([
 		return oDiscardPromise.then(function() {
 			var aVersions = oModel.getProperty("/versions");
 			aVersions.shift();
-			_updateVersionModelWhenDiscardOrActivate(oModel, oModel.getProperty("/activeVersion"));
-
+			let sDisplayedVersion = oModel.getProperty("/activeVersion");
+			if (mPropertyBag.discardDraftAndKeepActiveVersion) {
+				sDisplayedVersion = oModel.getProperty("/displayedVersion");
+			}
+			_updateVersionModelWhenDiscardOrActivate(oModel, sDisplayedVersion);
 			return {
 				backendChangesDiscarded: bBackendDraftExists
 			};

package/src/sap/ui/fl/write/_internal/appVariant/AppVariant.js

@@ -35,7 +35,7 @@ sap.ui.define([
 	 * @constructor
 	 * @alias sap.ui.fl.write._internal.appVariant.AppVariant
 	 * @author SAP SE
-	 * @version 1.129.0
+	 * @version 1.130.1
 	 * @private
 	 * @ui5-restricted sap.ui.rta, smart business
 	 */

package/src/sap/ui/fl/write/_internal/appVariant/AppVariantFactory.js

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * @namespace
 	 * @alias sap.ui.fl.write._internal.appVariant.AppVariantFactory
 	 * @author SAP SE
-	 * @version 1.129.0
+	 * @version 1.130.1
 	 * @private
 	 * @ui5-restricted sap.ui.rta, smart business
 	 */

package/src/sap/ui/fl/write/_internal/appVariant/AppVariantInlineChange.js

@@ -28,7 +28,7 @@ sap.ui.define([
 	 * @constructor
 	 * @alias sap.ui.fl.write._internal.appVariant.AppVariantInlineChange
 	 * @author SAP SE
-	 * @version 1.129.0
+	 * @version 1.130.1
 	 * @private
 	 * @ui5-restricted sap.ui.rta, smart business
 	 */

package/src/sap/ui/fl/write/_internal/appVariant/AppVariantInlineChangeFactory.js

@@ -33,7 +33,7 @@ sap.ui.define([
 	 * @namespace
 	 * @alias sap.ui.fl.write._internal.appVariant.AppVariantInlineChangeFactory
 	 * @author SAP SE
-	 * @version 1.129.0
+	 * @version 1.130.1
 	 * @private
 	 * @ui5-restricted sap.ui.rta, smart business
 	 */
@@ -988,6 +988,39 @@ sap.ui.define([
 		return _createAppVariantInlineChange(mPropertyBag);
 	};
 
+	/**
+	* Creates an inline change of change type <code>appdescr_fe_addNewPage</code>.
+	*
+	* @param {object} mPropertyBag Parameters of the change type
+	* @param {string} mPropertyBag.changeType Inline change type of an app variant
+	* @param {object} mPropertyBag.sourcePage Source page details
+	* @param {string} mPropertyBag.sourcePage.id ID of the source page
+	* @param {string} mPropertyBag.sourcePage.navigationSource Navigation source of the source page
+	* @param {object} mPropertyBag.targetPage Target page details
+	* @param {string} mPropertyBag.targetPage.id ID of the target page
+	* @param {string} mPropertyBag.targetPage.type Type of the target page
+	* @param {string} mPropertyBag.targetPage.name Name of the target page component
+	* @param {string} mPropertyBag.targetPage.routePattern Route pattern for navigation
+	* @param {object} mPropertyBag.targetPage.settings Additional settings for the target page
+	*
+	* @return {Promise} Resolving when creating the app variant inline change was successful (without back end access)
+	*
+	* @private
+	*/
+	AppVariantInlineChangeFactory.create_fe_addNewPage = function(mPropertyBag) {
+		Utils.checkParameterAndType(mPropertyBag.sourcePage, "id", "string");
+		Utils.checkParameterAndType(mPropertyBag.sourcePage, "navigationSource", "string");
+		Utils.checkParameterAndType(mPropertyBag.targetPage, "id", "string");
+		Utils.checkParameterAndType(mPropertyBag.targetPage, "type", "string");
+		Utils.checkParameterAndType(mPropertyBag.targetPage, "name", "string");
+		Utils.checkParameterAndType(mPropertyBag.targetPage, "routePattern", "string");
+		Utils.checkParameterAndType(mPropertyBag.targetPage, "settings", "object");
+		Utils.checkParameterAndType(mPropertyBag.targetPage.settings, "contextPath", "string");
+		Utils.checkParameterAndType(mPropertyBag.targetPage.settings, "pageLayout", "string");
+		Utils.checkParameterAndType(mPropertyBag.targetPage.settings, "controlConfiguration", "object");
+		return _createAppVariantInlineChange(mPropertyBag);
+	};
+
 	/**
 	 * Creates an inline change of change type <code>appdescr_ui_generic_app_changePageConfiguration</code>.
 	 *