@microsoft/agents-hosting 0.4.3 → 0.5.1-g2e246ff274

package/src/app/appRoute.ts

@@ -17,4 +17,10 @@ export interface AppRoute<TState extends TurnState> {
    * The handler function that processes the activity if the selector matches.
    */
   handler: RouteHandler<TState>;
+
+  /**
+   * Indicates whether this route is an invoke route.
+   * Invoke routes are used for specific types of activities, such as messaging extensions.
+   */
+  isInvokeRoute?: boolean;
 }

package/src/app/attachmentDownloader.ts

@@ -46,6 +46,7 @@ export class AttachmentDownloader<TState extends TurnState = TurnState> implemen
       return Promise.resolve([])
     }
 
+    // TODO: from adapter
     const authProvider: AuthProvider = new MsalTokenProvider()
 
     const accessToken = await authProvider.getAccessToken(loadAuthConfigFromEnv(), 'https://api.botframework.com')

package/src/app/extensions.ts

@@ -0,0 +1,19 @@
+import { TurnContext } from '../turnContext'
+import { AgentApplication } from './agentApplication'
+import { RouteHandler } from './routeHandler'
+import { RouteSelector } from './routeSelector'
+import { TurnState } from './turnState'
+
+export class AgentExtension<TState extends TurnState> {
+  channelId: string
+  constructor (channelId: string) {
+    this.channelId = channelId
+  }
+
+  addRoute (app: AgentApplication<TState>, routeSelector: RouteSelector, routeHandler: RouteHandler<TurnState>, isInvokeRoute: boolean = false) {
+    const ensureChannelMatches = async (context: TurnContext) => {
+      return context.activity.channelId === this.channelId && routeSelector(context)
+    }
+    app.addRoute(ensureChannelMatches, routeHandler)
+  }
+}

package/src/app/index.ts

@@ -12,3 +12,5 @@ export * from './turnEvents'
 export * from './turnStateEntry'
 export * from './inputFileDownloader'
 export * from './appMemory'
+export * from './extensions'
+export * from './adaptiveCards'

package/src/auth/jwt-middleware.ts

