@microsoft/teamsfx-core 3.0.10-alpha.bd1eea45e.0 → 3.0.10-alpha.edb63176e.0

package/templates/configs/local/typescript/m365agents.local.yml.tpl

@@ -0,0 +1,129 @@
+# yaml-language-server: $schema=https://aka.ms/m365-agents-toolkits/v1.11/yaml.schema.json
+# Visit https://aka.ms/teamsfx-v5.0-guide for details on this file
+# Visit https://aka.ms/teamsfx-actions for details on actions
+version: v1.11
+
+provision:
+  # Creates an app
+  - uses: teamsApp/create
+    with:
+      # app name
+      name: {{appName}}$\{{APP_NAME_SUFFIX}}
+    # Write the information of created resources into environment file for
+    # the specified environment variable(s).
+    writeToEnvironmentFile:
+      teamsAppId: TEAMS_APP_ID
+
+{{^hasAzureBot}}
+{{#hasTab}}
+  # Set BOT_DOMAIN and BOT_ENDPOINT for local launch
+  - uses: script
+    with:
+      run:
+        echo "::set-teamsfx-env BOT_DOMAIN=localhost";
+        echo "::set-teamsfx-env BOT_ENDPOINT=https://localhost:3978";
+{{/hasTab}}
+{{/hasAzureBot}}
+
+{{#hasAzureBot}}
+  # Create or reuse an existing Microsoft Entra application for bot.
+  - uses: aadApp/create
+    with:
+      # The Microsoft Entra application's display name
+      name: {{appName}}$\{{APP_NAME_SUFFIX}}
+      generateClientSecret: true
+      generateServicePrincipal: true
+      signInAudience: AzureADMultipleOrgs
+    writeToEnvironmentFile:
+      # The Microsoft Entra application's client id created for bot.
+      clientId: BOT_ID
+      # The Microsoft Entra application's client secret created for bot.
+      clientSecret: SECRET_BOT_PASSWORD
+      # The Microsoft Entra application's object id created for bot.
+      objectId: BOT_OBJECT_ID
+
+  # Create or update the bot registration on dev.botframework.com
+  - uses: botFramework/create
+    with:
+      botId: $\{{BOT_ID}}
+      name: {{appName}}
+      messagingEndpoint: $\{{BOT_ENDPOINT}}/api/messages
+      description: ""
+      channels:
+        - name: msteams
+{{/hasAzureBot}}
+
+  # Validate using manifest schema
+  - uses: teamsApp/validateManifest
+    with:
+      # Path to manifest template
+      manifestPath: ./appPackage/manifest.json
+
+  # Build app package with latest env value
+  - uses: teamsApp/zipAppPackage
+    with:
+      # Path to manifest template
+      manifestPath: ./appPackage/manifest.json
+      outputZipPath: ./appPackage/build/appPackage.$\{{TEAMSFX_ENV}}.zip
+      outputFolder: ./appPackage/build
+
+  # Validate app package using validation rules
+  - uses: teamsApp/validateAppPackage
+    with:
+      # Relative path to this file. This is the path for built zip file.
+      appPackagePath: ./appPackage/build/appPackage.$\{{TEAMSFX_ENV}}.zip
+
+  # Apply the app manifest to an existing app in Developer Portal.
+  # Will use the app id in manifest file to determine which app to update.
+  - uses: teamsApp/update
+    with:
+      # Relative path to this file. This is the path for built zip file.
+      appPackagePath: ./appPackage/build/appPackage.$\{{TEAMSFX_ENV}}.zip
+  
+{{#hasCopilot}}
+  - uses: teamsApp/extendToM365
+    with:
+      # Relative path to the build app package.
+      appPackagePath: ./appPackage/build/appPackage.$\{{TEAMSFX_ENV}}.zip
+    # Write the information of created resources into environment file for
+    # the specified environment variable(s).
+    writeToEnvironmentFile:
+      titleId: M365_TITLE_ID
+      appId: M365_APP_ID
+{{/hasCopilot}}
+
+deploy:
+{{#hasTab}}
+  # Install development tool(s)
+  - uses: devTool/install
+    with:
+      devCert:
+        trust: true
+    # Write the information of installed development tool(s) into environment
+    # file for the specified environment variable(s).
+    writeToEnvironmentFile:
+      sslCertFile: SSL_CRT_FILE
+      sslKeyFile: SSL_KEY_FILE
+
+{{/hasTab}}
+  # Run npm command
+  - uses: cli/runNpmCommand
+    name: install dependencies
+    with:
+      args: install
+
+  # Generate runtime environment variables
+  - uses: file/createOrUpdateEnvironmentFile
+    with:
+      target: ./.localConfigs
+      envs:
+        PORT: 3978
+{{#hasAzureBot}}
+        CLIENT_ID: $\{{BOT_ID}}
+        CLIENT_SECRET: $\{{SECRET_BOT_PASSWORD}}
+        TENANT_ID: $\{{TEAMS_APP_TENANT_ID}}
+{{/hasAzureBot}}
+{{#hasTab}}
+        SSL_CRT_FILE: $\{{SSL_CRT_FILE}}
+        SSL_KEY_FILE: $\{{SSL_KEY_FILE}}
+{{/hasTab}}

package/templates/configs/local/typescript/package.json

@@ -0,0 +1,8 @@
+{
+    "devDependencies": {
+        "env-cmd": "^11.0.0"
+    },
+    "scripts": {
+        "dev:teamsfx": "env-cmd --silent -f .localConfigs npm run dev"
+    }
+}

package/templates/configs/playground/python/.vscode/launch.json

@@ -0,0 +1,46 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+         {
+            "name": "Start Python",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/src/app.py",
+            "cwd": "${workspaceFolder}/src",
+            "console": "integratedTerminal"
+        },
+        {
+            "name": "Start Microsoft 365 Agents Playground",
+            "type": "node",
+            "request": "launch",
+            "program": "${workspaceFolder}/devTools/playground/node_modules/@microsoft/m365agentsplayground/cli.js",
+            "args": [
+                "start"
+            ],
+            "env": {
+            "PATH": "${workspaceFolder}/devTools/nodejs;${env:PATH}"
+            },
+            "cwd": "${workspaceFolder}",
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen"
+        }
+    ],
+    "compounds": [
+        {
+            "name": "Debug in Microsoft 365 Agents Playground",
+            "configurations": [
+                "Start Python",
+                "Start Microsoft 365 Agents Playground"
+            ],
+            "cascadeTerminateToConfigurations": [
+                "Start Microsoft 365 Agents Playground"
+            ],
+            "preLaunchTask": "Deploy (Microsoft 365 Agents Playground)",
+            "presentation": {
+                "group": "1-playground",
+                "order": 1
+            },
+            "stopAll": true
+        }
+    ]
+}

package/templates/configs/playground/python/.vscode/tasks.json

@@ -0,0 +1,35 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            // Check all required prerequisites.
+            // See https://aka.ms/teamsfx-tasks/check-prerequisites to know the details and how to customize the args.
+            "label": "Validate prerequisites (Microsoft 365 Agents Playground)",
+            "type": "teamsfx",
+            "command": "debug-check-prerequisites",
+            "args": {
+                "prerequisites": [
+                    "nodejs", // Check if Node.js is installed and the version is >= 12.
+                    "portOccupancy" // Validate available ports to ensure those debug ones are not occupied.
+                ],
+                "portOccupancy": [
+                    3978, // app service port
+                    56150, // Microsoft 365 Agents Playground port
+                ]
+            }
+        },
+        {
+            // Build project.
+            // See https://aka.ms/teamsfx-tasks/deploy to know the details and how to customize the args.
+            "label": "Deploy (Microsoft 365 Agents Playground)",
+            "dependsOn": [
+                "Validate prerequisites (Microsoft 365 Agents Playground)"
+            ],
+            "type": "teamsfx",
+            "command": "deploy",
+            "args": {
+                "env": "playground"
+            }
+        },
+    ]
+}

package/templates/configs/playground/python/env/.env.playground

@@ -0,0 +1,7 @@
+# This file includes environment variables that can be committed to git. It's gitignored by default because it represents your local development environment.
+
+# Built-in environment variables
+TEAMSFX_ENV=playground
+
+# Environment variables used by Microsoft 365 Agents Playground
+TEAMSAPPTESTER_PORT=56150

package/templates/configs/playground/python/m365agents.playground.yml

@@ -0,0 +1,14 @@
+# yaml-language-server: $schema=https://aka.ms/m365-agents-toolkits/v1.11/yaml.schema.json
+# Visit https://aka.ms/teamsfx-v5.0-guide for details on this file
+# Visit https://aka.ms/teamsfx-actions for details on actions
+version: v1.11
+
+deploy:
+  # Install development tool(s)
+  - uses: devTool/install
+    with:
+      testTool:
+        version: ~0.2.7
+        symlinkDir: ./devTools/playground
+      nodejs:
+        symlinkDir: ./devTools/nodejs

package/templates/configs/playground/typescript/.gitignore

@@ -0,0 +1,4 @@
+.localConfigs.playground
+
+# Dev tool directories
+/devTools/

package/templates/configs/playground/typescript/.vscode/launch.json

@@ -0,0 +1,31 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Attach to Local Service",
+            "type": "node",
+            "request": "attach",
+            "port": 9239,
+            "restart": true,
+            "presentation": {
+                "group": "all",
+                "hidden": true
+            },
+            "internalConsoleOptions": "neverOpen"
+        }
+    ],
+    "compounds": [
+        {
+            "name": "Debug in Microsoft 365 Agents Playground",
+            "configurations": [
+                "Attach to Local Service"
+            ],
+            "preLaunchTask": "Start App in Microsoft 365 Agents Playground",
+            "presentation": {
+                "group": "1-playground",
+                "order": 1
+            },
+            "stopAll": true
+        }
+    ]
+}

package/templates/configs/playground/typescript/.vscode/tasks.json

@@ -0,0 +1,104 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Start App in Microsoft 365 Agents Playground",
+            "dependsOn": [
+                "Validate prerequisites (Microsoft 365 Agents Playground)",
+                "Deploy (Microsoft 365 Agents Playground)",
+                "Start application (Microsoft 365 Agents Playground)",
+                "Start Microsoft 365 Agents Playground"
+            ],
+            "dependsOrder": "sequence"
+        },
+        {
+            // Check all required prerequisites.
+            // See https://aka.ms/teamsfx-tasks/check-prerequisites to know the details and how to customize the args.
+            "label": "Validate prerequisites (Microsoft 365 Agents Playground)",
+            "type": "teamsfx",
+            "command": "debug-check-prerequisites",
+            "args": {
+                "prerequisites": [
+                    "nodejs", // Validate if Node.js is installed.
+                    "portOccupancy" // Validate available ports to ensure those debug ones are not occupied.
+                ],
+                "portOccupancy": [
+                    3978, // app service port
+                    9239, // app inspector port for Node.js debugger
+                    56150 // Microsoft 365 Agents Playground port
+                ]
+            }
+        },
+        {
+            // Build project.
+            // See https://aka.ms/teamsfx-tasks/deploy to know the details and how to customize the args.
+            "label": "Deploy (Microsoft 365 Agents Playground)",
+            "type": "teamsfx",
+            "command": "deploy",
+            "args": {
+                "env": "playground"
+            }
+        },
+        {
+            "label": "Start application (Microsoft 365 Agents Playground)",
+            "type": "shell",
+            "command": "npm run dev:teamsfx:playground",
+            "isBackground": true,
+            "options": {
+                "cwd": "${workspaceFolder}"
+            },
+            "problemMatcher": {
+                "pattern": [
+                    {
+                        "regexp": "^.*$",
+                        "file": 0,
+                        "location": 1,
+                        "message": 2
+                    }
+                ],
+                "background": {
+                    "activeOnStart": true,
+                    "beginsPattern": "[nodemon] starting",
+                    "endsPattern": "listening on port 3978|Bot/ME service listening at|[nodemon] app crashed"
+                }
+            }
+        },
+        {
+            "label": "Start Microsoft 365 Agents Playground",
+            "type": "shell",
+            "command": "npm run dev:teamsfx:launch-playground",
+            "isBackground": true,
+            "options": {
+                "env": {
+                  "PATH": "${workspaceFolder}/devTools/playground/node_modules/.bin;${env:PATH}"
+                }
+            },
+            "windows": {
+                "options": {
+                    "env": {
+                        "PATH": "${workspaceFolder}/devTools/playground/node_modules/.bin;${env:PATH}"
+                    }
+                }
+            },
+            "problemMatcher": {
+                "pattern": [
+                    {
+                        "regexp": "^.*$",
+                        "file": 0,
+                        "location": 1,
+                        "message": 2
+                    }
+                ],
+                "background": {
+                    "activeOnStart": true,
+                    "beginsPattern": ".*",
+                    "endsPattern": "Listening on"
+                }
+            },
+            "presentation": {
+                "panel": "dedicated",
+                "reveal": "silent"
+            }
+        }
+    ]
+}

package/templates/configs/playground/typescript/env/.env.playground

@@ -0,0 +1,7 @@
+# This file includes environment variables that can be committed to git. It's gitignored by default because it represents your local development environment.
+
+# Built-in environment variables
+TEAMSFX_ENV=playground
+
+# Environment variables used by Microsoft 365 Agents Playground
+TEAMSAPPTESTER_PORT=56150

package/templates/configs/playground/typescript/m365agents.playground.yml

@@ -0,0 +1,23 @@
+# yaml-language-server: $schema=https://aka.ms/m365-agents-toolkits/v1.11/yaml.schema.json
+# Visit https://aka.ms/teamsfx-v5.0-guide for details on this file
+# Visit https://aka.ms/teamsfx-actions for details on actions
+version: v1.11
+
+deploy:
+  # Install development tool(s)
+  - uses: devTool/install
+    with:
+      testTool:
+        version: ~0.2.7
+        symlinkDir: ./devTools/playground
+
+  # Run npm command
+  - uses: cli/runNpmCommand
+    with:
+      args: install
+
+  - uses: file/createOrUpdateEnvironmentFile
+    with:
+      target: ./.localConfigs.playground
+      envs:
+        PORT: 3978

package/templates/configs/playground/typescript/package.json

@@ -0,0 +1,9 @@
+{
+    "devDependencies": {
+        "env-cmd": "^11.0.0"
+    },
+    "scripts": {
+        "dev:teamsfx:playground": "env-cmd --silent -f .localConfigs.playground npm run dev",
+        "dev:teamsfx:launch-playground": "env-cmd --silent -f env/.env.playground agentsplayground start"
+    }
+}

package/templates/configs/remote/python/.vscode/launch.json.tpl

@@ -0,0 +1,70 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+{{#supportCopilot}}
+        {
+            "name": "(Preview) View Remote Agent in Copilot (Edge)",
+            "type": "msedge",
+            "request": "launch",
+            "url": "https://m365.cloud.microsoft/chat/entity1-d870f6cd-4aa5-4d42-9626-ab690c041429/${agent-hint}?auth=2&${account-hint}&developerMode=Basic",
+            "presentation": {
+                "group": "3-remote",
+                "order": 1
+            },
+            "internalConsoleOptions": "neverOpen",
+            "runtimeArgs": [
+                "--remote-debugging-port=9222",
+                "--no-first-run"
+            ]
+        },
+        {
+            "name": "(Preview) View Remote Agent in Copilot (Chrome)",
+            "type": "chrome",
+            "request": "launch",
+            "url": "https://m365.cloud.microsoft/chat/entity1-d870f6cd-4aa5-4d42-9626-ab690c041429/${agent-hint}?auth=2&${account-hint}&developerMode=Basic",
+            "presentation": {
+                "group": "3-remote",
+                "order": 2
+            },
+            "internalConsoleOptions": "neverOpen",
+            "runtimeArgs": [
+                "--remote-debugging-port=9223",
+                "--no-first-run"
+            ]
+        },
+{{/supportCopilot}}
+        {
+            "name": "View Remote App in Teams (Edge)",
+            "type": "msedge",
+            "request": "launch",
+            "url": "https://teams.microsoft.com/l/app/$\{{TEAMS_APP_ID}}?installAppPackage=true&webjoin=true&${account-hint}",
+            "presentation": {
+                "group": "3-remote",
+                "order": 4
+            },
+            "internalConsoleOptions": "neverOpen"
+        },
+        {
+            "name": "View Remote App in Teams (Chrome)",
+            "type": "chrome",
+            "request": "launch",
+            "url": "https://teams.microsoft.com/l/app/$\{{TEAMS_APP_ID}}?installAppPackage=true&webjoin=true&${account-hint}",
+            "presentation": {
+                "group": "3-remote",
+                "order": 5
+            },
+            "internalConsoleOptions": "neverOpen"
+        },
+        {
+            "name": "View Remote App in Teams (Desktop)",
+            "type": "node",
+            "request": "launch",
+            "preLaunchTask": "Start App in Desktop Client (Remote)",
+            "presentation": {
+                "group": "3-remote",
+                "order": 6
+            },
+            "internalConsoleOptions": "neverOpen",
+        }
+    ]
+}

package/templates/configs/remote/python/.webappignore

@@ -0,0 +1,11 @@
+.webappignore
+.venv/
+.vscode/
+.env
+env/
+__pycache__/
+README.md
+m365agents.yml
+m365agents.local.yml
+m365agents.playground.yml
+/devTools/

package/templates/configs/remote/python/env/.env.dev

@@ -0,0 +1,11 @@
+TEAMSFX_ENV=dev
+APP_NAME_SUFFIX=dev
+
+# Updating AZURE_SUBSCRIPTION_ID or AZURE_RESOURCE_GROUP_NAME after provision may also require an update to RESOURCE_SUFFIX, because some services require a globally unique name across subscriptions/resource groups.
+AZURE_SUBSCRIPTION_ID=
+AZURE_RESOURCE_GROUP_NAME=
+RESOURCE_SUFFIX=
+
+TEAMS_APP_ID=
+BOT_ENDPOINT=
+BOT_DOMAIN=

package/templates/configs/remote/python/infra/azure.bicep.tpl

@@ -0,0 +1,108 @@
+@maxLength(20)
+@minLength(4)
+@description('Used to generate names for all resources in this file')
+param resourceBaseName string
+
+param webAppSku string
+param linuxFxVersion string
+
+param serverfarmsName string = resourceBaseName
+param webAppName string = resourceBaseName
+param location string = resourceGroup().location
+param pythonVersion string = linuxFxVersion
+{{#hasAzureBot}}
+@maxLength(42)
+param botDisplayName string
+{{/hasAzureBot}}
+
+{{#hasAzureBot}}
+resource identity 'Microsoft.ManagedIdentity/userAssignedIdentities@2023-01-31' = {
+  location: location
+  name: resourceBaseName
+}
+{{/hasAzureBot}}
+
+
+resource serverfarm 'Microsoft.Web/serverfarms@2021-02-01' = {
+  kind: 'app,linux'
+  location: location
+  name: serverfarmsName
+  sku: {
+    name: webAppSku
+  }
+  properties:{
+    reserved: true
+  }
+}
+
+resource webApp 'Microsoft.Web/sites@2021-02-01' = {
+  kind: 'app,linux'
+  location: location
+  name: webAppName
+  properties: {
+    serverFarmId: serverfarm.id
+    httpsOnly: true
+    siteConfig: {
+      alwaysOn: true
+      appCommandLine: 'python app.py'
+      linuxFxVersion: linuxFxVersion
+      appSettings: [
+        {
+          name: 'WEBSITES_CONTAINER_START_TIME_LIMIT'
+          value: '900'
+        }
+        {
+          name: 'SCM_DO_BUILD_DURING_DEPLOYMENT'
+          value: 'true'
+        }
+{{#hasAzureBot}}
+        {
+          name: 'CLIENT_ID'
+          value: identity.properties.clientId
+        }
+        {
+          name: 'TENANT_ID'
+          value: identity.properties.tenantId
+        }
+        {
+          name: 'BOT_TYPE'
+          value: 'UserAssignedMsi'
+        }
+{{/hasAzureBot}}
+      ]
+      ftpsState: 'FtpsOnly'
+    }
+  }
+{{#hasAzureBot}}
+  identity: {
+    type: 'UserAssigned'
+    userAssignedIdentities: {
+      '${identity.id}': {}
+    }
+  }
+{{/hasAzureBot}}
+}
+
+{{#hasAzureBot}}
+// Register your web service as a bot with the Bot Framework
+module azureBotRegistration './botRegistration/azurebot.bicep' = {
+  name: 'Azure-Bot-registration'
+  params: {
+    resourceBaseName: resourceBaseName
+    botDisplayName: botDisplayName
+    identityResourceId: identity.id
+    identityClientId: identity.properties.clientId
+    identityTenantId: identity.properties.tenantId
+    botAppDomain: webApp.properties.defaultHostName
+  }
+}
+{{/hasAzureBot}}
+
+// The output will be persisted in .env.{envName}. Visit https://aka.ms/teamsfx-actions/arm-deploy for more details.
+output AZURE_APP_SERVICE_RESOURCE_ID string = webApp.id // used in deploy stage
+output BOT_DOMAIN string = webApp.properties.defaultHostName
+output BOT_ENDPOINT string = 'https://${webApp.properties.defaultHostName}'
+{{#hasAzureBot}}
+output BOT_ID string = identity.properties.clientId
+output BOT_TENANT_ID string = identity.properties.tenantId
+{{/hasAzureBot}}

package/templates/configs/remote/python/infra/azure.parameters.json.tpl

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
+  "contentVersion": "1.0.0.0",
+  "parameters": {
+{{#hasAzureBot}}
+    "botDisplayName": {
+      "value": "{{appName}}"
+    },
+{{/hasAzureBot}}
+    "resourceBaseName": {
+      "value": "app$\{{RESOURCE_SUFFIX}}"
+    },
+    "webAppSku": {
+      "value": "B3"
+    },
+    "linuxFxVersion": {
+      "value": "PYTHON|3.12"
+    }
+  }
+}