@microsoft/teamsfx 0.6.3-alpha.81c48cbfc.0 → 0.6.3-alpha.f018de6e6.0

package/dist/index.node.cjs.js

@@ -101,6 +101,10 @@ exports.ErrorCode = void 0;
      * Identity type error.
      */
     ErrorCode["IdentityTypeNotSupported"] = "IdentityTypeNotSupported";
+    /**
+     * Authentication info already exists error.
+     */
+    ErrorCode["AuthorizationInfoAlreadyExists"] = "AuthorizationInfoAlreadyExists";
 })(exports.ErrorCode || (exports.ErrorCode = {}));
 /**
  * @internal
@@ -122,6 +126,9 @@ ErrorMessage.FailToAcquireTokenOnBehalfOfUser = "Failed to acquire access token
 ErrorMessage.OnlyMSTeamsChannelSupported = "{0} is only supported in MS Teams Channel";
 // IdentityTypeNotSupported Error
 ErrorMessage.IdentityTypeNotSupported = "{0} identity is not supported in {1}";
+// AuthorizationInfoError
+ErrorMessage.AuthorizationHeaderAlreadyExists = "Authorization header already exists!";
+ErrorMessage.BasicCredentialAlreadyExists = "Basic credential already exists!";
 // InvalidParameter Error
 ErrorMessage.EmptyParameter = "Parameter {0} is empty";
 ErrorMessage.DuplicateHttpsOptionProperty = "Axios HTTPS agent already defined value for property {0}";
@@ -1493,6 +1500,10 @@ class BearerTokenAuthProvider {
      * @param config - Contains all the request information and can be updated to include extra authentication info.
      * Refer https://axios-http.com/docs/req_config for detailed document.
      *
+     * @returns Updated axios request config.
+     *
+     * @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when Authorization header already exists in request configuration.
+     *
      * @beta
      */
     AddAuthenticationInfo(config) {
@@ -1502,7 +1513,7 @@ class BearerTokenAuthProvider {
                 config.headers = {};
             }
             if (config.headers["Authorization"]) {
-                throw new Error("Authorization header already exists!");
+                throw new ErrorWithCode(ErrorMessage.AuthorizationHeaderAlreadyExists, exports.ErrorCode.AuthorizationInfoAlreadyExists);
             }
             config.headers["Authorization"] = `Bearer ${token}`;
             return config;
@@ -1510,6 +1521,59 @@ class BearerTokenAuthProvider {
     }
 }
 
+// Copyright (c) Microsoft Corporation.
+/**
+ * Provider that handles Basic authentication
+ *
+ * @beta
+ */
+class BasicAuthProvider {
+    /**
+     *
+     * @param userName - Username used in basic auth
+     * @param password - Password used in basic auth
+     *
+     * @beta
+     */
+    constructor(userName, password) {
+        if (!userName) {
+            throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "username"), exports.ErrorCode.InvalidParameter);
+        }
+        if (!password) {
+            throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "password"), exports.ErrorCode.InvalidParameter);
+        }
+        this.userName = userName;
+        this.password = password;
+    }
+    /**
+     * Adds authentication info to http requests
+     *
+     * @param config - Contains all the request information and can be updated to include extra authentication info.
+     * Refer https://axios-http.com/docs/req_config for detailed document.
+     *
+     * @returns Updated axios request config.
+     *
+     * @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when Authorization header or auth property already exists in request configuration.
+     *
+     * @beta
+     */
+    AddAuthenticationInfo(config) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            if (config.headers && config.headers["Authorization"]) {
+                throw new ErrorWithCode(ErrorMessage.AuthorizationHeaderAlreadyExists, exports.ErrorCode.AuthorizationInfoAlreadyExists);
+            }
+            if (config.auth) {
+                throw new ErrorWithCode(ErrorMessage.BasicCredentialAlreadyExists, exports.ErrorCode.AuthorizationInfoAlreadyExists);
+            }
+            config.auth = {
+                username: this.userName,
+                password: this.password,
+            };
+            return config;
+        });
+    }
+}
+
 // Copyright (c) Microsoft Corporation.
 /**
  * Provider that handles Certificate authentication
@@ -2659,8 +2723,8 @@ class MessageBuilder {
     /**
      * Build a bot message activity attached with adaptive card.
      *
-     * @param getCardData Function to prepare your card data.
      * @param cardTemplate The adaptive card template.
+     * @param data card data used to render the template.
      * @returns A bot message activity attached with an adaptive card.
      *
      * @example
@@ -2685,19 +2749,18 @@ class MessageBuilder {
      *   title: string,
      *   description: string
      * };
-     * const card = MessageBuilder.attachAdaptiveCard<CardData>(() => {
-     *     return {
-     *       title: "sample card title",
-     *       description: "sample card description"
-     *     }}, cardTemplate);
+     * const card = MessageBuilder.attachAdaptiveCard<CardData>(
+     *   cardTemplate, {
+     *   title: "sample card title",
+     *   description: "sample card description"
+     * });
      * ```
      *
      * @beta
      */
-    static attachAdaptiveCard(getCardData, cardTemplate) {
-        const cardData = getCardData();
+    static attachAdaptiveCard(cardTemplate, data) {
         return {
-            attachments: [botbuilder.CardFactory.adaptiveCard(AdaptiveCards.declare(cardTemplate).render(cardData))],
+            attachments: [botbuilder.CardFactory.adaptiveCard(AdaptiveCards.declare(cardTemplate).render(data))],
         };
     }
     /**
@@ -2805,6 +2868,7 @@ class MessageBuilder {
 }
 
 exports.AppCredential = AppCredential;
+exports.BasicAuthProvider = BasicAuthProvider;
 exports.BearerTokenAuthProvider = BearerTokenAuthProvider;
 exports.CertificateAuthProvider = CertificateAuthProvider;
 exports.Channel = Channel;