@microsoft/teamsfx 0.6.2-alpha.83ce60286.0 → 0.6.2-alpha.aafc68d57.0

package/types/teamsfx.d.ts

@@ -1,13 +1,29 @@
 import { AccessToken } from '@azure/identity';
+import { Activity } from 'botbuilder-core';
+import { Activity as Activity_2 } from 'botbuilder';
+import { Attachment } from 'botbuilder';
 import { AuthenticationProvider } from '@microsoft/microsoft-graph-client';
+import { AxiosInstance } from 'axios';
+import { AxiosRequestConfig } from 'axios';
+import { BotFrameworkAdapter } from 'botbuilder';
+import { CardAction } from 'botbuilder';
+import { CardImage } from 'botbuilder';
+import { ChannelInfo } from 'botbuilder';
 import { Client } from '@microsoft/microsoft-graph-client';
 import { ConnectionConfig } from 'tedious';
+import { ConversationReference } from 'botbuilder';
 import { Dialog } from 'botbuilder-dialogs';
 import { DialogContext } from 'botbuilder-dialogs';
 import { DialogTurnResult } from 'botbuilder-dialogs';
 import { GetTokenOptions } from '@azure/identity';
+import { HeroCard } from 'botbuilder';
+import { O365ConnectorCard } from 'botbuilder';
+import { ReceiptCard } from 'botbuilder';
+import { TeamsChannelAccount } from 'botbuilder';
+import { ThumbnailCard } from 'botbuilder';
 import { TokenCredential } from '@azure/identity';
 import { TokenResponse } from 'botframework-schema';
