@microsoft/mgt-electron-provider

Microsoft Graph Toolkit Electron Provider

The Microsoft Graph Toolkit (mgt) library is a collection of authentication providers and UI components powered by Microsoft Graph.

The @microsoft/mgt-electron-provider package exposes the ElectronAuthenticator and ElectronProvider classes which use MSAL node to sign in users and acquire tokens to use with Microsoft Graph.

Usage without Context Bridge

1. Install the packages

   npm install @microsoft/mgt-element @microsoft/mgt-electron-provider
   

2. Initialize the provider in your renderer process (Front end, eg. renderer.ts)

   import {Providers} from '@microsoft/mgt-element';
   import {ElectronProvider} from '@microsoft/mgt-electron-provider/dist/Provider';
   
   // initialize the auth provider globally
   Providers.globalProvider = new ElectronProvider();
   

3. Initialize ElectronAuthenticator in Main.ts (Back end)

   import { ElectronAuthenticator, MsalElectronConfig } from '@microsoft/mgt-electron-provider/dist/Authenticator'; 
   ...
   let mainWindow =  new BrowserWindow({
     width: 800,
     height: 800,
     webPreferences: {
       nodeIntegration: true //Make sure this is true
     }
   });
   let config: MsalElectronConfig = {
     clientId: '<your_client_id>',
     authority: '<your_authority_url>', //optional, uses common authority by default
     mainWindow: mainWindow, //This is the BrowserWindow instance that requires authentication
     scopes: [
       'user.read', 
     ],
   };
   ElectronAuthenticator.initialize(config);
   

Note : Make sure nodeIntegration is set to true under webPreferences while creating a new BrowserWindow instance.

See provider usage documentation to learn about how to use the providers with the mgt components, to sign in/sign out, get access tokens, call Microsoft Graph, and more. See Electron provider documentation.

Usage with Context Bridge

1. Install the packages

   npm install @microsoft/mgt-element @microsoft/mgt-electron-provider
   

2. Setup the context bridge in your preload script (eg. preload.ts)

   import { contextBridge } from 'electron';
   import { ElectronContextBridgeProvider } from '@microsoft/mgt-electron-provider/dist/Provider';
   
   // can be named anything, like "electronApi"
   contextBridge.exposeInMainWorld("main", {
     electronProvider: {
       mgtAuthState: (callback: (event: IpcRendererEvent, authState: string) => void) => ipcRenderer.on('mgtAuthState', callback),
       token: (options?: AuthenticationProviderOptions) => ipcRenderer.invoke('token', options),
       login: () => ipcRenderer.invoke('login'),
       logout: () => ipcRenderer.invoke('logout'),
     },
   });
   

   Expose the ElectronProvider methods through the context bridge. Here, we've named the api "main" for the main window, but it can be named anything. We've also made sure to put them under electronProvider to separate them from other methods you may add. These methods must match the IContextBridgeImpl interface in the @microsoft/mgt-electron-provider package.

3. Globally augment the Window interface in a declaration file (eg. preload.d.ts)

   import { IContextBridgeImpl } from '@microsoft/mgt-electron-provider/dist/Provider';
   
   export declare global {
     interface Window {
       // can be named anything, like "electronApi"
       main: {
         electronProvider: IContextBridgeImpl;
       }
     }
   }
   

4. Initialize the provider in your renderer process (Front end, eg. renderer.ts)

   import {Providers} from '@microsoft/mgt-element';
   import {ElectronContextBridgeProvider} from '@microsoft/mgt-electron-provider/dist/Provider';
   
   // initialize the auth provider globally
   Providers.globalProvider = new ElectronContextBridgeProvider(window.main.electronProvider)
   

5. Initialize ElectronAuthenticator in Main.ts (Back end)

   import { ElectronAuthenticator, MsalElectronConfig } from '@microsoft/mgt-electron-provider/dist/Authenticator'; 
   ...
   let mainWindow =  new BrowserWindow({
     width: 800,
     height: 800,
     webPreferences: {
       nodeIntegration: false // make sure this is false, we're using context bridge
     }
   });
   
   let config: MsalElectronConfig = {
     clientId: '<your_client_id>',
     authority: '<your_authority_url>', // optional, uses common authority by default
     mainWindow: mainWindow, // this is the BrowserWindow instance that requires authentication
     scopes: [
       'user.read', 
     ],
   };
   
   ElectronAuthenticator.initialize(config);
   

Note : Make sure nodeIntegration is set to false under webPreferences while creating a new BrowserWindow instance. This is because we're using context bridge to communicate between the main and renderer processes.

See provider usage documentation to learn about how to use the providers with the mgt components, to sign in/sign out, get access tokens, call Microsoft Graph, and more. See Electron provider documentation.

Cache Plugin

MSAL Node supports an in-memory cache by default and provides the ICachePlugin interface to perform cache serialization, but does not provide a default way of storing the token cache to disk. If you need persistent cache storage to enable silent log-ins or cross-platform caching, we recommend using the default implementation provided by MSAL Node here. You can import this plugin, and pass the instance of the cache plugin while initializing ElectronAuthenticator.

let config: MsalElectronConfig = {
  ...
  cachePlugin: new PersistenceCachePlugin(filePersistence)
};

For more details on how to implement this, refer to the sample for this extension here.

See also

• Build an electron app and integrate Microsoft Graph Toolkit
• Microsoft Graph Toolkit docs
• Microsoft Graph Toolkit repository
• Microsoft Graph Toolkit playground

Changelog

4.4.0 (2024-11-18)

Features

• display the children in a folder for a file list (#3339) (1afd741)

Bug Fixes

• fire logout completed on logout (#3332) (e2edc88)