@sapui5/sap.fe.core 1.102.3 → 1.105.0

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

@@ -1,11 +1,11 @@
-import Component from "sap/ui/core/Component";
+import type Component from "sap/ui/core/Component";
 import Service from "sap/ui/core/service/Service";
 import ServiceFactory from "sap/ui/core/service/ServiceFactory";
-import Container from "sap/ushell/services/Container";
-import CrossApplicationNavigation from "sap/ushell/services/CrossApplicationNavigation";
-import ShellNavigation from "sap/ushell/services/ShellNavigation";
-import URLParsing from "sap/ushell/services/URLParsing";
-import { ServiceContext } from "types/extension_types";
+import type Container from "sap/ushell/services/Container";
+import type CrossApplicationNavigation from "sap/ushell/services/CrossApplicationNavigation";
+import type ShellNavigation from "sap/ushell/services/ShellNavigation";
+import type URLParsing from "sap/ushell/services/URLParsing";
+import type { ServiceContext } from "types/extension_types";
 
 /**
  * @interface IShellServices
@@ -33,6 +33,8 @@ export interface IShellServices {
 
 	createEmptyAppState(oComponent: Component): object;
 
+	createEmptyAppState(oComponent: Component): Promise<any>;
+
 	isNavigationSupported(oNavArgumentsArr: Array<object>, oComponent?: object): Promise<any>;
 
 	isInitialNavigation(): boolean;
@@ -98,7 +100,7 @@ class ShellServiceMock extends Service<ShellServicesSettings> implements IShellS
 	}
 
 	toExternal(/*oNavArgumentsArr: Array<object>, oComponent: object*/) {
-		return;
+		/* Do Nothing */
 	}
 
 	getStartupAppState(/*oArgs: object*/) {
@@ -106,14 +108,14 @@ class ShellServiceMock extends Service<ShellServicesSettings> implements IShellS
 	}
 
 	backToPreviousApp() {
-		return;
+		/* Do Nothing */
 	}
 
 	hrefForExternal(/*oArgs?: object, oComponent?: object, bAsync?: boolean*/) {
 		return "";
 	}
 
-	hrefForExternalAsync(oArgs?: object, oComponent?: object) {
+	hrefForExternalAsync(/*oArgs?: object, oComponent?: object*/) {
 		return Promise.resolve({});
 	}
 
@@ -125,6 +127,10 @@ class ShellServiceMock extends Service<ShellServicesSettings> implements IShellS
 		return Promise.resolve({});
 	}
 
+	createEmptyAppStateAsync(/*oComponent: object*/) {
+		return Promise.resolve({});
+	}
+
 	isNavigationSupported(/*oNavArgumentsArr: Array<object>, oComponent: object*/) {
 		return Promise.resolve({});
 	}
