@crowbartools/firebot-types 5.67.0-alpha13 → 5.67.0-alpha15

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

@@ -1,5 +1,6 @@
 import { ScriptBase, LegacyCustomScript, Plugin, InstalledPluginConfig, ScriptDetails } from "../../../types";
 import { IPluginExecutor, PluginRegistrations, PluginExecutionResult } from "./script-executor.interface";
+import { ScriptApiContext } from "../script-api";
 /**
  * Executor for new-spec Plugins (manifest.type === "plugin")
  */
@@ -7,7 +8,7 @@ export declare class PluginExecutor extends IPluginExecutor {
     constructor();
     canHandle(script: ScriptBase | LegacyCustomScript): script is Plugin<import("../../../types").FirebotParams>;
     getScriptDetails(script: ScriptBase | LegacyCustomScript): ScriptDetails | null;
-    executePlugin(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig, isInstalling?: boolean): Promise<PluginExecutionResult>;
+    executePlugin(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig, isInstalling?: boolean, ctx?: ScriptApiContext): Promise<PluginExecutionResult>;
     unloadPlugin(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig, registrations?: PluginRegistrations, isUninstalling?: boolean): Promise<void>;
     updateParameters(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig): Promise<void>;
     private registerAll;

package/backend/scripts/executors/script-executor.interface.d.ts

@@ -1,4 +1,5 @@
 import { InstalledPluginConfig, LegacyCustomScript, ScriptBase, ScriptContext, Awaitable, ScriptDetails } 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>;
@@ -25,7 +26,7 @@ export type PluginExecutionResult = {
     error: string;
 };
 export declare abstract class IPluginExecutor extends IBaseScriptExecutor {
-    abstract executePlugin(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig, isInstalling?: boolean): Awaitable<PluginExecutionResult>;
+    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>;
 }

package/backend/webhooks/webhook-config-manager.d.ts

@@ -1,4 +1,5 @@
-import type { WebhookConfig } from "../../types";
+import type { ScriptWebhook, WebhookConfig } from "../../types";
+import type { ScriptWebhookEventHandler } from "../../types/script-api";
 import JsonDbManager from "../database/json-db-manager";
 type ExtraEvents = {
     "webhook-received": (data: {
@@ -9,8 +10,18 @@ type ExtraEvents = {
     }) => void;
 };
 declare class WebhookConfigManager extends JsonDbManager<WebhookConfig, ExtraEvents> {
+    private _registeredPlugins;
     constructor();
     getWebhookUrlById(webhookId: string): string;
+    private toPublic;
+    findPluginWebhookByName(pluginId: string, webhookName: string): WebhookConfig;
+    getPluginWebhook(pluginId: string, webhookName: string): ScriptWebhook;
+    getAllPluginWebhooks(pluginId: string): ScriptWebhook[];
+    savePluginWebhook(pluginId: string, webhookName: string): ScriptWebhook;
+    deletePluginWebhook(pluginId: string, webhookName: string): boolean;
+    getPluginWebhookUrl(pluginId: string, webhookName: string): string;
+    registerPluginHandler(pluginId: string, handler: ScriptWebhookEventHandler): boolean;
+    unregisterPluginHandler(pluginId: string): boolean;
 }
 declare const webhookConfigManager: WebhookConfigManager;
 export = webhookConfigManager;

package/package.json

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

package/types/plugins.d.ts

@@ -12,6 +12,7 @@ import type { UIExtension } from "./ui-extensions";
 import type { OverlayWidgetType } from "./overlay-widgets";
 import type { PluginHttpRouteDefinition } from "./http-server";
 import type { CustomWebSocketHandler } from "./websocket";
+import type { PluginWebhooks } from "./webhooks";
 type NoResult = Awaitable<void>;
 type GenericParameters = Record<string, unknown>;
 export type InstalledPluginConfig<Params extends GenericParameters = GenericParameters> = {
@@ -37,11 +38,35 @@ interface ManifestFirebotVersion {
     minor?: number;
     patch?: number;
 }
+type FontAwesomeIcon = {
+    type: "font-awesome";
+    /**
+     * A FontAwesome icon name shown in the UI (eg. "fa-cogs").
+     */
+    name: `fa-${string}`;
+    /**
+     * A css color value (eg. "#FF0000") used for the icon.
+     */
+    color?: string;
+};
+type CustomIcon = {
+    type: "custom";
+    url: string;
+    /**
+     * A css color value (eg. "#FF0000") used for the background of the icon.
+     */
+    backgroundColor?: string;
+};
+export type PluginIcon = FontAwesomeIcon | CustomIcon;
 export interface Manifest {
     name: string;
     version: string;
     author: string;
     description: string | ManifestDescription;
+    /**
+     * An array of strings that describe or categorize your plugin
+     */
+    tags?: string[];
     /**
      * A link to the plugin's source code repository
      */
@@ -59,13 +84,9 @@ export interface Manifest {
     minimumFirebotVersion?: ManifestFirebotVersion;
     maximumFirebotVersion?: ManifestFirebotVersion;
     /**
-     * A FontAwesome icon name shown in the UI (eg. "fa-cogs").
-     */
-    icon?: `fa-${string}`;
-    /**
-     * A hex color code (eg. "#FF0000") used for the icon.
+     * The icon to be displayed for the plugin.
      */
-    color?: string;
+    icon?: PluginIcon;
     /**
      * If true, the plugin will be initialized before parameters are shown to the user,
      * allowing the plugin to provide custom parameter types that can be used in its own parametersSchema.
@@ -107,6 +128,7 @@ export interface Plugin<Params extends FirebotParams = FirebotParams> extends Sc
         overlayWidgets?: DynamicArray<OverlayWidgetType<any, any>>;
         httpRoutes?: DynamicObject<PluginHttpRouteDefinition>;
         websocketListener?: DynamicObject<CustomWebSocketHandler>;
+        webhooks?: DynamicObject<PluginWebhooks>;
     };
     /** Called when the plugin is loaded */
     onLoad?: (context: ScriptContext<Params>, isInstalling?: boolean) => NoResult;

package/types/script-api.d.ts

@@ -24,20 +24,12 @@ export interface ScriptWebhookEvent {
 }
 export type ScriptWebhookEventHandler = (event: ScriptWebhookEvent) => void;
 export interface ScriptWebhooksApi {
-    /** Create a new webhook (or return the existing one with the same name). */
-    save(name: string): ScriptWebhook | null;
     /** Look up a webhook by name. */
     get(name: string): ScriptWebhook | null;
-    /** Delete a webhook by name. Returns true if one was removed. */
-    delete(name: string): boolean;
     /** All webhooks owned by this script. */
     list(): ScriptWebhook[];
     /** Public URL for a webhook by name, or null if not found. */
     getUrl(name: string): string | null;
-    /**
-     * Subscribe to webhook events for this script. Returns an `unsubscribe` func
-     */
-    onReceived(handler: ScriptWebhookEventHandler): () => void;
 }
 /**
  * Simple per-script storage scoped to the script's data directory.

package/types/webhooks.d.ts

@@ -1,5 +1,10 @@
+import type { ScriptWebhookEventHandler } from "./script-api";
 export type WebhookConfig = {
     id: string;
     name: string;
     scriptId?: string;
 };
+export type PluginWebhooks = {
+    webhookNames: string[];
+    handler: ScriptWebhookEventHandler;
+};