@microsoft/agents-hosting 0.1.49

package/src/cards/cardFactory.ts

@@ -0,0 +1,276 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ActionTypes, Attachment, CardAction } from '@microsoft/agents-activity'
+import { MediaUrl } from './mediaUrl'
+import { AnimationCard } from './animationCard'
+import { AudioCard } from './audioCard'
+import { HeroCard } from './heroCard'
+import { ReceiptCard } from './receiptCard'
+import { O365ConnectorCard } from './o365ConnectorCard'
+import { ThumbnailCard } from './thumbnailCard'
+import { VideoCard } from './videoCard'
+import { CardImage } from './cardImage'
+import { OAuthCard } from '../oauth/oauthCard'
+import { SigningResource } from '../oauth/signingResource'
+
+/**
+ * Factory class for creating various types of cards.
+ */
+export class CardFactory {
+  static contentTypes: any = {
+    adaptiveCard: 'application/vnd.microsoft.card.adaptive',
+    animationCard: 'application/vnd.microsoft.card.animation',
+    audioCard: 'application/vnd.microsoft.card.audio',
+    heroCard: 'application/vnd.microsoft.card.hero',
+    receiptCard: 'application/vnd.microsoft.card.receipt',
+    o365ConnectorCard: 'application/vnd.microsoft.teams.card.o365connector',
+    thumbnailCard: 'application/vnd.microsoft.card.thumbnail',
+    videoCard: 'application/vnd.microsoft.card.video',
+    oauthCard: 'application/vnd.microsoft.card.oauth',
+    signinCard: 'application/vnd.microsoft.card.signin',
+  }
+
+  /**
+   * Creates an adaptive card attachment.
+   * @param card The adaptive card content.
+   * @returns The adaptive card attachment.
+   */
+  static adaptiveCard (card: any): Attachment {
+    return { contentType: CardFactory.contentTypes.adaptiveCard, content: card }
+  }
+
+  /**
+   * Creates an animation card attachment.
+   * @param title The title of the card.
+   * @param media The media URLs or objects.
+   * @param buttons The optional buttons for the card.
+   * @param other Additional properties for the card.
+   * @returns The animation card attachment.
+   */
+  static animationCard (
+    title: string,
+    media: (MediaUrl | string)[],
+    buttons?: (CardAction | string)[],
+    other?: Partial<AnimationCard>
+  ): Attachment {
+    return CardFactory.mediaCard(CardFactory.contentTypes.animationCard, title, media, buttons, other)
+  }
+
+  /**
+   * Creates an audio card attachment.
+   * @param title The title of the card.
+   * @param media The media URLs or objects.
+   * @param buttons The optional buttons for the card.
+   * @param other Additional properties for the card.
+   * @returns The audio card attachment.
+   */
+  static audioCard (
+    title: string,
+    media: (MediaUrl | string)[],
+    buttons?: (CardAction | string)[],
+    other?: Partial<AudioCard>
+  ): Attachment {
+    return CardFactory.mediaCard(CardFactory.contentTypes.audioCard, title, media, buttons, other)
+  }
+
+  /**
+   * Creates a hero card attachment.
+   * @param title The title of the card.
+   * @param text The optional text for the card.
+   * @param images The optional images for the card.
+   * @param buttons The optional buttons for the card.
+   * @param other Additional properties for the card.
+   * @returns The hero card attachment.
+   */
+  static heroCard (title: string, text?: any, images?: any, buttons?: any, other?: Partial<HeroCard>): Attachment {
+    const a: Attachment = CardFactory.thumbnailCard(title, text, images, buttons, other)
+    a.contentType = CardFactory.contentTypes.heroCard
+    return a
+  }
+
+  /**
+   * Creates a receipt card attachment.
+   * @param card The receipt card content.
+   * @returns The receipt card attachment.
+   */
+  static receiptCard (card: ReceiptCard): Attachment {
+    return { contentType: CardFactory.contentTypes.receiptCard, content: card }
+  }
+
+  /**
+   * Creates an O365 connector card attachment.
+   * @param card The O365 connector card content.
+   * @returns The O365 connector card attachment.
+   */
+  static o365ConnectorCard (card: O365ConnectorCard): Attachment {
+    return { contentType: CardFactory.contentTypes.o365ConnectorCard, content: card }
+  }
+
+  /**
+   * Creates a thumbnail card attachment.
+   * @param title The title of the card.
+   * @param text The optional text for the card.
+   * @param images The optional images for the card.
+   * @param buttons The optional buttons for the card.
+   * @param other Additional properties for the card.
+   * @returns The thumbnail card attachment.
+   */
+  static thumbnailCard (
+    title: string,
+    text?: any,
+    images?: any,
+    buttons?: any,
+    other?: Partial<ThumbnailCard>
+  ): Attachment {
+    if (typeof text !== 'string') {
+      other = buttons
+      buttons = images
+      images = text
+      text = undefined
+    }
+    const card: Partial<ThumbnailCard> = { ...other }
+    if (title) {
+      card.title = title
+    }
+    if (text) {
+      card.text = text
+    }
+    if (images) {
+      card.images = CardFactory.images(images)
+    }
+    if (buttons) {
+      card.buttons = CardFactory.actions(buttons)
+    }
+
+    return { contentType: CardFactory.contentTypes.thumbnailCard, content: card }
+  }
+
+  /**
+   * Creates a video card attachment.
+   * @param title The title of the card.
+   * @param media The media URLs or objects.
+   * @param buttons The optional buttons for the card.
+   * @param other Additional properties for the card.
+   * @returns The video card attachment.
+   */
+  static videoCard (
+    title: string,
+    media: (MediaUrl | string)[],
+    buttons?: (CardAction | string)[],
+    other?: Partial<VideoCard>
+  ): Attachment {
+    return CardFactory.mediaCard(CardFactory.contentTypes.videoCard, title, media, buttons, other)
+  }
+
+  /**
+   * Converts an array of image URLs or objects to an array of CardImage objects.
+   * @param images The image URLs or objects.
+   * @returns The array of CardImage objects.
+   */
+  static images (images: (CardImage | string)[] | undefined): CardImage[] {
+    const list: CardImage[] = [];
+    (images || []).forEach((img: CardImage | string) => {
+      if (typeof img === 'object') {
+        list.push(img)
+      } else {
+        list.push({ url: img })
+      }
+    })
+
+    return list
+  }
+
+  /**
+   * Converts an array of action URLs or objects to an array of CardAction objects.
+   * @param actions The action URLs or objects.
+   * @returns The array of CardAction objects.
+   */
+  static actions (actions: (CardAction | string)[] | undefined): CardAction[] {
+    const list: CardAction[] = [];
+    (actions || []).forEach((a: CardAction | string) => {
+      if (typeof a === 'object') {
+        list.push(a)
+      } else {
+        list.push({
+          type: ActionTypes.ImBack,
+          value: a.toString(),
+          title: a.toString(),
+          channelData: undefined,
+        })
+      }
+    })
+
+    return list
+  }
+
+  /**
+   * Creates an OAuth card attachment.
+   * @param connectionName The connection name.
+   * @param title The title of the card.
+   * @param text The optional text for the card.
+   * @param signingResource The signing resource.
+   * @returns The OAuth card attachment.
+   */
+  static oauthCard (connectionName: string, title: string, text: string, signingResource: SigningResource) : Attachment {
+    const card: Partial<OAuthCard> = {
+      buttons: [{ type: ActionTypes.Signin, title, value: signingResource.singingLink, channelData: undefined }],
+      connectionName,
+      tokenExchangeResource: signingResource.tokenExchangeResource,
+      tokenPostResource: signingResource.tokenPostResource,
+    }
+    if (text) {
+      card.text = text
+    }
+
+    return { contentType: CardFactory.contentTypes.oauthCard, content: card }
+  }
+
+  /**
+   * Converts an array of media URLs or objects to an array of MediaUrl objects.
+   * @param links The media URLs or objects.
+   * @returns The array of MediaUrl objects.
+   */
+  static media (links: (MediaUrl | string)[] | undefined): MediaUrl[] {
+    const list: MediaUrl[] = [];
+    (links || []).forEach((lnk: MediaUrl | string) => {
+      if (typeof lnk === 'object') {
+        list.push(lnk)
+      } else {
+        list.push({ url: lnk })
+      }
+    })
+
+    return list
+  }
+
+  /**
+   * Creates a media card attachment.
+   * @param contentType The content type of the card.
+   * @param title The title of the card.
+   * @param media The media URLs or objects.
+   * @param buttons The optional buttons for the card.
+   * @param other Additional properties for the card.
+   * @returns The media card attachment.
+   */
+  private static mediaCard (
+    contentType: string,
+    title: string,
+    media: (MediaUrl | string)[],
+    buttons?: (CardAction | string)[],
+    other?: any
+  ): Attachment {
+    const card: VideoCard = { ...other }
+    if (title) {
+      card.title = title
+    }
+    card.media = CardFactory.media(media)
+    if (buttons) {
+      card.buttons = CardFactory.actions(buttons)
+    }
+
+    return { contentType, content: card }
+  }
+}

