@microsoft/agents-hosting/src/auth/connections.ts

Microsoft 365 Agents SDK for JavaScript

/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */

import { Activity } from '@microsoft/agents-activity'
import { AuthConfiguration } from './authConfiguration'
import { AuthProvider } from './authProvider'
import { JwtPayload } from 'jsonwebtoken'

export interface Connections {
  /**
 * Get the OAuth connection for the agent.
 * @param name - The connection name. Must match a configured OAuth connection.
 * @returns An AuthProvider instance.
 * @throws {Error} If the connection name is not found.
 */
  getConnection: (name: string) => AuthProvider

  /**
   * Get the default OAuth connection for the agent.
   * @returns An AuthProvider instance.
   */
  getDefaultConnection: () => AuthProvider

  /**
   * Get the OAuth token provider for the agent.
   * @param identity - The identity. Usually TurnContext.identity.
   * @param serviceUrl - The service url.
   * @returns An AuthProvider instance.
   */
  getTokenProvider: (identity: JwtPayload, serviceUrl: string) => AuthProvider

  /**
   * Get the OAuth token provider for the agent.
   * @param identity - The identity.  Usually TurnContext.identity.
   * @param activity - The activity.
   * @returns An AuthProvider instance.
   */
  getTokenProviderFromActivity: (identity: JwtPayload, activity: Activity) => AuthProvider

  /**
   * Get the default connection configuration for the agent.
   * @returns An Auth Configuration.
   */
  getDefaultConnectionConfiguration: () => AuthConfiguration
}