@microsoft/teamsfx 2.1.1-alpha.f8e51b9d8.0 → 2.2.0-alpha.034f24ebd.0

package/dist/index.esm2017.mjs

@@ -3,7 +3,7 @@ import { ConfidentialClientApplication } from '@azure/msal-node';
 import { createHash } from 'crypto';
 import { Client } from '@microsoft/microsoft-graph-client';
 import { ManagedIdentityCredential } from '@azure/identity';
-import { ActivityTypes, Channels, TeamsInfo, CardFactory, ActionTypes, MessageFactory, StatusCodes, verifyStateOperationName, tokenExchangeOperationName, TurnContext, TeamsActivityHandler, MemoryStorage, UserState, ConversationState, BotFrameworkAdapter } from 'botbuilder';
+import { ActivityTypes, Channels, TeamsInfo, CardFactory, ActionTypes, MessageFactory, StatusCodes, verifyStateOperationName, tokenExchangeOperationName, TurnContext, TeamsActivityHandler, MemoryStorage, UserState, ConversationState, BotFrameworkAdapter, ConfigurationServiceClientCredentialFactory, ConfigurationBotFrameworkAuthentication, CloudAdapter } from 'botbuilder';
 import { Dialog, ComponentDialog, WaterfallDialog, DialogSet, DialogTurnStatus } from 'botbuilder-dialogs';
 import { v4 } from 'uuid';
 import axios from 'axios';
