@microsoft/teamsfx-core 3.0.9-rc.1 → 3.0.10-alpha.08ea48cc3.0

package/templates/configs/local/python/.vscode/tasks.json.tpl

@@ -0,0 +1,103 @@
+// This file is automatically generated by Microsoft 365 Agents Toolkit.
+// The teamsfx tasks defined in this file require Microsoft 365 Agents Toolkit version >= 5.0.0.
+// See https://aka.ms/teamsfx-tasks for details on how to customize each task.
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Start App Locally",
+            "dependsOn": [
+                "Validate prerequisites",
+{{#hasAzureBot}}
+                "Start local tunnel",
+{{/hasAzureBot}}
+                "Provision",
+                "Deploy"
+            ],
+            "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",
+            "type": "teamsfx",
+            "command": "debug-check-prerequisites",
+            "args": {
+                "prerequisites": [
+                    "m365Account", // Sign-in prompt for Microsoft 365 account, then validate if the account enables the sideloading permission.
+                    "portOccupancy" // Validate available ports to ensure those debug ones are not occupied.
+                ],
+                "portOccupancy": [
+                    3978, // tab service port
+                ]
+            }
+        },
+{{#hasAzureBot}}
+        {
+            // Start the local tunnel service to forward public URL to local port and inspect traffic.
+            // See https://aka.ms/teamsfx-tasks/local-tunnel for the detailed args definitions.
+            "label": "Start local tunnel",
+            "type": "teamsfx",
+            "command": "debug-start-local-tunnel",
+            "args": {
+                "type": "dev-tunnel",
+                "ports": [
+                    {
+                        "portNumber": 3978,
+                        "protocol": "http",
+                        "access": "public",
+                        "writeToEnvironmentFile": {
+                            "endpoint": "BOT_ENDPOINT", // output tunnel endpoint as BOT_ENDPOINT
+                            "domain": "BOT_DOMAIN" // output tunnel domain as BOT_DOMAIN
+                        }
+                    }
+                ],
+                "env": "local"
+            },
+            "isBackground": true,
+            "problemMatcher": "$teamsfx-local-tunnel-watch"
+        },
+{{/hasAzureBot}}
+        {
+            // Create the debug resources.
+            // See https://aka.ms/teamsfx-tasks/provision to know the details and how to customize the args.
+            "label": "Provision",
+            "type": "teamsfx",
+            "command": "provision",
+            "args": {
+                "env": "local"
+            }
+        },
+        {
+            // Build project.
+            // See https://aka.ms/teamsfx-tasks/deploy to know the details and how to customize the args.
+            "label": "Deploy",
+            "type": "teamsfx",
+            "command": "deploy",
+            "args": {
+                "env": "local"
+            }
+        },
+        {
+            "label": "Start App in Desktop Client",
+            "dependsOn": [
+                "Validate prerequisites",
+{{#hasAzureBot}}
+                "Start local tunnel",
+{{/hasAzureBot}}
+                "Provision",
+                "Deploy",
+                "Start desktop client"
+            ],
+            "dependsOrder": "sequence"
+        },
+        {
+            "label": "Start desktop client",
+            "type": "teamsfx",
+            "command": "launch-desktop-client",
+            "args": {
+                "url": "teams.microsoft.com/l/app/$\{{local:TEAMS_APP_ID}}?installAppPackage=true"
+            }
+        }
+    ]
+}

package/templates/configs/local/python/env/.env.local

@@ -0,0 +1,6 @@
+TEAMSFX_ENV=local
+APP_NAME_SUFFIX=local
+TEAMS_APP_ID=
+
+BOT_ENDPOINT=
+BOT_DOMAIN=

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

@@ -0,0 +1,121 @@
+# 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
+
+{{#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}}
+  # 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}}
+  # Generate runtime environment variables
+  - uses: file/createOrUpdateEnvironmentFile
+    with:
+      target: ./.env
+      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/.gitignore

@@ -0,0 +1 @@
+.localConfigs

package/templates/configs/local/typescript/.vscode/launch.json.tpl

@@ -0,0 +1,147 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Launch App in Teams (Edge)",
+            "type": "msedge",
+            "request": "launch",
+            "url": "https://teams.microsoft.com/l/app/$\{{local:TEAMS_APP_ID}}?installAppPackage=true&webjoin=true&${account-hint}",
+            "cascadeTerminateToConfigurations": [
+                "Attach to Local Service"
+            ],
+            "presentation": {
+                "group": "all",
+                "hidden": true
+            },
+            "internalConsoleOptions": "neverOpen"
+        },
+        {
+            "name": "Launch App in Teams (Chrome)",
+            "type": "chrome",
+            "request": "launch",
+            "url": "https://teams.microsoft.com/l/app/$\{{local:TEAMS_APP_ID}}?installAppPackage=true&webjoin=true&${account-hint}",
+            "cascadeTerminateToConfigurations": [
+                "Attach to Local Service"
+            ],
+            "presentation": {
+                "group": "all",
+                "hidden": true
+            },
+            "internalConsoleOptions": "neverOpen"
+        },
+{{#supportCopilot}}
+        {
+            "name": "Launch in Copilot (Edge)",
+            "type": "msedge",
+            "request": "launch",
+            "url": "https://m365.cloud.microsoft/chat/entity1-d870f6cd-4aa5-4d42-9626-ab690c041429/$\{{local:agent-hint}}?auth=2&${account-hint}&developerMode=Basic",
+            "cascadeTerminateToConfigurations": ["Attach to Local Service"],
+            "presentation": {
+                "group": "all",
+                "hidden": true
+            },
+            "internalConsoleOptions": "neverOpen",
+            "runtimeArgs": [
+                "--remote-debugging-port=9222",
+                "--no-first-run"
+            ]
+        },
+        {
+            "name": "Launch in Copilot (Chrome)",
+            "type": "chrome",
+            "request": "launch",
+            "url": "https://m365.cloud.microsoft/chat/entity1-d870f6cd-4aa5-4d42-9626-ab690c041429/$\{{local:agent-hint}}?auth=2&${account-hint}&developerMode=Basic",
+            "cascadeTerminateToConfigurations": ["Attach to Local Service"],
+            "presentation": {
+                "group": "all",
+                "hidden": true
+            },
+            "internalConsoleOptions": "neverOpen",
+            "runtimeArgs": [
+                "--remote-debugging-port=9223",
+                "--no-first-run"
+            ]
+        },
+{{/supportCopilot}}
+        {
+            "name": "Attach to Local Service",
+            "type": "node",
+            "request": "attach",
+            "port": 9239,
+            "restart": true,
+            "presentation": {
+                "group": "all",
+                "hidden": true
+            },
+            "internalConsoleOptions": "neverOpen"
+        }
+    ],
+    "compounds": [
+        {
+            "name": "Debug in Teams (Edge)",
+            "configurations": [
+                "Launch App in Teams (Edge)",
+                "Attach to Local Service"
+            ],
+            "preLaunchTask": "Start App Locally",
+            "presentation": {
+                "group": "2-local",
+                "order": 1
+            },
+            "stopAll": true
+        },
+        {
+            "name": "Debug in Teams (Chrome)",
+            "configurations": [
+                "Launch App in Teams (Chrome)",
+                "Attach to Local Service"
+            ],
+            "preLaunchTask": "Start App Locally",
+            "presentation": {
+                "group": "2-local",
+                "order": 2
+            },
+            "stopAll": true
+        },
+        {
+            "name": "Debug in Teams (Desktop)",
+            "configurations": [
+                "Attach to Local Service"
+            ],
+            "preLaunchTask": "Start App in Desktop Client",
+            "presentation": {
+                "group": "2-local",
+                "order": 3
+            },
+            "stopAll": true
+        },
+{{#supportCopilot}}
+        {
+            "name": "(Preview) Debug in Copilot (Edge)",
+            "configurations": [
+                "Launch in Copilot (Edge)",
+                "Attach to Local Service"
+            ],
+            "preLaunchTask": "Start App Locally",
+            "presentation": {
+                "group": "3-copilot",
+                "order": 1
+            },
+            "stopAll": true
+        },
+        {
+            "name": "(Preview) Debug in Copilot (Chrome)",
+            "configurations": [
+                "Launch in Copilot (Chrome)",
+                "Attach to Local Service"
+            ],
+            "preLaunchTask": "Start App Locally",
+            "presentation": {
+                "group": "3-copilot",
+                "order": 2
+            },
+            "stopAll": true
+        },
+{{/supportCopilot}}
+    ]
+}

package/templates/configs/local/typescript/.vscode/tasks.json.tpl

@@ -0,0 +1,129 @@
+// This file is automatically generated by Microsoft 365 Agents Toolkit.
+// The teamsfx tasks defined in this file require Microsoft 365 Agents Toolkit version >= 5.0.0.
+// See https://aka.ms/teamsfx-tasks for details on how to customize each task.
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Start App Locally",
+            "dependsOn": [
+                "Validate prerequisites",
+{{#hasAzureBot}}
+                "Start local tunnel",
+{{/hasAzureBot}}
+                "Provision",
+                "Deploy",
+                "Start application"
+            ],
+            "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",
+            "type": "teamsfx",
+            "command": "debug-check-prerequisites",
+            "args": {
+                "prerequisites": [
+                    "nodejs", // Validate if Node.js is installed.
+                    "m365Account", // Sign-in prompt for Microsoft 365 account, then validate if the account enables the sideloading permission.
+                    "portOccupancy" // Validate available ports to ensure those debug ones are not occupied.
+                ],
+                "portOccupancy": [
+                    3978, // tab service port,
+                    9239 // app inspector port for Node.js debugger
+                ]
+            }
+        },
+{{#hasAzureBot}}
+        {
+            // Start the local tunnel service to forward public URL to local port and inspect traffic.
+            // See https://aka.ms/teamsfx-tasks/local-tunnel for the detailed args definitions.
+            "label": "Start local tunnel",
+            "type": "teamsfx",
+            "command": "debug-start-local-tunnel",
+            "args": {
+                "type": "dev-tunnel",
+                "ports": [
+                    {
+                        "portNumber": 3978,
+                        "protocol": "http",
+                        "access": "public",
+                        "writeToEnvironmentFile": {
+                            "endpoint": "BOT_ENDPOINT", // output tunnel endpoint as BOT_ENDPOINT
+                            "domain": "BOT_DOMAIN" // output tunnel domain as BOT_DOMAIN
+                        }
+                    }
+                ],
+                "env": "local"
+            },
+            "isBackground": true,
+            "problemMatcher": "$teamsfx-local-tunnel-watch"
+        },
+{{/hasAzureBot}}
+        {
+            // Create the debug resources.
+            // See https://aka.ms/teamsfx-tasks/provision to know the details and how to customize the args.
+            "label": "Provision",
+            "type": "teamsfx",
+            "command": "provision",
+            "args": {
+                "env": "local"
+            }
+        },
+        {
+            // Build project.
+            // See https://aka.ms/teamsfx-tasks/deploy to know the details and how to customize the args.
+            "label": "Deploy",
+            "type": "teamsfx",
+            "command": "deploy",
+            "args": {
+                "env": "local"
+            }
+        },
+        {
+            "label": "Start application",
+            "type": "shell",
+            "command": "npm run dev:teamsfx",
+            "isBackground": true,
+            "options": {
+                "cwd": "${workspaceFolder}"
+            },
+            "problemMatcher": {
+                "pattern": {
+                    "regexp": "^.*$",
+                    "file": 0,
+                    "location": 1,
+                    "message": 2
+                },
+                "background": {
+                    "activeOnStart": true,
+                    "beginsPattern": ".*",
+                    "endsPattern": "listening on port 3978|[nodemon] app crashed"
+                }
+            }
+        },
+        {
+            "label": "Start App in Desktop Client",
+            "dependsOn": [
+                "Validate prerequisites",
+{{#hasAzureBot}}
+                "Start local tunnel",
+{{/hasAzureBot}}
+                "Provision",
+                "Deploy",
+                "Start application",
+                "Start desktop client"
+            ],
+            "dependsOrder": "sequence"
+        },
+        {
+            "label": "Start desktop client",
+            "type": "teamsfx",
+            "command": "launch-desktop-client",
+            "args": {
+                "url": "teams.microsoft.com/l/app/$\{{local:TEAMS_APP_ID}}?installAppPackage=true"
+            }
+        }
+    ]
+}

package/templates/configs/local/typescript/env/.env.local

@@ -0,0 +1,6 @@
+TEAMSFX_ENV=local
+APP_NAME_SUFFIX=local
+TEAMS_APP_ID=
+
+BOT_ENDPOINT=
+BOT_DOMAIN=

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"
+    }
+}