@microsoft/agents-hosting 1.1.0-alpha.5 → 1.1.0-alpha.75

package/src/oauth/userTokenClient.ts

@@ -2,11 +2,14 @@
 // Licensed under the MIT License.
 
 import axios, { AxiosInstance } from 'axios'
-import { ConversationReference } from '@microsoft/agents-activity'
+import { Activity, ConversationReference } from '@microsoft/agents-activity'
 import { debug } from '@microsoft/agents-activity/logger'
 import { normalizeTokenExchangeState } from '../activityWireCompat'
 import { AadResourceUrls, SignInResource, TokenExchangeRequest, TokenOrSinginResourceResponse, TokenResponse, TokenStatus } from './userTokenClient.types'
 import { getProductInfo } from '../getProductInfo'
+import { AuthProvider, MsalTokenProvider } from '../auth'
+import { HeaderPropagationCollection } from '../headerPropagation'
+import { getTokenServiceEndpoint } from './customUserTokenAPI'
 
 const logger = debug('agents:user-token-client')
 
@@ -15,19 +18,31 @@ const logger = debug('agents:user-token-client')
  */
 export class UserTokenClient {
   client: AxiosInstance
+  private msAppId: string = ''
   /**
    * Creates a new instance of UserTokenClient.
    * @param msAppId The Microsoft application ID.
    */
-  constructor (private msAppId: string) {
-    const baseURL = 'https://api.botframework.com'
-    this.client = axios.create({
-      baseURL,
-      headers: {
-        Accept: 'application/json',
-        'User-Agent': getProductInfo(),
-      }
-    })
+  constructor (msAppId: string)
+  /**
+   * Creates a new instance of UserTokenClient.
+   * @param axiosInstance The axios instance.
+   */
+  constructor (axiosInstance: AxiosInstance)
+
+  constructor (param: string | AxiosInstance) {
+    if (typeof param === 'string') {
+      const baseURL = getTokenServiceEndpoint()
+      this.client = axios.create({
+        baseURL,
+        headers: {
+          Accept: 'application/json',
+          'User-Agent': getProductInfo(),
+        }
+      })
+    } else {
+      this.client = param
+    }
 
     this.client.interceptors.request.use((config) => {
       const { method, url, data, headers, params } = config
@@ -79,15 +94,47 @@ export class UserTokenClient {
       })
   }
 
+  /**
+   * Creates a new instance of UserTokenClient with authentication.
+   * @param baseURL - The base URL for the API.
+   * @param authConfig - The authentication configuration.
+   * @param authProvider - The authentication provider.
+   * @param scope - The scope for the authentication token.
+   * @param headers - Optional headers to propagate in the request.
+   * @returns A new instance of ConnectorClient.
+   */
+  static async createClientWithScope (
+    baseURL: string,
+    authProvider: AuthProvider,
+    scope: string,
+    headers?: HeaderPropagationCollection
+  ): Promise<UserTokenClient> {
+    // TODO: add header propagation logic
+    const axiosInstance = axios.create({
+      baseURL,
+      headers: {
+        Accept: 'application/json',
+        'Content-Type': 'application/json', // Required by transformRequest
+        'User-Agent': getProductInfo(),
+      },
+    })
+    const token = await (authProvider as MsalTokenProvider).getAccessToken(scope)
+    if (token.length > 1) {
+      axiosInstance.defaults.headers.common.Authorization = `Bearer ${token}`
+    }
+    return new UserTokenClient(axiosInstance)
+  }
+
   /**
    * Gets the user token.
    * @param connectionName The connection name.
-   * @param channelId The channel ID.
+   * @param channelIdComposite The channel ID.
    * @param userId The user ID.
    * @param code The optional code.
    * @returns A promise that resolves to the user token.
    */
-  async getUserToken (connectionName: string, channelId: string, userId: string, code?: string) : Promise<TokenResponse> {
+  async getUserToken (connectionName: string, channelIdComposite: string, userId: string, code?: string) : Promise<TokenResponse> {
+    const [channelId] = Activity.parseChannelId(channelIdComposite)
     const params = { connectionName, channelId, userId, code }
     const response = await this.client.get('/api/usertoken/GetToken', { params })
     if (response?.data) {
@@ -100,10 +147,11 @@ export class UserTokenClient {
    * Signs the user out.
    * @param userId The user ID.
    * @param connectionName The connection name.
-   * @param channelId The channel ID.
+   * @param channelIdComposite The channel ID.
    * @returns A promise that resolves when the sign-out operation is complete.
    */
-  async signOut (userId: string, connectionName: string, channelId: string) : Promise<void> {
+  async signOut (userId: string, connectionName: string, channelIdComposite: string) : Promise<void> {
+    const [channelId] = Activity.parseChannelId(channelIdComposite)
     const params = { userId, connectionName, channelId }
     const response = await this.client.delete('/api/usertoken/SignOut', { params })
     if (response.status !== 200) {
@@ -137,11 +185,12 @@ export class UserTokenClient {
    * Exchanges the token.
    * @param userId The user ID.
    * @param connectionName The connection name.
-   * @param channelId The channel ID.
+   * @param channelIdComposite The channel ID.
    * @param tokenExchangeRequest The token exchange request.
    * @returns A promise that resolves to the exchanged token.
    */
-  async exchangeTokenAsync (userId: string, connectionName: string, channelId: string, tokenExchangeRequest: TokenExchangeRequest) : Promise<TokenResponse> {
+  async exchangeTokenAsync (userId: string, connectionName: string, channelIdComposite: string, tokenExchangeRequest: TokenExchangeRequest) : Promise<TokenResponse> {
+    const [channelId] = Activity.parseChannelId(channelIdComposite)
     const params = { userId, connectionName, channelId }
     const response = await this.client.post('/api/usertoken/exchange', tokenExchangeRequest, { params })
     if (response?.data) {
@@ -155,7 +204,7 @@ export class UserTokenClient {
    * Gets the token or sign-in resource.
    * @param userId The user ID.
    * @param connectionName The connection name.
-   * @param channelId The channel ID.
+   * @param channelIdComposite The channel ID.
    * @param conversation The conversation reference.
    * @param relatesTo The related conversation reference.
    * @param code The code.
@@ -163,7 +212,8 @@ export class UserTokenClient {
    * @param fwdUrl The forward URL.
    * @returns A promise that resolves to the token or sign-in resource response.
    */
-  async getTokenOrSignInResource (userId: string, connectionName: string, channelId: string, conversation: ConversationReference, relatesTo: ConversationReference, code: string, finalRedirect: string = '', fwdUrl: string = '') : Promise<TokenOrSinginResourceResponse> {
+  async getTokenOrSignInResource (userId: string, connectionName: string, channelIdComposite: string, conversation: ConversationReference, relatesTo: ConversationReference, code: string, finalRedirect: string = '', fwdUrl: string = '') : Promise<TokenOrSinginResourceResponse> {
+    const [channelId] = Activity.parseChannelId(channelIdComposite)
     const state = Buffer.from(JSON.stringify({ conversation, relatesTo, connectionName, msAppId: this.msAppId })).toString('base64')
     const params = { userId, connectionName, channelId, state, code, finalRedirect, fwdUrl }
     const response = await this.client.get('/api/usertoken/GetTokenOrSignInResource', { params })
@@ -173,11 +223,12 @@ export class UserTokenClient {
   /**
    * Gets the token status.
    * @param userId The user ID.
-   * @param channelId The channel ID.
+   * @param channelIdComposite The channel ID.
    * @param include The optional include parameter.
    * @returns A promise that resolves to the token status.
    */
-  async getTokenStatus (userId: string, channelId: string, include: string = null!): Promise<TokenStatus[]> {
+  async getTokenStatus (userId: string, channelIdComposite: string, include: string = null!): Promise<TokenStatus[]> {
+    const [channelId] = Activity.parseChannelId(channelIdComposite)
     const params = { userId, channelId, include }
     const response = await this.client.get('/api/usertoken/GetTokenStatus', { params })
     return response.data as TokenStatus[]
@@ -187,11 +238,12 @@ export class UserTokenClient {
    * Gets the AAD tokens.
    * @param userId The user ID.
    * @param connectionName The connection name.
-   * @param channelId The channel ID.
+   * @param channelIdComposite The channel ID.
    * @param resourceUrls The resource URLs.
    * @returns A promise that resolves to the AAD tokens.
    */
-  async getAadTokens (userId: string, connectionName: string, channelId: string, resourceUrls: AadResourceUrls) : Promise<Record<string, TokenResponse>> {
+  async getAadTokens (userId: string, connectionName: string, channelIdComposite: string, resourceUrls: AadResourceUrls) : Promise<Record<string, TokenResponse>> {
+    const [channelId] = Activity.parseChannelId(channelIdComposite)
     const params = { userId, connectionName, channelId }
     const response = await this.client.post('/api/usertoken/GetAadTokens', resourceUrls, { params })
     return response.data as Record<string, TokenResponse>

package/src/oauth/userTokenClient.types.ts

@@ -20,19 +20,31 @@ export interface TokenResponse {
  */
 export interface TokenExchangeRequest {
   /**
-     * The URI for the token exchange request.
-     */
+   * The URI for the token exchange request.
+   */
   uri?: string;
-
   /**
-     * The token to be exchanged.
-     */
+   * The token to be exchanged.
+   */
   token?: string;
+}
 
+/**
+ * Represents the response for a token exchange invoke operation.
+ */
+export interface TokenExchangeInvokeResponse {
   /**
-     * The ID associated with the token exchange request.
-     */
-  id?: string;
+   * The connection name associated with the token exchange response.
+   */
+  connectionName: string
+  /**
+   * The ID associated with the token exchange response.
+   */
+  id?: string
+  /**
+   * (Optional) Details about any failure that occurred during the token exchange.
+   */
+  failureDetail?: string
 }
 
 /**

package/src/turnContext.ts

@@ -7,6 +7,7 @@ import { TurnContextStateCollection } from './turnContextStateCollection'
 import { AttachmentInfo } from './connector-client/attachmentInfo'
 import { AttachmentData } from './connector-client/attachmentData'
 import { StreamingResponse } from './app/streaming/streamingResponse'
+import { JwtPayload } from 'jsonwebtoken'
 
 /**
  * Defines a handler for processing and sending activities.
@@ -71,20 +72,23 @@ export class TurnContext {
   private readonly _turn = 'turn'
   private readonly _locale = 'locale'
   private readonly _streamingResponse: StreamingResponse
+  private readonly _identity?: JwtPayload
+
   /**
    * Initializes a new instance of the TurnContext class.
    *
    * @param adapterOrContext The adapter that created this context, or another TurnContext to clone
    * @param request The activity for the turn (required when first parameter is an adapter)
    */
-  constructor (adapterOrContext: BaseAdapter, request: Activity)
+  constructor (adapterOrContext: BaseAdapter, request: Activity, identity?: JwtPayload)
   constructor (adapterOrContext: TurnContext)
-  constructor (adapterOrContext: BaseAdapter | TurnContext, request?: Activity) {
+  constructor (adapterOrContext: BaseAdapter | TurnContext, request?: Activity, identity?: JwtPayload) {
     if (adapterOrContext instanceof TurnContext) {
       adapterOrContext.copyTo(this)
     } else {
       this._adapter = adapterOrContext
       this._activity = request as Activity
+      this._identity = identity as JwtPayload
     }
     this._streamingResponse = new StreamingResponse(this)
   }
@@ -246,6 +250,7 @@ export class TurnContext {
   }
 
   /**
+   * @deprecated This function will not be supported in future versions.  Use TurnContext.turnState.get<ConnectorClient>(CloudAdapter.ConnectorClientKey).
    * Uploads an attachment to the conversation.
    *
    * @param conversationId The ID of the conversation
@@ -253,20 +258,22 @@ export class TurnContext {
    * @returns A promise that resolves to the resource response
    */
   async uploadAttachment (conversationId: string, attachmentData: AttachmentData): Promise<ResourceResponse> {
-    return await this.adapter.uploadAttachment(conversationId, attachmentData)
+    return await this.adapter.uploadAttachment(this, conversationId, attachmentData)
   }
 
   /**
+   * @deprecated This function will not be supported in future versions.  Use TurnContext.turnState.get<ConnectorClient>(CloudAdapter.ConnectorClientKey).
    * Gets information about an attachment.
    *
    * @param attachmentId The ID of the attachment
    * @returns A promise that resolves to the attachment information
    */
   async getAttachmentInfo (attachmentId: string): Promise<AttachmentInfo> {
-    return await this.adapter.getAttachmentInfo(attachmentId)
+    return await this.adapter.getAttachmentInfo(this, attachmentId)
   }
 
   /**
+   * @deprecated This function will not be supported in future versions.  Use TurnContext.turnState.get<ConnectorClient>(CloudAdapter.ConnectorClientKey).
    * Gets the content of an attachment.
    *
    * @param attachmentId The ID of the attachment
@@ -274,7 +281,7 @@ export class TurnContext {
    * @returns A promise that resolves to a readable stream of the attachment content
    */
   async getAttachment (attachmentId: string, viewId: string): Promise<NodeJS.ReadableStream> {
-    return await this.adapter.getAttachment(attachmentId, viewId)
+    return await this.adapter.getAttachment(this, attachmentId, viewId)
   }
 
   /**
@@ -348,6 +355,10 @@ export class TurnContext {
     return this._activity as Activity
   }
 
+  get identity (): JwtPayload {
+    return this._identity as JwtPayload
+  }
+
   /**
    * Gets or sets whether the turn has sent a response to the user.
    *