@microsoft/agents-activity 0.2.14 → 0.4.1

package/src/activityEventNames.ts

@@ -9,7 +9,14 @@ import { z } from 'zod'
  * Enum representing activity event names.
  */
 export enum ActivityEventNames {
+  /**
+   * Event name for continuing a conversation.
+   */
   ContinueConversation = 'ContinueConversation',
+
+  /**
+   * Event name for creating a new conversation.
+   */
   CreateConversation = 'CreateConversation',
 }
 

package/src/activityImportance.ts

@@ -9,8 +9,19 @@ import { z } from 'zod'
  * Enum representing activity importance levels.
  */
 export enum ActivityImportance {
+  /**
+   * Indicates low importance.
+   */
   Low = 'low',
+
+  /**
+   * Indicates normal importance.
+   */
   Normal = 'normal',
+
+  /**
+   * Indicates high importance.
+   */
   High = 'high',
 }
 

package/src/activityTypes.ts

@@ -9,24 +9,99 @@ import { z } from 'zod'
  * Enum representing activity types.
  */
 export enum ActivityTypes {
+  /**
+   * A message activity.
+   */
   Message = 'message',
+
+  /**
+   * An update to a contact relationship.
+   */
   ContactRelationUpdate = 'contactRelationUpdate',
+
+  /**
+   * An update to a conversation.
+   */
   ConversationUpdate = 'conversationUpdate',
+
+  /**
+   * A typing indicator activity.
+   */
   Typing = 'typing',
+
+  /**
+   * Indicates the end of a conversation.
+   */
   EndOfConversation = 'endOfConversation',
+
+  /**
+   * An event activity.
+   */
   Event = 'event',
+
+  /**
+   * An invoke activity.
+   */
   Invoke = 'invoke',
+
+  /**
+   * A response to an invoke activity.
+   */
   InvokeResponse = 'invokeResponse',
+
+  /**
+   * An activity to delete user data.
+   */
   DeleteUserData = 'deleteUserData',
+
+  /**
+   * An update to a message.
+   */
   MessageUpdate = 'messageUpdate',
+
+  /**
+   * A deletion of a message.
+   */
   MessageDelete = 'messageDelete',
+
+  /**
+   * An update to an installation.
+   */
   InstallationUpdate = 'installationUpdate',
+
+  /**
+   * A reaction to a message.
+   */
   MessageReaction = 'messageReaction',
+
+  /**
+   * A suggestion activity.
+   */
   Suggestion = 'suggestion',
+
+  /**
+   * A trace activity for debugging.
+   */
   Trace = 'trace',
+
+  /**
+   * A handoff activity to another bot or human.
+   */
   Handoff = 'handoff',
+
+  /**
+   * A command activity.
+   */
   Command = 'command',
+
+  /**
+   * A result of a command activity.
+   */
   CommandResult = 'commandResult',
+
+  /**
+   * A delay activity.
+   */
   Delay = 'delay'
 }
 

package/src/attachment/attachment.ts

@@ -9,10 +9,29 @@ import { z } from 'zod'
  * Interface representing an attachment.
  */
 export interface Attachment {
+  /**
+   * The MIME type of the attachment content.
+   */
   contentType: string
+
+  /**
+   * The URL of the attachment content.
+   */
   contentUrl?: string
+
+  /**
+   * The content of the attachment.
+   */
   content?: unknown
+
+  /**
+   * The name of the attachment.
+   */
   name?: string
+
+  /**
+   * The URL of the thumbnail for the attachment.
+   */
   thumbnailUrl?: string
 }
 

package/src/attachment/attachmentLayoutTypes.ts

@@ -9,7 +9,14 @@ import { z } from 'zod'
  * Enum representing the layout types for attachments.
  */
 export enum AttachmentLayoutTypes {
+  /**
+   * Displays attachments in a list format.
+   */
   List = 'list',
+
+  /**
+   * Displays attachments in a carousel format.
+   */
   Carousel = 'carousel',
 }
 

package/src/conversation/channelAccount.ts

