@openui5/sap.ui.fl 1.140.0 → 1.141.1

package/src/sap/ui/fl/apply/_internal/flexState/changes/ExtensionPointState.js

@@ -41,7 +41,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.apply._internal.flexState.changes.ExtensionPointState
 	 * @since 1.79
-	 * @version 1.140.0
+	 * @version 1.141.1
 	 * @private
 	 * @ui5-restricted
 	 */

package/src/sap/ui/fl/apply/_internal/flexState/changes/UIChangesState.js

@@ -24,7 +24,7 @@ sap.ui.define([
 	 * @namespace
 	 * @alias sap.ui.fl.apply._internal.flexState.changes.UIChangesState
 	 * @since 1.121
-	 * @version 1.140.0
+	 * @version 1.141.1
 	 * @private
 	 * @ui5-restricted
 	 */

package/src/sap/ui/fl/apply/_internal/flexState/compVariants/CompVariantManagementState.js

@@ -7,7 +7,6 @@
 sap.ui.define([
 	"sap/base/Log",
 	"sap/ui/fl/apply/_internal/flexState/FlexState",
-	"sap/ui/fl/apply/_internal/flexState/changes/UIChangesState",
 	"sap/ui/fl/apply/_internal/flexState/DataSelector",
 	"sap/ui/fl/apply/_internal/flexState/compVariants/applyChangesOnVariant",
 	"sap/ui/fl/apply/_internal/flexObjects/CompVariant",
@@ -16,7 +15,6 @@ sap.ui.define([
 ], function(
 	Log,
 	FlexState,
-	UIChangesState,
 	DataSelector,
 	applyChangesOnVariant,
 	CompVariant,
@@ -30,7 +28,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.apply._internal.flexState.compVariants.CompVariantManagementState
 	 * @since 1.129
-	 * @version 1.140.0
+	 * @version 1.141.1
 	 * @private
 	 * @ui5-restricted
 	 */
@@ -160,7 +158,6 @@ sap.ui.define([
 
 	function createVariant(mPropertyBag) {
 		const oVariantInput = mPropertyBag.variantInput || {};
-		const mAuthors = mPropertyBag.authors || {};
 		const oVariantData = {
 			fileName: oVariantInput.fileName,
 			fileType: "variant",
@@ -181,7 +178,7 @@ sap.ui.define([
 			}
 		};
 
-		return FlexObjectFactory.createCompVariant(oVariantData, mAuthors);
+		return FlexObjectFactory.createCompVariant(oVariantData);
 	}
 
 	function escapeSpecialIdCharacters(sId) {

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

@@ -8,12 +8,16 @@ sap.ui.define([
 	"sap/base/util/restricted/_pick",
 	"sap/ui/fl/apply/_internal/changes/Applier",
 	"sap/ui/fl/apply/_internal/changes/Reverter",
-	"sap/ui/fl/apply/_internal/flexState/controlVariants/VariantManagementState"
+	"sap/ui/fl/apply/_internal/flexState/changes/DependencyHandler",
+	"sap/ui/fl/apply/_internal/flexState/controlVariants/VariantManagementState",
+	"sap/ui/fl/apply/_internal/flexState/FlexObjectState"
 ], function(
 	_pick,
 	Applier,
 	Reverter,
-	VariantManagementState
+	DependencyHandler,
+	VariantManagementState,
+	FlexObjectState
 ) {
 	"use strict";
 
@@ -75,7 +79,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.apply._internal.flexState.controlVariants.Switcher
 	 * @since 1.74
-	 * @version 1.140.0
+	 * @version 1.141.1
 	 * @private
 	 * @ui5-restricted
 	 */
@@ -97,8 +101,21 @@ sap.ui.define([
 		async switchVariant(mPropertyBag) {
 			var mChangesToBeSwitched = getControlChangesForVariantSwitch(mPropertyBag);
 
-			await Reverter.revertMultipleChanges(mChangesToBeSwitched.changesToBeReverted, mPropertyBag);
-			await Applier.applyMultipleChanges(mChangesToBeSwitched.changesToBeApplied, mPropertyBag);
+			const oLiveDependencyMap = FlexObjectState.getLiveDependencyMap(mPropertyBag.reference);
+
+			// Early setting the changes as queued for revert/apply prevents potential timing issues
+			// when e.g. evaluating the App State after the switch
+			mChangesToBeSwitched.changesToBeReverted.forEach((oChange) => oChange.setQueuedForRevert());
+			mChangesToBeSwitched.changesToBeApplied.forEach((oChange) => {
+				if (!oChange.isApplyProcessFinished()) {
+					oChange.setQueuedForApply();
+					// Add change to the dependency map in advance so that any dependent changes are aware of the change
+					DependencyHandler.addRuntimeChangeToMap(oChange, mPropertyBag.appComponent, oLiveDependencyMap);
+				}
+			});
+
+			await Reverter.revertMultipleChanges(mChangesToBeSwitched.changesToBeReverted, {...mPropertyBag, skipSetQueued: true});
+			await Applier.applyMultipleChanges(mChangesToBeSwitched.changesToBeApplied, {...mPropertyBag, skipSetQueued: true});
 			VariantManagementState.setCurrentVariant(mPropertyBag);
 		}
 

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

@@ -14,7 +14,6 @@ sap.ui.define([
 	"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(
 	_omit,
@@ -26,7 +25,6 @@ sap.ui.define([
 	DataSelector,
 	FlexState,
 	Classification,
-	Storage,
 	LayerUtils
 ) {
 	"use strict";
@@ -55,7 +53,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.apply._internal.flexState.controlVariants.VariantManagementState
 	 * @since 1.74
-	 * @version 1.140.0
+	 * @version 1.141.1
 	 * @private
 	 * @ui5-restricted
 	 */
@@ -346,8 +344,8 @@ sap.ui.define([
 				return true;
 			}
 
-			const aRelevantFlexObjectTypes = ["addFlexObject", "updateFlexObject", "removeFlexObject"];
-			const bRelevantType = aRelevantFlexObjectTypes.includes(oUpdateInfo.type);
+			const aRelevantFlexObjectUpdateTypes = ["addFlexObject", "updateFlexObject", "removeFlexObject"];
+			const bRelevantType = aRelevantFlexObjectUpdateTypes.includes(oUpdateInfo.type);
 			const aRelevantVariantFileTypes = ["ctrl_variant", "ctrl_variant_change", "ctrl_variant_management_change"];
 			const bRelevantVariantType = aRelevantVariantFileTypes.includes(oUpdateInfo.updatedObject?.getFileType?.());
 			const bHasVariantReference = oUpdateInfo.updatedObject?.getVariantReference?.();
@@ -495,14 +493,10 @@ sap.ui.define([
 	 * @param {string} mPropertyBag.variantReference - Variant reference to be loaded
 	 */
 	VariantManagementState.loadVariant = async function(mPropertyBag) {
-		const oStorageResponse = await Storage.loadFlVariant({
+		await FlexState.lazyLoadFlVariant({
 			variantReference: mPropertyBag.variantReference,
 			reference: mPropertyBag.reference
 		});
-		FlexState.updateWithDataProvided({
-			reference: mPropertyBag.reference,
-			newData: oStorageResponse
-		});
 	};
 
 	/**
@@ -576,20 +570,43 @@ sap.ui.define([
 		});
 	};
 
+	VariantManagementState.updateVariant = function(mPropertyBag) {
+		oVariantManagementMapDataSelector.checkUpdate(
+			{ reference: mPropertyBag.reference },
+			[{ type: "updateFlexObject", updatedObject: mPropertyBag.variant }]
+		);
+	};
+
 	/**
 	 * Returns the current variant reference for a given variant management reference.
 	 *
 	 * @param {object} mPropertyBag - Object with the necessary properties
 	 * @param {string} mPropertyBag.vmReference - Variant management reference
 	 * @param {string} mPropertyBag.reference - Component reference
-	 * @returns {string} Reference of the current variant
+	 * @returns {string | undefined} Reference of the current variant or undefined if VM does not exist
 	 */
 	VariantManagementState.getCurrentVariantReference = function(mPropertyBag) {
 		var oVariantManagementSection = oVariantManagementsDataSelector.get({
 			variantManagementReference: mPropertyBag.vmReference,
 			reference: mPropertyBag.reference
 		});
-		return oVariantManagementSection.currentVariant;
+		return oVariantManagementSection?.currentVariant;
+	};
+
+	/**
+	 * Returns the default variant reference for a given variant management reference.
+	 *
+	 * @param {object} mPropertyBag - Object with the necessary properties
+	 * @param {string} mPropertyBag.vmReference - Variant management reference
+	 * @param {string} mPropertyBag.reference - Component reference
+	 * @returns {string | undefined} Reference of the default variant or undefined if VM does not exist
+	 */
+	VariantManagementState.getDefaultVariantReference = function(mPropertyBag) {
+		const oVariantManagement = oVariantManagementsDataSelector.get({
+			variantManagementReference: mPropertyBag.vmReference,
+			reference: mPropertyBag.reference
+		});
+		return oVariantManagement?.defaultVariant;
 	};
 
 	/**
@@ -625,6 +642,24 @@ sap.ui.define([
 		return Object.keys(oVariantsMap);
 	};
 
+	/**
+	 * Returns the variant management reference for a given variant reference.
+	 *
+	 * @param {string} sReference - Flex reference of the current app
+	 * @param {string} sVariantReference - Variant reference to search for
+	 * @returns {string | undefined} Variant management reference if found, otherwise undefined
+	 */
+	VariantManagementState.getVariantManagementReferenceForVariant = function(sReference, sVariantReference) {
+		const oVariantsMap = oVariantManagementMapDataSelector.get({
+			reference: sReference
+		});
+		return Object.entries(oVariantsMap).find(([, oVM]) => {
+			return oVM.variants.some((oVariant) => {
+				return oVariant.key === sVariantReference;
+			});
+		})?.[0];
+	};
+
 	/**
 	 * Returns all variants saved in the FlexState.
 	 *
@@ -823,5 +858,12 @@ sap.ui.define([
 		return Promise.all(Object.values(mVariantSwitchPromises[sReference] || {}));
 	};
 
+	VariantManagementState.getVariantsForVariantManagement = function(mPropertyBag) {
+		const oVariantManagement = oVariantManagementsDataSelector.get({
+			variantManagementReference: mPropertyBag.vmReference,
+			reference: mPropertyBag.reference
+		});
+		return oVariantManagement?.variants || [];
+	};
 	return VariantManagementState;
 });

package/src/sap/ui/fl/apply/_internal/init.js

@@ -0,0 +1,47 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+	"sap/ui/fl/apply/_internal/DelegateMediator",
+	"sap/ui/fl/changeHandler/ChangeAnnotation",
+	"sap/ui/fl/initial/_internal/changeHandlers/ChangeHandlerRegistration"
+], function(
+	DelegateMediator,
+	ChangeAnnotation,
+	ChangeHandlerRegistration
+) {
+	"use strict";
+
+	/**
+	 * Initialization of the apply bundle - takes care of registering change handlers
+ 	 * This module must be loaded by every publicly used module of the apply bundle.
+	 *
+	 * @name sap.ui.fl.apply._internal.init
+	 * @author SAP SE
+	 * @version 1.141.1
+	 * @since 1.141.0
+	 * @private
+	 */
+	ChangeHandlerRegistration.registerPredefinedChangeHandlers();
+	ChangeHandlerRegistration.getChangeHandlersOfLoadedLibsAndRegisterOnNewLoadedLibs();
+	ChangeHandlerRegistration.registerAnnotationChangeHandler({
+		changeHandler: ChangeAnnotation,
+		isDefaultChangeHandler: true
+	});
+
+	DelegateMediator.registerReadDelegate({
+		modelType: "sap.ui.model.odata.v4.ODataModel",
+		delegate: "sap/ui/fl/write/_internal/delegates/ODataV4ReadDelegate"
+	});
+	DelegateMediator.registerReadDelegate({
+		modelType: "sap.ui.model.odata.v2.ODataModel",
+		delegate: "sap/ui/fl/write/_internal/delegates/ODataV2ReadDelegate"
+	});
+	DelegateMediator.registerReadDelegate({
+		modelType: "sap.ui.model.odata.ODataModel",
+		delegate: "sap/ui/fl/write/_internal/delegates/ODataV2ReadDelegate"
+	});
+});

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

@@ -241,6 +241,10 @@ sap.ui.define([
 		// the functionality still works without component Id, but the FlexState will be initialized again
 		// once the component Id is set. This will happen in the instanceCreated hook.
 		// This can only be improved once the generated component instance Id is available in the factory config
+		if (!oPropertyBag.factoryConfig) {
+			Log.error("Could not fetch Annotation changes. This can be caused by creating a component in an unsupported way");
+			return [];
+		}
 		const sAppComponentId = oPropertyBag.owner?.id || oPropertyBag.factoryConfig.id || oPropertyBag.factoryConfig.settings?.id;
 
 		const oComponentData = oOwnerComponent?.getComponentData()
@@ -265,11 +269,16 @@ sap.ui.define([
 
 			const aReturn = [];
 			for (const oAnnotationChange of aRelevantAnnotationChanges) {
-				const oChangeHandler = await ChangeHandlerRegistration.getAnnotationChangeHandler({
-					changeType: oAnnotationChange.getChangeType()
-				});
-				aReturn.push(await oChangeHandler.applyChange(oAnnotationChange));
-				oAnnotationChange._appliedOnModel = true;
+				try {
+					const oChangeHandler = await ChangeHandlerRegistration.getAnnotationChangeHandler({
+						changeType: oAnnotationChange.getChangeType()
+					});
+					aReturn.push(await oChangeHandler.applyChange(oAnnotationChange));
+					oAnnotationChange._appliedOnModel = true;
+				} catch (oError) {
+					// Continue with next change
+					Log.error(`Annotation change with id ${oAnnotationChange.getId()} could not be applied to the model`, oError);
+				}
 			}
 			return aReturn;
 		} catch (oError) {

package/src/sap/ui/fl/apply/api/AnnotationChangeHandlerAPI.js

@@ -5,7 +5,8 @@
  */
 
 sap.ui.define([
-	"sap/ui/fl/initial/_internal/changeHandlers/ChangeHandlerRegistration"
+	"sap/ui/fl/initial/_internal/changeHandlers/ChangeHandlerRegistration",
+	"sap/ui/fl/apply/_internal/init"
 ], function(
 	ChangeHandlerRegistration
 ) {