Interface IAngularAuthProvider

Readonlytype

classifyError

• classifyError(error: unknown): StandardAuthError

  Classify an error into a standard error type

  This method converts provider-specific errors into semantic error types that application code can handle consistently. Eliminates the need for consumers to check provider-specific error names like 'BrowserAuthError'.

  Parameters

  • error: unknown

    The error to classify (can be any type)

  Returns StandardAuthError

  StandardAuthError with categorized error type

  Example

  try {
    await this.authBase.login();
  } catch (err) {
    const authError = this.authBase.classifyError(err);
  
    switch (authError.type) {
      case AuthErrorType.TOKEN_EXPIRED:
        // Show "session expired" message
        break;
      case AuthErrorType.USER_CANCELLED:
        // User cancelled - don't show error
        break;
      default:
        // Show generic error
        alert(authError.userMessage);
    }
  }
  Copy

getIdToken

• getIdToken(): Promise<string | null>

  Get the current ID token as a string

  This is the primary method applications should use to get the token for backend API calls. It abstracts away provider-specific token storage (Auth0's __raw vs MSAL's idToken).

  Returns Promise<string | null>

  Promise resolving to the ID token string, or null if not authenticated

  Example

  const token = await this.authBase.getIdToken();
  if (token) {
    // Use token for GraphQL or REST API calls
    setupGraphQLClient(token, apiUrl);
  }
  Copy

getRequiredConfig

• getRequiredConfig(): string[]

  Get list of required configuration fields for this provider

  Returns string[]

  Array of required config field names

  Example

  // Auth0 requires: ['clientId', 'domain']
  // MSAL requires: ['clientId', 'tenantId']
  Copy

getTokenInfo

• getTokenInfo(): Promise<StandardAuthToken | null>

  Get complete token information

  Returns a standardized token object with ID token, access token, and expiration. Use this when you need more than just the token string.

  Returns Promise<StandardAuthToken | null>

  Promise resolving to StandardAuthToken or null if not authenticated

  Example

  const tokenInfo = await this.authBase.getTokenInfo();
  if (tokenInfo) {
    console.log(`Token expires at: ${new Date(tokenInfo.expiresAt)}`);
  }
  Copy

getUserEmail

• getUserEmail(): Observable<string>

  Observable stream of user's email address

  Emits email string when authenticated, empty string otherwise.

  Returns Observable<string>

  Example

  this.userEmail$ = this.authBase.getUserEmail();
  Copy

getUserInfo

• getUserInfo(): Observable<StandardUserInfo | null>

  Observable stream of user profile information

  Emits StandardUserInfo when authenticated, null otherwise. This replaces the old getUserProfile() which returned 'any'.

  Returns Observable<StandardUserInfo | null>

  Example

  this.authBase.getUserInfo().subscribe(user => {
    if (user) {
      console.log(`Welcome ${user.name}!`);
    }
  });
  Copy

handleCallback

• handleCallback(): Promise<void>

  Handle OAuth callback after redirect

  This is called automatically by the redirect component. Application code typically doesn't need to call this directly.

  Returns Promise<void>

initialize

• initialize(): Promise<void>

  Initialize the authentication provider

  This should handle callback processing, session restoration, etc. Called automatically during app startup.

  Returns Promise<void>

isAuthenticated

• isAuthenticated(): Observable<boolean>

  Observable stream of authentication state

  Emits true when user is authenticated, false otherwise. Subscribe to this for reactive UI updates.

  Returns Observable<boolean>

  Example

  this.authBase.isAuthenticated().subscribe(isAuth => {
    this.showLoginButton = !isAuth;
  });
  Copy

login

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

  Initiate login flow

  Parameters

  • Optionaloptions: Record<string, unknown>

    Optional provider-specific login options

  Returns Promise<void> | Observable<void>

  Observable for backward compatibility, can also return Promise

  Example

  await this.authBase.login({ appState: { target: '/dashboard' } });
  Copy

logout

• logout(): Promise<void>

  Log out the current user

  Clears local session and redirects to provider's logout endpoint.

  Returns Promise<void>

  Example

  await this.authBase.logout();
  Copy

refreshToken

• refreshToken(): Promise<StandardAuthToken>

  Refresh the current 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 a fresh token 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

  Parameters

  • config: Record<string, unknown>

    Configuration object to validate

  Returns boolean

  True if configuration is valid