Merge branch 'next/fluentui' into merge/main-to-fluentui

Author: musale

packages/mgt-element/src/Graph.ts

@@ -17,7 +17,7 @@ import {
   TelemetryHandler
 } from '@microsoft/microsoft-graph-client';
 
-import { IGraph } from './IGraph';
+import { IGraph, MICROSOFT_GRAPH_DEFAULT_ENDPOINT } from './IGraph';
 import { IProvider } from './providers/IProvider';
 import { Batch } from './utils/Batch';
 import { ComponentMiddlewareOptions } from './utils/ComponentMiddlewareOptions';
@@ -155,8 +155,10 @@ export function createFromProvider(provider: IProvider, version?: string, compon
     new HTTPMessageHandler()
   ];
 
+  let baseURL = provider.baseURL ? provider.baseURL : MICROSOFT_GRAPH_DEFAULT_ENDPOINT;
   const client = Client.initWithMiddleware({
-    middleware: chainMiddleware(...middleware)
+    middleware: chainMiddleware(...middleware),
+    baseUrl: baseURL
   });
 
   const graph = new Graph(client, version);

packages/mgt-element/src/IGraph.ts

@@ -67,14 +67,25 @@ export interface IGraph {
   createBatch(): IBatch;
 }
 
+/**
+ * GraphEndpoint is a valid URL that is used to access the Graph.
+ */
 export type GraphEndpoint =
   | 'https://graph.microsoft.com'
   | 'https://graph.microsoft.us'
   | 'https://dod-graph.microsoft.us'
   | 'https://graph.microsoft.de'
   | 'https://microsoftgraph.chinacloudapi.cn';
 
+/**
+ * MICROSOFT_GRAPH_ENDPOINTS is a set of all the valid Graph URL endpoints.
+ */
 export const MICROSOFT_GRAPH_ENDPOINTS: Set<GraphEndpoint> = new Set<GraphEndpoint>();
