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

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,5 @@ 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";
+export * from "./control-deck-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,9 +1,9 @@
 import type { EffectInstance } from "../effects";
 import type { TriggerType } from "../triggers";
-
 export type ObjectCopyHelper = {
     copyEffects: (effects: EffectInstance[]) => void;
     getCopiedEffects: (trigger: TriggerType, triggerMeta: unknown) => Promise<EffectInstance[]>;
     hasCopiedEffects: () => boolean;
     cloneEffect: (effect: EffectInstance) => EffectInstance;
+    copyAndReplaceIds<T>(obj: T): T;
 };

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

@@ -0,0 +1,101 @@
+export type BasePage = {
+    id: string;
+    name: string;
+    icon: `fa-${string}`;
+    fullPage?: boolean;
+    disableScroll?: boolean;
+};
+export type AngularJsPage = BasePage & {
+    type: 'angularjs';
+    template: string;
+    controller: Function;
+};
+export type IframePage = BasePage & {
+    type: 'iframe';
+};
+export type AngularJsFactory = {
+    name: string;
+    function: Function;
+};
+export type AngularJsComponent = {
+    name: string;
+    bindings: Record<string, string>;
+    template: 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:
+ * - `$ctrl.schema`: The parameter schema (any properties in the parameter object)
+ * - `$ctrl.value`: The current value of the parameter
+ * - `$ctrl.onInput`: A callback function to call when the parameter value changes
+ * - `$ctrl.onTouched`: A callback function to call when the parameter is touched
+ */
+export type AngularJsFirebotParameterComponent = {
+    parameterConfig: {
+        /**
+         * The type of parameter this component handles.
+         * This value is what will go in the "type" field of a parameter schema.
+         */
+        type: string;
+        hideTitle?: boolean;
+        hideDescription?: boolean;
+    };
+    template: string;
+    controller: Function;
+};
+export type AngularJsDirective = {
+    name: string;
+    function: (...args: any[]) => {
+        compile?: Function;
+        controller?: Function;
+        link?: Function;
+        multiElement?: boolean;
+        name?: string;
+        priority?: number;
+        require?: string | string[] | {
+            [controller: string]: string;
+        };
+        restrict?: string;
+        scope?: boolean | object;
+        template?: string;
+        terminal?: boolean;
+        transclude?: boolean | string | {
+            [slot: string]: string;
+        };
+    };
+};
+export type AngularJsFilter = {
+    name: string;
+    function: {
+        (...args: any[]): Function;
+    };
+};
+export type UIExtension = {
+    id: string;
+    /**
+     * Adds new sidebar entries under an "Extensions" category
+     */
+    pages?: AngularJsPage[];
+    /**
+     * Add your own AngularJS services, components, directives, filters
+     */
+    providers?: {
+        factories?: AngularJsFactory[];
+        components?: AngularJsComponent[];
+        directives?: AngularJsDirective[];
+        filters?: AngularJsFilter[];
+        /**
+         * Add your own parameter components for rendering custom parameter types
+         */
+        parameters?: AngularJsFirebotParameterComponent[];
+    };
+};
+export type FrontendListener = {
+    eventName: string;
+    useAsync?: boolean;
+    handler: <ExpectedArgs extends Array<unknown> = [], ReturnPayload = void>(...args: ExpectedArgs) => ReturnPayload;
+};

package/types/util-types.d.ts

@@ -1,52 +1,30 @@
-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;
+type SnakeToCamel<S extends string> = S extends `${infer H}_${infer T}` ? `${H}${Capitalize<SnakeToCamel<T>>}` : S;
+export type CamelCased<T> = T extends Date ? string : T extends Array<infer U> ? Array<CamelCased<U>> : T extends object ? {
+    [K in keyof T as K extends string ? SnakeToCamel<K> : K]: CamelCased<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,12 @@
+import type { EventSourceAndId } from "./events";
 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 +21,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 +43,22 @@ export type RegisteredVariable = {
     argsCheck: (...args: unknown[]) => void;
     evaluator(trigger: Trigger, ...args: unknown[]): Awaitable<unknown>;
     getSuggestions: (triggerType: TriggerType, triggerMeta?: TriggerMeta) => Awaitable<VariableUsage[]>;
-};
+};
+export type AdditionalVariableEvent = {
+    handle: string;
+    eventSourceId: string;
+    eventId: string;
+};
+export type PluginAdditionalVariableEvents = {
+    handle: string;
+    events: Array<EventSourceAndId>;
+};
+export type VariableConfig = {
+    handle: string;
+    description: string;
+    events: string[];
+    eventMetaKey: string;
+    usage?: string;
+    defaultValue?: unknown;
+    type: ReplaceVariable["definition"]["possibleDataOutput"][number] | ReplaceVariable["definition"]["possibleDataOutput"];
+};

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,19 @@ export type WebhookConfig = {
     id: string;
     name: string;
     scriptId?: string;
-};
+};
+export interface PluginWebhook {
+    id: string;
+    name: string;
+}
+export interface PluginWebhookEvent {
+    webhook: PluginWebhook;
+    payload: unknown;
+    rawPayload?: string;
+    headers: Record<string, string>;
+}
+export type PluginWebhookEventHandler = (event: PluginWebhookEvent) => void;
+export type PluginWebhooks = {
+    webhookNames: string[];
+    handler: PluginWebhookEventHandler;
+};

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;
-    callback: (data: unknown | unknown[]) => Awaitable<void>;
+    handler: (data: unknown) => Awaitable<void>;
 }
