@microsoft/teamsfx 0.6.3-alpha.f018de6e6.0 → 0.6.3-alpha.f6638b461.0

package/dist/index.node.cjs.js

@@ -132,6 +132,8 @@ 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.
  *
@@ -1487,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
      */
@@ -1497,7 +1499,7 @@ 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.
@@ -1530,8 +1532,11 @@ class BearerTokenAuthProvider {
 class BasicAuthProvider {
     /**
      *
-     * @param userName - Username used in basic auth
-     * @param password - Password used in basic auth
+     * @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
      */
@@ -1548,12 +1553,13 @@ class BasicAuthProvider {
     /**
      * 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 or auth property already exists in request configuration.
+     * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
      *
      * @beta
      */
@@ -1574,6 +1580,92 @@ class BasicAuthProvider {
     }
 }
 
+// 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
@@ -1585,6 +1677,8 @@ 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) {
@@ -1630,15 +1724,14 @@ class CertificateAuthProvider {
  *
  * @param { string | Buffer } cert - The cert chain in PEM format
  * @param { string | Buffer } key - The private key for the cert chain
- * @param { string? } passphrase - The passphrase for private key
- * @param { string? | Buffer? } ca - Overrides the trusted CA certificates
+ * @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, passphrase, ca) {
+function createPemCertOption(cert, key, options) {
     if (cert.length === 0) {
         throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "cert"), exports.ErrorCode.InvalidParameter);
     }
@@ -1648,32 +1741,48 @@ function createPemCertOption(cert, key, passphrase, ca) {
     return {
         cert,
         key,
-        passphrase,
-        ca,
+        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 { string? } passphrase - Optional. The passphrase 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, passphrase) {
+function createPfxCertOption(pfx, options) {
     if (pfx.length === 0) {
         throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "pfx"), exports.ErrorCode.InvalidParameter);
     }
     return {
         pfx,
-        passphrase,
+        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
@@ -1851,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]);
         });
     }
 }
@@ -1889,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);
@@ -1918,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") {
@@ -2867,6 +2966,7 @@ class MessageBuilder {
     }
 }
 
+exports.ApiKeyProvider = ApiKeyProvider;
 exports.AppCredential = AppCredential;
 exports.BasicAuthProvider = BasicAuthProvider;
 exports.BearerTokenAuthProvider = BearerTokenAuthProvider;