@sapui5/sap.fe.templates 1.98.0 → 1.99.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapui5/sap.fe.templates",
-	"version": "1.98.0",
+	"version": "1.99.0",
 	"description": "SAPUI5 Library sap.fe.templates",
 	"license": "SEE LICENSE IN LICENSE.txt",
 	"author": "SAP SE (https://www.sap.com)",
@@ -8,7 +8,8 @@
 	"scripts": {
 		"build": "tsc -v && tsc --project tsconfig-build.json",
 		"prepare-npm-sources": "babel target/npm-sources/src --out-dir target/npm-sources/src --extensions \".ts\" --config-file ../../.babelrc",
-		"test": "jest --runInBand",
+		"prepare-ui5-build-sources": "mkdirp target/ui5-build-tmp/src && babel src --out-dir target/ui5-build-tmp/src --extensions \".ts\" --config-file ../../.babelrc && babel test --out-dir target/ui5-build-tmp/test --extensions \".ts\" --config-file ../../.babelrc",
+		"test": "jest --maxWorkers=4",
 		"test-refs": "jest --runInBand --config jest.config-refs.js",
 		"test-updateSnapshots": "jest --runInBand -u"
 	},
@@ -19,6 +20,7 @@
 	"devDependencies": {
 		"ts-node": "^9.1.1",
 		"@babel/cli": "^7.14.8",
-		"@ui5/cli": "^2.14.0"
+		"@ui5/cli": "^2.14.0",
+		"mkdirp": "^1.0.4"
 	}
 }

package/src/sap/fe/templates/.library

@@ -6,7 +6,7 @@
     <copyright>SAP UI development toolkit for HTML5 (SAPUI5)
         (c) Copyright 2009-2021 SAP SE. All rights reserved
     </copyright>
-    <version>1.98.0</version>
+    <version>1.99.0</version>
 
     <documentation>UI5 library: sap.fe.templates</documentation>
 

package/src/sap/fe/templates/AnalyticalListPage/Component.js