-
 export type OverlayConnectedData = {
     instanceName: string;
-};
+};

package/types/script-api.d.ts

@@ -1,95 +0,0 @@
-/// <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
-
-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;
-    /** Look up a webhook by name. */
-    get(name: string): ScriptWebhook | null;
-    /** Delete a webhook by name. Returns true if one was removed. */
-    delete(name: string): boolean;
-    /** All webhooks owned by this script. */
-    list(): ScriptWebhook[];
-    /** Public URL for a webhook by name, or null if not found. */
-    getUrl(name: string): string | null;
-    /**
-     * Subscribe to webhook events for this script. Returns an `unsubscribe` func
-     */
-    onReceived(handler: ScriptWebhookEventHandler): () => void;
-}
-
-export interface ScriptFsDirEntry {
-    /** File or directory name */
-    name: string;
-    /** Path relative to the script's data dir */
-    relativePath: string;
-    isFile: boolean;
-    isDirectory: boolean;
-}
-
-export interface ScriptFsApi {
-    /** Absolute path to this script's data directory. Read-only. */
-    readonly dataDir: string;
-
-    /** Resolve a sandboxed relative path to an absolute one. Throws on escape. */
-    resolve(relativePath: string): string;
-
-    exists(relativePath: string): Promise<boolean>;
-
-    readText(relativePath: string, encoding?: BufferEncoding): Promise<string>;
-    writeText(relativePath: string, contents: string, encoding?: BufferEncoding): Promise<void>;
-
-    readBytes(relativePath: string): Promise<Buffer>;
-    writeBytes(relativePath: string, contents: Buffer | Uint8Array): Promise<void>;
-
-    /** Read JSON. Returns `null` if the file doesn't exist. */
-    readJson(relativePath: string): Promise<unknown>;
-    /** Write JSON pretty-printed with 2-space indent. */
-    writeJson(relativePath: string, value: unknown): Promise<void>;
-
-    /** Create a directory (and any missing parents). */
-    mkdir(relativePath: string): Promise<void>;
-    /** Delete a file or directory recursively. No-op if it doesn't exist. */
-    remove(relativePath: string): Promise<void>;
-
-    /** List immediate children of a directory (defaults to the data dir root). */
-    list(relativePath?: string): Promise<ScriptFsDirEntry[]>;
-}
-
-export interface FirebotScriptApi {
-    /** Running Firebot version, e.g. `"5.65.0"`. */
-    version: string;
-    /** Scoped logger. */
-    logger: ScriptLoggerApi;
-    /** Webhooks owned by this script. */
-    webhooks: ScriptWebhooksApi;
-    /** Sandboxed filesystem rooted at this script's data directory. */
-    fs: ScriptFsApi;
-}