@microsoft/teamsfx 0.5.1 → 0.5.2-alpha.0535e2d27.0

package/dist/index.esm5.js

@@ -1,5 +1,5 @@
-import jwt_decode from 'jwt-decode';
 import { __awaiter } from 'tslib';
+import jwt_decode from 'jwt-decode';
 import * as microsoftTeams from '@microsoft/teams-js';
 import { PublicClientApplication } from '@azure/msal-browser';
 import { Client } from '@microsoft/microsoft-graph-client';
@@ -60,6 +60,10 @@ var ErrorCode;
      * Invalid response error.
      */
     ErrorCode["InvalidResponse"] = "InvalidResponse";
+    /**
+     * Identity type error.
+     */
+    ErrorCode["IdentityTypeNotSupported"] = "IdentityTypeNotSupported";
 })(ErrorCode || (ErrorCode = {}));
 /**
  * @internal
@@ -79,6 +83,8 @@ ErrorMessage.NodejsRuntimeNotSupported = "{0} is not supported in Node.";
 ErrorMessage.FailToAcquireTokenOnBehalfOfUser = "Failed to acquire access token on behalf of user: {0}";
 // ChannelNotSupported Error
 ErrorMessage.OnlyMSTeamsChannelSupported = "{0} is only supported in MS Teams Channel";
+// IdentityTypeNotSupported Error
+ErrorMessage.IdentityTypeNotSupported = "{0} identity is not supported in {1}";
 /**
  * Error class with code and message thrown by the SDK.
  *
@@ -105,26 +111,6 @@ class ErrorWithCode extends Error {
     }
 }
 
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Available resource type.
- * @beta
- */
-var ResourceType;
-(function (ResourceType) {
-    /**
-     * SQL database.
-     *
-     */
-    ResourceType[ResourceType["SQL"] = 0] = "SQL";
-    /**
-     * Rest API.
-     *
-     */
-    ResourceType[ResourceType["API"] = 1] = "API";
-})(ResourceType || (ResourceType = {}));
-
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 /**
@@ -404,131 +390,6 @@ function validateScopesType(value) {
     const errorMsg = "The type of scopes is not valid, it must be string or string array";
     internalLogger.error(errorMsg);
     throw new ErrorWithCode(errorMsg, ErrorCode.InvalidParameter);
-}
-/**
- * @internal
- */
-const isNode = typeof process !== "undefined" &&
-    !!process.version &&
-    !!process.versions &&
-    !!process.versions.node;
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Global configuration instance
- *
- */
-let config;
-/**
- * Initialize configuration from environment variables or configuration object and set the global instance
- *
- * @param {Configuration} configuration - Optional configuration that overrides the default configuration values. The override depth is 1.
- *
- * @throws {@link ErrorCode|InvalidParameter} when configuration is not passed in browser environment
- *
- * @beta
- */
-function loadConfiguration(configuration) {
-    internalLogger.info("load configuration");
-    // browser environment
-    if (!isNode) {
-        if (!configuration) {
-            const errorMsg = "You are running the code in browser. Configuration must be passed in.";
-            internalLogger.error(errorMsg);
-            throw new ErrorWithCode(errorMsg, ErrorCode.InvalidParameter);
-        }
-        config = configuration;
-        return;
-    }
-    // node environment
-    let newAuthentication;
-    let newResources = [];
-    const defaultResourceName = "default";
-    if (configuration === null || configuration === void 0 ? void 0 : configuration.authentication) {
-        newAuthentication = configuration.authentication;
-    }
-    else {
-        newAuthentication = {
-            authorityHost: process.env.M365_AUTHORITY_HOST,
-            tenantId: process.env.M365_TENANT_ID,
-            clientId: process.env.M365_CLIENT_ID,
-            clientSecret: process.env.M365_CLIENT_SECRET,
-            simpleAuthEndpoint: process.env.SIMPLE_AUTH_ENDPOINT,
-            initiateLoginEndpoint: process.env.INITIATE_LOGIN_ENDPOINT,
-            applicationIdUri: process.env.M365_APPLICATION_ID_URI,
-        };
-    }
-    if (configuration === null || configuration === void 0 ? void 0 : configuration.resources) {
-        newResources = configuration.resources;
-    }
-    else {
-        newResources = [
-            {
-                // SQL resource
-                type: ResourceType.SQL,
-                name: defaultResourceName,
-                properties: {
-                    sqlServerEndpoint: process.env.SQL_ENDPOINT,
-                    sqlUsername: process.env.SQL_USER_NAME,
-                    sqlPassword: process.env.SQL_PASSWORD,
-                    sqlDatabaseName: process.env.SQL_DATABASE_NAME,
-                    sqlIdentityId: process.env.IDENTITY_ID,
-                },
-            },
-            {
-                // API resource
-                type: ResourceType.API,
-                name: defaultResourceName,
-                properties: {
-                    endpoint: process.env.API_ENDPOINT,
-                },
-            },
-        ];
-    }
-    config = {
-        authentication: newAuthentication,
-        resources: newResources,
-    };
-}
-/**
- * Get configuration for a specific resource.
- * @param {ResourceType} resourceType - The type of resource
- * @param {string} resourceName - The name of resource, default value is "default".
- *
- * @returns Resource configuration for target resource from global configuration instance.
- *
- * @throws {@link ErrorCode|InvalidConfiguration} when resource configuration with the specific type and name is not found
- *
- * @beta
- */
-function getResourceConfiguration(resourceType, resourceName = "default") {
-    var _a;
-    internalLogger.info(`Get resource configuration of ${ResourceType[resourceType]} from ${resourceName}`);
-    const result = (_a = config.resources) === null || _a === void 0 ? void 0 : _a.find((item) => item.type === resourceType && item.name === resourceName);
-    if (result) {
-        return result.properties;
-    }
-    const errorMsg = formatString(ErrorMessage.MissingResourceConfiguration, ResourceType[resourceType], resourceName);
-    internalLogger.error(errorMsg);
-    throw new ErrorWithCode(errorMsg, ErrorCode.InvalidConfiguration);
-}
-/**
- * Get configuration for authentication.
- *
- * @returns Authentication configuration from global configuration instance, the value may be undefined if no authentication config exists in current environment.
- *
- * @throws {@link ErrorCode|InvalidConfiguration} when global configuration does not exist
- *
- * @beta
- */
-function getAuthenticationConfiguration() {
-    internalLogger.info("Get authentication configuration");
-    if (config) {
-        return config.authentication;
-    }
-    const errorMsg = "Please call loadConfiguration() first before calling getAuthenticationConfiguration().";
-    internalLogger.error(errorMsg);
-    throw new ErrorWithCode(formatString(ErrorMessage.ConfigurationNotExists, errorMsg), ErrorCode.InvalidConfiguration);
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -540,16 +401,16 @@ function getAuthenticationConfiguration() {
  *
  * @beta
  */
-class M365TenantCredential {
+class AppCredential {
     /**
-     * Constructor of M365TenantCredential.
+     * Constructor of AppCredential.
      *
      * @remarks
      * Only works in in server side.
      * @beta
      */
-    constructor() {
-        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "M365TenantCredential"), ErrorCode.RuntimeNotSupported);
+    constructor(authConfig) {
+        throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "AppCredential"), ErrorCode.RuntimeNotSupported);
     }
     /**
      * Get access token for credential.
@@ -560,7 +421,7 @@ class M365TenantCredential {
      */
     getToken(scopes, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "M365TenantCredential"), ErrorCode.RuntimeNotSupported);
