feat: add isInMultiAction to PI action info (#44)

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

CHANGELOG.md

@@ -22,6 +22,7 @@
     -   Add `streamDeck.settings` namespace for interacting with settings.
     -   Add `streamDeck.system` namespace for system-related operations.
     -   Add `streamDeck.plugin` namespace for bi-direction communication with the plugin and the UI.
+-   Add `isInMultiAction` to the property inspector's action information.
 
 ### 🐞 Fix
 

src/api/events/action.ts

@@ -121,6 +121,8 @@ export type SingleActionPayload<TSettings extends JsonObject, TController extend
 
 	/**
 	 * Determines whether the action is part of a multi-action.
+	 *
+	 * NB. Requires Stream Deck 6.7 when accessed from the property inspector.
 	 */
 	readonly isInMultiAction: false;
 };
@@ -139,6 +141,8 @@ export type MultiActionPayload<TSettings extends JsonObject> = ActionPayload<TSe
 
 	/**
 	 * Determines whether the action is part of a multi-action.
+	 *
+	 * NB. Requires Stream Deck 6.7 when accessed from the property inspector.
 	 */
 	readonly isInMultiAction: true;
 };

src/api/registration/__mocks__/index.ts

@@ -10,6 +10,7 @@ export const actionInfo: ActionInfo = {
 	device: "dev123",
 	payload: {
 		controller: "Keypad",
+		isInMultiAction: false,
 		coordinates: {
 			column: 1,
 			row: 2

src/api/registration/ui.ts

@@ -1,4 +1,6 @@
-import type { ActionIdentifier, Coordinates, DeviceIdentifier } from "../events";
+import type { JsonObject } from "../../common/json";
+import type { ActionIdentifier, DeviceIdentifier } from "../events";
+import type { MultiActionPayload, SingleActionPayload } from "../events/action";
 
 /**
  * Connects to the Stream Deck, enabling the UI to interact with the plugin, and access the Stream Deck API.
@@ -12,29 +14,12 @@ export type ConnectElgatoStreamDeckSocketFn = (port: string, uuid: string, event
 
 /**
  * Information about the action associated with the UI.
+ * @template TSettings Settings associated with the action.
  */
-export type ActionInfo<T = unknown> = ActionIdentifier &
+export type ActionInfo<TSettings extends JsonObject = JsonObject> = ActionIdentifier &
 	DeviceIdentifier & {
 		/**
 		 * Additional information about the action and event that occurred.
 		 */
-		readonly payload: {
-			/**
-			 * Defines the controller type the action is applicable to. **Keypad** refers to a standard action on a Stream Deck device, e.g. 1 of the 15 buttons on the Stream Deck MK.2,
-			 * or a pedal on the Stream Deck Pedal, etc., whereas an **Encoder** refers to a dial / touchscreen on the Stream Deck +.
-			 *
-			 * NB: Requires Stream Deck 6.5 for `WillAppear` and `WillDisappear` events.
-			 */
-			readonly controller: T;
-
-			/**
-			 * Coordinates that identify the location of an action.
-			 */
-			readonly coordinates: Coordinates;
-
-			/**
-			 * Settings associated with the action instance.
-			 */
-			settings: T;
-		};
+		readonly payload: MultiActionPayload<TSettings> | SingleActionPayload<TSettings>;
 	};

src/ui/index.ts

@@ -1,5 +1,6 @@
 import { type ActionInfo, type RegistrationInfo } from "../api";
 import type { IDisposable } from "../common/disposable";
+import type { JsonObject } from "../common/json";
 import { connection } from "./connection";
 import { i18n } from "./i18n";
 import { logger } from "./logging";
@@ -46,7 +47,7 @@ const streamDeck = {
 	 * @param listener Event handler function.
 	 * @returns A disposable that removes the listener when disposed.
 	 */
-	onDidConnect: (listener: (info: RegistrationInfo, actionInfo: ActionInfo) => void): IDisposable => {
+	onDidConnect: <TSettings extends JsonObject = JsonObject>(listener: (info: RegistrationInfo, actionInfo: ActionInfo<TSettings>) => void): IDisposable => {
 		return connection.disposableOn("connected", listener);
 	}
 };