+
+/**
+ * MICROSOFT_GRAPH_DEFAULT_ENDPOINT is the default Graph endpoint that is silently set on
+ * the providers as the baseURL.
+ */
 export const MICROSOFT_GRAPH_DEFAULT_ENDPOINT: GraphEndpoint = 'https://graph.microsoft.com';
 
 (() => {

packages/mgt-element/src/components/baseProvider.ts

@@ -8,6 +8,7 @@
 import { property } from 'lit/decorators.js';
 import { MgtBaseComponent } from './baseComponent';
 import { IProvider } from '../providers/IProvider';
+import { GraphEndpoint } from '../IGraph';
 
 /**
  * Abstract implementation for provider component
@@ -65,6 +66,17 @@ export abstract class MgtBaseProvider extends MgtBaseComponent {
   })
   public dependsOn: MgtBaseProvider;
 
+  /**
+   * The base URL that should be used in the graph client config.
+   *
+   * @memberof MgtBaseProvider
+   */
+  @property({
+    attribute: 'base-url',
+    type: String
+  })
+  public baseUrl: GraphEndpoint;
+
   private _provider: IProvider;
 
   /**

packages/mgt-element/src/providers/IProvider.ts

@@ -6,7 +6,8 @@
  */
 
 import { AuthenticationProvider, AuthenticationProviderOptions } from '@microsoft/microsoft-graph-client';
-import { IGraph } from '../IGraph';
+import { validateBaseURL } from '../utils/GraphHelpers';
+import { GraphEndpoint, IGraph, MICROSOFT_GRAPH_DEFAULT_ENDPOINT } from '../IGraph';
 import { EventDispatcher, EventHandler } from '../utils/EventDispatcher';
 
 /**
@@ -48,6 +49,23 @@ export abstract class IProvider implements AuthenticationProvider {
   private _state: ProviderState;
   private _loginChangedDispatcher = new EventDispatcher<LoginChangedEvent>();
   private _activeAccountChangedDispatcher = new EventDispatcher<ActiveAccountChanged>();
+  private _baseURL: GraphEndpoint = MICROSOFT_GRAPH_DEFAULT_ENDPOINT;
+
+  /**
+   * The base URL to be used in the graph client config.
+   */
+  public set baseURL(url: GraphEndpoint) {
+    if (validateBaseURL(url)) {
+      this._baseURL = url;
+      return;
+    } else {
+      throw new Error(`${url} is not a valid Graph URL endpoint.`);
+    }
+  }
+
+  public get baseURL(): GraphEndpoint {
+    return this._baseURL;
+  }
 
   /**
    * Enable/Disable incremental consent

packages/providers/mgt-electron-provider/src/Authenticator/ElectronAuthenticator.ts

@@ -17,6 +17,7 @@ import {
   PublicClientApplication
 } from '@azure/msal-node';
 import { AuthenticationProviderOptions } from '@microsoft/microsoft-graph-client';
+import { GraphEndpoint } from '@microsoft/mgt-element';
 import { BrowserWindow, ipcMain } from 'electron';
 import { CustomFileProtocolListener } from './CustomFileProtocol';
 import { REDIRECT_URI, COMMON_AUTHORITY_URL } from './Constants';
@@ -65,6 +66,10 @@ export interface MsalElectronConfig {
    * @memberof MsalElectronConfig
    */
   cachePlugin?: ICachePlugin;
+  /**
+   * The base URL for the graph client
+   */
+  baseURL?: GraphEndpoint;
 }
 
 /**
@@ -86,6 +91,11 @@ enum AuthState {
   LOGGED_OUT = 'logged_out'
 }
 
+/**
+ * AccountDetails defines the available AccountInfo or undefined.
+ */
+type AccountDetails = AccountInfo | undefined;
+
 /**
  * ElectronAuthenticator class to be instantiated in the main process.
  * Responsible for MSAL authentication flow and token acqusition.
@@ -133,10 +143,10 @@ export class ElectronAuthenticator {
    * Logged in account
    *
    * @private
-   * @type {AccountInfo}
+   * @type {AccountDetails}
    * @memberof ElectronAuthenticator
    */
-  private account: AccountInfo;
+  private account: AccountDetails;
 
   /**
    * Params to generate the URL for MSAL auth
@@ -182,7 +192,7 @@ export class ElectronAuthenticator {
    */
   private constructor(config: MsalElectronConfig) {
     this.setConfig(config);
-    this.account = null;
+    this.account = undefined;
     this.mainWindow = config.mainWindow;
     this.setRequestObjects(config.scopes);
     this.setupProvider();
@@ -224,7 +234,7 @@ export class ElectronAuthenticator {
         clientId: config.clientId,
         authority: config.authority ? config.authority : COMMON_AUTHORITY_URL
       },
-      cache: config.cachePlugin ? { cachePlugin: config.cachePlugin } : null,
+      cache: config.cachePlugin ? { cachePlugin: config.cachePlugin } : undefined,
       system: {
         loggerOptions: {
           loggerCallback(loglevel, message, containsPii) {},
@@ -255,7 +265,7 @@ export class ElectronAuthenticator {
     this.authCodeRequest = {
       scopes: requestScopes,
       redirectUri,
-      code: null
+      code: ''
     };
   }
 
@@ -311,7 +321,7 @@ export class ElectronAuthenticator {
    * @return {*}  {Promise<string>}
    * @memberof ElectronAuthenticator
    */
-  protected async getAccessToken(options?: AuthenticationProviderOptions): Promise<string> {
+  protected async getAccessToken(options?: AuthenticationProviderOptions): Promise<string | undefined> {
     let authResponse;
     const scopes = options && options.scopes ? options.scopes : this.authCodeUrlParams.scopes;
     const account = this.account || (await this.getAccount());
@@ -326,6 +336,7 @@ export class ElectronAuthenticator {
     if (authResponse) {
       return authResponse.accessToken;
     }
+    return undefined;
   }
 
   /**
@@ -337,7 +348,7 @@ export class ElectronAuthenticator {
    * @return {*}  {Promise<AuthenticationResult>}
    * @memberof ElectronAuthenticator
    */
-  protected async getTokenSilent(tokenRequest, scopes?): Promise<AuthenticationResult> {
+  protected async getTokenSilent(tokenRequest, scopes?): Promise<AuthenticationResult | null> {
     try {
       return await this.clientApplication.acquireTokenSilent(tokenRequest);
     } catch (error) {
@@ -366,7 +377,7 @@ export class ElectronAuthenticator {
   protected async logout(): Promise<void> {
     if (this.account) {
       await this.clientApplication.getTokenCache().removeAccount(this.account);
-      this.account = null;
+      this.account = undefined;
     }
   }
 
@@ -379,8 +390,8 @@ export class ElectronAuthenticator {
    * @memberof ElectronAuthenticator
    */
   private async setAccountFromResponse(response: AuthenticationResult) {
-    if (response !== null) {
-      this.account = response.account;
+    if (response) {
+      this.account = response?.account || undefined;
     } else {
       this.account = await this.getAccount();
     }
@@ -412,7 +423,7 @@ export class ElectronAuthenticator {
       .acquireTokenByCode({
         ...this.authCodeRequest,
         scopes: requestScopes,
-        code: authCode
+        code: authCode || ''
       })
       .catch((e: AuthError) => {
         throw e;
@@ -429,7 +440,7 @@ export class ElectronAuthenticator {
    * @return {*}  {Promise<string>}
    * @memberof ElectronAuthenticator
    */
-  private async listenForAuthCode(navigateUrl: string, prompt_type: promptType): Promise<string> {
+  private async listenForAuthCode(navigateUrl: string, prompt_type: promptType): Promise<string | null> {
     this.setAuthWindow(true);
     await this.authWindow.loadURL(navigateUrl);
     return new Promise((resolve, reject) => {
@@ -474,20 +485,12 @@ export class ElectronAuthenticator {
    * @return {*}  {Promise<AccountInfo>}
    * @memberof ElectronAuthenticator
    */
-  private async getAccount(): Promise<AccountInfo> {
+  private async getAccount(): Promise<AccountDetails> {
     const cache = this.clientApplication.getTokenCache();
     const currentAccounts = await cache.getAllAccounts();
-
-    if (currentAccounts === null) {
-      return null;
-    }
-
-    if (currentAccounts.length > 1) {
+    if (currentAccounts?.length >= 1) {
       return currentAccounts[0];
-    } else if (currentAccounts.length === 1) {
-      return currentAccounts[0];
-    } else {
-      return null;
     }
+    return undefined;
   }
 }

packages/providers/mgt-electron-provider/src/Provider/ElectronProvider.ts

@@ -5,7 +5,14 @@
  * -------------------------------------------------------------------------------------------
  */
 
-import { IProvider, Providers, ProviderState, createFromProvider } from '@microsoft/mgt-element';
+import {
+  IProvider,
+  Providers,
+  ProviderState,
+  createFromProvider,
+  GraphEndpoint,
+  MICROSOFT_GRAPH_DEFAULT_ENDPOINT
+} from '@microsoft/mgt-element';
 import { AuthenticationProviderOptions } from '@microsoft/microsoft-graph-client';
 import { ipcRenderer } from 'electron';
 
@@ -28,8 +35,9 @@ export class ElectronProvider extends IProvider {
     return 'MgtElectronProvider';
   }
 
-  constructor() {
+  constructor(baseUrl: GraphEndpoint = MICROSOFT_GRAPH_DEFAULT_ENDPOINT) {
     super();
+    this.baseURL = baseUrl;
     this.graph = createFromProvider(this);
     this.setupProvider();
   }

packages/providers/mgt-msal-provider/src/MsalProvider.ts

@@ -6,7 +6,7 @@
  */
 
 import { AuthenticationProviderOptions } from '@microsoft/microsoft-graph-client';
-import { IProvider, LoginType, ProviderState, createFromProvider } from '@microsoft/mgt-element';
+import { IProvider, LoginType, ProviderState, createFromProvider, GraphEndpoint } from '@microsoft/mgt-element';
 import { AuthenticationParameters, AuthError, AuthResponse, Configuration, UserAgentApplication } from 'msal';
 
 /**
@@ -51,6 +51,10 @@ interface MsalConfigBase {
    * @memberof MsalConfigBase
    */
   prompt?: string;
+  /**
+   * The base URL for the graph client
+   */
+  baseURL?: GraphEndpoint;
 }
 
 /**
@@ -439,6 +443,7 @@ export class MsalProvider extends IProvider {
     }
 
     this.clientId = clientId;
+    this.baseURL = typeof config.baseURL !== 'undefined' ? config.baseURL : this.baseURL;
 
     this._userAgentApplication = userAgentApplication;
     this._userAgentApplication.handleRedirectCallback(

packages/providers/mgt-msal-provider/src/mgt-msal-provider.ts

@@ -5,7 +5,7 @@
  * -------------------------------------------------------------------------------------------
  */
 import { customElement, property } from 'lit/decorators.js';
-import { Providers, LoginType, MgtBaseProvider } from '@microsoft/mgt-element';
+import { Providers, LoginType, MgtBaseProvider, validateBaseURL } from '@microsoft/mgt-element';
 import { MsalConfig, MsalProvider } from './MsalProvider';
 /**
  * Authentication Library Provider for Microsoft personal accounts
@@ -135,6 +135,10 @@ export class MgtMsalProvider extends MgtBaseProvider {
         config.redirectUri = this.redirectUri;
       }
 
+      if (this.baseUrl) {
+        config.baseURL = this.baseUrl;
+      }
+
       this.provider = new MsalProvider(config);
       Providers.globalProvider = this.provider;
     }

packages/providers/mgt-msal2-provider/src/Msal2Provider.ts

@@ -5,7 +5,14 @@
  * -------------------------------------------------------------------------------------------
  */
 
-import { IProvider, LoginType, ProviderState, createFromProvider, IProviderAccount } from '@microsoft/mgt-element';
+import {
+  IProvider,
+  LoginType,
+  ProviderState,
+  createFromProvider,
+  IProviderAccount,
+  GraphEndpoint
+} from '@microsoft/mgt-element';
 import {
   Configuration,
   PublicClientApplication,
@@ -133,6 +140,11 @@ export interface Msal2Config extends Msal2ConfigBase {
    * @memberof Msal2Config
    */
   isMultiAccountEnabled?: boolean;
+
+  /**
+   * The base URL for the graph client
+   */
+  baseURL?: GraphEndpoint;
 }
 
 /**
@@ -376,6 +388,7 @@ export class Msal2Provider extends IProvider {
     const msal2config = config as Msal2Config;
     this.isMultipleAccountEnabled =
       typeof msal2config.isMultiAccountEnabled !== 'undefined' ? msal2config.isMultiAccountEnabled : true;
+    this.baseURL = typeof msal2config.baseURL !== 'undefined' ? msal2config.baseURL : this.baseURL;
 
     this.graph = createFromProvider(this);
     try {

packages/providers/mgt-msal2-provider/src/mgt-msal2-provider.ts

@@ -6,7 +6,7 @@
  */
 
 import { customElement, property } from 'lit/decorators.js';
-import { Providers, LoginType, MgtBaseProvider } from '@microsoft/mgt-element';
+import { Providers, LoginType, MgtBaseProvider, validateBaseURL } from '@microsoft/mgt-element';
 import { Msal2Config, Msal2Provider, PromptType } from './Msal2Provider';
 /**
  * Authentication Library Provider for Microsoft personal accounts
@@ -188,6 +188,11 @@ export class MgtMsal2Provider extends MgtBaseProvider {
       if (this.isMultiAccountDisabled) {
         config.isMultiAccountEnabled = false;
       }
+
+      if (this.baseUrl) {
+        config.baseURL = this.baseUrl;
+      }
+
       this.provider = new Msal2Provider(config);
       Providers.globalProvider = this.provider;
     }