@openui5/sap.ui.rta 1.134.0 → 1.136.0

package/src/sap/ui/rta/util/guidedTour/content/GeneralTour.js

@@ -0,0 +1,205 @@
+/*!
+ * 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/core/Element",
+	"sap/ui/core/Lib"
+], function(
+	Element,
+	Lib
+) {
+	"use strict";
+
+	const GeneralTour = {};
+
+	const oTextResources = Lib.getResourceBundleFor("sap.ui.rta");
+
+	function filterAvailableBurgerMenuActions(oGeneralTour) {
+		const oControlsModelData = Element.getElementById("sapUIRta_toolbar").getModel("controls").getData();
+		const aAvailableBurgerMenuActions = {
+			newFeaturesOverview: oControlsModelData.newFeaturesOverview.visible,
+			translation: oControlsModelData.translation.visible,
+			generalTour: true,
+			appVariantMenu: oControlsModelData.appVariantMenu.visible,
+			restore: oControlsModelData.restore.visible
+		};
+
+		// Find the index of the burger menu step
+		const nBurgerMenuStepIndex = oGeneralTour.steps.findIndex((oStep) =>
+			oStep.title === oTextResources.getText("TIT_TOUR_GENERAL_STEP_BURGER_MENU_TITLE")
+		);
+
+		// Set the available actions
+		oGeneralTour.steps[nBurgerMenuStepIndex].listContent = oGeneralTour.steps[nBurgerMenuStepIndex].listContent.filter((oItem) =>
+			aAvailableBurgerMenuActions[oItem.id]
+		);
+
+		return oGeneralTour;
+	}
+
+	/**
+	 * The `oGeneralTourContent` object defines the steps for the Guided Tour in the RTA toolbar.
+	 * Each step provides information about a specific feature or functionality.
+	 *
+	 * To add a new step, include an object in the `steps` array with the following structure:
+	 *
+	 * {
+	 *   title: <Title of the step>,
+	 *   description: <Description of the step>,
+	 *   listContent: [
+	 *     {
+	 *       id: <id of the action>,
+	 *       title: <Title of the action>,
+	 *       description: <Description of the action>,
+	 *       icon: <Icon representing the action>
+	 *     }
+	 *   ],
+	 *   markerSelector: <Selector for the UI element to highlight during the step>,
+	 *   actionSelectors: [<Selectors for elements to trigger actions on during the steps>],
+	 *   waitForElement: <Boolean indicating whether to wait for the element to become visible>
+	 * }
+	 */
+
+	const oGeneralTourContent = {
+		initialStateSelectors: ["sapUIRta_toolbar_fragment--sapUiRta_adaptationSwitcherButton-button"],
+		steps: [
+			{
+				title: oTextResources.getText("TIT_TOUR_GENERAL_STEP_UI_ADAPTATION_BUTTON_TITLE"),
+				description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_UI_ADAPTATION_BUTTON_DESCRIPTION"),
+				listContent: [],
+				markerSelector: "sapUIRta_toolbar_fragment--sapUiRta_adaptationSwitcherButton-button",
+				actionSelectors: ["sapUIRta_toolbar_fragment--sapUiRta_adaptationSwitcherButton-button"]
+			},
+			{
+				title: oTextResources.getText("TIT_TOUR_GENERAL_STEP_NAVIGATION_BUTTON_TITLE"),
+				description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_NAVIGATION_BUTTON_DESCRIPTION"),
+				listContent: [],
+				markerSelector: "sapUIRta_toolbar_fragment--sapUiRta_navigationSwitcherButton-button",
+				actionSelectors: ["sapUIRta_toolbar_fragment--sapUiRta_navigationSwitcherButton-button"]
+			},
+			{
+				title: oTextResources.getText("TIT_TOUR_GENERAL_STEP_VISUALIZATION_BUTTON_TITLE"),
+				description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_VISUALIZATION_BUTTON_DESCRIPTION"),
+				listContent: [],
+				markerSelector: "sapUIRta_toolbar_fragment--sapUiRta_visualizationSwitcherButton-button",
+				actionSelectors: ["sapUIRta_toolbar_fragment--sapUiRta_visualizationSwitcherButton-button"]
+			},
+			{
+				title: oTextResources.getText("TIT_TOUR_GENERAL_STEP_CHANGE_LIST_DROPDOWN_TITLE"),
+				description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_CHANGE_LIST_DROPDOWN_DESCRIPTION"),
+				listContent: [],
+				markerSelector:
+					"sapUIRta_toolbar_fragment--sapUiRta_toggleChangeVisualizationMenuButton--ChangeIndicatorCategorySelection--popover",
+				waitForElement: true,
+				actionSelectors: [
+					"sapUIRta_toolbar_fragment--sapUiRta_visualizationSwitcherButton-button",
+					"sapUIRta_toolbar_fragment--sapUiRta_toggleChangeVisualizationMenuButton"
+				]
+			},
+			{
+				title: oTextResources.getText("TIT_TOUR_GENERAL_STEP_SAVE_BUTTON_TITLE"),
+				description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_SAVE_BUTTON_DESCRIPTION"),
+				listContent: [],
+				markerSelector: "sapUIRta_toolbar_fragment--sapUiRta_save",
+				waitForElement: true,
+				actionSelectors: ["sapUIRta_toolbar_fragment--sapUiRta_adaptationSwitcherButton-button"]
+			},
+			{
+				title: oTextResources.getText("TIT_TOUR_GENERAL_STEP_UNDO_BUTTON_TITLE"),
+				description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_UNDO_BUTTON_DESCRIPTION"),
+				listContent: [],
+				markerSelector: "sapUIRta_toolbar_fragment--sapUiRta_undo"
+			},
+			{
+				title: oTextResources.getText("TIT_TOUR_GENERAL_STEP_REDO_BUTTON_TITLE"),
+				description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_REDO_BUTTON_DESCRIPTION"),
+				listContent: [],
+				markerSelector: "sapUIRta_toolbar_fragment--sapUiRta_redo"
+			},
+			{
+				title: oTextResources.getText("TIT_TOUR_GENERAL_STEP_ACTIVATE_VERSION_BUTTON_TITLE"),
+				description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_ACTIVATE_VERSION_BUTTON_DESCRIPTION"),
+				listContent: [],
+				markerSelector: "sapUIRta_toolbar_fragment--sapUiRta_activate"
+			},
+			{
+				title: oTextResources.getText("TIT_TOUR_GENERAL_STEP_VERSIONS_DROPDOWN_TITLE"),
+				description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_VERSIONS_DROPDOWN_DESCRIPTION"),
+				listContent: [],
+				markerSelector: "sapUIRta_toolbar_fragment--sapUiRta_versionHistoryDialog--originalVersionList",
+				waitForElement: true,
+				actionSelectors: ["sapUIRta_toolbar_fragment--sapUiRta_versionButton"]
+			},
+			{
+				title: oTextResources.getText("TIT_TOUR_GENERAL_STEP_PUBLISH_BUTTON_TITLE"),
+				description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_PUBLISH_BUTTON_DESCRIPTION"),
+				listContent: [],
+				markerSelector: "sapUIRta_toolbar_fragment--sapUiRta_publishVersion"
+			},
+			{
+				title: oTextResources.getText("TIT_TOUR_GENERAL_STEP_BURGER_MENU_TITLE"),
+				description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_BURGER_MENU_DESCRIPTION"),
+				listContent: [
+					{
+						id: "translation",
+						title: oTextResources.getText("BTN_TRANSLATE"),
+						description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_BURGER_MENU_TRANSLATIONS"),
+						icon: "sap-icon://translate"
+					},
+					{
+						id: "appVariantMenu",
+						title: oTextResources.getText("BTN_MANAGE_APPS_TXT"),
+						description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_BURGER_MENU_APP_VARIANTS"),
+						icon: "sap-icon://BusinessSuiteInAppSymbols/icon-variant-configuration"
+					},
+					{
+						id: "restore",
+						title: oTextResources.getText("BTN_RESTORE"),
+						description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_BURGER_MENU_RESTORE"),
+						icon: "sap-icon://reset"
+					},
+					{
+						id: "newFeaturesOverview",
+						title: oTextResources.getText("BTN_WHATS_NEW_DIALOG_OVERVIEW"),
+						description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_BURGER_MENU_NEW_FEATURES"),
+						icon: "sap-icon://newspaper"
+					},
+					{
+						id: "generalTour",
+						title: oTextResources.getText("BTN_GUIDED_TOUR_START"),
+						description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_BURGER_MENU_GENERAL_TOUR"),
+						icon: "sap-icon://map-3"
+					}
+				],
+				markerSelector: "sapUIRta_toolbar_fragment--sapUiRta_actionsMenu"
+			},
+			{
+				title: oTextResources.getText("TIT_TOUR_GENERAL_STEP_CONTEXT_BASED_ADAPTATIONS_TITLE"),
+				description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_CONTEXT_BASED_ADAPTATIONS_DESCRIPTION"),
+				listContent: [],
+				markerSelector: "sapUIRta_toolbar_fragment--sapUiRta_contextBasedAdaptationsButton"
+			},
+			{
+				title: oTextResources.getText("TIT_TOUR_GENERAL_STEP_FEEDBACK_BUTTON_TITLE"),
+				description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_FEEDBACK_BUTTON_DESCRIPTION"),
+				listContent: [],
+				markerSelector: "sapUIRta_toolbar_fragment--sapUiRta_feedback"
+			},
+			{
+				title: oTextResources.getText("TIT_TOUR_GENERAL_STEP_EXIT_BUTTON_TITLE"),
+				description: oTextResources.getText("TXT_TOUR_GENERAL_STEP_EXIT_BUTTON_DESCRIPTION"),
+				listContent: [],
+				markerSelector: "sapUIRta_toolbar_fragment--sapUiRta_exit"
+			}
+		]
+	};
+
+	GeneralTour.getTourContent = function() {
+		return filterAvailableBurgerMenuActions(oGeneralTourContent);
+	};
+
+	return GeneralTour;
+});

