@microsoft/teamsfx 1.0.0 → 1.0.1-alpha.96c4705a0.0

package/dist/index.esm2017.js

@@ -8,7 +8,6 @@ import axios from 'axios';
 // Licensed under the MIT license.
 /**
  * Error code to trace the error types.
- * @beta
  */
 var ErrorCode;
 (function (ErrorCode) {
@@ -99,8 +98,6 @@ ErrorMessage.DuplicateApiKeyInHeader = "The request already defined api key in r
 ErrorMessage.DuplicateApiKeyInQueryParam = "The request already defined api key in query parameter with name {0}.";
 /**
  * Error class with code and message thrown by the SDK.
- *
- * @beta
  */
 class ErrorWithCode extends Error {
     /**
@@ -108,8 +105,6 @@ class ErrorWithCode extends Error {
      *
      * @param {string} message - error message.
      * @param {ErrorCode} code - error code.
-     *
-     * @beta
      */
     constructor(message, code) {
         if (!code) {
@@ -127,8 +122,6 @@ class ErrorWithCode extends Error {
 // Licensed under the MIT license.
 /**
  * Log level.
- *
- * @beta
  */
 var LogLevel;
 (function (LogLevel) {
@@ -153,8 +146,6 @@ var LogLevel;
  * Update log level helper.
  *
  * @param { LogLevel } level - log level in configuration
- *
- * @beta
  */
 function setLogLevel(level) {
     internalLogger.level = level;
@@ -163,8 +154,6 @@ function setLogLevel(level) {
  * Get log level.
  *
  * @returns Log level
- *
- * @beta
  */
 function getLogLevel() {
     return internalLogger.level;
@@ -239,8 +228,6 @@ const internalLogger = new InternalLogger();
  *   error: console.error,
  * });
  * ```
- *
- * @beta
  */
 function setLogger(logger) {
     internalLogger.customLogger = logger;
@@ -258,8 +245,6 @@ function setLogger(logger) {
  *   }
  * });
  * ```
- *
- * @beta
  */
 function setLogFunction(logFunction) {
     internalLogger.customLogFunction = logFunction;
@@ -410,8 +395,6 @@ function validateScopesType(value) {
  *
  * @remarks
  * Only works in in server side.
- *
- * @beta
  */
 class AppCredential {
     /**
@@ -419,7 +402,6 @@ class AppCredential {
      *
      * @remarks
      * Only works in in server side.
-     * @beta
      */
     constructor(authConfig) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "AppCredential"), ErrorCode.RuntimeNotSupported);
@@ -429,7 +411,6 @@ class AppCredential {
      *
      * @remarks
      * Only works in in server side.
-     * @beta
      */
     async getToken(scopes, options) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "AppCredential"), ErrorCode.RuntimeNotSupported);
@@ -442,8 +423,6 @@ class AppCredential {
  *
  * @remarks
  * Can only be used in server side.
- *
- * @beta
  */
 class OnBehalfOfUserCredential {
     /**
@@ -451,7 +430,6 @@ class OnBehalfOfUserCredential {
      *
      * @remarks
      * Can Only works in in server side.
-     * @beta
      */
     constructor(ssoToken, config) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "OnBehalfOfUserCredential"), ErrorCode.RuntimeNotSupported);
@@ -460,7 +438,6 @@ class OnBehalfOfUserCredential {
      * Get access token from credential.
      * @remarks
      * Can only be used in server side.
-     * @beta
      */
     async getToken(scopes, options) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "OnBehalfOfUserCredential"), ErrorCode.RuntimeNotSupported);
@@ -469,7 +446,6 @@ class OnBehalfOfUserCredential {
      * Get basic user info from SSO token.
      * @remarks
      * Can only be used in server side.
-     * @beta
      */
     getUserInfo() {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "OnBehalfOfUserCredential"), ErrorCode.RuntimeNotSupported);
@@ -485,8 +461,6 @@ const loginPageHeight = 535;
  *
  * @remarks
  * Can only be used within Teams.
- *
- * @beta
  */
 class TeamsUserCredential {
     /**
@@ -510,8 +484,6 @@ class TeamsUserCredential {
      *
      * @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.
-     *
-     * @beta
      */
     constructor(authConfig) {
         internalLogger.info("Create teams user credential");
@@ -538,8 +510,6 @@ class TeamsUserCredential {
      * @throws {@link ErrorCode|ConsentFailed} when user canceled or failed to consent.
      * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is nodeJS.
-     *
-     * @beta
      */
     async login(scopes) {
         validateScopesType(scopes);
@@ -625,8 +595,6 @@ class TeamsUserCredential {
      * If scopes is empty string or array, it returns SSO token.
      * If scopes is non-empty, it returns access token for target scope.
      * Throw error if get access token failed.
-     *
-     * @beta
      */
     async getToken(scopes, options) {
         validateScopesType(scopes);
@@ -695,8 +663,6 @@ class TeamsUserCredential {
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is nodeJS.
      *
      * @returns Basic user info with user displayName, objectId and preferredUserName.
-     *
-     * @beta
      */
     async getUserInfo() {
         internalLogger.info("Get basic user info from SSO token");
@@ -828,8 +794,6 @@ class TeamsUserCredential {
 const defaultScope = "https://graph.microsoft.com/.default";
 /**
  * Microsoft Graph auth provider for Teams Framework
- *
- * @beta
  */
 class MsGraphAuthProvider {
     /**
@@ -841,8 +805,6 @@ class MsGraphAuthProvider {
      * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
      *
      * @returns An instance of MsGraphAuthProvider.
-     *
-     * @beta
      */
     constructor(teamsfx, scopes) {
         this.teamsfx = teamsfx;
@@ -934,8 +896,6 @@ class MsGraphAuthProvider {
  * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
  *
  * @returns Graph client with specified scopes.
- *
- * @beta
  */
 function createMicrosoftGraphClient(teamsfx, scopes) {
     internalLogger.info("Create Microsoft Graph Client");
@@ -951,7 +911,6 @@ function createMicrosoftGraphClient(teamsfx, scopes) {
  * Generate connection configuration consumed by tedious.
  * @remarks
  * Only works in in server side.
- * @beta
  */
 async function getTediousConnectionConfig(teamsfx, databaseName) {
     throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "DefaultTediousConnectionConfiguration"), ErrorCode.RuntimeNotSupported);
@@ -1005,8 +964,6 @@ async function getTediousConnectionConfig(teamsfx, databaseName) {
  *      }
  * ]));
  * ```
- *
- * @beta
  */
 class TeamsBotSsoPrompt {
     /**
@@ -1017,8 +974,6 @@ class TeamsBotSsoPrompt {
      *
      * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
-     *
-     * @beta
      */
     constructor(teamsfx, dialogId, settings) {
         this.teamsfx = teamsfx;
@@ -1038,8 +993,6 @@ class TeamsBotSsoPrompt {
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
      *
      * @returns A `Promise` representing the asynchronous operation.
-     *
-     * @beta
      */
     async beginDialog(dc) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "TeamsBotSsoPrompt"), ErrorCode.RuntimeNotSupported);
@@ -1059,8 +1012,6 @@ class TeamsBotSsoPrompt {
      *
      * @throws {@link ErrorCode|ChannelNotSupported} when bot channel is not MS Teams.
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
-     *
-     * @beta
      */
     async continueDialog(dc) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "TeamsBotSsoPrompt"), ErrorCode.RuntimeNotSupported);
@@ -1079,8 +1030,6 @@ class TeamsBotSsoPrompt {
  * ```typescript
  * const client = createApiClient("https://my-api-endpoint-base-url", new BasicAuthProvider("xxx","xxx"));
  * ```
- *
- * @beta
  */
 function createApiClient(apiEndpoint, authProvider) {
     // Add a request interceptor
@@ -1096,14 +1045,10 @@ function createApiClient(apiEndpoint, authProvider) {
 // Copyright (c) Microsoft Corporation.
 /**
  * Provider that handles Bearer Token authentication
- *
- * @beta
  */
 class BearerTokenAuthProvider {
     /**
      * @param { () => Promise<string> } getToken - Function that returns the content of bearer token used in http request
-     *
-     * @beta
      */
     constructor(getToken) {
         this.getToken = getToken;
@@ -1117,8 +1062,6 @@ class BearerTokenAuthProvider {
      * @returns Updated axios request config.
      *
      * @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when Authorization header already exists in request configuration.
-     *
-     * @beta
      */
     async AddAuthenticationInfo(config) {
         const token = await this.getToken();
@@ -1136,8 +1079,6 @@ class BearerTokenAuthProvider {
 // Copyright (c) Microsoft Corporation.
 /**
  * Provider that handles Basic authentication
- *
- * @beta
  */
 class BasicAuthProvider {
     /**
@@ -1147,8 +1088,6 @@ class BasicAuthProvider {
      *
      * @throws {@link ErrorCode|InvalidParameter} - when username or password is empty.
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
-     *
-     * @beta
      */
     constructor(userName, password) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "BasicAuthProvider"), ErrorCode.RuntimeNotSupported);
@@ -1163,8 +1102,6 @@ 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.
-     *
-     * @beta
      */
     async AddAuthenticationInfo(config) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "BasicAuthProvider"), ErrorCode.RuntimeNotSupported);
@@ -1174,8 +1111,6 @@ class BasicAuthProvider {
 // Copyright (c) Microsoft Corporation.
 /**
  * Provider that handles API Key authentication
- *
- * @beta
  */
 class ApiKeyProvider {
     /**
@@ -1186,8 +1121,6 @@ class ApiKeyProvider {
      *
      * @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);
@@ -1202,8 +1135,6 @@ 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.
-     *
-     * @beta
      */
     async AddAuthenticationInfo(config) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "ApiKeyProvider"), ErrorCode.RuntimeNotSupported);
@@ -1211,8 +1142,6 @@ class ApiKeyProvider {
 }
 /**
  * Define available location for API Key location
- *
- * @beta
  */
 var ApiKeyLocation;
 (function (ApiKeyLocation) {
@@ -1229,15 +1158,11 @@ var ApiKeyLocation;
 // Copyright (c) Microsoft Corporation.
 /**
  * Provider that handles Certificate authentication
- *
- * @beta
  */
 class CertificateAuthProvider {
     /**
      *
      * @param { SecureContextOptions } certOption - information about the cert used in http requests
-     *
-     * @beta
      */
     constructor(certOption) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "CertificateAuthProvider"), ErrorCode.RuntimeNotSupported);
@@ -1252,8 +1177,6 @@ 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.
-     *
-     * @beta
      */
     async AddAuthenticationInfo(config) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "CertificateAuthProvider"), ErrorCode.RuntimeNotSupported);
@@ -1295,8 +1218,6 @@ function createPfxCertOption(pfx, options) {
 // Licensed under the MIT license.
 /**
  * Identity type to use in authentication.
- *
- * @beta
  */
 var IdentityType;
 (function (IdentityType) {
@@ -1313,7 +1234,6 @@ var IdentityType;
 // Copyright (c) Microsoft Corporation.
 /**
  * A class providing credential and configuration.
- * @beta
  */
 class TeamsFx {
     constructor(identityType, customConfig) {
@@ -1415,8 +1335,6 @@ class TeamsFx {
  *
  * @remarks
  * Only work on server side.
- *
- * @beta
  */
 class ConversationBot {
     /**
@@ -1426,8 +1344,6 @@ class ConversationBot {
      *
      * @remarks
      * Only work on server side.
-     *
-     * @beta
      */
     constructor(options) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "ConversationBot"), ErrorCode.RuntimeNotSupported);
@@ -1441,8 +1357,6 @@ class ConversationBot {
      *
      * @remarks
      * Only work on server side.
-     *
-     * @beta
      */
     async requestHandler(req, res, logic) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "ConversationBot"), ErrorCode.RuntimeNotSupported);
@@ -1459,8 +1373,6 @@ class ConversationBot {
  * @param target - the notification target.
  * @param text - the plain text message.
  * @returns A `Promise` representing the asynchronous operation.
- *
- * @beta
  */
 function sendMessage(target, text) {
     throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "sendMessage"), ErrorCode.RuntimeNotSupported);
@@ -1474,8 +1386,6 @@ function sendMessage(target, text) {
  * @param target - the notification target.
  * @param card - the adaptive card raw JSON.
  * @returns A `Promise` representing the asynchronous operation.
- *
- * @beta
  */
 function sendAdaptiveCard(target, card) {
     throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "sendAdaptiveCard"), ErrorCode.RuntimeNotSupported);
@@ -1487,8 +1397,6 @@ function sendAdaptiveCard(target, card) {
  * Only work on server side.
  *
  * It's recommended to get channels from {@link TeamsBotInstallation.channels()}.
- *
- * @beta
  */
 class Channel {
     /**
@@ -1501,8 +1409,6 @@ class Channel {
      *
      * @param parent - The parent {@link TeamsBotInstallation} where this channel is created from.
      * @param info - Detailed channel information.
-     *
-     * @beta
      */
     constructor(parent, info) {
         /**
@@ -1510,8 +1416,6 @@ class Channel {
          *
          * @remarks
          * Only work on server side.
-         *
-         * @beta
          */
         this.type = "Channel";
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "Channel"), ErrorCode.RuntimeNotSupported);
@@ -1524,8 +1428,6 @@ class Channel {
      *
      * @param text - the plain text message.
      * @returns A `Promise` representing the asynchronous operation.
-     *
-     * @beta
      */
     sendMessage(text) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "Channel"), ErrorCode.RuntimeNotSupported);
@@ -1538,8 +1440,6 @@ class Channel {
      *
      * @param card - the adaptive card raw JSON.
      * @returns A `Promise` representing the asynchronous operation.
-     *
-     * @beta
      */
     async sendAdaptiveCard(card) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "Channel"), ErrorCode.RuntimeNotSupported);
@@ -1552,8 +1452,6 @@ class Channel {
  * Only work on server side.
  *
  * It's recommended to get members from {@link TeamsBotInstallation.members()}.
- *
- * @beta
  */
 class Member {
     /**
@@ -1566,8 +1464,6 @@ class Member {
      *
      * @param parent - The parent {@link TeamsBotInstallation} where this member is created from.
      * @param account - Detailed member account information.
-     *
-     * @beta
      */
     constructor(parent, account) {
         /**
@@ -1575,8 +1471,6 @@ class Member {
          *
          * @remarks
          * Only work on server side.
-         *
-         * @beta
          */
         this.type = "Person";
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "Member"), ErrorCode.RuntimeNotSupported);
@@ -1589,8 +1483,6 @@ class Member {
      *
      * @param text - the plain text message.
      * @returns A `Promise` representing the asynchronous operation.
-     *
-     * @beta
      */
     sendMessage(text) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "Member"), ErrorCode.RuntimeNotSupported);
@@ -1603,8 +1495,6 @@ class Member {
      *
      * @param card - the adaptive card raw JSON.
      * @returns A `Promise` representing the asynchronous operation.
-     *
-     * @beta
      */
     async sendAdaptiveCard(card) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "Member"), ErrorCode.RuntimeNotSupported);
@@ -1620,8 +1510,6 @@ class Member {
  * Only work on server side.
  *
  * It's recommended to get bot installations from {@link ConversationBot.installations()}.
- *
- * @beta
  */
 class TeamsBotInstallation {
     /**
@@ -1634,8 +1522,6 @@ class TeamsBotInstallation {
      *
      * @param adapter - the bound `BotFrameworkAdapter`.
      * @param conversationReference - the bound `ConversationReference`.
-     *
-     * @beta
      */
     constructor(adapter, conversationReference) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "TeamsBotInstallation"), ErrorCode.RuntimeNotSupported);
@@ -1648,8 +1534,6 @@ class TeamsBotInstallation {
      *
      * @param text - the plain text message.
      * @returns A `Promise` representing the asynchronous operation.
-     *
-     * @beta
      */
     sendMessage(text) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "TeamsBotInstallation"), ErrorCode.RuntimeNotSupported);
@@ -1662,8 +1546,6 @@ class TeamsBotInstallation {
      *
      * @param card - the adaptive card raw JSON.
      * @returns A `Promise` representing the asynchronous operation.
-     *
-     * @beta
      */
     sendAdaptiveCard(card) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "TeamsBotInstallation"), ErrorCode.RuntimeNotSupported);
@@ -1675,8 +1557,6 @@ class TeamsBotInstallation {
      * Only work on server side.
      *
      * @returns an array of channels if bot is installed into a team, otherwise returns an empty array.
-     *
-     * @beta
      */
     async channels() {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "TeamsBotInstallation"), ErrorCode.RuntimeNotSupported);
@@ -1688,8 +1568,6 @@ class TeamsBotInstallation {
      * Only work on server side.
      *
      * @returns an array of members from where the bot is installed.
-     *
-     * @beta
      */
     async members() {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "TeamsBotInstallation"), ErrorCode.RuntimeNotSupported);
@@ -1719,8 +1597,6 @@ class TeamsBotInstallation {
  *   }
  * }
  * ```
- *
- * @beta
  */
 class NotificationBot {
     /**
@@ -1733,8 +1609,6 @@ class NotificationBot {
      *
      * @param adapter - the bound `BotFrameworkAdapter`
      * @param options - initialize options
-     *
-     * @beta
      */
     constructor(adapter, options) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "NotificationBot"), ErrorCode.RuntimeNotSupported);
@@ -1748,8 +1622,6 @@ class NotificationBot {
      * The result is retrieving from the persisted storage.
      *
      * @returns - an array of {@link TeamsBotInstallation}.
-     *
-     * @beta
      */
     static async installations() {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "NotificationBot"), ErrorCode.RuntimeNotSupported);
@@ -1762,8 +1634,6 @@ class NotificationBot {
  *
  * @remarks
  * Only work on server side.
- *
- * @beta
  */
 class CommandBot {
     /**
@@ -1771,8 +1641,6 @@ class CommandBot {
      *
      * @param adapter The bound `BotFrameworkAdapter`.
      * @param commands The commands to registered with the command bot. Each command should implement the interface {@link TeamsFxBotCommandHandler} so that it can be correctly handled by this command bot.
-     *
-     * @beta
      */
     constructor(adapter, commands) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "CommandBot"), ErrorCode.RuntimeNotSupported);
@@ -1784,8 +1652,6 @@ class CommandBot {
      *
      * @remarks
      * Only work on server side.
-     *
-     * @beta
      */
     registerCommand(command) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "CommandBot"), ErrorCode.RuntimeNotSupported);
@@ -1797,8 +1663,6 @@ class CommandBot {
      *
      * @remarks
      * Only work on server side.
-     *
-     * @beta
      */
     registerCommands(commands) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "CommandnBot"), ErrorCode.RuntimeNotSupported);