@equinor/fusion-framework-module-msal 11.0.0 → 11.0.1

package/src/MsalProxyProvider.interface.ts

@@ -1,72 +0,0 @@
-import type { SemVer } from 'semver';
-import type { MsalModuleVersion } from './static';
-
-import type { IMsalProvider } from './MsalProvider.interface';
-import type { IMsalProvider as IMsalProvider_v2 } from './v2/MsalProvider.interface';
-
-/**
- * Type mapping between MSAL module versions and their corresponding provider interfaces.
- *
- * This mapping ensures type-safe creation of proxy providers for different MSAL versions.
- * Each version maps to its appropriate provider interface type.
- *
- * @internal
- */
-type ProxyProviderMap = {
-  [MsalModuleVersion.V2]: IMsalProvider_v2;
-  [MsalModuleVersion.V4]: IMsalProvider;
-  [MsalModuleVersion.V5]: IMsalProvider;
-};
-
-/**
- * Interface for providers that can create version-compatible proxy providers.
- *
- * This interface enables backward compatibility by allowing providers to create
- * proxies that adapt their API to match different MSAL version signatures. The proxy
- * wraps the v4 implementation and exposes it through older version interfaces.
- *
- * @remarks
- * This interface should ideally be defined in the @equinor/fusion-framework-module package
- * for broader framework compatibility.
- *
- * @property version - The semantic version of the provider
- * @property msalVersion - The MSAL module version enum value
- * @property createProxyProvider - Method to create a version-specific proxy provider
- *
- * @example
- * ```typescript
- * const provider: IMsalProvider = new MsalProvider(config);
- *
- * // Create a v2-compatible proxy
- * const v2Proxy = provider.createProxyProvider('2.0.0');
- * // v2Proxy now has v2-compatible method signatures
- * ```
- */
-export interface IProxyProvider {
-  /**
-   * The semantic version of the provider.
-   *
-   * This represents the actual version number of the MSAL implementation,
-   * following semantic versioning (semver) standards.
-   */
-  readonly version: string | SemVer;
-
-  /**
-   * The MSAL module version enum value indicating the API compatibility level.
-   *
-   * This property specifies which MSAL version's API surface this provider implements,
-   * allowing for version-specific behavior and proxy provider creation.
-   */
-  msalVersion: MsalModuleVersion;
-
-  /**
-   * Creates a proxy provider compatible with the specified MSAL version.
-   *
-   * The proxy adapts the provider's v4 API to match the requested version's interface,
-   * enabling backward compatibility during migration scenarios.
-   *
-   * @param version - Target version key (V2, V4, or Latest)
-   * @returns Proxy provider with version-specific type
-   */
-  createProxyProvider<T extends keyof ProxyProviderMap>(version: T): ProxyProviderMap[T];
-}

package/src/__tests__/MsalConfigurator.test.ts

