@sapui5/sap.fe.core 1.102.0 → 1.103.0

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

@@ -1,25 +1,26 @@
 import Log from "sap/base/Log";
-import AppComponent from "sap/fe/core/AppComponent";
+import type 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 type RouterProxy from "sap/fe/core/controllerextensions/routing/RouterProxy";
 import AppStartupHelper from "sap/fe/core/helpers/AppStartupHelper";
 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 type Event from "sap/ui/base/Event";
 import EventProvider from "sap/ui/base/EventProvider";
-import Router from "sap/ui/core/routing/Router";
+import type Router from "sap/ui/core/routing/Router";
 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 type Context from "sap/ui/model/odata/v4/Context";
+import type ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
+import type ODataModel from "sap/ui/model/odata/v4/ODataModel";
 import ODataUtils from "sap/ui/model/odata/v4/ODataUtils";
-import { ServiceContext } from "types/extension_types";
+import type { ServiceContext } from "types/extension_types";
+
 type RoutingServiceSettings = {};
 @defineUI5Class("sap.fe.core.services.RoutingServiceEventing")
 class RoutingServiceEventing extends EventProvider {
@@ -83,8 +84,8 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 	/**
 	 * Parse a manifest routing configuration for internal usage.
 	 *
-	 * @param {object} oRoutingConfig The routing configuration from the manifest
-	 * @param {object} oRootViewConfig The root view configuration from the manifest
+	 * @param oRoutingConfig The routing configuration from the manifest
+	 * @param oRootViewConfig The root view configuration from the manifest
 	 * @private
 	 */
 	_parseRoutingConfiguration(oRoutingConfig: any, oRootViewConfig: any) {
@@ -111,7 +112,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 
 			// Check route pattern: all patterns need to end with ':?query:', that we use for parameters
 			if (sRoutePattern.length < 8 || sRoutePattern.indexOf(":?query:") !== sRoutePattern.length - 8) {
-				Log.warning("Pattern for route " + sRouteName + " doesn't end with ':?query:' : " + sRoutePattern);
+				Log.warning(`Pattern for route ${sRouteName} doesn't end with ':?query:' : ${sRoutePattern}`);
 			}
 			const iRouteLevel = this._getViewLevelFromPattern(sRoutePattern, 0);
 			this._mRoutes[sRouteName] = {
@@ -203,11 +204,11 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 			this.sContextPath = "";
 			if (this._mTargets[sDefaultTargetName].options && this._mTargets[sDefaultTargetName].options.settings) {
 				const oSettings = this._mTargets[sDefaultTargetName].options.settings;
-				this.sContextPath = oSettings.contextPath || "/" + oSettings.entitySet;
+				this.sContextPath = oSettings.contextPath || `/${oSettings.entitySet}`;
 			}
 			if (!this.sContextPath) {
 				Log.warning(
-					"Cannot determine default contextPath: contextPath or entitySet missing in default target: " + sDefaultTargetName
+					`Cannot determine default contextPath: contextPath or entitySet missing in default target: ${sDefaultTargetName}`
 				);
 			}
 		} else {
@@ -226,9 +227,9 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 				// After sorting the targets per level we can then go through their navigation object and update the paths accordingly.
 				if (target.options) {
 					const settings = target.options.settings;
-					const sContextPath = settings.contextPath || (settings.entitySet ? "/" + settings.entitySet : "");
+					const sContextPath = settings.contextPath || (settings.entitySet ? `/${settings.entitySet}` : "");
 					if (!settings.fullContextPath && sContextPath) {
-						settings.fullContextPath = sContextPath + "/";
+						settings.fullContextPath = `${sContextPath}/`;
 					}
 					Object.keys(settings.navigation || {}).forEach((sNavName: string) => {
 						// Check if it's a navigation property
@@ -241,11 +242,13 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 									!this._mTargets[sTargetName].options.settings.fullContextPath
 								) {
 									if (target.viewLevel === 0) {
-										this._mTargets[sTargetName].options.settings.fullContextPath =
-											(sNavName.startsWith("/") ? "" : "/") + sNavName + "/";
+										this._mTargets[sTargetName].options.settings.fullContextPath = `${
+											(sNavName.startsWith("/") ? "" : "/") + sNavName
+										}/`;
 									} else {
-										this._mTargets[sTargetName].options.settings.fullContextPath =
-											settings.fullContextPath + sNavName + "/";
+										this._mTargets[sTargetName].options.settings.fullContextPath = `${
+											settings.fullContextPath + sNavName
+										}/`;
 									}
 								}
 							});
@@ -258,15 +261,15 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 	/**
 	 * Calculates a view level from a pattern by counting the number of segments.
 	 *
-	 * @param {string} sPattern The pattern
-	 * @param {number} viewLevel The current level of view
-	 * @returns {number} The level
+	 * @param sPattern The pattern
+	 * @param viewLevel The current level of view
+	 * @returns The level
 	 */
 	_getViewLevelFromPattern(sPattern: string, viewLevel: number): number {
 		sPattern = sPattern.replace(":?query:", "");
 		const regex = new RegExp("/[^/]*$");
 		if (sPattern && sPattern[0] !== "/" && sPattern[0] !== "?") {
-			sPattern = "/" + sPattern;
+			sPattern = `/${sPattern}`;
 		}
 		if (sPattern.length) {
 			sPattern = sPattern.replace(regex, "");
@@ -289,7 +292,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 	}
 
 	_getComponentId(sOwnerId: any, sComponentId: any) {
-		if (sComponentId.indexOf(sOwnerId + "---") === 0) {
+		if (sComponentId.indexOf(`${sOwnerId}---`) === 0) {
 			return sComponentId.substr(sOwnerId.length + 3);
 		}
 		return sComponentId;
@@ -298,8 +301,8 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 	/**
 	 * Get target information for a given component.
 	 *
-	 * @param {object} oComponentInstance Instance of the component
-	 * @returns {object} The configuration for the target
+	 * @param oComponentInstance Instance of the component
+	 * @returns The configuration for the target
 	 */
 	getTargetInformationFor(oComponentInstance: any) {
 		const sTargetComponentId = this._getComponentId(oComponentInstance._sOwnerId, oComponentInstance.getId());
@@ -341,10 +344,10 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 	/**
 	 * Method to return a map of routing target parameters where the binding syntax is resolved to the current model.
 	 *
-	 * @param {object} mParameters Parameters map in the format [k: string] : ComplexBindingSyntax
-	 * @param {string} sTargetRoute Name of the target route
-	 * @param {object} oContext The instance of the binding context
-	 * @returns {Promise} A promise which resolves to the routing target parameters
+	 * @param mParameters Parameters map in the format [k: string] : ComplexBindingSyntax
+	 * @param sTargetRoute Name of the target route
+	 * @param oContext The instance of the binding context
+	 * @returns A promise which resolves to the routing target parameters
 	 */
 	prepareParameters(mParameters: any, sTargetRoute: string, oContext: Context) {
 		let oParametersPromise;
@@ -390,7 +393,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 				return oParameters;
 			});
 		} catch (oError) {
-			Log.error("Could not parse the parameters for the navigation to route " + sTargetRoute);
+			Log.error(`Could not parse the parameters for the navigation to route ${sTargetRoute}`);
 			oParametersPromise = Promise.resolve(undefined);
 		}
 		return oParametersPromise;
@@ -406,22 +409,21 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 	/**
 	 * Navigates to a context.
 	 *
-	 * @param {sap.ui.model.odata.v4.Context} oContext The Context to be navigated to
-	 * @param {object} [mParameters] Optional, map containing the following attributes:
-	 * @param {boolean} [mParameters.checkNoHashChange] Navigate to the context without changing the URL
-	 * @param {Promise} [mParameters.asyncContext] The context is created async, navigate to (...) and
+	 * @param oContext The Context to be navigated to
+	 * @param [mParameters] Optional, map containing the following attributes:
+	 * @param [mParameters.checkNoHashChange] Navigate to the context without changing the URL
+	 * @param [mParameters.asyncContext] The context is created async, navigate to (...) and
 	 *                    wait for Promise to be resolved and then navigate into the context
-	 * @param {boolean} [mParameters.bDeferredContext] The context shall be created deferred at the target page
-	 * @param {boolean} [mParameters.editable] The target page shall be immediately in the edit mode to avoid flickering
-	 * @param {boolean} [mParameters.bPersistOPScroll] The bPersistOPScroll will be used for scrolling to first tab
-	 * @param {number} [mParameters.updateFCLLevel] `+1` if we add a column in FCL, `-1` to remove a column, 0 to stay on the same column
-	 * @param {boolean} [mParameters.noPreservationCache] Do navigation without taking into account the preserved cache mechanism
-	 * @param {boolean} [mParameters.bRecreateContext] Force re-creation of the context instead of using the one passed as parameter
-	 * @param {boolean} [mParameters.bForceFocus] Forces focus selection after navigation
-	 * @param {object} [oViewData] View data
-	 * @param {object} [oCurrentTargetInfo] The target information from which the navigation is triggered
-	 * @returns {Promise} Promise which is resolved once the navigation is triggered
-	 *
+	 * @param [mParameters.bDeferredContext] The context shall be created deferred at the target page
+	 * @param [mParameters.editable] The target page shall be immediately in the edit mode to avoid flickering
+	 * @param [mParameters.bPersistOPScroll] The bPersistOPScroll will be used for scrolling to first tab
+	 * @param [mParameters.updateFCLLevel] `+1` if we add a column in FCL, `-1` to remove a column, 0 to stay on the same column
+	 * @param [mParameters.noPreservationCache] Do navigation without taking into account the preserved cache mechanism
+	 * @param [mParameters.bRecreateContext] Force re-creation of the context instead of using the one passed as parameter
+	 * @param [mParameters.bForceFocus] Forces focus selection after navigation
+	 * @param [oViewData] View data
+	 * @param [oCurrentTargetInfo] The target information from which the navigation is triggered
+	 * @returns Promise which is resolved once the navigation is triggered
 	 * @ui5-restricted
 	 * @final
 	 */
@@ -481,7 +483,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 		// Add layout parameter if needed
 		const sLayout = this._calculateLayout(sTargetPath, mParameters);
 		if (sLayout) {
-			sTargetPath += "?layout=" + sLayout;
+			sTargetPath += `?layout=${sLayout}`;
 		}
 
 		// Navigation parameters for later usage
@@ -569,10 +571,9 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 	 * @name sap.fe.core.controllerextensions.Routing#navigateToRoute
 	 * @memberof sap.fe.core.controllerextensions.Routing
 	 * @static
-	 * @param {string} sTargetRouteName Name of the target route
-	 * @param {object} [oRouteParameters] Parameters to be used with route to create the target hash
-	 * @returns {Promise} Promise that is resolved when the navigation is finalized
-	 *
+	 * @param sTargetRouteName Name of the target route
+	 * @param [oRouteParameters] Parameters to be used with route to create the target hash
+	 * @returns Promise that is resolved when the navigation is finalized
 	 * @ui5-restricted
 	 * @final
 	 */
@@ -584,8 +585,8 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 	/**
 	 * Checks if one of the current views on the screen is bound to a given context.
 	 *
-	 * @param {sap.ui.model.odata.v4.Context} oContext The context
-	 * @returns {boolean} `true` or `false` if the current state is impacted or not
+	 * @param oContext The context
+	 * @returns `true` or `false` if the current state is impacted or not
 	 */
 	isCurrentStateImpactedBy(oContext: any) {
 		const sPath = oContext.getPath();
@@ -621,7 +622,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 		}
 	}
 
-	_checkContextForSemanticPath(oContext: any) {
+	_checkIfContextSupportsSemanticPath(oContext: Context) {
 		const sPath = oContext.getPath();
 
 		// First, check if this is a level-1 object (path = /aaa(bbb))
@@ -630,8 +631,8 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 		}
 
 		// Then check if the entity has semantic keys
-		const oMetaModel = oContext.getModel().getMetaModel(),
-			sEntitySetName = oMetaModel.getMetaContext(oContext.getPath()).getObject("@sapui.name");
+		const oMetaModel = oContext.getModel().getMetaModel() as ODataMetaModel;
+		const sEntitySetName = oMetaModel.getMetaContext(oContext.getPath()).getObject("@sapui.name") as any as string;
 		if (!SemanticKeyHelper.getSemanticKeys(oMetaModel, sEntitySetName)) {
 			return false;
 		}
@@ -657,7 +658,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 			if (this.oLastSemanticMapping && this.oLastSemanticMapping.technicalPath === sPath) {
 				sPath = this.oLastSemanticMapping.semanticPath;
 			}
-		} else if (this._checkContextForSemanticPath(oContext)) {
+		} else if (this._checkIfContextSupportsSemanticPath(oContext)) {
 			// We check if we have to use a semantic path
 			const sSemanticPath = SemanticKeyHelper.getSemanticPath(oContext, true);
 
@@ -716,7 +717,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 	 * Event handler when a route is matched.
 	 * Hides the busy indicator and fires its own 'routematched' event.
 	 *
-	 * @param {object} oEvent The event
+	 * @param oEvent The event
 	 */
 	_onRouteMatched(oEvent: Event) {
 		const oAppStateHandler = this.oAppComponent.getAppStateHandler(),
@@ -812,7 +813,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 		this.bExitOnNavigateBackToRoot = !this.oRouter.match("");
 
 		const bIsIappState = this.oRouter.getHashChanger().getHash().indexOf("sap-iapp-state") !== -1;
-		const initPromise = this.oAppComponent
+		return this.oAppComponent
 			.getStartupParameters()
 			.then((oStartupParameters: any) => {
 				const bHasStartUpParameters = oStartupParameters !== undefined && Object.keys(oStartupParameters).length !== 0;
@@ -831,8 +832,6 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 			.catch(function (oError: any) {
 				Log.error("Error during routing initialization", oError);
 			});
-
-		return initPromise;
 	}
 
 	getDefaultCreateHash(oStartupParameters?: any) {
@@ -844,6 +843,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 			(sNewHash: any) => {
 				if (sNewHash) {
 					(this.oRouter.getHashChanger().replaceHash as any)(sNewHash);
+					this.oAppComponent.setStartupModeCreate();
 					this.bExitOnNavigateBackToRoot = true;
 				}
 			}
@@ -858,8 +858,10 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 		).then((oDeepLink: any) => {
 			let sHash;
 			if (oDeepLink.context) {
-				const sTechnicalPath = oDeepLink.context.getPath(),
-					sSemanticPath = SemanticKeyHelper.getSemanticPath(oDeepLink.context);
+				const sTechnicalPath = oDeepLink.context.getPath();
+				const sSemanticPath = this._checkIfContextSupportsSemanticPath(oDeepLink.context)
+					? SemanticKeyHelper.getSemanticPath(oDeepLink.context)
+					: sTechnicalPath;
 
 				if (sSemanticPath !== sTechnicalPath) {
 					// Store the mapping technical <-> semantic path to avoid recalculating it later
@@ -875,6 +877,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 			if (sHash) {
 				//Replace the hash with newly created hash
 				(this.oRouter.getHashChanger().replaceHash as any)(sHash);
+				this.oAppComponent.setStartupModeDeeplink();
 			}
 		});
 	}
@@ -886,8 +889,7 @@ export class RoutingService extends Service<RoutingServiceSettings> {
 	/**
 	 * Gets the name of the Draft root entity set or the sticky-enabled entity set.
 	 *
-	 * @returns {string} The name of the root EntitySet
-	 *
+	 * @returns The name of the root EntitySet
 	 * @ui5-restricted
 	 */
 	getContextPath() {