@openui5/sap.ui.fl 1.131.1 → 1.132.1

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

@@ -1,44 +1,44 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (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/ui/core/Lib",
-	"sap/ui/fl/write/api/Adaptations",
-	"sap/ui/fl/write/api/FeaturesAPI",
 	"sap/ui/fl/apply/_internal/flexObjects/FlexObjectFactory",
+	"sap/ui/fl/apply/_internal/flexState/compVariants/CompVariantMerger",
+	"sap/ui/fl/apply/_internal/flexState/controlVariants/VariantManagementState",
 	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
 	"sap/ui/fl/apply/api/ControlVariantApplyAPI",
-	"sap/ui/fl/Layer",
-	"sap/ui/fl/LayerUtils",
-	"sap/ui/fl/Utils",
 	"sap/ui/fl/initial/_internal/FlexInfoSession",
-	"sap/ui/fl/write/_internal/flexState/FlexObjectManager",
-	"sap/ui/fl/apply/_internal/flexState/compVariants/CompVariantMerger",
 	"sap/ui/fl/write/_internal/flexState/compVariants/CompVariantState",
-	"sap/ui/fl/apply/_internal/flexState/controlVariants/VariantManagementState",
+	"sap/ui/fl/write/_internal/flexState/FlexObjectManager",
 	"sap/ui/fl/write/_internal/Storage",
 	"sap/ui/fl/write/_internal/Versions",
+	"sap/ui/fl/write/api/Adaptations",
+	"sap/ui/fl/write/api/FeaturesAPI",
+	"sap/ui/fl/Layer",
+	"sap/ui/fl/LayerUtils",
+	"sap/ui/fl/Utils",
 	"sap/ui/model/json/JSONModel"
 ], function(
 	Lib,
-	Adaptations,
-	FeaturesAPI,
 	FlexObjectFactory,
+	CompVariantMerger,
+	VariantManagementState,
 	ManifestUtils,
 	ControlVariantApplyAPI,
-	Layer,
-	LayerUtils,
-	FlexUtils,
 	FlexInfoSession,
-	FlexObjectManager,
-	CompVariantMerger,
 	CompVariantState,
-	VariantManagementState,
+	FlexObjectManager,
 	Storage,
 	Versions,
+	Adaptations,
+	FeaturesAPI,
+	Layer,
+	LayerUtils,
+	FlexUtils,
 	JSONModel
 ) {
 	"use strict";
@@ -470,9 +470,10 @@ sap.ui.define([
 	 * @param {string} mPropertyBag.layer - Working layer
 	 * @param {sap.ui.core.Control} mPropertyBag.control - Control for which the request is done
 	 * @param {string} [contextBasedAdaptationId] - ID of the context-based adaption
+	 * @param {sap.ui.fl.variants.VariantManager} VariantManager - Variant Manager module
 	 * @returns {object} Returns the change as JSON object
 	 */
-	function createChangeSetVisibleFalseToRestrictedVariant(oVariant, mPropertyBag, contextBasedAdaptationId) {
+	function createChangeSetVisibleFalseToRestrictedVariant(oVariant, mPropertyBag, contextBasedAdaptationId, VariantManager) {
 		if (oVariant.isA("sap.ui.fl.apply._internal.flexObjects.CompVariant")) {
 			var sPersistencyKey = oVariant.getPersistencyKey();
 			oVariant = CompVariantState.updateVariant({
@@ -488,8 +489,7 @@ sap.ui.define([
 		}
 		// Fl variant
 		var oAppComponent = FlexUtils.getAppComponentForControl(mPropertyBag.control);
-		var oModel = oAppComponent.getModel(ControlVariantApplyAPI.getVariantModelName());
-		var oChange = oModel.createVariantChange(
+		var oChange = VariantManager.createVariantChange(
 			oVariant.getVariantManagementReference(),
 			{
 				changeType: "setVisible",
@@ -671,7 +671,7 @@ sap.ui.define([
 	 * @param {sap.ui.core.Control} mPropertyBag.control - Control for which the request is done
 	 * @returns {object} Returns a object containing context-based adaptations and changes/variants as FlexObjects that must be migrated
 	 */
-	function prepareMigrationData(aVariants, aFlVariantsFinalState, aChanges, mPropertyBag) {
+	function prepareMigrationData(aVariants, aFlVariantsFinalState, aChanges, mPropertyBag, VariantManager) {
 		var oMigrationData = {
 			contextBasedAdaptations: [],
 			flexObjects: []
@@ -699,7 +699,7 @@ sap.ui.define([
 			var sContextBasedAdaptationId = oUniqueContext.contextBasedAdaptationId;
 			var oContextBasedAdaptation = {
 				id: sContextBasedAdaptationId,
-				title: _oResourceBundle.getText("CBA_MIGRATED_ADAPTATION_TITLE", sContext),
+				title: _oResourceBundle.getText("CBA_MIGRATED_ADAPTATION_TITLE", [sContext]),
 				contexts: {
 					role: [sContext]
 				},
@@ -737,7 +737,7 @@ sap.ui.define([
 			aVariants.forEach(function(oVariant) {
 				if (oVariant.getLayer() !== Layer.CUSTOMER && aUniqueContextVariantIds.indexOf(oVariant.getId()) < 0) {
 					oMigrationData.flexObjects.push(
-						createChangeSetVisibleFalseToRestrictedVariant(oVariant, mPropertyBag, sContextBasedAdaptationId)
+						createChangeSetVisibleFalseToRestrictedVariant(oVariant, mPropertyBag, sContextBasedAdaptationId, VariantManager)
 					);
 				}
 			});
@@ -749,7 +749,7 @@ sap.ui.define([
 			var bRestricted = aUnrestrictedViews.indexOf(oVariant) < 0;
 			if (oFinalState.visible === true && bRestricted) {
 				oMigrationData.flexObjects.push(
-					createChangeSetVisibleFalseToRestrictedVariant(oVariant, mPropertyBag, undefined)
+					createChangeSetVisibleFalseToRestrictedVariant(oVariant, mPropertyBag, undefined, VariantManager)
 				);
 			}
 		});
@@ -757,7 +757,18 @@ sap.ui.define([
 		return oMigrationData;
 	}
 
-	 /**
+	// the VariantModel / VariantManager uses the ContextBasedAdaptationsAPI to fetch the adaptation id,
+	// and the ContextBasedAdaptationsAPI uses the VariantModel / VariantManager to create changes
+	// TODO: the logic needs to be refactored to get rid of this circular dependency
+	function lazyRequireVariantManager() {
+		return new Promise(function(resolve) {
+			sap.ui.require(["sap/ui/fl/variants/VariantManager"], function(VariantManager) {
+				resolve(VariantManager);
+			});
+		});
+	}
+
+	/**
 	 * Migrate variants to use context-based adaptations by creating context-based adaptations for single unique context.
 	 * This is done by retrieving unique contexts, and grouping variants by unique contexts.
 	 * For each unique context a new context-based adaptation is created that contains one unique context.
@@ -770,7 +781,7 @@ sap.ui.define([
 	 * @private
 	 * @ui5-restricted sap.ui.fl, sap.ui.rta
 	 */
-	ContextBasedAdaptationsAPI.migrate = function(mPropertyBag) {
+	ContextBasedAdaptationsAPI.migrate = async function(mPropertyBag) {
 		mPropertyBag.appId = getFlexReferenceForControl(mPropertyBag.control);
 		var sParentVersion = getParentVersion(mPropertyBag);
 		mPropertyBag.parentVersion = sParentVersion;
@@ -784,6 +795,8 @@ sap.ui.define([
 			flexObjects: []
 		};
 
+		const VariantManager = await lazyRequireVariantManager();
+
 		return FlexObjectManager.getFlexObjects({
 			selector: mPropertyBag.control,
 			invalidateCache: false,
@@ -801,7 +814,7 @@ sap.ui.define([
 		.then(function(aFlexObjects) {
 			var aChanges = aFlexObjects.pop();
 			var aVariants = aFlexObjects.flat();
-			oMigrationData = prepareMigrationData(aVariants, aFlVariantsFinalState, aChanges, mPropertyBag);
+			oMigrationData = prepareMigrationData(aVariants, aFlVariantsFinalState, aChanges, mPropertyBag, VariantManager);
 
 			// Create adaptations sequentially because backend does not support parallel calls
 			var oPromise = Promise.resolve();

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -125,6 +125,7 @@ sap.ui.define([
 			const oVariantModel = oAppComponent.getModel(ControlVariantApplyAPI.getVariantModelName());
 			const sLayer = Layer.USER;
 			const aSuccessfulChanges = [];
+			const mVMReferences = {};
 
 			function createChanges() {
 				const aChanges = [];
@@ -140,12 +141,23 @@ sap.ui.define([
 						if (!oPersonalizationChange.transient && !mPropertyBag.ignoreVariantManagement) {
 							// check for preset variantReference
 							if (!oPersonalizationChange.changeSpecificData.variantReference) {
-								const sVariantManagementReference = getRelevantVariantManagementReference(
+								let sVariantManagementReference;
+								const sSelectorControlId = oPersonalizationChange.selectorControl.getId();
+								sVariantManagementReference = mVMReferences[sSelectorControlId] || getRelevantVariantManagementReference(
 									oAppComponent,
 									oPersonalizationChange.selectorControl,
 									mPropertyBag.useStaticArea
 								);
+								if (!sVariantManagementReference && !mPropertyBag.useStaticArea) {
+									// If not already found, look for a suitable VM control in the static area
+									sVariantManagementReference = getRelevantVariantManagementReference(
+										oAppComponent,
+										oPersonalizationChange.selectorControl,
+										true
+									);
+								}
 								if (sVariantManagementReference) {
+									mVMReferences[sSelectorControlId] = sVariantManagementReference;
 									const sCurrentVariantReference = oVariantModel.oData[sVariantManagementReference].currentVariant;
 									oPersonalizationChange.changeSpecificData.variantReference = sCurrentVariantReference;
 								}

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -22,7 +22,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.write.api.FieldExtensibility
 	 * @since 1.87
-	 * @version 1.131.1
+	 * @version 1.132.1
 	 * @private
 	 * @ui5-restricted sap.ui.fl, sap.ui.rta, sap.ui.mdc
 	 */

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -10,6 +10,8 @@ sap.ui.define([
 	"sap/ui/core/util/reflection/JsControlTreeModifier",
 	"sap/ui/fl/apply/_internal/appVariant/DescriptorChangeTypes",
 	"sap/ui/fl/apply/_internal/changes/FlexCustomData",
+	"sap/ui/fl/apply/_internal/flexObjects/AnnotationChange",
+	"sap/ui/fl/apply/_internal/flexState/FlexState",
 	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
 	"sap/ui/fl/initial/_internal/FlexInfoSession",
 	"sap/ui/fl/registry/Settings",
@@ -27,6 +29,8 @@ sap.ui.define([
 	JsControlTreeModifier,
 	DescriptorChangeTypes,
 	FlexCustomData,
+	AnnotationChange,
+	FlexState,
 	ManifestUtils,
 	FlexInfoSession,
 	Settings,
@@ -266,13 +270,16 @@ sap.ui.define([
 	 * @ui5-restricted sap.ui.fl, sap.ui.rta
 	 */
 	PersistenceWriteAPI.add = function(mPropertyBag) {
-		var oAppComponent = Utils.getAppComponentForSelector(mPropertyBag.selector);
-		var sFlexReference = ManifestUtils.getFlexReferenceForSelector(mPropertyBag.selector);
+		const oAppComponent = Utils.getAppComponentForSelector(mPropertyBag.selector);
+		const sFlexReference = ManifestUtils.getFlexReferenceForSelector(mPropertyBag.selector);
 
 		function addSingleFlexObject(oFlexObject) {
 			if (isDescriptorChange(oFlexObject)) {
 				return oFlexObject.store();
 			}
+			if (oFlexObject instanceof AnnotationChange) {
+				return FlexObjectManager.addDirtyFlexObjects(sFlexReference, [oFlexObject])?.[0];
+			}
 			return UIChangeManager.addDirtyChanges(sFlexReference, [oFlexObject], oAppComponent)?.[0];
 		}
 
@@ -284,7 +291,7 @@ sap.ui.define([
 			return addSingleFlexObject(mPropertyBag.change);
 		}
 
-		var bHasDescriptorChanges = mPropertyBag.flexObjects.some(function(oFlexObject) {
+		const bHasDescriptorChanges = mPropertyBag.flexObjects.some(function(oFlexObject) {
 			return isDescriptorChange(oFlexObject);
 		});
 
@@ -293,7 +300,25 @@ sap.ui.define([
 			return mPropertyBag.flexObjects.map(addSingleFlexObject);
 		}
 
-		return UIChangeManager.addDirtyChanges(sFlexReference, mPropertyBag.flexObjects, oAppComponent);
+		const aUIChanges = [];
+		const aAnnotationChanges = [];
+
+		mPropertyBag.flexObjects.forEach((oFlexObject) => {
+			if (oFlexObject instanceof AnnotationChange) {
+				aAnnotationChanges.push(oFlexObject);
+			} else {
+				aUIChanges.push(oFlexObject);
+			}
+		});
+
+		const aAddedFlexObjects = FlexObjectManager.addDirtyFlexObjects(sFlexReference, aAnnotationChanges);
+		const aAddedUIChanges = UIChangeManager.addDirtyChanges(sFlexReference, aUIChanges, oAppComponent);
+
+		// Ensure that the added changes are returned in the same order as they were passed
+		return mPropertyBag.flexObjects.map((oFlexObject) => {
+			return aAddedFlexObjects.find((oAddedFlexObject) => oAddedFlexObject === oFlexObject)
+				|| aAddedUIChanges.find((oAddedFlexObject) => oAddedFlexObject === oFlexObject);
+		});
 	};
 
 	/**
@@ -449,6 +474,19 @@ sap.ui.define([
 		return FlexObjectManager.getFlexObjects(mPropertyBag);
 	};
 
+	/**
+	 * Retrieves the annotation changes for the given control from the FlexState.
+	 *
+	 * @param {object} mPropertyBag - Property bag
+	 * @param {sap.ui.core.Control} mPropertyBag.control - Control to retrieve the flex reference
+	 * @returns {sap.ui.fl.apply._internal.flexObjects.AnnotationChange[]} List of all annotation changes
+	 * @private
+	 */
+	PersistenceWriteAPI._getAnnotationChanges = function(mPropertyBag) {
+		const sFlexReference = ManifestUtils.getFlexReferenceForControl(mPropertyBag.control);
+		return FlexState.getAnnotationChanges(sFlexReference);
+	};
+
 	/**
 	 * Adds layer property to the flex info session.
 	 *

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (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([

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 

package/src/sap/ui/fl/write/connectors/BaseConnector.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 

package/ui5.yaml

@@ -35,7 +35,7 @@ builder:
               - sap/ui/fl/initial/
               - sap/ui/fl/interfaces/Delegate.js
               - sap/ui/fl/interfaces/BaseLoadConnector.js
-              - sap/ui/fl/registry/SimpleChanges.js
+              - sap/ui/fl/registry/Settings.js
               - sap/ui/fl/util/ManagedObjectModel.js
               - sap/ui/fl/variants/VariantManagement.js
               # exclude all bundles
@@ -62,6 +62,7 @@ builder:
               - sap/ui/fl/descriptorRelated/api/DescriptorInlineChangeFactory.js
               - sap/ui/fl/util/resolveBinding.js
               - sap/ui/fl/write/
+              - sap/ui/fl/variants/VariantManager.js
               # exclude all bundles
               - "!sap/ui/fl/**/*-preload*.js"
             resolve: true