@@ -1,222 +0,0 @@
-import type { ConfigBuilderCallbackArgs } from '@equinor/fusion-framework-module';
-import { CacheLookupPolicy } from '@azure/msal-browser';
-import { describe, expect, it, vi } from 'vitest';
-import type { IMsalClient } from '../MsalClient.interface';
-import { type MsalConfig, MsalConfigurator } from '../MsalConfigurator';
-
-const createConfigCallbackArgs = (): ConfigBuilderCallbackArgs => ({
-  config: {},
-  hasModule: vi.fn().mockReturnValue(false),
-  requireInstance: vi.fn(),
-});
-
-const createClient = (): IMsalClient => ({}) as IMsalClient;
-
-const createInitialConfig = (): Pick<MsalConfig, 'telemetry'> => ({
-  telemetry: {
-    metadata: {},
-    scope: [],
-  },
-});
-
-describe('MsalConfigurator', () => {
-  it('enriches a copy, leaving the declared client configuration untouched', async () => {
-    // A caller may reuse or assert on the object it passed, and the defaults
-    // applied here are derived — rewriting it behind their back is not ours to do
-    const declared = { auth: { clientId: 'my-app', tenantId: 'my-tenant' } };
-    const configurator = new MsalConfigurator();
-
-    configurator.setClientConfig(declared);
-
-    const config = await configurator.createConfigAsync(
-      createConfigCallbackArgs(),
-      createInitialConfig(),
-    );
-
-    expect(declared).toEqual({ auth: { clientId: 'my-app', tenantId: 'my-tenant' } });
-    expect(config.client?.tenantId).toBe('my-tenant');
-  });
-
-  it('setAuthCode should normalize surrounding whitespace', async () => {
-    const configurator = new MsalConfigurator();
-
-    configurator.setClient(createClient());
-    configurator.setAuthCode('  auth-code  ');
-
-    const config = await configurator.createConfigAsync(
-      createConfigCallbackArgs(),
-      createInitialConfig(),
-    );
-
-    expect(config.authCode).toBe('auth-code');
-  });
-
-  it('setAuthCode should allow clearing with undefined', async () => {
-    const configurator = new MsalConfigurator();
-
-    configurator.setClient(createClient());
-    configurator.setAuthCode('auth-code');
-    configurator.setAuthCode(undefined);
-
-    const config = await configurator.createConfigAsync(
-      createConfigCallbackArgs(),
-      createInitialConfig(),
-    );
-
-    expect(config.authCode).toBeUndefined();
-  });
-
-  it('setAuthCode should treat whitespace-only values as undefined', async () => {
-    const configurator = new MsalConfigurator();
-
-    configurator.setClient(createClient());
-    configurator.setAuthCode('   ');
-
-    const config = await configurator.createConfigAsync(
-      createConfigCallbackArgs(),
-      createInitialConfig(),
-    );
-
-    expect(config.authCode).toBeUndefined();
-  });
-
-  it('createConfigAsync should succeed when client is omitted', async () => {
-    const configurator = new MsalConfigurator();
-
-    const config = await configurator.createConfigAsync(
-      createConfigCallbackArgs(),
-      createInitialConfig(),
-    );
-
-    expect(config.client).toBeUndefined();
-  });
-
-  describe('_createClient', () => {
-    it('builds from the same resolved client config the real client would get', async () => {
-      // The mock relies on this: substituting the client must not also mean
-      // re-implementing authority, cache and telemetry resolution
-      const received: unknown[] = [];
-      class CustomConfigurator extends MsalConfigurator {
-        protected override async _createClient(config: MsalConfig): Promise<IMsalClient> {
-          received.push(this._createClientConfig(config));
-          return createClient();
-        }
-      }
-
-      const configurator = new CustomConfigurator();
-      configurator.setClientConfig({ auth: { clientId: 'client-id', tenantId: 'tenant-id' } });
-
-      await configurator.createConfigAsync(createConfigCallbackArgs(), createInitialConfig());
-
-      expect(received).toEqual([
-        expect.objectContaining({
-          auth: expect.objectContaining({
-            clientId: 'client-id',
-            // derived by the configurator, not by the caller
-            authority: 'https://login.microsoftonline.com/tenant-id',
-          }),
-          cache: { cacheLocation: 'localStorage' },
-        }),
-      ]);
-    });
-
-    it('supplies the client when none was set', async () => {
-      const client = createClient();
-      class CustomConfigurator extends MsalConfigurator {
-        protected override async _createClient(): Promise<IMsalClient> {
-          return client;
-        }
-      }
-
-      const config = await new CustomConfigurator().createConfigAsync(
-        createConfigCallbackArgs(),
-        createInitialConfig(),
-      );
-
-      expect(config.client).toBe(client);
-    });
-
-    it('is not consulted when a client was set, so setClient always wins', async () => {
-      const own = createClient();
-      const createOther = vi.fn().mockResolvedValue(createClient());
-      class CustomConfigurator extends MsalConfigurator {
-        protected override _createClient(): Promise<IMsalClient> {
-          return createOther();
-        }
-      }
-
-      const configurator = new CustomConfigurator();
-      configurator.setClient(own);
-
-      const config = await configurator.createConfigAsync(
-        createConfigCallbackArgs(),
-        createInitialConfig(),
-      );
-
-      expect(config.client).toBe(own);
-      expect(createOther).not.toHaveBeenCalled();
-    });
-
-    it('is not consulted when hoisted, so a host provider is never shadowed', async () => {
-      // A hoisted module authenticates through the host's provider, so anything
-      // built here would be discarded — or worse, shadow the host's user
-      const createOther = vi.fn().mockResolvedValue(createClient());
-      class CustomConfigurator extends MsalConfigurator {
-        protected override _createClient(): Promise<IMsalClient> {
-          return createOther();
-        }
-      }
-
-      const configurator = new CustomConfigurator();
-      configurator.setClientConfig({ auth: { clientId: 'client-id', tenantId: 'tenant-id' } });
-
-      const config = await configurator.createConfigAsync(
-        { ...createConfigCallbackArgs(), ref: { auth: {} } },
-        createInitialConfig(),
-      );
-
-      expect(config.client).toBeUndefined();
-      expect(createOther).not.toHaveBeenCalled();
-    });
-  });
-
-  describe('cacheLookupPolicy', () => {
-    it('defaults to CacheLookupPolicy.AccessTokenAndRefreshToken', async () => {
-      const configurator = new MsalConfigurator();
-      configurator.setClient(createClient());
-
-      const config = await configurator.createConfigAsync(
-        createConfigCallbackArgs(),
-        createInitialConfig(),
-      );
-
-      expect(config.cacheLookupPolicy).toBe(CacheLookupPolicy.AccessTokenAndRefreshToken);
-    });
-
-    it('setCacheLookupPolicy(undefined) clears the policy so MSAL default applies', async () => {
-      const configurator = new MsalConfigurator();
-      configurator.setClient(createClient());
-      configurator.setCacheLookupPolicy(undefined);
-
-      const config = await configurator.createConfigAsync(
-        createConfigCallbackArgs(),
-        createInitialConfig(),
-      );
-
-      expect(config.cacheLookupPolicy).toBeUndefined();
-    });
-
-    it('setCacheLookupPolicy overrides the default', async () => {
-      const configurator = new MsalConfigurator();
-      configurator.setClient(createClient());
-      configurator.setCacheLookupPolicy(CacheLookupPolicy.Default);
-
-      const config = await configurator.createConfigAsync(
-        createConfigCallbackArgs(),
-        createInitialConfig(),
-      );
-
-      expect(config.cacheLookupPolicy).toBe(CacheLookupPolicy.Default);
-    });
-  });
-});