package/src/cards/cardImage.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { CardAction } from '@microsoft/agents-activity'
+
+/**
+ * Interface representing a Card Image.
+ */
+export interface CardImage {
+  /** The URL of the image. */
+  url: string
+  /** The alternative text for the image. */
+  alt?: string
+  /** The action to be performed when the image is tapped. */
+  tap?: CardAction
+}

package/src/cards/fact.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Interface representing a Fact.
+ */
+export interface Fact {
+  /** The key of the fact. */
+  key: string;
+  /** The value of the fact. */
+  value: string;
+}

package/src/cards/heroCard.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { CardAction } from '@microsoft/agents-activity'
+import { CardImage } from './cardImage'
+
+/**
+ * Interface representing a Hero Card.
+ */
+export interface HeroCard {
+  /** The title of the card. */
+  title: string
+  /** The subtitle of the card. */
+  subtitle: string
+  /** The text content of the card. */
+  text: string
+  /** The images to be displayed on the card. */
+  images: CardImage[]
+  /** The buttons to be displayed on the card. */
+  buttons: CardAction[]
+  /** The action to be performed when the card is tapped. */
+  tap: CardAction
+}

package/src/cards/index.ts

@@ -0,0 +1,17 @@
+export * from './animationCard'
+export * from './audioCard'
+export * from './cardFactory'
+export * from './cardImage'
+export * from './fact'
+export * from './heroCard'
+export * from './mediaUrl'
+export * from './o365ConnectorCard'
+export * from './o365ConnectorCardActionBase'
+export * from './o365ConnectorCardFact'
+export * from './o365ConnectorCardImage'
+export * from './o365ConnectorCardSection'
+export * from './receiptCard'
+export * from './receiptItem'
+export * from './taskModuleAction'
+export * from './thumbnailCard'
+export * from './videoCard'

