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

package/types/triggers.d.ts

@@ -1,28 +1,10 @@
 import type { FirebotChatMessage } from "./chat";
 import type { CommandDefinition, SubCommand } from "./commands";
-
-export type TriggerType =
-    | "command"
-    | "custom_script"
-    | "startup_script"
-    | "api"
-    | "event"
-    | "hotkey"
-    | "timer"
-    | "scheduled_task"
-    | "counter"
-    | "preset"
-    | "quick_action"
-    | "manual"
-    | "channel_reward"
-    | "power_up"
-    | "overlay_widget";
-
+export type TriggerType = "command" | "custom_script" | "startup_script" | "api" | "event" | "hotkey" | "timer" | "scheduled_task" | "counter" | "preset" | "quick_action" | "manual" | "channel_reward" | "power_up" | "overlay_widget";
 export type TriggerMeta = {
     triggerId?: string;
     [x: string]: unknown;
 };
-
 export type Trigger = {
     type: TriggerType;
     metadata: {
@@ -37,8 +19,14 @@ export type Trigger = {
             subcommandId?: string;
         };
         chatMessage?: FirebotChatMessage;
-        event?: { id: string, name: string };
-        eventSource?: { id: string, name: string };
+        event?: {
+            id: string;
+            name: string;
+        };
+        eventSource?: {
+            id: string;
+            name: string;
+        };
         eventData?: {
             chatMessage?: FirebotChatMessage;
             [x: string]: unknown;
@@ -53,9 +41,10 @@ export type Trigger = {
         };
         [x: string]: unknown;
     };
-    effectOutputs?: { [key: string]: unknown };
+    effectOutputs?: {
+        [key: string]: unknown;
+    };
 };
-
 export type TriggersObject = {
     [T in TriggerType]?: T extends "event" ? string[] | boolean : boolean;
 };

package/types/ui/angular.d.ts

@@ -1,31 +1,10 @@
 import type angular from "angular";
-
 export type BindingsDefinition<Bindings> = {
-    [K in keyof Bindings]: {} extends Pick<Bindings, K>
-        ? Bindings[K] extends string
-            ? "@?" | "<?" | "=?" | `@?${string}` | `<?${string}` | `=?${string}`
-            : Bindings[K] extends boolean
-                ? "<?" | "=?" | `<?${string}` | `=?${string}`
-                : Bindings[K] extends number
-                    ? "<?" | "=?" | `<?${string}` | `=?${string}`
-                    : Bindings[K] extends (...args: any[]) => any
-                        ? "&?" | `&?${string}`
-                        : "<?" | "=?" | `<?${string}` | `=?${string}`
-        : Bindings[K] extends string
-            ? "@" | "<" | "=" | `@${string}` | `<${string}` | `=${string}`
-            : Bindings[K] extends boolean
-                ? "<" | "=" | `<${string}` | `=${string}`
-                : Bindings[K] extends number
-                    ? "<" | "=" | `<${string}` | `=${string}`
-                    : Bindings[K] extends (...args: any[]) => any
-                        ? "&" | `&${string}`
-                        : "<" | "=" | `<${string}` | `=${string}`;
+    [K in keyof Bindings]: {} extends Pick<Bindings, K> ? Bindings[K] extends string ? "@?" | "<?" | "=?" | `@?${string}` | `<?${string}` | `=?${string}` : Bindings[K] extends boolean ? "<?" | "=?" | `<?${string}` | `=?${string}` : Bindings[K] extends number ? "<?" | "=?" | `<?${string}` | `=?${string}` : Bindings[K] extends (...args: any[]) => any ? "&?" | `&?${string}` : "<?" | "=?" | `<?${string}` | `=?${string}` : Bindings[K] extends string ? "@" | "<" | "=" | `@${string}` | `<${string}` | `=${string}` : Bindings[K] extends boolean ? "<" | "=" | `<${string}` | `=${string}` : Bindings[K] extends number ? "<" | "=" | `<${string}` | `=${string}` : Bindings[K] extends (...args: any[]) => any ? "&" | `&${string}` : "<" | "=" | `<${string}` | `=${string}`;
 };
-
 export type FirebotComponent<Bindings, ExtraControllerProps = {}> = angular.IComponentOptions & {
     bindings: BindingsDefinition<Bindings>;
-    controller: (
-        this: angular.IController & Bindings & ExtraControllerProps & { [key: string]: unknown },
-        ...args: unknown[]
-    ) => void;
-};
+    controller: (this: angular.IController & Bindings & ExtraControllerProps & {
+        [key: string]: unknown;
+    }, ...args: unknown[]) => void;
+};