@@ -2007,9 +2007,9 @@ class InvokeResponseFactory {
      * The type of the invoke response is `application/vnd.microsoft.activity.message`
      * indicates the request was successfully processed.
      *
-     * @param message A text message included in a invoke response.
+     * @param message - A text message included in a invoke response.
      *
-     * @returns {InvokeResponse} An InvokeResponse object.
+     * @returns An `InvokeResponse` object.
      */
     static textMessage(message) {
         if (!message) {
@@ -2031,9 +2031,9 @@ class InvokeResponseFactory {
      * the request was successfully processed, and the response includes an adaptive card
      * that the client should display in place of the current one.
      *
-     * @param card The adaptive card JSON payload.
+     * @param card - The adaptive card JSON payload.
      *
-     * @returns {InvokeResponse} An InvokeResponse object.
+     * @returns An `InvokeResponse` object.
      */
     static adaptiveCard(card) {
         if (!card) {
@@ -2054,12 +2054,12 @@ class InvokeResponseFactory {
      * The type of the invoke response is `application/vnd.microsoft.error` indicates
      * the request was failed to processed.
      *
-     * @param errorCode The status code indicates error, available values:
+     * @param errorCode - The status code indicates error, available values:
      *  - 400 (BadRequest): indicate the incoming request was invalid.
      *  - 500 (InternalServerError): indicate an unexpected error occurred.
-     * @param errorMessage The error message.
+     * @param errorMessage - The error message.
      *
-     * @returns {InvokeResponse} An InvokeResponse object.
+     * @returns An `InvokeResponse` object.
      */
     static errorResponse(errorCode, errorMessage) {
         return {
@@ -2076,10 +2076,10 @@ class InvokeResponseFactory {
     }
     /**
      * Create an invoke response with status code and response value.
-     * @param statusCode The status code.
-     * @param body The value of the response body.
+     * @param statusCode - The status code.
+     * @param body - The value of the response body.
      *
-     * @returns {InvokeResponse} An InvokeResponse object.
+     * @returns An `InvokeResponse` object.
      */
     static createInvokeResponse(statusCode, body) {
         return {
@@ -2167,7 +2167,10 @@ class CardActionMiddleware {
 /**
  * A card action bot to respond to adaptive card universal actions.
  */
-class CardActionBot {
+/**
+ * @deprecated Use `BotBuilderCloudAdapter.CardActionBot` instead.
+ */
+class CardActionBot$1 {
     /**
      * Creates a new instance of the `CardActionBot`.
      *
@@ -2321,7 +2324,10 @@ class CommandResponseMiddleware {
  * @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.
  */
-class CommandBot {
+/**
+ * @deprecated Use `BotBuilderCloudAdapter.CommandBot` instead.
+ */
+class CommandBot$1 {
     /**
      * Creates a new instance of the `CommandBot`.
      *
@@ -2419,7 +2425,7 @@ function getTeamsBotInstallationId(context) {
         return teamId;
     }
     // Fallback to use conversation id.
-    // the conversation id is equal to team id only when the bot app is installed into the General channel.
+    // The conversation id is equal to team id only when the bot app is installed into the General channel.
     if (context.activity.conversation.name === undefined) {
         return context.activity.conversation.id;
     }
@@ -2645,7 +2651,7 @@ class ConversationReferenceStore {
  * If not defined, error will be handled by `BotAdapter.onTurnError`.
  * @returns the response of sending message.
  */
-function sendMessage(target, text, onError) {
+function sendMessage$1(target, text, onError) {
     return target.sendMessage(text, onError);
 }
 /**
@@ -2657,7 +2663,7 @@ function sendMessage(target, text, onError) {
  * If not defined, error will be handled by `BotAdapter.onTurnError`.
  * @returns the response of sending adaptive card message.
  */
-function sendAdaptiveCard(target, card, onError) {
+function sendAdaptiveCard$1(target, card, onError) {
     return target.sendAdaptiveCard(card, onError);
 }
 /**
@@ -2666,7 +2672,7 @@ function sendAdaptiveCard(target, card, onError) {
  * @remarks
  * It's recommended to get channels from {@link TeamsBotInstallation.channels()}.
  */
-class Channel {
+class Channel$1 {
     /**
      * Constructor.
      *
@@ -2760,7 +2766,7 @@ class Channel {
  * @remarks
  * It's recommended to get members from {@link TeamsBotInstallation.members()}.
  */
-class Member {
+class Member$1 {
     /**
      * Constructor.
      *
@@ -2865,7 +2871,10 @@ class Member {
  * @remarks
  * It's recommended to get bot installations from {@link ConversationBot.installations()}.
  */
-class TeamsBotInstallation {
+/**
+ * @deprecated Use `BotBuilderCloudAdapter.TeamsBotInstallation` instead.
+ */
+class TeamsBotInstallation$1 {
     /**
      * Constructor
      *
@@ -2952,7 +2961,7 @@ class TeamsBotInstallation {
             }
         });
         for (const channel of teamsChannels) {
-            channels.push(new Channel(this, channel));
+            channels.push(new Channel$1(this, channel));
         }
         return channels;
     }
@@ -2969,7 +2978,7 @@ class TeamsBotInstallation {
                 const pagedMembers = await TeamsInfo.getPagedMembers(context, undefined, continuationToken);
                 continuationToken = pagedMembers.continuationToken;
                 for (const member of pagedMembers.members) {
-                    members.push(new Member(this, member));
+                    members.push(new Member$1(this, member));
                 }
             } while (continuationToken !== undefined);
         });
@@ -2997,7 +3006,10 @@ class TeamsBotInstallation {
 /**
  * Provide utilities to send notification to varies targets (e.g., member, group, channel).
  */
-class NotificationBot {
+/**
+ * @deprecated Use `BotBuilderCloudAdapter.NotificationBot` instead.
+ */
+class NotificationBot$1 {
     /**
      * constructor of the notification bot.
      *
@@ -3044,7 +3056,7 @@ class NotificationBot {
                 }
             });
             if (valid) {
-                targets.push(new TeamsBotInstallation(this.adapter, reference));
+                targets.push(new TeamsBotInstallation$1(this.adapter, reference));
             }
             else {
                 await this.conversationReferenceStore.delete(reference);
@@ -3139,10 +3151,10 @@ class NotificationBot {
         return channels;
     }
     matchSearchScope(target, scope) {
-        scope = scope !== null && scope !== void 0 ? scope : SearchScope.All;
-        return ((target.type === NotificationTargetType.Channel && (scope & SearchScope.Channel) !== 0) ||
-            (target.type === NotificationTargetType.Group && (scope & SearchScope.Group) !== 0) ||
-            (target.type === NotificationTargetType.Person && (scope & SearchScope.Person) !== 0));
+        scope = scope !== null && scope !== void 0 ? scope : SearchScope$1.All;
+        return ((target.type === NotificationTargetType.Channel && (scope & SearchScope$1.Channel) !== 0) ||
+            (target.type === NotificationTargetType.Group && (scope & SearchScope$1.Group) !== 0) ||
+            (target.type === NotificationTargetType.Person && (scope & SearchScope$1.Person) !== 0));
     }
 }
 /**
@@ -3150,7 +3162,7 @@ class NotificationBot {
  * The search scope is a flagged enum and it can be combined with `|`.
  * For example, to search from personal chat and group chat, use `SearchScope.Person | SearchScope.Group`.
  */
-var SearchScope;
+var SearchScope$1;
 (function (SearchScope) {
     /**
      * Search members from the installations in personal chat only.
@@ -3168,7 +3180,7 @@ var SearchScope;
      * Search members from all installations including personal chat, group chat and Teams channel.
      */
     SearchScope[SearchScope["All"] = 7] = "All";
-})(SearchScope || (SearchScope = {}));
+})(SearchScope$1 || (SearchScope$1 = {}));
 
 // Copyright (c) Microsoft Corporation.
 let DIALOG_NAME = "BotSsoExecutionDialog";
@@ -3563,7 +3575,10 @@ class DefaultBotSsoExecutionActivityHandler extends TeamsActivityHandler {
  *
  * For notification, set `notification.storage` in {@link ConversationOptions} to use your own storage implementation.
  */
-class ConversationBot {
+/**
+ * @deprecated Use `BotBuilderCloudAdapter.ConversationBot` instead.
+ */
+class ConversationBot$1 {
     /**
      * Creates new instance of the `ConversationBot`.
      *
@@ -3591,13 +3606,13 @@ class ConversationBot {
             }
         }
         if ((_b = options.command) === null || _b === void 0 ? void 0 : _b.enabled) {
-            this.command = new CommandBot(this.adapter, options.command, ssoCommandActivityHandler, options.ssoConfig);
+            this.command = new CommandBot$1(this.adapter, options.command, ssoCommandActivityHandler, options.ssoConfig);
         }
         if ((_c = options.notification) === null || _c === void 0 ? void 0 : _c.enabled) {
-            this.notification = new NotificationBot(this.adapter, options.notification);
+            this.notification = new NotificationBot$1(this.adapter, options.notification);
         }
         if ((_d = options.cardAction) === null || _d === void 0 ? void 0 : _d.enabled) {
-            this.cardAction = new CardActionBot(this.adapter, options.cardAction);
+            this.cardAction = new CardActionBot$1(this.adapter, options.cardAction);
         }
     }
     createDefaultAdapter(adapterConfig) {
@@ -3988,5 +4003,827 @@ async function handleMessageExtensionQueryWithSSO(context, config, initiateLogin
     return await executionWithTokenAndConfig(context, config !== null && config !== void 0 ? config : {}, initiateLoginEndpoint, scopes, logic);
 }
 
-export { AdaptiveCardResponse, ApiKeyLocation, ApiKeyProvider, AppCredential, BasicAuthProvider, BearerTokenAuthProvider, BotSsoExecutionDialog, CardActionBot, CertificateAuthProvider, Channel, CommandBot, ConversationBot, ErrorCode, ErrorWithCode, IdentityType, InvokeResponseErrorCode, InvokeResponseFactory, LogLevel, Member, MessageBuilder, MsGraphAuthProvider, NotificationBot, NotificationTargetType, OnBehalfOfUserCredential, SearchScope, TeamsBotInstallation, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createApiClient, createMicrosoftGraphClient, createMicrosoftGraphClientWithCredential, createPemCertOption, createPfxCertOption, getLogLevel, getTediousConnectionConfig, handleMessageExtensionQueryWithSSO, handleMessageExtensionQueryWithToken, sendAdaptiveCard, sendMessage, setLogFunction, setLogLevel, setLogger };
+/**
+ * A card action bot to respond to adaptive card universal actions.
+ */
+class CardActionBot {
+    /**
+     * Create a new instance of the `CardActionBot`.
+     *
+     * @param adapter - The bound `CloudAdapter`.
+     * @param options - The initialize options.
+     */
+    constructor(adapter, options) {
+        this.middleware = new CardActionMiddleware(options === null || options === void 0 ? void 0 : options.actions);
+        this.adapter = adapter.use(this.middleware);
+    }
+    /**
+     * Register a card action handler to the bot.
+     *
+     * @param actionHandler - A card action handler to be registered.
+     */
+    registerHandler(actionHandler) {
+        if (actionHandler) {
+            this.middleware.actionHandlers.push(actionHandler);
+        }
+    }
+    /**
+     * Register card action handlers to the bot.
+     *
+     * @param actionHandlers - A set of card action handlers to be registered.
+     */
+    registerHandlers(actionHandlers) {
+        if (actionHandlers) {
+            this.middleware.actionHandlers.push(...actionHandlers);
+        }
+    }
+}
+
+// Copyright (c) Microsoft Corporation.
+/**
+ * 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.
+ */
+class CommandBot {
+    // eslint-disable-next-line no-secrets/no-secrets
+    /**
+     * Create a new instance of the `CommandBot`.
+     *
+     * @param adapter - The bound `CloudAdapter`.
+     * @param options - The initialize options
+     * @param ssoCommandActivityHandler - SSO execution activity handler.
+     * @param ssoConfig - SSO configuration for Bot SSO.
+     */
+    constructor(adapter, options, ssoCommandActivityHandler, ssoConfig) {
+        this.ssoConfig = ssoConfig;
+        this.middleware = new CommandResponseMiddleware(options === null || options === void 0 ? void 0 : options.commands, options === null || options === void 0 ? void 0 : options.ssoCommands, ssoCommandActivityHandler);
+        this.adapter = adapter.use(this.middleware);
+    }
+    /**
+     * Register a command into the command bot.
+     *
+     * @param command - The command to be registered.
+     */
+    registerCommand(command) {
+        if (command) {
+            this.middleware.commandHandlers.push(command);
+        }
+    }
+    /**
+     * Register commands into the command bot.
+     *
+     * @param commands - The commands to be registered.
+     */
+    registerCommands(commands) {
+        if (commands) {
+            this.middleware.commandHandlers.push(...commands);
+        }
+    }
+    /**
+     * Register a sso command into the command bot.
+     *
+     * @param ssoCommand - The sso command to be registered.
+     */
+    registerSsoCommand(ssoCommand) {
+        this.validateSsoActivityHandler();
+        this.middleware.addSsoCommand(ssoCommand);
+    }
+    /**
+     * Register sso commands into the command bot.
+     *
+     * @param ssoCommands - The sso commands to be registered.
+     */
+    registerSsoCommands(ssoCommands) {
+        if (ssoCommands.length > 0) {
+            this.validateSsoActivityHandler();
+            for (const ssoCommand of ssoCommands) {
+                this.middleware.addSsoCommand(ssoCommand);
+            }
+        }
+    }
+    validateSsoActivityHandler() {
+        if (!this.middleware.ssoActivityHandler) {
+            internalLogger.error(ErrorMessage.SsoActivityHandlerIsNull);
+            throw new ErrorWithCode(ErrorMessage.SsoActivityHandlerIsNull, ErrorCode.SsoActivityHandlerIsUndefined);
+        }
+    }
+}
+
+// Copyright (c) Microsoft Corporation.
+/**
+ * Send a plain text message to a notification target.
+ *
+ * @param target - The notification target.
+ * @param text - The plain text message.
+ * @param onError - An optional error handler that can catch exceptions during message sending.
+ * If not defined, error will be handled by `BotAdapter.onTurnError`.
+ *
+ * @returns The response of sending message.
+ */
+function sendMessage(target, text, onError) {
+    return target.sendMessage(text, onError);
+}
+/**
+ * Send an adaptive card message to a notification target.
+ *
+ * @param target - The notification target.
+ * @param card - The adaptive card raw JSON.
+ * @param onError - An optional error handler that can catch exceptions during adaptive card sending.
+ * If not defined, error will be handled by `BotAdapter.onTurnError`.
+ *
+ * @returns The response of sending adaptive card message.
+ */
+function sendAdaptiveCard(target, card, onError) {
+    return target.sendAdaptiveCard(card, onError);
+}
+/**
+ * A {@link NotificationTarget} that represents a team channel.
+ *
+ * @remarks
+ * It's recommended to get channels from {@link TeamsBotInstallation.channels()}.
+ */
+class Channel {
+    /**
+     * Constructor.
+     *
+     * @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.
+     */
+    constructor(parent, info) {
+        /**
+         * Notification target type. For channel it's always "Channel".
+         */
+        this.type = NotificationTargetType.Channel;
+        this.parent = parent;
+        this.info = info;
+    }
+    /**
+     * Send a plain text message.
+     *
+     * @param text - The plain text message.
+     * @param onError - An optional error handler that can catch exceptions during message sending.
+     * If not defined, error will be handled by `BotAdapter.onTurnError`.
+     *
+     * @returns The response of sending message.
+     */
+    async sendMessage(text, onError) {
+        const response = {};
+        await this.parent.adapter.continueConversationAsync(this.parent.botAppId, this.parent.conversationReference, async (context) => {
+            const conversation = await this.newConversation(context);
+            await this.parent.adapter.continueConversationAsync(this.parent.botAppId, conversation, async (ctx) => {
+                try {
+                    const res = await ctx.sendActivity(text);
+                    response.id = res === null || res === void 0 ? void 0 : res.id;
+                }
+                catch (error) {
+                    if (onError) {
+                        await onError(ctx, error);
+                    }
+                    else {
+                        throw error;
+                    }
+                }
+            });
+        });
+        return response;
+    }
+    /**
+     * Send an adaptive card message.
+     *
+     * @param card - The adaptive card raw JSON.
+     * @param onError - An optional error handler that can catch exceptions during adaptive card sending.
+     * If not defined, error will be handled by `BotAdapter.onTurnError`.
+     *
+     * @returns The response of sending adaptive card message.
+     */
+    async sendAdaptiveCard(card, onError) {
+        const response = {};
+        await this.parent.adapter.continueConversationAsync(this.parent.botAppId, this.parent.conversationReference, async (context) => {
+            const conversation = await this.newConversation(context);
+            await this.parent.adapter.continueConversationAsync(this.parent.botAppId, conversation, async (ctx) => {
+                try {
+                    const res = await ctx.sendActivity({
+                        attachments: [CardFactory.adaptiveCard(card)],
+                    });
+                    response.id = res === null || res === void 0 ? void 0 : res.id;
+                }
+                catch (error) {
+                    if (onError) {
+                        await onError(ctx, error);
+                    }
+                    else {
+                        throw error;
+                    }
+                }
+            });
+        });
+        return response;
+    }
+    /**
+     * @internal
+     */
+    async newConversation(context) {
+        const reference = TurnContext.getConversationReference(context.activity);
+        const channelConversation = cloneConversation(reference);
+        channelConversation.conversation.id = this.info.id || "";
+        return channelConversation;
+    }
+}
+/**
+ * A {@link NotificationTarget} that represents a team member.
+ *
+ * @remarks
+ * It's recommended to get members from {@link TeamsBotInstallation.members()}.
+ */
+class Member {
+    /**
+     * Constructor.
+     *
+     * @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.
+     */
+    constructor(parent, account) {
+        /**
+         * Notification target type. For member it's always "Person".
+         */
+        this.type = NotificationTargetType.Person;
+        this.parent = parent;
+        this.account = account;
+    }
+    /**
+     * Send a plain text message.
+     *
+     * @param text - The plain text message.
+     * @param onError - An optional error handler that can catch exceptions during message sending.
+     * If not defined, error will be handled by `BotAdapter.onTurnError`.
+     *
+     * @returns The response of sending message.
+     */
+    async sendMessage(text, onError) {
+        const response = {};
+        await this.parent.adapter.continueConversationAsync(this.parent.botAppId, this.parent.conversationReference, async (context) => {
+            const conversation = await this.newConversation(context);
+            await this.parent.adapter.continueConversationAsync(this.parent.botAppId, conversation, async (ctx) => {
+                try {
+                    const res = await ctx.sendActivity(text);
+                    response.id = res === null || res === void 0 ? void 0 : res.id;
+                }
+                catch (error) {
+                    if (onError) {
+                        await onError(ctx, error);
+                    }
+                    else {
+                        throw error;
+                    }
+                }
+            });
+        });
+        return response;
+    }
+    /**
+     * Send an adaptive card message.
+     *
+     * @param card - The adaptive card raw JSON.
+     * @param onError - An optional error handler that can catch exceptions during adaptive card sending.
+     * If not defined, error will be handled by `BotAdapter.onTurnError`.
+     *
+     * @returns The response of sending adaptive card message.
+     */
+    async sendAdaptiveCard(card, onError) {
+        const response = {};
+        await this.parent.adapter.continueConversationAsync(this.parent.botAppId, this.parent.conversationReference, async (context) => {
+            const conversation = await this.newConversation(context);
+            await this.parent.adapter.continueConversationAsync(this.parent.botAppId, conversation, async (ctx) => {
+                try {
+                    const res = await ctx.sendActivity({
+                        attachments: [CardFactory.adaptiveCard(card)],
+                    });
+                    response.id = res === null || res === void 0 ? void 0 : res.id;
+                }
+                catch (error) {
+                    if (onError) {
+                        await onError(ctx, error);
+                    }
+                    else {
+                        throw error;
+                    }
+                }
+            });
+        });
+        return response;
+    }
+    /**
+     * @internal
+     */
+    async newConversation(context) {
+        const reference = TurnContext.getConversationReference(context.activity);
+        const personalConversation = cloneConversation(reference);
+        const connectorClient = context.turnState.get(this.parent.adapter.ConnectorClientKey);
+        const conversation = await connectorClient.conversations.createConversation({
+            isGroup: false,
+            tenantId: context.activity.conversation.tenantId,
+            bot: context.activity.recipient,
+            members: [this.account],
+            channelData: {},
+        });
+        personalConversation.conversation.id = conversation.id;
+        return personalConversation;
+    }
+}
+/**
+ * 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()}.
+ */
+class TeamsBotInstallation {
+    /**
+     * Constructor
+     *
+     * @remarks
+     * It's recommended to get bot installations from {@link ConversationBot.installations()}, instead of using this constructor.
+     *
+     * @param adapter - The bound `CloudAdapter`.
+     * @param conversationReference - The bound `ConversationReference`.
+     * @param botAppId - The bot app id.
+     */
+    constructor(adapter, conversationReference, botAppId) {
+        this.adapter = adapter;
+        this.conversationReference = conversationReference;
+        this.type = getTargetType(conversationReference);
+        this.botAppId = botAppId;
+    }
+    /**
+     * Send a plain text message.
+     *
+     * @param text - The plain text message.
+     * @param onError - An optional error handler that can catch exceptions during message sending.
+     * If not defined, error will be handled by `BotAdapter.onTurnError`.
+     *
+     * @returns The response of sending message.
+     */
+    async sendMessage(text, onError) {
+        const response = {};
+        await this.adapter.continueConversationAsync(this.botAppId, this.conversationReference, async (context) => {
+            try {
+                const res = await context.sendActivity(text);
+                response.id = res === null || res === void 0 ? void 0 : res.id;
+            }
+            catch (error) {
+                if (onError) {
+                    await onError(context, error);
+                }
+                else {
+                    throw error;
+                }
+            }
+        });
+        return response;
+    }
+    /**
+     * Send an adaptive card message.
+     *
+     * @param card - The adaptive card raw JSON.
+     * @param onError - An optional error handler that can catch exceptions during adaptive card sending.
+     * If not defined, error will be handled by `BotAdapter.onTurnError`.
+     *
+     * @returns The response of sending adaptive card message.
+     */
+    async sendAdaptiveCard(card, onError) {
+        const response = {};
+        await this.adapter.continueConversationAsync(this.botAppId, this.conversationReference, async (context) => {
+            try {
+                const res = await context.sendActivity({
+                    attachments: [CardFactory.adaptiveCard(card)],
+                });
+                response.id = res === null || res === void 0 ? void 0 : res.id;
+            }
+            catch (error) {
+                if (onError) {
+                    await onError(context, error);
+                }
+                else {
+                    throw error;
+                }
+            }
+        });
+        return response;
+    }
+    /**
+     * Get channels from this bot installation.
+     *
+     * @returns An array of channels if bot is installed into a team, otherwise returns an empty array.
+     */
+    async channels() {
+        const channels = [];
+        if (this.type !== NotificationTargetType.Channel) {
+            return channels;
+        }
+        let teamsChannels = [];
+        await this.adapter.continueConversationAsync(this.botAppId, this.conversationReference, async (context) => {
+            const teamId = getTeamsBotInstallationId(context);
+            if (teamId !== undefined) {
+                teamsChannels = await TeamsInfo.getTeamChannels(context, teamId);
+            }
+        });
+        for (const channel of teamsChannels) {
+            channels.push(new Channel(this, channel));
+        }
+        return channels;
+    }
+    /**
+     * Get members from this bot installation.
+     *
+     * @returns An array of members from where the bot is installed.
+     */
+    async members() {
+        const members = [];
+        await this.adapter.continueConversationAsync(this.botAppId, this.conversationReference, async (context) => {
+            let continuationToken;
+            do {
+                const pagedMembers = await TeamsInfo.getPagedMembers(context, undefined, continuationToken);
+                continuationToken = pagedMembers.continuationToken;
+                for (const member of pagedMembers.members) {
+                    members.push(new Member(this, member));
+                }
+            } while (continuationToken !== undefined);
+        });
+        return members;
+    }
+    /**
+     * Get team details from this bot installation
+     *
+     * @returns The team details if bot is installed into a team, otherwise returns `undefined`.
+     */
+    async getTeamDetails() {
+        if (this.type !== NotificationTargetType.Channel) {
+            return undefined;
+        }
+        let teamDetails;
+        await this.adapter.continueConversationAsync(this.botAppId, this.conversationReference, async (context) => {
+            const teamId = getTeamsBotInstallationId(context);
+            if (teamId !== undefined) {
+                teamDetails = await TeamsInfo.getTeamDetails(context, teamId);
+            }
+        });
+        return teamDetails;
+    }
+}
+/**
+ * Provide utilities to send notification to varies targets (e.g., member, group, channel).
+ */
+class NotificationBot {
+    /**
+     * Constructor of the notification bot.
+     *
+     * @remarks
+     * To ensure accuracy, it's recommended to initialize before handling any message.
+     *
+     * @param adapter - The bound `CloudAdapter`
+     * @param options - The initialize options
+     */
+    constructor(adapter, options) {
+        var _a, _b, _c;
+        const storage = (_a = options === null || options === void 0 ? void 0 : options.storage) !== null && _a !== void 0 ? _a : new LocalFileStorage(path.resolve(process.env.RUNNING_ON_AZURE === "1" ? (_b = process.env.TEMP) !== null && _b !== void 0 ? _b : "./" : "./"));
+        this.conversationReferenceStore = new ConversationReferenceStore(storage);
+        this.adapter = adapter.use(new NotificationMiddleware({
+            conversationReferenceStore: this.conversationReferenceStore,
+        }));
+        this.botAppId = ((_c = options === null || options === void 0 ? void 0 : options.botAppId) !== null && _c !== void 0 ? _c : process.env.BOT_ID);
+    }
+    /**
+     * Get all targets where the bot is installed.
+     *
+     * @remarks
+     * The result is retrieving from the persisted storage.
+     *
+     * @returns An array of {@link TeamsBotInstallation}.
+     */
+    async installations() {
+        if (this.conversationReferenceStore === undefined || this.adapter === undefined) {
+            throw new Error("NotificationBot has not been initialized.");
+        }
+        const references = await this.conversationReferenceStore.getAll();
+        const targets = [];
+        for (const reference of references) {
+            // validate connection
+            let valid = true;
+            await this.adapter.continueConversationAsync(this.botAppId, reference, async (context) => {
+                try {
+                    // try get member to see if the installation is still valid
+                    await TeamsInfo.getPagedMembers(context, 1);
+                }
+                catch (error) {
+                    if (error.code === "BotNotInConversationRoster") {
+                        valid = false;
+                    }
+                }
+            });
+            if (valid) {
+                targets.push(new TeamsBotInstallation(this.adapter, reference, this.botAppId));
+            }
+            else {
+                await this.conversationReferenceStore.delete(reference);
+            }
+        }
+        return targets;
+    }
+    /**
+     * Return the first {@link Member} where predicate is true, and undefined otherwise.
+     *
+     * @param predicate - Find calls predicate once for each member of the installation,
+     * until it finds one where predicate returns true. If such a member is found, find
+     * immediately returns that member. Otherwise, find returns undefined.
+     * @param scope - The scope to find members from the installations
+     * (personal chat, group chat, Teams channel).
+     *
+     * @returns The first {@link Member} where predicate is true, and `undefined` otherwise.
+     */
+    async findMember(predicate, scope) {
+        for (const target of await this.installations()) {
+            if (this.matchSearchScope(target, scope)) {
+                for (const member of await target.members()) {
+                    if (await predicate(member)) {
+                        return member;
+                    }
+                }
+            }
+        }
+        return;
+    }
+    /**
+     * Return the first {@link Channel} where predicate is true, and undefined otherwise.
+     * (Ensure the bot app is installed into the `General` channel, otherwise undefined will be returned.)
+     *
+     * @param predicate - Find calls predicate once for each channel of the installation,
+     * until it finds one where predicate returns true. If such a channel is found, find
+     * immediately returns that channel. Otherwise, find returns `undefined`.
+     *
+     * @returns The first {@link Channel} where predicate is true, and `undefined` otherwise.
+     */
+    async findChannel(predicate) {
+        for (const target of await this.installations()) {
+            if (target.type === NotificationTargetType.Channel) {
+                const teamDetails = await target.getTeamDetails();
+                for (const channel of await target.channels()) {
+                    if (await predicate(channel, teamDetails)) {
+                        return channel;
+                    }
+                }
+            }
+        }
+        return;
+    }
+    /**
+     * Return all {@link Member} where predicate is true, and empty array otherwise.
+     *
+     * @param predicate - Find calls predicate for each member of the installation.
+     * @param scope - The scope to find members from the installations
+     * (personal chat, group chat, Teams channel).
+     *
+     * @returns An array of {@link Member} where predicate is true, and empty array otherwise.
+     */
+    async findAllMembers(predicate, scope) {
+        const members = [];
+        for (const target of await this.installations()) {
+            if (this.matchSearchScope(target, scope)) {
+                for (const member of await target.members()) {
+                    if (await predicate(member)) {
+                        members.push(member);
+                    }
+                }
+            }
+        }
+        return members;
+    }
+    /**
+     * Return all {@link Channel} where predicate is true, and empty array otherwise.
+     * (Ensure the bot app is installed into the `General` channel, otherwise empty array will be returned.)
+     *
+     * @param predicate - Find calls predicate for each channel of the installation.
+     *
+     * @returns An array of {@link Channel} where predicate is true, and empty array otherwise.
+     */
+    async findAllChannels(predicate) {
+        const channels = [];
+        for (const target of await this.installations()) {
+            if (target.type === NotificationTargetType.Channel) {
+                const teamDetails = await target.getTeamDetails();
+                for (const channel of await target.channels()) {
+                    if (await predicate(channel, teamDetails)) {
+                        channels.push(channel);
+                    }
+                }
+            }
+        }
+        return channels;
+    }
+    matchSearchScope(target, scope) {
+        scope = scope !== null && scope !== void 0 ? scope : SearchScope.All;
+        return ((target.type === NotificationTargetType.Channel && (scope & SearchScope.Channel) !== 0) ||
+            (target.type === NotificationTargetType.Group && (scope & SearchScope.Group) !== 0) ||
+            (target.type === NotificationTargetType.Person && (scope & SearchScope.Person) !== 0));
+    }
+}
+/**
+ * The search scope when calling {@link NotificationBot.findMember} and {@link NotificationBot.findAllMembers}.
+ * The search scope is a flagged enum and it can be combined with `|`.
+ * For example, to search from personal chat and group chat, use `SearchScope.Person | SearchScope.Group`.
+ */
+var SearchScope;
+(function (SearchScope) {
+    /**
+     * Search members from the installations in personal chat only.
+     */
+    SearchScope[SearchScope["Person"] = 1] = "Person";
+    /**
+     * Search members from the installations in group chat only.
+     */
+    SearchScope[SearchScope["Group"] = 2] = "Group";
+    /**
+     * Search members from the installations in Teams channel only.
+     */
+    SearchScope[SearchScope["Channel"] = 4] = "Channel";
+    /**
+     * Search members from all installations including personal chat, group chat and Teams channel.
+     */
+    SearchScope[SearchScope["All"] = 7] = "All";
+})(SearchScope || (SearchScope = {}));
+
+// Copyright (c) Microsoft Corporation.
+/**
+ * Provide utilities for bot conversation, including:
+ *   - handle command and response.
+ *   - send notification to varies targets (e.g., member, group, channel).
+ *
+ * @example
+ * For command and response, you can register your commands through the constructor, or use the `registerCommand` and `registerCommands` API to add commands later.
+ *
+ * ```typescript
+ * import { BotBuilderCloudAdapter } from "@microsoft/teamsfx";
+ * import ConversationBot = BotBuilderCloudAdapter.ConversationBot;
+ *
+ * // register through constructor
+ * const conversationBot = new ConversationBot({
+ *   command: {
+ *     enabled: true,
+ *     commands: [ new HelloWorldCommandHandler() ],
+ *   },
+ * });
+ *
+ * // register through `register*` API
+ * conversationBot.command.registerCommand(new HelpCommandHandler());
+ * ```
+ *
+ * For notification, you can enable notification at initialization, then send notifications at any time.
+ *
+ * ```typescript
+ * import { BotBuilderCloudAdapter } from "@microsoft/teamsfx";
+ * import ConversationBot = BotBuilderCloudAdapter.ConversationBot;
+ *
+ * // enable through constructor
+ * const conversationBot = new ConversationBot({
+ *   notification: {
+ *     enabled: true,
+ *   },
+ * });
+ *
+ * // get all bot installations and send message
+ * for (const target of await conversationBot.notification.installations()) {
+ *   await target.sendMessage("Hello Notification");
+ * }
+ *
+ * // alternative - send message to all members
+ * for (const target of await conversationBot.notification.installations()) {
+ *   for (const member of await target.members()) {
+ *     await member.sendMessage("Hello Notification");
+ *   }
+ * }
+ * ```
+ *
+ * @remarks
+ * Set `adapter` in {@link ConversationOptions} to use your own bot adapter.
+ *
+ * For command and response, 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.
+ *
+ * For notification, set `notification.storage` in {@link ConversationOptions} to use your own storage implementation.
+ */
+class ConversationBot {
+    /**
+     * Create new instance of the `ConversationBot`.
+     *
+     * @remarks
+     * It's recommended to create your own adapter and storage for production environment instead of the default one.
+     *
+     * @param options - The initialize options.
+     */
+    constructor(options) {
+        var _a, _b, _c, _d;
+        if (options.adapter) {
+            this.adapter = options.adapter;
+        }
+        else {
+            this.adapter = this.createDefaultAdapter(options.adapterConfig);
+        }
+        let ssoCommandActivityHandler;
+        if (options === null || options === void 0 ? void 0 : options.ssoConfig) {
+            if ((_a = options.ssoConfig.dialog) === null || _a === void 0 ? void 0 : _a.CustomBotSsoExecutionActivityHandler) {
+                ssoCommandActivityHandler =
+                    new options.ssoConfig.dialog.CustomBotSsoExecutionActivityHandler(options.ssoConfig);
+            }
+            else {
+                ssoCommandActivityHandler = new DefaultBotSsoExecutionActivityHandler(options.ssoConfig);
+            }
+        }
+        if ((_b = options.command) === null || _b === void 0 ? void 0 : _b.enabled) {
+            this.command = new CommandBot(this.adapter, options.command, ssoCommandActivityHandler, options.ssoConfig);
+        }
+        if ((_c = options.notification) === null || _c === void 0 ? void 0 : _c.enabled) {
+            this.notification = new NotificationBot(this.adapter, options.notification);
+        }
+        if ((_d = options.cardAction) === null || _d === void 0 ? void 0 : _d.enabled) {
+            this.cardAction = new CardActionBot(this.adapter, options.cardAction);
+        }
+    }
+    createDefaultAdapter(adapterConfig) {
+        const credentialsFactory = adapterConfig === undefined
+            ? new ConfigurationServiceClientCredentialFactory({
+                MicrosoftAppId: process.env.BOT_ID,
+                MicrosoftAppPassword: process.env.BOT_PASSWORD,
+                MicrosoftAppType: "MultiTenant",
+            })
+            : new ConfigurationServiceClientCredentialFactory(adapterConfig);
+        const botFrameworkAuthentication = new ConfigurationBotFrameworkAuthentication({}, credentialsFactory);
+        const adapter = new CloudAdapter(botFrameworkAuthentication);
+        // the default error handler
+        adapter.onTurnError = async (context, error) => {
+            // This check writes out errors to console.
+            console.error(`[onTurnError] unhandled error: ${error}`);
+            // Send a trace activity, which will be displayed in Bot Framework Emulator
+            await context.sendTraceActivity("OnTurnError Trace", `${error}`, "https://www.botframework.com/schemas/error", "TurnError");
+            // Send a message to the user
+            await context.sendActivity(`The bot encountered unhandled error: ${error.message}`);
+            await context.sendActivity("To continue to run this bot, please fix the bot source code.");
+        };
+        return adapter;
+    }
+    /**
+     * The request handler to integrate with web request.
+     *
+     * @param req - An incoming HTTP [Request](xref:botbuilder.Request).
+     * @param res - The corresponding HTTP [Response](xref:botbuilder.Response).
+     * @param logic - The additional function to handle bot context.
+     *
+     * @example
+     * For example, to use with Restify:
+     * ``` typescript
+     * // The default/empty behavior
+     * server.use(restify.plugins.bodyParser());
+     * server.post("api/messages", conversationBot.requestHandler);
+     *
+     * // Or, add your own logic
+     * server.use(restify.plugins.bodyParser());
+     * server.post("api/messages", async (req, res) => {
+     *   await conversationBot.requestHandler(req, res, async (context) => {
+     *     // your-own-context-logic
+     *   });
+     * });
+     * ```
+     */
+    async requestHandler(req, res, logic) {
+        if (logic === undefined) {
+            // create empty logic
+            logic = async () => { };
+        }
+        await this.adapter.process(req, res, logic);
+    }
+}
+
+var conversationWithCloudAdapter = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  ConversationBot: ConversationBot,
+  BotSsoExecutionDialog: BotSsoExecutionDialog,
+  Channel: Channel,
+  Member: Member,
+  NotificationBot: NotificationBot,
+  sendAdaptiveCard: sendAdaptiveCard,
+  sendMessage: sendMessage,
+  TeamsBotInstallation: TeamsBotInstallation,
+  get SearchScope () { return SearchScope; },
+  CommandBot: CommandBot,
+  CardActionBot: CardActionBot
+});
+
+export { AdaptiveCardResponse, ApiKeyLocation, ApiKeyProvider, AppCredential, BasicAuthProvider, BearerTokenAuthProvider, conversationWithCloudAdapter as BotBuilderCloudAdapter, BotSsoExecutionDialog, CardActionBot$1 as CardActionBot, CertificateAuthProvider, Channel$1 as Channel, CommandBot$1 as CommandBot, ConversationBot$1 as ConversationBot, ErrorCode, ErrorWithCode, IdentityType, InvokeResponseErrorCode, InvokeResponseFactory, LogLevel, Member$1 as Member, MessageBuilder, MsGraphAuthProvider, NotificationBot$1 as NotificationBot, NotificationTargetType, OnBehalfOfUserCredential, SearchScope$1 as SearchScope, TeamsBotInstallation$1 as TeamsBotInstallation, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createApiClient, createMicrosoftGraphClient, createMicrosoftGraphClientWithCredential, createPemCertOption, createPfxCertOption, getLogLevel, getTediousConnectionConfig, handleMessageExtensionQueryWithSSO, handleMessageExtensionQueryWithToken, sendAdaptiveCard$1 as sendAdaptiveCard, sendMessage$1 as sendMessage, setLogFunction, setLogLevel, setLogger };
 //# sourceMappingURL=index.esm2017.mjs.map