@microsoft/teamsfx 1.1.2-alpha.c46d33f34.0 → 1.1.2-alpha.d61ffd7b2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/teamsfx",
-  "version": "1.1.2-alpha.c46d33f34.0",
+  "version": "1.1.2-alpha.d61ffd7b2.0",
   "description": "Microsoft Teams Framework for Node.js and browser.",
   "main": "dist/index.node.cjs.js",
   "browser": "dist/index.esm2017.js",
@@ -49,8 +49,9 @@
     "@azure/identity": "^2.0.1",
     "@azure/msal-browser": "^2.21.0",
     "@azure/msal-node": "~1.1.0",
-    "@microsoft/adaptivecards-tools": "1.0.2-alpha.c46d33f34.0",
+    "@microsoft/adaptivecards-tools": "1.0.2-alpha.d61ffd7b2.0",
     "@microsoft/microsoft-graph-client": "^3.0.1",
+    "adaptivecards": "^2.10.0",
     "axios": "^0.27.2",
     "botbuilder": ">=4.15.0 <5.0.0",
     "botbuilder-dialogs": ">=4.15.0 <5.0.0",
@@ -128,7 +129,7 @@
     "webpack": "^5.62.1",
     "yargs": "^17.2.1"
   },
-  "gitHead": "4ebb137bff5949f589ef21880adc373522526eeb",
+  "gitHead": "ebe3f7cb6ab5c7ee8b2f925816fa5b3f432f10c8",
   "publishConfig": {
     "access": "public"
   },

package/types/teamsfx.d.ts

@@ -19,9 +19,13 @@ import { DialogContext } from 'botbuilder-dialogs';
 import { DialogTurnResult } from 'botbuilder-dialogs';
 import { GetTokenOptions } from '@azure/identity';
 import { HeroCard } from 'botbuilder';
+import { IAdaptiveCard } from 'adaptivecards';
+import { InvokeResponse } from 'botbuilder-core';
+import { InvokeResponse as InvokeResponse_2 } from 'botbuilder';
 import { O365ConnectorCard } from 'botbuilder';
 import { ReceiptCard } from 'botbuilder';
 import { SecureContextOptions } from 'tls';
+import { StatusCodes } from 'botbuilder';
 import { TeamsChannelAccount } from 'botbuilder';
 import { ThumbnailCard } from 'botbuilder';
 import { TokenCredential } from '@azure/identity';
@@ -31,6 +35,24 @@ import { TurnContext as TurnContext_2 } from 'botbuilder';
 import { WebRequest } from 'botbuilder';
 import { WebResponse } from 'botbuilder';
 
+/**
+ * Options used to control how the response card will be sent to users.
+ */
+export declare enum AdaptiveCardResponse {
+    /**
+     * The response card will be replaced the current one for the interactor who trigger the action.
+     */
+    ReplaceForInteractor = 0,
+    /**
+     * The response card will be replaced the current one for all users in the chat.
+     */
+    ReplaceForAll = 1,
+    /**
+     * The response card will be sent as a new message for all users in the chat.
+     */
+    NewForAll = 2
+}
+
 /**
  * Define available location for API Key location
  */
@@ -249,6 +271,41 @@ export declare class BearerTokenAuthProvider implements AuthProvider {
     AddAuthenticationInfo(config: AxiosRequestConfig): Promise<AxiosRequestConfig>;
 }
 
+/**
+ * A card action bot to respond to adaptive card universal actions.
+ */
+export declare class CardActionBot {
+    private readonly adapter;
+    private middleware;
+    /**
+     * Creates a new instance of the `CardActionBot`.
+     *
+     * @param adapter The bound `BotFrameworkAdapter`.
+     * @param options - initialize options
+     */
+    constructor(adapter: BotFrameworkAdapter, options?: CardActionOptions);
+    /**
+     * Registers a card action handler to the bot.
+     * @param actionHandler A card action handler to be registered.
+     */
+    registerHandler(actionHandler: TeamsFxAdaptiveCardActionHandler): void;
+    /**
+     * Registers card action handlers to the bot.
+     * @param actionHandlers A set of card action handlers to be registered.
+     */
+    registerHandlers(actionHandlers: TeamsFxAdaptiveCardActionHandler[]): void;
+}
+
+/**
+ * Options to initialize {@link CardActionBot}.
+ */
+export declare interface CardActionOptions {
+    /**
+     * The action handlers to registered with the action bot. Each command should implement the interface {@link TeamsFxAdaptiveCardActionHandler} so that it can be correctly handled by this bot.
+     */
+    actions?: TeamsFxAdaptiveCardActionHandler[];
+}
+
 /**
  * Provider that handles Certificate authentication
  */
