@microsoft/agents-hosting-extensions-teams 0.5.1-g2e246ff274

package/src/teamsAgentExtension.ts

@@ -0,0 +1,201 @@
+import { Meeting } from './meeting/meeting'
+import { ActivityTypes } from '@microsoft/agents-activity'
+import { AgentApplication, AgentExtension, RouteHandler, RouteSelector, TurnContext, TurnState } from '@microsoft/agents-hosting'
+import { parseTeamsChannelData } from './activity-extensions/teamsChannelDataParser'
+import { MessageExtension } from './messageExtension/messageExtension'
+import { TaskModule } from './taskModule/taskModule'
+
+export class TeamsAgentExtension<TState extends TurnState = TurnState> extends AgentExtension<TState> {
+  _app: AgentApplication<TState>
+  _meeting: Meeting<TState>
+  _messageExtension: MessageExtension<TState>
+  _taskModule: TaskModule<TState>
+  constructor (private app: AgentApplication<TState>) {
+    super('msteams')
+    this._app = app
+    this._meeting = new Meeting(app)
+    this._messageExtension = new MessageExtension(app)
+    this._taskModule = new TaskModule(app)
+  }
+
+  public get meeting (): Meeting<TState> {
+    return this._meeting
+  }
+
+  public get messageExtension (): MessageExtension<TState> {
+    return this._messageExtension
+  }
+
+  public get taskModule (): TaskModule<TState> {
+    return this._taskModule
+  }
+
+  onMessageEdit = (handler: RouteHandler<TurnState>) => {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      const channelData = parseTeamsChannelData(context.activity.channelData)
+      return Promise.resolve(!!(context.activity.type === ActivityTypes.MessageUpdate && channelData?.eventType === 'editMessage'))
+    }
+    this.addRoute(this._app, routeSel, handler, false)
+    return this
+  }
+
+  onMessageDelete = (handler: RouteHandler<TurnState>) => {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      const channelData = parseTeamsChannelData(context.activity.channelData)
+      return Promise.resolve(context.activity.type === ActivityTypes.MessageDelete && channelData && channelData.eventType === 'softDeleteMessage')
+    }
+    this.addRoute(this._app, routeSel, handler, false)
+    return this
+  }
+
+  onMessageUndelete = (handler: RouteHandler<TurnState>) => {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      const channelData = parseTeamsChannelData(context.activity.channelData)
+      return Promise.resolve(context.activity.type === ActivityTypes.MessageUpdate && channelData && channelData.eventType === 'undeleteMessage')
+    }
+    this.addRoute(this._app, routeSel, handler, false)
+    return this
+  }
+
+  onTeamsMembersAdded = (handler: RouteHandler<TurnState>) => {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(!!(context.activity.type === ActivityTypes.ConversationUpdate &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.membersAdded &&
+        context.activity.membersAdded.length > 0))
+    }
+    this.addRoute(this._app, routeSel, handler, false)
+    return this
+  }
+
+  onTeamsMembersRemoved = (handler: RouteHandler<TurnState>) => {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(!!(context.activity.type === ActivityTypes.ConversationUpdate &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.membersRemoved &&
+        context.activity.membersRemoved.length > 0))
+    }
+    this.addRoute(this._app, routeSel, handler, false)
+    return this
+  }
+
+  onTeamsChannelCreated = (handler: RouteHandler<TurnState>) => {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      const channelData = parseTeamsChannelData(context.activity.channelData)
+      return Promise.resolve(context.activity.type === ActivityTypes.ConversationUpdate &&
+        context.activity.channelId === 'msteams' &&
+        channelData &&
+        channelData.eventType === 'channelCreated')
+    }
+    this.addRoute(this._app, routeSel, handler, false)
+    return this
+  }
+
+  onTeamsChannelDeleted = (handler: RouteHandler<TurnState>) => {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      const channelData = parseTeamsChannelData(context.activity.channelData)
+      return Promise.resolve(context.activity.type === ActivityTypes.ConversationUpdate &&
+        context.activity.channelId === 'msteams' &&
+        channelData &&
+        channelData.eventType === 'channelDeleted')
+    }
+    this.addRoute(this._app, routeSel, handler, false)
+    return this
+  }
+
+  onTeamsChannelRenamed = (handler: RouteHandler<TurnState>) => {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      const channelData = parseTeamsChannelData(context.activity.channelData)
+      return Promise.resolve(context.activity.type === ActivityTypes.ConversationUpdate &&
+        context.activity.channelId === 'msteams' &&
+        channelData &&
+        channelData.eventType === 'channelRenamed')
+    }
+    this.addRoute(this._app, routeSel, handler, false)
+    return this
+  }
+
+  onTeamsChannelRestored = (handler: RouteHandler<TurnState>) => {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      const channelData = parseTeamsChannelData(context.activity.channelData)
+      return Promise.resolve(context.activity.type === ActivityTypes.ConversationUpdate &&
+        context.activity.channelId === 'msteams' &&
+        channelData &&
+        channelData.eventType === 'channelRestored')
+    }
+    this.addRoute(this._app, routeSel, handler, false)
+    return this
+  }
+
+  onTeamsTeamRenamed = (handler: RouteHandler<TurnState>) => {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      const channelData = parseTeamsChannelData(context.activity.channelData)
+      return Promise.resolve(context.activity.type === ActivityTypes.ConversationUpdate &&
+        context.activity.channelId === 'msteams' &&
+        channelData &&
+        channelData.eventType === 'teamRenamed')
+    }
+    this.addRoute(this._app, routeSel, handler, false)
+    return this
+  }
+
+  onTeamsTeamArchived = (handler: RouteHandler<TurnState>) => {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      const channelData = parseTeamsChannelData(context.activity.channelData)
+      return Promise.resolve(context.activity.type === ActivityTypes.ConversationUpdate &&
+        context.activity.channelId === 'msteams' &&
+        channelData &&
+        channelData.eventType === 'teamArchived')
+    }
+    this.addRoute(this._app, routeSel, handler, false)
+    return this
+  }
+
+  onTeamsTeamUnarchived = (handler: RouteHandler<TurnState>) => {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      const channelData = parseTeamsChannelData(context.activity.channelData)
+      return Promise.resolve(context.activity.type === ActivityTypes.ConversationUpdate &&
+        context.activity.channelId === 'msteams' &&
+        channelData &&
+        channelData.eventType === 'teamUnarchived')
+    }
+    this.addRoute(this._app, routeSel, handler, false)
+    return this
+  }
+
+  onTeamsTeamDeleted = (handler: RouteHandler<TurnState>) => {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      const channelData = parseTeamsChannelData(context.activity.channelData)
+      return Promise.resolve(context.activity.type === ActivityTypes.ConversationUpdate &&
+        context.activity.channelId === 'msteams' &&
+        channelData &&
+        channelData.eventType === 'teamDeleted')
+    }
+    this.addRoute(this._app, routeSel, handler, false)
+    return this
+  }
+
+  onTeamsTeamHardDeleted = (handler: RouteHandler<TurnState>) => {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      const channelData = parseTeamsChannelData(context.activity.channelData)
+      return Promise.resolve(context.activity.type === ActivityTypes.ConversationUpdate &&
+        context.activity.channelId === 'msteams' &&
+        channelData &&
+        channelData.eventType === 'teamHardDeleted')
+    }
+    this.addRoute(this._app, routeSel, handler, false)
+    return this
+  }
+
+  onTeamsTeamRestored = (handler: RouteHandler<TurnState>) => {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      const channelData = parseTeamsChannelData(context.activity.channelData)
+      return Promise.resolve(context.activity.type === ActivityTypes.ConversationUpdate &&
+        context.activity.channelId === 'msteams' &&
+        channelData &&
+        channelData.eventType === 'teamRestored')
+    }
+    this.addRoute(this._app, routeSel, handler, false)
+    return this
+  }
+}

