@microsoft/teamsfx 1.1.2-alpha.062e4a5ea.0 → 1.1.2-alpha.a639d9f2e.0

package/dist/index.esm2017.mjs

@@ -1838,131 +1838,280 @@ var NotificationTargetType;
      * The notification will be sent to a personal chat.
      */
     NotificationTargetType["Person"] = "Person";
-})(NotificationTargetType || (NotificationTargetType = {}));
+})(NotificationTargetType || (NotificationTargetType = {}));
+/**
+ * Options used to control how the response card will be sent to users.
+ */
+var AdaptiveCardResponse;
+(function (AdaptiveCardResponse) {
+    /**
+     * The response card will be replaced the current one for the interactor who trigger the action.
+     */
+    AdaptiveCardResponse[AdaptiveCardResponse["ReplaceForInteractor"] = 0] = "ReplaceForInteractor";
+    /**
+     * The response card will be replaced the current one for all users in the chat.
+     */
+    AdaptiveCardResponse[AdaptiveCardResponse["ReplaceForAll"] = 1] = "ReplaceForAll";
+    /**
+     * The response card will be sent as a new message for all users in the chat.
+     */
+    AdaptiveCardResponse[AdaptiveCardResponse["NewForAll"] = 2] = "NewForAll";
+})(AdaptiveCardResponse || (AdaptiveCardResponse = {}));
+/**
+ * Status code for an `application/vnd.microsoft.error` invoke response.
+ */
+var InvokeResponseErrorCode;
+(function (InvokeResponseErrorCode) {
+    /**
+     * Invalid request.
+     */
+    InvokeResponseErrorCode[InvokeResponseErrorCode["BadRequest"] = 400] = "BadRequest";
+    /**
+     * Internal server error.
+     */
+    InvokeResponseErrorCode[InvokeResponseErrorCode["InternalServerError"] = 500] = "InternalServerError";
+})(InvokeResponseErrorCode || (InvokeResponseErrorCode = {}));
 
-// Copyright (c) Microsoft Corporation.
 /**
+ * Available response type for an adaptive card invoke response.
  * @internal
  */
-function cloneConversation(conversation) {
-    return JSON.parse(JSON.stringify(conversation));
-}
+var InvokeResponseType;
+(function (InvokeResponseType) {
+    InvokeResponseType["AdaptiveCard"] = "application/vnd.microsoft.card.adaptive";
+    InvokeResponseType["Message"] = "application/vnd.microsoft.activity.message";
+    InvokeResponseType["Error"] = "application/vnd.microsoft.error";
+})(InvokeResponseType || (InvokeResponseType = {}));
 /**
- * @internal
+ * Provides methods for formatting various invoke responses a bot can send to respond to an invoke request.
+ *
+ * @remarks
+ * All of these functions return an {@link InvokeResponse} object, which can be
+ * passed as input to generate a new `invokeResponse` activity.
+ *
+ * This example sends an invoke response that contains an adaptive card.
+ *
+ * ```typescript
+ *
+ * const myCard: IAdaptiveCard = {
+ *    type: "AdaptiveCard",
+ *    body: [
+ *     {
+ *       "type": "TextBlock",
+ *       "text": "This is a sample card"
+ *     }],
+ *     $schema: "http://adaptivecards.io/schemas/adaptive-card.json",
+ *     version: "1.4"
+ *  };
+ *
+ * const invokeResponse = InvokeResponseFactory.adaptiveCard(myCard);
+ * await context.sendActivity({
+ *    type: ActivityTypes.InvokeResponse,
+ *    value: invokeResponse,
+ *  });
+ * ```
  */
