@microsoft/teamsfx 2.3.1-alpha.7f6ee9970.0 → 2.3.1-alpha.831e41ff5.0

package/dist/index.esm2017.mjs

@@ -138,6 +138,7 @@ ErrorMessage.DuplicateHttpsOptionProperty = "Axios HTTPS agent already defined v
 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}.";
 ErrorMessage.OnlySupportInQueryActivity = "The handleMessageExtensionQueryWithToken only support in handleTeamsMessagingExtensionQuery with composeExtension/query type.";
+ErrorMessage.OnlySupportInLinkQueryActivity = "The handleMessageExtensionLinkQueryWithSSO only support in handleTeamsAppBasedLinkQuery with composeExtension/queryLink type.";
 /**
  * Error class with code and message thrown by the SDK.
  */
@@ -3884,9 +3885,9 @@ class MessageBuilder {
  * @param {initiateLoginEndpoint} initiateLoginEndpoint - Login page for Teams to redirect to.
  * @param {string | string[]} scopes - The list of scopes for which the token will have access.
  *
- * @returns SignIn link CardAction with 200 status code.
+ * @returns SignIn link SilentAuth CardAction with 200 status code.
  */
-function getSignInResponseForMessageExtensionWithAuthConfig(authConfig, initiateLoginEndpoint, scopes) {
+function getSignInResponseForMessageExtensionWithSilentAuthConfig(authConfig, initiateLoginEndpoint, scopes) {
     const scopesArray = getScopesArray(scopes);
     const signInLink = `${initiateLoginEndpoint}?scope=${encodeURI(scopesArray.join(" "))}&clientId=${authConfig.clientId}&tenantId=${authConfig.tenantId}`;
     return {
@@ -3904,6 +3905,34 @@ function getSignInResponseForMessageExtensionWithAuthConfig(authConfig, initiate
         },
     };
 }
+/**
+ *  Retrieve the OAuth Sign in Link to use in the MessagingExtensionResult Suggested Actions.
+ * This method just a workaround for link unfurling now.
+ *
+ * @param {OnBehalfOfCredentialAuthConfig} authConfig - User custom the message extension authentication configuration.
+ * @param {initiateLoginEndpoint} initiateLoginEndpoint - Login page for Teams to redirect to.
+ * @param {string | string[]} scopes - The list of scopes for which the token will have access.
+ *
+ * @returns SignIn link Auth CardAction with 200 status code.
+ */
+function getSignInResponseForMessageExtensionWithAuthConfig(authConfig, initiateLoginEndpoint, scopes) {
+    const scopesArray = getScopesArray(scopes);
+    const signInLink = `${initiateLoginEndpoint}?scope=${encodeURI(scopesArray.join(" "))}&clientId=${authConfig.clientId}&tenantId=${authConfig.tenantId}`;
+    return {
+        composeExtension: {
+            type: "auth",
+            suggestedActions: {
+                actions: [
+                    {
+                        type: "openUrl",
+                        value: signInLink,
+                        title: "Message Extension OAuth",
+                    },
+                ],
+            },
+        },
+    };
+}
 /**
  * Retrieve the OAuth Sign in Link to use in the MessagingExtensionResult Suggested Actions.
  * This method only work on MessageExtension with Query now.
@@ -3952,7 +3981,7 @@ async function executionWithTokenAndConfig(context, authConfig, initiateLoginEnd
     const valueObj = context.activity.value;
     if (!valueObj.authentication || !valueObj.authentication.token) {
         internalLogger.verbose("No AccessToken in request, return silentAuth for AccessToken");
-        return getSignInResponseForMessageExtensionWithAuthConfig(authConfig, initiateLoginEndpoint, scopes);
+        return getSignInResponseForMessageExtensionWithSilentAuthConfig(authConfig, initiateLoginEndpoint, scopes);
     }
     try {
         const credential = new OnBehalfOfUserCredential(valueObj.authentication.token, authConfig);
@@ -3970,12 +3999,25 @@ async function executionWithTokenAndConfig(context, authConfig, initiateLoginEnd
         }
     }
     catch (err) {
-        if (err instanceof ErrorWithCode && err.code === ErrorCode.UiRequiredError) {
+        if (err instanceof ErrorWithCode &&
+            err.code === ErrorCode.UiRequiredError &&
+            context.activity.name === "composeExtension/query") {
             internalLogger.verbose("User not consent yet, return 412 to user consent first.");
             const response = { status: 412 };
             await context.sendActivity({ value: response, type: ActivityTypes.InvokeResponse });
             return;
         }
+        else if (err instanceof ErrorWithCode &&
+            err.code === ErrorCode.UiRequiredError &&
+            context.activity.name === "composeExtension/queryLink") {
+            internalLogger.verbose("User not consent yet, return auth card for user login");
+            const response = getSignInResponseForMessageExtensionWithAuthConfig(authConfig, initiateLoginEndpoint, scopes);
+            await context.sendActivity({
+                value: { status: 200, body: response },
+                type: ActivityTypes.InvokeResponse,
+            });
+            return;
+        }
         throw err;
     }
 }
@@ -4077,6 +4119,31 @@ async function handleMessageExtensionQueryWithSSO(context, config, initiateLogin
         throw new ErrorWithCode(formatString(ErrorMessage.OnlySupportInQueryActivity), ErrorCode.FailedOperation);
     }
     return await executionWithTokenAndConfig(context, config !== null && config !== void 0 ? config : {}, initiateLoginEndpoint, scopes, logic);
+}
+/**
+ * Users execute link query in message extension with SSO or access token.
+ *
+ * @param {TurnContext} context - The context object for the current turn.
+ * @param {OnBehalfOfCredentialAuthConfig} config - User custom the message extension authentication configuration.
+ * @param {initiateLoginEndpoint} initiateLoginEndpoint - Login page for Teams to redirect to.
+ * @param {string| string[]} scopes - The list of scopes for which the token will have access.
+ * @param {function} logic - Business logic when executing the link query in message extension with SSO or access token.
+ *
+ * @throws {@link ErrorCode|InternalError} when User invoke not response to message extension link query.
+ * @throws {@link ErrorCode|InternalError} when failed to get access token with unknown error.
+ * @throws {@link ErrorCode|TokenExpiredError} when SSO token has already expired.
+ * @throws {@link ErrorCode|ServiceError} when failed to get access token from simple auth server.
+ * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
+ * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is nodeJS.
+ *
+ * @returns A MessageExtension Response for the activity. If the logic not return any, return void instead.
+ */
+async function handleMessageExtensionLinkQueryWithSSO(context, config, initiateLoginEndpoint, scopes, logic) {
+    if (context.activity.name != "composeExtension/queryLink") {
+        internalLogger.error(ErrorMessage.OnlySupportInLinkQueryActivity);
+        throw new ErrorWithCode(formatString(ErrorMessage.OnlySupportInLinkQueryActivity), ErrorCode.FailedOperation);
+    }
+    return await executionWithTokenAndConfig(context, config !== null && config !== void 0 ? config : {}, initiateLoginEndpoint, scopes, logic);
 }
 
 /**
@@ -4977,5 +5044,5 @@ var conversationWithCloudAdapter = /*#__PURE__*/Object.freeze({
   CardActionBot: CardActionBot
 });
 
-export { AdaptiveCardResponse, ApiKeyLocation, ApiKeyProvider, AppCredential, BasicAuthProvider, BearerTokenAuthProvider, conversationWithCloudAdapter as BotBuilderCloudAdapter, BotSsoExecutionDialog, CardActionBot$1 as CardActionBot, CertificateAuthProvider, Channel$1 as Channel, CommandBot$1 as CommandBot, ConversationBot$1 as ConversationBot, ErrorCode, ErrorWithCode, IdentityType, InvokeResponseErrorCode, InvokeResponseFactory, LogLevel, Member$1 as Member, MessageBuilder, MsGraphAuthProvider, NotificationBot$1 as NotificationBot, NotificationTargetType, OnBehalfOfUserCredential, SearchScope$1 as SearchScope, TeamsBotInstallation$1 as TeamsBotInstallation, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createApiClient, createMicrosoftGraphClient, createMicrosoftGraphClientWithCredential, createPemCertOption, createPfxCertOption, getLogLevel, getTediousConnectionConfig, handleMessageExtensionQueryWithSSO, handleMessageExtensionQueryWithToken, sendAdaptiveCard$1 as sendAdaptiveCard, sendMessage$1 as sendMessage, setLogFunction, setLogLevel, setLogger };
+export { AdaptiveCardResponse, ApiKeyLocation, ApiKeyProvider, AppCredential, BasicAuthProvider, BearerTokenAuthProvider, conversationWithCloudAdapter as BotBuilderCloudAdapter, BotSsoExecutionDialog, CardActionBot$1 as CardActionBot, CertificateAuthProvider, Channel$1 as Channel, CommandBot$1 as CommandBot, ConversationBot$1 as ConversationBot, ErrorCode, ErrorWithCode, IdentityType, InvokeResponseErrorCode, InvokeResponseFactory, LogLevel, Member$1 as Member, MessageBuilder, MsGraphAuthProvider, NotificationBot$1 as NotificationBot, NotificationTargetType, OnBehalfOfUserCredential, SearchScope$1 as SearchScope, TeamsBotInstallation$1 as TeamsBotInstallation, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createApiClient, createMicrosoftGraphClient, createMicrosoftGraphClientWithCredential, createPemCertOption, createPfxCertOption, getLogLevel, getTediousConnectionConfig, handleMessageExtensionLinkQueryWithSSO, handleMessageExtensionQueryWithSSO, handleMessageExtensionQueryWithToken, sendAdaptiveCard$1 as sendAdaptiveCard, sendMessage$1 as sendMessage, setLogFunction, setLogLevel, setLogger };
 //# sourceMappingURL=index.esm2017.mjs.map