@sapui5/sap.fe.core 1.108.2 → 1.110.0

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

@@ -1,9 +1,13 @@
 import Log from "sap/base/Log";
+import type FlexibleColumnLayout from "sap/f/FlexibleColumnLayout";
 import AppStateHandler from "sap/fe/core/AppStateHandler";
 import RouterProxy from "sap/fe/core/controllerextensions/routing/RouterProxy";
+import type { ContentDensitiesType } from "sap/fe/core/converters/ManifestSettings";
 import { defineUI5Class } from "sap/fe/core/helpers/ClassSupport";
 import ModelHelper from "sap/fe/core/helpers/ModelHelper";
 import library from "sap/fe/core/library";
+import { changeConfiguration } from "sap/fe/core/manifestMerger/ChangePageConfiguration";
+import type RootViewBaseController from "sap/fe/core/rootView/RootViewBaseController";
 import type { EnvironmentCapabilitiesService } from "sap/fe/core/services/EnvironmentServiceFactory";
 import type { NavigationService } from "sap/fe/core/services/NavigationServiceFactory";
 import type { RoutingService } from "sap/fe/core/services/RoutingServiceFactory";
@@ -11,13 +15,13 @@ import type { IShellServices } from "sap/fe/core/services/ShellServicesFactory";
 import type { SideEffectsService } from "sap/fe/core/services/SideEffectsServiceFactory";
 import Diagnostics from "sap/fe/core/support/Diagnostics";
 import ValueListHelper from "sap/fe/macros/internal/valuehelp/ValueListHelper";
+import type NavContainer from "sap/m/NavContainer";
 import Core from "sap/ui/core/Core";
 import type View from "sap/ui/core/mvc/View";
 import UIComponent from "sap/ui/core/UIComponent";
 import JSONModel from "sap/ui/model/json/JSONModel";
 import type ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
 import type ODataModel from "sap/ui/model/odata/v4/ODataModel";
-import type BaseController from "./BaseController";
 import { deleteModelCacheData } from "./converters/MetaModelConverter";
 import SemanticDateOperators from "./helpers/SemanticDateOperators";
 
@@ -36,6 +40,73 @@ const NAVCONF = {
 	}
 };
 