package/types/ui/effect-helper-service.d.ts

@@ -1,5 +1,4 @@
 import type { EffectType } from "../effects";
-
 export type EffectHelperService = {
     getAllEffectTypes: () => Promise<EffectType[]>;
-};
+};

package/types/ui/effect-queues-service.d.ts

@@ -1,10 +1,14 @@
-import type { EffectQueueConfig } from "../../types";
-
+import type { EffectQueueConfig } from "..";
 export type EffectQueuesService = {
     effectQueues: EffectQueueConfig[];
     getEffectQueues: () => EffectQueueConfig[];
     getEffectQueue: (id: string) => EffectQueueConfig | undefined;
     showAddEditEffectQueueModal: (queueId?: string) => Promise<string>;
     showDeleteEffectQueueModal: (queueId: string) => Promise<boolean>;
-    queueModes: { value: string, label: string, description: string, iconClass: string }[];
-};
+    queueModes: {
+        value: string;
+        label: string;
+        description: string;
+        iconClass: string;
+    }[];
+};

package/types/ui/firebot-root-scope.d.ts

@@ -1,5 +1,4 @@
 import type angular from "angular";
-
 export type FirebotRootScope = angular.IRootScopeService & {
     copyTextToClipboard: (text: string) => void;
 };

package/types/ui/index.d.ts

@@ -9,4 +9,4 @@ export * from "./ng-toast";
 export * from "./firebot-root-scope";
 export * from "./object-copy-helper";
 export * from "./preset-effect-lists-service";
-export * from "./effect-queues-service";
+export * from "./effect-queues-service";

package/types/ui/modal-factory.d.ts

@@ -1,19 +1,11 @@
 import type { EffectInstance } from "../effects";
 import type { TriggerType } from "../triggers";
