@openui5/sap.ui.fl 1.139.0 → 1.141.0

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

@@ -1,233 +0,0 @@
-/*!
- * 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/flexObjects/CompVariant",
-	"sap/ui/fl/apply/_internal/flexObjects/FlexObjectFactory",
-	"sap/ui/fl/apply/_internal/flexObjects/States",
-	"sap/ui/fl/apply/_internal/flexState/compVariants/Utils",
-	"sap/base/Log"
-], function(
-	CompVariant,
-	FlexObjectFactory,
-	States,
-	CompVariantUtils,
-	Log
-) {
-	"use strict";
-
-	var mChangeHandlers = {
-		addFavorite(oVariant) {
-			oVariant.setFavorite(true);
-		},
-		removeFavorite(oVariant) {
-			oVariant.setFavorite(false);
-		},
-		updateVariant(oVariant, oChange) {
-			var oChangeContent = oChange.getContent();
-			if (oChangeContent.executeOnSelection !== undefined) {
-				oVariant.setExecuteOnSelection(oChangeContent.executeOnSelection);
-			}
-			if (oChangeContent.favorite !== undefined) {
-				oVariant.setFavorite(oChangeContent.favorite);
-			}
-			if (oChangeContent.contexts) {
-				oVariant.setContexts(oChangeContent.contexts);
-			}
-			if (oChangeContent.visible !== undefined) {
-				oVariant.setVisible(oChangeContent.visible);
-			}
-
-			if (oChangeContent.variantContent) {
-				oVariant.setContent(oChangeContent.variantContent, /* bSkipStateChange = */ true);
-			}
-			var sVariantName = oChange.getText("variantName");
-			if (sVariantName) {
-				oVariant.setName(sVariantName, /* bSkipStateChange = */ true);
-			}
-		},
-		standardVariant(oVariant, oChange) {
-			// legacy change on standard variants
-			oVariant.setExecuteOnSelection(oChange.getContent().executeOnSelect);
-		}
-	};
-
-	function getChangesMappedByVariant(mCompVariants) {
-		var mChanges = {};
-
-		mCompVariants.changes.forEach(function(oChange) {
-			var sVariantId = oChange.getSelector().variantId || oChange.getContent().key;
-			mChanges[sVariantId] ||= [];
-
-			mChanges[sVariantId].push(oChange);
-		});
-
-		return mChanges;
-	}
-
-	function logNoChangeHandler(oVariant, oChange) {
-		Log.error(`No change handler for change with the ID '${oChange.getId()}' and type '${oChange.getChangeType()}' defined.
-			The variant '${oVariant.getId()}'was not modified'`);
-	}
-
-	function createVariant(sPersistencyKey, oVariantInput, mAuthors) {
-		var oVariantData = {
-			fileName: oVariantInput.fileName,
-			variantId: oVariantInput.id || CompVariant.STANDARD_VARIANT_ID,
-			persisted: oVariantInput.persisted,
-			content: oVariantInput.content || {},
-			texts: {
-				variantName: {
-					value: oVariantInput.name || ""
-				}
-			},
-			selector: {
-				persistencyKey: sPersistencyKey
-			}
-		};
-
-		if (oVariantInput.favorite !== undefined) {
-			oVariantData.favorite = oVariantInput.favorite;
-		}
-
-		if (oVariantInput.executeOnSelection !== undefined) {
-			oVariantData.executeOnSelection = oVariantInput.executeOnSelection;
-		}
-
-		if (oVariantInput.adaptationId !== undefined) {
-			oVariantData.adaptationId = oVariantInput.adaptationId;
-		}
-
-		return FlexObjectFactory.createCompVariant(oVariantData, mAuthors);
-	}
-
-	function applyChangeOnVariant(oVariant, oChange) {
-		var oChangeHandler = mChangeHandlers[oChange.getChangeType()] || logNoChangeHandler;
-		oChangeHandler(oVariant, oChange);
-		oVariant.addChange(oChange);
-	}
-
-	function applyChangesOnVariant(mChanges, oVariant) {
-		var sVariantId = oVariant.getVariantId();
-		if (mChanges[sVariantId]) {
-			mChanges[sVariantId].forEach(function(oChange) {
-				applyChangeOnVariant(oVariant, oChange);
-			});
-		}
-	}
-
-	/**
-	 * Class in charge of applying changes.
-	 * This includes combining the variants passed on the <code>merge</code> call, sorting and applying changes.
-	 *
-	 * @namespace sap.ui.fl.apply._internal.flexState.compVariants.CompVariantMerger
-	 * @since 1.86
-	 * @version 1.139.0
-	 * @private
-	 * @ui5-restricted sap.ui.fl
-	 */
-	return {
-		merge(sPersistencyKey, mCompData, oStandardVariantInput) {
-			var aVariants = mCompData.nonPersistedVariants.concat(mCompData.variants);
-			var mChanges = getChangesMappedByVariant(mCompData);
-
-			// check for an overwritten standard variant
-			var oStandardVariant;
-			aVariants.forEach(function(oVariant) {
-				if (oVariant.getContent() && oVariant.getContent().standardvariant) {
-					oStandardVariant = oVariant;
-				}
-			});
-
-			if (!oStandardVariant) {
-				// create a new standard variant with the passed input
-				oStandardVariant = createVariant(sPersistencyKey, oStandardVariantInput);
-			} else {
-				// remove all standard variant entries
-				aVariants = aVariants.filter(function(oVariant) {
-					return !oVariant.getContent() || !oVariant.getContent().standardvariant;
-				});
-			}
-
-			// with setting the state to persisted it is made sure that they not show up as a dirty flex object
-			(mCompData.nonPersistedVariants.concat([oStandardVariant])).forEach((oVariant) => {
-				oVariant.setState(States.LifecycleState.PERSISTED);
-			});
-
-			// apply all changes on non-standard variants
-			aVariants.forEach(applyChangesOnVariant.bind(undefined, mChanges));
-
-			// Remove all invisible variants
-			aVariants = aVariants.filter(function(oVariant) {
-				var bVisible = oVariant.getVisible();
-				if (!bVisible) {
-					var sVariantId = oVariant.getId();
-					delete mChanges[sVariantId];
-					delete mCompData.byId[sVariantId];
-				}
-				return bVisible;
-			});
-
-			// the standard must always be visible
-			oStandardVariant.setFavorite(true);
-			oStandardVariant.setStandardVariant(true);
-			mCompData.byId[oStandardVariant.getVariantId()] = oStandardVariant;
-
-			var oStandardVariantChange = mCompData.standardVariantChange;
-			if (oStandardVariantChange) {
-				mChanges[oStandardVariant.getVariantId()] = mChanges[oStandardVariant.getVariantId()] || [];
-				mChanges[oStandardVariant.getVariantId()].push(oStandardVariantChange);
-				mChanges[oStandardVariant.getVariantId()].sort(function(a, b) {
-					if (a.getCreation() < b.getCreation()) {
-						return -1;
-					}
-					if (a.getCreation() > b.getCreation()) {
-						return 1;
-					}
-					return 0;
-				});
-			}
-			applyChangesOnVariant(mChanges, oStandardVariant);
-
-			mCompData.standardVariant = oStandardVariant;
-
-			// the default variant must always be a favorite
-			// e.g. end user sets variant to default, then key user removes it from favorites
-			const sDefaultVariantId = CompVariantUtils.getDefaultVariantId(mCompData);
-			aVariants.some((oVariant) => {
-				if (!oVariant.getFavorite() && oVariant.getId() === sDefaultVariantId) {
-					oVariant.setFavorite(true);
-				}
-			});
-
-			return {
-				standardVariant: oStandardVariant,
-				variants: aVariants
-			};
-		},
-
-		/**
-		 * Enhances Standard Variants and non-persisted variants with additional properties and
-		 * creates a new CompVariant out of it.
-		 *
-		 * @function
-		 * @since 1.89
-		 * @version 1.139.0
-		 * @private
-		 * @ui5-restricted sap.ui.fl
-		 *
-		 * @param {string} sPersistencyKey - Key of the variant management
-		 * @param {object} oVariantInput - Standard Variant or non-persisted Variants like oData variant
-		 * @param {object} mAuthors - Map of user IDs to full names
-		 *
-		 * @returns {sap.ui.fl.apply._internal.flexObjects.CompVariant} The created variant object
-		 */
-		createVariant(sPersistencyKey, oVariantInput, mAuthors) {
-			return createVariant(sPersistencyKey, oVariantInput, mAuthors);
-		},
-		applyChangeOnVariant
-	};
-});

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

