@equinor/fusion-framework-module-msal 4.0.0 → 4.0.2

package/dist/types/static.d.ts

@@ -1,5 +1,5 @@
 export declare const ModuleName: "msal";
 export declare enum MsalModuleVersion {
     V2 = "v2",
-    Latest = "4.0.0"
+    Latest = "4.0.2"
 }

package/dist/types/types.d.ts

@@ -1,5 +1,5 @@
-import { type SemVer } from 'semver';
-import { MsalModuleVersion } from './static';
+import type { SemVer } from 'semver';
+import type { MsalModuleVersion } from './static';
 export interface IProxyProvider {
     version: string | SemVer;
     createProxyProvider<T>(version: MsalModuleVersion): T;

package/dist/types/v2/client/client.d.ts

@@ -1,6 +1,6 @@
-import { PublicClientApplication, Configuration, AuthenticationResult, AccountInfo as AccountInfoBase } from '@azure/msal-browser';
-import { AuthBehavior } from './behavior';
-import { AuthRequest } from './request';
+import { PublicClientApplication, type Configuration, type AuthenticationResult, type AccountInfo as AccountInfoBase } from '@azure/msal-browser';
+import { type AuthBehavior } from './behavior';
+import type { AuthRequest } from './request';
 export type IdTokenClaims = {
     aud: string;
     exp: number;

package/dist/types/v2/client/create-auth-client.d.ts

@@ -1,4 +1,4 @@
-import { Configuration, IPublicClientApplication } from '@azure/msal-browser';
+import type { Configuration, IPublicClientApplication } from '@azure/msal-browser';
 import { AuthClient } from './client';
 export type AuthClientConfig = Configuration & {
     auth: Partial<Configuration['auth']>;

package/dist/types/v2/client/log/console.d.ts

@@ -20,6 +20,8 @@ export declare class ConsoleLogger extends Logger {
     protected loggerCallback(lvl: LogLevel, msg: string, _containsPii?: boolean): void;
     /**
      * Map log level to console log function type
+     *
+     * @default LogLevel.Verbose
      */
     protected getLogType: (lvl: LogLevel) => ConsoleLevel;
 }

package/dist/types/v2/client/request.d.ts

@@ -1,4 +1,4 @@
-import { PopupRequest, RedirectRequest } from '@azure/msal-browser';
+import type { PopupRequest, RedirectRequest } from '@azure/msal-browser';
 /**
  * Request object passed by user to retrieve a Code from the
  * server (first leg of authorization code grant flow).

package/dist/types/v2/configurator.d.ts

@@ -1,7 +1,7 @@
 import z from 'zod';
 import { BaseConfigBuilder } from '@equinor/fusion-framework-module';
 import { MsalModuleVersion } from '../static';
-import { IAuthProvider } from './provider';
+import type { IAuthProvider } from './provider';
 declare const AuthClientConfigSchema: z.ZodObject<{
     clientId: z.ZodString;
     tenantId: z.ZodString;

package/dist/types/v2/provider.d.ts

@@ -1,9 +1,13 @@
-import { AuthClient, AuthRequest } from './client';
-import { AuthClientConfig } from './configurator';
-import { AccountInfo, AuthenticationResult } from './types';
-import { IProxyProvider } from '../types';
+import { type AuthClient, type AuthRequest } from './client';
+import type { AuthClientConfig } from './configurator';
+import type { AccountInfo, AuthenticationResult } from './types';
+import type { IProxyProvider } from '../types';
 import { SemanticVersion } from '@equinor/fusion-framework-module';
 export interface IAuthProvider {
+    /**
+     * @deprecated
+     */
+    readonly defaultConfig: any | undefined;
     readonly defaultAccount: AccountInfo | undefined;
     /**
      * Acquire token from default auth client

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "4.0.0";
+export declare const version = "4.0.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-msal",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "description": "",
   "main": "dist/esm/index.js",
   "exports": {
@@ -37,10 +37,10 @@
     "@types/semver": "^7.5.0",
     "semver": "^7.5.4",
     "zod": "^3.23.8",
-    "@equinor/fusion-framework-module": "^4.3.5"
+    "@equinor/fusion-framework-module": "^4.3.7"
   },
   "devDependencies": {
-    "typescript": "^5.5.4"
+    "typescript": "^5.8.2"
   },
   "scripts": {
     "build": "tsc -b"

package/src/index.ts

@@ -1,11 +1,11 @@
 export {
-    module,
-    configureMsal,
-    enableMSAL,
-    type AuthConfigurator as IAppConfigurator,
-    type AuthConfigFn,
-    type IAuthProvider,
-    type MsalModule,
+  module,
+  configureMsal,
+  enableMSAL,
+  type AuthConfigurator as IAppConfigurator,
+  type AuthConfigFn,
+  type IAuthProvider,
+  type MsalModule,
 } from './module';
 
 export { MsalModuleVersion } from './static';

package/src/module.ts

@@ -1,7 +1,7 @@
 import {
-    type Module,
-    type IModulesConfigurator,
-    SemanticVersion,
+  type Module,
+  type IModulesConfigurator,
+  SemanticVersion,
 } from '@equinor/fusion-framework-module';
 
 import { MsalModuleVersion } from './static';
@@ -12,70 +12,70 @@ export type MsalModule = Module<'auth', IAuthProvider, AuthConfigurator, [MsalMo
 export type { AuthConfigurator, IAuthProvider };
 
 export const module: MsalModule = {
-    name: 'auth',
-    version: new SemanticVersion(MsalModuleVersion.Latest),
-    configure: () => new AuthConfigurator(),
-    initialize: async (init) => {
-        const config = await init.config.createConfigAsync(init);
+  name: 'auth',
+  version: new SemanticVersion(MsalModuleVersion.Latest),
+  configure: () => new AuthConfigurator(),
+  initialize: async (init) => {
+    const config = await init.config.createConfigAsync(init);
 
-        // configured to use a custom provider
-        if (config.provider) {
-            return config.provider;
-        }
+    // configured to use a custom provider
+    if (config.provider) {
+      return config.provider;
+    }
 
-        // check if the provider is defined in the parent module
-        const hostProvider = init.ref?.auth as AuthProvider;
-        if (hostProvider) {
-            try {
-                return hostProvider.createProxyProvider(config.version);
-            } catch (error) {
-                console.error('MsalModule::Failed to create proxy provider', error);
-                // just to make sure during migration that the provider is not set
-                return hostProvider;
-            }
-        }
+    // check if the provider is defined in the parent module
+    const hostProvider = init.ref?.auth as AuthProvider;
+    if (hostProvider) {
+      try {
+        return hostProvider.createProxyProvider(config.version);
+      } catch (error) {
+        console.error('MsalModule::Failed to create proxy provider', error);
+        // just to make sure during migration that the provider is not set
+        return hostProvider;
+      }
+    }
 
-        if (!config.client) {
-            throw new Error(
-                'Client configuration is required when provider is not in the parent module nor defined',
-            );
-        }
+    if (!config.client) {
+      throw new Error(
+        'Client configuration is required when provider is not in the parent module nor defined',
+      );
+    }
 
-        // create a new provider
-        const authProvider = new AuthProvider(config.client);
+    // create a new provider
+    const authProvider = new AuthProvider(config.client);
 
-        if (config.requiresAuth) {
-            await authProvider.handleRedirect();
-            await authProvider.login({ onlyIfRequired: true });
-        }
+    if (config.requiresAuth) {
+      await authProvider.handleRedirect();
+      await authProvider.login({ onlyIfRequired: true });
+    }
 
-        return authProvider;
-    },
+    return authProvider;
+  },
 };
 
 export type AuthConfigFn = (builder: {
-    setClientConfig: (config: AuthClientConfig) => void;
-    setRequiresAuth: (requiresAuth: boolean) => void;
+  setClientConfig: (config: AuthClientConfig) => void;
+  setRequiresAuth: (requiresAuth: boolean) => void;
 }) => void;
 
 export const enableMSAL = (
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    configurator: IModulesConfigurator<any, any>,
-    configure?: AuthConfigFn,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  configurator: IModulesConfigurator<any, any>,
+  configure?: AuthConfigFn,
 ): void => {
-    const config = configure ? configureMsal(configure) : { module };
-    configurator.addConfig(config);
+  const config = configure ? configureMsal(configure) : { module };
+  configurator.addConfig(config);
 };
 
 export const configureMsal = (configure: AuthConfigFn) => ({
-    module,
-    configure,
+  module,
+  configure,
 });
 
 declare module '@equinor/fusion-framework-module' {
-    interface Modules {
-        auth: MsalModule;
-    }
+  interface Modules {
+    auth: MsalModule;
+  }
 }
 
 export default module;

package/src/resolve-version.ts

@@ -3,41 +3,41 @@ import semver, { type SemVer } from 'semver';
 import { MsalModuleVersion } from './static';
 
 export function resolveVersion(version: string | SemVer): {
-    wantedVersion: SemVer;
-    latestVersion: SemVer;
-    isLatest: boolean;
-    satisfiesLatest: boolean;
-    enumVersion: MsalModuleVersion;
+  wantedVersion: SemVer;
+  latestVersion: SemVer;
+  isLatest: boolean;
+  satisfiesLatest: boolean;
+  enumVersion: MsalModuleVersion;
 } {
-    const wantedVersion = semver.coerce(version || MsalModuleVersion.Latest);
-    const latestVersion = semver.coerce(MsalModuleVersion.Latest);
-    // check if version is valid semver version
-    if (!wantedVersion) {
-        throw new Error(`Invalid version ${version} provided`);
-    }
+  const wantedVersion = semver.coerce(version || MsalModuleVersion.Latest);
+  const latestVersion = semver.coerce(MsalModuleVersion.Latest);
+  // check if version is valid semver version
+  if (!wantedVersion) {
+    throw new Error(`Invalid version ${version} provided`);
+  }
 
-    if (!latestVersion) {
-        throw new Error('Invalid latest version');
-    }
+  if (!latestVersion) {
+    throw new Error('Invalid latest version');
+  }
 
-    // check if version is greater than latest
-    if (semver.gt(wantedVersion, latestVersion!)) {
-        throw new Error(
-            `Requested version ${version} is greater than the latest version ${MsalModuleVersion.Latest}`,
-        );
-    }
+  // check if version is greater than latest
+  if (semver.gt(wantedVersion, latestVersion!)) {
+    throw new Error(
+      `Requested version ${version} is greater than the latest version ${MsalModuleVersion.Latest}`,
+    );
+  }
 
-    const enumVersion = Object.values(MsalModuleVersion).find(
-        (x) => semver.coerce(x)?.major === wantedVersion.major,
-    ) as MsalModuleVersion;
+  const enumVersion = Object.values(MsalModuleVersion).find(
+    (x) => semver.coerce(x)?.major === wantedVersion.major,
+  ) as MsalModuleVersion;
 
-    return {
-        wantedVersion,
-        latestVersion,
-        enumVersion,
-        isLatest: wantedVersion.compare(latestVersion) === 0,
-        satisfiesLatest: wantedVersion.major === latestVersion.major,
-    };
+  return {
+    wantedVersion,
+    latestVersion,
+    enumVersion,
+    isLatest: wantedVersion.compare(latestVersion) === 0,
+    satisfiesLatest: wantedVersion.major === latestVersion.major,
+  };
 }
 
 export default resolveVersion;

package/src/static.ts

@@ -3,6 +3,6 @@ import { version } from './version';
 export const ModuleName = 'msal' as const;
 
 export enum MsalModuleVersion {
-    V2 = 'v2',
-    Latest = version,
+  V2 = 'v2',
+  Latest = version,
 }

package/src/types.ts

@@ -1,8 +1,8 @@
-import { type SemVer } from 'semver';
-import { MsalModuleVersion } from './static';
+import type { SemVer } from 'semver';
+import type { MsalModuleVersion } from './static';
 
 // this should be defined the @equinor/fusion-framework-module package
 export interface IProxyProvider {
-    version: string | SemVer;
-    createProxyProvider<T>(version: MsalModuleVersion): T;
+  version: string | SemVer;
+  createProxyProvider<T>(version: MsalModuleVersion): T;
 }

package/src/v2/client/client.ts

@@ -1,23 +1,23 @@
 import {
-    PublicClientApplication,
-    Configuration,
-    AuthenticationResult,
-    SsoSilentRequest,
-    PopupRequest,
-    RedirectRequest,
-    AccountInfo as AccountInfoBase,
+  PublicClientApplication,
+  type Configuration,
+  type AuthenticationResult,
+  type SsoSilentRequest,
+  type PopupRequest,
+  type RedirectRequest,
+  type AccountInfo as AccountInfoBase,
 } from '@azure/msal-browser';
 
-import { AuthBehavior, defaultBehavior } from './behavior';
-import { AuthRequest } from './request';
+import { type AuthBehavior, defaultBehavior } from './behavior';
+import type { AuthRequest } from './request';
 
 export type IdTokenClaims = {
-    aud: string;
-    exp: number;
+  aud: string;
+  exp: number;
 };
 
 export type AccountInfo = AccountInfoBase & {
-    idTokenClaims?: IdTokenClaims;
+  idTokenClaims?: IdTokenClaims;
 };
 
 /**
@@ -52,133 +52,129 @@ export type AccountInfo = AccountInfoBase & {
  * @see [Microsoft identity platform](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow)
  */
 export class AuthClient extends PublicClientApplication {
-    /**
-     * @returns
-     * Returns account for client tenant that MSAL currently has data for.
-     * (the account object is created at the time of successful login)
-     */
-    get account(): AccountInfo | undefined {
-        const accounts = this.getAllAccounts();
-        const account = accounts.find(
-            (a) => (a as AccountInfo).idTokenClaims?.aud === this.clientId,
-        );
-        return account as AccountInfo;
+  /**
+   * @returns
+   * Returns account for client tenant that MSAL currently has data for.
+   * (the account object is created at the time of successful login)
+   */
+  get account(): AccountInfo | undefined {
+    const accounts = this.getAllAccounts();
+    const account = accounts.find((a) => (a as AccountInfo).idTokenClaims?.aud === this.clientId);
+    return account as AccountInfo;
+  }
+
+  get hasValidClaims(): boolean {
+    const idTokenClaims = this.account?.idTokenClaims;
+    if (idTokenClaims) {
+      const epoch = Math.ceil(Date.now() / 1000);
+      return idTokenClaims.exp > epoch;
     }
-
-    get hasValidClaims(): boolean {
-        const idTokenClaims = this.account?.idTokenClaims;
-        if (idTokenClaims) {
-            const epoch = Math.ceil(Date.now() / 1000);
-            return idTokenClaims.exp > epoch;
-        }
-        return false;
+    return false;
+  }
+
+  /**
+   * @returns - Configured client id
+   */
+  get clientId(): string | undefined {
+    return this.config.auth?.clientId;
+  }
+
+  get requestOrigin(): string | null {
+    return this.browserStorage.getTemporaryCache('request.origin', true);
+  }
+
+  /**
+   * @param tenantId - tenant id for client domain
+   * @param config - required [Configuration](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/src/config/Configuration.ts)
+   */
+  constructor(
+    readonly tenantId: string,
+    config: Configuration,
+  ) {
+    super(config);
+  }
+
+  /**
+   * @param silent
+   * Attempt to use a hidden iframe to fetch an authorization code from the eSTS if {@link AuthClient.account} or login hint.
+   * Provided {@link AuthBehavior} is used as fallback.
+   * There are cases where this may not work:
+   * - Any browser using a form of Intelligent Tracking Prevention
+   * - If there is not an established session with the service
+   *
+   * @returns
+   * Promise that is fulfilled when this function has completed, or rejected if an error was raised.
+   */
+  async login(
+    options?: AuthRequest,
+    behavior: AuthBehavior = defaultBehavior,
+    silent = true,
+  ): Promise<AuthenticationResult | void> {
+    const loginHint = options?.loginHint || this.account?.username;
+    const scopes = options?.scopes || [];
+    const request = { ...options, loginHint, scopes };
+
+    if (loginHint && silent) {
+      this.logger.verbose('Attempting to login in silently');
+      try {
+        const res = await this.ssoSilent(request as SsoSilentRequest);
+        return res;
+      } catch {
+        this.logger.verbose('Silent login attempt failed');
+      }
     }
 
-    /**
-     * @returns - Configured client id
-     */
-    get clientId(): string | undefined {
-        return this.config.auth?.clientId;
-    }
+    this.logger.verbose(`Attempting to login in by [${behavior}]`);
 
-    get requestOrigin(): string | null {
-        return this.browserStorage.getTemporaryCache('request.origin', true);
+    switch (behavior) {
+      case 'popup':
+        return this.loginPopup(request as PopupRequest);
+      case 'redirect': {
+        return this.loginRedirect(request as RedirectRequest);
+      }
     }
-
-    /**
-     * @param tenantId - tenant id for client domain
-     * @param config - required [Configuration](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/src/config/Configuration.ts)
-     */
-    constructor(
-        readonly tenantId: string,
-        config: Configuration,
-    ) {
-        super(config);
+  }
+
+  /**
+   * Will try to silently acquire an access token for a given set of scopes.
+   * Will use cached token if available, otherwise will attempt to acquire a new token from the network via refresh token.
+   *
+   * @param silent
+   * Attempt to use a hidden iframe to fetch an authorization code from the eSTS if {@link AuthClient.account} or login hint.
+   * Provided {@link AuthBehavior} is used as fallback.
+   * There are cases where this may not work:
+   * - Any browser using a form of Intelligent Tracking Prevention
+   * - If there is not an established session with the service
+   *
+   * @returns
+   * Promise that is fulfilled when this function has completed, or rejected if an error was raised.
+   */
+  public async acquireToken(
+    options: AuthRequest = { scopes: [] },
+    behavior: AuthBehavior = defaultBehavior,
+    silent = true,
+  ): Promise<AuthenticationResult | void> {
+    const account = await this.account;
+    if (silent && account) {
+      this.logger.verbose('Attempting to acquire token in silently');
+      try {
+        const token = await this.acquireTokenSilent({ account, ...options });
+        return token;
+      } catch (err) {
+        this.logger.info('Expected to navigate away from the current page but timeout occurred.');
+      }
     }
 
-    /**
-     * @param silent
-     * Attempt to use a hidden iframe to fetch an authorization code from the eSTS if {@link AuthClient.account} or login hint.
-     * Provided {@link AuthBehavior} is used as fallback.
-     * There are cases where this may not work:
-     * - Any browser using a form of Intelligent Tracking Prevention
-     * - If there is not an established session with the service
-     *
-     * @returns
-     * Promise that is fulfilled when this function has completed, or rejected if an error was raised.
-     */
-    async login(
-        options?: AuthRequest,
-        behavior: AuthBehavior = defaultBehavior,
-        silent = true,
-    ): Promise<AuthenticationResult | void> {
-        const loginHint = options?.loginHint || this.account?.username;
-        const scopes = options?.scopes || [];
-        const request = { ...options, loginHint, scopes };
-
-        if (loginHint && silent) {
-            this.logger.verbose('Attempting to login in silently');
-            try {
-                const res = await this.ssoSilent(request as SsoSilentRequest);
-                return res;
-            } catch {
-                this.logger.verbose('Silent login attempt failed');
-            }
-        }
-
-        this.logger.verbose(`Attempting to login in by [${behavior}]`);
-
-        switch (behavior) {
-            case 'popup':
-                return this.loginPopup(request as PopupRequest);
-            case 'redirect': {
-                return this.loginRedirect(request as RedirectRequest);
-            }
-        }
-    }
+    this.logger.verbose(`Attempting to acquire token by [${behavior}]`);
 
-    /**
-     * Will try to silently acquire an access token for a given set of scopes.
-     * Will use cached token if available, otherwise will attempt to acquire a new token from the network via refresh token.
-     *
-     * @param silent
-     * Attempt to use a hidden iframe to fetch an authorization code from the eSTS if {@link AuthClient.account} or login hint.
-     * Provided {@link AuthBehavior} is used as fallback.
-     * There are cases where this may not work:
-     * - Any browser using a form of Intelligent Tracking Prevention
-     * - If there is not an established session with the service
-     *
-     * @returns
-     * Promise that is fulfilled when this function has completed, or rejected if an error was raised.
-     */
-    public async acquireToken(
-        options: AuthRequest = { scopes: [] },
-        behavior: AuthBehavior = defaultBehavior,
-        silent = true,
-    ): Promise<AuthenticationResult | void> {
-        const account = await this.account;
-        if (silent && account) {
-            this.logger.verbose('Attempting to acquire token in silently');
-            try {
-                const token = await this.acquireTokenSilent({ account, ...options });
-                return token;
-            } catch (err) {
-                this.logger.info(
-                    'Expected to navigate away from the current page but timeout occurred.',
-                );
-            }
-        }
-
-        this.logger.verbose(`Attempting to acquire token by [${behavior}]`);
-
-        switch (behavior) {
-            case 'popup':
-                return this.acquireTokenPopup(options);
-            case 'redirect': {
-                return this.acquireTokenRedirect(options);
-            }
-        }
+    switch (behavior) {
+      case 'popup':
+        return this.acquireTokenPopup(options);
+      case 'redirect': {
+        return this.acquireTokenRedirect(options);
+      }
     }
+  }
 }
 
 export default AuthClient;