@microsoft/teamsfx 0.6.3-alpha.ffd3f8bc7.0 → 0.7.0-beta.0

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';
@@ -95,6 +95,8 @@ ErrorMessage.BasicCredentialAlreadyExists = "Basic credential already exists!";
 // InvalidParameter Error
 ErrorMessage.EmptyParameter = "Parameter {0} is empty";
 ErrorMessage.DuplicateHttpsOptionProperty = "Axios HTTPS agent already defined value for property {0}";
+ErrorMessage.DuplicateApiKeyInHeader = "The request already defined api key in request header with name {0}.";
+ErrorMessage.DuplicateApiKeyInQueryParam = "The request already defined api key in query parameter with name {0}.";
 /**
  * Error class with code and message thrown by the SDK.
  *
@@ -546,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 = 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.
@@ -723,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;
-                }
-            }
-            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));
+    async getSSOToken() {
+        if (this.ssoToken) {
+            if (this.ssoToken.expiresOnTimestamp - Date.now() > tokenRefreshTimeSpanInMillisecond) {
+                internalLogger.verbose("Get SSO token from memory cache");
+                return this.ssoToken;
             }
-        });
+        }
+        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
@@ -1099,7 +1085,7 @@ function createApiClient(apiEndpoint, authProvider) {
  */
 class BearerTokenAuthProvider {
     /**
-     * @param getToken Function that returns the content of bearer token used in http request
+     * @param { () => Promise<string> } getToken - Function that returns the content of bearer token used in http request
      *
      * @beta
      */
@@ -1109,7 +1095,7 @@ class BearerTokenAuthProvider {
     /**
      * Adds authentication info to http requests
      *
-     * @param config - Contains all the request information and can be updated to include extra authentication info.
+     * @param { AxiosRequestConfig } config - Contains all the request information and can be updated to include extra authentication info.
      * Refer https://axios-http.com/docs/req_config for detailed document.
      *
      * @returns Updated axios request config.
@@ -1140,48 +1126,90 @@ class BearerTokenAuthProvider {
 class BasicAuthProvider {
     /**
      *
-     * @param userName - Username used in basic auth
-     * @param password - Password used in basic auth
+     * @param { string } userName - Username used in basic auth
+     * @param { string } password - Password used in basic auth
+     *
+     * @throws {@link ErrorCode|InvalidParameter} - when username or password is empty.
+     * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
      *
      * @beta
      */
     constructor(userName, password) {
-        if (!userName) {
-            throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "username"), ErrorCode.InvalidParameter);
-        }
-        if (!password) {
-            throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "password"), ErrorCode.InvalidParameter);
-        }
-        this.userName = userName;
-        this.password = password;
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "BasicAuthProvider"), ErrorCode.RuntimeNotSupported);
     }
     /**
      * Adds authentication info to http requests
      *
-     * @param config - Contains all the request information and can be updated to include extra authentication info.
+     * @param { AxiosRequestConfig } config - Contains all the request information and can be updated to include extra authentication info.
      * Refer https://axios-http.com/docs/req_config for detailed document.
      *
      * @returns Updated axios request config.
      *
      * @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when Authorization header or auth property already exists in request configuration.
+     * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
      *
      * @beta
      */
     async AddAuthenticationInfo(config) {
-        if (config.headers && config.headers["Authorization"]) {
-            throw new ErrorWithCode(ErrorMessage.AuthorizationHeaderAlreadyExists, ErrorCode.AuthorizationInfoAlreadyExists);
-        }
-        if (config.auth) {
-            throw new ErrorWithCode(ErrorMessage.BasicCredentialAlreadyExists, ErrorCode.AuthorizationInfoAlreadyExists);
-        }
-        config.auth = {
-            username: this.userName,
-            password: this.password,
-        };
-        return config;
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "BasicAuthProvider"), ErrorCode.RuntimeNotSupported);
     }
 }
 