-function getTargetType(conversationReference) {
-    var _a;
-    const conversationType = (_a = conversationReference.conversation) === null || _a === void 0 ? void 0 : _a.conversationType;
-    if (conversationType === "personal") {
-        return NotificationTargetType.Person;
+class InvokeResponseFactory {
+    /**
+     * Create an invoke response from a text message.
+     * 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.
+     *
+     * @returns {InvokeResponse} An InvokeResponse object.
+     */
+    static textMessage(message) {
+        if (!message) {
+            throw new Error("The text message cannot be null or empty");
+        }
+        return {
+            status: StatusCodes.OK,
+            body: {
+                statusCode: StatusCodes.OK,
+                type: InvokeResponseType.Message,
+                value: message,
+            },
+        };
     }
-    else if (conversationType === "groupChat") {
-        return NotificationTargetType.Group;
+    /**
+     * Create an invoke response from an adaptive card.
+     *
+     * The type of the invoke response is `application/vnd.microsoft.card.adaptive` indicates
+     * 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.
+     *
+     * @returns {InvokeResponse} An InvokeResponse object.
+     */
+    static adaptiveCard(card) {
+        if (!card) {
+            throw new Error("The adaptive card content cannot be null or undefined");
+        }
+        return {
+            status: StatusCodes.OK,
+            body: {
+                statusCode: StatusCodes.OK,
+                type: InvokeResponseType.AdaptiveCard,
+                value: card,
+            },
+        };
     }
-    else if (conversationType === "channel") {
-        return NotificationTargetType.Channel;
+    /**
+     * Create an invoke response with error code and message.
+     *
+     * 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:
+     *  - 400 (BadRequest): indicate the incoming request was invalid.
+     *  - 500 (InternalServerError): indicate an unexpected error occurred.
+     * @param errorMessage The error message.
+     *
+     * @returns {InvokeResponse} An InvokeResponse object.
+     */
+    static errorResponse(errorCode, errorMessage) {
+        return {
+            status: StatusCodes.OK,
+            body: {
+                statusCode: errorCode,
+                type: InvokeResponseType.Error,
+                value: {
+                    code: errorCode.toString(),
+                    message: errorMessage,
+                },
+            },
+        };
     }
-    else {
-        return undefined;
+    /**
+     * Create an invoke response with status code and response value.
+     * @param statusCode The status code.
+     * @param body The value of the response body.
+     *
+     * @returns {InvokeResponse} An InvokeResponse object.
+     */
+    static createInvokeResponse(statusCode, body) {
+        return {
+            status: statusCode,
+            body: body,
+        };
     }
-}
-/**
- * @internal
- */
-function getTeamsBotInstallationId(context) {
-    var _a, _b, _c, _d;
-    return (_d = (_c = (_b = (_a = context.activity) === null || _a === void 0 ? void 0 : _a.channelData) === null || _b === void 0 ? void 0 : _b.team) === null || _c === void 0 ? void 0 : _c.id) !== null && _d !== void 0 ? _d : context.activity.conversation.id;
 }
 
-// Copyright (c) Microsoft Corporation.
 /**
  * @internal
  */
-var ActivityType;
-(function (ActivityType) {
-    ActivityType[ActivityType["CurrentBotInstalled"] = 0] = "CurrentBotInstalled";
-    ActivityType[ActivityType["CurrentBotMessaged"] = 1] = "CurrentBotMessaged";
-    ActivityType[ActivityType["CurrentBotUninstalled"] = 2] = "CurrentBotUninstalled";
-    ActivityType[ActivityType["TeamDeleted"] = 3] = "TeamDeleted";
-    ActivityType[ActivityType["TeamRestored"] = 4] = "TeamRestored";
-    ActivityType[ActivityType["Unknown"] = 5] = "Unknown";
-})(ActivityType || (ActivityType = {}));
-/**
- * @internal
- */
-class NotificationMiddleware {
-    constructor(options) {
-        this.conversationReferenceStore = options.conversationReferenceStore;
+class CardActionMiddleware {
+    constructor(handlers) {
+        this.actionHandlers = [];
+        this.defaultMessage = "Your response was sent to the app";
+        if (handlers && handlers.length > 0) {
+            this.actionHandlers.push(...handlers);
+        }
     }
     async onTurn(context, next) {
-        const type = this.classifyActivity(context.activity);
-        switch (type) {
-            case ActivityType.CurrentBotInstalled:
-            case ActivityType.TeamRestored: {
-                const reference = TurnContext.getConversationReference(context.activity);
-                await this.conversationReferenceStore.set(reference);
-                break;
-            }
-            case ActivityType.CurrentBotMessaged: {
-                await this.tryAddMessagedReference(context);
-                break;
-            }
-            case ActivityType.CurrentBotUninstalled:
-            case ActivityType.TeamDeleted: {
-                const reference = TurnContext.getConversationReference(context.activity);
-                await this.conversationReferenceStore.delete(reference);
-                break;
+        var _a, _b, _c;
+        if (context.activity.name === "adaptiveCard/action") {
+            const action = context.activity.value.action;
+            const actionVerb = action.verb;
+            for (const handler of this.actionHandlers) {
+                if (((_a = handler.triggerVerb) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === (actionVerb === null || actionVerb === void 0 ? void 0 : actionVerb.toLowerCase())) {
+                    let response;
+                    try {
+                        response = await handler.handleActionInvoked(context, action.data);
+                    }
+                    catch (error) {
+                        const errorResponse = InvokeResponseFactory.errorResponse(InvokeResponseErrorCode.InternalServerError, error.message);
+                        await this.sendInvokeResponse(context, errorResponse);
+                        throw error;
+                    }
+                    const responseType = (_b = response.body) === null || _b === void 0 ? void 0 : _b.type;
+                    switch (responseType) {
+                        case InvokeResponseType.AdaptiveCard:
+                            const card = (_c = response.body) === null || _c === void 0 ? void 0 : _c.value;
+                            if (!card) {
+                                const errorMessage = "Adaptive card content cannot be found in the response body";
+                                await this.sendInvokeResponse(context, InvokeResponseFactory.errorResponse(InvokeResponseErrorCode.InternalServerError, errorMessage));
+                                throw new Error(errorMessage);
+                            }
+                            if (card.refresh && handler.adaptiveCardResponse !== AdaptiveCardResponse.NewForAll) {
+                                // Card won't be refreshed with AdaptiveCardResponse.ReplaceForInteractor.
+                                // So set to AdaptiveCardResponse.ReplaceForAll here.
+                                handler.adaptiveCardResponse = AdaptiveCardResponse.ReplaceForAll;
+                            }
+                            const activity = MessageFactory.attachment(CardFactory.adaptiveCard(card));
+                            if (handler.adaptiveCardResponse === AdaptiveCardResponse.NewForAll) {
+                                await this.sendInvokeResponse(context, InvokeResponseFactory.textMessage(this.defaultMessage));
+                                await context.sendActivity(activity);
+                            }
+                            else if (handler.adaptiveCardResponse === AdaptiveCardResponse.ReplaceForAll) {
+                                activity.id = context.activity.replyToId;
+                                await context.updateActivity(activity);
+                                await this.sendInvokeResponse(context, response);
+                            }
+                            else {
+                                await this.sendInvokeResponse(context, response);
+                            }
+                            break;
+                        case InvokeResponseType.Message:
+                        case InvokeResponseType.Error:
+                        default:
+                            await this.sendInvokeResponse(context, response);
+                            break;
+                    }
+                    break;
+                }
             }
         }
         await next();
     }
-    classifyActivity(activity) {
-        var _a, _b;
-        const activityType = activity.type;
-        if (activityType === "installationUpdate") {
-            const action = (_a = activity.action) === null || _a === void 0 ? void 0 : _a.toLowerCase();
-            if (action === "add") {
-                return ActivityType.CurrentBotInstalled;
-            }
-            else {
-                return ActivityType.CurrentBotUninstalled;
-            }
-        }
-        else if (activityType === "conversationUpdate") {
-            const eventType = (_b = activity.channelData) === null || _b === void 0 ? void 0 : _b.eventType;
-            if (eventType === "teamDeleted") {
-                return ActivityType.TeamDeleted;
-            }
-            else if (eventType === "teamRestored") {
-                return ActivityType.TeamRestored;
-            }
-        }
-        else if (activityType === "message") {
-            return ActivityType.CurrentBotMessaged;
-        }
-        return ActivityType.Unknown;
+    async sendInvokeResponse(context, response) {
+        await context.sendActivity({
+            type: ActivityTypes.InvokeResponse,
+            value: response,
+        });
     }
-    async tryAddMessagedReference(context) {
-        var _a, _b, _c, _d;
-        const reference = TurnContext.getConversationReference(context.activity);
-        const conversationType = (_a = reference === null || reference === void 0 ? void 0 : reference.conversation) === null || _a === void 0 ? void 0 : _a.conversationType;
-        if (conversationType === "personal" || conversationType === "groupChat") {
-            if (!(await this.conversationReferenceStore.check(reference))) {
-                await this.conversationReferenceStore.set(reference);
-            }
+}
+
+/**
+ * A card action bot to respond to adaptive card universal actions.
+ */
+class CardActionBot {
+    /**
+     * Creates a new instance of the `CardActionBot`.
+     *
+     * @param adapter The bound `BotFrameworkAdapter`.
+     * @param options - initialize options
+     */
+    constructor(adapter, options) {
+        this.middleware = new CardActionMiddleware(options === null || options === void 0 ? void 0 : options.actions);
+        this.adapter = adapter.use(this.middleware);
+    }
+    /**
+     * Registers 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);
         }
-        else if (conversationType === "channel") {
-            const teamId = (_d = (_c = (_b = context.activity) === null || _b === void 0 ? void 0 : _b.channelData) === null || _c === void 0 ? void 0 : _c.team) === null || _d === void 0 ? void 0 : _d.id;
-            if (teamId !== undefined) {
-                const teamReference = cloneConversation(reference);
-                teamReference.conversation.id = teamId;
-                if (!(await this.conversationReferenceStore.check(teamReference))) {
-                    await this.conversationReferenceStore.set(teamReference);
-                }
-            }
+    }
+    /**
+     * Registers 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.
+/**
+ * @internal
+ */
 class CommandResponseMiddleware {
     constructor(handlers) {
         this.commandHandlers = [];
@@ -1993,6 +2142,7 @@ class CommandResponseMiddleware {
                             await context.sendActivity(replyActivity);
                         }
                     }
+                    break;
                 }
             }
         }
@@ -2073,6 +2223,130 @@ class CommandBot {
     }
 }
 
+// Copyright (c) Microsoft Corporation.
+/**
+ * @internal
+ */
+function cloneConversation(conversation) {
+    return JSON.parse(JSON.stringify(conversation));
+}
+/**
+ * @internal
+ */
+function getTargetType(conversationReference) {
+    var _a;
+    const conversationType = (_a = conversationReference.conversation) === null || _a === void 0 ? void 0 : _a.conversationType;
+    if (conversationType === "personal") {
+        return NotificationTargetType.Person;
+    }
+    else if (conversationType === "groupChat") {
+        return NotificationTargetType.Group;
+    }
+    else if (conversationType === "channel") {
+        return NotificationTargetType.Channel;
+    }
+    else {
+        return undefined;
+    }
+}
+/**
+ * @internal
+ */
+function getTeamsBotInstallationId(context) {
+    var _a, _b, _c, _d;
+    return (_d = (_c = (_b = (_a = context.activity) === null || _a === void 0 ? void 0 : _a.channelData) === null || _b === void 0 ? void 0 : _b.team) === null || _c === void 0 ? void 0 : _c.id) !== null && _d !== void 0 ? _d : context.activity.conversation.id;
+}
+
+// Copyright (c) Microsoft Corporation.
+/**
+ * @internal
+ */
+var ActivityType;
+(function (ActivityType) {
+    ActivityType[ActivityType["CurrentBotInstalled"] = 0] = "CurrentBotInstalled";
+    ActivityType[ActivityType["CurrentBotMessaged"] = 1] = "CurrentBotMessaged";
+    ActivityType[ActivityType["CurrentBotUninstalled"] = 2] = "CurrentBotUninstalled";
+    ActivityType[ActivityType["TeamDeleted"] = 3] = "TeamDeleted";
+    ActivityType[ActivityType["TeamRestored"] = 4] = "TeamRestored";
+    ActivityType[ActivityType["Unknown"] = 5] = "Unknown";
+})(ActivityType || (ActivityType = {}));
+/**
+ * @internal
+ */
+class NotificationMiddleware {
+    constructor(options) {
+        this.conversationReferenceStore = options.conversationReferenceStore;
+    }
+    async onTurn(context, next) {
+        const type = this.classifyActivity(context.activity);
+        switch (type) {
+            case ActivityType.CurrentBotInstalled:
+            case ActivityType.TeamRestored: {
+                const reference = TurnContext.getConversationReference(context.activity);
+                await this.conversationReferenceStore.set(reference);
+                break;
+            }
+            case ActivityType.CurrentBotMessaged: {
+                await this.tryAddMessagedReference(context);
+                break;
+            }
+            case ActivityType.CurrentBotUninstalled:
+            case ActivityType.TeamDeleted: {
+                const reference = TurnContext.getConversationReference(context.activity);
+                await this.conversationReferenceStore.delete(reference);
+                break;
+            }
+        }
+        await next();
+    }
+    classifyActivity(activity) {
+        var _a, _b;
+        const activityType = activity.type;
+        if (activityType === "installationUpdate") {
+            const action = (_a = activity.action) === null || _a === void 0 ? void 0 : _a.toLowerCase();
+            if (action === "add") {
+                return ActivityType.CurrentBotInstalled;
+            }
+            else {
+                return ActivityType.CurrentBotUninstalled;
+            }
+        }
+        else if (activityType === "conversationUpdate") {
+            const eventType = (_b = activity.channelData) === null || _b === void 0 ? void 0 : _b.eventType;
+            if (eventType === "teamDeleted") {
+                return ActivityType.TeamDeleted;
+            }
+            else if (eventType === "teamRestored") {
+                return ActivityType.TeamRestored;
+            }
+        }
+        else if (activityType === "message") {
+            return ActivityType.CurrentBotMessaged;
+        }
+        return ActivityType.Unknown;
+    }
+    async tryAddMessagedReference(context) {
+        var _a, _b, _c, _d;
+        const reference = TurnContext.getConversationReference(context.activity);
+        const conversationType = (_a = reference === null || reference === void 0 ? void 0 : reference.conversation) === null || _a === void 0 ? void 0 : _a.conversationType;
+        if (conversationType === "personal" || conversationType === "groupChat") {
+            if (!(await this.conversationReferenceStore.check(reference))) {
+                await this.conversationReferenceStore.set(reference);
+            }
+        }
+        else if (conversationType === "channel") {
+            const teamId = (_d = (_c = (_b = context.activity) === null || _b === void 0 ? void 0 : _b.channelData) === null || _c === void 0 ? void 0 : _c.team) === null || _d === void 0 ? void 0 : _d.id;
+            if (teamId !== undefined) {
+                const teamReference = cloneConversation(reference);
+                teamReference.conversation.id = teamId;
+                if (!(await this.conversationReferenceStore.check(teamReference))) {
+                    await this.conversationReferenceStore.set(teamReference);
+                }
+            }
+        }
+    }
+}
+
 // Copyright (c) Microsoft Corporation.
 /**
  * @internal
@@ -2576,7 +2850,7 @@ class ConversationBot {
      * @param options - initialize options
      */
     constructor(options) {
-        var _a, _b;
+        var _a, _b, _c;
         if (options.adapter) {
             this.adapter = options.adapter;
         }
@@ -2589,6 +2863,9 @@ class ConversationBot {
         if ((_b = options.notification) === null || _b === void 0 ? void 0 : _b.enabled) {
             this.notification = new NotificationBot(this.adapter, options.notification);
         }
+        if ((_c = options.cardAction) === null || _c === void 0 ? void 0 : _c.enabled) {
+            this.cardAction = new CardActionBot(this.adapter, options.cardAction);
+        }
     }
     createDefaultAdapter(adapterConfig) {
         const adapter = adapterConfig === undefined
@@ -2775,5 +3052,5 @@ class MessageBuilder {
     }
 }
 
-export { ApiKeyLocation, ApiKeyProvider, AppCredential, BasicAuthProvider, BearerTokenAuthProvider, CertificateAuthProvider, Channel, CommandBot, ConversationBot, ErrorCode, ErrorWithCode, IdentityType, LogLevel, Member, MessageBuilder, MsGraphAuthProvider, NotificationBot, NotificationTargetType, OnBehalfOfUserCredential, TeamsBotInstallation, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createApiClient, createMicrosoftGraphClient, createPemCertOption, createPfxCertOption, getLogLevel, getTediousConnectionConfig, sendAdaptiveCard, sendMessage, setLogFunction, setLogLevel, setLogger };
+export { AdaptiveCardResponse, ApiKeyLocation, ApiKeyProvider, AppCredential, BasicAuthProvider, BearerTokenAuthProvider, CardActionBot, CertificateAuthProvider, Channel, CommandBot, ConversationBot, ErrorCode, ErrorWithCode, IdentityType, InvokeResponseErrorCode, InvokeResponseFactory, LogLevel, Member, MessageBuilder, MsGraphAuthProvider, NotificationBot, NotificationTargetType, OnBehalfOfUserCredential, TeamsBotInstallation, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createApiClient, createMicrosoftGraphClient, createPemCertOption, createPfxCertOption, getLogLevel, getTediousConnectionConfig, sendAdaptiveCard, sendMessage, setLogFunction, setLogLevel, setLogger };
 //# sourceMappingURL=index.esm2017.mjs.map