@@ -1,118 +0,0 @@
-/*!
- * 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/flexObjects/FlexObjectFactory",
-	"sap/ui/fl/apply/_internal/flexObjects/States",
-	"sap/ui/fl/apply/_internal/flexObjects/UpdatableChange",
-	"sap/ui/fl/apply/_internal/flexState/compVariants/CompVariantMerger"
-], function(
-	FlexObjectFactory,
-	States,
-	UpdatableChange,
-	CompVariantMerger
-) {
-	"use strict";
-
-	function getOrCreate(mMap, sPersistencyKey) {
-		mMap[sPersistencyKey] ||= {
-			byId: {},
-			variants: [],
-			nonPersistedVariants: [],
-			changes: [],
-			defaultVariants: [],
-			standardVariantChange: undefined,
-			standardVariant: undefined
-		};
-
-		return mMap[sPersistencyKey];
-	}
-
-	function initialize(mMap, mAuthors, sPersistencyKey, aVariants, sSVMControlId) {
-		aVariants ||= [];
-		const mMapOfKey = getOrCreate(mMap, sPersistencyKey);
-		mMapOfKey.controlId = sSVMControlId;
-
-		// clear all non-persisted variants in case of a reinitialization
-		mMapOfKey.nonPersistedVariants.forEach(function(oVariant) {
-			delete mMapOfKey.byId[oVariant.getId()];
-		});
-
-		mMapOfKey.nonPersistedVariants = aVariants.map(function(oVariant) {
-			const oVariantInstance = CompVariantMerger.createVariant(
-				sPersistencyKey,
-				{
-					id: oVariant.id,
-					persisted: false,
-					...oVariant
-				},
-				mAuthors
-			);
-			mMapOfKey.byId[oVariant.id] = oVariantInstance;
-			return oVariantInstance;
-		});
-
-		return mMapOfKey;
-	}
-
-	function buildSectionMap(mCompSection, sSubSection, mCompVariants, mAuthors) {
-		const aFlexObjects = mCompSection[sSubSection].map(function(oCompVariantChangeDefinition) {
-			const oFlexObject = sSubSection === "variants"
-				? FlexObjectFactory.createCompVariant(oCompVariantChangeDefinition, mAuthors)
-				: FlexObjectFactory.createFromFileContent(oCompVariantChangeDefinition, UpdatableChange);
-			oFlexObject.setState(States.LifecycleState.PERSISTED); // prevent persisting these anew
-			return oFlexObject;
-		});
-
-		aFlexObjects.forEach(function(oFlexObject) {
-			const sPersistencyKey = oFlexObject.getPersistencyKey
-				? oFlexObject.getPersistencyKey()
-				: oFlexObject.getSelector().persistencyKey;
-			getOrCreate(
-				mCompVariants,
-				sPersistencyKey
-			).byId[oFlexObject.getId()] = oFlexObject;
-
-			switch (sSubSection) {
-				case "standardVariants":
-					getOrCreate(mCompVariants, sPersistencyKey).standardVariantChange = oFlexObject;
-					break;
-				default:
-					getOrCreate(mCompVariants, sPersistencyKey)[sSubSection].push(oFlexObject);
-			}
-		});
-	}
-
-	/**
-	 * Prepares the CompVariants from the flex response.
-	 *
-	 * @function
-	 * @since 1.83
-	 * @private
-	 * @ui5-restricted sap/ui/fl/apply/_internal/flexState/FlexState
-	 * @alias module:sap/ui/fl/apply/_internal/flexState/compVariants/prepareCompVariantsMap
-	 *
-	 * @param {object} mPropertyBag - Contains additional data needed for preparing the map
-	 * @param {object} mPropertyBag.storageResponse - Storage response with the flex data
-	 * @returns {object} The prepared map for compVariants
-	 */
-	return function(mPropertyBag) {
-		const mCompVariants = {};
-
-		// provide the function for fl-internal consumers reuse
-		mCompVariants._getOrCreate = getOrCreate.bind(undefined, mCompVariants);
-		mCompVariants._initialize = initialize.bind(undefined, mCompVariants, mPropertyBag.storageResponse.authors);
-
-		// check for the existence due to test mocks
-		if (mPropertyBag.storageResponse.changes.comp) {
-			["variants", "changes", "defaultVariants", "standardVariants"].forEach(function(sSection) {
-				buildSectionMap(mPropertyBag.storageResponse.changes.comp, sSection, mCompVariants, mPropertyBag.storageResponse.authors);
-			});
-		}
-
-		return mCompVariants;
-	};
-});

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

