@microsoft/teamsfx 1.2.1 → 2.0.0-alpha.28543dcd0.0

package/dist/index.esm5.js

@@ -1,6 +1,6 @@
 import { __awaiter } from 'tslib';
 import jwt_decode from 'jwt-decode';
-import * as microsoftTeams from '@microsoft/teams-js';
+import { app, authentication } from '@microsoft/teams-js';
 import { PublicClientApplication } from '@azure/msal-browser';
 import { Client } from '@microsoft/microsoft-graph-client';
 import axios from 'axios';
@@ -433,12 +433,6 @@ function validateScopesType(value) {
  * Only works in in server side.
  */
 class AppCredential {
-    /**
-     * Constructor of AppCredential.
-     *
-     * @remarks
-     * Only works in in server side.
-     */
     constructor(authConfig) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "AppCredential"), ErrorCode.RuntimeNotSupported);
     }
@@ -463,12 +457,6 @@ class AppCredential {
  * Can only be used in server side.
  */
 class OnBehalfOfUserCredential {
-    /**
-     * Constructor of OnBehalfOfUserCredential
-     *
-     * @remarks
-     * Can Only works in in server side.
-     */
     constructor(ssoToken, config) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "OnBehalfOfUserCredential"), ErrorCode.RuntimeNotSupported);
     }
