@sapui5/sap.fe.core 1.93.3 → 1.96.2

package/src/sap/fe/core/controllerextensions/InternalIntentBasedNavigation.js

@@ -13,7 +13,8 @@ sap.ui.define(
 		"sap/ui/core/Fragment",
 		"sap/ui/model/json/JSONModel",
 		"sap/base/Log",
-		"sap/fe/core/CommonUtils"
+		"sap/fe/core/CommonUtils",
+		"sap/base/util/merge"
 	],
 	function(
 		ControllerExtension,
@@ -25,7 +26,8 @@ sap.ui.define(
 		Fragment,
 		JSONModel,
 		Log,
-		CommonUtils
+		CommonUtils,
+		mergeObjects
 	) {
 		"use strict";
 
@@ -73,20 +75,27 @@ sap.ui.define(
 					prepareFiltersForExternalNavigation: {
 						"final": true,
 						"public": true
+					},
+					getOutboundParams: {
+						"final": true,
+						"public": true
 					}
 				}
 			},
 			/**
-			 * Allows for Navigation to a given Intent(SemanticObject-Action) with the provided context.
-			 * If Semantic Object mapping is provided that is also applied to the Selection Variant after adaptation by a consumer.
+			 * Enables intent-based navigation (SemanticObject-Action) with the provided context.
+			 * If semantic object mapping is provided, this is also applied to the selection variant after the adaptation by a consumer.
 			 * This takes care of removing any technical parameters and determines if an explace or inplace navigation should take place.
 			 *
-			 * @param {string} sSemanticObject Semantic Object for the target app
+			 * @param {string} sSemanticObject Semantic object for the target app
 			 * @param {string} sAction  Action for the target app
 			 * @param {object} [mNavigationParameters] Optional parameters to be passed to the external navigation
-			 * @param {Array|object} [mNavigationParameters.navigationContexts] Single instance or multiple instances of {@link sap.ui.model.odata.v4.Context} or alternatively an object or array of objects to be passed to intent.
-			 *		  if an array of contexts is passed the context is used to determine the meta path and accordingly remove the sensitive data
-			 *		  if an array of objects is passed the following format is expected :
+			 * @param {Array|object} [mNavigationParameters.navigationContexts] Uses one of the following to be passed to the intent:
+			 *    a single instance of {@link sap.ui.model.odata.v4.Context}
+			 *    multiple instances of {@link sap.ui.model.odata.v4.Context}
+			 *    an object or an array of objects
+			 *		  If an array of objects is passed, the context is used to determine the metaPath and to remove any sensitive data
+			 *		  If an array of objects is passed, the following format ix expected:
 			 *		  {
 			 *			data: {
 			 *	 			ProductID: 7634,
@@ -94,8 +103,9 @@ sap.ui.define(
 			 *			 },
 			 *			 metaPath: "/SalesOrderManage"
 			 *        }
-			 *		The metaPath is used to remove any sensitive data.
 			 * @param {string | object} [mNavigationParameters.semanticObjectMapping] String representation of the SemanticObjectMapping or SemanticObjectMapping that applies to this navigation
+			 * @param {object} [mNavigationParameters.defaultRefreshStrategy] Default refresh strategy to be used in case no refresh strategy is specified for the intent in the view.
+			 * @param {object} [mNavigationParameters.additionalNavigationParameters] Additional navigation parameters configured in the crossAppNavigation outbound parameters.
 			 **/
 			navigate: function(sSemanticObject, sAction, mNavigationParameters) {
 				var that = this;
@@ -104,10 +114,13 @@ sap.ui.define(
 						aNavigationContexts =
 							vNavigationContexts && !Array.isArray(vNavigationContexts) ? [vNavigationContexts] : vNavigationContexts,
 						vSemanticObjectMapping = mNavigationParameters && mNavigationParameters.semanticObjectMapping,
+						vOutboundParams = mNavigationParameters && mNavigationParameters.additionalNavigationParameters,
 						oTargetInfo = {
 							semanticObject: sSemanticObject,
 							action: sAction
-						};
+						},
+						oView = that.base.getView(),
+						oController = oView.getController();
 
 					if (oContext) {
 						that._oView.setBindingContext(oContext);
@@ -161,27 +174,40 @@ sap.ui.define(
 							oSelectionVariant.setFilterContextUrl(sContextUrl);
 						}
 
+						// Apply Outbound Parameters to the SV
+						if (vOutboundParams) {
+							that._applyOutboundParams(oSelectionVariant, vOutboundParams);
+						}
+
 						// 4. give an opportunity for the application to influence the SelectionVariant
-						that.base
-							.getView()
-							.getController()
-							.intentBasedNavigation.adaptNavigationContext(oSelectionVariant, oTargetInfo);
+						oController.intentBasedNavigation.adaptNavigationContext(oSelectionVariant, oTargetInfo);
 
 						// 5. Apply semantic object mappings to the SV
 						if (vSemanticObjectMapping) {
 							that._applySemanticObjectMappings(oSelectionVariant, vSemanticObjectMapping);
 						}
 
-						// 6. remove tehnical parameters from Selection Variant
+						// 6. remove technical parameters from Selection Variant
 						that._removeTechnicalParameters(oSelectionVariant);
 
 						// 7. check if programming model is sticky and page is editable
-						var sNavMode = that.base
-							.getView()
-							.getController()
-							._intentBasedNavigation.getNavigationMode();
+						var sNavMode = oController._intentBasedNavigation.getNavigationMode();
+
+						// 8. Updating refresh strategy in internal model
+						var mRefreshStrategies = (mNavigationParameters && mNavigationParameters.refreshStrategies) || {},
+							oInternalModel = oView.getModel("internal");
+						if (oInternalModel) {
+							if (oView && oView.getViewData().refreshStrategyOnAppRestore) {
+								var mViewRefreshStrategies = oView.getViewData().refreshStrategyOnAppRestore || {};
+								mergeObjects(mRefreshStrategies, mViewRefreshStrategies);
+							}
+							var mRefreshStrategy = CommonUtils.getRefreshStrategyForIntent(mRefreshStrategies, sSemanticObject, sAction);
+							if (mRefreshStrategy) {
+								oInternalModel.setProperty("/refreshStrategyOnAppRestore", mRefreshStrategy);
+							}
+						}
 
-						// 7. Navigate via NavigationHandler
+						// 9. Navigate via NavigationHandler
 						var onError = function() {
 							sap.ui.require(["sap/m/MessageBox"], function(MessageBox) {
 								var oResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core");
@@ -425,7 +451,7 @@ sap.ui.define(
 			 * @returns {string}
 			 */
 			getNavigationMode: function() {
-				return "inplace";
+				return undefined;
 			},
 			/**
 			 * Allows for Navigation to a given Intent(SemanticObject-Action) with the provided context with a dialog showing the contexts which cannot be passed
@@ -640,7 +666,7 @@ sap.ui.define(
 				}
 				var sSemanticObject = oOutbound.semanticObject,
 					sAction = oOutbound.action,
-					outboundParams = oOutbound.parameters && this._getOutboundParams(oOutbound.parameters);
+					outboundParams = oOutbound.parameters && this.getOutboundParams(oOutbound.parameters);
 
 				if (mNavigationParameters) {
 					var aNavParams = [];
@@ -670,13 +696,29 @@ sap.ui.define(
 			},
 
 			/**
-			 * Gets parameters in app descriptor outbounds.
+			 * Method to apply outbound parameters defined in the manifest.
+			 * @param {object} oSelectionVariant SelectionVariant consisting of a filter bar, a table, and a page context
+			 * @param {object} vOutboundParams Outbound Properties defined in the manifest
+			 * @returns {object} - The modified SelectionVariant with outbound parameters.
+			 */
+			_applyOutboundParams: function(oSelectionVariant, vOutboundParams) {
+				var aParameters = Object.keys(vOutboundParams);
+				var aSelectProperties = oSelectionVariant.getSelectOptionsPropertyNames();
+				aParameters.forEach(function(key) {
+					if (!aSelectProperties.includes(key)) {
+						oSelectionVariant.addSelectOption(key, "I", "EQ", vOutboundParams[key]);
+					}
+				});
+				return oSelectionVariant;
+			},
+			/**
+			 * Method to get the outbound parameters defined in the manifest.
 			 *
 			 * @function
 			 * @param {object} [oOutboundParams] Parameters defined in the outbounds. Only "plain" is supported
 			 * @returns {Array} Parameters with the key-Value pair
 			 **/
-			_getOutboundParams: function(oOutboundParams) {
+			getOutboundParams: function(oOutboundParams) {
 				var oParamsMapping = {};
 				if (oOutboundParams) {
 					var aParameters = Object.keys(oOutboundParams) || [];
@@ -693,6 +735,67 @@ sap.ui.define(
 				}
 				return oParamsMapping;
 			},
+
+			/**
+			 * Triggers an outbound navigation when a user chooses the chevron.
+			 *
+			 * @param {object} oController
+			 * @param {string} sOutboundTarget Name of the outbound target (needs to be defined in the manifest)
+			 * @param {sap.ui.model.odata.v4.Context} oContext The context that contains the data for the target app
+			 * @param {string} sCreatePath Create path when the chevron is created.
+			 * @returns {Promise} Promise which is resolved once the navigation is triggered
+			 */
+
+			onChevronPressNavigateOutBound: function(oController, sOutboundTarget, oContext, sCreatePath) {
+				var oOutbounds = oController
+						.getAppComponent()
+						.getRoutingService()
+						.getOutbounds(),
+					oDisplayOutbound = oOutbounds[sOutboundTarget],
+					additionalNavigationParameters;
+				if (oDisplayOutbound && oDisplayOutbound.semanticObject && oDisplayOutbound.action) {
+					var oRefreshStrategies = {
+							intents: {}
+						},
+						oDefaultRefreshStrategy = {},
+						sMetaPath;
+
+					if (oContext) {
+						if (oContext.isA && oContext.isA("sap.ui.model.odata.v4.Context")) {
+							sMetaPath = CommonUtils.getMetaPathForContext(oContext);
+							oContext = [oContext];
+						} else {
+							sMetaPath = CommonUtils.getMetaPathForContext(oContext[0]);
+						}
+						oDefaultRefreshStrategy[sMetaPath] = "self";
+						oRefreshStrategies["_feDefault"] = oDefaultRefreshStrategy;
+					}
+
+					if (sCreatePath) {
+						var sKey = oDisplayOutbound.semanticObject + "-" + oDisplayOutbound.action;
+						oRefreshStrategies.intents[sKey] = {};
+						oRefreshStrategies.intents[sKey][sCreatePath] = "self";
+					}
+					if (oDisplayOutbound && oDisplayOutbound.parameters) {
+						var oParams = oDisplayOutbound.parameters && this.getOutboundParams(oDisplayOutbound.parameters);
+						if (Object.keys(oParams).length > 0) {
+							additionalNavigationParameters = oParams;
+						}
+					}
+
+					oController._intentBasedNavigation.navigate(oDisplayOutbound.semanticObject, oDisplayOutbound.action, {
+						navigationContexts: oContext,
+						refreshStrategies: oRefreshStrategies,
+						additionalNavigationParameters: additionalNavigationParameters
+					});
+
+					//TODO: check why returning a promise is required
+					return Promise.resolve();
+				} else {
+					throw new Error("outbound target " + sOutboundTarget + " not found in cross navigation definition of manifest");
+				}
+			},
+
 			override: {
 				onInit: function() {
 					this._oAppComponent = this.base.getAppComponent();