@crowbartools/firebot-types 5.67.0-alpha14 → 5.67.0-alpha16

package/backend/scripts/script-manager.d.ts

@@ -32,7 +32,7 @@ declare class ScriptManager {
      * Handle a config change. Starts/stops as needed, and on a still-enabled plugin
      * either re-loads (if file may have changed) or invokes onParameterUpdate.
      */
-    reloadPluginConfig(pluginConfig: InstalledPluginConfig): Promise<void>;
+    reloadPluginConfig(pluginConfig: InstalledPluginConfig, isNewInstall?: boolean): Promise<void>;
     setPluginEnabled(pluginId: string, enabled: boolean): Promise<void>;
     getInstalledPlugins(): Promise<InstalledPlugin[]>;
     /**

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

@@ -1,5 +1,4 @@
-import type { ScriptWebhook, WebhookConfig } from "../../types";
-import type { ScriptWebhookEventHandler } from "../../types/script-api";
+import type { PluginWebhook, PluginWebhookEventHandler, WebhookConfig } from "../../types";
 import JsonDbManager from "../database/json-db-manager";
 type ExtraEvents = {
     "webhook-received": (data: {
@@ -15,12 +14,12 @@ declare class WebhookConfigManager extends JsonDbManager<WebhookConfig, ExtraEve
     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;
+    getPluginWebhook(pluginId: string, webhookName: string): PluginWebhook;
+    getAllPluginWebhooks(pluginId: string): PluginWebhook[];
+    savePluginWebhook(pluginId: string, webhookName: string): PluginWebhook;
     deletePluginWebhook(pluginId: string, webhookName: string): boolean;
     getPluginWebhookUrl(pluginId: string, webhookName: string): string;
-    registerPluginHandler(pluginId: string, handler: ScriptWebhookEventHandler): boolean;
+    registerPluginHandler(pluginId: string, handler: PluginWebhookEventHandler): boolean;
     unregisterPluginHandler(pluginId: string): boolean;
 }
 declare const webhookConfigManager: WebhookConfigManager;

package/package.json

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

package/types/plugins.d.ts

@@ -38,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
      */
@@ -60,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.
@@ -183,4 +203,4 @@ export type LegacyCustomScript = {
     stop?: () => Awaitable<void>;
 };
 export type FirebotScriptApi = import("./script-api").FirebotScriptApi;
-export type { ScriptLoggerApi, ScriptWebhooksApi, ScriptWebhook, ScriptWebhookEvent } from "./script-api";
+export type { ScriptLoggerApi, ScriptWebhooksApi } from "./script-api";

package/types/script-api.d.ts

@@ -5,6 +5,7 @@ import type { Notification } from "./notifications";
 import type { FirebotAccount } from "./accounts";
 import type { FirebotSettingsTypes } from "./settings";
 import type { InstalledPlugin } from "./plugins";
+import type { PluginWebhook } from "./webhooks";
 export type ScriptLogMethod = (message: string, ...meta: unknown[]) => void;
 export interface ScriptLoggerApi {
     debug: ScriptLogMethod;
@@ -12,22 +13,11 @@ export interface ScriptLoggerApi {
     warn: ScriptLogMethod;
     error: ScriptLogMethod;
 }
-export interface ScriptWebhook {
-    id: string;
-    name: string;
-}
-export interface ScriptWebhookEvent {
-    webhook: ScriptWebhook;
-    payload: unknown;
-    rawPayload?: string;
-    headers: Record<string, string>;
-}
-export type ScriptWebhookEventHandler = (event: ScriptWebhookEvent) => void;
 export interface ScriptWebhooksApi {
     /** Look up a webhook by name. */
-    get(name: string): ScriptWebhook | null;
+    get(name: string): PluginWebhook | null;
     /** All webhooks owned by this script. */
-    list(): ScriptWebhook[];
+    list(): PluginWebhook[];
     /** Public URL for a webhook by name, or null if not found. */
     getUrl(name: string): string | null;
 }

package/types/webhooks.d.ts

@@ -1,10 +1,20 @@
-import type { ScriptWebhookEventHandler } from "./script-api";
 export type WebhookConfig = {
     id: string;
     name: string;
     scriptId?: string;
 };
+export interface PluginWebhook {
+    id: string;
+    name: string;
+}
+export interface PluginWebhookEvent {
+    webhook: PluginWebhook;
+    payload: unknown;
+    rawPayload?: string;
+    headers: Record<string, string>;
+}
+export type PluginWebhookEventHandler = (event: PluginWebhookEvent) => void;
 export type PluginWebhooks = {
     webhookNames: string[];
-    handler: ScriptWebhookEventHandler;
+    handler: PluginWebhookEventHandler;
 };