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

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 {};

package/types/parameters.d.ts

@@ -1,6 +1,5 @@
 import type { EffectList } from "./effects";
 import type { Animation } from "./overlay-widgets";
-
 export type BaseParameter = {
     /**
      * The title of the parameter
@@ -28,23 +27,19 @@ export type BaseParameter = {
     };
     default?: unknown;
 };
-
 export type StringParameter = BaseParameter & {
     type: "string";
     useTextArea?: boolean;
     default: string;
 };
-
 export type PasswordParameter = BaseParameter & {
     type: "password";
     default: string;
 };
-
 export type BooleanParameter = BaseParameter & {
     type: "boolean";
     default: boolean;
 };
-
 export type NumberParameter = BaseParameter & {
     type: "number";
     placeholder?: string;
@@ -54,7 +49,6 @@ export type NumberParameter = BaseParameter & {
         max?: number;
     };
 };
-
 export type DateTimeParameter = BaseParameter & {
     type: "date-time";
     default?: string;
@@ -62,7 +56,6 @@ export type DateTimeParameter = BaseParameter & {
         futureOnly?: boolean;
     };
 };
-
 export type EnumParameter<G = string | number> = BaseParameter & {
     type: "enum";
     options: Array<G>;
@@ -73,7 +66,6 @@ export type EnumParameter<G = string | number> = BaseParameter & {
      */
     placeholder?: string;
 };
-
 export type FilepathParameter = BaseParameter & {
     type: "filepath";
     fileOptions?: {
@@ -86,25 +78,20 @@ export type FilepathParameter = BaseParameter & {
         buttonLabel: string;
     };
 };
-
 export type EffectListParameter = BaseParameter & {
     type: "effectlist";
 };
-
 export type DiscordChannelWebhookParameter = BaseParameter & {
     type: "discord-channel-webhooks";
 };
-
 export type CurrencySelectParameter = BaseParameter & {
     type: "currency-select";
     default?: string;
 };
-
 export type ChatterSelectParameter = BaseParameter & {
     type: "chatter-select";
     default?: "Bot" | "Streamer";
 };
-
 export type EditableListParameter = BaseParameter & {
     type: "editable-list";
     default?: string[];
@@ -116,10 +103,7 @@ export type EditableListParameter = BaseParameter & {
         noneAddedText: string;
     };
 };
-
-export type MultiselectParameter<
-    T extends string | number = string | number
-> = BaseParameter & {
+export type MultiselectParameter<T extends string | number = string | number> = BaseParameter & {
     type: "multiselect";
     default?: T[];
     settings: {
@@ -129,7 +113,6 @@ export type MultiselectParameter<
         }>;
     };
 };
-
 export type RolePercentageParameterValue = {
     basePercent: number;
     roles: Array<{
@@ -137,12 +120,10 @@ export type RolePercentageParameterValue = {
         percent: number;
     }>;
 };
-
 export type RolePercentagesParameter = BaseParameter & {
     type: "role-percentages";
     default?: RolePercentageParameterValue;
 };
-
 export type RoleNumberParameterValue = {
     base: number;
     roles: Array<{
@@ -150,7 +131,6 @@ export type RoleNumberParameterValue = {
         value: number;
     }>;
 };
-
 export type RoleNumberParameter = BaseParameter & {
     type: "role-numbers";
     default?: RoleNumberParameterValue;
@@ -161,7 +141,6 @@ export type RoleNumberParameter = BaseParameter & {
         max?: number;
     };
 };
-
 export type ButtonParameter = BaseParameter & {
     type: "button";
     /**
@@ -170,30 +149,10 @@ export type ButtonParameter = BaseParameter & {
     backendEventName: string;
     buttonText: string;
     size?: "extraSmall" | "small" | "large";
-    buttonType?:
-    | "default"
-    | "primary"
-    | "success"
-    | "info"
-    | "warning"
-    | "danger"
-    | "link";
+    buttonType?: "default" | "primary" | "success" | "info" | "warning" | "danger" | "link";
     tooltip?: string;
-    tooltipPlacement?:
-    | "top"
-    | "top-left"
-    | "top-right"
-    | "bottom"
-    | "bottom-left"
-    | "bottom-right"
-    | "left"
-    | "left-top"
-    | "left-bottom"
-    | "right"
-    | "right-top"
-    | "right-bottom";
-};
-
+    tooltipPlacement?: "top" | "top-left" | "top-right" | "bottom" | "bottom-left" | "bottom-right" | "left" | "left-top" | "left-bottom" | "right" | "right-top" | "right-bottom";
+};
 export type HexColorParameter = BaseParameter & {
     type: "hexcolor";
     /**
@@ -202,7 +161,6 @@ export type HexColorParameter = BaseParameter & {
     default: string;
     allowAlpha?: boolean;
 };
-
 export type FontNameParameter = BaseParameter & {
     type: "font-name";
     /**
@@ -210,7 +168,6 @@ export type FontNameParameter = BaseParameter & {
      */
     default?: string;
 };
-
 export type FontOptions = {
     family: string;
     size: number;
@@ -218,14 +175,12 @@ export type FontOptions = {
     italic: boolean;
     color?: string;
 };
-
 export type FontOptionsParameter = BaseParameter & {
     type: "font-options";
     default: FontOptions;
     allowAlpha?: boolean;
     hideColor?: boolean;
 };
-
 export type RadioCardsParameter<V = string> = BaseParameter & {
     type: "radio-cards";
     default?: V;
@@ -239,143 +194,55 @@ export type RadioCardsParameter<V = string> = BaseParameter & {
         gridColumns?: number;
     };
 };
-
 export type CodeMirrorParameter = BaseParameter & {
     type: "codemirror";
     default?: string;
     settings?: {
-        mode: { name: "javascript", json?: boolean } | "htmlmixed" | "css" | { mode: "xml", htmlMode: true };
+        mode: {
+            name: "javascript";
+            json?: boolean;
+        } | "htmlmixed" | "css" | {
+            mode: "xml";
+            htmlMode: true;
+        };
         theme: 'blackboard';
         lineNumbers?: boolean;
         autoRefresh?: boolean;
         showGutter?: boolean;
     };
 };
-
 export type CounterSelectParameter = BaseParameter & {
     type: "counter-select";
     default?: never;
 };
-
 export type SortTagSelectParameter = BaseParameter & {
     type: "sort-tag-select";
     context: string;
     default?: never;
 };
-
 export type AnimationSelectParameter = BaseParameter & {
     type: "animation-select";
     animationType: "enter" | "exit" | "inbetween";
     default?: Animation;
 };
-
 export type UnknownParameter = BaseParameter & {
     [key: string]: unknown;
 };
-
-type FirebotParameter =
-    | StringParameter
-    | PasswordParameter
-    | BooleanParameter
-    | NumberParameter
-    | DateTimeParameter
-    | EnumParameter
-    | EffectListParameter
-    | DiscordChannelWebhookParameter
-    | CurrencySelectParameter
-    | ChatterSelectParameter
-    | EditableListParameter
-    | MultiselectParameter
-    | RolePercentagesParameter
-    | RoleNumberParameter
-    | ButtonParameter
-    | UnknownParameter
-    | HexColorParameter
-    | FontNameParameter
-    | FontOptionsParameter
-    | RadioCardsParameter
-    | CodeMirrorParameter
-    | CounterSelectParameter
-    | SortTagSelectParameter
-    | AnimationSelectParameter;
-
+type FirebotParameter = StringParameter | PasswordParameter | BooleanParameter | NumberParameter | DateTimeParameter | EnumParameter | EffectListParameter | DiscordChannelWebhookParameter | CurrencySelectParameter | ChatterSelectParameter | EditableListParameter | MultiselectParameter | RolePercentagesParameter | RoleNumberParameter | ButtonParameter | UnknownParameter | HexColorParameter | FontNameParameter | FontOptionsParameter | RadioCardsParameter | CodeMirrorParameter | CounterSelectParameter | SortTagSelectParameter | AnimationSelectParameter;
 export type ParametersConfig<P> = {
-    [K in keyof P]: (P[K] extends string
-        ?
-        | StringParameter
-        | PasswordParameter
-        | DateTimeParameter
-        | FilepathParameter
-        | ChatterSelectParameter
-        | CurrencySelectParameter
-        | EnumParameter<string>
-        | HexColorParameter
-        | FontNameParameter
-        | RadioCardsParameter<string>
-        | CodeMirrorParameter
-        | CounterSelectParameter
-        | SortTagSelectParameter
-        : P[K] extends number
-            ? NumberParameter | EnumParameter<number>
-            : P[K] extends boolean
-                ? BooleanParameter | EnumParameter<boolean>
-                : P[K] extends Array<string>
-                    ? MultiselectParameter<string> | EditableListParameter
-                    : P[K] extends Array<number>
-                        ? MultiselectParameter<number>
-                        : P[K] extends void | undefined | null
-                            ? ButtonParameter
-                            : P[K] extends RolePercentageParameterValue
-                                ? RolePercentagesParameter
-                                : P[K] extends RoleNumberParameterValue
-                                    ? RoleNumberParameter
-                                    : P[K] extends EffectList
-                                        ? EffectListParameter
-                                        : P[K] extends FontOptions
-                                            ? FontOptionsParameter
-                                            : P[K] extends Animation
-                                                ? AnimationSelectParameter : FirebotParameter) & { value?: P[K] };
-};
-
+    [K in keyof P]: (P[K] extends string ? StringParameter | PasswordParameter | DateTimeParameter | FilepathParameter | ChatterSelectParameter | CurrencySelectParameter | EnumParameter<string> | HexColorParameter | FontNameParameter | RadioCardsParameter<string> | CodeMirrorParameter | CounterSelectParameter | SortTagSelectParameter : P[K] extends number ? NumberParameter | EnumParameter<number> : P[K] extends boolean ? BooleanParameter | EnumParameter<boolean> : P[K] extends Array<string> ? MultiselectParameter<string> | EditableListParameter : P[K] extends Array<number> ? MultiselectParameter<number> : P[K] extends void | undefined | null ? ButtonParameter : P[K] extends RolePercentageParameterValue ? RolePercentagesParameter : P[K] extends RoleNumberParameterValue ? RoleNumberParameter : P[K] extends EffectList ? EffectListParameter : P[K] extends FontOptions ? FontOptionsParameter : P[K] extends Animation ? AnimationSelectParameter : FirebotParameter) & {
+        value?: P[K];
+    };
+};
 export type ParametersWithNameConfig<P> = {
-    [K in keyof P]: (P[K] extends string
-        ?
-        | StringParameter
-        | PasswordParameter
-        | DateTimeParameter
-        | FilepathParameter
-        | ChatterSelectParameter
-        | CurrencySelectParameter
-        | EnumParameter<string>
-        | HexColorParameter
-        | FontNameParameter
-        | RadioCardsParameter<string>
-        | CodeMirrorParameter
-        | CounterSelectParameter
-        | SortTagSelectParameter
-        : P[K] extends number
-            ? NumberParameter | EnumParameter<number> | RadioCardsParameter<number>
-            : P[K] extends boolean
-                ? BooleanParameter | EnumParameter<boolean> | RadioCardsParameter<boolean>
-                : P[K] extends Array<string>
-                    ? MultiselectParameter<string> | EditableListParameter
-                    : P[K] extends Array<number>
-                        ? MultiselectParameter<number>
-                        : P[K] extends void | undefined | null
-                            ? ButtonParameter
-                            : P[K] extends RolePercentageParameterValue
-                                ? RolePercentagesParameter
-                                : P[K] extends RoleNumberParameterValue
-                                    ? RoleNumberParameter
-                                    : P[K] extends EffectList
-                                        ? EffectListParameter
-                                        : P[K] extends FontOptions
-                                            ? FontOptionsParameter
-                                            : P[K] extends Animation
-                                                ? AnimationSelectParameter : FirebotParameter) & { name: K, showIf?: { [K2 in keyof P]?: P[K2] | Array<P[K2]> } };
-};
-
-type FirebotParamCategory<ParamConfig extends Record<string, unknown>> = {
+    [K in keyof P]: (P[K] extends string ? StringParameter | PasswordParameter | DateTimeParameter | FilepathParameter | ChatterSelectParameter | CurrencySelectParameter | EnumParameter<string> | HexColorParameter | FontNameParameter | RadioCardsParameter<string> | CodeMirrorParameter | CounterSelectParameter | SortTagSelectParameter : P[K] extends number ? NumberParameter | EnumParameter<number> | RadioCardsParameter<number> : P[K] extends boolean ? BooleanParameter | EnumParameter<boolean> | RadioCardsParameter<boolean> : P[K] extends Array<string> ? MultiselectParameter<string> | EditableListParameter : P[K] extends Array<number> ? MultiselectParameter<number> : P[K] extends void | undefined | null ? ButtonParameter : P[K] extends RolePercentageParameterValue ? RolePercentagesParameter : P[K] extends RoleNumberParameterValue ? RoleNumberParameter : P[K] extends EffectList ? EffectListParameter : P[K] extends FontOptions ? FontOptionsParameter : P[K] extends Animation ? AnimationSelectParameter : FirebotParameter) & {
+        name: K;
+        showIf?: {
+            [K2 in keyof P]?: P[K2] | Array<P[K2]>;
+        };
+    };
+};
+export type FirebotParamCategory<ParamConfig extends Record<string, unknown>> = {
     title: string;
     /**
      * Used to order categories in the UI.
@@ -383,32 +250,9 @@ type FirebotParamCategory<ParamConfig extends Record<string, unknown>> = {
     sortRank?: number;
     settings: ParametersConfig<ParamConfig>;
 };
-
 export type FirebotParams = Record<string, unknown>;
-
-export type FirebotParameterCategories<Config extends FirebotParams> = {
+export type FirebotParameterCategories<Config extends Record<string, Record<string, unknown>>> = {
     [Category in keyof Config]: FirebotParamCategory<Config[Category]>;
 };
-
 export type FirebotParameterArray<Config extends Record<string, unknown>> = ParametersWithNameConfig<Config>[keyof Config][];
-
-
-// export type WithValues<Categories extends FirebotParameterCategories> = {
-//     [Category in keyof Categories]: Categories[Category] & {
-//         settings: {
-//             [Setting in keyof Categories[Category]["settings"]]: Categories[Category]["settings"][Setting] & {
-//                 value?: Categories[Category]["settings"][Setting]["default"];
-//             };
-//         };
-//     }
-// };
-
-// type ValidParamKeys<T> = {
-//     [P in keyof T]: Exclude<T[P], undefined> extends void | undefined | null
-//         ? never
-//         : P;
-// }[keyof T];
-
-// export type ResolvedParameters<Config extends FirebotParams> = {
-//     [K in keyof Config]: Pick<Config[K], ValidParamKeys<Config[K]>>;
-// }
+export {};