@openui5/sap.ui.rta 1.103.0 → 1.105.0

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

@@ -19,7 +19,7 @@ function(
 	 *
 	 * @extends sap.ui.core.EventBus
 	 * @author SAP SE
-	 * @version 1.103.0
+	 * @version 1.105.0
 	 * @private
 	 * @since 1.56.0
 	 * @alias sap.ui.rta.util.ServiceEventBus

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

@@ -1,9 +1,10 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
+	"sap/base/util/UriParameters",
 	"sap/base/Log",
 	"sap/ui/core/Control",
 	"sap/ui/core/UIComponent",
@@ -14,6 +15,7 @@ sap.ui.define([
 	"sap/ui/rta/util/showMessageBox",
 	"sap/ui/rta/RuntimeAuthoring"
 ], function(
+	UriParameters,
 	Log,
 	Control,
 	UIComponent,
@@ -41,13 +43,17 @@ sap.ui.define([
 	}
 
 	function checkFlexEnabled(oAppComponent) {
-		var oManifest = oAppComponent.getManifest() || {};
-		var vFlexEnabled = oManifest["sap.ui5"] && oManifest["sap.ui5"].flexEnabled;
+		// fiori tools is always a developer scenario where the flexEnabled flag should not be evaluated
+		var sFioriToolsMode = UriParameters.fromQuery(window.location.search).get("fiori-tools-rta-mode");
+		if (!sFioriToolsMode || sFioriToolsMode === "false") {
+			var oManifest = oAppComponent.getManifest() || {};
+			var vFlexEnabled = oManifest["sap.ui5"] && oManifest["sap.ui5"].flexEnabled;
 
-		if (vFlexEnabled === false) {
-			var oError = Error("This app is not enabled for key user adaptation");
-			oError.reason = "flexEnabled";
-			throw oError;
+			if (vFlexEnabled === false) {
+				var oError = Error("This app is not enabled for key user adaptation");
+				oError.reason = "flexEnabled";
+				throw oError;
+			}
 		}
 	}
 

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

@@ -8,7 +8,6 @@ sap.ui.define([
 	"sap/ui/core/Fragment",
 	"sap/ui/model/json/JSONModel",
 	"sap/ui/core/Control",
-	"sap/m/Text",
 	"sap/ui/core/format/DateFormat",
 	"sap/ui/events/KeyCodes",
 	"sap/ui/rta/util/changeVisualization/categories/getVisualizationCategory",
@@ -20,7 +19,6 @@ sap.ui.define([
 	Fragment,
 	JSONModel,
 	Control,
-	Text,
 	DateFormat,
 	KeyCodes,
 	getVisualizationCategory,
@@ -48,7 +46,7 @@ sap.ui.define([
 	 * @alias sap.ui.rta.util.changeVisualization.ChangeIndicator
 	 * @author SAP SE
 	 * @since 1.84.0
-	 * @version 1.103.0
+	 * @version 1.105.0
 	 * @private
 	 */
 	var ChangeIndicator = Control.extend("sap.ui.rta.util.changeVisualization.ChangeIndicator", {
@@ -160,7 +158,7 @@ sap.ui.define([
 
 	function centerVertically(oIndicator) {
 		var oIndicatorDomRef = oIndicator.getDomRef();
-		var iOverlayHeight = document.getElementById(oIndicator.getOverlayId()).offsetHeight;
+		var iOverlayHeight = Core.byId(oIndicator.getOverlayId()).getDomRef().offsetHeight;
 		var iIndicatorHeight = oIndicatorDomRef.offsetHeight;
 		// the indicator should be centered only if the element has a small enough height to improve the design and visibility
 		if (iOverlayHeight < iIndicatorHeight * 5) {
@@ -168,6 +166,84 @@ sap.ui.define([
 		}
 	}
 
+	function getTexts(mChangeInformation, oRtaResourceBundle, sOverlayId) {
+		var oAffectedElement = Core.byId(mChangeInformation.affectedElementId);
+		var mPayload = Object.keys(mChangeInformation.payload || {}).reduce(function(mPayload, sKey) {
+			var vOriginalValue = mChangeInformation.payload[sKey];
+			var bIsBinding = FlUtils.isBinding(vOriginalValue);
+			var vValue = bIsBinding
+				? resolveBinding(vOriginalValue, oAffectedElement)
+				: vOriginalValue;
+			mPayload[sKey] = vValue;
+			return mPayload;
+		}, {});
+
+		var mPropertyBag = { appComponent: FlUtils.getAppComponentForControl(oAffectedElement) };
+		var oOverlay = Core.byId(sOverlayId);
+		var oVisualizationUtil = getVisualizationCategory(mChangeInformation);
+		var sElementLabel = oOverlay.getDesignTimeMetadata().getLabel(oAffectedElement);
+		var oDescription = oVisualizationUtil && oVisualizationUtil.getDescription(mPayload, sElementLabel, mPropertyBag);
+		sElementLabel = sElementLabel && "'" + sElementLabel + "'";
+		var sShortenedElementLabel = ChangeVisualizationUtils.shortenString(sElementLabel);
+		var sChangeTextKey = (
+			"TXT_CHANGEVISUALIZATION_CHANGE_"
+			+ mChangeInformation.commandName.toUpperCase()
+		);
+
+		var sDescriptionText;
+		var sDescriptionTooltip;
+		// for settings commands if available description and tooltip should be taken as is from the change handler
+		if (mPayload.description && mChangeInformation.commandName === "settings") {
+			sDescriptionText = mPayload.description;
+			sDescriptionTooltip = mPayload.descriptionTooltip || "";
+		} else {
+			if (oDescription) {
+				sDescriptionText = oDescription.descriptionText;
+				sDescriptionTooltip = oDescription.descriptionTooltip;
+			} else {
+				sDescriptionText = oRtaResourceBundle.getText(sChangeTextKey, sShortenedElementLabel);
+				sDescriptionTooltip = oRtaResourceBundle.getText(sChangeTextKey, sElementLabel);
+			}
+			sDescriptionTooltip = sDescriptionText.length < sDescriptionTooltip.length ? sDescriptionTooltip : null;
+		}
+		var sDetailButtonText = oDescription && oDescription.buttonText;
+
+		return {
+			description: sDescriptionText,
+			tooltip: sDescriptionTooltip,
+			buttonText: sDetailButtonText
+		};
+	}
+
+	function getDates(mChangeInformation, oRtaResourceBundle) {
+		var sCreationDate = mChangeInformation.change.getCreation();
+		var oDate = new Date(sCreationDate);
+		var sFallbackDate = oRtaResourceBundle.getText("TXT_CHANGEVISUALIZATION_CREATED_IN_SESSION_DATE");
+
+		return {
+			fullDate: sCreationDate ? DateFormat.getDateTimeInstance().format(oDate) : sFallbackDate,
+			relativeDate: sCreationDate ? DateFormat.getDateTimeInstance({ relative: "true" }).format(oDate) : sFallbackDate
+		};
+	}
+
+	function formatChangesModelItem(sOverlayId, mChangeInformation) {
+		var oRtaResourceBundle = Core.getLibraryResourceBundle("sap.ui.rta");
+		var oTexts = getTexts(mChangeInformation, oRtaResourceBundle, sOverlayId);
+		var oDates = getDates(mChangeInformation, oRtaResourceBundle);
+
+
+		return {
+			id: mChangeInformation.id,
+			change: mChangeInformation,
+			description: oTexts.description,
+			descriptionTooltip: oTexts.tooltip,
+			fullDate: oDates.fullDate,
+			relativeDate: oDates.relativeDate,
+			detailButtonText: oTexts.buttonText,
+			icon: CATEGORY_ICONS[mChangeInformation.commandCategory]
+		};
+	}
+
 	ChangeIndicator.prototype.init = function() {
 		this._iOldTabIndex = 0;
 		handleBrowserEventsOnElement.call(this, this, "attachBrowserEvent");
@@ -203,11 +279,28 @@ sap.ui.define([
 		this._bScheduledForFocus = true;
 	};
 
+	ChangeIndicator.prototype.setOverlayId = function(sOverlayId) {
+		// Overlays don't have aggregations, thus the indicator dom ref must be placed as
+		// a child of the overlay dom ref manually
+		// If the overlay that the indicator should be attached to changes, it is possible that the
+		// indicator is not rendered yet or that the old overlay and thus the nested indicator were destroyed
+		// To properly render it, the indicator must temporarily be placed in the static area
+		// Once it is rendered, it can move itself to the actual overlay dom ref (see onAfterRendering)
+		var oDomRef = this.getDomRef();
+		if (oDomRef) {
+			oDomRef.parentNode.removeChild(oDomRef);
+		}
+		this.placeAt(Core.getStaticAreaRef());
+
+		this.setProperty("overlayId", sOverlayId);
+		return this;
+	};
+
 	ChangeIndicator.prototype.onAfterRendering = function() {
-		var oOverlay = document.getElementById(this.getOverlayId());
+		var oOverlay = Core.getElementById(this.getOverlayId());
 		if (oOverlay) {
 			// Attach to the overlay
-			oOverlay.appendChild(this.getDomRef());
+			oOverlay.getDomRef().appendChild(this.getDomRef());
 			centerVertically(this);
 		}
 		// Restore the Tabindex if stored before; set to 0 as default
@@ -237,7 +330,7 @@ sap.ui.define([
 
 	ChangeIndicator.prototype.setChanges = function(aChanges) {
 		this.setProperty("changes", aChanges);
-		this._oDetailModel.setData((aChanges || []).reverse().map(this._formatChangesModelItem.bind(this)));
+		this._oDetailModel.setData((aChanges || []).reverse().map(formatChangesModelItem.bind(this, this.getOverlayId())));
 	};
 
 	ChangeIndicator.prototype._onSelect = function(oEvent) {
@@ -270,50 +363,6 @@ sap.ui.define([
 		this[sFunctionName]("sapUiRtaHover");
 	};
 
-	ChangeIndicator.prototype._formatChangesModelItem = function(mChangeInformation) {
-		var oAffectedElement = Core.byId(mChangeInformation.affectedElementId);
-		var mPayload = Object.keys(mChangeInformation.payload || {}).reduce(function(mPayload, sKey) {
-			var vOriginalValue = mChangeInformation.payload[sKey];
-			var bIsBinding = FlUtils.isBinding(vOriginalValue);
-			var vValue = bIsBinding
-				? resolveBinding(vOriginalValue, oAffectedElement)
-				: vOriginalValue;
-			mPayload[sKey] = vValue;
-			return mPayload;
-		}, {});
-
-		var mPropertyBag = { appComponent: FlUtils.getAppComponentForControl(oAffectedElement) };
-		var oOverlay = Core.byId(this.getOverlayId());
-		var sElementLabel = oOverlay.getDesignTimeMetadata().getLabel(oAffectedElement);
-		var oVisualizationUtil = getVisualizationCategory(mChangeInformation.commandName);
-		var oDescription = oVisualizationUtil && oVisualizationUtil.getDescription(mPayload, sElementLabel, mPropertyBag);
-		var oRtaResourceBundle = Core.getLibraryResourceBundle("sap.ui.rta");
-		sElementLabel = sElementLabel && "'" + sElementLabel + "'";
-		var sShortenedElementLabel = ChangeVisualizationUtils.shortenString(sElementLabel);
-		var sChangeTextKey = (
-			"TXT_CHANGEVISUALIZATION_CHANGE_"
-			+ mChangeInformation.commandName.toUpperCase()
-		);
-		var sDescriptionText = oDescription ? oDescription.descriptionText : oRtaResourceBundle.getText(sChangeTextKey, sShortenedElementLabel);
-		var sDescriptionTooltip = oDescription ? oDescription.descriptionTooltip : oRtaResourceBundle.getText(sChangeTextKey, sElementLabel);
-		var sCreationDate = mChangeInformation.change.getCreation();
-		var oDate = new Date(sCreationDate);
-		var sFallbackDate = oRtaResourceBundle.getText("TXT_CHANGEVISUALIZATION_CREATED_IN_SESSION_DATE");
-		var sFullDate = sCreationDate ? DateFormat.getDateTimeInstance().format(oDate) : sFallbackDate;
-		var sRelativeDate = sCreationDate ? DateFormat.getDateTimeInstance({ relative: "true" }).format(oDate) : sFallbackDate;
-		var sDetailButtonText = oDescription && oDescription.buttonText;
-		return {
-			id: mChangeInformation.id,
-			change: mChangeInformation,
-			description: sDescriptionText,
-			descriptionTooltip: sDescriptionTooltip && sDescriptionText.length < sDescriptionTooltip.length ? sDescriptionTooltip : null,
-			fullDate: sFullDate,
-			relativeDate: sRelativeDate,
-			detailButtonText: sDetailButtonText,
-			icon: CATEGORY_ICONS[mChangeInformation.commandCategory]
-		};
-	};
-
 	ChangeIndicator.prototype._openDetailPopover = function() {
 		if (!this.getAggregation("_popover")) {
 			//store the tabindex (tabindex will be removed on opening the popover)

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

@@ -5,15 +5,25 @@
  */
 
 sap.ui.define([
-	"sap/ui/base/ManagedObject",
 	"sap/base/util/includes",
 	"sap/base/util/values",
-	"sap/base/util/restricted/_omit"
+	"sap/base/util/restricted/_omit",
+	"sap/base/Log",
+	"sap/ui/base/ManagedObject",
+	"sap/ui/core/util/reflection/JsControlTreeModifier",
+	"sap/ui/dt/ElementUtil",
+	"sap/ui/fl/write/api/ChangesWriteAPI",
+	"sap/ui/fl/Utils"
 ], function(
-	ManagedObject,
 	includes,
 	values,
-	_omit
+	_omit,
+	Log,
+	ManagedObject,
+	JsControlTreeModifier,
+	ElementUtil,
+	ChangesWriteAPI,
+	FlUtils
 ) {
 	"use strict";
 
@@ -25,7 +35,7 @@ sap.ui.define([
 	 * @alias sap.ui.rta.util.changeVisualization.ChangeIndicatorRegistry
 	 * @author SAP SE
 	 * @since 1.86.0
-	 * @version 1.103.0
+	 * @version 1.105.0
 	 * @private
 	 */
 	var ChangeIndicatorRegistry = ManagedObject.extend("sap.ui.rta.util.changeVisualization.ChangeIndicatorRegistry", {
@@ -37,12 +47,18 @@ sap.ui.define([
 				commandCategories: {
 					type: "object",
 					defaultValue: []
+				},
+				/**
+				 * Id of the component or control to visualize the changes for
+				 */
+				 rootControlId: {
+					type: "string"
 				}
 			}
 		},
 		constructor: function () {
 			ManagedObject.prototype.constructor.apply(this, arguments);
-			this._oChanges = {};
+			this._oChangeIndicatorData = {};
 			this._oChangeIndicators = {};
 		}
 	});
@@ -57,7 +73,7 @@ sap.ui.define([
 	 * @returns {object[]} Registered changes
 	 */
 	ChangeIndicatorRegistry.prototype.getChanges = function () {
-		return values(this._oChanges || {}).map(function (oChange) {
+		return values(this._oChangeIndicatorData || {}).map(function (oChange) {
 			return Object.assign({}, oChange);
 		});
 	};
@@ -68,7 +84,7 @@ sap.ui.define([
 	 * @returns {string[]} Promise with both design time and runtime change
 	 */
 	ChangeIndicatorRegistry.prototype.getChangeIds = function () {
-		return Object.keys(this._oChanges || {});
+		return Object.keys(this._oChangeIndicatorData || {});
 	};
 
 	/**
@@ -78,7 +94,7 @@ sap.ui.define([
 	 * @returns {object} Registered change
 	 */
 	ChangeIndicatorRegistry.prototype.getChange = function (sChangeId) {
-		return this._oChanges[sChangeId] && Object.assign({}, this._oChanges[sChangeId]);
+		return this._oChangeIndicatorData[sChangeId] && Object.assign({}, this._oChangeIndicatorData[sChangeId]);
 	};
 
 	/**
@@ -105,7 +121,7 @@ sap.ui.define([
 			));
 		}
 
-		values(this._oChanges).forEach(function (oChange) {
+		values(this._oChangeIndicatorData).forEach(function (oChange) {
 			oChange.visualizationInfo.displayElementIds.forEach(function (sSelectorId, iIndex) {
 				addSelector(sSelectorId, oChange.visualizationInfo.affectedElementIds[iIndex], oChange, false);
 			});
@@ -118,16 +134,6 @@ sap.ui.define([
 		return oChangeIndicators;
 	};
 
-	/**
-	 * Checks if the given element ID was registered as a change indicator.
-	 *
-	 * @param {string} sSelectorId - ID of the element to check
-	 * @returns {boolean} Whether the element was registered as an indicator
-	 */
-	ChangeIndicatorRegistry.prototype.hasChangeIndicator = function (sSelectorId) {
-		return !!this._oChangeIndicators[sSelectorId];
-	};
-
 	/**
 	 * Returns the registered change indicator for the given element ID.
 	 *
@@ -152,25 +158,83 @@ sap.ui.define([
 	 *
 	 * @param {object} oChange - The change to register
 	 * @param {string} sCommandName - Command name of the change
+	 * @returns {Promise<undefined>} Resolves as soon as the change is registered
 	 */
-	ChangeIndicatorRegistry.prototype.registerChange = function (oChange, sCommandName) {
-		var aCategories = this.getCommandCategories();
-		var oNewChangeInformation = {
-			change: oChange,
-			commandName: sCommandName,
-			commandCategory: Object.keys(aCategories).find(function (sCommandCategoryName) {
-				return includes(aCategories[sCommandCategoryName], sCommandName);
-			}),
-			visualizationInfo: {
-				affectedElementIds: [],
-				displayElementIds: [],
-				dependentElementIds: []
+	ChangeIndicatorRegistry.prototype.registerChange = function(oChange, sCommandName) {
+		var oAppComponent = FlUtils.getAppComponentForControl(ElementUtil.getElementInstance(this.getRootControlId()));
+		return getVisualizationInfo(oChange, oAppComponent).then(function(mChangeVisualizationInfo) {
+			var aCategories = this.getCommandCategories();
+			var sCommandCategory;
+			if (sCommandName === "settings" && includes(Object.keys(aCategories), mChangeVisualizationInfo.payload.category)) {
+				sCommandCategory = mChangeVisualizationInfo.payload.category;
+			} else {
+				sCommandCategory = Object.keys(aCategories).find(function (sCommandCategoryName) {
+					return includes(aCategories[sCommandCategoryName], sCommandName);
+				});
 			}
-		};
 
-		this._oChanges[oChange.getId()] = oNewChangeInformation;
+			this._oChangeIndicatorData[oChange.getId()] = {
+				change: oChange,
+				commandName: sCommandName,
+				commandCategory: sCommandCategory,
+				visualizationInfo: mChangeVisualizationInfo
+			};
+		}.bind(this));
 	};
 
+	function getVisualizationInfo(oChange, oAppComponent) {
+		function getSelectorIds(aSelectorList) {
+			if (!aSelectorList) {
+				return undefined;
+			}
+			return aSelectorList
+				.map(function(vSelector) {
+					var oElement = typeof vSelector.getId === "function"
+						? vSelector
+						: JsControlTreeModifier.bySelector(vSelector, oAppComponent);
+					return oElement && oElement.getId();
+				})
+				.filter(Boolean);
+		}
+
+		return getInfoFromChangeHandler(oAppComponent, oChange)
+			.then(function(oInfoFromChangeHandler) {
+				var mVisualizationInfo = oInfoFromChangeHandler || {};
+				var aAffectedElementIds = getSelectorIds(mVisualizationInfo.affectedControls || [oChange.getSelector()]);
+
+				return {
+					affectedElementIds: aAffectedElementIds,
+					dependentElementIds: getSelectorIds(mVisualizationInfo.dependentControls) || [],
+					displayElementIds: getSelectorIds(mVisualizationInfo.displayControls) || aAffectedElementIds,
+					payload: mVisualizationInfo.payload || {}
+				};
+			});
+	}
+
+	function getInfoFromChangeHandler(oAppComponent, oChange) {
+		var oControl = JsControlTreeModifier.bySelector(oChange.getSelector(), oAppComponent);
+		if (oControl) {
+			return ChangesWriteAPI.getChangeHandler({
+				changeType: oChange.getChangeType(),
+				element: oControl,
+				modifier: JsControlTreeModifier,
+				layer: oChange.getLayer()
+			})
+				.then(function(oChangeHandler) {
+					if (oChangeHandler && typeof oChangeHandler.getChangeVisualizationInfo === "function") {
+						return oChangeHandler.getChangeVisualizationInfo(oChange, oAppComponent);
+					}
+					return undefined;
+				})
+				.catch(function(vErr) {
+					Log.error(vErr);
+					return undefined;
+				});
+		}
+
+		return Promise.resolve();
+	}
+
 	/**
 	 * Adds a change indicator to the registry.
 	 *
@@ -181,30 +245,11 @@ sap.ui.define([
 		this._oChangeIndicators[sSelectorId] = oChangeIndicator;
 	};
 
-	/**
-	 * Adds selectors for a registered change.
-	 *
-	 * @param {string} sChangeId - ID of the registered change
-	 * @param {object} mVisualizationInfo - Map of selector IDs to register
-	 * @param {string[]} [mVisualizationInfo.affectedElementIds] - Array of affected element IDs
-	 * @param {string[]} [mVisualizationInfo.displayElementIds] - Array of element IDs that the indicators are attached to
-	 * @param {string[]} [mVisualizationInfo.dependentElementIds] - Array of element IDs that the dependent indicators are attached to
-	 * @param {object} [mVisualizationInfo.payload] - Command category specific visualization information
-	 */
-	ChangeIndicatorRegistry.prototype.addVisualizationInfo = function (sChangeId, mVisualizationInfo) {
-		var oChange = this._oChanges[sChangeId];
-		if (oChange === undefined) {
-			throw new Error("Change id is not registered");
-		}
-
-		oChange.visualizationInfo = Object.assign({}, oChange.visualizationInfo, mVisualizationInfo);
-	};
-
 	/**
 	 * Resets the change and change indicator registries.
 	 */
 	ChangeIndicatorRegistry.prototype.reset = function () {
-		Object.keys(this._oChanges).forEach(function (sKeyToRemove) {
+		Object.keys(this._oChangeIndicatorData).forEach(function (sKeyToRemove) {
 			this.removeChange(sKeyToRemove);
 		}.bind(this));
 
@@ -220,7 +265,7 @@ sap.ui.define([
 	 * @param {string} sChangeId - ID of the registered change
 	 */
 	ChangeIndicatorRegistry.prototype.removeChange = function (sChangeId) {
-		delete this._oChanges[sChangeId];
+		delete this._oChangeIndicatorData[sChangeId];
 	};
 
 	return ChangeIndicatorRegistry;