Bug fixes

🐞 Fixed

• Fixed an issue with StreamDeckClient.Run() not blocking the main thread.

Greatly simplified start-up!

🚨 Breaking

• Removed StreamDeckClient; replaced with IStreamDeckConnection.
• Updated StreamDeckAction.StreamDeck to be IStreamDeckConnection.

⭐ Added

• Greatly simplfied starting a plug-in.
  • StreamDeckPlugin.Run()
  • StreamDeckPlugin.RunAsync()
• Added basic unit tests.
• Added GitHub workflows.
• Added StreamDeckAction.OnInit virtual.

♻ Changed

• Actions with StreamDeckAttribute are automatically registered.
• Complete re-write of action caching.
• Complete re-write of event routing.

🐞 Fixed

• Fixed an issue with incorrect actions being invoked.

Auto deployment for NuGet!

♻ Changed

• Updated deployment to NuGet.

NuGet deployment

♻ Changed

• Updated deployment to NuGet.

Manifest generation and error handling

🚨 Breaking

• Removed StreamDeckAction.Initialized event, please use StreamDeckAction.WillAppear
• Removed StreamDeckAction<TSettings>.Settings to prevent misuse.

⭐ Added

• Added automatic manifest generation!
• Added support for initializing actions with their AppearancePayload.
• Added action context when raising StreamDeckClient.Error (where possible).
• Added support for FontFamilyType and FontStyleType.
• Improved deadlock prevention for all WebSocket requests.

🐞 Fixed

• Fixed DeviceType, PlatformType, and TitleAlignmentType.

Stream Deck support

🚨 Breaking

• Relocated to SharpDeck.Events.StreamDeckAction to top level SharpDeck.StreamDeckAction.
• Re-aligned namespaces of events (received) / messages (sent) to match Elgato SDK terminology.

⭐ Added

• Support for SDK 4.1
  • didReceiveGlobalSettings
  • didReceiveSettings
  • getGlobalSettings
  • getSettings
  • logMessage
  • propertyInspectorDidAppear
  • propertyInspectorDidDisappear
  • setGlobalSettings
• Support for SDK 4.3
  • systemDidWakeUp
  • Added device name to registration info.
• StreamDeckAction{TSettings} base class.
• RequestId to property inspector methods, allowing for responses to be identified more easily (e.g. with promises).
• StreamDeckXL and StreamDeckMobile to DeviceType.

🐞 Fixed

• Fixed JSON serialization casing inconsistencies when using JObject (specifically action settings).
• Fixed openUrl event.

Property Inspector decorators

⭐ Added

• PropertyInspectorMethodAttribute decorator for interacting with Property Inspector.
• Added unit testing, including AppVeyor integration.

♻ Changed

• Updated StreamDeckAction overrides to require a task.
• Streamlined publishing to NuGet with npm package scripts.

🐞 Fixed

• Fixed potential async/await issue within StreamDeckClient.

The one with the Property Inspector

♻ Changed

• Removed unnecessary parameters when calling SendToPropertyInspectorAsync.

🐞 Fixed

• Fixed an issue with sendToPlugin event not triggering.

Missing event, and namespace changes

⭐ Added

• Added missing event: sendToPlugin.

♻ Changded

• StreamDeckClient.RegisterAction now supports a value factory.
• Centralised all event related models to the SharpDeck.Events namespace.
• Improved dependency injection capabilities.

Initial release

⭐ Added

• StreamDeckClient, allowing for connections to an Elgato Stream Deck.
• Event listeners (ref: "Events Received").
• Messaging (ref: "Events Sent").
• Support for registering StreamDeckAction.