feat: add routing of messages between the property inspector and the plugin

[GeekyEggo]

Adds routing of messages between the plugin and its property inspector.

Example

Plugin

import streamDeck from "@elgato/streamdeck";
streamDeck.ui.registerRoute("/get-names", (req, res) => {
    // access to the request and a responder -alternatively, a response can be returned.
    return ["Mario", "Peach", "Luigi"];
});

Property Inspector Side

const res = await streamDeck.plugin.fetch("/get-names");
// res.body = ["Mario", "Luigi", "Peach"]

Changes

Plugin

• Add PropertyInspector class.
  • Add fetch to fetch requests from the property inspector.
• Add streamDeck.ui.current to track the current property inspector.
• Add streamDeck.ui.registerRoute to register the routing of requests from the property inspector.
• Add @route decorator to provide routing of an action's function.
• Mark sendToPlugin and sendToPropertyInspector as deprecated.

Property Inspector

• Add streamDeck.plugin fetch to send fetch requests to the plugin.
• Add streamDeck.plugin.registerRoute to register the routing of requests from the plugin.
• Mark sendToPlugin and sendToPropertyInspector as deprecated.

Internal

• Add MessageGateway class for handling bi-directional requests / responses.
• Update UI namespace to be a controller class.
• Fix trace logging of the connection.

[ChekTek]

Is 2024 required here?

[GeekyEggo]

Good spot, re-added.

[Elgato-AStory]

Is there ever any circumstance where we might want to allow a route to be unregistered?

[GeekyEggo]

There is, but not at the moment. When transient actions are available, and they're added / removed from memory as needed, we'll need to ensure the routes for those context/action combinations are also removed appropriately. This also drove the decision to not return this on the publicly exposed registerRoute as that will likely return a Disposable to allow for the route to be removed.

streamdeck/src/plugin/ui/controller.ts

Lines 77 to 83 in d41df3a

	public registerRoute<TBody extends JsonValue = JsonValue, TSettings extends JsonObject = JsonObject>(
	path: string,
	handler: MessageHandler<TBody, TSettings>,
	options?: RouteConfiguration<Action>
	): void {
	router.route(path, handler, options);
	}

[GeekyEggo]

registerRoute now returns an IDisposable 🥳