@openui5/sap.ui.rta 1.105.0 → 1.106.0

package/src/sap/ui/rta/plugin/additionalElements/AdditionalElementsAnalyzer.js

@@ -7,7 +7,6 @@
 sap.ui.define([
 	"sap/base/util/isPlainObject",
 	"sap/base/util/ObjectPath",
-	"sap/base/Log",
 	"sap/ui/core/util/reflection/JsControlTreeModifier",
 	"sap/ui/dt/ElementUtil",
 	"sap/ui/fl/apply/api/DelegateMediatorAPI",
@@ -15,7 +14,6 @@ sap.ui.define([
 ], function(
 	isPlainObject,
 	ObjectPath,
-	Log,
 	JsControlTreeModifier,
 	ElementUtil,
 	DelegateMediatorAPI,
@@ -264,9 +262,11 @@ sap.ui.define([
 		var aBindingPaths = [];
 
 		aRelevantElements.forEach(function(oElement) {
-			aBindingPaths = aBindingPaths.concat(BindingsExtractor.getBindings(oElement, oModel)
-				.map(_vBindingToPath)
-			);
+			aBindingPaths = aBindingPaths.concat(BindingsExtractor.getBindings({
+				element: oElement,
+				model: oModel,
+				parent: oElement.getParent()
+			}).map(_vBindingToPath));
 		});
 		return aBindingPaths;
 	}
@@ -399,7 +399,10 @@ sap.ui.define([
 		// BCP: 1880498671
 		} else if (_getBindingContextPath(oElement, sAggregationName, sModelName) === _getBindingContextPath(oInvisibleElement, sAggregationName, sModelName)) {
 			aBindingPaths = BindingsExtractor.collectBindingPaths(oInvisibleElement, oModel).bindingPaths;
-		} else if (mAddViaDelegate && BindingsExtractor.getBindings(oInvisibleElement, oModel).length > 0) {
+		} else if (mAddViaDelegate && BindingsExtractor.getBindings({
+			element: oInvisibleElement,
+			model: oModel
+		}).length > 0) {
 			bIncludeElement = false;
 		}
 

package/src/sap/ui/rta/plugin/additionalElements/AdditionalElementsPlugin.js

@@ -75,7 +75,7 @@ sap.ui.define([
 	 * @class The plugin allows to add additional elements that exist either hidden in the UI or in the OData service
 	 * @extends sap.ui.rta.plugin.Plugin
 	 * @author SAP SE
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 * @constructor
 	 * @private
 	 * @since 1.44
@@ -144,13 +144,13 @@ sap.ui.define([
 			return AdditionalElementsUtils.getText("CTX_ADD_ELEMENTS", mActions, mParents.parent, SINGULAR);
 		},
 
-		isAvailable: function (bOverlayIsSibling, aElementOverlays) {
+		isAvailable: function(aElementOverlays, bOverlayIsSibling) {
 			return aElementOverlays.every(function (oElementOverlay) {
 				return this._isEditableByPlugin(oElementOverlay, bOverlayIsSibling);
 			}, this);
 		},
 
-		isEnabled: function(bOverlayIsSibling, aElementOverlays, sAggregationName) {
+		isEnabled: function(aElementOverlays, bOverlayIsSibling, sAggregationName) {
 			if (aElementOverlays.length > 1) {
 				return false;
 			}
@@ -452,8 +452,8 @@ sap.ui.define([
 				var bHasChildren = aElementsWithAggregations[0].length > 0;
 				var bHasMultipleAggregations = aElementsWithAggregations[0].length > 1;
 				var bHasSiblings = aElementsWithAggregations[1].length > 0;
-				var bIsAvailableForChildren = this.isAvailable(false, aElementOverlays);
-				var bIsAvailableForSibling = this.isAvailable(true, aElementOverlays);
+				var bIsAvailableForChildren = this.isAvailable(aElementOverlays, false);
+				var bIsAvailableForSibling = this.isAvailable(aElementOverlays, true);
 				if (bIsAvailableForSibling && (!bIsAvailableForChildren || !bHasChildren)) {
 					// Case 1: Only siblings -> No submenu required
 					oMenuItem = this._buildMenuItem("CTX_ADD_ELEMENTS_AS_SIBLING", true, aElementOverlays, aElementsWithAggregations, false);
@@ -507,7 +507,7 @@ sap.ui.define([
 				id: sPluginId,
 				text: this.getContextMenuText.bind(this, bOverlayIsSibling, oSelectedOverlay, sAggregationName, bHasSubMenu),
 				enabled: bHasSubMenu || function(bOverlayIsSibling, aElementOverlays) {
-					return this.isEnabled(bOverlayIsSibling, aElementOverlays, sAggregationName);
+					return this.isEnabled(aElementOverlays, bOverlayIsSibling, sAggregationName);
 				}.bind(this, bOverlayIsSibling),
 				rank: 20,
 				icon: "sap-icon://add",
@@ -544,9 +544,9 @@ sap.ui.define([
 				var oItem = {
 					id: sPluginId + '_' + iPosition,
 					text: sDisplayText,
-					enabled: function(bOverlayIsSibling, aElementOverlays) {
-						return this.isEnabled(bOverlayIsSibling, aElementOverlays, sAggregationName);
-					}.bind(this, bOverlayIsSibling),
+					enabled: function(aElementOverlays) {
+						return this.isEnabled(aElementOverlays, bOverlayIsSibling, sAggregationName);
+					}.bind(this),
 					handler: function (bOverlayIsSibling, aElementOverlays) {
 						// showAvailableElements has optional parameters
 						return this.showAvailableElements(bOverlayIsSibling, sAggregationName, aElementOverlays, undefined, undefined, sDisplayText);

package/src/sap/ui/rta/plugin/additionalElements/AdditionalElementsUtils.js

@@ -15,7 +15,7 @@ sap.ui.define([
 	 * Helper object containing methods for the AdditionalElements plugin
 	 *
 	 * @author SAP SE
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 * @private
 	 * @since 1.94
 	 * @experimental Since 1.94. This class is experimental and provides only limited functionality. Also the API might be changed in future.

package/src/sap/ui/rta/plugin/additionalElements/CommandBuilder.js

@@ -25,7 +25,7 @@ sap.ui.define([
 	 * Helper object to build the RTA commands resulting from the AdditionalElements Plugin
 	 *
 	 * @author SAP SE
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 * @private
 	 * @since 1.94
 	 * @experimental Since 1.94. This class is experimental and provides only limited functionality. Also the API might be changed in future.
@@ -295,7 +295,7 @@ sap.ui.define([
 						throw DtUtils.propagateError(
 							vMessage,
 							"AdditionalElementsPlugin#_createCommands",
-							"Error occured during _createCommands execution",
+							"Error occurred during _createCommands execution",
 							"sap.ui.rta.plugin"
 						);
 					});

package/src/sap/ui/rta/plugin/iframe/AddIFrame.js

@@ -110,7 +110,7 @@ sap.ui.define([
 	 * @class The AddIFrame allows trigger AddIFrame operations on the overlay.
 	 * @extends sap.ui.rta.plugin.BaseCreate
 	 * @author SAP SE
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 * @constructor
 	 * @private
 	 * @since 1.75
@@ -172,7 +172,7 @@ sap.ui.define([
 		var aMenuItems = [];
 
 		var bIsSibling = true;
-		if (this.isAvailable(bIsSibling, aElementOverlays)) {
+		if (this.isAvailable(aElementOverlays, bIsSibling)) {
 			var oAction = this.getCreateAction(bIsSibling, aElementOverlays[0]);
 			if (oAction) {
 				var oSiblingMenuItem = Object.assign({
@@ -187,7 +187,7 @@ sap.ui.define([
 		}
 
 		bIsSibling = false;
-		if (this.isAvailable(bIsSibling, aElementOverlays)) {
+		if (this.isAvailable(aElementOverlays, bIsSibling)) {
 			aMenuItems = aMenuItems.concat(this.getCreateActions(bIsSibling, aElementOverlays[0])
 				.map(function(oAction, iIndex) {
 					var oParentMenuItem = Object.assign({

package/src/sap/ui/rta/plugin/iframe/AddIFrameDialog.js

@@ -113,7 +113,7 @@ sap.ui.define([
 	 * @class Context - Dialog for IFrame settings in Runtime Authoring
 	 * @extends sap.ui.base.ManagedObject
 	 * @author SAP SE
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 * @constructor
 	 * @private
 	 * @since 1.78

package/src/sap/ui/rta/service/Action.js

@@ -25,7 +25,7 @@ sap.ui.define([
 	 * @author SAP SE
 	 * @experimental Since 1.58
 	 * @since 1.58
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 * @private
 	 * @ui5-restricted
 	 *

package/src/sap/ui/rta/service/ControllerExtension.js

@@ -31,7 +31,7 @@ sap.ui.define([
 	 * @author SAP SE
 	 * @experimental Since 1.58
 	 * @since 1.58
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 * @private
 	 * @ui5-restricted
 	*/

package/src/sap/ui/rta/service/Outline.js

@@ -42,7 +42,7 @@ sap.ui.define([
 	 * @author SAP SE
 	 * @experimental Since 1.56
 	 * @since 1.56
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 * @private
 	 * @ui5-restricted
 	 */

package/src/sap/ui/rta/service/Property.js

@@ -28,7 +28,7 @@ sap.ui.define([
 	 * @author SAP SE
 	 * @experimental Since 1.58
 	 * @since 1.58
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 * @private
 	 * @ui5-restricted
 	*/

package/src/sap/ui/rta/service/Selection.js

@@ -15,7 +15,7 @@ sap.ui.define(function () {
 	 * @author SAP SE
 	 * @experimental Since 1.58
 	 * @since 1.58
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 * @private
 	 * @ui5-restricted
 	*/

package/src/sap/ui/rta/service/SupportTools.js

@@ -0,0 +1,189 @@
+/*!
+ * 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/ui/core/Core",
+	"sap/ui/core/util/reflection/JsControlTreeModifier",
+	"sap/ui/fl/write/api/ChangesWriteAPI"
+], function(
+	Core,
+	JsControlTreeModifier,
+	ChangesWriteAPI
+) {
+	"use strict";
+
+	/**
+	 * Service to register message event listeners for the communication with the
+	 * Flex Support web extension.
+	 *
+	 * This is implemented as a service and not as part of the injected script because
+	 * there is no easy way to retrieve the RuntimeAuthoring instance otherwise.
+	 *
+	 * @namespace
+	 * @name sap.ui.rta.service.SupportTools
+	 * @author SAP SE
+	 * @experimental Since 1.106
+	 * @since 1.106
+	 * @version 1.106.0
+	 * @private
+	 * @ui5-restricted
+	 */
+
+	function getPluginChangeHandler(oPlugin, oElementOverlay, oRta) {
+		var oAction = oPlugin.getAction(oElementOverlay);
+		if (oAction && oAction.changeType) {
+			var oElement = oAction.changeOnRelevantContainer
+				? oElementOverlay.getRelevantContainer()
+				: oElementOverlay.getElement();
+			return ChangesWriteAPI.getChangeHandler({
+				changeType: oAction.changeType,
+				element: oElement,
+				modifier: JsControlTreeModifier,
+				layer: oRta.getLayer()
+			})
+				.then(function(oChangeHandler) {
+					return oChangeHandler;
+				})
+				.catch(function() {
+					return;
+				});
+		}
+		return Promise.resolve(undefined);
+	}
+
+	function isPluginForSibling(sPluginName) {
+		if (sPluginName.endsWith(".asSibling")) {
+			return true;
+		}
+		if (sPluginName.endsWith(".asChild")) {
+			return false;
+		}
+		return undefined;
+	}
+
+	function getPluginByName(oRta, sPluginName) {
+		var bIsSibling = isPluginForSibling(sPluginName);
+		var oAllPlugins = oRta.getPlugins();
+		return Object.values(oAllPlugins).find(function(oPlugin) {
+			var sName = oPlugin._retrievePluginName
+				? oPlugin._retrievePluginName(bIsSibling)
+				: oPlugin.getMetadata().getName();
+			return sName === sPluginName;
+		});
+	}
+
+	/*
+	 * Returns information about an overlay, namely:
+	 *  For every plugin that is part of the "editableByPlugins"
+	 *  aggregation, we return the plugin name and the result for
+	 *  isAvailable(). If the change handler can be determined, we
+	 *  return this information, which enables a button allowing the
+	 *  key user to print the change handler to the console.
+	 *
+	 * @method sap.ui.rta.service.SupportTools.getOverlayInfo
+	 * @param {sap.ui.rta.RuntimeAuthoring} oRta - Instance of the RuntimeAuthoring class
+	 * @param {object} mPayload - Property Bag
+	 * @param {string} mPayload.overlayId
+	 */
+	function getOverlayInfo(oRta, mPayload) {
+		var oOverlay = Core.byId(mPayload.overlayId);
+		var oElement = oOverlay.getElement();
+
+		return Promise.all(oOverlay.getEditableByPlugins().map(function(sPluginName) {
+			var oInstance = getPluginByName(oRta, sPluginName);
+			var bIsSibling = isPluginForSibling(sPluginName);
+
+			return getPluginChangeHandler(oInstance, oOverlay, oRta)
+				.then(function(oChangeHandler) {
+					return {
+						name: sPluginName,
+						isAvailable: oInstance.isAvailable([oOverlay], bIsSibling),
+						hasChangeHandler: !!oChangeHandler
+					};
+				});
+		}))
+			.then(function(aPlugins) {
+				return {
+					elementId: oElement.getId(),
+					elementControlType: oElement.getMetadata().getName(),
+					overlayId: oOverlay.getId(),
+					plugins: aPlugins
+				};
+			});
+	}
+
+	function printChangeHandler(oRta, mPayload) {
+		var oOverlay = Core.byId(mPayload.overlayId);
+		var oPlugin = getPluginByName(oRta, mPayload.pluginName);
+		getPluginChangeHandler(oPlugin, oOverlay, oRta)
+			.then(console.log); // eslint-disable-line no-console
+	}
+
+	// List of supported handlers
+	var mHandlers = {
+		getOverlayInfo: {
+			handler: getOverlayInfo,
+			returnMessageType: "overlayInfo",
+			id: "ui5FlexibilitySupport.submodules.overlayInfo"
+		},
+		printChangeHandler: {
+			handler: printChangeHandler,
+			id: "ui5FlexibilitySupport.submodules.overlayInfo"
+		}
+	};
+
+	/*
+	 * Event handler for the messages sent by the support extension.
+	 *
+	 * Messages are contained in oEvent.data - the following properties
+	 * are sent:
+	 *  - type: specifies, what action should be taken. Possible values:
+	 *   - getOverlayInfo (request information about an overlay)
+	 *   - printChangeHandler (a specified change handler object is to be printed to the console)
+	 * - content: type-specific information, e.g. for getOverlayInfo, an 'overlayId' is provided
+	 *
+	 * @method sap.ui.rta.service.SupportTools.onMessageReceived
+	 * @param {sap.ui.rta.RuntimeAuthoring} oRta - Instance of the RuntimeAuthoring class
+	 * @param {object} oEvent - Event thrown by the browser on received message
+	 */
+	function onMessageReceived(oRta, oEvent) {
+		if (oEvent.source !== window) {
+			return;
+		}
+
+		var aHandler = Object.entries(mHandlers).find(function(aEntry) {
+			return (
+				aEntry[0] === oEvent.data.type
+				&& aEntry[1].id === oEvent.data.id
+			);
+		});
+		var mHandler = aHandler && aHandler[1];
+
+		if (mHandler) {
+			Promise.resolve(mHandler.handler(oRta, oEvent.data.content))
+				.then(function(oResult) {
+					if (mHandler.returnMessageType) {
+						oEvent.source.postMessage({
+							id: mHandler.id,
+							type: mHandler.returnMessageType,
+							content: oResult
+						});
+					}
+				});
+		}
+	}
+
+	return function(oRta) {
+		var fnOnMessageReceivedBound = onMessageReceived.bind(null, oRta);
+		window.addEventListener("message", fnOnMessageReceivedBound);
+
+		return {
+			destroy: function() {
+				window.removeEventListener("message", fnOnMessageReceivedBound);
+			}
+		};
+	};
+});

package/src/sap/ui/rta/service/index.js

@@ -8,11 +8,12 @@ sap.ui.define(function () {
 	"use strict";
 
 	return Object.freeze({
-		selection: 'sap.ui.rta.service.Selection',
-		receiver: 'sap.ui.rta.service.Receiver',
-		controllerExtension: 'sap.ui.rta.service.ControllerExtension',
-		outline: 'sap.ui.rta.service.Outline',
-		action: 'sap.ui.rta.service.Action',
-		property: 'sap.ui.rta.service.Property'
+		selection: "sap.ui.rta.service.Selection",
+		receiver: "sap.ui.rta.service.Receiver",
+		controllerExtension: "sap.ui.rta.service.ControllerExtension",
+		outline: "sap.ui.rta.service.Outline",
+		action: "sap.ui.rta.service.Action",
+		property: "sap.ui.rta.service.Property",
+		supportTools: "sap.ui.rta.service.SupportTools"
 	});
 });

package/src/sap/ui/rta/toolbar/Adaptation.fragment.xml

@@ -119,7 +119,7 @@
 				<Button
 						id="sapUiRta_toggleChangeVisualizationMenuButton"
 						visible="{= ${controls>/modeSwitcher} === 'visualization'}"
-						text="{visualizationModel>/commandCategoryText}"
+						text="{visualizationModel>/changeCategoryText}"
 						type="Transparent"
 						icon="sap-icon://slim-arrow-down"
 						iconFirst="false"
@@ -204,6 +204,16 @@
 						<OverflowToolbarLayoutData priority="Low" />
 					</layoutData>
 				</MenuButton>
+				<toolbar:OverflowToolbarButton
+						id="sapUiRta_saveAsContextBasedAdaptation"
+						visible="{= (${controls>/contextBasedAdaptationVisible} &amp;&amp; ${controls>/modeSwitcher} === 'adaptation')}"
+						press=".saveAsContextBasedAdaptation"
+						type="Transparent"
+						text="{i18n>BTN_SAVE_AS}" >
+					<toolbar:layoutData>
+						<OverflowToolbarLayoutData priority="Low" />
+					</toolbar:layoutData>
+				</toolbar:OverflowToolbarButton>
 				<toolbar:OverflowToolbarButton
 						id="sapUiRta_saveAs"
 						visible="{= (${controls>/saveAsVisible} &amp;&amp; ${controls>/modeSwitcher} === 'adaptation')}"

package/src/sap/ui/rta/toolbar/Adaptation.js

@@ -7,6 +7,7 @@
 sap.ui.define([
 	"sap/ui/core/Fragment",
 	"sap/ui/fl/write/api/Version",
+	"sap/ui/rta/toolbar/contextBased/SaveAsContextBasedAdaptation",
 	"sap/ui/rta/toolbar/translation/Translation",
 	"sap/ui/rta/toolbar/versioning/Versioning",
 	"sap/ui/rta/appVariant/Feature",
@@ -16,6 +17,7 @@ sap.ui.define([
 ], function(
 	Fragment,
 	Version,
+	SaveAsContextBasedAdaptation,
 	Translation,
 	Versioning,
 	AppVariantFeature,
@@ -33,7 +35,7 @@ sap.ui.define([
 	 * @extends sap.ui.rta.toolbar.Base
 	 *
 	 * @author SAP SE
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 *
 	 * @constructor
 	 * @private
@@ -207,6 +209,7 @@ sap.ui.define([
 				manageApps: onManageAppsPressed.bind(this),
 				appVariantOverview: onOverviewPressed.bind(this),
 				saveAs: onSaveAsPressed.bind(this),
+				saveAsContextBasedAdaptation: onSaveAsContextBasedAdaptation.bind(this),
 				formatSaveAsEnabled: formatSaveAsEnabled,
 				restore: this.eventHandler.bind(this, "Restore"),
 				publish: this.eventHandler.bind(this, "Transport"),
@@ -239,6 +242,10 @@ sap.ui.define([
 		AppVariantFeature.onSaveAs(true, true, this.getRtaInformation().flexSettings.layer, null);
 	}
 
+	function onSaveAsContextBasedAdaptation() {
+		this.getExtension("adaptation", SaveAsContextBasedAdaptation).openAddAdaptationDialog(this.getRtaInformation().flexSettings.layer);
+	}
+
 	function onOverviewPressed(oEvent) {
 		var oItem = oEvent.getParameter("item");
 		var bTriggeredForKeyUser = oItem.getId().endsWith("keyUser");

package/src/sap/ui/rta/toolbar/Base.js

@@ -27,7 +27,7 @@ sap.ui.define([
 	 * @extends sap.m.HBox
 	 *
 	 * @author SAP SE
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/rta/toolbar/Fiori.js

@@ -32,7 +32,7 @@ function(
 	 * @extends sap.ui.rta.toolbar.Adaptation
 	 *
 	 * @author SAP SE
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/rta/toolbar/FioriLike.js

@@ -20,7 +20,7 @@ function(
 	 * @extends sap.ui.rta.toolbar.Adaptation
 	 *
 	 * @author SAP SE
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/rta/toolbar/OverflowToolbarButton.js

@@ -23,7 +23,7 @@ sap.ui.define([
 	 * @extends sap.m.OverflowToolbarButton
 	 *
 	 * @author SAP SE
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/rta/toolbar/Personalization.js

@@ -22,7 +22,7 @@ function(
 	 * @extends sap.ui.rta.toolbar.Base
 	 *
 	 * @author SAP SE
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/rta/toolbar/Standalone.js

@@ -20,7 +20,7 @@ function(
 	 * @extends sap.ui.rta.toolbar.Adaptation
 	 *
 	 * @author SAP SE
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 *
 	 * @constructor
 	 * @private