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

package/src/activity-extensions/notificationInfo.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+
+/**
+ * Represents information about a notification.
+ */
+export interface NotificationInfo {
+  /**
+   * Indicates whether the notification is an alert.
+   */
+  alert?: boolean
+  /**
+   * Indicates whether the alert is in a meeting.
+   */
+  alertInMeeting?: boolean
+  /**
+   * The URL of the external resource.
+   */
+  externalResourceUrl?: string
+}
+
+/**
+ * Zod schema for validating NotificationInfo objects.
+ */
+export const notificationInfoZodSchema = z.object({
+  alert: z.boolean().optional(),
+  alertInMeeting: z.boolean().optional(),
+  externalResourceUrl: z.string().min(1).optional()
+})

package/src/activity-extensions/onBehalfOf.ts

@@ -0,0 +1,38 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+
+/**
+ * Represents information about a user on behalf of whom an action is performed.
+ */
+export interface OnBehalfOf {
+  /**
+   * The ID of the item.
+   */
+  itemid: 0 | number
+  /**
+   * The type of mention.
+   */
+  mentionType: 'person' | string
+  /**
+   * The Microsoft Resource Identifier (MRI) of the user.
+   */
+  mri: string
+  /**
+   * The display name of the user.
+   */
+  displayName?: string
+}
+
+/**
+ * Zod schema for validating OnBehalfOf objects.
+ */
+export const onBehalfOfZodSchema = z.object({
+  itemid: z.union([z.literal(0), z.number()]),
+  mentionType: z.union([z.string().min(1), z.literal('person')]),
+  mri: z.string().min(1),
+  displayName: z.string().min(1).optional()
+})

package/src/activity-extensions/teamInfo.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+
+/**
+ * Represents information about a team.
+ */
+export interface TeamInfo {
+  /**
+   * The ID of the team.
+   */
+  id?: string
+  /**
+   * The name of the team.
+   */
+  name?: string
+  /**
+   * The Azure Active Directory group ID of the team.
+   */
+  aadGroupId?: string
+}
+
+/**
+ * Zod schema for validating TeamInfo objects.
+ */
+export const teamInfoZodSchema = z.object({
+  id: z.string().min(1).optional(),
+  name: z.string().min(1).optional(),
+  aadGroupId: z.string().min(1).optional()
+})

package/src/activity-extensions/teamsChannelAccount.ts

@@ -0,0 +1,36 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ChannelAccount } from '@microsoft/agents-activity'
+
+/**
+ * Represents a Teams channel account.
+ */
+export interface TeamsChannelAccount extends ChannelAccount {
+  /**
+   * Given name of the user.
+   */
+  givenName?: string
+  /**
+   * Surname of the user.
+   */
+  surname?: string
+  /**
+   * Email address of the user.
+   */
+  email?: string
+  /**
+   * User principal name of the user.
+   */
+  userPrincipalName?: string
+  /**
+   * Tenant ID of the user.
+   */
+  tenantId?: string
+  /**
+   * Role of the user in the team.
+   */
+  userRole?: string
+}

package/src/activity-extensions/teamsChannelData.ts

@@ -0,0 +1,75 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+import { ChannelInfo, channelInfoZodSchema } from './channelInfo'
+import { NotificationInfo, notificationInfoZodSchema } from './notificationInfo'
+import { OnBehalfOf, onBehalfOfZodSchema } from './onBehalfOf'
+import { TeamsChannelDataSettings, teamsChannelDataSettingsZodSchema } from './teamsChannelDataSettings'
+import { TeamsMeetingInfo, teamsMeetingInfoZodSchema } from './teamsMeetingInfo'
+import { TenantInfo, tenantInfoZodSchema } from './tenantInfo'
+import { TeamInfo, teamInfoZodSchema } from './teamInfo'
+
+/**
+ * Represents data for a Teams channel.
+ */
+export interface TeamsChannelData {
+  /**
+   * Information about the channel.
+   */
+  channel?: ChannelInfo
+  /**
+   * The type of event.
+   */
+  eventType?: string
+  /**
+   * Information about the team.
+   */
+  team?: TeamInfo
+  /**
+   * Information about the notification.
+   */
+  notification?: NotificationInfo
+  /**
+   * Information about the tenant.
+   */
+  tenant?: TenantInfo
+  /**
+   * Information about the meeting.
+   */
+  meeting?: TeamsMeetingInfo
+  /**
+   * Settings for the Teams channel data.
+   */
+  settings?: TeamsChannelDataSettings
+  /**
+   * Information about the users on behalf of whom the action is performed.
+   */
+  onBehalfOf?: OnBehalfOf[]
+}
+
+/**
+ * Zod schema for validating TeamsChannelData objects.
+ */
+export const teamsChannelDataZodSchema = z.object({
+  channel: channelInfoZodSchema.optional(),
+  eventType: z.string().min(1).optional(),
+  team: teamInfoZodSchema.optional(),
+  notification: notificationInfoZodSchema.optional(),
+  tenant: tenantInfoZodSchema.optional(),
+  meeting: teamsMeetingInfoZodSchema.optional(),
+  settings: teamsChannelDataSettingsZodSchema.optional(),
+  onBehalfOf: z.array(onBehalfOfZodSchema).optional()
+})
+
+/**
+ * Parses the given object as TeamsChannelData.
+ *
+ * @param {object} o - The object to parse.
+ * @returns {TeamsChannelData} - The parsed TeamsChannelData.
+ */
+export function parseTeamsChannelData (o: object): TeamsChannelData {
+  return teamsChannelDataZodSchema.passthrough().parse(o)
+}

