@crowbartools/firebot-types 5.67.0-alpha1

package/types/util-types.d.ts

@@ -0,0 +1,52 @@
+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 = {
+    [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;

package/types/variable-macros.d.ts

@@ -0,0 +1,7 @@
+export type VariableMacro = {
+    id: string;
+    name: string;
+    expression: string;
+    description?: string;
+    argNames?: string[];
+};

package/types/variables.d.ts

@@ -0,0 +1,59 @@
+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 VariableUsage = {
+    usage: string;
+    description?: string;
+};
+
+interface VariableDefinition {
+    handle: string;
+    aliases?: string[];
+    usage?: string;
+    description: string;
+    examples?: VariableUsage[];
+    hasSuggestions?: boolean;
+    noSuggestionsText?: string;
+    categories?: VariableCategory[];
+    triggers?: TriggersObject;
+    possibleDataOutput: Array<"null" | "bool" | "number" | "text" | "array" | "object" | "ALL">;
+    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 };
+    argsCheck?: never;
+    evaluator?: never;
+    getSuggestions?: (triggerType: TriggerType, triggerMeta?: TriggerMeta) => Awaitable<VariableUsage[]>;
+};
+
+export type ReplaceVariable = Variable | SpoofedVariable;
+
+export type RegisteredVariable = {
+    definition: VariableDefinition;
+    handle: string;
+    triggers: TriggersObject;
+    argsCheck: (...args: unknown[]) => void;
+    evaluator(trigger: Trigger, ...args: unknown[]): Awaitable<unknown>;
+    getSuggestions: (triggerType: TriggerType, triggerMeta?: TriggerMeta) => Awaitable<VariableUsage[]>;
+};

package/types/viewers.d.ts

@@ -0,0 +1,30 @@
+export interface FirebotViewer {
+    _id: string;
+    username: string;
+    displayName: string;
+    profilePicUrl: string;
+    twitch: boolean;
+    twitchRoles: string[];
+    online: boolean;
+    onlineAt: number;
+    lastSeen: number;
+    joinDate: number;
+    minutesInChannel: number;
+    chatMessages: number;
+    disableAutoStatAccrual: boolean;
+    disableActiveUserList: boolean;
+    disableViewerList: boolean;
+    metadata: Record<string, unknown>;
+    currency: Record<string, number>;
+    ranks: Record<string, string>;
+}
+
+export interface BasicViewer {
+    id: string;
+    username: string;
+    displayName?: string;
+    twitchRoles?: string[];
+    profilePicUrl?: string;
+}
+
+export type NewFirebotViewer = BasicViewer & Partial<Omit<FirebotViewer, "_id" | "username" | "displayName" | "twitchRoles" | "profilePicUrl">>

package/types/webhooks.d.ts

@@ -0,0 +1,5 @@
+export type WebhookConfig = {
+    id: string;
+    name: string;
+    scriptId?: string;
+};

package/types/websocket.d.ts

@@ -0,0 +1,70 @@
+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 {
+    type: string;
+    id?: number | string;
+    name: string;
+    data?: unknown;
+}
+interface InvokeMessage extends Message {
+    type: "invoke";
+    id: string | number;
+    data: unknown;
+}
+interface ResponseMessage extends Message {
+    type: "response";
+    id: number | string;
+    name: "error" | "success";
+}
+interface EventMessage extends Message {
+    type: "event";
+}
+
+interface InvokePluginMessage extends InvokeMessage {
+    name: "plugin";
+    pluginName: string;
+}
+
+interface CustomWebSocketHandler {
+    pluginName: string;
+    callback: (data: unknown | unknown[]) => Awaitable<void>;
+}
+
+export type OverlayConnectedData = {
+    instanceName: string;
+};