@crowbartools/firebot-types 5.67.0-alpha2 → 5.67.0-alpha21

package/types/icons.d.ts

@@ -3,4 +3,4 @@ export type FontAwesomeIcon = {
     className: string;
     style: string;
     searchTerms: string[];
-};
+};

package/types/import.d.ts

@@ -1,69 +1,42 @@
 import type { Quote } from "./quotes";
 import type { FileFilter, Awaitable } from "./util-types";
-
 export interface LoadRequest {
     appId: string;
     filepath: string;
 }
-
 export interface LoadResult<T = unknown[]> {
     success: boolean;
     data?: T;
     error?: string;
 }
-
 export type ParsedQuotes = {
     quotes: Quote[];
 };
-
 export type ParsedViewers<V = unknown> = {
     viewers: V[];
     ranks: string[];
 };
-
 export interface ImportRequest<Data = unknown, Settings = unknown> {
     appId: string;
     data: Data;
     settings: Settings;
 }
-
 export interface ImportResult {
     success: boolean;
     error?: string;
 }
-
 type CustomImporterSettings = {
     quotes?: unknown;
     viewers?: unknown;
 };
-
-export type ThirdPartyImporter<
-    Settings extends CustomImporterSettings = CustomImporterSettings,
-    ViewerType = unknown
-> = {
+export type ThirdPartyImporter<Settings extends CustomImporterSettings = CustomImporterSettings, ViewerType = unknown> = {
     id: string;
     appName: string;
     defaultSettings?: Settings;
     filetypes: FileFilter[];
-
-    loadQuotes?: (
-        filename: string,
-        settings?: Settings["quotes"]
-    ) => Awaitable<LoadResult<ParsedQuotes>>;
-
-    importQuotes?: (
-        quotes: Quote[],
-        settings: Settings["quotes"]
-    ) => Awaitable<ImportResult>;
-
-    loadViewers?: (
-        filename: string,
-        settings?: Settings["viewers"]
-    ) => Awaitable<LoadResult<ParsedViewers>>;
-
-    importViewers?: (
-        viewers: ViewerType[],
-        settings: Settings["viewers"],
-        abortSignal: AbortSignal
-    ) => Awaitable<ImportResult>;
-};
+    loadQuotes?: (filename: string, settings?: Settings["quotes"]) => Awaitable<LoadResult<ParsedQuotes>>;
+    importQuotes?: (quotes: Quote[], settings: Settings["quotes"]) => Awaitable<ImportResult>;
+    loadViewers?: (filename: string, settings?: Settings["viewers"]) => Awaitable<LoadResult<ParsedViewers>>;
+    importViewers?: (viewers: ViewerType[], settings: Settings["viewers"], abortSignal: AbortSignal) => Awaitable<ImportResult>;
+};
+export {};

package/types/index.d.ts

@@ -3,6 +3,7 @@ export * from "./auth";
 export * from "./channel-rewards";
 export * from "./chat";
 export * from "./commands";
+export * from "./control-deck";
 export * from "./counters";
 export * from "./currency";
 export * from "./discord";
@@ -12,13 +13,17 @@ export * from "./expressionish";
 export * from "./games";
 export * from "./goals";
 export * from "./hotkeys";
+export * from "./http-server";
 export * from "./icons";
 export * from "./import";
 export * from "./integrations";
 export * from "./moderation";
 export * from "./modules";
+export * from "./notifications";
 export * from "./overlay-widgets";
 export * from "./parameters";
+export * from "./plugins";
+export * from "./power-ups";
 export * from "./pronouns";
 export * from "./quick-actions";
 export * from "./quotes";
@@ -31,10 +36,10 @@ export * from "./sort-tags";
 export * from "./timers";
 export * from "./triggers";
 export * from "./ui";
+export * from "./ui-extensions";
 export * from "./util-types";
 export * from "./variable-macros";
 export * from "./variables";
 export * from "./viewers";
 export * from "./webhooks";
 export * from "./websocket";
