@openui5/sap.ui.rta 1.103.1 → 1.106.0

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

@@ -0,0 +1,331 @@
+/*!
+ * 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/merge",
+	"sap/ui/fl/apply/api/FlexRuntimeInfoAPI",
+	"sap/ui/fl/write/api/ReloadInfoAPI",
+	"sap/ui/fl/write/api/VersionsAPI",
+	"sap/ui/fl/Layer",
+	"sap/ui/fl/Utils",
+	"sap/ui/rta/Utils"
+], function(
+	merge,
+	FlexRuntimeInfoAPI,
+	ReloadInfoAPI,
+	VersionsAPI,
+	Layer,
+	FlUtils,
+	Utils
+) {
+	"use strict";
+
+	/**
+	 * Static class to handle all the reload related functionality for UI Adaptation
+	 *
+	 * @class
+	 * @namespace sap.ui.rta.util.ReloadManager
+	 * @alias sap.ui.rta.util.ReloadManager
+	 * @since 1.104
+	 * @version 1.106.0
+	 * @private
+	 * @ui5-restricted
+	 */
+	var ReloadManager = {};
+
+	var mUShellServices = {};
+	var mReloadMethods = {
+		NOT_NEEDED: "NO_RELOAD",
+		VIA_HASH: "CROSS_APP_NAVIGATION",
+		RELOAD_PAGE: "HARD_RELOAD"
+	};
+
+	/**
+	 * Builds the navigation arguments object required to trigger the navigation
+	 * using the <code>CrossApplicationNavigation</code> ushell service.
+	 *
+	 * @param {object} mParsedHash Parsed URL hash
+	 * @return {object} Argument map ("oArg" parameter of the "toExternal" function)
+	 */
+	function buildNavigationArguments(mParsedHash) {
+		return {
+			target: {
+				semanticObject: mParsedHash.semanticObject,
+				action: mParsedHash.action,
+				context: mParsedHash.contextRaw
+			},
+			params: mParsedHash.params,
+			appSpecificRoute: mParsedHash.appSpecificRoute,
+			writeHistory: false
+		};
+	}
+
+	function getReloadMessageOnStart(oReloadInfo) {
+		var sReason;
+		var bIsCustomerLayer = oReloadInfo.layer === Layer.CUSTOMER;
+
+		if (oReloadInfo.hasHigherLayerChanges && oReloadInfo.isDraftAvailable) {
+			sReason = bIsCustomerLayer ? "MSG_VIEWS_OR_PERSONALIZATION_AND_DRAFT_EXISTS" : "MSG_HIGHER_LAYER_CHANGES_AND_DRAFT_EXISTS";
+		} else if (oReloadInfo.hasHigherLayerChanges && oReloadInfo.allContexts) {
+			sReason = "MSG_RESTRICTED_CONTEXT_EXIST_AND_PERSONALIZATION";
+		} else if (oReloadInfo.hasHigherLayerChanges) {
+			sReason = bIsCustomerLayer ? "MSG_PERSONALIZATION_OR_PUBLIC_VIEWS_EXISTS" : "MSG_HIGHER_LAYER_CHANGES_EXIST";
+		} else if (oReloadInfo.isDraftAvailable) {
+			sReason = "MSG_DRAFT_EXISTS";
+		} else if (oReloadInfo.allContexts) {
+			sReason = "MSG_RESTRICTED_CONTEXT_EXIST";
+		} // TODO add app descr changes case for start?
+		return sReason;
+	}
+
+	function getReloadMessageOnExit(oReloadInfo) {
+		var bIsCustomerLayer = oReloadInfo.layer === Layer.CUSTOMER;
+
+		if (oReloadInfo.hasHigherLayerChanges) {
+			if (!bIsCustomerLayer) {
+				return "MSG_RELOAD_WITH_ALL_CHANGES";
+			}
+			if (oReloadInfo.isDraftAvailable) {
+				return "MSG_RELOAD_WITH_VIEWS_PERSONALIZATION_AND_WITHOUT_DRAFT";
+			}
+			if (oReloadInfo.allContexts) {
+				return "MSG_RELOAD_WITH_PERSONALIZATION_AND_RESTRICTED_CONTEXT";
+			}
+			return "MSG_RELOAD_WITH_PERSONALIZATION_AND_VIEWS";
+		}
+
+		if (oReloadInfo.initialDraftGotActivated) {
+			return "MSG_RELOAD_ACTIVATED_DRAFT";
+		}
+
+		if (oReloadInfo.isDraftAvailable) {
+			return "MSG_RELOAD_WITHOUT_DRAFT";
+		}
+
+		if (oReloadInfo.changesNeedReload) {
+			return "MSG_RELOAD_NEEDED";
+		}
+
+		if (oReloadInfo.allContexts) {
+			return "MSG_RELOAD_WITHOUT_ALL_CONTEXT";
+		}
+		return undefined;
+	}
+
+	function handleReloadMessageBoxOnExit(oReloadReasons) {
+		var sReason = getReloadMessageOnExit(oReloadReasons);
+
+		if (sReason) {
+			return Utils.showMessageBox("information", sReason, {
+				titleKey: "HEADER_RELOAD_NEEDED"
+			});
+		}
+		return Promise.resolve();
+	}
+
+	function triggerReloadOnStart(oReloadInfo, bVersioningEnabled, bDeveloperMode) {
+		if (mUShellServices.CrossApplicationNavigation && bVersioningEnabled) {
+			// clears FlexState and triggers reloading of the flex data without blocking
+			if (oReloadInfo.isDraftAvailable) {
+				VersionsAPI.loadDraftForApplication({
+					control: oReloadInfo.selector,
+					layer: oReloadInfo.layer,
+					allContexts: oReloadInfo.allContexts
+				});
+			} else {
+				VersionsAPI.loadVersionForApplication({
+					control: oReloadInfo.selector,
+					layer: oReloadInfo.layer,
+					allContexts: oReloadInfo.allContexts
+				});
+			}
+		}
+		var sReason = getReloadMessageOnStart(oReloadInfo);
+		// showing messages in visual editor is leading to blocked screen. In this case we should reload without message
+		var pMessageBox = bDeveloperMode ? Promise.resolve() : Utils.showMessageBox("information", sReason);
+		return pMessageBox.then(function() {
+			ReloadManager.enableAutomaticStart(oReloadInfo.layer, oReloadInfo.selector);
+			oReloadInfo.onStart = true;
+			return ReloadManager.triggerReload(oReloadInfo);
+		})
+		.then(function() {
+			return true;
+		});
+	}
+
+	function triggerReloadForStandalone(oReloadInfo) {
+		oReloadInfo.parameters = document.location.search;
+		if (oReloadInfo.onStart) {
+			ReloadInfoAPI.handleParametersOnStart(oReloadInfo, "standalone");
+		} else {
+			ReloadInfoAPI.handleUrlParameters(oReloadInfo, "standalone");
+		}
+
+		if (document.location.search === oReloadInfo.parameters) {
+			ReloadManager.reloadPage();
+		} else {
+			ReloadManager.setUriParameters(oReloadInfo.parameters);
+		}
+	}
+
+	function triggerReloadForFLP(oReloadInfo) {
+		oReloadInfo.URLParsingService = mUShellServices.URLParsing;
+		oReloadInfo.parsedHash = FlUtils.getParsedURLHash(mUShellServices.URLParsing);
+		oReloadInfo.parameters = oReloadInfo.parsedHash.params;
+		var bChanged = oReloadInfo.onStart ? ReloadInfoAPI.handleParametersOnStart(oReloadInfo, "flp") : ReloadInfoAPI.handleUrlParameters(oReloadInfo, "flp");
+
+		if (bChanged) {
+			// if a hard reload is required the crossAppNav still has to be triggered to update the URL
+			mUShellServices.CrossApplicationNavigation.toExternal(buildNavigationArguments(oReloadInfo.parsedHash));
+		} else {
+			mUShellServices.AppLifeCycle.reloadCurrentApp();
+		}
+		if (oReloadInfo.triggerHardReload) {
+			ReloadManager.reloadPage();
+		}
+	}
+
+	ReloadManager.setUShellServices = function(mPassedUShellServices) {
+		mUShellServices = mPassedUShellServices;
+	};
+
+	/**
+	 * Enables automatic key user adaptation start.
+	 *
+	 * @param {sap.ui.fl.Layer} sLayer - Active layer
+	 * @param {sap.ui.core.Control} oRootControl - Root control for which key user adaptation was started
+	 */
+	ReloadManager.enableAutomaticStart = function(sLayer, oRootControl) {
+		var sFlexReference = FlexRuntimeInfoAPI.getFlexReference({element: oRootControl});
+		var vParameter = sFlexReference || true;
+		window.sessionStorage.setItem("sap.ui.rta.restart." + sLayer, vParameter);
+	};
+
+	/**
+	 * Disable automatic key user adaptation start
+	 *
+	 * @param {sap.ui.fl.Layer} sLayer - Active layer
+	 */
+	ReloadManager.disableAutomaticStart = function(sLayer) {
+		window.sessionStorage.removeItem("sap.ui.rta.restart." + sLayer);
+	};
+
+	/**
+	 * Checks if the flag for an automatic key user adaptation start is set.
+	 *
+	 * @param {sap.ui.fl.Layer} sLayer - Active layer
+	 * @returns {boolean} <code>true</code> if restart is needed
+	 */
+	ReloadManager.needsAutomaticStart = function(sLayer) {
+		return !!window.sessionStorage.getItem("sap.ui.rta.restart." + sLayer);
+	};
+
+	/**
+	 * Triggers the reload of the page. Can either be a soft reload inside the FLP or a hard reload.
+	 *
+	 * @param {object} oReloadInfo - Information needed for the reload
+	 * @param {sap.ui.fl.Layer} oReloadInfo.layer - Current layer
+	 * @param {boolean} oReloadInfo.hasHigherLayerChanges - Indicates if higher layer changes exist
+	 * @param {boolean} oReloadInfo.ignoreMaxLayerParameter - Indicates if the max layer parameter should be ignored
+	 * @param {string|object} oReloadInfo.parameters - The URL parameters to be modified
+	 * @param {string} oReloadInfo.versionSwitch - Indicates if we are in a version switch scenario
+	 * @param {string} oReloadInfo.version - Version we want to switch to
+	 * @param {string} oReloadInfo.removeVersionParameter - Indicates if version parameter should be removed
+	 * @param {string} oReloadInfo.removeDraft - Indicates if draft parameter should be removed
+	 */
+	ReloadManager.triggerReload = function(oReloadInfo) {
+		if (FlUtils.getUshellContainer()) {
+			triggerReloadForFLP(oReloadInfo);
+		} else {
+			triggerReloadForStandalone(oReloadInfo);
+		}
+	};
+
+	/**
+	 * Reloads the page via the browsers window object.
+	 */
+	ReloadManager.reloadPage = function() {
+		window.location.reload();
+	};
+
+	/**
+	 * Sets the given parameters as <code>document.location.search</code> which will trigger a browser reload.
+	 * @param {string} sParameters - URL parameters
+	 */
+	ReloadManager.setUriParameters = function(sParameters) {
+		document.location.search = sParameters;
+	};
+
+	/**
+	 * Checks if there are personalization changes/draft changes and restarts the application without/with them.
+	 * Warns the user that the application will be restarted without personalization / with draft changes.
+	 * Checks if it is necessary to load all contexts.
+	 * @param {object} mProperties - Object with additional information
+	 * @param {sap.ui.fl.Layer} mProperties.layer - Current layer
+	 * @param {sap.ui.fl.Selector} mProperties.selector - Root control
+	 * @param {boolean} mProperties.versioningEnabled - Whether versioning is enabled
+	 * @param {boolean} mProperties.developerMode - Whether the developer mode is set
+	 *
+	 * @return {Promise<boolean>} Resolving to <code>false</code> means that reload is not necessary
+	 */
+	ReloadManager.handleReloadOnStart = function(mProperties) {
+		merge(mProperties, {
+			hasHigherLayerChanges: false,
+			isDraftAvailable: false,
+			ignoreMaxLayerParameter: false,
+			includeCtrlVariants: true,
+			URLParsingService: mUShellServices.URLParsing
+		});
+		return ReloadInfoAPI.getReloadReasonsForStart(mProperties).then(function(oReloadInfo) {
+			if (oReloadInfo.hasHigherLayerChanges || oReloadInfo.isDraftAvailable || oReloadInfo.allContexts) {
+				return triggerReloadOnStart(oReloadInfo, mProperties.versioningEnabled, mProperties.developerMode);
+			}
+			return undefined;
+		});
+	};
+
+	/**
+	 * When exiting key user adaptation and personalization changes exist, the user can choose to
+	 * reload the app with personalization or stay in the app without the personalization.
+	 * @param {object} mProperties - Object with additional information
+	 * @param {sap.ui.fl.Layer} mProperties.layer - Current layer
+	 * @param {sap.ui.fl.Selector} mProperties.selector - Root control
+	 * @param {boolean} mProperties.versioningEnabled - Whether versioning is enabled
+	 * @param {boolean} mProperties.isDraftAvailable - Whether a draft is available
+	 * @param {boolean} mProperties.activeVersion - Number of the active version
+	 * @param {Promise} mProperties.changesNeedReloadPromise - Resolves to whether any change needs a hard reload
+	 * @param {boolean} bSkipRestart - Stop key user adaptation without reloading the app in any way
+	 *
+	 * @return {Promise<object>} Resolving to an object containing information about whether a reload is needed and how to handle it
+	 */
+	ReloadManager.checkReloadOnExit = function(mProperties) {
+		return mProperties.changesNeedReloadPromise.then(function(bChangesNeedReload) {
+			mProperties.changesNeedReload = bChangesNeedReload;
+			mProperties.URLParsingService = mUShellServices.URLParsing;
+			var oReloadInfo = ReloadInfoAPI.getReloadMethod(mProperties);
+			return handleReloadMessageBoxOnExit(oReloadInfo).then(function() {
+				oReloadInfo.triggerHardReload = oReloadInfo.reloadMethod === mReloadMethods.RELOAD_PAGE;
+				return oReloadInfo;
+			});
+		});
+	};
+
+	/**
+	 * Reloads the app inside FLP or standalone by removing max layer / draft parameter;
+	 *
+	 * @param {object} oReloadInfo - Information needed for the reload
+	 * @param {sap.ui.fl.Layer} oReloadInfo.layer - Current layer
+	 * @param {boolean} oReloadInfo.hasHigherLayerChanges - Indicates if higher layer changes exist
+	 */
+	ReloadManager.handleUrlParametersOnExit = function(oReloadInfo) {
+		if (oReloadInfo.layer !== Layer.USER && oReloadInfo.reloadMethod !== mReloadMethods.NOT_NEEDED) {
+			oReloadInfo.removeVersionParameter = true;
+			ReloadManager.triggerReload(oReloadInfo);
+		}
+	};
+
+	return ReloadManager;
+});

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

