@microsoft/teamsfx 1.1.2-alpha.9bd0cb559.0 → 1.1.2-alpha.9d488528e.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/teamsfx",
-  "version": "1.1.2-alpha.9bd0cb559.0",
+  "version": "1.1.2-alpha.9d488528e.0",
   "description": "Microsoft Teams Framework for Node.js and browser.",
   "main": "dist/index.node.cjs.js",
   "browser": "dist/index.esm2017.js",
@@ -21,7 +21,7 @@
     "test:unit:node": "nyc --no-clean -- mocha 'test/unit/{,!(browser)/**/}*.spec.ts' --file src/index.ts -r config/mocha.env.ts --config config/mocharc.node.js",
     "test:unit": "npm run test:unit:node && npm run test:unit:browser ",
     "test:e2e:browser": "karma start --single-run --integration",
-    "test:e2e:node": "mocha 'test/e2e/node/*.spec.ts' --file src/index.ts -r config/mocha.env.ts --config config/mocharc.node.js --reporter xunit --reporter-option output=test-results.node.xml ",
+    "test:e2e:node": "mocha --reporter mocha-multi-reporters 'test/e2e/node/*.spec.ts' --file src/index.ts -r config/mocha.env.ts --config config/mocharc.node.js --reporter-options configFile=config/mocha-multi-reporter.json",
     "test:e2e": "npm run test:e2e:node && npm run test:e2e:browser",
     "ui-test": "mocha --no-timeouts -r test/mocha.env.ts -r ts-node/register test/ui/**/*.spec.ts --exit",
     "check-sensitive": "npx eslint --plugin 'no-secrets' --cache --ignore-pattern 'package.json' --ignore-pattern 'package-lock.json'",
@@ -49,7 +49,7 @@
     "@azure/identity": "^2.0.1",
     "@azure/msal-browser": "^2.21.0",
     "@azure/msal-node": "~1.1.0",
-    "@microsoft/adaptivecards-tools": "1.0.2-alpha.9bd0cb559.0",
+    "@microsoft/adaptivecards-tools": "1.0.2-alpha.9d488528e.0",
     "@microsoft/microsoft-graph-client": "^3.0.1",
     "adaptivecards": "^2.10.0",
     "axios": "^0.27.2",
@@ -78,6 +78,7 @@
     "@types/chai-as-promised": "^7.1.4",
     "@types/fs-extra": "^9.0.11",
     "@types/mocha": "^9.0.0",
+    "@types/mochawesome": "^6.2.1",
     "@types/node": "^16.11.7",
     "@types/sinon": "^10.0.6",
     "@types/tedious": "^4.0.5",
@@ -112,7 +113,8 @@
     "karma-webpack": "^5.0.0",
     "lint-staged": "^11.2.6",
     "mocha": "^9.2.0",
-    "mocha-junit-reporter": "^2.0.2",
+    "mocha-multi-reporters": "^1.5.1",
+    "mochawesome": "^7.0.1",
     "mocked-env": "^1.3.5",
     "nyc": "^15.1.0",
     "prettier": "^2.4.1",
@@ -129,7 +131,7 @@
     "webpack": "^5.62.1",
     "yargs": "^17.2.1"
   },
-  "gitHead": "3af4b6e0aa2b7bcfbf2dbbf1fccbe4a03ea8a71b",
+  "gitHead": "ffbbe229e83536079e5224c40f62d35d2963ec75",
   "publishConfig": {
     "access": "public"
   },

package/types/teamsfx.d.ts

@@ -22,6 +22,7 @@ import { GetTokenOptions } from '@azure/identity';
 import { HeroCard } from 'botbuilder';
 import { IAdaptiveCard } from 'adaptivecards';
 import { InvokeResponse } from 'botbuilder';
+import { MessagingExtensionResponse } from 'botbuilder';
 import { O365ConnectorCard } from 'botbuilder';
 import { ReceiptCard } from 'botbuilder';
 import { SecureContextOptions } from 'tls';
@@ -29,7 +30,7 @@ import { SigninStateVerificationQuery } from 'botbuilder';
 import { StatePropertyAccessor } from 'botbuilder';
 import { StatusCodes } from 'botbuilder';
 import { Storage as Storage_2 } from 'botbuilder';
