@sapui5/sap.fe.navigation 1.103.0 → 1.106.0

package/package.json

@@ -1,13 +1,13 @@
 {
 	"name": "@sapui5/sap.fe.navigation",
-	"version": "1.103.0",
+	"version": "1.106.0",
 	"description": "SAPUI5 Library sap.fe.navigation",
 	"license": "SEE LICENSE IN LICENSE.txt",
 	"author": "SAP SE (https://www.sap.com)",
 	"homepage": "https://sap.github.io/ui5-tooling/pages/SAPUI5/",
 	"scripts": {
 		"build": "echo 'nothing to do'",
-		"prepare-npm-sources": "babel target/npm-sources/src --out-dir target/npm-sources/src --extensions \".ts\" --config-file ../../.babelrc",
+		"prepare-npm-sources": "echo 'nothing to do'",
 		"prepare-ts-class-doc": "echo 'nothing to do'",
 		"prepare-ui5-build-sources": "echo 'nothing to do'",
 		"test": "echo 'nothing to do'"
@@ -18,7 +18,6 @@
 	],
 	"devDependencies": {
 		"@babel/cli": "^7.14.8",
-		"@ui5/cli": "^2.14.0",
-		"mkdirp": "^1.0.4"
+		"@ui5/cli": "^2.14.0"
 	}
 }

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

@@ -6,7 +6,7 @@
     <copyright>SAP UI development toolkit for HTML5 (SAPUI5)
         (c) Copyright 2009-2021 SAP SE. All rights reserved
     </copyright>
-    <version>1.103.0</version>
+    <version>1.106.0</version>
 
     <documentation>UI5 library: sap.fe.navigation</documentation>
 

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

