@sapui5/sap.fe.core 1.99.0 → 1.101.1

package/src/sap/fe/core/AnnotationHelper.ts

@@ -1,10 +1,12 @@
-import ODataModelAnnotationHelper from "sap/ui/model/odata/v4/AnnotationHelper";
+import { DataField, UIAnnotationTerms, UIAnnotationTypes } from "@sap-ux/vocabularies-types";
 import CommonUtils from "sap/fe/core/CommonUtils";
-import mLibrary from "sap/m/library";
-import { generate } from "sap/fe/core/helpers/StableIdHelper";
+import { ConverterAction } from "sap/fe/core/converters/controls/Common/Action";
+import { ManifestAction } from "sap/fe/core/converters/ManifestSettings";
+import { BindingExpression, compileBinding, Expression, fn, or, ref, resolveBindingString } from "sap/fe/core/helpers/BindingExpression";
 import ModelHelper from "sap/fe/core/helpers/ModelHelper";
-import { compileBinding, fn, ref } from "sap/fe/core/helpers/BindingExpression";
-import { UIAnnotationTerms, UIAnnotationTypes } from "@sap-ux/vocabularies-types";
+import { generate } from "sap/fe/core/helpers/StableIdHelper";
+import mLibrary from "sap/m/library";
+import ODataModelAnnotationHelper from "sap/ui/model/odata/v4/AnnotationHelper";
 const ButtonType = mLibrary.ButtonType;
 const AnnotationHelper = {
 	/* this helper can be activated to debug template processing
@@ -13,91 +15,21 @@ const AnnotationHelper = {
 			 },
 			 */
 
-	getTargetContext: function(oTarget: any) {
+	getTargetContext: function (oTarget: any) {
 		const sTarget = oTarget.getObject(oTarget.getPath()),
 			sNavigationPath = ODataModelAnnotationHelper.getNavigationPath(oTarget.getPath());
 		return sNavigationPath + "/" + sTarget;
 	},
 
-	getNavigationContext: function(oContext: any) {
+	getNavigationContext: function (oContext: any) {
 		return ODataModelAnnotationHelper.getNavigationPath(oContext.getPath());
 	},
-
-	/**
-	 * Checks if the navigation collection is insertable.
-	 *
-	 * @function
-	 * @static
-	 * @name sap.fe.core.AnnotationHelper.getNavigationInsertableRestrictions
-	 * @memberof sap.fe.core.AnnotationHelper
-	 * @param oCollection
-	 * @param {string} sCurrentCollectionName The name of the navigation collection
-	 * @param {Array} aRestrictedProperties Array of RestrictedProperties of NavigationRestrictions of the root collection
-	 * @param {boolean} bInsertable Insertable value of the navigation collection
-	 * @param bCreationRow
-	 * @returns {string} Expression if insertable or insertable path, false otherwise
-	 * @private
-	 * @ui5-restricted
-	 */
-	getNavigationInsertableRestrictions: function(
-		oCollection: any,
-		sCurrentCollectionName: string,
-		aRestrictedProperties: any[],
-		bInsertable: boolean | any,
-		bCreationRow: any
-	) {
-		// If insertable = true via NavigationRestriction of root collection, navigation collection is insertable
-		// If NOT insertable via NavigationRestriction of root collection, navigation collection is NOT insertable
-		// If insertable property is undefined for the NavigationRestrictions of the root collection,
-		// 	then insertable property of the navigation collection is considered.
-		// 	If insertable = true, navigation collection is insertable
-		// 	If insertable = false, navigation collection is NOT insertable
-		// If Insertable is undefined via navigation restriction of root collection
-		// 	and Insertable is undefined at navigation collection,
-		// 	then navigation collection is insertable.
-		let i,
-			oNavigationProperty,
-			sPath = "";
-		for (i in aRestrictedProperties) {
-			oNavigationProperty = aRestrictedProperties[i];
-			if (
-				oNavigationProperty.NavigationProperty.$NavigationPropertyPath === sCurrentCollectionName &&
-				oNavigationProperty.InsertRestrictions
-			) {
-				if (oNavigationProperty.InsertRestrictions.Insertable && oNavigationProperty.InsertRestrictions.Insertable.$Path) {
-					if (bCreationRow) {
-						sPath = oCollection.$Partner + "/";
-					}
-					return (
-						"{= ${" + sPath + oNavigationProperty.InsertRestrictions.Insertable.$Path + "}  && ${ui>/editMode} === 'Editable' }"
-					);
-				}
-				return oNavigationProperty.InsertRestrictions.Insertable ? "{= ${ui>/editMode} === 'Editable' }" : false;
-			}
-		}
-		if (bInsertable && bInsertable.$Path && bInsertable.$Path.indexOf("/") > -1) {
-			const aSplitInsertablePath = bInsertable.$Path.split("/");
-			const sNavigationPath = aSplitInsertablePath[0];
-			const sPartner = oCollection.$Partner;
-			if (sNavigationPath !== sPartner) {
-				// check for parent property
-				return "{= ${ui>/editMode} === 'Editable'}";
-			}
-			if (bCreationRow) {
-				sCurrentCollectionName = "";
-			} else {
-				sCurrentCollectionName = sCurrentCollectionName + "/";
-			}
-			return "{=  ${ui>/editMode} === 'Editable' && ${" + sCurrentCollectionName + bInsertable.$Path + "}}";
-		}
-		return "{= " + (bInsertable !== false) + " && ${ui>/editMode} === 'Editable'}";
-	},
 	/**
 	 * Checks if the footer is visible or not.
 	 *
 	 * @function
 	 * @static
-	 * @name sap.fe.core.AnnotationHelper.showFooter
+	 * @name sap.fe.core.AnnotationHelper.getDataFieldBasedFooterVisibility
 	 * @memberof sap.fe.core.AnnotationHelper
 	 * @param {Array} aDataFields Array of DataFields in the identification
 	 * @param {boolean} bConsiderEditable Whether the edit mode binding is required or not
@@ -105,7 +37,7 @@ const AnnotationHelper = {
 	 * @private
 	 * @ui5-restricted
 	 **/
-	showFooter: function(aDataFields: any[], bConsiderEditable: boolean) {
+	getDataFieldBasedFooterVisibility: function (aDataFields: any[], bConsiderEditable: boolean) {
 		let sHiddenExpression = "";
 		let sSemiHiddenExpression;
 		const aHiddenActionPath = [];
@@ -139,11 +71,11 @@ const AnnotationHelper = {
 				"{= " +
 				(bConsiderEditable ? "(" : "") +
 				sHiddenExpression +
-				(bConsiderEditable ? " || ${ui>/editMode} === 'Editable') " : " ") +
+				(bConsiderEditable ? " || ${ui>/isEditable}) " : " ") +
 				"&& ${internal>isCreateDialogOpen} !== true}"
 			);
 		} else {
-			return "{= " + (bConsiderEditable ? "${ui>/editMode} === 'Editable' && " : "") + "${internal>isCreateDialogOpen} !== true}";
+			return "{= " + (bConsiderEditable ? "${ui>/isEditable} && " : "") + "${internal>isCreateDialogOpen} !== true}";
 		}
 	},
 
@@ -163,7 +95,7 @@ const AnnotationHelper = {
 	 * @private
 	 * @ui5-restricted
 	 **/
-	getActionContext: function(oAction: object) {
+	getActionContext: function (oAction: object) {
 		return CommonUtils.getActionPath(oAction, true);
 	},
 	/**
@@ -181,7 +113,7 @@ const AnnotationHelper = {
 	 * @private
 	 * @ui5-restricted
 	 **/
-	getPathToBoundActionOverload: function(oAction: object) {
+	getPathToBoundActionOverload: function (oAction: object) {
 		const sPath = CommonUtils.getActionPath(oAction, true);
 		return sPath + "/@$ui5.overload/0";
 	},
@@ -198,7 +130,7 @@ const AnnotationHelper = {
 	 * @private
 	 * @ui5-restricted
 	 **/
-	buildEmphasizedButtonExpression: function(aIdentification?: any[]) {
+	buildEmphasizedButtonExpression: function (aIdentification?: any[]) {
 		if (!aIdentification) {
 			return ButtonType.Emphasized;
 		}
@@ -206,7 +138,7 @@ const AnnotationHelper = {
 		let bIsAlwaysDefault: boolean,
 			sHiddenSimplePath,
 			sHiddenExpression = "";
-		aIdentification.forEach(function(oDataField: any) {
+		aIdentification.forEach(function (oDataField: any) {
 			const oCriticalityProperty = oDataField.Criticality;
 			const oDataFieldHidden = oDataField["@com.sap.vocabularies.UI.v1.Hidden"];
 			if (oDataField.$Type === "com.sap.vocabularies.UI.v1.DataFieldForAction" && !bIsAlwaysDefault && oCriticalityProperty) {
@@ -279,7 +211,7 @@ const AnnotationHelper = {
 	 * @param {object} [oInterface] Contains the context, used in oDataContext
 	 * @returns {boolean} `true` if sticky, `false` otherwise
 	 */
-	isStickySessionSupported: function(vCollectionOrMetaModel: object | undefined, oInterface: any | undefined) {
+	isStickySessionSupported: function (vCollectionOrMetaModel: object | undefined, oInterface: any | undefined) {
 		let oMetaModel;
 		if (oInterface) {
 			oMetaModel = oInterface.context.getModel();
@@ -296,7 +228,7 @@ const AnnotationHelper = {
 	 * @param {object} oAction The action object
 	 * @returns {boolean} `true` if action is coming from manifest, `false` otherwise
 	 */
-	isManifestAction: function(oAction: any) {
+	isManifestAction: function (oAction: any) {
 		const aActions = [
 			"Primary",
 			"DefaultApply",
@@ -304,32 +236,36 @@ const AnnotationHelper = {
 			"ForAction",
 			"ForNavigation",
 			"SwitchToActiveObject",
-			"SwitchToDraftObject"
+			"SwitchToDraftObject",
+			"DraftActions"
 		];
 		return aActions.indexOf(oAction.type) < 0;
 	},
 	/**
-	 * Method returns whether footer is visible or not on object / sub object page.
+	 * Method returns whether footer is visible or not on object / subobject page.
 	 *
 	 * @function
 	 * @name getFooterVisible
-	 * @param {Array} oFooterActions The footer action object coming from convertor
-	 * @param {Array} aDataFields Data field array for normal footer visiblity processing
-	 * @returns {boolean} `true` if custom actions are present otherwise call function showFooter
+	 * @param {ConverterAction[]} footerActions The footer action object coming from the converter
+	 * @param {DataField[]} dataFields Data field array for normal footer visibility processing
+	 * @returns {boolean | BindingExpression<string>} `true` if any action is true, otherwise compiled Binding or `false`
 	 */
-	getFooterVisible: function(oFooterActions: any[], aDataFields: any[]) {
-		let bCustomActionFlag = false;
-		oFooterActions.forEach(function(action: any) {
-			const isCustomAction = AnnotationHelper.isManifestAction(action);
-			if (isCustomAction) {
-				bCustomActionFlag = true;
-			}
-		});
-		if (bCustomActionFlag) {
-			return true;
-		} else {
-			return this.showFooter(aDataFields, true);
+	getFooterVisible: function (footerActions: ConverterAction[], dataFields: DataField[]): boolean | BindingExpression<string> {
+		const manifestActions = footerActions.filter((action) => AnnotationHelper.isManifestAction(action)) as ManifestAction[];
+		let customActionVisibility: Expression<boolean>;
+		if (manifestActions.length) {
+			// If we have manifest actions
+			const customActionIndividualVisibility = manifestActions.map((action) => {
+				return resolveBindingString<boolean>(action.visible as string | boolean, "boolean");
+			});
+			// construct the footer's visibility-binding out of all actions' visibility-bindings, first the binding of all custom actions ...
+			customActionVisibility = or(...customActionIndividualVisibility);
+			// and then the binding of all annotation actions inside the footer ...
+			const annotationActionVisibility = this.getDataFieldBasedFooterVisibility(dataFields, true);
+			// finally, return everything.
+			return compileBinding(or(customActionVisibility, resolveBindingString<boolean>(annotationActionVisibility, "boolean")));
 		}
+		return this.getDataFieldBasedFooterVisibility(dataFields, true);
 	},
 	/**
 	 * Build an expression calling an action handler via the FPM helper's actionWrapper function
@@ -343,7 +279,7 @@ const AnnotationHelper = {
 	 * @param {string} oThis.id The table's ID
 	 * @returns {string} The action wrapper binding	expression
 	 */
-	buildActionWrapper: function(oAction: { handlerModule: string; handlerMethod: string }, oThis: { id: string } | undefined) {
+	buildActionWrapper: function (oAction: { handlerModule: string; handlerMethod: string }, oThis: { id: string } | undefined) {
 		const aParams: any[] = [ref("$event"), oAction.handlerModule, oAction.handlerMethod];
 
 		if (oThis && oThis.id) {
@@ -364,7 +300,7 @@ const AnnotationHelper = {
 	 * @param {object} oConverterContext Object containing converted context
 	 * @returns {string}
 	 */
-	getVariantBackReference: function(oViewData: any, oConverterContext: any) {
+	getVariantBackReference: function (oViewData: any, oConverterContext: any) {
 		if (oViewData && oViewData.variantManagement === "Page") {
 			return "fe::PageVariantManagement";
 		}
@@ -373,7 +309,7 @@ const AnnotationHelper = {
 		}
 		return undefined;
 	},
-	getDefaultPath: function(aViews: any) {
+	getDefaultPath: function (aViews: any) {
 		for (let i = 0; i < aViews.length; i++) {
 			if (aViews[i].defaultPath) {
 				return aViews[i].defaultPath;