@sapui5/sap.fe.core 1.131.0 → 1.133.0

package/src/sap/fe/core/converters/templates/ObjectPageConverter.ts

@@ -3,7 +3,14 @@ import type { FacetTypes } from "@sap-ux/vocabularies-types/vocabularies/UI";
 import type { BindingToolkitExpression, CompiledBindingToolkitExpression } from "sap/fe/base/BindingToolkit";
 import { compileExpression, constant, equal, getExpressionFromAnnotation, ifElse, not } from "sap/fe/base/BindingToolkit";
 import type { BaseAction, CombinedAction, CustomAction, OverrideTypeAction } from "sap/fe/core/converters/controls/Common/Action";
-import { getActionsFromManifest, removeDuplicateActions } from "sap/fe/core/converters/controls/Common/Action";
+import {
+	getActionsFromManifest,
+	getAnnotationMenuActionItems,
+	getMatchingManifestAction,
+	getVisibilityEnablementMenuActions,
+	prepareMenuActions,
+	removeDuplicateActions
+} from "sap/fe/core/converters/controls/Common/Action";
 import type { TableVisualization } from "sap/fe/core/converters/controls/Common/Table";
 import {
 	getFooterDefaultActions,
@@ -11,6 +18,7 @@ import {
 	getHiddenHeaderActions
 } from "sap/fe/core/converters/objectPage/HeaderAndFooterAction";
 import { UI, singletonPathVisitor } from "../../helpers/BindingHelper";
+import type { EnvironmentCapabilities } from "../../services/EnvironmentServiceFactory";
 import type ConverterContext from "../ConverterContext";
 import type { ManifestSection, ManifestSubSection, TransportSelectionDefinition } from "../ManifestSettings";
 import { TemplateType, VisualizationType } from "../ManifestSettings";
@@ -215,7 +223,9 @@ function getSectionFromManifest(
 			[sectionKey]: {
 				...customSectionDefinition,
 				position: undefined,
-				visible: "true"
+				visible: "true",
+				applyState: undefined,
+				retrieveState: undefined
 			}
 		};
 	} else {
@@ -231,7 +241,9 @@ function getSectionFromManifest(
 		visible: customSectionDefinition.visible !== undefined ? customSectionDefinition.visible : "true",
 		position: position,
 		subSections: subSections,
-		onSectionLoaded: customSectionDefinition.onSectionLoaded
+		onSectionLoaded: customSectionDefinition.onSectionLoaded,
+		applyState: customSectionDefinition.applyState,
+		retrieveState: customSectionDefinition.retrieveState
 	};
 	return customSection;
 }
