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

package/dist/index.node.cjs.js

@@ -167,6 +167,7 @@ ErrorMessage.EmptyParameter = "Parameter {0} is empty";
 ErrorMessage.DuplicateHttpsOptionProperty = "Axios HTTPS agent already defined value for property {0}";
 ErrorMessage.DuplicateApiKeyInHeader = "The request already defined api key in request header with name {0}.";
 ErrorMessage.DuplicateApiKeyInQueryParam = "The request already defined api key in query parameter with name {0}.";
+ErrorMessage.OnlySupportInQueryActivity = "The handleMessageExtensionQueryWithToken only support in handleTeamsMessagingExtensionQuery with composeExtension/query type.";
 /**
  * Error class with code and message thrown by the SDK.
  */
@@ -2250,7 +2251,6 @@ class CommandResponseMiddleware {
             yield this.processResponse(context, response);
         }), ssoHandler.triggerPatterns);
         this.ssoCommandHandlers.push(ssoHandler);
-        this.commandHandlers.push(ssoHandler);
         this.hasSsoCommand = true;
     }
     onTurn(context, next) {
@@ -2259,23 +2259,29 @@ class CommandResponseMiddleware {
             if (context.activity.type === botbuilder.ActivityTypes.Message) {
                 // Invoke corresponding command handler for the command response
                 const commandText = this.getActivityText(context.activity);
+                let alreadyProcessed = false;
                 for (const handler of this.commandHandlers) {
                     const matchResult = this.shouldTrigger(handler.triggerPatterns, commandText);
                     // It is important to note that the command bot will stop processing handlers
                     // when the first command handler is matched.
                     if (!!matchResult) {
-                        if (this.isSsoExecutionHandler(handler)) {
+                        const message = {
+                            text: commandText,
+                        };
+                        message.matches = Array.isArray(matchResult) ? matchResult : void 0;
+                        const response = yield handler.handleCommandReceived(context, message);
+                        yield this.processResponse(context, response);
+                        alreadyProcessed = true;
+                        break;
+                    }
+                }
+                if (!alreadyProcessed) {
+                    for (const handler of this.ssoCommandHandlers) {
+                        const matchResult = this.shouldTrigger(handler.triggerPatterns, commandText);
+                        if (!!matchResult) {
                             yield ((_a = this.ssoActivityHandler) === null || _a === void 0 ? void 0 : _a.run(context));
+                            break;
                         }
-                        else {
-                            const message = {
-                                text: commandText,
-                            };
-                            message.matches = Array.isArray(matchResult) ? matchResult : void 0;
-                            const response = yield handler.handleCommandReceived(context, message);
-                            yield this.processResponse(context, response);
-                        }
-                        break;
                     }
                 }
             }
@@ -2300,9 +2306,6 @@ class CommandResponseMiddleware {
             }
         });
     }
-    isSsoExecutionHandler(handler) {
-        return this.ssoCommandHandlers.indexOf(handler) >= 0;
-    }
     matchPattern(pattern, text) {
         if (text) {
             if (typeof pattern === "string") {
@@ -2912,6 +2915,10 @@ class TeamsBotInstallation {
      */
     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.continueConversation(this.conversationReference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
                 const teamId = getTeamsBotInstallationId(context);
@@ -2919,7 +2926,6 @@ class TeamsBotInstallation {
                     teamsChannels = yield botbuilder.TeamsInfo.getTeamChannels(context, teamId);
                 }
             }));
-            const channels = [];
             for (const channel of teamsChannels) {
                 channels.push(new Channel(this, channel));
             }
@@ -2947,6 +2953,26 @@ class TeamsBotInstallation {
             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.continueConversation(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).
@@ -3008,7 +3034,129 @@ class NotificationBot {
             return targets;
         });
     }
-}
+    /**
+     * 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, 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;
+        });
+    }
+    /**
+     * 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) {
+        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;
+        });
+    }
+    /**
+     * 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, 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;
+        });
+    }
+    /**
+     * 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) {
+        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 : exports.SearchScope.All;
+        return ((target.type === exports.NotificationTargetType.Channel && (scope & exports.SearchScope.Channel) !== 0) ||
+            (target.type === exports.NotificationTargetType.Group && (scope & exports.SearchScope.Group) !== 0) ||
+            (target.type === exports.NotificationTargetType.Person && (scope & exports.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`.
+ */
+exports.SearchScope = void 0;
+(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";
+})(exports.SearchScope || (exports.SearchScope = {}));
 
 // Copyright (c) Microsoft Corporation.
 let DIALOG_NAME = "BotSsoExecutionDialog";
@@ -3646,6 +3794,110 @@ class MessageBuilder {
     }
 }
 
