@microsoft/teamsfx 1.1.2-alpha.988c78cba.0 → 1.1.2-alpha.9bd0cb559.0

package/dist/index.esm2017.js

@@ -31,6 +31,30 @@ var ErrorCode;
      * Channel is not supported error.
      */
     ErrorCode["ChannelNotSupported"] = "ChannelNotSupported";
+    /**
+     * Failed to retrieve sso token
+     */
+    ErrorCode["FailedToRetrieveSsoToken"] = "FailedToRetrieveSsoToken";
+    /**
+     * Failed to process sso handler
+     */
+    ErrorCode["FailedToProcessSsoHandler"] = "FailedToProcessSsoHandler";
+    /**
+     * Cannot find command
+     */
+    ErrorCode["CannotFindCommand"] = "CannotFindCommand";
+    /**
+     * Failed to run sso step
+     */
+    ErrorCode["FailedToRunSsoStep"] = "FailedToRunSsoStep";
+    /**
+     * Failed to run dedup step
+     */
+    ErrorCode["FailedToRunDedupStep"] = "FailedToRunDedupStep";
+    /**
+     * Sso activity handler is undefined
+     */
+    ErrorCode["SsoActivityHandlerIsUndefined"] = "SsoActivityHandlerIsUndefined";
     /**
      * Runtime is not supported error.
      */
@@ -86,6 +110,15 @@ ErrorMessage.NodejsRuntimeNotSupported = "{0} is not supported in Node.";
 ErrorMessage.FailToAcquireTokenOnBehalfOfUser = "Failed to acquire access token on behalf of user: {0}";
 // ChannelNotSupported Error
 ErrorMessage.OnlyMSTeamsChannelSupported = "{0} is only supported in MS Teams Channel";
+ErrorMessage.FailedToProcessSsoHandler = "Failed to process sso handler: {0}";
+// FailedToRetrieveSsoToken Error
+ErrorMessage.FailedToRetrieveSsoToken = "Failed to retrieve sso token, user failed to finish the AAD consent flow.";
+// CannotFindCommand Error
+ErrorMessage.CannotFindCommand = "Cannot find command: {0}";
+ErrorMessage.FailedToRunSsoStep = "Failed to run dialog to retrieve sso token: {0}";
+ErrorMessage.FailedToRunDedupStep = "Failed to run dialog to remove duplicated messages: {0}";
+// SsoActivityHandlerIsUndefined Error
+ErrorMessage.SsoActivityHandlerIsNull = "Sso command can only be used or added when sso activity handler is not undefined";
 // IdentityTypeNotSupported Error
 ErrorMessage.IdentityTypeNotSupported = "{0} identity is not supported in {1}";
 // AuthorizationInfoError
