@crowbartools/firebot-types 5.67.0-alpha12 → 5.67.0-alpha14

package/backend/events/filters/builtin/firebot/index.d.ts

@@ -1,4 +1,4 @@
-declare const _default: (Omit<import("../../../../../types").EventFilter, "presetValues"> | (Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const _default: (Omit<import("../../../../../types").EventFilter, "presetValues"> | (Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 }))[];
 export default _default;

package/backend/events/filters/builtin/firebot/new-currency-amount.d.ts

@@ -1,4 +1,4 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 };
 export default filter;

package/backend/events/filters/builtin/firebot/new-view-time.d.ts

@@ -1,4 +1,4 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 };
 export default filter;

package/backend/events/filters/builtin/firebot/previous-currency-amount.d.ts

@@ -1,4 +1,4 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 };
 export default filter;

package/backend/events/filters/builtin/firebot/previous-view-time.d.ts

@@ -1,4 +1,4 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 };
 export default filter;

package/backend/events/filters/builtin/index.d.ts

@@ -1,4 +1,4 @@
-declare const _default: (Omit<import("../../../../types").EventFilter, "presetValues"> | (Omit<import("../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const _default: (Omit<import("../../../../types").EventFilter, "presetValues"> | (Omit<import("../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 }))[];
 export default _default;

package/backend/events/filters/builtin/third-party/donation-amount.d.ts

@@ -1,4 +1,4 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 };
 export default filter;

package/backend/events/filters/builtin/third-party/index.d.ts

@@ -1,4 +1,4 @@
-declare const _default: (Omit<import("../../../../../types").EventFilter, "presetValues"> | (Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const _default: (Omit<import("../../../../../types").EventFilter, "presetValues"> | (Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 }))[];
 export default _default;

package/backend/events/filters/builtin/twitch/bits-badge-tier.d.ts

@@ -1,4 +1,4 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 };
 export default filter;

package/backend/events/filters/builtin/twitch/chat-mode-duration.d.ts

@@ -1,4 +1,4 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 };
 export default filter;

package/backend/events/filters/builtin/twitch/cheer-bits-amount.d.ts

@@ -1,4 +1,4 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 };
 export default filter;

package/backend/events/filters/builtin/twitch/gift-count.d.ts

@@ -1,4 +1,4 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 };
 export default filter;

package/backend/events/filters/builtin/twitch/gift-duration.d.ts

@@ -1,4 +1,4 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 };
 export default filter;

package/backend/events/filters/builtin/twitch/index.d.ts

@@ -1,4 +1,4 @@
-declare const _default: (Omit<import("../../../../../types").EventFilter, "presetValues"> | (Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const _default: (Omit<import("../../../../../types").EventFilter, "presetValues"> | (Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 }))[];
 export default _default;

package/backend/events/filters/builtin/twitch/lifetime-gift-count.d.ts

@@ -1,4 +1,4 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 };
 export default filter;

package/backend/events/filters/builtin/twitch/raid-viewer-count.d.ts

@@ -1,4 +1,4 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 };
 export default filter;

package/backend/events/filters/builtin/twitch/sub-months.d.ts

@@ -1,4 +1,4 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 };
 export default filter;

package/backend/events/filters/builtin/twitch/watch-streak-count.d.ts

@@ -1,4 +1,4 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 };
 export default filter;

package/backend/integrations/builtin/streamloots/filters/chest-quantity.d.ts

@@ -1,4 +1,4 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "valueType" | "presetValues"> & {
+declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
     valueType: "number";
 };
 export = filter;

package/backend/overlay-widgets/overlay-widgets-manager.d.ts

