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

package/src/file/fileConsentCardResponse.ts

@@ -0,0 +1,31 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { FileUploadInfo } from './fileUploadInfo'
+
+/**
+ * Type representing possible actions for file consent.
+ */
+export type Action = 'accept' | 'decline'
+
+/**
+ * Interface representing the response to a file consent card.
+ */
+export interface FileConsentCardResponse {
+  /**
+   * The action taken by the user, either 'accept' or 'decline'.
+   */
+  action?: Action;
+
+  /**
+   * Additional context information.
+   */
+  context?: any;
+
+  /**
+   * Information about the file to be uploaded.
+   */
+  uploadInfo?: FileUploadInfo;
+}

package/src/file/fileUploadInfo.ts

@@ -0,0 +1,34 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Interface representing information required for file upload.
+ */
+export interface FileUploadInfo {
+  /**
+   * The name of the file.
+   */
+  name?: string;
+
+  /**
+   * The URL to upload the file.
+   */
+  uploadUrl?: string;
+
+  /**
+   * The URL to access the uploaded file.
+   */
+  contentUrl?: string;
+
+  /**
+   * A unique identifier for the file.
+   */
+  uniqueId?: string;
+
+  /**
+   * The type of the file.
+   */
+  fileType?: string;
+}

package/src/file/index.ts

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

package/src/index.ts

@@ -0,0 +1,10 @@
+export * from './activity-extensions'
+export * from './client'
+export * from './compat/teamsActivityHandler'
+export * from './meeting'
+export * from './meeting/meeting'
+export * from './messageExtension'
+export * from './taskModule'
+export * from './teamsAgentExtension'
+export * from './teamsAttachmentDownloader'
+export * from './teamsInfo'

package/src/meeting/index.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export * from './meetingDetailsBase'
+export * from './meetingEndEventDetails'
+export * from './meetingEventDetails'
+export * from './meetingParticipantsEventDetails'
+export * from './meetingStartEventDetails'
+export * from './teamsMeetingMember'
+export * from './userMeetingDetails'
+export * from './targetedMeetingNotification'
+export * from './meetingDetails'
+export * from './meetingNotificationRecipientFailureInfo'
+export * from './teamsMeetingParticipant'
+export * from './meetingNotificationChannelData'
+export * from './meeting'
+export * from './targetedMeetingNotificationValue'
+export * from './meetingSurface'
+export * from './meetingStageSurface'
+export * from './meetingTabIconSurface'
+export * from './meetingNotification'

package/src/meeting/meeting.ts

