Class MJAuthBaseAbstract

constructor

• new MJAuthBase(config: AngularAuthProviderConfig): MJAuthBase

  Parameters

  • config: AngularAuthProviderConfig

  Returns MJAuthBase

Abstract Readonlytype

initialPath

• get initialPath(): string | null

  Contains the initial path from window.location.pathname before any work was done by auth services

  Returns string | null

initialSearch

• get initialSearch(): string | null

  Contains the initial search/query string from window.location.search before any work was done by auth services

  Returns string | null

classifyError

• classifyError(error: unknown): StandardAuthError

  Classify an error into standard error type

  Converts provider-specific errors into semantic categories. Eliminates need for consumers to check error.name or error types.

  Parameters

  • error: unknown

  Returns StandardAuthError

  Example

  const authError = this.authBase.classifyError(err);
  if (authError.type === AuthErrorType.TOKEN_EXPIRED) {
    this.showMessage(authError.userMessage);
  }
  Copy

getIdToken

• getIdToken(): Promise<string | null>

  Get ID token string (primary token method)

  This is the clean abstraction - no provider-specific logic needed! Replaces the old pattern of: claims?.__raw || claims?.idToken

  Returns Promise<string | null>

  Example

  const token = await this.authBase.getIdToken();
  if (token) {
    setupGraphQLClient(token, apiUrl);
  }
  Copy

getProfilePictureUrl

• getProfilePictureUrl(): Promise<string | null>

  Get profile picture URL from auth provider

  Returns the user's profile picture URL if available from the auth provider. This abstracts away provider-specific logic:

  • Microsoft/MSAL: Fetches from Graph API
  • Auth0/Okta: Returns from user claims

  Returns Promise<string | null>

  Promise resolving to image URL or null if not available

  Example

  const pictureUrl = await this.authBase.getProfilePictureUrl();
  if (pictureUrl) {
    this.userAvatar = pictureUrl;
  }
  Copy

getRequiredConfig

• getRequiredConfig(): string[]

  Get required configuration fields

  Default implementation requires clientId. Subclasses can override to add provider-specific requirements.

  Returns string[]

GetSessionScope

• GetSessionScope(): SessionScope | null

  Returns any constraints this provider places on the session, or null for an unconstrained session. The host shell uses this to confine the UI (e.g. hide app-switching and lock to a single app for magic-link sessions).

  Default: unconstrained. Constrained providers override this.

  Returns SessionScope | null

getTokenInfo

• getTokenInfo(): Promise<StandardAuthToken | null>

  Get complete token information

  Returns full token details including expiration and scopes. Use this when you need more than just the token string.

  Returns Promise<StandardAuthToken | null>

getUserEmail

• getUserEmail(): Observable<string>

  Get user email as Observable stream

  Returns Observable<string>

getUserInfo

• getUserInfo(): Observable<StandardUserInfo | null>

  Get user info as Observable stream

  Returns standardized user info, hiding provider-specific claim structures. No more need for consumers to merge claims or check provider-specific fields!

  Returns Observable<StandardUserInfo | null>

AbstracthandleCallback

• handleCallback(): Promise<void>

  Handle OAuth callback

  Subclasses implement provider-specific callback handling.

  Returns Promise<void>

Abstractinitialize

• initialize(): Promise<void>

  Initialize the provider

  Subclasses should override to set up provider-specific initialization, handle redirect callbacks, restore sessions, etc.

  Returns Promise<void>

isAuthenticated

• isAuthenticated(): Observable<boolean>

  Check if user is authenticated (Observable stream)

  Returns a reactive stream that emits authentication state changes. Consumers can subscribe to react to login/logout events.

  Returns Observable<boolean>

login

• login(options?: Record<string, unknown>): Observable<void>

  Public login method with Observable wrapper for backward compatibility

  Consumers can use either:

  • await this.authBase.login() (Promise)
  • this.authBase.login().subscribe() (Observable)

  Parameters

  • Optionaloptions: Record<string, unknown>

  Returns Observable<void>

logout

• logout(): Promise<void>

  Logout — clears all MJ client-side caches then delegates to the provider.

  Cache clearing happens universally regardless of auth provider so that a subsequent login as a different user never sees the previous user's data. Providers that need to clear additional caches should override logoutInternal() and call super.logoutInternal() if applicable.

  Returns Promise<void>

refreshToken

• refreshToken(): Promise<StandardAuthToken>

  Refresh authentication token

  Attempts to obtain a fresh authentication token using the provider's refresh mechanism. If silent refresh fails due to session expiry, the provider will handle re-authentication automatically (which may involve redirecting to the auth provider's login page).

  Returns StandardAuthToken on success, or throws on complete failure.

  IMPORTANT: If the provider requires interactive re-authentication (redirect or popup), this method may never return. The app will reload after authentication completes and re-initialize with a fresh token.

  Returns Promise<StandardAuthToken>

  Promise resolving to StandardAuthToken or throws on failure

  Example

  const token = await this.authBase.refreshToken();
  return token.idToken; // Always succeeds or throws
  Copy

validateConfig

• validateConfig(config: Record<string, unknown>): boolean

  Validate provider configuration

  Checks that all required fields are present and non-empty. Subclasses can override to add custom validation logic.

  Parameters

  • config: Record<string, unknown>

  Returns boolean