@microsoft/teamsfx 2.3.0 → 2.3.1-alpha.0028ae747.0

package/dist/index.esm2017.mjs

@@ -10,7 +10,6 @@ import axios from 'axios';
 import { Agent } from 'https';
 import * as path from 'path';
 import * as fs from 'fs';
-import { __rest } from 'tslib';
 import { AdaptiveCards } from '@microsoft/adaptivecards-tools';
 
 // Copyright (c) Microsoft Corporation.
@@ -139,6 +138,7 @@ ErrorMessage.DuplicateHttpsOptionProperty = "Axios HTTPS agent already defined v
 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.";
+ErrorMessage.OnlySupportInLinkQueryActivity = "The handleMessageExtensionLinkQueryWithSSO only support in handleTeamsAppBasedLinkQuery with composeExtension/queryLink type.";
 /**
  * Error class with code and message thrown by the SDK.
  */
@@ -1475,7 +1475,7 @@ function createApiClient(apiEndpoint, authProvider) {
         baseURL: apiEndpoint,
     });
     instance.interceptors.request.use(async function (config) {
-        return await authProvider.AddAuthenticationInfo(config);
+        return (await authProvider.AddAuthenticationInfo(config));
     });
     return instance;
 }
@@ -1985,6 +1985,7 @@ var InvokeResponseErrorCode;
     InvokeResponseErrorCode[InvokeResponseErrorCode["InternalServerError"] = 500] = "InternalServerError";
 })(InvokeResponseErrorCode || (InvokeResponseErrorCode = {}));
 
