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

package/backend/common/screenshot-helpers.d.ts

@@ -0,0 +1,24 @@
+import type { DiscordCustomEmbed, DiscordEmbedType } from "../../types";
+export declare function saveScreenshotToFolder(base64ImageData: string, folderPath: string, fileName?: string): Promise<void>;
+export declare function saveScreenshotToFile(base64ImageData: string, filePath: string): Promise<void>;
+export declare function sendScreenshotToDiscord(base64ImageData: string, message: string, discordChannelId: string, color: string): Promise<void>;
+export declare function sendEmbedToDiscord(base64ImageData: string, embedType: DiscordEmbedType, message: string, embed: DiscordCustomEmbed, discordChannelId: string, color: string): Promise<void>;
+export type ScreenshotEffectData = {
+    position: string;
+    overlayInstance: string;
+    width: number;
+    height: number;
+    duration: number;
+    customCoords?: string;
+    enterAnimation?: string;
+    enterDuration?: number;
+    inbetweenAnimation?: string;
+    inbetweenDuration?: number;
+    inbetweenDelay?: number;
+    inbetweenRepeat?: number;
+    exitAnimation?: string;
+    exitDuration?: number;
+    rotation?: string;
+    rotType?: string;
+};
+export declare function sendScreenshotToOverlay(screenshotDataUrl: string, effect: ScreenshotEffectData): void;

package/backend/common/settings-manager.d.ts

