@microsoft/teamsfx 0.6.3-alpha.ffd3f8bc7.0 → 0.6.3-beta.016f72ed1.0

package/dist/index.esm2017.mjs

@@ -102,6 +102,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.
  *
@@ -1433,7 +1435,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
      */
@@ -1443,7 +1445,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.
@@ -1474,8 +1476,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
      */
@@ -1492,12 +1497,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
      */
@@ -1516,6 +1522,90 @@ 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"), ErrorCode.InvalidParameter);
+        }
+        if (!keyValue) {
+            throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "keyVaule"), 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
+     */
+    async AddAuthenticationInfo(config) {
+        switch (this.keyLocation) {
+            case ApiKeyLocation.Header:
+                if (!config.headers) {
+                    config.headers = {};
+                }
+                if (config.headers[this.keyName]) {
+                    throw new ErrorWithCode(formatString(ErrorMessage.DuplicateApiKeyInHeader, this.keyName), ErrorCode.AuthorizationInfoAlreadyExists);
+                }
+                config.headers[this.keyName] = this.keyValue;
+                break;
+            case 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), ErrorCode.AuthorizationInfoAlreadyExists);
+                }
+                config.params[this.keyName] = this.keyValue;
+                break;
+        }
+        return config;
+    }
+}
+/**
+ * Define available location for API Key location
+ *
+ * @beta
+ */
+var ApiKeyLocation;
+(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";
+})(ApiKeyLocation || (ApiKeyLocation = {}));
+
 // Copyright (c) Microsoft Corporation.
 /**
  * Provider that handles Certificate authentication
@@ -1527,6 +1617,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) {
@@ -1570,15 +1662,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"), ErrorCode.InvalidParameter);
     }
@@ -1588,28 +1679,28 @@ 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"), ErrorCode.InvalidParameter);
     }
     return {
         pfx,
-        passphrase,
+        passphrase: options === null || options === void 0 ? void 0 : options.passphrase,
     };
 }
 
@@ -2777,5 +2868,5 @@ class MessageBuilder {
     }
 }
 
-export { AppCredential, BasicAuthProvider, BearerTokenAuthProvider, CertificateAuthProvider, Channel, CommandBot, ConversationBot, ErrorCode, ErrorWithCode, IdentityType, LogLevel, Member, MessageBuilder, MsGraphAuthProvider, NotificationBot, OnBehalfOfUserCredential, TeamsBotInstallation, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createApiClient, createMicrosoftGraphClient, createPemCertOption, createPfxCertOption, getLogLevel, getTediousConnectionConfig, sendAdaptiveCard, sendMessage, setLogFunction, setLogLevel, setLogger };
+export { ApiKeyLocation, ApiKeyProvider, AppCredential, BasicAuthProvider, BearerTokenAuthProvider, CertificateAuthProvider, Channel, CommandBot, ConversationBot, ErrorCode, ErrorWithCode, IdentityType, LogLevel, Member, MessageBuilder, MsGraphAuthProvider, NotificationBot, OnBehalfOfUserCredential, TeamsBotInstallation, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createApiClient, createMicrosoftGraphClient, createPemCertOption, createPfxCertOption, getLogLevel, getTediousConnectionConfig, sendAdaptiveCard, sendMessage, setLogFunction, setLogLevel, setLogger };
 //# sourceMappingURL=index.esm2017.mjs.map