@microsoft/teamsfx 2.2.3-alpha.81508f111.0 → 2.2.3-alpha.8b06251e7.0

package/dist/index.node.cjs.js

@@ -425,6 +425,7 @@ function getAuthority(authorityHost, tenantId) {
     return normalizedAuthorityHost + "/" + tenantId;
 }
 
+// Copyright (c) Microsoft Corporation.
 /**
  * @internal
  */
@@ -747,9 +748,7 @@ class TeamsUserCredential {
      * Can only be used within Teams.
      */
     login(scopes, resources) {
-        return tslib.__awaiter(this, void 0, void 0, function* () {
-            throw new ErrorWithCode(formatString(ErrorMessage.NodejsRuntimeNotSupported, "TeamsUserCredential"), exports.ErrorCode.RuntimeNotSupported);
-        });
+        return Promise.reject(new ErrorWithCode(formatString(ErrorMessage.NodejsRuntimeNotSupported, "TeamsUserCredential"), exports.ErrorCode.RuntimeNotSupported));
     }
     /**
      * Get access token from credential.
@@ -757,9 +756,7 @@ class TeamsUserCredential {
      * Can only be used within Teams.
      */
     getToken(scopes, options) {
-        return tslib.__awaiter(this, void 0, void 0, function* () {
-            throw new ErrorWithCode(formatString(ErrorMessage.NodejsRuntimeNotSupported, "TeamsUserCredential"), exports.ErrorCode.RuntimeNotSupported);
-        });
+        return Promise.reject(new ErrorWithCode(formatString(ErrorMessage.NodejsRuntimeNotSupported, "TeamsUserCredential"), exports.ErrorCode.RuntimeNotSupported));
     }
     /**
      * Get basic user info from SSO token
@@ -770,14 +767,16 @@ class TeamsUserCredential {
      * Can only be used within Teams.
      */
     getUserInfo(resources) {
-        throw new ErrorWithCode(formatString(ErrorMessage.NodejsRuntimeNotSupported, "TeamsUserCredential"), exports.ErrorCode.RuntimeNotSupported);
+        return Promise.reject(new ErrorWithCode(formatString(ErrorMessage.NodejsRuntimeNotSupported, "TeamsUserCredential"), exports.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) {
@@ -807,7 +806,7 @@ class MsGraphAuthProvider {
      */
     getAccessToken() {
         return tslib.__awaiter(this, void 0, void 0, function* () {
-            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 = yield this.credentialOrTeamsFx
@@ -834,6 +833,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
@@ -891,6 +898,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
@@ -1048,7 +1063,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: {
@@ -1102,7 +1117,7 @@ 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
@@ -1376,7 +1391,8 @@ class TeamsBotSsoPrompt extends botbuilderDialogs.Dialog {
         return tslib.__awaiter(this, void 0, void 0, function* () {
             internalLogger.verbose("Send OAuth card to get SSO token");
             const account = yield botbuilder.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 = botbuilder.CardFactory.oauthCard("", "Teams SSO Sign In", "Sign In", signInResource.signInLink, signInResource.tokenExchangeResource);
@@ -1584,19 +1600,17 @@ class BasicAuthProvider {
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
      */
     AddAuthenticationInfo(config) {
-        return tslib.__awaiter(this, void 0, void 0, function* () {
-            if (config.headers && config.headers["Authorization"]) {
-                throw new ErrorWithCode(ErrorMessage.AuthorizationHeaderAlreadyExists, exports.ErrorCode.AuthorizationInfoAlreadyExists);
-            }
-            if (config.auth) {
-                throw new ErrorWithCode(ErrorMessage.BasicCredentialAlreadyExists, exports.ErrorCode.AuthorizationInfoAlreadyExists);
-            }
-            config.auth = {
-                username: this.userName,
-                password: this.password,
-            };
-            return config;
-        });
+        if (config.headers && config.headers["Authorization"]) {
+            return Promise.reject(new ErrorWithCode(ErrorMessage.AuthorizationHeaderAlreadyExists, exports.ErrorCode.AuthorizationInfoAlreadyExists));
+        }
+        if (config.auth) {
+            return Promise.reject(new ErrorWithCode(ErrorMessage.BasicCredentialAlreadyExists, exports.ErrorCode.AuthorizationInfoAlreadyExists));
+        }
+        config.auth = {
+            username: this.userName,
+            password: this.password,
+        };
+        return Promise.resolve(config);
     }
 }
 
@@ -1637,34 +1651,32 @@ class ApiKeyProvider {
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
      */
     AddAuthenticationInfo(config) {
-        return tslib.__awaiter(this, void 0, void 0, function* () {
-            switch (this.keyLocation) {
-                case exports.ApiKeyLocation.Header:
-                    if (!config.headers) {
-                        config.headers = {};
-                    }
-                    if (config.headers[this.keyName]) {
-                        throw new ErrorWithCode(formatString(ErrorMessage.DuplicateApiKeyInHeader, this.keyName), exports.ErrorCode.AuthorizationInfoAlreadyExists);
-                    }
-                    config.headers[this.keyName] = this.keyValue;
-                    break;
-                case exports.ApiKeyLocation.QueryParams:
-                    if (!config.params) {
-                        config.params = {};
-                    }
-                    let urlHasDefinedApiKey = false;
-                    if (config.url) {
-                        const url = new URL(config.url, config.baseURL);
-                        urlHasDefinedApiKey = url.searchParams.has(this.keyName);
-                    }
-                    if (config.params[this.keyName] || urlHasDefinedApiKey) {
-                        throw new ErrorWithCode(formatString(ErrorMessage.DuplicateApiKeyInQueryParam, this.keyName), exports.ErrorCode.AuthorizationInfoAlreadyExists);
-                    }
-                    config.params[this.keyName] = this.keyValue;
-                    break;
-            }
-            return config;
-        });
+        switch (this.keyLocation) {
+            case exports.ApiKeyLocation.Header:
+                if (!config.headers) {
+                    config.headers = {};
+                }
+                if (config.headers[this.keyName]) {
+                    return Promise.reject(new ErrorWithCode(formatString(ErrorMessage.DuplicateApiKeyInHeader, this.keyName), exports.ErrorCode.AuthorizationInfoAlreadyExists));
+                }
+                config.headers[this.keyName] = this.keyValue;
+                break;
+            case exports.ApiKeyLocation.QueryParams:
+                if (!config.params) {
+                    config.params = {};
+                }
+                let urlHasDefinedApiKey = false;
+                if (config.url) {
+                    const url = new URL(config.url, config.baseURL);
+                    urlHasDefinedApiKey = url.searchParams.has(this.keyName);
+                }
+                if (config.params[this.keyName] || urlHasDefinedApiKey) {
+                    return Promise.reject(new ErrorWithCode(formatString(ErrorMessage.DuplicateApiKeyInQueryParam, this.keyName), exports.ErrorCode.AuthorizationInfoAlreadyExists));
+                }
+                config.params[this.keyName] = this.keyValue;
+                break;
+        }
+        return Promise.resolve(config);
     }
 }
 /**
@@ -1712,21 +1724,19 @@ class CertificateAuthProvider {
      * @throws {@link ErrorCode|InvalidParameter} - when custom httpsAgent in the request has duplicate properties with certOption provided in constructor.
      */
     AddAuthenticationInfo(config) {
-        return tslib.__awaiter(this, void 0, void 0, function* () {
-            if (!config.httpsAgent) {
-                config.httpsAgent = new https.Agent(this.certOption);
-            }
-            else {
-                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), exports.ErrorCode.InvalidParameter);
-                    }
+        if (!config.httpsAgent) {
+            config.httpsAgent = new https.Agent(this.certOption);
+        }
+        else {
+            const existingProperties = new Set(Object.keys(config.httpsAgent.options));
+            for (const property of Object.keys(this.certOption)) {
+                if (existingProperties.has(property)) {
+                    return Promise.reject(new ErrorWithCode(formatString(ErrorMessage.DuplicateHttpsOptionProperty, property), exports.ErrorCode.InvalidParameter));
                 }
-                Object.assign(config.httpsAgent.options, this.certOption);
             }
-            return config;
-        });
+            Object.assign(config.httpsAgent.options, this.certOption);
+        }
+        return Promise.resolve(config);
     }
 }
 /**
@@ -1795,6 +1805,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 {
     /**
@@ -2475,6 +2487,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}`;
 }
 /**
@@ -2813,7 +2826,7 @@ class Channel$1 {
         return tslib.__awaiter(this, void 0, void 0, function* () {
             const response = {};
             yield this.parent.adapter.continueConversation(this.parent.conversationReference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
-                const conversation = yield this.newConversation(context);
+                const conversation = this.newConversation(context);
                 yield this.parent.adapter.continueConversation(conversation, (ctx) => tslib.__awaiter(this, void 0, void 0, function* () {
                     try {
                         const res = yield ctx.sendActivity(text);
@@ -2844,7 +2857,7 @@ class Channel$1 {
         return tslib.__awaiter(this, void 0, void 0, function* () {
             const response = {};
             yield this.parent.adapter.continueConversation(this.parent.conversationReference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
-                const conversation = yield this.newConversation(context);
+                const conversation = this.newConversation(context);
                 yield this.parent.adapter.continueConversation(conversation, (ctx) => tslib.__awaiter(this, void 0, void 0, function* () {
                     try {
                         const res = yield ctx.sendActivity({
@@ -2869,12 +2882,10 @@ class Channel$1 {
      * @internal
      */
     newConversation(context) {
-        return tslib.__awaiter(this, void 0, void 0, function* () {
-            const reference = botbuilder.TurnContext.getConversationReference(context.activity);
-            const channelConversation = cloneConversation(reference);
-            channelConversation.conversation.id = this.info.id || "";
-            return channelConversation;
-        });
+        const reference = botbuilder.TurnContext.getConversationReference(context.activity);
+        const channelConversation = cloneConversation(reference);
+        channelConversation.conversation.id = this.info.id || "";
+        return channelConversation;
     }
 }
 /**
@@ -3618,8 +3629,7 @@ class DefaultBotSsoExecutionActivityHandler extends botbuilder.TeamsActivityHand
             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(exports.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;
@@ -3789,9 +3799,12 @@ class ConversationBot$1 {
         // the default error handler
         adapter.onTurnError = (context, error) => tslib.__awaiter(this, void 0, void 0, function* () {
             // 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
-            yield context.sendTraceActivity("OnTurnError Trace", `${error}`, "https://www.botframework.com/schemas/error", "TurnError");
+            yield 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
             yield context.sendActivity(`The bot encountered unhandled error: ${error.message}`);
             yield context.sendActivity("To continue to run this bot, please fix the bot source code.");
@@ -4074,6 +4087,7 @@ function executionWithTokenAndConfig(context, authConfig, initiateLoginEndpoint,
 }
 /**
  * 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.
@@ -4124,7 +4138,7 @@ 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.
@@ -4406,12 +4420,10 @@ class Channel {
      * @internal
      */
     newConversation(context) {
-        return tslib.__awaiter(this, void 0, void 0, function* () {
-            const reference = botbuilder.TurnContext.getConversationReference(context.activity);
-            const channelConversation = cloneConversation(reference);
-            channelConversation.conversation.id = this.info.id || "";
-            return channelConversation;
-        });
+        const reference = botbuilder.TurnContext.getConversationReference(context.activity);
+        const channelConversation = cloneConversation(reference);
+        channelConversation.conversation.id = this.info.id || "";
+        return Promise.resolve(channelConversation);
     }
 }
 /**
@@ -4736,6 +4748,29 @@ 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.
+     */
+    validateInstallation(conversationReference) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            let isValid = true;
+            yield this.adapter.continueConversationAsync(this.botAppId, conversationReference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
+                try {
+                    // try get member to see if the installation is still valid
+                    yield botbuilder.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.
      *
@@ -4747,7 +4782,7 @@ class NotificationBot {
      *
      * @returns An array of {@link TeamsBotInstallation} with paged data and continuation token.
      */
-    getPagedInstallations(pageSize, continuationToken) {
+    getPagedInstallations(pageSize, continuationToken, validationEnabled = true) {
         return tslib.__awaiter(this, void 0, void 0, function* () {
             if (this.conversationReferenceStore === undefined || this.adapter === undefined) {
                 throw new Error("NotificationBot has not been initialized.");
@@ -4756,19 +4791,12 @@ class NotificationBot {
             const targets = [];
             for (const reference of references.data) {
                 // validate connection
-                let valid = true;
-                yield this.adapter.continueConversationAsync(this.botAppId, reference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
-                    try {
-                        // try get member to see if the installation is still valid
-                        yield botbuilder.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 = yield this.validateInstallation(reference);
+                }
+                if (!validationEnabled || (validationEnabled && valid)) {
                     targets.push(new TeamsBotInstallation(this.adapter, reference, this.botAppId));
                 }
                 else {
@@ -5041,9 +5069,9 @@ class ConversationBot {
         // the default error handler
         adapter.onTurnError = (context, error) => tslib.__awaiter(this, void 0, void 0, function* () {
             // 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
-            yield context.sendTraceActivity("OnTurnError Trace", `${error}`, "https://www.botframework.com/schemas/error", "TurnError");
+            yield context.sendTraceActivity("OnTurnError Trace", error instanceof Error ? error.message : error, "https://www.botframework.com/schemas/error", "TurnError");
             // Send a message to the user
             yield context.sendActivity(`The bot encountered unhandled error: ${error.message}`);
             yield context.sendActivity("To continue to run this bot, please fix the bot source code.");