@@ -441,6 +498,10 @@ export declare class ConversationBot {
      * The entrypoint of notification.
      */
     readonly notification?: NotificationBot;
+    /**
+     * The action handler used for adaptive card universal actions.
+     */
+    readonly cardAction?: CardActionBot;
     /**
      * Creates new instance of the `ConversationBot`.
      *
@@ -515,6 +576,15 @@ export declare interface ConversationOptions {
          */
         enabled?: boolean;
     };
+    /**
+     * The adaptive card action handler part.
+     */
+    cardAction?: CardActionOptions & {
+        /**
+         * Whether to enable adaptive card actions or not.
+         */
+        enabled?: boolean;
+    };
 }
 
 /**
@@ -702,6 +772,10 @@ export declare class ErrorWithCode extends Error {
  */
 export declare function getLogLevel(): LogLevel | undefined;
 
+export declare interface GetTeamsUserTokenOptions extends GetTokenOptions {
+    resources?: string[];
+}
+
 /**
  * Generate connection configuration consumed by tedious.
  *
@@ -730,6 +804,96 @@ export declare enum IdentityType {
     App = "Application"
 }
 
+/**
+ * Status code for an `application/vnd.microsoft.error` invoke response.
+ */
+export declare enum InvokeResponseErrorCode {
+    /**
+     * Invalid request.
+     */
+    BadRequest = 400,
+    /**
+     * Internal server error.
+     */
+    InternalServerError = 500
+}
+
+/**
+ * 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,
+ *  });
+ * ```
+ */
+export declare 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: string): InvokeResponse_2;
+    /**
+     * 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: IAdaptiveCard): InvokeResponse_2;
+    /**
+     * 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: InvokeResponseErrorCode, errorMessage: string): InvokeResponse_2;
+    /**
+     * 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: StatusCodes, body?: unknown): InvokeResponse_2;
+}
+
 /**
  * Log function for customized logging.
  */