package/src/cards/mediaUrl.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Represents a media URL.
+ */
+export interface MediaUrl {
+  /**
+   * The URL of the media.
+   */
+  url: string;
+  /**
+   * The profile of the media.
+   */
+  profile?: string;
+}

package/src/cards/o365ConnectorCard.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { O365ConnectorCardActionBase } from './o365ConnectorCardActionBase'
+import { O365ConnectorCardSection } from './o365ConnectorCardSection'
+
+/**
+ * Represents an O365 connector card.
+ */
+export interface O365ConnectorCard {
+  /**
+   * The title of the card.
+   */
+  title?: string;
+  /**
+   * The text of the card.
+   */
+  text?: string;
+  /**
+   * The summary of the card.
+   */
+  summary?: string;
+  /**
+   * The theme color of the card.
+   */
+  themeColor?: string;
+  /**
+   * The sections of the card.
+   */
+  sections?: O365ConnectorCardSection[];
+  /**
+   * The potential actions of the card.
+   */
+  potentialAction?: O365ConnectorCardActionBase[];
+}

package/src/cards/o365ConnectorCardActionBase.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export type O365ConnectorCardActionType = 'ViewAction' | 'OpenUri' | 'HttpPOST' | 'ActionCard'
+
+/**
+ * Represents a base action in an O365 connector card.
+ */
+export interface O365ConnectorCardActionBase {
+  /**
+   * The type of the action.
+   */
+  '@type'?: O365ConnectorCardActionType;
+  /**
+   * The name of the action.
+   */
+  name?: string;
+  /**
+   * The ID of the action.
+   */
+  '@id'?: string;
+}