+// Copyright (c) Microsoft Corporation.
 /**
  * Available response type for an adaptive card invoke response.
  * @internal
@@ -1999,7 +2000,7 @@ var InvokeResponseType;
  * 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
+ * All of these functions return an `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.
@@ -2424,6 +2425,7 @@ function cloneConversation(conversation) {
  */
 function getKey(reference) {
     var _a, _b;
+    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
     return `_${(_a = reference.conversation) === null || _a === void 0 ? void 0 : _a.tenantId}_${(_b = reference.conversation) === null || _b === void 0 ? void 0 : _b.id}`;
 }
 /**
@@ -2533,7 +2535,7 @@ class NotificationMiddleware {
         return ActivityType.Unknown;
     }
     async tryAddMessagedReference(context) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f;
         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") {
@@ -2541,7 +2543,9 @@ class NotificationMiddleware {
         }
         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 channelId = (_f = (_e = context.activity.channelData) === null || _e === void 0 ? void 0 : _e.channel) === null || _f === void 0 ? void 0 : _f.id;
+            // `teamId === channelId` means General channel. Ignore messaging in non-General channel.
+            if (teamId !== undefined && (channelId === undefined || teamId === channelId)) {
                 const teamReference = cloneConversation(reference);
                 teamReference.conversation.id = teamId;
                 await this.conversationReferenceStore.add(getKey(teamReference), teamReference, {
@@ -2558,7 +2562,8 @@ class NotificationMiddleware {
  */
 class LocalFileStorage {
     constructor(fileDir) {
-        this.localFileName = ".notification.localstore.json";
+        var _a;
+        this.localFileName = (_a = process.env.TEAMSFX_NOTIFICATION_STORE_FILENAME) !== null && _a !== void 0 ? _a : ".notification.localstore.json";
         this.filePath = path.resolve(fileDir, this.localFileName);
     }
     async read(key) {
@@ -3222,6 +3227,38 @@ var SearchScope$1;
     SearchScope[SearchScope["All"] = 7] = "All";
 })(SearchScope$1 || (SearchScope$1 = {}));
 
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __rest(s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
 // Copyright (c) Microsoft Corporation.
 let DIALOG_NAME = "BotSsoExecutionDialog";
 let TEAMS_SSO_PROMPT_ID = "TeamsFxSsoPrompt";
@@ -3554,7 +3591,7 @@ class DefaultBotSsoExecutionActivityHandler extends TeamsActivityHandler {
      * @param query Signin state (part of signin action auth flow) verification invoke query
      * @returns A promise that represents the work queued.
      *
-     * @remark
+     * @remarks
      * It should trigger {@link BotSsoExecutionDialog} instance to handle signin process
      */
     async handleTeamsSigninTokenExchange(context, query) {
@@ -3664,9 +3701,12 @@ class ConversationBot$1 {
         // the default error handler
         adapter.onTurnError = async (context, error) => {
             // This check writes out errors to console.
+            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
             console.error(`[onTurnError] unhandled error: ${error}`);
             // Send a trace activity, which will be displayed in Bot Framework Emulator
-            await context.sendTraceActivity("OnTurnError Trace", `${error}`, "https://www.botframework.com/schemas/error", "TurnError");
+            await context.sendTraceActivity("OnTurnError Trace", 
+            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+            `${error}`, "https://www.botframework.com/schemas/error", "TurnError");
             // Send a message to the user
             await context.sendActivity(`The bot encountered unhandled error: ${error.message}`);
             await context.sendActivity("To continue to run this bot, please fix the bot source code.");
@@ -3848,9 +3888,9 @@ class MessageBuilder {
  * @param {initiateLoginEndpoint} initiateLoginEndpoint - Login page for Teams to redirect to.
  * @param {string | string[]} scopes - The list of scopes for which the token will have access.
  *
- * @returns SignIn link CardAction with 200 status code.
+ * @returns SignIn link SilentAuth CardAction with 200 status code.
  */
-function getSignInResponseForMessageExtensionWithAuthConfig(authConfig, initiateLoginEndpoint, scopes) {
+function getSignInResponseForMessageExtensionWithSilentAuthConfig(authConfig, initiateLoginEndpoint, scopes) {
     const scopesArray = getScopesArray(scopes);
     const signInLink = `${initiateLoginEndpoint}?scope=${encodeURI(scopesArray.join(" "))}&clientId=${authConfig.clientId}&tenantId=${authConfig.tenantId}`;
     return {
@@ -3868,6 +3908,34 @@ function getSignInResponseForMessageExtensionWithAuthConfig(authConfig, initiate
         },
     };
 }
+/**
+ *  Retrieve the OAuth Sign in Link to use in the MessagingExtensionResult Suggested Actions.
+ * This method just a workaround for link unfurling now.
+ *
+ * @param {OnBehalfOfCredentialAuthConfig} authConfig - User custom the message extension authentication configuration.
+ * @param {initiateLoginEndpoint} initiateLoginEndpoint - Login page for Teams to redirect to.
+ * @param {string | string[]} scopes - The list of scopes for which the token will have access.
+ *
+ * @returns SignIn link Auth CardAction with 200 status code.
+ */
+function getSignInResponseForMessageExtensionWithAuthConfig(authConfig, initiateLoginEndpoint, scopes) {
+    const scopesArray = getScopesArray(scopes);
+    const signInLink = `${initiateLoginEndpoint}?scope=${encodeURI(scopesArray.join(" "))}&clientId=${authConfig.clientId}&tenantId=${authConfig.tenantId}`;
+    return {
+        composeExtension: {
+            type: "auth",
+            suggestedActions: {
+                actions: [
+                    {
+                        type: "openUrl",
+                        value: signInLink,
+                        title: "Message Extension OAuth",
+                    },
+                ],
+            },
+        },
+    };
+}
 /**
  * Retrieve the OAuth Sign in Link to use in the MessagingExtensionResult Suggested Actions.
  * This method only work on MessageExtension with Query now.
@@ -3916,7 +3984,7 @@ async function executionWithTokenAndConfig(context, authConfig, initiateLoginEnd
     const valueObj = context.activity.value;
     if (!valueObj.authentication || !valueObj.authentication.token) {
         internalLogger.verbose("No AccessToken in request, return silentAuth for AccessToken");
-        return getSignInResponseForMessageExtensionWithAuthConfig(authConfig, initiateLoginEndpoint, scopes);
+        return getSignInResponseForMessageExtensionWithSilentAuthConfig(authConfig, initiateLoginEndpoint, scopes);
     }
     try {
         const credential = new OnBehalfOfUserCredential(valueObj.authentication.token, authConfig);
@@ -3934,12 +4002,25 @@ async function executionWithTokenAndConfig(context, authConfig, initiateLoginEnd
         }
     }
     catch (err) {
-        if (err instanceof ErrorWithCode && err.code === ErrorCode.UiRequiredError) {
+        if (err instanceof ErrorWithCode &&
+            err.code === ErrorCode.UiRequiredError &&
+            context.activity.name === "composeExtension/query") {
             internalLogger.verbose("User not consent yet, return 412 to user consent first.");
             const response = { status: 412 };
             await context.sendActivity({ value: response, type: ActivityTypes.InvokeResponse });
             return;
         }
+        else if (err instanceof ErrorWithCode &&
+            err.code === ErrorCode.UiRequiredError &&
+            context.activity.name === "composeExtension/queryLink") {
+            internalLogger.verbose("User not consent yet, return auth card for user login");
+            const response = getSignInResponseForMessageExtensionWithAuthConfig(authConfig, initiateLoginEndpoint, scopes);
+            await context.sendActivity({
+                value: { status: 200, body: response },
+                type: ActivityTypes.InvokeResponse,
+            });
+            return;
+        }
         throw err;
     }
 }
@@ -4041,6 +4122,31 @@ async function handleMessageExtensionQueryWithSSO(context, config, initiateLogin
         throw new ErrorWithCode(formatString(ErrorMessage.OnlySupportInQueryActivity), ErrorCode.FailedOperation);
     }
     return await executionWithTokenAndConfig(context, config !== null && config !== void 0 ? config : {}, initiateLoginEndpoint, scopes, logic);
+}
+/**
+ * Users execute link query in message extension with SSO or access token.
+ *
+ * @param {TurnContext} context - The context object for the current turn.
+ * @param {OnBehalfOfCredentialAuthConfig} config - User custom the message extension authentication configuration.
+ * @param {initiateLoginEndpoint} initiateLoginEndpoint - Login page for Teams to redirect to.
+ * @param {string| string[]} scopes - The list of scopes for which the token will have access.
+ * @param {function} logic - Business logic when executing the link query in message extension with SSO or access token.
+ *
+ * @throws {@link ErrorCode|InternalError} when User invoke not response to message extension link 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.
+ */
+async function handleMessageExtensionLinkQueryWithSSO(context, config, initiateLoginEndpoint, scopes, logic) {
+    if (context.activity.name != "composeExtension/queryLink") {
+        internalLogger.error(ErrorMessage.OnlySupportInLinkQueryActivity);
+        throw new ErrorWithCode(formatString(ErrorMessage.OnlySupportInLinkQueryActivity), ErrorCode.FailedOperation);
+    }
+    return await executionWithTokenAndConfig(context, config !== null && config !== void 0 ? config : {}, initiateLoginEndpoint, scopes, logic);
 }
 
 /**
@@ -4941,5 +5047,5 @@ var conversationWithCloudAdapter = /*#__PURE__*/Object.freeze({
   CardActionBot: CardActionBot
 });
 
-export { AdaptiveCardResponse, ApiKeyLocation, ApiKeyProvider, AppCredential, BasicAuthProvider, BearerTokenAuthProvider, conversationWithCloudAdapter as BotBuilderCloudAdapter, BotSsoExecutionDialog, CardActionBot$1 as CardActionBot, CertificateAuthProvider, Channel$1 as Channel, CommandBot$1 as CommandBot, ConversationBot$1 as ConversationBot, ErrorCode, ErrorWithCode, IdentityType, InvokeResponseErrorCode, InvokeResponseFactory, LogLevel, Member$1 as Member, MessageBuilder, MsGraphAuthProvider, NotificationBot$1 as NotificationBot, NotificationTargetType, OnBehalfOfUserCredential, SearchScope$1 as SearchScope, TeamsBotInstallation$1 as TeamsBotInstallation, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createApiClient, createMicrosoftGraphClient, createMicrosoftGraphClientWithCredential, createPemCertOption, createPfxCertOption, getLogLevel, getTediousConnectionConfig, handleMessageExtensionQueryWithSSO, handleMessageExtensionQueryWithToken, sendAdaptiveCard$1 as sendAdaptiveCard, sendMessage$1 as sendMessage, setLogFunction, setLogLevel, setLogger };
+export { AdaptiveCardResponse, ApiKeyLocation, ApiKeyProvider, AppCredential, BasicAuthProvider, BearerTokenAuthProvider, conversationWithCloudAdapter as BotBuilderCloudAdapter, BotSsoExecutionDialog, CardActionBot$1 as CardActionBot, CertificateAuthProvider, Channel$1 as Channel, CommandBot$1 as CommandBot, ConversationBot$1 as ConversationBot, ErrorCode, ErrorWithCode, IdentityType, InvokeResponseErrorCode, InvokeResponseFactory, LogLevel, Member$1 as Member, MessageBuilder, MsGraphAuthProvider, NotificationBot$1 as NotificationBot, NotificationTargetType, OnBehalfOfUserCredential, SearchScope$1 as SearchScope, TeamsBotInstallation$1 as TeamsBotInstallation, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createApiClient, createMicrosoftGraphClient, createMicrosoftGraphClientWithCredential, createPemCertOption, createPfxCertOption, getLogLevel, getTediousConnectionConfig, handleMessageExtensionLinkQueryWithSSO, handleMessageExtensionQueryWithSSO, handleMessageExtensionQueryWithToken, sendAdaptiveCard$1 as sendAdaptiveCard, sendMessage$1 as sendMessage, setLogFunction, setLogLevel, setLogger };
 //# sourceMappingURL=index.esm2017.mjs.map