+import { TurnContext } from 'botbuilder-core';
 
 /**
  * Represent Microsoft 365 tenant identity, and it is usually used when user is not involved like time-triggered automation job.
@@ -123,6 +139,175 @@ export declare interface AuthenticationConfiguration {
     readonly applicationIdUri?: string;
 }
 
+/**
+ * Defines method that injects authentication info to http requests
+ *
+ * @beta
+ */
+export declare interface AuthProvider {
+    /**
+     * Adds authentication info to http requests
+     *
+     * @param config - Contains all the request information and can be updated to include extra authentication info.
+     * Refer https://axios-http.com/docs/req_config for detailed document.
+     *
+     * @beta
+     */
+    AddAuthenticationInfo: (config: AxiosRequestConfig) => Promise<AxiosRequestConfig>;
+}
+
+/**
+ * Provider that handles Bearer Token authentication
+ *
+ * @beta
+ */
+export declare class BearerTokenAuthProvider implements AuthProvider {
+    private getToken;
+    /**
+     * @param getToken Function that returns the content of bearer token used in http request
+     *
+     * @beta
+     */
+    constructor(getToken: () => Promise<string>);
+    /**
+     * Adds authentication info to http requests
+     *
+     * @param config - Contains all the request information and can be updated to include extra authentication info.
+     * Refer https://axios-http.com/docs/req_config for detailed document.
+     *
+     * @beta
+     */
+    AddAuthenticationInfo(config: AxiosRequestConfig): Promise<AxiosRequestConfig>;
+}
+
+/**
+ * A {@link NotificationTarget} that represents a team channel.
+ *
+ * @remarks
+ * It's recommended to get channels from {@link TeamsBotInstallation.channels()}.
+ *
+ * @beta
+ */
+export declare class Channel implements NotificationTarget {
+    /**
+     * The parent {@link TeamsBotInstallation} where this channel is created from.
+     *
+     * @beta
+     */
+    readonly parent: TeamsBotInstallation;
+    /**
+     * Detailed channel information.
+     *
+     * @beta
+     */
+    readonly info: ChannelInfo;
+    /**
+     * Notification target type. For channel it's always "Channel".
+     *
+     * @beta
+     */
+    readonly type: NotificationTargetType;
+    /**
+     * Constuctor.
+     *
+     * @remarks
+     * It's recommended to get channels from {@link TeamsBotInstallation.channels()}, instead of using this constructor.
+     *
+     * @param parent - The parent {@link TeamsBotInstallation} where this channel is created from.
+     * @param info - Detailed channel information.
+     *
+     * @beta
+     */
+    constructor(parent: TeamsBotInstallation, info: ChannelInfo);
+    /**
+     * Send a plain text message.
+     *
+     * @param text - the plain text message.
+     * @returns A `Promise` representing the asynchronous operation.
+     *
+     * @beta
+     */
+    sendMessage(text: string): Promise<void>;
+    /**
+     * Send an adaptive card message.
+     *
+     * @param card - the adaptive card raw JSON.
+     * @returns A `Promise` representing the asynchronous operation.
+     *
+     * @beta
+     */
+    sendAdaptiveCard(card: unknown): Promise<void>;
+    /**
+     * @internal
+     */
+    private newConversation;
+}
+
+/**
+ * A command bot for receiving commands and sending responses in Teams.
+ *
+ * @remarks
+ * Ensure each command should ONLY be registered with the command once, otherwise it'll cause unexpected behavior if you register the same command more than once.
+ *
+ * @example
+ * You can register your commands  through the constructor of the {@link CommandBot}, or use the `registerCommand` and `registerCommands` API to add commands after creating the `CommandBot` instance.
+ *
+ * ```typescript
+ * // register through constructor
+ * const commandBot = new CommandBot(adapter, [ new HelloWorldCommandHandler() ]);
+ *
+ * // register through `register*` API
+ * commandBot.registerCommand(new HelpCommandHandler());
+ * ```
+ *
+ * @beta
+ */
+export declare class CommandBot {
+    readonly adapter: BotFrameworkAdapter;
+    private readonly middleware;
+    /**
+     * Creates a new instance of the `CommandBot`.
+     *
+     * @param adapter The bound `BotFrameworkAdapter`.
+     * @param commands The commands to registered with the command bot. Each command should implement the interface {@link TeamsFxBotCommandHandler} so that it can be correctly handled by this command bot.
+     *
+     * @beta
+     */
+    constructor(adapter: BotFrameworkAdapter, commands?: TeamsFxBotCommandHandler[]);
+    /**
+     * Registers a command into the command bot.
+     *
+     * @param command The command to registered.
+     *
+     * @beta
+     */
+    registerCommand(command: TeamsFxBotCommandHandler): void;
+    /**
+     * Registers commands into the command bot.
+     *
+     * @param commands The command to registered.
+     *
+     * @beta
+     */
+    registerCommands(commands: TeamsFxBotCommandHandler[]): void;
+}
+
+/**
+ * Initializes new Axios instance with specific auth provider
+ *
+ * @param apiEndpoint - Base url of the API
+ * @param authProvider - Auth provider that injects authentication info to each request
+ * @returns axios instance configured with specfic auth provider
+ *
+ * @example
+ * ```typescript
+ * const client = createApiClient("https://my-api-endpoint-base-url", new BasicAuthProvider("xxx","xxx"));
+ * ```
+ *
+ * @beta
+ */
+export declare function createApiClient(apiEndpoint: string, authProvider: AuthProvider): AxiosInstance;
+
 /**
  * Get Microsoft graph client.
  *
@@ -353,6 +538,198 @@ export declare enum LogLevel {
     Error = 3
 }
 
+/**
+ * A {@link NotificationTarget} that represents a team member.
+ *
+ * @remarks
+ * It's recommended to get members from {@link TeamsBotInstallation.members()}.
+ *
+ * @beta
+ */
+export declare class Member implements NotificationTarget {
+    /**
+     * The parent {@link TeamsBotInstallation} where this member is created from.
+     *
+     * @beta
+     */
+    readonly parent: TeamsBotInstallation;
+    /**
+     * Detailed member account information.
+     *
+     * @beta
+     */
+    readonly account: TeamsChannelAccount;
+    /**
+     * Notification target type. For member it's always "Person".
+     *
+     * @beta
+     */
+    readonly type: NotificationTargetType;
+    /**
+     * Constuctor.
+     *
+     * @remarks
+     * It's recommended to get members from {@link TeamsBotInstallation.members()}, instead of using this constructor.
+     *
+     * @param parent - The parent {@link TeamsBotInstallation} where this member is created from.
+     * @param account - Detailed member account information.
+     *
+     * @beta
+     */
+    constructor(parent: TeamsBotInstallation, account: TeamsChannelAccount);
+    /**
+     * Send a plain text message.
+     *
+     * @param text - the plain text message.
+     * @returns A `Promise` representing the asynchronous operation.
+     *
+     * @beta
+     */
+    sendMessage(text: string): Promise<void>;
+    /**
+     * Send an adaptive card message.
+     *
+     * @param card - the adaptive card raw JSON.
+     * @returns A `Promise` representing the asynchronous operation.
+     *
+     * @beta
+     */
+    sendAdaptiveCard(card: unknown): Promise<void>;
+    /**
+     * @internal
+     */
+    private newConversation;
+}
+
+/**
+ * Provides utility method to build bot message with cards that supported in Teams.
+ */
+export declare class MessageBuilder {
+    /**
+     * Build a bot message activity attached with adaptive card.
+     *
+     * @param getCardData Function to prepare your card data.
+     * @param cardTemplate The adaptive card template.
+     * @returns A bot message activity attached with an adaptive card.
+     *
+     * @example
+     * ```javascript
+     * const cardTemplate = {
+     *   type: "AdaptiveCard",
+     *   body: [
+     *     {
+     *       "type": "TextBlock",
+     *       "text": "${title}",
+     *       "size": "Large"
+     *     },
+     *     {
+     *       "type": "TextBlock",
+     *       "text": "${description}"
+     *     }],
+     *     $schema: "http://adaptivecards.io/schemas/adaptive-card.json",
+     *     version: "1.4"
+     *  };
+     *
+     * type CardData = {
+     *   title: string,
+     *   description: string
+     * };
+     * const card = MessageBuilder.attachAdaptiveCard<CardData>(() => {
+     *     return {
+     *       title: "sample card title",
+     *       description: "sample card description"
+     *     }}, cardTemplate);
+     * ```
+     *
+     * @beta
+     */
+    static attachAdaptiveCard<TData>(getCardData: () => TData, cardTemplate: any): Partial<Activity_2>;
+    /**
+     * Build a bot message activity attached with an adaptive card.
+     *
+     * @param card The adaptive card content.
+     * @returns A bot message activity attached with an adaptive card.
+     *
+     * @beta
+     */
+    static attachAdaptiveCardWithoutData(card: any): Partial<Activity_2>;
+    /**
+     * Build a bot message activity attached with an hero card.
+     *
+     * @param title The card title.
+     * @param images Optional. The array of images to include on the card.
+     * @param buttons Optional. The array of buttons to include on the card. Each `string` in the array
+     *      is converted to an `imBack` button with a title and value set to the value of the string.
+     * @param other Optional. Any additional properties to include on the card.
+     *
+     * @returns A bot message activity attached with a hero card.
+     *
+     * @example
+     * ```javascript
+     * const message = MessageBuilder.attachHeroCard(
+     *      'sample title',
+     *      ['https://example.com/sample.jpg'],
+     *      ['action']
+     * );
+     * ```
+     *
+     * @beta
+     */
+    static attachHeroCard(title: string, images?: (CardImage | string)[], buttons?: (CardAction | string)[], other?: Partial<HeroCard>): Partial<Activity_2>;
+    /**
+     * Returns an attachment for a sign-in card.
+     *
+     * @param title The title for the card's sign-in button.
+     * @param url The URL of the sign-in page to use.
+     * @param text Optional. Additional text to include on the card.
+     *
+     * @returns A bot message activity attached with a sign-in card.
+     *
+     * @remarks
+     * For channels that don't natively support sign-in cards, an alternative message is rendered.
+     *
+     * @beta
+     */
+    static attachSigninCard(title: string, url: string, text?: string): Partial<Activity_2>;
+    /**
+     * Build a bot message activity attached with an Office 365 connector card.
+     *
+     * @param card A description of the Office 365 connector card.
+     * @returns A bot message activity attached with an Office 365 connector card.
+     *
+     * @beta
+     */
+    static attachO365ConnectorCard(card: O365ConnectorCard): Partial<Activity_2>;
+    /**
+     * Build a message activity attached with a receipt card.
+     * @param card A description of the receipt card.
+     * @returns A message activity attached with a receipt card.
+     *
+     * @beta
+     */
+    static AttachReceiptCard(card: ReceiptCard): Partial<Activity_2>;
+    /**
+     *
+     * @param title The card title.
+     * @param images Optional. The array of images to include on the card.
+     * @param buttons Optional. The array of buttons to include on the card. Each `string` in the array
+     *      is converted to an `imBack` button with a title and value set to the value of the string.
+     * @param other Optional. Any additional properties to include on the card.
+     * @returns A message activity attached with a thumbnail card
+     *
+     * @beta
+     */
+    static attachThumbnailCard(title: string, images?: (CardImage | string)[], buttons?: (CardAction | string)[], other?: Partial<ThumbnailCard>): Partial<Activity_2>;
+    /**
+     * Add an attachement to a bot activity.
+     * @param attachement The attachment object to attach.
+     * @returns A message activity with an attachment.
+     *
+     * @beta
+     */
+    static attachContent(attachement: Attachment): Partial<Activity_2>;
+}
+
 /**
  * Microsoft Graph auth provider for Teams Framework
  *
@@ -389,6 +766,174 @@ export declare class MsGraphAuthProvider implements AuthenticationProvider {
     getAccessToken(): Promise<string>;
 }
 
+/**
+ * Provide static utilities for bot conversation, including
+ * - send notification to varies targets (e.g., member, channel, incoming wehbook)
+ * - handle command and response.
+ *
+ * @example
+ * Here's an example on how to send notification via Teams Bot.
+ * ```typescript
+ * // initialize (it's recommended to be called before handling any bot message)
+ * const notificationBot = new NotificationBot(adapter);
+ *
+ * // get all bot installations and send message
+ * for (const target of await notificationBot.installations()) {
+ *   await target.sendMessage("Hello Notification");
+ * }
+ *
+ * // alternative - send message to all members
+ * for (const target of await notificationBot.installations()) {
+ *   for (const member of await target.members()) {
+ *     await member.sendMessage("Hello Notification");
+ *   }
+ * }
+ * ```
+ *
+ * @beta
+ */
+export declare class NotificationBot {
+    private readonly conversationReferenceStore;
+    private readonly adapter;
+    /**
+     * constructor of the notification bot.
+     *
+     * @remarks
+     * To ensure accuracy, it's recommended to initialize before handling any message.
+     *
+     * @param adapter - the bound `BotFrameworkAdapter`
+     * @param options - initialize options
+     *
+     * @beta
+     */
+    constructor(adapter: BotFrameworkAdapter, options?: NotificationOptions_2);
+    /**
+     * Get all targets where the bot is installed.
+     *
+     * @remarks
+     * The result is retrieving from the persisted storage.
+     *
+     * @returns - an array of {@link TeamsBotInstallation}.
+     *
+     * @beta
+     */
+    installations(): Promise<TeamsBotInstallation[]>;
+}
+
+/**
+ * Options to initialize {@link NotificationBot}.
+ *
+ * @beta
+ */
+declare interface NotificationOptions_2 {
+    /**
+     * An optional storage to persist bot notification connections.
+     *
+     * @remarks
+     * If `storage` is not provided, a default local file storage will be used,
+     * which stores notification connections into:
+     *   - ".notification.localstore.json" if running locally
+     *   - "${process.env.TEMP}/.notification.localstore.json" if `process.env.RUNNING_ON_AZURE` is set to "1"
+     *
+     * It's recommended to use your own shared storage for production environment.
+     *
+     * @beta
+     */
+    storage?: NotificationTargetStorage;
+}
+export { NotificationOptions_2 as NotificationOptions }
+
+/**
+ * Represent a notification target.
+ *
+ * @beta
+ */
+export declare interface NotificationTarget {
+    /**
+     * The type of target, could be "Channel" or "Group" or "Person".
+     *
+     * @beta
+     */
+    readonly type?: NotificationTargetType;
+    /**
+     * Send a plain text message.
+     *
+     * @param text - the plain text message.
+     *
+     * @beta
+     */
+    sendMessage(text: string): Promise<void>;
+    /**
+     * Send an adaptive card message.
+     *
+     * @param card - the adaptive card raw JSON.
+     *
+     * @beta
+     */
+    sendAdaptiveCard(card: unknown): Promise<void>;
+}
+
+/**
+ * Interface for a storage provider that stores and retrieves notification target references.
+ *
+ * @beta
+ */
+export declare interface NotificationTargetStorage {
+    /**
+     * Read one notification target by its key.
+     *
+     * @param key - the key of a notification target.
+     *
+     * @returns - the notification target. Or undefined if not found.
+     *
+     * @beta
+     */
+    read(key: string): Promise<{
+        [key: string]: unknown;
+    } | undefined>;
+    /**
+     * List all stored notification targets.
+     *
+     * @returns - an array of notification target. Or an empty array if nothing is stored.
+     *
+     * @beta
+     */
+    list(): Promise<{
+        [key: string]: unknown;
+    }[]>;
+    /**
+     * Write one notification target by its key.
+     *
+     * @param key - the key of a notification target.
+     * @param object - the notification target.
+     *
+     * @beta
+     */
+    write(key: string, object: {
+        [key: string]: unknown;
+    }): Promise<void>;
+    /**
+     * Delete one notificaton target by its key.
+     *
+     * @param key - the key of a notification target.
+     *
+     * @beta
+     */
+    delete(key: string): Promise<void>;
+}
+
+/**
+ * The target type where the notification will be sent to.
+ *
+ * @remarks
+ * - "Channel" means to a team channel. (By default, notification to a team will be sent to its "General" channel.)
+ * - "Group" means to a group chat.
+ * - "Person" means to a personal chat.
+ *
+ * @beta
+ */
+export declare type NotificationTargetType = "Channel" | "Group" | "Person";
+
 /**
  * Represent on-behalf-of flow to get user identity, and it is designed to be used in server side.
  *
@@ -476,6 +1021,28 @@ export declare class OnBehalfOfUserCredential implements TokenCredential {
     private generateAuthServerError;
 }
 
+/**
+ * Send an adaptive card message to a notification target.
+ *
+ * @param target - the notification target.
+ * @param card - the adaptive card raw JSON.
+ * @returns A `Promise` representing the asynchronous operation.
+ *
+ * @beta
+ */
+export declare function sendAdaptiveCard(target: NotificationTarget, card: unknown): Promise<void>;
+
+/**
+ * Send a plain text message to a notification target.
+ *
+ * @param target - the notification target.
+ * @param text - the plain text message.
+ * @returns A `Promise` representing the asynchronous operation.
+ *
+ * @beta
+ */
+export declare function sendMessage(target: NotificationTarget, text: string): Promise<void>;
+
 /**
  * Set custom log function. Use the function if it's set. Priority is lower than setLogger.
  *
@@ -522,6 +1089,89 @@ export declare function setLogger(logger?: Logger): void;
  */
 export declare function setLogLevel(level: LogLevel): void;
 
