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

package/backend/viewers/viewer-database.d.ts

@@ -0,0 +1,87 @@
+import { TypedEmitter } from "tiny-typed-emitter";
+import Datastore from "@seald-io/nedb";
+import type { BasicViewer, FirebotViewer, NewFirebotViewer, Rank, RankLadder } from "../../types";
+interface ViewerDbChangePacket {
+    userId: string;
+    field: string;
+    value: unknown;
+}
+interface ViewerPurgeOptions {
+    daysSinceActive: {
+        enabled: boolean;
+        value?: number;
+    };
+    viewTimeHours: {
+        enabled: boolean;
+        value?: number;
+    };
+    chatMessagesSent: {
+        enabled: boolean;
+        value?: number;
+    };
+    banned: {
+        enabled: boolean;
+    };
+}
+interface UserDetails {
+    firebotData: FirebotViewer;
+    twitchData: Record<string, unknown>;
+    streamerFollowsUser: boolean;
+    userFollowsStreamer: boolean;
+}
+declare class ViewerDatabase extends TypedEmitter<{
+    "viewer-database-loaded": () => void;
+    "updated-viewer-avatar": (event: {
+        userId: string;
+        url: string;
+    }) => void;
+}> {
+    private logger;
+    private _db;
+    private _dbCompactionInterval;
+    private cancelRankRecalculation;
+    private _activeViewers;
+    constructor();
+    /**
+     * Checks settings to see if viewer database is enabled.
+     * @returns `true` if the viewer database is enabled, or `false` otherwise
+     */
+    isViewerDBOn(): boolean;
+    connectViewerDatabase(): Promise<void>;
+    disconnectViewerDatabase(): void;
+    getViewerDb(): Datastore<FirebotViewer>;
+    createNewViewer(viewer: NewFirebotViewer): Promise<FirebotViewer>;
+    addNewViewerFromChat(viewerDetails: BasicViewer, isOnline?: boolean): Promise<FirebotViewer>;
+    getViewerById(id: string): Promise<FirebotViewer>;
+    getViewerByUsername(username: string): Promise<FirebotViewer>;
+    getAllViewers(): Promise<FirebotViewer[]>;
+    getAllUsernames(): Promise<string[]>;
+    getAllUsernamesWithIds(): Promise<{
+        id: string;
+        username: string;
+        displayName: string;
+    }[]>;
+    incrementDbField(userId: string, fieldName: string): Promise<void>;
+    private sanitizeDbInput;
+    updateDbCell(changePacket: ViewerDbChangePacket): Promise<void>;
+    updateViewer(viewer: FirebotViewer): Promise<boolean>;
+    updateViewerDataField(userId: string, field: string, value: unknown): Promise<void>;
+    removeViewer(userId: string): Promise<boolean>;
+    private getPurgeWherePredicate;
+    getPurgeViewers(options: ViewerPurgeOptions): Promise<FirebotViewer[]>;
+    purgeViewers(options: ViewerPurgeOptions): Promise<number>;
+    setViewerRank(viewer: FirebotViewer, ladderId: string, newRankId?: string): Promise<void>;
+    setViewerRankById(userId: string, ladderId: string, rankId: string): Promise<void>;
+    viewerHasRank(viewer: FirebotViewer, ladderId: string, rankId: string): boolean;
+    viewerHasRankById(userId: string, ladderId: string, rankId: string): Promise<boolean>;
+    getViewerRankForLadderByUserName(userName: string, ladderId: string): Promise<Rank | null>;
+    getViewerRankForLadder(userId: string, ladderId: string): Promise<Rank | null>;
+    calculateAutoRanks(userId: string, trackByType?: RankLadder["settings"]["trackBy"]): Promise<void>;
+    calculateAutoRanksByName(userName: string, trackByType?: RankLadder["settings"]["trackBy"]): Promise<void>;
+    recalculateRanksForAllViewers(rankLadderId: string): Promise<void>;
+    addActiveViewer(userId: string): void;
+    removeActiveViewer(userId: string): void;
+    getUserDetails(userId: string): Promise<Partial<UserDetails>>;
+}
+declare const viewerDatabase: ViewerDatabase;
+export = viewerDatabase;

package/backend/viewers/viewer-export-manager.d.ts

