@microsoft/teamsfx 2.2.3-alpha.0c7c513de.0 → 2.2.3-alpha.13d1e618d.0

package/README.md

@@ -535,13 +535,12 @@ You can pass custom config when creating `TeamsFx` instance to override default
 
 If you are using the version of SDK that has `loadConfiguration()`, you can follow these steps to upgrade to the latest SDK version.
 
-1. Remove `loadConfiguration()` and pass customized settings using `new TeamsFx(IdentityType.User, { ...customConfig })`.
-2. Replace `new TeamsUserCredential()` with `new TeamsFx()`.
-3. Replace `new M365TenantCredential()` with `new TeamsFx(IdentityType.App)`.
-4. Replace `new OnBehalfOfUserCredential(ssoToken)` with `new TeamsFx().setSsoToken(ssoToken)`.
-5. Pass the instance of `TeamsFx` to helper functions to replace credential instance.
+1. Instead of calling `loadConfiguration()`, use the specific auth config classes to customize the settings for each credential type. For example, use `AppCredentialAuthConfig` for `AppCredential`, `OnBehalfOfUserCredentialAuthConfig` for `OnBehalfOfUserCredential`, and `TeamsUserCredentialAuthConfig` for `TeamsUserCredential`.
+2. Replace `new TeamsUserCredential()` with `new TeamsUserCredential(authConfig)`.
+3. Replace `new M365TenantCredential()` with `new AppCredential(authConfig)`.
+4. Replace `new OnBehalfOfUserCredential(ssoToken)` with `new OnBehalfOfUserCredential(authConfig)`.
 
-Also see [TeamsFx class](#teamsfx-class) for furthur description.
+Also see [Credential](#Credential) for furthur description.
 
 ## How to use SDK implemented with `CloudAdapter`
 

package/dist/index.esm2017.js

@@ -864,7 +864,7 @@ class MsGraphAuthProvider {
  * };
  * const prompt = new TeamsBotSsoPrompt(dialogId, {
  *    config: config
- *    scopes: '["User.Read"],
+ *    scopes: ["User.Read"],
  * });
  * this.addDialog(prompt);
  *
@@ -1159,8 +1159,8 @@ class BasicAuthProvider {
      * @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when Authorization header or auth property already exists in request configuration.
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
      */
-    async AddAuthenticationInfo(config) {
-        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "BasicAuthProvider"), ErrorCode.RuntimeNotSupported);
+    AddAuthenticationInfo(config) {
+        return Promise.reject(new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "BasicAuthProvider"), ErrorCode.RuntimeNotSupported));
     }
 }
 
@@ -1192,8 +1192,8 @@ class ApiKeyProvider {
      * @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when API key already exists in request header or url query parameter.
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
      */
-    async AddAuthenticationInfo(config) {
-        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "ApiKeyProvider"), ErrorCode.RuntimeNotSupported);
+    AddAuthenticationInfo(config) {
+        return Promise.reject(new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "ApiKeyProvider"), ErrorCode.RuntimeNotSupported));
     }
 }
 /**
@@ -1234,8 +1234,8 @@ class CertificateAuthProvider {
      * @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.
      */
-    async AddAuthenticationInfo(config) {
-        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "CertificateAuthProvider"), ErrorCode.RuntimeNotSupported);
+    AddAuthenticationInfo(config) {
+        return Promise.reject(new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "CertificateAuthProvider"), ErrorCode.RuntimeNotSupported));
     }
 }
 /**
@@ -1477,7 +1477,7 @@ class ConversationBot$1 {
      * @remarks
      * Only work on server side.
      */
-    async requestHandler(req, res, logic) {
+    requestHandler(req, res, logic) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "ConversationBot"), ErrorCode.RuntimeNotSupported);
     }
 }
@@ -1599,7 +1599,7 @@ class Channel$1 {
      * @param onError - an optional error handler that can catch exceptions during adaptive card sending.
      * @returns the response of sending adaptive card message.
      */
-    async sendAdaptiveCard(card, onError) {
+    sendAdaptiveCard(card, onError) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "Channel"), ErrorCode.RuntimeNotSupported);
     }
 }
@@ -1656,7 +1656,7 @@ class Member$1 {
      * @param onError - an optional error handler that can catch exceptions during adaptive card sending.
      * @returns the response of sending adaptive card message.
      */
-    async sendAdaptiveCard(card, onError) {
+    sendAdaptiveCard(card, onError) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "Member"), ErrorCode.RuntimeNotSupported);
     }
 }
@@ -1723,7 +1723,7 @@ class TeamsBotInstallation$1 {
      *
      * @returns an array of channels if bot is installed into a team, otherwise returns an empty array.
      */
-    async channels() {
+    channels() {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "TeamsBotInstallation"), ErrorCode.RuntimeNotSupported);
     }
     /**
@@ -1734,7 +1734,7 @@ class TeamsBotInstallation$1 {
      *
      * @returns an array of members from where the bot is installed.
      */
-    async members() {
+    members() {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "TeamsBotInstallation"), ErrorCode.RuntimeNotSupported);
     }
     /**
@@ -1742,7 +1742,7 @@ class TeamsBotInstallation$1 {
      *
      * @returns the team details if bot is installed into a team, otherwise returns undefined.
      */
-    async getTeamDetails() {
+    getTeamDetails() {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "TeamsBotInstallation"), ErrorCode.RuntimeNotSupported);
     }
 }
@@ -1799,7 +1799,7 @@ class NotificationBot$1 {
      *
      * @returns - an array of {@link TeamsBotInstallation}.
      */
-    static async installations() {
+    static installations() {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "NotificationBot"), ErrorCode.RuntimeNotSupported);
     }
     /**
@@ -1815,7 +1815,7 @@ class NotificationBot$1 {
      * (personal chat, group chat, Teams channel).
      * @returns the first {@link Member} where predicate is true, and undefined otherwise.
      */
-    async findMember(predicate, scope) {
+    findMember(predicate, scope) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "NotificationBot"), ErrorCode.RuntimeNotSupported);
     }
     /**
@@ -1830,7 +1830,7 @@ class NotificationBot$1 {
      * immediately returns that channel. Otherwise, find returns undefined.
      * @returns the first {@link Channel} where predicate is true, and undefined otherwise.
      */
-    async findChannel(predicate) {
+    findChannel(predicate) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "NotificationBot"), ErrorCode.RuntimeNotSupported);
     }
     /**
@@ -1844,7 +1844,7 @@ class NotificationBot$1 {
      * (personal chat, group chat, Teams channel).
      * @returns an array of {@link Member} where predicate is true, and empty array otherwise.
      */
-    async findAllMembers(predicate, scope) {
+    findAllMembers(predicate, scope) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "NotificationBot"), ErrorCode.RuntimeNotSupported);
     }
     /**
@@ -1857,7 +1857,7 @@ class NotificationBot$1 {
      * @param predicate find calls predicate for each channel of the installation.
      * @returns an array of {@link Channel} where predicate is true, and empty array otherwise.
      */
-    async findAllChannels(predicate) {
+    findAllChannels(predicate) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "NotificationBot"), ErrorCode.RuntimeNotSupported);
     }
 }