-
 export type ModalFactory = {
-    showEditEffectModal: (
-        effectInstance: EffectInstance,
-        effectIndex: number | null,
-        trigger: TriggerType,
-        closeCallback: (response: {
-            action: "add" | "update" | "delete";
-            effect: EffectInstance | null;
-            index: number;
-        }) => void,
-        triggerMeta: unknown,
-        isNewEffect: boolean
-    ) => void;
+    showEditEffectModal: (effectInstance: EffectInstance, effectIndex: number | null, trigger: TriggerType, closeCallback: (response: {
+        action: "add" | "update" | "delete";
+        effect: EffectInstance | null;
+        index: number;
+    }) => void, triggerMeta: unknown, isNewEffect: boolean) => void;
     openGetInputModal: <T extends string | number>(options: {
         model: T;
         inputType?: "text" | "number" | "password";

package/types/ui/modal-service.d.ts

@@ -1,9 +1,10 @@
 import type angular from "angular";
-
 export type ModalService = {
     showModal: (options: {
         component?: string;
-        resolveObj?: { [key: string]: unknown };
+        resolveObj?: {
+            [key: string]: unknown;
+        };
         dismissCallback?: () => void;
         closeCallback?: (data: unknown) => void;
         size?: "sm" | "md" | "mdlg" | "lg" | "xl";

package/types/ui/ng-toast.d.ts

@@ -1,3 +1,7 @@
 export type NgToast = {
-    create: (options: { content: string, timeout?: number, className?: string } | string) => void;
+    create: (options: {
+        content: string;
+        timeout?: number;
+        className?: string;
+    } | string) => void;
 };

package/types/ui/object-copy-helper.d.ts

@@ -1,6 +1,5 @@
 import type { EffectInstance } from "../effects";
 import type { TriggerType } from "../triggers";
-
 export type ObjectCopyHelper = {
     copyEffects: (effects: EffectInstance[]) => void;
     getCopiedEffects: (trigger: TriggerType, triggerMeta: unknown) => Promise<EffectInstance[]>;

package/types/ui/platform-service.d.ts

@@ -4,4 +4,4 @@ export type PlatformService = {
     isWindows: boolean;
     isLinux: boolean;
     loadPlatform: () => void;
-};
+};

package/types/ui/preset-effect-lists-service.d.ts

@@ -1,5 +1,4 @@
 import type { PresetEffectList } from "../effects";
-
 export type PresetEffectListsService = {
     presetEffectLists: PresetEffectList[];
     loadPresetEffectLists: () => void;
@@ -9,11 +8,7 @@ export type PresetEffectListsService = {
     saveAllPresetEffectLists: (presetEffectLists: PresetEffectList[]) => void;
     presetEffectListNameExists: (name: string) => boolean;
     showRunPresetListModal: (id: string, isQuickAction?: boolean) => void;
-    manuallyTriggerPresetEffectList: (
-        presetEffectListId: string,
-        args?: Record<string, unknown>,
-        isQuickAction?: boolean
-    ) => void;
+    manuallyTriggerPresetEffectList: (presetEffectListId: string, args?: Record<string, unknown>, isQuickAction?: boolean) => void;
     duplicatePresetEffectList: (presetEffectListId: string) => void;
     deletePresetEffectList: (presetEffectListId: string) => void;
     showAddEditPresetEffectListModal: (presetEffectList?: Partial<PresetEffectList>) => Promise<PresetEffectList | null>;

package/types/ui/settings-service.d.ts

@@ -1,5 +1,4 @@
 import type { FirebotSettingsTypes } from "../settings";
-
 export type SettingsService = {
     getSetting: <Key extends keyof FirebotSettingsTypes>(key: Key) => FirebotSettingsTypes[Key];
 };

package/types/ui-extensions.d.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-unsafe-function-type */
 export type BasePage = {
     id: string;
     name: string;
@@ -6,32 +5,27 @@ export type BasePage = {
     fullPage?: boolean;
     disableScroll?: boolean;
 };
-
 export type AngularJsPage = BasePage & {
     type: 'angularjs';
     template: string;
     controller: Function;
 };
-
 export type IframePage = BasePage & {
     type: 'iframe';
-    // Other properties TBD
 };
-
 export type AngularJsFactory = {
     name: string;
     function: Function;
 };
-
 export type AngularJsComponent = {
     name: string;
     bindings: Record<string, string>;
     template: string;
-    transclude?: boolean | string | { [slot: string]: string };
+    transclude?: boolean | string | {
+        [slot: string]: string;
+    };
     controller: Function;
 };
-
-
 /**
  * A specialized AngularJS component for rendering Firebot parameters.
  * These components will always have the following bindings:
@@ -53,10 +47,8 @@ export type AngularJsFirebotParameterComponent = {
     template: string;
     controller: Function;
 };
-
 export type AngularJsDirective = {
     name: string;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     function: (...args: any[]) => {
         compile?: Function;
         controller?: Function;
@@ -64,23 +56,24 @@ export type AngularJsDirective = {
         multiElement?: boolean;
         name?: string;
         priority?: number;
-        require?: string | string[] | { [controller: string]: string };
+        require?: string | string[] | {
+            [controller: string]: string;
+        };
         restrict?: string;
         scope?: boolean | object;
         template?: string;
         terminal?: boolean;
-        transclude?: boolean | string | { [slot: string]: string };
+        transclude?: boolean | string | {
+            [slot: string]: string;
+        };
     };
 };
-
 export type AngularJsFilter = {
     name: string;
     function: {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         (...args: any[]): Function;
     };
 };
-
 export type UIExtension = {
     id: string;
     /**

package/types/util-types.d.ts

@@ -1,52 +1,26 @@
-export type NoFunctionValue =
-    boolean
-    | string
-    | number
-    | null
-    | undefined
-
-    | NoFunctionObject
-
-    | NoFunctionArray;
-
+export type NoFunctionValue = boolean | string | number | null | undefined | NoFunctionObject | NoFunctionArray;
 export interface NoFunctionObject {
     [key: string]: NoFunctionValue;
 }
-
 export type NoFunctionArray = Array<NoFunctionValue>;
-
 export type Awaitable<T> = T | PromiseLike<T>;
-
-type ObjectOfUnknowns = {
+export type ObjectOfUnknowns = {
     [key: string]: unknown;
 };
-
 export type KeyValuePair<K = string, V = string> = {
     key: K;
     value: V;
 };
-
 export type FileFilter = {
     name: string;
     extensions: string[];
 };
-
 /**
  * Converts a camelCase string type into its snake_case equivalent.
  * Uppercase letters and digits are prefixed with an underscore.
  */
-type CamelToSnake<S extends string, Acc extends string = ""> = S extends `${infer H}${infer T}`
-    ? H extends Uppercase<H>
-        ? H extends Lowercase<H>
-            ? CamelToSnake<T, `${Acc}_${H}`>
-            : CamelToSnake<T, `${Acc}_${Lowercase<H>}`>
-        : CamelToSnake<T, `${Acc}${H}`>
-    : Acc;
-
-export type SnakeCased<T> = T extends Date
-    ? string
-    : T extends Array<infer U>
-        ? Array<SnakeCased<U>>
-        : T extends object
-            ? { [K in keyof T as K extends string ? CamelToSnake<K> : K]: SnakeCased<T[K]> }
-            : T;
+type CamelToSnake<S extends string, Acc extends string = ""> = S extends `${infer H}${infer T}` ? H extends Uppercase<H> ? H extends Lowercase<H> ? CamelToSnake<T, `${Acc}_${H}`> : CamelToSnake<T, `${Acc}_${Lowercase<H>}`> : CamelToSnake<T, `${Acc}${H}`> : Acc;
+export type SnakeCased<T> = T extends Date ? string : T extends Array<infer U> ? Array<SnakeCased<U>> : T extends object ? {
+    [K in keyof T as K extends string ? CamelToSnake<K> : K]: SnakeCased<T[K]>;
+} : T;
+export {};

package/types/variable-macros.d.ts

@@ -4,4 +4,4 @@ export type VariableMacro = {
     expression: string;
     description?: string;
     argNames?: string[];
-};
+};

package/types/variables.d.ts

@@ -1,23 +1,11 @@
 import type { Trigger, TriggersObject, TriggerType, TriggerMeta } from "./triggers";
 import type { Awaitable } from "./util-types";
-
 export { Trigger, TriggersObject, TriggerType, TriggerMeta };
-
-export type VariableCategory =
-    | "common"
-    | "trigger based"
-    | "user based"
-    | "text"
-    | "numbers"
-    | "advanced"
-    | "obs"
-    | "integrations";
-
+export type VariableCategory = "common" | "trigger based" | "user based" | "text" | "numbers" | "advanced" | "obs" | "integrations";
 export type VariableUsage = {
     usage: string;
     description?: string;
 };
-
 interface VariableDefinition {
     handle: string;
     aliases?: string[];
@@ -32,23 +20,21 @@ interface VariableDefinition {
     sensitive?: boolean;
     hidden?: boolean;
 }
-
 type Variable = {
     definition: VariableDefinition;
     getSuggestions?: (triggerType: TriggerType, triggerMeta?: TriggerMeta) => Awaitable<VariableUsage[]>;
     argsCheck?: (...args: unknown[]) => void;
     evaluator(trigger: Trigger, ...args: unknown[]): Awaitable<unknown>;
 };
-
 type SpoofedVariable = {
-    definition: VariableDefinition & { spoof: true };
+    definition: VariableDefinition & {
+        spoof: true;
+    };
     argsCheck?: never;
     evaluator?: never;
     getSuggestions?: (triggerType: TriggerType, triggerMeta?: TriggerMeta) => Awaitable<VariableUsage[]>;
 };
-
 export type ReplaceVariable = Variable | SpoofedVariable;
-
 export type RegisteredVariable = {
     definition: VariableDefinition;
     handle: string;
@@ -56,4 +42,4 @@ export type RegisteredVariable = {
     argsCheck: (...args: unknown[]) => void;
     evaluator(trigger: Trigger, ...args: unknown[]): Awaitable<unknown>;
     getSuggestions: (triggerType: TriggerType, triggerMeta?: TriggerMeta) => Awaitable<VariableUsage[]>;
-};
+};

package/types/viewers.d.ts

@@ -18,7 +18,6 @@ export interface FirebotViewer {
     currency: Record<string, number>;
     ranks: Record<string, string>;
 }
-
 export interface BasicViewer {
     id: string;
     username: string;
@@ -26,5 +25,4 @@ export interface BasicViewer {
     twitchRoles?: string[];
     profilePicUrl?: string;
 }
-
-export type NewFirebotViewer = BasicViewer & Partial<Omit<FirebotViewer, "_id" | "username" | "displayName" | "twitchRoles" | "profilePicUrl">>
+export type NewFirebotViewer = BasicViewer & Partial<Omit<FirebotViewer, "_id" | "username" | "displayName" | "twitchRoles" | "profilePicUrl">>;

package/types/webhooks.d.ts

@@ -2,4 +2,4 @@ export type WebhookConfig = {
     id: string;
     name: string;
     scriptId?: string;
-};
+};

package/types/websocket.d.ts

@@ -1,70 +1,32 @@
 import type { Awaitable } from "./util-types";
-
-export type WebSocketEventType =
-"subscribe-events" |
-"overlay-connected" |
-"overlay-event" |
-"send-to-overlay" |
-
-"command:created" |
-"command:updated" |
-"command:deleted" |
-
-"counter:created" |
-"counter:updated" |
-"counter:deleted" |
-
-"custom-role:created" |
-"custom-role:updated" |
-"custom-role:deleted" |
-
-"custom-variable:created" |
-"custom-variable:updated" |
-"custom-variable:deleted" |
-
-"effect-queue:created" |
-"effect-queue:updated" |
-"effect-queue:length-updated" |
-"effect-queue:deleted" |
-
-"preset-effect-list:created" |
-"preset-effect-list:updated" |
-"preset-effect-list:deleted" |
-
-"timer:created" |
-"timer:updated" |
-"timer:deleted";
-
-interface Message {
+export type WebSocketEventType = "subscribe-events" | "overlay-connected" | "overlay-event" | "send-to-overlay" | "command:created" | "command:updated" | "command:deleted" | "counter:created" | "counter:updated" | "counter:deleted" | "custom-role:created" | "custom-role:updated" | "custom-role:deleted" | "custom-variable:created" | "custom-variable:updated" | "custom-variable:deleted" | "effect-queue:created" | "effect-queue:updated" | "effect-queue:length-updated" | "effect-queue:deleted" | "preset-effect-list:created" | "preset-effect-list:updated" | "preset-effect-list:deleted" | "timer:created" | "timer:updated" | "timer:deleted";
+export interface Message {
     type: string;
     id?: number | string;
     name: string;
     data?: unknown;
 }
-interface InvokeMessage extends Message {
+export interface InvokeMessage extends Message {
     type: "invoke";
     id: string | number;
     data: unknown;
 }
-interface ResponseMessage extends Message {
+export interface ResponseMessage extends Message {
     type: "response";
     id: number | string;
     name: "error" | "success";
 }
-interface EventMessage extends Message {
+export interface EventMessage extends Message {
     type: "event";
 }
-
-interface InvokePluginMessage extends InvokeMessage {
+export interface InvokePluginMessage extends InvokeMessage {
     name: "plugin";
     pluginName: string;
 }
-
-interface CustomWebSocketHandler {
+export interface CustomWebSocketHandler {
     pluginName: string;
     handler: (data: unknown) => Awaitable<void>;
 }
-
 export type OverlayConnectedData = {
     instanceName: string;
-};
+};