package/src/cards/o365ConnectorCardFact.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Represents a fact in an O365 connector card.
+ */
+export interface O365ConnectorCardFact {
+  /**
+   * The name of the fact.
+   */
+  name?: string;
+  /**
+   * The value of the fact.
+   */
+  value?: string;
+}

package/src/cards/o365ConnectorCardImage.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Represents an image in an O365 connector card.
+ */
+export interface O365ConnectorCardImage {
+  /**
+   * The URL of the image.
+   */
+  image?: string;
+  /**
+   * The title of the image.
+   */
+  title?: string;
+}

package/src/cards/o365ConnectorCardSection.ts

@@ -0,0 +1,60 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { O365ConnectorCardActionBase } from './o365ConnectorCardActionBase'
+import { O365ConnectorCardFact } from './o365ConnectorCardFact'
+import { O365ConnectorCardImage } from './o365ConnectorCardImage'
+
+export type ActivityImageType = 'avatar' | 'article'
+
+/**
+ * Represents a section in an O365 connector card.
+ */
+export interface O365ConnectorCardSection {
+  /**
+   * The title of the section.
+   */
+  title?: string
+  /**
+   * The text of the section.
+   */
+  text?: string
+  /**
+   * The activity title of the section.
+   */
+  activityTitle?: string
+  /**
+   * The activity subtitle of the section.
+   */
+  activitySubtitle?: string
+  /**
+   * The activity text of the section.
+   */
+  activityText?: string
+  /**
+   * The activity image of the section.
+   */
+  activityImage?: string
+  /**
+   * The type of the activity image.
+   */
+  activityImageType?: ActivityImageType
+  /**
+   * Indicates whether markdown is enabled.
+   */
+  markdown?: boolean
+  /**
+   * The facts of the section.
+   */
+  facts?: O365ConnectorCardFact[]
+  /**
+   * The images of the section.
+   */
+  images?: O365ConnectorCardImage[]
+  /**
+   * The potential actions of the section.
+   */
+  potentialAction?: O365ConnectorCardActionBase[]
+}

package/src/cards/receiptCard.ts

@@ -0,0 +1,46 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { CardAction } from '@microsoft/agents-activity'
+import { Fact } from './fact'
+import { ReceiptItem } from './receiptItem'
+
+/**
+ * Represents a receipt card.
+ */
+export interface ReceiptCard {
+  /**
+   * The title of the card.
+   */
+  title: string;
+  /**
+   * The facts of the card.
+   */
+  facts: Fact[];
+  /**
+   * The items of the card.
+   */
+  items: ReceiptItem[];
+  /**
+   * The tap action of the card.
+   */
+  tap?: CardAction;
+  /**
+   * The total amount of the receipt.
+   */
+  total: string;
+  /**
+   * The tax amount of the receipt.
+   */
+  tax: string;
+  /**
+   * The VAT amount of the receipt.
+   */
+  vat?: string;
+  /**
+   * The buttons of the card.
+   */
+  buttons: CardAction[];
+}

package/src/cards/receiptItem.ts

@@ -0,0 +1,41 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { CardAction } from '@microsoft/agents-activity'
+import { CardImage } from './cardImage'
+
+/**
+ * Represents an item in a receipt card.
+ */
+export interface ReceiptItem {
+  /**
+   * The title of the item.
+   */
+  title: string
+  /**
+   * The subtitle of the item.
+   */
+  subtitle?: string
+  /**
+   * The text of the item.
+   */
+  text?: string
+  /**
+   * The image of the item.
+   */
+  image: CardImage
+  /**
+   * The price of the item.
+   */
+  price: string
+  /**
+   * The quantity of the item.
+   */
+  quantity: number
+  /**
+   * The tap action of the item.
+   */
+  tap?: CardAction
+}

package/src/cards/signinCard.ts

@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { CardAction } from '@microsoft/agents-activity'
+
+/**
+ * Represents a sign-in card.
+ */
+export interface SigninCard {
+  /**
+   * The text to display on the sign-in card.
+   */
+  text?: string
+  /**
+   * The buttons to include on the sign-in card.
+   */
+  buttons: CardAction[]
+}