@@ -10,7 +10,7 @@ declare class OverlayWidgetsManager extends TypedEmitter<Events> {
     registerOverlayWidgetType(overlayWidgetType: OverlayWidgetType<any, any>): void;
     unregisterOverlayWidgetType(id: string): void;
     getOverlayWidgetType(id: string): OverlayWidgetType | null;
-    getOverlayWidgetTypesForFrontend(): (Pick<OverlayWidgetType, "id" | "name" | "description" | "icon" | "settingsSchema" | "userCanConfigure" | "supportsLivePreview" | "initialState" | "initialAspectRatio" | "nonEditableSettings"> & {
+    getOverlayWidgetTypesForFrontend(): (Pick<OverlayWidgetType, "id" | "name" | "icon" | "description" | "settingsSchema" | "userCanConfigure" | "supportsLivePreview" | "initialState" | "initialAspectRatio" | "nonEditableSettings"> & {
         uiActions?: Omit<WidgetUIAction, "click">[];
     })[];
     getOverlayExtensions(): {

package/backend/ranks/rank-ladder-helper.d.ts

@@ -5,7 +5,7 @@ export declare class RankLadderHelper {
     get id(): string;
     get name(): string;
     get mode(): "manual" | "auto";
-    get trackBy(): "currency" | "view_time" | "metadata";
+    get trackBy(): "view_time" | "currency" | "metadata";
     get currencyId(): string;
     get metadataKey(): string;
     get announcePromotionsInChat(): boolean;

package/backend/restrictions/builtin/index.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("../../../types").RestrictionType[];
+declare const _default: import("../../../types").RestrictionType<never>[];
 export default _default;

package/backend/scripts/executors/plugin-executor.d.ts

@@ -1,5 +1,6 @@
 import { ScriptBase, LegacyCustomScript, Plugin, InstalledPluginConfig, ScriptDetails } from "../../../types";
 import { IPluginExecutor, PluginRegistrations, PluginExecutionResult } from "./script-executor.interface";
+import { ScriptApiContext } from "../script-api";
 /**
  * Executor for new-spec Plugins (manifest.type === "plugin")
  */
@@ -7,7 +8,7 @@ export declare class PluginExecutor extends IPluginExecutor {
     constructor();
     canHandle(script: ScriptBase | LegacyCustomScript): script is Plugin<import("../../../types").FirebotParams>;
     getScriptDetails(script: ScriptBase | LegacyCustomScript): ScriptDetails | null;
-    executePlugin(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig, isInstalling?: boolean): Promise<PluginExecutionResult>;
+    executePlugin(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig, isInstalling?: boolean, ctx?: ScriptApiContext): Promise<PluginExecutionResult>;
     unloadPlugin(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig, registrations?: PluginRegistrations, isUninstalling?: boolean): Promise<void>;
     updateParameters(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig): Promise<void>;
     private registerAll;

package/backend/scripts/executors/script-executor.interface.d.ts

@@ -1,4 +1,5 @@
 import { InstalledPluginConfig, LegacyCustomScript, ScriptBase, ScriptContext, Awaitable, ScriptDetails } from "../../../types";
+import type { ScriptApiContext } from "../script-api";
 declare abstract class IBaseScriptExecutor {
     abstract canHandle(script: ScriptBase | LegacyCustomScript): Awaitable<boolean>;
     abstract getScriptDetails(script: ScriptBase | LegacyCustomScript): Awaitable<ScriptDetails | null>;
@@ -25,7 +26,7 @@ export type PluginExecutionResult = {
     error: string;
 };
 export declare abstract class IPluginExecutor extends IBaseScriptExecutor {
-    abstract executePlugin(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig, isInstalling?: boolean): Awaitable<PluginExecutionResult>;
+    abstract executePlugin(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig, isInstalling?: boolean, ctx?: ScriptApiContext): Awaitable<PluginExecutionResult>;
     abstract unloadPlugin(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig, registrations?: PluginRegistrations, isUninstalling?: boolean): Awaitable<void>;
     updateParameters?(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig): Awaitable<void>;
 }

package/backend/webhooks/webhook-config-manager.d.ts

@@ -1,4 +1,5 @@
-import type { WebhookConfig } from "../../types";
+import type { ScriptWebhook, WebhookConfig } from "../../types";
+import type { ScriptWebhookEventHandler } from "../../types/script-api";
 import JsonDbManager from "../database/json-db-manager";
 type ExtraEvents = {
     "webhook-received": (data: {
@@ -9,8 +10,18 @@ type ExtraEvents = {
     }) => void;
 };
 declare class WebhookConfigManager extends JsonDbManager<WebhookConfig, ExtraEvents> {
+    private _registeredPlugins;
     constructor();
     getWebhookUrlById(webhookId: string): string;
+    private toPublic;
+    findPluginWebhookByName(pluginId: string, webhookName: string): WebhookConfig;
+    getPluginWebhook(pluginId: string, webhookName: string): ScriptWebhook;
+    getAllPluginWebhooks(pluginId: string): ScriptWebhook[];
+    savePluginWebhook(pluginId: string, webhookName: string): ScriptWebhook;
+    deletePluginWebhook(pluginId: string, webhookName: string): boolean;
+    getPluginWebhookUrl(pluginId: string, webhookName: string): string;
+    registerPluginHandler(pluginId: string, handler: ScriptWebhookEventHandler): boolean;
+    unregisterPluginHandler(pluginId: string): boolean;
 }
 declare const webhookConfigManager: WebhookConfigManager;
 export = webhookConfigManager;

package/index.d.ts

@@ -1,4 +1,4 @@
-// Auto-generated by grunt publish-types. Do not edit by hand.
+// Auto-generated by grunt build-types. Do not edit by hand.
 import { FirebotScriptApi } from "./types/script-api";
 
 export * from "./types";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowbartools/firebot-types",
-  "version": "5.67.0-alpha12",
+  "version": "5.67.0-alpha14",
   "description": "Type definitions and script API for Firebot plugins and custom scripts.",
   "main": "index.js",
   "types": "index.d.ts",

package/types/accounts.d.ts

@@ -1,5 +1,4 @@
 import type { AuthDetails } from "./auth";
-
 export type FirebotAccount = {
     username: string;
     displayName?: string;
@@ -10,4 +9,4 @@ export type FirebotAccount = {
     broadcasterType?: string;
     auth?: AuthDetails;
     loggedIn?: boolean;
-};
+};

package/types/auth.d.ts

@@ -1,5 +1,4 @@
 import type ClientOAuth2 from "client-oauth2";
-
 export interface AuthProviderDefinition {
     id: string;
     name: string;
@@ -17,7 +16,6 @@ export interface AuthProviderDefinition {
     redirectUriHost?: string;
     scopes?: string[] | string | undefined;
 }
-
 export interface AuthProvider {
     id: string;
     oauthClient: ClientOAuth2;
@@ -26,26 +24,19 @@ export interface AuthProvider {
     tokenUri: string;
     details: AuthProviderDefinition;
 }
-
 export interface AuthDetails {
     /** The access token */
     access_token: string;
-
     /** The type of access token */
     token_type: string;
-
     /** OAuth scopes of the access token */
     scope: string[];
-
     /** When the token was obtained, in epoch timestamp format */
     obtainment_timestamp?: number;
-
     /** How many seconds before the token expires */
     expires_in?: number;
-
     /** JSON representation of when access token expires */
     expires_at?: Date;
-
     /** The refresh token */
     refresh_token?: string;
-}
+}

package/types/channel-rewards.d.ts

@@ -1,12 +1,10 @@
 import type { EffectList } from "./effects";
 import type { RestrictionData } from "./restrictions";
-
 export interface CustomRewardImageSet {
     url1x: string;
     url2x: string;
     url4x: string;
 }
-
 export interface CustomReward {
     broadcasterId: string;
     broadcasterLogin: string;
@@ -38,7 +36,6 @@ export interface CustomReward {
     redemptionsRedeemedCurrentStream?: number;
     cooldownExpiresAt?: Date;
 }
-
 export type SavedChannelReward = {
     id: string;
     twitchData: CustomReward;
@@ -49,7 +46,6 @@ export type SavedChannelReward = {
     restrictionData?: RestrictionData;
     autoApproveRedemptions?: boolean;
 };
-
 export type RewardRedemptionMetadata = {
     username: string;
     userId: string;
@@ -60,4 +56,4 @@ export type RewardRedemptionMetadata = {
     rewardImage: string;
     rewardName: string;
     rewardCost: number;
-};
+};

package/types/chat.d.ts

@@ -1,36 +1,25 @@
-type FirebotChatMessagePartType =
-    | "text"
-    | "link"
-    | "emote"
-    | "third-party-emote"
-    | "cheermote"
-    | "mention";
-
+type FirebotChatMessagePartType = "text" | "link" | "emote" | "third-party-emote" | "cheermote" | "mention";
 type FirebotChatMessagePartBase = {
     type: FirebotChatMessagePartType;
     id?: string;
     text: string;
 };
-
-type FirebotChatMessageTextPart = FirebotChatMessagePartBase & {
+export type FirebotChatMessageTextPart = FirebotChatMessagePartBase & {
     type: "text";
     flagged?: boolean;
 };
-
-type FirebotChatMessageLinkPart = FirebotChatMessagePartBase & {
+export type FirebotChatMessageLinkPart = FirebotChatMessagePartBase & {
     type: "link";
     url: string;
 };
-
-type FirebotChatMessageEmotePart = FirebotChatMessagePartBase & {
+export type FirebotChatMessageEmotePart = FirebotChatMessagePartBase & {
     type: "emote" | "third-party-emote";
     name: string;
     origin: string;
     url: string;
     animatedUrl?: string;
 };
-
-type FirebotChatMessageCheermotePart = FirebotChatMessagePartBase & {
+export type FirebotChatMessageCheermotePart = FirebotChatMessagePartBase & {
     type: "cheermote";
     name: string;
     url: string;
@@ -38,21 +27,13 @@ type FirebotChatMessageCheermotePart = FirebotChatMessagePartBase & {
     amount: number;
     color: string;
 };
-
-type FirebotChatMessageMentionPart = FirebotChatMessagePartBase & {
+export type FirebotChatMessageMentionPart = FirebotChatMessagePartBase & {
     type: "mention";
     username: string;
     userId: string;
     userDisplayName: string;
 };
-
-export type FirebotChatMessagePart =
-    | FirebotChatMessageTextPart
-    | FirebotChatMessageLinkPart
-    | FirebotChatMessageEmotePart
-    | FirebotChatMessageCheermotePart
-    | FirebotChatMessageMentionPart;
-
+export type FirebotChatMessagePart = FirebotChatMessageTextPart | FirebotChatMessageLinkPart | FirebotChatMessageEmotePart | FirebotChatMessageCheermotePart | FirebotChatMessageMentionPart;
 export type FirebotParsedMessagePart = {
     type: string;
     id?: string;
@@ -67,7 +48,6 @@ export type FirebotParsedMessagePart = {
     amount?: number;
     color?: string;
 };
-
 export type FirebotChatMessage = {
     id: string;
     timestamp?: number;
@@ -135,14 +115,12 @@ export type FirebotChatMessage = {
     };
     isGigantified?: boolean;
 };
-
 export type FirebotEmote = {
     url: string;
     animatedUrl: string;
     origin: string;
     code: string;
 };
-
 export type FirebotCheermoteInstance = {
     name: string;
     amount: number;
@@ -150,10 +128,10 @@ export type FirebotCheermoteInstance = {
     animatedUrl: string;
     color: string;
 };
-
 export type SharedChatParticipant = {
     broadcasterId: string;
     broadcasterName: string;
     broadcasterDisplayName: string;
     profilePictureUrl: string;
-};
+};
+export {};

package/types/commands.d.ts

@@ -3,10 +3,8 @@ import type { EffectList } from "./effects";
 import type { RestrictionData } from "./restrictions";
 import type { ParametersConfig } from "./parameters";
 import type { Awaitable } from "./util-types";
-
 export type CommandType = "system" | "custom";
-
-type Cooldown = {
+export type Cooldown = {
     /**
      * Global cooldown to use a command in seconds.
      */
@@ -16,7 +14,6 @@ type Cooldown = {
      */
     user: number | undefined;
 };
-
 export type SubCommand = {
     arg: string;
     usage: string;
@@ -34,7 +31,6 @@ export type SubCommand = {
     effects?: EffectList;
     hidden?: boolean;
 };
-
 export type CommandDefinition<OptionsModel = any> = {
     id?: string;
     name?: string;
@@ -96,8 +92,7 @@ export type CommandDefinition<OptionsModel = any> = {
     };
     allowTriggerBySharedChat?: boolean | "inherit" | undefined;
 };
-
-type UserCommand = {
+export type UserCommand = {
     trigger: string;
     args: string[];
     triggeredSubcmd?: SubCommand;
@@ -107,32 +102,17 @@ type UserCommand = {
     commandSender: string;
     senderRoles: string[];
 };
-
-type BasicCommandDefinition = Omit<
-    CommandDefinition,
-    | "type"
-    | "createdBy"
-    | "createdAt"
-    | "lastEditBy"
-    | "lastEditAt"
-    | "count"
-    | "simple"
->;
-
 export type SystemCommandDefinition<OptionsModel = any> = CommandDefinition<OptionsModel> & {
     hideCooldowns?: boolean;
 };
-
 export type SystemCommand<OptionsModel = any> = {
     definition: SystemCommandDefinition<OptionsModel>;
-    onTriggerEvent: (
-        event: {
-            command: SystemCommand<OptionsModel>['definition'];
-            userCommand: UserCommand;
-            chatMessage: FirebotChatMessage;
-            commandOptions?: {
-                [x in keyof OptionsModel]: OptionsModel[x]
-            };
-        }
-    ) => Awaitable<boolean | void>;
-};
+    onTriggerEvent: (event: {
+        command: SystemCommand<OptionsModel>['definition'];
+        userCommand: UserCommand;
+        chatMessage: FirebotChatMessage;
+        commandOptions?: {
+            [x in keyof OptionsModel]: OptionsModel[x];
+        };
+    }) => Awaitable<boolean | void>;
+};

package/types/counters.d.ts

@@ -1,5 +1,4 @@
 import type { EffectList } from "./effects";
-
 export type Counter = {
     id?: string;
     name: string;
@@ -10,4 +9,4 @@ export type Counter = {
     updateEffects?: EffectList;
     minimumEffects?: EffectList;
     maximumEffects?: EffectList;
-};
+};

package/types/currency.d.ts

@@ -6,10 +6,8 @@ export type Currency = {
     transfer: "Allow" | "Disallow";
     interval: number;
     payout: number;
-
     /** Offline payout */
     offline?: number | string;
-
     /** Maps user role IDs to the amount of bonus payout they receive. */
     bonus: Record<string, number>;
-};
+};

package/types/discord.d.ts

@@ -6,5 +6,4 @@ export type DiscordCustomEmbed = {
     authorIconUrl?: string;
     imageUrl?: string;
 };
-
 export type DiscordEmbedType = "channel" | "stream" | "custom";