@sapui5/sap.fe.core 1.102.0 → 1.103.0

package/src/sap/fe/core/controllerextensions/InternalRouting.ts

@@ -1,37 +1,31 @@
 import Log from "sap/base/Log";
-import AppComponent from "sap/fe/core/AppComponent";
+import type AppComponent from "sap/fe/core/AppComponent";
 import CommonUtils from "sap/fe/core/CommonUtils";
 import BusyLocker from "sap/fe/core/controllerextensions/BusyLocker";
 import ActivitySync from "sap/fe/core/controllerextensions/collaboration/ActivitySync";
 import draft from "sap/fe/core/controllerextensions/editFlow/draft";
-import RouterProxy from "sap/fe/core/controllerextensions/routing/RouterProxy";
-import {
-	defineUI5Class,
-	EnhanceWithUI5,
-	extensible,
-	finalExtension,
-	methodOverride,
-	publicExtension
-} from "sap/fe/core/helpers/ClassSupport";
+import type RouterProxy from "sap/fe/core/controllerextensions/routing/RouterProxy";
+import type { EnhanceWithUI5 } from "sap/fe/core/helpers/ClassSupport";
+import { defineUI5Class, extensible, finalExtension, methodOverride, publicExtension } 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 FELibrary from "sap/fe/core/library";
-import PageController from "sap/fe/core/PageController";
-import { RoutingService } from "sap/fe/core/services/RoutingServiceFactory";
-import TemplateComponent from "sap/fe/core/TemplateComponent";
-import Event from "sap/ui/base/Event";
+import type PageController from "sap/fe/core/PageController";
+import type { RoutingService } from "sap/fe/core/services/RoutingServiceFactory";
+import type TemplateComponent from "sap/fe/core/TemplateComponent";
+import type Event from "sap/ui/base/Event";
 import Component from "sap/ui/core/Component";
 import Core from "sap/ui/core/Core";
 import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
 import OverrideExecution from "sap/ui/core/mvc/OverrideExecution";
-import View from "sap/ui/core/mvc/View";
-import Router from "sap/ui/core/routing/Router";
+import type View from "sap/ui/core/mvc/View";
+import type Router from "sap/ui/core/routing/Router";
 import Filter from "sap/ui/model/Filter";
 import FilterOperator from "sap/ui/model/FilterOperator";
-import JSONModel from "sap/ui/model/json/JSONModel";
-import Context from "sap/ui/model/odata/v4/Context";
-import { CoreEx } from "types/extension_types";
+import type JSONModel from "sap/ui/model/json/JSONModel";
+import type Context from "sap/ui/model/odata/v4/Context";
+import type { CoreEx } from "types/extension_types";
 
 /**
  * {@link sap.ui.core.mvc.ControllerExtension Controller extension}
@@ -55,7 +49,9 @@ class InternalRouting extends ControllerExtension {
 
 	@methodOverride()
 	onExit() {
-		this._oRoutingService && this._oRoutingService.detachRouteMatched(this._fnRouteMatchedBound);
+		if (this._oRoutingService) {
+			this._oRoutingService.detachRouteMatched(this._fnRouteMatchedBound);
+		}
 	}
 
 	@methodOverride()
@@ -133,10 +129,10 @@ class InternalRouting extends ControllerExtension {
 	/**
 	 * Navigates to the specified navigation target.
 	 *
-	 * @param {sap.ui.model.odata.v4.Context} oContext Context instance
-	 * @param {string} sNavigationTargetName Navigation target name
-	 * @param {object} oSemanticObject Semantic object
-	 * @param {boolean} bPreserveHistory True to force the new URL to be added at the end of the browser history (no replace)
+	 * @param oContext Context instance
+	 * @param sNavigationTargetName Navigation target name
+	 * @param oSemanticObject Semantic object
+	 * @param bPreserveHistory True to force the new URL to be added at the end of the browser history (no replace)
 	 * @ui5-restricted
 	 */
 	@publicExtension()
