Merge branch 'ActionEnv'

Author: emorydunn

Examples/counter/Sources/counter/Actions/DecrementAction.swift

@@ -27,15 +27,12 @@ class DecrementAction: KeyAction {
 
 	static var userTitleEnabled: Bool? = false
 
-	var context: String
-
-	var coordinates: StreamDeck.Coordinates?
+	let context: String
 
 	@GlobalSetting(\.count) var count
 
-	required init(context: String, coordinates: StreamDeck.Coordinates?) {
+	required init(context: String) {
 		self.context = context
-		self.coordinates = coordinates
 	}
 
 	func willAppear(device: String, payload: AppearEvent<Settings>) {

Examples/counter/Sources/counter/Actions/IncrementAction.swift

@@ -27,15 +27,12 @@ class IncrementAction: KeyAction {
 
 	static var userTitleEnabled: Bool? = false
 
-	var context: String
-	
-	var coordinates: StreamDeck.Coordinates?
+	let context: String
 
 	@GlobalSetting(\.count) var count
 
-	required init(context: String, coordinates: StreamDeck.Coordinates?) {
+	required init(context: String) {
 		self.context = context
-		self.coordinates = coordinates
 	}
 
 	func willAppear(device: String, payload: AppearEvent<Settings>) {

Examples/counter/Sources/counter/Actions/RotaryAction.swift

@@ -24,17 +24,14 @@ class RotaryAction: EncoderAction {
 													   rotate: "Count",
 													   push: "Reset")
 
-	var context: String
-
-	var coordinates: StreamDeck.Coordinates?
-
 	static var userTitleEnabled: Bool? = false
 
+	let context: String
+
 	@GlobalSetting(\.count) var count: Int
 
-	required init(context: String, coordinates: StreamDeck.Coordinates?) {
+	required init(context: String) {
 		self.context = context
-		self.coordinates = coordinates
 	}
 
 	func willAppear(device: String, payload: AppearEvent<Settings>) {

Sources/StreamDeck/StreamDeck Plugin/Action/Action.swift

@@ -101,10 +101,7 @@ public protocol Action {
 
 	/// The context value for the instance.
 	var context: String { get }
-	
-	/// The coordinates of the instance.
-	var coordinates: Coordinates? { get }
-	
+
 	/// The duration a button needs to be held down in order to be considered a long press. 
 	var longPressDuration: TimeInterval { get }
 
@@ -113,7 +110,7 @@ public protocol Action {
 
 	/// Create a new instance with the specified context and coordinates.
 	init(context: String, coordinates: Coordinates?)
-	
+
 	// MARK: - Events
 	func didReceiveGlobalSettings()
 

Sources/StreamDeck/StreamDeck Plugin/PluginCommunication.swift

@@ -84,7 +84,7 @@ public final actor PluginCommunication {
 		type(of: plugin).actions.first { $0.uuid == uuid }
 	}
 
-	public func registerInstance(_ event:  ActionEvent<InstanceAppearEvent>) {
+	public func registerInstance(_ event: ActionEvent<InstanceAppearEvent>) {
 		// Check if the instance already exists
 		guard instances[event.context] == nil else {
 			log.log("This instance has already been registered.")
@@ -97,8 +97,8 @@ public final actor PluginCommunication {
 			return
 		}
 
-		// Register the controller type
-		ActionControllerRegistry.shared.store(event.context, controller: event.payload.controller, device: event.device)
+		// Register the action metadata
+		ActionControllerRegistry.shared.store(event: event)
 
 		// Initialize a new instance
 		instances[event.context] = actionType.init(context: event.context, coordinates: event.payload.coordinates)
@@ -127,13 +127,11 @@ public final actor PluginCommunication {
 		// Find all actions on the device
 		guard let actions = ActionControllerRegistry.shared.devices[device] else { return [] }
 
-		return actions.compactMap { context in
-			instances[context] as? A
+		return actions.compactMap { info in
+			instances[info.context] as? A
 		}
-
 	}
 
-
 	// MARK: - WebSocket Methods
 	/// Continually receive messages from the socket.
 	func monitorSocket() async {
@@ -149,8 +147,8 @@ public final actor PluginCommunication {
 			// Parse the message outside of the WebSocket loop.
 			// An action may take a long time to respond, especially
 			// if an AppleEvent takes longer than expected, so we
-			// want to kick that off and get back to receiving messages
-			// as soon as possible.
+			// want to kick that off and get back to receiving
+			// messages as soon as possible.
 			Task.detached(priority: .userInitiated) {
 				await self.parseMessage(message)
 			}
@@ -353,12 +351,11 @@ public final actor PluginCommunication {
 			log.log("Received first event, requesting global settings")
 			// Get the initial global settings
 			await PluginCommunication.shared.sendEvent(.getGlobalSettings,
-											  context: PluginCommunication.shared.uuid,
-											  payload: nil)
+													   context: PluginCommunication.shared.uuid,
+													   payload: nil)
 			shouldLoadSettings = false
 		}
 
-
 #if DEBUG
 		if let json = String(data: data, encoding: .utf8) {
 			log.debug("\(json, privacy: .public)")

Sources/StreamDeck/Support Models/ActionControllerRegistry.swift

@@ -12,36 +12,56 @@ class ActionControllerRegistry {
 	static let shared = ActionControllerRegistry()
 
 	/// A dictionary of actions and their controller type.
-	var actions: [String: ControllerType] = [:]
+	var actions: [String: ActionInfo] = [:]
 
 	/// A dictionary of devices and their actions
-	var devices: [String: [String]] = [:]
+	var devices: [String: [ActionInfo]] {
+		let infos: [ActionInfo] = Array(actions.values)
+		return Dictionary(grouping: infos) { $0.device }
+	}
 
-	func store(_ actionContext: String, controller: ControllerType, device: String) {
-		actions[actionContext] = controller
-		devices[device, default: []].append(actionContext)
+	func store(event: ActionEvent<InstanceAppearEvent>) {
+		actions[event.context] = ActionInfo(event)
 	}
 
 	func remove(_ actionContext: String) {
 		actions[actionContext] = nil
-		devices[actionContext] = nil
 	}
 
-	subscript <A: Action>(_ action: A) -> ControllerType? {
-		get {
-			actions[action.context]
-		}
-
-		set {
-			actions[action.context] = newValue
-		}
+	subscript <A: Action>(_ action: A) -> ActionInfo? {
+		actions[action.context]
 	}
 
 }
 
+/// Information about where the action is displayed.
+struct ActionInfo {
+	let context: String
+	let device: String
+	let controllerType: ControllerType
+	let coordinates: Coordinates?
+
+	init(_ event: ActionEvent<InstanceAppearEvent>) {
+		self.context = event.context
+		self.device = event.device
+		self.controllerType = event.payload.controller
+		self.coordinates = event.payload.coordinates
+	}
+}
+
 extension Action {
 	/// The type of controller the action instance was instantiated on.
 	public var controllerType: ControllerType {
-		ActionControllerRegistry.shared[self]!
+		ActionControllerRegistry.shared[self]!.controllerType
+	}
+
+	/// The type of controller the action instance was instantiated on.
+	public var coordinates: Coordinates? {
+		ActionControllerRegistry.shared[self]!.coordinates
+	}
+
+	/// The type of controller the action instance was instantiated on.
+	public var device: String {
+		ActionControllerRegistry.shared[self]!.device
 	}
 }

Sources/StreamDeck/Support Models/PluginManifest/Coordinates.swift

@@ -8,11 +8,15 @@
 import Foundation
 
 /// The coordinates of the action triggered.
-public struct Coordinates: Decodable, Hashable, Sendable {
-	
+public struct Coordinates: Decodable, Hashable, Sendable, CustomStringConvertible {
+
 	/// The column.
 	public let column: Int
 
 	/// The row.
 	public let row: Int
+
+	public var description: String {
+		"Coord (\(row), \(column))"
+	}
 }