@microsoft/teamsfx 2.3.1-alpha.cea4e2840.0 → 2.3.1-alpha.da51b018b.0

package/dist/index.node.cjs.js

@@ -167,6 +167,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.
  */
@@ -2668,7 +2669,8 @@ class NotificationMiddleware {
  */
 class LocalFileStorage {
     constructor(fileDir) {
-        this.localFileName = ".notification.localstore.json";
+        var _a;
+        this.localFileName = (_a = process.env.TEAMSFX_NOTIFICATION_STORE_FILENAME) !== null && _a !== void 0 ? _a : ".notification.localstore.json";
         this.filePath = path__namespace.resolve(fileDir, this.localFileName);
     }
     read(key) {
@@ -4030,9 +4032,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 {
@@ -4050,6 +4052,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.
@@ -4099,7 +4129,7 @@ function executionWithTokenAndConfig(context, authConfig, initiateLoginEndpoint,
         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);
@@ -4117,12 +4147,25 @@ function executionWithTokenAndConfig(context, authConfig, initiateLoginEndpoint,
             }
         }
         catch (err) {
-            if (err instanceof ErrorWithCode && err.code === exports.ErrorCode.UiRequiredError) {
+            if (err instanceof ErrorWithCode &&
+                err.code === exports.ErrorCode.UiRequiredError &&
+                context.activity.name === "composeExtension/query") {
                 internalLogger.verbose("User not consent yet, return 412 to user consent first.");
                 const response = { status: 412 };
                 yield context.sendActivity({ value: response, type: botbuilder.ActivityTypes.InvokeResponse });
                 return;
             }
+            else if (err instanceof ErrorWithCode &&
+                err.code === exports.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);
+                yield context.sendActivity({
+                    value: { status: 200, body: response },
+                    type: botbuilder.ActivityTypes.InvokeResponse,
+                });
+                return;
+            }
             throw err;
         }
     });
@@ -4231,6 +4274,33 @@ function handleMessageExtensionQueryWithSSO(context, config, initiateLoginEndpoi
         }
         return yield 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.
+ */
+function handleMessageExtensionLinkQueryWithSSO(context, config, initiateLoginEndpoint, scopes, logic) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (context.activity.name != "composeExtension/queryLink") {
+            internalLogger.error(ErrorMessage.OnlySupportInLinkQueryActivity);
+            throw new ErrorWithCode(formatString(ErrorMessage.OnlySupportInLinkQueryActivity), exports.ErrorCode.FailedOperation);
+        }
+        return yield executionWithTokenAndConfig(context, config !== null && config !== void 0 ? config : {}, initiateLoginEndpoint, scopes, logic);
+    });
 }
 
 /**
@@ -5198,6 +5268,7 @@ exports.createPemCertOption = createPemCertOption;
 exports.createPfxCertOption = createPfxCertOption;
 exports.getLogLevel = getLogLevel;
 exports.getTediousConnectionConfig = getTediousConnectionConfig;
+exports.handleMessageExtensionLinkQueryWithSSO = handleMessageExtensionLinkQueryWithSSO;
 exports.handleMessageExtensionQueryWithSSO = handleMessageExtensionQueryWithSSO;
 exports.handleMessageExtensionQueryWithToken = handleMessageExtensionQueryWithToken;
 exports.sendAdaptiveCard = sendAdaptiveCard$1;