@sapui5/sap.fe.core 1.100.0 → 1.102.0

package/src/sap/fe/core/services/RoutingServiceFactory.ts

@@ -1,33 +1,38 @@
-import Event from "sap/ui/base/Event";
-import Service from "sap/ui/core/service/Service";
-import ServiceFactory from "sap/ui/core/service/ServiceFactory";
-import BindingParser from "sap/ui/base/BindingParser";
-import SemanticKeyHelper from "sap/fe/core/helpers/SemanticKeyHelper";
 import Log from "sap/base/Log";
-import EventProvider from "sap/ui/base/EventProvider";
-import BusyLocker from "sap/fe/core/BusyLocker";
-import ModelHelper from "sap/fe/core/helpers/ModelHelper";
-import EditState from "sap/fe/core/helpers/EditState";
-import messageHandling from "sap/fe/core/actions/messageHandling";
+import AppComponent from "sap/fe/core/AppComponent";
+import BusyLocker from "sap/fe/core/controllerextensions/BusyLocker";
+import messageHandling from "sap/fe/core/controllerextensions/messageHandler/messageHandling";
 import Placeholder from "sap/fe/core/controllerextensions/Placeholder";
+import RouterProxy from "sap/fe/core/controllerextensions/routing/RouterProxy";
 import AppStartupHelper from "sap/fe/core/helpers/AppStartupHelper";
-import ODataUtils from "sap/ui/model/odata/v4/ODataUtils";
-import { ServiceContext } from "sap/ui/core/service";
-import AppComponent from "sap/fe/core/AppComponent";
-import ODataModel from "sap/ui/model/odata/v4/ODataModel";
-import ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
+import { defineUI5Class, event } from "sap/fe/core/helpers/ClassSupport";
+import EditState from "sap/fe/core/helpers/EditState";
+import ModelHelper from "sap/fe/core/helpers/ModelHelper";
+import SemanticKeyHelper from "sap/fe/core/helpers/SemanticKeyHelper";
+import BindingParser from "sap/ui/base/BindingParser";
+import Event from "sap/ui/base/Event";
+import EventProvider from "sap/ui/base/EventProvider";
 import Router from "sap/ui/core/routing/Router";
-import RouterProxy from "sap/fe/core/RouterProxy";
+import Service from "sap/ui/core/service/Service";
+import ServiceFactory from "sap/ui/core/service/ServiceFactory";
 import Context from "sap/ui/model/odata/v4/Context";
+import ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
+import ODataModel from "sap/ui/model/odata/v4/ODataModel";
+import ODataUtils from "sap/ui/model/odata/v4/ODataUtils";
+import { ServiceContext } from "types/extension_types";
 type RoutingServiceSettings = {};
