@intility/vite-plugin-msal

Vite plugin for @azure/msal-browser features.

Usage

First, install the package:

npm install @intility/vite-plugin-msal

Then, set up the plugin in your vite.config.ts:

import msal from "@intility/vite-plugin-msal";
import { defineConfig } from "vite";

// https://vite.dev/config/
export default defineConfig({
  plugins: [msal()],
});

Features

Redirect Bridge

This plugin automatically emits a redirect bridge described in Login User / RedirectUri Considerations and the v4 -> v5 Migration guide, which is bundled with vite and your installed version of @azure/msal-browser.

The path of the redirect page can be configured with redirectBridgePath:

msal({
  redirectBridgePath: "/auth/redirect"
})

Important

If you haven't had a redirect bridge earlier, remember to update your redirect URIs in Entra ID.

Cross-Origin-Opener-Policy header

The COOP header is returned by the authentication service and requires the application to have a redirect bridge (which this plugin provides). You do not need to serve the COOP header yourself, but if you choose to, configure coopHeader and the plugin will add it to all pages except the redirect bridge during dev/preview.

msal({
  coopHeader: "same-origin"
})

Important

The plugin can only configure this for the dev and preview server. It is your responsibility to ensure your deployments return the header correctly in production.

Bypass metadata resolution

This plugin can optionally pre-fetch cloud discovery and OpenID metadata at build time, described in the msal-common Performance docs.

Note

This is not needed when using the standard login.microsoftonline.com authority — MSAL already includes hardcoded metadata for it. This option exists as an escape hatch for applications using a non-standard authority where MSAL cannot resolve metadata on its own. See MSAL issue #8392 for context.

Configure the authority option in the plugin to fetch metadata at build time:

msal({
  authority: "https://login.example.com/tenant-id"
})

Then use withMetadata to apply the pre-fetched metadata to your MSAL config:

import { withMetadata } from "@intility/vite-plugin-msal/client";
import { PublicClientApplication } from "@azure/msal-browser";

const msalConfig = withMetadata({
  auth: {
    clientId: "your-client-id",
  },
});

const instance = new PublicClientApplication(msalConfig);

If auth.authority is not set in your MSAL config, the plugin's configured authority will be applied automatically. If it is set, it must match the authority passed to the plugin.