@sapui5/sap.fe.navigation 1.124.2 → 1.126.0

package/src/sap/fe/navigation/NavigationHandler.ts

@@ -12,6 +12,8 @@ import V4ODataModel from "sap/ui/model/odata/v4/ODataModel";
 import URI from "sap/ui/thirdparty/URI";
 import jQuery from "sap/ui/thirdparty/jquery";
 import openWindow from "sap/ui/util/openWindow";
+import type Container from "sap/ushell/Container";
+import type Navigation from "sap/ushell/services/Navigation";
 import NavError from "./NavError";
 import type { SerializedSelectionVariant } from "./SelectionVariant";
 import SelectionVariant from "./SelectionVariant";
@@ -217,13 +219,15 @@ export class NavigationHandler extends BaseObject {
 	 * @returns The Navigation service
 	 * @private
 	 */
-	_getAppNavigationServiceAsync(): any {
-		return sap.ushell.Container.getServiceAsync("CrossApplicationNavigation")
-			.then(function (oCrossAppNavService: any) {
-				return oCrossAppNavService;
+	async _getAppNavigationServiceAsync(): Promise<Navigation> {
+		const ushellContainer: Container = sap.ui.require("sap/ushell/Container");
+		return ushellContainer
+			?.getServiceAsync("Navigation")
+			.then(function (oCrossAppNavService: object) {
+				return oCrossAppNavService as Navigation;
 			})
 			.catch(function () {
-				Log.error("NavigationHandler: CrossApplicationNavigation is not available.");
+				Log.error("NavigationHandler: Navigation is not available.");
 				throw new NavError("NavigationHandler.NO.XAPPSERVICE");
 			});
 	}
@@ -429,7 +433,7 @@ export class NavigationHandler extends BaseObject {
 			}
 
 			const fnNavExplace = function () {
-				const sNewHrefPromise = oCrossAppNavService.hrefForExternalAsync(oNavArguments, oNavHandler.oComponent);
+				const sNewHrefPromise = oCrossAppNavService.getHref(oNavArguments, oNavHandler.oComponent);
 				sNewHrefPromise
 					.then(function (sNewHref: any) {
 						openWindow(sNewHref);
@@ -454,7 +458,7 @@ export class NavigationHandler extends BaseObject {
 					if (sNavMode == "explace") {
 						fnNavExplace();
 					} else {
-						const ptoExt = oCrossAppNavService.toExternal(oNavArguments, oNavHandler.oComponent);
+						const ptoExt = oCrossAppNavService.navigate(oNavArguments, oNavHandler.oComponent);
 						// TODO: This is just a temporary solution to allow FE V2 to use toExternal promise.
 						if (oNavHandler._navigateCallback) {
 							oNavHandler._navigateCallback(ptoExt);
@@ -483,9 +487,12 @@ export class NavigationHandler extends BaseObject {
 		}
 		oNavHandler
 			._getAppNavigationServiceAsync()
-			.then(function (oCrossAppNavService: any) {
-				const oSupportedPromise = oCrossAppNavService.isNavigationSupported([oNavArguments], oNavHandler.oComponent);
-				oSupportedPromise.done(function (oTargets: any) {
+			.then(async function (oCrossAppNavService: Navigation) {
+				try {
+					const oTargets = await (oCrossAppNavService.isNavigationSupported(
+						[oNavArguments],
+						oNavHandler.oComponent
+					) as unknown as Promise<{ supported: boolean }[]>);
 					if (oTargets[0].supported) {
 						if (!bExPlace) {
 							fnStoreAndNavigate(oCrossAppNavService);
@@ -497,15 +504,14 @@ export class NavigationHandler extends BaseObject {
 						const oError = new NavError("NavigationHandler.isIntentSupported.notSupported");
 						fnOnError(oError);
 					}
-				});
-
-				if (fnOnError) {
-					oSupportedPromise.fail(function () {
+				} catch (oError) {
+					if (fnOnError) {
 						// technical error: could not determine if intent is supported
 						const oError = oNavHandler._createTechnicalError("NavigationHandler.isIntentSupported.failed");
 						fnOnError(oError);
-					});
+					}
 				}
+				return;
 			})
 			.catch(function (oError: any) {
 				if (fnOnError) {
@@ -666,60 +672,60 @@ export class NavigationHandler extends BaseObject {
 				// inner app state was not found in the AppHash, but xapp state => try to read the xapp state
 				this._getAppNavigationServiceAsync()
 					.then(function (oCrossAppNavService: any) {
-						const oStartupPromise = oCrossAppNavService.getStartupAppState(that.oComponent);
-						oStartupPromise.done(function (oAppState: any) {
-							// get app state from sap-xapp-state,
-							// create a copy, not only a reference, because we want to modify the object
-							let oAppStateData = oAppState.getData();
-							let oError;
-							if (oAppStateData) {
-								try {
-									oAppStateData = JSON.parse(JSON.stringify(oAppStateData));
-								} catch (x) {
-									oError = oNavHandler._createTechnicalError("NavigationHandler.AppStateData.parseError");
-									oMyDeferred.reject(oError, oStartupParameters, NavType.xAppState);
-									return oMyDeferred.promise();
-								}
+						return oCrossAppNavService.getStartupAppState(that.oComponent);
+					})
+					.catch(function () {
+						const oError = oNavHandler._createTechnicalError("NavigationHandler.getStartupState.failed");
+						oMyDeferred.reject(oError, {}, NavType.xAppState);
+					})
+					.then(function (oAppState: any) {
+						// get app state from sap-xapp-state,
+						// create a copy, not only a reference, because we want to modify the object
+						let oAppStateData = oAppState.getData();
+						let oError;
+						if (oAppStateData) {
+							try {
+								oAppStateData = JSON.parse(JSON.stringify(oAppStateData));
+							} catch (x) {
+								oError = oNavHandler._createTechnicalError("NavigationHandler.AppStateData.parseError");
+								oMyDeferred.reject(oError, oStartupParameters, NavType.xAppState);
+								return oMyDeferred.promise();
 							}
+						}
 
-							if (oAppStateData) {
-								const oSelVar = new SelectionVariant(oAppStateData.selectionVariant);
-
-								const oSelVars = oNavHandler._splitInboundNavigationParameters(
-									oSelVar,
-									oStartupParameters,
-									aDefaultedParameters
+						if (oAppStateData) {
+							const oSelVar = new SelectionVariant(oAppStateData.selectionVariant);
+
+							const oSelVars = oNavHandler._splitInboundNavigationParameters(
+								oSelVar,
+								oStartupParameters,
+								aDefaultedParameters
+							);
+							oAppStateData.selectionVariant = oSelVars.oNavigationSelVar.toJSONString();
+							oAppStateData.oSelectionVariant = oSelVars.oNavigationSelVar;
+							oAppStateData.oDefaultedSelectionVariant = oSelVars.oDefaultedSelVar;
+							oAppStateData.bNavSelVarHasDefaultsOnly = oSelVars.bNavSelVarHasDefaultsOnly;
+							const successHandlerHybridState = function (iAppStateData: object, _ref: object, navType: string): void {
+								oAppStateData.iAppState = iAppStateData;
+								oMyDeferred.resolve(oAppStateData, oStartupParameters, navType);
+							};
+							if (hybridIAppStateKeyParams !== undefined && iAppStateHybridDeferred !== undefined) {
+								iAppStateHybridDeferred.done(successHandlerHybridState);
+							} else if (oAppStateData[HYBRID_IAPP_STATE_KEY]) {
+								that._loadAppState(oAppStateData[HYBRID_IAPP_STATE_KEY], hybridDeferred, NavType.hybrid).done(
+									successHandlerHybridState
 								);
-								oAppStateData.selectionVariant = oSelVars.oNavigationSelVar.toJSONString();
-								oAppStateData.oSelectionVariant = oSelVars.oNavigationSelVar;
-								oAppStateData.oDefaultedSelectionVariant = oSelVars.oDefaultedSelVar;
-								oAppStateData.bNavSelVarHasDefaultsOnly = oSelVars.bNavSelVarHasDefaultsOnly;
-								const successHandlerHybridState = function (iAppStateData: object, _ref: object, navType: string) {
-									oAppStateData.iAppState = iAppStateData;
-									oMyDeferred.resolve(oAppStateData, oStartupParameters, navType);
-								};
-								if (hybridIAppStateKeyParams !== undefined && iAppStateHybridDeferred !== undefined) {
-									iAppStateHybridDeferred.done(successHandlerHybridState);
-								} else if (oAppStateData[HYBRID_IAPP_STATE_KEY]) {
-									that._loadAppState(oAppStateData[HYBRID_IAPP_STATE_KEY], hybridDeferred, NavType.hybrid).done(
-										successHandlerHybridState
-									);
-								} else {
-									oMyDeferred.resolve(oAppStateData, oStartupParameters, NavType.xAppState);
-								}
-							} else if (oStartupParameters) {
-								parseUrlParams(oStartupParameters, aDefaultedParameters, oMyDeferred, NavType.xAppState);
 							} else {
-								// sap-xapp-state navigation, but ID has already expired, but URL parameters available
-								oError = oNavHandler._createTechnicalError("NavigationHandler.getDataFromAppState.failed");
-								oMyDeferred.reject(oError, oStartupParameters || {}, NavType.xAppState);
+								oMyDeferred.resolve(oAppStateData, oStartupParameters, NavType.xAppState);
 							}
-						});
-						oStartupPromise.fail(function () {
-							const oError = oNavHandler._createTechnicalError("NavigationHandler.getStartupState.failed");
-							oMyDeferred.reject(oError, {}, NavType.xAppState);
-						});
-						return oStartupPromise;
+						} else if (oStartupParameters) {
+							parseUrlParams(oStartupParameters, aDefaultedParameters, oMyDeferred, NavType.xAppState);
+						} else {
+							// sap-xapp-state navigation, but ID has already expired, but URL parameters available
+							oError = oNavHandler._createTechnicalError("NavigationHandler.getDataFromAppState.failed");
+							oMyDeferred.reject(oError, oStartupParameters || {}, NavType.xAppState);
+						}
+						return;
 					})
 					.catch(function () {
 						const oError = oNavHandler._createTechnicalError("NavigationHandler._getAppNavigationServiceAsync.failed");
@@ -1415,8 +1421,8 @@ export class NavigationHandler extends BaseObject {
 			presentationVariant?: object;
 			valueTexts?: object;
 		}
-	): JQuery.Promise<any, any, any> {
-		const oMyDeferred = jQuery.Deferred();
+	): JQuery.Promise<unknown, unknown, unknown> {
+		const oMyDeferred = jQuery.Deferred() as JQuery.Deferred<unknown, unknown, unknown>;
 		let mSemanticAttributes: any;
 		if (oTableEventParameters != undefined) {
 			mSemanticAttributes = oTableEventParameters.semanticAttributes;
@@ -1536,7 +1542,8 @@ export class NavigationHandler extends BaseObject {
 	 * @private
 	 * @ui5-restricted
 	 */
-	_getAppStateKeyAndUrlParameters(sSelectionVariant: string) {
+	// eslint-disable-next-line @typescript-eslint/promise-function-async
+	_getAppStateKeyAndUrlParameters(sSelectionVariant: string): JQuery.Promise<unknown, unknown, unknown> {
 		return this.processBeforeSmartLinkPopoverOpens(undefined, sSelectionVariant, undefined, undefined);
 	}
 
@@ -1550,7 +1557,7 @@ export class NavigationHandler extends BaseObject {
 	async _getAppSpecificHash(appHash: string): Promise<string | undefined> {
 		try {
 			const crossAppService = await this._getAppNavigationServiceAsync();
-			return crossAppService.hrefForAppSpecificHashAsync(appHash);
+			return await crossAppService.getHref({ appSpecificRoute: appHash });
 		} catch (error: unknown) {
 			const message = error instanceof Error ? error.message : String(error);
 			Log.error(`FE : Can not fetch App sepcific URL : ${message}`);
@@ -1840,7 +1847,7 @@ export class NavigationHandler extends BaseObject {
 		const oNavHandler = this;
 		return this._getAppNavigationServiceAsync()
 			.then(function (oCrossAppNavService: any) {
-				return oCrossAppNavService.createEmptyAppStateAsync(oNavHandler.oComponent);
+				return oCrossAppNavService.createEmptyAppState(oNavHandler.oComponent);
 			})
 			.then(function (oAppState: any) {
 				return oNavHandler._fnSaveAppStateWithImmediateReturn(oAppData, oAppState, fnOnError);
@@ -1871,77 +1878,77 @@ export class NavigationHandler extends BaseObject {
 		const oNavHandler = this;
 		this._getAppNavigationServiceAsync()
 			.then(function (oCrossAppNavService: any) {
-				const oAppStatePromise = oCrossAppNavService.getAppState(oNavHandler.oComponent, sAppStateKey);
-				oAppStatePromise.done(function (oAppState: any) {
-					let oAppData: any = {};
-					const oAppDataLoaded = oAppState.getData();
-
-					if (typeof oAppDataLoaded === "undefined") {
-						const oError = oNavHandler._createTechnicalError("NavigationHandler.getDataFromAppState.failed");
-						oDeferred.reject(oError, {}, navType);
-					} else if (oNavHandler._sMode === Mode.ODataV2) {
-						oAppData = {
-							selectionVariant: "{}",
-							oSelectionVariant: new SelectionVariant(),
-							oDefaultedSelectionVariant: new SelectionVariant(),
-							bNavSelVarHasDefaultsOnly: false,
-							tableVariantId: "",
-							customData: {},
-							appStateKey: sAppStateKey,
-							presentationVariant: {},
-							valueTexts: {},
-							semanticDates: {},
-							data: {}
-						};
-						if (oAppDataLoaded.selectionVariant) {
-							/*
-							 * In case that we get an object from the stored AppData (=persistency), we need to stringify the JSON object.
-							 */
-							oAppData.selectionVariant = oNavHandler._ensureSelectionVariantFormatString(oAppDataLoaded.selectionVariant);
-							oAppData.oSelectionVariant = new SelectionVariant(oAppData.selectionVariant);
-						}
-						if (oAppDataLoaded.tableVariantId) {
-							oAppData.tableVariantId = oAppDataLoaded.tableVariantId;
-						}
-						if (oAppDataLoaded.customData) {
-							oAppData.customData = oAppDataLoaded.customData;
-						}
-						if (oAppDataLoaded.presentationVariant) {
-							oAppData.presentationVariant = oAppDataLoaded.presentationVariant;
-						}
-						if (oAppDataLoaded.valueTexts) {
-							oAppData.valueTexts = oAppDataLoaded.valueTexts;
-						}
-						if (oAppDataLoaded.semanticDates) {
-							oAppData.semanticDates = oAppDataLoaded.semanticDates;
-						}
-						/* In V2 case, we need the data in the below format for hybrid case */
-						if (navType === NavType.hybrid) {
-							oAppData.data = oAppDataLoaded;
-						}
-					} else {
-						oAppData = merge(oAppData, oAppDataLoaded);
-						if (oAppDataLoaded.selectionVariant) {
-							/*
-							 * In case that we get an object from the stored AppData (=persistency), we need to stringify the JSON object.
-							 */
-							oAppData.selectionVariant = oNavHandler._ensureSelectionVariantFormatString(oAppDataLoaded.selectionVariant);
-							oAppData.oSelectionVariant = new SelectionVariant(oAppData.selectionVariant);
-						}
-					}
+				return oCrossAppNavService.getAppState(oNavHandler.oComponent, sAppStateKey);
+			})
+			.catch(function () {
+				const oError = oNavHandler._createTechnicalError("NavigationHandler._getAppNavigationServiceAsync.failed");
+				oDeferred.reject(oError, {}, navType);
+			})
+			.then(function (oAppState: any) {
+				let oAppData: any = {};
+				const oAppDataLoaded = oAppState.getData();
 
-					// resolve is called on passed Deferred object to trigger a call of the done method, if implemented
-					// the done method will receive the loaded appState and the navigation type as parameters
-					oDeferred.resolve(oAppData, {}, navType);
-				});
-				oAppStatePromise.fail(function () {
-					const oError = oNavHandler._createTechnicalError("NavigationHandler.getAppState.failed");
+				if (typeof oAppDataLoaded === "undefined") {
+					const oError = oNavHandler._createTechnicalError("NavigationHandler.getDataFromAppState.failed");
 					oDeferred.reject(oError, {}, navType);
-				});
-				return oAppStatePromise;
+				} else if (oNavHandler._sMode === Mode.ODataV2) {
+					oAppData = {
+						selectionVariant: "{}",
+						oSelectionVariant: new SelectionVariant(),
+						oDefaultedSelectionVariant: new SelectionVariant(),
+						bNavSelVarHasDefaultsOnly: false,
+						tableVariantId: "",
+						customData: {},
+						appStateKey: sAppStateKey,
+						presentationVariant: {},
+						valueTexts: {},
+						semanticDates: {},
+						data: {}
+					};
+					if (oAppDataLoaded.selectionVariant) {
+						/*
+						 * In case that we get an object from the stored AppData (=persistency), we need to stringify the JSON object.
+						 */
+						oAppData.selectionVariant = oNavHandler._ensureSelectionVariantFormatString(oAppDataLoaded.selectionVariant);
+						oAppData.oSelectionVariant = new SelectionVariant(oAppData.selectionVariant);
+					}
+					if (oAppDataLoaded.tableVariantId) {
+						oAppData.tableVariantId = oAppDataLoaded.tableVariantId;
+					}
+					if (oAppDataLoaded.customData) {
+						oAppData.customData = oAppDataLoaded.customData;
+					}
+					if (oAppDataLoaded.presentationVariant) {
+						oAppData.presentationVariant = oAppDataLoaded.presentationVariant;
+					}
+					if (oAppDataLoaded.valueTexts) {
+						oAppData.valueTexts = oAppDataLoaded.valueTexts;
+					}
+					if (oAppDataLoaded.semanticDates) {
+						oAppData.semanticDates = oAppDataLoaded.semanticDates;
+					}
+					/* In V2 case, we need the data in the below format for hybrid case */
+					if (navType === NavType.hybrid) {
+						oAppData.data = oAppDataLoaded;
+					}
+				} else {
+					oAppData = merge(oAppData, oAppDataLoaded);
+					if (oAppDataLoaded.selectionVariant) {
+						/*
+						 * In case that we get an object from the stored AppData (=persistency), we need to stringify the JSON object.
+						 */
+						oAppData.selectionVariant = oNavHandler._ensureSelectionVariantFormatString(oAppDataLoaded.selectionVariant);
+						oAppData.oSelectionVariant = new SelectionVariant(oAppData.selectionVariant);
+					}
+				}
+
+				// resolve is called on passed Deferred object to trigger a call of the done method, if implemented
+				// the done method will receive the loaded appState and the navigation type as parameters
+				oDeferred.resolve(oAppData, {}, navType);
+				return;
 			})
 			.catch(function () {
-				const oError = oNavHandler._createTechnicalError("NavigationHandler._getAppNavigationServiceAsync.failed");
+				const oError = oNavHandler._createTechnicalError("NavigationHandler.getAppState.failed");
 				oDeferred.reject(oError, {}, navType);
 			});
 

package/src/sap/fe/navigation/library.js

@@ -93,7 +93,7 @@ sap.ui.define(["sap/ui/core/Lib", "sap/ui/core/library"], function (Library, _li
   const thisLib = Library.init({
     name: "sap.fe.navigation",
     // eslint-disable-next-line no-template-curly-in-string
-    version: "1.124.2",
+    version: "1.126.0",
     dependencies: ["sap.ui.core"],
     types: ["sap.fe.navigation.NavType", "sap.fe.navigation.ParamHandlingMode", "sap.fe.navigation.SuppressionBehavior"],
     interfaces: [],