@@ -0,0 +1,148 @@
+import { TypedEmitter } from "tiny-typed-emitter";
+import type { FirebotAutoUpdateLevel, FirebotSettingsTypes } from "../../types";
+type Events = {
+    [settingName in keyof FirebotSettingsTypes as `settings:setting-updated:${settingName}`]: (data: FirebotSettingsTypes[settingName]) => void;
+} & {
+    [settingName in keyof FirebotSettingsTypes as `settings:setting-deleted:${settingName}`]: () => void;
+};
+declare class SettingsManager extends TypedEmitter<Events> {
+    private logger;
+    settingsCache: Partial<Record<keyof FirebotSettingsTypes, unknown>>;
+    constructor();
+    private getLoggedInProfilePath;
+    private getSettingsFile;
+    private getGlobalSettingsFile;
+    private handleCorruptSettingsFile;
+    private handleCorruptGlobalSettingsFile;
+    private migrateUserSettingsToGlobal;
+    private userSettingExists;
+    private globalSettingExists;
+    private getDataFromFile;
+    private getDataFromGlobalSettingsFile;
+    private pushDataToFile;
+    private pushDataToGlobalSettingsFile;
+    private deleteUserDataAtPath;
+    private deleteGlobalDataAtPath;
+    /**
+     * Get the JSON data path for a specific Firebot setting in the settings file
+     *
+     * @param settingName Name of the setting
+     * @returns String representing the full JSON path of the setting data
+     */
+    getSettingPath(settingName: keyof FirebotSettingsTypes): string;
+    /**
+     * Get a Firebot setting value or its default
+     *
+     * @param settingName Name of the setting to get
+     * @param forceCacheUpdate Force an update to the settings cache. Defaults to `false`.
+     * @returns Setting value, or the default if one isn't explicitly set
+     */
+    getSetting<SettingName extends keyof FirebotSettingsTypes>(settingName: SettingName, forceCacheUpdate?: boolean): FirebotSettingsTypes[SettingName];
+    /**
+     * Save a Firebot setting
+     *
+     * @param settingName Name of the setting to save
+     * @param data Setting data
+     */
+    saveSetting<SettingName extends keyof FirebotSettingsTypes>(settingName: SettingName, data: FirebotSettingsTypes[SettingName]): void;
+    /**
+     * Delete a Firebot setting
+     *
+     * @param settingName Name of the setting to delete
+     */
+    deleteSetting<SettingName extends keyof FirebotSettingsTypes>(settingName: SettingName): void;
+    /**
+     * Get a plugin setting or its default
+     *
+     * @param pluginName Name of the plugin
+     * @param settingName Name of the setting
+     * @param forceCacheUpdate Force an update to the settings cache. Defaults to `false`.
+     * @param defaultValue The default value to return if one isn't explicitly defined
+     * @returns The saved plugin setting value, or the default if it doesn't exist.
+     */
+    getPluginSetting(pluginName: string, settingName: string, forceCacheUpdate?: boolean, defaultValue?: unknown): unknown;
+    /**
+     * Flushes the settings cache, forcing all settings to be retrieved from file on the next retrieval
+     */
+    flushSettingsCache(): void;
+    /** @deprecated Use `getSetting("EventSettings")` instead */
+    getEventSettings: () => object;
+    /** @deprecated Use `getSetting("IgnoreSubsequentSubEventsAfterCommunitySub")` instead */
+    ignoreSubsequentSubEventsAfterCommunitySub: () => boolean;
+    /** @deprecated Use `getSetting("JustUpdated")` instead */
+    hasJustUpdated: () => boolean;
+    /** @deprecated Use `saveSetting("JustUpdated", value)` instead */
+    setJustUpdated: (value: boolean) => void;
+    /** @deprecated Use `getSetting("CopiedOverlayVersion")` instead */
+    getOverlayVersion: () => string;
+    /** @deprecated Use `saveSetting("CopiedOverlayVersion", value)` instead */
+    setOverlayVersion: (value: string) => void;
+    /** @deprecated Use `getSetting("ClearCustomScriptCache")` instead */
+    getClearCustomScriptCache: () => boolean;
+    /** @deprecated Use `saveSetting("ClearCustomScriptCache", value)` instead */
+    setClearCustomScriptCache: (value: boolean) => void;
+    /** @deprecated Use `getSetting("RunCustomScripts")` instead */
+    isCustomScriptsEnabled: () => boolean;
+    /** @deprecated Use `getSetting("RunCustomScripts")` instead */
+    getCustomScriptsEnabled: () => boolean;
+    /** @deprecated Use `saveSetting("RunCustomScripts", value)` instead */
+    setCustomScriptsEnabled: (value: boolean) => void;
+    /** @deprecated Use `getSetting("PersistCustomVariables")` instead */
+    getPersistCustomVariables: () => boolean;
+    /** @deprecated Use `saveSetting("PersistCustomVariables", value)` instead */
+    setPersistCustomVariables: (value: boolean) => void;
+    /** @deprecated Use `getSetting("UseOverlayInstances")` instead */
+    useOverlayInstances: () => boolean;
+    /** @deprecated Use `saveSetting("UseOverlayInstances", value)` instead */
+    setUseOverlayInstances: (value: boolean) => void;
+    /** @deprecated Use `getSetting("OverlayInstances")` instead */
+    getOverlayInstances: () => string[];
+    /** @deprecated Use `saveSetting("OverlayInstances", value)` instead */
+    setOverlayInstances: (value: string[]) => void;
+    /** @deprecated Use `getSetting("BackupKeepAll")` instead */
+    backupKeepAll: () => boolean;
+    /** @deprecated Use `getSetting("BackupOnExit")` instead */
+    backupOnExit: () => boolean;
+    /** @deprecated Use `getSetting("BackupBeforeUpdates")` instead */
+    backupBeforeUpdates: () => boolean;
+    /** @deprecated Use `getSetting("BackupOnceADay")` instead */
+    backupOnceADay: () => boolean;
+    /** @deprecated Use `saveSetting("BackupOnceADay", value)` instead */
+    setBackupOnceADay: (value: boolean) => void;
+    /** @deprecated Use `getSetting("LastBackupDate")` instead */
+    lastBackupDate: () => Date;
+    /** @deprecated Use `saveSetting("LastBackupDate", value)` instead */
+    setLastBackupDate: (value: Date) => void;
+    /** @deprecated Use `getSetting("MaxBackupCount")` instead */
+    maxBackupCount: () => number | "All";
+    /** @deprecated Use `getSetting("MaxBackupCount")` instead */
+    setMaxBackupCount: (value: number) => void;
+    /** @deprecated Use `getSetting("AllowQuoteCSVDownloads")` instead */
+    getAllowQuoteCSVDownloads: () => boolean;
+    /** @deprecated Use `getSetting("ActiveChatUserListTimeout")` instead */
+    getActiveChatUserListTimeout: () => number;
+    /** @deprecated Use `getSetting("WebServerPort")` instead */
+    getWebSocketPort: () => number;
+    /** @deprecated Use `getSetting("WebServerPort")` instead */
+    getWebServerPort: () => number;
+    /** @deprecated Use `getSetting("ViewerDB")` instead */
+    getViewerDbStatus: () => boolean;
+    /** @deprecated Use `getSetting("AutoUpdateLevel")` instead */
+    getAutoUpdateLevel: () => FirebotAutoUpdateLevel;
+    /** @deprecated Use `getSetting("AudioOutputDevice")` instead */
+    getAudioOutputDevice: () => import("../../types").FirebotAudioDevice;
+    /** @deprecated Use `getSetting("DebugMode")` instead */
+    debugModeEnabled: () => boolean;
+    /** @deprecated Use `getSetting("WhileLoopEnabled")` instead */
+    getWhileLoopEnabled: () => boolean;
+    /** @deprecated Use `saveSetting("WhileLoopEnabled", value)` instead */
+    setWhileLoopEnabled: (value: boolean) => void;
+    /** @deprecated Use `getSetting("SidebarControlledServices")` instead */
+    getSidebarControlledServices: () => string[];
+    /** @deprecated Use `getSetting("MinimizeToTray")` instead */
+    getMinimizeToTray: () => boolean;
+    /** @deprecated Use `saveSetting("MinimizeToTray", value)` instead */
+    setMinimizeToTray: (value: boolean) => void;
+}
+declare const settings: SettingsManager;
+export { settings as SettingsManager };

