feat: add SupportURL to manifest (#20)

Co-authored-by: Richard Herman <[email protected]>

Author: GeekyEggo

CHANGELOG.md

@@ -11,6 +11,12 @@
 
 # Change Log
 
+## 0.4.4
+
+### ✨ New
+
+-   Add `SupportURL` and `Actions[].SupportURL`.
+
 ## 0.4.3
 
 ### ✨ New

src/streamdeck/plugins/manifest/__tests__/files/v6.9.json

@@ -36,6 +36,7 @@
 					"TitleColor": "#000000"
 				}
 			],
+			"SupportURL": "https://help.elgato.com",
 			"SupportedInMultiActions": true,
 			"Tooltip": "This is the tooltip",
 			"UserTitleEnabled": true,
@@ -85,6 +86,7 @@
 	"Software": {
 		"MinimumVersion": "6.9"
 	},
+	"SupportURL": "https://help.elgato.com",
 	"URL": "https://www.elgato.com",
 	"UUID": "com.elgato.test",
 	"Version": "1.0.0.0"

src/streamdeck/plugins/manifest/__tests__/v6.9.test.ts

@@ -78,4 +78,39 @@ describe("6.9", () => {
 			});
 		});
 	});
+
+	describe("SupportURL", () => {
+		it("is optional", () => {
+			// Arrange, act.
+			const errors = validateStreamDeckPluginManifest("v6.9.json", (m) => {
+				m.Actions[0].SupportURL = undefined;
+				m.SupportURL = undefined;
+			});
+
+			// Assert.
+			expect(errors).toHaveLength(0);
+		});
+
+		it("cannot be in lower than 6.9", () => {
+			// Arrange, act.
+			const errors = validateStreamDeckPluginManifest("v6.9.json", (m) => (m.Software.MinimumVersion = "6.8"));
+
+			// Assert.
+			expect(errors).toHaveError({
+				keyword: "additionalProperties",
+				instancePath: "/Actions/0",
+				params: {
+					additionalProperty: "SupportURL"
+				}
+			});
+
+			expect(errors).toHaveError({
+				keyword: "additionalProperties",
+				instancePath: "",
+				params: {
+					additionalProperty: "SupportURL"
+				}
+			});
+		});
+	});
 });

src/streamdeck/plugins/manifest/latest.ts

@@ -183,6 +183,15 @@ export type Manifest = {
 	 */
 	Software: Software;
 
+	/**
+	 * Link to the plugin's support website.
+	 *
+	 * **Examples**:
+	 * - https://help.corsair.com/
+	 * - https://help.elgato.com/
+	 */
+	SupportURL?: string;
+
 	/**
 	 * Link to the plugin's website.
 	 *
@@ -318,6 +327,15 @@ export type Action = {
 	 */
 	SupportedInMultiActions?: boolean;
 
+	/**
+	 * Link to the actions's support website.
+	 *
+	 * **Examples**:
+	 * - https://help.corsair.com/
+	 * - https://help.elgato.com/
+	 */
+	SupportURL?: string;
+
 	/**
 	 * Tooltip shown to the user when they hover over the action within the actions list in the Stream Deck application.
 	 */

src/streamdeck/plugins/manifest/v6.6.ts

@@ -1,9 +1,16 @@
+import type { ElementOf } from "../../../utils";
 import type { Manifest_6_9 } from "./v6.9";
 
 /**
  * Defines the plugin and available actions, and all information associated with them, including the plugin's entry point, all iconography, action default behavior, etc.
  */
-export type Manifest_6_6 = Omit<Manifest_6_9, "SDKVersion" | "Software"> & {
+export type Manifest_6_6 = Omit<Manifest_6_9, "Actions" | "SDKVersion" | "Software" | "SupportURL"> & {
+	/**
+	 * Collection of actions provided by the plugin, and all of their information; this can include actions that are available to user's via the actions list, and actions that are
+	 * hidden to the user but available to pre-defined profiles distributed with the plugin (`Manifest.Actions.VisibleInActionsList`).
+	 */
+	Actions: Omit<ElementOf<Manifest_6_9["Actions"]>, "SupportURL">[];
+
 	/**
 	 * Determines the Stream Deck software requirements for this plugin.
 	 */