-const RoutingServiceEventing = EventProvider.extend("sap.fe.core.services.RoutingServiceEventing", {
-	metadata: {
-		events: {
-			"routeMatched": {},
-			"afterRouteMatched": {}
-		}
-	}
-});
+@defineUI5Class("sap.fe.core.services.RoutingServiceEventing")
+class RoutingServiceEventing extends EventProvider {
+	@event()
+	routeMatched!: Function;
+	@event()
+	afterRouteMatched!: Function;
+}
+
+export type SemanticMapping = {
+	semanticPath: string;
+	technicalPath: string;
+};
 export class RoutingService extends Service<RoutingServiceSettings> {
 	oAppComponent!: AppComponent;
 	oModel!: ODataModel;
@@ -39,7 +44,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 	outbounds: any;
 	_mTargets: any;
 	_mRoutes: any;
-	oLastSemanticMapping: any;
+	oLastSemanticMapping?: SemanticMapping;
 	bExitOnNavigateBackToRoot?: boolean;
 	sCurrentRouteName?: string;
 	sCurrentRoutePattern?: string;
@@ -236,7 +241,8 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 									!this._mTargets[sTargetName].options.settings.fullContextPath
 								) {
 									if (target.viewLevel === 0) {
-										this._mTargets[sTargetName].options.settings.fullContextPath = "/" + sNavName + "/";
+										this._mTargets[sTargetName].options.settings.fullContextPath =
+											(sNavName.startsWith("/") ? "" : "/") + sNavName + "/";
 									} else {
 										this._mTargets[sTargetName].options.settings.fullContextPath =
 											settings.fullContextPath + sNavName + "/";
@@ -306,17 +312,17 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 		return this._getTargetInformation(sCorrectTargetName);
 	}
 
-	getLastSemanticMapping() {
+	getLastSemanticMapping(): SemanticMapping | undefined {
 		return this.oLastSemanticMapping;
 	}
 
-	setLastSemanticMapping(oMapping: any) {
+	setLastSemanticMapping(oMapping?: SemanticMapping) {
 		this.oLastSemanticMapping = oMapping;
 	}
 
 	navigateTo(oContext: any, sRouteName: any, mParameterMapping: any, bPreserveHistory: any) {
 		let sTargetURLPromise, bIsStickyMode: boolean;
-		if (oContext.getModel() && oContext.getModel().getMetaModel) {
+		if (oContext.getModel() && oContext.getModel().getMetaModel && oContext.getModel().getMetaModel()) {
 			bIsStickyMode = ModelHelper.isStickySessionSupported(oContext.getModel().getMetaModel());
 		}
 		if (!mParameterMapping) {
@@ -351,7 +357,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 				// We assume the defined parameters will be compatible with a binding expression
 				const oParsedExpression = BindingParser.complexParser(sParameterMappingExpression);
 				const aParts = oParsedExpression.parts || [oParsedExpression];
-				const aResolvedParameterPromises = aParts.map(function(oPathPart: any) {
+				const aResolvedParameterPromises = aParts.map(function (oPathPart: any) {
 					const aRelativeParts = oPathPart.path.split("../");
 					// We go up the current context path as many times as necessary
 					const aLocalParts = aContextPathParts.slice(0, aContextPathParts.length - aRelativeParts.length + 1);
@@ -359,7 +365,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 
 					const sPropertyPath = aLocalParts.join("/");
 					const oMetaContext = (oMetaModel as any).getMetaContext(sPropertyPath);
-					return oContext.requestProperty(sPropertyPath).then(function(oValue: any) {
+					return oContext.requestProperty(sPropertyPath).then(function (oValue: any) {
 						const oPropertyInfo = oMetaContext.getObject();
 						const sEdmType = oPropertyInfo.$Type;
 						return ODataUtils.formatLiteral(oValue, sEdmType);
@@ -374,11 +380,11 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 				});
 			});
 
-			oParametersPromise = Promise.all(aAllResolvedParameterPromises).then(function(
+			oParametersPromise = Promise.all(aAllResolvedParameterPromises).then(function (
 				aAllResolvedParameters: { key: any; value: any }[]
 			) {
 				const oParameters: any = {};
-				aAllResolvedParameters.forEach(function(oResolvedParameter: { key: any; value: any }) {
+				aAllResolvedParameters.forEach(function (oResolvedParameter: { key: any; value: any }) {
 					oParameters[oResolvedParameter.key] = oResolvedParameter.value;
 				});
 				return oParameters;
@@ -436,11 +442,12 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 					targetPath?: string;
 					showPlaceholder?: boolean;
 					bDraftNavigation?: boolean;
+					bNavigateToSiblingEntity?: boolean;
 			  }
 			| undefined,
 		oViewData: any | undefined,
 		oCurrentTargetInfo: any | undefined
-	): Promise<void> {
+	): Promise<boolean> {
 		let sTargetRoute: string = "",
 			oRouteParametersPromise,
 			bIsStickyMode: boolean = false;
@@ -462,7 +469,8 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 		// If the path is empty, we're supposed to navigate to the first page of the app
 		// Check if we need to exit from the app instead
 		if (sTargetPath.length === 0 && this.bExitOnNavigateBackToRoot) {
-			return Promise.resolve(this.oRouterProxy.exitFromApp());
+			this.oRouterProxy.exitFromApp();
+			return Promise.resolve(true);
 		}
 
 		// If the context is deferred or async, we add (...) to the path
@@ -484,7 +492,8 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 			bPersistOPScroll: mParameters?.bPersistOPScroll,
 			useContext: mParameters?.updateFCLLevel === -1 || mParameters?.bRecreateContext ? undefined : oContext,
 			bDraftNavigation: mParameters?.bDraftNavigation,
-			bShowPlaceholder: mParameters?.showPlaceholder !== undefined ? mParameters?.showPlaceholder : true
+			bShowPlaceholder: mParameters?.showPlaceholder !== undefined ? mParameters?.showPlaceholder : true,
+			bNavigateToSiblingEntity: mParameters?.bNavigateToSiblingEntity
 		};
 
 		if (mParameters?.checkNoHashChange) {
@@ -504,7 +513,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 
 				this._fireRouteMatchEvents(mEventParameters);
 
-				return Promise.resolve();
+				return Promise.resolve(true);
 			}
 		}
 
@@ -539,10 +548,9 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 			return oRouteParametersPromise.then((oRouteParameters: any) => {
 				oRouteParameters.bIsStickyMode = bIsStickyMode;
 				this.oRouter.navTo(sTargetRoute, oRouteParameters);
-				return Promise.resolve();
+				return Promise.resolve(true);
 			});
 		}
-
 		return this.oRouterProxy
 			.navToHash(sTargetPath, false, mParameters?.noPreservationCache, mParameters?.bForceFocus, !bIsStickyMode)
 			.then((bNavigated: any) => {
@@ -550,6 +558,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 					// The navigation did not happen --> remove the navigation parameters from the queue as they shouldn't be used
 					this.navigationInfoQueue.pop();
 				}
+				return bNavigated;
 			});
 	}
 
@@ -682,7 +691,12 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 			}
 		}
 
-		return (this.oAppComponent.getRootViewController() as any).calculateLayout(FCLLevel, sPath, mParameters.sLayout);
+		return (this.oAppComponent.getRootViewController() as any).calculateLayout(
+			FCLLevel,
+			sPath,
+			mParameters.sLayout,
+			mParameters.keepCurrentLayout
+		);
 	}
 
 	/**
@@ -740,7 +754,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 				.then(() => {
 					this.oRouterProxy.resolveRouteMatch();
 				})
-				.catch(function(oError: any) {
+				.catch(function (oError: any) {
 					Log.error("Error while restoring history", oError);
 				});
 		} else {
@@ -754,7 +768,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 	detachRouteMatched(fnFunction: any, oListener?: any) {
 		this.eventProvider.detachEvent("routeMatched", fnFunction, oListener);
 	}
-	attachAfterRouteMatched(oData: any, fnFunction: any, oListener: any) {
+	attachAfterRouteMatched(oData: any, fnFunction: any, oListener?: any) {
 		this.eventProvider.attachEvent("afterRouteMatched", oData, fnFunction, oListener);
 	}
 	detachAfterRouteMatched(fnFunction: any, oListener: any) {
@@ -767,7 +781,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 		return oAppComponent
 			.getMetadata()
 			.getManifestEntry("/sap.ui5/routing/routes")
-			.filter(function(oRoute: any) {
+			.filter(function (oRoute: any) {
 				return oRoute.name === oRouteInfo.name;
 			})[0];
 	}
@@ -797,11 +811,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 		EditState.resetEditState();
 		this.bExitOnNavigateBackToRoot = !this.oRouter.match("");
 
-		const bIsIappState =
-			this.oRouter
-				.getHashChanger()
-				.getHash()
-				.indexOf("sap-iapp-state") !== -1;
+		const bIsIappState = this.oRouter.getHashChanger().getHash().indexOf("sap-iapp-state") !== -1;
 		const initPromise = this.oAppComponent
 			.getStartupParameters()
 			.then((oStartupParameters: any) => {
@@ -818,7 +828,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 					}
 				}
 			})
-			.catch(function(oError: any) {
+			.catch(function (oError: any) {
 				Log.error("Error during routing initialization", oError);
 			});