@@ -1511,7 +1675,7 @@ export declare class TeamsFx implements TeamsFxConfiguration {
      *
      * @throws {@link ErrorCode|IdentityTypeNotSupported} when setting app identity in browser.
      */
-    constructor(identityType?: IdentityType, customConfig?: Record<string, string>);
+    constructor(identityType?: IdentityType, customConfig?: Record<string, string> | AuthenticationConfiguration);
     /**
      * Identity type set by user.
      *
@@ -1530,9 +1694,10 @@ export declare class TeamsFx implements TeamsFxConfiguration {
     getCredential(): TokenCredential;
     /**
      * Get user information.
+     * @param {string[]} resources - The optional list of resources for full trust Teams apps.
      * @returns UserInfo object.
      */
-    getUserInfo(): Promise<UserInfo>;
+    getUserInfo(resources?: string[]): Promise<UserInfo>;
     /**
      * Popup login page to get user's access token with specific scopes.
      *
@@ -1547,13 +1712,14 @@ export declare class TeamsFx implements TeamsFxConfiguration {
      * await teamsfx.login("https://graph.microsoft.com/User.Read Calendars.Read"); // multiple scopes using string
      * ```
      * @param scopes - The list of scopes for which the token will have access, before that, we will request user to consent.
+     * @param {string[]} resources - The optional list of resources for full trust Teams apps.
      *
      * @throws {@link ErrorCode|InternalError} when failed to login with unknown error.
      * @throws {@link ErrorCode|ConsentFailed} when user canceled or failed to consent.
      * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is nodeJS.
      */
-    login(scopes: string | string[]): Promise<void>;
+    login(scopes: string | string[], resources?: string[]): Promise<void>;
     /**
      * Set SSO token when using user identity in NodeJS.
      * @param {string} ssoToken - used for on behalf of user flow.
@@ -1583,6 +1749,47 @@ export declare class TeamsFx implements TeamsFxConfiguration {
     private loadFromEnv;
 }
 
+/**
+ * Interface for adaptive card action handler that can process card action invoke and return a response.
+ */
+export declare interface TeamsFxAdaptiveCardActionHandler {
+    /**
+     * The verb defined in adaptive card action that can trigger this handler.
+     * The verb string here is case-insensitive.
+     */
+    triggerVerb: string;
+    /**
+     * Specify the behavior for how the card response will be sent in Teams conversation.
+     * The default value is `AdaptiveCardResponse.ReplaceForInteractor`, which means the card
+     * response will replace the current one only for the interactor.
+     */
+    adaptiveCardResponse?: AdaptiveCardResponse;
+    /**
+     * The handler function that will be invoked when the action is fired.
+     * @param context The turn context.
+     * @param actionData The contextual data that associated with the action.
+     *
+     * @returns A `Promise` representing a invoke response for the adaptive card invoke action.
+     * You can use the `InvokeResponseFactory` utility class to create an invoke response from
+     *  - A text message:
+     *   ```typescript
+     *   return InvokeResponseFactory.textMessage("Action is processed successfully!");
+     *   ```
+     *  - An adaptive card:
+     *    ```typescript
+     *    const responseCard = AdaptiveCards.declare(helloWorldCard).render(actionData);
+     return InvokeResponseFactory.adaptiveCard(responseCard);
+     *    ```
+     *  - An error response:
+     *     ```typescript
+     *     return InvokeResponseFactory.errorResponse(InvokeResponseErrorCode.BadRequest, "Invalid request");
+     *     ```
+     *
+     * @remark For more details about the invoke response format, refer to https://docs.microsoft.com/en-us/adaptive-cards/authoring-cards/universal-action-model#response-format.
+     */
+    handleActionInvoked(context: TurnContext, actionData: any): Promise<InvokeResponse>;
+}
+
 /**
  * Interface for a command handler that can process command to a TeamsFx bot and return a response.
  */
@@ -1624,9 +1831,10 @@ declare interface TeamsFxConfiguration {
     getCredential(): TokenCredential;
     /**
      * Get user information.
+     * @param {string[]} resources - The optional list of resources for full trust Teams apps.
      * @returns UserInfo object.
      */
-    getUserInfo(): Promise<UserInfo>;
+    getUserInfo(resources?: string[]): Promise<UserInfo>;
     /**
      * Popup login page to get user's access token with specific scopes.
      *
@@ -1641,13 +1849,14 @@ declare interface TeamsFxConfiguration {
      * await teamsfx.login("https://graph.microsoft.com/User.Read Calendars.Read"); // multiple scopes using string
      * ```
      * @param scopes - The list of scopes for which the token will have access, before that, we will request user to consent.
+     * @param {string[]} resources - The optional list of resources for full trust Teams apps.
      *
      * @throws {@link ErrorCode|InternalError} when failed to login with unknown error.
      * @throws {@link ErrorCode|ConsentFailed} when user canceled or failed to consent.
      * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is nodeJS.
      */
-    login(scopes: string | string[]): Promise<void>;
+    login(scopes: string | string[], resources?: string[]): Promise<void>;
     /**
      * Set SSO token when using user identity in NodeJS.
      * @param {string} ssoToken - used for on behalf of user flow.
@@ -1688,10 +1897,13 @@ export declare class TeamsUserCredential implements TokenCredential {
     constructor(authConfig: AuthenticationConfiguration);
     /**
      * Popup login page to get user's access token with specific scopes.
+     *
+     * @param {string[]} resources - The optional list of resources for full trust Teams apps.
+     *
      * @remarks
      * Can only be used within Teams.
      */
-    login(scopes: string | string[]): Promise<void>;
+    login(scopes: string | string[], resources?: string[]): Promise<void>;
     /**
      * Get access token from credential.
      * @remarks
@@ -1700,10 +1912,13 @@ export declare class TeamsUserCredential implements TokenCredential {
     getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken | null>;
     /**
      * Get basic user info from SSO token
+     *
+     * @param {string[]} resources - The optional list of resources for full trust Teams apps.
+     *
      * @remarks
      * Can only be used within Teams.
      */
-    getUserInfo(): Promise<UserInfo>;
+    getUserInfo(resources?: string[]): Promise<UserInfo>;
 }
 
 /**