@openui5/sap.ui.fl 1.134.0 → 1.135.0

package/src/sap/ui/fl/apply/_internal/flexState/controlVariants/VariantManagementState.js

@@ -13,6 +13,7 @@ sap.ui.define([
 	"sap/ui/fl/apply/_internal/flexState/changes/DependencyHandler",
 	"sap/ui/fl/apply/_internal/flexState/DataSelector",
 	"sap/ui/fl/apply/_internal/flexState/FlexState",
+	"sap/ui/fl/changeHandler/condenser/Classification",
 	"sap/ui/fl/initial/_internal/Storage",
 	"sap/ui/fl/LayerUtils"
 ], function(
@@ -24,17 +25,37 @@ sap.ui.define([
 	DependencyHandler,
 	DataSelector,
 	FlexState,
+	Classification,
 	Storage,
 	LayerUtils
 ) {
 	"use strict";
 
+	const oChangeInformationProviders = {
+		ctrl_variant_change: {
+			getCondenserInfo(oFlexObject) {
+				return {
+					classification: Classification.LastOneWins,
+					uniqueKey: oFlexObject.getVariantId() + oFlexObject.getChangeType()
+				};
+			}
+		},
+		ctrl_variant_management_change: {
+			getCondenserInfo(oFlexObject, mPropertyBag) {
+				return {
+					classification: Classification.LastOneWins,
+					uniqueKey: mPropertyBag.modifier.getControlIdBySelector(oFlexObject.getSelector(), mPropertyBag.appComponent)
+				};
+			}
+		}
+	};
+
 	/**
 	 * Handler class to manipulate control variant changes in a variants map. See also {@link sap.ui.fl.variants.VariantManagement}.
 	 *
 	 * @namespace sap.ui.fl.apply._internal.flexState.controlVariants.VariantManagementState
 	 * @since 1.74
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @private
 	 * @ui5-restricted
 	 */
@@ -126,7 +147,7 @@ sap.ui.define([
 		return {
 			instance: oVariantInstance,
 			variantChanges: oGroupedFlexObjects.variantChanges.filter(function(oFlexObject) {
-				return oFlexObject.getSelector().id === oVariantInstance.getId();
+				return oFlexObject.getVariantId() === oVariantInstance.getId();
 			}),
 			controlChanges: oGroupedFlexObjects.changes.filter(function(oFlexObject) {
 				var bCorrectFlexObjectType = oFlexObject.isA("sap.ui.fl.apply._internal.flexObjects.UIChange");
@@ -304,7 +325,7 @@ sap.ui.define([
 		var oFoundVariant;
 		Object.values(oVariantsMap).some(function(oVariantsMapEntry) {
 			return oVariantsMapEntry.variants.some(function(oVariant) {
-				if (oVariantChange.getSelector().id === oVariant.key) {
+				if (oVariantChange.getVariantId() === oVariant.key) {
 					oFoundVariant = oVariant;
 					return true;
 				}
@@ -406,6 +427,10 @@ sap.ui.define([
 		return oVariantDependentFlexObjectsDataSelector.get({reference: sReference});
 	};
 
+	VariantManagementState.getChangeInformationProvider = function(oFlexObject) {
+		return oChangeInformationProviders[oFlexObject.getFileType()];
+	};
+
 	/**
 	 * Removes the saved current variant from the internal map for the given reference
 	 *
@@ -735,7 +760,7 @@ sap.ui.define([
 				// eslint-disable-next-line camelcase
 				ctrl_variant: () => (oFilteredFlexObject.getVariantId()),
 				// eslint-disable-next-line camelcase
-				ctrl_variant_change: () => (oFilteredFlexObject.getSelector().id),
+				ctrl_variant_change: () => (oFilteredFlexObject.getVariantId()),
 				change: () => (oFilteredFlexObject.getVariantReference())
 			}[oFilteredFlexObject.getFileType()]?.();
 			return !aHiddenVariants.includes(sVariantReference);

package/src/sap/ui/fl/apply/_internal/preprocessors/ComponentLifecycleHooks.js

@@ -8,8 +8,8 @@ sap.ui.define([
 	"sap/base/Log",
 	"sap/ui/core/Component",
 	"sap/ui/core/Lib",
-	"sap/ui/fl/apply/_internal/changes/descriptor/Applier",
 	"sap/ui/fl/apply/_internal/changes/descriptor/ApplyStrategyFactory",
+	"sap/ui/fl/apply/_internal/changes/descriptor/InlineApplier",
 	"sap/ui/fl/apply/_internal/changes/Applier",
 	"sap/ui/fl/apply/_internal/flexState/FlexState",
 	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
@@ -26,8 +26,8 @@ sap.ui.define([
 	Log,
 	Component,
 	Lib,
-	AppDescriptorApplier,
 	ApplyStrategyFactory,
+	InlineApplier,
 	ChangesApplier,
 	FlexState,
 	ManifestUtils,
@@ -200,7 +200,7 @@ sap.ui.define([
 		// manifest descriptor changes for ABAP mixed mode can only be applied in this hook,
 		// because at this point all libs have been loaded (in contrast to the first Component(s) 'onPreprocessManifest' hook),
 		// but the manifest is still adaptable
-		return AppDescriptorApplier.applyChangesIncludedInManifest(oManifest, ApplyStrategyFactory.getRuntimeStrategy());
+		return InlineApplier.applyChanges(oManifest, ApplyStrategyFactory.getRuntimeStrategy());
 	}
 
 	// the current sinon version used in UI5 does not support stubbing the constructor

package/src/sap/ui/fl/apply/_internal/preprocessors/ControllerExtension.js

@@ -5,17 +5,17 @@
  */
 
 sap.ui.define([
+	"sap/base/Log",
 	"sap/ui/core/Component",
-	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
 	"sap/ui/fl/apply/_internal/flexState/FlexState",
-	"sap/ui/fl/Utils",
-	"sap/base/Log"
+	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
+	"sap/ui/fl/Utils"
 ], function(
+	Log,
 	Component,
-	ManifestUtils,
 	FlexState,
-	Utils,
-	Log
+	ManifestUtils,
+	Utils
 ) {
 	"use strict";
 
@@ -26,7 +26,7 @@ sap.ui.define([
 	 * @class
 	 * @constructor
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.27.0
 	 * @private
 	 * @ui5-restricted sap.ui.fl, sap.ui.core
@@ -37,9 +37,25 @@ sap.ui.define([
 		return oChange.getChangeType() === "codeExt";
 	}
 
+	function migrateToNewSyntaxIfNecessary(sControllerName) {
+		if (!sControllerName.startsWith("module:")) {
+			return `module:${sControllerName.replace(/\./g, "/")}.controller`;
+		}
+		return sControllerName;
+	}
+
+	/**
+	 * Checks if the controller name saved in the change matches the provided controller name.
+	 * The syntax for the controller name changed to module syntax in 1.134, so legacy changes need
+	 * to be transformed to module syntax before the check.
+	 *
+	 * @param {string} sControllerName - Name of the controller in module syntax
+	 * @param {sap.ui.fl.apply._internal.flexObjects.ControllerExtensionChange} oChange - ControllerExtensionChange instance
+	 * @returns {boolean} - Returns true if the controller name of the change matches the provided controller name
+	 */
 	function isForController(sControllerName, oChange) {
-		var sSelectorControllerName = oChange.getSelector().controllerName;
-		return sControllerName === sSelectorControllerName;
+		var sSelectorControllerName = migrateToNewSyntaxIfNecessary(oChange.getSelector().controllerName);
+		return sSelectorControllerName === migrateToNewSyntaxIfNecessary(sControllerName);
 	}
 
 	function getExtensionModules(aCodeExtModuleNames) {
@@ -58,8 +74,8 @@ sap.ui.define([
 	}
 
 	/**
-	 * Provides an array of extension providers. An extension provider is an object which were defined as controller extensions. These objects
-	 * provides lifecycle and event handler functions of a specific controller.
+	 * Provides an array of extension providers. An extension provider is an object which were defined as controller extensions.
+	 * These objects provide lifecycle and event handler functions of a specific controller.
 	 *
 	 * @param {string} sControllerName - Name of the controller
 	 * @param {string} sComponentId - Unique id for the running controller - unique as well for manifest first

package/src/sap/ui/fl/apply/_internal/preprocessors/RegistrationDelegator.js

@@ -44,7 +44,7 @@ sap.ui.define([
 	 * @class
 	 * @constructor
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.43.0
 	 * @private
 	 */

package/src/sap/ui/fl/apply/_internal/preprocessors/XmlPreprocessor.js

@@ -38,7 +38,7 @@ sap.ui.define([
 	 * @class
 	 * @constructor
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.27.0
 	 * @private
 	 */

package/src/sap/ui/fl/changeHandler/AddIFrame.js

@@ -22,7 +22,7 @@ sap.ui.define([
 	 *
 	 * @alias sap.ui.fl.changeHandler.AddIFrame
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.72
 	 * @private
 	 */

package/src/sap/ui/fl/changeHandler/AddXML.js

@@ -16,7 +16,7 @@ sap.ui.define([
 	 *
 	 * @alias sap.ui.fl.changeHandler.AddXML
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.54
 	 * @private
 	 */

package/src/sap/ui/fl/changeHandler/AddXMLAtExtensionPoint.js

@@ -18,7 +18,7 @@ sap.ui.define([
 	 *
 	 * @alias sap.ui.fl.changeHandler.AddXMLAtExtensionPoint
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.75
 	 * @private
 	 */

package/src/sap/ui/fl/changeHandler/Base.js

@@ -14,7 +14,7 @@ sap.ui.define([
 	/**
 	 * Base functionality for all change handlers, which provides some reuse methods
 	 * @namespace sap.ui.fl.changeHandler.Base
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @private
 	 * @ui5-restricted change handlers
 	 */

package/src/sap/ui/fl/changeHandler/BaseAddViaDelegate.js

@@ -29,7 +29,7 @@ sap.ui.define([
 	 * @constructor
 	 * @alias sap.ui.fl.changeHandler.BaseAddViaDelegate
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @private
 	 * @ui5-restricted change handlers
 	 */

package/src/sap/ui/fl/changeHandler/BaseAddXml.js

@@ -21,7 +21,7 @@ sap.ui.define([
 	 *
 	 * @alias sap.ui.fl.changeHandler.BaseAddXml
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.75
 	 * @private
 	 * @ui5-restricted change handlers

package/src/sap/ui/fl/changeHandler/BaseRename.js

@@ -17,7 +17,7 @@ sap.ui.define([
 	 * @constructor
 	 * @alias sap.ui.fl.changeHandler.BaseRename
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.46
 	 *
 	 * @private

package/src/sap/ui/fl/changeHandler/ChangeAnnotation.js

@@ -15,7 +15,7 @@ sap.ui.define([
 	 * Default change handler for annotations.
 	 * @alias sap.ui.fl.changeHandler.ChangeAnnotation
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.132
 	 * @public
 	 */
@@ -32,10 +32,20 @@ sap.ui.define([
 	 * @returns {object} Information for the model to apply the change
 	 */
 	ChangeAnnotation.applyChange = function(oChange) {
-		return {
-			path: oChange.getContent().annotationPath,
-			value: oChange.getText("annotationText") || oChange.getContent().value
+		const oContent = oChange.getContent();
+		const oReturn = {
+			path: oContent.annotationPath
 		};
+
+		const sValue = oChange.getText("annotationText") || oContent.value;
+
+		const oObjectTemplateInfo = oContent.objectTemplateInfo;
+		if (oObjectTemplateInfo) {
+			oReturn.value = JSON.parse(oObjectTemplateInfo.templateAsString.replace(oObjectTemplateInfo.placeholder, sValue));
+		} else {
+			oReturn.value = sValue;
+		}
+		return oReturn;
 	};
 
 	/**
@@ -50,11 +60,20 @@ sap.ui.define([
 	 * @param {object} oSpecificChangeInfo - Information needed to complete the change
 	 * @param {string} oSpecificChangeInfo.content.annotationPath - Path of the annotation to be changed
 	 * @param {string} oSpecificChangeInfo.content.value - Value of the annotation to be changed
+	 * @param {string} oSpecificChangeInfo.content.text - Translatable value of the annotation. If given, the value is ignored
+	 * @param {object} [oSpecificChangeInfo.content.objectTemplateInfo] - Object template to construct a return object
+	 * @param {string} [oSpecificChangeInfo.content.objectTemplateInfo.templateAsString] - Stringified template to be used for constructing the return object
+	 * @param {string} [oSpecificChangeInfo.content.objectTemplateInfo.placeholder] - Placeholder in the template string
 	 */
 	ChangeAnnotation.completeChangeContent = function(oChange, oSpecificChangeInfo) {
 		const oNewContent = {
 			annotationPath: oSpecificChangeInfo.content.annotationPath
 		};
+
+		if (oSpecificChangeInfo.content.objectTemplateInfo) {
+			oNewContent.objectTemplateInfo = oSpecificChangeInfo.content.objectTemplateInfo;
+		}
+
 		if (oSpecificChangeInfo.content.text) {
 			oChange.setText("annotationText", oSpecificChangeInfo.content.text);
 		} else {

package/src/sap/ui/fl/changeHandler/HideControl.js

@@ -21,7 +21,7 @@ sap.ui.define([
 	 * Change handler for hiding of a control.
 	 * @alias sap.ui.fl.changeHandler.HideControl
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.27.0
 	 */
 	const HideControl = {};

package/src/sap/ui/fl/changeHandler/MoveControls.js

@@ -19,7 +19,7 @@ function(
 	 *
 	 * @alias sap.ui.fl.changeHandler.MoveControls
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.46
 	 */
 	const MoveControls = { };

package/src/sap/ui/fl/changeHandler/MoveElements.js

@@ -12,7 +12,7 @@ sap.ui.define([], function() {
 	 *
 	 * @alias sap.ui.fl.changeHandler.MoveElements
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.34.0
 	 */
 	var MoveElements = { };

package/src/sap/ui/fl/changeHandler/PropertyBindingChange.js

@@ -18,7 +18,7 @@ sap.ui.define([
 	 *
 	 * @alias sap.ui.fl.changeHandler.PropertyBindingChange
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.38
 	 * @private
 	 */

package/src/sap/ui/fl/changeHandler/PropertyChange.js

@@ -22,7 +22,7 @@ sap.ui.define([
 	 *
 	 * @alias sap.ui.fl.changeHandler.PropertyChange
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.36
 	 * @private
 	 */

package/src/sap/ui/fl/changeHandler/StashControl.js

@@ -19,7 +19,7 @@ sap.ui.define([
 	 * Change handler for stashing of a control.
 	 * @alias sap.ui.fl.changeHandler.StashControl
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.27.0
 	 */
 	const StashControl = {};

package/src/sap/ui/fl/changeHandler/UnhideControl.js

@@ -21,7 +21,7 @@ sap.ui.define([
 	 * Change handler for revealing of a control.
 	 * @alias sap.ui.fl.changeHandler.UnhideControl
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.27.0
 	 */
 	const UnhideControl = {};

package/src/sap/ui/fl/changeHandler/UnstashControl.js

@@ -15,7 +15,7 @@ sap.ui.define([
 	 * Change handler for unstashing of a control.
 	 * @alias sap.ui.fl.changeHandler.UnstashControl
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.27.0
 	 */
 	const UnstashControl = {};

package/src/sap/ui/fl/changeHandler/UpdateIFrame.js

@@ -18,7 +18,7 @@ sap.ui.define([
 	 *
 	 * @alias sap.ui.fl.changeHandler.UpdateIFrame
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @since 1.72
 	 * @private
 	 */

package/src/sap/ui/fl/descriptorRelated/api/DescriptorChange.js

@@ -0,0 +1,121 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define([
+	"sap/base/util/merge",
+	"sap/ui/fl/apply/_internal/flexObjects/FlexObjectFactory",
+	"sap/ui/fl/write/_internal/flexState/changes/UIChangeManager",
+	"sap/ui/fl/ChangePersistenceFactory",
+	"sap/ui/fl/Utils"
+], function(
+	fnBaseMerge,
+	FlexObjectFactory,
+	UIChangeManager,
+	ChangePersistenceFactory,
+	Utils
+) {
+	"use strict";
+	/**
+	 * Descriptor Related
+	 * @namespace
+	 * @name sap.ui.fl.descriptorRelated
+	 * @author SAP SE
+	 * @version 1.135.0
+	 * @private
+	 * @ui5-restricted sap.ui.rta, smart business
+	 */
+
+	/**
+	 * Descriptor Related Apis
+	 * @namespace
+	 * @name sap.ui.fl.descriptorRelated.api
+	 * @author SAP SE
+	 * @version 1.135.0
+	 * @private
+	 * @ui5-restricted sap.ui.rta, smart business
+	 */
+
+	/**
+	 * Descriptor Change
+	 *
+	 * @param {object} mChangeFile change file
+	 * @param {sap.ui.fl.descriptorRelated.api.DescriptorInlineChange} oInlineChange inline change object
+	 *
+	 * @constructor
+	 * @alias sap.ui.fl.descriptorRelated.api.DescriptorChange
+	 * @author SAP SE
+	 * @version 1.135.0
+	 * @private
+	 * @ui5-restricted sap.ui.rta, smart business
+	 */
+	const DescriptorChange = function(mChangeFile, oInlineChange) { // so far, parameter correspond to inline change format
+		this._mChangeFile = mChangeFile;
+		this._mChangeFile.packageName = "";
+		this._oInlineChange = oInlineChange;
+	};
+
+	/**
+	 * Submits the descriptor change to the backend
+	 *
+	 * @return {Promise} resolving after all changes have been saved
+	 *
+	 * @private
+	 * @ui5-restricted sap.ui.rta, smart business
+	 */
+	DescriptorChange.prototype.submit = function() {
+		this.store();
+
+		// submit
+		const oChangePersistence = this._getChangePersistence(this._mChangeFile.reference);
+		return oChangePersistence.saveDirtyChanges();
+	};
+
+	/**
+	 * Stores the descriptor change in change persistence
+	 *
+	 * @return {object} change object
+	 *
+	 * @private
+	 * @ui5-restricted sap.ui.rta, smart business
+	 */
+	DescriptorChange.prototype.store = function() {
+		const sReference = this._mChangeFile.reference;
+		const oComponent = Utils.getComponentForControl(this._mChangeFile.selector);
+		const oChange = this._getChangeToSubmit();
+		UIChangeManager.addDirtyChanges(sReference, [oChange], oComponent);
+
+		return oChange;
+	};
+
+	DescriptorChange.prototype._getChangePersistence = function(sComponentName) {
+		return ChangePersistenceFactory.getChangePersistenceForComponent(sComponentName);
+	};
+
+	DescriptorChange.prototype._getChangeToSubmit = function() {
+		return FlexObjectFactory.createAppDescriptorChange(this._getMap());
+	};
+
+	DescriptorChange.prototype._getMap = function() {
+		var mInlineChange = this._oInlineChange.getMap();
+
+		this._mChangeFile.content = mInlineChange.content;
+		this._mChangeFile.texts = mInlineChange.texts;
+		return this._mChangeFile;
+	};
+
+	/**
+	 * Returns a copy of the JSON object of the descriptor change
+	 *
+	 * @return {object} copy of JSON object of the descriptor change
+	 *
+	 * @private
+	 * @ui5-restricted sap.ui.rta, smart business
+	 */
+	DescriptorChange.prototype.getJson = function() {
+		return fnBaseMerge({}, this._getMap());
+	};
+
+	return DescriptorChange;
+});