package/src/__tests__/MsalProvider.test.ts

@@ -1,74 +0,0 @@
-import { describe, expect, it, vi } from 'vitest';
-import type { IMsalClient } from '../MsalClient.interface';
-import type { MsalConfig } from '../MsalConfigurator';
-import { MsalProvider } from '../MsalProvider';
-import type { AuthenticationResult } from '../types';
-
-type MockMsalClient = {
-  client: IMsalClient;
-  acquireTokenByCode: ReturnType<typeof vi.fn>;
-  initialize: ReturnType<typeof vi.fn>;
-};
-
-const createClient = (): MockMsalClient => {
-  const initialize = vi.fn(async () => undefined);
-  const acquireTokenByCode = vi.fn(async () => ({}) as AuthenticationResult);
-
-  return {
-    client: {
-      clientId: 'test-client-id',
-      initialize,
-      acquireTokenByCode,
-      setActiveAccount: vi.fn(),
-    } as unknown as IMsalClient,
-    acquireTokenByCode,
-    initialize,
-  };
-};
-
-const createConfig = (client: IMsalClient, authCode?: string): MsalConfig => ({
-  client,
-  version: '7.0.0',
-  requiresAuth: false,
-  authCode,
-  telemetry: {
-    metadata: { module: 'msal', version: '7.0.0' },
-    scope: ['framework', 'authentication'],
-  },
-});
-
-describe('MsalProvider.initialize', () => {
-  it('should not attempt auth code exchange when auth code is undefined', async () => {
-    const mockClient = createClient();
-
-    const provider = new MsalProvider(createConfig(mockClient.client, undefined));
-    await provider.initialize();
-
-    expect(mockClient.initialize).toHaveBeenCalledTimes(1);
-    expect(mockClient.acquireTokenByCode).not.toHaveBeenCalled();
-  });
-
-  it('should not attempt auth code exchange when auth code is whitespace-only', async () => {
-    const mockClient = createClient();
-
-    const provider = new MsalProvider(createConfig(mockClient.client, '   '));
-    await provider.initialize();
-
-    expect(mockClient.acquireTokenByCode).not.toHaveBeenCalled();
-  });
-
-  it('should exchange auth code once and clear it afterwards', async () => {
-    const mockClient = createClient();
-
-    const provider = new MsalProvider(createConfig(mockClient.client, 'auth-code'));
-
-    await provider.initialize();
-    await provider.initialize();
-
-    expect(mockClient.acquireTokenByCode).toHaveBeenCalledTimes(1);
-    expect(mockClient.acquireTokenByCode).toHaveBeenCalledWith({
-      code: 'auth-code',
-      scopes: ['test-client-id/.default'],
-    });
-  });
-});

package/src/__tests__/create-proxy-provider.test.ts