+// Copyright (c) Microsoft Corporation.
+/**
+ * Provider that handles API Key authentication
+ *
+ * @beta
+ */
+class ApiKeyProvider {
+    /**
+     *
+     * @param { string } keyName - The name of request header or query parameter that specifies API Key
+     * @param { string } keyValue - The value of API Key
+     * @param { ApiKeyLocation } keyLocation - The location of API Key: request header or query parameter.
+     *
+     * @throws {@link ErrorCode|InvalidParameter} - when key name or key value is empty.
+     * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
+     *
+     * @beta
+     */
+    constructor(keyName, keyValue, keyLocation) {
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "ApiKeyProvider"), ErrorCode.RuntimeNotSupported);
+    }
+    /**
+     * Adds authentication info to http requests
+     *
+     * @param { AxiosRequestConfig } config - Contains all the request information and can be updated to include extra authentication info.
+     * Refer https://axios-http.com/docs/req_config for detailed document.
+     *
+     * @returns Updated axios request config.
+     *
+     * @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when API key already exists in request header or url query parameter.
+     * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
+     *
+     * @beta
+     */
+    async AddAuthenticationInfo(config) {
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "ApiKeyProvider"), ErrorCode.RuntimeNotSupported);
+    }
+}
+/**
+ * Define available location for API Key location
+ *
+ * @beta
+ */
+var ApiKeyLocation;
+(function (ApiKeyLocation) {
+    /**
+     * The API Key is placed in request header
+     */
+    ApiKeyLocation[ApiKeyLocation["Header"] = 0] = "Header";
+    /**
+     * The API Key is placed in query parameter
+     */
+    ApiKeyLocation[ApiKeyLocation["QueryParams"] = 1] = "QueryParams";
+})(ApiKeyLocation || (ApiKeyLocation = {}));
+
 // Copyright (c) Microsoft Corporation.
 /**
  * Provider that handles Certificate authentication
@@ -1207,6 +1235,7 @@ class CertificateAuthProvider {
      * @returns Updated axios request config.
      *
      * @throws {@link ErrorCode|InvalidParameter} - when custom httpsAgent in the request has duplicate properties with certOption provided in constructor.
+     * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
      *
      * @beta
      */
@@ -1219,29 +1248,30 @@ class CertificateAuthProvider {
  *
  * @param { string | Buffer } cert - The cert chain in PEM format
  * @param { string | Buffer } key - The private key for the cert chain
- * @param { string? } passphrase - The passphrase for private key
- * @param { string? | Buffer? } ca - Overrides the trusted CA certificates
+ * @param { {passphrase?: string; ca?: string | Buffer} } options - Optional settings when create the cert options.
  *
  * @returns Instance of SecureContextOptions
  *
  * @throws {@link ErrorCode|InvalidParameter} - when any parameter is empty
+ * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
  *
  */
-function createPemCertOption(cert, key, passphrase, ca) {
+function createPemCertOption(cert, key, options) {
     throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "createPemCertOption"), ErrorCode.RuntimeNotSupported);
 }
 /**
  * Helper to create SecureContextOptions from PFX format cert
  *
  * @param { string | Buffer } pfx - The content of .pfx file
- * @param { string? } passphrase - Optional. The passphrase of .pfx file
+ * @param { {passphrase?: string} } options - Optional settings when create the cert options.
  *
  * @returns Instance of SecureContextOptions
  *
  * @throws {@link ErrorCode|InvalidParameter} - when any parameter is empty
+ * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
  *
  */
-function createPfxCertOption(pfx, passphrase) {
+function createPfxCertOption(pfx, options) {
     throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "createPfxCertOption"), ErrorCode.RuntimeNotSupported);
 }
 
@@ -1759,5 +1789,5 @@ class CommandBot {
     }
 }
 
-export { AppCredential, BasicAuthProvider, BearerTokenAuthProvider, CertificateAuthProvider, Channel, CommandBot, ConversationBot, ErrorCode, ErrorWithCode, IdentityType, LogLevel, Member, MsGraphAuthProvider, NotificationBot, OnBehalfOfUserCredential, TeamsBotInstallation, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createApiClient, createMicrosoftGraphClient, createPemCertOption, createPfxCertOption, getLogLevel, getTediousConnectionConfig, sendAdaptiveCard, sendMessage, setLogFunction, setLogLevel, setLogger };
+export { ApiKeyLocation, ApiKeyProvider, AppCredential, BasicAuthProvider, BearerTokenAuthProvider, CertificateAuthProvider, Channel, CommandBot, ConversationBot, ErrorCode, ErrorWithCode, IdentityType, LogLevel, Member, MsGraphAuthProvider, NotificationBot, OnBehalfOfUserCredential, TeamsBotInstallation, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createApiClient, createMicrosoftGraphClient, createPemCertOption, createPfxCertOption, getLogLevel, getTediousConnectionConfig, sendAdaptiveCard, sendMessage, setLogFunction, setLogLevel, setLogger };
 //# sourceMappingURL=index.esm2017.js.map