Merge branch 'master' into yo-office

Author: millerds

.vscode/tasks.json

@@ -1,6 +1,4 @@
 {
-  // See https://go.microsoft.com/fwlink/?LinkId=733558
-  // for the documentation about the tasks.json format
   "version": "2.0.0",
   "tasks": [
     {
@@ -34,7 +32,7 @@
       "script": "start:desktop -- --app excel",
       "presentation": {
         "clear": true,
-        "panel": "dedicated",
+        "panel": "dedicated"
       },
       "problemMatcher": []
     },
@@ -95,6 +93,6 @@
         "panel": "dedicated"
       },
       "problemMatcher": []
-    },
+    }
   ]
 }

README.md

@@ -16,12 +16,9 @@ Questions about Office Add-ins development in general should be posted to [Micro
 
 ## Join the Microsoft 365 Developer Program
 
-Get a free sandbox, tools, and other resources you need to build solutions for the Microsoft 365 platform.
+Join the [Microsoft 365 Developer Program](https://aka.ms/m365devprogram) to get resources and information to help you build solutions for the Microsoft 365 platform, including recommendations tailored to your areas of interest.
 
-- [Free developer sandbox](https://developer.microsoft.com/microsoft-365/dev-program#Subscription) Get a free, renewable 90-day Microsoft 365 E5 developer subscription.
-- [Sample data packs](https://developer.microsoft.com/microsoft-365/dev-program#Sample) Automatically configure your sandbox by installing user data and content to help you build your solutions.
-- [Access to experts](https://developer.microsoft.com/microsoft-365/dev-program#Experts) Access community events to learn from Microsoft 365 experts.
-- [Personalized recommendations](https://developer.microsoft.com/microsoft-365/dev-program#Recommendations) Find developer resources quickly from your personalized dashboard.
+You might also qualify for a free developer subscription that's renewable for 90 days and comes configured with sample data; for details, see the [FAQ](https://learn.microsoft.com/office/developer-program/microsoft-365-developer-program-faq#who-qualifies-for-a-microsoft-365-e5-developer-subscription-).
 
 ## Additional resources
 

assets/color.png

@@ -3,6 +3,11 @@
 const fs = require("fs");
 const path = require("path");
 const util = require("util");
+const childProcess = require("child_process");
+
+const manifestType = process.argv[2];
+const projectName = process.argv[3];
+let appId = process.argv[4];
 const testPackages = [
   "@types/mocha",
   "@types/node",
@@ -18,12 +23,13 @@ const unlinkFileAsync = util.promisify(fs.unlink);
 const writeFileAsync = util.promisify(fs.writeFile);
 
 async function removeTestInfraStructure() {
+  // Delete test folder
   deleteFolder(path.resolve(`./test`));
 
-  // delete the .github folder
+  // Delete the .github folder
   deleteFolder(path.resolve(`./.github`));
 
-  // delete CI/CD pipeline files
+  // Delete CI/CD pipeline files
   deleteFolder(path.resolve(`./.azure-devops`));
 
   await updatePackageJsonFile();
@@ -45,19 +51,19 @@ async function updatePackageJsonFile() {
     }
   });
 
-  // remove test-related packages
+  // Remove test-related packages
   Object.keys(content.devDependencies).forEach(function (key) {
     if (testPackages.includes(key)) {
       delete content.devDependencies[key];
     }
   });
 
-  // write updated json to file
+  // Write updated JSON to file
   await writeFileAsync(packageJson, JSON.stringify(content, null, 2));
 }
 
 async function updateLaunchJsonFile() {
-  // remove 'Debug Tests' configuration from launch.json
+  // Remove 'Debug Tests' configuration from launch.json
   const launchJson = `.vscode/launch.json`;
   const launchJsonContent = await readFileAsync(launchJson, "utf8");
   const regex = /(.+{\r?\n.*"name": "Debug (?:UI|Unit) Tests",\r?\n(?:.*\r?\n)*?.*},.*\r?\n)/gm;
@@ -93,10 +99,137 @@ async function deleteSupportFiles() {
   await unlinkFileAsync("package-lock.json");
 }
 
+async function deleteJSONManifestRelatedFiles() {
+  await unlinkFileAsync("manifest.json");
+  await unlinkFileAsync("assets/color.png");
+  await unlinkFileAsync("assets/outline.png");
+}
+
+async function deleteXMLManifestRelatedFiles() {
+  await unlinkFileAsync("manifest.xml");
+}
+
+async function updatePackageJsonForXMLManifest() {
+  const packageJson = `./package.json`;
+  const data = await readFileAsync(packageJson, "utf8");
+  let content = JSON.parse(data);
+
+  // Remove scripts that are only used with JSON manifest
+  delete content.scripts["signin"];
+  delete content.scripts["signout"];
+
+  // Write updated JSON to file
+  await writeFileAsync(packageJson, JSON.stringify(content, null, 2));
+}
+
+async function updatePackageJsonForJSONManifest() {
+  const packageJson = `./package.json`;
+  const data = await readFileAsync(packageJson, "utf8");
+  let content = JSON.parse(data);
+
+  // Remove special start scripts
+  Object.keys(content.scripts).forEach(function (key) {
+    if (key.includes("start:")) {
+      delete content.scripts[key];
+    }
+  });
+
+  // Change manifest file name extension
+  content.scripts.start = "office-addin-debugging start manifest.json";
+  content.scripts.stop = "office-addin-debugging stop manifest.json";
+  content.scripts.validate = "office-addin-manifest validate manifest.json";
+
+  // Write updated JSON to file
+  await writeFileAsync(packageJson, JSON.stringify(content, null, 2));
+}
+
+async function updateTasksJsonFileForJSONManifest() {
+  const tasksJson = `.vscode/tasks.json`;
+  const data = await readFileAsync(tasksJson, "utf8");
+  let content = JSON.parse(data);
+
+  content.tasks.forEach(function (task) {
+    if (task.label.startsWith("Build")) {
+      task.dependsOn = ["Install"];
+    }
+    if (task.label === "Debug: Outlook Desktop") {
+      task.script = "start";
+      task.dependsOn = ["Check OS", "Install"];
+    }
+  });
+
+  const checkOSTask = {
+    label: "Check OS",
+    type: "shell",
+    windows: {
+      command: "echo 'Sideloading in Outlook on Windows is supported'",
+    },
+    linux: {
+      command: "echo 'Sideloading on Linux is not supported' && exit 1",
+    },
+    osx: {
+      command: "echo 'Sideloading in Outlook on Mac is not supported' && exit 1",
+    },
+    presentation: {
+      clear: true,
+      panel: "dedicated",
+    },
+  };
+
+  content.tasks.push(checkOSTask);
+  await writeFileAsync(tasksJson, JSON.stringify(content, null, 2));
+}
+
+async function updateWebpackConfigForJSONManifest() {
+  const webPack = `webpack.config.js`;
+  const webPackContent = await readFileAsync(webPack, "utf8");
+  const updatedContent = webPackContent.replace(".xml", ".json");
+  await writeFileAsync(webPack, updatedContent);
+}
+
+async function modifyProjectForJSONManifest() {
+  await updatePackageJsonForJSONManifest();
+  await updateWebpackConfigForJSONManifest();
+  await updateTasksJsonFileForJSONManifest();
+  await deleteXMLManifestRelatedFiles();
+}
+
+
 /**
  * Remove test infrastructure and repo support files from project.
  */
 removeTestInfraStructure().catch((err) => {
   console.error(`Error: ${err instanceof Error ? err.message : err}`);
   process.exitCode = 1;
 });
+
+let manifestPath = "manifest.xml";
+
+// Uncomment when template supports JSON manifest
+// if (host !== "outlook" || manifestType !== "json") {
+  // Remove things that are only relevant to JSON manifest
+  deleteJSONManifestRelatedFiles();
+  updatePackageJsonForXMLManifest();
+// } else {
+//   manifestPath = "manifest.json";
+//   modifyProjectForJSONManifest().catch((err) => {
+//     console.error(`Error modifying for JSON manifest: ${err instanceof Error ? err.message : err}`);
+//     process.exitCode = 1;
+//   });
+// }
+
+if (projectName) {
+  if (!appId) {
+    appId = "random";
+  }
+
+  // Modify the manifest to include the name and id of the project
+  const cmdLine = `npx office-addin-manifest modify ${manifestPath} -g ${appId} -d ${projectName}`;
+  childProcess.exec(cmdLine, (error, stdout) => {
+    if (error) {
+      Promise.reject(stdout);
+    } else {
+      Promise.resolve();
+    }
+  });
+}

assets/outline.png

@@ -0,0 +1,145 @@
+{
+    "$schema": "https://raw.githubusercontent.com/OfficeDev/microsoft-teams-app-schema/preview/DevPreview/MicrosoftTeams.schema.json",
+    "id": "f2b103f1-1ab1-4e1b-8f0b-072aa3d4e19d",
+    "manifestVersion": "devPreview",
+    "version": "1.0.0",
+    "name": {
+      "short": "Contoso Task Pane Add-in",
+      "full": "Contoso Task Pane Add-in"
+    },
+    "description": {
+      "short": "A template to get started.",
+      "full": "This is the template to get started."
+    },
+    "developer": {
+      "name": "Contoso",
+      "websiteUrl": "https://www.contoso.com",
+      "privacyUrl": "https://www.contoso.com/privacy",
+      "termsOfUseUrl": "https://www.contoso.com/servicesagreement"
+    },
+    "icons": {
+      "outline": "assets/outline.png",
+      "color": "assets/color.png"
+    },
+    "accentColor": "#230201",
+    "localizationInfo": {
+      "defaultLanguageTag": "en-us",
+      "additionalLanguages": []
+    },
+    "authorization": {
+      "permissions": {
+        "resourceSpecific": [
+          {
+            "name": "MailboxItem.Read.User",
+            "type": "Delegated"
+          }
+        ]
+      }
+    },
+    "validDomains": ["contoso.com"],
+    "extensions": [
+      {
+        "requirements": {
+          "scopes": ["mail"],
+          "capabilities": [
+            { "name": "Mailbox", "minVersion": "1.3" }
+          ]
+        },
+        "runtimes": [
+          {
+            "requirements": {
+              "capabilities": [
+                { "name": "Mailbox", "minVersion": "1.3" }
+              ]
+            },
+            "id": "TaskPaneRuntime",
+            "type": "general",
+            "code": {
+              "page": "https://localhost:3000/taskpane.html"
+            },
+            "lifetime": "short",
+            "actions": [
+              {
+                "id": "TaskPaneRuntimeShow",
+                "type":"openPage",
+                "pinnable": false,
+                "view": "dashboard"
+              }
+            ]
+          },
+          {
+            "id": "CommandsRuntime",
+            "type": "general",
+            "code": {
+              "page": "https://localhost:3000/commands.html",
+              "script": "https://localhost:3000/commands.js"
+            },
+            "lifetime": "short",
+            "actions": [
+              {
+                "id": "action",
+                "type": "executeFunction",
+                "displayName": "action"
+              }
+            ]
+          }
+        ],
+        "ribbons": [
+          {
+            "contexts": [
+              "mailRead"
+            ],
+            "tabs": [
+              {
+                "builtInTabId": "TabDefault",
+                "groups": [
+                  {
+                    "id": "msgReadGroup",
+                    "label": "Contoso Add-in",
+                    "icons": [
+                      { "size": 16, "file": "https://localhost:3000/assets/icon-16.png" },
+                      { "size": 32, "file": "https://localhost:3000/assets/icon-32.png" },
+                      { "size": 80, "file": "https://localhost:3000/assets/icon-80.png" }
+                    ],
+                    "controls": [
+                      {
+                        "id": "msgReadOpenPaneButton",
+                        "type": "button",
+                        "label": "Show Taskpane",
+                        "icons": [
+                          { "size": 16, "file": "https://localhost:3000/assets/icon-16.png" },
+                          { "size": 32, "file": "https://localhost:3000/assets/icon-32.png" },
+                          { "size": 80, "file": "https://localhost:3000/assets/icon-80.png" }
+                        ],
+                        "supertip": {
+                          "title": "Show Taskpane",
+                          "description": "Opens a pane displaying all available properties."
+                        },
+                        "actionId": "TaskPaneRuntimeShow"
+                      },
+                      {
+                        "id": "ActionButton",
+                        "type": "button",
+                        "label": "Perform an action",
+                        "icons": [
+                          { "size": 16, "file": "https://localhost:3000/assets/icon-16.png" },
+                          { "size": 32, "file": "https://localhost:3000/assets/icon-32.png" },
+                          { "size": 80, "file": "https://localhost:3000/assets/icon-80.png" }
+                        ],
+                        "supertip": {
+                          "title": "Perform an action",
+                          "description": "Perform an action when clicked."
+                        },
+                        "actionId": "action"
+                      }
+                    ]
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+