@@ -1,77 +0,0 @@
-import { describe, expect, it, vi } from 'vitest';
-import type { IMsalClient } from '../MsalClient.interface';
-import type { MsalConfig } from '../MsalConfigurator';
-import { MsalProvider } from '../MsalProvider';
-import { MsalModuleVersion } from '../static';
-import type { AuthenticationResult } from '../types';
-import type { IMsalProvider as IMsalProvider_v2 } from '../v2/MsalProvider.interface';
-
-type MockMsalClient = {
-  client: IMsalClient;
-  acquireToken: ReturnType<typeof vi.fn>;
-  handleRedirectPromise: ReturnType<typeof vi.fn>;
-};
-
-const createClient = (): MockMsalClient => {
-  const acquireToken = vi.fn(async () => ({ accessToken: 'v4-token' }) as AuthenticationResult);
-  const handleRedirectPromise = vi.fn(
-    async () => ({ accessToken: 'redirect-token' }) as AuthenticationResult,
-  );
-
-  return {
-    client: {
-      clientId: 'test-client-id',
-      initialize: vi.fn(async () => undefined),
-      acquireToken,
-      handleRedirectPromise,
-      setActiveAccount: vi.fn(),
-      getActiveAccount: vi.fn(() => null),
-    } as unknown as IMsalClient,
-    acquireToken,
-    handleRedirectPromise,
-  };
-};
-
-const createConfig = (client: IMsalClient): MsalConfig => ({
-  client,
-  version: '7.0.0',
-  requiresAuth: false,
-  telemetry: {
-    metadata: { module: 'msal', version: '7.0.0' },
-    scope: ['framework', 'authentication'],
-  },
-});
-
-describe('MsalProvider.createProxyProvider (v2)', () => {
-  it('tags the proxy as v2 while delegating through the same v4 provider', () => {
-    const mockClient = createClient();
-    const provider = new MsalProvider(createConfig(mockClient.client));
-
-    const v2Provider = provider.createProxyProvider<IMsalProvider_v2>(MsalModuleVersion.V2);
-
-    expect(v2Provider.msalVersion).toBe(MsalModuleVersion.V2);
-  });
-
-  it('adapts the legacy v2 acquireToken shape into a v4 request before delegating', async () => {
-    const mockClient = createClient();
-    const provider = new MsalProvider(createConfig(mockClient.client));
-    const v2Provider = provider.createProxyProvider<IMsalProvider_v2>(MsalModuleVersion.V2);
-
-    await expect(v2Provider.acquireToken({ scopes: ['User.Read'] })).resolves.toMatchObject({
-      accessToken: 'v4-token',
-    });
-
-    expect(mockClient.acquireToken).toHaveBeenCalledWith(
-      expect.objectContaining({ request: expect.objectContaining({ scopes: ['User.Read'] }) }),
-    );
-  });
-
-  it('discards the host’s redirect result, honoring v2’s null contract, while still processing it', async () => {
-    const mockClient = createClient();
-    const provider = new MsalProvider(createConfig(mockClient.client));
-    const v2Provider = provider.createProxyProvider<IMsalProvider_v2>(MsalModuleVersion.V2);
-
-    await expect(v2Provider.handleRedirect()).resolves.toBeNull();
-    expect(mockClient.handleRedirectPromise).toHaveBeenCalledTimes(1);
-  });
-});

package/src/__tests__/mock/create-mock-user-from-token.test.ts

@@ -1,46 +0,0 @@
-import { describe, expect, it } from 'vitest';
-
-import { createMockToken } from '../../mock/create-mock-token';
-import { createMockUserFromToken } from '../../mock/create-mock-user-from-token';
-
-describe('createMockUserFromToken', () => {
-  it('maps identity claims onto the matching MsalMockUser fields', () => {
-    const token = createMockToken({
-      name: 'Ada Lovelace',
-      preferred_username: 'ada@equinor.com',
-      oid: 'ada-object-id',
-      tid: 'ada-tenant-id',
-      scp: 'User.Read Files.Read',
-    });
-
-    expect(createMockUserFromToken(token)).toEqual({
-      name: 'Ada Lovelace',
-      username: 'ada@equinor.com',
-      userId: 'ada-object-id',
-      tenantId: 'ada-tenant-id',
-      scopes: ['User.Read', 'Files.Read'],
-    });
-  });
-
-  it('leaves a field undefined rather than fabricating one, when a claim is absent', () => {
-    const token = createMockToken({
-      name: undefined,
-      preferred_username: undefined,
-      scp: undefined,
-    });
-
-    const user = createMockUserFromToken(token);
-
-    expect(user.name).toBeUndefined();
-    expect(user.username).toBeUndefined();
-    expect(user.scopes).toBeUndefined();
-  });
-
-  it('throws for a token with no payload segment', () => {
-    expect(() => createMockUserFromToken('not-a-jwt')).toThrow(/payload segment/);
-  });
-
-  it('throws for an empty string', () => {
-    expect(() => createMockUserFromToken('')).toThrow(/payload segment/);
-  });
-});