@@ -0,0 +1,307 @@
+import { ActivityTypes } from '@microsoft/agents-activity'
+import { AgentApplication, RouteHandler, RouteSelector, TurnContext, TurnState } from '@microsoft/agents-hosting'
+
+/**
+ * Class that exposes all Teams meeting-related events.
+ * Provides an organized way to handle meeting events in Microsoft Teams.
+ */
+export class Meeting<TState extends TurnState> {
+  private _app: AgentApplication<TState>
+
+  /**
+   * Creates a new instance of the Meetings class.
+   * @param app - The agent application
+   */
+  constructor (app: AgentApplication<TState>) {
+    this._app = app
+  }
+
+  /**
+   * Triggered when a meeting starts.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onMeetingStart (handler: RouteHandler<TState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Event &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingStart'
+      )
+    }
+    this._app.addRoute(routeSel, handler)
+    return this
+  }
+
+  /**
+   * Triggered when a meeting ends.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onMeetingEnd (handler: RouteHandler<TurnState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Event &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingEnd'
+      )
+    }
+    this._app.addRoute(routeSel, handler)
+    return this
+  }
+
+  /**
+   * Triggered when participants join a meeting.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onParticipantsJoin (handler: RouteHandler<TurnState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Event &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingParticipantJoin'
+      )
+    }
+    this._app.addRoute(routeSel, handler)
+    return this
+  }
+
+  /**
+   * Triggered when participants leave a meeting.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onParticipantsLeave (handler: RouteHandler<TurnState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Event &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingParticipantLeave'
+      )
+    }
+    this._app.addRoute(routeSel, handler)
+    return this
+  }
+
+  /**
+   * Triggered when a physical meeting room joins a Teams meeting.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onRoomJoin (handler: RouteHandler<TurnState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Event &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingRoomJoin'
+      )
+    }
+    this._app.addRoute(routeSel, handler)
+    return this
+  }
+
+  /**
+   * Triggered when a physical meeting room leaves a Teams meeting.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onRoomLeave (handler: RouteHandler<TurnState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Event &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingRoomLeave'
+      )
+    }
+    this._app.addRoute(routeSel, handler)
+    return this
+  }
+
+  /**
+   * Triggered when your app is viewed in the meeting stage.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onStageView (handler: RouteHandler<TurnState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Invoke &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingStageView'
+      )
+    }
+    this._app.addRoute(routeSel, handler)// This is an invoke so true
+    return this
+  }
+
+  /**
+   * Processes smart reply recommendations during meetings.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onSmartReply (handler: RouteHandler<TurnState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Invoke &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingSmartReply'
+      )
+    }
+    this._app.addRoute(routeSel, handler)
+    return this
+  }
+
+  /**
+   * Captures emoji reactions during meetings.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onReaction (handler: RouteHandler<TurnState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Event &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingReaction'
+      )
+    }
+    this._app.addRoute(routeSel, handler)
+    return this
+  }
+
+  /**
+   * Processes responses to polls during meetings.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onPollResponse (handler: RouteHandler<TurnState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Event &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingPollResponse'
+      )
+    }
+    this._app.addRoute(routeSel, handler)
+    return this
+  }
+
+  /**
+   * Notifies when apps are installed during a meeting.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onAppsInstalled (handler: RouteHandler<TurnState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Event &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingAppsInstalled'
+      )
+    }
+    this._app.addRoute(routeSel, handler)
+    return this
+  }
+
+  /**
+   * Notifies when apps are removed during a meeting.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onAppsUninstalled (handler: RouteHandler<TurnState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Event &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingAppsUninstalled'
+      )
+    }
+    this._app.addRoute(routeSel, handler)
+    return this
+  }
+
+  /**
+   * Triggered when a meeting is recorded.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onRecordingStarted (handler: RouteHandler<TurnState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Event &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingRecordingStarted'
+      )
+    }
+    this._app.addRoute(routeSel, handler)
+    return this
+  }
+
+  /**
+   * Triggered when recording is stopped in a meeting.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onRecordingStopped (handler: RouteHandler<TurnState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Event &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingRecordingStopped'
+      )
+    }
+    this._app.addRoute(routeSel, handler)
+    return this
+  }
+
+  /**
+   * Triggered when the focus of the meeting changes.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onFocusChange (handler: RouteHandler<TurnState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Event &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingFocusChange'
+      )
+    }
+    this._app.addRoute(routeSel, handler)
+    return this
+  }
+
+  /**
+   * Triggered when screen sharing starts in a meeting.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onScreenShareStart (handler: RouteHandler<TurnState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Event &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingScreenShareStart'
+      )
+    }
+    this._app.addRoute(routeSel, handler)
+    return this
+  }
+
+  /**
+   * Triggered when screen sharing stops in a meeting.
+   * @param handler - The handler to call when this event occurs
+   * @returns this (for method chaining)
+   */
+  onScreenShareStop (handler: RouteHandler<TurnState>) {
+    const routeSel: RouteSelector = (context: TurnContext) => {
+      return Promise.resolve(
+        context.activity.type === ActivityTypes.Event &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === 'application/vnd.microsoft.meetingScreenShareStop'
+      )
+    }
+    this._app.addRoute(routeSel, handler)
+    return this
+  }
+}

package/src/meeting/meetingDetails.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { MeetingDetailsBase } from './meetingDetailsBase'
+
+/**
+ * Interface representing the details of a meeting.
+ */
+export interface MeetingDetails extends MeetingDetailsBase {
+  /** The Microsoft Graph resource ID of the meeting. */
+  msGraphResourceId: string;
+  /** The scheduled start time of the meeting. */
+  scheduledStartTime?: Date;
+  /** The scheduled end time of the meeting. */
+  scheduledEndTime?: Date;
+  /** The type of the meeting. */
+  type: string;
+}

package/src/meeting/meetingDetailsBase.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Interface representing the base details of a meeting.
+ */
+export interface MeetingDetailsBase {
+  /** The unique identifier of the meeting. */
+  id: string
+  /** The URL to join the meeting. */
+  joinUrl: string
+  /** The title of the meeting. */
+  title: string
+}

package/src/meeting/meetingEndEventDetails.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { MeetingEventDetails } from './meetingEventDetails'
+
+/**
+ * Interface representing the details of a meeting end event.
+ */
+export interface MeetingEndEventDetails extends MeetingEventDetails {
+  /** The end time of the meeting. */
+  endTime: Date
+}