@@ -0,0 +1,17 @@
+import type { FirebotViewer } from "../../types";
+interface ViewerExportOptions {
+    viewers: boolean;
+    currencies: boolean;
+    ranks: boolean;
+}
+declare class ViewerExportManager {
+    private logger;
+    constructor();
+    setupListeners(): void;
+    exportViewersToFile(folderpath: string, exportOptions: ViewerExportOptions): Promise<boolean>;
+    createViewersFile(viewers: FirebotViewer[], folderpath: string): Promise<boolean>;
+    createCurrenciesFile(viewers: FirebotViewer[], folderpath: string): Promise<boolean>;
+    createRanksFile(viewers: FirebotViewer[], folderpath: string): Promise<boolean>;
+}
+declare const manager: ViewerExportManager;
+export { manager as ViewerExportManager };

package/backend/viewers/viewer-metadata-manager.d.ts

@@ -0,0 +1,18 @@
+import { TypedEmitter } from "tiny-typed-emitter";
+import type { FirebotViewer } from "../../types";
+type Events = {
+    "created-item": (item: object) => void;
+    "updated-item": (item: object) => void;
+    "deleted-item": (item: object) => void;
+};
+declare class ViewerMetadataManager extends TypedEmitter<Events> {
+    private logger;
+    constructor();
+    getViewerMetadata(username: string, key: string, propertyPath: string): Promise<unknown>;
+    getTopMetadataPosition(metadataKey: string, position?: number): Promise<FirebotViewer>;
+    getTopMetadata(metadataKey: string, count: number): Promise<FirebotViewer[]>;
+    updateViewerMetadata(username: string, key: string, value: string, propertyPath?: string): Promise<void>;
+    removeViewerMetadata(username: string, key: string): Promise<void>;
+}
+declare const viewerMetadataManager: ViewerMetadataManager;
+export = viewerMetadataManager;

package/backend/viewers/viewer-online-status-manager.d.ts

@@ -0,0 +1,26 @@
+import type { BasicViewer, FirebotViewer } from "../../types";
+declare class ViewerOnlineStatusManager {
+    private logger;
+    private _updateLastSeenIntervalId;
+    private _updateTimeIntervalId;
+    constructor();
+    getOnlineViewers(): Promise<FirebotViewer[]>;
+    getViewerOnlineMinutes(username: string): Promise<number>;
+    getTopViewTimeViewers(count: number): Promise<FirebotViewer[]>;
+    setChatViewerOnline(viewer: BasicViewer): Promise<void>;
+    setAllChatViewersOnline(): Promise<void>;
+    setChatViewerOffline(id: string): Promise<void>;
+    setAllViewersOffline(): Promise<void>;
+    /**
+     * Update viewers with last seen time. Allows us to recover chat hours from crash.
+     */
+    setLastSeenDateTime(): Promise<void>;
+    calcViewerOnlineMinutes(viewer: FirebotViewer): Promise<void>;
+    calcAllViewersOnlineMinutes(): Promise<void>;
+    /**
+     * Triggers a View Time Update event if view time hours has increased
+     */
+    viewerViewTimeUpdate(viewer: FirebotViewer, previousTotalMinutes: number, newTotalMinutes: number): void;
+}
+declare const viewerOnlineStatusManager: ViewerOnlineStatusManager;
+export = viewerOnlineStatusManager;

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

@@ -0,0 +1,26 @@
+import type { PluginWebhook, PluginWebhookEventHandler, WebhookConfig } from "../../types";
+import JsonDbManager from "../database/json-db-manager";
+type ExtraEvents = {
+    "webhook-received": (data: {
+        config: WebhookConfig;
+        payload: unknown;
+        rawPayload?: string;
+        headers: Record<string, string>;
+    }) => 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): 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: PluginWebhookEventHandler): boolean;
+    unregisterPluginHandler(pluginId: string): boolean;
+}
+declare const webhookConfigManager: WebhookConfigManager;
+export = webhookConfigManager;

package/index.d.ts

@@ -1,7 +1,7 @@
-// Auto-generated by grunt publish-types. Do not edit by hand.
-import { FirebotScriptApi } from "./types/script-api";
+// Auto-generated by grunt build-types. Do not edit by hand.
+import { FirebotPluginApi } from "./types/plugin-api";
 
 export * from "./types";
 
-declare const firebot: FirebotScriptApi;
+declare const firebot: FirebotPluginApi;
 export default firebot;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@crowbartools/firebot-types",
-  "version": "5.67.0-alpha2",
-  "description": "Type definitions and script API for Firebot custom scripts and plugins.",
+  "version": "5.67.0-alpha21",
+  "description": "Type definitions and plugin API for Firebot plugins.",
   "main": "index.js",
   "types": "index.d.ts",
   "exports": {
@@ -20,6 +20,9 @@
     "index.js",
     "index.d.ts",
     "types/**/*.d.ts",
+    "backend/**/*.d.ts",
+    "server/**/*.d.ts",
+    "shared/**/*.d.ts",
     "README.md",
     "LICENSE"
   ],
