@microsoft/teamsfx 0.4.2-alpha.f865ef05.0 → 0.5.0-beta.0

package/README.md

@@ -45,7 +45,6 @@ Please note that you need to load configuration before using any credentials.
 loadConfiguration({
   authentication: {
     initiateLoginEndpoint: process.env.REACT_APP_START_LOGIN_PAGE_URL,
-    simpleAuthEndpoint: process.env.REACT_APP_TEAMSFX_ENDPOINT,
     clientId: process.env.REACT_APP_CLIENT_ID,
   },
 });
@@ -67,7 +66,6 @@ Use the snippet below:
 loadConfiguration({
   authentication: {
     initiateLoginEndpoint: process.env.REACT_APP_START_LOGIN_PAGE_URL,
-    simpleAuthEndpoint: process.env.REACT_APP_TEAMSFX_ENDPOINT,
     clientId: process.env.REACT_APP_CLIENT_ID,
   },
 });
@@ -165,7 +163,6 @@ Use `TeamsUserCredential` and `createMicrosoftGraphClient`.
 loadConfiguration({
   authentication: {
     initiateLoginEndpoint: process.env.REACT_APP_START_LOGIN_PAGE_URL,
-    simpleAuthEndpoint: process.env.REACT_APP_TEAMSFX_ENDPOINT,
     clientId: process.env.REACT_APP_CLIENT_ID,
   },
 });
@@ -182,7 +179,6 @@ Use `axios` library to make HTTP request to Azure Function.
 loadConfiguration({
   authentication: {
     initiateLoginEndpoint: process.env.REACT_APP_START_LOGIN_PAGE_URL,
-    simpleAuthEndpoint: process.env.REACT_APP_TEAMSFX_ENDPOINT,
     clientId: process.env.REACT_APP_CLIENT_ID,
   },
 });
@@ -205,7 +201,10 @@ Apart from `tedious`, you can also compose connection config of other SQL librar
 ```ts
 loadConfiguration();
 const sqlConnectConfig = new DefaultTediousConnectionConfiguration();
+// if there's only one SQL database
 const config = await sqlConnectConfig.getConfig();
+// if there are multiple SQL databases
+const config2 = await sqlConnectionConfig.getConfig("your database name");
 const connection = new Connection(config);
 connection.on("connect", (error) => {
   if (error) {

package/dist/index.esm2017.js

@@ -1,5 +1,5 @@
 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';
 
@@ -55,6 +55,10 @@ var ErrorCode;
      * Operation failed.
      */
     ErrorCode["FailedOperation"] = "FailedOperation";
+    /**
+     * Invalid response error.
+     */
+    ErrorCode["InvalidResponse"] = "InvalidResponse";
 })(ErrorCode || (ErrorCode = {}));
 /**
  * @internal
@@ -600,7 +604,6 @@ class OnBehalfOfUserCredential {
 
 // Copyright (c) Microsoft Corporation.
 const tokenRefreshTimeSpanInMillisecond = 5 * 60 * 1000;
-const initializeTeamsSdkTimeoutInMillisecond = 5000;
 const loginPageWidth = 600;
 const loginPageHeight = 535;
 /**
@@ -668,45 +671,48 @@ class TeamsUserCredential {
         if (!this.initialized) {
             await this.init();
         }
-        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: async (result) => {
-                        if (!result) {
-                            const errorMsg = "Get empty authentication result from MSAL";
-                            internalLogger.error(errorMsg);
-                            reject(new ErrorWithCode(errorMsg, ErrorCode.InternalError));
-                            return;
-                        }
-                        let resultJson = {};
-                        try {
-                            resultJson = JSON.parse(result);
-                        }
-                        catch (error) {
-                            // If can not parse result as Json, will NOT throw error since user may return other info in auth-end page.
-                            // TODO: resolve the result.
-                            const failedToParseResult = "Failed to parse result to Json.";
-                            internalLogger.verbose(failedToParseResult);
-                            resolve();
-                            return;
-                        }
-                        // 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));
-                    },
-                });
-            });
-        });
+        await 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 = await 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 = JSON.parse(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);
+        }
     }
     /**
      * Get access token from credential.
@@ -839,57 +845,47 @@ class TeamsUserCredential {
      * It will try to get SSO token from memory first, if SSO token doesn't exist or about to expired, then it will using teams SDK to get SSO token
      * @returns SSO token
      */
-    getSSOToken() {
-        return new Promise((resolve, reject) => {
-            if (this.ssoToken) {
-                if (this.ssoToken.expiresOnTimestamp - Date.now() > tokenRefreshTimeSpanInMillisecond) {
-                    internalLogger.verbose("Get SSO token from memory cache");
-                    resolve(this.ssoToken);
-                    return;
-                }
+    async getSSOToken() {
+        if (this.ssoToken) {
+            if (this.ssoToken.expiresOnTimestamp - Date.now() > tokenRefreshTimeSpanInMillisecond) {
+                internalLogger.verbose("Get SSO token from memory cache");
+                return this.ssoToken;
             }
-            let initialized = false;
-            microsoftTeams.initialize(() => {
-                initialized = true;
-                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: [],
-                });
-            });
-            // If the code not running in Teams, the initialize callback function would never trigger
-            setTimeout(() => {
-                if (!initialized) {
-                    const errorMsg = "Initialize teams sdk timeout, maybe the code is not running inside Teams";
-                    internalLogger.error(errorMsg);
-                    reject(new ErrorWithCode(errorMsg, ErrorCode.InternalError));
-                }
-            }, initializeTeamsSdkTimeoutInMillisecond);
-        });
+        }
+        if (this.checkInTeams()) {
+            const params = {};
+            let token;
+            try {
+                token = await authentication.getAuthToken(params);
+            }
+            catch (err) {
+                const errorMsg = "Get SSO token failed with error: " + err.message;
+                internalLogger.error(errorMsg);
+                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;
+        }
+        else {
+            const errorMsg = "Initialize teams sdk failed due to not running inside Teams";
+            internalLogger.error(errorMsg);
+            throw new ErrorWithCode(errorMsg, ErrorCode.InternalError);
+        }
     }
     /**
      * Load and validate authentication configuration
@@ -916,11 +912,11 @@ class TeamsUserCredential {
         internalLogger.error(errorMsg);
         throw new ErrorWithCode(errorMsg, ErrorCode.InvalidConfiguration);
     }
-    setSessionStorage(sessonStorageValues) {
+    setSessionStorage(sessionStorageValues) {
         try {
-            const sessionStorageKeys = Object.keys(sessonStorageValues);
+            const sessionStorageKeys = Object.keys(sessionStorageValues);
             sessionStorageKeys.forEach((key) => {
-                sessionStorage.setItem(key, sessonStorageValues[key]);
+                sessionStorage.setItem(key, sessionStorageValues[key]);
             });
         }
         catch (error) {
@@ -931,6 +927,16 @@ 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.
@@ -1072,7 +1078,7 @@ class DefaultTediousConnectionConfiguration {
      * Only works in in server side.
      * @beta
      */
-    async getConfig() {
+    async getConfig(databaseName) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "DefaultTediousConnectionConfiguration"), ErrorCode.RuntimeNotSupported);
     }
 }