@microsoft/agents-activity 0.1.49

package/src/conversation/conversationReference.ts

@@ -0,0 +1,34 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+import { ChannelAccount, channelAccountZodSchema } from './channelAccount'
+import { ConversationAccount, conversationAccountZodSchema } from './conversationAccount'
+
+/**
+ * Interface representing a reference to a conversation.
+ */
+export interface ConversationReference {
+  activityId?: string
+  user?: ChannelAccount
+  locale?: string
+  bot?: ChannelAccount | undefined | null
+  conversation: ConversationAccount
+  channelId: string
+  serviceUrl?: string | undefined
+}
+
+/**
+ * Zod schema for validating a conversation reference.
+ */
+export const conversationReferenceZodSchema = z.object({
+  activityId: z.string().min(1).optional(),
+  user: channelAccountZodSchema.optional(),
+  locale: z.string().min(1).optional(),
+  bot: channelAccountZodSchema.optional().nullable(),
+  conversation: conversationAccountZodSchema,
+  channelId: z.string().min(1),
+  serviceUrl: z.string().min(1).optional()
+})

package/src/conversation/endOfConversationCodes.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+
+/**
+ * Enum representing the different end of conversation codes.
+ */
+export enum EndOfConversationCodes {
+  Unknown = 'unknown',
+  CompletedSuccessfully = 'completedSuccessfully',
+  UserCancelled = 'userCancelled',
+  BotTimedOut = 'botTimedOut',
+  BotIssuedInvalidMessage = 'botIssuedInvalidMessage',
+  ChannelFailed = 'channelFailed',
+}
+
+/**
+ * Zod schema for validating end of conversation codes.
+ */
+export const endOfConversationCodesZodSchema = z.enum(['unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'])

package/src/conversation/roleTypes.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+
+/**
+ * Enum representing the different role types in a conversation.
+ */
+export enum RoleTypes {
+  User = 'user',
+  Bot = 'bot',
+  Skill = 'skill',
+}
+
+/**
+ * Zod schema for validating role types.
+ */
+export const roleTypeZodSchema = z.enum(['user', 'bot', 'skill'])

package/src/deliveryModes.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+
+/**
+ * Enum representing delivery modes.
+ */
+export enum DeliveryModes {
+  Normal = 'normal',
+  Notification = 'notification',
+  ExpectReplies = 'expectReplies',
+  Ephemeral = 'ephemeral',
+}
+
+/**
+ * Zod schema for validating a DeliveryModes enum.
+ */
+export const deliveryModesZodSchema = z.enum(['normal', 'notification', 'expectReplies', 'ephemeral'])

package/src/entity/entity.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+
+/**
+ * Represents a generic Entity.
+ */
+export interface Entity {
+  /**
+   * The type of the entity.
+   */
+  type: string
+  /**
+   * Additional properties of the entity.
+   */
+  [key: string]: unknown
+}
+
+/**
+ * Zod schema for validating Entity objects.
+ */
+export const entityZodSchema = z.object({
+  type: z.string().min(1)
+})

package/src/entity/geoCoordinates.ts

@@ -0,0 +1,30 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Represents geographical coordinates.
+ */
+export interface GeoCoordinates {
+  /**
+   * The elevation of the location.
+   */
+  elevation: number
+  /**
+   * The latitude of the location.
+   */
+  latitude: number
+  /**
+   * The longitude of the location.
+   */
+  longitude: number
+  /**
+   * The type of the geographical coordinates.
+   */
+  type: string
+  /**
+   * The name of the geographical coordinates.
+   */
+  name: string
+}

package/src/entity/mention.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ChannelAccount } from '../conversation/channelAccount'
+
+/**
+ * Represents a Mention entity.
+ */
+export interface Mention {
+  /**
+   * The account that is mentioned.
+   */
+  mentioned: ChannelAccount
+  /**
+   * The text of the mention.
+   */
+  text: string
+  /**
+   * The type of the mention.
+   */
+  type: string
+}

package/src/entity/place.ts

@@ -0,0 +1,30 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Represents a Place entity.
+ */
+export interface Place {
+  /**
+   * The address of the place.
+   */
+  address: unknown
+  /**
+   * The geographical coordinates of the place.
+   */
+  geo: unknown
+  /**
+   * A map that shows the place.
+   */
+  hasMap: unknown
+  /**
+   * The type of the place.
+   */
+  type: string
+  /**
+   * The name of the place.
+   */
+  name: string
+}

package/src/entity/thing.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Represents a Thing entity.
+ */
+export interface Thing {
+  /**
+   * The type of the thing.
+   */
+  type: string
+  /**
+   * The name of the thing.
+   */
+  name: string
+}

package/src/expectedReplies.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { Activity } from './activity'
+
+/**
+ * Represents expected replies in a conversation.
+ */
+export interface ExpectedReplies {
+  /**
+   * List of activities representing the expected replies.
+   */
+  activities: Activity[]
+}