+            throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "AppCredential"), ErrorCode.RuntimeNotSupported);
         });
     }
 }
@@ -582,7 +443,7 @@ class OnBehalfOfUserCredential {
      * Can Only works in in server side.
      * @beta
      */
-    constructor(ssoToken) {
+    constructor(ssoToken, config) {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "OnBehalfOfUserCredential"), ErrorCode.RuntimeNotSupported);
     }
     /**
@@ -622,7 +483,6 @@ const loginPageHeight = 535;
 class TeamsUserCredential {
     /**
      * Constructor of TeamsUserCredential.
-     * Developer need to call loadConfiguration(config) before using this class.
      *
      * @example
      * ```typescript
@@ -632,18 +492,22 @@ class TeamsUserCredential {
      *    clientId: "xxx"
      *   }
      * }
-       loadConfiguration(config); // No default config from environment variables, developers must provide the config object.
-       const credential = new TeamsUserCredential(["https://graph.microsoft.com/User.Read"]);
+     * // Use default configuration provided by Teams Toolkit
+     * const credential = new TeamsUserCredential();
+     * // Use a customized configuration
+     * const anotherCredential = new TeamsUserCredential(config);
      * ```
      *
+     * @param {AuthenticationConfiguration} authConfig - The authentication configuration. Use environment variables if not provided.
+     *
      * @throws {@link ErrorCode|InvalidConfiguration} when client id, initiate login endpoint or simple auth endpoint is not found in config.
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is nodeJS.
      *
      * @beta
      */