@@ -10,10 +10,29 @@ import { roleTypeZodSchema, RoleTypes } from './roleTypes'
  * Interface representing a channel account.
  */
 export interface ChannelAccount {
+  /**
+   * The unique identifier of the channel account.
+   */
   id?: string
+
+  /**
+   * The name of the channel account.
+   */
   name?: string
+
+  /**
+   * The Azure Active Directory object ID of the channel account.
+   */
   aadObjectId?: string
+
+  /**
+   * The role of the channel account.
+   */
   role?: RoleTypes | string
+
+  /**
+   * Additional properties of the channel account.
+   */
   properties?: unknown
 }
 

package/src/conversation/channels.ts

@@ -7,23 +7,98 @@
  * Enum representing the different channels an agent can communicate through.
  */
 export enum Channels {
+  /**
+   * Represents the Alexa channel.
+   */
   Alexa = 'alexa',
+
+  /**
+   * Represents the Console channel.
+   */
   Console = 'console',
+
+  /**
+   * Represents the Directline channel.
+   */
   Directline = 'directline',
+
+  /**
+   * Represents the Directline Speech channel.
+   */
   DirectlineSpeech = 'directlinespeech',
+
+  /**
+   * Represents the Email channel.
+   */
   Email = 'email',
+
+  /**
+   * Represents the Emulator channel.
+   */
   Emulator = 'emulator',
+
+  /**
+   * Represents the Facebook channel.
+   */
   Facebook = 'facebook',
+
+  /**
+   * Represents the GroupMe channel.
+   */
   Groupme = 'groupme',
+
+  /**
+   * Represents the Line channel.
+   */
   Line = 'line',
+
+  /**
+   * Represents the Microsoft Teams channel.
+   */
   Msteams = 'msteams',
+
+  /**
+   * Represents the Omnichannel.
+   */
   Omni = 'omnichannel',
+
+  /**
+   * Represents the Outlook channel.
+   */
   Outlook = 'outlook',
+
+  /**
+   * Represents the Skype channel.
+   */
   Skype = 'skype',
+
+  /**
+   * Represents the Slack channel.
+   */
   Slack = 'slack',
+
+  /**
+   * Represents the SMS channel.
+   */
   Sms = 'sms',
+
+  /**
+   * Represents the Telegram channel.
+   */
   Telegram = 'telegram',
+
+  /**
+   * Represents the Telephony channel.
+   */
   Telephony = 'telephony',
+
+  /**
+   * Represents the Test channel.
+   */
   Test = 'test',
+
+  /**
+   * Represents the Webchat channel.
+   */
   Webchat = 'webchat',
 }

package/src/conversation/conversationAccount.ts

@@ -10,13 +10,44 @@ import { roleTypeZodSchema, RoleTypes } from './roleTypes'
  * Interface representing a conversation account.
  */
 export interface ConversationAccount {
+  /**
+   * The unique identifier of the conversation account.
+   */
   id: string
+
+  /**
+   * The type of the conversation (e.g., personal, group, etc.).
+   */
   conversationType?: string
+
+  /**
+   * The tenant ID associated with the conversation account.
+   */
   tenantId?: string
+
+  /**
+   * Indicates whether the conversation is a group.
+   */
   isGroup?: boolean
+
+  /**
+   * The name of the conversation account.
+   */
   name?: string
+
+  /**
+   * The Azure Active Directory object ID of the conversation account.
+   */
   aadObjectId?: string
+
+  /**
+   * The role of the conversation account.
+   */
   role?: RoleTypes | string
+
+  /**
+   * Additional properties of the conversation account.
+   */
   properties?: unknown
 }
 

package/src/conversation/conversationReference.ts