@@ -19,7 +19,7 @@ function(
 	 *
 	 * @extends sap.ui.core.EventBus
 	 * @author SAP SE
-	 * @version 1.103.1
+	 * @version 1.106.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",
@@ -12,8 +13,10 @@ sap.ui.define([
 	"sap/ui/fl/Layer",
 	"sap/ui/fl/Utils",
 	"sap/ui/rta/util/showMessageBox",
-	"sap/ui/rta/RuntimeAuthoring"
+	"sap/ui/rta/RuntimeAuthoring",
+	"sap/ui/core/Core"
 ], function(
+	UriParameters,
 	Log,
 	Control,
 	UIComponent,
@@ -22,7 +25,8 @@ sap.ui.define([
 	Layer,
 	FlexUtils,
 	showMessageBox,
-	RuntimeAuthoring
+	RuntimeAuthoring,
+	Core
 ) {
 	"use strict";
 
@@ -31,7 +35,8 @@ sap.ui.define([
 			return FeaturesAPI.isKeyUser()
 				.then(function(bIsKeyUser) {
 					if (!bIsKeyUser) {
-						var oError = Error("Key user rights have not been granted to the current user");
+						var oRtaResourceBundle = Core.getLibraryResourceBundle("sap.ui.rta");
+						var oError = new Error(oRtaResourceBundle.getText("MSG_NO_KEY_USER_RIGHTS_ERROR_MESSAGE"));
 						oError.reason = "isKeyUser";
 						throw oError;
 					}
@@ -41,13 +46,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;
+			}
 		}
 	}
 
@@ -116,7 +125,7 @@ sap.ui.define([
 				PersistenceWriteAPI.getChangesWarning(mPropertyBag)
 					.then(function(oWarningMessage) {
 						if (oWarningMessage.showWarning) {
-							var oRtaResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.ui.rta");
+							var oRtaResourceBundle = Core.getLibraryResourceBundle("sap.ui.rta");
 							var oMessageProps = oWarningMessage.warningType === "mixedChangesWarning"
 								? {
 									text: "MSG_ADAPTATION_STARTER_MIXED_CHANGES_WARNING",
@@ -141,6 +150,12 @@ sap.ui.define([
 		})
 		.catch(function(vError) {
 			if (vError !== "Reload triggered") {
+				var oRtaResourceBundle = Core.getLibraryResourceBundle("sap.ui.rta");
+				showMessageBox(
+					oRtaResourceBundle.getText("MSG_GENERIC_ERROR_MESSAGE", vError.message),
+					{title: oRtaResourceBundle.getText("MSG_ADAPTATION_COULD_NOT_START")},
+					"error"
+				);
 				Log.error("UI Adaptation could not be started", vError.message);
 			}
 			throw vError;

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

@@ -0,0 +1,50 @@
+/*!
+ * 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/fl/changeHandler/common/ChangeCategories"
+], function(
+	FlChangeCategories
+) {
+	"use strict";
+
+	var ChangeCategories = {};
+
+	ChangeCategories.ALL = "all";
+
+	// Assignment of commands to change categories
+	var COMMANDS = {};
+	COMMANDS[FlChangeCategories.ADD] = [
+		"createContainer",
+		"addDelegateProperty",
+		"reveal",
+		"addIFrame"
+	];
+	COMMANDS[FlChangeCategories.MOVE] = ["move"];
+	COMMANDS[FlChangeCategories.RENAME] = ["rename"];
+	COMMANDS[FlChangeCategories.COMBINESPLIT] = ["combine", "split"];
+	COMMANDS[FlChangeCategories.REMOVE] = ["remove"];
+	COMMANDS[FlChangeCategories.OTHER] = [];
+
+	var CATEGORY_ICONS = {};
+	CATEGORY_ICONS[ChangeCategories.ALL] = "sap-icon://show";
+	CATEGORY_ICONS[FlChangeCategories.ADD] = "sap-icon://add";
+	CATEGORY_ICONS[FlChangeCategories.MOVE] = "sap-icon://move";
+	CATEGORY_ICONS[FlChangeCategories.RENAME] = "sap-icon://edit";
+	CATEGORY_ICONS[FlChangeCategories.COMBINESPLIT] = "sap-icon://combine";
+	CATEGORY_ICONS[FlChangeCategories.REMOVE] = "sap-icon://less";
+	CATEGORY_ICONS[FlChangeCategories.OTHER] = "sap-icon://key-user-settings";
+
+	ChangeCategories.getCategories = function() {
+		return COMMANDS;
+	};
+
+	ChangeCategories.getIconForCategory = function(sCategory) {
+		return CATEGORY_ICONS[sCategory];
+	};
+
+	return ChangeCategories;
+});