@crowbartools/firebot-types 5.67.0-alpha11 → 5.67.0-alpha12

package/backend/scripts/script-api/namespaces/http-server.d.ts

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

package/package.json

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

package/types/script-api.d.ts

@@ -203,6 +203,15 @@ export interface Accounts {
     bot: FirebotAccount;
 }
 
+export interface ScriptWebServerApi {
+    /**
+     * Sends a custom event over the internal Firebot WebSocket server
+     * @param name Name of the event to send. Full event name will be `custom-event:{name}`
+     * @param data Any optional data you would like to send with the event
+     */
+    sendWebSocketEvent(name: string, data?: unknown);
+}
+
 export interface FirebotScriptApi {
     /** Running Firebot version, e.g. `"5.67.0"`. */
     version: string;
@@ -230,4 +239,6 @@ export interface FirebotScriptApi {
     notifications: ScriptNotificationsApi;
     /** Access to installed plugins. */
     plugins: ScriptPluginsApi;
+    /** Firebot internal web server functions. */
+    webServer: ScriptWebServerApi;
 }