@microsoft/agents-hosting-extensions-msteams 1.7.2

package/src/messageExtensions/messageExtension.ts

@@ -0,0 +1,370 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { Activity, ActivityTypes } from '@microsoft/agents-activity'
+import { AgentApplication, RouteHandler, RouteRank, RouteSelector, TurnContext, TurnState } from '@microsoft/agents-hosting'
+import type { AppBasedLinkQuery, MessagingExtensionAction, MessagingExtensionActionResponse, MessagingExtensionQuery, MessagingExtensionResponse } from '@microsoft/teams.api'
+import { z } from 'zod'
+import { messagingExtensionQueryZodSchema } from './messagingExtensionQuery'
+import { TeamsTurnContext } from '../teamsTurnContext'
+
+const appBasedLinkQuerySchema = z.object({
+  url: z.string().optional(),
+  state: z.string().optional()
+}).passthrough()
+
+function parseAppBasedLinkQuery (value: unknown): AppBasedLinkQuery | undefined {
+  if (value == null) return undefined
+  return appBasedLinkQuerySchema.parse(value) as AppBasedLinkQuery
+}
+
+function matchesCommandId (context: TurnContext, commandId: string | RegExp): boolean {
+  const activityCommandId = (context.activity.value as any)?.commandId
+  if (activityCommandId == null) return false
+  return typeof commandId === 'string'
+    ? activityCommandId === commandId
+    : commandId.test(activityCommandId)
+}
+
+function matchesPreviewAction (context: TurnContext, previewAction: 'edit' | 'send'): boolean {
+  const activityPreviewAction = (context.activity.value as any)?.botMessagePreviewAction
+  return typeof activityPreviewAction !== 'string' ||
+    activityPreviewAction.length === 0 ||
+    activityPreviewAction.toLowerCase() === previewAction
+}
+
+function getActivityPreview (action: MessagingExtensionAction): Activity | undefined {
+  const activityPreview = action.botActivityPreview?.[0]
+  return activityPreview != null ? Activity.fromObject(activityPreview) : undefined
+}
+
+type RouteQueryHandler<TState extends TurnState> = (context: TeamsTurnContext, state: TState, query: MessagingExtensionQuery) => Promise<MessagingExtensionResponse>
+type SelectItemHandler<TState extends TurnState, TData = unknown> = (context: TeamsTurnContext, state: TState, item: TData) => Promise<MessagingExtensionResponse>
+type QueryLinkHandler<TState extends TurnState> = (context: TeamsTurnContext, state: TState, query: AppBasedLinkQuery | undefined) => Promise<MessagingExtensionResponse>
+type FetchActionHandler<TState extends TurnState> = (context: TeamsTurnContext, state: TState, action: MessagingExtensionAction) => Promise<MessagingExtensionActionResponse>
+type SubmitActionHandler<TState extends TurnState> = (context: TeamsTurnContext, state: TState, action: MessagingExtensionAction) => Promise<MessagingExtensionActionResponse>
+type MessagePreviewEditHandler<TState extends TurnState> = (context: TeamsTurnContext, state: TState, activity: Activity | undefined) => Promise<MessagingExtensionActionResponse>
+type MessagePreviewSendHandler<TState extends TurnState> = (context: TeamsTurnContext, state: TState, activity: Activity | undefined) => Promise<void>
+type QuerySettingUrlHandler<TState extends TurnState> = (context: TeamsTurnContext, state: TState) => Promise<MessagingExtensionResponse>
+type SettingHandler<TState extends TurnState> = (context: TeamsTurnContext, state: TState, settings: MessagingExtensionQuery) => Promise<MessagingExtensionResponse>
+type CardButtonClickedHandler<TState extends TurnState, TData = unknown> = (context: TeamsTurnContext, state: TState, cardData: TData) => Promise<void>
+
+/**
+ * Registers handlers for Microsoft Teams message extension invokes.
+ *
+ * @typeParam TState - The turn state type used by the agent application.
+ */
+export class MessageExtension<TState extends TurnState> {
+  _app: AgentApplication<TState>
+
+  /**
+   * Creates a Teams message extension route helper.
+   *
+   * @param app - The agent application that receives the registered routes.
+   */
+  constructor (app: AgentApplication<TState>) {
+    this._app = app
+  }
+
+  /**
+   * Registers a handler for compose extension query invokes.
+   *
+   * @param commandId - Command ID or regular expression used to match the query command.
+   * @param handler - Handler invoked with the parsed messaging extension query.
+   * @param rank - Optional route rank used for route ordering.
+   * @param authHandlers - Optional authorization handlers required by the route.
+   * @returns This message extension helper for chaining.
+   */
+  onQuery (commandId: string | RegExp, handler: RouteQueryHandler<TState>, rank: number = RouteRank.Unspecified, authHandlers: string[] = []) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Invoke &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'composeExtension/query' &&
+        matchesCommandId(context, commandId)
+      )
+    }
+    const routeHandler: RouteHandler<TState> = async (context: TurnContext, state: TState) => {
+      const messageExtensionQuery: MessagingExtensionQuery = messagingExtensionQueryZodSchema.parse(context.activity.value)
+      const response: MessagingExtensionResponse = await handler(new TeamsTurnContext(context), state, messageExtensionQuery)
+      const invokeResponse = new Activity(ActivityTypes.InvokeResponse)
+      invokeResponse.value = { status: 200, body: response }
+      await context.sendActivity(invokeResponse)
+    }
+    this._app.addRoute(routeSel, routeHandler, true, rank, authHandlers)
+    return this
+  }
+
+  /**
+   * Registers a handler for compose extension select item invokes.
+   *
+   * @param handler - Handler invoked with the selected item payload.
+   * @param rank - Optional route rank used for route ordering.
+   * @param authHandlers - Optional authorization handlers required by the route.
+   * @returns This message extension helper for chaining.
+   */
+  onSelectItem<TData = unknown> (handler: SelectItemHandler<TState, TData>, rank: number = RouteRank.Unspecified, authHandlers: string[] = []) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Invoke &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'composeExtension/selectItem'
+      )
+    }
+    const routeHandler: RouteHandler<TState> = async (context: TurnContext, state: TState) => {
+      const response: MessagingExtensionResponse = await handler(new TeamsTurnContext(context), state, context.activity.value as TData)
+      const invokeResponse = new Activity(ActivityTypes.InvokeResponse)
+      invokeResponse.value = { status: 200, body: response }
+      await context.sendActivity(invokeResponse)
+    }
+    this._app.addRoute(routeSel, routeHandler, true, rank, authHandlers)
+    return this
+  }
+
+  /**
+   * Registers a handler for app-based link query invokes.
+   *
+   * @param handler - Handler invoked with the app-based link query payload.
+   * @param rank - Optional route rank used for route ordering.
+   * @param authHandlers - Optional authorization handlers required by the route.
+   * @returns This message extension helper for chaining.
+   */
+  onQueryLink (handler: QueryLinkHandler<TState>, rank: number = RouteRank.Unspecified, authHandlers: string[] = []) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Invoke &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'composeExtension/queryLink'
+      )
+    }
+    const routeHandler: RouteHandler<TState> = async (context: TurnContext, state: TState) => {
+      const query = parseAppBasedLinkQuery(context.activity.value)
+      const response: MessagingExtensionResponse = await handler(new TeamsTurnContext(context), state, query)
+      const invokeResponse = Activity.fromObject({ type: ActivityTypes.InvokeResponse, value: { status: 200, body: response } })
+      await context.sendActivity(invokeResponse)
+    }
+    this._app.addRoute(routeSel, routeHandler, true, rank, authHandlers)
+    return this
+  }
+
+  /**
+   * Registers a handler for anonymous app-based link query invokes.
+   *
+   * @param handler - Handler invoked with the app-based link query payload, when present.
+   * @param rank - Optional route rank used for route ordering.
+   * @param authHandlers - Optional authorization handlers required by the route.
+   * @returns This message extension helper for chaining.
+   */
+  onAnonymousQueryLink (handler: QueryLinkHandler<TState>, rank: number = RouteRank.Unspecified, authHandlers: string[] = []) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Invoke &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'composeExtension/anonymousQueryLink'
+      )
+    }
+    const routeHandler: RouteHandler<TState> = async (context: TurnContext, state: TState) => {
+      const query = parseAppBasedLinkQuery(context.activity.value)
+      const response: MessagingExtensionResponse = await handler(new TeamsTurnContext(context), state, query)
+      const invokeResponse = Activity.fromObject({ type: ActivityTypes.InvokeResponse, value: { status: 200, body: response } })
+      await context.sendActivity(invokeResponse)
+    }
+    this._app.addRoute(routeSel, routeHandler, true, rank, authHandlers)
+    return this
+  }
+
+  /**
+   * Registers a handler for compose extension fetch task invokes.
+   *
+   * @param commandId - Command ID or regular expression used to match the action command.
+   * @param handler - Handler invoked with the messaging extension action payload.
+   * @param rank - Optional route rank used for route ordering.
+   * @param authHandlers - Optional authorization handlers required by the route.
+   * @returns This message extension helper for chaining.
+   */
+  onFetchAction (commandId: string | RegExp, handler: FetchActionHandler<TState>, rank: number = RouteRank.Unspecified, authHandlers: string[] = []) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Invoke &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'composeExtension/fetchTask' &&
+        matchesCommandId(context, commandId)
+      )
+    }
+    const routeHandler: RouteHandler<TState> = async (context: TurnContext, state: TState) => {
+      const actionResponse: MessagingExtensionActionResponse = await handler(new TeamsTurnContext(context), state, context.activity.value as MessagingExtensionAction)
+      const invokeResponse = new Activity(ActivityTypes.InvokeResponse)
+      invokeResponse.value = { status: 200, body: actionResponse }
+      await context.sendActivity(invokeResponse)
+    }
+    this._app.addRoute(routeSel, routeHandler, true, rank, authHandlers)
+    return this
+  }
+
+  /**
+   * Registers a handler for compose extension submit action invokes.
+   *
+   * @param commandId - Command ID or regular expression used to match the action command.
+   * @param handler - Handler invoked with the messaging extension action payload.
+   * @param rank - Optional route rank used for route ordering.
+   * @param authHandlers - Optional authorization handlers required by the route.
+   * @returns This message extension helper for chaining.
+   */
+  onSubmitAction (commandId: string | RegExp, handler: SubmitActionHandler<TState>, rank: number = RouteRank.Unspecified, authHandlers: string[] = []) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Invoke &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'composeExtension/submitAction' &&
+        matchesCommandId(context, commandId)
+      )
+    }
+    const routeHandler: RouteHandler<TState> = async (context: TurnContext, state: TState) => {
+      const response: MessagingExtensionActionResponse = await handler(new TeamsTurnContext(context), state, context.activity.value as MessagingExtensionAction)
+      const invokeResponse = new Activity(ActivityTypes.InvokeResponse)
+      invokeResponse.value = { status: 200, body: response }
+      await context.sendActivity(invokeResponse)
+    }
+    this._app.addRoute(routeSel, routeHandler, true, rank, authHandlers)
+    return this
+  }
+
+  /**
+   * Registers a handler for message preview edit submit action invokes.
+   *
+   * @param commandId - Command ID or regular expression used to match the action command.
+   * @param handler - Handler invoked with the preview activity, when present.
+   * @param rank - Optional route rank used for route ordering.
+   * @param authHandlers - Optional authorization handlers required by the route.
+   * @returns This message extension helper for chaining.
+   */
+  onMessagePreviewEdit (commandId: string | RegExp, handler: MessagePreviewEditHandler<TState>, rank: number = RouteRank.Unspecified, authHandlers: string[] = []) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(!!(
+        context.activity.type === ActivityTypes.Invoke &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'composeExtension/submitAction' &&
+        matchesPreviewAction(context, 'edit') &&
+        matchesCommandId(context, commandId)
+      ))
+    }
+    const routeHandler: RouteHandler<TState> = async (context: TurnContext, state: TState) => {
+      const activity = getActivityPreview(context.activity.value as MessagingExtensionAction)
+      const response: MessagingExtensionActionResponse = await handler(new TeamsTurnContext(context), state, activity)
+      const invokeResponse = new Activity(ActivityTypes.InvokeResponse)
+      invokeResponse.value = { status: 200, body: response }
+      await context.sendActivity(invokeResponse)
+    }
+    this._app.addRoute(routeSel, routeHandler, true, rank, authHandlers)
+    return this
+  }
+
+  /**
+   * Registers a handler for message preview send submit action invokes.
+   *
+   * @param commandId - Command ID or regular expression used to match the action command.
+   * @param handler - Handler invoked with the preview activity, when present.
+   * @param rank - Optional route rank used for route ordering.
+   * @param authHandlers - Optional authorization handlers required by the route.
+   * @returns This message extension helper for chaining.
+   */
+  onMessagePreviewSend (commandId: string | RegExp, handler: MessagePreviewSendHandler<TState>, rank: number = RouteRank.Unspecified, authHandlers: string[] = []) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(!!(
+        context.activity.type === ActivityTypes.Invoke &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'composeExtension/submitAction' &&
+        matchesPreviewAction(context, 'send') &&
+        matchesCommandId(context, commandId)
+      ))
+    }
+    const routeHandler: RouteHandler<TState> = async (context: TurnContext, state: TState) => {
+      const msgExtensionAction = context.activity.value as MessagingExtensionAction
+      const activityPreview = getActivityPreview(msgExtensionAction)
+      await handler(new TeamsTurnContext(context), state, activityPreview)
+      const invokeResponse = new Activity(ActivityTypes.InvokeResponse)
+      invokeResponse.value = { status: 200, body: {} }
+      await context.sendActivity(invokeResponse)
+    }
+    this._app.addRoute(routeSel, routeHandler, true, rank, authHandlers)
+    return this
+  }
+
+  /**
+   * Registers a handler for compose extension query setting URL invokes.
+   *
+   * @param handler - Handler invoked when Teams requests a settings URL.
+   * @param rank - Optional route rank used for route ordering.
+   * @param authHandlers - Optional authorization handlers required by the route.
+   * @returns This message extension helper for chaining.
+   */
+  onQuerySettingUrl (handler: QuerySettingUrlHandler<TState>, rank: number = RouteRank.Unspecified, authHandlers: string[] = []) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Invoke &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'composeExtension/querySettingUrl'
+      )
+    }
+    const routeHandler: RouteHandler<TState> = async (context: TurnContext, state: TState) => {
+      const response: MessagingExtensionResponse = await handler(new TeamsTurnContext(context), state)
+      const invokeResponse = new Activity(ActivityTypes.InvokeResponse)
+      invokeResponse.value = { status: 200, body: response }
+      await context.sendActivity(invokeResponse)
+    }
+    this._app.addRoute(routeSel, routeHandler, true, rank, authHandlers)
+    return this
+  }
+
+  /**
+   * Registers a handler for compose extension setting invokes.
+   *
+   * @param handler - Handler invoked with the messaging extension settings payload.
+   * @param rank - Optional route rank used for route ordering.
+   * @param authHandlers - Optional authorization handlers required by the route.
+   * @returns This message extension helper for chaining.
+   */
+  onSetting (handler: SettingHandler<TState>, rank: number = RouteRank.Unspecified, authHandlers: string[] = []) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Invoke &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'composeExtension/setting'
+      )
+    }
+    const routeHandler: RouteHandler<TState> = async (context: TurnContext, state: TState) => {
+      const response: MessagingExtensionResponse = await handler(new TeamsTurnContext(context), state, context.activity.value as MessagingExtensionQuery)
+      const invokeResponse = new Activity(ActivityTypes.InvokeResponse)
+      invokeResponse.value = { status: 200, body: response }
+      await context.sendActivity(invokeResponse)
+    }
+    this._app.addRoute(routeSel, routeHandler, true, rank, authHandlers)
+    return this
+  }
+
+  /**
+   * Registers a handler for card button clicked invokes from message extension cards.
+   *
+   * @param handler - Handler invoked with the card action payload.
+   * @param rank - Optional route rank used for route ordering.
+   * @param authHandlers - Optional authorization handlers required by the route.
+   * @returns This message extension helper for chaining.
+   */
+  onCardButtonClicked<TData = unknown> (handler: CardButtonClickedHandler<TState, TData>, rank: number = RouteRank.Unspecified, authHandlers: string[] = []) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Invoke &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'composeExtension/onCardButtonClicked'
+      )
+    }
+    const routeHandler: RouteHandler<TState> = async (context: TurnContext, state: TState) => {
+      await handler(new TeamsTurnContext(context), state, context.activity.value as TData)
+      const invokeResponse = new Activity(ActivityTypes.InvokeResponse)
+      invokeResponse.value = { status: 200 }
+      await context.sendActivity(invokeResponse)
+    }
+    this._app.addRoute(routeSel, routeHandler, true, rank, authHandlers)
+    return this
+  }
+}