+export type ManifestContentApp = {
+	crossNavigation?: {
+		outbounds?: Record<
+			string,
+			{
+				semanticObject: string;
+				action: string;
+				parameters: string;
+			}
+		>;
+	};
+	title?: string;
+	subTitle?: string;
+	icon?: string;
+};
+
+export type ManifestContentUI5 = {
+	contentDensities?: ContentDensitiesType;
+	pageReadyTimeout?: number;
+	rootView?: {
+		viewName: string;
+	};
+	routing?: {
+		config?: {
+			routerClass: string;
+			controlId?: string;
+		};
+		routes: {
+			pattern: string;
+			name: string;
+			target: string;
+		}[];
+		targets?: Record<
+			string,
+			{
+				id: string;
+				name: string;
+				options?: {
+					settings?: object;
+				};
+			}
+		>;
+	};
+	models: Record<
+		string,
+		{
+			type?: string;
+			dataSource?: string;
+			settings?: object;
+		}
+	>;
+};
+
+export type ManifestContent = {
+	"sap.app"?: ManifestContentApp;
+	"sap.ui5"?: ManifestContentUI5;
+	"sap.fe"?: {
+		form?: {
+			retrieveTextFromValueList?: boolean;
+		};
+	};
+};
+export type ComponentData = {
+	startupParameters?: {
+		preferredMode?: string[];
+	} & Record<string, unknown[]>;
+};
 /**
  * Main class for components used for an application in SAP Fiori elements.
  *
@@ -60,10 +131,10 @@ const NAVCONF = {
 			services: {
 				resourceModel: {
 					factoryName: "sap.fe.core.services.ResourceModelService",
-					"startup": "waitFor",
-					"settings": {
-						"bundles": ["sap.fe.core.messagebundle"],
-						"modelName": "sap.fe.i18n"
+					startup: "waitFor",
+					settings: {
+						bundles: ["sap.fe.core.messagebundle"],
+						modelName: "sap.fe.i18n"
 					}
 				},
 				routingService: {
@@ -124,7 +195,7 @@ class AppComponent extends UIComponent {
 	private _oAppStateHandler!: AppStateHandler;
 	private bInitializeRouting?: boolean;
 	private _oDiagnostics!: Diagnostics;
-	private entityContainer: any;
+	private entityContainer!: Promise<void>;
 	private startupMode: string = StartupMode.Normal;
 
 	/**
@@ -134,11 +205,40 @@ class AppComponent extends UIComponent {
 	 */
 
 	_isFclEnabled() {
-		const oManifestUI5 = this.getManifestEntry("/sap.ui5");
-		return (
-			oManifestUI5?.rootView?.viewName === NAVCONF.FCL.VIEWNAME ||
-			oManifestUI5?.rootView?.viewName === NAVCONF.FCL.VIEWNAME_COMPATIBILITY
-		);
+		const oManifestUI5 = this.getManifestEntry("sap.ui5");
+		return oManifestUI5?.routing?.config?.routerClass === NAVCONF.FCL.ROUTERCLASS;
+	}
+
+	/**
+	 * Provides a hook to initialize feature toggles.
+	 *
+	 * This hook is being called by the SAP Fiori elements AppComponent at the time feature toggles can be initialized.
+	 * To change page configuration use the {@link sap.fe.core.AppComponent#changePageConfiguration} method.
+	 *
+	 * @function
+	 * @name sap.fe.core.AppComponent#initializeFeatureToggles
+	 * @memberof sap.fe.core.AppComponent
+	 * @public
+	 */
+	initializeFeatureToggles(): void {
+		// this method can be overridden by applications
+	}
+
+	/**
+	 * Changes the page configuration of SAP Fiori elements.
+	 *
+	 * This method enables you to change the page configuration of SAP Fiori elements.
+	 *
+	 * @function
+	 * @name sap.fe.core.AppComponent#changePageConfiguration
+	 * @memberof sap.fe.core.AppComponent
+	 * @param pageId The ID of the page for which the configuration is to be changed.
+	 * @param path The path in the page settings for which the configuration is to be changed.
+	 * @param value The new value of the configuration. This could be a plain value like a string, or a Boolean, or a structured object.
+	 * @public
+	 */
+	changePageConfiguration(pageId: string, path: string, value: unknown): void {
+		changeConfiguration(this.getManifest(), pageId, path, value);
 	}
 
 	/**
@@ -179,8 +279,8 @@ class AppComponent extends UIComponent {
 	 * @ui5-restricted
 	 * @final
 	 */
