Standardize Base URL

Add base URL support to Data Gateway since it can be run from dev environments.
Use the data gateway logic on SHIELD's client factory to standardize and extend code support.

Author: elliot-huffman

src/dataGateway/TypeScript/index.ts

@@ -1,7 +1,7 @@
 import { AzureIdentityAuthenticationProvider } from "@microsoft/kiota-authentication-azure";
 import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
 import type { TokenCredential } from "@azure/core-auth";
-import { assert } from 'typia';
+import { assert, assertGuardEquals } from 'typia';
 import { createDataGatewayClient } from "./sdk/dataGatewayClient.js";
 
 // Export all of the SDK's types
@@ -10,22 +10,28 @@ export type * from './sdk/models/index.js';
 /**
  * Function that initializes the Data Gateway SDK.
  * @param credential Configured authentication session.
+ * @param baseUrl Root of the URL that should have endpoints appended to it by the query building system.
  * @returns Configured API client that is able to make requests against SHI Data Gateway.
  */
-export default function dataGatewayClientFactory(credential: TokenCredential) {
+export default function dataGatewayClientFactory(credential: TokenCredential, baseUrl?: URL) {
     // #region Input Validation
     assert(credential);
+
+    assertGuardEquals(baseUrl);
     // #endregion Input Validation
 
     /** List of hosts that are allowed when making API calls, this is used to prevent token leaks to threat actors. */
-    const allowedHostList = new Set(['https://api.shilab.com']);
+    const allowedHostList = new Set([baseUrl?.host ?? 'api.shilab.com']);
 
     /** Authentication system that will be used to configure the SDK client. */
     const authProvider = new AzureIdentityAuthenticationProvider(credential, void 0, void 0, allowedHostList);
 
     /** Instance of the data gateway client initialization configuration. */
     const dataGatewayAdapter = new FetchRequestAdapter(authProvider);
 
+    // If a base URL is provided, set the root of the SDK's queries to the provided URL. Also account for trailing slashes.
+    if (baseUrl) { dataGatewayAdapter.baseUrl = baseUrl.href.endsWith('/') ? baseUrl.href.substring(0, baseUrl.href.length - 1) : baseUrl.href; }
+
     /** Instance of the API client that can be used for data gateway access. */
     return createDataGatewayClient(dataGatewayAdapter);
 }

src/shield/TypeScript/index.ts

@@ -1,4 +1,4 @@
-import { assert, assertGuardEquals, tags } from 'typia';
+import { assert, assertGuardEquals } from 'typia';
 import { AzureIdentityAuthenticationProvider } from "@microsoft/kiota-authentication-azure";
 import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
 import type { TokenCredential } from "@azure/core-auth";
@@ -10,17 +10,18 @@ export type * from './sdk/models/index.js';
 /**
  * Function that initializes the SHIELD SDK.
  * @param credential Configured authentication session from Entra ID.
+ * @param baseUrl Root of the URL that should have endpoints appended to it by the query building system.
  * @returns Configured API client that is able to make requests against the specified SHIELD instance.
  */
-export default function shieldClientFactory(credential: TokenCredential, baseUrl: string & tags.Format<'hostname'>) {
+export default function shieldClientFactory(credential: TokenCredential, baseUrl: URL) {
     // #region Input Validation
     assert(credential);
 
     assertGuardEquals(baseUrl);
     // #endregion Input Validation
 
     /** List of hosts that are allowed when making API calls, this is used to prevent token leaks to threat actors. */
-    const allowedHostList = new Set([baseUrl]);
+    const allowedHostList = new Set([baseUrl.host]);
 
     /** Authentication system that will be used to configure the SDK client. */
     const authProvider = new AzureIdentityAuthenticationProvider(credential, void 0, void 0, allowedHostList);
@@ -29,7 +30,7 @@ export default function shieldClientFactory(credential: TokenCredential, baseUrl
     const shieldAdapter = new FetchRequestAdapter(authProvider);
 
     // Set the base URL to be what is provided, since the host name is unique every deployment
-    shieldAdapter.baseUrl = baseUrl.startsWith('localhost') ? `http://${ baseUrl }` : `https://${ baseUrl }`;
+    shieldAdapter.baseUrl = baseUrl.href.endsWith('/') ? baseUrl.href.substring(0, baseUrl.href.length - 1) : baseUrl.href;
 
     /** Instance of the API client that can be used for SHIELD access. */
     return createShieldClient(shieldAdapter);