@microsoft/teamsfx 0.6.3-alpha.768a76f6e.0 → 0.6.3-alpha.8178ded9d.0

package/dist/index.node.cjs.js

@@ -12,6 +12,7 @@ var botbuilder = require('botbuilder');
 var botbuilderDialogs = require('botbuilder-dialogs');
 var uuid = require('uuid');
 var axios = require('axios');
+var https = require('https');
 var path = require('path');
 var fs = require('fs');
 
@@ -100,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
@@ -121,6 +126,14 @@ 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}";
+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}.";
 /**
  * Error class with code and message thrown by the SDK.
  *
@@ -1476,7 +1489,7 @@ function createApiClient(apiEndpoint, authProvider) {
  */
 class BearerTokenAuthProvider {
     /**
-     * @param getToken Function that returns the content of bearer token used in http request
+     * @param { () => Promise<string> } getToken - Function that returns the content of bearer token used in http request
      *
      * @beta
      */
@@ -1486,9 +1499,13 @@ class BearerTokenAuthProvider {
     /**
      * Adds authentication info to http requests
      *
-     * @param config - Contains all the request information and can be updated to include extra authentication info.
+     * @param { AxiosRequestConfig } 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) {
@@ -1498,7 +1515,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;
@@ -1507,6 +1524,265 @@ class BearerTokenAuthProvider {
 }
 
 // Copyright (c) Microsoft Corporation.
+/**
+ * Provider that handles Basic authentication
+ *
+ * @beta
+ */
+class BasicAuthProvider {
+    /**
+     *
+     * @param { string } userName - Username used in basic auth
+     * @param { string } password - Password used in basic auth
+     *
+     * @throws {@link ErrorCode|InvalidParameter} - when username or password is empty.
+     * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
+     *
+     * @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 { AxiosRequestConfig } 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.
+     * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
+     *
+     * @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 API Key authentication
+ *
+ * @beta
+ */
+class ApiKeyProvider {
+    /**
+     *
+     * @param { string } keyName - The name of request header or query parameter that specifies API Key
+     * @param { string } keyValue - The value of API Key
+     * @param { ApiKeyLocation } keyLocation - The location of API Key: request header or query parameter.
+     *
+     * @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) {
+        if (!keyName) {
+            throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "keyName"), exports.ErrorCode.InvalidParameter);
+        }
+        if (!keyValue) {
+            throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "keyVaule"), exports.ErrorCode.InvalidParameter);
+        }
+        this.keyName = keyName;
+        this.keyValue = keyValue;
+        this.keyLocation = keyLocation;
+    }
+    /**
+     * Adds authentication info to http requests
+     *
+     * @param { AxiosRequestConfig } 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 API key already exists in request header or url query parameter.
+     * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
+     *
+     * @beta
+     */
+    AddAuthenticationInfo(config) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            switch (this.keyLocation) {
+                case exports.ApiKeyLocation.Header:
+                    if (!config.headers) {
+                        config.headers = {};
+                    }
+                    if (config.headers[this.keyName]) {
+                        throw new ErrorWithCode(formatString(ErrorMessage.DuplicateApiKeyInHeader, this.keyName), exports.ErrorCode.AuthorizationInfoAlreadyExists);
+                    }
+                    config.headers[this.keyName] = this.keyValue;
+                    break;
+                case exports.ApiKeyLocation.QueryParams:
+                    if (!config.params) {
+                        config.params = {};
+                    }
+                    const url = new URL(config.url, config.baseURL);
+                    if (config.params[this.keyName] || url.searchParams.has(this.keyName)) {
+                        throw new ErrorWithCode(formatString(ErrorMessage.DuplicateApiKeyInQueryParam, this.keyName), exports.ErrorCode.AuthorizationInfoAlreadyExists);
+                    }
+                    config.params[this.keyName] = this.keyValue;
+                    break;
+            }
+            return config;
+        });
+    }
+}
+/**
+ * Define available location for API Key location
+ *
+ * @beta
+ */
+exports.ApiKeyLocation = void 0;
+(function (ApiKeyLocation) {
+    /**
+     * The API Key is placed in request header
+     */
+    ApiKeyLocation[ApiKeyLocation["Header"] = 0] = "Header";
+    /**
+     * The API Key is placed in query parameter
+     */
+    ApiKeyLocation[ApiKeyLocation["QueryParams"] = 1] = "QueryParams";
+})(exports.ApiKeyLocation || (exports.ApiKeyLocation = {}));
+
+// Copyright (c) Microsoft Corporation.
+/**
+ * Provider that handles Certificate authentication
+ *
+ * @beta
+ */
+class CertificateAuthProvider {
+    /**
+     *
+     * @param { SecureContextOptions } certOption - information about the cert used in http requests
+     *
+     * @throws {@link ErrorCode|InvalidParameter} - when cert option is empty.
+     *
+     * @beta
+     */
+    constructor(certOption) {
+        if (certOption && Object.keys(certOption).length !== 0) {
+            this.certOption = certOption;
+        }
+        else {
+            throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "certOption"), exports.ErrorCode.InvalidParameter);
+        }
+    }
+    /**
+     * Adds authentication info to http requests.
+     *
+     * @param { AxiosRequestConfig } 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|InvalidParameter} - when custom httpsAgent in the request has duplicate properties with certOption provided in constructor.
+     *
+     * @beta
+     */
+    AddAuthenticationInfo(config) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            if (!config.httpsAgent) {
+                config.httpsAgent = new https.Agent(this.certOption);
+            }
+            else {
+                const existingProperties = new Set(Object.keys(config.httpsAgent.options));
+                for (const property of Object.keys(this.certOption)) {
+                    if (existingProperties.has(property)) {
+                        throw new ErrorWithCode(formatString(ErrorMessage.DuplicateHttpsOptionProperty, property), exports.ErrorCode.InvalidParameter);
+                    }
+                }
+                Object.assign(config.httpsAgent.options, this.certOption);
+            }
+            return config;
+        });
+    }
+}
+/**
+ * Helper to create SecureContextOptions from PEM format cert
+ *
+ * @param { string | Buffer } cert - The cert chain in PEM format
+ * @param { string | Buffer } key - The private key for the cert chain
+ * @param { {passphrase?: string; ca?: string | Buffer} } options - Optional settings when create the cert options.
+ *
+ * @returns Instance of SecureContextOptions
+ *
+ * @throws {@link ErrorCode|InvalidParameter} - when any parameter is empty
+ *
+ */
+function createPemCertOption(cert, key, options) {
+    if (cert.length === 0) {
+        throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "cert"), exports.ErrorCode.InvalidParameter);
+    }
+    if (key.length === 0) {
+        throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "key"), exports.ErrorCode.InvalidParameter);
+    }
+    return {
+        cert,
+        key,
+        passphrase: options === null || options === void 0 ? void 0 : options.passphrase,
+        ca: options === null || options === void 0 ? void 0 : options.ca,
+    };
+}
+/**
+ * Helper to create SecureContextOptions from PFX format cert
+ *
+ * @param { string | Buffer } pfx - The content of .pfx file
+ * @param { {passphrase?: string} } options - Optional settings when create the cert options.
+ *
+ * @returns Instance of SecureContextOptions
+ *
+ * @throws {@link ErrorCode|InvalidParameter} - when any parameter is empty
+ *
+ */
+function createPfxCertOption(pfx, options) {
+    if (pfx.length === 0) {
+        throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "pfx"), exports.ErrorCode.InvalidParameter);
+    }
+    return {
+        pfx,
+        passphrase: options === null || options === void 0 ? void 0 : options.passphrase,
+    };
+}
+
+// Copyright (c) Microsoft Corporation.
+// Following keys are used by SDK internally
+const ReservedKey = new Set([
+    "authorityHost",
+    "tenantId",
+    "clientId",
+    "clientSecret",
+    "initiateLoginEndpoint",
+    "applicationIdUri",
+    "apiEndpoint",
+    "apiName",
+    "sqlServerEndpoint",
+    "sqlUsername",
+    "sqlPassword",
+    "sqlDatabaseName",
+    "sqlIdentityId",
+]);
 /**
  * A class providing credential and configuration.
  * @beta
@@ -1684,10 +1960,10 @@ class TeamsFx {
         this.configuration.set("sqlDatabaseName", env.SQL_DATABASE_NAME);
         this.configuration.set("sqlIdentityId", env.IDENTITY_ID);
         Object.keys(env).forEach((key) => {
-            const value = env[key];
-            if (key.startsWith("TEAMSFX_") && value) {
-                this.configuration.set(key.substring(8), value);
+            if (ReservedKey.has(key)) {
+                internalLogger.warn(`The name of environment variable ${key} is preserved. Will not load it as configuration.`);
             }
+            this.configuration.set(key, env[key]);
         });
     }
 }
@@ -1722,13 +1998,6 @@ class NotificationMiddleware {
                     yield this.conversationReferenceStore.set(reference);
                     break;
                 }
-                case ActivityType.CurrentBotMessaged: {
-                    const reference = botbuilder.TurnContext.getConversationReference(context.activity);
-                    if (!(yield this.conversationReferenceStore.check(reference))) {
-                        yield this.conversationReferenceStore.set(reference);
-                    }
-                    break;
-                }
                 case ActivityType.CurrentBotUninstalled:
                 case ActivityType.TeamDeleted: {
                     const reference = botbuilder.TurnContext.getConversationReference(context.activity);
@@ -1751,9 +2020,6 @@ class NotificationMiddleware {
                 return ActivityType.CurrentBotUninstalled;
             }
         }
-        else if (activityType === "message") {
-            return ActivityType.CurrentBotMessaged;
-        }
         else if (activityType === "conversationUpdate") {
             const eventType = (_b = activity.channelData) === null || _b === void 0 ? void 0 : _b.eventType;
             if (eventType === "teamDeleted") {
@@ -2556,8 +2822,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
@@ -2582,19 +2848,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))],
         };
     }
     /**
@@ -2701,8 +2966,11 @@ class MessageBuilder {
     }
 }
 
+exports.ApiKeyProvider = ApiKeyProvider;
 exports.AppCredential = AppCredential;
+exports.BasicAuthProvider = BasicAuthProvider;
 exports.BearerTokenAuthProvider = BearerTokenAuthProvider;
+exports.CertificateAuthProvider = CertificateAuthProvider;
 exports.Channel = Channel;
 exports.CommandBot = CommandBot;
 exports.ConversationBot = ConversationBot;
@@ -2718,6 +2986,8 @@ exports.TeamsFx = TeamsFx;
 exports.TeamsUserCredential = TeamsUserCredential;
 exports.createApiClient = createApiClient;
 exports.createMicrosoftGraphClient = createMicrosoftGraphClient;
+exports.createPemCertOption = createPemCertOption;
+exports.createPfxCertOption = createPfxCertOption;
 exports.getLogLevel = getLogLevel;
 exports.getTediousConnectionConfig = getTediousConnectionConfig;
 exports.sendAdaptiveCard = sendAdaptiveCard;