Upgrading to Version 2.x

This documentation will guide you through upgrading your Stream Deck plugin, using @elgato/streamdeck, to version 2.

Breaking Changes

• UI namespace has been simplified.
• Dependencies have been decoupled.
• Manifest namespace has been removed.
• Browser import has been removed.

UI Communication

The UI namespace responsible for communicating with the property inspector has been streamlined; these improvements come with two breaking changes.

Send to Property Inspector

Sending payloads to the property inspector has now been streamlined, and no longer requires .current?.

Before

import streamDeck from "@elgato/streamdeck";

streamDeck.ui.current?.sendToPropertyInspector({
	message: "Hello world",
});

Now

import streamDeck from "@elgato/streamdeck";

streamDeck.ui.sendToPropertyInspector({
	message: "Hello world",
});

Property Inspector Action

Accessing the action for current property inspector is now achieved using the .action property.

Before

import streamDeck from "@elgato/streamdeck";

streamDeck.ui.current;

Now

import streamDeck from "@elgato/streamdeck";

streamDeck.ui.action;

Dependencies

Previously when publishing @elgato/streamdeck the package was bundled into a single file making dependency resolution difficult, and prone to conflicts.

Starting with version 2.0, @elgato/streamdeck is no longer pre-bundle; this allows more functionality, previously isolated to the Stream Deck SDK, to become accessible, starting with @elgato/utils.

JSON

Before

import type {
	JsonObject,
	JsonPrimitive,
	JsonValue
} from "@elgato/streamdeck";

Now

import type {
	JsonObject,
	JsonPrimitive,
	JsonValue
} from "@elgato/utils";

Logging

Before

import streamDeck, { LogLevel } from "@elgato/streamdeck";

streamDeck.logger.setLevel(LogLevel.TRACE);

Now

import streamDeck from "@elgato/streamdeck";

streamDeck.logger.setLevel("trace");

Miscellaneous

Before

import {
	Enumerable,
	EventEmitter,
	type EventsOf,
} from "@elgato/streamdeck";

Now

import {
	Enumerable,
	EventEmitter,
	type EventsOf,
} from "@elgato/utils";

Manifest

With the introduction of DRM protection, the manifest is now considered a protected resource, and access to streamDeck.manifest at runtime has been removed. Learn more about DRM protection.

Browser Import

The ability to import @elgato/streamdeck into the browser (property inspector) has been removed.