package/backend/control-deck/control-deck-manager.d.ts

@@ -0,0 +1,13 @@
+import { ControlDeck, ControlDeckControl } from "../../types";
+import JsonDbManager from "../database/json-db-manager";
+declare class ControlDeckManager extends JsonDbManager<ControlDeck> {
+    constructor();
+    saveDeck(deck: ControlDeck, notify?: boolean): ControlDeck;
+    deleteDeck(deckId: string): void;
+    getControl(deckId: string, controlId: string): ControlDeckControl | null;
+    triggerControl(deckId: string, controlId: string, inputValues?: Record<string, string | number | boolean>): boolean;
+    private broadcastToControlDecks;
+    triggerUiRefresh(): void;
+}
+declare const controlDeckManager: ControlDeckManager;
+export { controlDeckManager as ControlDeckManager };

package/backend/counters/counter-manager.d.ts

@@ -0,0 +1,29 @@
+import type { Counter } from "../../types";
+import JsonDbManager from "../database/json-db-manager";
+declare class CounterManager extends JsonDbManager<Counter> {
+    constructor();
+    /**
+     * @deprecated Please use {@linkcode getItem()} instead.
+     */
+    getCounter(counterId: string): Counter;
+    /**
+     * @deprecated Please use {@linkcode getItemByName()} instead.
+     */
+    getCounterByName(counterName: string): Counter;
+    saveItem(counter: Counter): Counter;
+    deleteItem(counterId: string): boolean;
+    private _updateCounterWidgets;
+    triggerUiRefresh(): void;
+    createCounter(counterName: string): Counter;
+    getCounterTxtFilePath(counterName: string): string;
+    updateCounterTxtFile(counterName: string, counterValue: number): Promise<void>;
+    renameCounterTxtFile(oldName: string, newName: string): Promise<void>;
+    deleteCounterTxtFile(counterName: string): Promise<void>;
+    private _counterHitMin;
+    private _counterHitMax;
+    private _runEffects;
+    private _updateCounter;
+    updateCounterValue(counterId: string, value: string | number, overridePreviousValue?: boolean): Promise<void>;
+}
+declare const counterManager: CounterManager;
+export { counterManager as CounterManager };

package/backend/crowbar-relay/crowbar-relay-websocket.d.ts

@@ -0,0 +1,16 @@
+import { TypedEmitter } from "tiny-typed-emitter";
+declare class CrowbarRelayWebSocket extends TypedEmitter<{
+    "ready": () => void;
+    "message": (msg: {
+        event: string;
+        data: unknown;
+    }) => void;
+}> {
+    private logger;
+    private ws;
+    constructor();
+    private start;
+    send(event: string, data?: unknown): void;
+}
+export declare const crowbarRelayWebSocket: CrowbarRelayWebSocket;
+export {};

package/backend/currency/currency-access.d.ts