@@ -239,30 +251,50 @@ function getSectionFromManifest(
 /**
  * Retrieves the ObjectPage header actions (both the default ones and the custom ones defined in the manifest).
  * @param converterContext The converter context
+ * @param capabilities
  * @returns An array containing all the actions for this ObjectPage header
  */
-export const getHeaderActions = function (converterContext: ConverterContext<PageContextPathTarget>): CombinedAction {
-	const aAnnotationHeaderActions: BaseAction[] = getHeaderDefaultActions(converterContext);
+export const getHeaderActions = function (
+	converterContext: ConverterContext<PageContextPathTarget>,
+	capabilities?: EnvironmentCapabilities
+): CombinedAction {
+	// 1. Get actions from annotations
+	const annotationHeaderActions: BaseAction[] = getHeaderDefaultActions(converterContext, capabilities);
 	const manifestWrapper = converterContext.getManifestWrapper();
-	const manifestActions = getActionsFromManifest(
-		manifestWrapper.getHeaderActions(),
-		converterContext,
-		aAnnotationHeaderActions,
-		undefined,
-		undefined,
-		getHiddenHeaderActions(converterContext)
-	);
 	const actionOverwriteConfig: OverrideTypeAction = {
 		isNavigable: OverrideType.overwrite,
 		enabled: OverrideType.overwrite,
 		visible: OverrideType.overwrite,
 		defaultValuesExtensionFunction: OverrideType.overwrite,
 		command: OverrideType.overwrite,
-		position: OverrideType.overwrite
+		position: OverrideType.overwrite,
+		menu: OverrideType.overwrite
 	};
-	const headerActions = insertCustomElements(aAnnotationHeaderActions, manifestActions.actions, actionOverwriteConfig);
+	// 2. Get actions from manifest
+	const manifestActions = getActionsFromManifest(
+		manifestWrapper.getHeaderActions(),
+		converterContext,
+		annotationHeaderActions,
+		undefined,
+		undefined,
+		getHiddenHeaderActions(converterContext)
+	);
+	// 3. Get all annotation menu items
+	const annotationMenuActionItems = getAnnotationMenuActionItems(annotationHeaderActions);
+	// 4. Find manifest actions which override any annotation menu items
+	const matchingManifestActions = getMatchingManifestAction(annotationMenuActionItems, manifestActions.actions);
+	// 5. Get overridden annotation menu items
+	const overwrittenMenuActionItems = insertCustomElements(annotationMenuActionItems, matchingManifestActions, actionOverwriteConfig);
+	// 6. Override all actions
+	let headerActions = insertCustomElements(annotationHeaderActions, manifestActions.actions, actionOverwriteConfig) as CustomAction[];
+	// 7. Replace original menu items with their corresponding overridden menu items
+	prepareMenuActions(headerActions, overwrittenMenuActionItems);
+	// 8. Remove duplicate actions which are menu items
+	headerActions = removeDuplicateActions(headerActions);
+	// 9. Hide menus where all menu items are hidden
+	headerActions = getVisibilityEnablementMenuActions(headerActions);
 	return {
-		actions: removeDuplicateActions(headerActions),
+		actions: headerActions,
 		commandActions: manifestActions.commandActions
 	};
 };
@@ -270,11 +302,15 @@ export const getHeaderActions = function (converterContext: ConverterContext<Pag
 /**
  * Retrieves the ObjectPage footer actions (both the default ones and the custom ones defined in the manifest).
  * @param converterContext The converter context
+ * @param capabilities The predefined environment capabilities
  * @returns An array containing all the actions for this ObjectPage footer
  */
-export const getFooterActions = function (converterContext: ConverterContext<PageContextPathTarget>): CombinedAction {
+export const getFooterActions = function (
+	converterContext: ConverterContext<PageContextPathTarget>,
+	capabilities?: EnvironmentCapabilities
+): CombinedAction {
 	const manifestWrapper = converterContext.getManifestWrapper();
-	const aAnnotationFooterActions: BaseAction[] = getFooterDefaultActions(manifestWrapper.getViewLevel(), converterContext);
+	const aAnnotationFooterActions: BaseAction[] = getFooterDefaultActions(manifestWrapper.getViewLevel(), converterContext, capabilities);
 	const manifestActions = getActionsFromManifest(manifestWrapper.getFooterActions(), converterContext, aAnnotationFooterActions);
 
 	const actionOverwriteConfig: OverrideTypeAction = {
@@ -519,7 +555,10 @@ export const getExpandedImageVisible = function (
 	return compileExpression(not(getShowHeaderContentExpression(converterContext)));
 };
 
-export const convertPage = function (converterContext: ConverterContext<PageContextPathTarget>): ObjectPageDefinition {
+export const convertPage = function (
+	converterContext: ConverterContext<PageContextPathTarget>,
+	capabilities?: EnvironmentCapabilities
+): ObjectPageDefinition {
 	const manifestWrapper = converterContext.getManifestWrapper();
 	let headerSection: ObjectPageSection | undefined;
 	const entityType: EntityType = converterContext.getEntityType();
@@ -531,10 +570,10 @@ export const convertPage = function (converterContext: ConverterContext<PageCont
 	);
 
 	// Retrieve the page header actions
-	const headerActions = getHeaderActions(converterContext);
+	const headerActions = getHeaderActions(converterContext, capabilities);
 
 	// Retrieve the page footer actions
-	const footerActions = getFooterActions(converterContext);
+	const footerActions = getFooterActions(converterContext, capabilities);
 
 	if (manifestWrapper.isHeaderEditable() && (entityType.annotations.UI?.HeaderFacets || entityType.annotations.UI?.HeaderInfo)) {
 		headerSection = createEditableHeaderSection(converterContext, headerFacets);