@crowbartools/firebot-types 5.67.0-alpha20 → 5.67.0-alpha22

package/backend/common/settings-manager.d.ts

@@ -77,10 +77,6 @@ declare class SettingsManager extends TypedEmitter<Events> {
     getOverlayVersion: () => string;
     /** @deprecated Use `saveSetting("CopiedOverlayVersion", value)` instead */
     setOverlayVersion: (value: string) => void;
-    /** @deprecated Use `getSetting("ClearCustomScriptCache")` instead */
-    getClearCustomScriptCache: () => boolean;
-    /** @deprecated Use `saveSetting("ClearCustomScriptCache", value)` instead */
-    setClearCustomScriptCache: (value: boolean) => void;
     /** @deprecated Use `getSetting("RunCustomScripts")` instead */
     isCustomScriptsEnabled: () => boolean;
     /** @deprecated Use `getSetting("RunCustomScripts")` instead */

package/backend/control-deck/builtin-control-types/button.d.ts

@@ -0,0 +1,6 @@
+import type { ControlDeckControlType, EffectList } from "../../../types";
+type ButtonParams = {
+    effects: EffectList;
+};
+export declare const buttonControlType: ControlDeckControlType<ButtonParams>;
+export {};

package/backend/control-deck/builtin-control-types/folder.d.ts

@@ -0,0 +1,6 @@
+import type { ControlDeckControlType } from "../../../types";
+type FolderParams = {
+    autoReturn: boolean;
+};
+export declare const folderControlType: ControlDeckControlType<FolderParams>;
+export {};

package/backend/control-deck/builtin-control-types/switch.d.ts

@@ -0,0 +1,11 @@
+import type { ControlDeckControlType, EffectList } from "../../../types";
+type SwitchParams = {
+    orientation: "horizontal" | "vertical";
+    color: string;
+    initialState: "restore" | "off" | "on";
+    runEffectsOnInit: boolean;
+    onEffects: EffectList;
+    offEffects: EffectList;
+};
+export declare const switchControlType: ControlDeckControlType<SwitchParams, boolean>;
+export {};

package/backend/control-deck/control-deck-manager.d.ts

@@ -5,7 +5,13 @@ declare class ControlDeckManager extends JsonDbManager<ControlDeck> {
     saveDeck(deck: ControlDeck, notify?: boolean): ControlDeck;
     deleteDeck(deckId: string): void;
     getControl(deckId: string, controlId: string): ControlDeckControl | null;
-    triggerControl(deckId: string, controlId: string, inputValues?: Record<string, string | number | boolean>): boolean;
+    private buildTriggerEffectList;
+    /**
+     * Routes a hosted-page interaction to the control's type handler. Returns
+     * false when the control or its type can't be resolved.
+     */
+    handleInteraction(deckId: string, controlId: string, action: string, data: unknown, inputValues?: Record<string, string | number | boolean>): Promise<boolean>;
+    initializeControlStates(): Promise<void>;
     private broadcastToControlDecks;
     triggerUiRefresh(): void;
 }

package/backend/control-deck/control-deck-state-manager.d.ts

@@ -0,0 +1,18 @@
+import JsonDbManager from "../database/json-db-manager";
+type ControlStateRecord = {
+    /** The control id. */
+    id: string;
+    state: unknown;
+};
+declare class ControlDeckStateManager extends JsonDbManager<ControlStateRecord> {
+    private stateLogger;
+    constructor();
+    getControlState(controlId: string): unknown;
+    setControlState(deckId: string, controlId: string, state: unknown, { broadcast }?: {
+        broadcast?: boolean;
+    }): void;
+    deleteControlState(controlId: string): void;
+    private broadcastToControlDecks;
+}
+declare const controlDeckStateManager: ControlDeckStateManager;
+export { controlDeckStateManager as ControlDeckStateManager };

package/backend/control-deck/control-type-manager.d.ts

@@ -0,0 +1,13 @@
+import type { ControlDeckControlType } from "../../types";
+declare class ControlDeckControlTypeManager {
+    private logger;
+    private controlTypes;
+    constructor();
+    registerBuiltInControlTypes(): void;
+    private registerControlType;
+    getControlType(id: string): ControlDeckControlType<any, any> | null;
+    getAllControlTypes(): ControlDeckControlType<any, any>[];
+    private getControlTypesForFrontend;
+}
+declare const manager: ControlDeckControlTypeManager;
+export { manager as ControlDeckControlTypeManager };

package/backend/effects/builtin/chat.d.ts

@@ -5,5 +5,8 @@ declare const effect: EffectType<{
     me: boolean;
     whisper: string;
     sendAsReply: boolean;
+    pin: boolean;
+    pinUntilEndOfStream: boolean;
+    pinDuration?: string;
 }>;
 export = effect;

package/backend/notifications/notification-manager.d.ts

@@ -1,4 +1,4 @@
-import { Notification, NotificationBase } from "../../types";
+import type { Notification, NotificationBase } from "../../types";
 declare class NotificationManager {
     private logger;
     private _externalCheckInterval;
@@ -18,6 +18,7 @@ declare class NotificationManager {
     private loadExternalNotifications;
     startExternalNotificationCheck(): void;
     stopExternalNotificationCheck(): void;
+    migrateLegacyScriptNotifications(): void;
 }
 declare const manager: NotificationManager;
 export { manager as NotificationManager };

package/backend/plugins/executors/plugin-executor.interface.d.ts

@@ -13,6 +13,10 @@ export interface PluginRegistrations {
     restrictionIds?: string[];
     integrationIds?: string[];
     gameIds?: string[];
+    frontendListeners?: Array<{
+        eventName: string;
+        id: string;
+    }>;
     uiExtensionIds?: string[];
     overlayWidgetIds?: string[];
     httpRoutePrefix?: string;

package/backend/plugins/plugin-config-manager.d.ts

@@ -5,8 +5,6 @@ import JsonDbManager from "../database/json-db-manager";
  */
 declare class PluginConfigManager extends JsonDbManager<InstalledPluginConfig> {
     constructor();
-    loadItems(): void;
-    migrateLegacyStartUpScriptsToPlugins(): void;
 }
 declare const manager: PluginConfigManager;
 export { manager as PluginConfigManager };

package/backend/plugins/plugin-manager.d.ts

@@ -17,6 +17,7 @@ declare class PluginManager {
     private pluginExecutors;
     private legacyEffectScriptExecutor;
     constructor();
+    migrateLegacyStartUpScriptsToPlugins(): Promise<void>;
     startPlugin(pluginConfig: InstalledPluginConfig, installing?: boolean): Promise<void>;
     private doStartPlugin;
     startPlugins(): Promise<void>;

package/backend/restrictions/builtin/active-chat-users.d.ts

@@ -1,3 +1,3 @@
-import type { RestrictionType } from "../../../types/restrictions";
+import type { RestrictionType } from "../../../types";
 declare const model: RestrictionType<never>;
 export = model;

package/backend/restrictions/builtin/channel-currency.d.ts

@@ -1,4 +1,4 @@
-import type { RestrictionType } from "../../../types/restrictions";
+import type { RestrictionType } from "../../../types";
 type ComparisonType = "less" | "greater" | "equal";
 declare const model: RestrictionType<{
     selectedCurrency: string;

package/backend/restrictions/builtin/channel-game.d.ts

@@ -1,4 +1,4 @@
-import type { RestrictionType } from "../../../types/restrictions";
+import type { RestrictionType } from "../../../types";
 declare const model: RestrictionType<{
     gameId: string;
     name: string;

package/backend/restrictions/builtin/chat-messages.d.ts

@@ -1,4 +1,4 @@
-import type { RestrictionType } from "../../../types/restrictions";
+import type { RestrictionType } from "../../../types";
 declare const model: RestrictionType<{
     messages: number;
 }>;

package/backend/restrictions/builtin/custom-variable.d.ts

@@ -1,4 +1,4 @@
-import type { RestrictionType } from "../../../types/restrictions";
+import type { RestrictionType } from "../../../types";
 declare const model: RestrictionType<{
     name: string;
     value: string;

package/backend/restrictions/builtin/follow-check.d.ts

@@ -1,4 +1,4 @@
-import type { RestrictionType } from "../../../types/restrictions";
+import type { RestrictionType } from "../../../types";
 declare const model: RestrictionType<{
     checkMode: "streamer" | "custom";
     value: string;

package/backend/restrictions/builtin/limit-per-stream.d.ts

@@ -1,4 +1,4 @@
-import type { RestrictionType } from "../../../types/restrictions";
+import type { RestrictionType } from "../../../types";
 type RestrictionData = {
     perUserLimit?: number;
     globalLimit?: number;

package/backend/restrictions/builtin/only-when-live.d.ts

@@ -1,3 +1,3 @@
-import type { RestrictionType } from "../../../types/restrictions";
+import type { RestrictionType } from "../../../types";
 declare const restriction: RestrictionType;
 export = restriction;

package/backend/restrictions/builtin/permissions.d.ts

@@ -1,4 +1,4 @@
-import type { RestrictionType } from "../../../types/restrictions";
+import type { RestrictionType } from "../../../types";
 type PermissionMode = "roles" | "viewer";
 type Rank = {
     rankId: string;

package/backend/restrictions/builtin/time-range.d.ts

@@ -1,4 +1,4 @@
-import type { RestrictionType } from "../../../types/restrictions";
+import type { RestrictionType } from "../../../types";
 declare const model: RestrictionType<{
     mode: "time" | "days";
     days: string[];

package/backend/restrictions/builtin/view-time.d.ts

@@ -1,4 +1,4 @@
-import type { RestrictionType } from "../../../types/restrictions";
+import type { RestrictionType } from "../../../types";
 declare const model: RestrictionType<{
     time: number;
 }>;

package/backend/restrictions/builtin/viewer-count.d.ts

@@ -1,4 +1,4 @@
-import type { RestrictionType } from "../../../types/restrictions";
+import type { RestrictionType } from "../../../types";
 type ComparisonType = "less" | "greater" | "equal";
 declare const model: RestrictionType<{
     comparison: ComparisonType;

package/backend/restrictions/restriction-manager.d.ts

@@ -1,6 +1,5 @@
 import { TypedEmitter } from "tiny-typed-emitter";
-import type { RestrictionData, RestrictionType } from "../../types/restrictions";
-import type { Trigger } from "../../types/triggers";
+import type { RestrictionData, RestrictionResult, RestrictionType, Trigger } from "../../types";
 type Events = {
     "restriction-registered": (restriction: RestrictionType) => void;
     "restriction-unregistered": (restrictionId: string) => void;
@@ -15,7 +14,7 @@ declare class RestrictionsManager extends TypedEmitter<Events> {
     getAllRestrictions(): RestrictionType[];
     checkPermissionsPredicateOnly(restrictionData: RestrictionData, username: string, twitchRoles: string[]): Promise<boolean>;
     private runPredicate;
-    runRestrictionPredicates(triggerData: Trigger, restrictionData: RestrictionData, restrictionsAreInherited?: boolean): Promise<void>;
+    runRestrictionPredicates(triggerData: Trigger, restrictionData: RestrictionData, restrictionsAreInherited?: boolean): Promise<RestrictionResult>;
     private mapRestrictionForFrontEnd;
 }
 declare const manager: RestrictionsManager;

package/backend/streaming-platforms/twitch/api/index.d.ts

@@ -35,6 +35,7 @@ declare class TwitchApi {
     get streamerClient(): ApiClient;
     get botClient(): ApiClient;
     get moderationClient(): ApiClient;
+    get moderatorId(): string;
     get accounts(): {
         streamer: FirebotAccount;
         bot: FirebotAccount;

package/backend/streaming-platforms/twitch/api/resource/api-resource-base.d.ts

@@ -7,6 +7,7 @@ export declare abstract class ApiResourceBase<T extends ListenerSignature<T> = u
     protected get streamerClient(): ApiClient;
     protected get botClient(): ApiClient;
     protected get moderationClient(): ApiClient;
+    protected get moderatorId(): string;
     protected get logger(): import("winston").Logger;
     protected get accounts(): {
         streamer: import("../../../../../types").FirebotAccount;

package/backend/streaming-platforms/twitch/api/resource/chat.d.ts

@@ -1,12 +1,33 @@
-import { HelixChatAnnouncementColor, HelixChatChatter, HelixUserEmote } from "@twurple/api";
-import type { SharedChatParticipant } from "../../../../../types";
-import { ApiResourceBase } from "./api-resource-base";
+import type { HelixChatAnnouncementColor, HelixChatChatter, HelixUserEmote } from "@twurple/api";
+import type { CamelCased, SharedChatParticipant } from "../../../../../types";
+import type { EventSubChatMessageData } from "../twurple-private-types";
 import type { TwitchApi } from "../";
+import { ApiResourceBase } from "./api-resource-base";
 interface ResultWithError<TResult, TError> {
     success: boolean;
     result?: TResult;
     error?: TError;
 }
+interface SendChatMessageResult {
+    success: boolean;
+    isSlashCommand: boolean;
+    messageId?: string;
+    error?: string;
+}
+export type TwitchPinnedChatMessage = {
+    messageId: string;
+    broadcasterId: string;
+    senderUserId: string;
+    senderUserLogin: string;
+    senderUserName: string;
+    pinnedByUserId: string;
+    pinnedByUserLogin: string;
+    pinnedByUserName: string;
+    message: CamelCased<EventSubChatMessageData>;
+    startsAt: Date;
+    endsAt?: Date;
+    updatedAt: Date;
+};
 export declare class TwitchChatApi extends ApiResourceBase {
     private _slashCommandHandler;
     constructor(apiBase: typeof TwitchApi);
@@ -21,9 +42,8 @@ export declare class TwitchChatApi extends ApiResourceBase {
      * @param replyToMessageId The ID of the message this should be replying to. Leave as null for non replies.
      * @param sendAsBot If the chat message should be sent as the bot or not.
      * If this is set to `false` or the bot account is not logged in, the chat message will be sent as the streamer.
-     * @returns `true` if sending the chat message was successful or `false` if it failed
      */
-    sendChatMessage(message: string, replyToMessageId?: string, sendAsBot?: boolean): Promise<boolean>;
+    sendChatMessage(message: string, replyToMessageId?: string, sendAsBot?: boolean): Promise<SendChatMessageResult>;
     /**
      * Sends an announcement to the streamer's chat.
      *
@@ -112,5 +132,30 @@ export declare class TwitchChatApi extends ApiResourceBase {
      * @returns An array of {@link SharedChatParticipant} containing all the participants in the shared chat session, or null if there is no active session
      */
     getSharedChatParticipants(): Promise<SharedChatParticipant[]>;
+    /**
+     * Gets the currently pinned message in the streamer's chat, if one exists
+     * @returns The currently pinned chat message, or `null` if no message is pinned
+     */
+    getPinnedChatMessage(): Promise<TwitchPinnedChatMessage>;
+    /**
+     * Pin a chat message to the top of the streamer's chat
+     * @param messageId ID of the chat message to pin
+     * @param duration The number of seconds the message should be pinned for. Minimum: 30. Maximum: 1800. If not specified, the message will be pinned until the stream ends.
+     * @returns `true` if the message was pinned, `false` if it failed
+     */
+    pinChatMessage(messageId: string, duration?: number): Promise<boolean>;
+    /**
+     * Updates the chat message currently pinned to the top of the streamer's chat
+     * @param messageId ID of the pinned message to update
+     * @param duration The number of seconds the message should be pinned for. Minimum: 30. Maximum: 1800. If not specified, the message will be pinned until the stream ends.
+     * @returns `true` if the pinned message was updated, `false` if it failed
+     */
+    updatePinnedChatMessage(messageId: string, duration?: number): Promise<boolean>;
+    /**
+     * Unpins a message from the streamer's chat
+     * @param messageId ID of the message to unpin
+     * @returns `true` if the message was unpinned, `false` if it failed
+     */
+    unpinChatMessage(messageId: string): Promise<boolean>;
 }
 export {};

package/backend/streaming-platforms/twitch/effects/pin-chat-message.d.ts

@@ -0,0 +1,6 @@
+import type { EffectType } from "../../../../types";
+declare const effect: EffectType<{
+    pinUntilEndOfStream: boolean;
+    pinDuration?: string;
+}>;
+export = effect;

package/backend/streaming-platforms/twitch/effects/unpin-chat-message.d.ts

@@ -0,0 +1,3 @@
+import type { EffectType } from "../../../../types";
+declare const effect: EffectType;
+export = effect;

package/backend/streaming-platforms/twitch/effects/update-pinned-chat-message.d.ts

@@ -0,0 +1,6 @@
+import type { EffectType } from "../../../../types";
+declare const effect: EffectType<{
+    pinUntilEndOfStream: boolean;
+    pinDuration?: string;
+}>;
+export = effect;

package/backend/streaming-platforms/twitch/variables/chat/pinned-message/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("../../../../../../types").ReplaceVariable[];
+export default _default;

package/backend/streaming-platforms/twitch/variables/chat/pinned-message/pinned-by-user-display-name.d.ts

@@ -0,0 +1,3 @@
+import type { ReplaceVariable } from "../../../../../../types";
+declare const model: ReplaceVariable;
+export default model;

package/backend/streaming-platforms/twitch/variables/chat/pinned-message/pinned-by-user-id.d.ts

@@ -0,0 +1,3 @@
+import type { ReplaceVariable } from "../../../../../../types";
+declare const model: ReplaceVariable;
+export default model;

package/backend/streaming-platforms/twitch/variables/chat/pinned-message/pinned-by-username.d.ts

@@ -0,0 +1,3 @@
+import type { ReplaceVariable } from "../../../../../../types";
+declare const model: ReplaceVariable;
+export default model;

package/backend/streaming-platforms/twitch/variables/chat/pinned-message/pinned-chat-message-id.d.ts

@@ -0,0 +1,3 @@
+import type { ReplaceVariable } from "../../../../../../types";
+declare const model: ReplaceVariable;
+export default model;

package/backend/streaming-platforms/twitch/variables/chat/pinned-message/pinned-chat-message-text-only.d.ts

@@ -0,0 +1,3 @@
+import type { ReplaceVariable } from "../../../../../../types";
+declare const model: ReplaceVariable;
+export default model;

package/backend/streaming-platforms/twitch/variables/chat/pinned-message/pinned-chat-message-user-display-name.d.ts

@@ -0,0 +1,3 @@
+import type { ReplaceVariable } from "../../../../../../types";
+declare const model: ReplaceVariable;
+export default model;

package/backend/streaming-platforms/twitch/variables/chat/pinned-message/pinned-chat-message-user-id.d.ts

@@ -0,0 +1,3 @@
+import type { ReplaceVariable } from "../../../../../../types";
+declare const model: ReplaceVariable;
+export default model;

package/backend/streaming-platforms/twitch/variables/chat/pinned-message/pinned-chat-message-username.d.ts

@@ -0,0 +1,3 @@
+import type { ReplaceVariable } from "../../../../../../types";
+declare const model: ReplaceVariable;
+export default model;

package/backend/streaming-platforms/twitch/variables/chat/pinned-message/pinned-chat-message.d.ts

@@ -0,0 +1,3 @@
+import type { ReplaceVariable } from "../../../../../../types";
+declare const model: ReplaceVariable;
+export default model;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowbartools/firebot-types",
-  "version": "5.67.0-alpha20",
+  "version": "5.67.0-alpha22",
   "description": "Type definitions and plugin API for Firebot plugins.",
   "main": "index.js",
   "types": "index.d.ts",

package/types/control-deck.d.ts

@@ -1,10 +1,9 @@
+import type { FirebotParameterArray, FirebotParams, FontOptions } from "./parameters";
 import type { EffectList } from "./effects";
-/**
- * Reserved page id for the "Pinned" shadow page. Buttons with this pageId are
- * replicated onto every real page (unless a page button overrides the slot)
- */
+import type { Awaitable } from "./util-types";
 export declare const CONTROL_DECK_PINNED_PAGE_ID = "pinned";
-export type ControlDeckControlType = "button" | "folder";
+export declare const CONTROL_DECK_BUTTON_TYPE_ID = "firebot:button";
+export declare const CONTROL_DECK_FOLDER_TYPE_ID = "firebot:folder";
 /** An image icon — either a local file path or a URL. */
 export type ControlDeckImageIcon = {
     type: "image";
@@ -21,16 +20,21 @@ export type ControlDeckGlyphIcon = {
     /** Optional CSS color; defaults to the control's text color */
     color?: string;
 };
-export type ControlDeckNoneIcon = {
-    type: "none";
-};
 /** An emoji icon referenced by its unicode character. */
 export type ControlDeckEmojiIcon = {
     type: "emoji";
     /** The emoji character (eg "🔥") */
     emoji: string;
 };
-export type ControlDeckIcon = ControlDeckImageIcon | ControlDeckGlyphIcon | ControlDeckEmojiIcon | ControlDeckNoneIcon;
+export type ControlDeckIcon = ControlDeckImageIcon | ControlDeckGlyphIcon | ControlDeckEmojiIcon;
+export type ControlDeckBackground = {
+    type: "color";
+    color: string;
+} | {
+    type: "image";
+    source: "local" | "url";
+    path: string;
+};
 export type ControlDeckInputType = "text" | "number" | "toggle" | "preset";
 type ControlDeckInputBase = {
     /** Unique name of the input, used to access the value in effects */
@@ -64,33 +68,40 @@ export type ControlDeckControlSize = {
     /** Number of grid rows the control spans (default 1) */
     height: number;
 };
-export type ControlDeckControl = {
+export type ControlDeckControl<Params extends FirebotParams = FirebotParams> = {
     id: string;
+    /** Reference name (shown in the editor, folder breadcrumbs, etc — not on the control itself) */
     name: string;
-    type: ControlDeckControlType;
+    /** The control type id, e.g. "firebot:button" */
+    type: string;
+    /** Optional label rendered on the control itself, if the control type allows labels */
+    label?: string;
+    /** Font config for the label */
+    labelFont?: Partial<FontOptions>;
+    /** Label size as a percentage of the default size (100 = default) */
+    labelSize?: number;
     /** The page this control belongs to */
     pageId: string;
     /** The parent folder control id, or null when placed at the page root */
     parentId: string | null;
-    /** The icon shown on the control */
-    icon: ControlDeckIcon;
-    backgroundColor?: string;
+    /** The icon shown on the control, if the control type allows icons */
+    icon?: ControlDeckIcon;
+    /** Icon size as a percentage of the default size (100 = default) */
+    iconSize?: number;
+    /** The background shown behind the control, if the control type allows backgrounds */
+    background?: ControlDeckBackground;
     /** Placement within the deck's grid */
     position?: ControlDeckControlPosition;
     /** How many grid cells the control spans (default 1x1) */
     size?: ControlDeckControlSize;
-    /** Effects to run when the control is pressed. Only used when type is "button" */
-    effectList?: EffectList;
     /**
-     * Inputs the user is prompted for when the control is pressed on the hosted
-     * page. The provided values are sent with the press and are available to
-     * effects via $controlDeckInput
+     * Inputs the user is prompted for when the control is interacted with on the
+     * hosted page. The provided values are sent with the interaction and are
+     * available to effects via $controlDeckInput
      */
     inputs?: ControlDeckControlInput[];
-    /**
-     * Whether a folder control should automatically return to the parent page after a button within it is pressed. Only used when type is "folder".
-     */
-    autoReturn?: boolean;
+    /** Type-specific settings, defined by the control type's settingsSchema */
+    settings: Params;
 };
 export type ControlDeckGrid = {
     cols: number;
@@ -116,7 +127,7 @@ export type ControlDeckSettings = {
     /**
      * How the hosted grid responds to device rotation.
      * - "fixed": grid keeps its designed dimensions regardless of orientation
-     * - "dynamic": grid rotates to best fill the screen for the current orientation
+     * - "dynamic": grid rotates to best fill the screen
      */
     orientationMode?: ControlDeckOrientationMode;
 };
@@ -131,16 +142,95 @@ export type ControlDeckResolvedIcon = {
     type: "emoji";
     emoji: string;
 };
-/**
- * A control as projected to the hosted Control Deck page. Server-only fields
- * (the raw effect list and local icon path) are removed, and the resolved
- * `icon` the page should render is added.
- */
-export type ControlDeckControlView = Omit<ControlDeckControl, "icon" | "effectList"> & {
+/** A control background as projected to the hosted page (local images resolved to urls) */
+export type ControlDeckResolvedBackground = {
+    type: "color";
+    color: string;
+} | {
+    type: "image";
+    url: string;
+};
+export type ControlDeckControlView = Omit<ControlDeckControl, "icon" | "background" | "settings"> & {
     icon?: ControlDeckResolvedIcon;
+    background?: ControlDeckResolvedBackground;
+    resolvedSettings: Record<string, unknown>;
+    /** Current runtime state for stateful control types (e.g. a Switch's on/off value) */
+    state?: unknown;
+    shell: "standard" | "none";
 };
 /** A deck as projected to the hosted Control Deck page. */
 export type ControlDeckView = Omit<ControlDeck, "controls"> & {
     controls: ControlDeckControlView[];
 };
+/** The event passed to a control type's onInteraction handler */
+export type ControlDeckInteractionEvent<Params extends FirebotParams = FirebotParams> = {
+    control: ControlDeckControl<Params>;
+    deckId: string;
+    action: string;
+    data: unknown;
+    /** Values the user provided for the control's configured inputs */
+    inputValues: Record<string, string | number | boolean>;
+};
+export type ControlDeckInteractionContext<State = unknown> = {
+    /**
+     * Runs an effect list with the standard control_deck trigger metadata.
+     * metadata is merged into the trigger metadata.
+     */
+    triggerEffectList: (effectList: EffectList, extraMetadata?: Record<string, unknown>) => Promise<void>;
+    /** The control's current runtime state (stateful types only) */
+    getState: () => State;
+    /**
+     * Sets the control's runtime state. The central store persists it and
+     * broadcasts the change to connected devices.
+     */
+    setState: (newState: State) => Promise<void>;
+};
+/** Context provided when a stateful control type computes its initial state */
+export type ControlDeckStateInitContext = {
+    triggerEffectList: (effectList: EffectList, extraMetadata?: Record<string, unknown>) => Promise<void>;
+};
+export type ControlDeckControlTypeState<Params extends FirebotParams = FirebotParams, State = unknown> = {
+    /**
+     * Called on Firebot startup (and when a control is first added) to compute
+     * the state the control should initialize to
+     */
+    getInitialState: (event: {
+        control: ControlDeckControl<Params>;
+        persistedState: State | undefined;
+    }, context: ControlDeckStateInitContext) => Awaitable<State>;
+};
+export type ControlDeckControlType<Params extends FirebotParams = FirebotParams, State = void> = {
+    id: string;
+    /** Display name shown in the Add Control picker, e.g. "Slider" */
+    name: string;
+    description: string;
+    /** Font Awesome icon class for the Add Control picker, e.g. "fa-square" */
+    icon: string;
+    /** Default grid cell span when the control is added */
+    defaultSize?: ControlDeckControlSize;
+    minSize?: ControlDeckControlSize;
+    maxSize?: ControlDeckControlSize;
+    /** When false, the control cannot be resized in the editor. Defaults to true. */
+    resizable?: boolean;
+    /** When true, the standard icon config is shown for controls of this type */
+    enableIcon?: boolean;
+    /**
+     * Default icon for new controls of this type.
+     */
+    defaultIcon?: ControlDeckIcon;
+    /** When true, the standard background config (color or image) is shown for controls of this type */
+    enableBackground?: boolean;
+    /** When true, the inputs config is shown for controls of this type */
+    enableInputs?: boolean;
+    /** When true, the optional label (+ label font) config is shown for controls of this type */
+    enableLabel?: boolean;
+    /** The shell style for the control. "standard" uses the default shell and click animation, "none" removes it. */
+    shell?: "standard" | "none";
+    /** Schema for the type-specific settings shown in the control edit modal */
+    settingsSchema: FirebotParameterArray<Params>;
+    /** Declares this control type as stateful. */
+    state?: ControlDeckControlTypeState<Params, State>;
+    /** Called when a device interacts with a control of this type */
+    onInteraction: (event: ControlDeckInteractionEvent<Params>, context: ControlDeckInteractionContext<State>) => Awaitable<void>;
+};
 export {};

package/types/parameters.d.ts

@@ -38,6 +38,7 @@ export type PasswordParameter = BaseParameter & {
 };
 export type BooleanParameter = BaseParameter & {
     type: "boolean";
+    useSwitch?: boolean;
     default: boolean;
 };
 export type NumberParameter = BaseParameter & {
@@ -180,6 +181,8 @@ export type FontOptionsParameter = BaseParameter & {
     default: FontOptions;
     allowAlpha?: boolean;
     hideColor?: boolean;
+    /** When true, the font size input is hidden */
+    hideSize?: boolean;
 };
 export type RadioCardsParameter<V = string> = BaseParameter & {
     type: "radio-cards";

package/types/plugin-api.d.ts

@@ -105,16 +105,6 @@ export interface PluginFrontendCommunicatorApi {
      * back.
      */
     fireEventAsync<ReturnPayload = void, ExpectedArg = unknown>(eventName: string, data?: ExpectedArg): Promise<ReturnPayload>;
-    /**
-     * Handle a synchronous event triggered by the frontend. Returns an
-     * `unsubscribe` function.
-     */
-    on<ExpectedArgs extends Array<unknown> = [], ReturnPayload = void>(eventName: string, callback: (...args: ExpectedArgs) => ReturnPayload): () => void;
-    /**
-     * Handle an asynchronous event triggered by the frontend. Returns an
-     * `unsubscribe` function.
-     */
-    onAsync<ExpectedArgs extends Array<unknown> = [], ReturnPayload = void>(eventName: string, callback: (...args: ExpectedArgs) => Promise<ReturnPayload>): () => void;
 }
 export interface PluginSettingsApi {
     /**

package/types/plugins.d.ts

@@ -8,7 +8,7 @@ import type { RestrictionType } from "./restrictions";
 import type { FirebotParams, FirebotParameterArray } from "./parameters";
 import type { FirebotGame } from "./games";
 import type { Integration } from "./integrations";
-import type { UIExtension } from "./ui-extensions";
+import type { FrontendListener, UIExtension } from "./ui-extensions";
 import type { OverlayWidgetType } from "./overlay-widgets";
 import type { PluginHttpRouteDefinition } from "./http-server";
 import type { CustomWebSocketHandler } from "./websocket";
@@ -114,6 +114,7 @@ export interface Plugin<Params extends FirebotParams = FirebotParams> extends Pl
         restrictions?: DynamicArray<RestrictionType<any>>;
         systemCommands?: DynamicArray<SystemCommand<any>>;
         games?: DynamicArray<FirebotGame>;
+        frontendListeners?: DynamicArray<FrontendListener>;
         uiExtensions?: DynamicArray<UIExtension>;
         overlayWidgets?: DynamicArray<OverlayWidgetType<any, any>>;
         httpRoutes?: DynamicObject<PluginHttpRouteDefinition>;

package/types/restrictions.d.ts

@@ -8,6 +8,10 @@ interface RestrictionScope<RestrictionModel> extends ng.IScope {
     [x: string]: any;
 }
 export type RestrictionMode = "all" | "any" | "none";
+export type RestrictionResult = {
+    success: boolean;
+    failureReason?: string;
+};
 export type RestrictionType<RestrictionModel = unknown> = {
     definition: {
         id: string;
@@ -19,7 +23,7 @@ export type RestrictionType<RestrictionModel = unknown> = {
     optionsTemplate: string;
     optionsController?: ($scope: RestrictionScope<RestrictionModel>, ...args: any[]) => void;
     optionsValueDisplay?: (restriction: RestrictionModel, ...args: any[]) => string;
-    predicate(triggerData: Trigger, restrictionData: RestrictionModel, inherited?: boolean): Awaitable<boolean>;
+    predicate(triggerData: Trigger, restrictionData: RestrictionModel, inherited?: boolean): Awaitable<RestrictionResult>;
     onSuccessful?: (triggerData: Trigger, restrictionData: RestrictionModel, inherited?: boolean) => Awaitable<void>;
 };
 export type Restriction<RestrictionModel = unknown> = {

package/types/settings.d.ts

@@ -55,7 +55,6 @@ export type FirebotSettingsTypes = {
     ChatTaggedNotificationVolume: number;
     ChatTimestamps: boolean;
     ClearChatFeedMode: "never" | "onlyStreamer" | "always";
-    ClearCustomScriptCache: boolean;
     ConnectOnLaunch: boolean;
     ControlDeckEnabled: boolean;
     ControlDeckPin?: string;

package/types/ui/control-deck-service.d.ts

@@ -0,0 +1,8 @@
+export type ControlDeckService = {
+    getControlType: (typeId: string) => {
+        settingsSchema?: Array<{
+            name: string;
+            type?: string;
+        }>;
+    } | null;
+};

package/types/ui/index.d.ts

@@ -10,3 +10,4 @@ export * from "./firebot-root-scope";
 export * from "./object-copy-helper";
 export * from "./preset-effect-lists-service";
 export * from "./effect-queues-service";
+export * from "./control-deck-service";

package/types/ui-extensions.d.ts

@@ -1,3 +1,4 @@
+import type { Awaitable } from "./util-types";
 export type BasePage = {
     id: string;
     name: string;
@@ -94,3 +95,8 @@ export type UIExtension = {
         parameters?: AngularJsFirebotParameterComponent[];
     };
 };
+export type FrontendListener = {
+    eventName: string;
+    useAsync?: boolean;
+    handler: (...args: unknown[]) => Awaitable<unknown>;
+};

package/types/util-types.d.ts

@@ -23,4 +23,8 @@ type CamelToSnake<S extends string, Acc extends string = ""> = S extends `${infe
 export type SnakeCased<T> = T extends Date ? string : T extends Array<infer U> ? Array<SnakeCased<U>> : T extends object ? {
     [K in keyof T as K extends string ? CamelToSnake<K> : K]: SnakeCased<T[K]>;
 } : T;
+type SnakeToCamel<S extends string> = S extends `${infer H}_${infer T}` ? `${H}${Capitalize<SnakeToCamel<T>>}` : S;
+export type CamelCased<T> = T extends Date ? string : T extends Array<infer U> ? Array<CamelCased<U>> : T extends object ? {
+    [K in keyof T as K extends string ? SnakeToCamel<K> : K]: CamelCased<T[K]>;
+} : T;
 export {};