package/src/meeting/meetingEventDetails.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { MeetingDetailsBase } from './meetingDetailsBase'
+
+/**
+ * Interface representing the details of a meeting event.
+ */
+export interface MeetingEventDetails extends MeetingDetailsBase {
+  /** The type of the meeting. */
+  meetingType: string
+}

package/src/meeting/meetingInfo.ts

@@ -0,0 +1,26 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ConversationAccount } from '@microsoft/agents-activity'
+import { MeetingDetails } from '../meeting/meetingDetails'
+import { TeamsChannelAccount } from '../activity-extensions/teamsChannelAccount'
+
+/**
+ * Represents information about a meeting.
+ */
+export interface MeetingInfo {
+  /**
+   * Details of the meeting.
+   */
+  details: MeetingDetails;
+  /**
+   * Conversation account associated with the meeting.
+   */
+  conversation: ConversationAccount;
+  /**
+   * Organizer of the meeting.
+   */
+  organizer: TeamsChannelAccount;
+}

package/src/meeting/meetingNotification.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { TargetedMeetingNotification } from './targetedMeetingNotification'
+
+/**
+ * Represents a meeting notification.
+ */
+export type MeetingNotification = TargetedMeetingNotification

package/src/meeting/meetingNotificationBase.ts

@@ -0,0 +1,15 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Interface representing the base structure of a meeting notification.
+ * @template T - The type of the value.
+ */
+export interface MeetingNotificationBase<T> {
+  /** The type of the notification. */
+  type: string;
+  /** The value associated with the notification. */
+  value: T;
+}

package/src/meeting/meetingNotificationChannelData.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { OnBehalfOf } from '../activity-extensions/onBehalfOf'
+
+/**
+ * Interface representing the channel data for a meeting notification.
+ */
+export interface MeetingNotificationChannelData {
+  /** Optional list of entities on behalf of whom the notification is sent. */
+  onBehalfOf?: OnBehalfOf[];
+}

package/src/meeting/meetingNotificationRecipientFailureInfo.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Interface representing the failure information of a meeting notification recipient.
+ */
+export interface MeetingNotificationRecipientFailureInfo {
+  /** The recipient's MRI (Microsoft Resource Identifier). */
+  recipientMri: string;
+  /** The reason for the failure. */
+  failureReason: string;
+  /** The error code associated with the failure. */
+  errorCode: string;
+}

package/src/meeting/meetingNotificationResponse.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { MeetingNotificationRecipientFailureInfo } from './meetingNotificationRecipientFailureInfo'
+
+/**
+ * Represents a response to a meeting notification.
+ */
+export interface MeetingNotificationResponse {
+  /**
+   * Information about recipients who failed to receive the notification.
+   */
+  recipientsFailureInfo?: MeetingNotificationRecipientFailureInfo[];
+}

package/src/meeting/meetingParticipantsEventDetails.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { TeamsMeetingMember } from './teamsMeetingMember'
+
+/**
+ * Interface representing the details of a meeting participants event.
+ */
+export interface MeetingParticipantsEventDetails {
+  /** The list of members participating in the meeting. */
+  members: TeamsMeetingMember[]
+}

package/src/meeting/meetingStageSurface.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Interface representing the surface of a meeting stage.
+ * @template T - The type of the content.
+ */
+export interface MeetingStageSurface<T> {
+  /** The surface type, which is always 'meetingStage'. */
+  surface: 'meetingStage';
+  /** The content type, which is always 'task'. */
+  contentType: 'task';
+  /** The content of the meeting stage. */
+  content: T;
+}

package/src/meeting/meetingStartEventDetails.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { MeetingEventDetails } from './meetingEventDetails'
+
+/**
+ * Interface representing the details of a meeting start event.
+ */
+export interface MeetingStartEventDetails extends MeetingEventDetails {
+  /**
+   * The start time of the meeting.
+   */
+  startTime: Date
+}

package/src/meeting/meetingSurface.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { MeetingStageSurface } from './meetingStageSurface'
+import { MeetingTabIconSurface } from './meetingTabIconSurface'
+
+/**
+ * Type representing a meeting surface, which can be either a stage surface or a tab icon surface.
+ */
+export type MeetingSurface = MeetingStageSurface<any> | MeetingTabIconSurface

package/src/meeting/meetingTabIconSurface.ts

@@ -0,0 +1,19 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Interface representing a meeting tab icon surface.
+ */
+export interface MeetingTabIconSurface {
+  /**
+   * The type of surface.
+   */
+  surface: 'meetingTabIcon';
+
+  /**
+   * The tab entity ID associated with the surface.
+   */
+  tabEntityId?: string;
+}