@@ -1,79 +0,0 @@
-/*!
- * 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/base/BindingInfo",
-	"sap/ui/base/ManagedObject",
-	"sap/ui/fl/Utils"
-], function(
-	BindingInfo,
-	ManagedObject,
-	FlUtils
-) {
-	"use strict";
-
-	// Helper class to resolve bindings
-	var HelperControl = ManagedObject.extend("sap.ui.fl.util.HelperControl", {
-		metadata: {
-			library: "sap.ui.fl",
-			properties: {
-				resolved: {
-					type: "any"
-				}
-			}
-		}
-	});
-
-	/**
-	 * Resolves bindings synchronously by copying model and binding context information
-	 * from a given reference control.
-	 *
-	 * @param {object|string} vValue - Binding string or binding object
-	 * @param {sap.ui.core.Control} oReferenceControl - Control to copy binding information from
-	 * @returns {any} - Resolved value
-	 *
-	 * @function
-	 * @author SAP SE
-	 * @version 1.139.0
-	 * @alias sap.ui.fl.util.resolveBinding
-	 * @since 1.91
-	 * @private
-	 * @ui5-restricted sap.ui.fl, sap.ui.rta, sap.ui.dt
-	 */
-	return function(vValue, oReferenceControl) {
-		const oView = FlUtils.getViewForControl(oReferenceControl);
-		const oController = oView && oView.getController();
-		if (!FlUtils.isBinding(vValue, oController)) {
-			return undefined;
-		}
-		const oBindingInfo = typeof vValue === "string"
-			? BindingInfo.parse(vValue, oController)
-			: { ...vValue };
-
-		if (!oBindingInfo) {
-			return undefined;
-		}
-
-		const oHelperControl = new HelperControl();
-
-		const aParts = oBindingInfo.parts || [oBindingInfo];
-		aParts.forEach(function(oBindingPart) {
-			const sModelName = oBindingPart.model;
-			if (sModelName) {
-				oHelperControl.setModel(oReferenceControl.getModel(sModelName), sModelName);
-				oHelperControl.setBindingContext(oReferenceControl.getBindingContext(sModelName), sModelName);
-			} else {
-				oHelperControl.setModel(oReferenceControl.getModel());
-				oHelperControl.setBindingContext(oReferenceControl.getBindingContext());
-			}
-		});
-
-		oHelperControl.bindProperty("resolved", oBindingInfo);
-		const vResolvedValue = oHelperControl.getResolved();
-		oHelperControl.destroy();
-
-		return vResolvedValue;
-	};
-});