@@ -159,9 +155,9 @@ class InternalRouting extends ControllerExtension {
 	/**
 	 * Navigates to the specified navigation target route.
 	 *
-	 * @param {string} sTargetRouteName Name of the target route
-	 * @param {object} [oParameters] 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 [oParameters] Parameters to be used with route to create the target hash
+	 * @returns Promise that is resolved when the navigation is finalized
 	 * @ui5-restricted
 	 */
 	@publicExtension()
@@ -172,9 +168,9 @@ class InternalRouting extends ControllerExtension {
 	/**
 	 * Navigates to a specific context.
 	 *
-	 * @param {sap.ui.model.odata.v4.Context} oContext The context to be navigated to
-	 * @param {object} [mParameters] Optional navigation parameters
-	 * @returns {Promise} Promise resolved when the navigation has been triggered
+	 * @param oContext The context to be navigated to
+	 * @param [mParameters] Optional navigation parameters
+	 * @returns Promise resolved when the navigation has been triggered
 	 * @ui5-restricted
 	 */
 	@publicExtension()
@@ -191,9 +187,9 @@ class InternalRouting extends ControllerExtension {
 				this._oRouterProxy.activateRouteMatchSynchronization();
 
 				mParameters.asyncContext
-					.then((oContext: any) => {
+					.then((asyncContext: any) => {
 						// once the context is returned we navigate into it
-						this.navigateToContext(oContext, {
+						this.navigateToContext(asyncContext, {
 							checkNoHashChange: mParameters.checkNoHashChange,
 							editable: mParameters.editable,
 							bPersistOPScroll: mParameters.bPersistOPScroll,
@@ -235,9 +231,9 @@ class InternalRouting extends ControllerExtension {
 	/**
 	 * Navigates backwards from a context.
 	 *
-	 * @param {sap.ui.model.odata.v4.Context} oContext Context to be navigated from
-	 * @param {object} [mParameters] Optional navigation parameters
-	 * @returns {Promise} Promise resolved when the navigation has been triggered
+	 * @param oContext Context to be navigated from
+	 * @param [mParameters] Optional navigation parameters
+	 * @returns Promise resolved when the navigation has been triggered
 	 * @ui5-restricted
 	 */
 	@publicExtension()
@@ -252,9 +248,9 @@ class InternalRouting extends ControllerExtension {
 	/**
 	 * Navigates forwards to a context.
 	 *
-	 * @param {sap.ui.model.odata.v4.Context} oContext Context to be navigated to
-	 * @param {object} mParameters Optional navigation parameters
-	 * @returns {Promise} Promise resolved when the navigation has been triggered
+	 * @param oContext Context to be navigated to
+	 * @param mParameters Optional navigation parameters
+	 * @returns Promise resolved when the navigation has been triggered
 	 * @ui5-restricted
 	 */
 	@publicExtension()
@@ -299,8 +295,8 @@ class InternalRouting extends ControllerExtension {
 	/**
 	 * Checks if one of the current views on the screen is bound to a given context.
 	 *
-	 * @param {sap.ui.model.odata.v4.Context} oContext
-	 * @returns {boolean}
+	 * @param oContext
+	 * @returns `true` if the state is impacted by the context
 	 * @ui5-restricted
 	 */
 	@publicExtension()
@@ -317,7 +313,7 @@ class InternalRouting extends ControllerExtension {
 	 * Called when a route is matched.
 	 * Builds the binding context from the navigation parameters, and bind the page accordingly.
 	 *
-	 * @param {object} oEvent
+	 * @param oEvent
 	 * @ui5-restricted
 	 */
 	_onRouteMatched(oEvent: Event) {
@@ -347,14 +343,14 @@ class InternalRouting extends ControllerExtension {
 
 		for (const sKey in mArguments) {
 			const sValue = mArguments[sKey];
-			if (sValue === "..." && sTarget.indexOf("{" + sKey + "}") >= 0) {
+			if (sValue === "..." && sTarget.indexOf(`{${sKey}}`) >= 0) {
 				bDeferred = true;
 				// Sometimes in preferredMode = create, the edit button is shown in background when the
 				// action parameter dialog shows up, setting bTargetEditable passes editable as true
 				// to onBeforeBinding in _bindTargetPage function
 				oNavigationParameters.bTargetEditable = true;
 			}
-			sTarget = sTarget.replace("{" + sKey + "}", sValue);
+			sTarget = sTarget.replace(`{${sKey}}`, sValue);
 		}
 		if (mArguments["?query"] && mArguments["?query"].hasOwnProperty("i-action")) {
 			oNavigationParameters.bActionCreate = true;
@@ -362,7 +358,7 @@ class InternalRouting extends ControllerExtension {
 
 		// the binding target is always absolute
 		if (sTarget && sTarget[0] !== "/") {
-			sTarget = "/" + sTarget;
+			sTarget = `/${sTarget}`;
 		}
 
 		this.onRouteMatched();
@@ -385,9 +381,9 @@ class InternalRouting extends ControllerExtension {
 	/**
 	 * Deferred binding (during object creation).
 	 *
-	 * @param {string} sTargetPath The path to the deffered context
-	 * @param {object} oNavigationParameters Navigation parameters
-	 * @returns {Promise}
+	 * @param sTargetPath The path to the deffered context
+	 * @param oNavigationParameters Navigation parameters
+	 * @returns A Promise
 	 * @ui5-restricted
 	 */
 	_bindDeferred(sTargetPath: string, oNavigationParameters: any) {
@@ -423,10 +419,10 @@ class InternalRouting extends ControllerExtension {
 	/**
 	 * Sets the binding context of the page from a path.
 	 *
-	 * @param {string} sTargetPath The path to the context
-	 * @param {sap.ui.model.odata.v4.ODataModel} oModel The OData model
-	 * @param {object} oNavigationParameters Navigation parameters
-	 * @returns {Promise}
+	 * @param sTargetPath The path to the context
+	 * @param oModel The OData model
+	 * @param oNavigationParameters Navigation parameters
+	 * @returns A Promise resolved once the binding has been set on the page
 	 * @ui5-restricted
 	 */
 	_bindPage(sTargetPath: string, oModel: any, oNavigationParameters: object) {
@@ -452,10 +448,10 @@ class InternalRouting extends ControllerExtension {
 	/**
 	 * Creates the filter to retrieve a context corresponding to a semantic path.
 	 *
-	 * @param {string} sSemanticPath The semantic path
-	 * @param {Array} aSemanticKeys The semantic keys for the path
-	 * @param {object} oMetaModel The instance of the meta model
-	 * @returns {sap.ui.model.Filter} The filter
+	 * @param sSemanticPath The semantic path
+	 * @param aSemanticKeys The semantic keys for the path
+	 * @param oMetaModel The instance of the meta model
+	 * @returns The filter
 	 * @ui5-restricted
 	 */
 	_createFilterFromSemanticPath(sSemanticPath: string, aSemanticKeys: any[], oMetaModel: object) {
@@ -529,17 +525,16 @@ class InternalRouting extends ControllerExtension {
 		});
 		aFilters.push(oDraftFilter);
 
-		const oCombinedFilter = new Filter(aFilters, true);
-		return oCombinedFilter;
+		return new Filter(aFilters, true);
 	}
 
 	/**
 	 * Converts a path with semantic keys to a path with technical keys.
 	 *
-	 * @param {string} sSemanticPath The path with semantic keys
-	 * @param {sap.ui.model.odata.v4.ODataModel} oModel The model for the path
-	 * @param {Array} aSemanticKeys The semantic keys for the path
-	 * @returns {Promise} A Promise containing the path with technical keys if sSemanticPath could be interpreted as a semantic path, null otherwise
+	 * @param sSemanticPath The path with semantic keys
+	 * @param oModel The model for the path
+	 * @param aSemanticKeys The semantic keys for the path
+	 * @returns A Promise containing the path with technical keys if sSemanticPath could be interpreted as a semantic path, null otherwise
 	 * @ui5-restricted
 	 */
 	_getTechnicalPathFromSemanticPath(sSemanticPath: string, oModel: any, aSemanticKeys: any[]) {
@@ -560,7 +555,7 @@ class InternalRouting extends ControllerExtension {
 
 		// Load the corresponding object
 		if (!sEntitySetPath?.startsWith("/")) {
-			sEntitySetPath = "/" + sEntitySetPath;
+			sEntitySetPath = `/${sEntitySetPath}`;
 		}
 		const oListBinding = oModel.bindList(sEntitySetPath, undefined, undefined, oFilter, {
 			"$$groupId": "$auto.Heroes"
@@ -579,9 +574,9 @@ class InternalRouting extends ControllerExtension {
 	/**
 	 * Checks if a path is eligible for semantic bookmarking.
 	 *
-	 * @param {string} sPath The path to test
-	 * @param {sap.ui.model.odata.v4.ODataMetaModel} oMetaModel The associated metadata model
-	 * @returns {boolean} `true` if the path is eligible
+	 * @param sPath The path to test
+	 * @param oMetaModel The associated metadata model
+	 * @returns `true` if the path is eligible
 	 * @ui5-restricted
 	 */
 	_checkPathForSemanticBookmarking(sPath: string, oMetaModel: any) {
@@ -591,19 +586,19 @@ class InternalRouting extends ControllerExtension {
 			return false;
 		}
 		// Get the entitySet name
-		const sEntitySetPath = "/" + aMatches[1];
+		const sEntitySetPath = `/${aMatches[1]}`;
 		// Check the entity set supports draft (otherwise we don't support semantic bookmarking)
-		const oDraftRoot = oMetaModel.getObject(sEntitySetPath + "@com.sap.vocabularies.Common.v1.DraftRoot");
-		const oDraftNode = oMetaModel.getObject(sEntitySetPath + "@com.sap.vocabularies.Common.v1.DraftNode");
+		const oDraftRoot = oMetaModel.getObject(`${sEntitySetPath}@com.sap.vocabularies.Common.v1.DraftRoot`);
+		const oDraftNode = oMetaModel.getObject(`${sEntitySetPath}@com.sap.vocabularies.Common.v1.DraftNode`);
 		return oDraftRoot || oDraftNode ? true : false;
 	}
 
 	/**
 	 * Builds a path with semantic keys from a path with technical keys.
 	 *
-	 * @param {string} sPathToResolve The path to be transformed
+	 * @param sPathToResolve The path to be transformed
 	 * @param oModel The OData model
-	 * @returns {Promise} String promise for the new path. If sPathToResolved couldn't be interpreted as a semantic path, it is returned as is.
+	 * @returns String promise for the new path. If sPathToResolved couldn't be interpreted as a semantic path, it is returned as is.
 	 * @ui5-restricted
 	 */
 	_resolveSemanticPath(sPathToResolve: string, oModel: any): Promise<string> {
@@ -648,9 +643,9 @@ class InternalRouting extends ControllerExtension {
 	/**
 	 * Sets the binding context of the page from a path.
 	 *
-	 * @param {string} sTargetPath The path to build the context. Needs to contain technical keys only.
-	 * @param {sap.ui.model.odata.v4.ODataModel} oModel The OData model
-	 * @param {object} oNavigationParameters Navigation parameters
+	 * @param sTargetPath The path to build the context. Needs to contain technical keys only.
+	 * @param oModel The OData model
+	 * @param oNavigationParameters Navigation parameters
 	 * @ui5-restricted
 	 */
 	_bindPageToPath(sTargetPath: string, oModel: any, oNavigationParameters: any) {
@@ -680,9 +675,9 @@ class InternalRouting extends ControllerExtension {
 	/**
 	 * Binds the page to a context.
 	 *
-	 * @param {sap.ui.model.odata.v4.Context} oContext Context to be bound
-	 * @param {sap.ui.model.odata.v4.ODataModel} oModel The OData model
-	 * @param {object} oNavigationParameters Navigation parameters
+	 * @param oContext Context to be bound
+	 * @param oModel The OData model
+	 * @param oNavigationParameters Navigation parameters
 	 * @ui5-restricted
 	 */
 	_bindPageToContext(oContext: any, oModel: any, oNavigationParameters: any) {
@@ -701,12 +696,16 @@ class InternalRouting extends ControllerExtension {
 					// if the parentBinding is not a listBinding or the transient one from the create, we create a new context
 					oContext = this._createContext(oContext.getPath(), oModel);
 				}
-				oContext.setKeepAlive(true, () => {
-					// it is possible that the context is no longer kept alive
-					if (oContext.isKeepAlive() && oRootViewController.isContextUsedInPages(oContext)) {
-						this.navigateBackFromContext(oContext);
-					}
-				});
+				oContext.setKeepAlive(
+					true,
+					() => {
+						// it is possible that the context is no longer kept alive
+						if (oContext.isKeepAlive() && oRootViewController.isContextUsedInPages(oContext)) {
+							this.navigateBackFromContext(oContext);
+						}
+					},
+					true
+				);
 			} else if (!oParentListBinding || oParentListBinding.isA("sap.ui.model.odata.v4.ODataListBinding")) {
 				// We need to recreate the context otherwise we get errors
 				oContext = this._createContext(oContext.getPath(), oModel, oNavigationParameters.bNavigateToSiblingEntity);
@@ -729,10 +728,10 @@ class InternalRouting extends ControllerExtension {
 	/**
 	 * Creates a context from a path.
 	 *
-	 * @param {string} sPath The path
-	 * @param {sap.ui.model.odata.v4.ODataModel} oModel The OData model
-	 * @param {boolean} navigateToSiblingEntity A parameter that tells whether to navigate to the context on data received
-	 * @returns {sap.ui.model.odata.v4.Context} The created context
+	 * @param sPath The path
+	 * @param oModel The OData model
+	 * @param navigateToSiblingEntity A parameter that determines whether to navigate to the context on data received
+	 * @returns The created context
 	 * @ui5-restricted
 	 */
 	@publicExtension()
@@ -740,7 +739,7 @@ class InternalRouting extends ControllerExtension {
 		const oPageComponent = this._oPageComponent,
 			sEntitySet = oPageComponent && oPageComponent.getEntitySet && oPageComponent.getEntitySet(),
 			sContextPath =
-				(oPageComponent && oPageComponent.getContextPath && oPageComponent.getContextPath()) || (sEntitySet && "/" + sEntitySet),
+				(oPageComponent && oPageComponent.getContextPath && oPageComponent.getContextPath()) || (sEntitySet && `/${sEntitySet}`),
 			oMetaModel = oModel.getMetaModel(),
 			mParameters: any = {
 				$$groupId: "$auto.Heroes",
@@ -748,21 +747,26 @@ class InternalRouting extends ControllerExtension {
 				$$patchWithoutSideEffects: true
 			};
 		// In case of draft: $select the state flags (HasActiveEntity, HasDraftEntity, and IsActiveEntity)
-		const oDraftRoot = oMetaModel.getObject(sContextPath + "@com.sap.vocabularies.Common.v1.DraftRoot");
-		const oDraftNode = oMetaModel.getObject(sContextPath + "@com.sap.vocabularies.Common.v1.DraftNode");
+		const oDraftRoot = oMetaModel.getObject(`${sContextPath}@com.sap.vocabularies.Common.v1.DraftRoot`);
+		const oDraftNode = oMetaModel.getObject(`${sContextPath}@com.sap.vocabularies.Common.v1.DraftNode`);
 		const oRootViewController = (this._oAppComponent as any).getRootViewController();
 		if (oRootViewController.isFclEnabled()) {
 			const oContext = oModel.getKeepAliveContext(sPath, false, mParameters);
 			if (oDraftRoot || oDraftNode) {
-				// when switching between draft and edit we need to ensure those properties are requested again even if they are in the binding's cache
-				// otherwise when you edit and go to the saved version you have no way of switching back to the edit version
-				oContext.requestSideEffects(["HasActiveEntity", "HasDraftEntity", "IsActiveEntity", "DraftAdministrativeData"]);
+				if (!oContext.getBinding().oCache) {
+					oContext.requestProperty(["HasActiveEntity", "HasDraftEntity", "IsActiveEntity"]);
+					oContext.requestObject("DraftAdministrativeData");
+				} else {
+					// when switching between draft and edit we need to ensure those properties are requested again even if they are in the binding's cache
+					// otherwise when you edit and go to the saved version you have no way of switching back to the edit version
+					oContext.requestSideEffects(["HasActiveEntity", "HasDraftEntity", "IsActiveEntity", "DraftAdministrativeData"]);
+				}
 			}
 
 			return oContext;
 		} else {
 			if (sEntitySet) {
-				const sMessagesPath = oMetaModel.getObject(sContextPath + "/@com.sap.vocabularies.Common.v1.Messages/$Path");
+				const sMessagesPath = oMetaModel.getObject(`${sContextPath}/@com.sap.vocabularies.Common.v1.Messages/$Path`);
 				if (sMessagesPath) {
 					mParameters.$select = sMessagesPath;
 				}
@@ -820,7 +824,7 @@ class InternalRouting extends ControllerExtension {
 					};
 				} else {
 					mParams = {
-						title: oResourceBundle.getText("SAPFE_ERROR"),
+						title: oResourceBundle.getText("C_COMMON_SAPFE_ERROR"),
 						description: sErrorDescription,
 						isDataReceivedError: true,
 						shellBack: true
@@ -841,7 +845,7 @@ class InternalRouting extends ControllerExtension {
 	 * therefore we get all dependent bindings (via private model method) to determine all paths and then
 	 * request them.
 	 *
-	 * @param {sap.ui.model.odata.v4.Context} oBindingContext Context to be refreshed
+	 * @param oBindingContext Context to be refreshed
 	 * @ui5-restricted
 	 */
 	_refreshBindingContext(oBindingContext: any) {
@@ -850,7 +854,7 @@ class InternalRouting extends ControllerExtension {
 		const sRootContextPath = oBindingContext.getPath();
 		const sEntitySet = oPageComponent && oPageComponent.getEntitySet && oPageComponent.getEntitySet();
 		const sContextPath =
-			(oPageComponent && oPageComponent.getContextPath && oPageComponent.getContextPath()) || (sEntitySet && "/" + sEntitySet);
+			(oPageComponent && oPageComponent.getContextPath && oPageComponent.getContextPath()) || (sEntitySet && `/${sEntitySet}`);
 		const oMetaModel = this._oView.getModel().getMetaModel();
 		let sMessagesPath;
 		const aNavigationPropertyPaths: any[] = [];
@@ -863,7 +867,7 @@ class InternalRouting extends ControllerExtension {
 		function getBindingPaths(oBinding: any) {
 			let aDependentBindings;
 			const sRelativePath = ((oBinding.getContext() && oBinding.getContext().getPath()) || "").replace(sRootContextPath, ""); // If no context, this is an absolute binding so no relative path
-			const sPath = (sRelativePath ? sRelativePath.slice(1) + "/" : sRelativePath) + oBinding.getPath();
+			const sPath = (sRelativePath ? `${sRelativePath.slice(1)}/` : sRelativePath) + oBinding.getPath();
 
 			if (oBinding.isA("sap.ui.model.odata.v4.ODataContextBinding")) {
 				// if (sPath === "") {
@@ -890,7 +894,7 @@ class InternalRouting extends ControllerExtension {
 		}
 
 		if (sContextPath) {
-			sMessagesPath = oMetaModel.getObject(sContextPath + "/@com.sap.vocabularies.Common.v1.Messages/$Path");
+			sMessagesPath = oMetaModel.getObject(`${sContextPath}/@com.sap.vocabularies.Common.v1.Messages/$Path`);
 		}
 
 		// binding of the context must have $$PatchWithoutSideEffects true, this bound context may be needed to be fetched from the dependent binding
@@ -914,7 +918,7 @@ class InternalRouting extends ControllerExtension {
 	/**
 	 * Gets the binding context of the page or the component.
 	 *
-	 * @returns {sap.ui.model.odata.v4.Context} The binding context
+	 * @returns The binding context
 	 * @ui5-restricted
 	 */
 	_getBindingContext(): Context {
@@ -928,7 +932,7 @@ class InternalRouting extends ControllerExtension {
 	/**
 	 * Sets the binding context of the page or the component.
 	 *
-	 * @param {sap.ui.model.odata.v4.Context} oContext The binding context
+	 * @param oContext The binding context
 	 * @ui5-restricted
 	 */
 	_setBindingContext(oContext: any) {
@@ -951,7 +955,7 @@ class InternalRouting extends ControllerExtension {
 	/**
 	 * Gets the flexible column layout (FCL) level corresponding to the view (-1 if the app is not FCL).
 	 *
-	 * @returns {number} The level
+	 * @returns The level
 	 * @ui5-restricted
 	 */
 	_getFCLLevel() {