@@ -154,15 +160,15 @@ class ShellServiceMock extends Service<ShellServicesSettings> implements IShellS
 	}
 
 	setDirtyFlag(/*bDirty: boolean*/) {
-		return;
+		/* Do Nothing */
 	}
 
 	registerDirtyStateProvider(/*fnDirtyStateProvider: Function*/) {
-		return;
+		/* Do Nothing */
 	}
 
 	deregisterDirtyStateProvider(/*fnDirtyStateProvider: Function*/) {
-		return;
+		/* Do Nothing */
 	}
 
 	createRenderer() {
@@ -178,23 +184,23 @@ class ShellServiceMock extends Service<ShellServicesSettings> implements IShellS
 	}
 
 	registerNavigationFilter(/*fnNavFilter: Function*/): void {
-		return;
+		/* Do Nothing */
 	}
 
 	unregisterNavigationFilter(/*fnNavFilter: Function*/): void {
-		return;
+		/* Do Nothing */
 	}
 
 	setBackNavigation(/*fnCallBack?: Function*/): void {
-		return;
+		/* Do Nothing */
 	}
 
 	setHierarchy(/*aHierarchyLevels: Array<object>*/): void {
-		return;
+		/* Do Nothing */
 	}
 
 	setTitle(/*sTitle: string*/): void {
-		return;
+		/* Do Nothing */
 	}
 
 	getContentDensity(): string {
@@ -225,8 +231,8 @@ export type ShellServicesSettings = {
  * Wrap a JQuery Promise within a native {Promise}.
  *
  * @template {object} T
- * @param {jQuery.Promise<T>} jqueryPromise The original jquery promise
- * @returns {Promise<T>} A native promise wrapping the same object
+ * @param jqueryPromise The original jquery promise
+ * @returns A native promise wrapping the same object
  * @private
  */
 function wrapJQueryPromise<T>(jqueryPromise: jQuery.Promise): Promise<T> {
@@ -307,9 +313,9 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {object} oArgs Check the definition of
+	 * @param oArgs Check the definition of
 	 * sap.ushell.services.CrossApplicationNavigation=>getLinks arguments
-	 * @returns {Promise} Promise which will be resolved to target links array
+	 * @returns Promise which will be resolved to target links array
 	 */
 	getLinks(oArgs: object) {
 		return new Promise((resolve, reject) => {
@@ -317,7 +323,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 			this.crossAppNavService
 				.getLinks(oArgs)
 				.fail((oError: any) => {
-					reject(new Error(oError + " sap.fe.core.services.NavigationServiceFactory.getLinks"));
+					reject(new Error(`${oError} sap.fe.core.services.NavigationServiceFactory.getLinks`));
 				})
 				.then(resolve);
 		});
@@ -331,9 +337,9 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {object} oArgs Check the definition of
+	 * @param oArgs Check the definition of
 	 * sap.ushell.services.CrossApplicationNavigation=>getLinks arguments
-	 * @returns {Promise} Promise which will be resolved to target links array
+	 * @returns Promise which will be resolved to target links array
 	 */
 	getLinksWithCache(oArgs: object): Promise<any[]> {
 		return new Promise((resolve, reject) => {
@@ -350,7 +356,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 					this.crossAppNavService
 						.getLinks(oCacheResults.newArgs)
 						.fail((oError: any) => {
-							reject(new Error(oError + " sap.fe.core.services.NavigationServiceFactory.getLinksWithCache"));
+							reject(new Error(`${oError} sap.fe.core.services.NavigationServiceFactory.getLinksWithCache`));
 						})
 						.then((aLinks: any) => {
 							if (aLinks.length !== 0) {
@@ -401,7 +407,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 * @private
 	 * @ui5-restricted
 	 * sap.ushell.container
-	 * @returns {object} Object with predefined shellContainer methods
+	 * @returns Object with predefined shellContainer methods
 	 */
 	getShellContainer() {
 		return this.oShellContainer;
@@ -412,10 +418,9 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {Array} oNavArgumentsArr And
-	 * @param {object} oComponent Check the definition of
+	 * @param oNavArgumentsArr And
+	 * @param oComponent Check the definition of
 	 * sap.ushell.services.CrossApplicationNavigation=>toExternal arguments
-	 * @returns {void}
 	 */
 	toExternal(oNavArgumentsArr: Array<object>, oComponent: object): void {
 		this.crossAppNavService.toExternal(oNavArgumentsArr, oComponent);
@@ -429,9 +434,9 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {object} oArgs Check the definition of
+	 * @param oArgs Check the definition of
 	 * sap.ushell.services.CrossApplicationNavigation=>getStartupAppState arguments
-	 * @returns {Promise} Promise which will be resolved to Object
+	 * @returns Promise which will be resolved to Object
 	 */
 	getStartupAppState(oArgs: Component) {
 		return new Promise((resolve, reject) => {
@@ -440,7 +445,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 			(this.crossAppNavService as any)
 				.getStartupAppState(oArgs)
 				.fail((oError: any) => {
-					reject(new Error(oError + " sap.fe.core.services.NavigationServiceFactory.getStartupAppState"));
+					reject(new Error(`${oError} sap.fe.core.services.NavigationServiceFactory.getStartupAppState`));
 				})
 				.then(resolve);
 		});
@@ -449,7 +454,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	/**
 	 * Will call backToPreviousApp method of CrossApplicationNavigation service.
 	 *
-	 * @returns {void}
+	 * @returns Something that indicate we've navigated
 	 * @private
 	 * @ui5-restricted
 	 */
@@ -462,11 +467,11 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {object} oArgs Check the definition of
-	 * @param {object} oComponent The appComponent
-	 * @param {boolean} bAsync Whether this call should be async or not
+	 * @param oArgs Check the definition of
+	 * @param oComponent The appComponent
+	 * @param bAsync Whether this call should be async or not
 	 * sap.ushell.services.CrossApplicationNavigation=>hrefForExternal arguments
-	 * @returns {string} Promise which will be resolved to string
+	 * @returns Promise which will be resolved to string
 	 */
 	hrefForExternal(oArgs: object, oComponent?: object, bAsync?: boolean) {
 		return this.crossAppNavService.hrefForExternal(oArgs, oComponent as object, !!bAsync);
@@ -477,10 +482,10 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {object} oArgs Check the definition of
-	 * @param {object} oComponent The appComponent
+	 * @param oArgs Check the definition of
+	 * @param oComponent The appComponent
 	 * sap.ushell.services.CrossApplicationNavigation=>hrefForExternalAsync arguments
-	 * @returns {string} Promise which will be resolved to string
+	 * @returns Promise which will be resolved to string
 	 */
 	hrefForExternalAsync(oArgs: object, oComponent?: object) {
 		return this.crossAppNavService.hrefForExternalAsync(oArgs, oComponent as object);
@@ -491,10 +496,10 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {object} oComponent
-	 * @param {string} sAppStateKey Check the definition of
+	 * @param oComponent
+	 * @param sAppStateKey Check the definition of
 	 * sap.ushell.services.CrossApplicationNavigation=>getAppState arguments
-	 * @returns {Promise} Promise which will be resolved to object
+	 * @returns Promise which will be resolved to object
 	 */
 	getAppState(oComponent: Component, sAppStateKey: string) {
 		return wrapJQueryPromise((this.crossAppNavService as any).getAppState(oComponent, sAppStateKey));
@@ -505,23 +510,36 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {object} oComponent Check the definition of
+	 * @param oComponent Check the definition of
 	 * sap.ushell.services.CrossApplicationNavigation=>createEmptyAppState arguments
-	 * @returns {Promise} Promise which will be resolved to object
+	 * @returns Promise which will be resolved to object
 	 */
 	createEmptyAppState(oComponent: Component) {
 		return (this.crossAppNavService as any).createEmptyAppState(oComponent);
 	}
 
+	/**
+	 * Will call createEmptyAppStateAsync method of CrossApplicationNavigation service with oComponent.
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param oComponent Check the definition of
+	 * sap.ushell.services.CrossApplicationNavigation=>createEmptyAppStateAsync arguments
+	 * @returns Promise which will be resolved to object
+	 */
+	createEmptyAppStateAsync(oComponent: Component) {
+		return (this.crossAppNavService as any).createEmptyAppStateAsync(oComponent);
+	}
+
 	/**
 	 * Will call isNavigationSupported method of CrossApplicationNavigation service with Navigation Arguments and oComponent.
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {Array} oNavArgumentsArr
-	 * @param {object} oComponent Check the definition of
+	 * @param oNavArgumentsArr
+	 * @param oComponent Check the definition of
 	 * sap.ushell.services.CrossApplicationNavigation=>isNavigationSupported arguments
-	 * @returns {Promise} Promise which will be resolved to object
+	 * @returns Promise which will be resolved to object
 	 */
 	isNavigationSupported(oNavArgumentsArr: Array<object>, oComponent: object) {
 		return wrapJQueryPromise(this.crossAppNavService.isNavigationSupported(oNavArgumentsArr, oComponent));
@@ -532,7 +550,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @returns {Promise} Promise which will be resolved to boolean
+	 * @returns Promise which will be resolved to boolean
 	 */
 	isInitialNavigation() {
 		return this.crossAppNavService.isInitialNavigation();
@@ -543,7 +561,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @returns {Promise} Promise which will be resolved to boolean
+	 * @returns Promise which will be resolved to boolean
 	 */
 	isInitialNavigationAsync() {
 		return this.crossAppNavService.isInitialNavigationAsync();
@@ -552,8 +570,8 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	/**
 	 * Will call expandCompactHash method of CrossApplicationNavigation service.
 	 *
-	 * @param {string} sHashFragment An (internal format) shell hash
-	 * @returns {Promise} A promise the success handler of the resolve promise get an expanded shell hash as first argument
+	 * @param sHashFragment An (internal format) shell hash
+	 * @returns A promise the success handler of the resolve promise get an expanded shell hash as first argument
 	 * @private
 	 * @ui5-restricted
 	 */
@@ -566,9 +584,9 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {string} sHash Check the definition of
+	 * @param sHash Check the definition of
 	 * sap.ushell.services.URLParsing=>parseShellHash arguments
-	 * @returns {object}
+	 * @returns The parsed url
 	 */
 	parseShellHash(sHash: string) {
 		return this.urlParsingService.parseShellHash(sHash);
@@ -579,9 +597,9 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {string} sHash Check the definition of
+	 * @param sHash Check the definition of
 	 * sap.ushell.services.URLParsing=>splitHash arguments
-	 * @returns {Promise} Promise which will be resolved to object
+	 * @returns Promise which will be resolved to object
 	 */
 	splitHash(sHash: string) {
 		return this.urlParsingService.splitHash(sHash);
@@ -592,9 +610,9 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {object} oNewShellHash Check the definition of
+	 * @param oNewShellHash Check the definition of
 	 * sap.ushell.services.URLParsing=>constructShellHash arguments
-	 * @returns {string} Shell Hash string
+	 * @returns Shell Hash string
 	 */
 	constructShellHash(oNewShellHash: object) {
 		return this.urlParsingService.constructShellHash(oNewShellHash);
@@ -605,7 +623,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {boolean} bDirty Check the definition of sap.ushell.Container.setDirtyFlag arguments
+	 * @param bDirty Check the definition of sap.ushell.Container.setDirtyFlag arguments
 	 */
 	setDirtyFlag(bDirty: boolean) {
 		this.oShellContainer.setDirtyFlag(bDirty);
@@ -616,7 +634,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {Function} fnDirtyStateProvider Check the definition of sap.ushell.Container.registerDirtyStateProvider arguments
+	 * @param fnDirtyStateProvider Check the definition of sap.ushell.Container.registerDirtyStateProvider arguments
 	 */
 	registerDirtyStateProvider(fnDirtyStateProvider: Function) {
 		this.oShellContainer.registerDirtyStateProvider(fnDirtyStateProvider);
@@ -627,7 +645,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {Function} fnDirtyStateProvider Check the definition of sap.ushell.Container.deregisterDirtyStateProvider arguments
+	 * @param fnDirtyStateProvider Check the definition of sap.ushell.Container.deregisterDirtyStateProvider arguments
 	 */
 	deregisterDirtyStateProvider(fnDirtyStateProvider: Function) {
 		this.oShellContainer.deregisterDirtyStateProvider(fnDirtyStateProvider);
@@ -638,7 +656,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @returns {object} Returns renderer object
+	 * @returns Returns renderer object
 	 */
 	createRenderer() {
 		return this.oShellContainer.createRenderer();
@@ -649,7 +667,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @returns {object} Returns User object
+	 * @returns Returns User object
 	 */
 	getUser() {
 		return (this.oShellContainer as any).getUser();
@@ -660,7 +678,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @returns {boolean} Returns true
+	 * @returns Returns true
 	 */
 	hasUShell() {
 		return true;
@@ -669,8 +687,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	/**
 	 * Will call registerNavigationFilter method of shellNavigation.
 	 *
-	 * @param {Function} fnNavFilter The filter function to register
-	 * @returns {void}
+	 * @param fnNavFilter The filter function to register
 	 * @private
 	 * @ui5-restricted
 	 */
@@ -681,8 +698,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	/**
 	 * Will call unregisterNavigationFilter method of shellNavigation.
 	 *
-	 * @param {Function} fnNavFilter The filter function to unregister
-	 * @returns {void}
+	 * @param fnNavFilter The filter function to unregister
 	 * @private
 	 * @ui5-restricted
 	 */
@@ -694,8 +710,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 * Will call setBackNavigation method of ShellUIService
 	 * that displays the back button in the shell header.
 	 *
-	 * @param {Function} [fnCallBack] A callback function called when the button is clicked in the UI.
-	 * @returns {void}
+	 * @param [fnCallBack] A callback function called when the button is clicked in the UI.
 	 * @private
 	 * @ui5-restricted
 	 */
@@ -707,8 +722,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 * Will call setHierarchy method of ShellUIService
 	 * that displays the given hierarchy in the shell header.
 	 *
-	 * @param {object[]} [aHierarchyLevels] An array representing hierarchies of the currently displayed app.
-	 * @returns {void}
+	 * @param [aHierarchyLevels] An array representing hierarchies of the currently displayed app.
 	 * @private
 	 * @ui5-restricted
 	 */
@@ -720,8 +734,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 * Will call setTitle method of ShellUIService
 	 * that displays the given title in the shell header.
 	 *
-	 * @param {string} [sTitle] The new title. The default title is set if this argument is not given.
-	 * @returns {void}
+	 * @param [sTitle] The new title. The default title is set if this argument is not given.
 	 * @private
 	 * @ui5-restricted
 	 */
@@ -732,10 +745,10 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	/**
 	 * Retrieves the currently defined content density.
 	 *
-	 * @returns {string} The content density value
+	 * @returns The content density value
 	 */
 	getContentDensity(): string {
-		return ((this.oShellContainer as any).getUser() as any).getContentDensity();
+		return (this.oShellContainer as any).getUser().getContentDensity();
 	}
 
 	/**
@@ -745,9 +758,9 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {string} sSemanticObject Semantic object.
-	 * @param {object} mParameters See #CrossApplicationNavigation#getLinks for description.
-	 * @returns {Promise} Promise which will be resolved with an object containing the intent if it exists.
+	 * @param sSemanticObject Semantic object.
+	 * @param mParameters See #CrossApplicationNavigation#getLinks for description.
+	 * @returns Promise which will be resolved with an object containing the intent if it exists.
 	 */
 	getPrimaryIntent(sSemanticObject: string, mParameters?: object): Promise<any> {
 		return new Promise((resolve, reject) => {
@@ -755,7 +768,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 			this.crossAppNavService
 				.getPrimaryIntent(sSemanticObject, mParameters)
 				.fail((oError: any) => {
-					reject(new Error(oError + " sap.fe.core.services.NavigationServiceFactory.getPrimaryIntent"));
+					reject(new Error(`${oError} sap.fe.core.services.NavigationServiceFactory.getPrimaryIntent`));
 				})
 				.then(resolve);
 		});
@@ -771,8 +784,8 @@ class ShellServicesFactory extends ServiceFactory<ShellServicesSettings> {
 	/**
 	 * Creates either a standard or a mock Shell service depending on the configuration.
 	 *
-	 * @param {ServiceContext<ShellServicesSettings>} oServiceContext The shellservice context
-	 * @returns {Promise<IShellServices>} A promise for a shell service implementation
+	 * @param oServiceContext The shellservice context
+	 * @returns A promise for a shell service implementation
 	 * @see ServiceFactory#createInstance
 	 */
 	createInstance(oServiceContext: ServiceContext<ShellServicesSettings>): Promise<IShellServices> {