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

package/README.md

@@ -1,6 +1,6 @@
 # @crowbartools/firebot-types
 
-Type definitions and the script API contract for [Firebot](https://firebot.app) custom scripts and plugins.
+Type definitions and the plugin API contract for [Firebot](https://firebot.app) plugins.
 
 This package is **type-only**. At runtime the `@crowbartools/firebot-types` module is provided by the Firebot host application via a `require()` interceptor (installing this package in a standalone Node project and importing it will throw).
 

package/backend/bonjour-manager.d.ts

@@ -0,0 +1,11 @@
+declare class BonjourManager {
+    private logger;
+    private bonjour;
+    private service;
+    constructor();
+    start(): void;
+    stop(): void;
+    getHost(): string;
+}
+declare const manager: BonjourManager;
+export { manager as BonjourManager };

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

@@ -1,6 +1,11 @@
-import { EventEmitter } from "events";
+import { TypedEmitter } from "tiny-typed-emitter";
 import type { FirebotAutoUpdateLevel, FirebotSettingsTypes } from "../../types";
-declare class SettingsManager extends EventEmitter {
+type Events = {
+    [settingName in keyof FirebotSettingsTypes as `settings:setting-updated:${settingName}`]: (data: FirebotSettingsTypes[settingName]) => void;
+} & {
+    [settingName in keyof FirebotSettingsTypes as `settings:setting-deleted:${settingName}`]: () => void;
+};
+declare class SettingsManager extends TypedEmitter<Events> {
     private logger;
     settingsCache: Partial<Record<keyof FirebotSettingsTypes, unknown>>;
     constructor();

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

@@ -0,0 +1,13 @@
+import { ControlDeck, ControlDeckControl } from "../../types";
+import JsonDbManager from "../database/json-db-manager";
+declare class ControlDeckManager extends JsonDbManager<ControlDeck> {
+    constructor();
+    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 broadcastToControlDecks;
+    triggerUiRefresh(): void;
+}
+declare const controlDeckManager: ControlDeckManager;
+export { controlDeckManager as ControlDeckManager };

package/backend/effects/builtin/set-active-control-deck.d.ts

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

package/backend/effects/builtin/set-default-control-deck.d.ts

@@ -0,0 +1,5 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    deckId: string;
+}>;
+export = effect;

package/backend/plugin-log-names.d.ts

@@ -0,0 +1,3 @@
+export declare function registerPluginLogName(pluginId: string, displayName: string): void;
+export declare function unregisterPluginLogName(pluginId: string): void;
+export declare function getPluginLogName(pluginId: string): string | undefined;

package/backend/plugins/executors/legacy-effect-script-executor.d.ts

@@ -0,0 +1,15 @@
+import type { PluginBase, LegacyCustomScript, PluginContext, PluginDetails } from "../../../types";
+import type { EffectScriptExecutionResult } from "./plugin-executor.interface";
+/**
+ * Executor for legacy effect scripts (run function with no manifest or startupOnly !== true)
+ */
+export declare class LegacyEffectScriptExecutor {
+    canHandle(script: PluginBase | LegacyCustomScript): Promise<boolean>;
+    getScriptDetails(script: PluginBase | LegacyCustomScript): Promise<PluginDetails | null>;
+    executeScript(script: PluginBase | LegacyCustomScript, context: PluginContext): Promise<EffectScriptExecutionResult>;
+    private isLegacy;
+    /**
+     * Runs effects returned by a custom script and returns flow-control flags.
+     */
+    private runEffectsResult;
+}

package/backend/plugins/executors/legacy-startup-script-executor.d.ts

@@ -0,0 +1,15 @@
+import { PluginBase, LegacyCustomScript, InstalledPluginConfig, PluginDetails } from "../../../types";
+import { IPluginExecutor, PluginExecutionResult } from "./plugin-executor.interface";
+/**
+ * Executor for legacy startup scripts (scripts that export a getScriptManifest function that returns an object with startupOnly: true)
+ */
+export declare class LegacyStartUpScript extends IPluginExecutor {
+    constructor();
+    canHandle(script: PluginBase | LegacyCustomScript): Promise<boolean>;
+    executePlugin(script: PluginBase | LegacyCustomScript, config: InstalledPluginConfig): Promise<PluginExecutionResult>;
+    unloadPlugin(script: PluginBase | LegacyCustomScript, config: InstalledPluginConfig): Promise<void>;
+    updateParameters(script: PluginBase | LegacyCustomScript, config: InstalledPluginConfig): Promise<void>;
+    getPluginDetails(script: PluginBase | LegacyCustomScript): Promise<PluginDetails>;
+    private buildParameters;
+    private isLegacyScript;
+}

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

@@ -0,0 +1,18 @@
+import { PluginBase, LegacyCustomScript, Plugin, InstalledPluginConfig, PluginDetails } from "../../../types";
+import { IPluginExecutor, PluginRegistrations, PluginExecutionResult } from "./plugin-executor.interface";
+import { PluginApiContext } from "../plugin-api";
+/**
+ * Executor for new-spec Plugins (manifest.type === "plugin")
+ */
+export declare class PluginExecutor extends IPluginExecutor {
+    constructor();
+    canHandle(plugin: PluginBase | LegacyCustomScript): plugin is Plugin<import("../../../types").FirebotParams>;
+    getPluginDetails(plugin: PluginBase | LegacyCustomScript): PluginDetails | null;
+    executePlugin(plugin: PluginBase | LegacyCustomScript, config: InstalledPluginConfig, isInstalling?: boolean, ctx?: PluginApiContext): Promise<PluginExecutionResult>;
+    unloadPlugin(plugin: PluginBase | LegacyCustomScript, config: InstalledPluginConfig, registrations?: PluginRegistrations, isUninstalling?: boolean): Promise<void>;
+    updateParameters(plugin: PluginBase | LegacyCustomScript, config: InstalledPluginConfig): Promise<void>;
+    private registerAll;
+    private runUnregistrations;
+    private buildParameters;
+    private isPlugin;
+}

package/backend/{scripts/executors/script-executor.interface.d.ts → plugins/executors/plugin-executor.interface.d.ts}

@@ -1,8 +1,8 @@
-import { InstalledPluginConfig, LegacyCustomScript, ScriptBase, ScriptContext, Awaitable, ScriptDetails, AdditionalVariableEvent, AdditionalEffectEvent } from "../../../types";
-import type { ScriptApiContext } from "../script-api";
-declare abstract class IBaseScriptExecutor {
-    abstract canHandle(script: ScriptBase | LegacyCustomScript): Awaitable<boolean>;
-    abstract getScriptDetails(script: ScriptBase | LegacyCustomScript): Awaitable<ScriptDetails | null>;
+import { InstalledPluginConfig, LegacyCustomScript, PluginBase, Awaitable, PluginDetails, AdditionalVariableEvent, AdditionalEffectEvent } from "../../../types";
+import type { PluginApiContext } from "../plugin-api";
+declare abstract class IBasePluginExecutor {
+    abstract canHandle(plugin: PluginBase | LegacyCustomScript): Awaitable<boolean>;
+    abstract getPluginDetails(plugin: PluginBase | LegacyCustomScript): Awaitable<PluginDetails | null>;
 }
 export interface PluginRegistrations {
     effectIds?: string[];
@@ -27,10 +27,10 @@ export type PluginExecutionResult = {
     success: false;
     error: string;
 };
-export declare abstract class IPluginExecutor extends IBaseScriptExecutor {
-    abstract executePlugin(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig, isInstalling?: boolean, ctx?: ScriptApiContext): Awaitable<PluginExecutionResult>;
-    abstract unloadPlugin(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig, registrations?: PluginRegistrations, isUninstalling?: boolean): Awaitable<void>;
-    updateParameters?(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig): Awaitable<void>;
+export declare abstract class IPluginExecutor extends IBasePluginExecutor {
+    abstract executePlugin(plugin: PluginBase | LegacyCustomScript, config: InstalledPluginConfig, isInstalling?: boolean, ctx?: PluginApiContext): Awaitable<PluginExecutionResult>;
+    abstract unloadPlugin(plugin: PluginBase | LegacyCustomScript, config: InstalledPluginConfig, registrations?: PluginRegistrations, isUninstalling?: boolean): Awaitable<void>;
+    updateParameters?(plugin: PluginBase | LegacyCustomScript, config: InstalledPluginConfig): Awaitable<void>;
 }
 export type EffectScriptExecutionResult = {
     success: true;
@@ -42,7 +42,4 @@ export type EffectScriptExecutionResult = {
     success: false;
     error: string;
 };
-export declare abstract class IEffectScriptExecutor extends IBaseScriptExecutor {
-    abstract executeScript(script: ScriptBase | LegacyCustomScript, context: ScriptContext): Awaitable<EffectScriptExecutionResult>;
-}
 export {};

package/backend/{scripts/script-api → plugins/plugin-api}/context.d.ts

@@ -3,47 +3,42 @@ import { DisposeBag, DisposeFn } from "./internal/dispose-bag";
 import { normalizeName } from "./internal/name-normalizer";
 declare const logger: import("winston").Logger;
 /**
- * The per-script context handed to every namespace factory.
+ * The per-plugin context handed to every namespace factory.
  *
- * `manifest` is populated after the script is first loaded. Shim methods should read `ctx.manifest`
+ * `manifest` is populated after the plugin is first loaded. Shim methods should read `ctx.manifest`
  * lazily (inside method bodies) instead of at factory time.
  */
-export interface ScriptApiContext {
+export interface PluginApiContext {
     /** If a plugin, the installed config id.  */
     readonly pluginId?: string;
     /**
-     * Normalized, filesystem-safe scope id for this plugin/script.
+     * Normalized, filesystem-safe scope id for this plugin.
      */
     readonly scriptId: string;
-    /** The on-disk filename of the script. */
+    /** The on-disk filename of the plugin. */
     readonly fileName: string;
     /** Manifest, once known. Undefined during very-early loading. */
     readonly manifest: Manifest | undefined;
     /** Human-friendly display name. Manifest name when available, else fileName. */
     readonly displayName: string;
-    /** Absolute path to this script's data directory. */
+    /** Absolute path to this plugin's data directory. */
     readonly scriptDataDir: string;
-    /** Winston child logger pre-tagged with `{ script: scriptId }`. */
+    /** Winston child logger pre-tagged with `{ plugin: pluginId }`. */
     readonly logger: typeof logger;
-    /** True when script is being inspected (e.g. during early detail / manifest retrieval). */
+    /** True when plugin is being inspected (e.g. during early detail / manifest retrieval). */
     readonly isInspecting: boolean;
     /** Register a teardown callback fired when the plugin is unloaded. */
     onDispose(fn: DisposeFn): void;
 }
-export interface ScriptApiContextHandle {
-    readonly context: ScriptApiContext;
+export interface PluginApiContextHandle {
+    readonly context: PluginApiContext;
     readonly disposeBag: DisposeBag;
 }
-export type ScriptApiContextSource = {
+export type PluginApiContextSource = {
     kind: "plugin";
     config: InstalledPluginConfig;
     manifest: Manifest;
     isInspecting: boolean;
-} | {
-    kind: "effect-script";
-    fileName: string;
-    manifest: Manifest;
-    isInspecting: boolean;
 };
-export declare function createScriptApiContext(source: ScriptApiContextSource): ScriptApiContextHandle;
+export declare function createPluginApiContext(source: PluginApiContextSource): PluginApiContextHandle;
 export { normalizeName };

package/backend/plugins/plugin-api/index.d.ts

@@ -0,0 +1,8 @@
+import type { FirebotPluginApi } from "../../../types/plugin-api";
+import type { PluginApiContext } from "./context";
+/**
+ * Composition root for the Firebot Plugin API
+ */
+export declare function buildPluginApi(ctx: PluginApiContext): FirebotPluginApi;
+export type { PluginApiContext, PluginApiContextSource } from "./context";
+export { createPluginApiContext } from "./context";

package/backend/plugins/plugin-api/internal/define-namespace.d.ts

@@ -0,0 +1,3 @@
+import type { PluginApiContext } from "../context";
+export type PluginApiNamespaceFactory<TApi> = (ctx: PluginApiContext) => TApi;
+export declare function definePluginApiNamespace<TApi>(factory: PluginApiNamespaceFactory<TApi>): PluginApiNamespaceFactory<TApi>;

package/backend/{scripts/script-api → plugins/plugin-api}/internal/dispose-bag.d.ts

@@ -1,6 +1,6 @@
 export type DisposeFn = () => void | Promise<void>;
 /**
- * Collects teardown callbacks registered by script-api namespaces during plugin
+ * Collects teardown callbacks registered by plugin-api namespaces during plugin
  * startup, and drains them (in reverse order / LIFO) when the plugin is unloaded.
  */
 export declare class DisposeBag {

package/backend/{scripts/script-api → plugins/plugin-api}/internal/name-normalizer.d.ts

@@ -1,5 +1,5 @@
 /**
- * Normalizes a script name or file name into a slug safe for use
+ * Normalizes a plugin name or file name into a slug safe for use
  * as a stable identifier.
  */
 export declare function normalizeName(value: string | undefined | null): string;

package/backend/plugins/plugin-api/internal/plugin-data-dir.d.ts

@@ -0,0 +1 @@
+export declare function resolvePluginDataDir(pluginId: string): string;

package/backend/plugins/plugin-api/namespaces/effects.d.ts

@@ -0,0 +1,2 @@
+import type { PluginEffectsApi } from "../../../../types/plugin-api";
+export declare const createEffectsApi: import("../internal/define-namespace").PluginApiNamespaceFactory<PluginEffectsApi>;

package/backend/plugins/plugin-api/namespaces/event-filter-factory.d.ts

@@ -0,0 +1,2 @@
+import type { PluginEventFilterFactoryApi } from "../../../../types/plugin-api";
+export declare const createEventFilterFactoryApi: import("../internal/define-namespace").PluginApiNamespaceFactory<PluginEventFilterFactoryApi>;

package/backend/plugins/plugin-api/namespaces/events.d.ts

@@ -0,0 +1,2 @@
+import type { PluginEventsApi } from "../../../../types/plugin-api";
+export declare const createEventsApi: import("../internal/define-namespace").PluginApiNamespaceFactory<PluginEventsApi>;

package/backend/plugins/plugin-api/namespaces/frontend-communicator.d.ts

@@ -0,0 +1,2 @@
+import type { PluginFrontendCommunicatorApi } from "../../../../types/plugin-api";
+export declare const createFrontendCommunicatorApi: import("../internal/define-namespace").PluginApiNamespaceFactory<PluginFrontendCommunicatorApi>;

package/backend/plugins/plugin-api/namespaces/http-server.d.ts

@@ -0,0 +1,2 @@
+import type { PluginWebServerApi } from "../../../../types/plugin-api";
+export declare const createWebServerApi: import("../internal/define-namespace").PluginApiNamespaceFactory<PluginWebServerApi>;

package/backend/plugins/plugin-api/namespaces/logger.d.ts

@@ -0,0 +1,2 @@
+import type { PluginLoggerApi } from "../../../../types/plugin-api";
+export declare const createLoggerApi: import("../internal/define-namespace").PluginApiNamespaceFactory<PluginLoggerApi>;

package/backend/plugins/plugin-api/namespaces/notifications.d.ts

@@ -0,0 +1,2 @@
+import type { PluginNotificationsApi } from "../../../../types/plugin-api";
+export declare const createNotificationsApi: import("../internal/define-namespace").PluginApiNamespaceFactory<PluginNotificationsApi>;

package/backend/plugins/plugin-api/namespaces/parameters.d.ts

@@ -0,0 +1,2 @@
+import type { PluginParametersApi } from "../../../../types/plugin-api";
+export declare const createParametersApi: import("../internal/define-namespace").PluginApiNamespaceFactory<PluginParametersApi>;

package/backend/plugins/plugin-api/namespaces/plugins.d.ts

@@ -0,0 +1,2 @@
+import type { PluginPluginsApi } from "../../../../types/plugin-api";
+export declare const createPluginsApi: import("../internal/define-namespace").PluginApiNamespaceFactory<PluginPluginsApi>;

package/backend/plugins/plugin-api/namespaces/settings.d.ts

@@ -0,0 +1,2 @@
+import type { PluginSettingsApi } from "../../../../types/plugin-api";
+export declare const createSettingsApi: import("../internal/define-namespace").PluginApiNamespaceFactory<PluginSettingsApi>;

package/backend/plugins/plugin-api/namespaces/storage.d.ts

@@ -0,0 +1,6 @@
+import type { PluginStorageApi } from "../../../../types/plugin-api";
+/**
+ * Simple per-plugin storage. Lets a plugin easily save/load JSON values or
+ * arbitrary files inside its own data directory.
+ */
+export declare const createStorageApi: import("../internal/define-namespace").PluginApiNamespaceFactory<PluginStorageApi>;

package/backend/plugins/plugin-api/namespaces/twitch.d.ts

@@ -0,0 +1,2 @@
+import type { PluginTwitchApi } from "../../../../types/plugin-api";
+export declare const createTwitchApi: import("../internal/define-namespace").PluginApiNamespaceFactory<PluginTwitchApi>;

package/backend/plugins/plugin-api/namespaces/variable-factory.d.ts

@@ -0,0 +1,2 @@
+import type { PluginVariableFactoryApi } from "../../../../types/plugin-api";
+export declare const createVariableFactoryApi: import("../internal/define-namespace").PluginApiNamespaceFactory<PluginVariableFactoryApi>;

package/backend/plugins/plugin-api/namespaces/webhooks.d.ts

@@ -0,0 +1,2 @@
+import type { PluginWebhooksApi } from "../../../../types/plugin-api";
+export declare const createWebhooksApi: import("../internal/define-namespace").PluginApiNamespaceFactory<PluginWebhooksApi>;

package/backend/{scripts/script-manager.d.ts → plugins/plugin-manager.d.ts}

@@ -1,29 +1,28 @@
-import { InstalledPlugin, InstalledPluginConfig, ScriptDetails, ScriptType, Trigger } from "../../types";
-import { EffectScriptExecutionResult } from "./executors/script-executor.interface";
-type GetScriptDetailsResult = {
+import type { InstalledPlugin, InstalledPluginConfig, PluginDetails, PluginType, Trigger } from "../../types";
+import { EffectScriptExecutionResult } from "./executors/plugin-executor.interface";
+type GetPluginDetailsResult = {
     success: true;
     fileName: string;
-    scriptType: "plugin" | "script";
-    details: ScriptDetails;
+    pluginType: "plugin" | "script";
+    details: PluginDetails;
 } | {
     success: false;
     error: string;
 };
-declare class ScriptManager {
+declare class PluginManager {
     private startingPlugins;
     private activePlugins;
     private pendingApiInstances;
-    private effectScriptApiInstances;
     private requireInterceptorInstalled;
     private pluginExecutors;
-    private effectScriptExecutors;
+    private legacyEffectScriptExecutor;
     constructor();
     startPlugin(pluginConfig: InstalledPluginConfig, installing?: boolean): Promise<void>;
     private doStartPlugin;
     startPlugins(): Promise<void>;
     stopPlugin(pluginId: string, uninstalling?: boolean): Promise<void>;
     /**
-     * Convenience helper for hot-reloading. Finds an active plugin by its script file
+     * Convenience helper for hot-reloading. Finds an active plugin by its plugin file
      * name and restarts it (stop then start). Does nothing if no active plugin matches.
      */
     restartPluginByFileName(fileName: string): Promise<void>;
@@ -35,23 +34,23 @@ declare class ScriptManager {
     reloadPluginConfig(pluginConfig: InstalledPluginConfig, isNewInstall?: boolean): Promise<void>;
     setPluginEnabled(pluginId: string, enabled: boolean): Promise<void>;
     getInstalledPlugins(): Promise<InstalledPlugin[]>;
-    private doGetScriptDetailsByFileName;
+    private doGetPluginDetailsByFileName;
     /**
-     * Loads a script file (without persisting a config) and returns its details for
+     * Loads a plugin file (without persisting a config) and returns its details for
      * the install / edit UI.
      */
-    getScriptDetailsByFileName(fileName: string, expectedScriptType?: ScriptType): Promise<GetScriptDetailsResult>;
+    getPluginDetailsByFileName(fileName: string, expectedPluginType?: PluginType): Promise<GetPluginDetailsResult>;
     /**
      * Validates a file at any path on disk and copies it into the scripts folder.
      * Does NOT persist an InstalledPluginConfig — caller does that on save.
      */
-    installScriptFromPath(sourcePath: string, overwrite?: boolean): Promise<GetScriptDetailsResult | {
+    installPluginFromPath(sourcePath: string, overwrite?: boolean): Promise<GetPluginDetailsResult | {
         success: false;
         error: string;
         conflict?: boolean;
     }>;
     /**
-     * Delete a copied script file that the user cancelled installing, but only
+     * Delete a copied plugin file that the user cancelled installing, but only
      * when no config currently references it.
      */
     cancelInstall(fileName: string): Promise<void>;
@@ -60,17 +59,17 @@ declare class ScriptManager {
      * plugin.
      */
     onPluginConfigDeleted(pluginConfig: InstalledPluginConfig): Promise<void>;
-    deleteScriptFileIfUnreferenced(fileName: string): Promise<void>;
+    deletePluginFileIfUnreferenced(fileName: string): Promise<void>;
     /**
      * Remove an installed plugin. Stops the plugin and deletes its config, and
-     * optionally deletes the underlying script file from the scripts folder.
+     * optionally deletes the underlying plugin file from the scripts folder.
      */
-    deletePlugin(pluginId: string, deleteScriptFile?: boolean): Promise<boolean>;
+    deletePlugin(pluginId: string, deletePluginFile?: boolean): Promise<boolean>;
     /**
-     * Replace the underlying script file for an existing plugin config with a new file
+     * Replace the underlying plugin file for an existing plugin config with a new file
      * chosen on disk.
      */
-    updatePluginFromPath(pluginId: string, sourcePath: string, overwrite?: boolean): Promise<GetScriptDetailsResult | {
+    updatePluginFromPath(pluginId: string, sourcePath: string, overwrite?: boolean): Promise<GetPluginDetailsResult | {
         success: false;
         error: string;
         conflict?: boolean;
@@ -79,23 +78,21 @@ declare class ScriptManager {
         scriptName: string;
         parameters?: Record<string, unknown>;
     }, trigger?: Trigger): Promise<EffectScriptExecutionResult | undefined>;
-    private disposeEffectScriptApi;
-    private getScriptFilePath;
+    private getPluginFilePath;
     private getActivePluginByFileName;
     private findPluginExecutor;
     private installRequireInterceptor;
     private createApiInstance;
-    private loadScript;
+    private loadPlugin;
     /**
-     * Hack to load a script without registering it in `require.cache`.
+     * Hack to load a plugin without registering it in `require.cache`.
      *
      * Used for read-only inspection (manifest / parameter schema lookup) so that
-     * loading a fresh copy of a script does not evict or replace the cached module
+     * loading a fresh copy of a plugin does not evict or replace the cached module
      * of a currently-running plugin is holding a reference to.
      */
-    private loadScriptIsolated;
-    private scriptCanBePlugin;
+    private loadPluginIsolated;
+    private isValidPlugin;
 }
-declare const scriptManager: ScriptManager;
-export default scriptManager;
-export { ScriptManager };
+declare const pluginManager: PluginManager;
+export { pluginManager as PluginManager };

package/backend/variables/builtin/metadata/control-deck-input.d.ts

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

package/index.d.ts

@@ -1,7 +1,7 @@
 // Auto-generated by grunt build-types. Do not edit by hand.
-import { FirebotScriptApi } from "./types/script-api";
+import { FirebotPluginApi } from "./types/plugin-api";
 
 export * from "./types";
 
-declare const firebot: FirebotScriptApi;
+declare const firebot: FirebotPluginApi;
 export default firebot;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@crowbartools/firebot-types",
-  "version": "5.67.0-alpha19",
-  "description": "Type definitions and script API for Firebot plugins and custom scripts.",
+  "version": "5.67.0-alpha20",
+  "description": "Type definitions and plugin API for Firebot plugins.",
   "main": "index.js",
   "types": "index.d.ts",
   "exports": {

package/server/http-server-manager.d.ts

@@ -42,6 +42,7 @@ declare class HttpServerManager extends EventEmitter {
      * @param overlayInstance the instance to refresh, leave undefined to refresh default
      */
     refreshOverlayInstance(overlayInstance?: string): void;
+    sendToControlDecks(eventName: string, data?: unknown): void;
     triggerCustomWebSocketEvent(eventType: string, payload: object): void;
     createServerInstance(): Express;
     startHttpServer(name: string, port: number, instance: Express): http.Server;

package/server/websocket-client.d.ts

@@ -1,5 +1,5 @@
 import WebSocket from "ws";
 export declare class WebSocketClient extends WebSocket {
     registrationTimeout: ReturnType<typeof setTimeout>;
-    type?: "overlay" | "events";
+    type?: "overlay" | "events" | "control-deck";
 }

package/server/websocket-server-manager.d.ts

@@ -11,6 +11,7 @@ declare class WebSocketServerManager extends EventEmitter {
     sendToOverlay(eventName: string, meta?: Record<string, unknown>, overlayInstance?: string): void;
     sendWidgetEventToOverlay(event: WidgetOverlayEvent): void;
     refreshAllOverlays(): void;
+    sendToControlDecks(eventName: string, data?: unknown): void;
     triggerEvent(eventType: string, payload: unknown): void;
     reportClientsToFrontend(isDefaultServerStarted: boolean): void;
     getNumberOfOverlayClients(): number;