npm - @microsoft/teamsfx-core - Versions diffs - 1.8.0 → 1.8.1-alpha.324752dff.0 - Mend

@microsoft/teamsfx-core 1.8.0 → 1.8.1-alpha.324752dff.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (527) hide show

package/templates/plugins/resource/aad/auth/bot/ts/public/auth-end.html CHANGED Viewed

@@ -1,3 +1,6 @@
+<!--This file is auto generated by Teams Toolkit to provide you instructions and reference code to implement single sign on. -->
+<!--This file is used during the Teams Bot authentication flow to assist with retrieval of the access token.-->
+<!--If you're not familiar with this, do not alter or remove this file from your project.-->
 <html>
   <head>
     <title>Login End Page</title>
@@ -34,7 +37,7 @@
       // Parse hash parameters into key-value pairs
       function getHashParameters() {
-        let hashParams = {};
+        let hashParams = new Map();
         location.hash
           .substr(1)
           .split("&")

package/templates/plugins/resource/aad/auth/bot/ts/public/auth-start.html CHANGED Viewed

@@ -1,3 +1,4 @@
+<!--This file is auto generated by Teams Toolkit to provide you instructions and reference code to implement single sign on. -->
 <!--This file is used during the Teams Bot authentication flow to assist with retrieval of the access token.-->
 <!--If you're not familiar with this, do not alter or remove this file from your project.-->
 <html>

package/templates/plugins/resource/aad/auth/bot/ts/sso/showUserInfo.ts CHANGED Viewed

@@ -1,16 +1,30 @@
+// This file is auto generated by Teams Toolkit to provide you instructions and reference code to implement single sign on.
+// This file implements a function to call Graph API with TeamsFx SDK to get user profile with SSO token.
+// You can modify this file to add your business with SSO token.
+// See https://aka.ms/teamsfx-add-sso to learn more about adding new command to your bot.
 import { createMicrosoftGraphClient, TeamsFx } from "@microsoft/teamsfx";
 import { TurnContext } from "botbuilder";
 import { DialogTurnResult } from "botbuilder-dialogs";
+// If you need extra parameters, you can add param in `addCommand`
 export async function showUserInfo(
   context: TurnContext,
-  ssoToken: string
+  ssoToken: string,
+  param: any[]
 ): Promise<DialogTurnResult> {
   await context.sendActivity("Retrieving user information from Microsoft Graph ...");
+  // Init TeamsFx instance with SSO token
   const teamsfx = new TeamsFx().setSsoToken(ssoToken);
+  // Add scope for your Azure AD app. For example: Mail.Read, etc.
   const graphClient = createMicrosoftGraphClient(teamsfx, ["User.Read"]);
+  // Call graph api use `graph` instance to get user profile information
   const me = await graphClient.api("/me").get();
   if (me) {
+    // Bot will send the user profile info to user
     await context.sendActivity(
       `You're logged in as ${me.displayName} (${me.userPrincipalName})${
         me.jobTitle ? `; your job title is: ${me.jobTitle}` : ""

package/templates/plugins/resource/aad/auth/bot/ts/sso/ssoDialog.ts CHANGED Viewed

@@ -1,3 +1,8 @@
+// This file is auto generated by Teams Toolkit to provide you instructions and reference code to implement single sign on.
+// This file implements a `ComponentDialog` class for Single Sign On.
+// See https://docs.microsoft.com/javascript/api/botbuilder-dialogs/componentdialog?view=botbuilder-ts-latest for more about `ComponentDialog`.
+// If you are not familiar with this, do not remove or update this file.
 import {
   ComponentDialog,
   WaterfallDialog,
@@ -45,7 +50,12 @@ export class SsoDialog extends ComponentDialog {
   public addCommand(
     commandId: string,
     commandText: string | RegExp,
-    operation: (context: TurnContext, ssoToken: string) => Promise<DialogTurnResult>
+    operation: (
+      context: TurnContext,
+      ssoToken: string,
+      ...param: any[]
+    ) => Promise<DialogTurnResult>,
+    ...param: any[]
   ): void {
     const dialog = new WaterfallDialog(commandId, [
       this.ssoStep.bind(this),
@@ -53,12 +63,18 @@ export class SsoDialog extends ComponentDialog {
       async (stepContext: any) => {
         const tokenResponse: TeamsBotSsoPromptTokenResponse = stepContext.result;
         const context: TurnContext = stepContext.context;
-        if (tokenResponse) {
-          await operation(context, tokenResponse.ssoToken);
-        } else {
+        try {
+          if (tokenResponse) {
+            await operation(context, tokenResponse.ssoToken, param);
+          } else {
+            await context.sendActivity("Failed to retrieve user token from conversation context.");
+          }
+          return await stepContext.endDialog();
+        } catch (error) {
           await context.sendActivity("Failed to retrieve user token from conversation context.");
+          await context.sendActivity(error.message);
+          return await stepContext.endDialog();
         }
-        return await stepContext.endDialog();
       },
     ]);
@@ -99,20 +115,35 @@ export class SsoDialog extends ComponentDialog {
     if (commandId) {
       return await stepContext.beginDialog(commandId);
     }
+    await stepContext.context.sendActivity(`Cannot find command: ${text}`);
     return await stepContext.endDialog();
   }
   private async ssoStep(stepContext: any) {
-    return await stepContext.beginDialog(TEAMS_SSO_PROMPT_ID);
+    try {
+      return await stepContext.beginDialog(TEAMS_SSO_PROMPT_ID);
+    } catch (error) {
+      const context = stepContext.context;
+      await context.sendActivity("Failed to run SSO step");
+      await context.sendActivity(error.message);
+      return await stepContext.endDialog();
+    }
   }
   private async dedupStep(stepContext: any) {
-    const tokenResponse = stepContext.result;
-    // Only dedup after ssoStep to make sure that all Teams client would receive the login request
-    if (tokenResponse && (await this.shouldDedup(stepContext.context))) {
-      return Dialog.EndOfTurn;
+    try {
+      const tokenResponse = stepContext.result;
+      // Only dedup after ssoStep to make sure that all Teams client would receive the login request
+      if (tokenResponse && (await this.shouldDedup(stepContext.context))) {
+        return Dialog.EndOfTurn;
+      }
+      return await stepContext.next(tokenResponse);
+    } catch (error) {
+      const context = stepContext.context;
+      await context.sendActivity("Failed to run dedup step");
+      await context.sendActivity(error.message);
+      return await stepContext.endDialog();
     }
-    return await stepContext.next(tokenResponse);
   }
   public async onEndDialog(context: TurnContext) {

package/templates/plugins/resource/aad/auth/bot/ts/sso/teamsSsoBot.ts CHANGED Viewed

@@ -1,3 +1,8 @@
+// This file is auto generated by Teams Toolkit to provide you instructions and reference code to implement single sign on.
+// This file implements a `TeamsActivityHandler` class using `ssoDialog` and add `showUserInfo` as a command.
+// See https://docs.microsoft.com/javascript/api/botbuilder/teamsactivityhandler?view=botbuilder-ts-latest for more about `TeamsActivityHandler`.
+// You can add your own command that requires SSO in this file.
 import {
   BotState,
   ConversationState,
@@ -33,7 +38,8 @@ export class TeamsSsoBot extends TeamsActivityHandler {
     // Add commands that requires user authentication
     this.dialog.addCommand("ShowUserProfile", "show", showUserInfo);
-    // call the `addCommand` function to add more customized commands
+    // Call the `addCommand` function to add more customized commands with your own parameters, e.g.
+    // this.dialog.addCommand("ManageToDo", new RegExp("todo\s*.*"), todoCmdHandler, param);
     this.onMessage(async (context, next) => {
       console.log("Running with Message Activity.");

package/templates/plugins/resource/aad/auth/tab/README.md CHANGED Viewed

@@ -1,15 +1,51 @@
-## How to enable SSO in TeamsFx Tab projects
+# Enable single sign-on for tab applications
-This doc will show you how to add Single sign-on (SSO) feature to TeamsFx Tab projects. Note that this article is only for Teams Toolkit Visual Studio Code Extension version after x.x.x or TeamsFx CLI version after x.x.x.
+Microsoft Teams provides a mechanism by which an application can obtain the signed-in Teams user token to access Microsoft Graph (and other APIs). Teams Toolkit facilitates this interaction by abstracting some of the Azure Active Directory flows and integrations behind some simple, high level APIs. This enables you to add single sign-on (SSO) features easily to your Teams application.
-*Note: This article is only for TeamsFx projects by Javascript and Typescript. For Dotnet, please refer to ${help link}.*
+# Changes to your project
-For more detail about SSO, please refer to the [wiki](https://aka.ms/teamsfx-add-sso-readme).
+When you added the SSO feature to your application, Teams Toolkit updated your project to support SSO:
-### What we have done in 'Add SSO' command
+After you successfully added SSO into your project, Teams Toolkit will create and modify some files that helps you implement SSO feature.
-By triggering `Add SSO` command, we will help you to setup your project to enable SSO and create `auth/tab` folder with some code snippet. For detail, please refer to the [wiki](https://aka.ms/teamsfx-add-sso-readme).
+| Action | File | Description |
+| - | - | - |
+| Create| `aad.template.json` under `templates/appPackage` | The Azure Active Directory application manifest that is used to register the application with AAD. |
+| Modify | `manifest.template.json` under `templates/appPackage` | An `webApplicationInfo` object will be added into your Teams app manifest template. This field is required by Teams when enabling SSO. |
+| Create | `auth/tab` | Reference code, redirect pages and a `README.md` file. These files are provided for reference. See below for more information. |
-### What you need to do after triggering 'Add SSO' command
+# Update your code to add SSO
-Please follow the [wiki](https://aka.ms/teamsfx-add-sso-readme) to update your source code, provision Azure AD app and deploy latest code.
+As described above, the Teams Toolkit generated some configuration to set up your application for SSO, but you need to update your application business logic to take advantage of the SSO feature as appropriate.
+1. Move `auth-start.html` and `auth-end.html` in `auth/public` folder to `tabs/public/`.
+These two HTML files are used for auth redirects.
+1. Move `sso` folder under `auth/tab` to `tabs/src/sso/`.
+    `InitTeamsFx`: This file implements a function that initialize TeamsFx SDK and will open `GetUserProfile` component after SDK is initialized.
+    `GetUserProfile`: This file implements a function that calls Microsoft Graph API to get user info.
+1. Execute the following commands under `tabs/`: `npm install @microsoft/teamsfx-react`
+1. Add the following lines to `tabs/src/components/sample/Welcome.*` to import `InitTeamsFx`:
+    ```
+    import { InitTeamsFx } from "../../sso/InitTeamsFx";
+    ```
+1. Replace the following line: `<AddSSO />` with `<InitTeamsFx />` to replace the `AddSSO` component with `InitTeamsFx` component.
+# Debug your application
+You can debug your application by pressing F5.
+Teams Toolkit will use the AAD manifest file to register a AAD application registered for SSO.
+To learn more about Teams Toolkit local debug functionalities, refer to this [document](https://docs.microsoft.com/microsoftteams/platform/toolkit/debug-local).
+# Customize AAD applications
+The AAD [manifest](https://docs.microsoft.com/azure/active-directory/develop/reference-app-manifest) allows you to customize various aspects of your application registration. You can update the manifest as needed.
+Follow this [document](https://aka.ms/teamsfx-aad-manifest#how-to-customize-the-aad-manifest-template) if you need to include additional API permissions to access your desired APIs.
+Follow this [document](https://aka.ms/teamsfx-aad-manifest#How-to-view-the-AAD-app-on-the-Azure-portal) to view your AAD application in Azure Portal.

package/templates/plugins/resource/aad/auth/tab/js/public/auth-end.html CHANGED Viewed

@@ -1,6 +1,4 @@
-<!--This file is added by us when enable SSO. Developers can use it directly, or reference this sample to create their own auth end page.-->
+<!--This file is auto generated by Teams Toolkit to provide you instructions and reference code to implement single sign on. -->
 <!--This file is used during the Teams authentication flow to assist with retrieval of the access token.-->
 <!--If you're not familiar with this, do not alter or remove this file from your project.-->
 <html>

package/templates/plugins/resource/aad/auth/tab/js/public/auth-start.html CHANGED Viewed

@@ -1,6 +1,4 @@
-<!--This file is added by us when enable SSO. Developers can use it directly, or reference this sample to create their own auth end page.-->
+<!--This file is auto generated by Teams Toolkit to provide you instructions and reference code to implement single sign on. -->
 <!--This file is used during the Teams authentication flow to assist with retrieval of the access token.-->
 <!--If you're not familiar with this, do not alter or remove this file from your project.-->
 <html>

package/templates/plugins/resource/aad/auth/tab/js/sso/GetUserProfile.jsx CHANGED Viewed

@@ -1,22 +1,34 @@
+// This file is auto generated by Teams Toolkit to provide you instructions and reference code to implement single sign on.
+// This file will use TeamsFx SDK to call Graph API to get user profile.
+// Refer to this link to learn more: https://www.npmjs.com/package/@microsoft/teamsfx-react#calling-the-microsoft-graph-api.
 import { Button } from "@fluentui/react-northstar";
-import { useGraph, useTeamsFx } from "@microsoft/teamsfx-react";
+import { useGraph } from "@microsoft/teamsfx-react";
+export function GetUserProfile(props) {
+  const { teamsfx } = {
+    teamsfx: undefined,
+    ...props,
+  };
-export function GetUserProfile() {
-  const { teamsfx } = useTeamsFx();
+  // For usage of useGraph(), please refer to: https://www.npmjs.com/package/@microsoft/teamsfx-react#usegraph.
   const { loading, error, data, reload } = useGraph(
     async (graph, teamsfx, scope) => {
       // Call graph api directly to get user profile information
       const profile = await graph.api("/me").get();
-      let photoUrl = "";
-      try {
-        const photo = await graph.api("/me/photo/$value").get();
-        photoUrl = URL.createObjectURL(photo);
-      } catch {
-        // Could not fetch photo from user's profile, return empty string as placeholder.
-      }
-      return { profile, photoUrl };
+      // You can also add following code to get your photo:
+      // let photoUrl = "";
+      // try {
+      //   const photo = await graph.api("/me/photo/$value").get();
+      //   photoUrl = URL.createObjectURL(photo);
+      // } catch {
+      //   // Could not fetch photo from user's profile, return empty string as placeholder.
+      // }
+      return { profile };
     },
+    // Add scope for your Azure AD app. For example: Mail.Read, etc.
+    // Use teamsfx instance from `InitTeamsFx`
     { scope: ["User.Read"], teamsfx: teamsfx }
   );

package/templates/plugins/resource/aad/auth/tab/js/sso/InitTeamsFx.jsx ADDED Viewed

@@ -0,0 +1,20 @@
+// This file is auto generated by Teams Toolkit to provide you instructions and reference code to implement single sign on.
+// This file will initialize TeamsFx SDK and show `GetUserProfile` component after initialization.
+import { useTeamsFx } from "@microsoft/teamsfx-react";
+import { GetUserProfile } from "./GetUserProfile";
+export function InitTeamsFx() {
+  // For usage of useTeamsFx(), please refer to: https://www.npmjs.com/package/@microsoft/teamsfx-react#useTeamsfx.
+  // You need to wait until `loading == false` to use TeamsFx SDK.
+  const { loading, error, teamsfx } = useTeamsFx();
+  return (
+    <div>
+      {!loading && error && (
+        <div className="error">Failed init TeamsFx. Please try again later.</div>
+      )}
+      {!loading && teamsfx && <GetUserProfile teamsfx={teamsfx} />}
+    </div>
+  );
+}

package/templates/plugins/resource/aad/auth/tab/ts/public/auth-end.html CHANGED Viewed

@@ -1,6 +1,4 @@
-<!--This file is added by us when enable SSO. Developers can use it directly, or reference this sample to create their own auth end page.-->
+<!--This file is auto generated by Teams Toolkit to provide you instructions and reference code to implement single sign on. -->
 <!--This file is used during the Teams authentication flow to assist with retrieval of the access token.-->
 <!--If you're not familiar with this, do not alter or remove this file from your project.-->
 <html>

package/templates/plugins/resource/aad/auth/tab/ts/public/auth-start.html CHANGED Viewed

@@ -1,6 +1,4 @@
-<!--This file is added by us when enable SSO. Developers can use it directly, or reference this sample to create their own auth end page.-->
+<!--This file is auto generated by Teams Toolkit to provide you instructions and reference code to implement single sign on. -->
 <!--This file is used during the Teams authentication flow to assist with retrieval of the access token.-->
 <!--If you're not familiar with this, do not alter or remove this file from your project.-->
 <html>

package/templates/plugins/resource/aad/auth/tab/ts/sso/GetUserProfile.tsx CHANGED Viewed

@@ -1,22 +1,35 @@
+// This file is auto generated by Teams Toolkit to provide you instructions and reference code to implement single sign on.
+// This file will use TeamsFx SDK to call Graph API to get user profile.
+// Refer to this link to learn more: https://www.npmjs.com/package/@microsoft/teamsfx-react#calling-the-microsoft-graph-api.
 import { Button } from "@fluentui/react-northstar";
-import { useGraph, useTeamsFx } from "@microsoft/teamsfx-react";
+import { TeamsFx } from "@microsoft/teamsfx";
+import { useGraph } from "@microsoft/teamsfx-react";
+export function GetUserProfile(props: { teamsfx?: TeamsFx }) {
+  const { teamsfx } = {
+    teamsfx: undefined,
+    ...props,
+  };
-export function GetUserProfile() {
-  const { teamsfx } = useTeamsFx();
+  // For usage of useGraph(), please refer to: https://www.npmjs.com/package/@microsoft/teamsfx-react#usegraph.
   const { loading, error, data, reload } = useGraph(
     async (graph, teamsfx, scope) => {
-      // Call graph api directly to get user profile information
+      // Call graph api use `graph` instance to get user profile information
       const profile = await graph.api("/me").get();
-      let photoUrl = "";
-      try {
-        const photo = await graph.api("/me/photo/$value").get();
-        photoUrl = URL.createObjectURL(photo);
-      } catch {
-        // Could not fetch photo from user's profile, return empty string as placeholder.
-      }
-      return { profile, photoUrl };
+      // You can also add following code to get your photo:
+      // let photoUrl = "";
+      // try {
+      //   const photo = await graph.api("/me/photo/$value").get();
+      //   photoUrl = URL.createObjectURL(photo);
+      // } catch {
+      //   // Could not fetch photo from user's profile, return empty string as placeholder.
+      // }
+      return { profile };
     },
+    // Add scope for your Azure AD app. For example: Mail.Read, etc.
+    // Use teamsfx instance from `InitTeamsFx`
     { scope: ["User.Read"], teamsfx: teamsfx }
   );

package/templates/plugins/resource/aad/auth/tab/ts/sso/InitTeamsFx.tsx ADDED Viewed

@@ -0,0 +1,20 @@
+// This file is auto generated by Teams Toolkit to provide you instructions and reference code to implement single sign on.
+// This file will initialize TeamsFx SDK and show `GetUserProfile` component after initialization.
+import { useTeamsFx } from "@microsoft/teamsfx-react";
+import { GetUserProfile } from "./GetUserProfile";
+export function InitTeamsFx() {
+  // For usage of useTeamsFx(), please refer to: https://www.npmjs.com/package/@microsoft/teamsfx-react#useTeamsfx.
+  // You need to wait until `loading == false` to use TeamsFx SDK.
+  const { loading, error, teamsfx } = useTeamsFx();
+  return (
+    <div>
+      {!loading && error && (
+        <div className="error">Failed init TeamsFx. Please try again later.</div>
+      )}
+      {!loading && teamsfx && <GetUserProfile teamsfx={teamsfx} />}
+    </div>
+  );
+}

package/templates/plugins/resource/apiconnector/package.json CHANGED Viewed

@@ -1,5 +1,5 @@
 {
     "dependencies": {
-        "@microsoft/teamsfx": "^0.7.0"
+        "@microsoft/teamsfx": "1.0.0-alpha.324752dff.0"
     }
 }

package/templates/plugins/resource/apiconnector/sample/headerComment.template CHANGED Viewed

@@ -6,15 +6,14 @@ Your next steps:
 2. Add your user password to TEAMSFX_API_{{capitalName}}_PASSWORD in "{{component}}/.env.teamsfx.local".
 {{else if (equals config.AuthConfig.AuthType "aad")}}
     {{#if (equals config.AuthConfig.ReuseTeamsApp false)}}
-2. Add your client secret to TEAMSFX_API_{{capitalName}}_CLIENT_SECRET in "{{component}}/.env.teamsfx.local".
+2. Replace "<your-api-scope>" in this file with actual scope required by the API.
+3. Add your client secret to TEAMSFX_API_{{capitalName}}_CLIENT_SECRET in "{{component}}/.env.teamsfx.local".
     {{else}}
 2. Replace "<your-api-scope>" in this file with actual scope required by the API.
-3. Gain consent of the required scope.
-4. Add the scope to "templates/appPackage/aad.template.json" in this project.
-   You can visit https://aka.ms/teamsfx-aad-manifest to learn more about the AAD app template.
+3. Refer https://aka.ms/teamsfx-connect-api-with-aad for configuring AAD app and consent scopes.
     {{/if}}
 {{else if (equals config.AuthConfig.AuthType "apikey")}}
-2. Add your API Key to TEAMSFX_API_{{capitalName}}_APIKEY in "{{component}}/.env.teamsfx.local".
+2. Add your API Key to TEAMSFX_API_{{capitalName}}_API_KEY in "{{component}}/.env.teamsfx.local".
 {{else if (equals config.AuthConfig.AuthType "cert")}}
 2. Add code to read your cert content and replace "<your-cert>" and "<your-private-key>" with actual value.
 {{else if (equals config.AuthConfig.AuthType "custom")}}
@@ -23,7 +22,22 @@ Your next steps:
 You can now import the API client (an Axios instance) in another file and call {{config.APIName}} APIs without worrying about authentication.
 Here is an example for a GET request to "relative_path_of_target_api":
-const result = await {{config.APIName}}Client.get("relative_path_of_target_api");
+```
+{{#if (equals languageExt "js")}}
+const { {{config.APIName}}Client } = require("relative_path_to_this_file");
+{{else}}
+import { {{config.APIName}}Client } from "relative_path_to_this_file";
+{{/if}}
+const response = await {{config.APIName}}Client.get("relative_path_of_target_api");
+// You only need to enter the relative path for your API.
+// For example, if you want to call api https://my-api-endpoint/test, and inputted https://my-api-endpoint as API endpoint,
+// the code will looks like: const response = await {{config.APIName}}Client.get("test");
+const responseBody = response.data;
+```
+If you added this API while local debugging, please stop local debugging and start again because local debugging will not hot reload changes to .env.teamsfx.local
 You can refer https://aka.ms/teamsfx-connect-api to learn more.
 */

package/templates/plugins/resource/apiconnector/sample/js/aad.template CHANGED Viewed

@@ -23,4 +23,4 @@ const {{config.APIName}}Client = teamsfxSdk.createApiClient(
   teamsFx.getConfig("TEAMSFX_API_{{capitalName}}_ENDPOINT"),
   authProvider
 );
-export { {{config.APIName}}Client };
+module.exports.{{config.APIName}}Client = {{config.APIName}}Client;

package/templates/plugins/resource/apiconnector/sample/js/apikey.template CHANGED Viewed

@@ -5,7 +5,7 @@ const teamsFx = new teamsfxSdk.TeamsFx();
 // Initializes a new axios instance to call {{config.APIName}} API.
 const authProvider = new teamsfxSdk.ApiKeyProvider(
   "{{config.AuthConfig.Name}}",
-  teamsFx.getConfig("TEAMSFX_API_FAKE_API_KEY"),
+  teamsFx.getConfig("TEAMSFX_API_{{capitalName}}_API_KEY"),
 {{#if (equals config.AuthConfig.Location "request header")}}
   teamsfxSdk.ApiKeyLocation.Header
 {{else}}
@@ -16,4 +16,4 @@ const {{config.APIName}}Client = teamsfxSdk.createApiClient(
   teamsFx.getConfig("TEAMSFX_API_{{capitalName}}_ENDPOINT"),
   authProvider
 );
-export { {{config.APIName}}Client };
+module.exports.{{config.APIName}}Client = {{config.APIName}}Client;

package/templates/plugins/resource/apiconnector/sample/js/basic.template CHANGED Viewed

@@ -11,4 +11,4 @@ const {{config.APIName}}Client = teamsfxSdk.createApiClient(
   teamsFx.getConfig("TEAMSFX_API_{{capitalName}}_ENDPOINT"),
   authProvider
 );
-export { {{config.APIName}}Client };
+module.exports.{{config.APIName}}Client = {{config.APIName}}Client;

package/templates/plugins/resource/apiconnector/sample/js/cert.template CHANGED Viewed

@@ -12,4 +12,4 @@ const {{config.APIName}}Client = teamsfxSdk.createApiClient(
   teamsFx.getConfig("TEAMSFX_API_{{capitalName}}_ENDPOINT"),
   authProvider
 );
-export { {{config.APIName}}Client };
+module.exports.{{config.APIName}}Client = {{config.APIName}}Client;

package/templates/plugins/resource/apiconnector/sample/js/custom.template CHANGED Viewed

@@ -36,4 +36,4 @@ const {{config.APIName}}Client = teamsfxSdk.createApiClient(
   teamsFx.getConfig("TEAMSFX_API_{{capitalName}}_ENDPOINT"),
   authProvider
 );
-export { {{config.APIName}}Client };
+module.exports.{{config.APIName}}Client = {{config.APIName}}Client;

package/templates/plugins/resource/apiconnector/sample/ts/aad.template CHANGED Viewed

@@ -5,7 +5,7 @@ import {
   IdentityType,
 } from "@microsoft/teamsfx";
-// Loads current app's configuration and use app for auth, the sample uses client credential flow to acquire token for your API.
+// Loads current app's configuration, the sample uses client credential flow to acquire token for your API.
 {{#if (equals config.AuthConfig.ReuseTeamsApp true)}}
 const teamsFx = new TeamsFx(IdentityType.App);
 {{else}}

package/templates/plugins/resource/apiconnector/sample/ts/apikey.template CHANGED Viewed

@@ -5,7 +5,7 @@ const teamsFx = new TeamsFx();
 // Initializes a new axios instance to call {{config.APIName}} API.
 const authProvider = new ApiKeyProvider(
   "{{config.AuthConfig.Name}}",
-  teamsFx.getConfig("TEAMSFX_API_FAKE_API_KEY"),
+  teamsFx.getConfig("TEAMSFX_API_{{capitalName}}_API_KEY"),
 {{#if (equals config.AuthConfig.Location "request header")}}
   ApiKeyLocation.Header
 {{else}}

package/templates/plugins/resource/bot/bicep/funcHostedBotProvision.template.bicep CHANGED Viewed

@@ -70,7 +70,7 @@ resource functionApp 'Microsoft.Web/sites@2021-02-01' = {
         }
         {
           name: 'FUNCTIONS_EXTENSION_VERSION'
-          value: '~3' // Use Azure Functions runtime v3
+          value: '~4' // Use Azure Functions runtime v4
         }
         {
           name: 'FUNCTIONS_WORKER_RUNTIME'
@@ -86,7 +86,7 @@ resource functionApp 'Microsoft.Web/sites@2021-02-01' = {
         }
         {
           name: 'WEBSITE_NODE_DEFAULT_VERSION'
-          value: '~14' // Set NodeJS version to 14.x
+          value: '~16' // Set NodeJS version to 16.x
         }
         {
           name: 'RUNNING_ON_AZURE'

package/templates/plugins/resource/cicd/azdo/cd.yml CHANGED Viewed

@@ -21,8 +21,9 @@ steps:
     M365_ACCOUNT_NAME: $(M365_ACCOUNT_NAME)
     M365_ACCOUNT_PASSWORD: $(M365_ACCOUNT_PASSWORD)
     M365_TENANT_ID: $(M365_TENANT_ID)
-    CI_ENABLED: 'true'
 <%/hosting_type_contains_spfx%>
+    # To enable M365 account login by environment variables and non-interactive mode.
+    CI_ENABLED: 'true'
     TEAMSFX_ENV_NAME: <%env_name%>
   inputs:
     targetType: 'inline'

package/templates/plugins/resource/cicd/jenkins/Jenkinsfile.cd CHANGED Viewed

@@ -15,10 +15,9 @@ pipeline {
         M365_ACCOUNT_NAME = credentials('M365_ACCOUNT_NAME')
         M365_ACCOUNT_PASSWORD = credentials('M365_ACCOUNT_PASSWORD')
         M365_TENANT_ID = credentials('M365_TENANT_ID')
-        // To enable M365 account login by non-interactive mode.
-        CI_ENABLED = 'true'
 <%/hosting_type_contains_spfx%>
+        // To enable M365 account login by environment variables and non-interactive mode.
+        CI_ENABLED = 'true'
         // To specify the env name for multi-env feature.
         TEAMSFX_ENV_NAME = '<%env_name%>'
     }

package/templates/plugins/resource/function/bicep/functionProvision.template.bicep CHANGED Viewed

@@ -40,7 +40,7 @@ resource functionApp 'Microsoft.Web/sites@2021-02-01' = {
         }
         {
           name: 'FUNCTIONS_EXTENSION_VERSION'
-          value: '~3' // Use Azure Functions runtime v3
+          value: '~4' // Use Azure Functions runtime v4
         }
         {
           name: 'FUNCTIONS_WORKER_RUNTIME'
@@ -56,7 +56,7 @@ resource functionApp 'Microsoft.Web/sites@2021-02-01' = {
         }
         {
           name: 'WEBSITE_NODE_DEFAULT_VERSION'
-          value: '~14' // Set NodeJS version to 14.x
+          value: '~16' // Set NodeJS version to 16.x
         }
       ]
       ftpsState: 'FtpsOnly'

package/templates/plugins/resource/hosting/bicep/botservice/botserviceProvision.template.bicep ADDED Viewed

@@ -0,0 +1,34 @@
+@secure()
+param provisionParameters object
+param botEndpoint string
+var resourceBaseName = provisionParameters.resourceBaseName
+var botAadAppClientId = provisionParameters['botAadAppClientId'] // Read AAD app client id for Azure Bot Service from parameters
+var botServiceName = contains(provisionParameters, 'botServiceName') ? provisionParameters['botServiceName'] : '${resourceBaseName}' // Try to read name for Azure Bot Service from parameters
+var botServiceSku = contains(provisionParameters, 'botServiceSku') ? provisionParameters['botServiceSku'] : 'F0' // Try to read SKU for Azure Bot Service from parameters
+var botDisplayName = contains(provisionParameters, 'botDisplayName') ? provisionParameters['botDisplayName'] : '${resourceBaseName}' // Try to read display name for Azure Bot Service from parameters
+// Register your web service as a bot with the Bot Framework
+resource botService 'Microsoft.BotService/botServices@2021-03-01' = {
+  kind: 'azurebot'
+  location: 'global'
+  name: botServiceName
+  properties: {
+    displayName: botDisplayName
+    endpoint: uri(botEndpoint, '/api/messages')
+    msaAppId: botAadAppClientId
+  }
+  sku: {
+    name: botServiceSku // You can follow https://aka.ms/teamsfx-bicep-add-param-tutorial to add botServiceSku property to provisionParameters to override the default value "F0".
+  }
+}
+// Connect the bot service to Microsoft Teams
+resource botServiceMsTeamsChannel 'Microsoft.BotService/botServices/channels@2021-03-01' = {
+  parent: botService
+  location: 'global'
+  name: 'MsTeamsChannel'
+  properties: {
+    channelName: 'MsTeamsChannel'
+  }
+}

package/templates/plugins/resource/hosting/bicep/botservice/parameters.json ADDED Viewed

@@ -0,0 +1,4 @@
+{
+  "botAadAppClientId": "{{state.fx-resource-bot.botId}}",
+  "botAadAppClientSecret": "{{state.fx-resource-bot.botPassword}}"
+}