@sapui5/sap.fe.core 1.94.0 → 1.96.3

package/src/sap/fe/core/CommonUtils.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(
@@ -693,14 +693,24 @@ sap.ui.define(
 			return aOutAttributes;
 		}
 
+		function _fnCheckIsMatch(oObject, oKeysToCheck) {
+			for (var sKey in oKeysToCheck) {
+				if (oKeysToCheck[sKey] !== oObject[sKey]) {
+					return false;
+				}
+			}
+			return true;
+		}
+
 		/**
 		 * Method to get metadata of entityset properties.
 		 *
 		 * @param {object} oMetaModel MetaModel for annotations
 		 * @param {string} sContextPath ContextPath for properities
+		 * @param {object} oFilter Filter for the properties
 		 * @returns {object} The entity type properties
 		 */
-		function fnGetContextPathProperties(oMetaModel, sContextPath) {
+		function fnGetContextPathProperties(oMetaModel, sContextPath, oFilter) {
 			var oEntityType = oMetaModel.getObject(sContextPath + "/") || {},
 				oProperties = {};
 
@@ -709,7 +719,7 @@ sap.ui.define(
 					oEntityType.hasOwnProperty(sKey) &&
 					!/^\$/i.test(sKey) &&
 					oEntityType[sKey].$kind &&
-					oEntityType[sKey].$kind === "Property"
+					_fnCheckIsMatch(oEntityType[sKey], oFilter || { $kind: "Property" })
 				) {
 					oProperties[sKey] = oEntityType[sKey];
 				}
@@ -787,7 +797,7 @@ sap.ui.define(
 								params: oParams
 							})
 							.then(function(aLink) {
-								oIBNAction.setVisible(aLink && aLink.length === 1);
+								oIBNAction.setVisible(oIBNAction.getVisible() && aLink && aLink.length === 1);
 							})
 							.catch(function(oError) {
 								Log.error("Cannot retrieve the links from the shell service", oError);
@@ -815,8 +825,8 @@ sap.ui.define(
 		 *
 		 * @param {string} sFrameworkKey Current key.
 		 * @param {object} oResourceBundle Contains the local resource bundle
-		 * @param {object} oParams Parameter object for the resource value
-		 * @param {object} sEntitySetName EntitySet name of the control where the resource is being used
+		 * @param {object} [oParams] Parameter object for the resource value
+		 * @param {string} [sEntitySetName] EntitySet name of the control where the resource is being used
 		 * @returns {string} The translated text
 		 */
 		function getTranslatedText(sFrameworkKey, oResourceBundle, oParams, sEntitySetName) {
@@ -929,11 +939,39 @@ sap.ui.define(
 			return oTextAnnotation ? "DescriptionValue" : "Value";
 		}
 
+		function _getEntityType(oContext) {
+			var oMetaModel = oContext.getModel().getMetaModel();
+			return oMetaModel.getObject(oMetaModel.getMetaPath(oContext.getPath()) + "/$Type");
+		}
+
+		function _requestObject(sAction, oSelectedContext, sProperty) {
+			var oContext = oSelectedContext,
+				nBracketIndex = sAction.indexOf("(");
+
+			if (nBracketIndex > -1) {
+				var sTargetType = sAction.slice(nBracketIndex + 1, -1),
+					sCurrentType = _getEntityType(oContext);
+
+				while (sCurrentType !== sTargetType) {
+					// Find parent binding context and retrieve entity type
+					oContext = oContext.getBinding().getContext();
+					if (oContext) {
+						sCurrentType = _getEntityType(oContext);
+					} else {
+						Log.warn("Cannot determine target type to request property value for bound action invocation");
+						return Promise.resolve(undefined);
+					}
+				}
+			}
+
+			return oContext.requestObject(sProperty);
+		}
+
 		function _requestProperty(oSelectedContext, sAction, sProperty, sDynamicActionEnabledPath) {
 			var oPromise =
 				sProperty && sProperty.indexOf("/") === 0
 					? requestSingletonProperty(sProperty, oSelectedContext.getModel())
-					: oSelectedContext.requestObject(sProperty);
+					: _requestObject(sAction, oSelectedContext, sProperty);
 
 			return oPromise.then(function(vPropertyValue) {
 				return Promise.resolve({
@@ -1410,13 +1448,14 @@ sap.ui.define(
 		 * @param {object} oSelectionVariant Instance of {@link sap.fe.navigation.SelectionVariant} SelectionVariant to be used.
 		 * @param {object} mFilters Conditons to be added to the SelectionVariant
 		 * @param {object} oTargetInfo Object returned after selection variant from the table is prepared.
+		 * @param {object} oFilterInfo Object containing the converted FilterBar filters
 		 * @returns {object} Instance of {@link sap.fe.navigation.SelectionVariant} SelectionVariant with the conditions.
 		 * @private
 		 * @ui5-restricted
 		 * @example <code>
 		 * </code>
 		 */
-		function addExternalStateFiltersToSelectionVariant(oSelectionVariant, mFilters, oTargetInfo) {
+		function addExternalStateFiltersToSelectionVariant(oSelectionVariant, mFilters, oTargetInfo, oFilterInfo) {
 			var sFilter,
 				sLow = "",
 				sHigh = null;
@@ -1447,6 +1486,10 @@ sap.ui.define(
 					case "EQ":
 						oSelectOptionState.option = sOperator;
 						break;
+					case "TODAY":
+					case "DATE":
+						oSelectOptionState.option = "EQ";
+						break;
 					case "EEQ":
 						oSelectOptionState.option = "EQ";
 						break;
@@ -1506,6 +1549,13 @@ sap.ui.define(
 					var oFilter = aFilters[item];
 					sLow = (oFilter.values[0] && oFilter.values[0].toString()) || "";
 					sHigh = (oFilter.values[1] && oFilter.values[1].toString()) || null;
+					if (oFilter.operator === "TODAY" || oFilter.operator === "DATE") {
+						var aFilter = oFilterInfo[0].aFilters.filter(function(oFilter) {
+							return oFilter.sPath === sFilter;
+						});
+						sLow = aFilter[0].oValue1 || "";
+						sHigh = null;
+					}
 					var oSelectOptionValues = fnGetSignAndOption(oFilter.operator, sLow, sHigh);
 					if (oSelectOptionValues.option) {
 						oSelectionVariant.addSelectOption(
@@ -2172,6 +2222,52 @@ sap.ui.define(
 			return Promise.resolve(null);
 		}
 
+		/**
+		 * Add binding event listener.
+		 *
+		 * @param {object} oControl Control instance
+		 * @param {object} sEventName Event name
+		 * @param {object} fHandler Handler to be called
+		 * @private
+		 * @ui5-restricted
+		 */
+		function addEventToBindingInfo(oControl, sEventName, fHandler) {
+			var oBindingInfo;
+			var setBindingInfo = function() {
+				if (oBindingInfo) {
+					if (!oBindingInfo.events) {
+						oBindingInfo.events = {};
+					}
+					if (!oBindingInfo.events[sEventName]) {
+						oBindingInfo.events[sEventName] = fHandler;
+					} else {
+						var fOriginalHandler = oBindingInfo.events[sEventName];
+						oBindingInfo.events[sEventName] = function() {
+							fHandler.apply(this, arguments);
+							fOriginalHandler.apply(this, arguments);
+						};
+					}
+				}
+			};
+			if (oControl.isA("sap.ui.mdc.ChartNew")) {
+				oControl
+					.innerChartBound()
+					.then(function() {
+						oBindingInfo = oControl
+							.getControlDelegate()
+							._getChart(oControl)
+							.getBindingInfo("data");
+						setBindingInfo();
+					})
+					.catch(function(sError) {
+						Log.error(sError);
+					});
+			} else {
+				oBindingInfo = oControl.data("rowsBindingInfo");
+				setBindingInfo();
+			}
+		}
+
 		function loadMacroLibrary() {
 			return new Promise(function(resolve, reject) {
 				sap.ui.require(["sap/fe/macros/macroLibrary"], function(/*macroLibrary*/) {
@@ -2180,6 +2276,263 @@ sap.ui.define(
 			});
 		}
 
+		/**
+		 * Check if given path resides in the context path provided.
+		 *
+		 * @function
+		 * @name sap.fe.core.CommonUtils.isPathApplicableToContextPath
+		 * @memberof sap.fe.core.CommonUtils
+		 * @param {object} [oMetaModel] MetaModel to be used
+		 * @param {string} [sContextPath] Context path to be used
+		 * @param {string} [sPath] Path to be used
+		 * @param {string} [sStrategy] Strategy, it could be 'self' | 'includingDependents'
+		 * @returns {boolean} If path is applicable to context.
+		 **/
+		function isPathApplicableToContextPath(oMetaModel, sContextPath, sPath, sStrategy) {
+			var sContextPathToCheck = sContextPath.startsWith("/") ? sContextPath : "/" + sContextPath,
+				sPathToCheck = sPath.startsWith("/") ? sPath : "/" + sPath,
+				fnIsApplicable = function(sPrimaryPath, sKey) {
+					return sPrimaryPath === sKey || (sStrategy === "includingDependents" && sPrimaryPath.startsWith(sKey));
+				},
+				fnSimplifyEntitySetPath = function(sEntitySetPathToUse) {
+					var sEntitySetPath = ModelHelper.getEntitySetPath(sEntitySetPathToUse);
+					var sEntitySet = sEntitySetPath.indexOf("$NavigationPropertyBinding") > -1 && oMetaModel.getObject(sEntitySetPath);
+					return sEntitySet ? "/" + sEntitySet : sEntitySetPathToUse;
+				};
+
+			if (!fnIsApplicable(sContextPathToCheck, sPathToCheck)) {
+				sContextPathToCheck = fnSimplifyEntitySetPath(sContextPathToCheck);
+
+				if (!fnIsApplicable(sContextPathToCheck, sPathToCheck)) {
+					sPathToCheck = fnSimplifyEntitySetPath(sPathToCheck);
+				} else {
+					return true;
+				}
+			}
+
+			return fnIsApplicable(sContextPathToCheck, sPathToCheck);
+		}
+
+		/**
+		 * Get controls to refresh in a view.
+		 *
+		 * @function
+		 * @name sap.fe.core.CommonUtils.getControlsForRefresh
+		 * @memberof sap.fe.core.CommonUtils
+		 * @param {object} [oView] View of the controls
+		 * @param {Array} [aViewControls] Controls to be checked
+		 * @returns {Array} Controls that need to be refreshed
+		 **/
+		function getControlsForRefresh(oView, aViewControls) {
+			var aControls = [],
+				oMetaModel = oView.getModel().getMetaModel(),
+				oInternalModel = oView.getModel("internal"),
+				oRefreshStrategyForKeepAliveRestore = oInternalModel.getProperty("/refreshStrategyOnAppRestore") || {};
+
+			if (aViewControls) {
+				aViewControls.forEach(function(oControl) {
+					var sContextPath = oControl.data("targetCollectionPath");
+
+					for (var sKey in oRefreshStrategyForKeepAliveRestore) {
+						var sStrategy = oRefreshStrategyForKeepAliveRestore[sKey];
+						if (CommonUtils.isPathApplicableToContextPath(oMetaModel, sContextPath, sKey, sStrategy)) {
+							aControls.push(oControl);
+						}
+					}
+				});
+			}
+
+			return aControls;
+		}
+
+		/**
+		 * Get refresh strategy for the control for a context path.
+		 *
+		 * @function
+		 * @name sap.fe.core.CommonUtils.getControlRefreshStrategyForContextPath
+		 * @memberof sap.fe.core.CommonUtils
+		 * @param {object} [oControl] Control from which refresh info is needed
+		 * @param {string} sContextPath ContextPath for properities
+		 * @returns {string} Strategy for control refresh
+		 **/
+
+		function getControlRefreshStrategyForContextPath(oControl, sContextPath) {
+			var oMetaModel = oControl.getModel().getMetaModel(),
+				oInternalModel = oControl.getModel("internal"),
+				oRefreshStrategyForKeepAliveRestore = oInternalModel.getProperty("/refreshStrategyOnAppRestore"),
+				sStrategy;
+
+			if (sContextPath) {
+				for (var sKey in oRefreshStrategyForKeepAliveRestore) {
+					var sStrategyToCheck = oRefreshStrategyForKeepAliveRestore[sKey];
+					if (CommonUtils.isPathApplicableToContextPath(oMetaModel, sContextPath, sKey, sStrategyToCheck)) {
+						sStrategy = sStrategyToCheck;
+						if (sStrategy === "includingDependents") {
+							break;
+						}
+					}
+				}
+			}
+
+			return sStrategy;
+		}
+
+		/**
+		 * Get refresh info from view.
+		 *
+		 * @function
+		 * @name sap.fe.core.CommonUtils.getViewRefreshInfo
+		 * @memberof sap.fe.core.CommonUtils
+		 * @param {object} [oView] View from which refresh info is needed
+		 * @returns {string} Strategy for view refresh
+		 **/
+		function getViewRefreshInfo(oView) {
+			var mViewData = oView.getViewData(),
+				sContextPath = mViewData && (mViewData.contextPath || "/" + mViewData.entitySet);
+
+			return CommonUtils.getControlRefreshStrategyForContextPath(oView, sContextPath);
+		}
+
+		/**
+		 * Get MetaPath for the context.
+		 *
+		 * @function
+		 * @name sap.fe.core.CommonUtils.getMetaPathForContext
+		 * @memberof sap.fe.core.CommonUtils
+		 * @param {object} [oContext] Outbound defined in app descriptor
+		 * @returns {string} Meta path for the context
+		 **/
+		function getMetaPathForContext(oContext) {
+			var oModel = oContext && oContext.getModel && oContext.getModel(),
+				oMetaModel = oModel && oModel.getMetaModel && oModel.getMetaModel(),
+				sPath = oContext && oContext.getPath && oContext.getPath();
+
+			return oMetaModel && sPath && oMetaModel.getMetaPath && oMetaModel.getMetaPath(sPath);
+		}
+
+		/**
+		 * Get MetaPath for the listbinding.
+		 *
+		 * @function
+		 * @name sap.fe.core.CommonUtils.getAbsoluteMetaPathForListBinding
+		 * @memberof sap.fe.core.CommonUtils
+		 * @param {object} [oView] The View
+		 * @param {sap.ui.model.odata.v4.ODataListBinding|string} vListBinding  ODataListBinding object or the binding path for a temporary list binding
+		 * @returns {string} Meta path for the listbinding
+		 **/
+		function getAbsoluteMetaPathForListBinding(oView, vListBinding) {
+			var oMetaModel = oView.getModel().getMetaModel(),
+				sMetaPath;
+			if (vListBinding && typeof vListBinding === "object") {
+				// we already get a list binding use this one
+				var oBinding = vListBinding;
+				var oRootBinding = oBinding.getRootBinding();
+				if (oBinding === oRootBinding) {
+					// absolute path
+					sMetaPath = oMetaModel.getMetaPath(oBinding.getPath());
+				} else {
+					// relative path
+					var sRootBindingPath = oRootBinding.getPath();
+					var sRelativePath = oBinding.getPath();
+					sMetaPath = oMetaModel.getMetaPath(sRootBindingPath + "/" + sRelativePath);
+				}
+			} else if (typeof vListBinding === "string") {
+				if (vListBinding.startsWith("/")) {
+					// absolute path
+					sMetaPath = oMetaModel.getMetaPath(vListBinding);
+				} else {
+					// relative path
+					var oBindingContext = oView.getBindingContext();
+					var sRootContextPath = oBindingContext.getPath();
+					sMetaPath = oMetaModel.getMetaPath(sRootContextPath + "/" + vListBinding);
+				}
+			}
+			return sMetaPath;
+		}
+
+		/**
+		 * Get refresh strategy for an intent.
+		 *
+		 * @function
+		 * @name sap.fe.core.CommonUtils.getRefreshStrategyForIntent
+		 * @memberof sap.fe.core.CommonUtils
+		 * @param {object} mRefreshStrategies RefreshStrategies to consider
+		 * @param {string} sSemanticObject Outbound Semantic Object
+		 * @param {string} sAction Outbound Action
+		 * @returns {object} Meta path for the context
+		 **/
+		function getRefreshStrategyForIntent(mRefreshStrategies, sSemanticObject, sAction) {
+			return (
+				(mRefreshStrategies.intents &&
+					((sSemanticObject && sAction && mRefreshStrategies.intents[sSemanticObject + "-" + sAction]) ||
+						(sSemanticObject && mRefreshStrategies.intents[sSemanticObject]))) ||
+				mRefreshStrategies["defaultBehavior"] ||
+				mRefreshStrategies["_feDefault"]
+			);
+		}
+
+		/**
+		 * Store control refresh strategy for hash in the internal model.
+		 *
+		 * @function
+		 * @name sap.fe.core.CommonUtils.storeControlRefreshStrategyForHash
+		 * @memberof sap.fe.core.CommonUtils
+		 * @param {object} oControl Control for the refresh strategy
+		 * @param {object} oHash Shell hash object
+		 **/
+		function storeControlRefreshStrategyForHash(oControl, oHash) {
+			if (oControl && oControl.getModel("viewData") && oControl.getModel("internal")) {
+				var mViewData = oControl.getModel("viewData");
+				var oRefreshStrategies = mViewData.getObject("/refreshStrategyOnAppRestore");
+				if (oRefreshStrategies) {
+					var mInternalModel = oControl.getModel("internal");
+					var oRefreshStrategy = CommonUtils.getRefreshStrategyForIntent(
+						oRefreshStrategies,
+						oHash && oHash.semanticObject,
+						oHash && oHash.action
+					);
+
+					mInternalModel.setProperty("/refreshStrategyOnAppRestore", oRefreshStrategy);
+				}
+			}
+		}
+		/**
+		 * Method to refresh and restore the view if neccessary.
+		 *
+		 * @function
+		 * @name sap.fe.core.CommonUtils.restoreView
+		 * @memberof sap.fe.core.CommonUtils
+		 * @param {object} oView Control for the refresh strategy
+		 * @returns {Promise} A promise after view refresh and restore are triggered
+		 **/
+		function restoreView(oView) {
+			var oInternalModelContext = oView.getBindingContext("internal");
+			var oController = oView.getController();
+			var oViewState = oController.viewState;
+			var pRefreshBindings = Promise.resolve();
+			if (oInternalModelContext.getProperty("restoreStatus") === "pending") {
+				if (oViewState.refreshViewBindings) {
+					pRefreshBindings = oViewState.refreshViewBindings();
+					pRefreshBindings
+						.then(function() {
+							Log.info("FE V4: Refresh was triggered successfull: " + oView.getId());
+						})
+						.catch(function(err) {
+							Log.warning("FE V4: Refresh was unsuccessfull: " + oView.getId(), err);
+						});
+				}
+				pRefreshBindings
+					.then(function() {
+						oViewState.onRestore();
+						oInternalModelContext.setProperty("restoreStatus", "done");
+					})
+					.catch(function(err) {
+						Log.warning("FE V4: Restore was unsuccessfull: " + oView.getId());
+					});
+			}
+			return pRefreshBindings;
+		}
+
 		var CommonUtils = {
 			isPropertyFilterable: isPropertyFilterable,
 			isFieldControlPathInapplicable: isFieldControlPathInapplicable,
@@ -2224,6 +2577,7 @@ sap.ui.define(
 			getSpecificAllowedExpression: getSpecificAllowedExpression,
 			requestSingletonProperty: requestSingletonProperty,
 			templateControlFragment: templateControlFragment,
+			addEventToBindingInfo: addEventToBindingInfo,
 			FilterRestrictions: {
 				REQUIRED_PROPERTIES: "RequiredProperties",
 				NON_FILTERABLE_PROPERTIES: "NonFilterableProperties",
@@ -2237,7 +2591,16 @@ sap.ui.define(
 				"SearchExpression",
 				"MultiRangeOrSearchExpression"
 			],
-			fnProcessDataLossOrDraftDiscardConfirmation: fnProcessDataLossOrDraftDiscardConfirmation
+			fnProcessDataLossOrDraftDiscardConfirmation: fnProcessDataLossOrDraftDiscardConfirmation,
+			isPathApplicableToContextPath: isPathApplicableToContextPath,
+			getControlsForRefresh: getControlsForRefresh,
+			getViewRefreshInfo: getViewRefreshInfo,
+			getMetaPathForContext: getMetaPathForContext,
+			getAbsoluteMetaPathForListBinding: getAbsoluteMetaPathForListBinding,
+			getControlRefreshStrategyForContextPath: getControlRefreshStrategyForContextPath,
+			getRefreshStrategyForIntent: getRefreshStrategyForIntent,
+			storeControlRefreshStrategyForHash: storeControlRefreshStrategyForHash,
+			restoreView: restoreView
 		};
 
 		return CommonUtils;

package/src/sap/fe/core/ExtensionAPI.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/base/Object", "sap/fe/core/CommonUtils", "sap/base/Log", "sap/ui/core/Component", "sap/ui/model/json/JSONModel"],

package/src/sap/fe/core/PageController.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(
 	[
@@ -16,7 +16,8 @@ sap.ui.define(
 		"sap/fe/core/controllerextensions/InternalIntentBasedNavigation",
 		"sap/fe/core/controllerextensions/Share",
 		"sap/fe/core/controllerextensions/ViewState",
-		"sap/fe/core/controllerextensions/Paginator"
+		"sap/fe/core/controllerextensions/Paginator",
+		"sap/fe/core/controllerextensions/Placeholder"
 	],
 	function(
 		Controller,
@@ -31,7 +32,8 @@ sap.ui.define(
 		InternalIntentBasedNavigation,
 		Share,
 		ViewState,
-		Paginator
+		Paginator,
+		Placeholder
 	) {
 		"use strict";
 
@@ -57,6 +59,7 @@ sap.ui.define(
 			share: Share,
 			paginator: Paginator,
 			viewState: ViewState,
+			placeholder: Placeholder,
 			/**
 			 * @private
 			 * @name sap.fe.core.PageController.getMetadata
@@ -101,6 +104,11 @@ sap.ui.define(
 				this.getView().setModel(oInternalModel, "internal");
 			},
 
+			onBeforeRendering: function() {
+				if (this.placeholder.attachHideCallback) {
+					this.placeholder.attachHideCallback();
+				}
+			},
 			getExtensionAPI: function() {
 				if (!this.extensionAPI) {
 					this.extensionAPI = new ExtensionAPI(this);