@@ -0,0 +1,25 @@
+import EventEmitter from "events";
+import { JsonDB } from "node-json-db";
+import type { Currency, FirebotViewer } from "../../types";
+type CurrencyCache = {
+    [currencyName: string]: Currency;
+};
+declare class CurrencyAccess extends EventEmitter {
+    private logger;
+    private _currencyCache;
+    constructor();
+    isViewerDBOn(): boolean;
+    getCurrencyDb(): JsonDB;
+    loadCurrencies(): void;
+    getCurrencies(): CurrencyCache;
+    getCurrencyById(id: string): Currency;
+    getCurrencyByName(name: string): Currency;
+    addCurrencyToNewViewer(viewer: FirebotViewer): FirebotViewer;
+    importCurrency(currency: Currency): void;
+    createCurrency(currency: Currency): boolean;
+    updateCurrency(currency: Currency): void;
+    deleteCurrency(id: string): void;
+    private saveAllCurrencies;
+}
+declare const currencyAccess: CurrencyAccess;
+export default currencyAccess;

package/backend/currency/currency-command-manager.d.ts

@@ -0,0 +1,29 @@
+import type { Currency, SystemCommand } from "../../types";
+type CurrencyCommandRefreshRequestAction = "create" | "update" | "delete";
+declare class CurrencyCommandManager {
+    private logger;
+    constructor();
+    /**
+     * Creates a command definition when given a currency name.
+     */
+    createCurrencyCommandDefinition(currency: Partial<Currency>): SystemCommand<{
+        currencyBalanceMessageTemplate: string;
+        whisperCurrencyBalanceMessage: boolean;
+        addMessageTemplate: string;
+        setMessageTemplate: string;
+        removeMessageTemplate: string;
+        addAllMessageTemplate: string;
+        removeAllMessageTemplate: string;
+    }>;
+    /**
+     * Makes sure our currency system commands are up to date.
+     */
+    refreshCurrencyCommands(action?: CurrencyCommandRefreshRequestAction, currency?: Partial<Currency>): void;
+    /**
+     * Loops through all currencies we have and passes them to refresh currency commands.
+     * This lets us create all of our currency commands when the application is started.
+     */
+    createAllCurrencyCommands(): void;
+}
+declare const currencyCommandManager: CurrencyCommandManager;
+export = currencyCommandManager;

package/backend/currency/currency-manager.d.ts

@@ -0,0 +1,33 @@
+import type { Currency, FirebotViewer } from "../../types";
+declare class CurrencyManager {
+    private logger;
+    private _currencyInterval;
+    constructor();
+    /**
+     * Adjust Currency
+     * This adjust currency for a viewer. Can be given negative values. Provide it with the database record for a viewer.
+     */
+    adjustCurrency(viewer: FirebotViewer, currencyId: string, value: number | string, adjustType?: string): Promise<void>;
+    purgeCurrencyById(currencyId: string): Promise<void>;
+    deleteCurrencyById(currencyId: string): Promise<void>;
+    startTimer(): void;
+    stopTimer(): void;
+    applyCurrency(): Promise<void>;
+    processCurrencyTimer(currency: Currency, basePayout: number): Promise<void>;
+    adjustCurrencyForViewer(username: string, currencyId: string, value: number | string, adjustType?: string): Promise<boolean>;
+    adjustCurrencyForViewerById(userId: string, currencyId: string, value: string | number, overrideValue?: boolean): Promise<boolean>;
+    addCurrencyToViewerGroupOnlineViewers(roleIds: string[], currencyId: string, value: string | number, ignoreDisable?: boolean, adjustType?: string): Promise<void>;
+    addCurrencyToOnlineViewers(currencyId: string, value: string | number, ignoreDisable?: boolean, adjustType?: string): Promise<void>;
+    /**
+     * Adjusts currency for all viewers in the database
+     */
+    adjustCurrencyForAllViewers(currencyId: string, value: string | number, ignoreDisable?: boolean, adjustType?: string): Promise<void>;
+    addCurrencyToAllViewers(currencyId: string, value: number): Promise<void>;
+    getViewerCurrencyAmount(username: string, currencyId: string): Promise<number>;
+    getViewerCurrencies(usernameOrId: string, isUsername?: boolean): Promise<Record<string, number>>;
+    getViewerCurrencyRank(currencyId: string, usernameOrId: string, isUsername?: boolean): Promise<number>;
+    getTopCurrencyPosition(currencyId: string, position?: number): Promise<FirebotViewer>;
+    getTopCurrencyHolders(currencyIdOrName: string, count: number, byName?: boolean): Promise<FirebotViewer[]>;
+}
+declare const currencyManager: CurrencyManager;
+export = currencyManager;