@@ -21,7 +21,7 @@ const logger = debug('agents:jwt-middleware')
 const verifyToken = async (raw: string, config: AuthConfiguration): Promise<JwtPayload> => {
   const getKey: GetPublicKeyOrSecret = (header: JwtHeader, callback: SignCallback) => {
     const payload = jwt.decode(raw) as JwtPayload
-
+    logger.info('jwt.decode ', JSON.stringify(payload))
     const jwksUri: string = payload.iss === 'https://api.botframework.com'
       ? 'https://login.botframework.com/v1/.well-known/keys'
       : `https://login.microsoftonline.com/${config.tenantId}/discovery/v2.0/keys`

package/src/baseAdapter.ts

@@ -175,12 +175,12 @@ export abstract class BaseAdapter {
 
     try {
       await this.middleware.run(pContext.proxy, async () => await next(pContext.proxy))
-    } catch (err) {
+    } catch (err: Error | any) {
       if (this.onTurnError) {
         if (err instanceof Error) {
           await this.onTurnError(pContext.proxy, err)
         } else {
-          throw new Error('Unknown error type')
+          throw new Error('Unknown error type: ' + err.message)
         }
       } else {
         throw err

package/src/cards/adaptiveCard.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Represents an Adaptive Card, which is a card framework that enables developers to exchange UI content in a common and consistent way.
+ * @see {@link https://learn.microsoft.com/adaptive-cards/ | Adaptive Cards Documentation}
+ */
+export interface AdaptiveCard {
+  /**
+   * The type of the card, which must always be 'AdaptiveCard'.
+   */
+  type: 'AdaptiveCard'
+  [key: string]: any
+}

package/src/cards/index.ts

@@ -16,3 +16,4 @@ export * from './taskModuleAction'
 export * from './thumbnailCard'
 export * from './videoCard'
 export * from './thumbnailUrl'
+export * from './adaptiveCard'

package/src/cloudAdapter.ts

@@ -198,25 +198,23 @@ export class CloudAdapter extends BaseAdapter {
     }
 
     logger.debug('Received activity: ', activity)
+    const context = this.createTurnContext(activity, logic)
+    const scope = request.user?.azp ?? request.user?.appid ?? 'https://api.botframework.com'
+    logger.debug('Creating connector client with scope: ', scope)
+    this.connectorClient = await this.createConnectorClient(activity.serviceUrl!, scope)
+    this.setConnectorClient(context)
 
     if (
       activity?.type === ActivityTypes.InvokeResponse ||
       activity?.type === ActivityTypes.Invoke ||
       activity?.deliveryMode === DeliveryModes.ExpectReplies
     ) {
-      const context = this.createTurnContext(activity, logic)
       await this.runMiddleware(context, logic)
       const invokeResponse = this.processTurnResults(context)
       logger.debug('Activity Response (invoke/expect replies): ', invokeResponse)
       return end(invokeResponse?.status ?? StatusCodes.OK, JSON.stringify(invokeResponse?.body), true)
     }
 
-    const scope = request.user?.azp ?? request.user?.appid ?? 'https://api.botframework.com'
-    logger.debug('Creating connector client with scope: ', scope)
-    this.connectorClient = await this.createConnectorClient(activity.serviceUrl!, scope)
-
-    const context = this.createTurnContext(activity, logic)
-    this.setConnectorClient(context)
     await this.runMiddleware(context, logic)
     const invokeResponse = this.processTurnResults(context)
 

package/src/connector-client/connectorClient.ts

@@ -3,7 +3,7 @@ import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios'
 import { AuthConfiguration } from '../auth/authConfiguration'
 import { AuthProvider } from '../auth/authProvider'
 import { debug } from '../logger'
-import { Activity, ConversationParameters } from '@microsoft/agents-activity'
+import { Activity, ChannelAccount, ConversationParameters } from '@microsoft/agents-activity'
 import { ConversationsResult } from './conversationsResult'
 import { ConversationResourceResponse } from './conversationResourceResponse'
 import { ResourceResponse } from './resourceResponse'
@@ -19,21 +19,21 @@ export { getProductInfo }
  * ConnectorClient is a client for interacting with the Microsoft Connector API.
  */
 export class ConnectorClient {
-  protected readonly client: AxiosInstance
+  protected readonly _axiosInstance: AxiosInstance
 
   /**
    * Private constructor for the ConnectorClient.
-   * @param client - The AxiosInstance to use for HTTP requests.
+   * @param axInstance - The AxiosInstance to use for HTTP requests.
    */
-  protected constructor (client: AxiosInstance) {
-    this.client = client
-    this.client.interceptors.response.use(
+  protected constructor (axInstance: AxiosInstance) {
+    this._axiosInstance = axInstance
+    this._axiosInstance.interceptors.response.use(
       (config) => {
         const { status, statusText, config: requestConfig } = config
         logger.debug('Response: ', {
           status,
           statusText,
-          host: this.client.getUri(),
+          host: this._axiosInstance.getUri(),
           url: requestConfig?.url,
           data: config.config.data,
           method: requestConfig?.method,
@@ -41,14 +41,14 @@ export class ConnectorClient {
         return config
       },
       (error) => {
-        const { code, message, stack } = error
+        const { code, message, stack, response } = error
         const errorDetails = {
           code,
-          host: this.client.getUri(),
+          host: this._axiosInstance.getUri(),
           url: error.config.url,
           method: error.config.method,
           data: error.config.data,
-          message,
+          message: message + JSON.stringify(response?.data),
           stack,
         }
         return Promise.reject(errorDetails)
@@ -56,6 +56,10 @@ export class ConnectorClient {
     )
   }
 
+  public get axiosInstance (): AxiosInstance {
+    return this._axiosInstance
+  }
+
   /**
    * Creates a new instance of ConnectorClient with authentication.
    * @param baseURL - The base URL for the API.
@@ -100,7 +104,22 @@ export class ConnectorClient {
       url: '/v3/conversations',
       params: continuationToken ? { continuationToken } : undefined
     }
-    const response = await this.client(config)
+    const response = await this._axiosInstance(config)
+    return response.data
+  }
+
+  public async getConversationMember (userId: string, conversationId: string): Promise<ChannelAccount> {
+    if (!userId || !conversationId) {
+      throw new Error('userId and conversationId are required')
+    }
+    const config: AxiosRequestConfig = {
+      method: 'get',
+      url: `v3/conversations/${conversationId}/members/${userId}`,
+      headers: {
+        'Content-Type': 'application/json'
+      }
+    }
+    const response = await this._axiosInstance(config)
     return response.data
   }
 
@@ -119,7 +138,7 @@ export class ConnectorClient {
       },
       data: body
     }
-    const response: AxiosResponse = await this.client(config)
+    const response: AxiosResponse = await this._axiosInstance(config)
     return response.data
   }
 
@@ -147,7 +166,7 @@ export class ConnectorClient {
       },
       data: body
     }
-    const response = await this.client(config)
+    const response = await this._axiosInstance(config)
     logger.info('Reply to conversation/activity: ', response.data.id!, activityId)
     return response.data
   }
@@ -174,7 +193,7 @@ export class ConnectorClient {
       },
       data: body
     }
-    const response = await this.client(config)
+    const response = await this._axiosInstance(config)
     return response.data
   }
 
@@ -201,7 +220,7 @@ export class ConnectorClient {
       },
       data: body
     }
-    const response = await this.client(config)
+    const response = await this._axiosInstance(config)
     return response.data
   }
 
@@ -225,7 +244,7 @@ export class ConnectorClient {
         'Content-Type': 'application/json'
       }
     }
-    const response = await this.client(config)
+    const response = await this._axiosInstance(config)
     return response.data
   }
 
@@ -250,7 +269,7 @@ export class ConnectorClient {
       },
       data: body
     }
-    const response = await this.client(config)
+    const response = await this._axiosInstance(config)
     return response.data
   }
 
@@ -272,7 +291,7 @@ export class ConnectorClient {
         'Content-Type': 'application/json'
       }
     }
-    const response = await this.client(config)
+    const response = await this._axiosInstance(config)
     return response.data
   }
 
@@ -299,7 +318,7 @@ export class ConnectorClient {
         'Content-Type': 'application/json'
       }
     }
-    const response = await this.client(config)
+    const response = await this._axiosInstance(config)
     return response.data
   }
 }