@crowbartools/firebot-types 5.67.0-alpha27 → 5.67.0-alpha29

package/backend/effects/builtin/overlay-widgets/update-rotating-text.d.ts

@@ -0,0 +1,12 @@
+import type { EffectType } from "../../../../types";
+declare const model: EffectType<{
+    rotatingTextWidgetId: string;
+    action: "add" | "remove" | "set";
+    texts?: string[];
+    variableEvaluation?: "dynamic" | "onRun";
+    removeMode?: "first" | "last" | "position" | "matching";
+    removePosition?: number;
+    removeValue?: string;
+    removeExactMatch?: boolean;
+}>;
+export = model;

package/backend/overlay-widgets/builtin-types/index.d.ts

@@ -28,7 +28,7 @@ declare const _default: (import("../../../types").OverlayWidgetType<import("./ch
     fontOptions?: import("../../../types").FontOptions;
     horizontalAlignment: "left" | "center" | "right";
     verticalAlignment: "top" | "center" | "bottom";
-}, {}> | import("../../../types").OverlayWidgetType<{
+}, {}> | import("../../../types").OverlayWidgetType<import("./rotating-text/rotating-text").RotatingTextSettings, import("./rotating-text/rotating-text").RotatingTextState> | import("../../../types").OverlayWidgetType<{
     format?: string;
     fontOptions?: import("../../../types").FontOptions;
     horizontalAlignment: "left" | "center" | "right";

package/backend/overlay-widgets/builtin-types/rotating-text/rotating-text.d.ts

@@ -0,0 +1,18 @@
+import type { OverlayWidgetType, OverlayWidgetConfig, FontOptions, Animation } from "../../../../types";
+export declare const ROTATING_TEXT_TYPE_ID = "firebot:rotating-text";
+export type RotatingTextSettings = {
+    texts: string[];
+    intervalSeconds: number;
+    randomizeOrder: boolean;
+    fontOptions?: FontOptions;
+    horizontalAlignment: "left" | "center" | "right";
+    verticalAlignment: "top" | "center" | "bottom";
+    backgroundColor: string;
+    backgroundBorderRadius: number;
+    addDropShadow: boolean;
+    textEnterAnimation: Animation;
+    textExitAnimation: Animation;
+};
+export type RotatingTextState = Record<string, never>;
+export type RotatingTextWidgetConfig = OverlayWidgetConfig<RotatingTextSettings, RotatingTextState>;
+export declare const rotatingText: OverlayWidgetType<RotatingTextSettings, RotatingTextState>;

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

@@ -1,4 +1,4 @@
-import { InstalledPluginConfig, LegacyCustomScript, PluginBase, Awaitable, PluginDetails, AdditionalVariableEvent, AdditionalEffectEvent } from "../../../types";
+import { InstalledPluginConfig, LegacyCustomScript, PluginBase, Awaitable, PluginDetails, AdditionalVariableEvent, AdditionalEffectEvent, AdditionalFilterEvent } from "../../../types";
 import type { PluginApiContext } from "../plugin-api";
 declare abstract class IBasePluginExecutor {
     abstract canHandle(plugin: PluginBase | LegacyCustomScript): Awaitable<boolean>;
@@ -24,6 +24,7 @@ export interface PluginRegistrations {
     websocketListenerName?: string;
     additionalVariableEvents?: AdditionalVariableEvent[];
     additionalEffectEvents?: AdditionalEffectEvent[];
+    additionalFilterEvents?: AdditionalFilterEvent[];
 }
 export type PluginExecutionResult = {
     success: true;

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

@@ -101,6 +101,7 @@ declare class PluginManager {
     private loadPluginIsolated;
     private isValidPlugin;
     private searchForCommunityPlugins;
+    private trackCommunityPluginDownload;
     private downloadAndSaveCommunityPlugin;
     private installCommunityPlugin;
     private updateCommunityPlugin;

package/backend/streaming-platforms/twitch/api/eventsub/eventsub-client.d.ts

@@ -2,6 +2,7 @@ declare class TwitchEventSubClient {
     private logger;
     private _eventSubListener;
     private _subscriptions;
+    private ensureViewerExists;
     private createSubscriptions;
     createClient(): void;
     removeSubscriptions(): void;

package/package.json

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

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

@@ -1,7 +1,7 @@
 import { EventEmitter } from "events";
 import { Express, Request, Response, Router } from "express";
 import http from "http";
-import type { HttpMethod, CustomHttpRoute, PluginHttpRouteDefinition, CustomWebSocketHandler, Awaitable } from "../types";
+import type { HttpMethod, CustomHttpRoute, PluginHttpRouteDefinition, PluginWebSocketHandler, Awaitable } from "../types";
 interface ServerInstance {
     name: string;
     port: number;
@@ -63,7 +63,7 @@ declare class HttpServerManager extends EventEmitter {
     };
     private getCustomRoutePathFromRoot;
     private removeCustomRoute;
-    registerCustomWebSocketListener(pluginName: string, handler: CustomWebSocketHandler["handler"]): boolean;
+    registerCustomWebSocketListener(pluginName: string, handler: PluginWebSocketHandler["handler"]): boolean;
     unregisterCustomWebSocketListener(pluginName: string): boolean;
 }
 declare const manager: HttpServerManager;

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

@@ -1,11 +1,12 @@
 import { EventEmitter } from "events";
 import http from "http";
-import type { CustomWebSocketHandler, WidgetOverlayEvent } from "../types";
+import type { PluginWebSocketHandler, WidgetOverlayEvent, OverlayRequestWebSocketHandler } from "../types";
 declare class WebSocketServerManager extends EventEmitter {
     private logger;
     overlayHasClients: boolean;
     private server;
-    private customHandlers;
+    private pluginHandlers;
+    private overlayRequestHandlers;
     constructor();
     createServer(httpServer: http.Server): void;
     sendToOverlay(eventName: string, meta?: Record<string, unknown>, overlayInstance?: string): void;
@@ -15,8 +16,9 @@ declare class WebSocketServerManager extends EventEmitter {
     triggerEvent(eventType: string, payload: unknown): void;
     reportClientsToFrontend(isDefaultServerStarted: boolean): void;
     getNumberOfOverlayClients(): number;
-    registerCustomWebSocketListener(pluginName: string, handler: CustomWebSocketHandler["handler"]): boolean;
+    registerCustomWebSocketListener(pluginName: string, handler: PluginWebSocketHandler["handler"]): boolean;
     unregisterCustomWebSocketListener(pluginName: string): boolean;
+    registerOverlayRequestHandler<TData extends Record<string, unknown> = Record<string, unknown>, TResponse = unknown>(handler: OverlayRequestWebSocketHandler<TData, TResponse>): boolean;
 }
 declare const manager: WebSocketServerManager;
 export { manager as WebSocketServerManager };

package/types/events.d.ts

@@ -53,6 +53,15 @@ export type EventFilterData = {
     mode: "inclusive" | "exclusive";
     filters: FilterSettings[];
 };
+export type AdditionalFilterEvent = {
+    filterId: string;
+    eventSourceId: string;
+    eventId: string;
+};
+export type PluginAdditionalFilterEvents = {
+    filterId: string;
+    events: Array<EventSourceAndId>;
+};
 export type EventSettings = {
     id: string;
     type: string;

package/types/overlay-widgets.d.ts

@@ -276,6 +276,7 @@ export interface IOverlayWidgetEventUtils {
     stylesToString(styles: Record<string, string | number | undefined>): string;
     getFontOptionsStyles(fontOptions?: FontOptions): Record<string, string | number | undefined>;
     sendMessageToFirebot(messageName: string, messageData?: unknown): void;
+    invokeFirebotRequest<TData extends Record<string, unknown> = Record<string, unknown>, TResponse = unknown>(requestName: string, requestData?: TData): Promise<TResponse>;
 }
 export interface IOverlayWidgetInitUtils {
     getWidgetContainerElements(): NodeListOf<HTMLElement>;

package/types/parameters.d.ts

@@ -26,6 +26,7 @@ export type BaseParameter = {
         pattern?: string;
     };
     default?: unknown;
+    allowReplaceVariables?: boolean;
 };
 export type StringParameter = BaseParameter & {
     type: "string";