@microsoft/teamsfx 0.7.0-beta.01d6a9fb3.0 → 0.7.0-beta.1

package/README.md

@@ -205,14 +205,13 @@ Use `axios` library to make HTTP request to Azure Function.
 
 ```ts
 const teamsfx = new TeamsFx();
-const token = teamsfx.getCredential().getToken(""); // Get SSO token for the user
+const credential = teamsfx.getCredential();
+// Create an API client that uses SSO token to authenticate requests
+const apiClient = createApiClient(
+  teamsfx.getConfig("apiEndpoint"),
+  new BearerTokenAuthProvider(async ()=> (await credential.getToken(""))!.token));
 // Call API hosted in Azure Functions on behalf of user
-const apiEndpoint = teamsfx.getConfig("apiEndpoint");
-const response = await axios.default.get(apiEndpoint + "api/httptrigger1", {
-  headers: {
-    authorization: "Bearer " + token,
-  },
-});
+const response = await apiClient.get("/api/" + functionName);
 ```
 
 ### Access SQL database in Azure Function
@@ -287,6 +286,27 @@ dialogs.add(
 );
 ```
 
+### Create API client to call existing API in Bot / Azure Function
+
+```ts
+const teamsfx = new TeamsFx();
+
+// Create an API Key auth provider. Following auth providers are also available:
+// BearerTokenAuthProvider, BasicAuthProvider, CertificateAuthProvider
+const authProvider = new ApiKeyProvider("your_api_key_name", 
+  teamsfx.getConfig("YOUR_API_KEY_VALUE"), // This reads the value of YOUR_API_KEY_VALUE environment variable
+  ApiKeyLocation.Header);
+
+// Create an API client using above auth provider
+// You can also implement AuthProvider interface and use it here
+const apiClient = createApiClient(
+  teamsfx.getConfig("YOUR_API_ENDPOINT"), // This reads YOUR_API_ENDPOINT environment variable
+  authProvider);
+
+// Send a GET request to "relative_api_path"
+const response = await apiClient.get("relative_api_path");
+```
+
 ## Advanced Customization
 
 ### Configure log

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';
 import axios from 'axios';
@@ -548,51 +548,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 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));
-                    },
-                });
-            });
-        });
+        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 = 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);
+        }
     }
     /**
      * Get access token from credential.
@@ -725,54 +722,41 @@ 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;
             }
-            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: [],
-                    });
-                });
-            }
-            else {
-                const errorMsg = "Initialize teams sdk failed due to not running inside Teams";
-                internalLogger.error(errorMsg);
-                reject(new ErrorWithCode(errorMsg, ErrorCode.InternalError));
-            }
-        });
+        }
+        const params = {};
+        let token;
+        try {
+            await app.initialize();
+            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;
     }
     /**
      * Load and validate authentication configuration
@@ -1492,7 +1476,7 @@ function sendAdaptiveCard(target, card) {
  */
 class Channel {
     /**
-     * Constuctor.
+     * Constructor.
      *
      * @remarks
      * Only work on server side.
@@ -1557,7 +1541,7 @@ class Channel {
  */
 class Member {
     /**
-     * Constuctor.
+     * Constructor.
      *
      * @remarks
      * Only work on server side.