package/src/index.ts

@@ -0,0 +1,44 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Export statements for various modules.
+ */
+export { ActionTypes } from './action/actionTypes'
+export { CardAction } from './action/cardAction'
+export { SemanticAction } from './action/semanticAction'
+export { SemanticActionStateTypes } from './action/semanticActionStateTypes'
+export { SuggestedActions } from './action/suggestedActions'
+
+export { Attachment } from './attachment/attachment'
+export { AttachmentLayoutTypes } from './attachment/attachmentLayoutTypes'
+
+export { ChannelAccount } from './conversation/channelAccount'
+export { Channels } from './conversation/channels'
+export { ConversationAccount } from './conversation/conversationAccount'
+export { ConversationReference } from './conversation/conversationReference'
+export { EndOfConversationCodes } from './conversation/endOfConversationCodes'
+export { RoleTypes } from './conversation/roleTypes'
+
+export { Entity } from './entity/entity'
+export { Mention } from './entity/mention'
+export { GeoCoordinates } from './entity/geoCoordinates'
+export { Place } from './entity/place'
+export { Thing } from './entity/thing'
+
+export * from './invoke/adaptiveCardInvokeAction'
+
+export { Activity, activityZodSchema } from './activity'
+export { ActivityEventNames } from './activityEventNames'
+export { ActivityImportance } from './activityImportance'
+export { ActivityTypes } from './activityTypes'
+export { CallerIdConstants } from './callerIdConstants'
+export { DeliveryModes } from './deliveryModes'
+export { ExpectedReplies } from './expectedReplies'
+export { InputHints } from './inputHints'
+export { MessageReaction } from './messageReaction'
+export { MessageReactionTypes } from './messageReactionTypes'
+export { TextFormatTypes } from './textFormatTypes'
+export { TextHighlight } from './textHighlight'

package/src/inputHints.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+
+/**
+ * Enum representing input hints.
+ */
+export enum InputHints {
+  AcceptingInput = 'acceptingInput',
+  IgnoringInput = 'ignoringInput',
+  ExpectingInput = 'expectingInput',
+}
+
+/**
+ * Zod schema for validating an InputHints enum.
+ */
+export const inputHintsZodSchema = z.enum(['acceptingInput', 'ignoringInput', 'expectingInput'])

package/src/invoke/adaptiveCardInvokeAction.ts

@@ -0,0 +1,38 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+
+/**
+ * Interface representing an adaptive card invoke action.
+ */
+export interface AdaptiveCardInvokeAction {
+  /**
+   * The type of the action.
+   */
+  type: string
+  /**
+   * The unique identifier of the action.
+   */
+  id?: string
+  /**
+   * The verb associated with the action.
+   */
+  verb: string
+  /**
+   * Additional data associated with the action.
+   */
+  data: Record<string, any>
+}
+
+/**
+ * Zod schema for validating an adaptive card invoke action.
+ */
+export const adaptiveCardInvokeActionZodSchema = z.object({
+  type: z.string().min(1),
+  id: z.string().optional(),
+  verb: z.string().min(1),
+  data: z.record(z.string().min(1), z.any())
+})

package/src/messageReaction.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+import { MessageReactionTypes, messageReactionTypesZodSchema } from './messageReactionTypes'
+
+/**
+ * Represents a message reaction.
+ */
+export interface MessageReaction {
+  /**
+   * The type of the reaction.
+   */
+  type: MessageReactionTypes | string
+}
+
+/**
+ * Zod schema for validating a MessageReaction object.
+ */
+export const messageReactionZodSchema = z.object({
+  type: z.union([messageReactionTypesZodSchema, z.string().min(1)])
+})

package/src/messageReactionTypes.ts

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+
+/**
+ * Enum representing message reaction types.
+ */
+export enum MessageReactionTypes {
+  Like = 'like',
+  PlusOne = 'plusOne',
+}
+
+/**
+ * Zod schema for validating MessageReactionTypes enum values.
+ */
+export const messageReactionTypesZodSchema = z.enum(['like', 'plusOne'])

package/src/textFormatTypes.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+
+/**
+ * Enum representing text format types.
+ */
+export enum TextFormatTypes {
+  Markdown = 'markdown',
+  Plain = 'plain',
+  Xml = 'xml',
+}
+
+/**
+ * Zod schema for validating TextFormatTypes enum values.
+ */
+export const textFormatTypesZodSchema = z.enum(['markdown', 'plain', 'xml'])

package/src/textHighlight.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { z } from 'zod'
+
+/**
+ * Interface representing a text highlight.
+ */
+export interface TextHighlight {
+  /**
+   * The highlighted text.
+   */
+  text: string
+  /**
+   * The occurrence count of the highlighted text.
+   */
+  occurrence: number
+}
+
+/**
+ * Zod schema for validating TextHighlight objects.
+ */
+export const textHighlightZodSchema = z.object({
+  text: z.string().min(1),
+  occurrence: z.number()
+})