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

package/types/plugins.d.ts

@@ -16,6 +16,26 @@ 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,26 +95,6 @@ export 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;
@@ -120,11 +124,6 @@ export interface Manifest {
      * 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> {
     manifest: Manifest;
@@ -213,7 +212,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/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 };