+/**
+ * A {@link NotificationTarget} that represents a bot installation. Teams Bot could be installed into
+ * - Personal chat
+ * - Group chat
+ * - Team (by default the `General` channel)
+ *
+ * @remarks
+ * It's recommended to get bot installations from {@link ConversationBot.installations()}.
+ *
+ * @beta
+ */
+export declare class TeamsBotInstallation implements NotificationTarget {
+    /**
+     * The bound `BotFrameworkAdapter`.
+     *
+     * @beta
+     */
+    readonly adapter: BotFrameworkAdapter;
+    /**
+     * The bound `ConversationReference`.
+     *
+     * @beta
+     */
+    readonly conversationReference: Partial<ConversationReference>;
+    /**
+     * Notification target type.
+     *
+     * @remarks
+     * - "Channel" means bot is installed into a team and notification will be sent to its "General" channel.
+     * - "Group" means bot is installed into a group chat.
+     * - "Person" means bot is installed into a personal scope and notification will be sent to personal chat.
+     *
+     * @beta
+     */
+    readonly type?: NotificationTargetType;
+    /**
+     * Constructor
+     *
+     * @remarks
+     * It's recommended to get bot installations from {@link ConversationBot.installations()}, instead of using this constructor.
+     *
+     * @param adapter - the bound `BotFrameworkAdapter`.
+     * @param conversationReference - the bound `ConversationReference`.
+     *
+     * @beta
+     */
+    constructor(adapter: BotFrameworkAdapter, conversationReference: Partial<ConversationReference>);
+    /**
+     * Send a plain text message.
+     *
+     * @param text - the plain text message.
+     * @returns A `Promise` representing the asynchronous operation.
+     *
+     * @beta
+     */
+    sendMessage(text: string): Promise<void>;
+    /**
+     * Send an adaptive card message.
+     *
+     * @param card - the adaptive card raw JSON.
+     * @returns A `Promise` representing the asynchronous operation.
+     *
+     * @beta
+     */
+    sendAdaptiveCard(card: unknown): Promise<void>;
+    /**
+     * Get channels from this bot installation.
+     *
+     * @returns an array of channels if bot is installed into a team, otherwise returns an empty array.
+     *
+     * @beta
+     */
+    channels(): Promise<Channel[]>;
+    /**
+     * Get members from this bot installation.
+     *
+     * @returns an array of members from where the bot is installed.
+     *
+     * @beta
+     */
+    members(): Promise<Member[]>;
+}
+
 /**
  * Creates a new prompt that leverage Teams Single Sign On (SSO) support for bot to automatically sign in user and
  * help receive oauth token, asks the user to consent if needed.
@@ -809,6 +1459,26 @@ export declare class TeamsFx implements TeamsFxConfiguration {
     private loadFromEnv;
 }
 
+/**
+ * Interface for a command handler that can process command to a TeamsFx bot and return a response.
+ *
+ * @beta
+ */
+export declare interface TeamsFxBotCommandHandler {
+    /**
+     * The command name or RegExp pattern that can trigger this handler.
+     */
+    commandNameOrPattern: string | RegExp;
+    /**
+     * Handles a bot command received activity.
+     *
+     * @param context The bot context.
+     * @param receivedText The command text the user types from Teams.
+     * @returns A `Promise` representing an activity or text to send as the command response.
+     */
+    handleCommandReceived(context: TurnContext, receivedText: string): Promise<string | Partial<Activity>>;
+}
+
 /**
  * TeamsFx interface that provides credential and configuration.
  * @beta