-	getRootViewController(): BaseController {
-		return (this.getRootControl() as View).getController() as BaseController;
+	getRootViewController(): RootViewBaseController {
+		return this.getRootControl().getController();
 	}
 
 	/**
@@ -194,7 +294,7 @@ class AppComponent extends UIComponent {
 	 * @final
 	 */
 	getRootContainer() {
-		return (this.getRootControl() as View).getContent()[0];
+		return this.getRootControl().getContent()[0] as NavContainer | FlexibleColumnLayout;
 	}
 
 	/**
@@ -235,6 +335,8 @@ class AppComponent extends UIComponent {
 	}
 
 	init() {
+		this.initializeFeatureToggles();
+
 		const uiModel = new JSONModel({
 			editMode: library.EditMode.Display,
 			isEditable: false,
@@ -268,31 +370,31 @@ class AppComponent extends UIComponent {
 			this.entityContainer = Promise.resolve();
 		}
 
-		const oManifestUI5 = (this.getManifest() as any)["sap.ui5"];
+		const oManifestUI5 = this.getManifest()["sap.ui5"];
 		if (oManifestUI5?.rootView?.viewName) {
 			// The application specified an own root view in the manifest
 
 			// Root View was moved from sap.fe.templates to sap.fe.core - keep it compatible
 			if (oManifestUI5.rootView.viewName === NAVCONF.FCL.VIEWNAME_COMPATIBILITY) {
 				oManifestUI5.rootView.viewName = NAVCONF.FCL.VIEWNAME;
-			} else if (oManifestUI5?.rootView.viewName === NAVCONF.NAVCONTAINER.VIEWNAME_COMPATIBILITY) {
+			} else if (oManifestUI5.rootView.viewName === NAVCONF.NAVCONTAINER.VIEWNAME_COMPATIBILITY) {
 				oManifestUI5.rootView.viewName = NAVCONF.NAVCONTAINER.VIEWNAME;
 			}
 
 			if (
 				oManifestUI5.rootView.viewName === NAVCONF.FCL.VIEWNAME &&
-				oManifestUI5.routing.config.routerClass === NAVCONF.FCL.ROUTERCLASS
+				oManifestUI5.routing?.config?.routerClass === NAVCONF.FCL.ROUTERCLASS
 			) {
 				Log.info(`Rootcontainer: "${NAVCONF.FCL.VIEWNAME}" - Routerclass: "${NAVCONF.FCL.ROUTERCLASS}"`);
 			} else if (
 				oManifestUI5.rootView.viewName === NAVCONF.NAVCONTAINER.VIEWNAME &&
-				oManifestUI5.routing.config.routerClass === NAVCONF.NAVCONTAINER.ROUTERCLASS
+				oManifestUI5.routing?.config?.routerClass === NAVCONF.NAVCONTAINER.ROUTERCLASS
 			) {
 				Log.info(`Rootcontainer: "${NAVCONF.NAVCONTAINER.VIEWNAME}" - Routerclass: "${NAVCONF.NAVCONTAINER.ROUTERCLASS}"`);
-			} else if (oManifestUI5.rootView.viewName.indexOf("sap.fe.core.rootView") !== -1) {
+			} else if (oManifestUI5.rootView?.viewName?.indexOf("sap.fe.core.rootView") !== -1) {
 				throw Error(
 					`\nWrong configuration for the couple (rootView/routerClass) in manifest file.\n` +
-						`Current values are :(${oManifestUI5.rootView.viewName}/${oManifestUI5.routing.config.routerClass})\n` +
+						`Current values are :(${oManifestUI5.rootView.viewName}/${oManifestUI5.routing?.config?.routerClass})\n` +
 						`Expected values are \n` +
 						`\t - (${NAVCONF.NAVCONTAINER.VIEWNAME}/${NAVCONF.NAVCONTAINER.ROUTERCLASS})\n` +
 						`\t - (${NAVCONF.FCL.VIEWNAME}/${NAVCONF.FCL.ROUTERCLASS})`
@@ -318,16 +420,16 @@ class AppComponent extends UIComponent {
 		const finalizedRoutingInitialization = () => {
 			this.entityContainer
 				.then(() => {
-					if ((this.getRootViewController() as any).attachRouteMatchers) {
-						(this.getRootViewController() as any).attachRouteMatchers();
+					if (this.getRootViewController().attachRouteMatchers) {
+						this.getRootViewController().attachRouteMatchers();
 					}
 					this.getRouter().initialize();
 					this.getRouterProxy().init(this, this._isFclEnabled());
 				})
-				.catch((error: any) => {
+				.catch((error: Error) => {
 					const oResourceBundle = Core.getLibraryResourceBundle("sap.fe.core");
 
-					(this.getRootViewController() as any).displayMessagePage(
+					this.getRootViewController().displayErrorPage(
 						oResourceBundle.getText("C_APP_COMPONENT_SAPFE_APPSTART_TECHNICAL_ISSUES"),
 						{
 							title: oResourceBundle.getText("C_COMMON_SAPFE_ERROR"),
@@ -345,12 +447,12 @@ class AppComponent extends UIComponent {
 					if (this.getRootViewController()) {
 						return finalizedRoutingInitialization();
 					} else {
-						(this.getRootControl() as any).attachAfterInit(function () {
+						this.getRootControl().attachAfterInit(function () {
 							finalizedRoutingInitialization();
 						});
 					}
 				})
-				.catch(function (err: any) {
+				.catch(function (err: Error) {
 					Log.error(`cannot cannot initialize routing: ${err}`);
 				});
 		}
@@ -373,7 +475,7 @@ class AppComponent extends UIComponent {
 	getDiagnostics() {
 		return this._oDiagnostics;
 	}
-	destroy(...args: any[]) {
+	destroy(bSuppressInvalidate?: boolean) {
 		// LEAKS, with workaround for some Flex / MDC issue
 		try {
 			// 	// This one is only a leak if you don't go back to the same component in the long run
@@ -383,14 +485,9 @@ class AppComponent extends UIComponent {
 
 			delete AppComponent.instanceMap[this.getId()];
 
-			// 	var oRegistry = sap.ui.mdc.p13n.Engine.getInstance()._getRegistry();
-			// 	Object.keys(oRegistry).forEach(function(sKey) {
-			// 		Object.keys(oRegistry[sKey].controller).forEach(function(sControllerKey) {
-			// 			oRegistry[sKey].controller[sControllerKey].destroy();
-			// 		});
-			// 	});
-			// 	sap.ui.mdc.p13n.Engine.getInstance().destroy();
-			delete (window as any)._routing;
+			// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+			// @ts-ignore
+			delete (window as unknown)._routing;
 		} catch (e) {
 			Log.info(e as string);
 		}
@@ -400,7 +497,7 @@ class AppComponent extends UIComponent {
 
 		// eslint-disable-next-line @typescript-eslint/ban-ts-comment
 		// @ts-ignore
-		const oMainModel = (this as any).oModels[undefined];
+		const oMainModel = this.oModels[undefined];
 		let oHeaders;
 		if (oMainModel.oRequestor) {
 			oHeaders = jQuery.extend({}, oMainModel.oRequestor.mHeaders);
@@ -408,14 +505,11 @@ class AppComponent extends UIComponent {
 
 		// As we need to cleanup the application / handle the dirty object we need to call our cleanup before the models are destroyed
 		this.getRoutingService()?.beforeExit();
-		super.destroy(...args);
+		super.destroy(bSuppressInvalidate);
 		if (oHeaders && oMainModel.oRequestor) {
 			oMainModel.oRequestor.mHeaders = oHeaders;
 		}
 	}
-	getComponentData(): any {
-		return super.getComponentData();
-	}
 	getRoutingService(): RoutingService {
 		return {} as RoutingService; // overriden at runtime
 	}
@@ -432,19 +526,28 @@ class AppComponent extends UIComponent {
 		return {} as EnvironmentCapabilitiesService;
 	}
 
-	getStartupParameters() {
+	async getStartupParameters() {
 		const oComponentData = this.getComponentData();
-		const oStartUpParameters = (oComponentData && oComponentData.startupParameters) || {};
-		return Promise.resolve(oStartUpParameters);
+		return Promise.resolve((oComponentData && oComponentData.startupParameters) || {});
 	}
 	restore() {
 		// called by FLP when app sap-keep-alive is enabled and app is restored
-		(this.getRootViewController() as any).viewState.onRestore();
+		this.getRootViewController().viewState.onRestore();
 	}
 	suspend() {
 		// called by FLP when app sap-keep-alive is enabled and app is suspended
-		(this.getRootViewController() as any).viewState.onSuspend();
+		this.getRootViewController().viewState.onSuspend();
 	}
 }
 
+interface AppComponent extends UIComponent {
+	getManifest(): ManifestContent;
+	getManifestEntry(entry: "sap.app"): ManifestContentApp;
+	getManifestEntry(entry: "sap.ui5"): ManifestContentUI5;
+	getComponentData(): ComponentData;
+	getRootControl(): {
+		getController(): RootViewBaseController;
+	} & View;
+}
+
 export default AppComponent;