@sapui5/sap.fe.core 1.95.0 → 1.98.0

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

@@ -1,6 +1,6 @@
 /*!
  * SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * (c) Copyright 2009-2022 SAP SE. All rights reserved.
  */
 sap.ui.define(["sap/ui/core/mvc/ControllerExtension", "sap/ui/core/mvc/OverrideExecution"], function(
 	ControllerExtension,

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

@@ -1,6 +1,6 @@
 /*!
  * SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * (c) Copyright 2009-2022 SAP SE. All rights reserved.
  */
 sap.ui.define(
 	[
@@ -29,7 +29,8 @@ sap.ui.define(
 
 		var ProgrammingModel = FELibrary.ProgrammingModel,
 			DraftStatus = FELibrary.DraftStatus,
-			EditMode = FELibrary.EditMode;
+			EditMode = FELibrary.EditMode,
+			CreationMode = FELibrary.CreationMode;
 
 		var Extension = ControllerExtension.extend("sap.fe.core.controllerextensions.InternalEditFlow", {
 			metadata: {
@@ -94,7 +95,7 @@ sap.ui.define(
 
 							mParameters.keepTransientContextOnFailed = false; // currently not fully supported
 							mParameters.busyMode = "None";
-							mParameters.creationMode = "CreationRow";
+							mParameters.creationMode = CreationMode.CreationRow;
 							mParameters.parentControl = that.getView();
 							mParameters.createAtEnd = bCreateAtEnd;
 
@@ -200,6 +201,9 @@ sap.ui.define(
 
 						return oResult;
 					})
+					.catch(function(oError) {
+						Log.error("Error while deleting the document(s)", oError);
+					})
 					.finally(function() {
 						BusyLocker.unlock(oLockObject);
 					});
@@ -344,9 +348,10 @@ sap.ui.define(
 
 				// TODO: this setting and removing of contexts shouldn't be in the transaction helper at all
 				// for the time being I kept it and provide the internal model context to not break something
-				mParameters.internalModelContext = mParameters.id
-					? this.getView()
-							.byId(mParameters.id)
+				mParameters.internalModelContext = mParameters.controlId
+					? sap.ui
+							.getCore()
+							.byId(mParameters.controlId)
 							.getBindingContext("internal")
 					: null;
 
@@ -362,6 +367,9 @@ sap.ui.define(
 					)
 					.then(function() {
 						that.getInternalModel().setProperty("/sessionOn", false);
+					})
+					.catch(function(oError) {
+						return Promise.reject(oError);
 					});
 			},
 

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

@@ -1,6 +1,6 @@
 /*!
  * SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * (c) Copyright 2009-2022 SAP SE. All rights reserved.
  */
 sap.ui.define(
 	[
@@ -14,6 +14,7 @@ sap.ui.define(
 		"sap/ui/model/json/JSONModel",
 		"sap/base/Log",
 		"sap/fe/core/CommonUtils",
+		"sap/fe/core/helpers/KeepAliveHelper",
 		"sap/base/util/merge"
 	],
 	function(
@@ -27,6 +28,7 @@ sap.ui.define(
 		JSONModel,
 		Log,
 		CommonUtils,
+		KeepAliveHelper,
 		mergeObjects
 	) {
 		"use strict";
@@ -75,20 +77,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,
@@ -96,9 +105,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 not specified for the View.
+			 * @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;
@@ -107,6 +116,7 @@ sap.ui.define(
 						aNavigationContexts =
 							vNavigationContexts && !Array.isArray(vNavigationContexts) ? [vNavigationContexts] : vNavigationContexts,
 						vSemanticObjectMapping = mNavigationParameters && mNavigationParameters.semanticObjectMapping,
+						vOutboundParams = mNavigationParameters && mNavigationParameters.additionalNavigationParameters,
 						oTargetInfo = {
 							semanticObject: sSemanticObject,
 							action: sAction
@@ -166,6 +176,11 @@ 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
 						oController.intentBasedNavigation.adaptNavigationContext(oSelectionVariant, oTargetInfo);
 
@@ -174,7 +189,7 @@ sap.ui.define(
 							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
@@ -188,10 +203,11 @@ sap.ui.define(
 								var mViewRefreshStrategies = oView.getViewData().refreshStrategyOnAppRestore || {};
 								mergeObjects(mRefreshStrategies, mViewRefreshStrategies);
 							}
-							var mRefreshStrategy =
-								mRefreshStrategies[sSemanticObject + "-" + sAction] ||
-								mRefreshStrategies[sSemanticObject] ||
-								mRefreshStrategies["default"];
+							var mRefreshStrategy = KeepAliveHelper.getRefreshStrategyForIntent(
+								mRefreshStrategies,
+								sSemanticObject,
+								sAction
+							);
 							if (mRefreshStrategy) {
 								oInternalModel.setProperty("/refreshStrategyOnAppRestore", mRefreshStrategy);
 							}
@@ -244,6 +260,14 @@ sap.ui.define(
 			 * @returns {object} Object of prepared attributes for external navigation and no conflict properties.
 			 */
 			prepareContextForExternalNavigation: function(oSemanticAttributes, oContext) {
+				// 1. Find all distinct keys in the object SemanticAttributes
+				// Store meta path for each occurence of the key
+				var oDistinctKeys = {},
+					sContextPath = oContext.getPath(),
+					oMetaModel = oContext.getModel().getMetaModel(),
+					sMetaPath = oMetaModel.getMetaPath(sContextPath),
+					aMetaPathParts = sMetaPath.split("/").filter(Boolean);
+
 				function _findDistinctKeysInObject(LookUpObject, sLookUpObjectMetaPath) {
 					for (var sKey in LookUpObject) {
 						// null case??
@@ -261,13 +285,7 @@ sap.ui.define(
 						}
 					}
 				}
-				// 1. Find all distinct keys in the object SemanticAttributes
-				// Store meta path for each occurence of the key
-				var oDistinctKeys = {},
-					sContextPath = oContext.getPath(),
-					oMetaModel = oContext.getModel().getMetaModel(),
-					sMetaPath = oMetaModel.getMetaPath(sContextPath),
-					aMetaPathParts = sMetaPath.split("/").filter(Boolean);
+
 				_findDistinctKeysInObject(oSemanticAttributes, sMetaPath);
 
 				// 2. Determine distinct key value and add conflicted paths to semantic attributes
@@ -355,6 +373,7 @@ sap.ui.define(
 			 * @returns {object} Object of prepared filter conditions for external navigation and no conflict filters.
 			 */
 			prepareFiltersForExternalNavigation: function(oFilterBarConditions, sRootPath, aParameters) {
+				var oDistinctKeys = {};
 				function _findDistinctKeysInObject(LookUpObject, sLookUpObjectMetaPath) {
 					for (var sKey in LookUpObject) {
 						if (LookUpObject[sKey]) {
@@ -375,7 +394,6 @@ sap.ui.define(
 						}
 					}
 				}
-				var oDistinctKeys = {};
 
 				_findDistinctKeysInObject(oFilterBarConditions, sRootPath);
 				var oFilterConditionsWithoutConflict = {};
@@ -441,21 +459,21 @@ 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
-			 * If Semantic Object mapping is provided that is also applied to the Selection Variant after adaptation by a consumer.
-			 * This takes care of removing any technical parameters and determines if an explace or inplace navigation should take place.
+			 * Allows for navigation to a given intent (SemanticObject-Action) with the provided context, using a dialog that shows the contexts which cannot be passed
+			 * If semantic object mapping is provided, this setting is also applied to the selection variant after adaptation by a consumer.
+			 * This setting also removes any technical parameters and determines if an inplace or explace 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.
-			 * @param {Array|object} [mNavigationParameters.applicableContexts] 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 and for which the IBN button is enabled
-			 * @param {Array|object} [mNavigationParameters.notApplicableContexts] Single instance or multiple instances of {@link sap.ui.model.odata.v4.Context} or alternatively an object or array of objects which cannot be passed to the intent.
+			 * @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 the intent.
+			 * @param {Array|object} [mNavigationParameters.applicableContexts] 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 the intent and for which the IBN button is enabled
+			 * @param {Array|object} [mNavigationParameters.notApplicableContexts] Single instance or multiple instances of {@link sap.ui.model.odata.v4.Context}, or alternatively an object or array of objects, which cannot be passed to the 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 :
+			 *		  If an array of objects is passed, the following format is expected:
 			 *		  {
 			 *			data: {
 			 *	 			ProductID: 7634,
@@ -656,7 +674,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 = [];
@@ -686,13 +704,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) || [];
@@ -711,13 +745,13 @@ sap.ui.define(
 			},
 
 			/**
-			 * Triggers an outbound navigation on Chevron Press.
+			 * 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 contain the data for the target app
-			 * @param {string} sCreatePath Create path in case of chevron create.
-			 * @returns {Promise} Promise which is resolved once the navigation is triggered (??? maybe only once finished?)
+			 * @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) {
@@ -725,32 +759,42 @@ sap.ui.define(
 						.getAppComponent()
 						.getRoutingService()
 						.getOutbounds(),
-					oDisplayOutbound = oOutbounds[sOutboundTarget];
+					oDisplayOutbound = oOutbounds[sOutboundTarget],
+					additionalNavigationParameters;
 				if (oDisplayOutbound && oDisplayOutbound.semanticObject && oDisplayOutbound.action) {
-					var oRefreshStrategies = {},
+					var oRefreshStrategies = {
+							intents: {}
+						},
 						oDefaultRefreshStrategy = {},
 						sMetaPath;
 
 					if (oContext) {
 						if (oContext.isA && oContext.isA("sap.ui.model.odata.v4.Context")) {
-							sMetaPath = CommonUtils.getMetaPathForContext(oContext);
+							sMetaPath = ModelHelper.getMetaPathForContext(oContext);
 							oContext = [oContext];
 						} else {
-							sMetaPath = CommonUtils.getMetaPathForContext(oContext[0]);
+							sMetaPath = ModelHelper.getMetaPathForContext(oContext[0]);
 						}
 						oDefaultRefreshStrategy[sMetaPath] = "self";
-						oRefreshStrategies["default"] = oDefaultRefreshStrategy;
+						oRefreshStrategies["_feDefault"] = oDefaultRefreshStrategy;
 					}
 
 					if (sCreatePath) {
 						var sKey = oDisplayOutbound.semanticObject + "-" + oDisplayOutbound.action;
-						oRefreshStrategies[sKey] = {};
-						oRefreshStrategies[sKey][sCreatePath] = "self";
+						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
+						refreshStrategies: oRefreshStrategies,
+						additionalNavigationParameters: additionalNavigationParameters
 					});
 
 					//TODO: check why returning a promise is required