@microsoft/teamsfx 2.2.3-alpha.9b38c38b5.0 → 2.2.3-alpha.a0d5ed36e.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.
@@ -396,6 +395,7 @@ function getAuthority(authorityHost, tenantId) {
     return normalizedAuthorityHost + "/" + tenantId;
 }
 
+// Copyright (c) Microsoft Corporation.
 /**
  * @internal
  */
@@ -713,16 +713,16 @@ class TeamsUserCredential {
      * @remarks
      * Can only be used within Teams.
      */
-    async login(scopes, resources) {
-        throw new ErrorWithCode(formatString(ErrorMessage.NodejsRuntimeNotSupported, "TeamsUserCredential"), ErrorCode.RuntimeNotSupported);
+    login(scopes, resources) {
+        return Promise.reject(new ErrorWithCode(formatString(ErrorMessage.NodejsRuntimeNotSupported, "TeamsUserCredential"), ErrorCode.RuntimeNotSupported));
     }
     /**
      * Get access token from credential.
      * @remarks
      * Can only be used within Teams.
      */
-    async getToken(scopes, options) {
-        throw new ErrorWithCode(formatString(ErrorMessage.NodejsRuntimeNotSupported, "TeamsUserCredential"), ErrorCode.RuntimeNotSupported);
+    getToken(scopes, options) {
+        return Promise.reject(new ErrorWithCode(formatString(ErrorMessage.NodejsRuntimeNotSupported, "TeamsUserCredential"), ErrorCode.RuntimeNotSupported));
     }
     /**
      * Get basic user info from SSO token
@@ -733,14 +733,16 @@ class TeamsUserCredential {
      * Can only be used within Teams.
      */
     getUserInfo(resources) {
-        throw new ErrorWithCode(formatString(ErrorMessage.NodejsRuntimeNotSupported, "TeamsUserCredential"), ErrorCode.RuntimeNotSupported);
+        return Promise.reject(new ErrorWithCode(formatString(ErrorMessage.NodejsRuntimeNotSupported, "TeamsUserCredential"), ErrorCode.RuntimeNotSupported));
     }
 }
 
 // Copyright (c) Microsoft Corporation.
 const defaultScope = "https://graph.microsoft.com/.default";
+// eslint-disable-next-line no-secrets/no-secrets
 /**
  * Microsoft Graph auth provider for Teams Framework
+ * @deprecated Use `TokenCredentialAuthenticationProvider` from `@microsoft/microsoft-graph-client/authProviders/azureTokenCredentials` instead.
  */
 class MsGraphAuthProvider {
     constructor(credentialOrTeamsFx, scopes) {
@@ -769,7 +771,7 @@ class MsGraphAuthProvider {
      *
      */
     async getAccessToken() {
-        internalLogger.info(`Get Graph Access token with scopes: '${this.scopes}'`);
+        internalLogger.info(`Get Graph Access token with scopes: '${this.scopes.toString()}'`);
         let accessToken;
         if (this.credentialOrTeamsFx.getCredential) {
             accessToken = await this.credentialOrTeamsFx
@@ -795,6 +797,14 @@ class MsGraphAuthProvider {
 // Copyright (c) Microsoft Corporation.
 /**
  * Get Microsoft graph client.
+ * @deprecated Use `TokenCredentialAuthenticationProvider` and `Client.initWithMiddleware` instead.
+ * ```typescript
+ * const authProvider = new TokenCredentialAuthenticationProvider(credential, { scopes: scope });
+ * const graph = Client.initWithMiddleware({
+ *   authProvider: authProvider,
+ * });
+ * ```
+ *
  * @example
  * Get Microsoft graph client by TokenCredential
  * ```typescript
@@ -852,6 +862,14 @@ function createMicrosoftGraphClient(teamsfx, scopes) {
 // eslint-disable-next-line no-secrets/no-secrets
 /**
  * Get Microsoft graph client.
+ * @deprecated Use `TokenCredentialAuthenticationProvider` and `Client.initWithMiddleware` instead.
+ * ```typescript
+ * const authProvider = new TokenCredentialAuthenticationProvider(credential, { scopes: scope });
+ * const graph = Client.initWithMiddleware({
+ *   authProvider: authProvider,
+ * });
+ * ```
+ *
  * @example
  * Get Microsoft graph client by TokenCredential
  * ```typescript
@@ -1007,7 +1025,7 @@ function isMsiAuthentication(teamsfx) {
 function generateDefaultConfig(teamsfx, databaseName) {
     internalLogger.verbose(`SQL server ${teamsfx.getConfig("sqlServerEndpoint")}
     , user name ${teamsfx.getConfig("sqlUsername")}
-    , database name ${databaseName}`);
+    , database name ${databaseName ? databaseName : ""}`);
     const config = {
         server: teamsfx.getConfig("sqlServerEndpoint"),
         authentication: {
@@ -1060,7 +1078,7 @@ async function generateTokenConfig(teamsfx, databaseName) {
         };
         internalLogger.verbose(`Generate token configuration success
       , server endpoint is ${teamsfx.getConfig("sqlServerEndpoint")}
-      , database name is ${databaseName}`);
+      , database name is ${databaseName ? databaseName : ""}`);
         return config;
     }
     internalLogger.error(`Generate token configuration
@@ -1328,7 +1346,8 @@ class TeamsBotSsoPrompt extends Dialog {
     async sendOAuthCardAsync(context) {
         internalLogger.verbose("Send OAuth card to get SSO token");
         const account = await TeamsInfo.getMember(context, context.activity.from.id);
-        internalLogger.verbose("Get Teams member account user principal name: " + account.userPrincipalName);
+        internalLogger.verbose("Get Teams member account user principal name: " +
+            (account.userPrincipalName ? account.userPrincipalName : ""));
         const loginHint = account.userPrincipalName ? account.userPrincipalName : "";
         const signInResource = this.getSignInResource(loginHint);
         const card = CardFactory.oauthCard("", "Teams SSO Sign In", "Sign In", signInResource.signInLink, signInResource.tokenExchangeResource);
@@ -1528,18 +1547,18 @@ class BasicAuthProvider {
      * @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when Authorization header or auth property already exists in request configuration.
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
      */
-    async AddAuthenticationInfo(config) {
+    AddAuthenticationInfo(config) {
         if (config.headers && config.headers["Authorization"]) {
-            throw new ErrorWithCode(ErrorMessage.AuthorizationHeaderAlreadyExists, ErrorCode.AuthorizationInfoAlreadyExists);
+            return Promise.reject(new ErrorWithCode(ErrorMessage.AuthorizationHeaderAlreadyExists, ErrorCode.AuthorizationInfoAlreadyExists));
         }
         if (config.auth) {
-            throw new ErrorWithCode(ErrorMessage.BasicCredentialAlreadyExists, ErrorCode.AuthorizationInfoAlreadyExists);
+            return Promise.reject(new ErrorWithCode(ErrorMessage.BasicCredentialAlreadyExists, ErrorCode.AuthorizationInfoAlreadyExists));
         }
         config.auth = {
             username: this.userName,
             password: this.password,
         };
-        return config;
+        return Promise.resolve(config);
     }
 }
 
@@ -1579,14 +1598,14 @@ class ApiKeyProvider {
      * @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when API key already exists in request header or url query parameter.
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
      */
-    async AddAuthenticationInfo(config) {
+    AddAuthenticationInfo(config) {
         switch (this.keyLocation) {
             case ApiKeyLocation.Header:
                 if (!config.headers) {
                     config.headers = {};
                 }
                 if (config.headers[this.keyName]) {
-                    throw new ErrorWithCode(formatString(ErrorMessage.DuplicateApiKeyInHeader, this.keyName), ErrorCode.AuthorizationInfoAlreadyExists);
+                    return Promise.reject(new ErrorWithCode(formatString(ErrorMessage.DuplicateApiKeyInHeader, this.keyName), ErrorCode.AuthorizationInfoAlreadyExists));
                 }
                 config.headers[this.keyName] = this.keyValue;
                 break;
@@ -1600,12 +1619,12 @@ class ApiKeyProvider {
                     urlHasDefinedApiKey = url.searchParams.has(this.keyName);
                 }
                 if (config.params[this.keyName] || urlHasDefinedApiKey) {
-                    throw new ErrorWithCode(formatString(ErrorMessage.DuplicateApiKeyInQueryParam, this.keyName), ErrorCode.AuthorizationInfoAlreadyExists);
+                    return Promise.reject(new ErrorWithCode(formatString(ErrorMessage.DuplicateApiKeyInQueryParam, this.keyName), ErrorCode.AuthorizationInfoAlreadyExists));
                 }
                 config.params[this.keyName] = this.keyValue;
                 break;
         }
-        return config;
+        return Promise.resolve(config);
     }
 }
 /**
@@ -1652,7 +1671,7 @@ class CertificateAuthProvider {
      *
      * @throws {@link ErrorCode|InvalidParameter} - when custom httpsAgent in the request has duplicate properties with certOption provided in constructor.
      */
-    async AddAuthenticationInfo(config) {
+    AddAuthenticationInfo(config) {
         if (!config.httpsAgent) {
             config.httpsAgent = new Agent(this.certOption);
         }
@@ -1660,12 +1679,12 @@ class CertificateAuthProvider {
             const existingProperties = new Set(Object.keys(config.httpsAgent.options));
             for (const property of Object.keys(this.certOption)) {
                 if (existingProperties.has(property)) {
-                    throw new ErrorWithCode(formatString(ErrorMessage.DuplicateHttpsOptionProperty, property), ErrorCode.InvalidParameter);
+                    return Promise.reject(new ErrorWithCode(formatString(ErrorMessage.DuplicateHttpsOptionProperty, property), ErrorCode.InvalidParameter));
                 }
             }
             Object.assign(config.httpsAgent.options, this.certOption);
         }
-        return config;
+        return Promise.resolve(config);
     }
 }
 /**
@@ -1734,6 +1753,8 @@ const ReservedKey = new Set([
 ]);
 /**
  * A class providing credential and configuration.
+ * @deprecated Please use {@link TeamsUserCredential}
+ * in browser environment and {@link OnBehalfOfUserCredential} or {@link AppCredential} in NodeJS.
  */
 class TeamsFx {
     /**
@@ -1963,6 +1984,7 @@ var InvokeResponseErrorCode;
     InvokeResponseErrorCode[InvokeResponseErrorCode["InternalServerError"] = 500] = "InternalServerError";
 })(InvokeResponseErrorCode || (InvokeResponseErrorCode = {}));
 
+// Copyright (c) Microsoft Corporation.
 /**
  * Available response type for an adaptive card invoke response.
  * @internal
@@ -1977,7 +1999,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.
@@ -2402,6 +2424,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}`;
 }
 /**
@@ -2719,7 +2742,7 @@ class Channel$1 {
     async sendMessage(text, onError) {
         const response = {};
         await this.parent.adapter.continueConversation(this.parent.conversationReference, async (context) => {
-            const conversation = await this.newConversation(context);
+            const conversation = this.newConversation(context);
             await this.parent.adapter.continueConversation(conversation, async (ctx) => {
                 try {
                     const res = await ctx.sendActivity(text);
@@ -2748,7 +2771,7 @@ class Channel$1 {
     async sendAdaptiveCard(card, onError) {
         const response = {};
         await this.parent.adapter.continueConversation(this.parent.conversationReference, async (context) => {
-            const conversation = await this.newConversation(context);
+            const conversation = this.newConversation(context);
             await this.parent.adapter.continueConversation(conversation, async (ctx) => {
                 try {
                     const res = await ctx.sendActivity({
@@ -2771,7 +2794,7 @@ class Channel$1 {
     /**
      * @internal
      */
-    async newConversation(context) {
+    newConversation(context) {
         const reference = TurnContext.getConversationReference(context.activity);
         const channelConversation = cloneConversation(reference);
         channelConversation.conversation.id = this.info.id || "";
@@ -3200,6 +3223,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";
@@ -3481,8 +3536,7 @@ class DefaultBotSsoExecutionActivityHandler extends TeamsActivityHandler {
             timeout: (_h = (_g = ssoConfig.dialog) === null || _g === void 0 ? void 0 : _g.ssoPromptConfig) === null || _h === void 0 ? void 0 : _h.timeout,
             endOnInvalidMessage: (_k = (_j = ssoConfig.dialog) === null || _j === void 0 ? void 0 : _j.ssoPromptConfig) === null || _k === void 0 ? void 0 : _k.endOnInvalidMessage,
         };
-        const teamsfx = new TeamsFx(IdentityType.User, Object.assign({}, customConfig));
-        this.ssoExecutionDialog = new BotSsoExecutionDialog(dedupStorage, settings, teamsfx);
+        this.ssoExecutionDialog = new BotSsoExecutionDialog(dedupStorage, settings, customConfig, customConfig.initiateLoginEndpoint);
         this.conversationState = conversationState;
         this.dialogState = conversationState.createProperty("DialogState");
         this.userState = userState;
@@ -3533,7 +3587,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) {
@@ -3643,9 +3697,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.");
@@ -3924,6 +3981,7 @@ async function executionWithTokenAndConfig(context, authConfig, initiateLoginEnd
 }
 /**
  * execution in message extension with SSO token.
+ * @deprecated Use {@link executionWithTokenAndConfig} instead.
  *
  * @param {TurnContext} context - The context object for the current turn.
  * @param {AuthenticationConfiguration} config - User custom the message extension authentication configuration.
@@ -3972,7 +4030,7 @@ async function executionWithToken(context, config, scopes, logic) {
 // eslint-disable-next-line no-secrets/no-secrets
 /**
  * Users execute query in message extension with SSO or access token.
- *
+ * @deprecated Use {@link handleMessageExtensionQueryWithSSO} instead.
  *
  * @param {TurnContext} context - The context object for the current turn.
  * @param {AuthenticationConfiguration} config - User custom the message extension authentication configuration.
@@ -4245,11 +4303,11 @@ class Channel {
     /**
      * @internal
      */
-    async newConversation(context) {
+    newConversation(context) {
         const reference = TurnContext.getConversationReference(context.activity);
         const channelConversation = cloneConversation(reference);
         channelConversation.conversation.id = this.info.id || "";
-        return channelConversation;
+        return Promise.resolve(channelConversation);
     }
 }
 /**
@@ -4556,6 +4614,27 @@ class NotificationBot {
         }
         return new TeamsBotInstallation(this.adapter, conversationReference, this.botAppId);
     }
+    /**
+     * Validate the installation by getting paged memebers.
+     *
+     * @param conversationReference The bound `ConversationReference`.
+     * @returns Returns false if recieves `BotNotInConversationRoster` error, otherwise returns true.
+     */
+    async validateInstallation(conversationReference) {
+        let isValid = true;
+        await this.adapter.continueConversationAsync(this.botAppId, conversationReference, async (context) => {
+            try {
+                // try get member to see if the installation is still valid
+                await TeamsInfo.getPagedMembers(context, 1);
+            }
+            catch (error) {
+                if (error.code === "BotNotInConversationRoster") {
+                    isValid = false;
+                }
+            }
+        });
+        return isValid;
+    }
     /**
      * Gets a pagined list of targets where the bot is installed.
      *
@@ -4567,7 +4646,7 @@ class NotificationBot {
      *
      * @returns An array of {@link TeamsBotInstallation} with paged data and continuation token.
      */
-    async getPagedInstallations(pageSize, continuationToken) {
+    async getPagedInstallations(pageSize, continuationToken, validationEnabled = true) {
         if (this.conversationReferenceStore === undefined || this.adapter === undefined) {
             throw new Error("NotificationBot has not been initialized.");
         }
@@ -4575,19 +4654,12 @@ class NotificationBot {
         const targets = [];
         for (const reference of references.data) {
             // validate connection
-            let valid = true;
-            await this.adapter.continueConversationAsync(this.botAppId, reference, async (context) => {
-                try {
-                    // try get member to see if the installation is still valid
-                    await TeamsInfo.getPagedMembers(context, 1);
-                }
-                catch (error) {
-                    if (error.code === "BotNotInConversationRoster") {
-                        valid = false;
-                    }
-                }
-            });
-            if (valid) {
+            let valid;
+            if (validationEnabled) {
+                // try get member to see if the installation is still valid
+                valid = await this.validateInstallation(reference);
+            }
+            if (!validationEnabled || (validationEnabled && valid)) {
                 targets.push(new TeamsBotInstallation(this.adapter, reference, this.botAppId));
             }
             else {
@@ -4849,9 +4921,9 @@ class ConversationBot {
         // the default error handler
         adapter.onTurnError = async (context, error) => {
             // This check writes out errors to console.
-            console.error(`[onTurnError] unhandled error: ${error}`);
+            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", error instanceof Error ? error.message : 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.");