-    constructor() {
+    constructor(authConfig) {
         internalLogger.info("Create teams user credential");
-        this.config = this.loadAndValidateConfig();
+        this.config = this.loadAndValidateConfig(authConfig);
         this.ssoToken = null;
         this.initialized = false;
     }
@@ -912,15 +776,13 @@ class TeamsUserCredential {
     }
     /**
      * Load and validate authentication configuration
+     *
+     * @param {AuthenticationConfiguration?} config - The authentication configuration. Use environment variables if not provided.
+     *
      * @returns Authentication configuration
      */
-    loadAndValidateConfig() {
+    loadAndValidateConfig(config) {
         internalLogger.verbose("Validate authentication configuration");
-        const config = getAuthenticationConfiguration();
-        if (!config) {
-            internalLogger.error(ErrorMessage.AuthenticationConfigurationNotExists);
-            throw new ErrorWithCode(ErrorMessage.AuthenticationConfigurationNotExists, ErrorCode.InvalidConfiguration);
-        }
         if (config.initiateLoginEndpoint && config.clientId) {
             return config;
         }
@@ -973,7 +835,7 @@ class MsGraphAuthProvider {
     /**
      * Constructor of MsGraphAuthProvider.
      *
-     * @param {TokenCredential} credential - Credential used to invoke Microsoft Graph APIs.
+     * @param {TeamsFx} teamsfx - Used to provide configuration and auth.
      * @param {string | string[]} scopes - The list of scopes for which the token will have access.
      *
      * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
@@ -982,8 +844,8 @@ class MsGraphAuthProvider {
      *
      * @beta
      */
-    constructor(credential, scopes) {
-        this.credential = credential;
+    constructor(teamsfx, scopes) {
+        this.teamsfx = teamsfx;
         let scopesStr = defaultScope;
         if (scopes) {
             validateScopesType(scopes);
@@ -1010,7 +872,7 @@ class MsGraphAuthProvider {
     getAccessToken() {
         return __awaiter(this, void 0, void 0, function* () {
             internalLogger.info(`Get Graph Access token with scopes: '${this.scopes}'`);
-            const accessToken = yield this.credential.getToken(this.scopes);
+            const accessToken = yield this.teamsfx.getCredential().getToken(this.scopes);
             return new Promise((resolve, reject) => {
                 if (accessToken) {
                     resolve(accessToken.token);
@@ -1068,7 +930,7 @@ class MsGraphAuthProvider {
  * }
  * ```
  *
- * @param {TokenCredential} credential - token credential instance.
+ * @param {TeamsFx} teamsfx - Used to provide configuration and auth.
  * @param scopes - The array of Microsoft Token scope of access. Default value is `[.default]`.
  *
  * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
@@ -1077,36 +939,26 @@ class MsGraphAuthProvider {
  *
  * @beta
  */
-function createMicrosoftGraphClient(credential, scopes) {
+function createMicrosoftGraphClient(teamsfx, scopes) {
     internalLogger.info("Create Microsoft Graph Client");
-    const authProvider = new MsGraphAuthProvider(credential, scopes);
+    const authProvider = new MsGraphAuthProvider(teamsfx, scopes);
     const graphClient = Client.initWithMiddleware({
         authProvider,
     });
     return graphClient;
 }
 
+// Copyright (c) Microsoft Corporation.
 /**
  * Generate connection configuration consumed by tedious.
  * @remarks
  * Only works in in server side.
  * @beta
  */
-class DefaultTediousConnectionConfiguration {
-    constructor() {
+function getTediousConnectionConfig(teamsfx, databaseName) {
+    return __awaiter(this, void 0, void 0, function* () {
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "DefaultTediousConnectionConfiguration"), ErrorCode.RuntimeNotSupported);
-    }
-    /**
-     * Generate connection configuration consumed by tedious.
-     * @remarks
-     * Only works in in server side.
-     * @beta
-     */
-    getConfig(databaseName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "DefaultTediousConnectionConfiguration"), ErrorCode.RuntimeNotSupported);
-        });
-    }
+    });
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -1136,7 +988,6 @@ class DefaultTediousConnectionConfiguration {
  * const dialogState = convoState.createProperty('dialogState');
  * const dialogs = new DialogSet(dialogState);
  *
- * loadConfiguration();
  * dialogs.add(new TeamsBotSsoPrompt('TeamsBotSsoPrompt', {
  *    scopes: ["User.Read"],
  * }));
@@ -1173,7 +1024,8 @@ class TeamsBotSsoPrompt {
      *
      * @beta
      */
-    constructor(dialogId, settings) {
+    constructor(teamsfx, dialogId, settings) {
+        this.teamsfx = teamsfx;
         this.settings = settings;
         throw new ErrorWithCode(formatString(ErrorMessage.BrowserRuntimeNotSupported, "TeamsBotSsoPrompt"), ErrorCode.RuntimeNotSupported);
     }
@@ -1223,5 +1075,125 @@ class TeamsBotSsoPrompt {
     }
 }
 
-export { DefaultTediousConnectionConfiguration, ErrorCode, ErrorWithCode, LogLevel, M365TenantCredential, MsGraphAuthProvider, OnBehalfOfUserCredential, ResourceType, TeamsBotSsoPrompt, TeamsUserCredential, createMicrosoftGraphClient, getAuthenticationConfiguration, getLogLevel, getResourceConfiguration, loadConfiguration, setLogFunction, setLogLevel, setLogger };
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Identity type to use in authentication.
+ *
+ * @beta
+ */
+var IdentityType;
+(function (IdentityType) {
+    /**
+     * Represents the current user of Teams.
+     */
+    IdentityType["User"] = "User";
+    /**
+     * Represents the application itself.
+     */
+    IdentityType["App"] = "Application";
+})(IdentityType || (IdentityType = {}));
+
+// Copyright (c) Microsoft Corporation.
+/**
+ * A class providing credential and configuration.
+ * @beta
+ */
+class TeamsFx {
+    constructor(identityType, customConfig) {
+        this.identityType = identityType !== null && identityType !== void 0 ? identityType : IdentityType.User;
+        if (this.identityType !== IdentityType.User) {
+            const errorMsg = formatString(ErrorMessage.IdentityTypeNotSupported, this.identityType.toString(), "TeamsFx");
+            internalLogger.error(errorMsg);
+            throw new ErrorWithCode(errorMsg, ErrorCode.IdentityTypeNotSupported);
+        }
+        this.configuration = new Map();
+        this.loadFromEnv();
+        if (customConfig) {
+            for (const key of Object.keys(customConfig)) {
+                const value = customConfig[key];
+                if (value) {
+                    this.configuration.set(key, value);
+                }
+            }
+        }
+        if (this.configuration.size === 0) {
+            internalLogger.warn("No configuration is loaded, please pass required configs to TeamsFx constructor");
+        }
+    }
+    loadFromEnv() {
+        if (window && window.__env__) {
+            // testing purpose
+            const env = window.__env__;
+            this.configuration.set("authorityHost", env.REACT_APP_AUTHORITY_HOST);
+            this.configuration.set("tenantId", env.REACT_APP_TENANT_ID);
+            this.configuration.set("clientId", env.REACT_APP_CLIENT_ID);
+            this.configuration.set("initiateLoginEndpoint", env.REACT_APP_START_LOGIN_PAGE_URL);
+            this.configuration.set("applicationIdUri", env.M365_APPLICATION_ID_URI);
+            this.configuration.set("apiEndpoint", env.REACT_APP_FUNC_ENDPOINT);
+            this.configuration.set("apiName", env.REACT_APP_FUNC_NAME);
+        }
+        else {
+            // TODO: support common environment variable name
+            try {
+                this.configuration.set("authorityHost", process.env.REACT_APP_AUTHORITY_HOST);
+                this.configuration.set("tenantId", process.env.REACT_APP_TENANT_ID);
+                this.configuration.set("clientId", process.env.REACT_APP_CLIENT_ID);
+                this.configuration.set("initiateLoginEndpoint", process.env.REACT_APP_START_LOGIN_PAGE_URL);
+                this.configuration.set("applicationIdUri", process.env.M365_APPLICATION_ID_URI);
+                this.configuration.set("apiEndpoint", process.env.REACT_APP_FUNC_ENDPOINT);
+                this.configuration.set("apiName", process.env.REACT_APP_FUNC_NAME);
+            }
+            catch (_) {
+                internalLogger.warn("Cannot read process.env, please use webpack if you want to use environment variables.");
+                return;
+            }
+        }
+    }
+    getIdentityType() {
+        return this.identityType;
+    }
+    getCredential() {
+        if (!this.teamsUserCredential) {
+            this.teamsUserCredential = new TeamsUserCredential(Object.fromEntries(this.configuration));
+        }
+        return this.teamsUserCredential;
+    }
+    getUserInfo() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.getCredential().getUserInfo();
+        });
+    }
+    login(scopes) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.getCredential().login(scopes);
+        });
+    }
+    setSsoToken(ssoToken) {
+        return this;
+    }
+    getConfig(key) {
+        const value = this.configuration.get(key);
+        if (!value) {
+            throw new Error();
+        }
+        return value;
+    }
+    hasConfig(key) {
+        const value = this.configuration.get(key);
+        return !!value;
+    }
+    getConfigs() {
+        const config = {};
+        for (const key of this.configuration.keys()) {
+            const value = this.configuration.get(key);
+            if (value) {
+                config[key] = value;
+            }
+        }
+        return config;
+    }
+}
+
+export { AppCredential, ErrorCode, ErrorWithCode, IdentityType, LogLevel, MsGraphAuthProvider, OnBehalfOfUserCredential, TeamsBotSsoPrompt, TeamsFx, TeamsUserCredential, createMicrosoftGraphClient, getLogLevel, getTediousConnectionConfig, setLogFunction, setLogLevel, setLogger };
 //# sourceMappingURL=index.esm5.js.map