@crowbartools/firebot-types 5.67.0-alpha26 → 5.67.0-alpha28

package/types/plugins.d.ts

@@ -2,7 +2,7 @@ import type { EffectType, PluginAdditionalEffectEvents } from "./effects";
 import type { Trigger } from "./triggers";
 import type { Awaitable } from "./util-types";
 import type { PluginAdditionalVariableEvents, ReplaceVariable } from "./variables";
-import type { EventFilter, EventSource } from "./events";
+import type { EventFilter, EventSource, PluginAdditionalFilterEvents } from "./events";
 import type { SystemCommand } from "./commands";
 import type { RestrictionType } from "./restrictions";
 import type { FirebotParams, FirebotParameterArray } from "./parameters";
@@ -11,11 +11,31 @@ import type { Integration } from "./integrations";
 import type { FrontendListener, UIExtension } from "./ui-extensions";
 import type { OverlayWidgetType } from "./overlay-widgets";
 import type { PluginHttpRouteDefinition } from "./http-server";
-import type { CustomWebSocketHandler } from "./websocket";
+import type { PluginWebSocketHandler } from "./websocket";
 import type { PluginWebhooks } from "./webhooks";
 import { ConditionType } from "./conditions";
 type NoResult = Awaitable<void>;
 type GenericParameters = Record<string, unknown>;