package/src/messageExtensions/messagingExtensionQuery.ts

@@ -0,0 +1,34 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+import type { MessagingExtensionQuery } from '@microsoft/teams.api'
+
+/**
+ * Zod schema for validating MessagingExtensionQuery.
+ * @ignore
+ */
+export const messagingExtensionQueryZodSchema = z.object({
+  commandId: z.string().min(1).optional(),
+  parameters: z.array(z.object({
+    name: z.string().min(1).optional(),
+    value: z.any().optional()
+  })).optional(),
+  queryOptions: z.object({
+    skip: z.number().optional(),
+    count: z.number().optional()
+  }).optional(),
+  state: z.string().min(1).optional()
+}).passthrough()
+
+/**
+ * Parses the given value as a messaging extension query.
+ *
+ * @param {unknown} value - The value to parse.
+ * @returns {MessagingExtensionQuery} - The parsed messaging extension query.
+ */
+export function parseValueMessagingExtensionQuery (value: unknown): MessagingExtensionQuery {
+  return messagingExtensionQueryZodSchema.parse(value) as MessagingExtensionQuery
+}

package/src/messages/index.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+export * from './message'

package/src/messages/message.ts

@@ -0,0 +1,148 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { Activity, ActivityTypes } from '@microsoft/agents-activity'
+import { AgentApplication, RouteHandler, RouteRank, RouteSelector, TurnContext, TurnState } from '@microsoft/agents-hosting'
+import { parseTeamsChannelData } from '../activity-extensions'
+import type { O365ConnectorCardActionQuery } from '@microsoft/teams.api'
+import { TeamsTurnContext } from '../teamsTurnContext'
+import type { ReadReceiptInfo } from '../models/readReceiptInfo'
+import { createTeamsRouteHandler, TeamsRouteHandler } from '../teamsRouteHandler'
+
+type ExecuteActionRouteHandler<TState extends TurnState> = (context: TeamsTurnContext, state: TState, query: O365ConnectorCardActionQuery) => Promise<void>
+type ReadReceiptHandler<TState extends TurnState> = (context: TeamsTurnContext, state: TState, data: ReadReceiptInfo) => Promise<void>
+
+function equalsIgnoreCase (actual: unknown, expected: string): boolean {
+  return typeof actual === 'string' && actual.toLowerCase() === expected.toLowerCase()
+}
+
+/**
+ * Registers handlers for Microsoft Teams message lifecycle events.
+ *
+ * @typeParam TState - The turn state type used by the agent application.
+ */
+export class Message<TState extends TurnState = TurnState> {
+  private _app: AgentApplication<TState>
+
+  /**
+   * Creates a Teams message route helper.
+   *
+   * @param app - The agent application that receives the registered routes.
+   */
+  constructor (app: AgentApplication<TState>) {
+    this._app = app
+  }
+
+  /**
+   * Registers a handler for Teams message edit events.
+   *
+   * @param handler - Handler invoked for matching message edit activities.
+   * @param rank - Optional route rank used for route ordering.
+   * @param authHandlers - Optional authorization handlers required by the route.
+   * @returns This message helper for chaining.
+   */
+  onMessageEdit (handler: TeamsRouteHandler<TState>, rank: number = RouteRank.Unspecified, authHandlers: string[] = []) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      const channelData = parseTeamsChannelData(context.activity.channelData)
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.MessageUpdate &&
+        context.activity.channelId === 'msteams' &&
+        equalsIgnoreCase(channelData?.eventType, 'editMessage')
+      )
+    }
+    this._app.addRoute(routeSel, createTeamsRouteHandler(handler), false, rank, authHandlers)
+    return this
+  }
+
+  /**
+   * Registers a handler for Teams soft-delete message events.
+   *
+   * @param handler - Handler invoked for matching message delete activities.
+   * @param rank - Optional route rank used for route ordering.
+   * @param authHandlers - Optional authorization handlers required by the route.
+   * @returns This message helper for chaining.
+   */
+  onMessageDelete (handler: TeamsRouteHandler<TState>, rank: number = RouteRank.Unspecified, authHandlers: string[] = []) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      const channelData = parseTeamsChannelData(context.activity.channelData)
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.MessageDelete &&
+        context.activity.channelId === 'msteams' &&
+        equalsIgnoreCase(channelData?.eventType, 'softDeleteMessage')
+      )
+    }
+    this._app.addRoute(routeSel, createTeamsRouteHandler(handler), false, rank, authHandlers)
+    return this
+  }
+
+  /**
+   * Registers a handler for Teams message undelete events.
+   *
+   * @param handler - Handler invoked for matching message update activities.
+   * @param rank - Optional route rank used for route ordering.
+   * @param authHandlers - Optional authorization handlers required by the route.
+   * @returns This message helper for chaining.
+   */
+  onMessageUndelete (handler: TeamsRouteHandler<TState>, rank: number = RouteRank.Unspecified, authHandlers: string[] = []) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      const channelData = parseTeamsChannelData(context.activity.channelData)
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.MessageUpdate &&
+        context.activity.channelId === 'msteams' &&
+        equalsIgnoreCase(channelData?.eventType, 'undeleteMessage')
+      )
+    }
+    this._app.addRoute(routeSel, createTeamsRouteHandler(handler), false, rank, authHandlers)
+    return this
+  }
+
+  /**
+   * Registers a handler for Teams read receipt events.
+   *
+   * @param handler - Handler invoked with read receipt information.
+   * @param rank - Optional route rank used for route ordering.
+   * @param authHandlers - Optional authorization handlers required by the route.
+   * @returns This message helper for chaining.
+   */
+  onReadReceipt (handler: ReadReceiptHandler<TState>, rank: number = RouteRank.Unspecified, authHandlers: string[] = []) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Event &&
+        context.activity.channelId === 'msteams' &&
+        equalsIgnoreCase(context.activity.name, 'application/vnd.microsoft.readReceipt')
+      )
+    }
+    const routeHandler: RouteHandler<TState> = async (context: TurnContext, state: TState) => {
+      await handler(new TeamsTurnContext(context), state, context.activity.value as ReadReceiptInfo)
+    }
+    this._app.addRoute(routeSel, routeHandler, false, rank, authHandlers)
+    return this
+  }
+
+  /**
+   * Registers a handler for Office 365 connector card execute action invokes.
+   *
+   * @param handler - Handler invoked with the connector card action query.
+   * @param rank - Optional route rank used for route ordering.
+   * @param authHandlers - Optional authorization handlers required by the route.
+   * @returns This message helper for chaining.
+   */
+  onExecuteAction (handler: ExecuteActionRouteHandler<TState>, rank: number = RouteRank.Unspecified, authHandlers: string[] = []) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Invoke &&
+        context.activity.channelId === 'msteams' &&
+        equalsIgnoreCase(context.activity.name, 'actionableMessage/executeAction')
+      )
+    }
+    const routeHandler: RouteHandler<TState> = async (context: TurnContext, state: TState) => {
+      const query = (context.activity.value ?? {}) as O365ConnectorCardActionQuery
+      await handler(new TeamsTurnContext(context), state, query)
+      const invokeResponse = new Activity(ActivityTypes.InvokeResponse)
+      invokeResponse.value = { status: 200 }
+      await context.sendActivity(invokeResponse)
+    }
+    this._app.addRoute(routeSel, routeHandler, true, rank, authHandlers)
+    return this
+  }
+}