package/src/sap/ui/rta/util/hasStableId.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/isReuseComponent.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/showMessageBox.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/validateFlexEnabled.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/validateStableIds.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/validateText.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/whatsNew/WhatsNew.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.
  */
 
@@ -33,7 +33,7 @@ sap.ui.define([
 	 * @class Constructor for a new sap.ui.rta.util.whatsNew.WhatsNew
 	 * @extends sap.ui.base.ManagedObject
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.136.0
 	 * @constructor
 	 * @since 1.129
 	 * @private
@@ -56,14 +56,18 @@ sap.ui.define([
 		this.aUnseenFeatures = await WhatsNewUtils.getFilteredFeatures(aDontShowAgainFeatureIds, this.getLayer());
 	};
 
-	WhatsNew.prototype.initializeWhatsNewDialog = async function() {
+	WhatsNew.prototype.initializeWhatsNewDialog = async function(aExcludeFeatureIds = []) {
 		const aDontShowAgainFeatureIds = await FeaturesAPI.getSeenFeatureIds({ layer: this.getLayer() });
 		await this.setDontShowAgainFeatureIds(aDontShowAgainFeatureIds);
 		if (this.aUnseenFeatures.length === 0 || this.getLayer() !== "CUSTOMER") {
 			return;
 		}
 		const oWhatsNewDialogModel = new JSONModel();
-		oWhatsNewDialogModel.setData({ featureCollection: this.aUnseenFeatures });
+		const aVisibleFeatures = this.aUnseenFeatures.filter((oFeature) => !aExcludeFeatureIds.includes(oFeature.featureId));
+		if (aVisibleFeatures.length === 0) {
+			return;
+		}
+		oWhatsNewDialogModel.setData({ featureCollection: aVisibleFeatures });
 		if (!this.oWhatsNewDialog)	{
 			await this.createWhatsNewDialog(oWhatsNewDialogModel);
 		}

package/src/sap/ui/rta/util/whatsNew/WhatsNewDialog.fragment.xml

@@ -24,7 +24,7 @@
 							<Title text="{whatsNewModel>title}" class="sapUiMediumMarginTop sapUiSmallMarginBegin sapUiTinyMarginBottom" level="H3"/>
 							<f:Card width="100%" height="24rem" class="sapUiSmallMarginBottom">
 								<f:content>
-									<Page width="100%" showHeader="false" backgroundDesign="Transparent">
+									<Page showHeader="false" backgroundDesign="Transparent">
 											<VBox items="{path: 'whatsNewModel>information', templateShareable: false}" class="sapUiSmallMargin">
 												<HBox alignItems="Center" class="sapUiTinyMargin">
 													<FormattedText

package/src/sap/ui/rta/util/whatsNew/WhatsNewOverview.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/whatsNew/WhatsNewUtils.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/whatsNew/whatsNewContent/WhatsNewFeatures.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.
  */
 
@@ -65,6 +65,90 @@ sap.ui.define([
 	 */
 	const aWhatsNewFeaturesContent =
 	[
+		{
+			featureId: "GuidedTour",
+			title: oTextResources.getText("TIT_WHATS_NEW_RTA_TOUR_TITLE"),
+			description: oTextResources.getText("TXT_WHATS_NEW_DIALOG_RTA_TOUR_DESCRIPTION"),
+			documentationUrls: {
+				btpUrl: "https://help.sap.com/docs/ui5-flexibility-for-key-users/ui5-flexibility-for-key-users/adapting-ui",
+				s4HanaCloudUrl: "https://help.sap.com/docs/SAP_S4HANA_CLOUD/4fc8d03390c342da8a60f8ee387bca1a/d868950a1e8c4b0f9b9453176939a19b.html",
+				s4HanaOnPremUrl: "https://help.sap.com/docs/ABAP_PLATFORM_NEW/a7b390faab1140c087b8926571e942b7/d868950a1e8c4b0f9b9453176939a19b.html"
+			},
+			information: [
+				{
+					text: oTextResources.getText("TXT_WHATS_NEW_DIALOG_RTA_TOUR_TEXT"),
+					image: getImagePath("GuidedTour.png")
+				}
+			]
+		},
+		{
+			featureId: "RenameRework",
+			title: oTextResources.getText("TIT_WHATS_NEW_RENAME_REWORK_TITLE"),
+			description: oTextResources.getText("TXT_WHATS_NEW_DIALOG_RENAME_REWORK_DESCRIPTION"),
+			documentationUrls: {
+				btpUrl: "https://help.sap.com/docs/ui5-flexibility-for-key-users/ui5-flexibility-for-key-users/making-ui-changes#renaming-a-ui-element",
+				s4HanaCloudUrl: "https://help.sap.com/docs/SAP_S4HANA_CLOUD/4fc8d03390c342da8a60f8ee387bca1a/54270a390b194c3e97be2424592c3352.html#renaming-a-ui-element",
+				s4HanaOnPremUrl: "https://help.sap.com/docs/ABAP_PLATFORM_NEW/a7b390faab1140c087b8926571e942b7/54270a390b194c3e97be2424592c3352.html#renaming-a-ui-element"
+			},
+			information: [
+				{
+					text: oTextResources.getText("TXT_WHATS_NEW_DIALOG_RENAME_REWORK_TEXT_1"),
+					image: getImagePath("RenameDialog.png")
+				},
+				{
+					text: oTextResources.getText("TXT_WHATS_NEW_DIALOG_RENAME_REWORK_TEXT_2"),
+					image: getImagePath("ChangeLabelsAction.png")
+				},
+				{
+					text: oTextResources.getText("TXT_WHATS_NEW_DIALOG_RENAME_REWORK_TEXT_3"),
+					image: getImagePath("ReloadButtonToolbar.png")
+				}
+			]
+		},
+		{
+			featureId: "TextArrangement",
+			title: oTextResources.getText("TIT_WHATS_NEW_TEXT_ARRANGEMENT_TITLE"),
+			description: oTextResources.getText("TXT_WHATS_NEW_DIALOG_TEXT_ARRANGEMENT_DESCRIPTION"),
+			documentationUrls: {
+				btpUrl: "https://help.sap.com/docs/ui5-flexibility-for-key-users/ui5-flexibility-for-key-users/making-ui-changes#text-arrangement",
+				s4HanaCloudUrl: "https://help.sap.com/docs/SAP_S4HANA_CLOUD/4fc8d03390c342da8a60f8ee387bca1a/54270a390b194c3e97be2424592c3352.html#text-arrangement",
+				s4HanaOnPremUrl: "https://help.sap.com/docs/ABAP_PLATFORM_NEW/a7b390faab1140c087b8926571e942b7/54270a390b194c3e97be2424592c3352.html#text-arrangement"
+			},
+			information: [
+				{
+					text: oTextResources.getText("TXT_WHATS_NEW_DIALOG_TEXT_ARRANGEMENT_TEXT_1"),
+					image: getImagePath("DisplayBehavior.png")
+				},
+				{
+					text: oTextResources.getText("TXT_WHATS_NEW_DIALOG_TEXT_ARRANGEMENT_TEXT_2"),
+					image: null
+				},
+				{
+					text: oTextResources.getText("TXT_WHATS_NEW_DIALOG_TEXT_ARRANGEMENT_TEXT_3"),
+					image: getImagePath("ReloadButtonToolbar.png")
+				}
+			]
+		},
+		{
+			featureId: "ExtendedActions",
+			title: oTextResources.getText("TIT_WHATS_NEW_EXTENDED_ACTIONS_TITLE"),
+			description: oTextResources.getText("TXT_WHATS_NEW_DIALOG_EXTENDED_ACTIONS_DESCRIPTION"),
+			documentationUrls: {
+				btpUrl: "https://help.sap.com/docs/ui5-flexibility-for-key-users/ui5-flexibility-for-key-users/adapting-ui",
+				s4HanaCloudUrl: "https://help.sap.com/docs/SAP_S4HANA_CLOUD/4fc8d03390c342da8a60f8ee387bca1a/d868950a1e8c4b0f9b9453176939a19b.html",
+				s4HanaOnPremUrl: "https://help.sap.com/docs/ABAP_PLATFORM_NEW/a7b390faab1140c087b8926571e942b7/d868950a1e8c4b0f9b9453176939a19b.html"
+			},
+			information: [
+				{
+					text: oTextResources.getText("TXT_WHATS_NEW_DIALOG_EXTENDED_ACTIONS_TEXT_1"),
+					image: null
+				},
+				{
+					text: oTextResources.getText("TXT_WHATS_NEW_DIALOG_EXTENDED_ACTIONS_TEXT_2"),
+					image: getImagePath("ExtendedActions.png")
+				}
+			]
+		},
 		{
 			featureId: "WhatsNewFeature",
 			title: oTextResources.getText("TIT_WHATS_NEW_DIALOG_WHATS_NEW_FEATURE_TITLE"),

package/ui5.yaml

@@ -5,7 +5,7 @@ metadata:
   name: sap.ui.rta
   copyright: |-
    OpenUI5
-    * (c) Copyright 2009-${currentYear} SAP SE or an SAP affiliate company.
+    * (c) Copyright ${currentYear} SAP SE or an SAP affiliate company.
     * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
 resources:
   configuration: