@crowbartools/firebot-types 5.67.0-alpha11 → 5.67.0-alpha13

package/types/plugins.d.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
 import type { EffectInstance, EffectList, EffectType } from "./effects";
 import type { Trigger } from "./triggers";
 import type { Awaitable } from "./util-types";
@@ -13,11 +12,8 @@ import type { UIExtension } from "./ui-extensions";
 import type { OverlayWidgetType } from "./overlay-widgets";
 import type { PluginHttpRouteDefinition } from "./http-server";
 import type { CustomWebSocketHandler } from "./websocket";
-
 type NoResult = Awaitable<void>;
-
 type GenericParameters = Record<string, unknown>;
-
 export type InstalledPluginConfig<Params extends GenericParameters = GenericParameters> = {
     id: string;
     fileName: string;
@@ -25,41 +21,31 @@ export type InstalledPluginConfig<Params extends GenericParameters = GenericPara
     legacyImport?: boolean;
     parameters: Params;
 };
-
 export type ScriptContext<Params extends FirebotParams = FirebotParams> = {
     trigger?: Trigger;
     parameters: Params;
 };
-
 type DynamicObject<T> = T | ((context: ScriptContext) => Awaitable<T>);
 type DynamicArray<T> = Array<T | ((context: ScriptContext) => Awaitable<T>)>;
-
 export type ScriptType = "script" | "plugin";
-
 interface ManifestDescription {
     short: string;
     long?: string;
 }
-
 interface ManifestFirebotVersion {
     major: number;
     minor?: number;
     patch?: number;
 }
-
 export interface Manifest {
     name: string;
     version: string;
     author: string;
     description: string | ManifestDescription;
-
-    // keywords?: string[];
-
     /**
      * A link to the plugin's source code repository
      */
     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.
@@ -70,10 +56,8 @@ export interface Manifest {
      * If the repo is on GitHub and support is not specified, it will default to the GitHub issues URL.
      */
     support?: string;
-
     minimumFirebotVersion?: ManifestFirebotVersion;
     maximumFirebotVersion?: ManifestFirebotVersion;
-
     /**
      * A FontAwesome icon name shown in the UI (eg. "fa-cogs").
      */
@@ -82,34 +66,26 @@ export interface Manifest {
      * A hex color code (eg. "#FF0000") used for the icon.
      */
     color?: string;
-
     /**
      * 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;
-
     type: ScriptType;
 }
-
 type EffectScriptResult = {
     success: boolean;
     errorMessage?: string;
     effects?: EffectList | Array<EffectInstance>;
     onEffectsDone?: () => Awaitable<void>;
 };
-
-
 export interface ScriptBase<Params extends FirebotParams = FirebotParams> {
     manifest: Manifest;
-
     parametersSchema?: FirebotParameterArray<Params>;
 }
-
 export interface EffectScript<Params extends FirebotParams = FirebotParams> extends ScriptBase<Params> {
     run: (context: ScriptContext<Params>) => Awaitable<void | EffectScriptResult>;
 }
-
 export interface Plugin<Params extends FirebotParams = FirebotParams> extends ScriptBase<Params> {
     /**
      * Automatically handles registration with appropriate managers for definitions
@@ -132,50 +108,40 @@ export interface Plugin<Params extends FirebotParams = FirebotParams> extends Sc
         httpRoutes?: DynamicObject<PluginHttpRouteDefinition>;
         websocketListener?: DynamicObject<CustomWebSocketHandler>;
     };
-
     /** Called when the plugin is loaded */
     onLoad?: (context: ScriptContext<Params>, isInstalling?: boolean) => NoResult;
-
     /** Called when Firebot is closing or plugin is disabled / removed  */
     onUnload?: (context: ScriptContext<Params>, isUninstalling?: boolean) => NoResult;
-
     /** Called when the user updates plugin-specific parameters */
     onParameterUpdate?: (context: ScriptContext<Params>) => NoResult;
 }
-
 export type ScriptDetails = Pick<ScriptBase, "manifest" | "parametersSchema">;
-
 export type InstalledPlugin = {
     config: InstalledPluginConfig;
     details: ScriptDetails;
 };
-
-/* Legacy types */
-type LegacyScriptParameters = Record<
-    string,
-    {
-
-        type: any;
-        title?: string;
-        description?: string;
-        secondaryDescription?: string;
-        tip?: string;
-        showBottomHr?: boolean;
-        validation?: {
-            required?: boolean;
-        };
-        value?: unknown;
-        default?: unknown;
-    }
->;
-
+type LegacyScriptParameters = Record<string, {
+    type: any;
+    title?: string;
+    description?: string;
+    secondaryDescription?: string;
+    tip?: string;
+    showBottomHr?: boolean;
+    validation?: {
+        required?: boolean;
+    };
+    value?: unknown;
+    default?: unknown;
+}>;
 export type LegacyScriptReturnObject = {
     success: boolean;
     errorMessage?: string;
-    effects: unknown[] | { id: string, list: unknown[] };
+    effects: unknown[] | {
+        id: string;
+        list: unknown[];
+    };
     callback?: VoidFunction;
 };
-
 type LegacyRunRequest = {
     parameters: Record<string, unknown>;
     modules: Record<string, unknown>;
@@ -191,7 +157,6 @@ type LegacyRunRequest = {
     };
     trigger: Trigger;
 };
-
 type LegacyCustomScriptManifest = {
     name: string;
     description: string;
@@ -202,23 +167,18 @@ type LegacyCustomScriptManifest = {
     initBeforeShowingParams?: boolean;
     firebotVersion?: "5";
 };
-
 export type LegacyScriptData = {
     id: string;
     name: string;
     scriptName: string;
     parameters: LegacyScriptParameters;
 };
-
 export type LegacyCustomScript = {
     getScriptManifest(): Awaitable<LegacyCustomScriptManifest>;
     getDefaultParameters?: () => LegacyScriptParameters;
-    run(
-        runRequest: LegacyRunRequest
-    ): Awaitable<void | LegacyScriptReturnObject>;
+    run(runRequest: LegacyRunRequest): Awaitable<void | LegacyScriptReturnObject>;
     parametersUpdated?: (parameters: Record<string, unknown>) => Awaitable<void>;
     stop?: () => Awaitable<void>;
 };
-
 export type FirebotScriptApi = import("./script-api").FirebotScriptApi;
 export type { ScriptLoggerApi, ScriptWebhooksApi, ScriptWebhook, ScriptWebhookEvent } from "./script-api";

package/types/power-ups.d.ts

@@ -1,13 +1,11 @@
 import type { CustomPowerUp } from "../backend/streaming-platforms/twitch/api/resource/power-ups";
 import type { EffectList } from "./effects";
-
 export type SavedPowerUp = {
     id: string;
     twitchData: CustomPowerUp;
     effects?: EffectList;
     sortTags?: string[];
 };
-
 export type PowerUpRedemptionMetadata = {
     username: string;
     userId: string;

package/types/pronouns.d.ts

@@ -4,8 +4,7 @@ export type Pronoun = {
     object: string;
     singular: boolean;
 };
-
 export type UserPronoun = {
     primary: string;
     secondary?: string;
-};
+};

package/types/quick-actions.d.ts

@@ -1,6 +1,5 @@
 import type { EffectList } from "./effects";
 import type { Awaitable } from "./util-types";
-
 export type QuickActionDefinition = {
     id: string;
     name: string;
@@ -11,8 +10,7 @@ export type QuickActionDefinition = {
     promptForArgs?: boolean;
     effectList?: EffectList;
 };
-
 export type SystemQuickAction = {
     definition: QuickActionDefinition;
     onTriggerEvent(): Awaitable<void>;
-};
+};

package/types/quotes.d.ts

@@ -2,7 +2,6 @@ export type QuoteAutoid = {
     _id: "__autoid__";
     seq: number;
 };
-
 export type Quote = {
     _id?: number;
     createdAt?: string;
@@ -11,7 +10,6 @@ export type Quote = {
     originator: string;
     text: string;
 };
-
 export type FormattedQuote = Omit<Quote, "_id"> & {
     id: number;
-};
+};

package/types/ranks.d.ts

@@ -3,7 +3,6 @@ export type Rank = {
     name: string;
     value?: number;
 };
-
 export type RankLadder = {
     id: string;
     name: string;
@@ -20,4 +19,4 @@ export type RankLadder = {
         showBadgeInChat?: boolean;
     };
     ranks: Rank[];
-};
+};

package/types/restrictions.d.ts

@@ -1,15 +1,13 @@
+import type ng from "angular";
 import type { Trigger, TriggerType, TriggersObject } from "./triggers";
 import type { Awaitable } from "./util-types";
-
 interface RestrictionScope<RestrictionModel> extends ng.IScope {
     restriction: Restriction<RestrictionModel>;
     restrictionDefinition: RestrictionType<RestrictionModel>;
     restrictionMode: RestrictionMode;
     [x: string]: any;
 }
-
 export type RestrictionMode = "all" | "any" | "none";
-
 export type RestrictionType<RestrictionModel = unknown> = {
     definition: {
         id: string;
@@ -19,26 +17,11 @@ export type RestrictionType<RestrictionModel = unknown> = {
     };
     failedReasonWhenInverted?: string;
     optionsTemplate: string;
-    optionsController?: (
-        $scope: RestrictionScope<RestrictionModel>,
-        ...args: any[]
-    ) => void;
-    optionsValueDisplay?: (
-        restriction: RestrictionModel,
-        ...args: any[]
-    ) => string;
-    predicate(
-        triggerData: Trigger,
-        restrictionData: RestrictionModel,
-        inherited?: boolean
-    ): Awaitable<boolean>;
-    onSuccessful?: (
-        triggerData: Trigger,
-        restrictionData: RestrictionModel,
-        inherited?: boolean
-    ) => Awaitable<void>;
+    optionsController?: ($scope: RestrictionScope<RestrictionModel>, ...args: any[]) => void;
+    optionsValueDisplay?: (restriction: RestrictionModel, ...args: any[]) => string;
+    predicate(triggerData: Trigger, restrictionData: RestrictionModel, inherited?: boolean): Awaitable<boolean>;
+    onSuccessful?: (triggerData: Trigger, restrictionData: RestrictionModel, inherited?: boolean) => Awaitable<void>;
 };
-
 export type Restriction<RestrictionModel = unknown> = {
     id: string;
     type: string;
@@ -47,7 +30,6 @@ export type Restriction<RestrictionModel = unknown> = {
 } & {
     [x: string]: unknown;
 };
-
 export type RestrictionData = {
     /**
      * Sets the command to only trigger when all/any/none of the restrictions pass.
@@ -62,4 +44,5 @@ export type RestrictionData = {
     restrictions: Restriction[];
     sendAsReply?: boolean;
     invertCondition?: boolean;
-};
+};
+export {};

package/types/roles.d.ts

@@ -2,7 +2,6 @@ export interface FirebotRole {
     id: string;
     name: string;
 }
-
 export type CustomRole = {
     id: string;
     name: string;
@@ -13,9 +12,8 @@ export type CustomRole = {
     }>;
     showBadgeInChat?: boolean;
 };
-
 export type LegacyCustomRole = {
     id: string;
     name: string;
     viewers: string[];
-};
+};

package/types/script-api.d.ts

@@ -1,9 +1,3 @@
-/// <reference types="node" />
-
-// Public contract types for the Firebot Script API.
-// Everything a custom script can touch via `require("@crowbartools/firebot-types")`
-// should be defined here
-
 import type { TriggeredEvent } from "./events";
 import type { RunEffectsContext } from "./effects";
 import type { TwitchApi } from "../backend/streaming-platforms/twitch/api";
@@ -11,30 +5,24 @@ import type { Notification } from "./notifications";
 import type { FirebotAccount } from "./accounts";
 import type { FirebotSettingsTypes } from "./settings";
 import type { InstalledPlugin } from "./plugins";
-
 export type ScriptLogMethod = (message: string, ...meta: unknown[]) => void;
-
 export interface ScriptLoggerApi {
     debug: ScriptLogMethod;
     info: ScriptLogMethod;
     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 {
     /** Create a new webhook (or return the existing one with the same name). */
     save(name: string): ScriptWebhook | null;
@@ -51,7 +39,6 @@ export interface ScriptWebhooksApi {
      */
     onReceived(handler: ScriptWebhookEventHandler): () => void;
 }
-
 /**
  * Simple per-script storage scoped to the script's data directory.
  * Provides helpers for storing/loading JSON values
@@ -60,7 +47,6 @@ export interface ScriptWebhooksApi {
 export interface ScriptStorageApi {
     /** Absolute path to this script's data directory. */
     readonly path: string;
-
     /** Save a value as JSON under the given key. The key becomes the filename with a `.json` extension. */
     setJson(key: string, value: unknown): Promise<void>;
     /**
@@ -70,7 +56,6 @@ export interface ScriptStorageApi {
     getJson<T = unknown>(key: string): Promise<T | null>;
     /** Delete the JSON value stored under the given key. No-op if missing. */
     deleteJson(key: string): Promise<void>;
-
     /** Check whether a file exists in the data directory. */
     fileExists(name: string): Promise<boolean>;
     /** Read a file's raw bytes. Returns `null` if it doesn't exist. */
@@ -82,36 +67,26 @@ export interface ScriptStorageApi {
     /** Delete a file. No-op if it doesn't exist. */
     deleteFile(name: string): Promise<void>;
 }
-
 export type ScriptEventHandler = (event: TriggeredEvent) => void;
-
 export interface ScriptEventsApi {
     /**
      * Subscribe to all Firebot events as they trigger. Returns an `unsubscribe`
      * function.
      */
     onTriggered(handler: ScriptEventHandler): () => void;
-
     /**
      * Manually trigger a Firebot event.
      */
-    trigger(
-        sourceId: string,
-        eventId: string,
-        meta?: Record<string, unknown>
-    ): Promise<void>;
+    trigger(sourceId: string, eventId: string, meta?: Record<string, unknown>): Promise<void>;
 }
-
 export interface ScriptEffectsApi {
     /**
      * Register an existing effect to be available for an event.
      * Useful for surfacing built-in effects on script provided events.
      */
     addEventToEffect(effectId: string, eventSourceId: string, eventId: string): void;
-
     /** Reverse of `addEventToEffect`. */
     removeEventFromEffect(effectId: string, eventSourceId: string, eventId: string): void;
-
     /**
      * Run an effect list. Respects the list's run mode and effect queue, if any.
      * Resolves once the effects have been run (queued lists resolve
@@ -119,12 +94,10 @@ export interface ScriptEffectsApi {
      */
     processEffects(context: RunEffectsContext): Promise<unknown>;
 }
-
 export interface ScriptTwitchApi {
     /** The full Twitch API surface. See {@linkcode TwitchApi}. */
     api: typeof TwitchApi;
 }
-
 /**
  * Access to this plugin's saved parameter values (the settings configured by
  * the user)
@@ -132,7 +105,6 @@ export interface ScriptTwitchApi {
 export interface ScriptParametersApi {
     getAll<T extends Record<string, unknown> = Record<string, unknown>>(): T;
 }
-
 export interface ScriptNotificationsApi {
     /**
      * Create a new notification. Pass `permanentlySave` as `true` to persist it
@@ -148,39 +120,25 @@ export interface ScriptNotificationsApi {
     /** Delete all of this script's notifications. */
     clearAll(): void;
 }
-
 export interface ScriptFrontendCommunicatorApi {
     /** Send a synchronous event to the frontend. */
     send<ExpectedArg = unknown>(eventName: string, data?: ExpectedArg): void;
-
     /**
      * Send an asynchronous event to the frontend and await the reply it sends
      * back.
      */
-    fireEventAsync<ReturnPayload = void, ExpectedArg = unknown>(
-        eventName: string,
-        data?: ExpectedArg
-    ): Promise<ReturnPayload>;
-
+    fireEventAsync<ReturnPayload = void, ExpectedArg = unknown>(eventName: string, data?: ExpectedArg): Promise<ReturnPayload>;
     /**
      * Handle a synchronous event triggered by the frontend. Returns an
      * `unsubscribe` function.
      */
-    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. Returns an
      * `unsubscribe` function.
      */
-    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;
 }
-
 export interface ScriptSettingsApi {
     /**
      * Get a Firebot setting value or its default
@@ -190,19 +148,24 @@ export interface ScriptSettingsApi {
      */
     getSetting<SettingName extends keyof FirebotSettingsTypes>(settingName: SettingName): FirebotSettingsTypes[SettingName];
 }
-
 export interface ScriptPluginsApi {
     /**
      * Get a list of currently installed plugins installed by the user
      */
     getInstalledPlugins(): Promise<Array<InstalledPlugin>>;
 }
-
 export interface Accounts {
     streamer: FirebotAccount;
     bot: FirebotAccount;
 }
-
+export interface ScriptWebServerApi {
+    /**
+     * Sends a custom event over the internal Firebot WebSocket server
+     * @param name Name of the event to send. Full event name will be `custom-event:{name}`
+     * @param data Any optional data you would like to send with the event
+     */
+    sendWebSocketEvent(name: string, data?: unknown): any;
+}
 export interface FirebotScriptApi {
     /** Running Firebot version, e.g. `"5.67.0"`. */
     version: string;
@@ -230,4 +193,6 @@ export interface FirebotScriptApi {
     notifications: ScriptNotificationsApi;
     /** Access to installed plugins. */
     plugins: ScriptPluginsApi;
+    /** Firebot internal web server functions. */
+    webServer: ScriptWebServerApi;
 }

package/types/settings.d.ts

@@ -1,22 +1,19 @@
-export enum FirebotAutoUpdateLevel {
+export declare enum FirebotAutoUpdateLevel {
     Off = 0,
     Bugfix = 1,
     Feature = 2,
     MajorRelease = 3,
     Betas = 4
 }
-
 export type FirebotAudioDevice = {
     label: string;
     deviceId: string;
 };
-
 export type FirebotGlobalValue = {
     name: string;
     secret?: boolean;
     value: string;
 };
-
 export type FirebotSettingsTypes = {
     ActiveChatUserListTimeout: number;
     ActiveProfiles: string[];
@@ -51,7 +48,10 @@ export type FirebotSettingsTypes = {
     ChatShowFfzEmotes: boolean;
     ChatShowSevenTvEmotes: boolean;
     ChatShowSharedChatInfo: boolean;
-    ChatTaggedNotificationSound: { name: string, path?: string | undefined };
+    ChatTaggedNotificationSound: {
+        name: string;
+        path?: string | undefined;
+    };
     ChatTaggedNotificationVolume: number;
     ChatTimestamps: boolean;
     ClearChatFeedMode: "never" | "onlyStreamer" | "always";
@@ -73,7 +73,7 @@ export type FirebotSettingsTypes = {
     EventSetSettings: Record<string, {
         position: number;
     }>;
-    EventSettings: object; // Pretty sure this is no longer used
+    EventSettings: object;
     FirstTimeUse: boolean;
     ForceOverlayEffectsToContinueOnRefresh: boolean;
     GlobalValues: Array<FirebotGlobalValue>;
@@ -125,4 +125,4 @@ export type FirebotSettingsTypes = {
     WebServerPort: number;
     WhileLoopEnabled: boolean;
     WysiwygBackground: "black" | "white";
-};
+};

package/types/setups.d.ts

@@ -11,16 +11,13 @@ import type { CustomRole, LegacyCustomRole } from "./roles";
 import type { FirebotGlobalValue } from "./settings";
 import type { ScheduledTask, Timer } from "./timers";
 import type { VariableMacro } from "./variable-macros";
-
 export type SetupImportQuestion = {
     replaceToken: string;
     answer: string;
 };
-
 type FirebotSetupGlobalValue = FirebotGlobalValue & {
     id: string;
 };
-
 export type FirebotSetup = {
     name: string;
     description: string;
@@ -46,4 +43,5 @@ export type FirebotSetup = {
         overlayWidgetConfigs: OverlayWidgetConfig[];
         globalValues: FirebotSetupGlobalValue[];
     };
-};
+};
+export {};

package/types/sort-tags.d.ts

@@ -1,4 +1,4 @@
 export interface SortTag {
     id: string;
     name: string;
-}
+}

package/types/timers.d.ts

@@ -1,7 +1,5 @@
 import type { DateTime } from "luxon";
-
 import type { EffectList } from "./effects";
-
 export type Timer = {
     id: string;
     name: string;
@@ -12,7 +10,6 @@ export type Timer = {
     effects: EffectList;
     sortTags: string[];
 };
-
 export type TimerIntervalTracker = {
     timerId: string;
     onlyWhenLive: boolean;
@@ -23,7 +20,6 @@ export type TimerIntervalTracker = {
     intervalId: number | NodeJS.Timeout;
     startedAt: DateTime;
 };
-
 export type ScheduledTask = {
     id: string;
     name: string;
@@ -33,4 +29,4 @@ export type ScheduledTask = {
     onlyWhenLive: boolean;
     effects: EffectList;
     sortTags: string[];
-};
+};