@sapui5/sap.fe.core 1.97.0 → 1.100.0

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

@@ -0,0 +1,403 @@
+import UIComponent from "sap/ui/core/UIComponent";
+import RouterProxy from "sap/fe/core/RouterProxy";
+import AppStateHandler from "sap/fe/core/AppStateHandler";
+import Log from "sap/base/Log";
+import Diagnostics from "sap/fe/core/support/Diagnostics";
+import JSONModel from "sap/ui/model/json/JSONModel";
+import library from "sap/fe/core/library";
+import ModelHelper from "sap/fe/core/helpers/ModelHelper";
+import ValueListHelper from "sap/fe/macros/internal/valuehelp/ValueListHelper";
+import { UI5Class } from "sap/fe/core/helpers/ClassSupport";
+import ComponentMetadata from "sap/ui/core/ComponentMetadata";
+import View from "sap/ui/core/mvc/View";
+import ODataModel from "sap/ui/model/odata/v4/ODataModel";
+import ResourceBundle from "sap/base/i18n/ResourceBundle";
+import BaseController from "./BaseController";
+import { deleteModelCacheData } from "./converters/MetaModelConverter";
+import ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
+import { RoutingService } from "sap/fe/core/services/RoutingServiceFactory";
+import { IShellServices } from "sap/fe/core/services/ShellServicesFactory";
+import { NavigationService } from "sap/fe/core/services/NavigationServiceFactory";
+import { SideEffectsService } from "sap/fe/core/services/SideEffectsServiceFactory";
+import { EnvironmentCapabilitiesService } from "sap/fe/core/services/EnvironmentServiceFactory";
+
+const NAVCONF = {
+	FCL: {
+		VIEWNAME: "sap.fe.templates.RootContainer.view.Fcl",
+		ROUTERCLASS: "sap.f.routing.Router"
+	},
+	NAVCONTAINER: {
+		VIEWNAME: "sap.fe.templates.RootContainer.view.NavContainer",
+		ROUTERCLASS: "sap.m.routing.Router"
+	}
+};
+
+/**
+ * Main class for components used for an application in SAP Fiori elements.
+ *
+ * Application developers using the templates and building blocks provided by SAP Fiori elements should create their apps by extending this component.
+ * This ensures that all the necessary services that you need for the building blocks and templates to work properly are started.
+ *
+ * When you use sap.fe.core.AppComponent as the base component, you also need to use a rootView. SAP Fiori elements provides two options: <br/>
+ *  - sap.fe.templates.RootContainer.view.NavContainer when using sap.m.routing.Router <br/>
+ *  - sap.fe.templates.RootContainer.view.Fcl when using sap.f.routing.Router (FCL use case) <br/>
+ *
+ * @hideconstructor
+ * @public
+ * @name sap.fe.core.AppComponent
+ */
+@UI5Class("sap.fe.core.AppComponent", ComponentMetadata, {
+	interfaces: ["sap.ui.core.IAsyncContentCreation"],
+	config: {
+		fullWidth: true
+	},
+	manifest: {
+		"sap.ui5": {
+			services: {
+				resourceModel: {
+					factoryName: "sap.fe.core.services.ResourceModelService",
+					"startup": "waitFor",
+					"settings": {
+						"bundles": ["sap.fe.core.messagebundle"],
+						"modelName": "sap.fe.i18n"
+					}
+				},
+				routingService: {
+					factoryName: "sap.fe.core.services.RoutingService",
+					startup: "waitFor"
+				},
+				shellServices: {
+					factoryName: "sap.fe.core.services.ShellServices",
+					startup: "waitFor"
+				},
+				ShellUIService: {
+					factoryName: "sap.ushell.ui5service.ShellUIService"
+				},
+				navigationService: {
+					factoryName: "sap.fe.core.services.NavigationService",
+					startup: "waitFor"
+				},
+				environmentCapabilities: {
+					factoryName: "sap.fe.core.services.EnvironmentService",
+					startup: "waitFor"
+				},
+				sideEffectsService: {
+					factoryName: "sap.fe.core.services.SideEffectsService",
+					startup: "waitFor"
+				},
+				asyncComponentService: {
+					factoryName: "sap.fe.core.services.AsyncComponentService",
+					startup: "waitFor"
+				}
+			},
+			rootView: {
+				viewName: NAVCONF.NAVCONTAINER.VIEWNAME,
+				type: "XML",
+				async: true,
+				id: "appRootView"
+			},
+			routing: {
+				config: {
+					controlId: "appContent",
+					routerClass: NAVCONF.NAVCONTAINER.ROUTERCLASS,
+					viewType: "XML",
+					controlAggregation: "pages",
+					async: true,
+					containerOptions: {
+						propagateModel: true
+					}
+				}
+			}
+		}
+	},
+	designtime: "sap/fe/core/designtime/AppComponent.designtime",
+
+	library: "sap.fe.core"
+})
+class AppComponent extends UIComponent {
+	static instanceMap: Record<string, AppComponent> = {};
+	private _oRouterProxy!: RouterProxy;
+	private _oAppStateHandler!: AppStateHandler;
+	private bInitializeRouting?: boolean;
+	private _oDiagnostics!: Diagnostics;
+	private entityContainer: any;
+	/**
+	 * @private
+	 * @name sap.fe.core.AppComponent.getMetadata
+	 * @function
+	 */
+
+	_isFclEnabled() {
+		const oManifestUI5 = this.getMetadata().getManifestEntry("/sap.ui5", true);
+		return NAVCONF.FCL.VIEWNAME === oManifestUI5.rootView.viewName;
+	}
+
+	/**
+	 * Get a reference to the RouterProxy.
+	 *
+	 * @function
+	 * @name sap.fe.core.AppComponent#getRouterProxy
+	 * @memberof sap.fe.core.AppComponent
+	 * @returns {oObject} A Reference to the RouterProxy
+	 *
+	 * @ui5-restricted
+	 * @final
+	 */
+	getRouterProxy(): RouterProxy {
+		return this._oRouterProxy;
+	}
+
+	/**
+	 * Get a reference to the AppStateHandler.
+	 *
+	 * @function
+	 * @name sap.fe.core.AppComponent#getAppStateHandler
+	 * @memberof sap.fe.core.AppComponent
+	 * @returns {oObject} A reference to the AppStateHandler
+	 *
+	 * @ui5-restricted
+	 * @final
+	 */
+	getAppStateHandler() {
+		return this._oAppStateHandler;
+	}
+
+	/**
+	 * Get a reference to the nav/FCL Controller.
+	 *
+	 * @function
+	 * @name sap.fe.core.AppComponent#getRootViewController
+	 * @memberof sap.fe.core.AppComponent
+	 * @returns {oObject} A reference to the FCL Controller
+	 *
+	 * @ui5-restricted
+	 * @final
+	 */
+	getRootViewController(): BaseController {
+		return (this.getRootControl() as View).getController() as BaseController;
+	}
+
+	/**
+	 * Get the NavContainer control or the FCL control.
+	 *
+	 * @function
+	 * @name sap.fe.core.AppComponent#getRootContainer
+	 * @memberof sap.fe.core.AppComponent
+	 * @returns {oObject} A reference to NavContainer control or the FCL control
+	 *
+	 * @ui5-restricted
+	 * @final
+	 */
+	getRootContainer() {
+		return (this.getRootControl() as View).getContent()[0];
+	}
+
+	init(...args: any[]) {
+		this.setModel(
+			new JSONModel({
+				editMode: library.EditMode.Display,
+				isEditable: false,
+				draftStatus: library.DraftStatus.Clear,
+				busy: false,
+				busyLocal: {},
+				pages: {}
+			}),
+			"ui"
+		);
+
+		const oInternalModel = new JSONModel({
+			pages: {}
+		});
+
+		ModelHelper.enhanceInternalJSONModel(oInternalModel);
+
+		this.setModel(oInternalModel, "internal");
+
+		this.bInitializeRouting = this.bInitializeRouting !== undefined ? this.bInitializeRouting : true;
+		this._oRouterProxy = new RouterProxy();
+		this._oAppStateHandler = new AppStateHandler(this);
+		this._oDiagnostics = new Diagnostics();
+		const oModel = this.getModel() as ODataModel;
+		if (oModel) {
+			this.entityContainer = oModel.getMetaModel().requestObject("/$EntityContainer/");
+		}
+
+		const oManifestUI5 = this.getMetadata().getManifestEntry("/sap.ui5", true);
+		if (
+			oManifestUI5.rootView.viewName === NAVCONF.FCL.VIEWNAME &&
+			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
+		) {
+			Log.info('Rootcontainer: "' + NAVCONF.NAVCONTAINER.VIEWNAME + '" - Routerclass: "' + NAVCONF.NAVCONTAINER.ROUTERCLASS + '"');
+		} else if (oManifestUI5.rootView.viewName.indexOf("sap.fe") !== -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" +
+					"Expected values are \n" +
+					"\t - (" +
+					NAVCONF.NAVCONTAINER.VIEWNAME +
+					"/" +
+					NAVCONF.NAVCONTAINER.ROUTERCLASS +
+					")\n" +
+					"\t - (" +
+					NAVCONF.FCL.VIEWNAME +
+					"/" +
+					NAVCONF.FCL.ROUTERCLASS +
+					")"
+			);
+		} else {
+			Log.info('Rootcontainer: "' + oManifestUI5.rootView.viewName + '" - Routerclass: "' + NAVCONF.NAVCONTAINER.ROUTERCLASS + '"');
+		}
+
+		// Adding Semantic Date Operators
+		// Commenting since it is not needed for SingleRange
+		// SemanticDateOperators.addSemanticDateOperators();
+
+		// the init function configures the routing according to the settings above
+		// it will call the createContent function to instantiate the RootView and add it to the UIComponent aggregations
+
+		// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+		// @ts-ignore
+		UIComponent.prototype.init.apply(this, args);
+		AppComponent.instanceMap[this.getId()] = this;
+	}
+	onServicesStarted() {
+		//router must be started once the rootcontainer is initialized
+		//starting of the router
+		const finalizedRoutingInitialization = () => {
+			this.entityContainer
+				.then(() => {
+					if ((this.getRootViewController() as any).attachRouteMatchers) {
+						(this.getRootViewController() as any).attachRouteMatchers();
+					}
+					this.getRouter().initialize();
+					this.getRouterProxy().init(this, this._isFclEnabled());
+				})
+				.catch((error: any) => {
+					const oResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle;
+
+					(this.getRootViewController() as any).displayMessagePage(
+						oResourceBundle.getText("C_APP_COMPONENT_SAPFE_APPSTART_TECHNICAL_ISSUES"),
+						{
+							title: oResourceBundle.getText("C_COMMON_SAPFE_ERROR"),
+							description: error.message,
+							FCLLevel: 0
+						}
+					);
+				});
+		};
+
+		if (this.bInitializeRouting) {
+			return this.getRoutingService()
+				.initializeRouting()
+				.then(() => {
+					if (this.getRootViewController()) {
+						return finalizedRoutingInitialization();
+					} else {
+						(this.getRootControl() as any).attachAfterInit(function() {
+							finalizedRoutingInitialization();
+						});
+					}
+				})
+				.catch(function(err: any) {
+					Log.error("cannot cannot initialize routing: " + err);
+				});
+		}
+	}
+	exit() {
+		this._oAppStateHandler.destroy();
+		this._oRouterProxy.destroy();
+		// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+		// @ts-ignore
+		delete this._oAppStateHandler;
+		// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+		// @ts-ignore
+		delete this._oRouterProxy;
+		deleteModelCacheData(this.getMetaModel());
+		this.getModel("ui").destroy();
+	}
+	getMetaModel(): ODataMetaModel {
+		return this.getModel().getMetaModel() as ODataMetaModel;
+	}
+	getDiagnostics() {
+		return this._oDiagnostics;
+	}
+	destroy(...args: any[]) {
+		// 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
+			//delete sap.ui.fl.FlexControllerFactory._componentInstantiationPromises[this.getId()];
+
+			ValueListHelper.initializeCachedValueHelp();
+
+			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;
+		} catch (e) {
+			Log.info(e);
+		}
+
+		//WORKAROUND for sticky discard request : due to async callback, request triggered by the exitApplication will be send after the UIComponent.prototype.destroy
+		//so we need to copy the Requestor headers as it will be destroy
+
+		// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+		// @ts-ignore
+		const oMainModel = (this as any).oModels[undefined];
+		const oHeaders = jQuery.extend({}, oMainModel.oRequestor.mHeaders);
+		// 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();
+		// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+		// @ts-ignore
+		UIComponent.prototype.destroy.apply(this, [args]);
+		oMainModel.oRequestor.mHeaders = oHeaders;
+	}
+	getComponentData(): any {
+		return super.getComponentData();
+	}
+	getRoutingService(): RoutingService {
+		return {} as RoutingService; // overriden at runtime
+	}
+	getShellServices(): IShellServices {
+		return {} as IShellServices; // overriden at runtime
+	}
+	getNavigationService(): NavigationService {
+		return {} as NavigationService; // overriden at runtime
+	}
+	getSideEffectsService(): SideEffectsService {
+		return {} as SideEffectsService;
+	}
+	getEnvironmentCapabilities(): EnvironmentCapabilitiesService {
+		return {} as EnvironmentCapabilitiesService;
+	}
+
+	getStartupParameters() {
+		const oComponentData = this.getComponentData() as any;
+		const oStartUpParameters = (oComponentData && oComponentData.startupParameters) || {};
+		return Promise.resolve(oStartUpParameters);
+	}
+	restore() {
+		// called by FLP when app sap-keep-alive is enabled and app is restored
+		(this.getRootViewController() as any).viewState.onRestore();
+	}
+	suspend() {
+		// called by FLP when app sap-keep-alive is enabled and app is suspended
+		(this.getRootViewController() as any).viewState.onSuspend();
+	}
+}
+
+export default AppComponent;