package/backend/database/json-db-manager.d.ts

@@ -0,0 +1,44 @@
+import type { JsonDB } from "node-json-db";
+import { TypedEmitter, type ListenerSignature } from "tiny-typed-emitter";
+import type { Logger } from "winston";
+interface Item {
+    id?: string;
+    name?: string;
+    [key: string]: unknown;
+}
+type DefaultEvents<I extends Item = Item> = {
+    "loaded-items": (items: I[]) => void;
+    "created-item": (item: I) => void;
+    "updated-item": (item: I) => void;
+    "saved-all-items": (items: I[]) => void;
+    "deleted-item": (item: I) => void;
+    "deleted-all-items": () => void;
+    "items-changed": (items: I[]) => void;
+};
+declare abstract class JsonDbManager<T extends Item, E extends ListenerSignature<E> = DefaultEvents<T>> extends TypedEmitter<E & DefaultEvents<T>> {
+    protected type: string;
+    protected path: string;
+    protected loggerModule: string;
+    protected logger: Logger;
+    protected items: {
+        [key: string]: T;
+    };
+    protected db: JsonDB;
+    private batchedSaveTimeout;
+    /**
+     * @param type - The type of data in the json file
+     * @param path - The path to the json file
+     */
+    constructor(type: string, path: string, loggerModule: string);
+    loadItems(): void;
+    getItem(itemId: string): T | null;
+    getItemByName(itemName: string): T | null;
+    getAllItems(): T[];
+    saveItem(item: T, isCreating?: boolean, batchSave?: boolean): T | null;
+    saveAllItems(allItems: T[]): void;
+    private saveCurrentItems;
+    deleteItem(itemId: string): boolean;
+    deleteAllItems(): void;
+    private emitItemsChanged;
+}
+export = JsonDbManager;

package/backend/effects/builtin/active-user-lists.d.ts

@@ -0,0 +1,6 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    action: string;
+    username: string;
+}>;
+export = effect;

package/backend/effects/builtin/activity-feed-alert.d.ts

@@ -0,0 +1,6 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    message: string;
+    icon: string;
+}>;
+export = effect;

package/backend/effects/builtin/add-quote.d.ts

@@ -0,0 +1,7 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    creator: string;
+    originator: string;
+    text: string;
+}>;
+export = effect;

package/backend/effects/builtin/chat-feed-alert.d.ts

@@ -0,0 +1,6 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    message: string;
+    icon: string;
+}>;
+export = effect;

package/backend/effects/builtin/chat-feed-custom-highlight.d.ts

@@ -0,0 +1,9 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    highlightEnabled: boolean;
+    bannerEnabled: boolean;
+    customHighlightColor?: string;
+    customBannerText?: string;
+    customBannerIcon?: string;
+}>;
+export = effect;

package/backend/effects/builtin/chat-feed-message-hide.d.ts

@@ -0,0 +1,5 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    hidden: boolean;
+}>;
+export = effect;

package/backend/effects/builtin/chat.d.ts

@@ -0,0 +1,9 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    chatter: string;
+    message: string;
+    me: boolean;
+    whisper: string;
+    sendAsReply: boolean;
+}>;
+export = effect;

package/backend/effects/builtin/clear-chat.d.ts

@@ -0,0 +1,3 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType;
+export = effect;

package/backend/effects/builtin/clear-effects.d.ts

@@ -0,0 +1,11 @@
+import { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    overlay: boolean;
+    overlayInstance: string;
+    sounds: boolean;
+    queues: boolean;
+    queueId: string;
+    abortActiveQueueEffectLists: boolean;
+    activeEffectLists: boolean;
+}>;
+export = effect;

package/backend/effects/builtin/comment.d.ts

@@ -0,0 +1,5 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    effectComment: string;
+}>;
+export = effect;

package/backend/effects/builtin/conditional-effects/switch-statement.d.ts

@@ -0,0 +1,18 @@
+import type { EffectType } from "../../../../types";
+interface SwitchCase {
+    label?: string;
+    type?: "compare" | "range";
+    value?: string;
+    min?: string;
+    max?: string;
+    effectList?: unknown;
+    fallthrough?: boolean;
+}
+interface EffectModel {
+    value: string;
+    cases: SwitchCase[];
+    defaultCase: SwitchCase;
+    bubbleOutputs: boolean;
+}
+declare const model: EffectType<EffectModel>;
+export = model;