@@ -503,28 +491,6 @@ const loginPageHeight = 535;
  * Can only be used within Teams.
  */
 class TeamsUserCredential {
-    /**
-     * Constructor of TeamsUserCredential.
-     *
-     * @example
-     * ```typescript
-     * const config = {
-     *  authentication: {
-     *    initiateLoginEndpoint: "https://localhost:3000/auth-start.html",
-     *    clientId: "xxx"
-     *   }
-     * }
-     * // Use default configuration provided by Teams Toolkit
-     * const credential = new TeamsUserCredential();
-     * // Use a customized configuration
-     * const anotherCredential = new TeamsUserCredential(config);
-     * ```
-     *
-     * @param {AuthenticationConfiguration} authConfig - The authentication configuration. Use environment variables if not provided.
-     *
-     * @throws {@link ErrorCode|InvalidConfiguration} when client id, initiate login endpoint or simple auth endpoint is not found in config.
-     * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is nodeJS.
-     */
     constructor(authConfig) {
         internalLogger.info("Create teams user credential");
         this.config = this.loadAndValidateConfig(authConfig);
@@ -560,51 +526,48 @@ class TeamsUserCredential {
             if (!this.initialized) {
                 yield this.init(resources);
             }
-            return new Promise((resolve, reject) => {
-                microsoftTeams.initialize(() => {
-                    microsoftTeams.authentication.authenticate({
-                        url: `${this.config.initiateLoginEndpoint}?clientId=${this.config.clientId}&scope=${encodeURI(scopesStr)}&loginHint=${this.loginHint}`,
-                        width: loginPageWidth,
-                        height: loginPageHeight,
-                        successCallback: (result) => __awaiter(this, void 0, void 0, function* () {
-                            if (!result) {
-                                const errorMsg = "Get empty authentication result from MSAL";
-                                internalLogger.error(errorMsg);
-                                reject(new ErrorWithCode(errorMsg, ErrorCode.InternalError));
-                                return;
-                            }
-                            let resultJson = {};
-                            try {
-                                resultJson = typeof result == "string" ? JSON.parse(result) : result;
-                            }
-                            catch (error) {
-                                // If can not parse result as Json, will throw error.
-                                const failedToParseResult = "Failed to parse response to Json.";
-                                internalLogger.error(failedToParseResult);
-                                reject(new ErrorWithCode(failedToParseResult, ErrorCode.InvalidResponse));
-                            }
-                            // If code exists in result, user may using previous auth-start and auth-end page.
-                            if (resultJson.code) {
-                                const helpLink = "https://aka.ms/teamsfx-auth-code-flow";
-                                const usingPreviousAuthPage = "Found auth code in response. Auth code is not support for current version of SDK. " +
-                                    `Please refer to the help link for how to fix the issue: ${helpLink}.`;
-                                internalLogger.error(usingPreviousAuthPage);
-                                reject(new ErrorWithCode(usingPreviousAuthPage, ErrorCode.InvalidResponse));
-                            }
-                            // If sessionStorage exists in result, set the values in current session storage.
-                            if (resultJson.sessionStorage) {
-                                this.setSessionStorage(resultJson.sessionStorage);
-                            }
-                            resolve();
-                        }),
-                        failureCallback: (reason) => {
-                            const errorMsg = `Consent failed for the scope ${scopesStr} with error: ${reason}`;
-                            internalLogger.error(errorMsg);
-                            reject(new ErrorWithCode(errorMsg, ErrorCode.ConsentFailed));
-                        },
-                    });
-                });
-            });
+            yield app.initialize();
+            let result;
+            try {
+                const params = {
+                    url: `${this.config.initiateLoginEndpoint}?clientId=${this.config.clientId}&scope=${encodeURI(scopesStr)}&loginHint=${this.loginHint}`,
+                    width: loginPageWidth,
+                    height: loginPageHeight,
+                };
+                result = yield authentication.authenticate(params);
+                if (!result) {
+                    const errorMsg = "Get empty authentication result from MSAL";
+                    internalLogger.error(errorMsg);
+                    throw new ErrorWithCode(errorMsg, ErrorCode.InternalError);
+                }
+            }
+            catch (err) {
+                const errorMsg = `Consent failed for the scope ${scopesStr} with error: ${err.message}`;
+                internalLogger.error(errorMsg);
+                throw new ErrorWithCode(errorMsg, ErrorCode.ConsentFailed);
+            }
+            let resultJson = {};
+            try {
+                resultJson = typeof result == "string" ? JSON.parse(result) : result;
+            }
+            catch (error) {
+                // If can not parse result as Json, will throw error.
+                const failedToParseResult = "Failed to parse response to Json.";
+                internalLogger.error(failedToParseResult);
+                throw new ErrorWithCode(failedToParseResult, ErrorCode.InvalidResponse);
+            }
+            // If code exists in result, user may using previous auth-start and auth-end page.
+            if (resultJson.code) {
+                const helpLink = "https://aka.ms/teamsfx-auth-code-flow";
+                const usingPreviousAuthPage = "Found auth code in response. Auth code is not support for current version of SDK. " +
+                    `Please refer to the help link for how to fix the issue: ${helpLink}.`;
+                internalLogger.error(usingPreviousAuthPage);
+                throw new ErrorWithCode(usingPreviousAuthPage, ErrorCode.InvalidResponse);
+            }
+            // If sessionStorage exists in result, set the values in current session storage.
+            if (resultJson.sessionStorage) {
+                this.setSessionStorage(resultJson.sessionStorage);
+            }
         });
     }
     /**
@@ -754,52 +717,48 @@ class TeamsUserCredential {
      * @returns SSO token
      */
     getSSOToken(resources) {
-        return new Promise((resolve, reject) => {
+        return __awaiter(this, void 0, void 0, function* () {
             if (this.ssoToken) {
                 if (this.ssoToken.expiresOnTimestamp - Date.now() > tokenRefreshTimeSpanInMillisecond) {
                     internalLogger.verbose("Get SSO token from memory cache");
-                    resolve(this.ssoToken);
-                    return;
+                    return this.ssoToken;
                 }
             }
-            if (this.checkInTeams()) {
-                microsoftTeams.initialize(() => {
-                    microsoftTeams.authentication.getAuthToken({
-                        successCallback: (token) => {
-                            if (!token) {
-                                const errorMsg = "Get empty SSO token from Teams";
-                                internalLogger.error(errorMsg);
-                                reject(new ErrorWithCode(errorMsg, ErrorCode.InternalError));
-                                return;
-                            }
-                            const tokenObject = parseJwt(token);
-                            if (tokenObject.ver !== "1.0" && tokenObject.ver !== "2.0") {
-                                const errorMsg = "SSO token is not valid with an unknown version: " + tokenObject.ver;
-                                internalLogger.error(errorMsg);
-                                reject(new ErrorWithCode(errorMsg, ErrorCode.InternalError));
-                                return;
-                            }
-                            const ssoToken = {
-                                token,
-                                expiresOnTimestamp: tokenObject.exp * 1000,
-                            };
-                            this.ssoToken = ssoToken;
-                            resolve(ssoToken);
-                        },
-                        failureCallback: (errMessage) => {
-                            const errorMsg = "Get SSO token failed with error: " + errMessage;
-                            internalLogger.error(errorMsg);
-                            reject(new ErrorWithCode(errorMsg, ErrorCode.InternalError));
-                        },
-                        resources: resources !== null && resources !== void 0 ? resources : [],
-                    });
-                });
+            const params = { resources: resources !== null && resources !== void 0 ? resources : [] };
+            let token;
+            try {
+                yield app.initialize();
             }
-            else {
-                const errorMsg = "Initialize teams sdk failed due to not running inside Teams";
+            catch (err) {
+                const errorMsg = "Initialize teams sdk failed due to not running inside Teams environment";
+                internalLogger.error(errorMsg);
+                throw new ErrorWithCode(errorMsg, ErrorCode.InternalError);
+            }
+            try {
+                token = yield authentication.getAuthToken(params);
+            }
+            catch (err) {
+                const errorMsg = "Get SSO token failed with error: " + err.message;
                 internalLogger.error(errorMsg);
-                reject(new ErrorWithCode(errorMsg, ErrorCode.InternalError));
+                throw new ErrorWithCode(errorMsg, ErrorCode.InternalError);
             }
+            if (!token) {
+                const errorMsg = "Get empty SSO token from Teams";
+                internalLogger.error(errorMsg);
+                throw new ErrorWithCode(errorMsg, ErrorCode.InternalError);
+            }
+            const tokenObject = parseJwt(token);
+            if (tokenObject.ver !== "1.0" && tokenObject.ver !== "2.0") {
+                const errorMsg = "SSO token is not valid with an unknown version: " + tokenObject.ver;
+                internalLogger.error(errorMsg);
+                throw new ErrorWithCode(errorMsg, ErrorCode.InternalError);
+            }
+            const ssoToken = {
+                token,
+                expiresOnTimestamp: tokenObject.exp * 1000,
+            };
+            this.ssoToken = ssoToken;
+            return ssoToken;
         });
     }
     /**
@@ -840,16 +799,6 @@ class TeamsUserCredential {
             throw new ErrorWithCode(errorMessage, ErrorCode.InternalError);
         }
     }
-    // Come from here: https://github.com/wictorwilen/msteams-react-base-component/blob/master/src/useTeams.ts
-    checkInTeams() {
-        if ((window.parent === window.self && window.nativeInterface) ||
-            window.navigator.userAgent.includes("Teams/") ||
-            window.name === "embedded-page-container" ||
-            window.name === "extension-tab-frame") {
-            return true;
-        }
-        return false;
-    }
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -858,18 +807,8 @@ const defaultScope = "https://graph.microsoft.com/.default";
  * Microsoft Graph auth provider for Teams Framework
  */
 class MsGraphAuthProvider {
-    /**
-     * Constructor of MsGraphAuthProvider.
-     *
-     * @param {TeamsFx} teamsfx - Used to provide configuration and auth.
-     * @param {string | string[]} scopes - The list of scopes for which the token will have access.
-     *
-     * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
-     *
-     * @returns An instance of MsGraphAuthProvider.
-     */
-    constructor(teamsfx, scopes) {
-        this.teamsfx = teamsfx;
+    constructor(credentialOrTeamsFx, scopes) {
+        this.credentialOrTeamsFx = credentialOrTeamsFx;
         let scopesStr = defaultScope;
         if (scopes) {
             validateScopesType(scopes);
@@ -896,7 +835,15 @@ class MsGraphAuthProvider {
     getAccessToken() {
         return __awaiter(this, void 0, void 0, function* () {
             internalLogger.info(`Get Graph Access token with scopes: '${this.scopes}'`);
-            const accessToken = yield this.teamsfx.getCredential().getToken(this.scopes);
+            let accessToken;
+            if (this.credentialOrTeamsFx.getCredential) {
+                accessToken = yield this.credentialOrTeamsFx
+                    .getCredential()
+                    .getToken(this.scopes);
+            }
+            else {
+                accessToken = yield this.credentialOrTeamsFx.getToken(this.scopes);
+            }
             return new Promise((resolve, reject) => {
                 if (accessToken) {
                     resolve(accessToken.token);
@@ -914,7 +861,6 @@ class MsGraphAuthProvider {
 // Copyright (c) Microsoft Corporation.
 /**
  * Get Microsoft graph client.
- *
  * @example
  * Get Microsoft graph client by TokenCredential
  * ```typescript
@@ -968,11 +914,74 @@ function createMicrosoftGraphClient(teamsfx, scopes) {
         authProvider,
     });
     return graphClient;
+}
+// eslint-disable-next-line no-secrets/no-secrets
+/**
+ * Get Microsoft graph client.
+ * @example
+ * Get Microsoft graph client by TokenCredential
+ * ```typescript
+ * // In browser: TeamsUserCredential
+ * const authConfig: TeamsUserCredentialAuthConfig = {
+ *   clientId: "xxx",
+    initiateLoginEndpoint: "https://xxx/auth-start.html",
+ * };
+
+ * const credential = new TeamsUserCredential(authConfig);
+
+ * const scope = "User.Read";
+ * await credential.login(scope);
+
+ * const client = createMicrosoftGraphClientWithCredential(credential, scope);
+
+ * // In node: OnBehalfOfUserCredential
+ * const oboAuthConfig: OnBehalfOfCredentialAuthConfig = {
+ *   authorityHost: "xxx",
+ *   clientId: "xxx",
+ *   tenantId: "xxx",
+ *   clientSecret: "xxx",
+ * };
+
+ * const oboCredential = new OnBehalfOfUserCredential(ssoToken, oboAuthConfig);
+ * const scope = "User.Read";
+ * const client = createMicrosoftGraphClientWithCredential(oboCredential, scope);
+
+ * // In node: AppCredential
+ * const appAuthConfig: AppCredentialAuthConfig = {
+ *   authorityHost: "xxx",
+ *   clientId: "xxx",
+ *   tenantId: "xxx",
+ *   clientSecret: "xxx",
+ * };
+ * const appCredential = new AppCredential(appAuthConfig);
+ * const scope = "User.Read";
+ * const client = createMicrosoftGraphClientWithCredential(appCredential, scope);
+ *
+ * const profile = await client.api("/me").get();
+ * ```
+ *
+ * @param {TokenCredential} credential - Used to provide configuration and auth.
+ * @param scopes - The array of Microsoft Token scope of access. Default value is `[.default]`.
+ *
+ * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
+ *
+ * @returns Graph client with specified scopes.
+ */
+function createMicrosoftGraphClientWithCredential(credential, scopes) {
+    internalLogger.info("Create Microsoft Graph Client");
+    const authProvider = new MsGraphAuthProvider(credential, scopes);
+    const graphClient = Client.initWithMiddleware({
+        authProvider,
+    });
+    return graphClient;
 }
 
 // Copyright (c) Microsoft Corporation.
 /**
  * Generate connection configuration consumed by tedious.
+ *
+ * @deprecated we recommend you compose your own Tedious configuration for better flexibility.
+ *
  * @remarks
  * Only works in in server side.
  */
@@ -1514,13 +1523,7 @@ class ConversationBot {
  * Sso execution dialog, use to handle sso command
  */
 class BotSsoExecutionDialog {
-    /**
-     * Creates a new instance of the BotSsoExecutionDialog.
-     * @param dedupStorage Helper storage to remove duplicated messages
-     * @param requiredScopes The list of scopes for which the token will have access
-     * @param teamsfx {@link TeamsFx} instance for authentication
-     */
-    constructor(dedupStorage, requiredScopes, teamsfx) {
+    constructor(dedupStorage, ssoPromptSettings, authConfig, ...args) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "BotSsoExecutionDialog"), ErrorCode.RuntimeNotSupported);
     }
     /**
@@ -2041,7 +2044,17 @@ function handleMessageExtensionQueryWithToken(context, config, scopes, logic) {
     return __awaiter(this, void 0, void 0, function* () {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "queryWithToken in message extension"), ErrorCode.RuntimeNotSupported);
     });
+}
+/**
+ * Users execute query with SSO or Access Token.
+ * @remarks
+ * Only works in in server side.
+ */
+function handleMessageExtensionQueryWithSSO(context, config, initiateLoginEndpoint, scopes, logic) {
+    return __awaiter(this, void 0, void 0, function* () {
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "queryWithToken in message extension"), ErrorCode.RuntimeNotSupported);
+    });
 }
 
-export { AdaptiveCardResponse, ApiKeyLocation, ApiKeyProvider, AppCredential, BasicAuthProvider, BearerTokenAuthProvider, BotSsoExecutionDialog, CardActionBot, CertificateAuthProvider, Channel, CommandBot, ConversationBot, ErrorCode, ErrorWithCode, IdentityType, InvokeResponseErrorCode, LogLevel, Member, MsGraphAuthProvider, NotificationBot, NotificationTargetType, OnBehalfOfUserCredential, TeamsBotInstallation, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createApiClient, createMicrosoftGraphClient, createPemCertOption, createPfxCertOption, getLogLevel, getTediousConnectionConfig, handleMessageExtensionQueryWithToken, sendAdaptiveCard, sendMessage, setLogFunction, setLogLevel, setLogger };
+export { AdaptiveCardResponse, ApiKeyLocation, ApiKeyProvider, AppCredential, BasicAuthProvider, BearerTokenAuthProvider, BotSsoExecutionDialog, CardActionBot, CertificateAuthProvider, Channel, CommandBot, ConversationBot, ErrorCode, ErrorWithCode, IdentityType, InvokeResponseErrorCode, LogLevel, Member, MsGraphAuthProvider, NotificationBot, NotificationTargetType, OnBehalfOfUserCredential, TeamsBotInstallation, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createApiClient, createMicrosoftGraphClient, createMicrosoftGraphClientWithCredential, createPemCertOption, createPfxCertOption, getLogLevel, getTediousConnectionConfig, handleMessageExtensionQueryWithSSO, handleMessageExtensionQueryWithToken, sendAdaptiveCard, sendMessage, setLogFunction, setLogLevel, setLogger };
 //# sourceMappingURL=index.esm5.js.map