@@ -506,18 +539,19 @@ class TeamsUserCredential {
      * await credential.login("https://graph.microsoft.com/User.Read Calendars.Read"); // multiple scopes using string
      * ```
      * @param scopes - The list of scopes for which the token will have access, before that, we will request user to consent.
+     * @param { string[] } resources - The optional list of resources for full trust Teams apps.
      *
      * @throws {@link ErrorCode|InternalError} when failed to login with unknown error.
      * @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.
      */
-    async login(scopes) {
+    async login(scopes, resources) {
         validateScopesType(scopes);
         const scopesStr = typeof scopes === "string" ? scopes : scopes.join(" ");
         internalLogger.info(`Popup login page to get user's access token with scopes: ${scopesStr}`);
         if (!this.initialized) {
-            await this.init();
+            await this.init(resources);
         }
         return new Promise((resolve, reject) => {
             microsoftTeams.initialize(() => {
@@ -569,6 +603,9 @@ class TeamsUserCredential {
      * Get access token from credential.
      *
      * Important: Access tokens are stored in sessionStorage, read more here: https://aka.ms/teamsfx-session-storage-notice
+     * Important: Full trust applications do not read the resource information from the webApplicationInfo section of the app
+     * manifest. Instead, this resource (along with any additional resources from which to request tokens) must be provided
+     * as a list of resources to the getToken() method through a GetTeamsUserTokenOptions object.
      *
      * @example
      * ```typescript
@@ -582,6 +619,9 @@ class TeamsUserCredential {
      * await credential.getToken("User.Read Application.Read.All") // Get Graph access token for multiple scopes using space-separated string
      * await credential.getToken("https://graph.microsoft.com/User.Read") // Get Graph access token with full resource URI
      * await credential.getToken(["https://outlook.office.com/Mail.Read"]) // Get Outlook access token
+     *
+     * const options: GetTeamsUserTokenOptions = { resources: ["https://domain.example.com"] }; // set up resources for full trust apps.
+     * await credential.getToken([], options) // Get sso token from teams client - only use this approach for full trust apps.
      * ```
      *
      * @param {string | string[]} scopes - The list of scopes for which the token will have access.
@@ -598,8 +638,10 @@ class TeamsUserCredential {
      * Throw error if get access token failed.
      */
     async getToken(scopes, options) {
+        var _a;
         validateScopesType(scopes);
-        const ssoToken = await this.getSSOToken();
+        const resources = (_a = options) === null || _a === void 0 ? void 0 : _a.resources;
+        const ssoToken = await this.getSSOToken(resources);
         const scopeStr = typeof scopes === "string" ? scopes : scopes.join(" ");
         if (scopeStr === "") {
             internalLogger.info("Get SSO token");
@@ -608,7 +650,7 @@ class TeamsUserCredential {
         else {
             internalLogger.info("Get access token with scopes: " + scopeStr);
             if (!this.initialized) {
-                await this.init();
+                await this.init(resources);
             }
             let tokenResponse;
             const scopesArray = typeof scopes === "string" ? scopes.split(" ") : scopes;
@@ -654,6 +696,8 @@ class TeamsUserCredential {
     /**
      * Get basic user info from SSO token
      *
+     * @param {string[]} resources - The optional list of resources for full trust Teams apps.
+     *
      * @example
      * ```typescript
      * const currentUser = await credential.getUserInfo();
@@ -665,13 +709,13 @@ class TeamsUserCredential {
      *
      * @returns Basic user info with user displayName, objectId and preferredUserName.
      */
-    async getUserInfo() {
+    async getUserInfo(resources) {
         internalLogger.info("Get basic user info from SSO token");
-        const ssoToken = await this.getSSOToken();
+        const ssoToken = await this.getSSOToken(resources);
         return getUserInfoFromSsoToken(ssoToken.token);
     }
-    async init() {
-        const ssoToken = await this.getSSOToken();
+    async init(resources) {
+        const ssoToken = await this.getSSOToken(resources);
         const info = getTenantIdAndLoginHintFromSsoToken(ssoToken.token);
         this.loginHint = info.loginHint;
         this.tid = info.tid;
@@ -690,9 +734,12 @@ class TeamsUserCredential {
     /**
      * Get SSO token using teams SDK
      * 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
+     *
+     * @param {string[]} resources - The optional list of resources for full trust Teams apps.
+     *
      * @returns SSO token
      */
-    getSSOToken() {
+    getSSOToken(resources) {
         return new Promise((resolve, reject) => {
             if (this.ssoToken) {
                 if (this.ssoToken.expiresOnTimestamp - Date.now() > tokenRefreshTimeSpanInMillisecond) {
@@ -730,7 +777,7 @@ class TeamsUserCredential {
                             internalLogger.error(errorMsg);
                             reject(new ErrorWithCode(errorMsg, ErrorCode.InternalError));
                         },
-                        resources: [],
+                        resources: resources !== null && resources !== void 0 ? resources : [],
                     });
                 });
             }
@@ -1247,8 +1294,9 @@ class TeamsFx {
         this.configuration = new Map();
         this.loadFromEnv();
         if (customConfig) {
-            for (const key of Object.keys(customConfig)) {
-                const value = customConfig[key];
+            const myConfig = Object.assign({}, customConfig);
+            for (const key of Object.keys(myConfig)) {
+                const value = myConfig[key];
                 if (value) {
                     this.configuration.set(key, value);
                 }
@@ -1296,11 +1344,11 @@ class TeamsFx {
         }
         return this.teamsUserCredential;
     }
-    async getUserInfo() {
-        return await this.getCredential().getUserInfo();
+    async getUserInfo(resources) {
+        return await this.getCredential().getUserInfo(resources);
     }
-    async login(scopes) {
-        await this.getCredential().login(scopes);
+    async login(scopes, resources) {
+        await this.getCredential().login(scopes, resources);
     }
     setSsoToken(ssoToken) {
         return this;
@@ -1423,6 +1471,105 @@ class ConversationBot {
     }
 }
 
+// Copyright (c) Microsoft Corporation.
+/*
+ * Sso execution dialog, use to handle sso command
+ */
+class BotSsoExecutionDialog {
+    /**
+     * Creates a new instance of the BotSsoExecutionDialog.
+     * @param dedupStorage Helper storage to remove duplicated messages
+     * @param requiredScopes The list of scopes for which the token will have access
+     * @param teamsfx {@link TeamsFx} instance for authentication
+     */
+    constructor(dedupStorage, requiredScopes, teamsfx) {
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "BotSsoExecutionDialog"), ErrorCode.RuntimeNotSupported);
+    }
+    /**
+     * Add TeamsFxBotSsoCommandHandler instance
+     * @param handler {@link BotSsoExecutionDialogHandler} callback function
+     * @param triggerPatterns The trigger pattern
+     */
+    addCommand(handler, triggerPatterns) {
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "BotSsoExecutionDialog"), ErrorCode.RuntimeNotSupported);
+    }
+    /**
+     * The run method handles the incoming activity (in the form of a DialogContext) and passes it through the dialog system.
+     *
+     * @param context The context object for the current turn.
+     * @param accessor The instance of StatePropertyAccessor for dialog system.
+     */
+    async run(context, accessor) {
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "BotSsoExecutionDialog"), ErrorCode.RuntimeNotSupported);
+    }
+    /**
+     * Called when the component is ending.
+     *
+     * @param context Context for the current turn of conversation.
+     */
+    async onEndDialog(context) {
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "BotSsoExecutionDialog"), ErrorCode.RuntimeNotSupported);
+    }
+}
+
+// Copyright (c) Microsoft Corporation.
+/**
+ * Default sso execution activity handler
+ */
+class DefaultBotSsoExecutionActivityHandler {
+    /**
+     * Creates a new instance of the DefaultBotSsoExecutionActivityHandler.
+     * @param ssoConfig configuration for sso command bot
+     */
+    constructor(ssoConfig) {
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "DefaultBotSsoExecutionActivityHandler"), ErrorCode.RuntimeNotSupported);
+    }
+    /**
+     * Add TeamsFxBotSsoCommandHandler instance to sso execution dialog
+     * @param handler {@link BotSsoExecutionDialogHandler} callback function
+     * @param triggerPatterns The trigger pattern
+     */
+    addCommand(handler, triggerPatterns) {
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "DefaultBotSsoExecutionActivityHandler"), ErrorCode.RuntimeNotSupported);
+    }
+    /**
+     * Called to initiate the event emission process.
+     * @param context The context object for the current turn.
+     */
+    async run(context) {
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "DefaultBotSsoExecutionActivityHandler"), ErrorCode.RuntimeNotSupported);
+    }
+    /**
+     * Receives invoke activities with Activity name of 'signin/verifyState'.
+     * @param context A context object for this turn.
+     * @param query Signin state (part of signin action auth flow) verification invoke query.
+     * @returns A promise that represents the work queued.
+     */
+    async handleTeamsSigninVerifyState(context, query) {
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "DefaultBotSsoExecutionActivityHandler"), ErrorCode.RuntimeNotSupported);
+    }
+    /**
+     * Receives invoke activities with Activity name of 'signin/tokenExchange'
+     * @param context A context object for this turn.
+     * @param query Signin state (part of signin action auth flow) verification invoke query
+     * @returns A promise that represents the work queued.
+     */
+    async handleTeamsSigninTokenExchange(context, query) {
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "DefaultBotSsoExecutionActivityHandler"), ErrorCode.RuntimeNotSupported);
+    }
+    /**
+     * Handle signin invoke activity type.
+     *
+     * @param context The context object for the current turn.
+     *
+     * @remarks
+     * Override this method to support channel-specific behavior across multiple channels.
+     */
+    async onSignInInvoke(context) {
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "DefaultBotSsoExecutionActivityHandler"), ErrorCode.RuntimeNotSupported);
+    }
+}
+
 // Copyright (c) Microsoft Corporation.
 /**
  * Send a plain text message to a notification target.
@@ -1727,6 +1874,22 @@ class CommandBot {
     registerCommands(commands) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "CommandBot"), ErrorCode.RuntimeNotSupported);
     }
+    /**
+     * Registers a sso command into the command bot.
+     *
+     * @param command The command to register.
+     */
+    registerSsoCommand(ssoCommand) {
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "CommandBot"), ErrorCode.RuntimeNotSupported);
+    }
+    /**
+     * Registers commands into the command bot.
+     *
+     * @param commands The commands to register.
+     */
+    registerSsoCommands(ssoCommands) {
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "CommandBot"), ErrorCode.RuntimeNotSupported);
+    }
 }
 
 /**
@@ -1767,5 +1930,5 @@ class CardActionBot {
     }
 }
 
-export { AdaptiveCardResponse, ApiKeyLocation, ApiKeyProvider, AppCredential, BasicAuthProvider, BearerTokenAuthProvider, CardActionBot, CertificateAuthProvider, Channel, CommandBot, ConversationBot, ErrorCode, ErrorWithCode, IdentityType, InvokeResponseErrorCode, LogLevel, Member, MsGraphAuthProvider, NotificationBot, NotificationTargetType, OnBehalfOfUserCredential, TeamsBotInstallation, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createApiClient, createMicrosoftGraphClient, createPemCertOption, createPfxCertOption, getLogLevel, getTediousConnectionConfig, sendAdaptiveCard, sendMessage, setLogFunction, setLogLevel, setLogger };
+export { AdaptiveCardResponse, ApiKeyLocation, ApiKeyProvider, AppCredential, BasicAuthProvider, BearerTokenAuthProvider, BotSsoExecutionDialog, CardActionBot, CertificateAuthProvider, Channel, CommandBot, ConversationBot, DefaultBotSsoExecutionActivityHandler, ErrorCode, ErrorWithCode, IdentityType, InvokeResponseErrorCode, LogLevel, Member, MsGraphAuthProvider, NotificationBot, NotificationTargetType, OnBehalfOfUserCredential, TeamsBotInstallation, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createApiClient, createMicrosoftGraphClient, createPemCertOption, createPfxCertOption, getLogLevel, getTediousConnectionConfig, sendAdaptiveCard, sendMessage, setLogFunction, setLogLevel, setLogger };
 //# sourceMappingURL=index.esm2017.js.map