@microsoft/teamsfx 1.0.1-alpha.4edf8c10a.0 → 1.0.1-alpha.dbef2ba70.0

package/dist/index.esm5.js

@@ -9,7 +9,6 @@ import axios from 'axios';
 // Licensed under the MIT license.
 /**
  * Error code to trace the error types.
- * @beta
  */
 var ErrorCode;
 (function (ErrorCode) {
@@ -100,8 +99,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 {
     /**
@@ -109,8 +106,6 @@ class ErrorWithCode extends Error {
      *
      * @param {string} message - error message.
      * @param {ErrorCode} code - error code.
-     *
-     * @beta
      */
     constructor(message, code) {
         if (!code) {
@@ -128,8 +123,6 @@ class ErrorWithCode extends Error {
 // Licensed under the MIT license.
 /**
  * Log level.
- *
- * @beta
  */
 var LogLevel;
 (function (LogLevel) {
@@ -154,8 +147,6 @@ var LogLevel;
  * Update log level helper.
  *
  * @param { LogLevel } level - log level in configuration
- *
- * @beta
  */
 function setLogLevel(level) {
     internalLogger.level = level;
@@ -164,8 +155,6 @@ function setLogLevel(level) {
  * Get log level.
  *
  * @returns Log level
- *
- * @beta
  */
 function getLogLevel() {
     return internalLogger.level;
@@ -240,8 +229,6 @@ const internalLogger = new InternalLogger();
  *   error: console.error,
  * });
  * ```
- *
- * @beta
  */
 function setLogger(logger) {
     internalLogger.customLogger = logger;
@@ -259,8 +246,6 @@ function setLogger(logger) {
  *   }
  * });
  * ```
- *
- * @beta
  */
 function setLogFunction(logFunction) {
     internalLogger.customLogFunction = logFunction;
@@ -411,8 +396,6 @@ function validateScopesType(value) {
  *
  * @remarks
  * Only works in in server side.
- *
- * @beta
  */
 class AppCredential {
     /**
@@ -420,7 +403,6 @@ class AppCredential {
      *
      * @remarks
      * Only works in in server side.
-     * @beta
      */
     constructor(authConfig) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "AppCredential"), ErrorCode.RuntimeNotSupported);
@@ -430,7 +412,6 @@ class AppCredential {
      *
      * @remarks
      * Only works in in server side.
-     * @beta
      */
     getToken(scopes, options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -445,8 +426,6 @@ class AppCredential {
  *
  * @remarks
  * Can only be used in server side.
- *
- * @beta
  */
 class OnBehalfOfUserCredential {
     /**
@@ -454,7 +433,6 @@ class OnBehalfOfUserCredential {
      *
      * @remarks
      * Can Only works in in server side.
-     * @beta
      */
     constructor(ssoToken, config) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "OnBehalfOfUserCredential"), ErrorCode.RuntimeNotSupported);
@@ -463,7 +441,6 @@ class OnBehalfOfUserCredential {
      * Get access token from credential.
      * @remarks
      * Can only be used in server side.
-     * @beta
      */
     getToken(scopes, options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -474,7 +451,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);
@@ -490,8 +466,6 @@ const loginPageHeight = 535;
  *
  * @remarks
  * Can only be used within Teams.
- *
- * @beta
  */
 class TeamsUserCredential {
     /**
@@ -515,8 +489,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");
@@ -543,8 +515,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
      */
     login(scopes) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -632,8 +602,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
      */
     getToken(scopes, options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -704,8 +672,6 @@ class TeamsUserCredential {
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is nodeJS.
      *
      * @returns Basic user info with user displayName, objectId and preferredUserName.
-     *
-     * @beta
      */
     getUserInfo() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -841,8 +807,6 @@ class TeamsUserCredential {
 const defaultScope = "https://graph.microsoft.com/.default";
 /**
  * Microsoft Graph auth provider for Teams Framework
- *
- * @beta
  */
 class MsGraphAuthProvider {
     /**
@@ -854,8 +818,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;
@@ -949,8 +911,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");
@@ -966,7 +926,6 @@ function createMicrosoftGraphClient(teamsfx, scopes) {
  * Generate connection configuration consumed by tedious.
  * @remarks
  * Only works in in server side.
- * @beta
  */
 function getTediousConnectionConfig(teamsfx, databaseName) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -1022,8 +981,6 @@ function getTediousConnectionConfig(teamsfx, databaseName) {
  *      }
  * ]));
  * ```
- *
- * @beta
  */
 class TeamsBotSsoPrompt {
     /**
@@ -1034,8 +991,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;
@@ -1055,8 +1010,6 @@ class TeamsBotSsoPrompt {
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
      *
      * @returns A `Promise` representing the asynchronous operation.
-     *
-     * @beta
      */
     beginDialog(dc) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1078,8 +1031,6 @@ class TeamsBotSsoPrompt {
      *
      * @throws {@link ErrorCode|ChannelNotSupported} when bot channel is not MS Teams.
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
-     *
-     * @beta
      */
     continueDialog(dc) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1100,8 +1051,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
@@ -1119,14 +1068,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;
@@ -1140,8 +1085,6 @@ class BearerTokenAuthProvider {
      * @returns Updated axios request config.
      *
      * @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when Authorization header already exists in request configuration.
-     *
-     * @beta
      */
     AddAuthenticationInfo(config) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1161,8 +1104,6 @@ class BearerTokenAuthProvider {
 // Copyright (c) Microsoft Corporation.
 /**
  * Provider that handles Basic authentication
- *
- * @beta
  */
 class BasicAuthProvider {
     /**
@@ -1172,8 +1113,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);
@@ -1188,8 +1127,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
      */
     AddAuthenticationInfo(config) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1201,8 +1138,6 @@ class BasicAuthProvider {
 // Copyright (c) Microsoft Corporation.
 /**
  * Provider that handles API Key authentication
- *
- * @beta
  */
 class ApiKeyProvider {
     /**
@@ -1213,8 +1148,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);
@@ -1229,8 +1162,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
      */
     AddAuthenticationInfo(config) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1240,8 +1171,6 @@ class ApiKeyProvider {
 }
 /**
  * Define available location for API Key location
- *
- * @beta
  */
 var ApiKeyLocation;
 (function (ApiKeyLocation) {
@@ -1258,15 +1187,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);
@@ -1281,8 +1206,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
      */
     AddAuthenticationInfo(config) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1326,8 +1249,6 @@ function createPfxCertOption(pfx, options) {
 // Licensed under the MIT license.
 /**
  * Identity type to use in authentication.
- *
- * @beta
  */
 var IdentityType;
 (function (IdentityType) {
@@ -1344,7 +1265,6 @@ var IdentityType;
 // Copyright (c) Microsoft Corporation.
 /**
  * A class providing credential and configuration.
- * @beta
  */
 class TeamsFx {
     constructor(identityType, customConfig) {
@@ -1450,8 +1370,6 @@ class TeamsFx {
  *
  * @remarks
  * Only work on server side.
- *
- * @beta
  */
 class ConversationBot {
     /**
@@ -1461,8 +1379,6 @@ class ConversationBot {
      *
      * @remarks
      * Only work on server side.
-     *
-     * @beta
      */
     constructor(options) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "ConversationBot"), ErrorCode.RuntimeNotSupported);
@@ -1476,8 +1392,6 @@ class ConversationBot {
      *
      * @remarks
      * Only work on server side.
-     *
-     * @beta
      */
     requestHandler(req, res, logic) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1496,8 +1410,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);
@@ -1511,8 +1423,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);
@@ -1524,8 +1434,6 @@ function sendAdaptiveCard(target, card) {
  * Only work on server side.
  *
  * It's recommended to get channels from {@link TeamsBotInstallation.channels()}.
- *
- * @beta
  */
 class Channel {
     /**
@@ -1538,8 +1446,6 @@ class Channel {
      *
      * @param parent - The parent {@link TeamsBotInstallation} where this channel is created from.
      * @param info - Detailed channel information.
-     *
-     * @beta
      */
     constructor(parent, info) {
         /**
@@ -1547,8 +1453,6 @@ class Channel {
          *
          * @remarks
          * Only work on server side.
-         *
-         * @beta
          */
         this.type = "Channel";
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "Channel"), ErrorCode.RuntimeNotSupported);
@@ -1561,8 +1465,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);
@@ -1575,8 +1477,6 @@ class Channel {
      *
      * @param card - the adaptive card raw JSON.
      * @returns A `Promise` representing the asynchronous operation.
-     *
-     * @beta
      */
     sendAdaptiveCard(card) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1591,8 +1491,6 @@ class Channel {
  * Only work on server side.
  *
  * It's recommended to get members from {@link TeamsBotInstallation.members()}.
- *
- * @beta
  */
 class Member {
     /**
@@ -1605,8 +1503,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) {
         /**
@@ -1614,8 +1510,6 @@ class Member {
          *
          * @remarks
          * Only work on server side.
-         *
-         * @beta
          */
         this.type = "Person";
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "Member"), ErrorCode.RuntimeNotSupported);
@@ -1628,8 +1522,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);
@@ -1642,8 +1534,6 @@ class Member {
      *
      * @param card - the adaptive card raw JSON.
      * @returns A `Promise` representing the asynchronous operation.
-     *
-     * @beta
      */
     sendAdaptiveCard(card) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1661,8 +1551,6 @@ class Member {
  * Only work on server side.
  *
  * It's recommended to get bot installations from {@link ConversationBot.installations()}.
- *
- * @beta
  */
 class TeamsBotInstallation {
     /**
@@ -1675,8 +1563,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);
@@ -1689,8 +1575,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);
@@ -1703,8 +1587,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);
@@ -1716,8 +1598,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
      */
     channels() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1731,8 +1611,6 @@ class TeamsBotInstallation {
      * Only work on server side.
      *
      * @returns an array of members from where the bot is installed.
-     *
-     * @beta
      */
     members() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1764,8 +1642,6 @@ class TeamsBotInstallation {
  *   }
  * }
  * ```
- *
- * @beta
  */
 class NotificationBot {
     /**
@@ -1778,8 +1654,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);
@@ -1793,8 +1667,6 @@ class NotificationBot {
      * The result is retrieving from the persisted storage.
      *
      * @returns - an array of {@link TeamsBotInstallation}.
-     *
-     * @beta
      */
     static installations() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1809,8 +1681,6 @@ class NotificationBot {
  *
  * @remarks
  * Only work on server side.
- *
- * @beta
  */
 class CommandBot {
     /**
@@ -1818,8 +1688,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);
@@ -1831,8 +1699,6 @@ class CommandBot {
      *
      * @remarks
      * Only work on server side.
-     *
-     * @beta
      */
     registerCommand(command) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "CommandBot"), ErrorCode.RuntimeNotSupported);
@@ -1844,8 +1710,6 @@ class CommandBot {
      *
      * @remarks
      * Only work on server side.
-     *
-     * @beta
      */
     registerCommands(commands) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "CommandnBot"), ErrorCode.RuntimeNotSupported);