@microsoft/agents-activity 0.2.14 → 0.3.5

package/src/action/actionTypes.ts

@@ -9,16 +9,59 @@ import { z } from 'zod'
  * Enum representing the types of actions.
  */
 export enum ActionTypes {
+  /**
+   * Opens a URL in the default browser.
+   */
   OpenUrl = 'openUrl',
+
+  /**
+   * Sends a message back to the bot as a simple string.
+   */
   ImBack = 'imBack',
+
+  /**
+   * Sends a message back to the bot with additional data.
+   */
   PostBack = 'postBack',
+
+  /**
+   * Plays an audio file.
+   */
   PlayAudio = 'playAudio',
+
+  /**
+   * Plays a video file.
+   */
   PlayVideo = 'playVideo',
+
+  /**
+   * Displays an image.
+   */
   ShowImage = 'showImage',
+
+  /**
+   * Downloads a file.
+   */
   DownloadFile = 'downloadFile',
+
+  /**
+   * Initiates a sign-in process.
+   */
   Signin = 'signin',
+
+  /**
+   * Initiates a phone call.
+   */
   Call = 'call',
+
+  /**
+   * Sends a message back to the bot with additional metadata.
+   */
   MessageBack = 'messageBack',
+
+  /**
+   * Opens an application.
+   */
   OpenApp = 'openApp',
 }
 

package/src/action/semanticActionStateTypes.ts

@@ -9,8 +9,19 @@ import { z } from 'zod'
  * Enum representing the state types of a semantic action.
  */
 export enum SemanticActionStateTypes {
+  /**
+   * Indicates the start of a semantic action.
+   */
   Start = 'start',
+
+  /**
+   * Indicates the continuation of a semantic action.
+   */
   Continue = 'continue',
+
+  /**
+   * Indicates the completion of a semantic action.
+   */
   Done = 'done',
 }
 

package/src/activity.ts

@@ -77,51 +77,234 @@ export const activityZodSchema = z.object({
  * Represents an activity in a conversation.
  */
 export class Activity {
+  /**
+   * The type of the activity.
+   */
   type: ActivityTypes | string
+
+  /**
+   * The text content of the activity.
+   */
   text?: string
+
+  /**
+   * The unique identifier of the activity.
+   */
   id?: string
+
+  /**
+   * The channel ID where the activity originated.
+   */
   channelId?: string
+
+  /**
+   * The account of the sender of the activity.
+   */
   from?: ChannelAccount
+
+  /**
+   * The timestamp of the activity.
+   */
   timestamp?: Date | string
+
+  /**
+   * The local timestamp of the activity.
+   */
   localTimestamp?: Date | string
+
+  /**
+   * The local timezone of the activity.
+   */
   localTimezone?: string
+
+  /**
+   * The caller ID of the activity.
+   */
   callerId?: string
+
+  /**
+   * The service URL of the activity.
+   */
   serviceUrl?: string
+
+  /**
+   * The conversation account associated with the activity.
+   */
   conversation?: ConversationAccount
+
+  /**
+   * The recipient of the activity.
+   */
   recipient?: ChannelAccount
+
+  /**
+   * The text format of the activity.
+   */
   textFormat?: TextFormatTypes | string
+
+  /**
+   * The attachment layout of the activity.
+   */
   attachmentLayout?: AttachmentLayoutTypes | string
+
+  /**
+   * The members added to the conversation.
+   */
   membersAdded?: ChannelAccount[]
+
+  /**
+   * The members removed from the conversation.
+   */
   membersRemoved?: ChannelAccount[]
+
+  /**
+   * The reactions added to the activity.
+   */
   reactionsAdded?: MessageReaction[]
+
+  /**
+   * The reactions removed from the activity.
+   */
   reactionsRemoved?: MessageReaction[]
+
+  /**
+   * The topic name of the activity.
+   */
   topicName?: string
+
+  /**
+   * Indicates whether the history is disclosed.
+   */
   historyDisclosed?: boolean
+
+  /**
+   * The locale of the activity.
+   */
   locale?: string
+
+  /**
+   * The speech text of the activity.
+   */
   speak?: string
+
+  /**
+   * The input hint for the activity.
+   */
   inputHint?: InputHints | string
+
+  /**
+   * The summary of the activity.
+   */
   summary?: string
+
+  /**
+   * The suggested actions for the activity.
+   */
   suggestedActions?: SuggestedActions
+
+  /**
+   * The attachments of the activity.
+   */
   attachments?: Attachment[]
+
+  /**
+   * The entities associated with the activity.
+   */
   entities?: Entity[]
+
+  /**
+   * The channel-specific data for the activity.
+   */
   channelData?: any
+
+  /**
+   * The action associated with the activity.
+   */
   action?: string
+
+  /**
+   * The ID of the activity being replied to.
+   */
   replyToId?: string
+
+  /**
+   * The label for the activity.
+   */
   label?: string
+
+  /**
+   * The value type of the activity.
+   */
   valueType?: string
+
+  /**
+   * The value associated with the activity.
+   */
   value?: unknown
+
+  /**
+   * The name of the activity event.
+   */
   name?: ActivityEventNames | string
+
+  /**
+   * The conversation reference for the activity.
+   */
   relatesTo?: ConversationReference
+
+  /**
+   * The end-of-conversation code for the activity.
+   */
   code?: EndOfConversationCodes | string
+
+  /**
+   * The expiration time of the activity.
+   */
   expiration?: string | Date
+
+  /**
+   * The importance of the activity.
+   */
   importance?: ActivityImportance | string
+
+  /**
+   * The delivery mode of the activity.
+   */
   deliveryMode?: DeliveryModes | string
+
+  /**
+   * The list of keywords to listen for in the activity.
+   */
   listenFor?: string[]
+
+  /**
+   * The text highlights in the activity.
+   */
   textHighlights?: TextHighlight[]
+
+  /**
+   * The semantic action associated with the activity.
+   */
   semanticAction?: SemanticAction
+
+  /**
+   * The raw timestamp of the activity.
+   */
   rawTimestamp?: string
+
+  /**
+   * The raw expiration time of the activity.
+   */
   rawExpiration?: string
+
+  /**
+   * The raw local timestamp of the activity.
+   */
   rawLocalTimestamp?: string
+
+  /**
+   * Additional properties of the activity.
+   */
   [x: string]: unknown
 
   /**

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
 }