+// Copyright (c) Microsoft Corporation.
+/**
+ * Retrieve the OAuth Sign in Link to use in the MessagingExtensionResult Suggested Actions.
+ * This method only work on MessageExtension with Query now.
+ *
+ * @param {TeamsFx} teamsfx - Used to provide configuration and auth.
+ * @param {string | string[]} scopes - The list of scopes for which the token will have access.
+ *
+ * @returns SignIn link CardAction with 200 status code.
+ */
+function getSignInResponseForMessageExtension(teamsfx, scopes) {
+    const scopesArray = getScopesArray(scopes);
+    const signInLink = `${teamsfx.getConfig("initiateLoginEndpoint")}?scope=${encodeURI(scopesArray.join(" "))}&clientId=${teamsfx.getConfig("clientId")}&tenantId=${teamsfx.getConfig("tenantId")}`;
+    return {
+        composeExtension: {
+            type: "silentAuth",
+            suggestedActions: {
+                actions: [
+                    {
+                        type: "openUrl",
+                        value: signInLink,
+                        title: "Message Extension OAuth",
+                    },
+                ],
+            },
+        },
+    };
+}
+/**
+ * execution in message extension with SSO token.
+ *
+ * @param {TurnContext} context - The context object for the current turn.
+ * @param {AuthenticationConfiguration} config - User custom the message extension authentication configuration.
+ * @param {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 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.
+ */
+function executionWithToken(context, config, scopes, logic) {
+    return tslib.__awaiter(this, void 0, void 0, function* () {
+        const valueObj = context.activity.value;
+        if (!valueObj.authentication || !valueObj.authentication.token) {
+            internalLogger.verbose("No AccessToken in request, return silentAuth for AccessToken");
+            return getSignInResponseForMessageExtension(new TeamsFx(exports.IdentityType.User, config), scopes);
+        }
+        try {
+            const teamsfx = new TeamsFx(exports.IdentityType.User, config).setSsoToken(valueObj.authentication.token);
+            const token = yield teamsfx.getCredential().getToken(scopes);
+            const ssoTokenExpiration = parseJwt(valueObj.authentication.token).exp;
+            const tokenRes = {
+                ssoToken: valueObj.authentication.token,
+                ssoTokenExpiration: new Date(ssoTokenExpiration * 1000).toISOString(),
+                token: token.token,
+                expiration: token.expiresOnTimestamp.toString(),
+                connectionName: "",
+            };
+            if (logic) {
+                return yield logic(tokenRes);
+            }
+        }
+        catch (err) {
+            if (err instanceof ErrorWithCode && err.code === exports.ErrorCode.UiRequiredError) {
+                internalLogger.verbose("User not consent yet, return 412 to user consent first.");
+                const response = { status: 412 };
+                yield context.sendActivity({ value: response, type: botbuilder.ActivityTypes.InvokeResponse });
+                return;
+            }
+            throw err;
+        }
+    });
+}
+/**
+ * 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.
+ */
+function handleMessageExtensionQueryWithToken(context, config, scopes, logic) {
+    return tslib.__awaiter(this, void 0, void 0, function* () {
+        if (context.activity.name != "composeExtension/query") {
+            internalLogger.error(ErrorMessage.OnlySupportInQueryActivity);
+            throw new ErrorWithCode(formatString(ErrorMessage.OnlySupportInQueryActivity), exports.ErrorCode.FailedOperation);
+        }
+        return yield executionWithToken(context, config !== null && config !== void 0 ? config : {}, scopes, logic);
+    });
+}
+
 exports.ApiKeyProvider = ApiKeyProvider;
 exports.AppCredential = AppCredential;
 exports.BasicAuthProvider = BasicAuthProvider;
@@ -3656,7 +3908,6 @@ exports.CertificateAuthProvider = CertificateAuthProvider;
 exports.Channel = Channel;
 exports.CommandBot = CommandBot;
 exports.ConversationBot = ConversationBot;
-exports.DefaultBotSsoExecutionActivityHandler = DefaultBotSsoExecutionActivityHandler;
 exports.ErrorWithCode = ErrorWithCode;
 exports.InvokeResponseFactory = InvokeResponseFactory;
 exports.Member = Member;
@@ -3674,6 +3925,7 @@ exports.createPemCertOption = createPemCertOption;
 exports.createPfxCertOption = createPfxCertOption;
 exports.getLogLevel = getLogLevel;
 exports.getTediousConnectionConfig = getTediousConnectionConfig;
+exports.handleMessageExtensionQueryWithToken = handleMessageExtensionQueryWithToken;
 exports.sendAdaptiveCard = sendAdaptiveCard;
 exports.sendMessage = sendMessage;
 exports.setLogFunction = setLogFunction;