package/src/models/index.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+export * from './readReceiptInfo'

package/src/models/readReceiptInfo.ts

@@ -0,0 +1,50 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+/**
+ * Class representing read receipt information.
+ */
+export class ReadReceiptInfo {
+  /**
+   * The ID of the last read message.
+   */
+  lastReadMessageId: string
+
+  /**
+   * Creates an instance of ReadReceiptInfo.
+   * @param {string} [lastReadMessageId=''] - The ID of the last read message.
+   */
+  constructor (lastReadMessageId: string = '') {
+    this.lastReadMessageId = lastReadMessageId
+  }
+
+  /**
+   * Checks if a message has been read.
+   * @param {string} compareMessageId - The ID of the message to compare.
+   * @param {string} lastReadMessageId - The ID of the last read message.
+   * @returns {boolean} True if the message has been read, false otherwise.
+   */
+  static isMessageRead (compareMessageId: string, lastReadMessageId: string): boolean {
+    if (compareMessageId.trim().length === 0 || lastReadMessageId.trim().length === 0) {
+      return false
+    }
+
+    const compareMessageIdNum = Number(compareMessageId)
+    const lastReadMessageIdNum = Number(lastReadMessageId)
+
+    if (!Number.isFinite(compareMessageIdNum) || !Number.isFinite(lastReadMessageIdNum)) {
+      return false
+    }
+
+    return compareMessageIdNum <= lastReadMessageIdNum
+  }
+
+  /**
+   * Checks if a message has been read using the instance's last read message ID.
+   * @param {string} compareMessageId - The ID of the message to compare.
+   * @returns {boolean} True if the message has been read, false otherwise.
+   */
+  isMessageRead (compareMessageId: string): boolean {
+    return ReadReceiptInfo.isMessageRead(compareMessageId, this.lastReadMessageId)
+  }
+}

package/src/taskModules/index.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+export * from './taskModule'