+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 type ManagedPluginManifest = {
     name: string;
     author: string;
@@ -35,16 +55,20 @@ export type ManagedPluginManifest = {
     minimumFirebotVersion?: ManifestFirebotVersion;
     maximumFirebotVersion?: ManifestFirebotVersion;
 };
-export type ManagedPlugin = {
+export type ManagedPluginBase = {
     author: string;
     name: string;
     version: string;
 };
-export type ManagedPluginWithManifest = ManagedPlugin & {
+export type ManagedPlugin = ManagedPluginBase & {
     manifest: ManagedPluginManifest;
 };
+export type ManagedPluginExtended = ManagedPlugin & {
+    installed: boolean;
+    installedVersion?: string;
+};
 export type ManagedPluginUpdateRequest = {
-    plugins: Array<ManagedPlugin>;
+    plugins: Array<ManagedPluginBase>;
     firebotVersion: ManifestFirebotVersion;
 };
 export type InstalledPluginConfig<Params extends GenericParameters = GenericParameters> = {
@@ -52,7 +76,7 @@ export type InstalledPluginConfig<Params extends GenericParameters = GenericPara
     fileName: string;
     enabled?: boolean;
     legacyImport?: boolean;
-    managedPluginDetails?: ManagedPlugin;
+    managedPluginDetails?: ManagedPluginBase;
     parameters: Params;
 };
 export type PluginContext<Params extends FirebotParams = FirebotParams> = {
@@ -71,30 +95,22 @@ export interface ManifestFirebotVersion {
     minor?: number;
     patch?: number;
 }
-type FontAwesomeIcon = {
-    type: "font-awesome";
+export interface Manifest {
     /**
-     * A FontAwesome icon name shown in the UI (eg. "fa-cogs").
+     * Name of the plugin
      */
-    name: `fa-${string}`;
+    name: string;
     /**
-     * A css color value (eg. "#FF0000") used for the icon.
+     * Version of the plugin
      */
-    color?: string;
-};
-type CustomIcon = {
-    type: "custom";
-    url: string;
+    version: string;
     /**
-     * A css color value (eg. "#FF0000") used for the background of the icon.
+     * Author of the plugin
      */
-    backgroundColor?: string;
-};
-export type PluginIcon = FontAwesomeIcon | CustomIcon;
-export interface Manifest {
-    name: string;
-    version: string;
     author: string;
+    /**
+     * Description of the plugin
+     */
     description: string | ManifestDescription;
     /**
      * An array of strings that describe or categorize your plugin
@@ -105,8 +121,8 @@ export interface Manifest {
      */
     repo?: string;
     /**
-     * A link to the plugin's website
-     * If the repo is on GitHub and the website is not specified, it will default to the GitHub repo URL.
+     * A link to the plugin's website. If the repo is on GitHub and the website
+     * is not specified, it will default to the GitHub repo URL.
      */
     website?: string;
     /**
@@ -114,20 +130,27 @@ export interface Manifest {
      * If the repo is on GitHub and support is not specified, it will default to the GitHub issues URL.
      */
     support?: string;
+    /**
+     * The lowest Firebot version this plugin is compatible with
+     */
     minimumFirebotVersion?: ManifestFirebotVersion;
+    /**
+     * The highest Firebot version this plugin is compatible with
+     */
     maximumFirebotVersion?: ManifestFirebotVersion;
     /**
      * The icon to be displayed for the plugin.
      */
     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.
-     */
-    initBeforeShowingParams?: boolean;
 }
 export interface PluginBase<Params extends FirebotParams = FirebotParams> {
+    /**
+     * Basic information about the plugin
+     */
     manifest: Manifest;
+    /**
+     * Defines the user-specified parameters for this plugin
+     */
     parametersSchema?: FirebotParameterArray<Params>;
 }
 export interface Plugin<Params extends FirebotParams = FirebotParams> extends PluginBase<Params> {
@@ -152,10 +175,11 @@ export interface Plugin<Params extends FirebotParams = FirebotParams> extends Pl
         uiExtensions?: DynamicArray<UIExtension>;
         overlayWidgets?: DynamicArray<OverlayWidgetType<any, any>>;
         httpRoutes?: DynamicObject<PluginHttpRouteDefinition>;
-        websocketListener?: DynamicObject<CustomWebSocketHandler>;
+        websocketListener?: DynamicObject<PluginWebSocketHandler>;
         webhooks?: DynamicObject<PluginWebhooks>;
         additionalEffectEvents?: DynamicArray<PluginAdditionalEffectEvents>;
         additionalVariableEvents?: DynamicArray<PluginAdditionalVariableEvents>;
+        additionalFilterEvents?: DynamicArray<PluginAdditionalFilterEvents>;
     };
     /** Called when the plugin is loaded */
     onLoad?: (context: PluginContext<Params>, isInstalling?: boolean) => NoResult;
@@ -213,7 +237,6 @@ type LegacyCustomScriptManifest = {
     author: string;
     website?: string;
     startupOnly?: boolean;
-    initBeforeShowingParams?: boolean;
     firebotVersion?: "5";
 };
 export type LegacyScriptData = {

package/types/ui/modal-factory.d.ts

@@ -19,4 +19,13 @@ export type ModalFactory = {
         trigger?: TriggerType;
         triggerMeta?: unknown;
     }, callback: (result: T) => void, dismissCallback?: () => void) => void;
+    showConfirmationModal: (options: {
+        title: string;
+        question: string;
+        tip?: string;
+        cancelLabel?: string;
+        cancelBtnType?: string;
+        confirmLabel?: string;
+        confirmBtnType?: string;
+    }) => Promise<boolean>;
 };

package/types/ui-extensions.d.ts

@@ -13,7 +13,9 @@ export type AngularJsPage = BasePage & {
 };
 export type IframePage = BasePage & {
     type: 'iframe';
+    url: string;
 };
+export type UiExtensionPage = AngularJsPage | IframePage;
 export type AngularJsFactory = {
     name: string;
     function: Function;
@@ -80,7 +82,7 @@ export type UIExtension = {
     /**
      * Adds new sidebar entries under an "Extensions" category
      */
-    pages?: AngularJsPage[];
+    pages?: UiExtensionPage[];
     /**
      * Add your own AngularJS services, components, directives, filters
      */

package/types/viewers.d.ts

@@ -26,3 +26,12 @@ export interface BasicViewer {
     profilePicUrl?: string;
 }
 export type NewFirebotViewer = BasicViewer & Partial<Omit<FirebotViewer, "_id" | "username" | "displayName" | "twitchRoles" | "profilePicUrl">>;
+export type FrontendViewer = {
+    id: string;
+    username: string;
+    displayName: string;
+    roles: string[];
+    profilePicUrl: string;
+    active: boolean;
+    disableViewerList?: boolean;
+};

package/types/websocket.d.ts

@@ -23,10 +23,21 @@ export interface InvokePluginMessage extends InvokeMessage {
     name: "plugin";
     pluginName: string;
 }
-export interface CustomWebSocketHandler {
+export interface PluginWebSocketHandler {
     pluginName: string;
     handler: (data: unknown) => Awaitable<void>;
 }
+export interface InvokeOverlayRequestMessage extends InvokeMessage {
+    name: "overlay-request";
+    data: {
+        name: string;
+        data?: Record<string, unknown>;
+    };
+}
+export interface OverlayRequestWebSocketHandler<TData extends Record<string, unknown> = Record<string, unknown>, TResponse = unknown> {
+    name: string;
+    handler: (data: TData) => Awaitable<TResponse>;
+}
 export type OverlayConnectedData = {
     instanceName: string;
 };

package/backend/chat/frontend-chat-helpers.d.ts

@@ -1,14 +0,0 @@
-import type { FirebotChatMessage } from "../../types";
-declare class FirebotFrontendChatHelpers {
-    private logger;
-    private _pendingMessageCache;
-    private sendChatMessageToChatWidget;
-    sendChatMessageToFrontend(chatMessage: FirebotChatMessage): void;
-    private deleteMessageFromChatWidget;
-    deleteMessageFromFrontend(messageId: string, animate?: boolean): void;
-    deleteUserMessagesFromFrontend(username: string): void;
-    clearChatFeed(moderatorName: string): void;
-    updateMessageAutomodStatus(messageId: string, newStatus: FirebotChatMessage["autoModStatus"], resolverName: string, resolverId: string, flaggedPhrases: string[]): void;
-}
-declare const frontendChatHelpers: FirebotFrontendChatHelpers;
-export { frontendChatHelpers as FirebotFrontendChatHelpers };