@@ -1,6 +1,7 @@
 /*!
- * SAPUI5
- * (c) Copyright 2009-2022 SAP SE. All rights reserved.
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
  */
 sap.ui.define(
 	["sap/fe/templates/ListComponent"],

package/src/sap/fe/templates/AnalyticalListPage/chart/FEChartDelegate.js

@@ -1,6 +1,7 @@
 /*!
- * SAPUI5
- * (c) Copyright 2009-2022 SAP SE. All rights reserved.
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
  */
 // ---------------------------------------------------------------------------------------
 // Helper class used to help create content in the chart/item and fill relevant metadata

package/src/sap/fe/templates/ListComponent.js

@@ -1,6 +1,7 @@
 /*!
- * SAPUI5
- * (c) Copyright 2009-2022 SAP SE. All rights reserved.
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
  */
 sap.ui.define(
 	["sap/fe/core/TemplateComponent", "sap/fe/core/library"],

package/src/sap/fe/templates/ListReport/Component.js

@@ -1,6 +1,7 @@
 /*!
- * SAPUI5
- * (c) Copyright 2009-2022 SAP SE. All rights reserved.
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
  */
 sap.ui.define(
 	["sap/fe/templates/ListComponent"],
@@ -29,6 +30,14 @@ sap.ui.define(
 					 */
 					keyPerformanceIndicators: {
 						type: "object"
+					},
+
+					/**
+					 * Flag to determine whether the template should hide the filter bar
+					 */
+					hideFilterBar: {
+						type: "boolean",
+						defaultValue: false
 					}
 				},
 				library: "sap.fe.templates",

package/src/sap/fe/templates/ListReport/ExtensionAPI.js

@@ -1,6 +1,7 @@
 /*!
- * SAPUI5
- * (c) Copyright 2009-2022 SAP SE. All rights reserved.
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
  */
 sap.ui.define(["sap/fe/core/ExtensionAPI", "sap/fe/macros/filter/FilterUtils", "sap/fe/macros/chart/ChartUtils"], function(
 	ExtensionAPI,
@@ -44,9 +45,14 @@ sap.ui.define(["sap/fe/core/ExtensionAPI", "sap/fe/macros/filter/FilterUtils", "
 		 */
 		refresh: function() {
 			var oFilterBar = this._controller._getFilterBarControl();
-			return oFilterBar.waitForInitialization().then(function() {
-				oFilterBar.triggerSearch();
-			});
+			if (oFilterBar) {
+				return oFilterBar.waitForInitialization().then(function() {
+					oFilterBar.triggerSearch();
+				});
+			} else {
+				// TODO: if there is no filter bar, make refresh work
+				return Promise.resolve();
+			}
 		},
 
 		/**

package/src/sap/fe/templates/ListReport/ListReport.view.xml

@@ -60,7 +60,7 @@
 														executeOnSelectionForStandardDefault="{= ${viewData>/initialLoad} === 'Enabled'}"
 													/>
 										</template:then>
-										<template:elseif test="{= ${viewData>/variantManagement} === 'Control'}">
+										<template:elseif test="{= ${viewData>/variantManagement} === 'Control' &amp;&amp; !${converterContext>hideFilterBar}}">
 											<v:VariantManagement
 														id="{= ID.generate([ ${converterContext>filterBarId}, 'VariantManagement']) }"
 														unittest:id="listReportVMControlTest"
@@ -97,7 +97,7 @@
 													executeOnSelectionForStandardDefault="{= ${viewData>/initialLoad} === 'Enabled'}"
 												/>
 									</template:then>
-									<template:elseif test="{= ${viewData>/variantManagement} === 'Control'}">
+									<template:elseif test="{= ${viewData>/variantManagement} === 'Control' &amp;&amp; !${converterContext>hideFilterBar}}">
 										<v:VariantManagement
 													id="{= ID.generate([ ${converterContext>filterBarId}, 'VariantManagement']) }"
 													unittest:id="listReportVMControlTest"
@@ -135,7 +135,7 @@
 									/>
 								</template:repeat>
 							</template:if>
-							<template:if test="{= ${converterContext>/filterLayout} === 'compactvisual'}">
+							<template:if test="{= ${converterContext>/filterLayout} === 'compactvisual' &amp;&amp; !${converterContext>hideFilterBar}}">
 								<SegmentedButton
 									id="{= ID.generate([ ${converterContext>filterBarId}, 'LayoutToggle']) }"
 									selectedKey="{converterContext>/filterInitialLayout}"
@@ -151,8 +151,10 @@
 					</f:DynamicPageTitle>
 				</f:title>
 				<f:header>
-					<template:with path="converterContext>filterBar" var="filterBarContext">
-						<f:DynamicPageHeader pinnable="{converterContext>showPinnableToggle}">
+					<template:if test="{= !${converterContext>hideFilterBar} }">
+					<template:then>
+						<template:with path="converterContext>filterBar" var="filterBarContext">
+							<f:DynamicPageHeader pinnable="{converterContext>showPinnableToggle}">
 							<VBox>
 								<macroInternal:FilterBar
 									unittest:id="listReportFilterBarTest"
@@ -161,6 +163,7 @@
 									contextPath="{entityType>}"
 									variantBackreference="{= CORE.getVariantBackReference(${viewData>}, ${converterContext>} )}"
 									selectionFields="{filterBarContext>selectionFields}"
+									propertyInfo="{filterBarContext>propertyInfo}"
 									filterChanged=".handlers.onFiltersChanged"
 									filterConditions="{parts:[{path:'converterContext>filterConditions'}, {path:'entitySet>'}], formatter: 'FILTER.getFilterConditions'}"
 									search=".handlers.onSearch"
@@ -176,7 +179,9 @@
 								/>
 							</VBox>
 						</f:DynamicPageHeader>
-					</template:with>
+						</template:with>
+					</template:then>
+					</template:if>
 				</f:header>
 				<f:content>
 					<template:if test="{= ${converterContext>views}.length > 0}">

package/src/sap/fe/templates/ListReport/ListReportController.controller.js

@@ -1,6 +1,7 @@
 /*!
- * SAPUI5
- * (c) Copyright 2009-2022 SAP SE. All rights reserved.
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
  */
 
 sap.ui.define(
@@ -36,8 +37,7 @@ sap.ui.define(
 		"sap/fe/templates/TableScroller",
 		"sap/fe/core/controllerextensions/Placeholder",
 		"sap/ui/fl/write/api/ControlPersonalizationWriteAPI",
-		"sap/fe/core/controllerextensions/MassEdit",
-		"./overrides/MassEdit"
+		"sap/fe/core/controllerextensions/MassEdit"
 	],
 	function(
 		PageController,
@@ -71,8 +71,7 @@ sap.ui.define(
 		TableScroller,
 		Placeholder,
 		ControlPersonalizationWriteAPI,
-		MassEdit,
-		MassEditOverrides
+		MassEdit
 	) {
 		"use strict";
 		var TemplateContentView = CoreLibrary.TemplateContentView,
@@ -122,7 +121,7 @@ sap.ui.define(
 			viewState: ViewState.override(ViewStateOverrides),
 			kpiManagement: KPIManagement,
 			placeholder: Placeholder,
-			massEdit: MassEdit.override(MassEditOverrides),
+			massEdit: MassEdit,
 
 			getExtensionAPI: function() {
 				if (!this.extensionAPI) {
@@ -443,8 +442,13 @@ sap.ui.define(
 						}
 					});
 					return aControls;
+				} else if (sKey === "Chart") {
+					var oChart = this._getChart();
+					return oChart ? [oChart] : [];
+				} else {
+					var oTable = this._getTable();
+					return oTable ? [oTable] : [];
 				}
-				return sKey === "Chart" ? [this._getChart()] : [this._getTable()];
 			},
 			_getDefaultPath: function() {
 				var defaultPath = this.getView()
@@ -529,7 +533,7 @@ sap.ui.define(
 			 * requests when FilterBar is changed or LR is initialized
 			 * Best workflow would be to suspend table binding but
 			 * if the user switch quickly between tabs the batch response of previous
-			 * is recevied when previous tab is already disabled (binding is suspended) and
+			 * is received when previous tab is already disabled (binding is suspended) and
 			 * generates error.
 			 * A temporary solution (if we find better workflow) is to set a customData and don't trigger
 			 * rebindTable if this customData is set to true.
@@ -551,7 +555,7 @@ sap.ui.define(
 			 * @param {sap.ui.model.context} oInternalModelContext The internal model context
 			 * @param {sap.ui.mdc.FilterBar} oFilterBar MDC filter bar
 			 */
-			_updateMultiNotApplicableFields: function(oInternalModelContext, oFilterBar) {
+			_updateMultiTabNotApplicableFields: function(oInternalModelContext, oFilterBar) {
 				var mCache = {};
 				var ignoredFields = {},
 					aTables = this._getControls("table"),
@@ -584,6 +588,35 @@ sap.ui.define(
 				});
 				oInternalModelContext.setProperty("tabs/ignoredFields", ignoredFields);
 			},
+			/**
+			 * Method to update the local UI model of the page with the fields that are not applicable to the filter bar (this is specific to the ALP scenario).
+			 *
+			 * @param {sap.ui.model.context} oInternalModelContext The internal model context
+			 * @param {sap.ui.mdc.FilterBar} oFilterBar MDC filter bar
+			 */
+			_updateALPNotApplicableFields: function(oInternalModelContext, oFilterBar) {
+				var mCache = {};
+				var ignoredFields = {},
+					aTables = this._getControls("table"),
+					aCharts = this._getControls("Chart");
+
+				if (!aTables.length || !aCharts.length) {
+					// If there's not a table and a chart, we're not in the ALP case
+					return;
+				}
+
+				// For the moment, there's nothing for tables...
+				aCharts.forEach(function(oChart) {
+					var sChartEntityPath = oChart.data("targetCollectionPath"),
+						sChartEntitySet = sChartEntityPath.slice(1),
+						sCacheKey = sChartEntitySet + "Chart";
+					if (!mCache[sCacheKey]) {
+						mCache[sCacheKey] = FilterUtils.getNotApplicableFilters(oFilterBar, oChart);
+					}
+					ignoredFields[sCacheKey] = mCache[sCacheKey];
+				});
+				oInternalModelContext.setProperty("controls/ignoredFields", ignoredFields);
+			},
 			_updateMultiModeSelectedControl: function() {
 				this._sEntitySet = undefined;
 				this._oListReportControl = undefined;
@@ -660,17 +693,22 @@ sap.ui.define(
 						});
 				}
 			},
+			_isFilterBarHidden: function() {
+				return this.getView().getViewData().hideFilterBar;
+			},
 			_shouldAutoTriggerSearch: function(oVM) {
 				if (
 					this.getView().getViewData().initialLoad === InitialLoadMode.Auto &&
 					(!oVM || oVM.getStandardVariantKey() === oVM.getCurrentVariantKey())
 				) {
-					var oFilterBar = this._getFilterBarControl(),
-						oConditions = oFilterBar.getConditions();
-					for (var sKey in oConditions) {
-						// ignore filters starting with $ (e.g. $search, $editState)
-						if (!sKey.startsWith("$") && Array.isArray(oConditions[sKey]) && oConditions[sKey].length) {
-							return true;
+					var oFilterBar = this._getFilterBarControl();
+					if (oFilterBar) {
+						var oConditions = oFilterBar.getConditions();
+						for (var sKey in oConditions) {
+							// ignore filters starting with $ (e.g. $search, $editState)
+							if (!sKey.startsWith("$") && Array.isArray(oConditions[sKey]) && oConditions[sKey].length) {
+								return true;
+							}
 						}
 					}
 				}
@@ -703,9 +741,9 @@ sap.ui.define(
 					var sPreviousSelectedKey = oEvent && oEvent.mParameters ? oEvent.mParameters.previousKey : undefined;
 
 					oInternalModelContext.setProperty("tabs/selected", sSelectedKey);
-					if (oFilterBar && oInternalModelContext.getProperty("hasPendingFilters") !== true) {
+					if (oInternalModelContext.getProperty("hasPendingFilters") !== true) {
 						// No pending filters into FilterBar
-						if (this._isCustomTab()) {
+						if (oFilterBar && this._isCustomTab()) {
 							var oFilterConditions = oFilterBar.getFilterConditions();
 							this.onViewNeedsRefresh({
 								filterConditions: oFilterConditions,
@@ -734,7 +772,7 @@ sap.ui.define(
 						}
 					}
 
-					if (oEvent && oEvent.mParameters && sPreviousSelectedKey != oEvent.mParameters.selectedKey) {
+					if (oEvent && oEvent.mParameters && sPreviousSelectedKey !== oEvent.mParameters.selectedKey) {
 						ControlPersonalizationWriteAPI.add({
 							changes: [
 								{
@@ -753,13 +791,15 @@ sap.ui.define(
 					this.getExtensionAPI().updateAppState();
 				},
 				onFiltersChanged: function(oEvent) {
-					var oFilterBar = this._getFilterBarControl(),
-						oInternalModelContext = this.getView().getBindingContext("internal");
-					// Pending filters into FilterBar to be used for custom views
-					this.onPendingFilters();
-					oInternalModelContext.setProperty("appliedFilters", oFilterBar.getAssignedFiltersText().filtersText);
-					if (oEvent.getParameter("conditionsBased")) {
-						oInternalModelContext.setProperty("hasPendingFilters", true);
+					var oFilterBar = this._getFilterBarControl();
+					if (oFilterBar) {
+						var oInternalModelContext = this.getView().getBindingContext("internal");
+						// Pending filters into FilterBar to be used for custom views
+						this.onPendingFilters();
+						oInternalModelContext.setProperty("appliedFilters", oFilterBar.getAssignedFiltersText().filtersText);
+						if (oEvent.getParameter("conditionsBased")) {
+							oInternalModelContext.setProperty("hasPendingFilters", true);
+						}
 					}
 				},
 				onVariantSelected: function(oEvent) {
@@ -799,7 +839,10 @@ sap.ui.define(
 						this._setCountsOutDated();
 						if (!this._isCustomTab()) {
 							var sDisplayedControlId = this._getCurrentControl().getId();
-							this._updateMultiNotApplicableFields(oInternalModelContext, oFilterBar);
+							this._updateMultiTabNotApplicableFields(oInternalModelContext, oFilterBar);
+							// This should be done outside the search event handler of the filter bar.
+							// The same logic is required when filter bar is hidden and multiple tables exist on the LR.
+							// This is currently done in ListReport/overrides/ViewState.js#onAfterStateApplied()
 							aControls.forEach(function(oControl) {
 								oControl.data("outdatedRows", oControl.getId() !== sDisplayedControlId);
 							});
@@ -811,6 +854,8 @@ sap.ui.define(
 								refreshCause: "search"
 							});
 						}
+					} else {
+						this._updateALPNotApplicableFields(oInternalModelContext, oFilterBar);
 					}
 					if (oMdcChart) {
 						// disable bound actions TODO: this clears everything for the chart?
@@ -838,6 +883,11 @@ sap.ui.define(
 					if (this.getView().getViewData().liveMode === false) {
 						this.getExtensionAPI().updateAppState();
 					}
+
+					if (Device.system.phone) {
+						var oDynamicPage = this.getView().byId("fe::ListReport");
+						oDynamicPage.setHeaderExpanded(false);
+					}
 				},
 				/**
 				 * Triggers an outbound navigation when a user chooses the chevron.
@@ -968,10 +1018,10 @@ sap.ui.define(
 				 * @returns {string} Message text
 				 */
 				setTabMessageStrip: function(aIgnoredFields, sTabTitle) {
-					var sText = "";
-					if (Array.isArray(aIgnoredFields) && aIgnoredFields.length > 0 && sTabTitle) {
-						var oFilterBar = this._getFilterBarControl(),
-							sFilterBarEntityPath = oFilterBar.data("entityType"),
+					var sText = "",
+						oFilterBar = this._getFilterBarControl();
+					if (oFilterBar && Array.isArray(aIgnoredFields) && aIgnoredFields.length > 0 && sTabTitle) {
+						var sFilterBarEntityPath = oFilterBar.data("entityType"),
 							oMetaModel = this.getView()
 								.getModel()
 								.getMetaModel(),
@@ -997,6 +1047,42 @@ sap.ui.define(
 						}
 					}
 					return sText;
+				},
+				/**
+				 * Formatter for the message text for the chart when fields in the FilterBar need to be ignored.
+				 *
+				 * @param {Array} aIgnoredFields Array of ignored fields in the FilterBar for the current tab (multiple entity sets)
+				 * @returns {string} Message text
+				 */
+				setChartMessageStrip: function(aIgnoredFields) {
+					var sText = "";
+					if (Array.isArray(aIgnoredFields) && aIgnoredFields.length > 0) {
+						var oFilterBar = this._getFilterBarControl(),
+							sFilterBarEntityPath = oFilterBar.data("entityType"),
+							oMetaModel = this.getView()
+								.getModel()
+								.getMetaModel(),
+							oResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.fe.templates"),
+							aIgnoredLabels = aIgnoredFields.map(function(sProperty) {
+								if (sProperty === "$search") {
+									var oMacroResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.fe.macros");
+									return oMacroResourceBundle ? oMacroResourceBundle.getText("M_FILTERBAR_SEARCH") : "";
+								}
+								var sLabel = oMetaModel.getObject(
+									sFilterBarEntityPath + sProperty + "@com.sap.vocabularies.Common.v1.Label"
+								);
+								return DelegateUtil.getLocalizedText(sLabel, oFilterBar);
+							});
+						if (oResourceBundle) {
+							var sResource =
+								"C_LR_MULTIVIZ_CHART_" +
+								(aIgnoredLabels.length === 1 ? "SINGLE" : "MULTI") +
+								"_IGNORED_FILTER_" +
+								(Device.system.desktop ? "LARGE" : "SMALL");
+							sText = oResourceBundle.getText(sResource, [aIgnoredLabels.join(", ")]);
+						}
+					}
+					return sText;
 				}
 			}
 		});

package/src/sap/fe/templates/ListReport/overrides/IntentBasedNavigation.js

@@ -1,20 +1,22 @@
 /*!
- * SAPUI5
- * (c) Copyright 2009-2022 SAP SE. All rights reserved.
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
  */
 sap.ui.define(["sap/fe/core/CommonUtils", "sap/fe/macros/filter/FilterUtils"], function(CommonUtils, FilterUtils) {
 	"use strict";
 	return {
 		adaptNavigationContext: function(oSelectionVariant, oTargetInfo) {
+			var oView = this.getView(),
+				oController = oView.getController(),
+				oFilterBar = oController._getFilterBarControl();
 			// Adding filter bar values to the navigation does not make sense if no context has been selected.
-			// Hence only consider filter bar values when SelectionVaraint is not empty
-			if (!oSelectionVariant.isEmpty()) {
-				var oView = this.getView(),
-					oViewData = oView.getViewData(),
-					oController = oView.getController(),
-					sRootPath = oViewData.fullContextPath + oViewData.entitySet;
-				var oFilterBarConditions = Object.assign({}, this.base.getView().getController().filterBarConditions);
-				var aParameters = [];
+			// Hence only consider filter bar values when SelectionVariant is not empty
+			if (oFilterBar && !oSelectionVariant.isEmpty()) {
+				var oViewData = oView.getViewData(),
+					sRootPath = oViewData.fullContextPath + oViewData.entitySet,
+					oFilterBarConditions = Object.assign({}, this.base.getView().getController().filterBarConditions),
+					aParameters = [];
 
 				if (oViewData.contextPath) {
 					var oMetaModel = oView.getModel().getMetaModel(),
@@ -28,12 +30,11 @@ sap.ui.define(["sap/fe/core/CommonUtils", "sap/fe/macros/filter/FilterUtils"], f
 					sRootPath,
 					aParameters
 				);
-				var oFilterBar = oController._getFilterBarControl();
 				var oFilterInfo = FilterUtils.getFilterInfo(oFilterBar, {
 					targetControl: oController._getTable()
 				}).filters;
 				var oInternalModelContext = oView.getBindingContext("internal");
-				var mTabs = oInternalModelContext.getProperty("tabs");
+				var mTabs = oInternalModelContext && oInternalModelContext.getProperty("tabs");
 				// Do we need to exclude Fields (mutli tables mode)?
 				if (mTabs) {
 					var aIgnoredFieldsForTab = mTabs.ignoredFields[mTabs.selected];

package/src/sap/fe/templates/ListReport/overrides/Share.js

@@ -1,6 +1,7 @@
 /*!
- * SAPUI5
- * (c) Copyright 2009-2022 SAP SE. All rights reserved.
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
  */
 sap.ui.define(
 	["sap/fe/core/helpers/SemanticDateOperators", "sap/ui/core/routing/HashChanger", "sap/fe/core/CommonUtils", "sap/base/Log"],
@@ -74,13 +75,14 @@ sap.ui.define(
 					.getContent()[0]
 					.data("filterBarId")
 			);
-			var oConditions = oFilterBar.getFilterConditions();
-			var bsaveAsTileServiceUrlAllowed = SemanticDateOperators.hasSemanticDateOperations(oConditions);
-			if (bsaveAsTileServiceUrlAllowed) {
-				return getCountUrl(oController);
-			} else {
-				return "";
+			if (oFilterBar) {
+				var oConditions = oFilterBar.getFilterConditions();
+				var bSaveAsTileServiceUrlAllowed = SemanticDateOperators.hasSemanticDateOperations(oConditions);
+				if (bSaveAsTileServiceUrlAllowed) {
+					return getCountUrl(oController);
+				}
 			}
+			return "";
 		}
 
 		function getJamUrl() {