@@ -11,12 +11,39 @@ import { ConversationAccount, conversationAccountZodSchema } from './conversatio
  * Interface representing a reference to a conversation.
  */
 export interface ConversationReference {
+  /**
+   * The ID of the activity. Optional.
+   */
   activityId?: string
+
+  /**
+   * The user involved in the conversation. Optional.
+   */
   user?: ChannelAccount
+
+  /**
+   * The locale of the conversation. Optional.
+   */
   locale?: string
+
+  /**
+   * The agent involved in the conversation. Can be undefined or null. Optional.
+   */
   agent?: ChannelAccount | undefined | null
+
+  /**
+   * The conversation account details.
+   */
   conversation: ConversationAccount
+
+  /**
+   * The ID of the channel where the conversation is taking place.
+   */
   channelId: string
+
+  /**
+   * The service URL for the conversation. Optional.
+   */
   serviceUrl?: string | undefined
 }
 

package/src/conversation/endOfConversationCodes.ts

@@ -9,11 +9,34 @@ import { z } from 'zod'
  * Enum representing the different end of conversation codes.
  */
 export enum EndOfConversationCodes {
+  /**
+   * The end of conversation reason is unknown.
+   */
   Unknown = 'unknown',
+
+  /**
+   * The conversation completed successfully.
+   */
   CompletedSuccessfully = 'completedSuccessfully',
+
+  /**
+   * The user cancelled the conversation.
+   */
   UserCancelled = 'userCancelled',
+
+  /**
+   * The agent timed out during the conversation.
+   */
   AgentTimedOut = 'agentTimedOut',
+
+  /**
+   * The agent issued an invalid message.
+   */
   AgentIssuedInvalidMessage = 'agentIssuedInvalidMessage',
+
+  /**
+   * The channel failed during the conversation.
+   */
   ChannelFailed = 'channelFailed',
 }
 

package/src/conversation/roleTypes.ts

@@ -9,8 +9,19 @@ import { z } from 'zod'
  * Enum representing the different role types in a conversation.
  */
 export enum RoleTypes {
+  /**
+   * Represents a user in the conversation.
+   */
   User = 'user',
+
+  /**
+   * Represents an agent or bot in the conversation.
+   */
   Agent = 'bot',
+
+  /**
+   * Represents a skill in the conversation.
+   */
   Skill = 'skill',
 }
 

package/src/deliveryModes.ts

@@ -9,9 +9,24 @@ import { z } from 'zod'
  * Enum representing delivery modes.
  */
 export enum DeliveryModes {
+  /**
+   * Represents the normal delivery mode.
+   */
   Normal = 'normal',
+
+  /**
+   * Represents a notification delivery mode.
+   */
   Notification = 'notification',
+
+  /**
+   * Represents a delivery mode where replies are expected.
+   */
   ExpectReplies = 'expectReplies',
+
+  /**
+   * Represents an ephemeral delivery mode.
+   */
   Ephemeral = 'ephemeral',
 }
 

package/src/inputHints.ts

@@ -9,8 +9,19 @@ import { z } from 'zod'
  * Enum representing input hints.
  */
 export enum InputHints {
+  /**
+   * Indicates that the bot is ready to accept input from the user.
+   */
   AcceptingInput = 'acceptingInput',
+
+  /**
+   * Indicates that the bot is ignoring input from the user.
+   */
   IgnoringInput = 'ignoringInput',
+
+  /**
+   * Indicates that the bot is expecting input from the user.
+   */
   ExpectingInput = 'expectingInput',
 }
 

package/src/messageReactionTypes.ts

@@ -9,7 +9,14 @@ import { z } from 'zod'
  * Enum representing message reaction types.
  */
 export enum MessageReactionTypes {
+  /**
+   * Represents a 'like' reaction to a message.
+   */
   Like = 'like',
+
+  /**
+   * Represents a '+1' reaction to a message.
+   */
   PlusOne = 'plusOne',
 }
 

package/src/textFormatTypes.ts

@@ -9,8 +9,19 @@ import { z } from 'zod'
  * Enum representing text format types.
  */
 export enum TextFormatTypes {
+  /**
+   * Represents text formatted using Markdown.
+   */
   Markdown = 'markdown',
+
+  /**
+   * Represents plain text without any formatting.
+   */
   Plain = 'plain',
+
+  /**
+   * Represents text formatted using XML.
+   */
   Xml = 'xml',
 }