@openui5/sap.ui.rta 1.134.0 → 1.136.0

package/src/sap/ui/rta/util/PopupManager.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -42,7 +42,7 @@ sap.ui.define([
 	 * Constructor for a new sap.ui.rta.util.PopupManager
 	 * @extends sap.ui.base.ManagedObject
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.136.0
 	 * @constructor
 	 * @private
 	 * @since 1.48

package/src/sap/ui/rta/util/ReloadManager.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -30,7 +30,7 @@ sap.ui.define([
 	 * @namespace sap.ui.rta.util.ReloadManager
 	 * @alias sap.ui.rta.util.ReloadManager
 	 * @since 1.104
-	 * @version 1.134.0
+	 * @version 1.136.0
 	 * @private
 	 * @ui5-restricted
 	 */

package/src/sap/ui/rta/util/ServiceEventBus.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -19,7 +19,7 @@ function(
 	 *
 	 * @extends sap.ui.core.EventBus
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.136.0
 	 * @private
 	 * @since 1.56.0
 	 * @alias sap.ui.rta.util.ServiceEventBus

package/src/sap/ui/rta/util/ServiceManager.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
@@ -27,7 +27,7 @@ sap.ui.define([
 	 *
 	 * @extends sap.ui.base.ManagedObject
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.136.0
 	 * @constructor
 	 * @private
 	 * @since 1.121

package/src/sap/ui/rta/util/adaptationStarter.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 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/rta/util/changeVisualization/ChangeCategories.js

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

package/src/sap/ui/rta/util/changeVisualization/ChangeIndicator.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -46,7 +46,7 @@ sap.ui.define([
 	 * @alias sap.ui.rta.util.changeVisualization.ChangeIndicator
 	 * @author SAP SE
 	 * @since 1.84.0
-	 * @version 1.134.0
+	 * @version 1.136.0
 	 * @private
 	 */
 	const ChangeIndicator = Control.extend("sap.ui.rta.util.changeVisualization.ChangeIndicator", {

package/src/sap/ui/rta/util/changeVisualization/ChangeIndicatorRegistry.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -37,7 +37,7 @@ sap.ui.define([
 	 * @alias sap.ui.rta.util.changeVisualization.ChangeIndicatorRegistry
 	 * @author SAP SE
 	 * @since 1.86.0
-	 * @version 1.134.0
+	 * @version 1.136.0
 	 * @private
 	 */
 	const ChangeIndicatorRegistry = ManagedObject.extend("sap.ui.rta.util.changeVisualization.ChangeIndicatorRegistry", {

package/src/sap/ui/rta/util/changeVisualization/ChangeStates.js

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

package/src/sap/ui/rta/util/changeVisualization/ChangeVisualization.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -84,7 +84,7 @@ sap.ui.define([
 	 * @alias sap.ui.rta.util.changeVisualization.ChangeVisualization
 	 * @author SAP SE
 	 * @since 1.84.0
-	 * @version 1.134.0
+	 * @version 1.136.0
 	 * @private
 	 */
 	const ChangeVisualization = Control.extend("sap.ui.rta.util.changeVisualization.ChangeVisualization", {
@@ -344,7 +344,7 @@ sap.ui.define([
 		if (!oPopover) {
 			Fragment.load({
 				name: "sap.ui.rta.util.changeVisualization.ChangeIndicatorCategorySelection",
-				id: this._getComponent().createId("changeVisualization_changesList"),
+				id: `${this._oToolbarButton.sId}--ChangeIndicatorCategorySelection`,
 				controller: this
 			})
 			.then(function(oPopover) {
@@ -420,7 +420,7 @@ sap.ui.define([
 			return sCommand;
 		}
 
-		if (!oChange.getSelector || !oChange.getSelector() || isEmptyObject(oChange.getSelector())) {
+		if (!oChange.canBeVisualized()) {
 			return false;
 		}
 

package/src/sap/ui/rta/util/changeVisualization/ChangeVisualizationUtils.js

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

package/src/sap/ui/rta/util/changeVisualization/commands/CombineVisualization.js

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

package/src/sap/ui/rta/util/changeVisualization/commands/CreateContainerVisualization.js

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

package/src/sap/ui/rta/util/changeVisualization/commands/MoveVisualization.js

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

package/src/sap/ui/rta/util/changeVisualization/commands/RenameVisualization.js

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

package/src/sap/ui/rta/util/changeVisualization/commands/SplitVisualization.js

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

package/src/sap/ui/rta/util/changeVisualization/commands/getCommandVisualization.js

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

package/src/sap/ui/rta/util/guidedTour/GuidedTour.js

@@ -0,0 +1,242 @@
+/*!
+ * 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/m/MessageBox",
+	"sap/ui/base/ManagedObject",
+	"sap/ui/core/Element",
+	"sap/ui/core/Fragment",
+	"sap/ui/model/json/JSONModel",
+	"sap/ui/model/resource/ResourceModel",
+	"sap/ui/rta/Utils"
+], function(
+	MessageBox,
+	ManagedObject,
+	Element,
+	Fragment,
+	JSONModel,
+	ResourceModel,
+	Utils
+) {
+	"use strict";
+
+	/**
+	 * @class Constructor for a new sap.ui.rta.util.guidedTour.GuidedTour
+	 * @extends sap.ui.base.ManagedObject
+	 * @author SAP SE
+	 * @version 1.136.0
+	 * @constructor
+	 * @since 1.136
+	 * @private
+	 * @ui5-restricted sap.ui.rta
+	 */
+	const GuidedTour = ManagedObject.extend("sap.ui.rta.util.guidedTour.GuidedTour", {
+		metadata: {
+			properties: {
+				steps: { type: "object" },
+				initialStateSelectors: { type: "object" },
+				currentStep: { type: "int", defaultValue: 0 },
+				forwardDirection: { type: "boolean", defaultValue: true }
+			},
+			events: {
+				tourClosed: {}
+			}
+		}
+	});
+
+	function waitForElementVisibility(oTargetElementId) {
+		return new Promise((resolve, reject) => {
+			const oTargetElement = Element.getElementById(oTargetElementId);
+			const oTargetElementDomRef = oTargetElement?.getDomRef();
+			let bResolved = false;
+
+			if (Utils.isElementVisible(oTargetElementDomRef)) {
+				resolve(oTargetElement);
+				return;
+			}
+
+			const oObserver = new MutationObserver(() => {
+				const observedElement = Element.getElementById(oTargetElementId);
+				const oObservedElementDomRef = observedElement?.getDomRef();
+				if (Utils.isElementVisible(oObservedElementDomRef)) {
+					bResolved = true;
+					oObserver.disconnect();
+					resolve(observedElement);
+				}
+			});
+
+			// Start observing the document for changes
+			oObserver.observe(document.body, {
+				childList: true,
+				subtree: true,
+				attributes: true
+			});
+
+			// Set a timeout to reject the promise and clean up the observer if the element is not found
+			setTimeout(() => {
+				if (!bResolved) {
+					oObserver.disconnect();
+					reject(new Error(`Element with ID "${oTargetElementId}" not found`));
+				}
+			}, 700);
+		});
+	}
+
+	function skipStep() {
+		if (this.getProperty("forwardDirection") === true) {
+			this.onNextPress();
+		} else {
+			this.onPreviousPress();
+		}
+	}
+
+	function onEscKeyDown(oEvent) {
+		if (oEvent.key === "Escape" || oEvent.key === "Esc") {
+			this.onClosePress();
+		}
+	}
+
+	GuidedTour.prototype.autoStart = async function(oTourContent) {
+		const sResponse = await Utils.showMessageBox(
+			"information",
+			"TXT_TOUR_GENERAL_DESCRIPTION",
+			{
+				actions: [MessageBox.Action.YES, MessageBox.Action.NO],
+				emphasizedAction: MessageBox.Action.YES,
+				titleKey: "TIT_TOUR_GENERAL_TITLE",
+				id: "autoStartGuidedTour"
+			}
+		);
+		if (sResponse === MessageBox.Action.YES) {
+			this.start(oTourContent);
+		} else {
+			this.fireTourClosed();
+		}
+	};
+
+	GuidedTour.prototype.start = async function(oTourContent) {
+		this.setProperty("steps", oTourContent.steps);
+		this.setProperty("initialStateSelectors", oTourContent.initialStateSelectors);
+		const oRTAResourceModel = new ResourceModel({ bundleName: "sap.ui.rta.messagebundle" });
+		this._oPopover = await Fragment.load({
+			id: "guidedTourMarker",
+			name: "sap.ui.rta.util.guidedTour.TourMarker",
+			controller: this
+		});
+		this.oGuidedTourModel = new JSONModel();
+		this.updateGuidedTourModel(0);
+		this._oPopover.setModel(oRTAResourceModel, "i18n");
+		this._oPopover.setModel(this.oGuidedTourModel);
+
+		// Add the event listener to the popup's DOM element after it is rendered
+		this._oPopover.addEventDelegate({
+			onAfterRendering: function() {
+				const oPopupElement = this._oPopover.getDomRef();
+				if (oPopupElement) {
+					oPopupElement.addEventListener("keydown", onEscKeyDown.bind(this));
+				}
+			}.bind(this)
+		});
+
+		this.showMarker(0);
+	};
+
+	GuidedTour.prototype.showMarker = async function(nStep) {
+		const oStepConfig = this.getProperty("steps")[nStep];
+		const sSelector = oStepConfig.markerSelector;
+		const aActionSelectors = oStepConfig.actionSelectors || [];
+
+		try {
+			for (const sActionSelector of aActionSelectors) {
+				const oActionControl = await waitForElementVisibility.call(this, sActionSelector);
+				oActionControl.firePress();
+			}
+
+			const oAffectedControl = oStepConfig.waitForElement
+				? await waitForElementVisibility.call(this, sSelector)
+				: Element.getElementById(sSelector);
+
+			// Open the popover if the element is visible
+			if (oAffectedControl && oAffectedControl.getVisible()) {
+				this._oPopover.openBy(oAffectedControl);
+			} else {
+				skipStep.call(this);
+			}
+		} catch (error) {
+			skipStep.call(this);
+		}
+	};
+
+	GuidedTour.prototype.updateGuidedTourModel = function(nStepIndex) {
+		const bIsLastStep = nStepIndex === this.getProperty("steps").length - 1;
+		const bIsFirstStep = nStepIndex === 0;
+
+		this.oGuidedTourModel.setData({
+			...this.oGuidedTourModel.getData(),
+			...this.getProperty("steps")[nStepIndex],
+			isLastStep: bIsLastStep,
+			isFirstStep: bIsFirstStep,
+			progress: 100 / this.getProperty("steps").length * (nStepIndex + 1)
+		});
+	};
+
+	GuidedTour.prototype.onNextPress = function() {
+		this.setProperty("forwardDirection", true);
+		this._oPopover.close();
+		const nCurrentStep = this.getCurrentStep();
+
+		if (nCurrentStep < this.getProperty("steps").length - 1) {
+			const nNextStep = nCurrentStep + 1;
+			this.updateGuidedTourModel(nNextStep);
+			this.setCurrentStep(nNextStep);
+			this.showMarker(nNextStep);
+		} else {
+			this.fireTourClosed();
+			this.destroy();
+		}
+	};
+
+	GuidedTour.prototype.onPreviousPress = function() {
+		this.setProperty("forwardDirection", false);
+		this._oPopover.close();
+		const nCurrentStep = this.getCurrentStep();
+		const nPreviousStep = nCurrentStep - 1;
+		this.updateGuidedTourModel(nPreviousStep);
+		this.setCurrentStep(nPreviousStep);
+		this.showMarker(nPreviousStep);
+	};
+
+	GuidedTour.prototype.returnToInitialState = async function() {
+		try {
+			const oInitialStateSelectors = this.getProperty("initialStateSelectors");
+			if (oInitialStateSelectors.length === 0) {
+				return;
+			}
+			for (const sActionSelector of oInitialStateSelectors) {
+				const oActionControl = await waitForElementVisibility.call(this, sActionSelector);
+				oActionControl.firePress();
+			}
+		} catch (error) {
+			this.destroy();
+		}
+	};
+
+	GuidedTour.prototype.onClosePress = async function() {
+		this._oPopover.close();
+		this.fireTourClosed();
+		this.destroy();
+		await this.returnToInitialState();
+	};
+
+	GuidedTour.prototype.destroy = function(...aArgs) {
+		ManagedObject.prototype.destroy.apply(this, aArgs);
+		if (this._oPopover) {
+			this._oPopover.destroy();
+		}
+	};
+
+	return GuidedTour;
+});

package/src/sap/ui/rta/util/guidedTour/TourMarker.fragment.xml

@@ -0,0 +1,50 @@
+<core:FragmentDefinition
+	xmlns="sap.m"
+	xmlns:core="sap.ui.core">
+	<Popover
+		id="guidedTourMarkerPopover"
+		title="{/title}"
+		class="sapUiResponsivePadding--header sapUiResponsivePadding--footer sapUiContentPadding"
+		placement="PreferredBottomOrFlip"
+		modal="true"
+		contentWidth="32rem"
+		initialFocus="continueButton">
+		<endButton>
+			<Button
+				id="closeButton"
+				icon="sap-icon://decline"
+				press=".onClosePress"
+				tooltip="{i18n>TOOLTIP_GUIDED_TOUR_END}" />
+		</endButton>
+		<content>
+			<VBox>
+				<FormattedText htmlText="{/description}" class="sapUiTinyMargin"/>
+				<List
+					visible="{= ${/listContent}.length > 0}"
+					items="{/listContent}"
+					id="navigationList">
+						<StandardListItem  wrapping="true" title="{title}" description="{description}" icon="{icon}" />
+				</List>
+				<ProgressIndicator
+					id="progressIndicator"
+					percentValue="{/progress}"
+					state="None"
+					displayOnly="true"/>
+			</VBox>
+		</content>
+		<footer>
+			<OverflowToolbar>
+				<ToolbarSpacer/>
+				<Button
+					id="previewsButton"
+					text="{i18n>BTN_GUIDED_TOUR_PREV}"
+					visible="{= !${/isFirstStep}}"
+					press=".onPreviousPress" />
+				<Button
+					id="continueButton"
+					text="{= ${/isLastStep} ? ${i18n>BTN_GUIDED_TOUR_END} : ${i18n>BTN_GUIDED_TOUR_NEXT} }"
+					press=".onNextPress" />
+			</OverflowToolbar>
+		</footer>
+	</Popover>
+</core:FragmentDefinition>