package/src/activity-extensions/teamsChannelDataParser.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { TeamsChannelData, teamsChannelDataZodSchema } from './teamsChannelData'
+
+/**
+ * Parses the given object as TeamsChannelData.
+ *
+ * @param {object} o - The object to parse.
+ * @returns {TeamsChannelData} - The parsed TeamsChannelData.
+ */
+export function parseTeamsChannelData (o: object): TeamsChannelData {
+  teamsChannelDataZodSchema.passthrough().parse(o)
+  return o
+}

package/src/activity-extensions/teamsChannelDataSettings.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+import { ChannelInfo, channelInfoZodSchema } from './channelInfo'
+
+/**
+ * Represents settings for Teams channel data.
+ */
+export interface TeamsChannelDataSettings {
+  /**
+   * The selected channel information.
+   */
+  selectedChannel?: ChannelInfo
+  /**
+   * Additional properties.
+   */
+  [properties: string]: unknown
+}
+
+/**
+ * Zod schema for validating TeamsChannelDataSettings objects.
+ */
+export const teamsChannelDataSettingsZodSchema = z.object({
+  selectedChannel: channelInfoZodSchema.optional()
+})

package/src/activity-extensions/teamsConversationUpdateEvents.ts

@@ -0,0 +1,61 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ConversationUpdateEvents } from '@microsoft/agents-hosting'
+
+/**
+ * Represents the types of conversation update events specific to Microsoft Teams.
+ * Extends the base `ConversationUpdateEvents` with additional Teams-specific events.
+ */
+export type TeamsConversationUpdateEvents =
+    ConversationUpdateEvents |
+    /**
+     * Event triggered when a new channel is created.
+     */
+    'channelCreated'
+    /**
+     * Event triggered when a channel is renamed.
+     */
+    | 'channelRenamed'
+    /**
+     * Event triggered when a channel is deleted.
+     */
+    | 'channelDeleted'
+    /**
+     * Event triggered when a deleted channel is restored.
+     */
+    | 'channelRestored'
+    /**
+     * Event triggered when a team is renamed.
+     */
+    | 'teamRenamed'
+    /**
+     * Event triggered when a team is deleted.
+     */
+    | 'teamDeleted'
+    /**
+     * Event triggered when a team is permanently deleted.
+     */
+    | 'teamHardDeleted'
+    /**
+     * Event triggered when a team is archived.
+     */
+    | 'teamArchived'
+    /**
+     * Event triggered when an archived team is unarchived.
+     */
+    | 'teamUnarchived'
+    /**
+     * Event triggered when a deleted team is restored.
+     */
+    | 'teamRestored'
+    /**
+     * Event triggered when the topic name is updated.
+     */
+    | 'topicName'
+    /**
+     * Event triggered when the conversation history is disclosed.
+     */
+    | 'historyDisclosed'

package/src/activity-extensions/teamsMeetingInfo.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+
+/**
+ * Represents information about a Teams meeting.
+ */
+export interface TeamsMeetingInfo {
+  /**
+   * The ID of the meeting.
+   */
+  id?: string
+}
+
+/**
+ * Zod schema for validating TeamsMeetingInfo objects.
+ */
+export const teamsMeetingInfoZodSchema = z.object({
+  id: z.string().min(1).optional()
+})

package/src/activity-extensions/teamsMessageEvents.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export type TeamsMessageEvents = 'undeleteMessage' | 'softDeleteMessage' | 'editMessage'

package/src/activity-extensions/tenantInfo.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+
+/**
+ * Represents information about a tenant.
+ */
+export interface TenantInfo {
+  /**
+   * The ID of the tenant.
+   */
+  id?: string
+}
+
+/**
+ * Zod schema for validating TenantInfo objects.
+ */
+export const tenantInfoZodSchema = z.object({
+  id: z.string().min(1).optional()
+})

package/src/client/index.ts

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