package/src/teamsAttachmentDownloader.ts

@@ -0,0 +1,78 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { Attachment } from '@microsoft/agents-activity'
+import { ConnectorClient, InputFile, InputFileDownloader, TurnContext, TurnState } from '@microsoft/agents-hosting'
+import axios, { AxiosInstance } from 'axios'
+import { z } from 'zod'
+/**
+ * Downloads attachments from Teams using the bots access token.
+ */
+export class TeamsAttachmentDownloader<TState extends TurnState = TurnState> implements InputFileDownloader<TState> {
+  private _httpClient: AxiosInstance
+  public constructor () {
+    this._httpClient = axios.create()
+  }
+
+  /**
+     * Download any files relative to the current user's input.
+     * @template TState - Type of the state object passed to the `TurnContext.turnState` method.
+     * @param {TurnContext} context Context for the current turn of conversation.
+     * @param {TState} state Application state for the current turn of conversation.
+     * @returns {Promise<InputFile[]>} Promise that resolves to an array of downloaded input files.
+     */
+  public async downloadFiles (context: TurnContext, state: TState): Promise<InputFile[]> {
+    // Filter out HTML attachments
+    const attachments = context.activity.attachments?.filter((a) => !a.contentType.startsWith('text/html'))
+    if (!attachments || attachments.length === 0) {
+      return Promise.resolve([])
+    }
+
+    const connectorClient : ConnectorClient = context.turnState.get<ConnectorClient>('connectorClient')
+    this._httpClient.defaults.headers = connectorClient.axiosInstance.defaults.headers
+
+    const files: InputFile[] = []
+    for (const attachment of attachments) {
+      const file = await this.downloadFile(attachment)
+      if (file) {
+        files.push(file)
+      }
+    }
+
+    return files
+  }
+
+  /**
+     * @private
+     * @param {Attachment} attachment - Attachment to download.
+     * @param {string} accessToken - Access token to use for downloading.
+     * @returns {Promise<InputFile>} - Promise that resolves to the downloaded input file.
+     */
+  private async downloadFile (attachment: Attachment): Promise<InputFile | undefined> {
+    let inputFile: InputFile | undefined
+    if (attachment.contentType === 'application/vnd.microsoft.teams.file.download.info') {
+      const contentSchema = z.object({ downloadUrl: z.string() })
+      const contentValue = contentSchema.parse(attachment.content)
+      const response = await this._httpClient.get(contentValue.downloadUrl, { responseType: 'arraybuffer' })
+      const content = Buffer.from(response.data, 'binary')
+      let contentType = attachment.contentType
+      if (contentType === 'image/*') {
+        contentType = 'image/png'
+      }
+      inputFile = { content, contentType, contentUrl: attachment.contentUrl }
+    } else if (attachment.contentType === 'image/*') {
+      const response = await this._httpClient.get(attachment.contentUrl!, { responseType: 'arraybuffer' })
+      const content = Buffer.from(response.data, 'binary')
+      inputFile = { content, contentType: attachment.contentType, contentUrl: attachment.contentUrl }
+    } else {
+      inputFile = {
+        content: Buffer.from(attachment.content as ArrayBuffer),
+        contentType: attachment.contentType,
+        contentUrl: attachment.contentUrl
+      }
+    }
+    return inputFile
+  }
+}