@@ -39,6 +42,10 @@
   "author": "The Streaming Community",
   "license": "GPL-3.0",
   "peerDependencies": {
-    "@types/node": "*"
+    "@types/express": "^5.0.5",
+    "@types/node": "^24.1.0"
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }

package/server/bonjour-manager.d.ts

@@ -0,0 +1,11 @@
+declare class BonjourManager {
+    private logger;
+    private bonjour;
+    private service;
+    constructor();
+    start(): void;
+    stop(): void;
+    getHost(): string;
+}
+declare const manager: BonjourManager;
+export { manager as BonjourManager };

package/server/http-server-manager.d.ts

@@ -0,0 +1,70 @@
+import { EventEmitter } from "events";
+import { Express, Request, Response, Router } from "express";
+import http from "http";
+import type { HttpMethod, CustomHttpRoute, PluginHttpRouteDefinition, CustomWebSocketHandler, Awaitable } from "../types";
+interface ServerInstance {
+    name: string;
+    port: number;
+    server: http.Server;
+}
+interface RegisteredPlugin {
+    name: string;
+    routes: Array<CustomHttpRoute>;
+}
+interface CustomRoute {
+    prefix: string;
+    route: string;
+    fullRoute: string;
+    method: HttpMethod;
+    callback: (req: Request, res: Response) => Awaitable<void>;
+}
+declare class HttpServerManager extends EventEmitter {
+    private logger;
+    serverInstances: ServerInstance[];
+    defaultServerInstance: Express;
+    defaultHttpServer: http.Server;
+    overlayServer: http.Server;
+    isDefaultServerStarted: boolean;
+    overlayHasClients: boolean;
+    registeredPlugins: Record<string, RegisteredPlugin>;
+    pluginRootRouter: Router;
+    pluginRouters: Record<string, Router>;
+    customRoutes: CustomRoute[];
+    customRouteRouter: Router;
+    constructor();
+    start(): void;
+    createDefaultServerInstance(): Express;
+    startDefaultHttpServer(): void;
+    sendToOverlay(eventName: string, meta?: Record<string, unknown>, overlayInstance?: string): void;
+    refreshAllOverlays(): void;
+    /**
+     * Refresh a specific overlay instance
+     * @param overlayInstance the instance to refresh, leave undefined to refresh default
+     */
+    refreshOverlayInstance(overlayInstance?: string): void;
+    sendToControlDecks(eventName: string, data?: unknown): void;
+    triggerCustomWebSocketEvent(eventType: string, payload: object): void;
+    createServerInstance(): Express;
+    startHttpServer(name: string, port: number, instance: Express): http.Server;
+    stopHttpServer(name: any): boolean;
+    private getFullPluginRoute;
+    registerPlugin(plugin: {
+        name: string;
+        definition: PluginHttpRouteDefinition;
+    }): boolean;
+    unregisterPlugin(prefix: string): boolean;
+    registerCustomRoute(prefix: string, route: string, method: string, callback: CustomRoute["callback"]): boolean;
+    unregisterCustomRoute(prefix: string, route: string, method: string): boolean;
+    buildCustomRouteParameters(prefix: string, route: string, method: string): {
+        normalizedPrefix: string;
+        normalizedRoute: string;
+        normalizedMethod: HttpMethod;
+        fullRoute: string;
+    };
+    private getCustomRoutePathFromRoot;
+    private removeCustomRoute;
+    registerCustomWebSocketListener(pluginName: string, handler: CustomWebSocketHandler["handler"]): boolean;
+    unregisterCustomWebSocketListener(pluginName: string): boolean;
+}
+declare const manager: HttpServerManager;
+export { manager as HttpServerManager };

package/server/websocket-client.d.ts

@@ -0,0 +1,5 @@
+import WebSocket from "ws";
+export declare class WebSocketClient extends WebSocket {
+    registrationTimeout: ReturnType<typeof setTimeout>;
+    type?: "overlay" | "events" | "control-deck";
+}

package/server/websocket-events-handler.d.ts

@@ -0,0 +1 @@
+export declare function createComponentEventListeners(): void;

package/server/websocket-server-manager.d.ts

