Add automatic switching to Portals Web API

Author: Cipriano Giuseppe

src/dynamics-web-api.ts

@@ -1703,8 +1703,6 @@ export interface Config {
     dataApi?: ApiConfig;
     /**Configuration object for Dataverse Search API (with path "search") */
     searchApi?: ApiConfig;
-    /**A flag that switches to the Dynamics Portals Web API. Official Docs: https://learn.microsoft.com/en-us/power-pages/configure/web-api-overview  */
-    portalsApi?: boolean | null;
 }
 
 export interface ProxyConfig {

src/utils/Config.ts

@@ -13,8 +13,8 @@ export interface InternalConfig extends Config {
     searchApi: InternalApiConfig;
 }
 
-const getApiUrl = (serverUrl: string | undefined | null, apiConfig: ApiConfig, portalsApi: boolean | undefined | null): string => {
-    if (portalsApi) {
+const getApiUrl = (serverUrl: string | undefined | null, apiConfig: ApiConfig): string => {
+    if (Utility.isRunningWithinPortals()) {
         return `${window.location.origin}/_api/`;
     } else {
         if (!serverUrl) serverUrl = Utility.getClientUrl();
@@ -35,7 +35,7 @@ const mergeApiConfigs = (apiConfig: ApiConfig | undefined, apiType: ApiType, int
         internalApiConfig.path = apiConfig.path;
     }
 
-    internalApiConfig.url = getApiUrl(internalConfig.serverUrl, internalApiConfig, internalConfig.portalsApi);
+    internalApiConfig.url = getApiUrl(internalConfig.serverUrl, internalApiConfig);
 };
 
 export class ConfigurationUtility {
@@ -127,7 +127,6 @@ export class ConfigurationUtility {
                 version: "1.0",
                 url: "",
             },
-            portalsApi: null,
         };
     }
 }

src/utils/Utility.ts

@@ -153,6 +153,16 @@ export class Utility {
         return clientUrl;
     }
 
+    /**
+     * Checks whether whether the app is currently running in a Dynamics Portals Environment.
+     *
+     * In that case we switch to the Web API for Dynamics Portals.
+     * @returns {boolean}
+     */
+    static isRunningWithinPortals(): boolean {
+        return !!(window as any).shell;
+    }
+
     static isObject(obj: any): boolean {
         return typeof obj === "object" && !!obj && !Array.isArray(obj) && Object.prototype.toString.call(obj) !== "[object Date]";
     }