package/backend/effects/builtin/copy-to-clipboard.d.ts

@@ -0,0 +1,5 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    text: string;
+}>;
+export = effect;

package/backend/effects/builtin/custom-variable.d.ts

@@ -0,0 +1,9 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    name: string;
+    variableData: string;
+    ttl: number;
+    propertyPath: string;
+    persistToFile?: boolean;
+}>;
+export = effect;

package/backend/effects/builtin/delay.d.ts

@@ -0,0 +1,5 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    delay: number;
+}>;
+export = effect;

package/backend/effects/builtin/delete-chat-message.d.ts

@@ -0,0 +1,3 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType;
+export = effect;

package/backend/effects/builtin/deprecated/random-effect.d.ts

@@ -0,0 +1,9 @@
+import type { EffectList, EffectType } from "../../../../types";
+declare const effect: EffectType<{
+    effectList: EffectList;
+    weighted: boolean;
+    dontRepeat: boolean;
+    bubbleOutputs: boolean;
+    outputs: unknown;
+}>;
+export = effect;

package/backend/effects/builtin/deprecated/sequential-effect.d.ts

@@ -0,0 +1,7 @@
+import type { EffectList, EffectType } from "../../../../types";
+declare const effect: EffectType<{
+    id: string;
+    effectList: EffectList;
+    outputs: Record<string, unknown>;
+}>;
+export = effect;

package/backend/effects/builtin/dice.d.ts

@@ -0,0 +1,4 @@
+import type { EffectType } from "../../../types";
+import { type DiceEffectModel } from "../../common/handlers/dice-processor";
+declare const model: EffectType<DiceEffectModel>;
+export = model;

package/backend/effects/builtin/eval-js.d.ts

@@ -0,0 +1,6 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    code: string;
+    parameters: string[];
+}>;
+export = effect;

package/backend/effects/builtin/file-writer.d.ts

@@ -0,0 +1,12 @@
+import type { EffectType } from "../../../types";
+declare const fileWriter: EffectType<{
+    filepath: string;
+    writeMode: "replace" | "suffix" | "append" | "delete" | "replace-line" | "delete-all";
+    deleteLineMode: "lines" | "text";
+    replaceLineMode: "lineNumbers" | "text";
+    lineNumbers: string;
+    text: string;
+    dontRepeat: boolean;
+    replacementText: string;
+}>;
+export = fileWriter;

package/backend/effects/builtin/http-request.d.ts

@@ -0,0 +1,23 @@
+import type { EffectType, EffectList, KeyValuePair } from "../../../types";
+declare const effect: EffectType<{
+    url: string;
+    method: string;
+    body: string;
+    headers: Array<KeyValuePair>;
+    options: {
+        timeout?: number;
+        useTwitchAuth?: boolean;
+        runEffectsOnError?: boolean;
+        storeOutputAsBinary?: boolean;
+        /** @deprecated */
+        putResponseInVariable?: boolean;
+        /** @deprecated */
+        variableName?: string;
+        /** @deprecated */
+        variableTtl?: number;
+        /** @deprecated */
+        variablePropertyPath?: string;
+    };
+    errorEffects: EffectList;
+}>;
+export = effect;

package/backend/effects/builtin/log-message.d.ts

@@ -0,0 +1,6 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    logLevel: "Info" | "Warning" | "Error" | "Debug";
+    logMessage: string;
+}>;
+export = effect;

package/backend/effects/builtin/mark-all-activity-acknowledged.d.ts

@@ -0,0 +1,3 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType;
+export = effect;

package/backend/effects/builtin/moderator-ban.d.ts

@@ -0,0 +1,7 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    action: "Ban" | "Unban";
+    username: string;
+    reason: string;
+}>;
+export = effect;

package/backend/effects/builtin/moderator-mod.d.ts

@@ -0,0 +1,6 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    action: "Mod" | "Unmod";
+    username: string;
+}>;
+export = effect;

package/backend/effects/builtin/moderator-purge.d.ts

@@ -0,0 +1,5 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    username: string;
+}>;
+export = effect;

package/backend/effects/builtin/moderator-timeout.d.ts

@@ -0,0 +1,7 @@
+import type { EffectType } from "../../../types";
+declare const effect: EffectType<{
+    username: string;
+    time: number;
+    reason: string;
+}>;
+export = effect;