@openui5/sap.ui.rta 1.131.1 → 1.132.1

package/src/sap/ui/rta/plugin/additionalElements/CommandBuilder.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.
  */
 
@@ -25,14 +25,14 @@ sap.ui.define([
 	 * Helper object to build the RTA commands resulting from the AdditionalElements Plugin
 	 *
 	 * @author SAP SE
-	 * @version 1.131.1
+	 * @version 1.132.1
 	 * @private
 	 * @since 1.94
 	 */
-	var CommandBuilder = {};
+	const CommandBuilder = {};
 
 	function getRevealDataFromActions(mActions, oRevealedElement) {
-		var mRevealData;
+		let mRevealData;
 		mActions.reveal.elements.some(function(mElement) {
 			if (mElement.element.getId() === oRevealedElement.getId()) {
 				mRevealData = mElement;
@@ -44,81 +44,62 @@ sap.ui.define([
 		return mRevealData;
 	}
 
-	function createCommandsForInvisibleElement(mPropertyBag) {
-		var oCompositeCommand = mPropertyBag.compositeCommand;
-		var oSelectedElement = mPropertyBag.selectedElement;
-		var mParents = mPropertyBag.parents;
-		var oSiblingElement = mPropertyBag.siblingElement;
-		var mActions = mPropertyBag.actions;
-		var iIndex = mPropertyBag.index;
-		var sTargetAggregation = mPropertyBag.targetAggregation;
-		var oPlugin = mPropertyBag.plugin;
-		return createRevealCommandForInvisible(oSelectedElement, mActions, mParents, oPlugin)
-		.then(function(oRevealCommandForInvisible) {
-			oCompositeCommand.addCommand(oRevealCommandForInvisible);
-			return createMoveCommandForInvisible(oSelectedElement, mParents, oSiblingElement, iIndex, sTargetAggregation, oPlugin);
-		})
-		.then(function(oMoveCommandForInvisible) {
-			if (oMoveCommandForInvisible) {
-				oCompositeCommand.addCommand(oMoveCommandForInvisible);
-			} else {
-				Log.warning(`No move action configured for ${
-						 mParents.parent.getMetadata().getName()
-						 }, aggregation: ${oSelectedElement.aggregation}`, "sap.ui.rta");
-			}
-			return oCompositeCommand;
-		});
+	async function createCommandsForInvisibleElement(mPropertyBag) {
+		const oRevealCommandForInvisible = await createRevealCommandForInvisible(
+			mPropertyBag.selectedElement, mPropertyBag.actions, mPropertyBag.parents, mPropertyBag.plugin
+		);
+		mPropertyBag.compositeCommand.addCommand(oRevealCommandForInvisible);
+		const oMoveCommandForInvisible = await createMoveCommandForInvisible(
+			mPropertyBag.selectedElement, mPropertyBag.parents, mPropertyBag.siblingElement,
+			mPropertyBag.index, mPropertyBag.targetAggregation, mPropertyBag.plugin
+		);
+		if (oMoveCommandForInvisible) {
+			mPropertyBag.compositeCommand.addCommand(oMoveCommandForInvisible);
+		} else {
+			Log.warning(
+				`No move action configured for ${mPropertyBag.parents.parent.getMetadata().getName()}, aggregation: ${mPropertyBag.selectedElement.aggregation}`,
+				"sap.ui.rta"
+			);
+		}
+		return mPropertyBag.compositeCommand;
 	}
 
 	function createRevealCommandForInvisible(mSelectedElement, mActions, mParents, oPlugin) {
-		var oRevealedElement = ElementUtil.getElementInstance(mSelectedElement.elementId);
-		var oRevealedElementOverlay = OverlayRegistry.getOverlay(oRevealedElement);
-		var mRevealData = getRevealDataFromActions(mActions, oRevealedElement);
+		const oRevealedElement = ElementUtil.getElementInstance(mSelectedElement.elementId);
+		const oRevealedElementOverlay = OverlayRegistry.getOverlay(oRevealedElement);
+		const mRevealData = getRevealDataFromActions(mActions, oRevealedElement);
 
-		var oDesignTimeMetadata = mRevealData.designTimeMetadata;
-		var oRevealAction = mRevealData.action;
+		const sVMReference = oRevealedElementOverlay ? oPlugin.getVariantManagementReference(oRevealedElementOverlay) : undefined;
 
-		var sVariantManagementReference;
-		if (oRevealedElementOverlay) {
-			sVariantManagementReference = oPlugin.getVariantManagementReference(oRevealedElementOverlay);
-		}
-
-		if (oRevealAction.changeOnRelevantContainer) {
+		if (mRevealData.action.changeOnRelevantContainer) {
 			return oPlugin.getCommandFactory().getCommandFor(oRevealedElement, "reveal", {
 				revealedElementId: oRevealedElement.getId(),
 				directParent: mParents.parent
-			}, oDesignTimeMetadata, sVariantManagementReference);
+			}, mRevealData.designTimeMetadata, sVMReference);
 		}
-		return oPlugin.getCommandFactory().getCommandFor(
-			oRevealedElement,
-			"reveal",
-			{ },
-			oDesignTimeMetadata,
-			sVariantManagementReference
-		);
+		return oPlugin.getCommandFactory().getCommandFor(oRevealedElement, "reveal", {}, mRevealData.designTimeMetadata, sVMReference);
 	}
 
 	function createMoveCommandForInvisible(oSelectedElement, mParents, oSiblingElement, iIndex, sTargetAggregationName, oPlugin) {
-		var oRevealedElement = ElementUtil.getElementInstance(oSelectedElement.elementId);
-		var oRevealedElementOverlay = OverlayRegistry.getOverlay(oRevealedElement);
+		const oRevealedElement = ElementUtil.getElementInstance(oSelectedElement.elementId);
+		const oRevealedElementOverlay = OverlayRegistry.getOverlay(oRevealedElement);
 		// Elements can also be moved between aggregations inside the parent
-		var sSourceAggregationName = oSelectedElement.sourceAggregation;
-		var oSourceParent = oRevealedElementOverlay.getParentElementOverlay().getElement() || mParents.parent;
-		var oTargetParent = mParents.parent;
-		var iRevealTargetIndex = Utils.getIndex(mParents.parent, oSiblingElement, sTargetAggregationName);
-		var iRevealedSourceIndex = Utils.getIndex(oSourceParent, oRevealedElement, sSourceAggregationName) - 1;
+		const oSourceParent = oRevealedElementOverlay.getParentElementOverlay().getElement() || mParents.parent;
+		const iTempRevealTargetIndex = Utils.getIndex(mParents.parent, oSiblingElement, sTargetAggregationName);
+		const iRevealedSourceIndex = Utils.getIndex(oSourceParent, oRevealedElement, oSelectedElement.sourceAggregation) - 1;
 
-		iRevealTargetIndex = iIndex !== undefined ?
-			iIndex : ElementUtil.adjustIndexForMove(oSourceParent, oTargetParent, iRevealedSourceIndex, iRevealTargetIndex);
+		const iRevealTargetIndex = iIndex !== undefined ?
+			iIndex : ElementUtil.adjustIndexForMove(oSourceParent, mParents.parent, iRevealedSourceIndex, iTempRevealTargetIndex);
 
-		if (iRevealTargetIndex !== iRevealedSourceIndex
+		if (
+			iRevealTargetIndex !== iRevealedSourceIndex
 			|| mParents.parent !== oRevealedElement.getParent()
-			|| sSourceAggregationName !== sTargetAggregationName
+			|| oSelectedElement.sourceAggregation !== sTargetAggregationName
 		) {
-			var oSourceParentOverlay = OverlayRegistry.getOverlay(oRevealedElement) ?
+			const oSourceParentOverlay = OverlayRegistry.getOverlay(oRevealedElement) ?
 				OverlayRegistry.getOverlay(oRevealedElement).getParentAggregationOverlay() : mParents.relevantContainerOverlay;
-			var SourceParentDesignTimeMetadata = oSourceParentOverlay.getDesignTimeMetadata();
-			var sVariantManagementReference = oPlugin.getVariantManagementReference(oRevealedElementOverlay);
+			const oSourceParentDesignTimeMetadata = oSourceParentOverlay.getDesignTimeMetadata();
+			const sVariantManagementReference = oPlugin.getVariantManagementReference(oRevealedElementOverlay);
 
 			return oPlugin.getCommandFactory().getCommandFor(mParents.relevantContainer, "move", {
 				movedElements: [{
@@ -128,19 +109,19 @@ sap.ui.define([
 				}],
 				source: {
 					parent: oSourceParent,
-					aggregation: sSourceAggregationName
+					aggregation: oSelectedElement.sourceAggregation
 				},
 				target: {
-					parent: oTargetParent,
+					parent: mParents.parent,
 					aggregation: sTargetAggregationName
 				}
-			}, SourceParentDesignTimeMetadata, sVariantManagementReference);
+			}, oSourceParentDesignTimeMetadata, sVariantManagementReference);
 		}
 		return Promise.resolve();
 	}
 
 	function areLibDependenciesMissing(oComponent, mRequiredLibraries) {
-		var mAppsLibDependencies = oComponent.getManifestEntry("/sap.ui5/dependencies/libs");
+		const mAppsLibDependencies = oComponent.getManifestEntry("/sap.ui5/dependencies/libs");
 		return Object.keys(mRequiredLibraries).some(function(sRequiredLib) {
 			return !mAppsLibDependencies[sRequiredLib] || mAppsLibDependencies[sRequiredLib].lazy;
 		});
@@ -148,11 +129,10 @@ sap.ui.define([
 
 	function createCommandForAddLibrary(mParents, mRequiredLibraries, oParentAggregationDTMetadata, oPlugin) {
 		if (mRequiredLibraries) {
-			var oComponent = FlUtils.getAppComponentForControl(mParents.relevantContainer);
-			var bLibsMissing = areLibDependenciesMissing(oComponent, mRequiredLibraries);
-			if (bLibsMissing) {
-				var mManifest = oComponent.getManifest();
-				var sReference = mManifest["sap.app"].id;
+			const oComponent = FlUtils.getAppComponentForControl(mParents.relevantContainer);
+			if (areLibDependenciesMissing(oComponent, mRequiredLibraries)) {
+				const mManifest = oComponent.getManifest();
+				const sReference = mManifest["sap.app"].id;
 				return oPlugin.getCommandFactory().getCommandFor(mParents.publicParent, "addLibrary", {
 					reference: sReference,
 					parameters: { libraries: mRequiredLibraries },
@@ -163,36 +143,28 @@ sap.ui.define([
 		return Promise.resolve();
 	}
 
-	function createCommandsForAddViaDelegate(mPropertyBag) {
-		var oCompositeCommand = mPropertyBag.compositeCommand;
-		var mAddViaDelegateAction = mPropertyBag.actions.addViaDelegate.action;
-		var mRequiredLibraries = mAddViaDelegateAction.delegateInfo.requiredLibraries;
-		var oParentAggregationOverlay = mPropertyBag.parents.parentOverlay.getAggregationOverlay(mPropertyBag.actions.aggregation);
-		var oParentAggregationDTMetadata = oParentAggregationOverlay.getDesignTimeMetadata();
-		return createCommandForAddLibrary(mPropertyBag.parents, mRequiredLibraries, oParentAggregationDTMetadata, mPropertyBag.plugin)
-		.then(function(oCommandForAddLibrary) {
-			if (oCommandForAddLibrary) {
-				oCompositeCommand.addCommand(oCommandForAddLibrary);
-			}
-			return createAddViaDelegateCommand(mPropertyBag, oParentAggregationDTMetadata);
-		})
-		.then(function(oAddViaDelegateCommand) {
-			if (oAddViaDelegateCommand) {
-				oCompositeCommand.addCommand(oAddViaDelegateCommand);
-			}
-			return oCompositeCommand;
-		});
+	async function createCommandsForAddViaDelegate(mPropertyBag) {
+		const mAddViaDelegateAction = mPropertyBag.actions.addViaDelegate.action;
+		const oParentAggregationOverlay = mPropertyBag.parents.parentOverlay.getAggregationOverlay(mPropertyBag.actions.aggregation);
+		const oParentAggregationDTMetadata = oParentAggregationOverlay.getDesignTimeMetadata();
+		const oCommandForAddLibrary = await createCommandForAddLibrary(
+			mPropertyBag.parents, mAddViaDelegateAction.delegateInfo.requiredLibraries, oParentAggregationDTMetadata, mPropertyBag.plugin
+		);
+		if (oCommandForAddLibrary) {
+			mPropertyBag.compositeCommand.addCommand(oCommandForAddLibrary);
+		}
+		const oAddViaDelegateCommand = await createAddViaDelegateCommand(mPropertyBag, oParentAggregationDTMetadata);
+		if (oAddViaDelegateCommand) {
+			mPropertyBag.compositeCommand.addCommand(oAddViaDelegateCommand);
+		}
+		return mPropertyBag.compositeCommand;
 	}
 
 	function getODataServiceUriFromManifest(oManifest) {
-		var sUri = "";
+		let sUri = "";
 		if (oManifest) {
-			var oSapApp = oManifest.getEntry ? oManifest.getEntry("sap.app") : oManifest["sap.app"];
-			if (
-				oSapApp && oSapApp.dataSources
-				&& oSapApp.dataSources.mainService
-				&& oSapApp.dataSources.mainService.uri
-			) {
+			const oSapApp = oManifest.getEntry ? oManifest.getEntry("sap.app") : oManifest["sap.app"];
+			if (oSapApp?.dataSources?.mainService?.uri) {
 				sUri = oSapApp.dataSources.mainService.uri;
 			}
 		}
@@ -204,33 +176,26 @@ sap.ui.define([
 	}
 
 	function createAddViaDelegateCommand(mPropertyBag, oParentAggregationDTMetadata) {
-		var oSelectedElement = mPropertyBag.selectedElement;
-		var mParents = mPropertyBag.parents;
-		var oSiblingElement = mPropertyBag.siblingElement;
-		var mActions = mPropertyBag.actions;
-		var iIndex = mPropertyBag.index;
-		var oPlugin = mPropertyBag.plugin;
-		var mAddViaDelegateAction = mActions.addViaDelegate.action;
-		var oParent = mAddViaDelegateAction.changeOnRelevantContainer ? mParents.relevantContainer : mParents.parent;
-		var oParentOverlay = mAddViaDelegateAction.changeOnRelevantContainer ? mParents.relevantContainerOverlay : mParents.parentOverlay;
-		var sVariantManagementReference = oPlugin.getVariantManagementReference(oParentOverlay);
-		var iAddTargetIndex = Utils.getIndex(mParents.parent, oSiblingElement, mActions.aggregation, oParentAggregationDTMetadata.getData().getIndex);
-		var sCommandName = "addDelegateProperty";
-		var oManifest = FlUtils.getAppComponentForControl(mParents.parent).getManifest();
-		var sServiceUri = getODataServiceUriFromManifest(oManifest);
+		const mParents = mPropertyBag.parents;
+		const mAddViaDelegateAction = mPropertyBag.actions.addViaDelegate.action;
+		const oParent = mAddViaDelegateAction.changeOnRelevantContainer ? mParents.relevantContainer : mParents.parent;
+		const oParentOverlay = mAddViaDelegateAction.changeOnRelevantContainer ? mParents.relevantContainerOverlay : mParents.parentOverlay;
+		const iAddTargetIndex = Utils.getIndex(
+			mParents.parent, mPropertyBag.siblingElement, mPropertyBag.actions.aggregation, oParentAggregationDTMetadata.getData().getIndex
+		);
 
-		return oPlugin.getCommandFactory().getCommandFor(mParents.parent, sCommandName, {
-			newControlId: createFieldLabelId(oParent, oSelectedElement.entityType, oSelectedElement.bindingPath),
-			index: iIndex !== undefined ? iIndex : iAddTargetIndex,
-			bindingString: oSelectedElement.bindingPath,
-			entityType: oSelectedElement.entityType, // needed for custom field support tool
+		return mPropertyBag.plugin.getCommandFactory().getCommandFor(mParents.parent, "addDelegateProperty", {
+			newControlId: createFieldLabelId(oParent, mPropertyBag.selectedElement.entityType, mPropertyBag.selectedElement.bindingPath),
+			index: mPropertyBag.index !== undefined ? mPropertyBag.index : iAddTargetIndex,
+			bindingString: mPropertyBag.selectedElement.bindingPath,
+			entityType: mPropertyBag.selectedElement.entityType, // needed for custom field support tool
 			parentId: mParents.parent.getId(),
-			propertyName: oSelectedElement.name,
-			oDataServiceVersion: oSelectedElement.oDataServiceVersion,
-			oDataServiceUri: sServiceUri,
+			propertyName: mPropertyBag.selectedElement.name,
+			oDataServiceVersion: mPropertyBag.selectedElement.oDataServiceVersion,
+			oDataServiceUri: getODataServiceUriFromManifest(FlUtils.getAppComponentForControl(mParents.parent).getManifest()),
 			modelType: mAddViaDelegateAction.delegateInfo.modelType,
 			relevantContainerId: mParents.relevantContainer.getId()
-		}, oParentAggregationDTMetadata, sVariantManagementReference);
+		}, oParentAggregationDTMetadata, mPropertyBag.plugin.getVariantManagementReference(oParentOverlay));
 	}
 
 	/**
@@ -242,9 +207,9 @@ sap.ui.define([
 	 * @param {Array<sap.ui.core.Element>} aSelectedElements - Selected elements when the action was triggered
 	 * @param {string} sTargetAggregation - The aggregation where the element is being inserted
 	 * @param {sap.ui.rta.plugin.additionalElements.AdditionalElementsPlugin} oPlugin - Instance of the AdditionalElementsPlugin
-	 * @returns {Promise} Resolving when the commands are created
+	 * @returns {Promise<undefined>} Resolves when the commands are created
 	 */
-	CommandBuilder.createCommands = function(mParents, oSiblingElement, mActions, iIndex, aSelectedElements, sTargetAggregation, oPlugin) {
+	CommandBuilder.createCommands = async function(mParents, oSiblingElement, mActions, iIndex, aSelectedElements, sTargetAggregation, oPlugin) {
 		// sort elements by label in descending order. When added the fields will be in ascending order on the UI
 		aSelectedElements.sort(function(oElement1, oElement2) {
 			if (oElement1.label > oElement2.label) {
@@ -257,12 +222,10 @@ sap.ui.define([
 		});
 
 		if (aSelectedElements.length > 0) {
-			return oPlugin.getCommandFactory().getCommandFor(mParents.parent, "composite")
-
-			.then(function(oCompositeCommand) {
-				var oPromise = Promise.resolve();
-				aSelectedElements.forEach(function(oSelectedElement) {
-					var mPropertyBag = {
+			try {
+				const oCompositeCommand = await oPlugin.getCommandFactory().getCommandFor(mParents.parent, "composite");
+				for (const oSelectedElement of aSelectedElements) {
+					const mPropertyBag = {
 						compositeCommand: oCompositeCommand,
 						selectedElement: oSelectedElement,
 						parents: mParents,
@@ -274,36 +237,28 @@ sap.ui.define([
 					};
 					switch (oSelectedElement.type) {
 						case "invisible":
-							oPromise = oPromise.then(
-								createCommandsForInvisibleElement.bind(this, mPropertyBag));
+							await createCommandsForInvisibleElement(mPropertyBag);
 							break;
 						case "delegate":
-							oPromise = oPromise.then(
-								createCommandsForAddViaDelegate.bind(this, mPropertyBag));
+							await createCommandsForAddViaDelegate(mPropertyBag);
 							break;
 						default:
 							Log.error(`Can't create command for untreated element.type ${oSelectedElement.type}`);
 					}
-				}, this);
-				return oPromise.then(function() { return oCompositeCommand; });
-			}.bind(this))
+				}
 
-			.then(function(oCompositeCommand) {
 				oPlugin.fireElementModified({
 					command: oCompositeCommand
 				});
-			})
-
-			.catch(function(vMessage) {
+			} catch (oError) {
 				throw DtUtils.propagateError(
-					vMessage,
+					oError,
 					"AdditionalElementsPlugin#_createCommands",
 					"Error occurred during _createCommands execution",
 					"sap.ui.rta.plugin"
 				);
-			});
+			}
 		}
-		return Promise.resolve();
 	};
 
 	return CommandBuilder;

package/src/sap/ui/rta/plugin/annotations/AnnotationChangeDialog.fragment.xml

@@ -0,0 +1,112 @@
+<core:FragmentDefinition
+	xmlns:core="sap.ui.core"
+	xmlns:f="sap.ui.layout.form"
+	xmlns="sap.m"
+>
+	<Dialog
+		id="sapUiRtaChangeAnnotationDialog"
+		verticalScrolling="true"
+		resizable="false"
+		draggable="true"
+		contentWidth="50rem"
+		contentHeight="25rem"
+	>
+		<customHeader>
+			<Bar>
+				<contentLeft>
+					<Label
+						id="sapUiRtaChangeAnnotationDialog_title"
+						class="sapUiSmallMargin"
+						text="{/title}"/>
+				</contentLeft>
+				<contentRight>
+					<Button
+						id="sapUiRtaChangeAnnotationDialog_toggleShowAllPropertiesButton"
+						class="sapUiSmallMargin"
+						text="{= ${/showChangedPropertiesOnly} ? ${i18n>ANNOTATION_CHANGE_DIALOG_BUTTON_ALL_PROPERTIES} : ${i18n>ANNOTATION_CHANGE_DIALOG_BUTTON_CHANGED_PROPERTIES}}"
+						press="switchDisplayMode"/>
+				</contentRight>
+			</Bar>
+		</customHeader>
+		<content>
+			<VBox>
+				<MessageStrip
+					text="{i18n>ANNOTATION_CHANGE_DIALOG_WARNING}"
+					type="Warning"
+					showIcon="true"
+					class="sapUiSmallMarginBottom">
+					<link>
+						<Link text="{i18n>ANNOTATION_CHANGE_DIALOG_WARNING_MORE_INFO}"
+							target="_blank"
+							href=""/> <!-- TODO: Change link once the docs are available -->
+					</link>
+				</MessageStrip>
+				<Label
+					id="sapUiRtaChangeAnnotationDialog_description"
+					visible="{= ${/description}.length > 0}"
+					text="{/description}"/>
+				<SearchField
+					id="sapUiRtaChangeAnnotationDialog_propertiesFilter"
+					placeholder="{i18n>ANNOTATION_CHANGE_DIALOG_PROPERTY_SEARCH}"
+					width="100%"
+					value="{/filterText}"
+					liveChange="onFilterProperties"/>
+				<f:Form editable="false">
+					<f:layout>
+						<f:ResponsiveGridLayout
+							labelSpanXL="3"
+							labelSpanL="3"
+							labelSpanM="3"
+							labelSpanS="12"
+							adjustLabelSpan="false"
+							emptySpanXL="4"
+							emptySpanL="4"
+							emptySpanM="4"
+							emptySpanS="0"
+							columnsXL="1"
+							columnsL="1"
+							columnsM="1"
+							singleContainerFullSize="false"/>
+					</f:layout>
+					<f:FormContainer
+						id="sapUiRtaChangeAnnotationDialog_propertyList"
+						formElements="{path: '/propertiesToDisplay', templateShareable: false}">
+						<f:FormElement label="{propertyName}">
+							<Select
+								visible="{path: '/valueType', formatter: '.formatters.isValueList'}"
+								selectedKey="{currentValue}"
+								change="onValueListChange"
+								items="{path: '/possibleValues', templateShareable: false}">
+								<core:Item key="{key}" text="{text}" />
+							</Select>
+							<Input
+								visible="{path: '/valueType', formatter: '.formatters.isString'}"
+								value="{currentValue}"
+								change="onStringChange"/>
+							<CheckBox
+								visible="{path: '/valueType', formatter: '.formatters.isBoolean'}"
+								selected="{=!!${currentValue}}"
+								select="onBooleanChange"/>
+						</f:FormElement>
+					</f:FormContainer>
+				</f:Form>
+			</VBox>
+		</content>
+		<beginButton>
+			<Button
+				id="sapUiRtaChangeAnnotationDialog_saveButton"
+				type="Emphasized"
+				text="{i18n>ANNOTATION_CHANGE_DIALOG_SAVE}"
+				press="onSavePress"
+			/>
+		</beginButton>
+		<endButton>
+			<Button
+				id="sapUiRtaChangeAnnotationDialog_cancelButton"
+				type="Transparent"
+				text="{i18n>ANNOTATION_CHANGE_DIALOG_CANCEL}"
+				press="onCancelPress"
+			/>
+		</endButton>
+	</Dialog>
+</core:FragmentDefinition>

package/src/sap/ui/rta/plugin/annotations/AnnotationChangeDialog.js

@@ -0,0 +1,183 @@
+
+/*!
+ * 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/ui/base/ManagedObject",
+	"sap/ui/core/Fragment",
+	"sap/ui/fl/apply/api/FlexRuntimeInfoAPI",
+	"sap/ui/fl/write/api/PersistenceWriteAPI",
+	"sap/ui/model/json/JSONModel",
+	"sap/ui/model/resource/ResourceModel",
+	"sap/ui/rta/plugin/annotations/AnnotationChangeDialogController"
+], function(
+	ManagedObject,
+	Fragment,
+	FlexRuntimeInfoAPI,
+	PersistenceWriteAPI,
+	JSONModel,
+	ResourceModel,
+	AnnotationChangeDialogController
+) {
+	"use strict";
+
+	/**
+	 * @class Constructor for a new sap.ui.rta.plugin.annotations.AnnotationChangeDialog.
+	 * @extends sap.ui.base.ManagedObject
+	 * @author SAP SE
+	 * @version 1.132.1
+	 * @constructor
+	 * @since 1.132
+	 * @private
+	 * @ui5-restricted sap.ui.rta
+	 */
+	const AnnotationChangeDialog = ManagedObject.extend("sap.ui.rta.plugin.annotations.AnnotationChangeDialog");
+
+	AnnotationChangeDialog.prototype._createDialog = async function() {
+		this._oController = new AnnotationChangeDialogController();
+		const oPopover = await Fragment.load({
+			name: "sap.ui.rta.plugin.annotations.AnnotationChangeDialog",
+			controller: this._oController
+		});
+		this.oChangeAnnotationModel = new JSONModel();
+		oPopover.setModel(this.oChangeAnnotationModel);
+		const oI18nModel = new ResourceModel({ bundleName: "sap.ui.rta.messagebundle" });
+		oPopover.setModel(oI18nModel, "i18n");
+		return oPopover;
+	};
+
+	AnnotationChangeDialog.prototype._openDialog = function() {
+		this._oPopover.open();
+		return this._oController.initialize();
+	};
+
+	/**
+	 * Annotation change info
+	 *
+	 * @typedef {object} sap.ui.rta.plugin.annotations.AnnotationChangeInfo
+	 * @property {string} serviceUrl - Url of the OData service
+	 * @property {object[]} properties - Array of properties
+	 * @property {string} properties.annotationPath - Path of the property
+	 * @property {string} properties.propertyName - Name of the property
+	 * @property {string} properties.currentValue - Current value of the property
+	 * @property {object[]} possibleValues - Array of possible values for value list type properties
+	 * @property {string} possibleValues.key - Key of the option
+	 * @property {string} possibleValues.text - Text of the option
+	 * @property {string} [preSelectedProperty] - Name of the property that should be filtered for initially
+	 * @private
+	 * @ui5-restricted
+	 */
+
+	/**
+	 * @callback  sap.ui.rta.plugin.annotations.getAnnotationChangeInfo
+	 * @property {sap.ui.core.Control} oControl - Control for which the annotation change is made
+	 * @property {string} sAnnotation - Annotation name
+	 * @returns {sap.ui.rta.plugin.annotations.AnnotationChangeInfo} - Annotation change info
+	 * @private
+	 * @ui5-restricted
+	 */
+
+	/**
+	 * Annotation change definition
+	 *
+	 * @typedef {object} sap.ui.rta.plugin.annotations.AnnotationChangeDefinition
+	 * @property {string} annotationChangeType - Change type
+	 * @property {object} content - Change content
+	 * @property {string} content.annotationPath - Path of the property
+	 * @property {string} content.value - New value
+	 * @property {string} serviceUrl - Url of the OData service
+	 * @private
+	 * @ui5-restricted
+	 */
+
+	/**
+	 * Opens the annotation change dialog and returns the changes made by the user.
+	 *
+	 * @param {object} mPropertyBag - Property bag
+	 * @param {string} mPropertyBag.title - Title of the dialog
+	 * @param {string} mPropertyBag.type - Value type of the annotation, see {@link sap.ui.rta.plugin.annotations.AnnotationTypes}
+	 * @param {object} mPropertyBag.delegate - Annotation change info provider delegate
+	 * @param {sap.ui.rta.plugin.annotations.getAnnotationChangeInfo} mPropertyBag.delegate.getAnnotationsChangeInfo - Delegate function to get annotation change info
+	 * @param {sap.ui.core.Control} mPropertyBag.control - Control for which the annotation change is made
+	 * @param {string} mPropertyBag.annotation - Annotation name
+	 * @param {string} [mPropertyBag.description] - Description of the dialog
+	 * @returns {Promise<sap.ui.rta.plugin.annotations.AnnotationChangeDefinition[]>} - Array of changes made by the user
+	 */
+	AnnotationChangeDialog.prototype.openDialogAndHandleChanges = async function(mPropertyBag) {
+		const {
+			title: sAnnotationTitle,
+			type: sAnnotationValueType,
+			delegate: oDelegate,
+			control: oControl,
+			annotation: sAnnotation,
+			description: sAnnotationDescription = ""
+		} = mPropertyBag;
+		const {
+			serviceUrl: sServiceUrl,
+			properties: aProperties,
+			possibleValues: aPossibleValues,
+			preSelectedProperty: sPreSelectedPropertyKey
+		} = oDelegate.getAnnotationsChangeInfo(oControl, sAnnotation);
+
+		const aExistingChanges = PersistenceWriteAPI._getAnnotationChanges({
+			control: oControl
+		});
+		const aChangedAnnotations = aExistingChanges
+		.map((oChange) => {
+			return oChange.getContent().annotationPath;
+		});
+
+		this._oPopover ||= await this._createDialog();
+
+		const oOriginalProperties = {};
+		aProperties.forEach(({ annotationPath, currentValue }) => {
+			oOriginalProperties[annotationPath] = currentValue;
+		});
+
+		const sFilterText = sPreSelectedPropertyKey
+			? aProperties.find((oProperty) => oProperty.annotationPath === sPreSelectedPropertyKey).propertyName
+			: "";
+		this.oChangeAnnotationModel.setData({
+			title: sAnnotationTitle,
+			description: sAnnotationDescription,
+			properties: aProperties, // all properties
+			changedProperties: aProperties.filter(({ annotationPath }) => aChangedAnnotations.includes(annotationPath)),
+			propertiesToDisplay: aProperties, // switches dynamcially between all properties and changed properties
+			showChangedPropertiesOnly: false,
+			filterText: sFilterText,
+			possibleValues: aPossibleValues,
+			valueType: sAnnotationValueType
+		});
+		if (sFilterText) {
+			this._oController.filterProperties(sFilterText);
+		}
+		const oChangedProperties = await this._openDialog();
+		this._oPopover.close();
+		return Object.entries(oChangedProperties).map(([sPath, vNewValue]) => {
+			if (oOriginalProperties[sPath] === vNewValue) {
+				return null;
+			}
+			return {
+				serviceUrl: sServiceUrl,
+				content: {
+					annotationPath: sPath,
+					value: vNewValue
+				}
+			};
+		}).filter(Boolean);
+	};
+
+	AnnotationChangeDialog.prototype.destroy = function(...aArgs) {
+		ManagedObject.prototype.destroy.apply(this, aArgs);
+		if (this._oPopover) {
+			this._oPopover.destroy();
+		}
+		if (this._oController) {
+			this._oController.destroy();
+		}
+	};
+
+	return AnnotationChangeDialog;
+});