@sapui5/sap.fe.core 1.97.0 → 1.100.0

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

@@ -1,8 +1,13 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 
-import { ServiceFactory, Service, ServiceContext } from "sap/ui/core/service";
-import { Container, CrossApplicationNavigation, ShellNavigation, URLParsing } from "sap/ushell/services";
-import { Component } from "sap/ui/core";
+import ServiceFactory from "sap/ui/core/service/ServiceFactory";
+import Service from "sap/ui/core/service/Service";
+import { ServiceContext } from "sap/ui/core/service";
+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 Component from "sap/ui/core/Component";
 
 /**
  * @interface IShellServices
@@ -10,16 +15,19 @@ import { Component } from "sap/ui/core";
  */
 export interface IShellServices {
 	initPromise: Promise<IShellServices>;
-
+	instanceType: string;
+	crossAppNavService?: CrossApplicationNavigation;
 	getLinks(oArgs: object): Promise<any>;
 
+	getLinksWithCache(oArgs: object): Promise<any[]>;
+
 	toExternal(oNavArgumentsArr: Array<object>, oComponent: object): void;
 
 	getStartupAppState(oArgs: object): Promise<any>;
 
 	backToPreviousApp(): void;
 
-	hrefForExternal(oArgs?: object, oComponent?: object, bAsync?: boolean): string;
+	hrefForExternal(oArgs?: object, oComponent?: object, bAsync?: boolean): string | Promise<string>;
 
 	getAppState(oComponent: Component, sAppStateKey: string): Promise<any>;
 
@@ -31,7 +39,7 @@ export interface IShellServices {
 
 	expandCompactHash(sHashFragment: string): object;
 
-	parseShellHash(sHash: string): object;
+	parseShellHash(sHash: string): any;
 
 	splitHash(sHash: string): object;
 
@@ -45,7 +53,7 @@ export interface IShellServices {
 
 	createRenderer(): object;
 
-	getUser(): object;
+	getUser(): any;
 
 	hasUShell(): boolean;
 
@@ -60,6 +68,8 @@ export interface IShellServices {
 	setTitle(sTitle: string): void;
 
 	getContentDensity(): string;
+
+	getPrimaryIntent(sSemanticObject: string, mParameters?: object): Promise<any>;
 }
 
 /**
@@ -187,6 +197,10 @@ class ShellServiceMock extends Service<ShellServicesSettings> implements IShellS
 			return "";
 		}
 	}
+
+	getPrimaryIntent(sSemanticObject: string, mParameters?: object): Promise<any> {
+		return Promise.resolve();
+	}
 }
 
 /**
@@ -311,7 +325,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 * sap.ushell.services.CrossApplicationNavigation=>getLinks arguments
 	 * @returns {Promise} Promise which will be resolved to target links array
 	 */
-	getLinksWithCache(oArgs: object) {
+	getLinksWithCache(oArgs: object): Promise<any[]> {
 		return new Promise((resolve, reject) => {
 			// eslint-disable-next-line promise/catch-or-return
 			if ((oArgs as Object[]).length === 0) {
@@ -414,7 +428,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 		return new Promise((resolve, reject) => {
 			// JQuery Promise behaves differently
 			// eslint-disable-next-line promise/catch-or-return
-			this.crossAppNavService
+			(this.crossAppNavService as any)
 				.getStartupAppState(oArgs)
 				.fail((oError: any) => {
 					reject(new Error(oError + " sap.fe.core.services.NavigationServiceFactory.getStartupAppState"));
@@ -460,7 +474,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 * @returns {Promise} Promise which will be resolved to object
 	 */
 	getAppState(oComponent: Component, sAppStateKey: string) {
-		return wrapJQueryPromise(this.crossAppNavService.getAppState(oComponent, sAppStateKey));
+		return wrapJQueryPromise((this.crossAppNavService as any).getAppState(oComponent, sAppStateKey));
 	}
 
 	/**
@@ -473,7 +487,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 * @returns {Promise} Promise which will be resolved to object
 	 */
 	createEmptyAppState(oComponent: Component) {
-		return this.crossAppNavService.createEmptyAppState(oComponent);
+		return (this.crossAppNavService as any).createEmptyAppState(oComponent);
 	}
 
 	/**
@@ -604,7 +618,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 * @returns {object} Returns User object
 	 */
 	getUser() {
-		return this.oShellContainer.getUser();
+		return (this.oShellContainer as any).getUser();
 	}
 
 	/**
@@ -627,7 +641,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 * @ui5-restricted
 	 */
 	registerNavigationFilter(fnNavFilter: Function) {
-		this.shellNavigation.registerNavigationFilter(fnNavFilter);
+		(this.shellNavigation as any).registerNavigationFilter(fnNavFilter);
 	}
 
 	/**
@@ -639,7 +653,7 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 * @ui5-restricted
 	 */
 	unregisterNavigationFilter(fnNavFilter: Function) {
-		this.shellNavigation.unregisterNavigationFilter(fnNavFilter);
+		(this.shellNavigation as any).unregisterNavigationFilter(fnNavFilter);
 	}
 
 	/**
@@ -687,7 +701,30 @@ class ShellServices extends Service<Required<ShellServicesSettings>> implements
 	 * @returns {string} The content density value
 	 */
 	getContentDensity(): string {
-		return (this.oShellContainer.getUser() as any).getContentDensity();
+		return ((this.oShellContainer as any).getUser() as any).getContentDensity();
+	}
+
+	/**
+	 * For a given semantic object, this method considers all actions associated with the semantic object and
+	 * returns the one tagged as a "primaryAction". If no inbound tagged as "primaryAction" exists, then it returns
+	 * the intent of the first inbound (after sorting has been applied) matching the action "displayFactSheet".
+	 *
+	 * @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.
+	 */
+	getPrimaryIntent(sSemanticObject: string, mParameters?: object): Promise<any> {
+		return new Promise((resolve, reject) => {
+			// eslint-disable-next-line promise/catch-or-return
+			this.crossAppNavService
+				.getPrimaryIntent(sSemanticObject, mParameters)
+				.fail((oError: any) => {
+					reject(new Error(oError + " sap.fe.core.services.NavigationServiceFactory.getPrimaryIntent"));
+				})
+				.then(resolve);
+		});
 	}
 }