@microsoft/agents-hosting 0.5.4-ga4d0401645 → 0.5.12-g2d752e9b13

package/src/app/adaptiveCards/adaptiveCardsActions.ts

@@ -219,10 +219,10 @@ export class AdaptiveCardsActions<TState extends TurnState> {
               }
             }
 
-            await context.sendActivity({
+            await context.sendActivity(Activity.fromObject({
               value: { body: response, status: 200 } as InvokeResponse,
               type: ActivityTypes.InvokeResponse
-            } as Activity)
+            }))
           }
         },
         true
@@ -313,8 +313,8 @@ function createSearchSelector (dataset: string | RegExp | RouteSelector): RouteS
 }
 
 async function sendInvokeResponse (context: TurnContext, response: AdaptiveCardInvokeResponse) {
-  await context.sendActivity({
+  await context.sendActivity(Activity.fromObject({
     value: { body: response, status: 200 } as InvokeResponse,
     type: ActivityTypes.InvokeResponse
-  } as Activity)
+  }))
 }

package/src/app/agentApplication.ts

@@ -741,7 +741,7 @@ export class AgentApplication<TState extends TurnState> {
       const k = keyword.toString().toLocaleLowerCase()
       return (context: TurnContext) => {
         if (context?.activity?.type === ActivityTypes.Message && context.activity.text) {
-          return Promise.resolve(context.activity.text.toLocaleLowerCase().indexOf(k) >= 0)
+          return Promise.resolve(context.activity.text.toLocaleLowerCase() === k)
         } else {
           return Promise.resolve(false)
         }

package/src/app/oauth/authorization.ts

@@ -7,8 +7,7 @@ import { TurnContext } from '../../turnContext'
 import { debug } from '../../logger'
 import { TurnState } from '../turnState'
 import { Storage } from '../../storage'
-import { OAuthFlow, TokenRequestStatus, TokenResponse } from '../../oauth'
-import { UserState } from '../../state'
+import { OAuthFlow, TokenResponse } from '../../oauth'
 
 const logger = debug('agents:authorization')
 
@@ -48,11 +47,10 @@ export class Authorization {
    * @param {AuthorizationHandlers} authHandlers - Configuration for OAuth providers
    * @throws {Error} If storage is null/undefined or no auth handlers are provided
    */
-  constructor (storage: Storage, authHandlers: AuthorizationHandlers) {
+  constructor (private storage: Storage, authHandlers: AuthorizationHandlers) {
     if (storage === undefined || storage === null) {
       throw new Error('Storage is required for UserAuthorization')
     }
-    const userState = new UserState(storage)
     if (authHandlers === undefined || Object.keys(authHandlers).length === 0) {
       throw new Error('The authorization does not have any auth handlers')
     }
@@ -66,7 +64,7 @@ export class Authorization {
       currentAuthHandler.title = currentAuthHandler.title ?? process.env[ah + '_connectionTitle'] as string
       currentAuthHandler.text = currentAuthHandler.text ?? process.env[ah + '_connectionText'] as string
       currentAuthHandler.auto = currentAuthHandler.auto ?? process.env[ah + '_connectionAuto'] === 'true'
-      currentAuthHandler.flow = new OAuthFlow(userState, currentAuthHandler.name, null!, currentAuthHandler.title, currentAuthHandler.text)
+      currentAuthHandler.flow = new OAuthFlow(this.storage, currentAuthHandler.name, null!, currentAuthHandler.title, currentAuthHandler.text)
     }
     logger.info('Authorization handlers configured with', this._authHandlers.length, 'handlers')
   }
@@ -93,18 +91,18 @@ export class Authorization {
   public async beginOrContinueFlow (context: TurnContext, state: TurnState, authHandlerId?: string) : Promise<TokenResponse> {
     logger.info('beginOrContinueFlow for authHandlerId:', authHandlerId)
     const flow = this.resolverHandler(authHandlerId).flow!
-    let tokenResponse: TokenResponse
+    let tokenResponse: TokenResponse | undefined
     if (flow.state!.flowStarted === false) {
       tokenResponse = await flow.beginFlow(context)
     } else {
       tokenResponse = await flow.continueFlow(context)
-      if (tokenResponse.status === TokenRequestStatus.Success) {
+      if (tokenResponse && tokenResponse.token) {
         if (this._signInHandler) {
           await this._signInHandler(context, state, authHandlerId)
         }
       }
     }
-    return tokenResponse
+    return tokenResponse!
   }
 
   /**

package/src/app/streaming/citation.ts

@@ -0,0 +1,29 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Citations returned by the model.
+ */
+export interface Citation {
+  /**
+     * The content of the citation.
+     */
+  content: string;
+
+  /**
+     * The title of the citation.
+     */
+  title: string | null;
+
+  /**
+     * The URL of the citation.
+     */
+  url: string | null;
+
+  /**
+     * The filepath of the document.
+     */
+  filepath: string | null;
+}

package/src/app/streaming/{utilities.ts → citationUtil.ts}

@@ -3,48 +3,16 @@
  * Licensed under the MIT License.
  */
 
-import { ClientCitation } from './clientCitation'
+import { ClientCitation } from '@microsoft/agents-activity/src/entity/AIEntity'
 
 // import { stringify } from 'yaml'
 
 // import { Tokenizer } from './tokenizers'
 
 /**
- * Utility functions for manipulating .
+ * Utility functions for manipulating text and citations.
  */
-export class Utilities {
-//   /**
-//      * Converts a value to a string.
-//      * @remarks
-//      * Dates are converted to ISO strings and Objects are converted to JSON or YAML, whichever is shorter.
-//      * @param {Tokenizer} tokenizer Tokenizer to use for encoding.
-//      * @param {any} value Value to convert.
-//      * @param {boolean} asJSON Optional. If true objects will always be converted to JSON instead of YAML. Defaults to false.
-//      * @returns {string} Converted value.
-//      */
-//   public static toString (tokenizer: Tokenizer, value: any, asJSON: boolean = false): string {
-//     if (value === undefined || value === null) {
-//       return ''
-//     } else if (typeof value === 'object') {
-//       if (typeof value.toISOString === 'function') {
-//         return value.toISOString()
-//       } else if (asJSON) {
-//         return JSON.stringify(value)
-//       } else {
-//         // Return shorter version of object
-//         const asYaml = stringify(value)
-//         const asJSON = JSON.stringify(value)
-//         if (tokenizer.encode(asYaml).length <= tokenizer.encode(asJSON).length) {
-//           return asYaml
-//         } else {
-//           return asJSON
-//         }
-//       }
-//     } else {
-//       return value.toString()
-//     }
-//   }
-
+export class CitationUtil {
   /**
      *
      * Clips the text to a maximum length in case it exceeds the limit.

package/src/app/streaming/streamingResponse.ts

@@ -3,12 +3,14 @@
  * Licensed under the MIT License.
  */
 
-import { Activity, Attachment, Entity } from '@microsoft/agents-activity'
+import { Activity, addAIToActivity, Attachment, Entity } from '@microsoft/agents-activity'
 import { TurnContext } from '../../turnContext'
-import { ClientCitation } from './clientCitation'
-import { SensitivityUsageInfo } from './sensitivityUsageInfo'
-import { Citation } from './message'
-import { Utilities } from './utilities'
+import { Citation } from './citation'
+import { CitationUtil } from './citationUtil'
+import { debug } from '../../logger'
+import { ClientCitation, SensitivityUsageInfo } from '@microsoft/agents-activity/src/entity/AIEntity'
+
+const logger = debug('agents:streamingResponse')
 
 /**
  * A helper class for streaming responses to the client.
@@ -16,7 +18,7 @@ import { Utilities } from './utilities'
  * This class is used to send a series of updates to the client in a single response. The expected
  * sequence of calls is:
  *
- * `sendInformativeUpdate()`, `sendTextChunk()`, `sendTextChunk()`, ..., `endStream()`.
+ * `queueInformativeUpdate()`, `queueTextChunk()`, `queueTextChunk()`, ..., `endStream()`.
  *
  * Once `endStream()` is called, the stream is considered ended and no further updates can be sent.
  */
@@ -111,7 +113,7 @@ export class StreamingResponse {
     this._message += text
 
     // If there are citations, modify the content so that the sources are numbers instead of [doc1], [doc2], etc.
-    this._message = Utilities.formatCitationsResponse(this._message)
+    this._message = CitationUtil.formatCitationsResponse(this._message)
 
     // Queue the next chunk
     this.queueNextChunk()
@@ -168,7 +170,7 @@ export class StreamingResponse {
           appearance: {
             '@type': 'DigitalDocument',
             name: citation.title || `Document #${currPos + 1}`,
-            abstract: Utilities.snippet(citation.content, 477)
+            abstract: CitationUtil.snippet(citation.content, 477)
           }
         }
         currPos++
@@ -238,10 +240,11 @@ export class StreamingResponse {
         // Send final message
         return Activity.fromObject({
           type: 'message',
-          text: this._message,
+          text: this._message || 'end strean response',
           attachments: this._attachments,
           channelData: {
-            streamType: 'final'
+            streamType: 'final',
+            streamSequence: this._nextSequence++
           } as StreamingChannelData
         })
       } else {
@@ -267,8 +270,8 @@ export class StreamingResponse {
     // If there's no sync in progress, start one
     if (!this._queueSync) {
       this._queueSync = this.drainQueue().catch((err) => {
-        console.error(`Error occured when sending activity while streaming: "${err}".`)
-        throw err
+        logger.error(`Error occured when sending activity while streaming: "${err}".`)
+        // throw err
       })
     }
   }
@@ -282,12 +285,10 @@ export class StreamingResponse {
     // eslint-disable-next-line no-async-promise-executor
     return new Promise<void>(async (resolve, reject) => {
       try {
+        logger.debug(`Draining queue with ${this._queue.length} activities.`)
         while (this._queue.length > 0) {
-          // Get next activity from queue
           const factory = this._queue.shift()!
           const activity = factory()
-
-          // Send activity
           await this.sendActivity(activity)
         }
 
@@ -295,7 +296,6 @@ export class StreamingResponse {
       } catch (err) {
         reject(err)
       } finally {
-        // Queue is empty, mark as idle
         this._queueSync = undefined
       }
     })
@@ -323,7 +323,7 @@ export class StreamingResponse {
 
     if (this._citations && this._citations.length > 0 && !this._ended) {
       // Filter out the citations unused in content.
-      const currCitations = Utilities.getUsedCitations(this._message, this._citations) ?? undefined
+      const currCitations = CitationUtil.getUsedCitations(this._message, this._citations) ?? undefined
       activity.entities.push({
         type: 'https://schema.org/Message',
         '@type': 'Message',
@@ -347,21 +347,22 @@ export class StreamingResponse {
 
       // Add in Generated by AI
       if (this._enableGeneratedByAILabel) {
-        activity.entities.push({
-          type: 'https://schema.org/Message',
-          '@type': 'Message',
-          '@context': 'https://schema.org',
-          '@id': '',
-          additionalType: ['AIGeneratedContent'],
-          citation: this._citations && this._citations.length > 0 ? this._citations : [],
-          usageInfo: this._sensitivityLabel
-        } as unknown as Entity)
+        addAIToActivity(activity, this._citations, this._sensitivityLabel)
+        // activity.entities.push({
+        //   type: 'https://schema.org/Message',
+        //   '@type': 'Message',
+        //   '@context': 'https://schema.org',
+        //   '@id': '',
+        //   additionalType: ['AIGeneratedContent'],
+        //   citation: this._citations && this._citations.length > 0 ? this._citations : [],
+        //   usageInfo: this._sensitivityLabel
+        // } as unknown as Entity)
       }
     }
 
     // Send activity
     const response = await this._context.sendActivity(activity)
-    // await new Promise((resolve) => setTimeout(resolve, 1500))
+    await new Promise((resolve) => setTimeout(resolve, 1500))
 
     // Save assigned stream ID
     if (!this._streamId) {

package/src/cards/cardFactory.ts

@@ -13,8 +13,7 @@ import { O365ConnectorCard } from './o365ConnectorCard'
 import { ThumbnailCard } from './thumbnailCard'
 import { VideoCard } from './videoCard'
 import { CardImage } from './cardImage'
-import { OAuthCard } from '../oauth/oAuthCard'
-import { SigningResource } from '../oauth/signingResource'
+import { OAuthCard, SignInResource } from '../oauth/userTokenClient.types'
 import { SigninCard } from './signinCard'
 
 /**
@@ -218,7 +217,7 @@ export class CardFactory {
    * @param signingResource The signing resource.
    * @returns The OAuth card attachment.
    */
-  static oauthCard (connectionName: string, title: string, text: string, signingResource: SigningResource) : Attachment {
+  static oauthCard (connectionName: string, title: string, text: string, signingResource: SignInResource) : Attachment {
     const card: Partial<OAuthCard> = {
       buttons: [{
         type: ActionTypes.Signin,

package/src/oauth/index.ts

@@ -1,6 +1,3 @@
-export * from './oAuthCard'
-export * from './signingResource'
 export * from './userTokenClient'
-export * from './tokenExchangeRequest'
 export * from './oAuthFlow'
-export * from './tokenResponse'
+export * from './userTokenClient.types'

package/src/oauth/oAuthFlow.ts

@@ -4,20 +4,18 @@ import { debug } from './../logger'
 import { ActivityTypes, Attachment } from '@microsoft/agents-activity'
 import {
   CardFactory,
-  AgentStatePropertyAccessor,
-  UserState,
   TurnContext,
+  Storage,
   MessageFactory,
-  TokenExchangeRequest,
-  UserTokenClient
 } from '../'
-import { TokenRequestStatus, TokenResponse } from './tokenResponse'
+import { UserTokenClient } from './userTokenClient'
+import { TokenExchangeRequest, TokenResponse } from './userTokenClient.types'
 
 const logger = debug('agents:oauth-flow')
 
-export class FlowState {
-  public flowStarted: boolean = false
-  public flowExpires: number = 0
+export interface FlowState {
+  flowStarted: boolean,
+  flowExpires: number
 }
 
 interface TokenVerifyState {
@@ -35,12 +33,7 @@ export class OAuthFlow {
   /**
    * The current state of the OAuth flow.
    */
-  state: FlowState | null
-
-  /**
-   * The accessor for managing the flow state in user state.
-   */
-  flowStateAccessor: AgentStatePropertyAccessor<FlowState | null>
+  state: FlowState
 
   /**
    * The ID of the token exchange request, used to deduplicate requests.
@@ -66,9 +59,8 @@ export class OAuthFlow {
    * Creates a new instance of OAuthFlow.
    * @param userState The user state.
    */
-  constructor (userState: UserState, absOauthConnectionName: string, tokenClient?: UserTokenClient, cardTitle?: string, cardText?: string) {
-    this.state = new FlowState()
-    this.flowStateAccessor = userState.createProperty('flowState')
+  constructor (private storage: Storage, absOauthConnectionName: string, tokenClient?: UserTokenClient, cardTitle?: string, cardText?: string) {
+    this.state = { flowExpires: 0, flowStarted: false }
     this.absOauthConnectionName = absOauthConnectionName
     this.userTokenClient = tokenClient ?? null!
     this.cardTitle = cardTitle ?? this.cardTitle
@@ -97,7 +89,7 @@ export class OAuthFlow {
    * @param context The turn context.
    * @returns A promise that resolves to the user token.
    */
-  public async beginFlow (context: TurnContext): Promise<TokenResponse> {
+  public async beginFlow (context: TurnContext): Promise<TokenResponse | undefined> {
     this.state = await this.getUserState(context)
     if (this.absOauthConnectionName === '') {
       throw new Error('connectionName is not set')
@@ -105,27 +97,20 @@ export class OAuthFlow {
     logger.info('Starting OAuth flow for connectionName:', this.absOauthConnectionName)
     await this.initializeTokenClient(context)
 
-    const tokenResponse = await this.userTokenClient.getUserToken(this.absOauthConnectionName, context.activity.channelId!, context.activity.from?.id!)
-    if (tokenResponse?.status === TokenRequestStatus.Success) {
+    const act = context.activity
+    const output = await this.userTokenClient.getTokenOrSignInResource(act.from?.id!, this.absOauthConnectionName, act.channelId!, act.getConversationReference(), act.relatesTo!, undefined!)
+    if (output && output.tokenResponse) {
       this.state.flowStarted = false
       this.state.flowExpires = 0
-      await this.flowStateAccessor.set(context, this.state)
-      logger.info('User token retrieved successfully from service')
-      return tokenResponse
+      await this.storage.write({ [this.getFlowStateKey(context)]: this.state })
+      return output.tokenResponse
     }
-
-    const authConfig = context.adapter.authConfig
-    const signingResource = await this.userTokenClient.getSignInResource(authConfig.clientId!, this.absOauthConnectionName, context.activity.getConversationReference(), context.activity.relatesTo)
-    const oCard: Attachment = CardFactory.oauthCard(this.absOauthConnectionName, this.cardTitle, this.cardText, signingResource)
+    const oCard: Attachment = CardFactory.oauthCard(this.absOauthConnectionName, this.cardTitle, this.cardText, output.signInResource)
     await context.sendActivity(MessageFactory.attachment(oCard))
     this.state.flowStarted = true
     this.state.flowExpires = Date.now() + 30000
-    await this.flowStateAccessor.set(context, this.state)
-    logger.info('OAuth begin flow completed, waiting for user to sign in')
-    return {
-      token: undefined,
-      status: TokenRequestStatus.InProgress
-    }
+    await this.storage.write({ [this.getFlowStateKey(context)]: this.state })
+    return undefined
   }
 
   /**
@@ -140,7 +125,7 @@ export class OAuthFlow {
       logger.warn('Flow expired')
       this.state!.flowStarted = false
       await context.sendActivity(MessageFactory.text('Sign-in session expired. Please try again.'))
-      return { status: TokenRequestStatus.Expired, token: undefined }
+      return { token: undefined }
     }
     const contFlowActivity = context.activity
     if (contFlowActivity.type === ActivityTypes.Message) {
@@ -161,22 +146,22 @@ export class OAuthFlow {
       logger.info('Continuing OAuth flow with tokenExchange')
       const tokenExchangeRequest = contFlowActivity.value as TokenExchangeRequest
       if (this.tokenExchangeId === tokenExchangeRequest.id) { // dedupe
-        return { status: TokenRequestStatus.InProgress, token: undefined }
+        return { token: undefined }
       }
       this.tokenExchangeId = tokenExchangeRequest.id!
       const userTokenResp = await this.userTokenClient?.exchangeTokenAsync(contFlowActivity.from?.id!, this.absOauthConnectionName, contFlowActivity.channelId!, tokenExchangeRequest)
-      if (userTokenResp?.status === TokenRequestStatus.Success) {
+      if (userTokenResp && userTokenResp.token) {
         logger.info('Token exchanged')
         this.state!.flowStarted = false
-        await this.flowStateAccessor.set(context, this.state)
+        await this.storage.write({ [this.getFlowStateKey(context)]: this.state })
         return userTokenResp
       } else {
         logger.warn('Token exchange failed')
         this.state!.flowStarted = true
-        return { status: TokenRequestStatus.Failed, token: undefined }
+        return { token: undefined }
       }
     }
-    return { status: TokenRequestStatus.Failed, token: undefined }
+    return { token: undefined }
   }
 
   /**
@@ -189,7 +174,7 @@ export class OAuthFlow {
     await this.initializeTokenClient(context)
     await this.userTokenClient?.signOut(context.activity.from?.id as string, this.absOauthConnectionName, context.activity.channelId as string)
     this.state!.flowExpires = 0
-    await this.flowStateAccessor.set(context, this.state)
+    this.storage.write({ [this.getFlowStateKey(context)]: this.state })
     logger.info('User signed out successfully')
   }
 
@@ -199,10 +184,9 @@ export class OAuthFlow {
    * @returns A promise that resolves to the user state.
    */
   private async getUserState (context: TurnContext) {
-    let userProfile: FlowState | null = await this.flowStateAccessor.get(context, null)
-    if (userProfile === null) {
-      userProfile = new FlowState()
-    }
+    const key = this.getFlowStateKey(context)
+    const data = await this.storage.read([key])
+    const userProfile: FlowState = data[key] ?? { flowStarted: false, flowExpires: 0 }
     return userProfile
   }
 
@@ -210,7 +194,17 @@ export class OAuthFlow {
     if (this.userTokenClient === undefined || this.userTokenClient === null) {
       const scope = 'https://api.botframework.com'
       const accessToken = await context.adapter.authProvider.getAccessToken(context.adapter.authConfig, scope)
-      this.userTokenClient = new UserTokenClient(accessToken)
+      this.userTokenClient = new UserTokenClient(accessToken, context.adapter.authConfig.clientId!)
+    }
+  }
+
+  private getFlowStateKey (context: TurnContext): string {
+    const channelId = context.activity.channelId
+    const conversationId = context.activity.conversation?.id
+    const userId = context.activity.from?.id
+    if (!channelId || !conversationId || !userId) {
+      throw new Error('ChannelId, conversationId, and userId must be set in the activity')
     }
+    return `oauth/${channelId}/${conversationId}/${userId}/flowState`
   }
 }

package/src/oauth/userTokenClient.ts

@@ -2,12 +2,10 @@
 // Licensed under the MIT License.
 
 import axios, { AxiosInstance } from 'axios'
-import { SigningResource } from './signingResource'
 import { ConversationReference } from '@microsoft/agents-activity'
 import { debug } from '../logger'
-import { TokenExchangeRequest } from './tokenExchangeRequest'
 import { normalizeTokenExchangeState } from '../activityWireCompat'
-import { TokenRequestStatus, TokenResponse } from './tokenResponse'
+import { AadResourceUrls, SignInResource, TokenExchangeRequest, TokenOrSinginResourceResponse, TokenResponse, TokenStatus } from './userTokenClient.types'
 import { getProductInfo } from '../getProductInfo'
 
 const logger = debug('agents:user-token-client')
@@ -17,12 +15,14 @@ const logger = debug('agents:user-token-client')
  */
 export class UserTokenClient {
   client: AxiosInstance
-
+  msAppId: string
   /**
    * Creates a new instance of UserTokenClient.
    * @param token The token to use for authentication.
+   * @param msAppId The Microsoft application ID.
    */
-  constructor (token: string) {
+  constructor (token: string, appId: string) {
+    this.msAppId = appId
     const baseURL = 'https://api.botframework.com'
     const axiosInstance = axios.create({
       baseURL,
@@ -47,15 +47,12 @@ export class UserTokenClient {
     try {
       const params = { connectionName, channelId, userId, code }
       const response = await this.client.get('/api/usertoken/GetToken', { params })
-      return { ...response.data, status: TokenRequestStatus.Success }
+      return response.data as TokenResponse
     } catch (error: any) {
       if (error.response?.status !== 404) {
         logger.error(error)
       }
-      return {
-        status: TokenRequestStatus.Failed,
-        token: undefined
-      }
+      return { token: undefined }
     }
   }
 
@@ -81,24 +78,24 @@ export class UserTokenClient {
 
   /**
    * Gets the sign-in resource.
-   * @param appId The application ID.
-   * @param cnxName The connection name.
+   * @param msAppId The application ID.
+   * @param connectionName The connection name.
    * @param activity The activity.
    * @returns A promise that resolves to the signing resource.
    */
-  async getSignInResource (appId: string, cnxName: string, conversationReference: ConversationReference, relatesTo?: ConversationReference) : Promise<SigningResource> {
+  async getSignInResource (msAppId: string, connectionName: string, conversation: ConversationReference, relatesTo?: ConversationReference) : Promise<SignInResource> {
     try {
       const tokenExchangeState = {
-        connectionName: cnxName,
-        conversation: conversationReference,
+        connectionName,
+        conversation,
         relatesTo,
-        msAppId: appId
+        msAppId
       }
       const tokenExchangeStateNormalized = normalizeTokenExchangeState(tokenExchangeState)
       const state = Buffer.from(JSON.stringify(tokenExchangeStateNormalized)).toString('base64')
       const params = { state }
       const response = await this.client.get('/api/botsignin/GetSignInResource', { params })
-      return response.data as SigningResource
+      return response.data as SignInResource
     } catch (error: any) {
       logger.error(error)
       throw error
@@ -117,10 +114,56 @@ export class UserTokenClient {
     try {
       const params = { userId, connectionName, channelId }
       const response = await this.client.post('/api/usertoken/exchange', tokenExchangeRequest, { params })
-      return { ...response.data, status: TokenRequestStatus.Success }
+      return response.data as TokenResponse
     } catch (error: any) {
       logger.error(error)
-      return { status: TokenRequestStatus.Failed, token: undefined }
+      return { token: undefined }
     }
   }
+
+  /**
+   * Gets the token or sign-in resource.
+   * @param userId The user ID.
+   * @param connectionName The connection name.
+   * @param channelId The channel ID.
+   * @param conversation The conversation reference.
+   * @param relatesTo The related conversation reference.
+   * @param code The code.
+   * @param finalRedirect The final redirect URL.
+   * @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> {
+    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 })
+    return response.data as TokenOrSinginResourceResponse
+  }
+
+  /**
+   * Gets the token status.
+   * @param userId The user ID.
+   * @param channelId 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[]> {
+    const params = { userId, channelId, include }
+    const response = await this.client.get('/api/usertoken/GetTokenStatus', { params })
+    return response.data as TokenStatus[]
+  }
+
+  /**
+   * Gets the AAD tokens.
+   * @param userId The user ID.
+   * @param connectionName The connection name.
+   * @param channelId 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>> {
+    const params = { userId, connectionName, channelId }
+    const response = await this.client.post('/api/usertoken/GetAadTokens', resourceUrls, { params })
+    return response.data as Record<string, TokenResponse>
+  }
 }