@@ -76,14 +76,15 @@ sap.ui.define(
 		 *         <td>Indicates that the input parameter is invalid</td>
 		 *         </tr>
 		 *         </table>
-		 * @alias sap.fe.navigation.NavigationHandler
+		 * @name sap.fe.navigation.NavigationHandler
 		 */
-		return BaseObject.extend("sap.fe.navigation.NavigationHandler" /** @lends sap.fe.navigation.NavigationHandler */, {
+		return BaseObject.extend("sap.fe.navigation.NavigationHandler" /** @lends sap.fe.navigation.NavigationHandler.prototype */, {
 			metadata: {
 				publicMethods: [
 					"navigate",
 					"parseNavigation",
 					"storeInnerAppState",
+					"storeInnerAppStateAsync",
 					"storeInnerAppStateWithImmediateReturn",
 					"processBeforeSmartLinkPopoverOpens",
 					"processBeforeSemanticLinkPopoverOpens",
@@ -126,17 +127,6 @@ sap.ui.define(
 					throw new NavError("NavigationHandler.INVALID_INPUT");
 				}
 
-				try {
-					this.oCrossAppNavService = this._getAppNavigationService();
-					if (!this.oCrossAppNavService) {
-						Log.error("NavigationHandler: CrossApplicationNavigation is not available.");
-						throw new NavError("NavigationHandler.NO.XAPPSERVICE");
-					}
-				} catch (ex) {
-					Log.error("NavigationHandler: UShell service API for CrossApplicationNavigation is not available.");
-					// throw new NavError("NavigationHandler.NO.SHELL");
-				}
-
 				this.IAPP_STATE = "sap-iapp-state";
 				this.sDefaultedParamProp = "sap-ushell-defaultedParameterNames";
 				this.sSAPSystemProp = "sap-system";
@@ -196,6 +186,23 @@ sap.ui.define(
 				return sap.ushell.Container.getService("CrossApplicationNavigation");
 			},
 
+			/**
+			 * Retrieves the shell navigation service.
+			 *
+			 * @returns {object} The Navigation service
+			 * @private
+			 */
+			_getAppNavigationServiceAsync: function () {
+				return sap.ushell.Container.getServiceAsync("CrossApplicationNavigation")
+					.then(function (oCrossAppNavService) {
+						return oCrossAppNavService;
+					})
+					.catch(function () {
+						Log.error("NavigationHandler: CrossApplicationNavigation is not available.");
+						throw new NavError("NavigationHandler.NO.XAPPSERVICE");
+					});
+			},
+
 			/**
 			 * Retrieves the reference to the router object for navigation for this given Controller.
 			 *
@@ -387,31 +394,26 @@ sap.ui.define(
 					params: mParameters || {}
 				};
 
-				if (sNavMode) {
-					oNavArguments.params["sap-ushell-navmode"] = bExPlace ? "explace" : "inplace";
-				}
-
-				var oSupportedPromise = oNavHandler.oCrossAppNavService.isNavigationSupported([oNavArguments], oNavHandler.oComponent);
-				oSupportedPromise.done(function (oTargets) {
-					if (oTargets[0].supported) {
-						var oReturn;
-
-						if (!bExPlace) {
-							oReturn = oNavHandler.storeInnerAppStateWithImmediateReturn(oInnerAppData, true);
-							if (oReturn && oReturn.appStateKey) {
-								oNavHandler.replaceHash(oReturn.appStateKey);
-							}
-						}
-
-						if (!oXAppDataObj.selectionVariant) {
-							oXAppDataObj.selectionVariant = sSelectionVariant;
-						}
+				var fnNavigate = function (oCrossAppNavService) {
+					if (!oXAppDataObj.selectionVariant) {
+						oXAppDataObj.selectionVariant = sSelectionVariant;
+					}
 
-						oXAppDataObj = oNavHandler._removeMeasureBasedInformation(oXAppDataObj);
+					var fnNavExplace = function () {
+						var sNewHrefPromise = oCrossAppNavService.hrefForExternalAsync(oNavArguments, oNavHandler.oComponent);
+						sNewHrefPromise
+							.then(function (sNewHref) {
+								openWindow(sNewHref);
+							})
+							.catch(function (oError) {
+								Log.error("Error while retireving hrefForExternal : " + oError);
+							});
+					};
 
-						oReturn = oNavHandler._saveAppStateWithImmediateReturn(oXAppDataObj, fnOnError);
-						if (oReturn) {
-							oNavArguments.appStateKey = oReturn.appStateKey;
+					oXAppDataObj = oNavHandler._removeMeasureBasedInformation(oXAppDataObj);
+					return oNavHandler._fnSaveAppStateAsync(oXAppDataObj, fnOnError).then(function (oSaveAppStateReturn) {
+						if (oSaveAppStateReturn) {
+							oNavArguments.appStateKey = oSaveAppStateReturn.appStateKey;
 
 							// Remark:
 							// The Cross App Service takes care of encoding parameter keys and values. Example:
@@ -421,39 +423,64 @@ sap.ui.define(
 							// toExternal sets sap-xapp-state in the URL if appStateKey is provided in oNavArguments
 							// toExternal has issues on sticky apps FIORITECHP1-14400, temp fix using hrefForExternal
 							if (sNavMode == "explace") {
-								var sNewHrefPromise = oNavHandler.oCrossAppNavService.hrefForExternalAsync(
-									oNavArguments,
-									oNavHandler.oComponent
-								);
-								sNewHrefPromise
-									.then(function (sNewHref) {
-										openWindow(sNewHref);
-									})
-									.catch(function (oError) {
-										Log.error("Error while retireving hrefForExternal : " + oError);
-									});
+								fnNavExplace();
 							} else {
-								var ptoExt = oNavHandler.oCrossAppNavService.toExternal(oNavArguments, oNavHandler.oComponent);
+								var ptoExt = oCrossAppNavService.toExternal(oNavArguments, oNavHandler.oComponent);
 								// TODO: This is just a temporary solution to allow FE V2 to use toExternal promise.
 								if (oNavHandler._navigateCallback) {
 									oNavHandler._navigateCallback(ptoExt);
 								}
 							}
 						} // else : error was already reported
-					} else if (fnOnError) {
-						// intent is not supported
-						var oError = new NavError("NavigationHandler.isIntentSupported.notSupported");
-						fnOnError(oError);
-					}
-				});
+					});
+				};
+				var fnStoreAndNavigate = function (oCrossAppNavService) {
+					oNavHandler
+						.storeInnerAppStateAsync(oInnerAppData, true)
+						.then(function (sAppStateKey) {
+							if (sAppStateKey) {
+								oNavHandler.replaceHash(sAppStateKey);
+							}
+							return fnNavigate(oCrossAppNavService);
+						})
+						.catch(function (oError) {
+							if (fnOnError) {
+								fnOnError(oError);
+							}
+						});
+				};
+				if (sNavMode) {
+					oNavArguments.params["sap-ushell-navmode"] = bExPlace ? "explace" : "inplace";
+				}
+				oNavHandler
+					._getAppNavigationServiceAsync()
+					.then(function (oCrossAppNavService) {
+						var oSupportedPromise = oCrossAppNavService.isNavigationSupported([oNavArguments], oNavHandler.oComponent);
+						oSupportedPromise.done(function (oTargets) {
+							if (oTargets[0].supported) {
+								if (!bExPlace) {
+									fnStoreAndNavigate(oCrossAppNavService);
+								} else {
+									fnNavigate(oCrossAppNavService);
+								}
+							} else if (fnOnError) {
+								// intent is not supported
+								var oError = new NavError("NavigationHandler.isIntentSupported.notSupported");
+								fnOnError(oError);
+							}
+						});
 
-				if (fnOnError) {
-					oSupportedPromise.fail(function () {
-						// technical error: could not determine if intent is supported
-						var oError = oNavHandler._createTechnicalError("NavigationHandler.isIntentSupported.failed");
+						if (fnOnError) {
+							oSupportedPromise.fail(function () {
+								// technical error: could not determine if intent is supported
+								var oError = oNavHandler._createTechnicalError("NavigationHandler.isIntentSupported.failed");
+								fnOnError(oError);
+							});
+						}
+					})
+					.catch(function (oError) {
 						fnOnError(oError);
 					});
-				}
 			},
 
 			/**
@@ -485,7 +512,7 @@ sap.ui.define(
 			 *          <li><code>oAppData.tableVariantId</code></li>
 			 *          <li><code>oAppData.customData</code></li>
 			 *          </ul>
-			 *          which return the inner app data as stored in {@link #.navigate navigate} or {@link #.storeInnerAppState storeInnerAppState}.
+			 *          which return the inner app data as stored in {@link #.navigate navigate} or {@link #.storeInnerAppStateAsync storeInnerAppStateAsync}.
 			 *          <code>oAppData.oDefaultedSelectionVariant</code> is an empty selection variant and
 			 *          <code>oAppData.bNavSelVarHasDefaultsOnly</code> is <code>false</code> in this case.<br>
 			 *          <b>Note:</b> If the navigation type is {@link sap.fe.navigation.NavType.initial} oAppData is an empty object!<br>
@@ -579,49 +606,56 @@ sap.ui.define(
 					// no back navigation
 					var bIsXappStateNavigation = oComponentData["sap-xapp-state"] !== undefined;
 					if (bIsXappStateNavigation) {
+						var that = this;
 						// inner app state was not found in the AppHash, but xapp state => try to read the xapp state
-						var oStartupPromise = this.oCrossAppNavService.getStartupAppState(this.oComponent);
-
-						oStartupPromise.done(function (oAppState) {
-							// get app state from sap-xapp-state,
-							// create a copy, not only a reference, because we want to modify the object
-							var oAppStateData = oAppState.getData();
-							var 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) {
-								var oSelVar = new SelectionVariant(oAppStateData.selectionVariant);
+						this._getAppNavigationServiceAsync()
+							.then(function (oCrossAppNavService) {
+								var oStartupPromise = oCrossAppNavService.getStartupAppState(that.oComponent);
+								oStartupPromise.done(function (oAppState) {
+									// get app state from sap-xapp-state,
+									// create a copy, not only a reference, because we want to modify the object
+									var oAppStateData = oAppState.getData();
+									var 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();
+										}
+									}
 
-								var oSelVars = oNavHandler._splitInboundNavigationParameters(
-									oSelVar,
-									oStartupParameters,
-									aDefaultedParameters
-								);
-								oAppStateData.selectionVariant = oSelVars.oNavigationSelVar.toJSONString();
-								oAppStateData.oSelectionVariant = oSelVars.oNavigationSelVar;
-								oAppStateData.oDefaultedSelectionVariant = oSelVars.oDefaultedSelVar;
-								oAppStateData.bNavSelVarHasDefaultsOnly = oSelVars.bNavSelVarHasDefaultsOnly;
-								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);
-							}
-						});
-						oStartupPromise.fail(function () {
-							var oError = oNavHandler._createTechnicalError("NavigationHandler.getStartupState.failed");
-							oMyDeferred.reject(oError, {}, NavType.xAppState);
-						});
+									if (oAppStateData) {
+										var oSelVar = new SelectionVariant(oAppStateData.selectionVariant);
+
+										var oSelVars = oNavHandler._splitInboundNavigationParameters(
+											oSelVar,
+											oStartupParameters,
+											aDefaultedParameters
+										);
+										oAppStateData.selectionVariant = oSelVars.oNavigationSelVar.toJSONString();
+										oAppStateData.oSelectionVariant = oSelVars.oNavigationSelVar;
+										oAppStateData.oDefaultedSelectionVariant = oSelVars.oDefaultedSelVar;
+										oAppStateData.bNavSelVarHasDefaultsOnly = oSelVars.bNavSelVarHasDefaultsOnly;
+										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);
+									}
+								});
+								oStartupPromise.fail(function () {
+									var oError = oNavHandler._createTechnicalError("NavigationHandler.getStartupState.failed");
+									oMyDeferred.reject(oError, {}, NavType.xAppState);
+								});
+							})
+							.catch(function () {
+								var oError = oNavHandler._createTechnicalError("NavigationHandler._getAppNavigationServiceAsync.failed");
+								oMyDeferred.reject(oError, {}, NavType.xAppState);
+							});
 					} else if (oStartupParameters) {
 						// no sap-xapp-state
 						parseUrlParams(oStartupParameters, aDefaultedParameters, oMyDeferred, NavType.URLParams);
@@ -894,6 +928,126 @@ sap.ui.define(
 				oHashChanger.replaceHash(sAppHashNew);
 			},
 
+			/**
+			 * Changes the URL according to the current app state and stores the app state for later retrieval.
+			 *
+			 * @param {object} mInnerAppData Object containing the current state of the app
+			 * @param {string} mInnerAppData.selectionVariant Stringified JSON object as returned, for example, from getDataSuiteFormat() of the
+			 *        SmartFilterBar control
+			 * @param {string} [mInnerAppData.tableVariantId] ID of the SmartTable variant
+			 * @param {object} [mInnerAppData.customData] Object that can be used to store additional app-specific data
+			 * @param {object} [mInnerAppData.presentationVariant] Object containing the current ui state of the app
+			 * @param {object} [mInnerAppData.valueTexts] Object containing value descriptions
+			 * @param {object} [mInnerAppData.semanticDates] Object containing semanticDates filter information
+			 * @param {boolean} [bImmediateHashReplace=true] If set to false, the inner app hash will not be replaced until storing is successful; do not
+			 *        set to false if you cannot react to the resolution of the Promise, for example, when calling the beforeLinkPressed event
+			 * @param {boolean} [bSkipHashReplace=false] If set to true, the inner app hash will not be replaced in the storeInnerAppStateAsync. Also the bImmediateHashReplace
+			 * 		  will be ignored.
+			 * @returns {object} A Promise object to monitor when all the actions of the function have been executed; if the execution is successful, the
+			 *          app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError} is
+			 *          returned
+			 * @public
+			 * @example <code>
+			 * sap.ui.define(["sap/fe/navigation/NavigationHandler"], function (NavigationHandler) {
+			 * 	var oNavigationHandler = new NavigationHandler(oController);
+			 * 	var mInnerAppData = {
+			 * 		selectionVariant : oSmartFilterBar.getDataSuiteFormat(),
+			 * 		tableVariantId : oSmartTable.getCurrentVariantId(),
+			 * 		customData : oMyCustomData
+			 * 	};
+			 *
+			 * 	var oStoreInnerAppStatePromise = oNavigationHandler.storeInnerAppStateAsync(mInnerAppData);
+			 *
+			 * 	oStoreInnerAppStatePromise.done(function(sAppStateKey){
+			 * 		//your inner app state is saved now, sAppStateKey was added to URL
+			 * 		//perform actions that must run after save
+			 * 	});
+			 *
+			 * 	oStoreInnerAppStatePromise.fail(function(oError){
+			 * 		//some error handling
+			 * 	});
+			 * });
+			 * </code>
+			 */
+			storeInnerAppStateAsync: function (mInnerAppData, bImmediateHashReplace, bSkipHashReplace) {
+				if (typeof bImmediateHashReplace !== "boolean") {
+					bImmediateHashReplace = true; // default
+				}
+				var oNavHandler = this;
+				var oMyDeferred = jQuery.Deferred();
+
+				var fnReplaceHash = function (sAppStateKey) {
+					var oHashChanger = oNavHandler.oRouter.oHashChanger ? oNavHandler.oRouter.oHashChanger : HashChanger.getInstance();
+					var sAppHashOld = oHashChanger.getHash();
+					/*
+					 * use .getHash() here instead of .getAppHash() to also be able dealing with environments where only SAPUI5 is loaded and the UShell
+					 * is not initialized properly.
+					 */
+					var sAppHashNew = oNavHandler._replaceInnerAppStateKey(sAppHashOld, sAppStateKey);
+					oHashChanger.replaceHash(sAppHashNew);
+				};
+
+				// in case mInnerAppState is empty, do not overwrite the last saved state
+				if (isEmptyObject(mInnerAppData)) {
+					oMyDeferred.resolve("");
+					return oMyDeferred.promise();
+				}
+
+				// check if we already saved the same data
+				var sAppStateKeyCached = this._oLastSavedInnerAppData.sAppStateKey;
+
+				var bInnerAppDataEqual = JSON.stringify(mInnerAppData) === JSON.stringify(this._oLastSavedInnerAppData.oAppData);
+				if (bInnerAppDataEqual && sAppStateKeyCached) {
+					// passed inner app state found in cache
+					this._oLastSavedInnerAppData.iCacheHit++;
+
+					// replace inner app hash with cached appStateKey in url (just in case the app has changed the hash in meantime)
+					fnReplaceHash(sAppStateKeyCached);
+					oMyDeferred.resolve(sAppStateKeyCached);
+					return oMyDeferred.promise();
+				}
+
+				// passed inner app state not found in cache
+				this._oLastSavedInnerAppData.iCacheMiss++;
+
+				var fnOnAfterSave = function (sAppStateKey) {
+					// replace inner app hash with new appStateKey in url
+					if (!bSkipHashReplace && !bImmediateHashReplace) {
+						fnReplaceHash(sAppStateKey);
+					}
+
+					// remember last saved state
+					oNavHandler._oLastSavedInnerAppData.oAppData = mInnerAppData;
+					oNavHandler._oLastSavedInnerAppData.sAppStateKey = sAppStateKey;
+					oMyDeferred.resolve(sAppStateKey);
+				};
+
+				var fnOnError = function (oError) {
+					oMyDeferred.reject(oError);
+				};
+
+				this._saveAppStateAsync(mInnerAppData, fnOnAfterSave, fnOnError)
+					.then(function (sAppStateKey) {
+						/* Note that _sapAppState may return 'undefined' in case that the parsing has failed. In this case, we should not trigger the replacement
+						 * of the App Hash with the generated key, as the container was not written before. Note as well that the error handling has already
+						 * happened before by making the oMyDeferred promise fail (see fnOnError above).
+						 */
+						if (sAppStateKey !== undefined) {
+							// replace inner app hash with new appStateKey in url
+							// note: we do not wait for the save to be completed: this asynchronously behaviour is necessary if
+							// this method is called e.g. in a onLinkPressed event with no possibility to wait for the promise resolution
+							if (!bSkipHashReplace && bImmediateHashReplace) {
+								fnReplaceHash(sAppStateKey);
+							}
+						}
+					})
+					.catch(function () {
+						Log.error("NavigationHandler._saveAppStateAsync failed");
+					});
+
+				return oMyDeferred.promise();
+			},
+
 			/**
 			 * Changes the URL according to the current app state and stores the app state for later retrieval.
 			 *
@@ -932,8 +1086,15 @@ sap.ui.define(
 			 * 	});
 			 * });
 			 * </code>
+			 * @deprecated as of version 1.104. Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync} instead.
 			 */
+
 			storeInnerAppState: function (mInnerAppData, bImmediateHashReplace) {
+				Log.error(
+					"Deprecated API call of 'sap.fe.navigation.NavigationHandler.storeInnerAppState'. Please use 'storeInnerAppStateAsync' instead",
+					null,
+					"sap.fe.navigation.NavigationHandler"
+				);
 				if (typeof bImmediateHashReplace !== "boolean") {
 					bImmediateHashReplace = true; // default
 				}
@@ -1052,8 +1213,14 @@ sap.ui.define(
 			 * });
 			 * </code>
 			 * @public
+			 * @deprecated as of version 1.104. Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync} instead.
 			 */
 			storeInnerAppStateWithImmediateReturn: function (mInnerAppData, bImmediateHashReplace) {
+				Log.error(
+					"Deprecated API call of 'sap.fe.navigation.NavigationHandler.storeInnerAppStateWithImmediateReturn'. Please use 'storeInnerAppStateAsync' instead",
+					null,
+					"sap.fe.navigation.NavigationHandler"
+				);
 				if (typeof bImmediateHashReplace !== "boolean") {
 					bImmediateHashReplace = false; // default
 				}
@@ -1260,11 +1427,11 @@ sap.ui.define(
 
 					oXAppDataObj = oNavHandler._removeMeasureBasedInformation(oXAppDataObj);
 
-					oNavHandler._saveAppState(oXAppDataObj, fnOnContainerSave, fnOnError);
+					oNavHandler._saveAppStateAsync(oXAppDataObj, fnOnContainerSave, fnOnError);
 				};
 
 				if (mInnerAppData) {
-					var oStoreInnerAppStatePromise = this.storeInnerAppState(mInnerAppData, true);
+					var oStoreInnerAppStatePromise = this.storeInnerAppStateAsync(mInnerAppData, true);
 
 					// if the inner app state was successfully stored, store also the xapp-state
 					oStoreInnerAppStatePromise.done(function () {
@@ -1477,32 +1644,56 @@ sap.ui.define(
 
 				return vConvertedSelectionVariant;
 			},
+			_fnHandleAppStatePromise: function (oReturn, fnOnAfterSave, fnOnError) {
+				oReturn.promise.done(function () {
+					if (fnOnAfterSave) {
+						fnOnAfterSave(oReturn.appStateKey);
+					}
+				});
 
+				if (fnOnError) {
+					var oNavHandler = this;
+					oReturn.promise.fail(function () {
+						var oError = oNavHandler._createTechnicalError("NavigationHandler.AppStateSave.failed");
+						fnOnError(oError);
+					});
+				}
+			},
+			_saveAppStateAsync: function (oAppData, fnOnAfterSave, fnOnError) {
+				var oNavHandler = this;
+				return this._fnSaveAppStateAsync(oAppData, fnOnError).then(function (oReturn) {
+					if (oReturn) {
+						oNavHandler._fnHandleAppStatePromise(oReturn, fnOnAfterSave, fnOnError);
+						return oReturn.appStateKey;
+					}
+
+					return undefined;
+				});
+			},
 			_saveAppState: function (oAppData, fnOnAfterSave, fnOnError) {
 				var oReturn = this._saveAppStateWithImmediateReturn(oAppData, fnOnError);
 				if (oReturn) {
-					oReturn.promise.done(function () {
-						if (fnOnAfterSave) {
-							fnOnAfterSave(oReturn.appStateKey);
-						}
-					});
-
-					if (fnOnError) {
-						var oNavHandler = this;
-						oReturn.promise.fail(function () {
-							var oError = oNavHandler._createTechnicalError("NavigationHandler.AppStateSave.failed");
-							fnOnError(oError);
-						});
-					}
+					this._fnHandleAppStatePromise(oReturn, fnOnAfterSave, fnOnError);
 					return oReturn.appStateKey;
 				}
 
 				return undefined;
 			},
-
-			_saveAppStateWithImmediateReturn: function (oAppData, fnOnError) {
-				var oAppState = this.oCrossAppNavService.createEmptyAppState(this.oComponent);
+			_fnSaveAppStateWithImmediateReturn: function (oAppData, oAppState, fnOnError) {
 				var sAppStateKey = oAppState.getKey();
+				var oAppDataForSave = this._fetchAppDataForSave(oAppData, fnOnError);
+				if (!oAppDataForSave) {
+					return undefined;
+				}
+				oAppState.setData(oAppDataForSave);
+				var oSavePromise = oAppState.save();
+
+				return {
+					appStateKey: sAppStateKey,
+					promise: oSavePromise.promise()
+				};
+			},
+			_fetchAppDataForSave: function (oAppData, fnOnError) {
 				var oAppDataForSave = {};
 
 				if (oAppData.hasOwnProperty("selectionVariant")) {
@@ -1557,80 +1748,103 @@ sap.ui.define(
 					oAppDataForSave = merge(oAppDataClone, oAppDataForSave);
 				}
 				oAppDataForSave = this._checkIsPotentiallySensitive(oAppDataForSave);
-				oAppState.setData(oAppDataForSave);
-				var oSavePromise = oAppState.save();
-
-				return {
-					appStateKey: sAppStateKey,
-					promise: oSavePromise.promise()
-				};
+				return oAppDataForSave;
+			},
+			_fnSaveAppStateAsync: function (oAppData, fnOnError) {
+				var oNavHandler = this;
+				return this._getAppNavigationServiceAsync()
+					.then(function (oCrossAppNavService) {
+						return oCrossAppNavService.createEmptyAppStateAsync(oNavHandler.oComponent);
+					})
+					.then(function (oAppState) {
+						return oNavHandler._fnSaveAppStateWithImmediateReturn(oAppData, oAppState, fnOnError);
+					})
+					.catch(function (oError) {
+						if (fnOnError) {
+							fnOnError(oError);
+						}
+					});
+			},
+			_saveAppStateWithImmediateReturn: function (oAppData, fnOnError) {
+				var oAppState = this._getAppNavigationService().createEmptyAppState(this.oComponent);
+				return this._fnSaveAppStateWithImmediateReturn(oAppData, oAppState, fnOnError);
 			},
 
 			_loadAppState: function (sAppStateKey, oDeferred) {
-				var oAppStatePromise = this.oCrossAppNavService.getAppState(this.oComponent, sAppStateKey);
 				var oNavHandler = this;
+				this._getAppNavigationServiceAsync()
+					.then(function (oCrossAppNavService) {
+						var oAppStatePromise = oCrossAppNavService.getAppState(oNavHandler.oComponent, sAppStateKey);
+						oAppStatePromise.done(function (oAppState) {
+							var oAppData = {};
+							var oAppDataLoaded = oAppState.getData();
+
+							if (typeof oAppDataLoaded === "undefined") {
+								var oError = oNavHandler._createTechnicalError("NavigationHandler.getDataFromAppState.failed");
+								oDeferred.reject(oError, {}, NavType.iAppState);
+							} else if (oNavHandler._sMode === Mode.ODataV2) {
+								oAppData = {
+									selectionVariant: "{}",
+									oSelectionVariant: new SelectionVariant(),
+									oDefaultedSelectionVariant: new SelectionVariant(),
+									bNavSelVarHasDefaultsOnly: false,
+									tableVariantId: "",
+									customData: {},
+									appStateKey: sAppStateKey,
+									presentationVariant: {},
+									valueTexts: {},
+									semanticDates: {}
+								};
+								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;
+								}
+							} 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);
+								}
+							}
 
-				oAppStatePromise.done(function (oAppState) {
-					var oAppData = {};
-					var oAppDataLoaded = oAppState.getData();
-
-					if (typeof oAppDataLoaded === "undefined") {
-						var oError = oNavHandler._createTechnicalError("NavigationHandler.getDataFromAppState.failed");
+							// 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.iAppState);
+						});
+						oAppStatePromise.fail(function () {
+							var oError = oNavHandler._createTechnicalError("NavigationHandler.getAppState.failed");
+							oDeferred.reject(oError, {}, NavType.iAppState);
+						});
+					})
+					.catch(function () {
+						var oError = oNavHandler._createTechnicalError("NavigationHandler._getAppNavigationServiceAsync.failed");
 						oDeferred.reject(oError, {}, NavType.iAppState);
-					} else if (oNavHandler._sMode === Mode.ODataV2) {
-						oAppData = {
-							selectionVariant: "{}",
-							oSelectionVariant: new SelectionVariant(),
-							oDefaultedSelectionVariant: new SelectionVariant(),
-							bNavSelVarHasDefaultsOnly: false,
-							tableVariantId: "",
-							customData: {},
-							appStateKey: sAppStateKey,
-							presentationVariant: {},
-							valueTexts: {},
-							semanticDates: {}
-						};
-						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;
-						}
-					} 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.iAppState);
-				});
-				oAppStatePromise.fail(function () {
-					var oError = oNavHandler._createTechnicalError("NavigationHandler.getAppState.failed");
-					oDeferred.reject(oError, {}, NavType.iAppState);
-				});
+					});
 			},
 
 			/**

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

@@ -19,7 +19,7 @@ sap.ui.define(
 		 * @class
 		 * @public
 		 * @since 1.83.0
-		 * @alias sap.fe.navigation.PresentationVariant
+		 * @name sap.fe.navigation.PresentationVariant
 		 * @param {string|object} [vPresentationVariant] If of type <code>string</code>, the selection variant is JSON-formatted;
 		 * if of type <code>object</code>, the object represents a selection variant
 		 * @throws An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are:
@@ -36,7 +36,7 @@ sap.ui.define(
 		 */
 		return BaseObject.extend(
 			"sap.fe.navigation.PresentationVariant",
-			/** @lends sap.fe.navigation.PresentationVariant */ {
+			/** @lends sap.fe.navigation.PresentationVariant.prototype */ {
 				constructor: function (vPresentationVariant) {
 					this._sId = "";
 

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

@@ -19,7 +19,7 @@ sap.ui.define(
 		 * @class
 		 * @public
 		 * @since 1.83.0
-		 * @alias sap.fe.navigation.SelectionVariant
+		 * @name sap.fe.navigation.SelectionVariant
 		 * @param {string|object} [vSelectionVariant] If of type <code>string</code>, the selection variant is JSON-formatted;
 		 * if of type <code>object</code>, the object represents a selection variant
 		 * @throws An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are:
@@ -36,7 +36,7 @@ sap.ui.define(
 		 */
 		return BaseObject.extend(
 			"sap.fe.navigation.SelectionVariant",
-			/** @lends sap.fe.navigation.SelectionVariant */
+			/** @lends sap.fe.navigation.SelectionVariant.prototype */
 			{
 				_rVALIDATE_SIGN: new RegExp("[E|I]"),
 				_rVALIDATE_OPTION: new RegExp("EQ|NE|LE|GE|LT|GT|BT|CP"),
@@ -307,8 +307,8 @@ sap.ui.define(
 				 * (ABAP-styled pattern matching with the asterisk as wildcard)
 				 * @param {string} sLow The single value or the lower boundary of the interval; the <code>null</code> value is not allowed
 				 * @param {string} [sHigh] Set only if sOption is <b>BT</b>: the upper boundary of the interval;
-				 * @param {string} [sText] Text representing the SelectOption. This is an optional parameter, consumption of this parameter is 
-				 * completely decided by the consumer. For an example in most Fiori applications fetch the Text based on the ID and doesn't 
+				 * @param {string} [sText] Text representing the SelectOption. This is an optional parameter, consumption of this parameter is
+				 * completely decided by the consumer. For an example in most Fiori applications fetch the Text based on the ID and doesn't
 				 * consider this text property
 				 * must be <code>undefined</code> or <code>null</code> in all other cases
 				 * @returns {object} This instance to allow method chaining.
@@ -324,7 +324,7 @@ sap.ui.define(
 				 * <tr><td>SelectionVariant.PARAMETER_SELOPT_COLLISION</td><td>Indicates that another parameter with the same name as the property name already exists</td></tr>
 				 * </table>
 				 */
-				addSelectOption: function(sPropertyName, sSign, sOption, sLow, sHigh, sText) {
+				addSelectOption: function (sPropertyName, sSign, sOption, sLow, sHigh, sText) {
 					/* {string} sLow The single value or the lower boundary of the interval; the <code>null</code> value is not allowed
 					 * (see specification "Selection Variants for UI Navigation in Fiori", section 2.4.2.1)
 					 */
@@ -378,7 +378,7 @@ sap.ui.define(
 					};
 
 					if (sText) {
-						// Add Text property only in case it is passed by the consumer of the API. 
+						// Add Text property only in case it is passed by the consumer of the API.
 						// Otherwise keep the structure as is.
 						oEntry.Text = sText;
 					}
@@ -730,6 +730,9 @@ sap.ui.define(
 				},
 
 				_parseFromObject: function (oInput) {
+					if (!oInput) {
+						oInput = {};
+					}
 					if (oInput.SelectionVariantID === undefined) {
 						// Do not throw an error, but only write a warning into the log.
 						// The SelectionVariantID is mandatory according to the specification document version 1.0,

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

@@ -26,7 +26,7 @@ sap.ui.define(
 		var thisLib = sap.ui.getCore().initLibrary({
 			name: "sap.fe.navigation",
 			// eslint-disable-next-line no-template-curly-in-string
-			version: "1.103.0",
+			version: "1.106.0",
 			dependencies: ["sap.ui.core"],
 			types: ["sap.fe.navigation.NavType", "sap.fe.navigation.ParamHandlingMode", "sap.fe.navigation.SuppressionBehavior"],
 			interfaces: [],