@sapui5/sap.fe.core 1.101.0 → 1.103.0

package/src/sap/fe/core/converters/ManifestWrapper.ts

@@ -1,10 +1,12 @@
-import { ConfigurableRecord } from "sap/fe/core/converters/helpers/ConfigurableObject";
-import {
+import type { ConfigurableRecord } from "sap/fe/core/converters/helpers/ConfigurableObject";
+import type {
 	BaseManifestSettings,
 	CombinedViewPathConfiguration,
 	ContentDensitiesType,
+	CustomViewTemplateConfiguration,
 	FilterManifestConfiguration,
 	FormManifestConfiguration,
+	KPIConfiguration,
 	ListReportManifestSettings,
 	ManifestAction,
 	ManifestHeaderFacet,
@@ -13,13 +15,11 @@ import {
 	NavigationSettingsConfiguration,
 	ObjectPageManifestSettings,
 	SingleViewPathConfiguration,
-	ViewPathConfiguration,
 	TemplateType,
-	VariantManagementType,
-	CustomViewTemplateConfiguration,
 	ViewConfiguration,
-	KPIConfiguration
+	ViewPathConfiguration
 } from "sap/fe/core/converters/ManifestSettings";
+import { VariantManagementType } from "sap/fe/core/converters/ManifestSettings";
 
 /**
  *
@@ -28,9 +28,9 @@ class ManifestWrapper {
 	/**
 	 * Creates a wrapper object to ensure the data returned from the manifest is consistent and everything is merged correctly.
 	 *
-	 * @param {BaseManifestSettings} oManifestSettings The manifest settings for the current page
-	 * @param {Function} mergeFn A function that will be used to perform the merge
-	 * @returns {ManifestWrapper} The manifest wrapper object
+	 * @param oManifestSettings The manifest settings for the current page
+	 * @param mergeFn A function that will be used to perform the merge
+	 * @returns The manifest wrapper object
 	 */
 	constructor(private oManifestSettings: BaseManifestSettings, private mergeFn: Function) {}
 
@@ -46,7 +46,7 @@ class ManifestWrapper {
 	/**
 	 * Checks whether the current template should display the filter bar.
 	 *
-	 * @returns {boolean} `true` if the filter bar should be hidden
+	 * @returns `true` if the filter bar should be hidden
 	 */
 	isFilterBarHidden(): boolean {
 		return !!(this.oManifestSettings as ListReportManifestSettings)?.hideFilterBar;
@@ -55,7 +55,7 @@ class ManifestWrapper {
 	/**
 	 * Checks whether the current environment is a desktop or not.
 	 *
-	 * @returns {boolean} `true` if we are on a desktop
+	 * @returns `true` if we are on a desktop
 	 */
 	isDesktop(): boolean {
 		return !!this.oManifestSettings.isDesktop;
@@ -64,7 +64,7 @@ class ManifestWrapper {
 	/**
 	 * Checks whether the current environment is a mobile phone or not.
 	 *
-	 * @returns {boolean} `true` if we are on a mobile phone
+	 * @returns `true` if we are on a mobile phone
 	 */
 	isPhone(): boolean {
 		return !!this.oManifestSettings.isPhone;
@@ -73,8 +73,8 @@ class ManifestWrapper {
 	/**
 	 * Retrieves the form containers (field groups or identification) defined in the manifest.
 	 *
-	 * @param {string} facetTarget The target annotation path for this form
-	 * @returns {FormManifestConfiguration} A set of form containers defined in the manifest indexed by an iterable key
+	 * @param facetTarget The target annotation path for this form
+	 * @returns A set of form containers defined in the manifest indexed by an iterable key
 	 */
 	getFormContainer(facetTarget: string): FormManifestConfiguration {
 		return this.oManifestSettings.controlConfiguration?.[facetTarget] as FormManifestConfiguration;
@@ -82,7 +82,7 @@ class ManifestWrapper {
 	/**
 	 * Retrieves the header facets defined in the manifest.
 	 *
-	 * @returns {ConfigurableRecord<ManifestHeaderFacet>} A set of header facets defined in the manifest indexed by an iterable key
+	 * @returns A set of header facets defined in the manifest indexed by an iterable key
 	 */
 	getHeaderFacets(): ConfigurableRecord<ManifestHeaderFacet> {
 		return this.mergeFn(
@@ -94,7 +94,7 @@ class ManifestWrapper {
 	/**
 	 * Retrieves the header actions defined in the manifest.
 	 *
-	 * @returns {ConfigurableRecord<ManifestAction>} A set of actions defined in the manifest indexed by an iterable key
+	 * @returns A set of actions defined in the manifest indexed by an iterable key
 	 */
 	getHeaderActions(): ConfigurableRecord<ManifestAction> {
 		return this.oManifestSettings.content?.header?.actions || {};
@@ -102,7 +102,7 @@ class ManifestWrapper {
 	/**
 	 * Retrieves the footer actions defined in the manifest.
 	 *
-	 * @returns {ConfigurableRecord<ManifestAction>} A set of actions defined in the manifest indexed by an iterable key
+	 * @returns A set of actions defined in the manifest indexed by an iterable key
 	 */
 	getFooterActions(): ConfigurableRecord<ManifestAction> {
 		return this.oManifestSettings.content?.footer?.actions || {};
@@ -111,7 +111,7 @@ class ManifestWrapper {
 	/**
 	 * Retrieves the variant management as defined in the manifest.
 	 *
-	 * @returns {VariantManagementType} A type of variant management
+	 * @returns A type of variant management
 	 */
 	getVariantManagement(): VariantManagementType {
 		return this.oManifestSettings.variantManagement || VariantManagementType.None;
@@ -120,7 +120,7 @@ class ManifestWrapper {
 	/**
 	 * Retrieves the annotation Path for the SPV in the manifest.
 	 *
-	 * @returns {string|undefined} The annotation path for the default SPV or undefined.
+	 * @returns The annotation path for the default SPV or undefined.
 	 */
 	getDefaultTemplateAnnotationPath(): string | undefined {
 		return this.oManifestSettings.defaultTemplateAnnotationPath;
@@ -129,9 +129,9 @@ class ManifestWrapper {
 	/**
 	 * Retrieves the control configuration as defined in the manifest for a specific annotation path.
 	 *
-	 * @param {string} sAnnotationPath The relative annotation path
+	 * @param sAnnotationPath The relative annotation path
 	 * @private
-	 * @returns {object} The control configuration
+	 * @returns The control configuration
 	 */
 	getControlConfiguration(sAnnotationPath: string): any {
 		return this.oManifestSettings?.controlConfiguration?.[sAnnotationPath] || {};
@@ -139,8 +139,8 @@ class ManifestWrapper {
 	/**
 	 * Retrieves the configured settings for a given navigation target.
 	 *
-	 * @param {string} navigationOrCollectionName The name of the navigation to check
-	 * @returns {NavigationSettingsConfiguration} The navigation settings configuration
+	 * @param navigationOrCollectionName The name of the navigation to check
+	 * @returns The navigation settings configuration
 	 */
 	getNavigationConfiguration(navigationOrCollectionName: string): NavigationSettingsConfiguration {
 		return this.oManifestSettings?.navigation?.[navigationOrCollectionName] || {};
@@ -149,7 +149,7 @@ class ManifestWrapper {
 	/**
 	 * Retrieves the view level.
 	 *
-	 * @returns {number} The current view level
+	 * @returns The current view level
 	 */
 	getViewLevel(): number {
 		return this.oManifestSettings?.viewLevel || -1;
@@ -158,7 +158,7 @@ class ManifestWrapper {
 	/**
 	 * Retrieves the contentDensities setting of the application.
 	 *
-	 * @returns {ContentDensitiesType} The current content density
+	 * @returns The current content density
 	 */
 	getContentDensities(): ContentDensitiesType {
 		return (
@@ -172,7 +172,7 @@ class ManifestWrapper {
 	/**
 	 * Checks whether we are in FCL mode or not.
 	 *
-	 * @returns {boolean} `true` if we are in FCL
+	 * @returns `true` if we are in FCL
 	 */
 	isFclEnabled(): boolean {
 		return !!this.oManifestSettings?.fclEnabled;
@@ -181,7 +181,7 @@ class ManifestWrapper {
 	/**
 	 * Checks whether the current settings (application / shell) allows us to use condensed layout.
 	 *
-	 * @returns {boolean} `true` if we can use the condensed layout, false otherwise
+	 * @returns `true` if we can use the condensed layout, false otherwise
 	 */
 	isCondensedLayoutCompliant(): boolean {
 		const manifestContentDensity = this.oManifestSettings?.contentDensities || {
@@ -195,13 +195,23 @@ class ManifestWrapper {
 		}
 		return isCondensedLayoutCompliant;
 	}
+	/**
+	 * Checks whether the current settings (application / shell) uses compact mode as content density.
+	 *
+	 * @returns `true` if compact mode is set as content density, false otherwise
+	 */
+	isCompactType(): boolean {
+		const manifestContentDensity = this.getContentDensities();
+		const shellContentDensity = this.oManifestSettings?.shellContentDensity || "compact";
+		return manifestContentDensity.compact !== false || shellContentDensity === "compact" ? true : false;
+	}
 
 	//region OP Specific
 
 	/**
 	 * Retrieves the sections defined in the manifest.
 	 *
-	 * @returns {ConfigurableRecord<ManifestSection>} A set of manifest sections indexed by an iterable key
+	 * @returns A set of manifest sections indexed by an iterable key
 	 */
 	getSections(): ConfigurableRecord<ManifestSection> {
 		return this.mergeFn(
@@ -214,7 +224,7 @@ class ManifestWrapper {
 	/**
 	 * Returns true of the header of the application is editable and should appear in the facets.
 	 *
-	 * @returns {boolean} `true` if the header if editable
+	 * @returns `true` if the header if editable
 	 */
 	isHeaderEditable(): boolean {
 		return this.getShowObjectPageHeader() && (this.oManifestSettings as ObjectPageManifestSettings).editableHeaderContent;
@@ -222,7 +232,7 @@ class ManifestWrapper {
 	/**
 	 * Returns true if we should show the object page header.
 	 *
-	 * @returns {boolean} `true` if the header should be displayed
+	 * @returns `true` if the header should be displayed
 	 */
 	getShowAnchorBar(): boolean {
 		return (this.oManifestSettings as ObjectPageManifestSettings).content?.header?.anchorBarVisible !== undefined
@@ -233,7 +243,7 @@ class ManifestWrapper {
 	/**
 	 * Defines whether or not the section will be displayed in different tabs.
 	 *
-	 * @returns {boolean} `true` if the icon tab bar should be used instead of scrolling
+	 * @returns `true` if the icon tab bar should be used instead of scrolling
 	 */
 	useIconTabBar(): boolean {
 		return this.getShowAnchorBar() && (this.oManifestSettings as ObjectPageManifestSettings).sectionLayout === "Tabs";
@@ -242,7 +252,7 @@ class ManifestWrapper {
 	/**
 	 * Returns true if the object page header is to be shown.
 	 *
-	 * @returns {boolean} `true` if the object page header is to be displayed
+	 * @returns `true` if the object page header is to be displayed
 	 */
 	getShowObjectPageHeader(): boolean {
 		return (this.oManifestSettings as ObjectPageManifestSettings).content?.header?.visible !== undefined
@@ -257,7 +267,7 @@ class ManifestWrapper {
 	/**
 	 * Retrieves the multiple view configuration from the manifest.
 	 *
-	 * @returns {MultipleViewsConfiguration} The views that represent the manifest object
+	 * @returns The views that represent the manifest object
 	 */
 	getViewConfiguration(): MultipleViewsConfiguration | undefined {
 		return (this.oManifestSettings as ListReportManifestSettings).views;
@@ -266,7 +276,7 @@ class ManifestWrapper {
 	/**
 	 * Retrieves the stickyMultiTabHeader configuration from the manifest.
 	 *
-	 * @returns {boolean} Returns True if stickyMultiTabHeader is enabled or undefined
+	 * @returns Returns True if stickyMultiTabHeader is enabled or undefined
 	 */
 	getStickyMultiTabHeaderConfiguration(): boolean {
 		const bStickyMultiTabHeader = (this.oManifestSettings as ListReportManifestSettings).stickyMultiTabHeader;
@@ -276,7 +286,7 @@ class ManifestWrapper {
 	/**
 	 * Retrieves the KPI configuration from the manifest.
 	 *
-	 * @returns {object} Returns a map between KPI names and their respective configuration
+	 * @returns Returns a map between KPI names and their respective configuration
 	 */
 	getKPIConfiguration(): { [kpiName: string]: KPIConfiguration } {
 		return (this.oManifestSettings as ListReportManifestSettings).keyPerformanceIndicators || {};
@@ -285,7 +295,7 @@ class ManifestWrapper {
 	/**
 	 * Retrieves the filter configuration from the manifest.
 	 *
-	 * @returns {FilterManifestConfiguration} The filter configuration from the manifest
+	 * @returns The filter configuration from the manifest
 	 */
 	getFilterConfiguration(): FilterManifestConfiguration {
 		return this.getControlConfiguration("@com.sap.vocabularies.UI.v1.SelectionFields");
@@ -293,7 +303,7 @@ class ManifestWrapper {
 	/**
 	 * Returns true if there are multiple entity sets to be displayed.
 	 *
-	 * @returns {boolean} `true` if there are multiple entity sets
+	 * @returns `true` if there are multiple entity sets
 	 */
 	hasMultipleEntitySets(): boolean {
 		const viewConfig = this.getViewConfiguration() || { paths: [] };
@@ -305,8 +315,8 @@ class ManifestWrapper {
 				} else if (this.hasMultipleVisualizations(path as CombinedViewPathConfiguration)) {
 					const { primary, secondary } = path as CombinedViewPathConfiguration;
 					return (
-						primary.some(path => path.entitySet && path.entitySet !== manifestEntitySet) ||
-						secondary.some(path => path.entitySet && path.entitySet !== manifestEntitySet)
+						primary.some((primaryPath) => primaryPath.entitySet && primaryPath.entitySet !== manifestEntitySet) ||
+						secondary.some((secondaryPath) => secondaryPath.entitySet && secondaryPath.entitySet !== manifestEntitySet)
 					);
 				} else {
 					path = path as SingleViewPathConfiguration;
@@ -319,7 +329,7 @@ class ManifestWrapper {
 	/**
 	 * Returns the context path for the template if it is specified in the manifest.
 	 *
-	 * @returns {string} The context path for the template
+	 * @returns The context path for the template
 	 */
 	getContextPath(): string | undefined {
 		return this.oManifestSettings?.contextPath;
@@ -328,16 +338,16 @@ class ManifestWrapper {
 	/**
 	 * Returns true if there are multiple visualizations.
 	 *
-	 * @param {ViewPathConfiguration} path The path from the view
-	 * @returns {boolean} `true` if there are multiple visualizations
+	 * @param path The path from the view
+	 * @returns `true` if there are multiple visualizations
 	 */
 	hasMultipleVisualizations(path?: ViewPathConfiguration): boolean {
 		if (!path) {
 			const viewConfig = this.getViewConfiguration() || { paths: [] };
-			return viewConfig.paths.some(path => {
+			return viewConfig.paths.some((viewPath) => {
 				return (
-					(path as CombinedViewPathConfiguration).primary?.length > 0 &&
-					(path as CombinedViewPathConfiguration).secondary?.length > 0
+					(viewPath as CombinedViewPathConfiguration).primary?.length > 0 &&
+					(viewPath as CombinedViewPathConfiguration).secondary?.length > 0
 				);
 			});
 		}