-import { TeamsActivityHandler } from 'botbuilder';
+import { TeamDetails } from 'botbuilder';
 import { TeamsChannelAccount } from 'botbuilder';
 import { ThumbnailCard } from 'botbuilder';
 import { TokenCredential } from '@azure/identity';
@@ -344,7 +345,7 @@ export declare interface BotSsoConfig {
  *    ...
  * });
  * ```
- * For details information about how to implement a BotSsoExecutionActivityHandler, please refer {@link DefaultBotSsoExecutionActivityHandler} class source code.
+ * For details information about how to implement a BotSsoExecutionActivityHandler, please refer DefaultBotSsoExecutionActivityHandler class source code: https://aka.ms/teamsfx-default-sso-execution-activity-handler
  */
 export declare interface BotSsoExecutionActivityHandler {
     /**
@@ -880,59 +881,6 @@ export declare function createPfxCertOption(pfx: string | Buffer, options?: {
     passphrase?: string;
 }): SecureContextOptions;
 
-/**
- * Default SSO execution activity handler
- */
-export declare class DefaultBotSsoExecutionActivityHandler extends TeamsActivityHandler implements BotSsoExecutionActivityHandler {
-    private ssoExecutionDialog;
-    private userState;
-    private conversationState;
-    private dialogState;
-    /**
-     * Creates a new instance of the DefaultBotSsoExecutionActivityHandler.
-     * @param ssoConfig configuration for SSO command bot
-     *
-     * @remarks
-     * In the constructor, it uses BotSsoConfig parameter which from {@link ConversationBot} options to initialize {@link BotSsoExecutionDialog}.
-     * It also need to register an event handler for the message event which trigger {@link BotSsoExecutionDialog} instance.
-     */
-    constructor(ssoConfig: BotSsoConfig);
-    /**
-     * Add TeamsFxBotSsoCommandHandler instance to SSO execution dialog
-     * @param handler {@link BotSsoExecutionDialogHandler} callback function
-     * @param triggerPatterns The trigger pattern
-     *
-     * @remarks
-     * This function is used to add SSO command to {@link BotSsoExecutionDialog} instance.
-     */
-    addCommand(handler: BotSsoExecutionDialogHandler, triggerPatterns: TriggerPatterns): void;
-    /**
-     * Called to initiate the event emission process.
-     * @param context The context object for the current turn.
-     */
-    run(context: TurnContext): Promise<void>;
-    /**
-     * Receives invoke activities with Activity name of 'signin/verifyState'.
-     * @param context A context object for this turn.
-     * @param query Signin state (part of signin action auth flow) verification invoke query.
-     * @returns A promise that represents the work queued.
-     *
-     * @remarks
-     * It should trigger {@link BotSsoExecutionDialog} instance to handle signin process
-     */
-    handleTeamsSigninVerifyState(context: TurnContext, query: SigninStateVerificationQuery): Promise<void>;
-    /**
-     * Receives invoke activities with Activity name of 'signin/tokenExchange'
-     * @param context A context object for this turn.
-     * @param query Signin state (part of signin action auth flow) verification invoke query
-     * @returns A promise that represents the work queued.
-     *
-     * @remark
-     * It should trigger {@link BotSsoExecutionDialog} instance to handle signin process
-     */
-    handleTeamsSigninTokenExchange(context: TurnContext, query: SigninStateVerificationQuery): Promise<void>;
-}
-
 /**
  * Error code to trace the error types.
  */
@@ -1063,6 +1011,25 @@ export declare interface GetTeamsUserTokenOptions extends GetTokenOptions {
  */
 export declare function getTediousConnectionConfig(teamsfx: TeamsFx, databaseName?: string): Promise<ConnectionConfig>;
 
+/**
+ * Users execute query in message extension with SSO or access token.
+ *
+ * @param {TurnContext} context - The context object for the current turn.
+ * @param {AuthenticationConfiguration} config - User custom the message extension authentication configuration.
+ * @param {string| string[]} scopes - The list of scopes for which the token will have access.
+ * @param {function} logic - Business logic when executing the query in message extension with SSO or access token.
+ *
+ * @throws {@link ErrorCode|InternalError} when User invoke not response to message extension query.
+ * @throws {@link ErrorCode|InternalError} when failed to get access token with unknown error.
+ * @throws {@link ErrorCode|TokenExpiredError} when SSO token has already expired.
+ * @throws {@link ErrorCode|ServiceError} when failed to get access token from simple auth server.
+ * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
+ * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is nodeJS.
+ *
+ * @returns A MessageExtension Response for the activity. If the logic not return any, return void instead.
+ */
+export declare function handleMessageExtensionQueryWithToken(context: TurnContext, config: AuthenticationConfiguration | null, scopes: string | string[], logic: (token: MessageExtensionTokenResponse) => Promise<any>): Promise<MessagingExtensionResponse | void>;
+
 /**
  * Identity type to use in authentication.
  */
@@ -1378,6 +1345,20 @@ export declare class MessageBuilder {
     static attachContent(attachement: Attachment): Partial<Activity>;
 }
 
+/**
+ * Token response provided by Teams Bot SSO prompt
+ */
+export declare interface MessageExtensionTokenResponse extends TokenResponse {
+    /**
+     * SSO token for user
+     */
+    ssoToken: string;
+    /**
+     * Expire time of SSO token
+     */
+    ssoTokenExpiration: string;
+}
+
 /**
  * The response of a message action, e.g., `sendMessage`, `sendAdaptiveCard`.
  */
@@ -1445,6 +1426,43 @@ export declare class NotificationBot {
      * @returns - an array of {@link TeamsBotInstallation}.
      */
     installations(): Promise<TeamsBotInstallation[]>;
+    /**
+     * Returns 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: (member: Member) => Promise<boolean>, scope?: SearchScope): Promise<Member | undefined>;
+    /**
+     * Returns the first {@link Channel} where predicate is true, and undefined otherwise.
+     *
+     * @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: (channel: Channel, teamDetails: TeamDetails | undefined) => Promise<boolean>): Promise<Channel | undefined>;
+    /**
+     * Returns 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: (member: Member) => Promise<boolean>, scope?: SearchScope): Promise<Member[]>;
+    /**
+     * Returns all {@link Channel} where predicate is true, and empty array otherwise.
+     *
+     * @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: (channel: Channel, teamDetails: TeamDetails | undefined) => Promise<boolean>): Promise<Channel[]>;
+    private matchSearchScope;
 }
 
 /**
@@ -1634,6 +1652,30 @@ export declare class OnBehalfOfUserCredential implements TokenCredential {
     private generateAuthServerError;
 }
 
+/**
+ * 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`.
+ */
+export declare enum SearchScope {
+    /**
+     * Search members from the installations in personal chat only.
+     */
+    Person = 1,
+    /**
+     * Search members from the installations in group chat only.
+     */
+    Group = 2,
+    /**
+     * Search members from the installations in Teams channel only.
+     */
+    Channel = 4,
+    /**
+     * Search members from all installations including personal chat, group chat and Teams channel.
+     */
+    All = 7
+}
+
 /**
  * Send an adaptive card message to a notification target.
  *
@@ -1755,6 +1797,12 @@ export declare class TeamsBotInstallation implements NotificationTarget {
      * @returns an array of members from where the bot is installed.
      */
     members(): Promise<Member[]>;
+    /**
+     * Get team details from this bot installation
+     *
+     * @returns the team details if bot is installed into a team, otherwise returns undefined.
+     */
+    getTeamDetails(): Promise<TeamDetails | undefined>;
 }
 
 /**
@@ -2095,11 +2143,11 @@ export declare interface TeamsFxBotSsoCommandHandler {
      *
      * @param context The bot context.
      * @param message The command message the user types from Teams.
-     * @param ssoToken The sso token which can be used to exchange access token for the bot.
+     * @param tokenResponse The tokenResponse which contains sso token that can be used to exchange access token for the bot.
      * @returns A `Promise` representing an activity or text to send as the command response.
      * Or no return value if developers want to send the response activity by themselves in this method.
      */
-    handleCommandReceived(context: TurnContext, message: CommandMessage, ssoToken: TeamsBotSsoPromptTokenResponse): Promise<string | Partial<Activity> | void>;
+    handleCommandReceived(context: TurnContext, message: CommandMessage, tokenResponse: TeamsBotSsoPromptTokenResponse): Promise<string | Partial<Activity> | void>;
 }
 
 /**