@microsoft/teamsfx 2.1.1-alpha.f8e51b9d8.0 → 2.2.0-alpha.07688183f.0

package/dist/index.node.cjs.js

@@ -2072,9 +2072,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) {
@@ -2096,9 +2096,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) {
@@ -2119,12 +2119,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 {
@@ -2141,10 +2141,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 {
@@ -2236,7 +2236,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`.
      *
@@ -2394,7 +2397,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`.
      *
@@ -2492,7 +2498,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;
     }
@@ -2734,7 +2740,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);
 }
 /**
@@ -2746,7 +2752,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);
 }
 /**
@@ -2755,7 +2761,7 @@ function sendAdaptiveCard(target, card, onError) {
  * @remarks
  * It's recommended to get channels from {@link TeamsBotInstallation.channels()}.
  */
-class Channel {
+class Channel$1 {
     /**
      * Constructor.
      *
@@ -2855,7 +2861,7 @@ class Channel {
  * @remarks
  * It's recommended to get members from {@link TeamsBotInstallation.members()}.
  */
-class Member {
+class Member$1 {
     /**
      * Constructor.
      *
@@ -2966,7 +2972,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
      *
@@ -3058,7 +3067,7 @@ class TeamsBotInstallation {
                 }
             }));
             for (const channel of teamsChannels) {
-                channels.push(new Channel(this, channel));
+                channels.push(new Channel$1(this, channel));
             }
             return channels;
         });
@@ -3077,7 +3086,7 @@ class TeamsBotInstallation {
                     const pagedMembers = yield botbuilder.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);
             }));
@@ -3108,7 +3117,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.
      *
@@ -3156,7 +3168,7 @@ class NotificationBot {
                     }
                 }));
                 if (valid) {
-                    targets.push(new TeamsBotInstallation(this.adapter, reference));
+                    targets.push(new TeamsBotInstallation$1(this.adapter, reference));
                 }
                 else {
                     yield this.conversationReferenceStore.delete(reference);
@@ -3705,7 +3717,10 @@ class DefaultBotSsoExecutionActivityHandler extends botbuilder.TeamsActivityHand
  *
  * 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`.
      *
@@ -3733,13 +3748,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) {
@@ -4140,24 +4155,881 @@ function handleMessageExtensionQueryWithSSO(context, config, initiateLoginEndpoi
     });
 }
 
+/**
+ * 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, exports.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 = exports.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.
+     */
+    sendMessage(text, onError) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            const response = {};
+            yield this.parent.adapter.continueConversationAsync(this.parent.botAppId, this.parent.conversationReference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
+                const conversation = yield this.newConversation(context);
+                yield this.parent.adapter.continueConversationAsync(this.parent.botAppId, conversation, (ctx) => tslib.__awaiter(this, void 0, void 0, function* () {
+                    try {
+                        const res = yield ctx.sendActivity(text);
+                        response.id = res === null || res === void 0 ? void 0 : res.id;
+                    }
+                    catch (error) {
+                        if (onError) {
+                            yield 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.
+     */
+    sendAdaptiveCard(card, onError) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            const response = {};
+            yield this.parent.adapter.continueConversationAsync(this.parent.botAppId, this.parent.conversationReference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
+                const conversation = yield this.newConversation(context);
+                yield this.parent.adapter.continueConversationAsync(this.parent.botAppId, conversation, (ctx) => tslib.__awaiter(this, void 0, void 0, function* () {
+                    try {
+                        const res = yield ctx.sendActivity({
+                            attachments: [botbuilder.CardFactory.adaptiveCard(card)],
+                        });
+                        response.id = res === null || res === void 0 ? void 0 : res.id;
+                    }
+                    catch (error) {
+                        if (onError) {
+                            yield onError(ctx, error);
+                        }
+                        else {
+                            throw error;
+                        }
+                    }
+                }));
+            }));
+            return response;
+        });
+    }
+    /**
+     * @internal
+     */
+    newConversation(context) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            const reference = botbuilder.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 = exports.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.
+     */
+    sendMessage(text, onError) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            const response = {};
+            yield this.parent.adapter.continueConversationAsync(this.parent.botAppId, this.parent.conversationReference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
+                const conversation = yield this.newConversation(context);
+                yield this.parent.adapter.continueConversationAsync(this.parent.botAppId, conversation, (ctx) => tslib.__awaiter(this, void 0, void 0, function* () {
+                    try {
+                        const res = yield ctx.sendActivity(text);
+                        response.id = res === null || res === void 0 ? void 0 : res.id;
+                    }
+                    catch (error) {
+                        if (onError) {
+                            yield 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.
+     */
+    sendAdaptiveCard(card, onError) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            const response = {};
+            yield this.parent.adapter.continueConversationAsync(this.parent.botAppId, this.parent.conversationReference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
+                const conversation = yield this.newConversation(context);
+                yield this.parent.adapter.continueConversationAsync(this.parent.botAppId, conversation, (ctx) => tslib.__awaiter(this, void 0, void 0, function* () {
+                    try {
+                        const res = yield ctx.sendActivity({
+                            attachments: [botbuilder.CardFactory.adaptiveCard(card)],
+                        });
+                        response.id = res === null || res === void 0 ? void 0 : res.id;
+                    }
+                    catch (error) {
+                        if (onError) {
+                            yield onError(ctx, error);
+                        }
+                        else {
+                            throw error;
+                        }
+                    }
+                }));
+            }));
+            return response;
+        });
+    }
+    /**
+     * @internal
+     */
+    newConversation(context) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            const reference = botbuilder.TurnContext.getConversationReference(context.activity);
+            const personalConversation = cloneConversation(reference);
+            const connectorClient = context.turnState.get(this.parent.adapter.ConnectorClientKey);
+            const conversation = yield 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.
+     */
+    sendMessage(text, onError) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            const response = {};
+            yield this.adapter.continueConversationAsync(this.botAppId, this.conversationReference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
+                try {
+                    const res = yield context.sendActivity(text);
+                    response.id = res === null || res === void 0 ? void 0 : res.id;
+                }
+                catch (error) {
+                    if (onError) {
+                        yield 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.
+     */
+    sendAdaptiveCard(card, onError) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            const response = {};
+            yield this.adapter.continueConversationAsync(this.botAppId, this.conversationReference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
+                try {
+                    const res = yield context.sendActivity({
+                        attachments: [botbuilder.CardFactory.adaptiveCard(card)],
+                    });
+                    response.id = res === null || res === void 0 ? void 0 : res.id;
+                }
+                catch (error) {
+                    if (onError) {
+                        yield 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.
+     */
+    channels() {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            const channels = [];
+            if (this.type !== exports.NotificationTargetType.Channel) {
+                return channels;
+            }
+            let teamsChannels = [];
+            yield this.adapter.continueConversationAsync(this.botAppId, this.conversationReference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
+                const teamId = getTeamsBotInstallationId(context);
+                if (teamId !== undefined) {
+                    teamsChannels = yield botbuilder.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.
+     */
+    members() {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            const members = [];
+            yield this.adapter.continueConversationAsync(this.botAppId, this.conversationReference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
+                let continuationToken;
+                do {
+                    const pagedMembers = yield botbuilder.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`.
+     */
+    getTeamDetails() {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            if (this.type !== exports.NotificationTargetType.Channel) {
+                return undefined;
+            }
+            let teamDetails;
+            yield this.adapter.continueConversationAsync(this.botAppId, this.conversationReference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
+                const teamId = getTeamsBotInstallationId(context);
+                if (teamId !== undefined) {
+                    teamDetails = yield botbuilder.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__namespace.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}.
+     */
+    installations() {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            if (this.conversationReferenceStore === undefined || this.adapter === undefined) {
+                throw new Error("NotificationBot has not been initialized.");
+            }
+            const references = yield this.conversationReferenceStore.getAll();
+            const targets = [];
+            for (const reference of references) {
+                // validate connection
+                let valid = true;
+                yield this.adapter.continueConversationAsync(this.botAppId, reference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
+                    try {
+                        // try get member to see if the installation is still valid
+                        yield botbuilder.TeamsInfo.getPagedMembers(context, 1);
+                    }
+                    catch (error) {
+                        if (error.code === "BotNotInConversationRoster") {
+                            valid = false;
+                        }
+                    }
+                }));
+                if (valid) {
+                    targets.push(new TeamsBotInstallation(this.adapter, reference, this.botAppId));
+                }
+                else {
+                    yield 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.
+     */
+    findMember(predicate, scope) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            for (const target of yield this.installations()) {
+                if (this.matchSearchScope(target, scope)) {
+                    for (const member of yield target.members()) {
+                        if (yield 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.
+     */
+    findChannel(predicate) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            for (const target of yield this.installations()) {
+                if (target.type === exports.NotificationTargetType.Channel) {
+                    const teamDetails = yield target.getTeamDetails();
+                    for (const channel of yield target.channels()) {
+                        if (yield 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.
+     */
+    findAllMembers(predicate, scope) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            const members = [];
+            for (const target of yield this.installations()) {
+                if (this.matchSearchScope(target, scope)) {
+                    for (const member of yield target.members()) {
+                        if (yield 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.
+     */
+    findAllChannels(predicate) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            const channels = [];
+            for (const target of yield this.installations()) {
+                if (target.type === exports.NotificationTargetType.Channel) {
+                    const teamDetails = yield target.getTeamDetails();
+                    for (const channel of yield target.channels()) {
+                        if (yield predicate(channel, teamDetails)) {
+                            channels.push(channel);
+                        }
+                    }
+                }
+            }
+            return channels;
+        });
+    }
+    matchSearchScope(target, scope) {
+        scope = scope !== null && scope !== void 0 ? scope : SearchScope.All;
+        return ((target.type === exports.NotificationTargetType.Channel && (scope & SearchScope.Channel) !== 0) ||
+            (target.type === exports.NotificationTargetType.Group && (scope & SearchScope.Group) !== 0) ||
+            (target.type === exports.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 botbuilder.ConfigurationServiceClientCredentialFactory({
+                MicrosoftAppId: process.env.BOT_ID,
+                MicrosoftAppPassword: process.env.BOT_PASSWORD,
+                MicrosoftAppType: "MultiTenant",
+            })
+            : new botbuilder.ConfigurationServiceClientCredentialFactory(adapterConfig);
+        const botFrameworkAuthentication = new botbuilder.ConfigurationBotFrameworkAuthentication({}, credentialsFactory);
+        const adapter = new botbuilder.CloudAdapter(botFrameworkAuthentication);
+        // the default error handler
+        adapter.onTurnError = (context, error) => tslib.__awaiter(this, void 0, void 0, function* () {
+            // 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
+            yield context.sendTraceActivity("OnTurnError Trace", `${error}`, "https://www.botframework.com/schemas/error", "TurnError");
+            // Send a message to the user
+            yield context.sendActivity(`The bot encountered unhandled error: ${error.message}`);
+            yield 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
+     *   });
+     * });
+     * ```
+     */
+    requestHandler(req, res, logic) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            if (logic === undefined) {
+                // create empty logic
+                logic = () => tslib.__awaiter(this, void 0, void 0, function* () { });
+            }
+            yield 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
+});
+
 exports.ApiKeyProvider = ApiKeyProvider;
 exports.AppCredential = AppCredential;
 exports.BasicAuthProvider = BasicAuthProvider;
 exports.BearerTokenAuthProvider = BearerTokenAuthProvider;
+exports.BotBuilderCloudAdapter = conversationWithCloudAdapter;
 exports.BotSsoExecutionDialog = BotSsoExecutionDialog;
-exports.CardActionBot = CardActionBot;
+exports.CardActionBot = CardActionBot$1;
 exports.CertificateAuthProvider = CertificateAuthProvider;
-exports.Channel = Channel;
-exports.CommandBot = CommandBot;
-exports.ConversationBot = ConversationBot;
+exports.Channel = Channel$1;
+exports.CommandBot = CommandBot$1;
+exports.ConversationBot = ConversationBot$1;
 exports.ErrorWithCode = ErrorWithCode;
 exports.InvokeResponseFactory = InvokeResponseFactory;
-exports.Member = Member;
+exports.Member = Member$1;
 exports.MessageBuilder = MessageBuilder;
 exports.MsGraphAuthProvider = MsGraphAuthProvider;
-exports.NotificationBot = NotificationBot;
+exports.NotificationBot = NotificationBot$1;
 exports.OnBehalfOfUserCredential = OnBehalfOfUserCredential;
-exports.TeamsBotInstallation = TeamsBotInstallation;
+exports.TeamsBotInstallation = TeamsBotInstallation$1;
 exports.TeamsBotSsoPrompt = TeamsBotSsoPrompt;
 exports.TeamsFx = TeamsFx;
 exports.TeamsUserCredential = TeamsUserCredential;
@@ -4170,8 +5042,8 @@ exports.getLogLevel = getLogLevel;
 exports.getTediousConnectionConfig = getTediousConnectionConfig;
 exports.handleMessageExtensionQueryWithSSO = handleMessageExtensionQueryWithSSO;
 exports.handleMessageExtensionQueryWithToken = handleMessageExtensionQueryWithToken;
-exports.sendAdaptiveCard = sendAdaptiveCard;
-exports.sendMessage = sendMessage;
+exports.sendAdaptiveCard = sendAdaptiveCard$1;
+exports.sendMessage = sendMessage$1;
 exports.setLogFunction = setLogFunction;
 exports.setLogLevel = setLogLevel;
 exports.setLogger = setLogger;