@@ -0,0 +1,22 @@
+import { EventEmitter } from "events";
+import http from "http";
+import type { CustomWebSocketHandler, WidgetOverlayEvent } from "../types";
+declare class WebSocketServerManager extends EventEmitter {
+    private logger;
+    overlayHasClients: boolean;
+    private server;
+    private customHandlers;
+    constructor();
+    createServer(httpServer: http.Server): void;
+    sendToOverlay(eventName: string, meta?: Record<string, unknown>, overlayInstance?: string): void;
+    sendWidgetEventToOverlay(event: WidgetOverlayEvent): void;
+    refreshAllOverlays(): void;
+    sendToControlDecks(eventName: string, data?: unknown): void;
+    triggerEvent(eventType: string, payload: unknown): void;
+    reportClientsToFrontend(isDefaultServerStarted: boolean): void;
+    getNumberOfOverlayClients(): number;
+    registerCustomWebSocketListener(pluginName: string, handler: CustomWebSocketHandler["handler"]): boolean;
+    unregisterCustomWebSocketListener(pluginName: string): boolean;
+}
+declare const manager: WebSocketServerManager;
+export { manager as WebSocketServerManager };

package/types/accounts.d.ts

@@ -1,5 +1,4 @@
 import type { AuthDetails } from "./auth";
-
 export type FirebotAccount = {
     username: string;
     displayName?: string;
@@ -10,4 +9,4 @@ export type FirebotAccount = {
     broadcasterType?: string;
     auth?: AuthDetails;
     loggedIn?: boolean;
-};
+};

package/types/auth.d.ts

@@ -1,5 +1,4 @@
 import type ClientOAuth2 from "client-oauth2";