-export * from "./plugins";

package/types/integrations.d.ts

@@ -1,93 +1,69 @@
-import type {
-    FirebotParameterCategories,
-    FirebotParams
-} from "./parameters";
+import type { FirebotParameterCategories } from "./parameters";
 import type { Awaitable, ObjectOfUnknowns } from "./util-types";
-
-export type Integration<Params extends FirebotParams = FirebotParams> = {
+export type IntegrationParams = Record<string, Record<string, unknown>>;
+export type Integration<Params extends IntegrationParams = IntegrationParams> = {
     definition: IntegrationDefinition<Params>;
     integration: IntegrationController<Params>;
 };
-
-export type IntegrationDefinition<
-    Params extends FirebotParams = FirebotParams
-> = {
+export type IntegrationDefinition<Params extends IntegrationParams = IntegrationParams> = {
     id: string;
     name: string;
     description: string;
     connectionToggle?: boolean;
     configurable?: boolean;
     settingCategories: FirebotParameterCategories<Params>;
-} & (
-    | {
-        linkType: "id";
-        idDetails: {
-            steps: string;
-        };
-    }
-    | {
-        linkType: "auth";
-        authProviderDetails: {
+} & ({
+    linkType: "id";
+    idDetails: {
+        steps: string;
+    };
+} | {
+    linkType: "auth";
+    authProviderDetails: {
+        id: string;
+        name: string;
+        redirectUriHost?: string;
+        client: {
             id: string;
-            name: string;
-            redirectUriHost?: string;
-            client: {
-                id: string;
-                secret: string;
-            };
-            auth: {
-                tokenHost: string;
-                tokenPath: string;
-                authorizePath: string;
-            };
-            autoRefreshToken?: boolean;
-            scopes: string;
+            secret: string;
+        };
+        auth: {
+            tokenHost: string;
+            tokenPath: string;
+            authorizePath: string;
         };
-    }
-    | { linkType: "other" | "none" }
-);
-
+        autoRefreshToken?: boolean;
+        scopes: string;
+    };
+} | {
+    linkType: "other" | "none";
+});
 export interface IntegrationEvents {
     connected: (id: string) => void;
     disconnected: (id: string) => void;
     "settings-update": (id: string, settings: Record<string, any>) => void;
 }
-
-type LinkData =
-    | {
-        accountId: string;
-    }
-    | {
-        auth: Record<string, unknown>;
-    }
-    | null;
-
-export type IntegrationData<Params extends FirebotParams = FirebotParams> = {
+type LinkData = {
+    accountId: string;
+} | {
+    auth: Record<string, unknown>;
+} | null;
+export type IntegrationData<Params extends IntegrationParams = IntegrationParams> = {
     settings: any;
     userSettings?: Params;
     oauth?: any;
     accountId?: string;
 };
-
-export interface IntegrationController<
-    Params extends FirebotParams = FirebotParams
-> {
+export interface IntegrationController<Params extends IntegrationParams = IntegrationParams> {
     connected: boolean;
-    init(
-        linked: boolean,
-        integrationData: IntegrationData<Params>
-    ): Awaitable<void>;
+    init(linked: boolean, integrationData: IntegrationData<Params>): Awaitable<void>;
     link?(linkData: LinkData): Awaitable<void>;
-    connect?(
-        integrationData: IntegrationData<Params>
-    ): Awaitable<void>;
+    connect?(integrationData: IntegrationData<Params>): Awaitable<void>;
     disconnect?(): Awaitable<void>;
-    onUserSettingsUpdate?(
-        integrationData: IntegrationData<Params>
-    ): Awaitable<void>;
+    onUserSettingsUpdate?(integrationData: IntegrationData<Params>): Awaitable<void>;
 }
-
-type IntegrationWithUnknowns = {
+export type IntegrationWithUnknowns = {
     definition: IntegrationDefinition & ObjectOfUnknowns;
     integration: IntegrationController & ObjectOfUnknowns;
-};
+};
+export {};

package/types/moderation.d.ts

@@ -2,38 +2,31 @@ export type ModerationTerm = {
     text: string;
     createdAt: number;
 };
-
 export type ModerationUser = {
     id: string;
     username: string;
     displayName: string;
 };
-
 export type AllowedUser = {
     id: string;
     username: string;
     displayName: string;
     createdAt: number;
 };
-
 export type BannedWords = {
     words: ModerationTerm[];
 };
-
 export type BannedRegularExpressions = {
     regularExpressions: ModerationTerm[];
 };
-
 export type AllowList = {
     urls: ModerationTerm[];
     users: AllowedUser[];
 };
-
 export type ModerationImportRequest = {
     filePath: string;
     delimiter: "newline" | "comma" | "space";
 };
-
 export type ChatModerationSettings = {
     bannedWordList: {
         enabled: boolean;
@@ -56,4 +49,4 @@ export type ChatModerationSettings = {
         outputMessage?: string;
     };
     exemptRoles: string[];
-};
+};

package/types/modules/event-manager.d.ts

@@ -1,18 +1,15 @@
 import type { EventSource } from "../events";
-
 export type EventManagerModule = {
     /**
      * Registers an event source in Firebot.
      * @param eventSource The {@linkcode EventSource} you want to register.
      */
     registerEventSource: (eventSource: EventSource) => void;
-
     /**
      * Unregisters an event source from Firebot.
      * @param eventSourceId The ID of the event source to unregister.
      */
     unregisterEventSource: (eventSourceId: string) => void;
-
     /**
      * Triggers an event in Firebot.
      * @param eventSourceId The ID of the event source.
@@ -20,10 +17,5 @@ export type EventManagerModule = {
      * @param meta Any metadata you want to include with the event.
      * @param isManual `true` if the event is being triggered manually, `false` otherwise.
      */
-    triggerEvent: (
-        eventSourceId: string,
-        eventId: string,
-        meta: Record<string, unknown>,
-        isManual?: boolean
-    ) => void;
-};
+    triggerEvent: (eventSourceId: string, eventId: string, meta: Record<string, unknown>, isManual?: boolean) => void;
+};

package/types/modules/frontend-communicator.d.ts

@@ -4,11 +4,7 @@ export interface FrontendCommunicatorModule {
      * @param eventName The name of the event to send.
      * @param data Data to provide to the event handler.
      */
-    send<ExpectedArg = unknown>(
-        eventName: string,
-        data?: ExpectedArg
-    ): void;
-
+    send<ExpectedArg = unknown>(eventName: string, data?: ExpectedArg): void;
     /** Handle a synchronous event triggered by the frontend.
      * @template ExpectedArgs The type of data provided with the event.
      * @template ReturnPayload The type of data returned from the event handler.
@@ -16,11 +12,7 @@ export interface FrontendCommunicatorModule {
      * @param callback A function to handle the event.
      * @returns Unique ID of the registered event handler.
      */
-    on<ExpectedArgs extends Array<unknown> = [], ReturnPayload = void>(
-        eventName: string,
-        callback: (...args: ExpectedArgs) => ReturnPayload
-    ): void;
-
+    on<ExpectedArgs extends Array<unknown> = [], ReturnPayload = void>(eventName: string, callback: (...args: ExpectedArgs) => ReturnPayload): void;
     /** Handle an asynchronous event triggered by the frontend.
      * @template ExpectedArgs The type of data provided with the event.
      * @template ReturnPayload The type of data returned from the event handler.
@@ -28,26 +20,18 @@ export interface FrontendCommunicatorModule {
      * @param callback A function to asynchronously handle the event.
      * @returns Unique ID of the registered event handler.
      */
-    onAsync<ExpectedArgs extends Array<unknown> = [], ReturnPayload = void>(
-        eventName: string,
-        callback: (...args: ExpectedArgs) => Promise<ReturnPayload>
-    ): void;
-
+    onAsync<ExpectedArgs extends Array<unknown> = [], ReturnPayload = void>(eventName: string, callback: (...args: ExpectedArgs) => Promise<ReturnPayload>): void;
     /** Send an asynchronous event to the frontend that is capable of returning a result.
      * @template ReturnPayload The type of data returned from the event handler.
      * @template ExpectedArg The type of data provided with the event.
      * @param eventName The name of the event to send.
      * @param data The data to provide with the event.
      */
-    fireEventAsync<ReturnPayload = void, ExpectedArg = unknown>(
-        eventName: string,
-        data?: ExpectedArg
-    ): Promise<ReturnPayload>;
-
+    fireEventAsync<ReturnPayload = void, ExpectedArg = unknown>(eventName: string, data?: ExpectedArg): Promise<ReturnPayload>;
     /**
      * Unregisters a previously registered frontend event handler.
      * @param eventName The name of the event.
      * @param id The unique ID of the event handler to unregister. This ID is returned when you create an event handler using {@linkcode FrontendCommunicator.on | on} or {@linkcode FrontendCommunicator.onAsync | onAsync}.
      */
     off(eventName: string, id: string): void;
-}
+}

package/types/modules/index.d.ts

@@ -1,2 +1,2 @@
 export * from "./event-manager";
-export * from "./frontend-communicator";
+export * from "./frontend-communicator";

package/types/notifications.d.ts

@@ -0,0 +1,28 @@
+export type NotificationSource = "external" | "internal" | "plugin";
+export type NotificationType = "info" | "tip" | "update" | "alert";
+export type ExternalNotification = {
+    id: string;
+    title: string;
+    message: string;
+    type: NotificationType;
+};
+export type NotificationBase = {
+    title: string;
+    message: string;
+    type: NotificationType;
+    source?: NotificationSource;
+    pluginName?: string;
+    externalId?: string;
+    metadata?: Record<string, unknown>;
+};
+export type Notification = NotificationBase & {
+    id: string;
+    timestamp: Date;
+    saved: boolean;
+    read: boolean;
+};
+export interface NotificationCache {
+    dbVersion?: string;
+    notifications: Notification[];
+    knownExternalIds: string[];
+}

package/types/overlay-widgets.d.ts

@@ -1,13 +1,11 @@
 import type { FirebotParameterArray, FontOptions } from "./parameters";
 import type { Awaitable } from "./util-types";
-
 export type Position = {
     x: number;
     y: number;
     width: number;
     height: number;
 };
-
 export type Animation = {
     /**
      * CSS class name for the animation (e.g., from Animate.css)
@@ -18,13 +16,11 @@ export type Animation = {
      */
     duration?: number;
 };
-
 type WidgetEvent<Settings, State> = OverlayWidgetConfig<Settings, State> & {
     previewMode: boolean;
     previousState?: State;
     persisted?: boolean;
 };
-
 export type WidgetEventResult<State> = {
     newState?: State | null;
     /**
@@ -33,26 +29,16 @@ export type WidgetEventResult<State> = {
      */
     persistState?: boolean;
 };
-
 export type WidgetEventHandler<Settings, State, Return = WidgetEventResult<State>> = (event: WidgetEvent<Settings, State>) => Awaitable<Return | undefined>;
-
-export type WidgetUIAction<
-    Settings extends Record<string, unknown> = Record<string, unknown>,
-    State = Record<string, unknown>
-> = {
+export type WidgetUIAction<Settings extends Record<string, unknown> = Record<string, unknown>, State = Record<string, unknown>> = {
     id: string;
     label: string;
     icon: string;
-
     click: (config: OverlayWidgetConfig<Settings, State>) => Awaitable<{
         newState?: State | null;
     } | void>;
 };
-
-export type OverlayWidgetType<
-    Settings extends Record<string, unknown> = Record<string, unknown>,
-    State = Record<string, unknown>
-> = {
+export type OverlayWidgetType<Settings extends Record<string, unknown> = Record<string, unknown>, State = Record<string, unknown>> = {
     id: string;
     name: string;
     description: string;
@@ -88,12 +74,10 @@ export type OverlayWidgetType<
      * Settings allow the user to customize the widget instance (e.g., font to use, colors, etc.)
      */
     settingsSchema?: FirebotParameterArray<Settings>;
-
     /**
      * Array of setting keys that cannot be edited in the Update Overlay Widget Settings effect.
      */
     nonEditableSettings?: (keyof Settings)[];
-
     /**
      * Initial state for the widget instance (e.g., current count for a counter widget)
      */
@@ -110,7 +94,6 @@ export type OverlayWidgetType<
      * State that is used when the widget is shown in live preview mode.
      */
     livePreviewState?: State;
-
     /**
      * Array of setting keys that reference local resource paths.
      * These properties will be automatically converted to resource tokens when sent to the overlay,
@@ -121,7 +104,6 @@ export type OverlayWidgetType<
      * This is shown in the overlay widget list to give the user a quick overview of the widget's state.
      * If null or undefined, no state display is shown.
      */
-
     stateDisplay?: (config: OverlayWidgetConfig<Settings, State>) => string | null;
     /**
      * Actions are buttons shown in the overlay widget list for each widget instance.
@@ -154,10 +136,12 @@ export type OverlayWidgetType<
     overlayExtension: {
         dependencies?: {
             css?: string[];
-            js?: Array<string | { module: boolean, url: string }>;
+            js?: Array<string | {
+                module: boolean;
+                url: string;
+            }>;
             globalStyles?: string;
         };
-
         eventHandler: (event: WidgetOverlayEvent, utils: IOverlayWidgetEventUtils) => void;
         /**
          * Called when the overlay is loaded. Can be async.
@@ -165,8 +149,7 @@ export type OverlayWidgetType<
         onInitialLoad?: (utils: IOverlayWidgetInitUtils) => Awaitable<void>;
     };
 };
-
-type OverlayWidgetConfig<Settings = Record<string, unknown>, State = Record<string, unknown>> = {
+export type OverlayWidgetConfig<Settings = Record<string, unknown>, State = Record<string, unknown>> = {
     id: string;
     name: string;
     type: string;
@@ -187,7 +170,6 @@ type OverlayWidgetConfig<Settings = Record<string, unknown>, State = Record<stri
     settings: Settings;
     state?: State;
 };
-
 export type WidgetOverlayEvent<Settings = Record<string, unknown>, State = Record<string, unknown>> = {
     name: "show" | "settings-update" | "state-update" | "message" | "remove";
     data: {
@@ -208,7 +190,6 @@ export type WidgetOverlayEvent<Settings = Record<string, unknown>, State = Recor
         messageData?: unknown;
     };
 };
-
 /**
  * Utility functions for managing overlay widgets. These functions can used within the overlayExtension.eventHandler
  */
@@ -222,19 +203,15 @@ export interface IOverlayWidgetEventUtils {
     handleOverlayEvent(generateWidgetHtml: (widgetConfig: WidgetOverlayEvent["data"]["widgetConfig"]) => string, updateOnMessage?: boolean): void;
     getWidgetPositionStyle(position?: Position): string;
     getWidgetContainerElement(): HTMLElement | null;
-    initializeWidget(
-        html: string
-    ): void;
-    updateWidgetContent(
-        newHtml: string,
-    ): void;
+    initializeWidget(html: string): void;
+    updateWidgetContent(newHtml: string): void;
     updateWidgetPosition(): void;
     removeWidget(): void;
     stylesToString(styles: Record<string, string | number | undefined>): string;
     getFontOptionsStyles(fontOptions?: FontOptions): Record<string, string | number | undefined>;
     sendMessageToFirebot(messageName: string, messageData?: unknown): void;
 }
-
 export interface IOverlayWidgetInitUtils {
     getWidgetContainerElements(): NodeListOf<HTMLElement>;
-}
+}
+export {};