-
 export interface AuthProviderDefinition {
     id: string;
     name: string;
@@ -17,7 +16,6 @@ export interface AuthProviderDefinition {
     redirectUriHost?: string;
     scopes?: string[] | string | undefined;
 }
-
 export interface AuthProvider {
     id: string;
     oauthClient: ClientOAuth2;
@@ -26,26 +24,19 @@ export interface AuthProvider {
     tokenUri: string;
     details: AuthProviderDefinition;
 }
-
 export interface AuthDetails {
     /** The access token */
     access_token: string;
-
     /** The type of access token */
     token_type: string;
-
     /** OAuth scopes of the access token */
     scope: string[];
-
     /** When the token was obtained, in epoch timestamp format */
     obtainment_timestamp?: number;
-
     /** How many seconds before the token expires */
     expires_in?: number;
-
     /** JSON representation of when access token expires */
     expires_at?: Date;
-
     /** The refresh token */
     refresh_token?: string;
-}
+}

package/types/channel-rewards.d.ts

@@ -1,12 +1,10 @@
 import type { EffectList } from "./effects";
 import type { RestrictionData } from "./restrictions";
-
 export interface CustomRewardImageSet {
     url1x: string;
     url2x: string;
     url4x: string;
 }
-
 export interface CustomReward {
     broadcasterId: string;
     broadcasterLogin: string;
@@ -38,7 +36,6 @@ export interface CustomReward {
     redemptionsRedeemedCurrentStream?: number;
     cooldownExpiresAt?: Date;
 }
-
 export type SavedChannelReward = {
     id: string;
     twitchData: CustomReward;
@@ -49,7 +46,6 @@ export type SavedChannelReward = {
     restrictionData?: RestrictionData;
     autoApproveRedemptions?: boolean;
 };
-
 export type RewardRedemptionMetadata = {
     username: string;
     userId: string;
@@ -60,4 +56,4 @@ export type RewardRedemptionMetadata = {
     rewardImage: string;
     rewardName: string;
     rewardCost: number;
-};
+};

package/types/chat.d.ts

@@ -1,36 +1,25 @@
-type FirebotChatMessagePartType =
-    | "text"
-    | "link"
-    | "emote"
-    | "third-party-emote"
-    | "cheermote"
-    | "mention";
-
+type FirebotChatMessagePartType = "text" | "link" | "emote" | "third-party-emote" | "cheermote" | "mention";
 type FirebotChatMessagePartBase = {
     type: FirebotChatMessagePartType;
     id?: string;
     text: string;
 };
-
-type FirebotChatMessageTextPart = FirebotChatMessagePartBase & {
+export type FirebotChatMessageTextPart = FirebotChatMessagePartBase & {
     type: "text";
     flagged?: boolean;
 };
-
-type FirebotChatMessageLinkPart = FirebotChatMessagePartBase & {
+export type FirebotChatMessageLinkPart = FirebotChatMessagePartBase & {
     type: "link";
     url: string;
 };
-
-type FirebotChatMessageEmotePart = FirebotChatMessagePartBase & {
+export type FirebotChatMessageEmotePart = FirebotChatMessagePartBase & {
     type: "emote" | "third-party-emote";
     name: string;
     origin: string;
     url: string;
     animatedUrl?: string;
 };
-
-type FirebotChatMessageCheermotePart = FirebotChatMessagePartBase & {
+export type FirebotChatMessageCheermotePart = FirebotChatMessagePartBase & {
     type: "cheermote";
     name: string;
     url: string;
@@ -38,21 +27,13 @@ type FirebotChatMessageCheermotePart = FirebotChatMessagePartBase & {
     amount: number;
     color: string;
 };
-
-type FirebotChatMessageMentionPart = FirebotChatMessagePartBase & {
+export type FirebotChatMessageMentionPart = FirebotChatMessagePartBase & {
     type: "mention";
     username: string;
     userId: string;
     userDisplayName: string;
 };
-
-export type FirebotChatMessagePart =
-    | FirebotChatMessageTextPart
-    | FirebotChatMessageLinkPart
-    | FirebotChatMessageEmotePart
-    | FirebotChatMessageCheermotePart
-    | FirebotChatMessageMentionPart;
-
+export type FirebotChatMessagePart = FirebotChatMessageTextPart | FirebotChatMessageLinkPart | FirebotChatMessageEmotePart | FirebotChatMessageCheermotePart | FirebotChatMessageMentionPart;
 export type FirebotParsedMessagePart = {
     type: string;
     id?: string;
@@ -67,7 +48,6 @@ export type FirebotParsedMessagePart = {
     amount?: number;
     color?: string;
 };
-
 export type FirebotChatMessage = {
     id: string;
     timestamp?: number;
@@ -135,14 +115,12 @@ export type FirebotChatMessage = {
     };
     isGigantified?: boolean;
 };
-
 export type FirebotEmote = {
     url: string;
     animatedUrl: string;
     origin: string;
     code: string;
 };
-
 export type FirebotCheermoteInstance = {
     name: string;
     amount: number;
@@ -150,10 +128,10 @@ export type FirebotCheermoteInstance = {
     animatedUrl: string;
     color: string;
 };
-
 export type SharedChatParticipant = {
     broadcasterId: string;
     broadcasterName: string;
     broadcasterDisplayName: string;
     profilePictureUrl: string;
-};
+};
+export {};

package/types/commands.d.ts

@@ -3,10 +3,8 @@ import type { EffectList } from "./effects";
 import type { RestrictionData } from "./restrictions";
 import type { ParametersConfig } from "./parameters";
 import type { Awaitable } from "./util-types";
-
 export type CommandType = "system" | "custom";
-
-type Cooldown = {
+export type Cooldown = {
     /**
      * Global cooldown to use a command in seconds.
      */
@@ -16,7 +14,6 @@ type Cooldown = {
      */
     user: number | undefined;
 };
-
 export type SubCommand = {
     arg: string;
     usage: string;
@@ -34,7 +31,6 @@ export type SubCommand = {
     effects?: EffectList;
     hidden?: boolean;
 };
-
 export type CommandDefinition<OptionsModel = any> = {
     id?: string;
     name?: string;
@@ -96,8 +92,7 @@ export type CommandDefinition<OptionsModel = any> = {
     };
     allowTriggerBySharedChat?: boolean | "inherit" | undefined;
 };
-
-type UserCommand = {
+export type UserCommand = {
     trigger: string;
     args: string[];
     triggeredSubcmd?: SubCommand;
@@ -107,32 +102,17 @@ type UserCommand = {
     commandSender: string;
     senderRoles: string[];
 };
-
-type BasicCommandDefinition = Omit<
-    CommandDefinition,
-    | "type"
-    | "createdBy"
-    | "createdAt"
-    | "lastEditBy"
-    | "lastEditAt"
-    | "count"
-    | "simple"
->;
-
 export type SystemCommandDefinition<OptionsModel = any> = CommandDefinition<OptionsModel> & {
     hideCooldowns?: boolean;
 };
-
 export type SystemCommand<OptionsModel = any> = {
     definition: SystemCommandDefinition<OptionsModel>;
-    onTriggerEvent: (
-        event: {
-            command: SystemCommand<OptionsModel>['definition'];
-            userCommand: UserCommand;
-            chatMessage: FirebotChatMessage;
-            commandOptions?: {
-                [x in keyof OptionsModel]: OptionsModel[x]
-            };
-        }
-    ) => Awaitable<boolean | void>;
-};
+    onTriggerEvent: (event: {
+        command: SystemCommand<OptionsModel>['definition'];
+        userCommand: UserCommand;
+        chatMessage: FirebotChatMessage;
+        commandOptions?: {
+            [x in keyof OptionsModel]: OptionsModel[x];
+        };
+    }) => Awaitable<boolean | void>;
+};